xref: /illumos-gate/usr/src/uts/common/smbsrv/smb_ktypes.h (revision a90cf9f29973990687fa61de9f1f6ea22e924e40)
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.
23*a90cf9f2SGordon Ross  * Copyright 2015 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>
52da6c28aaSamw #include <smbsrv/smb.h>
53*a90cf9f2SGordon Ross #include <smbsrv/smb2.h>
54da6c28aaSamw #include <smbsrv/smbinfo.h>
55da6c28aaSamw #include <smbsrv/mbuf.h>
566537f381Sas #include <smbsrv/smb_sid.h>
573db3f65cSamw #include <smbsrv/smb_xdr.h>
5821b7895dSjb #include <smbsrv/netbios.h>
59da6c28aaSamw #include <smbsrv/smb_vops.h>
60148c5f43SAlan Wright #include <smbsrv/smb_kstat.h>
61da6c28aaSamw 
62b819cea2SGordon Ross struct __door_handle;	/* <sys/door.h> */
63b819cea2SGordon Ross struct edirent;		/* <sys/extdirent.h> */
64b819cea2SGordon Ross 
652c2961f8Sjose borrego struct smb_disp_entry;
66faa1795aSjb struct smb_request;
67faa1795aSjb struct smb_server;
689fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States struct smb_event;
698622ec45SGordon Ross struct smb_export;
70da6c28aaSamw 
71148c5f43SAlan Wright /*
72148c5f43SAlan Wright  * Accumulated time and queue length statistics.
73148c5f43SAlan Wright  *
74148c5f43SAlan Wright  * Accumulated time statistics are kept as a running sum of "active" time.
75148c5f43SAlan Wright  * Queue length statistics are kept as a running sum of the product of queue
76148c5f43SAlan Wright  * length and elapsed time at that length -- i.e., a Riemann sum for queue
77148c5f43SAlan Wright  * length integrated against time.  (You can also think of the active time as a
78148c5f43SAlan Wright  * Riemann sum, for the boolean function (queue_length > 0) integrated against
79148c5f43SAlan Wright  * time, or you can think of it as the Lebesgue measure of the set on which
80148c5f43SAlan Wright  * queue_length > 0.)
81148c5f43SAlan Wright  *
82148c5f43SAlan Wright  *		^
83148c5f43SAlan Wright  *		|			_________
84148c5f43SAlan Wright  *		8			| i4	|
85148c5f43SAlan Wright  *		|			|	|
86148c5f43SAlan Wright  *	Queue	6			|	|
87148c5f43SAlan Wright  *	Length	|	_________	|	|
88148c5f43SAlan Wright  *		4	| i2	|_______|	|
89148c5f43SAlan Wright  *		|	|	    i3		|
90148c5f43SAlan Wright  *		2_______|			|
91148c5f43SAlan Wright  *		|    i1				|
92148c5f43SAlan Wright  *		|_______________________________|
93148c5f43SAlan Wright  *		Time->	t1	t2	t3	t4
94148c5f43SAlan Wright  *
95148c5f43SAlan Wright  * At each change of state (entry or exit from the queue), we add the elapsed
96148c5f43SAlan Wright  * time (since the previous state change) to the active time if the queue length
97148c5f43SAlan Wright  * was non-zero during that interval; and we add the product of the elapsed time
98148c5f43SAlan Wright  * times the queue length to the running length*time sum.
99148c5f43SAlan Wright  *
100148c5f43SAlan Wright  * This method is generalizable to measuring residency in any defined system:
101148c5f43SAlan Wright  * instead of queue lengths, think of "outstanding RPC calls to server X".
102148c5f43SAlan Wright  *
103148c5f43SAlan Wright  * A large number of I/O subsystems have at least two basic "lists" of
104148c5f43SAlan Wright  * transactions they manage: one for transactions that have been accepted for
105148c5f43SAlan Wright  * processing but for which processing has yet to begin, and one for
106148c5f43SAlan Wright  * transactions which are actively being processed (but not done). For this
107148c5f43SAlan Wright  * reason, two cumulative time statistics are defined here: wait (pre-service)
108148c5f43SAlan Wright  * time, and run (service) time.
109148c5f43SAlan Wright  *
110148c5f43SAlan Wright  * All times are 64-bit nanoseconds (hrtime_t), as returned by gethrtime().
111148c5f43SAlan Wright  *
112148c5f43SAlan Wright  * The units of cumulative busy time are accumulated nanoseconds. The units of
113148c5f43SAlan Wright  * cumulative length*time products are elapsed time times queue length.
114148c5f43SAlan Wright  *
115148c5f43SAlan Wright  * Updates to the fields below are performed implicitly by calls to
116148c5f43SAlan Wright  * these functions:
117148c5f43SAlan Wright  *
118148c5f43SAlan Wright  *	smb_srqueue_init()
119148c5f43SAlan Wright  *	smb_srqueue_destroy()
120148c5f43SAlan Wright  *	smb_srqueue_waitq_enter()
121148c5f43SAlan Wright  *	smb_srqueue_runq_exit()
122148c5f43SAlan Wright  *	smb_srqueue_waitq_to_runq()
123148c5f43SAlan Wright  *	smb_srqueue_update()
124148c5f43SAlan Wright  *
125148c5f43SAlan Wright  * These fields should never be updated by any other means.
126148c5f43SAlan Wright  */
127148c5f43SAlan Wright typedef struct smb_srqueue {
128148c5f43SAlan Wright 	kmutex_t	srq_mutex;
129148c5f43SAlan Wright 	hrtime_t	srq_wlastupdate;
130148c5f43SAlan Wright 	hrtime_t	srq_wtime;
131148c5f43SAlan Wright 	hrtime_t	srq_wlentime;
132148c5f43SAlan Wright 	hrtime_t	srq_rlastupdate;
133148c5f43SAlan Wright 	hrtime_t	srq_rtime;
134148c5f43SAlan Wright 	hrtime_t	srq_rlentime;
135148c5f43SAlan Wright 	uint32_t	srq_wcnt;
136148c5f43SAlan Wright 	uint32_t	srq_rcnt;
137148c5f43SAlan Wright } smb_srqueue_t;
138148c5f43SAlan Wright 
139148c5f43SAlan Wright /*
140148c5f43SAlan Wright  * The fields with the prefix 'ly_a' contain the statistics collected since the
141148c5f43SAlan Wright  * server was last started ('a' for 'aggregated'). The fields with the prefix
142148c5f43SAlan Wright  * 'ly_d' contain the statistics collected since the last snapshot ('d' for
143148c5f43SAlan Wright  * 'delta').
144148c5f43SAlan Wright  */
145148c5f43SAlan Wright typedef struct smb_latency {
146148c5f43SAlan Wright 	kmutex_t	ly_mutex;
147148c5f43SAlan Wright 	uint64_t	ly_a_nreq;
148148c5f43SAlan Wright 	hrtime_t	ly_a_sum;
149148c5f43SAlan Wright 	hrtime_t	ly_a_mean;
150148c5f43SAlan Wright 	hrtime_t	ly_a_stddev;
151148c5f43SAlan Wright 	uint64_t	ly_d_nreq;
152148c5f43SAlan Wright 	hrtime_t	ly_d_sum;
153148c5f43SAlan Wright 	hrtime_t	ly_d_mean;
154148c5f43SAlan Wright 	hrtime_t	ly_d_stddev;
155148c5f43SAlan Wright } smb_latency_t;
156148c5f43SAlan Wright 
1578622ec45SGordon Ross typedef struct smb_disp_stats {
1588622ec45SGordon Ross 	volatile uint64_t sdt_txb;
1598622ec45SGordon Ross 	volatile uint64_t sdt_rxb;
1608622ec45SGordon Ross 	smb_latency_t	sdt_lat;
1618622ec45SGordon Ross } smb_disp_stats_t;
1628622ec45SGordon Ross 
163da6c28aaSamw int smb_noop(void *, size_t, int);
164da6c28aaSamw 
165da6c28aaSamw #define	SMB_AUDIT_STACK_DEPTH	16
166da6c28aaSamw #define	SMB_AUDIT_BUF_MAX_REC	16
167da6c28aaSamw #define	SMB_AUDIT_NODE		0x00000001
168da6c28aaSamw 
169c8ec8eeaSjose borrego /*
170c8ec8eeaSjose borrego  * Maximum number of records returned in SMBsearch, SMBfind
171c8ec8eeaSjose borrego  * and SMBfindunique response. Value set to 10 for compatibility
172c8ec8eeaSjose borrego  * with Windows.
173c8ec8eeaSjose borrego  */
174c8ec8eeaSjose borrego #define	SMB_MAX_SEARCH		10
175c8ec8eeaSjose borrego 
1767f667e74Sjose borrego #define	SMB_SEARCH_ATTRIBUTES    \
1777f667e74Sjose borrego 	(FILE_ATTRIBUTE_HIDDEN | \
1787f667e74Sjose borrego 	FILE_ATTRIBUTE_SYSTEM |  \
1797f667e74Sjose borrego 	FILE_ATTRIBUTE_DIRECTORY)
1807f667e74Sjose borrego 
1812c1b14e5Sjose borrego #define	SMB_SEARCH_HIDDEN(sattr) ((sattr) & FILE_ATTRIBUTE_HIDDEN)
1822c1b14e5Sjose borrego #define	SMB_SEARCH_SYSTEM(sattr) ((sattr) & FILE_ATTRIBUTE_SYSTEM)
1832c1b14e5Sjose borrego #define	SMB_SEARCH_DIRECTORY(sattr) ((sattr) & FILE_ATTRIBUTE_DIRECTORY)
1847f667e74Sjose borrego #define	SMB_SEARCH_ALL(sattr) ((sattr) & SMB_SEARCH_ATTRIBUTES)
1852c1b14e5Sjose borrego 
186da6c28aaSamw typedef struct {
187da6c28aaSamw 	uint32_t		anr_refcnt;
188da6c28aaSamw 	int			anr_depth;
189da6c28aaSamw 	pc_t			anr_stack[SMB_AUDIT_STACK_DEPTH];
190da6c28aaSamw } smb_audit_record_node_t;
191da6c28aaSamw 
192da6c28aaSamw typedef struct {
193da6c28aaSamw 	int			anb_index;
194da6c28aaSamw 	int			anb_max_index;
195da6c28aaSamw 	smb_audit_record_node_t	anb_records[SMB_AUDIT_BUF_MAX_REC];
196da6c28aaSamw } smb_audit_buf_node_t;
197da6c28aaSamw 
198da6c28aaSamw /*
199da6c28aaSamw  * Thread State Machine
200da6c28aaSamw  * --------------------
201da6c28aaSamw  *
202da6c28aaSamw  *			    T5			   T0
203da6c28aaSamw  * smb_thread_destroy()	<-------+		+------- smb_thread_init()
204da6c28aaSamw  *                              |		|
205da6c28aaSamw  *				|		v
206da6c28aaSamw  *			+-----------------------------+
207da6c28aaSamw  *			|   SMB_THREAD_STATE_EXITED   |<---+
208da6c28aaSamw  *			+-----------------------------+	   |
209da6c28aaSamw  *				      | T1		   |
210da6c28aaSamw  *				      v			   |
211da6c28aaSamw  *			+-----------------------------+	   |
212da6c28aaSamw  *			|  SMB_THREAD_STATE_STARTING  |	   |
213da6c28aaSamw  *			+-----------------------------+	   |
214da6c28aaSamw  *				     | T2		   | T4
215da6c28aaSamw  *				     v			   |
216da6c28aaSamw  *			+-----------------------------+	   |
217da6c28aaSamw  *			|  SMB_THREAD_STATE_RUNNING   |	   |
218da6c28aaSamw  *			+-----------------------------+	   |
219da6c28aaSamw  *				     | T3		   |
220da6c28aaSamw  *				     v			   |
221da6c28aaSamw  *			+-----------------------------+	   |
222da6c28aaSamw  *			|  SMB_THREAD_STATE_EXITING   |----+
223da6c28aaSamw  *			+-----------------------------+
224da6c28aaSamw  *
225da6c28aaSamw  * Transition T0
226da6c28aaSamw  *
227da6c28aaSamw  *    This transition is executed in smb_thread_init().
228da6c28aaSamw  *
229da6c28aaSamw  * Transition T1
230da6c28aaSamw  *
231da6c28aaSamw  *    This transition is executed in smb_thread_start().
232da6c28aaSamw  *
233da6c28aaSamw  * Transition T2
234da6c28aaSamw  *
235da6c28aaSamw  *    This transition is executed by the thread itself when it starts running.
236da6c28aaSamw  *
237da6c28aaSamw  * Transition T3
238da6c28aaSamw  *
239da6c28aaSamw  *    This transition is executed by the thread itself in
240da6c28aaSamw  *    smb_thread_entry_point() just before calling thread_exit().
241da6c28aaSamw  *
242da6c28aaSamw  *
243da6c28aaSamw  * Transition T4
244da6c28aaSamw  *
245da6c28aaSamw  *    This transition is executed in smb_thread_stop().
246da6c28aaSamw  *
247da6c28aaSamw  * Transition T5
248da6c28aaSamw  *
249da6c28aaSamw  *    This transition is executed in smb_thread_destroy().
250da6c28aaSamw  */
251da6c28aaSamw typedef enum smb_thread_state {
252da6c28aaSamw 	SMB_THREAD_STATE_STARTING = 0,
253da6c28aaSamw 	SMB_THREAD_STATE_RUNNING,
254da6c28aaSamw 	SMB_THREAD_STATE_EXITING,
255b819cea2SGordon Ross 	SMB_THREAD_STATE_EXITED,
256b819cea2SGordon Ross 	SMB_THREAD_STATE_FAILED
257da6c28aaSamw } smb_thread_state_t;
258da6c28aaSamw 
259da6c28aaSamw struct _smb_thread;
260da6c28aaSamw 
261da6c28aaSamw typedef void (*smb_thread_ep_t)(struct _smb_thread *, void *ep_arg);
262da6c28aaSamw 
263da6c28aaSamw #define	SMB_THREAD_MAGIC	0x534D4254	/* SMBT */
264da6c28aaSamw 
265da6c28aaSamw typedef struct _smb_thread {
266da6c28aaSamw 	uint32_t		sth_magic;
267*a90cf9f2SGordon Ross 	char			sth_name[32];
268da6c28aaSamw 	smb_thread_state_t	sth_state;
269da6c28aaSamw 	kthread_t		*sth_th;
270da6c28aaSamw 	kt_did_t		sth_did;
271da6c28aaSamw 	smb_thread_ep_t		sth_ep;
272da6c28aaSamw 	void			*sth_ep_arg;
27308344b29SGordon Ross 	pri_t			sth_pri;
274da6c28aaSamw 	boolean_t		sth_kill;
275da6c28aaSamw 	kmutex_t		sth_mtx;
276da6c28aaSamw 	kcondvar_t		sth_cv;
277da6c28aaSamw } smb_thread_t;
278da6c28aaSamw 
279da6c28aaSamw /*
280da6c28aaSamw  * Pool of IDs
281da6c28aaSamw  * -----------
282da6c28aaSamw  *
283da6c28aaSamw  *    A pool of IDs is a pool of 16 bit numbers. It is implemented as a bitmap.
284da6c28aaSamw  *    A bit set to '1' indicates that that particular value has been allocated.
285da6c28aaSamw  *    The allocation process is done shifting a bit through the whole bitmap.
286da6c28aaSamw  *    The current position of that index bit is kept in the smb_idpool_t
287da6c28aaSamw  *    structure and represented by a byte index (0 to buffer size minus 1) and
288da6c28aaSamw  *    a bit index (0 to 7).
289da6c28aaSamw  *
290da6c28aaSamw  *    The pools start with a size of 8 bytes or 64 IDs. Each time the pool runs
291da6c28aaSamw  *    out of IDs its current size is doubled until it reaches its maximum size
292da6c28aaSamw  *    (8192 bytes or 65536 IDs). The IDs 0 and 65535 are never given out which
293da6c28aaSamw  *    means that a pool can have a maximum number of 65534 IDs available.
294da6c28aaSamw  */
295da6c28aaSamw #define	SMB_IDPOOL_MAGIC	0x4944504C	/* IDPL */
296da6c28aaSamw #define	SMB_IDPOOL_MIN_SIZE	64	/* Number of IDs to begin with */
297da6c28aaSamw #define	SMB_IDPOOL_MAX_SIZE	64 * 1024
298da6c28aaSamw 
299da6c28aaSamw typedef struct smb_idpool {
300da6c28aaSamw 	uint32_t	id_magic;
301da6c28aaSamw 	kmutex_t	id_mutex;
302da6c28aaSamw 	uint8_t		*id_pool;
303da6c28aaSamw 	uint32_t	id_size;
30412b65585SGordon Ross 	uint32_t	id_maxsize;
305da6c28aaSamw 	uint8_t		id_bit;
306da6c28aaSamw 	uint8_t		id_bit_idx;
307da6c28aaSamw 	uint32_t	id_idx;
308da6c28aaSamw 	uint32_t	id_idx_msk;
309da6c28aaSamw 	uint32_t	id_free_counter;
310da6c28aaSamw 	uint32_t	id_max_free_counter;
311da6c28aaSamw } smb_idpool_t;
312da6c28aaSamw 
313da6c28aaSamw /*
3142c2961f8Sjose borrego  * Maximum size of a Transport Data Unit when CAP_LARGE_READX and
3152c2961f8Sjose borrego  * CAP_LARGE_WRITEX are not set.  CAP_LARGE_READX/CAP_LARGE_WRITEX
3162c2961f8Sjose borrego  * allow the payload to exceed the negotiated buffer size.
31721b7895dSjb  *     4 --> NBT/TCP Transport Header.
31821b7895dSjb  *    32 --> SMB Header
31921b7895dSjb  *     1 --> Word Count byte
32021b7895dSjb  *   510 --> Maximum Number of bytes of the Word Table (2 * 255)
32121b7895dSjb  *     2 --> Byte count of the data
32221b7895dSjb  * 65535 --> Maximum size of the data
32321b7895dSjb  * -----
32421b7895dSjb  * 66084
325da6c28aaSamw  */
3262c2961f8Sjose borrego #define	SMB_REQ_MAX_SIZE	66560		/* 65KB */
32721b7895dSjb #define	SMB_XPRT_MAX_SIZE	(SMB_REQ_MAX_SIZE + NETBIOS_HDR_SZ)
328da6c28aaSamw 
32921b7895dSjb #define	SMB_TXREQ_MAGIC		0X54524251	/* 'TREQ' */
3305cdbe942Sjb typedef struct {
33121b7895dSjb 	list_node_t	tr_lnd;
332*a90cf9f2SGordon Ross 	uint32_t	tr_magic;
33321b7895dSjb 	int		tr_len;
33421b7895dSjb 	uint8_t		tr_buf[SMB_XPRT_MAX_SIZE];
33521b7895dSjb } smb_txreq_t;
3365cdbe942Sjb 
3375cdbe942Sjb #define	SMB_TXLST_MAGIC		0X544C5354	/* 'TLST' */
3385cdbe942Sjb typedef struct {
3395cdbe942Sjb 	uint32_t	tl_magic;
3405cdbe942Sjb 	kmutex_t	tl_mutex;
341*a90cf9f2SGordon Ross 	kcondvar_t	tl_wait_cv;
3425cdbe942Sjb 	boolean_t	tl_active;
3435cdbe942Sjb } smb_txlst_t;
3445cdbe942Sjb 
345da6c28aaSamw /*
346faa1795aSjb  * Maximum buffer size for NT is 37KB.  If all clients are Windows 2000, this
347faa1795aSjb  * can be changed to 64KB.  37KB must be used with a mix of NT/Windows 2000
348faa1795aSjb  * clients because NT loses directory entries when values greater than 37KB are
349faa1795aSjb  * used.
350faa1795aSjb  *
351faa1795aSjb  * Note: NBT_MAXBUF will be subtracted from the specified max buffer size to
352faa1795aSjb  * account for the NBT header.
353da6c28aaSamw  */
354faa1795aSjb #define	NBT_MAXBUF		8
355faa1795aSjb #define	SMB_NT_MAXBUF		(37 * 1024)
356da6c28aaSamw 
357da6c28aaSamw #define	OUTBUFSIZE		(65 * 1024)
358da6c28aaSamw #define	SMBHEADERSIZE		32
359da6c28aaSamw #define	SMBND_HASH_MASK		(0xFF)
360da6c28aaSamw #define	MAX_IOVEC		512
361da6c28aaSamw #define	MAX_READREF		(8 * 1024)
362da6c28aaSamw 
363da6c28aaSamw #define	SMB_WORKER_MIN		4
364da6c28aaSamw #define	SMB_WORKER_DEFAULT	64
365da6c28aaSamw #define	SMB_WORKER_MAX		1024
366da6c28aaSamw 
367da6c28aaSamw /*
3689fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * Destructor object used in the locked-list delete queue.
369da6c28aaSamw  */
3709fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_DTOR_MAGIC		0x44544F52	/* DTOR */
3719fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_DTOR_VALID(d)	\
3729fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((d) != NULL) && ((d)->dt_magic == SMB_DTOR_MAGIC))
373da6c28aaSamw 
3749fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef void (*smb_dtorproc_t)(void *);
375da6c28aaSamw 
3769fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_dtor {
3779fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_node_t	dt_lnd;
378*a90cf9f2SGordon Ross 	uint32_t	dt_magic;
3799fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	void		*dt_object;
3809fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_dtorproc_t	dt_proc;
3819fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States } smb_dtor_t;
382da6c28aaSamw 
383da6c28aaSamw typedef struct smb_llist {
384da6c28aaSamw 	krwlock_t	ll_lock;
385da6c28aaSamw 	list_t		ll_list;
386da6c28aaSamw 	uint32_t	ll_count;
387da6c28aaSamw 	uint64_t	ll_wrop;
3889fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmutex_t	ll_mutex;
3899fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_t		ll_deleteq;
3909fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t	ll_deleteq_count;
391cb174861Sjoyce mcintosh 	boolean_t	ll_flushing;
392da6c28aaSamw } smb_llist_t;
393da6c28aaSamw 
394da6c28aaSamw typedef struct smb_slist {
395da6c28aaSamw 	kmutex_t	sl_mutex;
396da6c28aaSamw 	kcondvar_t	sl_cv;
397da6c28aaSamw 	list_t		sl_list;
398da6c28aaSamw 	uint32_t	sl_count;
399da6c28aaSamw 	boolean_t	sl_waiting;
400da6c28aaSamw } smb_slist_t;
401da6c28aaSamw 
402148c5f43SAlan Wright /*
403148c5f43SAlan Wright  * smb_avl_t State Machine
404148c5f43SAlan Wright  * --------------------
405148c5f43SAlan Wright  *
406148c5f43SAlan Wright  *                      +-----------------------------+
407148c5f43SAlan Wright  *                      |     SMB_AVL_STATE_START     |
408148c5f43SAlan Wright  *                      +-----------------------------+
409148c5f43SAlan Wright  *                                    | T0
410148c5f43SAlan Wright  *                                    v
411148c5f43SAlan Wright  *                      +-----------------------------+
412148c5f43SAlan Wright  *                      |     SMB_AVL_STATE_READY     |
413148c5f43SAlan Wright  *                      +-----------------------------+
414148c5f43SAlan Wright  *                                    | T1
415148c5f43SAlan Wright  *                                    v
416148c5f43SAlan Wright  *                      +-----------------------------+
417148c5f43SAlan Wright  *                      |  SMB_AVL_STATE_DESTROYING   |
418148c5f43SAlan Wright  *                      +-----------------------------+
419148c5f43SAlan Wright  *
420148c5f43SAlan Wright  * Transition T0
421148c5f43SAlan Wright  *
422148c5f43SAlan Wright  *    This transition is executed in smb_avl_create().
423148c5f43SAlan Wright  *
424148c5f43SAlan Wright  * Transition T1
425148c5f43SAlan Wright  *
426148c5f43SAlan Wright  *    This transition is executed in smb_avl_destroy().
427148c5f43SAlan Wright  *
428148c5f43SAlan Wright  */
429148c5f43SAlan Wright typedef enum {
430148c5f43SAlan Wright 	SMB_AVL_STATE_START = 0,
431148c5f43SAlan Wright 	SMB_AVL_STATE_READY,
432148c5f43SAlan Wright 	SMB_AVL_STATE_DESTROYING
433148c5f43SAlan Wright } smb_avl_state_t;
434148c5f43SAlan Wright 
435148c5f43SAlan Wright typedef struct smb_avl_nops {
436148c5f43SAlan Wright 	int		(*avln_cmp) (const void *, const void *);
437148c5f43SAlan Wright 	void		(*avln_hold)(const void *);
438148c5f43SAlan Wright 	boolean_t	(*avln_rele)(const void *);
439148c5f43SAlan Wright 	void		(*avln_destroy)(void *);
440148c5f43SAlan Wright } smb_avl_nops_t;
441148c5f43SAlan Wright 
442148c5f43SAlan Wright typedef struct smb_avl_cursor {
443148c5f43SAlan Wright 	void		*avlc_next;
444148c5f43SAlan Wright 	uint32_t	avlc_sequence;
445148c5f43SAlan Wright } smb_avl_cursor_t;
446148c5f43SAlan Wright 
447148c5f43SAlan Wright typedef struct smb_avl {
448148c5f43SAlan Wright 	krwlock_t	avl_lock;
449148c5f43SAlan Wright 	avl_tree_t	avl_tree;
450148c5f43SAlan Wright 	kmutex_t	avl_mutex;
451148c5f43SAlan Wright 	kcondvar_t	avl_cv;
452148c5f43SAlan Wright 	smb_avl_state_t	avl_state;
453148c5f43SAlan Wright 	uint32_t	avl_refcnt;
454148c5f43SAlan Wright 	uint32_t	avl_sequence;
4558622ec45SGordon Ross 	const smb_avl_nops_t	*avl_nops;
456148c5f43SAlan Wright } smb_avl_t;
457148c5f43SAlan Wright 
458da6c28aaSamw typedef struct {
459da6c28aaSamw 	kcondvar_t	rwx_cv;
460da6c28aaSamw 	kmutex_t	rwx_mutex;
461da6c28aaSamw 	krwlock_t	rwx_lock;
462da6c28aaSamw 	boolean_t	rwx_waiting;
463da6c28aaSamw } smb_rwx_t;
464da6c28aaSamw 
4658622ec45SGordon Ross typedef struct smb_export {
4668622ec45SGordon Ross 	kmutex_t	e_mutex;
4678622ec45SGordon Ross 	boolean_t	e_ready;
4688622ec45SGordon Ross 	smb_llist_t	e_vfs_list;
4698622ec45SGordon Ross 	smb_avl_t	e_share_avl;
4708622ec45SGordon Ross 	smb_slist_t	e_unexport_list;
4718622ec45SGordon Ross 	smb_thread_t	e_unexport_thread;
4728622ec45SGordon Ross } smb_export_t;
4738622ec45SGordon Ross 
474da6c28aaSamw /* NOTIFY CHANGE */
475ccc71be5SGordon Ross typedef struct smb_node_fcn {
476ccc71be5SGordon Ross 	kmutex_t	fcn_mutex;
477ccc71be5SGordon Ross 	uint32_t	fcn_count;
478ccc71be5SGordon Ross 	list_t		fcn_watchers;	/* smb_request_t, sr_ncr.nc_lnd */
479ccc71be5SGordon Ross } smb_node_fcn_t;
480da6c28aaSamw 
481da6c28aaSamw typedef struct smb_notify_change_req {
482ccc71be5SGordon Ross 	list_node_t		nc_lnd;	/* n_fcn.fcn_watchers */
483ccc71be5SGordon Ross 	kcondvar_t		nc_cv;	/* prot: sr_mutex */
484da6c28aaSamw 	uint32_t		nc_flags;
485ccc71be5SGordon Ross 	uint32_t		nc_action;
486ccc71be5SGordon Ross 	char			*nc_fname;
487da6c28aaSamw } smb_notify_change_req_t;
488da6c28aaSamw 
489da6c28aaSamw /*
490da6c28aaSamw  * SMB operates over a NetBIOS-over-TCP transport (NBT) or directly
491da6c28aaSamw  * over TCP, which is also known as direct hosted NetBIOS-less SMB
492da6c28aaSamw  * or SMB-over-TCP.
493da6c28aaSamw  *
494da6c28aaSamw  * NBT messages have a 4-byte header that defines the message type
495da6c28aaSamw  * (8-bits), a 7-bit flags field and a 17-bit length.
496da6c28aaSamw  *
497da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
498da6c28aaSamw  * |      TYPE     |     FLAGS   |E|            LENGTH             |
499da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
500da6c28aaSamw  *
501da6c28aaSamw  * 8-bit type      Defined in RFC 1002
502da6c28aaSamw  * 7-bit flags     Bits 0-6 reserved (must be 0)
503da6c28aaSamw  *                 Bit 7: Length extension bit (E)
504da6c28aaSamw  * 17-bit length   Includes bit 7 of the flags byte
505da6c28aaSamw  *
506da6c28aaSamw  *
507da6c28aaSamw  * SMB-over-TCP is defined to use a modified version of the NBT header
508da6c28aaSamw  * containing an 8-bit message type and 24-bit message length.
509da6c28aaSamw  *
510da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
511da6c28aaSamw  * |      TYPE     |                  LENGTH                       |
512da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
513da6c28aaSamw  *
514da6c28aaSamw  * 8-bit type      Must be 0
515da6c28aaSamw  * 24-bit length
516da6c28aaSamw  *
517da6c28aaSamw  * The following structure is used to represent a generic, in-memory
518da6c28aaSamw  * SMB transport header; it is not intended to map directly to either
519da6c28aaSamw  * of the over-the-wire formats.
520da6c28aaSamw  */
521da6c28aaSamw typedef struct {
522da6c28aaSamw 	uint8_t		xh_type;
523da6c28aaSamw 	uint32_t	xh_length;
524da6c28aaSamw } smb_xprt_t;
525da6c28aaSamw 
526faa1795aSjb int MBC_LENGTH(struct mbuf_chain *);
5273ad684d6Sjb int MBC_MAXBYTES(struct mbuf_chain *);
528faa1795aSjb void MBC_SETUP(struct mbuf_chain *, uint32_t);
529faa1795aSjb void MBC_INIT(struct mbuf_chain *, uint32_t);
530faa1795aSjb void MBC_FLUSH(struct mbuf_chain *);
531faa1795aSjb void MBC_ATTACH_MBUF(struct mbuf_chain *, struct mbuf *);
532faa1795aSjb void MBC_APPEND_MBUF(struct mbuf_chain *, struct mbuf *);
533da6c28aaSamw void MBC_ATTACH_BUF(struct mbuf_chain *MBC, unsigned char *BUF, int LEN);
534da6c28aaSamw int MBC_SHADOW_CHAIN(struct mbuf_chain *SUBMBC, struct mbuf_chain *MBC,
535da6c28aaSamw     int OFF, int LEN);
536da6c28aaSamw 
537da6c28aaSamw #define	MBC_ROOM_FOR(b, n) (((b)->chain_offset + (n)) <= (b)->max_bytes)
538da6c28aaSamw 
539cb174861Sjoyce mcintosh #define	OPLOCK_MIN_TIMEOUT	(5 * 1000)
540cb174861Sjoyce mcintosh #define	OPLOCK_STD_TIMEOUT	(30 * 1000)
541cb174861Sjoyce mcintosh 
542fc724630SAlan Wright /*
543cb174861Sjoyce mcintosh  * Oplock break flags:
544cb174861Sjoyce mcintosh  * SMB_OPLOCK_BREAK_EXCLUSIVE - only break exclusive oplock
545cb174861Sjoyce mcintosh  * (type SMB_OPLOCK_EXCLUSIVE or SMB_OPLOCK_BATCH)
546cb174861Sjoyce mcintosh  * SMB_OPLOCK_BREAK_BATCH - only break exclusive BATCH oplock
547cb174861Sjoyce mcintosh  * SMB_OPLOCK_BREAK_NOWAIT - do not wait for oplock break ack
548cb174861Sjoyce mcintosh  */
549cb174861Sjoyce mcintosh #define	SMB_OPLOCK_NO_BREAK		0x00
550cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_TO_NONE	0x01
551cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_TO_LEVEL_II	0x02
552cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_EXCLUSIVE	0x04
553cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_BATCH		0x08
554cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_NOWAIT		0x10
555cb174861Sjoyce mcintosh 
556cb174861Sjoyce mcintosh /*
557cb174861Sjoyce mcintosh  * Oplocks levels are defined to match the levels in the SMB
558cb174861Sjoyce mcintosh  * protocol (nt_create_andx / nt_transact_create) and should
559cb174861Sjoyce mcintosh  * not be changed
560fc724630SAlan Wright  */
561cb174861Sjoyce mcintosh #define	SMB_OPLOCK_NONE		0
562cb174861Sjoyce mcintosh #define	SMB_OPLOCK_EXCLUSIVE	1
563cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BATCH	2
564cb174861Sjoyce mcintosh #define	SMB_OPLOCK_LEVEL_II	3
565cb174861Sjoyce mcintosh 
566da6c28aaSamw typedef struct smb_oplock {
567cb174861Sjoyce mcintosh 	kmutex_t		ol_mutex;
5682c2961f8Sjose borrego 	kcondvar_t		ol_cv;
5692c2961f8Sjose borrego 	kthread_t		*ol_xthread;
570cb174861Sjoyce mcintosh 	boolean_t		ol_fem;		/* fem monitor installed? */
571*a90cf9f2SGordon Ross 	uint8_t			ol_brk_pending;
572cb174861Sjoyce mcintosh 	uint8_t			ol_break;
573cb174861Sjoyce mcintosh 	uint32_t		ol_count;	/* number of grants */
574cb174861Sjoyce mcintosh 	list_t			ol_grants;	/* list of smb_oplock_grant_t */
575da6c28aaSamw } smb_oplock_t;
576da6c28aaSamw 
577cb174861Sjoyce mcintosh #define	SMB_OPLOCK_GRANT_MAGIC	0x4F4C4B47	/* OLKG */
578cb174861Sjoyce mcintosh #define	SMB_OPLOCK_GRANT_VALID(p) \
579cb174861Sjoyce mcintosh 	ASSERT((p)->og_magic == SMB_OPLOCK_GRANT_MAGIC)
5801fdeec65Sjoyce mcintosh #define	SMB_OFILE_OPLOCK_GRANTED(p) \
5811fdeec65Sjoyce mcintosh 	((p)->f_oplock_grant.og_magic == SMB_OPLOCK_GRANT_MAGIC)
582cb174861Sjoyce mcintosh typedef struct smb_oplock_grant {
583cb174861Sjoyce mcintosh 	list_node_t		og_lnd;
584*a90cf9f2SGordon Ross 	uint32_t		og_magic;
585*a90cf9f2SGordon Ross 	uint8_t			og_breaking;
586cb174861Sjoyce mcintosh 	uint8_t			og_level;
587cb174861Sjoyce mcintosh 	uint16_t		og_fid;
588cb174861Sjoyce mcintosh 	uint16_t		og_tid;
589cb174861Sjoyce mcintosh 	uint16_t		og_uid;
590cb174861Sjoyce mcintosh 	struct smb_session	*og_session;
591cb174861Sjoyce mcintosh 	struct smb_ofile	*og_ofile;
592cb174861Sjoyce mcintosh } smb_oplock_grant_t;
593cb174861Sjoyce mcintosh 
594cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_MAGIC	0x4F4C4B42	/* OLKB */
595cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_VALID(p) \
596cb174861Sjoyce mcintosh 	ASSERT((p)->ob_magic == SMB_OPLOCK_BREAK_MAGIC)
597cb174861Sjoyce mcintosh typedef struct smb_oplock_break {
598cb174861Sjoyce mcintosh 	list_node_t	ob_lnd;
599*a90cf9f2SGordon Ross 	uint32_t	ob_magic;
600cb174861Sjoyce mcintosh 	struct smb_node	*ob_node;
601cb174861Sjoyce mcintosh } smb_oplock_break_t;
602cb174861Sjoyce mcintosh 
603cb174861Sjoyce mcintosh 
604da6c28aaSamw #define	SMB_VFS_MAGIC	0x534D4256	/* 'SMBV' */
605da6c28aaSamw 
606da6c28aaSamw typedef struct smb_vfs {
607da6c28aaSamw 	list_node_t		sv_lnd;
608*a90cf9f2SGordon Ross 	uint32_t		sv_magic;
609da6c28aaSamw 	uint32_t		sv_refcnt;
610da6c28aaSamw 	vfs_t			*sv_vfsp;
611da6c28aaSamw 	vnode_t			*sv_rootvp;
612da6c28aaSamw } smb_vfs_t;
613da6c28aaSamw 
6142c2961f8Sjose borrego #define	SMB_NODE_MAGIC		0x4E4F4445	/* 'NODE' */
6152c2961f8Sjose borrego #define	SMB_NODE_VALID(p)	ASSERT((p)->n_magic == SMB_NODE_MAGIC)
616da6c28aaSamw 
617da6c28aaSamw typedef enum {
618da6c28aaSamw 	SMB_NODE_STATE_AVAILABLE = 0,
619da6c28aaSamw 	SMB_NODE_STATE_DESTROYING
620da6c28aaSamw } smb_node_state_t;
621da6c28aaSamw 
6229fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States /*
6239fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * waiting_event        # of clients requesting FCN
6249fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_timestamps         cached timestamps
6259fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_allocsz            cached file allocation size
6269fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_dnode              directory node
6279fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_unode              unnamed stream node
6289fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * delete_on_close_cred credentials for delayed delete
6299fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  */
630da6c28aaSamw typedef struct smb_node {
631*a90cf9f2SGordon Ross 	list_node_t		n_lnd;
632da6c28aaSamw 	uint32_t		n_magic;
6332c2961f8Sjose borrego 	krwlock_t		n_lock;
6342c2961f8Sjose borrego 	kmutex_t		n_mutex;
635da6c28aaSamw 	smb_node_state_t	n_state;
636da6c28aaSamw 	uint32_t		n_refcnt;
637da6c28aaSamw 	uint32_t		n_hashkey;
638da6c28aaSamw 	smb_llist_t		*n_hash_bucket;
6392c2961f8Sjose borrego 	uint32_t		n_open_count;
640cb174861Sjoyce mcintosh 	uint32_t		n_opening_count;
641da6c28aaSamw 	smb_llist_t		n_ofile_list;
642da6c28aaSamw 	smb_llist_t		n_lock_list;
6435fd03bc0SGordon Ross 	uint32_t		n_pending_dosattr;
6449fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	volatile int		flags;
6459fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	u_offset_t		n_allocsz;
646ccc71be5SGordon Ross 	smb_node_fcn_t		n_fcn;
647da6c28aaSamw 	smb_oplock_t		n_oplock;
6489fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_node		*n_dnode;
6499fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_node		*n_unode;
650da6c28aaSamw 	cred_t			*delete_on_close_cred;
6518b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		n_delete_on_close_flags;
652da6c28aaSamw 	char			od_name[MAXNAMELEN];
653da6c28aaSamw 	vnode_t			*vp;
654da6c28aaSamw 	smb_audit_buf_node_t	*n_audit_buf;
655da6c28aaSamw } smb_node_t;
656da6c28aaSamw 
6579fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_REPARSE		0x00001000
6589fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_DFSLINK		0x00002000
6599fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_VFSROOT		0x00004000
6609fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_SYSTEM		0x00008000
661da6c28aaSamw #define	NODE_FLAGS_WRITE_THROUGH	0x00100000
662cbfb650aScp #define	NODE_XATTR_DIR			0x01000000
663*a90cf9f2SGordon Ross #define	NODE_FLAGS_WATCH_TREE		0x10000000	/* smb_notify.c */
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 	kmutex_t	shr_mutex;
693148c5f43SAlan Wright } smb_kshare_t;
694148c5f43SAlan Wright 
695148c5f43SAlan Wright 
696148c5f43SAlan Wright typedef struct smb_arg_negotiate {
697148c5f43SAlan Wright 	char		*ni_name;
698148c5f43SAlan Wright 	int		ni_dialect;
699148c5f43SAlan Wright 	int		ni_index;
700148c5f43SAlan Wright 	uint32_t	ni_capabilities;
701148c5f43SAlan Wright 	uint16_t	ni_maxmpxcount;
702148c5f43SAlan Wright 	int16_t		ni_tzcorrection;
703148c5f43SAlan Wright 	uint8_t		ni_keylen;
704148c5f43SAlan Wright 	uint8_t		ni_key[SMB_ENCRYPT_KEY_MAXLEN];
705148c5f43SAlan Wright 	timestruc_t	ni_servertime;
706148c5f43SAlan Wright } smb_arg_negotiate_t;
707148c5f43SAlan Wright 
70812b65585SGordon Ross typedef enum {
70912b65585SGordon Ross 	SMB_SSNSETUP_PRE_NTLM012 = 1,
71012b65585SGordon Ross 	SMB_SSNSETUP_NTLM012_NOEXT,
71112b65585SGordon Ross 	SMB_SSNSETUP_NTLM012_EXTSEC
71212b65585SGordon Ross } smb_ssnsetup_type_t;
71312b65585SGordon Ross 
714148c5f43SAlan Wright typedef struct smb_arg_sessionsetup {
71512b65585SGordon Ross 	smb_ssnsetup_type_t ssi_type;
716148c5f43SAlan Wright 	char		*ssi_user;
717148c5f43SAlan Wright 	char		*ssi_domain;
71812b65585SGordon Ross 	/* LM password hash, f.k.a. case-insensitive p/w */
71912b65585SGordon Ross 	uint16_t	ssi_lmpwlen;
72012b65585SGordon Ross 	uint8_t		*ssi_lmpwd;
72112b65585SGordon Ross 	/* NT password hash, f.k.a. case-sensitive p/w */
72212b65585SGordon Ross 	uint16_t	ssi_ntpwlen;
72312b65585SGordon Ross 	uint8_t		*ssi_ntpwd;
72412b65585SGordon Ross 	/* Incoming security blob */
72512b65585SGordon Ross 	uint16_t	ssi_iseclen;
72612b65585SGordon Ross 	uint8_t		*ssi_isecblob;
72712b65585SGordon Ross 	/* Incoming security blob */
72812b65585SGordon Ross 	uint16_t	ssi_oseclen;
72912b65585SGordon Ross 	uint8_t		*ssi_osecblob;
73012b65585SGordon Ross 	/* parameters */
73112b65585SGordon Ross 	uint16_t	ssi_maxbufsize;
732148c5f43SAlan Wright 	uint16_t	ssi_maxmpxcount;
733148c5f43SAlan Wright 	uint32_t	ssi_capabilities;
73412b65585SGordon Ross 	int		ssi_native_os;
73512b65585SGordon Ross 	int		ssi_native_lm;
736148c5f43SAlan Wright } smb_arg_sessionsetup_t;
737148c5f43SAlan Wright 
738148c5f43SAlan Wright typedef struct tcon {
739*a90cf9f2SGordon Ross 	char		*name;
740148c5f43SAlan Wright 	char		*path;
741148c5f43SAlan Wright 	char		*service;
742148c5f43SAlan Wright 	int		pwdlen;
743148c5f43SAlan Wright 	char		*password;
744148c5f43SAlan Wright 	uint16_t	flags;
745148c5f43SAlan Wright 	uint16_t	optional_support;
746148c5f43SAlan Wright 	smb_kshare_t	*si;
747148c5f43SAlan Wright } smb_arg_tcon_t;
748148c5f43SAlan Wright 
749da6c28aaSamw /*
750da6c28aaSamw  * Based on section 2.6.1.2 (Connection Management) of the June 13,
751da6c28aaSamw  * 1996 CIFS spec, a server may terminate the transport connection
752da6c28aaSamw  * due to inactivity. The client software is expected to be able to
753da6c28aaSamw  * automatically reconnect to the server if this happens. Like much
754da6c28aaSamw  * of the useful background information, this section appears to
755da6c28aaSamw  * have been dropped from later revisions of the document.
756da6c28aaSamw  *
757da6c28aaSamw  * Each session has an activity timestamp that's updated whenever a
758da6c28aaSamw  * request is dispatched. If the session is idle, i.e. receives no
759da6c28aaSamw  * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be
760da6c28aaSamw  * closed.
761da6c28aaSamw  *
762da6c28aaSamw  * Each session has an I/O semaphore to serialize communication with
763da6c28aaSamw  * the client. For example, after receiving a raw-read request, the
764da6c28aaSamw  * server is not allowed to send an oplock break to the client until
765da6c28aaSamw  * after it has sent the raw-read data.
766da6c28aaSamw  */
767da6c28aaSamw #define	SMB_SESSION_INACTIVITY_TIMEOUT		(15 * 60)
768da6c28aaSamw 
769e3f2c991SKeyur Desai #define	SMB_SESSION_OFILE_MAX			(16 * 1024)
770da6c28aaSamw 
771*a90cf9f2SGordon Ross /* SMB1 signing */
772da6c28aaSamw struct smb_sign {
773da6c28aaSamw 	unsigned int flags;
774b819cea2SGordon Ross 	uint32_t seqnum;
775b819cea2SGordon Ross 	uint_t mackey_len;
776b819cea2SGordon Ross 	uint8_t *mackey;
777da6c28aaSamw };
778da6c28aaSamw 
779*a90cf9f2SGordon Ross /*
780*a90cf9f2SGordon Ross  * SMB2 signing
781*a90cf9f2SGordon Ross  */
782*a90cf9f2SGordon Ross struct smb_key {
783*a90cf9f2SGordon Ross 	uint_t len;
784*a90cf9f2SGordon Ross 	uint8_t key[SMB2_SESSION_KEY_LEN];
785*a90cf9f2SGordon Ross };
786*a90cf9f2SGordon Ross 
787da6c28aaSamw #define	SMB_SIGNING_ENABLED	1
788da6c28aaSamw #define	SMB_SIGNING_CHECK	2
789da6c28aaSamw 
790da6c28aaSamw /*
791da6c28aaSamw  * Session State Machine
792da6c28aaSamw  * ---------------------
793da6c28aaSamw  *
794da6c28aaSamw  * +-----------------------------+	     +------------------------------+
795da6c28aaSamw  * | SMB_SESSION_STATE_CONNECTED |           | SMB_SESSION_STATE_TERMINATED |
796da6c28aaSamw  * +-----------------------------+           +------------------------------+
797da6c28aaSamw  *		T0|					     ^
798*a90cf9f2SGordon Ross  *		  +--------------------+		     |T5
799*a90cf9f2SGordon Ross  *		  v		       |T4                   |
800da6c28aaSamw  * +-------------------------------+   |    +--------------------------------+
801da6c28aaSamw  * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED |
802da6c28aaSamw  * +-------------------------------+        +--------------------------------+
803*a90cf9f2SGordon Ross  *		T1|				^
804*a90cf9f2SGordon Ross  *		  +----------+			|T3
805*a90cf9f2SGordon Ross  *                           v			|
806*a90cf9f2SGordon Ross  *                  +------------------------------+
807*a90cf9f2SGordon Ross  *                  | SMB_SESSION_STATE_NEGOTIATED |
808*a90cf9f2SGordon Ross  *                  +------------------------------+
809*a90cf9f2SGordon Ross  *
810da6c28aaSamw  *
811da6c28aaSamw  * Transition T0
812da6c28aaSamw  *
813da6c28aaSamw  *
814da6c28aaSamw  *
815da6c28aaSamw  * Transition T1
816da6c28aaSamw  *
817da6c28aaSamw  *
818da6c28aaSamw  *
819da6c28aaSamw  * Transition T2
820da6c28aaSamw  *
821da6c28aaSamw  *
822da6c28aaSamw  *
823da6c28aaSamw  * Transition T3
824da6c28aaSamw  *
825da6c28aaSamw  *
826da6c28aaSamw  *
827da6c28aaSamw  * Transition T4
828da6c28aaSamw  *
829da6c28aaSamw  *
830da6c28aaSamw  *
831da6c28aaSamw  * Transition T5
832da6c28aaSamw  *
833da6c28aaSamw  *
834da6c28aaSamw  *
835da6c28aaSamw  */
8362c2961f8Sjose borrego #define	SMB_SESSION_MAGIC	0x53455353	/* 'SESS' */
8379fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_SESSION_VALID(p)	\
8389fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((p) != NULL) && ((p)->s_magic == SMB_SESSION_MAGIC))
839da6c28aaSamw 
840f9bc6dadSDmitry.Savitsky@nexenta.com #define	SMB_CHALLENGE_SZ	8
841f9bc6dadSDmitry.Savitsky@nexenta.com 
842da6c28aaSamw typedef enum {
843faa1795aSjb 	SMB_SESSION_STATE_INITIALIZED = 0,
844faa1795aSjb 	SMB_SESSION_STATE_DISCONNECTED,
845da6c28aaSamw 	SMB_SESSION_STATE_CONNECTED,
846da6c28aaSamw 	SMB_SESSION_STATE_ESTABLISHED,
847da6c28aaSamw 	SMB_SESSION_STATE_NEGOTIATED,
8486537f381Sas 	SMB_SESSION_STATE_TERMINATED,
8496537f381Sas 	SMB_SESSION_STATE_SENTINEL
850da6c28aaSamw } smb_session_state_t;
851da6c28aaSamw 
852faa1795aSjb typedef struct smb_session {
853*a90cf9f2SGordon Ross 	list_node_t		s_lnd;
854da6c28aaSamw 	uint32_t		s_magic;
855da6c28aaSamw 	smb_rwx_t		s_lock;
856da6c28aaSamw 	uint64_t		s_kid;
857da6c28aaSamw 	smb_session_state_t	s_state;
858da6c28aaSamw 	uint32_t		s_flags;
8598622ec45SGordon Ross 	taskqid_t		s_receiver_tqid;
860faa1795aSjb 	kthread_t		*s_thread;
861faa1795aSjb 	kt_did_t		s_ktdid;
862*a90cf9f2SGordon Ross 	int	(*newrq_func)(struct smb_request *);
863faa1795aSjb 	struct smb_server	*s_server;
864*a90cf9f2SGordon Ross 	smb_kmod_cfg_t		s_cfg;
865c8ec8eeaSjose borrego 	int32_t			s_gmtoff;
866da6c28aaSamw 	uint32_t		keep_alive;
867da6c28aaSamw 	uint64_t		opentime;
868da6c28aaSamw 	uint16_t		s_local_port;
869*a90cf9f2SGordon Ross 	uint16_t		s_remote_port;
8707f667e74Sjose borrego 	smb_inaddr_t		ipaddr;
8717f667e74Sjose borrego 	smb_inaddr_t		local_ipaddr;
872da6c28aaSamw 	int			dialect;
873da6c28aaSamw 	int			native_os;
874148c5f43SAlan Wright 	int			native_lm;
875148c5f43SAlan Wright 
876*a90cf9f2SGordon Ross 	kmutex_t		s_credits_mutex;
877*a90cf9f2SGordon Ross 	uint16_t		s_cur_credits;
878*a90cf9f2SGordon Ross 	uint16_t		s_max_credits;
879*a90cf9f2SGordon Ross 
880da6c28aaSamw 	uint32_t		capabilities;
88112b65585SGordon Ross 
88212b65585SGordon Ross 	struct smb_sign		signing;	/* SMB1 */
88312b65585SGordon Ross 	void			*sign_mech;	/* mechanism info */
884b819cea2SGordon Ross 	void			(*sign_fini)(struct smb_session *);
885da6c28aaSamw 
8860f1702c5SYu Xiangning 	ksocket_t		sock;
887da6c28aaSamw 
888da6c28aaSamw 	smb_slist_t		s_req_list;
889da6c28aaSamw 	smb_llist_t		s_xa_list;
890da6c28aaSamw 	smb_llist_t		s_user_list;
8913b13a1efSThomas Keiser 	smb_llist_t		s_tree_list;
892da6c28aaSamw 	smb_idpool_t		s_uid_pool;
8933b13a1efSThomas Keiser 	smb_idpool_t		s_tid_pool;
8945cdbe942Sjb 	smb_txlst_t		s_txlst;
895da6c28aaSamw 
896da6c28aaSamw 	volatile uint32_t	s_tree_cnt;
897da6c28aaSamw 	volatile uint32_t	s_file_cnt;
898da6c28aaSamw 	volatile uint32_t	s_dir_cnt;
899da6c28aaSamw 
900da6c28aaSamw 	uint16_t		secmode;
901da6c28aaSamw 	uint32_t		sesskey;
902da6c28aaSamw 	uint32_t		challenge_len;
903f9bc6dadSDmitry.Savitsky@nexenta.com 	unsigned char		challenge_key[SMB_CHALLENGE_SZ];
904da6c28aaSamw 	int64_t			activity_timestamp;
905da6c28aaSamw 	/*
906*a90cf9f2SGordon Ross 	 * Maximum negotiated buffer sizes between SMB client and server
907da6c28aaSamw 	 * in SMB_SESSION_SETUP_ANDX
908da6c28aaSamw 	 */
909*a90cf9f2SGordon Ross 	int			cmd_max_bytes;
910*a90cf9f2SGordon Ross 	int			reply_max_bytes;
911da6c28aaSamw 	uint16_t		smb_msg_size;
91212b65585SGordon Ross 	uint16_t		smb_max_mpx;
913da6c28aaSamw 	uchar_t			*outpipe_data;
914da6c28aaSamw 	int			outpipe_datalen;
915da6c28aaSamw 	int			outpipe_cookie;
916148c5f43SAlan Wright 	smb_srqueue_t		*s_srqueue;
917*a90cf9f2SGordon Ross 	uint64_t		start_time;
918*a90cf9f2SGordon Ross 	unsigned char		MAC_key[44];
91949b5df1eSGordon Ross 	char			ip_addr_str[INET6_ADDRSTRLEN];
920*a90cf9f2SGordon Ross 	char			clnt_uuid[16];
92149b5df1eSGordon Ross 	char 			workstation[SMB_PI_MAX_HOST];
922faa1795aSjb } smb_session_t;
923da6c28aaSamw 
924da6c28aaSamw #define	SMB_USER_MAGIC 0x55534552	/* 'USER' */
9259fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_USER_VALID(u)	\
9269fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((u) != NULL) && ((u)->u_magic == SMB_USER_MAGIC))
927da6c28aaSamw 
928da6c28aaSamw #define	SMB_USER_FLAG_GUEST			SMB_ATF_GUEST
929*a90cf9f2SGordon Ross #define	SMB_USER_FLAG_ANON			SMB_ATF_ANON
930da6c28aaSamw #define	SMB_USER_FLAG_ADMIN			SMB_ATF_ADMIN
931da6c28aaSamw #define	SMB_USER_FLAG_POWER_USER		SMB_ATF_POWERUSER
932da6c28aaSamw #define	SMB_USER_FLAG_BACKUP_OPERATOR		SMB_ATF_BACKUPOP
933da6c28aaSamw 
934148c5f43SAlan Wright #define	SMB_USER_IS_ADMIN(U)	(((U)->u_flags & SMB_USER_FLAG_ADMIN) != 0)
935148c5f43SAlan Wright #define	SMB_USER_IS_GUEST(U)	(((U)->u_flags & SMB_USER_FLAG_GUEST) != 0)
936148c5f43SAlan Wright 
937da6c28aaSamw #define	SMB_USER_PRIV_TAKE_OWNERSHIP	0x00000001
938da6c28aaSamw #define	SMB_USER_PRIV_BACKUP		0x00000002
939da6c28aaSamw #define	SMB_USER_PRIV_RESTORE		0x00000004
940da6c28aaSamw #define	SMB_USER_PRIV_SECURITY		0x00000008
941da6c28aaSamw 
942da6c28aaSamw 
943da6c28aaSamw typedef enum {
94412b65585SGordon Ross 	SMB_USER_STATE_LOGGING_ON = 0,
94512b65585SGordon Ross 	SMB_USER_STATE_LOGGED_ON,
946da6c28aaSamw 	SMB_USER_STATE_LOGGING_OFF,
9476537f381Sas 	SMB_USER_STATE_LOGGED_OFF,
9486537f381Sas 	SMB_USER_STATE_SENTINEL
949da6c28aaSamw } smb_user_state_t;
950da6c28aaSamw 
951da6c28aaSamw typedef struct smb_user {
952da6c28aaSamw 	list_node_t		u_lnd;
953*a90cf9f2SGordon Ross 	uint32_t		u_magic;
954da6c28aaSamw 	kmutex_t		u_mutex;
955da6c28aaSamw 	smb_user_state_t	u_state;
956da6c28aaSamw 
957faa1795aSjb 	struct smb_server	*u_server;
958da6c28aaSamw 	smb_session_t		*u_session;
95912b65585SGordon Ross 	ksocket_t		u_authsock;
960da6c28aaSamw 	uint16_t		u_name_len;
961da6c28aaSamw 	char			*u_name;
962da6c28aaSamw 	uint16_t		u_domain_len;
963da6c28aaSamw 	char			*u_domain;
964da6c28aaSamw 	time_t			u_logon_time;
965da6c28aaSamw 	cred_t			*u_cred;
966b89a8333Snatalie li - Sun Microsystems - Irvine United States 	cred_t			*u_privcred;
967da6c28aaSamw 
968da6c28aaSamw 	uint32_t		u_refcnt;
969da6c28aaSamw 	uint32_t		u_flags;
970da6c28aaSamw 	uint32_t		u_privileges;
971da6c28aaSamw 	uint16_t		u_uid;
972da6c28aaSamw 	uint32_t		u_audit_sid;
973*a90cf9f2SGordon Ross 
974*a90cf9f2SGordon Ross 	uint32_t		u_sign_flags;
975*a90cf9f2SGordon Ross 	struct smb_key		u_sign_key;	/* SMB2 signing */
976da6c28aaSamw } smb_user_t;
977da6c28aaSamw 
978c8ec8eeaSjose borrego #define	SMB_TREE_MAGIC			0x54524545	/* 'TREE' */
9799fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_VALID(p)	\
9809fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT((p != NULL) && ((p)->t_magic == SMB_TREE_MAGIC))
981c8ec8eeaSjose borrego 
982c8ec8eeaSjose borrego #define	SMB_TYPENAMELEN			_ST_FSTYPSZ
983c8ec8eeaSjose borrego #define	SMB_VOLNAMELEN			32
984c8ec8eeaSjose borrego 
985c8ec8eeaSjose borrego #define	SMB_TREE_READONLY		0x00000001
986c8ec8eeaSjose borrego #define	SMB_TREE_SUPPORTS_ACLS		0x00000002
987c8ec8eeaSjose borrego #define	SMB_TREE_STREAMS		0x00000004
988c8ec8eeaSjose borrego #define	SMB_TREE_CASEINSENSITIVE	0x00000008
989c8ec8eeaSjose borrego #define	SMB_TREE_NO_CASESENSITIVE	0x00000010
990c8ec8eeaSjose borrego #define	SMB_TREE_NO_EXPORT		0x00000020
991cb174861Sjoyce mcintosh #define	SMB_TREE_OPLOCKS		0x00000040
992cb174861Sjoyce mcintosh #define	SMB_TREE_SHORTNAMES		0x00000080
993c8ec8eeaSjose borrego #define	SMB_TREE_XVATTR			0x00000100
994c8ec8eeaSjose borrego #define	SMB_TREE_DIRENTFLAGS		0x00000200
995c8ec8eeaSjose borrego #define	SMB_TREE_ACLONCREATE		0x00000400
996c8ec8eeaSjose borrego #define	SMB_TREE_ACEMASKONACCESS	0x00000800
997c8ec8eeaSjose borrego #define	SMB_TREE_NFS_MOUNTED		0x00001000
998fc724630SAlan Wright #define	SMB_TREE_UNICODE_ON_DISK	0x00002000
9998b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_CATIA			0x00004000
1000e3f2c991SKeyur Desai #define	SMB_TREE_ABE			0x00008000
10019fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_QUOTA			0x00010000
10029fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_DFSROOT		0x00020000
1003fd9ee8b5Sjoyce mcintosh #define	SMB_TREE_SPARSE			0x00040000
10045f1ef25cSAram Hăvărneanu #define	SMB_TREE_TRAVERSE_MOUNTS	0x00080000
10052c1b14e5Sjose borrego 
1006da6c28aaSamw typedef enum {
1007da6c28aaSamw 	SMB_TREE_STATE_CONNECTED = 0,
1008da6c28aaSamw 	SMB_TREE_STATE_DISCONNECTING,
10096537f381Sas 	SMB_TREE_STATE_DISCONNECTED,
10106537f381Sas 	SMB_TREE_STATE_SENTINEL
1011da6c28aaSamw } smb_tree_state_t;
1012da6c28aaSamw 
1013da6c28aaSamw typedef struct smb_tree {
1014*a90cf9f2SGordon Ross 	list_node_t		t_lnd;
1015da6c28aaSamw 	uint32_t		t_magic;
1016da6c28aaSamw 	kmutex_t		t_mutex;
1017da6c28aaSamw 	smb_tree_state_t	t_state;
1018da6c28aaSamw 
1019faa1795aSjb 	struct smb_server	*t_server;
1020da6c28aaSamw 	smb_session_t		*t_session;
10213b13a1efSThomas Keiser 	/*
10223b13a1efSThomas Keiser 	 * user whose uid was in the tree connect message
10233b13a1efSThomas Keiser 	 * ("owner" in MS-CIFS parlance, see section 2.2.1.6 definition of FID)
10243b13a1efSThomas Keiser 	 */
10253b13a1efSThomas Keiser 	smb_user_t		*t_owner;
1026da6c28aaSamw 	smb_node_t		*t_snode;
1027da6c28aaSamw 
1028da6c28aaSamw 	smb_llist_t		t_ofile_list;
1029da6c28aaSamw 	smb_idpool_t		t_fid_pool;
1030da6c28aaSamw 
1031da6c28aaSamw 	smb_llist_t		t_odir_list;
10327f667e74Sjose borrego 	smb_idpool_t		t_odid_pool;
1033da6c28aaSamw 
1034da6c28aaSamw 	uint32_t		t_refcnt;
1035da6c28aaSamw 	uint32_t		t_flags;
1036da6c28aaSamw 	int32_t			t_res_type;
1037da6c28aaSamw 	uint16_t		t_tid;
1038da6c28aaSamw 	uint16_t		t_umask;
1039da6c28aaSamw 	char			t_sharename[MAXNAMELEN];
1040da6c28aaSamw 	char			t_resource[MAXPATHLEN];
1041c8ec8eeaSjose borrego 	char			t_typename[SMB_TYPENAMELEN];
1042c8ec8eeaSjose borrego 	char			t_volume[SMB_VOLNAMELEN];
1043da6c28aaSamw 	acl_type_t		t_acltype;
1044743a77edSAlan Wright 	uint32_t		t_access;
1045148c5f43SAlan Wright 	uint32_t		t_execflags;
10461fcced4cSJordan Brown 	time_t			t_connect_time;
10471fcced4cSJordan Brown 	volatile uint32_t	t_open_files;
1048da6c28aaSamw } smb_tree_t;
1049da6c28aaSamw 
1050c8ec8eeaSjose borrego #define	SMB_TREE_VFS(tree)	((tree)->t_snode->vp->v_vfsp)
1051c8ec8eeaSjose borrego #define	SMB_TREE_FSID(tree)	((tree)->t_snode->vp->v_vfsp->vfs_fsid)
1052c8ec8eeaSjose borrego 
1053743a77edSAlan Wright #define	SMB_TREE_IS_READONLY(sr)					\
1054743a77edSAlan Wright 	((sr) != NULL && (sr)->tid_tree != NULL &&			\
1055743a77edSAlan Wright 	!((sr)->tid_tree->t_access & ACE_ALL_WRITE_PERMS))
1056c8ec8eeaSjose borrego 
1057c8ec8eeaSjose borrego #define	SMB_TREE_IS_CASEINSENSITIVE(sr)                                 \
1058c8ec8eeaSjose borrego 	(((sr) && (sr)->tid_tree) ?                                     \
1059c8ec8eeaSjose borrego 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0)
1060da6c28aaSamw 
1061743a77edSAlan Wright #define	SMB_TREE_HAS_ACCESS(sr, acemask)				\
1062743a77edSAlan Wright 	((sr) == NULL ? ACE_ALL_PERMS : (				\
1063743a77edSAlan Wright 	(((sr) && (sr)->tid_tree) ?					\
1064743a77edSAlan Wright 	(((sr)->tid_tree->t_access) & (acemask)) : 0)))
1065743a77edSAlan Wright 
10668b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_SUPPORTS_CATIA(sr)            				\
10678b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	(((sr) && (sr)->tid_tree) ?                                     \
10688b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CATIA) : 0)
10698b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 
1070e3f2c991SKeyur Desai #define	SMB_TREE_SUPPORTS_ABE(sr)            				\
1071e3f2c991SKeyur Desai 	(((sr) && (sr)->tid_tree) ?                                     \
1072e3f2c991SKeyur Desai 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_ABE) : 0)
1073e3f2c991SKeyur Desai 
10749fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_IS_DFSROOT(sr)            				\
10759fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	(((sr) && (sr)->tid_tree) ?                                     \
10769fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_DFSROOT) : 0)
10779fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
1078cb174861Sjoyce mcintosh #define	SMB_TREE_SUPPORTS_SHORTNAMES(sr)				\
1079cb174861Sjoyce mcintosh 	(((sr) && (sr)->tid_tree) ?					\
1080cb174861Sjoyce mcintosh 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_SHORTNAMES) : 0)
1081cb174861Sjoyce mcintosh 
1082da6c28aaSamw /*
10835f1ef25cSAram Hăvărneanu  * SMB_TREE_CONTAINS_NODE is used to check if a node is on the same
10845f1ef25cSAram Hăvărneanu  * file system as the tree's root filesystem, or if mount point traversal
10855f1ef25cSAram Hăvărneanu  * should be allowed.  Note that this is also called in some cases with
10865f1ef25cSAram Hăvărneanu  * sr=NULL, where it is expected to evaluate to TRUE.
1087da6c28aaSamw  */
10885f1ef25cSAram Hăvărneanu 
1089c8ec8eeaSjose borrego #define	SMB_TREE_CONTAINS_NODE(sr, node)                                \
10905f1ef25cSAram Hăvărneanu 	((sr) == NULL || (sr)->tid_tree == NULL ||                      \
10915f1ef25cSAram Hăvărneanu 	SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node) ||           \
10925f1ef25cSAram Hăvărneanu 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_TRAVERSE_MOUNTS))
1093da6c28aaSamw 
1094da6c28aaSamw /*
1095c8ec8eeaSjose borrego  * SMB_OFILE_IS_READONLY reflects whether an ofile is readonly or not.
10965fd03bc0SGordon Ross  * The macro takes into account read-only settings in any of:
10975fd03bc0SGordon Ross  * the tree, the node (pending) and the file-system object.
10985fd03bc0SGordon Ross  * all of this is evaluated in smb_ofile_open() and after that
10995fd03bc0SGordon Ross  * we can just test the f_flags & SMB_OFLAGS_READONLY
1100da6c28aaSamw  */
11015fd03bc0SGordon Ross #define	SMB_OFILE_IS_READONLY(of)	\
11025fd03bc0SGordon Ross 	((of)->f_flags & SMB_OFLAGS_READONLY)
1103da6c28aaSamw 
1104c8ec8eeaSjose borrego /*
1105c8ec8eeaSjose borrego  * SMB_PATHFILE_IS_READONLY indicates whether or not a file is
11065fd03bc0SGordon Ross  * readonly when the caller has a path rather than an ofile.
1107c8ec8eeaSjose borrego  */
11085fd03bc0SGordon Ross #define	SMB_PATHFILE_IS_READONLY(sr, node)			\
11095fd03bc0SGordon Ross 	(SMB_TREE_IS_READONLY((sr)) ||				\
11105fd03bc0SGordon Ross 	smb_node_file_is_readonly((node)))
1111da6c28aaSamw 
1112*a90cf9f2SGordon Ross #define	SMB_ODIR_MAGIC 		0x4F444952	/* 'ODIR' */
1113*a90cf9f2SGordon Ross #define	SMB_ODIR_VALID(p)	\
1114*a90cf9f2SGordon Ross     ASSERT((p != NULL) && ((p)->d_magic == SMB_ODIR_MAGIC))
1115*a90cf9f2SGordon Ross 
1116*a90cf9f2SGordon Ross #define	SMB_ODIR_BUFSIZE	(8 * 1024)
1117*a90cf9f2SGordon Ross 
1118*a90cf9f2SGordon Ross #define	SMB_ODIR_FLAG_WILDCARDS		0x0001
1119*a90cf9f2SGordon Ross #define	SMB_ODIR_FLAG_IGNORE_CASE	0x0002
1120*a90cf9f2SGordon Ross #define	SMB_ODIR_FLAG_XATTR		0x0004
1121*a90cf9f2SGordon Ross #define	SMB_ODIR_FLAG_EDIRENT		0x0008
1122*a90cf9f2SGordon Ross #define	SMB_ODIR_FLAG_CATIA		0x0010
1123*a90cf9f2SGordon Ross #define	SMB_ODIR_FLAG_ABE		0x0020
1124*a90cf9f2SGordon Ross #define	SMB_ODIR_FLAG_SHORTNAMES	0x0040
1125*a90cf9f2SGordon Ross 
1126*a90cf9f2SGordon Ross typedef enum {
1127*a90cf9f2SGordon Ross 	SMB_ODIR_STATE_OPEN = 0,
1128*a90cf9f2SGordon Ross 	SMB_ODIR_STATE_IN_USE,
1129*a90cf9f2SGordon Ross 	SMB_ODIR_STATE_CLOSING,
1130*a90cf9f2SGordon Ross 	SMB_ODIR_STATE_CLOSED,
1131*a90cf9f2SGordon Ross 	SMB_ODIR_STATE_SENTINEL
1132*a90cf9f2SGordon Ross } smb_odir_state_t;
1133*a90cf9f2SGordon Ross 
1134*a90cf9f2SGordon Ross typedef enum {
1135*a90cf9f2SGordon Ross 	SMB_ODIR_RESUME_CONT,
1136*a90cf9f2SGordon Ross 	SMB_ODIR_RESUME_IDX,
1137*a90cf9f2SGordon Ross 	SMB_ODIR_RESUME_COOKIE,
1138*a90cf9f2SGordon Ross 	SMB_ODIR_RESUME_FNAME
1139*a90cf9f2SGordon Ross } smb_odir_resume_type_t;
1140*a90cf9f2SGordon Ross 
1141*a90cf9f2SGordon Ross typedef struct smb_odir_resume {
1142*a90cf9f2SGordon Ross 	smb_odir_resume_type_t	or_type;
1143*a90cf9f2SGordon Ross 	int			or_idx;
1144*a90cf9f2SGordon Ross 	uint32_t		or_cookie;
1145*a90cf9f2SGordon Ross 	char			*or_fname;
1146*a90cf9f2SGordon Ross } smb_odir_resume_t;
1147*a90cf9f2SGordon Ross 
1148*a90cf9f2SGordon Ross /*
1149*a90cf9f2SGordon Ross  * Flags used when opening an odir
1150*a90cf9f2SGordon Ross  */
1151*a90cf9f2SGordon Ross #define	SMB_ODIR_OPENF_BACKUP_INTENT	0x01
1152*a90cf9f2SGordon Ross 
1153*a90cf9f2SGordon Ross typedef struct smb_odir {
1154*a90cf9f2SGordon Ross 	list_node_t		d_lnd;
1155*a90cf9f2SGordon Ross 	uint32_t		d_magic;
1156*a90cf9f2SGordon Ross 	kmutex_t		d_mutex;
1157*a90cf9f2SGordon Ross 	smb_odir_state_t	d_state;
1158*a90cf9f2SGordon Ross 	smb_session_t		*d_session;
1159*a90cf9f2SGordon Ross 	smb_user_t		*d_user;
1160*a90cf9f2SGordon Ross 	smb_tree_t		*d_tree;
1161*a90cf9f2SGordon Ross 	smb_node_t		*d_dnode;
1162*a90cf9f2SGordon Ross 	cred_t			*d_cred;
1163*a90cf9f2SGordon Ross 	uint32_t		d_opened_by_pid;
1164*a90cf9f2SGordon Ross 	uint16_t		d_odid;
1165*a90cf9f2SGordon Ross 	uint16_t		d_sattr;
1166*a90cf9f2SGordon Ross 	uint32_t		d_refcnt;
1167*a90cf9f2SGordon Ross 	uint32_t		d_flags;
1168*a90cf9f2SGordon Ross 	boolean_t		d_eof;
1169*a90cf9f2SGordon Ross 	int			d_bufsize;
1170*a90cf9f2SGordon Ross 	uint64_t		d_offset;
1171*a90cf9f2SGordon Ross 	union {
1172*a90cf9f2SGordon Ross 		char		*u_bufptr;
1173*a90cf9f2SGordon Ross 		struct edirent	*u_edp;
1174*a90cf9f2SGordon Ross 		struct dirent64	*u_dp;
1175*a90cf9f2SGordon Ross 	} d_u;
1176*a90cf9f2SGordon Ross 	uint32_t		d_last_cookie;
1177*a90cf9f2SGordon Ross 	uint32_t		d_cookies[SMB_MAX_SEARCH];
1178*a90cf9f2SGordon Ross 	char			d_pattern[MAXNAMELEN];
1179*a90cf9f2SGordon Ross 	char			d_buf[SMB_ODIR_BUFSIZE];
1180*a90cf9f2SGordon Ross 	char			d_last_name[MAXNAMELEN];
1181*a90cf9f2SGordon Ross } smb_odir_t;
1182*a90cf9f2SGordon Ross #define	d_bufptr	d_u.u_bufptr
1183*a90cf9f2SGordon Ross #define	d_edp		d_u.u_edp
1184*a90cf9f2SGordon Ross #define	d_dp		d_u.u_dp
1185*a90cf9f2SGordon Ross 
1186*a90cf9f2SGordon Ross typedef struct smb_odirent {
1187*a90cf9f2SGordon Ross 	char		od_name[MAXNAMELEN];	/* on disk name */
1188*a90cf9f2SGordon Ross 	ino64_t		od_ino;
1189*a90cf9f2SGordon Ross 	uint32_t	od_eflags;
1190*a90cf9f2SGordon Ross } smb_odirent_t;
1191*a90cf9f2SGordon Ross 
11929fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_OPIPE_MAGIC		0x50495045	/* 'PIPE' */
11939fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_OPIPE_VALID(p)	\
11949fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((p) != NULL) && (p)->p_magic == SMB_OPIPE_MAGIC)
119568b2bbf2SGordon Ross #define	SMB_OPIPE_MAXNAME	32
1196da6c28aaSamw 
11973db3f65cSamw /*
11983db3f65cSamw  * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used
11993db3f65cSamw  * at the interface between SMB and NDR RPC.
12003db3f65cSamw  */
12013db3f65cSamw typedef struct smb_opipe {
12029fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		p_magic;
12039fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmutex_t		p_mutex;
12049fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kcondvar_t		p_cv;
120568b2bbf2SGordon Ross 	struct smb_ofile	*p_ofile;
12069fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_server	*p_server;
120768b2bbf2SGordon Ross 	uint32_t		p_refcnt;
120868b2bbf2SGordon Ross 	ksocket_t		p_socket;
120968b2bbf2SGordon Ross 	/* This is the "flat" name, without path prefix */
121068b2bbf2SGordon Ross 	char			p_name[SMB_OPIPE_MAXNAME];
12113db3f65cSamw } smb_opipe_t;
12123db3f65cSamw 
1213da6c28aaSamw /*
1214da6c28aaSamw  * The of_ftype	of an open file should contain the SMB_FTYPE value
1215bbf6f00cSJordan Brown  * returned when the file/pipe was opened. The following
1216da6c28aaSamw  * assumptions are currently made:
1217da6c28aaSamw  *
1218da6c28aaSamw  * File Type	    Node       PipeInfo
1219da6c28aaSamw  * ---------	    --------   --------
1220da6c28aaSamw  * SMB_FTYPE_DISK       Valid      Null
1221da6c28aaSamw  * SMB_FTYPE_BYTE_PIPE  Undefined  Undefined
1222da6c28aaSamw  * SMB_FTYPE_MESG_PIPE  Null       Valid
1223da6c28aaSamw  * SMB_FTYPE_PRINTER    Undefined  Undefined
1224da6c28aaSamw  * SMB_FTYPE_UNKNOWN    Undefined  Undefined
1225da6c28aaSamw  */
1226da6c28aaSamw 
1227da6c28aaSamw /*
1228da6c28aaSamw  * Some flags for ofile structure
1229da6c28aaSamw  *
1230da6c28aaSamw  *	SMB_OFLAGS_SET_DELETE_ON_CLOSE
1231da6c28aaSamw  *   Set this flag when the corresponding open operation whose
1232da6c28aaSamw  *   DELETE_ON_CLOSE bit of the CreateOptions is set. If any
1233da6c28aaSamw  *   open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE
1234da6c28aaSamw  *   will be set for the file node upon close.
1235da6c28aaSamw  */
1236da6c28aaSamw 
1237c8ec8eeaSjose borrego #define	SMB_OFLAGS_READONLY		0x0001
12382c2961f8Sjose borrego #define	SMB_OFLAGS_EXECONLY		0x0002
1239da6c28aaSamw #define	SMB_OFLAGS_SET_DELETE_ON_CLOSE	0x0004
1240da6c28aaSamw #define	SMB_OFLAGS_LLF_POS_VALID	0x0008
1241da6c28aaSamw 
1242da6c28aaSamw #define	SMB_OFILE_MAGIC 	0x4F464C45	/* 'OFLE' */
12439fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_OFILE_VALID(p)	\
12449fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT((p != NULL) && ((p)->f_magic == SMB_OFILE_MAGIC))
1245da6c28aaSamw 
1246da6c28aaSamw typedef enum {
1247da6c28aaSamw 	SMB_OFILE_STATE_OPEN = 0,
1248da6c28aaSamw 	SMB_OFILE_STATE_CLOSING,
12496537f381Sas 	SMB_OFILE_STATE_CLOSED,
12506537f381Sas 	SMB_OFILE_STATE_SENTINEL
1251da6c28aaSamw } smb_ofile_state_t;
1252da6c28aaSamw 
1253da6c28aaSamw typedef struct smb_ofile {
1254*a90cf9f2SGordon Ross 	list_node_t		f_lnd;	/* t_ofile_list */
1255*a90cf9f2SGordon Ross 	list_node_t		f_nnd;	/* n_ofile_list */
1256da6c28aaSamw 	uint32_t		f_magic;
1257da6c28aaSamw 	kmutex_t		f_mutex;
1258da6c28aaSamw 	smb_ofile_state_t	f_state;
1259da6c28aaSamw 
1260faa1795aSjb 	struct smb_server	*f_server;
1261da6c28aaSamw 	smb_session_t		*f_session;
1262da6c28aaSamw 	smb_user_t		*f_user;
1263da6c28aaSamw 	smb_tree_t		*f_tree;
1264da6c28aaSamw 	smb_node_t		*f_node;
1265*a90cf9f2SGordon Ross 	smb_odir_t		*f_odir;
12663db3f65cSamw 	smb_opipe_t		*f_pipe;
1267da6c28aaSamw 
1268dc20a302Sas 	uint32_t		f_uniqid;
1269da6c28aaSamw 	uint32_t		f_refcnt;
1270da6c28aaSamw 	uint64_t		f_seek_pos;
1271da6c28aaSamw 	uint32_t		f_flags;
1272da6c28aaSamw 	uint32_t		f_granted_access;
1273da6c28aaSamw 	uint32_t		f_share_access;
1274da6c28aaSamw 	uint32_t		f_create_options;
1275*a90cf9f2SGordon Ross 	uint32_t		f_opened_by_pid;
1276da6c28aaSamw 	uint16_t		f_fid;
1277da6c28aaSamw 	uint16_t		f_ftype;
1278da6c28aaSamw 	uint64_t		f_llf_pos;
12798c10a865Sas 	int			f_mode;
1280da6c28aaSamw 	cred_t			*f_cr;
12816537f381Sas 	pid_t			f_pid;
12825fd03bc0SGordon Ross 	smb_attr_t		f_pending_attr;
12835fd03bc0SGordon Ross 	boolean_t		f_written;
12849fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	char			f_quota_resume[SMB_SID_STRSZ];
12851fdeec65Sjoyce mcintosh 	smb_oplock_grant_t	f_oplock_grant;
1286da6c28aaSamw } smb_ofile_t;
1287da6c28aaSamw 
12887f667e74Sjose borrego typedef struct smb_fileinfo {
12897f667e74Sjose borrego 	char		fi_name[MAXNAMELEN];
12907f667e74Sjose borrego 	char		fi_shortname[SMB_SHORTNAMELEN];
1291bfbce3c1SGordon Ross 	uint32_t	fi_cookie;	/* Dir offset (of next entry) */
12927f667e74Sjose borrego 	uint32_t	fi_dosattr;	/* DOS attributes */
12937f667e74Sjose borrego 	uint64_t	fi_nodeid;	/* file system node id */
12947f667e74Sjose borrego 	uint64_t	fi_size;	/* file size in bytes */
12957f667e74Sjose borrego 	uint64_t	fi_alloc_size;	/* allocation size in bytes */
12967f667e74Sjose borrego 	timestruc_t	fi_atime;	/* last access */
12977f667e74Sjose borrego 	timestruc_t	fi_mtime;	/* last modification */
12987f667e74Sjose borrego 	timestruc_t	fi_ctime;	/* last status change */
12997f667e74Sjose borrego 	timestruc_t	fi_crtime;	/* file creation */
13007f667e74Sjose borrego } smb_fileinfo_t;
13017f667e74Sjose borrego 
13027f667e74Sjose borrego typedef struct smb_streaminfo {
13037f667e74Sjose borrego 	uint64_t	si_size;
1304037cac00Sjoyce mcintosh 	uint64_t	si_alloc_size;
13057f667e74Sjose borrego 	char		si_name[MAXPATHLEN];
13067f667e74Sjose borrego } smb_streaminfo_t;
1307da6c28aaSamw 
1308da6c28aaSamw #define	SMB_LOCK_MAGIC 	0x4C4F434B	/* 'LOCK' */
1309da6c28aaSamw 
1310da6c28aaSamw typedef struct smb_lock {
1311*a90cf9f2SGordon Ross 	list_node_t		l_lnd;
1312da6c28aaSamw 	uint32_t		l_magic;
1313da6c28aaSamw 	kmutex_t		l_mutex;
1314da6c28aaSamw 	kcondvar_t		l_cv;
1315da6c28aaSamw 
1316da6c28aaSamw 	list_node_t		l_conflict_lnd;
1317da6c28aaSamw 	smb_slist_t		l_conflict_list;
1318da6c28aaSamw 
1319da6c28aaSamw 	smb_session_t		*l_session;
1320da6c28aaSamw 	smb_ofile_t		*l_file;
1321faa1795aSjb 	struct smb_request	*l_sr;
1322da6c28aaSamw 
1323da6c28aaSamw 	uint32_t		l_flags;
1324da6c28aaSamw 	uint64_t		l_session_kid;
1325da6c28aaSamw 	struct smb_lock		*l_blocked_by; /* Debug info only */
1326da6c28aaSamw 
1327*a90cf9f2SGordon Ross 	uint32_t		l_pid;
1328da6c28aaSamw 	uint16_t		l_uid;
1329da6c28aaSamw 	uint32_t		l_type;
1330da6c28aaSamw 	uint64_t		l_start;
1331da6c28aaSamw 	uint64_t		l_length;
1332da6c28aaSamw 	clock_t			l_end_time;
1333da6c28aaSamw } smb_lock_t;
1334da6c28aaSamw 
1335da6c28aaSamw #define	SMB_LOCK_FLAG_INDEFINITE	0x0004
1336da6c28aaSamw #define	SMB_LOCK_INDEFINITE_WAIT(lock) \
1337da6c28aaSamw 	((lock)->l_flags & SMB_LOCK_FLAG_INDEFINITE)
1338da6c28aaSamw 
1339da6c28aaSamw #define	SMB_LOCK_TYPE_READWRITE		101
1340da6c28aaSamw #define	SMB_LOCK_TYPE_READONLY		102
1341da6c28aaSamw 
1342faa1795aSjb typedef struct vardata_block {
13432c2961f8Sjose borrego 	uint8_t			vdb_tag;
13442c2961f8Sjose borrego 	uint32_t		vdb_len;
13452c2961f8Sjose borrego 	struct uio 		vdb_uio;
13462c2961f8Sjose borrego 	struct iovec		vdb_iovec[MAX_IOVEC];
1347faa1795aSjb } smb_vdb_t;
1348faa1795aSjb 
1349f96bd5c8SAlan Wright #define	SMB_WRMODE_WRITE_THRU	0x0001
1350f96bd5c8SAlan Wright #define	SMB_WRMODE_IS_STABLE(M)	((M) & SMB_WRMODE_WRITE_THRU)
1351f96bd5c8SAlan Wright 
1352faa1795aSjb #define	SMB_RW_MAGIC		0x52445257	/* 'RDRW' */
1353faa1795aSjb 
1354faa1795aSjb typedef struct smb_rw_param {
1355faa1795aSjb 	uint32_t rw_magic;
1356faa1795aSjb 	smb_vdb_t rw_vdb;
1357faa1795aSjb 	uint64_t rw_offset;
1358faa1795aSjb 	uint32_t rw_last_write;
1359faa1795aSjb 	uint16_t rw_mode;
1360f96bd5c8SAlan Wright 	uint32_t rw_count;		/* bytes in this request */
1361faa1795aSjb 	uint16_t rw_mincnt;
1362f96bd5c8SAlan Wright 	uint32_t rw_total;		/* total bytes (write-raw) */
1363faa1795aSjb 	uint16_t rw_dsoff;		/* SMB data offset */
1364faa1795aSjb 	uint8_t rw_andx;		/* SMB secondary andx command */
1365faa1795aSjb } smb_rw_param_t;
1366da6c28aaSamw 
1367eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_pathname {
1368eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_path;
1369eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_pname;
1370eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_fname;
1371eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_sname;
1372eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_stype;
1373eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States } smb_pathname_t;
1374eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 
1375b89a8333Snatalie li - Sun Microsystems - Irvine United States /*
1376b89a8333Snatalie li - Sun Microsystems - Irvine United States  * fs_query_info
1377b89a8333Snatalie li - Sun Microsystems - Irvine United States  */
1378b89a8333Snatalie li - Sun Microsystems - Irvine United States typedef struct smb_fqi {
1379eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_pathname_t	fq_path;
1380eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	uint16_t	fq_sattr;
1381eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_node_t	*fq_dnode;
1382eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_node_t	*fq_fnode;
1383eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_attr_t	fq_fattr;
1384eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char		fq_last_comp[MAXNAMELEN];
1385b89a8333Snatalie li - Sun Microsystems - Irvine United States } smb_fqi_t;
1386da6c28aaSamw 
1387148c5f43SAlan Wright typedef struct dirop {
1388148c5f43SAlan Wright 	smb_fqi_t	fqi;
1389148c5f43SAlan Wright 	smb_fqi_t	dst_fqi;
1390148c5f43SAlan Wright 	uint16_t	info_level;
1391148c5f43SAlan Wright 	uint16_t	flags;
1392148c5f43SAlan Wright } smb_arg_dirop_t;
1393148c5f43SAlan Wright 
1394*a90cf9f2SGordon Ross typedef struct smb_queryinfo {
1395*a90cf9f2SGordon Ross 	smb_node_t	*qi_node;	/* NULL for pipes */
1396*a90cf9f2SGordon Ross 	uint8_t qi_InfoType;
1397*a90cf9f2SGordon Ross 	uint8_t qi_InfoClass;
1398*a90cf9f2SGordon Ross 	uint8_t	qi_delete_on_close;
1399*a90cf9f2SGordon Ross 	uint8_t qi_isdir;
1400*a90cf9f2SGordon Ross 	uint32_t qi_AddlInfo;
1401*a90cf9f2SGordon Ross 	uint32_t qi_Flags;
1402*a90cf9f2SGordon Ross 	mbuf_chain_t in_data;
1403*a90cf9f2SGordon Ross 	smb_attr_t	qi_attr;
1404*a90cf9f2SGordon Ross 	uint32_t	qi_namelen;
1405*a90cf9f2SGordon Ross 	char		qi_shortname[SMB_SHORTNAMELEN];
1406*a90cf9f2SGordon Ross 	char		qi_name[MAXPATHLEN];
1407*a90cf9f2SGordon Ross } smb_queryinfo_t;
1408*a90cf9f2SGordon Ross 
1409*a90cf9f2SGordon Ross typedef struct smb_setinfo {
1410*a90cf9f2SGordon Ross 	smb_node_t *si_node;
1411*a90cf9f2SGordon Ross 	mbuf_chain_t si_data;
1412*a90cf9f2SGordon Ross 	smb_attr_t si_attr;
1413*a90cf9f2SGordon Ross } smb_setinfo_t;
1414*a90cf9f2SGordon Ross 
1415*a90cf9f2SGordon Ross /*
1416*a90cf9f2SGordon Ross  * smb_fssize_t
1417*a90cf9f2SGordon Ross  * volume_units and volume avail are the total allocated and
1418*a90cf9f2SGordon Ross  * available units on the volume.
1419*a90cf9f2SGordon Ross  * caller_units and caller_avail are the allocated and available
1420*a90cf9f2SGordon Ross  * units on the volume for the user associated with the calling
1421*a90cf9f2SGordon Ross  * thread.
1422*a90cf9f2SGordon Ross  */
1423*a90cf9f2SGordon Ross typedef struct smb_fssize {
1424*a90cf9f2SGordon Ross 	uint64_t	fs_volume_units;
1425*a90cf9f2SGordon Ross 	uint64_t	fs_volume_avail;
1426*a90cf9f2SGordon Ross 	uint64_t	fs_caller_units;
1427*a90cf9f2SGordon Ross 	uint64_t	fs_caller_avail;
1428*a90cf9f2SGordon Ross 	uint32_t	fs_sectors_per_unit;
1429*a90cf9f2SGordon Ross 	uint32_t	fs_bytes_per_sector;
1430*a90cf9f2SGordon Ross } smb_fssize_t;
1431*a90cf9f2SGordon Ross 
1432*a90cf9f2SGordon Ross /*
1433*a90cf9f2SGordon Ross  * SMB FsCtl operations (SMB2 Ioctl, and some SMB1 trans calls)
1434*a90cf9f2SGordon Ross  */
1435*a90cf9f2SGordon Ross typedef struct {
1436*a90cf9f2SGordon Ross 	uint32_t CtlCode;
1437*a90cf9f2SGordon Ross 	uint32_t InputCount;
1438*a90cf9f2SGordon Ross 	uint32_t OutputCount;
1439*a90cf9f2SGordon Ross 	uint32_t MaxOutputResp;
1440*a90cf9f2SGordon Ross 	mbuf_chain_t *in_mbc;
1441*a90cf9f2SGordon Ross 	mbuf_chain_t *out_mbc;
1442*a90cf9f2SGordon Ross } smb_fsctl_t;
1443*a90cf9f2SGordon Ross 
1444*a90cf9f2SGordon Ross typedef struct {
1445*a90cf9f2SGordon Ross 	uint64_t	persistent;
1446*a90cf9f2SGordon Ross 	uint64_t	temporal;
1447*a90cf9f2SGordon Ross } smb2fid_t;
1448*a90cf9f2SGordon Ross 
14497b59d02dSjb typedef struct {
14507b59d02dSjb 	uint32_t status;
14517b59d02dSjb 	uint16_t errcls;
14527b59d02dSjb 	uint16_t errcode;
14537b59d02dSjb } smb_error_t;
1454da6c28aaSamw 
14552c2961f8Sjose borrego typedef struct open_param {
14562c2961f8Sjose borrego 	smb_fqi_t	fqi;
14572c2961f8Sjose borrego 	uint16_t	omode;
14582c2961f8Sjose borrego 	uint16_t	ofun;
14592c2961f8Sjose borrego 	uint32_t	nt_flags;
14602c2961f8Sjose borrego 	uint32_t	timeo;
14612c2961f8Sjose borrego 	uint32_t	dattr;
14622c2961f8Sjose borrego 	timestruc_t	crtime;
14632c2961f8Sjose borrego 	timestruc_t	mtime;
1464*a90cf9f2SGordon Ross 	timestruc_t	timewarp;
1465*a90cf9f2SGordon Ross 	/*
1466*a90cf9f2SGordon Ross 	 * Careful: dsize is the desired (allocation) size before the
1467*a90cf9f2SGordon Ross 	 * common open function, and the actual size afterwards.
1468*a90cf9f2SGordon Ross 	 */
1469*a90cf9f2SGordon Ross 	uint64_t	dsize;	/* alloc size, actual size */
14702c2961f8Sjose borrego 	uint32_t	desired_access;
14712c2961f8Sjose borrego 	uint32_t	share_access;
14722c2961f8Sjose borrego 	uint32_t	create_options;
14732c2961f8Sjose borrego 	uint32_t	create_disposition;
1474*a90cf9f2SGordon Ross 	boolean_t	create_timewarp;
14752c2961f8Sjose borrego 	boolean_t	created_readonly;
14762c2961f8Sjose borrego 	uint32_t	ftype;
14772c2961f8Sjose borrego 	uint32_t	devstate;
14782c2961f8Sjose borrego 	uint32_t	action_taken;
14792c2961f8Sjose borrego 	uint64_t	fileid;
14802c2961f8Sjose borrego 	uint32_t	rootdirfid;
1481bbf6f00cSJordan Brown 	smb_ofile_t	*dir;
148268b2bbf2SGordon Ross 	smb_opipe_t	*pipe;	/* for smb_opipe_open */
148368b2bbf2SGordon Ross 	struct smb_sd	*sd;	/* for NTTransactCreate */
1484cb174861Sjoyce mcintosh 	uint8_t		op_oplock_level;	/* requested/granted level */
1485cb174861Sjoyce mcintosh 	boolean_t	op_oplock_levelII;	/* TRUE if levelII supported */
1486148c5f43SAlan Wright } smb_arg_open_t;
14872c2961f8Sjose borrego 
1488*a90cf9f2SGordon Ross struct smb_async_req;
1489*a90cf9f2SGordon Ross 
1490da6c28aaSamw /*
1491da6c28aaSamw  * SMB Request State Machine
1492da6c28aaSamw  * -------------------------
1493da6c28aaSamw  *
1494da6c28aaSamw  *                  T4               +------+		T0
1495da6c28aaSamw  *      +--------------------------->| FREE |---------------------------+
1496da6c28aaSamw  *      |                            +------+                           |
1497da6c28aaSamw  * +-----------+                                                        |
1498da6c28aaSamw  * | COMPLETED |                                                        |
1499da6c28aaSamw  * +-----------+
1500da6c28aaSamw  *      ^                                                               |
1501da6c28aaSamw  *      | T15                      +----------+                         v
1502da6c28aaSamw  * +------------+        T6        |          |                 +--------------+
1503da6c28aaSamw  * | CLEANED_UP |<-----------------| CANCELED |                 | INITIALIZING |
1504da6c28aaSamw  * +------------+                  |          |                 +--------------+
1505da6c28aaSamw  *      |    ^                     +----------+                         |
1506da6c28aaSamw  *      |    |                        ^  ^ ^ ^                          |
1507da6c28aaSamw  *      |    |          +-------------+  | | |                          |
1508da6c28aaSamw  *      |    |    T3    |                | | |               T13        | T1
1509da6c28aaSamw  *      |    +-------------------------+ | | +----------------------+   |
1510da6c28aaSamw  *      +----------------------------+ | | |                        |   |
1511da6c28aaSamw  *         T16          |            | | | +-----------+            |   |
1512da6c28aaSamw  *                      |           \/ | | T5          |            |   v
1513da6c28aaSamw  * +-----------------+  |   T12     +--------+         |     T2    +-----------+
1514da6c28aaSamw  * | EVENT_OCCURRED  |------------->| ACTIVE |<--------------------| SUBMITTED |
1515da6c28aaSamw  * +-----------------+  |           +--------+         |           +-----------+
1516da6c28aaSamw  *        ^             |              | ^ |           |
1517da6c28aaSamw  *        |             |           T8 | | |  T7       |
1518da6c28aaSamw  *        | T10      T9 |   +----------+ | +-------+   |  T11
1519da6c28aaSamw  *        |             |   |            +-------+ |   |
1520da6c28aaSamw  *        |             |   |               T14  | |   |
1521da6c28aaSamw  *        |             |   v                    | v   |
1522da6c28aaSamw  *      +----------------------+                +--------------+
1523da6c28aaSamw  *	|     WAITING_EVENT    |                | WAITING_LOCK |
1524da6c28aaSamw  *      +----------------------+                +--------------+
1525da6c28aaSamw  *
1526da6c28aaSamw  *
1527da6c28aaSamw  *
1528da6c28aaSamw  *
1529da6c28aaSamw  *
1530da6c28aaSamw  * Transition T0
1531da6c28aaSamw  *
1532da6c28aaSamw  * This transition occurs when the request is allocated and is still under the
1533da6c28aaSamw  * control of the session thread.
1534da6c28aaSamw  *
1535da6c28aaSamw  * Transition T1
1536da6c28aaSamw  *
1537da6c28aaSamw  * This transition occurs when the session thread dispatches a task to treat the
1538da6c28aaSamw  * request.
1539da6c28aaSamw  *
1540da6c28aaSamw  * Transition T2
1541da6c28aaSamw  *
1542da6c28aaSamw  *
1543da6c28aaSamw  *
1544da6c28aaSamw  * Transition T3
1545da6c28aaSamw  *
1546da6c28aaSamw  * A request completes and smbsr_cleanup is called to release resources
1547da6c28aaSamw  * associated with the request (but not the smb_request_t itself).  This
1548da6c28aaSamw  * includes references on smb_ofile_t, smb_node_t, and other structures.
1549da6c28aaSamw  * CLEANED_UP state exists to detect if we attempt to cleanup a request
1550da6c28aaSamw  * multiple times and to allow us to detect that we are accessing a
1551da6c28aaSamw  * request that has already been cleaned up.
1552da6c28aaSamw  *
1553da6c28aaSamw  * Transition T4
1554da6c28aaSamw  *
1555da6c28aaSamw  *
1556da6c28aaSamw  *
1557da6c28aaSamw  * Transition T5
1558da6c28aaSamw  *
1559da6c28aaSamw  *
1560da6c28aaSamw  *
1561da6c28aaSamw  * Transition T6
1562da6c28aaSamw  *
1563da6c28aaSamw  *
1564da6c28aaSamw  *
1565da6c28aaSamw  * Transition T7
1566da6c28aaSamw  *
1567da6c28aaSamw  *
1568da6c28aaSamw  *
1569da6c28aaSamw  * Transition T8
1570da6c28aaSamw  *
1571da6c28aaSamw  *
1572da6c28aaSamw  *
1573da6c28aaSamw  * Transition T9
1574da6c28aaSamw  *
1575da6c28aaSamw  *
1576da6c28aaSamw  *
1577da6c28aaSamw  * Transition T10
1578da6c28aaSamw  *
1579da6c28aaSamw  *
1580da6c28aaSamw  *
1581da6c28aaSamw  * Transition T11
1582da6c28aaSamw  *
1583da6c28aaSamw  *
1584da6c28aaSamw  *
1585da6c28aaSamw  * Transition T12
1586da6c28aaSamw  *
1587da6c28aaSamw  *
1588da6c28aaSamw  *
1589da6c28aaSamw  * Transition T13
1590da6c28aaSamw  *
1591da6c28aaSamw  *
1592da6c28aaSamw  *
1593da6c28aaSamw  * Transition T14
1594da6c28aaSamw  *
1595da6c28aaSamw  *
1596da6c28aaSamw  *
1597da6c28aaSamw  * Transition T15
1598da6c28aaSamw  *
1599da6c28aaSamw  * Request processing is completed (control returns from smb_dispatch)
1600da6c28aaSamw  *
1601da6c28aaSamw  * Transition T16
1602da6c28aaSamw  *
1603da6c28aaSamw  * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx"
1604da6c28aaSamw  * sections remain to be processed.
1605da6c28aaSamw  *
1606da6c28aaSamw  */
1607da6c28aaSamw 
1608da6c28aaSamw #define	SMB_REQ_MAGIC 		0x534D4252	/* 'SMBR' */
16092c2961f8Sjose borrego #define	SMB_REQ_VALID(p)	ASSERT((p)->sr_magic == SMB_REQ_MAGIC)
1610da6c28aaSamw 
1611da6c28aaSamw typedef enum smb_req_state {
1612da6c28aaSamw 	SMB_REQ_STATE_FREE = 0,
1613da6c28aaSamw 	SMB_REQ_STATE_INITIALIZING,
1614da6c28aaSamw 	SMB_REQ_STATE_SUBMITTED,
1615da6c28aaSamw 	SMB_REQ_STATE_ACTIVE,
1616da6c28aaSamw 	SMB_REQ_STATE_WAITING_EVENT,
1617da6c28aaSamw 	SMB_REQ_STATE_EVENT_OCCURRED,
1618da6c28aaSamw 	SMB_REQ_STATE_WAITING_LOCK,
1619da6c28aaSamw 	SMB_REQ_STATE_COMPLETED,
1620da6c28aaSamw 	SMB_REQ_STATE_CANCELED,
16216537f381Sas 	SMB_REQ_STATE_CLEANED_UP,
16226537f381Sas 	SMB_REQ_STATE_SENTINEL
1623da6c28aaSamw } smb_req_state_t;
1624da6c28aaSamw 
1625faa1795aSjb typedef struct smb_request {
1626*a90cf9f2SGordon Ross 	list_node_t		sr_session_lnd;
1627da6c28aaSamw 	uint32_t		sr_magic;
1628da6c28aaSamw 	kmutex_t		sr_mutex;
1629da6c28aaSamw 	smb_req_state_t		sr_state;
1630faa1795aSjb 	struct smb_server	*sr_server;
16316537f381Sas 	pid_t			*sr_pid;
1632c8ec8eeaSjose borrego 	int32_t			sr_gmtoff;
1633faa1795aSjb 	smb_session_t		*session;
1634faa1795aSjb 	smb_kmod_cfg_t		*sr_cfg;
1635*a90cf9f2SGordon Ross 
1636da6c28aaSamw 	smb_notify_change_req_t	sr_ncr;
1637da6c28aaSamw 
1638da6c28aaSamw 	/* Info from session service header */
1639da6c28aaSamw 	uint32_t		sr_req_length; /* Excluding NBT header */
1640da6c28aaSamw 
1641da6c28aaSamw 	/* Request buffer excluding NBT header */
1642da6c28aaSamw 	void			*sr_request_buf;
1643da6c28aaSamw 
1644da6c28aaSamw 	smb_lock_t		*sr_awaiting;
1645da6c28aaSamw 	struct mbuf_chain	command;
1646da6c28aaSamw 	struct mbuf_chain	reply;
1647da6c28aaSamw 	struct mbuf_chain	raw_data;
1648bbf6f00cSJordan Brown 	list_t			sr_storage;
1649da6c28aaSamw 	struct smb_xa		*r_xa;
1650da6c28aaSamw 	int			andx_prev_wct;
1651da6c28aaSamw 	int 			cur_reply_offset;
1652da6c28aaSamw 	int			orig_request_hdr;
1653da6c28aaSamw 	unsigned int		reply_seqnum;	/* reply sequence number */
1654da6c28aaSamw 	unsigned char		first_smb_com;	/* command code */
1655da6c28aaSamw 	unsigned char		smb_com;	/* command code */
16567b59d02dSjb 
16577b59d02dSjb 	uint8_t			smb_rcls;	/* error code class */
16587b59d02dSjb 	uint8_t			smb_reh;	/* rsvd (AH DOS INT-24 ERR) */
1659da6c28aaSamw 	uint16_t		smb_err;	/* error code */
16607b59d02dSjb 	smb_error_t		smb_error;
16617b59d02dSjb 
1662da6c28aaSamw 	uint8_t			smb_flg;	/* flags */
1663da6c28aaSamw 	uint16_t		smb_flg2;	/* flags */
1664da6c28aaSamw 	unsigned char		smb_sig[8];	/* signiture */
1665da6c28aaSamw 	uint16_t		smb_tid;	/* tree id #  */
1666*a90cf9f2SGordon Ross 	uint32_t		smb_pid;	/* caller's process id # */
1667da6c28aaSamw 	uint16_t		smb_uid;	/* user id # */
1668da6c28aaSamw 	uint16_t		smb_mid;	/* mutiplex id #  */
1669da6c28aaSamw 	unsigned char		smb_wct;	/* count of parameter words */
1670da6c28aaSamw 	uint16_t		smb_bcc;	/* data byte count */
1671da6c28aaSamw 
1672*a90cf9f2SGordon Ross 	/*
1673*a90cf9f2SGordon Ross 	 * Beginning offsets (in the mbuf chain) for the
1674*a90cf9f2SGordon Ross 	 * command and reply headers, and the next reply.
1675*a90cf9f2SGordon Ross 	 */
1676*a90cf9f2SGordon Ross 	uint32_t		smb2_cmd_hdr;
1677*a90cf9f2SGordon Ross 	uint32_t		smb2_reply_hdr;
1678*a90cf9f2SGordon Ross 	uint32_t		smb2_next_reply;
1679*a90cf9f2SGordon Ross 
1680*a90cf9f2SGordon Ross 	/*
1681*a90cf9f2SGordon Ross 	 * SMB2 header fields.  [MS-SMB2 2.2.1.2]
1682*a90cf9f2SGordon Ross 	 * XXX: Later do a union w smb1 members
1683*a90cf9f2SGordon Ross 	 */
1684*a90cf9f2SGordon Ross 	uint16_t		smb2_credit_charge;
1685*a90cf9f2SGordon Ross 	uint16_t		smb2_chan_seq;	/* cmd only */
1686*a90cf9f2SGordon Ross 	uint32_t		smb2_status;
1687*a90cf9f2SGordon Ross 	uint16_t		smb2_cmd_code;
1688*a90cf9f2SGordon Ross 	uint16_t		smb2_credit_request;
1689*a90cf9f2SGordon Ross 	uint16_t		smb2_credit_response;
1690*a90cf9f2SGordon Ross 	uint32_t		smb2_hdr_flags;
1691*a90cf9f2SGordon Ross 	uint32_t		smb2_next_command;
1692*a90cf9f2SGordon Ross 	uint64_t		smb2_messageid;
1693*a90cf9f2SGordon Ross 	/* uint32_t		smb2_pid; use smb_pid */
1694*a90cf9f2SGordon Ross 	/* uint32_t		smb2_tid; use smb_tid */
1695*a90cf9f2SGordon Ross 	/* uint64_t		smb2_ssnid; use smb_uid */
1696*a90cf9f2SGordon Ross 	unsigned char		smb2_sig[16];	/* signiture */
1697*a90cf9f2SGordon Ross 
1698*a90cf9f2SGordon Ross 	uint64_t		smb2_async_id;
1699*a90cf9f2SGordon Ross 	struct smb2_async_req	*sr_async_req;
1700*a90cf9f2SGordon Ross 
1701da6c28aaSamw 	/* Parameters */
1702da6c28aaSamw 	struct mbuf_chain	smb_vwv;	/* variable width value */
1703da6c28aaSamw 
1704da6c28aaSamw 	/* Data */
1705da6c28aaSamw 	struct mbuf_chain	smb_data;
1706da6c28aaSamw 
1707da6c28aaSamw 	uint16_t		smb_fid;	/* not in hdr, but common */
1708da6c28aaSamw 
1709da6c28aaSamw 	unsigned char		andx_com;
1710da6c28aaSamw 	uint16_t		andx_off;
1711da6c28aaSamw 
1712da6c28aaSamw 	struct smb_tree		*tid_tree;
1713da6c28aaSamw 	struct smb_ofile	*fid_ofile;
1714da6c28aaSamw 	smb_user_t		*uid_user;
1715da6c28aaSamw 
171668b2bbf2SGordon Ross 	cred_t			*user_cr;
171768b2bbf2SGordon Ross 	kthread_t		*sr_worker;
171868b2bbf2SGordon Ross 	hrtime_t		sr_time_submitted;
171968b2bbf2SGordon Ross 	hrtime_t		sr_time_active;
172068b2bbf2SGordon Ross 	hrtime_t		sr_time_start;
172168b2bbf2SGordon Ross 	int32_t			sr_txb;
172268b2bbf2SGordon Ross 	uint32_t		sr_seqnum;
172368b2bbf2SGordon Ross 
1724da6c28aaSamw 	union {
1725148c5f43SAlan Wright 		smb_arg_negotiate_t	*negprot;
1726148c5f43SAlan Wright 		smb_arg_sessionsetup_t	*ssetup;
1727148c5f43SAlan Wright 		smb_arg_tcon_t		tcon;
1728148c5f43SAlan Wright 		smb_arg_dirop_t		dirop;
1729148c5f43SAlan Wright 		smb_arg_open_t		open;
1730148c5f43SAlan Wright 		smb_rw_param_t		*rw;
1731*a90cf9f2SGordon Ross 		smb_oplock_grant_t	olbrk;	/* for async oplock break */
17325fd03bc0SGordon Ross 		int32_t			timestamp;
1733da6c28aaSamw 	} arg;
1734faa1795aSjb } smb_request_t;
1735da6c28aaSamw 
1736148c5f43SAlan Wright #define	sr_ssetup	arg.ssetup
1737148c5f43SAlan Wright #define	sr_negprot	arg.negprot
1738148c5f43SAlan Wright #define	sr_tcon		arg.tcon
1739148c5f43SAlan Wright #define	sr_dirop	arg.dirop
1740148c5f43SAlan Wright #define	sr_open		arg.open
1741148c5f43SAlan Wright #define	sr_rw		arg.rw
1742148c5f43SAlan Wright #define	sr_timestamp	arg.timestamp
1743148c5f43SAlan Wright 
1744bbf6f00cSJordan Brown #define	SMB_READ_PROTOCOL(hdr) \
1745bbf6f00cSJordan Brown 	LE_IN32(((smb_hdr_t *)(hdr))->protocol)
1746da6c28aaSamw 
1747da6c28aaSamw #define	SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \
1748da6c28aaSamw 	(SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC)
1749da6c28aaSamw 
1750bbf6f00cSJordan Brown #define	SMB_READ_COMMAND(hdr) \
1751bbf6f00cSJordan Brown 	(((smb_hdr_t *)(hdr))->command)
1752da6c28aaSamw 
1753148c5f43SAlan Wright #define	SMB_IS_NT_CANCEL(rd_sr) \
1754148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NT_CANCEL)
1755148c5f43SAlan Wright 
1756148c5f43SAlan Wright #define	SMB_IS_SESSION_SETUP_ANDX(rd_sr) \
1757148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == \
1758148c5f43SAlan Wright 	    SMB_COM_SESSION_SETUP_ANDX)
1759148c5f43SAlan Wright 
1760148c5f43SAlan Wright #define	SMB_IS_NT_NEGOTIATE(rd_sr) \
1761148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NEGOTIATE)
1762148c5f43SAlan Wright 
1763148c5f43SAlan Wright #define	SMB_IS_TREE_CONNECT_ANDX(rd_sr) \
1764148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_TREE_CONNECT_ANDX)
1765da6c28aaSamw 
1766da6c28aaSamw #define	SMB_XA_FLAG_OPEN	0x0001
1767da6c28aaSamw #define	SMB_XA_FLAG_CLOSE	0x0002
1768da6c28aaSamw #define	SMB_XA_FLAG_COMPLETE	0x0004
1769da6c28aaSamw #define	SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN))
1770da6c28aaSamw 
1771da6c28aaSamw #define	SMB_XA_MAGIC		0x534D4258	/* 'SMBX' */
1772da6c28aaSamw 
1773da6c28aaSamw typedef struct smb_xa {
1774*a90cf9f2SGordon Ross 	list_node_t		xa_lnd;
1775da6c28aaSamw 	uint32_t		xa_magic;
1776da6c28aaSamw 	kmutex_t		xa_mutex;
1777da6c28aaSamw 
1778da6c28aaSamw 	uint32_t		xa_refcnt;
1779da6c28aaSamw 	uint32_t		xa_flags;
1780da6c28aaSamw 
1781da6c28aaSamw 	struct smb_session	*xa_session;
1782da6c28aaSamw 
1783da6c28aaSamw 	unsigned char		smb_com;	/* which TRANS type */
1784da6c28aaSamw 	unsigned char		smb_flg;	/* flags */
1785da6c28aaSamw 	uint16_t		smb_flg2;	/* flags */
1786da6c28aaSamw 	uint16_t		smb_tid;	/* tree id number */
1787*a90cf9f2SGordon Ross 	uint32_t		smb_pid;	/* caller's process id */
1788da6c28aaSamw 	uint16_t		smb_uid;	/* user id number */
1789da6c28aaSamw 	uint32_t		smb_func;	/* NT_TRANS function */
1790da6c28aaSamw 
1791da6c28aaSamw 	uint16_t		xa_smb_mid;	/* mutiplex id number */
1792da6c28aaSamw 	uint16_t		xa_smb_fid;	/* TRANS2 secondary */
1793da6c28aaSamw 
1794da6c28aaSamw 	unsigned int		reply_seqnum;	/* reply sequence number */
1795da6c28aaSamw 
1796da6c28aaSamw 	uint32_t	smb_tpscnt;	/* total parameter bytes being sent */
1797da6c28aaSamw 	uint32_t	smb_tdscnt;	/* total data bytes being sent */
1798da6c28aaSamw 	uint32_t	smb_mprcnt;	/* max parameter bytes to return */
1799da6c28aaSamw 	uint32_t	smb_mdrcnt;	/* max data bytes to return */
1800da6c28aaSamw 	uint32_t	smb_msrcnt;	/* max setup words to return */
1801da6c28aaSamw 	uint32_t	smb_flags;	/* additional information: */
1802da6c28aaSamw 				/*  bit 0 - if set, disconnect TID in smb_tid */
1803da6c28aaSamw 				/*  bit 1 - if set, transaction is one way */
1804da6c28aaSamw 				/*  (no final response) */
1805da6c28aaSamw 	int32_t	smb_timeout;	/* number of milliseconds to await completion */
1806da6c28aaSamw 	uint32_t	smb_suwcnt;	/* set up word count */
1807da6c28aaSamw 
1808bbf6f00cSJordan Brown 	char			*xa_pipe_name;
1809da6c28aaSamw 
18107f3ef643SGordon Ross 	/*
18117f3ef643SGordon Ross 	 * These are the param and data count received so far,
18127f3ef643SGordon Ross 	 * used to decide if the whole trans is here yet.
18137f3ef643SGordon Ross 	 */
1814da6c28aaSamw 	int			req_disp_param;
1815da6c28aaSamw 	int			req_disp_data;
1816da6c28aaSamw 
1817da6c28aaSamw 	struct mbuf_chain	req_setup_mb;
1818da6c28aaSamw 	struct mbuf_chain	req_param_mb;
1819da6c28aaSamw 	struct mbuf_chain	req_data_mb;
1820da6c28aaSamw 
1821da6c28aaSamw 	struct mbuf_chain	rep_setup_mb;
1822da6c28aaSamw 	struct mbuf_chain	rep_param_mb;
1823da6c28aaSamw 	struct mbuf_chain	rep_data_mb;
1824da6c28aaSamw } smb_xa_t;
1825da6c28aaSamw 
1826da6c28aaSamw 
1827da6c28aaSamw #define	SDDF_NO_FLAGS			0
1828da6c28aaSamw #define	SDDF_SUPPRESS_TID		0x0001
1829da6c28aaSamw #define	SDDF_SUPPRESS_UID		0x0002
1830da6c28aaSamw 
18317b59d02dSjb /*
18327b59d02dSjb  * SMB dispatch return codes.
18337b59d02dSjb  */
18347b59d02dSjb typedef enum {
1835faa1795aSjb 	SDRC_SUCCESS = 0,
1836faa1795aSjb 	SDRC_ERROR,
18377b59d02dSjb 	SDRC_DROP_VC,
18387b59d02dSjb 	SDRC_NO_REPLY,
183959229f98Sjose borrego 	SDRC_SR_KEPT,
1840faa1795aSjb 	SDRC_NOT_IMPLEMENTED
18417b59d02dSjb } smb_sdrc_t;
1842da6c28aaSamw 
1843da6c28aaSamw #define	VAR_BCC		((short)-1)
1844da6c28aaSamw 
1845faa1795aSjb #define	SMB_SERVER_MAGIC	0x53534552	/* 'SSER' */
18469fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_SERVER_VALID(s)	\
18479fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((s) != NULL) && ((s)->sv_magic == SMB_SERVER_MAGIC))
1848da6c28aaSamw 
18494163af6aSjose borrego #define	SMB_LISTENER_MAGIC	0x4C53544E	/* 'LSTN' */
18504163af6aSjose borrego #define	SMB_LISTENER_VALID(ld)	\
18514163af6aSjose borrego     ASSERT(((ld) != NULL) && ((ld)->ld_magic == SMB_LISTENER_MAGIC))
18524163af6aSjose borrego 
1853faa1795aSjb typedef struct {
18544163af6aSjose borrego 	uint32_t		ld_magic;
18554163af6aSjose borrego 	struct smb_server	*ld_sv;
18564163af6aSjose borrego 	smb_thread_t		ld_thread;
18570f1702c5SYu Xiangning 	ksocket_t		ld_so;
18584163af6aSjose borrego 	in_port_t		ld_port;
18594163af6aSjose borrego 	int			ld_family;
1860faa1795aSjb 	struct sockaddr_in	ld_sin;
18617f667e74Sjose borrego 	struct sockaddr_in6	ld_sin6;
18624163af6aSjose borrego 	smb_llist_t		ld_session_list;
1863faa1795aSjb } smb_listener_daemon_t;
1864faa1795aSjb 
1865cb174861Sjoyce mcintosh #define	SMB_SSETUP_CMD			"authentication"
1866cb174861Sjoyce mcintosh #define	SMB_TCON_CMD			"share mapping"
1867cb174861Sjoyce mcintosh #define	SMB_OPIPE_CMD			"pipe open"
1868cb174861Sjoyce mcintosh #define	SMB_THRESHOLD_REPORT_THROTTLE	50
1869cb174861Sjoyce mcintosh typedef struct smb_cmd_threshold {
1870cb174861Sjoyce mcintosh 	char			*ct_cmd;
1871cb174861Sjoyce mcintosh 	kmutex_t		ct_mutex;
1872cb174861Sjoyce mcintosh 	volatile uint32_t	ct_active_cnt;
1873cb174861Sjoyce mcintosh 	volatile uint32_t	ct_blocked_cnt;
1874cb174861Sjoyce mcintosh 	uint32_t		ct_threshold;
1875856399cfSGordon Ross 	uint32_t		ct_timeout; /* milliseconds */
1876856399cfSGordon Ross 	kcondvar_t		ct_cond;
1877cb174861Sjoyce mcintosh } smb_cmd_threshold_t;
1878cb174861Sjoyce mcintosh 
1879cb174861Sjoyce mcintosh typedef struct {
1880cb174861Sjoyce mcintosh 	kstat_named_t		ls_files;
1881cb174861Sjoyce mcintosh 	kstat_named_t		ls_trees;
1882cb174861Sjoyce mcintosh 	kstat_named_t		ls_users;
1883cb174861Sjoyce mcintosh } smb_server_legacy_kstat_t;
1884cb174861Sjoyce mcintosh 
1885faa1795aSjb typedef enum smb_server_state {
1886faa1795aSjb 	SMB_SERVER_STATE_CREATED = 0,
1887faa1795aSjb 	SMB_SERVER_STATE_CONFIGURED,
1888faa1795aSjb 	SMB_SERVER_STATE_RUNNING,
18899fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	SMB_SERVER_STATE_STOPPING,
18906537f381Sas 	SMB_SERVER_STATE_DELETING,
18916537f381Sas 	SMB_SERVER_STATE_SENTINEL
1892faa1795aSjb } smb_server_state_t;
1893faa1795aSjb 
1894cb174861Sjoyce mcintosh typedef struct {
189523a9c295SGordon Ross 	/* protected by sv_mutex */
1896cb174861Sjoyce mcintosh 	kcondvar_t		sp_cv;
1897cb174861Sjoyce mcintosh 	uint32_t 		sp_cnt;
1898cb174861Sjoyce mcintosh 	smb_llist_t		sp_list;
1899cb174861Sjoyce mcintosh 	smb_llist_t		sp_fidlist;
1900cb174861Sjoyce mcintosh } smb_spool_t;
1901cb174861Sjoyce mcintosh 
1902148c5f43SAlan Wright #define	SMB_SERVER_STATE_VALID(S)               \
1903148c5f43SAlan Wright     ASSERT(((S) == SMB_SERVER_STATE_CREATED) || \
1904148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_CONFIGURED) || \
1905148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_RUNNING) ||    \
1906148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_STOPPING) ||   \
1907148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_DELETING))
19089fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
1909faa1795aSjb typedef struct smb_server {
1910*a90cf9f2SGordon Ross 	list_node_t		sv_lnd;
1911faa1795aSjb 	uint32_t		sv_magic;
1912faa1795aSjb 	kcondvar_t		sv_cv;
1913faa1795aSjb 	kmutex_t		sv_mutex;
1914faa1795aSjb 	smb_server_state_t	sv_state;
1915faa1795aSjb 	uint32_t		sv_refcnt;
19166537f381Sas 	pid_t			sv_pid;
1917faa1795aSjb 	zoneid_t		sv_zid;
1918faa1795aSjb 	smb_listener_daemon_t	sv_nbt_daemon;
1919faa1795aSjb 	smb_listener_daemon_t	sv_tcp_daemon;
1920faa1795aSjb 	krwlock_t		sv_cfg_lock;
1921faa1795aSjb 	smb_kmod_cfg_t		sv_cfg;
1922faa1795aSjb 	smb_session_t		*sv_session;
1923da6c28aaSamw 
19248622ec45SGordon Ross 	struct smb_export	sv_export;
1925b819cea2SGordon Ross 	struct __door_handle	*sv_lmshrd;
1926da6c28aaSamw 
19278622ec45SGordon Ross 	/* Internal door for up-calls to smbd */
1928b819cea2SGordon Ross 	struct __door_handle	*sv_kdoor_hd;
19298622ec45SGordon Ross 	int			sv_kdoor_id; /* init -1 */
19308622ec45SGordon Ross 	uint64_t		sv_kdoor_ncall;
19318622ec45SGordon Ross 	kmutex_t		sv_kdoor_mutex;
19328622ec45SGordon Ross 	kcondvar_t		sv_kdoor_cv;
19338622ec45SGordon Ross 
1934c8ec8eeaSjose borrego 	int32_t			si_gmtoff;
1935da6c28aaSamw 
1936da6c28aaSamw 	smb_thread_t		si_thread_timers;
1937da6c28aaSamw 
19384163af6aSjose borrego 	taskq_t			*sv_worker_pool;
19394163af6aSjose borrego 	taskq_t			*sv_receiver_pool;
1940da6c28aaSamw 
1941da6c28aaSamw 	smb_node_t		*si_root_smb_node;
19429fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_llist_t		sv_opipe_list;
19439fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_llist_t		sv_event_list;
1944148c5f43SAlan Wright 
1945148c5f43SAlan Wright 	/* Statistics */
1946148c5f43SAlan Wright 	hrtime_t		sv_start_time;
1947148c5f43SAlan Wright 	kstat_t			*sv_ksp;
1948148c5f43SAlan Wright 	volatile uint32_t	sv_nbt_sess;
1949148c5f43SAlan Wright 	volatile uint32_t	sv_tcp_sess;
1950148c5f43SAlan Wright 	volatile uint32_t	sv_users;
1951148c5f43SAlan Wright 	volatile uint32_t	sv_trees;
1952148c5f43SAlan Wright 	volatile uint32_t	sv_files;
1953148c5f43SAlan Wright 	volatile uint32_t	sv_pipes;
1954148c5f43SAlan Wright 	volatile uint64_t	sv_txb;
1955148c5f43SAlan Wright 	volatile uint64_t	sv_rxb;
1956148c5f43SAlan Wright 	volatile uint64_t	sv_nreq;
1957148c5f43SAlan Wright 	smb_srqueue_t		sv_srqueue;
1958cb174861Sjoyce mcintosh 	smb_spool_t		sp_info;
1959cb174861Sjoyce mcintosh 	smb_cmd_threshold_t	sv_ssetup_ct;
1960cb174861Sjoyce mcintosh 	smb_cmd_threshold_t	sv_tcon_ct;
1961cb174861Sjoyce mcintosh 	smb_cmd_threshold_t	sv_opipe_ct;
1962cb174861Sjoyce mcintosh 	kstat_t			*sv_legacy_ksp;
1963cb174861Sjoyce mcintosh 	kmutex_t		sv_legacy_ksmtx;
1964*a90cf9f2SGordon Ross 	smb_disp_stats_t	*sv_disp_stats1;
1965*a90cf9f2SGordon Ross 	smb_disp_stats_t	*sv_disp_stats2;
1966faa1795aSjb } smb_server_t;
1967da6c28aaSamw 
19689fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_EVENT_MAGIC		0x45564E54	/* EVNT */
1969cb174861Sjoyce mcintosh #define	SMB_EVENT_TIMEOUT	45		/* seconds */
19709fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_EVENT_VALID(e)	\
19719fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((e) != NULL) && ((e)->se_magic == SMB_EVENT_MAGIC))
19729fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_event {
19739fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_node_t		se_lnd;
1974*a90cf9f2SGordon Ross 	uint32_t		se_magic;
19759fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmutex_t		se_mutex;
19769fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kcondvar_t		se_cv;
1977cb174861Sjoyce mcintosh 	smb_server_t		*se_server;
19789fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		se_txid;
19799fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	boolean_t		se_notified;
19809fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	int			se_waittime;
1981cb174861Sjoyce mcintosh 	int			se_timeout;
19829fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	int			se_errno;
19839fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States } smb_event_t;
19849fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
1985cb174861Sjoyce mcintosh typedef struct smb_kspooldoc {
1986cb174861Sjoyce mcintosh 	list_node_t	sd_lnd;
1987*a90cf9f2SGordon Ross 	uint32_t	sd_magic;
1988cb174861Sjoyce mcintosh 	smb_inaddr_t	sd_ipaddr;
1989cb174861Sjoyce mcintosh 	uint32_t	sd_spool_num;
1990cb174861Sjoyce mcintosh 	uint16_t	sd_fid;
1991cb174861Sjoyce mcintosh 	char		sd_username[MAXNAMELEN];
1992cb174861Sjoyce mcintosh 	char		sd_path[MAXPATHLEN];
1993cb174861Sjoyce mcintosh } smb_kspooldoc_t;
1994cb174861Sjoyce mcintosh 
1995cb174861Sjoyce mcintosh typedef struct smb_spoolfid {
1996cb174861Sjoyce mcintosh 	list_node_t	sf_lnd;
1997*a90cf9f2SGordon Ross 	uint32_t	sf_magic;
1998cb174861Sjoyce mcintosh 	uint16_t	sf_fid;
1999cb174861Sjoyce mcintosh } smb_spoolfid_t;
2000cb174861Sjoyce mcintosh 
2001da6c28aaSamw #define	SMB_INFO_NETBIOS_SESSION_SVC_RUNNING	0x0001
2002da6c28aaSamw #define	SMB_INFO_NETBIOS_SESSION_SVC_FAILED	0x0002
2003da6c28aaSamw #define	SMB_INFO_USER_LEVEL_SECURITY		0x40000000
2004da6c28aaSamw #define	SMB_INFO_ENCRYPT_PASSWORDS		0x80000000
2005da6c28aaSamw 
20061fcced4cSJordan Brown #define	SMB_IS_STREAM(node) ((node)->n_unode)
2007da6c28aaSamw 
2008da6c28aaSamw typedef struct smb_tsd {
2009da6c28aaSamw 	void (*proc)();
2010da6c28aaSamw 	void *arg;
2011da6c28aaSamw 	char name[100];
2012da6c28aaSamw } smb_tsd_t;
2013da6c28aaSamw 
20142c2961f8Sjose borrego typedef struct smb_disp_entry {
2015148c5f43SAlan Wright 	char		sdt_name[KSTAT_STRLEN];
2016148c5f43SAlan Wright 	smb_sdrc_t	(*sdt_pre_op)(smb_request_t *);
2017148c5f43SAlan Wright 	smb_sdrc_t	(*sdt_function)(smb_request_t *);
2018148c5f43SAlan Wright 	void		(*sdt_post_op)(smb_request_t *);
2019148c5f43SAlan Wright 	uint8_t		sdt_com;
2020148c5f43SAlan Wright 	char		sdt_dialect;
2021148c5f43SAlan Wright 	uint8_t		sdt_flags;
20222c2961f8Sjose borrego } smb_disp_entry_t;
2023da6c28aaSamw 
2024148c5f43SAlan Wright typedef struct smb_xlate {
2025148c5f43SAlan Wright 	int	code;
2026148c5f43SAlan Wright 	char	*str;
2027148c5f43SAlan Wright } smb_xlate_t;
2028148c5f43SAlan Wright 
2029148c5f43SAlan Wright /*
2030148c5f43SAlan Wright  * This structure is a helper for building RAP NetShareEnum response
2031148c5f43SAlan Wright  *
2032148c5f43SAlan Wright  * es_posix_uid UID of the user requesting the shares list which
2033148c5f43SAlan Wright  *              is used to detect if the user has any autohome
2034148c5f43SAlan Wright  * es_bufsize   size of the response buffer
2035148c5f43SAlan Wright  * es_buf       pointer to the response buffer
2036148c5f43SAlan Wright  * es_ntotal    total number of shares exported by server which
2037148c5f43SAlan Wright  *              their OEM names is less then 13 chars
2038148c5f43SAlan Wright  * es_nsent     number of shares that can fit in the specified buffer
2039148c5f43SAlan Wright  * es_datasize  actual data size (share's data) which was encoded
2040148c5f43SAlan Wright  *              in the response buffer
2041148c5f43SAlan Wright  */
2042148c5f43SAlan Wright typedef struct smb_enumshare_info {
2043148c5f43SAlan Wright 	uid_t		es_posix_uid;
2044148c5f43SAlan Wright 	uint16_t	es_bufsize;
2045148c5f43SAlan Wright 	char		*es_buf;
2046148c5f43SAlan Wright 	uint16_t	es_ntotal;
2047148c5f43SAlan Wright 	uint16_t	es_nsent;
2048148c5f43SAlan Wright 	uint16_t	es_datasize;
2049148c5f43SAlan Wright } smb_enumshare_info_t;
2050148c5f43SAlan Wright 
2051da6c28aaSamw #ifdef	__cplusplus
2052da6c28aaSamw }
2053da6c28aaSamw #endif
2054da6c28aaSamw 
2055faa1795aSjb #endif /* _SMBSRV_SMB_KTYPES_H */
2056