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 attribute cache timeout (jiffies) - 2^30
55 #define CIFS_MAX_ACTIMEO (1 << 30)
58 * Max persistent and resilient handle timeout (milliseconds).
59 * Windows durable max was 960000 (16 minutes)
61 #define SMB3_MAX_HANDLE_TIMEOUT 960000
64 * MAX_REQ is the maximum number of requests that WE will send
65 * on one socket concurrently.
67 #define CIFS_MAX_REQ 32767
69 #define RFC1001_NAME_LEN 15
70 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
72 /* maximum length of ip addr as a string (including ipv6 and sctp) */
73 #define SERVER_NAME_LENGTH 80
74 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
76 /* echo interval in seconds */
77 #define SMB_ECHO_INTERVAL_MIN 1
78 #define SMB_ECHO_INTERVAL_MAX 600
79 #define SMB_ECHO_INTERVAL_DEFAULT 60
81 /* smb multichannel query server interfaces interval in seconds */
82 #define SMB_INTERFACE_POLL_INTERVAL 600
84 /* maximum number of PDUs in one compound */
85 #define MAX_COMPOUND 5
88 * Default number of credits to keep available for SMB3.
89 * This value is chosen somewhat arbitrarily. The Windows client
90 * defaults to 128 credits, the Windows server allows clients up to
91 * 512 credits (or 8K for later versions), and the NetApp server
92 * does not limit clients at all. Choose a high enough default value
93 * such that the client shouldn't limit performance, but allow mount
94 * to override (until you approach 64K, where we limit credits to 65000
95 * to reduce possibility of seeing more server credit overflow bugs.
97 #define SMB2_MAX_CREDITS_AVAILABLE 32000
101 #ifndef XATTR_DOS_ATTRIB
102 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
105 #define CIFS_MAX_WORKSTATION_LEN (__NEW_UTS_LEN + 1) /* reasonable max for client */
107 #define CIFS_DFS_ROOT_SES(ses) ((ses)->dfs_root_ses ?: (ses))
110 * CIFS vfs client Status information (based on what we know.)
113 /* associated with each connection */
123 /* associated with each smb session */
124 enum ses_status_enum {
132 /* associated with each tree connection to the server */
133 enum tid_status_enum {
140 TID_NEED_FILES_INVALIDATE, /* currently unused */
141 TID_IN_FILES_INVALIDATE
145 Unspecified = 0, /* not specified */
146 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
147 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
148 Kerberos, /* Kerberos via SPNEGO */
156 /* crypto hashing related structure/fields, not specific to a sec mech */
157 struct cifs_secmech {
158 struct shash_desc *hmacmd5; /* hmacmd5 hash function, for NTLMv2/CR1 hashes */
159 struct shash_desc *md5; /* md5 hash function, for CIFS/SMB1 signatures */
160 struct shash_desc *hmacsha256; /* hmac-sha256 hash function, for SMB2 signatures */
161 struct shash_desc *sha512; /* sha512 hash function, for SMB3.1.1 preauth hash */
162 struct shash_desc *aes_cmac; /* block-cipher based MAC function, for SMB3 signatures */
164 struct crypto_aead *enc; /* smb3 encryption AEAD TFM (AES-CCM and AES-GCM) */
165 struct crypto_aead *dec; /* smb3 decryption AEAD TFM (AES-CCM and AES-GCM) */
168 /* per smb session structure/fields */
169 struct ntlmssp_auth {
170 bool sesskey_per_smbsess; /* whether session key is per smb session */
171 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
172 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
173 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
174 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
182 struct cifs_sid osid;
183 struct cifs_sid gsid;
184 struct cifs_ntace *ntaces;
185 struct cifs_ace *aces;
188 struct cifs_open_info_data {
195 char *symlink_target;
197 struct smb2_file_all_info fi;
198 struct smb311_posix_qinfo posix_fi;
202 #define cifs_open_data_reparse(d) \
203 ((d)->reparse_point || \
204 (le32_to_cpu((d)->fi.Attributes) & ATTR_REPARSE))
206 static inline void cifs_free_open_info(struct cifs_open_info_data *data)
208 kfree(data->symlink_target);
212 *****************************************************************
213 * Except the CIFS PDUs themselves all the
214 * globally interesting structs should go here
215 *****************************************************************
219 * A smb_rqst represents a complete request to be issued to a server. It's
220 * formed by a kvec array, followed by an array of pages. Page data is assumed
221 * to start at the beginning of the first page.
224 struct kvec *rq_iov; /* array of kvecs */
225 unsigned int rq_nvec; /* number of kvecs in array */
226 size_t rq_iter_size; /* Amount of data in ->rq_iter */
227 struct iov_iter rq_iter; /* Data iterator */
228 struct xarray rq_buffer; /* Page buffer for encryption */
232 struct TCP_Server_Info;
236 struct dfs_info3_param;
238 struct smb3_fs_context;
240 struct cifs_readdata;
241 struct cifs_writedata;
242 struct cifs_io_parms;
243 struct cifs_search_info;
244 struct cifsInodeInfo;
245 struct cifs_open_parms;
248 struct smb_version_operations {
249 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
250 struct mid_q_entry *);
251 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
252 /* setup request: allocate mid, sign message */
253 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
254 struct TCP_Server_Info *,
256 /* setup async request: allocate mid, sign message */
257 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
259 /* check response: verify signature, map error */
260 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
262 void (*add_credits)(struct TCP_Server_Info *server,
263 const struct cifs_credits *credits,
265 void (*set_credits)(struct TCP_Server_Info *, const int);
266 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
267 unsigned int (*get_credits)(struct mid_q_entry *);
268 __u64 (*get_next_mid)(struct TCP_Server_Info *);
269 void (*revert_current_mid)(struct TCP_Server_Info *server,
270 const unsigned int val);
271 /* data offset from read response message */
272 unsigned int (*read_data_offset)(char *);
274 * Data length from read response message
275 * When in_remaining is true, the returned data length is in
276 * message field DataRemaining for out-of-band data read (e.g through
277 * Memory Registration RDMA write in SMBD).
278 * Otherwise, the returned data length is in message field DataLength.
280 unsigned int (*read_data_length)(char *, bool in_remaining);
281 /* map smb to linux error */
282 int (*map_error)(char *, bool);
283 /* find mid corresponding to the response message */
284 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
285 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
286 void (*clear_stats)(struct cifs_tcon *);
287 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
288 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
289 /* verify the message */
290 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
291 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
292 int (*handle_cancelled_mid)(struct mid_q_entry *, struct TCP_Server_Info *);
293 void (*downgrade_oplock)(struct TCP_Server_Info *server,
294 struct cifsInodeInfo *cinode, __u32 oplock,
295 unsigned int epoch, bool *purge_cache);
296 /* process transaction2 response */
297 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
299 /* check if we need to negotiate */
300 bool (*need_neg)(struct TCP_Server_Info *);
301 /* negotiate to the server */
302 int (*negotiate)(const unsigned int xid,
303 struct cifs_ses *ses,
304 struct TCP_Server_Info *server);
305 /* set negotiated write size */
306 unsigned int (*negotiate_wsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
307 /* set negotiated read size */
308 unsigned int (*negotiate_rsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
309 /* setup smb sessionn */
310 int (*sess_setup)(const unsigned int, struct cifs_ses *,
311 struct TCP_Server_Info *server,
312 const struct nls_table *);
313 /* close smb session */
314 int (*logoff)(const unsigned int, struct cifs_ses *);
315 /* connect to a server share */
316 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
317 struct cifs_tcon *, const struct nls_table *);
318 /* close tree connecion */
319 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
320 /* get DFS referrals */
321 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
322 const char *, struct dfs_info3_param **,
323 unsigned int *, const struct nls_table *, int);
324 /* informational QFS call */
325 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *,
326 struct cifs_sb_info *);
327 /* check if a path is accessible or not */
328 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
329 struct cifs_sb_info *, const char *);
330 /* query path data from the server */
331 int (*query_path_info)(const unsigned int xid,
332 struct cifs_tcon *tcon,
333 struct cifs_sb_info *cifs_sb,
334 const char *full_path,
335 struct cifs_open_info_data *data);
336 /* query file data from the server */
337 int (*query_file_info)(const unsigned int xid, struct cifs_tcon *tcon,
338 struct cifsFileInfo *cfile, struct cifs_open_info_data *data);
339 /* query reparse point to determine which type of special file */
340 int (*query_reparse_point)(const unsigned int xid,
341 struct cifs_tcon *tcon,
342 struct cifs_sb_info *cifs_sb,
343 const char *full_path,
344 u32 *tag, struct kvec *rsp,
346 /* get server index number */
347 int (*get_srv_inum)(const unsigned int xid, struct cifs_tcon *tcon,
348 struct cifs_sb_info *cifs_sb, const char *full_path, u64 *uniqueid,
349 struct cifs_open_info_data *data);
350 /* set size by path */
351 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
352 const char *, __u64, struct cifs_sb_info *, bool);
353 /* set size by file handle */
354 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
355 struct cifsFileInfo *, __u64, bool);
357 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
359 int (*set_compression)(const unsigned int, struct cifs_tcon *,
360 struct cifsFileInfo *);
361 /* check if we can send an echo or nor */
362 bool (*can_echo)(struct TCP_Server_Info *);
363 /* send echo request */
364 int (*echo)(struct TCP_Server_Info *);
365 /* create directory */
366 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
367 umode_t mode, struct cifs_tcon *tcon,
368 const char *full_path,
369 struct cifs_sb_info *cifs_sb);
370 int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
371 struct cifs_tcon *tcon, const char *name,
372 struct cifs_sb_info *sb);
373 /* set info on created directory */
374 void (*mkdir_setinfo)(struct inode *, const char *,
375 struct cifs_sb_info *, struct cifs_tcon *,
377 /* remove directory */
378 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
379 struct cifs_sb_info *);
381 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
382 struct cifs_sb_info *);
383 /* open, rename and delete file */
384 int (*rename_pending_delete)(const char *, struct dentry *,
386 /* send rename request */
387 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
388 const char *, struct cifs_sb_info *);
389 /* send create hardlink request */
390 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
391 const char *, const char *,
392 struct cifs_sb_info *);
393 /* query symlink target */
394 int (*query_symlink)(const unsigned int xid,
395 struct cifs_tcon *tcon,
396 struct cifs_sb_info *cifs_sb,
397 const char *full_path,
399 struct kvec *rsp_iov);
400 /* open a file for non-posix mounts */
401 int (*open)(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,
403 /* set fid protocol-specific info */
404 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
406 void (*close)(const unsigned int, struct cifs_tcon *,
408 /* close a file, returning file attributes and timestamps */
409 void (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon,
410 struct cifsFileInfo *pfile_info);
411 /* send a flush request to the server */
412 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
413 /* async read from the server */
414 int (*async_readv)(struct cifs_readdata *);
415 /* async write to the server */
416 int (*async_writev)(struct cifs_writedata *,
417 void (*release)(struct kref *));
418 /* sync read from the server */
419 int (*sync_read)(const unsigned int, struct cifs_fid *,
420 struct cifs_io_parms *, unsigned int *, char **,
422 /* sync write to the server */
423 int (*sync_write)(const unsigned int, struct cifs_fid *,
424 struct cifs_io_parms *, unsigned int *, struct kvec *,
426 /* open dir, start readdir */
427 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
428 const char *, struct cifs_sb_info *,
429 struct cifs_fid *, __u16,
430 struct cifs_search_info *);
431 /* continue readdir */
432 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
434 __u16, struct cifs_search_info *srch_inf);
436 int (*close_dir)(const unsigned int, struct cifs_tcon *,
438 /* calculate a size of SMB message */
439 unsigned int (*calc_smb_size)(void *buf);
440 /* check for STATUS_PENDING and process the response if yes */
441 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
442 /* check for STATUS_NETWORK_SESSION_EXPIRED */
443 bool (*is_session_expired)(char *);
444 /* send oplock break response */
445 int (*oplock_response)(struct cifs_tcon *tcon, __u64 persistent_fid, __u64 volatile_fid,
446 __u16 net_fid, struct cifsInodeInfo *cifs_inode);
447 /* query remote filesystem */
448 int (*queryfs)(const unsigned int, struct cifs_tcon *,
449 struct cifs_sb_info *, struct kstatfs *);
450 /* send mandatory brlock to the server */
451 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
452 __u64, __u32, int, int, bool);
453 /* unlock range of mandatory locks */
454 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
456 /* push brlocks from the cache to the server */
457 int (*push_mand_locks)(struct cifsFileInfo *);
458 /* get lease key of the inode */
459 void (*get_lease_key)(struct inode *, struct cifs_fid *);
460 /* set lease key of the inode */
461 void (*set_lease_key)(struct inode *, struct cifs_fid *);
462 /* generate new lease key */
463 void (*new_lease_key)(struct cifs_fid *);
464 int (*generate_signingkey)(struct cifs_ses *ses,
465 struct TCP_Server_Info *server);
466 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *,
467 bool allocate_crypto);
468 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
469 struct cifsFileInfo *src_file);
470 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
471 struct cifsFileInfo *src_file, void __user *);
472 int (*notify)(const unsigned int xid, struct file *pfile,
473 void __user *pbuf, bool return_changes);
474 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
475 struct cifs_sb_info *, const unsigned char *,
476 char *, unsigned int *);
477 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
478 struct cifs_sb_info *, const unsigned char *,
479 char *, unsigned int *);
480 /* if we can do cache read operations */
481 bool (*is_read_op)(__u32);
482 /* set oplock level for the inode */
483 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
485 /* create lease context buffer for CREATE request */
486 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
487 /* parse lease context buffer and return oplock/epoch info */
488 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
489 ssize_t (*copychunk_range)(const unsigned int,
490 struct cifsFileInfo *src_file,
491 struct cifsFileInfo *target_file,
492 u64 src_off, u64 len, u64 dest_off);
493 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
494 struct cifsFileInfo *target_file, u64 src_off, u64 len,
496 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
497 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
498 const unsigned char *, const unsigned char *, char *,
499 size_t, struct cifs_sb_info *);
500 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
501 const char *, const void *, const __u16,
502 const struct nls_table *, struct cifs_sb_info *);
503 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
504 const char *, u32 *, u32);
505 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
506 const struct cifs_fid *, u32 *, u32);
507 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
509 /* writepages retry size */
510 unsigned int (*wp_retry_size)(struct inode *);
511 /* get mtu credits */
512 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
513 unsigned int *, struct cifs_credits *);
514 /* adjust previously taken mtu credits to request size */
515 int (*adjust_credits)(struct TCP_Server_Info *server,
516 struct cifs_credits *credits,
517 const unsigned int payload_size);
518 /* check if we need to issue closedir */
519 bool (*dir_needs_close)(struct cifsFileInfo *);
520 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
522 /* init transform request - used for encryption for now */
523 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
524 struct smb_rqst *, struct smb_rqst *);
525 int (*is_transform_hdr)(void *buf);
526 int (*receive_transform)(struct TCP_Server_Info *,
527 struct mid_q_entry **, char **, int *);
528 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
530 int (*next_header)(char *);
531 /* ioctl passthrough for query_info */
532 int (*ioctl_query_info)(const unsigned int xid,
533 struct cifs_tcon *tcon,
534 struct cifs_sb_info *cifs_sb,
535 __le16 *path, int is_dir,
537 /* make unix special files (block, char, fifo, socket) */
538 int (*make_node)(unsigned int xid,
540 struct dentry *dentry,
541 struct cifs_tcon *tcon,
542 const char *full_path,
544 dev_t device_number);
545 /* version specific fiemap implementation */
546 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
547 struct fiemap_extent_info *, u64, u64);
548 /* version specific llseek implementation */
549 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
550 /* Check for STATUS_IO_TIMEOUT */
551 bool (*is_status_io_timeout)(char *buf);
552 /* Check for STATUS_NETWORK_NAME_DELETED */
553 bool (*is_network_name_deleted)(char *buf, struct TCP_Server_Info *srv);
556 struct smb_version_values {
557 char *version_string;
559 __u32 req_capabilities;
560 __u32 large_lock_type;
561 __u32 exclusive_lock_type;
562 __u32 shared_lock_type;
563 __u32 unlock_lock_type;
564 size_t header_preamble_size;
566 size_t max_header_size;
567 size_t read_rsp_size;
569 unsigned int cap_unix;
570 unsigned int cap_nt_find;
571 unsigned int cap_large_files;
572 __u16 signing_enabled;
573 __u16 signing_required;
574 size_t create_lease_size;
577 #define HEADER_SIZE(server) (server->vals->header_size)
578 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
579 #define HEADER_PREAMBLE_SIZE(server) (server->vals->header_preamble_size)
580 #define MID_HEADER_SIZE(server) (HEADER_SIZE(server) - 1 - HEADER_PREAMBLE_SIZE(server))
583 * CIFS superblock mount flags (mnt_cifs_flags) to consider when
584 * trying to reuse existing superblock for a new mount
586 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
587 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
588 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
589 CIFS_MOUNT_MAP_SFM_CHR | \
590 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
591 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
592 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
593 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
594 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
595 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
596 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
597 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
598 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
599 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
602 * Generic VFS superblock mount flags (s_flags) to consider when
603 * trying to reuse existing superblock for a new mount
605 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
606 SB_NODEV | SB_SYNCHRONOUS)
608 struct cifs_mnt_data {
609 struct cifs_sb_info *cifs_sb;
610 struct smb3_fs_context *ctx;
614 static inline unsigned int
615 get_rfc1002_length(void *buf)
617 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
621 inc_rfc1001_len(void *buf, int count)
623 be32_add_cpu((__be32 *)buf, count);
626 struct TCP_Server_Info {
627 struct list_head tcp_ses_list;
628 struct list_head smb_ses_list;
629 spinlock_t srv_lock; /* protect anything here that is not protected */
630 __u64 conn_id; /* connection identifier (useful for debugging) */
631 int srv_count; /* reference counter */
632 /* 15 character server name + 0x20 16th byte indicating type = srv */
633 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
634 struct smb_version_operations *ops;
635 struct smb_version_values *vals;
636 /* updates to tcpStatus protected by cifs_tcp_ses_lock */
637 enum statusEnum tcpStatus; /* what we think the status is */
638 char *hostname; /* hostname portion of UNC string */
639 struct socket *ssocket;
640 struct sockaddr_storage dstaddr;
641 struct sockaddr_storage srcaddr; /* locally bind to this IP */
645 wait_queue_head_t response_q;
646 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
647 spinlock_t mid_lock; /* protect mid queue and it's entries */
648 struct list_head pending_mid_q;
649 bool noblocksnd; /* use blocking sendmsg */
650 bool noautotune; /* do not autotune send buf sizes */
653 unsigned int credits; /* send no more requests at once */
654 unsigned int max_credits; /* can override large 32000 default at mnt */
655 unsigned int in_flight; /* number of requests on the wire to server */
656 unsigned int max_in_flight; /* max number of requests that were on wire */
657 spinlock_t req_lock; /* protect the two values above */
658 struct mutex _srv_mutex;
659 unsigned int nofs_flag;
660 struct task_struct *tsk;
661 char server_GUID[16];
663 bool sign; /* is signing enabled on this connection? */
664 bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
665 bool session_estab; /* mark when very first sess is established */
666 int echo_credits; /* echo reserved slots */
667 int oplock_credits; /* oplock break reserved slots */
668 bool echoes:1; /* enable echoes */
669 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
670 u16 dialect; /* dialect index that server chose */
671 bool oplocks:1; /* enable oplocks */
672 unsigned int maxReq; /* Clients should submit no more */
673 /* than maxReq distinct unanswered SMBs to the server when using */
674 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
675 unsigned int maxBuf; /* maxBuf specifies the maximum */
676 /* message size the server can send or receive for non-raw SMBs */
677 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
678 /* when socket is setup (and during reconnect) before NegProt sent */
679 unsigned int max_rw; /* maxRw specifies the maximum */
680 /* message size the server can send or receive for */
681 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
682 unsigned int capabilities; /* selective disabling of caps by smb sess */
683 int timeAdj; /* Adjust for difference in server time zone in sec */
684 __u64 CurrentMid; /* multiplex id - rotating counter, protected by GlobalMid_Lock */
685 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
686 /* 16th byte of RFC1001 workstation name is always null */
687 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
688 __u32 sequence_number; /* for signing, protected by srv_mutex */
689 __u32 reconnect_instance; /* incremented on each reconnect */
690 struct session_key session_key;
691 unsigned long lstrp; /* when we got last response from this server */
692 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
693 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
694 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
695 char negflavor; /* NEGOTIATE response flavor */
696 /* extended security flavors that server supports */
697 bool sec_ntlmssp; /* supports NTLMSSP */
698 bool sec_kerberosu2u; /* supports U2U Kerberos */
699 bool sec_kerberos; /* supports plain Kerberos */
700 bool sec_mskerberos; /* supports legacy MS Kerberos */
701 bool large_buf; /* is current buffer large? */
702 /* use SMBD connection instead of socket */
704 /* point to the SMBD connection if RDMA is used instead of socket */
705 struct smbd_connection *smbd_conn;
706 struct delayed_work echo; /* echo ping workqueue job */
707 char *smallbuf; /* pointer to current "small" buffer */
708 char *bigbuf; /* pointer to current "big" buffer */
709 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
710 unsigned int pdu_size;
711 unsigned int total_read; /* total amount of data read in this pass */
712 atomic_t in_send; /* requests trying to send */
713 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
714 #ifdef CONFIG_CIFS_STATS2
715 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
716 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
717 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
718 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
719 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
721 unsigned int max_read;
722 unsigned int max_write;
723 unsigned int min_offload;
724 __le16 compress_algorithm;
725 __u16 signing_algorithm;
727 /* save initital negprot hash */
728 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
729 bool signing_negotiated; /* true if valid signing context rcvd from server */
730 bool posix_ext_supported;
731 struct delayed_work reconnect; /* reconnect workqueue job */
732 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
733 unsigned long echo_interval;
736 * Number of targets available for reconnect. The more targets
737 * the more tasks have to wait to let the demultiplex thread
741 bool noblockcnt; /* use non-blocking connect() */
744 * If this is a session channel,
745 * primary_server holds the ref-counted
746 * pointer to primary channel connection for the session.
748 #define SERVER_IS_CHAN(server) (!!(server)->primary_server)
749 struct TCP_Server_Info *primary_server;
750 __u16 channel_sequence_num; /* incremented on primary channel on each chan reconnect */
752 #ifdef CONFIG_CIFS_SWN_UPCALL
753 bool use_swn_dstaddr;
754 struct sockaddr_storage swn_dstaddr;
756 struct mutex refpath_lock; /* protects leaf_fullpath */
758 * leaf_fullpath: Canonical DFS referral path related to this
760 * It is used in DFS cache refresher, reconnect and may
761 * change due to nested DFS links.
763 * Protected by @refpath_lock and @srv_lock. The @refpath_lock is
764 * mostly used for not requiring a copy of @leaf_fullpath when getting
765 * cached or new DFS referrals (which might also sleep during I/O).
766 * While @srv_lock is held for making string and NULL comparions against
767 * both fields as in mount(2) and cache refresh.
769 * format: \\HOST\SHARE[\OPTIONAL PATH]
774 static inline bool is_smb1(struct TCP_Server_Info *server)
776 return HEADER_PREAMBLE_SIZE(server) != 0;
779 static inline void cifs_server_lock(struct TCP_Server_Info *server)
781 unsigned int nofs_flag = memalloc_nofs_save();
783 mutex_lock(&server->_srv_mutex);
784 server->nofs_flag = nofs_flag;
787 static inline void cifs_server_unlock(struct TCP_Server_Info *server)
789 unsigned int nofs_flag = server->nofs_flag;
791 mutex_unlock(&server->_srv_mutex);
792 memalloc_nofs_restore(nofs_flag);
795 struct cifs_credits {
797 unsigned int instance;
800 static inline unsigned int
801 in_flight(struct TCP_Server_Info *server)
805 spin_lock(&server->req_lock);
806 num = server->in_flight;
807 spin_unlock(&server->req_lock);
812 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
816 spin_lock(&server->req_lock);
818 spin_unlock(&server->req_lock);
819 return num >= num_credits;
823 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
826 server->ops->add_credits(server, credits, optype);
830 add_credits_and_wake_if(struct TCP_Server_Info *server,
831 const struct cifs_credits *credits, const int optype)
833 if (credits->value) {
834 server->ops->add_credits(server, credits, optype);
835 wake_up(&server->request_q);
840 set_credits(struct TCP_Server_Info *server, const int val)
842 server->ops->set_credits(server, val);
846 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
847 const unsigned int payload_size)
849 return server->ops->adjust_credits ?
850 server->ops->adjust_credits(server, credits, payload_size) : 0;
854 get_next_mid64(struct TCP_Server_Info *server)
856 return cpu_to_le64(server->ops->get_next_mid(server));
860 get_next_mid(struct TCP_Server_Info *server)
862 __u16 mid = server->ops->get_next_mid(server);
864 * The value in the SMB header should be little endian for easy
865 * on-the-wire decoding.
867 return cpu_to_le16(mid);
871 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
873 if (server->ops->revert_current_mid)
874 server->ops->revert_current_mid(server, val);
878 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
879 const struct smb2_hdr *shdr)
881 unsigned int num = le16_to_cpu(shdr->CreditCharge);
883 return revert_current_mid(server, num > 0 ? num : 1);
887 get_mid(const struct smb_hdr *smb)
889 return le16_to_cpu(smb->Mid);
893 compare_mid(__u16 mid, const struct smb_hdr *smb)
895 return mid == le16_to_cpu(smb->Mid);
899 * When the server supports very large reads and writes via POSIX extensions,
900 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
901 * including the RFC1001 length.
903 * Note that this might make for "interesting" allocation problems during
904 * writeback however as we have to allocate an array of pointers for the
905 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
907 * For reads, there is a similar problem as we need to allocate an array
908 * of kvecs to handle the receive, though that should only need to be done
911 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
912 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
915 * When the server doesn't allow large posix writes, only allow a rsize/wsize
916 * of 2^17-1 minus the size of the call header. That allows for a read or
917 * write up to the maximum size described by RFC1002.
919 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
920 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
922 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
925 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
926 * those values when posix extensions aren't in force. In actuality here, we
927 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
928 * to be ok with the extra byte even though Windows doesn't send writes that
933 * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
935 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
936 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
939 * Macros to allow the TCP_Server_Info->net field and related code to drop out
940 * when CONFIG_NET_NS isn't set.
945 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
950 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
957 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
962 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
968 struct cifs_server_iface {
969 struct list_head iface_head;
970 struct kref refcount;
972 size_t weight_fulfilled;
973 unsigned int num_channels;
974 unsigned int rdma_capable : 1;
975 unsigned int rss_capable : 1;
976 unsigned int is_active : 1; /* unset if non existent */
977 struct sockaddr_storage sockaddr;
980 /* release iface when last ref is dropped */
982 release_iface(struct kref *ref)
984 struct cifs_server_iface *iface = container_of(ref,
985 struct cifs_server_iface,
987 list_del_init(&iface->iface_head);
992 unsigned int in_reconnect : 1; /* if session setup in progress for this channel */
993 struct TCP_Server_Info *server;
994 struct cifs_server_iface *iface; /* interface in use */
995 __u8 signkey[SMB3_SIGN_KEY_SIZE];
999 * Session structure. One of these for each uid session with a particular host
1002 struct list_head smb_ses_list;
1003 struct list_head rlist; /* reconnect list */
1004 struct list_head tcon_list;
1005 struct cifs_tcon *tcon_ipc;
1006 spinlock_t ses_lock; /* protect anything here that is not protected */
1007 struct mutex session_mutex;
1008 struct TCP_Server_Info *server; /* pointer to server info */
1009 int ses_count; /* reference counter */
1010 enum ses_status_enum ses_status; /* updates protected by cifs_tcp_ses_lock */
1011 unsigned int overrideSecFlg; /* if non-zero override global sec flags */
1012 char *serverOS; /* name of operating system underlying server */
1013 char *serverNOS; /* name of network operating system of server */
1014 char *serverDomain; /* security realm of server */
1015 __u64 Suid; /* remote smb uid */
1016 kuid_t linux_uid; /* overriding owner of files on the mount */
1017 kuid_t cred_uid; /* owner of credentials */
1018 unsigned int capabilities;
1019 char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */
1020 char *user_name; /* must not be null except during init of sess
1021 and after mount option parsing we fill it */
1024 char workstation_name[CIFS_MAX_WORKSTATION_LEN];
1025 struct session_key auth_key;
1026 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
1027 enum securityEnum sectype; /* what security flavor was specified? */
1028 bool sign; /* is signing required? */
1030 __u16 session_flags;
1031 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
1032 __u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1033 __u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1034 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1037 * Network interfaces available on the server this session is
1040 * Other channels can be opened by connecting and binding this
1041 * session to interfaces from this list.
1043 * iface_lock should be taken when accessing any of these fields
1045 spinlock_t iface_lock;
1046 /* ========= begin: protected by iface_lock ======== */
1047 struct list_head iface_list;
1049 unsigned long iface_last_update; /* jiffies */
1050 /* ========= end: protected by iface_lock ======== */
1052 spinlock_t chan_lock;
1053 /* ========= begin: protected by chan_lock ======== */
1054 #define CIFS_MAX_CHANNELS 16
1055 #define CIFS_ALL_CHANNELS_SET(ses) \
1056 ((1UL << (ses)->chan_count) - 1)
1057 #define CIFS_ALL_CHANS_GOOD(ses) \
1058 (!(ses)->chans_need_reconnect)
1059 #define CIFS_ALL_CHANS_NEED_RECONNECT(ses) \
1060 ((ses)->chans_need_reconnect == CIFS_ALL_CHANNELS_SET(ses))
1061 #define CIFS_SET_ALL_CHANS_NEED_RECONNECT(ses) \
1062 ((ses)->chans_need_reconnect = CIFS_ALL_CHANNELS_SET(ses))
1063 #define CIFS_CHAN_NEEDS_RECONNECT(ses, index) \
1064 test_bit((index), &(ses)->chans_need_reconnect)
1065 #define CIFS_CHAN_IN_RECONNECT(ses, index) \
1066 ((ses)->chans[(index)].in_reconnect)
1068 struct cifs_chan chans[CIFS_MAX_CHANNELS];
1071 atomic_t chan_seq; /* round robin state */
1074 * chans_need_reconnect is a bitmap indicating which of the channels
1075 * under this smb session needs to be reconnected.
1076 * If not multichannel session, only one bit will be used.
1078 * We will ask for sess and tcon reconnection only if all the
1079 * channels are marked for needing reconnection. This will
1080 * enable the sessions on top to continue to live till any
1081 * of the channels below are active.
1083 unsigned long chans_need_reconnect;
1084 /* ========= end: protected by chan_lock ======== */
1085 struct cifs_ses *dfs_root_ses;
1086 struct nls_table *local_nls;
1090 cap_unix(struct cifs_ses *ses)
1092 return ses->server->vals->cap_unix & ses->capabilities;
1096 * common struct for holding inode info when searching for or updating an
1097 * inode with new info
1100 #define CIFS_FATTR_JUNCTION 0x1
1101 #define CIFS_FATTR_DELETE_PENDING 0x2
1102 #define CIFS_FATTR_NEED_REVAL 0x4
1103 #define CIFS_FATTR_INO_COLLISION 0x8
1104 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1105 #define CIFS_FATTR_FAKE_ROOT_INO 0x20
1118 unsigned int cf_nlink;
1119 unsigned int cf_dtype;
1120 struct timespec64 cf_atime;
1121 struct timespec64 cf_mtime;
1122 struct timespec64 cf_ctime;
1124 char *cf_symlink_target;
1128 * there is one of these for each connection to a resource on a particular
1132 struct list_head tcon_list;
1134 struct list_head rlist; /* reconnect list */
1135 spinlock_t tc_lock; /* protect anything here that is not protected */
1136 atomic_t num_local_opens; /* num of all opens including disconnected */
1137 atomic_t num_remote_opens; /* num of all network opens on server */
1138 struct list_head openFileList;
1139 spinlock_t open_file_lock; /* protects list above */
1140 struct cifs_ses *ses; /* pointer to session associated with */
1141 char tree_name[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1142 char *nativeFileSystem;
1143 char *password; /* for share-level security */
1144 __u32 tid; /* The 4 byte tree id */
1145 __u16 Flags; /* optional support bits */
1146 enum tid_status_enum status;
1147 atomic_t num_smbs_sent;
1150 atomic_t num_writes;
1152 atomic_t num_flushes;
1153 atomic_t num_oplock_brks;
1155 atomic_t num_closes;
1156 atomic_t num_deletes;
1157 atomic_t num_mkdirs;
1158 atomic_t num_posixopens;
1159 atomic_t num_posixmkdirs;
1160 atomic_t num_rmdirs;
1161 atomic_t num_renames;
1162 atomic_t num_t2renames;
1163 atomic_t num_ffirst;
1165 atomic_t num_fclose;
1166 atomic_t num_hardlinks;
1167 atomic_t num_symlinks;
1169 atomic_t num_acl_get;
1170 atomic_t num_acl_set;
1173 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1174 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1178 __u64 bytes_written;
1179 spinlock_t stat_lock; /* protects the two fields above */
1180 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1181 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1182 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1183 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
1184 bool pipe:1; /* set if connection to pipe share */
1185 bool print:1; /* set if connection to printer share */
1188 bool nohandlecache:1; /* if strange server resource prob can turn off */
1190 bool seal:1; /* transport encryption for this mounted share */
1191 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
1192 for this mount even if server would support */
1193 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1194 bool local_lease:1; /* check leases (only) on local system not remote */
1195 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1196 bool broken_sparse_sup; /* if server or share does not support sparse */
1197 bool need_reconnect:1; /* connection reset, tid now invalid */
1198 bool need_reopen_files:1; /* need to reopen tcon file handles */
1199 bool use_resilient:1; /* use resilient instead of durable handles */
1200 bool use_persistent:1; /* use persistent instead of durable handles */
1201 bool no_lease:1; /* Do not request leases on files or directories */
1202 bool use_witness:1; /* use witness protocol */
1203 __le32 capabilities;
1205 __u32 maximal_access;
1206 __u32 vol_serial_number;
1207 __le64 vol_create_time;
1208 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1209 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
1210 __u32 ss_flags; /* sector size flags */
1211 __u32 perf_sector_size; /* best sector size for perf */
1213 __u32 max_bytes_chunk;
1214 __u32 max_bytes_copy;
1215 __u32 max_cached_dirs;
1216 #ifdef CONFIG_CIFS_FSCACHE
1217 u64 resource_id; /* server resource id */
1218 struct fscache_volume *fscache; /* cookie for share */
1220 struct list_head pending_opens; /* list of incomplete opens */
1221 struct cached_fids *cfids;
1222 /* BB add field for back pointer to sb struct(s)? */
1223 #ifdef CONFIG_CIFS_DFS_UPCALL
1224 struct list_head dfs_ses_list;
1225 struct delayed_work dfs_cache_work;
1227 struct delayed_work query_interfaces; /* query interfaces workqueue job */
1228 char *origin_fullpath; /* canonical copy of smb3_fs_context::source */
1232 * This is a refcounted and timestamped container for a tcon pointer. The
1233 * container holds a tcon reference. It is considered safe to free one of
1234 * these when the tl_count goes to 0. The tl_time is the time of the last
1235 * "get" on the container.
1238 struct rb_node tl_rbnode;
1240 unsigned long tl_flags;
1241 #define TCON_LINK_MASTER 0
1242 #define TCON_LINK_PENDING 1
1243 #define TCON_LINK_IN_TREE 2
1244 unsigned long tl_time;
1246 struct cifs_tcon *tl_tcon;
1249 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1250 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1252 static inline struct cifs_tcon *
1253 tlink_tcon(struct tcon_link *tlink)
1255 return tlink->tl_tcon;
1258 static inline struct tcon_link *
1259 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1261 return cifs_sb->master_tlink;
1264 extern void cifs_put_tlink(struct tcon_link *tlink);
1266 static inline struct tcon_link *
1267 cifs_get_tlink(struct tcon_link *tlink)
1269 if (tlink && !IS_ERR(tlink))
1270 atomic_inc(&tlink->tl_count);
1274 /* This function is always expected to succeed */
1275 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1277 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1279 struct cifs_pending_open {
1280 struct list_head olist;
1281 struct tcon_link *tlink;
1286 struct cifs_deferred_close {
1287 struct list_head dlist;
1288 struct tcon_link *tlink;
1290 __u64 persistent_fid;
1295 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1296 * This is used to track byte stream locks on the file
1298 struct cifsLockInfo {
1299 struct list_head llist; /* pointer to next cifsLockInfo */
1300 struct list_head blist; /* pointer to locks blocked on this */
1301 wait_queue_head_t block_q;
1310 * One of these for each open instance of a file
1312 struct cifs_search_info {
1313 loff_t index_of_last_entry;
1314 __u16 entries_in_buffer;
1317 char *ntwrk_buf_start;
1318 char *srch_entries_start;
1320 const char *presume_name;
1321 unsigned int resume_name_len;
1325 bool smallBuf:1; /* so we know which buf_release function to call */
1328 #define ACL_NO_MODE ((umode_t)(-1))
1329 struct cifs_open_parms {
1330 struct cifs_tcon *tcon;
1331 struct cifs_sb_info *cifs_sb;
1336 struct cifs_fid *fid;
1343 __u64 persistent_fid; /* persist file id for smb2 */
1344 __u64 volatile_fid; /* volatile file id for smb2 */
1345 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1346 __u8 create_guid[16];
1348 struct cifs_pending_open *pending_open;
1350 #ifdef CONFIG_CIFS_DEBUG2
1352 #endif /* CIFS_DEBUG2 */
1356 struct cifs_fid_locks {
1357 struct list_head llist;
1358 struct cifsFileInfo *cfile; /* fid that owns locks */
1359 struct list_head locks; /* locks held by fid above */
1362 struct cifsFileInfo {
1363 /* following two lists are protected by tcon->open_file_lock */
1364 struct list_head tlist; /* pointer to next fid owned by tcon */
1365 struct list_head flist; /* next fid (file instance) for this inode */
1366 /* lock list below protected by cifsi->lock_sem */
1367 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1368 kuid_t uid; /* allows finding which FileInfo structure */
1369 __u32 pid; /* process id who opened file */
1370 struct cifs_fid fid; /* file id from remote */
1371 struct list_head rlist; /* reconnect list */
1372 /* BB add lock scope info here if needed */
1373 /* lock scope id (0 if none) */
1374 struct dentry *dentry;
1375 struct tcon_link *tlink;
1376 unsigned int f_flags;
1377 bool invalidHandle:1; /* file closed via session abend */
1379 bool oplock_break_cancelled:1;
1380 unsigned int oplock_epoch; /* epoch from the lease break */
1381 __u32 oplock_level; /* oplock/lease level from the lease break */
1383 spinlock_t file_info_lock; /* protects four flag/count fields above */
1384 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1385 struct cifs_search_info srch_inf;
1386 struct work_struct oplock_break; /* work for oplock breaks */
1387 struct work_struct put; /* work for the final part of _put */
1388 struct delayed_work deferred;
1389 bool deferred_close_scheduled; /* Flag to indicate close is scheduled */
1390 char *symlink_target;
1393 struct cifs_io_parms {
1395 __u64 persistent_fid; /* persist file id for smb2 */
1396 __u64 volatile_fid; /* volatile file id for smb2 */
1399 unsigned int length;
1400 struct cifs_tcon *tcon;
1401 struct TCP_Server_Info *server;
1404 struct cifs_aio_ctx {
1405 struct kref refcount;
1406 struct list_head list;
1407 struct mutex aio_mutex;
1408 struct completion done;
1409 struct iov_iter iter;
1411 struct cifsFileInfo *cfile;
1414 unsigned int nr_pinned_pages;
1417 unsigned int total_len;
1418 unsigned int bv_need_unpin; /* If ->bv[] needs unpinning */
1421 * Indicates if this aio_ctx is for direct_io,
1422 * If yes, iter is a copy of the user passed iov_iter
1427 /* asynchronous read support */
1428 struct cifs_readdata {
1429 struct kref refcount;
1430 struct list_head list;
1431 struct completion done;
1432 struct cifsFileInfo *cfile;
1433 struct address_space *mapping;
1434 struct cifs_aio_ctx *ctx;
1440 struct work_struct work;
1441 struct iov_iter iter;
1443 struct TCP_Server_Info *server;
1444 #ifdef CONFIG_CIFS_SMB_DIRECT
1447 struct cifs_credits credits;
1450 /* asynchronous write support */
1451 struct cifs_writedata {
1452 struct kref refcount;
1453 struct list_head list;
1454 struct completion done;
1455 enum writeback_sync_modes sync_mode;
1456 struct work_struct work;
1457 struct cifsFileInfo *cfile;
1458 struct cifs_aio_ctx *ctx;
1459 struct iov_iter iter;
1465 struct TCP_Server_Info *server;
1466 #ifdef CONFIG_CIFS_SMB_DIRECT
1469 struct cifs_credits credits;
1473 * Take a reference on the file private data. Must be called with
1474 * cfile->file_info_lock held.
1477 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1482 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1483 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1485 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1487 #define CIFS_CACHE_READ_FLG 1
1488 #define CIFS_CACHE_HANDLE_FLG 2
1489 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1490 #define CIFS_CACHE_WRITE_FLG 4
1491 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1492 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1494 #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))
1495 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1496 #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))
1499 * One of these for each file inode
1502 struct cifsInodeInfo {
1503 struct netfs_inode netfs; /* Netfslib context and vfs inode */
1504 bool can_cache_brlcks;
1505 struct list_head llist; /* locks helb by this inode */
1507 * NOTE: Some code paths call down_read(lock_sem) twice, so
1508 * we must always use cifs_down_write() instead of down_write()
1509 * for this semaphore to avoid deadlocks.
1511 struct rw_semaphore lock_sem; /* protect the fields above */
1512 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1513 struct list_head openFileList;
1514 spinlock_t open_file_lock; /* protects openFileList */
1515 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1516 unsigned int oplock; /* oplock/lease level we have */
1517 unsigned int epoch; /* used to track lease state changes */
1518 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1519 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1520 #define CIFS_INODE_FLAG_UNUSED (2) /* Unused flag */
1521 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1522 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1523 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1524 #define CIFS_INO_MODIFIED_ATTR (6) /* Indicate change in mtime/ctime */
1525 #define CIFS_INO_CLOSE_ON_LOCK (7) /* Not to defer the close when lock is set */
1526 unsigned long flags;
1527 spinlock_t writers_lock;
1528 unsigned int writers; /* Number of writers on this inode */
1529 unsigned long time; /* jiffies of last update of inode */
1530 u64 server_eof; /* current file size on server -- protected by i_lock */
1531 u64 uniqueid; /* server inode number */
1532 u64 createtime; /* creation time on server */
1533 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1534 struct list_head deferred_closes; /* list of deferred closes */
1535 spinlock_t deferred_lock; /* protection on deferred list */
1536 bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */
1537 char *symlink_target;
1540 static inline struct cifsInodeInfo *
1541 CIFS_I(struct inode *inode)
1543 return container_of(inode, struct cifsInodeInfo, netfs.inode);
1546 static inline struct cifs_sb_info *
1547 CIFS_SB(struct super_block *sb)
1549 return sb->s_fs_info;
1552 static inline struct cifs_sb_info *
1553 CIFS_FILE_SB(struct file *file)
1555 return CIFS_SB(file_inode(file)->i_sb);
1558 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1560 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1567 convert_delimiter(char *path, char delim)
1569 char old_delim, *pos;
1577 while ((pos = strchr(pos, old_delim)))
1581 #define cifs_stats_inc atomic_inc
1583 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1587 spin_lock(&tcon->stat_lock);
1588 tcon->bytes_written += bytes;
1589 spin_unlock(&tcon->stat_lock);
1593 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1596 spin_lock(&tcon->stat_lock);
1597 tcon->bytes_read += bytes;
1598 spin_unlock(&tcon->stat_lock);
1603 * This is the prototype for the mid receive function. This function is for
1604 * receiving the rest of the SMB frame, starting with the WordCount (which is
1605 * just after the MID in struct smb_hdr). Note:
1607 * - This will be called by cifsd, with no locks held.
1608 * - The mid will still be on the pending_mid_q.
1609 * - mid->resp_buf will point to the current buffer.
1611 * Returns zero on a successful receive, or an error. The receive state in
1612 * the TCP_Server_Info will also be updated.
1614 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1615 struct mid_q_entry *mid);
1618 * This is the prototype for the mid callback function. This is called once the
1619 * mid has been received off of the socket. When creating one, take special
1620 * care to avoid deadlocks. Things to bear in mind:
1622 * - it will be called by cifsd, with no locks held
1623 * - the mid will be removed from any lists
1625 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1628 * This is the protopyte for mid handle function. This is called once the mid
1629 * has been recognized after decryption of the message.
1631 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1632 struct mid_q_entry *mid);
1634 /* one of these for every pending CIFS request to the server */
1635 struct mid_q_entry {
1636 struct list_head qhead; /* mids waiting on reply from this server */
1637 struct kref refcount;
1638 struct TCP_Server_Info *server; /* server corresponding to this mid */
1639 __u64 mid; /* multiplex id */
1640 __u16 credits; /* number of credits consumed by this mid */
1641 __u16 credits_received; /* number of credits from the response */
1642 __u32 pid; /* process id */
1643 __u32 sequence_number; /* for CIFS signing */
1644 unsigned long when_alloc; /* when mid was created */
1645 #ifdef CONFIG_CIFS_STATS2
1646 unsigned long when_sent; /* time when smb send finished */
1647 unsigned long when_received; /* when demux complete (taken off wire) */
1649 mid_receive_t *receive; /* call receive callback */
1650 mid_callback_t *callback; /* call completion callback */
1651 mid_handle_t *handle; /* call handle mid callback */
1652 void *callback_data; /* general purpose pointer for callback */
1653 struct task_struct *creator;
1654 void *resp_buf; /* pointer to received SMB header */
1655 unsigned int resp_buf_size;
1656 int mid_state; /* wish this were enum but can not pass to wait_event */
1657 unsigned int mid_flags;
1658 __le16 command; /* smb command code */
1659 unsigned int optype; /* operation type */
1660 bool large_buf:1; /* if valid response, is pointer to large buf */
1661 bool multiRsp:1; /* multiple trans2 responses for one request */
1662 bool multiEnd:1; /* both received */
1663 bool decrypted:1; /* decrypted entry */
1666 struct close_cancelled_open {
1667 struct cifs_fid fid;
1668 struct cifs_tcon *tcon;
1669 struct work_struct work;
1674 /* Make code in transport.c a little cleaner by moving
1675 update of optional stats into function below */
1676 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1678 atomic_inc(&server->in_send);
1681 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1683 atomic_dec(&server->in_send);
1686 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1688 atomic_inc(&server->num_waiters);
1691 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1693 atomic_dec(&server->num_waiters);
1696 #ifdef CONFIG_CIFS_STATS2
1697 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1699 mid->when_sent = jiffies;
1702 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1707 /* for pending dnotify requests */
1708 struct dir_notify_req {
1709 struct list_head lhead;
1716 __u32 filter; /* CompletionFilter (for multishot) */
1721 struct dfs_info3_param {
1722 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1732 struct list_head list;
1733 struct cifsFileInfo *cfile;
1736 struct cifs_mount_ctx {
1737 struct cifs_sb_info *cifs_sb;
1738 struct smb3_fs_context *fs_ctx;
1740 struct TCP_Server_Info *server;
1741 struct cifs_ses *ses;
1742 struct cifs_tcon *tcon;
1743 struct list_head dfs_ses_list;
1746 static inline void __free_dfs_info_param(struct dfs_info3_param *param)
1748 kfree(param->path_name);
1749 kfree(param->node_name);
1752 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1755 __free_dfs_info_param(param);
1758 static inline void zfree_dfs_info_param(struct dfs_info3_param *param)
1761 __free_dfs_info_param(param);
1762 memset(param, 0, sizeof(*param));
1766 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1767 int number_of_items)
1771 if ((number_of_items == 0) || (param == NULL))
1773 for (i = 0; i < number_of_items; i++) {
1774 kfree(param[i].path_name);
1775 kfree(param[i].node_name);
1780 static inline bool is_interrupt_error(int error)
1785 case -ERESTARTNOHAND:
1786 case -ERESTARTNOINTR:
1792 static inline bool is_retryable_error(int error)
1794 if (is_interrupt_error(error) || error == -EAGAIN)
1800 /* cifs_get_writable_file() flags */
1801 #define FIND_WR_ANY 0
1802 #define FIND_WR_FSUID_ONLY 1
1803 #define FIND_WR_WITH_DELETE 2
1806 #define MID_REQUEST_ALLOCATED 1
1807 #define MID_REQUEST_SUBMITTED 2
1808 #define MID_RESPONSE_RECEIVED 4
1809 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1810 #define MID_RESPONSE_MALFORMED 0x10
1811 #define MID_SHUTDOWN 0x20
1812 #define MID_RESPONSE_READY 0x40 /* ready for other process handle the rsp */
1815 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1816 #define MID_DELETED 2 /* Mid has been dequeued/deleted */
1818 /* Types of response buffer returned from SendReceive2 */
1819 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1820 #define CIFS_SMALL_BUFFER 1
1821 #define CIFS_LARGE_BUFFER 2
1822 #define CIFS_IOVEC 4 /* array of response buffers */
1824 /* Type of Request to SendReceive2 */
1825 #define CIFS_BLOCKING_OP 1 /* operation can block */
1826 #define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */
1827 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1828 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1829 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1830 #define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */
1832 /* Type of request operation */
1833 #define CIFS_ECHO_OP 0x080 /* echo request */
1834 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1835 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1836 #define CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */
1837 /* Lower bitmask values are reserved by others below. */
1838 #define CIFS_SESS_OP 0x2000 /* session setup request */
1839 #define CIFS_OP_MASK 0x2780 /* mask request type */
1841 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1842 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1843 #define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */
1845 /* Security Flags: indicate type of session setup needed */
1846 #define CIFSSEC_MAY_SIGN 0x00001
1847 #define CIFSSEC_MAY_NTLMV2 0x00004
1848 #define CIFSSEC_MAY_KRB5 0x00008
1849 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1850 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1852 #define CIFSSEC_MUST_SIGN 0x01001
1853 /* note that only one of the following can be set so the
1854 result of setting MUST flags more than once will be to
1855 require use of the stronger protocol */
1856 #define CIFSSEC_MUST_NTLMV2 0x04004
1857 #define CIFSSEC_MUST_KRB5 0x08008
1858 #ifdef CONFIG_CIFS_UPCALL
1859 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1861 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1863 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1864 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1866 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1867 #define CIFSSEC_MAX (CIFSSEC_MUST_NTLMV2)
1868 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1870 *****************************************************************
1871 * All constants go here
1872 *****************************************************************
1875 #define UID_HASH (16)
1878 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1879 * following to be declared.
1882 /****************************************************************************
1883 * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according
1884 * to the locking order. i.e. if two locks are to be held together, the lock that
1885 * appears higher in this list needs to be taken before the other.
1887 * If you hold a lock that is lower in this list, and you need to take a higher lock
1888 * (or if you think that one of the functions that you're calling may need to), first
1889 * drop the lock you hold, pick up the higher lock, then the lower one. This will
1890 * ensure that locks are picked up only in one direction in the below table
1893 * Also, if you expect a function to be called with a lock held, explicitly document
1894 * this in the comments on top of your function definition.
1896 * And also, try to keep the critical sections (lock hold time) to be as minimal as
1897 * possible. Blocking / calling other functions with a lock held always increase
1898 * the risk of a possible deadlock.
1900 * Following this rule will avoid unnecessary deadlocks, which can get really hard to
1901 * debug. Also, any new lock that you introduce, please add to this list in the correct
1904 * Please populate this list whenever you introduce new locks in your changes. Or in
1905 * case I've missed some existing locks. Please ensure that it's added in the list
1906 * based on the locking order expected.
1908 * =====================================================================================
1909 * Lock Protects Initialization fn
1910 * =====================================================================================
1912 * vol_info->ctx_lock vol_info->ctx
1913 * cifs_sb_info->tlink_tree_lock cifs_sb_info->tlink_tree cifs_setup_cifs_sb
1914 * TCP_Server_Info-> TCP_Server_Info cifs_get_tcp_session
1916 * TCP_Server_Info->srv_mutex TCP_Server_Info cifs_get_tcp_session
1917 * cifs_ses->session_mutex cifs_ses sesInfoAlloc
1919 * cifs_tcon->open_file_lock cifs_tcon->openFileList tconInfoAlloc
1920 * cifs_tcon->pending_opens
1921 * cifs_tcon->stat_lock cifs_tcon->bytes_read tconInfoAlloc
1922 * cifs_tcon->bytes_written
1923 * cifs_tcp_ses_lock cifs_tcp_ses_list sesInfoAlloc
1924 * GlobalMid_Lock GlobalMaxActiveXid init_cifs
1926 * GlobalTotalActiveXid
1927 * TCP_Server_Info->srv_lock (anything in struct not protected by another lock and can change)
1928 * TCP_Server_Info->mid_lock TCP_Server_Info->pending_mid_q cifs_get_tcp_session
1930 * (any changes in mid_q_entry fields)
1931 * TCP_Server_Info->req_lock TCP_Server_Info->in_flight cifs_get_tcp_session
1935 * ->reconnect_instance
1936 * cifs_ses->ses_lock (anything that is not protected by another lock and can change)
1937 * cifs_ses->iface_lock cifs_ses->iface_list sesInfoAlloc
1939 * ->iface_last_update
1940 * cifs_ses->chan_lock cifs_ses->chans
1941 * ->chans_need_reconnect
1942 * ->chans_in_reconnect
1943 * cifs_tcon->tc_lock (anything that is not protected by another lock and can change)
1944 * cifsInodeInfo->open_file_lock cifsInodeInfo->openFileList cifs_alloc_inode
1945 * cifsInodeInfo->writers_lock cifsInodeInfo->writers cifsInodeInfo_alloc
1946 * cifsInodeInfo->lock_sem cifsInodeInfo->llist cifs_init_once
1947 * ->can_cache_brlcks
1948 * cifsInodeInfo->deferred_lock cifsInodeInfo->deferred_closes cifsInodeInfo_alloc
1949 * cached_fid->fid_mutex cifs_tcon->crfid tcon_info_alloc
1950 * cifsFileInfo->fh_mutex cifsFileInfo cifs_new_fileinfo
1951 * cifsFileInfo->file_info_lock cifsFileInfo->count cifs_new_fileinfo
1952 * ->invalidHandle initiate_cifs_search
1953 * ->oplock_break_cancelled
1954 * cifs_aio_ctx->aio_mutex cifs_aio_ctx cifs_aio_ctx_alloc
1955 ****************************************************************************/
1957 #ifdef DECLARE_GLOBALS_HERE
1958 #define GLOBAL_EXTERN
1960 #define GLOBAL_EXTERN extern
1964 * the list of TCP_Server_Info structures, ie each of the sockets
1965 * connecting our client to a distinct server (ip address), is
1966 * chained together by cifs_tcp_ses_list. The list of all our SMB
1967 * sessions (and from that the tree connections) can be found
1968 * by iterating over cifs_tcp_ses_list
1970 extern struct list_head cifs_tcp_ses_list;
1973 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1974 * tcp session, and the list of tcon's per smb session. It also protects
1975 * the reference counters for the server, smb session, and tcon.
1976 * generally the locks should be taken in order tcp_ses_lock before
1977 * tcon->open_file_lock and that before file->file_info_lock since the
1978 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1980 extern spinlock_t cifs_tcp_ses_lock;
1983 * Global transaction id (XID) information
1985 extern unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1986 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1987 extern unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1988 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */
1991 * Global counters, updated atomically
1993 extern atomic_t sesInfoAllocCount;
1994 extern atomic_t tconInfoAllocCount;
1995 extern atomic_t tcpSesNextId;
1996 extern atomic_t tcpSesAllocCount;
1997 extern atomic_t tcpSesReconnectCount;
1998 extern atomic_t tconInfoReconnectCount;
2000 /* Various Debug counters */
2001 extern atomic_t buf_alloc_count; /* current number allocated */
2002 extern atomic_t small_buf_alloc_count;
2003 #ifdef CONFIG_CIFS_STATS2
2004 extern atomic_t total_buf_alloc_count; /* total allocated over all time */
2005 extern atomic_t total_small_buf_alloc_count;
2006 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
2010 extern bool enable_oplocks; /* enable or disable oplocks */
2011 extern bool lookupCacheEnabled;
2012 extern unsigned int global_secflags; /* if on, session setup sent
2013 with more secure ntlmssp2 challenge/resp */
2014 extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
2015 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
2016 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
2017 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */
2018 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
2019 extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
2020 extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
2021 extern unsigned int cifs_min_small; /* min size of small buf pool */
2022 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
2023 extern unsigned int dir_cache_timeout; /* max time for directory lease caching of dir */
2024 extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
2025 extern atomic_t mid_count;
2027 void cifs_oplock_break(struct work_struct *work);
2028 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
2029 void smb2_deferred_work_close(struct work_struct *work);
2031 extern const struct slow_work_ops cifs_oplock_break_ops;
2032 extern struct workqueue_struct *cifsiod_wq;
2033 extern struct workqueue_struct *decrypt_wq;
2034 extern struct workqueue_struct *fileinfo_put_wq;
2035 extern struct workqueue_struct *cifsoplockd_wq;
2036 extern struct workqueue_struct *deferredclose_wq;
2037 extern __u32 cifs_lock_secret;
2039 extern mempool_t *cifs_mid_poolp;
2041 /* Operations for different SMB versions */
2042 #define SMB1_VERSION_STRING "1.0"
2043 #define SMB20_VERSION_STRING "2.0"
2044 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
2045 extern struct smb_version_operations smb1_operations;
2046 extern struct smb_version_values smb1_values;
2047 extern struct smb_version_operations smb20_operations;
2048 extern struct smb_version_values smb20_values;
2049 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
2050 #define SMB21_VERSION_STRING "2.1"
2051 extern struct smb_version_operations smb21_operations;
2052 extern struct smb_version_values smb21_values;
2053 #define SMBDEFAULT_VERSION_STRING "default"
2054 extern struct smb_version_values smbdefault_values;
2055 #define SMB3ANY_VERSION_STRING "3"
2056 extern struct smb_version_values smb3any_values;
2057 #define SMB30_VERSION_STRING "3.0"
2058 extern struct smb_version_operations smb30_operations;
2059 extern struct smb_version_values smb30_values;
2060 #define SMB302_VERSION_STRING "3.02"
2061 #define ALT_SMB302_VERSION_STRING "3.0.2"
2062 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2063 extern struct smb_version_values smb302_values;
2064 #define SMB311_VERSION_STRING "3.1.1"
2065 #define ALT_SMB311_VERSION_STRING "3.11"
2066 extern struct smb_version_operations smb311_operations;
2067 extern struct smb_version_values smb311_values;
2069 static inline char *get_security_type_str(enum securityEnum sectype)
2073 return "RawNTLMSSP";
2083 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2085 return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2088 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2091 * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2092 * Subsystem Notifies That a Share Is a DFS Share.
2094 * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2095 * Application Updates a Share.
2097 if (!tcon || !tcon->ses || !tcon->ses->server)
2099 return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2100 tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2103 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon,
2104 const struct dfs_info3_param *ref)
2107 * Check if all targets are capable of handling DFS referrals as per
2108 * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL.
2110 return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER));
2113 static inline u64 cifs_flock_len(const struct file_lock *fl)
2115 return (u64)fl->fl_end - fl->fl_start + 1;
2118 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses)
2120 if (WARN_ON_ONCE(!ses || !ses->server))
2123 * Make workstation name no more than 15 chars when using insecure dialects as some legacy
2124 * servers do require it during NTLMSSP.
2126 if (ses->server->dialect <= SMB20_PROT_ID)
2127 return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL);
2128 return sizeof(ses->workstation_name);
2131 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src)
2133 memcpy(dst, src, (size_t)((u8 *)&src->AccessFlags - (u8 *)src));
2134 dst->AccessFlags = src->AccessFlags;
2135 dst->CurrentByteOffset = src->CurrentByteOffset;
2136 dst->Mode = src->Mode;
2137 dst->AlignmentRequirement = src->AlignmentRequirement;
2138 dst->FileNameLength = src->FileNameLength;
2141 static inline int cifs_get_num_sgs(const struct smb_rqst *rqst,
2145 unsigned int len, skip;
2146 unsigned int nents = 0;
2152 * The first rqst has a transform header where the first 20 bytes are
2153 * not part of the encrypted blob.
2157 /* Assumes the first rqst has a transform header as the first iov.
2159 * rqst[0].rq_iov[0] is transform header
2160 * rqst[0].rq_iov[1+] data to be encrypted/decrypted
2161 * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
2163 for (i = 0; i < num_rqst; i++) {
2164 data_size = iov_iter_count(&rqst[i].rq_iter);
2166 /* We really don't want a mixture of pinned and unpinned pages
2167 * in the sglist. It's hard to keep track of which is what.
2168 * Instead, we convert to a BVEC-type iterator higher up.
2171 WARN_ON_ONCE(user_backed_iter(&rqst[i].rq_iter)))
2174 /* We also don't want to have any extra refs or pins to clean
2178 WARN_ON_ONCE(iov_iter_extract_will_pin(&rqst[i].rq_iter)))
2181 for (j = 0; j < rqst[i].rq_nvec; j++) {
2182 struct kvec *iov = &rqst[i].rq_iov[j];
2184 addr = (unsigned long)iov->iov_base + skip;
2185 if (unlikely(is_vmalloc_addr((void *)addr))) {
2186 len = iov->iov_len - skip;
2187 nents += DIV_ROUND_UP(offset_in_page(addr) + len,
2195 nents += iov_iter_npages(&rqst[i].rq_iter, INT_MAX);
2197 nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
2201 /* We can not use the normal sg_set_buf() as we will sometimes pass a
2202 * stack object as buf.
2204 static inline void cifs_sg_set_buf(struct sg_table *sgtable,
2206 unsigned int buflen)
2208 unsigned long addr = (unsigned long)buf;
2209 unsigned int off = offset_in_page(addr);
2212 if (unlikely(is_vmalloc_addr((void *)addr))) {
2214 unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
2216 sg_set_page(&sgtable->sgl[sgtable->nents++],
2217 vmalloc_to_page((void *)addr), len, off);
2224 sg_set_page(&sgtable->sgl[sgtable->nents++],
2225 virt_to_page((void *)addr), buflen, off);
2229 struct smb2_compound_vars {
2230 struct cifs_open_parms oparms;
2231 struct kvec rsp_iov[3];
2232 struct smb_rqst rqst[3];
2233 struct kvec open_iov[SMB2_CREATE_IOV_SIZE];
2235 struct kvec io_iov[SMB2_IOCTL_IOV_SIZE];
2236 struct kvec si_iov[SMB2_SET_INFO_IOV_SIZE];
2237 struct kvec close_iov;
2238 struct smb2_file_rename_info rename_info;
2239 struct smb2_file_link_info link_info;
2242 #endif /* _CIFS_GLOB_H */