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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)if_arp.h    8.1 (Berkeley) 6/10/93
  34  * $FreeBSD: src/sys/net/if_arp.h,v 1.14.2.3 2002/02/20 23:34:09 fjoe Exp $
  35  * $DragonFly: src/sys/net/if_arp.h,v 1.9 2008/11/24 12:19:14 hasso Exp $
  36  */
  37
  38 #ifndef _NET_IF_ARP_H_
  39 #define _NET_IF_ARP_H_
  40
  41 #ifndef _SYS_TYPES_H_
  42 #include <sys/types.h>
  43 #endif
  44 #ifndef _SYS_SOCKET_H_
  45 #include <sys/socket.h>
  46 #endif
  47
  48 /*
  49  * Address Resolution Protocol.
  50  *
  51  * See RFC 826 for protocol description.  ARP packets are variable
  52  * in size; the arphdr structure defines the fixed-length portion.
  53  * Protocol type values are the same as those for 10 Mb/s Ethernet.
  54  * It is followed by the variable-sized fields ar_sha, arp_spa,
  55  * arp_tha and arp_tpa in that order, according to the lengths
  56  * specified.  Field names used correspond to RFC 826.
  57  */
  58 struct  arphdr {
  59         u_short ar_hrd;         /* format of hardware address */
  60 #define ARPHRD_ETHER    1       /* ethernet hardware format */
  61 #define ARPHRD_IEEE802  6       /* token-ring hardware format */
  62 #define ARPHRD_ARCNET   7       /* arcnet hardware format */
  63 #define ARPHRD_FRELAY   15      /* frame relay hardware format */
  64 #define ARPHRD_IEEE1394 24      /* firewire hardware format */
  65         u_short ar_pro;         /* format of protocol address */
  66         u_char  ar_hln;         /* length of hardware address */
  67         u_char  ar_pln;         /* length of protocol address */
  68         u_short ar_op;          /* one of: */
  69 #define ARPOP_REQUEST   1       /* request to resolve address */
  70 #define ARPOP_REPLY     2       /* response to previous request */
  71 #define ARPOP_REVREQUEST 3      /* request protocol address given hardware */
  72 #define ARPOP_REVREPLY  4       /* response giving protocol address */
  73 #define ARPOP_INVREQUEST 8      /* request to identify peer */
  74 #define ARPOP_INVREPLY  9       /* response identifying peer */
  75 /*
  76  * The remaining fields are variable in size,
  77  * according to the sizes above.
  78  */
  79 #ifdef COMMENT_ONLY
  80         u_char  ar_sha[];       /* sender hardware address */
  81         u_char  ar_spa[];       /* sender protocol address */
  82         u_char  ar_tha[];       /* target hardware address */
  83         u_char  ar_tpa[];       /* target protocol address */
  84 #endif
  85 };
  86
  87 #define ar_sha(ap)      (((caddr_t)((ap)+1)) +   0)
  88 #define ar_spa(ap)      (((caddr_t)((ap)+1)) +   (ap)->ar_hln)
  89 #define ar_tha(ap)      (((caddr_t)((ap)+1)) +   (ap)->ar_hln + (ap)->ar_pln)
  90 #define ar_tpa(ap)      (((caddr_t)((ap)+1)) + 2*(ap)->ar_hln + (ap)->ar_pln)
  91
  92 #define arphdr_len2(ar_hln, ar_pln)                                     \
  93         (sizeof(struct arphdr) + 2*(ar_hln) + 2*(ar_pln))
  94 #define arphdr_len(ap)  (arphdr_len2((ap)->ar_hln, (ap)->ar_pln))
  95
  96 /*
  97  * ARP ioctl request
  98  */
  99 struct arpreq {
 100         struct  sockaddr arp_pa;                /* protocol address */
 101         struct  sockaddr arp_ha;                /* hardware address */
 102         int     arp_flags;                      /* flags */
 103 };
 104 /*  arp_flags and at_flags field values */
 105 #define ATF_INUSE       0x01    /* entry in use */
 106 #define ATF_COM         0x02    /* completed entry (enaddr valid) */
 107 #define ATF_PERM        0x04    /* permanent entry */
 108 #define ATF_PUBL        0x08    /* publish entry (respond for other host) */
 109 #define ATF_USETRAILERS 0x10    /* has requested trailers */
 110
 111 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 112 #ifndef _NET_IF_VAR_H_
 113 #include <net/if_var.h>
 114 #endif
 115
 116 /*
 117  * Structure shared between the ethernet driver modules and
 118  * the address resolution code.  For example, each ec_softc or il_softc
 119  * begins with this structure.
 120  */
 121 struct  arpcom {
 122         /*
 123          * The ifnet struct _must_ be at the head of this structure.
 124          */
 125         struct  ifnet ac_if;            /* network-visible interface */
 126         u_char  ac_enaddr[6];           /* ethernet hardware address */
 127         int     ac_multicnt;            /* length of ac_multiaddrs list */
 128         void    *ac_netgraph;           /* ng_ether(4) netgraph node info */
 129 };
 130
 131 #endif
 132
 133 #endif /* !_NET_IF_ARP_H_ */