1/* 2 * Copyright (c) 1999-2012 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28#ifndef DLIL_H 29#define DLIL_H 30#ifdef KERNEL 31 32#include <sys/kernel_types.h> 33#include <net/kpi_interface.h> 34 35enum { 36 BPF_TAP_DISABLE, 37 BPF_TAP_INPUT, 38 BPF_TAP_OUTPUT, 39 BPF_TAP_INPUT_OUTPUT 40}; 41 42/* 43 * DLIL_DESC_ETYPE2 - native_type must point to 2 byte ethernet raw protocol, 44 * variants.native_type_length must be set to 2 45 * DLIL_DESC_SAP - native_type must point to 3 byte SAP protocol 46 * variants.native_type_length must be set to 3 47 * DLIL_DESC_SNAP - native_type must point to 5 byte SNAP protocol 48 * variants.native_type_length must be set to 5 49 * 50 * All protocols must be in Network byte order. 51 * 52 * Future interface families may define more protocol types they know about. 53 * The type implies the offset and context of the protocol data at native_type. 54 * The length of the protocol data specified at native_type must be set in 55 * variants.native_type_length. 56 */ 57/* Ethernet specific types */ 58#define DLIL_DESC_ETYPE2 4 59#define DLIL_DESC_SAP 5 60#define DLIL_DESC_SNAP 6 61 62#ifdef KERNEL_PRIVATE 63#include <net/if.h> 64#include <net/if_var.h> 65#include <net/classq/classq.h> 66#include <net/flowadv.h> 67#include <sys/kern_event.h> 68#include <kern/thread.h> 69#include <kern/locks.h> 70 71#ifdef BSD_KERNEL_PRIVATE 72/* Operations on timespecs. */ 73#define net_timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_nsec = 0 74 75#define net_timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_nsec) 76 77#define net_timercmp(tvp, uvp, cmp) \ 78 (((tvp)->tv_sec == (uvp)->tv_sec) ? \ 79 ((tvp)->tv_nsec cmp (uvp)->tv_nsec) : \ 80 ((tvp)->tv_sec cmp (uvp)->tv_sec)) 81 82#define net_timeradd(tvp, uvp, vvp) do { \ 83 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \ 84 (vvp)->tv_nsec = (tvp)->tv_nsec + (uvp)->tv_nsec; \ 85 if ((vvp)->tv_nsec >= NSEC_PER_SEC) { \ 86 (vvp)->tv_sec++; \ 87 (vvp)->tv_nsec -= NSEC_PER_SEC; \ 88 } \ 89} while (0) 90 91#define net_timersub(tvp, uvp, vvp) do { \ 92 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \ 93 (vvp)->tv_nsec = (tvp)->tv_nsec - (uvp)->tv_nsec; \ 94 if ((vvp)->tv_nsec < 0) { \ 95 (vvp)->tv_sec--; \ 96 (vvp)->tv_nsec += NSEC_PER_SEC; \ 97 } \ 98} while (0) 99 100#define net_timernsec(tvp, nsp) do { \ 101 *(nsp) = (tvp)->tv_nsec; \ 102 if ((tvp)->tv_sec > 0) \ 103 *(nsp) += ((tvp)->tv_sec * NSEC_PER_SEC); \ 104} while (0) 105 106#define net_nsectimer(nsp, tvp) do { \ 107 u_int64_t __nsp = *(nsp); \ 108 net_timerclear(tvp); \ 109 while ((__nsp) >= NSEC_PER_SEC) { \ 110 (tvp)->tv_sec++; \ 111 (__nsp) -= NSEC_PER_SEC; \ 112 } \ 113 (tvp)->tv_nsec = (__nsp); \ 114} while (0) 115 116struct ifnet; 117struct mbuf; 118struct ether_header; 119struct sockaddr_dl; 120struct iff_filter; 121 122#define DLIL_THREADNAME_LEN 32 123 124/* 125 * DLIL input thread info 126 */ 127struct dlil_threading_info { 128 decl_lck_mtx_data(, input_lck); 129 lck_grp_t *lck_grp; /* lock group (for lock stats) */ 130 u_int32_t input_waiting; /* DLIL condition of thread */ 131 u_int32_t wtot; /* # of wakeup requests */ 132 char input_name[DLIL_THREADNAME_LEN]; /* name storage */ 133 struct ifnet *ifp; /* pointer to interface */ 134 class_queue_t rcvq_pkts; /* queue of pkts */ 135 struct ifnet_stat_increment_param stats; /* incremental statistics */ 136 /* 137 * Thread affinity (workloop and DLIL threads). 138 */ 139 boolean_t net_affinity; /* affinity set is available */ 140 struct thread *input_thr; /* input thread */ 141 struct thread *wloop_thr; /* workloop thread */ 142 struct thread *poll_thr; /* poll thread */ 143 u_int32_t tag; /* affinity tag */ 144 /* 145 * Opportunistic polling. 146 */ 147 ifnet_model_t mode; /* current mode */ 148 struct pktcntr tstats; /* incremental polling statistics */ 149 struct if_rxpoll_stats pstats; /* polling statistics */ 150#define rxpoll_offreq pstats.ifi_poll_off_req 151#define rxpoll_offerr pstats.ifi_poll_off_err 152#define rxpoll_onreq pstats.ifi_poll_on_req 153#define rxpoll_onerr pstats.ifi_poll_on_err 154#define rxpoll_wavg pstats.ifi_poll_wakeups_avg 155#define rxpoll_wlowat pstats.ifi_poll_wakeups_lowat 156#define rxpoll_whiwat pstats.ifi_poll_wakeups_hiwat 157#define rxpoll_pavg pstats.ifi_poll_packets_avg 158#define rxpoll_pmin pstats.ifi_poll_packets_min 159#define rxpoll_pmax pstats.ifi_poll_packets_max 160#define rxpoll_plowat pstats.ifi_poll_packets_lowat 161#define rxpoll_phiwat pstats.ifi_poll_packets_hiwat 162#define rxpoll_bavg pstats.ifi_poll_bytes_avg 163#define rxpoll_bmin pstats.ifi_poll_bytes_min 164#define rxpoll_bmax pstats.ifi_poll_bytes_max 165#define rxpoll_blowat pstats.ifi_poll_bytes_lowat 166#define rxpoll_bhiwat pstats.ifi_poll_bytes_hiwat 167 struct pktcntr sstats; /* packets and bytes per sampling */ 168 struct timespec mode_holdtime; /* mode holdtime in nsec */ 169 struct timespec mode_lasttime; /* last mode change time in nsec */ 170 struct timespec sample_holdtime; /* sampling holdtime in nsec */ 171 struct timespec sample_lasttime; /* last sampling time in nsec */ 172 struct timespec dbg_lasttime; /* last debug message time in nsec */ 173#if IFNET_INPUT_SANITY_CHK 174 /* 175 * For debugging. 176 */ 177 u_int64_t input_mbuf_cnt; /* total # of packets processed */ 178#endif 179}; 180 181/* 182 * DLIL input thread info (for main/loopback input thread) 183 */ 184struct dlil_main_threading_info { 185 struct dlil_threading_info inp; 186 class_queue_t lo_rcvq_pkts; /* queue of lo0 pkts */ 187}; 188 189/* 190 * The following are shared with kpi_protocol.c so that it may wakeup 191 * the input thread to run through packets queued for protocol input. 192*/ 193#define DLIL_INPUT_RUNNING 0x80000000 194#define DLIL_INPUT_WAITING 0x40000000 195#define DLIL_PROTO_REGISTER 0x20000000 196#define DLIL_PROTO_WAITING 0x10000000 197#define DLIL_INPUT_TERMINATE 0x08000000 198 199__private_extern__ struct dlil_threading_info *dlil_main_input_thread; 200 201extern void dlil_init(void); 202 203extern errno_t ifp_if_ioctl(struct ifnet *, unsigned long, void *); 204 205extern errno_t dlil_set_bpf_tap(ifnet_t, bpf_tap_mode, bpf_packet_func); 206 207/* 208 * Send arp internal bypasses the check for IPv4LL. 209 */ 210extern errno_t dlil_send_arp_internal(ifnet_t, u_int16_t, 211 const struct sockaddr_dl *, const struct sockaddr *, 212 const struct sockaddr_dl *, const struct sockaddr *); 213 214/* 215 * The following flags used to check if a network thread already 216 * owns the lock 217 */ 218#define NET_THREAD_HELD_PF 0x1 /* thread is holding PF lock */ 219#define NET_THREAD_HELD_DOMAIN 0x2 /* thread is holding domain_proto_mtx */ 220 221extern errno_t net_thread_check_lock(u_int32_t); 222extern void net_thread_set_lock(u_int32_t); 223extern void net_thread_unset_lock(u_int32_t); 224 225extern int dlil_output(ifnet_t, protocol_family_t, mbuf_t, void *, 226 const struct sockaddr *, int, struct flowadv *); 227 228extern void dlil_input_packet_list(struct ifnet *, struct mbuf *); 229extern void dlil_input_packet_list_extended(struct ifnet *, struct mbuf *, 230 u_int32_t, ifnet_model_t); 231 232extern errno_t dlil_resolve_multi(struct ifnet *, 233 const struct sockaddr *, struct sockaddr *, size_t); 234 235extern errno_t dlil_send_arp(ifnet_t, u_int16_t, const struct sockaddr_dl *, 236 const struct sockaddr *, const struct sockaddr_dl *, 237 const struct sockaddr *, u_int32_t); 238 239extern int dlil_attach_filter(ifnet_t, const struct iff_filter *, 240 interface_filter_t *); 241extern void dlil_detach_filter(interface_filter_t); 242 243extern void dlil_proto_unplumb_all(ifnet_t); 244 245extern void dlil_post_msg(struct ifnet *, u_int32_t, u_int32_t, 246 struct net_event_data *, u_int32_t); 247 248extern int dlil_alloc_local_stats(struct ifnet *); 249 250/* 251 * dlil_if_acquire is obsolete. Use ifnet_allocate. 252 */ 253extern int dlil_if_acquire(u_int32_t, const void *, size_t, struct ifnet **); 254/* 255 * dlil_if_release is obsolete. The equivalent is called automatically when 256 * an interface is detached. 257 */ 258extern void dlil_if_release(struct ifnet *ifp); 259 260extern u_int32_t ifnet_aggressive_drainers; 261 262extern errno_t dlil_if_ref(struct ifnet *); 263extern errno_t dlil_if_free(struct ifnet *); 264 265extern void dlil_node_present(struct ifnet *, struct sockaddr *, int32_t, int, 266 int, u_int8_t[48]); 267extern void dlil_node_absent(struct ifnet *, struct sockaddr *); 268 269#endif /* BSD_KERNEL_PRIVATE */ 270#endif /* KERNEL_PRIVATE */ 271#endif /* KERNEL */ 272#endif /* DLIL_H */ 273