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