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