xref: /onnv-gate/usr/src/uts/common/sys/logindmux_impl.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _SYS_LOGINDMUX_IMPL_H
28*0Sstevel@tonic-gate #define	_SYS_LOGINDMUX_IMPL_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/types.h>
33*0Sstevel@tonic-gate #include <sys/stream.h>
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate #ifdef	__cplusplus
36*0Sstevel@tonic-gate extern "C" {
37*0Sstevel@tonic-gate #endif
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate /*
41*0Sstevel@tonic-gate  * This structure is shared between two logindmux peer instances and
42*0Sstevel@tonic-gate  * ensures that only one of the peers will be actively processing an
43*0Sstevel@tonic-gate  * I_UNLINK ioctl at any one time.
44*0Sstevel@tonic-gate  */
45*0Sstevel@tonic-gate typedef struct unlinkinfo {
46*0Sstevel@tonic-gate 	kmutex_t	state_lock;	/* serialize access to state */
47*0Sstevel@tonic-gate 	int		state;		/* state of I_UNLINK operation */
48*0Sstevel@tonic-gate 	mblk_t		*prot_mp;	/* carries protocol messages */
49*0Sstevel@tonic-gate } unlinkinfo_t;
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate /*
52*0Sstevel@tonic-gate  * Logindmux state structure; one per open instance.
53*0Sstevel@tonic-gate  */
54*0Sstevel@tonic-gate struct tmx {
55*0Sstevel@tonic-gate 	queue_t		*rdq;		/* our mux upper read queue */
56*0Sstevel@tonic-gate 	queue_t		*muxq;		/* our mux lower write queue */
57*0Sstevel@tonic-gate 	queue_t		*peerq; 	/* peer mux lower write queue */
58*0Sstevel@tonic-gate 	minor_t		dev0;		/* our minor device number */
59*0Sstevel@tonic-gate 	boolean_t	isptm;		/* true if ptm is downstream */
60*0Sstevel@tonic-gate 	mblk_t		*unlink_mp;	/* mblk used in logdmux_unlink_timer */
61*0Sstevel@tonic-gate 	unlinkinfo_t	*unlinkinfop;	/* used during I_UNLINK processing */
62*0Sstevel@tonic-gate 	bufcall_id_t	wbufcid;	/* needed for recovery */
63*0Sstevel@tonic-gate 	bufcall_id_t	rbufcid;	/* needed for recovery */
64*0Sstevel@tonic-gate 	timeout_id_t	utimoutid;	/* unlink timer identifier */
65*0Sstevel@tonic-gate 	timeout_id_t	wtimoutid;	/* needed for recovery */
66*0Sstevel@tonic-gate 	timeout_id_t	rtimoutid;	/* needed for recovery */
67*0Sstevel@tonic-gate };
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate #define	LOGDMX_ID		107	/* module id number */
70*0Sstevel@tonic-gate 
71*0Sstevel@tonic-gate /*
72*0Sstevel@tonic-gate  * The arguments for calls to qtimeout, in microseconds.
73*0Sstevel@tonic-gate  */
74*0Sstevel@tonic-gate #define	SIMWAIT			100000	/* logdmux_timer */
75*0Sstevel@tonic-gate #define	LOGDMUX_POLL_WAIT	10	/* logdmux_unlink_timer */
76*0Sstevel@tonic-gate 
77*0Sstevel@tonic-gate /*
78*0Sstevel@tonic-gate  * State of peer linkage.
79*0Sstevel@tonic-gate  */
80*0Sstevel@tonic-gate enum {
81*0Sstevel@tonic-gate 	LOGDMUX_LINKED		= 1,	/* peer instances are in linked state */
82*0Sstevel@tonic-gate 	LOGDMUX_UNLINK_PENDING	= 2,	/* a peer is actively I_UNLINKing */
83*0Sstevel@tonic-gate 	LOGDMUX_UNLINKED	= 3	/* a peer has completed its I_UNLINK */
84*0Sstevel@tonic-gate };
85*0Sstevel@tonic-gate 
86*0Sstevel@tonic-gate /*
87*0Sstevel@tonic-gate  * Protocol message magic cookie.
88*0Sstevel@tonic-gate  */
89*0Sstevel@tonic-gate #define	LOGDMUX_MCTL		(LOGDMX_ID << 16)
90*0Sstevel@tonic-gate 
91*0Sstevel@tonic-gate /*
92*0Sstevel@tonic-gate  * peer to peer protocol messages.
93*0Sstevel@tonic-gate  */
94*0Sstevel@tonic-gate #define	LOGDMUX_UNLINK_REQ	(LOGDMUX_MCTL|1) /* peer wants to unlink */
95*0Sstevel@tonic-gate #define	LOGDMUX_UNLINK_RESP	(LOGDMUX_MCTL|2) /* ok for peer to unlink */
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate /*
98*0Sstevel@tonic-gate  * Macro to determine if an mblk is a logindmux protocol mblk.
99*0Sstevel@tonic-gate  */
100*0Sstevel@tonic-gate #define	LOGDMUX_PROTO_MBLK(mp)						   \
101*0Sstevel@tonic-gate 	((DB_TYPE(mp) == M_CTL)						&& \
102*0Sstevel@tonic-gate 	((mp)->b_cont != NULL)						&& \
103*0Sstevel@tonic-gate 	(DB_TYPE((mp)->b_cont) == M_IOCTL)				&& \
104*0Sstevel@tonic-gate 	(((struct iocblk *)((mp)->b_cont->b_rptr))->ioc_cmd == I_UNLINK))
105*0Sstevel@tonic-gate 
106*0Sstevel@tonic-gate 
107*0Sstevel@tonic-gate #ifdef	__cplusplus
108*0Sstevel@tonic-gate }
109*0Sstevel@tonic-gate #endif
110*0Sstevel@tonic-gate 
111*0Sstevel@tonic-gate #endif	/* _SYS_LOGINDMUX_IMPL_H */
112