fs/cifs/cifsproto.h

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