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