lib/libstand/if_ether.h

   1 /*      $NetBSD: if_ether.h,v 1.25 1997/01/17 17:06:06 mikel Exp $      */
   2
   3 /*
   4  * Copyright (c) 1982, 1986, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. All advertising materials mentioning features or use of this software
  16  *    must display the following acknowledgement:
  17  *      This product includes software developed by the University of
  18  *      California, Berkeley and its contributors.
  19  * 4. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  *
  35  *      @(#)if_ether.h  8.1 (Berkeley) 6/10/93
  36  *
  37  * $FreeBSD: src/lib/libstand/if_ether.h,v 1.1.1.1.6.1 2000/09/20 09:49:17 jkh Exp $
  38  */
  39
  40 /*
  41  * Ethernet address - 6 octets
  42  * this is only used by the ethers(3) functions.
  43  */
  44 struct ether_addr {
  45         u_int8_t ether_addr_octet[6];
  46 };
  47
  48 /*
  49  * Structure of a 10Mb/s Ethernet header.
  50  */
  51 #define ETHER_ADDR_LEN  6
  52
  53 struct  ether_header {
  54         u_int8_t  ether_dhost[ETHER_ADDR_LEN];
  55         u_int8_t  ether_shost[ETHER_ADDR_LEN];
  56         u_int16_t ether_type;
  57 };
  58
  59 #define ETHERTYPE_PUP           0x0200  /* PUP protocol */
  60 #define ETHERTYPE_IP            0x0800  /* IP protocol */
  61 #define ETHERTYPE_ARP           0x0806  /* address resolution protocol */
  62 #define ETHERTYPE_REVARP        0x8035  /* reverse addr resolution protocol */
  63
  64 /*
  65  * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
  66  * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
  67  * by an ETHER type (as given above) and then the (variable-length) header.
  68  */
  69 #define ETHERTYPE_TRAIL         0x1000          /* Trailer packet */
  70 #define ETHERTYPE_NTRAILER      16
  71
  72 #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */
  73
  74 #define ETHERMTU        1500
  75 #define ETHERMIN        (60-14)
  76
  77 #ifdef _KERNEL
  78 /*
  79  * Macro to map an IP multicast address to an Ethernet multicast address.
  80  * The high-order 25 bits of the Ethernet address are statically assigned,
  81  * and the low-order 23 bits are taken from the low end of the IP address.
  82  */
  83 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr)                          \
  84         /* struct in_addr *ipaddr; */                                   \
  85         /* u_int8_t enaddr[ETHER_ADDR_LEN]; */                          \
  86 {                                                                       \
  87         (enaddr)[0] = 0x01;                                             \
  88         (enaddr)[1] = 0x00;                                             \
  89         (enaddr)[2] = 0x5e;                                             \
  90         (enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f;                   \
  91         (enaddr)[4] = ((u_int8_t *)ipaddr)[2];                          \
  92         (enaddr)[5] = ((u_int8_t *)ipaddr)[3];                          \
  93 }
  94 #endif
  95
  96 /*
  97  * Ethernet Address Resolution Protocol.
  98  *
  99  * See RFC 826 for protocol description.  Structure below is adapted
 100  * to resolving internet addresses.  Field names used correspond to
 101  * RFC 826.
 102  */
 103 struct  ether_arp {
 104         struct   arphdr ea_hdr;                 /* fixed-size header */
 105         u_int8_t arp_sha[ETHER_ADDR_LEN];       /* sender hardware address */
 106         u_int8_t arp_spa[4];                    /* sender protocol address */
 107         u_int8_t arp_tha[ETHER_ADDR_LEN];       /* target hardware address */
 108         u_int8_t arp_tpa[4];                    /* target protocol address */
 109 };
 110 #define arp_hrd ea_hdr.ar_hrd
 111 #define arp_pro ea_hdr.ar_pro
 112 #define arp_hln ea_hdr.ar_hln
 113 #define arp_pln ea_hdr.ar_pln
 114 #define arp_op  ea_hdr.ar_op
 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         struct   ifnet ac_if;                   /* network-visible interface */
 123         u_int8_t ac_enaddr[ETHER_ADDR_LEN];     /* ethernet hardware address */
 124         char     ac__pad[2];                    /* be nice to m68k ports */
 125         LIST_HEAD(, ether_multi) ac_multiaddrs; /* list of ether multicast addrs */
 126         int      ac_multicnt;                   /* length of ac_multiaddrs list */
 127 };
 128
 129 struct llinfo_arp {
 130         LIST_ENTRY(llinfo_arp) la_list;
 131         struct  rtentry *la_rt;
 132         struct  mbuf *la_hold;          /* last packet until resolved/timeout */
 133         long    la_asked;               /* last time we QUERIED for this addr */
 134 #define la_timer la_rt->rt_rmx.rmx_expire /* deletion time in seconds */
 135 };
 136
 137 struct sockaddr_inarp {
 138         u_int8_t  sin_len;
 139         u_int8_t  sin_family;
 140         u_int16_t sin_port;
 141         struct    in_addr sin_addr;
 142         struct    in_addr sin_srcaddr;
 143         u_int16_t sin_tos;
 144         u_int16_t sin_other;
 145 #define SIN_PROXY 1
 146 };
 147
 148 /*
 149  * IP and ethernet specific routing flags
 150  */
 151 #define RTF_USETRAILERS RTF_PROTO1      /* use trailers */
 152 #define RTF_ANNOUNCE    RTF_PROTO2      /* announce new arp entry */
 153
 154 #ifdef  _KERNEL
 155 u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN];
 156 u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN];
 157 u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN];
 158 struct  ifqueue arpintrq;
 159
 160 void    arpwhohas(struct arpcom *, struct in_addr *);
 161 void    arpintr(void);
 162 int     arpresolve(struct arpcom *,
 163             struct rtentry *, struct mbuf *, struct sockaddr *, u_char *);
 164 void    arp_ifinit(struct arpcom *, struct ifaddr *);
 165 void    arp_rtrequest(int, struct rtentry *, struct sockaddr *);
 166
 167 int     ether_addmulti(struct ifreq *, struct arpcom *);
 168 int     ether_delmulti(struct ifreq *, struct arpcom *);
 169 #endif /* _KERNEL */
 170
 171 /*
 172  * Ethernet multicast address structure.  There is one of these for each
 173  * multicast address or range of multicast addresses that we are supposed
 174  * to listen to on a particular interface.  They are kept in a linked list,
 175  * rooted in the interface's arpcom structure.  (This really has nothing to
 176  * do with ARP, or with the Internet address family, but this appears to be
 177  * the minimally-disrupting place to put it.)
 178  */
 179 struct ether_multi {
 180         u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low  or only address of range */
 181         u_int8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */
 182         struct   arpcom *enm_ac;        /* back pointer to arpcom */
 183         u_int    enm_refcount;          /* no. claims to this addr/range */
 184         LIST_ENTRY(ether_multi) enm_list;
 185 };
 186
 187 /*
 188  * Structure used by macros below to remember position when stepping through
 189  * all of the ether_multi records.
 190  */
 191 struct ether_multistep {
 192         struct ether_multi  *e_enm;
 193 };
 194
 195 /*
 196  * Macro for looking up the ether_multi record for a given range of Ethernet
 197  * multicast addresses connected to a given arpcom structure.  If no matching
 198  * record is found, "enm" returns NULL.
 199  */
 200 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm)                     \
 201         /* u_int8_t addrlo[ETHER_ADDR_LEN]; */                          \
 202         /* u_int8_t addrhi[ETHER_ADDR_LEN]; */                          \
 203         /* struct arpcom *ac; */                                        \
 204         /* struct ether_multi *enm; */                                  \
 205 {                                                                       \
 206         for ((enm) = (ac)->ac_multiaddrs.lh_first;                      \
 207             (enm) != NULL &&                                            \
 208             (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 ||  \
 209              bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0);   \
 210                 (enm) = (enm)->enm_list.le_next);                       \
 211 }
 212
 213 /*
 214  * Macro to step through all of the ether_multi records, one at a time.
 215  * The current position is remembered in "step", which the caller must
 216  * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
 217  * and get the first record.  Both macros return a NULL "enm" when there
 218  * are no remaining records.
 219  */
 220 #define ETHER_NEXT_MULTI(step, enm) \
 221         /* struct ether_multistep step; */  \
 222         /* struct ether_multi *enm; */  \
 223 { \
 224         if (((enm) = (step).e_enm) != NULL) \
 225                 (step).e_enm = (enm)->enm_list.le_next; \
 226 }
 227
 228 #define ETHER_FIRST_MULTI(step, ac, enm) \
 229         /* struct ether_multistep step; */ \
 230         /* struct arpcom *ac; */ \
 231         /* struct ether_multi *enm; */ \
 232 { \
 233         (step).e_enm = (ac)->ac_multiaddrs.lh_first; \
 234         ETHER_NEXT_MULTI((step), (enm)); \
 235 }
 236
 237 #ifdef _KERNEL
 238 void arp_rtrequest(int, struct rtentry *, struct sockaddr *);
 239 int arpresolve(struct arpcom *, struct rtentry *, struct mbuf *,
 240                     struct sockaddr *, u_char *);
 241 void arpintr(void);
 242 int arpioctl(u_long, caddr_t);
 243 void arp_ifinit(struct arpcom *, struct ifaddr *);
 244 void revarpinput(struct mbuf *);
 245 void in_revarpinput(struct mbuf *);
 246 void revarprequest(struct ifnet *);
 247 int revarpwhoarewe(struct ifnet *, struct in_addr *, struct in_addr *);
 248 int revarpwhoami(struct in_addr *, struct ifnet *);
 249 int db_show_arptab(void);
 250 #endif
 251
 252 /*
 253  * Prototype ethers(3) functions.
 254  */
 255 #ifndef _KERNEL
 256 #include <sys/cdefs.h>
 257 __BEGIN_DECLS
 258 char *  ether_ntoa(struct ether_addr *);
 259 struct ether_addr *
 260         ether_aton(char *);
 261 int     ether_ntohost(char *, struct ether_addr *);
 262 int     ether_hostton(char *, struct ether_addr *);
 263 int     ether_line(char *, struct ether_addr *, char *);
 264 __END_DECLS
 265 #endif