xref: /netbsd-src/sys/net/if_arp.h (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /*	$NetBSD: if_arp.h,v 1.24 2003/08/07 16:32:50 agc 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. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)if_arp.h	8.1 (Berkeley) 6/10/93
32  */
33 
34 #ifndef _NET_IF_ARP_H_
35 #define _NET_IF_ARP_H_
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_int16_t ar_hrd;	/* format of hardware address */
48 #define ARPHRD_ETHER 	1	/* ethernet hardware format */
49 #define ARPHRD_IEEE802 	6	/* IEEE 802 hardware format */
50 #define ARPHRD_ARCNET 	7	/* ethernet hardware format */
51 #define ARPHRD_FRELAY 	15	/* frame relay hardware format */
52 #define ARPHRD_STRIP 	23	/* Ricochet Starmode Radio hardware format */
53 #define	ARPHRD_IEEE1394	24	/* IEEE 1394 (FireWire) hardware format */
54 	u_int16_t ar_pro;	/* format of protocol address */
55 	u_int8_t  ar_hln;	/* length of hardware address */
56 	u_int8_t  ar_pln;	/* length of protocol address */
57 	u_int16_t 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_int8_t  ar_sha[];	/* sender hardware address */
70 	u_int8_t  ar_spa[];	/* sender protocol address */
71 	u_int8_t  ar_tha[];	/* target hardware address */
72 	u_int8_t  ar_tpa[];	/* target protocol address */
73 #endif
74 #define ar_sha(ap) (((caddr_t)((ap)+1))+0)
75 #define ar_spa(ap) (((caddr_t)((ap)+1))+(ap)->ar_hln)
76 #define ar_tha(ap) \
77 	(ntohs((ap)->ar_hrd) == ARPHRD_IEEE1394 \
78 		? NULL : (((caddr_t)((ap)+1))+(ap)->ar_hln+(ap)->ar_pln))
79 #define ar_tpa(ap) \
80 	(ntohs((ap)->ar_hrd) == ARPHRD_IEEE1394 \
81 		? (((caddr_t)((ap)+1))+(ap)->ar_hln+(ap)->ar_pln) \
82 		: (((caddr_t)((ap)+1))+(ap)->ar_hln+(ap)->ar_pln+(ap)->ar_hln))
83 } __attribute__((__packed__));
84 
85 
86 /*
87  * ARP ioctl request
88  */
89 struct arpreq {
90 	struct	sockaddr arp_pa;		/* protocol address */
91 	struct	sockaddr arp_ha;		/* hardware address */
92 	int	arp_flags;			/* flags */
93 };
94 /*  arp_flags and at_flags field values */
95 #define	ATF_INUSE	0x01	/* entry in use */
96 #define ATF_COM		0x02	/* completed entry (enaddr valid) */
97 #define	ATF_PERM	0x04	/* permanent entry */
98 #define	ATF_PUBL	0x08	/* publish entry (respond for other host) */
99 #define	ATF_USETRAILERS	0x10	/* has requested trailers */
100 
101 /*
102  * Kernel statistics about arp
103  */
104 struct arpstat {
105 	u_quad_t	as_sndtotal;	/* total packets sent */
106 	u_quad_t	as_sndreply;	/* replies sent */
107 	u_quad_t	as_sndrequest;	/* requests sent */
108 
109 	u_quad_t	as_rcvtotal;	/* total packets received */
110 	u_quad_t	as_rcvrequest;	/* valid requests received */
111 	u_quad_t	as_rcvreply;	/* replies received */
112 	u_quad_t	as_rcvmcast;    /* multicast/broadcast received */
113 	u_quad_t	as_rcvbadproto;	/* unknown protocol type received */
114 	u_quad_t	as_rcvbadlen;	/* bad (short) length received */
115 	u_quad_t	as_rcvzerotpa;	/* received w/ null target ip */
116 	u_quad_t	as_rcvzerospa;	/* received w/ null src ip */
117 	u_quad_t	as_rcvnoint;	/* couldn't map to interface */
118 	u_quad_t	as_rcvlocalsha;	/* received from local hw address */
119 	u_quad_t	as_rcvbcastsha;	/* received w/ broadcast src */
120 	u_quad_t	as_rcvlocalspa;	/* received for a local ip [dup!] */
121 	u_quad_t	as_rcvoverperm;	/* attempts to overwrite static info */
122 	u_quad_t	as_rcvoverint;	/* attempts to overwrite wrong if */
123 	u_quad_t	as_rcvover;	/* entries overwritten! */
124 	u_quad_t	as_rcvlenchg;	/* changes in hw add len */
125 
126 	u_quad_t	as_dfrtotal;	/* deferred pending ARP resolution. */
127 	u_quad_t	as_dfrsent;	/* deferred, then sent */
128 	u_quad_t	as_dfrdropped;	/* deferred, then dropped */
129 
130 	u_quad_t	as_allocfail;	/* Failures to allocate llinfo */
131 };
132 
133 #endif /* _NET_IF_ARP_H_ */
134