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 * 4. 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: stable/11/sys/net/bpfdesc.h 332734 2018-04-18 18:45:04Z shurd $
37 */
38
39#ifndef _NET_BPFDESC_H_
40#define _NET_BPFDESC_H_
41
42#include <sys/callout.h>
43#include <sys/selinfo.h>
44#include <sys/queue.h>
45#include <sys/conf.h>
46#include <net/if.h>
47
48/*
49 * Descriptor associated with each open bpf file.
50 */
51struct zbuf;
52struct bpf_d {
53	LIST_ENTRY(bpf_d) bd_next;	/* Linked list of descriptors */
54	/*
55	 * Buffer slots: two memory buffers store the incoming packets.
56	 *   The model has three slots.  Sbuf is always occupied.
57	 *   sbuf (store) - Receive interrupt puts packets here.
58	 *   hbuf (hold) - When sbuf is full, put buffer here and
59	 *                 wakeup read (replace sbuf with fbuf).
60	 *   fbuf (free) - When read is done, put buffer here.
61	 * On receiving, if sbuf is full and fbuf is 0, packet is dropped.
62	 */
63	caddr_t		bd_sbuf;	/* store slot */
64	caddr_t		bd_hbuf;	/* hold slot */
65	caddr_t		bd_fbuf;	/* free slot */
66	int		bd_hbuf_in_use;	/* don't rotate buffers */
67	int 		bd_slen;	/* current length of store buffer */
68	int 		bd_hlen;	/* current length of hold buffer */
69
70	int		bd_bufsize;	/* absolute length of buffers */
71
72	struct bpf_if *	bd_bif;		/* interface descriptor */
73	u_long		bd_rtout;	/* Read timeout in 'ticks' */
74	struct bpf_insn *bd_rfilter; 	/* read filter code */
75	struct bpf_insn *bd_wfilter;	/* write filter code */
76	void		*bd_bfilter;	/* binary filter code */
77	u_int64_t	bd_rcount;	/* number of packets received */
78	u_int64_t	bd_dcount;	/* number of packets dropped */
79
80	u_char		bd_promisc;	/* true if listening promiscuously */
81	u_char		bd_state;	/* idle, waiting, or timed out */
82	u_char		bd_immediate;	/* true to return on packet arrival */
83	u_char		bd_writer;	/* non-zero if d is writer-only */
84	int		bd_hdrcmplt;	/* false to fill in src lladdr automatically */
85	int		bd_direction;	/* select packet direction */
86	int		bd_tstamp;	/* select time stamping function */
87	int		bd_feedback;	/* true to feed back sent packets */
88	int		bd_async;	/* non-zero if packet reception should generate signal */
89	int		bd_sig;		/* signal to send upon packet reception */
90	struct sigio *	bd_sigio;	/* information for async I/O */
91	struct selinfo	bd_sel;		/* bsd select info */
92	struct mtx	bd_lock;	/* per-descriptor lock */
93	struct callout	bd_callout;	/* for BPF timeouts with select */
94	struct label	*bd_label;	/* MAC label for descriptor */
95	u_int64_t	bd_fcount;	/* number of packets which matched filter */
96	pid_t		bd_pid;		/* PID which created descriptor */
97	int		bd_locked;	/* true if descriptor is locked */
98	u_int		bd_bufmode;	/* Current buffer mode. */
99	u_int64_t	bd_wcount;	/* number of packets written */
100	u_int64_t	bd_wfcount;	/* number of packets that matched write filter */
101	u_int64_t	bd_wdcount;	/* number of packets dropped during a write */
102	u_int64_t	bd_zcopy;	/* number of zero copy operations */
103	u_char		bd_compat32;	/* 32-bit stream on LP64 system */
104};
105
106/* Values for bd_state */
107#define BPF_IDLE	0		/* no select in progress */
108#define BPF_WAITING	1		/* waiting for read timeout in select */
109#define BPF_TIMED_OUT	2		/* read timeout has expired in select */
110
111#define BPFD_LOCK(bd)		mtx_lock(&(bd)->bd_lock)
112#define BPFD_UNLOCK(bd)		mtx_unlock(&(bd)->bd_lock)
113#define BPFD_LOCK_ASSERT(bd)	mtx_assert(&(bd)->bd_lock, MA_OWNED)
114
115#define BPF_PID_REFRESH(bd, td)	(bd)->bd_pid = (td)->td_proc->p_pid
116#define BPF_PID_REFRESH_CUR(bd)	(bd)->bd_pid = curthread->td_proc->p_pid
117
118/*
119 * External representation of the bpf descriptor
120 */
121struct xbpf_d {
122	u_int		bd_structsize;	/* Size of this structure. */
123	u_char		bd_promisc;
124	u_char		bd_immediate;
125	u_char		__bd_pad[6];
126	int		bd_hdrcmplt;
127	int		bd_direction;
128	int		bd_feedback;
129	int		bd_async;
130	u_int64_t	bd_rcount;
131	u_int64_t	bd_dcount;
132	u_int64_t	bd_fcount;
133	int		bd_sig;
134	int		bd_slen;
135	int		bd_hlen;
136	int		bd_bufsize;
137	pid_t		bd_pid;
138	char		bd_ifname[IFNAMSIZ];
139	int		bd_locked;
140	u_int64_t	bd_wcount;
141	u_int64_t	bd_wfcount;
142	u_int64_t	bd_wdcount;
143	u_int64_t	bd_zcopy;
144	int		bd_bufmode;
145	/*
146	 * Allocate 4 64 bit unsigned integers for future expansion so we do
147	 * not have to worry about breaking the ABI.
148	 */
149	u_int64_t	bd_spare[4];
150};
151
152#define BPFIF_RLOCK(bif)	rw_rlock(&(bif)->bif_lock)
153#define BPFIF_RUNLOCK(bif)	rw_runlock(&(bif)->bif_lock)
154#define BPFIF_WLOCK(bif)	rw_wlock(&(bif)->bif_lock)
155#define BPFIF_WUNLOCK(bif)	rw_wunlock(&(bif)->bif_lock)
156
157#define BPFIF_FLAG_DYING	1	/* Reject new bpf consumers */
158
159#endif
160