xref: /dragonfly/sys/net/if_arp.h (revision fcce2b94)
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.7 2006/05/21 03:43:45 dillon 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 #ifndef _NET_IF_H_
48 #include <net/if.h>
49 #endif
50 #ifndef _NET_IF_VAR_H_
51 #include <net/if_var.h>
52 #endif
53 
54 /*
55  * Address Resolution Protocol.
56  *
57  * See RFC 826 for protocol description.  ARP packets are variable
58  * in size; the arphdr structure defines the fixed-length portion.
59  * Protocol type values are the same as those for 10 Mb/s Ethernet.
60  * It is followed by the variable-sized fields ar_sha, arp_spa,
61  * arp_tha and arp_tpa in that order, according to the lengths
62  * specified.  Field names used correspond to RFC 826.
63  */
64 struct	arphdr {
65 	u_short	ar_hrd;		/* format of hardware address */
66 #define ARPHRD_ETHER	1	/* ethernet hardware format */
67 #define ARPHRD_IEEE802	6	/* token-ring hardware format */
68 #define ARPHRD_ARCNET	7	/* arcnet hardware format */
69 #define ARPHRD_FRELAY	15	/* frame relay hardware format */
70 	u_short	ar_pro;		/* format of protocol address */
71 	u_char	ar_hln;		/* length of hardware address */
72 	u_char	ar_pln;		/* length of protocol address */
73 	u_short	ar_op;		/* one of: */
74 #define	ARPOP_REQUEST	1	/* request to resolve address */
75 #define	ARPOP_REPLY	2	/* response to previous request */
76 #define	ARPOP_REVREQUEST 3	/* request protocol address given hardware */
77 #define	ARPOP_REVREPLY	4	/* response giving protocol address */
78 #define ARPOP_INVREQUEST 8	/* request to identify peer */
79 #define ARPOP_INVREPLY	9	/* response identifying peer */
80 /*
81  * The remaining fields are variable in size,
82  * according to the sizes above.
83  */
84 #ifdef COMMENT_ONLY
85 	u_char	ar_sha[];	/* sender hardware address */
86 	u_char	ar_spa[];	/* sender protocol address */
87 	u_char	ar_tha[];	/* target hardware address */
88 	u_char	ar_tpa[];	/* target protocol address */
89 #endif
90 };
91 
92 #define ar_sha(ap)	(((caddr_t)((ap)+1)) +   0)
93 #define ar_spa(ap)	(((caddr_t)((ap)+1)) +   (ap)->ar_hln)
94 #define ar_tha(ap)	(((caddr_t)((ap)+1)) +   (ap)->ar_hln + (ap)->ar_pln)
95 #define ar_tpa(ap)	(((caddr_t)((ap)+1)) + 2*(ap)->ar_hln + (ap)->ar_pln)
96 
97 #define arphdr_len2(ar_hln, ar_pln)					\
98 	(sizeof(struct arphdr) + 2*(ar_hln) + 2*(ar_pln))
99 #define arphdr_len(ap)	(arphdr_len2((ap)->ar_hln, (ap)->ar_pln))
100 
101 /*
102  * ARP ioctl request
103  */
104 struct arpreq {
105 	struct	sockaddr arp_pa;		/* protocol address */
106 	struct	sockaddr arp_ha;		/* hardware address */
107 	int	arp_flags;			/* flags */
108 };
109 /*  arp_flags and at_flags field values */
110 #define	ATF_INUSE	0x01	/* entry in use */
111 #define ATF_COM		0x02	/* completed entry (enaddr valid) */
112 #define	ATF_PERM	0x04	/* permanent entry */
113 #define	ATF_PUBL	0x08	/* publish entry (respond for other host) */
114 #define	ATF_USETRAILERS	0x10	/* has requested trailers */
115 
116 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
117 
118 /*
119  * Structure shared between the ethernet driver modules and
120  * the address resolution code.  For example, each ec_softc or il_softc
121  * begins with this structure.
122  */
123 struct	arpcom {
124 	/*
125 	 * The ifnet struct _must_ be at the head of this structure.
126 	 */
127 	struct	ifnet ac_if;		/* network-visible interface */
128 	u_char	ac_enaddr[6];		/* ethernet hardware address */
129 	int	ac_multicnt;		/* length of ac_multiaddrs list */
130 	void	*ac_netgraph;		/* ng_ether(4) netgraph node info */
131 };
132 
133 #endif
134 
135 #endif /* !_NET_IF_ARP_H_ */
136