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