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