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",__FUNCTION__, xid,current->fsuid));
  43 #define FreeXid(curr_xid) {_FreeXid(curr_xid); cFYI(1,("CIFS VFS: leaving %s (xid = %d) rc = %d",__FUNCTION__,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 *,
  58                                 struct smb_hdr * /* input */ ,
  59                                 struct smb_hdr * /* out */ ,
  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);
  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 *search_path);
 100 extern int mode_to_acl(struct inode *inode, const char *path, __u64);
 101
 102 extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
 103                         const char *);
 104 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
 105 #ifdef CONFIG_CIFS_DFS_UPCALL
 106 extern void dfs_shrink_umount_helper(struct vfsmount *vfsmnt);
 107 #endif
 108 void cifs_proc_init(void);
 109 void cifs_proc_clean(void);
 110
 111 extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
 112                         struct nls_table *nls_info);
 113 extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
 114
 115 extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
 116                         const char *tree, struct cifsTconInfo *tcon,
 117                         const struct nls_table *);
 118
 119 extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
 120                 const char *searchName, const struct nls_table *nls_codepage,
 121                 __u16 *searchHandle, struct cifs_search_info *psrch_inf,
 122                 int map, const char dirsep);
 123
 124 extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
 125                 __u16 searchHandle, struct cifs_search_info *psrch_inf);
 126
 127 extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
 128                         const __u16 search_handle);
 129
 130 extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
 131                         const unsigned char *searchName,
 132                         FILE_ALL_INFO * findData,
 133                         int legacy /* whether to use old info level */,
 134                         const struct nls_table *nls_codepage, int remap);
 135 extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
 136                         const unsigned char *searchName,
 137                         FILE_ALL_INFO *findData,
 138                         const struct nls_table *nls_codepage, int remap);
 139
 140 extern int CIFSSMBUnixQPathInfo(const int xid,
 141                         struct cifsTconInfo *tcon,
 142                         const unsigned char *searchName,
 143                         FILE_UNIX_BASIC_INFO * pFindData,
 144                         const struct nls_table *nls_codepage, int remap);
 145
 146 extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
 147                         const unsigned char *searchName,
 148                         unsigned char **targetUNCs,
 149                         unsigned int *number_of_UNC_in_array,
 150                         const struct nls_table *nls_codepage, int remap);
 151
 152 extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 153                         const char *old_path,
 154                         const struct nls_table *nls_codepage, int remap);
 155 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 156                         const char *old_path,
 157                         const struct nls_table *nls_codepage,
 158                         unsigned int *pnum_referrals,
 159                         struct dfs_info3_param **preferrals,
 160                         int remap);
 161 extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
 162                                  struct super_block *sb, struct smb_vol *vol);
 163 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
 164                         struct kstatfs *FSData);
 165 extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
 166                         struct kstatfs *FSData);
 167 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
 168                         __u64 cap);
 169
 170 extern int CIFSSMBQFSAttributeInfo(const int xid,
 171                         struct cifsTconInfo *tcon);
 172 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
 173 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
 174 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
 175                         struct kstatfs *FSData);
 176
 177 extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
 178                         const char *fileName, const FILE_BASIC_INFO * data,
 179                         const struct nls_table *nls_codepage,
 180                         int remap_special_chars);
 181 extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
 182                         const FILE_BASIC_INFO * data, __u16 fid);
 183 #if 0
 184 extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
 185                         char *fileName, __u16 dos_attributes,
 186                         const struct nls_table *nls_codepage);
 187 #endif /* possibly unneeded function */
 188 extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
 189                         const char *fileName, __u64 size,
 190                         int setAllocationSizeFlag,
 191                         const struct nls_table *nls_codepage,
 192                         int remap_special_chars);
 193 extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
 194                          __u64 size, __u16 fileHandle, __u32 opener_pid,
 195                         int AllocSizeFlag);
 196 extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
 197                         char *full_path, __u64 mode, __u64 uid,
 198                         __u64 gid, dev_t dev,
 199                         const struct nls_table *nls_codepage,
 200                         int remap_special_chars);
 201
 202 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
 203                         const char *newName,
 204                         const struct nls_table *nls_codepage,
 205                         int remap_special_chars);
 206 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
 207                         const char *name, const struct nls_table *nls_codepage,
 208                         int remap_special_chars);
 209 extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
 210                         const char *name, __u16 type,
 211                         const struct nls_table *nls_codepage,
 212                         int remap_special_chars);
 213 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
 214                         const char *name,
 215                         const struct nls_table *nls_codepage,
 216                         int remap_special_chars);
 217 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
 218                         const char *fromName, const char *toName,
 219                         const struct nls_table *nls_codepage,
 220                         int remap_special_chars);
 221 extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
 222                         int netfid, char *target_name,
 223                         const struct nls_table *nls_codepage,
 224                         int remap_special_chars);
 225 extern int CIFSCreateHardLink(const int xid,
 226                         struct cifsTconInfo *tcon,
 227                         const char *fromName, const char *toName,
 228                         const struct nls_table *nls_codepage,
 229                         int remap_special_chars);
 230 extern int CIFSUnixCreateHardLink(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 CIFSUnixCreateSymLink(const int xid,
 236                         struct cifsTconInfo *tcon,
 237                         const char *fromName, const char *toName,
 238                         const struct nls_table *nls_codepage);
 239 extern int CIFSSMBUnixQuerySymLink(const int xid,
 240                         struct cifsTconInfo *tcon,
 241                         const unsigned char *searchName,
 242                         char *syminfo, const int buflen,
 243                         const struct nls_table *nls_codepage);
 244 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
 245                         struct cifsTconInfo *tcon,
 246                         const unsigned char *searchName,
 247                         char *symlinkinfo, const int buflen, __u16 fid,
 248                         const struct nls_table *nls_codepage);
 249
 250 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
 251                         const char *fileName, const int disposition,
 252                         const int access_flags, const int omode,
 253                         __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
 254                         const struct nls_table *nls_codepage, int remap);
 255 extern int SMBLegacyOpen(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 CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
 261                         u32 posix_flags, __u64 mode, __u16 *netfid,
 262                         FILE_UNIX_BASIC_INFO *pRetData,
 263                         __u32 *pOplock, const char *name,
 264                         const struct nls_table *nls_codepage, int remap);
 265 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
 266                         const int smb_file_id);
 267
 268 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
 269                         const int netfid, unsigned int count,
 270                         const __u64 lseek, unsigned int *nbytes, char **buf,
 271                         int *return_buf_type);
 272 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
 273                         const int netfid, const unsigned int count,
 274                         const __u64 lseek, unsigned int *nbytes,
 275                         const char *buf, const char __user *ubuf,
 276                         const int long_op);
 277 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
 278                         const int netfid, const unsigned int count,
 279                         const __u64 offset, unsigned int *nbytes,
 280                         struct kvec *iov, const int nvec, const int long_op);
 281 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
 282                         const unsigned char *searchName, __u64 *inode_number,
 283                         const struct nls_table *nls_codepage,
 284                         int remap_special_chars);
 285 extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
 286                         const struct nls_table *codepage);
 287 extern int cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
 288                         const struct nls_table *cp, int mapChars);
 289
 290 extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
 291                         const __u16 netfid, const __u64 len,
 292                         const __u64 offset, const __u32 numUnlock,
 293                         const __u32 numLock, const __u8 lockType,
 294                         const int waitFlag);
 295 extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
 296                         const __u16 smb_file_id, const int get_flag,
 297                         const __u64 len, struct file_lock *,
 298                         const __u16 lock_type, const int waitFlag);
 299 extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
 300 extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
 301
 302 extern struct cifsSesInfo *sesInfoAlloc(void);
 303 extern void sesInfoFree(struct cifsSesInfo *);
 304 extern struct cifsTconInfo *tconInfoAlloc(void);
 305 extern void tconInfoFree(struct cifsTconInfo *);
 306
 307 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
 308 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
 309                           __u32 *);
 310 extern int cifs_verify_signature(struct smb_hdr *,
 311                                  const struct mac_key *mac_key,
 312                                 __u32 expected_sequence_number);
 313 extern int cifs_calculate_mac_key(struct mac_key *key, const char *rn,
 314                                  const char *pass);
 315 extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
 316                         const struct nls_table *);
 317 extern void CalcNTLMv2_response(const struct cifsSesInfo *, char *);
 318 extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
 319                              const struct nls_table *);
 320 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 321 extern void calc_lanman_hash(struct cifsSesInfo *ses, char *lnm_session_key);
 322 #endif /* CIFS_WEAK_PW_HASH */
 323 extern int CIFSSMBCopy(int xid,
 324                         struct cifsTconInfo *source_tcon,
 325                         const char *fromName,
 326                         const __u16 target_tid,
 327                         const char *toName, const int flags,
 328                         const struct nls_table *nls_codepage,
 329                         int remap_special_chars);
 330 extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
 331                         const int notify_subdirs, const __u16 netfid,
 332                         __u32 filter, struct file *file, int multishot,
 333                         const struct nls_table *nls_codepage);
 334 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
 335                         const unsigned char *searchName, char *EAData,
 336                         size_t bufsize, const struct nls_table *nls_codepage,
 337                         int remap_special_chars);
 338 extern ssize_t CIFSSMBQueryEA(const int xid, struct cifsTconInfo *tcon,
 339                 const unsigned char *searchName, const unsigned char *ea_name,
 340                 unsigned char *ea_value, size_t buf_size,
 341                 const struct nls_table *nls_codepage, int remap_special_chars);
 342 extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
 343                 const char *fileName, const char *ea_name,
 344                 const void *ea_value, const __u16 ea_value_len,
 345                 const struct nls_table *nls_codepage, int remap_special_chars);
 346 extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
 347                         __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
 348 extern int CIFSSMBSetCIFSACL(const int, struct cifsTconInfo *, __u16,
 349                         struct cifs_ntsd *, __u32);
 350 extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
 351                 const unsigned char *searchName,
 352                 char *acl_inf, const int buflen, const int acl_type,
 353                 const struct nls_table *nls_codepage, int remap_special_chars);
 354 extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
 355                 const unsigned char *fileName,
 356                 const char *local_acl, const int buflen, const int acl_type,
 357                 const struct nls_table *nls_codepage, int remap_special_chars);
 358 extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
 359                         const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
 360 #endif                  /* _CIFSPROTO_H */