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/workqueue.h>
26 #include "cifs_fs_sb.h"
28 #include <crypto/internal/hash.h>
29 #include <linux/scatterlist.h>
32 * The sizes of various internal tables and strings
34 #define MAX_UID_INFO 16
35 #define MAX_SES_INFO 2
36 #define MAX_TCON_INFO 4
38 #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
39 #define MAX_SERVER_SIZE 15
40 #define MAX_SHARE_SIZE 80
41 #define MAX_USERNAME_SIZE 256 /* reasonable maximum for current servers */
42 #define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */
44 #define CIFS_MIN_RCV_POOL 4
46 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
48 * default attribute cache timeout (jiffies)
50 #define CIFS_DEF_ACTIMEO (1 * HZ)
53 * max attribute cache timeout (jiffies) - 2^30
55 #define CIFS_MAX_ACTIMEO (1 << 30)
58 * MAX_REQ is the maximum number of requests that WE will send
59 * on one socket concurrently.
61 #define CIFS_MAX_REQ 32767
63 #define RFC1001_NAME_LEN 15
64 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
66 /* currently length of NIP6_FMT */
67 #define SERVER_NAME_LENGTH 40
68 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
70 /* used to define string lengths for reversing unicode strings */
72 /* (max path length + 1 for null) * 2 for unicode */
77 #ifndef XATTR_DOS_ATTRIB
78 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
82 * CIFS vfs client Status information (based on what we know.)
85 /* associated with each tcp and smb session */
95 LANMAN = 0, /* Legacy LANMAN auth */
96 NTLM, /* Legacy NTLM012 auth with NTLM hash */
97 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
98 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
99 /* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
100 Kerberos, /* Kerberos via SPNEGO */
106 /* Netbios frames protocol not supported at this time */
114 /* crypto security descriptor definition */
116 struct shash_desc shash;
120 /* crypto hashing related structure/fields, not specific to a sec mech */
121 struct cifs_secmech {
122 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
123 struct crypto_shash *md5; /* md5 hash function */
124 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
125 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
128 /* per smb session structure/fields */
129 struct ntlmssp_auth {
130 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
131 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
132 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
133 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
141 struct cifs_sid osid;
142 struct cifs_sid gsid;
143 struct cifs_ntace *ntaces;
144 struct cifs_ace *aces;
148 *****************************************************************
149 * Except the CIFS PDUs themselves all the
150 * globally interesting structs should go here
151 *****************************************************************
160 struct TCP_Server_Info;
165 struct smb_version_operations {
166 int (*send_cancel)(struct TCP_Server_Info *, void *,
167 struct mid_q_entry *);
168 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
169 /* setup request: allocate mid, sign message */
170 int (*setup_request)(struct cifs_ses *, struct kvec *, unsigned int,
171 struct mid_q_entry **);
172 /* check response: verify signature, map error */
173 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
175 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
177 void (*set_credits)(struct TCP_Server_Info *, const int);
178 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
179 unsigned int (*get_credits)(struct mid_q_entry *);
180 __u64 (*get_next_mid)(struct TCP_Server_Info *);
181 /* data offset from read response message */
182 unsigned int (*read_data_offset)(char *);
183 /* data length from read response message */
184 unsigned int (*read_data_length)(char *);
185 /* map smb to linux error */
186 int (*map_error)(char *, bool);
187 /* find mid corresponding to the response message */
188 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
189 void (*dump_detail)(void *);
190 /* verify the message */
191 int (*check_message)(char *, unsigned int);
192 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
193 /* process transaction2 response */
194 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
196 /* check if we need to negotiate */
197 bool (*need_neg)(struct TCP_Server_Info *);
198 /* negotiate to the server */
199 int (*negotiate)(const unsigned int, struct cifs_ses *);
200 /* setup smb sessionn */
201 int (*sess_setup)(const unsigned int, struct cifs_ses *,
202 const struct nls_table *);
203 /* close smb session */
204 int (*logoff)(const unsigned int, struct cifs_ses *);
205 /* connect to a server share */
206 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
207 struct cifs_tcon *, const struct nls_table *);
208 /* close tree connecion */
209 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
212 struct smb_version_values {
213 char *version_string;
214 __u32 large_lock_type;
215 __u32 exclusive_lock_type;
216 __u32 shared_lock_type;
217 __u32 unlock_lock_type;
219 size_t max_header_size;
220 size_t read_rsp_size;
223 #define HEADER_SIZE(server) (server->vals->header_size)
224 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
232 char *iocharset; /* local code page for mapping to and from Unicode */
233 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
234 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
250 bool no_psx_acl:1; /* set if posix acl support should be disabled */
252 bool backupuid_specified; /* mount option backupuid is specified */
253 bool backupgid_specified; /* mount option backupgid is specified */
254 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
255 bool server_ino:1; /* use inode numbers from server ie UniqueId */
257 bool strict_io:1; /* strict cache behavior */
258 bool remap:1; /* set to remap seven reserved chars in filenames */
259 bool posix_paths:1; /* unset to not ask for posix pathnames. */
262 bool nullauth:1; /* attempt to authenticate with null user */
263 bool nocase:1; /* request case insensitive filenames */
264 bool nobrl:1; /* disable sending byte range locks to srv */
265 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
266 bool seal:1; /* request transport encryption on share */
267 bool nodfs:1; /* Do not request DFS, even if available */
268 bool local_lease:1; /* check leases only on local system, not remote */
271 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
272 bool fsc:1; /* enable fscache */
273 bool mfsymlinks:1; /* use Minshall+French Symlinks */
275 bool rwpidforward:1; /* pid forward for read/write operations */
278 bool sockopt_tcp_nodelay:1;
279 unsigned short int port;
280 unsigned long actimeo; /* attribute cache timeout (jiffies) */
281 struct smb_version_operations *ops;
282 struct smb_version_values *vals;
284 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
285 struct nls_table *local_nls;
288 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
289 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
290 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
291 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
292 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
293 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
294 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
295 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
296 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
297 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
299 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
300 MS_NODEV | MS_SYNCHRONOUS)
302 struct cifs_mnt_data {
303 struct cifs_sb_info *cifs_sb;
308 static inline unsigned int
309 get_rfc1002_length(void *buf)
311 return be32_to_cpu(*((__be32 *)buf));
314 struct TCP_Server_Info {
315 struct list_head tcp_ses_list;
316 struct list_head smb_ses_list;
317 int srv_count; /* reference counter */
318 /* 15 character server name + 0x20 16th byte indicating type = srv */
319 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
320 struct smb_version_operations *ops;
321 struct smb_version_values *vals;
322 enum statusEnum tcpStatus; /* what we think the status is */
323 char *hostname; /* hostname portion of UNC string */
324 struct socket *ssocket;
325 struct sockaddr_storage dstaddr;
326 struct sockaddr_storage srcaddr; /* locally bind to this IP */
330 wait_queue_head_t response_q;
331 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
332 struct list_head pending_mid_q;
333 bool noblocksnd; /* use blocking sendmsg */
334 bool noautotune; /* do not autotune send buf sizes */
336 int credits; /* send no more requests at once */
337 unsigned int in_flight; /* number of requests on the wire to server */
338 spinlock_t req_lock; /* protect the two values above */
339 struct mutex srv_mutex;
340 struct task_struct *tsk;
341 char server_GUID[16];
343 bool session_estab; /* mark when very first sess is established */
344 u16 dialect; /* dialect index that server chose */
345 enum securityEnum secType;
346 bool oplocks:1; /* enable oplocks */
347 unsigned int maxReq; /* Clients should submit no more */
348 /* than maxReq distinct unanswered SMBs to the server when using */
349 /* multiplexed reads or writes */
350 unsigned int maxBuf; /* maxBuf specifies the maximum */
351 /* message size the server can send or receive for non-raw SMBs */
352 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
353 /* when socket is setup (and during reconnect) before NegProt sent */
354 unsigned int max_rw; /* maxRw specifies the maximum */
355 /* message size the server can send or receive for */
356 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
357 unsigned int max_vcs; /* maximum number of smb sessions, at least
358 those that can be specified uniquely with
360 int capabilities; /* allow selective disabling of caps by smb sess */
361 int timeAdj; /* Adjust for difference in server time zone in sec */
362 __u64 CurrentMid; /* multiplex id - rotating counter */
363 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
364 /* 16th byte of RFC1001 workstation name is always null */
365 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
366 __u32 sequence_number; /* for signing, protected by srv_mutex */
367 struct session_key session_key;
368 unsigned long lstrp; /* when we got last response from this server */
369 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
370 /* extended security flavors that server supports */
371 bool sec_ntlmssp; /* supports NTLMSSP */
372 bool sec_kerberosu2u; /* supports U2U Kerberos */
373 bool sec_kerberos; /* supports plain Kerberos */
374 bool sec_mskerberos; /* supports legacy MS Kerberos */
375 bool large_buf; /* is current buffer large? */
376 struct delayed_work echo; /* echo ping workqueue job */
377 struct kvec *iov; /* reusable kvec array for receives */
378 unsigned int nr_iov; /* number of kvecs in array */
379 char *smallbuf; /* pointer to current "small" buffer */
380 char *bigbuf; /* pointer to current "big" buffer */
381 unsigned int total_read; /* total amount of data read in this pass */
382 #ifdef CONFIG_CIFS_FSCACHE
383 struct fscache_cookie *fscache; /* client index cache cookie */
385 #ifdef CONFIG_CIFS_STATS2
386 atomic_t in_send; /* requests trying to send */
387 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
391 static inline unsigned int
392 in_flight(struct TCP_Server_Info *server)
395 spin_lock(&server->req_lock);
396 num = server->in_flight;
397 spin_unlock(&server->req_lock);
402 has_credits(struct TCP_Server_Info *server, int *credits)
405 spin_lock(&server->req_lock);
407 spin_unlock(&server->req_lock);
412 add_credits(struct TCP_Server_Info *server, const unsigned int add,
415 server->ops->add_credits(server, add, optype);
419 set_credits(struct TCP_Server_Info *server, const int val)
421 server->ops->set_credits(server, val);
425 get_next_mid(struct TCP_Server_Info *server)
427 return server->ops->get_next_mid(server);
431 * Macros to allow the TCP_Server_Info->net field and related code to drop out
432 * when CONFIG_NET_NS isn't set.
437 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
442 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
449 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
454 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
461 * Session structure. One of these for each uid session with a particular host
464 struct list_head smb_ses_list;
465 struct list_head tcon_list;
466 struct mutex session_mutex;
467 struct TCP_Server_Info *server; /* pointer to server info */
468 int ses_count; /* reference counter */
469 enum statusEnum status;
470 unsigned overrideSecFlg; /* if non-zero override global sec flags */
471 __u16 ipc_tid; /* special tid for connection to IPC share */
474 char *serverOS; /* name of operating system underlying server */
475 char *serverNOS; /* name of network operating system of server */
476 char *serverDomain; /* security realm of server */
477 __u64 Suid; /* remote smb uid */
478 uid_t linux_uid; /* overriding owner of files on the mount */
479 uid_t cred_uid; /* owner of credentials */
481 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
482 TCP names - will ipv6 and sctp addresses fit? */
483 char *user_name; /* must not be null except during init of sess
484 and after mount option parsing we fill it */
487 struct session_key auth_key;
488 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
489 bool need_reconnect:1; /* connection reset, uid now invalid */
491 /* no more than one of the following three session flags may be set */
492 #define CIFS_SES_NT4 1
493 #define CIFS_SES_OS2 2
494 #define CIFS_SES_W9X 4
495 /* following flag is set for old servers such as OS2 (and Win95?)
496 which do not negotiate NTLM or POSIX dialects, but instead
497 negotiate one of the older LANMAN dialects */
498 #define CIFS_SES_LANMAN 8
500 * there is one of these for each connection to a resource on a particular
504 struct list_head tcon_list;
506 struct list_head openFileList;
507 struct cifs_ses *ses; /* pointer to session associated with */
508 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
509 char *nativeFileSystem;
510 char *password; /* for share-level security */
511 __u16 tid; /* The 2 byte tree id */
512 __u16 Flags; /* optional support bits */
513 enum statusEnum tidStatus;
514 #ifdef CONFIG_CIFS_STATS
515 atomic_t num_smbs_sent;
518 atomic_t num_flushes;
519 atomic_t num_oplock_brks;
522 atomic_t num_deletes;
524 atomic_t num_posixopens;
525 atomic_t num_posixmkdirs;
527 atomic_t num_renames;
528 atomic_t num_t2renames;
532 atomic_t num_hardlinks;
533 atomic_t num_symlinks;
535 atomic_t num_acl_get;
536 atomic_t num_acl_set;
537 #ifdef CONFIG_CIFS_STATS2
538 unsigned long long time_writes;
539 unsigned long long time_reads;
540 unsigned long long time_opens;
541 unsigned long long time_deletes;
542 unsigned long long time_closes;
543 unsigned long long time_mkdirs;
544 unsigned long long time_rmdirs;
545 unsigned long long time_renames;
546 unsigned long long time_t2renames;
547 unsigned long long time_ffirst;
548 unsigned long long time_fnext;
549 unsigned long long time_fclose;
550 #endif /* CONFIG_CIFS_STATS2 */
553 spinlock_t stat_lock;
554 #endif /* CONFIG_CIFS_STATS */
555 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
556 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
557 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
558 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
561 bool seal:1; /* transport encryption for this mounted share */
562 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
563 for this mount even if server would support */
564 bool local_lease:1; /* check leases (only) on local system not remote */
565 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
566 bool need_reconnect:1; /* connection reset, tid now invalid */
567 #ifdef CONFIG_CIFS_FSCACHE
568 u64 resource_id; /* server resource id */
569 struct fscache_cookie *fscache; /* cookie for share */
571 /* BB add field for back pointer to sb struct(s)? */
575 * This is a refcounted and timestamped container for a tcon pointer. The
576 * container holds a tcon reference. It is considered safe to free one of
577 * these when the tl_count goes to 0. The tl_time is the time of the last
578 * "get" on the container.
581 struct rb_node tl_rbnode;
583 unsigned long tl_flags;
584 #define TCON_LINK_MASTER 0
585 #define TCON_LINK_PENDING 1
586 #define TCON_LINK_IN_TREE 2
587 unsigned long tl_time;
589 struct cifs_tcon *tl_tcon;
592 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
594 static inline struct cifs_tcon *
595 tlink_tcon(struct tcon_link *tlink)
597 return tlink->tl_tcon;
600 extern void cifs_put_tlink(struct tcon_link *tlink);
602 static inline struct tcon_link *
603 cifs_get_tlink(struct tcon_link *tlink)
605 if (tlink && !IS_ERR(tlink))
606 atomic_inc(&tlink->tl_count);
610 /* This function is always expected to succeed */
611 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
614 * This info hangs off the cifsFileInfo structure, pointed to by llist.
615 * This is used to track byte stream locks on the file
617 struct cifsLockInfo {
618 struct list_head llist; /* pointer to next cifsLockInfo */
619 struct list_head blist; /* pointer to locks blocked on this */
620 wait_queue_head_t block_q;
628 * One of these for each open instance of a file
630 struct cifs_search_info {
631 loff_t index_of_last_entry;
632 __u16 entries_in_buffer;
635 char *ntwrk_buf_start;
636 char *srch_entries_start;
638 const char *presume_name;
639 unsigned int resume_name_len;
643 bool smallBuf:1; /* so we know which buf_release function to call */
646 struct cifsFileInfo {
647 struct list_head tlist; /* pointer to next fid owned by tcon */
648 struct list_head flist; /* next fid (file instance) for this inode */
649 struct list_head llist; /*
650 * brlocks held by this fid, protected by
651 * lock_mutex from cifsInodeInfo structure
653 unsigned int uid; /* allows finding which FileInfo structure */
654 __u32 pid; /* process id who opened file */
655 __u16 netfid; /* file id from remote */
656 /* BB add lock scope info here if needed */ ;
657 /* lock scope id (0 if none) */
658 struct dentry *dentry;
659 unsigned int f_flags;
660 struct tcon_link *tlink;
661 bool invalidHandle:1; /* file closed via session abend */
662 bool oplock_break_cancelled:1;
663 int count; /* refcount protected by cifs_file_list_lock */
664 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
665 struct cifs_search_info srch_inf;
666 struct work_struct oplock_break; /* work for oplock breaks */
669 struct cifs_io_parms {
674 struct cifs_tcon *tcon;
678 * Take a reference on the file private data. Must be called with
679 * cifs_file_list_lock held.
682 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file)
688 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
691 * One of these for each file inode
694 struct cifsInodeInfo {
695 bool can_cache_brlcks;
696 struct mutex lock_mutex; /*
697 * protect the field above and llist
698 * from every cifsFileInfo structure
701 /* BB add in lists for dirty pages i.e. write caching info for oplock */
702 struct list_head openFileList;
703 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
704 bool clientCanCacheRead; /* read oplock */
705 bool clientCanCacheAll; /* read and writebehind oplock */
706 bool delete_pending; /* DELETE_ON_CLOSE is set */
707 bool invalid_mapping; /* pagecache is invalid */
708 unsigned long time; /* jiffies of last update of inode */
709 u64 server_eof; /* current file size on server -- protected by i_lock */
710 u64 uniqueid; /* server inode number */
711 u64 createtime; /* creation time on server */
712 #ifdef CONFIG_CIFS_FSCACHE
713 struct fscache_cookie *fscache;
715 struct inode vfs_inode;
718 static inline struct cifsInodeInfo *
719 CIFS_I(struct inode *inode)
721 return container_of(inode, struct cifsInodeInfo, vfs_inode);
724 static inline struct cifs_sb_info *
725 CIFS_SB(struct super_block *sb)
727 return sb->s_fs_info;
730 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
732 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
739 convert_delimiter(char *path, char delim)
752 for (i = 0; path[i] != '\0'; i++) {
753 if (path[i] == old_delim)
758 #ifdef CONFIG_CIFS_STATS
759 #define cifs_stats_inc atomic_inc
761 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
765 spin_lock(&tcon->stat_lock);
766 tcon->bytes_written += bytes;
767 spin_unlock(&tcon->stat_lock);
771 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
774 spin_lock(&tcon->stat_lock);
775 tcon->bytes_read += bytes;
776 spin_unlock(&tcon->stat_lock);
780 #define cifs_stats_inc(field) do {} while (0)
781 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
782 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
788 * This is the prototype for the mid receive function. This function is for
789 * receiving the rest of the SMB frame, starting with the WordCount (which is
790 * just after the MID in struct smb_hdr). Note:
792 * - This will be called by cifsd, with no locks held.
793 * - The mid will still be on the pending_mid_q.
794 * - mid->resp_buf will point to the current buffer.
796 * Returns zero on a successful receive, or an error. The receive state in
797 * the TCP_Server_Info will also be updated.
799 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
800 struct mid_q_entry *mid);
803 * This is the prototype for the mid callback function. This is called once the
804 * mid has been received off of the socket. When creating one, take special
805 * care to avoid deadlocks. Things to bear in mind:
807 * - it will be called by cifsd, with no locks held
808 * - the mid will be removed from any lists
810 typedef void (mid_callback_t)(struct mid_q_entry *mid);
812 /* one of these for every pending CIFS request to the server */
814 struct list_head qhead; /* mids waiting on reply from this server */
815 __u64 mid; /* multiplex id */
816 __u32 pid; /* process id */
817 __u32 sequence_number; /* for CIFS signing */
818 unsigned long when_alloc; /* when mid was created */
819 #ifdef CONFIG_CIFS_STATS2
820 unsigned long when_sent; /* time when smb send finished */
821 unsigned long when_received; /* when demux complete (taken off wire) */
823 mid_receive_t *receive; /* call receive callback */
824 mid_callback_t *callback; /* call completion callback */
825 void *callback_data; /* general purpose pointer for callback */
826 void *resp_buf; /* pointer to received SMB header */
827 int mid_state; /* wish this were enum but can not pass to wait_event */
828 __le16 command; /* smb command code */
829 bool large_buf:1; /* if valid response, is pointer to large buf */
830 bool multiRsp:1; /* multiple trans2 responses for one request */
831 bool multiEnd:1; /* both received */
834 /* Make code in transport.c a little cleaner by moving
835 update of optional stats into function below */
836 #ifdef CONFIG_CIFS_STATS2
838 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
840 atomic_inc(&server->in_send);
843 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
845 atomic_dec(&server->in_send);
848 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
850 atomic_inc(&server->num_waiters);
853 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
855 atomic_dec(&server->num_waiters);
858 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
860 mid->when_sent = jiffies;
863 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
866 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
870 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
874 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
878 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
883 /* for pending dnotify requests */
884 struct dir_notify_req {
885 struct list_head lhead;
892 __u32 filter; /* CompletionFilter (for multishot) */
897 struct dfs_info3_param {
898 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
907 * common struct for holding inode info when searching for or updating an
908 * inode with new info
911 #define CIFS_FATTR_DFS_REFERRAL 0x1
912 #define CIFS_FATTR_DELETE_PENDING 0x2
913 #define CIFS_FATTR_NEED_REVAL 0x4
914 #define CIFS_FATTR_INO_COLLISION 0x8
927 unsigned int cf_nlink;
928 unsigned int cf_dtype;
929 struct timespec cf_atime;
930 struct timespec cf_mtime;
931 struct timespec cf_ctime;
934 static inline void free_dfs_info_param(struct dfs_info3_param *param)
937 kfree(param->path_name);
938 kfree(param->node_name);
943 static inline void free_dfs_info_array(struct dfs_info3_param *param,
947 if ((number_of_items == 0) || (param == NULL))
949 for (i = 0; i < number_of_items; i++) {
950 kfree(param[i].path_name);
951 kfree(param[i].node_name);
957 #define MID_REQUEST_ALLOCATED 1
958 #define MID_REQUEST_SUBMITTED 2
959 #define MID_RESPONSE_RECEIVED 4
960 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
961 #define MID_RESPONSE_MALFORMED 0x10
962 #define MID_SHUTDOWN 0x20
964 /* Types of response buffer returned from SendReceive2 */
965 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
966 #define CIFS_SMALL_BUFFER 1
967 #define CIFS_LARGE_BUFFER 2
968 #define CIFS_IOVEC 4 /* array of response buffers */
970 /* Type of Request to SendReceive2 */
971 #define CIFS_BLOCKING_OP 1 /* operation can block */
972 #define CIFS_ASYNC_OP 2 /* do not wait for response */
973 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
974 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
975 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
976 #define CIFS_NO_RESP 0x040 /* no response buffer required */
978 /* Type of request operation */
979 #define CIFS_ECHO_OP 0x080 /* echo request */
980 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
981 #define CIFS_OP_MASK 0x0180 /* mask request type */
983 /* Security Flags: indicate type of session setup needed */
984 #define CIFSSEC_MAY_SIGN 0x00001
985 #define CIFSSEC_MAY_NTLM 0x00002
986 #define CIFSSEC_MAY_NTLMV2 0x00004
987 #define CIFSSEC_MAY_KRB5 0x00008
988 #ifdef CONFIG_CIFS_WEAK_PW_HASH
989 #define CIFSSEC_MAY_LANMAN 0x00010
990 #define CIFSSEC_MAY_PLNTXT 0x00020
992 #define CIFSSEC_MAY_LANMAN 0
993 #define CIFSSEC_MAY_PLNTXT 0
994 #endif /* weak passwords */
995 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
996 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
998 #define CIFSSEC_MUST_SIGN 0x01001
999 /* note that only one of the following can be set so the
1000 result of setting MUST flags more than once will be to
1001 require use of the stronger protocol */
1002 #define CIFSSEC_MUST_NTLM 0x02002
1003 #define CIFSSEC_MUST_NTLMV2 0x04004
1004 #define CIFSSEC_MUST_KRB5 0x08008
1005 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1006 #define CIFSSEC_MUST_LANMAN 0x10010
1007 #define CIFSSEC_MUST_PLNTXT 0x20020
1008 #ifdef CONFIG_CIFS_UPCALL
1009 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1011 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1013 #else /* do not allow weak pw hash */
1014 #define CIFSSEC_MUST_LANMAN 0
1015 #define CIFSSEC_MUST_PLNTXT 0
1016 #ifdef CONFIG_CIFS_UPCALL
1017 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1019 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1021 #endif /* WEAK_PW_HASH */
1022 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1023 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1025 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
1026 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1027 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1029 *****************************************************************
1030 * All constants go here
1031 *****************************************************************
1034 #define UID_HASH (16)
1037 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1038 * following to be declared.
1041 /****************************************************************************
1042 * Locking notes. All updates to global variables and lists should be
1043 * protected by spinlocks or semaphores.
1047 * GlobalMid_Lock protects:
1048 * list operations on pending_mid_q and oplockQ
1049 * updates to XID counters, multiplex id and SMB sequence numbers
1050 * cifs_file_list_lock protects:
1051 * list operations on tcp and SMB session lists and tCon lists
1052 * f_owner.lock protects certain per file struct operations
1053 * mapping->page_lock protects certain per page operations
1057 * sesSem operations on smb session
1058 * tconSem operations on tree connection
1059 * fh_sem file handle reconnection operations
1061 ****************************************************************************/
1063 #ifdef DECLARE_GLOBALS_HERE
1064 #define GLOBAL_EXTERN
1066 #define GLOBAL_EXTERN extern
1070 * the list of TCP_Server_Info structures, ie each of the sockets
1071 * connecting our client to a distinct server (ip address), is
1072 * chained together by cifs_tcp_ses_list. The list of all our SMB
1073 * sessions (and from that the tree connections) can be found
1074 * by iterating over cifs_tcp_ses_list
1076 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1079 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1080 * tcp session, and the list of tcon's per smb session. It also protects
1081 * the reference counters for the server, smb session, and tcon. Finally,
1082 * changes to the tcon->tidStatus should be done while holding this lock.
1084 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1087 * This lock protects the cifs_file->llist and cifs_file->flist
1088 * list operations, and updates to some flags (cifs_file->invalidHandle)
1089 * It will be moved to either use the tcon->stat_lock or equivalent later.
1090 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1091 * the cifs_tcp_ses_lock must be grabbed first and released last.
1093 GLOBAL_EXTERN spinlock_t cifs_file_list_lock;
1095 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1096 /* Outstanding dir notify requests */
1097 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1098 /* DirNotify response queue */
1099 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1100 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1103 * Global transaction id (XID) information
1105 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1106 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1107 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1108 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1109 /* on midQ entries */
1111 * Global counters, updated atomically
1113 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1114 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1115 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1116 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1117 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1119 /* Various Debug counters */
1120 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1121 #ifdef CONFIG_CIFS_STATS2
1122 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1123 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1125 GLOBAL_EXTERN atomic_t smBufAllocCount;
1126 GLOBAL_EXTERN atomic_t midCount;
1129 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1130 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1131 GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1132 with more secure ntlmssp2 challenge/resp */
1133 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1134 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1135 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1136 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1137 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1138 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1140 #ifdef CONFIG_CIFS_ACL
1141 GLOBAL_EXTERN struct rb_root uidtree;
1142 GLOBAL_EXTERN struct rb_root gidtree;
1143 GLOBAL_EXTERN spinlock_t siduidlock;
1144 GLOBAL_EXTERN spinlock_t sidgidlock;
1145 GLOBAL_EXTERN struct rb_root siduidtree;
1146 GLOBAL_EXTERN struct rb_root sidgidtree;
1147 GLOBAL_EXTERN spinlock_t uidsidlock;
1148 GLOBAL_EXTERN spinlock_t gidsidlock;
1149 #endif /* CONFIG_CIFS_ACL */
1151 void cifs_oplock_break(struct work_struct *work);
1153 extern const struct slow_work_ops cifs_oplock_break_ops;
1154 extern struct workqueue_struct *cifsiod_wq;
1156 /* Operations for different SMB versions */
1157 #define SMB1_VERSION_STRING "1.0"
1158 extern struct smb_version_operations smb1_operations;
1159 extern struct smb_version_values smb1_values;
1160 #define SMB21_VERSION_STRING "2.1"
1161 extern struct smb_version_operations smb21_operations;
1162 extern struct smb_version_values smb21_values;
1163 #endif /* _CIFS_GLOB_H */