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