1 /* 2 * Copyright (c) 2000-2022 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 /* 29 * Copyright (c) 1990, 1991, 1993 30 * The Regents of the University of California. All rights reserved. 31 * 32 * This code is derived from the Stanford/CMU enet packet filter, 33 * (net/enet.c) distributed as part of 4.3BSD, and code contributed 34 * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence 35 * Berkeley Laboratory. 36 * 37 * Redistribution and use in source and binary forms, with or without 38 * modification, are permitted provided that the following conditions 39 * are met: 40 * 1. Redistributions of source code must retain the above copyright 41 * notice, this list of conditions and the following disclaimer. 42 * 2. Redistributions in binary form must reproduce the above copyright 43 * notice, this list of conditions and the following disclaimer in the 44 * documentation and/or other materials provided with the distribution. 45 * 3. All advertising materials mentioning features or use of this software 46 * must display the following acknowledgement: 47 * This product includes software developed by the University of 48 * California, Berkeley and its contributors. 49 * 4. Neither the name of the University nor the names of its contributors 50 * may be used to endorse or promote products derived from this software 51 * without specific prior written permission. 52 * 53 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 54 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 55 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 56 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 57 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 58 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 59 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 60 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 61 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 62 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 63 * SUCH DAMAGE. 64 * 65 * @(#)bpfdesc.h 8.1 (Berkeley) 6/10/93 66 * 67 * $FreeBSD: src/sys/net/bpfdesc.h,v 1.14.2.1 2000/03/19 05:55:36 rwatson Exp $ 68 */ 69 70 #ifndef _NET_BPFDESC_H_ 71 #define _NET_BPFDESC_H_ 72 #include <sys/appleapiopts.h> 73 #ifdef KERNEL_PRIVATE 74 /* 75 * The items in this header file should be wrapped in #ifdef KERNEL. 76 */ 77 78 #include <sys/proc.h> 79 #include <sys/select.h> 80 #include <kern/thread_call.h> 81 #include <net/if.h> 82 #include <uuid/uuid.h> 83 84 #if __has_ptrcheck 85 #define BPF_BIDI_INDEXABLE __bidi_indexable 86 #else 87 #define BPF_BIDI_INDEXABLE 88 #endif 89 90 /* 91 * Descriptor associated with each open bpf file. 92 */ 93 struct bpf_d { 94 struct bpf_d *bd_next; /* Linked list of descriptors */ 95 /* 96 * Buffer slots: two mbuf clusters buffer the incoming packets. 97 * The model has three slots. Sbuf is always occupied. 98 * sbuf (store) - Receive interrupt puts packets here. 99 * hbuf (hold) - When sbuf is full, put cluster here and 100 * wakeup read (replace sbuf with fbuf). 101 * fbuf (free) - When read is done, put cluster here. 102 * On receiving, if sbuf is full and fbuf is 0, packet is dropped. 103 * 104 * Ideally, these buffers would all be marked with 105 * __sized_by(bd_bufsize), but due to how they are rotated, it's 106 * not possible to maintain that relationship. 107 */ 108 caddr_t BPF_BIDI_INDEXABLE bd_sbuf; /* store slot */ 109 caddr_t BPF_BIDI_INDEXABLE bd_hbuf; /* hold slot */ 110 caddr_t BPF_BIDI_INDEXABLE bd_fbuf; /* free slot */ 111 uint32_t bd_slen; /* current length of store buffer */ 112 uint32_t bd_hlen; /* current length of hold buffer */ 113 uint32_t bd_scnt; /* number of packets in store buffer */ 114 uint32_t bd_hcnt; /* number of packets in hold buffer */ 115 116 uint32_t bd_bufsize; /* absolute length of buffers */ 117 bool bd_hbuf_read; /* reading from hbuf */ 118 bool bd_hbuf_write; /* writing on device */ 119 bool bd_headdrop; /* Keep newer packets */ 120 121 uint32_t bd_write_size_max; /* max length of packet when writing */ 122 123 uint32_t bd_rtout; /* Read timeout in 'ticks' */ 124 struct bpf_if *bd_bif; /* interface descriptor */ 125 struct bpf_insn *__counted_by(bd_filter_len) bd_filter; /* filter code */ 126 uint32_t bd_filter_len; /* filter code length */ 127 uint64_t bd_rcount; /* number of packets received */ 128 uint64_t bd_dcount; /* number of received packets dropped */ 129 uint64_t bd_fcount; /* number of received packets which matched filter */ 130 131 uint64_t bd_wcount; /* number of packets written */ 132 uint64_t bd_wdcount; /* number of packets dropped during a write */ 133 134 uint8_t bd_promisc; /* true if listening promiscuously */ 135 uint8_t bd_state; /* idle, waiting, or timed out */ 136 uint8_t bd_immediate; /* true to return on packet arrival */ 137 uint32_t bd_dev_minor; /* for logging */ 138 int bd_async; /* non-zero if packet reception should generate signal */ 139 int bd_sig; /* signal to send upon packet reception */ 140 pid_t bd_sigio; 141 142 struct selinfo bd_sel; /* bsd select info */ 143 144 int bd_hdrcmplt; /* false to fill in src lladdr automatically */ 145 u_int bd_direction; /* direction of packets to see */ 146 int bd_oflags; /* device open flags */ 147 thread_call_t bd_thread_call; /* for BPF timeouts with select */ 148 int bd_traffic_class; /* traffic service class */ 149 int bd_flags; /* flags */ 150 int bd_tstamp; /* select time stamping function */ 151 152 int bd_refcnt; 153 #define BPF_REF_HIST 4 /* how many callers to keep around */ 154 void *bd_ref_lr[BPF_REF_HIST]; 155 void *bd_unref_lr[BPF_REF_HIST]; 156 int bd_next_ref_lr; 157 int bd_next_unref_lr; 158 159 struct proc *bd_opened_by; 160 uuid_t bd_uuid; 161 pid_t bd_pid; 162 163 uint8_t bd_prev_slen; 164 caddr_t BPF_BIDI_INDEXABLE bd_prev_sbuf; 165 caddr_t BPF_BIDI_INDEXABLE bd_prev_fbuf; 166 167 struct bpf_comp_stats bd_bcs; 168 }; 169 170 /* Values for bd_state */ 171 #define BPF_IDLE 0 /* no select in progress or kqueue pending */ 172 #define BPF_WAITING 1 /* waiting for read timeout in select/kqueue */ 173 #define BPF_TIMED_OUT 2 /* read timeout has expired in select/kqueue */ 174 #define BPF_DRAINING 3 /* waiting for timeout routine to finish during close */ 175 176 /* Test whether a BPF is ready for read(). */ 177 #define bpf_ready(bd) ((bd)->bd_hlen != 0 || \ 178 (((bd)->bd_immediate || (bd)->bd_state == BPF_TIMED_OUT) && \ 179 (bd)->bd_slen != 0)) 180 181 /* Values for bd_flags */ 182 #define BPF_EXTENDED_HDR 0x0001 /* process req. the extended header */ 183 #define BPF_WANT_PKTAP 0x0002 /* knows how to handle DLT_PKTAP */ 184 #define BPF_FINALIZE_PKTAP 0x0004 /* finalize pktap header on read */ 185 #define BPF_KNOTE 0x0008 /* kernel note attached */ 186 #define BPF_DETACHING 0x0010 /* bpf_d is being detached */ 187 #define BPF_DETACHED 0x0020 /* bpf_d is detached */ 188 #define BPF_CLOSING 0x0040 /* bpf_d is being closed */ 189 #define BPF_TRUNCATE 0x0080 /* truncate the packet payload */ 190 #define BPF_PKTHDRV2 0x0100 /* pktap header version 2 */ 191 #define BPF_COMP_REQ 0x0200 /* compression requested */ 192 #define BPF_COMP_ENABLED 0x0400 /* compression enabled */ 193 #define BPF_BATCH_WRITE 0x0800 /* batch write enabled */ 194 #define BPF_DIVERT_IN 0x1000 /* divert input */ 195 196 /* 197 * Descriptor associated with each attached hardware interface. 198 */ 199 struct bpf_if { 200 struct bpf_if *bif_next; /* list of all interfaces */ 201 struct bpf_d *bif_dlist; /* descriptor list */ 202 uint32_t bif_dlt; /* link layer type */ 203 uint32_t bif_hdrlen; /* length of header (with padding) */ 204 uint32_t bif_exthdrlen; /* length of ext header */ 205 uint32_t bif_comphdrlen; /* length of compressed header */ 206 struct ifnet *bif_ifp; /* corresponding interface */ 207 bpf_send_func bif_send; 208 bpf_tap_func bif_tap; 209 }; 210 211 #endif /* KERNEL_PRIVATE */ 212 213 #endif 214