Merge git://git.kernel.org/pub/scm/linux/kernel/git/kyle/parisc-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,2005
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
27 /*
28  *****************************************************************
29  * All Prototypes
30  *****************************************************************
31  */
32
33 extern struct smb_hdr *cifs_buf_get(void);
34 extern void cifs_buf_release(void *);
35 extern struct smb_hdr *cifs_small_buf_get(void);
36 extern void cifs_small_buf_release(void *);
37 extern int smb_send(struct socket *, struct smb_hdr *,
38                         unsigned int /* length */ , struct sockaddr *);
39 extern unsigned int _GetXid(void);
40 extern void _FreeXid(unsigned int);
41 #define GetXid() (int)_GetXid(); cFYI(1,("CIFS VFS: in %s as Xid: %d with uid: %d",__FUNCTION__, xid,current->fsuid));
42 #define FreeXid(curr_xid) {_FreeXid(curr_xid); cFYI(1,("CIFS VFS: leaving %s (xid = %d) rc = %d",__FUNCTION__,curr_xid,(int)rc));}
43 extern char *build_path_from_dentry(struct dentry *);
44 extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
45 extern void renew_parental_timestamps(struct dentry *direntry);
46 extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
47                         struct smb_hdr * /* input */ ,
48                         struct smb_hdr * /* out */ ,
49                         int * /* bytes returned */ , const int long_op);
50 extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
51                         struct kvec *, int /* nvec to send */, 
52                         int * /* type of buf returned */ , const int long_op);
53 extern int checkSMBhdr(struct smb_hdr *smb, __u16 mid);
54 extern int checkSMB(struct smb_hdr *smb, __u16 mid, int length);
55 extern int is_valid_oplock_break(struct smb_hdr *smb, struct TCP_Server_Info *);
56 extern int is_size_safe_to_change(struct cifsInodeInfo *);
57 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
58 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
59 extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
60 extern int decode_negTokenInit(unsigned char *security_blob, int length,
61                         enum securityEnum *secType);
62 extern int cifs_inet_pton(int, char * source, void *dst);
63 extern int map_smb_to_linux_error(struct smb_hdr *smb);
64 extern void header_assemble(struct smb_hdr *, char /* command */ ,
65                             const struct cifsTconInfo *, int /* length of
66                             fixed section (word count) in two byte units */);
67 extern __u16 GetNextMid(struct TCP_Server_Info *server);
68 extern struct oplock_q_entry * AllocOplockQEntry(struct inode *, u16, 
69                                                  struct cifsTconInfo *);
70 extern void DeleteOplockQEntry(struct oplock_q_entry *);
71 extern struct timespec cifs_NTtimeToUnix(u64 /* utc nanoseconds since 1601 */ );
72 extern u64 cifs_UnixTimeToNT(struct timespec);
73 extern int cifs_get_inode_info(struct inode **pinode,
74                         const unsigned char *search_path, 
75                         FILE_ALL_INFO * pfile_info,
76                         struct super_block *sb, int xid);
77 extern int cifs_get_inode_info_unix(struct inode **pinode,
78                         const unsigned char *search_path,
79                         struct super_block *sb,int xid);
80
81 extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
82                         const char *);
83 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
84 void cifs_proc_init(void);
85 void cifs_proc_clean(void);
86
87 extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo, 
88                         struct nls_table * nls_info);
89 extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
90
91 extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
92                         const char *tree, struct cifsTconInfo *tcon,
93                         const struct nls_table *);
94
95 extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
96                 const char *searchName, const struct nls_table *nls_codepage,
97                 __u16 *searchHandle, struct cifs_search_info * psrch_inf, 
98                 int map, const char dirsep);
99
100 extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
101                 __u16 searchHandle, struct cifs_search_info * psrch_inf);
102
103 extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
104                         const __u16 search_handle);
105
106 extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
107                         const unsigned char *searchName,
108                         FILE_ALL_INFO * findData,
109                         const struct nls_table *nls_codepage, int remap);
110 extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
111                         const unsigned char *searchName,
112                         FILE_ALL_INFO * findData,
113                         const struct nls_table *nls_codepage, int remap);
114
115 extern int CIFSSMBUnixQPathInfo(const int xid,
116                         struct cifsTconInfo *tcon,
117                         const unsigned char *searchName,
118                         FILE_UNIX_BASIC_INFO * pFindData,
119                         const struct nls_table *nls_codepage, int remap);
120
121 extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
122                         const unsigned char *searchName,
123                         unsigned char **targetUNCs,
124                         unsigned int *number_of_UNC_in_array,
125                         const struct nls_table *nls_codepage, int remap);
126
127 extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
128                         const char *old_path,
129                         const struct nls_table *nls_codepage, int remap);
130 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
131                         const char *old_path, 
132                         const struct nls_table *nls_codepage,
133                         unsigned int *pnum_referrals, 
134                         unsigned char ** preferrals,
135                         int remap);
136 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
137                         struct kstatfs *FSData);
138 extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
139                         struct kstatfs *FSData);
140 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
141                         __u64 cap);
142
143 extern int CIFSSMBQFSAttributeInfo(const int xid,
144                         struct cifsTconInfo *tcon);
145 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
146 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
147 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
148                         struct kstatfs *FSData);
149
150 extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
151                         const char *fileName, const FILE_BASIC_INFO * data,
152                         const struct nls_table *nls_codepage,
153                         int remap_special_chars);
154 extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
155                         const FILE_BASIC_INFO * data, __u16 fid);
156 #if 0
157 extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
158                         char *fileName, __u16 dos_attributes,
159                         const struct nls_table *nls_codepage);
160 #endif /* possibly unneeded function */
161 extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
162                         const char *fileName, __u64 size,
163                         int setAllocationSizeFlag,
164                         const struct nls_table *nls_codepage,
165                         int remap_special_chars);
166 extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
167                          __u64 size, __u16 fileHandle,__u32 opener_pid, 
168                         int AllocSizeFlag);
169 extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
170                         char *full_path, __u64 mode, __u64 uid,
171                         __u64 gid, dev_t dev, 
172                         const struct nls_table *nls_codepage,
173                         int remap_special_chars);
174
175 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
176                         const char *newName,
177                         const struct nls_table *nls_codepage,
178                         int remap_special_chars);
179 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
180                         const char *name, const struct nls_table *nls_codepage,
181                         int remap_special_chars);
182
183 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
184                         const char *name,
185                         const struct nls_table *nls_codepage,
186                         int remap_special_chars);
187 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
188                         const char *fromName, const char *toName,
189                         const struct nls_table *nls_codepage,
190                         int remap_special_chars);
191 extern int CIFSSMBRenameOpenFile(const int xid,struct cifsTconInfo *pTcon,
192                         int netfid, char * target_name, 
193                         const struct nls_table *nls_codepage,
194                         int remap_special_chars);
195 extern int CIFSCreateHardLink(const int xid,
196                         struct cifsTconInfo *tcon,
197                         const char *fromName, const char *toName,
198                         const struct nls_table *nls_codepage,
199                         int remap_special_chars);
200 extern int CIFSUnixCreateHardLink(const int xid,
201                         struct cifsTconInfo *tcon,
202                         const char *fromName, const char *toName,
203                         const struct nls_table *nls_codepage, 
204                         int remap_special_chars);
205 extern int CIFSUnixCreateSymLink(const int xid,
206                         struct cifsTconInfo *tcon,
207                         const char *fromName, const char *toName,
208                         const struct nls_table *nls_codepage);
209 extern int CIFSSMBUnixQuerySymLink(const int xid,
210                         struct cifsTconInfo *tcon,
211                         const unsigned char *searchName,
212                         char *syminfo, const int buflen,
213                         const struct nls_table *nls_codepage);
214 extern int CIFSSMBQueryReparseLinkInfo(const int xid, 
215                         struct cifsTconInfo *tcon,
216                         const unsigned char *searchName,
217                         char *symlinkinfo, const int buflen, __u16 fid,
218                         const struct nls_table *nls_codepage);
219
220 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
221                         const char *fileName, const int disposition,
222                         const int access_flags, const int omode,
223                         __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
224                         const struct nls_table *nls_codepage, int remap);
225 extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
226                         const char *fileName, const int disposition,
227                         const int access_flags, const int omode,
228                         __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
229                         const struct nls_table *nls_codepage, int remap);
230 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
231                         const int smb_file_id);
232
233 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
234                         const int netfid, unsigned int count,
235                         const __u64 lseek, unsigned int *nbytes, char **buf,
236                         int * return_buf_type);
237 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
238                         const int netfid, const unsigned int count,
239                         const __u64 lseek, unsigned int *nbytes,
240                         const char *buf, const char __user *ubuf, 
241                         const int long_op);
242 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
243                         const int netfid, const unsigned int count,
244                         const __u64 offset, unsigned int *nbytes, 
245                         struct kvec *iov, const int nvec, const int long_op);
246 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
247                         const unsigned char *searchName, __u64 * inode_number,
248                         const struct nls_table *nls_codepage, 
249                         int remap_special_chars);
250 extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
251                         const struct nls_table * codepage);
252 extern int cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
253                         const struct nls_table * cp, int mapChars);
254
255 extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
256                         const __u16 netfid, const __u64 len,
257                         const __u64 offset, const __u32 numUnlock,
258                         const __u32 numLock, const __u8 lockType,
259                         const int waitFlag);
260
261 extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
262 extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
263
264 extern struct cifsSesInfo *sesInfoAlloc(void);
265 extern void sesInfoFree(struct cifsSesInfo *);
266 extern struct cifsTconInfo *tconInfoAlloc(void);
267 extern void tconInfoFree(struct cifsTconInfo *);
268
269 extern int cifs_reconnect(struct TCP_Server_Info *server);
270
271 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *,__u32 *);
272 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
273                           __u32 *);
274 extern int cifs_verify_signature(struct smb_hdr *, const char * mac_key,
275         __u32 expected_sequence_number);
276 extern int cifs_calculate_mac_key(char * key,const char * rn,const char * pass);
277 extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *, struct nls_table *);
278 extern void CalcNTLMv2_response(const struct cifsSesInfo *,char * );
279 extern int CIFSSMBCopy(int xid,
280                         struct cifsTconInfo *source_tcon,
281                         const char *fromName,
282                         const __u16 target_tid,
283                         const char *toName, const int flags,
284                         const struct nls_table *nls_codepage, 
285                         int remap_special_chars);
286 extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon, 
287                         const int notify_subdirs,const __u16 netfid,
288                         __u32 filter, struct file * file, int multishot, 
289                         const struct nls_table *nls_codepage);
290 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
291                         const unsigned char *searchName, char * EAData,
292                         size_t bufsize, const struct nls_table *nls_codepage,
293                         int remap_special_chars);
294 extern ssize_t CIFSSMBQueryEA(const int xid,struct cifsTconInfo * tcon,
295                 const unsigned char * searchName,const unsigned char * ea_name,
296                 unsigned char * ea_value, size_t buf_size, 
297                 const struct nls_table *nls_codepage, int remap_special_chars);
298 extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon, 
299                 const char *fileName, const char * ea_name, 
300                 const void * ea_value, const __u16 ea_value_len, 
301                 const struct nls_table *nls_codepage, int remap_special_chars);
302 extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
303                         __u16 fid, char *acl_inf, const int buflen,
304                         const int acl_type /* ACCESS vs. DEFAULT */);
305 extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
306                 const unsigned char *searchName,
307                 char *acl_inf, const int buflen,const int acl_type,
308                 const struct nls_table *nls_codepage, int remap_special_chars);
309 extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
310                 const unsigned char *fileName,
311                 const char *local_acl, const int buflen, const int acl_type,
312                 const struct nls_table *nls_codepage, int remap_special_chars);
313 extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
314                 const int netfid, __u64 * pExtAttrBits, __u64 *pMask);
315 #endif                  /* _CIFSPROTO_H */