1 .\" Copyright (c) 1990, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" From: @(#)route.4 8.6 (Berkeley) 4/19/94
33 .\" $FreeBSD: src/share/man/man4/route.4,v 1.9.2.6 2002/03/17 09:12:44 schweikh Exp $
34 .\" $DragonFly: src/share/man/man4/route.4,v 1.3 2004/03/11 13:28:55 hmp Exp $
41 .Nd kernel packet forwarding database
49 .Fn socket PF_ROUTE SOCK_RAW "int family"
52 provides some packet routing facilities.
53 The kernel maintains a routing information database, which
54 is used in selecting the appropriate network interface when
57 A user process (or possibly multiple co-operating processes)
58 maintains this database by sending messages over a special kind
60 This supplants fixed size
62 used in earlier releases.
63 Routing table changes may only be carried out by the super user.
65 The operating system may spontaneously emit routing messages in response
66 to external events, such as receipt of a re-direct, or failure to
67 locate a suitable route for a request.
68 The message types are described in greater detail below.
70 Routing database entries come in two flavors: for a specific
71 host, or for all hosts on a generic subnetwork (as specified
72 by a bit mask and value under the mask.
73 The effect of wildcard or default route may be achieved by using
74 a mask of all zeros, and there may be hierarchical routes.
76 When the system is booted and addresses are assigned
77 to the network interfaces, each protocol family
78 installs a routing table entry for each interface when it is ready for traffic.
79 Normally the protocol specifies the route
80 through each interface as a
82 connection to the destination host
83 or network. If the route is direct, the transport layer of
84 a protocol family usually requests the packet be sent to the
85 same host specified in the packet. Otherwise, the interface
86 is requested to address the packet to the gateway listed in the routing entry
87 (i.e. the packet is forwarded).
89 When routing a packet,
90 the kernel will attempt to find
91 the most specific route matching the destination.
92 (If there are two different mask and value-under-the-mask pairs
93 that match, the more specific is the one with more bits in the mask.
94 A route to a host is regarded as being supplied with a mask of
95 as many ones as there are bits in the destination).
96 If no entry is found, the destination is declared to be unreachable,
97 and a routing\-miss message is generated if there are any
98 listeners on the routing control socket described below.
100 A wildcard routing entry is specified with a zero
101 destination address value, and a mask of all zeroes.
102 Wildcard routes will be used
103 when the system fails to find other routes matching the
104 destination. The combination of wildcard
105 routes and routing redirects can provide an economical
106 mechanism for routing traffic.
108 One opens the channel for passing routing control messages
109 by using the socket call shown in the synopsis above:
116 routing information for all address families, or can be restricted
117 to a specific address family by specifying which one is desired.
118 There can be more than one routing socket open per system.
120 Messages are formed by a header followed by a small
121 number of sockaddrs (now variable length particularly
124 case), interpreted by position, and delimited
125 by the new length entry in the sockaddr.
126 An example of a message with four addresses might be an
129 Destination, Netmask, Gateway, and Author of the redirect.
130 The interpretation of which address are present is given by a
131 bit mask within the header, and the sequence is least significant
132 to most significant bit within the vector.
134 Any messages sent to the kernel are returned, and copies are sent
135 to all interested listeners. The kernel will provide the process
136 ID for the sender, and the sender may use an additional sequence
137 field to distinguish between outstanding messages. However,
138 message replies may be lost when kernel buffers are exhausted.
140 The kernel may reject certain messages, and will indicate this
144 The routing code returns
147 requested to duplicate an existing entry,
150 requested to delete a non-existent entry,
153 if insufficient resources were available
154 to install a new route.
155 In the current implementation, all routing processes run locally,
158 are available through the normal
160 mechanism, even if the routing reply message is lost.
162 A process may avoid the expense of reading replies to
163 its own messages by issuing a
165 call indicating that the
170 level is to be turned off.
171 A process may ignore all messages from the routing socket
174 system call for further input.
176 If a route is in use when it is deleted,
177 the routing entry will be marked down and removed from the routing table,
178 but the resources associated with it will not
179 be reclaimed until all references to it are released.
180 User processes can obtain information about the routing
181 entry to a specific destination by using a
183 message, or by calling
188 #define RTM_ADD 0x1 /* Add Route */
189 #define RTM_DELETE 0x2 /* Delete Route */
190 #define RTM_CHANGE 0x3 /* Change Metrics, Flags, or Gateway */
191 #define RTM_GET 0x4 /* Report Information */
192 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
193 #define RTM_REDIRECT 0x6 /* Told to use different route */
194 #define RTM_MISS 0x7 /* Lookup failed on this address */
195 #define RTM_LOCK 0x8 /* fix specified metrics */
196 #define RTM_RESOLVE 0xb /* request to resolve dst to LL addr */
197 #define RTM_NEWADDR 0xc /* address being added to iface */
198 #define RTM_DELADDR 0xd /* address being removed from iface */
199 #define RTM_IFINFO 0xe /* iface going up/down etc. */
200 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
201 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
202 #define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */
205 A message header consists of one of the following:
208 u_short rtm_msglen; /* to skip over non-understood messages */
209 u_char rtm_version; /* future binary compatibility */
210 u_char rtm_type; /* message type */
211 u_short rtm_index; /* index for associated ifp */
212 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
213 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
214 pid_t rtm_pid; /* identify sender */
215 int rtm_seq; /* for sender to identify action */
216 int rtm_errno; /* why failed */
217 int rtm_use; /* from rtentry */
218 u_long rtm_inits; /* which metrics we are initializing */
219 struct rt_metrics rtm_rmx; /* metrics themselves */
223 u_short ifm_msglen; /* to skip over non-understood messages */
224 u_char ifm_version; /* future binary compatibility */
225 u_char ifm_type; /* message type */
226 int ifm_addrs; /* like rtm_addrs */
227 int ifm_flags; /* value of if_flags */
228 u_short ifm_index; /* index for associated ifp */
229 struct if_data ifm_data; /* statistics and other data about if */
233 u_short ifam_msglen; /* to skip over non-understood messages */
234 u_char ifam_version; /* future binary compatibility */
235 u_char ifam_type; /* message type */
236 int ifam_addrs; /* like rtm_addrs */
237 int ifam_flags; /* value of ifa_flags */
238 u_short ifam_index; /* index for associated ifp */
239 int ifam_metric; /* value of ifa_metric */
243 u_short ifmam_msglen; /* to skip over non-understood messages */
244 u_char ifmam_version; /* future binary compatibility */
245 u_char ifmam_type; /* message type */
246 int ifmam_addrs; /* like rtm_addrs */
247 int ifmam_flags; /* value of ifa_flags */
248 u_short ifmam_index; /* index for associated ifp */
251 struct if_announcemsghdr {
252 u_short ifan_msglen; /* to skip over non-understood messages */
253 u_char ifan_version; /* future binary compatibility */
254 u_char ifan_type; /* message type */
255 u_short ifan_index; /* index for associated ifp */
256 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
257 u_short ifan_what; /* what type of announcement */
280 .Vt if_announcemsghdr
282 and all other messages use the
287 .Dq Li "struct rt_metrics"
288 and the flag bits are as defined in
291 Specifiers for metric values in rmx_locks and rtm_inits are:
293 #define RTV_MTU 0x1 /* init or lock _mtu */
294 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
295 #define RTV_EXPIRE 0x4 /* init or lock _expire */
296 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
297 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
298 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
299 #define RTV_RTT 0x40 /* init or lock _rtt */
300 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
303 Specifiers for which addresses are present in the messages are:
305 #define RTA_DST 0x1 /* destination sockaddr present */
306 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
307 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
308 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
309 #define RTA_IFP 0x10 /* interface name sockaddr present */
310 #define RTA_IFA 0x20 /* interface addr sockaddr present */
311 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
312 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
321 protocol family first appeared in