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