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