4 * Copyright (C) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org)
8 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as published
10 * by the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
16 * the GNU Lesser General Public License for more details.
23 #include <linux/in6.h>
24 #include <linux/slab.h>
25 #include <linux/mempool.h>
26 #include <linux/workqueue.h>
27 #include "cifs_fs_sb.h"
29 #include <crypto/internal/hash.h>
30 #include <linux/scatterlist.h>
31 #ifdef CONFIG_CIFS_SMB2
36 * The sizes of various internal tables and strings
38 #define MAX_UID_INFO 16
39 #define MAX_SES_INFO 2
40 #define MAX_TCON_INFO 4
42 #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
43 #define MAX_SERVER_SIZE 15
44 #define MAX_SHARE_SIZE 80
45 #define MAX_USERNAME_SIZE 256 /* reasonable maximum for current servers */
46 #define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */
48 #define CIFS_MIN_RCV_POOL 4
50 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
52 * default attribute cache timeout (jiffies)
54 #define CIFS_DEF_ACTIMEO (1 * HZ)
57 * max attribute cache timeout (jiffies) - 2^30
59 #define CIFS_MAX_ACTIMEO (1 << 30)
62 * MAX_REQ is the maximum number of requests that WE will send
63 * on one socket concurrently.
65 #define CIFS_MAX_REQ 32767
67 #define RFC1001_NAME_LEN 15
68 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
70 /* currently length of NIP6_FMT */
71 #define SERVER_NAME_LENGTH 40
72 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
74 /* used to define string lengths for reversing unicode strings */
76 /* (max path length + 1 for null) * 2 for unicode */
79 /* SMB echo "timeout" -- FIXME: tunable? */
80 #define SMB_ECHO_INTERVAL (60 * HZ)
84 #ifndef XATTR_DOS_ATTRIB
85 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
89 * CIFS vfs client Status information (based on what we know.)
92 /* associated with each tcp and smb session */
102 LANMAN = 0, /* Legacy LANMAN auth */
103 NTLM, /* Legacy NTLM012 auth with NTLM hash */
104 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
105 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
106 /* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
107 Kerberos, /* Kerberos via SPNEGO */
113 /* Netbios frames protocol not supported at this time */
121 /* crypto security descriptor definition */
123 struct shash_desc shash;
127 /* crypto hashing related structure/fields, not specific to a sec mech */
128 struct cifs_secmech {
129 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
130 struct crypto_shash *md5; /* md5 hash function */
131 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
132 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
135 /* per smb session structure/fields */
136 struct ntlmssp_auth {
137 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
138 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
139 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
140 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
148 struct cifs_sid osid;
149 struct cifs_sid gsid;
150 struct cifs_ntace *ntaces;
151 struct cifs_ace *aces;
155 *****************************************************************
156 * Except the CIFS PDUs themselves all the
157 * globally interesting structs should go here
158 *****************************************************************
167 struct TCP_Server_Info;
171 struct dfs_info3_param;
176 struct smb_version_operations {
177 int (*send_cancel)(struct TCP_Server_Info *, void *,
178 struct mid_q_entry *);
179 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
180 /* setup request: allocate mid, sign message */
181 int (*setup_request)(struct cifs_ses *, struct kvec *, unsigned int,
182 struct mid_q_entry **);
183 /* setup async request: allocate mid, sign message */
184 int (*setup_async_request)(struct TCP_Server_Info *, struct kvec *,
185 unsigned int, struct mid_q_entry **);
186 /* check response: verify signature, map error */
187 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
189 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
191 void (*set_credits)(struct TCP_Server_Info *, const int);
192 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
193 unsigned int (*get_credits)(struct mid_q_entry *);
194 __u64 (*get_next_mid)(struct TCP_Server_Info *);
195 /* data offset from read response message */
196 unsigned int (*read_data_offset)(char *);
197 /* data length from read response message */
198 unsigned int (*read_data_length)(char *);
199 /* map smb to linux error */
200 int (*map_error)(char *, bool);
201 /* find mid corresponding to the response message */
202 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
203 void (*dump_detail)(void *);
204 void (*clear_stats)(struct cifs_tcon *);
205 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
206 /* verify the message */
207 int (*check_message)(char *, unsigned int);
208 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
209 /* process transaction2 response */
210 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
212 /* check if we need to negotiate */
213 bool (*need_neg)(struct TCP_Server_Info *);
214 /* negotiate to the server */
215 int (*negotiate)(const unsigned int, struct cifs_ses *);
216 /* setup smb sessionn */
217 int (*sess_setup)(const unsigned int, struct cifs_ses *,
218 const struct nls_table *);
219 /* close smb session */
220 int (*logoff)(const unsigned int, struct cifs_ses *);
221 /* connect to a server share */
222 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
223 struct cifs_tcon *, const struct nls_table *);
224 /* close tree connecion */
225 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
226 /* get DFS referrals */
227 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
228 const char *, struct dfs_info3_param **,
229 unsigned int *, const struct nls_table *, int);
230 /* informational QFS call */
231 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
232 /* check if a path is accessible or not */
233 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
234 struct cifs_sb_info *, const char *);
235 /* query path data from the server */
236 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
237 struct cifs_sb_info *, const char *,
238 FILE_ALL_INFO *, bool *);
239 /* get server index number */
240 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
241 struct cifs_sb_info *, const char *,
242 u64 *uniqueid, FILE_ALL_INFO *);
243 /* build a full path to the root of the mount */
244 char * (*build_path_to_root)(struct smb_vol *, struct cifs_sb_info *,
246 /* check if we can send an echo or nor */
247 bool (*can_echo)(struct TCP_Server_Info *);
248 /* send echo request */
249 int (*echo)(struct TCP_Server_Info *);
250 /* create directory */
251 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
252 struct cifs_sb_info *);
253 /* set info on created directory */
254 void (*mkdir_setinfo)(struct inode *, const char *,
255 struct cifs_sb_info *, struct cifs_tcon *,
257 /* remove directory */
258 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
259 struct cifs_sb_info *);
261 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
262 struct cifs_sb_info *);
263 /* open, rename and delete file */
264 int (*rename_pending_delete)(const char *, struct dentry *,
266 /* open a file for non-posix mounts */
267 int (*open)(const unsigned int, struct cifs_tcon *, const char *, int,
268 int, int, struct cifs_fid *, __u32 *, FILE_ALL_INFO *,
269 struct cifs_sb_info *);
270 /* set fid protocol-specific info */
271 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
273 int (*close)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
276 struct smb_version_values {
277 char *version_string;
278 __u32 large_lock_type;
279 __u32 exclusive_lock_type;
280 __u32 shared_lock_type;
281 __u32 unlock_lock_type;
283 size_t max_header_size;
284 size_t read_rsp_size;
286 unsigned int cap_unix;
287 unsigned int cap_nt_find;
288 unsigned int cap_large_files;
291 #define HEADER_SIZE(server) (server->vals->header_size)
292 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
300 char *iocharset; /* local code page for mapping to and from Unicode */
301 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
302 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
318 bool no_psx_acl:1; /* set if posix acl support should be disabled */
320 bool backupuid_specified; /* mount option backupuid is specified */
321 bool backupgid_specified; /* mount option backupgid is specified */
322 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
323 bool server_ino:1; /* use inode numbers from server ie UniqueId */
325 bool strict_io:1; /* strict cache behavior */
326 bool remap:1; /* set to remap seven reserved chars in filenames */
327 bool posix_paths:1; /* unset to not ask for posix pathnames. */
330 bool nullauth:1; /* attempt to authenticate with null user */
331 bool nocase:1; /* request case insensitive filenames */
332 bool nobrl:1; /* disable sending byte range locks to srv */
333 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
334 bool seal:1; /* request transport encryption on share */
335 bool nodfs:1; /* Do not request DFS, even if available */
336 bool local_lease:1; /* check leases only on local system, not remote */
339 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
340 bool fsc:1; /* enable fscache */
341 bool mfsymlinks:1; /* use Minshall+French Symlinks */
343 bool rwpidforward:1; /* pid forward for read/write operations */
346 bool sockopt_tcp_nodelay:1;
347 unsigned short int port;
348 unsigned long actimeo; /* attribute cache timeout (jiffies) */
349 struct smb_version_operations *ops;
350 struct smb_version_values *vals;
352 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
353 struct nls_table *local_nls;
356 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
357 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
358 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
359 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
360 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
361 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
362 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
363 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
364 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
365 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
367 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
368 MS_NODEV | MS_SYNCHRONOUS)
370 struct cifs_mnt_data {
371 struct cifs_sb_info *cifs_sb;
376 static inline unsigned int
377 get_rfc1002_length(void *buf)
379 return be32_to_cpu(*((__be32 *)buf));
383 inc_rfc1001_len(void *buf, int count)
385 be32_add_cpu((__be32 *)buf, count);
388 struct TCP_Server_Info {
389 struct list_head tcp_ses_list;
390 struct list_head smb_ses_list;
391 int srv_count; /* reference counter */
392 /* 15 character server name + 0x20 16th byte indicating type = srv */
393 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
394 struct smb_version_operations *ops;
395 struct smb_version_values *vals;
396 enum statusEnum tcpStatus; /* what we think the status is */
397 char *hostname; /* hostname portion of UNC string */
398 struct socket *ssocket;
399 struct sockaddr_storage dstaddr;
400 struct sockaddr_storage srcaddr; /* locally bind to this IP */
404 wait_queue_head_t response_q;
405 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
406 struct list_head pending_mid_q;
407 bool noblocksnd; /* use blocking sendmsg */
408 bool noautotune; /* do not autotune send buf sizes */
410 int credits; /* send no more requests at once */
411 unsigned int in_flight; /* number of requests on the wire to server */
412 spinlock_t req_lock; /* protect the two values above */
413 struct mutex srv_mutex;
414 struct task_struct *tsk;
415 char server_GUID[16];
417 bool session_estab; /* mark when very first sess is established */
418 #ifdef CONFIG_CIFS_SMB2
419 int echo_credits; /* echo reserved slots */
420 int oplock_credits; /* oplock break reserved slots */
421 bool echoes:1; /* enable echoes */
423 u16 dialect; /* dialect index that server chose */
424 enum securityEnum secType;
425 bool oplocks:1; /* enable oplocks */
426 unsigned int maxReq; /* Clients should submit no more */
427 /* than maxReq distinct unanswered SMBs to the server when using */
428 /* multiplexed reads or writes */
429 unsigned int maxBuf; /* maxBuf specifies the maximum */
430 /* message size the server can send or receive for non-raw SMBs */
431 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
432 /* when socket is setup (and during reconnect) before NegProt sent */
433 unsigned int max_rw; /* maxRw specifies the maximum */
434 /* message size the server can send or receive for */
435 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
436 unsigned int max_vcs; /* maximum number of smb sessions, at least
437 those that can be specified uniquely with
439 unsigned int capabilities; /* selective disabling of caps by smb sess */
440 int timeAdj; /* Adjust for difference in server time zone in sec */
441 __u64 CurrentMid; /* multiplex id - rotating counter */
442 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
443 /* 16th byte of RFC1001 workstation name is always null */
444 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
445 __u32 sequence_number; /* for signing, protected by srv_mutex */
446 struct session_key session_key;
447 unsigned long lstrp; /* when we got last response from this server */
448 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
449 /* extended security flavors that server supports */
450 bool sec_ntlmssp; /* supports NTLMSSP */
451 bool sec_kerberosu2u; /* supports U2U Kerberos */
452 bool sec_kerberos; /* supports plain Kerberos */
453 bool sec_mskerberos; /* supports legacy MS Kerberos */
454 bool large_buf; /* is current buffer large? */
455 struct delayed_work echo; /* echo ping workqueue job */
456 struct kvec *iov; /* reusable kvec array for receives */
457 unsigned int nr_iov; /* number of kvecs in array */
458 char *smallbuf; /* pointer to current "small" buffer */
459 char *bigbuf; /* pointer to current "big" buffer */
460 unsigned int total_read; /* total amount of data read in this pass */
461 #ifdef CONFIG_CIFS_FSCACHE
462 struct fscache_cookie *fscache; /* client index cache cookie */
464 #ifdef CONFIG_CIFS_STATS2
465 atomic_t in_send; /* requests trying to send */
466 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
468 #ifdef CONFIG_CIFS_SMB2
469 unsigned int max_read;
470 unsigned int max_write;
471 #endif /* CONFIG_CIFS_SMB2 */
474 static inline unsigned int
475 in_flight(struct TCP_Server_Info *server)
478 spin_lock(&server->req_lock);
479 num = server->in_flight;
480 spin_unlock(&server->req_lock);
485 has_credits(struct TCP_Server_Info *server, int *credits)
488 spin_lock(&server->req_lock);
490 spin_unlock(&server->req_lock);
495 add_credits(struct TCP_Server_Info *server, const unsigned int add,
498 server->ops->add_credits(server, add, optype);
502 set_credits(struct TCP_Server_Info *server, const int val)
504 server->ops->set_credits(server, val);
508 get_next_mid(struct TCP_Server_Info *server)
510 return server->ops->get_next_mid(server);
514 * Macros to allow the TCP_Server_Info->net field and related code to drop out
515 * when CONFIG_NET_NS isn't set.
520 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
525 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
532 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
537 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
544 * Session structure. One of these for each uid session with a particular host
547 struct list_head smb_ses_list;
548 struct list_head tcon_list;
549 struct mutex session_mutex;
550 struct TCP_Server_Info *server; /* pointer to server info */
551 int ses_count; /* reference counter */
552 enum statusEnum status;
553 unsigned overrideSecFlg; /* if non-zero override global sec flags */
554 __u16 ipc_tid; /* special tid for connection to IPC share */
557 char *serverOS; /* name of operating system underlying server */
558 char *serverNOS; /* name of network operating system of server */
559 char *serverDomain; /* security realm of server */
560 __u64 Suid; /* remote smb uid */
561 uid_t linux_uid; /* overriding owner of files on the mount */
562 uid_t cred_uid; /* owner of credentials */
563 unsigned int capabilities;
564 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
565 TCP names - will ipv6 and sctp addresses fit? */
566 char *user_name; /* must not be null except during init of sess
567 and after mount option parsing we fill it */
570 struct session_key auth_key;
571 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
572 bool need_reconnect:1; /* connection reset, uid now invalid */
573 #ifdef CONFIG_CIFS_SMB2
575 #endif /* CONFIG_CIFS_SMB2 */
577 /* no more than one of the following three session flags may be set */
578 #define CIFS_SES_NT4 1
579 #define CIFS_SES_OS2 2
580 #define CIFS_SES_W9X 4
581 /* following flag is set for old servers such as OS2 (and Win95?)
582 which do not negotiate NTLM or POSIX dialects, but instead
583 negotiate one of the older LANMAN dialects */
584 #define CIFS_SES_LANMAN 8
587 cap_unix(struct cifs_ses *ses)
589 return ses->server->vals->cap_unix & ses->capabilities;
593 * there is one of these for each connection to a resource on a particular
597 struct list_head tcon_list;
599 struct list_head openFileList;
600 struct cifs_ses *ses; /* pointer to session associated with */
601 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
602 char *nativeFileSystem;
603 char *password; /* for share-level security */
604 __u32 tid; /* The 4 byte tree id */
605 __u16 Flags; /* optional support bits */
606 enum statusEnum tidStatus;
607 #ifdef CONFIG_CIFS_STATS
608 atomic_t num_smbs_sent;
613 atomic_t num_flushes;
614 atomic_t num_oplock_brks;
617 atomic_t num_deletes;
619 atomic_t num_posixopens;
620 atomic_t num_posixmkdirs;
622 atomic_t num_renames;
623 atomic_t num_t2renames;
627 atomic_t num_hardlinks;
628 atomic_t num_symlinks;
630 atomic_t num_acl_get;
631 atomic_t num_acl_set;
633 #ifdef CONFIG_CIFS_SMB2
635 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
636 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
638 #endif /* CONFIG_CIFS_SMB2 */
640 #ifdef CONFIG_CIFS_STATS2
641 unsigned long long time_writes;
642 unsigned long long time_reads;
643 unsigned long long time_opens;
644 unsigned long long time_deletes;
645 unsigned long long time_closes;
646 unsigned long long time_mkdirs;
647 unsigned long long time_rmdirs;
648 unsigned long long time_renames;
649 unsigned long long time_t2renames;
650 unsigned long long time_ffirst;
651 unsigned long long time_fnext;
652 unsigned long long time_fclose;
653 #endif /* CONFIG_CIFS_STATS2 */
656 spinlock_t stat_lock;
657 #endif /* CONFIG_CIFS_STATS */
658 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
659 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
660 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
661 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
664 bool seal:1; /* transport encryption for this mounted share */
665 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
666 for this mount even if server would support */
667 bool local_lease:1; /* check leases (only) on local system not remote */
668 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
669 bool need_reconnect:1; /* connection reset, tid now invalid */
670 #ifdef CONFIG_CIFS_SMB2
671 bool print:1; /* set if connection to printer share */
672 bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
675 __u32 maximal_access;
676 __u32 vol_serial_number;
677 __le64 vol_create_time;
678 #endif /* CONFIG_CIFS_SMB2 */
679 #ifdef CONFIG_CIFS_FSCACHE
680 u64 resource_id; /* server resource id */
681 struct fscache_cookie *fscache; /* cookie for share */
683 /* BB add field for back pointer to sb struct(s)? */
687 * This is a refcounted and timestamped container for a tcon pointer. The
688 * container holds a tcon reference. It is considered safe to free one of
689 * these when the tl_count goes to 0. The tl_time is the time of the last
690 * "get" on the container.
693 struct rb_node tl_rbnode;
695 unsigned long tl_flags;
696 #define TCON_LINK_MASTER 0
697 #define TCON_LINK_PENDING 1
698 #define TCON_LINK_IN_TREE 2
699 unsigned long tl_time;
701 struct cifs_tcon *tl_tcon;
704 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
706 static inline struct cifs_tcon *
707 tlink_tcon(struct tcon_link *tlink)
709 return tlink->tl_tcon;
712 extern void cifs_put_tlink(struct tcon_link *tlink);
714 static inline struct tcon_link *
715 cifs_get_tlink(struct tcon_link *tlink)
717 if (tlink && !IS_ERR(tlink))
718 atomic_inc(&tlink->tl_count);
722 /* This function is always expected to succeed */
723 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
726 * This info hangs off the cifsFileInfo structure, pointed to by llist.
727 * This is used to track byte stream locks on the file
729 struct cifsLockInfo {
730 struct list_head llist; /* pointer to next cifsLockInfo */
731 struct list_head blist; /* pointer to locks blocked on this */
732 wait_queue_head_t block_q;
740 * One of these for each open instance of a file
742 struct cifs_search_info {
743 loff_t index_of_last_entry;
744 __u16 entries_in_buffer;
747 char *ntwrk_buf_start;
748 char *srch_entries_start;
750 const char *presume_name;
751 unsigned int resume_name_len;
755 bool smallBuf:1; /* so we know which buf_release function to call */
762 struct cifsFileInfo {
763 struct list_head tlist; /* pointer to next fid owned by tcon */
764 struct list_head flist; /* next fid (file instance) for this inode */
765 struct list_head llist; /*
766 * brlocks held by this fid, protected by
767 * lock_mutex from cifsInodeInfo structure
769 unsigned int uid; /* allows finding which FileInfo structure */
770 __u32 pid; /* process id who opened file */
771 struct cifs_fid fid; /* file id from remote */
772 /* BB add lock scope info here if needed */ ;
773 /* lock scope id (0 if none) */
774 struct dentry *dentry;
775 unsigned int f_flags;
776 struct tcon_link *tlink;
777 bool invalidHandle:1; /* file closed via session abend */
778 bool oplock_break_cancelled:1;
779 int count; /* refcount protected by cifs_file_list_lock */
780 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
781 struct cifs_search_info srch_inf;
782 struct work_struct oplock_break; /* work for oplock breaks */
785 struct cifs_io_parms {
790 struct cifs_tcon *tcon;
794 * Take a reference on the file private data. Must be called with
795 * cifs_file_list_lock held.
798 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
803 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
804 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
807 * One of these for each file inode
810 struct cifsInodeInfo {
811 bool can_cache_brlcks;
812 struct mutex lock_mutex; /*
813 * protect the field above and llist
814 * from every cifsFileInfo structure
817 /* BB add in lists for dirty pages i.e. write caching info for oplock */
818 struct list_head openFileList;
819 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
820 bool clientCanCacheRead; /* read oplock */
821 bool clientCanCacheAll; /* read and writebehind oplock */
822 bool delete_pending; /* DELETE_ON_CLOSE is set */
823 bool invalid_mapping; /* pagecache is invalid */
824 unsigned long time; /* jiffies of last update of inode */
825 u64 server_eof; /* current file size on server -- protected by i_lock */
826 u64 uniqueid; /* server inode number */
827 u64 createtime; /* creation time on server */
828 #ifdef CONFIG_CIFS_FSCACHE
829 struct fscache_cookie *fscache;
831 struct inode vfs_inode;
834 static inline struct cifsInodeInfo *
835 CIFS_I(struct inode *inode)
837 return container_of(inode, struct cifsInodeInfo, vfs_inode);
840 static inline struct cifs_sb_info *
841 CIFS_SB(struct super_block *sb)
843 return sb->s_fs_info;
846 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
848 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
855 convert_delimiter(char *path, char delim)
868 for (i = 0; path[i] != '\0'; i++) {
869 if (path[i] == old_delim)
875 build_path_to_root(struct smb_vol *vol, struct cifs_sb_info *cifs_sb,
876 struct cifs_tcon *tcon)
878 if (!vol->ops->build_path_to_root)
880 return vol->ops->build_path_to_root(vol, cifs_sb, tcon);
883 #ifdef CONFIG_CIFS_STATS
884 #define cifs_stats_inc atomic_inc
886 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
890 spin_lock(&tcon->stat_lock);
891 tcon->bytes_written += bytes;
892 spin_unlock(&tcon->stat_lock);
896 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
899 spin_lock(&tcon->stat_lock);
900 tcon->bytes_read += bytes;
901 spin_unlock(&tcon->stat_lock);
905 #define cifs_stats_inc(field) do {} while (0)
906 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
907 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
913 * This is the prototype for the mid receive function. This function is for
914 * receiving the rest of the SMB frame, starting with the WordCount (which is
915 * just after the MID in struct smb_hdr). Note:
917 * - This will be called by cifsd, with no locks held.
918 * - The mid will still be on the pending_mid_q.
919 * - mid->resp_buf will point to the current buffer.
921 * Returns zero on a successful receive, or an error. The receive state in
922 * the TCP_Server_Info will also be updated.
924 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
925 struct mid_q_entry *mid);
928 * This is the prototype for the mid callback function. This is called once the
929 * mid has been received off of the socket. When creating one, take special
930 * care to avoid deadlocks. Things to bear in mind:
932 * - it will be called by cifsd, with no locks held
933 * - the mid will be removed from any lists
935 typedef void (mid_callback_t)(struct mid_q_entry *mid);
937 /* one of these for every pending CIFS request to the server */
939 struct list_head qhead; /* mids waiting on reply from this server */
940 struct TCP_Server_Info *server; /* server corresponding to this mid */
941 __u64 mid; /* multiplex id */
942 __u32 pid; /* process id */
943 __u32 sequence_number; /* for CIFS signing */
944 unsigned long when_alloc; /* when mid was created */
945 #ifdef CONFIG_CIFS_STATS2
946 unsigned long when_sent; /* time when smb send finished */
947 unsigned long when_received; /* when demux complete (taken off wire) */
949 mid_receive_t *receive; /* call receive callback */
950 mid_callback_t *callback; /* call completion callback */
951 void *callback_data; /* general purpose pointer for callback */
952 void *resp_buf; /* pointer to received SMB header */
953 int mid_state; /* wish this were enum but can not pass to wait_event */
954 __le16 command; /* smb command code */
955 bool large_buf:1; /* if valid response, is pointer to large buf */
956 bool multiRsp:1; /* multiple trans2 responses for one request */
957 bool multiEnd:1; /* both received */
960 /* Make code in transport.c a little cleaner by moving
961 update of optional stats into function below */
962 #ifdef CONFIG_CIFS_STATS2
964 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
966 atomic_inc(&server->in_send);
969 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
971 atomic_dec(&server->in_send);
974 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
976 atomic_inc(&server->num_waiters);
979 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
981 atomic_dec(&server->num_waiters);
984 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
986 mid->when_sent = jiffies;
989 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
992 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
996 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1000 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1004 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1009 /* for pending dnotify requests */
1010 struct dir_notify_req {
1011 struct list_head lhead;
1018 __u32 filter; /* CompletionFilter (for multishot) */
1023 struct dfs_info3_param {
1024 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1033 * common struct for holding inode info when searching for or updating an
1034 * inode with new info
1037 #define CIFS_FATTR_DFS_REFERRAL 0x1
1038 #define CIFS_FATTR_DELETE_PENDING 0x2
1039 #define CIFS_FATTR_NEED_REVAL 0x4
1040 #define CIFS_FATTR_INO_COLLISION 0x8
1053 unsigned int cf_nlink;
1054 unsigned int cf_dtype;
1055 struct timespec cf_atime;
1056 struct timespec cf_mtime;
1057 struct timespec cf_ctime;
1060 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1063 kfree(param->path_name);
1064 kfree(param->node_name);
1069 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1070 int number_of_items)
1073 if ((number_of_items == 0) || (param == NULL))
1075 for (i = 0; i < number_of_items; i++) {
1076 kfree(param[i].path_name);
1077 kfree(param[i].node_name);
1083 #define MID_REQUEST_ALLOCATED 1
1084 #define MID_REQUEST_SUBMITTED 2
1085 #define MID_RESPONSE_RECEIVED 4
1086 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1087 #define MID_RESPONSE_MALFORMED 0x10
1088 #define MID_SHUTDOWN 0x20
1090 /* Types of response buffer returned from SendReceive2 */
1091 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1092 #define CIFS_SMALL_BUFFER 1
1093 #define CIFS_LARGE_BUFFER 2
1094 #define CIFS_IOVEC 4 /* array of response buffers */
1096 /* Type of Request to SendReceive2 */
1097 #define CIFS_BLOCKING_OP 1 /* operation can block */
1098 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1099 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1100 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1101 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1102 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1104 /* Type of request operation */
1105 #define CIFS_ECHO_OP 0x080 /* echo request */
1106 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1107 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1108 #define CIFS_OP_MASK 0x0380 /* mask request type */
1110 /* Security Flags: indicate type of session setup needed */
1111 #define CIFSSEC_MAY_SIGN 0x00001
1112 #define CIFSSEC_MAY_NTLM 0x00002
1113 #define CIFSSEC_MAY_NTLMV2 0x00004
1114 #define CIFSSEC_MAY_KRB5 0x00008
1115 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1116 #define CIFSSEC_MAY_LANMAN 0x00010
1117 #define CIFSSEC_MAY_PLNTXT 0x00020
1119 #define CIFSSEC_MAY_LANMAN 0
1120 #define CIFSSEC_MAY_PLNTXT 0
1121 #endif /* weak passwords */
1122 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1123 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1125 #define CIFSSEC_MUST_SIGN 0x01001
1126 /* note that only one of the following can be set so the
1127 result of setting MUST flags more than once will be to
1128 require use of the stronger protocol */
1129 #define CIFSSEC_MUST_NTLM 0x02002
1130 #define CIFSSEC_MUST_NTLMV2 0x04004
1131 #define CIFSSEC_MUST_KRB5 0x08008
1132 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1133 #define CIFSSEC_MUST_LANMAN 0x10010
1134 #define CIFSSEC_MUST_PLNTXT 0x20020
1135 #ifdef CONFIG_CIFS_UPCALL
1136 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1138 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1140 #else /* do not allow weak pw hash */
1141 #define CIFSSEC_MUST_LANMAN 0
1142 #define CIFSSEC_MUST_PLNTXT 0
1143 #ifdef CONFIG_CIFS_UPCALL
1144 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1146 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1148 #endif /* WEAK_PW_HASH */
1149 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1150 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1152 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
1153 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1154 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1156 *****************************************************************
1157 * All constants go here
1158 *****************************************************************
1161 #define UID_HASH (16)
1164 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1165 * following to be declared.
1168 /****************************************************************************
1169 * Locking notes. All updates to global variables and lists should be
1170 * protected by spinlocks or semaphores.
1174 * GlobalMid_Lock protects:
1175 * list operations on pending_mid_q and oplockQ
1176 * updates to XID counters, multiplex id and SMB sequence numbers
1177 * cifs_file_list_lock protects:
1178 * list operations on tcp and SMB session lists and tCon lists
1179 * f_owner.lock protects certain per file struct operations
1180 * mapping->page_lock protects certain per page operations
1184 * sesSem operations on smb session
1185 * tconSem operations on tree connection
1186 * fh_sem file handle reconnection operations
1188 ****************************************************************************/
1190 #ifdef DECLARE_GLOBALS_HERE
1191 #define GLOBAL_EXTERN
1193 #define GLOBAL_EXTERN extern
1197 * the list of TCP_Server_Info structures, ie each of the sockets
1198 * connecting our client to a distinct server (ip address), is
1199 * chained together by cifs_tcp_ses_list. The list of all our SMB
1200 * sessions (and from that the tree connections) can be found
1201 * by iterating over cifs_tcp_ses_list
1203 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1206 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1207 * tcp session, and the list of tcon's per smb session. It also protects
1208 * the reference counters for the server, smb session, and tcon. Finally,
1209 * changes to the tcon->tidStatus should be done while holding this lock.
1211 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1214 * This lock protects the cifs_file->llist and cifs_file->flist
1215 * list operations, and updates to some flags (cifs_file->invalidHandle)
1216 * It will be moved to either use the tcon->stat_lock or equivalent later.
1217 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1218 * the cifs_tcp_ses_lock must be grabbed first and released last.
1220 GLOBAL_EXTERN spinlock_t cifs_file_list_lock;
1222 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1223 /* Outstanding dir notify requests */
1224 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1225 /* DirNotify response queue */
1226 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1227 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1230 * Global transaction id (XID) information
1232 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1233 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1234 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1235 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1236 /* on midQ entries */
1238 * Global counters, updated atomically
1240 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1241 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1242 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1243 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1244 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1246 /* Various Debug counters */
1247 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1248 #ifdef CONFIG_CIFS_STATS2
1249 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1250 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1252 GLOBAL_EXTERN atomic_t smBufAllocCount;
1253 GLOBAL_EXTERN atomic_t midCount;
1256 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1257 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1258 GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1259 with more secure ntlmssp2 challenge/resp */
1260 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1261 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1262 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1263 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1264 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1265 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1267 #ifdef CONFIG_CIFS_ACL
1268 GLOBAL_EXTERN struct rb_root uidtree;
1269 GLOBAL_EXTERN struct rb_root gidtree;
1270 GLOBAL_EXTERN spinlock_t siduidlock;
1271 GLOBAL_EXTERN spinlock_t sidgidlock;
1272 GLOBAL_EXTERN struct rb_root siduidtree;
1273 GLOBAL_EXTERN struct rb_root sidgidtree;
1274 GLOBAL_EXTERN spinlock_t uidsidlock;
1275 GLOBAL_EXTERN spinlock_t gidsidlock;
1276 #endif /* CONFIG_CIFS_ACL */
1278 void cifs_oplock_break(struct work_struct *work);
1280 extern const struct slow_work_ops cifs_oplock_break_ops;
1281 extern struct workqueue_struct *cifsiod_wq;
1283 extern mempool_t *cifs_mid_poolp;
1285 /* Operations for different SMB versions */
1286 #define SMB1_VERSION_STRING "1.0"
1287 extern struct smb_version_operations smb1_operations;
1288 extern struct smb_version_values smb1_values;
1289 #define SMB21_VERSION_STRING "2.1"
1290 extern struct smb_version_operations smb21_operations;
1291 extern struct smb_version_values smb21_values;
1292 #endif /* _CIFS_GLOB_H */