[CIFS] Ensure that cifs multiplex ids do not collide.
[safe/jmp/linux-2.6] / 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 *, const struct cifs_sb_info *cifs_sb);
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 smb_hdr * /* input */ , int hdr_len,
52                         const char * /* SMB data to send */ , int data_len,
53                         int * /* bytes returned */ , const int long_op);
54 extern int checkSMBhdr(struct smb_hdr *smb, __u16 mid);
55 extern int checkSMB(struct smb_hdr *smb, __u16 mid, int length);
56 extern int is_valid_oplock_break(struct smb_hdr *smb);
57 extern int is_size_safe_to_change(struct cifsInodeInfo *);
58 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
59 extern int decode_negTokenInit(unsigned char *security_blob, int length,
60                         enum securityEnum *secType);
61 extern int cifs_inet_pton(int, char * source, void *dst);
62 extern int map_smb_to_linux_error(struct smb_hdr *smb);
63 extern void header_assemble(struct smb_hdr *, char /* command */ ,
64                             const struct cifsTconInfo *, int /* length of
65                             fixed section (word count) in two byte units */);
66 extern __u16 GetNextMid(struct TCP_Server_Info *server);
67 extern struct oplock_q_entry * AllocOplockQEntry(struct inode *, u16, 
68                                                  struct cifsTconInfo *);
69 extern void DeleteOplockQEntry(struct oplock_q_entry *);
70 extern struct timespec cifs_NTtimeToUnix(u64 /* utc nanoseconds since 1601 */ );
71 extern u64 cifs_UnixTimeToNT(struct timespec);
72 extern int cifs_get_inode_info(struct inode **pinode,
73                         const unsigned char *search_path, 
74                         FILE_ALL_INFO * pfile_info,
75                         struct super_block *sb, int xid);
76 extern int cifs_get_inode_info_unix(struct inode **pinode,
77                         const unsigned char *search_path,
78                         struct super_block *sb,int xid);
79
80 extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
81                         const char *);
82 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
83 void cifs_proc_init(void);
84 void cifs_proc_clean(void);
85
86 extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo, 
87                         struct nls_table * nls_info);
88 extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
89
90 extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
91                         const char *tree, struct cifsTconInfo *tcon,
92                         const struct nls_table *);
93
94 extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
95             const char *searchName, const struct nls_table *nls_codepage,
96             __u16 *searchHandle, struct cifs_search_info * psrch_inf, int map, const char dirsep);
97
98 extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
99             __u16 searchHandle, struct cifs_search_info * psrch_inf);
100
101 extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
102                         const __u16 search_handle);
103
104 extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
105                         const unsigned char *searchName,
106                         FILE_ALL_INFO * findData,
107                         const struct nls_table *nls_codepage, int remap);
108
109 extern int CIFSSMBUnixQPathInfo(const int xid,
110                         struct cifsTconInfo *tcon,
111                         const unsigned char *searchName,
112                         FILE_UNIX_BASIC_INFO * pFindData,
113                         const struct nls_table *nls_codepage, int remap);
114
115 extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
116                         const unsigned char *searchName,
117                         unsigned char **targetUNCs,
118                         unsigned int *number_of_UNC_in_array,
119                         const struct nls_table *nls_codepage, int remap);
120
121 extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
122                         const char *old_path,
123                         const struct nls_table *nls_codepage, int remap);
124 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
125                         const char *old_path, 
126                         const struct nls_table *nls_codepage,
127                         unsigned int *pnum_referrals, 
128                         unsigned char ** preferrals,
129                         int remap);
130 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
131                         struct kstatfs *FSData);
132 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
133                         __u64 cap);
134
135 extern int CIFSSMBQFSAttributeInfo(const int xid,
136                         struct cifsTconInfo *tcon);
137 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
138 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
139 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
140                         struct kstatfs *FSData);
141
142 extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
143                         const char *fileName, const FILE_BASIC_INFO * data,
144                         const struct nls_table *nls_codepage,
145                         int remap_special_chars);
146 extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
147                         const FILE_BASIC_INFO * data, __u16 fid);
148 #if 0
149 extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
150                         char *fileName, __u16 dos_attributes,
151                         const struct nls_table *nls_codepage);
152 #endif /* possibly unneeded function */
153 extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
154                         const char *fileName, __u64 size,
155                         int setAllocationSizeFlag,
156                         const struct nls_table *nls_codepage,
157                         int remap_special_chars);
158 extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
159                          __u64 size, __u16 fileHandle,__u32 opener_pid, 
160                         int AllocSizeFlag);
161 extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
162                         char *full_path, __u64 mode, __u64 uid,
163                         __u64 gid, dev_t dev, 
164                         const struct nls_table *nls_codepage,
165                         int remap_special_chars);
166
167 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
168                         const char *newName,
169                         const struct nls_table *nls_codepage,
170                         int remap_special_chars);
171 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
172                         const char *name, const struct nls_table *nls_codepage,
173                         int remap_special_chars);
174
175 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
176                         const char *name,
177                         const struct nls_table *nls_codepage,
178                         int remap_special_chars);
179 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
180                         const char *fromName, const char *toName,
181                         const struct nls_table *nls_codepage,
182                         int remap_special_chars);
183 extern int CIFSSMBRenameOpenFile(const int xid,struct cifsTconInfo *pTcon,
184                         int netfid, char * target_name, 
185                         const struct nls_table *nls_codepage,
186                         int remap_special_chars);
187 extern int CIFSCreateHardLink(const int xid,
188                         struct cifsTconInfo *tcon,
189                         const char *fromName, const char *toName,
190                         const struct nls_table *nls_codepage,
191                         int remap_special_chars);
192 extern int CIFSUnixCreateHardLink(const int xid,
193                         struct cifsTconInfo *tcon,
194                         const char *fromName, const char *toName,
195                         const struct nls_table *nls_codepage, 
196                         int remap_special_chars);
197 extern int CIFSUnixCreateSymLink(const int xid,
198                         struct cifsTconInfo *tcon,
199                         const char *fromName, const char *toName,
200                         const struct nls_table *nls_codepage);
201 extern int CIFSSMBUnixQuerySymLink(const int xid,
202                         struct cifsTconInfo *tcon,
203                         const unsigned char *searchName,
204                         char *syminfo, const int buflen,
205                         const struct nls_table *nls_codepage);
206 extern int CIFSSMBQueryReparseLinkInfo(const int xid, 
207                         struct cifsTconInfo *tcon,
208                         const unsigned char *searchName,
209                         char *symlinkinfo, const int buflen, __u16 fid,
210                         const struct nls_table *nls_codepage);
211
212 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
213                         const char *fileName, const int disposition,
214                         const int access_flags, const int omode,
215                         __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
216                         const struct nls_table *nls_codepage, int remap);
217 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
218                         const int smb_file_id);
219
220 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
221                         const int netfid, unsigned int count,
222                         const __u64 lseek, unsigned int *nbytes, char **buf);
223 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
224                         const int netfid, const unsigned int count,
225                         const __u64 lseek, unsigned int *nbytes,
226                         const char *buf, const char __user *ubuf, 
227                         const int long_op);
228 #ifdef CONFIG_CIFS_EXPERIMENTAL
229 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
230                         const int netfid, const unsigned int count,
231                         const __u64 offset, unsigned int *nbytes, 
232                         const char *buf,const int long_op);
233 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
234                         const unsigned char *searchName, __u64 * inode_number,
235                         const struct nls_table *nls_codepage, 
236                         int remap_special_chars);
237 #endif /* CONFIG_CIFS_EXPERIMENTAL */
238 extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
239                         const struct nls_table * codepage);
240 extern int cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
241                         const struct nls_table * cp, int mapChars);
242
243 extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
244                         const __u16 netfid, const __u64 len,
245                         const __u64 offset, const __u32 numUnlock,
246                         const __u32 numLock, const __u8 lockType,
247                         const int waitFlag);
248
249 extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
250 extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
251
252 extern struct cifsSesInfo *sesInfoAlloc(void);
253 extern void sesInfoFree(struct cifsSesInfo *);
254 extern struct cifsTconInfo *tconInfoAlloc(void);
255 extern void tconInfoFree(struct cifsTconInfo *);
256
257 extern int cifs_reconnect(struct TCP_Server_Info *server);
258
259 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *,__u32 *);
260 extern int cifs_verify_signature(struct smb_hdr *, const char * mac_key,
261         __u32 expected_sequence_number);
262 extern int cifs_calculate_mac_key(char * key,const char * rn,const char * pass);
263 extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *, struct nls_table *);
264 extern void CalcNTLMv2_response(const struct cifsSesInfo *,char * );
265 extern int CIFSSMBCopy(int xid,
266                         struct cifsTconInfo *source_tcon,
267                         const char *fromName,
268                         const __u16 target_tid,
269                         const char *toName, const int flags,
270                         const struct nls_table *nls_codepage, 
271                         int remap_special_chars);
272 extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon, 
273                         const int notify_subdirs,const __u16 netfid,
274                         __u32 filter, const struct nls_table *nls_codepage);
275 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
276                         const unsigned char *searchName, char * EAData,
277                         size_t bufsize, const struct nls_table *nls_codepage,
278                         int remap_special_chars);
279 extern ssize_t CIFSSMBQueryEA(const int xid,struct cifsTconInfo * tcon,
280                 const unsigned char * searchName,const unsigned char * ea_name,
281                 unsigned char * ea_value, size_t buf_size, 
282                 const struct nls_table *nls_codepage, int remap_special_chars);
283 extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon, 
284                 const char *fileName, const char * ea_name, 
285                 const void * ea_value, const __u16 ea_value_len, 
286                 const struct nls_table *nls_codepage, int remap_special_chars);
287 extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
288                 const unsigned char *searchName,
289                 char *acl_inf, const int buflen,const int acl_type,
290                 const struct nls_table *nls_codepage, int remap_special_chars);
291 extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
292                 const unsigned char *fileName,
293                 const char *local_acl, const int buflen, const int acl_type,
294                 const struct nls_table *nls_codepage, int remap_special_chars);
295 extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
296                 const int netfid, __u64 * pExtAttrBits, __u64 *pMask);
297 #endif                  /* _CIFSPROTO_H */