contrib/traceroute/traceroute.8

   1 .\" Copyright (c) 1989, 1995, 1996
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms are permitted
   5 .\" provided that the above copyright notice and this paragraph are
   6 .\" duplicated in all such forms and that any documentation,
   7 .\" advertising materials, and other materials related to such
   8 .\" distribution and use acknowledge that the software was developed
   9 .\" by the University of California, Berkeley.  The name of the
  10 .\" University may not be used to endorse or promote products derived
  11 .\" from this software without specific prior written permission.
  12 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  13 .\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  14 .\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  15 .\"
  16 .\"     $Header: traceroute.8,v 1.7 96/09/27 20:02:41 leres Exp $
  17 .\"     $FreeBSD$
  18 .\"
  19 .TH TRACEROUTE 8 "27 September 1996"
  20 .UC 6
  21 .SH NAME
  22 traceroute \- print the route packets take to network host
  23 .SH SYNOPSIS
  24 .. while ((op = getopt(argc, argv, "dnrvg:M:m:P:p:q:s:t:w:")) != EOF)
  25 .na
  26 .B traceroute
  27 [
  28 .B \-Sdnrv
  29 ] [
  30 .B \-g
  31 .I gw_host
  32 ] [
  33 .B \-M
  34 .I min_ttl
  35 ]
  36 .br
  37 .ti +8
  38 [
  39 .B \-m
  40 .I max_ttl
  41 ] [
  42 .B \-P
  43 .I proto
  44 ] [
  45 .B \-p
  46 .I port
  47 ]
  48 .br
  49 .ti +8
  50 [
  51 .B \-q
  52 .I nqueries
  53 ] [
  54 .B \-s
  55 .I src_addr
  56 ] [
  57 .B \-t
  58 .I tos
  59 ]
  60 .br
  61 .ti +8
  62 [
  63 .B \-w
  64 .I waittime
  65 ]
  66 .I host
  67 [
  68 .I packetlen
  69 ]
  70 .ad
  71 .SH DESCRIPTION
  72 The Internet is a large and complex aggregation of
  73 network hardware, connected together by gateways.
  74 Tracking the route one's packets follow (or finding the miscreant
  75 gateway that's discarding your packets) can be difficult.
  76 .I Traceroute
  77 utilizes the IP protocol `time to live' field and attempts to elicit an
  78 ICMP TIME_EXCEEDED response from each gateway along the path to some
  79 host.
  80 .PP
  81 The only mandatory parameter is the destination host name or IP number.
  82 The default probe datagram length is 40 bytes, but this may be increased
  83 by specifying a packet length (in bytes) after the destination host
  84 name.
  85 .PP
  86 Other options are:
  87 .TP
  88 .B \-S
  89 Print a summary of how many probes were not answered for each hop.
  90 .TP
  91 .B \-g
  92 Specify a loose source route gateway (8 maximum).
  93 .TP
  94 .B \-M
  95 Set the initial time-to-live value used in outgoing probe packets.
  96 The default is 1, i.e., start with the first hop.
  97 .TP
  98 .B \-m
  99 Set the max time-to-live (max number of hops) used in outgoing probe
 100 packets.  The default is
 101 .I net.inet.ip.ttl
 102 hops (the same default used for TCP
 103 connections).
 104 .TP
 105 .B \-n
 106 Print hop addresses numerically rather than symbolically and numerically
 107 (saves a nameserver address-to-name lookup for each gateway found on the
 108 path).
 109 .TP
 110 .B \-P
 111 Send packets of specified IP protocol. The currently supported protocols
 112 are: UDP, TCP and GRE. Other protocols may also be specified (either by
 113 name or by number), though
 114 .I traceroute
 115 does not implement any special knowledge of their packet formats. This
 116 option is useful for determining which router along a path may be
 117 blocking packets based on IP protocol number. But see BUGS below.
 118 .TP
 119 .B \-p
 120 Protocol specific. For UDP and TCP, sets
 121 the base port number used in probes (default is 33434).
 122 Traceroute hopes that nothing is listening on UDP ports
 123 .I base
 124 to
 125 .I base + nhops - 1
 126 at the destination host (so an ICMP PORT_UNREACHABLE message will
 127 be returned to terminate the route tracing).  If something is
 128 listening on a port in the default range, this option can be used
 129 to pick an unused port range.
 130 .TP
 131 .B \-q
 132 Set the number of probes per hop (default is 3).
 133 .TP
 134 .B \-r
 135 Bypass the normal routing tables and send directly to a host on an attached
 136 network.
 137 If the host is not on a directly-attached network,
 138 an error is returned.
 139 This option can be used to ping a local host through an interface
 140 that has no route through it (e.g., after the interface was dropped by
 141 .IR routed (8C)).
 142 .TP
 143 .B \-s
 144 Use the following IP address (which must be given as an IP number, not
 145 a hostname) as the source address in outgoing probe packets.  On
 146 hosts with more than one IP address, this option can be used to
 147 force the source address to be something other than the IP address
 148 of the interface the probe packet is sent on.  If the IP address
 149 is not one of this machine's interface addresses, an error is
 150 returned and nothing is sent.
 151 .TP
 152 .B \-t
 153 Set the
 154 .I type-of-service
 155 in probe packets to the following value (default zero).  The value must be
 156 a decimal integer in the range 0 to 255.  This option can be used to
 157 see if different types-of-service result in different paths.  (If you
 158 are not running 4.4bsd, this may be academic since the normal network
 159 services like telnet and ftp don't let you control the TOS).
 160 Not all values of TOS are legal or
 161 meaningful \- see the IP spec for definitions.  Useful values are
 162 probably `-t 16' (low delay) and `-t 8' (high throughput).
 163 .TP
 164 .B \-v
 165 Verbose output.  Received ICMP packets other than TIME_EXCEEDED and
 166 UNREACHABLEs are listed.
 167 .TP
 168 .B \-w
 169 Set the time (in seconds) to wait for a response to a probe (default 5
 170 sec.).
 171 .PP
 172 This program attempts to trace the route an IP packet would follow to some
 173 internet host by launching UDP probe
 174 packets with a small ttl (time to live) then listening for an
 175 ICMP "time exceeded" reply from a gateway.  We start our probes
 176 with a ttl of one and increase by one until we get an ICMP "port
 177 unreachable" (which means we got to "host") or hit a max (which
 178 defaults to
 179 .I net.inet.ip.ttl
 180 hops & can be changed with the \-m flag).  Three
 181 probes (change with \-q flag) are sent at each ttl setting and a
 182 line is printed showing the ttl, address of the gateway and
 183 round trip time of each probe.  If the probe answers come from
 184 different gateways, the address of each responding system will
 185 be printed.  If there is no response within a 5 sec. timeout
 186 interval (changed with the \-w flag), a "*" is printed for that
 187 probe.
 188 .PP
 189 We don't want the destination
 190 host to process the UDP probe packets so the destination port is set to an
 191 unlikely value (if some clod on the destination is using that
 192 value, it can be changed with the \-p flag).
 193 .PP
 194 A sample use and output might be:
 195
 196 .RS
 197 .nf
 198 [yak 71]% traceroute nis.nsf.net.
 199 traceroute to nis.nsf.net (35.1.1.48), 64 hops max, 38 byte packet
 200  1  helios.ee.lbl.gov (128.3.112.1)  19 ms  19 ms  0 ms
 201  2  lilac-dmc.Berkeley.EDU (128.32.216.1)  39 ms  39 ms  19 ms
 202  3  lilac-dmc.Berkeley.EDU (128.32.216.1)  39 ms  39 ms  19 ms
 203  4  ccngw-ner-cc.Berkeley.EDU (128.32.136.23)  39 ms  40 ms  39 ms
 204  5  ccn-nerif22.Berkeley.EDU (128.32.168.22)  39 ms  39 ms  39 ms
 205  6  128.32.197.4 (128.32.197.4)  40 ms  59 ms  59 ms
 206  7  131.119.2.5 (131.119.2.5)  59 ms  59 ms  59 ms
 207  8  129.140.70.13 (129.140.70.13)  99 ms  99 ms  80 ms
 208  9  129.140.71.6 (129.140.71.6)  139 ms  239 ms  319 ms
 209 10  129.140.81.7 (129.140.81.7)  220 ms  199 ms  199 ms
 210 11  nic.merit.edu (35.1.1.48)  239 ms  239 ms  239 ms
 211 .fi
 212 .RE
 213
 214 Note that lines 2 & 3 are the same.  This is due to a buggy
 215 kernel on the 2nd hop system \- lbl-csam.arpa \- that forwards
 216 packets with a zero ttl (a bug in the distributed version
 217 of 4.3BSD).  Note that you have to guess what path
 218 the packets are taking cross-country since the NSFNet (129.140)
 219 doesn't supply address-to-name translations for its NSSes.
 220 .PP
 221 A more interesting example is:
 222
 223 .RS
 224 .nf
 225 [yak 72]% traceroute allspice.lcs.mit.edu.
 226 traceroute to allspice.lcs.mit.edu (18.26.0.115), 64 hops max
 227  1  helios.ee.lbl.gov (128.3.112.1)  0 ms  0 ms  0 ms
 228  2  lilac-dmc.Berkeley.EDU (128.32.216.1)  19 ms  19 ms  19 ms
 229  3  lilac-dmc.Berkeley.EDU (128.32.216.1)  39 ms  19 ms  19 ms
 230  4  ccngw-ner-cc.Berkeley.EDU (128.32.136.23)  19 ms  39 ms  39 ms
 231  5  ccn-nerif22.Berkeley.EDU (128.32.168.22)  20 ms  39 ms  39 ms
 232  6  128.32.197.4 (128.32.197.4)  59 ms  119 ms  39 ms
 233  7  131.119.2.5 (131.119.2.5)  59 ms  59 ms  39 ms
 234  8  129.140.70.13 (129.140.70.13)  80 ms  79 ms  99 ms
 235  9  129.140.71.6 (129.140.71.6)  139 ms  139 ms  159 ms
 236 10  129.140.81.7 (129.140.81.7)  199 ms  180 ms  300 ms
 237 11  129.140.72.17 (129.140.72.17)  300 ms  239 ms  239 ms
 238 12  * * *
 239 13  128.121.54.72 (128.121.54.72)  259 ms  499 ms  279 ms
 240 14  * * *
 241 15  * * *
 242 16  * * *
 243 17  * * *
 244 18  ALLSPICE.LCS.MIT.EDU (18.26.0.115)  339 ms  279 ms  279 ms
 245 .fi
 246 .RE
 247
 248 Note that the gateways 12, 14, 15, 16 & 17 hops away
 249 either don't send ICMP "time exceeded" messages or send them
 250 with a ttl too small to reach us.  14 \- 17 are running the
 251 MIT C Gateway code that doesn't send "time exceeded"s.  God
 252 only knows what's going on with 12.
 253 .PP
 254 The silent gateway 12 in the above may be the result of a bug in
 255 the 4.[23]BSD network code (and its derivatives):  4.x (x <= 3)
 256 sends an unreachable message using whatever ttl remains in the
 257 original datagram.  Since, for gateways, the remaining ttl is
 258 zero, the ICMP "time exceeded" is guaranteed to not make it back
 259 to us.  The behavior of this bug is slightly more interesting
 260 when it appears on the destination system:
 261
 262 .RS
 263 .nf
 264  1  helios.ee.lbl.gov (128.3.112.1)  0 ms  0 ms  0 ms
 265  2  lilac-dmc.Berkeley.EDU (128.32.216.1)  39 ms  19 ms  39 ms
 266  3  lilac-dmc.Berkeley.EDU (128.32.216.1)  19 ms  39 ms  19 ms
 267  4  ccngw-ner-cc.Berkeley.EDU (128.32.136.23)  39 ms  40 ms  19 ms
 268  5  ccn-nerif35.Berkeley.EDU (128.32.168.35)  39 ms  39 ms  39 ms
 269  6  csgw.Berkeley.EDU (128.32.133.254)  39 ms  59 ms  39 ms
 270  7  * * *
 271  8  * * *
 272  9  * * *
 273 10  * * *
 274 11  * * *
 275 12  * * *
 276 13  rip.Berkeley.EDU (128.32.131.22)  59 ms !  39 ms !  39 ms !
 277 .fi
 278 .RE
 279
 280 Notice that there are 12 "gateways" (13 is the final
 281 destination) and exactly the last half of them are "missing".
 282 What's really happening is that rip (a Sun-3 running Sun OS3.5)
 283 is using the ttl from our arriving datagram as the ttl in its
 284 ICMP reply.  So, the reply will time out on the return path
 285 (with no notice sent to anyone since ICMP's aren't sent for
 286 ICMP's) until we probe with a ttl that's at least twice the path
 287 length.  I.e., rip is really only 7 hops away.  A reply that
 288 returns with a ttl of 1 is a clue this problem exists.
 289 Traceroute prints a "!" after the time if the ttl is <= 1.
 290 Since vendors ship a lot of obsolete (DEC's Ultrix, Sun 3.x) or
 291 non-standard (HPUX) software, expect to see this problem
 292 frequently and/or take care picking the target host of your
 293 probes.
 294
 295 Other possible annotations after the time are
 296 .BR !H ,
 297 .BR !N ,
 298 or
 299 .B !P
 300 (got a host, network or protocol unreachable, respectively),
 301 .B !S
 302 or
 303 .B !F
 304 (source route failed or fragmentation needed \- neither of these should
 305 ever occur and the associated gateway is busted if you see one),
 306 .B !X
 307 (communication administratively prohibited), or
 308 .B !<N>
 309 (ICMP unreachable code N).
 310 If almost all the probes result in some kind of unreachable, traceroute
 311 will give up and exit.
 312 .PP
 313 This program is intended for use in network testing, measurement
 314 and management.
 315 It should be used primarily for manual fault isolation.
 316 Because of the load it could impose on the network, it is unwise to use
 317 .I traceroute
 318 during normal operations or from automated scripts.
 319 .SH SEE ALSO
 320 netstat(1), ping(8)
 321 .SH AUTHOR
 322 Implemented by Van Jacobson from a suggestion by Steve Deering.  Debugged
 323 by a cast of thousands with particularly cogent suggestions or fixes from
 324 C. Philip Wood, Tim Seaver and Ken Adelman.
 325 .LP
 326 The current version is available via anonymous ftp:
 327 .LP
 328 .RS
 329 .I ftp://ftp.ee.lbl.gov/traceroute.tar.Z
 330 .RE
 331 .SH BUGS
 332 When using protocols other than UDP, functionality is reduced.
 333 In particular, the last packet will often appear to be lost, because
 334 even though it reaches the destination host, there's no way to know
 335 that because no ICMP message is sent back.
 336 In the TCP case,
 337 .I traceroute
 338 should listen for a RST from the destination host (or an intermediate
 339 router that's filtering packets), but this is not implemented yet.
 340 .PP
 341 Please send bug reports to traceroute@ee.lbl.gov.