bsd/net/if_gif.h

   1 /*
   2  * Copyright (c) 2000-2018 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_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 License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*      $KAME: if_gif.h,v 1.7 2000/02/22 14:01:46 itojun Exp $  */
  29
  30 /*
  31  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
  32  * All rights reserved.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  * 3. Neither the name of the project nor the names of its contributors
  43  *    may be used to endorse or promote products derived from this software
  44  *    without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  */
  58
  59 /*
  60  * if_gif.h
  61  */
  62
  63 #ifndef _NET_IF_GIF_H_
  64 #define _NET_IF_GIF_H_
  65 #include <sys/appleapiopts.h>
  66
  67 #include <netinet/in.h>
  68 /* xxx sigh, why route have struct route instead of pointer? */
  69
  70 #ifdef BSD_KERNEL_PRIVATE
  71
  72 extern void gif_init(void);
  73
  74 struct encaptab;
  75
  76 struct gif_softc {
  77         ifnet_t                 gif_if;    /* pointer back to the interface */
  78         struct sockaddr *gif_psrc; /* Physical src addr */
  79         struct sockaddr *gif_pdst; /* Physical dst addr */
  80 #ifdef __APPLE__
  81         protocol_family_t gif_proto; /* dlil protocol attached */
  82 #endif
  83         union {
  84                 struct route  gifscr_ro;    /* xxx */
  85                 struct route_in6 gifscr_ro6; /* xxx */
  86         } gifsc_gifscr;
  87         int             gif_flags;
  88 #define IFGIF_DETACHING 0x1
  89         int             gif_called;
  90         const struct encaptab *encap_cookie4;
  91         const struct encaptab *encap_cookie6;
  92         TAILQ_ENTRY(gif_softc) gif_link; /* all gif's are linked */
  93         bpf_tap_mode    tap_mode;
  94         bpf_packet_func tap_callback;
  95         char    gif_ifname[IFNAMSIZ];
  96         decl_lck_mtx_data(, gif_lock);  /* lock for gif softc structure */
  97 };
  98
  99 #define GIF_LOCK(_sc)           lck_mtx_lock(&(_sc)->gif_lock)
 100 #define GIF_UNLOCK(_sc)         lck_mtx_unlock(&(_sc)->gif_lock)
 101 #define GIF_LOCK_ASSERT(_sc)    LCK_MTX_ASSERT(&(_sc)->gif_lock,        \
 102     LCK_MTX_ASSERT_OWNED)
 103
 104 #define gif_ro gifsc_gifscr.gifscr_ro
 105 #define gif_ro6 gifsc_gifscr.gifscr_ro6
 106
 107 #endif /* BSD_KERNEL_PRIVATE */
 108
 109 #define GIF_MTU         (1280)  /* Default MTU */
 110 #define GIF_MTU_MIN     (1280)  /* Minimum MTU */
 111 #define GIF_MTU_MAX     (8192)  /* Maximum MTU */
 112
 113 #endif /* _NET_IF_GIF_H_ */