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