xref: /linux/fs/smb/client/cifsglob.h (revision 7f4f3b14e8079ecde096bd734af10e30d40c27b7)
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 				   struct kvec *rsp_iov,
598 				   struct cifs_open_info_data *data);
599 	int (*create_reparse_symlink)(const unsigned int xid,
600 				      struct inode *inode,
601 				      struct dentry *dentry,
602 				      struct cifs_tcon *tcon,
603 				      const char *full_path,
604 				      const char *symname);
605 };
606 
607 struct smb_version_values {
608 	char		*version_string;
609 	__u16		protocol_id;
610 	__u32		req_capabilities;
611 	__u32		large_lock_type;
612 	__u32		exclusive_lock_type;
613 	__u32		shared_lock_type;
614 	__u32		unlock_lock_type;
615 	size_t		header_preamble_size;
616 	size_t		header_size;
617 	size_t		max_header_size;
618 	size_t		read_rsp_size;
619 	__le16		lock_cmd;
620 	unsigned int	cap_unix;
621 	unsigned int	cap_nt_find;
622 	unsigned int	cap_large_files;
623 	__u16		signing_enabled;
624 	__u16		signing_required;
625 	size_t		create_lease_size;
626 };
627 
628 #define HEADER_SIZE(server) (server->vals->header_size)
629 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
630 #define HEADER_PREAMBLE_SIZE(server) (server->vals->header_preamble_size)
631 #define MID_HEADER_SIZE(server) (HEADER_SIZE(server) - 1 - HEADER_PREAMBLE_SIZE(server))
632 
633 /**
634  * CIFS superblock mount flags (mnt_cifs_flags) to consider when
635  * trying to reuse existing superblock for a new mount
636  */
637 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
638 			 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
639 			 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
640 			 CIFS_MOUNT_MAP_SFM_CHR | \
641 			 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
642 			 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
643 			 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
644 			 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
645 			 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
646 			 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
647 			 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
648 			 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
649 			 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
650 			 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
651 
652 /**
653  * Generic VFS superblock mount flags (s_flags) to consider when
654  * trying to reuse existing superblock for a new mount
655  */
656 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
657 		      SB_NODEV | SB_SYNCHRONOUS)
658 
659 struct cifs_mnt_data {
660 	struct cifs_sb_info *cifs_sb;
661 	struct smb3_fs_context *ctx;
662 	int flags;
663 };
664 
665 static inline unsigned int
666 get_rfc1002_length(void *buf)
667 {
668 	return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
669 }
670 
671 static inline void
672 inc_rfc1001_len(void *buf, int count)
673 {
674 	be32_add_cpu((__be32 *)buf, count);
675 }
676 
677 struct TCP_Server_Info {
678 	struct list_head tcp_ses_list;
679 	struct list_head smb_ses_list;
680 	spinlock_t srv_lock;  /* protect anything here that is not protected */
681 	__u64 conn_id; /* connection identifier (useful for debugging) */
682 	int srv_count; /* reference counter */
683 	/* 15 character server name + 0x20 16th byte indicating type = srv */
684 	char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
685 	struct smb_version_operations	*ops;
686 	struct smb_version_values	*vals;
687 	/* updates to tcpStatus protected by cifs_tcp_ses_lock */
688 	enum statusEnum tcpStatus; /* what we think the status is */
689 	char *hostname; /* hostname portion of UNC string */
690 	struct socket *ssocket;
691 	struct sockaddr_storage dstaddr;
692 	struct sockaddr_storage srcaddr; /* locally bind to this IP */
693 #ifdef CONFIG_NET_NS
694 	struct net *net;
695 #endif
696 	wait_queue_head_t response_q;
697 	wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
698 	spinlock_t mid_lock;  /* protect mid queue and it's entries */
699 	struct list_head pending_mid_q;
700 	bool noblocksnd;		/* use blocking sendmsg */
701 	bool noautotune;		/* do not autotune send buf sizes */
702 	bool nosharesock;
703 	bool tcp_nodelay;
704 	bool terminate;
705 	unsigned int credits;  /* send no more requests at once */
706 	unsigned int max_credits; /* can override large 32000 default at mnt */
707 	unsigned int in_flight;  /* number of requests on the wire to server */
708 	unsigned int max_in_flight; /* max number of requests that were on wire */
709 	spinlock_t req_lock;  /* protect the two values above */
710 	struct mutex _srv_mutex;
711 	unsigned int nofs_flag;
712 	struct task_struct *tsk;
713 	char server_GUID[16];
714 	__u16 sec_mode;
715 	bool sign; /* is signing enabled on this connection? */
716 	bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
717 	bool session_estab; /* mark when very first sess is established */
718 	int echo_credits;  /* echo reserved slots */
719 	int oplock_credits;  /* oplock break reserved slots */
720 	bool echoes:1; /* enable echoes */
721 	__u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
722 	u16 dialect; /* dialect index that server chose */
723 	bool oplocks:1; /* enable oplocks */
724 	unsigned int maxReq;	/* Clients should submit no more */
725 	/* than maxReq distinct unanswered SMBs to the server when using  */
726 	/* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
727 	unsigned int maxBuf;	/* maxBuf specifies the maximum */
728 	/* message size the server can send or receive for non-raw SMBs */
729 	/* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
730 	/* when socket is setup (and during reconnect) before NegProt sent */
731 	unsigned int max_rw;	/* maxRw specifies the maximum */
732 	/* message size the server can send or receive for */
733 	/* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
734 	unsigned int capabilities; /* selective disabling of caps by smb sess */
735 	int timeAdj;  /* Adjust for difference in server time zone in sec */
736 	__u64 CurrentMid;         /* multiplex id - rotating counter, protected by GlobalMid_Lock */
737 	char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
738 	/* 16th byte of RFC1001 workstation name is always null */
739 	char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
740 	__u32 sequence_number; /* for signing, protected by srv_mutex */
741 	__u32 reconnect_instance; /* incremented on each reconnect */
742 	struct session_key session_key;
743 	unsigned long lstrp; /* when we got last response from this server */
744 	struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
745 #define	CIFS_NEGFLAVOR_UNENCAP	1	/* wct == 17, but no ext_sec */
746 #define	CIFS_NEGFLAVOR_EXTENDED	2	/* wct == 17, ext_sec bit set */
747 	char	negflavor;	/* NEGOTIATE response flavor */
748 	/* extended security flavors that server supports */
749 	bool	sec_ntlmssp;		/* supports NTLMSSP */
750 	bool	sec_kerberosu2u;	/* supports U2U Kerberos */
751 	bool	sec_kerberos;		/* supports plain Kerberos */
752 	bool	sec_mskerberos;		/* supports legacy MS Kerberos */
753 	bool	large_buf;		/* is current buffer large? */
754 	/* use SMBD connection instead of socket */
755 	bool	rdma;
756 	/* point to the SMBD connection if RDMA is used instead of socket */
757 	struct smbd_connection *smbd_conn;
758 	struct delayed_work	echo; /* echo ping workqueue job */
759 	char	*smallbuf;	/* pointer to current "small" buffer */
760 	char	*bigbuf;	/* pointer to current "big" buffer */
761 	/* Total size of this PDU. Only valid from cifs_demultiplex_thread */
762 	unsigned int pdu_size;
763 	unsigned int total_read; /* total amount of data read in this pass */
764 	atomic_t in_send; /* requests trying to send */
765 	atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
766 #ifdef CONFIG_CIFS_STATS2
767 	atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
768 	atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
769 	__u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
770 	__u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
771 	__u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
772 #endif /* STATS2 */
773 	unsigned int	max_read;
774 	unsigned int	max_write;
775 	unsigned int	min_offload;
776 	unsigned int	retrans;
777 	struct {
778 		bool requested; /* "compress" mount option set*/
779 		bool enabled; /* actually negotiated with server */
780 		__le16 alg; /* preferred alg negotiated with server */
781 	} compression;
782 	__u16	signing_algorithm;
783 	__le16	cipher_type;
784 	 /* save initial negprot hash */
785 	__u8	preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
786 	bool	signing_negotiated; /* true if valid signing context rcvd from server */
787 	bool	posix_ext_supported;
788 	struct delayed_work reconnect; /* reconnect workqueue job */
789 	struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
790 	unsigned long echo_interval;
791 
792 	/*
793 	 * Number of targets available for reconnect. The more targets
794 	 * the more tasks have to wait to let the demultiplex thread
795 	 * reconnect.
796 	 */
797 	int nr_targets;
798 	bool noblockcnt; /* use non-blocking connect() */
799 
800 	/*
801 	 * If this is a session channel,
802 	 * primary_server holds the ref-counted
803 	 * pointer to primary channel connection for the session.
804 	 */
805 #define SERVER_IS_CHAN(server)	(!!(server)->primary_server)
806 	struct TCP_Server_Info *primary_server;
807 	__u16 channel_sequence_num;  /* incremented on primary channel on each chan reconnect */
808 
809 #ifdef CONFIG_CIFS_SWN_UPCALL
810 	bool use_swn_dstaddr;
811 	struct sockaddr_storage swn_dstaddr;
812 #endif
813 	struct mutex refpath_lock; /* protects leaf_fullpath */
814 	/*
815 	 * leaf_fullpath: Canonical DFS referral path related to this
816 	 *                connection.
817 	 *                It is used in DFS cache refresher, reconnect and may
818 	 *                change due to nested DFS links.
819 	 *
820 	 * Protected by @refpath_lock and @srv_lock.  The @refpath_lock is
821 	 * mostly used for not requiring a copy of @leaf_fullpath when getting
822 	 * cached or new DFS referrals (which might also sleep during I/O).
823 	 * While @srv_lock is held for making string and NULL comparisons against
824 	 * both fields as in mount(2) and cache refresh.
825 	 *
826 	 * format: \\HOST\SHARE[\OPTIONAL PATH]
827 	 */
828 	char *leaf_fullpath;
829 	bool dfs_conn:1;
830 };
831 
832 static inline bool is_smb1(struct TCP_Server_Info *server)
833 {
834 	return HEADER_PREAMBLE_SIZE(server) != 0;
835 }
836 
837 static inline void cifs_server_lock(struct TCP_Server_Info *server)
838 {
839 	unsigned int nofs_flag = memalloc_nofs_save();
840 
841 	mutex_lock(&server->_srv_mutex);
842 	server->nofs_flag = nofs_flag;
843 }
844 
845 static inline void cifs_server_unlock(struct TCP_Server_Info *server)
846 {
847 	unsigned int nofs_flag = server->nofs_flag;
848 
849 	mutex_unlock(&server->_srv_mutex);
850 	memalloc_nofs_restore(nofs_flag);
851 }
852 
853 struct cifs_credits {
854 	unsigned int value;
855 	unsigned int instance;
856 	unsigned int in_flight_check;
857 	unsigned int rreq_debug_id;
858 	unsigned int rreq_debug_index;
859 };
860 
861 static inline unsigned int
862 in_flight(struct TCP_Server_Info *server)
863 {
864 	unsigned int num;
865 
866 	spin_lock(&server->req_lock);
867 	num = server->in_flight;
868 	spin_unlock(&server->req_lock);
869 	return num;
870 }
871 
872 static inline bool
873 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
874 {
875 	int num;
876 
877 	spin_lock(&server->req_lock);
878 	num = *credits;
879 	spin_unlock(&server->req_lock);
880 	return num >= num_credits;
881 }
882 
883 static inline void
884 add_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
885 	    const int optype)
886 {
887 	server->ops->add_credits(server, credits, optype);
888 }
889 
890 static inline void
891 add_credits_and_wake_if(struct TCP_Server_Info *server,
892 			struct cifs_credits *credits, const int optype)
893 {
894 	if (credits->value) {
895 		server->ops->add_credits(server, credits, optype);
896 		wake_up(&server->request_q);
897 		credits->value = 0;
898 	}
899 }
900 
901 static inline void
902 set_credits(struct TCP_Server_Info *server, const int val)
903 {
904 	server->ops->set_credits(server, val);
905 }
906 
907 static inline int
908 adjust_credits(struct TCP_Server_Info *server, struct cifs_io_subrequest *subreq,
909 	       unsigned int /* enum smb3_rw_credits_trace */ trace)
910 {
911 	return server->ops->adjust_credits ?
912 		server->ops->adjust_credits(server, subreq, trace) : 0;
913 }
914 
915 static inline __le64
916 get_next_mid64(struct TCP_Server_Info *server)
917 {
918 	return cpu_to_le64(server->ops->get_next_mid(server));
919 }
920 
921 static inline __le16
922 get_next_mid(struct TCP_Server_Info *server)
923 {
924 	__u16 mid = server->ops->get_next_mid(server);
925 	/*
926 	 * The value in the SMB header should be little endian for easy
927 	 * on-the-wire decoding.
928 	 */
929 	return cpu_to_le16(mid);
930 }
931 
932 static inline void
933 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
934 {
935 	if (server->ops->revert_current_mid)
936 		server->ops->revert_current_mid(server, val);
937 }
938 
939 static inline void
940 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
941 			    const struct smb2_hdr *shdr)
942 {
943 	unsigned int num = le16_to_cpu(shdr->CreditCharge);
944 
945 	return revert_current_mid(server, num > 0 ? num : 1);
946 }
947 
948 static inline __u16
949 get_mid(const struct smb_hdr *smb)
950 {
951 	return le16_to_cpu(smb->Mid);
952 }
953 
954 static inline bool
955 compare_mid(__u16 mid, const struct smb_hdr *smb)
956 {
957 	return mid == le16_to_cpu(smb->Mid);
958 }
959 
960 /*
961  * When the server supports very large reads and writes via POSIX extensions,
962  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
963  * including the RFC1001 length.
964  *
965  * Note that this might make for "interesting" allocation problems during
966  * writeback however as we have to allocate an array of pointers for the
967  * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
968  *
969  * For reads, there is a similar problem as we need to allocate an array
970  * of kvecs to handle the receive, though that should only need to be done
971  * once.
972  */
973 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
974 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
975 
976 /*
977  * When the server doesn't allow large posix writes, only allow a rsize/wsize
978  * of 2^17-1 minus the size of the call header. That allows for a read or
979  * write up to the maximum size described by RFC1002.
980  */
981 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
982 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
983 
984 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
985 
986 /*
987  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
988  * those values when posix extensions aren't in force. In actuality here, we
989  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
990  * to be ok with the extra byte even though Windows doesn't send writes that
991  * are that large.
992  *
993  * Citation:
994  *
995  * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
996  */
997 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
998 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
999 
1000 /*
1001  * Macros to allow the TCP_Server_Info->net field and related code to drop out
1002  * when CONFIG_NET_NS isn't set.
1003  */
1004 
1005 #ifdef CONFIG_NET_NS
1006 
1007 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
1008 {
1009 	return srv->net;
1010 }
1011 
1012 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
1013 {
1014 	srv->net = net;
1015 }
1016 
1017 #else
1018 
1019 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
1020 {
1021 	return &init_net;
1022 }
1023 
1024 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
1025 {
1026 }
1027 
1028 #endif
1029 
1030 struct cifs_server_iface {
1031 	struct list_head iface_head;
1032 	struct kref refcount;
1033 	size_t speed;
1034 	size_t weight_fulfilled;
1035 	unsigned int num_channels;
1036 	unsigned int rdma_capable : 1;
1037 	unsigned int rss_capable : 1;
1038 	unsigned int is_active : 1; /* unset if non existent */
1039 	struct sockaddr_storage sockaddr;
1040 };
1041 
1042 /* release iface when last ref is dropped */
1043 static inline void
1044 release_iface(struct kref *ref)
1045 {
1046 	struct cifs_server_iface *iface = container_of(ref,
1047 						       struct cifs_server_iface,
1048 						       refcount);
1049 	kfree(iface);
1050 }
1051 
1052 struct cifs_chan {
1053 	unsigned int in_reconnect : 1; /* if session setup in progress for this channel */
1054 	struct TCP_Server_Info *server;
1055 	struct cifs_server_iface *iface; /* interface in use */
1056 	__u8 signkey[SMB3_SIGN_KEY_SIZE];
1057 };
1058 
1059 #define CIFS_SES_FLAG_SCALE_CHANNELS (0x1)
1060 
1061 /*
1062  * Session structure.  One of these for each uid session with a particular host
1063  */
1064 struct cifs_ses {
1065 	struct list_head smb_ses_list;
1066 	struct list_head rlist; /* reconnect list */
1067 	struct list_head tcon_list;
1068 	struct list_head dlist; /* dfs list */
1069 	struct cifs_tcon *tcon_ipc;
1070 	spinlock_t ses_lock;  /* protect anything here that is not protected */
1071 	struct mutex session_mutex;
1072 	struct TCP_Server_Info *server;	/* pointer to server info */
1073 	int ses_count;		/* reference counter */
1074 	enum ses_status_enum ses_status;  /* updates protected by cifs_tcp_ses_lock */
1075 	unsigned int overrideSecFlg; /* if non-zero override global sec flags */
1076 	char *serverOS;		/* name of operating system underlying server */
1077 	char *serverNOS;	/* name of network operating system of server */
1078 	char *serverDomain;	/* security realm of server */
1079 	__u64 Suid;		/* remote smb uid  */
1080 	kuid_t linux_uid;	/* overriding owner of files on the mount */
1081 	kuid_t cred_uid;	/* owner of credentials */
1082 	unsigned int capabilities;
1083 	char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */
1084 	char *user_name;	/* must not be null except during init of sess
1085 				   and after mount option parsing we fill it */
1086 	char *domainName;
1087 	char *password;
1088 	char *password2; /* When key rotation used, new password may be set before it expires */
1089 	char workstation_name[CIFS_MAX_WORKSTATION_LEN];
1090 	struct session_key auth_key;
1091 	struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
1092 	enum securityEnum sectype; /* what security flavor was specified? */
1093 	enum upcall_target_enum upcall_target; /* what upcall target was specified? */
1094 	bool sign;		/* is signing required? */
1095 	bool domainAuto:1;
1096 	bool expired_pwd;  /* track if access denied or expired pwd so can know if need to update */
1097 	unsigned int flags;
1098 	__u16 session_flags;
1099 	__u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
1100 	__u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1101 	__u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1102 	__u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1103 
1104 	/*
1105 	 * Network interfaces available on the server this session is
1106 	 * connected to.
1107 	 *
1108 	 * Other channels can be opened by connecting and binding this
1109 	 * session to interfaces from this list.
1110 	 *
1111 	 * iface_lock should be taken when accessing any of these fields
1112 	 */
1113 	spinlock_t iface_lock;
1114 	/* ========= begin: protected by iface_lock ======== */
1115 	struct list_head iface_list;
1116 	size_t iface_count;
1117 	unsigned long iface_last_update; /* jiffies */
1118 	/* ========= end: protected by iface_lock ======== */
1119 
1120 	spinlock_t chan_lock;
1121 	/* ========= begin: protected by chan_lock ======== */
1122 #define CIFS_MAX_CHANNELS 16
1123 #define CIFS_INVAL_CHAN_INDEX (-1)
1124 #define CIFS_ALL_CHANNELS_SET(ses)	\
1125 	((1UL << (ses)->chan_count) - 1)
1126 #define CIFS_ALL_CHANS_GOOD(ses)		\
1127 	(!(ses)->chans_need_reconnect)
1128 #define CIFS_ALL_CHANS_NEED_RECONNECT(ses)	\
1129 	((ses)->chans_need_reconnect == CIFS_ALL_CHANNELS_SET(ses))
1130 #define CIFS_SET_ALL_CHANS_NEED_RECONNECT(ses)	\
1131 	((ses)->chans_need_reconnect = CIFS_ALL_CHANNELS_SET(ses))
1132 #define CIFS_CHAN_NEEDS_RECONNECT(ses, index)	\
1133 	test_bit((index), &(ses)->chans_need_reconnect)
1134 #define CIFS_CHAN_IN_RECONNECT(ses, index)	\
1135 	((ses)->chans[(index)].in_reconnect)
1136 
1137 	struct cifs_chan chans[CIFS_MAX_CHANNELS];
1138 	size_t chan_count;
1139 	size_t chan_max;
1140 	atomic_t chan_seq; /* round robin state */
1141 
1142 	/*
1143 	 * chans_need_reconnect is a bitmap indicating which of the channels
1144 	 * under this smb session needs to be reconnected.
1145 	 * If not multichannel session, only one bit will be used.
1146 	 *
1147 	 * We will ask for sess and tcon reconnection only if all the
1148 	 * channels are marked for needing reconnection. This will
1149 	 * enable the sessions on top to continue to live till any
1150 	 * of the channels below are active.
1151 	 */
1152 	unsigned long chans_need_reconnect;
1153 	/* ========= end: protected by chan_lock ======== */
1154 	struct cifs_ses *dfs_root_ses;
1155 	struct nls_table *local_nls;
1156 };
1157 
1158 static inline bool
1159 cap_unix(struct cifs_ses *ses)
1160 {
1161 	return ses->server->vals->cap_unix & ses->capabilities;
1162 }
1163 
1164 /*
1165  * common struct for holding inode info when searching for or updating an
1166  * inode with new info
1167  */
1168 
1169 #define CIFS_FATTR_JUNCTION		0x1
1170 #define CIFS_FATTR_DELETE_PENDING	0x2
1171 #define CIFS_FATTR_NEED_REVAL		0x4
1172 #define CIFS_FATTR_INO_COLLISION	0x8
1173 #define CIFS_FATTR_UNKNOWN_NLINK	0x10
1174 #define CIFS_FATTR_FAKE_ROOT_INO	0x20
1175 
1176 struct cifs_fattr {
1177 	u32		cf_flags;
1178 	u32		cf_cifsattrs;
1179 	u64		cf_uniqueid;
1180 	u64		cf_eof;
1181 	u64		cf_bytes;
1182 	u64		cf_createtime;
1183 	kuid_t		cf_uid;
1184 	kgid_t		cf_gid;
1185 	umode_t		cf_mode;
1186 	dev_t		cf_rdev;
1187 	unsigned int	cf_nlink;
1188 	unsigned int	cf_dtype;
1189 	struct timespec64 cf_atime;
1190 	struct timespec64 cf_mtime;
1191 	struct timespec64 cf_ctime;
1192 	u32             cf_cifstag;
1193 	char            *cf_symlink_target;
1194 };
1195 
1196 /*
1197  * there is one of these for each connection to a resource on a particular
1198  * session
1199  */
1200 struct cifs_tcon {
1201 	struct list_head tcon_list;
1202 	int debug_id;		/* Debugging for tracing */
1203 	int tc_count;
1204 	struct list_head rlist; /* reconnect list */
1205 	spinlock_t tc_lock;  /* protect anything here that is not protected */
1206 	atomic_t num_local_opens;  /* num of all opens including disconnected */
1207 	atomic_t num_remote_opens; /* num of all network opens on server */
1208 	struct list_head openFileList;
1209 	spinlock_t open_file_lock; /* protects list above */
1210 	struct cifs_ses *ses;	/* pointer to session associated with */
1211 	char tree_name[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1212 	char *nativeFileSystem;
1213 	char *password;		/* for share-level security */
1214 	__u32 tid;		/* The 4 byte tree id */
1215 	__u16 Flags;		/* optional support bits */
1216 	enum tid_status_enum status;
1217 	atomic_t num_smbs_sent;
1218 	union {
1219 		struct {
1220 			atomic_t num_writes;
1221 			atomic_t num_reads;
1222 			atomic_t num_flushes;
1223 			atomic_t num_oplock_brks;
1224 			atomic_t num_opens;
1225 			atomic_t num_closes;
1226 			atomic_t num_deletes;
1227 			atomic_t num_mkdirs;
1228 			atomic_t num_posixopens;
1229 			atomic_t num_posixmkdirs;
1230 			atomic_t num_rmdirs;
1231 			atomic_t num_renames;
1232 			atomic_t num_t2renames;
1233 			atomic_t num_ffirst;
1234 			atomic_t num_fnext;
1235 			atomic_t num_fclose;
1236 			atomic_t num_hardlinks;
1237 			atomic_t num_symlinks;
1238 			atomic_t num_locks;
1239 			atomic_t num_acl_get;
1240 			atomic_t num_acl_set;
1241 		} cifs_stats;
1242 		struct {
1243 			atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1244 			atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1245 		} smb2_stats;
1246 	} stats;
1247 	__u64    bytes_read;
1248 	__u64    bytes_written;
1249 	spinlock_t stat_lock;  /* protects the two fields above */
1250 	time64_t stats_from_time;
1251 	FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1252 	FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1253 	FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1254 	bool ipc:1;   /* set if connection to IPC$ share (always also pipe) */
1255 	bool pipe:1;  /* set if connection to pipe share */
1256 	bool print:1; /* set if connection to printer share */
1257 	bool retry:1;
1258 	bool nocase:1;
1259 	bool nohandlecache:1; /* if strange server resource prob can turn off */
1260 	bool nodelete:1;
1261 	bool seal:1;      /* transport encryption for this mounted share */
1262 	bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
1263 				for this mount even if server would support */
1264 	bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1265 	bool local_lease:1; /* check leases (only) on local system not remote */
1266 	bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1267 	bool broken_sparse_sup; /* if server or share does not support sparse */
1268 	bool need_reconnect:1; /* connection reset, tid now invalid */
1269 	bool need_reopen_files:1; /* need to reopen tcon file handles */
1270 	bool use_resilient:1; /* use resilient instead of durable handles */
1271 	bool use_persistent:1; /* use persistent instead of durable handles */
1272 	bool no_lease:1;    /* Do not request leases on files or directories */
1273 	bool use_witness:1; /* use witness protocol */
1274 	__le32 capabilities;
1275 	__u32 share_flags;
1276 	__u32 maximal_access;
1277 	__u32 vol_serial_number;
1278 	__le64 vol_create_time;
1279 	__u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1280 	__u32 handle_timeout; /* persistent and durable handle timeout in ms */
1281 	__u32 ss_flags;		/* sector size flags */
1282 	__u32 perf_sector_size; /* best sector size for perf */
1283 	__u32 max_chunks;
1284 	__u32 max_bytes_chunk;
1285 	__u32 max_bytes_copy;
1286 	__u32 max_cached_dirs;
1287 #ifdef CONFIG_CIFS_FSCACHE
1288 	u64 resource_id;		/* server resource id */
1289 	bool fscache_acquired;		/* T if we've tried acquiring a cookie */
1290 	struct fscache_volume *fscache;	/* cookie for share */
1291 	struct mutex fscache_lock;	/* Prevent regetting a cookie */
1292 #endif
1293 	struct list_head pending_opens;	/* list of incomplete opens */
1294 	struct cached_fids *cfids;
1295 	/* BB add field for back pointer to sb struct(s)? */
1296 #ifdef CONFIG_CIFS_DFS_UPCALL
1297 	struct delayed_work dfs_cache_work;
1298 	struct list_head dfs_ses_list;
1299 #endif
1300 	struct delayed_work	query_interfaces; /* query interfaces workqueue job */
1301 	char *origin_fullpath; /* canonical copy of smb3_fs_context::source */
1302 };
1303 
1304 /*
1305  * This is a refcounted and timestamped container for a tcon pointer. The
1306  * container holds a tcon reference. It is considered safe to free one of
1307  * these when the tl_count goes to 0. The tl_time is the time of the last
1308  * "get" on the container.
1309  */
1310 struct tcon_link {
1311 	struct rb_node		tl_rbnode;
1312 	kuid_t			tl_uid;
1313 	unsigned long		tl_flags;
1314 #define TCON_LINK_MASTER	0
1315 #define TCON_LINK_PENDING	1
1316 #define TCON_LINK_IN_TREE	2
1317 	unsigned long		tl_time;
1318 	atomic_t		tl_count;
1319 	struct cifs_tcon	*tl_tcon;
1320 };
1321 
1322 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1323 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1324 
1325 static inline struct cifs_tcon *
1326 tlink_tcon(struct tcon_link *tlink)
1327 {
1328 	return tlink->tl_tcon;
1329 }
1330 
1331 static inline struct tcon_link *
1332 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1333 {
1334 	return cifs_sb->master_tlink;
1335 }
1336 
1337 extern void cifs_put_tlink(struct tcon_link *tlink);
1338 
1339 static inline struct tcon_link *
1340 cifs_get_tlink(struct tcon_link *tlink)
1341 {
1342 	if (tlink && !IS_ERR(tlink))
1343 		atomic_inc(&tlink->tl_count);
1344 	return tlink;
1345 }
1346 
1347 /* This function is always expected to succeed */
1348 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1349 
1350 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1351 
1352 struct cifs_pending_open {
1353 	struct list_head olist;
1354 	struct tcon_link *tlink;
1355 	__u8 lease_key[16];
1356 	__u32 oplock;
1357 };
1358 
1359 struct cifs_deferred_close {
1360 	struct list_head dlist;
1361 	struct tcon_link *tlink;
1362 	__u16  netfid;
1363 	__u64  persistent_fid;
1364 	__u64  volatile_fid;
1365 };
1366 
1367 /*
1368  * This info hangs off the cifsFileInfo structure, pointed to by llist.
1369  * This is used to track byte stream locks on the file
1370  */
1371 struct cifsLockInfo {
1372 	struct list_head llist;	/* pointer to next cifsLockInfo */
1373 	struct list_head blist; /* pointer to locks blocked on this */
1374 	wait_queue_head_t block_q;
1375 	__u64 offset;
1376 	__u64 length;
1377 	__u32 pid;
1378 	__u16 type;
1379 	__u16 flags;
1380 };
1381 
1382 /*
1383  * One of these for each open instance of a file
1384  */
1385 struct cifs_search_info {
1386 	loff_t index_of_last_entry;
1387 	__u16 entries_in_buffer;
1388 	__u16 info_level;
1389 	__u32 resume_key;
1390 	char *ntwrk_buf_start;
1391 	char *srch_entries_start;
1392 	char *last_entry;
1393 	const char *presume_name;
1394 	unsigned int resume_name_len;
1395 	bool endOfSearch:1;
1396 	bool emptyDir:1;
1397 	bool unicode:1;
1398 	bool smallBuf:1; /* so we know which buf_release function to call */
1399 };
1400 
1401 #define ACL_NO_MODE	((umode_t)(-1))
1402 struct cifs_open_parms {
1403 	struct cifs_tcon *tcon;
1404 	struct cifs_sb_info *cifs_sb;
1405 	int disposition;
1406 	int desired_access;
1407 	int create_options;
1408 	const char *path;
1409 	struct cifs_fid *fid;
1410 	umode_t mode;
1411 	bool reconnect:1;
1412 	bool replay:1; /* indicates that this open is for a replay */
1413 	struct kvec *ea_cctx;
1414 };
1415 
1416 struct cifs_fid {
1417 	__u16 netfid;
1418 	__u64 persistent_fid;	/* persist file id for smb2 */
1419 	__u64 volatile_fid;	/* volatile file id for smb2 */
1420 	__u8 lease_key[SMB2_LEASE_KEY_SIZE];	/* lease key for smb2 */
1421 	__u8 create_guid[16];
1422 	__u32 access;
1423 	struct cifs_pending_open *pending_open;
1424 	unsigned int epoch;
1425 #ifdef CONFIG_CIFS_DEBUG2
1426 	__u64 mid;
1427 #endif /* CIFS_DEBUG2 */
1428 	bool purge_cache;
1429 };
1430 
1431 struct cifs_fid_locks {
1432 	struct list_head llist;
1433 	struct cifsFileInfo *cfile;	/* fid that owns locks */
1434 	struct list_head locks;		/* locks held by fid above */
1435 };
1436 
1437 struct cifsFileInfo {
1438 	/* following two lists are protected by tcon->open_file_lock */
1439 	struct list_head tlist;	/* pointer to next fid owned by tcon */
1440 	struct list_head flist;	/* next fid (file instance) for this inode */
1441 	/* lock list below protected by cifsi->lock_sem */
1442 	struct cifs_fid_locks *llist;	/* brlocks held by this fid */
1443 	kuid_t uid;		/* allows finding which FileInfo structure */
1444 	__u32 pid;		/* process id who opened file */
1445 	struct cifs_fid fid;	/* file id from remote */
1446 	struct list_head rlist; /* reconnect list */
1447 	/* BB add lock scope info here if needed */
1448 	/* lock scope id (0 if none) */
1449 	struct dentry *dentry;
1450 	struct tcon_link *tlink;
1451 	unsigned int f_flags;
1452 	bool invalidHandle:1;	/* file closed via session abend */
1453 	bool swapfile:1;
1454 	bool oplock_break_cancelled:1;
1455 	bool status_file_deleted:1; /* file has been deleted */
1456 	bool offload:1; /* offload final part of _put to a wq */
1457 	unsigned int oplock_epoch; /* epoch from the lease break */
1458 	__u32 oplock_level; /* oplock/lease level from the lease break */
1459 	int count;
1460 	spinlock_t file_info_lock; /* protects four flag/count fields above */
1461 	struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1462 	struct cifs_search_info srch_inf;
1463 	struct work_struct oplock_break; /* work for oplock breaks */
1464 	struct work_struct put; /* work for the final part of _put */
1465 	struct work_struct serverclose; /* work for serverclose */
1466 	struct delayed_work deferred;
1467 	bool deferred_close_scheduled; /* Flag to indicate close is scheduled */
1468 	char *symlink_target;
1469 };
1470 
1471 struct cifs_io_parms {
1472 	__u16 netfid;
1473 	__u64 persistent_fid;	/* persist file id for smb2 */
1474 	__u64 volatile_fid;	/* volatile file id for smb2 */
1475 	__u32 pid;
1476 	__u64 offset;
1477 	unsigned int length;
1478 	struct cifs_tcon *tcon;
1479 	struct TCP_Server_Info *server;
1480 };
1481 
1482 struct cifs_io_request {
1483 	struct netfs_io_request		rreq;
1484 	struct cifsFileInfo		*cfile;
1485 	struct TCP_Server_Info		*server;
1486 	pid_t				pid;
1487 };
1488 
1489 /* asynchronous read support */
1490 struct cifs_io_subrequest {
1491 	union {
1492 		struct netfs_io_subrequest subreq;
1493 		struct netfs_io_request *rreq;
1494 		struct cifs_io_request *req;
1495 	};
1496 	ssize_t				got_bytes;
1497 	unsigned int			xid;
1498 	int				result;
1499 	bool				have_xid;
1500 	bool				replay;
1501 	struct kvec			iov[2];
1502 	struct TCP_Server_Info		*server;
1503 #ifdef CONFIG_CIFS_SMB_DIRECT
1504 	struct smbd_mr			*mr;
1505 #endif
1506 	struct cifs_credits		credits;
1507 };
1508 
1509 /*
1510  * Take a reference on the file private data. Must be called with
1511  * cfile->file_info_lock held.
1512  */
1513 static inline void
1514 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1515 {
1516 	++cifs_file->count;
1517 }
1518 
1519 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1520 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1521 		       bool offload);
1522 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1523 
1524 #define CIFS_CACHE_READ_FLG	1
1525 #define CIFS_CACHE_HANDLE_FLG	2
1526 #define CIFS_CACHE_RH_FLG	(CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1527 #define CIFS_CACHE_WRITE_FLG	4
1528 #define CIFS_CACHE_RW_FLG	(CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1529 #define CIFS_CACHE_RHW_FLG	(CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1530 
1531 #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))
1532 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1533 #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))
1534 
1535 /*
1536  * One of these for each file inode
1537  */
1538 
1539 struct cifsInodeInfo {
1540 	struct netfs_inode netfs; /* Netfslib context and vfs inode */
1541 	bool can_cache_brlcks;
1542 	struct list_head llist;	/* locks helb by this inode */
1543 	/*
1544 	 * NOTE: Some code paths call down_read(lock_sem) twice, so
1545 	 * we must always use cifs_down_write() instead of down_write()
1546 	 * for this semaphore to avoid deadlocks.
1547 	 */
1548 	struct rw_semaphore lock_sem;	/* protect the fields above */
1549 	/* BB add in lists for dirty pages i.e. write caching info for oplock */
1550 	struct list_head openFileList;
1551 	spinlock_t	open_file_lock;	/* protects openFileList */
1552 	__u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1553 	unsigned int oplock;		/* oplock/lease level we have */
1554 	unsigned int epoch;		/* used to track lease state changes */
1555 #define CIFS_INODE_PENDING_OPLOCK_BREAK   (0) /* oplock break in progress */
1556 #define CIFS_INODE_PENDING_WRITERS	  (1) /* Writes in progress */
1557 #define CIFS_INODE_FLAG_UNUSED		  (2) /* Unused flag */
1558 #define CIFS_INO_DELETE_PENDING		  (3) /* delete pending on server */
1559 #define CIFS_INO_INVALID_MAPPING	  (4) /* pagecache is invalid */
1560 #define CIFS_INO_LOCK			  (5) /* lock bit for synchronization */
1561 #define CIFS_INO_CLOSE_ON_LOCK            (7) /* Not to defer the close when lock is set */
1562 	unsigned long flags;
1563 	spinlock_t writers_lock;
1564 	unsigned int writers;		/* Number of writers on this inode */
1565 	unsigned long time;		/* jiffies of last update of inode */
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 #define   CIFS_COMPRESS_REQ       0x4000 /* compress request before sending */
1887 
1888 /* Security Flags: indicate type of session setup needed */
1889 #define   CIFSSEC_MAY_SIGN	0x00001
1890 #define   CIFSSEC_MAY_NTLMV2	0x00004
1891 #define   CIFSSEC_MAY_KRB5	0x00008
1892 #define   CIFSSEC_MAY_SEAL	0x00040
1893 #define   CIFSSEC_MAY_NTLMSSP	0x00080 /* raw ntlmssp with ntlmv2 */
1894 
1895 #define   CIFSSEC_MUST_SIGN	0x01001
1896 /* note that only one of the following can be set so the
1897 result of setting MUST flags more than once will be to
1898 require use of the stronger protocol */
1899 #define   CIFSSEC_MUST_NTLMV2	0x04004
1900 #define   CIFSSEC_MUST_KRB5	0x08008
1901 #ifdef CONFIG_CIFS_UPCALL
1902 #define   CIFSSEC_MASK          0xCF0CF /* flags supported if no weak allowed */
1903 #else
1904 #define	  CIFSSEC_MASK          0xC70C7 /* flags supported if no weak allowed */
1905 #endif /* UPCALL */
1906 #define   CIFSSEC_MUST_SEAL	0x40040
1907 #define   CIFSSEC_MUST_NTLMSSP	0x80080 /* raw ntlmssp with ntlmv2 */
1908 
1909 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP | CIFSSEC_MAY_SEAL)
1910 #define   CIFSSEC_MAX (CIFSSEC_MAY_SIGN | CIFSSEC_MUST_KRB5 | CIFSSEC_MAY_SEAL)
1911 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1912 /*
1913  *****************************************************************
1914  * All constants go here
1915  *****************************************************************
1916  */
1917 
1918 #define UID_HASH (16)
1919 
1920 /*
1921  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1922  * following to be declared.
1923  */
1924 
1925 /****************************************************************************
1926  * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according
1927  * to the locking order. i.e. if two locks are to be held together, the lock that
1928  * appears higher in this list needs to be taken before the other.
1929  *
1930  * If you hold a lock that is lower in this list, and you need to take a higher lock
1931  * (or if you think that one of the functions that you're calling may need to), first
1932  * drop the lock you hold, pick up the higher lock, then the lower one. This will
1933  * ensure that locks are picked up only in one direction in the below table
1934  * (top to bottom).
1935  *
1936  * Also, if you expect a function to be called with a lock held, explicitly document
1937  * this in the comments on top of your function definition.
1938  *
1939  * And also, try to keep the critical sections (lock hold time) to be as minimal as
1940  * possible. Blocking / calling other functions with a lock held always increase
1941  * the risk of a possible deadlock.
1942  *
1943  * Following this rule will avoid unnecessary deadlocks, which can get really hard to
1944  * debug. Also, any new lock that you introduce, please add to this list in the correct
1945  * order.
1946  *
1947  * Please populate this list whenever you introduce new locks in your changes. Or in
1948  * case I've missed some existing locks. Please ensure that it's added in the list
1949  * based on the locking order expected.
1950  *
1951  * =====================================================================================
1952  * Lock				Protects			Initialization fn
1953  * =====================================================================================
1954  * vol_list_lock
1955  * vol_info->ctx_lock		vol_info->ctx
1956  * cifs_sb_info->tlink_tree_lock	cifs_sb_info->tlink_tree	cifs_setup_cifs_sb
1957  * TCP_Server_Info->		TCP_Server_Info			cifs_get_tcp_session
1958  * reconnect_mutex
1959  * TCP_Server_Info->srv_mutex	TCP_Server_Info			cifs_get_tcp_session
1960  * cifs_ses->session_mutex		cifs_ses		sesInfoAlloc
1961  *				cifs_tcon
1962  * cifs_tcon->open_file_lock	cifs_tcon->openFileList		tconInfoAlloc
1963  *				cifs_tcon->pending_opens
1964  * cifs_tcon->stat_lock		cifs_tcon->bytes_read		tconInfoAlloc
1965  *				cifs_tcon->bytes_written
1966  * cifs_tcp_ses_lock		cifs_tcp_ses_list		sesInfoAlloc
1967  * GlobalMid_Lock		GlobalMaxActiveXid		init_cifs
1968  *				GlobalCurrentXid
1969  *				GlobalTotalActiveXid
1970  * TCP_Server_Info->srv_lock	(anything in struct not protected by another lock and can change)
1971  * TCP_Server_Info->mid_lock	TCP_Server_Info->pending_mid_q	cifs_get_tcp_session
1972  *				->CurrentMid
1973  *				(any changes in mid_q_entry fields)
1974  * TCP_Server_Info->req_lock	TCP_Server_Info->in_flight	cifs_get_tcp_session
1975  *				->credits
1976  *				->echo_credits
1977  *				->oplock_credits
1978  *				->reconnect_instance
1979  * cifs_ses->ses_lock		(anything that is not protected by another lock and can change)
1980  * cifs_ses->iface_lock		cifs_ses->iface_list		sesInfoAlloc
1981  *				->iface_count
1982  *				->iface_last_update
1983  * cifs_ses->chan_lock		cifs_ses->chans
1984  *				->chans_need_reconnect
1985  *				->chans_in_reconnect
1986  * cifs_tcon->tc_lock		(anything that is not protected by another lock and can change)
1987  * inode->i_rwsem, taken by fs/netfs/locking.c e.g. should be taken before cifsInodeInfo locks
1988  * cifsInodeInfo->open_file_lock	cifsInodeInfo->openFileList	cifs_alloc_inode
1989  * cifsInodeInfo->writers_lock	cifsInodeInfo->writers		cifsInodeInfo_alloc
1990  * cifsInodeInfo->lock_sem	cifsInodeInfo->llist		cifs_init_once
1991  *				->can_cache_brlcks
1992  * cifsInodeInfo->deferred_lock	cifsInodeInfo->deferred_closes	cifsInodeInfo_alloc
1993  * cached_fid->fid_mutex		cifs_tcon->crfid		tcon_info_alloc
1994  * cifsFileInfo->fh_mutex		cifsFileInfo			cifs_new_fileinfo
1995  * cifsFileInfo->file_info_lock	cifsFileInfo->count		cifs_new_fileinfo
1996  *				->invalidHandle			initiate_cifs_search
1997  *				->oplock_break_cancelled
1998  ****************************************************************************/
1999 
2000 #ifdef DECLARE_GLOBALS_HERE
2001 #define GLOBAL_EXTERN
2002 #else
2003 #define GLOBAL_EXTERN extern
2004 #endif
2005 
2006 /*
2007  * the list of TCP_Server_Info structures, ie each of the sockets
2008  * connecting our client to a distinct server (ip address), is
2009  * chained together by cifs_tcp_ses_list. The list of all our SMB
2010  * sessions (and from that the tree connections) can be found
2011  * by iterating over cifs_tcp_ses_list
2012  */
2013 extern struct list_head		cifs_tcp_ses_list;
2014 
2015 /*
2016  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
2017  * tcp session, and the list of tcon's per smb session. It also protects
2018  * the reference counters for the server, smb session, and tcon.
2019  * generally the locks should be taken in order tcp_ses_lock before
2020  * tcon->open_file_lock and that before file->file_info_lock since the
2021  * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
2022  */
2023 extern spinlock_t		cifs_tcp_ses_lock;
2024 
2025 /*
2026  * Global transaction id (XID) information
2027  */
2028 extern unsigned int GlobalCurrentXid;	/* protected by GlobalMid_Lock */
2029 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Lock */
2030 extern unsigned int GlobalMaxActiveXid;	/* prot by GlobalMid_Lock */
2031 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */
2032 
2033 /*
2034  *  Global counters, updated atomically
2035  */
2036 extern atomic_t sesInfoAllocCount;
2037 extern atomic_t tconInfoAllocCount;
2038 extern atomic_t tcpSesNextId;
2039 extern atomic_t tcpSesAllocCount;
2040 extern atomic_t tcpSesReconnectCount;
2041 extern atomic_t tconInfoReconnectCount;
2042 
2043 /* Various Debug counters */
2044 extern atomic_t buf_alloc_count;	/* current number allocated  */
2045 extern atomic_t small_buf_alloc_count;
2046 #ifdef CONFIG_CIFS_STATS2
2047 extern atomic_t total_buf_alloc_count; /* total allocated over all time */
2048 extern atomic_t total_small_buf_alloc_count;
2049 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
2050 #endif
2051 
2052 /* Misc globals */
2053 extern bool enable_oplocks; /* enable or disable oplocks */
2054 extern bool lookupCacheEnabled;
2055 extern unsigned int global_secflags;	/* if on, session setup sent
2056 				with more secure ntlmssp2 challenge/resp */
2057 extern unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
2058 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
2059 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
2060 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */
2061 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
2062 extern unsigned int CIFSMaxBufSize;  /* max size not including hdr */
2063 extern unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
2064 extern unsigned int cifs_min_small;  /* min size of small buf pool */
2065 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
2066 extern unsigned int dir_cache_timeout; /* max time for directory lease caching of dir */
2067 extern bool disable_legacy_dialects;  /* forbid vers=1.0 and vers=2.0 mounts */
2068 extern atomic_t mid_count;
2069 
2070 void cifs_oplock_break(struct work_struct *work);
2071 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
2072 void smb2_deferred_work_close(struct work_struct *work);
2073 
2074 extern const struct slow_work_ops cifs_oplock_break_ops;
2075 extern struct workqueue_struct *cifsiod_wq;
2076 extern struct workqueue_struct *decrypt_wq;
2077 extern struct workqueue_struct *fileinfo_put_wq;
2078 extern struct workqueue_struct *cifsoplockd_wq;
2079 extern struct workqueue_struct *deferredclose_wq;
2080 extern struct workqueue_struct *serverclose_wq;
2081 extern __u32 cifs_lock_secret;
2082 
2083 extern mempool_t *cifs_sm_req_poolp;
2084 extern mempool_t *cifs_req_poolp;
2085 extern mempool_t *cifs_mid_poolp;
2086 extern mempool_t cifs_io_request_pool;
2087 extern mempool_t cifs_io_subrequest_pool;
2088 
2089 /* Operations for different SMB versions */
2090 #define SMB1_VERSION_STRING	"1.0"
2091 #define SMB20_VERSION_STRING    "2.0"
2092 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
2093 extern struct smb_version_operations smb1_operations;
2094 extern struct smb_version_values smb1_values;
2095 extern struct smb_version_operations smb20_operations;
2096 extern struct smb_version_values smb20_values;
2097 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
2098 #define SMB21_VERSION_STRING	"2.1"
2099 extern struct smb_version_operations smb21_operations;
2100 extern struct smb_version_values smb21_values;
2101 #define SMBDEFAULT_VERSION_STRING "default"
2102 extern struct smb_version_values smbdefault_values;
2103 #define SMB3ANY_VERSION_STRING "3"
2104 extern struct smb_version_values smb3any_values;
2105 #define SMB30_VERSION_STRING	"3.0"
2106 extern struct smb_version_operations smb30_operations;
2107 extern struct smb_version_values smb30_values;
2108 #define SMB302_VERSION_STRING	"3.02"
2109 #define ALT_SMB302_VERSION_STRING "3.0.2"
2110 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2111 extern struct smb_version_values smb302_values;
2112 #define SMB311_VERSION_STRING	"3.1.1"
2113 #define ALT_SMB311_VERSION_STRING "3.11"
2114 extern struct smb_version_operations smb311_operations;
2115 extern struct smb_version_values smb311_values;
2116 
2117 static inline char *get_security_type_str(enum securityEnum sectype)
2118 {
2119 	switch (sectype) {
2120 	case RawNTLMSSP:
2121 		return "RawNTLMSSP";
2122 	case Kerberos:
2123 		return "Kerberos";
2124 	case NTLMv2:
2125 		return "NTLMv2";
2126 	default:
2127 		return "Unknown";
2128 	}
2129 }
2130 
2131 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2132 {
2133 	return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2134 }
2135 
2136 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2137 {
2138 	/*
2139 	 * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2140 	 * Subsystem Notifies That a Share Is a DFS Share.
2141 	 *
2142 	 * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2143 	 * Application Updates a Share.
2144 	 */
2145 	if (!tcon || !tcon->ses || !tcon->ses->server)
2146 		return false;
2147 	return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2148 		tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2149 }
2150 
2151 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon,
2152 					   const struct dfs_info3_param *ref)
2153 {
2154 	/*
2155 	 * Check if all targets are capable of handling DFS referrals as per
2156 	 * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL.
2157 	 */
2158 	return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER));
2159 }
2160 
2161 static inline u64 cifs_flock_len(const struct file_lock *fl)
2162 {
2163 	return (u64)fl->fl_end - fl->fl_start + 1;
2164 }
2165 
2166 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses)
2167 {
2168 	if (WARN_ON_ONCE(!ses || !ses->server))
2169 		return 0;
2170 	/*
2171 	 * Make workstation name no more than 15 chars when using insecure dialects as some legacy
2172 	 * servers do require it during NTLMSSP.
2173 	 */
2174 	if (ses->server->dialect <= SMB20_PROT_ID)
2175 		return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL);
2176 	return sizeof(ses->workstation_name);
2177 }
2178 
2179 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src)
2180 {
2181 	memcpy(dst, src, (size_t)((u8 *)&src->AccessFlags - (u8 *)src));
2182 	dst->AccessFlags = src->AccessFlags;
2183 	dst->CurrentByteOffset = src->CurrentByteOffset;
2184 	dst->Mode = src->Mode;
2185 	dst->AlignmentRequirement = src->AlignmentRequirement;
2186 	dst->FileNameLength = src->FileNameLength;
2187 }
2188 
2189 static inline int cifs_get_num_sgs(const struct smb_rqst *rqst,
2190 				   int num_rqst,
2191 				   const u8 *sig)
2192 {
2193 	unsigned int len, skip;
2194 	unsigned int nents = 0;
2195 	unsigned long addr;
2196 	size_t data_size;
2197 	int i, j;
2198 
2199 	/*
2200 	 * The first rqst has a transform header where the first 20 bytes are
2201 	 * not part of the encrypted blob.
2202 	 */
2203 	skip = 20;
2204 
2205 	/* Assumes the first rqst has a transform header as the first iov.
2206 	 * I.e.
2207 	 * rqst[0].rq_iov[0]  is transform header
2208 	 * rqst[0].rq_iov[1+] data to be encrypted/decrypted
2209 	 * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
2210 	 */
2211 	for (i = 0; i < num_rqst; i++) {
2212 		data_size = iov_iter_count(&rqst[i].rq_iter);
2213 
2214 		/* We really don't want a mixture of pinned and unpinned pages
2215 		 * in the sglist.  It's hard to keep track of which is what.
2216 		 * Instead, we convert to a BVEC-type iterator higher up.
2217 		 */
2218 		if (data_size &&
2219 		    WARN_ON_ONCE(user_backed_iter(&rqst[i].rq_iter)))
2220 			return -EIO;
2221 
2222 		/* We also don't want to have any extra refs or pins to clean
2223 		 * up in the sglist.
2224 		 */
2225 		if (data_size &&
2226 		    WARN_ON_ONCE(iov_iter_extract_will_pin(&rqst[i].rq_iter)))
2227 			return -EIO;
2228 
2229 		for (j = 0; j < rqst[i].rq_nvec; j++) {
2230 			struct kvec *iov = &rqst[i].rq_iov[j];
2231 
2232 			addr = (unsigned long)iov->iov_base + skip;
2233 			if (is_vmalloc_or_module_addr((void *)addr)) {
2234 				len = iov->iov_len - skip;
2235 				nents += DIV_ROUND_UP(offset_in_page(addr) + len,
2236 						      PAGE_SIZE);
2237 			} else {
2238 				nents++;
2239 			}
2240 			skip = 0;
2241 		}
2242 		if (data_size)
2243 			nents += iov_iter_npages(&rqst[i].rq_iter, INT_MAX);
2244 	}
2245 	nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
2246 	return nents;
2247 }
2248 
2249 /* We can not use the normal sg_set_buf() as we will sometimes pass a
2250  * stack object as buf.
2251  */
2252 static inline void cifs_sg_set_buf(struct sg_table *sgtable,
2253 				   const void *buf,
2254 				   unsigned int buflen)
2255 {
2256 	unsigned long addr = (unsigned long)buf;
2257 	unsigned int off = offset_in_page(addr);
2258 
2259 	addr &= PAGE_MASK;
2260 	if (is_vmalloc_or_module_addr((void *)addr)) {
2261 		do {
2262 			unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
2263 
2264 			sg_set_page(&sgtable->sgl[sgtable->nents++],
2265 				    vmalloc_to_page((void *)addr), len, off);
2266 
2267 			off = 0;
2268 			addr += PAGE_SIZE;
2269 			buflen -= len;
2270 		} while (buflen);
2271 	} else {
2272 		sg_set_page(&sgtable->sgl[sgtable->nents++],
2273 			    virt_to_page((void *)addr), buflen, off);
2274 	}
2275 }
2276 
2277 #define CIFS_OPARMS(_cifs_sb, _tcon, _path, _da, _cd, _co, _mode) \
2278 	((struct cifs_open_parms) { \
2279 		.tcon = _tcon, \
2280 		.path = _path, \
2281 		.desired_access = (_da), \
2282 		.disposition = (_cd), \
2283 		.create_options = cifs_create_options(_cifs_sb, (_co)), \
2284 		.mode = (_mode), \
2285 		.cifs_sb = _cifs_sb, \
2286 	})
2287 
2288 struct smb2_compound_vars {
2289 	struct cifs_open_parms oparms;
2290 	struct kvec rsp_iov[MAX_COMPOUND];
2291 	struct smb_rqst rqst[MAX_COMPOUND];
2292 	struct kvec open_iov[SMB2_CREATE_IOV_SIZE];
2293 	struct kvec qi_iov;
2294 	struct kvec io_iov[SMB2_IOCTL_IOV_SIZE];
2295 	struct kvec si_iov[SMB2_SET_INFO_IOV_SIZE];
2296 	struct kvec close_iov;
2297 	struct smb2_file_rename_info rename_info;
2298 	struct smb2_file_link_info link_info;
2299 	struct kvec ea_iov;
2300 };
2301 
2302 static inline bool cifs_ses_exiting(struct cifs_ses *ses)
2303 {
2304 	bool ret;
2305 
2306 	spin_lock(&ses->ses_lock);
2307 	ret = ses->ses_status == SES_EXITING;
2308 	spin_unlock(&ses->ses_lock);
2309 	return ret;
2310 }
2311 
2312 #endif	/* _CIFS_GLOB_H */
2313