xref: /titanic_52/usr/src/uts/common/sys/netstack.h (revision 7ddc9b1afd18f260b9fb78ec7732facd91769131)
1f4b3ec61Sdh155122 /*
2f4b3ec61Sdh155122  * CDDL HEADER START
3f4b3ec61Sdh155122  *
4f4b3ec61Sdh155122  * The contents of this file are subject to the terms of the
5f4b3ec61Sdh155122  * Common Development and Distribution License (the "License").
6f4b3ec61Sdh155122  * You may not use this file except in compliance with the License.
7f4b3ec61Sdh155122  *
8f4b3ec61Sdh155122  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9f4b3ec61Sdh155122  * or http://www.opensolaris.org/os/licensing.
10f4b3ec61Sdh155122  * See the License for the specific language governing permissions
11f4b3ec61Sdh155122  * and limitations under the License.
12f4b3ec61Sdh155122  *
13f4b3ec61Sdh155122  * When distributing Covered Code, include this CDDL HEADER in each
14f4b3ec61Sdh155122  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15f4b3ec61Sdh155122  * If applicable, add the following below this CDDL HEADER, with the
16f4b3ec61Sdh155122  * fields enclosed by brackets "[]" replaced with your own identifying
17f4b3ec61Sdh155122  * information: Portions Copyright [yyyy] [name of copyright owner]
18f4b3ec61Sdh155122  *
19f4b3ec61Sdh155122  * CDDL HEADER END
20f4b3ec61Sdh155122  */
21f4b3ec61Sdh155122 
22f4b3ec61Sdh155122 /*
23bd41d0a8Snordmark  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
24f4b3ec61Sdh155122  * Use is subject to license terms.
25f4b3ec61Sdh155122  */
26f4b3ec61Sdh155122 #ifndef _SYS_NETSTACK_H
27f4b3ec61Sdh155122 #define	_SYS_NETSTACK_H
28f4b3ec61Sdh155122 
29f4b3ec61Sdh155122 #include <sys/kstat.h>
30f4b3ec61Sdh155122 
31f4b3ec61Sdh155122 #ifdef	__cplusplus
32f4b3ec61Sdh155122 extern "C" {
33f4b3ec61Sdh155122 #endif
34f4b3ec61Sdh155122 
35f4b3ec61Sdh155122 /*
36f4b3ec61Sdh155122  * This allows various pieces in and around IP to have a separate instance
37f4b3ec61Sdh155122  * for each instance of IP. This is used to support zones that have an
38f4b3ec61Sdh155122  * exclusive stack.
39f4b3ec61Sdh155122  * Pieces of software far removed from IP (e.g., kernel software
40f4b3ec61Sdh155122  * sitting on top of TCP or UDP) probably should not use the netstack
41f4b3ec61Sdh155122  * support; if such software wants to support separate zones it
42f4b3ec61Sdh155122  * can do that using the zones framework (zone_key_create() etc)
43f4b3ec61Sdh155122  * whether there is a shared IP stack or and exclusive IP stack underneath.
44f4b3ec61Sdh155122  */
45f4b3ec61Sdh155122 
46f4b3ec61Sdh155122 /*
47f4b3ec61Sdh155122  * Each netstack has an identifier. We reuse the zoneid allocation for
48f4b3ec61Sdh155122  * this but have a separate typedef. Thus the shared stack (used by
49f4b3ec61Sdh155122  * the global zone and other shared stack zones) have a zero ID, and
50f4b3ec61Sdh155122  * the exclusive stacks have a netstackid that is the same as their zoneid.
51f4b3ec61Sdh155122  */
52f4b3ec61Sdh155122 typedef id_t	netstackid_t;
53f4b3ec61Sdh155122 
54f4b3ec61Sdh155122 #define	GLOBAL_NETSTACKID	0
55f4b3ec61Sdh155122 
56f4b3ec61Sdh155122 /*
57f4b3ec61Sdh155122  * One for each module which uses netstack support.
58f4b3ec61Sdh155122  * Used in netstack_register().
59f4b3ec61Sdh155122  *
60f4b3ec61Sdh155122  * The order of these is important for some modules both for
61f4b3ec61Sdh155122  * the creation (which done in ascending order) and destruction (which is
62f4b3ec61Sdh155122  * done ine in decending order).
63f4b3ec61Sdh155122  */
6423f4867fSnordmark #define	NS_ALL		-1	/* Match all */
65*7ddc9b1aSDarren Reed #define	NS_STR		0	/* autopush list etc */
66*7ddc9b1aSDarren Reed #define	NS_HOOK		1
67*7ddc9b1aSDarren Reed #define	NS_NETI		2
68*7ddc9b1aSDarren Reed #define	NS_ARP		3
69*7ddc9b1aSDarren Reed #define	NS_IP		4
70*7ddc9b1aSDarren Reed #define	NS_ICMP		5
71*7ddc9b1aSDarren Reed #define	NS_UDP		6
72*7ddc9b1aSDarren Reed #define	NS_TCP		7
73*7ddc9b1aSDarren Reed #define	NS_SCTP		8
74*7ddc9b1aSDarren Reed #define	NS_RTS		9
75*7ddc9b1aSDarren Reed #define	NS_IPSEC	10
76*7ddc9b1aSDarren Reed #define	NS_KEYSOCK	11
77*7ddc9b1aSDarren Reed #define	NS_SPDSOCK	12
78*7ddc9b1aSDarren Reed #define	NS_IPSECAH	13
79*7ddc9b1aSDarren Reed #define	NS_IPSECESP	14
80*7ddc9b1aSDarren Reed #define	NS_TUN		15
81*7ddc9b1aSDarren Reed #define	NS_MAX		(NS_TUN+1)
82f4b3ec61Sdh155122 
83f4b3ec61Sdh155122 /*
84bd41d0a8Snordmark  * State maintained for each module which tracks the state of
85bd41d0a8Snordmark  * the create, shutdown and destroy callbacks.
86bd41d0a8Snordmark  *
87bd41d0a8Snordmark  * Keeps track of pending actions to avoid holding locks when
88bd41d0a8Snordmark  * calling into the create/shutdown/destroy functions in the module.
89bd41d0a8Snordmark  */
90bd41d0a8Snordmark #ifdef _KERNEL
91bd41d0a8Snordmark typedef struct {
92bd41d0a8Snordmark 	uint16_t 	nms_flags;
93bd41d0a8Snordmark 	kcondvar_t	nms_cv;
94bd41d0a8Snordmark } nm_state_t;
95bd41d0a8Snordmark 
96bd41d0a8Snordmark /*
97bd41d0a8Snordmark  * nms_flags
98bd41d0a8Snordmark  */
99bd41d0a8Snordmark #define	NSS_CREATE_NEEDED	0x0001
100bd41d0a8Snordmark #define	NSS_CREATE_INPROGRESS	0x0002
101bd41d0a8Snordmark #define	NSS_CREATE_COMPLETED	0x0004
102bd41d0a8Snordmark #define	NSS_SHUTDOWN_NEEDED	0x0010
103bd41d0a8Snordmark #define	NSS_SHUTDOWN_INPROGRESS	0x0020
104bd41d0a8Snordmark #define	NSS_SHUTDOWN_COMPLETED	0x0040
105bd41d0a8Snordmark #define	NSS_DESTROY_NEEDED	0x0100
106bd41d0a8Snordmark #define	NSS_DESTROY_INPROGRESS	0x0200
107bd41d0a8Snordmark #define	NSS_DESTROY_COMPLETED	0x0400
108bd41d0a8Snordmark 
109bd41d0a8Snordmark #define	NSS_CREATE_ALL	\
110bd41d0a8Snordmark 	(NSS_CREATE_NEEDED|NSS_CREATE_INPROGRESS|NSS_CREATE_COMPLETED)
111bd41d0a8Snordmark #define	NSS_SHUTDOWN_ALL	\
112bd41d0a8Snordmark 	(NSS_SHUTDOWN_NEEDED|NSS_SHUTDOWN_INPROGRESS|NSS_SHUTDOWN_COMPLETED)
113bd41d0a8Snordmark #define	NSS_DESTROY_ALL	\
114bd41d0a8Snordmark 	(NSS_DESTROY_NEEDED|NSS_DESTROY_INPROGRESS|NSS_DESTROY_COMPLETED)
115bd41d0a8Snordmark 
116bd41d0a8Snordmark #define	NSS_ALL_INPROGRESS	\
117bd41d0a8Snordmark 	(NSS_CREATE_INPROGRESS|NSS_SHUTDOWN_INPROGRESS|NSS_DESTROY_INPROGRESS)
118bd41d0a8Snordmark #else
119bd41d0a8Snordmark /* User-level compile like IP Filter needs a netstack_t. Dummy */
120bd41d0a8Snordmark typedef uint_t nm_state_t;
121bd41d0a8Snordmark #endif /* _KERNEL */
122bd41d0a8Snordmark 
123bd41d0a8Snordmark /*
124f4b3ec61Sdh155122  * One for every netstack in the system.
125f4b3ec61Sdh155122  * We use a union so that the compilar and lint can provide type checking -
126f4b3ec61Sdh155122  * in principle we could have
127f4b3ec61Sdh155122  * #define	netstack_arp		netstack_modules[NS_ARP]
128f4b3ec61Sdh155122  * etc, but that would imply void * types hence no type checking by the
129f4b3ec61Sdh155122  * compiler.
130f4b3ec61Sdh155122  *
131f4b3ec61Sdh155122  * All the fields in netstack_t except netstack_next are protected by
132f4b3ec61Sdh155122  * netstack_lock. netstack_next is protected by netstack_g_lock.
133f4b3ec61Sdh155122  */
134f4b3ec61Sdh155122 struct netstack {
135f4b3ec61Sdh155122 	union {
136f4b3ec61Sdh155122 		void	*nu_modules[NS_MAX];
137f4b3ec61Sdh155122 		struct {
138*7ddc9b1aSDarren Reed 			struct str_stack	*nu_str;
139f4b3ec61Sdh155122 			struct hook_stack	*nu_hook;
140f4b3ec61Sdh155122 			struct neti_stack	*nu_neti;
141f4b3ec61Sdh155122 			struct arp_stack	*nu_arp;
142f4b3ec61Sdh155122 			struct ip_stack		*nu_ip;
143f4b3ec61Sdh155122 			struct icmp_stack	*nu_icmp;
144f4b3ec61Sdh155122 			struct udp_stack	*nu_udp;
145f4b3ec61Sdh155122 			struct tcp_stack	*nu_tcp;
146f4b3ec61Sdh155122 			struct sctp_stack	*nu_sctp;
147f4b3ec61Sdh155122 			struct rts_stack	*nu_rts;
148f4b3ec61Sdh155122 			struct ipsec_stack	*nu_ipsec;
149f4b3ec61Sdh155122 			struct keysock_stack	*nu_keysock;
150f4b3ec61Sdh155122 			struct spd_stack	*nu_spdsock;
151f4b3ec61Sdh155122 			struct ipsecah_stack	*nu_ipsecah;
152f4b3ec61Sdh155122 			struct ipsecesp_stack	*nu_ipsecesp;
153f4b3ec61Sdh155122 			struct tun_stack	*nu_tun;
154f4b3ec61Sdh155122 		} nu_s;
155f4b3ec61Sdh155122 	} netstack_u;
156f4b3ec61Sdh155122 #define	netstack_modules	netstack_u.nu_modules
157*7ddc9b1aSDarren Reed #define	netstack_str		netstack_u.nu_s.nu_str
158f4b3ec61Sdh155122 #define	netstack_hook		netstack_u.nu_s.nu_hook
159f4b3ec61Sdh155122 #define	netstack_neti		netstack_u.nu_s.nu_neti
160f4b3ec61Sdh155122 #define	netstack_arp		netstack_u.nu_s.nu_arp
161f4b3ec61Sdh155122 #define	netstack_ip		netstack_u.nu_s.nu_ip
162f4b3ec61Sdh155122 #define	netstack_icmp		netstack_u.nu_s.nu_icmp
163f4b3ec61Sdh155122 #define	netstack_udp		netstack_u.nu_s.nu_udp
164f4b3ec61Sdh155122 #define	netstack_tcp		netstack_u.nu_s.nu_tcp
165f4b3ec61Sdh155122 #define	netstack_sctp		netstack_u.nu_s.nu_sctp
166f4b3ec61Sdh155122 #define	netstack_rts		netstack_u.nu_s.nu_rts
167f4b3ec61Sdh155122 #define	netstack_ipsec		netstack_u.nu_s.nu_ipsec
168f4b3ec61Sdh155122 #define	netstack_keysock	netstack_u.nu_s.nu_keysock
169f4b3ec61Sdh155122 #define	netstack_spdsock	netstack_u.nu_s.nu_spdsock
170f4b3ec61Sdh155122 #define	netstack_ipsecah	netstack_u.nu_s.nu_ipsecah
171f4b3ec61Sdh155122 #define	netstack_ipsecesp	netstack_u.nu_s.nu_ipsecesp
172f4b3ec61Sdh155122 #define	netstack_tun		netstack_u.nu_s.nu_tun
173f4b3ec61Sdh155122 
174bd41d0a8Snordmark 	nm_state_t	netstack_m_state[NS_MAX]; /* module state */
175f4b3ec61Sdh155122 
176f4b3ec61Sdh155122 	kmutex_t	netstack_lock;
177f4b3ec61Sdh155122 	struct netstack *netstack_next;
178f4b3ec61Sdh155122 	netstackid_t	netstack_stackid;
179f4b3ec61Sdh155122 	int		netstack_numzones;	/* Number of zones using this */
180f4b3ec61Sdh155122 	int		netstack_refcnt;	/* Number of hold-rele */
181f4b3ec61Sdh155122 	int		netstack_flags;	/* See below */
182bd41d0a8Snordmark 
183bd41d0a8Snordmark #ifdef _KERNEL
184bd41d0a8Snordmark 	/* Needed to ensure that we run the callback functions in order */
185bd41d0a8Snordmark 	kcondvar_t	netstack_cv;
186bd41d0a8Snordmark #endif
187f4b3ec61Sdh155122 };
188f4b3ec61Sdh155122 typedef struct netstack netstack_t;
189f4b3ec61Sdh155122 
190f4b3ec61Sdh155122 /* netstack_flags values */
191f4b3ec61Sdh155122 #define	NSF_UNINIT		0x01		/* Not initialized */
192f4b3ec61Sdh155122 #define	NSF_CLOSING		0x02		/* Going away */
193bd41d0a8Snordmark #define	NSF_ZONE_CREATE		0x04		/* create callbacks inprog */
194bd41d0a8Snordmark #define	NSF_ZONE_SHUTDOWN	0x08		/* shutdown callbacks */
195bd41d0a8Snordmark #define	NSF_ZONE_DESTROY	0x10		/* destroy callbacks */
196f4b3ec61Sdh155122 
197bd41d0a8Snordmark #define	NSF_ZONE_INPROGRESS	\
198bd41d0a8Snordmark 	(NSF_ZONE_CREATE|NSF_ZONE_SHUTDOWN|NSF_ZONE_DESTROY)
199f4b3ec61Sdh155122 
200f4b3ec61Sdh155122 /*
201f4b3ec61Sdh155122  * One for each of the NS_* values.
202f4b3ec61Sdh155122  */
203f4b3ec61Sdh155122 struct netstack_registry {
204f4b3ec61Sdh155122 	int		nr_flags;	/* 0 if nothing registered */
205f4b3ec61Sdh155122 	void		*(*nr_create)(netstackid_t, netstack_t *);
206f4b3ec61Sdh155122 	void		(*nr_shutdown)(netstackid_t, void *);
207f4b3ec61Sdh155122 	void		(*nr_destroy)(netstackid_t, void *);
208f4b3ec61Sdh155122 };
209f4b3ec61Sdh155122 
210f4b3ec61Sdh155122 /* nr_flags values */
211f4b3ec61Sdh155122 #define	NRF_REGISTERED	0x01
212bd41d0a8Snordmark #define	NRF_DYING	0x02	/* No new creates */
213f4b3ec61Sdh155122 
214f4b3ec61Sdh155122 /*
215f4b3ec61Sdh155122  * To support kstat_create_netstack() using kstat_add_zone we need
216f4b3ec61Sdh155122  * to track both
217f4b3ec61Sdh155122  *  - all zoneids that use the global/shared stack
218f4b3ec61Sdh155122  *  - all kstats that have been added for the shared stack
219f4b3ec61Sdh155122  */
220f4b3ec61Sdh155122 
221f4b3ec61Sdh155122 extern void netstack_init(void);
222f4b3ec61Sdh155122 extern void netstack_hold(netstack_t *);
223f4b3ec61Sdh155122 extern void netstack_rele(netstack_t *);
224f4b3ec61Sdh155122 extern netstack_t *netstack_find_by_cred(const cred_t *);
225f4b3ec61Sdh155122 extern netstack_t *netstack_find_by_stackid(netstackid_t);
226f4b3ec61Sdh155122 extern netstack_t *netstack_find_by_zoneid(zoneid_t);
227f4b3ec61Sdh155122 
228f4b3ec61Sdh155122 extern zoneid_t netstackid_to_zoneid(netstackid_t);
229f4b3ec61Sdh155122 extern netstackid_t zoneid_to_netstackid(zoneid_t);
230f4b3ec61Sdh155122 
231fd006805Snordmark extern netstack_t *netstack_get_current(void);
232fd006805Snordmark 
233f4b3ec61Sdh155122 /*
234f4b3ec61Sdh155122  * Register interest in changes to the set of netstacks.
235f4b3ec61Sdh155122  * The createfn and destroyfn are required, but the shutdownfn can be
236f4b3ec61Sdh155122  * NULL.
237f4b3ec61Sdh155122  * Note that due to the current zsd implementation, when the create
238f4b3ec61Sdh155122  * function is called the zone isn't fully present, thus functions
239f4b3ec61Sdh155122  * like zone_find_by_* will fail, hence the create function can not
240f4b3ec61Sdh155122  * use many zones kernel functions including zcmn_err().
241f4b3ec61Sdh155122  */
242f4b3ec61Sdh155122 extern void	netstack_register(int,
243f4b3ec61Sdh155122     void *(*)(netstackid_t, netstack_t *),
244f4b3ec61Sdh155122     void (*)(netstackid_t, void *),
245f4b3ec61Sdh155122     void (*)(netstackid_t, void *));
246f4b3ec61Sdh155122 extern void	netstack_unregister(int);
247f4b3ec61Sdh155122 extern kstat_t	*kstat_create_netstack(char *, int, char *, char *, uchar_t,
248f4b3ec61Sdh155122     uint_t, uchar_t, netstackid_t);
249f4b3ec61Sdh155122 extern void	kstat_delete_netstack(kstat_t *, netstackid_t);
250f4b3ec61Sdh155122 
251f4b3ec61Sdh155122 /*
252f4b3ec61Sdh155122  * Simple support for walking all the netstacks.
253f4b3ec61Sdh155122  * The caller of netstack_next() needs to call netstack_rele() when
254f4b3ec61Sdh155122  * done with a netstack.
255f4b3ec61Sdh155122  */
256f4b3ec61Sdh155122 typedef	int	netstack_handle_t;
257f4b3ec61Sdh155122 
258f4b3ec61Sdh155122 extern void	netstack_next_init(netstack_handle_t *);
259f4b3ec61Sdh155122 extern void	netstack_next_fini(netstack_handle_t *);
260f4b3ec61Sdh155122 extern netstack_t	*netstack_next(netstack_handle_t *);
261f4b3ec61Sdh155122 
262f4b3ec61Sdh155122 #ifdef	__cplusplus
263f4b3ec61Sdh155122 }
264f4b3ec61Sdh155122 #endif
265f4b3ec61Sdh155122 
266f4b3ec61Sdh155122 
267f4b3ec61Sdh155122 #endif	/* _SYS_NETSTACK_H */
268