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