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