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