cifs: consolidate SendReceive response checks
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / fs / cifs / cifsproto.h
blob7aa131112884f34f8efeb8650060571a77caa51f
1 /*
2 * fs/cifs/cifsproto.h
4 * Copyright (c) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
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.
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.
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
21 #ifndef _CIFSPROTO_H
22 #define _CIFSPROTO_H
23 #include <linux/nls.h>
25 struct statfs;
26 struct smb_vol;
29 *****************************************************************
30 * All Prototypes
31 *****************************************************************
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; \
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 cifs_check_receive(struct mid_q_entry *mid,
80 struct TCP_Server_Info *server, bool log_error);
81 extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
82 struct kvec *, int /* nvec to send */,
83 int * /* type of buf returned */ , const int flags);
84 extern int SendReceiveBlockingLock(const unsigned int xid,
85 struct cifsTconInfo *ptcon,
86 struct smb_hdr *in_buf ,
87 struct smb_hdr *out_buf,
88 int *bytes_returned);
89 extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
90 extern bool is_valid_oplock_break(struct smb_hdr *smb,
91 struct TCP_Server_Info *);
92 extern bool is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
93 extern void cifs_update_eof(struct cifsInodeInfo *cifsi, loff_t offset,
94 unsigned int bytes_written);
95 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *, bool);
96 extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *, bool);
97 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
98 extern int decode_negTokenInit(unsigned char *security_blob, int length,
99 struct TCP_Server_Info *server);
100 extern int cifs_convert_address(struct sockaddr *dst, const char *src, int len);
101 extern int cifs_set_port(struct sockaddr *addr, const unsigned short int port);
102 extern int cifs_fill_sockaddr(struct sockaddr *dst, const char *src, int len,
103 const unsigned short int port);
104 extern int map_smb_to_linux_error(struct smb_hdr *smb, bool logErr);
105 extern void header_assemble(struct smb_hdr *, char /* command */ ,
106 const struct cifsTconInfo *, int /* length of
107 fixed section (word count) in two byte units */);
108 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
109 struct cifsSesInfo *ses,
110 void **request_buf);
111 extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
112 const struct nls_table *nls_cp);
113 extern __u16 GetNextMid(struct TCP_Server_Info *server);
114 extern struct timespec cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
115 extern u64 cifs_UnixTimeToNT(struct timespec);
116 extern struct timespec cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
117 int offset);
118 extern void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock);
120 extern struct cifsFileInfo *cifs_new_fileinfo(__u16 fileHandle,
121 struct file *file, struct tcon_link *tlink,
122 __u32 oplock);
123 extern int cifs_posix_open(char *full_path, struct inode **pinode,
124 struct super_block *sb,
125 int mode, unsigned int f_flags,
126 __u32 *poplock, __u16 *pnetfid, int xid);
127 void cifs_fill_uniqueid(struct super_block *sb, struct cifs_fattr *fattr);
128 extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
129 FILE_UNIX_BASIC_INFO *info,
130 struct cifs_sb_info *cifs_sb);
131 extern void cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
132 extern struct inode *cifs_iget(struct super_block *sb,
133 struct cifs_fattr *fattr);
135 extern int cifs_get_file_info(struct file *filp);
136 extern int cifs_get_inode_info(struct inode **pinode,
137 const unsigned char *search_path,
138 FILE_ALL_INFO *pfile_info,
139 struct super_block *sb, int xid, const __u16 *pfid);
140 extern int cifs_get_file_info_unix(struct file *filp);
141 extern int cifs_get_inode_info_unix(struct inode **pinode,
142 const unsigned char *search_path,
143 struct super_block *sb, int xid);
144 extern int cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
145 struct cifs_fattr *fattr, struct inode *inode,
146 const char *path, const __u16 *pfid);
147 extern int mode_to_cifs_acl(struct inode *inode, const char *path, __u64);
148 extern struct cifs_ntsd *get_cifs_acl(struct cifs_sb_info *, struct inode *,
149 const char *, u32 *);
150 extern int set_cifs_acl(struct cifs_ntsd *, __u32, struct inode *,
151 const char *);
153 extern int cifs_mount(struct super_block *, struct cifs_sb_info *,
154 const char *);
155 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
156 extern void cifs_dfs_release_automount_timer(void);
157 void cifs_proc_init(void);
158 void cifs_proc_clean(void);
160 extern int cifs_negotiate_protocol(unsigned int xid,
161 struct cifsSesInfo *ses);
162 extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *ses,
163 struct nls_table *nls_info);
164 extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
166 extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
167 const char *tree, struct cifsTconInfo *tcon,
168 const struct nls_table *);
170 extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
171 const char *searchName, const struct nls_table *nls_codepage,
172 __u16 *searchHandle, struct cifs_search_info *psrch_inf,
173 int map, const char dirsep);
175 extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
176 __u16 searchHandle, struct cifs_search_info *psrch_inf);
178 extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
179 const __u16 search_handle);
181 extern int CIFSSMBQFileInfo(const int xid, struct cifsTconInfo *tcon,
182 u16 netfid, FILE_ALL_INFO *pFindData);
183 extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
184 const unsigned char *searchName,
185 FILE_ALL_INFO *findData,
186 int legacy /* whether to use old info level */,
187 const struct nls_table *nls_codepage, int remap);
188 extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
189 const unsigned char *searchName,
190 FILE_ALL_INFO *findData,
191 const struct nls_table *nls_codepage, int remap);
193 extern int CIFSSMBUnixQFileInfo(const int xid, struct cifsTconInfo *tcon,
194 u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
195 extern int CIFSSMBUnixQPathInfo(const int xid,
196 struct cifsTconInfo *tcon,
197 const unsigned char *searchName,
198 FILE_UNIX_BASIC_INFO *pFindData,
199 const struct nls_table *nls_codepage, int remap);
201 extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
202 const unsigned char *searchName,
203 struct dfs_info3_param **target_nodes,
204 unsigned int *number_of_nodes_in_array,
205 const struct nls_table *nls_codepage, int remap);
207 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
208 const char *old_path,
209 const struct nls_table *nls_codepage,
210 unsigned int *pnum_referrals,
211 struct dfs_info3_param **preferrals,
212 int remap);
213 extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
214 struct super_block *sb, struct smb_vol *vol);
215 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
216 struct kstatfs *FSData);
217 extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
218 struct kstatfs *FSData);
219 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
220 __u64 cap);
222 extern int CIFSSMBQFSAttributeInfo(const int xid,
223 struct cifsTconInfo *tcon);
224 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
225 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
226 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
227 struct kstatfs *FSData);
229 extern int CIFSSMBSetPathInfo(const int xid, struct cifsTconInfo *tcon,
230 const char *fileName, const FILE_BASIC_INFO *data,
231 const struct nls_table *nls_codepage,
232 int remap_special_chars);
233 extern int CIFSSMBSetFileInfo(const int xid, struct cifsTconInfo *tcon,
234 const FILE_BASIC_INFO *data, __u16 fid,
235 __u32 pid_of_opener);
236 extern int CIFSSMBSetFileDisposition(const int xid, struct cifsTconInfo *tcon,
237 bool delete_file, __u16 fid, __u32 pid_of_opener);
238 #if 0
239 extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
240 char *fileName, __u16 dos_attributes,
241 const struct nls_table *nls_codepage);
242 #endif /* possibly unneeded function */
243 extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
244 const char *fileName, __u64 size,
245 bool setAllocationSizeFlag,
246 const struct nls_table *nls_codepage,
247 int remap_special_chars);
248 extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
249 __u64 size, __u16 fileHandle, __u32 opener_pid,
250 bool AllocSizeFlag);
252 struct cifs_unix_set_info_args {
253 __u64 ctime;
254 __u64 atime;
255 __u64 mtime;
256 __u64 mode;
257 __u64 uid;
258 __u64 gid;
259 dev_t device;
262 extern int CIFSSMBUnixSetFileInfo(const int xid, struct cifsTconInfo *tcon,
263 const struct cifs_unix_set_info_args *args,
264 u16 fid, u32 pid_of_opener);
266 extern int CIFSSMBUnixSetPathInfo(const int xid, struct cifsTconInfo *pTcon,
267 char *fileName,
268 const struct cifs_unix_set_info_args *args,
269 const struct nls_table *nls_codepage,
270 int remap_special_chars);
272 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
273 const char *newName,
274 const struct nls_table *nls_codepage,
275 int remap_special_chars);
276 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
277 const char *name, const struct nls_table *nls_codepage,
278 int remap_special_chars);
279 extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
280 const char *name, __u16 type,
281 const struct nls_table *nls_codepage,
282 int remap_special_chars);
283 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
284 const char *name,
285 const struct nls_table *nls_codepage,
286 int remap_special_chars);
287 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
288 const char *fromName, const char *toName,
289 const struct nls_table *nls_codepage,
290 int remap_special_chars);
291 extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
292 int netfid, const char *target_name,
293 const struct nls_table *nls_codepage,
294 int remap_special_chars);
295 extern int CIFSCreateHardLink(const int xid,
296 struct cifsTconInfo *tcon,
297 const char *fromName, const char *toName,
298 const struct nls_table *nls_codepage,
299 int remap_special_chars);
300 extern int CIFSUnixCreateHardLink(const int xid,
301 struct cifsTconInfo *tcon,
302 const char *fromName, const char *toName,
303 const struct nls_table *nls_codepage,
304 int remap_special_chars);
305 extern int CIFSUnixCreateSymLink(const int xid,
306 struct cifsTconInfo *tcon,
307 const char *fromName, const char *toName,
308 const struct nls_table *nls_codepage);
309 extern int CIFSSMBUnixQuerySymLink(const int xid,
310 struct cifsTconInfo *tcon,
311 const unsigned char *searchName, char **syminfo,
312 const struct nls_table *nls_codepage);
313 #ifdef CONFIG_CIFS_SYMLINK_EXPERIMENTAL
314 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
315 struct cifsTconInfo *tcon,
316 const unsigned char *searchName,
317 char *symlinkinfo, const int buflen, __u16 fid,
318 const struct nls_table *nls_codepage);
319 #endif /* temporarily unused until cifs_symlink fixed */
320 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
321 const char *fileName, const int disposition,
322 const int access_flags, const int omode,
323 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
324 const struct nls_table *nls_codepage, int remap);
325 extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
326 const char *fileName, const int disposition,
327 const int access_flags, const int omode,
328 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
329 const struct nls_table *nls_codepage, int remap);
330 extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
331 u32 posix_flags, __u64 mode, __u16 *netfid,
332 FILE_UNIX_BASIC_INFO *pRetData,
333 __u32 *pOplock, const char *name,
334 const struct nls_table *nls_codepage, int remap);
335 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
336 const int smb_file_id);
338 extern int CIFSSMBFlush(const int xid, struct cifsTconInfo *tcon,
339 const int smb_file_id);
341 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
342 const int netfid, unsigned int count,
343 const __u64 lseek, unsigned int *nbytes, char **buf,
344 int *return_buf_type);
345 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
346 const int netfid, const unsigned int count,
347 const __u64 lseek, unsigned int *nbytes,
348 const char *buf, const char __user *ubuf,
349 const int long_op);
350 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
351 const int netfid, const unsigned int count,
352 const __u64 offset, unsigned int *nbytes,
353 struct kvec *iov, const int nvec, const int long_op);
354 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
355 const unsigned char *searchName, __u64 *inode_number,
356 const struct nls_table *nls_codepage,
357 int remap_special_chars);
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);
372 extern struct cifsSesInfo *sesInfoAlloc(void);
373 extern void sesInfoFree(struct cifsSesInfo *);
374 extern struct cifsTconInfo *tconInfoAlloc(void);
375 extern void tconInfoFree(struct cifsTconInfo *);
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 *);
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 */