1da6c28aaSamw /*
2da6c28aaSamw  * CDDL HEADER START
3da6c28aaSamw  *
4da6c28aaSamw  * The contents of this file are subject to the terms of the
5da6c28aaSamw  * Common Development and Distribution License (the "License").
6da6c28aaSamw  * You may not use this file except in compliance with the License.
7da6c28aaSamw  *
8da6c28aaSamw  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9da6c28aaSamw  * or http://www.opensolaris.org/os/licensing.
10da6c28aaSamw  * See the License for the specific language governing permissions
11da6c28aaSamw  * and limitations under the License.
12da6c28aaSamw  *
13da6c28aaSamw  * When distributing Covered Code, include this CDDL HEADER in each
14da6c28aaSamw  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15da6c28aaSamw  * If applicable, add the following below this CDDL HEADER, with the
16da6c28aaSamw  * fields enclosed by brackets "[]" replaced with your own identifying
17da6c28aaSamw  * information: Portions Copyright [yyyy] [name of copyright owner]
18da6c28aaSamw  *
19da6c28aaSamw  * CDDL HEADER END
20da6c28aaSamw  */
21da6c28aaSamw /*
22148c5f43SAlan Wright  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
23bfbce3c1SGordon Ross  * Copyright 2012 Nexenta Systems, Inc.  All rights reserved.
24da6c28aaSamw  */
25da6c28aaSamw 
26da6c28aaSamw /*
27da6c28aaSamw  * Structures and type definitions for the SMB module.
28da6c28aaSamw  */
29da6c28aaSamw 
30faa1795aSjb #ifndef _SMBSRV_SMB_KTYPES_H
31faa1795aSjb #define	_SMBSRV_SMB_KTYPES_H
32da6c28aaSamw 
33da6c28aaSamw #ifdef	__cplusplus
34da6c28aaSamw extern "C" {
35da6c28aaSamw #endif
36da6c28aaSamw 
37faa1795aSjb #include <sys/note.h>
38da6c28aaSamw #include <sys/systm.h>
39da6c28aaSamw #include <sys/param.h>
40da6c28aaSamw #include <sys/types.h>
41da6c28aaSamw #include <sys/synch.h>
42da6c28aaSamw #include <sys/taskq.h>
433db3f65cSamw #include <sys/socket.h>
44da6c28aaSamw #include <sys/acl.h>
45da6c28aaSamw #include <sys/sdt.h>
46c8ec8eeaSjose borrego #include <sys/stat.h>
47da6c28aaSamw #include <sys/vnode.h>
48da6c28aaSamw #include <sys/cred.h>
490f1702c5SYu Xiangning #include <netinet/in.h>
500f1702c5SYu Xiangning #include <sys/ksocket.h>
51faa1795aSjb #include <sys/fem.h>
52faa1795aSjb #include <sys/door.h>
537f667e74Sjose borrego #include <sys/extdirent.h>
54da6c28aaSamw #include <smbsrv/smb.h>
55da6c28aaSamw #include <smbsrv/smbinfo.h>
56da6c28aaSamw #include <smbsrv/mbuf.h>
576537f381Sas #include <smbsrv/smb_sid.h>
583db3f65cSamw #include <smbsrv/smb_xdr.h>
5921b7895dSjb #include <smbsrv/netbios.h>
60da6c28aaSamw #include <smbsrv/smb_vops.h>
61148c5f43SAlan Wright #include <smbsrv/smb_kstat.h>
62da6c28aaSamw 
632c2961f8Sjose borrego struct smb_disp_entry;
64faa1795aSjb struct smb_request;
65faa1795aSjb struct smb_server;
669fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States struct smb_event;
67da6c28aaSamw 
68148c5f43SAlan Wright /*
69148c5f43SAlan Wright  * Accumulated time and queue length statistics.
70148c5f43SAlan Wright  *
71148c5f43SAlan Wright  * Accumulated time statistics are kept as a running sum of "active" time.
72148c5f43SAlan Wright  * Queue length statistics are kept as a running sum of the product of queue
73148c5f43SAlan Wright  * length and elapsed time at that length -- i.e., a Riemann sum for queue
74148c5f43SAlan Wright  * length integrated against time.  (You can also think of the active time as a
75148c5f43SAlan Wright  * Riemann sum, for the boolean function (queue_length > 0) integrated against
76148c5f43SAlan Wright  * time, or you can think of it as the Lebesgue measure of the set on which
77148c5f43SAlan Wright  * queue_length > 0.)
78148c5f43SAlan Wright  *
79148c5f43SAlan Wright  *		^
80148c5f43SAlan Wright  *		|			_________
81148c5f43SAlan Wright  *		8			| i4	|
82148c5f43SAlan Wright  *		|			|	|
83148c5f43SAlan Wright  *	Queue	6			|	|
84148c5f43SAlan Wright  *	Length	|	_________	|	|
85148c5f43SAlan Wright  *		4	| i2	|_______|	|
86148c5f43SAlan Wright  *		|	|	    i3		|
87148c5f43SAlan Wright  *		2_______|			|
88148c5f43SAlan Wright  *		|    i1				|
89148c5f43SAlan Wright  *		|_______________________________|
90148c5f43SAlan Wright  *		Time->	t1	t2	t3	t4
91148c5f43SAlan Wright  *
92148c5f43SAlan Wright  * At each change of state (entry or exit from the queue), we add the elapsed
93148c5f43SAlan Wright  * time (since the previous state change) to the active time if the queue length
94148c5f43SAlan Wright  * was non-zero during that interval; and we add the product of the elapsed time
95148c5f43SAlan Wright  * times the queue length to the running length*time sum.
96148c5f43SAlan Wright  *
97148c5f43SAlan Wright  * This method is generalizable to measuring residency in any defined system:
98148c5f43SAlan Wright  * instead of queue lengths, think of "outstanding RPC calls to server X".
99148c5f43SAlan Wright  *
100148c5f43SAlan Wright  * A large number of I/O subsystems have at least two basic "lists" of
101148c5f43SAlan Wright  * transactions they manage: one for transactions that have been accepted for
102148c5f43SAlan Wright  * processing but for which processing has yet to begin, and one for
103148c5f43SAlan Wright  * transactions which are actively being processed (but not done). For this
104148c5f43SAlan Wright  * reason, two cumulative time statistics are defined here: wait (pre-service)
105148c5f43SAlan Wright  * time, and run (service) time.
106148c5f43SAlan Wright  *
107148c5f43SAlan Wright  * All times are 64-bit nanoseconds (hrtime_t), as returned by gethrtime().
108148c5f43SAlan Wright  *
109148c5f43SAlan Wright  * The units of cumulative busy time are accumulated nanoseconds. The units of
110148c5f43SAlan Wright  * cumulative length*time products are elapsed time times queue length.
111148c5f43SAlan Wright  *
112148c5f43SAlan Wright  * Updates to the fields below are performed implicitly by calls to
113148c5f43SAlan Wright  * these functions:
114148c5f43SAlan Wright  *
115148c5f43SAlan Wright  *	smb_srqueue_init()
116148c5f43SAlan Wright  *	smb_srqueue_destroy()
117148c5f43SAlan Wright  *	smb_srqueue_waitq_enter()
118148c5f43SAlan Wright  *	smb_srqueue_runq_exit()
119148c5f43SAlan Wright  *	smb_srqueue_waitq_to_runq()
120148c5f43SAlan Wright  *	smb_srqueue_update()
121148c5f43SAlan Wright  *
122148c5f43SAlan Wright  * These fields should never be updated by any other means.
123148c5f43SAlan Wright  */
124148c5f43SAlan Wright typedef struct smb_srqueue {
125148c5f43SAlan Wright 	kmutex_t	srq_mutex;
126148c5f43SAlan Wright 	hrtime_t	srq_wlastupdate;
127148c5f43SAlan Wright 	hrtime_t	srq_wtime;
128148c5f43SAlan Wright 	hrtime_t	srq_wlentime;
129148c5f43SAlan Wright 	hrtime_t	srq_rlastupdate;
130148c5f43SAlan Wright 	hrtime_t	srq_rtime;
131148c5f43SAlan Wright 	hrtime_t	srq_rlentime;
132148c5f43SAlan Wright 	uint32_t	srq_wcnt;
133148c5f43SAlan Wright 	uint32_t	srq_rcnt;
134148c5f43SAlan Wright } smb_srqueue_t;
135148c5f43SAlan Wright 
136148c5f43SAlan Wright /*
137148c5f43SAlan Wright  * The fields with the prefix 'ly_a' contain the statistics collected since the
138148c5f43SAlan Wright  * server was last started ('a' for 'aggregated'). The fields with the prefix
139148c5f43SAlan Wright  * 'ly_d' contain the statistics collected since the last snapshot ('d' for
140148c5f43SAlan Wright  * 'delta').
141148c5f43SAlan Wright  */
142148c5f43SAlan Wright typedef struct smb_latency {
143148c5f43SAlan Wright 	kmutex_t	ly_mutex;
144148c5f43SAlan Wright 	uint64_t	ly_a_nreq;
145148c5f43SAlan Wright 	hrtime_t	ly_a_sum;
146148c5f43SAlan Wright 	hrtime_t	ly_a_mean;
147148c5f43SAlan Wright 	hrtime_t	ly_a_stddev;
148148c5f43SAlan Wright 	uint64_t	ly_d_nreq;
149148c5f43SAlan Wright 	hrtime_t	ly_d_sum;
150148c5f43SAlan Wright 	hrtime_t	ly_d_mean;
151148c5f43SAlan Wright 	hrtime_t	ly_d_stddev;
152148c5f43SAlan Wright } smb_latency_t;
153148c5f43SAlan Wright 
154da6c28aaSamw int smb_noop(void *, size_t, int);
155da6c28aaSamw 
156da6c28aaSamw #define	SMB_AUDIT_STACK_DEPTH	16
157da6c28aaSamw #define	SMB_AUDIT_BUF_MAX_REC	16
158da6c28aaSamw #define	SMB_AUDIT_NODE		0x00000001
159da6c28aaSamw 
160c8ec8eeaSjose borrego /*
161c8ec8eeaSjose borrego  * Maximum number of records returned in SMBsearch, SMBfind
162c8ec8eeaSjose borrego  * and SMBfindunique response. Value set to 10 for compatibility
163c8ec8eeaSjose borrego  * with Windows.
164c8ec8eeaSjose borrego  */
165c8ec8eeaSjose borrego #define	SMB_MAX_SEARCH		10
166c8ec8eeaSjose borrego 
1677f667e74Sjose borrego #define	SMB_SEARCH_ATTRIBUTES    \
1687f667e74Sjose borrego 	(FILE_ATTRIBUTE_HIDDEN | \
1697f667e74Sjose borrego 	FILE_ATTRIBUTE_SYSTEM |  \
1707f667e74Sjose borrego 	FILE_ATTRIBUTE_DIRECTORY)
1717f667e74Sjose borrego 
1722c1b14e5Sjose borrego #define	SMB_SEARCH_HIDDEN(sattr) ((sattr) & FILE_ATTRIBUTE_HIDDEN)
1732c1b14e5Sjose borrego #define	SMB_SEARCH_SYSTEM(sattr) ((sattr) & FILE_ATTRIBUTE_SYSTEM)
1742c1b14e5Sjose borrego #define	SMB_SEARCH_DIRECTORY(sattr) ((sattr) & FILE_ATTRIBUTE_DIRECTORY)
1757f667e74Sjose borrego #define	SMB_SEARCH_ALL(sattr) ((sattr) & SMB_SEARCH_ATTRIBUTES)
1762c1b14e5Sjose borrego 
177da6c28aaSamw typedef struct {
178da6c28aaSamw 	uint32_t		anr_refcnt;
179da6c28aaSamw 	int			anr_depth;
180da6c28aaSamw 	pc_t			anr_stack[SMB_AUDIT_STACK_DEPTH];
181da6c28aaSamw } smb_audit_record_node_t;
182da6c28aaSamw 
183da6c28aaSamw typedef struct {
184da6c28aaSamw 	int			anb_index;
185da6c28aaSamw 	int			anb_max_index;
186da6c28aaSamw 	smb_audit_record_node_t	anb_records[SMB_AUDIT_BUF_MAX_REC];
187da6c28aaSamw } smb_audit_buf_node_t;
188da6c28aaSamw 
189da6c28aaSamw #define	SMB_WORKER_PRIORITY	99
190da6c28aaSamw /*
191da6c28aaSamw  * Thread State Machine
192da6c28aaSamw  * --------------------
193da6c28aaSamw  *
194da6c28aaSamw  *			    T5			   T0
195da6c28aaSamw  * smb_thread_destroy()	<-------+		+------- smb_thread_init()
196da6c28aaSamw  *                              |		|
197da6c28aaSamw  *				|		v
198da6c28aaSamw  *			+-----------------------------+
199da6c28aaSamw  *			|   SMB_THREAD_STATE_EXITED   |<---+
200da6c28aaSamw  *			+-----------------------------+	   |
201da6c28aaSamw  *				      | T1		   |
202da6c28aaSamw  *				      v			   |
203da6c28aaSamw  *			+-----------------------------+	   |
204da6c28aaSamw  *			|  SMB_THREAD_STATE_STARTING  |	   |
205da6c28aaSamw  *			+-----------------------------+	   |
206da6c28aaSamw  *				     | T2		   | T4
207da6c28aaSamw  *				     v			   |
208da6c28aaSamw  *			+-----------------------------+	   |
209da6c28aaSamw  *			|  SMB_THREAD_STATE_RUNNING   |	   |
210da6c28aaSamw  *			+-----------------------------+	   |
211da6c28aaSamw  *				     | T3		   |
212da6c28aaSamw  *				     v			   |
213da6c28aaSamw  *			+-----------------------------+	   |
214da6c28aaSamw  *			|  SMB_THREAD_STATE_EXITING   |----+
215da6c28aaSamw  *			+-----------------------------+
216da6c28aaSamw  *
217da6c28aaSamw  * Transition T0
218da6c28aaSamw  *
219da6c28aaSamw  *    This transition is executed in smb_thread_init().
220da6c28aaSamw  *
221da6c28aaSamw  * Transition T1
222da6c28aaSamw  *
223da6c28aaSamw  *    This transition is executed in smb_thread_start().
224da6c28aaSamw  *
225da6c28aaSamw  * Transition T2
226da6c28aaSamw  *
227da6c28aaSamw  *    This transition is executed by the thread itself when it starts running.
228da6c28aaSamw  *
229da6c28aaSamw  * Transition T3
230da6c28aaSamw  *
231da6c28aaSamw  *    This transition is executed by the thread itself in
232da6c28aaSamw  *    smb_thread_entry_point() just before calling thread_exit().
233da6c28aaSamw  *
234da6c28aaSamw  *
235da6c28aaSamw  * Transition T4
236da6c28aaSamw  *
237da6c28aaSamw  *    This transition is executed in smb_thread_stop().
238da6c28aaSamw  *
239da6c28aaSamw  * Transition T5
240da6c28aaSamw  *
241da6c28aaSamw  *    This transition is executed in smb_thread_destroy().
242da6c28aaSamw  */
243da6c28aaSamw typedef enum smb_thread_state {
244da6c28aaSamw 	SMB_THREAD_STATE_STARTING = 0,
245da6c28aaSamw 	SMB_THREAD_STATE_RUNNING,
246da6c28aaSamw 	SMB_THREAD_STATE_EXITING,
247da6c28aaSamw 	SMB_THREAD_STATE_EXITED
248da6c28aaSamw } smb_thread_state_t;
249da6c28aaSamw 
250da6c28aaSamw struct _smb_thread;
251da6c28aaSamw 
252da6c28aaSamw typedef void (*smb_thread_ep_t)(struct _smb_thread *, void *ep_arg);
253da6c28aaSamw 
254da6c28aaSamw #define	SMB_THREAD_MAGIC	0x534D4254	/* SMBT */
255da6c28aaSamw 
256da6c28aaSamw typedef struct _smb_thread {
257da6c28aaSamw 	uint32_t		sth_magic;
258da6c28aaSamw 	char			sth_name[16];
259da6c28aaSamw 	smb_thread_state_t	sth_state;
260da6c28aaSamw 	kthread_t		*sth_th;
261da6c28aaSamw 	kt_did_t		sth_did;
262da6c28aaSamw 	smb_thread_ep_t		sth_ep;
263da6c28aaSamw 	void			*sth_ep_arg;
264da6c28aaSamw 	boolean_t		sth_kill;
265da6c28aaSamw 	kmutex_t		sth_mtx;
266da6c28aaSamw 	kcondvar_t		sth_cv;
267da6c28aaSamw } smb_thread_t;
268da6c28aaSamw 
269da6c28aaSamw /*
270da6c28aaSamw  * Pool of IDs
271da6c28aaSamw  * -----------
272da6c28aaSamw  *
273da6c28aaSamw  *    A pool of IDs is a pool of 16 bit numbers. It is implemented as a bitmap.
274da6c28aaSamw  *    A bit set to '1' indicates that that particular value has been allocated.
275da6c28aaSamw  *    The allocation process is done shifting a bit through the whole bitmap.
276da6c28aaSamw  *    The current position of that index bit is kept in the smb_idpool_t
277da6c28aaSamw  *    structure and represented by a byte index (0 to buffer size minus 1) and
278da6c28aaSamw  *    a bit index (0 to 7).
279da6c28aaSamw  *
280da6c28aaSamw  *    The pools start with a size of 8 bytes or 64 IDs. Each time the pool runs
281da6c28aaSamw  *    out of IDs its current size is doubled until it reaches its maximum size
282da6c28aaSamw  *    (8192 bytes or 65536 IDs). The IDs 0 and 65535 are never given out which
283da6c28aaSamw  *    means that a pool can have a maximum number of 65534 IDs available.
284da6c28aaSamw  */
285da6c28aaSamw #define	SMB_IDPOOL_MAGIC	0x4944504C	/* IDPL */
286da6c28aaSamw #define	SMB_IDPOOL_MIN_SIZE	64	/* Number of IDs to begin with */
287da6c28aaSamw #define	SMB_IDPOOL_MAX_SIZE	64 * 1024
288da6c28aaSamw 
289da6c28aaSamw typedef struct smb_idpool {
290da6c28aaSamw 	uint32_t	id_magic;
291da6c28aaSamw 	kmutex_t	id_mutex;
292da6c28aaSamw 	uint8_t		*id_pool;
293da6c28aaSamw 	uint32_t	id_size;
294da6c28aaSamw 	uint8_t		id_bit;
295da6c28aaSamw 	uint8_t		id_bit_idx;
296da6c28aaSamw 	uint32_t	id_idx;
297da6c28aaSamw 	uint32_t	id_idx_msk;
298da6c28aaSamw 	uint32_t	id_free_counter;
299da6c28aaSamw 	uint32_t	id_max_free_counter;
300da6c28aaSamw } smb_idpool_t;
301da6c28aaSamw 
302da6c28aaSamw /*
3032c2961f8Sjose borrego  * Maximum size of a Transport Data Unit when CAP_LARGE_READX and
3042c2961f8Sjose borrego  * CAP_LARGE_WRITEX are not set.  CAP_LARGE_READX/CAP_LARGE_WRITEX
3052c2961f8Sjose borrego  * allow the payload to exceed the negotiated buffer size.
30621b7895dSjb  *     4 --> NBT/TCP Transport Header.
30721b7895dSjb  *    32 --> SMB Header
30821b7895dSjb  *     1 --> Word Count byte
30921b7895dSjb  *   510 --> Maximum Number of bytes of the Word Table (2 * 255)
31021b7895dSjb  *     2 --> Byte count of the data
31121b7895dSjb  * 65535 --> Maximum size of the data
31221b7895dSjb  * -----
31321b7895dSjb  * 66084
314da6c28aaSamw  */
3152c2961f8Sjose borrego #define	SMB_REQ_MAX_SIZE	66560		/* 65KB */
31621b7895dSjb #define	SMB_XPRT_MAX_SIZE	(SMB_REQ_MAX_SIZE + NETBIOS_HDR_SZ)
317da6c28aaSamw 
31821b7895dSjb #define	SMB_TXREQ_MAGIC		0X54524251	/* 'TREQ' */
3195cdbe942Sjb typedef struct {
32021b7895dSjb 	uint32_t	tr_magic;
32121b7895dSjb 	list_node_t	tr_lnd;
32221b7895dSjb 	int		tr_len;
32321b7895dSjb 	uint8_t		tr_buf[SMB_XPRT_MAX_SIZE];
32421b7895dSjb } smb_txreq_t;
3255cdbe942Sjb 
3265cdbe942Sjb #define	SMB_TXLST_MAGIC		0X544C5354	/* 'TLST' */
3275cdbe942Sjb typedef struct {
3285cdbe942Sjb 	uint32_t	tl_magic;
3295cdbe942Sjb 	kmutex_t	tl_mutex;
3305cdbe942Sjb 	boolean_t	tl_active;
3315cdbe942Sjb 	list_t		tl_list;
3325cdbe942Sjb } smb_txlst_t;
3335cdbe942Sjb 
334da6c28aaSamw /*
335faa1795aSjb  * Maximum buffer size for NT is 37KB.  If all clients are Windows 2000, this
336faa1795aSjb  * can be changed to 64KB.  37KB must be used with a mix of NT/Windows 2000
337faa1795aSjb  * clients because NT loses directory entries when values greater than 37KB are
338faa1795aSjb  * used.
339faa1795aSjb  *
340faa1795aSjb  * Note: NBT_MAXBUF will be subtracted from the specified max buffer size to
341faa1795aSjb  * account for the NBT header.
342da6c28aaSamw  */
343faa1795aSjb #define	NBT_MAXBUF		8
344faa1795aSjb #define	SMB_NT_MAXBUF		(37 * 1024)
345da6c28aaSamw 
346da6c28aaSamw #define	OUTBUFSIZE		(65 * 1024)
347da6c28aaSamw #define	SMBHEADERSIZE		32
348da6c28aaSamw #define	SMBND_HASH_MASK		(0xFF)
349da6c28aaSamw #define	MAX_IOVEC		512
350da6c28aaSamw #define	MAX_READREF		(8 * 1024)
351da6c28aaSamw 
352da6c28aaSamw #define	SMB_WORKER_MIN		4
353da6c28aaSamw #define	SMB_WORKER_DEFAULT	64
354da6c28aaSamw #define	SMB_WORKER_MAX		1024
355da6c28aaSamw 
356da6c28aaSamw /*
3579fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * Destructor object used in the locked-list delete queue.
358da6c28aaSamw  */
3599fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_DTOR_MAGIC		0x44544F52	/* DTOR */
3609fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_DTOR_VALID(d)	\
3619fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((d) != NULL) && ((d)->dt_magic == SMB_DTOR_MAGIC))
362da6c28aaSamw 
3639fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef void (*smb_dtorproc_t)(void *);
364da6c28aaSamw 
3659fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_dtor {
3669fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t	dt_magic;
3679fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_node_t	dt_lnd;
3689fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	void		*dt_object;
3699fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_dtorproc_t	dt_proc;
3709fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States } smb_dtor_t;
371da6c28aaSamw 
372da6c28aaSamw typedef struct smb_llist {
373da6c28aaSamw 	krwlock_t	ll_lock;
374da6c28aaSamw 	list_t		ll_list;
375da6c28aaSamw 	uint32_t	ll_count;
376da6c28aaSamw 	uint64_t	ll_wrop;
3779fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmutex_t	ll_mutex;
3789fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_t		ll_deleteq;
3799fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t	ll_deleteq_count;
380cb174861Sjoyce mcintosh 	boolean_t	ll_flushing;
381da6c28aaSamw } smb_llist_t;
382da6c28aaSamw 
383da6c28aaSamw typedef struct smb_slist {
384da6c28aaSamw 	kmutex_t	sl_mutex;
385da6c28aaSamw 	kcondvar_t	sl_cv;
386da6c28aaSamw 	list_t		sl_list;
387da6c28aaSamw 	uint32_t	sl_count;
388da6c28aaSamw 	boolean_t	sl_waiting;
389da6c28aaSamw } smb_slist_t;
390da6c28aaSamw 
391148c5f43SAlan Wright /*
392148c5f43SAlan Wright  * smb_avl_t State Machine
393148c5f43SAlan Wright  * --------------------
394148c5f43SAlan Wright  *
395148c5f43SAlan Wright  *                      +-----------------------------+
396148c5f43SAlan Wright  *                      |     SMB_AVL_STATE_START     |
397148c5f43SAlan Wright  *                      +-----------------------------+
398148c5f43SAlan Wright  *                                    | T0
399148c5f43SAlan Wright  *                                    v
400148c5f43SAlan Wright  *                      +-----------------------------+
401148c5f43SAlan Wright  *                      |     SMB_AVL_STATE_READY     |
402148c5f43SAlan Wright  *                      +-----------------------------+
403148c5f43SAlan Wright  *                                    | T1
404148c5f43SAlan Wright  *                                    v
405148c5f43SAlan Wright  *                      +-----------------------------+
406148c5f43SAlan Wright  *                      |  SMB_AVL_STATE_DESTROYING   |
407148c5f43SAlan Wright  *                      +-----------------------------+
408148c5f43SAlan Wright  *
409148c5f43SAlan Wright  * Transition T0
410148c5f43SAlan Wright  *
411148c5f43SAlan Wright  *    This transition is executed in smb_avl_create().
412148c5f43SAlan Wright  *
413148c5f43SAlan Wright  * Transition T1
414148c5f43SAlan Wright  *
415148c5f43SAlan Wright  *    This transition is executed in smb_avl_destroy().
416148c5f43SAlan Wright  *
417148c5f43SAlan Wright  */
418148c5f43SAlan Wright typedef enum {
419148c5f43SAlan Wright 	SMB_AVL_STATE_START = 0,
420148c5f43SAlan Wright 	SMB_AVL_STATE_READY,
421148c5f43SAlan Wright 	SMB_AVL_STATE_DESTROYING
422148c5f43SAlan Wright } smb_avl_state_t;
423148c5f43SAlan Wright 
424148c5f43SAlan Wright typedef struct smb_avl_nops {
425148c5f43SAlan Wright 	int		(*avln_cmp) (const void *, const void *);
426148c5f43SAlan Wright 	void		(*avln_hold)(const void *);
427148c5f43SAlan Wright 	boolean_t	(*avln_rele)(const void *);
428148c5f43SAlan Wright 	void		(*avln_destroy)(void *);
429148c5f43SAlan Wright } smb_avl_nops_t;
430148c5f43SAlan Wright 
431148c5f43SAlan Wright typedef struct smb_avl_cursor {
432148c5f43SAlan Wright 	void		*avlc_next;
433148c5f43SAlan Wright 	uint32_t	avlc_sequence;
434148c5f43SAlan Wright } smb_avl_cursor_t;
435148c5f43SAlan Wright 
436148c5f43SAlan Wright typedef struct smb_avl {
437148c5f43SAlan Wright 	krwlock_t	avl_lock;
438148c5f43SAlan Wright 	avl_tree_t	avl_tree;
439148c5f43SAlan Wright 	kmutex_t	avl_mutex;
440148c5f43SAlan Wright 	kcondvar_t	avl_cv;
441148c5f43SAlan Wright 	smb_avl_state_t	avl_state;
442148c5f43SAlan Wright 	uint32_t	avl_refcnt;
443148c5f43SAlan Wright 	uint32_t	avl_sequence;
444148c5f43SAlan Wright 	smb_avl_nops_t	*avl_nops;
445148c5f43SAlan Wright } smb_avl_t;
446148c5f43SAlan Wright 
447da6c28aaSamw typedef struct {
448da6c28aaSamw 	kcondvar_t	rwx_cv;
449da6c28aaSamw 	kmutex_t	rwx_mutex;
450da6c28aaSamw 	krwlock_t	rwx_lock;
451da6c28aaSamw 	boolean_t	rwx_waiting;
452da6c28aaSamw } smb_rwx_t;
453da6c28aaSamw 
454da6c28aaSamw /* NOTIFY CHANGE */
455*ccc71be5SGordon Ross typedef struct smb_node_fcn {
456*ccc71be5SGordon Ross 	kmutex_t	fcn_mutex;
457*ccc71be5SGordon Ross 	uint32_t	fcn_count;
458*ccc71be5SGordon Ross 	list_t		fcn_watchers;	/* smb_request_t, sr_ncr.nc_lnd */
459*ccc71be5SGordon Ross } smb_node_fcn_t;
460da6c28aaSamw 
461da6c28aaSamw typedef struct smb_notify_change_req {
462*ccc71be5SGordon Ross 	list_node_t		nc_lnd;	/* n_fcn.fcn_watchers */
463*ccc71be5SGordon Ross 	kcondvar_t		nc_cv;	/* prot: sr_mutex */
464da6c28aaSamw 	uint32_t		nc_flags;
465*ccc71be5SGordon Ross 	uint32_t		nc_action;
466*ccc71be5SGordon Ross 	char			*nc_fname;
467da6c28aaSamw } smb_notify_change_req_t;
468da6c28aaSamw 
469da6c28aaSamw /*
470da6c28aaSamw  * SMB operates over a NetBIOS-over-TCP transport (NBT) or directly
471da6c28aaSamw  * over TCP, which is also known as direct hosted NetBIOS-less SMB
472da6c28aaSamw  * or SMB-over-TCP.
473da6c28aaSamw  *
474da6c28aaSamw  * NBT messages have a 4-byte header that defines the message type
475da6c28aaSamw  * (8-bits), a 7-bit flags field and a 17-bit length.
476da6c28aaSamw  *
477da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
478da6c28aaSamw  * |      TYPE     |     FLAGS   |E|            LENGTH             |
479da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
480da6c28aaSamw  *
481da6c28aaSamw  * 8-bit type      Defined in RFC 1002
482da6c28aaSamw  * 7-bit flags     Bits 0-6 reserved (must be 0)
483da6c28aaSamw  *                 Bit 7: Length extension bit (E)
484da6c28aaSamw  * 17-bit length   Includes bit 7 of the flags byte
485da6c28aaSamw  *
486da6c28aaSamw  *
487da6c28aaSamw  * SMB-over-TCP is defined to use a modified version of the NBT header
488da6c28aaSamw  * containing an 8-bit message type and 24-bit message length.
489da6c28aaSamw  *
490da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
491da6c28aaSamw  * |      TYPE     |                  LENGTH                       |
492da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
493da6c28aaSamw  *
494da6c28aaSamw  * 8-bit type      Must be 0
495da6c28aaSamw  * 24-bit length
496da6c28aaSamw  *
497da6c28aaSamw  * The following structure is used to represent a generic, in-memory
498da6c28aaSamw  * SMB transport header; it is not intended to map directly to either
499da6c28aaSamw  * of the over-the-wire formats.
500da6c28aaSamw  */
501da6c28aaSamw typedef struct {
502da6c28aaSamw 	uint8_t		xh_type;
503da6c28aaSamw 	uint32_t	xh_length;
504da6c28aaSamw } smb_xprt_t;
505da6c28aaSamw 
506faa1795aSjb int MBC_LENGTH(struct mbuf_chain *);
5073ad684d6Sjb int MBC_MAXBYTES(struct mbuf_chain *);
508faa1795aSjb void MBC_SETUP(struct mbuf_chain *, uint32_t);
509faa1795aSjb void MBC_INIT(struct mbuf_chain *, uint32_t);
510faa1795aSjb void MBC_FLUSH(struct mbuf_chain *);
511faa1795aSjb void MBC_ATTACH_MBUF(struct mbuf_chain *, struct mbuf *);
512faa1795aSjb void MBC_APPEND_MBUF(struct mbuf_chain *, struct mbuf *);
513da6c28aaSamw void MBC_ATTACH_BUF(struct mbuf_chain *MBC, unsigned char *BUF, int LEN);
514da6c28aaSamw int MBC_SHADOW_CHAIN(struct mbuf_chain *SUBMBC, struct mbuf_chain *MBC,
515da6c28aaSamw     int OFF, int LEN);
516da6c28aaSamw 
517da6c28aaSamw #define	MBC_ROOM_FOR(b, n) (((b)->chain_offset + (n)) <= (b)->max_bytes)
518da6c28aaSamw 
519cb174861Sjoyce mcintosh #define	OPLOCK_MIN_TIMEOUT	(5 * 1000)
520cb174861Sjoyce mcintosh #define	OPLOCK_STD_TIMEOUT	(30 * 1000)
521cb174861Sjoyce mcintosh 
522fc724630SAlan Wright /*
523cb174861Sjoyce mcintosh  * Oplock break flags:
524cb174861Sjoyce mcintosh  * SMB_OPLOCK_BREAK_EXCLUSIVE - only break exclusive oplock
525cb174861Sjoyce mcintosh  * (type SMB_OPLOCK_EXCLUSIVE or SMB_OPLOCK_BATCH)
526cb174861Sjoyce mcintosh  * SMB_OPLOCK_BREAK_BATCH - only break exclusive BATCH oplock
527cb174861Sjoyce mcintosh  * SMB_OPLOCK_BREAK_NOWAIT - do not wait for oplock break ack
528cb174861Sjoyce mcintosh  */
529cb174861Sjoyce mcintosh #define	SMB_OPLOCK_NO_BREAK		0x00
530cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_TO_NONE	0x01
531cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_TO_LEVEL_II	0x02
532cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_EXCLUSIVE	0x04
533cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_BATCH		0x08
534cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_NOWAIT		0x10
535cb174861Sjoyce mcintosh 
536cb174861Sjoyce mcintosh /*
537cb174861Sjoyce mcintosh  * Oplocks levels are defined to match the levels in the SMB
538cb174861Sjoyce mcintosh  * protocol (nt_create_andx / nt_transact_create) and should
539cb174861Sjoyce mcintosh  * not be changed
540fc724630SAlan Wright  */
541cb174861Sjoyce mcintosh #define	SMB_OPLOCK_NONE		0
542cb174861Sjoyce mcintosh #define	SMB_OPLOCK_EXCLUSIVE	1
543cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BATCH	2
544cb174861Sjoyce mcintosh #define	SMB_OPLOCK_LEVEL_II	3
545cb174861Sjoyce mcintosh 
546da6c28aaSamw typedef struct smb_oplock {
547cb174861Sjoyce mcintosh 	kmutex_t		ol_mutex;
5482c2961f8Sjose borrego 	kcondvar_t		ol_cv;
5492c2961f8Sjose borrego 	kthread_t		*ol_xthread;
550cb174861Sjoyce mcintosh 	boolean_t		ol_fem;		/* fem monitor installed? */
551cb174861Sjoyce mcintosh 	uint8_t			ol_break;
552cb174861Sjoyce mcintosh 	uint32_t		ol_count;	/* number of grants */
553cb174861Sjoyce mcintosh 	list_t			ol_grants;	/* list of smb_oplock_grant_t */
554da6c28aaSamw } smb_oplock_t;
555da6c28aaSamw 
556cb174861Sjoyce mcintosh #define	SMB_OPLOCK_GRANT_MAGIC	0x4F4C4B47	/* OLKG */
557cb174861Sjoyce mcintosh #define	SMB_OPLOCK_GRANT_VALID(p) \
558cb174861Sjoyce mcintosh 	ASSERT((p)->og_magic == SMB_OPLOCK_GRANT_MAGIC)
5591fdeec65Sjoyce mcintosh #define	SMB_OFILE_OPLOCK_GRANTED(p) \
5601fdeec65Sjoyce mcintosh 	((p)->f_oplock_grant.og_magic == SMB_OPLOCK_GRANT_MAGIC)
561cb174861Sjoyce mcintosh typedef struct smb_oplock_grant {
562cb174861Sjoyce mcintosh 	uint32_t		og_magic;
563cb174861Sjoyce mcintosh 	list_node_t		og_lnd;
564cb174861Sjoyce mcintosh 	uint8_t			og_level;
565cb174861Sjoyce mcintosh 	uint16_t		og_fid;
566cb174861Sjoyce mcintosh 	uint16_t		og_tid;
567cb174861Sjoyce mcintosh 	uint16_t		og_uid;
568cb174861Sjoyce mcintosh 	struct smb_session	*og_session;
569cb174861Sjoyce mcintosh 	struct smb_ofile	*og_ofile;
570cb174861Sjoyce mcintosh } smb_oplock_grant_t;
571cb174861Sjoyce mcintosh 
572cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_MAGIC	0x4F4C4B42	/* OLKB */
573cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_VALID(p) \
574cb174861Sjoyce mcintosh 	ASSERT((p)->ob_magic == SMB_OPLOCK_BREAK_MAGIC)
575cb174861Sjoyce mcintosh typedef struct smb_oplock_break {
576cb174861Sjoyce mcintosh 	uint32_t	ob_magic;
577cb174861Sjoyce mcintosh 	list_node_t	ob_lnd;
578cb174861Sjoyce mcintosh 	struct smb_node	*ob_node;
579cb174861Sjoyce mcintosh } smb_oplock_break_t;
580cb174861Sjoyce mcintosh 
581cb174861Sjoyce mcintosh 
582da6c28aaSamw #define	SMB_VFS_MAGIC	0x534D4256	/* 'SMBV' */
583da6c28aaSamw 
584da6c28aaSamw typedef struct smb_vfs {
585da6c28aaSamw 	uint32_t		sv_magic;
586da6c28aaSamw 	list_node_t		sv_lnd;
587da6c28aaSamw 	uint32_t		sv_refcnt;
588da6c28aaSamw 	vfs_t			*sv_vfsp;
589da6c28aaSamw 	vnode_t			*sv_rootvp;
590da6c28aaSamw } smb_vfs_t;
591da6c28aaSamw 
592037cac00Sjoyce mcintosh /*
593037cac00Sjoyce mcintosh  * Solaris file systems handle timestamps differently from NTFS.
594037cac00Sjoyce mcintosh  * In order to provide a more similar view of an open file's
595037cac00Sjoyce mcintosh  * timestamps, we cache the timestamps in the node and manipulate
596037cac00Sjoyce mcintosh  * them in a manner more consistent with windows.
597037cac00Sjoyce mcintosh  * t_cached is B_TRUE when timestamps are cached.
598037cac00Sjoyce mcintosh  * Timestamps remain cached while there are open ofiles for the node.
599037cac00Sjoyce mcintosh  * This includes open ofiles for named streams.  t_open_ofiles is a
600037cac00Sjoyce mcintosh  * count of open ofiles on the node, including named streams' ofiles,
601cb174861Sjoyce mcintosh  * n_open_count cannot be used as it doesn't include ofiles opened
602037cac00Sjoyce mcintosh  * for the node's named streams.
603037cac00Sjoyce mcintosh  */
604037cac00Sjoyce mcintosh typedef struct smb_times {
605037cac00Sjoyce mcintosh 	uint32_t		t_open_ofiles;
606037cac00Sjoyce mcintosh 	boolean_t		t_cached;
607037cac00Sjoyce mcintosh 	timestruc_t		t_atime;
608037cac00Sjoyce mcintosh 	timestruc_t		t_mtime;
609037cac00Sjoyce mcintosh 	timestruc_t		t_ctime;
610037cac00Sjoyce mcintosh 	timestruc_t		t_crtime;
611037cac00Sjoyce mcintosh } smb_times_t;
612037cac00Sjoyce mcintosh 
6132c2961f8Sjose borrego #define	SMB_NODE_MAGIC		0x4E4F4445	/* 'NODE' */
6142c2961f8Sjose borrego #define	SMB_NODE_VALID(p)	ASSERT((p)->n_magic == SMB_NODE_MAGIC)
615da6c28aaSamw 
616da6c28aaSamw typedef enum {
617da6c28aaSamw 	SMB_NODE_STATE_AVAILABLE = 0,
618da6c28aaSamw 	SMB_NODE_STATE_DESTROYING
619da6c28aaSamw } smb_node_state_t;
620da6c28aaSamw 
6219fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States /*
6229fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * waiting_event        # of clients requesting FCN
6239fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_timestamps         cached timestamps
6249fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_allocsz            cached file allocation size
6259fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_dnode              directory node
6269fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_unode              unnamed stream node
6279fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * delete_on_close_cred credentials for delayed delete
6289fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  */
629da6c28aaSamw typedef struct smb_node {
630da6c28aaSamw 	uint32_t		n_magic;
6312c2961f8Sjose borrego 	krwlock_t		n_lock;
6322c2961f8Sjose borrego 	kmutex_t		n_mutex;
633da6c28aaSamw 	list_node_t		n_lnd;
634da6c28aaSamw 	smb_node_state_t	n_state;
635da6c28aaSamw 	uint32_t		n_refcnt;
636da6c28aaSamw 	uint32_t		n_hashkey;
637da6c28aaSamw 	smb_llist_t		*n_hash_bucket;
6382c2961f8Sjose borrego 	uint32_t		n_open_count;
639cb174861Sjoyce mcintosh 	uint32_t		n_opening_count;
640da6c28aaSamw 	smb_llist_t		n_ofile_list;
641da6c28aaSamw 	smb_llist_t		n_lock_list;
642c8ec8eeaSjose borrego 	struct smb_ofile	*readonly_creator;
6439fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	volatile int		flags;
6449fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	volatile int		waiting_event;
6459fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_times_t		n_timestamps;
6469fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	u_offset_t		n_allocsz;
647*ccc71be5SGordon Ross 	smb_node_fcn_t		n_fcn;
648da6c28aaSamw 	smb_oplock_t		n_oplock;
6499fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_node		*n_dnode;
6509fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_node		*n_unode;
651da6c28aaSamw 	cred_t			*delete_on_close_cred;
6528b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		n_delete_on_close_flags;
653da6c28aaSamw 	char			od_name[MAXNAMELEN];
654da6c28aaSamw 	vnode_t			*vp;
655da6c28aaSamw 	smb_audit_buf_node_t	*n_audit_buf;
656da6c28aaSamw } smb_node_t;
657da6c28aaSamw 
6589fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_REPARSE		0x00001000
6599fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_DFSLINK		0x00002000
6609fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_VFSROOT		0x00004000
6619fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_SYSTEM		0x00008000
662da6c28aaSamw #define	NODE_FLAGS_WRITE_THROUGH	0x00100000
663cbfb650aScp #define	NODE_XATTR_DIR			0x01000000
664da6c28aaSamw #define	NODE_FLAGS_DELETE_ON_CLOSE	0x40000000
665da6c28aaSamw #define	NODE_FLAGS_EXECUTABLE		0x80000000
666da6c28aaSamw 
667c8ec8eeaSjose borrego #define	SMB_NODE_VFS(node)	((node)->vp->v_vfsp)
668c8ec8eeaSjose borrego #define	SMB_NODE_FSID(node)	((node)->vp->v_vfsp->vfs_fsid)
669c8ec8eeaSjose borrego 
670148c5f43SAlan Wright /* Maximum buffer size for encryption key */
671148c5f43SAlan Wright #define	SMB_ENCRYPT_KEY_MAXLEN		32
672148c5f43SAlan Wright 
673148c5f43SAlan Wright #define	SMB_SHARE_MAGIC		0x4B534852	/* KSHR */
674148c5f43SAlan Wright 
675148c5f43SAlan Wright typedef struct smb_kshare {
676148c5f43SAlan Wright 	uint32_t	shr_magic;
677148c5f43SAlan Wright 	char		*shr_name;
678148c5f43SAlan Wright 	char		*shr_path;
679148c5f43SAlan Wright 	char		*shr_cmnt;
680148c5f43SAlan Wright 	char		*shr_container;
681148c5f43SAlan Wright 	char		*shr_oemname;
682148c5f43SAlan Wright 	uint32_t	shr_flags;
683148c5f43SAlan Wright 	uint32_t	shr_type;
684148c5f43SAlan Wright 	uint32_t	shr_refcnt;
685148c5f43SAlan Wright 	uint32_t	shr_autocnt;
686148c5f43SAlan Wright 	uid_t		shr_uid;
687148c5f43SAlan Wright 	gid_t		shr_gid;
688148c5f43SAlan Wright 	char		*shr_access_none;
689148c5f43SAlan Wright 	char		*shr_access_ro;
690148c5f43SAlan Wright 	char		*shr_access_rw;
691148c5f43SAlan Wright 	avl_node_t	shr_link;
692148c5f43SAlan Wright 	kmem_cache_t	*shr_cache;
693148c5f43SAlan Wright 	kmutex_t	shr_mutex;
694148c5f43SAlan Wright } smb_kshare_t;
695148c5f43SAlan Wright 
696148c5f43SAlan Wright 
697148c5f43SAlan Wright typedef struct smb_arg_negotiate {
698148c5f43SAlan Wright 	char		*ni_name;
699148c5f43SAlan Wright 	int		ni_dialect;
700148c5f43SAlan Wright 	int		ni_index;
701148c5f43SAlan Wright 	uint32_t	ni_capabilities;
702148c5f43SAlan Wright 	uint16_t	ni_maxmpxcount;
703148c5f43SAlan Wright 	int16_t		ni_tzcorrection;
704148c5f43SAlan Wright 	uint8_t		ni_keylen;
705148c5f43SAlan Wright 	uint8_t		ni_key[SMB_ENCRYPT_KEY_MAXLEN];
706148c5f43SAlan Wright 	timestruc_t	ni_servertime;
707148c5f43SAlan Wright } smb_arg_negotiate_t;
708148c5f43SAlan Wright 
709148c5f43SAlan Wright typedef struct smb_arg_sessionsetup {
710148c5f43SAlan Wright 	char		*ssi_user;
711148c5f43SAlan Wright 	char		*ssi_domain;
712148c5f43SAlan Wright 	uint16_t	ssi_cipwlen;
713148c5f43SAlan Wright 	uint8_t		*ssi_cipwd;
714148c5f43SAlan Wright 	uint16_t	ssi_cspwlen;
715148c5f43SAlan Wright 	uint8_t		*ssi_cspwd;
716148c5f43SAlan Wright 	uint16_t	ssi_maxmpxcount;
717148c5f43SAlan Wright 	uint32_t	ssi_capabilities;
718148c5f43SAlan Wright 	uint32_t	ssi_sesskey;
719148c5f43SAlan Wright 	boolean_t	ssi_guest;
720148c5f43SAlan Wright } smb_arg_sessionsetup_t;
721148c5f43SAlan Wright 
722148c5f43SAlan Wright typedef struct tcon {
723148c5f43SAlan Wright 	char		*path;
724148c5f43SAlan Wright 	char		*service;
725148c5f43SAlan Wright 	int		pwdlen;
726148c5f43SAlan Wright 	char		*password;
727148c5f43SAlan Wright 	uint16_t	flags;
728148c5f43SAlan Wright 	uint16_t	optional_support;
729148c5f43SAlan Wright 	smb_kshare_t	*si;
730148c5f43SAlan Wright } smb_arg_tcon_t;
731148c5f43SAlan Wright 
732da6c28aaSamw /*
733da6c28aaSamw  * Based on section 2.6.1.2 (Connection Management) of the June 13,
734da6c28aaSamw  * 1996 CIFS spec, a server may terminate the transport connection
735da6c28aaSamw  * due to inactivity. The client software is expected to be able to
736da6c28aaSamw  * automatically reconnect to the server if this happens. Like much
737da6c28aaSamw  * of the useful background information, this section appears to
738da6c28aaSamw  * have been dropped from later revisions of the document.
739da6c28aaSamw  *
740da6c28aaSamw  * Each session has an activity timestamp that's updated whenever a
741da6c28aaSamw  * request is dispatched. If the session is idle, i.e. receives no
742da6c28aaSamw  * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be
743da6c28aaSamw  * closed.
744da6c28aaSamw  *
745da6c28aaSamw  * Each session has an I/O semaphore to serialize communication with
746da6c28aaSamw  * the client. For example, after receiving a raw-read request, the
747da6c28aaSamw  * server is not allowed to send an oplock break to the client until
748da6c28aaSamw  * after it has sent the raw-read data.
749da6c28aaSamw  */
750da6c28aaSamw #define	SMB_SESSION_INACTIVITY_TIMEOUT		(15 * 60)
751da6c28aaSamw 
752e3f2c991SKeyur Desai #define	SMB_SESSION_OFILE_MAX			(16 * 1024)
753da6c28aaSamw 
754da6c28aaSamw /*
755da6c28aaSamw  * When a connection is set up we need to remember both the client
756da6c28aaSamw  * (peer) IP address and the local IP address used to establish the
757da6c28aaSamw  * connection. When a client connects with a vc number of zero, we
758da6c28aaSamw  * are supposed to abort any existing connections with that client
759da6c28aaSamw  * (see notes in smb_negotiate.c and smb_session_setup_andx.c). For
760da6c28aaSamw  * servers with multiple network interfaces or IP aliases, however,
761da6c28aaSamw  * each interface has to be managed independently since the client
762da6c28aaSamw  * is not aware of the server configuration. We have to allow the
763da6c28aaSamw  * client to establish a connection on each interface with a vc
764da6c28aaSamw  * number of zero without aborting the other connections.
765da6c28aaSamw  *
766da6c28aaSamw  * ipaddr:       the client (peer) IP address for the session.
767da6c28aaSamw  * local_ipaddr: the local IP address used to connect to the server.
768da6c28aaSamw  */
769da6c28aaSamw 
770da6c28aaSamw #define	SMB_MAC_KEYSZ	512
771da6c28aaSamw 
772da6c28aaSamw struct smb_sign {
773da6c28aaSamw 	unsigned int seqnum;
774da6c28aaSamw 	unsigned int mackey_len;
775da6c28aaSamw 	unsigned int flags;
776da6c28aaSamw 	unsigned char mackey[SMB_MAC_KEYSZ];
777da6c28aaSamw };
778da6c28aaSamw 
779da6c28aaSamw #define	SMB_SIGNING_ENABLED	1
780da6c28aaSamw #define	SMB_SIGNING_CHECK	2
781da6c28aaSamw 
782da6c28aaSamw /*
783da6c28aaSamw  * Session State Machine
784da6c28aaSamw  * ---------------------
785da6c28aaSamw  *
786da6c28aaSamw  * +-----------------------------+	     +------------------------------+
787da6c28aaSamw  * | SMB_SESSION_STATE_CONNECTED |           | SMB_SESSION_STATE_TERMINATED |
788da6c28aaSamw  * +-----------------------------+           +------------------------------+
789da6c28aaSamw  *		T0|					     ^
790da6c28aaSamw  *		  +--------------------+		     |T13
791da6c28aaSamw  *		  v		       |T14                  |
792da6c28aaSamw  * +-------------------------------+   |    +--------------------------------+
793da6c28aaSamw  * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED |
794da6c28aaSamw  * +-------------------------------+        +--------------------------------+
795da6c28aaSamw  *		T1|				^	   ^ ^ ^
796da6c28aaSamw  *		  +----------+			|T9        | | |
797da6c28aaSamw  *                           v			|          | | |
798da6c28aaSamw  *                  +------------------------------+       | | |
799da6c28aaSamw  *                  | SMB_SESSION_STATE_NEGOTIATED |       | | |
800da6c28aaSamw  *                  +------------------------------+       | | |
801da6c28aaSamw  *	                 ^|   ^|   | ^                     | | |
802da6c28aaSamw  *      +----------------+|   ||   | |                     | | |
803da6c28aaSamw  *      |+----------------+   || T7| |T8                   | | |
804da6c28aaSamw  *      ||                    ||   | |                     | | |
805da6c28aaSamw  *      ||   +----------------+|   | |                     | | |
806da6c28aaSamw  *      ||   |+----------------+   | |                     | | |
807da6c28aaSamw  *	||   ||			   v |                     | | |
808da6c28aaSamw  *      ||   ||   +-----------------------------------+ T10| | |
809da6c28aaSamw  *      ||   ||   | SMB_SESSION_STATE_OPLOCK_BREAKING |----+ | |
810da6c28aaSamw  *      ||   ||   +-----------------------------------+      | |
811da6c28aaSamw  *	||   ||T5                                            | |
812da6c28aaSamw  *      ||   |+-->+-----------------------------------+	  T11| |
813da6c28aaSamw  *      ||   |T6  | SMB_SESSION_STATE_READ_RAW_ACTIVE |------+ |
814da6c28aaSamw  *      ||   +----+-----------------------------------+        |
815da6c28aaSamw  *	||T3                                                   |
816da6c28aaSamw  *      |+------->+------------------------------------+    T12|
817da6c28aaSamw  *      |T4       | SMB_SESSION_STATE_WRITE_RAW_ACTIVE |-------+
818da6c28aaSamw  *      +---------+------------------------------------+
819da6c28aaSamw  *
820da6c28aaSamw  * Transition T0
821da6c28aaSamw  *
822da6c28aaSamw  *
823da6c28aaSamw  *
824da6c28aaSamw  * Transition T1
825da6c28aaSamw  *
826da6c28aaSamw  *
827da6c28aaSamw  *
828da6c28aaSamw  * Transition T2
829da6c28aaSamw  *
830da6c28aaSamw  *
831da6c28aaSamw  *
832da6c28aaSamw  * Transition T3
833da6c28aaSamw  *
834da6c28aaSamw  *
835da6c28aaSamw  *
836da6c28aaSamw  * Transition T4
837da6c28aaSamw  *
838da6c28aaSamw  *
839da6c28aaSamw  *
840da6c28aaSamw  * Transition T5
841da6c28aaSamw  *
842da6c28aaSamw  *
843da6c28aaSamw  *
844da6c28aaSamw  * Transition T6
845da6c28aaSamw  *
846da6c28aaSamw  *
847da6c28aaSamw  *
848da6c28aaSamw  * Transition T7
849da6c28aaSamw  *
850da6c28aaSamw  *
851da6c28aaSamw  *
852da6c28aaSamw  * Transition T8
853da6c28aaSamw  *
854da6c28aaSamw  *
855da6c28aaSamw  *
856da6c28aaSamw  * Transition T9
857da6c28aaSamw  *
858da6c28aaSamw  *
859da6c28aaSamw  *
860da6c28aaSamw  * Transition T10
861da6c28aaSamw  *
862da6c28aaSamw  *
863da6c28aaSamw  *
864da6c28aaSamw  * Transition T11
865da6c28aaSamw  *
866da6c28aaSamw  *
867da6c28aaSamw  *
868da6c28aaSamw  * Transition T12
869da6c28aaSamw  *
870da6c28aaSamw  *
871da6c28aaSamw  *
872da6c28aaSamw  * Transition T13
873da6c28aaSamw  *
874da6c28aaSamw  *
875da6c28aaSamw  *
876da6c28aaSamw  * Transition T14
877da6c28aaSamw  *
878da6c28aaSamw  *
879da6c28aaSamw  *
880da6c28aaSamw  */
8812c2961f8Sjose borrego #define	SMB_SESSION_MAGIC	0x53455353	/* 'SESS' */
8829fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_SESSION_VALID(p)	\
8839fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((p) != NULL) && ((p)->s_magic == SMB_SESSION_MAGIC))
884da6c28aaSamw 
885da6c28aaSamw typedef enum {
886faa1795aSjb 	SMB_SESSION_STATE_INITIALIZED = 0,
887faa1795aSjb 	SMB_SESSION_STATE_DISCONNECTED,
888da6c28aaSamw 	SMB_SESSION_STATE_CONNECTED,
889da6c28aaSamw 	SMB_SESSION_STATE_ESTABLISHED,
890da6c28aaSamw 	SMB_SESSION_STATE_NEGOTIATED,
891da6c28aaSamw 	SMB_SESSION_STATE_OPLOCK_BREAKING,
892da6c28aaSamw 	SMB_SESSION_STATE_WRITE_RAW_ACTIVE,
8932c2961f8Sjose borrego 	SMB_SESSION_STATE_READ_RAW_ACTIVE,
8946537f381Sas 	SMB_SESSION_STATE_TERMINATED,
8956537f381Sas 	SMB_SESSION_STATE_SENTINEL
896da6c28aaSamw } smb_session_state_t;
897da6c28aaSamw 
898faa1795aSjb typedef struct smb_session {
899da6c28aaSamw 	uint32_t		s_magic;
900da6c28aaSamw 	smb_rwx_t		s_lock;
901da6c28aaSamw 	list_node_t		s_lnd;
902da6c28aaSamw 	uint64_t		s_kid;
903da6c28aaSamw 	smb_session_state_t	s_state;
904da6c28aaSamw 	uint32_t		s_flags;
905da6c28aaSamw 	int			s_write_raw_status;
906faa1795aSjb 	kthread_t		*s_thread;
907faa1795aSjb 	kt_did_t		s_ktdid;
908faa1795aSjb 	smb_kmod_cfg_t		s_cfg;
909faa1795aSjb 	kmem_cache_t		*s_cache;
910faa1795aSjb 	kmem_cache_t		*s_cache_request;
911faa1795aSjb 	struct smb_server	*s_server;
912c8ec8eeaSjose borrego 	int32_t			s_gmtoff;
913da6c28aaSamw 	uint32_t		keep_alive;
914da6c28aaSamw 	uint64_t		opentime;
915da6c28aaSamw 	uint16_t		vcnumber;
916da6c28aaSamw 	uint16_t		s_local_port;
9177f667e74Sjose borrego 	smb_inaddr_t		ipaddr;
9187f667e74Sjose borrego 	smb_inaddr_t		local_ipaddr;
919da6c28aaSamw 	char 			workstation[SMB_PI_MAX_HOST];
920da6c28aaSamw 	int			dialect;
921da6c28aaSamw 	int			native_os;
922148c5f43SAlan Wright 	int			native_lm;
923148c5f43SAlan Wright 
924da6c28aaSamw 	uint32_t		capabilities;
925da6c28aaSamw 	struct smb_sign		signing;
926da6c28aaSamw 
9270f1702c5SYu Xiangning 	ksocket_t		sock;
928da6c28aaSamw 
929da6c28aaSamw 	smb_slist_t		s_req_list;
930da6c28aaSamw 	smb_llist_t		s_xa_list;
931da6c28aaSamw 	smb_llist_t		s_user_list;
932da6c28aaSamw 	smb_idpool_t		s_uid_pool;
9335cdbe942Sjb 	smb_txlst_t		s_txlst;
934da6c28aaSamw 
935da6c28aaSamw 	volatile uint32_t	s_tree_cnt;
936da6c28aaSamw 	volatile uint32_t	s_file_cnt;
937da6c28aaSamw 	volatile uint32_t	s_dir_cnt;
938da6c28aaSamw 
939da6c28aaSamw 	uint16_t		secmode;
940da6c28aaSamw 	uint32_t		sesskey;
941da6c28aaSamw 	uint32_t		challenge_len;
942da6c28aaSamw 	unsigned char		challenge_key[8];
943da6c28aaSamw 	unsigned char		MAC_key[44];
944da6c28aaSamw 	int64_t			activity_timestamp;
945da6c28aaSamw 	/*
946da6c28aaSamw 	 * Maximum negotiated buffer size between SMB client and server
947da6c28aaSamw 	 * in SMB_SESSION_SETUP_ANDX
948da6c28aaSamw 	 */
949da6c28aaSamw 	uint16_t		smb_msg_size;
950da6c28aaSamw 	uchar_t			*outpipe_data;
951da6c28aaSamw 	int			outpipe_datalen;
952da6c28aaSamw 	int			outpipe_cookie;
9532c2961f8Sjose borrego 	list_t			s_oplock_brkreqs;
954148c5f43SAlan Wright 	smb_srqueue_t		*s_srqueue;
955faa1795aSjb } smb_session_t;
956da6c28aaSamw 
957da6c28aaSamw #define	SMB_USER_MAGIC 0x55534552	/* 'USER' */
9589fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_USER_VALID(u)	\
9599fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((u) != NULL) && ((u)->u_magic == SMB_USER_MAGIC))
960da6c28aaSamw 
961da6c28aaSamw #define	SMB_USER_FLAG_GUEST			SMB_ATF_GUEST
962da6c28aaSamw #define	SMB_USER_FLAG_IPC			SMB_ATF_ANON
963da6c28aaSamw #define	SMB_USER_FLAG_ADMIN			SMB_ATF_ADMIN
964da6c28aaSamw #define	SMB_USER_FLAG_POWER_USER		SMB_ATF_POWERUSER
965da6c28aaSamw #define	SMB_USER_FLAG_BACKUP_OPERATOR		SMB_ATF_BACKUPOP
966da6c28aaSamw 
967148c5f43SAlan Wright #define	SMB_USER_IS_ADMIN(U)	(((U)->u_flags & SMB_USER_FLAG_ADMIN) != 0)
968148c5f43SAlan Wright #define	SMB_USER_IS_GUEST(U)	(((U)->u_flags & SMB_USER_FLAG_GUEST) != 0)
969148c5f43SAlan Wright 
970da6c28aaSamw #define	SMB_USER_PRIV_TAKE_OWNERSHIP	0x00000001
971da6c28aaSamw #define	SMB_USER_PRIV_BACKUP		0x00000002
972da6c28aaSamw #define	SMB_USER_PRIV_RESTORE		0x00000004
973da6c28aaSamw #define	SMB_USER_PRIV_SECURITY		0x00000008
974da6c28aaSamw 
975da6c28aaSamw 
976da6c28aaSamw typedef enum {
977da6c28aaSamw 	SMB_USER_STATE_LOGGED_IN = 0,
978da6c28aaSamw 	SMB_USER_STATE_LOGGING_OFF,
9796537f381Sas 	SMB_USER_STATE_LOGGED_OFF,
9806537f381Sas 	SMB_USER_STATE_SENTINEL
981da6c28aaSamw } smb_user_state_t;
982da6c28aaSamw 
983da6c28aaSamw typedef struct smb_user {
984da6c28aaSamw 	uint32_t		u_magic;
985da6c28aaSamw 	list_node_t		u_lnd;
986da6c28aaSamw 	kmutex_t		u_mutex;
987da6c28aaSamw 	smb_user_state_t	u_state;
988da6c28aaSamw 
989faa1795aSjb 	struct smb_server	*u_server;
990da6c28aaSamw 	smb_session_t		*u_session;
991da6c28aaSamw 	uint16_t		u_name_len;
992da6c28aaSamw 	char			*u_name;
993da6c28aaSamw 	uint16_t		u_domain_len;
994da6c28aaSamw 	char			*u_domain;
995da6c28aaSamw 	time_t			u_logon_time;
996da6c28aaSamw 	cred_t			*u_cred;
997b89a8333Snatalie li - Sun Microsystems - Irvine United States 	cred_t			*u_privcred;
998da6c28aaSamw 
999da6c28aaSamw 	smb_llist_t		u_tree_list;
1000da6c28aaSamw 	smb_idpool_t		u_tid_pool;
1001da6c28aaSamw 
1002da6c28aaSamw 	uint32_t		u_refcnt;
1003da6c28aaSamw 	uint32_t		u_flags;
1004da6c28aaSamw 	uint32_t		u_privileges;
1005da6c28aaSamw 	uint16_t		u_uid;
1006da6c28aaSamw 	uint32_t		u_audit_sid;
1007da6c28aaSamw } smb_user_t;
1008da6c28aaSamw 
1009c8ec8eeaSjose borrego #define	SMB_TREE_MAGIC			0x54524545	/* 'TREE' */
10109fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_VALID(p)	\
10119fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT((p != NULL) && ((p)->t_magic == SMB_TREE_MAGIC))
1012c8ec8eeaSjose borrego 
1013c8ec8eeaSjose borrego #define	SMB_TYPENAMELEN			_ST_FSTYPSZ
1014c8ec8eeaSjose borrego #define	SMB_VOLNAMELEN			32
1015c8ec8eeaSjose borrego 
1016c8ec8eeaSjose borrego #define	SMB_TREE_READONLY		0x00000001
1017c8ec8eeaSjose borrego #define	SMB_TREE_SUPPORTS_ACLS		0x00000002
1018c8ec8eeaSjose borrego #define	SMB_TREE_STREAMS		0x00000004
1019c8ec8eeaSjose borrego #define	SMB_TREE_CASEINSENSITIVE	0x00000008
1020c8ec8eeaSjose borrego #define	SMB_TREE_NO_CASESENSITIVE	0x00000010
1021c8ec8eeaSjose borrego #define	SMB_TREE_NO_EXPORT		0x00000020
1022cb174861Sjoyce mcintosh #define	SMB_TREE_OPLOCKS		0x00000040
1023cb174861Sjoyce mcintosh #define	SMB_TREE_SHORTNAMES		0x00000080
1024c8ec8eeaSjose borrego #define	SMB_TREE_XVATTR			0x00000100
1025c8ec8eeaSjose borrego #define	SMB_TREE_DIRENTFLAGS		0x00000200
1026c8ec8eeaSjose borrego #define	SMB_TREE_ACLONCREATE		0x00000400
1027c8ec8eeaSjose borrego #define	SMB_TREE_ACEMASKONACCESS	0x00000800
1028c8ec8eeaSjose borrego #define	SMB_TREE_NFS_MOUNTED		0x00001000
1029fc724630SAlan Wright #define	SMB_TREE_UNICODE_ON_DISK	0x00002000
10308b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_CATIA			0x00004000
1031e3f2c991SKeyur Desai #define	SMB_TREE_ABE			0x00008000
10329fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_QUOTA			0x00010000
10339fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_DFSROOT		0x00020000
1034fd9ee8b5Sjoyce mcintosh #define	SMB_TREE_SPARSE			0x00040000
10355f1ef25cSAram Hăvărneanu #define	SMB_TREE_TRAVERSE_MOUNTS	0x00080000
10362c1b14e5Sjose borrego 
1037da6c28aaSamw typedef enum {
1038da6c28aaSamw 	SMB_TREE_STATE_CONNECTED = 0,
1039da6c28aaSamw 	SMB_TREE_STATE_DISCONNECTING,
10406537f381Sas 	SMB_TREE_STATE_DISCONNECTED,
10416537f381Sas 	SMB_TREE_STATE_SENTINEL
1042da6c28aaSamw } smb_tree_state_t;
1043da6c28aaSamw 
1044da6c28aaSamw typedef struct smb_tree {
1045da6c28aaSamw 	uint32_t		t_magic;
1046da6c28aaSamw 	kmutex_t		t_mutex;
1047da6c28aaSamw 	list_node_t		t_lnd;
1048da6c28aaSamw 	smb_tree_state_t	t_state;
1049da6c28aaSamw 
1050faa1795aSjb 	struct smb_server	*t_server;
1051da6c28aaSamw 	smb_session_t		*t_session;
1052da6c28aaSamw 	smb_user_t		*t_user;
1053da6c28aaSamw 	smb_node_t		*t_snode;
1054da6c28aaSamw 
1055da6c28aaSamw 	smb_llist_t		t_ofile_list;
1056da6c28aaSamw 	smb_idpool_t		t_fid_pool;
1057da6c28aaSamw 
1058da6c28aaSamw 	smb_llist_t		t_odir_list;
10597f667e74Sjose borrego 	smb_idpool_t		t_odid_pool;
1060da6c28aaSamw 
1061da6c28aaSamw 	uint32_t		t_refcnt;
1062da6c28aaSamw 	uint32_t		t_flags;
1063da6c28aaSamw 	int32_t			t_res_type;
1064da6c28aaSamw 	uint16_t		t_tid;
1065da6c28aaSamw 	uint16_t		t_umask;
1066da6c28aaSamw 	char			t_sharename[MAXNAMELEN];
1067da6c28aaSamw 	char			t_resource[MAXPATHLEN];
1068c8ec8eeaSjose borrego 	char			t_typename[SMB_TYPENAMELEN];
1069c8ec8eeaSjose borrego 	char			t_volume[SMB_VOLNAMELEN];
1070da6c28aaSamw 	acl_type_t		t_acltype;
1071743a77edSAlan Wright 	uint32_t		t_access;
1072148c5f43SAlan Wright 	uint32_t		t_execflags;
10731fcced4cSJordan Brown 	time_t			t_connect_time;
10741fcced4cSJordan Brown 	volatile uint32_t	t_open_files;
1075da6c28aaSamw } smb_tree_t;
1076da6c28aaSamw 
1077c8ec8eeaSjose borrego #define	SMB_TREE_VFS(tree)	((tree)->t_snode->vp->v_vfsp)
1078c8ec8eeaSjose borrego #define	SMB_TREE_FSID(tree)	((tree)->t_snode->vp->v_vfsp->vfs_fsid)
1079c8ec8eeaSjose borrego 
1080743a77edSAlan Wright #define	SMB_TREE_IS_READONLY(sr)					\
1081743a77edSAlan Wright 	((sr) != NULL && (sr)->tid_tree != NULL &&			\
1082743a77edSAlan Wright 	!((sr)->tid_tree->t_access & ACE_ALL_WRITE_PERMS))
1083c8ec8eeaSjose borrego 
1084c8ec8eeaSjose borrego #define	SMB_TREE_IS_CASEINSENSITIVE(sr)                                 \
1085c8ec8eeaSjose borrego 	(((sr) && (sr)->tid_tree) ?                                     \
1086c8ec8eeaSjose borrego 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0)
1087da6c28aaSamw 
1088743a77edSAlan Wright #define	SMB_TREE_HAS_ACCESS(sr, acemask)				\
1089743a77edSAlan Wright 	((sr) == NULL ? ACE_ALL_PERMS : (				\
1090743a77edSAlan Wright 	(((sr) && (sr)->tid_tree) ?					\
1091743a77edSAlan Wright 	(((sr)->tid_tree->t_access) & (acemask)) : 0)))
1092743a77edSAlan Wright 
10938b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_SUPPORTS_CATIA(sr)            				\
10948b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	(((sr) && (sr)->tid_tree) ?                                     \
10958b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CATIA) : 0)
10968b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 
1097e3f2c991SKeyur Desai #define	SMB_TREE_SUPPORTS_ABE(sr)            				\
1098e3f2c991SKeyur Desai 	(((sr) && (sr)->tid_tree) ?                                     \
1099e3f2c991SKeyur Desai 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_ABE) : 0)
1100e3f2c991SKeyur Desai 
11019fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_IS_DFSROOT(sr)            				\
11029fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	(((sr) && (sr)->tid_tree) ?                                     \
11039fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_DFSROOT) : 0)
11049fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
1105cb174861Sjoyce mcintosh #define	SMB_TREE_SUPPORTS_SHORTNAMES(sr)				\
1106cb174861Sjoyce mcintosh 	(((sr) && (sr)->tid_tree) ?					\
1107cb174861Sjoyce mcintosh 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_SHORTNAMES) : 0)
1108cb174861Sjoyce mcintosh 
1109da6c28aaSamw /*
11105f1ef25cSAram Hăvărneanu  * SMB_TREE_CONTAINS_NODE is used to check if a node is on the same
11115f1ef25cSAram Hăvărneanu  * file system as the tree's root filesystem, or if mount point traversal
11125f1ef25cSAram Hăvărneanu  * should be allowed.  Note that this is also called in some cases with
11135f1ef25cSAram Hăvărneanu  * sr=NULL, where it is expected to evaluate to TRUE.
1114da6c28aaSamw  */
11155f1ef25cSAram Hăvărneanu 
1116c8ec8eeaSjose borrego #define	SMB_TREE_CONTAINS_NODE(sr, node)                                \
11175f1ef25cSAram Hăvărneanu 	((sr) == NULL || (sr)->tid_tree == NULL ||                      \
11185f1ef25cSAram Hăvărneanu 	SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node) ||           \
11195f1ef25cSAram Hăvărneanu 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_TRAVERSE_MOUNTS))
1120da6c28aaSamw 
1121da6c28aaSamw /*
1122c8ec8eeaSjose borrego  * SMB_OFILE_IS_READONLY reflects whether an ofile is readonly or not.
1123c8ec8eeaSjose borrego  * The macro takes into account
1124c8ec8eeaSjose borrego  *      - the tree readonly state
1125c8ec8eeaSjose borrego  *      - the node readonly state
1126c8ec8eeaSjose borrego  *      - whether the specified ofile is the readonly creator
1127c8ec8eeaSjose borrego  * The readonly creator has write permission until the ofile is closed.
1128da6c28aaSamw  */
1129da6c28aaSamw 
1130c8ec8eeaSjose borrego #define	SMB_OFILE_IS_READONLY(of)                               \
1131c8ec8eeaSjose borrego 	(((of)->f_flags & SMB_OFLAGS_READONLY) ||               \
1132037cac00Sjoyce mcintosh 	smb_node_file_is_readonly((of)->f_node) ||                   \
1133c8ec8eeaSjose borrego 	(((of)->f_node->readonly_creator) &&                    \
1134c8ec8eeaSjose borrego 	((of)->f_node->readonly_creator != (of))))
1135da6c28aaSamw 
1136c8ec8eeaSjose borrego /*
1137c8ec8eeaSjose borrego  * SMB_PATHFILE_IS_READONLY indicates whether or not a file is
1138c8ec8eeaSjose borrego  * readonly when the caller has a path rather than an ofile.  Unlike
1139c8ec8eeaSjose borrego  * SMB_OFILE_IS_READONLY, the caller cannot be the readonly creator,
1140c8ec8eeaSjose borrego  * since that requires an ofile.
1141c8ec8eeaSjose borrego  */
1142da6c28aaSamw 
1143c8ec8eeaSjose borrego #define	SMB_PATHFILE_IS_READONLY(sr, node)                       \
1144c8ec8eeaSjose borrego 	(SMB_TREE_IS_READONLY((sr)) ||                           \
1145037cac00Sjoyce mcintosh 	smb_node_file_is_readonly((node)) ||                          \
1146c8ec8eeaSjose borrego 	((node)->readonly_creator))
1147da6c28aaSamw 
11489fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_OPIPE_MAGIC		0x50495045	/* 'PIPE' */
11499fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_OPIPE_VALID(p)	\
11509fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((p) != NULL) && (p)->p_magic == SMB_OPIPE_MAGIC)
1151da6c28aaSamw 
11523db3f65cSamw /*
11533db3f65cSamw  * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used
11543db3f65cSamw  * at the interface between SMB and NDR RPC.
11553db3f65cSamw  */
11563db3f65cSamw typedef struct smb_opipe {
11579fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		p_magic;
11589fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_node_t		p_lnd;
11599fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmutex_t		p_mutex;
11609fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kcondvar_t		p_cv;
11619fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_server	*p_server;
11629fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_event	*p_event;
11639fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	char			*p_name;
11649fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		p_busy;
11659fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_doorhdr_t		p_hdr;
11669fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_netuserinfo_t	p_user;
11679fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint8_t			*p_doorbuf;
11689fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint8_t			*p_data;
11693db3f65cSamw } smb_opipe_t;
11703db3f65cSamw 
1171da6c28aaSamw /*
1172da6c28aaSamw  * The of_ftype	of an open file should contain the SMB_FTYPE value
1173bbf6f00cSJordan Brown  * returned when the file/pipe was opened. The following
1174da6c28aaSamw  * assumptions are currently made:
1175da6c28aaSamw  *
1176da6c28aaSamw  * File Type	    Node       PipeInfo
1177da6c28aaSamw  * ---------	    --------   --------
1178da6c28aaSamw  * SMB_FTYPE_DISK       Valid      Null
1179da6c28aaSamw  * SMB_FTYPE_BYTE_PIPE  Undefined  Undefined
1180da6c28aaSamw  * SMB_FTYPE_MESG_PIPE  Null       Valid
1181da6c28aaSamw  * SMB_FTYPE_PRINTER    Undefined  Undefined
1182da6c28aaSamw  * SMB_FTYPE_UNKNOWN    Undefined  Undefined
1183da6c28aaSamw  */
1184da6c28aaSamw 
1185da6c28aaSamw /*
1186da6c28aaSamw  * Some flags for ofile structure
1187da6c28aaSamw  *
1188da6c28aaSamw  *	SMB_OFLAGS_SET_DELETE_ON_CLOSE
1189da6c28aaSamw  *   Set this flag when the corresponding open operation whose
1190da6c28aaSamw  *   DELETE_ON_CLOSE bit of the CreateOptions is set. If any
1191da6c28aaSamw  *   open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE
1192da6c28aaSamw  *   will be set for the file node upon close.
1193037cac00Sjoyce mcintosh  *
1194037cac00Sjoyce mcintosh  *	SMB_OFLAGS_TIMESTAMPS_PENDING
1195037cac00Sjoyce mcintosh  *   This flag gets set when a write operation is performed on the
1196037cac00Sjoyce mcintosh  *   ofile. The timestamps will be updated, and the flags cleared,
1197037cac00Sjoyce mcintosh  *   when the ofile gets closed or a setattr is performed on the ofile.
1198da6c28aaSamw  */
1199da6c28aaSamw 
1200c8ec8eeaSjose borrego #define	SMB_OFLAGS_READONLY		0x0001
12012c2961f8Sjose borrego #define	SMB_OFLAGS_EXECONLY		0x0002
1202da6c28aaSamw #define	SMB_OFLAGS_SET_DELETE_ON_CLOSE	0x0004
1203da6c28aaSamw #define	SMB_OFLAGS_LLF_POS_VALID	0x0008
1204037cac00Sjoyce mcintosh #define	SMB_OFLAGS_TIMESTAMPS_PENDING	0x0010
1205da6c28aaSamw 
1206da6c28aaSamw #define	SMB_OFILE_MAGIC 	0x4F464C45	/* 'OFLE' */
12079fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_OFILE_VALID(p)	\
12089fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT((p != NULL) && ((p)->f_magic == SMB_OFILE_MAGIC))
1209da6c28aaSamw 
1210da6c28aaSamw typedef enum {
1211da6c28aaSamw 	SMB_OFILE_STATE_OPEN = 0,
1212da6c28aaSamw 	SMB_OFILE_STATE_CLOSING,
12136537f381Sas 	SMB_OFILE_STATE_CLOSED,
12146537f381Sas 	SMB_OFILE_STATE_SENTINEL
1215da6c28aaSamw } smb_ofile_state_t;
1216da6c28aaSamw 
1217da6c28aaSamw typedef struct smb_ofile {
1218da6c28aaSamw 	uint32_t		f_magic;
1219da6c28aaSamw 	kmutex_t		f_mutex;
1220da6c28aaSamw 	list_node_t		f_lnd;
1221da6c28aaSamw 	list_node_t		f_nnd;
1222da6c28aaSamw 	smb_ofile_state_t	f_state;
1223da6c28aaSamw 
1224faa1795aSjb 	struct smb_server	*f_server;
1225da6c28aaSamw 	smb_session_t		*f_session;
1226da6c28aaSamw 	smb_user_t		*f_user;
1227da6c28aaSamw 	smb_tree_t		*f_tree;
1228da6c28aaSamw 	smb_node_t		*f_node;
12293db3f65cSamw 	smb_opipe_t		*f_pipe;
1230da6c28aaSamw 
1231dc20a302Sas 	uint32_t		f_uniqid;
1232da6c28aaSamw 	uint32_t		f_refcnt;
1233da6c28aaSamw 	uint64_t		f_seek_pos;
1234da6c28aaSamw 	uint32_t		f_flags;
1235da6c28aaSamw 	uint32_t		f_granted_access;
1236da6c28aaSamw 	uint32_t		f_share_access;
1237da6c28aaSamw 	uint32_t		f_create_options;
1238da6c28aaSamw 	uint16_t		f_fid;
1239da6c28aaSamw 	uint16_t		f_opened_by_pid;
1240da6c28aaSamw 	uint16_t		f_ftype;
1241da6c28aaSamw 	uint64_t		f_llf_pos;
12428c10a865Sas 	int			f_mode;
1243da6c28aaSamw 	cred_t			*f_cr;
12446537f381Sas 	pid_t			f_pid;
1245037cac00Sjoyce mcintosh 	uint32_t		f_explicit_times;
12469fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	char			f_quota_resume[SMB_SID_STRSZ];
12471fdeec65Sjoyce mcintosh 	smb_oplock_grant_t	f_oplock_grant;
1248da6c28aaSamw } smb_ofile_t;
1249da6c28aaSamw 
12507f667e74Sjose borrego #define	SMB_ODIR_MAGIC 		0x4F444952	/* 'ODIR' */
12519fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_VALID(p)	\
12529fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT((p != NULL) && ((p)->d_magic == SMB_ODIR_MAGIC))
12539fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
12547f667e74Sjose borrego #define	SMB_ODIR_BUFSIZE	(8 * 1024)
1255da6c28aaSamw 
12568b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_WILDCARDS		0x0001
12578b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_IGNORE_CASE	0x0002
12588b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_XATTR		0x0004
12598b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_EDIRENT		0x0008
12608b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_CATIA		0x0010
1261e3f2c991SKeyur Desai #define	SMB_ODIR_FLAG_ABE		0x0020
1262cb174861Sjoyce mcintosh #define	SMB_ODIR_FLAG_SHORTNAMES	0x0040
12638b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 
1264da6c28aaSamw typedef enum {
1265da6c28aaSamw 	SMB_ODIR_STATE_OPEN = 0,
1266a1511e6bSjoyce mcintosh 	SMB_ODIR_STATE_IN_USE,
1267da6c28aaSamw 	SMB_ODIR_STATE_CLOSING,
12686537f381Sas 	SMB_ODIR_STATE_CLOSED,
12696537f381Sas 	SMB_ODIR_STATE_SENTINEL
1270da6c28aaSamw } smb_odir_state_t;
1271da6c28aaSamw 
12727f667e74Sjose borrego typedef enum {
1273bfbce3c1SGordon Ross 	SMB_ODIR_RESUME_CONT,
12747f667e74Sjose borrego 	SMB_ODIR_RESUME_IDX,
12757f667e74Sjose borrego 	SMB_ODIR_RESUME_COOKIE,
12767f667e74Sjose borrego 	SMB_ODIR_RESUME_FNAME
12777f667e74Sjose borrego } smb_odir_resume_type_t;
12787f667e74Sjose borrego 
12797f667e74Sjose borrego typedef struct smb_odir_resume {
12807f667e74Sjose borrego 	smb_odir_resume_type_t	or_type;
12817f667e74Sjose borrego 	int			or_idx;
12827f667e74Sjose borrego 	uint32_t		or_cookie;
12837f667e74Sjose borrego 	char			*or_fname;
12847f667e74Sjose borrego } smb_odir_resume_t;
12857f667e74Sjose borrego 
1286eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States /*
1287eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States  * Flags used when opening an odir
1288eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States  */
1289eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_OPENF_BACKUP_INTENT	0x01
1290eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 
1291da6c28aaSamw typedef struct smb_odir {
1292da6c28aaSamw 	uint32_t		d_magic;
1293da6c28aaSamw 	kmutex_t		d_mutex;
1294da6c28aaSamw 	list_node_t		d_lnd;
1295da6c28aaSamw 	smb_odir_state_t	d_state;
1296da6c28aaSamw 	smb_session_t		*d_session;
1297da6c28aaSamw 	smb_tree_t		*d_tree;
12987f667e74Sjose borrego 	smb_node_t		*d_dnode;
1299eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	cred_t			*d_cred;
13007f667e74Sjose borrego 	uint16_t		d_odid;
1301da6c28aaSamw 	uint16_t		d_opened_by_pid;
1302da6c28aaSamw 	uint16_t		d_sattr;
13037f667e74Sjose borrego 	uint32_t		d_refcnt;
13048b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		d_flags;
13057f667e74Sjose borrego 	boolean_t		d_eof;
13067f667e74Sjose borrego 	int			d_bufsize;
13077f667e74Sjose borrego 	uint64_t		d_offset;
13087f667e74Sjose borrego 	union {
13097f667e74Sjose borrego 		char		*u_bufptr;
13107f667e74Sjose borrego 		edirent_t	*u_edp;
13117f667e74Sjose borrego 		dirent64_t	*u_dp;
13127f667e74Sjose borrego 	} d_u;
1313bfbce3c1SGordon Ross 	uint32_t		d_last_cookie;
13147f667e74Sjose borrego 	uint32_t		d_cookies[SMB_MAX_SEARCH];
1315da6c28aaSamw 	char			d_pattern[MAXNAMELEN];
13167f667e74Sjose borrego 	char			d_buf[SMB_ODIR_BUFSIZE];
1317bfbce3c1SGordon Ross 	char			d_last_name[MAXNAMELEN];
1318da6c28aaSamw } smb_odir_t;
13197f667e74Sjose borrego #define	d_bufptr	d_u.u_bufptr
13207f667e74Sjose borrego #define	d_edp		d_u.u_edp
13217f667e74Sjose borrego #define	d_dp		d_u.u_dp
13227f667e74Sjose borrego 
13237f667e74Sjose borrego typedef struct smb_odirent {
13247f667e74Sjose borrego 	char		od_name[MAXNAMELEN];	/* on disk name */
13257f667e74Sjose borrego 	ino64_t		od_ino;
13267f667e74Sjose borrego 	uint32_t	od_eflags;
13277f667e74Sjose borrego } smb_odirent_t;
13287f667e74Sjose borrego 
13297f667e74Sjose borrego typedef struct smb_fileinfo {
13307f667e74Sjose borrego 	char		fi_name[MAXNAMELEN];
13317f667e74Sjose borrego 	char		fi_shortname[SMB_SHORTNAMELEN];
1332bfbce3c1SGordon Ross 	uint32_t	fi_cookie;	/* Dir offset (of next entry) */
13337f667e74Sjose borrego 	uint32_t	fi_dosattr;	/* DOS attributes */
13347f667e74Sjose borrego 	uint64_t	fi_nodeid;	/* file system node id */
13357f667e74Sjose borrego 	uint64_t	fi_size;	/* file size in bytes */
13367f667e74Sjose borrego 	uint64_t	fi_alloc_size;	/* allocation size in bytes */
13377f667e74Sjose borrego 	timestruc_t	fi_atime;	/* last access */
13387f667e74Sjose borrego 	timestruc_t	fi_mtime;	/* last modification */
13397f667e74Sjose borrego 	timestruc_t	fi_ctime;	/* last status change */
13407f667e74Sjose borrego 	timestruc_t	fi_crtime;	/* file creation */
13417f667e74Sjose borrego } smb_fileinfo_t;
13427f667e74Sjose borrego 
13437f667e74Sjose borrego typedef struct smb_streaminfo {
13447f667e74Sjose borrego 	uint64_t	si_size;
1345037cac00Sjoyce mcintosh 	uint64_t	si_alloc_size;
13467f667e74Sjose borrego 	char		si_name[MAXPATHLEN];
13477f667e74Sjose borrego } smb_streaminfo_t;
1348da6c28aaSamw 
1349da6c28aaSamw #define	SMB_LOCK_MAGIC 	0x4C4F434B	/* 'LOCK' */
1350da6c28aaSamw 
1351da6c28aaSamw typedef struct smb_lock {
1352da6c28aaSamw 	uint32_t		l_magic;
1353da6c28aaSamw 	kmutex_t		l_mutex;
1354da6c28aaSamw 	list_node_t		l_lnd;
1355da6c28aaSamw 	kcondvar_t		l_cv;
1356da6c28aaSamw 
1357da6c28aaSamw 	list_node_t		l_conflict_lnd;
1358da6c28aaSamw 	smb_slist_t		l_conflict_list;
1359da6c28aaSamw 
1360da6c28aaSamw 	smb_session_t		*l_session;
1361da6c28aaSamw 	smb_ofile_t		*l_file;
1362faa1795aSjb 	struct smb_request	*l_sr;
1363da6c28aaSamw 
1364da6c28aaSamw 	uint32_t		l_flags;
1365da6c28aaSamw 	uint64_t		l_session_kid;
1366da6c28aaSamw 	struct smb_lock		*l_blocked_by; /* Debug info only */
1367da6c28aaSamw 
1368da6c28aaSamw 	uint16_t		l_pid;
1369da6c28aaSamw 	uint16_t		l_uid;
1370da6c28aaSamw 	uint32_t		l_type;
1371da6c28aaSamw 	uint64_t		l_start;
1372da6c28aaSamw 	uint64_t		l_length;
1373da6c28aaSamw 	clock_t			l_end_time;
1374da6c28aaSamw } smb_lock_t;
1375da6c28aaSamw 
1376da6c28aaSamw #define	SMB_LOCK_FLAG_INDEFINITE	0x0004
1377da6c28aaSamw #define	SMB_LOCK_INDEFINITE_WAIT(lock) \
1378da6c28aaSamw 	((lock)->l_flags & SMB_LOCK_FLAG_INDEFINITE)
1379da6c28aaSamw 
1380da6c28aaSamw #define	SMB_LOCK_TYPE_READWRITE		101
1381da6c28aaSamw #define	SMB_LOCK_TYPE_READONLY		102
1382da6c28aaSamw 
1383faa1795aSjb typedef struct vardata_block {
13842c2961f8Sjose borrego 	uint8_t			vdb_tag;
13852c2961f8Sjose borrego 	uint32_t		vdb_len;
13862c2961f8Sjose borrego 	struct uio 		vdb_uio;
13872c2961f8Sjose borrego 	struct iovec		vdb_iovec[MAX_IOVEC];
1388faa1795aSjb } smb_vdb_t;
1389faa1795aSjb 
1390f96bd5c8SAlan Wright #define	SMB_WRMODE_WRITE_THRU	0x0001
1391f96bd5c8SAlan Wright #define	SMB_WRMODE_IS_STABLE(M)	((M) & SMB_WRMODE_WRITE_THRU)
1392f96bd5c8SAlan Wright 
1393faa1795aSjb #define	SMB_RW_MAGIC		0x52445257	/* 'RDRW' */
1394faa1795aSjb 
1395faa1795aSjb typedef struct smb_rw_param {
1396faa1795aSjb 	uint32_t rw_magic;
1397faa1795aSjb 	smb_vdb_t rw_vdb;
1398faa1795aSjb 	uint64_t rw_offset;
1399faa1795aSjb 	uint32_t rw_last_write;
1400faa1795aSjb 	uint16_t rw_mode;
1401f96bd5c8SAlan Wright 	uint32_t rw_count;		/* bytes in this request */
1402faa1795aSjb 	uint16_t rw_mincnt;
1403f96bd5c8SAlan Wright 	uint32_t rw_total;		/* total bytes (write-raw) */
1404faa1795aSjb 	uint16_t rw_dsoff;		/* SMB data offset */
1405faa1795aSjb 	uint8_t rw_andx;		/* SMB secondary andx command */
1406faa1795aSjb } smb_rw_param_t;
1407da6c28aaSamw 
1408eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_pathname {
1409eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_path;
1410eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_pname;
1411eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_fname;
1412eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_sname;
1413eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_stype;
1414eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States } smb_pathname_t;
1415eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 
1416b89a8333Snatalie li - Sun Microsystems - Irvine United States /*
1417b89a8333Snatalie li - Sun Microsystems - Irvine United States  * fs_query_info
1418b89a8333Snatalie li - Sun Microsystems - Irvine United States  */
1419b89a8333Snatalie li - Sun Microsystems - Irvine United States typedef struct smb_fqi {
1420eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_pathname_t	fq_path;
1421eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	uint16_t	fq_sattr;
1422eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_node_t	*fq_dnode;
1423eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_node_t	*fq_fnode;
1424eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_attr_t	fq_fattr;
1425eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char		fq_last_comp[MAXNAMELEN];
1426b89a8333Snatalie li - Sun Microsystems - Irvine United States } smb_fqi_t;
1427da6c28aaSamw 
1428148c5f43SAlan Wright typedef struct dirop {
1429148c5f43SAlan Wright 	smb_fqi_t	fqi;
1430148c5f43SAlan Wright 	smb_fqi_t	dst_fqi;
1431148c5f43SAlan Wright 	uint16_t	info_level;
1432148c5f43SAlan Wright 	uint16_t	flags;
1433148c5f43SAlan Wright } smb_arg_dirop_t;
1434148c5f43SAlan Wright 
14357b59d02dSjb typedef struct {
14367b59d02dSjb 	uint32_t status;
14377b59d02dSjb 	uint16_t errcls;
14387b59d02dSjb 	uint16_t errcode;
14397b59d02dSjb } smb_error_t;
1440da6c28aaSamw 
14412c2961f8Sjose borrego typedef struct open_param {
14422c2961f8Sjose borrego 	smb_fqi_t	fqi;
14432c2961f8Sjose borrego 	uint16_t	omode;
14442c2961f8Sjose borrego 	uint16_t	ofun;
14452c2961f8Sjose borrego 	uint32_t	nt_flags;
14462c2961f8Sjose borrego 	uint32_t	timeo;
14472c2961f8Sjose borrego 	uint32_t	dattr;
14482c2961f8Sjose borrego 	timestruc_t	crtime;
14492c2961f8Sjose borrego 	timestruc_t	mtime;
14502c2961f8Sjose borrego 	uint64_t	dsize;
14512c2961f8Sjose borrego 	uint32_t	desired_access;
14522c2961f8Sjose borrego 	uint32_t	share_access;
14532c2961f8Sjose borrego 	uint32_t	create_options;
14542c2961f8Sjose borrego 	uint32_t	create_disposition;
14552c2961f8Sjose borrego 	boolean_t	created_readonly;
14562c2961f8Sjose borrego 	uint32_t	ftype;
14572c2961f8Sjose borrego 	uint32_t	devstate;
14582c2961f8Sjose borrego 	uint32_t	action_taken;
14592c2961f8Sjose borrego 	uint64_t	fileid;
14602c2961f8Sjose borrego 	uint32_t	rootdirfid;
1461bbf6f00cSJordan Brown 	smb_ofile_t	*dir;
14622c2961f8Sjose borrego 	/* This is only set by NTTransactCreate */
14632c2961f8Sjose borrego 	struct smb_sd	*sd;
1464cb174861Sjoyce mcintosh 	uint8_t		op_oplock_level;	/* requested/granted level */
1465cb174861Sjoyce mcintosh 	boolean_t	op_oplock_levelII;	/* TRUE if levelII supported */
1466148c5f43SAlan Wright } smb_arg_open_t;
14672c2961f8Sjose borrego 
1468da6c28aaSamw /*
1469da6c28aaSamw  * SMB Request State Machine
1470da6c28aaSamw  * -------------------------
1471da6c28aaSamw  *
1472da6c28aaSamw  *                  T4               +------+		T0
1473da6c28aaSamw  *      +--------------------------->| FREE |---------------------------+
1474da6c28aaSamw  *      |                            +------+                           |
1475da6c28aaSamw  * +-----------+                                                        |
1476da6c28aaSamw  * | COMPLETED |                                                        |
1477da6c28aaSamw  * +-----------+
1478da6c28aaSamw  *      ^                                                               |
1479da6c28aaSamw  *      | T15                      +----------+                         v
1480da6c28aaSamw  * +------------+        T6        |          |                 +--------------+
1481da6c28aaSamw  * | CLEANED_UP |<-----------------| CANCELED |                 | INITIALIZING |
1482da6c28aaSamw  * +------------+                  |          |                 +--------------+
1483da6c28aaSamw  *      |    ^                     +----------+                         |
1484da6c28aaSamw  *      |    |                        ^  ^ ^ ^                          |
1485da6c28aaSamw  *      |    |          +-------------+  | | |                          |
1486da6c28aaSamw  *      |    |    T3    |                | | |               T13        | T1
1487da6c28aaSamw  *      |    +-------------------------+ | | +----------------------+   |
1488da6c28aaSamw  *      +----------------------------+ | | |                        |   |
1489da6c28aaSamw  *         T16          |            | | | +-----------+            |   |
1490da6c28aaSamw  *                      |           \/ | | T5          |            |   v
1491da6c28aaSamw  * +-----------------+  |   T12     +--------+         |     T2    +-----------+
1492da6c28aaSamw  * | EVENT_OCCURRED  |------------->| ACTIVE |<--------------------| SUBMITTED |
1493da6c28aaSamw  * +-----------------+  |           +--------+         |           +-----------+
1494da6c28aaSamw  *        ^             |              | ^ |           |
1495da6c28aaSamw  *        |             |           T8 | | |  T7       |
1496da6c28aaSamw  *        | T10      T9 |   +----------+ | +-------+   |  T11
1497da6c28aaSamw  *        |             |   |            +-------+ |   |
1498da6c28aaSamw  *        |             |   |               T14  | |   |
1499da6c28aaSamw  *        |             |   v                    | v   |
1500da6c28aaSamw  *      +----------------------+                +--------------+
1501da6c28aaSamw  *	|     WAITING_EVENT    |                | WAITING_LOCK |
1502da6c28aaSamw  *      +----------------------+                +--------------+
1503da6c28aaSamw  *
1504da6c28aaSamw  *
1505da6c28aaSamw  *
1506da6c28aaSamw  *
1507da6c28aaSamw  *
1508da6c28aaSamw  * Transition T0
1509da6c28aaSamw  *
1510da6c28aaSamw  * This transition occurs when the request is allocated and is still under the
1511da6c28aaSamw  * control of the session thread.
1512da6c28aaSamw  *
1513da6c28aaSamw  * Transition T1
1514da6c28aaSamw  *
1515da6c28aaSamw  * This transition occurs when the session thread dispatches a task to treat the
1516da6c28aaSamw  * request.
1517da6c28aaSamw  *
1518da6c28aaSamw  * Transition T2
1519da6c28aaSamw  *
1520da6c28aaSamw  *
1521da6c28aaSamw  *
1522da6c28aaSamw  * Transition T3
1523da6c28aaSamw  *
1524da6c28aaSamw  * A request completes and smbsr_cleanup is called to release resources
1525da6c28aaSamw  * associated with the request (but not the smb_request_t itself).  This
1526da6c28aaSamw  * includes references on smb_ofile_t, smb_node_t, and other structures.
1527da6c28aaSamw  * CLEANED_UP state exists to detect if we attempt to cleanup a request
1528da6c28aaSamw  * multiple times and to allow us to detect that we are accessing a
1529da6c28aaSamw  * request that has already been cleaned up.
1530da6c28aaSamw  *
1531da6c28aaSamw  * Transition T4
1532da6c28aaSamw  *
1533da6c28aaSamw  *
1534da6c28aaSamw  *
1535da6c28aaSamw  * Transition T5
1536da6c28aaSamw  *
1537da6c28aaSamw  *
1538da6c28aaSamw  *
1539da6c28aaSamw  * Transition T6
1540da6c28aaSamw  *
1541da6c28aaSamw  *
1542da6c28aaSamw  *
1543da6c28aaSamw  * Transition T7
1544da6c28aaSamw  *
1545da6c28aaSamw  *
1546da6c28aaSamw  *
1547da6c28aaSamw  * Transition T8
1548da6c28aaSamw  *
1549da6c28aaSamw  *
1550da6c28aaSamw  *
1551da6c28aaSamw  * Transition T9
1552da6c28aaSamw  *
1553da6c28aaSamw  *
1554da6c28aaSamw  *
1555da6c28aaSamw  * Transition T10
1556da6c28aaSamw  *
1557da6c28aaSamw  *
1558da6c28aaSamw  *
1559da6c28aaSamw  * Transition T11
1560da6c28aaSamw  *
1561da6c28aaSamw  *
1562da6c28aaSamw  *
1563da6c28aaSamw  * Transition T12
1564da6c28aaSamw  *
1565da6c28aaSamw  *
1566da6c28aaSamw  *
1567da6c28aaSamw  * Transition T13
1568da6c28aaSamw  *
1569da6c28aaSamw  *
1570da6c28aaSamw  *
1571da6c28aaSamw  * Transition T14
1572da6c28aaSamw  *
1573da6c28aaSamw  *
1574da6c28aaSamw  *
1575da6c28aaSamw  * Transition T15
1576da6c28aaSamw  *
1577da6c28aaSamw  * Request processing is completed (control returns from smb_dispatch)
1578da6c28aaSamw  *
1579da6c28aaSamw  * Transition T16
1580da6c28aaSamw  *
1581da6c28aaSamw  * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx"
1582da6c28aaSamw  * sections remain to be processed.
1583da6c28aaSamw  *
1584da6c28aaSamw  */
1585da6c28aaSamw 
1586da6c28aaSamw #define	SMB_REQ_MAGIC 		0x534D4252	/* 'SMBR' */
15872c2961f8Sjose borrego #define	SMB_REQ_VALID(p)	ASSERT((p)->sr_magic == SMB_REQ_MAGIC)
1588da6c28aaSamw 
1589da6c28aaSamw typedef enum smb_req_state {
1590da6c28aaSamw 	SMB_REQ_STATE_FREE = 0,
1591da6c28aaSamw 	SMB_REQ_STATE_INITIALIZING,
1592da6c28aaSamw 	SMB_REQ_STATE_SUBMITTED,
1593da6c28aaSamw 	SMB_REQ_STATE_ACTIVE,
1594da6c28aaSamw 	SMB_REQ_STATE_WAITING_EVENT,
1595da6c28aaSamw 	SMB_REQ_STATE_EVENT_OCCURRED,
1596da6c28aaSamw 	SMB_REQ_STATE_WAITING_LOCK,
1597da6c28aaSamw 	SMB_REQ_STATE_COMPLETED,
1598da6c28aaSamw 	SMB_REQ_STATE_CANCELED,
15996537f381Sas 	SMB_REQ_STATE_CLEANED_UP,
16006537f381Sas 	SMB_REQ_STATE_SENTINEL
1601da6c28aaSamw } smb_req_state_t;
1602da6c28aaSamw 
1603faa1795aSjb typedef struct smb_request {
1604da6c28aaSamw 	uint32_t		sr_magic;
1605da6c28aaSamw 	kmutex_t		sr_mutex;
1606da6c28aaSamw 	list_node_t		sr_session_lnd;
1607da6c28aaSamw 	smb_req_state_t		sr_state;
1608faa1795aSjb 	kmem_cache_t		*sr_cache;
1609faa1795aSjb 	struct smb_server	*sr_server;
16106537f381Sas 	pid_t			*sr_pid;
1611c8ec8eeaSjose borrego 	int32_t			sr_gmtoff;
1612faa1795aSjb 	smb_session_t		*session;
1613faa1795aSjb 	smb_kmod_cfg_t		*sr_cfg;
1614da6c28aaSamw 	smb_notify_change_req_t	sr_ncr;
1615da6c28aaSamw 
1616da6c28aaSamw 	/* Info from session service header */
1617da6c28aaSamw 	uint32_t		sr_req_length; /* Excluding NBT header */
1618da6c28aaSamw 
1619da6c28aaSamw 	/* Request buffer excluding NBT header */
1620da6c28aaSamw 	void			*sr_request_buf;
1621da6c28aaSamw 
1622da6c28aaSamw 	smb_lock_t		*sr_awaiting;
1623da6c28aaSamw 	struct mbuf_chain	command;
1624da6c28aaSamw 	struct mbuf_chain	reply;
1625da6c28aaSamw 	struct mbuf_chain	raw_data;
1626bbf6f00cSJordan Brown 	list_t			sr_storage;
1627da6c28aaSamw 	struct smb_xa		*r_xa;
1628da6c28aaSamw 	int			andx_prev_wct;
1629da6c28aaSamw 	int 			cur_reply_offset;
1630da6c28aaSamw 	int			orig_request_hdr;
1631da6c28aaSamw 	unsigned int		reply_seqnum;	/* reply sequence number */
1632da6c28aaSamw 	unsigned char		first_smb_com;	/* command code */
1633da6c28aaSamw 	unsigned char		smb_com;	/* command code */
16347b59d02dSjb 
16357b59d02dSjb 	uint8_t			smb_rcls;	/* error code class */
16367b59d02dSjb 	uint8_t			smb_reh;	/* rsvd (AH DOS INT-24 ERR) */
1637da6c28aaSamw 	uint16_t		smb_err;	/* error code */
16387b59d02dSjb 	smb_error_t		smb_error;
16397b59d02dSjb 
1640da6c28aaSamw 	uint8_t			smb_flg;	/* flags */
1641da6c28aaSamw 	uint16_t		smb_flg2;	/* flags */
1642da6c28aaSamw 	uint16_t		smb_pid_high;	/* high part of pid */
1643da6c28aaSamw 	unsigned char		smb_sig[8];	/* signiture */
1644da6c28aaSamw 	uint16_t		smb_tid;	/* tree id #  */
1645da6c28aaSamw 	uint16_t		smb_pid;	/* caller's process id # */
1646da6c28aaSamw 	uint16_t		smb_uid;	/* user id # */
1647da6c28aaSamw 	uint16_t		smb_mid;	/* mutiplex id #  */
1648da6c28aaSamw 	unsigned char		smb_wct;	/* count of parameter words */
1649da6c28aaSamw 	uint16_t		smb_bcc;	/* data byte count */
1650da6c28aaSamw 
1651da6c28aaSamw 	/* Parameters */
1652da6c28aaSamw 	struct mbuf_chain	smb_vwv;	/* variable width value */
1653da6c28aaSamw 
1654da6c28aaSamw 	/* Data */
1655da6c28aaSamw 	struct mbuf_chain	smb_data;
1656da6c28aaSamw 
1657da6c28aaSamw 	uint16_t		smb_fid;	/* not in hdr, but common */
1658da6c28aaSamw 
1659da6c28aaSamw 	unsigned char		andx_com;
1660da6c28aaSamw 	uint16_t		andx_off;
1661da6c28aaSamw 
1662da6c28aaSamw 	struct smb_tree		*tid_tree;
1663da6c28aaSamw 	struct smb_ofile	*fid_ofile;
1664da6c28aaSamw 	smb_user_t		*uid_user;
1665da6c28aaSamw 
1666da6c28aaSamw 	union {
1667148c5f43SAlan Wright 		smb_arg_negotiate_t	*negprot;
1668148c5f43SAlan Wright 		smb_arg_sessionsetup_t	*ssetup;
1669148c5f43SAlan Wright 		smb_arg_tcon_t		tcon;
1670148c5f43SAlan Wright 		smb_arg_dirop_t		dirop;
1671148c5f43SAlan Wright 		smb_arg_open_t		open;
1672148c5f43SAlan Wright 		smb_rw_param_t		*rw;
1673148c5f43SAlan Wright 		uint32_t		timestamp;
1674da6c28aaSamw 	} arg;
1675da6c28aaSamw 
1676da6c28aaSamw 	cred_t			*user_cr;
16772c2961f8Sjose borrego 	kthread_t		*sr_worker;
1678148c5f43SAlan Wright 	hrtime_t		sr_time_submitted;
1679148c5f43SAlan Wright 	hrtime_t		sr_time_active;
1680148c5f43SAlan Wright 	hrtime_t		sr_time_start;
1681148c5f43SAlan Wright 	int32_t			sr_txb;
1682148c5f43SAlan Wright 	uint32_t		sr_seqnum;
1683faa1795aSjb } smb_request_t;
1684da6c28aaSamw 
1685148c5f43SAlan Wright #define	sr_ssetup	arg.ssetup
1686148c5f43SAlan Wright #define	sr_negprot	arg.negprot
1687148c5f43SAlan Wright #define	sr_tcon		arg.tcon
1688148c5f43SAlan Wright #define	sr_dirop	arg.dirop
1689148c5f43SAlan Wright #define	sr_open		arg.open
1690148c5f43SAlan Wright #define	sr_rw		arg.rw
1691148c5f43SAlan Wright #define	sr_timestamp	arg.timestamp
1692148c5f43SAlan Wright 
1693bbf6f00cSJordan Brown #define	SMB_READ_PROTOCOL(hdr) \
1694bbf6f00cSJordan Brown 	LE_IN32(((smb_hdr_t *)(hdr))->protocol)
1695da6c28aaSamw 
1696da6c28aaSamw #define	SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \
1697da6c28aaSamw 	(SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC)
1698da6c28aaSamw 
1699bbf6f00cSJordan Brown #define	SMB_READ_COMMAND(hdr) \
1700bbf6f00cSJordan Brown 	(((smb_hdr_t *)(hdr))->command)
1701da6c28aaSamw 
1702da6c28aaSamw #define	SMB_IS_WRITERAW(rd_sr) \
1703da6c28aaSamw 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_WRITE_RAW)
1704da6c28aaSamw 
1705148c5f43SAlan Wright #define	SMB_IS_NT_CANCEL(rd_sr) \
1706148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NT_CANCEL)
1707148c5f43SAlan Wright 
1708148c5f43SAlan Wright #define	SMB_IS_SESSION_SETUP_ANDX(rd_sr) \
1709148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == \
1710148c5f43SAlan Wright 	    SMB_COM_SESSION_SETUP_ANDX)
1711148c5f43SAlan Wright 
1712148c5f43SAlan Wright #define	SMB_IS_NT_NEGOTIATE(rd_sr) \
1713148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NEGOTIATE)
1714148c5f43SAlan Wright 
1715148c5f43SAlan Wright #define	SMB_IS_TREE_CONNECT_ANDX(rd_sr) \
1716148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_TREE_CONNECT_ANDX)
1717da6c28aaSamw 
1718da6c28aaSamw #define	SMB_XA_FLAG_OPEN	0x0001
1719da6c28aaSamw #define	SMB_XA_FLAG_CLOSE	0x0002
1720da6c28aaSamw #define	SMB_XA_FLAG_COMPLETE	0x0004
1721da6c28aaSamw #define	SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN))
1722da6c28aaSamw 
1723da6c28aaSamw #define	SMB_XA_MAGIC		0x534D4258	/* 'SMBX' */
1724da6c28aaSamw 
1725da6c28aaSamw typedef struct smb_xa {
1726da6c28aaSamw 	uint32_t		xa_magic;
1727da6c28aaSamw 	kmutex_t		xa_mutex;
1728da6c28aaSamw 	list_node_t		xa_lnd;
1729da6c28aaSamw 
1730da6c28aaSamw 	uint32_t		xa_refcnt;
1731da6c28aaSamw 	uint32_t		xa_flags;
1732da6c28aaSamw 
1733da6c28aaSamw 	struct smb_session	*xa_session;
1734da6c28aaSamw 
1735da6c28aaSamw 	unsigned char		smb_com;	/* which TRANS type */
1736da6c28aaSamw 	unsigned char		smb_flg;	/* flags */
1737da6c28aaSamw 	uint16_t		smb_flg2;	/* flags */
1738da6c28aaSamw 	uint16_t		smb_tid;	/* tree id number */
1739da6c28aaSamw 	uint16_t		smb_pid;	/* caller's process id number */
1740da6c28aaSamw 	uint16_t		smb_uid;	/* user id number */
1741da6c28aaSamw 	uint32_t		smb_func;	/* NT_TRANS function */
1742da6c28aaSamw 
1743da6c28aaSamw 	uint16_t		xa_smb_mid;	/* mutiplex id number */
1744da6c28aaSamw 	uint16_t		xa_smb_fid;	/* TRANS2 secondary */
1745da6c28aaSamw 
1746da6c28aaSamw 	unsigned int		reply_seqnum;	/* reply sequence number */
1747da6c28aaSamw 
1748da6c28aaSamw 	uint32_t	smb_tpscnt;	/* total parameter bytes being sent */
1749da6c28aaSamw 	uint32_t	smb_tdscnt;	/* total data bytes being sent */
1750da6c28aaSamw 	uint32_t	smb_mprcnt;	/* max parameter bytes to return */
1751da6c28aaSamw 	uint32_t	smb_mdrcnt;	/* max data bytes to return */
1752da6c28aaSamw 	uint32_t	smb_msrcnt;	/* max setup words to return */
1753da6c28aaSamw 	uint32_t	smb_flags;	/* additional information: */
1754da6c28aaSamw 				/*  bit 0 - if set, disconnect TID in smb_tid */
1755da6c28aaSamw 				/*  bit 1 - if set, transaction is one way */
1756da6c28aaSamw 				/*  (no final response) */
1757da6c28aaSamw 	int32_t	smb_timeout;	/* number of milliseconds to await completion */
1758da6c28aaSamw 	uint32_t	smb_suwcnt;	/* set up word count */
1759da6c28aaSamw 
1760bbf6f00cSJordan Brown 	char			*xa_pipe_name;
1761da6c28aaSamw 
1762da6c28aaSamw 	int			req_disp_param;
1763da6c28aaSamw 	int			req_disp_data;
1764da6c28aaSamw 
1765da6c28aaSamw 	struct mbuf_chain	req_setup_mb;
1766da6c28aaSamw 	struct mbuf_chain	req_param_mb;
1767da6c28aaSamw 	struct mbuf_chain	req_data_mb;
1768da6c28aaSamw 
1769da6c28aaSamw 	struct mbuf_chain	rep_setup_mb;
1770da6c28aaSamw 	struct mbuf_chain	rep_param_mb;
1771da6c28aaSamw 	struct mbuf_chain	rep_data_mb;
1772da6c28aaSamw } smb_xa_t;
1773da6c28aaSamw 
1774da6c28aaSamw 
1775da6c28aaSamw #define	SDDF_NO_FLAGS			0
1776da6c28aaSamw #define	SDDF_SUPPRESS_TID		0x0001
1777da6c28aaSamw #define	SDDF_SUPPRESS_UID		0x0002
1778da6c28aaSamw 
17797b59d02dSjb /*
17807b59d02dSjb  * SMB dispatch return codes.
17817b59d02dSjb  */
17827b59d02dSjb typedef enum {
1783faa1795aSjb 	SDRC_SUCCESS = 0,
1784faa1795aSjb 	SDRC_ERROR,
17857b59d02dSjb 	SDRC_DROP_VC,
17867b59d02dSjb 	SDRC_NO_REPLY,
178759229f98Sjose borrego 	SDRC_SR_KEPT,
1788faa1795aSjb 	SDRC_NOT_IMPLEMENTED
17897b59d02dSjb } smb_sdrc_t;
1790da6c28aaSamw 
1791da6c28aaSamw #define	VAR_BCC		((short)-1)
1792da6c28aaSamw 
1793faa1795aSjb #define	SMB_SERVER_MAGIC	0x53534552	/* 'SSER' */
17949fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_SERVER_VALID(s)	\
17959fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((s) != NULL) && ((s)->sv_magic == SMB_SERVER_MAGIC))
1796da6c28aaSamw 
17974163af6aSjose borrego #define	SMB_LISTENER_MAGIC	0x4C53544E	/* 'LSTN' */
17984163af6aSjose borrego #define	SMB_LISTENER_VALID(ld)	\
17994163af6aSjose borrego     ASSERT(((ld) != NULL) && ((ld)->ld_magic == SMB_LISTENER_MAGIC))
18004163af6aSjose borrego 
1801faa1795aSjb typedef struct {
18024163af6aSjose borrego 	uint32_t		ld_magic;
18034163af6aSjose borrego 	struct smb_server	*ld_sv;
18044163af6aSjose borrego 	smb_thread_t		ld_thread;
18050f1702c5SYu Xiangning 	ksocket_t		ld_so;
18064163af6aSjose borrego 	in_port_t		ld_port;
18074163af6aSjose borrego 	int			ld_family;
1808faa1795aSjb 	struct sockaddr_in	ld_sin;
18097f667e74Sjose borrego 	struct sockaddr_in6	ld_sin6;
18104163af6aSjose borrego 	smb_llist_t		ld_session_list;
1811faa1795aSjb } smb_listener_daemon_t;
1812faa1795aSjb 
1813cb174861Sjoyce mcintosh #define	SMB_SSETUP_CMD			"authentication"
1814cb174861Sjoyce mcintosh #define	SMB_TCON_CMD			"share mapping"
1815cb174861Sjoyce mcintosh #define	SMB_OPIPE_CMD			"pipe open"
1816cb174861Sjoyce mcintosh #define	SMB_THRESHOLD_REPORT_THROTTLE	50
1817cb174861Sjoyce mcintosh typedef struct smb_cmd_threshold {
1818cb174861Sjoyce mcintosh 	char			*ct_cmd;
1819cb174861Sjoyce mcintosh 	kmutex_t		ct_mutex;
1820cb174861Sjoyce mcintosh 	volatile uint32_t	ct_active_cnt;
1821cb174861Sjoyce mcintosh 	volatile uint32_t	ct_blocked_cnt;
1822cb174861Sjoyce mcintosh 	volatile uint32_t	ct_error_cnt;
1823cb174861Sjoyce mcintosh 	uint32_t		ct_threshold;
1824cb174861Sjoyce mcintosh 	struct smb_event	*ct_event;
1825cb174861Sjoyce mcintosh 	uint32_t		ct_event_id;
1826cb174861Sjoyce mcintosh } smb_cmd_threshold_t;
1827cb174861Sjoyce mcintosh 
1828cb174861Sjoyce mcintosh typedef struct {
1829cb174861Sjoyce mcintosh 	kstat_named_t		ls_files;
1830cb174861Sjoyce mcintosh 	kstat_named_t		ls_trees;
1831cb174861Sjoyce mcintosh 	kstat_named_t		ls_users;
1832cb174861Sjoyce mcintosh } smb_server_legacy_kstat_t;
1833cb174861Sjoyce mcintosh 
1834faa1795aSjb typedef enum smb_server_state {
1835faa1795aSjb 	SMB_SERVER_STATE_CREATED = 0,
1836faa1795aSjb 	SMB_SERVER_STATE_CONFIGURED,
1837faa1795aSjb 	SMB_SERVER_STATE_RUNNING,
18389fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	SMB_SERVER_STATE_STOPPING,
18396537f381Sas 	SMB_SERVER_STATE_DELETING,
18406537f381Sas 	SMB_SERVER_STATE_SENTINEL
1841faa1795aSjb } smb_server_state_t;
1842faa1795aSjb 
1843cb174861Sjoyce mcintosh typedef struct {
184423a9c295SGordon Ross 	/* protected by sv_mutex */
1845cb174861Sjoyce mcintosh 	kcondvar_t		sp_cv;
1846cb174861Sjoyce mcintosh 	uint32_t 		sp_cnt;
1847cb174861Sjoyce mcintosh 	smb_llist_t		sp_list;
1848cb174861Sjoyce mcintosh 	smb_llist_t		sp_fidlist;
1849cb174861Sjoyce mcintosh } smb_spool_t;
1850cb174861Sjoyce mcintosh 
1851148c5f43SAlan Wright #define	SMB_SERVER_STATE_VALID(S)               \
1852148c5f43SAlan Wright     ASSERT(((S) == SMB_SERVER_STATE_CREATED) || \
1853148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_CONFIGURED) || \
1854148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_RUNNING) ||    \
1855148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_STOPPING) ||   \
1856148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_DELETING))
18579fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
1858faa1795aSjb typedef struct smb_server {
1859faa1795aSjb 	uint32_t		sv_magic;
1860faa1795aSjb 	kcondvar_t		sv_cv;
1861faa1795aSjb 	kmutex_t		sv_mutex;
1862faa1795aSjb 	list_node_t		sv_lnd;
1863faa1795aSjb 	smb_server_state_t	sv_state;
1864faa1795aSjb 	uint32_t		sv_refcnt;
18656537f381Sas 	pid_t			sv_pid;
1866faa1795aSjb 	zoneid_t		sv_zid;
1867faa1795aSjb 	smb_listener_daemon_t	sv_nbt_daemon;
1868faa1795aSjb 	smb_listener_daemon_t	sv_tcp_daemon;
1869faa1795aSjb 	krwlock_t		sv_cfg_lock;
1870faa1795aSjb 	smb_kmod_cfg_t		sv_cfg;
1871faa1795aSjb 	smb_session_t		*sv_session;
1872da6c28aaSamw 
1873faa1795aSjb 	door_handle_t		sv_lmshrd;
1874da6c28aaSamw 
1875c8ec8eeaSjose borrego 	int32_t			si_gmtoff;
1876da6c28aaSamw 
1877da6c28aaSamw 	smb_thread_t		si_thread_timers;
1878da6c28aaSamw 
18794163af6aSjose borrego 	taskq_t			*sv_worker_pool;
18804163af6aSjose borrego 	taskq_t			*sv_receiver_pool;
1881da6c28aaSamw 
1882da6c28aaSamw 	kmem_cache_t		*si_cache_request;
1883da6c28aaSamw 	kmem_cache_t		*si_cache_session;
1884da6c28aaSamw 	kmem_cache_t		*si_cache_user;
1885da6c28aaSamw 	kmem_cache_t		*si_cache_tree;
1886da6c28aaSamw 	kmem_cache_t		*si_cache_ofile;
1887da6c28aaSamw 	kmem_cache_t		*si_cache_odir;
18889fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmem_cache_t		*si_cache_opipe;
18899fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmem_cache_t		*si_cache_event;
1890da6c28aaSamw 
1891da6c28aaSamw 	smb_node_t		*si_root_smb_node;
18929fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_llist_t		sv_opipe_list;
18939fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_llist_t		sv_event_list;
1894148c5f43SAlan Wright 
1895148c5f43SAlan Wright 	/* Statistics */
1896148c5f43SAlan Wright 	hrtime_t		sv_start_time;
1897148c5f43SAlan Wright 	kstat_t			*sv_ksp;
1898148c5f43SAlan Wright 	volatile uint32_t	sv_nbt_sess;
1899148c5f43SAlan Wright 	volatile uint32_t	sv_tcp_sess;
1900148c5f43SAlan Wright 	volatile uint32_t	sv_users;
1901148c5f43SAlan Wright 	volatile uint32_t	sv_trees;
1902148c5f43SAlan Wright 	volatile uint32_t	sv_files;
1903148c5f43SAlan Wright 	volatile uint32_t	sv_pipes;
1904148c5f43SAlan Wright 	volatile uint64_t	sv_txb;
1905148c5f43SAlan Wright 	volatile uint64_t	sv_rxb;
1906148c5f43SAlan Wright 	volatile uint64_t	sv_nreq;
1907148c5f43SAlan Wright 	smb_srqueue_t		sv_srqueue;
1908cb174861Sjoyce mcintosh 	smb_spool_t		sp_info;
1909cb174861Sjoyce mcintosh 	smb_cmd_threshold_t	sv_ssetup_ct;
1910cb174861Sjoyce mcintosh 	smb_cmd_threshold_t	sv_tcon_ct;
1911cb174861Sjoyce mcintosh 	smb_cmd_threshold_t	sv_opipe_ct;
1912cb174861Sjoyce mcintosh 	kstat_t			*sv_legacy_ksp;
1913cb174861Sjoyce mcintosh 	kmutex_t		sv_legacy_ksmtx;
1914faa1795aSjb } smb_server_t;
1915da6c28aaSamw 
19169fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_EVENT_MAGIC		0x45564E54	/* EVNT */
1917cb174861Sjoyce mcintosh #define	SMB_EVENT_TIMEOUT	45		/* seconds */
19189fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_EVENT_VALID(e)	\
19199fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((e) != NULL) && ((e)->se_magic == SMB_EVENT_MAGIC))
19209fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_event {
19219fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		se_magic;
19229fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_node_t		se_lnd;
19239fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmutex_t		se_mutex;
19249fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kcondvar_t		se_cv;
1925cb174861Sjoyce mcintosh 	smb_server_t		*se_server;
19269fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		se_txid;
19279fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	boolean_t		se_notified;
19289fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	int			se_waittime;
1929cb174861Sjoyce mcintosh 	int			se_timeout;
19309fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	int			se_errno;
19319fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States } smb_event_t;
19329fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
1933cb174861Sjoyce mcintosh typedef struct smb_kspooldoc {
1934cb174861Sjoyce mcintosh 	uint32_t	sd_magic;
1935cb174861Sjoyce mcintosh 	list_node_t	sd_lnd;
1936cb174861Sjoyce mcintosh 	smb_inaddr_t	sd_ipaddr;
1937cb174861Sjoyce mcintosh 	uint32_t	sd_spool_num;
1938cb174861Sjoyce mcintosh 	uint16_t	sd_fid;
1939cb174861Sjoyce mcintosh 	char		sd_username[MAXNAMELEN];
1940cb174861Sjoyce mcintosh 	char		sd_path[MAXPATHLEN];
1941cb174861Sjoyce mcintosh } smb_kspooldoc_t;
1942cb174861Sjoyce mcintosh 
1943cb174861Sjoyce mcintosh typedef struct smb_spoolfid {
1944cb174861Sjoyce mcintosh 	uint32_t	sf_magic;
1945cb174861Sjoyce mcintosh 	list_node_t	sf_lnd;
1946cb174861Sjoyce mcintosh 	uint16_t	sf_fid;
1947cb174861Sjoyce mcintosh } smb_spoolfid_t;
1948cb174861Sjoyce mcintosh 
1949da6c28aaSamw #define	SMB_INFO_NETBIOS_SESSION_SVC_RUNNING	0x0001
1950da6c28aaSamw #define	SMB_INFO_NETBIOS_SESSION_SVC_FAILED	0x0002
1951da6c28aaSamw #define	SMB_INFO_USER_LEVEL_SECURITY		0x40000000
1952da6c28aaSamw #define	SMB_INFO_ENCRYPT_PASSWORDS		0x80000000
1953da6c28aaSamw 
1954faa1795aSjb #define	SMB_NEW_KID()	atomic_inc_64_nv(&smb_kids)
1955faa1795aSjb #define	SMB_UNIQ_FID()	atomic_inc_32_nv(&smb_fids)
1956da6c28aaSamw 
19571fcced4cSJordan Brown #define	SMB_IS_STREAM(node) ((node)->n_unode)
1958da6c28aaSamw 
1959da6c28aaSamw typedef struct smb_tsd {
1960da6c28aaSamw 	void (*proc)();
1961da6c28aaSamw 	void *arg;
1962da6c28aaSamw 	char name[100];
1963da6c28aaSamw } smb_tsd_t;
1964da6c28aaSamw 
19652c2961f8Sjose borrego typedef struct smb_disp_entry {
1966148c5f43SAlan Wright 	char		sdt_name[KSTAT_STRLEN];
1967148c5f43SAlan Wright 	smb_sdrc_t	(*sdt_pre_op)(smb_request_t *);
1968148c5f43SAlan Wright 	smb_sdrc_t	(*sdt_function)(smb_request_t *);
1969148c5f43SAlan Wright 	void		(*sdt_post_op)(smb_request_t *);
1970148c5f43SAlan Wright 	uint8_t		sdt_com;
1971148c5f43SAlan Wright 	char		sdt_dialect;
1972148c5f43SAlan Wright 	uint8_t		sdt_flags;
1973148c5f43SAlan Wright 	volatile uint64_t sdt_txb;
1974148c5f43SAlan Wright 	volatile uint64_t sdt_rxb;
1975148c5f43SAlan Wright 	smb_latency_t	sdt_lat;
19762c2961f8Sjose borrego } smb_disp_entry_t;
1977da6c28aaSamw 
1978148c5f43SAlan Wright typedef struct smb_xlate {
1979148c5f43SAlan Wright 	int	code;
1980148c5f43SAlan Wright 	char	*str;
1981148c5f43SAlan Wright } smb_xlate_t;
1982148c5f43SAlan Wright 
1983148c5f43SAlan Wright typedef struct smb_export {
1984148c5f43SAlan Wright 	kmutex_t	e_mutex;
1985148c5f43SAlan Wright 	boolean_t	e_ready;
1986148c5f43SAlan Wright 	smb_llist_t	e_vfs_list;
1987148c5f43SAlan Wright 	smb_avl_t	e_share_avl;
1988148c5f43SAlan Wright 	smb_slist_t	e_unexport_list;
1989148c5f43SAlan Wright 
1990148c5f43SAlan Wright 	kmem_cache_t	*e_cache_share;
1991148c5f43SAlan Wright 	kmem_cache_t	*e_cache_vfs;
1992148c5f43SAlan Wright 	kmem_cache_t	*e_cache_unexport;
1993148c5f43SAlan Wright 
1994148c5f43SAlan Wright 	smb_thread_t	e_unexport_thread;
1995148c5f43SAlan Wright } smb_export_t;
1996148c5f43SAlan Wright 
1997148c5f43SAlan Wright /*
1998148c5f43SAlan Wright  * This structure is a helper for building RAP NetShareEnum response
1999148c5f43SAlan Wright  *
2000148c5f43SAlan Wright  * es_posix_uid UID of the user requesting the shares list which
2001148c5f43SAlan Wright  *              is used to detect if the user has any autohome
2002148c5f43SAlan Wright  * es_bufsize   size of the response buffer
2003148c5f43SAlan Wright  * es_buf       pointer to the response buffer
2004148c5f43SAlan Wright  * es_ntotal    total number of shares exported by server which
2005148c5f43SAlan Wright  *              their OEM names is less then 13 chars
2006148c5f43SAlan Wright  * es_nsent     number of shares that can fit in the specified buffer
2007148c5f43SAlan Wright  * es_datasize  actual data size (share's data) which was encoded
2008148c5f43SAlan Wright  *              in the response buffer
2009148c5f43SAlan Wright  */
2010148c5f43SAlan Wright typedef struct smb_enumshare_info {
2011148c5f43SAlan Wright 	uid_t		es_posix_uid;
2012148c5f43SAlan Wright 	uint16_t	es_bufsize;
2013148c5f43SAlan Wright 	char		*es_buf;
2014148c5f43SAlan Wright 	uint16_t	es_ntotal;
2015148c5f43SAlan Wright 	uint16_t	es_nsent;
2016148c5f43SAlan Wright 	uint16_t	es_datasize;
2017148c5f43SAlan Wright } smb_enumshare_info_t;
2018148c5f43SAlan Wright 
2019da6c28aaSamw #ifdef	__cplusplus
2020da6c28aaSamw }
2021da6c28aaSamw #endif
2022da6c28aaSamw 
2023faa1795aSjb #endif /* _SMBSRV_SMB_KTYPES_H */
2024