sys/net/bpfdesc.h

   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$
  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  */
  51 struct bpf_d {
  52         LIST_ENTRY(bpf_d) bd_next;      /* Linked list of descriptors */
  53         /*
  54          * Buffer slots: two malloc buffers store 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 buffer here and
  58          *                 wakeup read (replace sbuf with fbuf).
  59          *   fbuf (free) - When read is done, put buffer here.
  60          * On receiving, if sbuf is full and fbuf is 0, packet is dropped.
  61          */
  62         caddr_t         bd_sbuf;        /* store slot */
  63         caddr_t         bd_hbuf;        /* hold slot */
  64         caddr_t         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_rfilter;    /* read filter code */
  73         struct bpf_insn *bd_wfilter;    /* write filter code */
  74 #ifdef BPF_JITTER
  75         bpf_jit_filter  *bd_bfilter;    /* binary filter code */
  76 #endif
  77         u_long          bd_rcount;      /* number of packets received */
  78         u_long          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         int             bd_hdrcmplt;    /* false to fill in src lladdr automatically */
  84         int             bd_direction;   /* select packet direction */
  85         int             bd_feedback;    /* true to feed back sent packets */
  86         int             bd_async;       /* non-zero if packet reception should generate signal */
  87         int             bd_sig;         /* signal to send upon packet reception */
  88         struct sigio *  bd_sigio;       /* information for async I/O */
  89         struct selinfo  bd_sel;         /* bsd select info */
  90         struct mtx      bd_mtx;         /* mutex for this descriptor */
  91         struct callout  bd_callout;     /* for BPF timeouts with select */
  92         struct label    *bd_label;      /* MAC label for descriptor */
  93         u_long          bd_fcount;      /* number of packets which matched filter */
  94         pid_t           bd_pid;         /* PID which created descriptor */
  95         int             bd_locked;      /* true if descriptor is locked */
  96 };
  97
  98 /* Values for bd_state */
  99 #define BPF_IDLE        0               /* no select in progress */
 100 #define BPF_WAITING     1               /* waiting for read timeout in select */
 101 #define BPF_TIMED_OUT   2               /* read timeout has expired in select */
 102
 103 #define BPFD_LOCK(bd)           mtx_lock(&(bd)->bd_mtx)
 104 #define BPFD_UNLOCK(bd)         mtx_unlock(&(bd)->bd_mtx)
 105 #define BPFD_LOCK_ASSERT(bd)    mtx_assert(&(bd)->bd_mtx, MA_OWNED)
 106
 107 /* Test whether a BPF is ready for read(). */
 108 #define bpf_ready(bd)                                            \
 109         ((bd)->bd_hlen != 0 ||                                   \
 110          (((bd)->bd_immediate || (bd)->bd_state == BPF_TIMED_OUT) && \
 111           (bd)->bd_slen != 0))
 112
 113 /*
 114  * External representation of the bpf descriptor
 115  */
 116 struct xbpf_d {
 117         u_char          bd_promisc;
 118         u_char          bd_immediate;
 119         int             bd_hdrcmplt;
 120         int             bd_direction;
 121         int             bd_feedback;
 122         int             bd_async;
 123         u_long          bd_rcount;
 124         u_long          bd_dcount;
 125         u_long          bd_fcount;
 126         int             bd_sig;
 127         int             bd_slen;
 128         int             bd_hlen;
 129         int             bd_bufsize;
 130         pid_t           bd_pid;
 131         char            bd_ifname[IFNAMSIZ];
 132         int             bd_locked;
 133 };
 134
 135 #define BPFIF_LOCK(bif)         mtx_lock(&(bif)->bif_mtx)
 136 #define BPFIF_UNLOCK(bif)       mtx_unlock(&(bif)->bif_mtx)
 137
 138 #endif