cifs: add a callback function to receive the rest of the frame
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / fs / cifs / cifsproto.h
blob8a7adb31ffedfcc0eae303f892ef6629eb26ea78
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 smb_vol *vol,
61 struct cifs_sb_info *cifs_sb,
62 struct cifs_tcon *tcon);
63 extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
64 extern char *cifs_compose_mount_options(const char *sb_mountdata,
65 const char *fullpath, const struct dfs_info3_param *ref,
66 char **devname);
67 /* extern void renew_parental_timestamps(struct dentry *direntry);*/
68 extern struct mid_q_entry *AllocMidQEntry(const struct smb_hdr *smb_buffer,
69 struct TCP_Server_Info *server);
70 extern void DeleteMidQEntry(struct mid_q_entry *midEntry);
71 extern int cifs_call_async(struct TCP_Server_Info *server, struct kvec *iov,
72 unsigned int nvec, mid_receive_t *receive,
73 mid_callback_t *callback, void *cbdata,
74 bool ignore_pend);
75 extern int SendReceive(const unsigned int /* xid */ , struct cifs_ses *,
76 struct smb_hdr * /* input */ ,
77 struct smb_hdr * /* out */ ,
78 int * /* bytes returned */ , const int long_op);
79 extern int SendReceiveNoRsp(const unsigned int xid, struct cifs_ses *ses,
80 struct smb_hdr *in_buf, int flags);
81 extern int cifs_check_receive(struct mid_q_entry *mid,
82 struct TCP_Server_Info *server, bool log_error);
83 extern int SendReceive2(const unsigned int /* xid */ , struct cifs_ses *,
84 struct kvec *, int /* nvec to send */,
85 int * /* type of buf returned */ , const int flags);
86 extern int SendReceiveBlockingLock(const unsigned int xid,
87 struct cifs_tcon *ptcon,
88 struct smb_hdr *in_buf ,
89 struct smb_hdr *out_buf,
90 int *bytes_returned);
91 extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
92 extern bool is_valid_oplock_break(struct smb_hdr *smb,
93 struct TCP_Server_Info *);
94 extern bool backup_cred(struct cifs_sb_info *);
95 extern bool is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
96 extern void cifs_update_eof(struct cifsInodeInfo *cifsi, loff_t offset,
97 unsigned int bytes_written);
98 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *, bool);
99 extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *, bool);
100 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
101 extern int decode_negTokenInit(unsigned char *security_blob, int length,
102 struct TCP_Server_Info *server);
103 extern int cifs_convert_address(struct sockaddr *dst, const char *src, int len);
104 extern int cifs_set_port(struct sockaddr *addr, const unsigned short int port);
105 extern int cifs_fill_sockaddr(struct sockaddr *dst, const char *src, int len,
106 const unsigned short int port);
107 extern int map_smb_to_linux_error(struct smb_hdr *smb, bool logErr);
108 extern void header_assemble(struct smb_hdr *, char /* command */ ,
109 const struct cifs_tcon *, int /* length of
110 fixed section (word count) in two byte units */);
111 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
112 struct cifs_ses *ses,
113 void **request_buf);
114 extern int CIFS_SessSetup(unsigned int xid, struct cifs_ses *ses,
115 const struct nls_table *nls_cp);
116 extern __u16 GetNextMid(struct TCP_Server_Info *server);
117 extern struct timespec cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
118 extern u64 cifs_UnixTimeToNT(struct timespec);
119 extern struct timespec cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
120 int offset);
121 extern void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock);
123 extern struct cifsFileInfo *cifs_new_fileinfo(__u16 fileHandle,
124 struct file *file, struct tcon_link *tlink,
125 __u32 oplock);
126 extern int cifs_posix_open(char *full_path, struct inode **pinode,
127 struct super_block *sb,
128 int mode, unsigned int f_flags,
129 __u32 *poplock, __u16 *pnetfid, int xid);
130 void cifs_fill_uniqueid(struct super_block *sb, struct cifs_fattr *fattr);
131 extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
132 FILE_UNIX_BASIC_INFO *info,
133 struct cifs_sb_info *cifs_sb);
134 extern void cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
135 extern struct inode *cifs_iget(struct super_block *sb,
136 struct cifs_fattr *fattr);
138 extern int cifs_get_file_info(struct file *filp);
139 extern int cifs_get_inode_info(struct inode **pinode,
140 const unsigned char *search_path,
141 FILE_ALL_INFO *pfile_info,
142 struct super_block *sb, int xid, const __u16 *pfid);
143 extern int cifs_get_file_info_unix(struct file *filp);
144 extern int cifs_get_inode_info_unix(struct inode **pinode,
145 const unsigned char *search_path,
146 struct super_block *sb, int xid);
147 extern int cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
148 struct cifs_fattr *fattr, struct inode *inode,
149 const char *path, const __u16 *pfid);
150 extern int id_mode_to_cifs_acl(struct inode *inode, const char *path, __u64,
151 uid_t, gid_t);
152 extern struct cifs_ntsd *get_cifs_acl(struct cifs_sb_info *, struct inode *,
153 const char *, u32 *);
154 extern int set_cifs_acl(struct cifs_ntsd *, __u32, struct inode *,
155 const char *, int);
157 extern void cifs_setup_cifs_sb(struct smb_vol *pvolume_info,
158 struct cifs_sb_info *cifs_sb);
159 extern int cifs_match_super(struct super_block *, void *);
160 extern void cifs_cleanup_volume_info(struct smb_vol *pvolume_info);
161 extern struct smb_vol *cifs_get_volume_info(char *mount_data,
162 const char *devname);
163 extern int cifs_mount(struct cifs_sb_info *, struct smb_vol *);
164 extern void cifs_umount(struct cifs_sb_info *);
165 extern void cifs_dfs_release_automount_timer(void);
166 void cifs_proc_init(void);
167 void cifs_proc_clean(void);
169 extern int cifs_negotiate_protocol(unsigned int xid,
170 struct cifs_ses *ses);
171 extern int cifs_setup_session(unsigned int xid, struct cifs_ses *ses,
172 struct nls_table *nls_info);
173 extern int CIFSSMBNegotiate(unsigned int xid, struct cifs_ses *ses);
175 extern int CIFSTCon(unsigned int xid, struct cifs_ses *ses,
176 const char *tree, struct cifs_tcon *tcon,
177 const struct nls_table *);
179 extern int CIFSFindFirst(const int xid, struct cifs_tcon *tcon,
180 const char *searchName, const struct nls_table *nls_codepage,
181 __u16 *searchHandle, struct cifs_search_info *psrch_inf,
182 int map, const char dirsep);
184 extern int CIFSFindNext(const int xid, struct cifs_tcon *tcon,
185 __u16 searchHandle, struct cifs_search_info *psrch_inf);
187 extern int CIFSFindClose(const int, struct cifs_tcon *tcon,
188 const __u16 search_handle);
190 extern int CIFSSMBQFileInfo(const int xid, struct cifs_tcon *tcon,
191 u16 netfid, FILE_ALL_INFO *pFindData);
192 extern int CIFSSMBQPathInfo(const int xid, struct cifs_tcon *tcon,
193 const unsigned char *searchName,
194 FILE_ALL_INFO *findData,
195 int legacy /* whether to use old info level */,
196 const struct nls_table *nls_codepage, int remap);
197 extern int SMBQueryInformation(const int xid, struct cifs_tcon *tcon,
198 const unsigned char *searchName,
199 FILE_ALL_INFO *findData,
200 const struct nls_table *nls_codepage, int remap);
202 extern int CIFSSMBUnixQFileInfo(const int xid, struct cifs_tcon *tcon,
203 u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
204 extern int CIFSSMBUnixQPathInfo(const int xid,
205 struct cifs_tcon *tcon,
206 const unsigned char *searchName,
207 FILE_UNIX_BASIC_INFO *pFindData,
208 const struct nls_table *nls_codepage, int remap);
210 extern int CIFSGetDFSRefer(const int xid, struct cifs_ses *ses,
211 const unsigned char *searchName,
212 struct dfs_info3_param **target_nodes,
213 unsigned int *number_of_nodes_in_array,
214 const struct nls_table *nls_codepage, int remap);
216 extern int get_dfs_path(int xid, struct cifs_ses *pSesInfo,
217 const char *old_path,
218 const struct nls_table *nls_codepage,
219 unsigned int *pnum_referrals,
220 struct dfs_info3_param **preferrals,
221 int remap);
222 extern void reset_cifs_unix_caps(int xid, struct cifs_tcon *tcon,
223 struct cifs_sb_info *cifs_sb,
224 struct smb_vol *vol);
225 extern int CIFSSMBQFSInfo(const int xid, struct cifs_tcon *tcon,
226 struct kstatfs *FSData);
227 extern int SMBOldQFSInfo(const int xid, struct cifs_tcon *tcon,
228 struct kstatfs *FSData);
229 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifs_tcon *tcon,
230 __u64 cap);
232 extern int CIFSSMBQFSAttributeInfo(const int xid,
233 struct cifs_tcon *tcon);
234 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifs_tcon *tcon);
235 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifs_tcon *tcon);
236 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifs_tcon *tcon,
237 struct kstatfs *FSData);
239 extern int CIFSSMBSetPathInfo(const int xid, struct cifs_tcon *tcon,
240 const char *fileName, const FILE_BASIC_INFO *data,
241 const struct nls_table *nls_codepage,
242 int remap_special_chars);
243 extern int CIFSSMBSetFileInfo(const int xid, struct cifs_tcon *tcon,
244 const FILE_BASIC_INFO *data, __u16 fid,
245 __u32 pid_of_opener);
246 extern int CIFSSMBSetFileDisposition(const int xid, struct cifs_tcon *tcon,
247 bool delete_file, __u16 fid, __u32 pid_of_opener);
248 #if 0
249 extern int CIFSSMBSetAttrLegacy(int xid, struct cifs_tcon *tcon,
250 char *fileName, __u16 dos_attributes,
251 const struct nls_table *nls_codepage);
252 #endif /* possibly unneeded function */
253 extern int CIFSSMBSetEOF(const int xid, struct cifs_tcon *tcon,
254 const char *fileName, __u64 size,
255 bool setAllocationSizeFlag,
256 const struct nls_table *nls_codepage,
257 int remap_special_chars);
258 extern int CIFSSMBSetFileSize(const int xid, struct cifs_tcon *tcon,
259 __u64 size, __u16 fileHandle, __u32 opener_pid,
260 bool AllocSizeFlag);
262 struct cifs_unix_set_info_args {
263 __u64 ctime;
264 __u64 atime;
265 __u64 mtime;
266 __u64 mode;
267 __u64 uid;
268 __u64 gid;
269 dev_t device;
272 extern int CIFSSMBUnixSetFileInfo(const int xid, struct cifs_tcon *tcon,
273 const struct cifs_unix_set_info_args *args,
274 u16 fid, u32 pid_of_opener);
276 extern int CIFSSMBUnixSetPathInfo(const int xid, struct cifs_tcon *pTcon,
277 char *fileName,
278 const struct cifs_unix_set_info_args *args,
279 const struct nls_table *nls_codepage,
280 int remap_special_chars);
282 extern int CIFSSMBMkDir(const int xid, struct cifs_tcon *tcon,
283 const char *newName,
284 const struct nls_table *nls_codepage,
285 int remap_special_chars);
286 extern int CIFSSMBRmDir(const int xid, struct cifs_tcon *tcon,
287 const char *name, const struct nls_table *nls_codepage,
288 int remap_special_chars);
289 extern int CIFSPOSIXDelFile(const int xid, struct cifs_tcon *tcon,
290 const char *name, __u16 type,
291 const struct nls_table *nls_codepage,
292 int remap_special_chars);
293 extern int CIFSSMBDelFile(const int xid, struct cifs_tcon *tcon,
294 const char *name,
295 const struct nls_table *nls_codepage,
296 int remap_special_chars);
297 extern int CIFSSMBRename(const int xid, struct cifs_tcon *tcon,
298 const char *fromName, const char *toName,
299 const struct nls_table *nls_codepage,
300 int remap_special_chars);
301 extern int CIFSSMBRenameOpenFile(const int xid, struct cifs_tcon *pTcon,
302 int netfid, const char *target_name,
303 const struct nls_table *nls_codepage,
304 int remap_special_chars);
305 extern int CIFSCreateHardLink(const int xid,
306 struct cifs_tcon *tcon,
307 const char *fromName, const char *toName,
308 const struct nls_table *nls_codepage,
309 int remap_special_chars);
310 extern int CIFSUnixCreateHardLink(const int xid,
311 struct cifs_tcon *tcon,
312 const char *fromName, const char *toName,
313 const struct nls_table *nls_codepage,
314 int remap_special_chars);
315 extern int CIFSUnixCreateSymLink(const int xid,
316 struct cifs_tcon *tcon,
317 const char *fromName, const char *toName,
318 const struct nls_table *nls_codepage);
319 extern int CIFSSMBUnixQuerySymLink(const int xid,
320 struct cifs_tcon *tcon,
321 const unsigned char *searchName, char **syminfo,
322 const struct nls_table *nls_codepage);
323 #ifdef CONFIG_CIFS_SYMLINK_EXPERIMENTAL
324 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
325 struct cifs_tcon *tcon,
326 const unsigned char *searchName,
327 char *symlinkinfo, const int buflen, __u16 fid,
328 const struct nls_table *nls_codepage);
329 #endif /* temporarily unused until cifs_symlink fixed */
330 extern int CIFSSMBOpen(const int xid, struct cifs_tcon *tcon,
331 const char *fileName, const int disposition,
332 const int access_flags, const int omode,
333 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
334 const struct nls_table *nls_codepage, int remap);
335 extern int SMBLegacyOpen(const int xid, struct cifs_tcon *tcon,
336 const char *fileName, const int disposition,
337 const int access_flags, const int omode,
338 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
339 const struct nls_table *nls_codepage, int remap);
340 extern int CIFSPOSIXCreate(const int xid, struct cifs_tcon *tcon,
341 u32 posix_flags, __u64 mode, __u16 *netfid,
342 FILE_UNIX_BASIC_INFO *pRetData,
343 __u32 *pOplock, const char *name,
344 const struct nls_table *nls_codepage, int remap);
345 extern int CIFSSMBClose(const int xid, struct cifs_tcon *tcon,
346 const int smb_file_id);
348 extern int CIFSSMBFlush(const int xid, struct cifs_tcon *tcon,
349 const int smb_file_id);
351 extern int CIFSSMBRead(const int xid, struct cifs_io_parms *io_parms,
352 unsigned int *nbytes, char **buf,
353 int *return_buf_type);
354 extern int CIFSSMBWrite(const int xid, struct cifs_io_parms *io_parms,
355 unsigned int *nbytes, const char *buf,
356 const char __user *ubuf, const int long_op);
357 extern int CIFSSMBWrite2(const int xid, struct cifs_io_parms *io_parms,
358 unsigned int *nbytes, struct kvec *iov, const int nvec,
359 const int long_op);
360 extern int CIFSGetSrvInodeNumber(const int xid, struct cifs_tcon *tcon,
361 const unsigned char *searchName, __u64 *inode_number,
362 const struct nls_table *nls_codepage,
363 int remap_special_chars);
365 extern int CIFSSMBLock(const int xid, struct cifs_tcon *tcon,
366 const __u16 netfid, const __u32 netpid, const __u64 len,
367 const __u64 offset, const __u32 numUnlock,
368 const __u32 numLock, const __u8 lockType,
369 const bool waitFlag, const __u8 oplock_level);
370 extern int CIFSSMBPosixLock(const int xid, struct cifs_tcon *tcon,
371 const __u16 smb_file_id, const int get_flag,
372 const __u64 len, struct file_lock *,
373 const __u16 lock_type, const bool waitFlag);
374 extern int CIFSSMBTDis(const int xid, struct cifs_tcon *tcon);
375 extern int CIFSSMBEcho(struct TCP_Server_Info *server);
376 extern int CIFSSMBLogoff(const int xid, struct cifs_ses *ses);
378 extern struct cifs_ses *sesInfoAlloc(void);
379 extern void sesInfoFree(struct cifs_ses *);
380 extern struct cifs_tcon *tconInfoAlloc(void);
381 extern void tconInfoFree(struct cifs_tcon *);
383 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
384 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
385 __u32 *);
386 extern int cifs_verify_signature(struct kvec *iov, unsigned int nr_iov,
387 struct TCP_Server_Info *server,
388 __u32 expected_sequence_number);
389 extern int SMBNTencrypt(unsigned char *, unsigned char *, unsigned char *);
390 extern int setup_ntlm_response(struct cifs_ses *);
391 extern int setup_ntlmv2_rsp(struct cifs_ses *, const struct nls_table *);
392 extern int cifs_crypto_shash_allocate(struct TCP_Server_Info *);
393 extern void cifs_crypto_shash_release(struct TCP_Server_Info *);
394 extern int calc_seckey(struct cifs_ses *);
396 #ifdef CONFIG_CIFS_WEAK_PW_HASH
397 extern int calc_lanman_hash(const char *password, const char *cryptkey,
398 bool encrypt, char *lnm_session_key);
399 #endif /* CIFS_WEAK_PW_HASH */
400 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
401 extern int CIFSSMBNotify(const int xid, struct cifs_tcon *tcon,
402 const int notify_subdirs, const __u16 netfid,
403 __u32 filter, struct file *file, int multishot,
404 const struct nls_table *nls_codepage);
405 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
406 extern int CIFSSMBCopy(int xid,
407 struct cifs_tcon *source_tcon,
408 const char *fromName,
409 const __u16 target_tid,
410 const char *toName, const int flags,
411 const struct nls_table *nls_codepage,
412 int remap_special_chars);
413 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifs_tcon *tcon,
414 const unsigned char *searchName,
415 const unsigned char *ea_name, char *EAData,
416 size_t bufsize, const struct nls_table *nls_codepage,
417 int remap_special_chars);
418 extern int CIFSSMBSetEA(const int xid, struct cifs_tcon *tcon,
419 const char *fileName, const char *ea_name,
420 const void *ea_value, const __u16 ea_value_len,
421 const struct nls_table *nls_codepage, int remap_special_chars);
422 extern int CIFSSMBGetCIFSACL(const int xid, struct cifs_tcon *tcon,
423 __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
424 extern int CIFSSMBSetCIFSACL(const int, struct cifs_tcon *, __u16,
425 struct cifs_ntsd *, __u32, int);
426 extern int CIFSSMBGetPosixACL(const int xid, struct cifs_tcon *tcon,
427 const unsigned char *searchName,
428 char *acl_inf, const int buflen, const int acl_type,
429 const struct nls_table *nls_codepage, int remap_special_chars);
430 extern int CIFSSMBSetPosixACL(const int xid, struct cifs_tcon *tcon,
431 const unsigned char *fileName,
432 const char *local_acl, const int buflen, const int acl_type,
433 const struct nls_table *nls_codepage, int remap_special_chars);
434 extern int CIFSGetExtAttr(const int xid, struct cifs_tcon *tcon,
435 const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
436 extern void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
437 extern bool CIFSCouldBeMFSymlink(const struct cifs_fattr *fattr);
438 extern int CIFSCheckMFSymlink(struct cifs_fattr *fattr,
439 const unsigned char *path,
440 struct cifs_sb_info *cifs_sb, int xid);
441 extern int mdfour(unsigned char *, unsigned char *, int);
442 extern int E_md4hash(const unsigned char *passwd, unsigned char *p16);
443 extern int SMBencrypt(unsigned char *passwd, const unsigned char *c8,
444 unsigned char *p24);
446 /* asynchronous write support */
447 struct cifs_writedata {
448 struct kref refcount;
449 enum writeback_sync_modes sync_mode;
450 struct work_struct work;
451 struct cifsFileInfo *cfile;
452 __u64 offset;
453 unsigned int bytes;
454 int result;
455 unsigned int nr_pages;
456 struct page *pages[1];
459 int cifs_async_writev(struct cifs_writedata *wdata);
460 struct cifs_writedata *cifs_writedata_alloc(unsigned int nr_pages);
461 void cifs_writedata_release(struct kref *refcount);
463 #endif /* _CIFSPROTO_H */