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 <linux/scatterlist.h>
27 #include <uapi/linux/cifs/cifs_mount.h>
28 #include "../smbfs_common/smb2pdu.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 /* dns resolution intervals in seconds */
82 #define SMB_DNS_RESOLVE_INTERVAL_MIN 120
83 #define SMB_DNS_RESOLVE_INTERVAL_DEFAULT 600
85 /* smb multichannel query server interfaces interval in seconds */
86 #define SMB_INTERFACE_POLL_INTERVAL 600
88 /* maximum number of PDUs in one compound */
89 #define MAX_COMPOUND 5
92 * Default number of credits to keep available for SMB3.
93 * This value is chosen somewhat arbitrarily. The Windows client
94 * defaults to 128 credits, the Windows server allows clients up to
95 * 512 credits (or 8K for later versions), and the NetApp server
96 * does not limit clients at all. Choose a high enough default value
97 * such that the client shouldn't limit performance, but allow mount
98 * to override (until you approach 64K, where we limit credits to 65000
99 * to reduce possibility of seeing more server credit overflow bugs.
101 #define SMB2_MAX_CREDITS_AVAILABLE 32000
105 #ifndef XATTR_DOS_ATTRIB
106 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
109 #define CIFS_MAX_WORKSTATION_LEN (__NEW_UTS_LEN + 1) /* reasonable max for client */
112 * CIFS vfs client Status information (based on what we know.)
115 /* associated with each connection */
125 /* associated with each smb session */
126 enum ses_status_enum {
134 /* associated with each tree connection to the server */
135 enum tid_status_enum {
142 TID_NEED_FILES_INVALIDATE, /* currently unused */
143 TID_IN_FILES_INVALIDATE
147 Unspecified = 0, /* not specified */
148 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
149 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
150 Kerberos, /* Kerberos via SPNEGO */
158 /* crypto hashing related structure/fields, not specific to a sec mech */
159 struct cifs_secmech {
160 struct shash_desc *hmacmd5; /* hmacmd5 hash function, for NTLMv2/CR1 hashes */
161 struct shash_desc *md5; /* md5 hash function, for CIFS/SMB1 signatures */
162 struct shash_desc *hmacsha256; /* hmac-sha256 hash function, for SMB2 signatures */
163 struct shash_desc *sha512; /* sha512 hash function, for SMB3.1.1 preauth hash */
164 struct shash_desc *aes_cmac; /* block-cipher based MAC function, for SMB3 signatures */
166 struct crypto_aead *enc; /* smb3 encryption AEAD TFM (AES-CCM and AES-GCM) */
167 struct crypto_aead *dec; /* smb3 decryption AEAD TFM (AES-CCM and AES-GCM) */
170 /* per smb session structure/fields */
171 struct ntlmssp_auth {
172 bool sesskey_per_smbsess; /* whether session key is per smb session */
173 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
174 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
175 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
176 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
184 struct cifs_sid osid;
185 struct cifs_sid gsid;
186 struct cifs_ntace *ntaces;
187 struct cifs_ace *aces;
190 struct cifs_open_info_data {
191 char *symlink_target;
193 struct smb2_file_all_info fi;
194 struct smb311_posix_qinfo posix_fi;
198 static inline void cifs_free_open_info(struct cifs_open_info_data *data)
200 kfree(data->symlink_target);
204 *****************************************************************
205 * Except the CIFS PDUs themselves all the
206 * globally interesting structs should go here
207 *****************************************************************
211 * A smb_rqst represents a complete request to be issued to a server. It's
212 * formed by a kvec array, followed by an array of pages. Page data is assumed
213 * to start at the beginning of the first page.
216 struct kvec *rq_iov; /* array of kvecs */
217 unsigned int rq_nvec; /* number of kvecs in array */
218 struct page **rq_pages; /* pointer to array of page ptrs */
219 unsigned int rq_offset; /* the offset to the 1st page */
220 unsigned int rq_npages; /* number pages in array */
221 unsigned int rq_pagesz; /* page size to use */
222 unsigned int rq_tailsz; /* length of last page */
226 struct TCP_Server_Info;
230 struct dfs_info3_param;
232 struct smb3_fs_context;
234 struct cifs_readdata;
235 struct cifs_writedata;
236 struct cifs_io_parms;
237 struct cifs_search_info;
238 struct cifsInodeInfo;
239 struct cifs_open_parms;
242 struct smb_version_operations {
243 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
244 struct mid_q_entry *);
245 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
246 /* setup request: allocate mid, sign message */
247 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
248 struct TCP_Server_Info *,
250 /* setup async request: allocate mid, sign message */
251 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
253 /* check response: verify signature, map error */
254 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
256 void (*add_credits)(struct TCP_Server_Info *server,
257 const struct cifs_credits *credits,
259 void (*set_credits)(struct TCP_Server_Info *, const int);
260 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
261 unsigned int (*get_credits)(struct mid_q_entry *);
262 __u64 (*get_next_mid)(struct TCP_Server_Info *);
263 void (*revert_current_mid)(struct TCP_Server_Info *server,
264 const unsigned int val);
265 /* data offset from read response message */
266 unsigned int (*read_data_offset)(char *);
268 * Data length from read response message
269 * When in_remaining is true, the returned data length is in
270 * message field DataRemaining for out-of-band data read (e.g through
271 * Memory Registration RDMA write in SMBD).
272 * Otherwise, the returned data length is in message field DataLength.
274 unsigned int (*read_data_length)(char *, bool in_remaining);
275 /* map smb to linux error */
276 int (*map_error)(char *, bool);
277 /* find mid corresponding to the response message */
278 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
279 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
280 void (*clear_stats)(struct cifs_tcon *);
281 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
282 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
283 /* verify the message */
284 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
285 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
286 int (*handle_cancelled_mid)(struct mid_q_entry *, struct TCP_Server_Info *);
287 void (*downgrade_oplock)(struct TCP_Server_Info *server,
288 struct cifsInodeInfo *cinode, __u32 oplock,
289 unsigned int epoch, bool *purge_cache);
290 /* process transaction2 response */
291 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
293 /* check if we need to negotiate */
294 bool (*need_neg)(struct TCP_Server_Info *);
295 /* negotiate to the server */
296 int (*negotiate)(const unsigned int xid,
297 struct cifs_ses *ses,
298 struct TCP_Server_Info *server);
299 /* set negotiated write size */
300 unsigned int (*negotiate_wsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
301 /* set negotiated read size */
302 unsigned int (*negotiate_rsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
303 /* setup smb sessionn */
304 int (*sess_setup)(const unsigned int, struct cifs_ses *,
305 struct TCP_Server_Info *server,
306 const struct nls_table *);
307 /* close smb session */
308 int (*logoff)(const unsigned int, struct cifs_ses *);
309 /* connect to a server share */
310 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
311 struct cifs_tcon *, const struct nls_table *);
312 /* close tree connecion */
313 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
314 /* get DFS referrals */
315 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
316 const char *, struct dfs_info3_param **,
317 unsigned int *, const struct nls_table *, int);
318 /* informational QFS call */
319 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *,
320 struct cifs_sb_info *);
321 /* check if a path is accessible or not */
322 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
323 struct cifs_sb_info *, const char *);
324 /* query path data from the server */
325 int (*query_path_info)(const unsigned int xid, struct cifs_tcon *tcon,
326 struct cifs_sb_info *cifs_sb, const char *full_path,
327 struct cifs_open_info_data *data, bool *adjust_tz, bool *reparse);
328 /* query file data from the server */
329 int (*query_file_info)(const unsigned int xid, struct cifs_tcon *tcon,
330 struct cifsFileInfo *cfile, struct cifs_open_info_data *data);
331 /* query reparse tag from srv to determine which type of special file */
332 int (*query_reparse_tag)(const unsigned int xid, struct cifs_tcon *tcon,
333 struct cifs_sb_info *cifs_sb, const char *path,
335 /* get server index number */
336 int (*get_srv_inum)(const unsigned int xid, struct cifs_tcon *tcon,
337 struct cifs_sb_info *cifs_sb, const char *full_path, u64 *uniqueid,
338 struct cifs_open_info_data *data);
339 /* set size by path */
340 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
341 const char *, __u64, struct cifs_sb_info *, bool);
342 /* set size by file handle */
343 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
344 struct cifsFileInfo *, __u64, bool);
346 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
348 int (*set_compression)(const unsigned int, struct cifs_tcon *,
349 struct cifsFileInfo *);
350 /* check if we can send an echo or nor */
351 bool (*can_echo)(struct TCP_Server_Info *);
352 /* send echo request */
353 int (*echo)(struct TCP_Server_Info *);
354 /* create directory */
355 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
356 umode_t mode, struct cifs_tcon *tcon,
357 const char *full_path,
358 struct cifs_sb_info *cifs_sb);
359 int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
360 struct cifs_tcon *tcon, const char *name,
361 struct cifs_sb_info *sb);
362 /* set info on created directory */
363 void (*mkdir_setinfo)(struct inode *, const char *,
364 struct cifs_sb_info *, struct cifs_tcon *,
366 /* remove directory */
367 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
368 struct cifs_sb_info *);
370 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
371 struct cifs_sb_info *);
372 /* open, rename and delete file */
373 int (*rename_pending_delete)(const char *, struct dentry *,
375 /* send rename request */
376 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
377 const char *, struct cifs_sb_info *);
378 /* send create hardlink request */
379 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
380 const char *, const char *,
381 struct cifs_sb_info *);
382 /* query symlink target */
383 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
384 struct cifs_sb_info *, const char *,
386 /* open a file for non-posix mounts */
387 int (*open)(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,
389 /* set fid protocol-specific info */
390 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
392 void (*close)(const unsigned int, struct cifs_tcon *,
394 /* close a file, returning file attributes and timestamps */
395 void (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon,
396 struct cifsFileInfo *pfile_info);
397 /* send a flush request to the server */
398 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
399 /* async read from the server */
400 int (*async_readv)(struct cifs_readdata *);
401 /* async write to the server */
402 int (*async_writev)(struct cifs_writedata *,
403 void (*release)(struct kref *));
404 /* sync read from the server */
405 int (*sync_read)(const unsigned int, struct cifs_fid *,
406 struct cifs_io_parms *, unsigned int *, char **,
408 /* sync write to the server */
409 int (*sync_write)(const unsigned int, struct cifs_fid *,
410 struct cifs_io_parms *, unsigned int *, struct kvec *,
412 /* open dir, start readdir */
413 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
414 const char *, struct cifs_sb_info *,
415 struct cifs_fid *, __u16,
416 struct cifs_search_info *);
417 /* continue readdir */
418 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
420 __u16, struct cifs_search_info *srch_inf);
422 int (*close_dir)(const unsigned int, struct cifs_tcon *,
424 /* calculate a size of SMB message */
425 unsigned int (*calc_smb_size)(void *buf);
426 /* check for STATUS_PENDING and process the response if yes */
427 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
428 /* check for STATUS_NETWORK_SESSION_EXPIRED */
429 bool (*is_session_expired)(char *);
430 /* send oplock break response */
431 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
432 struct cifsInodeInfo *);
433 /* query remote filesystem */
434 int (*queryfs)(const unsigned int, struct cifs_tcon *,
435 struct cifs_sb_info *, struct kstatfs *);
436 /* send mandatory brlock to the server */
437 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
438 __u64, __u32, int, int, bool);
439 /* unlock range of mandatory locks */
440 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
442 /* push brlocks from the cache to the server */
443 int (*push_mand_locks)(struct cifsFileInfo *);
444 /* get lease key of the inode */
445 void (*get_lease_key)(struct inode *, struct cifs_fid *);
446 /* set lease key of the inode */
447 void (*set_lease_key)(struct inode *, struct cifs_fid *);
448 /* generate new lease key */
449 void (*new_lease_key)(struct cifs_fid *);
450 int (*generate_signingkey)(struct cifs_ses *ses,
451 struct TCP_Server_Info *server);
452 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *,
453 bool allocate_crypto);
454 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
455 struct cifsFileInfo *src_file);
456 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
457 struct cifsFileInfo *src_file, void __user *);
458 int (*notify)(const unsigned int xid, struct file *pfile,
459 void __user *pbuf, bool return_changes);
460 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
461 struct cifs_sb_info *, const unsigned char *,
462 char *, unsigned int *);
463 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
464 struct cifs_sb_info *, const unsigned char *,
465 char *, unsigned int *);
466 /* if we can do cache read operations */
467 bool (*is_read_op)(__u32);
468 /* set oplock level for the inode */
469 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
471 /* create lease context buffer for CREATE request */
472 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
473 /* parse lease context buffer and return oplock/epoch info */
474 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
475 ssize_t (*copychunk_range)(const unsigned int,
476 struct cifsFileInfo *src_file,
477 struct cifsFileInfo *target_file,
478 u64 src_off, u64 len, u64 dest_off);
479 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
480 struct cifsFileInfo *target_file, u64 src_off, u64 len,
482 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
483 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
484 const unsigned char *, const unsigned char *, char *,
485 size_t, struct cifs_sb_info *);
486 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
487 const char *, const void *, const __u16,
488 const struct nls_table *, struct cifs_sb_info *);
489 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
490 const char *, u32 *, u32);
491 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
492 const struct cifs_fid *, u32 *, u32);
493 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
495 /* writepages retry size */
496 unsigned int (*wp_retry_size)(struct inode *);
497 /* get mtu credits */
498 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
499 unsigned int *, struct cifs_credits *);
500 /* adjust previously taken mtu credits to request size */
501 int (*adjust_credits)(struct TCP_Server_Info *server,
502 struct cifs_credits *credits,
503 const unsigned int payload_size);
504 /* check if we need to issue closedir */
505 bool (*dir_needs_close)(struct cifsFileInfo *);
506 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
508 /* init transform request - used for encryption for now */
509 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
510 struct smb_rqst *, struct smb_rqst *);
511 int (*is_transform_hdr)(void *buf);
512 int (*receive_transform)(struct TCP_Server_Info *,
513 struct mid_q_entry **, char **, int *);
514 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
516 int (*next_header)(char *);
517 /* ioctl passthrough for query_info */
518 int (*ioctl_query_info)(const unsigned int xid,
519 struct cifs_tcon *tcon,
520 struct cifs_sb_info *cifs_sb,
521 __le16 *path, int is_dir,
523 /* make unix special files (block, char, fifo, socket) */
524 int (*make_node)(unsigned int xid,
526 struct dentry *dentry,
527 struct cifs_tcon *tcon,
528 const char *full_path,
530 dev_t device_number);
531 /* version specific fiemap implementation */
532 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
533 struct fiemap_extent_info *, u64, u64);
534 /* version specific llseek implementation */
535 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
536 /* Check for STATUS_IO_TIMEOUT */
537 bool (*is_status_io_timeout)(char *buf);
538 /* Check for STATUS_NETWORK_NAME_DELETED */
539 void (*is_network_name_deleted)(char *buf, struct TCP_Server_Info *srv);
542 struct smb_version_values {
543 char *version_string;
545 __u32 req_capabilities;
546 __u32 large_lock_type;
547 __u32 exclusive_lock_type;
548 __u32 shared_lock_type;
549 __u32 unlock_lock_type;
550 size_t header_preamble_size;
552 size_t max_header_size;
553 size_t read_rsp_size;
555 unsigned int cap_unix;
556 unsigned int cap_nt_find;
557 unsigned int cap_large_files;
558 __u16 signing_enabled;
559 __u16 signing_required;
560 size_t create_lease_size;
563 #define HEADER_SIZE(server) (server->vals->header_size)
564 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
565 #define HEADER_PREAMBLE_SIZE(server) (server->vals->header_preamble_size)
566 #define MID_HEADER_SIZE(server) (HEADER_SIZE(server) - 1 - HEADER_PREAMBLE_SIZE(server))
569 * CIFS superblock mount flags (mnt_cifs_flags) to consider when
570 * trying to reuse existing superblock for a new mount
572 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
573 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
574 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
575 CIFS_MOUNT_MAP_SFM_CHR | \
576 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
577 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
578 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
579 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
580 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
581 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
582 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
583 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
584 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
585 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
588 * Generic VFS superblock mount flags (s_flags) to consider when
589 * trying to reuse existing superblock for a new mount
591 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
592 SB_NODEV | SB_SYNCHRONOUS)
594 struct cifs_mnt_data {
595 struct cifs_sb_info *cifs_sb;
596 struct smb3_fs_context *ctx;
600 static inline unsigned int
601 get_rfc1002_length(void *buf)
603 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
607 inc_rfc1001_len(void *buf, int count)
609 be32_add_cpu((__be32 *)buf, count);
612 struct TCP_Server_Info {
613 struct list_head tcp_ses_list;
614 struct list_head smb_ses_list;
615 spinlock_t srv_lock; /* protect anything here that is not protected */
616 __u64 conn_id; /* connection identifier (useful for debugging) */
617 int srv_count; /* reference counter */
618 /* 15 character server name + 0x20 16th byte indicating type = srv */
619 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
620 struct smb_version_operations *ops;
621 struct smb_version_values *vals;
622 /* updates to tcpStatus protected by cifs_tcp_ses_lock */
623 enum statusEnum tcpStatus; /* what we think the status is */
624 char *hostname; /* hostname portion of UNC string */
625 struct socket *ssocket;
626 struct sockaddr_storage dstaddr;
627 struct sockaddr_storage srcaddr; /* locally bind to this IP */
631 wait_queue_head_t response_q;
632 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
633 spinlock_t mid_lock; /* protect mid queue and it's entries */
634 struct list_head pending_mid_q;
635 bool noblocksnd; /* use blocking sendmsg */
636 bool noautotune; /* do not autotune send buf sizes */
639 unsigned int credits; /* send no more requests at once */
640 unsigned int max_credits; /* can override large 32000 default at mnt */
641 unsigned int in_flight; /* number of requests on the wire to server */
642 unsigned int max_in_flight; /* max number of requests that were on wire */
643 spinlock_t req_lock; /* protect the two values above */
644 struct mutex _srv_mutex;
645 unsigned int nofs_flag;
646 struct task_struct *tsk;
647 char server_GUID[16];
649 bool sign; /* is signing enabled on this connection? */
650 bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
651 bool session_estab; /* mark when very first sess is established */
652 int echo_credits; /* echo reserved slots */
653 int oplock_credits; /* oplock break reserved slots */
654 bool echoes:1; /* enable echoes */
655 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
656 u16 dialect; /* dialect index that server chose */
657 bool oplocks:1; /* enable oplocks */
658 unsigned int maxReq; /* Clients should submit no more */
659 /* than maxReq distinct unanswered SMBs to the server when using */
660 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
661 unsigned int maxBuf; /* maxBuf specifies the maximum */
662 /* message size the server can send or receive for non-raw SMBs */
663 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
664 /* when socket is setup (and during reconnect) before NegProt sent */
665 unsigned int max_rw; /* maxRw specifies the maximum */
666 /* message size the server can send or receive for */
667 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
668 unsigned int capabilities; /* selective disabling of caps by smb sess */
669 int timeAdj; /* Adjust for difference in server time zone in sec */
670 __u64 CurrentMid; /* multiplex id - rotating counter, protected by GlobalMid_Lock */
671 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
672 /* 16th byte of RFC1001 workstation name is always null */
673 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
674 __u32 sequence_number; /* for signing, protected by srv_mutex */
675 __u32 reconnect_instance; /* incremented on each reconnect */
676 struct session_key session_key;
677 unsigned long lstrp; /* when we got last response from this server */
678 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
679 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
680 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
681 char negflavor; /* NEGOTIATE response flavor */
682 /* extended security flavors that server supports */
683 bool sec_ntlmssp; /* supports NTLMSSP */
684 bool sec_kerberosu2u; /* supports U2U Kerberos */
685 bool sec_kerberos; /* supports plain Kerberos */
686 bool sec_mskerberos; /* supports legacy MS Kerberos */
687 bool large_buf; /* is current buffer large? */
688 /* use SMBD connection instead of socket */
690 /* point to the SMBD connection if RDMA is used instead of socket */
691 struct smbd_connection *smbd_conn;
692 struct delayed_work echo; /* echo ping workqueue job */
693 struct delayed_work resolve; /* dns resolution workqueue job */
694 char *smallbuf; /* pointer to current "small" buffer */
695 char *bigbuf; /* pointer to current "big" buffer */
696 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
697 unsigned int pdu_size;
698 unsigned int total_read; /* total amount of data read in this pass */
699 atomic_t in_send; /* requests trying to send */
700 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
701 #ifdef CONFIG_CIFS_STATS2
702 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
703 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
704 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
705 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
706 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
708 unsigned int max_read;
709 unsigned int max_write;
710 unsigned int min_offload;
711 __le16 compress_algorithm;
712 __u16 signing_algorithm;
714 /* save initital negprot hash */
715 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
716 bool signing_negotiated; /* true if valid signing context rcvd from server */
717 bool posix_ext_supported;
718 struct delayed_work reconnect; /* reconnect workqueue job */
719 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
720 unsigned long echo_interval;
723 * Number of targets available for reconnect. The more targets
724 * the more tasks have to wait to let the demultiplex thread
728 bool noblockcnt; /* use non-blocking connect() */
731 * If this is a session channel,
732 * primary_server holds the ref-counted
733 * pointer to primary channel connection for the session.
735 #define CIFS_SERVER_IS_CHAN(server) (!!(server)->primary_server)
736 struct TCP_Server_Info *primary_server;
738 #ifdef CONFIG_CIFS_SWN_UPCALL
739 bool use_swn_dstaddr;
740 struct sockaddr_storage swn_dstaddr;
742 #ifdef CONFIG_CIFS_DFS_UPCALL
743 bool is_dfs_conn; /* if a dfs connection */
744 struct mutex refpath_lock; /* protects leaf_fullpath */
746 * Canonical DFS full paths that were used to chase referrals in mount and reconnect.
748 * origin_fullpath: first or original referral path
749 * leaf_fullpath: last referral path (might be changed due to nested links in reconnect)
751 * current_fullpath: pointer to either origin_fullpath or leaf_fullpath
752 * NOTE: cannot be accessed outside cifs_reconnect() and smb2_reconnect()
754 * format: \\HOST\SHARE\[OPTIONAL PATH]
756 char *origin_fullpath, *leaf_fullpath, *current_fullpath;
760 static inline bool is_smb1(struct TCP_Server_Info *server)
762 return HEADER_PREAMBLE_SIZE(server) != 0;
765 static inline void cifs_server_lock(struct TCP_Server_Info *server)
767 unsigned int nofs_flag = memalloc_nofs_save();
769 mutex_lock(&server->_srv_mutex);
770 server->nofs_flag = nofs_flag;
773 static inline void cifs_server_unlock(struct TCP_Server_Info *server)
775 unsigned int nofs_flag = server->nofs_flag;
777 mutex_unlock(&server->_srv_mutex);
778 memalloc_nofs_restore(nofs_flag);
781 struct cifs_credits {
783 unsigned int instance;
786 static inline unsigned int
787 in_flight(struct TCP_Server_Info *server)
790 spin_lock(&server->req_lock);
791 num = server->in_flight;
792 spin_unlock(&server->req_lock);
797 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
800 spin_lock(&server->req_lock);
802 spin_unlock(&server->req_lock);
803 return num >= num_credits;
807 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
810 server->ops->add_credits(server, credits, optype);
814 add_credits_and_wake_if(struct TCP_Server_Info *server,
815 const struct cifs_credits *credits, const int optype)
817 if (credits->value) {
818 server->ops->add_credits(server, credits, optype);
819 wake_up(&server->request_q);
824 set_credits(struct TCP_Server_Info *server, const int val)
826 server->ops->set_credits(server, val);
830 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
831 const unsigned int payload_size)
833 return server->ops->adjust_credits ?
834 server->ops->adjust_credits(server, credits, payload_size) : 0;
838 get_next_mid64(struct TCP_Server_Info *server)
840 return cpu_to_le64(server->ops->get_next_mid(server));
844 get_next_mid(struct TCP_Server_Info *server)
846 __u16 mid = server->ops->get_next_mid(server);
848 * The value in the SMB header should be little endian for easy
849 * on-the-wire decoding.
851 return cpu_to_le16(mid);
855 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
857 if (server->ops->revert_current_mid)
858 server->ops->revert_current_mid(server, val);
862 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
863 const struct smb2_hdr *shdr)
865 unsigned int num = le16_to_cpu(shdr->CreditCharge);
867 return revert_current_mid(server, num > 0 ? num : 1);
871 get_mid(const struct smb_hdr *smb)
873 return le16_to_cpu(smb->Mid);
877 compare_mid(__u16 mid, const struct smb_hdr *smb)
879 return mid == le16_to_cpu(smb->Mid);
883 * When the server supports very large reads and writes via POSIX extensions,
884 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
885 * including the RFC1001 length.
887 * Note that this might make for "interesting" allocation problems during
888 * writeback however as we have to allocate an array of pointers for the
889 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
891 * For reads, there is a similar problem as we need to allocate an array
892 * of kvecs to handle the receive, though that should only need to be done
895 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
896 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
899 * When the server doesn't allow large posix writes, only allow a rsize/wsize
900 * of 2^17-1 minus the size of the call header. That allows for a read or
901 * write up to the maximum size described by RFC1002.
903 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
904 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
906 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
909 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
910 * those values when posix extensions aren't in force. In actuality here, we
911 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
912 * to be ok with the extra byte even though Windows doesn't send writes that
917 * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
919 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
920 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
923 * Macros to allow the TCP_Server_Info->net field and related code to drop out
924 * when CONFIG_NET_NS isn't set.
929 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
934 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
941 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
946 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
952 struct cifs_server_iface {
953 struct list_head iface_head;
954 struct kref refcount;
956 unsigned int rdma_capable : 1;
957 unsigned int rss_capable : 1;
958 unsigned int is_active : 1; /* unset if non existent */
959 struct sockaddr_storage sockaddr;
962 /* release iface when last ref is dropped */
964 release_iface(struct kref *ref)
966 struct cifs_server_iface *iface = container_of(ref,
967 struct cifs_server_iface,
969 list_del_init(&iface->iface_head);
974 * compare two interfaces a and b
975 * return 0 if everything matches.
976 * return 1 if a has higher link speed, or rdma capable, or rss capable
977 * return -1 otherwise.
980 iface_cmp(struct cifs_server_iface *a, struct cifs_server_iface *b)
985 if (a->speed == b->speed) {
986 if (a->rdma_capable == b->rdma_capable) {
987 if (a->rss_capable == b->rss_capable) {
988 cmp_ret = memcmp(&a->sockaddr, &b->sockaddr,
989 sizeof(a->sockaddr));
992 else if (cmp_ret > 0)
996 } else if (a->rss_capable > b->rss_capable)
1000 } else if (a->rdma_capable > b->rdma_capable)
1004 } else if (a->speed > b->speed)
1011 unsigned int in_reconnect : 1; /* if session setup in progress for this channel */
1012 struct TCP_Server_Info *server;
1013 struct cifs_server_iface *iface; /* interface in use */
1014 __u8 signkey[SMB3_SIGN_KEY_SIZE];
1018 * Session structure. One of these for each uid session with a particular host
1021 struct list_head smb_ses_list;
1022 struct list_head rlist; /* reconnect list */
1023 struct list_head tcon_list;
1024 struct cifs_tcon *tcon_ipc;
1025 spinlock_t ses_lock; /* protect anything here that is not protected */
1026 struct mutex session_mutex;
1027 struct TCP_Server_Info *server; /* pointer to server info */
1028 int ses_count; /* reference counter */
1029 enum ses_status_enum ses_status; /* updates protected by cifs_tcp_ses_lock */
1030 unsigned overrideSecFlg; /* if non-zero override global sec flags */
1031 char *serverOS; /* name of operating system underlying server */
1032 char *serverNOS; /* name of network operating system of server */
1033 char *serverDomain; /* security realm of server */
1034 __u64 Suid; /* remote smb uid */
1035 kuid_t linux_uid; /* overriding owner of files on the mount */
1036 kuid_t cred_uid; /* owner of credentials */
1037 unsigned int capabilities;
1038 char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */
1039 char *user_name; /* must not be null except during init of sess
1040 and after mount option parsing we fill it */
1043 char workstation_name[CIFS_MAX_WORKSTATION_LEN];
1044 struct session_key auth_key;
1045 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
1046 enum securityEnum sectype; /* what security flavor was specified? */
1047 bool sign; /* is signing required? */
1049 __u16 session_flags;
1050 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
1051 __u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1052 __u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1053 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1056 * Network interfaces available on the server this session is
1059 * Other channels can be opened by connecting and binding this
1060 * session to interfaces from this list.
1062 * iface_lock should be taken when accessing any of these fields
1064 spinlock_t iface_lock;
1065 /* ========= begin: protected by iface_lock ======== */
1066 struct list_head iface_list;
1068 unsigned long iface_last_update; /* jiffies */
1069 /* ========= end: protected by iface_lock ======== */
1071 spinlock_t chan_lock;
1072 /* ========= begin: protected by chan_lock ======== */
1073 #define CIFS_MAX_CHANNELS 16
1074 #define CIFS_ALL_CHANNELS_SET(ses) \
1075 ((1UL << (ses)->chan_count) - 1)
1076 #define CIFS_ALL_CHANS_GOOD(ses) \
1077 (!(ses)->chans_need_reconnect)
1078 #define CIFS_ALL_CHANS_NEED_RECONNECT(ses) \
1079 ((ses)->chans_need_reconnect == CIFS_ALL_CHANNELS_SET(ses))
1080 #define CIFS_SET_ALL_CHANS_NEED_RECONNECT(ses) \
1081 ((ses)->chans_need_reconnect = CIFS_ALL_CHANNELS_SET(ses))
1082 #define CIFS_CHAN_NEEDS_RECONNECT(ses, index) \
1083 test_bit((index), &(ses)->chans_need_reconnect)
1084 #define CIFS_CHAN_IN_RECONNECT(ses, index) \
1085 ((ses)->chans[(index)].in_reconnect)
1087 struct cifs_chan chans[CIFS_MAX_CHANNELS];
1090 atomic_t chan_seq; /* round robin state */
1093 * chans_need_reconnect is a bitmap indicating which of the channels
1094 * under this smb session needs to be reconnected.
1095 * If not multichannel session, only one bit will be used.
1097 * We will ask for sess and tcon reconnection only if all the
1098 * channels are marked for needing reconnection. This will
1099 * enable the sessions on top to continue to live till any
1100 * of the channels below are active.
1102 unsigned long chans_need_reconnect;
1103 /* ========= end: protected by chan_lock ======== */
1107 cap_unix(struct cifs_ses *ses)
1109 return ses->server->vals->cap_unix & ses->capabilities;
1113 * common struct for holding inode info when searching for or updating an
1114 * inode with new info
1117 #define CIFS_FATTR_DFS_REFERRAL 0x1
1118 #define CIFS_FATTR_DELETE_PENDING 0x2
1119 #define CIFS_FATTR_NEED_REVAL 0x4
1120 #define CIFS_FATTR_INO_COLLISION 0x8
1121 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1122 #define CIFS_FATTR_FAKE_ROOT_INO 0x20
1135 unsigned int cf_nlink;
1136 unsigned int cf_dtype;
1137 struct timespec64 cf_atime;
1138 struct timespec64 cf_mtime;
1139 struct timespec64 cf_ctime;
1141 char *cf_symlink_target;
1145 * there is one of these for each connection to a resource on a particular
1149 struct list_head tcon_list;
1151 struct list_head rlist; /* reconnect list */
1152 spinlock_t tc_lock; /* protect anything here that is not protected */
1153 atomic_t num_local_opens; /* num of all opens including disconnected */
1154 atomic_t num_remote_opens; /* num of all network opens on server */
1155 struct list_head openFileList;
1156 spinlock_t open_file_lock; /* protects list above */
1157 struct cifs_ses *ses; /* pointer to session associated with */
1158 char tree_name[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1159 char *nativeFileSystem;
1160 char *password; /* for share-level security */
1161 __u32 tid; /* The 4 byte tree id */
1162 __u16 Flags; /* optional support bits */
1163 enum tid_status_enum status;
1164 atomic_t num_smbs_sent;
1167 atomic_t num_writes;
1169 atomic_t num_flushes;
1170 atomic_t num_oplock_brks;
1172 atomic_t num_closes;
1173 atomic_t num_deletes;
1174 atomic_t num_mkdirs;
1175 atomic_t num_posixopens;
1176 atomic_t num_posixmkdirs;
1177 atomic_t num_rmdirs;
1178 atomic_t num_renames;
1179 atomic_t num_t2renames;
1180 atomic_t num_ffirst;
1182 atomic_t num_fclose;
1183 atomic_t num_hardlinks;
1184 atomic_t num_symlinks;
1186 atomic_t num_acl_get;
1187 atomic_t num_acl_set;
1190 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1191 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1195 __u64 bytes_written;
1196 spinlock_t stat_lock; /* protects the two fields above */
1197 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1198 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1199 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1200 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
1201 bool pipe:1; /* set if connection to pipe share */
1202 bool print:1; /* set if connection to printer share */
1205 bool nohandlecache:1; /* if strange server resource prob can turn off */
1207 bool seal:1; /* transport encryption for this mounted share */
1208 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
1209 for this mount even if server would support */
1210 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1211 bool local_lease:1; /* check leases (only) on local system not remote */
1212 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1213 bool broken_sparse_sup; /* if server or share does not support sparse */
1214 bool need_reconnect:1; /* connection reset, tid now invalid */
1215 bool need_reopen_files:1; /* need to reopen tcon file handles */
1216 bool use_resilient:1; /* use resilient instead of durable handles */
1217 bool use_persistent:1; /* use persistent instead of durable handles */
1218 bool no_lease:1; /* Do not request leases on files or directories */
1219 bool use_witness:1; /* use witness protocol */
1220 __le32 capabilities;
1222 __u32 maximal_access;
1223 __u32 vol_serial_number;
1224 __le64 vol_create_time;
1225 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1226 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
1227 __u32 ss_flags; /* sector size flags */
1228 __u32 perf_sector_size; /* best sector size for perf */
1230 __u32 max_bytes_chunk;
1231 __u32 max_bytes_copy;
1232 #ifdef CONFIG_CIFS_FSCACHE
1233 u64 resource_id; /* server resource id */
1234 struct fscache_volume *fscache; /* cookie for share */
1236 struct list_head pending_opens; /* list of incomplete opens */
1237 struct cached_fids *cfids;
1238 /* BB add field for back pointer to sb struct(s)? */
1239 #ifdef CONFIG_CIFS_DFS_UPCALL
1240 struct list_head ulist; /* cache update list */
1242 struct delayed_work query_interfaces; /* query interfaces workqueue job */
1246 * This is a refcounted and timestamped container for a tcon pointer. The
1247 * container holds a tcon reference. It is considered safe to free one of
1248 * these when the tl_count goes to 0. The tl_time is the time of the last
1249 * "get" on the container.
1252 struct rb_node tl_rbnode;
1254 unsigned long tl_flags;
1255 #define TCON_LINK_MASTER 0
1256 #define TCON_LINK_PENDING 1
1257 #define TCON_LINK_IN_TREE 2
1258 unsigned long tl_time;
1260 struct cifs_tcon *tl_tcon;
1263 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1264 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1266 static inline struct cifs_tcon *
1267 tlink_tcon(struct tcon_link *tlink)
1269 return tlink->tl_tcon;
1272 static inline struct tcon_link *
1273 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1275 return cifs_sb->master_tlink;
1278 extern void cifs_put_tlink(struct tcon_link *tlink);
1280 static inline struct tcon_link *
1281 cifs_get_tlink(struct tcon_link *tlink)
1283 if (tlink && !IS_ERR(tlink))
1284 atomic_inc(&tlink->tl_count);
1288 /* This function is always expected to succeed */
1289 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1291 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1293 struct cifs_pending_open {
1294 struct list_head olist;
1295 struct tcon_link *tlink;
1300 struct cifs_deferred_close {
1301 struct list_head dlist;
1302 struct tcon_link *tlink;
1304 __u64 persistent_fid;
1309 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1310 * This is used to track byte stream locks on the file
1312 struct cifsLockInfo {
1313 struct list_head llist; /* pointer to next cifsLockInfo */
1314 struct list_head blist; /* pointer to locks blocked on this */
1315 wait_queue_head_t block_q;
1324 * One of these for each open instance of a file
1326 struct cifs_search_info {
1327 loff_t index_of_last_entry;
1328 __u16 entries_in_buffer;
1331 char *ntwrk_buf_start;
1332 char *srch_entries_start;
1334 const char *presume_name;
1335 unsigned int resume_name_len;
1339 bool smallBuf:1; /* so we know which buf_release function to call */
1342 #define ACL_NO_MODE ((umode_t)(-1))
1343 struct cifs_open_parms {
1344 struct cifs_tcon *tcon;
1345 struct cifs_sb_info *cifs_sb;
1350 struct cifs_fid *fid;
1357 __u64 persistent_fid; /* persist file id for smb2 */
1358 __u64 volatile_fid; /* volatile file id for smb2 */
1359 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1360 __u8 create_guid[16];
1362 struct cifs_pending_open *pending_open;
1364 #ifdef CONFIG_CIFS_DEBUG2
1366 #endif /* CIFS_DEBUG2 */
1370 struct cifs_fid_locks {
1371 struct list_head llist;
1372 struct cifsFileInfo *cfile; /* fid that owns locks */
1373 struct list_head locks; /* locks held by fid above */
1376 struct cifsFileInfo {
1377 /* following two lists are protected by tcon->open_file_lock */
1378 struct list_head tlist; /* pointer to next fid owned by tcon */
1379 struct list_head flist; /* next fid (file instance) for this inode */
1380 /* lock list below protected by cifsi->lock_sem */
1381 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1382 kuid_t uid; /* allows finding which FileInfo structure */
1383 __u32 pid; /* process id who opened file */
1384 struct cifs_fid fid; /* file id from remote */
1385 struct list_head rlist; /* reconnect list */
1386 /* BB add lock scope info here if needed */ ;
1387 /* lock scope id (0 if none) */
1388 struct dentry *dentry;
1389 struct tcon_link *tlink;
1390 unsigned int f_flags;
1391 bool invalidHandle:1; /* file closed via session abend */
1393 bool oplock_break_cancelled:1;
1394 unsigned int oplock_epoch; /* epoch from the lease break */
1395 __u32 oplock_level; /* oplock/lease level from the lease break */
1397 spinlock_t file_info_lock; /* protects four flag/count fields above */
1398 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1399 struct cifs_search_info srch_inf;
1400 struct work_struct oplock_break; /* work for oplock breaks */
1401 struct work_struct put; /* work for the final part of _put */
1402 struct delayed_work deferred;
1403 bool deferred_close_scheduled; /* Flag to indicate close is scheduled */
1404 char *symlink_target;
1407 struct cifs_io_parms {
1409 __u64 persistent_fid; /* persist file id for smb2 */
1410 __u64 volatile_fid; /* volatile file id for smb2 */
1413 unsigned int length;
1414 struct cifs_tcon *tcon;
1415 struct TCP_Server_Info *server;
1418 struct cifs_aio_ctx {
1419 struct kref refcount;
1420 struct list_head list;
1421 struct mutex aio_mutex;
1422 struct completion done;
1423 struct iov_iter iter;
1425 struct cifsFileInfo *cfile;
1428 unsigned int npages;
1431 unsigned int total_len;
1434 * Indicates if this aio_ctx is for direct_io,
1435 * If yes, iter is a copy of the user passed iov_iter
1440 /* asynchronous read support */
1441 struct cifs_readdata {
1442 struct kref refcount;
1443 struct list_head list;
1444 struct completion done;
1445 struct cifsFileInfo *cfile;
1446 struct address_space *mapping;
1447 struct cifs_aio_ctx *ctx;
1450 unsigned int got_bytes;
1453 struct work_struct work;
1454 int (*read_into_pages)(struct TCP_Server_Info *server,
1455 struct cifs_readdata *rdata,
1457 int (*copy_into_pages)(struct TCP_Server_Info *server,
1458 struct cifs_readdata *rdata,
1459 struct iov_iter *iter);
1461 struct TCP_Server_Info *server;
1462 #ifdef CONFIG_CIFS_SMB_DIRECT
1465 unsigned int pagesz;
1466 unsigned int page_offset;
1467 unsigned int tailsz;
1468 struct cifs_credits credits;
1469 unsigned int nr_pages;
1470 struct page **pages;
1473 /* asynchronous write support */
1474 struct cifs_writedata {
1475 struct kref refcount;
1476 struct list_head list;
1477 struct completion done;
1478 enum writeback_sync_modes sync_mode;
1479 struct work_struct work;
1480 struct cifsFileInfo *cfile;
1481 struct cifs_aio_ctx *ctx;
1486 struct TCP_Server_Info *server;
1487 #ifdef CONFIG_CIFS_SMB_DIRECT
1490 unsigned int pagesz;
1491 unsigned int page_offset;
1492 unsigned int tailsz;
1493 struct cifs_credits credits;
1494 unsigned int nr_pages;
1495 struct page **pages;
1499 * Take a reference on the file private data. Must be called with
1500 * cfile->file_info_lock held.
1503 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1508 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1509 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1511 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1513 #define CIFS_CACHE_READ_FLG 1
1514 #define CIFS_CACHE_HANDLE_FLG 2
1515 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1516 #define CIFS_CACHE_WRITE_FLG 4
1517 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1518 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1520 #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))
1521 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1522 #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))
1525 * One of these for each file inode
1528 struct cifsInodeInfo {
1529 struct netfs_inode netfs; /* Netfslib context and vfs inode */
1530 bool can_cache_brlcks;
1531 struct list_head llist; /* locks helb by this inode */
1533 * NOTE: Some code paths call down_read(lock_sem) twice, so
1534 * we must always use cifs_down_write() instead of down_write()
1535 * for this semaphore to avoid deadlocks.
1537 struct rw_semaphore lock_sem; /* protect the fields above */
1538 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1539 struct list_head openFileList;
1540 spinlock_t open_file_lock; /* protects openFileList */
1541 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1542 unsigned int oplock; /* oplock/lease level we have */
1543 unsigned int epoch; /* used to track lease state changes */
1544 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1545 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1546 #define CIFS_INODE_FLAG_UNUSED (2) /* Unused flag */
1547 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1548 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1549 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1550 #define CIFS_INO_MODIFIED_ATTR (6) /* Indicate change in mtime/ctime */
1551 #define CIFS_INO_CLOSE_ON_LOCK (7) /* Not to defer the close when lock is set */
1552 unsigned long flags;
1553 spinlock_t writers_lock;
1554 unsigned int writers; /* Number of writers on this inode */
1555 unsigned long time; /* jiffies of last update of inode */
1556 u64 server_eof; /* current file size on server -- protected by i_lock */
1557 u64 uniqueid; /* server inode number */
1558 u64 createtime; /* creation time on server */
1559 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1560 struct list_head deferred_closes; /* list of deferred closes */
1561 spinlock_t deferred_lock; /* protection on deferred list */
1562 bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */
1563 char *symlink_target;
1566 static inline struct cifsInodeInfo *
1567 CIFS_I(struct inode *inode)
1569 return container_of(inode, struct cifsInodeInfo, netfs.inode);
1572 static inline struct cifs_sb_info *
1573 CIFS_SB(struct super_block *sb)
1575 return sb->s_fs_info;
1578 static inline struct cifs_sb_info *
1579 CIFS_FILE_SB(struct file *file)
1581 return CIFS_SB(file_inode(file)->i_sb);
1584 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1586 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1593 convert_delimiter(char *path, char delim)
1595 char old_delim, *pos;
1603 while ((pos = strchr(pos, old_delim)))
1607 #define cifs_stats_inc atomic_inc
1609 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1613 spin_lock(&tcon->stat_lock);
1614 tcon->bytes_written += bytes;
1615 spin_unlock(&tcon->stat_lock);
1619 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1622 spin_lock(&tcon->stat_lock);
1623 tcon->bytes_read += bytes;
1624 spin_unlock(&tcon->stat_lock);
1629 * This is the prototype for the mid receive function. This function is for
1630 * receiving the rest of the SMB frame, starting with the WordCount (which is
1631 * just after the MID in struct smb_hdr). Note:
1633 * - This will be called by cifsd, with no locks held.
1634 * - The mid will still be on the pending_mid_q.
1635 * - mid->resp_buf will point to the current buffer.
1637 * Returns zero on a successful receive, or an error. The receive state in
1638 * the TCP_Server_Info will also be updated.
1640 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1641 struct mid_q_entry *mid);
1644 * This is the prototype for the mid callback function. This is called once the
1645 * mid has been received off of the socket. When creating one, take special
1646 * care to avoid deadlocks. Things to bear in mind:
1648 * - it will be called by cifsd, with no locks held
1649 * - the mid will be removed from any lists
1651 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1654 * This is the protopyte for mid handle function. This is called once the mid
1655 * has been recognized after decryption of the message.
1657 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1658 struct mid_q_entry *mid);
1660 /* one of these for every pending CIFS request to the server */
1661 struct mid_q_entry {
1662 struct list_head qhead; /* mids waiting on reply from this server */
1663 struct kref refcount;
1664 struct TCP_Server_Info *server; /* server corresponding to this mid */
1665 __u64 mid; /* multiplex id */
1666 __u16 credits; /* number of credits consumed by this mid */
1667 __u16 credits_received; /* number of credits from the response */
1668 __u32 pid; /* process id */
1669 __u32 sequence_number; /* for CIFS signing */
1670 unsigned long when_alloc; /* when mid was created */
1671 #ifdef CONFIG_CIFS_STATS2
1672 unsigned long when_sent; /* time when smb send finished */
1673 unsigned long when_received; /* when demux complete (taken off wire) */
1675 mid_receive_t *receive; /* call receive callback */
1676 mid_callback_t *callback; /* call completion callback */
1677 mid_handle_t *handle; /* call handle mid callback */
1678 void *callback_data; /* general purpose pointer for callback */
1679 struct task_struct *creator;
1680 void *resp_buf; /* pointer to received SMB header */
1681 unsigned int resp_buf_size;
1682 int mid_state; /* wish this were enum but can not pass to wait_event */
1683 unsigned int mid_flags;
1684 __le16 command; /* smb command code */
1685 unsigned int optype; /* operation type */
1686 bool large_buf:1; /* if valid response, is pointer to large buf */
1687 bool multiRsp:1; /* multiple trans2 responses for one request */
1688 bool multiEnd:1; /* both received */
1689 bool decrypted:1; /* decrypted entry */
1692 struct close_cancelled_open {
1693 struct cifs_fid fid;
1694 struct cifs_tcon *tcon;
1695 struct work_struct work;
1700 /* Make code in transport.c a little cleaner by moving
1701 update of optional stats into function below */
1702 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1704 atomic_inc(&server->in_send);
1707 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1709 atomic_dec(&server->in_send);
1712 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1714 atomic_inc(&server->num_waiters);
1717 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1719 atomic_dec(&server->num_waiters);
1722 #ifdef CONFIG_CIFS_STATS2
1723 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1725 mid->when_sent = jiffies;
1728 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1733 /* for pending dnotify requests */
1734 struct dir_notify_req {
1735 struct list_head lhead;
1742 __u32 filter; /* CompletionFilter (for multishot) */
1747 struct dfs_info3_param {
1748 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1758 struct list_head list;
1759 struct cifsFileInfo *cfile;
1762 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1765 kfree(param->path_name);
1766 kfree(param->node_name);
1770 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1771 int number_of_items)
1774 if ((number_of_items == 0) || (param == NULL))
1776 for (i = 0; i < number_of_items; i++) {
1777 kfree(param[i].path_name);
1778 kfree(param[i].node_name);
1783 static inline bool is_interrupt_error(int error)
1788 case -ERESTARTNOHAND:
1789 case -ERESTARTNOINTR:
1795 static inline bool is_retryable_error(int error)
1797 if (is_interrupt_error(error) || error == -EAGAIN)
1803 /* cifs_get_writable_file() flags */
1804 #define FIND_WR_ANY 0
1805 #define FIND_WR_FSUID_ONLY 1
1806 #define FIND_WR_WITH_DELETE 2
1809 #define MID_REQUEST_ALLOCATED 1
1810 #define MID_REQUEST_SUBMITTED 2
1811 #define MID_RESPONSE_RECEIVED 4
1812 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1813 #define MID_RESPONSE_MALFORMED 0x10
1814 #define MID_SHUTDOWN 0x20
1817 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1818 #define MID_DELETED 2 /* Mid has been dequeued/deleted */
1820 /* Types of response buffer returned from SendReceive2 */
1821 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1822 #define CIFS_SMALL_BUFFER 1
1823 #define CIFS_LARGE_BUFFER 2
1824 #define CIFS_IOVEC 4 /* array of response buffers */
1826 /* Type of Request to SendReceive2 */
1827 #define CIFS_BLOCKING_OP 1 /* operation can block */
1828 #define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */
1829 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1830 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1831 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1832 #define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */
1834 /* Type of request operation */
1835 #define CIFS_ECHO_OP 0x080 /* echo request */
1836 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1837 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1838 #define CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */
1839 /* Lower bitmask values are reserved by others below. */
1840 #define CIFS_SESS_OP 0x2000 /* session setup request */
1841 #define CIFS_OP_MASK 0x2780 /* mask request type */
1843 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1844 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1845 #define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */
1847 /* Security Flags: indicate type of session setup needed */
1848 #define CIFSSEC_MAY_SIGN 0x00001
1849 #define CIFSSEC_MAY_NTLMV2 0x00004
1850 #define CIFSSEC_MAY_KRB5 0x00008
1851 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1852 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1854 #define CIFSSEC_MUST_SIGN 0x01001
1855 /* note that only one of the following can be set so the
1856 result of setting MUST flags more than once will be to
1857 require use of the stronger protocol */
1858 #define CIFSSEC_MUST_NTLMV2 0x04004
1859 #define CIFSSEC_MUST_KRB5 0x08008
1860 #ifdef CONFIG_CIFS_UPCALL
1861 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1863 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1865 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1866 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1868 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1869 #define CIFSSEC_MAX (CIFSSEC_MUST_NTLMV2)
1870 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1872 *****************************************************************
1873 * All constants go here
1874 *****************************************************************
1877 #define UID_HASH (16)
1880 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1881 * following to be declared.
1884 /****************************************************************************
1885 * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according
1886 * to the locking order. i.e. if two locks are to be held together, the lock that
1887 * appears higher in this list needs to be taken before the other.
1889 * If you hold a lock that is lower in this list, and you need to take a higher lock
1890 * (or if you think that one of the functions that you're calling may need to), first
1891 * drop the lock you hold, pick up the higher lock, then the lower one. This will
1892 * ensure that locks are picked up only in one direction in the below table
1895 * Also, if you expect a function to be called with a lock held, explicitly document
1896 * this in the comments on top of your function definition.
1898 * And also, try to keep the critical sections (lock hold time) to be as minimal as
1899 * possible. Blocking / calling other functions with a lock held always increase
1900 * the risk of a possible deadlock.
1902 * Following this rule will avoid unnecessary deadlocks, which can get really hard to
1903 * debug. Also, any new lock that you introduce, please add to this list in the correct
1906 * Please populate this list whenever you introduce new locks in your changes. Or in
1907 * case I've missed some existing locks. Please ensure that it's added in the list
1908 * based on the locking order expected.
1910 * =====================================================================================
1911 * Lock Protects Initialization fn
1912 * =====================================================================================
1914 * vol_info->ctx_lock vol_info->ctx
1915 * cifs_sb_info->tlink_tree_lock cifs_sb_info->tlink_tree cifs_setup_cifs_sb
1916 * TCP_Server_Info-> TCP_Server_Info cifs_get_tcp_session
1918 * TCP_Server_Info->srv_mutex TCP_Server_Info cifs_get_tcp_session
1919 * cifs_ses->session_mutex cifs_ses sesInfoAlloc
1921 * cifs_tcon->open_file_lock cifs_tcon->openFileList tconInfoAlloc
1922 * cifs_tcon->pending_opens
1923 * cifs_tcon->stat_lock cifs_tcon->bytes_read tconInfoAlloc
1924 * cifs_tcon->bytes_written
1925 * cifs_tcp_ses_lock cifs_tcp_ses_list sesInfoAlloc
1926 * GlobalMid_Lock GlobalMaxActiveXid init_cifs
1928 * GlobalTotalActiveXid
1929 * TCP_Server_Info->srv_lock (anything in struct not protected by another lock and can change)
1930 * TCP_Server_Info->mid_lock TCP_Server_Info->pending_mid_q cifs_get_tcp_session
1932 * (any changes in mid_q_entry fields)
1933 * TCP_Server_Info->req_lock TCP_Server_Info->in_flight cifs_get_tcp_session
1937 * ->reconnect_instance
1938 * cifs_ses->ses_lock (anything that is not protected by another lock and can change)
1939 * cifs_ses->iface_lock cifs_ses->iface_list sesInfoAlloc
1941 * ->iface_last_update
1942 * cifs_ses->chan_lock cifs_ses->chans
1943 * ->chans_need_reconnect
1944 * ->chans_in_reconnect
1945 * cifs_tcon->tc_lock (anything that is not protected by another lock and can change)
1946 * cifsInodeInfo->open_file_lock cifsInodeInfo->openFileList cifs_alloc_inode
1947 * cifsInodeInfo->writers_lock cifsInodeInfo->writers cifsInodeInfo_alloc
1948 * cifsInodeInfo->lock_sem cifsInodeInfo->llist cifs_init_once
1949 * ->can_cache_brlcks
1950 * cifsInodeInfo->deferred_lock cifsInodeInfo->deferred_closes cifsInodeInfo_alloc
1951 * cached_fid->fid_mutex cifs_tcon->crfid tconInfoAlloc
1952 * cifsFileInfo->fh_mutex cifsFileInfo cifs_new_fileinfo
1953 * cifsFileInfo->file_info_lock cifsFileInfo->count cifs_new_fileinfo
1954 * ->invalidHandle initiate_cifs_search
1955 * ->oplock_break_cancelled
1956 * cifs_aio_ctx->aio_mutex cifs_aio_ctx cifs_aio_ctx_alloc
1957 ****************************************************************************/
1959 #ifdef DECLARE_GLOBALS_HERE
1960 #define GLOBAL_EXTERN
1962 #define GLOBAL_EXTERN extern
1966 * the list of TCP_Server_Info structures, ie each of the sockets
1967 * connecting our client to a distinct server (ip address), is
1968 * chained together by cifs_tcp_ses_list. The list of all our SMB
1969 * sessions (and from that the tree connections) can be found
1970 * by iterating over cifs_tcp_ses_list
1972 extern struct list_head cifs_tcp_ses_list;
1975 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1976 * tcp session, and the list of tcon's per smb session. It also protects
1977 * the reference counters for the server, smb session, and tcon.
1978 * generally the locks should be taken in order tcp_ses_lock before
1979 * tcon->open_file_lock and that before file->file_info_lock since the
1980 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1982 extern spinlock_t cifs_tcp_ses_lock;
1985 * Global transaction id (XID) information
1987 extern unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1988 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1989 extern unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1990 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */
1993 * Global counters, updated atomically
1995 extern atomic_t sesInfoAllocCount;
1996 extern atomic_t tconInfoAllocCount;
1997 extern atomic_t tcpSesNextId;
1998 extern atomic_t tcpSesAllocCount;
1999 extern atomic_t tcpSesReconnectCount;
2000 extern atomic_t tconInfoReconnectCount;
2002 /* Various Debug counters */
2003 extern atomic_t buf_alloc_count; /* current number allocated */
2004 extern atomic_t small_buf_alloc_count;
2005 #ifdef CONFIG_CIFS_STATS2
2006 extern atomic_t total_buf_alloc_count; /* total allocated over all time */
2007 extern atomic_t total_small_buf_alloc_count;
2008 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
2012 extern bool enable_oplocks; /* enable or disable oplocks */
2013 extern bool lookupCacheEnabled;
2014 extern unsigned int global_secflags; /* if on, session setup sent
2015 with more secure ntlmssp2 challenge/resp */
2016 extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
2017 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
2018 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
2019 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */
2020 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
2021 extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
2022 extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
2023 extern unsigned int cifs_min_small; /* min size of small buf pool */
2024 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
2025 extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
2026 extern atomic_t mid_count;
2028 void cifs_oplock_break(struct work_struct *work);
2029 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
2030 void smb2_deferred_work_close(struct work_struct *work);
2032 extern const struct slow_work_ops cifs_oplock_break_ops;
2033 extern struct workqueue_struct *cifsiod_wq;
2034 extern struct workqueue_struct *decrypt_wq;
2035 extern struct workqueue_struct *fileinfo_put_wq;
2036 extern struct workqueue_struct *cifsoplockd_wq;
2037 extern struct workqueue_struct *deferredclose_wq;
2038 extern __u32 cifs_lock_secret;
2040 extern mempool_t *cifs_mid_poolp;
2042 /* Operations for different SMB versions */
2043 #define SMB1_VERSION_STRING "1.0"
2044 #define SMB20_VERSION_STRING "2.0"
2045 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
2046 extern struct smb_version_operations smb1_operations;
2047 extern struct smb_version_values smb1_values;
2048 extern struct smb_version_operations smb20_operations;
2049 extern struct smb_version_values smb20_values;
2050 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
2051 #define SMB21_VERSION_STRING "2.1"
2052 extern struct smb_version_operations smb21_operations;
2053 extern struct smb_version_values smb21_values;
2054 #define SMBDEFAULT_VERSION_STRING "default"
2055 extern struct smb_version_values smbdefault_values;
2056 #define SMB3ANY_VERSION_STRING "3"
2057 extern struct smb_version_values smb3any_values;
2058 #define SMB30_VERSION_STRING "3.0"
2059 extern struct smb_version_operations smb30_operations;
2060 extern struct smb_version_values smb30_values;
2061 #define SMB302_VERSION_STRING "3.02"
2062 #define ALT_SMB302_VERSION_STRING "3.0.2"
2063 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2064 extern struct smb_version_values smb302_values;
2065 #define SMB311_VERSION_STRING "3.1.1"
2066 #define ALT_SMB311_VERSION_STRING "3.11"
2067 extern struct smb_version_operations smb311_operations;
2068 extern struct smb_version_values smb311_values;
2070 static inline char *get_security_type_str(enum securityEnum sectype)
2074 return "RawNTLMSSP";
2084 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2086 return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2089 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2092 * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2093 * Subsystem Notifies That a Share Is a DFS Share.
2095 * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2096 * Application Updates a Share.
2098 if (!tcon || !tcon->ses || !tcon->ses->server)
2100 return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2101 tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2104 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon,
2105 const struct dfs_info3_param *ref)
2108 * Check if all targets are capable of handling DFS referrals as per
2109 * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL.
2111 return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER));
2114 static inline u64 cifs_flock_len(const struct file_lock *fl)
2116 return (u64)fl->fl_end - fl->fl_start + 1;
2119 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses)
2121 if (WARN_ON_ONCE(!ses || !ses->server))
2124 * Make workstation name no more than 15 chars when using insecure dialects as some legacy
2125 * servers do require it during NTLMSSP.
2127 if (ses->server->dialect <= SMB20_PROT_ID)
2128 return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL);
2129 return sizeof(ses->workstation_name);
2132 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src)
2134 memcpy(dst, src, (size_t)((u8 *)&src->AccessFlags - (u8 *)src));
2135 dst->AccessFlags = src->AccessFlags;
2136 dst->CurrentByteOffset = src->CurrentByteOffset;
2137 dst->Mode = src->Mode;
2138 dst->AlignmentRequirement = src->AlignmentRequirement;
2139 dst->FileNameLength = src->FileNameLength;
2142 static inline unsigned int cifs_get_num_sgs(const struct smb_rqst *rqst,
2146 unsigned int len, skip;
2147 unsigned int nents = 0;
2151 /* Assumes the first rqst has a transform header as the first iov.
2153 * rqst[0].rq_iov[0] is transform header
2154 * rqst[0].rq_iov[1+] data to be encrypted/decrypted
2155 * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
2157 for (i = 0; i < num_rqst; i++) {
2159 * The first rqst has a transform header where the
2160 * first 20 bytes are not part of the encrypted blob.
2162 for (j = 0; j < rqst[i].rq_nvec; j++) {
2163 struct kvec *iov = &rqst[i].rq_iov[j];
2165 skip = (i == 0) && (j == 0) ? 20 : 0;
2166 addr = (unsigned long)iov->iov_base + skip;
2167 if (unlikely(is_vmalloc_addr((void *)addr))) {
2168 len = iov->iov_len - skip;
2169 nents += DIV_ROUND_UP(offset_in_page(addr) + len,
2175 nents += rqst[i].rq_npages;
2177 nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
2181 /* We can not use the normal sg_set_buf() as we will sometimes pass a
2182 * stack object as buf.
2184 static inline struct scatterlist *cifs_sg_set_buf(struct scatterlist *sg,
2186 unsigned int buflen)
2188 unsigned long addr = (unsigned long)buf;
2189 unsigned int off = offset_in_page(addr);
2192 if (unlikely(is_vmalloc_addr((void *)addr))) {
2194 unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
2196 sg_set_page(sg++, vmalloc_to_page((void *)addr), len, off);
2203 sg_set_page(sg++, virt_to_page(addr), buflen, off);
2208 #endif /* _CIFS_GLOB_H */