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 socket *, struct smb_hdr *,
  39                         unsigned int /* length */ , struct sockaddr *);
  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 *build_wildcard_path_from_dentry(struct dentry *direntry);
  46 /* extern void renew_parental_timestamps(struct dentry *direntry);*/
  47 extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
  48                         struct smb_hdr * /* input */ ,
  49                         struct smb_hdr * /* out */ ,
  50                         int * /* bytes returned */ , const int long_op);
  51 extern int SendReceiveNoRsp(const unsigned int xid, struct cifsSesInfo *ses,
  52                         struct smb_hdr *in_buf, int flags);
  53 extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
  54                         struct kvec *, int /* nvec to send */,
  55                         int * /* type of buf returned */ , const int flags);
  56 extern int SendReceiveBlockingLock(const unsigned int xid,
  57                         struct cifsTconInfo *ptcon,
  58                         struct smb_hdr *in_buf ,
  59                         struct smb_hdr *out_buf,
  60                         int *bytes_returned);
  61 extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
  62 extern int is_valid_oplock_break(struct smb_hdr *smb, struct TCP_Server_Info *);
  63 extern int is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
  64 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
  65 #ifdef CONFIG_CIFS_EXPERIMENTAL
  66 extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *);
  67 #endif
  68 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
  69 extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
  70 extern int decode_negTokenInit(unsigned char *security_blob, int length,
  71                         enum securityEnum *secType);
  72 extern int cifs_inet_pton(int, char *source, void *dst);
  73 extern int map_smb_to_linux_error(struct smb_hdr *smb, int logErr);
  74 extern void header_assemble(struct smb_hdr *, char /* command */ ,
  75                             const struct cifsTconInfo *, int /* length of
  76                             fixed section (word count) in two byte units */);
  77 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
  78                                 struct cifsSesInfo *ses,
  79                                 void **request_buf);
  80 extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
  81                              const int stage,
  82                              const struct nls_table *nls_cp);
  83 extern __u16 GetNextMid(struct TCP_Server_Info *server);
  84 extern struct oplock_q_entry *AllocOplockQEntry(struct inode *, u16,
  85                                                  struct cifsTconInfo *);
  86 extern void DeleteOplockQEntry(struct oplock_q_entry *);
  87 extern struct timespec cifs_NTtimeToUnix(u64 utc_nanoseconds_since_1601);
  88 extern u64 cifs_UnixTimeToNT(struct timespec);
  89 extern __le64 cnvrtDosCifsTm(__u16 date, __u16 time);
  90 extern struct timespec cnvrtDosUnixTm(__u16 date, __u16 time);
  91
  92 extern int cifs_get_inode_info(struct inode **pinode,
  93                         const unsigned char *search_path,
  94                         FILE_ALL_INFO * pfile_info,
  95                         struct super_block *sb, int xid, const __u16 *pfid);
  96 extern int cifs_get_inode_info_unix(struct inode **pinode,
  97                         const unsigned char *search_path,
  98                         struct super_block *sb, int xid);
  99 extern void acl_to_uid_mode(struct inode *inode, const char *path,
 100                             const __u16 *pfid);
 101 extern int mode_to_acl(struct inode *inode, const char *path, __u64);
 102
 103 extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
 104                         const char *);
 105 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
 106 #ifdef CONFIG_CIFS_DFS_UPCALL
 107 extern void dfs_shrink_umount_helper(struct vfsmount *vfsmnt);
 108 #else
 109 static inline void dfs_shrink_umount_helper(struct vfsmount *vfsmnt)
 110 {
 111 }
 112 #endif /* DFS_UPCALL */
 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                         unsigned char **targetUNCs,
 154                         unsigned int *number_of_UNC_in_array,
 155                         const struct nls_table *nls_codepage, int remap);
 156
 157 extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 158                         const char *old_path,
 159                         const struct nls_table *nls_codepage, int remap);
 160 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 161                         const char *old_path,
 162                         const struct nls_table *nls_codepage,
 163                         unsigned int *pnum_referrals,
 164                         struct dfs_info3_param **preferrals,
 165                         int remap);
 166 extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
 167                                  struct super_block *sb, struct smb_vol *vol);
 168 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
 169                         struct kstatfs *FSData);
 170 extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
 171                         struct kstatfs *FSData);
 172 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
 173                         __u64 cap);
 174
 175 extern int CIFSSMBQFSAttributeInfo(const int xid,
 176                         struct cifsTconInfo *tcon);
 177 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
 178 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
 179 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
 180                         struct kstatfs *FSData);
 181
 182 extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
 183                         const char *fileName, const FILE_BASIC_INFO *data,
 184                         const struct nls_table *nls_codepage,
 185                         int remap_special_chars);
 186 extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
 187                         const FILE_BASIC_INFO *data, __u16 fid);
 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                         int 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                         int AllocSizeFlag);
 201 extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
 202                         char *full_path, __u64 mode, __u64 uid,
 203                         __u64 gid, dev_t dev,
 204                         const struct nls_table *nls_codepage,
 205                         int remap_special_chars);
 206
 207 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
 208                         const char *newName,
 209                         const struct nls_table *nls_codepage,
 210                         int remap_special_chars);
 211 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
 212                         const char *name, const struct nls_table *nls_codepage,
 213                         int remap_special_chars);
 214 extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
 215                         const char *name, __u16 type,
 216                         const struct nls_table *nls_codepage,
 217                         int remap_special_chars);
 218 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
 219                         const char *name,
 220                         const struct nls_table *nls_codepage,
 221                         int remap_special_chars);
 222 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
 223                         const char *fromName, const char *toName,
 224                         const struct nls_table *nls_codepage,
 225                         int remap_special_chars);
 226 extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
 227                         int netfid, char *target_name,
 228                         const struct nls_table *nls_codepage,
 229                         int remap_special_chars);
 230 extern int CIFSCreateHardLink(const int xid,
 231                         struct cifsTconInfo *tcon,
 232                         const char *fromName, const char *toName,
 233                         const struct nls_table *nls_codepage,
 234                         int remap_special_chars);
 235 extern int CIFSUnixCreateHardLink(const int xid,
 236                         struct cifsTconInfo *tcon,
 237                         const char *fromName, const char *toName,
 238                         const struct nls_table *nls_codepage,
 239                         int remap_special_chars);
 240 extern int CIFSUnixCreateSymLink(const int xid,
 241                         struct cifsTconInfo *tcon,
 242                         const char *fromName, const char *toName,
 243                         const struct nls_table *nls_codepage);
 244 extern int CIFSSMBUnixQuerySymLink(const int xid,
 245                         struct cifsTconInfo *tcon,
 246                         const unsigned char *searchName,
 247                         char *syminfo, const int buflen,
 248                         const struct nls_table *nls_codepage);
 249 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
 250                         struct cifsTconInfo *tcon,
 251                         const unsigned char *searchName,
 252                         char *symlinkinfo, const int buflen, __u16 fid,
 253                         const struct nls_table *nls_codepage);
 254
 255 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
 256                         const char *fileName, const int disposition,
 257                         const int access_flags, const int omode,
 258                         __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
 259                         const struct nls_table *nls_codepage, int remap);
 260 extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
 261                         const char *fileName, const int disposition,
 262                         const int access_flags, const int omode,
 263                         __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
 264                         const struct nls_table *nls_codepage, int remap);
 265 extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
 266                         u32 posix_flags, __u64 mode, __u16 *netfid,
 267                         FILE_UNIX_BASIC_INFO *pRetData,
 268                         __u32 *pOplock, const char *name,
 269                         const struct nls_table *nls_codepage, int remap);
 270 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
 271                         const int smb_file_id);
 272
 273 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
 274                         const int netfid, unsigned int count,
 275                         const __u64 lseek, unsigned int *nbytes, char **buf,
 276                         int *return_buf_type);
 277 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
 278                         const int netfid, const unsigned int count,
 279                         const __u64 lseek, unsigned int *nbytes,
 280                         const char *buf, const char __user *ubuf,
 281                         const int long_op);
 282 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
 283                         const int netfid, const unsigned int count,
 284                         const __u64 offset, unsigned int *nbytes,
 285                         struct kvec *iov, const int nvec, const int long_op);
 286 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
 287                         const unsigned char *searchName, __u64 *inode_number,
 288                         const struct nls_table *nls_codepage,
 289                         int remap_special_chars);
 290 extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
 291                         const struct nls_table *codepage);
 292 extern int cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
 293                         const struct nls_table *cp, int mapChars);
 294
 295 extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
 296                         const __u16 netfid, const __u64 len,
 297                         const __u64 offset, const __u32 numUnlock,
 298                         const __u32 numLock, const __u8 lockType,
 299                         const int waitFlag);
 300 extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
 301                         const __u16 smb_file_id, const int get_flag,
 302                         const __u64 len, struct file_lock *,
 303                         const __u16 lock_type, const int waitFlag);
 304 extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
 305 extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
 306
 307 extern struct cifsSesInfo *sesInfoAlloc(void);
 308 extern void sesInfoFree(struct cifsSesInfo *);
 309 extern struct cifsTconInfo *tconInfoAlloc(void);
 310 extern void tconInfoFree(struct cifsTconInfo *);
 311
 312 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
 313 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
 314                           __u32 *);
 315 extern int cifs_verify_signature(struct smb_hdr *,
 316                                  const struct mac_key *mac_key,
 317                                 __u32 expected_sequence_number);
 318 extern int cifs_calculate_mac_key(struct mac_key *key, const char *rn,
 319                                  const char *pass);
 320 extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
 321                         const struct nls_table *);
 322 extern void CalcNTLMv2_response(const struct cifsSesInfo *, char *);
 323 extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
 324                              const struct nls_table *);
 325 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 326 extern void calc_lanman_hash(struct cifsSesInfo *ses, char *lnm_session_key);
 327 #endif /* CIFS_WEAK_PW_HASH */
 328 extern int CIFSSMBCopy(int xid,
 329                         struct cifsTconInfo *source_tcon,
 330                         const char *fromName,
 331                         const __u16 target_tid,
 332                         const char *toName, const int flags,
 333                         const struct nls_table *nls_codepage,
 334                         int remap_special_chars);
 335 extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
 336                         const int notify_subdirs, const __u16 netfid,
 337                         __u32 filter, struct file *file, int multishot,
 338                         const struct nls_table *nls_codepage);
 339 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
 340                         const unsigned char *searchName, char *EAData,
 341                         size_t bufsize, const struct nls_table *nls_codepage,
 342                         int remap_special_chars);
 343 extern ssize_t CIFSSMBQueryEA(const int xid, struct cifsTconInfo *tcon,
 344                 const unsigned char *searchName, const unsigned char *ea_name,
 345                 unsigned char *ea_value, size_t buf_size,
 346                 const struct nls_table *nls_codepage, int remap_special_chars);
 347 extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
 348                 const char *fileName, const char *ea_name,
 349                 const void *ea_value, const __u16 ea_value_len,
 350                 const struct nls_table *nls_codepage, int remap_special_chars);
 351 extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
 352                         __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
 353 extern int CIFSSMBSetCIFSACL(const int, struct cifsTconInfo *, __u16,
 354                         struct cifs_ntsd *, __u32);
 355 extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
 356                 const unsigned char *searchName,
 357                 char *acl_inf, const int buflen, const int acl_type,
 358                 const struct nls_table *nls_codepage, int remap_special_chars);
 359 extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
 360                 const unsigned char *fileName,
 361                 const char *local_acl, const int buflen, const int acl_type,
 362                 const struct nls_table *nls_codepage, int remap_special_chars);
 363 extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
 364                         const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
 365 #endif                  /* _CIFSPROTO_H */