bsd/net/if_arp.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) 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_arp.h    8.1 (Berkeley) 6/10/93
  55  * $FreeBSD: src/sys/net/if_arp.h,v 1.14.2.1 2000/07/11 20:46:55 archie Exp $
  56  */
  57
  58 #ifndef _NET_IF_ARP_H_
  59 #define _NET_IF_ARP_H_
  60 #include <sys/appleapiopts.h>
  61 #include <netinet/in.h>
  62
  63 /*
  64  * Address Resolution Protocol.
  65  *
  66  * See RFC 826 for protocol description.  ARP packets are variable
  67  * in size; the arphdr structure defines the fixed-length portion.
  68  * Protocol type values are the same as those for 10 Mb/s Ethernet.
  69  * It is followed by the variable-sized fields ar_sha, arp_spa,
  70  * arp_tha and arp_tpa in that order, according to the lengths
  71  * specified.  Field names used correspond to RFC 826.
  72  */
  73 struct  arphdr {
  74         u_short ar_hrd;         /* format of hardware address */
  75 #define ARPHRD_ETHER    1       /* ethernet hardware format */
  76 #define ARPHRD_IEEE802  6       /* token-ring hardware format */
  77 #define ARPHRD_FRELAY   15      /* frame relay hardware format */
  78         u_short ar_pro;         /* format of protocol address */
  79         u_char  ar_hln;         /* length of hardware address */
  80         u_char  ar_pln;         /* length of protocol address */
  81         u_short ar_op;          /* one of: */
  82 #define ARPOP_REQUEST   1       /* request to resolve address */
  83 #define ARPOP_REPLY     2       /* response to previous request */
  84 #define ARPOP_REVREQUEST 3      /* request protocol address given hardware */
  85 #define ARPOP_REVREPLY  4       /* response giving protocol address */
  86 #define ARPOP_INVREQUEST 8      /* request to identify peer */
  87 #define ARPOP_INVREPLY  9       /* response identifying peer */
  88 /*
  89  * The remaining fields are variable in size,
  90  * according to the sizes above.
  91  */
  92 #ifdef COMMENT_ONLY
  93         u_char  ar_sha[];       /* sender hardware address */
  94         u_char  ar_spa[];       /* sender protocol address */
  95         u_char  ar_tha[];       /* target hardware address */
  96         u_char  ar_tpa[];       /* target protocol address */
  97 #endif
  98 };
  99
 100 /*
 101  * ARP ioctl request
 102  */
 103 struct arpreq {
 104         struct  sockaddr arp_pa;                /* protocol address */
 105         struct  sockaddr arp_ha;                /* hardware address */
 106         int     arp_flags;                      /* flags */
 107 };
 108 /*  arp_flags and at_flags field values */
 109 #define ATF_INUSE       0x01    /* entry in use */
 110 #define ATF_COM         0x02    /* completed entry (enaddr valid) */
 111 #define ATF_PERM        0x04    /* permanent entry */
 112 #define ATF_PUBL        0x08    /* publish entry (respond for other host) */
 113 #define ATF_USETRAILERS 0x10    /* has requested trailers */
 114
 115 #ifdef __APPLE_API_UNSTABLE
 116
 117 #ifdef __APPLE__
 118 /*
 119  * Ethernet multicast address structure.  There is one of these for each
 120  * multicast address or range of multicast addresses that we are supposed
 121  * to listen to on a particular interface.  They are kept in a linked list,
 122  * rooted in the interface's arpcom structure.  (This really has nothing to
 123  * do with ARP, or with the Internet address family, but this appears to be
 124  * the minimally-disrupting place to put it.)
 125  */
 126 struct ether_multi {
 127         u_char  enm_addrlo[6];          /* low  or only address of range */
 128         u_char  enm_addrhi[6];          /* high or only address of range */
 129         struct  arpcom *enm_ac;         /* back pointer to arpcom */
 130         u_int   enm_refcount;           /* no. claims to this addr/range */
 131         struct  ether_multi *enm_next;  /* ptr to next ether_multi */
 132 };
 133
 134 /*
 135  * Structure used by macros below to remember position when stepping through
 136  * all of the ether_multi records.
 137  */
 138 struct ether_multistep {
 139         struct ether_multi  *e_enm;
 140 };
 141 #endif /* __APPLE__ */
 142
 143 #ifdef KERNEL
 144 /*
 145  * Structure shared between the ethernet driver modules and
 146  * the address resolution code.  For example, each ec_softc or il_softc
 147  * begins with this structure.
 148  */
 149 struct  arpcom {
 150         /*
 151          * The ifnet struct _must_ be at the head of this structure.
 152          */
 153         struct  ifnet ac_if;            /* network-visible interface */
 154         u_char  ac_enaddr[6];           /* ethernet hardware address */
 155 #ifdef __APPLE__
 156         struct  in_addr ac_ipaddr;      /* copy of ip address- XXX */
 157         struct  ether_multi *ac_multiaddrs; /* list of ether multicast addrs */
 158 #endif
 159         int     ac_multicnt;            /* length of ac_multiaddrs list */
 160 #ifndef __APPLE__
 161         void    *ac_netgraph;           /* ng_ether(4) netgraph node info */
 162 #endif
 163 };
 164
 165
 166 #endif
 167 #endif /* __APPLE_API_UNSTABLE */
 168
 169 #endif /* !_NET_IF_ARP_H_ */