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