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 /* query file data from the server */
240 int (*query_file_info
)(const unsigned int, struct cifs_tcon
*,
241 struct cifs_fid
*, FILE_ALL_INFO
*);
242 /* get server index number */
243 int (*get_srv_inum
)(const unsigned int, struct cifs_tcon
*,
244 struct cifs_sb_info
*, const char *,
245 u64
*uniqueid
, FILE_ALL_INFO
*);
246 /* build a full path to the root of the mount */
247 char * (*build_path_to_root
)(struct smb_vol
*, struct cifs_sb_info
*,
249 /* check if we can send an echo or nor */
250 bool (*can_echo
)(struct TCP_Server_Info
*);
251 /* send echo request */
252 int (*echo
)(struct TCP_Server_Info
*);
253 /* create directory */
254 int (*mkdir
)(const unsigned int, struct cifs_tcon
*, const char *,
255 struct cifs_sb_info
*);
256 /* set info on created directory */
257 void (*mkdir_setinfo
)(struct inode
*, const char *,
258 struct cifs_sb_info
*, struct cifs_tcon
*,
260 /* remove directory */
261 int (*rmdir
)(const unsigned int, struct cifs_tcon
*, const char *,
262 struct cifs_sb_info
*);
264 int (*unlink
)(const unsigned int, struct cifs_tcon
*, const char *,
265 struct cifs_sb_info
*);
266 /* open, rename and delete file */
267 int (*rename_pending_delete
)(const char *, struct dentry
*,
269 /* open a file for non-posix mounts */
270 int (*open
)(const unsigned int, struct cifs_tcon
*, const char *, int,
271 int, int, struct cifs_fid
*, __u32
*, FILE_ALL_INFO
*,
272 struct cifs_sb_info
*);
273 /* set fid protocol-specific info */
274 void (*set_fid
)(struct cifsFileInfo
*, struct cifs_fid
*, __u32
);
276 int (*close
)(const unsigned int, struct cifs_tcon
*, struct cifs_fid
*);
279 struct smb_version_values
{
280 char *version_string
;
281 __u32 large_lock_type
;
282 __u32 exclusive_lock_type
;
283 __u32 shared_lock_type
;
284 __u32 unlock_lock_type
;
286 size_t max_header_size
;
287 size_t read_rsp_size
;
289 unsigned int cap_unix
;
290 unsigned int cap_nt_find
;
291 unsigned int cap_large_files
;
294 #define HEADER_SIZE(server) (server->vals->header_size)
295 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
303 char *iocharset
; /* local code page for mapping to and from Unicode */
304 char source_rfc1001_name
[RFC1001_NAME_LEN_WITH_NULL
]; /* clnt nb name */
305 char target_rfc1001_name
[RFC1001_NAME_LEN_WITH_NULL
]; /* srvr nb name */
321 bool no_psx_acl
:1; /* set if posix acl support should be disabled */
323 bool backupuid_specified
; /* mount option backupuid is specified */
324 bool backupgid_specified
; /* mount option backupgid is specified */
325 bool no_xattr
:1; /* set if xattr (EA) support should be disabled*/
326 bool server_ino
:1; /* use inode numbers from server ie UniqueId */
328 bool strict_io
:1; /* strict cache behavior */
329 bool remap
:1; /* set to remap seven reserved chars in filenames */
330 bool posix_paths
:1; /* unset to not ask for posix pathnames. */
333 bool nullauth
:1; /* attempt to authenticate with null user */
334 bool nocase
:1; /* request case insensitive filenames */
335 bool nobrl
:1; /* disable sending byte range locks to srv */
336 bool mand_lock
:1; /* send mandatory not posix byte range lock reqs */
337 bool seal
:1; /* request transport encryption on share */
338 bool nodfs
:1; /* Do not request DFS, even if available */
339 bool local_lease
:1; /* check leases only on local system, not remote */
342 bool nostrictsync
:1; /* do not force expensive SMBflush on every sync */
343 bool fsc
:1; /* enable fscache */
344 bool mfsymlinks
:1; /* use Minshall+French Symlinks */
346 bool rwpidforward
:1; /* pid forward for read/write operations */
349 bool sockopt_tcp_nodelay
:1;
350 unsigned short int port
;
351 unsigned long actimeo
; /* attribute cache timeout (jiffies) */
352 struct smb_version_operations
*ops
;
353 struct smb_version_values
*vals
;
355 struct sockaddr_storage srcaddr
; /* allow binding to a local IP */
356 struct nls_table
*local_nls
;
359 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
360 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
361 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
362 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
363 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
364 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
365 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
366 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
367 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
368 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
370 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
371 MS_NODEV | MS_SYNCHRONOUS)
373 struct cifs_mnt_data
{
374 struct cifs_sb_info
*cifs_sb
;
379 static inline unsigned int
380 get_rfc1002_length(void *buf
)
382 return be32_to_cpu(*((__be32
*)buf
));
386 inc_rfc1001_len(void *buf
, int count
)
388 be32_add_cpu((__be32
*)buf
, count
);
391 struct TCP_Server_Info
{
392 struct list_head tcp_ses_list
;
393 struct list_head smb_ses_list
;
394 int srv_count
; /* reference counter */
395 /* 15 character server name + 0x20 16th byte indicating type = srv */
396 char server_RFC1001_name
[RFC1001_NAME_LEN_WITH_NULL
];
397 struct smb_version_operations
*ops
;
398 struct smb_version_values
*vals
;
399 enum statusEnum tcpStatus
; /* what we think the status is */
400 char *hostname
; /* hostname portion of UNC string */
401 struct socket
*ssocket
;
402 struct sockaddr_storage dstaddr
;
403 struct sockaddr_storage srcaddr
; /* locally bind to this IP */
407 wait_queue_head_t response_q
;
408 wait_queue_head_t request_q
; /* if more than maxmpx to srvr must block*/
409 struct list_head pending_mid_q
;
410 bool noblocksnd
; /* use blocking sendmsg */
411 bool noautotune
; /* do not autotune send buf sizes */
413 int credits
; /* send no more requests at once */
414 unsigned int in_flight
; /* number of requests on the wire to server */
415 spinlock_t req_lock
; /* protect the two values above */
416 struct mutex srv_mutex
;
417 struct task_struct
*tsk
;
418 char server_GUID
[16];
420 bool session_estab
; /* mark when very first sess is established */
421 #ifdef CONFIG_CIFS_SMB2
422 int echo_credits
; /* echo reserved slots */
423 int oplock_credits
; /* oplock break reserved slots */
424 bool echoes
:1; /* enable echoes */
426 u16 dialect
; /* dialect index that server chose */
427 enum securityEnum secType
;
428 bool oplocks
:1; /* enable oplocks */
429 unsigned int maxReq
; /* Clients should submit no more */
430 /* than maxReq distinct unanswered SMBs to the server when using */
431 /* multiplexed reads or writes */
432 unsigned int maxBuf
; /* maxBuf specifies the maximum */
433 /* message size the server can send or receive for non-raw SMBs */
434 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
435 /* when socket is setup (and during reconnect) before NegProt sent */
436 unsigned int max_rw
; /* maxRw specifies the maximum */
437 /* message size the server can send or receive for */
438 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
439 unsigned int max_vcs
; /* maximum number of smb sessions, at least
440 those that can be specified uniquely with
442 unsigned int capabilities
; /* selective disabling of caps by smb sess */
443 int timeAdj
; /* Adjust for difference in server time zone in sec */
444 __u64 CurrentMid
; /* multiplex id - rotating counter */
445 char cryptkey
[CIFS_CRYPTO_KEY_SIZE
]; /* used by ntlm, ntlmv2 etc */
446 /* 16th byte of RFC1001 workstation name is always null */
447 char workstation_RFC1001_name
[RFC1001_NAME_LEN_WITH_NULL
];
448 __u32 sequence_number
; /* for signing, protected by srv_mutex */
449 struct session_key session_key
;
450 unsigned long lstrp
; /* when we got last response from this server */
451 struct cifs_secmech secmech
; /* crypto sec mech functs, descriptors */
452 /* extended security flavors that server supports */
453 bool sec_ntlmssp
; /* supports NTLMSSP */
454 bool sec_kerberosu2u
; /* supports U2U Kerberos */
455 bool sec_kerberos
; /* supports plain Kerberos */
456 bool sec_mskerberos
; /* supports legacy MS Kerberos */
457 bool large_buf
; /* is current buffer large? */
458 struct delayed_work echo
; /* echo ping workqueue job */
459 struct kvec
*iov
; /* reusable kvec array for receives */
460 unsigned int nr_iov
; /* number of kvecs in array */
461 char *smallbuf
; /* pointer to current "small" buffer */
462 char *bigbuf
; /* pointer to current "big" buffer */
463 unsigned int total_read
; /* total amount of data read in this pass */
464 #ifdef CONFIG_CIFS_FSCACHE
465 struct fscache_cookie
*fscache
; /* client index cache cookie */
467 #ifdef CONFIG_CIFS_STATS2
468 atomic_t in_send
; /* requests trying to send */
469 atomic_t num_waiters
; /* blocked waiting to get in sendrecv */
471 #ifdef CONFIG_CIFS_SMB2
472 unsigned int max_read
;
473 unsigned int max_write
;
474 #endif /* CONFIG_CIFS_SMB2 */
477 static inline unsigned int
478 in_flight(struct TCP_Server_Info
*server
)
481 spin_lock(&server
->req_lock
);
482 num
= server
->in_flight
;
483 spin_unlock(&server
->req_lock
);
488 has_credits(struct TCP_Server_Info
*server
, int *credits
)
491 spin_lock(&server
->req_lock
);
493 spin_unlock(&server
->req_lock
);
498 add_credits(struct TCP_Server_Info
*server
, const unsigned int add
,
501 server
->ops
->add_credits(server
, add
, optype
);
505 set_credits(struct TCP_Server_Info
*server
, const int val
)
507 server
->ops
->set_credits(server
, val
);
511 get_next_mid(struct TCP_Server_Info
*server
)
513 return server
->ops
->get_next_mid(server
);
517 * Macros to allow the TCP_Server_Info->net field and related code to drop out
518 * when CONFIG_NET_NS isn't set.
523 static inline struct net
*cifs_net_ns(struct TCP_Server_Info
*srv
)
528 static inline void cifs_set_net_ns(struct TCP_Server_Info
*srv
, struct net
*net
)
535 static inline struct net
*cifs_net_ns(struct TCP_Server_Info
*srv
)
540 static inline void cifs_set_net_ns(struct TCP_Server_Info
*srv
, struct net
*net
)
547 * Session structure. One of these for each uid session with a particular host
550 struct list_head smb_ses_list
;
551 struct list_head tcon_list
;
552 struct mutex session_mutex
;
553 struct TCP_Server_Info
*server
; /* pointer to server info */
554 int ses_count
; /* reference counter */
555 enum statusEnum status
;
556 unsigned overrideSecFlg
; /* if non-zero override global sec flags */
557 __u16 ipc_tid
; /* special tid for connection to IPC share */
560 char *serverOS
; /* name of operating system underlying server */
561 char *serverNOS
; /* name of network operating system of server */
562 char *serverDomain
; /* security realm of server */
563 __u64 Suid
; /* remote smb uid */
564 uid_t linux_uid
; /* overriding owner of files on the mount */
565 uid_t cred_uid
; /* owner of credentials */
566 unsigned int capabilities
;
567 char serverName
[SERVER_NAME_LEN_WITH_NULL
* 2]; /* BB make bigger for
568 TCP names - will ipv6 and sctp addresses fit? */
569 char *user_name
; /* must not be null except during init of sess
570 and after mount option parsing we fill it */
573 struct session_key auth_key
;
574 struct ntlmssp_auth
*ntlmssp
; /* ciphertext, flags, server challenge */
575 bool need_reconnect
:1; /* connection reset, uid now invalid */
576 #ifdef CONFIG_CIFS_SMB2
578 #endif /* CONFIG_CIFS_SMB2 */
580 /* no more than one of the following three session flags may be set */
581 #define CIFS_SES_NT4 1
582 #define CIFS_SES_OS2 2
583 #define CIFS_SES_W9X 4
584 /* following flag is set for old servers such as OS2 (and Win95?)
585 which do not negotiate NTLM or POSIX dialects, but instead
586 negotiate one of the older LANMAN dialects */
587 #define CIFS_SES_LANMAN 8
590 cap_unix(struct cifs_ses
*ses
)
592 return ses
->server
->vals
->cap_unix
& ses
->capabilities
;
596 * there is one of these for each connection to a resource on a particular
600 struct list_head tcon_list
;
602 struct list_head openFileList
;
603 struct cifs_ses
*ses
; /* pointer to session associated with */
604 char treeName
[MAX_TREE_SIZE
+ 1]; /* UNC name of resource in ASCII */
605 char *nativeFileSystem
;
606 char *password
; /* for share-level security */
607 __u32 tid
; /* The 4 byte tree id */
608 __u16 Flags
; /* optional support bits */
609 enum statusEnum tidStatus
;
610 #ifdef CONFIG_CIFS_STATS
611 atomic_t num_smbs_sent
;
616 atomic_t num_flushes
;
617 atomic_t num_oplock_brks
;
620 atomic_t num_deletes
;
622 atomic_t num_posixopens
;
623 atomic_t num_posixmkdirs
;
625 atomic_t num_renames
;
626 atomic_t num_t2renames
;
630 atomic_t num_hardlinks
;
631 atomic_t num_symlinks
;
633 atomic_t num_acl_get
;
634 atomic_t num_acl_set
;
636 #ifdef CONFIG_CIFS_SMB2
638 atomic_t smb2_com_sent
[NUMBER_OF_SMB2_COMMANDS
];
639 atomic_t smb2_com_failed
[NUMBER_OF_SMB2_COMMANDS
];
641 #endif /* CONFIG_CIFS_SMB2 */
643 #ifdef CONFIG_CIFS_STATS2
644 unsigned long long time_writes
;
645 unsigned long long time_reads
;
646 unsigned long long time_opens
;
647 unsigned long long time_deletes
;
648 unsigned long long time_closes
;
649 unsigned long long time_mkdirs
;
650 unsigned long long time_rmdirs
;
651 unsigned long long time_renames
;
652 unsigned long long time_t2renames
;
653 unsigned long long time_ffirst
;
654 unsigned long long time_fnext
;
655 unsigned long long time_fclose
;
656 #endif /* CONFIG_CIFS_STATS2 */
659 spinlock_t stat_lock
;
660 #endif /* CONFIG_CIFS_STATS */
661 FILE_SYSTEM_DEVICE_INFO fsDevInfo
;
662 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo
; /* ok if fs name truncated */
663 FILE_SYSTEM_UNIX_INFO fsUnixInfo
;
664 bool ipc
:1; /* set if connection to IPC$ eg for RPC/PIPES */
667 bool seal
:1; /* transport encryption for this mounted share */
668 bool unix_ext
:1; /* if false disable Linux extensions to CIFS protocol
669 for this mount even if server would support */
670 bool local_lease
:1; /* check leases (only) on local system not remote */
671 bool broken_posix_open
; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
672 bool need_reconnect
:1; /* connection reset, tid now invalid */
673 #ifdef CONFIG_CIFS_SMB2
674 bool print
:1; /* set if connection to printer share */
675 bool bad_network_name
:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
678 __u32 maximal_access
;
679 __u32 vol_serial_number
;
680 __le64 vol_create_time
;
681 #endif /* CONFIG_CIFS_SMB2 */
682 #ifdef CONFIG_CIFS_FSCACHE
683 u64 resource_id
; /* server resource id */
684 struct fscache_cookie
*fscache
; /* cookie for share */
686 /* BB add field for back pointer to sb struct(s)? */
690 * This is a refcounted and timestamped container for a tcon pointer. The
691 * container holds a tcon reference. It is considered safe to free one of
692 * these when the tl_count goes to 0. The tl_time is the time of the last
693 * "get" on the container.
696 struct rb_node tl_rbnode
;
698 unsigned long tl_flags
;
699 #define TCON_LINK_MASTER 0
700 #define TCON_LINK_PENDING 1
701 #define TCON_LINK_IN_TREE 2
702 unsigned long tl_time
;
704 struct cifs_tcon
*tl_tcon
;
707 extern struct tcon_link
*cifs_sb_tlink(struct cifs_sb_info
*cifs_sb
);
709 static inline struct cifs_tcon
*
710 tlink_tcon(struct tcon_link
*tlink
)
712 return tlink
->tl_tcon
;
715 extern void cifs_put_tlink(struct tcon_link
*tlink
);
717 static inline struct tcon_link
*
718 cifs_get_tlink(struct tcon_link
*tlink
)
720 if (tlink
&& !IS_ERR(tlink
))
721 atomic_inc(&tlink
->tl_count
);
725 /* This function is always expected to succeed */
726 extern struct cifs_tcon
*cifs_sb_master_tcon(struct cifs_sb_info
*cifs_sb
);
729 * This info hangs off the cifsFileInfo structure, pointed to by llist.
730 * This is used to track byte stream locks on the file
732 struct cifsLockInfo
{
733 struct list_head llist
; /* pointer to next cifsLockInfo */
734 struct list_head blist
; /* pointer to locks blocked on this */
735 wait_queue_head_t block_q
;
743 * One of these for each open instance of a file
745 struct cifs_search_info
{
746 loff_t index_of_last_entry
;
747 __u16 entries_in_buffer
;
750 char *ntwrk_buf_start
;
751 char *srch_entries_start
;
753 const char *presume_name
;
754 unsigned int resume_name_len
;
758 bool smallBuf
:1; /* so we know which buf_release function to call */
763 #ifdef CONFIG_CIFS_SMB2
764 __u64 persistent_fid
; /* persist file id for smb2 */
765 __u64 volatile_fid
; /* volatile file id for smb2 */
769 struct cifsFileInfo
{
770 struct list_head tlist
; /* pointer to next fid owned by tcon */
771 struct list_head flist
; /* next fid (file instance) for this inode */
772 struct list_head llist
; /*
773 * brlocks held by this fid, protected by
774 * lock_mutex from cifsInodeInfo structure
776 unsigned int uid
; /* allows finding which FileInfo structure */
777 __u32 pid
; /* process id who opened file */
778 struct cifs_fid fid
; /* file id from remote */
779 /* BB add lock scope info here if needed */ ;
780 /* lock scope id (0 if none) */
781 struct dentry
*dentry
;
782 unsigned int f_flags
;
783 struct tcon_link
*tlink
;
784 bool invalidHandle
:1; /* file closed via session abend */
785 bool oplock_break_cancelled
:1;
786 int count
; /* refcount protected by cifs_file_list_lock */
787 struct mutex fh_mutex
; /* prevents reopen race after dead ses*/
788 struct cifs_search_info srch_inf
;
789 struct work_struct oplock_break
; /* work for oplock breaks */
792 struct cifs_io_parms
{
797 struct cifs_tcon
*tcon
;
801 * Take a reference on the file private data. Must be called with
802 * cifs_file_list_lock held.
805 cifsFileInfo_get_locked(struct cifsFileInfo
*cifs_file
)
810 struct cifsFileInfo
*cifsFileInfo_get(struct cifsFileInfo
*cifs_file
);
811 void cifsFileInfo_put(struct cifsFileInfo
*cifs_file
);
814 * One of these for each file inode
817 struct cifsInodeInfo
{
818 bool can_cache_brlcks
;
819 struct mutex lock_mutex
; /*
820 * protect the field above and llist
821 * from every cifsFileInfo structure
824 /* BB add in lists for dirty pages i.e. write caching info for oplock */
825 struct list_head openFileList
;
826 __u32 cifsAttrs
; /* e.g. DOS archive bit, sparse, compressed, system */
827 bool clientCanCacheRead
; /* read oplock */
828 bool clientCanCacheAll
; /* read and writebehind oplock */
829 bool delete_pending
; /* DELETE_ON_CLOSE is set */
830 bool invalid_mapping
; /* pagecache is invalid */
831 unsigned long time
; /* jiffies of last update of inode */
832 u64 server_eof
; /* current file size on server -- protected by i_lock */
833 u64 uniqueid
; /* server inode number */
834 u64 createtime
; /* creation time on server */
835 #ifdef CONFIG_CIFS_FSCACHE
836 struct fscache_cookie
*fscache
;
838 struct inode vfs_inode
;
841 static inline struct cifsInodeInfo
*
842 CIFS_I(struct inode
*inode
)
844 return container_of(inode
, struct cifsInodeInfo
, vfs_inode
);
847 static inline struct cifs_sb_info
*
848 CIFS_SB(struct super_block
*sb
)
850 return sb
->s_fs_info
;
853 static inline char CIFS_DIR_SEP(const struct cifs_sb_info
*cifs_sb
)
855 if (cifs_sb
->mnt_cifs_flags
& CIFS_MOUNT_POSIX_PATHS
)
862 convert_delimiter(char *path
, char delim
)
875 for (i
= 0; path
[i
] != '\0'; i
++) {
876 if (path
[i
] == old_delim
)
882 build_path_to_root(struct smb_vol
*vol
, struct cifs_sb_info
*cifs_sb
,
883 struct cifs_tcon
*tcon
)
885 if (!vol
->ops
->build_path_to_root
)
887 return vol
->ops
->build_path_to_root(vol
, cifs_sb
, tcon
);
890 #ifdef CONFIG_CIFS_STATS
891 #define cifs_stats_inc atomic_inc
893 static inline void cifs_stats_bytes_written(struct cifs_tcon
*tcon
,
897 spin_lock(&tcon
->stat_lock
);
898 tcon
->bytes_written
+= bytes
;
899 spin_unlock(&tcon
->stat_lock
);
903 static inline void cifs_stats_bytes_read(struct cifs_tcon
*tcon
,
906 spin_lock(&tcon
->stat_lock
);
907 tcon
->bytes_read
+= bytes
;
908 spin_unlock(&tcon
->stat_lock
);
912 #define cifs_stats_inc(field) do {} while (0)
913 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
914 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
920 * This is the prototype for the mid receive function. This function is for
921 * receiving the rest of the SMB frame, starting with the WordCount (which is
922 * just after the MID in struct smb_hdr). Note:
924 * - This will be called by cifsd, with no locks held.
925 * - The mid will still be on the pending_mid_q.
926 * - mid->resp_buf will point to the current buffer.
928 * Returns zero on a successful receive, or an error. The receive state in
929 * the TCP_Server_Info will also be updated.
931 typedef int (mid_receive_t
)(struct TCP_Server_Info
*server
,
932 struct mid_q_entry
*mid
);
935 * This is the prototype for the mid callback function. This is called once the
936 * mid has been received off of the socket. When creating one, take special
937 * care to avoid deadlocks. Things to bear in mind:
939 * - it will be called by cifsd, with no locks held
940 * - the mid will be removed from any lists
942 typedef void (mid_callback_t
)(struct mid_q_entry
*mid
);
944 /* one of these for every pending CIFS request to the server */
946 struct list_head qhead
; /* mids waiting on reply from this server */
947 struct TCP_Server_Info
*server
; /* server corresponding to this mid */
948 __u64 mid
; /* multiplex id */
949 __u32 pid
; /* process id */
950 __u32 sequence_number
; /* for CIFS signing */
951 unsigned long when_alloc
; /* when mid was created */
952 #ifdef CONFIG_CIFS_STATS2
953 unsigned long when_sent
; /* time when smb send finished */
954 unsigned long when_received
; /* when demux complete (taken off wire) */
956 mid_receive_t
*receive
; /* call receive callback */
957 mid_callback_t
*callback
; /* call completion callback */
958 void *callback_data
; /* general purpose pointer for callback */
959 void *resp_buf
; /* pointer to received SMB header */
960 int mid_state
; /* wish this were enum but can not pass to wait_event */
961 __le16 command
; /* smb command code */
962 bool large_buf
:1; /* if valid response, is pointer to large buf */
963 bool multiRsp
:1; /* multiple trans2 responses for one request */
964 bool multiEnd
:1; /* both received */
967 /* Make code in transport.c a little cleaner by moving
968 update of optional stats into function below */
969 #ifdef CONFIG_CIFS_STATS2
971 static inline void cifs_in_send_inc(struct TCP_Server_Info
*server
)
973 atomic_inc(&server
->in_send
);
976 static inline void cifs_in_send_dec(struct TCP_Server_Info
*server
)
978 atomic_dec(&server
->in_send
);
981 static inline void cifs_num_waiters_inc(struct TCP_Server_Info
*server
)
983 atomic_inc(&server
->num_waiters
);
986 static inline void cifs_num_waiters_dec(struct TCP_Server_Info
*server
)
988 atomic_dec(&server
->num_waiters
);
991 static inline void cifs_save_when_sent(struct mid_q_entry
*mid
)
993 mid
->when_sent
= jiffies
;
996 static inline void cifs_in_send_inc(struct TCP_Server_Info
*server
)
999 static inline void cifs_in_send_dec(struct TCP_Server_Info
*server
)
1003 static inline void cifs_num_waiters_inc(struct TCP_Server_Info
*server
)
1007 static inline void cifs_num_waiters_dec(struct TCP_Server_Info
*server
)
1011 static inline void cifs_save_when_sent(struct mid_q_entry
*mid
)
1016 /* for pending dnotify requests */
1017 struct dir_notify_req
{
1018 struct list_head lhead
;
1025 __u32 filter
; /* CompletionFilter (for multishot) */
1030 struct dfs_info3_param
{
1031 int flags
; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1040 * common struct for holding inode info when searching for or updating an
1041 * inode with new info
1044 #define CIFS_FATTR_DFS_REFERRAL 0x1
1045 #define CIFS_FATTR_DELETE_PENDING 0x2
1046 #define CIFS_FATTR_NEED_REVAL 0x4
1047 #define CIFS_FATTR_INO_COLLISION 0x8
1060 unsigned int cf_nlink
;
1061 unsigned int cf_dtype
;
1062 struct timespec cf_atime
;
1063 struct timespec cf_mtime
;
1064 struct timespec cf_ctime
;
1067 static inline void free_dfs_info_param(struct dfs_info3_param
*param
)
1070 kfree(param
->path_name
);
1071 kfree(param
->node_name
);
1076 static inline void free_dfs_info_array(struct dfs_info3_param
*param
,
1077 int number_of_items
)
1080 if ((number_of_items
== 0) || (param
== NULL
))
1082 for (i
= 0; i
< number_of_items
; i
++) {
1083 kfree(param
[i
].path_name
);
1084 kfree(param
[i
].node_name
);
1090 #define MID_REQUEST_ALLOCATED 1
1091 #define MID_REQUEST_SUBMITTED 2
1092 #define MID_RESPONSE_RECEIVED 4
1093 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1094 #define MID_RESPONSE_MALFORMED 0x10
1095 #define MID_SHUTDOWN 0x20
1097 /* Types of response buffer returned from SendReceive2 */
1098 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1099 #define CIFS_SMALL_BUFFER 1
1100 #define CIFS_LARGE_BUFFER 2
1101 #define CIFS_IOVEC 4 /* array of response buffers */
1103 /* Type of Request to SendReceive2 */
1104 #define CIFS_BLOCKING_OP 1 /* operation can block */
1105 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1106 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1107 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1108 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1109 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1111 /* Type of request operation */
1112 #define CIFS_ECHO_OP 0x080 /* echo request */
1113 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1114 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1115 #define CIFS_OP_MASK 0x0380 /* mask request type */
1117 /* Security Flags: indicate type of session setup needed */
1118 #define CIFSSEC_MAY_SIGN 0x00001
1119 #define CIFSSEC_MAY_NTLM 0x00002
1120 #define CIFSSEC_MAY_NTLMV2 0x00004
1121 #define CIFSSEC_MAY_KRB5 0x00008
1122 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1123 #define CIFSSEC_MAY_LANMAN 0x00010
1124 #define CIFSSEC_MAY_PLNTXT 0x00020
1126 #define CIFSSEC_MAY_LANMAN 0
1127 #define CIFSSEC_MAY_PLNTXT 0
1128 #endif /* weak passwords */
1129 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1130 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1132 #define CIFSSEC_MUST_SIGN 0x01001
1133 /* note that only one of the following can be set so the
1134 result of setting MUST flags more than once will be to
1135 require use of the stronger protocol */
1136 #define CIFSSEC_MUST_NTLM 0x02002
1137 #define CIFSSEC_MUST_NTLMV2 0x04004
1138 #define CIFSSEC_MUST_KRB5 0x08008
1139 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1140 #define CIFSSEC_MUST_LANMAN 0x10010
1141 #define CIFSSEC_MUST_PLNTXT 0x20020
1142 #ifdef CONFIG_CIFS_UPCALL
1143 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1145 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1147 #else /* do not allow weak pw hash */
1148 #define CIFSSEC_MUST_LANMAN 0
1149 #define CIFSSEC_MUST_PLNTXT 0
1150 #ifdef CONFIG_CIFS_UPCALL
1151 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1153 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1155 #endif /* WEAK_PW_HASH */
1156 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1157 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1159 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
1160 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1161 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1163 *****************************************************************
1164 * All constants go here
1165 *****************************************************************
1168 #define UID_HASH (16)
1171 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1172 * following to be declared.
1175 /****************************************************************************
1176 * Locking notes. All updates to global variables and lists should be
1177 * protected by spinlocks or semaphores.
1181 * GlobalMid_Lock protects:
1182 * list operations on pending_mid_q and oplockQ
1183 * updates to XID counters, multiplex id and SMB sequence numbers
1184 * cifs_file_list_lock protects:
1185 * list operations on tcp and SMB session lists and tCon lists
1186 * f_owner.lock protects certain per file struct operations
1187 * mapping->page_lock protects certain per page operations
1191 * sesSem operations on smb session
1192 * tconSem operations on tree connection
1193 * fh_sem file handle reconnection operations
1195 ****************************************************************************/
1197 #ifdef DECLARE_GLOBALS_HERE
1198 #define GLOBAL_EXTERN
1200 #define GLOBAL_EXTERN extern
1204 * the list of TCP_Server_Info structures, ie each of the sockets
1205 * connecting our client to a distinct server (ip address), is
1206 * chained together by cifs_tcp_ses_list. The list of all our SMB
1207 * sessions (and from that the tree connections) can be found
1208 * by iterating over cifs_tcp_ses_list
1210 GLOBAL_EXTERN
struct list_head cifs_tcp_ses_list
;
1213 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1214 * tcp session, and the list of tcon's per smb session. It also protects
1215 * the reference counters for the server, smb session, and tcon. Finally,
1216 * changes to the tcon->tidStatus should be done while holding this lock.
1218 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock
;
1221 * This lock protects the cifs_file->llist and cifs_file->flist
1222 * list operations, and updates to some flags (cifs_file->invalidHandle)
1223 * It will be moved to either use the tcon->stat_lock or equivalent later.
1224 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1225 * the cifs_tcp_ses_lock must be grabbed first and released last.
1227 GLOBAL_EXTERN spinlock_t cifs_file_list_lock
;
1229 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1230 /* Outstanding dir notify requests */
1231 GLOBAL_EXTERN
struct list_head GlobalDnotifyReqList
;
1232 /* DirNotify response queue */
1233 GLOBAL_EXTERN
struct list_head GlobalDnotifyRsp_Q
;
1234 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1237 * Global transaction id (XID) information
1239 GLOBAL_EXTERN
unsigned int GlobalCurrentXid
; /* protected by GlobalMid_Sem */
1240 GLOBAL_EXTERN
unsigned int GlobalTotalActiveXid
; /* prot by GlobalMid_Sem */
1241 GLOBAL_EXTERN
unsigned int GlobalMaxActiveXid
; /* prot by GlobalMid_Sem */
1242 GLOBAL_EXTERN spinlock_t GlobalMid_Lock
; /* protects above & list operations */
1243 /* on midQ entries */
1245 * Global counters, updated atomically
1247 GLOBAL_EXTERN atomic_t sesInfoAllocCount
;
1248 GLOBAL_EXTERN atomic_t tconInfoAllocCount
;
1249 GLOBAL_EXTERN atomic_t tcpSesAllocCount
;
1250 GLOBAL_EXTERN atomic_t tcpSesReconnectCount
;
1251 GLOBAL_EXTERN atomic_t tconInfoReconnectCount
;
1253 /* Various Debug counters */
1254 GLOBAL_EXTERN atomic_t bufAllocCount
; /* current number allocated */
1255 #ifdef CONFIG_CIFS_STATS2
1256 GLOBAL_EXTERN atomic_t totBufAllocCount
; /* total allocated over all time */
1257 GLOBAL_EXTERN atomic_t totSmBufAllocCount
;
1259 GLOBAL_EXTERN atomic_t smBufAllocCount
;
1260 GLOBAL_EXTERN atomic_t midCount
;
1263 GLOBAL_EXTERN
bool enable_oplocks
; /* enable or disable oplocks */
1264 GLOBAL_EXTERN
unsigned int lookupCacheEnabled
;
1265 GLOBAL_EXTERN
unsigned int global_secflags
; /* if on, session setup sent
1266 with more secure ntlmssp2 challenge/resp */
1267 GLOBAL_EXTERN
unsigned int sign_CIFS_PDUs
; /* enable smb packet signing */
1268 GLOBAL_EXTERN
unsigned int linuxExtEnabled
;/*enable Linux/Unix CIFS extensions*/
1269 GLOBAL_EXTERN
unsigned int CIFSMaxBufSize
; /* max size not including hdr */
1270 GLOBAL_EXTERN
unsigned int cifs_min_rcv
; /* min size of big ntwrk buf pool */
1271 GLOBAL_EXTERN
unsigned int cifs_min_small
; /* min size of small buf pool */
1272 GLOBAL_EXTERN
unsigned int cifs_max_pending
; /* MAX requests at once to server*/
1274 #ifdef CONFIG_CIFS_ACL
1275 GLOBAL_EXTERN
struct rb_root uidtree
;
1276 GLOBAL_EXTERN
struct rb_root gidtree
;
1277 GLOBAL_EXTERN spinlock_t siduidlock
;
1278 GLOBAL_EXTERN spinlock_t sidgidlock
;
1279 GLOBAL_EXTERN
struct rb_root siduidtree
;
1280 GLOBAL_EXTERN
struct rb_root sidgidtree
;
1281 GLOBAL_EXTERN spinlock_t uidsidlock
;
1282 GLOBAL_EXTERN spinlock_t gidsidlock
;
1283 #endif /* CONFIG_CIFS_ACL */
1285 void cifs_oplock_break(struct work_struct
*work
);
1287 extern const struct slow_work_ops cifs_oplock_break_ops
;
1288 extern struct workqueue_struct
*cifsiod_wq
;
1290 extern mempool_t
*cifs_mid_poolp
;
1292 /* Operations for different SMB versions */
1293 #define SMB1_VERSION_STRING "1.0"
1294 extern struct smb_version_operations smb1_operations
;
1295 extern struct smb_version_values smb1_values
;
1296 #define SMB21_VERSION_STRING "2.1"
1297 extern struct smb_version_operations smb21_operations
;
1298 extern struct smb_version_values smb21_values
;
1299 #endif /* _CIFS_GLOB_H */