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