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