xref: /netbsd-src/sys/net/bpfdesc.h (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /*	$NetBSD: bpfdesc.h,v 1.20 2004/05/29 14:18:33 darrenr Exp $	*/
2 
3 /*
4  * Copyright (c) 1990, 1991, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from the Stanford/CMU enet packet filter,
8  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
9  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
10  * Berkeley Laboratory.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)bpfdesc.h	8.1 (Berkeley) 6/10/93
37  *
38  * @(#) Header: bpfdesc.h,v 1.14 96/06/16 22:28:07 leres Exp  (LBL)
39  */
40 
41 #ifndef _NET_BPFDESC_H_
42 #define _NET_BPFDESC_H_
43 
44 #include <sys/callout.h>
45 #include <sys/select.h>
46 
47 /*
48  * Descriptor associated with each open bpf file.
49  */
50 struct bpf_d {
51 	struct bpf_d	*bd_next;	/* Linked list of descriptors */
52 	/*
53 	 * Buffer slots: two mbuf clusters buffer the incoming packets.
54 	 *   The model has three slots.  Sbuf is always occupied.
55 	 *   sbuf (store) - Receive interrupt puts packets here.
56 	 *   hbuf (hold) - When sbuf is full, put cluster here and
57 	 *                 wakeup read (replace sbuf with fbuf).
58 	 *   fbuf (free) - When read is done, put cluster here.
59 	 * On receiving, if sbuf is full and fbuf is 0, packet is dropped.
60 	 */
61 	caddr_t		bd_sbuf;	/* store slot */
62 	caddr_t		bd_hbuf;	/* hold slot */
63 	caddr_t		bd_fbuf;	/* free slot */
64 	int 		bd_slen;	/* current length of store buffer */
65 	int 		bd_hlen;	/* current length of hold buffer */
66 
67 	int		bd_bufsize;	/* absolute length of buffers */
68 
69 	struct bpf_if *	bd_bif;		/* interface descriptor */
70 	u_long		bd_rtout;	/* Read timeout in 'ticks' */
71 	struct bpf_insn *bd_filter; 	/* filter code */
72 	u_long		bd_rcount;	/* number of packets received */
73 	u_long		bd_dcount;	/* number of packets dropped */
74 	u_long		bd_ccount;	/* number of packets captured */
75 
76 	u_char		bd_promisc;	/* true if listening promiscuously */
77 	u_char		bd_state;	/* idle, waiting, or timed out */
78 	u_char		bd_immediate;	/* true to return on packet arrival */
79 	int		bd_hdrcmplt;	/* false to fill in src lladdr */
80 	int		bd_seesent;	/* true if bpf should see sent packets */
81 	int		bd_async;	/* non-zero if packet reception should generate signal */
82 	pid_t		bd_pgid;	/* process or group id for signal */
83 #if BSD < 199103
84 	u_char		bd_selcoll;	/* true if selects collide */
85 	int		bd_timedout;
86 	struct proc *	bd_selproc;	/* process that last selected us */
87 #else
88 	u_char		bd_pad;		/* explicit alignment */
89 	struct selinfo	bd_sel;		/* bsd select info */
90 #endif
91 	struct callout	bd_callout;	/* for BPF timeouts with select */
92 };
93 
94 
95 /* Values for bd_state */
96 #define BPF_IDLE	0		/* no select in progress */
97 #define BPF_WAITING	1		/* waiting for read timeout in select */
98 #define BPF_TIMED_OUT	2		/* read timeout has expired in select */
99 
100 /*
101  * Descriptor associated with each attached hardware interface.
102  */
103 struct bpf_if {
104 	struct bpf_if *bif_next;	/* list of all interfaces */
105 	struct bpf_d *bif_dlist;	/* descriptor list */
106 	struct bpf_if **bif_driverp;	/* pointer into softc */
107 	u_int bif_dlt;			/* link layer type */
108 	u_int bif_hdrlen;		/* length of header (with padding) */
109 	struct ifnet *bif_ifp;		/* correspoding interface */
110 };
111 
112 #ifdef _KERNEL
113 int	 bpf_setf __P((struct bpf_d *, struct bpf_program *));
114 #endif
115 
116 #endif /* _NET_BPFDESC_H_ */
117