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