bsd/net/bpfdesc.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * Copyright (c) 1990, 1991, 1993
  32  *      The Regents of the University of California.  All rights reserved.
  33  *
  34  * This code is derived from the Stanford/CMU enet packet filter,
  35  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
  36  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
  37  * Berkeley Laboratory.
  38  *
  39  * Redistribution and use in source and binary forms, with or without
  40  * modification, are permitted provided that the following conditions
  41  * are met:
  42  * 1. Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  * 2. Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in the
  46  *    documentation and/or other materials provided with the distribution.
  47  * 3. All advertising materials mentioning features or use of this software
  48  *    must display the following acknowledgement:
  49  *      This product includes software developed by the University of
  50  *      California, Berkeley and its contributors.
  51  * 4. Neither the name of the University nor the names of its contributors
  52  *    may be used to endorse or promote products derived from this software
  53  *    without specific prior written permission.
  54  *
  55  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  56  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  58  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  59  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  60  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  61  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  62  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  63  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  64  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  65  * SUCH DAMAGE.
  66  *
  67  *      @(#)bpfdesc.h   8.1 (Berkeley) 6/10/93
  68  *
  69  * $FreeBSD: src/sys/net/bpfdesc.h,v 1.14.2.1 2000/03/19 05:55:36 rwatson Exp $
  70  */
  71
  72 #ifndef _NET_BPFDESC_H_
  73 #define _NET_BPFDESC_H_
  74 #include <sys/appleapiopts.h>
  75 #ifdef KERNEL_PRIVATE
  76 /*
  77  * The items in this header file should be wrapped in #ifdef KERNEL.
  78  */
  79
  80 #include <sys/select.h>
  81
  82 /*
  83  * Descriptor associated with each open bpf file.
  84  */
  85 struct bpf_d {
  86         struct bpf_d    *bd_next;       /* Linked list of descriptors */
  87         /*
  88          * Buffer slots: two mbuf clusters buffer the incoming packets.
  89          *   The model has three slots.  Sbuf is always occupied.
  90          *   sbuf (store) - Receive interrupt puts packets here.
  91          *   hbuf (hold) - When sbuf is full, put cluster here and
  92          *                 wakeup read (replace sbuf with fbuf).
  93          *   fbuf (free) - When read is done, put cluster here.
  94          * On receiving, if sbuf is full and fbuf is 0, packet is dropped.
  95          */
  96         caddr_t         bd_sbuf;        /* store slot */
  97         caddr_t         bd_hbuf;        /* hold slot */
  98         caddr_t         bd_fbuf;        /* free slot */
  99         int             bd_slen;        /* current length of store buffer */
 100         int             bd_hlen;        /* current length of hold buffer */
 101
 102         int             bd_bufsize;     /* absolute length of buffers */
 103
 104         struct bpf_if * bd_bif;         /* interface descriptor */
 105         u_long          bd_rtout;       /* Read timeout in 'ticks' */
 106         struct bpf_insn *bd_filter;     /* filter code */
 107         u_long          bd_rcount;      /* number of packets received */
 108         u_long          bd_dcount;      /* number of packets dropped */
 109
 110         u_char          bd_promisc;     /* true if listening promiscuously */
 111         u_char          bd_state;       /* idle, waiting, or timed out */
 112         u_char          bd_immediate;   /* true to return on packet arrival */
 113         int             bd_async;       /* non-zero if packet reception should generate signal */
 114         int             bd_sig;         /* signal to send upon packet reception */
 115 #ifdef __APPLE__
 116         pid_t           bd_sigio;
 117 #else
 118         struct sigio *  bd_sigio;       /* information for async I/O */
 119 #endif
 120
 121 #if BSD < 199103
 122         u_char          bd_selcoll;     /* true if selects collide */
 123         int             bd_timedout;
 124         struct proc *   bd_selproc;     /* process that last selected us */
 125 #else
 126         u_char          bd_pad;         /* explicit alignment */
 127         struct selinfo  bd_sel;         /* bsd select info */
 128 #endif
 129         int             bd_hdrcmplt;    /* false to fill in src lladdr automatically */
 130         int             bd_seesent;     /* true if bpf should see sent packets */
 131
 132 };
 133
 134 /*
 135  * Descriptor associated with each attached hardware interface.
 136  */
 137 struct bpf_if {
 138         struct bpf_if *bif_next;        /* list of all interfaces */
 139         struct bpf_d *bif_dlist;        /* descriptor list */
 140         u_int bif_dlt;                  /* link layer type */
 141         u_int bif_hdrlen;               /* length of header (with padding) */
 142         struct ifnet *bif_ifp;          /* corresponding interface */
 143 };
 144
 145 #endif /* KERNEL_PRIVATE */
 146 #endif