4 * Copyright (C) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org)
8 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as published
10 * by the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
16 * the GNU Lesser General Public License for more details.
23 #include <linux/in6.h>
24 #include <linux/slab.h>
25 #include <linux/mempool.h>
26 #include <linux/workqueue.h>
27 #include "cifs_fs_sb.h"
29 #include <crypto/internal/hash.h>
30 #include <linux/scatterlist.h>
31 #include <uapi/linux/cifs/cifs_mount.h>
34 #define CIFS_MAGIC_NUMBER 0xFF534D42 /* the first four bytes of SMB PDUs */
36 #define SMB_PATH_MAX 260
38 #define RFC1001_PORT 139
41 * The sizes of various internal tables and strings
43 #define MAX_UID_INFO 16
44 #define MAX_SES_INFO 2
45 #define MAX_TCON_INFO 4
47 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
49 #define CIFS_MIN_RCV_POOL 4
51 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
53 * default attribute cache timeout (jiffies)
55 #define CIFS_DEF_ACTIMEO (1 * HZ)
58 * max attribute cache timeout (jiffies) - 2^30
60 #define CIFS_MAX_ACTIMEO (1 << 30)
63 * Max persistent and resilient handle timeout (milliseconds).
64 * Windows durable max was 960000 (16 minutes)
66 #define SMB3_MAX_HANDLE_TIMEOUT 960000
69 * MAX_REQ is the maximum number of requests that WE will send
70 * on one socket concurrently.
72 #define CIFS_MAX_REQ 32767
74 #define RFC1001_NAME_LEN 15
75 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
77 /* maximum length of ip addr as a string (including ipv6 and sctp) */
78 #define SERVER_NAME_LENGTH 80
79 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
81 /* echo interval in seconds */
82 #define SMB_ECHO_INTERVAL_MIN 1
83 #define SMB_ECHO_INTERVAL_MAX 600
84 #define SMB_ECHO_INTERVAL_DEFAULT 60
86 /* maximum number of PDUs in one compound */
87 #define MAX_COMPOUND 5
90 * Default number of credits to keep available for SMB3.
91 * This value is chosen somewhat arbitrarily. The Windows client
92 * defaults to 128 credits, the Windows server allows clients up to
93 * 512 credits (or 8K for later versions), and the NetApp server
94 * does not limit clients at all. Choose a high enough default value
95 * such that the client shouldn't limit performance, but allow mount
96 * to override (until you approach 64K, where we limit credits to 65000
97 * to reduce possibility of seeing more server credit overflow bugs.
99 #define SMB2_MAX_CREDITS_AVAILABLE 32000
103 #ifndef XATTR_DOS_ATTRIB
104 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
108 * CIFS vfs client Status information (based on what we know.)
111 /* associated with each tcp and smb session */
121 Unspecified = 0, /* not specified */
122 LANMAN, /* Legacy LANMAN auth */
123 NTLM, /* Legacy NTLM012 auth with NTLM hash */
124 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
125 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
126 Kerberos, /* Kerberos via SPNEGO */
134 /* crypto security descriptor definition */
136 struct shash_desc shash;
140 /* crypto hashing related structure/fields, not specific to a sec mech */
141 struct cifs_secmech {
142 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
143 struct crypto_shash *md5; /* md5 hash function */
144 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
145 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
146 struct crypto_shash *sha512; /* sha512 hash function */
147 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
148 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
149 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
150 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
151 struct sdesc *sdescsha512; /* ctxt to generate smb3.11 signing key */
152 struct crypto_aead *ccmaesencrypt; /* smb3 encryption aead */
153 struct crypto_aead *ccmaesdecrypt; /* smb3 decryption aead */
156 /* per smb session structure/fields */
157 struct ntlmssp_auth {
158 bool sesskey_per_smbsess; /* whether session key is per smb session */
159 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
160 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
161 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
162 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
170 struct cifs_sid osid;
171 struct cifs_sid gsid;
172 struct cifs_ntace *ntaces;
173 struct cifs_ace *aces;
177 *****************************************************************
178 * Except the CIFS PDUs themselves all the
179 * globally interesting structs should go here
180 *****************************************************************
184 * A smb_rqst represents a complete request to be issued to a server. It's
185 * formed by a kvec array, followed by an array of pages. Page data is assumed
186 * to start at the beginning of the first page.
189 struct kvec *rq_iov; /* array of kvecs */
190 unsigned int rq_nvec; /* number of kvecs in array */
191 struct page **rq_pages; /* pointer to array of page ptrs */
192 unsigned int rq_offset; /* the offset to the 1st page */
193 unsigned int rq_npages; /* number pages in array */
194 unsigned int rq_pagesz; /* page size to use */
195 unsigned int rq_tailsz; /* length of last page */
211 struct TCP_Server_Info;
215 struct dfs_info3_param;
219 struct cifs_readdata;
220 struct cifs_writedata;
221 struct cifs_io_parms;
222 struct cifs_search_info;
223 struct cifsInodeInfo;
224 struct cifs_open_parms;
227 struct smb_version_operations {
228 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
229 struct mid_q_entry *);
230 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
231 /* setup request: allocate mid, sign message */
232 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
234 /* setup async request: allocate mid, sign message */
235 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
237 /* check response: verify signature, map error */
238 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
240 void (*add_credits)(struct TCP_Server_Info *server,
241 const struct cifs_credits *credits,
243 void (*set_credits)(struct TCP_Server_Info *, const int);
244 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
245 unsigned int (*get_credits)(struct mid_q_entry *);
246 __u64 (*get_next_mid)(struct TCP_Server_Info *);
247 void (*revert_current_mid)(struct TCP_Server_Info *server,
248 const unsigned int val);
249 /* data offset from read response message */
250 unsigned int (*read_data_offset)(char *);
252 * Data length from read response message
253 * When in_remaining is true, the returned data length is in
254 * message field DataRemaining for out-of-band data read (e.g through
255 * Memory Registration RDMA write in SMBD).
256 * Otherwise, the returned data length is in message field DataLength.
258 unsigned int (*read_data_length)(char *, bool in_remaining);
259 /* map smb to linux error */
260 int (*map_error)(char *, bool);
261 /* find mid corresponding to the response message */
262 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
263 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
264 void (*clear_stats)(struct cifs_tcon *);
265 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
266 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
267 /* verify the message */
268 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
269 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
270 int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
271 void (*downgrade_oplock)(struct TCP_Server_Info *,
272 struct cifsInodeInfo *, bool);
273 /* process transaction2 response */
274 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
276 /* check if we need to negotiate */
277 bool (*need_neg)(struct TCP_Server_Info *);
278 /* negotiate to the server */
279 int (*negotiate)(const unsigned int, struct cifs_ses *);
280 /* set negotiated write size */
281 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
282 /* set negotiated read size */
283 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
284 /* setup smb sessionn */
285 int (*sess_setup)(const unsigned int, struct cifs_ses *,
286 const struct nls_table *);
287 /* close smb session */
288 int (*logoff)(const unsigned int, struct cifs_ses *);
289 /* connect to a server share */
290 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
291 struct cifs_tcon *, const struct nls_table *);
292 /* close tree connecion */
293 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
294 /* get DFS referrals */
295 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
296 const char *, struct dfs_info3_param **,
297 unsigned int *, const struct nls_table *, int);
298 /* informational QFS call */
299 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
300 /* check if a path is accessible or not */
301 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
302 struct cifs_sb_info *, const char *);
303 /* query path data from the server */
304 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
305 struct cifs_sb_info *, const char *,
306 FILE_ALL_INFO *, bool *, bool *);
307 /* query file data from the server */
308 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
309 struct cifs_fid *, FILE_ALL_INFO *);
310 /* get server index number */
311 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
312 struct cifs_sb_info *, const char *,
313 u64 *uniqueid, FILE_ALL_INFO *);
314 /* set size by path */
315 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
316 const char *, __u64, struct cifs_sb_info *, bool);
317 /* set size by file handle */
318 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
319 struct cifsFileInfo *, __u64, bool);
321 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
323 int (*set_compression)(const unsigned int, struct cifs_tcon *,
324 struct cifsFileInfo *);
325 /* check if we can send an echo or nor */
326 bool (*can_echo)(struct TCP_Server_Info *);
327 /* send echo request */
328 int (*echo)(struct TCP_Server_Info *);
329 /* create directory */
330 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
331 umode_t mode, struct cifs_tcon *tcon,
332 const char *full_path,
333 struct cifs_sb_info *cifs_sb);
334 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
335 struct cifs_sb_info *);
336 /* set info on created directory */
337 void (*mkdir_setinfo)(struct inode *, const char *,
338 struct cifs_sb_info *, struct cifs_tcon *,
340 /* remove directory */
341 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
342 struct cifs_sb_info *);
344 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
345 struct cifs_sb_info *);
346 /* open, rename and delete file */
347 int (*rename_pending_delete)(const char *, struct dentry *,
349 /* send rename request */
350 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
351 const char *, struct cifs_sb_info *);
352 /* send create hardlink request */
353 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
354 const char *, const char *,
355 struct cifs_sb_info *);
356 /* query symlink target */
357 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
358 struct cifs_sb_info *, const char *,
360 /* open a file for non-posix mounts */
361 int (*open)(const unsigned int, struct cifs_open_parms *,
362 __u32 *, FILE_ALL_INFO *);
363 /* set fid protocol-specific info */
364 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
366 void (*close)(const unsigned int, struct cifs_tcon *,
368 /* send a flush request to the server */
369 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
370 /* async read from the server */
371 int (*async_readv)(struct cifs_readdata *);
372 /* async write to the server */
373 int (*async_writev)(struct cifs_writedata *,
374 void (*release)(struct kref *));
375 /* sync read from the server */
376 int (*sync_read)(const unsigned int, struct cifs_fid *,
377 struct cifs_io_parms *, unsigned int *, char **,
379 /* sync write to the server */
380 int (*sync_write)(const unsigned int, struct cifs_fid *,
381 struct cifs_io_parms *, unsigned int *, struct kvec *,
383 /* open dir, start readdir */
384 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
385 const char *, struct cifs_sb_info *,
386 struct cifs_fid *, __u16,
387 struct cifs_search_info *);
388 /* continue readdir */
389 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
391 __u16, struct cifs_search_info *srch_inf);
393 int (*close_dir)(const unsigned int, struct cifs_tcon *,
395 /* calculate a size of SMB message */
396 unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi);
397 /* check for STATUS_PENDING and process the response if yes */
398 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
399 /* check for STATUS_NETWORK_SESSION_EXPIRED */
400 bool (*is_session_expired)(char *);
401 /* send oplock break response */
402 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
403 struct cifsInodeInfo *);
404 /* query remote filesystem */
405 int (*queryfs)(const unsigned int, struct cifs_tcon *,
407 /* send mandatory brlock to the server */
408 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
409 __u64, __u32, int, int, bool);
410 /* unlock range of mandatory locks */
411 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
413 /* push brlocks from the cache to the server */
414 int (*push_mand_locks)(struct cifsFileInfo *);
415 /* get lease key of the inode */
416 void (*get_lease_key)(struct inode *, struct cifs_fid *);
417 /* set lease key of the inode */
418 void (*set_lease_key)(struct inode *, struct cifs_fid *);
419 /* generate new lease key */
420 void (*new_lease_key)(struct cifs_fid *);
421 int (*generate_signingkey)(struct cifs_ses *);
422 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
423 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
424 struct cifsFileInfo *src_file);
425 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
426 struct cifsFileInfo *src_file, void __user *);
427 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
428 struct cifs_sb_info *, const unsigned char *,
429 char *, unsigned int *);
430 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
431 struct cifs_sb_info *, const unsigned char *,
432 char *, unsigned int *);
433 /* if we can do cache read operations */
434 bool (*is_read_op)(__u32);
435 /* set oplock level for the inode */
436 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
438 /* create lease context buffer for CREATE request */
439 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
440 /* parse lease context buffer and return oplock/epoch info */
441 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
442 ssize_t (*copychunk_range)(const unsigned int,
443 struct cifsFileInfo *src_file,
444 struct cifsFileInfo *target_file,
445 u64 src_off, u64 len, u64 dest_off);
446 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
447 struct cifsFileInfo *target_file, u64 src_off, u64 len,
449 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
450 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
451 const unsigned char *, const unsigned char *, char *,
452 size_t, struct cifs_sb_info *);
453 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
454 const char *, const void *, const __u16,
455 const struct nls_table *, struct cifs_sb_info *);
456 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
457 const char *, u32 *);
458 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
459 const struct cifs_fid *, u32 *);
460 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
462 /* writepages retry size */
463 unsigned int (*wp_retry_size)(struct inode *);
464 /* get mtu credits */
465 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
466 unsigned int *, struct cifs_credits *);
467 /* adjust previously taken mtu credits to request size */
468 int (*adjust_credits)(struct TCP_Server_Info *server,
469 struct cifs_credits *credits,
470 const unsigned int payload_size);
471 /* check if we need to issue closedir */
472 bool (*dir_needs_close)(struct cifsFileInfo *);
473 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
475 /* init transform request - used for encryption for now */
476 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
477 struct smb_rqst *, struct smb_rqst *);
478 int (*is_transform_hdr)(void *buf);
479 int (*receive_transform)(struct TCP_Server_Info *,
480 struct mid_q_entry **, char **, int *);
481 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
483 int (*next_header)(char *);
484 /* ioctl passthrough for query_info */
485 int (*ioctl_query_info)(const unsigned int xid,
486 struct cifs_tcon *tcon,
487 __le16 *path, int is_dir,
489 /* make unix special files (block, char, fifo, socket) */
490 int (*make_node)(unsigned int xid,
492 struct dentry *dentry,
493 struct cifs_tcon *tcon,
496 dev_t device_number);
497 /* version specific fiemap implementation */
498 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
499 struct fiemap_extent_info *, u64, u64);
500 /* version specific llseek implementation */
501 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
504 struct smb_version_values {
505 char *version_string;
507 __u32 req_capabilities;
508 __u32 large_lock_type;
509 __u32 exclusive_lock_type;
510 __u32 shared_lock_type;
511 __u32 unlock_lock_type;
512 size_t header_preamble_size;
514 size_t max_header_size;
515 size_t read_rsp_size;
517 unsigned int cap_unix;
518 unsigned int cap_nt_find;
519 unsigned int cap_large_files;
520 __u16 signing_enabled;
521 __u16 signing_required;
522 size_t create_lease_size;
525 #define HEADER_SIZE(server) (server->vals->header_size)
526 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
533 char *iocharset; /* local code page for mapping to and from Unicode */
534 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
535 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
543 enum securityEnum sectype; /* sectype requested via mnt opts */
544 bool sign; /* was signing requested via mnt opts? */
545 bool ignore_signature:1;
549 bool setuidfromacl:1;
555 bool no_psx_acl:1; /* set if posix acl support should be disabled */
557 bool backupuid_specified; /* mount option backupuid is specified */
558 bool backupgid_specified; /* mount option backupgid is specified */
559 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
560 bool server_ino:1; /* use inode numbers from server ie UniqueId */
562 bool strict_io:1; /* strict cache behavior */
565 bool remap:1; /* set to remap seven reserved chars in filenames */
566 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
567 bool posix_paths:1; /* unset to not ask for posix pathnames. */
571 bool nullauth:1; /* attempt to authenticate with null user */
572 bool nocase:1; /* request case insensitive filenames */
573 bool nobrl:1; /* disable sending byte range locks to srv */
574 bool nohandlecache:1; /* disable caching dir handles if srvr probs */
575 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
576 bool seal:1; /* request transport encryption on share */
577 bool nodfs:1; /* Do not request DFS, even if available */
578 bool local_lease:1; /* check leases only on local system, not remote */
581 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
582 bool no_lease:1; /* disable requesting leases */
583 bool fsc:1; /* enable fscache */
584 bool mfsymlinks:1; /* use Minshall+French Symlinks */
586 bool rwpidforward:1; /* pid forward for read/write operations */
590 bool resilient:1; /* noresilient not required since not fored for CA */
596 unsigned int min_offload;
597 bool sockopt_tcp_nodelay:1;
598 unsigned long actimeo; /* attribute cache timeout (jiffies) */
599 struct smb_version_operations *ops;
600 struct smb_version_values *vals;
602 struct sockaddr_storage dstaddr; /* destination address */
603 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
604 struct nls_table *local_nls;
605 unsigned int echo_interval; /* echo interval in secs */
606 __u64 snapshot_time; /* needed for timewarp tokens */
607 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
608 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
609 __u16 compression; /* compression algorithm 0xFFFF default 0=disabled */
610 bool rootfs:1; /* if it's a SMB root file system */
614 * CIFS superblock mount flags (mnt_cifs_flags) to consider when
615 * trying to reuse existing superblock for a new mount
617 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
618 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
619 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
620 CIFS_MOUNT_MAP_SFM_CHR | \
621 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
622 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
623 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
624 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
625 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
626 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
627 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
628 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
629 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
630 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
633 * Generic VFS superblock mount flags (s_flags) to consider when
634 * trying to reuse existing superblock for a new mount
636 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
637 SB_NODEV | SB_SYNCHRONOUS)
639 struct cifs_mnt_data {
640 struct cifs_sb_info *cifs_sb;
645 static inline unsigned int
646 get_rfc1002_length(void *buf)
648 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
652 inc_rfc1001_len(void *buf, int count)
654 be32_add_cpu((__be32 *)buf, count);
657 struct TCP_Server_Info {
658 struct list_head tcp_ses_list;
659 struct list_head smb_ses_list;
660 int srv_count; /* reference counter */
661 /* 15 character server name + 0x20 16th byte indicating type = srv */
662 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
663 struct smb_version_operations *ops;
664 struct smb_version_values *vals;
665 enum statusEnum tcpStatus; /* what we think the status is */
666 char *hostname; /* hostname portion of UNC string */
667 struct socket *ssocket;
668 struct sockaddr_storage dstaddr;
669 struct sockaddr_storage srcaddr; /* locally bind to this IP */
673 wait_queue_head_t response_q;
674 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
675 struct list_head pending_mid_q;
676 bool noblocksnd; /* use blocking sendmsg */
677 bool noautotune; /* do not autotune send buf sizes */
679 unsigned int credits; /* send no more requests at once */
680 unsigned int max_credits; /* can override large 32000 default at mnt */
681 unsigned int in_flight; /* number of requests on the wire to server */
682 unsigned int max_in_flight; /* max number of requests that were on wire */
683 spinlock_t req_lock; /* protect the two values above */
684 struct mutex srv_mutex;
685 struct task_struct *tsk;
686 char server_GUID[16];
688 bool sign; /* is signing enabled on this connection? */
689 bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
690 bool session_estab; /* mark when very first sess is established */
691 int echo_credits; /* echo reserved slots */
692 int oplock_credits; /* oplock break reserved slots */
693 bool echoes:1; /* enable echoes */
694 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
695 u16 dialect; /* dialect index that server chose */
696 bool oplocks:1; /* enable oplocks */
697 unsigned int maxReq; /* Clients should submit no more */
698 /* than maxReq distinct unanswered SMBs to the server when using */
699 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
700 unsigned int maxBuf; /* maxBuf specifies the maximum */
701 /* message size the server can send or receive for non-raw SMBs */
702 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
703 /* when socket is setup (and during reconnect) before NegProt sent */
704 unsigned int max_rw; /* maxRw specifies the maximum */
705 /* message size the server can send or receive for */
706 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
707 unsigned int capabilities; /* selective disabling of caps by smb sess */
708 int timeAdj; /* Adjust for difference in server time zone in sec */
709 __u64 CurrentMid; /* multiplex id - rotating counter */
710 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
711 /* 16th byte of RFC1001 workstation name is always null */
712 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
713 __u32 sequence_number; /* for signing, protected by srv_mutex */
714 __u32 reconnect_instance; /* incremented on each reconnect */
715 struct session_key session_key;
716 unsigned long lstrp; /* when we got last response from this server */
717 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
718 #define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
719 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
720 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
721 char negflavor; /* NEGOTIATE response flavor */
722 /* extended security flavors that server supports */
723 bool sec_ntlmssp; /* supports NTLMSSP */
724 bool sec_kerberosu2u; /* supports U2U Kerberos */
725 bool sec_kerberos; /* supports plain Kerberos */
726 bool sec_mskerberos; /* supports legacy MS Kerberos */
727 bool large_buf; /* is current buffer large? */
728 /* use SMBD connection instead of socket */
730 /* point to the SMBD connection if RDMA is used instead of socket */
731 struct smbd_connection *smbd_conn;
732 struct delayed_work echo; /* echo ping workqueue job */
733 char *smallbuf; /* pointer to current "small" buffer */
734 char *bigbuf; /* pointer to current "big" buffer */
735 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
736 unsigned int pdu_size;
737 unsigned int total_read; /* total amount of data read in this pass */
738 #ifdef CONFIG_CIFS_FSCACHE
739 struct fscache_cookie *fscache; /* client index cache cookie */
741 #ifdef CONFIG_CIFS_STATS2
742 atomic_t in_send; /* requests trying to send */
743 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
744 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
745 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
746 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
747 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
748 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
750 unsigned int max_read;
751 unsigned int max_write;
752 unsigned int min_offload;
753 __le16 compress_algorithm;
755 /* save initital negprot hash */
756 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
757 bool posix_ext_supported;
758 struct delayed_work reconnect; /* reconnect workqueue job */
759 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
760 unsigned long echo_interval;
763 * Number of targets available for reconnect. The more targets
764 * the more tasks have to wait to let the demultiplex thread
768 bool noblockcnt; /* use non-blocking connect() */
771 struct cifs_credits {
773 unsigned int instance;
776 static inline unsigned int
777 in_flight(struct TCP_Server_Info *server)
780 spin_lock(&server->req_lock);
781 num = server->in_flight;
782 spin_unlock(&server->req_lock);
787 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
790 spin_lock(&server->req_lock);
792 spin_unlock(&server->req_lock);
793 return num >= num_credits;
797 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
800 server->ops->add_credits(server, credits, optype);
804 add_credits_and_wake_if(struct TCP_Server_Info *server,
805 const struct cifs_credits *credits, const int optype)
807 if (credits->value) {
808 server->ops->add_credits(server, credits, optype);
809 wake_up(&server->request_q);
814 set_credits(struct TCP_Server_Info *server, const int val)
816 server->ops->set_credits(server, val);
820 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
821 const unsigned int payload_size)
823 return server->ops->adjust_credits ?
824 server->ops->adjust_credits(server, credits, payload_size) : 0;
828 get_next_mid64(struct TCP_Server_Info *server)
830 return cpu_to_le64(server->ops->get_next_mid(server));
834 get_next_mid(struct TCP_Server_Info *server)
836 __u16 mid = server->ops->get_next_mid(server);
838 * The value in the SMB header should be little endian for easy
839 * on-the-wire decoding.
841 return cpu_to_le16(mid);
845 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
847 if (server->ops->revert_current_mid)
848 server->ops->revert_current_mid(server, val);
852 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
853 const struct smb2_sync_hdr *shdr)
855 unsigned int num = le16_to_cpu(shdr->CreditCharge);
857 return revert_current_mid(server, num > 0 ? num : 1);
861 get_mid(const struct smb_hdr *smb)
863 return le16_to_cpu(smb->Mid);
867 compare_mid(__u16 mid, const struct smb_hdr *smb)
869 return mid == le16_to_cpu(smb->Mid);
873 * When the server supports very large reads and writes via POSIX extensions,
874 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
875 * including the RFC1001 length.
877 * Note that this might make for "interesting" allocation problems during
878 * writeback however as we have to allocate an array of pointers for the
879 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
881 * For reads, there is a similar problem as we need to allocate an array
882 * of kvecs to handle the receive, though that should only need to be done
885 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
886 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
889 * When the server doesn't allow large posix writes, only allow a rsize/wsize
890 * of 2^17-1 minus the size of the call header. That allows for a read or
891 * write up to the maximum size described by RFC1002.
893 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
894 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
897 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
898 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
899 * a single wsize request with a single call.
901 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
902 #define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
905 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
906 * those values when posix extensions aren't in force. In actuality here, we
907 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
908 * to be ok with the extra byte even though Windows doesn't send writes that
913 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
915 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
916 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
919 * Macros to allow the TCP_Server_Info->net field and related code to drop out
920 * when CONFIG_NET_NS isn't set.
925 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
930 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
937 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
942 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
948 struct cifs_server_iface {
950 unsigned int rdma_capable : 1;
951 unsigned int rss_capable : 1;
952 struct sockaddr_storage sockaddr;
956 * Session structure. One of these for each uid session with a particular host
959 struct list_head smb_ses_list;
960 struct list_head tcon_list;
961 struct cifs_tcon *tcon_ipc;
962 struct mutex session_mutex;
963 struct TCP_Server_Info *server; /* pointer to server info */
964 int ses_count; /* reference counter */
965 enum statusEnum status;
966 unsigned overrideSecFlg; /* if non-zero override global sec flags */
967 char *serverOS; /* name of operating system underlying server */
968 char *serverNOS; /* name of network operating system of server */
969 char *serverDomain; /* security realm of server */
970 __u64 Suid; /* remote smb uid */
971 kuid_t linux_uid; /* overriding owner of files on the mount */
972 kuid_t cred_uid; /* owner of credentials */
973 unsigned int capabilities;
974 char serverName[SERVER_NAME_LEN_WITH_NULL];
975 char *user_name; /* must not be null except during init of sess
976 and after mount option parsing we fill it */
979 struct session_key auth_key;
980 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
981 enum securityEnum sectype; /* what security flavor was specified? */
982 bool sign; /* is signing required? */
983 bool need_reconnect:1; /* connection reset, uid now invalid */
986 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
987 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
988 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
989 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
992 * Network interfaces available on the server this session is
995 * Other channels can be opened by connecting and binding this
996 * session to interfaces from this list.
998 * iface_lock should be taken when accessing any of these fields
1000 spinlock_t iface_lock;
1001 struct cifs_server_iface *iface_list;
1003 unsigned long iface_last_update; /* jiffies */
1007 cap_unix(struct cifs_ses *ses)
1009 return ses->server->vals->cap_unix & ses->capabilities;
1013 bool is_valid:1; /* Do we have a useable root fid */
1014 bool file_all_info_is_valid:1;
1016 struct kref refcount;
1017 struct cifs_fid *fid;
1018 struct mutex fid_mutex;
1019 struct cifs_tcon *tcon;
1020 struct work_struct lease_break;
1021 struct smb2_file_all_info file_all_info;
1025 * there is one of these for each connection to a resource on a particular
1029 struct list_head tcon_list;
1031 struct list_head rlist; /* reconnect list */
1032 atomic_t num_local_opens; /* num of all opens including disconnected */
1033 atomic_t num_remote_opens; /* num of all network opens on server */
1034 struct list_head openFileList;
1035 spinlock_t open_file_lock; /* protects list above */
1036 struct cifs_ses *ses; /* pointer to session associated with */
1037 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1038 char *nativeFileSystem;
1039 char *password; /* for share-level security */
1040 __u32 tid; /* The 4 byte tree id */
1041 __u16 Flags; /* optional support bits */
1042 enum statusEnum tidStatus;
1043 atomic_t num_smbs_sent;
1046 atomic_t num_writes;
1048 atomic_t num_flushes;
1049 atomic_t num_oplock_brks;
1051 atomic_t num_closes;
1052 atomic_t num_deletes;
1053 atomic_t num_mkdirs;
1054 atomic_t num_posixopens;
1055 atomic_t num_posixmkdirs;
1056 atomic_t num_rmdirs;
1057 atomic_t num_renames;
1058 atomic_t num_t2renames;
1059 atomic_t num_ffirst;
1061 atomic_t num_fclose;
1062 atomic_t num_hardlinks;
1063 atomic_t num_symlinks;
1065 atomic_t num_acl_get;
1066 atomic_t num_acl_set;
1069 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1070 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1074 __u64 bytes_written;
1075 spinlock_t stat_lock; /* protects the two fields above */
1076 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1077 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1078 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1079 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
1080 bool pipe:1; /* set if connection to pipe share */
1081 bool print:1; /* set if connection to printer share */
1084 bool nohandlecache:1; /* if strange server resource prob can turn off */
1085 bool seal:1; /* transport encryption for this mounted share */
1086 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
1087 for this mount even if server would support */
1088 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1089 bool local_lease:1; /* check leases (only) on local system not remote */
1090 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1091 bool broken_sparse_sup; /* if server or share does not support sparse */
1092 bool need_reconnect:1; /* connection reset, tid now invalid */
1093 bool need_reopen_files:1; /* need to reopen tcon file handles */
1094 bool use_resilient:1; /* use resilient instead of durable handles */
1095 bool use_persistent:1; /* use persistent instead of durable handles */
1096 bool no_lease:1; /* Do not request leases on files or directories */
1097 __le32 capabilities;
1099 __u32 maximal_access;
1100 __u32 vol_serial_number;
1101 __le64 vol_create_time;
1102 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1103 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
1104 __u32 ss_flags; /* sector size flags */
1105 __u32 perf_sector_size; /* best sector size for perf */
1107 __u32 max_bytes_chunk;
1108 __u32 max_bytes_copy;
1109 #ifdef CONFIG_CIFS_FSCACHE
1110 u64 resource_id; /* server resource id */
1111 struct fscache_cookie *fscache; /* cookie for share */
1113 struct list_head pending_opens; /* list of incomplete opens */
1114 struct cached_fid crfid; /* Cached root fid */
1115 /* BB add field for back pointer to sb struct(s)? */
1116 #ifdef CONFIG_CIFS_DFS_UPCALL
1119 struct list_head ulist; /* cache update list */
1124 * This is a refcounted and timestamped container for a tcon pointer. The
1125 * container holds a tcon reference. It is considered safe to free one of
1126 * these when the tl_count goes to 0. The tl_time is the time of the last
1127 * "get" on the container.
1130 struct rb_node tl_rbnode;
1132 unsigned long tl_flags;
1133 #define TCON_LINK_MASTER 0
1134 #define TCON_LINK_PENDING 1
1135 #define TCON_LINK_IN_TREE 2
1136 unsigned long tl_time;
1138 struct cifs_tcon *tl_tcon;
1141 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1142 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1144 static inline struct cifs_tcon *
1145 tlink_tcon(struct tcon_link *tlink)
1147 return tlink->tl_tcon;
1150 static inline struct tcon_link *
1151 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1153 return cifs_sb->master_tlink;
1156 extern void cifs_put_tlink(struct tcon_link *tlink);
1158 static inline struct tcon_link *
1159 cifs_get_tlink(struct tcon_link *tlink)
1161 if (tlink && !IS_ERR(tlink))
1162 atomic_inc(&tlink->tl_count);
1166 /* This function is always expected to succeed */
1167 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1169 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1171 struct cifs_pending_open {
1172 struct list_head olist;
1173 struct tcon_link *tlink;
1179 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1180 * This is used to track byte stream locks on the file
1182 struct cifsLockInfo {
1183 struct list_head llist; /* pointer to next cifsLockInfo */
1184 struct list_head blist; /* pointer to locks blocked on this */
1185 wait_queue_head_t block_q;
1194 * One of these for each open instance of a file
1196 struct cifs_search_info {
1197 loff_t index_of_last_entry;
1198 __u16 entries_in_buffer;
1201 char *ntwrk_buf_start;
1202 char *srch_entries_start;
1204 const char *presume_name;
1205 unsigned int resume_name_len;
1209 bool smallBuf:1; /* so we know which buf_release function to call */
1212 struct cifs_open_parms {
1213 struct cifs_tcon *tcon;
1214 struct cifs_sb_info *cifs_sb;
1219 struct cifs_fid *fid;
1226 __u64 persistent_fid; /* persist file id for smb2 */
1227 __u64 volatile_fid; /* volatile file id for smb2 */
1228 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1229 __u8 create_guid[16];
1230 struct cifs_pending_open *pending_open;
1232 #ifdef CONFIG_CIFS_DEBUG2
1234 #endif /* CIFS_DEBUG2 */
1238 struct cifs_fid_locks {
1239 struct list_head llist;
1240 struct cifsFileInfo *cfile; /* fid that owns locks */
1241 struct list_head locks; /* locks held by fid above */
1244 struct cifsFileInfo {
1245 /* following two lists are protected by tcon->open_file_lock */
1246 struct list_head tlist; /* pointer to next fid owned by tcon */
1247 struct list_head flist; /* next fid (file instance) for this inode */
1248 /* lock list below protected by cifsi->lock_sem */
1249 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1250 kuid_t uid; /* allows finding which FileInfo structure */
1251 __u32 pid; /* process id who opened file */
1252 struct cifs_fid fid; /* file id from remote */
1253 struct list_head rlist; /* reconnect list */
1254 /* BB add lock scope info here if needed */ ;
1255 /* lock scope id (0 if none) */
1256 struct dentry *dentry;
1257 struct tcon_link *tlink;
1258 unsigned int f_flags;
1259 bool invalidHandle:1; /* file closed via session abend */
1260 bool oplock_break_cancelled:1;
1262 spinlock_t file_info_lock; /* protects four flag/count fields above */
1263 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1264 struct cifs_search_info srch_inf;
1265 struct work_struct oplock_break; /* work for oplock breaks */
1268 struct cifs_io_parms {
1270 __u64 persistent_fid; /* persist file id for smb2 */
1271 __u64 volatile_fid; /* volatile file id for smb2 */
1274 unsigned int length;
1275 struct cifs_tcon *tcon;
1278 struct cifs_aio_ctx {
1279 struct kref refcount;
1280 struct list_head list;
1281 struct mutex aio_mutex;
1282 struct completion done;
1283 struct iov_iter iter;
1285 struct cifsFileInfo *cfile;
1288 unsigned int npages;
1291 unsigned int total_len;
1294 * Indicates if this aio_ctx is for direct_io,
1295 * If yes, iter is a copy of the user passed iov_iter
1300 struct cifs_readdata;
1302 /* asynchronous read support */
1303 struct cifs_readdata {
1304 struct kref refcount;
1305 struct list_head list;
1306 struct completion done;
1307 struct cifsFileInfo *cfile;
1308 struct address_space *mapping;
1309 struct cifs_aio_ctx *ctx;
1312 unsigned int got_bytes;
1315 struct work_struct work;
1316 int (*read_into_pages)(struct TCP_Server_Info *server,
1317 struct cifs_readdata *rdata,
1319 int (*copy_into_pages)(struct TCP_Server_Info *server,
1320 struct cifs_readdata *rdata,
1321 struct iov_iter *iter);
1323 #ifdef CONFIG_CIFS_SMB_DIRECT
1326 unsigned int pagesz;
1327 unsigned int page_offset;
1328 unsigned int tailsz;
1329 struct cifs_credits credits;
1330 unsigned int nr_pages;
1331 struct page **pages;
1334 struct cifs_writedata;
1336 /* asynchronous write support */
1337 struct cifs_writedata {
1338 struct kref refcount;
1339 struct list_head list;
1340 struct completion done;
1341 enum writeback_sync_modes sync_mode;
1342 struct work_struct work;
1343 struct cifsFileInfo *cfile;
1344 struct cifs_aio_ctx *ctx;
1349 #ifdef CONFIG_CIFS_SMB_DIRECT
1352 unsigned int pagesz;
1353 unsigned int page_offset;
1354 unsigned int tailsz;
1355 struct cifs_credits credits;
1356 unsigned int nr_pages;
1357 struct page **pages;
1361 * Take a reference on the file private data. Must be called with
1362 * cfile->file_info_lock held.
1365 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1370 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1371 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr);
1372 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1374 #define CIFS_CACHE_READ_FLG 1
1375 #define CIFS_CACHE_HANDLE_FLG 2
1376 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1377 #define CIFS_CACHE_WRITE_FLG 4
1378 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1379 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1381 #define CIFS_CACHE_READ(cinode) ((cinode->oplock & CIFS_CACHE_READ_FLG) || (CIFS_SB(cinode->vfs_inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RO_CACHE))
1382 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1383 #define CIFS_CACHE_WRITE(cinode) ((cinode->oplock & CIFS_CACHE_WRITE_FLG) || (CIFS_SB(cinode->vfs_inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RW_CACHE))
1386 * One of these for each file inode
1389 struct cifsInodeInfo {
1390 bool can_cache_brlcks;
1391 struct list_head llist; /* locks helb by this inode */
1392 struct rw_semaphore lock_sem; /* protect the fields above */
1393 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1394 struct list_head openFileList;
1395 spinlock_t open_file_lock; /* protects openFileList */
1396 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1397 unsigned int oplock; /* oplock/lease level we have */
1398 unsigned int epoch; /* used to track lease state changes */
1399 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1400 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1401 #define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
1402 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1403 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1404 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1405 unsigned long flags;
1406 spinlock_t writers_lock;
1407 unsigned int writers; /* Number of writers on this inode */
1408 unsigned long time; /* jiffies of last update of inode */
1409 u64 server_eof; /* current file size on server -- protected by i_lock */
1410 u64 uniqueid; /* server inode number */
1411 u64 createtime; /* creation time on server */
1412 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1413 #ifdef CONFIG_CIFS_FSCACHE
1414 struct fscache_cookie *fscache;
1416 struct inode vfs_inode;
1419 static inline struct cifsInodeInfo *
1420 CIFS_I(struct inode *inode)
1422 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1425 static inline struct cifs_sb_info *
1426 CIFS_SB(struct super_block *sb)
1428 return sb->s_fs_info;
1431 static inline struct cifs_sb_info *
1432 CIFS_FILE_SB(struct file *file)
1434 return CIFS_SB(file_inode(file)->i_sb);
1437 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1439 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1446 convert_delimiter(char *path, char delim)
1448 char old_delim, *pos;
1456 while ((pos = strchr(pos, old_delim)))
1460 #define cifs_stats_inc atomic_inc
1462 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1466 spin_lock(&tcon->stat_lock);
1467 tcon->bytes_written += bytes;
1468 spin_unlock(&tcon->stat_lock);
1472 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1475 spin_lock(&tcon->stat_lock);
1476 tcon->bytes_read += bytes;
1477 spin_unlock(&tcon->stat_lock);
1482 * This is the prototype for the mid receive function. This function is for
1483 * receiving the rest of the SMB frame, starting with the WordCount (which is
1484 * just after the MID in struct smb_hdr). Note:
1486 * - This will be called by cifsd, with no locks held.
1487 * - The mid will still be on the pending_mid_q.
1488 * - mid->resp_buf will point to the current buffer.
1490 * Returns zero on a successful receive, or an error. The receive state in
1491 * the TCP_Server_Info will also be updated.
1493 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1494 struct mid_q_entry *mid);
1497 * This is the prototype for the mid callback function. This is called once the
1498 * mid has been received off of the socket. When creating one, take special
1499 * care to avoid deadlocks. Things to bear in mind:
1501 * - it will be called by cifsd, with no locks held
1502 * - the mid will be removed from any lists
1504 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1507 * This is the protopyte for mid handle function. This is called once the mid
1508 * has been recognized after decryption of the message.
1510 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1511 struct mid_q_entry *mid);
1513 /* one of these for every pending CIFS request to the server */
1514 struct mid_q_entry {
1515 struct list_head qhead; /* mids waiting on reply from this server */
1516 struct kref refcount;
1517 struct TCP_Server_Info *server; /* server corresponding to this mid */
1518 __u64 mid; /* multiplex id */
1519 __u16 credits; /* number of credits consumed by this mid */
1520 __u32 pid; /* process id */
1521 __u32 sequence_number; /* for CIFS signing */
1522 unsigned long when_alloc; /* when mid was created */
1523 #ifdef CONFIG_CIFS_STATS2
1524 unsigned long when_sent; /* time when smb send finished */
1525 unsigned long when_received; /* when demux complete (taken off wire) */
1527 mid_receive_t *receive; /* call receive callback */
1528 mid_callback_t *callback; /* call completion callback */
1529 mid_handle_t *handle; /* call handle mid callback */
1530 void *callback_data; /* general purpose pointer for callback */
1531 void *resp_buf; /* pointer to received SMB header */
1532 unsigned int resp_buf_size;
1533 int mid_state; /* wish this were enum but can not pass to wait_event */
1534 unsigned int mid_flags;
1535 __le16 command; /* smb command code */
1536 unsigned int optype; /* operation type */
1537 bool large_buf:1; /* if valid response, is pointer to large buf */
1538 bool multiRsp:1; /* multiple trans2 responses for one request */
1539 bool multiEnd:1; /* both received */
1540 bool decrypted:1; /* decrypted entry */
1543 struct close_cancelled_open {
1544 struct cifs_fid fid;
1545 struct cifs_tcon *tcon;
1546 struct work_struct work;
1549 /* Make code in transport.c a little cleaner by moving
1550 update of optional stats into function below */
1551 #ifdef CONFIG_CIFS_STATS2
1553 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1555 atomic_inc(&server->in_send);
1558 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1560 atomic_dec(&server->in_send);
1563 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1565 atomic_inc(&server->num_waiters);
1568 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1570 atomic_dec(&server->num_waiters);
1573 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1575 mid->when_sent = jiffies;
1578 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1581 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1585 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1589 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1593 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1598 /* for pending dnotify requests */
1599 struct dir_notify_req {
1600 struct list_head lhead;
1607 __u32 filter; /* CompletionFilter (for multishot) */
1612 struct dfs_info3_param {
1613 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1623 * common struct for holding inode info when searching for or updating an
1624 * inode with new info
1627 #define CIFS_FATTR_DFS_REFERRAL 0x1
1628 #define CIFS_FATTR_DELETE_PENDING 0x2
1629 #define CIFS_FATTR_NEED_REVAL 0x4
1630 #define CIFS_FATTR_INO_COLLISION 0x8
1631 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1632 #define CIFS_FATTR_FAKE_ROOT_INO 0x20
1645 unsigned int cf_nlink;
1646 unsigned int cf_dtype;
1647 struct timespec64 cf_atime;
1648 struct timespec64 cf_mtime;
1649 struct timespec64 cf_ctime;
1652 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1655 kfree(param->path_name);
1656 kfree(param->node_name);
1660 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1661 int number_of_items)
1664 if ((number_of_items == 0) || (param == NULL))
1666 for (i = 0; i < number_of_items; i++) {
1667 kfree(param[i].path_name);
1668 kfree(param[i].node_name);
1673 static inline bool is_interrupt_error(int error)
1678 case -ERESTARTNOHAND:
1679 case -ERESTARTNOINTR:
1685 static inline bool is_retryable_error(int error)
1687 if (is_interrupt_error(error) || error == -EAGAIN)
1693 #define MID_REQUEST_ALLOCATED 1
1694 #define MID_REQUEST_SUBMITTED 2
1695 #define MID_RESPONSE_RECEIVED 4
1696 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1697 #define MID_RESPONSE_MALFORMED 0x10
1698 #define MID_SHUTDOWN 0x20
1701 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1702 #define MID_DELETED 2 /* Mid has been dequeued/deleted */
1704 /* Types of response buffer returned from SendReceive2 */
1705 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1706 #define CIFS_SMALL_BUFFER 1
1707 #define CIFS_LARGE_BUFFER 2
1708 #define CIFS_IOVEC 4 /* array of response buffers */
1710 /* Type of Request to SendReceive2 */
1711 #define CIFS_BLOCKING_OP 1 /* operation can block */
1712 #define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */
1713 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1714 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1715 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1716 #define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */
1718 /* Type of request operation */
1719 #define CIFS_ECHO_OP 0x080 /* echo request */
1720 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1721 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1722 #define CIFS_OP_MASK 0x0380 /* mask request type */
1724 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1725 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1726 #define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */
1728 /* Security Flags: indicate type of session setup needed */
1729 #define CIFSSEC_MAY_SIGN 0x00001
1730 #define CIFSSEC_MAY_NTLM 0x00002
1731 #define CIFSSEC_MAY_NTLMV2 0x00004
1732 #define CIFSSEC_MAY_KRB5 0x00008
1733 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1734 #define CIFSSEC_MAY_LANMAN 0x00010
1735 #define CIFSSEC_MAY_PLNTXT 0x00020
1737 #define CIFSSEC_MAY_LANMAN 0
1738 #define CIFSSEC_MAY_PLNTXT 0
1739 #endif /* weak passwords */
1740 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1741 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1743 #define CIFSSEC_MUST_SIGN 0x01001
1744 /* note that only one of the following can be set so the
1745 result of setting MUST flags more than once will be to
1746 require use of the stronger protocol */
1747 #define CIFSSEC_MUST_NTLM 0x02002
1748 #define CIFSSEC_MUST_NTLMV2 0x04004
1749 #define CIFSSEC_MUST_KRB5 0x08008
1750 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1751 #define CIFSSEC_MUST_LANMAN 0x10010
1752 #define CIFSSEC_MUST_PLNTXT 0x20020
1753 #ifdef CONFIG_CIFS_UPCALL
1754 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1756 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1758 #else /* do not allow weak pw hash */
1759 #define CIFSSEC_MUST_LANMAN 0
1760 #define CIFSSEC_MUST_PLNTXT 0
1761 #ifdef CONFIG_CIFS_UPCALL
1762 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1764 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1766 #endif /* WEAK_PW_HASH */
1767 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1768 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1770 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1771 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1772 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1774 *****************************************************************
1775 * All constants go here
1776 *****************************************************************
1779 #define UID_HASH (16)
1782 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1783 * following to be declared.
1786 /****************************************************************************
1787 * Locking notes. All updates to global variables and lists should be
1788 * protected by spinlocks or semaphores.
1792 * GlobalMid_Lock protects:
1793 * list operations on pending_mid_q and oplockQ
1794 * updates to XID counters, multiplex id and SMB sequence numbers
1795 * list operations on global DnotifyReqList
1796 * tcp_ses_lock protects:
1797 * list operations on tcp and SMB session lists
1798 * tcon->open_file_lock protects the list of open files hanging off the tcon
1799 * inode->open_file_lock protects the openFileList hanging off the inode
1800 * cfile->file_info_lock protects counters and fields in cifs file struct
1801 * f_owner.lock protects certain per file struct operations
1802 * mapping->page_lock protects certain per page operations
1804 * Note that the cifs_tcon.open_file_lock should be taken before
1805 * not after the cifsInodeInfo.open_file_lock
1809 * sesSem operations on smb session
1810 * tconSem operations on tree connection
1811 * fh_sem file handle reconnection operations
1813 ****************************************************************************/
1815 #ifdef DECLARE_GLOBALS_HERE
1816 #define GLOBAL_EXTERN
1818 #define GLOBAL_EXTERN extern
1822 * the list of TCP_Server_Info structures, ie each of the sockets
1823 * connecting our client to a distinct server (ip address), is
1824 * chained together by cifs_tcp_ses_list. The list of all our SMB
1825 * sessions (and from that the tree connections) can be found
1826 * by iterating over cifs_tcp_ses_list
1828 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1831 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1832 * tcp session, and the list of tcon's per smb session. It also protects
1833 * the reference counters for the server, smb session, and tcon. Finally,
1834 * changes to the tcon->tidStatus should be done while holding this lock.
1835 * generally the locks should be taken in order tcp_ses_lock before
1836 * tcon->open_file_lock and that before file->file_info_lock since the
1837 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1839 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1841 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1842 /* Outstanding dir notify requests */
1843 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1844 /* DirNotify response queue */
1845 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1846 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1849 * Global transaction id (XID) information
1851 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1852 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1853 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1854 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1855 /* on midQ entries */
1857 * Global counters, updated atomically
1859 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1860 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1861 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1862 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1863 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1865 /* Various Debug counters */
1866 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1867 #ifdef CONFIG_CIFS_STATS2
1868 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1869 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1870 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
1872 GLOBAL_EXTERN atomic_t smBufAllocCount;
1873 GLOBAL_EXTERN atomic_t midCount;
1876 extern bool enable_oplocks; /* enable or disable oplocks */
1877 extern bool lookupCacheEnabled;
1878 extern unsigned int global_secflags; /* if on, session setup sent
1879 with more secure ntlmssp2 challenge/resp */
1880 extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1881 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1882 extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
1883 extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1884 extern unsigned int cifs_min_small; /* min size of small buf pool */
1885 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1886 extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
1888 GLOBAL_EXTERN struct rb_root uidtree;
1889 GLOBAL_EXTERN struct rb_root gidtree;
1890 GLOBAL_EXTERN spinlock_t siduidlock;
1891 GLOBAL_EXTERN spinlock_t sidgidlock;
1892 GLOBAL_EXTERN struct rb_root siduidtree;
1893 GLOBAL_EXTERN struct rb_root sidgidtree;
1894 GLOBAL_EXTERN spinlock_t uidsidlock;
1895 GLOBAL_EXTERN spinlock_t gidsidlock;
1897 void cifs_oplock_break(struct work_struct *work);
1898 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
1900 extern const struct slow_work_ops cifs_oplock_break_ops;
1901 extern struct workqueue_struct *cifsiod_wq;
1902 extern struct workqueue_struct *decrypt_wq;
1903 extern struct workqueue_struct *cifsoplockd_wq;
1904 extern __u32 cifs_lock_secret;
1906 extern mempool_t *cifs_mid_poolp;
1908 /* Operations for different SMB versions */
1909 #define SMB1_VERSION_STRING "1.0"
1910 extern struct smb_version_operations smb1_operations;
1911 extern struct smb_version_values smb1_values;
1912 #define SMB20_VERSION_STRING "2.0"
1913 extern struct smb_version_operations smb20_operations;
1914 extern struct smb_version_values smb20_values;
1915 #define SMB21_VERSION_STRING "2.1"
1916 extern struct smb_version_operations smb21_operations;
1917 extern struct smb_version_values smb21_values;
1918 #define SMBDEFAULT_VERSION_STRING "default"
1919 extern struct smb_version_values smbdefault_values;
1920 #define SMB3ANY_VERSION_STRING "3"
1921 extern struct smb_version_values smb3any_values;
1922 #define SMB30_VERSION_STRING "3.0"
1923 extern struct smb_version_operations smb30_operations;
1924 extern struct smb_version_values smb30_values;
1925 #define SMB302_VERSION_STRING "3.02"
1926 #define ALT_SMB302_VERSION_STRING "3.0.2"
1927 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1928 extern struct smb_version_values smb302_values;
1929 #define SMB311_VERSION_STRING "3.1.1"
1930 #define ALT_SMB311_VERSION_STRING "3.11"
1931 extern struct smb_version_operations smb311_operations;
1932 extern struct smb_version_values smb311_values;
1933 #endif /* _CIFS_GLOB_H */