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