1381a2a9aSdr146992 /* 2381a2a9aSdr146992 * CDDL HEADER START 3381a2a9aSdr146992 * 4381a2a9aSdr146992 * The contents of this file are subject to the terms of the 5381a2a9aSdr146992 * Common Development and Distribution License (the "License"). 6381a2a9aSdr146992 * You may not use this file except in compliance with the License. 7381a2a9aSdr146992 * 8381a2a9aSdr146992 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9381a2a9aSdr146992 * or http://www.opensolaris.org/os/licensing. 10381a2a9aSdr146992 * See the License for the specific language governing permissions 11381a2a9aSdr146992 * and limitations under the License. 12381a2a9aSdr146992 * 13381a2a9aSdr146992 * When distributing Covered Code, include this CDDL HEADER in each 14381a2a9aSdr146992 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15381a2a9aSdr146992 * If applicable, add the following below this CDDL HEADER, with the 16381a2a9aSdr146992 * fields enclosed by brackets "[]" replaced with your own identifying 17381a2a9aSdr146992 * information: Portions Copyright [yyyy] [name of copyright owner] 18381a2a9aSdr146992 * 19381a2a9aSdr146992 * CDDL HEADER END 20381a2a9aSdr146992 */ 21381a2a9aSdr146992 /* 220a0e9771SDarren Reed * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23381a2a9aSdr146992 * Use is subject to license terms. 24*b22a70abSPatrick Mooney * 25*b22a70abSPatrick Mooney * Copyright 2018, Joyent, Inc. 26381a2a9aSdr146992 */ 27381a2a9aSdr146992 28381a2a9aSdr146992 #ifndef _SYS_NETI_H 29381a2a9aSdr146992 #define _SYS_NETI_H 30381a2a9aSdr146992 31381a2a9aSdr146992 #include <netinet/in.h> 32381a2a9aSdr146992 #include <sys/int_types.h> 33381a2a9aSdr146992 #include <sys/queue.h> 34381a2a9aSdr146992 #include <sys/hook_impl.h> 35f4b3ec61Sdh155122 #include <sys/netstack.h> 36381a2a9aSdr146992 37381a2a9aSdr146992 #ifdef __cplusplus 38381a2a9aSdr146992 extern "C" { 39381a2a9aSdr146992 #endif 40381a2a9aSdr146992 4133697085SGordon Ross struct msgb; /* avoiding sys/stream.h here */ 4233697085SGordon Ross 43381a2a9aSdr146992 #define NETINFO_VERSION 1 44381a2a9aSdr146992 45381a2a9aSdr146992 /* 46381a2a9aSdr146992 * Network hooks framework stack protocol name 47381a2a9aSdr146992 */ 48381a2a9aSdr146992 #define NHF_INET "NHF_INET" 49381a2a9aSdr146992 #define NHF_INET6 "NHF_INET6" 50381a2a9aSdr146992 #define NHF_ARP "NHF_ARP" 51*b22a70abSPatrick Mooney #define NHF_VIONA "NHF_VIONA" 52381a2a9aSdr146992 53381a2a9aSdr146992 /* 54381a2a9aSdr146992 * Event identification 55381a2a9aSdr146992 */ 56381a2a9aSdr146992 #define NH_PHYSICAL_IN "PHYSICAL_IN" 57381a2a9aSdr146992 #define NH_PHYSICAL_OUT "PHYSICAL_OUT" 58381a2a9aSdr146992 #define NH_FORWARDING "FORWARDING" 59381a2a9aSdr146992 #define NH_LOOPBACK_IN "LOOPBACK_IN" 60381a2a9aSdr146992 #define NH_LOOPBACK_OUT "LOOPBACK_OUT" 61381a2a9aSdr146992 #define NH_NIC_EVENTS "NIC_EVENTS" 620a0e9771SDarren Reed #define NH_OBSERVE "OBSERVING" 63381a2a9aSdr146992 64381a2a9aSdr146992 /* 65381a2a9aSdr146992 * Network NIC hardware checksum capability 66381a2a9aSdr146992 */ 67381a2a9aSdr146992 #define NET_HCK_NONE 0x00 68381a2a9aSdr146992 #define NET_HCK_L3_FULL 0x01 69381a2a9aSdr146992 #define NET_HCK_L3_PART 0x02 70381a2a9aSdr146992 #define NET_HCK_L4_FULL 0x10 71381a2a9aSdr146992 #define NET_HCK_L4_PART 0x20 72381a2a9aSdr146992 73381a2a9aSdr146992 #define NET_IS_HCK_L3_FULL(n, x) \ 74381a2a9aSdr146992 ((net_ispartialchecksum(n, x) & NET_HCK_L3_FULL) == NET_HCK_L3_FULL) 75381a2a9aSdr146992 #define NET_IS_HCK_L3_PART(n, x) \ 76381a2a9aSdr146992 ((net_ispartialchecksum(n, x) & NET_HCK_L3_PART) == NET_HCK_L3_PART) 77381a2a9aSdr146992 #define NET_IS_HCK_L4_FULL(n, x) \ 78381a2a9aSdr146992 ((net_ispartialchecksum(n, x) & NET_HCK_L4_FULL) == NET_HCK_L4_FULL) 79381a2a9aSdr146992 #define NET_IS_HCK_L4_PART(n, x) \ 80381a2a9aSdr146992 ((net_ispartialchecksum(n, x) & NET_HCK_L4_PART) == NET_HCK_L4_PART) 81381a2a9aSdr146992 #define NET_IS_HCK_L34_FULL(n, x) \ 82381a2a9aSdr146992 ((net_ispartialchecksum(n, x) & (NET_HCK_L3_FULL|NET_HCK_L4_FULL)) \ 83381a2a9aSdr146992 == (NET_HCK_L3_FULL | NET_HCK_L4_FULL)) 84381a2a9aSdr146992 85381a2a9aSdr146992 typedef uintptr_t phy_if_t; 86381a2a9aSdr146992 typedef intptr_t lif_if_t; 87381a2a9aSdr146992 typedef uintptr_t net_ifdata_t; 887ddc9b1aSDarren Reed typedef id_t netid_t; 89381a2a9aSdr146992 90381a2a9aSdr146992 /* 91381a2a9aSdr146992 * Netinfo interface specification 92381a2a9aSdr146992 * 93381a2a9aSdr146992 * Netinfo provides an extensible and easy to use interface for 94381a2a9aSdr146992 * accessing data and functionality already embedded within network 95381a2a9aSdr146992 * code that exists within the kernel. 96381a2a9aSdr146992 */ 97381a2a9aSdr146992 typedef enum net_ifaddr { 98381a2a9aSdr146992 NA_ADDRESS = 1, 99381a2a9aSdr146992 NA_PEER, 100381a2a9aSdr146992 NA_BROADCAST, 101381a2a9aSdr146992 NA_NETMASK 102381a2a9aSdr146992 } net_ifaddr_t; 103381a2a9aSdr146992 104381a2a9aSdr146992 105381a2a9aSdr146992 typedef enum inject { 106381a2a9aSdr146992 NI_QUEUE_IN = 1, 107381a2a9aSdr146992 NI_QUEUE_OUT, 108381a2a9aSdr146992 NI_DIRECT_OUT 109381a2a9aSdr146992 } inject_t; 110381a2a9aSdr146992 1117ddc9b1aSDarren Reed /* 1127ddc9b1aSDarren Reed * net_inject - public interface 1137ddc9b1aSDarren Reed */ 114381a2a9aSdr146992 typedef struct net_inject { 1157ddc9b1aSDarren Reed int ni_version; 1167ddc9b1aSDarren Reed netid_t ni_netid; 11733697085SGordon Ross struct msgb *ni_packet; 118381a2a9aSdr146992 struct sockaddr_storage ni_addr; 119381a2a9aSdr146992 phy_if_t ni_physical; 120381a2a9aSdr146992 } net_inject_t; 121381a2a9aSdr146992 1227ddc9b1aSDarren Reed typedef struct net_data *net_handle_t; 123381a2a9aSdr146992 124381a2a9aSdr146992 /* 1257ddc9b1aSDarren Reed * net_protocol_t private interface 126381a2a9aSdr146992 */ 1277ddc9b1aSDarren Reed struct net_protocol_s { 1287ddc9b1aSDarren Reed int netp_version; 1297ddc9b1aSDarren Reed char *netp_name; 1307ddc9b1aSDarren Reed int (*netp_getifname)(net_handle_t, phy_if_t, char *, 1317ddc9b1aSDarren Reed const size_t); 1327ddc9b1aSDarren Reed int (*netp_getmtu)(net_handle_t, phy_if_t, lif_if_t); 1337ddc9b1aSDarren Reed int (*netp_getpmtuenabled)(net_handle_t); 1347ddc9b1aSDarren Reed int (*netp_getlifaddr)(net_handle_t, phy_if_t, lif_if_t, 1357ddc9b1aSDarren Reed size_t, net_ifaddr_t [], void *); 136b127ac41SPhilip Kirk int (*neti_getlifzone)(net_handle_t, phy_if_t, lif_if_t, 137b127ac41SPhilip Kirk zoneid_t *); 138b127ac41SPhilip Kirk int (*neti_getlifflags)(net_handle_t, phy_if_t, lif_if_t, 139b127ac41SPhilip Kirk uint64_t *); 1407ddc9b1aSDarren Reed phy_if_t (*netp_phygetnext)(net_handle_t, phy_if_t); 1417ddc9b1aSDarren Reed phy_if_t (*netp_phylookup)(net_handle_t, const char *); 1427ddc9b1aSDarren Reed lif_if_t (*netp_lifgetnext)(net_handle_t, phy_if_t, lif_if_t); 1437ddc9b1aSDarren Reed int (*netp_inject)(net_handle_t, inject_t, net_inject_t *); 1447ddc9b1aSDarren Reed phy_if_t (*netp_routeto)(net_handle_t, struct sockaddr *, 1457ddc9b1aSDarren Reed struct sockaddr *); 14633697085SGordon Ross int (*netp_ispartialchecksum)(net_handle_t, struct msgb *); 14733697085SGordon Ross int (*netp_isvalidchecksum)(net_handle_t, struct msgb *); 1487ddc9b1aSDarren Reed }; 1497ddc9b1aSDarren Reed typedef struct net_protocol_s net_protocol_t; 150381a2a9aSdr146992 151381a2a9aSdr146992 152381a2a9aSdr146992 /* 153381a2a9aSdr146992 * Private data structures 154381a2a9aSdr146992 */ 155381a2a9aSdr146992 struct net_data { 156381a2a9aSdr146992 LIST_ENTRY(net_data) netd_list; 1577ddc9b1aSDarren Reed net_protocol_t netd_info; 158381a2a9aSdr146992 int netd_refcnt; 159381a2a9aSdr146992 hook_family_int_t *netd_hooks; 1607ddc9b1aSDarren Reed struct neti_stack_s *netd_stack; 1617ddc9b1aSDarren Reed int netd_condemned; 162381a2a9aSdr146992 }; 163381a2a9aSdr146992 164381a2a9aSdr146992 165381a2a9aSdr146992 typedef struct injection_s { 166381a2a9aSdr146992 net_inject_t inj_data; 167381a2a9aSdr146992 boolean_t inj_isv6; 168f4b3ec61Sdh155122 void * inj_ptr; 169381a2a9aSdr146992 } injection_t; 170381a2a9aSdr146992 171381a2a9aSdr146992 /* 172381a2a9aSdr146992 * The ipif_id space is [0,MAX) but this interface wants to return [1,MAX] as 173381a2a9aSdr146992 * a valid range of logical interface numbers so that it can return 0 to mean 174381a2a9aSdr146992 * "end of list" with net_lifgetnext. Changing ipif_id's to use the [1,MAX] 175381a2a9aSdr146992 * space is something to be considered for the future, if it is worthwhile. 176381a2a9aSdr146992 */ 177381a2a9aSdr146992 #define MAP_IPIF_ID(x) ((x) + 1) 178381a2a9aSdr146992 #define UNMAP_IPIF_ID(x) (((x) > 0) ? (x) - 1 : (x)) 179381a2a9aSdr146992 1807ddc9b1aSDarren Reed struct net_instance_s { 1817ddc9b1aSDarren Reed int nin_version; 1827ddc9b1aSDarren Reed char *nin_name; 1837ddc9b1aSDarren Reed void *(*nin_create)(const netid_t); 1847ddc9b1aSDarren Reed void (*nin_destroy)(const netid_t, void *); 1857ddc9b1aSDarren Reed void (*nin_shutdown)(const netid_t, void *); 186f4b3ec61Sdh155122 }; 1877ddc9b1aSDarren Reed typedef struct net_instance_s net_instance_t; 188f4b3ec61Sdh155122 1897ddc9b1aSDarren Reed struct net_instance_int_s { 1907ddc9b1aSDarren Reed LIST_ENTRY(net_instance_int_s) nini_next; 1918ad74188SDarren Reed uint_t nini_ref; 1927ddc9b1aSDarren Reed void *nini_created; 1937ddc9b1aSDarren Reed struct net_instance_int_s *nini_parent; 1947ddc9b1aSDarren Reed net_instance_t *nini_instance; 1957ddc9b1aSDarren Reed hook_notify_t nini_notify; 1967ddc9b1aSDarren Reed uint32_t nini_flags; 1977ddc9b1aSDarren Reed kcondvar_t nini_cv; 1988ad74188SDarren Reed boolean_t nini_condemned; 1997ddc9b1aSDarren Reed }; 2007ddc9b1aSDarren Reed typedef struct net_instance_int_s net_instance_int_t; 2017ddc9b1aSDarren Reed LIST_HEAD(nini_head_s, net_instance_int_s); 2027ddc9b1aSDarren Reed typedef struct nini_head_s nini_head_t; 2037ddc9b1aSDarren Reed 2047ddc9b1aSDarren Reed #define nini_version nini_instance->nin_version 2057ddc9b1aSDarren Reed #define nini_name nini_instance->nin_name 2067ddc9b1aSDarren Reed #define nini_create nini_instance->nin_create 2077ddc9b1aSDarren Reed #define nini_destroy nini_instance->nin_destroy 2087ddc9b1aSDarren Reed #define nini_shutdown nini_instance->nin_shutdown 209f4b3ec61Sdh155122 210f4b3ec61Sdh155122 /* 2117ddc9b1aSDarren Reed * netinfo stack instances 212381a2a9aSdr146992 */ 2137ddc9b1aSDarren Reed struct neti_stack_s { 2147ddc9b1aSDarren Reed kmutex_t nts_lock; 2157ddc9b1aSDarren Reed LIST_ENTRY(neti_stack_s) nts_next; 2167ddc9b1aSDarren Reed netid_t nts_id; 2177ddc9b1aSDarren Reed zoneid_t nts_zoneid; 2187ddc9b1aSDarren Reed netstackid_t nts_stackid; 2197ddc9b1aSDarren Reed netstack_t *nts_netstack; 2207ddc9b1aSDarren Reed nini_head_t nts_instances; 2217ddc9b1aSDarren Reed uint32_t nts_flags; 2227ddc9b1aSDarren Reed kcondvar_t nts_cv; 2237ddc9b1aSDarren Reed /* list of net_handle_t */ 2247ddc9b1aSDarren Reed LIST_HEAD(netd_listhead, net_data) nts_netd_head; 2257ddc9b1aSDarren Reed }; 2267ddc9b1aSDarren Reed typedef struct neti_stack_s neti_stack_t; 2277ddc9b1aSDarren Reed LIST_HEAD(neti_stack_head_s, neti_stack_s); 2287ddc9b1aSDarren Reed typedef struct neti_stack_head_s neti_stack_head_t; 229381a2a9aSdr146992 230381a2a9aSdr146992 /* 2317ddc9b1aSDarren Reed * Internal functions that need to be exported within the module. 232381a2a9aSdr146992 */ 2337ddc9b1aSDarren Reed extern void neti_init(void); 2347ddc9b1aSDarren Reed extern void neti_fini(void); 2357ddc9b1aSDarren Reed extern neti_stack_t *net_getnetistackbyid(netid_t); 2367ddc9b1aSDarren Reed extern netstackid_t net_getnetstackidbynetid(netid_t); 2377ddc9b1aSDarren Reed extern netid_t net_getnetidbynetstackid(netstackid_t); 2387ddc9b1aSDarren Reed extern netid_t net_zoneidtonetid(zoneid_t); 2397ddc9b1aSDarren Reed extern zoneid_t net_getzoneidbynetid(netid_t); 2407ddc9b1aSDarren Reed 2417ddc9b1aSDarren Reed /* 2427ddc9b1aSDarren Reed * Functions available for public use. 2437ddc9b1aSDarren Reed */ 2447ddc9b1aSDarren Reed extern hook_event_token_t net_event_register(net_handle_t, hook_event_t *); 2458ad74188SDarren Reed extern int net_event_shutdown(net_handle_t, hook_event_t *); 2467ddc9b1aSDarren Reed extern int net_event_unregister(net_handle_t, hook_event_t *); 2477ddc9b1aSDarren Reed extern int net_event_notify_register(net_handle_t, char *, 2487ddc9b1aSDarren Reed hook_notify_fn_t, void *); 2497ddc9b1aSDarren Reed extern int net_event_notify_unregister(net_handle_t, char *, hook_notify_fn_t); 2507ddc9b1aSDarren Reed 2517ddc9b1aSDarren Reed extern int net_family_register(net_handle_t, hook_family_t *); 2528ad74188SDarren Reed extern int net_family_shutdown(net_handle_t, hook_family_t *); 2537ddc9b1aSDarren Reed extern int net_family_unregister(net_handle_t, hook_family_t *); 2547ddc9b1aSDarren Reed 2557ddc9b1aSDarren Reed extern int net_hook_register(net_handle_t, char *, hook_t *); 2567ddc9b1aSDarren Reed extern int net_hook_unregister(net_handle_t, char *, hook_t *); 2577ddc9b1aSDarren Reed 2587ddc9b1aSDarren Reed extern int net_inject(net_handle_t, inject_t, net_inject_t *); 2597ddc9b1aSDarren Reed extern net_inject_t *net_inject_alloc(const int); 2607ddc9b1aSDarren Reed extern void net_inject_free(net_inject_t *); 2617ddc9b1aSDarren Reed 2627ddc9b1aSDarren Reed extern net_instance_t *net_instance_alloc(const int version); 2637ddc9b1aSDarren Reed extern void net_instance_free(net_instance_t *); 2647ddc9b1aSDarren Reed extern int net_instance_register(net_instance_t *); 2657ddc9b1aSDarren Reed extern int net_instance_unregister(net_instance_t *); 2667ddc9b1aSDarren Reed extern int net_instance_notify_register(netid_t, hook_notify_fn_t, void *); 2677ddc9b1aSDarren Reed extern int net_instance_notify_unregister(netid_t netid, hook_notify_fn_t); 2687ddc9b1aSDarren Reed 2697ddc9b1aSDarren Reed extern kstat_t *net_kstat_create(netid_t, char *, int, char *, char *, 2707ddc9b1aSDarren Reed uchar_t, ulong_t, uchar_t); 2717ddc9b1aSDarren Reed extern void net_kstat_delete(netid_t, kstat_t *); 2727ddc9b1aSDarren Reed 2737ddc9b1aSDarren Reed extern net_handle_t net_protocol_lookup(netid_t, const char *); 2747ddc9b1aSDarren Reed extern net_handle_t net_protocol_register(netid_t, const net_protocol_t *); 2757ddc9b1aSDarren Reed extern int net_protocol_release(net_handle_t); 2767ddc9b1aSDarren Reed extern int net_protocol_unregister(net_handle_t); 2777ddc9b1aSDarren Reed extern net_handle_t net_protocol_walk(netid_t, net_handle_t); 2787ddc9b1aSDarren Reed extern int net_protocol_notify_register(net_handle_t, hook_notify_fn_t, void *); 2797ddc9b1aSDarren Reed extern int net_protocol_notify_unregister(net_handle_t, hook_notify_fn_t); 2807ddc9b1aSDarren Reed 2817ddc9b1aSDarren Reed 2827ddc9b1aSDarren Reed extern int net_getifname(net_handle_t, phy_if_t, char *, const size_t); 2837ddc9b1aSDarren Reed extern int net_getmtu(net_handle_t, phy_if_t, lif_if_t); 2847ddc9b1aSDarren Reed extern int net_getpmtuenabled(net_handle_t); 2857ddc9b1aSDarren Reed extern int net_getlifaddr(net_handle_t, phy_if_t, lif_if_t, 286381a2a9aSdr146992 int, net_ifaddr_t [], void *); 287b127ac41SPhilip Kirk extern zoneid_t net_getlifzone(net_handle_t, phy_if_t, lif_if_t, zoneid_t *); 288b127ac41SPhilip Kirk extern int net_getlifflags(net_handle_t, phy_if_t, lif_if_t, uint64_t *); 2897ddc9b1aSDarren Reed extern phy_if_t net_phygetnext(net_handle_t, phy_if_t); 2907ddc9b1aSDarren Reed extern phy_if_t net_phylookup(net_handle_t, const char *); 2917ddc9b1aSDarren Reed extern lif_if_t net_lifgetnext(net_handle_t, phy_if_t, lif_if_t); 2927ddc9b1aSDarren Reed extern phy_if_t net_routeto(net_handle_t, struct sockaddr *, 2937ddc9b1aSDarren Reed struct sockaddr *); 29433697085SGordon Ross extern int net_ispartialchecksum(net_handle_t, struct msgb *); 29533697085SGordon Ross extern int net_isvalidchecksum(net_handle_t, struct msgb *); 296381a2a9aSdr146992 297381a2a9aSdr146992 #ifdef __cplusplus 298381a2a9aSdr146992 } 299381a2a9aSdr146992 #endif 300381a2a9aSdr146992 301381a2a9aSdr146992 #endif /* _SYS_NETI_H */ 302