1 /* SPDX-License-Identifier: LGPL-2.1 */
4 * Copyright (C) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org)
13 #include <linux/in6.h>
14 #include <linux/inet.h>
15 #include <linux/slab.h>
16 #include <linux/scatterlist.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"
25 #include <crypto/internal/hash.h>
26 #include <uapi/linux/cifs/cifs_mount.h>
27 #include "../common/smb2pdu.h"
29 #include <linux/filelock.h>
31 #define SMB_PATH_MAX 260
33 #define RFC1001_PORT 139
36 * The sizes of various internal tables and strings
38 #define MAX_UID_INFO 16
39 #define MAX_SES_INFO 2
40 #define MAX_TCON_INFO 4
42 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
44 #define CIFS_MIN_RCV_POOL 4
46 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
48 * default attribute cache timeout (jiffies)
50 #define CIFS_DEF_ACTIMEO (1 * HZ)
53 * max sleep time before retry to server
55 #define CIFS_MAX_SLEEP 2000
58 * max attribute cache timeout (jiffies) - 2^30
60 #define CIFS_MAX_ACTIMEO (1 << 30)
63 * Max persistent and resilient handle timeout (milliseconds).
64 * Windows durable max was 960000 (16 minutes)
66 #define SMB3_MAX_HANDLE_TIMEOUT 960000
69 * MAX_REQ is the maximum number of requests that WE will send
70 * on one socket concurrently.
72 #define CIFS_MAX_REQ 32767
74 #define RFC1001_NAME_LEN 15
75 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
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)
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
86 /* smb multichannel query server interfaces interval in seconds */
87 #define SMB_INTERFACE_POLL_INTERVAL 600
89 /* maximum number of PDUs in one compound */
90 #define MAX_COMPOUND 7
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.
102 #define SMB2_MAX_CREDITS_AVAILABLE 32000
106 #ifndef XATTR_DOS_ATTRIB
107 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
110 #define CIFS_MAX_WORKSTATION_LEN (__NEW_UTS_LEN + 1) /* reasonable max for client */
112 #define CIFS_DFS_ROOT_SES(ses) ((ses)->dfs_root_ses ?: (ses))
115 * CIFS vfs client Status information (based on what we know.)
118 /* associated with each connection */
128 /* associated with each smb session */
129 enum ses_status_enum {
137 /* associated with each tree connection to the server */
138 enum tid_status_enum {
145 TID_NEED_FILES_INVALIDATE, /* currently unused */
146 TID_IN_FILES_INVALIDATE
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 */
161 /* crypto hashing related structure/fields, not specific to a sec mech */
162 struct cifs_secmech {
163 struct shash_desc *hmacmd5; /* hmacmd5 hash function, for NTLMv2/CR1 hashes */
164 struct shash_desc *md5; /* md5 hash function, for CIFS/SMB1 signatures */
165 struct shash_desc *hmacsha256; /* hmac-sha256 hash function, for SMB2 signatures */
166 struct shash_desc *sha512; /* sha512 hash function, for SMB3.1.1 preauth hash */
167 struct shash_desc *aes_cmac; /* block-cipher based MAC function, for SMB3 signatures */
169 struct crypto_aead *enc; /* smb3 encryption AEAD TFM (AES-CCM and AES-GCM) */
170 struct crypto_aead *dec; /* smb3 decryption AEAD TFM (AES-CCM and AES-GCM) */
173 /* per smb session structure/fields */
174 struct ntlmssp_auth {
175 bool sesskey_per_smbsess; /* whether session key is per smb session */
176 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
177 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
178 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
179 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
187 struct cifs_sid osid;
188 struct cifs_sid gsid;
189 struct cifs_ntace *ntaces;
190 struct cifs_ace *aces;
193 struct cifs_open_info_data {
200 /* ioctl response buffer */
207 struct reparse_data_buffer *buf;
208 struct reparse_posix_data *posix;
211 char *symlink_target;
212 struct cifs_sid posix_owner;
213 struct cifs_sid posix_group;
215 struct smb2_file_all_info fi;
216 struct smb311_posix_qinfo posix_fi;
220 static inline bool cifs_open_data_reparse(struct cifs_open_info_data *data)
222 struct smb2_file_all_info *fi = &data->fi;
223 u32 attrs = le32_to_cpu(fi->Attributes);
226 ret = data->reparse_point || (attrs & ATTR_REPARSE);
228 attrs |= ATTR_REPARSE;
229 fi->Attributes = cpu_to_le32(attrs);
234 *****************************************************************
235 * Except the CIFS PDUs themselves all the
236 * globally interesting structs should go here
237 *****************************************************************
241 * A smb_rqst represents a complete request to be issued to a server. It's
242 * formed by a kvec array, followed by an array of pages. Page data is assumed
243 * to start at the beginning of the first page.
246 struct kvec *rq_iov; /* array of kvecs */
247 unsigned int rq_nvec; /* number of kvecs in array */
248 size_t rq_iter_size; /* Amount of data in ->rq_iter */
249 struct iov_iter rq_iter; /* Data iterator */
250 struct xarray rq_buffer; /* Page buffer for encryption */
254 struct TCP_Server_Info;
258 struct dfs_info3_param;
260 struct smb3_fs_context;
262 struct cifs_readdata;
263 struct cifs_writedata;
264 struct cifs_io_parms;
265 struct cifs_search_info;
266 struct cifsInodeInfo;
267 struct cifs_open_parms;
270 struct smb_version_operations {
271 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
272 struct mid_q_entry *);
273 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
274 /* setup request: allocate mid, sign message */
275 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
276 struct TCP_Server_Info *,
278 /* setup async request: allocate mid, sign message */
279 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
281 /* check response: verify signature, map error */
282 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
284 void (*add_credits)(struct TCP_Server_Info *server,
285 const struct cifs_credits *credits,
287 void (*set_credits)(struct TCP_Server_Info *, const int);
288 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
289 unsigned int (*get_credits)(struct mid_q_entry *);
290 __u64 (*get_next_mid)(struct TCP_Server_Info *);
291 void (*revert_current_mid)(struct TCP_Server_Info *server,
292 const unsigned int val);
293 /* data offset from read response message */
294 unsigned int (*read_data_offset)(char *);
296 * Data length from read response message
297 * When in_remaining is true, the returned data length is in
298 * message field DataRemaining for out-of-band data read (e.g through
299 * Memory Registration RDMA write in SMBD).
300 * Otherwise, the returned data length is in message field DataLength.
302 unsigned int (*read_data_length)(char *, bool in_remaining);
303 /* map smb to linux error */
304 int (*map_error)(char *, bool);
305 /* find mid corresponding to the response message */
306 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
307 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
308 void (*clear_stats)(struct cifs_tcon *);
309 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
310 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
311 /* verify the message */
312 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
313 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
314 int (*handle_cancelled_mid)(struct mid_q_entry *, struct TCP_Server_Info *);
315 void (*downgrade_oplock)(struct TCP_Server_Info *server,
316 struct cifsInodeInfo *cinode, __u32 oplock,
317 unsigned int epoch, bool *purge_cache);
318 /* process transaction2 response */
319 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
321 /* check if we need to negotiate */
322 bool (*need_neg)(struct TCP_Server_Info *);
323 /* negotiate to the server */
324 int (*negotiate)(const unsigned int xid,
325 struct cifs_ses *ses,
326 struct TCP_Server_Info *server);
327 /* set negotiated write size */
328 unsigned int (*negotiate_wsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
329 /* set negotiated read size */
330 unsigned int (*negotiate_rsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
331 /* setup smb sessionn */
332 int (*sess_setup)(const unsigned int, struct cifs_ses *,
333 struct TCP_Server_Info *server,
334 const struct nls_table *);
335 /* close smb session */
336 int (*logoff)(const unsigned int, struct cifs_ses *);
337 /* connect to a server share */
338 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
339 struct cifs_tcon *, const struct nls_table *);
340 /* close tree connecion */
341 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
342 /* get DFS referrals */
343 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
344 const char *, struct dfs_info3_param **,
345 unsigned int *, const struct nls_table *, int);
346 /* informational QFS call */
347 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *,
348 struct cifs_sb_info *);
349 /* query for server interfaces */
350 int (*query_server_interfaces)(const unsigned int, struct cifs_tcon *,
352 /* check if a path is accessible or not */
353 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
354 struct cifs_sb_info *, const char *);
355 /* query path data from the server */
356 int (*query_path_info)(const unsigned int xid,
357 struct cifs_tcon *tcon,
358 struct cifs_sb_info *cifs_sb,
359 const char *full_path,
360 struct cifs_open_info_data *data);
361 /* query file data from the server */
362 int (*query_file_info)(const unsigned int xid, struct cifs_tcon *tcon,
363 struct cifsFileInfo *cfile, struct cifs_open_info_data *data);
364 /* query reparse point to determine which type of special file */
365 int (*query_reparse_point)(const unsigned int xid,
366 struct cifs_tcon *tcon,
367 struct cifs_sb_info *cifs_sb,
368 const char *full_path,
369 u32 *tag, struct kvec *rsp,
371 /* get server index number */
372 int (*get_srv_inum)(const unsigned int xid, struct cifs_tcon *tcon,
373 struct cifs_sb_info *cifs_sb, const char *full_path, u64 *uniqueid,
374 struct cifs_open_info_data *data);
375 /* set size by path */
376 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
377 const char *, __u64, struct cifs_sb_info *, bool);
378 /* set size by file handle */
379 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
380 struct cifsFileInfo *, __u64, bool);
382 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
384 int (*set_compression)(const unsigned int, struct cifs_tcon *,
385 struct cifsFileInfo *);
386 /* check if we can send an echo or nor */
387 bool (*can_echo)(struct TCP_Server_Info *);
388 /* send echo request */
389 int (*echo)(struct TCP_Server_Info *);
390 /* create directory */
391 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
392 umode_t mode, struct cifs_tcon *tcon,
393 const char *full_path,
394 struct cifs_sb_info *cifs_sb);
395 int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
396 struct cifs_tcon *tcon, const char *name,
397 struct cifs_sb_info *sb);
398 /* set info on created directory */
399 void (*mkdir_setinfo)(struct inode *, const char *,
400 struct cifs_sb_info *, struct cifs_tcon *,
402 /* remove directory */
403 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
404 struct cifs_sb_info *);
406 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
407 struct cifs_sb_info *);
408 /* open, rename and delete file */
409 int (*rename_pending_delete)(const char *, struct dentry *,
411 /* send rename request */
412 int (*rename)(const unsigned int xid,
413 struct cifs_tcon *tcon,
414 struct dentry *source_dentry,
415 const char *from_name, const char *to_name,
416 struct cifs_sb_info *cifs_sb);
417 /* send create hardlink request */
418 int (*create_hardlink)(const unsigned int xid,
419 struct cifs_tcon *tcon,
420 struct dentry *source_dentry,
421 const char *from_name, const char *to_name,
422 struct cifs_sb_info *cifs_sb);
423 /* query symlink target */
424 int (*query_symlink)(const unsigned int xid,
425 struct cifs_tcon *tcon,
426 struct cifs_sb_info *cifs_sb,
427 const char *full_path,
429 /* open a file for non-posix mounts */
430 int (*open)(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,
432 /* set fid protocol-specific info */
433 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
435 int (*close)(const unsigned int, struct cifs_tcon *,
437 /* close a file, returning file attributes and timestamps */
438 int (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon,
439 struct cifsFileInfo *pfile_info);
440 /* send a flush request to the server */
441 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
442 /* async read from the server */
443 int (*async_readv)(struct cifs_readdata *);
444 /* async write to the server */
445 int (*async_writev)(struct cifs_writedata *,
446 void (*release)(struct kref *));
447 /* sync read from the server */
448 int (*sync_read)(const unsigned int, struct cifs_fid *,
449 struct cifs_io_parms *, unsigned int *, char **,
451 /* sync write to the server */
452 int (*sync_write)(const unsigned int, struct cifs_fid *,
453 struct cifs_io_parms *, unsigned int *, struct kvec *,
455 /* open dir, start readdir */
456 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
457 const char *, struct cifs_sb_info *,
458 struct cifs_fid *, __u16,
459 struct cifs_search_info *);
460 /* continue readdir */
461 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
463 __u16, struct cifs_search_info *srch_inf);
465 int (*close_dir)(const unsigned int, struct cifs_tcon *,
467 /* calculate a size of SMB message */
468 unsigned int (*calc_smb_size)(void *buf);
469 /* check for STATUS_PENDING and process the response if yes */
470 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
471 /* check for STATUS_NETWORK_SESSION_EXPIRED */
472 bool (*is_session_expired)(char *);
473 /* send oplock break response */
474 int (*oplock_response)(struct cifs_tcon *tcon, __u64 persistent_fid, __u64 volatile_fid,
475 __u16 net_fid, struct cifsInodeInfo *cifs_inode);
476 /* query remote filesystem */
477 int (*queryfs)(const unsigned int, struct cifs_tcon *,
478 struct cifs_sb_info *, struct kstatfs *);
479 /* send mandatory brlock to the server */
480 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
481 __u64, __u32, int, int, bool);
482 /* unlock range of mandatory locks */
483 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
485 /* push brlocks from the cache to the server */
486 int (*push_mand_locks)(struct cifsFileInfo *);
487 /* get lease key of the inode */
488 void (*get_lease_key)(struct inode *, struct cifs_fid *);
489 /* set lease key of the inode */
490 void (*set_lease_key)(struct inode *, struct cifs_fid *);
491 /* generate new lease key */
492 void (*new_lease_key)(struct cifs_fid *);
493 int (*generate_signingkey)(struct cifs_ses *ses,
494 struct TCP_Server_Info *server);
495 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *,
496 bool allocate_crypto);
497 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
498 struct cifsFileInfo *src_file);
499 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
500 struct cifsFileInfo *src_file, void __user *);
501 int (*notify)(const unsigned int xid, struct file *pfile,
502 void __user *pbuf, bool return_changes);
503 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
504 struct cifs_sb_info *, const unsigned char *,
505 char *, unsigned int *);
506 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
507 struct cifs_sb_info *, const unsigned char *,
508 char *, unsigned int *);
509 /* if we can do cache read operations */
510 bool (*is_read_op)(__u32);
511 /* set oplock level for the inode */
512 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
514 /* create lease context buffer for CREATE request */
515 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
516 /* parse lease context buffer and return oplock/epoch info */
517 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
518 ssize_t (*copychunk_range)(const unsigned int,
519 struct cifsFileInfo *src_file,
520 struct cifsFileInfo *target_file,
521 u64 src_off, u64 len, u64 dest_off);
522 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
523 struct cifsFileInfo *target_file, u64 src_off, u64 len,
525 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
526 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
527 const unsigned char *, const unsigned char *, char *,
528 size_t, struct cifs_sb_info *);
529 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
530 const char *, const void *, const __u16,
531 const struct nls_table *, struct cifs_sb_info *);
532 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
533 const char *, u32 *, u32);
534 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
535 const struct cifs_fid *, u32 *, u32);
536 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
538 /* writepages retry size */
539 unsigned int (*wp_retry_size)(struct inode *);
540 /* get mtu credits */
541 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
542 unsigned int *, struct cifs_credits *);
543 /* adjust previously taken mtu credits to request size */
544 int (*adjust_credits)(struct TCP_Server_Info *server,
545 struct cifs_credits *credits,
546 const unsigned int payload_size);
547 /* check if we need to issue closedir */
548 bool (*dir_needs_close)(struct cifsFileInfo *);
549 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
551 /* init transform request - used for encryption for now */
552 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
553 struct smb_rqst *, struct smb_rqst *);
554 int (*is_transform_hdr)(void *buf);
555 int (*receive_transform)(struct TCP_Server_Info *,
556 struct mid_q_entry **, char **, int *);
557 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
559 int (*next_header)(struct TCP_Server_Info *server, char *buf,
561 /* ioctl passthrough for query_info */
562 int (*ioctl_query_info)(const unsigned int xid,
563 struct cifs_tcon *tcon,
564 struct cifs_sb_info *cifs_sb,
565 __le16 *path, int is_dir,
567 /* make unix special files (block, char, fifo, socket) */
568 int (*make_node)(unsigned int xid,
570 struct dentry *dentry,
571 struct cifs_tcon *tcon,
572 const char *full_path,
574 dev_t device_number);
575 /* version specific fiemap implementation */
576 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
577 struct fiemap_extent_info *, u64, u64);
578 /* version specific llseek implementation */
579 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
580 /* Check for STATUS_IO_TIMEOUT */
581 bool (*is_status_io_timeout)(char *buf);
582 /* Check for STATUS_NETWORK_NAME_DELETED */
583 bool (*is_network_name_deleted)(char *buf, struct TCP_Server_Info *srv);
584 int (*parse_reparse_point)(struct cifs_sb_info *cifs_sb,
585 struct kvec *rsp_iov,
586 struct cifs_open_info_data *data);
587 int (*create_reparse_symlink)(const unsigned int xid,
589 struct dentry *dentry,
590 struct cifs_tcon *tcon,
591 const char *full_path,
592 const char *symname);
595 struct smb_version_values {
596 char *version_string;
598 __u32 req_capabilities;
599 __u32 large_lock_type;
600 __u32 exclusive_lock_type;
601 __u32 shared_lock_type;
602 __u32 unlock_lock_type;
603 size_t header_preamble_size;
605 size_t max_header_size;
606 size_t read_rsp_size;
608 unsigned int cap_unix;
609 unsigned int cap_nt_find;
610 unsigned int cap_large_files;
611 __u16 signing_enabled;
612 __u16 signing_required;
613 size_t create_lease_size;
616 #define HEADER_SIZE(server) (server->vals->header_size)
617 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
618 #define HEADER_PREAMBLE_SIZE(server) (server->vals->header_preamble_size)
619 #define MID_HEADER_SIZE(server) (HEADER_SIZE(server) - 1 - HEADER_PREAMBLE_SIZE(server))
622 * CIFS superblock mount flags (mnt_cifs_flags) to consider when
623 * trying to reuse existing superblock for a new mount
625 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
626 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
627 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
628 CIFS_MOUNT_MAP_SFM_CHR | \
629 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
630 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
631 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
632 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
633 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
634 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
635 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
636 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
637 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
638 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
641 * Generic VFS superblock mount flags (s_flags) to consider when
642 * trying to reuse existing superblock for a new mount
644 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
645 SB_NODEV | SB_SYNCHRONOUS)
647 struct cifs_mnt_data {
648 struct cifs_sb_info *cifs_sb;
649 struct smb3_fs_context *ctx;
653 static inline unsigned int
654 get_rfc1002_length(void *buf)
656 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
660 inc_rfc1001_len(void *buf, int count)
662 be32_add_cpu((__be32 *)buf, count);
665 struct TCP_Server_Info {
666 struct list_head tcp_ses_list;
667 struct list_head smb_ses_list;
668 spinlock_t srv_lock; /* protect anything here that is not protected */
669 __u64 conn_id; /* connection identifier (useful for debugging) */
670 int srv_count; /* reference counter */
671 /* 15 character server name + 0x20 16th byte indicating type = srv */
672 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
673 struct smb_version_operations *ops;
674 struct smb_version_values *vals;
675 /* updates to tcpStatus protected by cifs_tcp_ses_lock */
676 enum statusEnum tcpStatus; /* what we think the status is */
677 char *hostname; /* hostname portion of UNC string */
678 struct socket *ssocket;
679 struct sockaddr_storage dstaddr;
680 struct sockaddr_storage srcaddr; /* locally bind to this IP */
684 wait_queue_head_t response_q;
685 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
686 spinlock_t mid_lock; /* protect mid queue and it's entries */
687 struct list_head pending_mid_q;
688 bool noblocksnd; /* use blocking sendmsg */
689 bool noautotune; /* do not autotune send buf sizes */
693 unsigned int credits; /* send no more requests at once */
694 unsigned int max_credits; /* can override large 32000 default at mnt */
695 unsigned int in_flight; /* number of requests on the wire to server */
696 unsigned int max_in_flight; /* max number of requests that were on wire */
697 spinlock_t req_lock; /* protect the two values above */
698 struct mutex _srv_mutex;
699 unsigned int nofs_flag;
700 struct task_struct *tsk;
701 char server_GUID[16];
703 bool sign; /* is signing enabled on this connection? */
704 bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
705 bool session_estab; /* mark when very first sess is established */
706 int echo_credits; /* echo reserved slots */
707 int oplock_credits; /* oplock break reserved slots */
708 bool echoes:1; /* enable echoes */
709 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
710 u16 dialect; /* dialect index that server chose */
711 bool oplocks:1; /* enable oplocks */
712 unsigned int maxReq; /* Clients should submit no more */
713 /* than maxReq distinct unanswered SMBs to the server when using */
714 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
715 unsigned int maxBuf; /* maxBuf specifies the maximum */
716 /* message size the server can send or receive for non-raw SMBs */
717 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
718 /* when socket is setup (and during reconnect) before NegProt sent */
719 unsigned int max_rw; /* maxRw specifies the maximum */
720 /* message size the server can send or receive for */
721 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
722 unsigned int capabilities; /* selective disabling of caps by smb sess */
723 int timeAdj; /* Adjust for difference in server time zone in sec */
724 __u64 CurrentMid; /* multiplex id - rotating counter, protected by GlobalMid_Lock */
725 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
726 /* 16th byte of RFC1001 workstation name is always null */
727 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
728 __u32 sequence_number; /* for signing, protected by srv_mutex */
729 __u32 reconnect_instance; /* incremented on each reconnect */
730 struct session_key session_key;
731 unsigned long lstrp; /* when we got last response from this server */
732 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
733 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
734 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
735 char negflavor; /* NEGOTIATE response flavor */
736 /* extended security flavors that server supports */
737 bool sec_ntlmssp; /* supports NTLMSSP */
738 bool sec_kerberosu2u; /* supports U2U Kerberos */
739 bool sec_kerberos; /* supports plain Kerberos */
740 bool sec_mskerberos; /* supports legacy MS Kerberos */
741 bool large_buf; /* is current buffer large? */
742 /* use SMBD connection instead of socket */
744 /* point to the SMBD connection if RDMA is used instead of socket */
745 struct smbd_connection *smbd_conn;
746 struct delayed_work echo; /* echo ping workqueue job */
747 char *smallbuf; /* pointer to current "small" buffer */
748 char *bigbuf; /* pointer to current "big" buffer */
749 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
750 unsigned int pdu_size;
751 unsigned int total_read; /* total amount of data read in this pass */
752 atomic_t in_send; /* requests trying to send */
753 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
754 #ifdef CONFIG_CIFS_STATS2
755 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
756 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
757 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
758 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
759 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
761 unsigned int max_read;
762 unsigned int max_write;
763 unsigned int min_offload;
764 unsigned int retrans;
765 __le16 compress_algorithm;
766 __u16 signing_algorithm;
768 /* save initital negprot hash */
769 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
770 bool signing_negotiated; /* true if valid signing context rcvd from server */
771 bool posix_ext_supported;
772 struct delayed_work reconnect; /* reconnect workqueue job */
773 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
774 unsigned long echo_interval;
777 * Number of targets available for reconnect. The more targets
778 * the more tasks have to wait to let the demultiplex thread
782 bool noblockcnt; /* use non-blocking connect() */
785 * If this is a session channel,
786 * primary_server holds the ref-counted
787 * pointer to primary channel connection for the session.
789 #define SERVER_IS_CHAN(server) (!!(server)->primary_server)
790 struct TCP_Server_Info *primary_server;
791 __u16 channel_sequence_num; /* incremented on primary channel on each chan reconnect */
793 #ifdef CONFIG_CIFS_SWN_UPCALL
794 bool use_swn_dstaddr;
795 struct sockaddr_storage swn_dstaddr;
797 struct mutex refpath_lock; /* protects leaf_fullpath */
799 * leaf_fullpath: Canonical DFS referral path related to this
801 * It is used in DFS cache refresher, reconnect and may
802 * change due to nested DFS links.
804 * Protected by @refpath_lock and @srv_lock. The @refpath_lock is
805 * mostly used for not requiring a copy of @leaf_fullpath when getting
806 * cached or new DFS referrals (which might also sleep during I/O).
807 * While @srv_lock is held for making string and NULL comparions against
808 * both fields as in mount(2) and cache refresh.
810 * format: \\HOST\SHARE[\OPTIONAL PATH]
815 static inline bool is_smb1(struct TCP_Server_Info *server)
817 return HEADER_PREAMBLE_SIZE(server) != 0;
820 static inline void cifs_server_lock(struct TCP_Server_Info *server)
822 unsigned int nofs_flag = memalloc_nofs_save();
824 mutex_lock(&server->_srv_mutex);
825 server->nofs_flag = nofs_flag;
828 static inline void cifs_server_unlock(struct TCP_Server_Info *server)
830 unsigned int nofs_flag = server->nofs_flag;
832 mutex_unlock(&server->_srv_mutex);
833 memalloc_nofs_restore(nofs_flag);
836 struct cifs_credits {
838 unsigned int instance;
841 static inline unsigned int
842 in_flight(struct TCP_Server_Info *server)
846 spin_lock(&server->req_lock);
847 num = server->in_flight;
848 spin_unlock(&server->req_lock);
853 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
857 spin_lock(&server->req_lock);
859 spin_unlock(&server->req_lock);
860 return num >= num_credits;
864 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
867 server->ops->add_credits(server, credits, optype);
871 add_credits_and_wake_if(struct TCP_Server_Info *server,
872 const struct cifs_credits *credits, const int optype)
874 if (credits->value) {
875 server->ops->add_credits(server, credits, optype);
876 wake_up(&server->request_q);
881 set_credits(struct TCP_Server_Info *server, const int val)
883 server->ops->set_credits(server, val);
887 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
888 const unsigned int payload_size)
890 return server->ops->adjust_credits ?
891 server->ops->adjust_credits(server, credits, payload_size) : 0;
895 get_next_mid64(struct TCP_Server_Info *server)
897 return cpu_to_le64(server->ops->get_next_mid(server));
901 get_next_mid(struct TCP_Server_Info *server)
903 __u16 mid = server->ops->get_next_mid(server);
905 * The value in the SMB header should be little endian for easy
906 * on-the-wire decoding.
908 return cpu_to_le16(mid);
912 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
914 if (server->ops->revert_current_mid)
915 server->ops->revert_current_mid(server, val);
919 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
920 const struct smb2_hdr *shdr)
922 unsigned int num = le16_to_cpu(shdr->CreditCharge);
924 return revert_current_mid(server, num > 0 ? num : 1);
928 get_mid(const struct smb_hdr *smb)
930 return le16_to_cpu(smb->Mid);
934 compare_mid(__u16 mid, const struct smb_hdr *smb)
936 return mid == le16_to_cpu(smb->Mid);
940 * When the server supports very large reads and writes via POSIX extensions,
941 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
942 * including the RFC1001 length.
944 * Note that this might make for "interesting" allocation problems during
945 * writeback however as we have to allocate an array of pointers for the
946 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
948 * For reads, there is a similar problem as we need to allocate an array
949 * of kvecs to handle the receive, though that should only need to be done
952 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
953 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
956 * When the server doesn't allow large posix writes, only allow a rsize/wsize
957 * of 2^17-1 minus the size of the call header. That allows for a read or
958 * write up to the maximum size described by RFC1002.
960 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
961 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
963 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
966 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
967 * those values when posix extensions aren't in force. In actuality here, we
968 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
969 * to be ok with the extra byte even though Windows doesn't send writes that
974 * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
976 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
977 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
980 * Macros to allow the TCP_Server_Info->net field and related code to drop out
981 * when CONFIG_NET_NS isn't set.
986 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
991 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
998 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
1003 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
1009 struct cifs_server_iface {
1010 struct list_head iface_head;
1011 struct kref refcount;
1013 size_t weight_fulfilled;
1014 unsigned int num_channels;
1015 unsigned int rdma_capable : 1;
1016 unsigned int rss_capable : 1;
1017 unsigned int is_active : 1; /* unset if non existent */
1018 struct sockaddr_storage sockaddr;
1021 /* release iface when last ref is dropped */
1023 release_iface(struct kref *ref)
1025 struct cifs_server_iface *iface = container_of(ref,
1026 struct cifs_server_iface,
1032 unsigned int in_reconnect : 1; /* if session setup in progress for this channel */
1033 struct TCP_Server_Info *server;
1034 struct cifs_server_iface *iface; /* interface in use */
1035 __u8 signkey[SMB3_SIGN_KEY_SIZE];
1038 #define CIFS_SES_FLAG_SCALE_CHANNELS (0x1)
1041 * Session structure. One of these for each uid session with a particular host
1044 struct list_head smb_ses_list;
1045 struct list_head rlist; /* reconnect list */
1046 struct list_head tcon_list;
1047 struct cifs_tcon *tcon_ipc;
1048 spinlock_t ses_lock; /* protect anything here that is not protected */
1049 struct mutex session_mutex;
1050 struct TCP_Server_Info *server; /* pointer to server info */
1051 int ses_count; /* reference counter */
1052 enum ses_status_enum ses_status; /* updates protected by cifs_tcp_ses_lock */
1053 unsigned int overrideSecFlg; /* if non-zero override global sec flags */
1054 char *serverOS; /* name of operating system underlying server */
1055 char *serverNOS; /* name of network operating system of server */
1056 char *serverDomain; /* security realm of server */
1057 __u64 Suid; /* remote smb uid */
1058 kuid_t linux_uid; /* overriding owner of files on the mount */
1059 kuid_t cred_uid; /* owner of credentials */
1060 unsigned int capabilities;
1061 char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */
1062 char *user_name; /* must not be null except during init of sess
1063 and after mount option parsing we fill it */
1066 char workstation_name[CIFS_MAX_WORKSTATION_LEN];
1067 struct session_key auth_key;
1068 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
1069 enum securityEnum sectype; /* what security flavor was specified? */
1070 bool sign; /* is signing required? */
1072 bool expired_pwd; /* track if access denied or expired pwd so can know if need to update */
1074 __u16 session_flags;
1075 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
1076 __u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1077 __u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1078 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1081 * Network interfaces available on the server this session is
1084 * Other channels can be opened by connecting and binding this
1085 * session to interfaces from this list.
1087 * iface_lock should be taken when accessing any of these fields
1089 spinlock_t iface_lock;
1090 /* ========= begin: protected by iface_lock ======== */
1091 struct list_head iface_list;
1093 unsigned long iface_last_update; /* jiffies */
1094 /* ========= end: protected by iface_lock ======== */
1096 spinlock_t chan_lock;
1097 /* ========= begin: protected by chan_lock ======== */
1098 #define CIFS_MAX_CHANNELS 16
1099 #define CIFS_INVAL_CHAN_INDEX (-1)
1100 #define CIFS_ALL_CHANNELS_SET(ses) \
1101 ((1UL << (ses)->chan_count) - 1)
1102 #define CIFS_ALL_CHANS_GOOD(ses) \
1103 (!(ses)->chans_need_reconnect)
1104 #define CIFS_ALL_CHANS_NEED_RECONNECT(ses) \
1105 ((ses)->chans_need_reconnect == CIFS_ALL_CHANNELS_SET(ses))
1106 #define CIFS_SET_ALL_CHANS_NEED_RECONNECT(ses) \
1107 ((ses)->chans_need_reconnect = CIFS_ALL_CHANNELS_SET(ses))
1108 #define CIFS_CHAN_NEEDS_RECONNECT(ses, index) \
1109 test_bit((index), &(ses)->chans_need_reconnect)
1110 #define CIFS_CHAN_IN_RECONNECT(ses, index) \
1111 ((ses)->chans[(index)].in_reconnect)
1113 struct cifs_chan chans[CIFS_MAX_CHANNELS];
1116 atomic_t chan_seq; /* round robin state */
1119 * chans_need_reconnect is a bitmap indicating which of the channels
1120 * under this smb session needs to be reconnected.
1121 * If not multichannel session, only one bit will be used.
1123 * We will ask for sess and tcon reconnection only if all the
1124 * channels are marked for needing reconnection. This will
1125 * enable the sessions on top to continue to live till any
1126 * of the channels below are active.
1128 unsigned long chans_need_reconnect;
1129 /* ========= end: protected by chan_lock ======== */
1130 struct cifs_ses *dfs_root_ses;
1131 struct nls_table *local_nls;
1135 cap_unix(struct cifs_ses *ses)
1137 return ses->server->vals->cap_unix & ses->capabilities;
1141 * common struct for holding inode info when searching for or updating an
1142 * inode with new info
1145 #define CIFS_FATTR_JUNCTION 0x1
1146 #define CIFS_FATTR_DELETE_PENDING 0x2
1147 #define CIFS_FATTR_NEED_REVAL 0x4
1148 #define CIFS_FATTR_INO_COLLISION 0x8
1149 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1150 #define CIFS_FATTR_FAKE_ROOT_INO 0x20
1163 unsigned int cf_nlink;
1164 unsigned int cf_dtype;
1165 struct timespec64 cf_atime;
1166 struct timespec64 cf_mtime;
1167 struct timespec64 cf_ctime;
1169 char *cf_symlink_target;
1173 * there is one of these for each connection to a resource on a particular
1177 struct list_head tcon_list;
1179 struct list_head rlist; /* reconnect list */
1180 spinlock_t tc_lock; /* protect anything here that is not protected */
1181 atomic_t num_local_opens; /* num of all opens including disconnected */
1182 atomic_t num_remote_opens; /* num of all network opens on server */
1183 struct list_head openFileList;
1184 spinlock_t open_file_lock; /* protects list above */
1185 struct cifs_ses *ses; /* pointer to session associated with */
1186 char tree_name[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1187 char *nativeFileSystem;
1188 char *password; /* for share-level security */
1189 __u32 tid; /* The 4 byte tree id */
1190 __u16 Flags; /* optional support bits */
1191 enum tid_status_enum status;
1192 atomic_t num_smbs_sent;
1195 atomic_t num_writes;
1197 atomic_t num_flushes;
1198 atomic_t num_oplock_brks;
1200 atomic_t num_closes;
1201 atomic_t num_deletes;
1202 atomic_t num_mkdirs;
1203 atomic_t num_posixopens;
1204 atomic_t num_posixmkdirs;
1205 atomic_t num_rmdirs;
1206 atomic_t num_renames;
1207 atomic_t num_t2renames;
1208 atomic_t num_ffirst;
1210 atomic_t num_fclose;
1211 atomic_t num_hardlinks;
1212 atomic_t num_symlinks;
1214 atomic_t num_acl_get;
1215 atomic_t num_acl_set;
1218 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1219 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1223 __u64 bytes_written;
1224 spinlock_t stat_lock; /* protects the two fields above */
1225 time64_t stats_from_time;
1226 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1227 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1228 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1229 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
1230 bool pipe:1; /* set if connection to pipe share */
1231 bool print:1; /* set if connection to printer share */
1234 bool nohandlecache:1; /* if strange server resource prob can turn off */
1236 bool seal:1; /* transport encryption for this mounted share */
1237 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
1238 for this mount even if server would support */
1239 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1240 bool local_lease:1; /* check leases (only) on local system not remote */
1241 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1242 bool broken_sparse_sup; /* if server or share does not support sparse */
1243 bool need_reconnect:1; /* connection reset, tid now invalid */
1244 bool need_reopen_files:1; /* need to reopen tcon file handles */
1245 bool use_resilient:1; /* use resilient instead of durable handles */
1246 bool use_persistent:1; /* use persistent instead of durable handles */
1247 bool no_lease:1; /* Do not request leases on files or directories */
1248 bool use_witness:1; /* use witness protocol */
1249 __le32 capabilities;
1251 __u32 maximal_access;
1252 __u32 vol_serial_number;
1253 __le64 vol_create_time;
1254 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1255 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
1256 __u32 ss_flags; /* sector size flags */
1257 __u32 perf_sector_size; /* best sector size for perf */
1259 __u32 max_bytes_chunk;
1260 __u32 max_bytes_copy;
1261 __u32 max_cached_dirs;
1262 #ifdef CONFIG_CIFS_FSCACHE
1263 u64 resource_id; /* server resource id */
1264 struct fscache_volume *fscache; /* cookie for share */
1266 struct list_head pending_opens; /* list of incomplete opens */
1267 struct cached_fids *cfids;
1268 /* BB add field for back pointer to sb struct(s)? */
1269 #ifdef CONFIG_CIFS_DFS_UPCALL
1270 struct delayed_work dfs_cache_work;
1272 struct delayed_work query_interfaces; /* query interfaces workqueue job */
1273 char *origin_fullpath; /* canonical copy of smb3_fs_context::source */
1277 * This is a refcounted and timestamped container for a tcon pointer. The
1278 * container holds a tcon reference. It is considered safe to free one of
1279 * these when the tl_count goes to 0. The tl_time is the time of the last
1280 * "get" on the container.
1283 struct rb_node tl_rbnode;
1285 unsigned long tl_flags;
1286 #define TCON_LINK_MASTER 0
1287 #define TCON_LINK_PENDING 1
1288 #define TCON_LINK_IN_TREE 2
1289 unsigned long tl_time;
1291 struct cifs_tcon *tl_tcon;
1294 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1295 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1297 static inline struct cifs_tcon *
1298 tlink_tcon(struct tcon_link *tlink)
1300 return tlink->tl_tcon;
1303 static inline struct tcon_link *
1304 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1306 return cifs_sb->master_tlink;
1309 extern void cifs_put_tlink(struct tcon_link *tlink);
1311 static inline struct tcon_link *
1312 cifs_get_tlink(struct tcon_link *tlink)
1314 if (tlink && !IS_ERR(tlink))
1315 atomic_inc(&tlink->tl_count);
1319 /* This function is always expected to succeed */
1320 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1322 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1324 struct cifs_pending_open {
1325 struct list_head olist;
1326 struct tcon_link *tlink;
1331 struct cifs_deferred_close {
1332 struct list_head dlist;
1333 struct tcon_link *tlink;
1335 __u64 persistent_fid;
1340 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1341 * This is used to track byte stream locks on the file
1343 struct cifsLockInfo {
1344 struct list_head llist; /* pointer to next cifsLockInfo */
1345 struct list_head blist; /* pointer to locks blocked on this */
1346 wait_queue_head_t block_q;
1355 * One of these for each open instance of a file
1357 struct cifs_search_info {
1358 loff_t index_of_last_entry;
1359 __u16 entries_in_buffer;
1362 char *ntwrk_buf_start;
1363 char *srch_entries_start;
1365 const char *presume_name;
1366 unsigned int resume_name_len;
1370 bool smallBuf:1; /* so we know which buf_release function to call */
1373 #define ACL_NO_MODE ((umode_t)(-1))
1374 struct cifs_open_parms {
1375 struct cifs_tcon *tcon;
1376 struct cifs_sb_info *cifs_sb;
1381 struct cifs_fid *fid;
1384 bool replay:1; /* indicates that this open is for a replay */
1389 __u64 persistent_fid; /* persist file id for smb2 */
1390 __u64 volatile_fid; /* volatile file id for smb2 */
1391 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1392 __u8 create_guid[16];
1394 struct cifs_pending_open *pending_open;
1396 #ifdef CONFIG_CIFS_DEBUG2
1398 #endif /* CIFS_DEBUG2 */
1402 struct cifs_fid_locks {
1403 struct list_head llist;
1404 struct cifsFileInfo *cfile; /* fid that owns locks */
1405 struct list_head locks; /* locks held by fid above */
1408 struct cifsFileInfo {
1409 /* following two lists are protected by tcon->open_file_lock */
1410 struct list_head tlist; /* pointer to next fid owned by tcon */
1411 struct list_head flist; /* next fid (file instance) for this inode */
1412 /* lock list below protected by cifsi->lock_sem */
1413 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1414 kuid_t uid; /* allows finding which FileInfo structure */
1415 __u32 pid; /* process id who opened file */
1416 struct cifs_fid fid; /* file id from remote */
1417 struct list_head rlist; /* reconnect list */
1418 /* BB add lock scope info here if needed */
1419 /* lock scope id (0 if none) */
1420 struct dentry *dentry;
1421 struct tcon_link *tlink;
1422 unsigned int f_flags;
1423 bool invalidHandle:1; /* file closed via session abend */
1425 bool oplock_break_cancelled:1;
1426 bool offload:1; /* offload final part of _put to a wq */
1427 unsigned int oplock_epoch; /* epoch from the lease break */
1428 __u32 oplock_level; /* oplock/lease level from the lease break */
1430 spinlock_t file_info_lock; /* protects four flag/count fields above */
1431 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1432 struct cifs_search_info srch_inf;
1433 struct work_struct oplock_break; /* work for oplock breaks */
1434 struct work_struct put; /* work for the final part of _put */
1435 struct work_struct serverclose; /* work for serverclose */
1436 struct delayed_work deferred;
1437 bool deferred_close_scheduled; /* Flag to indicate close is scheduled */
1438 char *symlink_target;
1441 struct cifs_io_parms {
1443 __u64 persistent_fid; /* persist file id for smb2 */
1444 __u64 volatile_fid; /* volatile file id for smb2 */
1447 unsigned int length;
1448 struct cifs_tcon *tcon;
1449 struct TCP_Server_Info *server;
1452 struct cifs_aio_ctx {
1453 struct kref refcount;
1454 struct list_head list;
1455 struct mutex aio_mutex;
1456 struct completion done;
1457 struct iov_iter iter;
1459 struct cifsFileInfo *cfile;
1462 unsigned int nr_pinned_pages;
1465 unsigned int total_len;
1466 unsigned int bv_need_unpin; /* If ->bv[] needs unpinning */
1469 * Indicates if this aio_ctx is for direct_io,
1470 * If yes, iter is a copy of the user passed iov_iter
1475 /* asynchronous read support */
1476 struct cifs_readdata {
1477 struct kref refcount;
1478 struct list_head list;
1479 struct completion done;
1480 struct cifsFileInfo *cfile;
1481 struct address_space *mapping;
1482 struct cifs_aio_ctx *ctx;
1488 struct work_struct work;
1489 struct iov_iter iter;
1491 struct TCP_Server_Info *server;
1492 #ifdef CONFIG_CIFS_SMB_DIRECT
1495 struct cifs_credits credits;
1498 /* asynchronous write support */
1499 struct cifs_writedata {
1500 struct kref refcount;
1501 struct list_head list;
1502 struct completion done;
1503 enum writeback_sync_modes sync_mode;
1504 struct work_struct work;
1505 struct cifsFileInfo *cfile;
1506 struct cifs_aio_ctx *ctx;
1507 struct iov_iter iter;
1513 struct TCP_Server_Info *server;
1514 #ifdef CONFIG_CIFS_SMB_DIRECT
1517 struct cifs_credits credits;
1522 * Take a reference on the file private data. Must be called with
1523 * cfile->file_info_lock held.
1526 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1531 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1532 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1534 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1536 #define CIFS_CACHE_READ_FLG 1
1537 #define CIFS_CACHE_HANDLE_FLG 2
1538 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1539 #define CIFS_CACHE_WRITE_FLG 4
1540 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1541 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1543 #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))
1544 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1545 #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))
1548 * One of these for each file inode
1551 struct cifsInodeInfo {
1552 struct netfs_inode netfs; /* Netfslib context and vfs inode */
1553 bool can_cache_brlcks;
1554 struct list_head llist; /* locks helb by this inode */
1556 * NOTE: Some code paths call down_read(lock_sem) twice, so
1557 * we must always use cifs_down_write() instead of down_write()
1558 * for this semaphore to avoid deadlocks.
1560 struct rw_semaphore lock_sem; /* protect the fields above */
1561 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1562 struct list_head openFileList;
1563 spinlock_t open_file_lock; /* protects openFileList */
1564 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1565 unsigned int oplock; /* oplock/lease level we have */
1566 unsigned int epoch; /* used to track lease state changes */
1567 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1568 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1569 #define CIFS_INODE_FLAG_UNUSED (2) /* Unused flag */
1570 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1571 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1572 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1573 #define CIFS_INO_MODIFIED_ATTR (6) /* Indicate change in mtime/ctime */
1574 #define CIFS_INO_CLOSE_ON_LOCK (7) /* Not to defer the close when lock is set */
1575 unsigned long flags;
1576 spinlock_t writers_lock;
1577 unsigned int writers; /* Number of writers on this inode */
1578 unsigned long time; /* jiffies of last update of inode */
1579 u64 uniqueid; /* server inode number */
1580 u64 createtime; /* creation time on server */
1581 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1582 struct list_head deferred_closes; /* list of deferred closes */
1583 spinlock_t deferred_lock; /* protection on deferred list */
1584 bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */
1585 char *symlink_target;
1589 static inline struct cifsInodeInfo *
1590 CIFS_I(struct inode *inode)
1592 return container_of(inode, struct cifsInodeInfo, netfs.inode);
1595 static inline struct cifs_sb_info *
1596 CIFS_SB(struct super_block *sb)
1598 return sb->s_fs_info;
1601 static inline struct cifs_sb_info *
1602 CIFS_FILE_SB(struct file *file)
1604 return CIFS_SB(file_inode(file)->i_sb);
1607 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1609 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1616 convert_delimiter(char *path, char delim)
1618 char old_delim, *pos;
1626 while ((pos = strchr(pos, old_delim)))
1630 #define cifs_stats_inc atomic_inc
1632 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1636 spin_lock(&tcon->stat_lock);
1637 tcon->bytes_written += bytes;
1638 spin_unlock(&tcon->stat_lock);
1642 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1645 spin_lock(&tcon->stat_lock);
1646 tcon->bytes_read += bytes;
1647 spin_unlock(&tcon->stat_lock);
1652 * This is the prototype for the mid receive function. This function is for
1653 * receiving the rest of the SMB frame, starting with the WordCount (which is
1654 * just after the MID in struct smb_hdr). Note:
1656 * - This will be called by cifsd, with no locks held.
1657 * - The mid will still be on the pending_mid_q.
1658 * - mid->resp_buf will point to the current buffer.
1660 * Returns zero on a successful receive, or an error. The receive state in
1661 * the TCP_Server_Info will also be updated.
1663 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1664 struct mid_q_entry *mid);
1667 * This is the prototype for the mid callback function. This is called once the
1668 * mid has been received off of the socket. When creating one, take special
1669 * care to avoid deadlocks. Things to bear in mind:
1671 * - it will be called by cifsd, with no locks held
1672 * - the mid will be removed from any lists
1674 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1677 * This is the protopyte for mid handle function. This is called once the mid
1678 * has been recognized after decryption of the message.
1680 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1681 struct mid_q_entry *mid);
1683 /* one of these for every pending CIFS request to the server */
1684 struct mid_q_entry {
1685 struct list_head qhead; /* mids waiting on reply from this server */
1686 struct kref refcount;
1687 struct TCP_Server_Info *server; /* server corresponding to this mid */
1688 __u64 mid; /* multiplex id */
1689 __u16 credits; /* number of credits consumed by this mid */
1690 __u16 credits_received; /* number of credits from the response */
1691 __u32 pid; /* process id */
1692 __u32 sequence_number; /* for CIFS signing */
1693 unsigned long when_alloc; /* when mid was created */
1694 #ifdef CONFIG_CIFS_STATS2
1695 unsigned long when_sent; /* time when smb send finished */
1696 unsigned long when_received; /* when demux complete (taken off wire) */
1698 mid_receive_t *receive; /* call receive callback */
1699 mid_callback_t *callback; /* call completion callback */
1700 mid_handle_t *handle; /* call handle mid callback */
1701 void *callback_data; /* general purpose pointer for callback */
1702 struct task_struct *creator;
1703 void *resp_buf; /* pointer to received SMB header */
1704 unsigned int resp_buf_size;
1705 int mid_state; /* wish this were enum but can not pass to wait_event */
1706 unsigned int mid_flags;
1707 __le16 command; /* smb command code */
1708 unsigned int optype; /* operation type */
1709 bool large_buf:1; /* if valid response, is pointer to large buf */
1710 bool multiRsp:1; /* multiple trans2 responses for one request */
1711 bool multiEnd:1; /* both received */
1712 bool decrypted:1; /* decrypted entry */
1715 struct close_cancelled_open {
1716 struct cifs_fid fid;
1717 struct cifs_tcon *tcon;
1718 struct work_struct work;
1723 /* Make code in transport.c a little cleaner by moving
1724 update of optional stats into function below */
1725 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1727 atomic_inc(&server->in_send);
1730 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1732 atomic_dec(&server->in_send);
1735 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1737 atomic_inc(&server->num_waiters);
1740 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1742 atomic_dec(&server->num_waiters);
1745 #ifdef CONFIG_CIFS_STATS2
1746 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1748 mid->when_sent = jiffies;
1751 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1756 /* for pending dnotify requests */
1757 struct dir_notify_req {
1758 struct list_head lhead;
1765 __u32 filter; /* CompletionFilter (for multishot) */
1770 struct dfs_info3_param {
1771 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1781 struct list_head list;
1782 struct cifsFileInfo *cfile;
1785 struct cifs_mount_ctx {
1786 struct cifs_sb_info *cifs_sb;
1787 struct smb3_fs_context *fs_ctx;
1789 struct TCP_Server_Info *server;
1790 struct cifs_ses *ses;
1791 struct cifs_tcon *tcon;
1794 static inline void __free_dfs_info_param(struct dfs_info3_param *param)
1796 kfree(param->path_name);
1797 kfree(param->node_name);
1800 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1803 __free_dfs_info_param(param);
1806 static inline void zfree_dfs_info_param(struct dfs_info3_param *param)
1809 __free_dfs_info_param(param);
1810 memset(param, 0, sizeof(*param));
1814 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1815 int number_of_items)
1819 if ((number_of_items == 0) || (param == NULL))
1821 for (i = 0; i < number_of_items; i++) {
1822 kfree(param[i].path_name);
1823 kfree(param[i].node_name);
1828 static inline bool is_interrupt_error(int error)
1833 case -ERESTARTNOHAND:
1834 case -ERESTARTNOINTR:
1840 static inline bool is_retryable_error(int error)
1842 if (is_interrupt_error(error) || error == -EAGAIN)
1847 static inline bool is_replayable_error(int error)
1849 if (error == -EAGAIN || error == -ECONNABORTED)
1855 /* cifs_get_writable_file() flags */
1856 #define FIND_WR_ANY 0
1857 #define FIND_WR_FSUID_ONLY 1
1858 #define FIND_WR_WITH_DELETE 2
1861 #define MID_REQUEST_ALLOCATED 1
1862 #define MID_REQUEST_SUBMITTED 2
1863 #define MID_RESPONSE_RECEIVED 4
1864 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1865 #define MID_RESPONSE_MALFORMED 0x10
1866 #define MID_SHUTDOWN 0x20
1867 #define MID_RESPONSE_READY 0x40 /* ready for other process handle the rsp */
1870 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1871 #define MID_DELETED 2 /* Mid has been dequeued/deleted */
1873 /* Types of response buffer returned from SendReceive2 */
1874 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1875 #define CIFS_SMALL_BUFFER 1
1876 #define CIFS_LARGE_BUFFER 2
1877 #define CIFS_IOVEC 4 /* array of response buffers */
1879 /* Type of Request to SendReceive2 */
1880 #define CIFS_BLOCKING_OP 1 /* operation can block */
1881 #define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */
1882 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1883 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1884 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1885 #define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */
1887 /* Type of request operation */
1888 #define CIFS_ECHO_OP 0x080 /* echo request */
1889 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1890 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1891 #define CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */
1892 /* Lower bitmask values are reserved by others below. */
1893 #define CIFS_SESS_OP 0x2000 /* session setup request */
1894 #define CIFS_OP_MASK 0x2780 /* mask request type */
1896 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1897 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1898 #define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */
1900 /* Security Flags: indicate type of session setup needed */
1901 #define CIFSSEC_MAY_SIGN 0x00001
1902 #define CIFSSEC_MAY_NTLMV2 0x00004
1903 #define CIFSSEC_MAY_KRB5 0x00008
1904 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1905 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1907 #define CIFSSEC_MUST_SIGN 0x01001
1908 /* note that only one of the following can be set so the
1909 result of setting MUST flags more than once will be to
1910 require use of the stronger protocol */
1911 #define CIFSSEC_MUST_NTLMV2 0x04004
1912 #define CIFSSEC_MUST_KRB5 0x08008
1913 #ifdef CONFIG_CIFS_UPCALL
1914 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1916 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1918 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1919 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1921 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1922 #define CIFSSEC_MAX (CIFSSEC_MUST_NTLMV2)
1923 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1925 *****************************************************************
1926 * All constants go here
1927 *****************************************************************
1930 #define UID_HASH (16)
1933 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1934 * following to be declared.
1937 /****************************************************************************
1938 * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according
1939 * to the locking order. i.e. if two locks are to be held together, the lock that
1940 * appears higher in this list needs to be taken before the other.
1942 * If you hold a lock that is lower in this list, and you need to take a higher lock
1943 * (or if you think that one of the functions that you're calling may need to), first
1944 * drop the lock you hold, pick up the higher lock, then the lower one. This will
1945 * ensure that locks are picked up only in one direction in the below table
1948 * Also, if you expect a function to be called with a lock held, explicitly document
1949 * this in the comments on top of your function definition.
1951 * And also, try to keep the critical sections (lock hold time) to be as minimal as
1952 * possible. Blocking / calling other functions with a lock held always increase
1953 * the risk of a possible deadlock.
1955 * Following this rule will avoid unnecessary deadlocks, which can get really hard to
1956 * debug. Also, any new lock that you introduce, please add to this list in the correct
1959 * Please populate this list whenever you introduce new locks in your changes. Or in
1960 * case I've missed some existing locks. Please ensure that it's added in the list
1961 * based on the locking order expected.
1963 * =====================================================================================
1964 * Lock Protects Initialization fn
1965 * =====================================================================================
1967 * vol_info->ctx_lock vol_info->ctx
1968 * cifs_sb_info->tlink_tree_lock cifs_sb_info->tlink_tree cifs_setup_cifs_sb
1969 * TCP_Server_Info-> TCP_Server_Info cifs_get_tcp_session
1971 * TCP_Server_Info->srv_mutex TCP_Server_Info cifs_get_tcp_session
1972 * cifs_ses->session_mutex cifs_ses sesInfoAlloc
1974 * cifs_tcon->open_file_lock cifs_tcon->openFileList tconInfoAlloc
1975 * cifs_tcon->pending_opens
1976 * cifs_tcon->stat_lock cifs_tcon->bytes_read tconInfoAlloc
1977 * cifs_tcon->bytes_written
1978 * cifs_tcp_ses_lock cifs_tcp_ses_list sesInfoAlloc
1979 * GlobalMid_Lock GlobalMaxActiveXid init_cifs
1981 * GlobalTotalActiveXid
1982 * TCP_Server_Info->srv_lock (anything in struct not protected by another lock and can change)
1983 * TCP_Server_Info->mid_lock TCP_Server_Info->pending_mid_q cifs_get_tcp_session
1985 * (any changes in mid_q_entry fields)
1986 * TCP_Server_Info->req_lock TCP_Server_Info->in_flight cifs_get_tcp_session
1990 * ->reconnect_instance
1991 * cifs_ses->ses_lock (anything that is not protected by another lock and can change)
1992 * cifs_ses->iface_lock cifs_ses->iface_list sesInfoAlloc
1994 * ->iface_last_update
1995 * cifs_ses->chan_lock cifs_ses->chans
1996 * ->chans_need_reconnect
1997 * ->chans_in_reconnect
1998 * cifs_tcon->tc_lock (anything that is not protected by another lock and can change)
1999 * cifsInodeInfo->open_file_lock cifsInodeInfo->openFileList cifs_alloc_inode
2000 * cifsInodeInfo->writers_lock cifsInodeInfo->writers cifsInodeInfo_alloc
2001 * cifsInodeInfo->lock_sem cifsInodeInfo->llist cifs_init_once
2002 * ->can_cache_brlcks
2003 * cifsInodeInfo->deferred_lock cifsInodeInfo->deferred_closes cifsInodeInfo_alloc
2004 * cached_fid->fid_mutex cifs_tcon->crfid tcon_info_alloc
2005 * cifsFileInfo->fh_mutex cifsFileInfo cifs_new_fileinfo
2006 * cifsFileInfo->file_info_lock cifsFileInfo->count cifs_new_fileinfo
2007 * ->invalidHandle initiate_cifs_search
2008 * ->oplock_break_cancelled
2009 * cifs_aio_ctx->aio_mutex cifs_aio_ctx cifs_aio_ctx_alloc
2010 ****************************************************************************/
2012 #ifdef DECLARE_GLOBALS_HERE
2013 #define GLOBAL_EXTERN
2015 #define GLOBAL_EXTERN extern
2019 * the list of TCP_Server_Info structures, ie each of the sockets
2020 * connecting our client to a distinct server (ip address), is
2021 * chained together by cifs_tcp_ses_list. The list of all our SMB
2022 * sessions (and from that the tree connections) can be found
2023 * by iterating over cifs_tcp_ses_list
2025 extern struct list_head cifs_tcp_ses_list;
2028 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
2029 * tcp session, and the list of tcon's per smb session. It also protects
2030 * the reference counters for the server, smb session, and tcon.
2031 * generally the locks should be taken in order tcp_ses_lock before
2032 * tcon->open_file_lock and that before file->file_info_lock since the
2033 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
2035 extern spinlock_t cifs_tcp_ses_lock;
2038 * Global transaction id (XID) information
2040 extern unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
2041 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
2042 extern unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
2043 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */
2046 * Global counters, updated atomically
2048 extern atomic_t sesInfoAllocCount;
2049 extern atomic_t tconInfoAllocCount;
2050 extern atomic_t tcpSesNextId;
2051 extern atomic_t tcpSesAllocCount;
2052 extern atomic_t tcpSesReconnectCount;
2053 extern atomic_t tconInfoReconnectCount;
2055 /* Various Debug counters */
2056 extern atomic_t buf_alloc_count; /* current number allocated */
2057 extern atomic_t small_buf_alloc_count;
2058 #ifdef CONFIG_CIFS_STATS2
2059 extern atomic_t total_buf_alloc_count; /* total allocated over all time */
2060 extern atomic_t total_small_buf_alloc_count;
2061 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
2065 extern bool enable_oplocks; /* enable or disable oplocks */
2066 extern bool lookupCacheEnabled;
2067 extern unsigned int global_secflags; /* if on, session setup sent
2068 with more secure ntlmssp2 challenge/resp */
2069 extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
2070 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
2071 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
2072 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */
2073 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
2074 extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
2075 extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
2076 extern unsigned int cifs_min_small; /* min size of small buf pool */
2077 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
2078 extern unsigned int dir_cache_timeout; /* max time for directory lease caching of dir */
2079 extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
2080 extern atomic_t mid_count;
2082 void cifs_oplock_break(struct work_struct *work);
2083 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
2084 void smb2_deferred_work_close(struct work_struct *work);
2086 extern const struct slow_work_ops cifs_oplock_break_ops;
2087 extern struct workqueue_struct *cifsiod_wq;
2088 extern struct workqueue_struct *decrypt_wq;
2089 extern struct workqueue_struct *fileinfo_put_wq;
2090 extern struct workqueue_struct *cifsoplockd_wq;
2091 extern struct workqueue_struct *deferredclose_wq;
2092 extern struct workqueue_struct *serverclose_wq;
2093 extern __u32 cifs_lock_secret;
2095 extern mempool_t *cifs_mid_poolp;
2097 /* Operations for different SMB versions */
2098 #define SMB1_VERSION_STRING "1.0"
2099 #define SMB20_VERSION_STRING "2.0"
2100 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
2101 extern struct smb_version_operations smb1_operations;
2102 extern struct smb_version_values smb1_values;
2103 extern struct smb_version_operations smb20_operations;
2104 extern struct smb_version_values smb20_values;
2105 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
2106 #define SMB21_VERSION_STRING "2.1"
2107 extern struct smb_version_operations smb21_operations;
2108 extern struct smb_version_values smb21_values;
2109 #define SMBDEFAULT_VERSION_STRING "default"
2110 extern struct smb_version_values smbdefault_values;
2111 #define SMB3ANY_VERSION_STRING "3"
2112 extern struct smb_version_values smb3any_values;
2113 #define SMB30_VERSION_STRING "3.0"
2114 extern struct smb_version_operations smb30_operations;
2115 extern struct smb_version_values smb30_values;
2116 #define SMB302_VERSION_STRING "3.02"
2117 #define ALT_SMB302_VERSION_STRING "3.0.2"
2118 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2119 extern struct smb_version_values smb302_values;
2120 #define SMB311_VERSION_STRING "3.1.1"
2121 #define ALT_SMB311_VERSION_STRING "3.11"
2122 extern struct smb_version_operations smb311_operations;
2123 extern struct smb_version_values smb311_values;
2125 static inline char *get_security_type_str(enum securityEnum sectype)
2129 return "RawNTLMSSP";
2139 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2141 return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2144 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2147 * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2148 * Subsystem Notifies That a Share Is a DFS Share.
2150 * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2151 * Application Updates a Share.
2153 if (!tcon || !tcon->ses || !tcon->ses->server)
2155 return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2156 tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2159 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon,
2160 const struct dfs_info3_param *ref)
2163 * Check if all targets are capable of handling DFS referrals as per
2164 * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL.
2166 return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER));
2169 static inline u64 cifs_flock_len(const struct file_lock *fl)
2171 return (u64)fl->fl_end - fl->fl_start + 1;
2174 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses)
2176 if (WARN_ON_ONCE(!ses || !ses->server))
2179 * Make workstation name no more than 15 chars when using insecure dialects as some legacy
2180 * servers do require it during NTLMSSP.
2182 if (ses->server->dialect <= SMB20_PROT_ID)
2183 return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL);
2184 return sizeof(ses->workstation_name);
2187 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src)
2189 memcpy(dst, src, (size_t)((u8 *)&src->AccessFlags - (u8 *)src));
2190 dst->AccessFlags = src->AccessFlags;
2191 dst->CurrentByteOffset = src->CurrentByteOffset;
2192 dst->Mode = src->Mode;
2193 dst->AlignmentRequirement = src->AlignmentRequirement;
2194 dst->FileNameLength = src->FileNameLength;
2197 static inline int cifs_get_num_sgs(const struct smb_rqst *rqst,
2201 unsigned int len, skip;
2202 unsigned int nents = 0;
2208 * The first rqst has a transform header where the first 20 bytes are
2209 * not part of the encrypted blob.
2213 /* Assumes the first rqst has a transform header as the first iov.
2215 * rqst[0].rq_iov[0] is transform header
2216 * rqst[0].rq_iov[1+] data to be encrypted/decrypted
2217 * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
2219 for (i = 0; i < num_rqst; i++) {
2220 data_size = iov_iter_count(&rqst[i].rq_iter);
2222 /* We really don't want a mixture of pinned and unpinned pages
2223 * in the sglist. It's hard to keep track of which is what.
2224 * Instead, we convert to a BVEC-type iterator higher up.
2227 WARN_ON_ONCE(user_backed_iter(&rqst[i].rq_iter)))
2230 /* We also don't want to have any extra refs or pins to clean
2234 WARN_ON_ONCE(iov_iter_extract_will_pin(&rqst[i].rq_iter)))
2237 for (j = 0; j < rqst[i].rq_nvec; j++) {
2238 struct kvec *iov = &rqst[i].rq_iov[j];
2240 addr = (unsigned long)iov->iov_base + skip;
2241 if (unlikely(is_vmalloc_addr((void *)addr))) {
2242 len = iov->iov_len - skip;
2243 nents += DIV_ROUND_UP(offset_in_page(addr) + len,
2251 nents += iov_iter_npages(&rqst[i].rq_iter, INT_MAX);
2253 nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
2257 /* We can not use the normal sg_set_buf() as we will sometimes pass a
2258 * stack object as buf.
2260 static inline void cifs_sg_set_buf(struct sg_table *sgtable,
2262 unsigned int buflen)
2264 unsigned long addr = (unsigned long)buf;
2265 unsigned int off = offset_in_page(addr);
2268 if (unlikely(is_vmalloc_addr((void *)addr))) {
2270 unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
2272 sg_set_page(&sgtable->sgl[sgtable->nents++],
2273 vmalloc_to_page((void *)addr), len, off);
2280 sg_set_page(&sgtable->sgl[sgtable->nents++],
2281 virt_to_page((void *)addr), buflen, off);
2285 struct smb2_compound_vars {
2286 struct cifs_open_parms oparms;
2287 struct kvec rsp_iov[MAX_COMPOUND];
2288 struct smb_rqst rqst[MAX_COMPOUND];
2289 struct kvec open_iov[SMB2_CREATE_IOV_SIZE];
2291 struct kvec io_iov[SMB2_IOCTL_IOV_SIZE];
2292 struct kvec si_iov[SMB2_SET_INFO_IOV_SIZE];
2293 struct kvec close_iov;
2294 struct smb2_file_rename_info rename_info;
2295 struct smb2_file_link_info link_info;
2298 static inline bool cifs_ses_exiting(struct cifs_ses *ses)
2302 spin_lock(&ses->ses_lock);
2303 ret = ses->ses_status == SES_EXITING;
2304 spin_unlock(&ses->ses_lock);
2308 #endif /* _CIFS_GLOB_H */