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