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