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 */
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
197 struct TCP_Server_Info;
201 struct dfs_info3_param;
205 struct cifs_readdata;
206 struct cifs_writedata;
207 struct cifs_io_parms;
208 struct cifs_search_info;
209 struct cifsInodeInfo;
210 struct cifs_open_parms;
212 struct smb_version_operations {
213 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
214 struct mid_q_entry *);
215 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
216 /* setup request: allocate mid, sign message */
217 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
219 /* setup async request: allocate mid, sign message */
220 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
222 /* check response: verify signature, map error */
223 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
225 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
227 void (*set_credits)(struct TCP_Server_Info *, const int);
228 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
229 unsigned int (*get_credits)(struct mid_q_entry *);
230 __u64 (*get_next_mid)(struct TCP_Server_Info *);
231 /* data offset from read response message */
232 unsigned int (*read_data_offset)(char *);
233 /* data length from read response message */
234 unsigned int (*read_data_length)(char *);
235 /* map smb to linux error */
236 int (*map_error)(char *, bool);
237 /* find mid corresponding to the response message */
238 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
239 void (*dump_detail)(void *);
240 void (*clear_stats)(struct cifs_tcon *);
241 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
242 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
243 /* verify the message */
244 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
245 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
246 void (*downgrade_oplock)(struct TCP_Server_Info *,
247 struct cifsInodeInfo *, bool);
248 /* process transaction2 response */
249 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
251 /* check if we need to negotiate */
252 bool (*need_neg)(struct TCP_Server_Info *);
253 /* negotiate to the server */
254 int (*negotiate)(const unsigned int, struct cifs_ses *);
255 /* set negotiated write size */
256 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
257 /* set negotiated read size */
258 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
259 /* setup smb sessionn */
260 int (*sess_setup)(const unsigned int, struct cifs_ses *,
261 const struct nls_table *);
262 /* close smb session */
263 int (*logoff)(const unsigned int, struct cifs_ses *);
264 /* connect to a server share */
265 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
266 struct cifs_tcon *, const struct nls_table *);
267 /* close tree connecion */
268 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
269 /* get DFS referrals */
270 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
271 const char *, struct dfs_info3_param **,
272 unsigned int *, const struct nls_table *, int);
273 /* informational QFS call */
274 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
275 /* check if a path is accessible or not */
276 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
277 struct cifs_sb_info *, const char *);
278 /* query path data from the server */
279 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
280 struct cifs_sb_info *, const char *,
281 FILE_ALL_INFO *, bool *, bool *);
282 /* query file data from the server */
283 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
284 struct cifs_fid *, FILE_ALL_INFO *);
285 /* get server index number */
286 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
287 struct cifs_sb_info *, const char *,
288 u64 *uniqueid, FILE_ALL_INFO *);
289 /* set size by path */
290 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
291 const char *, __u64, struct cifs_sb_info *, bool);
292 /* set size by file handle */
293 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
294 struct cifsFileInfo *, __u64, bool);
296 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
298 int (*set_compression)(const unsigned int, struct cifs_tcon *,
299 struct cifsFileInfo *);
300 /* check if we can send an echo or nor */
301 bool (*can_echo)(struct TCP_Server_Info *);
302 /* send echo request */
303 int (*echo)(struct TCP_Server_Info *);
304 /* create directory */
305 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
306 struct cifs_sb_info *);
307 /* set info on created directory */
308 void (*mkdir_setinfo)(struct inode *, const char *,
309 struct cifs_sb_info *, struct cifs_tcon *,
311 /* remove directory */
312 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
313 struct cifs_sb_info *);
315 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
316 struct cifs_sb_info *);
317 /* open, rename and delete file */
318 int (*rename_pending_delete)(const char *, struct dentry *,
320 /* send rename request */
321 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
322 const char *, struct cifs_sb_info *);
323 /* send create hardlink request */
324 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
325 const char *, const char *,
326 struct cifs_sb_info *);
327 /* query symlink target */
328 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
329 const char *, char **, struct cifs_sb_info *);
330 /* open a file for non-posix mounts */
331 int (*open)(const unsigned int, struct cifs_open_parms *,
332 __u32 *, FILE_ALL_INFO *);
333 /* set fid protocol-specific info */
334 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
336 void (*close)(const unsigned int, struct cifs_tcon *,
338 /* send a flush request to the server */
339 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
340 /* async read from the server */
341 int (*async_readv)(struct cifs_readdata *);
342 /* async write to the server */
343 int (*async_writev)(struct cifs_writedata *,
344 void (*release)(struct kref *));
345 /* sync read from the server */
346 int (*sync_read)(const unsigned int, struct cifs_fid *,
347 struct cifs_io_parms *, unsigned int *, char **,
349 /* sync write to the server */
350 int (*sync_write)(const unsigned int, struct cifs_fid *,
351 struct cifs_io_parms *, unsigned int *, struct kvec *,
353 /* open dir, start readdir */
354 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
355 const char *, struct cifs_sb_info *,
356 struct cifs_fid *, __u16,
357 struct cifs_search_info *);
358 /* continue readdir */
359 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
361 __u16, struct cifs_search_info *srch_inf);
363 int (*close_dir)(const unsigned int, struct cifs_tcon *,
365 /* calculate a size of SMB message */
366 unsigned int (*calc_smb_size)(void *);
367 /* check for STATUS_PENDING and process it in a positive case */
368 bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
369 /* send oplock break response */
370 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
371 struct cifsInodeInfo *);
372 /* query remote filesystem */
373 int (*queryfs)(const unsigned int, struct cifs_tcon *,
375 /* send mandatory brlock to the server */
376 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
377 __u64, __u32, int, int, bool);
378 /* unlock range of mandatory locks */
379 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
381 /* push brlocks from the cache to the server */
382 int (*push_mand_locks)(struct cifsFileInfo *);
383 /* get lease key of the inode */
384 void (*get_lease_key)(struct inode *, struct cifs_fid *);
385 /* set lease key of the inode */
386 void (*set_lease_key)(struct inode *, struct cifs_fid *);
387 /* generate new lease key */
388 void (*new_lease_key)(struct cifs_fid *);
389 int (*generate_signingkey)(struct cifs_ses *);
390 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
391 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
392 struct cifsFileInfo *src_file);
393 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
394 struct cifsFileInfo *src_file, void __user *);
395 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
396 struct cifs_sb_info *, const unsigned char *,
397 char *, unsigned int *);
398 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
399 struct cifs_sb_info *, const unsigned char *,
400 char *, unsigned int *);
401 /* if we can do cache read operations */
402 bool (*is_read_op)(__u32);
403 /* set oplock level for the inode */
404 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
406 /* create lease context buffer for CREATE request */
407 char * (*create_lease_buf)(u8 *, u8);
408 /* parse lease context buffer and return oplock/epoch info */
409 __u8 (*parse_lease_buf)(void *, unsigned int *);
410 int (*clone_range)(const unsigned int, struct cifsFileInfo *src_file,
411 struct cifsFileInfo *target_file, u64 src_off, u64 len,
413 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
414 struct cifsFileInfo *target_file, u64 src_off, u64 len,
416 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
417 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
418 const unsigned char *, const unsigned char *, char *,
419 size_t, const struct nls_table *, int);
420 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
421 const char *, const void *, const __u16,
422 const struct nls_table *, int);
423 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
424 const char *, u32 *);
425 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
426 const struct cifs_fid *, u32 *);
427 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
429 /* writepages retry size */
430 unsigned int (*wp_retry_size)(struct inode *);
431 /* get mtu credits */
432 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
433 unsigned int *, unsigned int *);
434 /* check if we need to issue closedir */
435 bool (*dir_needs_close)(struct cifsFileInfo *);
436 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
438 /* init transform request - used for encryption for now */
439 int (*init_transform_rq)(struct TCP_Server_Info *, struct smb_rqst *,
441 /* free transform request */
442 void (*free_transform_rq)(struct smb_rqst *);
443 int (*is_transform_hdr)(void *buf);
444 int (*receive_transform)(struct TCP_Server_Info *,
445 struct mid_q_entry **);
448 struct smb_version_values {
449 char *version_string;
451 __u32 req_capabilities;
452 __u32 large_lock_type;
453 __u32 exclusive_lock_type;
454 __u32 shared_lock_type;
455 __u32 unlock_lock_type;
457 size_t max_header_size;
458 size_t read_rsp_size;
460 unsigned int cap_unix;
461 unsigned int cap_nt_find;
462 unsigned int cap_large_files;
463 __u16 signing_enabled;
464 __u16 signing_required;
465 size_t create_lease_size;
468 #define HEADER_SIZE(server) (server->vals->header_size)
469 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
476 char *iocharset; /* local code page for mapping to and from Unicode */
477 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
478 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
486 enum securityEnum sectype; /* sectype requested via mnt opts */
487 bool sign; /* was signing requested via mnt opts? */
491 bool setuidfromacl:1;
496 bool no_psx_acl:1; /* set if posix acl support should be disabled */
498 bool backupuid_specified; /* mount option backupuid is specified */
499 bool backupgid_specified; /* mount option backupgid is specified */
500 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
501 bool server_ino:1; /* use inode numbers from server ie UniqueId */
503 bool strict_io:1; /* strict cache behavior */
504 bool remap:1; /* set to remap seven reserved chars in filenames */
505 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
506 bool posix_paths:1; /* unset to not ask for posix pathnames. */
509 bool nullauth:1; /* attempt to authenticate with null user */
510 bool nocase:1; /* request case insensitive filenames */
511 bool nobrl:1; /* disable sending byte range locks to srv */
512 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
513 bool seal:1; /* request transport encryption on share */
514 bool nodfs:1; /* Do not request DFS, even if available */
515 bool local_lease:1; /* check leases only on local system, not remote */
518 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
519 bool fsc:1; /* enable fscache */
520 bool mfsymlinks:1; /* use Minshall+French Symlinks */
522 bool rwpidforward:1; /* pid forward for read/write operations */
526 bool resilient:1; /* noresilient not required since not fored for CA */
530 bool sockopt_tcp_nodelay:1;
531 unsigned long actimeo; /* attribute cache timeout (jiffies) */
532 struct smb_version_operations *ops;
533 struct smb_version_values *vals;
535 struct sockaddr_storage dstaddr; /* destination address */
536 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
537 struct nls_table *local_nls;
538 unsigned int echo_interval; /* echo interval in secs */
539 __u64 snapshot_time; /* needed for timewarp tokens */
540 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
543 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
544 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
545 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
546 CIFS_MOUNT_MAP_SFM_CHR | \
547 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
548 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
549 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
550 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
551 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
552 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
553 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
555 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
556 MS_NODEV | MS_SYNCHRONOUS)
558 struct cifs_mnt_data {
559 struct cifs_sb_info *cifs_sb;
564 static inline unsigned int
565 get_rfc1002_length(void *buf)
567 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
571 inc_rfc1001_len(void *buf, int count)
573 be32_add_cpu((__be32 *)buf, count);
576 struct TCP_Server_Info {
577 struct list_head tcp_ses_list;
578 struct list_head smb_ses_list;
579 int srv_count; /* reference counter */
580 /* 15 character server name + 0x20 16th byte indicating type = srv */
581 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
582 struct smb_version_operations *ops;
583 struct smb_version_values *vals;
584 enum statusEnum tcpStatus; /* what we think the status is */
585 char *hostname; /* hostname portion of UNC string */
586 struct socket *ssocket;
587 struct sockaddr_storage dstaddr;
588 struct sockaddr_storage srcaddr; /* locally bind to this IP */
592 wait_queue_head_t response_q;
593 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
594 struct list_head pending_mid_q;
595 bool noblocksnd; /* use blocking sendmsg */
596 bool noautotune; /* do not autotune send buf sizes */
598 unsigned int credits; /* send no more requests at once */
599 unsigned int max_credits; /* can override large 32000 default at mnt */
600 unsigned int in_flight; /* number of requests on the wire to server */
601 spinlock_t req_lock; /* protect the two values above */
602 struct mutex srv_mutex;
603 struct task_struct *tsk;
604 char server_GUID[16];
606 bool sign; /* is signing enabled on this connection? */
607 bool session_estab; /* mark when very first sess is established */
608 #ifdef CONFIG_CIFS_SMB2
609 int echo_credits; /* echo reserved slots */
610 int oplock_credits; /* oplock break reserved slots */
611 bool echoes:1; /* enable echoes */
612 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
614 u16 dialect; /* dialect index that server chose */
615 bool oplocks:1; /* enable oplocks */
616 unsigned int maxReq; /* Clients should submit no more */
617 /* than maxReq distinct unanswered SMBs to the server when using */
618 /* multiplexed reads or writes */
619 unsigned int maxBuf; /* maxBuf specifies the maximum */
620 /* message size the server can send or receive for non-raw SMBs */
621 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
622 /* when socket is setup (and during reconnect) before NegProt sent */
623 unsigned int max_rw; /* maxRw specifies the maximum */
624 /* message size the server can send or receive for */
625 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
626 unsigned int capabilities; /* selective disabling of caps by smb sess */
627 int timeAdj; /* Adjust for difference in server time zone in sec */
628 __u64 CurrentMid; /* multiplex id - rotating counter */
629 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
630 /* 16th byte of RFC1001 workstation name is always null */
631 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
632 __u32 sequence_number; /* for signing, protected by srv_mutex */
633 struct session_key session_key;
634 unsigned long lstrp; /* when we got last response from this server */
635 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
636 #define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
637 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
638 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
639 char negflavor; /* NEGOTIATE response flavor */
640 /* extended security flavors that server supports */
641 bool sec_ntlmssp; /* supports NTLMSSP */
642 bool sec_kerberosu2u; /* supports U2U Kerberos */
643 bool sec_kerberos; /* supports plain Kerberos */
644 bool sec_mskerberos; /* supports legacy MS Kerberos */
645 bool large_buf; /* is current buffer large? */
646 struct delayed_work echo; /* echo ping workqueue job */
647 char *smallbuf; /* pointer to current "small" buffer */
648 char *bigbuf; /* pointer to current "big" buffer */
649 unsigned int total_read; /* total amount of data read in this pass */
650 #ifdef CONFIG_CIFS_FSCACHE
651 struct fscache_cookie *fscache; /* client index cache cookie */
653 #ifdef CONFIG_CIFS_STATS2
654 atomic_t in_send; /* requests trying to send */
655 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
657 #ifdef CONFIG_CIFS_SMB2
658 unsigned int max_read;
659 unsigned int max_write;
660 __u8 preauth_hash[512];
661 struct delayed_work reconnect; /* reconnect workqueue job */
662 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
663 #endif /* CONFIG_CIFS_SMB2 */
664 unsigned long echo_interval;
667 static inline unsigned int
668 in_flight(struct TCP_Server_Info *server)
671 spin_lock(&server->req_lock);
672 num = server->in_flight;
673 spin_unlock(&server->req_lock);
678 has_credits(struct TCP_Server_Info *server, int *credits)
681 spin_lock(&server->req_lock);
683 spin_unlock(&server->req_lock);
688 add_credits(struct TCP_Server_Info *server, const unsigned int add,
691 server->ops->add_credits(server, add, optype);
695 add_credits_and_wake_if(struct TCP_Server_Info *server, const unsigned int add,
699 server->ops->add_credits(server, add, optype);
700 wake_up(&server->request_q);
705 set_credits(struct TCP_Server_Info *server, const int val)
707 server->ops->set_credits(server, val);
711 get_next_mid64(struct TCP_Server_Info *server)
713 return cpu_to_le64(server->ops->get_next_mid(server));
717 get_next_mid(struct TCP_Server_Info *server)
719 __u16 mid = server->ops->get_next_mid(server);
721 * The value in the SMB header should be little endian for easy
722 * on-the-wire decoding.
724 return cpu_to_le16(mid);
728 get_mid(const struct smb_hdr *smb)
730 return le16_to_cpu(smb->Mid);
734 compare_mid(__u16 mid, const struct smb_hdr *smb)
736 return mid == le16_to_cpu(smb->Mid);
740 * When the server supports very large reads and writes via POSIX extensions,
741 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
742 * including the RFC1001 length.
744 * Note that this might make for "interesting" allocation problems during
745 * writeback however as we have to allocate an array of pointers for the
746 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
748 * For reads, there is a similar problem as we need to allocate an array
749 * of kvecs to handle the receive, though that should only need to be done
752 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
753 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
756 * When the server doesn't allow large posix writes, only allow a rsize/wsize
757 * of 2^17-1 minus the size of the call header. That allows for a read or
758 * write up to the maximum size described by RFC1002.
760 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
761 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
764 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
765 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
766 * a single wsize request with a single call.
768 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
771 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
772 * those values when posix extensions aren't in force. In actuality here, we
773 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
774 * to be ok with the extra byte even though Windows doesn't send writes that
779 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
781 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
782 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
785 * Macros to allow the TCP_Server_Info->net field and related code to drop out
786 * when CONFIG_NET_NS isn't set.
791 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
796 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
803 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
808 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
815 * Session structure. One of these for each uid session with a particular host
818 struct list_head smb_ses_list;
819 struct list_head tcon_list;
820 struct mutex session_mutex;
821 struct TCP_Server_Info *server; /* pointer to server info */
822 int ses_count; /* reference counter */
823 enum statusEnum status;
824 unsigned overrideSecFlg; /* if non-zero override global sec flags */
825 __u16 ipc_tid; /* special tid for connection to IPC share */
826 char *serverOS; /* name of operating system underlying server */
827 char *serverNOS; /* name of network operating system of server */
828 char *serverDomain; /* security realm of server */
829 __u64 Suid; /* remote smb uid */
830 kuid_t linux_uid; /* overriding owner of files on the mount */
831 kuid_t cred_uid; /* owner of credentials */
832 unsigned int capabilities;
833 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
834 TCP names - will ipv6 and sctp addresses fit? */
835 char *user_name; /* must not be null except during init of sess
836 and after mount option parsing we fill it */
839 struct session_key auth_key;
840 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
841 enum securityEnum sectype; /* what security flavor was specified? */
842 bool sign; /* is signing required? */
843 bool need_reconnect:1; /* connection reset, uid now invalid */
845 #ifdef CONFIG_CIFS_SMB2
847 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
848 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
849 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
850 __u8 preauth_hash[512];
851 #endif /* CONFIG_CIFS_SMB2 */
855 cap_unix(struct cifs_ses *ses)
857 return ses->server->vals->cap_unix & ses->capabilities;
861 * there is one of these for each connection to a resource on a particular
865 struct list_head tcon_list;
867 struct list_head rlist; /* reconnect list */
868 struct list_head openFileList;
869 spinlock_t open_file_lock; /* protects list above */
870 struct cifs_ses *ses; /* pointer to session associated with */
871 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
872 char *nativeFileSystem;
873 char *password; /* for share-level security */
874 __u32 tid; /* The 4 byte tree id */
875 __u16 Flags; /* optional support bits */
876 enum statusEnum tidStatus;
877 #ifdef CONFIG_CIFS_STATS
878 atomic_t num_smbs_sent;
883 atomic_t num_flushes;
884 atomic_t num_oplock_brks;
887 atomic_t num_deletes;
889 atomic_t num_posixopens;
890 atomic_t num_posixmkdirs;
892 atomic_t num_renames;
893 atomic_t num_t2renames;
897 atomic_t num_hardlinks;
898 atomic_t num_symlinks;
900 atomic_t num_acl_get;
901 atomic_t num_acl_set;
903 #ifdef CONFIG_CIFS_SMB2
905 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
906 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
908 #endif /* CONFIG_CIFS_SMB2 */
910 #ifdef CONFIG_CIFS_STATS2
911 unsigned long long time_writes;
912 unsigned long long time_reads;
913 unsigned long long time_opens;
914 unsigned long long time_deletes;
915 unsigned long long time_closes;
916 unsigned long long time_mkdirs;
917 unsigned long long time_rmdirs;
918 unsigned long long time_renames;
919 unsigned long long time_t2renames;
920 unsigned long long time_ffirst;
921 unsigned long long time_fnext;
922 unsigned long long time_fclose;
923 #endif /* CONFIG_CIFS_STATS2 */
926 spinlock_t stat_lock; /* protects the two fields above */
927 #endif /* CONFIG_CIFS_STATS */
928 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
929 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
930 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
931 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
934 bool seal:1; /* transport encryption for this mounted share */
935 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
936 for this mount even if server would support */
937 bool local_lease:1; /* check leases (only) on local system not remote */
938 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
939 bool broken_sparse_sup; /* if server or share does not support sparse */
940 bool need_reconnect:1; /* connection reset, tid now invalid */
941 bool need_reopen_files:1; /* need to reopen tcon file handles */
942 bool use_resilient:1; /* use resilient instead of durable handles */
943 bool use_persistent:1; /* use persistent instead of durable handles */
944 #ifdef CONFIG_CIFS_SMB2
945 bool print:1; /* set if connection to printer share */
946 bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
949 __u32 maximal_access;
950 __u32 vol_serial_number;
951 __le64 vol_create_time;
952 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
953 __u32 ss_flags; /* sector size flags */
954 __u32 perf_sector_size; /* best sector size for perf */
956 __u32 max_bytes_chunk;
957 __u32 max_bytes_copy;
958 #endif /* CONFIG_CIFS_SMB2 */
959 #ifdef CONFIG_CIFS_FSCACHE
960 u64 resource_id; /* server resource id */
961 struct fscache_cookie *fscache; /* cookie for share */
963 struct list_head pending_opens; /* list of incomplete opens */
964 /* BB add field for back pointer to sb struct(s)? */
968 * This is a refcounted and timestamped container for a tcon pointer. The
969 * container holds a tcon reference. It is considered safe to free one of
970 * these when the tl_count goes to 0. The tl_time is the time of the last
971 * "get" on the container.
974 struct rb_node tl_rbnode;
976 unsigned long tl_flags;
977 #define TCON_LINK_MASTER 0
978 #define TCON_LINK_PENDING 1
979 #define TCON_LINK_IN_TREE 2
980 unsigned long tl_time;
982 struct cifs_tcon *tl_tcon;
985 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
987 static inline struct cifs_tcon *
988 tlink_tcon(struct tcon_link *tlink)
990 return tlink->tl_tcon;
993 extern void cifs_put_tlink(struct tcon_link *tlink);
995 static inline struct tcon_link *
996 cifs_get_tlink(struct tcon_link *tlink)
998 if (tlink && !IS_ERR(tlink))
999 atomic_inc(&tlink->tl_count);
1003 /* This function is always expected to succeed */
1004 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1006 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1008 struct cifs_pending_open {
1009 struct list_head olist;
1010 struct tcon_link *tlink;
1016 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1017 * This is used to track byte stream locks on the file
1019 struct cifsLockInfo {
1020 struct list_head llist; /* pointer to next cifsLockInfo */
1021 struct list_head blist; /* pointer to locks blocked on this */
1022 wait_queue_head_t block_q;
1030 * One of these for each open instance of a file
1032 struct cifs_search_info {
1033 loff_t index_of_last_entry;
1034 __u16 entries_in_buffer;
1037 char *ntwrk_buf_start;
1038 char *srch_entries_start;
1040 const char *presume_name;
1041 unsigned int resume_name_len;
1045 bool smallBuf:1; /* so we know which buf_release function to call */
1048 struct cifs_open_parms {
1049 struct cifs_tcon *tcon;
1050 struct cifs_sb_info *cifs_sb;
1055 struct cifs_fid *fid;
1061 #ifdef CONFIG_CIFS_SMB2
1062 __u64 persistent_fid; /* persist file id for smb2 */
1063 __u64 volatile_fid; /* volatile file id for smb2 */
1064 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1065 __u8 create_guid[16];
1067 struct cifs_pending_open *pending_open;
1072 struct cifs_fid_locks {
1073 struct list_head llist;
1074 struct cifsFileInfo *cfile; /* fid that owns locks */
1075 struct list_head locks; /* locks held by fid above */
1078 struct cifsFileInfo {
1079 /* following two lists are protected by tcon->open_file_lock */
1080 struct list_head tlist; /* pointer to next fid owned by tcon */
1081 struct list_head flist; /* next fid (file instance) for this inode */
1082 /* lock list below protected by cifsi->lock_sem */
1083 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1084 kuid_t uid; /* allows finding which FileInfo structure */
1085 __u32 pid; /* process id who opened file */
1086 struct cifs_fid fid; /* file id from remote */
1087 struct list_head rlist; /* reconnect list */
1088 /* BB add lock scope info here if needed */ ;
1089 /* lock scope id (0 if none) */
1090 struct dentry *dentry;
1091 struct tcon_link *tlink;
1092 unsigned int f_flags;
1093 bool invalidHandle:1; /* file closed via session abend */
1094 bool oplock_break_cancelled:1;
1096 spinlock_t file_info_lock; /* protects four flag/count fields above */
1097 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1098 struct cifs_search_info srch_inf;
1099 struct work_struct oplock_break; /* work for oplock breaks */
1102 struct cifs_io_parms {
1104 #ifdef CONFIG_CIFS_SMB2
1105 __u64 persistent_fid; /* persist file id for smb2 */
1106 __u64 volatile_fid; /* volatile file id for smb2 */
1110 unsigned int length;
1111 struct cifs_tcon *tcon;
1114 struct cifs_readdata;
1116 /* asynchronous read support */
1117 struct cifs_readdata {
1118 struct kref refcount;
1119 struct list_head list;
1120 struct completion done;
1121 struct cifsFileInfo *cfile;
1122 struct address_space *mapping;
1125 unsigned int got_bytes;
1128 struct work_struct work;
1129 int (*read_into_pages)(struct TCP_Server_Info *server,
1130 struct cifs_readdata *rdata,
1132 int (*copy_into_pages)(struct TCP_Server_Info *server,
1133 struct cifs_readdata *rdata,
1134 struct iov_iter *iter);
1136 unsigned int pagesz;
1137 unsigned int tailsz;
1138 unsigned int credits;
1139 unsigned int nr_pages;
1140 struct page *pages[];
1143 struct cifs_writedata;
1145 /* asynchronous write support */
1146 struct cifs_writedata {
1147 struct kref refcount;
1148 struct list_head list;
1149 struct completion done;
1150 enum writeback_sync_modes sync_mode;
1151 struct work_struct work;
1152 struct cifsFileInfo *cfile;
1157 unsigned int pagesz;
1158 unsigned int tailsz;
1159 unsigned int credits;
1160 unsigned int nr_pages;
1161 struct page *pages[];
1165 * Take a reference on the file private data. Must be called with
1166 * cfile->file_info_lock held.
1169 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1174 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1175 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1177 #define CIFS_CACHE_READ_FLG 1
1178 #define CIFS_CACHE_HANDLE_FLG 2
1179 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1180 #define CIFS_CACHE_WRITE_FLG 4
1181 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1182 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1184 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1185 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1186 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1189 * One of these for each file inode
1192 struct cifsInodeInfo {
1193 bool can_cache_brlcks;
1194 struct list_head llist; /* locks helb by this inode */
1195 struct rw_semaphore lock_sem; /* protect the fields above */
1196 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1197 struct list_head openFileList;
1198 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1199 unsigned int oplock; /* oplock/lease level we have */
1200 unsigned int epoch; /* used to track lease state changes */
1201 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1202 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1203 #define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
1204 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1205 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1206 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1207 unsigned long flags;
1208 spinlock_t writers_lock;
1209 unsigned int writers; /* Number of writers on this inode */
1210 unsigned long time; /* jiffies of last update of inode */
1211 u64 server_eof; /* current file size on server -- protected by i_lock */
1212 u64 uniqueid; /* server inode number */
1213 u64 createtime; /* creation time on server */
1214 #ifdef CONFIG_CIFS_SMB2
1215 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1217 #ifdef CONFIG_CIFS_FSCACHE
1218 struct fscache_cookie *fscache;
1220 struct inode vfs_inode;
1223 static inline struct cifsInodeInfo *
1224 CIFS_I(struct inode *inode)
1226 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1229 static inline struct cifs_sb_info *
1230 CIFS_SB(struct super_block *sb)
1232 return sb->s_fs_info;
1235 static inline struct cifs_sb_info *
1236 CIFS_FILE_SB(struct file *file)
1238 return CIFS_SB(file_inode(file)->i_sb);
1241 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1243 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1250 convert_delimiter(char *path, char delim)
1252 char old_delim, *pos;
1260 while ((pos = strchr(pos, old_delim)))
1264 #ifdef CONFIG_CIFS_STATS
1265 #define cifs_stats_inc atomic_inc
1267 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1271 spin_lock(&tcon->stat_lock);
1272 tcon->bytes_written += bytes;
1273 spin_unlock(&tcon->stat_lock);
1277 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1280 spin_lock(&tcon->stat_lock);
1281 tcon->bytes_read += bytes;
1282 spin_unlock(&tcon->stat_lock);
1286 #define cifs_stats_inc(field) do {} while (0)
1287 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1288 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
1294 * This is the prototype for the mid receive function. This function is for
1295 * receiving the rest of the SMB frame, starting with the WordCount (which is
1296 * just after the MID in struct smb_hdr). Note:
1298 * - This will be called by cifsd, with no locks held.
1299 * - The mid will still be on the pending_mid_q.
1300 * - mid->resp_buf will point to the current buffer.
1302 * Returns zero on a successful receive, or an error. The receive state in
1303 * the TCP_Server_Info will also be updated.
1305 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1306 struct mid_q_entry *mid);
1309 * This is the prototype for the mid callback function. This is called once the
1310 * mid has been received off of the socket. When creating one, take special
1311 * care to avoid deadlocks. Things to bear in mind:
1313 * - it will be called by cifsd, with no locks held
1314 * - the mid will be removed from any lists
1316 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1319 * This is the protopyte for mid handle function. This is called once the mid
1320 * has been recognized after decryption of the message.
1322 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1323 struct mid_q_entry *mid);
1325 /* one of these for every pending CIFS request to the server */
1326 struct mid_q_entry {
1327 struct list_head qhead; /* mids waiting on reply from this server */
1328 struct TCP_Server_Info *server; /* server corresponding to this mid */
1329 __u64 mid; /* multiplex id */
1330 __u32 pid; /* process id */
1331 __u32 sequence_number; /* for CIFS signing */
1332 unsigned long when_alloc; /* when mid was created */
1333 #ifdef CONFIG_CIFS_STATS2
1334 unsigned long when_sent; /* time when smb send finished */
1335 unsigned long when_received; /* when demux complete (taken off wire) */
1337 mid_receive_t *receive; /* call receive callback */
1338 mid_callback_t *callback; /* call completion callback */
1339 mid_handle_t *handle; /* call handle mid callback */
1340 void *callback_data; /* general purpose pointer for callback */
1341 void *resp_buf; /* pointer to received SMB header */
1342 int mid_state; /* wish this were enum but can not pass to wait_event */
1343 __le16 command; /* smb command code */
1344 bool large_buf:1; /* if valid response, is pointer to large buf */
1345 bool multiRsp:1; /* multiple trans2 responses for one request */
1346 bool multiEnd:1; /* both received */
1347 bool decrypted:1; /* decrypted entry */
1350 /* Make code in transport.c a little cleaner by moving
1351 update of optional stats into function below */
1352 #ifdef CONFIG_CIFS_STATS2
1354 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1356 atomic_inc(&server->in_send);
1359 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1361 atomic_dec(&server->in_send);
1364 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1366 atomic_inc(&server->num_waiters);
1369 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1371 atomic_dec(&server->num_waiters);
1374 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1376 mid->when_sent = jiffies;
1379 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1382 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1386 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1390 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1394 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1399 /* for pending dnotify requests */
1400 struct dir_notify_req {
1401 struct list_head lhead;
1408 __u32 filter; /* CompletionFilter (for multishot) */
1413 struct dfs_info3_param {
1414 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1423 * common struct for holding inode info when searching for or updating an
1424 * inode with new info
1427 #define CIFS_FATTR_DFS_REFERRAL 0x1
1428 #define CIFS_FATTR_DELETE_PENDING 0x2
1429 #define CIFS_FATTR_NEED_REVAL 0x4
1430 #define CIFS_FATTR_INO_COLLISION 0x8
1431 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1444 unsigned int cf_nlink;
1445 unsigned int cf_dtype;
1446 struct timespec cf_atime;
1447 struct timespec cf_mtime;
1448 struct timespec cf_ctime;
1451 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1454 kfree(param->path_name);
1455 kfree(param->node_name);
1460 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1461 int number_of_items)
1464 if ((number_of_items == 0) || (param == NULL))
1466 for (i = 0; i < number_of_items; i++) {
1467 kfree(param[i].path_name);
1468 kfree(param[i].node_name);
1474 #define MID_REQUEST_ALLOCATED 1
1475 #define MID_REQUEST_SUBMITTED 2
1476 #define MID_RESPONSE_RECEIVED 4
1477 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1478 #define MID_RESPONSE_MALFORMED 0x10
1479 #define MID_SHUTDOWN 0x20
1481 /* Types of response buffer returned from SendReceive2 */
1482 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1483 #define CIFS_SMALL_BUFFER 1
1484 #define CIFS_LARGE_BUFFER 2
1485 #define CIFS_IOVEC 4 /* array of response buffers */
1487 /* Type of Request to SendReceive2 */
1488 #define CIFS_BLOCKING_OP 1 /* operation can block */
1489 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1490 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1491 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1492 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1493 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1495 /* Type of request operation */
1496 #define CIFS_ECHO_OP 0x080 /* echo request */
1497 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1498 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1499 #define CIFS_OP_MASK 0x0380 /* mask request type */
1501 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1502 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1504 /* Security Flags: indicate type of session setup needed */
1505 #define CIFSSEC_MAY_SIGN 0x00001
1506 #define CIFSSEC_MAY_NTLM 0x00002
1507 #define CIFSSEC_MAY_NTLMV2 0x00004
1508 #define CIFSSEC_MAY_KRB5 0x00008
1509 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1510 #define CIFSSEC_MAY_LANMAN 0x00010
1511 #define CIFSSEC_MAY_PLNTXT 0x00020
1513 #define CIFSSEC_MAY_LANMAN 0
1514 #define CIFSSEC_MAY_PLNTXT 0
1515 #endif /* weak passwords */
1516 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1517 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1519 #define CIFSSEC_MUST_SIGN 0x01001
1520 /* note that only one of the following can be set so the
1521 result of setting MUST flags more than once will be to
1522 require use of the stronger protocol */
1523 #define CIFSSEC_MUST_NTLM 0x02002
1524 #define CIFSSEC_MUST_NTLMV2 0x04004
1525 #define CIFSSEC_MUST_KRB5 0x08008
1526 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1527 #define CIFSSEC_MUST_LANMAN 0x10010
1528 #define CIFSSEC_MUST_PLNTXT 0x20020
1529 #ifdef CONFIG_CIFS_UPCALL
1530 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1532 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1534 #else /* do not allow weak pw hash */
1535 #define CIFSSEC_MUST_LANMAN 0
1536 #define CIFSSEC_MUST_PLNTXT 0
1537 #ifdef CONFIG_CIFS_UPCALL
1538 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1540 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1542 #endif /* WEAK_PW_HASH */
1543 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1544 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1546 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1547 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1548 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1550 *****************************************************************
1551 * All constants go here
1552 *****************************************************************
1555 #define UID_HASH (16)
1558 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1559 * following to be declared.
1562 /****************************************************************************
1563 * Locking notes. All updates to global variables and lists should be
1564 * protected by spinlocks or semaphores.
1568 * GlobalMid_Lock protects:
1569 * list operations on pending_mid_q and oplockQ
1570 * updates to XID counters, multiplex id and SMB sequence numbers
1571 * tcp_ses_lock protects:
1572 * list operations on tcp and SMB session lists
1573 * tcon->open_file_lock protects the list of open files hanging off the tcon
1574 * cfile->file_info_lock protects counters and fields in cifs file struct
1575 * f_owner.lock protects certain per file struct operations
1576 * mapping->page_lock protects certain per page operations
1580 * sesSem operations on smb session
1581 * tconSem operations on tree connection
1582 * fh_sem file handle reconnection operations
1584 ****************************************************************************/
1586 #ifdef DECLARE_GLOBALS_HERE
1587 #define GLOBAL_EXTERN
1589 #define GLOBAL_EXTERN extern
1593 * the list of TCP_Server_Info structures, ie each of the sockets
1594 * connecting our client to a distinct server (ip address), is
1595 * chained together by cifs_tcp_ses_list. The list of all our SMB
1596 * sessions (and from that the tree connections) can be found
1597 * by iterating over cifs_tcp_ses_list
1599 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1602 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1603 * tcp session, and the list of tcon's per smb session. It also protects
1604 * the reference counters for the server, smb session, and tcon. Finally,
1605 * changes to the tcon->tidStatus should be done while holding this lock.
1606 * generally the locks should be taken in order tcp_ses_lock before
1607 * tcon->open_file_lock and that before file->file_info_lock since the
1608 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1610 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1612 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1613 /* Outstanding dir notify requests */
1614 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1615 /* DirNotify response queue */
1616 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1617 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1620 * Global transaction id (XID) information
1622 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1623 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1624 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1625 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1626 /* on midQ entries */
1628 * Global counters, updated atomically
1630 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1631 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1632 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1633 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1634 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1636 /* Various Debug counters */
1637 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1638 #ifdef CONFIG_CIFS_STATS2
1639 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1640 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1642 GLOBAL_EXTERN atomic_t smBufAllocCount;
1643 GLOBAL_EXTERN atomic_t midCount;
1646 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1647 GLOBAL_EXTERN bool lookupCacheEnabled;
1648 GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1649 with more secure ntlmssp2 challenge/resp */
1650 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1651 GLOBAL_EXTERN bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1652 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1653 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1654 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1655 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1657 #ifdef CONFIG_CIFS_ACL
1658 GLOBAL_EXTERN struct rb_root uidtree;
1659 GLOBAL_EXTERN struct rb_root gidtree;
1660 GLOBAL_EXTERN spinlock_t siduidlock;
1661 GLOBAL_EXTERN spinlock_t sidgidlock;
1662 GLOBAL_EXTERN struct rb_root siduidtree;
1663 GLOBAL_EXTERN struct rb_root sidgidtree;
1664 GLOBAL_EXTERN spinlock_t uidsidlock;
1665 GLOBAL_EXTERN spinlock_t gidsidlock;
1666 #endif /* CONFIG_CIFS_ACL */
1668 void cifs_oplock_break(struct work_struct *work);
1670 extern const struct slow_work_ops cifs_oplock_break_ops;
1671 extern struct workqueue_struct *cifsiod_wq;
1672 extern __u32 cifs_lock_secret;
1674 extern mempool_t *cifs_mid_poolp;
1676 /* Operations for different SMB versions */
1677 #define SMB1_VERSION_STRING "1.0"
1678 extern struct smb_version_operations smb1_operations;
1679 extern struct smb_version_values smb1_values;
1680 #define SMB20_VERSION_STRING "2.0"
1681 extern struct smb_version_operations smb20_operations;
1682 extern struct smb_version_values smb20_values;
1683 #define SMB21_VERSION_STRING "2.1"
1684 extern struct smb_version_operations smb21_operations;
1685 extern struct smb_version_values smb21_values;
1686 #define SMB30_VERSION_STRING "3.0"
1687 extern struct smb_version_operations smb30_operations;
1688 extern struct smb_version_values smb30_values;
1689 #define SMB302_VERSION_STRING "3.02"
1690 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1691 extern struct smb_version_values smb302_values;
1692 #define SMB311_VERSION_STRING "3.1.1"
1693 #define ALT_SMB311_VERSION_STRING "3.11"
1694 extern struct smb_version_operations smb311_operations;
1695 extern struct smb_version_values smb311_values;
1696 #endif /* _CIFS_GLOB_H */