netstack.h revision 2b24ab6b3865caeede9eeb9db6b83e1d89dcd1ea
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2009 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _SYS_NETSTACK_H
#define _SYS_NETSTACK_H
#ifdef __cplusplus
extern "C" {
#endif
/*
* This allows various pieces in and around IP to have a separate instance
* for each instance of IP. This is used to support zones that have an
* exclusive stack.
* Pieces of software far removed from IP (e.g., kernel software
* sitting on top of TCP or UDP) probably should not use the netstack
* support; if such software wants to support separate zones it
* can do that using the zones framework (zone_key_create() etc)
* whether there is a shared IP stack or and exclusive IP stack underneath.
*/
/*
* Each netstack has an identifier. We reuse the zoneid allocation for
* this but have a separate typedef. Thus the shared stack (used by
* the global zone and other shared stack zones) have a zero ID, and
* the exclusive stacks have a netstackid that is the same as their zoneid.
*/
typedef id_t netstackid_t;
#define GLOBAL_NETSTACKID 0
/*
* One for each module which uses netstack support.
* Used in netstack_register().
*
* The order of these is important for some modules both for
* the creation (which done in ascending order) and destruction (which is
* done in in decending order).
*/
#define NS_DLS 0
#define NS_IPTUN 1
#define NS_HOOK 3
#define NS_NETI 4
#define NS_ARP 5
#define NS_IP 6
#define NS_ICMP 7
#define NS_UDP 8
#define NS_TCP 9
#define NS_SCTP 10
#define NS_RTS 11
#define NS_IPSEC 12
#define NS_KEYSOCK 13
#define NS_SPDSOCK 14
#define NS_IPSECAH 15
#define NS_IPSECESP 16
#define NS_IPNET 17
/*
* State maintained for each module which tracks the state of
* the create, shutdown and destroy callbacks.
*
* Keeps track of pending actions to avoid holding locks when
*/
#ifdef _KERNEL
typedef struct {
} nm_state_t;
/*
* nms_flags
*/
#define NSS_CREATE_NEEDED 0x0001
#define NSS_CREATE_INPROGRESS 0x0002
#define NSS_CREATE_COMPLETED 0x0004
#define NSS_SHUTDOWN_NEEDED 0x0010
#define NSS_SHUTDOWN_INPROGRESS 0x0020
#define NSS_SHUTDOWN_COMPLETED 0x0040
#define NSS_DESTROY_NEEDED 0x0100
#define NSS_DESTROY_INPROGRESS 0x0200
#define NSS_DESTROY_COMPLETED 0x0400
#define NSS_CREATE_ALL \
#define NSS_SHUTDOWN_ALL \
#define NSS_DESTROY_ALL \
#define NSS_ALL_INPROGRESS \
#else
/* User-level compile like IP Filter needs a netstack_t. Dummy */
typedef uint_t nm_state_t;
#endif /* _KERNEL */
/*
* One for every netstack in the system.
* We use a union so that the compilar and lint can provide type checking -
* in principle we could have
* #define netstack_arp netstack_modules[NS_ARP]
* etc, but that would imply void * types hence no type checking by the
* compiler.
*
* All the fields in netstack_t except netstack_next are protected by
* netstack_lock. netstack_next is protected by netstack_g_lock.
*/
struct netstack {
union {
void *nu_modules[NS_MAX];
struct {
struct iptun_stack *nu_iptun;
struct hook_stack *nu_hook;
struct neti_stack *nu_neti;
struct icmp_stack *nu_icmp;
struct sctp_stack *nu_sctp;
struct ipsec_stack *nu_ipsec;
struct keysock_stack *nu_keysock;
struct spd_stack *nu_spdsock;
struct ipsecah_stack *nu_ipsecah;
struct ipsecesp_stack *nu_ipsecesp;
struct ipnet_stack *nu_ipnet;
} nu_s;
} netstack_u;
struct netstack *netstack_next;
int netstack_numzones; /* Number of zones using this */
int netstack_refcnt; /* Number of hold-rele */
int netstack_flags; /* See below */
#ifdef _KERNEL
/* Needed to ensure that we run the callback functions in order */
#endif
};
typedef struct netstack netstack_t;
/* netstack_flags values */
#define NSF_ZONE_INPROGRESS \
/*
* One for each of the NS_* values.
*/
struct netstack_registry {
int nr_flags; /* 0 if nothing registered */
void (*nr_shutdown)(netstackid_t, void *);
void (*nr_destroy)(netstackid_t, void *);
};
/* nr_flags values */
#define NRF_REGISTERED 0x01
/*
* To support kstat_create_netstack() using kstat_add_zone we need
* to track both
* - all kstats that have been added for the shared stack
*/
extern void netstack_init(void);
extern void netstack_hold(netstack_t *);
extern void netstack_rele(netstack_t *);
extern netstack_t *netstack_get_current(void);
/*
* Register interest in changes to the set of netstacks.
* The createfn and destroyfn are required, but the shutdownfn can be
* NULL.
* Note that due to the current zsd implementation, when the create
* function is called the zone isn't fully present, thus functions
* like zone_find_by_* will fail, hence the create function can not
* use many zones kernel functions including zcmn_err().
*/
extern void netstack_register(int,
void *(*)(netstackid_t, netstack_t *),
void (*)(netstackid_t, void *),
void (*)(netstackid_t, void *));
extern void netstack_unregister(int);
/*
* Simple support for walking all the netstacks.
* The caller of netstack_next() needs to call netstack_rele() when
* done with a netstack.
*/
typedef int netstack_handle_t;
extern void netstack_next_init(netstack_handle_t *);
extern void netstack_next_fini(netstack_handle_t *);
#ifdef __cplusplus
}
#endif
#endif /* _SYS_NETSTACK_H */