xref: /netbsd/sys/net/if_arp.h (revision bf9ec67e)
1 /*	$NetBSD: if_arp.h,v 1.22 2001/06/12 15:17:27 wiz Exp $	*/
2 
3 /*
4  * Copyright (c) 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_arp.h	8.1 (Berkeley) 6/10/93
36  */
37 
38 #ifndef _NET_IF_ARP_H_
39 #define _NET_IF_ARP_H_
40 /*
41  * Address Resolution Protocol.
42  *
43  * See RFC 826 for protocol description.  ARP packets are variable
44  * in size; the arphdr structure defines the fixed-length portion.
45  * Protocol type values are the same as those for 10 Mb/s Ethernet.
46  * It is followed by the variable-sized fields ar_sha, arp_spa,
47  * arp_tha and arp_tpa in that order, according to the lengths
48  * specified.  Field names used correspond to RFC 826.
49  */
50 struct	arphdr {
51 	u_int16_t ar_hrd;	/* format of hardware address */
52 #define ARPHRD_ETHER 	1	/* ethernet hardware format */
53 #define ARPHRD_IEEE802 	6	/* IEEE 802 hardware format */
54 #define ARPHRD_ARCNET 	7	/* ethernet hardware format */
55 #define ARPHRD_FRELAY 	15	/* frame relay hardware format */
56 #define ARPHRD_STRIP 	23	/* Ricochet Starmode Radio hardware format */
57 #define	ARPHRD_IEEE1394	24	/* IEEE 1394 (FireWire) hardware format */
58 	u_int16_t ar_pro;	/* format of protocol address */
59 	u_int8_t  ar_hln;	/* length of hardware address */
60 	u_int8_t  ar_pln;	/* length of protocol address */
61 	u_int16_t ar_op;	/* one of: */
62 #define	ARPOP_REQUEST	1	/* request to resolve address */
63 #define	ARPOP_REPLY	2	/* response to previous request */
64 #define	ARPOP_REVREQUEST 3	/* request protocol address given hardware */
65 #define	ARPOP_REVREPLY	4	/* response giving protocol address */
66 #define	ARPOP_INVREQUEST 8 	/* request to identify peer */
67 #define	ARPOP_INVREPLY	9	/* response identifying peer */
68 /*
69  * The remaining fields are variable in size,
70  * according to the sizes above.
71  */
72 #ifdef COMMENT_ONLY
73 	u_int8_t  ar_sha[];	/* sender hardware address */
74 	u_int8_t  ar_spa[];	/* sender protocol address */
75 	u_int8_t  ar_tha[];	/* target hardware address */
76 	u_int8_t  ar_tpa[];	/* target protocol address */
77 #endif
78 #define ar_sha(ap) (((caddr_t)((ap)+1))+0)
79 #define ar_spa(ap) (((caddr_t)((ap)+1))+  (ap)->ar_hln)
80 #define ar_tha(ap) (((caddr_t)((ap)+1))+  (ap)->ar_hln+(ap)->ar_pln)
81 #define ar_tpa(ap) (((caddr_t)((ap)+1))+2*(ap)->ar_hln+(ap)->ar_pln)
82 } __attribute__((__packed__));
83 
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 /*
101  * Kernel statistics about arp
102  */
103 struct arpstat {
104 	u_quad_t	as_sndtotal;	/* total packets sent */
105 	u_quad_t	as_sndreply;	/* replies sent */
106 	u_quad_t	as_sndrequest;	/* requests sent */
107 
108 	u_quad_t	as_rcvtotal;	/* total packets received */
109 	u_quad_t	as_rcvrequest;	/* valid requests received */
110 	u_quad_t	as_rcvreply;	/* replies received */
111 	u_quad_t	as_rcvmcast;    /* multicast/broadcast received */
112 	u_quad_t	as_rcvbadproto;	/* unknown protocol type received */
113 	u_quad_t	as_rcvbadlen;	/* bad (short) length received */
114 	u_quad_t	as_rcvzerotpa;	/* received w/ null target ip */
115 	u_quad_t	as_rcvzerospa;	/* received w/ null src ip */
116 	u_quad_t	as_rcvnoint;	/* couldn't map to interface */
117 	u_quad_t	as_rcvlocalsha;	/* received from local hw address */
118 	u_quad_t	as_rcvbcastsha;	/* received w/ broadcast src */
119 	u_quad_t	as_rcvlocalspa;	/* received for a local ip [dup!] */
120 	u_quad_t	as_rcvoverperm;	/* attempts to overwrite static info */
121 	u_quad_t	as_rcvoverint;	/* attempts to overwrite wrong if */
122 	u_quad_t	as_rcvover;	/* entries overwritten! */
123 	u_quad_t	as_rcvlenchg;	/* changes in hw add len */
124 
125 	u_quad_t	as_dfrtotal;	/* deferred pending ARP resolution. */
126 	u_quad_t	as_dfrsent;	/* deferred, then sent */
127 	u_quad_t	as_dfrdropped;	/* deferred, then dropped */
128 
129 	u_quad_t	as_allocfail;	/* Failures to allocate llinfo */
130 };
131 
132 #endif /* _NET_IF_ARP_H_ */
133