xref: /illumos-gate/usr/src/uts/common/smbsrv/smb_ktypes.h (revision b819cea2f73f98c5662230cc9affc8cc84f77fcf)
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.
235fd03bc0SGordon Ross  * Copyright 2013 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>
53da6c28aaSamw #include <smbsrv/smbinfo.h>
54da6c28aaSamw #include <smbsrv/mbuf.h>
556537f381Sas #include <smbsrv/smb_sid.h>
563db3f65cSamw #include <smbsrv/smb_xdr.h>
5721b7895dSjb #include <smbsrv/netbios.h>
58da6c28aaSamw #include <smbsrv/smb_vops.h>
59148c5f43SAlan Wright #include <smbsrv/smb_kstat.h>
60da6c28aaSamw 
61*b819cea2SGordon Ross struct __door_handle;	/* <sys/door.h> */
62*b819cea2SGordon Ross struct edirent;		/* <sys/extdirent.h> */
63*b819cea2SGordon Ross 
642c2961f8Sjose borrego struct smb_disp_entry;
65faa1795aSjb struct smb_request;
66faa1795aSjb struct smb_server;
679fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States struct smb_event;
688622ec45SGordon Ross struct smb_export;
69da6c28aaSamw 
70148c5f43SAlan Wright /*
71148c5f43SAlan Wright  * Accumulated time and queue length statistics.
72148c5f43SAlan Wright  *
73148c5f43SAlan Wright  * Accumulated time statistics are kept as a running sum of "active" time.
74148c5f43SAlan Wright  * Queue length statistics are kept as a running sum of the product of queue
75148c5f43SAlan Wright  * length and elapsed time at that length -- i.e., a Riemann sum for queue
76148c5f43SAlan Wright  * length integrated against time.  (You can also think of the active time as a
77148c5f43SAlan Wright  * Riemann sum, for the boolean function (queue_length > 0) integrated against
78148c5f43SAlan Wright  * time, or you can think of it as the Lebesgue measure of the set on which
79148c5f43SAlan Wright  * queue_length > 0.)
80148c5f43SAlan Wright  *
81148c5f43SAlan Wright  *		^
82148c5f43SAlan Wright  *		|			_________
83148c5f43SAlan Wright  *		8			| i4	|
84148c5f43SAlan Wright  *		|			|	|
85148c5f43SAlan Wright  *	Queue	6			|	|
86148c5f43SAlan Wright  *	Length	|	_________	|	|
87148c5f43SAlan Wright  *		4	| i2	|_______|	|
88148c5f43SAlan Wright  *		|	|	    i3		|
89148c5f43SAlan Wright  *		2_______|			|
90148c5f43SAlan Wright  *		|    i1				|
91148c5f43SAlan Wright  *		|_______________________________|
92148c5f43SAlan Wright  *		Time->	t1	t2	t3	t4
93148c5f43SAlan Wright  *
94148c5f43SAlan Wright  * At each change of state (entry or exit from the queue), we add the elapsed
95148c5f43SAlan Wright  * time (since the previous state change) to the active time if the queue length
96148c5f43SAlan Wright  * was non-zero during that interval; and we add the product of the elapsed time
97148c5f43SAlan Wright  * times the queue length to the running length*time sum.
98148c5f43SAlan Wright  *
99148c5f43SAlan Wright  * This method is generalizable to measuring residency in any defined system:
100148c5f43SAlan Wright  * instead of queue lengths, think of "outstanding RPC calls to server X".
101148c5f43SAlan Wright  *
102148c5f43SAlan Wright  * A large number of I/O subsystems have at least two basic "lists" of
103148c5f43SAlan Wright  * transactions they manage: one for transactions that have been accepted for
104148c5f43SAlan Wright  * processing but for which processing has yet to begin, and one for
105148c5f43SAlan Wright  * transactions which are actively being processed (but not done). For this
106148c5f43SAlan Wright  * reason, two cumulative time statistics are defined here: wait (pre-service)
107148c5f43SAlan Wright  * time, and run (service) time.
108148c5f43SAlan Wright  *
109148c5f43SAlan Wright  * All times are 64-bit nanoseconds (hrtime_t), as returned by gethrtime().
110148c5f43SAlan Wright  *
111148c5f43SAlan Wright  * The units of cumulative busy time are accumulated nanoseconds. The units of
112148c5f43SAlan Wright  * cumulative length*time products are elapsed time times queue length.
113148c5f43SAlan Wright  *
114148c5f43SAlan Wright  * Updates to the fields below are performed implicitly by calls to
115148c5f43SAlan Wright  * these functions:
116148c5f43SAlan Wright  *
117148c5f43SAlan Wright  *	smb_srqueue_init()
118148c5f43SAlan Wright  *	smb_srqueue_destroy()
119148c5f43SAlan Wright  *	smb_srqueue_waitq_enter()
120148c5f43SAlan Wright  *	smb_srqueue_runq_exit()
121148c5f43SAlan Wright  *	smb_srqueue_waitq_to_runq()
122148c5f43SAlan Wright  *	smb_srqueue_update()
123148c5f43SAlan Wright  *
124148c5f43SAlan Wright  * These fields should never be updated by any other means.
125148c5f43SAlan Wright  */
126148c5f43SAlan Wright typedef struct smb_srqueue {
127148c5f43SAlan Wright 	kmutex_t	srq_mutex;
128148c5f43SAlan Wright 	hrtime_t	srq_wlastupdate;
129148c5f43SAlan Wright 	hrtime_t	srq_wtime;
130148c5f43SAlan Wright 	hrtime_t	srq_wlentime;
131148c5f43SAlan Wright 	hrtime_t	srq_rlastupdate;
132148c5f43SAlan Wright 	hrtime_t	srq_rtime;
133148c5f43SAlan Wright 	hrtime_t	srq_rlentime;
134148c5f43SAlan Wright 	uint32_t	srq_wcnt;
135148c5f43SAlan Wright 	uint32_t	srq_rcnt;
136148c5f43SAlan Wright } smb_srqueue_t;
137148c5f43SAlan Wright 
138148c5f43SAlan Wright /*
139148c5f43SAlan Wright  * The fields with the prefix 'ly_a' contain the statistics collected since the
140148c5f43SAlan Wright  * server was last started ('a' for 'aggregated'). The fields with the prefix
141148c5f43SAlan Wright  * 'ly_d' contain the statistics collected since the last snapshot ('d' for
142148c5f43SAlan Wright  * 'delta').
143148c5f43SAlan Wright  */
144148c5f43SAlan Wright typedef struct smb_latency {
145148c5f43SAlan Wright 	kmutex_t	ly_mutex;
146148c5f43SAlan Wright 	uint64_t	ly_a_nreq;
147148c5f43SAlan Wright 	hrtime_t	ly_a_sum;
148148c5f43SAlan Wright 	hrtime_t	ly_a_mean;
149148c5f43SAlan Wright 	hrtime_t	ly_a_stddev;
150148c5f43SAlan Wright 	uint64_t	ly_d_nreq;
151148c5f43SAlan Wright 	hrtime_t	ly_d_sum;
152148c5f43SAlan Wright 	hrtime_t	ly_d_mean;
153148c5f43SAlan Wright 	hrtime_t	ly_d_stddev;
154148c5f43SAlan Wright } smb_latency_t;
155148c5f43SAlan Wright 
1568622ec45SGordon Ross typedef struct smb_disp_stats {
1578622ec45SGordon Ross 	volatile uint64_t sdt_txb;
1588622ec45SGordon Ross 	volatile uint64_t sdt_rxb;
1598622ec45SGordon Ross 	smb_latency_t	sdt_lat;
1608622ec45SGordon Ross } smb_disp_stats_t;
1618622ec45SGordon Ross 
162da6c28aaSamw int smb_noop(void *, size_t, int);
163da6c28aaSamw 
164da6c28aaSamw #define	SMB_AUDIT_STACK_DEPTH	16
165da6c28aaSamw #define	SMB_AUDIT_BUF_MAX_REC	16
166da6c28aaSamw #define	SMB_AUDIT_NODE		0x00000001
167da6c28aaSamw 
168c8ec8eeaSjose borrego /*
169c8ec8eeaSjose borrego  * Maximum number of records returned in SMBsearch, SMBfind
170c8ec8eeaSjose borrego  * and SMBfindunique response. Value set to 10 for compatibility
171c8ec8eeaSjose borrego  * with Windows.
172c8ec8eeaSjose borrego  */
173c8ec8eeaSjose borrego #define	SMB_MAX_SEARCH		10
174c8ec8eeaSjose borrego 
1757f667e74Sjose borrego #define	SMB_SEARCH_ATTRIBUTES    \
1767f667e74Sjose borrego 	(FILE_ATTRIBUTE_HIDDEN | \
1777f667e74Sjose borrego 	FILE_ATTRIBUTE_SYSTEM |  \
1787f667e74Sjose borrego 	FILE_ATTRIBUTE_DIRECTORY)
1797f667e74Sjose borrego 
1802c1b14e5Sjose borrego #define	SMB_SEARCH_HIDDEN(sattr) ((sattr) & FILE_ATTRIBUTE_HIDDEN)
1812c1b14e5Sjose borrego #define	SMB_SEARCH_SYSTEM(sattr) ((sattr) & FILE_ATTRIBUTE_SYSTEM)
1822c1b14e5Sjose borrego #define	SMB_SEARCH_DIRECTORY(sattr) ((sattr) & FILE_ATTRIBUTE_DIRECTORY)
1837f667e74Sjose borrego #define	SMB_SEARCH_ALL(sattr) ((sattr) & SMB_SEARCH_ATTRIBUTES)
1842c1b14e5Sjose borrego 
185da6c28aaSamw typedef struct {
186da6c28aaSamw 	uint32_t		anr_refcnt;
187da6c28aaSamw 	int			anr_depth;
188da6c28aaSamw 	pc_t			anr_stack[SMB_AUDIT_STACK_DEPTH];
189da6c28aaSamw } smb_audit_record_node_t;
190da6c28aaSamw 
191da6c28aaSamw typedef struct {
192da6c28aaSamw 	int			anb_index;
193da6c28aaSamw 	int			anb_max_index;
194da6c28aaSamw 	smb_audit_record_node_t	anb_records[SMB_AUDIT_BUF_MAX_REC];
195da6c28aaSamw } smb_audit_buf_node_t;
196da6c28aaSamw 
197da6c28aaSamw /*
198da6c28aaSamw  * Thread State Machine
199da6c28aaSamw  * --------------------
200da6c28aaSamw  *
201da6c28aaSamw  *			    T5			   T0
202da6c28aaSamw  * smb_thread_destroy()	<-------+		+------- smb_thread_init()
203da6c28aaSamw  *                              |		|
204da6c28aaSamw  *				|		v
205da6c28aaSamw  *			+-----------------------------+
206da6c28aaSamw  *			|   SMB_THREAD_STATE_EXITED   |<---+
207da6c28aaSamw  *			+-----------------------------+	   |
208da6c28aaSamw  *				      | T1		   |
209da6c28aaSamw  *				      v			   |
210da6c28aaSamw  *			+-----------------------------+	   |
211da6c28aaSamw  *			|  SMB_THREAD_STATE_STARTING  |	   |
212da6c28aaSamw  *			+-----------------------------+	   |
213da6c28aaSamw  *				     | T2		   | T4
214da6c28aaSamw  *				     v			   |
215da6c28aaSamw  *			+-----------------------------+	   |
216da6c28aaSamw  *			|  SMB_THREAD_STATE_RUNNING   |	   |
217da6c28aaSamw  *			+-----------------------------+	   |
218da6c28aaSamw  *				     | T3		   |
219da6c28aaSamw  *				     v			   |
220da6c28aaSamw  *			+-----------------------------+	   |
221da6c28aaSamw  *			|  SMB_THREAD_STATE_EXITING   |----+
222da6c28aaSamw  *			+-----------------------------+
223da6c28aaSamw  *
224da6c28aaSamw  * Transition T0
225da6c28aaSamw  *
226da6c28aaSamw  *    This transition is executed in smb_thread_init().
227da6c28aaSamw  *
228da6c28aaSamw  * Transition T1
229da6c28aaSamw  *
230da6c28aaSamw  *    This transition is executed in smb_thread_start().
231da6c28aaSamw  *
232da6c28aaSamw  * Transition T2
233da6c28aaSamw  *
234da6c28aaSamw  *    This transition is executed by the thread itself when it starts running.
235da6c28aaSamw  *
236da6c28aaSamw  * Transition T3
237da6c28aaSamw  *
238da6c28aaSamw  *    This transition is executed by the thread itself in
239da6c28aaSamw  *    smb_thread_entry_point() just before calling thread_exit().
240da6c28aaSamw  *
241da6c28aaSamw  *
242da6c28aaSamw  * Transition T4
243da6c28aaSamw  *
244da6c28aaSamw  *    This transition is executed in smb_thread_stop().
245da6c28aaSamw  *
246da6c28aaSamw  * Transition T5
247da6c28aaSamw  *
248da6c28aaSamw  *    This transition is executed in smb_thread_destroy().
249da6c28aaSamw  */
250da6c28aaSamw typedef enum smb_thread_state {
251da6c28aaSamw 	SMB_THREAD_STATE_STARTING = 0,
252da6c28aaSamw 	SMB_THREAD_STATE_RUNNING,
253da6c28aaSamw 	SMB_THREAD_STATE_EXITING,
254*b819cea2SGordon Ross 	SMB_THREAD_STATE_EXITED,
255*b819cea2SGordon Ross 	SMB_THREAD_STATE_FAILED
256da6c28aaSamw } smb_thread_state_t;
257da6c28aaSamw 
258da6c28aaSamw struct _smb_thread;
259da6c28aaSamw 
260da6c28aaSamw typedef void (*smb_thread_ep_t)(struct _smb_thread *, void *ep_arg);
261da6c28aaSamw 
262da6c28aaSamw #define	SMB_THREAD_MAGIC	0x534D4254	/* SMBT */
263da6c28aaSamw 
264da6c28aaSamw typedef struct _smb_thread {
265da6c28aaSamw 	uint32_t		sth_magic;
266da6c28aaSamw 	char			sth_name[16];
267da6c28aaSamw 	smb_thread_state_t	sth_state;
268da6c28aaSamw 	kthread_t		*sth_th;
269da6c28aaSamw 	kt_did_t		sth_did;
270da6c28aaSamw 	smb_thread_ep_t		sth_ep;
271da6c28aaSamw 	void			*sth_ep_arg;
27208344b29SGordon Ross 	pri_t			sth_pri;
273da6c28aaSamw 	boolean_t		sth_kill;
274da6c28aaSamw 	kmutex_t		sth_mtx;
275da6c28aaSamw 	kcondvar_t		sth_cv;
276da6c28aaSamw } smb_thread_t;
277da6c28aaSamw 
278da6c28aaSamw /*
279da6c28aaSamw  * Pool of IDs
280da6c28aaSamw  * -----------
281da6c28aaSamw  *
282da6c28aaSamw  *    A pool of IDs is a pool of 16 bit numbers. It is implemented as a bitmap.
283da6c28aaSamw  *    A bit set to '1' indicates that that particular value has been allocated.
284da6c28aaSamw  *    The allocation process is done shifting a bit through the whole bitmap.
285da6c28aaSamw  *    The current position of that index bit is kept in the smb_idpool_t
286da6c28aaSamw  *    structure and represented by a byte index (0 to buffer size minus 1) and
287da6c28aaSamw  *    a bit index (0 to 7).
288da6c28aaSamw  *
289da6c28aaSamw  *    The pools start with a size of 8 bytes or 64 IDs. Each time the pool runs
290da6c28aaSamw  *    out of IDs its current size is doubled until it reaches its maximum size
291da6c28aaSamw  *    (8192 bytes or 65536 IDs). The IDs 0 and 65535 are never given out which
292da6c28aaSamw  *    means that a pool can have a maximum number of 65534 IDs available.
293da6c28aaSamw  */
294da6c28aaSamw #define	SMB_IDPOOL_MAGIC	0x4944504C	/* IDPL */
295da6c28aaSamw #define	SMB_IDPOOL_MIN_SIZE	64	/* Number of IDs to begin with */
296da6c28aaSamw #define	SMB_IDPOOL_MAX_SIZE	64 * 1024
297da6c28aaSamw 
298da6c28aaSamw typedef struct smb_idpool {
299da6c28aaSamw 	uint32_t	id_magic;
300da6c28aaSamw 	kmutex_t	id_mutex;
301da6c28aaSamw 	uint8_t		*id_pool;
302da6c28aaSamw 	uint32_t	id_size;
303da6c28aaSamw 	uint8_t		id_bit;
304da6c28aaSamw 	uint8_t		id_bit_idx;
305da6c28aaSamw 	uint32_t	id_idx;
306da6c28aaSamw 	uint32_t	id_idx_msk;
307da6c28aaSamw 	uint32_t	id_free_counter;
308da6c28aaSamw 	uint32_t	id_max_free_counter;
309da6c28aaSamw } smb_idpool_t;
310da6c28aaSamw 
311da6c28aaSamw /*
3122c2961f8Sjose borrego  * Maximum size of a Transport Data Unit when CAP_LARGE_READX and
3132c2961f8Sjose borrego  * CAP_LARGE_WRITEX are not set.  CAP_LARGE_READX/CAP_LARGE_WRITEX
3142c2961f8Sjose borrego  * allow the payload to exceed the negotiated buffer size.
31521b7895dSjb  *     4 --> NBT/TCP Transport Header.
31621b7895dSjb  *    32 --> SMB Header
31721b7895dSjb  *     1 --> Word Count byte
31821b7895dSjb  *   510 --> Maximum Number of bytes of the Word Table (2 * 255)
31921b7895dSjb  *     2 --> Byte count of the data
32021b7895dSjb  * 65535 --> Maximum size of the data
32121b7895dSjb  * -----
32221b7895dSjb  * 66084
323da6c28aaSamw  */
3242c2961f8Sjose borrego #define	SMB_REQ_MAX_SIZE	66560		/* 65KB */
32521b7895dSjb #define	SMB_XPRT_MAX_SIZE	(SMB_REQ_MAX_SIZE + NETBIOS_HDR_SZ)
326da6c28aaSamw 
32721b7895dSjb #define	SMB_TXREQ_MAGIC		0X54524251	/* 'TREQ' */
3285cdbe942Sjb typedef struct {
32921b7895dSjb 	uint32_t	tr_magic;
33021b7895dSjb 	list_node_t	tr_lnd;
33121b7895dSjb 	int		tr_len;
33221b7895dSjb 	uint8_t		tr_buf[SMB_XPRT_MAX_SIZE];
33321b7895dSjb } smb_txreq_t;
3345cdbe942Sjb 
3355cdbe942Sjb #define	SMB_TXLST_MAGIC		0X544C5354	/* 'TLST' */
3365cdbe942Sjb typedef struct {
3375cdbe942Sjb 	uint32_t	tl_magic;
3385cdbe942Sjb 	kmutex_t	tl_mutex;
3395cdbe942Sjb 	boolean_t	tl_active;
3405cdbe942Sjb 	list_t		tl_list;
3415cdbe942Sjb } smb_txlst_t;
3425cdbe942Sjb 
343da6c28aaSamw /*
344faa1795aSjb  * Maximum buffer size for NT is 37KB.  If all clients are Windows 2000, this
345faa1795aSjb  * can be changed to 64KB.  37KB must be used with a mix of NT/Windows 2000
346faa1795aSjb  * clients because NT loses directory entries when values greater than 37KB are
347faa1795aSjb  * used.
348faa1795aSjb  *
349faa1795aSjb  * Note: NBT_MAXBUF will be subtracted from the specified max buffer size to
350faa1795aSjb  * account for the NBT header.
351da6c28aaSamw  */
352faa1795aSjb #define	NBT_MAXBUF		8
353faa1795aSjb #define	SMB_NT_MAXBUF		(37 * 1024)
354da6c28aaSamw 
355da6c28aaSamw #define	OUTBUFSIZE		(65 * 1024)
356da6c28aaSamw #define	SMBHEADERSIZE		32
357da6c28aaSamw #define	SMBND_HASH_MASK		(0xFF)
358da6c28aaSamw #define	MAX_IOVEC		512
359da6c28aaSamw #define	MAX_READREF		(8 * 1024)
360da6c28aaSamw 
361da6c28aaSamw #define	SMB_WORKER_MIN		4
362da6c28aaSamw #define	SMB_WORKER_DEFAULT	64
363da6c28aaSamw #define	SMB_WORKER_MAX		1024
364da6c28aaSamw 
365da6c28aaSamw /*
3669fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * Destructor object used in the locked-list delete queue.
367da6c28aaSamw  */
3689fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_DTOR_MAGIC		0x44544F52	/* DTOR */
3699fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_DTOR_VALID(d)	\
3709fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((d) != NULL) && ((d)->dt_magic == SMB_DTOR_MAGIC))
371da6c28aaSamw 
3729fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef void (*smb_dtorproc_t)(void *);
373da6c28aaSamw 
3749fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_dtor {
3759fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t	dt_magic;
3769fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_node_t	dt_lnd;
3779fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	void		*dt_object;
3789fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_dtorproc_t	dt_proc;
3799fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States } smb_dtor_t;
380da6c28aaSamw 
381da6c28aaSamw typedef struct smb_llist {
382da6c28aaSamw 	krwlock_t	ll_lock;
383da6c28aaSamw 	list_t		ll_list;
384da6c28aaSamw 	uint32_t	ll_count;
385da6c28aaSamw 	uint64_t	ll_wrop;
3869fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmutex_t	ll_mutex;
3879fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_t		ll_deleteq;
3889fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t	ll_deleteq_count;
389cb174861Sjoyce mcintosh 	boolean_t	ll_flushing;
390da6c28aaSamw } smb_llist_t;
391da6c28aaSamw 
392da6c28aaSamw typedef struct smb_slist {
393da6c28aaSamw 	kmutex_t	sl_mutex;
394da6c28aaSamw 	kcondvar_t	sl_cv;
395da6c28aaSamw 	list_t		sl_list;
396da6c28aaSamw 	uint32_t	sl_count;
397da6c28aaSamw 	boolean_t	sl_waiting;
398da6c28aaSamw } smb_slist_t;
399da6c28aaSamw 
400148c5f43SAlan Wright /*
401148c5f43SAlan Wright  * smb_avl_t State Machine
402148c5f43SAlan Wright  * --------------------
403148c5f43SAlan Wright  *
404148c5f43SAlan Wright  *                      +-----------------------------+
405148c5f43SAlan Wright  *                      |     SMB_AVL_STATE_START     |
406148c5f43SAlan Wright  *                      +-----------------------------+
407148c5f43SAlan Wright  *                                    | T0
408148c5f43SAlan Wright  *                                    v
409148c5f43SAlan Wright  *                      +-----------------------------+
410148c5f43SAlan Wright  *                      |     SMB_AVL_STATE_READY     |
411148c5f43SAlan Wright  *                      +-----------------------------+
412148c5f43SAlan Wright  *                                    | T1
413148c5f43SAlan Wright  *                                    v
414148c5f43SAlan Wright  *                      +-----------------------------+
415148c5f43SAlan Wright  *                      |  SMB_AVL_STATE_DESTROYING   |
416148c5f43SAlan Wright  *                      +-----------------------------+
417148c5f43SAlan Wright  *
418148c5f43SAlan Wright  * Transition T0
419148c5f43SAlan Wright  *
420148c5f43SAlan Wright  *    This transition is executed in smb_avl_create().
421148c5f43SAlan Wright  *
422148c5f43SAlan Wright  * Transition T1
423148c5f43SAlan Wright  *
424148c5f43SAlan Wright  *    This transition is executed in smb_avl_destroy().
425148c5f43SAlan Wright  *
426148c5f43SAlan Wright  */
427148c5f43SAlan Wright typedef enum {
428148c5f43SAlan Wright 	SMB_AVL_STATE_START = 0,
429148c5f43SAlan Wright 	SMB_AVL_STATE_READY,
430148c5f43SAlan Wright 	SMB_AVL_STATE_DESTROYING
431148c5f43SAlan Wright } smb_avl_state_t;
432148c5f43SAlan Wright 
433148c5f43SAlan Wright typedef struct smb_avl_nops {
434148c5f43SAlan Wright 	int		(*avln_cmp) (const void *, const void *);
435148c5f43SAlan Wright 	void		(*avln_hold)(const void *);
436148c5f43SAlan Wright 	boolean_t	(*avln_rele)(const void *);
437148c5f43SAlan Wright 	void		(*avln_destroy)(void *);
438148c5f43SAlan Wright } smb_avl_nops_t;
439148c5f43SAlan Wright 
440148c5f43SAlan Wright typedef struct smb_avl_cursor {
441148c5f43SAlan Wright 	void		*avlc_next;
442148c5f43SAlan Wright 	uint32_t	avlc_sequence;
443148c5f43SAlan Wright } smb_avl_cursor_t;
444148c5f43SAlan Wright 
445148c5f43SAlan Wright typedef struct smb_avl {
446148c5f43SAlan Wright 	krwlock_t	avl_lock;
447148c5f43SAlan Wright 	avl_tree_t	avl_tree;
448148c5f43SAlan Wright 	kmutex_t	avl_mutex;
449148c5f43SAlan Wright 	kcondvar_t	avl_cv;
450148c5f43SAlan Wright 	smb_avl_state_t	avl_state;
451148c5f43SAlan Wright 	uint32_t	avl_refcnt;
452148c5f43SAlan Wright 	uint32_t	avl_sequence;
4538622ec45SGordon Ross 	const smb_avl_nops_t	*avl_nops;
454148c5f43SAlan Wright } smb_avl_t;
455148c5f43SAlan Wright 
456da6c28aaSamw typedef struct {
457da6c28aaSamw 	kcondvar_t	rwx_cv;
458da6c28aaSamw 	kmutex_t	rwx_mutex;
459da6c28aaSamw 	krwlock_t	rwx_lock;
460da6c28aaSamw 	boolean_t	rwx_waiting;
461da6c28aaSamw } smb_rwx_t;
462da6c28aaSamw 
4638622ec45SGordon Ross typedef struct smb_export {
4648622ec45SGordon Ross 	kmutex_t	e_mutex;
4658622ec45SGordon Ross 	boolean_t	e_ready;
4668622ec45SGordon Ross 	smb_llist_t	e_vfs_list;
4678622ec45SGordon Ross 	smb_avl_t	e_share_avl;
4688622ec45SGordon Ross 	smb_slist_t	e_unexport_list;
4698622ec45SGordon Ross 	smb_thread_t	e_unexport_thread;
4708622ec45SGordon Ross } smb_export_t;
4718622ec45SGordon Ross 
472da6c28aaSamw /* NOTIFY CHANGE */
473ccc71be5SGordon Ross typedef struct smb_node_fcn {
474ccc71be5SGordon Ross 	kmutex_t	fcn_mutex;
475ccc71be5SGordon Ross 	uint32_t	fcn_count;
476ccc71be5SGordon Ross 	list_t		fcn_watchers;	/* smb_request_t, sr_ncr.nc_lnd */
477ccc71be5SGordon Ross } smb_node_fcn_t;
478da6c28aaSamw 
479da6c28aaSamw typedef struct smb_notify_change_req {
480ccc71be5SGordon Ross 	list_node_t		nc_lnd;	/* n_fcn.fcn_watchers */
481ccc71be5SGordon Ross 	kcondvar_t		nc_cv;	/* prot: sr_mutex */
482da6c28aaSamw 	uint32_t		nc_flags;
483ccc71be5SGordon Ross 	uint32_t		nc_action;
484ccc71be5SGordon Ross 	char			*nc_fname;
485da6c28aaSamw } smb_notify_change_req_t;
486da6c28aaSamw 
487da6c28aaSamw /*
488da6c28aaSamw  * SMB operates over a NetBIOS-over-TCP transport (NBT) or directly
489da6c28aaSamw  * over TCP, which is also known as direct hosted NetBIOS-less SMB
490da6c28aaSamw  * or SMB-over-TCP.
491da6c28aaSamw  *
492da6c28aaSamw  * NBT messages have a 4-byte header that defines the message type
493da6c28aaSamw  * (8-bits), a 7-bit flags field and a 17-bit length.
494da6c28aaSamw  *
495da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
496da6c28aaSamw  * |      TYPE     |     FLAGS   |E|            LENGTH             |
497da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
498da6c28aaSamw  *
499da6c28aaSamw  * 8-bit type      Defined in RFC 1002
500da6c28aaSamw  * 7-bit flags     Bits 0-6 reserved (must be 0)
501da6c28aaSamw  *                 Bit 7: Length extension bit (E)
502da6c28aaSamw  * 17-bit length   Includes bit 7 of the flags byte
503da6c28aaSamw  *
504da6c28aaSamw  *
505da6c28aaSamw  * SMB-over-TCP is defined to use a modified version of the NBT header
506da6c28aaSamw  * containing an 8-bit message type and 24-bit message length.
507da6c28aaSamw  *
508da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
509da6c28aaSamw  * |      TYPE     |                  LENGTH                       |
510da6c28aaSamw  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
511da6c28aaSamw  *
512da6c28aaSamw  * 8-bit type      Must be 0
513da6c28aaSamw  * 24-bit length
514da6c28aaSamw  *
515da6c28aaSamw  * The following structure is used to represent a generic, in-memory
516da6c28aaSamw  * SMB transport header; it is not intended to map directly to either
517da6c28aaSamw  * of the over-the-wire formats.
518da6c28aaSamw  */
519da6c28aaSamw typedef struct {
520da6c28aaSamw 	uint8_t		xh_type;
521da6c28aaSamw 	uint32_t	xh_length;
522da6c28aaSamw } smb_xprt_t;
523da6c28aaSamw 
524faa1795aSjb int MBC_LENGTH(struct mbuf_chain *);
5253ad684d6Sjb int MBC_MAXBYTES(struct mbuf_chain *);
526faa1795aSjb void MBC_SETUP(struct mbuf_chain *, uint32_t);
527faa1795aSjb void MBC_INIT(struct mbuf_chain *, uint32_t);
528faa1795aSjb void MBC_FLUSH(struct mbuf_chain *);
529faa1795aSjb void MBC_ATTACH_MBUF(struct mbuf_chain *, struct mbuf *);
530faa1795aSjb void MBC_APPEND_MBUF(struct mbuf_chain *, struct mbuf *);
531da6c28aaSamw void MBC_ATTACH_BUF(struct mbuf_chain *MBC, unsigned char *BUF, int LEN);
532da6c28aaSamw int MBC_SHADOW_CHAIN(struct mbuf_chain *SUBMBC, struct mbuf_chain *MBC,
533da6c28aaSamw     int OFF, int LEN);
534da6c28aaSamw 
535da6c28aaSamw #define	MBC_ROOM_FOR(b, n) (((b)->chain_offset + (n)) <= (b)->max_bytes)
536da6c28aaSamw 
537cb174861Sjoyce mcintosh #define	OPLOCK_MIN_TIMEOUT	(5 * 1000)
538cb174861Sjoyce mcintosh #define	OPLOCK_STD_TIMEOUT	(30 * 1000)
539cb174861Sjoyce mcintosh 
540fc724630SAlan Wright /*
541cb174861Sjoyce mcintosh  * Oplock break flags:
542cb174861Sjoyce mcintosh  * SMB_OPLOCK_BREAK_EXCLUSIVE - only break exclusive oplock
543cb174861Sjoyce mcintosh  * (type SMB_OPLOCK_EXCLUSIVE or SMB_OPLOCK_BATCH)
544cb174861Sjoyce mcintosh  * SMB_OPLOCK_BREAK_BATCH - only break exclusive BATCH oplock
545cb174861Sjoyce mcintosh  * SMB_OPLOCK_BREAK_NOWAIT - do not wait for oplock break ack
546cb174861Sjoyce mcintosh  */
547cb174861Sjoyce mcintosh #define	SMB_OPLOCK_NO_BREAK		0x00
548cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_TO_NONE	0x01
549cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_TO_LEVEL_II	0x02
550cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_EXCLUSIVE	0x04
551cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_BATCH		0x08
552cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_NOWAIT		0x10
553cb174861Sjoyce mcintosh 
554cb174861Sjoyce mcintosh /*
555cb174861Sjoyce mcintosh  * Oplocks levels are defined to match the levels in the SMB
556cb174861Sjoyce mcintosh  * protocol (nt_create_andx / nt_transact_create) and should
557cb174861Sjoyce mcintosh  * not be changed
558fc724630SAlan Wright  */
559cb174861Sjoyce mcintosh #define	SMB_OPLOCK_NONE		0
560cb174861Sjoyce mcintosh #define	SMB_OPLOCK_EXCLUSIVE	1
561cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BATCH	2
562cb174861Sjoyce mcintosh #define	SMB_OPLOCK_LEVEL_II	3
563cb174861Sjoyce mcintosh 
564da6c28aaSamw typedef struct smb_oplock {
565cb174861Sjoyce mcintosh 	kmutex_t		ol_mutex;
5662c2961f8Sjose borrego 	kcondvar_t		ol_cv;
5672c2961f8Sjose borrego 	kthread_t		*ol_xthread;
568cb174861Sjoyce mcintosh 	boolean_t		ol_fem;		/* fem monitor installed? */
569cb174861Sjoyce mcintosh 	uint8_t			ol_break;
570cb174861Sjoyce mcintosh 	uint32_t		ol_count;	/* number of grants */
571cb174861Sjoyce mcintosh 	list_t			ol_grants;	/* list of smb_oplock_grant_t */
572da6c28aaSamw } smb_oplock_t;
573da6c28aaSamw 
574cb174861Sjoyce mcintosh #define	SMB_OPLOCK_GRANT_MAGIC	0x4F4C4B47	/* OLKG */
575cb174861Sjoyce mcintosh #define	SMB_OPLOCK_GRANT_VALID(p) \
576cb174861Sjoyce mcintosh 	ASSERT((p)->og_magic == SMB_OPLOCK_GRANT_MAGIC)
5771fdeec65Sjoyce mcintosh #define	SMB_OFILE_OPLOCK_GRANTED(p) \
5781fdeec65Sjoyce mcintosh 	((p)->f_oplock_grant.og_magic == SMB_OPLOCK_GRANT_MAGIC)
579cb174861Sjoyce mcintosh typedef struct smb_oplock_grant {
580cb174861Sjoyce mcintosh 	uint32_t		og_magic;
581cb174861Sjoyce mcintosh 	list_node_t		og_lnd;
582cb174861Sjoyce mcintosh 	uint8_t			og_level;
583cb174861Sjoyce mcintosh 	uint16_t		og_fid;
584cb174861Sjoyce mcintosh 	uint16_t		og_tid;
585cb174861Sjoyce mcintosh 	uint16_t		og_uid;
586cb174861Sjoyce mcintosh 	struct smb_session	*og_session;
587cb174861Sjoyce mcintosh 	struct smb_ofile	*og_ofile;
588cb174861Sjoyce mcintosh } smb_oplock_grant_t;
589cb174861Sjoyce mcintosh 
590cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_MAGIC	0x4F4C4B42	/* OLKB */
591cb174861Sjoyce mcintosh #define	SMB_OPLOCK_BREAK_VALID(p) \
592cb174861Sjoyce mcintosh 	ASSERT((p)->ob_magic == SMB_OPLOCK_BREAK_MAGIC)
593cb174861Sjoyce mcintosh typedef struct smb_oplock_break {
594cb174861Sjoyce mcintosh 	uint32_t	ob_magic;
595cb174861Sjoyce mcintosh 	list_node_t	ob_lnd;
596cb174861Sjoyce mcintosh 	struct smb_node	*ob_node;
597cb174861Sjoyce mcintosh } smb_oplock_break_t;
598cb174861Sjoyce mcintosh 
599cb174861Sjoyce mcintosh 
600da6c28aaSamw #define	SMB_VFS_MAGIC	0x534D4256	/* 'SMBV' */
601da6c28aaSamw 
602da6c28aaSamw typedef struct smb_vfs {
603da6c28aaSamw 	uint32_t		sv_magic;
604da6c28aaSamw 	list_node_t		sv_lnd;
605da6c28aaSamw 	uint32_t		sv_refcnt;
606da6c28aaSamw 	vfs_t			*sv_vfsp;
607da6c28aaSamw 	vnode_t			*sv_rootvp;
608da6c28aaSamw } smb_vfs_t;
609da6c28aaSamw 
6102c2961f8Sjose borrego #define	SMB_NODE_MAGIC		0x4E4F4445	/* 'NODE' */
6112c2961f8Sjose borrego #define	SMB_NODE_VALID(p)	ASSERT((p)->n_magic == SMB_NODE_MAGIC)
612da6c28aaSamw 
613da6c28aaSamw typedef enum {
614da6c28aaSamw 	SMB_NODE_STATE_AVAILABLE = 0,
615da6c28aaSamw 	SMB_NODE_STATE_DESTROYING
616da6c28aaSamw } smb_node_state_t;
617da6c28aaSamw 
6189fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States /*
6199fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * waiting_event        # of clients requesting FCN
6209fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_timestamps         cached timestamps
6219fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_allocsz            cached file allocation size
6229fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_dnode              directory node
6239fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * n_unode              unnamed stream node
6249fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * delete_on_close_cred credentials for delayed delete
6259fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  */
626da6c28aaSamw typedef struct smb_node {
627da6c28aaSamw 	uint32_t		n_magic;
6282c2961f8Sjose borrego 	krwlock_t		n_lock;
6292c2961f8Sjose borrego 	kmutex_t		n_mutex;
630da6c28aaSamw 	list_node_t		n_lnd;
631da6c28aaSamw 	smb_node_state_t	n_state;
632da6c28aaSamw 	uint32_t		n_refcnt;
633da6c28aaSamw 	uint32_t		n_hashkey;
634da6c28aaSamw 	smb_llist_t		*n_hash_bucket;
6352c2961f8Sjose borrego 	uint32_t		n_open_count;
636cb174861Sjoyce mcintosh 	uint32_t		n_opening_count;
637da6c28aaSamw 	smb_llist_t		n_ofile_list;
638da6c28aaSamw 	smb_llist_t		n_lock_list;
6395fd03bc0SGordon Ross 	uint32_t		n_pending_dosattr;
6409fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	volatile int		flags;
6419fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	u_offset_t		n_allocsz;
642ccc71be5SGordon Ross 	smb_node_fcn_t		n_fcn;
643da6c28aaSamw 	smb_oplock_t		n_oplock;
6449fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_node		*n_dnode;
6459fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_node		*n_unode;
646da6c28aaSamw 	cred_t			*delete_on_close_cred;
6478b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		n_delete_on_close_flags;
648da6c28aaSamw 	char			od_name[MAXNAMELEN];
649da6c28aaSamw 	vnode_t			*vp;
650da6c28aaSamw 	smb_audit_buf_node_t	*n_audit_buf;
651da6c28aaSamw } smb_node_t;
652da6c28aaSamw 
6539fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_REPARSE		0x00001000
6549fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_DFSLINK		0x00002000
6559fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_VFSROOT		0x00004000
6569fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	NODE_FLAGS_SYSTEM		0x00008000
657da6c28aaSamw #define	NODE_FLAGS_WRITE_THROUGH	0x00100000
658cbfb650aScp #define	NODE_XATTR_DIR			0x01000000
659da6c28aaSamw #define	NODE_FLAGS_DELETE_ON_CLOSE	0x40000000
660da6c28aaSamw #define	NODE_FLAGS_EXECUTABLE		0x80000000
661da6c28aaSamw 
662c8ec8eeaSjose borrego #define	SMB_NODE_VFS(node)	((node)->vp->v_vfsp)
663c8ec8eeaSjose borrego #define	SMB_NODE_FSID(node)	((node)->vp->v_vfsp->vfs_fsid)
664c8ec8eeaSjose borrego 
665148c5f43SAlan Wright /* Maximum buffer size for encryption key */
666148c5f43SAlan Wright #define	SMB_ENCRYPT_KEY_MAXLEN		32
667148c5f43SAlan Wright 
668148c5f43SAlan Wright #define	SMB_SHARE_MAGIC		0x4B534852	/* KSHR */
669148c5f43SAlan Wright 
670148c5f43SAlan Wright typedef struct smb_kshare {
671148c5f43SAlan Wright 	uint32_t	shr_magic;
672148c5f43SAlan Wright 	char		*shr_name;
673148c5f43SAlan Wright 	char		*shr_path;
674148c5f43SAlan Wright 	char		*shr_cmnt;
675148c5f43SAlan Wright 	char		*shr_container;
676148c5f43SAlan Wright 	char		*shr_oemname;
677148c5f43SAlan Wright 	uint32_t	shr_flags;
678148c5f43SAlan Wright 	uint32_t	shr_type;
679148c5f43SAlan Wright 	uint32_t	shr_refcnt;
680148c5f43SAlan Wright 	uint32_t	shr_autocnt;
681148c5f43SAlan Wright 	uid_t		shr_uid;
682148c5f43SAlan Wright 	gid_t		shr_gid;
683148c5f43SAlan Wright 	char		*shr_access_none;
684148c5f43SAlan Wright 	char		*shr_access_ro;
685148c5f43SAlan Wright 	char		*shr_access_rw;
686148c5f43SAlan Wright 	avl_node_t	shr_link;
687148c5f43SAlan Wright 	kmutex_t	shr_mutex;
688148c5f43SAlan Wright } smb_kshare_t;
689148c5f43SAlan Wright 
690148c5f43SAlan Wright 
691148c5f43SAlan Wright typedef struct smb_arg_negotiate {
692148c5f43SAlan Wright 	char		*ni_name;
693148c5f43SAlan Wright 	int		ni_dialect;
694148c5f43SAlan Wright 	int		ni_index;
695148c5f43SAlan Wright 	uint32_t	ni_capabilities;
696148c5f43SAlan Wright 	uint16_t	ni_maxmpxcount;
697148c5f43SAlan Wright 	int16_t		ni_tzcorrection;
698148c5f43SAlan Wright 	uint8_t		ni_keylen;
699148c5f43SAlan Wright 	uint8_t		ni_key[SMB_ENCRYPT_KEY_MAXLEN];
700148c5f43SAlan Wright 	timestruc_t	ni_servertime;
701148c5f43SAlan Wright } smb_arg_negotiate_t;
702148c5f43SAlan Wright 
703148c5f43SAlan Wright typedef struct smb_arg_sessionsetup {
704148c5f43SAlan Wright 	char		*ssi_user;
705148c5f43SAlan Wright 	char		*ssi_domain;
706148c5f43SAlan Wright 	uint16_t	ssi_cipwlen;
707148c5f43SAlan Wright 	uint8_t		*ssi_cipwd;
708148c5f43SAlan Wright 	uint16_t	ssi_cspwlen;
709148c5f43SAlan Wright 	uint8_t		*ssi_cspwd;
710148c5f43SAlan Wright 	uint16_t	ssi_maxmpxcount;
711148c5f43SAlan Wright 	uint32_t	ssi_capabilities;
712148c5f43SAlan Wright 	boolean_t	ssi_guest;
713148c5f43SAlan Wright } smb_arg_sessionsetup_t;
714148c5f43SAlan Wright 
715148c5f43SAlan Wright typedef struct tcon {
716148c5f43SAlan Wright 	char		*path;
717148c5f43SAlan Wright 	char		*service;
718148c5f43SAlan Wright 	int		pwdlen;
719148c5f43SAlan Wright 	char		*password;
720148c5f43SAlan Wright 	uint16_t	flags;
721148c5f43SAlan Wright 	uint16_t	optional_support;
722148c5f43SAlan Wright 	smb_kshare_t	*si;
723148c5f43SAlan Wright } smb_arg_tcon_t;
724148c5f43SAlan Wright 
725da6c28aaSamw /*
726da6c28aaSamw  * Based on section 2.6.1.2 (Connection Management) of the June 13,
727da6c28aaSamw  * 1996 CIFS spec, a server may terminate the transport connection
728da6c28aaSamw  * due to inactivity. The client software is expected to be able to
729da6c28aaSamw  * automatically reconnect to the server if this happens. Like much
730da6c28aaSamw  * of the useful background information, this section appears to
731da6c28aaSamw  * have been dropped from later revisions of the document.
732da6c28aaSamw  *
733da6c28aaSamw  * Each session has an activity timestamp that's updated whenever a
734da6c28aaSamw  * request is dispatched. If the session is idle, i.e. receives no
735da6c28aaSamw  * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be
736da6c28aaSamw  * closed.
737da6c28aaSamw  *
738da6c28aaSamw  * Each session has an I/O semaphore to serialize communication with
739da6c28aaSamw  * the client. For example, after receiving a raw-read request, the
740da6c28aaSamw  * server is not allowed to send an oplock break to the client until
741da6c28aaSamw  * after it has sent the raw-read data.
742da6c28aaSamw  */
743da6c28aaSamw #define	SMB_SESSION_INACTIVITY_TIMEOUT		(15 * 60)
744da6c28aaSamw 
745e3f2c991SKeyur Desai #define	SMB_SESSION_OFILE_MAX			(16 * 1024)
746da6c28aaSamw 
747da6c28aaSamw /*
748da6c28aaSamw  * When a connection is set up we need to remember both the client
749da6c28aaSamw  * (peer) IP address and the local IP address used to establish the
750da6c28aaSamw  * connection. When a client connects with a vc number of zero, we
751da6c28aaSamw  * are supposed to abort any existing connections with that client
752da6c28aaSamw  * (see notes in smb_negotiate.c and smb_session_setup_andx.c). For
753da6c28aaSamw  * servers with multiple network interfaces or IP aliases, however,
754da6c28aaSamw  * each interface has to be managed independently since the client
755da6c28aaSamw  * is not aware of the server configuration. We have to allow the
756da6c28aaSamw  * client to establish a connection on each interface with a vc
757da6c28aaSamw  * number of zero without aborting the other connections.
758da6c28aaSamw  *
759da6c28aaSamw  * ipaddr:       the client (peer) IP address for the session.
760da6c28aaSamw  * local_ipaddr: the local IP address used to connect to the server.
761da6c28aaSamw  */
762da6c28aaSamw 
763da6c28aaSamw struct smb_sign {
764da6c28aaSamw 	unsigned int flags;
765*b819cea2SGordon Ross 	uint32_t seqnum;
766*b819cea2SGordon Ross 	uint_t mackey_len;
767*b819cea2SGordon Ross 	uint8_t *mackey;
768*b819cea2SGordon Ross 	void	*mech;	/* mechanism info */
769da6c28aaSamw };
770da6c28aaSamw 
771da6c28aaSamw #define	SMB_SIGNING_ENABLED	1
772da6c28aaSamw #define	SMB_SIGNING_CHECK	2
773da6c28aaSamw 
774da6c28aaSamw /*
775da6c28aaSamw  * Session State Machine
776da6c28aaSamw  * ---------------------
777da6c28aaSamw  *
778da6c28aaSamw  * +-----------------------------+	     +------------------------------+
779da6c28aaSamw  * | SMB_SESSION_STATE_CONNECTED |           | SMB_SESSION_STATE_TERMINATED |
780da6c28aaSamw  * +-----------------------------+           +------------------------------+
781da6c28aaSamw  *		T0|					     ^
782da6c28aaSamw  *		  +--------------------+		     |T13
783da6c28aaSamw  *		  v		       |T14                  |
784da6c28aaSamw  * +-------------------------------+   |    +--------------------------------+
785da6c28aaSamw  * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED |
786da6c28aaSamw  * +-------------------------------+        +--------------------------------+
787da6c28aaSamw  *		T1|				^	   ^ ^ ^
788da6c28aaSamw  *		  +----------+			|T9        | | |
789da6c28aaSamw  *                           v			|          | | |
790da6c28aaSamw  *                  +------------------------------+       | | |
791da6c28aaSamw  *                  | SMB_SESSION_STATE_NEGOTIATED |       | | |
792da6c28aaSamw  *                  +------------------------------+       | | |
793da6c28aaSamw  *	                 ^|   ^|   | ^                     | | |
794da6c28aaSamw  *      +----------------+|   ||   | |                     | | |
795da6c28aaSamw  *      |+----------------+   || T7| |T8                   | | |
796da6c28aaSamw  *      ||                    ||   | |                     | | |
797da6c28aaSamw  *      ||   +----------------+|   | |                     | | |
798da6c28aaSamw  *      ||   |+----------------+   | |                     | | |
799da6c28aaSamw  *	||   ||			   v |                     | | |
800da6c28aaSamw  *      ||   ||   +-----------------------------------+ T10| | |
801da6c28aaSamw  *      ||   ||   | SMB_SESSION_STATE_OPLOCK_BREAKING |----+ | |
802da6c28aaSamw  *      ||   ||   +-----------------------------------+      | |
803da6c28aaSamw  *	||   ||T5                                            | |
804da6c28aaSamw  *      ||   |+-->+-----------------------------------+	  T11| |
805da6c28aaSamw  *      ||   |T6  | SMB_SESSION_STATE_READ_RAW_ACTIVE |------+ |
806da6c28aaSamw  *      ||   +----+-----------------------------------+        |
807da6c28aaSamw  *	||T3                                                   |
808da6c28aaSamw  *      |+------->+------------------------------------+    T12|
809da6c28aaSamw  *      |T4       | SMB_SESSION_STATE_WRITE_RAW_ACTIVE |-------+
810da6c28aaSamw  *      +---------+------------------------------------+
811da6c28aaSamw  *
812da6c28aaSamw  * Transition T0
813da6c28aaSamw  *
814da6c28aaSamw  *
815da6c28aaSamw  *
816da6c28aaSamw  * Transition T1
817da6c28aaSamw  *
818da6c28aaSamw  *
819da6c28aaSamw  *
820da6c28aaSamw  * Transition T2
821da6c28aaSamw  *
822da6c28aaSamw  *
823da6c28aaSamw  *
824da6c28aaSamw  * Transition T3
825da6c28aaSamw  *
826da6c28aaSamw  *
827da6c28aaSamw  *
828da6c28aaSamw  * Transition T4
829da6c28aaSamw  *
830da6c28aaSamw  *
831da6c28aaSamw  *
832da6c28aaSamw  * Transition T5
833da6c28aaSamw  *
834da6c28aaSamw  *
835da6c28aaSamw  *
836da6c28aaSamw  * Transition T6
837da6c28aaSamw  *
838da6c28aaSamw  *
839da6c28aaSamw  *
840da6c28aaSamw  * Transition T7
841da6c28aaSamw  *
842da6c28aaSamw  *
843da6c28aaSamw  *
844da6c28aaSamw  * Transition T8
845da6c28aaSamw  *
846da6c28aaSamw  *
847da6c28aaSamw  *
848da6c28aaSamw  * Transition T9
849da6c28aaSamw  *
850da6c28aaSamw  *
851da6c28aaSamw  *
852da6c28aaSamw  * Transition T10
853da6c28aaSamw  *
854da6c28aaSamw  *
855da6c28aaSamw  *
856da6c28aaSamw  * Transition T11
857da6c28aaSamw  *
858da6c28aaSamw  *
859da6c28aaSamw  *
860da6c28aaSamw  * Transition T12
861da6c28aaSamw  *
862da6c28aaSamw  *
863da6c28aaSamw  *
864da6c28aaSamw  * Transition T13
865da6c28aaSamw  *
866da6c28aaSamw  *
867da6c28aaSamw  *
868da6c28aaSamw  * Transition T14
869da6c28aaSamw  *
870da6c28aaSamw  *
871da6c28aaSamw  *
872da6c28aaSamw  */
8732c2961f8Sjose borrego #define	SMB_SESSION_MAGIC	0x53455353	/* 'SESS' */
8749fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_SESSION_VALID(p)	\
8759fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((p) != NULL) && ((p)->s_magic == SMB_SESSION_MAGIC))
876da6c28aaSamw 
877f9bc6dadSDmitry.Savitsky@nexenta.com #define	SMB_CHALLENGE_SZ	8
878f9bc6dadSDmitry.Savitsky@nexenta.com 
879da6c28aaSamw typedef enum {
880faa1795aSjb 	SMB_SESSION_STATE_INITIALIZED = 0,
881faa1795aSjb 	SMB_SESSION_STATE_DISCONNECTED,
882da6c28aaSamw 	SMB_SESSION_STATE_CONNECTED,
883da6c28aaSamw 	SMB_SESSION_STATE_ESTABLISHED,
884da6c28aaSamw 	SMB_SESSION_STATE_NEGOTIATED,
885da6c28aaSamw 	SMB_SESSION_STATE_OPLOCK_BREAKING,
8866537f381Sas 	SMB_SESSION_STATE_TERMINATED,
8876537f381Sas 	SMB_SESSION_STATE_SENTINEL
888da6c28aaSamw } smb_session_state_t;
889da6c28aaSamw 
890faa1795aSjb typedef struct smb_session {
891da6c28aaSamw 	uint32_t		s_magic;
892da6c28aaSamw 	smb_rwx_t		s_lock;
893da6c28aaSamw 	list_node_t		s_lnd;
894da6c28aaSamw 	uint64_t		s_kid;
895da6c28aaSamw 	smb_session_state_t	s_state;
896da6c28aaSamw 	uint32_t		s_flags;
8978622ec45SGordon Ross 	taskqid_t		s_receiver_tqid;
898faa1795aSjb 	kthread_t		*s_thread;
899faa1795aSjb 	kt_did_t		s_ktdid;
900faa1795aSjb 	smb_kmod_cfg_t		s_cfg;
901faa1795aSjb 	struct smb_server	*s_server;
902c8ec8eeaSjose borrego 	int32_t			s_gmtoff;
903da6c28aaSamw 	uint32_t		keep_alive;
904da6c28aaSamw 	uint64_t		opentime;
905da6c28aaSamw 	uint16_t		vcnumber;
906da6c28aaSamw 	uint16_t		s_local_port;
9077f667e74Sjose borrego 	smb_inaddr_t		ipaddr;
9087f667e74Sjose borrego 	smb_inaddr_t		local_ipaddr;
909da6c28aaSamw 	char 			workstation[SMB_PI_MAX_HOST];
910da6c28aaSamw 	int			dialect;
911da6c28aaSamw 	int			native_os;
912148c5f43SAlan Wright 	int			native_lm;
913148c5f43SAlan Wright 
914da6c28aaSamw 	uint32_t		capabilities;
915da6c28aaSamw 	struct smb_sign		signing;
916*b819cea2SGordon Ross 	void			(*sign_fini)(struct smb_session *);
917da6c28aaSamw 
9180f1702c5SYu Xiangning 	ksocket_t		sock;
919da6c28aaSamw 
920da6c28aaSamw 	smb_slist_t		s_req_list;
921da6c28aaSamw 	smb_llist_t		s_xa_list;
922da6c28aaSamw 	smb_llist_t		s_user_list;
9233b13a1efSThomas Keiser 	smb_llist_t		s_tree_list;
924da6c28aaSamw 	smb_idpool_t		s_uid_pool;
9253b13a1efSThomas Keiser 	smb_idpool_t		s_tid_pool;
9265cdbe942Sjb 	smb_txlst_t		s_txlst;
927da6c28aaSamw 
928da6c28aaSamw 	volatile uint32_t	s_tree_cnt;
929da6c28aaSamw 	volatile uint32_t	s_file_cnt;
930da6c28aaSamw 	volatile uint32_t	s_dir_cnt;
931da6c28aaSamw 
932da6c28aaSamw 	uint16_t		secmode;
933da6c28aaSamw 	uint32_t		sesskey;
934da6c28aaSamw 	uint32_t		challenge_len;
935f9bc6dadSDmitry.Savitsky@nexenta.com 	unsigned char		challenge_key[SMB_CHALLENGE_SZ];
936da6c28aaSamw 	unsigned char		MAC_key[44];
937da6c28aaSamw 	int64_t			activity_timestamp;
938da6c28aaSamw 	/*
939da6c28aaSamw 	 * Maximum negotiated buffer size between SMB client and server
940da6c28aaSamw 	 * in SMB_SESSION_SETUP_ANDX
941da6c28aaSamw 	 */
942da6c28aaSamw 	uint16_t		smb_msg_size;
943da6c28aaSamw 	uchar_t			*outpipe_data;
944da6c28aaSamw 	int			outpipe_datalen;
945da6c28aaSamw 	int			outpipe_cookie;
946148c5f43SAlan Wright 	smb_srqueue_t		*s_srqueue;
947faa1795aSjb } smb_session_t;
948da6c28aaSamw 
949da6c28aaSamw #define	SMB_USER_MAGIC 0x55534552	/* 'USER' */
9509fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_USER_VALID(u)	\
9519fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((u) != NULL) && ((u)->u_magic == SMB_USER_MAGIC))
952da6c28aaSamw 
953da6c28aaSamw #define	SMB_USER_FLAG_GUEST			SMB_ATF_GUEST
954da6c28aaSamw #define	SMB_USER_FLAG_IPC			SMB_ATF_ANON
955da6c28aaSamw #define	SMB_USER_FLAG_ADMIN			SMB_ATF_ADMIN
956da6c28aaSamw #define	SMB_USER_FLAG_POWER_USER		SMB_ATF_POWERUSER
957da6c28aaSamw #define	SMB_USER_FLAG_BACKUP_OPERATOR		SMB_ATF_BACKUPOP
958da6c28aaSamw 
959148c5f43SAlan Wright #define	SMB_USER_IS_ADMIN(U)	(((U)->u_flags & SMB_USER_FLAG_ADMIN) != 0)
960148c5f43SAlan Wright #define	SMB_USER_IS_GUEST(U)	(((U)->u_flags & SMB_USER_FLAG_GUEST) != 0)
961148c5f43SAlan Wright 
962da6c28aaSamw #define	SMB_USER_PRIV_TAKE_OWNERSHIP	0x00000001
963da6c28aaSamw #define	SMB_USER_PRIV_BACKUP		0x00000002
964da6c28aaSamw #define	SMB_USER_PRIV_RESTORE		0x00000004
965da6c28aaSamw #define	SMB_USER_PRIV_SECURITY		0x00000008
966da6c28aaSamw 
967da6c28aaSamw 
968da6c28aaSamw typedef enum {
969da6c28aaSamw 	SMB_USER_STATE_LOGGED_IN = 0,
970da6c28aaSamw 	SMB_USER_STATE_LOGGING_OFF,
9716537f381Sas 	SMB_USER_STATE_LOGGED_OFF,
9726537f381Sas 	SMB_USER_STATE_SENTINEL
973da6c28aaSamw } smb_user_state_t;
974da6c28aaSamw 
975da6c28aaSamw typedef struct smb_user {
976da6c28aaSamw 	uint32_t		u_magic;
977da6c28aaSamw 	list_node_t		u_lnd;
978da6c28aaSamw 	kmutex_t		u_mutex;
979da6c28aaSamw 	smb_user_state_t	u_state;
980da6c28aaSamw 
981faa1795aSjb 	struct smb_server	*u_server;
982da6c28aaSamw 	smb_session_t		*u_session;
983da6c28aaSamw 	uint16_t		u_name_len;
984da6c28aaSamw 	char			*u_name;
985da6c28aaSamw 	uint16_t		u_domain_len;
986da6c28aaSamw 	char			*u_domain;
987da6c28aaSamw 	time_t			u_logon_time;
988da6c28aaSamw 	cred_t			*u_cred;
989b89a8333Snatalie li - Sun Microsystems - Irvine United States 	cred_t			*u_privcred;
990da6c28aaSamw 
991da6c28aaSamw 	uint32_t		u_refcnt;
992da6c28aaSamw 	uint32_t		u_flags;
993da6c28aaSamw 	uint32_t		u_privileges;
994da6c28aaSamw 	uint16_t		u_uid;
995da6c28aaSamw 	uint32_t		u_audit_sid;
996da6c28aaSamw } smb_user_t;
997da6c28aaSamw 
998c8ec8eeaSjose borrego #define	SMB_TREE_MAGIC			0x54524545	/* 'TREE' */
9999fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_VALID(p)	\
10009fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT((p != NULL) && ((p)->t_magic == SMB_TREE_MAGIC))
1001c8ec8eeaSjose borrego 
1002c8ec8eeaSjose borrego #define	SMB_TYPENAMELEN			_ST_FSTYPSZ
1003c8ec8eeaSjose borrego #define	SMB_VOLNAMELEN			32
1004c8ec8eeaSjose borrego 
1005c8ec8eeaSjose borrego #define	SMB_TREE_READONLY		0x00000001
1006c8ec8eeaSjose borrego #define	SMB_TREE_SUPPORTS_ACLS		0x00000002
1007c8ec8eeaSjose borrego #define	SMB_TREE_STREAMS		0x00000004
1008c8ec8eeaSjose borrego #define	SMB_TREE_CASEINSENSITIVE	0x00000008
1009c8ec8eeaSjose borrego #define	SMB_TREE_NO_CASESENSITIVE	0x00000010
1010c8ec8eeaSjose borrego #define	SMB_TREE_NO_EXPORT		0x00000020
1011cb174861Sjoyce mcintosh #define	SMB_TREE_OPLOCKS		0x00000040
1012cb174861Sjoyce mcintosh #define	SMB_TREE_SHORTNAMES		0x00000080
1013c8ec8eeaSjose borrego #define	SMB_TREE_XVATTR			0x00000100
1014c8ec8eeaSjose borrego #define	SMB_TREE_DIRENTFLAGS		0x00000200
1015c8ec8eeaSjose borrego #define	SMB_TREE_ACLONCREATE		0x00000400
1016c8ec8eeaSjose borrego #define	SMB_TREE_ACEMASKONACCESS	0x00000800
1017c8ec8eeaSjose borrego #define	SMB_TREE_NFS_MOUNTED		0x00001000
1018fc724630SAlan Wright #define	SMB_TREE_UNICODE_ON_DISK	0x00002000
10198b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_CATIA			0x00004000
1020e3f2c991SKeyur Desai #define	SMB_TREE_ABE			0x00008000
10219fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_QUOTA			0x00010000
10229fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_DFSROOT		0x00020000
1023fd9ee8b5Sjoyce mcintosh #define	SMB_TREE_SPARSE			0x00040000
10245f1ef25cSAram Hăvărneanu #define	SMB_TREE_TRAVERSE_MOUNTS	0x00080000
10252c1b14e5Sjose borrego 
1026da6c28aaSamw typedef enum {
1027da6c28aaSamw 	SMB_TREE_STATE_CONNECTED = 0,
1028da6c28aaSamw 	SMB_TREE_STATE_DISCONNECTING,
10296537f381Sas 	SMB_TREE_STATE_DISCONNECTED,
10306537f381Sas 	SMB_TREE_STATE_SENTINEL
1031da6c28aaSamw } smb_tree_state_t;
1032da6c28aaSamw 
1033da6c28aaSamw typedef struct smb_tree {
1034da6c28aaSamw 	uint32_t		t_magic;
1035da6c28aaSamw 	kmutex_t		t_mutex;
1036da6c28aaSamw 	list_node_t		t_lnd;
1037da6c28aaSamw 	smb_tree_state_t	t_state;
1038da6c28aaSamw 
1039faa1795aSjb 	struct smb_server	*t_server;
1040da6c28aaSamw 	smb_session_t		*t_session;
10413b13a1efSThomas Keiser 	/*
10423b13a1efSThomas Keiser 	 * user whose uid was in the tree connect message
10433b13a1efSThomas Keiser 	 * ("owner" in MS-CIFS parlance, see section 2.2.1.6 definition of FID)
10443b13a1efSThomas Keiser 	 */
10453b13a1efSThomas Keiser 	smb_user_t		*t_owner;
1046da6c28aaSamw 	smb_node_t		*t_snode;
1047da6c28aaSamw 
1048da6c28aaSamw 	smb_llist_t		t_ofile_list;
1049da6c28aaSamw 	smb_idpool_t		t_fid_pool;
1050da6c28aaSamw 
1051da6c28aaSamw 	smb_llist_t		t_odir_list;
10527f667e74Sjose borrego 	smb_idpool_t		t_odid_pool;
1053da6c28aaSamw 
1054da6c28aaSamw 	uint32_t		t_refcnt;
1055da6c28aaSamw 	uint32_t		t_flags;
1056da6c28aaSamw 	int32_t			t_res_type;
1057da6c28aaSamw 	uint16_t		t_tid;
1058da6c28aaSamw 	uint16_t		t_umask;
1059da6c28aaSamw 	char			t_sharename[MAXNAMELEN];
1060da6c28aaSamw 	char			t_resource[MAXPATHLEN];
1061c8ec8eeaSjose borrego 	char			t_typename[SMB_TYPENAMELEN];
1062c8ec8eeaSjose borrego 	char			t_volume[SMB_VOLNAMELEN];
1063da6c28aaSamw 	acl_type_t		t_acltype;
1064743a77edSAlan Wright 	uint32_t		t_access;
1065148c5f43SAlan Wright 	uint32_t		t_execflags;
10661fcced4cSJordan Brown 	time_t			t_connect_time;
10671fcced4cSJordan Brown 	volatile uint32_t	t_open_files;
1068da6c28aaSamw } smb_tree_t;
1069da6c28aaSamw 
1070c8ec8eeaSjose borrego #define	SMB_TREE_VFS(tree)	((tree)->t_snode->vp->v_vfsp)
1071c8ec8eeaSjose borrego #define	SMB_TREE_FSID(tree)	((tree)->t_snode->vp->v_vfsp->vfs_fsid)
1072c8ec8eeaSjose borrego 
1073743a77edSAlan Wright #define	SMB_TREE_IS_READONLY(sr)					\
1074743a77edSAlan Wright 	((sr) != NULL && (sr)->tid_tree != NULL &&			\
1075743a77edSAlan Wright 	!((sr)->tid_tree->t_access & ACE_ALL_WRITE_PERMS))
1076c8ec8eeaSjose borrego 
1077c8ec8eeaSjose borrego #define	SMB_TREE_IS_CASEINSENSITIVE(sr)                                 \
1078c8ec8eeaSjose borrego 	(((sr) && (sr)->tid_tree) ?                                     \
1079c8ec8eeaSjose borrego 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0)
1080da6c28aaSamw 
1081743a77edSAlan Wright #define	SMB_TREE_HAS_ACCESS(sr, acemask)				\
1082743a77edSAlan Wright 	((sr) == NULL ? ACE_ALL_PERMS : (				\
1083743a77edSAlan Wright 	(((sr) && (sr)->tid_tree) ?					\
1084743a77edSAlan Wright 	(((sr)->tid_tree->t_access) & (acemask)) : 0)))
1085743a77edSAlan Wright 
10868b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_SUPPORTS_CATIA(sr)            				\
10878b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	(((sr) && (sr)->tid_tree) ?                                     \
10888b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CATIA) : 0)
10898b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 
1090e3f2c991SKeyur Desai #define	SMB_TREE_SUPPORTS_ABE(sr)            				\
1091e3f2c991SKeyur Desai 	(((sr) && (sr)->tid_tree) ?                                     \
1092e3f2c991SKeyur Desai 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_ABE) : 0)
1093e3f2c991SKeyur Desai 
10949fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_TREE_IS_DFSROOT(sr)            				\
10959fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	(((sr) && (sr)->tid_tree) ?                                     \
10969fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_DFSROOT) : 0)
10979fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
1098cb174861Sjoyce mcintosh #define	SMB_TREE_SUPPORTS_SHORTNAMES(sr)				\
1099cb174861Sjoyce mcintosh 	(((sr) && (sr)->tid_tree) ?					\
1100cb174861Sjoyce mcintosh 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_SHORTNAMES) : 0)
1101cb174861Sjoyce mcintosh 
1102da6c28aaSamw /*
11035f1ef25cSAram Hăvărneanu  * SMB_TREE_CONTAINS_NODE is used to check if a node is on the same
11045f1ef25cSAram Hăvărneanu  * file system as the tree's root filesystem, or if mount point traversal
11055f1ef25cSAram Hăvărneanu  * should be allowed.  Note that this is also called in some cases with
11065f1ef25cSAram Hăvărneanu  * sr=NULL, where it is expected to evaluate to TRUE.
1107da6c28aaSamw  */
11085f1ef25cSAram Hăvărneanu 
1109c8ec8eeaSjose borrego #define	SMB_TREE_CONTAINS_NODE(sr, node)                                \
11105f1ef25cSAram Hăvărneanu 	((sr) == NULL || (sr)->tid_tree == NULL ||                      \
11115f1ef25cSAram Hăvărneanu 	SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node) ||           \
11125f1ef25cSAram Hăvărneanu 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_TRAVERSE_MOUNTS))
1113da6c28aaSamw 
1114da6c28aaSamw /*
1115c8ec8eeaSjose borrego  * SMB_OFILE_IS_READONLY reflects whether an ofile is readonly or not.
11165fd03bc0SGordon Ross  * The macro takes into account read-only settings in any of:
11175fd03bc0SGordon Ross  * the tree, the node (pending) and the file-system object.
11185fd03bc0SGordon Ross  * all of this is evaluated in smb_ofile_open() and after that
11195fd03bc0SGordon Ross  * we can just test the f_flags & SMB_OFLAGS_READONLY
1120da6c28aaSamw  */
11215fd03bc0SGordon Ross #define	SMB_OFILE_IS_READONLY(of)	\
11225fd03bc0SGordon Ross 	((of)->f_flags & SMB_OFLAGS_READONLY)
1123da6c28aaSamw 
1124c8ec8eeaSjose borrego /*
1125c8ec8eeaSjose borrego  * SMB_PATHFILE_IS_READONLY indicates whether or not a file is
11265fd03bc0SGordon Ross  * readonly when the caller has a path rather than an ofile.
1127c8ec8eeaSjose borrego  */
11285fd03bc0SGordon Ross #define	SMB_PATHFILE_IS_READONLY(sr, node)			\
11295fd03bc0SGordon Ross 	(SMB_TREE_IS_READONLY((sr)) ||				\
11305fd03bc0SGordon Ross 	smb_node_file_is_readonly((node)))
1131da6c28aaSamw 
11329fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_OPIPE_MAGIC		0x50495045	/* 'PIPE' */
11339fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_OPIPE_VALID(p)	\
11349fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((p) != NULL) && (p)->p_magic == SMB_OPIPE_MAGIC)
1135da6c28aaSamw 
11363db3f65cSamw /*
11373db3f65cSamw  * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used
11383db3f65cSamw  * at the interface between SMB and NDR RPC.
11393db3f65cSamw  */
11403db3f65cSamw typedef struct smb_opipe {
11419fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		p_magic;
11429fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_node_t		p_lnd;
11439fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmutex_t		p_mutex;
11449fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kcondvar_t		p_cv;
11459fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_server	*p_server;
11469fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	struct smb_event	*p_event;
11479fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	char			*p_name;
11489fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		p_busy;
11499fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_doorhdr_t		p_hdr;
11509fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_netuserinfo_t	p_user;
11519fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint8_t			*p_doorbuf;
11529fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint8_t			*p_data;
11533db3f65cSamw } smb_opipe_t;
11543db3f65cSamw 
1155da6c28aaSamw /*
1156da6c28aaSamw  * The of_ftype	of an open file should contain the SMB_FTYPE value
1157bbf6f00cSJordan Brown  * returned when the file/pipe was opened. The following
1158da6c28aaSamw  * assumptions are currently made:
1159da6c28aaSamw  *
1160da6c28aaSamw  * File Type	    Node       PipeInfo
1161da6c28aaSamw  * ---------	    --------   --------
1162da6c28aaSamw  * SMB_FTYPE_DISK       Valid      Null
1163da6c28aaSamw  * SMB_FTYPE_BYTE_PIPE  Undefined  Undefined
1164da6c28aaSamw  * SMB_FTYPE_MESG_PIPE  Null       Valid
1165da6c28aaSamw  * SMB_FTYPE_PRINTER    Undefined  Undefined
1166da6c28aaSamw  * SMB_FTYPE_UNKNOWN    Undefined  Undefined
1167da6c28aaSamw  */
1168da6c28aaSamw 
1169da6c28aaSamw /*
1170da6c28aaSamw  * Some flags for ofile structure
1171da6c28aaSamw  *
1172da6c28aaSamw  *	SMB_OFLAGS_SET_DELETE_ON_CLOSE
1173da6c28aaSamw  *   Set this flag when the corresponding open operation whose
1174da6c28aaSamw  *   DELETE_ON_CLOSE bit of the CreateOptions is set. If any
1175da6c28aaSamw  *   open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE
1176da6c28aaSamw  *   will be set for the file node upon close.
1177da6c28aaSamw  */
1178da6c28aaSamw 
1179c8ec8eeaSjose borrego #define	SMB_OFLAGS_READONLY		0x0001
11802c2961f8Sjose borrego #define	SMB_OFLAGS_EXECONLY		0x0002
1181da6c28aaSamw #define	SMB_OFLAGS_SET_DELETE_ON_CLOSE	0x0004
1182da6c28aaSamw #define	SMB_OFLAGS_LLF_POS_VALID	0x0008
1183da6c28aaSamw 
1184da6c28aaSamw #define	SMB_OFILE_MAGIC 	0x4F464C45	/* 'OFLE' */
11859fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_OFILE_VALID(p)	\
11869fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT((p != NULL) && ((p)->f_magic == SMB_OFILE_MAGIC))
1187da6c28aaSamw 
1188da6c28aaSamw typedef enum {
1189da6c28aaSamw 	SMB_OFILE_STATE_OPEN = 0,
1190da6c28aaSamw 	SMB_OFILE_STATE_CLOSING,
11916537f381Sas 	SMB_OFILE_STATE_CLOSED,
11926537f381Sas 	SMB_OFILE_STATE_SENTINEL
1193da6c28aaSamw } smb_ofile_state_t;
1194da6c28aaSamw 
1195da6c28aaSamw typedef struct smb_ofile {
1196da6c28aaSamw 	uint32_t		f_magic;
1197da6c28aaSamw 	kmutex_t		f_mutex;
1198da6c28aaSamw 	list_node_t		f_lnd;
1199da6c28aaSamw 	list_node_t		f_nnd;
1200da6c28aaSamw 	smb_ofile_state_t	f_state;
1201da6c28aaSamw 
1202faa1795aSjb 	struct smb_server	*f_server;
1203da6c28aaSamw 	smb_session_t		*f_session;
1204da6c28aaSamw 	smb_user_t		*f_user;
1205da6c28aaSamw 	smb_tree_t		*f_tree;
1206da6c28aaSamw 	smb_node_t		*f_node;
12073db3f65cSamw 	smb_opipe_t		*f_pipe;
1208da6c28aaSamw 
1209dc20a302Sas 	uint32_t		f_uniqid;
1210da6c28aaSamw 	uint32_t		f_refcnt;
1211da6c28aaSamw 	uint64_t		f_seek_pos;
1212da6c28aaSamw 	uint32_t		f_flags;
1213da6c28aaSamw 	uint32_t		f_granted_access;
1214da6c28aaSamw 	uint32_t		f_share_access;
1215da6c28aaSamw 	uint32_t		f_create_options;
1216da6c28aaSamw 	uint16_t		f_fid;
1217da6c28aaSamw 	uint16_t		f_opened_by_pid;
1218da6c28aaSamw 	uint16_t		f_ftype;
1219da6c28aaSamw 	uint64_t		f_llf_pos;
12208c10a865Sas 	int			f_mode;
1221da6c28aaSamw 	cred_t			*f_cr;
12226537f381Sas 	pid_t			f_pid;
12235fd03bc0SGordon Ross 	smb_attr_t		f_pending_attr;
12245fd03bc0SGordon Ross 	boolean_t		f_written;
12259fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	char			f_quota_resume[SMB_SID_STRSZ];
12261fdeec65Sjoyce mcintosh 	smb_oplock_grant_t	f_oplock_grant;
1227da6c28aaSamw } smb_ofile_t;
1228da6c28aaSamw 
12297f667e74Sjose borrego #define	SMB_ODIR_MAGIC 		0x4F444952	/* 'ODIR' */
12309fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_VALID(p)	\
12319fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT((p != NULL) && ((p)->d_magic == SMB_ODIR_MAGIC))
12329fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
12337f667e74Sjose borrego #define	SMB_ODIR_BUFSIZE	(8 * 1024)
1234da6c28aaSamw 
12358b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_WILDCARDS		0x0001
12368b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_IGNORE_CASE	0x0002
12378b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_XATTR		0x0004
12388b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_EDIRENT		0x0008
12398b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_FLAG_CATIA		0x0010
1240e3f2c991SKeyur Desai #define	SMB_ODIR_FLAG_ABE		0x0020
1241cb174861Sjoyce mcintosh #define	SMB_ODIR_FLAG_SHORTNAMES	0x0040
12428b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 
1243da6c28aaSamw typedef enum {
1244da6c28aaSamw 	SMB_ODIR_STATE_OPEN = 0,
1245a1511e6bSjoyce mcintosh 	SMB_ODIR_STATE_IN_USE,
1246da6c28aaSamw 	SMB_ODIR_STATE_CLOSING,
12476537f381Sas 	SMB_ODIR_STATE_CLOSED,
12486537f381Sas 	SMB_ODIR_STATE_SENTINEL
1249da6c28aaSamw } smb_odir_state_t;
1250da6c28aaSamw 
12517f667e74Sjose borrego typedef enum {
1252bfbce3c1SGordon Ross 	SMB_ODIR_RESUME_CONT,
12537f667e74Sjose borrego 	SMB_ODIR_RESUME_IDX,
12547f667e74Sjose borrego 	SMB_ODIR_RESUME_COOKIE,
12557f667e74Sjose borrego 	SMB_ODIR_RESUME_FNAME
12567f667e74Sjose borrego } smb_odir_resume_type_t;
12577f667e74Sjose borrego 
12587f667e74Sjose borrego typedef struct smb_odir_resume {
12597f667e74Sjose borrego 	smb_odir_resume_type_t	or_type;
12607f667e74Sjose borrego 	int			or_idx;
12617f667e74Sjose borrego 	uint32_t		or_cookie;
12627f667e74Sjose borrego 	char			*or_fname;
12637f667e74Sjose borrego } smb_odir_resume_t;
12647f667e74Sjose borrego 
1265eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States /*
1266eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States  * Flags used when opening an odir
1267eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States  */
1268eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_ODIR_OPENF_BACKUP_INTENT	0x01
1269eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 
1270da6c28aaSamw typedef struct smb_odir {
1271da6c28aaSamw 	uint32_t		d_magic;
1272da6c28aaSamw 	kmutex_t		d_mutex;
1273da6c28aaSamw 	list_node_t		d_lnd;
1274da6c28aaSamw 	smb_odir_state_t	d_state;
1275da6c28aaSamw 	smb_session_t		*d_session;
12763b13a1efSThomas Keiser 	smb_user_t		*d_user;
1277da6c28aaSamw 	smb_tree_t		*d_tree;
12787f667e74Sjose borrego 	smb_node_t		*d_dnode;
1279eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	cred_t			*d_cred;
12807f667e74Sjose borrego 	uint16_t		d_odid;
1281da6c28aaSamw 	uint16_t		d_opened_by_pid;
1282da6c28aaSamw 	uint16_t		d_sattr;
12837f667e74Sjose borrego 	uint32_t		d_refcnt;
12848b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		d_flags;
12857f667e74Sjose borrego 	boolean_t		d_eof;
12867f667e74Sjose borrego 	int			d_bufsize;
12877f667e74Sjose borrego 	uint64_t		d_offset;
12887f667e74Sjose borrego 	union {
12897f667e74Sjose borrego 		char		*u_bufptr;
1290*b819cea2SGordon Ross 		struct edirent	*u_edp;
1291*b819cea2SGordon Ross 		struct dirent64	*u_dp;
12927f667e74Sjose borrego 	} d_u;
1293bfbce3c1SGordon Ross 	uint32_t		d_last_cookie;
12947f667e74Sjose borrego 	uint32_t		d_cookies[SMB_MAX_SEARCH];
1295da6c28aaSamw 	char			d_pattern[MAXNAMELEN];
12967f667e74Sjose borrego 	char			d_buf[SMB_ODIR_BUFSIZE];
1297bfbce3c1SGordon Ross 	char			d_last_name[MAXNAMELEN];
1298da6c28aaSamw } smb_odir_t;
12997f667e74Sjose borrego #define	d_bufptr	d_u.u_bufptr
13007f667e74Sjose borrego #define	d_edp		d_u.u_edp
13017f667e74Sjose borrego #define	d_dp		d_u.u_dp
13027f667e74Sjose borrego 
13037f667e74Sjose borrego typedef struct smb_odirent {
13047f667e74Sjose borrego 	char		od_name[MAXNAMELEN];	/* on disk name */
13057f667e74Sjose borrego 	ino64_t		od_ino;
13067f667e74Sjose borrego 	uint32_t	od_eflags;
13077f667e74Sjose borrego } smb_odirent_t;
13087f667e74Sjose borrego 
13097f667e74Sjose borrego typedef struct smb_fileinfo {
13107f667e74Sjose borrego 	char		fi_name[MAXNAMELEN];
13117f667e74Sjose borrego 	char		fi_shortname[SMB_SHORTNAMELEN];
1312bfbce3c1SGordon Ross 	uint32_t	fi_cookie;	/* Dir offset (of next entry) */
13137f667e74Sjose borrego 	uint32_t	fi_dosattr;	/* DOS attributes */
13147f667e74Sjose borrego 	uint64_t	fi_nodeid;	/* file system node id */
13157f667e74Sjose borrego 	uint64_t	fi_size;	/* file size in bytes */
13167f667e74Sjose borrego 	uint64_t	fi_alloc_size;	/* allocation size in bytes */
13177f667e74Sjose borrego 	timestruc_t	fi_atime;	/* last access */
13187f667e74Sjose borrego 	timestruc_t	fi_mtime;	/* last modification */
13197f667e74Sjose borrego 	timestruc_t	fi_ctime;	/* last status change */
13207f667e74Sjose borrego 	timestruc_t	fi_crtime;	/* file creation */
13217f667e74Sjose borrego } smb_fileinfo_t;
13227f667e74Sjose borrego 
13237f667e74Sjose borrego typedef struct smb_streaminfo {
13247f667e74Sjose borrego 	uint64_t	si_size;
1325037cac00Sjoyce mcintosh 	uint64_t	si_alloc_size;
13267f667e74Sjose borrego 	char		si_name[MAXPATHLEN];
13277f667e74Sjose borrego } smb_streaminfo_t;
1328da6c28aaSamw 
1329da6c28aaSamw #define	SMB_LOCK_MAGIC 	0x4C4F434B	/* 'LOCK' */
1330da6c28aaSamw 
1331da6c28aaSamw typedef struct smb_lock {
1332da6c28aaSamw 	uint32_t		l_magic;
1333da6c28aaSamw 	kmutex_t		l_mutex;
1334da6c28aaSamw 	list_node_t		l_lnd;
1335da6c28aaSamw 	kcondvar_t		l_cv;
1336da6c28aaSamw 
1337da6c28aaSamw 	list_node_t		l_conflict_lnd;
1338da6c28aaSamw 	smb_slist_t		l_conflict_list;
1339da6c28aaSamw 
1340da6c28aaSamw 	smb_session_t		*l_session;
1341da6c28aaSamw 	smb_ofile_t		*l_file;
1342faa1795aSjb 	struct smb_request	*l_sr;
1343da6c28aaSamw 
1344da6c28aaSamw 	uint32_t		l_flags;
1345da6c28aaSamw 	uint64_t		l_session_kid;
1346da6c28aaSamw 	struct smb_lock		*l_blocked_by; /* Debug info only */
1347da6c28aaSamw 
1348da6c28aaSamw 	uint16_t		l_pid;
1349da6c28aaSamw 	uint16_t		l_uid;
1350da6c28aaSamw 	uint32_t		l_type;
1351da6c28aaSamw 	uint64_t		l_start;
1352da6c28aaSamw 	uint64_t		l_length;
1353da6c28aaSamw 	clock_t			l_end_time;
1354da6c28aaSamw } smb_lock_t;
1355da6c28aaSamw 
1356da6c28aaSamw #define	SMB_LOCK_FLAG_INDEFINITE	0x0004
1357da6c28aaSamw #define	SMB_LOCK_INDEFINITE_WAIT(lock) \
1358da6c28aaSamw 	((lock)->l_flags & SMB_LOCK_FLAG_INDEFINITE)
1359da6c28aaSamw 
1360da6c28aaSamw #define	SMB_LOCK_TYPE_READWRITE		101
1361da6c28aaSamw #define	SMB_LOCK_TYPE_READONLY		102
1362da6c28aaSamw 
1363faa1795aSjb typedef struct vardata_block {
13642c2961f8Sjose borrego 	uint8_t			vdb_tag;
13652c2961f8Sjose borrego 	uint32_t		vdb_len;
13662c2961f8Sjose borrego 	struct uio 		vdb_uio;
13672c2961f8Sjose borrego 	struct iovec		vdb_iovec[MAX_IOVEC];
1368faa1795aSjb } smb_vdb_t;
1369faa1795aSjb 
1370f96bd5c8SAlan Wright #define	SMB_WRMODE_WRITE_THRU	0x0001
1371f96bd5c8SAlan Wright #define	SMB_WRMODE_IS_STABLE(M)	((M) & SMB_WRMODE_WRITE_THRU)
1372f96bd5c8SAlan Wright 
1373faa1795aSjb #define	SMB_RW_MAGIC		0x52445257	/* 'RDRW' */
1374faa1795aSjb 
1375faa1795aSjb typedef struct smb_rw_param {
1376faa1795aSjb 	uint32_t rw_magic;
1377faa1795aSjb 	smb_vdb_t rw_vdb;
1378faa1795aSjb 	uint64_t rw_offset;
1379faa1795aSjb 	uint32_t rw_last_write;
1380faa1795aSjb 	uint16_t rw_mode;
1381f96bd5c8SAlan Wright 	uint32_t rw_count;		/* bytes in this request */
1382faa1795aSjb 	uint16_t rw_mincnt;
1383f96bd5c8SAlan Wright 	uint32_t rw_total;		/* total bytes (write-raw) */
1384faa1795aSjb 	uint16_t rw_dsoff;		/* SMB data offset */
1385faa1795aSjb 	uint8_t rw_andx;		/* SMB secondary andx command */
1386faa1795aSjb } smb_rw_param_t;
1387da6c28aaSamw 
1388eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_pathname {
1389eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_path;
1390eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_pname;
1391eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_fname;
1392eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_sname;
1393eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char	*pn_stype;
1394eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States } smb_pathname_t;
1395eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 
1396b89a8333Snatalie li - Sun Microsystems - Irvine United States /*
1397b89a8333Snatalie li - Sun Microsystems - Irvine United States  * fs_query_info
1398b89a8333Snatalie li - Sun Microsystems - Irvine United States  */
1399b89a8333Snatalie li - Sun Microsystems - Irvine United States typedef struct smb_fqi {
1400eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_pathname_t	fq_path;
1401eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	uint16_t	fq_sattr;
1402eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_node_t	*fq_dnode;
1403eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_node_t	*fq_fnode;
1404eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	smb_attr_t	fq_fattr;
1405eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 	char		fq_last_comp[MAXNAMELEN];
1406b89a8333Snatalie li - Sun Microsystems - Irvine United States } smb_fqi_t;
1407da6c28aaSamw 
1408148c5f43SAlan Wright typedef struct dirop {
1409148c5f43SAlan Wright 	smb_fqi_t	fqi;
1410148c5f43SAlan Wright 	smb_fqi_t	dst_fqi;
1411148c5f43SAlan Wright 	uint16_t	info_level;
1412148c5f43SAlan Wright 	uint16_t	flags;
1413148c5f43SAlan Wright } smb_arg_dirop_t;
1414148c5f43SAlan Wright 
14157b59d02dSjb typedef struct {
14167b59d02dSjb 	uint32_t status;
14177b59d02dSjb 	uint16_t errcls;
14187b59d02dSjb 	uint16_t errcode;
14197b59d02dSjb } smb_error_t;
1420da6c28aaSamw 
14212c2961f8Sjose borrego typedef struct open_param {
14222c2961f8Sjose borrego 	smb_fqi_t	fqi;
14232c2961f8Sjose borrego 	uint16_t	omode;
14242c2961f8Sjose borrego 	uint16_t	ofun;
14252c2961f8Sjose borrego 	uint32_t	nt_flags;
14262c2961f8Sjose borrego 	uint32_t	timeo;
14272c2961f8Sjose borrego 	uint32_t	dattr;
14282c2961f8Sjose borrego 	timestruc_t	crtime;
14292c2961f8Sjose borrego 	timestruc_t	mtime;
14302c2961f8Sjose borrego 	uint64_t	dsize;
14312c2961f8Sjose borrego 	uint32_t	desired_access;
14322c2961f8Sjose borrego 	uint32_t	share_access;
14332c2961f8Sjose borrego 	uint32_t	create_options;
14342c2961f8Sjose borrego 	uint32_t	create_disposition;
14352c2961f8Sjose borrego 	boolean_t	created_readonly;
14362c2961f8Sjose borrego 	uint32_t	ftype;
14372c2961f8Sjose borrego 	uint32_t	devstate;
14382c2961f8Sjose borrego 	uint32_t	action_taken;
14392c2961f8Sjose borrego 	uint64_t	fileid;
14402c2961f8Sjose borrego 	uint32_t	rootdirfid;
1441bbf6f00cSJordan Brown 	smb_ofile_t	*dir;
14422c2961f8Sjose borrego 	/* This is only set by NTTransactCreate */
14432c2961f8Sjose borrego 	struct smb_sd	*sd;
1444cb174861Sjoyce mcintosh 	uint8_t		op_oplock_level;	/* requested/granted level */
1445cb174861Sjoyce mcintosh 	boolean_t	op_oplock_levelII;	/* TRUE if levelII supported */
1446148c5f43SAlan Wright } smb_arg_open_t;
14472c2961f8Sjose borrego 
1448da6c28aaSamw /*
1449da6c28aaSamw  * SMB Request State Machine
1450da6c28aaSamw  * -------------------------
1451da6c28aaSamw  *
1452da6c28aaSamw  *                  T4               +------+		T0
1453da6c28aaSamw  *      +--------------------------->| FREE |---------------------------+
1454da6c28aaSamw  *      |                            +------+                           |
1455da6c28aaSamw  * +-----------+                                                        |
1456da6c28aaSamw  * | COMPLETED |                                                        |
1457da6c28aaSamw  * +-----------+
1458da6c28aaSamw  *      ^                                                               |
1459da6c28aaSamw  *      | T15                      +----------+                         v
1460da6c28aaSamw  * +------------+        T6        |          |                 +--------------+
1461da6c28aaSamw  * | CLEANED_UP |<-----------------| CANCELED |                 | INITIALIZING |
1462da6c28aaSamw  * +------------+                  |          |                 +--------------+
1463da6c28aaSamw  *      |    ^                     +----------+                         |
1464da6c28aaSamw  *      |    |                        ^  ^ ^ ^                          |
1465da6c28aaSamw  *      |    |          +-------------+  | | |                          |
1466da6c28aaSamw  *      |    |    T3    |                | | |               T13        | T1
1467da6c28aaSamw  *      |    +-------------------------+ | | +----------------------+   |
1468da6c28aaSamw  *      +----------------------------+ | | |                        |   |
1469da6c28aaSamw  *         T16          |            | | | +-----------+            |   |
1470da6c28aaSamw  *                      |           \/ | | T5          |            |   v
1471da6c28aaSamw  * +-----------------+  |   T12     +--------+         |     T2    +-----------+
1472da6c28aaSamw  * | EVENT_OCCURRED  |------------->| ACTIVE |<--------------------| SUBMITTED |
1473da6c28aaSamw  * +-----------------+  |           +--------+         |           +-----------+
1474da6c28aaSamw  *        ^             |              | ^ |           |
1475da6c28aaSamw  *        |             |           T8 | | |  T7       |
1476da6c28aaSamw  *        | T10      T9 |   +----------+ | +-------+   |  T11
1477da6c28aaSamw  *        |             |   |            +-------+ |   |
1478da6c28aaSamw  *        |             |   |               T14  | |   |
1479da6c28aaSamw  *        |             |   v                    | v   |
1480da6c28aaSamw  *      +----------------------+                +--------------+
1481da6c28aaSamw  *	|     WAITING_EVENT    |                | WAITING_LOCK |
1482da6c28aaSamw  *      +----------------------+                +--------------+
1483da6c28aaSamw  *
1484da6c28aaSamw  *
1485da6c28aaSamw  *
1486da6c28aaSamw  *
1487da6c28aaSamw  *
1488da6c28aaSamw  * Transition T0
1489da6c28aaSamw  *
1490da6c28aaSamw  * This transition occurs when the request is allocated and is still under the
1491da6c28aaSamw  * control of the session thread.
1492da6c28aaSamw  *
1493da6c28aaSamw  * Transition T1
1494da6c28aaSamw  *
1495da6c28aaSamw  * This transition occurs when the session thread dispatches a task to treat the
1496da6c28aaSamw  * request.
1497da6c28aaSamw  *
1498da6c28aaSamw  * Transition T2
1499da6c28aaSamw  *
1500da6c28aaSamw  *
1501da6c28aaSamw  *
1502da6c28aaSamw  * Transition T3
1503da6c28aaSamw  *
1504da6c28aaSamw  * A request completes and smbsr_cleanup is called to release resources
1505da6c28aaSamw  * associated with the request (but not the smb_request_t itself).  This
1506da6c28aaSamw  * includes references on smb_ofile_t, smb_node_t, and other structures.
1507da6c28aaSamw  * CLEANED_UP state exists to detect if we attempt to cleanup a request
1508da6c28aaSamw  * multiple times and to allow us to detect that we are accessing a
1509da6c28aaSamw  * request that has already been cleaned up.
1510da6c28aaSamw  *
1511da6c28aaSamw  * Transition T4
1512da6c28aaSamw  *
1513da6c28aaSamw  *
1514da6c28aaSamw  *
1515da6c28aaSamw  * Transition T5
1516da6c28aaSamw  *
1517da6c28aaSamw  *
1518da6c28aaSamw  *
1519da6c28aaSamw  * Transition T6
1520da6c28aaSamw  *
1521da6c28aaSamw  *
1522da6c28aaSamw  *
1523da6c28aaSamw  * Transition T7
1524da6c28aaSamw  *
1525da6c28aaSamw  *
1526da6c28aaSamw  *
1527da6c28aaSamw  * Transition T8
1528da6c28aaSamw  *
1529da6c28aaSamw  *
1530da6c28aaSamw  *
1531da6c28aaSamw  * Transition T9
1532da6c28aaSamw  *
1533da6c28aaSamw  *
1534da6c28aaSamw  *
1535da6c28aaSamw  * Transition T10
1536da6c28aaSamw  *
1537da6c28aaSamw  *
1538da6c28aaSamw  *
1539da6c28aaSamw  * Transition T11
1540da6c28aaSamw  *
1541da6c28aaSamw  *
1542da6c28aaSamw  *
1543da6c28aaSamw  * Transition T12
1544da6c28aaSamw  *
1545da6c28aaSamw  *
1546da6c28aaSamw  *
1547da6c28aaSamw  * Transition T13
1548da6c28aaSamw  *
1549da6c28aaSamw  *
1550da6c28aaSamw  *
1551da6c28aaSamw  * Transition T14
1552da6c28aaSamw  *
1553da6c28aaSamw  *
1554da6c28aaSamw  *
1555da6c28aaSamw  * Transition T15
1556da6c28aaSamw  *
1557da6c28aaSamw  * Request processing is completed (control returns from smb_dispatch)
1558da6c28aaSamw  *
1559da6c28aaSamw  * Transition T16
1560da6c28aaSamw  *
1561da6c28aaSamw  * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx"
1562da6c28aaSamw  * sections remain to be processed.
1563da6c28aaSamw  *
1564da6c28aaSamw  */
1565da6c28aaSamw 
1566da6c28aaSamw #define	SMB_REQ_MAGIC 		0x534D4252	/* 'SMBR' */
15672c2961f8Sjose borrego #define	SMB_REQ_VALID(p)	ASSERT((p)->sr_magic == SMB_REQ_MAGIC)
1568da6c28aaSamw 
1569da6c28aaSamw typedef enum smb_req_state {
1570da6c28aaSamw 	SMB_REQ_STATE_FREE = 0,
1571da6c28aaSamw 	SMB_REQ_STATE_INITIALIZING,
1572da6c28aaSamw 	SMB_REQ_STATE_SUBMITTED,
1573da6c28aaSamw 	SMB_REQ_STATE_ACTIVE,
1574da6c28aaSamw 	SMB_REQ_STATE_WAITING_EVENT,
1575da6c28aaSamw 	SMB_REQ_STATE_EVENT_OCCURRED,
1576da6c28aaSamw 	SMB_REQ_STATE_WAITING_LOCK,
1577da6c28aaSamw 	SMB_REQ_STATE_COMPLETED,
1578da6c28aaSamw 	SMB_REQ_STATE_CANCELED,
15796537f381Sas 	SMB_REQ_STATE_CLEANED_UP,
15806537f381Sas 	SMB_REQ_STATE_SENTINEL
1581da6c28aaSamw } smb_req_state_t;
1582da6c28aaSamw 
1583faa1795aSjb typedef struct smb_request {
1584da6c28aaSamw 	uint32_t		sr_magic;
1585da6c28aaSamw 	kmutex_t		sr_mutex;
1586da6c28aaSamw 	list_node_t		sr_session_lnd;
1587da6c28aaSamw 	smb_req_state_t		sr_state;
1588faa1795aSjb 	struct smb_server	*sr_server;
15896537f381Sas 	pid_t			*sr_pid;
1590c8ec8eeaSjose borrego 	int32_t			sr_gmtoff;
1591faa1795aSjb 	smb_session_t		*session;
1592faa1795aSjb 	smb_kmod_cfg_t		*sr_cfg;
1593da6c28aaSamw 	smb_notify_change_req_t	sr_ncr;
1594da6c28aaSamw 
1595da6c28aaSamw 	/* Info from session service header */
1596da6c28aaSamw 	uint32_t		sr_req_length; /* Excluding NBT header */
1597da6c28aaSamw 
1598da6c28aaSamw 	/* Request buffer excluding NBT header */
1599da6c28aaSamw 	void			*sr_request_buf;
1600da6c28aaSamw 
1601da6c28aaSamw 	smb_lock_t		*sr_awaiting;
1602da6c28aaSamw 	struct mbuf_chain	command;
1603da6c28aaSamw 	struct mbuf_chain	reply;
1604da6c28aaSamw 	struct mbuf_chain	raw_data;
1605bbf6f00cSJordan Brown 	list_t			sr_storage;
1606da6c28aaSamw 	struct smb_xa		*r_xa;
1607da6c28aaSamw 	int			andx_prev_wct;
1608da6c28aaSamw 	int 			cur_reply_offset;
1609da6c28aaSamw 	int			orig_request_hdr;
1610da6c28aaSamw 	unsigned int		reply_seqnum;	/* reply sequence number */
1611da6c28aaSamw 	unsigned char		first_smb_com;	/* command code */
1612da6c28aaSamw 	unsigned char		smb_com;	/* command code */
16137b59d02dSjb 
16147b59d02dSjb 	uint8_t			smb_rcls;	/* error code class */
16157b59d02dSjb 	uint8_t			smb_reh;	/* rsvd (AH DOS INT-24 ERR) */
1616da6c28aaSamw 	uint16_t		smb_err;	/* error code */
16177b59d02dSjb 	smb_error_t		smb_error;
16187b59d02dSjb 
1619da6c28aaSamw 	uint8_t			smb_flg;	/* flags */
1620da6c28aaSamw 	uint16_t		smb_flg2;	/* flags */
1621da6c28aaSamw 	uint16_t		smb_pid_high;	/* high part of pid */
1622da6c28aaSamw 	unsigned char		smb_sig[8];	/* signiture */
1623da6c28aaSamw 	uint16_t		smb_tid;	/* tree id #  */
1624da6c28aaSamw 	uint16_t		smb_pid;	/* caller's process id # */
1625da6c28aaSamw 	uint16_t		smb_uid;	/* user id # */
1626da6c28aaSamw 	uint16_t		smb_mid;	/* mutiplex id #  */
1627da6c28aaSamw 	unsigned char		smb_wct;	/* count of parameter words */
1628da6c28aaSamw 	uint16_t		smb_bcc;	/* data byte count */
1629da6c28aaSamw 
1630da6c28aaSamw 	/* Parameters */
1631da6c28aaSamw 	struct mbuf_chain	smb_vwv;	/* variable width value */
1632da6c28aaSamw 
1633da6c28aaSamw 	/* Data */
1634da6c28aaSamw 	struct mbuf_chain	smb_data;
1635da6c28aaSamw 
1636da6c28aaSamw 	uint16_t		smb_fid;	/* not in hdr, but common */
1637da6c28aaSamw 
1638da6c28aaSamw 	unsigned char		andx_com;
1639da6c28aaSamw 	uint16_t		andx_off;
1640da6c28aaSamw 
1641da6c28aaSamw 	struct smb_tree		*tid_tree;
1642da6c28aaSamw 	struct smb_ofile	*fid_ofile;
1643da6c28aaSamw 	smb_user_t		*uid_user;
1644da6c28aaSamw 
1645da6c28aaSamw 	union {
1646148c5f43SAlan Wright 		smb_arg_negotiate_t	*negprot;
1647148c5f43SAlan Wright 		smb_arg_sessionsetup_t	*ssetup;
1648148c5f43SAlan Wright 		smb_arg_tcon_t		tcon;
1649148c5f43SAlan Wright 		smb_arg_dirop_t		dirop;
1650148c5f43SAlan Wright 		smb_arg_open_t		open;
1651148c5f43SAlan Wright 		smb_rw_param_t		*rw;
16525fd03bc0SGordon Ross 		int32_t			timestamp;
1653da6c28aaSamw 	} arg;
1654da6c28aaSamw 
1655da6c28aaSamw 	cred_t			*user_cr;
16562c2961f8Sjose borrego 	kthread_t		*sr_worker;
1657148c5f43SAlan Wright 	hrtime_t		sr_time_submitted;
1658148c5f43SAlan Wright 	hrtime_t		sr_time_active;
1659148c5f43SAlan Wright 	hrtime_t		sr_time_start;
1660148c5f43SAlan Wright 	int32_t			sr_txb;
1661148c5f43SAlan Wright 	uint32_t		sr_seqnum;
1662faa1795aSjb } smb_request_t;
1663da6c28aaSamw 
1664148c5f43SAlan Wright #define	sr_ssetup	arg.ssetup
1665148c5f43SAlan Wright #define	sr_negprot	arg.negprot
1666148c5f43SAlan Wright #define	sr_tcon		arg.tcon
1667148c5f43SAlan Wright #define	sr_dirop	arg.dirop
1668148c5f43SAlan Wright #define	sr_open		arg.open
1669148c5f43SAlan Wright #define	sr_rw		arg.rw
1670148c5f43SAlan Wright #define	sr_timestamp	arg.timestamp
1671148c5f43SAlan Wright 
1672bbf6f00cSJordan Brown #define	SMB_READ_PROTOCOL(hdr) \
1673bbf6f00cSJordan Brown 	LE_IN32(((smb_hdr_t *)(hdr))->protocol)
1674da6c28aaSamw 
1675da6c28aaSamw #define	SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \
1676da6c28aaSamw 	(SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC)
1677da6c28aaSamw 
1678bbf6f00cSJordan Brown #define	SMB_READ_COMMAND(hdr) \
1679bbf6f00cSJordan Brown 	(((smb_hdr_t *)(hdr))->command)
1680da6c28aaSamw 
1681148c5f43SAlan Wright #define	SMB_IS_NT_CANCEL(rd_sr) \
1682148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NT_CANCEL)
1683148c5f43SAlan Wright 
1684148c5f43SAlan Wright #define	SMB_IS_SESSION_SETUP_ANDX(rd_sr) \
1685148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == \
1686148c5f43SAlan Wright 	    SMB_COM_SESSION_SETUP_ANDX)
1687148c5f43SAlan Wright 
1688148c5f43SAlan Wright #define	SMB_IS_NT_NEGOTIATE(rd_sr) \
1689148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NEGOTIATE)
1690148c5f43SAlan Wright 
1691148c5f43SAlan Wright #define	SMB_IS_TREE_CONNECT_ANDX(rd_sr) \
1692148c5f43SAlan Wright 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_TREE_CONNECT_ANDX)
1693da6c28aaSamw 
1694da6c28aaSamw #define	SMB_XA_FLAG_OPEN	0x0001
1695da6c28aaSamw #define	SMB_XA_FLAG_CLOSE	0x0002
1696da6c28aaSamw #define	SMB_XA_FLAG_COMPLETE	0x0004
1697da6c28aaSamw #define	SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN))
1698da6c28aaSamw 
1699da6c28aaSamw #define	SMB_XA_MAGIC		0x534D4258	/* 'SMBX' */
1700da6c28aaSamw 
1701da6c28aaSamw typedef struct smb_xa {
1702da6c28aaSamw 	uint32_t		xa_magic;
1703da6c28aaSamw 	kmutex_t		xa_mutex;
1704da6c28aaSamw 	list_node_t		xa_lnd;
1705da6c28aaSamw 
1706da6c28aaSamw 	uint32_t		xa_refcnt;
1707da6c28aaSamw 	uint32_t		xa_flags;
1708da6c28aaSamw 
1709da6c28aaSamw 	struct smb_session	*xa_session;
1710da6c28aaSamw 
1711da6c28aaSamw 	unsigned char		smb_com;	/* which TRANS type */
1712da6c28aaSamw 	unsigned char		smb_flg;	/* flags */
1713da6c28aaSamw 	uint16_t		smb_flg2;	/* flags */
1714da6c28aaSamw 	uint16_t		smb_tid;	/* tree id number */
1715da6c28aaSamw 	uint16_t		smb_pid;	/* caller's process id number */
1716da6c28aaSamw 	uint16_t		smb_uid;	/* user id number */
1717da6c28aaSamw 	uint32_t		smb_func;	/* NT_TRANS function */
1718da6c28aaSamw 
1719da6c28aaSamw 	uint16_t		xa_smb_mid;	/* mutiplex id number */
1720da6c28aaSamw 	uint16_t		xa_smb_fid;	/* TRANS2 secondary */
1721da6c28aaSamw 
1722da6c28aaSamw 	unsigned int		reply_seqnum;	/* reply sequence number */
1723da6c28aaSamw 
1724da6c28aaSamw 	uint32_t	smb_tpscnt;	/* total parameter bytes being sent */
1725da6c28aaSamw 	uint32_t	smb_tdscnt;	/* total data bytes being sent */
1726da6c28aaSamw 	uint32_t	smb_mprcnt;	/* max parameter bytes to return */
1727da6c28aaSamw 	uint32_t	smb_mdrcnt;	/* max data bytes to return */
1728da6c28aaSamw 	uint32_t	smb_msrcnt;	/* max setup words to return */
1729da6c28aaSamw 	uint32_t	smb_flags;	/* additional information: */
1730da6c28aaSamw 				/*  bit 0 - if set, disconnect TID in smb_tid */
1731da6c28aaSamw 				/*  bit 1 - if set, transaction is one way */
1732da6c28aaSamw 				/*  (no final response) */
1733da6c28aaSamw 	int32_t	smb_timeout;	/* number of milliseconds to await completion */
1734da6c28aaSamw 	uint32_t	smb_suwcnt;	/* set up word count */
1735da6c28aaSamw 
1736bbf6f00cSJordan Brown 	char			*xa_pipe_name;
1737da6c28aaSamw 
17387f3ef643SGordon Ross 	/*
17397f3ef643SGordon Ross 	 * These are the param and data count received so far,
17407f3ef643SGordon Ross 	 * used to decide if the whole trans is here yet.
17417f3ef643SGordon Ross 	 */
1742da6c28aaSamw 	int			req_disp_param;
1743da6c28aaSamw 	int			req_disp_data;
1744da6c28aaSamw 
1745da6c28aaSamw 	struct mbuf_chain	req_setup_mb;
1746da6c28aaSamw 	struct mbuf_chain	req_param_mb;
1747da6c28aaSamw 	struct mbuf_chain	req_data_mb;
1748da6c28aaSamw 
1749da6c28aaSamw 	struct mbuf_chain	rep_setup_mb;
1750da6c28aaSamw 	struct mbuf_chain	rep_param_mb;
1751da6c28aaSamw 	struct mbuf_chain	rep_data_mb;
1752da6c28aaSamw } smb_xa_t;
1753da6c28aaSamw 
1754da6c28aaSamw 
1755da6c28aaSamw #define	SDDF_NO_FLAGS			0
1756da6c28aaSamw #define	SDDF_SUPPRESS_TID		0x0001
1757da6c28aaSamw #define	SDDF_SUPPRESS_UID		0x0002
1758da6c28aaSamw 
17597b59d02dSjb /*
17607b59d02dSjb  * SMB dispatch return codes.
17617b59d02dSjb  */
17627b59d02dSjb typedef enum {
1763faa1795aSjb 	SDRC_SUCCESS = 0,
1764faa1795aSjb 	SDRC_ERROR,
17657b59d02dSjb 	SDRC_DROP_VC,
17667b59d02dSjb 	SDRC_NO_REPLY,
176759229f98Sjose borrego 	SDRC_SR_KEPT,
1768faa1795aSjb 	SDRC_NOT_IMPLEMENTED
17697b59d02dSjb } smb_sdrc_t;
1770da6c28aaSamw 
1771da6c28aaSamw #define	VAR_BCC		((short)-1)
1772da6c28aaSamw 
1773faa1795aSjb #define	SMB_SERVER_MAGIC	0x53534552	/* 'SSER' */
17749fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_SERVER_VALID(s)	\
17759fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((s) != NULL) && ((s)->sv_magic == SMB_SERVER_MAGIC))
1776da6c28aaSamw 
17774163af6aSjose borrego #define	SMB_LISTENER_MAGIC	0x4C53544E	/* 'LSTN' */
17784163af6aSjose borrego #define	SMB_LISTENER_VALID(ld)	\
17794163af6aSjose borrego     ASSERT(((ld) != NULL) && ((ld)->ld_magic == SMB_LISTENER_MAGIC))
17804163af6aSjose borrego 
1781faa1795aSjb typedef struct {
17824163af6aSjose borrego 	uint32_t		ld_magic;
17834163af6aSjose borrego 	struct smb_server	*ld_sv;
17844163af6aSjose borrego 	smb_thread_t		ld_thread;
17850f1702c5SYu Xiangning 	ksocket_t		ld_so;
17864163af6aSjose borrego 	in_port_t		ld_port;
17874163af6aSjose borrego 	int			ld_family;
1788faa1795aSjb 	struct sockaddr_in	ld_sin;
17897f667e74Sjose borrego 	struct sockaddr_in6	ld_sin6;
17904163af6aSjose borrego 	smb_llist_t		ld_session_list;
1791faa1795aSjb } smb_listener_daemon_t;
1792faa1795aSjb 
1793cb174861Sjoyce mcintosh #define	SMB_SSETUP_CMD			"authentication"
1794cb174861Sjoyce mcintosh #define	SMB_TCON_CMD			"share mapping"
1795cb174861Sjoyce mcintosh #define	SMB_OPIPE_CMD			"pipe open"
1796cb174861Sjoyce mcintosh #define	SMB_THRESHOLD_REPORT_THROTTLE	50
1797cb174861Sjoyce mcintosh typedef struct smb_cmd_threshold {
1798cb174861Sjoyce mcintosh 	char			*ct_cmd;
1799cb174861Sjoyce mcintosh 	kmutex_t		ct_mutex;
1800cb174861Sjoyce mcintosh 	volatile uint32_t	ct_active_cnt;
1801cb174861Sjoyce mcintosh 	volatile uint32_t	ct_blocked_cnt;
1802cb174861Sjoyce mcintosh 	uint32_t		ct_threshold;
1803856399cfSGordon Ross 	uint32_t		ct_timeout; /* milliseconds */
1804856399cfSGordon Ross 	kcondvar_t		ct_cond;
1805cb174861Sjoyce mcintosh } smb_cmd_threshold_t;
1806cb174861Sjoyce mcintosh 
1807cb174861Sjoyce mcintosh typedef struct {
1808cb174861Sjoyce mcintosh 	kstat_named_t		ls_files;
1809cb174861Sjoyce mcintosh 	kstat_named_t		ls_trees;
1810cb174861Sjoyce mcintosh 	kstat_named_t		ls_users;
1811cb174861Sjoyce mcintosh } smb_server_legacy_kstat_t;
1812cb174861Sjoyce mcintosh 
1813faa1795aSjb typedef enum smb_server_state {
1814faa1795aSjb 	SMB_SERVER_STATE_CREATED = 0,
1815faa1795aSjb 	SMB_SERVER_STATE_CONFIGURED,
1816faa1795aSjb 	SMB_SERVER_STATE_RUNNING,
18179fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	SMB_SERVER_STATE_STOPPING,
18186537f381Sas 	SMB_SERVER_STATE_DELETING,
18196537f381Sas 	SMB_SERVER_STATE_SENTINEL
1820faa1795aSjb } smb_server_state_t;
1821faa1795aSjb 
1822cb174861Sjoyce mcintosh typedef struct {
182323a9c295SGordon Ross 	/* protected by sv_mutex */
1824cb174861Sjoyce mcintosh 	kcondvar_t		sp_cv;
1825cb174861Sjoyce mcintosh 	uint32_t 		sp_cnt;
1826cb174861Sjoyce mcintosh 	smb_llist_t		sp_list;
1827cb174861Sjoyce mcintosh 	smb_llist_t		sp_fidlist;
1828cb174861Sjoyce mcintosh } smb_spool_t;
1829cb174861Sjoyce mcintosh 
1830148c5f43SAlan Wright #define	SMB_SERVER_STATE_VALID(S)               \
1831148c5f43SAlan Wright     ASSERT(((S) == SMB_SERVER_STATE_CREATED) || \
1832148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_CONFIGURED) || \
1833148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_RUNNING) ||    \
1834148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_STOPPING) ||   \
1835148c5f43SAlan Wright 	    ((S) == SMB_SERVER_STATE_DELETING))
18369fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
1837faa1795aSjb typedef struct smb_server {
1838faa1795aSjb 	uint32_t		sv_magic;
1839faa1795aSjb 	kcondvar_t		sv_cv;
1840faa1795aSjb 	kmutex_t		sv_mutex;
1841faa1795aSjb 	list_node_t		sv_lnd;
1842faa1795aSjb 	smb_server_state_t	sv_state;
1843faa1795aSjb 	uint32_t		sv_refcnt;
18446537f381Sas 	pid_t			sv_pid;
1845faa1795aSjb 	zoneid_t		sv_zid;
1846faa1795aSjb 	smb_listener_daemon_t	sv_nbt_daemon;
1847faa1795aSjb 	smb_listener_daemon_t	sv_tcp_daemon;
1848faa1795aSjb 	krwlock_t		sv_cfg_lock;
1849faa1795aSjb 	smb_kmod_cfg_t		sv_cfg;
1850faa1795aSjb 	smb_session_t		*sv_session;
1851da6c28aaSamw 
18528622ec45SGordon Ross 	struct smb_export	sv_export;
1853*b819cea2SGordon Ross 	struct __door_handle	*sv_lmshrd;
1854da6c28aaSamw 
18558622ec45SGordon Ross 	/* Internal door for up-calls to smbd */
1856*b819cea2SGordon Ross 	struct __door_handle	*sv_kdoor_hd;
18578622ec45SGordon Ross 	int			sv_kdoor_id; /* init -1 */
18588622ec45SGordon Ross 	uint64_t		sv_kdoor_ncall;
18598622ec45SGordon Ross 	kmutex_t		sv_kdoor_mutex;
18608622ec45SGordon Ross 	kcondvar_t		sv_kdoor_cv;
18618622ec45SGordon Ross 
18628622ec45SGordon Ross 	/* RPC pipes (client side) */
1863*b819cea2SGordon Ross 	struct __door_handle	*sv_opipe_door_hd;
18648622ec45SGordon Ross 	int			sv_opipe_door_id;
18658622ec45SGordon Ross 	uint64_t		sv_opipe_door_ncall;
18668622ec45SGordon Ross 	kmutex_t		sv_opipe_door_mutex;
18678622ec45SGordon Ross 	kcondvar_t		sv_opipe_door_cv;
18688622ec45SGordon Ross 
1869c8ec8eeaSjose borrego 	int32_t			si_gmtoff;
1870da6c28aaSamw 
1871da6c28aaSamw 	smb_thread_t		si_thread_timers;
1872da6c28aaSamw 
18734163af6aSjose borrego 	taskq_t			*sv_worker_pool;
18744163af6aSjose borrego 	taskq_t			*sv_receiver_pool;
1875da6c28aaSamw 
1876da6c28aaSamw 	smb_node_t		*si_root_smb_node;
18779fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_llist_t		sv_opipe_list;
18789fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	smb_llist_t		sv_event_list;
1879148c5f43SAlan Wright 
1880148c5f43SAlan Wright 	/* Statistics */
1881148c5f43SAlan Wright 	hrtime_t		sv_start_time;
1882148c5f43SAlan Wright 	kstat_t			*sv_ksp;
1883148c5f43SAlan Wright 	volatile uint32_t	sv_nbt_sess;
1884148c5f43SAlan Wright 	volatile uint32_t	sv_tcp_sess;
1885148c5f43SAlan Wright 	volatile uint32_t	sv_users;
1886148c5f43SAlan Wright 	volatile uint32_t	sv_trees;
1887148c5f43SAlan Wright 	volatile uint32_t	sv_files;
1888148c5f43SAlan Wright 	volatile uint32_t	sv_pipes;
1889148c5f43SAlan Wright 	volatile uint64_t	sv_txb;
1890148c5f43SAlan Wright 	volatile uint64_t	sv_rxb;
1891148c5f43SAlan Wright 	volatile uint64_t	sv_nreq;
1892148c5f43SAlan Wright 	smb_srqueue_t		sv_srqueue;
1893cb174861Sjoyce mcintosh 	smb_spool_t		sp_info;
1894cb174861Sjoyce mcintosh 	smb_cmd_threshold_t	sv_ssetup_ct;
1895cb174861Sjoyce mcintosh 	smb_cmd_threshold_t	sv_tcon_ct;
1896cb174861Sjoyce mcintosh 	smb_cmd_threshold_t	sv_opipe_ct;
1897cb174861Sjoyce mcintosh 	kstat_t			*sv_legacy_ksp;
1898cb174861Sjoyce mcintosh 	kmutex_t		sv_legacy_ksmtx;
18998622ec45SGordon Ross 	smb_disp_stats_t	*sv_disp_stats;
1900faa1795aSjb } smb_server_t;
1901da6c28aaSamw 
19029fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_EVENT_MAGIC		0x45564E54	/* EVNT */
1903cb174861Sjoyce mcintosh #define	SMB_EVENT_TIMEOUT	45		/* seconds */
19049fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SMB_EVENT_VALID(e)	\
19059fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States     ASSERT(((e) != NULL) && ((e)->se_magic == SMB_EVENT_MAGIC))
19069fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_event {
19079fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		se_magic;
19089fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	list_node_t		se_lnd;
19099fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kmutex_t		se_mutex;
19109fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	kcondvar_t		se_cv;
1911cb174861Sjoyce mcintosh 	smb_server_t		*se_server;
19129fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	uint32_t		se_txid;
19139fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	boolean_t		se_notified;
19149fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	int			se_waittime;
1915cb174861Sjoyce mcintosh 	int			se_timeout;
19169fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 	int			se_errno;
19179fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States } smb_event_t;
19189fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 
1919cb174861Sjoyce mcintosh typedef struct smb_kspooldoc {
1920cb174861Sjoyce mcintosh 	uint32_t	sd_magic;
1921cb174861Sjoyce mcintosh 	list_node_t	sd_lnd;
1922cb174861Sjoyce mcintosh 	smb_inaddr_t	sd_ipaddr;
1923cb174861Sjoyce mcintosh 	uint32_t	sd_spool_num;
1924cb174861Sjoyce mcintosh 	uint16_t	sd_fid;
1925cb174861Sjoyce mcintosh 	char		sd_username[MAXNAMELEN];
1926cb174861Sjoyce mcintosh 	char		sd_path[MAXPATHLEN];
1927cb174861Sjoyce mcintosh } smb_kspooldoc_t;
1928cb174861Sjoyce mcintosh 
1929cb174861Sjoyce mcintosh typedef struct smb_spoolfid {
1930cb174861Sjoyce mcintosh 	uint32_t	sf_magic;
1931cb174861Sjoyce mcintosh 	list_node_t	sf_lnd;
1932cb174861Sjoyce mcintosh 	uint16_t	sf_fid;
1933cb174861Sjoyce mcintosh } smb_spoolfid_t;
1934cb174861Sjoyce mcintosh 
1935da6c28aaSamw #define	SMB_INFO_NETBIOS_SESSION_SVC_RUNNING	0x0001
1936da6c28aaSamw #define	SMB_INFO_NETBIOS_SESSION_SVC_FAILED	0x0002
1937da6c28aaSamw #define	SMB_INFO_USER_LEVEL_SECURITY		0x40000000
1938da6c28aaSamw #define	SMB_INFO_ENCRYPT_PASSWORDS		0x80000000
1939da6c28aaSamw 
19401fcced4cSJordan Brown #define	SMB_IS_STREAM(node) ((node)->n_unode)
1941da6c28aaSamw 
1942da6c28aaSamw typedef struct smb_tsd {
1943da6c28aaSamw 	void (*proc)();
1944da6c28aaSamw 	void *arg;
1945da6c28aaSamw 	char name[100];
1946da6c28aaSamw } smb_tsd_t;
1947da6c28aaSamw 
19482c2961f8Sjose borrego typedef struct smb_disp_entry {
1949148c5f43SAlan Wright 	char		sdt_name[KSTAT_STRLEN];
1950148c5f43SAlan Wright 	smb_sdrc_t	(*sdt_pre_op)(smb_request_t *);
1951148c5f43SAlan Wright 	smb_sdrc_t	(*sdt_function)(smb_request_t *);
1952148c5f43SAlan Wright 	void		(*sdt_post_op)(smb_request_t *);
1953148c5f43SAlan Wright 	uint8_t		sdt_com;
1954148c5f43SAlan Wright 	char		sdt_dialect;
1955148c5f43SAlan Wright 	uint8_t		sdt_flags;
19562c2961f8Sjose borrego } smb_disp_entry_t;
1957da6c28aaSamw 
1958148c5f43SAlan Wright typedef struct smb_xlate {
1959148c5f43SAlan Wright 	int	code;
1960148c5f43SAlan Wright 	char	*str;
1961148c5f43SAlan Wright } smb_xlate_t;
1962148c5f43SAlan Wright 
1963148c5f43SAlan Wright /*
1964148c5f43SAlan Wright  * This structure is a helper for building RAP NetShareEnum response
1965148c5f43SAlan Wright  *
1966148c5f43SAlan Wright  * es_posix_uid UID of the user requesting the shares list which
1967148c5f43SAlan Wright  *              is used to detect if the user has any autohome
1968148c5f43SAlan Wright  * es_bufsize   size of the response buffer
1969148c5f43SAlan Wright  * es_buf       pointer to the response buffer
1970148c5f43SAlan Wright  * es_ntotal    total number of shares exported by server which
1971148c5f43SAlan Wright  *              their OEM names is less then 13 chars
1972148c5f43SAlan Wright  * es_nsent     number of shares that can fit in the specified buffer
1973148c5f43SAlan Wright  * es_datasize  actual data size (share's data) which was encoded
1974148c5f43SAlan Wright  *              in the response buffer
1975148c5f43SAlan Wright  */
1976148c5f43SAlan Wright typedef struct smb_enumshare_info {
1977148c5f43SAlan Wright 	uid_t		es_posix_uid;
1978148c5f43SAlan Wright 	uint16_t	es_bufsize;
1979148c5f43SAlan Wright 	char		*es_buf;
1980148c5f43SAlan Wright 	uint16_t	es_ntotal;
1981148c5f43SAlan Wright 	uint16_t	es_nsent;
1982148c5f43SAlan Wright 	uint16_t	es_datasize;
1983148c5f43SAlan Wright } smb_enumshare_info_t;
1984148c5f43SAlan Wright 
1985da6c28aaSamw #ifdef	__cplusplus
1986da6c28aaSamw }
1987da6c28aaSamw #endif
1988da6c28aaSamw 
1989faa1795aSjb #endif /* _SMBSRV_SMB_KTYPES_H */
1990