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_convert_address(char *src, 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 timespec cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
  90 extern u64 cifs_UnixTimeToNT(struct timespec);
  91 extern struct timespec cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
  92                                       int offset);
  93
  94 extern struct cifsFileInfo *cifs_new_fileinfo(struct inode *newinode,
  95                                 __u16 fileHandle, struct file *file,
  96                                 struct vfsmount *mnt, unsigned int oflags);
  97 extern int cifs_posix_open(char *full_path, struct inode **pinode,
  98                            struct vfsmount *mnt, int mode, int oflags,
  99                            __u32 *poplock, __u16 *pnetfid, int xid);
 100 extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
 101                                      FILE_UNIX_BASIC_INFO *info,
 102                                      struct cifs_sb_info *cifs_sb);
 103 extern void cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
 104 extern struct inode *cifs_iget(struct super_block *sb,
 105                                struct cifs_fattr *fattr);
 106
 107 extern int cifs_get_inode_info(struct inode **pinode,
 108                         const unsigned char *search_path,
 109                         FILE_ALL_INFO *pfile_info,
 110                         struct super_block *sb, int xid, const __u16 *pfid);
 111 extern int cifs_get_inode_info_unix(struct inode **pinode,
 112                         const unsigned char *search_path,
 113                         struct super_block *sb, int xid);
 114 extern void cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
 115                               struct cifs_fattr *fattr, struct inode *inode,
 116                               const char *path, const __u16 *pfid);
 117 extern int mode_to_acl(struct inode *inode, const char *path, __u64);
 118
 119 extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
 120                         const char *);
 121 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
 122 extern void cifs_dfs_release_automount_timer(void);
 123 void cifs_proc_init(void);
 124 void cifs_proc_clean(void);
 125
 126 extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
 127                         struct nls_table *nls_info);
 128 extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
 129
 130 extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
 131                         const char *tree, struct cifsTconInfo *tcon,
 132                         const struct nls_table *);
 133
 134 extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
 135                 const char *searchName, const struct nls_table *nls_codepage,
 136                 __u16 *searchHandle, struct cifs_search_info *psrch_inf,
 137                 int map, const char dirsep);
 138
 139 extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
 140                 __u16 searchHandle, struct cifs_search_info *psrch_inf);
 141
 142 extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
 143                         const __u16 search_handle);
 144
 145 extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
 146                         const unsigned char *searchName,
 147                         FILE_ALL_INFO *findData,
 148                         int legacy /* whether to use old info level */,
 149                         const struct nls_table *nls_codepage, int remap);
 150 extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
 151                         const unsigned char *searchName,
 152                         FILE_ALL_INFO *findData,
 153                         const struct nls_table *nls_codepage, int remap);
 154
 155 extern int CIFSSMBUnixQPathInfo(const int xid,
 156                         struct cifsTconInfo *tcon,
 157                         const unsigned char *searchName,
 158                         FILE_UNIX_BASIC_INFO *pFindData,
 159                         const struct nls_table *nls_codepage, int remap);
 160
 161 extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
 162                         const unsigned char *searchName,
 163                         struct dfs_info3_param **target_nodes,
 164                         unsigned int *number_of_nodes_in_array,
 165                         const struct nls_table *nls_codepage, int remap);
 166
 167 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 168                         const char *old_path,
 169                         const struct nls_table *nls_codepage,
 170                         unsigned int *pnum_referrals,
 171                         struct dfs_info3_param **preferrals,
 172                         int remap);
 173 extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
 174                                  struct super_block *sb, struct smb_vol *vol);
 175 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
 176                         struct kstatfs *FSData);
 177 extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
 178                         struct kstatfs *FSData);
 179 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
 180                         __u64 cap);
 181
 182 extern int CIFSSMBQFSAttributeInfo(const int xid,
 183                         struct cifsTconInfo *tcon);
 184 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
 185 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
 186 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
 187                         struct kstatfs *FSData);
 188
 189 extern int CIFSSMBSetPathInfo(const int xid, struct cifsTconInfo *tcon,
 190                         const char *fileName, const FILE_BASIC_INFO *data,
 191                         const struct nls_table *nls_codepage,
 192                         int remap_special_chars);
 193 extern int CIFSSMBSetFileInfo(const int xid, struct cifsTconInfo *tcon,
 194                         const FILE_BASIC_INFO *data, __u16 fid,
 195                         __u32 pid_of_opener);
 196 extern int CIFSSMBSetFileDisposition(const int xid, struct cifsTconInfo *tcon,
 197                         bool delete_file, __u16 fid, __u32 pid_of_opener);
 198 #if 0
 199 extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
 200                         char *fileName, __u16 dos_attributes,
 201                         const struct nls_table *nls_codepage);
 202 #endif /* possibly unneeded function */
 203 extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
 204                         const char *fileName, __u64 size,
 205                         bool setAllocationSizeFlag,
 206                         const struct nls_table *nls_codepage,
 207                         int remap_special_chars);
 208 extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
 209                          __u64 size, __u16 fileHandle, __u32 opener_pid,
 210                         bool AllocSizeFlag);
 211
 212 struct cifs_unix_set_info_args {
 213         __u64   ctime;
 214         __u64   atime;
 215         __u64   mtime;
 216         __u64   mode;
 217         __u64   uid;
 218         __u64   gid;
 219         dev_t   device;
 220 };
 221
 222 extern int CIFSSMBUnixSetFileInfo(const int xid, struct cifsTconInfo *tcon,
 223                                   const struct cifs_unix_set_info_args *args,
 224                                   u16 fid, u32 pid_of_opener);
 225
 226 extern int CIFSSMBUnixSetPathInfo(const int xid, struct cifsTconInfo *pTcon,
 227                         char *fileName,
 228                         const struct cifs_unix_set_info_args *args,
 229                         const struct nls_table *nls_codepage,
 230                         int remap_special_chars);
 231
 232 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
 233                         const char *newName,
 234                         const struct nls_table *nls_codepage,
 235                         int remap_special_chars);
 236 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
 237                         const char *name, const struct nls_table *nls_codepage,
 238                         int remap_special_chars);
 239 extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
 240                         const char *name, __u16 type,
 241                         const struct nls_table *nls_codepage,
 242                         int remap_special_chars);
 243 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
 244                         const char *name,
 245                         const struct nls_table *nls_codepage,
 246                         int remap_special_chars);
 247 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
 248                         const char *fromName, const char *toName,
 249                         const struct nls_table *nls_codepage,
 250                         int remap_special_chars);
 251 extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
 252                         int netfid, const char *target_name,
 253                         const struct nls_table *nls_codepage,
 254                         int remap_special_chars);
 255 extern int CIFSCreateHardLink(const int xid,
 256                         struct cifsTconInfo *tcon,
 257                         const char *fromName, const char *toName,
 258                         const struct nls_table *nls_codepage,
 259                         int remap_special_chars);
 260 extern int CIFSUnixCreateHardLink(const int xid,
 261                         struct cifsTconInfo *tcon,
 262                         const char *fromName, const char *toName,
 263                         const struct nls_table *nls_codepage,
 264                         int remap_special_chars);
 265 extern int CIFSUnixCreateSymLink(const int xid,
 266                         struct cifsTconInfo *tcon,
 267                         const char *fromName, const char *toName,
 268                         const struct nls_table *nls_codepage);
 269 extern int CIFSSMBUnixQuerySymLink(const int xid,
 270                         struct cifsTconInfo *tcon,
 271                         const unsigned char *searchName, char **syminfo,
 272                         const struct nls_table *nls_codepage);
 273 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
 274                         struct cifsTconInfo *tcon,
 275                         const unsigned char *searchName,
 276                         char *symlinkinfo, const int buflen, __u16 fid,
 277                         const struct nls_table *nls_codepage);
 278
 279 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
 280                         const char *fileName, const int disposition,
 281                         const int access_flags, const int omode,
 282                         __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
 283                         const struct nls_table *nls_codepage, int remap);
 284 extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
 285                         const char *fileName, const int disposition,
 286                         const int access_flags, const int omode,
 287                         __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
 288                         const struct nls_table *nls_codepage, int remap);
 289 extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
 290                         u32 posix_flags, __u64 mode, __u16 *netfid,
 291                         FILE_UNIX_BASIC_INFO *pRetData,
 292                         __u32 *pOplock, const char *name,
 293                         const struct nls_table *nls_codepage, int remap);
 294 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
 295                         const int smb_file_id);
 296
 297 extern int CIFSSMBFlush(const int xid, struct cifsTconInfo *tcon,
 298                         const int smb_file_id);
 299
 300 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
 301                         const int netfid, unsigned int count,
 302                         const __u64 lseek, unsigned int *nbytes, char **buf,
 303                         int *return_buf_type);
 304 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
 305                         const int netfid, const unsigned int count,
 306                         const __u64 lseek, unsigned int *nbytes,
 307                         const char *buf, const char __user *ubuf,
 308                         const int long_op);
 309 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
 310                         const int netfid, const unsigned int count,
 311                         const __u64 offset, unsigned int *nbytes,
 312                         struct kvec *iov, const int nvec, const int long_op);
 313 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
 314                         const unsigned char *searchName, __u64 *inode_number,
 315                         const struct nls_table *nls_codepage,
 316                         int remap_special_chars);
 317 extern int cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
 318                         const struct nls_table *cp, int mapChars);
 319
 320 extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
 321                         const __u16 netfid, const __u64 len,
 322                         const __u64 offset, const __u32 numUnlock,
 323                         const __u32 numLock, const __u8 lockType,
 324                         const bool waitFlag);
 325 extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
 326                         const __u16 smb_file_id, const int get_flag,
 327                         const __u64 len, struct file_lock *,
 328                         const __u16 lock_type, const bool waitFlag);
 329 extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
 330 extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
 331
 332 extern struct cifsSesInfo *sesInfoAlloc(void);
 333 extern void sesInfoFree(struct cifsSesInfo *);
 334 extern struct cifsTconInfo *tconInfoAlloc(void);
 335 extern void tconInfoFree(struct cifsTconInfo *);
 336
 337 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
 338 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
 339                           __u32 *);
 340 extern int cifs_verify_signature(struct smb_hdr *,
 341                                  const struct mac_key *mac_key,
 342                                 __u32 expected_sequence_number);
 343 extern int cifs_calculate_mac_key(struct mac_key *key, const char *rn,
 344                                  const char *pass);
 345 extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
 346                         const struct nls_table *);
 347 extern void CalcNTLMv2_response(const struct cifsSesInfo *, char *);
 348 extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
 349                              const struct nls_table *);
 350 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 351 extern void calc_lanman_hash(const char *password, const char *cryptkey,
 352                                 bool encrypt, char *lnm_session_key);
 353 #endif /* CIFS_WEAK_PW_HASH */
 354 extern int CIFSSMBCopy(int xid,
 355                         struct cifsTconInfo *source_tcon,
 356                         const char *fromName,
 357                         const __u16 target_tid,
 358                         const char *toName, const int flags,
 359                         const struct nls_table *nls_codepage,
 360                         int remap_special_chars);
 361 extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
 362                         const int notify_subdirs, const __u16 netfid,
 363                         __u32 filter, struct file *file, int multishot,
 364                         const struct nls_table *nls_codepage);
 365 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
 366                         const unsigned char *searchName, char *EAData,
 367                         size_t bufsize, const struct nls_table *nls_codepage,
 368                         int remap_special_chars);
 369 extern ssize_t CIFSSMBQueryEA(const int xid, struct cifsTconInfo *tcon,
 370                 const unsigned char *searchName, const unsigned char *ea_name,
 371                 unsigned char *ea_value, size_t buf_size,
 372                 const struct nls_table *nls_codepage, int remap_special_chars);
 373 extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
 374                 const char *fileName, const char *ea_name,
 375                 const void *ea_value, const __u16 ea_value_len,
 376                 const struct nls_table *nls_codepage, int remap_special_chars);
 377 extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
 378                         __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
 379 extern int CIFSSMBSetCIFSACL(const int, struct cifsTconInfo *, __u16,
 380                         struct cifs_ntsd *, __u32);
 381 extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
 382                 const unsigned char *searchName,
 383                 char *acl_inf, const int buflen, const int acl_type,
 384                 const struct nls_table *nls_codepage, int remap_special_chars);
 385 extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
 386                 const unsigned char *fileName,
 387                 const char *local_acl, const int buflen, const int acl_type,
 388                 const struct nls_table *nls_codepage, int remap_special_chars);
 389 extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
 390                         const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
 391 #endif                  /* _CIFSPROTO_H */