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