LXR linux/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
  25struct statfs;
  26struct smb_vol;
  27
  28/*
  29 *****************************************************************
  30 * All Prototypes
  31 *****************************************************************
  32 */
  33
  34extern struct smb_hdr *cifs_buf_get(void);
  35extern void cifs_buf_release(void *);
  36extern struct smb_hdr *cifs_small_buf_get(void);
  37extern void cifs_small_buf_release(void *);
  38extern int smb_send(struct TCP_Server_Info *, struct smb_hdr *,
  39                        unsigned int /* length */);
  40extern unsigned int _GetXid(void);
  41extern void _FreeXid(unsigned int);
  42#define GetXid() (int)_GetXid(); cFYI(1,("CIFS VFS: in %s as Xid: %d with uid: %d",__func__, xid,current_fsuid()));
  43#define FreeXid(curr_xid) {_FreeXid(curr_xid); cFYI(1,("CIFS VFS: leaving %s (xid = %d) rc = %d",__func__,curr_xid,(int)rc));}
  44extern char *build_path_from_dentry(struct dentry *);
  45extern char *cifs_build_path_to_root(struct cifs_sb_info *cifs_sb);
  46extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
  47extern char *cifs_compose_mount_options(const char *sb_mountdata,
  48                const char *fullpath, const struct dfs_info3_param *ref,
  49                char **devname);
  50/* extern void renew_parental_timestamps(struct dentry *direntry);*/
  51extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
  52                        struct smb_hdr * /* input */ ,
  53                        struct smb_hdr * /* out */ ,
  54                        int * /* bytes returned */ , const int long_op);
  55extern int SendReceiveNoRsp(const unsigned int xid, struct cifsSesInfo *ses,
  56                        struct smb_hdr *in_buf, int flags);
  57extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
  58                        struct kvec *, int /* nvec to send */,
  59                        int * /* type of buf returned */ , const int flags);
  60extern int SendReceiveBlockingLock(const unsigned int xid,
  61                        struct cifsTconInfo *ptcon,
  62                        struct smb_hdr *in_buf ,
  63                        struct smb_hdr *out_buf,
  64                        int *bytes_returned);
  65extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
  66extern bool is_valid_oplock_break(struct smb_hdr *smb,
  67                                  struct TCP_Server_Info *);
  68extern bool is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
  69extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
  70#ifdef CONFIG_CIFS_EXPERIMENTAL
  71extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *);
  72#endif
  73extern unsigned int smbCalcSize(struct smb_hdr *ptr);
  74extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
  75extern int decode_negTokenInit(unsigned char *security_blob, int length,
  76                        enum securityEnum *secType);
  77extern int cifs_convert_address(char *src, void *dst);
  78extern int map_smb_to_linux_error(struct smb_hdr *smb, int logErr);
  79extern void header_assemble(struct smb_hdr *, char /* command */ ,
  80                            const struct cifsTconInfo *, int /* length of
  81                            fixed section (word count) in two byte units */);
  82extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
  83                                struct cifsSesInfo *ses,
  84                                void **request_buf);
  85extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
  86                             const int stage,
  87                             const struct nls_table *nls_cp);
  88extern __u16 GetNextMid(struct TCP_Server_Info *server);
  89extern struct oplock_q_entry *AllocOplockQEntry(struct inode *, u16,
  90                                                 struct cifsTconInfo *);
  91extern void DeleteOplockQEntry(struct oplock_q_entry *);
  92extern void DeleteTconOplockQEntries(struct cifsTconInfo *);
  93extern struct timespec cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
  94extern u64 cifs_UnixTimeToNT(struct timespec);
  95extern struct timespec cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
  96                                      int offset);
  97
  98extern int cifs_posix_open(char *full_path, struct inode **pinode,
  99                           struct super_block *sb, int mode, int oflags,
 100                           int *poplock, __u16 *pnetfid, int xid);
 101extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
 102                                     FILE_UNIX_BASIC_INFO *info,
 103                                     struct cifs_sb_info *cifs_sb);
 104extern void cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
 105extern struct inode *cifs_iget(struct super_block *sb,
 106                               struct cifs_fattr *fattr);
 107
 108extern int cifs_get_inode_info(struct inode **pinode,
 109                        const unsigned char *search_path,
 110                        FILE_ALL_INFO *pfile_info,
 111                        struct super_block *sb, int xid, const __u16 *pfid);
 112extern int cifs_get_inode_info_unix(struct inode **pinode,
 113                        const unsigned char *search_path,
 114                        struct super_block *sb, int xid);
 115extern void cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
 116                              struct cifs_fattr *fattr, struct inode *inode,
 117                              const char *path, const __u16 *pfid);
 118extern int mode_to_acl(struct inode *inode, const char *path, __u64);
 119
 120extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
 121                        const char *);
 122extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
 123extern void cifs_dfs_release_automount_timer(void);
 124void cifs_proc_init(void);
 125void cifs_proc_clean(void);
 126
 127extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
 128                        struct nls_table *nls_info);
 129extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
 130
 131extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
 132                        const char *tree, struct cifsTconInfo *tcon,
 133                        const struct nls_table *);
 134
 135extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
 136                const char *searchName, const struct nls_table *nls_codepage,
 137                __u16 *searchHandle, struct cifs_search_info *psrch_inf,
 138                int map, const char dirsep);
 139
 140extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
 141                __u16 searchHandle, struct cifs_search_info *psrch_inf);
 142
 143extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
 144                        const __u16 search_handle);
 145
 146extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
 147                        const unsigned char *searchName,
 148                        FILE_ALL_INFO *findData,
 149                        int legacy /* whether to use old info level */,
 150                        const struct nls_table *nls_codepage, int remap);
 151extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
 152                        const unsigned char *searchName,
 153                        FILE_ALL_INFO *findData,
 154                        const struct nls_table *nls_codepage, int remap);
 155
 156extern int CIFSSMBUnixQPathInfo(const int xid,
 157                        struct cifsTconInfo *tcon,
 158                        const unsigned char *searchName,
 159                        FILE_UNIX_BASIC_INFO *pFindData,
 160                        const struct nls_table *nls_codepage, int remap);
 161
 162extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
 163                        const unsigned char *searchName,
 164                        struct dfs_info3_param **target_nodes,
 165                        unsigned int *number_of_nodes_in_array,
 166                        const struct nls_table *nls_codepage, int remap);
 167
 168extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
 169                        const char *old_path,
 170                        const struct nls_table *nls_codepage,
 171                        unsigned int *pnum_referrals,
 172                        struct dfs_info3_param **preferrals,
 173                        int remap);
 174extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
 175                                 struct super_block *sb, struct smb_vol *vol);
 176extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
 177                        struct kstatfs *FSData);
 178extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
 179                        struct kstatfs *FSData);
 180extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
 181                        __u64 cap);
 182
 183extern int CIFSSMBQFSAttributeInfo(const int xid,
 184                        struct cifsTconInfo *tcon);
 185extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
 186extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
 187extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
 188                        struct kstatfs *FSData);
 189
 190extern int CIFSSMBSetPathInfo(const int xid, struct cifsTconInfo *tcon,
 191                        const char *fileName, const FILE_BASIC_INFO *data,
 192                        const struct nls_table *nls_codepage,
 193                        int remap_special_chars);
 194extern int CIFSSMBSetFileInfo(const int xid, struct cifsTconInfo *tcon,
 195                        const FILE_BASIC_INFO *data, __u16 fid,
 196                        __u32 pid_of_opener);
 197extern int CIFSSMBSetFileDisposition(const int xid, struct cifsTconInfo *tcon,
 198                        bool delete_file, __u16 fid, __u32 pid_of_opener);
 199#if 0
 200extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
 201                        char *fileName, __u16 dos_attributes,
 202                        const struct nls_table *nls_codepage);
 203#endif /* possibly unneeded function */
 204extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
 205                        const char *fileName, __u64 size,
 206                        bool setAllocationSizeFlag,
 207                        const struct nls_table *nls_codepage,
 208                        int remap_special_chars);
 209extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
 210                         __u64 size, __u16 fileHandle, __u32 opener_pid,
 211                        bool AllocSizeFlag);
 212
 213struct cifs_unix_set_info_args {
 214        __u64   ctime;
 215        __u64   atime;
 216        __u64   mtime;
 217        __u64   mode;
 218        __u64   uid;
 219        __u64   gid;
 220        dev_t   device;
 221};
 222
 223extern int CIFSSMBUnixSetFileInfo(const int xid, struct cifsTconInfo *tcon,
 224                                  const struct cifs_unix_set_info_args *args,
 225                                  u16 fid, u32 pid_of_opener);
 226
 227extern int CIFSSMBUnixSetPathInfo(const int xid, struct cifsTconInfo *pTcon,
 228                        char *fileName,
 229                        const struct cifs_unix_set_info_args *args,
 230                        const struct nls_table *nls_codepage,
 231                        int remap_special_chars);
 232
 233extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
 234                        const char *newName,
 235                        const struct nls_table *nls_codepage,
 236                        int remap_special_chars);
 237extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
 238                        const char *name, const struct nls_table *nls_codepage,
 239                        int remap_special_chars);
 240extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
 241                        const char *name, __u16 type,
 242                        const struct nls_table *nls_codepage,
 243                        int remap_special_chars);
 244extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
 245                        const char *name,
 246                        const struct nls_table *nls_codepage,
 247                        int remap_special_chars);
 248extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
 249                        const char *fromName, const char *toName,
 250                        const struct nls_table *nls_codepage,
 251                        int remap_special_chars);
 252extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
 253                        int netfid, const char *target_name,
 254                        const struct nls_table *nls_codepage,
 255                        int remap_special_chars);
 256extern int CIFSCreateHardLink(const int xid,
 257                        struct cifsTconInfo *tcon,
 258                        const char *fromName, const char *toName,
 259                        const struct nls_table *nls_codepage,
 260                        int remap_special_chars);
 261extern int CIFSUnixCreateHardLink(const int xid,
 262                        struct cifsTconInfo *tcon,
 263                        const char *fromName, const char *toName,
 264                        const struct nls_table *nls_codepage,
 265                        int remap_special_chars);
 266extern int CIFSUnixCreateSymLink(const int xid,
 267                        struct cifsTconInfo *tcon,
 268                        const char *fromName, const char *toName,
 269                        const struct nls_table *nls_codepage);
 270extern int CIFSSMBUnixQuerySymLink(const int xid,
 271                        struct cifsTconInfo *tcon,
 272                        const unsigned char *searchName, char **syminfo,
 273                        const struct nls_table *nls_codepage);
 274extern int CIFSSMBQueryReparseLinkInfo(const int xid,
 275                        struct cifsTconInfo *tcon,
 276                        const unsigned char *searchName,
 277                        char *symlinkinfo, const int buflen, __u16 fid,
 278                        const struct nls_table *nls_codepage);
 279
 280extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
 281                        const char *fileName, const int disposition,
 282                        const int access_flags, const int omode,
 283                        __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
 284                        const struct nls_table *nls_codepage, int remap);
 285extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
 286                        const char *fileName, const int disposition,
 287                        const int access_flags, const int omode,
 288                        __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
 289                        const struct nls_table *nls_codepage, int remap);
 290extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
 291                        u32 posix_flags, __u64 mode, __u16 *netfid,
 292                        FILE_UNIX_BASIC_INFO *pRetData,
 293                        __u32 *pOplock, const char *name,
 294                        const struct nls_table *nls_codepage, int remap);
 295extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
 296                        const int smb_file_id);
 297
 298extern int CIFSSMBFlush(const int xid, struct cifsTconInfo *tcon,
 299                        const int smb_file_id);
 300
 301extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
 302                        const int netfid, unsigned int count,
 303                        const __u64 lseek, unsigned int *nbytes, char **buf,
 304                        int *return_buf_type);
 305extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
 306                        const int netfid, const unsigned int count,
 307                        const __u64 lseek, unsigned int *nbytes,
 308                        const char *buf, const char __user *ubuf,
 309                        const int long_op);
 310extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
 311                        const int netfid, const unsigned int count,
 312                        const __u64 offset, unsigned int *nbytes,
 313                        struct kvec *iov, const int nvec, const int long_op);
 314extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
 315                        const unsigned char *searchName, __u64 *inode_number,
 316                        const struct nls_table *nls_codepage,
 317                        int remap_special_chars);
 318extern int cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
 319                        const struct nls_table *cp, int mapChars);
 320
 321extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
 322                        const __u16 netfid, const __u64 len,
 323                        const __u64 offset, const __u32 numUnlock,
 324                        const __u32 numLock, const __u8 lockType,
 325                        const bool waitFlag);
 326extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
 327                        const __u16 smb_file_id, const int get_flag,
 328                        const __u64 len, struct file_lock *,
 329                        const __u16 lock_type, const bool waitFlag);
 330extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
 331extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
 332
 333extern struct cifsSesInfo *sesInfoAlloc(void);
 334extern void sesInfoFree(struct cifsSesInfo *);
 335extern struct cifsTconInfo *tconInfoAlloc(void);
 336extern void tconInfoFree(struct cifsTconInfo *);
 337
 338extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
 339extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
 340                          __u32 *);
 341extern int cifs_verify_signature(struct smb_hdr *,
 342                                 const struct mac_key *mac_key,
 343                                __u32 expected_sequence_number);
 344extern int cifs_calculate_mac_key(struct mac_key *key, const char *rn,
 345                                 const char *pass);
 346extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
 347                        const struct nls_table *);
 348extern void CalcNTLMv2_response(const struct cifsSesInfo *, char *);
 349extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
 350                             const struct nls_table *);
 351#ifdef CONFIG_CIFS_WEAK_PW_HASH
 352extern void calc_lanman_hash(const char *password, const char *cryptkey,
 353                                bool encrypt, char *lnm_session_key);
 354#endif /* CIFS_WEAK_PW_HASH */
 355extern int CIFSSMBCopy(int xid,
 356                        struct cifsTconInfo *source_tcon,
 357                        const char *fromName,
 358                        const __u16 target_tid,
 359                        const char *toName, const int flags,
 360                        const struct nls_table *nls_codepage,
 361                        int remap_special_chars);
 362extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
 363                        const int notify_subdirs, const __u16 netfid,
 364                        __u32 filter, struct file *file, int multishot,
 365                        const struct nls_table *nls_codepage);
 366extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
 367                        const unsigned char *searchName, char *EAData,
 368                        size_t bufsize, const struct nls_table *nls_codepage,
 369                        int remap_special_chars);
 370extern ssize_t CIFSSMBQueryEA(const int xid, struct cifsTconInfo *tcon,
 371                const unsigned char *searchName, const unsigned char *ea_name,
 372                unsigned char *ea_value, size_t buf_size,
 373                const struct nls_table *nls_codepage, int remap_special_chars);
 374extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
 375                const char *fileName, const char *ea_name,
 376                const void *ea_value, const __u16 ea_value_len,
 377                const struct nls_table *nls_codepage, int remap_special_chars);
 378extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
 379                        __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
 380extern int CIFSSMBSetCIFSACL(const int, struct cifsTconInfo *, __u16,
 381                        struct cifs_ntsd *, __u32);
 382extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
 383                const unsigned char *searchName,
 384                char *acl_inf, const int buflen, const int acl_type,
 385                const struct nls_table *nls_codepage, int remap_special_chars);
 386extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
 387                const unsigned char *fileName,
 388                const char *local_acl, const int buflen, const int acl_type,
 389                const struct nls_table *nls_codepage, int remap_special_chars);
 390extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
 391                        const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
 392#endif                  /* _CIFSPROTO_H */
 393