xref: /kernel/linux/linux-5.10/fs/cifs/cifsproto.h (revision 8c2ecf20)
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#include "trace.h"
25#ifdef CONFIG_CIFS_DFS_UPCALL
26#include "dfs_cache.h"
27#endif
28
29struct statfs;
30struct smb_vol;
31struct smb_rqst;
32
33/*
34 *****************************************************************
35 * All Prototypes
36 *****************************************************************
37 */
38
39extern struct smb_hdr *cifs_buf_get(void);
40extern void cifs_buf_release(void *);
41extern struct smb_hdr *cifs_small_buf_get(void);
42extern void cifs_small_buf_release(void *);
43extern void free_rsp_buf(int, void *);
44extern int smb_send(struct TCP_Server_Info *, struct smb_hdr *,
45			unsigned int /* length */);
46extern unsigned int _get_xid(void);
47extern void _free_xid(unsigned int);
48#define get_xid()							\
49({									\
50	unsigned int __xid = _get_xid();				\
51	cifs_dbg(FYI, "VFS: in %s as Xid: %u with uid: %d\n",		\
52		 __func__, __xid,					\
53		 from_kuid(&init_user_ns, current_fsuid()));		\
54	trace_smb3_enter(__xid, __func__);				\
55	__xid;								\
56})
57
58#define free_xid(curr_xid)						\
59do {									\
60	_free_xid(curr_xid);						\
61	cifs_dbg(FYI, "VFS: leaving %s (xid = %u) rc = %d\n",		\
62		 __func__, curr_xid, (int)rc);				\
63	if (rc)								\
64		trace_smb3_exit_err(curr_xid, __func__, (int)rc);	\
65	else								\
66		trace_smb3_exit_done(curr_xid, __func__);		\
67} while (0)
68extern int init_cifs_idmap(void);
69extern void exit_cifs_idmap(void);
70extern int init_cifs_spnego(void);
71extern void exit_cifs_spnego(void);
72extern char *build_path_from_dentry(struct dentry *);
73extern char *build_path_from_dentry_optional_prefix(struct dentry *direntry,
74						    bool prefix);
75extern char *cifs_build_path_to_root(struct smb_vol *vol,
76				     struct cifs_sb_info *cifs_sb,
77				     struct cifs_tcon *tcon,
78				     int add_treename);
79extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
80extern char *cifs_compose_mount_options(const char *sb_mountdata,
81		const char *fullpath, const struct dfs_info3_param *ref,
82		char **devname);
83/* extern void renew_parental_timestamps(struct dentry *direntry);*/
84extern struct mid_q_entry *AllocMidQEntry(const struct smb_hdr *smb_buffer,
85					struct TCP_Server_Info *server);
86extern void DeleteMidQEntry(struct mid_q_entry *midEntry);
87extern void cifs_delete_mid(struct mid_q_entry *mid);
88extern void cifs_mid_q_entry_release(struct mid_q_entry *midEntry);
89extern void cifs_wake_up_task(struct mid_q_entry *mid);
90extern int cifs_handle_standard(struct TCP_Server_Info *server,
91				struct mid_q_entry *mid);
92extern bool cifs_match_ipaddr(struct sockaddr *srcaddr, struct sockaddr *rhs);
93extern int cifs_discard_remaining_data(struct TCP_Server_Info *server);
94extern int cifs_call_async(struct TCP_Server_Info *server,
95			struct smb_rqst *rqst,
96			mid_receive_t *receive, mid_callback_t *callback,
97			mid_handle_t *handle, void *cbdata, const int flags,
98			const struct cifs_credits *exist_credits);
99extern struct TCP_Server_Info *cifs_pick_channel(struct cifs_ses *ses);
100extern int cifs_send_recv(const unsigned int xid, struct cifs_ses *ses,
101			  struct TCP_Server_Info *server,
102			  struct smb_rqst *rqst, int *resp_buf_type,
103			  const int flags, struct kvec *resp_iov);
104extern int compound_send_recv(const unsigned int xid, struct cifs_ses *ses,
105			      struct TCP_Server_Info *server,
106			      const int flags, const int num_rqst,
107			      struct smb_rqst *rqst, int *resp_buf_type,
108			      struct kvec *resp_iov);
109extern int SendReceive(const unsigned int /* xid */ , struct cifs_ses *,
110			struct smb_hdr * /* input */ ,
111			struct smb_hdr * /* out */ ,
112			int * /* bytes returned */ , const int);
113extern int SendReceiveNoRsp(const unsigned int xid, struct cifs_ses *ses,
114			    char *in_buf, int flags);
115extern struct mid_q_entry *cifs_setup_request(struct cifs_ses *,
116				struct TCP_Server_Info *,
117				struct smb_rqst *);
118extern struct mid_q_entry *cifs_setup_async_request(struct TCP_Server_Info *,
119						struct smb_rqst *);
120extern int cifs_check_receive(struct mid_q_entry *mid,
121			struct TCP_Server_Info *server, bool log_error);
122extern int cifs_wait_mtu_credits(struct TCP_Server_Info *server,
123				 unsigned int size, unsigned int *num,
124				 struct cifs_credits *credits);
125extern int SendReceive2(const unsigned int /* xid */ , struct cifs_ses *,
126			struct kvec *, int /* nvec to send */,
127			int * /* type of buf returned */, const int flags,
128			struct kvec * /* resp vec */);
129extern int SendReceiveBlockingLock(const unsigned int xid,
130			struct cifs_tcon *ptcon,
131			struct smb_hdr *in_buf ,
132			struct smb_hdr *out_buf,
133			int *bytes_returned);
134extern int cifs_reconnect(struct TCP_Server_Info *server);
135extern int checkSMB(char *buf, unsigned int len, struct TCP_Server_Info *srvr);
136extern bool is_valid_oplock_break(char *, struct TCP_Server_Info *);
137extern bool backup_cred(struct cifs_sb_info *);
138extern bool is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
139extern void cifs_update_eof(struct cifsInodeInfo *cifsi, loff_t offset,
140			    unsigned int bytes_written);
141extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *, int);
142extern int cifs_get_writable_file(struct cifsInodeInfo *cifs_inode,
143				  int flags,
144				  struct cifsFileInfo **ret_file);
145extern int cifs_get_writable_path(struct cifs_tcon *tcon, const char *name,
146				  int flags,
147				  struct cifsFileInfo **ret_file);
148extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *, bool);
149extern int cifs_get_readable_path(struct cifs_tcon *tcon, const char *name,
150				  struct cifsFileInfo **ret_file);
151extern unsigned int smbCalcSize(void *buf, struct TCP_Server_Info *server);
152extern int decode_negTokenInit(unsigned char *security_blob, int length,
153			struct TCP_Server_Info *server);
154extern int cifs_convert_address(struct sockaddr *dst, const char *src, int len);
155extern void cifs_set_port(struct sockaddr *addr, const unsigned short int port);
156extern int map_smb_to_linux_error(char *buf, bool logErr);
157extern int map_and_check_smb_error(struct mid_q_entry *mid, bool logErr);
158extern void header_assemble(struct smb_hdr *, char /* command */ ,
159			    const struct cifs_tcon *, int /* length of
160			    fixed section (word count) in two byte units */);
161extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
162				struct cifs_ses *ses,
163				void **request_buf);
164extern enum securityEnum select_sectype(struct TCP_Server_Info *server,
165				enum securityEnum requested);
166extern int CIFS_SessSetup(const unsigned int xid, struct cifs_ses *ses,
167			  const struct nls_table *nls_cp);
168extern struct timespec64 cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
169extern u64 cifs_UnixTimeToNT(struct timespec64);
170extern struct timespec64 cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
171				      int offset);
172extern void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock);
173extern int cifs_get_writer(struct cifsInodeInfo *cinode);
174extern void cifs_put_writer(struct cifsInodeInfo *cinode);
175extern void cifs_done_oplock_break(struct cifsInodeInfo *cinode);
176extern int cifs_unlock_range(struct cifsFileInfo *cfile,
177			     struct file_lock *flock, const unsigned int xid);
178extern int cifs_push_mandatory_locks(struct cifsFileInfo *cfile);
179
180extern void cifs_down_write(struct rw_semaphore *sem);
181extern struct cifsFileInfo *cifs_new_fileinfo(struct cifs_fid *fid,
182					      struct file *file,
183					      struct tcon_link *tlink,
184					      __u32 oplock);
185extern int cifs_posix_open(char *full_path, struct inode **inode,
186			   struct super_block *sb, int mode,
187			   unsigned int f_flags, __u32 *oplock, __u16 *netfid,
188			   unsigned int xid);
189void cifs_fill_uniqueid(struct super_block *sb, struct cifs_fattr *fattr);
190extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
191				     FILE_UNIX_BASIC_INFO *info,
192				     struct cifs_sb_info *cifs_sb);
193extern void cifs_dir_info_to_fattr(struct cifs_fattr *, FILE_DIRECTORY_INFO *,
194					struct cifs_sb_info *);
195extern void cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
196extern struct inode *cifs_iget(struct super_block *sb,
197			       struct cifs_fattr *fattr);
198
199extern int cifs_get_inode_info(struct inode **inode, const char *full_path,
200			       FILE_ALL_INFO *data, struct super_block *sb,
201			       int xid, const struct cifs_fid *fid);
202extern int smb311_posix_get_inode_info(struct inode **pinode, const char *search_path,
203			struct super_block *sb, unsigned int xid);
204extern int cifs_get_inode_info_unix(struct inode **pinode,
205			const unsigned char *search_path,
206			struct super_block *sb, unsigned int xid);
207extern int cifs_set_file_info(struct inode *inode, struct iattr *attrs,
208			      unsigned int xid, char *full_path, __u32 dosattr);
209extern int cifs_rename_pending_delete(const char *full_path,
210				      struct dentry *dentry,
211				      const unsigned int xid);
212extern int sid_to_id(struct cifs_sb_info *cifs_sb, struct cifs_sid *psid,
213				struct cifs_fattr *fattr, uint sidtype);
214extern int cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
215			      struct cifs_fattr *fattr, struct inode *inode,
216			      bool get_mode_from_special_sid,
217			      const char *path, const struct cifs_fid *pfid);
218extern int id_mode_to_cifs_acl(struct inode *inode, const char *path, __u64,
219					kuid_t, kgid_t);
220extern struct cifs_ntsd *get_cifs_acl(struct cifs_sb_info *, struct inode *,
221					const char *, u32 *);
222extern struct cifs_ntsd *get_cifs_acl_by_fid(struct cifs_sb_info *,
223						const struct cifs_fid *, u32 *);
224extern int set_cifs_acl(struct cifs_ntsd *, __u32, struct inode *,
225				const char *, int);
226extern unsigned int setup_authusers_ACE(struct cifs_ace *pace);
227extern unsigned int setup_special_mode_ACE(struct cifs_ace *pace, __u64 nmode);
228extern unsigned int setup_special_user_owner_ACE(struct cifs_ace *pace);
229
230extern void dequeue_mid(struct mid_q_entry *mid, bool malformed);
231extern int cifs_read_from_socket(struct TCP_Server_Info *server, char *buf,
232			         unsigned int to_read);
233extern ssize_t cifs_discard_from_socket(struct TCP_Server_Info *server,
234					size_t to_read);
235extern int cifs_read_page_from_socket(struct TCP_Server_Info *server,
236					struct page *page,
237					unsigned int page_offset,
238					unsigned int to_read);
239extern int cifs_setup_cifs_sb(struct smb_vol *pvolume_info,
240			       struct cifs_sb_info *cifs_sb);
241extern int cifs_match_super(struct super_block *, void *);
242extern void cifs_cleanup_volume_info(struct smb_vol *pvolume_info);
243extern struct smb_vol *cifs_get_volume_info(char *mount_data,
244					    const char *devname, bool is_smb3);
245extern int cifs_mount(struct cifs_sb_info *cifs_sb, struct smb_vol *vol);
246extern void cifs_umount(struct cifs_sb_info *);
247extern void cifs_mark_open_files_invalid(struct cifs_tcon *tcon);
248extern void cifs_reopen_persistent_handles(struct cifs_tcon *tcon);
249
250extern bool cifs_find_lock_conflict(struct cifsFileInfo *cfile, __u64 offset,
251				    __u64 length, __u8 type, __u16 flags,
252				    struct cifsLockInfo **conf_lock,
253				    int rw_check);
254extern void cifs_add_pending_open(struct cifs_fid *fid,
255				  struct tcon_link *tlink,
256				  struct cifs_pending_open *open);
257extern void cifs_add_pending_open_locked(struct cifs_fid *fid,
258					 struct tcon_link *tlink,
259					 struct cifs_pending_open *open);
260extern void cifs_del_pending_open(struct cifs_pending_open *open);
261extern struct TCP_Server_Info *cifs_get_tcp_session(struct smb_vol *vol);
262extern void cifs_put_tcp_session(struct TCP_Server_Info *server,
263				 int from_reconnect);
264extern void cifs_put_tcon(struct cifs_tcon *tcon);
265
266#if IS_ENABLED(CONFIG_CIFS_DFS_UPCALL)
267extern void cifs_dfs_release_automount_timer(void);
268#else /* ! IS_ENABLED(CONFIG_CIFS_DFS_UPCALL) */
269#define cifs_dfs_release_automount_timer()	do { } while (0)
270#endif /* ! IS_ENABLED(CONFIG_CIFS_DFS_UPCALL) */
271
272void cifs_proc_init(void);
273void cifs_proc_clean(void);
274
275extern void cifs_move_llist(struct list_head *source, struct list_head *dest);
276extern void cifs_free_llist(struct list_head *llist);
277extern void cifs_del_lock_waiters(struct cifsLockInfo *lock);
278
279extern int cifs_tree_connect(const unsigned int xid, struct cifs_tcon *tcon,
280			     const struct nls_table *nlsc);
281
282extern int cifs_negotiate_protocol(const unsigned int xid,
283				   struct cifs_ses *ses);
284extern int cifs_setup_session(const unsigned int xid, struct cifs_ses *ses,
285			      struct nls_table *nls_info);
286extern int cifs_enable_signing(struct TCP_Server_Info *server, bool mnt_sign_required);
287extern int CIFSSMBNegotiate(const unsigned int xid, struct cifs_ses *ses);
288
289extern int CIFSTCon(const unsigned int xid, struct cifs_ses *ses,
290		    const char *tree, struct cifs_tcon *tcon,
291		    const struct nls_table *);
292
293extern int CIFSFindFirst(const unsigned int xid, struct cifs_tcon *tcon,
294		const char *searchName, struct cifs_sb_info *cifs_sb,
295		__u16 *searchHandle, __u16 search_flags,
296		struct cifs_search_info *psrch_inf,
297		bool msearch);
298
299extern int CIFSFindNext(const unsigned int xid, struct cifs_tcon *tcon,
300		__u16 searchHandle, __u16 search_flags,
301		struct cifs_search_info *psrch_inf);
302
303extern int CIFSFindClose(const unsigned int xid, struct cifs_tcon *tcon,
304			const __u16 search_handle);
305
306extern int CIFSSMBQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
307			u16 netfid, FILE_ALL_INFO *pFindData);
308extern int CIFSSMBQPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
309			    const char *search_Name, FILE_ALL_INFO *data,
310			    int legacy /* whether to use old info level */,
311			    const struct nls_table *nls_codepage, int remap);
312extern int SMBQueryInformation(const unsigned int xid, struct cifs_tcon *tcon,
313			       const char *search_name, FILE_ALL_INFO *data,
314			       const struct nls_table *nls_codepage, int remap);
315
316extern int CIFSSMBUnixQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
317			u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
318extern int CIFSSMBUnixQPathInfo(const unsigned int xid,
319			struct cifs_tcon *tcon,
320			const unsigned char *searchName,
321			FILE_UNIX_BASIC_INFO *pFindData,
322			const struct nls_table *nls_codepage, int remap);
323
324extern int CIFSGetDFSRefer(const unsigned int xid, struct cifs_ses *ses,
325			   const char *search_name,
326			   struct dfs_info3_param **target_nodes,
327			   unsigned int *num_of_nodes,
328			   const struct nls_table *nls_codepage, int remap);
329
330extern int parse_dfs_referrals(struct get_dfs_referral_rsp *rsp, u32 rsp_size,
331			       unsigned int *num_of_nodes,
332			       struct dfs_info3_param **target_nodes,
333			       const struct nls_table *nls_codepage, int remap,
334			       const char *searchName, bool is_unicode);
335extern void reset_cifs_unix_caps(unsigned int xid, struct cifs_tcon *tcon,
336				 struct cifs_sb_info *cifs_sb,
337				 struct smb_vol *vol);
338extern int CIFSSMBQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
339			struct kstatfs *FSData);
340extern int SMBOldQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
341			struct kstatfs *FSData);
342extern int CIFSSMBSetFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon,
343			__u64 cap);
344
345extern int CIFSSMBQFSAttributeInfo(const unsigned int xid,
346			struct cifs_tcon *tcon);
347extern int CIFSSMBQFSDeviceInfo(const unsigned int xid, struct cifs_tcon *tcon);
348extern int CIFSSMBQFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon);
349extern int CIFSSMBQFSPosixInfo(const unsigned int xid, struct cifs_tcon *tcon,
350			struct kstatfs *FSData);
351
352extern int CIFSSMBSetPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
353			const char *fileName, const FILE_BASIC_INFO *data,
354			const struct nls_table *nls_codepage,
355			struct cifs_sb_info *cifs_sb);
356extern int CIFSSMBSetFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
357			const FILE_BASIC_INFO *data, __u16 fid,
358			__u32 pid_of_opener);
359extern int CIFSSMBSetFileDisposition(const unsigned int xid,
360				     struct cifs_tcon *tcon,
361				     bool delete_file, __u16 fid,
362				     __u32 pid_of_opener);
363#if 0
364extern int CIFSSMBSetAttrLegacy(unsigned int xid, struct cifs_tcon *tcon,
365			char *fileName, __u16 dos_attributes,
366			const struct nls_table *nls_codepage);
367#endif /* possibly unneeded function */
368extern int CIFSSMBSetEOF(const unsigned int xid, struct cifs_tcon *tcon,
369			 const char *file_name, __u64 size,
370			 struct cifs_sb_info *cifs_sb, bool set_allocation);
371extern int CIFSSMBSetFileSize(const unsigned int xid, struct cifs_tcon *tcon,
372			      struct cifsFileInfo *cfile, __u64 size,
373			      bool set_allocation);
374
375struct cifs_unix_set_info_args {
376	__u64	ctime;
377	__u64	atime;
378	__u64	mtime;
379	__u64	mode;
380	kuid_t	uid;
381	kgid_t	gid;
382	dev_t	device;
383};
384
385extern int CIFSSMBUnixSetFileInfo(const unsigned int xid,
386				  struct cifs_tcon *tcon,
387				  const struct cifs_unix_set_info_args *args,
388				  u16 fid, u32 pid_of_opener);
389
390extern int CIFSSMBUnixSetPathInfo(const unsigned int xid,
391				  struct cifs_tcon *tcon, const char *file_name,
392				  const struct cifs_unix_set_info_args *args,
393				  const struct nls_table *nls_codepage,
394				  int remap);
395
396extern int CIFSSMBMkDir(const unsigned int xid, struct inode *inode,
397			umode_t mode, struct cifs_tcon *tcon,
398			const char *name, struct cifs_sb_info *cifs_sb);
399extern int CIFSSMBRmDir(const unsigned int xid, struct cifs_tcon *tcon,
400			const char *name, struct cifs_sb_info *cifs_sb);
401extern int CIFSPOSIXDelFile(const unsigned int xid, struct cifs_tcon *tcon,
402			const char *name, __u16 type,
403			const struct nls_table *nls_codepage,
404			int remap_special_chars);
405extern int CIFSSMBDelFile(const unsigned int xid, struct cifs_tcon *tcon,
406			  const char *name, struct cifs_sb_info *cifs_sb);
407extern int CIFSSMBRename(const unsigned int xid, struct cifs_tcon *tcon,
408			 const char *from_name, const char *to_name,
409			 struct cifs_sb_info *cifs_sb);
410extern int CIFSSMBRenameOpenFile(const unsigned int xid, struct cifs_tcon *tcon,
411				 int netfid, const char *target_name,
412				 const struct nls_table *nls_codepage,
413				 int remap_special_chars);
414extern int CIFSCreateHardLink(const unsigned int xid, struct cifs_tcon *tcon,
415			      const char *from_name, const char *to_name,
416			      struct cifs_sb_info *cifs_sb);
417extern int CIFSUnixCreateHardLink(const unsigned int xid,
418			struct cifs_tcon *tcon,
419			const char *fromName, const char *toName,
420			const struct nls_table *nls_codepage,
421			int remap_special_chars);
422extern int CIFSUnixCreateSymLink(const unsigned int xid,
423			struct cifs_tcon *tcon,
424			const char *fromName, const char *toName,
425			const struct nls_table *nls_codepage, int remap);
426extern int CIFSSMBUnixQuerySymLink(const unsigned int xid,
427			struct cifs_tcon *tcon,
428			const unsigned char *searchName, char **syminfo,
429			const struct nls_table *nls_codepage, int remap);
430extern int CIFSSMBQuerySymLink(const unsigned int xid, struct cifs_tcon *tcon,
431			       __u16 fid, char **symlinkinfo,
432			       const struct nls_table *nls_codepage);
433extern int CIFSSMB_set_compression(const unsigned int xid,
434				   struct cifs_tcon *tcon, __u16 fid);
435extern int CIFS_open(const unsigned int xid, struct cifs_open_parms *oparms,
436		     int *oplock, FILE_ALL_INFO *buf);
437extern int SMBLegacyOpen(const unsigned int xid, struct cifs_tcon *tcon,
438			const char *fileName, const int disposition,
439			const int access_flags, const int omode,
440			__u16 *netfid, int *pOplock, FILE_ALL_INFO *,
441			const struct nls_table *nls_codepage, int remap);
442extern int CIFSPOSIXCreate(const unsigned int xid, struct cifs_tcon *tcon,
443			u32 posix_flags, __u64 mode, __u16 *netfid,
444			FILE_UNIX_BASIC_INFO *pRetData,
445			__u32 *pOplock, const char *name,
446			const struct nls_table *nls_codepage, int remap);
447extern int CIFSSMBClose(const unsigned int xid, struct cifs_tcon *tcon,
448			const int smb_file_id);
449
450extern int CIFSSMBFlush(const unsigned int xid, struct cifs_tcon *tcon,
451			const int smb_file_id);
452
453extern int CIFSSMBRead(const unsigned int xid, struct cifs_io_parms *io_parms,
454			unsigned int *nbytes, char **buf,
455			int *return_buf_type);
456extern int CIFSSMBWrite(const unsigned int xid, struct cifs_io_parms *io_parms,
457			unsigned int *nbytes, const char *buf);
458extern int CIFSSMBWrite2(const unsigned int xid, struct cifs_io_parms *io_parms,
459			unsigned int *nbytes, struct kvec *iov, const int nvec);
460extern int CIFSGetSrvInodeNumber(const unsigned int xid, struct cifs_tcon *tcon,
461				 const char *search_name, __u64 *inode_number,
462				 const struct nls_table *nls_codepage,
463				 int remap);
464
465extern int cifs_lockv(const unsigned int xid, struct cifs_tcon *tcon,
466		      const __u16 netfid, const __u8 lock_type,
467		      const __u32 num_unlock, const __u32 num_lock,
468		      LOCKING_ANDX_RANGE *buf);
469extern int CIFSSMBLock(const unsigned int xid, struct cifs_tcon *tcon,
470			const __u16 netfid, const __u32 netpid, const __u64 len,
471			const __u64 offset, const __u32 numUnlock,
472			const __u32 numLock, const __u8 lockType,
473			const bool waitFlag, const __u8 oplock_level);
474extern int CIFSSMBPosixLock(const unsigned int xid, struct cifs_tcon *tcon,
475			const __u16 smb_file_id, const __u32 netpid,
476			const loff_t start_offset, const __u64 len,
477			struct file_lock *, const __u16 lock_type,
478			const bool waitFlag);
479extern int CIFSSMBTDis(const unsigned int xid, struct cifs_tcon *tcon);
480extern int CIFSSMBEcho(struct TCP_Server_Info *server);
481extern int CIFSSMBLogoff(const unsigned int xid, struct cifs_ses *ses);
482
483extern struct cifs_ses *sesInfoAlloc(void);
484extern void sesInfoFree(struct cifs_ses *);
485extern struct cifs_tcon *tconInfoAlloc(void);
486extern void tconInfoFree(struct cifs_tcon *);
487
488extern int cifs_sign_rqst(struct smb_rqst *rqst, struct TCP_Server_Info *server,
489		   __u32 *pexpected_response_sequence_number);
490extern int cifs_sign_smbv(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
491			  __u32 *);
492extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
493extern int cifs_verify_signature(struct smb_rqst *rqst,
494				 struct TCP_Server_Info *server,
495				__u32 expected_sequence_number);
496extern int SMBNTencrypt(unsigned char *, unsigned char *, unsigned char *,
497			const struct nls_table *);
498extern int setup_ntlm_response(struct cifs_ses *, const struct nls_table *);
499extern int setup_ntlmv2_rsp(struct cifs_ses *, const struct nls_table *);
500extern void cifs_crypto_secmech_release(struct TCP_Server_Info *server);
501extern int calc_seckey(struct cifs_ses *);
502extern int generate_smb30signingkey(struct cifs_ses *);
503extern int generate_smb311signingkey(struct cifs_ses *);
504
505#ifdef CONFIG_CIFS_WEAK_PW_HASH
506extern int calc_lanman_hash(const char *password, const char *cryptkey,
507				bool encrypt, char *lnm_session_key);
508#endif /* CIFS_WEAK_PW_HASH */
509#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
510extern int CIFSSMBNotify(const unsigned int xid, struct cifs_tcon *tcon,
511			const int notify_subdirs, const __u16 netfid,
512			__u32 filter, struct file *file, int multishot,
513			const struct nls_table *nls_codepage);
514#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
515extern int CIFSSMBCopy(unsigned int xid,
516			struct cifs_tcon *source_tcon,
517			const char *fromName,
518			const __u16 target_tid,
519			const char *toName, const int flags,
520			const struct nls_table *nls_codepage,
521			int remap_special_chars);
522extern ssize_t CIFSSMBQAllEAs(const unsigned int xid, struct cifs_tcon *tcon,
523			const unsigned char *searchName,
524			const unsigned char *ea_name, char *EAData,
525			size_t bufsize, struct cifs_sb_info *cifs_sb);
526extern int CIFSSMBSetEA(const unsigned int xid, struct cifs_tcon *tcon,
527		const char *fileName, const char *ea_name,
528		const void *ea_value, const __u16 ea_value_len,
529		const struct nls_table *nls_codepage,
530		struct cifs_sb_info *cifs_sb);
531extern int CIFSSMBGetCIFSACL(const unsigned int xid, struct cifs_tcon *tcon,
532			__u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
533extern int CIFSSMBSetCIFSACL(const unsigned int, struct cifs_tcon *, __u16,
534			struct cifs_ntsd *, __u32, int);
535extern int CIFSSMBGetPosixACL(const unsigned int xid, struct cifs_tcon *tcon,
536		const unsigned char *searchName,
537		char *acl_inf, const int buflen, const int acl_type,
538		const struct nls_table *nls_codepage, int remap_special_chars);
539extern int CIFSSMBSetPosixACL(const unsigned int xid, struct cifs_tcon *tcon,
540		const unsigned char *fileName,
541		const char *local_acl, const int buflen, const int acl_type,
542		const struct nls_table *nls_codepage, int remap_special_chars);
543extern int CIFSGetExtAttr(const unsigned int xid, struct cifs_tcon *tcon,
544			const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
545extern void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
546extern bool couldbe_mf_symlink(const struct cifs_fattr *fattr);
547extern int check_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
548			      struct cifs_sb_info *cifs_sb,
549			      struct cifs_fattr *fattr,
550			      const unsigned char *path);
551extern int mdfour(unsigned char *, unsigned char *, int);
552extern int E_md4hash(const unsigned char *passwd, unsigned char *p16,
553			const struct nls_table *codepage);
554extern int SMBencrypt(unsigned char *passwd, const unsigned char *c8,
555			unsigned char *p24);
556
557extern int
558cifs_setup_volume_info(struct smb_vol *volume_info, char *mount_data,
559		       const char *devname, bool is_smb3);
560extern void
561cifs_cleanup_volume_info_contents(struct smb_vol *volume_info);
562
563extern struct TCP_Server_Info *
564cifs_find_tcp_session(struct smb_vol *vol);
565
566extern void cifs_put_smb_ses(struct cifs_ses *ses);
567
568extern struct cifs_ses *
569cifs_get_smb_ses(struct TCP_Server_Info *server, struct smb_vol *volume_info);
570
571void cifs_readdata_release(struct kref *refcount);
572int cifs_async_readv(struct cifs_readdata *rdata);
573int cifs_readv_receive(struct TCP_Server_Info *server, struct mid_q_entry *mid);
574
575int cifs_async_writev(struct cifs_writedata *wdata,
576		      void (*release)(struct kref *kref));
577void cifs_writev_complete(struct work_struct *work);
578struct cifs_writedata *cifs_writedata_alloc(unsigned int nr_pages,
579						work_func_t complete);
580struct cifs_writedata *cifs_writedata_direct_alloc(struct page **pages,
581						work_func_t complete);
582void cifs_writedata_release(struct kref *refcount);
583int cifs_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
584			  struct cifs_sb_info *cifs_sb,
585			  const unsigned char *path, char *pbuf,
586			  unsigned int *pbytes_read);
587int cifs_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
588			   struct cifs_sb_info *cifs_sb,
589			   const unsigned char *path, char *pbuf,
590			   unsigned int *pbytes_written);
591int __cifs_calc_signature(struct smb_rqst *rqst,
592			struct TCP_Server_Info *server, char *signature,
593			struct shash_desc *shash);
594enum securityEnum cifs_select_sectype(struct TCP_Server_Info *,
595					enum securityEnum);
596struct cifs_aio_ctx *cifs_aio_ctx_alloc(void);
597void cifs_aio_ctx_release(struct kref *refcount);
598int setup_aio_ctx_iter(struct cifs_aio_ctx *ctx, struct iov_iter *iter, int rw);
599void smb2_cached_lease_break(struct work_struct *work);
600
601int cifs_alloc_hash(const char *name, struct crypto_shash **shash,
602		    struct sdesc **sdesc);
603void cifs_free_hash(struct crypto_shash **shash, struct sdesc **sdesc);
604
605void rqst_page_get_length(const struct smb_rqst *rqst, unsigned int page,
606			  unsigned int *len, unsigned int *offset);
607struct cifs_chan *
608cifs_ses_find_chan(struct cifs_ses *ses, struct TCP_Server_Info *server);
609int cifs_try_adding_channels(struct cifs_ses *ses);
610int cifs_ses_add_channel(struct cifs_ses *ses,
611				struct cifs_server_iface *iface);
612bool is_server_using_iface(struct TCP_Server_Info *server,
613			   struct cifs_server_iface *iface);
614bool is_ses_using_iface(struct cifs_ses *ses, struct cifs_server_iface *iface);
615
616void extract_unc_hostname(const char *unc, const char **h, size_t *len);
617int copy_path_name(char *dst, const char *src);
618int smb2_parse_query_directory(struct cifs_tcon *tcon, struct kvec *rsp_iov,
619			       int resp_buftype,
620			       struct cifs_search_info *srch_inf);
621
622struct super_block *cifs_get_tcp_super(struct TCP_Server_Info *server);
623void cifs_put_tcp_super(struct super_block *sb);
624int update_super_prepath(struct cifs_tcon *tcon, char *prefix);
625
626#ifdef CONFIG_CIFS_DFS_UPCALL
627static inline int get_dfs_path(const unsigned int xid, struct cifs_ses *ses,
628			       const char *old_path,
629			       const struct nls_table *nls_codepage,
630			       struct dfs_info3_param *referral, int remap)
631{
632	return dfs_cache_find(xid, ses, nls_codepage, remap, old_path,
633			      referral, NULL);
634}
635
636int match_target_ip(struct TCP_Server_Info *server,
637		    const char *share, size_t share_len,
638		    bool *result);
639#endif
640
641static inline int cifs_create_options(struct cifs_sb_info *cifs_sb, int options)
642{
643	if (cifs_sb && (backup_cred(cifs_sb)))
644		return options | CREATE_OPEN_BACKUP_INTENT;
645	else
646		return options;
647}
648
649#endif			/* _CIFSPROTO_H */
650