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