sys/net/if_arp.h

   1 /*-
   2  * Copyright (c) 1986, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)if_arp.h    8.1 (Berkeley) 6/10/93
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _NET_IF_ARP_H_
  34 #define _NET_IF_ARP_H_
  35
  36 /*
  37  * Address Resolution Protocol.
  38  *
  39  * See RFC 826 for protocol description.  ARP packets are variable
  40  * in size; the arphdr structure defines the fixed-length portion.
  41  * Protocol type values are the same as those for 10 Mb/s Ethernet.
  42  * It is followed by the variable-sized fields ar_sha, arp_spa,
  43  * arp_tha and arp_tpa in that order, according to the lengths
  44  * specified.  Field names used correspond to RFC 826.
  45  */
  46 struct  arphdr {
  47         u_short ar_hrd;         /* format of hardware address */
  48 #define ARPHRD_ETHER    1       /* ethernet hardware format */
  49 #define ARPHRD_IEEE802  6       /* token-ring hardware format */
  50 #define ARPHRD_ARCNET   7       /* arcnet hardware format */
  51 #define ARPHRD_FRELAY   15      /* frame relay hardware format */
  52 #define ARPHRD_IEEE1394 24      /* firewire hardware format */
  53 #define ARPHRD_INFINIBAND 32    /* infiniband hardware format */
  54         u_short ar_pro;         /* format of protocol address */
  55         u_char  ar_hln;         /* length of hardware address */
  56         u_char  ar_pln;         /* length of protocol address */
  57         u_short ar_op;          /* one of: */
  58 #define ARPOP_REQUEST   1       /* request to resolve address */
  59 #define ARPOP_REPLY     2       /* response to previous request */
  60 #define ARPOP_REVREQUEST 3      /* request protocol address given hardware */
  61 #define ARPOP_REVREPLY  4       /* response giving protocol address */
  62 #define ARPOP_INVREQUEST 8      /* request to identify peer */
  63 #define ARPOP_INVREPLY  9       /* response identifying peer */
  64 /*
  65  * The remaining fields are variable in size,
  66  * according to the sizes above.
  67  */
  68 #ifdef COMMENT_ONLY
  69         u_char  ar_sha[];       /* sender hardware address */
  70         u_char  ar_spa[];       /* sender protocol address */
  71         u_char  ar_tha[];       /* target hardware address */
  72         u_char  ar_tpa[];       /* target protocol address */
  73 #endif
  74 };
  75
  76 #define ar_sha(ap)      (((caddr_t)((ap)+1)) +   0)
  77 #define ar_spa(ap)      (((caddr_t)((ap)+1)) +   (ap)->ar_hln)
  78 #define ar_tha(ap)      (((caddr_t)((ap)+1)) +   (ap)->ar_hln + (ap)->ar_pln)
  79 #define ar_tpa(ap)      (((caddr_t)((ap)+1)) + 2*(ap)->ar_hln + (ap)->ar_pln)
  80
  81 #define arphdr_len2(ar_hln, ar_pln)                                     \
  82         (sizeof(struct arphdr) + 2*(ar_hln) + 2*(ar_pln))
  83 #define arphdr_len(ap)  (arphdr_len2((ap)->ar_hln, (ap)->ar_pln))
  84
  85 /*
  86  * ARP ioctl request
  87  */
  88 struct arpreq {
  89         struct  sockaddr arp_pa;                /* protocol address */
  90         struct  sockaddr arp_ha;                /* hardware address */
  91         int     arp_flags;                      /* flags */
  92 };
  93 /*  arp_flags and at_flags field values */
  94 #define ATF_INUSE       0x01    /* entry in use */
  95 #define ATF_COM         0x02    /* completed entry (enaddr valid) */
  96 #define ATF_PERM        0x04    /* permanent entry */
  97 #define ATF_PUBL        0x08    /* publish entry (respond for other host) */
  98 #define ATF_USETRAILERS 0x10    /* has requested trailers */
  99
 100 #ifdef _KERNEL
 101 /*
 102  * Structure shared between the ethernet driver modules and
 103  * the address resolution code.
 104  */
 105 struct  arpcom {
 106         struct  ifnet *ac_ifp;          /* network-visible interface */
 107         void    *ac_netgraph;           /* ng_ether(4) netgraph node info */
 108 };
 109 #define IFP2AC(ifp) ((struct arpcom *)(ifp->if_l2com))
 110 #define AC2IFP(ac) ((ac)->ac_ifp)
 111
 112 #endif /* _KERNEL */
 113
 114 struct arpstat {
 115         /* Normal things that happen: */
 116         uint64_t txrequests;    /* # of ARP requests sent by this host. */
 117         uint64_t txreplies;     /* # of ARP replies sent by this host. */
 118         uint64_t rxrequests;    /* # of ARP requests received by this host. */
 119         uint64_t rxreplies;     /* # of ARP replies received by this host. */
 120         uint64_t received;      /* # of ARP packets received by this host. */
 121
 122         uint64_t arp_spares[4]; /* For either the upper or lower half. */
 123         /* Abnormal event and error  counting: */
 124         uint64_t dropped;       /* # of packets dropped waiting for a reply. */
 125         uint64_t timeouts;      /* # of times with entries removed */
 126                                 /* due to timeout. */
 127         uint64_t dupips;        /* # of duplicate IPs detected. */
 128 };
 129
 130 #ifdef _KERNEL
 131 #include <sys/counter.h>
 132 #include <net/vnet.h>
 133
 134 VNET_PCPUSTAT_DECLARE(struct arpstat, arpstat);
 135 /*
 136  * In-kernel consumers can use these accessor macros directly to update
 137  * stats.
 138  */
 139 #define ARPSTAT_ADD(name, val)  \
 140     VNET_PCPUSTAT_ADD(struct arpstat, arpstat, name, (val))
 141 #define ARPSTAT_SUB(name, val)  ARPSTAT_ADD(name, -(val))
 142 #define ARPSTAT_INC(name)       ARPSTAT_ADD(name, 1)
 143 #define ARPSTAT_DEC(name)       ARPSTAT_SUB(name, 1)
 144
 145 #endif /* _KERNEL */
 146
 147 #endif /* !_NET_IF_ARP_H_ */