xnu-7195.81.3.tar.gz

[apple/xnu.git] / bsd / net / bpfdesc.h

diff --git a/bsd/net/bpfdesc.h b/bsd/net/bpfdesc.h
index 13a5cb88554a508c8191cfc8978c09baf77893cf..531d9217b0d54ef2f0ffa1fe0cc5f841ea4e5d9e 100644 (file)
--- a/bsd/net/bpfdesc.h
+++ b/bsd/net/bpfdesc.h
@@ -1,15 +1,20 @@
 /*
 /*

- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2017 Apple Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  *
  *

- * @APPLE_LICENSE_HEADER_START@
- * 

  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in

- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- * 
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *

  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,


@@ -17,8 +22,8 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.

- * 
- * @APPLE_LICENSE_HEADER_END@
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * Copyright (c) 1990, 1991, 1993
  */
 /*
  * Copyright (c) 1990, 1991, 1993


@@ -70,13 +75,16 @@
  * The items in this header file should be wrapped in #ifdef KERNEL.
  */
 
  * The items in this header file should be wrapped in #ifdef KERNEL.
  */
 

+#include <sys/proc.h>

 #include <sys/select.h>
 #include <sys/select.h>

+#include <kern/thread_call.h>
+#include <uuid/uuid.h>

 
 /*
  * Descriptor associated with each open bpf file.
  */
 struct bpf_d {
 
 /*
  * Descriptor associated with each open bpf file.
  */
 struct bpf_d {

-       struct bpf_d    *bd_next;       /* Linked list of descriptors */
+       struct bpf_d    *bd_next;       /* Linked list of descriptors */

        /*
         * Buffer slots: two mbuf clusters buffer the incoming packets.
         *   The model has three slots.  Sbuf is always occupied.
        /*
         * Buffer slots: two mbuf clusters buffer the incoming packets.
         *   The model has three slots.  Sbuf is always occupied.


@@ -86,53 +94,95 @@ struct bpf_d {
         *   fbuf (free) - When read is done, put cluster here.
         * On receiving, if sbuf is full and fbuf is 0, packet is dropped.
         */
         *   fbuf (free) - When read is done, put cluster here.
         * On receiving, if sbuf is full and fbuf is 0, packet is dropped.
         */

-       caddr_t         bd_sbuf;        /* store slot */
-       caddr_t         bd_hbuf;        /* hold slot */
-       caddr_t         bd_fbuf;        /* free slot */
-       int             bd_slen;        /* current length of store buffer */
-       int             bd_hlen;        /* current length of hold buffer */
+       caddr_t         bd_sbuf;        /* store slot */
+       caddr_t         bd_hbuf;        /* hold slot */
+       caddr_t         bd_fbuf;        /* free slot */
+       int             bd_slen;        /* current length of store buffer */
+       int             bd_hlen;        /* current length of hold buffer */
+       u_int32_t       bd_scnt;        /* number of packets in store buffer */
+       u_int32_t       bd_hcnt;        /* number of packets in hold buffer */

 
 

-       int             bd_bufsize;     /* absolute length of buffers */
+       int             bd_bufsize;     /* absolute length of buffers */
+       int             bd_hbuf_read;   /* reading from hbuf */
+       int             bd_headdrop;    /* Keep newer packets */

 
 

-       struct bpf_if * bd_bif;         /* interface descriptor */
-       u_long          bd_rtout;       /* Read timeout in 'ticks' */
-       struct bpf_insn *bd_filter;     /* filter code */
-       u_long          bd_rcount;      /* number of packets received */
-       u_long          bd_dcount;      /* number of packets dropped */
+       struct bpf_if  *bd_bif;         /* interface descriptor */
+       u_int32_t       bd_rtout;       /* Read timeout in 'ticks' */
+       struct bpf_insn *bd_filter;     /* filter code */
+       u_int32_t       bd_rcount;      /* number of packets received */
+       u_int32_t       bd_dcount;      /* number of packets dropped */

 
 

-       u_char          bd_promisc;     /* true if listening promiscuously */
-       u_char          bd_state;       /* idle, waiting, or timed out */
-       u_char          bd_immediate;   /* true to return on packet arrival */
-       int             bd_async;       /* non-zero if packet reception should generate signal */
-       int             bd_sig;         /* signal to send upon packet reception */
+       u_char          bd_promisc;     /* true if listening promiscuously */
+       u_char          bd_state;       /* idle, waiting, or timed out */
+       u_char          bd_immediate;   /* true to return on packet arrival */
+       int             bd_async;       /* non-zero if packet reception should generate signal */
+       int             bd_sig;         /* signal to send upon packet reception */

 #ifdef __APPLE__
 #ifdef __APPLE__

-       pid_t           bd_sigio;
+       pid_t           bd_sigio;

 #else
 #else

-       struct sigio *  bd_sigio;       /* information for async I/O */
+       struct sigio *  bd_sigio;       /* information for async I/O */

 #endif
 
 #if BSD < 199103
 #endif
 
 #if BSD < 199103

-       u_char          bd_selcoll;     /* true if selects collide */
-       int             bd_timedout;
-       struct proc *   bd_selproc;     /* process that last selected us */
+       u_char          bd_selcoll;     /* true if selects collide */
+       int             bd_timedout;
+       struct proc *   bd_selproc;     /* process that last selected us */

 #else
 #else

-       u_char          bd_pad;         /* explicit alignment */
-       struct selinfo  bd_sel;         /* bsd select info */
+       u_char          bd_pad;         /* explicit alignment */
+       struct selinfo  bd_sel;         /* bsd select info */

 #endif
 #endif

-       int             bd_hdrcmplt;    /* false to fill in src lladdr automatically */
-       int             bd_seesent;     /* true if bpf should see sent packets */
+       int             bd_hdrcmplt;    /* false to fill in src lladdr automatically */
+       int             bd_seesent;     /* true if bpf should see sent packets */
+       int             bd_oflags;      /* device open flags */
+       thread_call_t   bd_thread_call; /* for BPF timeouts with select */
+       int             bd_traffic_class; /* traffic service class */
+       int             bd_flags;       /* flags */

 
 

+       int             bd_refcnt;
+#define BPF_REF_HIST    4               /* how many callers to keep around */
+       void            *bd_ref_lr[BPF_REF_HIST];
+       void            *bd_unref_lr[BPF_REF_HIST];
+       int             bd_next_ref_lr;
+       int             bd_next_unref_lr;
+
+       struct proc     *bd_opened_by;
+       uuid_t          bd_uuid;

 };
 
 };
 

+/* Values for bd_state */
+#define BPF_IDLE                0    /* no select in progress or kqueue pending */
+#define BPF_WAITING             1    /* waiting for read timeout in select/kqueue */
+#define BPF_TIMED_OUT   2        /* read timeout has expired in select/kqueue */
+#define BPF_DRAINING    3        /* waiting for timeout routine to finish during close */
+
+/* Test whether a BPF is ready for read(). */
+#define bpf_ready(bd)   ((bd)->bd_hlen != 0 ||          \
+                        (((bd)->bd_immediate || (bd)->bd_state == BPF_TIMED_OUT) && \
+                         (bd)->bd_slen != 0))
+
+/* Values for bd_flags */
+#define BPF_EXTENDED_HDR        0x0001  /* process req. the extended header */
+#define BPF_WANT_PKTAP          0x0002  /* knows how to handle DLT_PKTAP */
+#define BPF_FINALIZE_PKTAP      0x0004  /* finalize pktap header on read */
+#define BPF_KNOTE               0x0008  /* kernel note attached */
+#define BPF_DETACHING           0x0010  /* bpf_d is being detached */
+#define BPF_DETACHED            0x0020  /* bpf_d is detached */
+#define BPF_CLOSING             0x0040  /* bpf_d is being closed */
+#define BPF_TRUNCATE            0x0080  /* truncate the packet payload */
+#define BPF_PKTHDRV2            0x0100  /* pktap header version 2 */
+

 /*
  * Descriptor associated with each attached hardware interface.
  */
 struct bpf_if {
 /*
  * Descriptor associated with each attached hardware interface.
  */
 struct bpf_if {

-       struct bpf_if *bif_next;        /* list of all interfaces */
-       struct bpf_d *bif_dlist;        /* descriptor list */
-       u_int bif_dlt;                  /* link layer type */
-       u_int bif_hdrlen;               /* length of header (with padding) */
-       struct ifnet *bif_ifp;          /* corresponding interface */
+       struct bpf_if *bif_next;        /* list of all interfaces */
+       struct bpf_d *bif_dlist;        /* descriptor list */
+       u_int bif_dlt;                  /* link layer type */
+       u_int bif_hdrlen;               /* length of header (with padding) */
+       u_int bif_exthdrlen;            /* length of ext header */
+       struct ifnet *bif_ifp;          /* corresponding interface */
+       bpf_send_func   bif_send;
+       bpf_tap_func    bif_tap;

 };
 
 #endif /* KERNEL_PRIVATE */
 };
 
 #endif /* KERNEL_PRIVATE */