$OpenBSD: icmp.4,v 1.14 2015/09/10 17:55:21 schwarze Exp $
$NetBSD: icmp.4,v 1.3 1994/11/30 16:22:14 jtc Exp $

Copyright (c) 1986, 1991, 1993
The Regents of the University of California. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

@(#)icmp.4 8.1 (Berkeley) 6/5/93

.Dd $Mdocdate: September 3 2011 $ .Dt ICMP 4 .Os .Sh NAME .Nm icmp .Nd Internet Control Message Protocol .Sh SYNOPSIS n sys/socket.h n netinet/in.h .Ft int .Fn socket AF_INET SOCK_RAW proto .Sh DESCRIPTION .Tn ICMP is the error and control message protocol used by .Tn IP and the Internet protocol family. It may be accessed through a .Dq raw socket for network monitoring and diagnostic functions. The .Fa proto parameter to the socket call to create an .Tn ICMP socket is obtained from .Xr getprotobyname 3 . .Tn ICMP sockets are connectionless, and are normally used with the .Xr sendto 2 and .Xr recvfrom 2 calls, though the .Xr connect 2 call may also be used to fix the destination for future packets (in which case the .Xr read 2 or .Xr recv 2 and .Xr write 2 or .Xr send 2 system calls may be used).

p Outgoing packets automatically have an .Tn IP header prepended to them (based on the destination address). Incoming packets are received with the .Tn IP header and options intact. .Ss Types ICMP messages are classified according to the type and code fields present in the ICMP header. The abbreviations for the types and codes may be used in rules in .Xr pf.conf 5 . The following types are defined: l -column "Num" "ipv6-where" -offset indent t Sy Num Ta Sy "Abbrev." Ta Sy Description t 0 Ta echorep Ta "Echo reply" t 3 Ta unreach Ta "Destination unreachable" t 4 Ta squench Ta "Packet loss, slow down" t 5 Ta redir Ta "Shorter route exists" t 6 Ta althost Ta "Alternate host address" t 8 Ta echoreq Ta "Echo request" t 9 Ta routeradv Ta "Router advertisement" t 10 Ta routersol Ta "Router solicitation" t 11 Ta timex Ta "Time exceeded" t 12 Ta paramprob Ta "Invalid IP header" t 13 Ta timereq Ta "Timestamp request" t 14 Ta timerep Ta "Timestamp reply" t 15 Ta inforeq Ta "Information request" t 16 Ta inforep Ta "Information reply" t 17 Ta maskreq Ta "Address mask request" t 18 Ta maskrep Ta "Address mask reply" t 30 Ta trace Ta "Traceroute" t 31 Ta dataconv Ta "Data conversion problem" t 32 Ta mobredir Ta "Mobile host redirection" t 33 Ta ipv6-where Ta "IPv6 where-are-you" t 34 Ta ipv6-here Ta "IPv6 i-am-here" t 35 Ta mobregreq Ta "Mobile registration request" t 36 Ta mobregrep Ta "Mobile registration reply" t 39 Ta skip Ta "SKIP" t 40 Ta photuris Ta "Photuris" .El

p The following codes are defined: l -column "Num" "redir-tos-host" "paramprob" "Description" -offset indent t Sy Num Ta Sy "Abbrev." Ta Sy Type Ta Sy Description t 0 Ta net-unr Ta unreach Ta "Network unreachable" t 1 Ta host-unr Ta unreach Ta "Host unreachable" t 2 Ta proto-unr Ta unreach Ta "Protocol unreachable" t 3 Ta port-unr Ta unreach Ta "Port unreachable" t 4 Ta needfrag Ta unreach Ta "Fragmentation needed but DF bit set" t 5 Ta srcfail Ta unreach Ta "Source routing failed" t 6 Ta net-unk Ta unreach Ta "Network unknown" t 7 Ta host-unk Ta unreach Ta "Host unknown" t 8 Ta isolate Ta unreach Ta "Host isolated" t 9 Ta net-prohib Ta unreach Ta "Network administratively prohibited" t 10 Ta host-prohib Ta unreach Ta "Host administratively prohibited" t 11 Ta net-tos Ta unreach Ta "Invalid TOS for network" t 12 Ta host-tos Ta unreach Ta "Invalid TOS for host" t 13 Ta filter-prohib Ta unreach Ta "Prohibited access" t 14 Ta host-preced Ta unreach Ta "Precedence violation" t 15 Ta cutoff-preced Ta unreach Ta "Precedence cutoff" t 0 Ta redir-net Ta redir Ta "Shorter route for network" t 1 Ta redir-host Ta redir Ta "Shorter route for host" t 2 Ta redir-tos-net Ta redir Ta "Shorter route for TOS and network" t 3 Ta redir-tos-host Ta redir Ta "Shorter route for TOS and host" t 0 Ta normal-adv Ta routeradv Ta "Normal advertisement" t 16 Ta common-adv Ta routeradv Ta "Selective advertisement" t 0 Ta transit Ta timex Ta "Time exceeded in transit" t 1 Ta reassemb Ta timex Ta "Time exceeded in reassembly" t 0 Ta badhead Ta paramprob Ta "Invalid option pointer" t 1 Ta optmiss Ta paramprob Ta "Missing option" t 2 Ta badlen Ta paramprob Ta "Invalid length" t 1 Ta unknown-ind Ta photuris Ta "Unknown security index" t 2 Ta auth-fail Ta photuris Ta "Authentication failed" t 3 Ta decrypt-fail Ta photuris Ta "Decryption failed" .El .Sh DIAGNOSTICS A socket operation may fail with one of the following errors returned: l -tag -width [EADDRNOTAVAIL] t Bq Er EISCONN when trying to establish a connection on a socket which already has one, or when trying to send a datagram with the destination address specified and the socket is already connected; t Bq Er ENOTCONN when trying to send a datagram, but no destination address is specified, and the socket hasn't been connected; t Bq Er ENOBUFS when the system runs out of memory for an internal data structure; t Bq Er EADDRNOTAVAIL when an attempt is made to create a socket with a network address for which no network interface exists. .El .Sh SEE ALSO .Xr recv 2 , .Xr send 2 , .Xr inet 4 , .Xr ip 4 , .Xr netintro 4 .Sh HISTORY The .Nm protocol appeared in x 4.3 .