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 #ifdef CONFIG_CIFS_SMB2
36 * The sizes of various internal tables and strings
38 #define MAX_UID_INFO 16
39 #define MAX_SES_INFO 2
40 #define MAX_TCON_INFO 4
42 #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
43 #define MAX_SERVER_SIZE 15
44 #define MAX_SHARE_SIZE 80
45 #define MAX_USERNAME_SIZE 256 /* reasonable maximum for current servers */
46 #define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */
48 #define CIFS_MIN_RCV_POOL 4
50 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
52 * default attribute cache timeout (jiffies)
54 #define CIFS_DEF_ACTIMEO (1 * HZ)
57 * max attribute cache timeout (jiffies) - 2^30
59 #define CIFS_MAX_ACTIMEO (1 << 30)
62 * MAX_REQ is the maximum number of requests that WE will send
63 * on one socket concurrently.
65 #define CIFS_MAX_REQ 32767
67 #define RFC1001_NAME_LEN 15
68 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
70 /* currently length of NIP6_FMT */
71 #define SERVER_NAME_LENGTH 40
72 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
74 /* used to define string lengths for reversing unicode strings */
76 /* (max path length + 1 for null) * 2 for unicode */
79 /* SMB echo "timeout" -- FIXME: tunable? */
80 #define SMB_ECHO_INTERVAL (60 * HZ)
84 #ifndef XATTR_DOS_ATTRIB
85 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
89 * CIFS vfs client Status information (based on what we know.)
92 /* associated with each tcp and smb session */
102 LANMAN = 0, /* Legacy LANMAN auth */
103 NTLM, /* Legacy NTLM012 auth with NTLM hash */
104 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
105 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
106 /* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
107 Kerberos, /* Kerberos via SPNEGO */
113 /* Netbios frames protocol not supported at this time */
121 /* crypto security descriptor definition */
123 struct shash_desc shash;
127 /* crypto hashing related structure/fields, not specific to a sec mech */
128 struct cifs_secmech {
129 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
130 struct crypto_shash *md5; /* md5 hash function */
131 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
132 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
135 /* per smb session structure/fields */
136 struct ntlmssp_auth {
137 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
138 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
139 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
140 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
148 struct cifs_sid osid;
149 struct cifs_sid gsid;
150 struct cifs_ntace *ntaces;
151 struct cifs_ace *aces;
155 *****************************************************************
156 * Except the CIFS PDUs themselves all the
157 * globally interesting structs should go here
158 *****************************************************************
167 struct TCP_Server_Info;
171 struct dfs_info3_param;
175 struct smb_version_operations {
176 int (*send_cancel)(struct TCP_Server_Info *, void *,
177 struct mid_q_entry *);
178 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
179 /* setup request: allocate mid, sign message */
180 int (*setup_request)(struct cifs_ses *, struct kvec *, unsigned int,
181 struct mid_q_entry **);
182 /* setup async request: allocate mid, sign message */
183 int (*setup_async_request)(struct TCP_Server_Info *, struct kvec *,
184 unsigned int, struct mid_q_entry **);
185 /* check response: verify signature, map error */
186 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
188 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
190 void (*set_credits)(struct TCP_Server_Info *, const int);
191 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
192 unsigned int (*get_credits)(struct mid_q_entry *);
193 __u64 (*get_next_mid)(struct TCP_Server_Info *);
194 /* data offset from read response message */
195 unsigned int (*read_data_offset)(char *);
196 /* data length from read response message */
197 unsigned int (*read_data_length)(char *);
198 /* map smb to linux error */
199 int (*map_error)(char *, bool);
200 /* find mid corresponding to the response message */
201 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
202 void (*dump_detail)(void *);
203 void (*clear_stats)(struct cifs_tcon *);
204 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
205 /* verify the message */
206 int (*check_message)(char *, unsigned int);
207 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
208 /* process transaction2 response */
209 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
211 /* check if we need to negotiate */
212 bool (*need_neg)(struct TCP_Server_Info *);
213 /* negotiate to the server */
214 int (*negotiate)(const unsigned int, struct cifs_ses *);
215 /* setup smb sessionn */
216 int (*sess_setup)(const unsigned int, struct cifs_ses *,
217 const struct nls_table *);
218 /* close smb session */
219 int (*logoff)(const unsigned int, struct cifs_ses *);
220 /* connect to a server share */
221 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
222 struct cifs_tcon *, const struct nls_table *);
223 /* close tree connecion */
224 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
225 /* get DFS referrals */
226 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
227 const char *, struct dfs_info3_param **,
228 unsigned int *, const struct nls_table *, int);
229 /* informational QFS call */
230 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
231 /* check if a path is accessible or not */
232 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
233 struct cifs_sb_info *, const char *);
234 /* query path data from the server */
235 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
236 struct cifs_sb_info *, const char *,
237 FILE_ALL_INFO *, bool *);
238 /* get server index number */
239 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
240 struct cifs_sb_info *, const char *,
241 u64 *uniqueid, FILE_ALL_INFO *);
242 /* build a full path to the root of the mount */
243 char * (*build_path_to_root)(struct smb_vol *, struct cifs_sb_info *,
245 /* check if we can send an echo or nor */
246 bool (*can_echo)(struct TCP_Server_Info *);
247 /* send echo request */
248 int (*echo)(struct TCP_Server_Info *);
249 /* create directory */
250 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
251 struct cifs_sb_info *);
252 /* set info on created directory */
253 void (*mkdir_setinfo)(struct inode *, const char *,
254 struct cifs_sb_info *, struct cifs_tcon *,
256 /* remove directory */
257 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
258 struct cifs_sb_info *);
260 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
261 struct cifs_sb_info *);
262 /* open, rename and delete file */
263 int (*rename_pending_delete)(const char *, struct dentry *,
267 struct smb_version_values {
268 char *version_string;
269 __u32 large_lock_type;
270 __u32 exclusive_lock_type;
271 __u32 shared_lock_type;
272 __u32 unlock_lock_type;
274 size_t max_header_size;
275 size_t read_rsp_size;
277 unsigned int cap_unix;
278 unsigned int cap_nt_find;
279 unsigned int cap_large_files;
282 #define HEADER_SIZE(server) (server->vals->header_size)
283 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
291 char *iocharset; /* local code page for mapping to and from Unicode */
292 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
293 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
309 bool no_psx_acl:1; /* set if posix acl support should be disabled */
311 bool backupuid_specified; /* mount option backupuid is specified */
312 bool backupgid_specified; /* mount option backupgid is specified */
313 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
314 bool server_ino:1; /* use inode numbers from server ie UniqueId */
316 bool strict_io:1; /* strict cache behavior */
317 bool remap:1; /* set to remap seven reserved chars in filenames */
318 bool posix_paths:1; /* unset to not ask for posix pathnames. */
321 bool nullauth:1; /* attempt to authenticate with null user */
322 bool nocase:1; /* request case insensitive filenames */
323 bool nobrl:1; /* disable sending byte range locks to srv */
324 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
325 bool seal:1; /* request transport encryption on share */
326 bool nodfs:1; /* Do not request DFS, even if available */
327 bool local_lease:1; /* check leases only on local system, not remote */
330 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
331 bool fsc:1; /* enable fscache */
332 bool mfsymlinks:1; /* use Minshall+French Symlinks */
334 bool rwpidforward:1; /* pid forward for read/write operations */
337 bool sockopt_tcp_nodelay:1;
338 unsigned short int port;
339 unsigned long actimeo; /* attribute cache timeout (jiffies) */
340 struct smb_version_operations *ops;
341 struct smb_version_values *vals;
343 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
344 struct nls_table *local_nls;
347 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
348 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
349 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
350 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
351 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
352 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
353 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
354 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
355 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
356 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
358 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
359 MS_NODEV | MS_SYNCHRONOUS)
361 struct cifs_mnt_data {
362 struct cifs_sb_info *cifs_sb;
367 static inline unsigned int
368 get_rfc1002_length(void *buf)
370 return be32_to_cpu(*((__be32 *)buf));
374 inc_rfc1001_len(void *buf, int count)
376 be32_add_cpu((__be32 *)buf, count);
379 struct TCP_Server_Info {
380 struct list_head tcp_ses_list;
381 struct list_head smb_ses_list;
382 int srv_count; /* reference counter */
383 /* 15 character server name + 0x20 16th byte indicating type = srv */
384 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
385 struct smb_version_operations *ops;
386 struct smb_version_values *vals;
387 enum statusEnum tcpStatus; /* what we think the status is */
388 char *hostname; /* hostname portion of UNC string */
389 struct socket *ssocket;
390 struct sockaddr_storage dstaddr;
391 struct sockaddr_storage srcaddr; /* locally bind to this IP */
395 wait_queue_head_t response_q;
396 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
397 struct list_head pending_mid_q;
398 bool noblocksnd; /* use blocking sendmsg */
399 bool noautotune; /* do not autotune send buf sizes */
401 int credits; /* send no more requests at once */
402 unsigned int in_flight; /* number of requests on the wire to server */
403 spinlock_t req_lock; /* protect the two values above */
404 struct mutex srv_mutex;
405 struct task_struct *tsk;
406 char server_GUID[16];
408 bool session_estab; /* mark when very first sess is established */
409 #ifdef CONFIG_CIFS_SMB2
410 int echo_credits; /* echo reserved slots */
411 int oplock_credits; /* oplock break reserved slots */
412 bool echoes:1; /* enable echoes */
414 u16 dialect; /* dialect index that server chose */
415 enum securityEnum secType;
416 bool oplocks:1; /* enable oplocks */
417 unsigned int maxReq; /* Clients should submit no more */
418 /* than maxReq distinct unanswered SMBs to the server when using */
419 /* multiplexed reads or writes */
420 unsigned int maxBuf; /* maxBuf specifies the maximum */
421 /* message size the server can send or receive for non-raw SMBs */
422 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
423 /* when socket is setup (and during reconnect) before NegProt sent */
424 unsigned int max_rw; /* maxRw specifies the maximum */
425 /* message size the server can send or receive for */
426 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
427 unsigned int max_vcs; /* maximum number of smb sessions, at least
428 those that can be specified uniquely with
430 unsigned int capabilities; /* selective disabling of caps by smb sess */
431 int timeAdj; /* Adjust for difference in server time zone in sec */
432 __u64 CurrentMid; /* multiplex id - rotating counter */
433 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
434 /* 16th byte of RFC1001 workstation name is always null */
435 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
436 __u32 sequence_number; /* for signing, protected by srv_mutex */
437 struct session_key session_key;
438 unsigned long lstrp; /* when we got last response from this server */
439 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
440 /* extended security flavors that server supports */
441 bool sec_ntlmssp; /* supports NTLMSSP */
442 bool sec_kerberosu2u; /* supports U2U Kerberos */
443 bool sec_kerberos; /* supports plain Kerberos */
444 bool sec_mskerberos; /* supports legacy MS Kerberos */
445 bool large_buf; /* is current buffer large? */
446 struct delayed_work echo; /* echo ping workqueue job */
447 struct kvec *iov; /* reusable kvec array for receives */
448 unsigned int nr_iov; /* number of kvecs in array */
449 char *smallbuf; /* pointer to current "small" buffer */
450 char *bigbuf; /* pointer to current "big" buffer */
451 unsigned int total_read; /* total amount of data read in this pass */
452 #ifdef CONFIG_CIFS_FSCACHE
453 struct fscache_cookie *fscache; /* client index cache cookie */
455 #ifdef CONFIG_CIFS_STATS2
456 atomic_t in_send; /* requests trying to send */
457 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
459 #ifdef CONFIG_CIFS_SMB2
460 unsigned int max_read;
461 unsigned int max_write;
462 #endif /* CONFIG_CIFS_SMB2 */
465 static inline unsigned int
466 in_flight(struct TCP_Server_Info *server)
469 spin_lock(&server->req_lock);
470 num = server->in_flight;
471 spin_unlock(&server->req_lock);
476 has_credits(struct TCP_Server_Info *server, int *credits)
479 spin_lock(&server->req_lock);
481 spin_unlock(&server->req_lock);
486 add_credits(struct TCP_Server_Info *server, const unsigned int add,
489 server->ops->add_credits(server, add, optype);
493 set_credits(struct TCP_Server_Info *server, const int val)
495 server->ops->set_credits(server, val);
499 get_next_mid(struct TCP_Server_Info *server)
501 return server->ops->get_next_mid(server);
505 * Macros to allow the TCP_Server_Info->net field and related code to drop out
506 * when CONFIG_NET_NS isn't set.
511 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
516 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
523 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
528 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
535 * Session structure. One of these for each uid session with a particular host
538 struct list_head smb_ses_list;
539 struct list_head tcon_list;
540 struct mutex session_mutex;
541 struct TCP_Server_Info *server; /* pointer to server info */
542 int ses_count; /* reference counter */
543 enum statusEnum status;
544 unsigned overrideSecFlg; /* if non-zero override global sec flags */
545 __u16 ipc_tid; /* special tid for connection to IPC share */
548 char *serverOS; /* name of operating system underlying server */
549 char *serverNOS; /* name of network operating system of server */
550 char *serverDomain; /* security realm of server */
551 __u64 Suid; /* remote smb uid */
552 uid_t linux_uid; /* overriding owner of files on the mount */
553 uid_t cred_uid; /* owner of credentials */
554 unsigned int capabilities;
555 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
556 TCP names - will ipv6 and sctp addresses fit? */
557 char *user_name; /* must not be null except during init of sess
558 and after mount option parsing we fill it */
561 struct session_key auth_key;
562 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
563 bool need_reconnect:1; /* connection reset, uid now invalid */
564 #ifdef CONFIG_CIFS_SMB2
566 #endif /* CONFIG_CIFS_SMB2 */
568 /* no more than one of the following three session flags may be set */
569 #define CIFS_SES_NT4 1
570 #define CIFS_SES_OS2 2
571 #define CIFS_SES_W9X 4
572 /* following flag is set for old servers such as OS2 (and Win95?)
573 which do not negotiate NTLM or POSIX dialects, but instead
574 negotiate one of the older LANMAN dialects */
575 #define CIFS_SES_LANMAN 8
578 cap_unix(struct cifs_ses *ses)
580 return ses->server->vals->cap_unix & ses->capabilities;
584 * there is one of these for each connection to a resource on a particular
588 struct list_head tcon_list;
590 struct list_head openFileList;
591 struct cifs_ses *ses; /* pointer to session associated with */
592 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
593 char *nativeFileSystem;
594 char *password; /* for share-level security */
595 __u32 tid; /* The 4 byte tree id */
596 __u16 Flags; /* optional support bits */
597 enum statusEnum tidStatus;
598 #ifdef CONFIG_CIFS_STATS
599 atomic_t num_smbs_sent;
604 atomic_t num_flushes;
605 atomic_t num_oplock_brks;
608 atomic_t num_deletes;
610 atomic_t num_posixopens;
611 atomic_t num_posixmkdirs;
613 atomic_t num_renames;
614 atomic_t num_t2renames;
618 atomic_t num_hardlinks;
619 atomic_t num_symlinks;
621 atomic_t num_acl_get;
622 atomic_t num_acl_set;
624 #ifdef CONFIG_CIFS_SMB2
626 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
627 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
629 #endif /* CONFIG_CIFS_SMB2 */
631 #ifdef CONFIG_CIFS_STATS2
632 unsigned long long time_writes;
633 unsigned long long time_reads;
634 unsigned long long time_opens;
635 unsigned long long time_deletes;
636 unsigned long long time_closes;
637 unsigned long long time_mkdirs;
638 unsigned long long time_rmdirs;
639 unsigned long long time_renames;
640 unsigned long long time_t2renames;
641 unsigned long long time_ffirst;
642 unsigned long long time_fnext;
643 unsigned long long time_fclose;
644 #endif /* CONFIG_CIFS_STATS2 */
647 spinlock_t stat_lock;
648 #endif /* CONFIG_CIFS_STATS */
649 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
650 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
651 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
652 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
655 bool seal:1; /* transport encryption for this mounted share */
656 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
657 for this mount even if server would support */
658 bool local_lease:1; /* check leases (only) on local system not remote */
659 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
660 bool need_reconnect:1; /* connection reset, tid now invalid */
661 #ifdef CONFIG_CIFS_SMB2
662 bool print:1; /* set if connection to printer share */
663 bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
666 __u32 maximal_access;
667 __u32 vol_serial_number;
668 __le64 vol_create_time;
669 #endif /* CONFIG_CIFS_SMB2 */
670 #ifdef CONFIG_CIFS_FSCACHE
671 u64 resource_id; /* server resource id */
672 struct fscache_cookie *fscache; /* cookie for share */
674 /* BB add field for back pointer to sb struct(s)? */
678 * This is a refcounted and timestamped container for a tcon pointer. The
679 * container holds a tcon reference. It is considered safe to free one of
680 * these when the tl_count goes to 0. The tl_time is the time of the last
681 * "get" on the container.
684 struct rb_node tl_rbnode;
686 unsigned long tl_flags;
687 #define TCON_LINK_MASTER 0
688 #define TCON_LINK_PENDING 1
689 #define TCON_LINK_IN_TREE 2
690 unsigned long tl_time;
692 struct cifs_tcon *tl_tcon;
695 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
697 static inline struct cifs_tcon *
698 tlink_tcon(struct tcon_link *tlink)
700 return tlink->tl_tcon;
703 extern void cifs_put_tlink(struct tcon_link *tlink);
705 static inline struct tcon_link *
706 cifs_get_tlink(struct tcon_link *tlink)
708 if (tlink && !IS_ERR(tlink))
709 atomic_inc(&tlink->tl_count);
713 /* This function is always expected to succeed */
714 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
717 * This info hangs off the cifsFileInfo structure, pointed to by llist.
718 * This is used to track byte stream locks on the file
720 struct cifsLockInfo {
721 struct list_head llist; /* pointer to next cifsLockInfo */
722 struct list_head blist; /* pointer to locks blocked on this */
723 wait_queue_head_t block_q;
731 * One of these for each open instance of a file
733 struct cifs_search_info {
734 loff_t index_of_last_entry;
735 __u16 entries_in_buffer;
738 char *ntwrk_buf_start;
739 char *srch_entries_start;
741 const char *presume_name;
742 unsigned int resume_name_len;
746 bool smallBuf:1; /* so we know which buf_release function to call */
753 struct cifsFileInfo {
754 struct list_head tlist; /* pointer to next fid owned by tcon */
755 struct list_head flist; /* next fid (file instance) for this inode */
756 struct list_head llist; /*
757 * brlocks held by this fid, protected by
758 * lock_mutex from cifsInodeInfo structure
760 unsigned int uid; /* allows finding which FileInfo structure */
761 __u32 pid; /* process id who opened file */
762 struct cifs_fid fid; /* file id from remote */
763 /* BB add lock scope info here if needed */ ;
764 /* lock scope id (0 if none) */
765 struct dentry *dentry;
766 unsigned int f_flags;
767 struct tcon_link *tlink;
768 bool invalidHandle:1; /* file closed via session abend */
769 bool oplock_break_cancelled:1;
770 int count; /* refcount protected by cifs_file_list_lock */
771 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
772 struct cifs_search_info srch_inf;
773 struct work_struct oplock_break; /* work for oplock breaks */
776 struct cifs_io_parms {
781 struct cifs_tcon *tcon;
785 * Take a reference on the file private data. Must be called with
786 * cifs_file_list_lock held.
789 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
794 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
795 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
798 * One of these for each file inode
801 struct cifsInodeInfo {
802 bool can_cache_brlcks;
803 struct mutex lock_mutex; /*
804 * protect the field above and llist
805 * from every cifsFileInfo structure
808 /* BB add in lists for dirty pages i.e. write caching info for oplock */
809 struct list_head openFileList;
810 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
811 bool clientCanCacheRead; /* read oplock */
812 bool clientCanCacheAll; /* read and writebehind oplock */
813 bool delete_pending; /* DELETE_ON_CLOSE is set */
814 bool invalid_mapping; /* pagecache is invalid */
815 unsigned long time; /* jiffies of last update of inode */
816 u64 server_eof; /* current file size on server -- protected by i_lock */
817 u64 uniqueid; /* server inode number */
818 u64 createtime; /* creation time on server */
819 #ifdef CONFIG_CIFS_FSCACHE
820 struct fscache_cookie *fscache;
822 struct inode vfs_inode;
825 static inline struct cifsInodeInfo *
826 CIFS_I(struct inode *inode)
828 return container_of(inode, struct cifsInodeInfo, vfs_inode);
831 static inline struct cifs_sb_info *
832 CIFS_SB(struct super_block *sb)
834 return sb->s_fs_info;
837 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
839 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
846 convert_delimiter(char *path, char delim)
859 for (i = 0; path[i] != '\0'; i++) {
860 if (path[i] == old_delim)
866 build_path_to_root(struct smb_vol *vol, struct cifs_sb_info *cifs_sb,
867 struct cifs_tcon *tcon)
869 if (!vol->ops->build_path_to_root)
871 return vol->ops->build_path_to_root(vol, cifs_sb, tcon);
874 #ifdef CONFIG_CIFS_STATS
875 #define cifs_stats_inc atomic_inc
877 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
881 spin_lock(&tcon->stat_lock);
882 tcon->bytes_written += bytes;
883 spin_unlock(&tcon->stat_lock);
887 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
890 spin_lock(&tcon->stat_lock);
891 tcon->bytes_read += bytes;
892 spin_unlock(&tcon->stat_lock);
896 #define cifs_stats_inc(field) do {} while (0)
897 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
898 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
904 * This is the prototype for the mid receive function. This function is for
905 * receiving the rest of the SMB frame, starting with the WordCount (which is
906 * just after the MID in struct smb_hdr). Note:
908 * - This will be called by cifsd, with no locks held.
909 * - The mid will still be on the pending_mid_q.
910 * - mid->resp_buf will point to the current buffer.
912 * Returns zero on a successful receive, or an error. The receive state in
913 * the TCP_Server_Info will also be updated.
915 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
916 struct mid_q_entry *mid);
919 * This is the prototype for the mid callback function. This is called once the
920 * mid has been received off of the socket. When creating one, take special
921 * care to avoid deadlocks. Things to bear in mind:
923 * - it will be called by cifsd, with no locks held
924 * - the mid will be removed from any lists
926 typedef void (mid_callback_t)(struct mid_q_entry *mid);
928 /* one of these for every pending CIFS request to the server */
930 struct list_head qhead; /* mids waiting on reply from this server */
931 struct TCP_Server_Info *server; /* server corresponding to this mid */
932 __u64 mid; /* multiplex id */
933 __u32 pid; /* process id */
934 __u32 sequence_number; /* for CIFS signing */
935 unsigned long when_alloc; /* when mid was created */
936 #ifdef CONFIG_CIFS_STATS2
937 unsigned long when_sent; /* time when smb send finished */
938 unsigned long when_received; /* when demux complete (taken off wire) */
940 mid_receive_t *receive; /* call receive callback */
941 mid_callback_t *callback; /* call completion callback */
942 void *callback_data; /* general purpose pointer for callback */
943 void *resp_buf; /* pointer to received SMB header */
944 int mid_state; /* wish this were enum but can not pass to wait_event */
945 __le16 command; /* smb command code */
946 bool large_buf:1; /* if valid response, is pointer to large buf */
947 bool multiRsp:1; /* multiple trans2 responses for one request */
948 bool multiEnd:1; /* both received */
951 /* Make code in transport.c a little cleaner by moving
952 update of optional stats into function below */
953 #ifdef CONFIG_CIFS_STATS2
955 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
957 atomic_inc(&server->in_send);
960 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
962 atomic_dec(&server->in_send);
965 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
967 atomic_inc(&server->num_waiters);
970 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
972 atomic_dec(&server->num_waiters);
975 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
977 mid->when_sent = jiffies;
980 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
983 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
987 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
991 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
995 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1000 /* for pending dnotify requests */
1001 struct dir_notify_req {
1002 struct list_head lhead;
1009 __u32 filter; /* CompletionFilter (for multishot) */
1014 struct dfs_info3_param {
1015 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1024 * common struct for holding inode info when searching for or updating an
1025 * inode with new info
1028 #define CIFS_FATTR_DFS_REFERRAL 0x1
1029 #define CIFS_FATTR_DELETE_PENDING 0x2
1030 #define CIFS_FATTR_NEED_REVAL 0x4
1031 #define CIFS_FATTR_INO_COLLISION 0x8
1044 unsigned int cf_nlink;
1045 unsigned int cf_dtype;
1046 struct timespec cf_atime;
1047 struct timespec cf_mtime;
1048 struct timespec cf_ctime;
1051 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1054 kfree(param->path_name);
1055 kfree(param->node_name);
1060 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1061 int number_of_items)
1064 if ((number_of_items == 0) || (param == NULL))
1066 for (i = 0; i < number_of_items; i++) {
1067 kfree(param[i].path_name);
1068 kfree(param[i].node_name);
1074 #define MID_REQUEST_ALLOCATED 1
1075 #define MID_REQUEST_SUBMITTED 2
1076 #define MID_RESPONSE_RECEIVED 4
1077 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1078 #define MID_RESPONSE_MALFORMED 0x10
1079 #define MID_SHUTDOWN 0x20
1081 /* Types of response buffer returned from SendReceive2 */
1082 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1083 #define CIFS_SMALL_BUFFER 1
1084 #define CIFS_LARGE_BUFFER 2
1085 #define CIFS_IOVEC 4 /* array of response buffers */
1087 /* Type of Request to SendReceive2 */
1088 #define CIFS_BLOCKING_OP 1 /* operation can block */
1089 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1090 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1091 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1092 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1093 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1095 /* Type of request operation */
1096 #define CIFS_ECHO_OP 0x080 /* echo request */
1097 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1098 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1099 #define CIFS_OP_MASK 0x0380 /* mask request type */
1101 /* Security Flags: indicate type of session setup needed */
1102 #define CIFSSEC_MAY_SIGN 0x00001
1103 #define CIFSSEC_MAY_NTLM 0x00002
1104 #define CIFSSEC_MAY_NTLMV2 0x00004
1105 #define CIFSSEC_MAY_KRB5 0x00008
1106 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1107 #define CIFSSEC_MAY_LANMAN 0x00010
1108 #define CIFSSEC_MAY_PLNTXT 0x00020
1110 #define CIFSSEC_MAY_LANMAN 0
1111 #define CIFSSEC_MAY_PLNTXT 0
1112 #endif /* weak passwords */
1113 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1114 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1116 #define CIFSSEC_MUST_SIGN 0x01001
1117 /* note that only one of the following can be set so the
1118 result of setting MUST flags more than once will be to
1119 require use of the stronger protocol */
1120 #define CIFSSEC_MUST_NTLM 0x02002
1121 #define CIFSSEC_MUST_NTLMV2 0x04004
1122 #define CIFSSEC_MUST_KRB5 0x08008
1123 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1124 #define CIFSSEC_MUST_LANMAN 0x10010
1125 #define CIFSSEC_MUST_PLNTXT 0x20020
1126 #ifdef CONFIG_CIFS_UPCALL
1127 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1129 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1131 #else /* do not allow weak pw hash */
1132 #define CIFSSEC_MUST_LANMAN 0
1133 #define CIFSSEC_MUST_PLNTXT 0
1134 #ifdef CONFIG_CIFS_UPCALL
1135 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1137 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1139 #endif /* WEAK_PW_HASH */
1140 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1141 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1143 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
1144 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1145 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1147 *****************************************************************
1148 * All constants go here
1149 *****************************************************************
1152 #define UID_HASH (16)
1155 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1156 * following to be declared.
1159 /****************************************************************************
1160 * Locking notes. All updates to global variables and lists should be
1161 * protected by spinlocks or semaphores.
1165 * GlobalMid_Lock protects:
1166 * list operations on pending_mid_q and oplockQ
1167 * updates to XID counters, multiplex id and SMB sequence numbers
1168 * cifs_file_list_lock protects:
1169 * list operations on tcp and SMB session lists and tCon lists
1170 * f_owner.lock protects certain per file struct operations
1171 * mapping->page_lock protects certain per page operations
1175 * sesSem operations on smb session
1176 * tconSem operations on tree connection
1177 * fh_sem file handle reconnection operations
1179 ****************************************************************************/
1181 #ifdef DECLARE_GLOBALS_HERE
1182 #define GLOBAL_EXTERN
1184 #define GLOBAL_EXTERN extern
1188 * the list of TCP_Server_Info structures, ie each of the sockets
1189 * connecting our client to a distinct server (ip address), is
1190 * chained together by cifs_tcp_ses_list. The list of all our SMB
1191 * sessions (and from that the tree connections) can be found
1192 * by iterating over cifs_tcp_ses_list
1194 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1197 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1198 * tcp session, and the list of tcon's per smb session. It also protects
1199 * the reference counters for the server, smb session, and tcon. Finally,
1200 * changes to the tcon->tidStatus should be done while holding this lock.
1202 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1205 * This lock protects the cifs_file->llist and cifs_file->flist
1206 * list operations, and updates to some flags (cifs_file->invalidHandle)
1207 * It will be moved to either use the tcon->stat_lock or equivalent later.
1208 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1209 * the cifs_tcp_ses_lock must be grabbed first and released last.
1211 GLOBAL_EXTERN spinlock_t cifs_file_list_lock;
1213 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1214 /* Outstanding dir notify requests */
1215 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1216 /* DirNotify response queue */
1217 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1218 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1221 * Global transaction id (XID) information
1223 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1224 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1225 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1226 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1227 /* on midQ entries */
1229 * Global counters, updated atomically
1231 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1232 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1233 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1234 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1235 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1237 /* Various Debug counters */
1238 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1239 #ifdef CONFIG_CIFS_STATS2
1240 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1241 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1243 GLOBAL_EXTERN atomic_t smBufAllocCount;
1244 GLOBAL_EXTERN atomic_t midCount;
1247 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1248 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1249 GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1250 with more secure ntlmssp2 challenge/resp */
1251 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1252 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1253 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1254 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1255 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1256 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1258 #ifdef CONFIG_CIFS_ACL
1259 GLOBAL_EXTERN struct rb_root uidtree;
1260 GLOBAL_EXTERN struct rb_root gidtree;
1261 GLOBAL_EXTERN spinlock_t siduidlock;
1262 GLOBAL_EXTERN spinlock_t sidgidlock;
1263 GLOBAL_EXTERN struct rb_root siduidtree;
1264 GLOBAL_EXTERN struct rb_root sidgidtree;
1265 GLOBAL_EXTERN spinlock_t uidsidlock;
1266 GLOBAL_EXTERN spinlock_t gidsidlock;
1267 #endif /* CONFIG_CIFS_ACL */
1269 void cifs_oplock_break(struct work_struct *work);
1271 extern const struct slow_work_ops cifs_oplock_break_ops;
1272 extern struct workqueue_struct *cifsiod_wq;
1274 extern mempool_t *cifs_mid_poolp;
1276 /* Operations for different SMB versions */
1277 #define SMB1_VERSION_STRING "1.0"
1278 extern struct smb_version_operations smb1_operations;
1279 extern struct smb_version_values smb1_values;
1280 #define SMB21_VERSION_STRING "2.1"
1281 extern struct smb_version_operations smb21_operations;
1282 extern struct smb_version_values smb21_values;
1283 #endif /* _CIFS_GLOB_H */