xref: /openbsd/sys/net/bpfdesc.h (revision 1511e544)
1 /*	$OpenBSD: bpfdesc.h,v 1.50 2024/11/19 23:26:35 dlg Exp $	*/
2 /*	$NetBSD: bpfdesc.h,v 1.11 1995/09/27 18:30:42 thorpej Exp $	*/
3 
4 /*
5  * Copyright (c) 1990, 1991, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from the Stanford/CMU enet packet filter,
9  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
10  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
11  * Berkeley Laboratory.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)bpfdesc.h	8.1 (Berkeley) 6/10/93
38  */
39 
40 #ifndef _NET_BPFDESC_H_
41 #define _NET_BPFDESC_H_
42 
43 #ifdef _KERNEL
44 
45 /*
46  * Locks used to protect struct members in this file:
47  *
48  *	m	the per-descriptor mutex (bpf_d.bd_mtx)
49  */
50 
51 struct bpf_program_smr {
52 	struct bpf_program	bps_bf;
53 	struct smr_entry	bps_smr;
54 };
55 
56 /*
57  * Descriptor associated with each open bpf file.
58  */
59 struct bpf_d {
60 	SMR_SLIST_ENTRY(bpf_d) bd_next;	/* Linked list of descriptors */
61 	/*
62 	 * Buffer slots: two mbuf clusters buffer the incoming packets.
63 	 *   The model has three slots.  Sbuf is always occupied.
64 	 *   sbuf (store) - Receive interrupt puts packets here.
65 	 *   hbuf (hold) - When sbuf is full, put cluster here and
66 	 *                 wakeup read (replace sbuf with fbuf).
67 	 *   fbuf (free) - When read is done, put cluster here.
68 	 * On receiving, if sbuf is full and fbuf is 0, packet is dropped.
69 	 */
70 	struct mutex	bd_mtx;		/* protect buffer slots below */
71 	caddr_t		bd_sbuf;	/* store slot */
72 	caddr_t		bd_hbuf;	/* hold slot */
73 	caddr_t		bd_fbuf;	/* free slot */
74 	int		bd_slen;	/* current length of store buffer */
75 	int		bd_hlen;	/* current length of hold buffer */
76 	int		bd_bufsize;	/* absolute length of buffers */
77 
78 	int		bd_in_uiomove;	/* for debugging purpose */
79 
80 	struct bpf_if  *bd_bif;		/* interface descriptor */
81 	uint64_t	bd_rtout;	/* [m] Read timeout in nanoseconds */
82 	uint64_t	bd_wtout;	/* [m] Wait time in nanoseconds */
83 	u_long		bd_nreaders;	/* [m] # threads asleep in bpfread() */
84 	struct bpf_program_smr
85 		       *bd_rfilter;	/* read filter code */
86 	struct bpf_program_smr
87 		       *bd_wfilter;	/* write filter code */
88 	u_long		bd_rcount;	/* number of packets received */
89 	u_long		bd_dcount;	/* number of packets dropped */
90 
91 	u_char		bd_promisc;	/* true if listening promiscuously */
92 	u_char		bd_state;	/* [m] idle, waiting, or timed out */
93 	u_char		bd_locked;	/* true if descriptor is locked */
94 	u_char		bd_fildrop;	/* true if filtered packets will be dropped */
95 	u_char		bd_dirfilt;	/* direction filter */
96 	int		bd_hdrcmplt;	/* false to fill in src lladdr automatically */
97 	int		bd_async;	/* non-zero if packet reception should generate signal */
98 	int		bd_sig;		/* signal to send upon packet reception */
99 	struct sigio_ref
100 			bd_sigio;	/* async I/O registration */
101 	struct refcnt	bd_refcnt;	/* reference count */
102 	struct klist	bd_klist;	/* list of knotes */
103 	int		bd_unit;	/* logical unit number */
104 	LIST_ENTRY(bpf_d) bd_list;	/* descriptor list */
105 
106 	struct task	bd_wake_task;	/* defer pgsigio() and selwakeup() */
107 	struct timeout	bd_wait_tmo;	/* delay wakeup after catching pkt */
108 
109 	struct smr_entry
110 			bd_smr;
111 };
112 
113 /*
114  * Descriptor associated with each attached hardware interface.
115  */
116 struct bpf_if {
117 	TAILQ_ENTRY(bpf_if) bif_next;	/* list of all interfaces */
118 	SMR_SLIST_HEAD(, bpf_d) bif_dlist;		/* descriptor list */
119 	struct bpf_if **bif_driverp;	/* pointer into softc */
120 	u_int bif_dlt;			/* link layer type */
121 	u_int bif_hdrlen;		/* length of header (with padding) */
122 	const char *bif_name;		/* name of "subsystem" */
123 	struct ifnet *bif_ifp;		/* corresponding interface */
124 };
125 
126 int	 bpf_setf(struct bpf_d *, struct bpf_program *, u_long);
127 #endif /* _KERNEL */
128 #endif /* _NET_BPFDESC_H_ */
129