xref: /openbmc/linux/fs/smb/client/cifsglob.h (revision f0931824)
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  *              Jeremy Allison (jra@samba.org)
7  *
8  */
9 #ifndef _CIFS_GLOB_H
10 #define _CIFS_GLOB_H
11 
12 #include <linux/in.h>
13 #include <linux/in6.h>
14 #include <linux/inet.h>
15 #include <linux/slab.h>
16 #include <linux/scatterlist.h>
17 #include <linux/mm.h>
18 #include <linux/mempool.h>
19 #include <linux/workqueue.h>
20 #include <linux/utsname.h>
21 #include <linux/sched/mm.h>
22 #include <linux/netfs.h>
23 #include "cifs_fs_sb.h"
24 #include "cifsacl.h"
25 #include <crypto/internal/hash.h>
26 #include <uapi/linux/cifs/cifs_mount.h>
27 #include "../common/smb2pdu.h"
28 #include "smb2pdu.h"
29 #include <linux/filelock.h>
30 
31 #define SMB_PATH_MAX 260
32 #define CIFS_PORT 445
33 #define RFC1001_PORT 139
34 
35 /*
36  * The sizes of various internal tables and strings
37  */
38 #define MAX_UID_INFO 16
39 #define MAX_SES_INFO 2
40 #define MAX_TCON_INFO 4
41 
42 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
43 
44 #define CIFS_MIN_RCV_POOL 4
45 
46 #define MAX_REOPEN_ATT	5 /* these many maximum attempts to reopen a file */
47 /*
48  * default attribute cache timeout (jiffies)
49  */
50 #define CIFS_DEF_ACTIMEO (1 * HZ)
51 
52 /*
53  * max attribute cache timeout (jiffies) - 2^30
54  */
55 #define CIFS_MAX_ACTIMEO (1 << 30)
56 
57 /*
58  * Max persistent and resilient handle timeout (milliseconds).
59  * Windows durable max was 960000 (16 minutes)
60  */
61 #define SMB3_MAX_HANDLE_TIMEOUT 960000
62 
63 /*
64  * MAX_REQ is the maximum number of requests that WE will send
65  * on one socket concurrently.
66  */
67 #define CIFS_MAX_REQ 32767
68 
69 #define RFC1001_NAME_LEN 15
70 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
71 
72 /* maximum length of ip addr as a string (including ipv6 and sctp) */
73 #define SERVER_NAME_LENGTH 80
74 #define SERVER_NAME_LEN_WITH_NULL     (SERVER_NAME_LENGTH + 1)
75 
76 /* echo interval in seconds */
77 #define SMB_ECHO_INTERVAL_MIN 1
78 #define SMB_ECHO_INTERVAL_MAX 600
79 #define SMB_ECHO_INTERVAL_DEFAULT 60
80 
81 /* smb multichannel query server interfaces interval in seconds */
82 #define SMB_INTERFACE_POLL_INTERVAL	600
83 
84 /* maximum number of PDUs in one compound */
85 #define MAX_COMPOUND 7
86 
87 /*
88  * Default number of credits to keep available for SMB3.
89  * This value is chosen somewhat arbitrarily. The Windows client
90  * defaults to 128 credits, the Windows server allows clients up to
91  * 512 credits (or 8K for later versions), and the NetApp server
92  * does not limit clients at all.  Choose a high enough default value
93  * such that the client shouldn't limit performance, but allow mount
94  * to override (until you approach 64K, where we limit credits to 65000
95  * to reduce possibility of seeing more server credit overflow bugs.
96  */
97 #define SMB2_MAX_CREDITS_AVAILABLE 32000
98 
99 #include "cifspdu.h"
100 
101 #ifndef XATTR_DOS_ATTRIB
102 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
103 #endif
104 
105 #define CIFS_MAX_WORKSTATION_LEN  (__NEW_UTS_LEN + 1)  /* reasonable max for client */
106 
107 #define CIFS_DFS_ROOT_SES(ses) ((ses)->dfs_root_ses ?: (ses))
108 
109 /*
110  * CIFS vfs client Status information (based on what we know.)
111  */
112 
113 /* associated with each connection */
114 enum statusEnum {
115 	CifsNew = 0,
116 	CifsGood,
117 	CifsExiting,
118 	CifsNeedReconnect,
119 	CifsNeedNegotiate,
120 	CifsInNegotiate,
121 };
122 
123 /* associated with each smb session */
124 enum ses_status_enum {
125 	SES_NEW = 0,
126 	SES_GOOD,
127 	SES_EXITING,
128 	SES_NEED_RECON,
129 	SES_IN_SETUP
130 };
131 
132 /* associated with each tree connection to the server */
133 enum tid_status_enum {
134 	TID_NEW = 0,
135 	TID_GOOD,
136 	TID_EXITING,
137 	TID_NEED_RECON,
138 	TID_NEED_TCON,
139 	TID_IN_TCON,
140 	TID_NEED_FILES_INVALIDATE, /* currently unused */
141 	TID_IN_FILES_INVALIDATE
142 };
143 
144 enum securityEnum {
145 	Unspecified = 0,	/* not specified */
146 	NTLMv2,			/* Legacy NTLM auth with NTLMv2 hash */
147 	RawNTLMSSP,		/* NTLMSSP without SPNEGO, NTLMv2 hash */
148 	Kerberos,		/* Kerberos via SPNEGO */
149 };
150 
151 struct session_key {
152 	unsigned int len;
153 	char *response;
154 };
155 
156 /* crypto hashing related structure/fields, not specific to a sec mech */
157 struct cifs_secmech {
158 	struct shash_desc *hmacmd5; /* hmacmd5 hash function, for NTLMv2/CR1 hashes */
159 	struct shash_desc *md5; /* md5 hash function, for CIFS/SMB1 signatures */
160 	struct shash_desc *hmacsha256; /* hmac-sha256 hash function, for SMB2 signatures */
161 	struct shash_desc *sha512; /* sha512 hash function, for SMB3.1.1 preauth hash */
162 	struct shash_desc *aes_cmac; /* block-cipher based MAC function, for SMB3 signatures */
163 
164 	struct crypto_aead *enc; /* smb3 encryption AEAD TFM (AES-CCM and AES-GCM) */
165 	struct crypto_aead *dec; /* smb3 decryption AEAD TFM (AES-CCM and AES-GCM) */
166 };
167 
168 /* per smb session structure/fields */
169 struct ntlmssp_auth {
170 	bool sesskey_per_smbsess; /* whether session key is per smb session */
171 	__u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
172 	__u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
173 	unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
174 	char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
175 };
176 
177 struct cifs_cred {
178 	int uid;
179 	int gid;
180 	int mode;
181 	int cecount;
182 	struct cifs_sid osid;
183 	struct cifs_sid gsid;
184 	struct cifs_ntace *ntaces;
185 	struct cifs_ace *aces;
186 };
187 
188 struct cifs_open_info_data {
189 	bool adjust_tz;
190 	union {
191 		bool reparse_point;
192 		bool symlink;
193 	};
194 	struct {
195 		__u32 tag;
196 		union {
197 			struct reparse_data_buffer *buf;
198 			struct reparse_posix_data *posix;
199 		};
200 	} reparse;
201 	char *symlink_target;
202 	union {
203 		struct smb2_file_all_info fi;
204 		struct smb311_posix_qinfo posix_fi;
205 	};
206 };
207 
208 static inline bool cifs_open_data_reparse(struct cifs_open_info_data *data)
209 {
210 	struct smb2_file_all_info *fi = &data->fi;
211 	u32 attrs = le32_to_cpu(fi->Attributes);
212 	bool ret;
213 
214 	ret = data->reparse_point || (attrs & ATTR_REPARSE);
215 	if (ret)
216 		attrs |= ATTR_REPARSE;
217 	fi->Attributes = cpu_to_le32(attrs);
218 	return ret;
219 }
220 
221 static inline void cifs_free_open_info(struct cifs_open_info_data *data)
222 {
223 	kfree(data->symlink_target);
224 }
225 
226 /*
227  *****************************************************************
228  * Except the CIFS PDUs themselves all the
229  * globally interesting structs should go here
230  *****************************************************************
231  */
232 
233 /*
234  * A smb_rqst represents a complete request to be issued to a server. It's
235  * formed by a kvec array, followed by an array of pages. Page data is assumed
236  * to start at the beginning of the first page.
237  */
238 struct smb_rqst {
239 	struct kvec	*rq_iov;	/* array of kvecs */
240 	unsigned int	rq_nvec;	/* number of kvecs in array */
241 	size_t		rq_iter_size;	/* Amount of data in ->rq_iter */
242 	struct iov_iter	rq_iter;	/* Data iterator */
243 	struct xarray	rq_buffer;	/* Page buffer for encryption */
244 };
245 
246 struct mid_q_entry;
247 struct TCP_Server_Info;
248 struct cifsFileInfo;
249 struct cifs_ses;
250 struct cifs_tcon;
251 struct dfs_info3_param;
252 struct cifs_fattr;
253 struct smb3_fs_context;
254 struct cifs_fid;
255 struct cifs_readdata;
256 struct cifs_writedata;
257 struct cifs_io_parms;
258 struct cifs_search_info;
259 struct cifsInodeInfo;
260 struct cifs_open_parms;
261 struct cifs_credits;
262 
263 struct smb_version_operations {
264 	int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
265 			   struct mid_q_entry *);
266 	bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
267 	/* setup request: allocate mid, sign message */
268 	struct mid_q_entry *(*setup_request)(struct cifs_ses *,
269 					     struct TCP_Server_Info *,
270 					     struct smb_rqst *);
271 	/* setup async request: allocate mid, sign message */
272 	struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
273 						struct smb_rqst *);
274 	/* check response: verify signature, map error */
275 	int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
276 			     bool);
277 	void (*add_credits)(struct TCP_Server_Info *server,
278 			    const struct cifs_credits *credits,
279 			    const int optype);
280 	void (*set_credits)(struct TCP_Server_Info *, const int);
281 	int * (*get_credits_field)(struct TCP_Server_Info *, const int);
282 	unsigned int (*get_credits)(struct mid_q_entry *);
283 	__u64 (*get_next_mid)(struct TCP_Server_Info *);
284 	void (*revert_current_mid)(struct TCP_Server_Info *server,
285 				   const unsigned int val);
286 	/* data offset from read response message */
287 	unsigned int (*read_data_offset)(char *);
288 	/*
289 	 * Data length from read response message
290 	 * When in_remaining is true, the returned data length is in
291 	 * message field DataRemaining for out-of-band data read (e.g through
292 	 * Memory Registration RDMA write in SMBD).
293 	 * Otherwise, the returned data length is in message field DataLength.
294 	 */
295 	unsigned int (*read_data_length)(char *, bool in_remaining);
296 	/* map smb to linux error */
297 	int (*map_error)(char *, bool);
298 	/* find mid corresponding to the response message */
299 	struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
300 	void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
301 	void (*clear_stats)(struct cifs_tcon *);
302 	void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
303 	void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
304 	/* verify the message */
305 	int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
306 	bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
307 	int (*handle_cancelled_mid)(struct mid_q_entry *, struct TCP_Server_Info *);
308 	void (*downgrade_oplock)(struct TCP_Server_Info *server,
309 				 struct cifsInodeInfo *cinode, __u32 oplock,
310 				 unsigned int epoch, bool *purge_cache);
311 	/* process transaction2 response */
312 	bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
313 			     char *, int);
314 	/* check if we need to negotiate */
315 	bool (*need_neg)(struct TCP_Server_Info *);
316 	/* negotiate to the server */
317 	int (*negotiate)(const unsigned int xid,
318 			 struct cifs_ses *ses,
319 			 struct TCP_Server_Info *server);
320 	/* set negotiated write size */
321 	unsigned int (*negotiate_wsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
322 	/* set negotiated read size */
323 	unsigned int (*negotiate_rsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
324 	/* setup smb sessionn */
325 	int (*sess_setup)(const unsigned int, struct cifs_ses *,
326 			  struct TCP_Server_Info *server,
327 			  const struct nls_table *);
328 	/* close smb session */
329 	int (*logoff)(const unsigned int, struct cifs_ses *);
330 	/* connect to a server share */
331 	int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
332 			    struct cifs_tcon *, const struct nls_table *);
333 	/* close tree connecion */
334 	int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
335 	/* get DFS referrals */
336 	int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
337 			     const char *, struct dfs_info3_param **,
338 			     unsigned int *, const struct nls_table *, int);
339 	/* informational QFS call */
340 	void (*qfs_tcon)(const unsigned int, struct cifs_tcon *,
341 			 struct cifs_sb_info *);
342 	/* query for server interfaces */
343 	int (*query_server_interfaces)(const unsigned int, struct cifs_tcon *,
344 				       bool);
345 	/* check if a path is accessible or not */
346 	int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
347 				  struct cifs_sb_info *, const char *);
348 	/* query path data from the server */
349 	int (*query_path_info)(const unsigned int xid,
350 			       struct cifs_tcon *tcon,
351 			       struct cifs_sb_info *cifs_sb,
352 			       const char *full_path,
353 			       struct cifs_open_info_data *data);
354 	/* query file data from the server */
355 	int (*query_file_info)(const unsigned int xid, struct cifs_tcon *tcon,
356 			       struct cifsFileInfo *cfile, struct cifs_open_info_data *data);
357 	/* query reparse point to determine which type of special file */
358 	int (*query_reparse_point)(const unsigned int xid,
359 				   struct cifs_tcon *tcon,
360 				   struct cifs_sb_info *cifs_sb,
361 				   const char *full_path,
362 				   u32 *tag, struct kvec *rsp,
363 				   int *rsp_buftype);
364 	/* get server index number */
365 	int (*get_srv_inum)(const unsigned int xid, struct cifs_tcon *tcon,
366 			    struct cifs_sb_info *cifs_sb, const char *full_path, u64 *uniqueid,
367 			    struct cifs_open_info_data *data);
368 	/* set size by path */
369 	int (*set_path_size)(const unsigned int, struct cifs_tcon *,
370 			     const char *, __u64, struct cifs_sb_info *, bool);
371 	/* set size by file handle */
372 	int (*set_file_size)(const unsigned int, struct cifs_tcon *,
373 			     struct cifsFileInfo *, __u64, bool);
374 	/* set attributes */
375 	int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
376 			     const unsigned int);
377 	int (*set_compression)(const unsigned int, struct cifs_tcon *,
378 			       struct cifsFileInfo *);
379 	/* check if we can send an echo or nor */
380 	bool (*can_echo)(struct TCP_Server_Info *);
381 	/* send echo request */
382 	int (*echo)(struct TCP_Server_Info *);
383 	/* create directory */
384 	int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
385 			umode_t mode, struct cifs_tcon *tcon,
386 			const char *full_path,
387 			struct cifs_sb_info *cifs_sb);
388 	int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
389 		     struct cifs_tcon *tcon, const char *name,
390 		     struct cifs_sb_info *sb);
391 	/* set info on created directory */
392 	void (*mkdir_setinfo)(struct inode *, const char *,
393 			      struct cifs_sb_info *, struct cifs_tcon *,
394 			      const unsigned int);
395 	/* remove directory */
396 	int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
397 		     struct cifs_sb_info *);
398 	/* unlink file */
399 	int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
400 		      struct cifs_sb_info *);
401 	/* open, rename and delete file */
402 	int (*rename_pending_delete)(const char *, struct dentry *,
403 				     const unsigned int);
404 	/* send rename request */
405 	int (*rename)(const unsigned int xid,
406 		      struct cifs_tcon *tcon,
407 		      struct dentry *source_dentry,
408 		      const char *from_name, const char *to_name,
409 		      struct cifs_sb_info *cifs_sb);
410 	/* send create hardlink request */
411 	int (*create_hardlink)(const unsigned int xid,
412 			       struct cifs_tcon *tcon,
413 			       struct dentry *source_dentry,
414 			       const char *from_name, const char *to_name,
415 			       struct cifs_sb_info *cifs_sb);
416 	/* query symlink target */
417 	int (*query_symlink)(const unsigned int xid,
418 			     struct cifs_tcon *tcon,
419 			     struct cifs_sb_info *cifs_sb,
420 			     const char *full_path,
421 			     char **target_path);
422 	/* open a file for non-posix mounts */
423 	int (*open)(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,
424 		    void *buf);
425 	/* set fid protocol-specific info */
426 	void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
427 	/* close a file */
428 	int (*close)(const unsigned int, struct cifs_tcon *,
429 		      struct cifs_fid *);
430 	/* close a file, returning file attributes and timestamps */
431 	int (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon,
432 		      struct cifsFileInfo *pfile_info);
433 	/* send a flush request to the server */
434 	int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
435 	/* async read from the server */
436 	int (*async_readv)(struct cifs_readdata *);
437 	/* async write to the server */
438 	int (*async_writev)(struct cifs_writedata *,
439 			    void (*release)(struct kref *));
440 	/* sync read from the server */
441 	int (*sync_read)(const unsigned int, struct cifs_fid *,
442 			 struct cifs_io_parms *, unsigned int *, char **,
443 			 int *);
444 	/* sync write to the server */
445 	int (*sync_write)(const unsigned int, struct cifs_fid *,
446 			  struct cifs_io_parms *, unsigned int *, struct kvec *,
447 			  unsigned long);
448 	/* open dir, start readdir */
449 	int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
450 			       const char *, struct cifs_sb_info *,
451 			       struct cifs_fid *, __u16,
452 			       struct cifs_search_info *);
453 	/* continue readdir */
454 	int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
455 			      struct cifs_fid *,
456 			      __u16, struct cifs_search_info *srch_inf);
457 	/* close dir */
458 	int (*close_dir)(const unsigned int, struct cifs_tcon *,
459 			 struct cifs_fid *);
460 	/* calculate a size of SMB message */
461 	unsigned int (*calc_smb_size)(void *buf);
462 	/* check for STATUS_PENDING and process the response if yes */
463 	bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
464 	/* check for STATUS_NETWORK_SESSION_EXPIRED */
465 	bool (*is_session_expired)(char *);
466 	/* send oplock break response */
467 	int (*oplock_response)(struct cifs_tcon *tcon, __u64 persistent_fid, __u64 volatile_fid,
468 			__u16 net_fid, struct cifsInodeInfo *cifs_inode);
469 	/* query remote filesystem */
470 	int (*queryfs)(const unsigned int, struct cifs_tcon *,
471 		       struct cifs_sb_info *, struct kstatfs *);
472 	/* send mandatory brlock to the server */
473 	int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
474 			 __u64, __u32, int, int, bool);
475 	/* unlock range of mandatory locks */
476 	int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
477 				 const unsigned int);
478 	/* push brlocks from the cache to the server */
479 	int (*push_mand_locks)(struct cifsFileInfo *);
480 	/* get lease key of the inode */
481 	void (*get_lease_key)(struct inode *, struct cifs_fid *);
482 	/* set lease key of the inode */
483 	void (*set_lease_key)(struct inode *, struct cifs_fid *);
484 	/* generate new lease key */
485 	void (*new_lease_key)(struct cifs_fid *);
486 	int (*generate_signingkey)(struct cifs_ses *ses,
487 				   struct TCP_Server_Info *server);
488 	int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *,
489 				bool allocate_crypto);
490 	int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
491 			     struct cifsFileInfo *src_file);
492 	int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
493 			     struct cifsFileInfo *src_file, void __user *);
494 	int (*notify)(const unsigned int xid, struct file *pfile,
495 			     void __user *pbuf, bool return_changes);
496 	int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
497 				struct cifs_sb_info *, const unsigned char *,
498 				char *, unsigned int *);
499 	int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
500 				 struct cifs_sb_info *, const unsigned char *,
501 				 char *, unsigned int *);
502 	/* if we can do cache read operations */
503 	bool (*is_read_op)(__u32);
504 	/* set oplock level for the inode */
505 	void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
506 				 bool *);
507 	/* create lease context buffer for CREATE request */
508 	char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
509 	/* parse lease context buffer and return oplock/epoch info */
510 	__u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
511 	ssize_t (*copychunk_range)(const unsigned int,
512 			struct cifsFileInfo *src_file,
513 			struct cifsFileInfo *target_file,
514 			u64 src_off, u64 len, u64 dest_off);
515 	int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
516 			struct cifsFileInfo *target_file, u64 src_off, u64 len,
517 			u64 dest_off);
518 	int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
519 	ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
520 			const unsigned char *, const unsigned char *, char *,
521 			size_t, struct cifs_sb_info *);
522 	int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
523 			const char *, const void *, const __u16,
524 			const struct nls_table *, struct cifs_sb_info *);
525 	struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
526 			const char *, u32 *, u32);
527 	struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
528 			const struct cifs_fid *, u32 *, u32);
529 	int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
530 			int);
531 	/* writepages retry size */
532 	unsigned int (*wp_retry_size)(struct inode *);
533 	/* get mtu credits */
534 	int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
535 				unsigned int *, struct cifs_credits *);
536 	/* adjust previously taken mtu credits to request size */
537 	int (*adjust_credits)(struct TCP_Server_Info *server,
538 			      struct cifs_credits *credits,
539 			      const unsigned int payload_size);
540 	/* check if we need to issue closedir */
541 	bool (*dir_needs_close)(struct cifsFileInfo *);
542 	long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
543 			  loff_t);
544 	/* init transform request - used for encryption for now */
545 	int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
546 				 struct smb_rqst *, struct smb_rqst *);
547 	int (*is_transform_hdr)(void *buf);
548 	int (*receive_transform)(struct TCP_Server_Info *,
549 				 struct mid_q_entry **, char **, int *);
550 	enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
551 			    enum securityEnum);
552 	int (*next_header)(struct TCP_Server_Info *server, char *buf,
553 			   unsigned int *noff);
554 	/* ioctl passthrough for query_info */
555 	int (*ioctl_query_info)(const unsigned int xid,
556 				struct cifs_tcon *tcon,
557 				struct cifs_sb_info *cifs_sb,
558 				__le16 *path, int is_dir,
559 				unsigned long p);
560 	/* make unix special files (block, char, fifo, socket) */
561 	int (*make_node)(unsigned int xid,
562 			 struct inode *inode,
563 			 struct dentry *dentry,
564 			 struct cifs_tcon *tcon,
565 			 const char *full_path,
566 			 umode_t mode,
567 			 dev_t device_number);
568 	/* version specific fiemap implementation */
569 	int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
570 		      struct fiemap_extent_info *, u64, u64);
571 	/* version specific llseek implementation */
572 	loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
573 	/* Check for STATUS_IO_TIMEOUT */
574 	bool (*is_status_io_timeout)(char *buf);
575 	/* Check for STATUS_NETWORK_NAME_DELETED */
576 	bool (*is_network_name_deleted)(char *buf, struct TCP_Server_Info *srv);
577 	int (*parse_reparse_point)(struct cifs_sb_info *cifs_sb,
578 				   struct kvec *rsp_iov,
579 				   struct cifs_open_info_data *data);
580 };
581 
582 struct smb_version_values {
583 	char		*version_string;
584 	__u16		protocol_id;
585 	__u32		req_capabilities;
586 	__u32		large_lock_type;
587 	__u32		exclusive_lock_type;
588 	__u32		shared_lock_type;
589 	__u32		unlock_lock_type;
590 	size_t		header_preamble_size;
591 	size_t		header_size;
592 	size_t		max_header_size;
593 	size_t		read_rsp_size;
594 	__le16		lock_cmd;
595 	unsigned int	cap_unix;
596 	unsigned int	cap_nt_find;
597 	unsigned int	cap_large_files;
598 	__u16		signing_enabled;
599 	__u16		signing_required;
600 	size_t		create_lease_size;
601 };
602 
603 #define HEADER_SIZE(server) (server->vals->header_size)
604 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
605 #define HEADER_PREAMBLE_SIZE(server) (server->vals->header_preamble_size)
606 #define MID_HEADER_SIZE(server) (HEADER_SIZE(server) - 1 - HEADER_PREAMBLE_SIZE(server))
607 
608 /**
609  * CIFS superblock mount flags (mnt_cifs_flags) to consider when
610  * trying to reuse existing superblock for a new mount
611  */
612 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
613 			 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
614 			 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
615 			 CIFS_MOUNT_MAP_SFM_CHR | \
616 			 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
617 			 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
618 			 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
619 			 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
620 			 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
621 			 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
622 			 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
623 			 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
624 			 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
625 			 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
626 
627 /**
628  * Generic VFS superblock mount flags (s_flags) to consider when
629  * trying to reuse existing superblock for a new mount
630  */
631 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
632 		      SB_NODEV | SB_SYNCHRONOUS)
633 
634 struct cifs_mnt_data {
635 	struct cifs_sb_info *cifs_sb;
636 	struct smb3_fs_context *ctx;
637 	int flags;
638 };
639 
640 static inline unsigned int
641 get_rfc1002_length(void *buf)
642 {
643 	return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
644 }
645 
646 static inline void
647 inc_rfc1001_len(void *buf, int count)
648 {
649 	be32_add_cpu((__be32 *)buf, count);
650 }
651 
652 struct TCP_Server_Info {
653 	struct list_head tcp_ses_list;
654 	struct list_head smb_ses_list;
655 	spinlock_t srv_lock;  /* protect anything here that is not protected */
656 	__u64 conn_id; /* connection identifier (useful for debugging) */
657 	int srv_count; /* reference counter */
658 	/* 15 character server name + 0x20 16th byte indicating type = srv */
659 	char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
660 	struct smb_version_operations	*ops;
661 	struct smb_version_values	*vals;
662 	/* updates to tcpStatus protected by cifs_tcp_ses_lock */
663 	enum statusEnum tcpStatus; /* what we think the status is */
664 	char *hostname; /* hostname portion of UNC string */
665 	struct socket *ssocket;
666 	struct sockaddr_storage dstaddr;
667 	struct sockaddr_storage srcaddr; /* locally bind to this IP */
668 #ifdef CONFIG_NET_NS
669 	struct net *net;
670 #endif
671 	wait_queue_head_t response_q;
672 	wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
673 	spinlock_t mid_lock;  /* protect mid queue and it's entries */
674 	struct list_head pending_mid_q;
675 	bool noblocksnd;		/* use blocking sendmsg */
676 	bool noautotune;		/* do not autotune send buf sizes */
677 	bool nosharesock;
678 	bool tcp_nodelay;
679 	bool terminate;
680 	unsigned int credits;  /* send no more requests at once */
681 	unsigned int max_credits; /* can override large 32000 default at mnt */
682 	unsigned int in_flight;  /* number of requests on the wire to server */
683 	unsigned int max_in_flight; /* max number of requests that were on wire */
684 	spinlock_t req_lock;  /* protect the two values above */
685 	struct mutex _srv_mutex;
686 	unsigned int nofs_flag;
687 	struct task_struct *tsk;
688 	char server_GUID[16];
689 	__u16 sec_mode;
690 	bool sign; /* is signing enabled on this connection? */
691 	bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
692 	bool session_estab; /* mark when very first sess is established */
693 	int echo_credits;  /* echo reserved slots */
694 	int oplock_credits;  /* oplock break reserved slots */
695 	bool echoes:1; /* enable echoes */
696 	__u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
697 	u16 dialect; /* dialect index that server chose */
698 	bool oplocks:1; /* enable oplocks */
699 	unsigned int maxReq;	/* Clients should submit no more */
700 	/* than maxReq distinct unanswered SMBs to the server when using  */
701 	/* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
702 	unsigned int maxBuf;	/* maxBuf specifies the maximum */
703 	/* message size the server can send or receive for non-raw SMBs */
704 	/* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
705 	/* when socket is setup (and during reconnect) before NegProt sent */
706 	unsigned int max_rw;	/* maxRw specifies the maximum */
707 	/* message size the server can send or receive for */
708 	/* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
709 	unsigned int capabilities; /* selective disabling of caps by smb sess */
710 	int timeAdj;  /* Adjust for difference in server time zone in sec */
711 	__u64 CurrentMid;         /* multiplex id - rotating counter, protected by GlobalMid_Lock */
712 	char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
713 	/* 16th byte of RFC1001 workstation name is always null */
714 	char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
715 	__u32 sequence_number; /* for signing, protected by srv_mutex */
716 	__u32 reconnect_instance; /* incremented on each reconnect */
717 	struct session_key session_key;
718 	unsigned long lstrp; /* when we got last response from this server */
719 	struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
720 #define	CIFS_NEGFLAVOR_UNENCAP	1	/* wct == 17, but no ext_sec */
721 #define	CIFS_NEGFLAVOR_EXTENDED	2	/* wct == 17, ext_sec bit set */
722 	char	negflavor;	/* NEGOTIATE response flavor */
723 	/* extended security flavors that server supports */
724 	bool	sec_ntlmssp;		/* supports NTLMSSP */
725 	bool	sec_kerberosu2u;	/* supports U2U Kerberos */
726 	bool	sec_kerberos;		/* supports plain Kerberos */
727 	bool	sec_mskerberos;		/* supports legacy MS Kerberos */
728 	bool	large_buf;		/* is current buffer large? */
729 	/* use SMBD connection instead of socket */
730 	bool	rdma;
731 	/* point to the SMBD connection if RDMA is used instead of socket */
732 	struct smbd_connection *smbd_conn;
733 	struct delayed_work	echo; /* echo ping workqueue job */
734 	char	*smallbuf;	/* pointer to current "small" buffer */
735 	char	*bigbuf;	/* pointer to current "big" buffer */
736 	/* Total size of this PDU. Only valid from cifs_demultiplex_thread */
737 	unsigned int pdu_size;
738 	unsigned int total_read; /* total amount of data read in this pass */
739 	atomic_t in_send; /* requests trying to send */
740 	atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
741 #ifdef CONFIG_CIFS_STATS2
742 	atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
743 	atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
744 	__u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
745 	__u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
746 	__u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
747 #endif /* STATS2 */
748 	unsigned int	max_read;
749 	unsigned int	max_write;
750 	unsigned int	min_offload;
751 	__le16	compress_algorithm;
752 	__u16	signing_algorithm;
753 	__le16	cipher_type;
754 	 /* save initital negprot hash */
755 	__u8	preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
756 	bool	signing_negotiated; /* true if valid signing context rcvd from server */
757 	bool	posix_ext_supported;
758 	struct delayed_work reconnect; /* reconnect workqueue job */
759 	struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
760 	unsigned long echo_interval;
761 
762 	/*
763 	 * Number of targets available for reconnect. The more targets
764 	 * the more tasks have to wait to let the demultiplex thread
765 	 * reconnect.
766 	 */
767 	int nr_targets;
768 	bool noblockcnt; /* use non-blocking connect() */
769 
770 	/*
771 	 * If this is a session channel,
772 	 * primary_server holds the ref-counted
773 	 * pointer to primary channel connection for the session.
774 	 */
775 #define SERVER_IS_CHAN(server)	(!!(server)->primary_server)
776 	struct TCP_Server_Info *primary_server;
777 	__u16 channel_sequence_num;  /* incremented on primary channel on each chan reconnect */
778 
779 #ifdef CONFIG_CIFS_SWN_UPCALL
780 	bool use_swn_dstaddr;
781 	struct sockaddr_storage swn_dstaddr;
782 #endif
783 	struct mutex refpath_lock; /* protects leaf_fullpath */
784 	/*
785 	 * leaf_fullpath: Canonical DFS referral path related to this
786 	 *                connection.
787 	 *                It is used in DFS cache refresher, reconnect and may
788 	 *                change due to nested DFS links.
789 	 *
790 	 * Protected by @refpath_lock and @srv_lock.  The @refpath_lock is
791 	 * mostly used for not requiring a copy of @leaf_fullpath when getting
792 	 * cached or new DFS referrals (which might also sleep during I/O).
793 	 * While @srv_lock is held for making string and NULL comparions against
794 	 * both fields as in mount(2) and cache refresh.
795 	 *
796 	 * format: \\HOST\SHARE[\OPTIONAL PATH]
797 	 */
798 	char *leaf_fullpath;
799 };
800 
801 static inline bool is_smb1(struct TCP_Server_Info *server)
802 {
803 	return HEADER_PREAMBLE_SIZE(server) != 0;
804 }
805 
806 static inline void cifs_server_lock(struct TCP_Server_Info *server)
807 {
808 	unsigned int nofs_flag = memalloc_nofs_save();
809 
810 	mutex_lock(&server->_srv_mutex);
811 	server->nofs_flag = nofs_flag;
812 }
813 
814 static inline void cifs_server_unlock(struct TCP_Server_Info *server)
815 {
816 	unsigned int nofs_flag = server->nofs_flag;
817 
818 	mutex_unlock(&server->_srv_mutex);
819 	memalloc_nofs_restore(nofs_flag);
820 }
821 
822 struct cifs_credits {
823 	unsigned int value;
824 	unsigned int instance;
825 };
826 
827 static inline unsigned int
828 in_flight(struct TCP_Server_Info *server)
829 {
830 	unsigned int num;
831 
832 	spin_lock(&server->req_lock);
833 	num = server->in_flight;
834 	spin_unlock(&server->req_lock);
835 	return num;
836 }
837 
838 static inline bool
839 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
840 {
841 	int num;
842 
843 	spin_lock(&server->req_lock);
844 	num = *credits;
845 	spin_unlock(&server->req_lock);
846 	return num >= num_credits;
847 }
848 
849 static inline void
850 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
851 	    const int optype)
852 {
853 	server->ops->add_credits(server, credits, optype);
854 }
855 
856 static inline void
857 add_credits_and_wake_if(struct TCP_Server_Info *server,
858 			const struct cifs_credits *credits, const int optype)
859 {
860 	if (credits->value) {
861 		server->ops->add_credits(server, credits, optype);
862 		wake_up(&server->request_q);
863 	}
864 }
865 
866 static inline void
867 set_credits(struct TCP_Server_Info *server, const int val)
868 {
869 	server->ops->set_credits(server, val);
870 }
871 
872 static inline int
873 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
874 	       const unsigned int payload_size)
875 {
876 	return server->ops->adjust_credits ?
877 		server->ops->adjust_credits(server, credits, payload_size) : 0;
878 }
879 
880 static inline __le64
881 get_next_mid64(struct TCP_Server_Info *server)
882 {
883 	return cpu_to_le64(server->ops->get_next_mid(server));
884 }
885 
886 static inline __le16
887 get_next_mid(struct TCP_Server_Info *server)
888 {
889 	__u16 mid = server->ops->get_next_mid(server);
890 	/*
891 	 * The value in the SMB header should be little endian for easy
892 	 * on-the-wire decoding.
893 	 */
894 	return cpu_to_le16(mid);
895 }
896 
897 static inline void
898 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
899 {
900 	if (server->ops->revert_current_mid)
901 		server->ops->revert_current_mid(server, val);
902 }
903 
904 static inline void
905 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
906 			    const struct smb2_hdr *shdr)
907 {
908 	unsigned int num = le16_to_cpu(shdr->CreditCharge);
909 
910 	return revert_current_mid(server, num > 0 ? num : 1);
911 }
912 
913 static inline __u16
914 get_mid(const struct smb_hdr *smb)
915 {
916 	return le16_to_cpu(smb->Mid);
917 }
918 
919 static inline bool
920 compare_mid(__u16 mid, const struct smb_hdr *smb)
921 {
922 	return mid == le16_to_cpu(smb->Mid);
923 }
924 
925 /*
926  * When the server supports very large reads and writes via POSIX extensions,
927  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
928  * including the RFC1001 length.
929  *
930  * Note that this might make for "interesting" allocation problems during
931  * writeback however as we have to allocate an array of pointers for the
932  * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
933  *
934  * For reads, there is a similar problem as we need to allocate an array
935  * of kvecs to handle the receive, though that should only need to be done
936  * once.
937  */
938 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
939 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
940 
941 /*
942  * When the server doesn't allow large posix writes, only allow a rsize/wsize
943  * of 2^17-1 minus the size of the call header. That allows for a read or
944  * write up to the maximum size described by RFC1002.
945  */
946 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
947 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
948 
949 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
950 
951 /*
952  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
953  * those values when posix extensions aren't in force. In actuality here, we
954  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
955  * to be ok with the extra byte even though Windows doesn't send writes that
956  * are that large.
957  *
958  * Citation:
959  *
960  * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
961  */
962 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
963 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
964 
965 /*
966  * Macros to allow the TCP_Server_Info->net field and related code to drop out
967  * when CONFIG_NET_NS isn't set.
968  */
969 
970 #ifdef CONFIG_NET_NS
971 
972 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
973 {
974 	return srv->net;
975 }
976 
977 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
978 {
979 	srv->net = net;
980 }
981 
982 #else
983 
984 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
985 {
986 	return &init_net;
987 }
988 
989 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
990 {
991 }
992 
993 #endif
994 
995 struct cifs_server_iface {
996 	struct list_head iface_head;
997 	struct kref refcount;
998 	size_t speed;
999 	size_t weight_fulfilled;
1000 	unsigned int num_channels;
1001 	unsigned int rdma_capable : 1;
1002 	unsigned int rss_capable : 1;
1003 	unsigned int is_active : 1; /* unset if non existent */
1004 	struct sockaddr_storage sockaddr;
1005 };
1006 
1007 /* release iface when last ref is dropped */
1008 static inline void
1009 release_iface(struct kref *ref)
1010 {
1011 	struct cifs_server_iface *iface = container_of(ref,
1012 						       struct cifs_server_iface,
1013 						       refcount);
1014 	kfree(iface);
1015 }
1016 
1017 struct cifs_chan {
1018 	unsigned int in_reconnect : 1; /* if session setup in progress for this channel */
1019 	struct TCP_Server_Info *server;
1020 	struct cifs_server_iface *iface; /* interface in use */
1021 	__u8 signkey[SMB3_SIGN_KEY_SIZE];
1022 };
1023 
1024 #define CIFS_SES_FLAG_SCALE_CHANNELS (0x1)
1025 
1026 /*
1027  * Session structure.  One of these for each uid session with a particular host
1028  */
1029 struct cifs_ses {
1030 	struct list_head smb_ses_list;
1031 	struct list_head rlist; /* reconnect list */
1032 	struct list_head tcon_list;
1033 	struct cifs_tcon *tcon_ipc;
1034 	spinlock_t ses_lock;  /* protect anything here that is not protected */
1035 	struct mutex session_mutex;
1036 	struct TCP_Server_Info *server;	/* pointer to server info */
1037 	int ses_count;		/* reference counter */
1038 	enum ses_status_enum ses_status;  /* updates protected by cifs_tcp_ses_lock */
1039 	unsigned int overrideSecFlg; /* if non-zero override global sec flags */
1040 	char *serverOS;		/* name of operating system underlying server */
1041 	char *serverNOS;	/* name of network operating system of server */
1042 	char *serverDomain;	/* security realm of server */
1043 	__u64 Suid;		/* remote smb uid  */
1044 	kuid_t linux_uid;	/* overriding owner of files on the mount */
1045 	kuid_t cred_uid;	/* owner of credentials */
1046 	unsigned int capabilities;
1047 	char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */
1048 	char *user_name;	/* must not be null except during init of sess
1049 				   and after mount option parsing we fill it */
1050 	char *domainName;
1051 	char *password;
1052 	char workstation_name[CIFS_MAX_WORKSTATION_LEN];
1053 	struct session_key auth_key;
1054 	struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
1055 	enum securityEnum sectype; /* what security flavor was specified? */
1056 	bool sign;		/* is signing required? */
1057 	bool domainAuto:1;
1058 	bool expired_pwd;  /* track if access denied or expired pwd so can know if need to update */
1059 	unsigned int flags;
1060 	__u16 session_flags;
1061 	__u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
1062 	__u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1063 	__u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1064 	__u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1065 
1066 	/*
1067 	 * Network interfaces available on the server this session is
1068 	 * connected to.
1069 	 *
1070 	 * Other channels can be opened by connecting and binding this
1071 	 * session to interfaces from this list.
1072 	 *
1073 	 * iface_lock should be taken when accessing any of these fields
1074 	 */
1075 	spinlock_t iface_lock;
1076 	/* ========= begin: protected by iface_lock ======== */
1077 	struct list_head iface_list;
1078 	size_t iface_count;
1079 	unsigned long iface_last_update; /* jiffies */
1080 	/* ========= end: protected by iface_lock ======== */
1081 
1082 	spinlock_t chan_lock;
1083 	/* ========= begin: protected by chan_lock ======== */
1084 #define CIFS_MAX_CHANNELS 16
1085 #define CIFS_INVAL_CHAN_INDEX (-1)
1086 #define CIFS_ALL_CHANNELS_SET(ses)	\
1087 	((1UL << (ses)->chan_count) - 1)
1088 #define CIFS_ALL_CHANS_GOOD(ses)		\
1089 	(!(ses)->chans_need_reconnect)
1090 #define CIFS_ALL_CHANS_NEED_RECONNECT(ses)	\
1091 	((ses)->chans_need_reconnect == CIFS_ALL_CHANNELS_SET(ses))
1092 #define CIFS_SET_ALL_CHANS_NEED_RECONNECT(ses)	\
1093 	((ses)->chans_need_reconnect = CIFS_ALL_CHANNELS_SET(ses))
1094 #define CIFS_CHAN_NEEDS_RECONNECT(ses, index)	\
1095 	test_bit((index), &(ses)->chans_need_reconnect)
1096 #define CIFS_CHAN_IN_RECONNECT(ses, index)	\
1097 	((ses)->chans[(index)].in_reconnect)
1098 
1099 	struct cifs_chan chans[CIFS_MAX_CHANNELS];
1100 	size_t chan_count;
1101 	size_t chan_max;
1102 	atomic_t chan_seq; /* round robin state */
1103 
1104 	/*
1105 	 * chans_need_reconnect is a bitmap indicating which of the channels
1106 	 * under this smb session needs to be reconnected.
1107 	 * If not multichannel session, only one bit will be used.
1108 	 *
1109 	 * We will ask for sess and tcon reconnection only if all the
1110 	 * channels are marked for needing reconnection. This will
1111 	 * enable the sessions on top to continue to live till any
1112 	 * of the channels below are active.
1113 	 */
1114 	unsigned long chans_need_reconnect;
1115 	/* ========= end: protected by chan_lock ======== */
1116 	struct cifs_ses *dfs_root_ses;
1117 	struct nls_table *local_nls;
1118 };
1119 
1120 static inline bool
1121 cap_unix(struct cifs_ses *ses)
1122 {
1123 	return ses->server->vals->cap_unix & ses->capabilities;
1124 }
1125 
1126 /*
1127  * common struct for holding inode info when searching for or updating an
1128  * inode with new info
1129  */
1130 
1131 #define CIFS_FATTR_JUNCTION		0x1
1132 #define CIFS_FATTR_DELETE_PENDING	0x2
1133 #define CIFS_FATTR_NEED_REVAL		0x4
1134 #define CIFS_FATTR_INO_COLLISION	0x8
1135 #define CIFS_FATTR_UNKNOWN_NLINK	0x10
1136 #define CIFS_FATTR_FAKE_ROOT_INO	0x20
1137 
1138 struct cifs_fattr {
1139 	u32		cf_flags;
1140 	u32		cf_cifsattrs;
1141 	u64		cf_uniqueid;
1142 	u64		cf_eof;
1143 	u64		cf_bytes;
1144 	u64		cf_createtime;
1145 	kuid_t		cf_uid;
1146 	kgid_t		cf_gid;
1147 	umode_t		cf_mode;
1148 	dev_t		cf_rdev;
1149 	unsigned int	cf_nlink;
1150 	unsigned int	cf_dtype;
1151 	struct timespec64 cf_atime;
1152 	struct timespec64 cf_mtime;
1153 	struct timespec64 cf_ctime;
1154 	u32             cf_cifstag;
1155 	char            *cf_symlink_target;
1156 };
1157 
1158 /*
1159  * there is one of these for each connection to a resource on a particular
1160  * session
1161  */
1162 struct cifs_tcon {
1163 	struct list_head tcon_list;
1164 	int tc_count;
1165 	struct list_head rlist; /* reconnect list */
1166 	spinlock_t tc_lock;  /* protect anything here that is not protected */
1167 	atomic_t num_local_opens;  /* num of all opens including disconnected */
1168 	atomic_t num_remote_opens; /* num of all network opens on server */
1169 	struct list_head openFileList;
1170 	spinlock_t open_file_lock; /* protects list above */
1171 	struct cifs_ses *ses;	/* pointer to session associated with */
1172 	char tree_name[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1173 	char *nativeFileSystem;
1174 	char *password;		/* for share-level security */
1175 	__u32 tid;		/* The 4 byte tree id */
1176 	__u16 Flags;		/* optional support bits */
1177 	enum tid_status_enum status;
1178 	atomic_t num_smbs_sent;
1179 	union {
1180 		struct {
1181 			atomic_t num_writes;
1182 			atomic_t num_reads;
1183 			atomic_t num_flushes;
1184 			atomic_t num_oplock_brks;
1185 			atomic_t num_opens;
1186 			atomic_t num_closes;
1187 			atomic_t num_deletes;
1188 			atomic_t num_mkdirs;
1189 			atomic_t num_posixopens;
1190 			atomic_t num_posixmkdirs;
1191 			atomic_t num_rmdirs;
1192 			atomic_t num_renames;
1193 			atomic_t num_t2renames;
1194 			atomic_t num_ffirst;
1195 			atomic_t num_fnext;
1196 			atomic_t num_fclose;
1197 			atomic_t num_hardlinks;
1198 			atomic_t num_symlinks;
1199 			atomic_t num_locks;
1200 			atomic_t num_acl_get;
1201 			atomic_t num_acl_set;
1202 		} cifs_stats;
1203 		struct {
1204 			atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1205 			atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1206 		} smb2_stats;
1207 	} stats;
1208 	__u64    bytes_read;
1209 	__u64    bytes_written;
1210 	spinlock_t stat_lock;  /* protects the two fields above */
1211 	time64_t stats_from_time;
1212 	FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1213 	FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1214 	FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1215 	bool ipc:1;   /* set if connection to IPC$ share (always also pipe) */
1216 	bool pipe:1;  /* set if connection to pipe share */
1217 	bool print:1; /* set if connection to printer share */
1218 	bool retry:1;
1219 	bool nocase:1;
1220 	bool nohandlecache:1; /* if strange server resource prob can turn off */
1221 	bool nodelete:1;
1222 	bool seal:1;      /* transport encryption for this mounted share */
1223 	bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
1224 				for this mount even if server would support */
1225 	bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1226 	bool local_lease:1; /* check leases (only) on local system not remote */
1227 	bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1228 	bool broken_sparse_sup; /* if server or share does not support sparse */
1229 	bool need_reconnect:1; /* connection reset, tid now invalid */
1230 	bool need_reopen_files:1; /* need to reopen tcon file handles */
1231 	bool use_resilient:1; /* use resilient instead of durable handles */
1232 	bool use_persistent:1; /* use persistent instead of durable handles */
1233 	bool no_lease:1;    /* Do not request leases on files or directories */
1234 	bool use_witness:1; /* use witness protocol */
1235 	__le32 capabilities;
1236 	__u32 share_flags;
1237 	__u32 maximal_access;
1238 	__u32 vol_serial_number;
1239 	__le64 vol_create_time;
1240 	__u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1241 	__u32 handle_timeout; /* persistent and durable handle timeout in ms */
1242 	__u32 ss_flags;		/* sector size flags */
1243 	__u32 perf_sector_size; /* best sector size for perf */
1244 	__u32 max_chunks;
1245 	__u32 max_bytes_chunk;
1246 	__u32 max_bytes_copy;
1247 	__u32 max_cached_dirs;
1248 #ifdef CONFIG_CIFS_FSCACHE
1249 	u64 resource_id;		/* server resource id */
1250 	bool fscache_acquired;		/* T if we've tried acquiring a cookie */
1251 	struct fscache_volume *fscache;	/* cookie for share */
1252 	struct mutex fscache_lock;	/* Prevent regetting a cookie */
1253 #endif
1254 	struct list_head pending_opens;	/* list of incomplete opens */
1255 	struct cached_fids *cfids;
1256 	/* BB add field for back pointer to sb struct(s)? */
1257 #ifdef CONFIG_CIFS_DFS_UPCALL
1258 	struct delayed_work dfs_cache_work;
1259 #endif
1260 	struct delayed_work	query_interfaces; /* query interfaces workqueue job */
1261 	char *origin_fullpath; /* canonical copy of smb3_fs_context::source */
1262 };
1263 
1264 /*
1265  * This is a refcounted and timestamped container for a tcon pointer. The
1266  * container holds a tcon reference. It is considered safe to free one of
1267  * these when the tl_count goes to 0. The tl_time is the time of the last
1268  * "get" on the container.
1269  */
1270 struct tcon_link {
1271 	struct rb_node		tl_rbnode;
1272 	kuid_t			tl_uid;
1273 	unsigned long		tl_flags;
1274 #define TCON_LINK_MASTER	0
1275 #define TCON_LINK_PENDING	1
1276 #define TCON_LINK_IN_TREE	2
1277 	unsigned long		tl_time;
1278 	atomic_t		tl_count;
1279 	struct cifs_tcon	*tl_tcon;
1280 };
1281 
1282 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1283 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1284 
1285 static inline struct cifs_tcon *
1286 tlink_tcon(struct tcon_link *tlink)
1287 {
1288 	return tlink->tl_tcon;
1289 }
1290 
1291 static inline struct tcon_link *
1292 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1293 {
1294 	return cifs_sb->master_tlink;
1295 }
1296 
1297 extern void cifs_put_tlink(struct tcon_link *tlink);
1298 
1299 static inline struct tcon_link *
1300 cifs_get_tlink(struct tcon_link *tlink)
1301 {
1302 	if (tlink && !IS_ERR(tlink))
1303 		atomic_inc(&tlink->tl_count);
1304 	return tlink;
1305 }
1306 
1307 /* This function is always expected to succeed */
1308 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1309 
1310 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1311 
1312 struct cifs_pending_open {
1313 	struct list_head olist;
1314 	struct tcon_link *tlink;
1315 	__u8 lease_key[16];
1316 	__u32 oplock;
1317 };
1318 
1319 struct cifs_deferred_close {
1320 	struct list_head dlist;
1321 	struct tcon_link *tlink;
1322 	__u16  netfid;
1323 	__u64  persistent_fid;
1324 	__u64  volatile_fid;
1325 };
1326 
1327 /*
1328  * This info hangs off the cifsFileInfo structure, pointed to by llist.
1329  * This is used to track byte stream locks on the file
1330  */
1331 struct cifsLockInfo {
1332 	struct list_head llist;	/* pointer to next cifsLockInfo */
1333 	struct list_head blist; /* pointer to locks blocked on this */
1334 	wait_queue_head_t block_q;
1335 	__u64 offset;
1336 	__u64 length;
1337 	__u32 pid;
1338 	__u16 type;
1339 	__u16 flags;
1340 };
1341 
1342 /*
1343  * One of these for each open instance of a file
1344  */
1345 struct cifs_search_info {
1346 	loff_t index_of_last_entry;
1347 	__u16 entries_in_buffer;
1348 	__u16 info_level;
1349 	__u32 resume_key;
1350 	char *ntwrk_buf_start;
1351 	char *srch_entries_start;
1352 	char *last_entry;
1353 	const char *presume_name;
1354 	unsigned int resume_name_len;
1355 	bool endOfSearch:1;
1356 	bool emptyDir:1;
1357 	bool unicode:1;
1358 	bool smallBuf:1; /* so we know which buf_release function to call */
1359 };
1360 
1361 #define ACL_NO_MODE	((umode_t)(-1))
1362 struct cifs_open_parms {
1363 	struct cifs_tcon *tcon;
1364 	struct cifs_sb_info *cifs_sb;
1365 	int disposition;
1366 	int desired_access;
1367 	int create_options;
1368 	const char *path;
1369 	struct cifs_fid *fid;
1370 	umode_t mode;
1371 	bool reconnect:1;
1372 };
1373 
1374 struct cifs_fid {
1375 	__u16 netfid;
1376 	__u64 persistent_fid;	/* persist file id for smb2 */
1377 	__u64 volatile_fid;	/* volatile file id for smb2 */
1378 	__u8 lease_key[SMB2_LEASE_KEY_SIZE];	/* lease key for smb2 */
1379 	__u8 create_guid[16];
1380 	__u32 access;
1381 	struct cifs_pending_open *pending_open;
1382 	unsigned int epoch;
1383 #ifdef CONFIG_CIFS_DEBUG2
1384 	__u64 mid;
1385 #endif /* CIFS_DEBUG2 */
1386 	bool purge_cache;
1387 };
1388 
1389 struct cifs_fid_locks {
1390 	struct list_head llist;
1391 	struct cifsFileInfo *cfile;	/* fid that owns locks */
1392 	struct list_head locks;		/* locks held by fid above */
1393 };
1394 
1395 struct cifsFileInfo {
1396 	/* following two lists are protected by tcon->open_file_lock */
1397 	struct list_head tlist;	/* pointer to next fid owned by tcon */
1398 	struct list_head flist;	/* next fid (file instance) for this inode */
1399 	/* lock list below protected by cifsi->lock_sem */
1400 	struct cifs_fid_locks *llist;	/* brlocks held by this fid */
1401 	kuid_t uid;		/* allows finding which FileInfo structure */
1402 	__u32 pid;		/* process id who opened file */
1403 	struct cifs_fid fid;	/* file id from remote */
1404 	struct list_head rlist; /* reconnect list */
1405 	/* BB add lock scope info here if needed */
1406 	/* lock scope id (0 if none) */
1407 	struct dentry *dentry;
1408 	struct tcon_link *tlink;
1409 	unsigned int f_flags;
1410 	bool invalidHandle:1;	/* file closed via session abend */
1411 	bool swapfile:1;
1412 	bool oplock_break_cancelled:1;
1413 	bool offload:1; /* offload final part of _put to a wq */
1414 	unsigned int oplock_epoch; /* epoch from the lease break */
1415 	__u32 oplock_level; /* oplock/lease level from the lease break */
1416 	int count;
1417 	spinlock_t file_info_lock; /* protects four flag/count fields above */
1418 	struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1419 	struct cifs_search_info srch_inf;
1420 	struct work_struct oplock_break; /* work for oplock breaks */
1421 	struct work_struct put; /* work for the final part of _put */
1422 	struct work_struct serverclose; /* work for serverclose */
1423 	struct delayed_work deferred;
1424 	bool deferred_close_scheduled; /* Flag to indicate close is scheduled */
1425 	char *symlink_target;
1426 };
1427 
1428 struct cifs_io_parms {
1429 	__u16 netfid;
1430 	__u64 persistent_fid;	/* persist file id for smb2 */
1431 	__u64 volatile_fid;	/* volatile file id for smb2 */
1432 	__u32 pid;
1433 	__u64 offset;
1434 	unsigned int length;
1435 	struct cifs_tcon *tcon;
1436 	struct TCP_Server_Info *server;
1437 };
1438 
1439 struct cifs_aio_ctx {
1440 	struct kref		refcount;
1441 	struct list_head	list;
1442 	struct mutex		aio_mutex;
1443 	struct completion	done;
1444 	struct iov_iter		iter;
1445 	struct kiocb		*iocb;
1446 	struct cifsFileInfo	*cfile;
1447 	struct bio_vec		*bv;
1448 	loff_t			pos;
1449 	unsigned int		nr_pinned_pages;
1450 	ssize_t			rc;
1451 	unsigned int		len;
1452 	unsigned int		total_len;
1453 	unsigned int		bv_need_unpin;	/* If ->bv[] needs unpinning */
1454 	bool			should_dirty;
1455 	/*
1456 	 * Indicates if this aio_ctx is for direct_io,
1457 	 * If yes, iter is a copy of the user passed iov_iter
1458 	 */
1459 	bool			direct_io;
1460 };
1461 
1462 /* asynchronous read support */
1463 struct cifs_readdata {
1464 	struct kref			refcount;
1465 	struct list_head		list;
1466 	struct completion		done;
1467 	struct cifsFileInfo		*cfile;
1468 	struct address_space		*mapping;
1469 	struct cifs_aio_ctx		*ctx;
1470 	__u64				offset;
1471 	ssize_t				got_bytes;
1472 	unsigned int			bytes;
1473 	pid_t				pid;
1474 	int				result;
1475 	struct work_struct		work;
1476 	struct iov_iter			iter;
1477 	struct kvec			iov[2];
1478 	struct TCP_Server_Info		*server;
1479 #ifdef CONFIG_CIFS_SMB_DIRECT
1480 	struct smbd_mr			*mr;
1481 #endif
1482 	struct cifs_credits		credits;
1483 };
1484 
1485 /* asynchronous write support */
1486 struct cifs_writedata {
1487 	struct kref			refcount;
1488 	struct list_head		list;
1489 	struct completion		done;
1490 	enum writeback_sync_modes	sync_mode;
1491 	struct work_struct		work;
1492 	struct cifsFileInfo		*cfile;
1493 	struct cifs_aio_ctx		*ctx;
1494 	struct iov_iter			iter;
1495 	struct bio_vec			*bv;
1496 	__u64				offset;
1497 	pid_t				pid;
1498 	unsigned int			bytes;
1499 	int				result;
1500 	struct TCP_Server_Info		*server;
1501 #ifdef CONFIG_CIFS_SMB_DIRECT
1502 	struct smbd_mr			*mr;
1503 #endif
1504 	struct cifs_credits		credits;
1505 };
1506 
1507 /*
1508  * Take a reference on the file private data. Must be called with
1509  * cfile->file_info_lock held.
1510  */
1511 static inline void
1512 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1513 {
1514 	++cifs_file->count;
1515 }
1516 
1517 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1518 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1519 		       bool offload);
1520 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1521 
1522 #define CIFS_CACHE_READ_FLG	1
1523 #define CIFS_CACHE_HANDLE_FLG	2
1524 #define CIFS_CACHE_RH_FLG	(CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1525 #define CIFS_CACHE_WRITE_FLG	4
1526 #define CIFS_CACHE_RW_FLG	(CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1527 #define CIFS_CACHE_RHW_FLG	(CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1528 
1529 #define CIFS_CACHE_READ(cinode) ((cinode->oplock & CIFS_CACHE_READ_FLG) || (CIFS_SB(cinode->netfs.inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RO_CACHE))
1530 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1531 #define CIFS_CACHE_WRITE(cinode) ((cinode->oplock & CIFS_CACHE_WRITE_FLG) || (CIFS_SB(cinode->netfs.inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RW_CACHE))
1532 
1533 /*
1534  * One of these for each file inode
1535  */
1536 
1537 struct cifsInodeInfo {
1538 	struct netfs_inode netfs; /* Netfslib context and vfs inode */
1539 	bool can_cache_brlcks;
1540 	struct list_head llist;	/* locks helb by this inode */
1541 	/*
1542 	 * NOTE: Some code paths call down_read(lock_sem) twice, so
1543 	 * we must always use cifs_down_write() instead of down_write()
1544 	 * for this semaphore to avoid deadlocks.
1545 	 */
1546 	struct rw_semaphore lock_sem;	/* protect the fields above */
1547 	/* BB add in lists for dirty pages i.e. write caching info for oplock */
1548 	struct list_head openFileList;
1549 	spinlock_t	open_file_lock;	/* protects openFileList */
1550 	__u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1551 	unsigned int oplock;		/* oplock/lease level we have */
1552 	unsigned int epoch;		/* used to track lease state changes */
1553 #define CIFS_INODE_PENDING_OPLOCK_BREAK   (0) /* oplock break in progress */
1554 #define CIFS_INODE_PENDING_WRITERS	  (1) /* Writes in progress */
1555 #define CIFS_INODE_FLAG_UNUSED		  (2) /* Unused flag */
1556 #define CIFS_INO_DELETE_PENDING		  (3) /* delete pending on server */
1557 #define CIFS_INO_INVALID_MAPPING	  (4) /* pagecache is invalid */
1558 #define CIFS_INO_LOCK			  (5) /* lock bit for synchronization */
1559 #define CIFS_INO_MODIFIED_ATTR            (6) /* Indicate change in mtime/ctime */
1560 #define CIFS_INO_CLOSE_ON_LOCK            (7) /* Not to defer the close when lock is set */
1561 	unsigned long flags;
1562 	spinlock_t writers_lock;
1563 	unsigned int writers;		/* Number of writers on this inode */
1564 	unsigned long time;		/* jiffies of last update of inode */
1565 	u64  server_eof;		/* current file size on server -- protected by i_lock */
1566 	u64  uniqueid;			/* server inode number */
1567 	u64  createtime;		/* creation time on server */
1568 	__u8 lease_key[SMB2_LEASE_KEY_SIZE];	/* lease key for this inode */
1569 	struct list_head deferred_closes; /* list of deferred closes */
1570 	spinlock_t deferred_lock; /* protection on deferred list */
1571 	bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */
1572 	char *symlink_target;
1573 	__u32 reparse_tag;
1574 };
1575 
1576 static inline struct cifsInodeInfo *
1577 CIFS_I(struct inode *inode)
1578 {
1579 	return container_of(inode, struct cifsInodeInfo, netfs.inode);
1580 }
1581 
1582 static inline struct cifs_sb_info *
1583 CIFS_SB(struct super_block *sb)
1584 {
1585 	return sb->s_fs_info;
1586 }
1587 
1588 static inline struct cifs_sb_info *
1589 CIFS_FILE_SB(struct file *file)
1590 {
1591 	return CIFS_SB(file_inode(file)->i_sb);
1592 }
1593 
1594 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1595 {
1596 	if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1597 		return '/';
1598 	else
1599 		return '\\';
1600 }
1601 
1602 static inline void
1603 convert_delimiter(char *path, char delim)
1604 {
1605 	char old_delim, *pos;
1606 
1607 	if (delim == '/')
1608 		old_delim = '\\';
1609 	else
1610 		old_delim = '/';
1611 
1612 	pos = path;
1613 	while ((pos = strchr(pos, old_delim)))
1614 		*pos = delim;
1615 }
1616 
1617 #define cifs_stats_inc atomic_inc
1618 
1619 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1620 					    unsigned int bytes)
1621 {
1622 	if (bytes) {
1623 		spin_lock(&tcon->stat_lock);
1624 		tcon->bytes_written += bytes;
1625 		spin_unlock(&tcon->stat_lock);
1626 	}
1627 }
1628 
1629 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1630 					 unsigned int bytes)
1631 {
1632 	spin_lock(&tcon->stat_lock);
1633 	tcon->bytes_read += bytes;
1634 	spin_unlock(&tcon->stat_lock);
1635 }
1636 
1637 
1638 /*
1639  * This is the prototype for the mid receive function. This function is for
1640  * receiving the rest of the SMB frame, starting with the WordCount (which is
1641  * just after the MID in struct smb_hdr). Note:
1642  *
1643  * - This will be called by cifsd, with no locks held.
1644  * - The mid will still be on the pending_mid_q.
1645  * - mid->resp_buf will point to the current buffer.
1646  *
1647  * Returns zero on a successful receive, or an error. The receive state in
1648  * the TCP_Server_Info will also be updated.
1649  */
1650 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1651 			    struct mid_q_entry *mid);
1652 
1653 /*
1654  * This is the prototype for the mid callback function. This is called once the
1655  * mid has been received off of the socket. When creating one, take special
1656  * care to avoid deadlocks. Things to bear in mind:
1657  *
1658  * - it will be called by cifsd, with no locks held
1659  * - the mid will be removed from any lists
1660  */
1661 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1662 
1663 /*
1664  * This is the protopyte for mid handle function. This is called once the mid
1665  * has been recognized after decryption of the message.
1666  */
1667 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1668 			    struct mid_q_entry *mid);
1669 
1670 /* one of these for every pending CIFS request to the server */
1671 struct mid_q_entry {
1672 	struct list_head qhead;	/* mids waiting on reply from this server */
1673 	struct kref refcount;
1674 	struct TCP_Server_Info *server;	/* server corresponding to this mid */
1675 	__u64 mid;		/* multiplex id */
1676 	__u16 credits;		/* number of credits consumed by this mid */
1677 	__u16 credits_received;	/* number of credits from the response */
1678 	__u32 pid;		/* process id */
1679 	__u32 sequence_number;  /* for CIFS signing */
1680 	unsigned long when_alloc;  /* when mid was created */
1681 #ifdef CONFIG_CIFS_STATS2
1682 	unsigned long when_sent; /* time when smb send finished */
1683 	unsigned long when_received; /* when demux complete (taken off wire) */
1684 #endif
1685 	mid_receive_t *receive; /* call receive callback */
1686 	mid_callback_t *callback; /* call completion callback */
1687 	mid_handle_t *handle; /* call handle mid callback */
1688 	void *callback_data;	  /* general purpose pointer for callback */
1689 	struct task_struct *creator;
1690 	void *resp_buf;		/* pointer to received SMB header */
1691 	unsigned int resp_buf_size;
1692 	int mid_state;	/* wish this were enum but can not pass to wait_event */
1693 	unsigned int mid_flags;
1694 	__le16 command;		/* smb command code */
1695 	unsigned int optype;	/* operation type */
1696 	bool large_buf:1;	/* if valid response, is pointer to large buf */
1697 	bool multiRsp:1;	/* multiple trans2 responses for one request  */
1698 	bool multiEnd:1;	/* both received */
1699 	bool decrypted:1;	/* decrypted entry */
1700 };
1701 
1702 struct close_cancelled_open {
1703 	struct cifs_fid         fid;
1704 	struct cifs_tcon        *tcon;
1705 	struct work_struct      work;
1706 	__u64 mid;
1707 	__u16 cmd;
1708 };
1709 
1710 /*	Make code in transport.c a little cleaner by moving
1711 	update of optional stats into function below */
1712 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1713 {
1714 	atomic_inc(&server->in_send);
1715 }
1716 
1717 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1718 {
1719 	atomic_dec(&server->in_send);
1720 }
1721 
1722 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1723 {
1724 	atomic_inc(&server->num_waiters);
1725 }
1726 
1727 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1728 {
1729 	atomic_dec(&server->num_waiters);
1730 }
1731 
1732 #ifdef CONFIG_CIFS_STATS2
1733 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1734 {
1735 	mid->when_sent = jiffies;
1736 }
1737 #else
1738 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1739 {
1740 }
1741 #endif
1742 
1743 /* for pending dnotify requests */
1744 struct dir_notify_req {
1745 	struct list_head lhead;
1746 	__le16 Pid;
1747 	__le16 PidHigh;
1748 	__u16 Mid;
1749 	__u16 Tid;
1750 	__u16 Uid;
1751 	__u16 netfid;
1752 	__u32 filter; /* CompletionFilter (for multishot) */
1753 	int multishot;
1754 	struct file *pfile;
1755 };
1756 
1757 struct dfs_info3_param {
1758 	int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1759 	int path_consumed;
1760 	int server_type;
1761 	int ref_flag;
1762 	char *path_name;
1763 	char *node_name;
1764 	int ttl;
1765 };
1766 
1767 struct file_list {
1768 	struct list_head list;
1769 	struct cifsFileInfo *cfile;
1770 };
1771 
1772 struct cifs_mount_ctx {
1773 	struct cifs_sb_info *cifs_sb;
1774 	struct smb3_fs_context *fs_ctx;
1775 	unsigned int xid;
1776 	struct TCP_Server_Info *server;
1777 	struct cifs_ses *ses;
1778 	struct cifs_tcon *tcon;
1779 };
1780 
1781 static inline void __free_dfs_info_param(struct dfs_info3_param *param)
1782 {
1783 	kfree(param->path_name);
1784 	kfree(param->node_name);
1785 }
1786 
1787 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1788 {
1789 	if (param)
1790 		__free_dfs_info_param(param);
1791 }
1792 
1793 static inline void zfree_dfs_info_param(struct dfs_info3_param *param)
1794 {
1795 	if (param) {
1796 		__free_dfs_info_param(param);
1797 		memset(param, 0, sizeof(*param));
1798 	}
1799 }
1800 
1801 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1802 				       int number_of_items)
1803 {
1804 	int i;
1805 
1806 	if ((number_of_items == 0) || (param == NULL))
1807 		return;
1808 	for (i = 0; i < number_of_items; i++) {
1809 		kfree(param[i].path_name);
1810 		kfree(param[i].node_name);
1811 	}
1812 	kfree(param);
1813 }
1814 
1815 static inline bool is_interrupt_error(int error)
1816 {
1817 	switch (error) {
1818 	case -EINTR:
1819 	case -ERESTARTSYS:
1820 	case -ERESTARTNOHAND:
1821 	case -ERESTARTNOINTR:
1822 		return true;
1823 	}
1824 	return false;
1825 }
1826 
1827 static inline bool is_retryable_error(int error)
1828 {
1829 	if (is_interrupt_error(error) || error == -EAGAIN)
1830 		return true;
1831 	return false;
1832 }
1833 
1834 static inline bool is_replayable_error(int error)
1835 {
1836 	if (error == -EAGAIN || error == -ECONNABORTED)
1837 		return true;
1838 	return false;
1839 }
1840 
1841 
1842 /* cifs_get_writable_file() flags */
1843 #define FIND_WR_ANY         0
1844 #define FIND_WR_FSUID_ONLY  1
1845 #define FIND_WR_WITH_DELETE 2
1846 
1847 #define   MID_FREE 0
1848 #define   MID_REQUEST_ALLOCATED 1
1849 #define   MID_REQUEST_SUBMITTED 2
1850 #define   MID_RESPONSE_RECEIVED 4
1851 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
1852 #define   MID_RESPONSE_MALFORMED 0x10
1853 #define   MID_SHUTDOWN		 0x20
1854 #define   MID_RESPONSE_READY 0x40 /* ready for other process handle the rsp */
1855 
1856 /* Flags */
1857 #define   MID_WAIT_CANCELLED	 1 /* Cancelled while waiting for response */
1858 #define   MID_DELETED            2 /* Mid has been dequeued/deleted */
1859 
1860 /* Types of response buffer returned from SendReceive2 */
1861 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
1862 #define   CIFS_SMALL_BUFFER     1
1863 #define   CIFS_LARGE_BUFFER     2
1864 #define   CIFS_IOVEC            4    /* array of response buffers */
1865 
1866 /* Type of Request to SendReceive2 */
1867 #define   CIFS_BLOCKING_OP      1    /* operation can block */
1868 #define   CIFS_NON_BLOCKING     2    /* do not block waiting for credits */
1869 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
1870 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
1871 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
1872 #define   CIFS_NO_RSP_BUF   0x040    /* no response buffer required */
1873 
1874 /* Type of request operation */
1875 #define   CIFS_ECHO_OP            0x080  /* echo request */
1876 #define   CIFS_OBREAK_OP          0x0100 /* oplock break request */
1877 #define   CIFS_NEG_OP             0x0200 /* negotiate request */
1878 #define   CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */
1879 /* Lower bitmask values are reserved by others below. */
1880 #define   CIFS_SESS_OP            0x2000 /* session setup request */
1881 #define   CIFS_OP_MASK            0x2780 /* mask request type */
1882 
1883 #define   CIFS_HAS_CREDITS        0x0400 /* already has credits */
1884 #define   CIFS_TRANSFORM_REQ      0x0800 /* transform request before sending */
1885 #define   CIFS_NO_SRV_RSP         0x1000 /* there is no server response */
1886 
1887 /* Security Flags: indicate type of session setup needed */
1888 #define   CIFSSEC_MAY_SIGN	0x00001
1889 #define   CIFSSEC_MAY_NTLMV2	0x00004
1890 #define   CIFSSEC_MAY_KRB5	0x00008
1891 #define   CIFSSEC_MAY_SEAL	0x00040 /* not supported yet */
1892 #define   CIFSSEC_MAY_NTLMSSP	0x00080 /* raw ntlmssp with ntlmv2 */
1893 
1894 #define   CIFSSEC_MUST_SIGN	0x01001
1895 /* note that only one of the following can be set so the
1896 result of setting MUST flags more than once will be to
1897 require use of the stronger protocol */
1898 #define   CIFSSEC_MUST_NTLMV2	0x04004
1899 #define   CIFSSEC_MUST_KRB5	0x08008
1900 #ifdef CONFIG_CIFS_UPCALL
1901 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
1902 #else
1903 #define	  CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1904 #endif /* UPCALL */
1905 #define   CIFSSEC_MUST_SEAL	0x40040 /* not supported yet */
1906 #define   CIFSSEC_MUST_NTLMSSP	0x80080 /* raw ntlmssp with ntlmv2 */
1907 
1908 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1909 #define   CIFSSEC_MAX (CIFSSEC_MUST_NTLMV2)
1910 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1911 /*
1912  *****************************************************************
1913  * All constants go here
1914  *****************************************************************
1915  */
1916 
1917 #define UID_HASH (16)
1918 
1919 /*
1920  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1921  * following to be declared.
1922  */
1923 
1924 /****************************************************************************
1925  * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according
1926  * to the locking order. i.e. if two locks are to be held together, the lock that
1927  * appears higher in this list needs to be taken before the other.
1928  *
1929  * If you hold a lock that is lower in this list, and you need to take a higher lock
1930  * (or if you think that one of the functions that you're calling may need to), first
1931  * drop the lock you hold, pick up the higher lock, then the lower one. This will
1932  * ensure that locks are picked up only in one direction in the below table
1933  * (top to bottom).
1934  *
1935  * Also, if you expect a function to be called with a lock held, explicitly document
1936  * this in the comments on top of your function definition.
1937  *
1938  * And also, try to keep the critical sections (lock hold time) to be as minimal as
1939  * possible. Blocking / calling other functions with a lock held always increase
1940  * the risk of a possible deadlock.
1941  *
1942  * Following this rule will avoid unnecessary deadlocks, which can get really hard to
1943  * debug. Also, any new lock that you introduce, please add to this list in the correct
1944  * order.
1945  *
1946  * Please populate this list whenever you introduce new locks in your changes. Or in
1947  * case I've missed some existing locks. Please ensure that it's added in the list
1948  * based on the locking order expected.
1949  *
1950  * =====================================================================================
1951  * Lock				Protects			Initialization fn
1952  * =====================================================================================
1953  * vol_list_lock
1954  * vol_info->ctx_lock		vol_info->ctx
1955  * cifs_sb_info->tlink_tree_lock	cifs_sb_info->tlink_tree	cifs_setup_cifs_sb
1956  * TCP_Server_Info->		TCP_Server_Info			cifs_get_tcp_session
1957  * reconnect_mutex
1958  * TCP_Server_Info->srv_mutex	TCP_Server_Info			cifs_get_tcp_session
1959  * cifs_ses->session_mutex		cifs_ses		sesInfoAlloc
1960  *				cifs_tcon
1961  * cifs_tcon->open_file_lock	cifs_tcon->openFileList		tconInfoAlloc
1962  *				cifs_tcon->pending_opens
1963  * cifs_tcon->stat_lock		cifs_tcon->bytes_read		tconInfoAlloc
1964  *				cifs_tcon->bytes_written
1965  * cifs_tcp_ses_lock		cifs_tcp_ses_list		sesInfoAlloc
1966  * GlobalMid_Lock		GlobalMaxActiveXid		init_cifs
1967  *				GlobalCurrentXid
1968  *				GlobalTotalActiveXid
1969  * TCP_Server_Info->srv_lock	(anything in struct not protected by another lock and can change)
1970  * TCP_Server_Info->mid_lock	TCP_Server_Info->pending_mid_q	cifs_get_tcp_session
1971  *				->CurrentMid
1972  *				(any changes in mid_q_entry fields)
1973  * TCP_Server_Info->req_lock	TCP_Server_Info->in_flight	cifs_get_tcp_session
1974  *				->credits
1975  *				->echo_credits
1976  *				->oplock_credits
1977  *				->reconnect_instance
1978  * cifs_ses->ses_lock		(anything that is not protected by another lock and can change)
1979  * cifs_ses->iface_lock		cifs_ses->iface_list		sesInfoAlloc
1980  *				->iface_count
1981  *				->iface_last_update
1982  * cifs_ses->chan_lock		cifs_ses->chans
1983  *				->chans_need_reconnect
1984  *				->chans_in_reconnect
1985  * cifs_tcon->tc_lock		(anything that is not protected by another lock and can change)
1986  * cifsInodeInfo->open_file_lock	cifsInodeInfo->openFileList	cifs_alloc_inode
1987  * cifsInodeInfo->writers_lock	cifsInodeInfo->writers		cifsInodeInfo_alloc
1988  * cifsInodeInfo->lock_sem	cifsInodeInfo->llist		cifs_init_once
1989  *				->can_cache_brlcks
1990  * cifsInodeInfo->deferred_lock	cifsInodeInfo->deferred_closes	cifsInodeInfo_alloc
1991  * cached_fid->fid_mutex		cifs_tcon->crfid		tcon_info_alloc
1992  * cifsFileInfo->fh_mutex		cifsFileInfo			cifs_new_fileinfo
1993  * cifsFileInfo->file_info_lock	cifsFileInfo->count		cifs_new_fileinfo
1994  *				->invalidHandle			initiate_cifs_search
1995  *				->oplock_break_cancelled
1996  * cifs_aio_ctx->aio_mutex		cifs_aio_ctx			cifs_aio_ctx_alloc
1997  ****************************************************************************/
1998 
1999 #ifdef DECLARE_GLOBALS_HERE
2000 #define GLOBAL_EXTERN
2001 #else
2002 #define GLOBAL_EXTERN extern
2003 #endif
2004 
2005 /*
2006  * the list of TCP_Server_Info structures, ie each of the sockets
2007  * connecting our client to a distinct server (ip address), is
2008  * chained together by cifs_tcp_ses_list. The list of all our SMB
2009  * sessions (and from that the tree connections) can be found
2010  * by iterating over cifs_tcp_ses_list
2011  */
2012 extern struct list_head		cifs_tcp_ses_list;
2013 
2014 /*
2015  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
2016  * tcp session, and the list of tcon's per smb session. It also protects
2017  * the reference counters for the server, smb session, and tcon.
2018  * generally the locks should be taken in order tcp_ses_lock before
2019  * tcon->open_file_lock and that before file->file_info_lock since the
2020  * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
2021  */
2022 extern spinlock_t		cifs_tcp_ses_lock;
2023 
2024 /*
2025  * Global transaction id (XID) information
2026  */
2027 extern unsigned int GlobalCurrentXid;	/* protected by GlobalMid_Sem */
2028 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
2029 extern unsigned int GlobalMaxActiveXid;	/* prot by GlobalMid_Sem */
2030 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */
2031 
2032 /*
2033  *  Global counters, updated atomically
2034  */
2035 extern atomic_t sesInfoAllocCount;
2036 extern atomic_t tconInfoAllocCount;
2037 extern atomic_t tcpSesNextId;
2038 extern atomic_t tcpSesAllocCount;
2039 extern atomic_t tcpSesReconnectCount;
2040 extern atomic_t tconInfoReconnectCount;
2041 
2042 /* Various Debug counters */
2043 extern atomic_t buf_alloc_count;	/* current number allocated  */
2044 extern atomic_t small_buf_alloc_count;
2045 #ifdef CONFIG_CIFS_STATS2
2046 extern atomic_t total_buf_alloc_count; /* total allocated over all time */
2047 extern atomic_t total_small_buf_alloc_count;
2048 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
2049 #endif
2050 
2051 /* Misc globals */
2052 extern bool enable_oplocks; /* enable or disable oplocks */
2053 extern bool lookupCacheEnabled;
2054 extern unsigned int global_secflags;	/* if on, session setup sent
2055 				with more secure ntlmssp2 challenge/resp */
2056 extern unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
2057 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
2058 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
2059 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */
2060 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
2061 extern unsigned int CIFSMaxBufSize;  /* max size not including hdr */
2062 extern unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
2063 extern unsigned int cifs_min_small;  /* min size of small buf pool */
2064 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
2065 extern unsigned int dir_cache_timeout; /* max time for directory lease caching of dir */
2066 extern bool disable_legacy_dialects;  /* forbid vers=1.0 and vers=2.0 mounts */
2067 extern atomic_t mid_count;
2068 
2069 void cifs_oplock_break(struct work_struct *work);
2070 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
2071 void smb2_deferred_work_close(struct work_struct *work);
2072 
2073 extern const struct slow_work_ops cifs_oplock_break_ops;
2074 extern struct workqueue_struct *cifsiod_wq;
2075 extern struct workqueue_struct *decrypt_wq;
2076 extern struct workqueue_struct *fileinfo_put_wq;
2077 extern struct workqueue_struct *cifsoplockd_wq;
2078 extern struct workqueue_struct *deferredclose_wq;
2079 extern struct workqueue_struct *serverclose_wq;
2080 extern __u32 cifs_lock_secret;
2081 
2082 extern mempool_t *cifs_mid_poolp;
2083 
2084 /* Operations for different SMB versions */
2085 #define SMB1_VERSION_STRING	"1.0"
2086 #define SMB20_VERSION_STRING    "2.0"
2087 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
2088 extern struct smb_version_operations smb1_operations;
2089 extern struct smb_version_values smb1_values;
2090 extern struct smb_version_operations smb20_operations;
2091 extern struct smb_version_values smb20_values;
2092 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
2093 #define SMB21_VERSION_STRING	"2.1"
2094 extern struct smb_version_operations smb21_operations;
2095 extern struct smb_version_values smb21_values;
2096 #define SMBDEFAULT_VERSION_STRING "default"
2097 extern struct smb_version_values smbdefault_values;
2098 #define SMB3ANY_VERSION_STRING "3"
2099 extern struct smb_version_values smb3any_values;
2100 #define SMB30_VERSION_STRING	"3.0"
2101 extern struct smb_version_operations smb30_operations;
2102 extern struct smb_version_values smb30_values;
2103 #define SMB302_VERSION_STRING	"3.02"
2104 #define ALT_SMB302_VERSION_STRING "3.0.2"
2105 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2106 extern struct smb_version_values smb302_values;
2107 #define SMB311_VERSION_STRING	"3.1.1"
2108 #define ALT_SMB311_VERSION_STRING "3.11"
2109 extern struct smb_version_operations smb311_operations;
2110 extern struct smb_version_values smb311_values;
2111 
2112 static inline char *get_security_type_str(enum securityEnum sectype)
2113 {
2114 	switch (sectype) {
2115 	case RawNTLMSSP:
2116 		return "RawNTLMSSP";
2117 	case Kerberos:
2118 		return "Kerberos";
2119 	case NTLMv2:
2120 		return "NTLMv2";
2121 	default:
2122 		return "Unknown";
2123 	}
2124 }
2125 
2126 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2127 {
2128 	return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2129 }
2130 
2131 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2132 {
2133 	/*
2134 	 * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2135 	 * Subsystem Notifies That a Share Is a DFS Share.
2136 	 *
2137 	 * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2138 	 * Application Updates a Share.
2139 	 */
2140 	if (!tcon || !tcon->ses || !tcon->ses->server)
2141 		return false;
2142 	return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2143 		tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2144 }
2145 
2146 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon,
2147 					   const struct dfs_info3_param *ref)
2148 {
2149 	/*
2150 	 * Check if all targets are capable of handling DFS referrals as per
2151 	 * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL.
2152 	 */
2153 	return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER));
2154 }
2155 
2156 static inline u64 cifs_flock_len(const struct file_lock *fl)
2157 {
2158 	return (u64)fl->fl_end - fl->fl_start + 1;
2159 }
2160 
2161 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses)
2162 {
2163 	if (WARN_ON_ONCE(!ses || !ses->server))
2164 		return 0;
2165 	/*
2166 	 * Make workstation name no more than 15 chars when using insecure dialects as some legacy
2167 	 * servers do require it during NTLMSSP.
2168 	 */
2169 	if (ses->server->dialect <= SMB20_PROT_ID)
2170 		return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL);
2171 	return sizeof(ses->workstation_name);
2172 }
2173 
2174 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src)
2175 {
2176 	memcpy(dst, src, (size_t)((u8 *)&src->AccessFlags - (u8 *)src));
2177 	dst->AccessFlags = src->AccessFlags;
2178 	dst->CurrentByteOffset = src->CurrentByteOffset;
2179 	dst->Mode = src->Mode;
2180 	dst->AlignmentRequirement = src->AlignmentRequirement;
2181 	dst->FileNameLength = src->FileNameLength;
2182 }
2183 
2184 static inline int cifs_get_num_sgs(const struct smb_rqst *rqst,
2185 				   int num_rqst,
2186 				   const u8 *sig)
2187 {
2188 	unsigned int len, skip;
2189 	unsigned int nents = 0;
2190 	unsigned long addr;
2191 	size_t data_size;
2192 	int i, j;
2193 
2194 	/*
2195 	 * The first rqst has a transform header where the first 20 bytes are
2196 	 * not part of the encrypted blob.
2197 	 */
2198 	skip = 20;
2199 
2200 	/* Assumes the first rqst has a transform header as the first iov.
2201 	 * I.e.
2202 	 * rqst[0].rq_iov[0]  is transform header
2203 	 * rqst[0].rq_iov[1+] data to be encrypted/decrypted
2204 	 * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
2205 	 */
2206 	for (i = 0; i < num_rqst; i++) {
2207 		data_size = iov_iter_count(&rqst[i].rq_iter);
2208 
2209 		/* We really don't want a mixture of pinned and unpinned pages
2210 		 * in the sglist.  It's hard to keep track of which is what.
2211 		 * Instead, we convert to a BVEC-type iterator higher up.
2212 		 */
2213 		if (data_size &&
2214 		    WARN_ON_ONCE(user_backed_iter(&rqst[i].rq_iter)))
2215 			return -EIO;
2216 
2217 		/* We also don't want to have any extra refs or pins to clean
2218 		 * up in the sglist.
2219 		 */
2220 		if (data_size &&
2221 		    WARN_ON_ONCE(iov_iter_extract_will_pin(&rqst[i].rq_iter)))
2222 			return -EIO;
2223 
2224 		for (j = 0; j < rqst[i].rq_nvec; j++) {
2225 			struct kvec *iov = &rqst[i].rq_iov[j];
2226 
2227 			addr = (unsigned long)iov->iov_base + skip;
2228 			if (unlikely(is_vmalloc_addr((void *)addr))) {
2229 				len = iov->iov_len - skip;
2230 				nents += DIV_ROUND_UP(offset_in_page(addr) + len,
2231 						      PAGE_SIZE);
2232 			} else {
2233 				nents++;
2234 			}
2235 			skip = 0;
2236 		}
2237 		if (data_size)
2238 			nents += iov_iter_npages(&rqst[i].rq_iter, INT_MAX);
2239 	}
2240 	nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
2241 	return nents;
2242 }
2243 
2244 /* We can not use the normal sg_set_buf() as we will sometimes pass a
2245  * stack object as buf.
2246  */
2247 static inline void cifs_sg_set_buf(struct sg_table *sgtable,
2248 				   const void *buf,
2249 				   unsigned int buflen)
2250 {
2251 	unsigned long addr = (unsigned long)buf;
2252 	unsigned int off = offset_in_page(addr);
2253 
2254 	addr &= PAGE_MASK;
2255 	if (unlikely(is_vmalloc_addr((void *)addr))) {
2256 		do {
2257 			unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
2258 
2259 			sg_set_page(&sgtable->sgl[sgtable->nents++],
2260 				    vmalloc_to_page((void *)addr), len, off);
2261 
2262 			off = 0;
2263 			addr += PAGE_SIZE;
2264 			buflen -= len;
2265 		} while (buflen);
2266 	} else {
2267 		sg_set_page(&sgtable->sgl[sgtable->nents++],
2268 			    virt_to_page((void *)addr), buflen, off);
2269 	}
2270 }
2271 
2272 struct smb2_compound_vars {
2273 	struct cifs_open_parms oparms;
2274 	struct kvec rsp_iov[3];
2275 	struct smb_rqst rqst[3];
2276 	struct kvec open_iov[SMB2_CREATE_IOV_SIZE];
2277 	struct kvec qi_iov;
2278 	struct kvec io_iov[SMB2_IOCTL_IOV_SIZE];
2279 	struct kvec si_iov[SMB2_SET_INFO_IOV_SIZE];
2280 	struct kvec close_iov;
2281 	struct smb2_file_rename_info rename_info;
2282 	struct smb2_file_link_info link_info;
2283 };
2284 
2285 static inline bool cifs_ses_exiting(struct cifs_ses *ses)
2286 {
2287 	bool ret;
2288 
2289 	spin_lock(&ses->ses_lock);
2290 	ret = ses->ses_status == SES_EXITING;
2291 	spin_unlock(&ses->ses_lock);
2292 	return ret;
2293 }
2294 
2295 #endif	/* _CIFS_GLOB_H */
2296