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_REQ is the maximum number of requests that WE will send
64 * on one socket concurrently.
66 #define CIFS_MAX_REQ 32767
68 #define RFC1001_NAME_LEN 15
69 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
71 /* maximum length of ip addr as a string (including ipv6 and sctp) */
72 #define SERVER_NAME_LENGTH 80
73 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
75 /* echo interval in seconds */
76 #define SMB_ECHO_INTERVAL_MIN 1
77 #define SMB_ECHO_INTERVAL_MAX 600
78 #define SMB_ECHO_INTERVAL_DEFAULT 60
80 /* maximum number of PDUs in one compound */
81 #define MAX_COMPOUND 5
84 * Default number of credits to keep available for SMB3.
85 * This value is chosen somewhat arbitrarily. The Windows client
86 * defaults to 128 credits, the Windows server allows clients up to
87 * 512 credits (or 8K for later versions), and the NetApp server
88 * does not limit clients at all. Choose a high enough default value
89 * such that the client shouldn't limit performance, but allow mount
90 * to override (until you approach 64K, where we limit credits to 65000
91 * to reduce possibility of seeing more server credit overflow bugs.
93 #define SMB2_MAX_CREDITS_AVAILABLE 32000
97 #ifndef XATTR_DOS_ATTRIB
98 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
102 * CIFS vfs client Status information (based on what we know.)
105 /* associated with each tcp and smb session */
115 Unspecified = 0, /* not specified */
116 LANMAN, /* Legacy LANMAN auth */
117 NTLM, /* Legacy NTLM012 auth with NTLM hash */
118 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
119 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
120 Kerberos, /* Kerberos via SPNEGO */
128 /* crypto security descriptor definition */
130 struct shash_desc shash;
134 /* crypto hashing related structure/fields, not specific to a sec mech */
135 struct cifs_secmech {
136 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
137 struct crypto_shash *md5; /* md5 hash function */
138 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
139 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
140 struct crypto_shash *sha512; /* sha512 hash function */
141 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
142 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
143 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
144 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
145 struct sdesc *sdescsha512; /* ctxt to generate smb3.11 signing key */
146 struct crypto_aead *ccmaesencrypt; /* smb3 encryption aead */
147 struct crypto_aead *ccmaesdecrypt; /* smb3 decryption aead */
150 /* per smb session structure/fields */
151 struct ntlmssp_auth {
152 bool sesskey_per_smbsess; /* whether session key is per smb session */
153 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
154 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
155 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
156 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
164 struct cifs_sid osid;
165 struct cifs_sid gsid;
166 struct cifs_ntace *ntaces;
167 struct cifs_ace *aces;
171 *****************************************************************
172 * Except the CIFS PDUs themselves all the
173 * globally interesting structs should go here
174 *****************************************************************
178 * A smb_rqst represents a complete request to be issued to a server. It's
179 * formed by a kvec array, followed by an array of pages. Page data is assumed
180 * to start at the beginning of the first page.
183 struct kvec *rq_iov; /* array of kvecs */
184 unsigned int rq_nvec; /* number of kvecs in array */
185 struct page **rq_pages; /* pointer to array of page ptrs */
186 unsigned int rq_offset; /* the offset to the 1st page */
187 unsigned int rq_npages; /* number pages in array */
188 unsigned int rq_pagesz; /* page size to use */
189 unsigned int rq_tailsz; /* length of last page */
205 struct TCP_Server_Info;
209 struct dfs_info3_param;
213 struct cifs_readdata;
214 struct cifs_writedata;
215 struct cifs_io_parms;
216 struct cifs_search_info;
217 struct cifsInodeInfo;
218 struct cifs_open_parms;
220 struct smb_version_operations {
221 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
222 struct mid_q_entry *);
223 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
224 /* setup request: allocate mid, sign message */
225 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
227 /* setup async request: allocate mid, sign message */
228 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
230 /* check response: verify signature, map error */
231 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
233 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
235 void (*set_credits)(struct TCP_Server_Info *, const int);
236 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
237 unsigned int (*get_credits)(struct mid_q_entry *);
238 __u64 (*get_next_mid)(struct TCP_Server_Info *);
239 /* data offset from read response message */
240 unsigned int (*read_data_offset)(char *);
242 * Data length from read response message
243 * When in_remaining is true, the returned data length is in
244 * message field DataRemaining for out-of-band data read (e.g through
245 * Memory Registration RDMA write in SMBD).
246 * Otherwise, the returned data length is in message field DataLength.
248 unsigned int (*read_data_length)(char *, bool in_remaining);
249 /* map smb to linux error */
250 int (*map_error)(char *, bool);
251 /* find mid corresponding to the response message */
252 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
253 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
254 void (*clear_stats)(struct cifs_tcon *);
255 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
256 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
257 /* verify the message */
258 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
259 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
260 int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
261 void (*downgrade_oplock)(struct TCP_Server_Info *,
262 struct cifsInodeInfo *, bool);
263 /* process transaction2 response */
264 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
266 /* check if we need to negotiate */
267 bool (*need_neg)(struct TCP_Server_Info *);
268 /* negotiate to the server */
269 int (*negotiate)(const unsigned int, struct cifs_ses *);
270 /* set negotiated write size */
271 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
272 /* set negotiated read size */
273 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
274 /* setup smb sessionn */
275 int (*sess_setup)(const unsigned int, struct cifs_ses *,
276 const struct nls_table *);
277 /* close smb session */
278 int (*logoff)(const unsigned int, struct cifs_ses *);
279 /* connect to a server share */
280 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
281 struct cifs_tcon *, const struct nls_table *);
282 /* close tree connecion */
283 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
284 /* get DFS referrals */
285 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
286 const char *, struct dfs_info3_param **,
287 unsigned int *, const struct nls_table *, int);
288 /* informational QFS call */
289 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
290 /* check if a path is accessible or not */
291 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
292 struct cifs_sb_info *, const char *);
293 /* query path data from the server */
294 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
295 struct cifs_sb_info *, const char *,
296 FILE_ALL_INFO *, bool *, bool *);
297 /* query file data from the server */
298 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
299 struct cifs_fid *, FILE_ALL_INFO *);
300 /* get server index number */
301 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
302 struct cifs_sb_info *, const char *,
303 u64 *uniqueid, FILE_ALL_INFO *);
304 /* set size by path */
305 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
306 const char *, __u64, struct cifs_sb_info *, bool);
307 /* set size by file handle */
308 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
309 struct cifsFileInfo *, __u64, bool);
311 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
313 int (*set_compression)(const unsigned int, struct cifs_tcon *,
314 struct cifsFileInfo *);
315 /* check if we can send an echo or nor */
316 bool (*can_echo)(struct TCP_Server_Info *);
317 /* send echo request */
318 int (*echo)(struct TCP_Server_Info *);
319 /* create directory */
320 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
321 umode_t mode, struct cifs_tcon *tcon,
322 const char *full_path,
323 struct cifs_sb_info *cifs_sb);
324 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
325 struct cifs_sb_info *);
326 /* set info on created directory */
327 void (*mkdir_setinfo)(struct inode *, const char *,
328 struct cifs_sb_info *, struct cifs_tcon *,
330 /* remove directory */
331 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
332 struct cifs_sb_info *);
334 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
335 struct cifs_sb_info *);
336 /* open, rename and delete file */
337 int (*rename_pending_delete)(const char *, struct dentry *,
339 /* send rename request */
340 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
341 const char *, struct cifs_sb_info *);
342 /* send create hardlink request */
343 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
344 const char *, const char *,
345 struct cifs_sb_info *);
346 /* query symlink target */
347 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
348 const char *, char **, struct cifs_sb_info *);
349 /* open a file for non-posix mounts */
350 int (*open)(const unsigned int, struct cifs_open_parms *,
351 __u32 *, FILE_ALL_INFO *);
352 /* set fid protocol-specific info */
353 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
355 void (*close)(const unsigned int, struct cifs_tcon *,
357 /* send a flush request to the server */
358 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
359 /* async read from the server */
360 int (*async_readv)(struct cifs_readdata *);
361 /* async write to the server */
362 int (*async_writev)(struct cifs_writedata *,
363 void (*release)(struct kref *));
364 /* sync read from the server */
365 int (*sync_read)(const unsigned int, struct cifs_fid *,
366 struct cifs_io_parms *, unsigned int *, char **,
368 /* sync write to the server */
369 int (*sync_write)(const unsigned int, struct cifs_fid *,
370 struct cifs_io_parms *, unsigned int *, struct kvec *,
372 /* open dir, start readdir */
373 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
374 const char *, struct cifs_sb_info *,
375 struct cifs_fid *, __u16,
376 struct cifs_search_info *);
377 /* continue readdir */
378 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
380 __u16, struct cifs_search_info *srch_inf);
382 int (*close_dir)(const unsigned int, struct cifs_tcon *,
384 /* calculate a size of SMB message */
385 unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi);
386 /* check for STATUS_PENDING and process it in a positive case */
387 bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
388 /* check for STATUS_NETWORK_SESSION_EXPIRED */
389 bool (*is_session_expired)(char *);
390 /* send oplock break response */
391 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
392 struct cifsInodeInfo *);
393 /* query remote filesystem */
394 int (*queryfs)(const unsigned int, struct cifs_tcon *,
396 /* send mandatory brlock to the server */
397 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
398 __u64, __u32, int, int, bool);
399 /* unlock range of mandatory locks */
400 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
402 /* push brlocks from the cache to the server */
403 int (*push_mand_locks)(struct cifsFileInfo *);
404 /* get lease key of the inode */
405 void (*get_lease_key)(struct inode *, struct cifs_fid *);
406 /* set lease key of the inode */
407 void (*set_lease_key)(struct inode *, struct cifs_fid *);
408 /* generate new lease key */
409 void (*new_lease_key)(struct cifs_fid *);
410 int (*generate_signingkey)(struct cifs_ses *);
411 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
412 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
413 struct cifsFileInfo *src_file);
414 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
415 struct cifsFileInfo *src_file, void __user *);
416 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
417 struct cifs_sb_info *, const unsigned char *,
418 char *, unsigned int *);
419 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
420 struct cifs_sb_info *, const unsigned char *,
421 char *, unsigned int *);
422 /* if we can do cache read operations */
423 bool (*is_read_op)(__u32);
424 /* set oplock level for the inode */
425 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
427 /* create lease context buffer for CREATE request */
428 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
429 /* parse lease context buffer and return oplock/epoch info */
430 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
431 ssize_t (*copychunk_range)(const unsigned int,
432 struct cifsFileInfo *src_file,
433 struct cifsFileInfo *target_file,
434 u64 src_off, u64 len, u64 dest_off);
435 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
436 struct cifsFileInfo *target_file, u64 src_off, u64 len,
438 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
439 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
440 const unsigned char *, const unsigned char *, char *,
441 size_t, struct cifs_sb_info *);
442 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
443 const char *, const void *, const __u16,
444 const struct nls_table *, struct cifs_sb_info *);
445 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
446 const char *, u32 *);
447 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
448 const struct cifs_fid *, u32 *);
449 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
451 /* writepages retry size */
452 unsigned int (*wp_retry_size)(struct inode *);
453 /* get mtu credits */
454 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
455 unsigned int *, unsigned int *);
456 /* check if we need to issue closedir */
457 bool (*dir_needs_close)(struct cifsFileInfo *);
458 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
460 /* init transform request - used for encryption for now */
461 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
462 struct smb_rqst *, struct smb_rqst *);
463 int (*is_transform_hdr)(void *buf);
464 int (*receive_transform)(struct TCP_Server_Info *,
465 struct mid_q_entry **, char **, int *);
466 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
468 int (*next_header)(char *);
469 /* ioctl passthrough for query_info */
470 int (*ioctl_query_info)(const unsigned int xid,
471 struct cifs_tcon *tcon,
472 __le16 *path, int is_dir,
476 struct smb_version_values {
477 char *version_string;
479 __u32 req_capabilities;
480 __u32 large_lock_type;
481 __u32 exclusive_lock_type;
482 __u32 shared_lock_type;
483 __u32 unlock_lock_type;
484 size_t header_preamble_size;
486 size_t max_header_size;
487 size_t read_rsp_size;
489 unsigned int cap_unix;
490 unsigned int cap_nt_find;
491 unsigned int cap_large_files;
492 __u16 signing_enabled;
493 __u16 signing_required;
494 size_t create_lease_size;
497 #define HEADER_SIZE(server) (server->vals->header_size)
498 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
505 char *iocharset; /* local code page for mapping to and from Unicode */
506 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
507 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
515 enum securityEnum sectype; /* sectype requested via mnt opts */
516 bool sign; /* was signing requested via mnt opts? */
520 bool setuidfromacl:1;
525 bool no_psx_acl:1; /* set if posix acl support should be disabled */
527 bool backupuid_specified; /* mount option backupuid is specified */
528 bool backupgid_specified; /* mount option backupgid is specified */
529 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
530 bool server_ino:1; /* use inode numbers from server ie UniqueId */
532 bool strict_io:1; /* strict cache behavior */
533 bool remap:1; /* set to remap seven reserved chars in filenames */
534 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
535 bool posix_paths:1; /* unset to not ask for posix pathnames. */
539 bool nullauth:1; /* attempt to authenticate with null user */
540 bool nocase:1; /* request case insensitive filenames */
541 bool nobrl:1; /* disable sending byte range locks to srv */
542 bool nohandlecache:1; /* disable caching dir handles if srvr probs */
543 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
544 bool seal:1; /* request transport encryption on share */
545 bool nodfs:1; /* Do not request DFS, even if available */
546 bool local_lease:1; /* check leases only on local system, not remote */
549 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
550 bool fsc:1; /* enable fscache */
551 bool mfsymlinks:1; /* use Minshall+French Symlinks */
553 bool rwpidforward:1; /* pid forward for read/write operations */
557 bool resilient:1; /* noresilient not required since not fored for CA */
562 bool sockopt_tcp_nodelay:1;
563 unsigned long actimeo; /* attribute cache timeout (jiffies) */
564 struct smb_version_operations *ops;
565 struct smb_version_values *vals;
567 struct sockaddr_storage dstaddr; /* destination address */
568 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
569 struct nls_table *local_nls;
570 unsigned int echo_interval; /* echo interval in secs */
571 __u64 snapshot_time; /* needed for timewarp tokens */
572 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
575 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
576 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
577 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
578 CIFS_MOUNT_MAP_SFM_CHR | \
579 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
580 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
581 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
582 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
583 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
584 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
585 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
587 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
588 SB_NODEV | SB_SYNCHRONOUS)
590 struct cifs_mnt_data {
591 struct cifs_sb_info *cifs_sb;
596 static inline unsigned int
597 get_rfc1002_length(void *buf)
599 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
603 inc_rfc1001_len(void *buf, int count)
605 be32_add_cpu((__be32 *)buf, count);
608 struct TCP_Server_Info {
609 struct list_head tcp_ses_list;
610 struct list_head smb_ses_list;
611 int srv_count; /* reference counter */
612 /* 15 character server name + 0x20 16th byte indicating type = srv */
613 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
614 struct smb_version_operations *ops;
615 struct smb_version_values *vals;
616 enum statusEnum tcpStatus; /* what we think the status is */
617 char *hostname; /* hostname portion of UNC string */
618 struct socket *ssocket;
619 struct sockaddr_storage dstaddr;
620 struct sockaddr_storage srcaddr; /* locally bind to this IP */
624 wait_queue_head_t response_q;
625 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
626 struct list_head pending_mid_q;
627 bool noblocksnd; /* use blocking sendmsg */
628 bool noautotune; /* do not autotune send buf sizes */
630 unsigned int credits; /* send no more requests at once */
631 unsigned int max_credits; /* can override large 32000 default at mnt */
632 unsigned int in_flight; /* number of requests on the wire to server */
633 spinlock_t req_lock; /* protect the two values above */
634 struct mutex srv_mutex;
635 struct task_struct *tsk;
636 char server_GUID[16];
638 bool sign; /* is signing enabled on this connection? */
639 bool session_estab; /* mark when very first sess is established */
640 int echo_credits; /* echo reserved slots */
641 int oplock_credits; /* oplock break reserved slots */
642 bool echoes:1; /* enable echoes */
643 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
644 u16 dialect; /* dialect index that server chose */
645 bool oplocks:1; /* enable oplocks */
646 unsigned int maxReq; /* Clients should submit no more */
647 /* than maxReq distinct unanswered SMBs to the server when using */
648 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
649 unsigned int maxBuf; /* maxBuf specifies the maximum */
650 /* message size the server can send or receive for non-raw SMBs */
651 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
652 /* when socket is setup (and during reconnect) before NegProt sent */
653 unsigned int max_rw; /* maxRw specifies the maximum */
654 /* message size the server can send or receive for */
655 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
656 unsigned int capabilities; /* selective disabling of caps by smb sess */
657 int timeAdj; /* Adjust for difference in server time zone in sec */
658 __u64 CurrentMid; /* multiplex id - rotating counter */
659 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
660 /* 16th byte of RFC1001 workstation name is always null */
661 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
662 __u32 sequence_number; /* for signing, protected by srv_mutex */
663 __u32 reconnect_instance; /* incremented on each reconnect */
664 struct session_key session_key;
665 unsigned long lstrp; /* when we got last response from this server */
666 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
667 #define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
668 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
669 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
670 char negflavor; /* NEGOTIATE response flavor */
671 /* extended security flavors that server supports */
672 bool sec_ntlmssp; /* supports NTLMSSP */
673 bool sec_kerberosu2u; /* supports U2U Kerberos */
674 bool sec_kerberos; /* supports plain Kerberos */
675 bool sec_mskerberos; /* supports legacy MS Kerberos */
676 bool large_buf; /* is current buffer large? */
677 /* use SMBD connection instead of socket */
679 /* point to the SMBD connection if RDMA is used instead of socket */
680 struct smbd_connection *smbd_conn;
681 struct delayed_work echo; /* echo ping workqueue job */
682 char *smallbuf; /* pointer to current "small" buffer */
683 char *bigbuf; /* pointer to current "big" buffer */
684 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
685 unsigned int pdu_size;
686 unsigned int total_read; /* total amount of data read in this pass */
687 #ifdef CONFIG_CIFS_FSCACHE
688 struct fscache_cookie *fscache; /* client index cache cookie */
690 #ifdef CONFIG_CIFS_STATS2
691 atomic_t in_send; /* requests trying to send */
692 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
693 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
695 unsigned int max_read;
696 unsigned int max_write;
698 /* save initital negprot hash */
699 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
700 bool posix_ext_supported;
701 struct delayed_work reconnect; /* reconnect workqueue job */
702 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
703 unsigned long echo_interval;
706 * Number of targets available for reconnect. The more targets
707 * the more tasks have to wait to let the demultiplex thread
713 static inline unsigned int
714 in_flight(struct TCP_Server_Info *server)
717 spin_lock(&server->req_lock);
718 num = server->in_flight;
719 spin_unlock(&server->req_lock);
724 has_credits(struct TCP_Server_Info *server, int *credits)
727 spin_lock(&server->req_lock);
729 spin_unlock(&server->req_lock);
734 add_credits(struct TCP_Server_Info *server, const unsigned int add,
737 server->ops->add_credits(server, add, optype);
741 add_credits_and_wake_if(struct TCP_Server_Info *server, const unsigned int add,
745 server->ops->add_credits(server, add, optype);
746 wake_up(&server->request_q);
751 set_credits(struct TCP_Server_Info *server, const int val)
753 server->ops->set_credits(server, val);
757 get_next_mid64(struct TCP_Server_Info *server)
759 return cpu_to_le64(server->ops->get_next_mid(server));
763 get_next_mid(struct TCP_Server_Info *server)
765 __u16 mid = server->ops->get_next_mid(server);
767 * The value in the SMB header should be little endian for easy
768 * on-the-wire decoding.
770 return cpu_to_le16(mid);
774 get_mid(const struct smb_hdr *smb)
776 return le16_to_cpu(smb->Mid);
780 compare_mid(__u16 mid, const struct smb_hdr *smb)
782 return mid == le16_to_cpu(smb->Mid);
786 * When the server supports very large reads and writes via POSIX extensions,
787 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
788 * including the RFC1001 length.
790 * Note that this might make for "interesting" allocation problems during
791 * writeback however as we have to allocate an array of pointers for the
792 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
794 * For reads, there is a similar problem as we need to allocate an array
795 * of kvecs to handle the receive, though that should only need to be done
798 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
799 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
802 * When the server doesn't allow large posix writes, only allow a rsize/wsize
803 * of 2^17-1 minus the size of the call header. That allows for a read or
804 * write up to the maximum size described by RFC1002.
806 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
807 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
810 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
811 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
812 * a single wsize request with a single call.
814 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
815 #define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
818 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
819 * those values when posix extensions aren't in force. In actuality here, we
820 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
821 * to be ok with the extra byte even though Windows doesn't send writes that
826 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
828 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
829 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
832 * Macros to allow the TCP_Server_Info->net field and related code to drop out
833 * when CONFIG_NET_NS isn't set.
838 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
843 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
850 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
855 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
861 struct cifs_server_iface {
863 unsigned int rdma_capable : 1;
864 unsigned int rss_capable : 1;
865 struct sockaddr_storage sockaddr;
869 * Session structure. One of these for each uid session with a particular host
872 struct list_head smb_ses_list;
873 struct list_head tcon_list;
874 struct cifs_tcon *tcon_ipc;
875 struct mutex session_mutex;
876 struct TCP_Server_Info *server; /* pointer to server info */
877 int ses_count; /* reference counter */
878 enum statusEnum status;
879 unsigned overrideSecFlg; /* if non-zero override global sec flags */
880 char *serverOS; /* name of operating system underlying server */
881 char *serverNOS; /* name of network operating system of server */
882 char *serverDomain; /* security realm of server */
883 __u64 Suid; /* remote smb uid */
884 kuid_t linux_uid; /* overriding owner of files on the mount */
885 kuid_t cred_uid; /* owner of credentials */
886 unsigned int capabilities;
887 char serverName[SERVER_NAME_LEN_WITH_NULL];
888 char *user_name; /* must not be null except during init of sess
889 and after mount option parsing we fill it */
892 struct session_key auth_key;
893 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
894 enum securityEnum sectype; /* what security flavor was specified? */
895 bool sign; /* is signing required? */
896 bool need_reconnect:1; /* connection reset, uid now invalid */
899 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
900 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
901 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
902 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
905 * Network interfaces available on the server this session is
908 * Other channels can be opened by connecting and binding this
909 * session to interfaces from this list.
911 * iface_lock should be taken when accessing any of these fields
913 spinlock_t iface_lock;
914 struct cifs_server_iface *iface_list;
916 unsigned long iface_last_update; /* jiffies */
920 cap_unix(struct cifs_ses *ses)
922 return ses->server->vals->cap_unix & ses->capabilities;
926 bool is_valid:1; /* Do we have a useable root fid */
927 struct kref refcount;
928 struct cifs_fid *fid;
929 struct mutex fid_mutex;
930 struct cifs_tcon *tcon;
931 struct work_struct lease_break;
935 * there is one of these for each connection to a resource on a particular
939 struct list_head tcon_list;
941 struct list_head rlist; /* reconnect list */
942 atomic_t num_local_opens; /* num of all opens including disconnected */
943 atomic_t num_remote_opens; /* num of all network opens on server */
944 struct list_head openFileList;
945 spinlock_t open_file_lock; /* protects list above */
946 struct cifs_ses *ses; /* pointer to session associated with */
947 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
948 char *nativeFileSystem;
949 char *password; /* for share-level security */
950 __u32 tid; /* The 4 byte tree id */
951 __u16 Flags; /* optional support bits */
952 enum statusEnum tidStatus;
953 atomic_t num_smbs_sent;
958 atomic_t num_flushes;
959 atomic_t num_oplock_brks;
962 atomic_t num_deletes;
964 atomic_t num_posixopens;
965 atomic_t num_posixmkdirs;
967 atomic_t num_renames;
968 atomic_t num_t2renames;
972 atomic_t num_hardlinks;
973 atomic_t num_symlinks;
975 atomic_t num_acl_get;
976 atomic_t num_acl_set;
979 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
980 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
985 spinlock_t stat_lock; /* protects the two fields above */
986 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
987 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
988 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
989 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
990 bool pipe:1; /* set if connection to pipe share */
991 bool print:1; /* set if connection to printer share */
994 bool nohandlecache:1; /* if strange server resource prob can turn off */
995 bool seal:1; /* transport encryption for this mounted share */
996 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
997 for this mount even if server would support */
998 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
999 bool local_lease:1; /* check leases (only) on local system not remote */
1000 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1001 bool broken_sparse_sup; /* if server or share does not support sparse */
1002 bool need_reconnect:1; /* connection reset, tid now invalid */
1003 bool need_reopen_files:1; /* need to reopen tcon file handles */
1004 bool use_resilient:1; /* use resilient instead of durable handles */
1005 bool use_persistent:1; /* use persistent instead of durable handles */
1006 __le32 capabilities;
1008 __u32 maximal_access;
1009 __u32 vol_serial_number;
1010 __le64 vol_create_time;
1011 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1012 __u32 ss_flags; /* sector size flags */
1013 __u32 perf_sector_size; /* best sector size for perf */
1015 __u32 max_bytes_chunk;
1016 __u32 max_bytes_copy;
1017 #ifdef CONFIG_CIFS_FSCACHE
1018 u64 resource_id; /* server resource id */
1019 struct fscache_cookie *fscache; /* cookie for share */
1021 struct list_head pending_opens; /* list of incomplete opens */
1022 struct cached_fid crfid; /* Cached root fid */
1023 /* BB add field for back pointer to sb struct(s)? */
1024 #ifdef CONFIG_CIFS_DFS_UPCALL
1027 struct list_head ulist; /* cache update list */
1032 * This is a refcounted and timestamped container for a tcon pointer. The
1033 * container holds a tcon reference. It is considered safe to free one of
1034 * these when the tl_count goes to 0. The tl_time is the time of the last
1035 * "get" on the container.
1038 struct rb_node tl_rbnode;
1040 unsigned long tl_flags;
1041 #define TCON_LINK_MASTER 0
1042 #define TCON_LINK_PENDING 1
1043 #define TCON_LINK_IN_TREE 2
1044 unsigned long tl_time;
1046 struct cifs_tcon *tl_tcon;
1049 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1050 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1052 static inline struct cifs_tcon *
1053 tlink_tcon(struct tcon_link *tlink)
1055 return tlink->tl_tcon;
1058 static inline struct tcon_link *
1059 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1061 return cifs_sb->master_tlink;
1064 extern void cifs_put_tlink(struct tcon_link *tlink);
1066 static inline struct tcon_link *
1067 cifs_get_tlink(struct tcon_link *tlink)
1069 if (tlink && !IS_ERR(tlink))
1070 atomic_inc(&tlink->tl_count);
1074 /* This function is always expected to succeed */
1075 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1077 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1079 struct cifs_pending_open {
1080 struct list_head olist;
1081 struct tcon_link *tlink;
1087 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1088 * This is used to track byte stream locks on the file
1090 struct cifsLockInfo {
1091 struct list_head llist; /* pointer to next cifsLockInfo */
1092 struct list_head blist; /* pointer to locks blocked on this */
1093 wait_queue_head_t block_q;
1102 * One of these for each open instance of a file
1104 struct cifs_search_info {
1105 loff_t index_of_last_entry;
1106 __u16 entries_in_buffer;
1109 char *ntwrk_buf_start;
1110 char *srch_entries_start;
1112 const char *presume_name;
1113 unsigned int resume_name_len;
1117 bool smallBuf:1; /* so we know which buf_release function to call */
1120 struct cifs_open_parms {
1121 struct cifs_tcon *tcon;
1122 struct cifs_sb_info *cifs_sb;
1127 struct cifs_fid *fid;
1134 __u64 persistent_fid; /* persist file id for smb2 */
1135 __u64 volatile_fid; /* volatile file id for smb2 */
1136 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1137 __u8 create_guid[16];
1138 struct cifs_pending_open *pending_open;
1140 #ifdef CONFIG_CIFS_DEBUG2
1142 #endif /* CIFS_DEBUG2 */
1146 struct cifs_fid_locks {
1147 struct list_head llist;
1148 struct cifsFileInfo *cfile; /* fid that owns locks */
1149 struct list_head locks; /* locks held by fid above */
1152 struct cifsFileInfo {
1153 /* following two lists are protected by tcon->open_file_lock */
1154 struct list_head tlist; /* pointer to next fid owned by tcon */
1155 struct list_head flist; /* next fid (file instance) for this inode */
1156 /* lock list below protected by cifsi->lock_sem */
1157 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1158 kuid_t uid; /* allows finding which FileInfo structure */
1159 __u32 pid; /* process id who opened file */
1160 struct cifs_fid fid; /* file id from remote */
1161 struct list_head rlist; /* reconnect list */
1162 /* BB add lock scope info here if needed */ ;
1163 /* lock scope id (0 if none) */
1164 struct dentry *dentry;
1165 struct tcon_link *tlink;
1166 unsigned int f_flags;
1167 bool invalidHandle:1; /* file closed via session abend */
1168 bool oplock_break_cancelled:1;
1170 spinlock_t file_info_lock; /* protects four flag/count fields above */
1171 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1172 struct cifs_search_info srch_inf;
1173 struct work_struct oplock_break; /* work for oplock breaks */
1176 struct cifs_io_parms {
1178 __u64 persistent_fid; /* persist file id for smb2 */
1179 __u64 volatile_fid; /* volatile file id for smb2 */
1182 unsigned int length;
1183 struct cifs_tcon *tcon;
1186 struct cifs_aio_ctx {
1187 struct kref refcount;
1188 struct list_head list;
1189 struct mutex aio_mutex;
1190 struct completion done;
1191 struct iov_iter iter;
1193 struct cifsFileInfo *cfile;
1196 unsigned int npages;
1199 unsigned int total_len;
1202 * Indicates if this aio_ctx is for direct_io,
1203 * If yes, iter is a copy of the user passed iov_iter
1208 struct cifs_readdata;
1210 /* asynchronous read support */
1211 struct cifs_readdata {
1212 struct kref refcount;
1213 struct list_head list;
1214 struct completion done;
1215 struct cifsFileInfo *cfile;
1216 struct address_space *mapping;
1217 struct cifs_aio_ctx *ctx;
1220 unsigned int got_bytes;
1223 struct work_struct work;
1224 int (*read_into_pages)(struct TCP_Server_Info *server,
1225 struct cifs_readdata *rdata,
1227 int (*copy_into_pages)(struct TCP_Server_Info *server,
1228 struct cifs_readdata *rdata,
1229 struct iov_iter *iter);
1231 #ifdef CONFIG_CIFS_SMB_DIRECT
1234 unsigned int pagesz;
1235 unsigned int page_offset;
1236 unsigned int tailsz;
1237 unsigned int credits;
1238 unsigned int nr_pages;
1239 struct page **pages;
1242 struct cifs_writedata;
1244 /* asynchronous write support */
1245 struct cifs_writedata {
1246 struct kref refcount;
1247 struct list_head list;
1248 struct completion done;
1249 enum writeback_sync_modes sync_mode;
1250 struct work_struct work;
1251 struct cifsFileInfo *cfile;
1252 struct cifs_aio_ctx *ctx;
1257 #ifdef CONFIG_CIFS_SMB_DIRECT
1260 unsigned int pagesz;
1261 unsigned int page_offset;
1262 unsigned int tailsz;
1263 unsigned int credits;
1264 unsigned int nr_pages;
1265 struct page **pages;
1269 * Take a reference on the file private data. Must be called with
1270 * cfile->file_info_lock held.
1273 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1278 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1279 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1281 #define CIFS_CACHE_READ_FLG 1
1282 #define CIFS_CACHE_HANDLE_FLG 2
1283 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1284 #define CIFS_CACHE_WRITE_FLG 4
1285 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1286 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1288 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1289 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1290 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1293 * One of these for each file inode
1296 struct cifsInodeInfo {
1297 bool can_cache_brlcks;
1298 struct list_head llist; /* locks helb by this inode */
1299 struct rw_semaphore lock_sem; /* protect the fields above */
1300 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1301 struct list_head openFileList;
1302 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1303 unsigned int oplock; /* oplock/lease level we have */
1304 unsigned int epoch; /* used to track lease state changes */
1305 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1306 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1307 #define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
1308 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1309 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1310 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1311 unsigned long flags;
1312 spinlock_t writers_lock;
1313 unsigned int writers; /* Number of writers on this inode */
1314 unsigned long time; /* jiffies of last update of inode */
1315 u64 server_eof; /* current file size on server -- protected by i_lock */
1316 u64 uniqueid; /* server inode number */
1317 u64 createtime; /* creation time on server */
1318 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1319 #ifdef CONFIG_CIFS_FSCACHE
1320 struct fscache_cookie *fscache;
1322 struct inode vfs_inode;
1325 static inline struct cifsInodeInfo *
1326 CIFS_I(struct inode *inode)
1328 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1331 static inline struct cifs_sb_info *
1332 CIFS_SB(struct super_block *sb)
1334 return sb->s_fs_info;
1337 static inline struct cifs_sb_info *
1338 CIFS_FILE_SB(struct file *file)
1340 return CIFS_SB(file_inode(file)->i_sb);
1343 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1345 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1352 convert_delimiter(char *path, char delim)
1354 char old_delim, *pos;
1362 while ((pos = strchr(pos, old_delim)))
1366 #define cifs_stats_inc atomic_inc
1368 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1372 spin_lock(&tcon->stat_lock);
1373 tcon->bytes_written += bytes;
1374 spin_unlock(&tcon->stat_lock);
1378 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1381 spin_lock(&tcon->stat_lock);
1382 tcon->bytes_read += bytes;
1383 spin_unlock(&tcon->stat_lock);
1388 * This is the prototype for the mid receive function. This function is for
1389 * receiving the rest of the SMB frame, starting with the WordCount (which is
1390 * just after the MID in struct smb_hdr). Note:
1392 * - This will be called by cifsd, with no locks held.
1393 * - The mid will still be on the pending_mid_q.
1394 * - mid->resp_buf will point to the current buffer.
1396 * Returns zero on a successful receive, or an error. The receive state in
1397 * the TCP_Server_Info will also be updated.
1399 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1400 struct mid_q_entry *mid);
1403 * This is the prototype for the mid callback function. This is called once the
1404 * mid has been received off of the socket. When creating one, take special
1405 * care to avoid deadlocks. Things to bear in mind:
1407 * - it will be called by cifsd, with no locks held
1408 * - the mid will be removed from any lists
1410 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1413 * This is the protopyte for mid handle function. This is called once the mid
1414 * has been recognized after decryption of the message.
1416 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1417 struct mid_q_entry *mid);
1419 /* one of these for every pending CIFS request to the server */
1420 struct mid_q_entry {
1421 struct list_head qhead; /* mids waiting on reply from this server */
1422 struct kref refcount;
1423 struct TCP_Server_Info *server; /* server corresponding to this mid */
1424 __u64 mid; /* multiplex id */
1425 __u32 pid; /* process id */
1426 __u32 sequence_number; /* for CIFS signing */
1427 unsigned long when_alloc; /* when mid was created */
1428 #ifdef CONFIG_CIFS_STATS2
1429 unsigned long when_sent; /* time when smb send finished */
1430 unsigned long when_received; /* when demux complete (taken off wire) */
1432 mid_receive_t *receive; /* call receive callback */
1433 mid_callback_t *callback; /* call completion callback */
1434 mid_handle_t *handle; /* call handle mid callback */
1435 void *callback_data; /* general purpose pointer for callback */
1436 void *resp_buf; /* pointer to received SMB header */
1437 unsigned int resp_buf_size;
1438 int mid_state; /* wish this were enum but can not pass to wait_event */
1439 unsigned int mid_flags;
1440 __le16 command; /* smb command code */
1441 unsigned int optype; /* operation type */
1442 bool large_buf:1; /* if valid response, is pointer to large buf */
1443 bool multiRsp:1; /* multiple trans2 responses for one request */
1444 bool multiEnd:1; /* both received */
1445 bool decrypted:1; /* decrypted entry */
1448 struct close_cancelled_open {
1449 struct cifs_fid fid;
1450 struct cifs_tcon *tcon;
1451 struct work_struct work;
1454 /* Make code in transport.c a little cleaner by moving
1455 update of optional stats into function below */
1456 #ifdef CONFIG_CIFS_STATS2
1458 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1460 atomic_inc(&server->in_send);
1463 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1465 atomic_dec(&server->in_send);
1468 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1470 atomic_inc(&server->num_waiters);
1473 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1475 atomic_dec(&server->num_waiters);
1478 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1480 mid->when_sent = jiffies;
1483 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1486 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1490 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1494 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1498 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1503 /* for pending dnotify requests */
1504 struct dir_notify_req {
1505 struct list_head lhead;
1512 __u32 filter; /* CompletionFilter (for multishot) */
1517 struct dfs_info3_param {
1518 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1528 * common struct for holding inode info when searching for or updating an
1529 * inode with new info
1532 #define CIFS_FATTR_DFS_REFERRAL 0x1
1533 #define CIFS_FATTR_DELETE_PENDING 0x2
1534 #define CIFS_FATTR_NEED_REVAL 0x4
1535 #define CIFS_FATTR_INO_COLLISION 0x8
1536 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1537 #define CIFS_FATTR_FAKE_ROOT_INO 0x20
1550 unsigned int cf_nlink;
1551 unsigned int cf_dtype;
1552 struct timespec64 cf_atime;
1553 struct timespec64 cf_mtime;
1554 struct timespec64 cf_ctime;
1557 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1560 kfree(param->path_name);
1561 kfree(param->node_name);
1565 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1566 int number_of_items)
1569 if ((number_of_items == 0) || (param == NULL))
1571 for (i = 0; i < number_of_items; i++) {
1572 kfree(param[i].path_name);
1573 kfree(param[i].node_name);
1578 static inline bool is_interrupt_error(int error)
1583 case -ERESTARTNOHAND:
1584 case -ERESTARTNOINTR:
1590 static inline bool is_retryable_error(int error)
1592 if (is_interrupt_error(error) || error == -EAGAIN)
1598 #define MID_REQUEST_ALLOCATED 1
1599 #define MID_REQUEST_SUBMITTED 2
1600 #define MID_RESPONSE_RECEIVED 4
1601 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1602 #define MID_RESPONSE_MALFORMED 0x10
1603 #define MID_SHUTDOWN 0x20
1606 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1607 #define MID_DELETED 2 /* Mid has been dequeued/deleted */
1609 /* Types of response buffer returned from SendReceive2 */
1610 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1611 #define CIFS_SMALL_BUFFER 1
1612 #define CIFS_LARGE_BUFFER 2
1613 #define CIFS_IOVEC 4 /* array of response buffers */
1615 /* Type of Request to SendReceive2 */
1616 #define CIFS_BLOCKING_OP 1 /* operation can block */
1617 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1618 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1619 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1620 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1621 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1623 /* Type of request operation */
1624 #define CIFS_ECHO_OP 0x080 /* echo request */
1625 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1626 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1627 #define CIFS_OP_MASK 0x0380 /* mask request type */
1629 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1630 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1632 /* Security Flags: indicate type of session setup needed */
1633 #define CIFSSEC_MAY_SIGN 0x00001
1634 #define CIFSSEC_MAY_NTLM 0x00002
1635 #define CIFSSEC_MAY_NTLMV2 0x00004
1636 #define CIFSSEC_MAY_KRB5 0x00008
1637 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1638 #define CIFSSEC_MAY_LANMAN 0x00010
1639 #define CIFSSEC_MAY_PLNTXT 0x00020
1641 #define CIFSSEC_MAY_LANMAN 0
1642 #define CIFSSEC_MAY_PLNTXT 0
1643 #endif /* weak passwords */
1644 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1645 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1647 #define CIFSSEC_MUST_SIGN 0x01001
1648 /* note that only one of the following can be set so the
1649 result of setting MUST flags more than once will be to
1650 require use of the stronger protocol */
1651 #define CIFSSEC_MUST_NTLM 0x02002
1652 #define CIFSSEC_MUST_NTLMV2 0x04004
1653 #define CIFSSEC_MUST_KRB5 0x08008
1654 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1655 #define CIFSSEC_MUST_LANMAN 0x10010
1656 #define CIFSSEC_MUST_PLNTXT 0x20020
1657 #ifdef CONFIG_CIFS_UPCALL
1658 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1660 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1662 #else /* do not allow weak pw hash */
1663 #define CIFSSEC_MUST_LANMAN 0
1664 #define CIFSSEC_MUST_PLNTXT 0
1665 #ifdef CONFIG_CIFS_UPCALL
1666 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1668 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1670 #endif /* WEAK_PW_HASH */
1671 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1672 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1674 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1675 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1676 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1678 *****************************************************************
1679 * All constants go here
1680 *****************************************************************
1683 #define UID_HASH (16)
1686 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1687 * following to be declared.
1690 /****************************************************************************
1691 * Locking notes. All updates to global variables and lists should be
1692 * protected by spinlocks or semaphores.
1696 * GlobalMid_Lock protects:
1697 * list operations on pending_mid_q and oplockQ
1698 * updates to XID counters, multiplex id and SMB sequence numbers
1699 * tcp_ses_lock protects:
1700 * list operations on tcp and SMB session lists
1701 * tcon->open_file_lock protects the list of open files hanging off the tcon
1702 * cfile->file_info_lock protects counters and fields in cifs file struct
1703 * f_owner.lock protects certain per file struct operations
1704 * mapping->page_lock protects certain per page operations
1708 * sesSem operations on smb session
1709 * tconSem operations on tree connection
1710 * fh_sem file handle reconnection operations
1712 ****************************************************************************/
1714 #ifdef DECLARE_GLOBALS_HERE
1715 #define GLOBAL_EXTERN
1717 #define GLOBAL_EXTERN extern
1721 * the list of TCP_Server_Info structures, ie each of the sockets
1722 * connecting our client to a distinct server (ip address), is
1723 * chained together by cifs_tcp_ses_list. The list of all our SMB
1724 * sessions (and from that the tree connections) can be found
1725 * by iterating over cifs_tcp_ses_list
1727 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1730 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1731 * tcp session, and the list of tcon's per smb session. It also protects
1732 * the reference counters for the server, smb session, and tcon. Finally,
1733 * changes to the tcon->tidStatus should be done while holding this lock.
1734 * generally the locks should be taken in order tcp_ses_lock before
1735 * tcon->open_file_lock and that before file->file_info_lock since the
1736 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1738 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1740 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1741 /* Outstanding dir notify requests */
1742 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1743 /* DirNotify response queue */
1744 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1745 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1748 * Global transaction id (XID) information
1750 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1751 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1752 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1753 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1754 /* on midQ entries */
1756 * Global counters, updated atomically
1758 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1759 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1760 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1761 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1762 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1764 /* Various Debug counters */
1765 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1766 #ifdef CONFIG_CIFS_STATS2
1767 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1768 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1769 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
1771 GLOBAL_EXTERN atomic_t smBufAllocCount;
1772 GLOBAL_EXTERN atomic_t midCount;
1775 extern bool enable_oplocks; /* enable or disable oplocks */
1776 extern bool lookupCacheEnabled;
1777 extern unsigned int global_secflags; /* if on, session setup sent
1778 with more secure ntlmssp2 challenge/resp */
1779 extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1780 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1781 extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
1782 extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1783 extern unsigned int cifs_min_small; /* min size of small buf pool */
1784 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1785 extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
1787 #ifdef CONFIG_CIFS_ACL
1788 GLOBAL_EXTERN struct rb_root uidtree;
1789 GLOBAL_EXTERN struct rb_root gidtree;
1790 GLOBAL_EXTERN spinlock_t siduidlock;
1791 GLOBAL_EXTERN spinlock_t sidgidlock;
1792 GLOBAL_EXTERN struct rb_root siduidtree;
1793 GLOBAL_EXTERN struct rb_root sidgidtree;
1794 GLOBAL_EXTERN spinlock_t uidsidlock;
1795 GLOBAL_EXTERN spinlock_t gidsidlock;
1796 #endif /* CONFIG_CIFS_ACL */
1798 void cifs_oplock_break(struct work_struct *work);
1800 extern const struct slow_work_ops cifs_oplock_break_ops;
1801 extern struct workqueue_struct *cifsiod_wq;
1802 extern struct workqueue_struct *cifsoplockd_wq;
1803 extern __u32 cifs_lock_secret;
1805 extern mempool_t *cifs_mid_poolp;
1807 /* Operations for different SMB versions */
1808 #define SMB1_VERSION_STRING "1.0"
1809 extern struct smb_version_operations smb1_operations;
1810 extern struct smb_version_values smb1_values;
1811 #define SMB20_VERSION_STRING "2.0"
1812 extern struct smb_version_operations smb20_operations;
1813 extern struct smb_version_values smb20_values;
1814 #define SMB21_VERSION_STRING "2.1"
1815 extern struct smb_version_operations smb21_operations;
1816 extern struct smb_version_values smb21_values;
1817 #define SMBDEFAULT_VERSION_STRING "default"
1818 extern struct smb_version_values smbdefault_values;
1819 #define SMB3ANY_VERSION_STRING "3"
1820 extern struct smb_version_values smb3any_values;
1821 #define SMB30_VERSION_STRING "3.0"
1822 extern struct smb_version_operations smb30_operations;
1823 extern struct smb_version_values smb30_values;
1824 #define SMB302_VERSION_STRING "3.02"
1825 #define ALT_SMB302_VERSION_STRING "3.0.2"
1826 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1827 extern struct smb_version_values smb302_values;
1828 #define SMB311_VERSION_STRING "3.1.1"
1829 #define ALT_SMB311_VERSION_STRING "3.11"
1830 extern struct smb_version_operations smb311_operations;
1831 extern struct smb_version_values smb311_values;
1832 #endif /* _CIFS_GLOB_H */