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;
164 struct smb_version_operations {
165 int (*send_cancel)(struct TCP_Server_Info *, void *,
166 struct mid_q_entry *);
167 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
168 /* setup request: allocate mid, sign message */
169 int (*setup_request)(struct cifs_ses *, struct kvec *, unsigned int,
170 struct mid_q_entry **);
171 /* check response: verify signature, map error */
172 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
174 void (*add_credits)(struct TCP_Server_Info *, const unsigned int);
175 void (*set_credits)(struct TCP_Server_Info *, const int);
176 int * (*get_credits_field)(struct TCP_Server_Info *);
177 __u64 (*get_next_mid)(struct TCP_Server_Info *);
178 /* data offset from read response message */
179 unsigned int (*read_data_offset)(char *);
180 /* data length from read response message */
181 unsigned int (*read_data_length)(char *);
182 /* map smb to linux error */
183 int (*map_error)(char *, bool);
184 /* find mid corresponding to the response message */
185 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
186 void (*dump_detail)(void *);
187 /* verify the message */
188 int (*check_message)(char *, unsigned int);
189 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
190 /* process transaction2 response */
191 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
195 struct smb_version_values {
196 char *version_string;
197 __u32 large_lock_type;
198 __u32 exclusive_lock_type;
199 __u32 shared_lock_type;
200 __u32 unlock_lock_type;
202 size_t max_header_size;
203 size_t read_rsp_size;
206 #define HEADER_SIZE(server) (server->vals->header_size)
207 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
215 char *iocharset; /* local code page for mapping to and from Unicode */
216 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
217 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
233 bool no_psx_acl:1; /* set if posix acl support should be disabled */
235 bool backupuid_specified; /* mount option backupuid is specified */
236 bool backupgid_specified; /* mount option backupgid is specified */
237 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
238 bool server_ino:1; /* use inode numbers from server ie UniqueId */
240 bool strict_io:1; /* strict cache behavior */
241 bool remap:1; /* set to remap seven reserved chars in filenames */
242 bool posix_paths:1; /* unset to not ask for posix pathnames. */
245 bool nullauth:1; /* attempt to authenticate with null user */
246 bool nocase:1; /* request case insensitive filenames */
247 bool nobrl:1; /* disable sending byte range locks to srv */
248 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
249 bool seal:1; /* request transport encryption on share */
250 bool nodfs:1; /* Do not request DFS, even if available */
251 bool local_lease:1; /* check leases only on local system, not remote */
254 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
255 bool fsc:1; /* enable fscache */
256 bool mfsymlinks:1; /* use Minshall+French Symlinks */
258 bool rwpidforward:1; /* pid forward for read/write operations */
261 bool sockopt_tcp_nodelay:1;
262 unsigned short int port;
263 unsigned long actimeo; /* attribute cache timeout (jiffies) */
264 struct smb_version_operations *ops;
265 struct smb_version_values *vals;
267 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
268 struct nls_table *local_nls;
271 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
272 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
273 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
274 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
275 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
276 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
277 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
278 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
279 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
280 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
282 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
283 MS_NODEV | MS_SYNCHRONOUS)
285 struct cifs_mnt_data {
286 struct cifs_sb_info *cifs_sb;
291 static inline unsigned int
292 get_rfc1002_length(void *buf)
294 return be32_to_cpu(*((__be32 *)buf));
297 struct TCP_Server_Info {
298 struct list_head tcp_ses_list;
299 struct list_head smb_ses_list;
300 int srv_count; /* reference counter */
301 /* 15 character server name + 0x20 16th byte indicating type = srv */
302 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
303 struct smb_version_operations *ops;
304 struct smb_version_values *vals;
305 enum statusEnum tcpStatus; /* what we think the status is */
306 char *hostname; /* hostname portion of UNC string */
307 struct socket *ssocket;
308 struct sockaddr_storage dstaddr;
309 struct sockaddr_storage srcaddr; /* locally bind to this IP */
313 wait_queue_head_t response_q;
314 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
315 struct list_head pending_mid_q;
316 bool noblocksnd; /* use blocking sendmsg */
317 bool noautotune; /* do not autotune send buf sizes */
319 int credits; /* send no more requests at once */
320 unsigned int in_flight; /* number of requests on the wire to server */
321 spinlock_t req_lock; /* protect the two values above */
322 struct mutex srv_mutex;
323 struct task_struct *tsk;
324 char server_GUID[16];
326 bool session_estab; /* mark when very first sess is established */
327 u16 dialect; /* dialect index that server chose */
328 enum securityEnum secType;
329 bool oplocks:1; /* enable oplocks */
330 unsigned int maxReq; /* Clients should submit no more */
331 /* than maxReq distinct unanswered SMBs to the server when using */
332 /* multiplexed reads or writes */
333 unsigned int maxBuf; /* maxBuf specifies the maximum */
334 /* message size the server can send or receive for non-raw SMBs */
335 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
336 /* when socket is setup (and during reconnect) before NegProt sent */
337 unsigned int max_rw; /* maxRw specifies the maximum */
338 /* message size the server can send or receive for */
339 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
340 unsigned int max_vcs; /* maximum number of smb sessions, at least
341 those that can be specified uniquely with
343 int capabilities; /* allow selective disabling of caps by smb sess */
344 int timeAdj; /* Adjust for difference in server time zone in sec */
345 __u64 CurrentMid; /* multiplex id - rotating counter */
346 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
347 /* 16th byte of RFC1001 workstation name is always null */
348 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
349 __u32 sequence_number; /* for signing, protected by srv_mutex */
350 struct session_key session_key;
351 unsigned long lstrp; /* when we got last response from this server */
352 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
353 /* extended security flavors that server supports */
354 bool sec_ntlmssp; /* supports NTLMSSP */
355 bool sec_kerberosu2u; /* supports U2U Kerberos */
356 bool sec_kerberos; /* supports plain Kerberos */
357 bool sec_mskerberos; /* supports legacy MS Kerberos */
358 bool large_buf; /* is current buffer large? */
359 struct delayed_work echo; /* echo ping workqueue job */
360 struct kvec *iov; /* reusable kvec array for receives */
361 unsigned int nr_iov; /* number of kvecs in array */
362 char *smallbuf; /* pointer to current "small" buffer */
363 char *bigbuf; /* pointer to current "big" buffer */
364 unsigned int total_read; /* total amount of data read in this pass */
365 #ifdef CONFIG_CIFS_FSCACHE
366 struct fscache_cookie *fscache; /* client index cache cookie */
368 #ifdef CONFIG_CIFS_STATS2
369 atomic_t in_send; /* requests trying to send */
370 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
374 static inline unsigned int
375 in_flight(struct TCP_Server_Info *server)
378 spin_lock(&server->req_lock);
379 num = server->in_flight;
380 spin_unlock(&server->req_lock);
385 has_credits(struct TCP_Server_Info *server, int *credits)
388 spin_lock(&server->req_lock);
390 spin_unlock(&server->req_lock);
395 add_credits(struct TCP_Server_Info *server, const unsigned int add)
397 server->ops->add_credits(server, add);
401 set_credits(struct TCP_Server_Info *server, const int val)
403 server->ops->set_credits(server, val);
407 get_next_mid(struct TCP_Server_Info *server)
409 return server->ops->get_next_mid(server);
413 * Macros to allow the TCP_Server_Info->net field and related code to drop out
414 * when CONFIG_NET_NS isn't set.
419 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
424 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
431 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
436 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
443 * Session structure. One of these for each uid session with a particular host
446 struct list_head smb_ses_list;
447 struct list_head tcon_list;
448 struct mutex session_mutex;
449 struct TCP_Server_Info *server; /* pointer to server info */
450 int ses_count; /* reference counter */
451 enum statusEnum status;
452 unsigned overrideSecFlg; /* if non-zero override global sec flags */
453 __u16 ipc_tid; /* special tid for connection to IPC share */
456 char *serverOS; /* name of operating system underlying server */
457 char *serverNOS; /* name of network operating system of server */
458 char *serverDomain; /* security realm of server */
459 int Suid; /* remote smb uid */
460 uid_t linux_uid; /* overriding owner of files on the mount */
461 uid_t cred_uid; /* owner of credentials */
463 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
464 TCP names - will ipv6 and sctp addresses fit? */
465 char *user_name; /* must not be null except during init of sess
466 and after mount option parsing we fill it */
469 struct session_key auth_key;
470 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
471 bool need_reconnect:1; /* connection reset, uid now invalid */
473 /* no more than one of the following three session flags may be set */
474 #define CIFS_SES_NT4 1
475 #define CIFS_SES_OS2 2
476 #define CIFS_SES_W9X 4
477 /* following flag is set for old servers such as OS2 (and Win95?)
478 which do not negotiate NTLM or POSIX dialects, but instead
479 negotiate one of the older LANMAN dialects */
480 #define CIFS_SES_LANMAN 8
482 * there is one of these for each connection to a resource on a particular
486 struct list_head tcon_list;
488 struct list_head openFileList;
489 struct cifs_ses *ses; /* pointer to session associated with */
490 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
491 char *nativeFileSystem;
492 char *password; /* for share-level security */
493 __u16 tid; /* The 2 byte tree id */
494 __u16 Flags; /* optional support bits */
495 enum statusEnum tidStatus;
496 #ifdef CONFIG_CIFS_STATS
497 atomic_t num_smbs_sent;
500 atomic_t num_flushes;
501 atomic_t num_oplock_brks;
504 atomic_t num_deletes;
506 atomic_t num_posixopens;
507 atomic_t num_posixmkdirs;
509 atomic_t num_renames;
510 atomic_t num_t2renames;
514 atomic_t num_hardlinks;
515 atomic_t num_symlinks;
517 atomic_t num_acl_get;
518 atomic_t num_acl_set;
519 #ifdef CONFIG_CIFS_STATS2
520 unsigned long long time_writes;
521 unsigned long long time_reads;
522 unsigned long long time_opens;
523 unsigned long long time_deletes;
524 unsigned long long time_closes;
525 unsigned long long time_mkdirs;
526 unsigned long long time_rmdirs;
527 unsigned long long time_renames;
528 unsigned long long time_t2renames;
529 unsigned long long time_ffirst;
530 unsigned long long time_fnext;
531 unsigned long long time_fclose;
532 #endif /* CONFIG_CIFS_STATS2 */
535 spinlock_t stat_lock;
536 #endif /* CONFIG_CIFS_STATS */
537 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
538 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
539 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
540 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
543 bool seal:1; /* transport encryption for this mounted share */
544 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
545 for this mount even if server would support */
546 bool local_lease:1; /* check leases (only) on local system not remote */
547 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
548 bool need_reconnect:1; /* connection reset, tid now invalid */
549 #ifdef CONFIG_CIFS_FSCACHE
550 u64 resource_id; /* server resource id */
551 struct fscache_cookie *fscache; /* cookie for share */
553 /* BB add field for back pointer to sb struct(s)? */
557 * This is a refcounted and timestamped container for a tcon pointer. The
558 * container holds a tcon reference. It is considered safe to free one of
559 * these when the tl_count goes to 0. The tl_time is the time of the last
560 * "get" on the container.
563 struct rb_node tl_rbnode;
565 unsigned long tl_flags;
566 #define TCON_LINK_MASTER 0
567 #define TCON_LINK_PENDING 1
568 #define TCON_LINK_IN_TREE 2
569 unsigned long tl_time;
571 struct cifs_tcon *tl_tcon;
574 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
576 static inline struct cifs_tcon *
577 tlink_tcon(struct tcon_link *tlink)
579 return tlink->tl_tcon;
582 extern void cifs_put_tlink(struct tcon_link *tlink);
584 static inline struct tcon_link *
585 cifs_get_tlink(struct tcon_link *tlink)
587 if (tlink && !IS_ERR(tlink))
588 atomic_inc(&tlink->tl_count);
592 /* This function is always expected to succeed */
593 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
596 * This info hangs off the cifsFileInfo structure, pointed to by llist.
597 * This is used to track byte stream locks on the file
599 struct cifsLockInfo {
600 struct list_head llist; /* pointer to next cifsLockInfo */
601 struct list_head blist; /* pointer to locks blocked on this */
602 wait_queue_head_t block_q;
610 * One of these for each open instance of a file
612 struct cifs_search_info {
613 loff_t index_of_last_entry;
614 __u16 entries_in_buffer;
617 char *ntwrk_buf_start;
618 char *srch_entries_start;
620 const char *presume_name;
621 unsigned int resume_name_len;
625 bool smallBuf:1; /* so we know which buf_release function to call */
628 struct cifsFileInfo {
629 struct list_head tlist; /* pointer to next fid owned by tcon */
630 struct list_head flist; /* next fid (file instance) for this inode */
631 struct list_head llist; /*
632 * brlocks held by this fid, protected by
633 * lock_mutex from cifsInodeInfo structure
635 unsigned int uid; /* allows finding which FileInfo structure */
636 __u32 pid; /* process id who opened file */
637 __u16 netfid; /* file id from remote */
638 /* BB add lock scope info here if needed */ ;
639 /* lock scope id (0 if none) */
640 struct dentry *dentry;
641 unsigned int f_flags;
642 struct tcon_link *tlink;
643 bool invalidHandle:1; /* file closed via session abend */
644 bool oplock_break_cancelled:1;
645 int count; /* refcount protected by cifs_file_list_lock */
646 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
647 struct cifs_search_info srch_inf;
648 struct work_struct oplock_break; /* work for oplock breaks */
651 struct cifs_io_parms {
656 struct cifs_tcon *tcon;
660 * Take a reference on the file private data. Must be called with
661 * cifs_file_list_lock held.
664 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file)
670 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
673 * One of these for each file inode
676 struct cifsInodeInfo {
677 bool can_cache_brlcks;
678 struct mutex lock_mutex; /*
679 * protect the field above and llist
680 * from every cifsFileInfo structure
683 /* BB add in lists for dirty pages i.e. write caching info for oplock */
684 struct list_head openFileList;
685 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
686 bool clientCanCacheRead; /* read oplock */
687 bool clientCanCacheAll; /* read and writebehind oplock */
688 bool delete_pending; /* DELETE_ON_CLOSE is set */
689 bool invalid_mapping; /* pagecache is invalid */
690 unsigned long time; /* jiffies of last update of inode */
691 u64 server_eof; /* current file size on server -- protected by i_lock */
692 u64 uniqueid; /* server inode number */
693 u64 createtime; /* creation time on server */
694 #ifdef CONFIG_CIFS_FSCACHE
695 struct fscache_cookie *fscache;
697 struct inode vfs_inode;
700 static inline struct cifsInodeInfo *
701 CIFS_I(struct inode *inode)
703 return container_of(inode, struct cifsInodeInfo, vfs_inode);
706 static inline struct cifs_sb_info *
707 CIFS_SB(struct super_block *sb)
709 return sb->s_fs_info;
712 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
714 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
721 convert_delimiter(char *path, char delim)
734 for (i = 0; path[i] != '\0'; i++) {
735 if (path[i] == old_delim)
740 #ifdef CONFIG_CIFS_STATS
741 #define cifs_stats_inc atomic_inc
743 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
747 spin_lock(&tcon->stat_lock);
748 tcon->bytes_written += bytes;
749 spin_unlock(&tcon->stat_lock);
753 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
756 spin_lock(&tcon->stat_lock);
757 tcon->bytes_read += bytes;
758 spin_unlock(&tcon->stat_lock);
762 #define cifs_stats_inc(field) do {} while (0)
763 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
764 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
770 * This is the prototype for the mid receive function. This function is for
771 * receiving the rest of the SMB frame, starting with the WordCount (which is
772 * just after the MID in struct smb_hdr). Note:
774 * - This will be called by cifsd, with no locks held.
775 * - The mid will still be on the pending_mid_q.
776 * - mid->resp_buf will point to the current buffer.
778 * Returns zero on a successful receive, or an error. The receive state in
779 * the TCP_Server_Info will also be updated.
781 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
782 struct mid_q_entry *mid);
785 * This is the prototype for the mid callback function. This is called once the
786 * mid has been received off of the socket. When creating one, take special
787 * care to avoid deadlocks. Things to bear in mind:
789 * - it will be called by cifsd, with no locks held
790 * - the mid will be removed from any lists
792 typedef void (mid_callback_t)(struct mid_q_entry *mid);
794 /* one of these for every pending CIFS request to the server */
796 struct list_head qhead; /* mids waiting on reply from this server */
797 __u64 mid; /* multiplex id */
798 __u32 pid; /* process id */
799 __u32 sequence_number; /* for CIFS signing */
800 unsigned long when_alloc; /* when mid was created */
801 #ifdef CONFIG_CIFS_STATS2
802 unsigned long when_sent; /* time when smb send finished */
803 unsigned long when_received; /* when demux complete (taken off wire) */
805 mid_receive_t *receive; /* call receive callback */
806 mid_callback_t *callback; /* call completion callback */
807 void *callback_data; /* general purpose pointer for callback */
808 void *resp_buf; /* pointer to received SMB header */
809 int mid_state; /* wish this were enum but can not pass to wait_event */
810 __le16 command; /* smb command code */
811 bool large_buf:1; /* if valid response, is pointer to large buf */
812 bool multiRsp:1; /* multiple trans2 responses for one request */
813 bool multiEnd:1; /* both received */
816 /* Make code in transport.c a little cleaner by moving
817 update of optional stats into function below */
818 #ifdef CONFIG_CIFS_STATS2
820 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
822 atomic_inc(&server->in_send);
825 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
827 atomic_dec(&server->in_send);
830 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
832 atomic_inc(&server->num_waiters);
835 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
837 atomic_dec(&server->num_waiters);
840 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
842 mid->when_sent = jiffies;
845 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
848 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
852 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
856 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
860 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
865 /* for pending dnotify requests */
866 struct dir_notify_req {
867 struct list_head lhead;
874 __u32 filter; /* CompletionFilter (for multishot) */
879 struct dfs_info3_param {
880 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
889 * common struct for holding inode info when searching for or updating an
890 * inode with new info
893 #define CIFS_FATTR_DFS_REFERRAL 0x1
894 #define CIFS_FATTR_DELETE_PENDING 0x2
895 #define CIFS_FATTR_NEED_REVAL 0x4
896 #define CIFS_FATTR_INO_COLLISION 0x8
909 unsigned int cf_nlink;
910 unsigned int cf_dtype;
911 struct timespec cf_atime;
912 struct timespec cf_mtime;
913 struct timespec cf_ctime;
916 static inline void free_dfs_info_param(struct dfs_info3_param *param)
919 kfree(param->path_name);
920 kfree(param->node_name);
925 static inline void free_dfs_info_array(struct dfs_info3_param *param,
929 if ((number_of_items == 0) || (param == NULL))
931 for (i = 0; i < number_of_items; i++) {
932 kfree(param[i].path_name);
933 kfree(param[i].node_name);
939 #define MID_REQUEST_ALLOCATED 1
940 #define MID_REQUEST_SUBMITTED 2
941 #define MID_RESPONSE_RECEIVED 4
942 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
943 #define MID_RESPONSE_MALFORMED 0x10
944 #define MID_SHUTDOWN 0x20
946 /* Types of response buffer returned from SendReceive2 */
947 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
948 #define CIFS_SMALL_BUFFER 1
949 #define CIFS_LARGE_BUFFER 2
950 #define CIFS_IOVEC 4 /* array of response buffers */
952 /* Type of Request to SendReceive2 */
953 #define CIFS_BLOCKING_OP 1 /* operation can block */
954 #define CIFS_ASYNC_OP 2 /* do not wait for response */
955 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
956 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
957 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
958 #define CIFS_NO_RESP 0x040 /* no response buffer required */
960 /* Security Flags: indicate type of session setup needed */
961 #define CIFSSEC_MAY_SIGN 0x00001
962 #define CIFSSEC_MAY_NTLM 0x00002
963 #define CIFSSEC_MAY_NTLMV2 0x00004
964 #define CIFSSEC_MAY_KRB5 0x00008
965 #ifdef CONFIG_CIFS_WEAK_PW_HASH
966 #define CIFSSEC_MAY_LANMAN 0x00010
967 #define CIFSSEC_MAY_PLNTXT 0x00020
969 #define CIFSSEC_MAY_LANMAN 0
970 #define CIFSSEC_MAY_PLNTXT 0
971 #endif /* weak passwords */
972 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
973 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
975 #define CIFSSEC_MUST_SIGN 0x01001
976 /* note that only one of the following can be set so the
977 result of setting MUST flags more than once will be to
978 require use of the stronger protocol */
979 #define CIFSSEC_MUST_NTLM 0x02002
980 #define CIFSSEC_MUST_NTLMV2 0x04004
981 #define CIFSSEC_MUST_KRB5 0x08008
982 #ifdef CONFIG_CIFS_WEAK_PW_HASH
983 #define CIFSSEC_MUST_LANMAN 0x10010
984 #define CIFSSEC_MUST_PLNTXT 0x20020
985 #ifdef CONFIG_CIFS_UPCALL
986 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
988 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
990 #else /* do not allow weak pw hash */
991 #define CIFSSEC_MUST_LANMAN 0
992 #define CIFSSEC_MUST_PLNTXT 0
993 #ifdef CONFIG_CIFS_UPCALL
994 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
996 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
998 #endif /* WEAK_PW_HASH */
999 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1000 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1002 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
1003 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1004 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1006 *****************************************************************
1007 * All constants go here
1008 *****************************************************************
1011 #define UID_HASH (16)
1014 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1015 * following to be declared.
1018 /****************************************************************************
1019 * Locking notes. All updates to global variables and lists should be
1020 * protected by spinlocks or semaphores.
1024 * GlobalMid_Lock protects:
1025 * list operations on pending_mid_q and oplockQ
1026 * updates to XID counters, multiplex id and SMB sequence numbers
1027 * cifs_file_list_lock protects:
1028 * list operations on tcp and SMB session lists and tCon lists
1029 * f_owner.lock protects certain per file struct operations
1030 * mapping->page_lock protects certain per page operations
1034 * sesSem operations on smb session
1035 * tconSem operations on tree connection
1036 * fh_sem file handle reconnection operations
1038 ****************************************************************************/
1040 #ifdef DECLARE_GLOBALS_HERE
1041 #define GLOBAL_EXTERN
1043 #define GLOBAL_EXTERN extern
1047 * the list of TCP_Server_Info structures, ie each of the sockets
1048 * connecting our client to a distinct server (ip address), is
1049 * chained together by cifs_tcp_ses_list. The list of all our SMB
1050 * sessions (and from that the tree connections) can be found
1051 * by iterating over cifs_tcp_ses_list
1053 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1056 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1057 * tcp session, and the list of tcon's per smb session. It also protects
1058 * the reference counters for the server, smb session, and tcon. Finally,
1059 * changes to the tcon->tidStatus should be done while holding this lock.
1061 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1064 * This lock protects the cifs_file->llist and cifs_file->flist
1065 * list operations, and updates to some flags (cifs_file->invalidHandle)
1066 * It will be moved to either use the tcon->stat_lock or equivalent later.
1067 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1068 * the cifs_tcp_ses_lock must be grabbed first and released last.
1070 GLOBAL_EXTERN spinlock_t cifs_file_list_lock;
1072 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1073 /* Outstanding dir notify requests */
1074 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1075 /* DirNotify response queue */
1076 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1077 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1080 * Global transaction id (XID) information
1082 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1083 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1084 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1085 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1086 /* on midQ entries */
1088 * Global counters, updated atomically
1090 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1091 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1092 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1093 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1094 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1096 /* Various Debug counters */
1097 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1098 #ifdef CONFIG_CIFS_STATS2
1099 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1100 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1102 GLOBAL_EXTERN atomic_t smBufAllocCount;
1103 GLOBAL_EXTERN atomic_t midCount;
1106 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1107 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1108 GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1109 with more secure ntlmssp2 challenge/resp */
1110 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1111 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1112 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1113 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1114 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1115 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1117 #ifdef CONFIG_CIFS_ACL
1118 GLOBAL_EXTERN struct rb_root uidtree;
1119 GLOBAL_EXTERN struct rb_root gidtree;
1120 GLOBAL_EXTERN spinlock_t siduidlock;
1121 GLOBAL_EXTERN spinlock_t sidgidlock;
1122 GLOBAL_EXTERN struct rb_root siduidtree;
1123 GLOBAL_EXTERN struct rb_root sidgidtree;
1124 GLOBAL_EXTERN spinlock_t uidsidlock;
1125 GLOBAL_EXTERN spinlock_t gidsidlock;
1126 #endif /* CONFIG_CIFS_ACL */
1128 void cifs_oplock_break(struct work_struct *work);
1130 extern const struct slow_work_ops cifs_oplock_break_ops;
1131 extern struct workqueue_struct *cifsiod_wq;
1133 /* Operations for different SMB versions */
1134 #define SMB1_VERSION_STRING "1.0"
1135 extern struct smb_version_operations smb1_operations;
1136 extern struct smb_version_values smb1_values;
1137 #define SMB21_VERSION_STRING "2.1"
1138 extern struct smb_version_operations smb21_operations;
1139 extern struct smb_version_values smb21_values;
1140 #endif /* _CIFS_GLOB_H */