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