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