fs/cifs/cifsproto.h

   1 /*
   2  *   fs/cifs/cifsproto.h
   3  *
   4  *   Copyright (c) International Business Machines  Corp., 2002,2008
   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 TCP_Server_Info *, struct smb_hdr *,
  39                         unsigned int /* length */);
  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",__func__, xid,current_fsuid()));
  43 #define FreeXid(curr_xid) {_FreeXid(curr_xid); cFYI(1,("CIFS VFS: leaving %s (xid = %d) rc = %d",__func__,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 SendReceiveNoRsp(const unsigned int xid, struct cifsSesInfo *ses,
  52                         struct smb_hdr *in_buf, int flags);
  53 extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
  54                         struct kvec *, int /* nvec to send */,
  55                         int * /* type of buf returned */ , const int flags);
  56 extern int SendReceiveBlockingLock(const unsigned int xid,
  57                         struct cifsTconInfo *ptcon,
  58                         struct smb_hdr *in_buf ,
  59                         struct smb_hdr *out_buf,
  60                         int *bytes_returned);
  61 extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
  62 extern bool is_valid_oplock_break(struct smb_hdr *smb,
  63                                   struct TCP_Server_Info *);
  64 extern bool is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
  65 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
  66 #ifdef CONFIG_CIFS_EXPERIMENTAL
  67 extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *);
  68 #endif
  69 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
  70 extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
  71 extern int decode_negTokenInit(unsigned char *security_blob, int length,
  72                         enum securityEnum *secType);
  73 extern int cifs_inet_pton(const int, const char *source, void *dst);
  74 extern int map_smb_to_linux_error(struct smb_hdr *smb, int logErr);
  75 extern void header_assemble(struct smb_hdr *, char /* command */ ,
  76                             const struct cifsTconInfo *, int /* length of
  77                             fixed section (word count) in two byte units */);
  78 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
  79                                 struct cifsSesInfo *ses,
  80                                 void **request_buf);
  81 extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
  82                              const int stage,
  83                              const struct nls_table *nls_cp);
  84 extern __u16 GetNextMid(struct TCP_Server_Info *server);
  85 extern struct oplock_q_entry *AllocOplockQEntry(struct inode *, u16,
  86                                                  struct cifsTconInfo *);
  87 extern void DeleteOplockQEntry(struct oplock_q_entry *);
  88 extern void DeleteTconOplockQEntries(struct cifsTconInfo *);
  89 extern struct timespec cifs_NTtimeToUnix(u64 utc_nanoseconds_since_1601);
  90 extern u64 cifs_UnixTimeToNT(struct timespec);
  91 extern __le64 cnvrtDosCifsTm(__u16 date, __u16 time);
  92 extern struct timespec cnvrtDosUnixTm(__u16 date, __u16 time);
  93
  94 extern int cifs_get_inode_info(struct inode **pinode,
  95                         const unsigned char *search_path,
  96                         FILE_ALL_INFO *pfile_info,
  97                         struct super_block *sb, int xid, const __u16 *pfid);
  98 extern int cifs_get_inode_info_unix(struct inode **pinode,
  99                         const unsigned char *search_path,
 100                         struct super_block *sb, int xid);
 101 extern void acl_to_uid_mode(struct inode *inode, const char *path,
 102                             const __u16 *pfid);
 103 extern int mode_to_acl(struct inode *inode, const char *path, __u64);
 104
 105 extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
 106                         const char *);
 107 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
 108 extern void cifs_dfs_release_automount_timer(void);
 109 void cifs_proc_init(void);
 110 void cifs_proc_clean(void);
 111
 112 extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
 113                         struct nls_table *nls_info);
 114 extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
 115
 116 extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
 117                         const char *tree, struct cifsTconInfo *tcon,
 118                         const struct nls_table *);
 119
 120 extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
 121                 const char *searchName, const struct nls_table *nls_codepage,
 122                 __u16 *searchHandle, struct cifs_search_info *psrch_inf,
 123                 int map, const char dirsep);
 124
 125 extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
 126                 __u16 searchHandle, struct cifs_search_info *psrch_inf);
 127
 128 extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
 129                         const __u16 search_handle);
 130
 131 extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
 132                         const unsigned char *searchName,
 133                         FILE_ALL_INFO *findData,
 134                         int legacy /* whether to use old info level */,
 135                         const struct nls_table *nls_codepage, int remap);
 136 extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
 137                         const unsigned char *searchName,
 138                         FILE_ALL_INFO *findData,
 139                         const struct nls_table *nls_codepage, int remap);
 140
 141 extern int CIFSSMBUnixQPathInfo(const int xid,
 142                         struct cifsTconInfo *tcon,
 143                         const unsigned char *searchName,
 144                         FILE_UNIX_BASIC_INFO *pFindData,
 145                         const struct nls_table *nls_codepage, int remap);
 146
 147 extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
 148                         const unsigned char *searchName,
 149                         struct dfs_info3_param **target_nodes,
 150                         unsigned int *number_of_nodes_in_array,
 151                         const struct nls_table *nls_codepage, int remap);
 152
 153 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 154                         const char *old_path,
 155                         const struct nls_table *nls_codepage,
 156                         unsigned int *pnum_referrals,
 157                         struct dfs_info3_param **preferrals,
 158                         int remap);
 159 extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
 160                                  struct super_block *sb, struct smb_vol *vol);
 161 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
 162                         struct kstatfs *FSData);
 163 extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
 164                         struct kstatfs *FSData);
 165 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
 166                         __u64 cap);
 167
 168 extern int CIFSSMBQFSAttributeInfo(const int xid,
 169                         struct cifsTconInfo *tcon);
 170 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
 171 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
 172 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
 173                         struct kstatfs *FSData);
 174
 175 extern int CIFSSMBSetPathInfo(const int xid, struct cifsTconInfo *tcon,
 176                         const char *fileName, const FILE_BASIC_INFO *data,
 177                         const struct nls_table *nls_codepage,
 178                         int remap_special_chars);
 179 extern int CIFSSMBSetFileInfo(const int xid, struct cifsTconInfo *tcon,
 180                         const FILE_BASIC_INFO *data, __u16 fid,
 181                         __u32 pid_of_opener);
 182 extern int CIFSSMBSetFileDisposition(const int xid, struct cifsTconInfo *tcon,
 183                         bool delete_file, __u16 fid, __u32 pid_of_opener);
 184 #if 0
 185 extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
 186                         char *fileName, __u16 dos_attributes,
 187                         const struct nls_table *nls_codepage);
 188 #endif /* possibly unneeded function */
 189 extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
 190                         const char *fileName, __u64 size,
 191                         bool setAllocationSizeFlag,
 192                         const struct nls_table *nls_codepage,
 193                         int remap_special_chars);
 194 extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
 195                          __u64 size, __u16 fileHandle, __u32 opener_pid,
 196                         bool AllocSizeFlag);
 197
 198 struct cifs_unix_set_info_args {
 199         __u64   ctime;
 200         __u64   atime;
 201         __u64   mtime;
 202         __u64   mode;
 203         __u64   uid;
 204         __u64   gid;
 205         dev_t   device;
 206 };
 207
 208 extern int CIFSSMBUnixSetInfo(const int xid, struct cifsTconInfo *pTcon,
 209                         char *fileName,
 210                         const struct cifs_unix_set_info_args *args,
 211                         const struct nls_table *nls_codepage,
 212                         int remap_special_chars);
 213
 214 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
 215                         const char *newName,
 216                         const struct nls_table *nls_codepage,
 217                         int remap_special_chars);
 218 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
 219                         const char *name, const struct nls_table *nls_codepage,
 220                         int remap_special_chars);
 221 extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
 222                         const char *name, __u16 type,
 223                         const struct nls_table *nls_codepage,
 224                         int remap_special_chars);
 225 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
 226                         const char *name,
 227                         const struct nls_table *nls_codepage,
 228                         int remap_special_chars);
 229 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
 230                         const char *fromName, const char *toName,
 231                         const struct nls_table *nls_codepage,
 232                         int remap_special_chars);
 233 extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
 234                         int netfid, const char *target_name,
 235                         const struct nls_table *nls_codepage,
 236                         int remap_special_chars);
 237 extern int CIFSCreateHardLink(const int xid,
 238                         struct cifsTconInfo *tcon,
 239                         const char *fromName, const char *toName,
 240                         const struct nls_table *nls_codepage,
 241                         int remap_special_chars);
 242 extern int CIFSUnixCreateHardLink(const int xid,
 243                         struct cifsTconInfo *tcon,
 244                         const char *fromName, const char *toName,
 245                         const struct nls_table *nls_codepage,
 246                         int remap_special_chars);
 247 extern int CIFSUnixCreateSymLink(const int xid,
 248                         struct cifsTconInfo *tcon,
 249                         const char *fromName, const char *toName,
 250                         const struct nls_table *nls_codepage);
 251 extern int CIFSSMBUnixQuerySymLink(const int xid,
 252                         struct cifsTconInfo *tcon,
 253                         const unsigned char *searchName,
 254                         char *syminfo, const int buflen,
 255                         const struct nls_table *nls_codepage);
 256 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
 257                         struct cifsTconInfo *tcon,
 258                         const unsigned char *searchName,
 259                         char *symlinkinfo, const int buflen, __u16 fid,
 260                         const struct nls_table *nls_codepage);
 261
 262 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
 263                         const char *fileName, const int disposition,
 264                         const int access_flags, const int omode,
 265                         __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
 266                         const struct nls_table *nls_codepage, int remap);
 267 extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
 268                         const char *fileName, const int disposition,
 269                         const int access_flags, const int omode,
 270                         __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
 271                         const struct nls_table *nls_codepage, int remap);
 272 extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
 273                         u32 posix_flags, __u64 mode, __u16 *netfid,
 274                         FILE_UNIX_BASIC_INFO *pRetData,
 275                         __u32 *pOplock, const char *name,
 276                         const struct nls_table *nls_codepage, int remap);
 277 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
 278                         const int smb_file_id);
 279
 280 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
 281                         const int netfid, unsigned int count,
 282                         const __u64 lseek, unsigned int *nbytes, char **buf,
 283                         int *return_buf_type);
 284 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
 285                         const int netfid, const unsigned int count,
 286                         const __u64 lseek, unsigned int *nbytes,
 287                         const char *buf, const char __user *ubuf,
 288                         const int long_op);
 289 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
 290                         const int netfid, const unsigned int count,
 291                         const __u64 offset, unsigned int *nbytes,
 292                         struct kvec *iov, const int nvec, const int long_op);
 293 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
 294                         const unsigned char *searchName, __u64 *inode_number,
 295                         const struct nls_table *nls_codepage,
 296                         int remap_special_chars);
 297 extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
 298                         const struct nls_table *codepage);
 299 extern int cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
 300                         const struct nls_table *cp, int mapChars);
 301
 302 extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
 303                         const __u16 netfid, const __u64 len,
 304                         const __u64 offset, const __u32 numUnlock,
 305                         const __u32 numLock, const __u8 lockType,
 306                         const bool waitFlag);
 307 extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
 308                         const __u16 smb_file_id, const int get_flag,
 309                         const __u64 len, struct file_lock *,
 310                         const __u16 lock_type, const bool waitFlag);
 311 extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
 312 extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
 313
 314 extern struct cifsSesInfo *sesInfoAlloc(void);
 315 extern void sesInfoFree(struct cifsSesInfo *);
 316 extern struct cifsTconInfo *tconInfoAlloc(void);
 317 extern void tconInfoFree(struct cifsTconInfo *);
 318
 319 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
 320 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
 321                           __u32 *);
 322 extern int cifs_verify_signature(struct smb_hdr *,
 323                                  const struct mac_key *mac_key,
 324                                 __u32 expected_sequence_number);
 325 extern int cifs_calculate_mac_key(struct mac_key *key, const char *rn,
 326                                  const char *pass);
 327 extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
 328                         const struct nls_table *);
 329 extern void CalcNTLMv2_response(const struct cifsSesInfo *, char *);
 330 extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
 331                              const struct nls_table *);
 332 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 333 extern void calc_lanman_hash(const char *password, const char *cryptkey,
 334                                 bool encrypt, char *lnm_session_key);
 335 #endif /* CIFS_WEAK_PW_HASH */
 336 extern int CIFSSMBCopy(int xid,
 337                         struct cifsTconInfo *source_tcon,
 338                         const char *fromName,
 339                         const __u16 target_tid,
 340                         const char *toName, const int flags,
 341                         const struct nls_table *nls_codepage,
 342                         int remap_special_chars);
 343 extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
 344                         const int notify_subdirs, const __u16 netfid,
 345                         __u32 filter, struct file *file, int multishot,
 346                         const struct nls_table *nls_codepage);
 347 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
 348                         const unsigned char *searchName, char *EAData,
 349                         size_t bufsize, const struct nls_table *nls_codepage,
 350                         int remap_special_chars);
 351 extern ssize_t CIFSSMBQueryEA(const int xid, struct cifsTconInfo *tcon,
 352                 const unsigned char *searchName, const unsigned char *ea_name,
 353                 unsigned char *ea_value, size_t buf_size,
 354                 const struct nls_table *nls_codepage, int remap_special_chars);
 355 extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
 356                 const char *fileName, const char *ea_name,
 357                 const void *ea_value, const __u16 ea_value_len,
 358                 const struct nls_table *nls_codepage, int remap_special_chars);
 359 extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
 360                         __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
 361 extern int CIFSSMBSetCIFSACL(const int, struct cifsTconInfo *, __u16,
 362                         struct cifs_ntsd *, __u32);
 363 extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
 364                 const unsigned char *searchName,
 365                 char *acl_inf, const int buflen, const int acl_type,
 366                 const struct nls_table *nls_codepage, int remap_special_chars);
 367 extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
 368                 const unsigned char *fileName,
 369                 const char *local_acl, const int buflen, const int acl_type,
 370                 const struct nls_table *nls_codepage, int remap_special_chars);
 371 extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
 372                         const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
 373 #endif                  /* _CIFSPROTO_H */