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 | /* |
85 | * Descriptor associated with each open bpf file. |
86 | */ |
87 | struct bpf_d { |
88 | struct bpf_d *bd_next; /* Linked list of descriptors */ |
89 | /* |
90 | * Buffer slots: two mbuf clusters buffer the incoming packets. |
91 | * The model has three slots. Sbuf is always occupied. |
92 | * sbuf (store) - Receive interrupt puts packets here. |
93 | * hbuf (hold) - When sbuf is full, put cluster here and |
94 | * wakeup read (replace sbuf with fbuf). |
95 | * fbuf (free) - When read is done, put cluster here. |
96 | * On receiving, if sbuf is full and fbuf is 0, packet is dropped. |
97 | */ |
98 | caddr_t bd_sbuf; /* store slot */ |
99 | caddr_t bd_hbuf; /* hold slot */ |
100 | caddr_t bd_fbuf; /* free slot */ |
101 | uint32_t bd_slen; /* current length of store buffer */ |
102 | uint32_t bd_hlen; /* current length of hold buffer */ |
103 | uint32_t bd_scnt; /* number of packets in store buffer */ |
104 | uint32_t bd_hcnt; /* number of packets in hold buffer */ |
105 | |
106 | uint32_t bd_bufsize; /* absolute length of buffers */ |
107 | bool bd_hbuf_read; /* reading from hbuf */ |
108 | bool bd_hbuf_write; /* writing on device */ |
109 | bool bd_headdrop; /* Keep newer packets */ |
110 | |
111 | uint32_t bd_write_size_max; /* max length of packet when writing */ |
112 | |
113 | uint32_t bd_rtout; /* Read timeout in 'ticks' */ |
114 | struct bpf_if *bd_bif; /* interface descriptor */ |
115 | struct bpf_insn *bd_filter; /* filter code */ |
116 | uint64_t bd_rcount; /* number of packets received */ |
117 | uint64_t bd_dcount; /* number of received packets dropped */ |
118 | uint64_t bd_fcount; /* number of received packets which matched filter */ |
119 | |
120 | uint64_t bd_wcount; /* number of packets written */ |
121 | uint64_t bd_wdcount; /* number of packets dropped during a write */ |
122 | |
123 | uint8_t bd_promisc; /* true if listening promiscuously */ |
124 | uint8_t bd_state; /* idle, waiting, or timed out */ |
125 | uint8_t bd_immediate; /* true to return on packet arrival */ |
126 | uint32_t bd_dev_minor; /* for logging */ |
127 | int bd_async; /* non-zero if packet reception should generate signal */ |
128 | int bd_sig; /* signal to send upon packet reception */ |
129 | pid_t bd_sigio; |
130 | |
131 | struct selinfo bd_sel; /* bsd select info */ |
132 | |
133 | int bd_hdrcmplt; /* false to fill in src lladdr automatically */ |
134 | u_int bd_direction; /* direction of packets to see */ |
135 | int bd_oflags; /* device open flags */ |
136 | thread_call_t bd_thread_call; /* for BPF timeouts with select */ |
137 | int bd_traffic_class; /* traffic service class */ |
138 | int bd_flags; /* flags */ |
139 | |
140 | int bd_refcnt; |
141 | #define BPF_REF_HIST 4 /* how many callers to keep around */ |
142 | void *bd_ref_lr[BPF_REF_HIST]; |
143 | void *bd_unref_lr[BPF_REF_HIST]; |
144 | int bd_next_ref_lr; |
145 | int bd_next_unref_lr; |
146 | |
147 | struct proc *bd_opened_by; |
148 | uuid_t bd_uuid; |
149 | pid_t bd_pid; |
150 | |
151 | uint8_t bd_prev_slen; |
152 | caddr_t bd_prev_sbuf; |
153 | caddr_t bd_prev_fbuf; |
154 | |
155 | struct bpf_comp_stats bd_bcs; |
156 | }; |
157 | |
158 | /* Values for bd_state */ |
159 | #define BPF_IDLE 0 /* no select in progress or kqueue pending */ |
160 | #define BPF_WAITING 1 /* waiting for read timeout in select/kqueue */ |
161 | #define BPF_TIMED_OUT 2 /* read timeout has expired in select/kqueue */ |
162 | #define BPF_DRAINING 3 /* waiting for timeout routine to finish during close */ |
163 | |
164 | /* Test whether a BPF is ready for read(). */ |
165 | #define bpf_ready(bd) ((bd)->bd_hlen != 0 || \ |
166 | (((bd)->bd_immediate || (bd)->bd_state == BPF_TIMED_OUT) && \ |
167 | (bd)->bd_slen != 0)) |
168 | |
169 | /* Values for bd_flags */ |
170 | #define BPF_EXTENDED_HDR 0x0001 /* process req. the extended header */ |
171 | #define BPF_WANT_PKTAP 0x0002 /* knows how to handle DLT_PKTAP */ |
172 | #define BPF_FINALIZE_PKTAP 0x0004 /* finalize pktap header on read */ |
173 | #define BPF_KNOTE 0x0008 /* kernel note attached */ |
174 | #define BPF_DETACHING 0x0010 /* bpf_d is being detached */ |
175 | #define BPF_DETACHED 0x0020 /* bpf_d is detached */ |
176 | #define BPF_CLOSING 0x0040 /* bpf_d is being closed */ |
177 | #define BPF_TRUNCATE 0x0080 /* truncate the packet payload */ |
178 | #define BPF_PKTHDRV2 0x0100 /* pktap header version 2 */ |
179 | #define BPF_COMP_REQ 0x0200 /* compression requested */ |
180 | #define BPF_COMP_ENABLED 0x0400 /* compression enabled */ |
181 | #define BPF_BATCH_WRITE 0x0800 /* batch write enabled */ |
182 | |
183 | /* |
184 | * Descriptor associated with each attached hardware interface. |
185 | */ |
186 | struct bpf_if { |
187 | struct bpf_if *bif_next; /* list of all interfaces */ |
188 | struct bpf_d *bif_dlist; /* descriptor list */ |
189 | uint32_t bif_dlt; /* link layer type */ |
190 | uint32_t bif_hdrlen; /* length of header (with padding) */ |
191 | uint32_t bif_exthdrlen; /* length of ext header */ |
192 | uint32_t bif_comphdrlen; /* length of compressed header */ |
193 | struct ifnet *bif_ifp; /* corresponding interface */ |
194 | bpf_send_func bif_send; |
195 | bpf_tap_func bif_tap; |
196 | }; |
197 | |
198 | #endif /* KERNEL_PRIVATE */ |
199 | |
200 | #endif |
201 | |