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