Seth Woolley's Man Viewer

Manual for arp - man 7 arp

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

ARP(7)                     Linux Programmer's Manual                    ARP(7)



NAME
       arp(7,8) - Linux ARP kernel module.

DESCRIPTION
       This  kernel protocol module implements the Address Resolution Protocol
       defined in(1,8) RFC 826.  It is used  to  convert  between  Layer2  hardware
       addresses  and  IPv4 protocol addresses on directly connected networks.
       The user normally doesn't interact directly with this module except  to
       configure  it; instead it provides a service for other protocols in(1,8) the
       kernel.

       A user process can receive ARP  packets  by  using  packet(7)  sockets.
       There  is  also a mechanism for managing the ARP cache in(1,8) user-space by
       using netlink(3,7)(7) sockets. The ARP table  can  also  be  controlled  via
       ioctl (2) on any PF_INET socket.

       The ARP module maintains a cache of mappings between hardware addresses
       and protocol addresses.  The cache has a limited size so old  and  less(1,3)
       frequently  used  entries  are  garbage-collected.   Entries  which are
       marked as permanent are never deleted by  the  garbage-collector.   The
       cache  can  be directly manipulated by the use of ioctls and its behav-
       iour can be tuned by the sysctls defined below.

       When there is no positive feedback for an existing mapping  after  some
       time(1,2,n)  (see  the  sysctls  below)  a neighbour cache entry is considered
       stale.  Positive feedback can be gotten from a higher layer; for  exam-
       ple  from  a  successful  TCP  ACK.  Other protocols can signal(2,7) forward
       progress using the MSG_CONFIRM flag to sendmsg(2).  When  there  is  no
       forward  progress  ARP tries to reprobe.  It first tries to ask a local
       arp(7,8) daemon app_solicit times for an updated MAC address.  If that fails
       and  an old MAC address is known an unicast probe is send(2,n) ucast_solicit
       times. If that fails too it will broadcast a new  ARP  request  to  the
       network.  Requests are only send(2,n) when there is data queued for sending.

       Linux will automatically add a non-permanent proxy arp(7,8)  entry  when  it
       receives  a  request  for  an  address  it forwards to and proxy arp(7,8) is
       enabled on the receiving interface. When there is a  reject  route  for
       the target no proxy arp(7,8) entry is added.


IOCTLS
       Three ioctls are available on all PF_INET sockets.  They take a pointer
       to a struct arpreq as their parameter.

       struct arpreq
       {
           struct sockaddr arp_pa;      /* protocol address */
           struct sockaddr arp_ha;      /* hardware address */
           int             arp_flags;   /* flags */
           struct sockaddr arp_netmask; /* netmask of protocol address */
           char            arp_dev[16];
       };

       SIOCSARP, SIOCDARP and SIOCGARP respectively set(7,n,1 builtins), delete and get an ARP
       mapping.  Setting & deleting ARP maps are privileged operations and may
       only be performed by a process with the CAP_NET_ADMIN capability or  an
       effective UID of 0.

       arp_pa  must be an AF_INET socket(2,7,n) and arp_ha must have the same type as
       the device which is specified in(1,8) arp_dev.  arp_dev is a zero-terminated
       string(3,n) which names a device.


       +-------------------------------------+
       |             arp_flags               |
       +----------------+--------------------+
       |flag            | meaning            |
       +----------------+--------------------+
       |ATF_COM         | Lookup complete    |
       +----------------+--------------------+
       |ATF_PERM        | Permanent entry    |
       +----------------+--------------------+
       |ATF_PUBL        | Publish entry      |
       +----------------+--------------------+
       |ATF_USETRAILERS | Trailers requested |
       +----------------+--------------------+
       |ATF_NETMASK     | Use a netmask      |
       +----------------+--------------------+
       |ATF_DONTPUB     | Don't answer       |
       +----------------+--------------------+


       If  the  ATF_NETMASK  flag  is  set(7,n,1 builtins),  then arp_netmask should be valid.
       Linux 2.2 does not support proxy network ARP entries, so this should be
       set(7,n,1 builtins)  to  0xffffffff,  or  0  to  remove  an  existing  proxy arp(7,8) entry.
       ATF_USETRAILERS is obsolete and should not be used.


SYSCTLS
       ARP supports a sysctl(2,5,8) interface to configure parameters on a global  or
       per-interface basis.  The sysctls can be accessed by reading or writing
       the /proc(5,n)/sys/net/ipv4/neigh/*/* files or with the sysctl(2,5,8)(2) interface.
       Each   interface   in(1,8)   the   system   has   its   own   directory   in(1,8)
       /proc(5,n)/sys/net/ipv4/neigh/.  The setting in(1,8) the `default'  directory  is
       used  for  all  newly created devices.  Unless otherwise specified time(1,2,n)
       related sysctls are specified in(1,8) seconds.

       anycast_delay
              The maximum number of jiffies to delay before replying to a IPv6
              neighbour  solicitation  message.   Anycast  support  is not yet
              implemented.  Defaults to 1 second.

       app_solicit
              The maximum number of probes to send(2,n) to the user space ARP  dae-
              mon  via  netlink(3,7)  before dropping back to multicast probes (see
              mcast_solicit).  Defaults to 0.

       base_reachable_time
              Once a neighbour has been found, the entry is considered  to  be
              valid  for at least a random(3,4,6) value between base_reachable_time/2
              and  3*base_reachable_time/2.   An  entry's  validity  will   be
              extended if(3,n) it receives positive feedback from higher level pro-
              tocols.  Defaults to 30 seconds.

       delay_first_probe_time
              Delay before first probe after it has been decided that a neigh-
              bour is stale.  Defaults to 5 seconds.

       gc_interval
              How  frequently  the  garbage  collector  for  neighbour entries
              should attempt to run.  Defaults to 30 seconds.

       gc_stale_time
              Determines how often to check for stale neighbour entries.  When
              a  neighbour  entry  is  considered  stale  it is resolved again
              before sending data to it.  Defaults to 60 seconds.

       gc_thresh1
              The minimum number of entries to keep in(1,8)  the  ARP  cache.   The
              garbage collector will not run if(3,n) there are fewer than this num-
              ber of entries in(1,8) the cache.  Defaults to 128.

       gc_thresh2
              The soft maximum number of entries to keep  in(1,8)  the  ARP  cache.
              The garbage collector will allow the number of entries to exceed
              this  for  5  seconds  before  collection  will  be   performed.
              Defaults to 512.

       gc_thresh3
              The  hard  maximum  number  of entries to keep in(1,8) the ARP cache.
              The garbage collector will always run if(3,n)  there  are  more  than
              this number of entries in(1,8) the cache.  Defaults to 1024.

       locktime
              The minimum number of jiffies to keep an ARP entry in(1,8) the cache.
              This prevents ARP cache thrashing if(3,n)  there  is  more  than  one
              potential  mapping  (generally due to network misconfiguration).
              Defaults to 1 second.

       mcast_solicit
              The maximum number of attempts to resolve an address  by  multi-
              cast/broadcast   before   marking   the  entry  as  unreachable.
              Defaults to 3.

       proxy_delay
              When an ARP request for a known proxy-ARP address  is  received,
              delay  up  to proxy_delay jiffies before replying.  This is used
              to prevent network flooding in(1,8) some cases.  Defaults to 0.8 sec-
              onds.

       proxy_qlen
              The  maximum  number of packets which may be queued to proxy-ARP
              addresses.  Defaults to 64.

       retrans_time
              The number of jiffies to delay before retransmitting a  request.
              Defaults to 1 second.

       ucast_solicit
              The  maximum  number  of  attempts to send(2,n) unicast probes before
              asking the ARP daemon (see app_solicit).  Defaults to 3.

       unres_qlen
              The maximum number of packets which may be queued for each unre-
              solved address by other network layers.  Defaults to 3.


BUGS
       Some  timer  settings  are  specified in(1,8) jiffies, which is architecture
       related.  On the Alpha a jiffy is 1/1024 of a  second,  on  most  other
       architectures it is 1/100s.

       There is no way to signal(2,7) positive feedback from user space. This means
       connection oriented protocols implemented in(1,8) user space  will  generate
       excessive  ARP  traffic,  because  ndisc will regularly reprobe the MAC
       address.  The same problem applies for some kernel protocols (e.g.  NFS
       over UDP).

       This  man(1,5,7)  page  mashes  IPv4 specific and shared between IPv4 and IPv6
       functionality together.


VERSIONS
       The struct arpreq changed in(1,8) Linux 2.0 to include  the  arp_dev  member
       and  the  ioctl  numbers changed at the same time.  Support for the old
       ioctls was dropped in(1,8) Linux 2.2.

       Support  for  proxy  arp(7,8)  entries  for  networks  (netmask  not   equal
       0xffffffff) was dropped in(1,8) Linux 2.2. It is replaced by automatic proxy
       arp(7,8) setup(2,8) by the kernel for all reachable  hosts  on  other  interfaces
       (when forwarding and proxy arp(7,8) is enabled for the interface).

       The neigh/* sysctls did not exist before Linux 2.2.


SEE ALSO
       capabilities(7), ip(7,8)(7)

       RFC826 for a description of ARP.
       RFC2461  for  a  description  of  IPv6 neighbour discovery and the base
       algorithms used.

       Linux 2.2+ IPv4 ARP uses the IPv6 algorithms when applicable.



Linux Man Page                    1999-06-03                            ARP(7)

References for this manual (incoming links)