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 * The sizes of various internal tables and strings
39 #define MAX_UID_INFO 16
40 #define MAX_SES_INFO 2
41 #define MAX_TCON_INFO 4
43 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
45 #define CIFS_MIN_RCV_POOL 4
47 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
49 * default attribute cache timeout (jiffies)
51 #define CIFS_DEF_ACTIMEO (1 * HZ)
54 * max attribute cache timeout (jiffies) - 2^30
56 #define CIFS_MAX_ACTIMEO (1 << 30)
59 * MAX_REQ is the maximum number of requests that WE will send
60 * on one socket concurrently.
62 #define CIFS_MAX_REQ 32767
64 #define RFC1001_NAME_LEN 15
65 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
67 /* currently length of NIP6_FMT */
68 #define SERVER_NAME_LENGTH 40
69 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
71 /* echo interval in seconds */
72 #define SMB_ECHO_INTERVAL_MIN 1
73 #define SMB_ECHO_INTERVAL_MAX 600
74 #define SMB_ECHO_INTERVAL_DEFAULT 60
77 * Default number of credits to keep available for SMB3.
78 * This value is chosen somewhat arbitrarily. The Windows client
79 * defaults to 128 credits, the Windows server allows clients up to
80 * 512 credits (or 8K for later versions), and the NetApp server
81 * does not limit clients at all. Choose a high enough default value
82 * such that the client shouldn't limit performance, but allow mount
83 * to override (until you approach 64K, where we limit credits to 65000
84 * to reduce possibility of seeing more server credit overflow bugs.
86 #define SMB2_MAX_CREDITS_AVAILABLE 32000
90 #ifndef XATTR_DOS_ATTRIB
91 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
95 * CIFS vfs client Status information (based on what we know.)
98 /* associated with each tcp and smb session */
108 Unspecified = 0, /* not specified */
109 LANMAN, /* Legacy LANMAN auth */
110 NTLM, /* Legacy NTLM012 auth with NTLM hash */
111 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
112 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
113 Kerberos, /* Kerberos via SPNEGO */
121 /* crypto security descriptor definition */
123 struct shash_desc shash;
127 /* crypto hashing related structure/fields, not specific to a sec mech */
128 struct cifs_secmech {
129 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
130 struct crypto_shash *md5; /* md5 hash function */
131 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
132 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
133 struct crypto_shash *sha512; /* sha512 hash function */
134 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
135 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
136 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
137 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
138 struct sdesc *sdescsha512; /* ctxt to generate smb3.11 signing key */
139 struct crypto_aead *ccmaesencrypt; /* smb3 encryption aead */
140 struct crypto_aead *ccmaesdecrypt; /* smb3 decryption aead */
143 /* per smb session structure/fields */
144 struct ntlmssp_auth {
145 bool sesskey_per_smbsess; /* whether session key is per smb session */
146 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
147 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
148 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
149 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
157 struct cifs_sid osid;
158 struct cifs_sid gsid;
159 struct cifs_ntace *ntaces;
160 struct cifs_ace *aces;
164 *****************************************************************
165 * Except the CIFS PDUs themselves all the
166 * globally interesting structs should go here
167 *****************************************************************
171 * A smb_rqst represents a complete request to be issued to a server. It's
172 * formed by a kvec array, followed by an array of pages. Page data is assumed
173 * to start at the beginning of the first page.
176 struct kvec *rq_iov; /* array of kvecs */
177 unsigned int rq_nvec; /* number of kvecs in array */
178 struct page **rq_pages; /* pointer to array of page ptrs */
179 unsigned int rq_npages; /* number pages in array */
180 unsigned int rq_pagesz; /* page size to use */
181 unsigned int rq_tailsz; /* length of last page */
190 #ifdef CONFIG_CIFS_SMB311
199 struct TCP_Server_Info;
203 struct dfs_info3_param;
207 struct cifs_readdata;
208 struct cifs_writedata;
209 struct cifs_io_parms;
210 struct cifs_search_info;
211 struct cifsInodeInfo;
212 struct cifs_open_parms;
214 struct smb_version_operations {
215 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
216 struct mid_q_entry *);
217 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
218 /* setup request: allocate mid, sign message */
219 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
221 /* setup async request: allocate mid, sign message */
222 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
224 /* check response: verify signature, map error */
225 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
227 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
229 void (*set_credits)(struct TCP_Server_Info *, const int);
230 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
231 unsigned int (*get_credits)(struct mid_q_entry *);
232 __u64 (*get_next_mid)(struct TCP_Server_Info *);
233 /* data offset from read response message */
234 unsigned int (*read_data_offset)(char *);
235 /* data length from read response message */
236 unsigned int (*read_data_length)(char *);
237 /* map smb to linux error */
238 int (*map_error)(char *, bool);
239 /* find mid corresponding to the response message */
240 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
241 void (*dump_detail)(void *);
242 void (*clear_stats)(struct cifs_tcon *);
243 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
244 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
245 /* verify the message */
246 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
247 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
248 int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
249 void (*downgrade_oplock)(struct TCP_Server_Info *server,
250 struct cifsInodeInfo *cinode, __u32 oplock,
251 unsigned int epoch, bool *purge_cache);
252 /* process transaction2 response */
253 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
255 /* check if we need to negotiate */
256 bool (*need_neg)(struct TCP_Server_Info *);
257 /* negotiate to the server */
258 int (*negotiate)(const unsigned int, struct cifs_ses *);
259 /* set negotiated write size */
260 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
261 /* set negotiated read size */
262 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
263 /* setup smb sessionn */
264 int (*sess_setup)(const unsigned int, struct cifs_ses *,
265 const struct nls_table *);
266 /* close smb session */
267 int (*logoff)(const unsigned int, struct cifs_ses *);
268 /* connect to a server share */
269 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
270 struct cifs_tcon *, const struct nls_table *);
271 /* close tree connecion */
272 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
273 /* get DFS referrals */
274 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
275 const char *, struct dfs_info3_param **,
276 unsigned int *, const struct nls_table *, int);
277 /* informational QFS call */
278 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
279 /* check if a path is accessible or not */
280 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
281 struct cifs_sb_info *, const char *);
282 /* query path data from the server */
283 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
284 struct cifs_sb_info *, const char *,
285 FILE_ALL_INFO *, bool *, bool *);
286 /* query file data from the server */
287 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
288 struct cifs_fid *, FILE_ALL_INFO *);
289 /* get server index number */
290 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
291 struct cifs_sb_info *, const char *,
292 u64 *uniqueid, FILE_ALL_INFO *);
293 /* set size by path */
294 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
295 const char *, __u64, struct cifs_sb_info *, bool);
296 /* set size by file handle */
297 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
298 struct cifsFileInfo *, __u64, bool);
300 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
302 int (*set_compression)(const unsigned int, struct cifs_tcon *,
303 struct cifsFileInfo *);
304 /* check if we can send an echo or nor */
305 bool (*can_echo)(struct TCP_Server_Info *);
306 /* send echo request */
307 int (*echo)(struct TCP_Server_Info *);
308 /* create directory */
309 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
310 struct cifs_sb_info *);
311 /* set info on created directory */
312 void (*mkdir_setinfo)(struct inode *, const char *,
313 struct cifs_sb_info *, struct cifs_tcon *,
315 /* remove directory */
316 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
317 struct cifs_sb_info *);
319 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
320 struct cifs_sb_info *);
321 /* open, rename and delete file */
322 int (*rename_pending_delete)(const char *, struct dentry *,
324 /* send rename request */
325 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
326 const char *, struct cifs_sb_info *);
327 /* send create hardlink request */
328 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
329 const char *, const char *,
330 struct cifs_sb_info *);
331 /* query symlink target */
332 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
333 const char *, char **, struct cifs_sb_info *);
334 /* open a file for non-posix mounts */
335 int (*open)(const unsigned int, struct cifs_open_parms *,
336 __u32 *, FILE_ALL_INFO *);
337 /* set fid protocol-specific info */
338 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
340 void (*close)(const unsigned int, struct cifs_tcon *,
342 /* send a flush request to the server */
343 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
344 /* async read from the server */
345 int (*async_readv)(struct cifs_readdata *);
346 /* async write to the server */
347 int (*async_writev)(struct cifs_writedata *,
348 void (*release)(struct kref *));
349 /* sync read from the server */
350 int (*sync_read)(const unsigned int, struct cifs_fid *,
351 struct cifs_io_parms *, unsigned int *, char **,
353 /* sync write to the server */
354 int (*sync_write)(const unsigned int, struct cifs_fid *,
355 struct cifs_io_parms *, unsigned int *, struct kvec *,
357 /* open dir, start readdir */
358 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
359 const char *, struct cifs_sb_info *,
360 struct cifs_fid *, __u16,
361 struct cifs_search_info *);
362 /* continue readdir */
363 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
365 __u16, struct cifs_search_info *srch_inf);
367 int (*close_dir)(const unsigned int, struct cifs_tcon *,
369 /* calculate a size of SMB message */
370 unsigned int (*calc_smb_size)(void *);
371 /* check for STATUS_PENDING and process it in a positive case */
372 bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
373 /* check for STATUS_NETWORK_SESSION_EXPIRED */
374 bool (*is_session_expired)(char *);
375 /* send oplock break response */
376 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
377 struct cifsInodeInfo *);
378 /* query remote filesystem */
379 int (*queryfs)(const unsigned int, struct cifs_tcon *,
381 /* send mandatory brlock to the server */
382 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
383 __u64, __u32, int, int, bool);
384 /* unlock range of mandatory locks */
385 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
387 /* push brlocks from the cache to the server */
388 int (*push_mand_locks)(struct cifsFileInfo *);
389 /* get lease key of the inode */
390 void (*get_lease_key)(struct inode *, struct cifs_fid *);
391 /* set lease key of the inode */
392 void (*set_lease_key)(struct inode *, struct cifs_fid *);
393 /* generate new lease key */
394 void (*new_lease_key)(struct cifs_fid *);
395 int (*generate_signingkey)(struct cifs_ses *);
396 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
397 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
398 struct cifsFileInfo *src_file);
399 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
400 struct cifsFileInfo *src_file, void __user *);
401 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
402 struct cifs_sb_info *, const unsigned char *,
403 char *, unsigned int *);
404 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
405 struct cifs_sb_info *, const unsigned char *,
406 char *, unsigned int *);
407 /* if we can do cache read operations */
408 bool (*is_read_op)(__u32);
409 /* set oplock level for the inode */
410 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
412 /* create lease context buffer for CREATE request */
413 char * (*create_lease_buf)(u8 *, u8);
414 /* parse lease context buffer and return oplock/epoch info */
415 __u8 (*parse_lease_buf)(void *, unsigned int *);
416 ssize_t (*copychunk_range)(const unsigned int,
417 struct cifsFileInfo *src_file,
418 struct cifsFileInfo *target_file,
419 u64 src_off, u64 len, u64 dest_off);
420 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
421 struct cifsFileInfo *target_file, u64 src_off, u64 len,
423 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
424 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
425 const unsigned char *, const unsigned char *, char *,
426 size_t, struct cifs_sb_info *);
427 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
428 const char *, const void *, const __u16,
429 const struct nls_table *, struct cifs_sb_info *);
430 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
431 const char *, u32 *);
432 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
433 const struct cifs_fid *, u32 *);
434 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
436 /* writepages retry size */
437 unsigned int (*wp_retry_size)(struct inode *);
438 /* get mtu credits */
439 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
440 unsigned int *, unsigned int *);
441 /* check if we need to issue closedir */
442 bool (*dir_needs_close)(struct cifsFileInfo *);
443 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
445 /* init transform request - used for encryption for now */
446 int (*init_transform_rq)(struct TCP_Server_Info *, struct smb_rqst *,
448 /* free transform request */
449 void (*free_transform_rq)(struct smb_rqst *);
450 int (*is_transform_hdr)(void *buf);
451 int (*receive_transform)(struct TCP_Server_Info *,
452 struct mid_q_entry **);
453 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
458 struct smb_version_values {
459 char *version_string;
461 __u32 req_capabilities;
462 __u32 large_lock_type;
463 __u32 exclusive_lock_type;
464 __u32 shared_lock_type;
465 __u32 unlock_lock_type;
467 size_t max_header_size;
468 size_t read_rsp_size;
470 unsigned int cap_unix;
471 unsigned int cap_nt_find;
472 unsigned int cap_large_files;
473 __u16 signing_enabled;
474 __u16 signing_required;
475 size_t create_lease_size;
478 #define HEADER_SIZE(server) (server->vals->header_size)
479 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
486 char *iocharset; /* local code page for mapping to and from Unicode */
487 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
488 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
496 enum securityEnum sectype; /* sectype requested via mnt opts */
497 bool sign; /* was signing requested via mnt opts? */
501 bool setuidfromacl:1;
506 bool no_psx_acl:1; /* set if posix acl support should be disabled */
508 bool backupuid_specified; /* mount option backupuid is specified */
509 bool backupgid_specified; /* mount option backupgid is specified */
510 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
511 bool server_ino:1; /* use inode numbers from server ie UniqueId */
513 bool strict_io:1; /* strict cache behavior */
514 bool remap:1; /* set to remap seven reserved chars in filenames */
515 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
516 bool posix_paths:1; /* unset to not ask for posix pathnames. */
519 bool nullauth:1; /* attempt to authenticate with null user */
520 bool nocase:1; /* request case insensitive filenames */
521 bool nobrl:1; /* disable sending byte range locks to srv */
522 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
523 bool seal:1; /* request transport encryption on share */
524 bool nodfs:1; /* Do not request DFS, even if available */
525 bool local_lease:1; /* check leases only on local system, not remote */
528 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
529 bool fsc:1; /* enable fscache */
530 bool mfsymlinks:1; /* use Minshall+French Symlinks */
532 bool rwpidforward:1; /* pid forward for read/write operations */
536 bool resilient:1; /* noresilient not required since not fored for CA */
540 bool sockopt_tcp_nodelay:1;
541 unsigned long actimeo; /* attribute cache timeout (jiffies) */
542 struct smb_version_operations *ops;
543 struct smb_version_values *vals;
545 struct sockaddr_storage dstaddr; /* destination address */
546 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
547 struct nls_table *local_nls;
548 unsigned int echo_interval; /* echo interval in secs */
549 __u64 snapshot_time; /* needed for timewarp tokens */
550 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
553 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
554 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
555 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
556 CIFS_MOUNT_MAP_SFM_CHR | \
557 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
558 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
559 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
560 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
561 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
562 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
563 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
565 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
566 MS_NODEV | MS_SYNCHRONOUS)
568 struct cifs_mnt_data {
569 struct cifs_sb_info *cifs_sb;
574 static inline unsigned int
575 get_rfc1002_length(void *buf)
577 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
581 inc_rfc1001_len(void *buf, int count)
583 be32_add_cpu((__be32 *)buf, count);
586 struct TCP_Server_Info {
587 struct list_head tcp_ses_list;
588 struct list_head smb_ses_list;
589 int srv_count; /* reference counter */
590 /* 15 character server name + 0x20 16th byte indicating type = srv */
591 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
592 struct smb_version_operations *ops;
593 struct smb_version_values *vals;
594 enum statusEnum tcpStatus; /* what we think the status is */
595 char *hostname; /* hostname portion of UNC string */
596 struct socket *ssocket;
597 struct sockaddr_storage dstaddr;
598 struct sockaddr_storage srcaddr; /* locally bind to this IP */
602 wait_queue_head_t response_q;
603 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
604 struct list_head pending_mid_q;
605 bool noblocksnd; /* use blocking sendmsg */
606 bool noautotune; /* do not autotune send buf sizes */
608 unsigned int credits; /* send no more requests at once */
609 unsigned int max_credits; /* can override large 32000 default at mnt */
610 unsigned int in_flight; /* number of requests on the wire to server */
611 spinlock_t req_lock; /* protect the two values above */
612 struct mutex srv_mutex;
613 struct task_struct *tsk;
614 char server_GUID[16];
616 bool sign; /* is signing enabled on this connection? */
617 bool session_estab; /* mark when very first sess is established */
618 int echo_credits; /* echo reserved slots */
619 int oplock_credits; /* oplock break reserved slots */
620 bool echoes:1; /* enable echoes */
621 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
622 u16 dialect; /* dialect index that server chose */
623 bool oplocks:1; /* enable oplocks */
624 unsigned int maxReq; /* Clients should submit no more */
625 /* than maxReq distinct unanswered SMBs to the server when using */
626 /* multiplexed reads or writes */
627 unsigned int maxBuf; /* maxBuf specifies the maximum */
628 /* message size the server can send or receive for non-raw SMBs */
629 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
630 /* when socket is setup (and during reconnect) before NegProt sent */
631 unsigned int max_rw; /* maxRw specifies the maximum */
632 /* message size the server can send or receive for */
633 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
634 unsigned int capabilities; /* selective disabling of caps by smb sess */
635 int timeAdj; /* Adjust for difference in server time zone in sec */
636 __u64 CurrentMid; /* multiplex id - rotating counter */
637 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
638 /* 16th byte of RFC1001 workstation name is always null */
639 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
640 __u32 sequence_number; /* for signing, protected by srv_mutex */
641 struct session_key session_key;
642 unsigned long lstrp; /* when we got last response from this server */
643 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
644 #define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
645 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
646 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
647 char negflavor; /* NEGOTIATE response flavor */
648 /* extended security flavors that server supports */
649 bool sec_ntlmssp; /* supports NTLMSSP */
650 bool sec_kerberosu2u; /* supports U2U Kerberos */
651 bool sec_kerberos; /* supports plain Kerberos */
652 bool sec_mskerberos; /* supports legacy MS Kerberos */
653 bool large_buf; /* is current buffer large? */
654 struct delayed_work echo; /* echo ping workqueue job */
655 char *smallbuf; /* pointer to current "small" buffer */
656 char *bigbuf; /* pointer to current "big" buffer */
657 unsigned int total_read; /* total amount of data read in this pass */
658 #ifdef CONFIG_CIFS_FSCACHE
659 struct fscache_cookie *fscache; /* client index cache cookie */
661 #ifdef CONFIG_CIFS_STATS2
662 atomic_t in_send; /* requests trying to send */
663 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
665 unsigned int max_read;
666 unsigned int max_write;
667 #ifdef CONFIG_CIFS_SMB311
668 __u8 preauth_sha_hash[64]; /* save initital negprot hash */
670 struct delayed_work reconnect; /* reconnect workqueue job */
671 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
672 unsigned long echo_interval;
675 static inline unsigned int
676 in_flight(struct TCP_Server_Info *server)
679 spin_lock(&server->req_lock);
680 num = server->in_flight;
681 spin_unlock(&server->req_lock);
686 has_credits(struct TCP_Server_Info *server, int *credits)
689 spin_lock(&server->req_lock);
691 spin_unlock(&server->req_lock);
696 add_credits(struct TCP_Server_Info *server, const unsigned int add,
699 server->ops->add_credits(server, add, optype);
703 add_credits_and_wake_if(struct TCP_Server_Info *server, const unsigned int add,
707 server->ops->add_credits(server, add, optype);
708 wake_up(&server->request_q);
713 set_credits(struct TCP_Server_Info *server, const int val)
715 server->ops->set_credits(server, val);
719 get_next_mid64(struct TCP_Server_Info *server)
721 return cpu_to_le64(server->ops->get_next_mid(server));
725 get_next_mid(struct TCP_Server_Info *server)
727 __u16 mid = server->ops->get_next_mid(server);
729 * The value in the SMB header should be little endian for easy
730 * on-the-wire decoding.
732 return cpu_to_le16(mid);
736 get_mid(const struct smb_hdr *smb)
738 return le16_to_cpu(smb->Mid);
742 compare_mid(__u16 mid, const struct smb_hdr *smb)
744 return mid == le16_to_cpu(smb->Mid);
748 * When the server supports very large reads and writes via POSIX extensions,
749 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
750 * including the RFC1001 length.
752 * Note that this might make for "interesting" allocation problems during
753 * writeback however as we have to allocate an array of pointers for the
754 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
756 * For reads, there is a similar problem as we need to allocate an array
757 * of kvecs to handle the receive, though that should only need to be done
760 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
761 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
764 * When the server doesn't allow large posix writes, only allow a rsize/wsize
765 * of 2^17-1 minus the size of the call header. That allows for a read or
766 * write up to the maximum size described by RFC1002.
768 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
769 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
772 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
773 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
774 * a single wsize request with a single call.
776 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
779 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
780 * those values when posix extensions aren't in force. In actuality here, we
781 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
782 * to be ok with the extra byte even though Windows doesn't send writes that
787 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
789 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
790 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
793 * Macros to allow the TCP_Server_Info->net field and related code to drop out
794 * when CONFIG_NET_NS isn't set.
799 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
804 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
811 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
816 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
823 * Session structure. One of these for each uid session with a particular host
826 struct list_head smb_ses_list;
827 struct list_head tcon_list;
828 struct mutex session_mutex;
829 struct TCP_Server_Info *server; /* pointer to server info */
830 int ses_count; /* reference counter */
831 enum statusEnum status;
832 unsigned overrideSecFlg; /* if non-zero override global sec flags */
833 __u32 ipc_tid; /* special tid for connection to IPC share */
834 char *serverOS; /* name of operating system underlying server */
835 char *serverNOS; /* name of network operating system of server */
836 char *serverDomain; /* security realm of server */
837 __u64 Suid; /* remote smb uid */
838 kuid_t linux_uid; /* overriding owner of files on the mount */
839 kuid_t cred_uid; /* owner of credentials */
840 unsigned int capabilities;
841 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
842 TCP names - will ipv6 and sctp addresses fit? */
843 char *user_name; /* must not be null except during init of sess
844 and after mount option parsing we fill it */
847 struct session_key auth_key;
848 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
849 enum securityEnum sectype; /* what security flavor was specified? */
850 bool sign; /* is signing required? */
851 bool need_reconnect:1; /* connection reset, uid now invalid */
854 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
855 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
856 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
857 #ifdef CONFIG_CIFS_SMB311
858 __u8 preauth_sha_hash[64];
863 cap_unix(struct cifs_ses *ses)
865 return ses->server->vals->cap_unix & ses->capabilities;
869 * there is one of these for each connection to a resource on a particular
873 struct list_head tcon_list;
875 struct list_head rlist; /* reconnect list */
876 struct list_head openFileList;
877 spinlock_t open_file_lock; /* protects list above */
878 struct cifs_ses *ses; /* pointer to session associated with */
879 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
880 char *nativeFileSystem;
881 char *password; /* for share-level security */
882 __u32 tid; /* The 4 byte tree id */
883 __u16 Flags; /* optional support bits */
884 enum statusEnum tidStatus;
885 #ifdef CONFIG_CIFS_STATS
886 atomic_t num_smbs_sent;
891 atomic_t num_flushes;
892 atomic_t num_oplock_brks;
895 atomic_t num_deletes;
897 atomic_t num_posixopens;
898 atomic_t num_posixmkdirs;
900 atomic_t num_renames;
901 atomic_t num_t2renames;
905 atomic_t num_hardlinks;
906 atomic_t num_symlinks;
908 atomic_t num_acl_get;
909 atomic_t num_acl_set;
912 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
913 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
916 #ifdef CONFIG_CIFS_STATS2
917 unsigned long long time_writes;
918 unsigned long long time_reads;
919 unsigned long long time_opens;
920 unsigned long long time_deletes;
921 unsigned long long time_closes;
922 unsigned long long time_mkdirs;
923 unsigned long long time_rmdirs;
924 unsigned long long time_renames;
925 unsigned long long time_t2renames;
926 unsigned long long time_ffirst;
927 unsigned long long time_fnext;
928 unsigned long long time_fclose;
929 #endif /* CONFIG_CIFS_STATS2 */
932 spinlock_t stat_lock; /* protects the two fields above */
933 #endif /* CONFIG_CIFS_STATS */
934 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
935 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
936 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
937 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
940 bool seal:1; /* transport encryption for this mounted share */
941 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
942 for this mount even if server would support */
943 bool local_lease:1; /* check leases (only) on local system not remote */
944 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
945 bool broken_sparse_sup; /* if server or share does not support sparse */
946 bool need_reconnect:1; /* connection reset, tid now invalid */
947 bool need_reopen_files:1; /* need to reopen tcon file handles */
948 bool use_resilient:1; /* use resilient instead of durable handles */
949 bool use_persistent:1; /* use persistent instead of durable handles */
950 bool print:1; /* set if connection to printer share */
953 __u32 maximal_access;
954 __u32 vol_serial_number;
955 __le64 vol_create_time;
956 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
957 __u32 ss_flags; /* sector size flags */
958 __u32 perf_sector_size; /* best sector size for perf */
960 __u32 max_bytes_chunk;
961 __u32 max_bytes_copy;
962 #ifdef CONFIG_CIFS_FSCACHE
963 u64 resource_id; /* server resource id */
964 struct fscache_cookie *fscache; /* cookie for share */
966 struct list_head pending_opens; /* list of incomplete opens */
967 /* BB add field for back pointer to sb struct(s)? */
971 * This is a refcounted and timestamped container for a tcon pointer. The
972 * container holds a tcon reference. It is considered safe to free one of
973 * these when the tl_count goes to 0. The tl_time is the time of the last
974 * "get" on the container.
977 struct rb_node tl_rbnode;
979 unsigned long tl_flags;
980 #define TCON_LINK_MASTER 0
981 #define TCON_LINK_PENDING 1
982 #define TCON_LINK_IN_TREE 2
983 unsigned long tl_time;
985 struct cifs_tcon *tl_tcon;
988 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
990 static inline struct cifs_tcon *
991 tlink_tcon(struct tcon_link *tlink)
993 return tlink->tl_tcon;
996 extern void cifs_put_tlink(struct tcon_link *tlink);
998 static inline struct tcon_link *
999 cifs_get_tlink(struct tcon_link *tlink)
1001 if (tlink && !IS_ERR(tlink))
1002 atomic_inc(&tlink->tl_count);
1006 /* This function is always expected to succeed */
1007 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1009 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1011 struct cifs_pending_open {
1012 struct list_head olist;
1013 struct tcon_link *tlink;
1019 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1020 * This is used to track byte stream locks on the file
1022 struct cifsLockInfo {
1023 struct list_head llist; /* pointer to next cifsLockInfo */
1024 struct list_head blist; /* pointer to locks blocked on this */
1025 wait_queue_head_t block_q;
1033 * One of these for each open instance of a file
1035 struct cifs_search_info {
1036 loff_t index_of_last_entry;
1037 __u16 entries_in_buffer;
1040 char *ntwrk_buf_start;
1041 char *srch_entries_start;
1043 const char *presume_name;
1044 unsigned int resume_name_len;
1048 bool smallBuf:1; /* so we know which buf_release function to call */
1051 struct cifs_open_parms {
1052 struct cifs_tcon *tcon;
1053 struct cifs_sb_info *cifs_sb;
1058 struct cifs_fid *fid;
1064 __u64 persistent_fid; /* persist file id for smb2 */
1065 __u64 volatile_fid; /* volatile file id for smb2 */
1066 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1067 __u8 create_guid[16];
1068 struct cifs_pending_open *pending_open;
1073 struct cifs_fid_locks {
1074 struct list_head llist;
1075 struct cifsFileInfo *cfile; /* fid that owns locks */
1076 struct list_head locks; /* locks held by fid above */
1079 struct cifsFileInfo {
1080 /* following two lists are protected by tcon->open_file_lock */
1081 struct list_head tlist; /* pointer to next fid owned by tcon */
1082 struct list_head flist; /* next fid (file instance) for this inode */
1083 /* lock list below protected by cifsi->lock_sem */
1084 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1085 kuid_t uid; /* allows finding which FileInfo structure */
1086 __u32 pid; /* process id who opened file */
1087 struct cifs_fid fid; /* file id from remote */
1088 struct list_head rlist; /* reconnect list */
1089 /* BB add lock scope info here if needed */ ;
1090 /* lock scope id (0 if none) */
1091 struct dentry *dentry;
1092 struct tcon_link *tlink;
1093 unsigned int f_flags;
1094 bool invalidHandle:1; /* file closed via session abend */
1095 bool oplock_break_cancelled:1;
1096 unsigned int oplock_epoch; /* epoch from the lease break */
1097 __u32 oplock_level; /* oplock/lease level from the lease break */
1099 spinlock_t file_info_lock; /* protects four flag/count fields above */
1100 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1101 struct cifs_search_info srch_inf;
1102 struct work_struct oplock_break; /* work for oplock breaks */
1105 struct cifs_io_parms {
1107 __u64 persistent_fid; /* persist file id for smb2 */
1108 __u64 volatile_fid; /* volatile file id for smb2 */
1111 unsigned int length;
1112 struct cifs_tcon *tcon;
1115 struct cifs_aio_ctx {
1116 struct kref refcount;
1117 struct list_head list;
1118 struct mutex aio_mutex;
1119 struct completion done;
1120 struct iov_iter iter;
1122 struct cifsFileInfo *cfile;
1125 unsigned int npages;
1128 unsigned int total_len;
1132 struct cifs_readdata;
1134 /* asynchronous read support */
1135 struct cifs_readdata {
1136 struct kref refcount;
1137 struct list_head list;
1138 struct completion done;
1139 struct cifsFileInfo *cfile;
1140 struct address_space *mapping;
1141 struct cifs_aio_ctx *ctx;
1144 unsigned int got_bytes;
1147 struct work_struct work;
1148 int (*read_into_pages)(struct TCP_Server_Info *server,
1149 struct cifs_readdata *rdata,
1151 int (*copy_into_pages)(struct TCP_Server_Info *server,
1152 struct cifs_readdata *rdata,
1153 struct iov_iter *iter);
1155 unsigned int pagesz;
1156 unsigned int tailsz;
1157 unsigned int credits;
1158 unsigned int nr_pages;
1159 struct page *pages[];
1162 struct cifs_writedata;
1164 /* asynchronous write support */
1165 struct cifs_writedata {
1166 struct kref refcount;
1167 struct list_head list;
1168 struct completion done;
1169 enum writeback_sync_modes sync_mode;
1170 struct work_struct work;
1171 struct cifsFileInfo *cfile;
1172 struct cifs_aio_ctx *ctx;
1177 unsigned int pagesz;
1178 unsigned int tailsz;
1179 unsigned int credits;
1180 unsigned int nr_pages;
1181 struct page *pages[];
1185 * Take a reference on the file private data. Must be called with
1186 * cfile->file_info_lock held.
1189 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1194 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1195 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr);
1196 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1198 #define CIFS_CACHE_READ_FLG 1
1199 #define CIFS_CACHE_HANDLE_FLG 2
1200 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1201 #define CIFS_CACHE_WRITE_FLG 4
1202 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1203 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1205 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1206 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1207 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1210 * One of these for each file inode
1213 struct cifsInodeInfo {
1214 bool can_cache_brlcks;
1215 struct list_head llist; /* locks helb by this inode */
1217 * NOTE: Some code paths call down_read(lock_sem) twice, so
1218 * we must always use use cifs_down_write() instead of down_write()
1219 * for this semaphore to avoid deadlocks.
1221 struct rw_semaphore lock_sem; /* protect the fields above */
1222 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1223 struct list_head openFileList;
1224 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1225 unsigned int oplock; /* oplock/lease level we have */
1226 unsigned int epoch; /* used to track lease state changes */
1227 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1228 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1229 #define CIFS_INODE_FLAG_UNUSED (2) /* Unused flag */
1230 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1231 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1232 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1233 unsigned long flags;
1234 spinlock_t writers_lock;
1235 unsigned int writers; /* Number of writers on this inode */
1236 unsigned long time; /* jiffies of last update of inode */
1237 u64 server_eof; /* current file size on server -- protected by i_lock */
1238 u64 uniqueid; /* server inode number */
1239 u64 createtime; /* creation time on server */
1240 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1241 #ifdef CONFIG_CIFS_FSCACHE
1242 struct fscache_cookie *fscache;
1244 struct inode vfs_inode;
1247 static inline struct cifsInodeInfo *
1248 CIFS_I(struct inode *inode)
1250 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1253 static inline struct cifs_sb_info *
1254 CIFS_SB(struct super_block *sb)
1256 return sb->s_fs_info;
1259 static inline struct cifs_sb_info *
1260 CIFS_FILE_SB(struct file *file)
1262 return CIFS_SB(file_inode(file)->i_sb);
1265 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1267 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1274 convert_delimiter(char *path, char delim)
1276 char old_delim, *pos;
1284 while ((pos = strchr(pos, old_delim)))
1288 #ifdef CONFIG_CIFS_STATS
1289 #define cifs_stats_inc atomic_inc
1291 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1295 spin_lock(&tcon->stat_lock);
1296 tcon->bytes_written += bytes;
1297 spin_unlock(&tcon->stat_lock);
1301 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1304 spin_lock(&tcon->stat_lock);
1305 tcon->bytes_read += bytes;
1306 spin_unlock(&tcon->stat_lock);
1310 #define cifs_stats_inc(field) do {} while (0)
1311 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1312 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
1318 * This is the prototype for the mid receive function. This function is for
1319 * receiving the rest of the SMB frame, starting with the WordCount (which is
1320 * just after the MID in struct smb_hdr). Note:
1322 * - This will be called by cifsd, with no locks held.
1323 * - The mid will still be on the pending_mid_q.
1324 * - mid->resp_buf will point to the current buffer.
1326 * Returns zero on a successful receive, or an error. The receive state in
1327 * the TCP_Server_Info will also be updated.
1329 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1330 struct mid_q_entry *mid);
1333 * This is the prototype for the mid callback function. This is called once the
1334 * mid has been received off of the socket. When creating one, take special
1335 * care to avoid deadlocks. Things to bear in mind:
1337 * - it will be called by cifsd, with no locks held
1338 * - the mid will be removed from any lists
1340 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1343 * This is the protopyte for mid handle function. This is called once the mid
1344 * has been recognized after decryption of the message.
1346 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1347 struct mid_q_entry *mid);
1349 /* one of these for every pending CIFS request to the server */
1350 struct mid_q_entry {
1351 struct list_head qhead; /* mids waiting on reply from this server */
1352 struct kref refcount;
1353 struct TCP_Server_Info *server; /* server corresponding to this mid */
1354 __u64 mid; /* multiplex id */
1355 __u32 pid; /* process id */
1356 __u32 sequence_number; /* for CIFS signing */
1357 unsigned long when_alloc; /* when mid was created */
1358 #ifdef CONFIG_CIFS_STATS2
1359 unsigned long when_sent; /* time when smb send finished */
1360 unsigned long when_received; /* when demux complete (taken off wire) */
1362 mid_receive_t *receive; /* call receive callback */
1363 mid_callback_t *callback; /* call completion callback */
1364 mid_handle_t *handle; /* call handle mid callback */
1365 void *callback_data; /* general purpose pointer for callback */
1366 void *resp_buf; /* pointer to received SMB header */
1367 int mid_state; /* wish this were enum but can not pass to wait_event */
1368 unsigned int mid_flags;
1369 __le16 command; /* smb command code */
1370 bool large_buf:1; /* if valid response, is pointer to large buf */
1371 bool multiRsp:1; /* multiple trans2 responses for one request */
1372 bool multiEnd:1; /* both received */
1373 bool decrypted:1; /* decrypted entry */
1376 struct close_cancelled_open {
1377 struct cifs_fid fid;
1378 struct cifs_tcon *tcon;
1379 struct work_struct work;
1382 /* Make code in transport.c a little cleaner by moving
1383 update of optional stats into function below */
1384 #ifdef CONFIG_CIFS_STATS2
1386 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1388 atomic_inc(&server->in_send);
1391 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1393 atomic_dec(&server->in_send);
1396 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1398 atomic_inc(&server->num_waiters);
1401 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1403 atomic_dec(&server->num_waiters);
1406 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1408 mid->when_sent = jiffies;
1411 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1414 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1418 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1422 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1426 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1431 /* for pending dnotify requests */
1432 struct dir_notify_req {
1433 struct list_head lhead;
1440 __u32 filter; /* CompletionFilter (for multishot) */
1445 struct dfs_info3_param {
1446 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1455 * common struct for holding inode info when searching for or updating an
1456 * inode with new info
1459 #define CIFS_FATTR_DFS_REFERRAL 0x1
1460 #define CIFS_FATTR_DELETE_PENDING 0x2
1461 #define CIFS_FATTR_NEED_REVAL 0x4
1462 #define CIFS_FATTR_INO_COLLISION 0x8
1463 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1464 #define CIFS_FATTR_FAKE_ROOT_INO 0x20
1477 unsigned int cf_nlink;
1478 unsigned int cf_dtype;
1479 struct timespec cf_atime;
1480 struct timespec cf_mtime;
1481 struct timespec cf_ctime;
1484 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1487 kfree(param->path_name);
1488 kfree(param->node_name);
1493 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1494 int number_of_items)
1497 if ((number_of_items == 0) || (param == NULL))
1499 for (i = 0; i < number_of_items; i++) {
1500 kfree(param[i].path_name);
1501 kfree(param[i].node_name);
1507 #define MID_REQUEST_ALLOCATED 1
1508 #define MID_REQUEST_SUBMITTED 2
1509 #define MID_RESPONSE_RECEIVED 4
1510 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1511 #define MID_RESPONSE_MALFORMED 0x10
1512 #define MID_SHUTDOWN 0x20
1515 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1517 /* Types of response buffer returned from SendReceive2 */
1518 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1519 #define CIFS_SMALL_BUFFER 1
1520 #define CIFS_LARGE_BUFFER 2
1521 #define CIFS_IOVEC 4 /* array of response buffers */
1523 /* Type of Request to SendReceive2 */
1524 #define CIFS_BLOCKING_OP 1 /* operation can block */
1525 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1526 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1527 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1528 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1529 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1531 /* Type of request operation */
1532 #define CIFS_ECHO_OP 0x080 /* echo request */
1533 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1534 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1535 #define CIFS_OP_MASK 0x0380 /* mask request type */
1537 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1538 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1540 /* Security Flags: indicate type of session setup needed */
1541 #define CIFSSEC_MAY_SIGN 0x00001
1542 #define CIFSSEC_MAY_NTLM 0x00002
1543 #define CIFSSEC_MAY_NTLMV2 0x00004
1544 #define CIFSSEC_MAY_KRB5 0x00008
1545 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1546 #define CIFSSEC_MAY_LANMAN 0x00010
1547 #define CIFSSEC_MAY_PLNTXT 0x00020
1549 #define CIFSSEC_MAY_LANMAN 0
1550 #define CIFSSEC_MAY_PLNTXT 0
1551 #endif /* weak passwords */
1552 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1553 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1555 #define CIFSSEC_MUST_SIGN 0x01001
1556 /* note that only one of the following can be set so the
1557 result of setting MUST flags more than once will be to
1558 require use of the stronger protocol */
1559 #define CIFSSEC_MUST_NTLM 0x02002
1560 #define CIFSSEC_MUST_NTLMV2 0x04004
1561 #define CIFSSEC_MUST_KRB5 0x08008
1562 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1563 #define CIFSSEC_MUST_LANMAN 0x10010
1564 #define CIFSSEC_MUST_PLNTXT 0x20020
1565 #ifdef CONFIG_CIFS_UPCALL
1566 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1568 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1570 #else /* do not allow weak pw hash */
1571 #define CIFSSEC_MUST_LANMAN 0
1572 #define CIFSSEC_MUST_PLNTXT 0
1573 #ifdef CONFIG_CIFS_UPCALL
1574 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1576 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1578 #endif /* WEAK_PW_HASH */
1579 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1580 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1582 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1583 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1584 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1586 *****************************************************************
1587 * All constants go here
1588 *****************************************************************
1591 #define UID_HASH (16)
1594 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1595 * following to be declared.
1598 /****************************************************************************
1599 * Locking notes. All updates to global variables and lists should be
1600 * protected by spinlocks or semaphores.
1604 * GlobalMid_Lock protects:
1605 * list operations on pending_mid_q and oplockQ
1606 * updates to XID counters, multiplex id and SMB sequence numbers
1607 * tcp_ses_lock protects:
1608 * list operations on tcp and SMB session lists
1609 * tcon->open_file_lock protects the list of open files hanging off the tcon
1610 * cfile->file_info_lock protects counters and fields in cifs file struct
1611 * f_owner.lock protects certain per file struct operations
1612 * mapping->page_lock protects certain per page operations
1616 * sesSem operations on smb session
1617 * tconSem operations on tree connection
1618 * fh_sem file handle reconnection operations
1620 ****************************************************************************/
1622 #ifdef DECLARE_GLOBALS_HERE
1623 #define GLOBAL_EXTERN
1625 #define GLOBAL_EXTERN extern
1629 * the list of TCP_Server_Info structures, ie each of the sockets
1630 * connecting our client to a distinct server (ip address), is
1631 * chained together by cifs_tcp_ses_list. The list of all our SMB
1632 * sessions (and from that the tree connections) can be found
1633 * by iterating over cifs_tcp_ses_list
1635 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1638 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1639 * tcp session, and the list of tcon's per smb session. It also protects
1640 * the reference counters for the server, smb session, and tcon. Finally,
1641 * changes to the tcon->tidStatus should be done while holding this lock.
1642 * generally the locks should be taken in order tcp_ses_lock before
1643 * tcon->open_file_lock and that before file->file_info_lock since the
1644 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1646 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1648 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1649 /* Outstanding dir notify requests */
1650 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1651 /* DirNotify response queue */
1652 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1653 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1656 * Global transaction id (XID) information
1658 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1659 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1660 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1661 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1662 /* on midQ entries */
1664 * Global counters, updated atomically
1666 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1667 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1668 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1669 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1670 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1672 /* Various Debug counters */
1673 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1674 #ifdef CONFIG_CIFS_STATS2
1675 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1676 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1678 GLOBAL_EXTERN atomic_t smBufAllocCount;
1679 GLOBAL_EXTERN atomic_t midCount;
1682 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1683 GLOBAL_EXTERN bool lookupCacheEnabled;
1684 GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1685 with more secure ntlmssp2 challenge/resp */
1686 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1687 GLOBAL_EXTERN bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1688 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1689 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1690 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1691 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1693 #ifdef CONFIG_CIFS_ACL
1694 GLOBAL_EXTERN struct rb_root uidtree;
1695 GLOBAL_EXTERN struct rb_root gidtree;
1696 GLOBAL_EXTERN spinlock_t siduidlock;
1697 GLOBAL_EXTERN spinlock_t sidgidlock;
1698 GLOBAL_EXTERN struct rb_root siduidtree;
1699 GLOBAL_EXTERN struct rb_root sidgidtree;
1700 GLOBAL_EXTERN spinlock_t uidsidlock;
1701 GLOBAL_EXTERN spinlock_t gidsidlock;
1702 #endif /* CONFIG_CIFS_ACL */
1704 void cifs_oplock_break(struct work_struct *work);
1705 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
1707 extern const struct slow_work_ops cifs_oplock_break_ops;
1708 extern struct workqueue_struct *cifsiod_wq;
1709 extern struct workqueue_struct *cifsoplockd_wq;
1710 extern __u32 cifs_lock_secret;
1712 extern mempool_t *cifs_mid_poolp;
1714 /* Operations for different SMB versions */
1715 #define SMB1_VERSION_STRING "1.0"
1716 extern struct smb_version_operations smb1_operations;
1717 extern struct smb_version_values smb1_values;
1718 #define SMB20_VERSION_STRING "2.0"
1719 extern struct smb_version_operations smb20_operations;
1720 extern struct smb_version_values smb20_values;
1721 #define SMB21_VERSION_STRING "2.1"
1722 extern struct smb_version_operations smb21_operations;
1723 extern struct smb_version_values smb21_values;
1724 #define SMBDEFAULT_VERSION_STRING "default"
1725 extern struct smb_version_values smbdefault_values;
1726 #define SMB3ANY_VERSION_STRING "3"
1727 extern struct smb_version_values smb3any_values;
1728 #define SMB30_VERSION_STRING "3.0"
1729 extern struct smb_version_operations smb30_operations;
1730 extern struct smb_version_values smb30_values;
1731 #define SMB302_VERSION_STRING "3.02"
1732 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1733 extern struct smb_version_values smb302_values;
1734 #define SMB311_VERSION_STRING "3.1.1"
1735 #define ALT_SMB311_VERSION_STRING "3.11"
1736 extern struct smb_version_operations smb311_operations;
1737 extern struct smb_version_values smb311_values;
1738 #endif /* _CIFS_GLOB_H */