xref: /freebsd/usr.sbin/arp/arp.4 (revision 478df1d534e9b1ca86261fcef37b46cc7b4c8f17)
1.\" Copyright (c) 1985, 1986, 1988, 1994
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 4. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)arp4.4	6.5 (Berkeley) 4/18/94
29.\" $FreeBSD$
30.\"
31.Dd September 3, 2012
32.Dt ARP 4
33.Os
34.Sh NAME
35.Nm arp
36.Nd Address Resolution Protocol
37.Sh SYNOPSIS
38.Cd "device ether"
39.Sh DESCRIPTION
40The Address Resolution Protocol (ARP) is used to dynamically
41map between Protocol Addresses (such as IP addresses) and
42Local Network Addresses (such as Ethernet addresses).
43This implementation maps IP addresses to Ethernet,
44ARCnet,
45or Token Ring addresses.
46It is used by all the Ethernet interface drivers.
47.Pp
48ARP caches Internet-Ethernet address mappings.
49When an interface requests a mapping for an address not in the cache,
50ARP queues the message which requires the mapping and broadcasts
51a message on the associated network requesting the address mapping.
52If a response is provided, the new mapping is cached and any pending
53message is transmitted.
54ARP will queue at most one packet while waiting for a response to a
55mapping request;
56only the most recently ``transmitted'' packet is kept.
57If the target host does not respond after several requests,
58the host is considered to be down allowing an error to be returned to
59transmission attempts.
60Further demand for this mapping causes ARP request retransmissions, that
61are ratelimited to one packet per second.
62The error is
63.Er EHOSTDOWN
64for a non-responding destination host, and
65.Er EHOSTUNREACH
66for a non-responding router.
67.Pp
68The ARP cache is stored in the system routing table as
69dynamically-created host routes.
70The route to a directly-attached Ethernet network is installed as a
71.Dq cloning
72route (one with the
73.Li RTF_CLONING
74flag set),
75causing routes to individual hosts on that network to be created on
76demand.
77These routes time out periodically (normally 20 minutes after validated;
78entries are not validated when not in use).
79.Pp
80ARP entries may be added, deleted or changed with the
81.Xr arp 8
82utility.
83Manually-added entries may be temporary or permanent,
84and may be
85.Dq published ,
86in which case the system will respond to ARP requests for that host
87as if it were the target of the request.
88.Pp
89In the past,
90ARP was used to negotiate the use of a trailer encapsulation.
91This is no longer supported.
92.Pp
93ARP watches passively for hosts impersonating the local host (i.e., a host
94which responds to an ARP mapping request for the local host's address).
95.Pp
96Proxy ARP is a feature whereby the local host will respond to requests
97for addresses other than itself, with its own address.
98Normally, proxy ARP in
99.Fx
100is set up on a host-by-host basis using the
101.Xr arp 8
102utility, by adding an entry for each host inside a given subnet for
103which proxying of ARP requests is desired.
104However, the
105.Dq "proxy all"
106feature causes the local host to act as a proxy for
107.Em all
108hosts reachable through some other network interface,
109different from the one the request came in from.
110It may be enabled by setting the
111.Xr sysctl 8
112MIB variable
113.Va net.link.ether.inet.proxyall
114to 1.
115.Sh MIB Variables
116The ARP protocol implements a number of configurable variables in
117.Va net.link.ether.inet
118branch
119of the
120.Xr sysctl 3
121MIB.
122.Bl -tag -width "log_arp_permanent_modify"
123.It Va allow_multicast
124Should the kernel install ARP entries with multicast bit set in
125the hardware address.
126Installing such entries is RFC 1812 violation, but some prorietary
127load balancing techniques require routers on network to do so.
128Turned off by default.
129.It Va log_arp_movements
130Should the kernel log movements of IP addresses from one hardware
131address to an other.
132See
133.Sx DIAGNOSTICS
134below.
135Turned on by default.
136.It Va log_arp_permanent_modify
137Should the kernel log attempts of remote host on network to modify a
138permanent ARP entry.
139See
140.Sx DIAGNOSTICS
141below.
142Turned on by default.
143.It Va log_arp_wrong_iface
144Should the kernel log attempts to insert an ARP entry on an interface
145when the IP network the address belongs to is connected to an other
146interface.
147See
148.Sx DIAGNOSTICS
149below.
150Turned on by default.
151.It Va max_age
152How long an ARP entry is held in the cache until it needs to be refreshed.
153Default is 1200 seconds.
154.It Va maxhold
155How many packets hold in the per-entry output queue while the entry
156is being resolved.
157Default is one packet.
158.It Va maxtries
159Number of retransmits before host is considered down and error is returned.
160Default is 5 tries.
161.It Va proxyall
162Enables ARP proxying for all hosts on net.
163Turned off by default.
164.It Va useloopback
165If an ARP entry is added for local address, force the traffic to go through
166the loopback interface.
167Turned on by default.
168.It Va wait
169Lifetime of an incomplete ARP entry.
170Default is 20 seconds.
171.El
172.Sh DIAGNOSTICS
173.Bl -diag
174.It "arp: %x:%x:%x:%x:%x:%x is using my IP address %d.%d.%d.%d on %s!"
175ARP has discovered another host on the local network which responds to
176mapping requests for its own Internet address with a different Ethernet
177address, generally indicating that two hosts are attempting to use the
178same Internet address.
179.It "arp: link address is broadcast for IP address %d.%d.%d.%d!"
180ARP requested information for a host, and received an answer indicating
181that the host's ethernet address is the ethernet broadcast address.
182This indicates a misconfigured or broken device.
183.It "arp: %d.%d.%d.%d moved from %x:%x:%x:%x:%x:%x to %x:%x:%x:%x:%x:%x on %s"
184ARP had a cached value for the ethernet address of the referenced host,
185but received a reply indicating that the host is at a new address.
186This can happen normally when host hardware addresses change,
187or when a mobile node arrives or leaves the local subnet.
188It can also indicate a problem with proxy ARP.
189This message can only be issued if the sysctl
190.Va net.link.ether.inet.log_arp_movements
191is set to 1, which is the system's default behaviour.
192.It "arpresolve: can't allocate llinfo for %d.%d.%d.%d"
193The route for the referenced host points to a device upon which ARP is
194required, but ARP was unable to allocate a routing table entry in which
195to store the host's MAC address.
196This usually points to a misconfigured routing table.
197It can also occur if the kernel cannot allocate memory.
198.It "arp: %d.%d.%d.%d is on if0 but got reply from %x:%x:%x:%x:%x:%x on if1"
199Physical connections exist to the same logical IP network on both if0 and if1.
200It can also occur if an entry already exists in the ARP cache for the IP
201address above, and the cable has been disconnected from if0, then reconnected
202to if1.
203This message can only be issued if the sysctl
204.Va net.link.ether.inet.log_arp_wrong_iface
205is set to 1, which is the system's default behaviour.
206.It "arp: %x:%x:%x:%x:%x:%x attempts to modify permanent entry for %d.%d.%d.%d on %s"
207ARP has received an ARP reply that attempts to overwrite a permanent
208entry in the local ARP table.
209This error will only be logged if the sysctl
210.Va net.link.ether.inet.log_arp_permanent_modify
211is set to 1, which is the system's default behaviour.
212.It "arp: %x:%x:%x:%x:%x:%x is multicast"
213Kernel refused to install an entry with multicast hardware address.
214If you really want such addresses being installed, set the sysctl
215.Va net.link.ether.inet.allow_multicast
216to a positive value.
217.El
218.Sh SEE ALSO
219.Xr inet 4 ,
220.Xr route 4 ,
221.Xr arp 8 ,
222.Xr ifconfig 8 ,
223.Xr route 8 ,
224.Xr sysctl 8
225.Rs
226.%A Plummer, D.
227.%B "An Ethernet Address Resolution Protocol"
228.%T RFC826
229.Re
230.Rs
231.%A Leffler, S.J.
232.%A Karels, M.J.
233.%B "Trailer Encapsulations"
234.%T RFC893
235.Re
236