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