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