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