fs/cifs/cifsproto.h

   1 /*
   2  *   fs/cifs/cifsproto.h
   3  *
   4  *   Copyright (c) International Business Machines  Corp., 2002,2007
   5  *   Author(s): Steve French (sfrench@us.ibm.com)
   6  *
   7  *   This library is free software; you can redistribute it and/or modify
   8  *   it under the terms of the GNU Lesser General Public License as published
   9  *   by the Free Software Foundation; either version 2.1 of the License, or
  10  *   (at your option) any later version.
  11  *
  12  *   This library is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  15  *   the GNU Lesser General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU Lesser General Public License
  18  *   along with this library; if not, write to the Free Software
  19  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20  */
  21 #ifndef _CIFSPROTO_H
  22 #define _CIFSPROTO_H
  23 #include <linux/nls.h>
  24
  25 struct statfs;
  26 struct smb_vol;
  27
  28 /*
  29  *****************************************************************
  30  * All Prototypes
  31  *****************************************************************
  32  */
  33
  34 extern struct smb_hdr *cifs_buf_get(void);
  35 extern void cifs_buf_release(void *);
  36 extern struct smb_hdr *cifs_small_buf_get(void);
  37 extern void cifs_small_buf_release(void *);
  38 extern int smb_send(struct socket *, struct smb_hdr *,
  39                         unsigned int /* length */ , struct sockaddr *);
  40 extern unsigned int _GetXid(void);
  41 extern void _FreeXid(unsigned int);
  42 #define GetXid() (int)_GetXid(); cFYI(1,("CIFS VFS: in %s as Xid: %d with uid: %d",__FUNCTION__, xid,current->fsuid));
  43 #define FreeXid(curr_xid) {_FreeXid(curr_xid); cFYI(1,("CIFS VFS: leaving %s (xid = %d) rc = %d",__FUNCTION__,curr_xid,(int)rc));}
  44 extern char *build_path_from_dentry(struct dentry *);
  45 extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
  46 /* extern void renew_parental_timestamps(struct dentry *direntry);*/
  47 extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
  48                         struct smb_hdr * /* input */ ,
  49                         struct smb_hdr * /* out */ ,
  50                         int * /* bytes returned */ , const int long_op);
  51 extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
  52                         struct kvec *, int /* nvec to send */,
  53                         int * /* type of buf returned */ , const int long_op,
  54                         const int logError /* whether to log status code*/ );
  55 extern int SendReceiveBlockingLock(const unsigned int /* xid */ ,
  56                                         struct cifsTconInfo *,
  57                                 struct smb_hdr * /* input */ ,
  58                                 struct smb_hdr * /* out */ ,
  59                                 int * /* bytes returned */);
  60 extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
  61 extern int is_valid_oplock_break(struct smb_hdr *smb, struct TCP_Server_Info *);
  62 extern int is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
  63 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
  64 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
  65 extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
  66 extern int decode_negTokenInit(unsigned char *security_blob, int length,
  67                         enum securityEnum *secType);
  68 extern int cifs_inet_pton(int, char *source, void *dst);
  69 extern int map_smb_to_linux_error(struct smb_hdr *smb, int logErr);
  70 extern void header_assemble(struct smb_hdr *, char /* command */ ,
  71                             const struct cifsTconInfo *, int /* length of
  72                             fixed section (word count) in two byte units */);
  73 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
  74                                 struct cifsSesInfo *ses,
  75                                 void **request_buf);
  76 extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
  77                              const int stage,
  78                              const struct nls_table *nls_cp);
  79 extern __u16 GetNextMid(struct TCP_Server_Info *server);
  80 extern struct oplock_q_entry *AllocOplockQEntry(struct inode *, u16,
  81                                                  struct cifsTconInfo *);
  82 extern void DeleteOplockQEntry(struct oplock_q_entry *);
  83 extern struct timespec cifs_NTtimeToUnix(u64 /* utc nanoseconds since 1601 */ );
  84 extern u64 cifs_UnixTimeToNT(struct timespec);
  85 extern __le64 cnvrtDosCifsTm(__u16 date, __u16 time);
  86 extern struct timespec cnvrtDosUnixTm(__u16 date, __u16 time);
  87
  88 extern int cifs_get_inode_info(struct inode **pinode,
  89                         const unsigned char *search_path,
  90                         FILE_ALL_INFO * pfile_info,
  91                         struct super_block *sb, int xid);
  92 extern int cifs_get_inode_info_unix(struct inode **pinode,
  93                         const unsigned char *search_path,
  94                         struct super_block *sb, int xid);
  95
  96 extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
  97                         const char *);
  98 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
  99 void cifs_proc_init(void);
 100 void cifs_proc_clean(void);
 101
 102 extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
 103                         struct nls_table *nls_info);
 104 extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
 105
 106 extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
 107                         const char *tree, struct cifsTconInfo *tcon,
 108                         const struct nls_table *);
 109
 110 extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
 111                 const char *searchName, const struct nls_table *nls_codepage,
 112                 __u16 *searchHandle, struct cifs_search_info *psrch_inf,
 113                 int map, const char dirsep);
 114
 115 extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
 116                 __u16 searchHandle, struct cifs_search_info *psrch_inf);
 117
 118 extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
 119                         const __u16 search_handle);
 120
 121 extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
 122                         const unsigned char *searchName,
 123                         FILE_ALL_INFO * findData,
 124                         int legacy /* whether to use old info level */,
 125                         const struct nls_table *nls_codepage, int remap);
 126 extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
 127                         const unsigned char *searchName,
 128                         FILE_ALL_INFO *findData,
 129                         const struct nls_table *nls_codepage, int remap);
 130
 131 extern int CIFSSMBUnixQPathInfo(const int xid,
 132                         struct cifsTconInfo *tcon,
 133                         const unsigned char *searchName,
 134                         FILE_UNIX_BASIC_INFO * pFindData,
 135                         const struct nls_table *nls_codepage, int remap);
 136
 137 extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
 138                         const unsigned char *searchName,
 139                         unsigned char **targetUNCs,
 140                         unsigned int *number_of_UNC_in_array,
 141                         const struct nls_table *nls_codepage, int remap);
 142
 143 extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 144                         const char *old_path,
 145                         const struct nls_table *nls_codepage, int remap);
 146 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 147                         const char *old_path,
 148                         const struct nls_table *nls_codepage,
 149                         unsigned int *pnum_referrals,
 150                         unsigned char **preferrals,
 151                         int remap);
 152 extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
 153                                  struct super_block *sb, struct smb_vol *vol);
 154 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
 155                         struct kstatfs *FSData);
 156 extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
 157                         struct kstatfs *FSData);
 158 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
 159                         __u64 cap);
 160
 161 extern int CIFSSMBQFSAttributeInfo(const int xid,
 162                         struct cifsTconInfo *tcon);
 163 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
 164 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
 165 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
 166                         struct kstatfs *FSData);
 167
 168 extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
 169                         const char *fileName, const FILE_BASIC_INFO * data,
 170                         const struct nls_table *nls_codepage,
 171                         int remap_special_chars);
 172 extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
 173                         const FILE_BASIC_INFO * data, __u16 fid);
 174 #if 0
 175 extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
 176                         char *fileName, __u16 dos_attributes,
 177                         const struct nls_table *nls_codepage);
 178 #endif /* possibly unneeded function */
 179 extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
 180                         const char *fileName, __u64 size,
 181                         int setAllocationSizeFlag,
 182                         const struct nls_table *nls_codepage,
 183                         int remap_special_chars);
 184 extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
 185                          __u64 size, __u16 fileHandle, __u32 opener_pid,
 186                         int AllocSizeFlag);
 187 extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
 188                         char *full_path, __u64 mode, __u64 uid,
 189                         __u64 gid, dev_t dev,
 190                         const struct nls_table *nls_codepage,
 191                         int remap_special_chars);
 192
 193 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
 194                         const char *newName,
 195                         const struct nls_table *nls_codepage,
 196                         int remap_special_chars);
 197 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
 198                         const char *name, const struct nls_table *nls_codepage,
 199                         int remap_special_chars);
 200 extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
 201                         const char *name, __u16 type,
 202                         const struct nls_table *nls_codepage,
 203                         int remap_special_chars);
 204 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
 205                         const char *name,
 206                         const struct nls_table *nls_codepage,
 207                         int remap_special_chars);
 208 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
 209                         const char *fromName, const char *toName,
 210                         const struct nls_table *nls_codepage,
 211                         int remap_special_chars);
 212 extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
 213                         int netfid, char *target_name,
 214                         const struct nls_table *nls_codepage,
 215                         int remap_special_chars);
 216 extern int CIFSCreateHardLink(const int xid,
 217                         struct cifsTconInfo *tcon,
 218                         const char *fromName, const char *toName,
 219                         const struct nls_table *nls_codepage,
 220                         int remap_special_chars);
 221 extern int CIFSUnixCreateHardLink(const int xid,
 222                         struct cifsTconInfo *tcon,
 223                         const char *fromName, const char *toName,
 224                         const struct nls_table *nls_codepage,
 225                         int remap_special_chars);
 226 extern int CIFSUnixCreateSymLink(const int xid,
 227                         struct cifsTconInfo *tcon,
 228                         const char *fromName, const char *toName,
 229                         const struct nls_table *nls_codepage);
 230 extern int CIFSSMBUnixQuerySymLink(const int xid,
 231                         struct cifsTconInfo *tcon,
 232                         const unsigned char *searchName,
 233                         char *syminfo, const int buflen,
 234                         const struct nls_table *nls_codepage);
 235 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
 236                         struct cifsTconInfo *tcon,
 237                         const unsigned char *searchName,
 238                         char *symlinkinfo, const int buflen, __u16 fid,
 239                         const struct nls_table *nls_codepage);
 240
 241 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
 242                         const char *fileName, const int disposition,
 243                         const int access_flags, const int omode,
 244                         __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
 245                         const struct nls_table *nls_codepage, int remap);
 246 extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
 247                         const char *fileName, const int disposition,
 248                         const int access_flags, const int omode,
 249                         __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
 250                         const struct nls_table *nls_codepage, int remap);
 251 extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
 252                         u32 posix_flags, __u64 mode, __u16 * netfid,
 253                         FILE_UNIX_BASIC_INFO *pRetData,
 254                         __u32 *pOplock, const char *name,
 255                         const struct nls_table *nls_codepage, int remap);
 256 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
 257                         const int smb_file_id);
 258
 259 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
 260                         const int netfid, unsigned int count,
 261                         const __u64 lseek, unsigned int *nbytes, char **buf,
 262                         int *return_buf_type);
 263 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
 264                         const int netfid, const unsigned int count,
 265                         const __u64 lseek, unsigned int *nbytes,
 266                         const char *buf, const char __user *ubuf,
 267                         const int long_op);
 268 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
 269                         const int netfid, const unsigned int count,
 270                         const __u64 offset, unsigned int *nbytes,
 271                         struct kvec *iov, const int nvec, const int long_op);
 272 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
 273                         const unsigned char *searchName, __u64 * inode_number,
 274                         const struct nls_table *nls_codepage,
 275                         int remap_special_chars);
 276 extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
 277                         const struct nls_table *codepage);
 278 extern int cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
 279                         const struct nls_table *cp, int mapChars);
 280
 281 extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
 282                         const __u16 netfid, const __u64 len,
 283                         const __u64 offset, const __u32 numUnlock,
 284                         const __u32 numLock, const __u8 lockType,
 285                         const int waitFlag);
 286 extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
 287                         const __u16 smb_file_id, const int get_flag,
 288                         const __u64 len, struct file_lock *,
 289                         const __u16 lock_type, const int waitFlag);
 290 extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
 291 extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
 292
 293 extern struct cifsSesInfo *sesInfoAlloc(void);
 294 extern void sesInfoFree(struct cifsSesInfo *);
 295 extern struct cifsTconInfo *tconInfoAlloc(void);
 296 extern void tconInfoFree(struct cifsTconInfo *);
 297
 298 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
 299 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
 300                           __u32 *);
 301 extern int cifs_verify_signature(struct smb_hdr *,
 302                                  const struct mac_key *mac_key,
 303                                 __u32 expected_sequence_number);
 304 extern int cifs_calculate_mac_key(struct mac_key *key, const char *rn,
 305                                  const char *pass);
 306 extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
 307                         const struct nls_table *);
 308 extern void CalcNTLMv2_response(const struct cifsSesInfo *, char *);
 309 extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
 310                              const struct nls_table *);
 311 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 312 extern void calc_lanman_hash(struct cifsSesInfo *ses, char *lnm_session_key);
 313 #endif /* CIFS_WEAK_PW_HASH */
 314 extern int parse_sec_desc(struct cifs_ntsd *, int);
 315 extern int CIFSSMBCopy(int xid,
 316                         struct cifsTconInfo *source_tcon,
 317                         const char *fromName,
 318                         const __u16 target_tid,
 319                         const char *toName, const int flags,
 320                         const struct nls_table *nls_codepage,
 321                         int remap_special_chars);
 322 extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
 323                         const int notify_subdirs, const __u16 netfid,
 324                         __u32 filter, struct file *file, int multishot,
 325                         const struct nls_table *nls_codepage);
 326 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
 327                         const unsigned char *searchName, char *EAData,
 328                         size_t bufsize, const struct nls_table *nls_codepage,
 329                         int remap_special_chars);
 330 extern ssize_t CIFSSMBQueryEA(const int xid, struct cifsTconInfo *tcon,
 331                 const unsigned char *searchName, const unsigned char *ea_name,
 332                 unsigned char *ea_value, size_t buf_size,
 333                 const struct nls_table *nls_codepage, int remap_special_chars);
 334 extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
 335                 const char *fileName, const char *ea_name,
 336                 const void *ea_value, const __u16 ea_value_len,
 337                 const struct nls_table *nls_codepage, int remap_special_chars);
 338 extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
 339                         __u16 fid, char *acl_inf, const int buflen,
 340                         const int acl_type /* ACCESS vs. DEFAULT */);
 341 extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
 342                 const unsigned char *searchName,
 343                 char *acl_inf, const int buflen, const int acl_type,
 344                 const struct nls_table *nls_codepage, int remap_special_chars);
 345 extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
 346                 const unsigned char *fileName,
 347                 const char *local_acl, const int buflen, const int acl_type,
 348                 const struct nls_table *nls_codepage, int remap_special_chars);
 349 extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
 350                         const int netfid, __u64 * pExtAttrBits, __u64 *pMask);
 351 #endif                  /* _CIFSPROTO_H */