xref: /illumos-gate/usr/src/uts/common/smbsrv/smb_ktypes.h (revision 380bdfdf3b87cbfda20ccdf5d4fa7c129623622b)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
24  */
25 
26 /*
27  * Structures and type definitions for the SMB module.
28  */
29 
30 #ifndef _SMBSRV_SMB_KTYPES_H
31 #define	_SMBSRV_SMB_KTYPES_H
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 #include <sys/note.h>
38 #include <sys/systm.h>
39 #include <sys/param.h>
40 #include <sys/types.h>
41 #include <sys/synch.h>
42 #include <sys/taskq.h>
43 #include <sys/socket.h>
44 #include <sys/acl.h>
45 #include <sys/sdt.h>
46 #include <sys/stat.h>
47 #include <sys/vnode.h>
48 #include <sys/cred.h>
49 #include <netinet/in.h>
50 #include <sys/ksocket.h>
51 #include <sys/fem.h>
52 #include <sys/door.h>
53 #include <sys/extdirent.h>
54 #include <smbsrv/smb.h>
55 #include <smbsrv/smbinfo.h>
56 #include <smbsrv/mbuf.h>
57 #include <smbsrv/smb_sid.h>
58 #include <smbsrv/smb_xdr.h>
59 #include <smbsrv/netbios.h>
60 #include <smbsrv/smb_vops.h>
61 #include <smbsrv/smb_kstat.h>
62 
63 struct smb_disp_entry;
64 struct smb_request;
65 struct smb_server;
66 struct smb_event;
67 struct smb_export;
68 
69 /*
70  * Accumulated time and queue length statistics.
71  *
72  * Accumulated time statistics are kept as a running sum of "active" time.
73  * Queue length statistics are kept as a running sum of the product of queue
74  * length and elapsed time at that length -- i.e., a Riemann sum for queue
75  * length integrated against time.  (You can also think of the active time as a
76  * Riemann sum, for the boolean function (queue_length > 0) integrated against
77  * time, or you can think of it as the Lebesgue measure of the set on which
78  * queue_length > 0.)
79  *
80  *		^
81  *		|			_________
82  *		8			| i4	|
83  *		|			|	|
84  *	Queue	6			|	|
85  *	Length	|	_________	|	|
86  *		4	| i2	|_______|	|
87  *		|	|	    i3		|
88  *		2_______|			|
89  *		|    i1				|
90  *		|_______________________________|
91  *		Time->	t1	t2	t3	t4
92  *
93  * At each change of state (entry or exit from the queue), we add the elapsed
94  * time (since the previous state change) to the active time if the queue length
95  * was non-zero during that interval; and we add the product of the elapsed time
96  * times the queue length to the running length*time sum.
97  *
98  * This method is generalizable to measuring residency in any defined system:
99  * instead of queue lengths, think of "outstanding RPC calls to server X".
100  *
101  * A large number of I/O subsystems have at least two basic "lists" of
102  * transactions they manage: one for transactions that have been accepted for
103  * processing but for which processing has yet to begin, and one for
104  * transactions which are actively being processed (but not done). For this
105  * reason, two cumulative time statistics are defined here: wait (pre-service)
106  * time, and run (service) time.
107  *
108  * All times are 64-bit nanoseconds (hrtime_t), as returned by gethrtime().
109  *
110  * The units of cumulative busy time are accumulated nanoseconds. The units of
111  * cumulative length*time products are elapsed time times queue length.
112  *
113  * Updates to the fields below are performed implicitly by calls to
114  * these functions:
115  *
116  *	smb_srqueue_init()
117  *	smb_srqueue_destroy()
118  *	smb_srqueue_waitq_enter()
119  *	smb_srqueue_runq_exit()
120  *	smb_srqueue_waitq_to_runq()
121  *	smb_srqueue_update()
122  *
123  * These fields should never be updated by any other means.
124  */
125 typedef struct smb_srqueue {
126 	kmutex_t	srq_mutex;
127 	hrtime_t	srq_wlastupdate;
128 	hrtime_t	srq_wtime;
129 	hrtime_t	srq_wlentime;
130 	hrtime_t	srq_rlastupdate;
131 	hrtime_t	srq_rtime;
132 	hrtime_t	srq_rlentime;
133 	uint32_t	srq_wcnt;
134 	uint32_t	srq_rcnt;
135 } smb_srqueue_t;
136 
137 /*
138  * The fields with the prefix 'ly_a' contain the statistics collected since the
139  * server was last started ('a' for 'aggregated'). The fields with the prefix
140  * 'ly_d' contain the statistics collected since the last snapshot ('d' for
141  * 'delta').
142  */
143 typedef struct smb_latency {
144 	kmutex_t	ly_mutex;
145 	uint64_t	ly_a_nreq;
146 	hrtime_t	ly_a_sum;
147 	hrtime_t	ly_a_mean;
148 	hrtime_t	ly_a_stddev;
149 	uint64_t	ly_d_nreq;
150 	hrtime_t	ly_d_sum;
151 	hrtime_t	ly_d_mean;
152 	hrtime_t	ly_d_stddev;
153 } smb_latency_t;
154 
155 typedef struct smb_disp_stats {
156 	volatile uint64_t sdt_txb;
157 	volatile uint64_t sdt_rxb;
158 	smb_latency_t	sdt_lat;
159 } smb_disp_stats_t;
160 
161 int smb_noop(void *, size_t, int);
162 
163 #define	SMB_AUDIT_STACK_DEPTH	16
164 #define	SMB_AUDIT_BUF_MAX_REC	16
165 #define	SMB_AUDIT_NODE		0x00000001
166 
167 /*
168  * Maximum number of records returned in SMBsearch, SMBfind
169  * and SMBfindunique response. Value set to 10 for compatibility
170  * with Windows.
171  */
172 #define	SMB_MAX_SEARCH		10
173 
174 #define	SMB_SEARCH_ATTRIBUTES    \
175 	(FILE_ATTRIBUTE_HIDDEN | \
176 	FILE_ATTRIBUTE_SYSTEM |  \
177 	FILE_ATTRIBUTE_DIRECTORY)
178 
179 #define	SMB_SEARCH_HIDDEN(sattr) ((sattr) & FILE_ATTRIBUTE_HIDDEN)
180 #define	SMB_SEARCH_SYSTEM(sattr) ((sattr) & FILE_ATTRIBUTE_SYSTEM)
181 #define	SMB_SEARCH_DIRECTORY(sattr) ((sattr) & FILE_ATTRIBUTE_DIRECTORY)
182 #define	SMB_SEARCH_ALL(sattr) ((sattr) & SMB_SEARCH_ATTRIBUTES)
183 
184 typedef struct {
185 	uint32_t		anr_refcnt;
186 	int			anr_depth;
187 	pc_t			anr_stack[SMB_AUDIT_STACK_DEPTH];
188 } smb_audit_record_node_t;
189 
190 typedef struct {
191 	int			anb_index;
192 	int			anb_max_index;
193 	smb_audit_record_node_t	anb_records[SMB_AUDIT_BUF_MAX_REC];
194 } smb_audit_buf_node_t;
195 
196 /*
197  * Thread State Machine
198  * --------------------
199  *
200  *			    T5			   T0
201  * smb_thread_destroy()	<-------+		+------- smb_thread_init()
202  *                              |		|
203  *				|		v
204  *			+-----------------------------+
205  *			|   SMB_THREAD_STATE_EXITED   |<---+
206  *			+-----------------------------+	   |
207  *				      | T1		   |
208  *				      v			   |
209  *			+-----------------------------+	   |
210  *			|  SMB_THREAD_STATE_STARTING  |	   |
211  *			+-----------------------------+	   |
212  *				     | T2		   | T4
213  *				     v			   |
214  *			+-----------------------------+	   |
215  *			|  SMB_THREAD_STATE_RUNNING   |	   |
216  *			+-----------------------------+	   |
217  *				     | T3		   |
218  *				     v			   |
219  *			+-----------------------------+	   |
220  *			|  SMB_THREAD_STATE_EXITING   |----+
221  *			+-----------------------------+
222  *
223  * Transition T0
224  *
225  *    This transition is executed in smb_thread_init().
226  *
227  * Transition T1
228  *
229  *    This transition is executed in smb_thread_start().
230  *
231  * Transition T2
232  *
233  *    This transition is executed by the thread itself when it starts running.
234  *
235  * Transition T3
236  *
237  *    This transition is executed by the thread itself in
238  *    smb_thread_entry_point() just before calling thread_exit().
239  *
240  *
241  * Transition T4
242  *
243  *    This transition is executed in smb_thread_stop().
244  *
245  * Transition T5
246  *
247  *    This transition is executed in smb_thread_destroy().
248  */
249 typedef enum smb_thread_state {
250 	SMB_THREAD_STATE_STARTING = 0,
251 	SMB_THREAD_STATE_RUNNING,
252 	SMB_THREAD_STATE_EXITING,
253 	SMB_THREAD_STATE_EXITED
254 } smb_thread_state_t;
255 
256 struct _smb_thread;
257 
258 typedef void (*smb_thread_ep_t)(struct _smb_thread *, void *ep_arg);
259 
260 #define	SMB_THREAD_MAGIC	0x534D4254	/* SMBT */
261 
262 typedef struct _smb_thread {
263 	uint32_t		sth_magic;
264 	char			sth_name[16];
265 	smb_thread_state_t	sth_state;
266 	kthread_t		*sth_th;
267 	kt_did_t		sth_did;
268 	smb_thread_ep_t		sth_ep;
269 	void			*sth_ep_arg;
270 	pri_t			sth_pri;
271 	boolean_t		sth_kill;
272 	kmutex_t		sth_mtx;
273 	kcondvar_t		sth_cv;
274 } smb_thread_t;
275 
276 /*
277  * Pool of IDs
278  * -----------
279  *
280  *    A pool of IDs is a pool of 16 bit numbers. It is implemented as a bitmap.
281  *    A bit set to '1' indicates that that particular value has been allocated.
282  *    The allocation process is done shifting a bit through the whole bitmap.
283  *    The current position of that index bit is kept in the smb_idpool_t
284  *    structure and represented by a byte index (0 to buffer size minus 1) and
285  *    a bit index (0 to 7).
286  *
287  *    The pools start with a size of 8 bytes or 64 IDs. Each time the pool runs
288  *    out of IDs its current size is doubled until it reaches its maximum size
289  *    (8192 bytes or 65536 IDs). The IDs 0 and 65535 are never given out which
290  *    means that a pool can have a maximum number of 65534 IDs available.
291  */
292 #define	SMB_IDPOOL_MAGIC	0x4944504C	/* IDPL */
293 #define	SMB_IDPOOL_MIN_SIZE	64	/* Number of IDs to begin with */
294 #define	SMB_IDPOOL_MAX_SIZE	64 * 1024
295 
296 typedef struct smb_idpool {
297 	uint32_t	id_magic;
298 	kmutex_t	id_mutex;
299 	uint8_t		*id_pool;
300 	uint32_t	id_size;
301 	uint8_t		id_bit;
302 	uint8_t		id_bit_idx;
303 	uint32_t	id_idx;
304 	uint32_t	id_idx_msk;
305 	uint32_t	id_free_counter;
306 	uint32_t	id_max_free_counter;
307 } smb_idpool_t;
308 
309 /*
310  * Maximum size of a Transport Data Unit when CAP_LARGE_READX and
311  * CAP_LARGE_WRITEX are not set.  CAP_LARGE_READX/CAP_LARGE_WRITEX
312  * allow the payload to exceed the negotiated buffer size.
313  *     4 --> NBT/TCP Transport Header.
314  *    32 --> SMB Header
315  *     1 --> Word Count byte
316  *   510 --> Maximum Number of bytes of the Word Table (2 * 255)
317  *     2 --> Byte count of the data
318  * 65535 --> Maximum size of the data
319  * -----
320  * 66084
321  */
322 #define	SMB_REQ_MAX_SIZE	66560		/* 65KB */
323 #define	SMB_XPRT_MAX_SIZE	(SMB_REQ_MAX_SIZE + NETBIOS_HDR_SZ)
324 
325 #define	SMB_TXREQ_MAGIC		0X54524251	/* 'TREQ' */
326 typedef struct {
327 	uint32_t	tr_magic;
328 	list_node_t	tr_lnd;
329 	int		tr_len;
330 	uint8_t		tr_buf[SMB_XPRT_MAX_SIZE];
331 } smb_txreq_t;
332 
333 #define	SMB_TXLST_MAGIC		0X544C5354	/* 'TLST' */
334 typedef struct {
335 	uint32_t	tl_magic;
336 	kmutex_t	tl_mutex;
337 	boolean_t	tl_active;
338 	list_t		tl_list;
339 } smb_txlst_t;
340 
341 /*
342  * Maximum buffer size for NT is 37KB.  If all clients are Windows 2000, this
343  * can be changed to 64KB.  37KB must be used with a mix of NT/Windows 2000
344  * clients because NT loses directory entries when values greater than 37KB are
345  * used.
346  *
347  * Note: NBT_MAXBUF will be subtracted from the specified max buffer size to
348  * account for the NBT header.
349  */
350 #define	NBT_MAXBUF		8
351 #define	SMB_NT_MAXBUF		(37 * 1024)
352 
353 #define	OUTBUFSIZE		(65 * 1024)
354 #define	SMBHEADERSIZE		32
355 #define	SMBND_HASH_MASK		(0xFF)
356 #define	MAX_IOVEC		512
357 #define	MAX_READREF		(8 * 1024)
358 
359 #define	SMB_WORKER_MIN		4
360 #define	SMB_WORKER_DEFAULT	64
361 #define	SMB_WORKER_MAX		1024
362 
363 /*
364  * Destructor object used in the locked-list delete queue.
365  */
366 #define	SMB_DTOR_MAGIC		0x44544F52	/* DTOR */
367 #define	SMB_DTOR_VALID(d)	\
368     ASSERT(((d) != NULL) && ((d)->dt_magic == SMB_DTOR_MAGIC))
369 
370 typedef void (*smb_dtorproc_t)(void *);
371 
372 typedef struct smb_dtor {
373 	uint32_t	dt_magic;
374 	list_node_t	dt_lnd;
375 	void		*dt_object;
376 	smb_dtorproc_t	dt_proc;
377 } smb_dtor_t;
378 
379 typedef struct smb_llist {
380 	krwlock_t	ll_lock;
381 	list_t		ll_list;
382 	uint32_t	ll_count;
383 	uint64_t	ll_wrop;
384 	kmutex_t	ll_mutex;
385 	list_t		ll_deleteq;
386 	uint32_t	ll_deleteq_count;
387 	boolean_t	ll_flushing;
388 } smb_llist_t;
389 
390 typedef struct smb_slist {
391 	kmutex_t	sl_mutex;
392 	kcondvar_t	sl_cv;
393 	list_t		sl_list;
394 	uint32_t	sl_count;
395 	boolean_t	sl_waiting;
396 } smb_slist_t;
397 
398 /*
399  * smb_avl_t State Machine
400  * --------------------
401  *
402  *                      +-----------------------------+
403  *                      |     SMB_AVL_STATE_START     |
404  *                      +-----------------------------+
405  *                                    | T0
406  *                                    v
407  *                      +-----------------------------+
408  *                      |     SMB_AVL_STATE_READY     |
409  *                      +-----------------------------+
410  *                                    | T1
411  *                                    v
412  *                      +-----------------------------+
413  *                      |  SMB_AVL_STATE_DESTROYING   |
414  *                      +-----------------------------+
415  *
416  * Transition T0
417  *
418  *    This transition is executed in smb_avl_create().
419  *
420  * Transition T1
421  *
422  *    This transition is executed in smb_avl_destroy().
423  *
424  */
425 typedef enum {
426 	SMB_AVL_STATE_START = 0,
427 	SMB_AVL_STATE_READY,
428 	SMB_AVL_STATE_DESTROYING
429 } smb_avl_state_t;
430 
431 typedef struct smb_avl_nops {
432 	int		(*avln_cmp) (const void *, const void *);
433 	void		(*avln_hold)(const void *);
434 	boolean_t	(*avln_rele)(const void *);
435 	void		(*avln_destroy)(void *);
436 } smb_avl_nops_t;
437 
438 typedef struct smb_avl_cursor {
439 	void		*avlc_next;
440 	uint32_t	avlc_sequence;
441 } smb_avl_cursor_t;
442 
443 typedef struct smb_avl {
444 	krwlock_t	avl_lock;
445 	avl_tree_t	avl_tree;
446 	kmutex_t	avl_mutex;
447 	kcondvar_t	avl_cv;
448 	smb_avl_state_t	avl_state;
449 	uint32_t	avl_refcnt;
450 	uint32_t	avl_sequence;
451 	const smb_avl_nops_t	*avl_nops;
452 } smb_avl_t;
453 
454 typedef struct {
455 	kcondvar_t	rwx_cv;
456 	kmutex_t	rwx_mutex;
457 	krwlock_t	rwx_lock;
458 	boolean_t	rwx_waiting;
459 } smb_rwx_t;
460 
461 typedef struct smb_export {
462 	kmutex_t	e_mutex;
463 	boolean_t	e_ready;
464 	smb_llist_t	e_vfs_list;
465 	smb_avl_t	e_share_avl;
466 	smb_slist_t	e_unexport_list;
467 	smb_thread_t	e_unexport_thread;
468 } smb_export_t;
469 
470 /* NOTIFY CHANGE */
471 typedef struct smb_node_fcn {
472 	kmutex_t	fcn_mutex;
473 	uint32_t	fcn_count;
474 	list_t		fcn_watchers;	/* smb_request_t, sr_ncr.nc_lnd */
475 } smb_node_fcn_t;
476 
477 typedef struct smb_notify_change_req {
478 	list_node_t		nc_lnd;	/* n_fcn.fcn_watchers */
479 	kcondvar_t		nc_cv;	/* prot: sr_mutex */
480 	uint32_t		nc_flags;
481 	uint32_t		nc_action;
482 	char			*nc_fname;
483 } smb_notify_change_req_t;
484 
485 /*
486  * SMB operates over a NetBIOS-over-TCP transport (NBT) or directly
487  * over TCP, which is also known as direct hosted NetBIOS-less SMB
488  * or SMB-over-TCP.
489  *
490  * NBT messages have a 4-byte header that defines the message type
491  * (8-bits), a 7-bit flags field and a 17-bit length.
492  *
493  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
494  * |      TYPE     |     FLAGS   |E|            LENGTH             |
495  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
496  *
497  * 8-bit type      Defined in RFC 1002
498  * 7-bit flags     Bits 0-6 reserved (must be 0)
499  *                 Bit 7: Length extension bit (E)
500  * 17-bit length   Includes bit 7 of the flags byte
501  *
502  *
503  * SMB-over-TCP is defined to use a modified version of the NBT header
504  * containing an 8-bit message type and 24-bit message length.
505  *
506  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
507  * |      TYPE     |                  LENGTH                       |
508  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
509  *
510  * 8-bit type      Must be 0
511  * 24-bit length
512  *
513  * The following structure is used to represent a generic, in-memory
514  * SMB transport header; it is not intended to map directly to either
515  * of the over-the-wire formats.
516  */
517 typedef struct {
518 	uint8_t		xh_type;
519 	uint32_t	xh_length;
520 } smb_xprt_t;
521 
522 int MBC_LENGTH(struct mbuf_chain *);
523 int MBC_MAXBYTES(struct mbuf_chain *);
524 void MBC_SETUP(struct mbuf_chain *, uint32_t);
525 void MBC_INIT(struct mbuf_chain *, uint32_t);
526 void MBC_FLUSH(struct mbuf_chain *);
527 void MBC_ATTACH_MBUF(struct mbuf_chain *, struct mbuf *);
528 void MBC_APPEND_MBUF(struct mbuf_chain *, struct mbuf *);
529 void MBC_ATTACH_BUF(struct mbuf_chain *MBC, unsigned char *BUF, int LEN);
530 int MBC_SHADOW_CHAIN(struct mbuf_chain *SUBMBC, struct mbuf_chain *MBC,
531     int OFF, int LEN);
532 
533 #define	MBC_ROOM_FOR(b, n) (((b)->chain_offset + (n)) <= (b)->max_bytes)
534 
535 #define	OPLOCK_MIN_TIMEOUT	(5 * 1000)
536 #define	OPLOCK_STD_TIMEOUT	(30 * 1000)
537 
538 /*
539  * Oplock break flags:
540  * SMB_OPLOCK_BREAK_EXCLUSIVE - only break exclusive oplock
541  * (type SMB_OPLOCK_EXCLUSIVE or SMB_OPLOCK_BATCH)
542  * SMB_OPLOCK_BREAK_BATCH - only break exclusive BATCH oplock
543  * SMB_OPLOCK_BREAK_NOWAIT - do not wait for oplock break ack
544  */
545 #define	SMB_OPLOCK_NO_BREAK		0x00
546 #define	SMB_OPLOCK_BREAK_TO_NONE	0x01
547 #define	SMB_OPLOCK_BREAK_TO_LEVEL_II	0x02
548 #define	SMB_OPLOCK_BREAK_EXCLUSIVE	0x04
549 #define	SMB_OPLOCK_BREAK_BATCH		0x08
550 #define	SMB_OPLOCK_BREAK_NOWAIT		0x10
551 
552 /*
553  * Oplocks levels are defined to match the levels in the SMB
554  * protocol (nt_create_andx / nt_transact_create) and should
555  * not be changed
556  */
557 #define	SMB_OPLOCK_NONE		0
558 #define	SMB_OPLOCK_EXCLUSIVE	1
559 #define	SMB_OPLOCK_BATCH	2
560 #define	SMB_OPLOCK_LEVEL_II	3
561 
562 typedef struct smb_oplock {
563 	kmutex_t		ol_mutex;
564 	kcondvar_t		ol_cv;
565 	kthread_t		*ol_xthread;
566 	boolean_t		ol_fem;		/* fem monitor installed? */
567 	uint8_t			ol_break;
568 	uint32_t		ol_count;	/* number of grants */
569 	list_t			ol_grants;	/* list of smb_oplock_grant_t */
570 } smb_oplock_t;
571 
572 #define	SMB_OPLOCK_GRANT_MAGIC	0x4F4C4B47	/* OLKG */
573 #define	SMB_OPLOCK_GRANT_VALID(p) \
574 	ASSERT((p)->og_magic == SMB_OPLOCK_GRANT_MAGIC)
575 #define	SMB_OFILE_OPLOCK_GRANTED(p) \
576 	((p)->f_oplock_grant.og_magic == SMB_OPLOCK_GRANT_MAGIC)
577 typedef struct smb_oplock_grant {
578 	uint32_t		og_magic;
579 	list_node_t		og_lnd;
580 	uint8_t			og_level;
581 	uint16_t		og_fid;
582 	uint16_t		og_tid;
583 	uint16_t		og_uid;
584 	struct smb_session	*og_session;
585 	struct smb_ofile	*og_ofile;
586 } smb_oplock_grant_t;
587 
588 #define	SMB_OPLOCK_BREAK_MAGIC	0x4F4C4B42	/* OLKB */
589 #define	SMB_OPLOCK_BREAK_VALID(p) \
590 	ASSERT((p)->ob_magic == SMB_OPLOCK_BREAK_MAGIC)
591 typedef struct smb_oplock_break {
592 	uint32_t	ob_magic;
593 	list_node_t	ob_lnd;
594 	struct smb_node	*ob_node;
595 } smb_oplock_break_t;
596 
597 
598 #define	SMB_VFS_MAGIC	0x534D4256	/* 'SMBV' */
599 
600 typedef struct smb_vfs {
601 	uint32_t		sv_magic;
602 	list_node_t		sv_lnd;
603 	uint32_t		sv_refcnt;
604 	vfs_t			*sv_vfsp;
605 	vnode_t			*sv_rootvp;
606 } smb_vfs_t;
607 
608 #define	SMB_NODE_MAGIC		0x4E4F4445	/* 'NODE' */
609 #define	SMB_NODE_VALID(p)	ASSERT((p)->n_magic == SMB_NODE_MAGIC)
610 
611 typedef enum {
612 	SMB_NODE_STATE_AVAILABLE = 0,
613 	SMB_NODE_STATE_DESTROYING
614 } smb_node_state_t;
615 
616 /*
617  * waiting_event        # of clients requesting FCN
618  * n_timestamps         cached timestamps
619  * n_allocsz            cached file allocation size
620  * n_dnode              directory node
621  * n_unode              unnamed stream node
622  * delete_on_close_cred credentials for delayed delete
623  */
624 typedef struct smb_node {
625 	uint32_t		n_magic;
626 	krwlock_t		n_lock;
627 	kmutex_t		n_mutex;
628 	list_node_t		n_lnd;
629 	smb_node_state_t	n_state;
630 	uint32_t		n_refcnt;
631 	uint32_t		n_hashkey;
632 	smb_llist_t		*n_hash_bucket;
633 	uint32_t		n_open_count;
634 	uint32_t		n_opening_count;
635 	smb_llist_t		n_ofile_list;
636 	smb_llist_t		n_lock_list;
637 	uint32_t		n_pending_dosattr;
638 	volatile int		flags;
639 	u_offset_t		n_allocsz;
640 	smb_node_fcn_t		n_fcn;
641 	smb_oplock_t		n_oplock;
642 	struct smb_node		*n_dnode;
643 	struct smb_node		*n_unode;
644 	cred_t			*delete_on_close_cred;
645 	uint32_t		n_delete_on_close_flags;
646 	char			od_name[MAXNAMELEN];
647 	vnode_t			*vp;
648 	smb_audit_buf_node_t	*n_audit_buf;
649 } smb_node_t;
650 
651 #define	NODE_FLAGS_REPARSE		0x00001000
652 #define	NODE_FLAGS_DFSLINK		0x00002000
653 #define	NODE_FLAGS_VFSROOT		0x00004000
654 #define	NODE_FLAGS_SYSTEM		0x00008000
655 #define	NODE_FLAGS_WRITE_THROUGH	0x00100000
656 #define	NODE_XATTR_DIR			0x01000000
657 #define	NODE_FLAGS_DELETE_ON_CLOSE	0x40000000
658 #define	NODE_FLAGS_EXECUTABLE		0x80000000
659 
660 #define	SMB_NODE_VFS(node)	((node)->vp->v_vfsp)
661 #define	SMB_NODE_FSID(node)	((node)->vp->v_vfsp->vfs_fsid)
662 
663 /* Maximum buffer size for encryption key */
664 #define	SMB_ENCRYPT_KEY_MAXLEN		32
665 
666 #define	SMB_SHARE_MAGIC		0x4B534852	/* KSHR */
667 
668 typedef struct smb_kshare {
669 	uint32_t	shr_magic;
670 	char		*shr_name;
671 	char		*shr_path;
672 	char		*shr_cmnt;
673 	char		*shr_container;
674 	char		*shr_oemname;
675 	uint32_t	shr_flags;
676 	uint32_t	shr_type;
677 	uint32_t	shr_refcnt;
678 	uint32_t	shr_autocnt;
679 	uid_t		shr_uid;
680 	gid_t		shr_gid;
681 	char		*shr_access_none;
682 	char		*shr_access_ro;
683 	char		*shr_access_rw;
684 	avl_node_t	shr_link;
685 	kmutex_t	shr_mutex;
686 } smb_kshare_t;
687 
688 
689 typedef struct smb_arg_negotiate {
690 	char		*ni_name;
691 	int		ni_dialect;
692 	int		ni_index;
693 	uint32_t	ni_capabilities;
694 	uint16_t	ni_maxmpxcount;
695 	int16_t		ni_tzcorrection;
696 	uint8_t		ni_keylen;
697 	uint8_t		ni_key[SMB_ENCRYPT_KEY_MAXLEN];
698 	timestruc_t	ni_servertime;
699 } smb_arg_negotiate_t;
700 
701 typedef struct smb_arg_sessionsetup {
702 	char		*ssi_user;
703 	char		*ssi_domain;
704 	uint16_t	ssi_cipwlen;
705 	uint8_t		*ssi_cipwd;
706 	uint16_t	ssi_cspwlen;
707 	uint8_t		*ssi_cspwd;
708 	uint16_t	ssi_maxmpxcount;
709 	uint32_t	ssi_capabilities;
710 	uint32_t	ssi_sesskey;
711 	boolean_t	ssi_guest;
712 } smb_arg_sessionsetup_t;
713 
714 typedef struct tcon {
715 	char		*path;
716 	char		*service;
717 	int		pwdlen;
718 	char		*password;
719 	uint16_t	flags;
720 	uint16_t	optional_support;
721 	smb_kshare_t	*si;
722 } smb_arg_tcon_t;
723 
724 /*
725  * Based on section 2.6.1.2 (Connection Management) of the June 13,
726  * 1996 CIFS spec, a server may terminate the transport connection
727  * due to inactivity. The client software is expected to be able to
728  * automatically reconnect to the server if this happens. Like much
729  * of the useful background information, this section appears to
730  * have been dropped from later revisions of the document.
731  *
732  * Each session has an activity timestamp that's updated whenever a
733  * request is dispatched. If the session is idle, i.e. receives no
734  * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be
735  * closed.
736  *
737  * Each session has an I/O semaphore to serialize communication with
738  * the client. For example, after receiving a raw-read request, the
739  * server is not allowed to send an oplock break to the client until
740  * after it has sent the raw-read data.
741  */
742 #define	SMB_SESSION_INACTIVITY_TIMEOUT		(15 * 60)
743 
744 #define	SMB_SESSION_OFILE_MAX			(16 * 1024)
745 
746 /*
747  * When a connection is set up we need to remember both the client
748  * (peer) IP address and the local IP address used to establish the
749  * connection. When a client connects with a vc number of zero, we
750  * are supposed to abort any existing connections with that client
751  * (see notes in smb_negotiate.c and smb_session_setup_andx.c). For
752  * servers with multiple network interfaces or IP aliases, however,
753  * each interface has to be managed independently since the client
754  * is not aware of the server configuration. We have to allow the
755  * client to establish a connection on each interface with a vc
756  * number of zero without aborting the other connections.
757  *
758  * ipaddr:       the client (peer) IP address for the session.
759  * local_ipaddr: the local IP address used to connect to the server.
760  */
761 
762 #define	SMB_MAC_KEYSZ	512
763 
764 struct smb_sign {
765 	unsigned int seqnum;
766 	unsigned int mackey_len;
767 	unsigned int flags;
768 	unsigned char mackey[SMB_MAC_KEYSZ];
769 };
770 
771 #define	SMB_SIGNING_ENABLED	1
772 #define	SMB_SIGNING_CHECK	2
773 
774 /*
775  * Session State Machine
776  * ---------------------
777  *
778  * +-----------------------------+	     +------------------------------+
779  * | SMB_SESSION_STATE_CONNECTED |           | SMB_SESSION_STATE_TERMINATED |
780  * +-----------------------------+           +------------------------------+
781  *		T0|					     ^
782  *		  +--------------------+		     |T13
783  *		  v		       |T14                  |
784  * +-------------------------------+   |    +--------------------------------+
785  * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED |
786  * +-------------------------------+        +--------------------------------+
787  *		T1|				^	   ^ ^ ^
788  *		  +----------+			|T9        | | |
789  *                           v			|          | | |
790  *                  +------------------------------+       | | |
791  *                  | SMB_SESSION_STATE_NEGOTIATED |       | | |
792  *                  +------------------------------+       | | |
793  *	                 ^|   ^|   | ^                     | | |
794  *      +----------------+|   ||   | |                     | | |
795  *      |+----------------+   || T7| |T8                   | | |
796  *      ||                    ||   | |                     | | |
797  *      ||   +----------------+|   | |                     | | |
798  *      ||   |+----------------+   | |                     | | |
799  *	||   ||			   v |                     | | |
800  *      ||   ||   +-----------------------------------+ T10| | |
801  *      ||   ||   | SMB_SESSION_STATE_OPLOCK_BREAKING |----+ | |
802  *      ||   ||   +-----------------------------------+      | |
803  *	||   ||T5                                            | |
804  *      ||   |+-->+-----------------------------------+	  T11| |
805  *      ||   |T6  | SMB_SESSION_STATE_READ_RAW_ACTIVE |------+ |
806  *      ||   +----+-----------------------------------+        |
807  *	||T3                                                   |
808  *      |+------->+------------------------------------+    T12|
809  *      |T4       | SMB_SESSION_STATE_WRITE_RAW_ACTIVE |-------+
810  *      +---------+------------------------------------+
811  *
812  * Transition T0
813  *
814  *
815  *
816  * Transition T1
817  *
818  *
819  *
820  * Transition T2
821  *
822  *
823  *
824  * Transition T3
825  *
826  *
827  *
828  * Transition T4
829  *
830  *
831  *
832  * Transition T5
833  *
834  *
835  *
836  * Transition T6
837  *
838  *
839  *
840  * Transition T7
841  *
842  *
843  *
844  * Transition T8
845  *
846  *
847  *
848  * Transition T9
849  *
850  *
851  *
852  * Transition T10
853  *
854  *
855  *
856  * Transition T11
857  *
858  *
859  *
860  * Transition T12
861  *
862  *
863  *
864  * Transition T13
865  *
866  *
867  *
868  * Transition T14
869  *
870  *
871  *
872  */
873 #define	SMB_SESSION_MAGIC	0x53455353	/* 'SESS' */
874 #define	SMB_SESSION_VALID(p)	\
875     ASSERT(((p) != NULL) && ((p)->s_magic == SMB_SESSION_MAGIC))
876 
877 #define	SMB_CHALLENGE_SZ	8
878 
879 typedef enum {
880 	SMB_SESSION_STATE_INITIALIZED = 0,
881 	SMB_SESSION_STATE_DISCONNECTED,
882 	SMB_SESSION_STATE_CONNECTED,
883 	SMB_SESSION_STATE_ESTABLISHED,
884 	SMB_SESSION_STATE_NEGOTIATED,
885 	SMB_SESSION_STATE_OPLOCK_BREAKING,
886 	SMB_SESSION_STATE_TERMINATED,
887 	SMB_SESSION_STATE_SENTINEL
888 } smb_session_state_t;
889 
890 typedef struct smb_session {
891 	uint32_t		s_magic;
892 	smb_rwx_t		s_lock;
893 	list_node_t		s_lnd;
894 	uint64_t		s_kid;
895 	smb_session_state_t	s_state;
896 	uint32_t		s_flags;
897 	taskqid_t		s_receiver_tqid;
898 	kthread_t		*s_thread;
899 	kt_did_t		s_ktdid;
900 	smb_kmod_cfg_t		s_cfg;
901 	struct smb_server	*s_server;
902 	int32_t			s_gmtoff;
903 	uint32_t		keep_alive;
904 	uint64_t		opentime;
905 	uint16_t		vcnumber;
906 	uint16_t		s_local_port;
907 	smb_inaddr_t		ipaddr;
908 	smb_inaddr_t		local_ipaddr;
909 	char 			workstation[SMB_PI_MAX_HOST];
910 	int			dialect;
911 	int			native_os;
912 	int			native_lm;
913 
914 	uint32_t		capabilities;
915 	struct smb_sign		signing;
916 
917 	ksocket_t		sock;
918 
919 	smb_slist_t		s_req_list;
920 	smb_llist_t		s_xa_list;
921 	smb_llist_t		s_user_list;
922 	smb_llist_t		s_tree_list;
923 	smb_idpool_t		s_uid_pool;
924 	smb_idpool_t		s_tid_pool;
925 	smb_txlst_t		s_txlst;
926 
927 	volatile uint32_t	s_tree_cnt;
928 	volatile uint32_t	s_file_cnt;
929 	volatile uint32_t	s_dir_cnt;
930 
931 	uint16_t		secmode;
932 	uint32_t		sesskey;
933 	uint32_t		challenge_len;
934 	unsigned char		challenge_key[SMB_CHALLENGE_SZ];
935 	unsigned char		MAC_key[44];
936 	int64_t			activity_timestamp;
937 	/*
938 	 * Maximum negotiated buffer size between SMB client and server
939 	 * in SMB_SESSION_SETUP_ANDX
940 	 */
941 	uint16_t		smb_msg_size;
942 	uchar_t			*outpipe_data;
943 	int			outpipe_datalen;
944 	int			outpipe_cookie;
945 	smb_srqueue_t		*s_srqueue;
946 } smb_session_t;
947 
948 #define	SMB_USER_MAGIC 0x55534552	/* 'USER' */
949 #define	SMB_USER_VALID(u)	\
950     ASSERT(((u) != NULL) && ((u)->u_magic == SMB_USER_MAGIC))
951 
952 #define	SMB_USER_FLAG_GUEST			SMB_ATF_GUEST
953 #define	SMB_USER_FLAG_IPC			SMB_ATF_ANON
954 #define	SMB_USER_FLAG_ADMIN			SMB_ATF_ADMIN
955 #define	SMB_USER_FLAG_POWER_USER		SMB_ATF_POWERUSER
956 #define	SMB_USER_FLAG_BACKUP_OPERATOR		SMB_ATF_BACKUPOP
957 
958 #define	SMB_USER_IS_ADMIN(U)	(((U)->u_flags & SMB_USER_FLAG_ADMIN) != 0)
959 #define	SMB_USER_IS_GUEST(U)	(((U)->u_flags & SMB_USER_FLAG_GUEST) != 0)
960 
961 #define	SMB_USER_PRIV_TAKE_OWNERSHIP	0x00000001
962 #define	SMB_USER_PRIV_BACKUP		0x00000002
963 #define	SMB_USER_PRIV_RESTORE		0x00000004
964 #define	SMB_USER_PRIV_SECURITY		0x00000008
965 
966 
967 typedef enum {
968 	SMB_USER_STATE_LOGGED_IN = 0,
969 	SMB_USER_STATE_LOGGING_OFF,
970 	SMB_USER_STATE_LOGGED_OFF,
971 	SMB_USER_STATE_SENTINEL
972 } smb_user_state_t;
973 
974 typedef struct smb_user {
975 	uint32_t		u_magic;
976 	list_node_t		u_lnd;
977 	kmutex_t		u_mutex;
978 	smb_user_state_t	u_state;
979 
980 	struct smb_server	*u_server;
981 	smb_session_t		*u_session;
982 	uint16_t		u_name_len;
983 	char			*u_name;
984 	uint16_t		u_domain_len;
985 	char			*u_domain;
986 	time_t			u_logon_time;
987 	cred_t			*u_cred;
988 	cred_t			*u_privcred;
989 
990 	uint32_t		u_refcnt;
991 	uint32_t		u_flags;
992 	uint32_t		u_privileges;
993 	uint16_t		u_uid;
994 	uint32_t		u_audit_sid;
995 } smb_user_t;
996 
997 #define	SMB_TREE_MAGIC			0x54524545	/* 'TREE' */
998 #define	SMB_TREE_VALID(p)	\
999     ASSERT((p != NULL) && ((p)->t_magic == SMB_TREE_MAGIC))
1000 
1001 #define	SMB_TYPENAMELEN			_ST_FSTYPSZ
1002 #define	SMB_VOLNAMELEN			32
1003 
1004 #define	SMB_TREE_READONLY		0x00000001
1005 #define	SMB_TREE_SUPPORTS_ACLS		0x00000002
1006 #define	SMB_TREE_STREAMS		0x00000004
1007 #define	SMB_TREE_CASEINSENSITIVE	0x00000008
1008 #define	SMB_TREE_NO_CASESENSITIVE	0x00000010
1009 #define	SMB_TREE_NO_EXPORT		0x00000020
1010 #define	SMB_TREE_OPLOCKS		0x00000040
1011 #define	SMB_TREE_SHORTNAMES		0x00000080
1012 #define	SMB_TREE_XVATTR			0x00000100
1013 #define	SMB_TREE_DIRENTFLAGS		0x00000200
1014 #define	SMB_TREE_ACLONCREATE		0x00000400
1015 #define	SMB_TREE_ACEMASKONACCESS	0x00000800
1016 #define	SMB_TREE_NFS_MOUNTED		0x00001000
1017 #define	SMB_TREE_UNICODE_ON_DISK	0x00002000
1018 #define	SMB_TREE_CATIA			0x00004000
1019 #define	SMB_TREE_ABE			0x00008000
1020 #define	SMB_TREE_QUOTA			0x00010000
1021 #define	SMB_TREE_DFSROOT		0x00020000
1022 #define	SMB_TREE_SPARSE			0x00040000
1023 #define	SMB_TREE_TRAVERSE_MOUNTS	0x00080000
1024 
1025 typedef enum {
1026 	SMB_TREE_STATE_CONNECTED = 0,
1027 	SMB_TREE_STATE_DISCONNECTING,
1028 	SMB_TREE_STATE_DISCONNECTED,
1029 	SMB_TREE_STATE_SENTINEL
1030 } smb_tree_state_t;
1031 
1032 typedef struct smb_tree {
1033 	uint32_t		t_magic;
1034 	kmutex_t		t_mutex;
1035 	list_node_t		t_lnd;
1036 	smb_tree_state_t	t_state;
1037 
1038 	struct smb_server	*t_server;
1039 	smb_session_t		*t_session;
1040 	/*
1041 	 * user whose uid was in the tree connect message
1042 	 * ("owner" in MS-CIFS parlance, see section 2.2.1.6 definition of FID)
1043 	 */
1044 	smb_user_t		*t_owner;
1045 	smb_node_t		*t_snode;
1046 
1047 	smb_llist_t		t_ofile_list;
1048 	smb_idpool_t		t_fid_pool;
1049 
1050 	smb_llist_t		t_odir_list;
1051 	smb_idpool_t		t_odid_pool;
1052 
1053 	uint32_t		t_refcnt;
1054 	uint32_t		t_flags;
1055 	int32_t			t_res_type;
1056 	uint16_t		t_tid;
1057 	uint16_t		t_umask;
1058 	char			t_sharename[MAXNAMELEN];
1059 	char			t_resource[MAXPATHLEN];
1060 	char			t_typename[SMB_TYPENAMELEN];
1061 	char			t_volume[SMB_VOLNAMELEN];
1062 	acl_type_t		t_acltype;
1063 	uint32_t		t_access;
1064 	uint32_t		t_execflags;
1065 	time_t			t_connect_time;
1066 	volatile uint32_t	t_open_files;
1067 } smb_tree_t;
1068 
1069 #define	SMB_TREE_VFS(tree)	((tree)->t_snode->vp->v_vfsp)
1070 #define	SMB_TREE_FSID(tree)	((tree)->t_snode->vp->v_vfsp->vfs_fsid)
1071 
1072 #define	SMB_TREE_IS_READONLY(sr)					\
1073 	((sr) != NULL && (sr)->tid_tree != NULL &&			\
1074 	!((sr)->tid_tree->t_access & ACE_ALL_WRITE_PERMS))
1075 
1076 #define	SMB_TREE_IS_CASEINSENSITIVE(sr)                                 \
1077 	(((sr) && (sr)->tid_tree) ?                                     \
1078 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0)
1079 
1080 #define	SMB_TREE_HAS_ACCESS(sr, acemask)				\
1081 	((sr) == NULL ? ACE_ALL_PERMS : (				\
1082 	(((sr) && (sr)->tid_tree) ?					\
1083 	(((sr)->tid_tree->t_access) & (acemask)) : 0)))
1084 
1085 #define	SMB_TREE_SUPPORTS_CATIA(sr)            				\
1086 	(((sr) && (sr)->tid_tree) ?                                     \
1087 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CATIA) : 0)
1088 
1089 #define	SMB_TREE_SUPPORTS_ABE(sr)            				\
1090 	(((sr) && (sr)->tid_tree) ?                                     \
1091 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_ABE) : 0)
1092 
1093 #define	SMB_TREE_IS_DFSROOT(sr)            				\
1094 	(((sr) && (sr)->tid_tree) ?                                     \
1095 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_DFSROOT) : 0)
1096 
1097 #define	SMB_TREE_SUPPORTS_SHORTNAMES(sr)				\
1098 	(((sr) && (sr)->tid_tree) ?					\
1099 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_SHORTNAMES) : 0)
1100 
1101 /*
1102  * SMB_TREE_CONTAINS_NODE is used to check if a node is on the same
1103  * file system as the tree's root filesystem, or if mount point traversal
1104  * should be allowed.  Note that this is also called in some cases with
1105  * sr=NULL, where it is expected to evaluate to TRUE.
1106  */
1107 
1108 #define	SMB_TREE_CONTAINS_NODE(sr, node)                                \
1109 	((sr) == NULL || (sr)->tid_tree == NULL ||                      \
1110 	SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node) ||           \
1111 	smb_tree_has_feature((sr)->tid_tree, SMB_TREE_TRAVERSE_MOUNTS))
1112 
1113 /*
1114  * SMB_OFILE_IS_READONLY reflects whether an ofile is readonly or not.
1115  * The macro takes into account read-only settings in any of:
1116  * the tree, the node (pending) and the file-system object.
1117  * all of this is evaluated in smb_ofile_open() and after that
1118  * we can just test the f_flags & SMB_OFLAGS_READONLY
1119  */
1120 #define	SMB_OFILE_IS_READONLY(of)	\
1121 	((of)->f_flags & SMB_OFLAGS_READONLY)
1122 
1123 /*
1124  * SMB_PATHFILE_IS_READONLY indicates whether or not a file is
1125  * readonly when the caller has a path rather than an ofile.
1126  */
1127 #define	SMB_PATHFILE_IS_READONLY(sr, node)			\
1128 	(SMB_TREE_IS_READONLY((sr)) ||				\
1129 	smb_node_file_is_readonly((node)))
1130 
1131 #define	SMB_OPIPE_MAGIC		0x50495045	/* 'PIPE' */
1132 #define	SMB_OPIPE_VALID(p)	\
1133     ASSERT(((p) != NULL) && (p)->p_magic == SMB_OPIPE_MAGIC)
1134 
1135 /*
1136  * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used
1137  * at the interface between SMB and NDR RPC.
1138  */
1139 typedef struct smb_opipe {
1140 	uint32_t		p_magic;
1141 	list_node_t		p_lnd;
1142 	kmutex_t		p_mutex;
1143 	kcondvar_t		p_cv;
1144 	struct smb_server	*p_server;
1145 	struct smb_event	*p_event;
1146 	char			*p_name;
1147 	uint32_t		p_busy;
1148 	smb_doorhdr_t		p_hdr;
1149 	smb_netuserinfo_t	p_user;
1150 	uint8_t			*p_doorbuf;
1151 	uint8_t			*p_data;
1152 } smb_opipe_t;
1153 
1154 /*
1155  * The of_ftype	of an open file should contain the SMB_FTYPE value
1156  * returned when the file/pipe was opened. The following
1157  * assumptions are currently made:
1158  *
1159  * File Type	    Node       PipeInfo
1160  * ---------	    --------   --------
1161  * SMB_FTYPE_DISK       Valid      Null
1162  * SMB_FTYPE_BYTE_PIPE  Undefined  Undefined
1163  * SMB_FTYPE_MESG_PIPE  Null       Valid
1164  * SMB_FTYPE_PRINTER    Undefined  Undefined
1165  * SMB_FTYPE_UNKNOWN    Undefined  Undefined
1166  */
1167 
1168 /*
1169  * Some flags for ofile structure
1170  *
1171  *	SMB_OFLAGS_SET_DELETE_ON_CLOSE
1172  *   Set this flag when the corresponding open operation whose
1173  *   DELETE_ON_CLOSE bit of the CreateOptions is set. If any
1174  *   open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE
1175  *   will be set for the file node upon close.
1176  */
1177 
1178 #define	SMB_OFLAGS_READONLY		0x0001
1179 #define	SMB_OFLAGS_EXECONLY		0x0002
1180 #define	SMB_OFLAGS_SET_DELETE_ON_CLOSE	0x0004
1181 #define	SMB_OFLAGS_LLF_POS_VALID	0x0008
1182 
1183 #define	SMB_OFILE_MAGIC 	0x4F464C45	/* 'OFLE' */
1184 #define	SMB_OFILE_VALID(p)	\
1185     ASSERT((p != NULL) && ((p)->f_magic == SMB_OFILE_MAGIC))
1186 
1187 typedef enum {
1188 	SMB_OFILE_STATE_OPEN = 0,
1189 	SMB_OFILE_STATE_CLOSING,
1190 	SMB_OFILE_STATE_CLOSED,
1191 	SMB_OFILE_STATE_SENTINEL
1192 } smb_ofile_state_t;
1193 
1194 typedef struct smb_ofile {
1195 	uint32_t		f_magic;
1196 	kmutex_t		f_mutex;
1197 	list_node_t		f_lnd;
1198 	list_node_t		f_nnd;
1199 	smb_ofile_state_t	f_state;
1200 
1201 	struct smb_server	*f_server;
1202 	smb_session_t		*f_session;
1203 	smb_user_t		*f_user;
1204 	smb_tree_t		*f_tree;
1205 	smb_node_t		*f_node;
1206 	smb_opipe_t		*f_pipe;
1207 
1208 	uint32_t		f_uniqid;
1209 	uint32_t		f_refcnt;
1210 	uint64_t		f_seek_pos;
1211 	uint32_t		f_flags;
1212 	uint32_t		f_granted_access;
1213 	uint32_t		f_share_access;
1214 	uint32_t		f_create_options;
1215 	uint16_t		f_fid;
1216 	uint16_t		f_opened_by_pid;
1217 	uint16_t		f_ftype;
1218 	uint64_t		f_llf_pos;
1219 	int			f_mode;
1220 	cred_t			*f_cr;
1221 	pid_t			f_pid;
1222 	smb_attr_t		f_pending_attr;
1223 	boolean_t		f_written;
1224 	char			f_quota_resume[SMB_SID_STRSZ];
1225 	smb_oplock_grant_t	f_oplock_grant;
1226 } smb_ofile_t;
1227 
1228 #define	SMB_ODIR_MAGIC 		0x4F444952	/* 'ODIR' */
1229 #define	SMB_ODIR_VALID(p)	\
1230     ASSERT((p != NULL) && ((p)->d_magic == SMB_ODIR_MAGIC))
1231 
1232 #define	SMB_ODIR_BUFSIZE	(8 * 1024)
1233 
1234 #define	SMB_ODIR_FLAG_WILDCARDS		0x0001
1235 #define	SMB_ODIR_FLAG_IGNORE_CASE	0x0002
1236 #define	SMB_ODIR_FLAG_XATTR		0x0004
1237 #define	SMB_ODIR_FLAG_EDIRENT		0x0008
1238 #define	SMB_ODIR_FLAG_CATIA		0x0010
1239 #define	SMB_ODIR_FLAG_ABE		0x0020
1240 #define	SMB_ODIR_FLAG_SHORTNAMES	0x0040
1241 
1242 typedef enum {
1243 	SMB_ODIR_STATE_OPEN = 0,
1244 	SMB_ODIR_STATE_IN_USE,
1245 	SMB_ODIR_STATE_CLOSING,
1246 	SMB_ODIR_STATE_CLOSED,
1247 	SMB_ODIR_STATE_SENTINEL
1248 } smb_odir_state_t;
1249 
1250 typedef enum {
1251 	SMB_ODIR_RESUME_CONT,
1252 	SMB_ODIR_RESUME_IDX,
1253 	SMB_ODIR_RESUME_COOKIE,
1254 	SMB_ODIR_RESUME_FNAME
1255 } smb_odir_resume_type_t;
1256 
1257 typedef struct smb_odir_resume {
1258 	smb_odir_resume_type_t	or_type;
1259 	int			or_idx;
1260 	uint32_t		or_cookie;
1261 	char			*or_fname;
1262 } smb_odir_resume_t;
1263 
1264 /*
1265  * Flags used when opening an odir
1266  */
1267 #define	SMB_ODIR_OPENF_BACKUP_INTENT	0x01
1268 
1269 typedef struct smb_odir {
1270 	uint32_t		d_magic;
1271 	kmutex_t		d_mutex;
1272 	list_node_t		d_lnd;
1273 	smb_odir_state_t	d_state;
1274 	smb_session_t		*d_session;
1275 	smb_user_t		*d_user;
1276 	smb_tree_t		*d_tree;
1277 	smb_node_t		*d_dnode;
1278 	cred_t			*d_cred;
1279 	uint16_t		d_odid;
1280 	uint16_t		d_opened_by_pid;
1281 	uint16_t		d_sattr;
1282 	uint32_t		d_refcnt;
1283 	uint32_t		d_flags;
1284 	boolean_t		d_eof;
1285 	int			d_bufsize;
1286 	uint64_t		d_offset;
1287 	union {
1288 		char		*u_bufptr;
1289 		edirent_t	*u_edp;
1290 		dirent64_t	*u_dp;
1291 	} d_u;
1292 	uint32_t		d_last_cookie;
1293 	uint32_t		d_cookies[SMB_MAX_SEARCH];
1294 	char			d_pattern[MAXNAMELEN];
1295 	char			d_buf[SMB_ODIR_BUFSIZE];
1296 	char			d_last_name[MAXNAMELEN];
1297 } smb_odir_t;
1298 #define	d_bufptr	d_u.u_bufptr
1299 #define	d_edp		d_u.u_edp
1300 #define	d_dp		d_u.u_dp
1301 
1302 typedef struct smb_odirent {
1303 	char		od_name[MAXNAMELEN];	/* on disk name */
1304 	ino64_t		od_ino;
1305 	uint32_t	od_eflags;
1306 } smb_odirent_t;
1307 
1308 typedef struct smb_fileinfo {
1309 	char		fi_name[MAXNAMELEN];
1310 	char		fi_shortname[SMB_SHORTNAMELEN];
1311 	uint32_t	fi_cookie;	/* Dir offset (of next entry) */
1312 	uint32_t	fi_dosattr;	/* DOS attributes */
1313 	uint64_t	fi_nodeid;	/* file system node id */
1314 	uint64_t	fi_size;	/* file size in bytes */
1315 	uint64_t	fi_alloc_size;	/* allocation size in bytes */
1316 	timestruc_t	fi_atime;	/* last access */
1317 	timestruc_t	fi_mtime;	/* last modification */
1318 	timestruc_t	fi_ctime;	/* last status change */
1319 	timestruc_t	fi_crtime;	/* file creation */
1320 } smb_fileinfo_t;
1321 
1322 typedef struct smb_streaminfo {
1323 	uint64_t	si_size;
1324 	uint64_t	si_alloc_size;
1325 	char		si_name[MAXPATHLEN];
1326 } smb_streaminfo_t;
1327 
1328 #define	SMB_LOCK_MAGIC 	0x4C4F434B	/* 'LOCK' */
1329 
1330 typedef struct smb_lock {
1331 	uint32_t		l_magic;
1332 	kmutex_t		l_mutex;
1333 	list_node_t		l_lnd;
1334 	kcondvar_t		l_cv;
1335 
1336 	list_node_t		l_conflict_lnd;
1337 	smb_slist_t		l_conflict_list;
1338 
1339 	smb_session_t		*l_session;
1340 	smb_ofile_t		*l_file;
1341 	struct smb_request	*l_sr;
1342 
1343 	uint32_t		l_flags;
1344 	uint64_t		l_session_kid;
1345 	struct smb_lock		*l_blocked_by; /* Debug info only */
1346 
1347 	uint16_t		l_pid;
1348 	uint16_t		l_uid;
1349 	uint32_t		l_type;
1350 	uint64_t		l_start;
1351 	uint64_t		l_length;
1352 	clock_t			l_end_time;
1353 } smb_lock_t;
1354 
1355 #define	SMB_LOCK_FLAG_INDEFINITE	0x0004
1356 #define	SMB_LOCK_INDEFINITE_WAIT(lock) \
1357 	((lock)->l_flags & SMB_LOCK_FLAG_INDEFINITE)
1358 
1359 #define	SMB_LOCK_TYPE_READWRITE		101
1360 #define	SMB_LOCK_TYPE_READONLY		102
1361 
1362 typedef struct vardata_block {
1363 	uint8_t			vdb_tag;
1364 	uint32_t		vdb_len;
1365 	struct uio 		vdb_uio;
1366 	struct iovec		vdb_iovec[MAX_IOVEC];
1367 } smb_vdb_t;
1368 
1369 #define	SMB_WRMODE_WRITE_THRU	0x0001
1370 #define	SMB_WRMODE_IS_STABLE(M)	((M) & SMB_WRMODE_WRITE_THRU)
1371 
1372 #define	SMB_RW_MAGIC		0x52445257	/* 'RDRW' */
1373 
1374 typedef struct smb_rw_param {
1375 	uint32_t rw_magic;
1376 	smb_vdb_t rw_vdb;
1377 	uint64_t rw_offset;
1378 	uint32_t rw_last_write;
1379 	uint16_t rw_mode;
1380 	uint32_t rw_count;		/* bytes in this request */
1381 	uint16_t rw_mincnt;
1382 	uint32_t rw_total;		/* total bytes (write-raw) */
1383 	uint16_t rw_dsoff;		/* SMB data offset */
1384 	uint8_t rw_andx;		/* SMB secondary andx command */
1385 } smb_rw_param_t;
1386 
1387 typedef struct smb_pathname {
1388 	char	*pn_path;
1389 	char	*pn_pname;
1390 	char	*pn_fname;
1391 	char	*pn_sname;
1392 	char	*pn_stype;
1393 } smb_pathname_t;
1394 
1395 /*
1396  * fs_query_info
1397  */
1398 typedef struct smb_fqi {
1399 	smb_pathname_t	fq_path;
1400 	uint16_t	fq_sattr;
1401 	smb_node_t	*fq_dnode;
1402 	smb_node_t	*fq_fnode;
1403 	smb_attr_t	fq_fattr;
1404 	char		fq_last_comp[MAXNAMELEN];
1405 } smb_fqi_t;
1406 
1407 typedef struct dirop {
1408 	smb_fqi_t	fqi;
1409 	smb_fqi_t	dst_fqi;
1410 	uint16_t	info_level;
1411 	uint16_t	flags;
1412 } smb_arg_dirop_t;
1413 
1414 typedef struct {
1415 	uint32_t status;
1416 	uint16_t errcls;
1417 	uint16_t errcode;
1418 } smb_error_t;
1419 
1420 typedef struct open_param {
1421 	smb_fqi_t	fqi;
1422 	uint16_t	omode;
1423 	uint16_t	ofun;
1424 	uint32_t	nt_flags;
1425 	uint32_t	timeo;
1426 	uint32_t	dattr;
1427 	timestruc_t	crtime;
1428 	timestruc_t	mtime;
1429 	uint64_t	dsize;
1430 	uint32_t	desired_access;
1431 	uint32_t	share_access;
1432 	uint32_t	create_options;
1433 	uint32_t	create_disposition;
1434 	boolean_t	created_readonly;
1435 	uint32_t	ftype;
1436 	uint32_t	devstate;
1437 	uint32_t	action_taken;
1438 	uint64_t	fileid;
1439 	uint32_t	rootdirfid;
1440 	smb_ofile_t	*dir;
1441 	/* This is only set by NTTransactCreate */
1442 	struct smb_sd	*sd;
1443 	uint8_t		op_oplock_level;	/* requested/granted level */
1444 	boolean_t	op_oplock_levelII;	/* TRUE if levelII supported */
1445 } smb_arg_open_t;
1446 
1447 /*
1448  * SMB Request State Machine
1449  * -------------------------
1450  *
1451  *                  T4               +------+		T0
1452  *      +--------------------------->| FREE |---------------------------+
1453  *      |                            +------+                           |
1454  * +-----------+                                                        |
1455  * | COMPLETED |                                                        |
1456  * +-----------+
1457  *      ^                                                               |
1458  *      | T15                      +----------+                         v
1459  * +------------+        T6        |          |                 +--------------+
1460  * | CLEANED_UP |<-----------------| CANCELED |                 | INITIALIZING |
1461  * +------------+                  |          |                 +--------------+
1462  *      |    ^                     +----------+                         |
1463  *      |    |                        ^  ^ ^ ^                          |
1464  *      |    |          +-------------+  | | |                          |
1465  *      |    |    T3    |                | | |               T13        | T1
1466  *      |    +-------------------------+ | | +----------------------+   |
1467  *      +----------------------------+ | | |                        |   |
1468  *         T16          |            | | | +-----------+            |   |
1469  *                      |           \/ | | T5          |            |   v
1470  * +-----------------+  |   T12     +--------+         |     T2    +-----------+
1471  * | EVENT_OCCURRED  |------------->| ACTIVE |<--------------------| SUBMITTED |
1472  * +-----------------+  |           +--------+         |           +-----------+
1473  *        ^             |              | ^ |           |
1474  *        |             |           T8 | | |  T7       |
1475  *        | T10      T9 |   +----------+ | +-------+   |  T11
1476  *        |             |   |            +-------+ |   |
1477  *        |             |   |               T14  | |   |
1478  *        |             |   v                    | v   |
1479  *      +----------------------+                +--------------+
1480  *	|     WAITING_EVENT    |                | WAITING_LOCK |
1481  *      +----------------------+                +--------------+
1482  *
1483  *
1484  *
1485  *
1486  *
1487  * Transition T0
1488  *
1489  * This transition occurs when the request is allocated and is still under the
1490  * control of the session thread.
1491  *
1492  * Transition T1
1493  *
1494  * This transition occurs when the session thread dispatches a task to treat the
1495  * request.
1496  *
1497  * Transition T2
1498  *
1499  *
1500  *
1501  * Transition T3
1502  *
1503  * A request completes and smbsr_cleanup is called to release resources
1504  * associated with the request (but not the smb_request_t itself).  This
1505  * includes references on smb_ofile_t, smb_node_t, and other structures.
1506  * CLEANED_UP state exists to detect if we attempt to cleanup a request
1507  * multiple times and to allow us to detect that we are accessing a
1508  * request that has already been cleaned up.
1509  *
1510  * Transition T4
1511  *
1512  *
1513  *
1514  * Transition T5
1515  *
1516  *
1517  *
1518  * Transition T6
1519  *
1520  *
1521  *
1522  * Transition T7
1523  *
1524  *
1525  *
1526  * Transition T8
1527  *
1528  *
1529  *
1530  * Transition T9
1531  *
1532  *
1533  *
1534  * Transition T10
1535  *
1536  *
1537  *
1538  * Transition T11
1539  *
1540  *
1541  *
1542  * Transition T12
1543  *
1544  *
1545  *
1546  * Transition T13
1547  *
1548  *
1549  *
1550  * Transition T14
1551  *
1552  *
1553  *
1554  * Transition T15
1555  *
1556  * Request processing is completed (control returns from smb_dispatch)
1557  *
1558  * Transition T16
1559  *
1560  * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx"
1561  * sections remain to be processed.
1562  *
1563  */
1564 
1565 #define	SMB_REQ_MAGIC 		0x534D4252	/* 'SMBR' */
1566 #define	SMB_REQ_VALID(p)	ASSERT((p)->sr_magic == SMB_REQ_MAGIC)
1567 
1568 typedef enum smb_req_state {
1569 	SMB_REQ_STATE_FREE = 0,
1570 	SMB_REQ_STATE_INITIALIZING,
1571 	SMB_REQ_STATE_SUBMITTED,
1572 	SMB_REQ_STATE_ACTIVE,
1573 	SMB_REQ_STATE_WAITING_EVENT,
1574 	SMB_REQ_STATE_EVENT_OCCURRED,
1575 	SMB_REQ_STATE_WAITING_LOCK,
1576 	SMB_REQ_STATE_COMPLETED,
1577 	SMB_REQ_STATE_CANCELED,
1578 	SMB_REQ_STATE_CLEANED_UP,
1579 	SMB_REQ_STATE_SENTINEL
1580 } smb_req_state_t;
1581 
1582 typedef struct smb_request {
1583 	uint32_t		sr_magic;
1584 	kmutex_t		sr_mutex;
1585 	list_node_t		sr_session_lnd;
1586 	smb_req_state_t		sr_state;
1587 	struct smb_server	*sr_server;
1588 	pid_t			*sr_pid;
1589 	int32_t			sr_gmtoff;
1590 	smb_session_t		*session;
1591 	smb_kmod_cfg_t		*sr_cfg;
1592 	smb_notify_change_req_t	sr_ncr;
1593 
1594 	/* Info from session service header */
1595 	uint32_t		sr_req_length; /* Excluding NBT header */
1596 
1597 	/* Request buffer excluding NBT header */
1598 	void			*sr_request_buf;
1599 
1600 	smb_lock_t		*sr_awaiting;
1601 	struct mbuf_chain	command;
1602 	struct mbuf_chain	reply;
1603 	struct mbuf_chain	raw_data;
1604 	list_t			sr_storage;
1605 	struct smb_xa		*r_xa;
1606 	int			andx_prev_wct;
1607 	int 			cur_reply_offset;
1608 	int			orig_request_hdr;
1609 	unsigned int		reply_seqnum;	/* reply sequence number */
1610 	unsigned char		first_smb_com;	/* command code */
1611 	unsigned char		smb_com;	/* command code */
1612 
1613 	uint8_t			smb_rcls;	/* error code class */
1614 	uint8_t			smb_reh;	/* rsvd (AH DOS INT-24 ERR) */
1615 	uint16_t		smb_err;	/* error code */
1616 	smb_error_t		smb_error;
1617 
1618 	uint8_t			smb_flg;	/* flags */
1619 	uint16_t		smb_flg2;	/* flags */
1620 	uint16_t		smb_pid_high;	/* high part of pid */
1621 	unsigned char		smb_sig[8];	/* signiture */
1622 	uint16_t		smb_tid;	/* tree id #  */
1623 	uint16_t		smb_pid;	/* caller's process id # */
1624 	uint16_t		smb_uid;	/* user id # */
1625 	uint16_t		smb_mid;	/* mutiplex id #  */
1626 	unsigned char		smb_wct;	/* count of parameter words */
1627 	uint16_t		smb_bcc;	/* data byte count */
1628 
1629 	/* Parameters */
1630 	struct mbuf_chain	smb_vwv;	/* variable width value */
1631 
1632 	/* Data */
1633 	struct mbuf_chain	smb_data;
1634 
1635 	uint16_t		smb_fid;	/* not in hdr, but common */
1636 
1637 	unsigned char		andx_com;
1638 	uint16_t		andx_off;
1639 
1640 	struct smb_tree		*tid_tree;
1641 	struct smb_ofile	*fid_ofile;
1642 	smb_user_t		*uid_user;
1643 
1644 	union {
1645 		smb_arg_negotiate_t	*negprot;
1646 		smb_arg_sessionsetup_t	*ssetup;
1647 		smb_arg_tcon_t		tcon;
1648 		smb_arg_dirop_t		dirop;
1649 		smb_arg_open_t		open;
1650 		smb_rw_param_t		*rw;
1651 		int32_t			timestamp;
1652 	} arg;
1653 
1654 	cred_t			*user_cr;
1655 	kthread_t		*sr_worker;
1656 	hrtime_t		sr_time_submitted;
1657 	hrtime_t		sr_time_active;
1658 	hrtime_t		sr_time_start;
1659 	int32_t			sr_txb;
1660 	uint32_t		sr_seqnum;
1661 } smb_request_t;
1662 
1663 #define	sr_ssetup	arg.ssetup
1664 #define	sr_negprot	arg.negprot
1665 #define	sr_tcon		arg.tcon
1666 #define	sr_dirop	arg.dirop
1667 #define	sr_open		arg.open
1668 #define	sr_rw		arg.rw
1669 #define	sr_timestamp	arg.timestamp
1670 
1671 #define	SMB_READ_PROTOCOL(hdr) \
1672 	LE_IN32(((smb_hdr_t *)(hdr))->protocol)
1673 
1674 #define	SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \
1675 	(SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC)
1676 
1677 #define	SMB_READ_COMMAND(hdr) \
1678 	(((smb_hdr_t *)(hdr))->command)
1679 
1680 #define	SMB_IS_NT_CANCEL(rd_sr) \
1681 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NT_CANCEL)
1682 
1683 #define	SMB_IS_SESSION_SETUP_ANDX(rd_sr) \
1684 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == \
1685 	    SMB_COM_SESSION_SETUP_ANDX)
1686 
1687 #define	SMB_IS_NT_NEGOTIATE(rd_sr) \
1688 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NEGOTIATE)
1689 
1690 #define	SMB_IS_TREE_CONNECT_ANDX(rd_sr) \
1691 	(SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_TREE_CONNECT_ANDX)
1692 
1693 #define	SMB_XA_FLAG_OPEN	0x0001
1694 #define	SMB_XA_FLAG_CLOSE	0x0002
1695 #define	SMB_XA_FLAG_COMPLETE	0x0004
1696 #define	SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN))
1697 
1698 #define	SMB_XA_MAGIC		0x534D4258	/* 'SMBX' */
1699 
1700 typedef struct smb_xa {
1701 	uint32_t		xa_magic;
1702 	kmutex_t		xa_mutex;
1703 	list_node_t		xa_lnd;
1704 
1705 	uint32_t		xa_refcnt;
1706 	uint32_t		xa_flags;
1707 
1708 	struct smb_session	*xa_session;
1709 
1710 	unsigned char		smb_com;	/* which TRANS type */
1711 	unsigned char		smb_flg;	/* flags */
1712 	uint16_t		smb_flg2;	/* flags */
1713 	uint16_t		smb_tid;	/* tree id number */
1714 	uint16_t		smb_pid;	/* caller's process id number */
1715 	uint16_t		smb_uid;	/* user id number */
1716 	uint32_t		smb_func;	/* NT_TRANS function */
1717 
1718 	uint16_t		xa_smb_mid;	/* mutiplex id number */
1719 	uint16_t		xa_smb_fid;	/* TRANS2 secondary */
1720 
1721 	unsigned int		reply_seqnum;	/* reply sequence number */
1722 
1723 	uint32_t	smb_tpscnt;	/* total parameter bytes being sent */
1724 	uint32_t	smb_tdscnt;	/* total data bytes being sent */
1725 	uint32_t	smb_mprcnt;	/* max parameter bytes to return */
1726 	uint32_t	smb_mdrcnt;	/* max data bytes to return */
1727 	uint32_t	smb_msrcnt;	/* max setup words to return */
1728 	uint32_t	smb_flags;	/* additional information: */
1729 				/*  bit 0 - if set, disconnect TID in smb_tid */
1730 				/*  bit 1 - if set, transaction is one way */
1731 				/*  (no final response) */
1732 	int32_t	smb_timeout;	/* number of milliseconds to await completion */
1733 	uint32_t	smb_suwcnt;	/* set up word count */
1734 
1735 	char			*xa_pipe_name;
1736 
1737 	/*
1738 	 * These are the param and data count received so far,
1739 	 * used to decide if the whole trans is here yet.
1740 	 */
1741 	int			req_disp_param;
1742 	int			req_disp_data;
1743 
1744 	struct mbuf_chain	req_setup_mb;
1745 	struct mbuf_chain	req_param_mb;
1746 	struct mbuf_chain	req_data_mb;
1747 
1748 	struct mbuf_chain	rep_setup_mb;
1749 	struct mbuf_chain	rep_param_mb;
1750 	struct mbuf_chain	rep_data_mb;
1751 } smb_xa_t;
1752 
1753 
1754 #define	SDDF_NO_FLAGS			0
1755 #define	SDDF_SUPPRESS_TID		0x0001
1756 #define	SDDF_SUPPRESS_UID		0x0002
1757 
1758 /*
1759  * SMB dispatch return codes.
1760  */
1761 typedef enum {
1762 	SDRC_SUCCESS = 0,
1763 	SDRC_ERROR,
1764 	SDRC_DROP_VC,
1765 	SDRC_NO_REPLY,
1766 	SDRC_SR_KEPT,
1767 	SDRC_NOT_IMPLEMENTED
1768 } smb_sdrc_t;
1769 
1770 #define	VAR_BCC		((short)-1)
1771 
1772 #define	SMB_SERVER_MAGIC	0x53534552	/* 'SSER' */
1773 #define	SMB_SERVER_VALID(s)	\
1774     ASSERT(((s) != NULL) && ((s)->sv_magic == SMB_SERVER_MAGIC))
1775 
1776 #define	SMB_LISTENER_MAGIC	0x4C53544E	/* 'LSTN' */
1777 #define	SMB_LISTENER_VALID(ld)	\
1778     ASSERT(((ld) != NULL) && ((ld)->ld_magic == SMB_LISTENER_MAGIC))
1779 
1780 typedef struct {
1781 	uint32_t		ld_magic;
1782 	struct smb_server	*ld_sv;
1783 	smb_thread_t		ld_thread;
1784 	ksocket_t		ld_so;
1785 	in_port_t		ld_port;
1786 	int			ld_family;
1787 	struct sockaddr_in	ld_sin;
1788 	struct sockaddr_in6	ld_sin6;
1789 	smb_llist_t		ld_session_list;
1790 } smb_listener_daemon_t;
1791 
1792 #define	SMB_SSETUP_CMD			"authentication"
1793 #define	SMB_TCON_CMD			"share mapping"
1794 #define	SMB_OPIPE_CMD			"pipe open"
1795 #define	SMB_THRESHOLD_REPORT_THROTTLE	50
1796 typedef struct smb_cmd_threshold {
1797 	char			*ct_cmd;
1798 	kmutex_t		ct_mutex;
1799 	volatile uint32_t	ct_active_cnt;
1800 	volatile uint32_t	ct_blocked_cnt;
1801 	uint32_t		ct_threshold;
1802 	uint32_t		ct_timeout; /* milliseconds */
1803 	kcondvar_t		ct_cond;
1804 } smb_cmd_threshold_t;
1805 
1806 typedef struct {
1807 	kstat_named_t		ls_files;
1808 	kstat_named_t		ls_trees;
1809 	kstat_named_t		ls_users;
1810 } smb_server_legacy_kstat_t;
1811 
1812 typedef enum smb_server_state {
1813 	SMB_SERVER_STATE_CREATED = 0,
1814 	SMB_SERVER_STATE_CONFIGURED,
1815 	SMB_SERVER_STATE_RUNNING,
1816 	SMB_SERVER_STATE_STOPPING,
1817 	SMB_SERVER_STATE_DELETING,
1818 	SMB_SERVER_STATE_SENTINEL
1819 } smb_server_state_t;
1820 
1821 typedef struct {
1822 	/* protected by sv_mutex */
1823 	kcondvar_t		sp_cv;
1824 	uint32_t 		sp_cnt;
1825 	smb_llist_t		sp_list;
1826 	smb_llist_t		sp_fidlist;
1827 } smb_spool_t;
1828 
1829 #define	SMB_SERVER_STATE_VALID(S)               \
1830     ASSERT(((S) == SMB_SERVER_STATE_CREATED) || \
1831 	    ((S) == SMB_SERVER_STATE_CONFIGURED) || \
1832 	    ((S) == SMB_SERVER_STATE_RUNNING) ||    \
1833 	    ((S) == SMB_SERVER_STATE_STOPPING) ||   \
1834 	    ((S) == SMB_SERVER_STATE_DELETING))
1835 
1836 typedef struct smb_server {
1837 	uint32_t		sv_magic;
1838 	kcondvar_t		sv_cv;
1839 	kmutex_t		sv_mutex;
1840 	list_node_t		sv_lnd;
1841 	smb_server_state_t	sv_state;
1842 	uint32_t		sv_refcnt;
1843 	pid_t			sv_pid;
1844 	zoneid_t		sv_zid;
1845 	smb_listener_daemon_t	sv_nbt_daemon;
1846 	smb_listener_daemon_t	sv_tcp_daemon;
1847 	krwlock_t		sv_cfg_lock;
1848 	smb_kmod_cfg_t		sv_cfg;
1849 	smb_session_t		*sv_session;
1850 
1851 	struct smb_export	sv_export;
1852 	door_handle_t		sv_lmshrd;
1853 
1854 	/* Internal door for up-calls to smbd */
1855 	door_handle_t		sv_kdoor_hd;
1856 	int			sv_kdoor_id; /* init -1 */
1857 	uint64_t		sv_kdoor_ncall;
1858 	kmutex_t		sv_kdoor_mutex;
1859 	kcondvar_t		sv_kdoor_cv;
1860 
1861 	/* RPC pipes (client side) */
1862 	door_handle_t		sv_opipe_door_hd;
1863 	int			sv_opipe_door_id;
1864 	uint64_t		sv_opipe_door_ncall;
1865 	kmutex_t		sv_opipe_door_mutex;
1866 	kcondvar_t		sv_opipe_door_cv;
1867 
1868 	int32_t			si_gmtoff;
1869 
1870 	smb_thread_t		si_thread_timers;
1871 
1872 	taskq_t			*sv_worker_pool;
1873 	taskq_t			*sv_receiver_pool;
1874 
1875 	smb_node_t		*si_root_smb_node;
1876 	smb_llist_t		sv_opipe_list;
1877 	smb_llist_t		sv_event_list;
1878 
1879 	/* Statistics */
1880 	hrtime_t		sv_start_time;
1881 	kstat_t			*sv_ksp;
1882 	volatile uint32_t	sv_nbt_sess;
1883 	volatile uint32_t	sv_tcp_sess;
1884 	volatile uint32_t	sv_users;
1885 	volatile uint32_t	sv_trees;
1886 	volatile uint32_t	sv_files;
1887 	volatile uint32_t	sv_pipes;
1888 	volatile uint64_t	sv_txb;
1889 	volatile uint64_t	sv_rxb;
1890 	volatile uint64_t	sv_nreq;
1891 	smb_srqueue_t		sv_srqueue;
1892 	smb_spool_t		sp_info;
1893 	smb_cmd_threshold_t	sv_ssetup_ct;
1894 	smb_cmd_threshold_t	sv_tcon_ct;
1895 	smb_cmd_threshold_t	sv_opipe_ct;
1896 	kstat_t			*sv_legacy_ksp;
1897 	kmutex_t		sv_legacy_ksmtx;
1898 	smb_disp_stats_t	*sv_disp_stats;
1899 } smb_server_t;
1900 
1901 #define	SMB_EVENT_MAGIC		0x45564E54	/* EVNT */
1902 #define	SMB_EVENT_TIMEOUT	45		/* seconds */
1903 #define	SMB_EVENT_VALID(e)	\
1904     ASSERT(((e) != NULL) && ((e)->se_magic == SMB_EVENT_MAGIC))
1905 typedef struct smb_event {
1906 	uint32_t		se_magic;
1907 	list_node_t		se_lnd;
1908 	kmutex_t		se_mutex;
1909 	kcondvar_t		se_cv;
1910 	smb_server_t		*se_server;
1911 	uint32_t		se_txid;
1912 	boolean_t		se_notified;
1913 	int			se_waittime;
1914 	int			se_timeout;
1915 	int			se_errno;
1916 } smb_event_t;
1917 
1918 typedef struct smb_kspooldoc {
1919 	uint32_t	sd_magic;
1920 	list_node_t	sd_lnd;
1921 	smb_inaddr_t	sd_ipaddr;
1922 	uint32_t	sd_spool_num;
1923 	uint16_t	sd_fid;
1924 	char		sd_username[MAXNAMELEN];
1925 	char		sd_path[MAXPATHLEN];
1926 } smb_kspooldoc_t;
1927 
1928 typedef struct smb_spoolfid {
1929 	uint32_t	sf_magic;
1930 	list_node_t	sf_lnd;
1931 	uint16_t	sf_fid;
1932 } smb_spoolfid_t;
1933 
1934 #define	SMB_INFO_NETBIOS_SESSION_SVC_RUNNING	0x0001
1935 #define	SMB_INFO_NETBIOS_SESSION_SVC_FAILED	0x0002
1936 #define	SMB_INFO_USER_LEVEL_SECURITY		0x40000000
1937 #define	SMB_INFO_ENCRYPT_PASSWORDS		0x80000000
1938 
1939 #define	SMB_NEW_KID()	atomic_inc_64_nv(&smb_kids)
1940 #define	SMB_UNIQ_FID()	atomic_inc_32_nv(&smb_fids)
1941 
1942 #define	SMB_IS_STREAM(node) ((node)->n_unode)
1943 
1944 typedef struct smb_tsd {
1945 	void (*proc)();
1946 	void *arg;
1947 	char name[100];
1948 } smb_tsd_t;
1949 
1950 typedef struct smb_disp_entry {
1951 	char		sdt_name[KSTAT_STRLEN];
1952 	smb_sdrc_t	(*sdt_pre_op)(smb_request_t *);
1953 	smb_sdrc_t	(*sdt_function)(smb_request_t *);
1954 	void		(*sdt_post_op)(smb_request_t *);
1955 	uint8_t		sdt_com;
1956 	char		sdt_dialect;
1957 	uint8_t		sdt_flags;
1958 } smb_disp_entry_t;
1959 
1960 typedef struct smb_xlate {
1961 	int	code;
1962 	char	*str;
1963 } smb_xlate_t;
1964 
1965 /*
1966  * This structure is a helper for building RAP NetShareEnum response
1967  *
1968  * es_posix_uid UID of the user requesting the shares list which
1969  *              is used to detect if the user has any autohome
1970  * es_bufsize   size of the response buffer
1971  * es_buf       pointer to the response buffer
1972  * es_ntotal    total number of shares exported by server which
1973  *              their OEM names is less then 13 chars
1974  * es_nsent     number of shares that can fit in the specified buffer
1975  * es_datasize  actual data size (share's data) which was encoded
1976  *              in the response buffer
1977  */
1978 typedef struct smb_enumshare_info {
1979 	uid_t		es_posix_uid;
1980 	uint16_t	es_bufsize;
1981 	char		*es_buf;
1982 	uint16_t	es_ntotal;
1983 	uint16_t	es_nsent;
1984 	uint16_t	es_datasize;
1985 } smb_enumshare_info_t;
1986 
1987 #ifdef	__cplusplus
1988 }
1989 #endif
1990 
1991 #endif /* _SMBSRV_SMB_KTYPES_H */
1992