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
79 /* maximum number of PDUs in one compound */
80 #define MAX_COMPOUND 5
83 * Default number of credits to keep available for SMB3.
84 * This value is chosen somewhat arbitrarily. The Windows client
85 * defaults to 128 credits, the Windows server allows clients up to
86 * 512 credits (or 8K for later versions), and the NetApp server
87 * does not limit clients at all. Choose a high enough default value
88 * such that the client shouldn't limit performance, but allow mount
89 * to override (until you approach 64K, where we limit credits to 65000
90 * to reduce possibility of seeing more server credit overflow bugs.
92 #define SMB2_MAX_CREDITS_AVAILABLE 32000
96 #ifndef XATTR_DOS_ATTRIB
97 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
101 * CIFS vfs client Status information (based on what we know.)
104 /* associated with each tcp and smb session */
114 Unspecified = 0, /* not specified */
115 LANMAN, /* Legacy LANMAN auth */
116 NTLM, /* Legacy NTLM012 auth with NTLM hash */
117 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
118 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
119 Kerberos, /* Kerberos via SPNEGO */
127 /* crypto security descriptor definition */
129 struct shash_desc shash;
133 /* crypto hashing related structure/fields, not specific to a sec mech */
134 struct cifs_secmech {
135 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
136 struct crypto_shash *md5; /* md5 hash function */
137 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
138 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
139 struct crypto_shash *sha512; /* sha512 hash function */
140 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
141 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
142 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
143 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
144 struct sdesc *sdescsha512; /* ctxt to generate smb3.11 signing key */
145 struct crypto_aead *ccmaesencrypt; /* smb3 encryption aead */
146 struct crypto_aead *ccmaesdecrypt; /* smb3 decryption aead */
149 /* per smb session structure/fields */
150 struct ntlmssp_auth {
151 bool sesskey_per_smbsess; /* whether session key is per smb session */
152 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
153 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
154 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
155 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
163 struct cifs_sid osid;
164 struct cifs_sid gsid;
165 struct cifs_ntace *ntaces;
166 struct cifs_ace *aces;
170 *****************************************************************
171 * Except the CIFS PDUs themselves all the
172 * globally interesting structs should go here
173 *****************************************************************
177 * A smb_rqst represents a complete request to be issued to a server. It's
178 * formed by a kvec array, followed by an array of pages. Page data is assumed
179 * to start at the beginning of the first page.
182 struct kvec *rq_iov; /* array of kvecs */
183 unsigned int rq_nvec; /* number of kvecs in array */
184 struct page **rq_pages; /* pointer to array of page ptrs */
185 unsigned int rq_offset; /* the offset to the 1st page */
186 unsigned int rq_npages; /* number pages in array */
187 unsigned int rq_pagesz; /* page size to use */
188 unsigned int rq_tailsz; /* length of last page */
204 struct TCP_Server_Info;
208 struct dfs_info3_param;
212 struct cifs_readdata;
213 struct cifs_writedata;
214 struct cifs_io_parms;
215 struct cifs_search_info;
216 struct cifsInodeInfo;
217 struct cifs_open_parms;
219 struct smb_version_operations {
220 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
221 struct mid_q_entry *);
222 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
223 /* setup request: allocate mid, sign message */
224 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
226 /* setup async request: allocate mid, sign message */
227 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
229 /* check response: verify signature, map error */
230 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
232 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
234 void (*set_credits)(struct TCP_Server_Info *, const int);
235 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
236 unsigned int (*get_credits)(struct mid_q_entry *);
237 __u64 (*get_next_mid)(struct TCP_Server_Info *);
238 /* data offset from read response message */
239 unsigned int (*read_data_offset)(char *);
241 * Data length from read response message
242 * When in_remaining is true, the returned data length is in
243 * message field DataRemaining for out-of-band data read (e.g through
244 * Memory Registration RDMA write in SMBD).
245 * Otherwise, the returned data length is in message field DataLength.
247 unsigned int (*read_data_length)(char *, bool in_remaining);
248 /* map smb to linux error */
249 int (*map_error)(char *, bool);
250 /* find mid corresponding to the response message */
251 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
252 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
253 void (*clear_stats)(struct cifs_tcon *);
254 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
255 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
256 /* verify the message */
257 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
258 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
259 int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
260 void (*downgrade_oplock)(struct TCP_Server_Info *,
261 struct cifsInodeInfo *, bool);
262 /* process transaction2 response */
263 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
265 /* check if we need to negotiate */
266 bool (*need_neg)(struct TCP_Server_Info *);
267 /* negotiate to the server */
268 int (*negotiate)(const unsigned int, struct cifs_ses *);
269 /* set negotiated write size */
270 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
271 /* set negotiated read size */
272 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
273 /* setup smb sessionn */
274 int (*sess_setup)(const unsigned int, struct cifs_ses *,
275 const struct nls_table *);
276 /* close smb session */
277 int (*logoff)(const unsigned int, struct cifs_ses *);
278 /* connect to a server share */
279 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
280 struct cifs_tcon *, const struct nls_table *);
281 /* close tree connecion */
282 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
283 /* get DFS referrals */
284 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
285 const char *, struct dfs_info3_param **,
286 unsigned int *, const struct nls_table *, int);
287 /* informational QFS call */
288 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
289 /* check if a path is accessible or not */
290 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
291 struct cifs_sb_info *, const char *);
292 /* query path data from the server */
293 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
294 struct cifs_sb_info *, const char *,
295 FILE_ALL_INFO *, bool *, bool *);
296 /* query file data from the server */
297 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
298 struct cifs_fid *, FILE_ALL_INFO *);
299 /* get server index number */
300 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
301 struct cifs_sb_info *, const char *,
302 u64 *uniqueid, FILE_ALL_INFO *);
303 /* set size by path */
304 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
305 const char *, __u64, struct cifs_sb_info *, bool);
306 /* set size by file handle */
307 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
308 struct cifsFileInfo *, __u64, bool);
310 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
312 int (*set_compression)(const unsigned int, struct cifs_tcon *,
313 struct cifsFileInfo *);
314 /* check if we can send an echo or nor */
315 bool (*can_echo)(struct TCP_Server_Info *);
316 /* send echo request */
317 int (*echo)(struct TCP_Server_Info *);
318 /* create directory */
319 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
320 umode_t mode, struct cifs_tcon *tcon,
321 const char *full_path,
322 struct cifs_sb_info *cifs_sb);
323 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
324 struct cifs_sb_info *);
325 /* set info on created directory */
326 void (*mkdir_setinfo)(struct inode *, const char *,
327 struct cifs_sb_info *, struct cifs_tcon *,
329 /* remove directory */
330 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
331 struct cifs_sb_info *);
333 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
334 struct cifs_sb_info *);
335 /* open, rename and delete file */
336 int (*rename_pending_delete)(const char *, struct dentry *,
338 /* send rename request */
339 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
340 const char *, struct cifs_sb_info *);
341 /* send create hardlink request */
342 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
343 const char *, const char *,
344 struct cifs_sb_info *);
345 /* query symlink target */
346 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
347 const char *, char **, struct cifs_sb_info *);
348 /* open a file for non-posix mounts */
349 int (*open)(const unsigned int, struct cifs_open_parms *,
350 __u32 *, FILE_ALL_INFO *);
351 /* set fid protocol-specific info */
352 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
354 void (*close)(const unsigned int, struct cifs_tcon *,
356 /* send a flush request to the server */
357 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
358 /* async read from the server */
359 int (*async_readv)(struct cifs_readdata *);
360 /* async write to the server */
361 int (*async_writev)(struct cifs_writedata *,
362 void (*release)(struct kref *));
363 /* sync read from the server */
364 int (*sync_read)(const unsigned int, struct cifs_fid *,
365 struct cifs_io_parms *, unsigned int *, char **,
367 /* sync write to the server */
368 int (*sync_write)(const unsigned int, struct cifs_fid *,
369 struct cifs_io_parms *, unsigned int *, struct kvec *,
371 /* open dir, start readdir */
372 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
373 const char *, struct cifs_sb_info *,
374 struct cifs_fid *, __u16,
375 struct cifs_search_info *);
376 /* continue readdir */
377 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
379 __u16, struct cifs_search_info *srch_inf);
381 int (*close_dir)(const unsigned int, struct cifs_tcon *,
383 /* calculate a size of SMB message */
384 unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi);
385 /* check for STATUS_PENDING and process it in a positive case */
386 bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
387 /* check for STATUS_NETWORK_SESSION_EXPIRED */
388 bool (*is_session_expired)(char *);
389 /* send oplock break response */
390 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
391 struct cifsInodeInfo *);
392 /* query remote filesystem */
393 int (*queryfs)(const unsigned int, struct cifs_tcon *,
395 /* send mandatory brlock to the server */
396 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
397 __u64, __u32, int, int, bool);
398 /* unlock range of mandatory locks */
399 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
401 /* push brlocks from the cache to the server */
402 int (*push_mand_locks)(struct cifsFileInfo *);
403 /* get lease key of the inode */
404 void (*get_lease_key)(struct inode *, struct cifs_fid *);
405 /* set lease key of the inode */
406 void (*set_lease_key)(struct inode *, struct cifs_fid *);
407 /* generate new lease key */
408 void (*new_lease_key)(struct cifs_fid *);
409 int (*generate_signingkey)(struct cifs_ses *);
410 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
411 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
412 struct cifsFileInfo *src_file);
413 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
414 struct cifsFileInfo *src_file, void __user *);
415 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
416 struct cifs_sb_info *, const unsigned char *,
417 char *, unsigned int *);
418 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
419 struct cifs_sb_info *, const unsigned char *,
420 char *, unsigned int *);
421 /* if we can do cache read operations */
422 bool (*is_read_op)(__u32);
423 /* set oplock level for the inode */
424 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
426 /* create lease context buffer for CREATE request */
427 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
428 /* parse lease context buffer and return oplock/epoch info */
429 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
430 ssize_t (*copychunk_range)(const unsigned int,
431 struct cifsFileInfo *src_file,
432 struct cifsFileInfo *target_file,
433 u64 src_off, u64 len, u64 dest_off);
434 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
435 struct cifsFileInfo *target_file, u64 src_off, u64 len,
437 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
438 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
439 const unsigned char *, const unsigned char *, char *,
440 size_t, struct cifs_sb_info *);
441 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
442 const char *, const void *, const __u16,
443 const struct nls_table *, struct cifs_sb_info *);
444 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
445 const char *, u32 *);
446 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
447 const struct cifs_fid *, u32 *);
448 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
450 /* writepages retry size */
451 unsigned int (*wp_retry_size)(struct inode *);
452 /* get mtu credits */
453 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
454 unsigned int *, unsigned int *);
455 /* check if we need to issue closedir */
456 bool (*dir_needs_close)(struct cifsFileInfo *);
457 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
459 /* init transform request - used for encryption for now */
460 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
461 struct smb_rqst *, struct smb_rqst *);
462 int (*is_transform_hdr)(void *buf);
463 int (*receive_transform)(struct TCP_Server_Info *,
464 struct mid_q_entry **, char **, int *);
465 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
467 int (*next_header)(char *);
470 struct smb_version_values {
471 char *version_string;
473 __u32 req_capabilities;
474 __u32 large_lock_type;
475 __u32 exclusive_lock_type;
476 __u32 shared_lock_type;
477 __u32 unlock_lock_type;
478 size_t header_preamble_size;
480 size_t max_header_size;
481 size_t read_rsp_size;
483 unsigned int cap_unix;
484 unsigned int cap_nt_find;
485 unsigned int cap_large_files;
486 __u16 signing_enabled;
487 __u16 signing_required;
488 size_t create_lease_size;
491 #define HEADER_SIZE(server) (server->vals->header_size)
492 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
499 char *iocharset; /* local code page for mapping to and from Unicode */
500 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
501 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
509 enum securityEnum sectype; /* sectype requested via mnt opts */
510 bool sign; /* was signing requested via mnt opts? */
514 bool setuidfromacl:1;
519 bool no_psx_acl:1; /* set if posix acl support should be disabled */
521 bool backupuid_specified; /* mount option backupuid is specified */
522 bool backupgid_specified; /* mount option backupgid is specified */
523 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
524 bool server_ino:1; /* use inode numbers from server ie UniqueId */
526 bool strict_io:1; /* strict cache behavior */
527 bool remap:1; /* set to remap seven reserved chars in filenames */
528 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
529 bool posix_paths:1; /* unset to not ask for posix pathnames. */
533 bool nullauth:1; /* attempt to authenticate with null user */
534 bool nocase:1; /* request case insensitive filenames */
535 bool nobrl:1; /* disable sending byte range locks to srv */
536 bool nohandlecache:1; /* disable caching dir handles if srvr probs */
537 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
538 bool seal:1; /* request transport encryption on share */
539 bool nodfs:1; /* Do not request DFS, even if available */
540 bool local_lease:1; /* check leases only on local system, not remote */
543 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
544 bool fsc:1; /* enable fscache */
545 bool mfsymlinks:1; /* use Minshall+French Symlinks */
547 bool rwpidforward:1; /* pid forward for read/write operations */
551 bool resilient:1; /* noresilient not required since not fored for CA */
556 bool sockopt_tcp_nodelay:1;
557 unsigned long actimeo; /* attribute cache timeout (jiffies) */
558 struct smb_version_operations *ops;
559 struct smb_version_values *vals;
561 struct sockaddr_storage dstaddr; /* destination address */
562 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
563 struct nls_table *local_nls;
564 unsigned int echo_interval; /* echo interval in secs */
565 __u64 snapshot_time; /* needed for timewarp tokens */
566 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
569 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
570 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
571 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
572 CIFS_MOUNT_MAP_SFM_CHR | \
573 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
574 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
575 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
576 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
577 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
578 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
579 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
581 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
582 SB_NODEV | SB_SYNCHRONOUS)
584 struct cifs_mnt_data {
585 struct cifs_sb_info *cifs_sb;
590 static inline unsigned int
591 get_rfc1002_length(void *buf)
593 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
597 inc_rfc1001_len(void *buf, int count)
599 be32_add_cpu((__be32 *)buf, count);
602 struct TCP_Server_Info {
603 struct list_head tcp_ses_list;
604 struct list_head smb_ses_list;
605 int srv_count; /* reference counter */
606 /* 15 character server name + 0x20 16th byte indicating type = srv */
607 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
608 struct smb_version_operations *ops;
609 struct smb_version_values *vals;
610 enum statusEnum tcpStatus; /* what we think the status is */
611 char *hostname; /* hostname portion of UNC string */
612 struct socket *ssocket;
613 struct sockaddr_storage dstaddr;
614 struct sockaddr_storage srcaddr; /* locally bind to this IP */
618 wait_queue_head_t response_q;
619 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
620 struct list_head pending_mid_q;
621 bool noblocksnd; /* use blocking sendmsg */
622 bool noautotune; /* do not autotune send buf sizes */
624 unsigned int credits; /* send no more requests at once */
625 unsigned int max_credits; /* can override large 32000 default at mnt */
626 unsigned int in_flight; /* number of requests on the wire to server */
627 spinlock_t req_lock; /* protect the two values above */
628 struct mutex srv_mutex;
629 struct task_struct *tsk;
630 char server_GUID[16];
632 bool sign; /* is signing enabled on this connection? */
633 bool session_estab; /* mark when very first sess is established */
634 int echo_credits; /* echo reserved slots */
635 int oplock_credits; /* oplock break reserved slots */
636 bool echoes:1; /* enable echoes */
637 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
638 u16 dialect; /* dialect index that server chose */
639 bool oplocks:1; /* enable oplocks */
640 unsigned int maxReq; /* Clients should submit no more */
641 /* than maxReq distinct unanswered SMBs to the server when using */
642 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
643 unsigned int maxBuf; /* maxBuf specifies the maximum */
644 /* message size the server can send or receive for non-raw SMBs */
645 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
646 /* when socket is setup (and during reconnect) before NegProt sent */
647 unsigned int max_rw; /* maxRw specifies the maximum */
648 /* message size the server can send or receive for */
649 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
650 unsigned int capabilities; /* selective disabling of caps by smb sess */
651 int timeAdj; /* Adjust for difference in server time zone in sec */
652 __u64 CurrentMid; /* multiplex id - rotating counter */
653 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
654 /* 16th byte of RFC1001 workstation name is always null */
655 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
656 __u32 sequence_number; /* for signing, protected by srv_mutex */
657 struct session_key session_key;
658 unsigned long lstrp; /* when we got last response from this server */
659 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
660 #define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
661 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
662 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
663 char negflavor; /* NEGOTIATE response flavor */
664 /* extended security flavors that server supports */
665 bool sec_ntlmssp; /* supports NTLMSSP */
666 bool sec_kerberosu2u; /* supports U2U Kerberos */
667 bool sec_kerberos; /* supports plain Kerberos */
668 bool sec_mskerberos; /* supports legacy MS Kerberos */
669 bool large_buf; /* is current buffer large? */
670 /* use SMBD connection instead of socket */
672 /* point to the SMBD connection if RDMA is used instead of socket */
673 struct smbd_connection *smbd_conn;
674 struct delayed_work echo; /* echo ping workqueue job */
675 char *smallbuf; /* pointer to current "small" buffer */
676 char *bigbuf; /* pointer to current "big" buffer */
677 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
678 unsigned int pdu_size;
679 unsigned int total_read; /* total amount of data read in this pass */
680 #ifdef CONFIG_CIFS_FSCACHE
681 struct fscache_cookie *fscache; /* client index cache cookie */
683 #ifdef CONFIG_CIFS_STATS2
684 atomic_t in_send; /* requests trying to send */
685 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
686 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
688 unsigned int max_read;
689 unsigned int max_write;
691 /* save initital negprot hash */
692 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
693 bool posix_ext_supported;
694 struct delayed_work reconnect; /* reconnect workqueue job */
695 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
696 unsigned long echo_interval;
699 static inline unsigned int
700 in_flight(struct TCP_Server_Info *server)
703 spin_lock(&server->req_lock);
704 num = server->in_flight;
705 spin_unlock(&server->req_lock);
710 has_credits(struct TCP_Server_Info *server, int *credits)
713 spin_lock(&server->req_lock);
715 spin_unlock(&server->req_lock);
720 add_credits(struct TCP_Server_Info *server, const unsigned int add,
723 server->ops->add_credits(server, add, optype);
727 add_credits_and_wake_if(struct TCP_Server_Info *server, const unsigned int add,
731 server->ops->add_credits(server, add, optype);
732 wake_up(&server->request_q);
737 set_credits(struct TCP_Server_Info *server, const int val)
739 server->ops->set_credits(server, val);
743 get_next_mid64(struct TCP_Server_Info *server)
745 return cpu_to_le64(server->ops->get_next_mid(server));
749 get_next_mid(struct TCP_Server_Info *server)
751 __u16 mid = server->ops->get_next_mid(server);
753 * The value in the SMB header should be little endian for easy
754 * on-the-wire decoding.
756 return cpu_to_le16(mid);
760 get_mid(const struct smb_hdr *smb)
762 return le16_to_cpu(smb->Mid);
766 compare_mid(__u16 mid, const struct smb_hdr *smb)
768 return mid == le16_to_cpu(smb->Mid);
772 * When the server supports very large reads and writes via POSIX extensions,
773 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
774 * including the RFC1001 length.
776 * Note that this might make for "interesting" allocation problems during
777 * writeback however as we have to allocate an array of pointers for the
778 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
780 * For reads, there is a similar problem as we need to allocate an array
781 * of kvecs to handle the receive, though that should only need to be done
784 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
785 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
788 * When the server doesn't allow large posix writes, only allow a rsize/wsize
789 * of 2^17-1 minus the size of the call header. That allows for a read or
790 * write up to the maximum size described by RFC1002.
792 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
793 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
796 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
797 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
798 * a single wsize request with a single call.
800 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
803 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
804 * those values when posix extensions aren't in force. In actuality here, we
805 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
806 * to be ok with the extra byte even though Windows doesn't send writes that
811 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
813 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
814 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
817 * Macros to allow the TCP_Server_Info->net field and related code to drop out
818 * when CONFIG_NET_NS isn't set.
823 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
828 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
835 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
840 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
846 struct cifs_server_iface {
848 unsigned int rdma_capable : 1;
849 unsigned int rss_capable : 1;
850 struct sockaddr_storage sockaddr;
854 * Session structure. One of these for each uid session with a particular host
857 struct list_head smb_ses_list;
858 struct list_head tcon_list;
859 struct cifs_tcon *tcon_ipc;
860 struct mutex session_mutex;
861 struct TCP_Server_Info *server; /* pointer to server info */
862 int ses_count; /* reference counter */
863 enum statusEnum status;
864 unsigned overrideSecFlg; /* if non-zero override global sec flags */
865 char *serverOS; /* name of operating system underlying server */
866 char *serverNOS; /* name of network operating system of server */
867 char *serverDomain; /* security realm of server */
868 __u64 Suid; /* remote smb uid */
869 kuid_t linux_uid; /* overriding owner of files on the mount */
870 kuid_t cred_uid; /* owner of credentials */
871 unsigned int capabilities;
872 char serverName[SERVER_NAME_LEN_WITH_NULL];
873 char *user_name; /* must not be null except during init of sess
874 and after mount option parsing we fill it */
877 struct session_key auth_key;
878 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
879 enum securityEnum sectype; /* what security flavor was specified? */
880 bool sign; /* is signing required? */
881 bool need_reconnect:1; /* connection reset, uid now invalid */
884 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
885 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
886 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
887 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
890 * Network interfaces available on the server this session is
893 * Other channels can be opened by connecting and binding this
894 * session to interfaces from this list.
896 * iface_lock should be taken when accessing any of these fields
898 spinlock_t iface_lock;
899 struct cifs_server_iface *iface_list;
901 unsigned long iface_last_update; /* jiffies */
905 cap_unix(struct cifs_ses *ses)
907 return ses->server->vals->cap_unix & ses->capabilities;
911 bool is_valid:1; /* Do we have a useable root fid */
912 struct kref refcount;
913 struct cifs_fid *fid;
914 struct mutex fid_mutex;
915 struct cifs_tcon *tcon;
916 struct work_struct lease_break;
920 * there is one of these for each connection to a resource on a particular
924 struct list_head tcon_list;
926 struct list_head rlist; /* reconnect list */
927 struct list_head openFileList;
928 spinlock_t open_file_lock; /* protects list above */
929 struct cifs_ses *ses; /* pointer to session associated with */
930 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
931 char *nativeFileSystem;
932 char *password; /* for share-level security */
933 __u32 tid; /* The 4 byte tree id */
934 __u16 Flags; /* optional support bits */
935 enum statusEnum tidStatus;
936 atomic_t num_smbs_sent;
941 atomic_t num_flushes;
942 atomic_t num_oplock_brks;
945 atomic_t num_deletes;
947 atomic_t num_posixopens;
948 atomic_t num_posixmkdirs;
950 atomic_t num_renames;
951 atomic_t num_t2renames;
955 atomic_t num_hardlinks;
956 atomic_t num_symlinks;
958 atomic_t num_acl_get;
959 atomic_t num_acl_set;
962 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
963 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
968 spinlock_t stat_lock; /* protects the two fields above */
969 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
970 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
971 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
972 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
973 bool pipe:1; /* set if connection to pipe share */
974 bool print:1; /* set if connection to printer share */
977 bool nohandlecache:1; /* if strange server resource prob can turn off */
978 bool seal:1; /* transport encryption for this mounted share */
979 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
980 for this mount even if server would support */
981 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
982 bool local_lease:1; /* check leases (only) on local system not remote */
983 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
984 bool broken_sparse_sup; /* if server or share does not support sparse */
985 bool need_reconnect:1; /* connection reset, tid now invalid */
986 bool need_reopen_files:1; /* need to reopen tcon file handles */
987 bool use_resilient:1; /* use resilient instead of durable handles */
988 bool use_persistent:1; /* use persistent instead of durable handles */
991 __u32 maximal_access;
992 __u32 vol_serial_number;
993 __le64 vol_create_time;
994 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
995 __u32 ss_flags; /* sector size flags */
996 __u32 perf_sector_size; /* best sector size for perf */
998 __u32 max_bytes_chunk;
999 __u32 max_bytes_copy;
1000 #ifdef CONFIG_CIFS_FSCACHE
1001 u64 resource_id; /* server resource id */
1002 struct fscache_cookie *fscache; /* cookie for share */
1004 struct list_head pending_opens; /* list of incomplete opens */
1005 struct cached_fid crfid; /* Cached root fid */
1006 /* BB add field for back pointer to sb struct(s)? */
1010 * This is a refcounted and timestamped container for a tcon pointer. The
1011 * container holds a tcon reference. It is considered safe to free one of
1012 * these when the tl_count goes to 0. The tl_time is the time of the last
1013 * "get" on the container.
1016 struct rb_node tl_rbnode;
1018 unsigned long tl_flags;
1019 #define TCON_LINK_MASTER 0
1020 #define TCON_LINK_PENDING 1
1021 #define TCON_LINK_IN_TREE 2
1022 unsigned long tl_time;
1024 struct cifs_tcon *tl_tcon;
1027 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1028 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1030 static inline struct cifs_tcon *
1031 tlink_tcon(struct tcon_link *tlink)
1033 return tlink->tl_tcon;
1036 static inline struct tcon_link *
1037 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1039 return cifs_sb->master_tlink;
1042 extern void cifs_put_tlink(struct tcon_link *tlink);
1044 static inline struct tcon_link *
1045 cifs_get_tlink(struct tcon_link *tlink)
1047 if (tlink && !IS_ERR(tlink))
1048 atomic_inc(&tlink->tl_count);
1052 /* This function is always expected to succeed */
1053 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1055 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1057 struct cifs_pending_open {
1058 struct list_head olist;
1059 struct tcon_link *tlink;
1065 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1066 * This is used to track byte stream locks on the file
1068 struct cifsLockInfo {
1069 struct list_head llist; /* pointer to next cifsLockInfo */
1070 struct list_head blist; /* pointer to locks blocked on this */
1071 wait_queue_head_t block_q;
1079 * One of these for each open instance of a file
1081 struct cifs_search_info {
1082 loff_t index_of_last_entry;
1083 __u16 entries_in_buffer;
1086 char *ntwrk_buf_start;
1087 char *srch_entries_start;
1089 const char *presume_name;
1090 unsigned int resume_name_len;
1094 bool smallBuf:1; /* so we know which buf_release function to call */
1097 struct cifs_open_parms {
1098 struct cifs_tcon *tcon;
1099 struct cifs_sb_info *cifs_sb;
1104 struct cifs_fid *fid;
1111 __u64 persistent_fid; /* persist file id for smb2 */
1112 __u64 volatile_fid; /* volatile file id for smb2 */
1113 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1114 __u8 create_guid[16];
1115 struct cifs_pending_open *pending_open;
1120 struct cifs_fid_locks {
1121 struct list_head llist;
1122 struct cifsFileInfo *cfile; /* fid that owns locks */
1123 struct list_head locks; /* locks held by fid above */
1126 struct cifsFileInfo {
1127 /* following two lists are protected by tcon->open_file_lock */
1128 struct list_head tlist; /* pointer to next fid owned by tcon */
1129 struct list_head flist; /* next fid (file instance) for this inode */
1130 /* lock list below protected by cifsi->lock_sem */
1131 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1132 kuid_t uid; /* allows finding which FileInfo structure */
1133 __u32 pid; /* process id who opened file */
1134 struct cifs_fid fid; /* file id from remote */
1135 struct list_head rlist; /* reconnect list */
1136 /* BB add lock scope info here if needed */ ;
1137 /* lock scope id (0 if none) */
1138 struct dentry *dentry;
1139 struct tcon_link *tlink;
1140 unsigned int f_flags;
1141 bool invalidHandle:1; /* file closed via session abend */
1142 bool oplock_break_cancelled:1;
1144 spinlock_t file_info_lock; /* protects four flag/count fields above */
1145 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1146 struct cifs_search_info srch_inf;
1147 struct work_struct oplock_break; /* work for oplock breaks */
1150 struct cifs_io_parms {
1152 __u64 persistent_fid; /* persist file id for smb2 */
1153 __u64 volatile_fid; /* volatile file id for smb2 */
1156 unsigned int length;
1157 struct cifs_tcon *tcon;
1160 struct cifs_aio_ctx {
1161 struct kref refcount;
1162 struct list_head list;
1163 struct mutex aio_mutex;
1164 struct completion done;
1165 struct iov_iter iter;
1167 struct cifsFileInfo *cfile;
1170 unsigned int npages;
1173 unsigned int total_len;
1177 struct cifs_readdata;
1179 /* asynchronous read support */
1180 struct cifs_readdata {
1181 struct kref refcount;
1182 struct list_head list;
1183 struct completion done;
1184 struct cifsFileInfo *cfile;
1185 struct address_space *mapping;
1186 struct cifs_aio_ctx *ctx;
1189 unsigned int got_bytes;
1192 struct work_struct work;
1193 int (*read_into_pages)(struct TCP_Server_Info *server,
1194 struct cifs_readdata *rdata,
1196 int (*copy_into_pages)(struct TCP_Server_Info *server,
1197 struct cifs_readdata *rdata,
1198 struct iov_iter *iter);
1200 #ifdef CONFIG_CIFS_SMB_DIRECT
1203 unsigned int pagesz;
1204 unsigned int page_offset;
1205 unsigned int tailsz;
1206 unsigned int credits;
1207 unsigned int nr_pages;
1208 struct page **pages;
1211 struct cifs_writedata;
1213 /* asynchronous write support */
1214 struct cifs_writedata {
1215 struct kref refcount;
1216 struct list_head list;
1217 struct completion done;
1218 enum writeback_sync_modes sync_mode;
1219 struct work_struct work;
1220 struct cifsFileInfo *cfile;
1221 struct cifs_aio_ctx *ctx;
1226 #ifdef CONFIG_CIFS_SMB_DIRECT
1229 unsigned int pagesz;
1230 unsigned int page_offset;
1231 unsigned int tailsz;
1232 unsigned int credits;
1233 unsigned int nr_pages;
1234 struct page **pages;
1238 * Take a reference on the file private data. Must be called with
1239 * cfile->file_info_lock held.
1242 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1247 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1248 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1250 #define CIFS_CACHE_READ_FLG 1
1251 #define CIFS_CACHE_HANDLE_FLG 2
1252 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1253 #define CIFS_CACHE_WRITE_FLG 4
1254 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1255 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1257 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1258 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1259 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1262 * One of these for each file inode
1265 struct cifsInodeInfo {
1266 bool can_cache_brlcks;
1267 struct list_head llist; /* locks helb by this inode */
1268 struct rw_semaphore lock_sem; /* protect the fields above */
1269 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1270 struct list_head openFileList;
1271 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1272 unsigned int oplock; /* oplock/lease level we have */
1273 unsigned int epoch; /* used to track lease state changes */
1274 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1275 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1276 #define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
1277 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1278 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1279 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1280 unsigned long flags;
1281 spinlock_t writers_lock;
1282 unsigned int writers; /* Number of writers on this inode */
1283 unsigned long time; /* jiffies of last update of inode */
1284 u64 server_eof; /* current file size on server -- protected by i_lock */
1285 u64 uniqueid; /* server inode number */
1286 u64 createtime; /* creation time on server */
1287 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1288 #ifdef CONFIG_CIFS_FSCACHE
1289 struct fscache_cookie *fscache;
1291 struct inode vfs_inode;
1294 static inline struct cifsInodeInfo *
1295 CIFS_I(struct inode *inode)
1297 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1300 static inline struct cifs_sb_info *
1301 CIFS_SB(struct super_block *sb)
1303 return sb->s_fs_info;
1306 static inline struct cifs_sb_info *
1307 CIFS_FILE_SB(struct file *file)
1309 return CIFS_SB(file_inode(file)->i_sb);
1312 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1314 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1321 convert_delimiter(char *path, char delim)
1323 char old_delim, *pos;
1331 while ((pos = strchr(pos, old_delim)))
1335 #define cifs_stats_inc atomic_inc
1337 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1341 spin_lock(&tcon->stat_lock);
1342 tcon->bytes_written += bytes;
1343 spin_unlock(&tcon->stat_lock);
1347 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1350 spin_lock(&tcon->stat_lock);
1351 tcon->bytes_read += bytes;
1352 spin_unlock(&tcon->stat_lock);
1357 * This is the prototype for the mid receive function. This function is for
1358 * receiving the rest of the SMB frame, starting with the WordCount (which is
1359 * just after the MID in struct smb_hdr). Note:
1361 * - This will be called by cifsd, with no locks held.
1362 * - The mid will still be on the pending_mid_q.
1363 * - mid->resp_buf will point to the current buffer.
1365 * Returns zero on a successful receive, or an error. The receive state in
1366 * the TCP_Server_Info will also be updated.
1368 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1369 struct mid_q_entry *mid);
1372 * This is the prototype for the mid callback function. This is called once the
1373 * mid has been received off of the socket. When creating one, take special
1374 * care to avoid deadlocks. Things to bear in mind:
1376 * - it will be called by cifsd, with no locks held
1377 * - the mid will be removed from any lists
1379 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1382 * This is the protopyte for mid handle function. This is called once the mid
1383 * has been recognized after decryption of the message.
1385 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1386 struct mid_q_entry *mid);
1388 /* one of these for every pending CIFS request to the server */
1389 struct mid_q_entry {
1390 struct list_head qhead; /* mids waiting on reply from this server */
1391 struct kref refcount;
1392 struct TCP_Server_Info *server; /* server corresponding to this mid */
1393 __u64 mid; /* multiplex id */
1394 __u32 pid; /* process id */
1395 __u32 sequence_number; /* for CIFS signing */
1396 unsigned long when_alloc; /* when mid was created */
1397 #ifdef CONFIG_CIFS_STATS2
1398 unsigned long when_sent; /* time when smb send finished */
1399 unsigned long when_received; /* when demux complete (taken off wire) */
1401 mid_receive_t *receive; /* call receive callback */
1402 mid_callback_t *callback; /* call completion callback */
1403 mid_handle_t *handle; /* call handle mid callback */
1404 void *callback_data; /* general purpose pointer for callback */
1405 void *resp_buf; /* pointer to received SMB header */
1406 unsigned int resp_buf_size;
1407 int mid_state; /* wish this were enum but can not pass to wait_event */
1408 unsigned int mid_flags;
1409 __le16 command; /* smb command code */
1410 bool large_buf:1; /* if valid response, is pointer to large buf */
1411 bool multiRsp:1; /* multiple trans2 responses for one request */
1412 bool multiEnd:1; /* both received */
1413 bool decrypted:1; /* decrypted entry */
1416 struct close_cancelled_open {
1417 struct cifs_fid fid;
1418 struct cifs_tcon *tcon;
1419 struct work_struct work;
1422 /* Make code in transport.c a little cleaner by moving
1423 update of optional stats into function below */
1424 #ifdef CONFIG_CIFS_STATS2
1426 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1428 atomic_inc(&server->in_send);
1431 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1433 atomic_dec(&server->in_send);
1436 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1438 atomic_inc(&server->num_waiters);
1441 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1443 atomic_dec(&server->num_waiters);
1446 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1448 mid->when_sent = jiffies;
1451 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1454 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1458 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1462 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1466 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1471 /* for pending dnotify requests */
1472 struct dir_notify_req {
1473 struct list_head lhead;
1480 __u32 filter; /* CompletionFilter (for multishot) */
1485 struct dfs_info3_param {
1486 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1495 * common struct for holding inode info when searching for or updating an
1496 * inode with new info
1499 #define CIFS_FATTR_DFS_REFERRAL 0x1
1500 #define CIFS_FATTR_DELETE_PENDING 0x2
1501 #define CIFS_FATTR_NEED_REVAL 0x4
1502 #define CIFS_FATTR_INO_COLLISION 0x8
1503 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1504 #define CIFS_FATTR_FAKE_ROOT_INO 0x20
1517 unsigned int cf_nlink;
1518 unsigned int cf_dtype;
1519 struct timespec64 cf_atime;
1520 struct timespec64 cf_mtime;
1521 struct timespec64 cf_ctime;
1524 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1527 kfree(param->path_name);
1528 kfree(param->node_name);
1533 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1534 int number_of_items)
1537 if ((number_of_items == 0) || (param == NULL))
1539 for (i = 0; i < number_of_items; i++) {
1540 kfree(param[i].path_name);
1541 kfree(param[i].node_name);
1547 #define MID_REQUEST_ALLOCATED 1
1548 #define MID_REQUEST_SUBMITTED 2
1549 #define MID_RESPONSE_RECEIVED 4
1550 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1551 #define MID_RESPONSE_MALFORMED 0x10
1552 #define MID_SHUTDOWN 0x20
1555 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1557 /* Types of response buffer returned from SendReceive2 */
1558 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1559 #define CIFS_SMALL_BUFFER 1
1560 #define CIFS_LARGE_BUFFER 2
1561 #define CIFS_IOVEC 4 /* array of response buffers */
1563 /* Type of Request to SendReceive2 */
1564 #define CIFS_BLOCKING_OP 1 /* operation can block */
1565 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1566 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1567 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1568 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1569 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1571 /* Type of request operation */
1572 #define CIFS_ECHO_OP 0x080 /* echo request */
1573 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1574 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1575 #define CIFS_OP_MASK 0x0380 /* mask request type */
1577 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1578 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1580 /* Security Flags: indicate type of session setup needed */
1581 #define CIFSSEC_MAY_SIGN 0x00001
1582 #define CIFSSEC_MAY_NTLM 0x00002
1583 #define CIFSSEC_MAY_NTLMV2 0x00004
1584 #define CIFSSEC_MAY_KRB5 0x00008
1585 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1586 #define CIFSSEC_MAY_LANMAN 0x00010
1587 #define CIFSSEC_MAY_PLNTXT 0x00020
1589 #define CIFSSEC_MAY_LANMAN 0
1590 #define CIFSSEC_MAY_PLNTXT 0
1591 #endif /* weak passwords */
1592 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1593 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1595 #define CIFSSEC_MUST_SIGN 0x01001
1596 /* note that only one of the following can be set so the
1597 result of setting MUST flags more than once will be to
1598 require use of the stronger protocol */
1599 #define CIFSSEC_MUST_NTLM 0x02002
1600 #define CIFSSEC_MUST_NTLMV2 0x04004
1601 #define CIFSSEC_MUST_KRB5 0x08008
1602 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1603 #define CIFSSEC_MUST_LANMAN 0x10010
1604 #define CIFSSEC_MUST_PLNTXT 0x20020
1605 #ifdef CONFIG_CIFS_UPCALL
1606 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1608 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1610 #else /* do not allow weak pw hash */
1611 #define CIFSSEC_MUST_LANMAN 0
1612 #define CIFSSEC_MUST_PLNTXT 0
1613 #ifdef CONFIG_CIFS_UPCALL
1614 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1616 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1618 #endif /* WEAK_PW_HASH */
1619 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1620 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1622 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1623 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1624 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1626 *****************************************************************
1627 * All constants go here
1628 *****************************************************************
1631 #define UID_HASH (16)
1634 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1635 * following to be declared.
1638 /****************************************************************************
1639 * Locking notes. All updates to global variables and lists should be
1640 * protected by spinlocks or semaphores.
1644 * GlobalMid_Lock protects:
1645 * list operations on pending_mid_q and oplockQ
1646 * updates to XID counters, multiplex id and SMB sequence numbers
1647 * tcp_ses_lock protects:
1648 * list operations on tcp and SMB session lists
1649 * tcon->open_file_lock protects the list of open files hanging off the tcon
1650 * cfile->file_info_lock protects counters and fields in cifs file struct
1651 * f_owner.lock protects certain per file struct operations
1652 * mapping->page_lock protects certain per page operations
1656 * sesSem operations on smb session
1657 * tconSem operations on tree connection
1658 * fh_sem file handle reconnection operations
1660 ****************************************************************************/
1662 #ifdef DECLARE_GLOBALS_HERE
1663 #define GLOBAL_EXTERN
1665 #define GLOBAL_EXTERN extern
1669 * the list of TCP_Server_Info structures, ie each of the sockets
1670 * connecting our client to a distinct server (ip address), is
1671 * chained together by cifs_tcp_ses_list. The list of all our SMB
1672 * sessions (and from that the tree connections) can be found
1673 * by iterating over cifs_tcp_ses_list
1675 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1678 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1679 * tcp session, and the list of tcon's per smb session. It also protects
1680 * the reference counters for the server, smb session, and tcon. Finally,
1681 * changes to the tcon->tidStatus should be done while holding this lock.
1682 * generally the locks should be taken in order tcp_ses_lock before
1683 * tcon->open_file_lock and that before file->file_info_lock since the
1684 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1686 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1688 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1689 /* Outstanding dir notify requests */
1690 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1691 /* DirNotify response queue */
1692 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1693 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1696 * Global transaction id (XID) information
1698 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1699 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1700 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1701 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1702 /* on midQ entries */
1704 * Global counters, updated atomically
1706 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1707 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1708 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1709 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1710 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1712 /* Various Debug counters */
1713 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1714 #ifdef CONFIG_CIFS_STATS2
1715 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1716 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1718 GLOBAL_EXTERN atomic_t smBufAllocCount;
1719 GLOBAL_EXTERN atomic_t midCount;
1722 extern bool enable_oplocks; /* enable or disable oplocks */
1723 extern bool lookupCacheEnabled;
1724 extern unsigned int global_secflags; /* if on, session setup sent
1725 with more secure ntlmssp2 challenge/resp */
1726 extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1727 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1728 extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
1729 extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1730 extern unsigned int cifs_min_small; /* min size of small buf pool */
1731 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1732 extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
1734 #ifdef CONFIG_CIFS_ACL
1735 GLOBAL_EXTERN struct rb_root uidtree;
1736 GLOBAL_EXTERN struct rb_root gidtree;
1737 GLOBAL_EXTERN spinlock_t siduidlock;
1738 GLOBAL_EXTERN spinlock_t sidgidlock;
1739 GLOBAL_EXTERN struct rb_root siduidtree;
1740 GLOBAL_EXTERN struct rb_root sidgidtree;
1741 GLOBAL_EXTERN spinlock_t uidsidlock;
1742 GLOBAL_EXTERN spinlock_t gidsidlock;
1743 #endif /* CONFIG_CIFS_ACL */
1745 void cifs_oplock_break(struct work_struct *work);
1747 extern const struct slow_work_ops cifs_oplock_break_ops;
1748 extern struct workqueue_struct *cifsiod_wq;
1749 extern struct workqueue_struct *cifsoplockd_wq;
1750 extern __u32 cifs_lock_secret;
1752 extern mempool_t *cifs_mid_poolp;
1754 /* Operations for different SMB versions */
1755 #define SMB1_VERSION_STRING "1.0"
1756 extern struct smb_version_operations smb1_operations;
1757 extern struct smb_version_values smb1_values;
1758 #define SMB20_VERSION_STRING "2.0"
1759 extern struct smb_version_operations smb20_operations;
1760 extern struct smb_version_values smb20_values;
1761 #define SMB21_VERSION_STRING "2.1"
1762 extern struct smb_version_operations smb21_operations;
1763 extern struct smb_version_values smb21_values;
1764 #define SMBDEFAULT_VERSION_STRING "default"
1765 extern struct smb_version_values smbdefault_values;
1766 #define SMB3ANY_VERSION_STRING "3"
1767 extern struct smb_version_values smb3any_values;
1768 #define SMB30_VERSION_STRING "3.0"
1769 extern struct smb_version_operations smb30_operations;
1770 extern struct smb_version_values smb30_values;
1771 #define SMB302_VERSION_STRING "3.02"
1772 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1773 extern struct smb_version_values smb302_values;
1774 #define SMB311_VERSION_STRING "3.1.1"
1775 #define ALT_SMB311_VERSION_STRING "3.11"
1776 extern struct smb_version_operations smb311_operations;
1777 extern struct smb_version_values smb311_values;
1778 #endif /* _CIFS_GLOB_H */