bsd/netinet/if_ether.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1982, 1986, 1993
  24  *      The Regents of the University of California.  All rights reserved.
  25  *
  26  * Redistribution and use in source and binary forms, with or without
  27  * modification, are permitted provided that the following conditions
  28  * are met:
  29  * 1. Redistributions of source code must retain the above copyright
  30  *    notice, this list of conditions and the following disclaimer.
  31  * 2. Redistributions in binary form must reproduce the above copyright
  32  *    notice, this list of conditions and the following disclaimer in the
  33  *    documentation and/or other materials provided with the distribution.
  34  * 3. All advertising materials mentioning features or use of this software
  35  *    must display the following acknowledgement:
  36  *      This product includes software developed by the University of
  37  *      California, Berkeley and its contributors.
  38  * 4. Neither the name of the University nor the names of its contributors
  39  *    may be used to endorse or promote products derived from this software
  40  *    without specific prior written permission.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  *
  54  *      @(#)if_ether.h  8.3 (Berkeley) 5/2/95
  55  * $FreeBSD: src/sys/netinet/if_ether.h,v 1.24 1999/12/29 04:40:58 peter Exp $
  56  */
  57
  58 #ifndef _NETINET_IF_ETHER_H_
  59 #define _NETINET_IF_ETHER_H_
  60 #include <sys/appleapiopts.h>
  61
  62 #include <net/ethernet.h>
  63
  64 #include <netinet/in.h>
  65 #include <net/if_arp.h>
  66 #define ea_byte ether_addr_octet
  67
  68 #ifdef __APPLE__
  69 #ifdef __APPLE_API_UNSTABLE
  70 /*
  71  * Macro for looking up the ether_multi record for a given range of Ethernet
  72  * multicast addresses connected to a given arpcom structure.  If no matching
  73  * record is found, "enm" returns NULL.
  74  */
  75 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \
  76         /* u_char addrlo[6]; */ \
  77         /* u_char addrhi[6]; */ \
  78         /* struct arpcom *ac; */ \
  79         /* struct ether_multi *enm; */ \
  80 { \
  81         for ((enm) = (ac)->ac_multiaddrs; \
  82             (enm) != NULL && \
  83             (bcmp((enm)->enm_addrlo, (addrlo), 6) != 0 || \
  84              bcmp((enm)->enm_addrhi, (addrhi), 6) != 0); \
  85                 (enm) = (enm)->enm_next); \
  86 }
  87
  88 /*
  89  * Macro to step through all of the ether_multi records, one at a time.
  90  * The current position is remembered in "step", which the caller must
  91  * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
  92  * and get the first record.  Both macros return a NULL "enm" when there
  93  * are no remaining records.
  94  */
  95 #define ETHER_NEXT_MULTI(step, enm) \
  96         /* struct ether_multistep step; */  \
  97         /* struct ether_multi *enm; */  \
  98 { \
  99         if (((enm) = (step).e_enm) != NULL) \
 100                 (step).e_enm = (enm)->enm_next; \
 101 }
 102
 103 #define ETHER_FIRST_MULTI(step, ac, enm) \
 104         /* struct ether_multistep step; */ \
 105         /* struct arpcom *ac; */ \
 106         /* struct ether_multi *enm; */ \
 107 { \
 108         (step).e_enm = (ac)->ac_multiaddrs; \
 109         ETHER_NEXT_MULTI((step), (enm)); \
 110 }
 111 #endif /* __APPLE_API_UNSTABLE */
 112 #endif /* __APPLE__ */
 113
 114 /*
 115  * Macro to map an IP multicast address to an Ethernet multicast address.
 116  * The high-order 25 bits of the Ethernet address are statically assigned,
 117  * and the low-order 23 bits are taken from the low end of the IP address.
 118  */
 119 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \
 120         /* struct in_addr *ipaddr; */ \
 121         /* u_char enaddr[ETHER_ADDR_LEN];          */ \
 122 { \
 123         (enaddr)[0] = 0x01; \
 124         (enaddr)[1] = 0x00; \
 125         (enaddr)[2] = 0x5e; \
 126         (enaddr)[3] = ((u_char *)ipaddr)[1] & 0x7f; \
 127         (enaddr)[4] = ((u_char *)ipaddr)[2]; \
 128         (enaddr)[5] = ((u_char *)ipaddr)[3]; \
 129 }
 130 /*
 131  * Macro to map an IP6 multicast address to an Ethernet multicast address.
 132  * The high-order 16 bits of the Ethernet address are statically assigned,
 133  * and the low-order 32 bits are taken from the low end of the IP6 address.
 134  */
 135 #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr)                       \
 136 /* struct       in6_addr *ip6addr; */                                   \
 137 /* u_char       enaddr[ETHER_ADDR_LEN]; */                              \
 138 {                                                                       \
 139         (enaddr)[0] = 0x33;                                             \
 140         (enaddr)[1] = 0x33;                                             \
 141         (enaddr)[2] = ((u_char *)ip6addr)[12];                          \
 142         (enaddr)[3] = ((u_char *)ip6addr)[13];                          \
 143         (enaddr)[4] = ((u_char *)ip6addr)[14];                          \
 144         (enaddr)[5] = ((u_char *)ip6addr)[15];                          \
 145 }
 146
 147 /*
 148  * Ethernet Address Resolution Protocol.
 149  *
 150  * See RFC 826 for protocol description.  Structure below is adapted
 151  * to resolving internet addresses.  Field names used correspond to
 152  * RFC 826.
 153  */
 154 struct  ether_arp {
 155         struct  arphdr ea_hdr;  /* fixed-size header */
 156         u_char  arp_sha[ETHER_ADDR_LEN];        /* sender hardware address */
 157         u_char  arp_spa[4];     /* sender protocol address */
 158         u_char  arp_tha[ETHER_ADDR_LEN];        /* target hardware address */
 159         u_char  arp_tpa[4];     /* target protocol address */
 160 };
 161 #define arp_hrd ea_hdr.ar_hrd
 162 #define arp_pro ea_hdr.ar_pro
 163 #define arp_hln ea_hdr.ar_hln
 164 #define arp_pln ea_hdr.ar_pln
 165 #define arp_op  ea_hdr.ar_op
 166
 167 struct sockaddr_inarp {
 168         u_char  sin_len;
 169         u_char  sin_family;
 170         u_short sin_port;
 171         struct  in_addr sin_addr;
 172         struct  in_addr sin_srcaddr;
 173         u_short sin_tos;
 174         u_short sin_other;
 175 #define SIN_PROXY 1
 176 };
 177 /*
 178  * IP and ethernet specific routing flags
 179  */
 180 #define RTF_USETRAILERS RTF_PROTO1      /* use trailers */
 181 #define RTF_ANNOUNCE    RTF_PROTO2      /* announce new arp entry */
 182
 183 #ifdef  KERNEL
 184 #ifdef __APPLE_API_PRIVATE
 185 extern u_char   ether_ipmulticast_min[ETHER_ADDR_LEN];
 186 extern u_char   ether_ipmulticast_max[ETHER_ADDR_LEN];
 187 extern struct   ifqueue arpintrq;
 188
 189 int     arpresolve __P((struct arpcom *, struct rtentry *, struct mbuf *,
 190                         struct sockaddr *, u_char *, struct rtentry *));
 191 #endif /* __APPLE_API_PRIVATE */
 192 #ifdef __APPLE_API_UNSTABLE
 193 void    arp_ifinit __P((struct arpcom *, struct ifaddr *));
 194 #endif /* __APPLE_API_UNSTABLE */
 195 #endif
 196
 197 #endif