Sweep-fix man page section order to match mdoc(7), part 5/5.
[dragonfly.git] / usr.sbin / mrouted / mrouted.8
1 .\"COPYRIGHT 1989 by The Board of Trustees of Leland Stanford Junior University.
2 .\"
3 .\" $FreeBSD: src/usr.sbin/mrouted/mrouted.8,v 2003/03/11 22:31:29 trhodes Exp $
4 .\" $DragonFly: src/usr.sbin/mrouted/mrouted.8,v 1.3 2006/02/17 19:40:18 swildner Exp $
5 .\"
6 .Dd May 8, 1995
8 .Os
9 .Sh NAME
10 .Nm mrouted
11 .Nd IP multicast routing daemon
13 .Nm
14 .Op Fl c Ar config_file
15 .Op Fl d Op Ar debug_level
16 .Op Fl p
18 The
19 .Nm
20 utility is an implementation of the Distance-Vector Multicast Routing
21 Protocol (DVMRP), an earlier version of which is specified in RFC-1075.
22 It maintains topological knowledge via a distance-vector routing protocol
23 (like RIP, described in RFC-1058), upon which it implements a multicast
24 datagram forwarding algorithm called Reverse Path Multicasting.
25 .Pp
26 The
27 .Nm
28 utility forwards a multicast datagram along a shortest (reverse) path tree
29 rooted at the subnet on which the datagram originates.
30 The multicast
31 delivery tree may be thought of as a broadcast delivery tree that has
32 been pruned back so that it does not extend beyond those subnetworks
33 that have members of the destination group.
34 Hence, datagrams
35 are not forwarded along those branches which have no listeners of the
36 multicast group.
37 The IP time-to-live of a multicast datagram can be
38 used to limit the range of multicast datagrams.
39 .Pp
40 In order to support multicasting among subnets that are separated by (unicast)
41 routers that do not support IP multicasting,
42 .Nm
43 includes support for
44 "tunnels", which are virtual point-to-point links between pairs of
45 multicast routers
46 located anywhere in an internet.  IP multicast packets are encapsulated for
47 transmission through tunnels, so that they look like normal unicast datagrams
48 to intervening routers and subnets.  The encapsulation
49 is added on entry to a tunnel, and stripped off
50 on exit from a tunnel.
51 The packets are encapsulated using the IP-in-IP protocol
52 (IP protocol number 4).
53 Older versions of
54 .Nm
55 tunneled using IP source routing, which puts a heavy load on some
56 types of routers.
57 This version does not support IP source route tunnelling.
58 .Pp
59 The tunnelling mechanism allows
60 .Nm
61 to establish a virtual internet, for
62 the purpose of multicasting only, which is independent of the physical
63 internet, and which may span multiple Autonomous Systems.  This capability
64 is intended for experimental support of internet multicasting only, pending
65 widespread support for multicast routing by the regular (unicast) routers.
66 The
67 .Nm
68 utility suffers from the well-known scaling problems of any distance-vector
69 routing protocol, and does not (yet) support hierarchical multicast routing.
70 .Pp
71 The
72 .Nm
73 utility
74 handles multicast routing only; there may or may not be unicast routing
75 software running on the same machine as
76 .Nm .
77 With the use of tunnels, it
78 is not necessary for
79 .Nm
80 to have access to more than one physical subnet
81 in order to perform multicast forwarding.
82 .Pp
83 The following options are available:
84 .Bl -tag -width indent
85 .It Fl c Ar config_file
86 Specify an alternative file for configuration commands.
87 Default is
88 .Pa /etc/mrouted.conf .
89 .It Fl d Op Ar debug_level
90 If no
91 .Fl d
92 option is given, or if the debug level is specified as 0,
93 .Nm
94 detaches from the invoking terminal.  Otherwise, it remains attached to the
95 invoking terminal and responsive to signals from that terminal.
96 Regardless of the debug level,
97 .Nm
98 always writes warning and error messages to the system
99 log daemon.  The
100 .Fl debug-level
101 argument is a comma-separated list of any of the following:
102 .Bl -tag -width indent
103 .It "packet"
104 Display the type, source and destination of all packets sent or received.
105 .It "pruning"
106 Display more information about prunes sent or received.
107 .It "routing"
108 Display more information about routing update packets sent or received.
109 .It "route_detail"
110 Display routing updates in excruciating detail.  This is generally way too
111 much information.
112 .It "neighbors"
113 Display information about neighbor discovery.
114 .It "cache"
115 Display insertions, deletions and refreshes of entries in
116 the kernel forwarding cache.
117 .It "timeout"
118 Debug timeouts and periodic processes.
119 .It "interface"
120 Display information about interfaces and their configuration.
121 .It "membership"
122 Display information about group memberships on physical interfaces.
123 .It "traceroute"
124 Display information about multicast traceroute requests
125 passing through this router.
126 .It "igmp"
127 Display IGMP operation including group membership and querier election.
128 .It "icmp"
129 Monitor ICMP handling.
130 .It "rsrr"
131 Monitor RSRR operation.
132 .El
133 .Pp
134 Upon startup,
135 .Nm
136 writes its pid to the file
137 .Pa /var/run/mrouted.pid .
138 .El
140 The
141 .Nm
142 utility automatically configures itself to forward on all multicast-capable
143 interfaces, i.e., interfaces that have the IFF_MULTICAST flag set (excluding
144 the loopback "interface"), and it finds other DVMRP routers directly reachable
145 via those interfaces.  To override the default configuration, or to add
146 tunnel links to other multicast routers,
147 configuration commands may be placed in
148 .Pa /etc/mrouted.conf
149 (or an alternative file, specified by the
150 .Fl c
151 option).
152 .Pp
153 The file format is free-form; whitespace (including newlines) is not
154 significant.
155 The file begins with commands that apply to
156 .Nm Ns 's
157 overall operation or set defaults.
158 .Bl -tag -width indent
159 .It cache_lifetime Ar secs
160 Specifies, in seconds, the lifetime of a multicast forwarding cache
161 entry in the kernel.  Multicast forwarding cache entries in the kernel
162 are checked every
163 .Ar secs
164 seconds, and are refreshed if the source is still
165 active or deleted if not.  Care should be taken when setting this value,
166 as a low value can keep the kernel cache small at the cost of "thrashing"
167 the cache for periodic senders, but high values can cause the kernel
168 cache to grow unacceptably large.  The default is 300 seconds (5 minutes).
169 .It prune_lifetime Ar secs
170 Specifies, in seconds, the average lifetime of prunes that are sent towards
171 parents.  The actual lifetimes will be randomized in the range
172 [.5\fIsecs\fP,1.5\fIsecs\fP].  The default is 7200 (2 hours).  Smaller values
173 cause less state to be kept both at this router and the parent, at the
174 cost of more frequent broadcasts.  However, some routers (e.g.\&
175 .Nm
176 <3.3
177 and all currently known versions of cisco's IOS) do not use the
178 DVMRP generation ID to determine that a neighbor has rebooted.  Prunes
179 sent towards these neighbors should be kept short, in order to shorten
180 the time to recover from a reboot.  For use in this situation, the
181 prune_lifetime keyword may be specified on an interface as described
182 below.
183 .It noflood
184 The
185 .Nm
186 utility
187 uses a DVMRP optimization to prevent having to keep individual routing tables
188 for each neighbor; part of this optimization is that
189 .Nm
190 assumes that it is the forwarder for each of its attached subnets on
191 startup.  This can cause duplicates for a short period (approximately
192 one full route report interval), since both the router that just
193 started up and the proper forwarder will be forwarding traffic.  This
194 behavior can be turned off with the noflood keyword;
195 .Nm
196 will not assume that it is the forwarder on startup.
197 Turning on noflood can cause black holes on restart, which will generally
198 last approximately one full route report interval.
199 The noflood keyword can also be specified on individual interfaces.
200 .It rexmit_prunes Ar [on|off]
201 Default is to retransmit prunes on all point-to-point interfaces
202 (including tunnels) but no multi-access interfaces.  This option
203 may be used to make the default on (or off) for all interfaces.
204 The rexmit_prunes keyword can also be specified on individual interfaces.
205 .It name Ar "boundary-name scoped-addr/mask-len"
206 Associates
207 .Ar boundary-name
208 with the boundary described by
209 .Ar scoped-addr/mask-len ,
210 to help make interface configurations
211 more readable and reduce repetition in the configuration file.
212 .El
213 .Pp
214 The second section of the configuration file, which may optionally
215 be empty, describes options that apply to physical interfaces.
216 .Bl -tag -width indent
217 .It phyint Ar "local-addr|ifname"
218 The phyint command does nothing by itself; it is simply a place holder
219 which interface-specific commands may follow.  An interface address or
220 name may be specified.
221 .It disable
222 Disables multicast forwarding on this interface.  By default,
223 .Nm
224 discovers all locally attached multicast capable interfaces and forwards
225 on all of them.
226 .It netmask Ar netmask
227 If the kernel's netmask does not accurately reflect
228 the subnet (e.g. you're using proxy-ARP in lieu of IP subnetting), use the
229 netmask command to describe the real netmask.
230 .It altnet Ar network/mask-len
231 If a phyint is attached to multiple IP subnets, describe each additional subnet
232 with the altnet keyword.  This command may be specified multiple times
233 to describe multiple subnets.
234 .It igmpv1
235 If there are any IGMPv1 routers on the phyint, use the \fBigmpv1\fP
236 keyword to force
237 .Nm
238 into IGMPv1 mode.  All routers on the phyint
239 must use the same version of IGMP.
240 .It force_leaf
241 Force
242 .Nm
243 to ignore other routers on this interface.
244 .Nm
245 will never send or accept neighbor probes or
246 route reports on this interface.
247 .El
248 .Pp
249 In addition, the common vif commands described later may all be used on
250 a phyint.
251 .Pp
252 The third section of the configuration file, also optional, describes
253 the configuration of any DVMRP tunnels this router might have.
254 .Bl -tag -width indent
255 .It tunnel Ar "local-addr|ifname" Ar "remote-addr|remote-hostname"
256 This command establishes a DVMRP tunnel between this host (on the interface
257 described by
258 .Ar local-addr
259 or
260 .Ar ifname )
261 and a remote host (identified by
262 .Ar remote-addr
263 or
264 .Ar remote-hostname ) .
265 A remote hostname may only be used if
266 it maps to a single IP address.
267 A tunnel must be configured on both routers before it can be used.
268 .Pp
269 Be careful that the unicast route to the remote address goes out the
270 interface specified by the
271 .Ar "local-addr|ifname"
272 argument.  Some UNIX
273 kernels rewrite the source address of
274 .Nm Ns 's
275 packets on their way out to contain the address of the transmission
276 interface.  This is best assured via a static host route.
277 .El
278 .Pp
279 The common vif commands described below
280 may all be used on tunnels or phyints.
281 .Bl -tag -width indent
282 .It metric Ar m
283 The metric is the "cost" associated with receiving a datagram on the given
284 interface or tunnel; it may be used to influence the choice of routes.
285 The metric defaults to 1.  Metrics should be kept as small as possible,
286 because DVMRP cannot route along paths with a sum of metrics greater
287 than 31.
288 .It advert_metric Ar m
289 The advert_metric is the "cost" associated with sending a datagram
290 on the given interface or tunnel; it may be used to influence the choice
291 of routes.  The advert_metric defaults to 0.  Note that the effective
292 metric of a link is one end's metric plus the other end's advert_metric.
293 .It threshold Ar t
294 The threshold is the minimum IP time-to-live required for a multicast datagram
295 to be forwarded to the given interface or tunnel.  It is used to control the
296 scope of multicast datagrams.  (The TTL of forwarded packets is only compared
297 to the threshold, it is not decremented by the threshold.  Every multicast
298 router decrements the TTL by exactly 1.)  The default threshold is 1.
299 .Pp
300 In general, all multicast routers
301 connected to a particular subnet or tunnel should
302 use the same metric and threshold for that subnet or tunnel.
303 .It rate_limit Ar r
304 The rate_limit option allows the network administrator to specify a
305 certain bandwidth in Kbits/second which would be allocated to multicast
306 traffic.  It defaults 0 (unlimited).
307 .It boundary Ar "boundary-name|scoped-addr/mask-len"
308 The boundary option allows an interface
309 to be configured as an administrative boundary for the specified
310 scoped address.
311 Packets belonging to this address will not
312 be forwarded on a scoped interface.  The boundary option accepts either
313 a name or a boundary spec.  This command may be specified several times
314 on an interface in order to describe multiple boundaries.
315 .It passive
316 No packets will be sent on this link or tunnel until we hear from the other
317 end.  This is useful for the "server" end of a tunnel that goes over
318 a dial-on-demand link; configure the "server" end as passive and
319 it will not send its periodic probes until it hears one from the other
320 side, so will not keep the link up.  If this option is specified on both
321 ends of a tunnel, the tunnel will never come up.
322 .It noflood
323 As described above, but only applicable to this interface/tunnel.
324 .It prune_lifetime Ar secs
325 As described above, but only applicable to this interface/tunnel.
326 .It rexmit_prunes Ar "[on|off]"
327 As described above, but only applicable to this interface/tunnel.
328 Recall that prune retransmission
329 defaults to on on point-to-point links and tunnels, and off on
330 multi-access links.
331 .It allow_nonpruners
332 By default,
333 .Nm
334 refuses to peer with DVMRP neighbors that
335 do not claim to support pruning.  This option allows such peerings
336 on this interface.
337 .It notransit
338 A specialized case of route filtering; no route learned from an interface
339 marked "notransit" will be advertised on another interface marked
340 "notransit".  Marking only a single interface "notransit" has no meaning.
341 .It accept|deny Ar "(route/mask-len [exact])+" Op bidir
342 The
343 .Li accept
344 and
345 .Li deny
346 commands allow rudimentary route filtering.  The
347 .Li accept
348 command causes
349 .Nm
350 to accept only the listed routes on the configured interface; the
351 .Li deny
352 command causes
353 .Nm
354 to accept all but the listed routes.
355 Only one of
356 .Li accept
357 or
358 .Li deny
359 commands may be used on a given interface.
360 .Pp
361 The list of routes follows the
362 .Li accept
363 or
364 .Li deny
365 keyword.  If the keyword
366 .Ar exact
367 follows a route, then only that route is matched; otherwise, that route
368 and any more specific route is matched.  For example,
369 .Li deny 0/0
370 denys all routes, while
371 .Li deny 0/0 exact
372 denys only the default route.  The default route may also be specified
373 with the
374 .Li default
375 keyword.
376 .Pp
377 The
378 .Ar bidir
379 keyword enables bidirectional route filtering; the filter will be applied
380 to routes on both output and input.  Without the
381 .Ar bidir
382 keyword,
383 .Li accept
384 and
385 .Li deny
386 filters are only applied on input.  Poison reverse routes are never
387 filtered out.
388 .El
389 .Pp
390 The
391 .Nm
392 utility will not initiate execution if it has fewer than two enabled vifs,
393 where a vif (virtual interface) is either a physical multicast-capable
394 interface or a tunnel.  It will log a warning if all of its vifs are
395 tunnels; such an
396 .Nm
397 configuration would be better replaced by more
398 direct tunnels (i.e. eliminate the middle man).
400 This is an example configuration for a mythical multicast router at a big
401 school.
402 .Pp
403 .Bd -literal
404 #
405 # mrouted.conf example
406 #
407 # Name our boundaries to make it easier
408 name LOCAL
409 name EE
410 #
411 # le1 is our gateway to compsci, don't forward our
412 #     local groups to them
413 phyint le1 boundary EE
414 #
415 # le2 is our interface on the classroom net, it has four
416 #     different length subnets on it.
417 # note that you can use either an ip address or an
418 # interface name
419 phyint boundary EE altnet
420         altnet altnet
421 #
422 # atm0 is our ATM interface, which doesn't properly
423 #      support multicasting.
424 phyint atm0 disable
425 #
426 # This is an internal tunnel to another EE subnet
427 # Remove the default tunnel rate limit, since this
428 #   tunnel is over ethernets
429 tunnel metric 1 threshold 1
430         rate_limit 0
431 #
432 # This is our tunnel to the outside world.
433 # Careful with those boundaries, Eugene.
434 tunnel metric 1 threshold 32
435         boundary LOCAL boundary EE
436 .Ed
438 The
439 .Nm
440 utility responds to the following signals:
441 .Bl -tag -width indent
442 .It HUP
443 Restarts
444 .Nm .
445 The configuration file is reread every time this signal is evoked.
446 .It INT
447 Terminate execution gracefully (i.e., by sending
448 good-bye messages to all neighboring routers).
449 .It TERM
450 Same as INT.
451 .It USR1
452 Dump the internal routing tables to
453 .Pa /var/tmp/mrouted.dump .
454 .It USR2
455 Dump the internal cache tables to
456 .Pa /var/tmp/mrouted.cache .
457 .It QUIT
458 Dump the internal routing tables to stderr (only if
459 .Nm
460 was invoked with a non-zero debug level).
461 .El
462 .Pp
463 For convenience in sending signals,
464 .Nm
465 writes its pid to
466 .Pa /var/run/mrouted.pid
467 upon startup.
468 .Sh FILES
469 .Bl -tag -width /var/tmp/mrouted.cache -compact
470 .It Pa /etc/mrouted.conf
471 .It Pa /var/run/mrouted.pid
472 .It Pa /var/tmp/mrouted.dump
473 .It Pa /var/tmp/mrouted.cache
474 .El
476 The routing tables look like this:
477 .Pp
478 .Bd -literal
479 Virtual Interface Table
480  Vif  Local-Address                    Metric  Thresh  Flags
481   0      subnet: 36.2/16       1       1    querier
482                     groups:
484                    pkts in: 3456
485                   pkts out: 2322323
487   1     subnet: 36.11/16      1       1    querier
488                     groups:
491                    pkts in: 345
492                   pkts out: 3456
494   2      tunnel:     3       1
495                      peers: (3.255)
496                 boundaries: 239.0.1/24
497                           : 239.1.2/24
498                    pkts in: 34545433
499                   pkts out: 234342
501   3      tunnel:     3       16
503 Multicast Routing Table (1136 entries)
504  Origin-Subnet   From-Gateway    Metric Tmr In-Vif  Out-Vifs
505  36.2                               1    45    0    1* 2  3*
506  36.8            4    15    2    0* 1* 3*
507  36.11                              1    20    1    0* 2  3*
508  .
509  .
510  .
511 .Ed
512 .Pp
513 In this example, there are four vifs connecting to two subnets and two
514 tunnels.  The vif 3 tunnel is not in use (no peer address). The vif 0 and
515 vif 1 subnets have some groups present; tunnels never have any groups.  This
516 instance of
517 .Nm
518 is the one responsible for sending periodic group
519 membership queries on the vif 0 and vif 1 subnets, as indicated by the
520 "querier" flags.
521 The list of boundaries indicate the scoped addresses on that
522 interface.
523 A count of the no. of incoming and outgoing packets is also
524 shown at each interface.
525 .Pp
526 Associated with each subnet from which a multicast datagram can originate
527 is the address of the previous hop router (unless the subnet is directly-
528 connected), the metric of the path back to the origin, the amount of time
529 since we last received an update for this subnet, the incoming vif for
530 multicasts from that origin, and a list of outgoing vifs.  "*" means that
531 the outgoing vif is connected to a leaf of the broadcast tree rooted at the
532 origin, and a multicast datagram from that origin will be forwarded on that
533 outgoing vif only if there are members of the destination group on that leaf.
534 .Pp
535 The
536 .Nm
537 utility also maintains a copy of the kernel forwarding cache table.
538 Entries
539 are created and deleted by
540 .Nm .
541 .Pp
542 The cache tables look like this:
543 .Pp
544 .Bd -literal
545 Multicast Routing Cache Table (147 entries)
546  Origin             Mcast-group     CTmr  Age Ptmr IVif Forwvifs
547  13.2.116/22     3m   2m    -  0    1
548 >
549 >
550  138.96.48/21     5m   2m    -  0    1
551 >
552  128.9.160/20     3m   2m    -  0    1
553 >
554  198.106.194/24     9m  28s   9m  0P
555 >
556 .Ed
557 .Pp
558 Each entry is characterized by the origin subnet number and mask and the
559 destination multicast group.
560 .Pp
561 The 'CTmr' field indicates the lifetime
562 of the entry.  The entry is deleted from the cache table
563 (or refreshed, if traffic is flowing)
564 when the timer decrements to zero.  The 'Age' field is the time since
565 this cache entry was originally created.  Since cache entries get refreshed
566 if traffic is flowing, routing entries can grow very old.
567 .Pp
568 The 'Ptmr' field is simply a dash if no prune was sent upstream, or the
569 amount of time until the upstream prune will time out.
570 .Pp
571 The 'Ivif' field indicates the
572 incoming vif for multicast packets from that origin.  Each router also
573 maintains a record of the number of prunes received from neighboring
574 routers for a particular source and group.
575 If there are no members of
576 a multicast group on any downward link of the multicast tree for a
577 subnet, a prune message is sent to the upstream router.
578 They are
579 indicated by a "P" after the vif number.
580 .Pp
581 The Forwvifs field shows the
582 interfaces along which datagrams belonging to the source-group are
583 forwarded.
584 A "p" indicates that no datagrams are being forwarded along
585 that interface.
586 An unlisted interface is a leaf subnet with no
587 members of the particular group on that subnet.
588 A "b" on an interface
589 indicates that it is a boundary interface, i.e. traffic will not be
590 forwarded on the scoped address on that interface.
591 .Pp
592 An additional line with a ">" as the first character is printed for
593 each source on the subnet.  Note that there can be many sources in
594 one subnet.
595 An additional line with a "<" as the first character is printed
596 describing any prunes received from downstream dependent neighbors
597 for this subnet and group.
598 .Sh SEE ALSO
599 .Xr map-mbone 8 ,
600 .Xr mrinfo 8 ,
601 .Xr mtrace 8
602 .Pp
603 DVMRP is described, along with other multicast routing algorithms, in the
604 paper "Multicast Routing in Internetworks and Extended LANs" by S. Deering,
605 in the Proceedings of the ACM SIGCOMM '88 Conference.
607 .An Steve Deering ,
608 .An Ajit Thyagarajan ,
609 .An Bill Fenner .