xref: /kernel/linux/linux-6.6/fs/smb/client/cifsproto.h (revision 62306a36)
1/* SPDX-License-Identifier: LGPL-2.1 */
2/*
3 *
4 *   Copyright (c) International Business Machines  Corp., 2002,2008
5 *   Author(s): Steve French (sfrench@us.ibm.com)
6 *
7 */
8#ifndef _CIFSPROTO_H
9#define _CIFSPROTO_H
10#include <linux/nls.h>
11#include <linux/ctype.h>
12#include "trace.h"
13#ifdef CONFIG_CIFS_DFS_UPCALL
14#include "dfs_cache.h"
15#endif
16
17struct statfs;
18struct smb_rqst;
19struct smb3_fs_context;
20
21/*
22 *****************************************************************
23 * All Prototypes
24 *****************************************************************
25 */
26
27extern struct smb_hdr *cifs_buf_get(void);
28extern void cifs_buf_release(void *);
29extern struct smb_hdr *cifs_small_buf_get(void);
30extern void cifs_small_buf_release(void *);
31extern void free_rsp_buf(int, void *);
32extern int smb_send(struct TCP_Server_Info *, struct smb_hdr *,
33			unsigned int /* length */);
34extern unsigned int _get_xid(void);
35extern void _free_xid(unsigned int);
36#define get_xid()							\
37({									\
38	unsigned int __xid = _get_xid();				\
39	cifs_dbg(FYI, "VFS: in %s as Xid: %u with uid: %d\n",		\
40		 __func__, __xid,					\
41		 from_kuid(&init_user_ns, current_fsuid()));		\
42	trace_smb3_enter(__xid, __func__);				\
43	__xid;								\
44})
45
46#define free_xid(curr_xid)						\
47do {									\
48	_free_xid(curr_xid);						\
49	cifs_dbg(FYI, "VFS: leaving %s (xid = %u) rc = %d\n",		\
50		 __func__, curr_xid, (int)rc);				\
51	if (rc)								\
52		trace_smb3_exit_err(curr_xid, __func__, (int)rc);	\
53	else								\
54		trace_smb3_exit_done(curr_xid, __func__);		\
55} while (0)
56extern int init_cifs_idmap(void);
57extern void exit_cifs_idmap(void);
58extern int init_cifs_spnego(void);
59extern void exit_cifs_spnego(void);
60extern const char *build_path_from_dentry(struct dentry *, void *);
61char *__build_path_from_dentry_optional_prefix(struct dentry *direntry, void *page,
62					       const char *tree, int tree_len,
63					       bool prefix);
64extern char *build_path_from_dentry_optional_prefix(struct dentry *direntry,
65						    void *page, bool prefix);
66static inline void *alloc_dentry_path(void)
67{
68	return __getname();
69}
70
71static inline void free_dentry_path(void *page)
72{
73	if (page)
74		__putname(page);
75}
76
77extern char *cifs_build_path_to_root(struct smb3_fs_context *ctx,
78				     struct cifs_sb_info *cifs_sb,
79				     struct cifs_tcon *tcon,
80				     int add_treename);
81extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
82char *cifs_build_devname(char *nodename, const char *prepath);
83extern void delete_mid(struct mid_q_entry *mid);
84void __release_mid(struct kref *refcount);
85extern void cifs_wake_up_task(struct mid_q_entry *mid);
86extern int cifs_handle_standard(struct TCP_Server_Info *server,
87				struct mid_q_entry *mid);
88extern char *smb3_fs_context_fullpath(const struct smb3_fs_context *ctx,
89				      char dirsep);
90extern int smb3_parse_devname(const char *devname, struct smb3_fs_context *ctx);
91extern int smb3_parse_opt(const char *options, const char *key, char **val);
92extern int cifs_ipaddr_cmp(struct sockaddr *srcaddr, struct sockaddr *rhs);
93extern bool cifs_match_ipaddr(struct sockaddr *srcaddr, struct sockaddr *rhs);
94extern int cifs_discard_remaining_data(struct TCP_Server_Info *server);
95extern int cifs_call_async(struct TCP_Server_Info *server,
96			struct smb_rqst *rqst,
97			mid_receive_t *receive, mid_callback_t *callback,
98			mid_handle_t *handle, void *cbdata, const int flags,
99			const struct cifs_credits *exist_credits);
100extern struct TCP_Server_Info *cifs_pick_channel(struct cifs_ses *ses);
101extern int cifs_send_recv(const unsigned int xid, struct cifs_ses *ses,
102			  struct TCP_Server_Info *server,
103			  struct smb_rqst *rqst, int *resp_buf_type,
104			  const int flags, struct kvec *resp_iov);
105extern int compound_send_recv(const unsigned int xid, struct cifs_ses *ses,
106			      struct TCP_Server_Info *server,
107			      const int flags, const int num_rqst,
108			      struct smb_rqst *rqst, int *resp_buf_type,
109			      struct kvec *resp_iov);
110extern int SendReceive(const unsigned int /* xid */ , struct cifs_ses *,
111			struct smb_hdr * /* input */ ,
112			struct smb_hdr * /* out */ ,
113			int * /* bytes returned */ , const int);
114extern int SendReceiveNoRsp(const unsigned int xid, struct cifs_ses *ses,
115			    char *in_buf, int flags);
116extern struct mid_q_entry *cifs_setup_request(struct cifs_ses *,
117				struct TCP_Server_Info *,
118				struct smb_rqst *);
119extern struct mid_q_entry *cifs_setup_async_request(struct TCP_Server_Info *,
120						struct smb_rqst *);
121extern int cifs_check_receive(struct mid_q_entry *mid,
122			struct TCP_Server_Info *server, bool log_error);
123extern int cifs_wait_mtu_credits(struct TCP_Server_Info *server,
124				 unsigned int size, unsigned int *num,
125				 struct cifs_credits *credits);
126extern int SendReceive2(const unsigned int /* xid */ , struct cifs_ses *,
127			struct kvec *, int /* nvec to send */,
128			int * /* type of buf returned */, const int flags,
129			struct kvec * /* resp vec */);
130extern int SendReceiveBlockingLock(const unsigned int xid,
131			struct cifs_tcon *ptcon,
132			struct smb_hdr *in_buf,
133			struct smb_hdr *out_buf,
134			int *bytes_returned);
135
136void
137cifs_signal_cifsd_for_reconnect(struct TCP_Server_Info *server,
138				      bool all_channels);
139void
140cifs_mark_tcp_ses_conns_for_reconnect(struct TCP_Server_Info *server,
141				      bool mark_smb_session);
142extern int cifs_reconnect(struct TCP_Server_Info *server,
143			  bool mark_smb_session);
144extern int checkSMB(char *buf, unsigned int len, struct TCP_Server_Info *srvr);
145extern bool is_valid_oplock_break(char *, struct TCP_Server_Info *);
146extern bool backup_cred(struct cifs_sb_info *);
147extern bool is_size_safe_to_change(struct cifsInodeInfo *cifsInode, __u64 eof,
148				   bool from_readdir);
149extern void cifs_update_eof(struct cifsInodeInfo *cifsi, loff_t offset,
150			    unsigned int bytes_written);
151extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *, int);
152extern int cifs_get_writable_file(struct cifsInodeInfo *cifs_inode,
153				  int flags,
154				  struct cifsFileInfo **ret_file);
155extern int cifs_get_writable_path(struct cifs_tcon *tcon, const char *name,
156				  int flags,
157				  struct cifsFileInfo **ret_file);
158extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *, bool);
159extern int cifs_get_readable_path(struct cifs_tcon *tcon, const char *name,
160				  struct cifsFileInfo **ret_file);
161extern unsigned int smbCalcSize(void *buf);
162extern int decode_negTokenInit(unsigned char *security_blob, int length,
163			struct TCP_Server_Info *server);
164extern int cifs_convert_address(struct sockaddr *dst, const char *src, int len);
165extern void cifs_set_port(struct sockaddr *addr, const unsigned short int port);
166extern int map_smb_to_linux_error(char *buf, bool logErr);
167extern int map_and_check_smb_error(struct mid_q_entry *mid, bool logErr);
168extern void header_assemble(struct smb_hdr *, char /* command */ ,
169			    const struct cifs_tcon *, int /* length of
170			    fixed section (word count) in two byte units */);
171extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
172				struct cifs_ses *ses,
173				void **request_buf);
174extern enum securityEnum select_sectype(struct TCP_Server_Info *server,
175				enum securityEnum requested);
176extern int CIFS_SessSetup(const unsigned int xid, struct cifs_ses *ses,
177			  struct TCP_Server_Info *server,
178			  const struct nls_table *nls_cp);
179extern struct timespec64 cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
180extern u64 cifs_UnixTimeToNT(struct timespec64);
181extern struct timespec64 cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
182				      int offset);
183extern void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock);
184extern int cifs_get_writer(struct cifsInodeInfo *cinode);
185extern void cifs_put_writer(struct cifsInodeInfo *cinode);
186extern void cifs_done_oplock_break(struct cifsInodeInfo *cinode);
187extern int cifs_unlock_range(struct cifsFileInfo *cfile,
188			     struct file_lock *flock, const unsigned int xid);
189extern int cifs_push_mandatory_locks(struct cifsFileInfo *cfile);
190
191extern void cifs_down_write(struct rw_semaphore *sem);
192struct cifsFileInfo *cifs_new_fileinfo(struct cifs_fid *fid, struct file *file,
193				       struct tcon_link *tlink, __u32 oplock,
194				       const char *symlink_target);
195extern int cifs_posix_open(const char *full_path, struct inode **inode,
196			   struct super_block *sb, int mode,
197			   unsigned int f_flags, __u32 *oplock, __u16 *netfid,
198			   unsigned int xid);
199void cifs_fill_uniqueid(struct super_block *sb, struct cifs_fattr *fattr);
200extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
201				     FILE_UNIX_BASIC_INFO *info,
202				     struct cifs_sb_info *cifs_sb);
203extern void cifs_dir_info_to_fattr(struct cifs_fattr *, FILE_DIRECTORY_INFO *,
204					struct cifs_sb_info *);
205extern int cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr,
206			       bool from_readdir);
207extern struct inode *cifs_iget(struct super_block *sb,
208			       struct cifs_fattr *fattr);
209
210int cifs_get_inode_info(struct inode **inode, const char *full_path,
211			struct cifs_open_info_data *data, struct super_block *sb, int xid,
212			const struct cifs_fid *fid);
213bool cifs_reparse_point_to_fattr(struct cifs_sb_info *cifs_sb,
214				 struct cifs_fattr *fattr,
215				 struct cifs_open_info_data *data);
216extern int smb311_posix_get_inode_info(struct inode **pinode, const char *search_path,
217			struct super_block *sb, unsigned int xid);
218extern int cifs_get_inode_info_unix(struct inode **pinode,
219			const unsigned char *search_path,
220			struct super_block *sb, unsigned int xid);
221extern int cifs_set_file_info(struct inode *inode, struct iattr *attrs,
222			      unsigned int xid, const char *full_path, __u32 dosattr);
223extern int cifs_rename_pending_delete(const char *full_path,
224				      struct dentry *dentry,
225				      const unsigned int xid);
226extern int sid_to_id(struct cifs_sb_info *cifs_sb, struct cifs_sid *psid,
227				struct cifs_fattr *fattr, uint sidtype);
228extern int cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
229			      struct cifs_fattr *fattr, struct inode *inode,
230			      bool get_mode_from_special_sid,
231			      const char *path, const struct cifs_fid *pfid);
232extern int id_mode_to_cifs_acl(struct inode *inode, const char *path, __u64 *pnmode,
233					kuid_t uid, kgid_t gid);
234extern struct cifs_ntsd *get_cifs_acl(struct cifs_sb_info *, struct inode *,
235				      const char *, u32 *, u32);
236extern struct cifs_ntsd *get_cifs_acl_by_fid(struct cifs_sb_info *,
237				const struct cifs_fid *, u32 *, u32);
238extern struct posix_acl *cifs_get_acl(struct mnt_idmap *idmap,
239				      struct dentry *dentry, int type);
240extern int cifs_set_acl(struct mnt_idmap *idmap,
241			struct dentry *dentry, struct posix_acl *acl, int type);
242extern int set_cifs_acl(struct cifs_ntsd *, __u32, struct inode *,
243				const char *, int);
244extern unsigned int setup_authusers_ACE(struct cifs_ace *pace);
245extern unsigned int setup_special_mode_ACE(struct cifs_ace *pace, __u64 nmode);
246extern unsigned int setup_special_user_owner_ACE(struct cifs_ace *pace);
247
248extern void dequeue_mid(struct mid_q_entry *mid, bool malformed);
249extern int cifs_read_from_socket(struct TCP_Server_Info *server, char *buf,
250			         unsigned int to_read);
251extern ssize_t cifs_discard_from_socket(struct TCP_Server_Info *server,
252					size_t to_read);
253extern int cifs_read_page_from_socket(struct TCP_Server_Info *server,
254					struct page *page,
255					unsigned int page_offset,
256					unsigned int to_read);
257int cifs_read_iter_from_socket(struct TCP_Server_Info *server,
258			       struct iov_iter *iter,
259			       unsigned int to_read);
260extern int cifs_setup_cifs_sb(struct cifs_sb_info *cifs_sb);
261void cifs_mount_put_conns(struct cifs_mount_ctx *mnt_ctx);
262int cifs_mount_get_session(struct cifs_mount_ctx *mnt_ctx);
263int cifs_is_path_remote(struct cifs_mount_ctx *mnt_ctx);
264int cifs_mount_get_tcon(struct cifs_mount_ctx *mnt_ctx);
265extern int cifs_match_super(struct super_block *, void *);
266extern int cifs_mount(struct cifs_sb_info *cifs_sb, struct smb3_fs_context *ctx);
267extern void cifs_umount(struct cifs_sb_info *);
268extern void cifs_mark_open_files_invalid(struct cifs_tcon *tcon);
269extern void cifs_reopen_persistent_handles(struct cifs_tcon *tcon);
270
271extern bool cifs_find_lock_conflict(struct cifsFileInfo *cfile, __u64 offset,
272				    __u64 length, __u8 type, __u16 flags,
273				    struct cifsLockInfo **conf_lock,
274				    int rw_check);
275extern void cifs_add_pending_open(struct cifs_fid *fid,
276				  struct tcon_link *tlink,
277				  struct cifs_pending_open *open);
278extern void cifs_add_pending_open_locked(struct cifs_fid *fid,
279					 struct tcon_link *tlink,
280					 struct cifs_pending_open *open);
281extern void cifs_del_pending_open(struct cifs_pending_open *open);
282
283extern bool cifs_is_deferred_close(struct cifsFileInfo *cfile,
284				struct cifs_deferred_close **dclose);
285
286extern void cifs_add_deferred_close(struct cifsFileInfo *cfile,
287				struct cifs_deferred_close *dclose);
288
289extern void cifs_del_deferred_close(struct cifsFileInfo *cfile);
290
291extern void cifs_close_deferred_file(struct cifsInodeInfo *cifs_inode);
292
293extern void cifs_close_all_deferred_files(struct cifs_tcon *cifs_tcon);
294
295extern void cifs_close_deferred_file_under_dentry(struct cifs_tcon *cifs_tcon,
296				const char *path);
297extern struct TCP_Server_Info *
298cifs_get_tcp_session(struct smb3_fs_context *ctx,
299		     struct TCP_Server_Info *primary_server);
300extern void cifs_put_tcp_session(struct TCP_Server_Info *server,
301				 int from_reconnect);
302extern void cifs_put_tcon(struct cifs_tcon *tcon);
303
304extern void cifs_release_automount_timer(void);
305
306void cifs_proc_init(void);
307void cifs_proc_clean(void);
308
309extern void cifs_move_llist(struct list_head *source, struct list_head *dest);
310extern void cifs_free_llist(struct list_head *llist);
311extern void cifs_del_lock_waiters(struct cifsLockInfo *lock);
312
313extern int cifs_tree_connect(const unsigned int xid, struct cifs_tcon *tcon,
314			     const struct nls_table *nlsc);
315
316extern int cifs_negotiate_protocol(const unsigned int xid,
317				   struct cifs_ses *ses,
318				   struct TCP_Server_Info *server);
319extern int cifs_setup_session(const unsigned int xid, struct cifs_ses *ses,
320			      struct TCP_Server_Info *server,
321			      struct nls_table *nls_info);
322extern int cifs_enable_signing(struct TCP_Server_Info *server, bool mnt_sign_required);
323extern int CIFSSMBNegotiate(const unsigned int xid,
324			    struct cifs_ses *ses,
325			    struct TCP_Server_Info *server);
326
327extern int CIFSTCon(const unsigned int xid, struct cifs_ses *ses,
328		    const char *tree, struct cifs_tcon *tcon,
329		    const struct nls_table *);
330
331extern int CIFSFindFirst(const unsigned int xid, struct cifs_tcon *tcon,
332		const char *searchName, struct cifs_sb_info *cifs_sb,
333		__u16 *searchHandle, __u16 search_flags,
334		struct cifs_search_info *psrch_inf,
335		bool msearch);
336
337extern int CIFSFindNext(const unsigned int xid, struct cifs_tcon *tcon,
338		__u16 searchHandle, __u16 search_flags,
339		struct cifs_search_info *psrch_inf);
340
341extern int CIFSFindClose(const unsigned int xid, struct cifs_tcon *tcon,
342			const __u16 search_handle);
343
344extern int CIFSSMBQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
345			u16 netfid, FILE_ALL_INFO *pFindData);
346extern int CIFSSMBQPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
347			    const char *search_Name, FILE_ALL_INFO *data,
348			    int legacy /* whether to use old info level */,
349			    const struct nls_table *nls_codepage, int remap);
350extern int SMBQueryInformation(const unsigned int xid, struct cifs_tcon *tcon,
351			       const char *search_name, FILE_ALL_INFO *data,
352			       const struct nls_table *nls_codepage, int remap);
353
354extern int CIFSSMBUnixQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
355			u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
356extern int CIFSSMBUnixQPathInfo(const unsigned int xid,
357			struct cifs_tcon *tcon,
358			const unsigned char *searchName,
359			FILE_UNIX_BASIC_INFO *pFindData,
360			const struct nls_table *nls_codepage, int remap);
361
362extern int CIFSGetDFSRefer(const unsigned int xid, struct cifs_ses *ses,
363			   const char *search_name,
364			   struct dfs_info3_param **target_nodes,
365			   unsigned int *num_of_nodes,
366			   const struct nls_table *nls_codepage, int remap);
367
368extern int parse_dfs_referrals(struct get_dfs_referral_rsp *rsp, u32 rsp_size,
369			       unsigned int *num_of_nodes,
370			       struct dfs_info3_param **target_nodes,
371			       const struct nls_table *nls_codepage, int remap,
372			       const char *searchName, bool is_unicode);
373extern void reset_cifs_unix_caps(unsigned int xid, struct cifs_tcon *tcon,
374				 struct cifs_sb_info *cifs_sb,
375				 struct smb3_fs_context *ctx);
376extern int CIFSSMBQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
377			struct kstatfs *FSData);
378extern int SMBOldQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
379			struct kstatfs *FSData);
380extern int CIFSSMBSetFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon,
381			__u64 cap);
382
383extern int CIFSSMBQFSAttributeInfo(const unsigned int xid,
384			struct cifs_tcon *tcon);
385extern int CIFSSMBQFSDeviceInfo(const unsigned int xid, struct cifs_tcon *tcon);
386extern int CIFSSMBQFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon);
387extern int CIFSSMBQFSPosixInfo(const unsigned int xid, struct cifs_tcon *tcon,
388			struct kstatfs *FSData);
389
390extern int CIFSSMBSetPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
391			const char *fileName, const FILE_BASIC_INFO *data,
392			const struct nls_table *nls_codepage,
393			struct cifs_sb_info *cifs_sb);
394extern int CIFSSMBSetFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
395			const FILE_BASIC_INFO *data, __u16 fid,
396			__u32 pid_of_opener);
397extern int CIFSSMBSetFileDisposition(const unsigned int xid,
398				     struct cifs_tcon *tcon,
399				     bool delete_file, __u16 fid,
400				     __u32 pid_of_opener);
401extern int CIFSSMBSetEOF(const unsigned int xid, struct cifs_tcon *tcon,
402			 const char *file_name, __u64 size,
403			 struct cifs_sb_info *cifs_sb, bool set_allocation);
404extern int CIFSSMBSetFileSize(const unsigned int xid, struct cifs_tcon *tcon,
405			      struct cifsFileInfo *cfile, __u64 size,
406			      bool set_allocation);
407
408struct cifs_unix_set_info_args {
409	__u64	ctime;
410	__u64	atime;
411	__u64	mtime;
412	__u64	mode;
413	kuid_t	uid;
414	kgid_t	gid;
415	dev_t	device;
416};
417
418extern int CIFSSMBUnixSetFileInfo(const unsigned int xid,
419				  struct cifs_tcon *tcon,
420				  const struct cifs_unix_set_info_args *args,
421				  u16 fid, u32 pid_of_opener);
422
423extern int CIFSSMBUnixSetPathInfo(const unsigned int xid,
424				  struct cifs_tcon *tcon, const char *file_name,
425				  const struct cifs_unix_set_info_args *args,
426				  const struct nls_table *nls_codepage,
427				  int remap);
428
429extern int CIFSSMBMkDir(const unsigned int xid, struct inode *inode,
430			umode_t mode, struct cifs_tcon *tcon,
431			const char *name, struct cifs_sb_info *cifs_sb);
432extern int CIFSSMBRmDir(const unsigned int xid, struct cifs_tcon *tcon,
433			const char *name, struct cifs_sb_info *cifs_sb);
434extern int CIFSPOSIXDelFile(const unsigned int xid, struct cifs_tcon *tcon,
435			const char *name, __u16 type,
436			const struct nls_table *nls_codepage,
437			int remap_special_chars);
438extern int CIFSSMBDelFile(const unsigned int xid, struct cifs_tcon *tcon,
439			  const char *name, struct cifs_sb_info *cifs_sb);
440int CIFSSMBRename(const unsigned int xid, struct cifs_tcon *tcon,
441		  struct dentry *source_dentry,
442		  const char *from_name, const char *to_name,
443		  struct cifs_sb_info *cifs_sb);
444extern int CIFSSMBRenameOpenFile(const unsigned int xid, struct cifs_tcon *tcon,
445				 int netfid, const char *target_name,
446				 const struct nls_table *nls_codepage,
447				 int remap_special_chars);
448int CIFSCreateHardLink(const unsigned int xid,
449		       struct cifs_tcon *tcon,
450		       struct dentry *source_dentry,
451		       const char *from_name, const char *to_name,
452		       struct cifs_sb_info *cifs_sb);
453extern int CIFSUnixCreateHardLink(const unsigned int xid,
454			struct cifs_tcon *tcon,
455			const char *fromName, const char *toName,
456			const struct nls_table *nls_codepage,
457			int remap_special_chars);
458extern int CIFSUnixCreateSymLink(const unsigned int xid,
459			struct cifs_tcon *tcon,
460			const char *fromName, const char *toName,
461			const struct nls_table *nls_codepage, int remap);
462extern int CIFSSMBUnixQuerySymLink(const unsigned int xid,
463			struct cifs_tcon *tcon,
464			const unsigned char *searchName, char **syminfo,
465			const struct nls_table *nls_codepage, int remap);
466extern int cifs_query_reparse_point(const unsigned int xid,
467				    struct cifs_tcon *tcon,
468				    struct cifs_sb_info *cifs_sb,
469				    const char *full_path,
470				    u32 *tag, struct kvec *rsp,
471				    int *rsp_buftype);
472extern int CIFSSMBQuerySymLink(const unsigned int xid, struct cifs_tcon *tcon,
473			       __u16 fid, char **symlinkinfo,
474			       const struct nls_table *nls_codepage);
475extern int CIFSSMB_set_compression(const unsigned int xid,
476				   struct cifs_tcon *tcon, __u16 fid);
477extern int CIFS_open(const unsigned int xid, struct cifs_open_parms *oparms,
478		     int *oplock, FILE_ALL_INFO *buf);
479extern int SMBLegacyOpen(const unsigned int xid, struct cifs_tcon *tcon,
480			const char *fileName, const int disposition,
481			const int access_flags, const int omode,
482			__u16 *netfid, int *pOplock, FILE_ALL_INFO *,
483			const struct nls_table *nls_codepage, int remap);
484extern int CIFSPOSIXCreate(const unsigned int xid, struct cifs_tcon *tcon,
485			u32 posix_flags, __u64 mode, __u16 *netfid,
486			FILE_UNIX_BASIC_INFO *pRetData,
487			__u32 *pOplock, const char *name,
488			const struct nls_table *nls_codepage, int remap);
489extern int CIFSSMBClose(const unsigned int xid, struct cifs_tcon *tcon,
490			const int smb_file_id);
491
492extern int CIFSSMBFlush(const unsigned int xid, struct cifs_tcon *tcon,
493			const int smb_file_id);
494
495extern int CIFSSMBRead(const unsigned int xid, struct cifs_io_parms *io_parms,
496			unsigned int *nbytes, char **buf,
497			int *return_buf_type);
498extern int CIFSSMBWrite(const unsigned int xid, struct cifs_io_parms *io_parms,
499			unsigned int *nbytes, const char *buf);
500extern int CIFSSMBWrite2(const unsigned int xid, struct cifs_io_parms *io_parms,
501			unsigned int *nbytes, struct kvec *iov, const int nvec);
502extern int CIFSGetSrvInodeNumber(const unsigned int xid, struct cifs_tcon *tcon,
503				 const char *search_name, __u64 *inode_number,
504				 const struct nls_table *nls_codepage,
505				 int remap);
506
507extern int cifs_lockv(const unsigned int xid, struct cifs_tcon *tcon,
508		      const __u16 netfid, const __u8 lock_type,
509		      const __u32 num_unlock, const __u32 num_lock,
510		      LOCKING_ANDX_RANGE *buf);
511extern int CIFSSMBLock(const unsigned int xid, struct cifs_tcon *tcon,
512			const __u16 netfid, const __u32 netpid, const __u64 len,
513			const __u64 offset, const __u32 numUnlock,
514			const __u32 numLock, const __u8 lockType,
515			const bool waitFlag, const __u8 oplock_level);
516extern int CIFSSMBPosixLock(const unsigned int xid, struct cifs_tcon *tcon,
517			const __u16 smb_file_id, const __u32 netpid,
518			const loff_t start_offset, const __u64 len,
519			struct file_lock *, const __u16 lock_type,
520			const bool waitFlag);
521extern int CIFSSMBTDis(const unsigned int xid, struct cifs_tcon *tcon);
522extern int CIFSSMBEcho(struct TCP_Server_Info *server);
523extern int CIFSSMBLogoff(const unsigned int xid, struct cifs_ses *ses);
524
525extern struct cifs_ses *sesInfoAlloc(void);
526extern void sesInfoFree(struct cifs_ses *);
527extern struct cifs_tcon *tcon_info_alloc(bool dir_leases_enabled);
528extern void tconInfoFree(struct cifs_tcon *);
529
530extern int cifs_sign_rqst(struct smb_rqst *rqst, struct TCP_Server_Info *server,
531		   __u32 *pexpected_response_sequence_number);
532extern int cifs_sign_smbv(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
533			  __u32 *);
534extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
535extern int cifs_verify_signature(struct smb_rqst *rqst,
536				 struct TCP_Server_Info *server,
537				__u32 expected_sequence_number);
538extern int setup_ntlmv2_rsp(struct cifs_ses *, const struct nls_table *);
539extern void cifs_crypto_secmech_release(struct TCP_Server_Info *server);
540extern int calc_seckey(struct cifs_ses *);
541extern int generate_smb30signingkey(struct cifs_ses *ses,
542				    struct TCP_Server_Info *server);
543extern int generate_smb311signingkey(struct cifs_ses *ses,
544				     struct TCP_Server_Info *server);
545
546#ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
547extern int CIFSSMBCopy(unsigned int xid,
548			struct cifs_tcon *source_tcon,
549			const char *fromName,
550			const __u16 target_tid,
551			const char *toName, const int flags,
552			const struct nls_table *nls_codepage,
553			int remap_special_chars);
554extern ssize_t CIFSSMBQAllEAs(const unsigned int xid, struct cifs_tcon *tcon,
555			const unsigned char *searchName,
556			const unsigned char *ea_name, char *EAData,
557			size_t bufsize, struct cifs_sb_info *cifs_sb);
558extern int CIFSSMBSetEA(const unsigned int xid, struct cifs_tcon *tcon,
559		const char *fileName, const char *ea_name,
560		const void *ea_value, const __u16 ea_value_len,
561		const struct nls_table *nls_codepage,
562		struct cifs_sb_info *cifs_sb);
563extern int CIFSSMBGetCIFSACL(const unsigned int xid, struct cifs_tcon *tcon,
564			__u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
565extern int CIFSSMBSetCIFSACL(const unsigned int, struct cifs_tcon *, __u16,
566			struct cifs_ntsd *, __u32, int);
567extern int cifs_do_get_acl(const unsigned int xid, struct cifs_tcon *tcon,
568			   const unsigned char *searchName,
569			   struct posix_acl **acl, const int acl_type,
570			   const struct nls_table *nls_codepage, int remap);
571extern int cifs_do_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
572			   const unsigned char *fileName,
573			   const struct posix_acl *acl, const int acl_type,
574			   const struct nls_table *nls_codepage, int remap);
575extern int CIFSGetExtAttr(const unsigned int xid, struct cifs_tcon *tcon,
576			const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
577#endif /* CIFS_ALLOW_INSECURE_LEGACY */
578extern void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
579extern bool couldbe_mf_symlink(const struct cifs_fattr *fattr);
580extern int check_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
581			      struct cifs_sb_info *cifs_sb,
582			      struct cifs_fattr *fattr,
583			      const unsigned char *path);
584extern int E_md4hash(const unsigned char *passwd, unsigned char *p16,
585			const struct nls_table *codepage);
586
587extern struct TCP_Server_Info *
588cifs_find_tcp_session(struct smb3_fs_context *ctx);
589
590void __cifs_put_smb_ses(struct cifs_ses *ses);
591
592extern struct cifs_ses *
593cifs_get_smb_ses(struct TCP_Server_Info *server, struct smb3_fs_context *ctx);
594
595void cifs_readdata_release(struct kref *refcount);
596int cifs_async_readv(struct cifs_readdata *rdata);
597int cifs_readv_receive(struct TCP_Server_Info *server, struct mid_q_entry *mid);
598
599int cifs_async_writev(struct cifs_writedata *wdata,
600		      void (*release)(struct kref *kref));
601void cifs_writev_complete(struct work_struct *work);
602struct cifs_writedata *cifs_writedata_alloc(work_func_t complete);
603void cifs_writedata_release(struct kref *refcount);
604int cifs_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
605			  struct cifs_sb_info *cifs_sb,
606			  const unsigned char *path, char *pbuf,
607			  unsigned int *pbytes_read);
608int cifs_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
609			   struct cifs_sb_info *cifs_sb,
610			   const unsigned char *path, char *pbuf,
611			   unsigned int *pbytes_written);
612int __cifs_calc_signature(struct smb_rqst *rqst,
613			struct TCP_Server_Info *server, char *signature,
614			struct shash_desc *shash);
615enum securityEnum cifs_select_sectype(struct TCP_Server_Info *,
616					enum securityEnum);
617struct cifs_aio_ctx *cifs_aio_ctx_alloc(void);
618void cifs_aio_ctx_release(struct kref *refcount);
619
620int cifs_alloc_hash(const char *name, struct shash_desc **sdesc);
621void cifs_free_hash(struct shash_desc **sdesc);
622
623struct cifs_chan *
624cifs_ses_find_chan(struct cifs_ses *ses, struct TCP_Server_Info *server);
625int cifs_try_adding_channels(struct cifs_ses *ses);
626bool is_server_using_iface(struct TCP_Server_Info *server,
627			   struct cifs_server_iface *iface);
628bool is_ses_using_iface(struct cifs_ses *ses, struct cifs_server_iface *iface);
629void cifs_ses_mark_for_reconnect(struct cifs_ses *ses);
630
631int
632cifs_ses_get_chan_index(struct cifs_ses *ses,
633			struct TCP_Server_Info *server);
634void
635cifs_chan_set_in_reconnect(struct cifs_ses *ses,
636			     struct TCP_Server_Info *server);
637void
638cifs_chan_clear_in_reconnect(struct cifs_ses *ses,
639			       struct TCP_Server_Info *server);
640bool
641cifs_chan_in_reconnect(struct cifs_ses *ses,
642			  struct TCP_Server_Info *server);
643void
644cifs_chan_set_need_reconnect(struct cifs_ses *ses,
645			     struct TCP_Server_Info *server);
646void
647cifs_chan_clear_need_reconnect(struct cifs_ses *ses,
648			       struct TCP_Server_Info *server);
649bool
650cifs_chan_needs_reconnect(struct cifs_ses *ses,
651			  struct TCP_Server_Info *server);
652bool
653cifs_chan_is_iface_active(struct cifs_ses *ses,
654			  struct TCP_Server_Info *server);
655void
656cifs_disable_secondary_channels(struct cifs_ses *ses);
657int
658cifs_chan_update_iface(struct cifs_ses *ses, struct TCP_Server_Info *server);
659int
660SMB3_request_interfaces(const unsigned int xid, struct cifs_tcon *tcon, bool in_mount);
661
662void extract_unc_hostname(const char *unc, const char **h, size_t *len);
663int copy_path_name(char *dst, const char *src);
664int smb2_parse_query_directory(struct cifs_tcon *tcon, struct kvec *rsp_iov,
665			       int resp_buftype,
666			       struct cifs_search_info *srch_inf);
667
668struct super_block *cifs_get_dfs_tcon_super(struct cifs_tcon *tcon);
669void cifs_put_tcp_super(struct super_block *sb);
670int cifs_update_super_prepath(struct cifs_sb_info *cifs_sb, char *prefix);
671char *extract_hostname(const char *unc);
672char *extract_sharename(const char *unc);
673int parse_reparse_point(struct reparse_data_buffer *buf,
674			u32 plen, struct cifs_sb_info *cifs_sb,
675			bool unicode, struct cifs_open_info_data *data);
676
677#ifdef CONFIG_CIFS_DFS_UPCALL
678static inline int get_dfs_path(const unsigned int xid, struct cifs_ses *ses,
679			       const char *old_path,
680			       const struct nls_table *nls_codepage,
681			       struct dfs_info3_param *referral, int remap)
682{
683	return dfs_cache_find(xid, ses, nls_codepage, remap, old_path,
684			      referral, NULL);
685}
686
687int match_target_ip(struct TCP_Server_Info *server,
688		    const char *share, size_t share_len,
689		    bool *result);
690int cifs_inval_name_dfs_link_error(const unsigned int xid,
691				   struct cifs_tcon *tcon,
692				   struct cifs_sb_info *cifs_sb,
693				   const char *full_path,
694				   bool *islink);
695#else
696static inline int cifs_inval_name_dfs_link_error(const unsigned int xid,
697				   struct cifs_tcon *tcon,
698				   struct cifs_sb_info *cifs_sb,
699				   const char *full_path,
700				   bool *islink)
701{
702	*islink = false;
703	return 0;
704}
705#endif
706
707static inline int cifs_create_options(struct cifs_sb_info *cifs_sb, int options)
708{
709	if (cifs_sb && (backup_cred(cifs_sb)))
710		return options | CREATE_OPEN_BACKUP_INTENT;
711	else
712		return options;
713}
714
715struct super_block *cifs_get_tcon_super(struct cifs_tcon *tcon);
716void cifs_put_tcon_super(struct super_block *sb);
717int cifs_wait_for_server_reconnect(struct TCP_Server_Info *server, bool retry);
718
719/* Put references of @ses and @ses->dfs_root_ses */
720static inline void cifs_put_smb_ses(struct cifs_ses *ses)
721{
722	struct cifs_ses *rses = ses->dfs_root_ses;
723
724	__cifs_put_smb_ses(ses);
725	if (rses)
726		__cifs_put_smb_ses(rses);
727}
728
729/* Get an active reference of @ses and @ses->dfs_root_ses.
730 *
731 * NOTE: make sure to call this function when incrementing reference count of
732 * @ses to ensure that any DFS root session attached to it (@ses->dfs_root_ses)
733 * will also get its reference count incremented.
734 *
735 * cifs_put_smb_ses() will put both references, so call it when you're done.
736 */
737static inline void cifs_smb_ses_inc_refcount(struct cifs_ses *ses)
738{
739	lockdep_assert_held(&cifs_tcp_ses_lock);
740
741	ses->ses_count++;
742	if (ses->dfs_root_ses)
743		ses->dfs_root_ses->ses_count++;
744}
745
746static inline bool dfs_src_pathname_equal(const char *s1, const char *s2)
747{
748	if (strlen(s1) != strlen(s2))
749		return false;
750	for (; *s1; s1++, s2++) {
751		if (*s1 == '/' || *s1 == '\\') {
752			if (*s2 != '/' && *s2 != '\\')
753				return false;
754		} else if (tolower(*s1) != tolower(*s2))
755			return false;
756	}
757	return true;
758}
759
760static inline void release_mid(struct mid_q_entry *mid)
761{
762	kref_put(&mid->refcount, __release_mid);
763}
764
765#endif			/* _CIFSPROTO_H */
766