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