]> git.ipfire.org Git - thirdparty/man-pages.git/blob - man7/icmp.7
Small FIXME formatting fixes
[thirdparty/man-pages.git] / man7 / icmp.7
1 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
2 .\" Permission is granted to distribute possibly modified copies
3 .\" of this page provided the header is included verbatim,
4 .\" and in case of nontrivial modification author and date
5 .\" of the modification is added to the header.
6 .\" $Id: icmp.7,v 1.6 2000/08/14 08:03:45 ak Exp $
7 .TH ICMP 7 1999-04-27 "Linux Man Page" "Linux Programmer's Manual"
8 .SH NAME
9 icmp, IPPROTO_ICMP \- Linux IPv4 ICMP kernel module.
10 .SH DESCRIPTION
11 This kernel protocol module implements the Internet Control
12 Message Protocol defined in RFC\ 792.
13 It is used to signal error conditions and for diagnosis.
14 The user doesn't interact directly with this module;
15 instead it communicates with the other protocols in the kernel
16 and these pass the ICMP errors to the application layers.
17 The kernel ICMP module also answers ICMP requests.
18 .PP
19 A user protocol may receive ICMP packets for all local sockets by opening
20 a raw socket with the protocol
21 .BR IPPROTO_ICMP .
22 See
23 .BR raw (7)
24 for more information.
25 The types of ICMP packets passed to the socket can be filtered using the
26 .B ICMP_FILTER
27 socket option. ICMP packets are always processed by the kernel too, even
28 when passed to a user socket.
29 .LP
30 Linux limits the rate of ICMP error packets to each destination.
31 .B ICMP_REDIRECT
32 and
33 .B ICMP_DEST_UNREACH
34 are also limited by the destination route of the incoming packets.
35 .SH SYSCTLS
36 ICMP supports a sysctl interface to configure some global IP parameters.
37 The sysctls can be accessed by reading or writing the
38 .I /proc/sys/net/ipv4/*
39 files or with the
40 .BR sysctl (2)
41 interface.
42 Most of these sysctls are rate limitations for specific ICMP types.
43 Linux 2.2 uses a token bucket filter to limit ICMPs.
44 .\" FIXME better description needed
45 The value is the timeout in jiffies until the token bucket filter is
46 cleared after a burst.
47 A jiffy is a system dependent unit, usually 10ms on x86 and
48 about 1ms on alpha and IA64.
49 .TP
50 .B icmp_destunreach_rate
51 Maximum rate to send ICMP Destination Unreachable packets.
52 This limits the rate at which packets are sent to any individual
53 route or destination.
54 The limit does not affect sending of
55 .B ICMP_FRAG_NEEDED
56 packets needed for path MTU discovery.
57 .TP
58 .B icmp_echo_ignore_all
59 If this value is non-zero, Linux will ignore all
60 .B ICMP_ECHO
61 requests.
62 .TP
63 .B icmp_echo_ignore_broadcasts
64 If this value is non-zero, Linux will ignore all
65 .B ICMP_ECHO
66 packets sent to broadcast addresses.
67 .TP
68 .B icmp_echoreply_rate
69 Maximum rate for sending
70 .B ICMP_ECHOREPLY
71 packets in response to
72 .B ICMP_ECHOREQUEST
73 packets.
74 .TP
75 .B icmp_paramprob_rate
76 Maximum rate for sending
77 .B ICMP_PARAMETERPROB
78 packets.
79 These packets are sent when a packet arrives with an invalid IP header.
80 .TP
81 .B icmp_timeexceed_rate
82 Maximum rate for sending
83 .B ICMP_TIME_EXCEEDED
84 packets. These packets are
85 sent to prevent loops when a packet has crossed too many hops.
86 .SH NOTES
87 As many other implementations don't support
88 .B IPPROTO_ICMP
89 raw sockets, this feature
90 should not be relied on in portable programs.
91 .\" not really true ATM
92 .\" .PP
93 .\" Linux ICMP should be compliant to RFC 1122.
94 .PP
95 .B ICMP_REDIRECT
96 packets are not sent when Linux is not acting as a router.
97 They are also only accepted from the old gateway defined in the
98 routing table and the redirect routes are expired after some time.
99 .PP
100 The 64-bit timestamp returned by
101 .B ICMP_TIMESTAMP
102 is in milliseconds since January 1, 1970.
103 .PP
104 Linux ICMP internally uses a raw socket to send ICMPs.
105 This raw socket may appear in
106 .BR netstat (8)
107 output with a zero inode.
108 .PP
109 .SH VERSIONS
110 Support for the
111 .B ICMP_ADDRESS
112 request was removed in 2.2.
113 .PP
114 Support for
115 .B ICMP_SOURCE_QUENCH
116 was removed in Linux 2.2.
117 .SH "SEE ALSO"
118 .BR ip (7)
119 .PP
120 RFC\ 792 for a description of the ICMP protocol.