xref: /netbsd-src/sys/net/bpfdesc.h (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: bpfdesc.h,v 1.32 2010/03/13 20:38:48 christos 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/selinfo.h>		/* for struct selinfo */
46 #include <net/if.h>			/* for IFNAMSIZ */
47 
48 /*
49  * Descriptor associated with each open bpf file.
50  */
51 struct bpf_d {
52 	struct 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 	void *		bd_sbuf;	/* store slot */
63 	void *		bd_hbuf;	/* hold slot */
64 	void *		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_filter; 	/* filter code */
73 	u_long		bd_rcount;	/* number of packets received */
74 	u_long		bd_dcount;	/* number of packets dropped */
75 	u_long		bd_ccount;	/* number of packets captured */
76 
77 	u_char		bd_promisc;	/* true if listening promiscuously */
78 	u_char		bd_state;	/* idle, waiting, or timed out */
79 	u_char		bd_immediate;	/* true to return on packet arrival */
80 	int		bd_hdrcmplt;	/* false to fill in src lladdr */
81 	int		bd_seesent;	/* true if bpf should see sent packets */
82 	int 		bd_feedback;	/* true to feed back sent packets */
83 	int		bd_async;	/* non-zero if packet reception should generate signal */
84 	pid_t		bd_pgid;	/* process or group id for signal */
85 #if BSD < 199103
86 	u_char		bd_selcoll;	/* true if selects collide */
87 	int		bd_timedout;
88 	struct proc *	bd_selproc;	/* process that last selected us */
89 #else
90 	u_char		bd_pad;		/* explicit alignment */
91 	struct selinfo	bd_sel;		/* bsd select info */
92 #endif
93 	callout_t	bd_callout;	/* for BPF timeouts with select */
94 	pid_t		bd_pid;		/* corresponding PID */
95 	LIST_ENTRY(bpf_d) bd_list;	/* list of all BPF's */
96 	void		*bd_sih;	/* soft interrupt handle */
97 	struct timespec bd_atime;	/* access time */
98 	struct timespec bd_mtime;	/* modification time */
99 	struct timespec bd_btime;	/* birth time */
100 };
101 
102 
103 /* Values for bd_state */
104 #define BPF_IDLE	0		/* no select in progress */
105 #define BPF_WAITING	1		/* waiting for read timeout in select */
106 #define BPF_TIMED_OUT	2		/* read timeout has expired in select */
107 
108 /*
109  * Description associated with the external representation of each
110  * open bpf file.
111  */
112 struct bpf_d_ext {
113 	int32_t		bde_bufsize;
114 	uint8_t		bde_promisc;
115 	uint8_t		bde_state;
116 	uint8_t		bde_immediate;
117 	int32_t		bde_hdrcmplt;
118 	int32_t		bde_seesent;
119 	pid_t		bde_pid;
120 	uint64_t	bde_rcount;		/* number of packets received */
121 	uint64_t	bde_dcount;		/* number of packets dropped */
122 	uint64_t	bde_ccount;		/* number of packets captured */
123 	char		bde_ifname[IFNAMSIZ];
124 };
125 
126 
127 /*
128  * Descriptor associated with each attached hardware interface.
129  */
130 struct bpf_if {
131 	struct bpf_if *bif_next;	/* list of all interfaces */
132 	struct bpf_d *bif_dlist;	/* descriptor list */
133 	struct bpf_if **bif_driverp;	/* pointer into softc */
134 	u_int bif_dlt;			/* link layer type */
135 	u_int bif_hdrlen;		/* length of header (with padding) */
136 	struct ifnet *bif_ifp;		/* corresponding interface */
137 };
138 
139 #ifdef _KERNEL
140 int	 bpf_setf(struct bpf_d *, struct bpf_program *);
141 #endif
142 
143 #endif /* !_NET_BPFDESC_H_ */
144