xref: /openbmc/linux/fs/smb/client/cifsglob.h (revision f5da59f2)
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 	bool terminate;
663 	unsigned int credits;  /* send no more requests at once */
664 	unsigned int max_credits; /* can override large 32000 default at mnt */
665 	unsigned int in_flight;  /* number of requests on the wire to server */
666 	unsigned int max_in_flight; /* max number of requests that were on wire */
667 	spinlock_t req_lock;  /* protect the two values above */
668 	struct mutex _srv_mutex;
669 	unsigned int nofs_flag;
670 	struct task_struct *tsk;
671 	char server_GUID[16];
672 	__u16 sec_mode;
673 	bool sign; /* is signing enabled on this connection? */
674 	bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
675 	bool session_estab; /* mark when very first sess is established */
676 	int echo_credits;  /* echo reserved slots */
677 	int oplock_credits;  /* oplock break reserved slots */
678 	bool echoes:1; /* enable echoes */
679 	__u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
680 	u16 dialect; /* dialect index that server chose */
681 	bool oplocks:1; /* enable oplocks */
682 	unsigned int maxReq;	/* Clients should submit no more */
683 	/* than maxReq distinct unanswered SMBs to the server when using  */
684 	/* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
685 	unsigned int maxBuf;	/* maxBuf specifies the maximum */
686 	/* message size the server can send or receive for non-raw SMBs */
687 	/* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
688 	/* when socket is setup (and during reconnect) before NegProt sent */
689 	unsigned int max_rw;	/* maxRw specifies the maximum */
690 	/* message size the server can send or receive for */
691 	/* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
692 	unsigned int capabilities; /* selective disabling of caps by smb sess */
693 	int timeAdj;  /* Adjust for difference in server time zone in sec */
694 	__u64 CurrentMid;         /* multiplex id - rotating counter, protected by GlobalMid_Lock */
695 	char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
696 	/* 16th byte of RFC1001 workstation name is always null */
697 	char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
698 	__u32 sequence_number; /* for signing, protected by srv_mutex */
699 	__u32 reconnect_instance; /* incremented on each reconnect */
700 	struct session_key session_key;
701 	unsigned long lstrp; /* when we got last response from this server */
702 	struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
703 #define	CIFS_NEGFLAVOR_UNENCAP	1	/* wct == 17, but no ext_sec */
704 #define	CIFS_NEGFLAVOR_EXTENDED	2	/* wct == 17, ext_sec bit set */
705 	char	negflavor;	/* NEGOTIATE response flavor */
706 	/* extended security flavors that server supports */
707 	bool	sec_ntlmssp;		/* supports NTLMSSP */
708 	bool	sec_kerberosu2u;	/* supports U2U Kerberos */
709 	bool	sec_kerberos;		/* supports plain Kerberos */
710 	bool	sec_mskerberos;		/* supports legacy MS Kerberos */
711 	bool	large_buf;		/* is current buffer large? */
712 	/* use SMBD connection instead of socket */
713 	bool	rdma;
714 	/* point to the SMBD connection if RDMA is used instead of socket */
715 	struct smbd_connection *smbd_conn;
716 	struct delayed_work	echo; /* echo ping workqueue job */
717 	char	*smallbuf;	/* pointer to current "small" buffer */
718 	char	*bigbuf;	/* pointer to current "big" buffer */
719 	/* Total size of this PDU. Only valid from cifs_demultiplex_thread */
720 	unsigned int pdu_size;
721 	unsigned int total_read; /* total amount of data read in this pass */
722 	atomic_t in_send; /* requests trying to send */
723 	atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
724 #ifdef CONFIG_CIFS_STATS2
725 	atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
726 	atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
727 	__u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
728 	__u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
729 	__u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
730 #endif /* STATS2 */
731 	unsigned int	max_read;
732 	unsigned int	max_write;
733 	unsigned int	min_offload;
734 	__le16	compress_algorithm;
735 	__u16	signing_algorithm;
736 	__le16	cipher_type;
737 	 /* save initital negprot hash */
738 	__u8	preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
739 	bool	signing_negotiated; /* true if valid signing context rcvd from server */
740 	bool	posix_ext_supported;
741 	struct delayed_work reconnect; /* reconnect workqueue job */
742 	struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
743 	unsigned long echo_interval;
744 
745 	/*
746 	 * Number of targets available for reconnect. The more targets
747 	 * the more tasks have to wait to let the demultiplex thread
748 	 * reconnect.
749 	 */
750 	int nr_targets;
751 	bool noblockcnt; /* use non-blocking connect() */
752 
753 	/*
754 	 * If this is a session channel,
755 	 * primary_server holds the ref-counted
756 	 * pointer to primary channel connection for the session.
757 	 */
758 #define SERVER_IS_CHAN(server)	(!!(server)->primary_server)
759 	struct TCP_Server_Info *primary_server;
760 	__u16 channel_sequence_num;  /* incremented on primary channel on each chan reconnect */
761 
762 #ifdef CONFIG_CIFS_SWN_UPCALL
763 	bool use_swn_dstaddr;
764 	struct sockaddr_storage swn_dstaddr;
765 #endif
766 	struct mutex refpath_lock; /* protects leaf_fullpath */
767 	/*
768 	 * leaf_fullpath: Canonical DFS referral path related to this
769 	 *                connection.
770 	 *                It is used in DFS cache refresher, reconnect and may
771 	 *                change due to nested DFS links.
772 	 *
773 	 * Protected by @refpath_lock and @srv_lock.  The @refpath_lock is
774 	 * mostly used for not requiring a copy of @leaf_fullpath when getting
775 	 * cached or new DFS referrals (which might also sleep during I/O).
776 	 * While @srv_lock is held for making string and NULL comparions against
777 	 * both fields as in mount(2) and cache refresh.
778 	 *
779 	 * format: \\HOST\SHARE[\OPTIONAL PATH]
780 	 */
781 	char *leaf_fullpath;
782 };
783 
784 static inline bool is_smb1(struct TCP_Server_Info *server)
785 {
786 	return HEADER_PREAMBLE_SIZE(server) != 0;
787 }
788 
789 static inline void cifs_server_lock(struct TCP_Server_Info *server)
790 {
791 	unsigned int nofs_flag = memalloc_nofs_save();
792 
793 	mutex_lock(&server->_srv_mutex);
794 	server->nofs_flag = nofs_flag;
795 }
796 
797 static inline void cifs_server_unlock(struct TCP_Server_Info *server)
798 {
799 	unsigned int nofs_flag = server->nofs_flag;
800 
801 	mutex_unlock(&server->_srv_mutex);
802 	memalloc_nofs_restore(nofs_flag);
803 }
804 
805 struct cifs_credits {
806 	unsigned int value;
807 	unsigned int instance;
808 };
809 
810 static inline unsigned int
811 in_flight(struct TCP_Server_Info *server)
812 {
813 	unsigned int num;
814 
815 	spin_lock(&server->req_lock);
816 	num = server->in_flight;
817 	spin_unlock(&server->req_lock);
818 	return num;
819 }
820 
821 static inline bool
822 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
823 {
824 	int num;
825 
826 	spin_lock(&server->req_lock);
827 	num = *credits;
828 	spin_unlock(&server->req_lock);
829 	return num >= num_credits;
830 }
831 
832 static inline void
833 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
834 	    const int optype)
835 {
836 	server->ops->add_credits(server, credits, optype);
837 }
838 
839 static inline void
840 add_credits_and_wake_if(struct TCP_Server_Info *server,
841 			const struct cifs_credits *credits, const int optype)
842 {
843 	if (credits->value) {
844 		server->ops->add_credits(server, credits, optype);
845 		wake_up(&server->request_q);
846 	}
847 }
848 
849 static inline void
850 set_credits(struct TCP_Server_Info *server, const int val)
851 {
852 	server->ops->set_credits(server, val);
853 }
854 
855 static inline int
856 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
857 	       const unsigned int payload_size)
858 {
859 	return server->ops->adjust_credits ?
860 		server->ops->adjust_credits(server, credits, payload_size) : 0;
861 }
862 
863 static inline __le64
864 get_next_mid64(struct TCP_Server_Info *server)
865 {
866 	return cpu_to_le64(server->ops->get_next_mid(server));
867 }
868 
869 static inline __le16
870 get_next_mid(struct TCP_Server_Info *server)
871 {
872 	__u16 mid = server->ops->get_next_mid(server);
873 	/*
874 	 * The value in the SMB header should be little endian for easy
875 	 * on-the-wire decoding.
876 	 */
877 	return cpu_to_le16(mid);
878 }
879 
880 static inline void
881 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
882 {
883 	if (server->ops->revert_current_mid)
884 		server->ops->revert_current_mid(server, val);
885 }
886 
887 static inline void
888 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
889 			    const struct smb2_hdr *shdr)
890 {
891 	unsigned int num = le16_to_cpu(shdr->CreditCharge);
892 
893 	return revert_current_mid(server, num > 0 ? num : 1);
894 }
895 
896 static inline __u16
897 get_mid(const struct smb_hdr *smb)
898 {
899 	return le16_to_cpu(smb->Mid);
900 }
901 
902 static inline bool
903 compare_mid(__u16 mid, const struct smb_hdr *smb)
904 {
905 	return mid == le16_to_cpu(smb->Mid);
906 }
907 
908 /*
909  * When the server supports very large reads and writes via POSIX extensions,
910  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
911  * including the RFC1001 length.
912  *
913  * Note that this might make for "interesting" allocation problems during
914  * writeback however as we have to allocate an array of pointers for the
915  * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
916  *
917  * For reads, there is a similar problem as we need to allocate an array
918  * of kvecs to handle the receive, though that should only need to be done
919  * once.
920  */
921 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
922 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
923 
924 /*
925  * When the server doesn't allow large posix writes, only allow a rsize/wsize
926  * of 2^17-1 minus the size of the call header. That allows for a read or
927  * write up to the maximum size described by RFC1002.
928  */
929 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
930 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
931 
932 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
933 
934 /*
935  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
936  * those values when posix extensions aren't in force. In actuality here, we
937  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
938  * to be ok with the extra byte even though Windows doesn't send writes that
939  * are that large.
940  *
941  * Citation:
942  *
943  * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
944  */
945 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
946 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
947 
948 /*
949  * Macros to allow the TCP_Server_Info->net field and related code to drop out
950  * when CONFIG_NET_NS isn't set.
951  */
952 
953 #ifdef CONFIG_NET_NS
954 
955 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
956 {
957 	return srv->net;
958 }
959 
960 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
961 {
962 	srv->net = net;
963 }
964 
965 #else
966 
967 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
968 {
969 	return &init_net;
970 }
971 
972 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
973 {
974 }
975 
976 #endif
977 
978 struct cifs_server_iface {
979 	struct list_head iface_head;
980 	struct kref refcount;
981 	size_t speed;
982 	size_t weight_fulfilled;
983 	unsigned int num_channels;
984 	unsigned int rdma_capable : 1;
985 	unsigned int rss_capable : 1;
986 	unsigned int is_active : 1; /* unset if non existent */
987 	struct sockaddr_storage sockaddr;
988 };
989 
990 /* release iface when last ref is dropped */
991 static inline void
992 release_iface(struct kref *ref)
993 {
994 	struct cifs_server_iface *iface = container_of(ref,
995 						       struct cifs_server_iface,
996 						       refcount);
997 	kfree(iface);
998 }
999 
1000 struct cifs_chan {
1001 	unsigned int in_reconnect : 1; /* if session setup in progress for this channel */
1002 	struct TCP_Server_Info *server;
1003 	struct cifs_server_iface *iface; /* interface in use */
1004 	__u8 signkey[SMB3_SIGN_KEY_SIZE];
1005 };
1006 
1007 /*
1008  * Session structure.  One of these for each uid session with a particular host
1009  */
1010 struct cifs_ses {
1011 	struct list_head smb_ses_list;
1012 	struct list_head rlist; /* reconnect list */
1013 	struct list_head tcon_list;
1014 	struct cifs_tcon *tcon_ipc;
1015 	spinlock_t ses_lock;  /* protect anything here that is not protected */
1016 	struct mutex session_mutex;
1017 	struct TCP_Server_Info *server;	/* pointer to server info */
1018 	int ses_count;		/* reference counter */
1019 	enum ses_status_enum ses_status;  /* updates protected by cifs_tcp_ses_lock */
1020 	unsigned int overrideSecFlg; /* if non-zero override global sec flags */
1021 	char *serverOS;		/* name of operating system underlying server */
1022 	char *serverNOS;	/* name of network operating system of server */
1023 	char *serverDomain;	/* security realm of server */
1024 	__u64 Suid;		/* remote smb uid  */
1025 	kuid_t linux_uid;	/* overriding owner of files on the mount */
1026 	kuid_t cred_uid;	/* owner of credentials */
1027 	unsigned int capabilities;
1028 	char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */
1029 	char *user_name;	/* must not be null except during init of sess
1030 				   and after mount option parsing we fill it */
1031 	char *domainName;
1032 	char *password;
1033 	char workstation_name[CIFS_MAX_WORKSTATION_LEN];
1034 	struct session_key auth_key;
1035 	struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
1036 	enum securityEnum sectype; /* what security flavor was specified? */
1037 	bool sign;		/* is signing required? */
1038 	bool domainAuto:1;
1039 	__u16 session_flags;
1040 	__u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
1041 	__u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1042 	__u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1043 	__u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1044 
1045 	/*
1046 	 * Network interfaces available on the server this session is
1047 	 * connected to.
1048 	 *
1049 	 * Other channels can be opened by connecting and binding this
1050 	 * session to interfaces from this list.
1051 	 *
1052 	 * iface_lock should be taken when accessing any of these fields
1053 	 */
1054 	spinlock_t iface_lock;
1055 	/* ========= begin: protected by iface_lock ======== */
1056 	struct list_head iface_list;
1057 	size_t iface_count;
1058 	unsigned long iface_last_update; /* jiffies */
1059 	/* ========= end: protected by iface_lock ======== */
1060 
1061 	spinlock_t chan_lock;
1062 	/* ========= begin: protected by chan_lock ======== */
1063 #define CIFS_MAX_CHANNELS 16
1064 #define CIFS_INVAL_CHAN_INDEX (-1)
1065 #define CIFS_ALL_CHANNELS_SET(ses)	\
1066 	((1UL << (ses)->chan_count) - 1)
1067 #define CIFS_ALL_CHANS_GOOD(ses)		\
1068 	(!(ses)->chans_need_reconnect)
1069 #define CIFS_ALL_CHANS_NEED_RECONNECT(ses)	\
1070 	((ses)->chans_need_reconnect == CIFS_ALL_CHANNELS_SET(ses))
1071 #define CIFS_SET_ALL_CHANS_NEED_RECONNECT(ses)	\
1072 	((ses)->chans_need_reconnect = CIFS_ALL_CHANNELS_SET(ses))
1073 #define CIFS_CHAN_NEEDS_RECONNECT(ses, index)	\
1074 	test_bit((index), &(ses)->chans_need_reconnect)
1075 #define CIFS_CHAN_IN_RECONNECT(ses, index)	\
1076 	((ses)->chans[(index)].in_reconnect)
1077 
1078 	struct cifs_chan chans[CIFS_MAX_CHANNELS];
1079 	size_t chan_count;
1080 	size_t chan_max;
1081 	atomic_t chan_seq; /* round robin state */
1082 
1083 	/*
1084 	 * chans_need_reconnect is a bitmap indicating which of the channels
1085 	 * under this smb session needs to be reconnected.
1086 	 * If not multichannel session, only one bit will be used.
1087 	 *
1088 	 * We will ask for sess and tcon reconnection only if all the
1089 	 * channels are marked for needing reconnection. This will
1090 	 * enable the sessions on top to continue to live till any
1091 	 * of the channels below are active.
1092 	 */
1093 	unsigned long chans_need_reconnect;
1094 	/* ========= end: protected by chan_lock ======== */
1095 	struct cifs_ses *dfs_root_ses;
1096 	struct nls_table *local_nls;
1097 };
1098 
1099 static inline bool
1100 cap_unix(struct cifs_ses *ses)
1101 {
1102 	return ses->server->vals->cap_unix & ses->capabilities;
1103 }
1104 
1105 /*
1106  * common struct for holding inode info when searching for or updating an
1107  * inode with new info
1108  */
1109 
1110 #define CIFS_FATTR_JUNCTION		0x1
1111 #define CIFS_FATTR_DELETE_PENDING	0x2
1112 #define CIFS_FATTR_NEED_REVAL		0x4
1113 #define CIFS_FATTR_INO_COLLISION	0x8
1114 #define CIFS_FATTR_UNKNOWN_NLINK	0x10
1115 #define CIFS_FATTR_FAKE_ROOT_INO	0x20
1116 
1117 struct cifs_fattr {
1118 	u32		cf_flags;
1119 	u32		cf_cifsattrs;
1120 	u64		cf_uniqueid;
1121 	u64		cf_eof;
1122 	u64		cf_bytes;
1123 	u64		cf_createtime;
1124 	kuid_t		cf_uid;
1125 	kgid_t		cf_gid;
1126 	umode_t		cf_mode;
1127 	dev_t		cf_rdev;
1128 	unsigned int	cf_nlink;
1129 	unsigned int	cf_dtype;
1130 	struct timespec64 cf_atime;
1131 	struct timespec64 cf_mtime;
1132 	struct timespec64 cf_ctime;
1133 	u32             cf_cifstag;
1134 	char            *cf_symlink_target;
1135 };
1136 
1137 /*
1138  * there is one of these for each connection to a resource on a particular
1139  * session
1140  */
1141 struct cifs_tcon {
1142 	struct list_head tcon_list;
1143 	int tc_count;
1144 	struct list_head rlist; /* reconnect list */
1145 	spinlock_t tc_lock;  /* protect anything here that is not protected */
1146 	atomic_t num_local_opens;  /* num of all opens including disconnected */
1147 	atomic_t num_remote_opens; /* num of all network opens on server */
1148 	struct list_head openFileList;
1149 	spinlock_t open_file_lock; /* protects list above */
1150 	struct cifs_ses *ses;	/* pointer to session associated with */
1151 	char tree_name[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1152 	char *nativeFileSystem;
1153 	char *password;		/* for share-level security */
1154 	__u32 tid;		/* The 4 byte tree id */
1155 	__u16 Flags;		/* optional support bits */
1156 	enum tid_status_enum status;
1157 	atomic_t num_smbs_sent;
1158 	union {
1159 		struct {
1160 			atomic_t num_writes;
1161 			atomic_t num_reads;
1162 			atomic_t num_flushes;
1163 			atomic_t num_oplock_brks;
1164 			atomic_t num_opens;
1165 			atomic_t num_closes;
1166 			atomic_t num_deletes;
1167 			atomic_t num_mkdirs;
1168 			atomic_t num_posixopens;
1169 			atomic_t num_posixmkdirs;
1170 			atomic_t num_rmdirs;
1171 			atomic_t num_renames;
1172 			atomic_t num_t2renames;
1173 			atomic_t num_ffirst;
1174 			atomic_t num_fnext;
1175 			atomic_t num_fclose;
1176 			atomic_t num_hardlinks;
1177 			atomic_t num_symlinks;
1178 			atomic_t num_locks;
1179 			atomic_t num_acl_get;
1180 			atomic_t num_acl_set;
1181 		} cifs_stats;
1182 		struct {
1183 			atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1184 			atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1185 		} smb2_stats;
1186 	} stats;
1187 	__u64    bytes_read;
1188 	__u64    bytes_written;
1189 	spinlock_t stat_lock;  /* protects the two fields above */
1190 	FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1191 	FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1192 	FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1193 	bool ipc:1;   /* set if connection to IPC$ share (always also pipe) */
1194 	bool pipe:1;  /* set if connection to pipe share */
1195 	bool print:1; /* set if connection to printer share */
1196 	bool retry:1;
1197 	bool nocase:1;
1198 	bool nohandlecache:1; /* if strange server resource prob can turn off */
1199 	bool nodelete:1;
1200 	bool seal:1;      /* transport encryption for this mounted share */
1201 	bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
1202 				for this mount even if server would support */
1203 	bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1204 	bool local_lease:1; /* check leases (only) on local system not remote */
1205 	bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1206 	bool broken_sparse_sup; /* if server or share does not support sparse */
1207 	bool need_reconnect:1; /* connection reset, tid now invalid */
1208 	bool need_reopen_files:1; /* need to reopen tcon file handles */
1209 	bool use_resilient:1; /* use resilient instead of durable handles */
1210 	bool use_persistent:1; /* use persistent instead of durable handles */
1211 	bool no_lease:1;    /* Do not request leases on files or directories */
1212 	bool use_witness:1; /* use witness protocol */
1213 	__le32 capabilities;
1214 	__u32 share_flags;
1215 	__u32 maximal_access;
1216 	__u32 vol_serial_number;
1217 	__le64 vol_create_time;
1218 	__u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1219 	__u32 handle_timeout; /* persistent and durable handle timeout in ms */
1220 	__u32 ss_flags;		/* sector size flags */
1221 	__u32 perf_sector_size; /* best sector size for perf */
1222 	__u32 max_chunks;
1223 	__u32 max_bytes_chunk;
1224 	__u32 max_bytes_copy;
1225 	__u32 max_cached_dirs;
1226 #ifdef CONFIG_CIFS_FSCACHE
1227 	u64 resource_id;		/* server resource id */
1228 	struct fscache_volume *fscache;	/* cookie for share */
1229 #endif
1230 	struct list_head pending_opens;	/* list of incomplete opens */
1231 	struct cached_fids *cfids;
1232 	/* BB add field for back pointer to sb struct(s)? */
1233 #ifdef CONFIG_CIFS_DFS_UPCALL
1234 	struct list_head dfs_ses_list;
1235 	struct delayed_work dfs_cache_work;
1236 #endif
1237 	struct delayed_work	query_interfaces; /* query interfaces workqueue job */
1238 	char *origin_fullpath; /* canonical copy of smb3_fs_context::source */
1239 };
1240 
1241 /*
1242  * This is a refcounted and timestamped container for a tcon pointer. The
1243  * container holds a tcon reference. It is considered safe to free one of
1244  * these when the tl_count goes to 0. The tl_time is the time of the last
1245  * "get" on the container.
1246  */
1247 struct tcon_link {
1248 	struct rb_node		tl_rbnode;
1249 	kuid_t			tl_uid;
1250 	unsigned long		tl_flags;
1251 #define TCON_LINK_MASTER	0
1252 #define TCON_LINK_PENDING	1
1253 #define TCON_LINK_IN_TREE	2
1254 	unsigned long		tl_time;
1255 	atomic_t		tl_count;
1256 	struct cifs_tcon	*tl_tcon;
1257 };
1258 
1259 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1260 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1261 
1262 static inline struct cifs_tcon *
1263 tlink_tcon(struct tcon_link *tlink)
1264 {
1265 	return tlink->tl_tcon;
1266 }
1267 
1268 static inline struct tcon_link *
1269 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1270 {
1271 	return cifs_sb->master_tlink;
1272 }
1273 
1274 extern void cifs_put_tlink(struct tcon_link *tlink);
1275 
1276 static inline struct tcon_link *
1277 cifs_get_tlink(struct tcon_link *tlink)
1278 {
1279 	if (tlink && !IS_ERR(tlink))
1280 		atomic_inc(&tlink->tl_count);
1281 	return tlink;
1282 }
1283 
1284 /* This function is always expected to succeed */
1285 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1286 
1287 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1288 
1289 struct cifs_pending_open {
1290 	struct list_head olist;
1291 	struct tcon_link *tlink;
1292 	__u8 lease_key[16];
1293 	__u32 oplock;
1294 };
1295 
1296 struct cifs_deferred_close {
1297 	struct list_head dlist;
1298 	struct tcon_link *tlink;
1299 	__u16  netfid;
1300 	__u64  persistent_fid;
1301 	__u64  volatile_fid;
1302 };
1303 
1304 /*
1305  * This info hangs off the cifsFileInfo structure, pointed to by llist.
1306  * This is used to track byte stream locks on the file
1307  */
1308 struct cifsLockInfo {
1309 	struct list_head llist;	/* pointer to next cifsLockInfo */
1310 	struct list_head blist; /* pointer to locks blocked on this */
1311 	wait_queue_head_t block_q;
1312 	__u64 offset;
1313 	__u64 length;
1314 	__u32 pid;
1315 	__u16 type;
1316 	__u16 flags;
1317 };
1318 
1319 /*
1320  * One of these for each open instance of a file
1321  */
1322 struct cifs_search_info {
1323 	loff_t index_of_last_entry;
1324 	__u16 entries_in_buffer;
1325 	__u16 info_level;
1326 	__u32 resume_key;
1327 	char *ntwrk_buf_start;
1328 	char *srch_entries_start;
1329 	char *last_entry;
1330 	const char *presume_name;
1331 	unsigned int resume_name_len;
1332 	bool endOfSearch:1;
1333 	bool emptyDir:1;
1334 	bool unicode:1;
1335 	bool smallBuf:1; /* so we know which buf_release function to call */
1336 };
1337 
1338 #define ACL_NO_MODE	((umode_t)(-1))
1339 struct cifs_open_parms {
1340 	struct cifs_tcon *tcon;
1341 	struct cifs_sb_info *cifs_sb;
1342 	int disposition;
1343 	int desired_access;
1344 	int create_options;
1345 	const char *path;
1346 	struct cifs_fid *fid;
1347 	umode_t mode;
1348 	bool reconnect:1;
1349 };
1350 
1351 struct cifs_fid {
1352 	__u16 netfid;
1353 	__u64 persistent_fid;	/* persist file id for smb2 */
1354 	__u64 volatile_fid;	/* volatile file id for smb2 */
1355 	__u8 lease_key[SMB2_LEASE_KEY_SIZE];	/* lease key for smb2 */
1356 	__u8 create_guid[16];
1357 	__u32 access;
1358 	struct cifs_pending_open *pending_open;
1359 	unsigned int epoch;
1360 #ifdef CONFIG_CIFS_DEBUG2
1361 	__u64 mid;
1362 #endif /* CIFS_DEBUG2 */
1363 	bool purge_cache;
1364 };
1365 
1366 struct cifs_fid_locks {
1367 	struct list_head llist;
1368 	struct cifsFileInfo *cfile;	/* fid that owns locks */
1369 	struct list_head locks;		/* locks held by fid above */
1370 };
1371 
1372 struct cifsFileInfo {
1373 	/* following two lists are protected by tcon->open_file_lock */
1374 	struct list_head tlist;	/* pointer to next fid owned by tcon */
1375 	struct list_head flist;	/* next fid (file instance) for this inode */
1376 	/* lock list below protected by cifsi->lock_sem */
1377 	struct cifs_fid_locks *llist;	/* brlocks held by this fid */
1378 	kuid_t uid;		/* allows finding which FileInfo structure */
1379 	__u32 pid;		/* process id who opened file */
1380 	struct cifs_fid fid;	/* file id from remote */
1381 	struct list_head rlist; /* reconnect list */
1382 	/* BB add lock scope info here if needed */
1383 	/* lock scope id (0 if none) */
1384 	struct dentry *dentry;
1385 	struct tcon_link *tlink;
1386 	unsigned int f_flags;
1387 	bool invalidHandle:1;	/* file closed via session abend */
1388 	bool swapfile:1;
1389 	bool oplock_break_cancelled:1;
1390 	unsigned int oplock_epoch; /* epoch from the lease break */
1391 	__u32 oplock_level; /* oplock/lease level from the lease break */
1392 	int count;
1393 	spinlock_t file_info_lock; /* protects four flag/count fields above */
1394 	struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1395 	struct cifs_search_info srch_inf;
1396 	struct work_struct oplock_break; /* work for oplock breaks */
1397 	struct work_struct put; /* work for the final part of _put */
1398 	struct delayed_work deferred;
1399 	bool deferred_close_scheduled; /* Flag to indicate close is scheduled */
1400 	char *symlink_target;
1401 };
1402 
1403 struct cifs_io_parms {
1404 	__u16 netfid;
1405 	__u64 persistent_fid;	/* persist file id for smb2 */
1406 	__u64 volatile_fid;	/* volatile file id for smb2 */
1407 	__u32 pid;
1408 	__u64 offset;
1409 	unsigned int length;
1410 	struct cifs_tcon *tcon;
1411 	struct TCP_Server_Info *server;
1412 };
1413 
1414 struct cifs_aio_ctx {
1415 	struct kref		refcount;
1416 	struct list_head	list;
1417 	struct mutex		aio_mutex;
1418 	struct completion	done;
1419 	struct iov_iter		iter;
1420 	struct kiocb		*iocb;
1421 	struct cifsFileInfo	*cfile;
1422 	struct bio_vec		*bv;
1423 	loff_t			pos;
1424 	unsigned int		nr_pinned_pages;
1425 	ssize_t			rc;
1426 	unsigned int		len;
1427 	unsigned int		total_len;
1428 	unsigned int		bv_need_unpin;	/* If ->bv[] needs unpinning */
1429 	bool			should_dirty;
1430 	/*
1431 	 * Indicates if this aio_ctx is for direct_io,
1432 	 * If yes, iter is a copy of the user passed iov_iter
1433 	 */
1434 	bool			direct_io;
1435 };
1436 
1437 /* asynchronous read support */
1438 struct cifs_readdata {
1439 	struct kref			refcount;
1440 	struct list_head		list;
1441 	struct completion		done;
1442 	struct cifsFileInfo		*cfile;
1443 	struct address_space		*mapping;
1444 	struct cifs_aio_ctx		*ctx;
1445 	__u64				offset;
1446 	ssize_t				got_bytes;
1447 	unsigned int			bytes;
1448 	pid_t				pid;
1449 	int				result;
1450 	struct work_struct		work;
1451 	struct iov_iter			iter;
1452 	struct kvec			iov[2];
1453 	struct TCP_Server_Info		*server;
1454 #ifdef CONFIG_CIFS_SMB_DIRECT
1455 	struct smbd_mr			*mr;
1456 #endif
1457 	struct cifs_credits		credits;
1458 };
1459 
1460 /* asynchronous write support */
1461 struct cifs_writedata {
1462 	struct kref			refcount;
1463 	struct list_head		list;
1464 	struct completion		done;
1465 	enum writeback_sync_modes	sync_mode;
1466 	struct work_struct		work;
1467 	struct cifsFileInfo		*cfile;
1468 	struct cifs_aio_ctx		*ctx;
1469 	struct iov_iter			iter;
1470 	struct bio_vec			*bv;
1471 	__u64				offset;
1472 	pid_t				pid;
1473 	unsigned int			bytes;
1474 	int				result;
1475 	struct TCP_Server_Info		*server;
1476 #ifdef CONFIG_CIFS_SMB_DIRECT
1477 	struct smbd_mr			*mr;
1478 #endif
1479 	struct cifs_credits		credits;
1480 };
1481 
1482 /*
1483  * Take a reference on the file private data. Must be called with
1484  * cfile->file_info_lock held.
1485  */
1486 static inline void
1487 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1488 {
1489 	++cifs_file->count;
1490 }
1491 
1492 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1493 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1494 		       bool offload);
1495 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1496 
1497 #define CIFS_CACHE_READ_FLG	1
1498 #define CIFS_CACHE_HANDLE_FLG	2
1499 #define CIFS_CACHE_RH_FLG	(CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1500 #define CIFS_CACHE_WRITE_FLG	4
1501 #define CIFS_CACHE_RW_FLG	(CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1502 #define CIFS_CACHE_RHW_FLG	(CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1503 
1504 #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))
1505 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1506 #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))
1507 
1508 /*
1509  * One of these for each file inode
1510  */
1511 
1512 struct cifsInodeInfo {
1513 	struct netfs_inode netfs; /* Netfslib context and vfs inode */
1514 	bool can_cache_brlcks;
1515 	struct list_head llist;	/* locks helb by this inode */
1516 	/*
1517 	 * NOTE: Some code paths call down_read(lock_sem) twice, so
1518 	 * we must always use cifs_down_write() instead of down_write()
1519 	 * for this semaphore to avoid deadlocks.
1520 	 */
1521 	struct rw_semaphore lock_sem;	/* protect the fields above */
1522 	/* BB add in lists for dirty pages i.e. write caching info for oplock */
1523 	struct list_head openFileList;
1524 	spinlock_t	open_file_lock;	/* protects openFileList */
1525 	__u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1526 	unsigned int oplock;		/* oplock/lease level we have */
1527 	unsigned int epoch;		/* used to track lease state changes */
1528 #define CIFS_INODE_PENDING_OPLOCK_BREAK   (0) /* oplock break in progress */
1529 #define CIFS_INODE_PENDING_WRITERS	  (1) /* Writes in progress */
1530 #define CIFS_INODE_FLAG_UNUSED		  (2) /* Unused flag */
1531 #define CIFS_INO_DELETE_PENDING		  (3) /* delete pending on server */
1532 #define CIFS_INO_INVALID_MAPPING	  (4) /* pagecache is invalid */
1533 #define CIFS_INO_LOCK			  (5) /* lock bit for synchronization */
1534 #define CIFS_INO_MODIFIED_ATTR            (6) /* Indicate change in mtime/ctime */
1535 #define CIFS_INO_CLOSE_ON_LOCK            (7) /* Not to defer the close when lock is set */
1536 	unsigned long flags;
1537 	spinlock_t writers_lock;
1538 	unsigned int writers;		/* Number of writers on this inode */
1539 	unsigned long time;		/* jiffies of last update of inode */
1540 	u64  server_eof;		/* current file size on server -- protected by i_lock */
1541 	u64  uniqueid;			/* server inode number */
1542 	u64  createtime;		/* creation time on server */
1543 	__u8 lease_key[SMB2_LEASE_KEY_SIZE];	/* lease key for this inode */
1544 	struct list_head deferred_closes; /* list of deferred closes */
1545 	spinlock_t deferred_lock; /* protection on deferred list */
1546 	bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */
1547 	char *symlink_target;
1548 };
1549 
1550 static inline struct cifsInodeInfo *
1551 CIFS_I(struct inode *inode)
1552 {
1553 	return container_of(inode, struct cifsInodeInfo, netfs.inode);
1554 }
1555 
1556 static inline struct cifs_sb_info *
1557 CIFS_SB(struct super_block *sb)
1558 {
1559 	return sb->s_fs_info;
1560 }
1561 
1562 static inline struct cifs_sb_info *
1563 CIFS_FILE_SB(struct file *file)
1564 {
1565 	return CIFS_SB(file_inode(file)->i_sb);
1566 }
1567 
1568 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1569 {
1570 	if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1571 		return '/';
1572 	else
1573 		return '\\';
1574 }
1575 
1576 static inline void
1577 convert_delimiter(char *path, char delim)
1578 {
1579 	char old_delim, *pos;
1580 
1581 	if (delim == '/')
1582 		old_delim = '\\';
1583 	else
1584 		old_delim = '/';
1585 
1586 	pos = path;
1587 	while ((pos = strchr(pos, old_delim)))
1588 		*pos = delim;
1589 }
1590 
1591 #define cifs_stats_inc atomic_inc
1592 
1593 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1594 					    unsigned int bytes)
1595 {
1596 	if (bytes) {
1597 		spin_lock(&tcon->stat_lock);
1598 		tcon->bytes_written += bytes;
1599 		spin_unlock(&tcon->stat_lock);
1600 	}
1601 }
1602 
1603 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1604 					 unsigned int bytes)
1605 {
1606 	spin_lock(&tcon->stat_lock);
1607 	tcon->bytes_read += bytes;
1608 	spin_unlock(&tcon->stat_lock);
1609 }
1610 
1611 
1612 /*
1613  * This is the prototype for the mid receive function. This function is for
1614  * receiving the rest of the SMB frame, starting with the WordCount (which is
1615  * just after the MID in struct smb_hdr). Note:
1616  *
1617  * - This will be called by cifsd, with no locks held.
1618  * - The mid will still be on the pending_mid_q.
1619  * - mid->resp_buf will point to the current buffer.
1620  *
1621  * Returns zero on a successful receive, or an error. The receive state in
1622  * the TCP_Server_Info will also be updated.
1623  */
1624 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1625 			    struct mid_q_entry *mid);
1626 
1627 /*
1628  * This is the prototype for the mid callback function. This is called once the
1629  * mid has been received off of the socket. When creating one, take special
1630  * care to avoid deadlocks. Things to bear in mind:
1631  *
1632  * - it will be called by cifsd, with no locks held
1633  * - the mid will be removed from any lists
1634  */
1635 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1636 
1637 /*
1638  * This is the protopyte for mid handle function. This is called once the mid
1639  * has been recognized after decryption of the message.
1640  */
1641 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1642 			    struct mid_q_entry *mid);
1643 
1644 /* one of these for every pending CIFS request to the server */
1645 struct mid_q_entry {
1646 	struct list_head qhead;	/* mids waiting on reply from this server */
1647 	struct kref refcount;
1648 	struct TCP_Server_Info *server;	/* server corresponding to this mid */
1649 	__u64 mid;		/* multiplex id */
1650 	__u16 credits;		/* number of credits consumed by this mid */
1651 	__u16 credits_received;	/* number of credits from the response */
1652 	__u32 pid;		/* process id */
1653 	__u32 sequence_number;  /* for CIFS signing */
1654 	unsigned long when_alloc;  /* when mid was created */
1655 #ifdef CONFIG_CIFS_STATS2
1656 	unsigned long when_sent; /* time when smb send finished */
1657 	unsigned long when_received; /* when demux complete (taken off wire) */
1658 #endif
1659 	mid_receive_t *receive; /* call receive callback */
1660 	mid_callback_t *callback; /* call completion callback */
1661 	mid_handle_t *handle; /* call handle mid callback */
1662 	void *callback_data;	  /* general purpose pointer for callback */
1663 	struct task_struct *creator;
1664 	void *resp_buf;		/* pointer to received SMB header */
1665 	unsigned int resp_buf_size;
1666 	int mid_state;	/* wish this were enum but can not pass to wait_event */
1667 	unsigned int mid_flags;
1668 	__le16 command;		/* smb command code */
1669 	unsigned int optype;	/* operation type */
1670 	bool large_buf:1;	/* if valid response, is pointer to large buf */
1671 	bool multiRsp:1;	/* multiple trans2 responses for one request  */
1672 	bool multiEnd:1;	/* both received */
1673 	bool decrypted:1;	/* decrypted entry */
1674 };
1675 
1676 struct close_cancelled_open {
1677 	struct cifs_fid         fid;
1678 	struct cifs_tcon        *tcon;
1679 	struct work_struct      work;
1680 	__u64 mid;
1681 	__u16 cmd;
1682 };
1683 
1684 /*	Make code in transport.c a little cleaner by moving
1685 	update of optional stats into function below */
1686 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1687 {
1688 	atomic_inc(&server->in_send);
1689 }
1690 
1691 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1692 {
1693 	atomic_dec(&server->in_send);
1694 }
1695 
1696 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1697 {
1698 	atomic_inc(&server->num_waiters);
1699 }
1700 
1701 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1702 {
1703 	atomic_dec(&server->num_waiters);
1704 }
1705 
1706 #ifdef CONFIG_CIFS_STATS2
1707 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1708 {
1709 	mid->when_sent = jiffies;
1710 }
1711 #else
1712 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1713 {
1714 }
1715 #endif
1716 
1717 /* for pending dnotify requests */
1718 struct dir_notify_req {
1719 	struct list_head lhead;
1720 	__le16 Pid;
1721 	__le16 PidHigh;
1722 	__u16 Mid;
1723 	__u16 Tid;
1724 	__u16 Uid;
1725 	__u16 netfid;
1726 	__u32 filter; /* CompletionFilter (for multishot) */
1727 	int multishot;
1728 	struct file *pfile;
1729 };
1730 
1731 struct dfs_info3_param {
1732 	int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1733 	int path_consumed;
1734 	int server_type;
1735 	int ref_flag;
1736 	char *path_name;
1737 	char *node_name;
1738 	int ttl;
1739 };
1740 
1741 struct file_list {
1742 	struct list_head list;
1743 	struct cifsFileInfo *cfile;
1744 };
1745 
1746 struct cifs_mount_ctx {
1747 	struct cifs_sb_info *cifs_sb;
1748 	struct smb3_fs_context *fs_ctx;
1749 	unsigned int xid;
1750 	struct TCP_Server_Info *server;
1751 	struct cifs_ses *ses;
1752 	struct cifs_tcon *tcon;
1753 	struct list_head dfs_ses_list;
1754 };
1755 
1756 static inline void __free_dfs_info_param(struct dfs_info3_param *param)
1757 {
1758 	kfree(param->path_name);
1759 	kfree(param->node_name);
1760 }
1761 
1762 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1763 {
1764 	if (param)
1765 		__free_dfs_info_param(param);
1766 }
1767 
1768 static inline void zfree_dfs_info_param(struct dfs_info3_param *param)
1769 {
1770 	if (param) {
1771 		__free_dfs_info_param(param);
1772 		memset(param, 0, sizeof(*param));
1773 	}
1774 }
1775 
1776 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1777 				       int number_of_items)
1778 {
1779 	int i;
1780 
1781 	if ((number_of_items == 0) || (param == NULL))
1782 		return;
1783 	for (i = 0; i < number_of_items; i++) {
1784 		kfree(param[i].path_name);
1785 		kfree(param[i].node_name);
1786 	}
1787 	kfree(param);
1788 }
1789 
1790 static inline bool is_interrupt_error(int error)
1791 {
1792 	switch (error) {
1793 	case -EINTR:
1794 	case -ERESTARTSYS:
1795 	case -ERESTARTNOHAND:
1796 	case -ERESTARTNOINTR:
1797 		return true;
1798 	}
1799 	return false;
1800 }
1801 
1802 static inline bool is_retryable_error(int error)
1803 {
1804 	if (is_interrupt_error(error) || error == -EAGAIN)
1805 		return true;
1806 	return false;
1807 }
1808 
1809 
1810 /* cifs_get_writable_file() flags */
1811 #define FIND_WR_ANY         0
1812 #define FIND_WR_FSUID_ONLY  1
1813 #define FIND_WR_WITH_DELETE 2
1814 
1815 #define   MID_FREE 0
1816 #define   MID_REQUEST_ALLOCATED 1
1817 #define   MID_REQUEST_SUBMITTED 2
1818 #define   MID_RESPONSE_RECEIVED 4
1819 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
1820 #define   MID_RESPONSE_MALFORMED 0x10
1821 #define   MID_SHUTDOWN		 0x20
1822 #define   MID_RESPONSE_READY 0x40 /* ready for other process handle the rsp */
1823 
1824 /* Flags */
1825 #define   MID_WAIT_CANCELLED	 1 /* Cancelled while waiting for response */
1826 #define   MID_DELETED            2 /* Mid has been dequeued/deleted */
1827 
1828 /* Types of response buffer returned from SendReceive2 */
1829 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
1830 #define   CIFS_SMALL_BUFFER     1
1831 #define   CIFS_LARGE_BUFFER     2
1832 #define   CIFS_IOVEC            4    /* array of response buffers */
1833 
1834 /* Type of Request to SendReceive2 */
1835 #define   CIFS_BLOCKING_OP      1    /* operation can block */
1836 #define   CIFS_NON_BLOCKING     2    /* do not block waiting for credits */
1837 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
1838 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
1839 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
1840 #define   CIFS_NO_RSP_BUF   0x040    /* no response buffer required */
1841 
1842 /* Type of request operation */
1843 #define   CIFS_ECHO_OP            0x080  /* echo request */
1844 #define   CIFS_OBREAK_OP          0x0100 /* oplock break request */
1845 #define   CIFS_NEG_OP             0x0200 /* negotiate request */
1846 #define   CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */
1847 /* Lower bitmask values are reserved by others below. */
1848 #define   CIFS_SESS_OP            0x2000 /* session setup request */
1849 #define   CIFS_OP_MASK            0x2780 /* mask request type */
1850 
1851 #define   CIFS_HAS_CREDITS        0x0400 /* already has credits */
1852 #define   CIFS_TRANSFORM_REQ      0x0800 /* transform request before sending */
1853 #define   CIFS_NO_SRV_RSP         0x1000 /* there is no server response */
1854 
1855 /* Security Flags: indicate type of session setup needed */
1856 #define   CIFSSEC_MAY_SIGN	0x00001
1857 #define   CIFSSEC_MAY_NTLMV2	0x00004
1858 #define   CIFSSEC_MAY_KRB5	0x00008
1859 #define   CIFSSEC_MAY_SEAL	0x00040 /* not supported yet */
1860 #define   CIFSSEC_MAY_NTLMSSP	0x00080 /* raw ntlmssp with ntlmv2 */
1861 
1862 #define   CIFSSEC_MUST_SIGN	0x01001
1863 /* note that only one of the following can be set so the
1864 result of setting MUST flags more than once will be to
1865 require use of the stronger protocol */
1866 #define   CIFSSEC_MUST_NTLMV2	0x04004
1867 #define   CIFSSEC_MUST_KRB5	0x08008
1868 #ifdef CONFIG_CIFS_UPCALL
1869 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
1870 #else
1871 #define	  CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1872 #endif /* UPCALL */
1873 #define   CIFSSEC_MUST_SEAL	0x40040 /* not supported yet */
1874 #define   CIFSSEC_MUST_NTLMSSP	0x80080 /* raw ntlmssp with ntlmv2 */
1875 
1876 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1877 #define   CIFSSEC_MAX (CIFSSEC_MUST_NTLMV2)
1878 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1879 /*
1880  *****************************************************************
1881  * All constants go here
1882  *****************************************************************
1883  */
1884 
1885 #define UID_HASH (16)
1886 
1887 /*
1888  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1889  * following to be declared.
1890  */
1891 
1892 /****************************************************************************
1893  * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according
1894  * to the locking order. i.e. if two locks are to be held together, the lock that
1895  * appears higher in this list needs to be taken before the other.
1896  *
1897  * If you hold a lock that is lower in this list, and you need to take a higher lock
1898  * (or if you think that one of the functions that you're calling may need to), first
1899  * drop the lock you hold, pick up the higher lock, then the lower one. This will
1900  * ensure that locks are picked up only in one direction in the below table
1901  * (top to bottom).
1902  *
1903  * Also, if you expect a function to be called with a lock held, explicitly document
1904  * this in the comments on top of your function definition.
1905  *
1906  * And also, try to keep the critical sections (lock hold time) to be as minimal as
1907  * possible. Blocking / calling other functions with a lock held always increase
1908  * the risk of a possible deadlock.
1909  *
1910  * Following this rule will avoid unnecessary deadlocks, which can get really hard to
1911  * debug. Also, any new lock that you introduce, please add to this list in the correct
1912  * order.
1913  *
1914  * Please populate this list whenever you introduce new locks in your changes. Or in
1915  * case I've missed some existing locks. Please ensure that it's added in the list
1916  * based on the locking order expected.
1917  *
1918  * =====================================================================================
1919  * Lock				Protects			Initialization fn
1920  * =====================================================================================
1921  * vol_list_lock
1922  * vol_info->ctx_lock		vol_info->ctx
1923  * cifs_sb_info->tlink_tree_lock	cifs_sb_info->tlink_tree	cifs_setup_cifs_sb
1924  * TCP_Server_Info->		TCP_Server_Info			cifs_get_tcp_session
1925  * reconnect_mutex
1926  * TCP_Server_Info->srv_mutex	TCP_Server_Info			cifs_get_tcp_session
1927  * cifs_ses->session_mutex		cifs_ses		sesInfoAlloc
1928  *				cifs_tcon
1929  * cifs_tcon->open_file_lock	cifs_tcon->openFileList		tconInfoAlloc
1930  *				cifs_tcon->pending_opens
1931  * cifs_tcon->stat_lock		cifs_tcon->bytes_read		tconInfoAlloc
1932  *				cifs_tcon->bytes_written
1933  * cifs_tcp_ses_lock		cifs_tcp_ses_list		sesInfoAlloc
1934  * GlobalMid_Lock		GlobalMaxActiveXid		init_cifs
1935  *				GlobalCurrentXid
1936  *				GlobalTotalActiveXid
1937  * TCP_Server_Info->srv_lock	(anything in struct not protected by another lock and can change)
1938  * TCP_Server_Info->mid_lock	TCP_Server_Info->pending_mid_q	cifs_get_tcp_session
1939  *				->CurrentMid
1940  *				(any changes in mid_q_entry fields)
1941  * TCP_Server_Info->req_lock	TCP_Server_Info->in_flight	cifs_get_tcp_session
1942  *				->credits
1943  *				->echo_credits
1944  *				->oplock_credits
1945  *				->reconnect_instance
1946  * cifs_ses->ses_lock		(anything that is not protected by another lock and can change)
1947  * cifs_ses->iface_lock		cifs_ses->iface_list		sesInfoAlloc
1948  *				->iface_count
1949  *				->iface_last_update
1950  * cifs_ses->chan_lock		cifs_ses->chans
1951  *				->chans_need_reconnect
1952  *				->chans_in_reconnect
1953  * cifs_tcon->tc_lock		(anything that is not protected by another lock and can change)
1954  * cifsInodeInfo->open_file_lock	cifsInodeInfo->openFileList	cifs_alloc_inode
1955  * cifsInodeInfo->writers_lock	cifsInodeInfo->writers		cifsInodeInfo_alloc
1956  * cifsInodeInfo->lock_sem	cifsInodeInfo->llist		cifs_init_once
1957  *				->can_cache_brlcks
1958  * cifsInodeInfo->deferred_lock	cifsInodeInfo->deferred_closes	cifsInodeInfo_alloc
1959  * cached_fid->fid_mutex		cifs_tcon->crfid		tcon_info_alloc
1960  * cifsFileInfo->fh_mutex		cifsFileInfo			cifs_new_fileinfo
1961  * cifsFileInfo->file_info_lock	cifsFileInfo->count		cifs_new_fileinfo
1962  *				->invalidHandle			initiate_cifs_search
1963  *				->oplock_break_cancelled
1964  * cifs_aio_ctx->aio_mutex		cifs_aio_ctx			cifs_aio_ctx_alloc
1965  ****************************************************************************/
1966 
1967 #ifdef DECLARE_GLOBALS_HERE
1968 #define GLOBAL_EXTERN
1969 #else
1970 #define GLOBAL_EXTERN extern
1971 #endif
1972 
1973 /*
1974  * the list of TCP_Server_Info structures, ie each of the sockets
1975  * connecting our client to a distinct server (ip address), is
1976  * chained together by cifs_tcp_ses_list. The list of all our SMB
1977  * sessions (and from that the tree connections) can be found
1978  * by iterating over cifs_tcp_ses_list
1979  */
1980 extern struct list_head		cifs_tcp_ses_list;
1981 
1982 /*
1983  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1984  * tcp session, and the list of tcon's per smb session. It also protects
1985  * the reference counters for the server, smb session, and tcon.
1986  * generally the locks should be taken in order tcp_ses_lock before
1987  * tcon->open_file_lock and that before file->file_info_lock since the
1988  * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1989  */
1990 extern spinlock_t		cifs_tcp_ses_lock;
1991 
1992 /*
1993  * Global transaction id (XID) information
1994  */
1995 extern unsigned int GlobalCurrentXid;	/* protected by GlobalMid_Sem */
1996 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1997 extern unsigned int GlobalMaxActiveXid;	/* prot by GlobalMid_Sem */
1998 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */
1999 
2000 /*
2001  *  Global counters, updated atomically
2002  */
2003 extern atomic_t sesInfoAllocCount;
2004 extern atomic_t tconInfoAllocCount;
2005 extern atomic_t tcpSesNextId;
2006 extern atomic_t tcpSesAllocCount;
2007 extern atomic_t tcpSesReconnectCount;
2008 extern atomic_t tconInfoReconnectCount;
2009 
2010 /* Various Debug counters */
2011 extern atomic_t buf_alloc_count;	/* current number allocated  */
2012 extern atomic_t small_buf_alloc_count;
2013 #ifdef CONFIG_CIFS_STATS2
2014 extern atomic_t total_buf_alloc_count; /* total allocated over all time */
2015 extern atomic_t total_small_buf_alloc_count;
2016 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
2017 #endif
2018 
2019 /* Misc globals */
2020 extern bool enable_oplocks; /* enable or disable oplocks */
2021 extern bool lookupCacheEnabled;
2022 extern unsigned int global_secflags;	/* if on, session setup sent
2023 				with more secure ntlmssp2 challenge/resp */
2024 extern unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
2025 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
2026 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
2027 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */
2028 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
2029 extern unsigned int CIFSMaxBufSize;  /* max size not including hdr */
2030 extern unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
2031 extern unsigned int cifs_min_small;  /* min size of small buf pool */
2032 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
2033 extern unsigned int dir_cache_timeout; /* max time for directory lease caching of dir */
2034 extern bool disable_legacy_dialects;  /* forbid vers=1.0 and vers=2.0 mounts */
2035 extern atomic_t mid_count;
2036 
2037 void cifs_oplock_break(struct work_struct *work);
2038 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
2039 void smb2_deferred_work_close(struct work_struct *work);
2040 
2041 extern const struct slow_work_ops cifs_oplock_break_ops;
2042 extern struct workqueue_struct *cifsiod_wq;
2043 extern struct workqueue_struct *decrypt_wq;
2044 extern struct workqueue_struct *fileinfo_put_wq;
2045 extern struct workqueue_struct *cifsoplockd_wq;
2046 extern struct workqueue_struct *deferredclose_wq;
2047 extern __u32 cifs_lock_secret;
2048 
2049 extern mempool_t *cifs_mid_poolp;
2050 
2051 /* Operations for different SMB versions */
2052 #define SMB1_VERSION_STRING	"1.0"
2053 #define SMB20_VERSION_STRING    "2.0"
2054 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
2055 extern struct smb_version_operations smb1_operations;
2056 extern struct smb_version_values smb1_values;
2057 extern struct smb_version_operations smb20_operations;
2058 extern struct smb_version_values smb20_values;
2059 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
2060 #define SMB21_VERSION_STRING	"2.1"
2061 extern struct smb_version_operations smb21_operations;
2062 extern struct smb_version_values smb21_values;
2063 #define SMBDEFAULT_VERSION_STRING "default"
2064 extern struct smb_version_values smbdefault_values;
2065 #define SMB3ANY_VERSION_STRING "3"
2066 extern struct smb_version_values smb3any_values;
2067 #define SMB30_VERSION_STRING	"3.0"
2068 extern struct smb_version_operations smb30_operations;
2069 extern struct smb_version_values smb30_values;
2070 #define SMB302_VERSION_STRING	"3.02"
2071 #define ALT_SMB302_VERSION_STRING "3.0.2"
2072 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2073 extern struct smb_version_values smb302_values;
2074 #define SMB311_VERSION_STRING	"3.1.1"
2075 #define ALT_SMB311_VERSION_STRING "3.11"
2076 extern struct smb_version_operations smb311_operations;
2077 extern struct smb_version_values smb311_values;
2078 
2079 static inline char *get_security_type_str(enum securityEnum sectype)
2080 {
2081 	switch (sectype) {
2082 	case RawNTLMSSP:
2083 		return "RawNTLMSSP";
2084 	case Kerberos:
2085 		return "Kerberos";
2086 	case NTLMv2:
2087 		return "NTLMv2";
2088 	default:
2089 		return "Unknown";
2090 	}
2091 }
2092 
2093 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2094 {
2095 	return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2096 }
2097 
2098 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2099 {
2100 	/*
2101 	 * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2102 	 * Subsystem Notifies That a Share Is a DFS Share.
2103 	 *
2104 	 * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2105 	 * Application Updates a Share.
2106 	 */
2107 	if (!tcon || !tcon->ses || !tcon->ses->server)
2108 		return false;
2109 	return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2110 		tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2111 }
2112 
2113 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon,
2114 					   const struct dfs_info3_param *ref)
2115 {
2116 	/*
2117 	 * Check if all targets are capable of handling DFS referrals as per
2118 	 * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL.
2119 	 */
2120 	return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER));
2121 }
2122 
2123 static inline u64 cifs_flock_len(const struct file_lock *fl)
2124 {
2125 	return (u64)fl->fl_end - fl->fl_start + 1;
2126 }
2127 
2128 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses)
2129 {
2130 	if (WARN_ON_ONCE(!ses || !ses->server))
2131 		return 0;
2132 	/*
2133 	 * Make workstation name no more than 15 chars when using insecure dialects as some legacy
2134 	 * servers do require it during NTLMSSP.
2135 	 */
2136 	if (ses->server->dialect <= SMB20_PROT_ID)
2137 		return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL);
2138 	return sizeof(ses->workstation_name);
2139 }
2140 
2141 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src)
2142 {
2143 	memcpy(dst, src, (size_t)((u8 *)&src->AccessFlags - (u8 *)src));
2144 	dst->AccessFlags = src->AccessFlags;
2145 	dst->CurrentByteOffset = src->CurrentByteOffset;
2146 	dst->Mode = src->Mode;
2147 	dst->AlignmentRequirement = src->AlignmentRequirement;
2148 	dst->FileNameLength = src->FileNameLength;
2149 }
2150 
2151 static inline int cifs_get_num_sgs(const struct smb_rqst *rqst,
2152 				   int num_rqst,
2153 				   const u8 *sig)
2154 {
2155 	unsigned int len, skip;
2156 	unsigned int nents = 0;
2157 	unsigned long addr;
2158 	size_t data_size;
2159 	int i, j;
2160 
2161 	/*
2162 	 * The first rqst has a transform header where the first 20 bytes are
2163 	 * not part of the encrypted blob.
2164 	 */
2165 	skip = 20;
2166 
2167 	/* Assumes the first rqst has a transform header as the first iov.
2168 	 * I.e.
2169 	 * rqst[0].rq_iov[0]  is transform header
2170 	 * rqst[0].rq_iov[1+] data to be encrypted/decrypted
2171 	 * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
2172 	 */
2173 	for (i = 0; i < num_rqst; i++) {
2174 		data_size = iov_iter_count(&rqst[i].rq_iter);
2175 
2176 		/* We really don't want a mixture of pinned and unpinned pages
2177 		 * in the sglist.  It's hard to keep track of which is what.
2178 		 * Instead, we convert to a BVEC-type iterator higher up.
2179 		 */
2180 		if (data_size &&
2181 		    WARN_ON_ONCE(user_backed_iter(&rqst[i].rq_iter)))
2182 			return -EIO;
2183 
2184 		/* We also don't want to have any extra refs or pins to clean
2185 		 * up in the sglist.
2186 		 */
2187 		if (data_size &&
2188 		    WARN_ON_ONCE(iov_iter_extract_will_pin(&rqst[i].rq_iter)))
2189 			return -EIO;
2190 
2191 		for (j = 0; j < rqst[i].rq_nvec; j++) {
2192 			struct kvec *iov = &rqst[i].rq_iov[j];
2193 
2194 			addr = (unsigned long)iov->iov_base + skip;
2195 			if (unlikely(is_vmalloc_addr((void *)addr))) {
2196 				len = iov->iov_len - skip;
2197 				nents += DIV_ROUND_UP(offset_in_page(addr) + len,
2198 						      PAGE_SIZE);
2199 			} else {
2200 				nents++;
2201 			}
2202 			skip = 0;
2203 		}
2204 		if (data_size)
2205 			nents += iov_iter_npages(&rqst[i].rq_iter, INT_MAX);
2206 	}
2207 	nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
2208 	return nents;
2209 }
2210 
2211 /* We can not use the normal sg_set_buf() as we will sometimes pass a
2212  * stack object as buf.
2213  */
2214 static inline void cifs_sg_set_buf(struct sg_table *sgtable,
2215 				   const void *buf,
2216 				   unsigned int buflen)
2217 {
2218 	unsigned long addr = (unsigned long)buf;
2219 	unsigned int off = offset_in_page(addr);
2220 
2221 	addr &= PAGE_MASK;
2222 	if (unlikely(is_vmalloc_addr((void *)addr))) {
2223 		do {
2224 			unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
2225 
2226 			sg_set_page(&sgtable->sgl[sgtable->nents++],
2227 				    vmalloc_to_page((void *)addr), len, off);
2228 
2229 			off = 0;
2230 			addr += PAGE_SIZE;
2231 			buflen -= len;
2232 		} while (buflen);
2233 	} else {
2234 		sg_set_page(&sgtable->sgl[sgtable->nents++],
2235 			    virt_to_page((void *)addr), buflen, off);
2236 	}
2237 }
2238 
2239 struct smb2_compound_vars {
2240 	struct cifs_open_parms oparms;
2241 	struct kvec rsp_iov[3];
2242 	struct smb_rqst rqst[3];
2243 	struct kvec open_iov[SMB2_CREATE_IOV_SIZE];
2244 	struct kvec qi_iov;
2245 	struct kvec io_iov[SMB2_IOCTL_IOV_SIZE];
2246 	struct kvec si_iov[SMB2_SET_INFO_IOV_SIZE];
2247 	struct kvec close_iov;
2248 	struct smb2_file_rename_info rename_info;
2249 	struct smb2_file_link_info link_info;
2250 };
2251 
2252 #endif	/* _CIFS_GLOB_H */
2253