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 */
37 #define RFC1001_PORT 139
40 * The sizes of various internal tables and strings
42 #define MAX_UID_INFO 16
43 #define MAX_SES_INFO 2
44 #define MAX_TCON_INFO 4
46 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
48 #define CIFS_MIN_RCV_POOL 4
50 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
52 * default attribute cache timeout (jiffies)
54 #define CIFS_DEF_ACTIMEO (1 * HZ)
57 * max attribute cache timeout (jiffies) - 2^30
59 #define CIFS_MAX_ACTIMEO (1 << 30)
62 * MAX_REQ is the maximum number of requests that WE will send
63 * on one socket concurrently.
65 #define CIFS_MAX_REQ 32767
67 #define RFC1001_NAME_LEN 15
68 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
70 /* maximum length of ip addr as a string (including ipv6 and sctp) */
71 #define SERVER_NAME_LENGTH 80
72 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
74 /* echo interval in seconds */
75 #define SMB_ECHO_INTERVAL_MIN 1
76 #define SMB_ECHO_INTERVAL_MAX 600
77 #define SMB_ECHO_INTERVAL_DEFAULT 60
80 * Default number of credits to keep available for SMB3.
81 * This value is chosen somewhat arbitrarily. The Windows client
82 * defaults to 128 credits, the Windows server allows clients up to
83 * 512 credits (or 8K for later versions), and the NetApp server
84 * does not limit clients at all. Choose a high enough default value
85 * such that the client shouldn't limit performance, but allow mount
86 * to override (until you approach 64K, where we limit credits to 65000
87 * to reduce possibility of seeing more server credit overflow bugs.
89 #define SMB2_MAX_CREDITS_AVAILABLE 32000
93 #ifndef XATTR_DOS_ATTRIB
94 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
98 * CIFS vfs client Status information (based on what we know.)
101 /* associated with each tcp and smb session */
111 Unspecified
= 0, /* not specified */
112 LANMAN
, /* Legacy LANMAN auth */
113 NTLM
, /* Legacy NTLM012 auth with NTLM hash */
114 NTLMv2
, /* Legacy NTLM auth with NTLMv2 hash */
115 RawNTLMSSP
, /* NTLMSSP without SPNEGO, NTLMv2 hash */
116 Kerberos
, /* Kerberos via SPNEGO */
124 /* crypto security descriptor definition */
126 struct shash_desc shash
;
130 /* crypto hashing related structure/fields, not specific to a sec mech */
131 struct cifs_secmech
{
132 struct crypto_shash
*hmacmd5
; /* hmac-md5 hash function */
133 struct crypto_shash
*md5
; /* md5 hash function */
134 struct crypto_shash
*hmacsha256
; /* hmac-sha256 hash function */
135 struct crypto_shash
*cmacaes
; /* block-cipher based MAC function */
136 struct crypto_shash
*sha512
; /* sha512 hash function */
137 struct sdesc
*sdeschmacmd5
; /* ctxt to generate ntlmv2 hash, CR1 */
138 struct sdesc
*sdescmd5
; /* ctxt to generate cifs/smb signature */
139 struct sdesc
*sdeschmacsha256
; /* ctxt to generate smb2 signature */
140 struct sdesc
*sdesccmacaes
; /* ctxt to generate smb3 signature */
141 struct sdesc
*sdescsha512
; /* ctxt to generate smb3.11 signing key */
142 struct crypto_aead
*ccmaesencrypt
; /* smb3 encryption aead */
143 struct crypto_aead
*ccmaesdecrypt
; /* smb3 decryption aead */
146 /* per smb session structure/fields */
147 struct ntlmssp_auth
{
148 bool sesskey_per_smbsess
; /* whether session key is per smb session */
149 __u32 client_flags
; /* sent by client in type 1 ntlmsssp exchange */
150 __u32 server_flags
; /* sent by server in type 2 ntlmssp exchange */
151 unsigned char ciphertext
[CIFS_CPHTXT_SIZE
]; /* sent to server */
152 char cryptkey
[CIFS_CRYPTO_KEY_SIZE
]; /* used by ntlmssp */
160 struct cifs_sid osid
;
161 struct cifs_sid gsid
;
162 struct cifs_ntace
*ntaces
;
163 struct cifs_ace
*aces
;
167 *****************************************************************
168 * Except the CIFS PDUs themselves all the
169 * globally interesting structs should go here
170 *****************************************************************
174 * A smb_rqst represents a complete request to be issued to a server. It's
175 * formed by a kvec array, followed by an array of pages. Page data is assumed
176 * to start at the beginning of the first page.
179 struct kvec
*rq_iov
; /* array of kvecs */
180 unsigned int rq_nvec
; /* number of kvecs in array */
181 struct page
**rq_pages
; /* pointer to array of page ptrs */
182 unsigned int rq_offset
; /* the offset to the 1st page */
183 unsigned int rq_npages
; /* number pages in array */
184 unsigned int rq_pagesz
; /* page size to use */
185 unsigned int rq_tailsz
; /* length of last page */
194 #ifdef CONFIG_CIFS_SMB311
203 struct TCP_Server_Info
;
207 struct dfs_info3_param
;
211 struct cifs_readdata
;
212 struct cifs_writedata
;
213 struct cifs_io_parms
;
214 struct cifs_search_info
;
215 struct cifsInodeInfo
;
216 struct cifs_open_parms
;
218 struct smb_version_operations
{
219 int (*send_cancel
)(struct TCP_Server_Info
*, struct smb_rqst
*,
220 struct mid_q_entry
*);
221 bool (*compare_fids
)(struct cifsFileInfo
*, struct cifsFileInfo
*);
222 /* setup request: allocate mid, sign message */
223 struct mid_q_entry
*(*setup_request
)(struct cifs_ses
*,
225 /* setup async request: allocate mid, sign message */
226 struct mid_q_entry
*(*setup_async_request
)(struct TCP_Server_Info
*,
228 /* check response: verify signature, map error */
229 int (*check_receive
)(struct mid_q_entry
*, struct TCP_Server_Info
*,
231 void (*add_credits
)(struct TCP_Server_Info
*, const unsigned int,
233 void (*set_credits
)(struct TCP_Server_Info
*, const int);
234 int * (*get_credits_field
)(struct TCP_Server_Info
*, const int);
235 unsigned int (*get_credits
)(struct mid_q_entry
*);
236 __u64 (*get_next_mid
)(struct TCP_Server_Info
*);
237 /* data offset from read response message */
238 unsigned int (*read_data_offset
)(char *);
240 * Data length from read response message
241 * When in_remaining is true, the returned data length is in
242 * message field DataRemaining for out-of-band data read (e.g through
243 * Memory Registration RDMA write in SMBD).
244 * Otherwise, the returned data length is in message field DataLength.
246 unsigned int (*read_data_length
)(char *, bool in_remaining
);
247 /* map smb to linux error */
248 int (*map_error
)(char *, bool);
249 /* find mid corresponding to the response message */
250 struct mid_q_entry
* (*find_mid
)(struct TCP_Server_Info
*, char *);
251 void (*dump_detail
)(void *buf
, struct TCP_Server_Info
*ptcp_info
);
252 void (*clear_stats
)(struct cifs_tcon
*);
253 void (*print_stats
)(struct seq_file
*m
, struct cifs_tcon
*);
254 void (*dump_share_caps
)(struct seq_file
*, struct cifs_tcon
*);
255 /* verify the message */
256 int (*check_message
)(char *, unsigned int, struct TCP_Server_Info
*);
257 bool (*is_oplock_break
)(char *, struct TCP_Server_Info
*);
258 int (*handle_cancelled_mid
)(char *, struct TCP_Server_Info
*);
259 void (*downgrade_oplock
)(struct TCP_Server_Info
*,
260 struct cifsInodeInfo
*, bool);
261 /* process transaction2 response */
262 bool (*check_trans2
)(struct mid_q_entry
*, struct TCP_Server_Info
*,
264 /* check if we need to negotiate */
265 bool (*need_neg
)(struct TCP_Server_Info
*);
266 /* negotiate to the server */
267 int (*negotiate
)(const unsigned int, struct cifs_ses
*);
268 /* set negotiated write size */
269 unsigned int (*negotiate_wsize
)(struct cifs_tcon
*, struct smb_vol
*);
270 /* set negotiated read size */
271 unsigned int (*negotiate_rsize
)(struct cifs_tcon
*, struct smb_vol
*);
272 /* setup smb sessionn */
273 int (*sess_setup
)(const unsigned int, struct cifs_ses
*,
274 const struct nls_table
*);
275 /* close smb session */
276 int (*logoff
)(const unsigned int, struct cifs_ses
*);
277 /* connect to a server share */
278 int (*tree_connect
)(const unsigned int, struct cifs_ses
*, const char *,
279 struct cifs_tcon
*, const struct nls_table
*);
280 /* close tree connecion */
281 int (*tree_disconnect
)(const unsigned int, struct cifs_tcon
*);
282 /* get DFS referrals */
283 int (*get_dfs_refer
)(const unsigned int, struct cifs_ses
*,
284 const char *, struct dfs_info3_param
**,
285 unsigned int *, const struct nls_table
*, int);
286 /* informational QFS call */
287 void (*qfs_tcon
)(const unsigned int, struct cifs_tcon
*);
288 /* check if a path is accessible or not */
289 int (*is_path_accessible
)(const unsigned int, struct cifs_tcon
*,
290 struct cifs_sb_info
*, const char *);
291 /* query path data from the server */
292 int (*query_path_info
)(const unsigned int, struct cifs_tcon
*,
293 struct cifs_sb_info
*, const char *,
294 FILE_ALL_INFO
*, bool *, bool *);
295 /* query file data from the server */
296 int (*query_file_info
)(const unsigned int, struct cifs_tcon
*,
297 struct cifs_fid
*, FILE_ALL_INFO
*);
298 /* get server index number */
299 int (*get_srv_inum
)(const unsigned int, struct cifs_tcon
*,
300 struct cifs_sb_info
*, const char *,
301 u64
*uniqueid
, FILE_ALL_INFO
*);
302 /* set size by path */
303 int (*set_path_size
)(const unsigned int, struct cifs_tcon
*,
304 const char *, __u64
, struct cifs_sb_info
*, bool);
305 /* set size by file handle */
306 int (*set_file_size
)(const unsigned int, struct cifs_tcon
*,
307 struct cifsFileInfo
*, __u64
, bool);
309 int (*set_file_info
)(struct inode
*, const char *, FILE_BASIC_INFO
*,
311 int (*set_compression
)(const unsigned int, struct cifs_tcon
*,
312 struct cifsFileInfo
*);
313 /* check if we can send an echo or nor */
314 bool (*can_echo
)(struct TCP_Server_Info
*);
315 /* send echo request */
316 int (*echo
)(struct TCP_Server_Info
*);
317 /* create directory */
318 int (*posix_mkdir
)(const unsigned int xid
, struct inode
*inode
,
319 umode_t mode
, struct cifs_tcon
*tcon
,
320 const char *full_path
,
321 struct cifs_sb_info
*cifs_sb
);
322 int (*mkdir
)(const unsigned int, struct cifs_tcon
*, const char *,
323 struct cifs_sb_info
*);
324 /* set info on created directory */
325 void (*mkdir_setinfo
)(struct inode
*, const char *,
326 struct cifs_sb_info
*, struct cifs_tcon
*,
328 /* remove directory */
329 int (*rmdir
)(const unsigned int, struct cifs_tcon
*, const char *,
330 struct cifs_sb_info
*);
332 int (*unlink
)(const unsigned int, struct cifs_tcon
*, const char *,
333 struct cifs_sb_info
*);
334 /* open, rename and delete file */
335 int (*rename_pending_delete
)(const char *, struct dentry
*,
337 /* send rename request */
338 int (*rename
)(const unsigned int, struct cifs_tcon
*, const char *,
339 const char *, struct cifs_sb_info
*);
340 /* send create hardlink request */
341 int (*create_hardlink
)(const unsigned int, struct cifs_tcon
*,
342 const char *, const char *,
343 struct cifs_sb_info
*);
344 /* query symlink target */
345 int (*query_symlink
)(const unsigned int, struct cifs_tcon
*,
346 const char *, char **, struct cifs_sb_info
*);
347 /* open a file for non-posix mounts */
348 int (*open
)(const unsigned int, struct cifs_open_parms
*,
349 __u32
*, FILE_ALL_INFO
*);
350 /* set fid protocol-specific info */
351 void (*set_fid
)(struct cifsFileInfo
*, struct cifs_fid
*, __u32
);
353 void (*close
)(const unsigned int, struct cifs_tcon
*,
355 /* send a flush request to the server */
356 int (*flush
)(const unsigned int, struct cifs_tcon
*, struct cifs_fid
*);
357 /* async read from the server */
358 int (*async_readv
)(struct cifs_readdata
*);
359 /* async write to the server */
360 int (*async_writev
)(struct cifs_writedata
*,
361 void (*release
)(struct kref
*));
362 /* sync read from the server */
363 int (*sync_read
)(const unsigned int, struct cifs_fid
*,
364 struct cifs_io_parms
*, unsigned int *, char **,
366 /* sync write to the server */
367 int (*sync_write
)(const unsigned int, struct cifs_fid
*,
368 struct cifs_io_parms
*, unsigned int *, struct kvec
*,
370 /* open dir, start readdir */
371 int (*query_dir_first
)(const unsigned int, struct cifs_tcon
*,
372 const char *, struct cifs_sb_info
*,
373 struct cifs_fid
*, __u16
,
374 struct cifs_search_info
*);
375 /* continue readdir */
376 int (*query_dir_next
)(const unsigned int, struct cifs_tcon
*,
378 __u16
, struct cifs_search_info
*srch_inf
);
380 int (*close_dir
)(const unsigned int, struct cifs_tcon
*,
382 /* calculate a size of SMB message */
383 unsigned int (*calc_smb_size
)(void *buf
, struct TCP_Server_Info
*ptcpi
);
384 /* check for STATUS_PENDING and process it in a positive case */
385 bool (*is_status_pending
)(char *, struct TCP_Server_Info
*, int);
386 /* check for STATUS_NETWORK_SESSION_EXPIRED */
387 bool (*is_session_expired
)(char *);
388 /* send oplock break response */
389 int (*oplock_response
)(struct cifs_tcon
*, struct cifs_fid
*,
390 struct cifsInodeInfo
*);
391 /* query remote filesystem */
392 int (*queryfs
)(const unsigned int, struct cifs_tcon
*,
394 /* send mandatory brlock to the server */
395 int (*mand_lock
)(const unsigned int, struct cifsFileInfo
*, __u64
,
396 __u64
, __u32
, int, int, bool);
397 /* unlock range of mandatory locks */
398 int (*mand_unlock_range
)(struct cifsFileInfo
*, struct file_lock
*,
400 /* push brlocks from the cache to the server */
401 int (*push_mand_locks
)(struct cifsFileInfo
*);
402 /* get lease key of the inode */
403 void (*get_lease_key
)(struct inode
*, struct cifs_fid
*);
404 /* set lease key of the inode */
405 void (*set_lease_key
)(struct inode
*, struct cifs_fid
*);
406 /* generate new lease key */
407 void (*new_lease_key
)(struct cifs_fid
*);
408 int (*generate_signingkey
)(struct cifs_ses
*);
409 int (*calc_signature
)(struct smb_rqst
*, struct TCP_Server_Info
*);
410 int (*set_integrity
)(const unsigned int, struct cifs_tcon
*tcon
,
411 struct cifsFileInfo
*src_file
);
412 int (*enum_snapshots
)(const unsigned int xid
, struct cifs_tcon
*tcon
,
413 struct cifsFileInfo
*src_file
, void __user
*);
414 int (*query_mf_symlink
)(unsigned int, struct cifs_tcon
*,
415 struct cifs_sb_info
*, const unsigned char *,
416 char *, unsigned int *);
417 int (*create_mf_symlink
)(unsigned int, struct cifs_tcon
*,
418 struct cifs_sb_info
*, const unsigned char *,
419 char *, unsigned int *);
420 /* if we can do cache read operations */
421 bool (*is_read_op
)(__u32
);
422 /* set oplock level for the inode */
423 void (*set_oplock_level
)(struct cifsInodeInfo
*, __u32
, unsigned int,
425 /* create lease context buffer for CREATE request */
426 char * (*create_lease_buf
)(u8
*, u8
);
427 /* parse lease context buffer and return oplock/epoch info */
428 __u8 (*parse_lease_buf
)(void *buf
, unsigned int *epoch
, char *lkey
);
429 ssize_t (*copychunk_range
)(const unsigned int,
430 struct cifsFileInfo
*src_file
,
431 struct cifsFileInfo
*target_file
,
432 u64 src_off
, u64 len
, u64 dest_off
);
433 int (*duplicate_extents
)(const unsigned int, struct cifsFileInfo
*src
,
434 struct cifsFileInfo
*target_file
, u64 src_off
, u64 len
,
436 int (*validate_negotiate
)(const unsigned int, struct cifs_tcon
*);
437 ssize_t (*query_all_EAs
)(const unsigned int, struct cifs_tcon
*,
438 const unsigned char *, const unsigned char *, char *,
439 size_t, struct cifs_sb_info
*);
440 int (*set_EA
)(const unsigned int, struct cifs_tcon
*, const char *,
441 const char *, const void *, const __u16
,
442 const struct nls_table
*, struct cifs_sb_info
*);
443 struct cifs_ntsd
* (*get_acl
)(struct cifs_sb_info
*, struct inode
*,
444 const char *, u32
*);
445 struct cifs_ntsd
* (*get_acl_by_fid
)(struct cifs_sb_info
*,
446 const struct cifs_fid
*, u32
*);
447 int (*set_acl
)(struct cifs_ntsd
*, __u32
, struct inode
*, const char *,
449 /* writepages retry size */
450 unsigned int (*wp_retry_size
)(struct inode
*);
451 /* get mtu credits */
452 int (*wait_mtu_credits
)(struct TCP_Server_Info
*, unsigned int,
453 unsigned int *, unsigned int *);
454 /* check if we need to issue closedir */
455 bool (*dir_needs_close
)(struct cifsFileInfo
*);
456 long (*fallocate
)(struct file
*, struct cifs_tcon
*, int, loff_t
,
458 /* init transform request - used for encryption for now */
459 int (*init_transform_rq
)(struct TCP_Server_Info
*, struct smb_rqst
*,
461 /* free transform request */
462 void (*free_transform_rq
)(struct smb_rqst
*);
463 int (*is_transform_hdr
)(void *buf
);
464 int (*receive_transform
)(struct TCP_Server_Info
*,
465 struct mid_q_entry
**);
466 enum securityEnum (*select_sectype
)(struct TCP_Server_Info
*,
468 int (*next_header
)(char *);
471 struct smb_version_values
{
472 char *version_string
;
474 __u32 req_capabilities
;
475 __u32 large_lock_type
;
476 __u32 exclusive_lock_type
;
477 __u32 shared_lock_type
;
478 __u32 unlock_lock_type
;
479 size_t header_preamble_size
;
481 size_t max_header_size
;
482 size_t read_rsp_size
;
484 unsigned int cap_unix
;
485 unsigned int cap_nt_find
;
486 unsigned int cap_large_files
;
487 __u16 signing_enabled
;
488 __u16 signing_required
;
489 size_t create_lease_size
;
492 #define HEADER_SIZE(server) (server->vals->header_size)
493 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
500 char *iocharset
; /* local code page for mapping to and from Unicode */
501 char source_rfc1001_name
[RFC1001_NAME_LEN_WITH_NULL
]; /* clnt nb name */
502 char target_rfc1001_name
[RFC1001_NAME_LEN_WITH_NULL
]; /* srvr nb name */
510 enum securityEnum sectype
; /* sectype requested via mnt opts */
511 bool sign
; /* was signing requested via mnt opts? */
515 bool setuidfromacl
:1;
520 bool no_psx_acl
:1; /* set if posix acl support should be disabled */
522 bool backupuid_specified
; /* mount option backupuid is specified */
523 bool backupgid_specified
; /* mount option backupgid is specified */
524 bool no_xattr
:1; /* set if xattr (EA) support should be disabled*/
525 bool server_ino
:1; /* use inode numbers from server ie UniqueId */
527 bool strict_io
:1; /* strict cache behavior */
528 bool remap
:1; /* set to remap seven reserved chars in filenames */
529 bool sfu_remap
:1; /* remap seven reserved chars ala SFU */
530 bool posix_paths
:1; /* unset to not ask for posix pathnames. */
534 bool nullauth
:1; /* attempt to authenticate with null user */
535 bool nocase
:1; /* request case insensitive filenames */
536 bool nobrl
:1; /* disable sending byte range locks to srv */
537 bool nohandlecache
:1; /* disable caching dir handles if srvr probs */
538 bool mand_lock
:1; /* send mandatory not posix byte range lock reqs */
539 bool seal
:1; /* request transport encryption on share */
540 bool nodfs
:1; /* Do not request DFS, even if available */
541 bool local_lease
:1; /* check leases only on local system, not remote */
544 bool nostrictsync
:1; /* do not force expensive SMBflush on every sync */
545 bool fsc
:1; /* enable fscache */
546 bool mfsymlinks
:1; /* use Minshall+French Symlinks */
548 bool rwpidforward
:1; /* pid forward for read/write operations */
552 bool resilient
:1; /* noresilient not required since not fored for CA */
557 bool sockopt_tcp_nodelay
:1;
558 unsigned long actimeo
; /* attribute cache timeout (jiffies) */
559 struct smb_version_operations
*ops
;
560 struct smb_version_values
*vals
;
562 struct sockaddr_storage dstaddr
; /* destination address */
563 struct sockaddr_storage srcaddr
; /* allow binding to a local IP */
564 struct nls_table
*local_nls
;
565 unsigned int echo_interval
; /* echo interval in secs */
566 __u64 snapshot_time
; /* needed for timewarp tokens */
567 unsigned int max_credits
; /* smb3 max_credits 10 < credits < 60000 */
570 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
571 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
572 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
573 CIFS_MOUNT_MAP_SFM_CHR | \
574 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
575 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
576 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
577 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
578 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
579 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
580 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
582 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
583 SB_NODEV | SB_SYNCHRONOUS)
585 struct cifs_mnt_data
{
586 struct cifs_sb_info
*cifs_sb
;
591 static inline unsigned int
592 get_rfc1002_length(void *buf
)
594 return be32_to_cpu(*((__be32
*)buf
)) & 0xffffff;
598 inc_rfc1001_len(void *buf
, int count
)
600 be32_add_cpu((__be32
*)buf
, count
);
603 struct TCP_Server_Info
{
604 struct list_head tcp_ses_list
;
605 struct list_head smb_ses_list
;
606 int srv_count
; /* reference counter */
607 /* 15 character server name + 0x20 16th byte indicating type = srv */
608 char server_RFC1001_name
[RFC1001_NAME_LEN_WITH_NULL
];
609 struct smb_version_operations
*ops
;
610 struct smb_version_values
*vals
;
611 enum statusEnum tcpStatus
; /* what we think the status is */
612 char *hostname
; /* hostname portion of UNC string */
613 struct socket
*ssocket
;
614 struct sockaddr_storage dstaddr
;
615 struct sockaddr_storage srcaddr
; /* locally bind to this IP */
619 wait_queue_head_t response_q
;
620 wait_queue_head_t request_q
; /* if more than maxmpx to srvr must block*/
621 struct list_head pending_mid_q
;
622 bool noblocksnd
; /* use blocking sendmsg */
623 bool noautotune
; /* do not autotune send buf sizes */
625 unsigned int credits
; /* send no more requests at once */
626 unsigned int max_credits
; /* can override large 32000 default at mnt */
627 unsigned int in_flight
; /* number of requests on the wire to server */
628 spinlock_t req_lock
; /* protect the two values above */
629 struct mutex srv_mutex
;
630 struct task_struct
*tsk
;
631 char server_GUID
[16];
633 bool sign
; /* is signing enabled on this connection? */
634 bool session_estab
; /* mark when very first sess is established */
635 int echo_credits
; /* echo reserved slots */
636 int oplock_credits
; /* oplock break reserved slots */
637 bool echoes
:1; /* enable echoes */
638 __u8 client_guid
[SMB2_CLIENT_GUID_SIZE
]; /* Client GUID */
639 u16 dialect
; /* dialect index that server chose */
640 bool oplocks
:1; /* enable oplocks */
641 unsigned int maxReq
; /* Clients should submit no more */
642 /* than maxReq distinct unanswered SMBs to the server when using */
643 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
644 unsigned int maxBuf
; /* maxBuf specifies the maximum */
645 /* message size the server can send or receive for non-raw SMBs */
646 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
647 /* when socket is setup (and during reconnect) before NegProt sent */
648 unsigned int max_rw
; /* maxRw specifies the maximum */
649 /* message size the server can send or receive for */
650 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
651 unsigned int capabilities
; /* selective disabling of caps by smb sess */
652 int timeAdj
; /* Adjust for difference in server time zone in sec */
653 __u64 CurrentMid
; /* multiplex id - rotating counter */
654 char cryptkey
[CIFS_CRYPTO_KEY_SIZE
]; /* used by ntlm, ntlmv2 etc */
655 /* 16th byte of RFC1001 workstation name is always null */
656 char workstation_RFC1001_name
[RFC1001_NAME_LEN_WITH_NULL
];
657 __u32 sequence_number
; /* for signing, protected by srv_mutex */
658 struct session_key session_key
;
659 unsigned long lstrp
; /* when we got last response from this server */
660 struct cifs_secmech secmech
; /* crypto sec mech functs, descriptors */
661 #define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
662 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
663 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
664 char negflavor
; /* NEGOTIATE response flavor */
665 /* extended security flavors that server supports */
666 bool sec_ntlmssp
; /* supports NTLMSSP */
667 bool sec_kerberosu2u
; /* supports U2U Kerberos */
668 bool sec_kerberos
; /* supports plain Kerberos */
669 bool sec_mskerberos
; /* supports legacy MS Kerberos */
670 bool large_buf
; /* is current buffer large? */
671 /* use SMBD connection instead of socket */
673 /* point to the SMBD connection if RDMA is used instead of socket */
674 struct smbd_connection
*smbd_conn
;
675 struct delayed_work echo
; /* echo ping workqueue job */
676 char *smallbuf
; /* pointer to current "small" buffer */
677 char *bigbuf
; /* pointer to current "big" buffer */
678 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
679 unsigned int pdu_size
;
680 unsigned int total_read
; /* total amount of data read in this pass */
681 #ifdef CONFIG_CIFS_FSCACHE
682 struct fscache_cookie
*fscache
; /* client index cache cookie */
684 #ifdef CONFIG_CIFS_STATS2
685 atomic_t in_send
; /* requests trying to send */
686 atomic_t num_waiters
; /* blocked waiting to get in sendrecv */
688 unsigned int max_read
;
689 unsigned int max_write
;
690 #ifdef CONFIG_CIFS_SMB311
692 /* save initital negprot hash */
693 __u8 preauth_sha_hash
[SMB2_PREAUTH_HASH_SIZE
];
694 bool posix_ext_supported
;
696 struct delayed_work reconnect
; /* reconnect workqueue job */
697 struct mutex reconnect_mutex
; /* prevent simultaneous reconnects */
698 unsigned long echo_interval
;
701 static inline unsigned int
702 in_flight(struct TCP_Server_Info
*server
)
705 spin_lock(&server
->req_lock
);
706 num
= server
->in_flight
;
707 spin_unlock(&server
->req_lock
);
712 has_credits(struct TCP_Server_Info
*server
, int *credits
)
715 spin_lock(&server
->req_lock
);
717 spin_unlock(&server
->req_lock
);
722 add_credits(struct TCP_Server_Info
*server
, const unsigned int add
,
725 server
->ops
->add_credits(server
, add
, optype
);
729 add_credits_and_wake_if(struct TCP_Server_Info
*server
, const unsigned int add
,
733 server
->ops
->add_credits(server
, add
, optype
);
734 wake_up(&server
->request_q
);
739 set_credits(struct TCP_Server_Info
*server
, const int val
)
741 server
->ops
->set_credits(server
, val
);
745 get_next_mid64(struct TCP_Server_Info
*server
)
747 return cpu_to_le64(server
->ops
->get_next_mid(server
));
751 get_next_mid(struct TCP_Server_Info
*server
)
753 __u16 mid
= server
->ops
->get_next_mid(server
);
755 * The value in the SMB header should be little endian for easy
756 * on-the-wire decoding.
758 return cpu_to_le16(mid
);
762 get_mid(const struct smb_hdr
*smb
)
764 return le16_to_cpu(smb
->Mid
);
768 compare_mid(__u16 mid
, const struct smb_hdr
*smb
)
770 return mid
== le16_to_cpu(smb
->Mid
);
774 * When the server supports very large reads and writes via POSIX extensions,
775 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
776 * including the RFC1001 length.
778 * Note that this might make for "interesting" allocation problems during
779 * writeback however as we have to allocate an array of pointers for the
780 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
782 * For reads, there is a similar problem as we need to allocate an array
783 * of kvecs to handle the receive, though that should only need to be done
786 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
787 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
790 * When the server doesn't allow large posix writes, only allow a rsize/wsize
791 * of 2^17-1 minus the size of the call header. That allows for a read or
792 * write up to the maximum size described by RFC1002.
794 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
795 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
798 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
799 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
800 * a single wsize request with a single call.
802 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
805 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
806 * those values when posix extensions aren't in force. In actuality here, we
807 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
808 * to be ok with the extra byte even though Windows doesn't send writes that
813 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
815 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
816 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
819 * Macros to allow the TCP_Server_Info->net field and related code to drop out
820 * when CONFIG_NET_NS isn't set.
825 static inline struct net
*cifs_net_ns(struct TCP_Server_Info
*srv
)
830 static inline void cifs_set_net_ns(struct TCP_Server_Info
*srv
, struct net
*net
)
837 static inline struct net
*cifs_net_ns(struct TCP_Server_Info
*srv
)
842 static inline void cifs_set_net_ns(struct TCP_Server_Info
*srv
, struct net
*net
)
848 struct cifs_server_iface
{
850 unsigned int rdma_capable
: 1;
851 unsigned int rss_capable
: 1;
852 struct sockaddr_storage sockaddr
;
856 * Session structure. One of these for each uid session with a particular host
859 struct list_head smb_ses_list
;
860 struct list_head tcon_list
;
861 struct cifs_tcon
*tcon_ipc
;
862 struct mutex session_mutex
;
863 struct TCP_Server_Info
*server
; /* pointer to server info */
864 int ses_count
; /* reference counter */
865 enum statusEnum status
;
866 unsigned overrideSecFlg
; /* if non-zero override global sec flags */
867 char *serverOS
; /* name of operating system underlying server */
868 char *serverNOS
; /* name of network operating system of server */
869 char *serverDomain
; /* security realm of server */
870 __u64 Suid
; /* remote smb uid */
871 kuid_t linux_uid
; /* overriding owner of files on the mount */
872 kuid_t cred_uid
; /* owner of credentials */
873 unsigned int capabilities
;
874 char serverName
[SERVER_NAME_LEN_WITH_NULL
];
875 char *user_name
; /* must not be null except during init of sess
876 and after mount option parsing we fill it */
879 struct session_key auth_key
;
880 struct ntlmssp_auth
*ntlmssp
; /* ciphertext, flags, server challenge */
881 enum securityEnum sectype
; /* what security flavor was specified? */
882 bool sign
; /* is signing required? */
883 bool need_reconnect
:1; /* connection reset, uid now invalid */
886 __u8 smb3signingkey
[SMB3_SIGN_KEY_SIZE
];
887 __u8 smb3encryptionkey
[SMB3_SIGN_KEY_SIZE
];
888 __u8 smb3decryptionkey
[SMB3_SIGN_KEY_SIZE
];
889 #ifdef CONFIG_CIFS_SMB311
890 __u8 preauth_sha_hash
[SMB2_PREAUTH_HASH_SIZE
];
894 * Network interfaces available on the server this session is
897 * Other channels can be opened by connecting and binding this
898 * session to interfaces from this list.
900 * iface_lock should be taken when accessing any of these fields
902 spinlock_t iface_lock
;
903 struct cifs_server_iface
*iface_list
;
905 unsigned long iface_last_update
; /* jiffies */
909 cap_unix(struct cifs_ses
*ses
)
911 return ses
->server
->vals
->cap_unix
& ses
->capabilities
;
915 bool is_valid
:1; /* Do we have a useable root fid */
916 struct cifs_fid
*fid
;
917 struct mutex fid_mutex
;
918 struct cifs_tcon
*tcon
;
919 struct work_struct lease_break
;
923 * there is one of these for each connection to a resource on a particular
927 struct list_head tcon_list
;
929 struct list_head rlist
; /* reconnect list */
930 struct list_head openFileList
;
931 spinlock_t open_file_lock
; /* protects list above */
932 struct cifs_ses
*ses
; /* pointer to session associated with */
933 char treeName
[MAX_TREE_SIZE
+ 1]; /* UNC name of resource in ASCII */
934 char *nativeFileSystem
;
935 char *password
; /* for share-level security */
936 __u32 tid
; /* The 4 byte tree id */
937 __u16 Flags
; /* optional support bits */
938 enum statusEnum tidStatus
;
939 #ifdef CONFIG_CIFS_STATS
940 atomic_t num_smbs_sent
;
945 atomic_t num_flushes
;
946 atomic_t num_oplock_brks
;
949 atomic_t num_deletes
;
951 atomic_t num_posixopens
;
952 atomic_t num_posixmkdirs
;
954 atomic_t num_renames
;
955 atomic_t num_t2renames
;
959 atomic_t num_hardlinks
;
960 atomic_t num_symlinks
;
962 atomic_t num_acl_get
;
963 atomic_t num_acl_set
;
966 atomic_t smb2_com_sent
[NUMBER_OF_SMB2_COMMANDS
];
967 atomic_t smb2_com_failed
[NUMBER_OF_SMB2_COMMANDS
];
970 #ifdef CONFIG_CIFS_STATS2
971 unsigned long long time_writes
;
972 unsigned long long time_reads
;
973 unsigned long long time_opens
;
974 unsigned long long time_deletes
;
975 unsigned long long time_closes
;
976 unsigned long long time_mkdirs
;
977 unsigned long long time_rmdirs
;
978 unsigned long long time_renames
;
979 unsigned long long time_t2renames
;
980 unsigned long long time_ffirst
;
981 unsigned long long time_fnext
;
982 unsigned long long time_fclose
;
983 #endif /* CONFIG_CIFS_STATS2 */
986 spinlock_t stat_lock
; /* protects the two fields above */
987 #endif /* CONFIG_CIFS_STATS */
988 FILE_SYSTEM_DEVICE_INFO fsDevInfo
;
989 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo
; /* ok if fs name truncated */
990 FILE_SYSTEM_UNIX_INFO fsUnixInfo
;
991 bool ipc
:1; /* set if connection to IPC$ share (always also pipe) */
992 bool pipe
:1; /* set if connection to pipe share */
993 bool print
:1; /* set if connection to printer share */
996 bool nohandlecache
:1; /* if strange server resource prob can turn off */
997 bool seal
:1; /* transport encryption for this mounted share */
998 bool unix_ext
:1; /* if false disable Linux extensions to CIFS protocol
999 for this mount even if server would support */
1000 #ifdef CONFIG_CIFS_SMB311
1001 bool posix_extensions
; /* if true SMB3.11 posix extensions enabled */
1002 #endif /* CIFS_311 */
1003 bool local_lease
:1; /* check leases (only) on local system not remote */
1004 bool broken_posix_open
; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1005 bool broken_sparse_sup
; /* if server or share does not support sparse */
1006 bool need_reconnect
:1; /* connection reset, tid now invalid */
1007 bool need_reopen_files
:1; /* need to reopen tcon file handles */
1008 bool use_resilient
:1; /* use resilient instead of durable handles */
1009 bool use_persistent
:1; /* use persistent instead of durable handles */
1010 __le32 capabilities
;
1012 __u32 maximal_access
;
1013 __u32 vol_serial_number
;
1014 __le64 vol_create_time
;
1015 __u64 snapshot_time
; /* for timewarp tokens - timestamp of snapshot */
1016 __u32 ss_flags
; /* sector size flags */
1017 __u32 perf_sector_size
; /* best sector size for perf */
1019 __u32 max_bytes_chunk
;
1020 __u32 max_bytes_copy
;
1021 #ifdef CONFIG_CIFS_FSCACHE
1022 u64 resource_id
; /* server resource id */
1023 struct fscache_cookie
*fscache
; /* cookie for share */
1025 struct list_head pending_opens
; /* list of incomplete opens */
1026 struct cached_fid crfid
; /* Cached root fid */
1027 /* BB add field for back pointer to sb struct(s)? */
1031 * This is a refcounted and timestamped container for a tcon pointer. The
1032 * container holds a tcon reference. It is considered safe to free one of
1033 * these when the tl_count goes to 0. The tl_time is the time of the last
1034 * "get" on the container.
1037 struct rb_node tl_rbnode
;
1039 unsigned long tl_flags
;
1040 #define TCON_LINK_MASTER 0
1041 #define TCON_LINK_PENDING 1
1042 #define TCON_LINK_IN_TREE 2
1043 unsigned long tl_time
;
1045 struct cifs_tcon
*tl_tcon
;
1048 extern struct tcon_link
*cifs_sb_tlink(struct cifs_sb_info
*cifs_sb
);
1050 static inline struct cifs_tcon
*
1051 tlink_tcon(struct tcon_link
*tlink
)
1053 return tlink
->tl_tcon
;
1056 static inline struct tcon_link
*
1057 cifs_sb_master_tlink(struct cifs_sb_info
*cifs_sb
)
1059 return cifs_sb
->master_tlink
;
1062 extern void cifs_put_tlink(struct tcon_link
*tlink
);
1064 static inline struct tcon_link
*
1065 cifs_get_tlink(struct tcon_link
*tlink
)
1067 if (tlink
&& !IS_ERR(tlink
))
1068 atomic_inc(&tlink
->tl_count
);
1072 /* This function is always expected to succeed */
1073 extern struct cifs_tcon
*cifs_sb_master_tcon(struct cifs_sb_info
*cifs_sb
);
1075 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1077 struct cifs_pending_open
{
1078 struct list_head olist
;
1079 struct tcon_link
*tlink
;
1085 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1086 * This is used to track byte stream locks on the file
1088 struct cifsLockInfo
{
1089 struct list_head llist
; /* pointer to next cifsLockInfo */
1090 struct list_head blist
; /* pointer to locks blocked on this */
1091 wait_queue_head_t block_q
;
1099 * One of these for each open instance of a file
1101 struct cifs_search_info
{
1102 loff_t index_of_last_entry
;
1103 __u16 entries_in_buffer
;
1106 char *ntwrk_buf_start
;
1107 char *srch_entries_start
;
1109 const char *presume_name
;
1110 unsigned int resume_name_len
;
1114 bool smallBuf
:1; /* so we know which buf_release function to call */
1117 struct cifs_open_parms
{
1118 struct cifs_tcon
*tcon
;
1119 struct cifs_sb_info
*cifs_sb
;
1124 struct cifs_fid
*fid
;
1131 __u64 persistent_fid
; /* persist file id for smb2 */
1132 __u64 volatile_fid
; /* volatile file id for smb2 */
1133 __u8 lease_key
[SMB2_LEASE_KEY_SIZE
]; /* lease key for smb2 */
1134 __u8 create_guid
[16];
1135 struct cifs_pending_open
*pending_open
;
1140 struct cifs_fid_locks
{
1141 struct list_head llist
;
1142 struct cifsFileInfo
*cfile
; /* fid that owns locks */
1143 struct list_head locks
; /* locks held by fid above */
1146 struct cifsFileInfo
{
1147 /* following two lists are protected by tcon->open_file_lock */
1148 struct list_head tlist
; /* pointer to next fid owned by tcon */
1149 struct list_head flist
; /* next fid (file instance) for this inode */
1150 /* lock list below protected by cifsi->lock_sem */
1151 struct cifs_fid_locks
*llist
; /* brlocks held by this fid */
1152 kuid_t uid
; /* allows finding which FileInfo structure */
1153 __u32 pid
; /* process id who opened file */
1154 struct cifs_fid fid
; /* file id from remote */
1155 struct list_head rlist
; /* reconnect list */
1156 /* BB add lock scope info here if needed */ ;
1157 /* lock scope id (0 if none) */
1158 struct dentry
*dentry
;
1159 struct tcon_link
*tlink
;
1160 unsigned int f_flags
;
1161 bool invalidHandle
:1; /* file closed via session abend */
1162 bool oplock_break_cancelled
:1;
1164 spinlock_t file_info_lock
; /* protects four flag/count fields above */
1165 struct mutex fh_mutex
; /* prevents reopen race after dead ses*/
1166 struct cifs_search_info srch_inf
;
1167 struct work_struct oplock_break
; /* work for oplock breaks */
1170 struct cifs_io_parms
{
1172 __u64 persistent_fid
; /* persist file id for smb2 */
1173 __u64 volatile_fid
; /* volatile file id for smb2 */
1176 unsigned int length
;
1177 struct cifs_tcon
*tcon
;
1180 struct cifs_aio_ctx
{
1181 struct kref refcount
;
1182 struct list_head list
;
1183 struct mutex aio_mutex
;
1184 struct completion done
;
1185 struct iov_iter iter
;
1187 struct cifsFileInfo
*cfile
;
1190 unsigned int npages
;
1193 unsigned int total_len
;
1197 struct cifs_readdata
;
1199 /* asynchronous read support */
1200 struct cifs_readdata
{
1201 struct kref refcount
;
1202 struct list_head list
;
1203 struct completion done
;
1204 struct cifsFileInfo
*cfile
;
1205 struct address_space
*mapping
;
1206 struct cifs_aio_ctx
*ctx
;
1209 unsigned int got_bytes
;
1212 struct work_struct work
;
1213 int (*read_into_pages
)(struct TCP_Server_Info
*server
,
1214 struct cifs_readdata
*rdata
,
1216 int (*copy_into_pages
)(struct TCP_Server_Info
*server
,
1217 struct cifs_readdata
*rdata
,
1218 struct iov_iter
*iter
);
1220 #ifdef CONFIG_CIFS_SMB_DIRECT
1223 unsigned int pagesz
;
1224 unsigned int page_offset
;
1225 unsigned int tailsz
;
1226 unsigned int credits
;
1227 unsigned int nr_pages
;
1228 struct page
**pages
;
1231 struct cifs_writedata
;
1233 /* asynchronous write support */
1234 struct cifs_writedata
{
1235 struct kref refcount
;
1236 struct list_head list
;
1237 struct completion done
;
1238 enum writeback_sync_modes sync_mode
;
1239 struct work_struct work
;
1240 struct cifsFileInfo
*cfile
;
1241 struct cifs_aio_ctx
*ctx
;
1246 #ifdef CONFIG_CIFS_SMB_DIRECT
1249 unsigned int pagesz
;
1250 unsigned int page_offset
;
1251 unsigned int tailsz
;
1252 unsigned int credits
;
1253 unsigned int nr_pages
;
1254 struct page
**pages
;
1258 * Take a reference on the file private data. Must be called with
1259 * cfile->file_info_lock held.
1262 cifsFileInfo_get_locked(struct cifsFileInfo
*cifs_file
)
1267 struct cifsFileInfo
*cifsFileInfo_get(struct cifsFileInfo
*cifs_file
);
1268 void cifsFileInfo_put(struct cifsFileInfo
*cifs_file
);
1270 #define CIFS_CACHE_READ_FLG 1
1271 #define CIFS_CACHE_HANDLE_FLG 2
1272 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1273 #define CIFS_CACHE_WRITE_FLG 4
1274 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1275 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1277 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1278 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1279 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1282 * One of these for each file inode
1285 struct cifsInodeInfo
{
1286 bool can_cache_brlcks
;
1287 struct list_head llist
; /* locks helb by this inode */
1288 struct rw_semaphore lock_sem
; /* protect the fields above */
1289 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1290 struct list_head openFileList
;
1291 __u32 cifsAttrs
; /* e.g. DOS archive bit, sparse, compressed, system */
1292 unsigned int oplock
; /* oplock/lease level we have */
1293 unsigned int epoch
; /* used to track lease state changes */
1294 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1295 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1296 #define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
1297 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1298 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1299 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1300 unsigned long flags
;
1301 spinlock_t writers_lock
;
1302 unsigned int writers
; /* Number of writers on this inode */
1303 unsigned long time
; /* jiffies of last update of inode */
1304 u64 server_eof
; /* current file size on server -- protected by i_lock */
1305 u64 uniqueid
; /* server inode number */
1306 u64 createtime
; /* creation time on server */
1307 __u8 lease_key
[SMB2_LEASE_KEY_SIZE
]; /* lease key for this inode */
1308 #ifdef CONFIG_CIFS_FSCACHE
1309 struct fscache_cookie
*fscache
;
1311 struct inode vfs_inode
;
1314 static inline struct cifsInodeInfo
*
1315 CIFS_I(struct inode
*inode
)
1317 return container_of(inode
, struct cifsInodeInfo
, vfs_inode
);
1320 static inline struct cifs_sb_info
*
1321 CIFS_SB(struct super_block
*sb
)
1323 return sb
->s_fs_info
;
1326 static inline struct cifs_sb_info
*
1327 CIFS_FILE_SB(struct file
*file
)
1329 return CIFS_SB(file_inode(file
)->i_sb
);
1332 static inline char CIFS_DIR_SEP(const struct cifs_sb_info
*cifs_sb
)
1334 if (cifs_sb
->mnt_cifs_flags
& CIFS_MOUNT_POSIX_PATHS
)
1341 convert_delimiter(char *path
, char delim
)
1343 char old_delim
, *pos
;
1351 while ((pos
= strchr(pos
, old_delim
)))
1355 #ifdef CONFIG_CIFS_STATS
1356 #define cifs_stats_inc atomic_inc
1358 static inline void cifs_stats_bytes_written(struct cifs_tcon
*tcon
,
1362 spin_lock(&tcon
->stat_lock
);
1363 tcon
->bytes_written
+= bytes
;
1364 spin_unlock(&tcon
->stat_lock
);
1368 static inline void cifs_stats_bytes_read(struct cifs_tcon
*tcon
,
1371 spin_lock(&tcon
->stat_lock
);
1372 tcon
->bytes_read
+= bytes
;
1373 spin_unlock(&tcon
->stat_lock
);
1377 #define cifs_stats_inc(field) do {} while (0)
1378 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1379 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
1385 * This is the prototype for the mid receive function. This function is for
1386 * receiving the rest of the SMB frame, starting with the WordCount (which is
1387 * just after the MID in struct smb_hdr). Note:
1389 * - This will be called by cifsd, with no locks held.
1390 * - The mid will still be on the pending_mid_q.
1391 * - mid->resp_buf will point to the current buffer.
1393 * Returns zero on a successful receive, or an error. The receive state in
1394 * the TCP_Server_Info will also be updated.
1396 typedef int (mid_receive_t
)(struct TCP_Server_Info
*server
,
1397 struct mid_q_entry
*mid
);
1400 * This is the prototype for the mid callback function. This is called once the
1401 * mid has been received off of the socket. When creating one, take special
1402 * care to avoid deadlocks. Things to bear in mind:
1404 * - it will be called by cifsd, with no locks held
1405 * - the mid will be removed from any lists
1407 typedef void (mid_callback_t
)(struct mid_q_entry
*mid
);
1410 * This is the protopyte for mid handle function. This is called once the mid
1411 * has been recognized after decryption of the message.
1413 typedef int (mid_handle_t
)(struct TCP_Server_Info
*server
,
1414 struct mid_q_entry
*mid
);
1416 /* one of these for every pending CIFS request to the server */
1417 struct mid_q_entry
{
1418 struct list_head qhead
; /* mids waiting on reply from this server */
1419 struct TCP_Server_Info
*server
; /* server corresponding to this mid */
1420 __u64 mid
; /* multiplex id */
1421 __u32 pid
; /* process id */
1422 __u32 sequence_number
; /* for CIFS signing */
1423 unsigned long when_alloc
; /* when mid was created */
1424 #ifdef CONFIG_CIFS_STATS2
1425 unsigned long when_sent
; /* time when smb send finished */
1426 unsigned long when_received
; /* when demux complete (taken off wire) */
1428 mid_receive_t
*receive
; /* call receive callback */
1429 mid_callback_t
*callback
; /* call completion callback */
1430 mid_handle_t
*handle
; /* call handle mid callback */
1431 void *callback_data
; /* general purpose pointer for callback */
1432 void *resp_buf
; /* pointer to received SMB header */
1433 unsigned int resp_buf_size
;
1434 int mid_state
; /* wish this were enum but can not pass to wait_event */
1435 unsigned int mid_flags
;
1436 __le16 command
; /* smb command code */
1437 bool large_buf
:1; /* if valid response, is pointer to large buf */
1438 bool multiRsp
:1; /* multiple trans2 responses for one request */
1439 bool multiEnd
:1; /* both received */
1440 bool decrypted
:1; /* decrypted entry */
1443 struct close_cancelled_open
{
1444 struct cifs_fid fid
;
1445 struct cifs_tcon
*tcon
;
1446 struct work_struct work
;
1449 /* Make code in transport.c a little cleaner by moving
1450 update of optional stats into function below */
1451 #ifdef CONFIG_CIFS_STATS2
1453 static inline void cifs_in_send_inc(struct TCP_Server_Info
*server
)
1455 atomic_inc(&server
->in_send
);
1458 static inline void cifs_in_send_dec(struct TCP_Server_Info
*server
)
1460 atomic_dec(&server
->in_send
);
1463 static inline void cifs_num_waiters_inc(struct TCP_Server_Info
*server
)
1465 atomic_inc(&server
->num_waiters
);
1468 static inline void cifs_num_waiters_dec(struct TCP_Server_Info
*server
)
1470 atomic_dec(&server
->num_waiters
);
1473 static inline void cifs_save_when_sent(struct mid_q_entry
*mid
)
1475 mid
->when_sent
= jiffies
;
1478 static inline void cifs_in_send_inc(struct TCP_Server_Info
*server
)
1481 static inline void cifs_in_send_dec(struct TCP_Server_Info
*server
)
1485 static inline void cifs_num_waiters_inc(struct TCP_Server_Info
*server
)
1489 static inline void cifs_num_waiters_dec(struct TCP_Server_Info
*server
)
1493 static inline void cifs_save_when_sent(struct mid_q_entry
*mid
)
1498 /* for pending dnotify requests */
1499 struct dir_notify_req
{
1500 struct list_head lhead
;
1507 __u32 filter
; /* CompletionFilter (for multishot) */
1512 struct dfs_info3_param
{
1513 int flags
; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1522 * common struct for holding inode info when searching for or updating an
1523 * inode with new info
1526 #define CIFS_FATTR_DFS_REFERRAL 0x1
1527 #define CIFS_FATTR_DELETE_PENDING 0x2
1528 #define CIFS_FATTR_NEED_REVAL 0x4
1529 #define CIFS_FATTR_INO_COLLISION 0x8
1530 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1531 #define CIFS_FATTR_FAKE_ROOT_INO 0x20
1544 unsigned int cf_nlink
;
1545 unsigned int cf_dtype
;
1546 struct timespec cf_atime
;
1547 struct timespec cf_mtime
;
1548 struct timespec cf_ctime
;
1551 static inline void free_dfs_info_param(struct dfs_info3_param
*param
)
1554 kfree(param
->path_name
);
1555 kfree(param
->node_name
);
1560 static inline void free_dfs_info_array(struct dfs_info3_param
*param
,
1561 int number_of_items
)
1564 if ((number_of_items
== 0) || (param
== NULL
))
1566 for (i
= 0; i
< number_of_items
; i
++) {
1567 kfree(param
[i
].path_name
);
1568 kfree(param
[i
].node_name
);
1574 #define MID_REQUEST_ALLOCATED 1
1575 #define MID_REQUEST_SUBMITTED 2
1576 #define MID_RESPONSE_RECEIVED 4
1577 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1578 #define MID_RESPONSE_MALFORMED 0x10
1579 #define MID_SHUTDOWN 0x20
1582 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1584 /* Types of response buffer returned from SendReceive2 */
1585 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1586 #define CIFS_SMALL_BUFFER 1
1587 #define CIFS_LARGE_BUFFER 2
1588 #define CIFS_IOVEC 4 /* array of response buffers */
1590 /* Type of Request to SendReceive2 */
1591 #define CIFS_BLOCKING_OP 1 /* operation can block */
1592 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1593 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1594 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1595 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1596 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1598 /* Type of request operation */
1599 #define CIFS_ECHO_OP 0x080 /* echo request */
1600 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1601 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1602 #define CIFS_OP_MASK 0x0380 /* mask request type */
1604 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1605 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1607 /* Security Flags: indicate type of session setup needed */
1608 #define CIFSSEC_MAY_SIGN 0x00001
1609 #define CIFSSEC_MAY_NTLM 0x00002
1610 #define CIFSSEC_MAY_NTLMV2 0x00004
1611 #define CIFSSEC_MAY_KRB5 0x00008
1612 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1613 #define CIFSSEC_MAY_LANMAN 0x00010
1614 #define CIFSSEC_MAY_PLNTXT 0x00020
1616 #define CIFSSEC_MAY_LANMAN 0
1617 #define CIFSSEC_MAY_PLNTXT 0
1618 #endif /* weak passwords */
1619 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1620 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1622 #define CIFSSEC_MUST_SIGN 0x01001
1623 /* note that only one of the following can be set so the
1624 result of setting MUST flags more than once will be to
1625 require use of the stronger protocol */
1626 #define CIFSSEC_MUST_NTLM 0x02002
1627 #define CIFSSEC_MUST_NTLMV2 0x04004
1628 #define CIFSSEC_MUST_KRB5 0x08008
1629 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1630 #define CIFSSEC_MUST_LANMAN 0x10010
1631 #define CIFSSEC_MUST_PLNTXT 0x20020
1632 #ifdef CONFIG_CIFS_UPCALL
1633 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1635 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1637 #else /* do not allow weak pw hash */
1638 #define CIFSSEC_MUST_LANMAN 0
1639 #define CIFSSEC_MUST_PLNTXT 0
1640 #ifdef CONFIG_CIFS_UPCALL
1641 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1643 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1645 #endif /* WEAK_PW_HASH */
1646 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1647 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1649 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1650 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1651 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1653 *****************************************************************
1654 * All constants go here
1655 *****************************************************************
1658 #define UID_HASH (16)
1661 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1662 * following to be declared.
1665 /****************************************************************************
1666 * Locking notes. All updates to global variables and lists should be
1667 * protected by spinlocks or semaphores.
1671 * GlobalMid_Lock protects:
1672 * list operations on pending_mid_q and oplockQ
1673 * updates to XID counters, multiplex id and SMB sequence numbers
1674 * tcp_ses_lock protects:
1675 * list operations on tcp and SMB session lists
1676 * tcon->open_file_lock protects the list of open files hanging off the tcon
1677 * cfile->file_info_lock protects counters and fields in cifs file struct
1678 * f_owner.lock protects certain per file struct operations
1679 * mapping->page_lock protects certain per page operations
1683 * sesSem operations on smb session
1684 * tconSem operations on tree connection
1685 * fh_sem file handle reconnection operations
1687 ****************************************************************************/
1689 #ifdef DECLARE_GLOBALS_HERE
1690 #define GLOBAL_EXTERN
1692 #define GLOBAL_EXTERN extern
1696 * the list of TCP_Server_Info structures, ie each of the sockets
1697 * connecting our client to a distinct server (ip address), is
1698 * chained together by cifs_tcp_ses_list. The list of all our SMB
1699 * sessions (and from that the tree connections) can be found
1700 * by iterating over cifs_tcp_ses_list
1702 GLOBAL_EXTERN
struct list_head cifs_tcp_ses_list
;
1705 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1706 * tcp session, and the list of tcon's per smb session. It also protects
1707 * the reference counters for the server, smb session, and tcon. Finally,
1708 * changes to the tcon->tidStatus should be done while holding this lock.
1709 * generally the locks should be taken in order tcp_ses_lock before
1710 * tcon->open_file_lock and that before file->file_info_lock since the
1711 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1713 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock
;
1715 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1716 /* Outstanding dir notify requests */
1717 GLOBAL_EXTERN
struct list_head GlobalDnotifyReqList
;
1718 /* DirNotify response queue */
1719 GLOBAL_EXTERN
struct list_head GlobalDnotifyRsp_Q
;
1720 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1723 * Global transaction id (XID) information
1725 GLOBAL_EXTERN
unsigned int GlobalCurrentXid
; /* protected by GlobalMid_Sem */
1726 GLOBAL_EXTERN
unsigned int GlobalTotalActiveXid
; /* prot by GlobalMid_Sem */
1727 GLOBAL_EXTERN
unsigned int GlobalMaxActiveXid
; /* prot by GlobalMid_Sem */
1728 GLOBAL_EXTERN spinlock_t GlobalMid_Lock
; /* protects above & list operations */
1729 /* on midQ entries */
1731 * Global counters, updated atomically
1733 GLOBAL_EXTERN atomic_t sesInfoAllocCount
;
1734 GLOBAL_EXTERN atomic_t tconInfoAllocCount
;
1735 GLOBAL_EXTERN atomic_t tcpSesAllocCount
;
1736 GLOBAL_EXTERN atomic_t tcpSesReconnectCount
;
1737 GLOBAL_EXTERN atomic_t tconInfoReconnectCount
;
1739 /* Various Debug counters */
1740 GLOBAL_EXTERN atomic_t bufAllocCount
; /* current number allocated */
1741 #ifdef CONFIG_CIFS_STATS2
1742 GLOBAL_EXTERN atomic_t totBufAllocCount
; /* total allocated over all time */
1743 GLOBAL_EXTERN atomic_t totSmBufAllocCount
;
1745 GLOBAL_EXTERN atomic_t smBufAllocCount
;
1746 GLOBAL_EXTERN atomic_t midCount
;
1749 extern bool enable_oplocks
; /* enable or disable oplocks */
1750 extern bool lookupCacheEnabled
;
1751 extern unsigned int global_secflags
; /* if on, session setup sent
1752 with more secure ntlmssp2 challenge/resp */
1753 extern unsigned int sign_CIFS_PDUs
; /* enable smb packet signing */
1754 extern bool linuxExtEnabled
;/*enable Linux/Unix CIFS extensions*/
1755 extern unsigned int CIFSMaxBufSize
; /* max size not including hdr */
1756 extern unsigned int cifs_min_rcv
; /* min size of big ntwrk buf pool */
1757 extern unsigned int cifs_min_small
; /* min size of small buf pool */
1758 extern unsigned int cifs_max_pending
; /* MAX requests at once to server*/
1759 extern bool disable_legacy_dialects
; /* forbid vers=1.0 and vers=2.0 mounts */
1761 #ifdef CONFIG_CIFS_ACL
1762 GLOBAL_EXTERN
struct rb_root uidtree
;
1763 GLOBAL_EXTERN
struct rb_root gidtree
;
1764 GLOBAL_EXTERN spinlock_t siduidlock
;
1765 GLOBAL_EXTERN spinlock_t sidgidlock
;
1766 GLOBAL_EXTERN
struct rb_root siduidtree
;
1767 GLOBAL_EXTERN
struct rb_root sidgidtree
;
1768 GLOBAL_EXTERN spinlock_t uidsidlock
;
1769 GLOBAL_EXTERN spinlock_t gidsidlock
;
1770 #endif /* CONFIG_CIFS_ACL */
1772 void cifs_oplock_break(struct work_struct
*work
);
1774 extern const struct slow_work_ops cifs_oplock_break_ops
;
1775 extern struct workqueue_struct
*cifsiod_wq
;
1776 extern struct workqueue_struct
*cifsoplockd_wq
;
1777 extern __u32 cifs_lock_secret
;
1779 extern mempool_t
*cifs_mid_poolp
;
1781 /* Operations for different SMB versions */
1782 #define SMB1_VERSION_STRING "1.0"
1783 extern struct smb_version_operations smb1_operations
;
1784 extern struct smb_version_values smb1_values
;
1785 #define SMB20_VERSION_STRING "2.0"
1786 extern struct smb_version_operations smb20_operations
;
1787 extern struct smb_version_values smb20_values
;
1788 #define SMB21_VERSION_STRING "2.1"
1789 extern struct smb_version_operations smb21_operations
;
1790 extern struct smb_version_values smb21_values
;
1791 #define SMBDEFAULT_VERSION_STRING "default"
1792 extern struct smb_version_values smbdefault_values
;
1793 #define SMB3ANY_VERSION_STRING "3"
1794 extern struct smb_version_values smb3any_values
;
1795 #define SMB30_VERSION_STRING "3.0"
1796 extern struct smb_version_operations smb30_operations
;
1797 extern struct smb_version_values smb30_values
;
1798 #define SMB302_VERSION_STRING "3.02"
1799 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1800 extern struct smb_version_values smb302_values
;
1801 #define SMB311_VERSION_STRING "3.1.1"
1802 #define ALT_SMB311_VERSION_STRING "3.11"
1803 extern struct smb_version_operations smb311_operations
;
1804 extern struct smb_version_values smb311_values
;
1805 #endif /* _CIFS_GLOB_H */