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
23 #include <linux/nls.h>
29 *****************************************************************
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);
44 int __xid = (int)_GetXid(); \
45 cFYI(1, "CIFS VFS: in %s as Xid: %d with uid: %d", \
46 __func__, __xid, current_fsuid()); \
50 #define FreeXid(curr_xid) \
53 cFYI(1, "CIFS VFS: leaving %s (xid = %d) rc = %d", \
54 __func__, curr_xid, (int)rc); \
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,
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,
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,
91 extern void cifs_add_credits(struct TCP_Server_Info *server,
92 const unsigned int add);
93 extern void cifs_set_credits(struct TCP_Server_Info *server, const int val);
94 extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
95 extern bool is_valid_oplock_break(struct smb_hdr *smb,
96 struct TCP_Server_Info *);
97 extern bool backup_cred(struct cifs_sb_info *);
98 extern bool is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
99 extern void cifs_update_eof(struct cifsInodeInfo *cifsi, loff_t offset,
100 unsigned int bytes_written);
101 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *, bool);
102 extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *, bool);
103 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
104 extern int decode_negTokenInit(unsigned char *security_blob, int length,
105 struct TCP_Server_Info *server);
106 extern int cifs_convert_address(struct sockaddr *dst, const char *src, int len);
107 extern int cifs_set_port(struct sockaddr *addr, const unsigned short int port);
108 extern int cifs_fill_sockaddr(struct sockaddr *dst, const char *src, int len,
109 const unsigned short int port);
110 extern int map_smb_to_linux_error(struct smb_hdr *smb, bool logErr);
111 extern void header_assemble(struct smb_hdr *, char /* command */ ,
112 const struct cifs_tcon *, int /* length of
113 fixed section (word count) in two byte units */);
114 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
115 struct cifs_ses *ses,
117 extern int CIFS_SessSetup(unsigned int xid, struct cifs_ses *ses,
118 const struct nls_table *nls_cp);
119 extern __u16 GetNextMid(struct TCP_Server_Info *server);
120 extern struct timespec cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
121 extern u64 cifs_UnixTimeToNT(struct timespec);
122 extern struct timespec cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
124 extern void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock);
126 extern struct cifsFileInfo *cifs_new_fileinfo(__u16 fileHandle,
127 struct file *file, struct tcon_link *tlink,
129 extern int cifs_posix_open(char *full_path, struct inode **pinode,
130 struct super_block *sb,
131 int mode, unsigned int f_flags,
132 __u32 *poplock, __u16 *pnetfid, int xid);
133 void cifs_fill_uniqueid(struct super_block *sb, struct cifs_fattr *fattr);
134 extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
135 FILE_UNIX_BASIC_INFO *info,
136 struct cifs_sb_info *cifs_sb);
137 extern void cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
138 extern struct inode *cifs_iget(struct super_block *sb,
139 struct cifs_fattr *fattr);
141 extern int cifs_get_file_info(struct file *filp);
142 extern int cifs_get_inode_info(struct inode **pinode,
143 const unsigned char *search_path,
144 FILE_ALL_INFO *pfile_info,
145 struct super_block *sb, int xid, const __u16 *pfid);
146 extern int cifs_get_file_info_unix(struct file *filp);
147 extern int cifs_get_inode_info_unix(struct inode **pinode,
148 const unsigned char *search_path,
149 struct super_block *sb, int xid);
150 extern int cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
151 struct cifs_fattr *fattr, struct inode *inode,
152 const char *path, const __u16 *pfid);
153 extern int id_mode_to_cifs_acl(struct inode *inode, const char *path, __u64,
155 extern struct cifs_ntsd *get_cifs_acl(struct cifs_sb_info *, struct inode *,
156 const char *, u32 *);
157 extern int set_cifs_acl(struct cifs_ntsd *, __u32, struct inode *,
160 extern void dequeue_mid(struct mid_q_entry *mid, bool malformed);
161 extern int cifs_read_from_socket(struct TCP_Server_Info *server, char *buf,
162 unsigned int to_read);
163 extern int cifs_readv_from_socket(struct TCP_Server_Info *server,
164 struct kvec *iov_orig, unsigned int nr_segs,
165 unsigned int to_read);
166 extern void cifs_setup_cifs_sb(struct smb_vol *pvolume_info,
167 struct cifs_sb_info *cifs_sb);
168 extern int cifs_match_super(struct super_block *, void *);
169 extern void cifs_cleanup_volume_info(struct smb_vol *pvolume_info);
170 extern struct smb_vol *cifs_get_volume_info(char *mount_data,
171 const char *devname);
172 extern int cifs_mount(struct cifs_sb_info *, struct smb_vol *);
173 extern void cifs_umount(struct cifs_sb_info *);
174 extern void cifs_dfs_release_automount_timer(void);
175 void cifs_proc_init(void);
176 void cifs_proc_clean(void);
178 extern int cifs_negotiate_protocol(unsigned int xid,
179 struct cifs_ses *ses);
180 extern int cifs_setup_session(unsigned int xid, struct cifs_ses *ses,
181 struct nls_table *nls_info);
182 extern int CIFSSMBNegotiate(unsigned int xid, struct cifs_ses *ses);
184 extern int CIFSTCon(unsigned int xid, struct cifs_ses *ses,
185 const char *tree, struct cifs_tcon *tcon,
186 const struct nls_table *);
188 extern int CIFSFindFirst(const int xid, struct cifs_tcon *tcon,
189 const char *searchName, const struct nls_table *nls_codepage,
190 __u16 *searchHandle, struct cifs_search_info *psrch_inf,
191 int map, const char dirsep);
193 extern int CIFSFindNext(const int xid, struct cifs_tcon *tcon,
194 __u16 searchHandle, struct cifs_search_info *psrch_inf);
196 extern int CIFSFindClose(const int, struct cifs_tcon *tcon,
197 const __u16 search_handle);
199 extern int CIFSSMBQFileInfo(const int xid, struct cifs_tcon *tcon,
200 u16 netfid, FILE_ALL_INFO *pFindData);
201 extern int CIFSSMBQPathInfo(const int xid, struct cifs_tcon *tcon,
202 const unsigned char *searchName,
203 FILE_ALL_INFO *findData,
204 int legacy /* whether to use old info level */,
205 const struct nls_table *nls_codepage, int remap);
206 extern int SMBQueryInformation(const int xid, struct cifs_tcon *tcon,
207 const unsigned char *searchName,
208 FILE_ALL_INFO *findData,
209 const struct nls_table *nls_codepage, int remap);
211 extern int CIFSSMBUnixQFileInfo(const int xid, struct cifs_tcon *tcon,
212 u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
213 extern int CIFSSMBUnixQPathInfo(const int xid,
214 struct cifs_tcon *tcon,
215 const unsigned char *searchName,
216 FILE_UNIX_BASIC_INFO *pFindData,
217 const struct nls_table *nls_codepage, int remap);
219 extern int CIFSGetDFSRefer(const int xid, struct cifs_ses *ses,
220 const unsigned char *searchName,
221 struct dfs_info3_param **target_nodes,
222 unsigned int *number_of_nodes_in_array,
223 const struct nls_table *nls_codepage, int remap);
225 extern int get_dfs_path(int xid, struct cifs_ses *pSesInfo,
226 const char *old_path,
227 const struct nls_table *nls_codepage,
228 unsigned int *pnum_referrals,
229 struct dfs_info3_param **preferrals,
231 extern void reset_cifs_unix_caps(int xid, struct cifs_tcon *tcon,
232 struct cifs_sb_info *cifs_sb,
233 struct smb_vol *vol);
234 extern int CIFSSMBQFSInfo(const int xid, struct cifs_tcon *tcon,
235 struct kstatfs *FSData);
236 extern int SMBOldQFSInfo(const int xid, struct cifs_tcon *tcon,
237 struct kstatfs *FSData);
238 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifs_tcon *tcon,
241 extern int CIFSSMBQFSAttributeInfo(const int xid,
242 struct cifs_tcon *tcon);
243 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifs_tcon *tcon);
244 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifs_tcon *tcon);
245 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifs_tcon *tcon,
246 struct kstatfs *FSData);
248 extern int CIFSSMBSetPathInfo(const int xid, struct cifs_tcon *tcon,
249 const char *fileName, const FILE_BASIC_INFO *data,
250 const struct nls_table *nls_codepage,
251 int remap_special_chars);
252 extern int CIFSSMBSetFileInfo(const int xid, struct cifs_tcon *tcon,
253 const FILE_BASIC_INFO *data, __u16 fid,
254 __u32 pid_of_opener);
255 extern int CIFSSMBSetFileDisposition(const int xid, struct cifs_tcon *tcon,
256 bool delete_file, __u16 fid, __u32 pid_of_opener);
258 extern int CIFSSMBSetAttrLegacy(int xid, struct cifs_tcon *tcon,
259 char *fileName, __u16 dos_attributes,
260 const struct nls_table *nls_codepage);
261 #endif /* possibly unneeded function */
262 extern int CIFSSMBSetEOF(const int xid, struct cifs_tcon *tcon,
263 const char *fileName, __u64 size,
264 bool setAllocationSizeFlag,
265 const struct nls_table *nls_codepage,
266 int remap_special_chars);
267 extern int CIFSSMBSetFileSize(const int xid, struct cifs_tcon *tcon,
268 __u64 size, __u16 fileHandle, __u32 opener_pid,
271 struct cifs_unix_set_info_args {
281 extern int CIFSSMBUnixSetFileInfo(const int xid, struct cifs_tcon *tcon,
282 const struct cifs_unix_set_info_args *args,
283 u16 fid, u32 pid_of_opener);
285 extern int CIFSSMBUnixSetPathInfo(const int xid, struct cifs_tcon *pTcon,
287 const struct cifs_unix_set_info_args *args,
288 const struct nls_table *nls_codepage,
289 int remap_special_chars);
291 extern int CIFSSMBMkDir(const int xid, struct cifs_tcon *tcon,
293 const struct nls_table *nls_codepage,
294 int remap_special_chars);
295 extern int CIFSSMBRmDir(const int xid, struct cifs_tcon *tcon,
296 const char *name, const struct nls_table *nls_codepage,
297 int remap_special_chars);
298 extern int CIFSPOSIXDelFile(const int xid, struct cifs_tcon *tcon,
299 const char *name, __u16 type,
300 const struct nls_table *nls_codepage,
301 int remap_special_chars);
302 extern int CIFSSMBDelFile(const int xid, struct cifs_tcon *tcon,
304 const struct nls_table *nls_codepage,
305 int remap_special_chars);
306 extern int CIFSSMBRename(const int xid, 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 CIFSSMBRenameOpenFile(const int xid, struct cifs_tcon *pTcon,
311 int netfid, const char *target_name,
312 const struct nls_table *nls_codepage,
313 int remap_special_chars);
314 extern int CIFSCreateHardLink(const int xid,
315 struct cifs_tcon *tcon,
316 const char *fromName, const char *toName,
317 const struct nls_table *nls_codepage,
318 int remap_special_chars);
319 extern int CIFSUnixCreateHardLink(const int xid,
320 struct cifs_tcon *tcon,
321 const char *fromName, const char *toName,
322 const struct nls_table *nls_codepage,
323 int remap_special_chars);
324 extern int CIFSUnixCreateSymLink(const int xid,
325 struct cifs_tcon *tcon,
326 const char *fromName, const char *toName,
327 const struct nls_table *nls_codepage);
328 extern int CIFSSMBUnixQuerySymLink(const int xid,
329 struct cifs_tcon *tcon,
330 const unsigned char *searchName, char **syminfo,
331 const struct nls_table *nls_codepage);
332 #ifdef CONFIG_CIFS_SYMLINK_EXPERIMENTAL
333 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
334 struct cifs_tcon *tcon,
335 const unsigned char *searchName,
336 char *symlinkinfo, const int buflen, __u16 fid,
337 const struct nls_table *nls_codepage);
338 #endif /* temporarily unused until cifs_symlink fixed */
339 extern int CIFSSMBOpen(const int xid, struct cifs_tcon *tcon,
340 const char *fileName, const int disposition,
341 const int access_flags, const int omode,
342 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
343 const struct nls_table *nls_codepage, int remap);
344 extern int SMBLegacyOpen(const int xid, struct cifs_tcon *tcon,
345 const char *fileName, const int disposition,
346 const int access_flags, const int omode,
347 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
348 const struct nls_table *nls_codepage, int remap);
349 extern int CIFSPOSIXCreate(const int xid, struct cifs_tcon *tcon,
350 u32 posix_flags, __u64 mode, __u16 *netfid,
351 FILE_UNIX_BASIC_INFO *pRetData,
352 __u32 *pOplock, const char *name,
353 const struct nls_table *nls_codepage, int remap);
354 extern int CIFSSMBClose(const int xid, struct cifs_tcon *tcon,
355 const int smb_file_id);
357 extern int CIFSSMBFlush(const int xid, struct cifs_tcon *tcon,
358 const int smb_file_id);
360 extern int CIFSSMBRead(const int xid, struct cifs_io_parms *io_parms,
361 unsigned int *nbytes, char **buf,
362 int *return_buf_type);
363 extern int CIFSSMBWrite(const int xid, struct cifs_io_parms *io_parms,
364 unsigned int *nbytes, const char *buf,
365 const char __user *ubuf, const int long_op);
366 extern int CIFSSMBWrite2(const int xid, struct cifs_io_parms *io_parms,
367 unsigned int *nbytes, struct kvec *iov, const int nvec,
369 extern int CIFSGetSrvInodeNumber(const int xid, struct cifs_tcon *tcon,
370 const unsigned char *searchName, __u64 *inode_number,
371 const struct nls_table *nls_codepage,
372 int remap_special_chars);
374 extern int cifs_lockv(const int xid, struct cifs_tcon *tcon, const __u16 netfid,
375 const __u8 lock_type, const __u32 num_unlock,
376 const __u32 num_lock, LOCKING_ANDX_RANGE *buf);
377 extern int CIFSSMBLock(const int xid, struct cifs_tcon *tcon,
378 const __u16 netfid, const __u32 netpid, const __u64 len,
379 const __u64 offset, const __u32 numUnlock,
380 const __u32 numLock, const __u8 lockType,
381 const bool waitFlag, const __u8 oplock_level);
382 extern int CIFSSMBPosixLock(const int xid, struct cifs_tcon *tcon,
383 const __u16 smb_file_id, const __u32 netpid,
384 const int get_flag, const __u64 len, struct file_lock *,
385 const __u16 lock_type, const bool waitFlag);
386 extern int CIFSSMBTDis(const int xid, struct cifs_tcon *tcon);
387 extern int CIFSSMBEcho(struct TCP_Server_Info *server);
388 extern int CIFSSMBLogoff(const int xid, struct cifs_ses *ses);
390 extern struct cifs_ses *sesInfoAlloc(void);
391 extern void sesInfoFree(struct cifs_ses *);
392 extern struct cifs_tcon *tconInfoAlloc(void);
393 extern void tconInfoFree(struct cifs_tcon *);
395 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
396 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
398 extern int cifs_verify_signature(struct kvec *iov, unsigned int nr_iov,
399 struct TCP_Server_Info *server,
400 __u32 expected_sequence_number);
401 extern int SMBNTencrypt(unsigned char *, unsigned char *, unsigned char *,
402 const struct nls_table *);
403 extern int setup_ntlm_response(struct cifs_ses *, const struct nls_table *);
404 extern int setup_ntlmv2_rsp(struct cifs_ses *, const struct nls_table *);
405 extern int cifs_crypto_shash_allocate(struct TCP_Server_Info *);
406 extern void cifs_crypto_shash_release(struct TCP_Server_Info *);
407 extern int calc_seckey(struct cifs_ses *);
409 #ifdef CONFIG_CIFS_WEAK_PW_HASH
410 extern int calc_lanman_hash(const char *password, const char *cryptkey,
411 bool encrypt, char *lnm_session_key);
412 #endif /* CIFS_WEAK_PW_HASH */
413 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
414 extern int CIFSSMBNotify(const int xid, struct cifs_tcon *tcon,
415 const int notify_subdirs, const __u16 netfid,
416 __u32 filter, struct file *file, int multishot,
417 const struct nls_table *nls_codepage);
418 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
419 extern int CIFSSMBCopy(int xid,
420 struct cifs_tcon *source_tcon,
421 const char *fromName,
422 const __u16 target_tid,
423 const char *toName, const int flags,
424 const struct nls_table *nls_codepage,
425 int remap_special_chars);
426 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifs_tcon *tcon,
427 const unsigned char *searchName,
428 const unsigned char *ea_name, char *EAData,
429 size_t bufsize, const struct nls_table *nls_codepage,
430 int remap_special_chars);
431 extern int CIFSSMBSetEA(const int xid, struct cifs_tcon *tcon,
432 const char *fileName, const char *ea_name,
433 const void *ea_value, const __u16 ea_value_len,
434 const struct nls_table *nls_codepage, int remap_special_chars);
435 extern int CIFSSMBGetCIFSACL(const int xid, struct cifs_tcon *tcon,
436 __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
437 extern int CIFSSMBSetCIFSACL(const int, struct cifs_tcon *, __u16,
438 struct cifs_ntsd *, __u32, int);
439 extern int CIFSSMBGetPosixACL(const int xid, struct cifs_tcon *tcon,
440 const unsigned char *searchName,
441 char *acl_inf, const int buflen, const int acl_type,
442 const struct nls_table *nls_codepage, int remap_special_chars);
443 extern int CIFSSMBSetPosixACL(const int xid, struct cifs_tcon *tcon,
444 const unsigned char *fileName,
445 const char *local_acl, const int buflen, const int acl_type,
446 const struct nls_table *nls_codepage, int remap_special_chars);
447 extern int CIFSGetExtAttr(const int xid, struct cifs_tcon *tcon,
448 const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
449 extern void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
450 extern bool CIFSCouldBeMFSymlink(const struct cifs_fattr *fattr);
451 extern int CIFSCheckMFSymlink(struct cifs_fattr *fattr,
452 const unsigned char *path,
453 struct cifs_sb_info *cifs_sb, int xid);
454 extern int mdfour(unsigned char *, unsigned char *, int);
455 extern int E_md4hash(const unsigned char *passwd, unsigned char *p16,
456 const struct nls_table *codepage);
457 extern int SMBencrypt(unsigned char *passwd, const unsigned char *c8,
460 /* asynchronous read support */
461 struct cifs_readdata {
462 struct cifsFileInfo *cfile;
463 struct address_space *mapping;
468 struct list_head pages;
469 struct work_struct work;
474 struct cifs_readdata *cifs_readdata_alloc(unsigned int nr_pages);
475 void cifs_readdata_free(struct cifs_readdata *rdata);
476 int cifs_async_readv(struct cifs_readdata *rdata);
478 /* asynchronous write support */
479 struct cifs_writedata {
480 struct kref refcount;
481 enum writeback_sync_modes sync_mode;
482 struct work_struct work;
483 struct cifsFileInfo *cfile;
487 unsigned int nr_pages;
488 struct page *pages[1];
491 int cifs_async_writev(struct cifs_writedata *wdata);
492 struct cifs_writedata *cifs_writedata_alloc(unsigned int nr_pages);
493 void cifs_writedata_release(struct kref *refcount);
495 #endif /* _CIFSPROTO_H */