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