1 /*- 2 * Copyright (c) 1990, 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from the Stanford/CMU enet packet filter, 6 * (net/enet.c) distributed as part of 4.3BSD, and code contributed 7 * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence 8 * Berkeley Laboratory. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 4. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)bpfdesc.h 8.1 (Berkeley) 6/10/93 35 * 36 * $FreeBSD$ 37 */ 38 39 #ifndef _NET_BPFDESC_H_ 40 #define _NET_BPFDESC_H_ 41 42 #include <sys/callout.h> 43 #include <sys/selinfo.h> 44 #include <sys/queue.h> 45 #include <sys/conf.h> 46 #include <net/if.h> 47 48 /* 49 * Descriptor associated with each open bpf file. 50 */ 51 struct bpf_d { 52 LIST_ENTRY(bpf_d) bd_next; /* Linked list of descriptors */ 53 /* 54 * Buffer slots: two mbuf clusters buffer the incoming packets. 55 * The model has three slots. Sbuf is always occupied. 56 * sbuf (store) - Receive interrupt puts packets here. 57 * hbuf (hold) - When sbuf is full, put cluster here and 58 * wakeup read (replace sbuf with fbuf). 59 * fbuf (free) - When read is done, put cluster here. 60 * On receiving, if sbuf is full and fbuf is 0, packet is dropped. 61 */ 62 caddr_t bd_sbuf; /* store slot */ 63 caddr_t bd_hbuf; /* hold slot */ 64 caddr_t bd_fbuf; /* free slot */ 65 int bd_slen; /* current length of store buffer */ 66 int bd_hlen; /* current length of hold buffer */ 67 68 int bd_bufsize; /* absolute length of buffers */ 69 70 struct bpf_if * bd_bif; /* interface descriptor */ 71 u_long bd_rtout; /* Read timeout in 'ticks' */ 72 struct bpf_insn *bd_rfilter; /* read filter code */ 73 struct bpf_insn *bd_wfilter; /* write filter code */ 74 #ifdef BPF_JITTER 75 bpf_jit_filter *bd_bfilter; /* binary filter code */ 76 #endif 77 u_long bd_rcount; /* number of packets received */ 78 u_long bd_dcount; /* number of packets dropped */ 79 80 u_char bd_promisc; /* true if listening promiscuously */ 81 u_char bd_state; /* idle, waiting, or timed out */ 82 u_char bd_immediate; /* true to return on packet arrival */ 83 int bd_hdrcmplt; /* false to fill in src lladdr automatically */ 84 int bd_seesent; /* true if bpf should see sent packets */ 85 int bd_async; /* non-zero if packet reception should generate signal */ 86 int bd_sig; /* signal to send upon packet reception */ 87 struct sigio * bd_sigio; /* information for async I/O */ 88 #if BSD < 199103 89 u_char bd_selcoll; /* true if selects collide */ 90 int bd_timedout; 91 struct thread * bd_selthread; /* process that last selected us */ 92 #else 93 u_char bd_pad; /* explicit alignment */ 94 struct selinfo bd_sel; /* bsd select info */ 95 #endif 96 struct mtx bd_mtx; /* mutex for this descriptor */ 97 struct callout bd_callout; /* for BPF timeouts with select */ 98 struct label *bd_label; /* MAC label for descriptor */ 99 u_long bd_fcount; /* number of packets which matched filter */ 100 pid_t bd_pid; /* PID which created descriptor */ 101 int bd_locked; /* true if descriptor is locked */ 102 }; 103 104 /* Values for bd_state */ 105 #define BPF_IDLE 0 /* no select in progress */ 106 #define BPF_WAITING 1 /* waiting for read timeout in select */ 107 #define BPF_TIMED_OUT 2 /* read timeout has expired in select */ 108 109 #define BPFD_LOCK(bd) mtx_lock(&(bd)->bd_mtx) 110 #define BPFD_UNLOCK(bd) mtx_unlock(&(bd)->bd_mtx) 111 #define BPFD_LOCK_ASSERT(bd) do { \ 112 mtx_assert(&(bd)->bd_mtx, MA_OWNED); \ 113 NET_ASSERT_GIANT(); \ 114 } while (0) 115 116 /* Test whether a BPF is ready for read(). */ 117 #define bpf_ready(bd) \ 118 ((bd)->bd_hlen != 0 || \ 119 (((bd)->bd_immediate || (bd)->bd_state == BPF_TIMED_OUT) && \ 120 (bd)->bd_slen != 0)) 121 122 /* 123 * Descriptor associated with each attached hardware interface. 124 */ 125 struct bpf_if { 126 LIST_ENTRY(bpf_if) bif_next; /* list of all interfaces */ 127 LIST_HEAD(, bpf_d) bif_dlist; /* descriptor list */ 128 struct bpf_if **bif_driverp; /* pointer into softc */ 129 u_int bif_dlt; /* link layer type */ 130 u_int bif_hdrlen; /* length of header (with padding) */ 131 struct ifnet *bif_ifp; /* corresponding interface */ 132 struct mtx bif_mtx; /* mutex for interface */ 133 }; 134 135 /* 136 * External representation of the bpf descriptor 137 */ 138 struct xbpf_d { 139 u_char bd_promisc; 140 u_char bd_immediate; 141 int bd_hdrcmplt; 142 int bd_seesent; 143 int bd_async; 144 u_long bd_rcount; 145 u_long bd_dcount; 146 u_long bd_fcount; 147 int bd_sig; 148 int bd_slen; 149 int bd_hlen; 150 int bd_bufsize; 151 pid_t bd_pid; 152 char bd_ifname[IFNAMSIZ]; 153 int bd_locked; 154 }; 155 156 #define BPFIF_LOCK(bif) mtx_lock(&(bif)->bif_mtx) 157 #define BPFIF_UNLOCK(bif) mtx_unlock(&(bif)->bif_mtx) 158 159 #endif 160