xref: /openbsd-src/sys/net/bpfdesc.h (revision 4b70baf6e17fc8b27fc1f7fa7929335753fa94c3)
1 /*	$OpenBSD: bpfdesc.h,v 1.37 2019/04/15 21:55:08 sashan 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 struct bpf_program_smr {
46 	struct bpf_program	bps_bf;
47 	struct smr_entry	bps_smr;
48 };
49 
50 /*
51  * Descriptor associated with each open bpf file.
52  */
53 struct bpf_d {
54 	SMR_SLIST_ENTRY(bpf_d) bd_next;	/* Linked list of descriptors */
55 	/*
56 	 * Buffer slots: two mbuf clusters buffer the incoming packets.
57 	 *   The model has three slots.  Sbuf is always occupied.
58 	 *   sbuf (store) - Receive interrupt puts packets here.
59 	 *   hbuf (hold) - When sbuf is full, put cluster here and
60 	 *                 wakeup read (replace sbuf with fbuf).
61 	 *   fbuf (free) - When read is done, put cluster here.
62 	 * On receiving, if sbuf is full and fbuf is 0, packet is dropped.
63 	 */
64 	struct mutex	bd_mtx;		/* protect buffer slots below */
65 	caddr_t		bd_sbuf;	/* store slot */
66 	caddr_t		bd_hbuf;	/* hold slot */
67 	caddr_t		bd_fbuf;	/* free slot */
68 	int		bd_slen;	/* current length of store buffer */
69 	int		bd_hlen;	/* current length of hold buffer */
70 	int		bd_bufsize;	/* absolute length of buffers */
71 
72 	int		bd_in_uiomove;	/* for debugging purpose */
73 
74 	struct bpf_if  *bd_bif;		/* interface descriptor */
75 	u_long		bd_rtout;	/* Read timeout in 'ticks' */
76 	u_long		bd_rdStart;	/* when the read started */
77 	struct bpf_program_smr
78 		       *bd_rfilter;	/* read filter code */
79 	struct bpf_program_smr
80 		       *bd_wfilter;	/* write filter code */
81 	u_long		bd_rcount;	/* number of packets received */
82 	u_long		bd_dcount;	/* number of packets dropped */
83 
84 	u_char		bd_promisc;	/* true if listening promiscuously */
85 	u_char		bd_state;	/* idle, waiting, or timed out */
86 	u_char		bd_immediate;	/* true to return on packet arrival */
87 	u_char		bd_locked;	/* true if descriptor is locked */
88 	u_char		bd_fildrop;	/* true if filtered packets will be dropped */
89 	u_char		bd_dirfilt;	/* direction filter */
90 	int		bd_hdrcmplt;	/* false to fill in src lladdr automatically */
91 	int		bd_async;	/* non-zero if packet reception should generate signal */
92 	int		bd_sig;		/* signal to send upon packet reception */
93 	pid_t		bd_pgid;	/* process or group id for signal */
94 	uid_t		bd_siguid;	/* uid for process that set pgid */
95 	uid_t		bd_sigeuid;	/* euid for process that set pgid */
96 	u_int		bd_ref;		/* reference count */
97 	struct selinfo	bd_sel;		/* bsd select info */
98 	int		bd_unit;	/* logical unit number */
99 	LIST_ENTRY(bpf_d) bd_list;	/* descriptor list */
100 
101 	struct task	bd_wake_task;	/* delay csignal() and selwakeup() */
102 
103 	struct smr_entry
104 			bd_smr;
105 };
106 
107 /*
108  * Descriptor associated with each attached hardware interface.
109  */
110 struct bpf_if {
111 	struct bpf_if *bif_next;	/* list of all interfaces */
112 	SMR_SLIST_HEAD(, bpf_d) bif_dlist;		/* descriptor list */
113 	struct bpf_if **bif_driverp;	/* pointer into softc */
114 	u_int bif_dlt;			/* link layer type */
115 	u_int bif_hdrlen;		/* length of header (with padding) */
116 	const char *bif_name;		/* name of "subsystem" */
117 	struct ifnet *bif_ifp;		/* corresponding interface */
118 };
119 
120 int	 bpf_setf(struct bpf_d *, struct bpf_program *, int);
121 #endif /* _KERNEL */
122 #endif /* _NET_BPFDESC_H_ */
123