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>
32 #ifdef CONFIG_CIFS_SMB2
36 #define CIFS_MAGIC_NUMBER 0xFF534D42 /* the first four bytes of SMB PDUs */
39 * The sizes of various internal tables and strings
41 #define MAX_UID_INFO 16
42 #define MAX_SES_INFO 2
43 #define MAX_TCON_INFO 4
45 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
47 #define CIFS_MIN_RCV_POOL 4
49 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
51 * default attribute cache timeout (jiffies)
53 #define CIFS_DEF_ACTIMEO (1 * HZ)
56 * max attribute cache timeout (jiffies) - 2^30
58 #define CIFS_MAX_ACTIMEO (1 << 30)
61 * MAX_REQ is the maximum number of requests that WE will send
62 * on one socket concurrently.
64 #define CIFS_MAX_REQ 32767
66 #define RFC1001_NAME_LEN 15
67 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
69 /* currently length of NIP6_FMT */
70 #define SERVER_NAME_LENGTH 40
71 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
73 /* echo interval in seconds */
74 #define SMB_ECHO_INTERVAL_MIN 1
75 #define SMB_ECHO_INTERVAL_MAX 600
76 #define SMB_ECHO_INTERVAL_DEFAULT 60
79 * Default number of credits to keep available for SMB3.
80 * This value is chosen somewhat arbitrarily. The Windows client
81 * defaults to 128 credits, the Windows server allows clients up to
82 * 512 credits (or 8K for later versions), and the NetApp server
83 * does not limit clients at all. Choose a high enough default value
84 * such that the client shouldn't limit performance, but allow mount
85 * to override (until you approach 64K, where we limit credits to 65000
86 * to reduce possibility of seeing more server credit overflow bugs.
88 #define SMB2_MAX_CREDITS_AVAILABLE 32000
92 #ifndef XATTR_DOS_ATTRIB
93 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
97 * CIFS vfs client Status information (based on what we know.)
100 /* associated with each tcp and smb session */
110 Unspecified = 0, /* not specified */
111 LANMAN, /* Legacy LANMAN auth */
112 NTLM, /* Legacy NTLM012 auth with NTLM hash */
113 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
114 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
115 Kerberos, /* Kerberos via SPNEGO */
123 /* crypto security descriptor definition */
125 struct shash_desc shash;
129 /* crypto hashing related structure/fields, not specific to a sec mech */
130 struct cifs_secmech {
131 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
132 struct crypto_shash *md5; /* md5 hash function */
133 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
134 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
135 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
136 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
137 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
138 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
141 /* per smb session structure/fields */
142 struct ntlmssp_auth {
143 bool sesskey_per_smbsess; /* whether session key is per smb session */
144 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
145 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
146 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
147 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
155 struct cifs_sid osid;
156 struct cifs_sid gsid;
157 struct cifs_ntace *ntaces;
158 struct cifs_ace *aces;
162 *****************************************************************
163 * Except the CIFS PDUs themselves all the
164 * globally interesting structs should go here
165 *****************************************************************
169 * A smb_rqst represents a complete request to be issued to a server. It's
170 * formed by a kvec array, followed by an array of pages. Page data is assumed
171 * to start at the beginning of the first page.
174 struct kvec *rq_iov; /* array of kvecs */
175 unsigned int rq_nvec; /* number of kvecs in array */
176 struct page **rq_pages; /* pointer to array of page ptrs */
177 unsigned int rq_npages; /* number pages in array */
178 unsigned int rq_pagesz; /* page size to use */
179 unsigned int rq_tailsz; /* length of last page */
188 #ifdef CONFIG_CIFS_SMB311
195 struct TCP_Server_Info;
199 struct dfs_info3_param;
203 struct cifs_readdata;
204 struct cifs_writedata;
205 struct cifs_io_parms;
206 struct cifs_search_info;
207 struct cifsInodeInfo;
208 struct cifs_open_parms;
210 struct smb_version_operations {
211 int (*send_cancel)(struct TCP_Server_Info *, void *,
212 struct mid_q_entry *);
213 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
214 /* setup request: allocate mid, sign message */
215 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
217 /* setup async request: allocate mid, sign message */
218 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
220 /* check response: verify signature, map error */
221 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
223 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
225 void (*set_credits)(struct TCP_Server_Info *, const int);
226 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
227 unsigned int (*get_credits)(struct mid_q_entry *);
228 __u64 (*get_next_mid)(struct TCP_Server_Info *);
229 /* data offset from read response message */
230 unsigned int (*read_data_offset)(char *);
231 /* data length from read response message */
232 unsigned int (*read_data_length)(char *);
233 /* map smb to linux error */
234 int (*map_error)(char *, bool);
235 /* find mid corresponding to the response message */
236 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
237 void (*dump_detail)(void *);
238 void (*clear_stats)(struct cifs_tcon *);
239 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
240 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
241 /* verify the message */
242 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
243 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
244 void (*downgrade_oplock)(struct TCP_Server_Info *,
245 struct cifsInodeInfo *, bool);
246 /* process transaction2 response */
247 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
249 /* check if we need to negotiate */
250 bool (*need_neg)(struct TCP_Server_Info *);
251 /* negotiate to the server */
252 int (*negotiate)(const unsigned int, struct cifs_ses *);
253 /* set negotiated write size */
254 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
255 /* set negotiated read size */
256 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
257 /* setup smb sessionn */
258 int (*sess_setup)(const unsigned int, struct cifs_ses *,
259 const struct nls_table *);
260 /* close smb session */
261 int (*logoff)(const unsigned int, struct cifs_ses *);
262 /* connect to a server share */
263 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
264 struct cifs_tcon *, const struct nls_table *);
265 /* close tree connecion */
266 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
267 /* get DFS referrals */
268 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
269 const char *, struct dfs_info3_param **,
270 unsigned int *, const struct nls_table *, int);
271 /* informational QFS call */
272 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
273 /* check if a path is accessible or not */
274 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
275 struct cifs_sb_info *, const char *);
276 /* query path data from the server */
277 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
278 struct cifs_sb_info *, const char *,
279 FILE_ALL_INFO *, bool *, bool *);
280 /* query file data from the server */
281 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
282 struct cifs_fid *, FILE_ALL_INFO *);
283 /* get server index number */
284 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
285 struct cifs_sb_info *, const char *,
286 u64 *uniqueid, FILE_ALL_INFO *);
287 /* set size by path */
288 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
289 const char *, __u64, struct cifs_sb_info *, bool);
290 /* set size by file handle */
291 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
292 struct cifsFileInfo *, __u64, bool);
294 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
296 int (*set_compression)(const unsigned int, struct cifs_tcon *,
297 struct cifsFileInfo *);
298 /* check if we can send an echo or nor */
299 bool (*can_echo)(struct TCP_Server_Info *);
300 /* send echo request */
301 int (*echo)(struct TCP_Server_Info *);
302 /* create directory */
303 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
304 struct cifs_sb_info *);
305 /* set info on created directory */
306 void (*mkdir_setinfo)(struct inode *, const char *,
307 struct cifs_sb_info *, struct cifs_tcon *,
309 /* remove directory */
310 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
311 struct cifs_sb_info *);
313 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
314 struct cifs_sb_info *);
315 /* open, rename and delete file */
316 int (*rename_pending_delete)(const char *, struct dentry *,
318 /* send rename request */
319 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
320 const char *, struct cifs_sb_info *);
321 /* send create hardlink request */
322 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
323 const char *, const char *,
324 struct cifs_sb_info *);
325 /* query symlink target */
326 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
327 const char *, char **, struct cifs_sb_info *);
328 /* open a file for non-posix mounts */
329 int (*open)(const unsigned int, struct cifs_open_parms *,
330 __u32 *, FILE_ALL_INFO *);
331 /* set fid protocol-specific info */
332 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
334 void (*close)(const unsigned int, struct cifs_tcon *,
336 /* send a flush request to the server */
337 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
338 /* async read from the server */
339 int (*async_readv)(struct cifs_readdata *);
340 /* async write to the server */
341 int (*async_writev)(struct cifs_writedata *,
342 void (*release)(struct kref *));
343 /* sync read from the server */
344 int (*sync_read)(const unsigned int, struct cifs_fid *,
345 struct cifs_io_parms *, unsigned int *, char **,
347 /* sync write to the server */
348 int (*sync_write)(const unsigned int, struct cifs_fid *,
349 struct cifs_io_parms *, unsigned int *, struct kvec *,
351 /* open dir, start readdir */
352 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
353 const char *, struct cifs_sb_info *,
354 struct cifs_fid *, __u16,
355 struct cifs_search_info *);
356 /* continue readdir */
357 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
359 __u16, struct cifs_search_info *srch_inf);
361 int (*close_dir)(const unsigned int, struct cifs_tcon *,
363 /* calculate a size of SMB message */
364 unsigned int (*calc_smb_size)(void *);
365 /* check for STATUS_PENDING and process it in a positive case */
366 bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
367 /* send oplock break response */
368 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
369 struct cifsInodeInfo *);
370 /* query remote filesystem */
371 int (*queryfs)(const unsigned int, struct cifs_tcon *,
373 /* send mandatory brlock to the server */
374 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
375 __u64, __u32, int, int, bool);
376 /* unlock range of mandatory locks */
377 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
379 /* push brlocks from the cache to the server */
380 int (*push_mand_locks)(struct cifsFileInfo *);
381 /* get lease key of the inode */
382 void (*get_lease_key)(struct inode *, struct cifs_fid *);
383 /* set lease key of the inode */
384 void (*set_lease_key)(struct inode *, struct cifs_fid *);
385 /* generate new lease key */
386 void (*new_lease_key)(struct cifs_fid *);
387 int (*generate_signingkey)(struct cifs_ses *);
388 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
389 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
390 struct cifsFileInfo *src_file);
391 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
392 struct cifsFileInfo *src_file, void __user *);
393 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
394 struct cifs_sb_info *, const unsigned char *,
395 char *, unsigned int *);
396 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
397 struct cifs_sb_info *, const unsigned char *,
398 char *, unsigned int *);
399 /* if we can do cache read operations */
400 bool (*is_read_op)(__u32);
401 /* set oplock level for the inode */
402 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
404 /* create lease context buffer for CREATE request */
405 char * (*create_lease_buf)(u8 *, u8);
406 /* parse lease context buffer and return oplock/epoch info */
407 __u8 (*parse_lease_buf)(void *, unsigned int *);
408 int (*clone_range)(const unsigned int, struct cifsFileInfo *src_file,
409 struct cifsFileInfo *target_file, u64 src_off, u64 len,
411 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
412 struct cifsFileInfo *target_file, u64 src_off, u64 len,
414 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
415 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
416 const unsigned char *, const unsigned char *, char *,
417 size_t, const struct nls_table *, int);
418 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
419 const char *, const void *, const __u16,
420 const struct nls_table *, int);
421 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
422 const char *, u32 *);
423 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
424 const struct cifs_fid *, u32 *);
425 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
427 /* writepages retry size */
428 unsigned int (*wp_retry_size)(struct inode *);
429 /* get mtu credits */
430 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
431 unsigned int *, unsigned int *);
432 /* check if we need to issue closedir */
433 bool (*dir_needs_close)(struct cifsFileInfo *);
434 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
438 struct smb_version_values {
439 char *version_string;
441 __u32 req_capabilities;
442 __u32 large_lock_type;
443 __u32 exclusive_lock_type;
444 __u32 shared_lock_type;
445 __u32 unlock_lock_type;
447 size_t max_header_size;
448 size_t read_rsp_size;
450 unsigned int cap_unix;
451 unsigned int cap_nt_find;
452 unsigned int cap_large_files;
453 __u16 signing_enabled;
454 __u16 signing_required;
455 size_t create_lease_size;
458 #define HEADER_SIZE(server) (server->vals->header_size)
459 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
466 char *iocharset; /* local code page for mapping to and from Unicode */
467 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
468 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
476 enum securityEnum sectype; /* sectype requested via mnt opts */
477 bool sign; /* was signing requested via mnt opts? */
481 bool setuidfromacl:1;
486 bool no_psx_acl:1; /* set if posix acl support should be disabled */
488 bool backupuid_specified; /* mount option backupuid is specified */
489 bool backupgid_specified; /* mount option backupgid is specified */
490 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
491 bool server_ino:1; /* use inode numbers from server ie UniqueId */
493 bool strict_io:1; /* strict cache behavior */
494 bool remap:1; /* set to remap seven reserved chars in filenames */
495 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
496 bool posix_paths:1; /* unset to not ask for posix pathnames. */
499 bool nullauth:1; /* attempt to authenticate with null user */
500 bool nocase:1; /* request case insensitive filenames */
501 bool nobrl:1; /* disable sending byte range locks to srv */
502 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
503 bool seal:1; /* request transport encryption on share */
504 bool nodfs:1; /* Do not request DFS, even if available */
505 bool local_lease:1; /* check leases only on local system, not remote */
508 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
509 bool fsc:1; /* enable fscache */
510 bool mfsymlinks:1; /* use Minshall+French Symlinks */
512 bool rwpidforward:1; /* pid forward for read/write operations */
516 bool resilient:1; /* noresilient not required since not fored for CA */
519 bool sockopt_tcp_nodelay:1;
520 unsigned long actimeo; /* attribute cache timeout (jiffies) */
521 struct smb_version_operations *ops;
522 struct smb_version_values *vals;
524 struct sockaddr_storage dstaddr; /* destination address */
525 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
526 struct nls_table *local_nls;
527 unsigned int echo_interval; /* echo interval in secs */
528 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
531 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
532 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
533 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
534 CIFS_MOUNT_MAP_SFM_CHR | \
535 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
536 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
537 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
538 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
539 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
540 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
541 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
543 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
544 MS_NODEV | MS_SYNCHRONOUS)
546 struct cifs_mnt_data {
547 struct cifs_sb_info *cifs_sb;
552 static inline unsigned int
553 get_rfc1002_length(void *buf)
555 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
559 inc_rfc1001_len(void *buf, int count)
561 be32_add_cpu((__be32 *)buf, count);
564 struct TCP_Server_Info {
565 struct list_head tcp_ses_list;
566 struct list_head smb_ses_list;
567 int srv_count; /* reference counter */
568 /* 15 character server name + 0x20 16th byte indicating type = srv */
569 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
570 struct smb_version_operations *ops;
571 struct smb_version_values *vals;
572 enum statusEnum tcpStatus; /* what we think the status is */
573 char *hostname; /* hostname portion of UNC string */
574 struct socket *ssocket;
575 struct sockaddr_storage dstaddr;
576 struct sockaddr_storage srcaddr; /* locally bind to this IP */
580 wait_queue_head_t response_q;
581 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
582 struct list_head pending_mid_q;
583 bool noblocksnd; /* use blocking sendmsg */
584 bool noautotune; /* do not autotune send buf sizes */
586 unsigned int credits; /* send no more requests at once */
587 unsigned int max_credits; /* can override large 32000 default at mnt */
588 unsigned int in_flight; /* number of requests on the wire to server */
589 spinlock_t req_lock; /* protect the two values above */
590 struct mutex srv_mutex;
591 struct task_struct *tsk;
592 char server_GUID[16];
594 bool sign; /* is signing enabled on this connection? */
595 bool session_estab; /* mark when very first sess is established */
596 #ifdef CONFIG_CIFS_SMB2
597 int echo_credits; /* echo reserved slots */
598 int oplock_credits; /* oplock break reserved slots */
599 bool echoes:1; /* enable echoes */
600 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
602 u16 dialect; /* dialect index that server chose */
603 bool oplocks:1; /* enable oplocks */
604 unsigned int maxReq; /* Clients should submit no more */
605 /* than maxReq distinct unanswered SMBs to the server when using */
606 /* multiplexed reads or writes */
607 unsigned int maxBuf; /* maxBuf specifies the maximum */
608 /* message size the server can send or receive for non-raw SMBs */
609 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
610 /* when socket is setup (and during reconnect) before NegProt sent */
611 unsigned int max_rw; /* maxRw specifies the maximum */
612 /* message size the server can send or receive for */
613 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
614 unsigned int capabilities; /* selective disabling of caps by smb sess */
615 int timeAdj; /* Adjust for difference in server time zone in sec */
616 __u64 CurrentMid; /* multiplex id - rotating counter */
617 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
618 /* 16th byte of RFC1001 workstation name is always null */
619 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
620 __u32 sequence_number; /* for signing, protected by srv_mutex */
621 struct session_key session_key;
622 unsigned long lstrp; /* when we got last response from this server */
623 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
624 #define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
625 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
626 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
627 char negflavor; /* NEGOTIATE response flavor */
628 /* extended security flavors that server supports */
629 bool sec_ntlmssp; /* supports NTLMSSP */
630 bool sec_kerberosu2u; /* supports U2U Kerberos */
631 bool sec_kerberos; /* supports plain Kerberos */
632 bool sec_mskerberos; /* supports legacy MS Kerberos */
633 bool large_buf; /* is current buffer large? */
634 struct delayed_work echo; /* echo ping workqueue job */
635 char *smallbuf; /* pointer to current "small" buffer */
636 char *bigbuf; /* pointer to current "big" buffer */
637 unsigned int total_read; /* total amount of data read in this pass */
638 #ifdef CONFIG_CIFS_FSCACHE
639 struct fscache_cookie *fscache; /* client index cache cookie */
641 #ifdef CONFIG_CIFS_STATS2
642 atomic_t in_send; /* requests trying to send */
643 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
645 #ifdef CONFIG_CIFS_SMB2
646 unsigned int max_read;
647 unsigned int max_write;
648 __u8 preauth_hash[512];
649 #endif /* CONFIG_CIFS_SMB2 */
650 unsigned long echo_interval;
653 static inline unsigned int
654 in_flight(struct TCP_Server_Info *server)
657 spin_lock(&server->req_lock);
658 num = server->in_flight;
659 spin_unlock(&server->req_lock);
664 has_credits(struct TCP_Server_Info *server, int *credits)
667 spin_lock(&server->req_lock);
669 spin_unlock(&server->req_lock);
674 add_credits(struct TCP_Server_Info *server, const unsigned int add,
677 server->ops->add_credits(server, add, optype);
681 add_credits_and_wake_if(struct TCP_Server_Info *server, const unsigned int add,
685 server->ops->add_credits(server, add, optype);
686 wake_up(&server->request_q);
691 set_credits(struct TCP_Server_Info *server, const int val)
693 server->ops->set_credits(server, val);
697 get_next_mid64(struct TCP_Server_Info *server)
699 return cpu_to_le64(server->ops->get_next_mid(server));
703 get_next_mid(struct TCP_Server_Info *server)
705 __u16 mid = server->ops->get_next_mid(server);
707 * The value in the SMB header should be little endian for easy
708 * on-the-wire decoding.
710 return cpu_to_le16(mid);
714 get_mid(const struct smb_hdr *smb)
716 return le16_to_cpu(smb->Mid);
720 compare_mid(__u16 mid, const struct smb_hdr *smb)
722 return mid == le16_to_cpu(smb->Mid);
726 * When the server supports very large reads and writes via POSIX extensions,
727 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
728 * including the RFC1001 length.
730 * Note that this might make for "interesting" allocation problems during
731 * writeback however as we have to allocate an array of pointers for the
732 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
734 * For reads, there is a similar problem as we need to allocate an array
735 * of kvecs to handle the receive, though that should only need to be done
738 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
739 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
742 * When the server doesn't allow large posix writes, only allow a rsize/wsize
743 * of 2^17-1 minus the size of the call header. That allows for a read or
744 * write up to the maximum size described by RFC1002.
746 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
747 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
750 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
751 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
752 * a single wsize request with a single call.
754 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
757 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
758 * those values when posix extensions aren't in force. In actuality here, we
759 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
760 * to be ok with the extra byte even though Windows doesn't send writes that
765 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
767 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
768 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
771 * Macros to allow the TCP_Server_Info->net field and related code to drop out
772 * when CONFIG_NET_NS isn't set.
777 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
782 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
789 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
794 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
801 * Session structure. One of these for each uid session with a particular host
804 struct list_head smb_ses_list;
805 struct list_head tcon_list;
806 struct mutex session_mutex;
807 struct TCP_Server_Info *server; /* pointer to server info */
808 int ses_count; /* reference counter */
809 enum statusEnum status;
810 unsigned overrideSecFlg; /* if non-zero override global sec flags */
811 __u16 ipc_tid; /* special tid for connection to IPC share */
812 char *serverOS; /* name of operating system underlying server */
813 char *serverNOS; /* name of network operating system of server */
814 char *serverDomain; /* security realm of server */
815 __u64 Suid; /* remote smb uid */
816 kuid_t linux_uid; /* overriding owner of files on the mount */
817 kuid_t cred_uid; /* owner of credentials */
818 unsigned int capabilities;
819 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
820 TCP names - will ipv6 and sctp addresses fit? */
821 char *user_name; /* must not be null except during init of sess
822 and after mount option parsing we fill it */
825 struct session_key auth_key;
826 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
827 enum securityEnum sectype; /* what security flavor was specified? */
828 bool sign; /* is signing required? */
829 bool need_reconnect:1; /* connection reset, uid now invalid */
830 #ifdef CONFIG_CIFS_SMB2
832 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
833 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
834 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
835 __u8 preauth_hash[512];
836 #endif /* CONFIG_CIFS_SMB2 */
840 cap_unix(struct cifs_ses *ses)
842 return ses->server->vals->cap_unix & ses->capabilities;
846 * there is one of these for each connection to a resource on a particular
850 struct list_head tcon_list;
852 struct list_head openFileList;
853 spinlock_t open_file_lock; /* protects list above */
854 struct cifs_ses *ses; /* pointer to session associated with */
855 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
856 char *nativeFileSystem;
857 char *password; /* for share-level security */
858 __u32 tid; /* The 4 byte tree id */
859 __u16 Flags; /* optional support bits */
860 enum statusEnum tidStatus;
861 #ifdef CONFIG_CIFS_STATS
862 atomic_t num_smbs_sent;
867 atomic_t num_flushes;
868 atomic_t num_oplock_brks;
871 atomic_t num_deletes;
873 atomic_t num_posixopens;
874 atomic_t num_posixmkdirs;
876 atomic_t num_renames;
877 atomic_t num_t2renames;
881 atomic_t num_hardlinks;
882 atomic_t num_symlinks;
884 atomic_t num_acl_get;
885 atomic_t num_acl_set;
887 #ifdef CONFIG_CIFS_SMB2
889 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
890 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
892 #endif /* CONFIG_CIFS_SMB2 */
894 #ifdef CONFIG_CIFS_STATS2
895 unsigned long long time_writes;
896 unsigned long long time_reads;
897 unsigned long long time_opens;
898 unsigned long long time_deletes;
899 unsigned long long time_closes;
900 unsigned long long time_mkdirs;
901 unsigned long long time_rmdirs;
902 unsigned long long time_renames;
903 unsigned long long time_t2renames;
904 unsigned long long time_ffirst;
905 unsigned long long time_fnext;
906 unsigned long long time_fclose;
907 #endif /* CONFIG_CIFS_STATS2 */
910 spinlock_t stat_lock; /* protects the two fields above */
911 #endif /* CONFIG_CIFS_STATS */
912 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
913 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
914 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
915 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
918 bool seal:1; /* transport encryption for this mounted share */
919 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
920 for this mount even if server would support */
921 bool local_lease:1; /* check leases (only) on local system not remote */
922 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
923 bool broken_sparse_sup; /* if server or share does not support sparse */
924 bool need_reconnect:1; /* connection reset, tid now invalid */
925 bool use_resilient:1; /* use resilient instead of durable handles */
926 bool use_persistent:1; /* use persistent instead of durable handles */
927 #ifdef CONFIG_CIFS_SMB2
928 bool print:1; /* set if connection to printer share */
929 bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
932 __u32 maximal_access;
933 __u32 vol_serial_number;
934 __le64 vol_create_time;
935 __u32 ss_flags; /* sector size flags */
936 __u32 perf_sector_size; /* best sector size for perf */
938 __u32 max_bytes_chunk;
939 __u32 max_bytes_copy;
940 #endif /* CONFIG_CIFS_SMB2 */
941 #ifdef CONFIG_CIFS_FSCACHE
942 u64 resource_id; /* server resource id */
943 struct fscache_cookie *fscache; /* cookie for share */
945 struct list_head pending_opens; /* list of incomplete opens */
946 /* BB add field for back pointer to sb struct(s)? */
950 * This is a refcounted and timestamped container for a tcon pointer. The
951 * container holds a tcon reference. It is considered safe to free one of
952 * these when the tl_count goes to 0. The tl_time is the time of the last
953 * "get" on the container.
956 struct rb_node tl_rbnode;
958 unsigned long tl_flags;
959 #define TCON_LINK_MASTER 0
960 #define TCON_LINK_PENDING 1
961 #define TCON_LINK_IN_TREE 2
962 unsigned long tl_time;
964 struct cifs_tcon *tl_tcon;
967 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
969 static inline struct cifs_tcon *
970 tlink_tcon(struct tcon_link *tlink)
972 return tlink->tl_tcon;
975 extern void cifs_put_tlink(struct tcon_link *tlink);
977 static inline struct tcon_link *
978 cifs_get_tlink(struct tcon_link *tlink)
980 if (tlink && !IS_ERR(tlink))
981 atomic_inc(&tlink->tl_count);
985 /* This function is always expected to succeed */
986 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
988 #define CIFS_OPLOCK_NO_CHANGE 0xfe
990 struct cifs_pending_open {
991 struct list_head olist;
992 struct tcon_link *tlink;
998 * This info hangs off the cifsFileInfo structure, pointed to by llist.
999 * This is used to track byte stream locks on the file
1001 struct cifsLockInfo {
1002 struct list_head llist; /* pointer to next cifsLockInfo */
1003 struct list_head blist; /* pointer to locks blocked on this */
1004 wait_queue_head_t block_q;
1012 * One of these for each open instance of a file
1014 struct cifs_search_info {
1015 loff_t index_of_last_entry;
1016 __u16 entries_in_buffer;
1019 char *ntwrk_buf_start;
1020 char *srch_entries_start;
1022 const char *presume_name;
1023 unsigned int resume_name_len;
1027 bool smallBuf:1; /* so we know which buf_release function to call */
1030 struct cifs_open_parms {
1031 struct cifs_tcon *tcon;
1032 struct cifs_sb_info *cifs_sb;
1037 struct cifs_fid *fid;
1043 #ifdef CONFIG_CIFS_SMB2
1044 __u64 persistent_fid; /* persist file id for smb2 */
1045 __u64 volatile_fid; /* volatile file id for smb2 */
1046 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1047 __u8 create_guid[16];
1049 struct cifs_pending_open *pending_open;
1054 struct cifs_fid_locks {
1055 struct list_head llist;
1056 struct cifsFileInfo *cfile; /* fid that owns locks */
1057 struct list_head locks; /* locks held by fid above */
1060 struct cifsFileInfo {
1061 /* following two lists are protected by tcon->open_file_lock */
1062 struct list_head tlist; /* pointer to next fid owned by tcon */
1063 struct list_head flist; /* next fid (file instance) for this inode */
1064 /* lock list below protected by cifsi->lock_sem */
1065 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1066 kuid_t uid; /* allows finding which FileInfo structure */
1067 __u32 pid; /* process id who opened file */
1068 struct cifs_fid fid; /* file id from remote */
1069 struct list_head rlist; /* reconnect list */
1070 /* BB add lock scope info here if needed */ ;
1071 /* lock scope id (0 if none) */
1072 struct dentry *dentry;
1073 struct tcon_link *tlink;
1074 unsigned int f_flags;
1075 bool invalidHandle:1; /* file closed via session abend */
1076 bool oplock_break_cancelled:1;
1078 spinlock_t file_info_lock; /* protects four flag/count fields above */
1079 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1080 struct cifs_search_info srch_inf;
1081 struct work_struct oplock_break; /* work for oplock breaks */
1084 struct cifs_io_parms {
1086 #ifdef CONFIG_CIFS_SMB2
1087 __u64 persistent_fid; /* persist file id for smb2 */
1088 __u64 volatile_fid; /* volatile file id for smb2 */
1092 unsigned int length;
1093 struct cifs_tcon *tcon;
1096 struct cifs_readdata;
1098 /* asynchronous read support */
1099 struct cifs_readdata {
1100 struct kref refcount;
1101 struct list_head list;
1102 struct completion done;
1103 struct cifsFileInfo *cfile;
1104 struct address_space *mapping;
1107 unsigned int got_bytes;
1110 struct work_struct work;
1111 int (*read_into_pages)(struct TCP_Server_Info *server,
1112 struct cifs_readdata *rdata,
1115 unsigned int pagesz;
1116 unsigned int tailsz;
1117 unsigned int credits;
1118 unsigned int nr_pages;
1119 struct page *pages[];
1122 struct cifs_writedata;
1124 /* asynchronous write support */
1125 struct cifs_writedata {
1126 struct kref refcount;
1127 struct list_head list;
1128 struct completion done;
1129 enum writeback_sync_modes sync_mode;
1130 struct work_struct work;
1131 struct cifsFileInfo *cfile;
1136 unsigned int pagesz;
1137 unsigned int tailsz;
1138 unsigned int credits;
1139 unsigned int nr_pages;
1140 struct page *pages[];
1144 * Take a reference on the file private data. Must be called with
1145 * cfile->file_info_lock held.
1148 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1153 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1154 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1156 #define CIFS_CACHE_READ_FLG 1
1157 #define CIFS_CACHE_HANDLE_FLG 2
1158 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1159 #define CIFS_CACHE_WRITE_FLG 4
1160 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1161 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1163 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1164 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1165 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1168 * One of these for each file inode
1171 struct cifsInodeInfo {
1172 bool can_cache_brlcks;
1173 struct list_head llist; /* locks helb by this inode */
1174 struct rw_semaphore lock_sem; /* protect the fields above */
1175 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1176 struct list_head openFileList;
1177 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1178 unsigned int oplock; /* oplock/lease level we have */
1179 unsigned int epoch; /* used to track lease state changes */
1180 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1181 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1182 #define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
1183 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1184 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1185 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1186 unsigned long flags;
1187 spinlock_t writers_lock;
1188 unsigned int writers; /* Number of writers on this inode */
1189 unsigned long time; /* jiffies of last update of inode */
1190 u64 server_eof; /* current file size on server -- protected by i_lock */
1191 u64 uniqueid; /* server inode number */
1192 u64 createtime; /* creation time on server */
1193 #ifdef CONFIG_CIFS_SMB2
1194 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1196 #ifdef CONFIG_CIFS_FSCACHE
1197 struct fscache_cookie *fscache;
1199 struct inode vfs_inode;
1202 static inline struct cifsInodeInfo *
1203 CIFS_I(struct inode *inode)
1205 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1208 static inline struct cifs_sb_info *
1209 CIFS_SB(struct super_block *sb)
1211 return sb->s_fs_info;
1214 static inline struct cifs_sb_info *
1215 CIFS_FILE_SB(struct file *file)
1217 return CIFS_SB(file_inode(file)->i_sb);
1220 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1222 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1229 convert_delimiter(char *path, char delim)
1231 char old_delim, *pos;
1239 while ((pos = strchr(pos, old_delim)))
1243 #ifdef CONFIG_CIFS_STATS
1244 #define cifs_stats_inc atomic_inc
1246 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1250 spin_lock(&tcon->stat_lock);
1251 tcon->bytes_written += bytes;
1252 spin_unlock(&tcon->stat_lock);
1256 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1259 spin_lock(&tcon->stat_lock);
1260 tcon->bytes_read += bytes;
1261 spin_unlock(&tcon->stat_lock);
1265 #define cifs_stats_inc(field) do {} while (0)
1266 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1267 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
1273 * This is the prototype for the mid receive function. This function is for
1274 * receiving the rest of the SMB frame, starting with the WordCount (which is
1275 * just after the MID in struct smb_hdr). Note:
1277 * - This will be called by cifsd, with no locks held.
1278 * - The mid will still be on the pending_mid_q.
1279 * - mid->resp_buf will point to the current buffer.
1281 * Returns zero on a successful receive, or an error. The receive state in
1282 * the TCP_Server_Info will also be updated.
1284 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1285 struct mid_q_entry *mid);
1288 * This is the prototype for the mid callback function. This is called once the
1289 * mid has been received off of the socket. When creating one, take special
1290 * care to avoid deadlocks. Things to bear in mind:
1292 * - it will be called by cifsd, with no locks held
1293 * - the mid will be removed from any lists
1295 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1297 /* one of these for every pending CIFS request to the server */
1298 struct mid_q_entry {
1299 struct list_head qhead; /* mids waiting on reply from this server */
1300 struct TCP_Server_Info *server; /* server corresponding to this mid */
1301 __u64 mid; /* multiplex id */
1302 __u32 pid; /* process id */
1303 __u32 sequence_number; /* for CIFS signing */
1304 unsigned long when_alloc; /* when mid was created */
1305 #ifdef CONFIG_CIFS_STATS2
1306 unsigned long when_sent; /* time when smb send finished */
1307 unsigned long when_received; /* when demux complete (taken off wire) */
1309 mid_receive_t *receive; /* call receive callback */
1310 mid_callback_t *callback; /* call completion callback */
1311 void *callback_data; /* general purpose pointer for callback */
1312 void *resp_buf; /* pointer to received SMB header */
1313 int mid_state; /* wish this were enum but can not pass to wait_event */
1314 __le16 command; /* smb command code */
1315 bool large_buf:1; /* if valid response, is pointer to large buf */
1316 bool multiRsp:1; /* multiple trans2 responses for one request */
1317 bool multiEnd:1; /* both received */
1320 /* Make code in transport.c a little cleaner by moving
1321 update of optional stats into function below */
1322 #ifdef CONFIG_CIFS_STATS2
1324 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1326 atomic_inc(&server->in_send);
1329 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1331 atomic_dec(&server->in_send);
1334 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1336 atomic_inc(&server->num_waiters);
1339 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1341 atomic_dec(&server->num_waiters);
1344 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1346 mid->when_sent = jiffies;
1349 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1352 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1356 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1360 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1364 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1369 /* for pending dnotify requests */
1370 struct dir_notify_req {
1371 struct list_head lhead;
1378 __u32 filter; /* CompletionFilter (for multishot) */
1383 struct dfs_info3_param {
1384 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1393 * common struct for holding inode info when searching for or updating an
1394 * inode with new info
1397 #define CIFS_FATTR_DFS_REFERRAL 0x1
1398 #define CIFS_FATTR_DELETE_PENDING 0x2
1399 #define CIFS_FATTR_NEED_REVAL 0x4
1400 #define CIFS_FATTR_INO_COLLISION 0x8
1401 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1414 unsigned int cf_nlink;
1415 unsigned int cf_dtype;
1416 struct timespec cf_atime;
1417 struct timespec cf_mtime;
1418 struct timespec cf_ctime;
1421 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1424 kfree(param->path_name);
1425 kfree(param->node_name);
1430 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1431 int number_of_items)
1434 if ((number_of_items == 0) || (param == NULL))
1436 for (i = 0; i < number_of_items; i++) {
1437 kfree(param[i].path_name);
1438 kfree(param[i].node_name);
1444 #define MID_REQUEST_ALLOCATED 1
1445 #define MID_REQUEST_SUBMITTED 2
1446 #define MID_RESPONSE_RECEIVED 4
1447 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1448 #define MID_RESPONSE_MALFORMED 0x10
1449 #define MID_SHUTDOWN 0x20
1451 /* Types of response buffer returned from SendReceive2 */
1452 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1453 #define CIFS_SMALL_BUFFER 1
1454 #define CIFS_LARGE_BUFFER 2
1455 #define CIFS_IOVEC 4 /* array of response buffers */
1457 /* Type of Request to SendReceive2 */
1458 #define CIFS_BLOCKING_OP 1 /* operation can block */
1459 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1460 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1461 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1462 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1463 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1465 /* Type of request operation */
1466 #define CIFS_ECHO_OP 0x080 /* echo request */
1467 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1468 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1469 #define CIFS_OP_MASK 0x0380 /* mask request type */
1470 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1472 /* Security Flags: indicate type of session setup needed */
1473 #define CIFSSEC_MAY_SIGN 0x00001
1474 #define CIFSSEC_MAY_NTLM 0x00002
1475 #define CIFSSEC_MAY_NTLMV2 0x00004
1476 #define CIFSSEC_MAY_KRB5 0x00008
1477 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1478 #define CIFSSEC_MAY_LANMAN 0x00010
1479 #define CIFSSEC_MAY_PLNTXT 0x00020
1481 #define CIFSSEC_MAY_LANMAN 0
1482 #define CIFSSEC_MAY_PLNTXT 0
1483 #endif /* weak passwords */
1484 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1485 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1487 #define CIFSSEC_MUST_SIGN 0x01001
1488 /* note that only one of the following can be set so the
1489 result of setting MUST flags more than once will be to
1490 require use of the stronger protocol */
1491 #define CIFSSEC_MUST_NTLM 0x02002
1492 #define CIFSSEC_MUST_NTLMV2 0x04004
1493 #define CIFSSEC_MUST_KRB5 0x08008
1494 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1495 #define CIFSSEC_MUST_LANMAN 0x10010
1496 #define CIFSSEC_MUST_PLNTXT 0x20020
1497 #ifdef CONFIG_CIFS_UPCALL
1498 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1500 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1502 #else /* do not allow weak pw hash */
1503 #define CIFSSEC_MUST_LANMAN 0
1504 #define CIFSSEC_MUST_PLNTXT 0
1505 #ifdef CONFIG_CIFS_UPCALL
1506 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1508 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1510 #endif /* WEAK_PW_HASH */
1511 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1512 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1514 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1515 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1516 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1518 *****************************************************************
1519 * All constants go here
1520 *****************************************************************
1523 #define UID_HASH (16)
1526 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1527 * following to be declared.
1530 /****************************************************************************
1531 * Locking notes. All updates to global variables and lists should be
1532 * protected by spinlocks or semaphores.
1536 * GlobalMid_Lock protects:
1537 * list operations on pending_mid_q and oplockQ
1538 * updates to XID counters, multiplex id and SMB sequence numbers
1539 * tcp_ses_lock protects:
1540 * list operations on tcp and SMB session lists
1541 * tcon->open_file_lock protects the list of open files hanging off the tcon
1542 * cfile->file_info_lock protects counters and fields in cifs file struct
1543 * f_owner.lock protects certain per file struct operations
1544 * mapping->page_lock protects certain per page operations
1548 * sesSem operations on smb session
1549 * tconSem operations on tree connection
1550 * fh_sem file handle reconnection operations
1552 ****************************************************************************/
1554 #ifdef DECLARE_GLOBALS_HERE
1555 #define GLOBAL_EXTERN
1557 #define GLOBAL_EXTERN extern
1561 * the list of TCP_Server_Info structures, ie each of the sockets
1562 * connecting our client to a distinct server (ip address), is
1563 * chained together by cifs_tcp_ses_list. The list of all our SMB
1564 * sessions (and from that the tree connections) can be found
1565 * by iterating over cifs_tcp_ses_list
1567 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1570 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1571 * tcp session, and the list of tcon's per smb session. It also protects
1572 * the reference counters for the server, smb session, and tcon. Finally,
1573 * changes to the tcon->tidStatus should be done while holding this lock.
1574 * generally the locks should be taken in order tcp_ses_lock before
1575 * tcon->open_file_lock and that before file->file_info_lock since the
1576 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1578 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1580 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1581 /* Outstanding dir notify requests */
1582 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1583 /* DirNotify response queue */
1584 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1585 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1588 * Global transaction id (XID) information
1590 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1591 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1592 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1593 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1594 /* on midQ entries */
1596 * Global counters, updated atomically
1598 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1599 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1600 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1601 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1602 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1604 /* Various Debug counters */
1605 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1606 #ifdef CONFIG_CIFS_STATS2
1607 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1608 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1610 GLOBAL_EXTERN atomic_t smBufAllocCount;
1611 GLOBAL_EXTERN atomic_t midCount;
1614 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1615 GLOBAL_EXTERN bool lookupCacheEnabled;
1616 GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1617 with more secure ntlmssp2 challenge/resp */
1618 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1619 GLOBAL_EXTERN bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1620 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1621 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1622 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1623 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1625 #ifdef CONFIG_CIFS_ACL
1626 GLOBAL_EXTERN struct rb_root uidtree;
1627 GLOBAL_EXTERN struct rb_root gidtree;
1628 GLOBAL_EXTERN spinlock_t siduidlock;
1629 GLOBAL_EXTERN spinlock_t sidgidlock;
1630 GLOBAL_EXTERN struct rb_root siduidtree;
1631 GLOBAL_EXTERN struct rb_root sidgidtree;
1632 GLOBAL_EXTERN spinlock_t uidsidlock;
1633 GLOBAL_EXTERN spinlock_t gidsidlock;
1634 #endif /* CONFIG_CIFS_ACL */
1636 void cifs_oplock_break(struct work_struct *work);
1638 extern const struct slow_work_ops cifs_oplock_break_ops;
1639 extern struct workqueue_struct *cifsiod_wq;
1640 extern __u32 cifs_lock_secret;
1642 extern mempool_t *cifs_mid_poolp;
1644 /* Operations for different SMB versions */
1645 #define SMB1_VERSION_STRING "1.0"
1646 extern struct smb_version_operations smb1_operations;
1647 extern struct smb_version_values smb1_values;
1648 #define SMB20_VERSION_STRING "2.0"
1649 extern struct smb_version_operations smb20_operations;
1650 extern struct smb_version_values smb20_values;
1651 #define SMB21_VERSION_STRING "2.1"
1652 extern struct smb_version_operations smb21_operations;
1653 extern struct smb_version_values smb21_values;
1654 #define SMB30_VERSION_STRING "3.0"
1655 extern struct smb_version_operations smb30_operations;
1656 extern struct smb_version_values smb30_values;
1657 #define SMB302_VERSION_STRING "3.02"
1658 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1659 extern struct smb_version_values smb302_values;
1660 #define SMB311_VERSION_STRING "3.1.1"
1661 #define ALT_SMB311_VERSION_STRING "3.11"
1662 extern struct smb_version_operations smb311_operations;
1663 extern struct smb_version_values smb311_values;
1664 #endif /* _CIFS_GLOB_H */