4 * Copyright (C) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org)
8 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as published
10 * by the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
16 * the GNU Lesser General Public License for more details.
23 #include <linux/in6.h>
24 #include <linux/slab.h>
25 #include <linux/mempool.h>
26 #include <linux/workqueue.h>
27 #include "cifs_fs_sb.h"
29 #include <crypto/internal/hash.h>
30 #include <linux/scatterlist.h>
31 #ifdef CONFIG_CIFS_SMB2
36 * The sizes of various internal tables and strings
38 #define MAX_UID_INFO 16
39 #define MAX_SES_INFO 2
40 #define MAX_TCON_INFO 4
42 #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
43 #define MAX_SERVER_SIZE 15
44 #define MAX_SHARE_SIZE 80
45 #define MAX_USERNAME_SIZE 256 /* reasonable maximum for current servers */
46 #define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */
48 #define CIFS_MIN_RCV_POOL 4
50 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
52 * default attribute cache timeout (jiffies)
54 #define CIFS_DEF_ACTIMEO (1 * HZ)
57 * max attribute cache timeout (jiffies) - 2^30
59 #define CIFS_MAX_ACTIMEO (1 << 30)
62 * MAX_REQ is the maximum number of requests that WE will send
63 * on one socket concurrently.
65 #define CIFS_MAX_REQ 32767
67 #define RFC1001_NAME_LEN 15
68 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
70 /* currently length of NIP6_FMT */
71 #define SERVER_NAME_LENGTH 40
72 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
74 /* used to define string lengths for reversing unicode strings */
76 /* (max path length + 1 for null) * 2 for unicode */
79 /* SMB echo "timeout" -- FIXME: tunable? */
80 #define SMB_ECHO_INTERVAL (60 * HZ)
84 #ifndef XATTR_DOS_ATTRIB
85 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
89 * CIFS vfs client Status information (based on what we know.)
92 /* associated with each tcp and smb session */
102 LANMAN
= 0, /* Legacy LANMAN auth */
103 NTLM
, /* Legacy NTLM012 auth with NTLM hash */
104 NTLMv2
, /* Legacy NTLM auth with NTLMv2 hash */
105 RawNTLMSSP
, /* NTLMSSP without SPNEGO, NTLMv2 hash */
106 /* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
107 Kerberos
, /* Kerberos via SPNEGO */
113 /* Netbios frames protocol not supported at this time */
121 /* crypto security descriptor definition */
123 struct shash_desc shash
;
127 /* crypto hashing related structure/fields, not specific to a sec mech */
128 struct cifs_secmech
{
129 struct crypto_shash
*hmacmd5
; /* hmac-md5 hash function */
130 struct crypto_shash
*md5
; /* md5 hash function */
131 struct sdesc
*sdeschmacmd5
; /* ctxt to generate ntlmv2 hash, CR1 */
132 struct sdesc
*sdescmd5
; /* ctxt to generate cifs/smb signature */
135 /* per smb session structure/fields */
136 struct ntlmssp_auth
{
137 __u32 client_flags
; /* sent by client in type 1 ntlmsssp exchange */
138 __u32 server_flags
; /* sent by server in type 2 ntlmssp exchange */
139 unsigned char ciphertext
[CIFS_CPHTXT_SIZE
]; /* sent to server */
140 char cryptkey
[CIFS_CRYPTO_KEY_SIZE
]; /* used by ntlmssp */
148 struct cifs_sid osid
;
149 struct cifs_sid gsid
;
150 struct cifs_ntace
*ntaces
;
151 struct cifs_ace
*aces
;
155 *****************************************************************
156 * Except the CIFS PDUs themselves all the
157 * globally interesting structs should go here
158 *****************************************************************
167 struct TCP_Server_Info
;
171 struct dfs_info3_param
;
175 struct smb_version_operations
{
176 int (*send_cancel
)(struct TCP_Server_Info
*, void *,
177 struct mid_q_entry
*);
178 bool (*compare_fids
)(struct cifsFileInfo
*, struct cifsFileInfo
*);
179 /* setup request: allocate mid, sign message */
180 int (*setup_request
)(struct cifs_ses
*, struct kvec
*, unsigned int,
181 struct mid_q_entry
**);
182 /* setup async request: allocate mid, sign message */
183 int (*setup_async_request
)(struct TCP_Server_Info
*, struct kvec
*,
184 unsigned int, struct mid_q_entry
**);
185 /* check response: verify signature, map error */
186 int (*check_receive
)(struct mid_q_entry
*, struct TCP_Server_Info
*,
188 void (*add_credits
)(struct TCP_Server_Info
*, const unsigned int,
190 void (*set_credits
)(struct TCP_Server_Info
*, const int);
191 int * (*get_credits_field
)(struct TCP_Server_Info
*, const int);
192 unsigned int (*get_credits
)(struct mid_q_entry
*);
193 __u64 (*get_next_mid
)(struct TCP_Server_Info
*);
194 /* data offset from read response message */
195 unsigned int (*read_data_offset
)(char *);
196 /* data length from read response message */
197 unsigned int (*read_data_length
)(char *);
198 /* map smb to linux error */
199 int (*map_error
)(char *, bool);
200 /* find mid corresponding to the response message */
201 struct mid_q_entry
* (*find_mid
)(struct TCP_Server_Info
*, char *);
202 void (*dump_detail
)(void *);
203 void (*clear_stats
)(struct cifs_tcon
*);
204 void (*print_stats
)(struct seq_file
*m
, struct cifs_tcon
*);
205 /* verify the message */
206 int (*check_message
)(char *, unsigned int);
207 bool (*is_oplock_break
)(char *, struct TCP_Server_Info
*);
208 /* process transaction2 response */
209 bool (*check_trans2
)(struct mid_q_entry
*, struct TCP_Server_Info
*,
211 /* check if we need to negotiate */
212 bool (*need_neg
)(struct TCP_Server_Info
*);
213 /* negotiate to the server */
214 int (*negotiate
)(const unsigned int, struct cifs_ses
*);
215 /* setup smb sessionn */
216 int (*sess_setup
)(const unsigned int, struct cifs_ses
*,
217 const struct nls_table
*);
218 /* close smb session */
219 int (*logoff
)(const unsigned int, struct cifs_ses
*);
220 /* connect to a server share */
221 int (*tree_connect
)(const unsigned int, struct cifs_ses
*, const char *,
222 struct cifs_tcon
*, const struct nls_table
*);
223 /* close tree connecion */
224 int (*tree_disconnect
)(const unsigned int, struct cifs_tcon
*);
225 /* get DFS referrals */
226 int (*get_dfs_refer
)(const unsigned int, struct cifs_ses
*,
227 const char *, struct dfs_info3_param
**,
228 unsigned int *, const struct nls_table
*, int);
229 /* informational QFS call */
230 void (*qfs_tcon
)(const unsigned int, struct cifs_tcon
*);
231 /* check if a path is accessible or not */
232 int (*is_path_accessible
)(const unsigned int, struct cifs_tcon
*,
233 struct cifs_sb_info
*, const char *);
234 /* query path data from the server */
235 int (*query_path_info
)(const unsigned int, struct cifs_tcon
*,
236 struct cifs_sb_info
*, const char *,
237 FILE_ALL_INFO
*, bool *);
238 /* get server index number */
239 int (*get_srv_inum
)(const unsigned int, struct cifs_tcon
*,
240 struct cifs_sb_info
*, const char *,
241 u64
*uniqueid
, FILE_ALL_INFO
*);
242 /* build a full path to the root of the mount */
243 char * (*build_path_to_root
)(struct smb_vol
*, struct cifs_sb_info
*,
245 /* check if we can send an echo or nor */
246 bool (*can_echo
)(struct TCP_Server_Info
*);
247 /* send echo request */
248 int (*echo
)(struct TCP_Server_Info
*);
251 struct smb_version_values
{
252 char *version_string
;
253 __u32 large_lock_type
;
254 __u32 exclusive_lock_type
;
255 __u32 shared_lock_type
;
256 __u32 unlock_lock_type
;
258 size_t max_header_size
;
259 size_t read_rsp_size
;
261 unsigned int cap_unix
;
262 unsigned int cap_nt_find
;
263 unsigned int cap_large_files
;
266 #define HEADER_SIZE(server) (server->vals->header_size)
267 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
275 char *iocharset
; /* local code page for mapping to and from Unicode */
276 char source_rfc1001_name
[RFC1001_NAME_LEN_WITH_NULL
]; /* clnt nb name */
277 char target_rfc1001_name
[RFC1001_NAME_LEN_WITH_NULL
]; /* srvr nb name */
293 bool no_psx_acl
:1; /* set if posix acl support should be disabled */
295 bool backupuid_specified
; /* mount option backupuid is specified */
296 bool backupgid_specified
; /* mount option backupgid is specified */
297 bool no_xattr
:1; /* set if xattr (EA) support should be disabled*/
298 bool server_ino
:1; /* use inode numbers from server ie UniqueId */
300 bool strict_io
:1; /* strict cache behavior */
301 bool remap
:1; /* set to remap seven reserved chars in filenames */
302 bool posix_paths
:1; /* unset to not ask for posix pathnames. */
305 bool nullauth
:1; /* attempt to authenticate with null user */
306 bool nocase
:1; /* request case insensitive filenames */
307 bool nobrl
:1; /* disable sending byte range locks to srv */
308 bool mand_lock
:1; /* send mandatory not posix byte range lock reqs */
309 bool seal
:1; /* request transport encryption on share */
310 bool nodfs
:1; /* Do not request DFS, even if available */
311 bool local_lease
:1; /* check leases only on local system, not remote */
314 bool nostrictsync
:1; /* do not force expensive SMBflush on every sync */
315 bool fsc
:1; /* enable fscache */
316 bool mfsymlinks
:1; /* use Minshall+French Symlinks */
318 bool rwpidforward
:1; /* pid forward for read/write operations */
321 bool sockopt_tcp_nodelay
:1;
322 unsigned short int port
;
323 unsigned long actimeo
; /* attribute cache timeout (jiffies) */
324 struct smb_version_operations
*ops
;
325 struct smb_version_values
*vals
;
327 struct sockaddr_storage srcaddr
; /* allow binding to a local IP */
328 struct nls_table
*local_nls
;
331 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
332 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
333 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
334 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
335 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
336 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
337 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
338 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
339 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
340 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
342 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
343 MS_NODEV | MS_SYNCHRONOUS)
345 struct cifs_mnt_data
{
346 struct cifs_sb_info
*cifs_sb
;
351 static inline unsigned int
352 get_rfc1002_length(void *buf
)
354 return be32_to_cpu(*((__be32
*)buf
));
358 inc_rfc1001_len(void *buf
, int count
)
360 be32_add_cpu((__be32
*)buf
, count
);
363 struct TCP_Server_Info
{
364 struct list_head tcp_ses_list
;
365 struct list_head smb_ses_list
;
366 int srv_count
; /* reference counter */
367 /* 15 character server name + 0x20 16th byte indicating type = srv */
368 char server_RFC1001_name
[RFC1001_NAME_LEN_WITH_NULL
];
369 struct smb_version_operations
*ops
;
370 struct smb_version_values
*vals
;
371 enum statusEnum tcpStatus
; /* what we think the status is */
372 char *hostname
; /* hostname portion of UNC string */
373 struct socket
*ssocket
;
374 struct sockaddr_storage dstaddr
;
375 struct sockaddr_storage srcaddr
; /* locally bind to this IP */
379 wait_queue_head_t response_q
;
380 wait_queue_head_t request_q
; /* if more than maxmpx to srvr must block*/
381 struct list_head pending_mid_q
;
382 bool noblocksnd
; /* use blocking sendmsg */
383 bool noautotune
; /* do not autotune send buf sizes */
385 int credits
; /* send no more requests at once */
386 unsigned int in_flight
; /* number of requests on the wire to server */
387 spinlock_t req_lock
; /* protect the two values above */
388 struct mutex srv_mutex
;
389 struct task_struct
*tsk
;
390 char server_GUID
[16];
392 bool session_estab
; /* mark when very first sess is established */
393 #ifdef CONFIG_CIFS_SMB2
394 int echo_credits
; /* echo reserved slots */
395 int oplock_credits
; /* oplock break reserved slots */
396 bool echoes
:1; /* enable echoes */
398 u16 dialect
; /* dialect index that server chose */
399 enum securityEnum secType
;
400 bool oplocks
:1; /* enable oplocks */
401 unsigned int maxReq
; /* Clients should submit no more */
402 /* than maxReq distinct unanswered SMBs to the server when using */
403 /* multiplexed reads or writes */
404 unsigned int maxBuf
; /* maxBuf specifies the maximum */
405 /* message size the server can send or receive for non-raw SMBs */
406 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
407 /* when socket is setup (and during reconnect) before NegProt sent */
408 unsigned int max_rw
; /* maxRw specifies the maximum */
409 /* message size the server can send or receive for */
410 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
411 unsigned int max_vcs
; /* maximum number of smb sessions, at least
412 those that can be specified uniquely with
414 unsigned int capabilities
; /* selective disabling of caps by smb sess */
415 int timeAdj
; /* Adjust for difference in server time zone in sec */
416 __u64 CurrentMid
; /* multiplex id - rotating counter */
417 char cryptkey
[CIFS_CRYPTO_KEY_SIZE
]; /* used by ntlm, ntlmv2 etc */
418 /* 16th byte of RFC1001 workstation name is always null */
419 char workstation_RFC1001_name
[RFC1001_NAME_LEN_WITH_NULL
];
420 __u32 sequence_number
; /* for signing, protected by srv_mutex */
421 struct session_key session_key
;
422 unsigned long lstrp
; /* when we got last response from this server */
423 struct cifs_secmech secmech
; /* crypto sec mech functs, descriptors */
424 /* extended security flavors that server supports */
425 bool sec_ntlmssp
; /* supports NTLMSSP */
426 bool sec_kerberosu2u
; /* supports U2U Kerberos */
427 bool sec_kerberos
; /* supports plain Kerberos */
428 bool sec_mskerberos
; /* supports legacy MS Kerberos */
429 bool large_buf
; /* is current buffer large? */
430 struct delayed_work echo
; /* echo ping workqueue job */
431 struct kvec
*iov
; /* reusable kvec array for receives */
432 unsigned int nr_iov
; /* number of kvecs in array */
433 char *smallbuf
; /* pointer to current "small" buffer */
434 char *bigbuf
; /* pointer to current "big" buffer */
435 unsigned int total_read
; /* total amount of data read in this pass */
436 #ifdef CONFIG_CIFS_FSCACHE
437 struct fscache_cookie
*fscache
; /* client index cache cookie */
439 #ifdef CONFIG_CIFS_STATS2
440 atomic_t in_send
; /* requests trying to send */
441 atomic_t num_waiters
; /* blocked waiting to get in sendrecv */
443 #ifdef CONFIG_CIFS_SMB2
444 unsigned int max_read
;
445 unsigned int max_write
;
446 #endif /* CONFIG_CIFS_SMB2 */
449 static inline unsigned int
450 in_flight(struct TCP_Server_Info
*server
)
453 spin_lock(&server
->req_lock
);
454 num
= server
->in_flight
;
455 spin_unlock(&server
->req_lock
);
460 has_credits(struct TCP_Server_Info
*server
, int *credits
)
463 spin_lock(&server
->req_lock
);
465 spin_unlock(&server
->req_lock
);
470 add_credits(struct TCP_Server_Info
*server
, const unsigned int add
,
473 server
->ops
->add_credits(server
, add
, optype
);
477 set_credits(struct TCP_Server_Info
*server
, const int val
)
479 server
->ops
->set_credits(server
, val
);
483 get_next_mid(struct TCP_Server_Info
*server
)
485 return server
->ops
->get_next_mid(server
);
489 * Macros to allow the TCP_Server_Info->net field and related code to drop out
490 * when CONFIG_NET_NS isn't set.
495 static inline struct net
*cifs_net_ns(struct TCP_Server_Info
*srv
)
500 static inline void cifs_set_net_ns(struct TCP_Server_Info
*srv
, struct net
*net
)
507 static inline struct net
*cifs_net_ns(struct TCP_Server_Info
*srv
)
512 static inline void cifs_set_net_ns(struct TCP_Server_Info
*srv
, struct net
*net
)
519 * Session structure. One of these for each uid session with a particular host
522 struct list_head smb_ses_list
;
523 struct list_head tcon_list
;
524 struct mutex session_mutex
;
525 struct TCP_Server_Info
*server
; /* pointer to server info */
526 int ses_count
; /* reference counter */
527 enum statusEnum status
;
528 unsigned overrideSecFlg
; /* if non-zero override global sec flags */
529 __u16 ipc_tid
; /* special tid for connection to IPC share */
532 char *serverOS
; /* name of operating system underlying server */
533 char *serverNOS
; /* name of network operating system of server */
534 char *serverDomain
; /* security realm of server */
535 __u64 Suid
; /* remote smb uid */
536 uid_t linux_uid
; /* overriding owner of files on the mount */
537 uid_t cred_uid
; /* owner of credentials */
538 unsigned int capabilities
;
539 char serverName
[SERVER_NAME_LEN_WITH_NULL
* 2]; /* BB make bigger for
540 TCP names - will ipv6 and sctp addresses fit? */
541 char *user_name
; /* must not be null except during init of sess
542 and after mount option parsing we fill it */
545 struct session_key auth_key
;
546 struct ntlmssp_auth
*ntlmssp
; /* ciphertext, flags, server challenge */
547 bool need_reconnect
:1; /* connection reset, uid now invalid */
548 #ifdef CONFIG_CIFS_SMB2
550 #endif /* CONFIG_CIFS_SMB2 */
552 /* no more than one of the following three session flags may be set */
553 #define CIFS_SES_NT4 1
554 #define CIFS_SES_OS2 2
555 #define CIFS_SES_W9X 4
556 /* following flag is set for old servers such as OS2 (and Win95?)
557 which do not negotiate NTLM or POSIX dialects, but instead
558 negotiate one of the older LANMAN dialects */
559 #define CIFS_SES_LANMAN 8
562 cap_unix(struct cifs_ses
*ses
)
564 return ses
->server
->vals
->cap_unix
& ses
->capabilities
;
568 * there is one of these for each connection to a resource on a particular
572 struct list_head tcon_list
;
574 struct list_head openFileList
;
575 struct cifs_ses
*ses
; /* pointer to session associated with */
576 char treeName
[MAX_TREE_SIZE
+ 1]; /* UNC name of resource in ASCII */
577 char *nativeFileSystem
;
578 char *password
; /* for share-level security */
579 __u32 tid
; /* The 4 byte tree id */
580 __u16 Flags
; /* optional support bits */
581 enum statusEnum tidStatus
;
582 #ifdef CONFIG_CIFS_STATS
583 atomic_t num_smbs_sent
;
588 atomic_t num_flushes
;
589 atomic_t num_oplock_brks
;
592 atomic_t num_deletes
;
594 atomic_t num_posixopens
;
595 atomic_t num_posixmkdirs
;
597 atomic_t num_renames
;
598 atomic_t num_t2renames
;
602 atomic_t num_hardlinks
;
603 atomic_t num_symlinks
;
605 atomic_t num_acl_get
;
606 atomic_t num_acl_set
;
608 #ifdef CONFIG_CIFS_SMB2
610 atomic_t smb2_com_sent
[NUMBER_OF_SMB2_COMMANDS
];
611 atomic_t smb2_com_failed
[NUMBER_OF_SMB2_COMMANDS
];
613 #endif /* CONFIG_CIFS_SMB2 */
615 #ifdef CONFIG_CIFS_STATS2
616 unsigned long long time_writes
;
617 unsigned long long time_reads
;
618 unsigned long long time_opens
;
619 unsigned long long time_deletes
;
620 unsigned long long time_closes
;
621 unsigned long long time_mkdirs
;
622 unsigned long long time_rmdirs
;
623 unsigned long long time_renames
;
624 unsigned long long time_t2renames
;
625 unsigned long long time_ffirst
;
626 unsigned long long time_fnext
;
627 unsigned long long time_fclose
;
628 #endif /* CONFIG_CIFS_STATS2 */
631 spinlock_t stat_lock
;
632 #endif /* CONFIG_CIFS_STATS */
633 FILE_SYSTEM_DEVICE_INFO fsDevInfo
;
634 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo
; /* ok if fs name truncated */
635 FILE_SYSTEM_UNIX_INFO fsUnixInfo
;
636 bool ipc
:1; /* set if connection to IPC$ eg for RPC/PIPES */
639 bool seal
:1; /* transport encryption for this mounted share */
640 bool unix_ext
:1; /* if false disable Linux extensions to CIFS protocol
641 for this mount even if server would support */
642 bool local_lease
:1; /* check leases (only) on local system not remote */
643 bool broken_posix_open
; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
644 bool need_reconnect
:1; /* connection reset, tid now invalid */
645 #ifdef CONFIG_CIFS_SMB2
646 bool print
:1; /* set if connection to printer share */
647 bool bad_network_name
:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
650 __u32 maximal_access
;
651 __u32 vol_serial_number
;
652 __le64 vol_create_time
;
653 #endif /* CONFIG_CIFS_SMB2 */
654 #ifdef CONFIG_CIFS_FSCACHE
655 u64 resource_id
; /* server resource id */
656 struct fscache_cookie
*fscache
; /* cookie for share */
658 /* BB add field for back pointer to sb struct(s)? */
662 * This is a refcounted and timestamped container for a tcon pointer. The
663 * container holds a tcon reference. It is considered safe to free one of
664 * these when the tl_count goes to 0. The tl_time is the time of the last
665 * "get" on the container.
668 struct rb_node tl_rbnode
;
670 unsigned long tl_flags
;
671 #define TCON_LINK_MASTER 0
672 #define TCON_LINK_PENDING 1
673 #define TCON_LINK_IN_TREE 2
674 unsigned long tl_time
;
676 struct cifs_tcon
*tl_tcon
;
679 extern struct tcon_link
*cifs_sb_tlink(struct cifs_sb_info
*cifs_sb
);
681 static inline struct cifs_tcon
*
682 tlink_tcon(struct tcon_link
*tlink
)
684 return tlink
->tl_tcon
;
687 extern void cifs_put_tlink(struct tcon_link
*tlink
);
689 static inline struct tcon_link
*
690 cifs_get_tlink(struct tcon_link
*tlink
)
692 if (tlink
&& !IS_ERR(tlink
))
693 atomic_inc(&tlink
->tl_count
);
697 /* This function is always expected to succeed */
698 extern struct cifs_tcon
*cifs_sb_master_tcon(struct cifs_sb_info
*cifs_sb
);
701 * This info hangs off the cifsFileInfo structure, pointed to by llist.
702 * This is used to track byte stream locks on the file
704 struct cifsLockInfo
{
705 struct list_head llist
; /* pointer to next cifsLockInfo */
706 struct list_head blist
; /* pointer to locks blocked on this */
707 wait_queue_head_t block_q
;
715 * One of these for each open instance of a file
717 struct cifs_search_info
{
718 loff_t index_of_last_entry
;
719 __u16 entries_in_buffer
;
722 char *ntwrk_buf_start
;
723 char *srch_entries_start
;
725 const char *presume_name
;
726 unsigned int resume_name_len
;
730 bool smallBuf
:1; /* so we know which buf_release function to call */
733 struct cifsFileInfo
{
734 struct list_head tlist
; /* pointer to next fid owned by tcon */
735 struct list_head flist
; /* next fid (file instance) for this inode */
736 struct list_head llist
; /*
737 * brlocks held by this fid, protected by
738 * lock_mutex from cifsInodeInfo structure
740 unsigned int uid
; /* allows finding which FileInfo structure */
741 __u32 pid
; /* process id who opened file */
742 __u16 netfid
; /* file id from remote */
743 /* BB add lock scope info here if needed */ ;
744 /* lock scope id (0 if none) */
745 struct dentry
*dentry
;
746 unsigned int f_flags
;
747 struct tcon_link
*tlink
;
748 bool invalidHandle
:1; /* file closed via session abend */
749 bool oplock_break_cancelled
:1;
750 int count
; /* refcount protected by cifs_file_list_lock */
751 struct mutex fh_mutex
; /* prevents reopen race after dead ses*/
752 struct cifs_search_info srch_inf
;
753 struct work_struct oplock_break
; /* work for oplock breaks */
756 struct cifs_io_parms
{
761 struct cifs_tcon
*tcon
;
765 * Take a reference on the file private data. Must be called with
766 * cifs_file_list_lock held.
769 cifsFileInfo_get_locked(struct cifsFileInfo
*cifs_file
)
774 struct cifsFileInfo
*cifsFileInfo_get(struct cifsFileInfo
*cifs_file
);
775 void cifsFileInfo_put(struct cifsFileInfo
*cifs_file
);
778 * One of these for each file inode
781 struct cifsInodeInfo
{
782 bool can_cache_brlcks
;
783 struct mutex lock_mutex
; /*
784 * protect the field above and llist
785 * from every cifsFileInfo structure
788 /* BB add in lists for dirty pages i.e. write caching info for oplock */
789 struct list_head openFileList
;
790 __u32 cifsAttrs
; /* e.g. DOS archive bit, sparse, compressed, system */
791 bool clientCanCacheRead
; /* read oplock */
792 bool clientCanCacheAll
; /* read and writebehind oplock */
793 bool delete_pending
; /* DELETE_ON_CLOSE is set */
794 bool invalid_mapping
; /* pagecache is invalid */
795 unsigned long time
; /* jiffies of last update of inode */
796 u64 server_eof
; /* current file size on server -- protected by i_lock */
797 u64 uniqueid
; /* server inode number */
798 u64 createtime
; /* creation time on server */
799 #ifdef CONFIG_CIFS_FSCACHE
800 struct fscache_cookie
*fscache
;
802 struct inode vfs_inode
;
805 static inline struct cifsInodeInfo
*
806 CIFS_I(struct inode
*inode
)
808 return container_of(inode
, struct cifsInodeInfo
, vfs_inode
);
811 static inline struct cifs_sb_info
*
812 CIFS_SB(struct super_block
*sb
)
814 return sb
->s_fs_info
;
817 static inline char CIFS_DIR_SEP(const struct cifs_sb_info
*cifs_sb
)
819 if (cifs_sb
->mnt_cifs_flags
& CIFS_MOUNT_POSIX_PATHS
)
826 convert_delimiter(char *path
, char delim
)
839 for (i
= 0; path
[i
] != '\0'; i
++) {
840 if (path
[i
] == old_delim
)
846 build_path_to_root(struct smb_vol
*vol
, struct cifs_sb_info
*cifs_sb
,
847 struct cifs_tcon
*tcon
)
849 if (!vol
->ops
->build_path_to_root
)
851 return vol
->ops
->build_path_to_root(vol
, cifs_sb
, tcon
);
854 #ifdef CONFIG_CIFS_STATS
855 #define cifs_stats_inc atomic_inc
857 static inline void cifs_stats_bytes_written(struct cifs_tcon
*tcon
,
861 spin_lock(&tcon
->stat_lock
);
862 tcon
->bytes_written
+= bytes
;
863 spin_unlock(&tcon
->stat_lock
);
867 static inline void cifs_stats_bytes_read(struct cifs_tcon
*tcon
,
870 spin_lock(&tcon
->stat_lock
);
871 tcon
->bytes_read
+= bytes
;
872 spin_unlock(&tcon
->stat_lock
);
876 #define cifs_stats_inc(field) do {} while (0)
877 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
878 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
884 * This is the prototype for the mid receive function. This function is for
885 * receiving the rest of the SMB frame, starting with the WordCount (which is
886 * just after the MID in struct smb_hdr). Note:
888 * - This will be called by cifsd, with no locks held.
889 * - The mid will still be on the pending_mid_q.
890 * - mid->resp_buf will point to the current buffer.
892 * Returns zero on a successful receive, or an error. The receive state in
893 * the TCP_Server_Info will also be updated.
895 typedef int (mid_receive_t
)(struct TCP_Server_Info
*server
,
896 struct mid_q_entry
*mid
);
899 * This is the prototype for the mid callback function. This is called once the
900 * mid has been received off of the socket. When creating one, take special
901 * care to avoid deadlocks. Things to bear in mind:
903 * - it will be called by cifsd, with no locks held
904 * - the mid will be removed from any lists
906 typedef void (mid_callback_t
)(struct mid_q_entry
*mid
);
908 /* one of these for every pending CIFS request to the server */
910 struct list_head qhead
; /* mids waiting on reply from this server */
911 struct TCP_Server_Info
*server
; /* server corresponding to this mid */
912 __u64 mid
; /* multiplex id */
913 __u32 pid
; /* process id */
914 __u32 sequence_number
; /* for CIFS signing */
915 unsigned long when_alloc
; /* when mid was created */
916 #ifdef CONFIG_CIFS_STATS2
917 unsigned long when_sent
; /* time when smb send finished */
918 unsigned long when_received
; /* when demux complete (taken off wire) */
920 mid_receive_t
*receive
; /* call receive callback */
921 mid_callback_t
*callback
; /* call completion callback */
922 void *callback_data
; /* general purpose pointer for callback */
923 void *resp_buf
; /* pointer to received SMB header */
924 int mid_state
; /* wish this were enum but can not pass to wait_event */
925 __le16 command
; /* smb command code */
926 bool large_buf
:1; /* if valid response, is pointer to large buf */
927 bool multiRsp
:1; /* multiple trans2 responses for one request */
928 bool multiEnd
:1; /* both received */
931 /* Make code in transport.c a little cleaner by moving
932 update of optional stats into function below */
933 #ifdef CONFIG_CIFS_STATS2
935 static inline void cifs_in_send_inc(struct TCP_Server_Info
*server
)
937 atomic_inc(&server
->in_send
);
940 static inline void cifs_in_send_dec(struct TCP_Server_Info
*server
)
942 atomic_dec(&server
->in_send
);
945 static inline void cifs_num_waiters_inc(struct TCP_Server_Info
*server
)
947 atomic_inc(&server
->num_waiters
);
950 static inline void cifs_num_waiters_dec(struct TCP_Server_Info
*server
)
952 atomic_dec(&server
->num_waiters
);
955 static inline void cifs_save_when_sent(struct mid_q_entry
*mid
)
957 mid
->when_sent
= jiffies
;
960 static inline void cifs_in_send_inc(struct TCP_Server_Info
*server
)
963 static inline void cifs_in_send_dec(struct TCP_Server_Info
*server
)
967 static inline void cifs_num_waiters_inc(struct TCP_Server_Info
*server
)
971 static inline void cifs_num_waiters_dec(struct TCP_Server_Info
*server
)
975 static inline void cifs_save_when_sent(struct mid_q_entry
*mid
)
980 /* for pending dnotify requests */
981 struct dir_notify_req
{
982 struct list_head lhead
;
989 __u32 filter
; /* CompletionFilter (for multishot) */
994 struct dfs_info3_param
{
995 int flags
; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1004 * common struct for holding inode info when searching for or updating an
1005 * inode with new info
1008 #define CIFS_FATTR_DFS_REFERRAL 0x1
1009 #define CIFS_FATTR_DELETE_PENDING 0x2
1010 #define CIFS_FATTR_NEED_REVAL 0x4
1011 #define CIFS_FATTR_INO_COLLISION 0x8
1024 unsigned int cf_nlink
;
1025 unsigned int cf_dtype
;
1026 struct timespec cf_atime
;
1027 struct timespec cf_mtime
;
1028 struct timespec cf_ctime
;
1031 static inline void free_dfs_info_param(struct dfs_info3_param
*param
)
1034 kfree(param
->path_name
);
1035 kfree(param
->node_name
);
1040 static inline void free_dfs_info_array(struct dfs_info3_param
*param
,
1041 int number_of_items
)
1044 if ((number_of_items
== 0) || (param
== NULL
))
1046 for (i
= 0; i
< number_of_items
; i
++) {
1047 kfree(param
[i
].path_name
);
1048 kfree(param
[i
].node_name
);
1054 #define MID_REQUEST_ALLOCATED 1
1055 #define MID_REQUEST_SUBMITTED 2
1056 #define MID_RESPONSE_RECEIVED 4
1057 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1058 #define MID_RESPONSE_MALFORMED 0x10
1059 #define MID_SHUTDOWN 0x20
1061 /* Types of response buffer returned from SendReceive2 */
1062 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1063 #define CIFS_SMALL_BUFFER 1
1064 #define CIFS_LARGE_BUFFER 2
1065 #define CIFS_IOVEC 4 /* array of response buffers */
1067 /* Type of Request to SendReceive2 */
1068 #define CIFS_BLOCKING_OP 1 /* operation can block */
1069 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1070 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1071 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1072 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1073 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1075 /* Type of request operation */
1076 #define CIFS_ECHO_OP 0x080 /* echo request */
1077 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1078 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1079 #define CIFS_OP_MASK 0x0380 /* mask request type */
1081 /* Security Flags: indicate type of session setup needed */
1082 #define CIFSSEC_MAY_SIGN 0x00001
1083 #define CIFSSEC_MAY_NTLM 0x00002
1084 #define CIFSSEC_MAY_NTLMV2 0x00004
1085 #define CIFSSEC_MAY_KRB5 0x00008
1086 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1087 #define CIFSSEC_MAY_LANMAN 0x00010
1088 #define CIFSSEC_MAY_PLNTXT 0x00020
1090 #define CIFSSEC_MAY_LANMAN 0
1091 #define CIFSSEC_MAY_PLNTXT 0
1092 #endif /* weak passwords */
1093 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1094 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1096 #define CIFSSEC_MUST_SIGN 0x01001
1097 /* note that only one of the following can be set so the
1098 result of setting MUST flags more than once will be to
1099 require use of the stronger protocol */
1100 #define CIFSSEC_MUST_NTLM 0x02002
1101 #define CIFSSEC_MUST_NTLMV2 0x04004
1102 #define CIFSSEC_MUST_KRB5 0x08008
1103 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1104 #define CIFSSEC_MUST_LANMAN 0x10010
1105 #define CIFSSEC_MUST_PLNTXT 0x20020
1106 #ifdef CONFIG_CIFS_UPCALL
1107 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1109 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1111 #else /* do not allow weak pw hash */
1112 #define CIFSSEC_MUST_LANMAN 0
1113 #define CIFSSEC_MUST_PLNTXT 0
1114 #ifdef CONFIG_CIFS_UPCALL
1115 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1117 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1119 #endif /* WEAK_PW_HASH */
1120 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1121 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1123 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
1124 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1125 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1127 *****************************************************************
1128 * All constants go here
1129 *****************************************************************
1132 #define UID_HASH (16)
1135 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1136 * following to be declared.
1139 /****************************************************************************
1140 * Locking notes. All updates to global variables and lists should be
1141 * protected by spinlocks or semaphores.
1145 * GlobalMid_Lock protects:
1146 * list operations on pending_mid_q and oplockQ
1147 * updates to XID counters, multiplex id and SMB sequence numbers
1148 * cifs_file_list_lock protects:
1149 * list operations on tcp and SMB session lists and tCon lists
1150 * f_owner.lock protects certain per file struct operations
1151 * mapping->page_lock protects certain per page operations
1155 * sesSem operations on smb session
1156 * tconSem operations on tree connection
1157 * fh_sem file handle reconnection operations
1159 ****************************************************************************/
1161 #ifdef DECLARE_GLOBALS_HERE
1162 #define GLOBAL_EXTERN
1164 #define GLOBAL_EXTERN extern
1168 * the list of TCP_Server_Info structures, ie each of the sockets
1169 * connecting our client to a distinct server (ip address), is
1170 * chained together by cifs_tcp_ses_list. The list of all our SMB
1171 * sessions (and from that the tree connections) can be found
1172 * by iterating over cifs_tcp_ses_list
1174 GLOBAL_EXTERN
struct list_head cifs_tcp_ses_list
;
1177 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1178 * tcp session, and the list of tcon's per smb session. It also protects
1179 * the reference counters for the server, smb session, and tcon. Finally,
1180 * changes to the tcon->tidStatus should be done while holding this lock.
1182 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock
;
1185 * This lock protects the cifs_file->llist and cifs_file->flist
1186 * list operations, and updates to some flags (cifs_file->invalidHandle)
1187 * It will be moved to either use the tcon->stat_lock or equivalent later.
1188 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1189 * the cifs_tcp_ses_lock must be grabbed first and released last.
1191 GLOBAL_EXTERN spinlock_t cifs_file_list_lock
;
1193 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1194 /* Outstanding dir notify requests */
1195 GLOBAL_EXTERN
struct list_head GlobalDnotifyReqList
;
1196 /* DirNotify response queue */
1197 GLOBAL_EXTERN
struct list_head GlobalDnotifyRsp_Q
;
1198 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1201 * Global transaction id (XID) information
1203 GLOBAL_EXTERN
unsigned int GlobalCurrentXid
; /* protected by GlobalMid_Sem */
1204 GLOBAL_EXTERN
unsigned int GlobalTotalActiveXid
; /* prot by GlobalMid_Sem */
1205 GLOBAL_EXTERN
unsigned int GlobalMaxActiveXid
; /* prot by GlobalMid_Sem */
1206 GLOBAL_EXTERN spinlock_t GlobalMid_Lock
; /* protects above & list operations */
1207 /* on midQ entries */
1209 * Global counters, updated atomically
1211 GLOBAL_EXTERN atomic_t sesInfoAllocCount
;
1212 GLOBAL_EXTERN atomic_t tconInfoAllocCount
;
1213 GLOBAL_EXTERN atomic_t tcpSesAllocCount
;
1214 GLOBAL_EXTERN atomic_t tcpSesReconnectCount
;
1215 GLOBAL_EXTERN atomic_t tconInfoReconnectCount
;
1217 /* Various Debug counters */
1218 GLOBAL_EXTERN atomic_t bufAllocCount
; /* current number allocated */
1219 #ifdef CONFIG_CIFS_STATS2
1220 GLOBAL_EXTERN atomic_t totBufAllocCount
; /* total allocated over all time */
1221 GLOBAL_EXTERN atomic_t totSmBufAllocCount
;
1223 GLOBAL_EXTERN atomic_t smBufAllocCount
;
1224 GLOBAL_EXTERN atomic_t midCount
;
1227 GLOBAL_EXTERN
bool enable_oplocks
; /* enable or disable oplocks */
1228 GLOBAL_EXTERN
unsigned int lookupCacheEnabled
;
1229 GLOBAL_EXTERN
unsigned int global_secflags
; /* if on, session setup sent
1230 with more secure ntlmssp2 challenge/resp */
1231 GLOBAL_EXTERN
unsigned int sign_CIFS_PDUs
; /* enable smb packet signing */
1232 GLOBAL_EXTERN
unsigned int linuxExtEnabled
;/*enable Linux/Unix CIFS extensions*/
1233 GLOBAL_EXTERN
unsigned int CIFSMaxBufSize
; /* max size not including hdr */
1234 GLOBAL_EXTERN
unsigned int cifs_min_rcv
; /* min size of big ntwrk buf pool */
1235 GLOBAL_EXTERN
unsigned int cifs_min_small
; /* min size of small buf pool */
1236 GLOBAL_EXTERN
unsigned int cifs_max_pending
; /* MAX requests at once to server*/
1238 #ifdef CONFIG_CIFS_ACL
1239 GLOBAL_EXTERN
struct rb_root uidtree
;
1240 GLOBAL_EXTERN
struct rb_root gidtree
;
1241 GLOBAL_EXTERN spinlock_t siduidlock
;
1242 GLOBAL_EXTERN spinlock_t sidgidlock
;
1243 GLOBAL_EXTERN
struct rb_root siduidtree
;
1244 GLOBAL_EXTERN
struct rb_root sidgidtree
;
1245 GLOBAL_EXTERN spinlock_t uidsidlock
;
1246 GLOBAL_EXTERN spinlock_t gidsidlock
;
1247 #endif /* CONFIG_CIFS_ACL */
1249 void cifs_oplock_break(struct work_struct
*work
);
1251 extern const struct slow_work_ops cifs_oplock_break_ops
;
1252 extern struct workqueue_struct
*cifsiod_wq
;
1254 extern mempool_t
*cifs_mid_poolp
;
1256 /* Operations for different SMB versions */
1257 #define SMB1_VERSION_STRING "1.0"
1258 extern struct smb_version_operations smb1_operations
;
1259 extern struct smb_version_values smb1_values
;
1260 #define SMB21_VERSION_STRING "2.1"
1261 extern struct smb_version_operations smb21_operations
;
1262 extern struct smb_version_values smb21_values
;
1263 #endif /* _CIFS_GLOB_H */