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