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