xref: /linux/fs/smb/client/cifsproto.h (revision 3e7d63037a2b1715f70b7454630f3b2b8a922ec8)
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 "cifsglob.h"
13 #include "trace.h"
14 #ifdef CONFIG_CIFS_DFS_UPCALL
15 #include "dfs_cache.h"
16 #endif
17 #include "smb1proto.h"
18 
19 struct statfs;
20 struct smb_rqst;
21 struct smb3_fs_context;
22 
23 /*
24  *****************************************************************
25  * All Prototypes
26  *****************************************************************
27  */
28 
29 void *cifs_buf_get(void);
30 void cifs_buf_release(void *buf_to_free);
31 void *cifs_small_buf_get(void);
32 void cifs_small_buf_release(void *buf_to_free);
33 void free_rsp_buf(int resp_buftype, void *rsp);
34 int smb_send_kvec(struct TCP_Server_Info *server, struct msghdr *smb_msg,
35 		  size_t *sent);
36 unsigned int _get_xid(void);
37 void _free_xid(unsigned int xid);
38 #define get_xid()							\
39 ({									\
40 	unsigned int __xid = _get_xid();				\
41 	cifs_dbg(FYI, "VFS: in %s as Xid: %u with uid: %d\n",		\
42 		 __func__, __xid,					\
43 		 from_kuid(&init_user_ns, current_fsuid()));		\
44 	trace_smb3_enter(__xid, __func__);				\
45 	__xid;								\
46 })
47 
48 #define free_xid(curr_xid)						\
49 do {									\
50 	_free_xid(curr_xid);						\
51 	cifs_dbg(FYI, "VFS: leaving %s (xid = %u) rc = %d\n",		\
52 		 __func__, curr_xid, (int)rc);				\
53 	if (rc)								\
54 		trace_smb3_exit_err(curr_xid, __func__, (int)rc);	\
55 	else								\
56 		trace_smb3_exit_done(curr_xid, __func__);		\
57 } while (0)
58 int init_cifs_idmap(void);
59 void exit_cifs_idmap(void);
60 int init_cifs_spnego(void);
61 void exit_cifs_spnego(void);
62 const char *build_path_from_dentry(struct dentry *direntry, void *page);
63 char *__build_path_from_dentry_optional_prefix(struct dentry *direntry,
64 					       void *page, const char *tree,
65 					       int tree_len, bool prefix);
66 char *build_path_from_dentry_optional_prefix(struct dentry *direntry,
67 					     void *page, bool prefix);
68 static inline void *alloc_dentry_path(void)
69 {
70 	return __getname();
71 }
72 
73 static inline void free_dentry_path(void *page)
74 {
75 	if (page)
76 		__putname(page);
77 }
78 
79 char *cifs_build_path_to_root(struct smb3_fs_context *ctx,
80 			      struct cifs_sb_info *cifs_sb,
81 			      struct cifs_tcon *tcon, int add_treename);
82 char *cifs_build_devname(char *nodename, const char *prepath);
83 void delete_mid(struct TCP_Server_Info *server, struct mid_q_entry *mid);
84 void __release_mid(struct TCP_Server_Info *server,
85 		   struct mid_q_entry *midEntry);
86 void cifs_wake_up_task(struct TCP_Server_Info *server,
87 		       struct mid_q_entry *mid);
88 int cifs_handle_standard(struct TCP_Server_Info *server,
89 			 struct mid_q_entry *mid);
90 char *smb3_fs_context_fullpath(const struct smb3_fs_context *ctx, char dirsep);
91 int smb3_parse_devname(const char *devname, struct smb3_fs_context *ctx);
92 int smb3_parse_opt(const char *options, const char *key, char **val);
93 int cifs_ipaddr_cmp(struct sockaddr *srcaddr, struct sockaddr *rhs);
94 bool cifs_match_ipaddr(struct sockaddr *srcaddr, struct sockaddr *rhs);
95 int cifs_discard_remaining_data(struct TCP_Server_Info *server);
96 int cifs_call_async(struct TCP_Server_Info *server, 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 struct TCP_Server_Info *cifs_pick_channel(struct cifs_ses *ses);
101 int cifs_send_recv(const unsigned int xid, struct cifs_ses *ses,
102 		   struct TCP_Server_Info *server, struct smb_rqst *rqst,
103 		   int *resp_buf_type, const int flags, struct kvec *resp_iov);
104 int compound_send_recv(const unsigned int xid, struct cifs_ses *ses,
105 		       struct TCP_Server_Info *server, const int flags,
106 		       const int num_rqst, struct smb_rqst *rqst,
107 		       int *resp_buf_type, struct kvec *resp_iov);
108 int cifs_sync_mid_result(struct mid_q_entry *mid,
109 			 struct TCP_Server_Info *server);
110 int __smb_send_rqst(struct TCP_Server_Info *server, int num_rqst,
111 		    struct smb_rqst *rqst);
112 int wait_for_free_request(struct TCP_Server_Info *server, const int flags,
113 			  unsigned int *instance);
114 int cifs_wait_mtu_credits(struct TCP_Server_Info *server, size_t size,
115 			  size_t *num, struct cifs_credits *credits);
116 
117 static inline int
118 send_cancel(struct cifs_ses *ses, struct TCP_Server_Info *server,
119 	    struct smb_rqst *rqst, struct mid_q_entry *mid,
120 	    unsigned int xid)
121 {
122 	return server->ops->send_cancel ?
123 		server->ops->send_cancel(ses, server, rqst, mid, xid) : 0;
124 }
125 
126 int wait_for_response(struct TCP_Server_Info *server, struct mid_q_entry *mid);
127 
128 void smb2_query_server_interfaces(struct work_struct *work);
129 void cifs_signal_cifsd_for_reconnect(struct TCP_Server_Info *server,
130 				     bool all_channels);
131 void cifs_mark_tcp_ses_conns_for_reconnect(struct TCP_Server_Info *server,
132 					   bool mark_smb_session);
133 int cifs_reconnect(struct TCP_Server_Info *server, bool mark_smb_session);
134 bool backup_cred(struct cifs_sb_info *cifs_sb);
135 bool is_size_safe_to_change(struct cifsInodeInfo *cifsInode, __u64 end_of_file,
136 			    bool from_readdir);
137 void cifs_write_subrequest_terminated(struct cifs_io_subrequest *wdata,
138 				      ssize_t result);
139 struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *cifs_inode,
140 					int flags);
141 int __cifs_get_writable_file(struct cifsInodeInfo *cifs_inode,
142 			     unsigned int find_flags, unsigned int open_flags,
143 			     struct cifsFileInfo **ret_file);
144 int cifs_get_writable_path(struct cifs_tcon *tcon, const char *name,
145 			   struct inode *inode, int flags,
146 			   struct cifsFileInfo **ret_file);
147 struct cifsFileInfo *__find_readable_file(struct cifsInodeInfo *cifs_inode,
148 					  unsigned int find_flags,
149 					  unsigned int open_flags);
150 int cifs_get_readable_path(struct cifs_tcon *tcon, const char *name,
151 			   struct cifsFileInfo **ret_file);
152 int cifs_get_hardlink_path(struct cifs_tcon *tcon, struct inode *inode,
153 			   struct file *file);
154 int decode_negTokenInit(unsigned char *security_blob, int length,
155 			struct TCP_Server_Info *server);
156 int cifs_convert_address(struct sockaddr *dst, const char *src, int len);
157 void cifs_set_port(struct sockaddr *addr, const unsigned short int port);
158 struct timespec64 cifs_NTtimeToUnix(__le64 ntutc);
159 u64 cifs_UnixTimeToNT(struct timespec64 t);
160 struct timespec64 cnvrtDosUnixTm(__le16 le_date, __le16 le_time, int offset);
161 void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock);
162 int cifs_get_writer(struct cifsInodeInfo *cinode);
163 void cifs_put_writer(struct cifsInodeInfo *cinode);
164 void cifs_done_oplock_break(struct cifsInodeInfo *cinode);
165 int cifs_unlock_range(struct cifsFileInfo *cfile, struct file_lock *flock,
166 		      unsigned int xid);
167 int cifs_push_mandatory_locks(struct cifsFileInfo *cfile);
168 
169 void cifs_down_write(struct rw_semaphore *sem);
170 struct cifsFileInfo *cifs_new_fileinfo(struct cifs_fid *fid, struct file *file,
171 				       struct tcon_link *tlink, __u32 oplock,
172 				       const char *symlink_target);
173 int cifs_posix_open(const char *full_path, struct inode **pinode,
174 		    struct super_block *sb, int mode, unsigned int f_flags,
175 		    __u32 *poplock, __u16 *pnetfid, unsigned int xid);
176 void cifs_fill_uniqueid(struct super_block *sb, struct cifs_fattr *fattr);
177 void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
178 			      FILE_UNIX_BASIC_INFO *info,
179 			      struct cifs_sb_info *cifs_sb);
180 void cifs_dir_info_to_fattr(struct cifs_fattr *fattr,
181 			    FILE_DIRECTORY_INFO *info,
182 			    struct cifs_sb_info *cifs_sb);
183 int cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr,
184 			bool from_readdir);
185 struct inode *cifs_iget(struct super_block *sb, struct cifs_fattr *fattr);
186 
187 int cifs_get_inode_info(struct inode **inode, const char *full_path,
188 			struct cifs_open_info_data *data,
189 			struct super_block *sb, int xid,
190 			const struct cifs_fid *fid);
191 int smb311_posix_get_inode_info(struct inode **inode, const char *full_path,
192 				struct cifs_open_info_data *data,
193 				struct super_block *sb,
194 				const unsigned int xid);
195 int cifs_get_inode_info_unix(struct inode **pinode,
196 			     const unsigned char *full_path,
197 			     struct super_block *sb, unsigned int xid);
198 int cifs_set_file_info(struct inode *inode, struct iattr *attrs,
199 		       unsigned int xid, const char *full_path, __u32 dosattr);
200 int cifs_rename_pending_delete(const char *full_path, struct dentry *dentry,
201 			       const unsigned int xid);
202 int sid_to_id(struct cifs_sb_info *cifs_sb, struct smb_sid *psid,
203 	      struct cifs_fattr *fattr, uint sidtype);
204 int cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb, struct cifs_fattr *fattr,
205 		      struct inode *inode, bool mode_from_special_sid,
206 		      const char *path, const struct cifs_fid *pfid);
207 int id_mode_to_cifs_acl(struct inode *inode, const char *path, __u64 *pnmode,
208 			kuid_t uid, kgid_t gid);
209 struct smb_ntsd *get_cifs_acl(struct cifs_sb_info *cifs_sb,
210 			      struct inode *inode, const char *path,
211 			      u32 *pacllen, u32 info);
212 struct smb_ntsd *get_cifs_acl_by_fid(struct cifs_sb_info *cifs_sb,
213 				     const struct cifs_fid *cifsfid,
214 				     u32 *pacllen, u32 info);
215 struct posix_acl *cifs_get_acl(struct mnt_idmap *idmap, struct dentry *dentry,
216 			       int type);
217 int cifs_set_acl(struct mnt_idmap *idmap, struct dentry *dentry,
218 		 struct posix_acl *acl, int type);
219 int set_cifs_acl(struct smb_ntsd *pnntsd, __u32 acllen, struct inode *inode,
220 		 const char *path, int aclflag);
221 unsigned int setup_authusers_ACE(struct smb_ace *pntace);
222 unsigned int setup_special_mode_ACE(struct smb_ace *pntace, bool posix,
223 				    __u64 nmode);
224 unsigned int setup_special_user_owner_ACE(struct smb_ace *pntace);
225 
226 void dequeue_mid(struct TCP_Server_Info *server, struct mid_q_entry *mid,
227 		 bool malformed);
228 int cifs_read_from_socket(struct TCP_Server_Info *server, char *buf,
229 			  unsigned int to_read);
230 ssize_t cifs_discard_from_socket(struct TCP_Server_Info *server,
231 				 size_t to_read);
232 int cifs_read_iter_from_socket(struct TCP_Server_Info *server,
233 			       struct iov_iter *iter, unsigned int to_read);
234 int cifs_setup_cifs_sb(struct cifs_sb_info *cifs_sb);
235 void cifs_mount_put_conns(struct cifs_mount_ctx *mnt_ctx);
236 int cifs_mount_get_session(struct cifs_mount_ctx *mnt_ctx);
237 int cifs_is_path_remote(struct cifs_mount_ctx *mnt_ctx);
238 int cifs_mount_get_tcon(struct cifs_mount_ctx *mnt_ctx);
239 int cifs_match_super(struct super_block *sb, void *data);
240 int cifs_mount(struct cifs_sb_info *cifs_sb, struct smb3_fs_context *ctx);
241 void cifs_umount(struct cifs_sb_info *cifs_sb);
242 void cifs_mark_open_files_invalid(struct cifs_tcon *tcon);
243 void cifs_reopen_persistent_handles(struct cifs_tcon *tcon);
244 
245 bool cifs_find_lock_conflict(struct cifsFileInfo *cfile, __u64 offset,
246 			     __u64 length, __u8 type, __u16 flags,
247 			     struct cifsLockInfo **conf_lock, int rw_check);
248 void cifs_add_pending_open(struct cifs_fid *fid, struct tcon_link *tlink,
249 			   struct cifs_pending_open *open);
250 void cifs_add_pending_open_locked(struct cifs_fid *fid,
251 				  struct tcon_link *tlink,
252 				  struct cifs_pending_open *open);
253 void cifs_del_pending_open(struct cifs_pending_open *open);
254 
255 bool cifs_is_deferred_close(struct cifsFileInfo *cfile,
256 			    struct cifs_deferred_close **pdclose);
257 
258 void cifs_add_deferred_close(struct cifsFileInfo *cfile,
259 			     struct cifs_deferred_close *dclose);
260 
261 void cifs_del_deferred_close(struct cifsFileInfo *cfile);
262 
263 void cifs_close_deferred_file(struct cifsInodeInfo *cifs_inode);
264 
265 void cifs_close_all_deferred_files(struct cifs_tcon *tcon);
266 
267 void cifs_close_all_deferred_files_sb(struct cifs_sb_info *cifs_sb);
268 void cifs_close_deferred_file_under_dentry(struct cifs_tcon *tcon,
269 					   struct dentry *dentry);
270 
271 void cifs_mark_open_handles_for_deleted_file(struct inode *inode,
272 					     const char *path);
273 
274 struct TCP_Server_Info *cifs_get_tcp_session(struct smb3_fs_context *ctx,
275 					     struct TCP_Server_Info *primary_server);
276 void cifs_put_tcp_session(struct TCP_Server_Info *server, int from_reconnect);
277 void cifs_put_tcon(struct cifs_tcon *tcon, enum smb3_tcon_ref_trace trace);
278 
279 void cifs_release_automount_timer(void);
280 
281 void cifs_proc_init(void);
282 void cifs_proc_clean(void);
283 
284 void cifs_move_llist(struct list_head *source, struct list_head *dest);
285 void cifs_free_llist(struct list_head *llist);
286 void cifs_del_lock_waiters(struct cifsLockInfo *lock);
287 
288 int cifs_tree_connect(const unsigned int xid, struct cifs_tcon *tcon);
289 
290 int cifs_negotiate_protocol(const unsigned int xid, struct cifs_ses *ses,
291 			    struct TCP_Server_Info *server);
292 int cifs_setup_session(const unsigned int xid, struct cifs_ses *ses,
293 		       struct TCP_Server_Info *server,
294 		       struct nls_table *nls_info);
295 int cifs_enable_signing(struct TCP_Server_Info *server,
296 			bool mnt_sign_required);
297 
298 int parse_dfs_referrals(struct get_dfs_referral_rsp *rsp, u32 rsp_size,
299 			unsigned int *num_of_nodes,
300 			struct dfs_info3_param **target_nodes,
301 			const struct nls_table *nls_codepage, int remap,
302 			const char *searchName, bool is_unicode);
303 
304 struct cifs_ses *sesInfoAlloc(void);
305 void sesInfoFree(struct cifs_ses *buf_to_free);
306 struct cifs_tcon *tcon_info_alloc(bool dir_leases_enabled,
307 				  enum smb3_tcon_ref_trace trace);
308 void tconInfoFree(struct cifs_tcon *tcon, enum smb3_tcon_ref_trace trace);
309 
310 int setup_ntlmv2_rsp(struct cifs_ses *ses, const struct nls_table *nls_cp);
311 void cifs_crypto_secmech_release(struct TCP_Server_Info *server);
312 int calc_seckey(struct cifs_ses *ses);
313 int generate_smb30signingkey(struct cifs_ses *ses,
314 			     struct TCP_Server_Info *server);
315 int generate_smb311signingkey(struct cifs_ses *ses,
316 			      struct TCP_Server_Info *server);
317 
318 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
319 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
320 void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
321 bool couldbe_mf_symlink(const struct cifs_fattr *fattr);
322 int check_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
323 		     struct cifs_sb_info *cifs_sb, struct cifs_fattr *fattr,
324 		     const unsigned char *path);
325 int E_md4hash(const unsigned char *passwd, unsigned char *p16,
326 	      const struct nls_table *codepage);
327 
328 struct TCP_Server_Info *cifs_find_tcp_session(struct smb3_fs_context *ctx);
329 
330 struct cifs_tcon *cifs_setup_ipc(struct cifs_ses *ses, bool seal);
331 
332 void __cifs_put_smb_ses(struct cifs_ses *ses);
333 
334 struct cifs_ses *cifs_get_smb_ses(struct TCP_Server_Info *server,
335 				  struct smb3_fs_context *ctx);
336 
337 int cifs_readv_receive(struct TCP_Server_Info *server,
338 		       struct mid_q_entry *mid);
339 
340 int cifs_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
341 			  struct cifs_sb_info *cifs_sb,
342 			  const unsigned char *path, char *pbuf,
343 			  unsigned int *pbytes_read);
344 int cifs_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
345 			   struct cifs_sb_info *cifs_sb,
346 			   const unsigned char *path, char *pbuf,
347 			   unsigned int *pbytes_written);
348 int __cifs_calc_signature(struct smb_rqst *rqst,
349 			  struct TCP_Server_Info *server, char *signature,
350 			  struct cifs_calc_sig_ctx *ctx);
351 enum securityEnum cifs_select_sectype(struct TCP_Server_Info *server,
352 				      enum securityEnum requested);
353 
354 int cifs_alloc_hash(const char *name, struct shash_desc **sdesc);
355 void cifs_free_hash(struct shash_desc **sdesc);
356 
357 int cifs_try_adding_channels(struct cifs_ses *ses);
358 int smb3_update_ses_channels(struct cifs_ses *ses,
359 			     struct TCP_Server_Info *server,
360 			     bool from_reconnect, bool disable_mchan);
361 bool is_ses_using_iface(struct cifs_ses *ses, struct cifs_server_iface *iface);
362 
363 int cifs_ses_get_chan_index(struct cifs_ses *ses,
364 			    struct TCP_Server_Info *server);
365 void cifs_chan_set_in_reconnect(struct cifs_ses *ses,
366 				struct TCP_Server_Info *server);
367 void cifs_chan_clear_in_reconnect(struct cifs_ses *ses,
368 				  struct TCP_Server_Info *server);
369 void cifs_chan_set_need_reconnect(struct cifs_ses *ses,
370 				  struct TCP_Server_Info *server);
371 void cifs_chan_clear_need_reconnect(struct cifs_ses *ses,
372 				    struct TCP_Server_Info *server);
373 bool cifs_chan_needs_reconnect(struct cifs_ses *ses,
374 			       struct TCP_Server_Info *server);
375 bool cifs_chan_is_iface_active(struct cifs_ses *ses,
376 			       struct TCP_Server_Info *server);
377 void cifs_decrease_secondary_channels(struct cifs_ses *ses,
378 				      bool disable_mchan);
379 void cifs_chan_update_iface(struct cifs_ses *ses,
380 			    struct TCP_Server_Info *server);
381 int SMB3_request_interfaces(const unsigned int xid, struct cifs_tcon *tcon,
382 			    bool in_mount);
383 
384 void extract_unc_hostname(const char *unc, const char **h, size_t *len);
385 int copy_path_name(char *dst, const char *src);
386 int smb2_parse_query_directory(struct cifs_tcon *tcon, struct kvec *rsp_iov,
387 			       int resp_buftype,
388 			       struct cifs_search_info *srch_inf);
389 
390 struct super_block *cifs_get_dfs_tcon_super(struct cifs_tcon *tcon);
391 void cifs_put_tcp_super(struct super_block *sb);
392 int cifs_update_super_prepath(struct cifs_sb_info *cifs_sb, char *prefix);
393 char *extract_hostname(const char *unc);
394 char *extract_sharename(const char *unc);
395 int parse_reparse_point(struct reparse_data_buffer *buf, u32 plen,
396 			struct cifs_sb_info *cifs_sb, const char *full_path,
397 			struct cifs_open_info_data *data);
398 int __cifs_sfu_make_node(unsigned int xid, struct inode *inode,
399 			 struct dentry *dentry, struct cifs_tcon *tcon,
400 			 const char *full_path, umode_t mode, dev_t dev,
401 			 const char *symname);
402 int cifs_sfu_make_node(unsigned int xid, struct inode *inode,
403 		       struct dentry *dentry, struct cifs_tcon *tcon,
404 		       const char *full_path, umode_t mode, dev_t dev);
405 umode_t wire_mode_to_posix(u32 wire, bool is_dir);
406 
407 #ifdef CONFIG_CIFS_DFS_UPCALL
408 static inline int get_dfs_path(const unsigned int xid, struct cifs_ses *ses,
409 			       const char *old_path,
410 			       const struct nls_table *nls_codepage,
411 			       struct dfs_info3_param *referral, int remap)
412 {
413 	return dfs_cache_find(xid, ses, nls_codepage, remap, old_path,
414 			      referral, NULL);
415 }
416 
417 int match_target_ip(struct TCP_Server_Info *server, const char *host,
418 		    size_t hostlen, bool *result);
419 int cifs_inval_name_dfs_link_error(const unsigned int xid,
420 				   struct cifs_tcon *tcon,
421 				   struct cifs_sb_info *cifs_sb,
422 				   const char *full_path, bool *islink);
423 #else
424 static inline int cifs_inval_name_dfs_link_error(const unsigned int xid,
425 				   struct cifs_tcon *tcon,
426 				   struct cifs_sb_info *cifs_sb,
427 				   const char *full_path,
428 				   bool *islink)
429 {
430 	*islink = false;
431 	return 0;
432 }
433 #endif
434 
435 static inline int cifs_create_options(struct cifs_sb_info *cifs_sb, int options)
436 {
437 	if (cifs_sb && (backup_cred(cifs_sb)))
438 		return options | CREATE_OPEN_BACKUP_INTENT;
439 	else
440 		return options;
441 }
442 
443 int cifs_wait_for_server_reconnect(struct TCP_Server_Info *server, bool retry);
444 
445 static inline void cifs_put_smb_ses(struct cifs_ses *ses)
446 {
447 	__cifs_put_smb_ses(ses);
448 }
449 
450 /* Get an active reference of @ses and its children.
451  *
452  * NOTE: make sure to call this function when incrementing reference count of
453  * @ses to ensure that any DFS root session attached to it (@ses->dfs_root_ses)
454  * will also get its reference count incremented.
455  *
456  * cifs_put_smb_ses() will put all references, so call it when you're done.
457  */
458 static inline void cifs_smb_ses_inc_refcount(struct cifs_ses *ses)
459 {
460 	lockdep_assert_held(&cifs_tcp_ses_lock);
461 	ses->ses_count++;
462 }
463 
464 static inline bool dfs_src_pathname_equal(const char *s1, const char *s2)
465 {
466 	if (strlen(s1) != strlen(s2))
467 		return false;
468 	for (; *s1; s1++, s2++) {
469 		if (*s1 == '/' || *s1 == '\\') {
470 			if (*s2 != '/' && *s2 != '\\')
471 				return false;
472 		} else if (tolower(*s1) != tolower(*s2))
473 			return false;
474 	}
475 	return true;
476 }
477 
478 static inline void smb_get_mid(struct mid_q_entry *mid)
479 {
480 	refcount_inc(&mid->refcount);
481 }
482 
483 static inline void release_mid(struct TCP_Server_Info *server, struct mid_q_entry *mid)
484 {
485 	if (refcount_dec_and_test(&mid->refcount))
486 		__release_mid(server, mid);
487 }
488 
489 static inline void cifs_free_open_info(struct cifs_open_info_data *data)
490 {
491 	kfree(data->symlink_target);
492 	free_rsp_buf(data->reparse.io.buftype, data->reparse.io.iov.iov_base);
493 	memset(data, 0, sizeof(*data));
494 }
495 
496 static inline int smb_EIO(enum smb_eio_trace trace)
497 {
498 	trace_smb3_eio(trace, 0, 0);
499 	return -EIO;
500 }
501 
502 static inline int smb_EIO1(enum smb_eio_trace trace, unsigned long info)
503 {
504 	trace_smb3_eio(trace, info, 0);
505 	return -EIO;
506 }
507 
508 static inline int smb_EIO2(enum smb_eio_trace trace, unsigned long info, unsigned long info2)
509 {
510 	trace_smb3_eio(trace, info, info2);
511 	return -EIO;
512 }
513 
514 static inline int cifs_get_num_sgs(const struct smb_rqst *rqst,
515 				   int num_rqst,
516 				   const u8 *sig)
517 {
518 	unsigned int len, skip;
519 	unsigned int nents = 0;
520 	unsigned long addr;
521 	size_t data_size;
522 	int i, j;
523 
524 	/*
525 	 * The first rqst has a transform header where the first 20 bytes are
526 	 * not part of the encrypted blob.
527 	 */
528 	skip = 20;
529 
530 	/* Assumes the first rqst has a transform header as the first iov.
531 	 * I.e.
532 	 * rqst[0].rq_iov[0]  is transform header
533 	 * rqst[0].rq_iov[1+] data to be encrypted/decrypted
534 	 * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
535 	 */
536 	for (i = 0; i < num_rqst; i++) {
537 		data_size = iov_iter_count(&rqst[i].rq_iter);
538 
539 		/* We really don't want a mixture of pinned and unpinned pages
540 		 * in the sglist.  It's hard to keep track of which is what.
541 		 * Instead, we convert to a BVEC-type iterator higher up.
542 		 */
543 		if (data_size &&
544 		    WARN_ON_ONCE(user_backed_iter(&rqst[i].rq_iter)))
545 			return smb_EIO(smb_eio_trace_user_iter);
546 
547 		/* We also don't want to have any extra refs or pins to clean
548 		 * up in the sglist.
549 		 */
550 		if (data_size &&
551 		    WARN_ON_ONCE(iov_iter_extract_will_pin(&rqst[i].rq_iter)))
552 			return smb_EIO(smb_eio_trace_extract_will_pin);
553 
554 		for (j = 0; j < rqst[i].rq_nvec; j++) {
555 			struct kvec *iov = &rqst[i].rq_iov[j];
556 
557 			addr = (unsigned long)iov->iov_base + skip;
558 			if (is_vmalloc_or_module_addr((void *)addr)) {
559 				len = iov->iov_len - skip;
560 				nents += DIV_ROUND_UP(offset_in_page(addr) + len,
561 						      PAGE_SIZE);
562 			} else {
563 				nents++;
564 			}
565 			skip = 0;
566 		}
567 		if (data_size)
568 			nents += iov_iter_npages(&rqst[i].rq_iter, INT_MAX);
569 	}
570 	nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
571 	return nents;
572 }
573 
574 /* We can not use the normal sg_set_buf() as we will sometimes pass a
575  * stack object as buf.
576  */
577 static inline void cifs_sg_set_buf(struct sg_table *sgtable,
578 				   const void *buf,
579 				   unsigned int buflen)
580 {
581 	unsigned long addr = (unsigned long)buf;
582 	unsigned int off = offset_in_page(addr);
583 
584 	addr &= PAGE_MASK;
585 	if (is_vmalloc_or_module_addr((void *)addr)) {
586 		do {
587 			unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
588 
589 			sg_set_page(&sgtable->sgl[sgtable->nents++],
590 				    vmalloc_to_page((void *)addr), len, off);
591 
592 			off = 0;
593 			addr += PAGE_SIZE;
594 			buflen -= len;
595 		} while (buflen);
596 	} else {
597 		sg_set_page(&sgtable->sgl[sgtable->nents++],
598 			    virt_to_page((void *)addr), buflen, off);
599 	}
600 }
601 
602 static inline int cifs_get_writable_file(struct cifsInodeInfo *cifs_inode,
603 					 unsigned int find_flags,
604 					 struct cifsFileInfo **ret_file)
605 {
606 	find_flags &= ~FIND_OPEN_FLAGS;
607 	return __cifs_get_writable_file(cifs_inode, find_flags, 0, ret_file);
608 }
609 
610 static inline struct cifsFileInfo *
611 find_readable_file(struct cifsInodeInfo *cinode, unsigned int find_flags)
612 {
613 	find_flags &= ~FIND_OPEN_FLAGS;
614 	find_flags |= FIND_NO_PENDING_DELETE;
615 	return __find_readable_file(cinode, find_flags, 0);
616 }
617 
618 #endif			/* _CIFSPROTO_H */
619