sys/net/bpfdesc.h

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