fs/cifs/cifsproto.h

   1 /*
   2  *   fs/cifs/cifsproto.h
   3  *
   4  *   Copyright (c) International Business Machines  Corp., 2002,2006
   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
  27 /*
  28  *****************************************************************
  29  * All Prototypes
  30  *****************************************************************
  31  */
  32
  33 extern struct smb_hdr *cifs_buf_get(void);
  34 extern void cifs_buf_release(void *);
  35 extern struct smb_hdr *cifs_small_buf_get(void);
  36 extern void cifs_small_buf_release(void *);
  37 extern int smb_send(struct socket *, struct smb_hdr *,
  38                         unsigned int /* length */ , struct sockaddr *);
  39 extern unsigned int _GetXid(void);
  40 extern void _FreeXid(unsigned int);
  41 #define GetXid() (int)_GetXid(); cFYI(1,("CIFS VFS: in %s as Xid: %d with uid: %d",__FUNCTION__, xid,current->fsuid));
  42 #define FreeXid(curr_xid) {_FreeXid(curr_xid); cFYI(1,("CIFS VFS: leaving %s (xid = %d) rc = %d",__FUNCTION__,curr_xid,(int)rc));}
  43 extern char *build_path_from_dentry(struct dentry *);
  44 extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
  45 extern void renew_parental_timestamps(struct dentry *direntry);
  46 extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
  47                         struct smb_hdr * /* input */ ,
  48                         struct smb_hdr * /* out */ ,
  49                         int * /* bytes returned */ , const int long_op);
  50 extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
  51                         struct kvec *, int /* nvec to send */,
  52                         int * /* type of buf returned */ , const int long_op);
  53 extern int checkSMBhdr(struct smb_hdr *smb, __u16 mid);
  54 extern int checkSMB(struct smb_hdr *smb, __u16 mid, int length);
  55 extern int is_valid_oplock_break(struct smb_hdr *smb, struct TCP_Server_Info *);
  56 extern int is_size_safe_to_change(struct cifsInodeInfo *);
  57 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
  58 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
  59 extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
  60 extern int decode_negTokenInit(unsigned char *security_blob, int length,
  61                         enum securityEnum *secType);
  62 extern int cifs_inet_pton(int, char * source, void *dst);
  63 extern int map_smb_to_linux_error(struct smb_hdr *smb);
  64 extern void header_assemble(struct smb_hdr *, char /* command */ ,
  65                             const struct cifsTconInfo *, int /* length of
  66                             fixed section (word count) in two byte units */);
  67 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
  68                                 struct cifsSesInfo *ses,
  69                                 void ** request_buf);
  70 extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
  71                              const int stage,
  72                              const struct nls_table *nls_cp);
  73 extern __u16 GetNextMid(struct TCP_Server_Info *server);
  74 extern struct oplock_q_entry * AllocOplockQEntry(struct inode *, u16,
  75                                                  struct cifsTconInfo *);
  76 extern void DeleteOplockQEntry(struct oplock_q_entry *);
  77 extern struct timespec cifs_NTtimeToUnix(u64 /* utc nanoseconds since 1601 */ );
  78 extern u64 cifs_UnixTimeToNT(struct timespec);
  79 extern int cifs_get_inode_info(struct inode **pinode,
  80                         const unsigned char *search_path,
  81                         FILE_ALL_INFO * pfile_info,
  82                         struct super_block *sb, int xid);
  83 extern int cifs_get_inode_info_unix(struct inode **pinode,
  84                         const unsigned char *search_path,
  85                         struct super_block *sb,int xid);
  86
  87 extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
  88                         const char *);
  89 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
  90 void cifs_proc_init(void);
  91 void cifs_proc_clean(void);
  92
  93 extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
  94                         struct nls_table * nls_info);
  95 extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
  96
  97 extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
  98                         const char *tree, struct cifsTconInfo *tcon,
  99                         const struct nls_table *);
 100
 101 extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
 102                 const char *searchName, const struct nls_table *nls_codepage,
 103                 __u16 *searchHandle, struct cifs_search_info * psrch_inf,
 104                 int map, const char dirsep);
 105
 106 extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
 107                 __u16 searchHandle, struct cifs_search_info * psrch_inf);
 108
 109 extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
 110                         const __u16 search_handle);
 111
 112 extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
 113                         const unsigned char *searchName,
 114                         FILE_ALL_INFO * findData,
 115                         const struct nls_table *nls_codepage, int remap);
 116 extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
 117                         const unsigned char *searchName,
 118                         FILE_ALL_INFO * findData,
 119                         const struct nls_table *nls_codepage, int remap);
 120
 121 extern int CIFSSMBUnixQPathInfo(const int xid,
 122                         struct cifsTconInfo *tcon,
 123                         const unsigned char *searchName,
 124                         FILE_UNIX_BASIC_INFO * pFindData,
 125                         const struct nls_table *nls_codepage, int remap);
 126
 127 extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
 128                         const unsigned char *searchName,
 129                         unsigned char **targetUNCs,
 130                         unsigned int *number_of_UNC_in_array,
 131                         const struct nls_table *nls_codepage, int remap);
 132
 133 extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 134                         const char *old_path,
 135                         const struct nls_table *nls_codepage, int remap);
 136 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 137                         const char *old_path,
 138                         const struct nls_table *nls_codepage,
 139                         unsigned int *pnum_referrals,
 140                         unsigned char ** preferrals,
 141                         int remap);
 142 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
 143                         struct kstatfs *FSData);
 144 extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
 145                         struct kstatfs *FSData);
 146 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
 147                         __u64 cap);
 148
 149 extern int CIFSSMBQFSAttributeInfo(const int xid,
 150                         struct cifsTconInfo *tcon);
 151 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
 152 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
 153 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
 154                         struct kstatfs *FSData);
 155
 156 extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
 157                         const char *fileName, const FILE_BASIC_INFO * data,
 158                         const struct nls_table *nls_codepage,
 159                         int remap_special_chars);
 160 extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
 161                         const FILE_BASIC_INFO * data, __u16 fid);
 162 #if 0
 163 extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
 164                         char *fileName, __u16 dos_attributes,
 165                         const struct nls_table *nls_codepage);
 166 #endif /* possibly unneeded function */
 167 extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
 168                         const char *fileName, __u64 size,
 169                         int setAllocationSizeFlag,
 170                         const struct nls_table *nls_codepage,
 171                         int remap_special_chars);
 172 extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
 173                          __u64 size, __u16 fileHandle,__u32 opener_pid,
 174                         int AllocSizeFlag);
 175 extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
 176                         char *full_path, __u64 mode, __u64 uid,
 177                         __u64 gid, dev_t dev,
 178                         const struct nls_table *nls_codepage,
 179                         int remap_special_chars);
 180
 181 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
 182                         const char *newName,
 183                         const struct nls_table *nls_codepage,
 184                         int remap_special_chars);
 185 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
 186                         const char *name, const struct nls_table *nls_codepage,
 187                         int remap_special_chars);
 188
 189 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
 190                         const char *name,
 191                         const struct nls_table *nls_codepage,
 192                         int remap_special_chars);
 193 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
 194                         const char *fromName, const char *toName,
 195                         const struct nls_table *nls_codepage,
 196                         int remap_special_chars);
 197 extern int CIFSSMBRenameOpenFile(const int xid,struct cifsTconInfo *pTcon,
 198                         int netfid, char * target_name,
 199                         const struct nls_table *nls_codepage,
 200                         int remap_special_chars);
 201 extern int CIFSCreateHardLink(const int xid,
 202                         struct cifsTconInfo *tcon,
 203                         const char *fromName, const char *toName,
 204                         const struct nls_table *nls_codepage,
 205                         int remap_special_chars);
 206 extern int CIFSUnixCreateHardLink(const int xid,
 207                         struct cifsTconInfo *tcon,
 208                         const char *fromName, const char *toName,
 209                         const struct nls_table *nls_codepage,
 210                         int remap_special_chars);
 211 extern int CIFSUnixCreateSymLink(const int xid,
 212                         struct cifsTconInfo *tcon,
 213                         const char *fromName, const char *toName,
 214                         const struct nls_table *nls_codepage);
 215 extern int CIFSSMBUnixQuerySymLink(const int xid,
 216                         struct cifsTconInfo *tcon,
 217                         const unsigned char *searchName,
 218                         char *syminfo, const int buflen,
 219                         const struct nls_table *nls_codepage);
 220 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
 221                         struct cifsTconInfo *tcon,
 222                         const unsigned char *searchName,
 223                         char *symlinkinfo, const int buflen, __u16 fid,
 224                         const struct nls_table *nls_codepage);
 225
 226 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
 227                         const char *fileName, const int disposition,
 228                         const int access_flags, const int omode,
 229                         __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
 230                         const struct nls_table *nls_codepage, int remap);
 231 extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
 232                         const char *fileName, const int disposition,
 233                         const int access_flags, const int omode,
 234                         __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
 235                         const struct nls_table *nls_codepage, int remap);
 236 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
 237                         const int smb_file_id);
 238
 239 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
 240                         const int netfid, unsigned int count,
 241                         const __u64 lseek, unsigned int *nbytes, char **buf,
 242                         int * return_buf_type);
 243 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
 244                         const int netfid, const unsigned int count,
 245                         const __u64 lseek, unsigned int *nbytes,
 246                         const char *buf, const char __user *ubuf,
 247                         const int long_op);
 248 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
 249                         const int netfid, const unsigned int count,
 250                         const __u64 offset, unsigned int *nbytes,
 251                         struct kvec *iov, const int nvec, const int long_op);
 252 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
 253                         const unsigned char *searchName, __u64 * inode_number,
 254                         const struct nls_table *nls_codepage,
 255                         int remap_special_chars);
 256 extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
 257                         const struct nls_table * codepage);
 258 extern int cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
 259                         const struct nls_table * cp, int mapChars);
 260
 261 extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
 262                         const __u16 netfid, const __u64 len,
 263                         const __u64 offset, const __u32 numUnlock,
 264                         const __u32 numLock, const __u8 lockType,
 265                         const int waitFlag);
 266 extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
 267                         const __u16 smb_file_id, const int get_flag,
 268                         const __u64 len, struct file_lock *,
 269                         const __u16 lock_type, const int waitFlag);
 270 extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
 271 extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
 272
 273 extern struct cifsSesInfo *sesInfoAlloc(void);
 274 extern void sesInfoFree(struct cifsSesInfo *);
 275 extern struct cifsTconInfo *tconInfoAlloc(void);
 276 extern void tconInfoFree(struct cifsTconInfo *);
 277
 278 extern int cifs_reconnect(struct TCP_Server_Info *server);
 279
 280 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *,__u32 *);
 281 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
 282                           __u32 *);
 283 extern int cifs_verify_signature(struct smb_hdr *, const char * mac_key,
 284         __u32 expected_sequence_number);
 285 extern int cifs_calculate_mac_key(char * key,const char * rn,const char * pass);
 286 extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
 287                         const struct nls_table *);
 288 extern void CalcNTLMv2_response(const struct cifsSesInfo *, char * );
 289 extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
 290                              const struct nls_table *);
 291 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 292 extern void calc_lanman_hash(struct cifsSesInfo * ses, char * lnm_session_key);
 293 #endif /* CIFS_WEAK_PW_HASH */
 294 extern int CIFSSMBCopy(int xid,
 295                         struct cifsTconInfo *source_tcon,
 296                         const char *fromName,
 297                         const __u16 target_tid,
 298                         const char *toName, const int flags,
 299                         const struct nls_table *nls_codepage,
 300                         int remap_special_chars);
 301 extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
 302                         const int notify_subdirs,const __u16 netfid,
 303                         __u32 filter, struct file * file, int multishot,
 304                         const struct nls_table *nls_codepage);
 305 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
 306                         const unsigned char *searchName, char * EAData,
 307                         size_t bufsize, const struct nls_table *nls_codepage,
 308                         int remap_special_chars);
 309 extern ssize_t CIFSSMBQueryEA(const int xid,struct cifsTconInfo * tcon,
 310                 const unsigned char * searchName,const unsigned char * ea_name,
 311                 unsigned char * ea_value, size_t buf_size,
 312                 const struct nls_table *nls_codepage, int remap_special_chars);
 313 extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
 314                 const char *fileName, const char * ea_name,
 315                 const void * ea_value, const __u16 ea_value_len,
 316                 const struct nls_table *nls_codepage, int remap_special_chars);
 317 extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
 318                         __u16 fid, char *acl_inf, const int buflen,
 319                         const int acl_type /* ACCESS vs. DEFAULT */);
 320 extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
 321                 const unsigned char *searchName,
 322                 char *acl_inf, const int buflen,const int acl_type,
 323                 const struct nls_table *nls_codepage, int remap_special_chars);
 324 extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
 325                 const unsigned char *fileName,
 326                 const char *local_acl, const int buflen, const int acl_type,
 327                 const struct nls_table *nls_codepage, int remap_special_chars);
 328 extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
 329                 const int netfid, __u64 * pExtAttrBits, __u64 *pMask);
 330 #endif                  /* _CIFSPROTO_H */