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