share/man/man4/icmp.4

   1 .\" Copyright (c) 1986, 1991, 1993
   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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)icmp.4      8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd August 21, 2005
  36 .Dt ICMP 4
  37 .Os
  38 .Sh NAME
  39 .Nm icmp
  40 .Nd Internet Control Message Protocol
  41 .Sh SYNOPSIS
  42 .In sys/types.h
  43 .In sys/socket.h
  44 .In netinet/in.h
  45 .Ft int
  46 .Fn socket AF_INET SOCK_RAW proto
  47 .Sh DESCRIPTION
  48 .Tn ICMP
  49 is the error and control message protocol used
  50 by
  51 .Tn IP
  52 and the Internet protocol family.
  53 It may be accessed
  54 through a
  55 .Dq raw socket
  56 for network monitoring
  57 and diagnostic functions.
  58 The
  59 .Fa proto
  60 parameter to the socket call to create an
  61 .Tn ICMP
  62 socket
  63 is obtained from
  64 .Xr getprotobyname 3 .
  65 .Tn ICMP
  66 sockets are connectionless,
  67 and are normally used with the
  68 .Xr sendto 2
  69 and
  70 .Xr recvfrom 2
  71 calls, though the
  72 .Xr connect 2
  73 call may also be used to fix the destination for future
  74 packets (in which case the
  75 .Xr read 2
  76 or
  77 .Xr recv 2
  78 and
  79 .Xr write 2
  80 or
  81 .Xr send 2
  82 system calls may be used).
  83 .Pp
  84 Outgoing packets automatically have an
  85 .Tn IP
  86 header prepended to
  87 them (based on the destination address).
  88 Incoming packets are received with the
  89 .Tn IP
  90 header and options intact.
  91 .Ss MIB Variables
  92 The
  93 .Tn ICMP
  94 protocol implements a number of variables in the
  95 .Va net.inet.icmp
  96 branch of the
  97 .Xr sysctl 3
  98 MIB.
  99 .Bl -tag -width ".Va icmplim_output"
 100 .It Va maskrepl
 101 .Pq Vt boolean
 102 Enable/disable replies to ICMP Address Mask Request packets.
 103 Defaults to false.
 104 .It Va maskfake
 105 .Pq Vt "unsigned integer"
 106 When
 107 .Va maskrepl
 108 is set and this value is non-zero,
 109 it will be used instead of the real address mask when
 110 the system replies to an ICMP Address Mask Request packet.
 111 Defaults to 0.
 112 .It Va icmplim
 113 .Pq Vt integer
 114 Bandwidth limit for ICMP replies in packets/second.
 115 Used when
 116 .Va icmplim_output
 117 is non-zero.
 118 Defaults to 200.
 119 .It Va icmplim_output
 120 .Pq Vt boolean
 121 Enable/disable bandwidth limiting of ICMP replies.
 122 Defaults to true.
 123 .It Va drop_redirect
 124 .Pq Vt boolean
 125 Enable/disable dropping of ICMP Redirect packets.
 126 Defaults to false.
 127 .It Va log_redirect
 128 .Pq Vt boolean
 129 Enable/disable logging of ICMP Redirect packets.
 130 Defaults to false.
 131 .It Va bmcastecho
 132 .Pq Vt boolean
 133 Enable/disable ICMP replies received via broadcast or multicast.
 134 Defaults to false.
 135 .It Va reply_src
 136 .Pq Vt str
 137 An interface name used for the ICMP reply source in response to packets
 138 which are not directly addressed to us.
 139 By default continue with normal source selection.
 140 .It Va reply_from_interface
 141 .Pq Vt boolean
 142 Use the IP address of the interface the packet came through in for
 143 responses to packets which are not directly addressed to us.
 144 If enabled, this rule is processed before all others.
 145 By default, continue with normal source selection.
 146 Enabling this option is particularly useful on routers because it
 147 makes external traceroutes show the actual path a packet has taken
 148 instead of the possibly different return path.
 149 .It Va quotelen
 150 .Pq Vt integer
 151 Number of bytes from original packet to quote in ICMP reply.
 152 This number is internally enforced to be at least 8 bytes (per RFC792)
 153 and at most the maximal space left in the ICMP reply mbuf.
 154 .El
 155 .Sh ERRORS
 156 A socket operation may fail with one of the following errors returned:
 157 .Bl -tag -width Er
 158 .It Bq Er EISCONN
 159 when trying to establish a connection on a socket which
 160 already has one, or when trying to send a datagram with the destination
 161 address specified and the socket is already connected;
 162 .It Bq Er ENOTCONN
 163 when trying to send a datagram, but
 164 no destination address is specified, and the socket has not been
 165 connected;
 166 .It Bq Er ENOBUFS
 167 when the system runs out of memory for
 168 an internal data structure;
 169 .It Bq Er EADDRNOTAVAIL
 170 when an attempt is made to create a
 171 socket with a network address for which no network interface
 172 exists.
 173 .El
 174 .Sh SEE ALSO
 175 .Xr recv 2 ,
 176 .Xr send 2 ,
 177 .Xr inet 4 ,
 178 .Xr intro 4 ,
 179 .Xr ip 4
 180 .Sh HISTORY
 181 The
 182 .Nm
 183 protocol appeared in
 184 .Bx 4.3 .