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