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