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>
33 * The sizes of various internal tables and strings
35 #define MAX_UID_INFO 16
36 #define MAX_SES_INFO 2
37 #define MAX_TCON_INFO 4
39 #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
40 #define MAX_SERVER_SIZE 15
41 #define MAX_SHARE_SIZE 80
42 #define MAX_USERNAME_SIZE 256 /* reasonable maximum for current servers */
43 #define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */
45 #define CIFS_MIN_RCV_POOL 4
47 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
49 * default attribute cache timeout (jiffies)
51 #define CIFS_DEF_ACTIMEO (1 * HZ)
54 * max attribute cache timeout (jiffies) - 2^30
56 #define CIFS_MAX_ACTIMEO (1 << 30)
59 * MAX_REQ is the maximum number of requests that WE will send
60 * on one socket concurrently.
62 #define CIFS_MAX_REQ 32767
64 #define RFC1001_NAME_LEN 15
65 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
67 /* currently length of NIP6_FMT */
68 #define SERVER_NAME_LENGTH 40
69 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
71 /* used to define string lengths for reversing unicode strings */
73 /* (max path length + 1 for null) * 2 for unicode */
78 #ifndef XATTR_DOS_ATTRIB
79 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
83 * CIFS vfs client Status information (based on what we know.)
86 /* associated with each tcp and smb session */
96 LANMAN = 0, /* Legacy LANMAN auth */
97 NTLM, /* Legacy NTLM012 auth with NTLM hash */
98 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
99 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
100 /* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
101 Kerberos, /* Kerberos via SPNEGO */
107 /* Netbios frames protocol not supported at this time */
115 /* crypto security descriptor definition */
117 struct shash_desc shash;
121 /* crypto hashing related structure/fields, not specific to a sec mech */
122 struct cifs_secmech {
123 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
124 struct crypto_shash *md5; /* md5 hash function */
125 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
126 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
129 /* per smb session structure/fields */
130 struct ntlmssp_auth {
131 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
132 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
133 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
134 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
142 struct cifs_sid osid;
143 struct cifs_sid gsid;
144 struct cifs_ntace *ntaces;
145 struct cifs_ace *aces;
149 *****************************************************************
150 * Except the CIFS PDUs themselves all the
151 * globally interesting structs should go here
152 *****************************************************************
161 struct TCP_Server_Info;
166 struct smb_version_operations {
167 int (*send_cancel)(struct TCP_Server_Info *, void *,
168 struct mid_q_entry *);
169 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
170 /* setup request: allocate mid, sign message */
171 int (*setup_request)(struct cifs_ses *, struct kvec *, unsigned int,
172 struct mid_q_entry **);
173 /* check response: verify signature, map error */
174 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
176 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
178 void (*set_credits)(struct TCP_Server_Info *, const int);
179 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
180 unsigned int (*get_credits)(struct mid_q_entry *);
181 __u64 (*get_next_mid)(struct TCP_Server_Info *);
182 /* data offset from read response message */
183 unsigned int (*read_data_offset)(char *);
184 /* data length from read response message */
185 unsigned int (*read_data_length)(char *);
186 /* map smb to linux error */
187 int (*map_error)(char *, bool);
188 /* find mid corresponding to the response message */
189 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
190 void (*dump_detail)(void *);
191 /* verify the message */
192 int (*check_message)(char *, unsigned int);
193 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
194 /* process transaction2 response */
195 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
197 /* check if we need to negotiate */
198 bool (*need_neg)(struct TCP_Server_Info *);
199 /* negotiate to the server */
200 int (*negotiate)(const unsigned int, struct cifs_ses *);
201 /* setup smb sessionn */
202 int (*sess_setup)(const unsigned int, struct cifs_ses *,
203 const struct nls_table *);
204 /* close smb session */
205 int (*logoff)(const unsigned int, struct cifs_ses *);
206 /* connect to a server share */
207 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
208 struct cifs_tcon *, const struct nls_table *);
209 /* close tree connecion */
210 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
213 struct smb_version_values {
214 char *version_string;
215 __u32 large_lock_type;
216 __u32 exclusive_lock_type;
217 __u32 shared_lock_type;
218 __u32 unlock_lock_type;
220 size_t max_header_size;
221 size_t read_rsp_size;
225 #define HEADER_SIZE(server) (server->vals->header_size)
226 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
234 char *iocharset; /* local code page for mapping to and from Unicode */
235 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
236 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
252 bool no_psx_acl:1; /* set if posix acl support should be disabled */
254 bool backupuid_specified; /* mount option backupuid is specified */
255 bool backupgid_specified; /* mount option backupgid is specified */
256 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
257 bool server_ino:1; /* use inode numbers from server ie UniqueId */
259 bool strict_io:1; /* strict cache behavior */
260 bool remap:1; /* set to remap seven reserved chars in filenames */
261 bool posix_paths:1; /* unset to not ask for posix pathnames. */
264 bool nullauth:1; /* attempt to authenticate with null user */
265 bool nocase:1; /* request case insensitive filenames */
266 bool nobrl:1; /* disable sending byte range locks to srv */
267 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
268 bool seal:1; /* request transport encryption on share */
269 bool nodfs:1; /* Do not request DFS, even if available */
270 bool local_lease:1; /* check leases only on local system, not remote */
273 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
274 bool fsc:1; /* enable fscache */
275 bool mfsymlinks:1; /* use Minshall+French Symlinks */
277 bool rwpidforward:1; /* pid forward for read/write operations */
280 bool sockopt_tcp_nodelay:1;
281 unsigned short int port;
282 unsigned long actimeo; /* attribute cache timeout (jiffies) */
283 struct smb_version_operations *ops;
284 struct smb_version_values *vals;
286 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
287 struct nls_table *local_nls;
290 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
291 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
292 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
293 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
294 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
295 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
296 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
297 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
298 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
299 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
301 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
302 MS_NODEV | MS_SYNCHRONOUS)
304 struct cifs_mnt_data {
305 struct cifs_sb_info *cifs_sb;
310 static inline unsigned int
311 get_rfc1002_length(void *buf)
313 return be32_to_cpu(*((__be32 *)buf));
316 struct TCP_Server_Info {
317 struct list_head tcp_ses_list;
318 struct list_head smb_ses_list;
319 int srv_count; /* reference counter */
320 /* 15 character server name + 0x20 16th byte indicating type = srv */
321 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
322 struct smb_version_operations *ops;
323 struct smb_version_values *vals;
324 enum statusEnum tcpStatus; /* what we think the status is */
325 char *hostname; /* hostname portion of UNC string */
326 struct socket *ssocket;
327 struct sockaddr_storage dstaddr;
328 struct sockaddr_storage srcaddr; /* locally bind to this IP */
332 wait_queue_head_t response_q;
333 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
334 struct list_head pending_mid_q;
335 bool noblocksnd; /* use blocking sendmsg */
336 bool noautotune; /* do not autotune send buf sizes */
338 int credits; /* send no more requests at once */
339 unsigned int in_flight; /* number of requests on the wire to server */
340 spinlock_t req_lock; /* protect the two values above */
341 struct mutex srv_mutex;
342 struct task_struct *tsk;
343 char server_GUID[16];
345 bool session_estab; /* mark when very first sess is established */
346 u16 dialect; /* dialect index that server chose */
347 enum securityEnum secType;
348 bool oplocks:1; /* enable oplocks */
349 unsigned int maxReq; /* Clients should submit no more */
350 /* than maxReq distinct unanswered SMBs to the server when using */
351 /* multiplexed reads or writes */
352 unsigned int maxBuf; /* maxBuf specifies the maximum */
353 /* message size the server can send or receive for non-raw SMBs */
354 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
355 /* when socket is setup (and during reconnect) before NegProt sent */
356 unsigned int max_rw; /* maxRw specifies the maximum */
357 /* message size the server can send or receive for */
358 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
359 unsigned int max_vcs; /* maximum number of smb sessions, at least
360 those that can be specified uniquely with
362 int capabilities; /* allow selective disabling of caps by smb sess */
363 int timeAdj; /* Adjust for difference in server time zone in sec */
364 __u64 CurrentMid; /* multiplex id - rotating counter */
365 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
366 /* 16th byte of RFC1001 workstation name is always null */
367 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
368 __u32 sequence_number; /* for signing, protected by srv_mutex */
369 struct session_key session_key;
370 unsigned long lstrp; /* when we got last response from this server */
371 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
372 /* extended security flavors that server supports */
373 bool sec_ntlmssp; /* supports NTLMSSP */
374 bool sec_kerberosu2u; /* supports U2U Kerberos */
375 bool sec_kerberos; /* supports plain Kerberos */
376 bool sec_mskerberos; /* supports legacy MS Kerberos */
377 bool large_buf; /* is current buffer large? */
378 struct delayed_work echo; /* echo ping workqueue job */
379 struct kvec *iov; /* reusable kvec array for receives */
380 unsigned int nr_iov; /* number of kvecs in array */
381 char *smallbuf; /* pointer to current "small" buffer */
382 char *bigbuf; /* pointer to current "big" buffer */
383 unsigned int total_read; /* total amount of data read in this pass */
384 #ifdef CONFIG_CIFS_FSCACHE
385 struct fscache_cookie *fscache; /* client index cache cookie */
387 #ifdef CONFIG_CIFS_STATS2
388 atomic_t in_send; /* requests trying to send */
389 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
393 static inline unsigned int
394 in_flight(struct TCP_Server_Info *server)
397 spin_lock(&server->req_lock);
398 num = server->in_flight;
399 spin_unlock(&server->req_lock);
404 has_credits(struct TCP_Server_Info *server, int *credits)
407 spin_lock(&server->req_lock);
409 spin_unlock(&server->req_lock);
414 add_credits(struct TCP_Server_Info *server, const unsigned int add,
417 server->ops->add_credits(server, add, optype);
421 set_credits(struct TCP_Server_Info *server, const int val)
423 server->ops->set_credits(server, val);
427 get_next_mid(struct TCP_Server_Info *server)
429 return server->ops->get_next_mid(server);
433 * Macros to allow the TCP_Server_Info->net field and related code to drop out
434 * when CONFIG_NET_NS isn't set.
439 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
444 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
451 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
456 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
463 * Session structure. One of these for each uid session with a particular host
466 struct list_head smb_ses_list;
467 struct list_head tcon_list;
468 struct mutex session_mutex;
469 struct TCP_Server_Info *server; /* pointer to server info */
470 int ses_count; /* reference counter */
471 enum statusEnum status;
472 unsigned overrideSecFlg; /* if non-zero override global sec flags */
473 __u16 ipc_tid; /* special tid for connection to IPC share */
476 char *serverOS; /* name of operating system underlying server */
477 char *serverNOS; /* name of network operating system of server */
478 char *serverDomain; /* security realm of server */
479 __u64 Suid; /* remote smb uid */
480 uid_t linux_uid; /* overriding owner of files on the mount */
481 uid_t cred_uid; /* owner of credentials */
483 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
484 TCP names - will ipv6 and sctp addresses fit? */
485 char *user_name; /* must not be null except during init of sess
486 and after mount option parsing we fill it */
489 struct session_key auth_key;
490 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
491 bool need_reconnect:1; /* connection reset, uid now invalid */
493 /* no more than one of the following three session flags may be set */
494 #define CIFS_SES_NT4 1
495 #define CIFS_SES_OS2 2
496 #define CIFS_SES_W9X 4
497 /* following flag is set for old servers such as OS2 (and Win95?)
498 which do not negotiate NTLM or POSIX dialects, but instead
499 negotiate one of the older LANMAN dialects */
500 #define CIFS_SES_LANMAN 8
502 * there is one of these for each connection to a resource on a particular
506 struct list_head tcon_list;
508 struct list_head openFileList;
509 struct cifs_ses *ses; /* pointer to session associated with */
510 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
511 char *nativeFileSystem;
512 char *password; /* for share-level security */
513 __u16 tid; /* The 2 byte tree id */
514 __u16 Flags; /* optional support bits */
515 enum statusEnum tidStatus;
516 #ifdef CONFIG_CIFS_STATS
517 atomic_t num_smbs_sent;
520 atomic_t num_flushes;
521 atomic_t num_oplock_brks;
524 atomic_t num_deletes;
526 atomic_t num_posixopens;
527 atomic_t num_posixmkdirs;
529 atomic_t num_renames;
530 atomic_t num_t2renames;
534 atomic_t num_hardlinks;
535 atomic_t num_symlinks;
537 atomic_t num_acl_get;
538 atomic_t num_acl_set;
539 #ifdef CONFIG_CIFS_STATS2
540 unsigned long long time_writes;
541 unsigned long long time_reads;
542 unsigned long long time_opens;
543 unsigned long long time_deletes;
544 unsigned long long time_closes;
545 unsigned long long time_mkdirs;
546 unsigned long long time_rmdirs;
547 unsigned long long time_renames;
548 unsigned long long time_t2renames;
549 unsigned long long time_ffirst;
550 unsigned long long time_fnext;
551 unsigned long long time_fclose;
552 #endif /* CONFIG_CIFS_STATS2 */
555 spinlock_t stat_lock;
556 #endif /* CONFIG_CIFS_STATS */
557 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
558 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
559 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
560 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
563 bool seal:1; /* transport encryption for this mounted share */
564 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
565 for this mount even if server would support */
566 bool local_lease:1; /* check leases (only) on local system not remote */
567 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
568 bool need_reconnect:1; /* connection reset, tid now invalid */
569 #ifdef CONFIG_CIFS_FSCACHE
570 u64 resource_id; /* server resource id */
571 struct fscache_cookie *fscache; /* cookie for share */
573 /* BB add field for back pointer to sb struct(s)? */
577 * This is a refcounted and timestamped container for a tcon pointer. The
578 * container holds a tcon reference. It is considered safe to free one of
579 * these when the tl_count goes to 0. The tl_time is the time of the last
580 * "get" on the container.
583 struct rb_node tl_rbnode;
585 unsigned long tl_flags;
586 #define TCON_LINK_MASTER 0
587 #define TCON_LINK_PENDING 1
588 #define TCON_LINK_IN_TREE 2
589 unsigned long tl_time;
591 struct cifs_tcon *tl_tcon;
594 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
596 static inline struct cifs_tcon *
597 tlink_tcon(struct tcon_link *tlink)
599 return tlink->tl_tcon;
602 extern void cifs_put_tlink(struct tcon_link *tlink);
604 static inline struct tcon_link *
605 cifs_get_tlink(struct tcon_link *tlink)
607 if (tlink && !IS_ERR(tlink))
608 atomic_inc(&tlink->tl_count);
612 /* This function is always expected to succeed */
613 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
616 * This info hangs off the cifsFileInfo structure, pointed to by llist.
617 * This is used to track byte stream locks on the file
619 struct cifsLockInfo {
620 struct list_head llist; /* pointer to next cifsLockInfo */
621 struct list_head blist; /* pointer to locks blocked on this */
622 wait_queue_head_t block_q;
630 * One of these for each open instance of a file
632 struct cifs_search_info {
633 loff_t index_of_last_entry;
634 __u16 entries_in_buffer;
637 char *ntwrk_buf_start;
638 char *srch_entries_start;
640 const char *presume_name;
641 unsigned int resume_name_len;
645 bool smallBuf:1; /* so we know which buf_release function to call */
648 struct cifsFileInfo {
649 struct list_head tlist; /* pointer to next fid owned by tcon */
650 struct list_head flist; /* next fid (file instance) for this inode */
651 struct list_head llist; /*
652 * brlocks held by this fid, protected by
653 * lock_mutex from cifsInodeInfo structure
655 unsigned int uid; /* allows finding which FileInfo structure */
656 __u32 pid; /* process id who opened file */
657 __u16 netfid; /* file id from remote */
658 /* BB add lock scope info here if needed */ ;
659 /* lock scope id (0 if none) */
660 struct dentry *dentry;
661 unsigned int f_flags;
662 struct tcon_link *tlink;
663 bool invalidHandle:1; /* file closed via session abend */
664 bool oplock_break_cancelled:1;
665 int count; /* refcount protected by cifs_file_list_lock */
666 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
667 struct cifs_search_info srch_inf;
668 struct work_struct oplock_break; /* work for oplock breaks */
671 struct cifs_io_parms {
676 struct cifs_tcon *tcon;
680 * Take a reference on the file private data. Must be called with
681 * cifs_file_list_lock held.
684 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file)
690 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
693 * One of these for each file inode
696 struct cifsInodeInfo {
697 bool can_cache_brlcks;
698 struct mutex lock_mutex; /*
699 * protect the field above and llist
700 * from every cifsFileInfo structure
703 /* BB add in lists for dirty pages i.e. write caching info for oplock */
704 struct list_head openFileList;
705 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
706 bool clientCanCacheRead; /* read oplock */
707 bool clientCanCacheAll; /* read and writebehind oplock */
708 bool delete_pending; /* DELETE_ON_CLOSE is set */
709 bool invalid_mapping; /* pagecache is invalid */
710 unsigned long time; /* jiffies of last update of inode */
711 u64 server_eof; /* current file size on server -- protected by i_lock */
712 u64 uniqueid; /* server inode number */
713 u64 createtime; /* creation time on server */
714 #ifdef CONFIG_CIFS_FSCACHE
715 struct fscache_cookie *fscache;
717 struct inode vfs_inode;
720 static inline struct cifsInodeInfo *
721 CIFS_I(struct inode *inode)
723 return container_of(inode, struct cifsInodeInfo, vfs_inode);
726 static inline struct cifs_sb_info *
727 CIFS_SB(struct super_block *sb)
729 return sb->s_fs_info;
732 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
734 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
741 convert_delimiter(char *path, char delim)
754 for (i = 0; path[i] != '\0'; i++) {
755 if (path[i] == old_delim)
760 #ifdef CONFIG_CIFS_STATS
761 #define cifs_stats_inc atomic_inc
763 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
767 spin_lock(&tcon->stat_lock);
768 tcon->bytes_written += bytes;
769 spin_unlock(&tcon->stat_lock);
773 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
776 spin_lock(&tcon->stat_lock);
777 tcon->bytes_read += bytes;
778 spin_unlock(&tcon->stat_lock);
782 #define cifs_stats_inc(field) do {} while (0)
783 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
784 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
790 * This is the prototype for the mid receive function. This function is for
791 * receiving the rest of the SMB frame, starting with the WordCount (which is
792 * just after the MID in struct smb_hdr). Note:
794 * - This will be called by cifsd, with no locks held.
795 * - The mid will still be on the pending_mid_q.
796 * - mid->resp_buf will point to the current buffer.
798 * Returns zero on a successful receive, or an error. The receive state in
799 * the TCP_Server_Info will also be updated.
801 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
802 struct mid_q_entry *mid);
805 * This is the prototype for the mid callback function. This is called once the
806 * mid has been received off of the socket. When creating one, take special
807 * care to avoid deadlocks. Things to bear in mind:
809 * - it will be called by cifsd, with no locks held
810 * - the mid will be removed from any lists
812 typedef void (mid_callback_t)(struct mid_q_entry *mid);
814 /* one of these for every pending CIFS request to the server */
816 struct list_head qhead; /* mids waiting on reply from this server */
817 struct TCP_Server_Info *server; /* server corresponding to this mid */
818 __u64 mid; /* multiplex id */
819 __u32 pid; /* process id */
820 __u32 sequence_number; /* for CIFS signing */
821 unsigned long when_alloc; /* when mid was created */
822 #ifdef CONFIG_CIFS_STATS2
823 unsigned long when_sent; /* time when smb send finished */
824 unsigned long when_received; /* when demux complete (taken off wire) */
826 mid_receive_t *receive; /* call receive callback */
827 mid_callback_t *callback; /* call completion callback */
828 void *callback_data; /* general purpose pointer for callback */
829 void *resp_buf; /* pointer to received SMB header */
830 int mid_state; /* wish this were enum but can not pass to wait_event */
831 __le16 command; /* smb command code */
832 bool large_buf:1; /* if valid response, is pointer to large buf */
833 bool multiRsp:1; /* multiple trans2 responses for one request */
834 bool multiEnd:1; /* both received */
837 /* Make code in transport.c a little cleaner by moving
838 update of optional stats into function below */
839 #ifdef CONFIG_CIFS_STATS2
841 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
843 atomic_inc(&server->in_send);
846 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
848 atomic_dec(&server->in_send);
851 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
853 atomic_inc(&server->num_waiters);
856 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
858 atomic_dec(&server->num_waiters);
861 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
863 mid->when_sent = jiffies;
866 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
869 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
873 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
877 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
881 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
886 /* for pending dnotify requests */
887 struct dir_notify_req {
888 struct list_head lhead;
895 __u32 filter; /* CompletionFilter (for multishot) */
900 struct dfs_info3_param {
901 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
910 * common struct for holding inode info when searching for or updating an
911 * inode with new info
914 #define CIFS_FATTR_DFS_REFERRAL 0x1
915 #define CIFS_FATTR_DELETE_PENDING 0x2
916 #define CIFS_FATTR_NEED_REVAL 0x4
917 #define CIFS_FATTR_INO_COLLISION 0x8
930 unsigned int cf_nlink;
931 unsigned int cf_dtype;
932 struct timespec cf_atime;
933 struct timespec cf_mtime;
934 struct timespec cf_ctime;
937 static inline void free_dfs_info_param(struct dfs_info3_param *param)
940 kfree(param->path_name);
941 kfree(param->node_name);
946 static inline void free_dfs_info_array(struct dfs_info3_param *param,
950 if ((number_of_items == 0) || (param == NULL))
952 for (i = 0; i < number_of_items; i++) {
953 kfree(param[i].path_name);
954 kfree(param[i].node_name);
960 #define MID_REQUEST_ALLOCATED 1
961 #define MID_REQUEST_SUBMITTED 2
962 #define MID_RESPONSE_RECEIVED 4
963 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
964 #define MID_RESPONSE_MALFORMED 0x10
965 #define MID_SHUTDOWN 0x20
967 /* Types of response buffer returned from SendReceive2 */
968 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
969 #define CIFS_SMALL_BUFFER 1
970 #define CIFS_LARGE_BUFFER 2
971 #define CIFS_IOVEC 4 /* array of response buffers */
973 /* Type of Request to SendReceive2 */
974 #define CIFS_BLOCKING_OP 1 /* operation can block */
975 #define CIFS_ASYNC_OP 2 /* do not wait for response */
976 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
977 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
978 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
979 #define CIFS_NO_RESP 0x040 /* no response buffer required */
981 /* Type of request operation */
982 #define CIFS_ECHO_OP 0x080 /* echo request */
983 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
984 #define CIFS_OP_MASK 0x0180 /* mask request type */
986 /* Security Flags: indicate type of session setup needed */
987 #define CIFSSEC_MAY_SIGN 0x00001
988 #define CIFSSEC_MAY_NTLM 0x00002
989 #define CIFSSEC_MAY_NTLMV2 0x00004
990 #define CIFSSEC_MAY_KRB5 0x00008
991 #ifdef CONFIG_CIFS_WEAK_PW_HASH
992 #define CIFSSEC_MAY_LANMAN 0x00010
993 #define CIFSSEC_MAY_PLNTXT 0x00020
995 #define CIFSSEC_MAY_LANMAN 0
996 #define CIFSSEC_MAY_PLNTXT 0
997 #endif /* weak passwords */
998 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
999 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1001 #define CIFSSEC_MUST_SIGN 0x01001
1002 /* note that only one of the following can be set so the
1003 result of setting MUST flags more than once will be to
1004 require use of the stronger protocol */
1005 #define CIFSSEC_MUST_NTLM 0x02002
1006 #define CIFSSEC_MUST_NTLMV2 0x04004
1007 #define CIFSSEC_MUST_KRB5 0x08008
1008 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1009 #define CIFSSEC_MUST_LANMAN 0x10010
1010 #define CIFSSEC_MUST_PLNTXT 0x20020
1011 #ifdef CONFIG_CIFS_UPCALL
1012 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1014 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1016 #else /* do not allow weak pw hash */
1017 #define CIFSSEC_MUST_LANMAN 0
1018 #define CIFSSEC_MUST_PLNTXT 0
1019 #ifdef CONFIG_CIFS_UPCALL
1020 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1022 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1024 #endif /* WEAK_PW_HASH */
1025 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1026 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1028 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
1029 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1030 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1032 *****************************************************************
1033 * All constants go here
1034 *****************************************************************
1037 #define UID_HASH (16)
1040 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1041 * following to be declared.
1044 /****************************************************************************
1045 * Locking notes. All updates to global variables and lists should be
1046 * protected by spinlocks or semaphores.
1050 * GlobalMid_Lock protects:
1051 * list operations on pending_mid_q and oplockQ
1052 * updates to XID counters, multiplex id and SMB sequence numbers
1053 * cifs_file_list_lock protects:
1054 * list operations on tcp and SMB session lists and tCon lists
1055 * f_owner.lock protects certain per file struct operations
1056 * mapping->page_lock protects certain per page operations
1060 * sesSem operations on smb session
1061 * tconSem operations on tree connection
1062 * fh_sem file handle reconnection operations
1064 ****************************************************************************/
1066 #ifdef DECLARE_GLOBALS_HERE
1067 #define GLOBAL_EXTERN
1069 #define GLOBAL_EXTERN extern
1073 * the list of TCP_Server_Info structures, ie each of the sockets
1074 * connecting our client to a distinct server (ip address), is
1075 * chained together by cifs_tcp_ses_list. The list of all our SMB
1076 * sessions (and from that the tree connections) can be found
1077 * by iterating over cifs_tcp_ses_list
1079 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1082 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1083 * tcp session, and the list of tcon's per smb session. It also protects
1084 * the reference counters for the server, smb session, and tcon. Finally,
1085 * changes to the tcon->tidStatus should be done while holding this lock.
1087 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1090 * This lock protects the cifs_file->llist and cifs_file->flist
1091 * list operations, and updates to some flags (cifs_file->invalidHandle)
1092 * It will be moved to either use the tcon->stat_lock or equivalent later.
1093 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1094 * the cifs_tcp_ses_lock must be grabbed first and released last.
1096 GLOBAL_EXTERN spinlock_t cifs_file_list_lock;
1098 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1099 /* Outstanding dir notify requests */
1100 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1101 /* DirNotify response queue */
1102 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1103 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1106 * Global transaction id (XID) information
1108 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1109 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1110 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1111 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1112 /* on midQ entries */
1114 * Global counters, updated atomically
1116 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1117 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1118 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1119 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1120 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1122 /* Various Debug counters */
1123 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1124 #ifdef CONFIG_CIFS_STATS2
1125 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1126 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1128 GLOBAL_EXTERN atomic_t smBufAllocCount;
1129 GLOBAL_EXTERN atomic_t midCount;
1132 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1133 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1134 GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1135 with more secure ntlmssp2 challenge/resp */
1136 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1137 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1138 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1139 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1140 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1141 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1143 #ifdef CONFIG_CIFS_ACL
1144 GLOBAL_EXTERN struct rb_root uidtree;
1145 GLOBAL_EXTERN struct rb_root gidtree;
1146 GLOBAL_EXTERN spinlock_t siduidlock;
1147 GLOBAL_EXTERN spinlock_t sidgidlock;
1148 GLOBAL_EXTERN struct rb_root siduidtree;
1149 GLOBAL_EXTERN struct rb_root sidgidtree;
1150 GLOBAL_EXTERN spinlock_t uidsidlock;
1151 GLOBAL_EXTERN spinlock_t gidsidlock;
1152 #endif /* CONFIG_CIFS_ACL */
1154 void cifs_oplock_break(struct work_struct *work);
1156 extern const struct slow_work_ops cifs_oplock_break_ops;
1157 extern struct workqueue_struct *cifsiod_wq;
1159 extern mempool_t *cifs_mid_poolp;
1161 /* Operations for different SMB versions */
1162 #define SMB1_VERSION_STRING "1.0"
1163 extern struct smb_version_operations smb1_operations;
1164 extern struct smb_version_values smb1_values;
1165 #define SMB21_VERSION_STRING "2.1"
1166 extern struct smb_version_operations smb21_operations;
1167 extern struct smb_version_values smb21_values;
1168 #endif /* _CIFS_GLOB_H */