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