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