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