1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<table class="head">
<tr>
<td class="head-ltitle">ROUTE(4)</td>
<td class="head-vol">Device Drivers Manual</td>
<td class="head-rtitle">ROUTE(4)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">route</code> — <span class="Nd">kernel
packet forwarding database</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
<<a class="In">sys/types.h</a>></code>
<br/>
<code class="In">#include <<a class="In">sys/time.h</a>></code>
<br/>
<code class="In">#include <<a class="In">sys/socket.h</a>></code>
<br/>
<code class="In">#include <<a class="In">net/if.h</a>></code>
<br/>
<code class="In">#include <<a class="In">net/route.h</a>></code></p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">socket</code>(<var class="Fa" style="white-space: nowrap;">PF_ROUTE</var>,
<var class="Fa" style="white-space: nowrap;">SOCK_RAW</var>,
<var class="Fa" style="white-space: nowrap;">int family</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp"><span class="Ux">FreeBSD</span> provides some packet routing
facilities. The kernel maintains a routing information database, which is
used in selecting the appropriate network interface when transmitting
packets.</p>
<p class="Pp">A user process (or possibly multiple co-operating processes)
maintains this database by sending messages over a special kind of socket.
This supplants fixed size <a class="Xr">ioctl(2)</a>'s used in earlier
releases. Routing table changes may only be carried out by the super
user.</p>
<p class="Pp">The operating system may spontaneously emit routing messages in
response to external events, such as receipt of a re-direct, or failure to
locate a suitable route for a request. The message types are described in
greater detail below.</p>
<p class="Pp">Routing database entries come in two flavors: for a specific host,
or for all hosts on a generic subnetwork (as specified by a bit mask and
value under the mask. The effect of wildcard or default route may be
achieved by using a mask of all zeros, and there may be hierarchical
routes.</p>
<p class="Pp">When the system is booted and addresses are assigned to the
network interfaces, each protocol family installs a routing table entry for
each interface when it is ready for traffic. Normally the protocol specifies
the route through each interface as a “direct” connection to
the destination host or network. If the route is direct, the transport layer
of a protocol family usually requests the packet be sent to the same host
specified in the packet. Otherwise, the interface is requested to address
the packet to the gateway listed in the routing entry (i.e., the packet is
forwarded).</p>
<p class="Pp">When routing a packet, the kernel will attempt to find the most
specific route matching the destination. (If there are two different mask
and value-under-the-mask pairs that match, the more specific is the one with
more bits in the mask. A route to a host is regarded as being supplied with
a mask of as many ones as there are bits in the destination). If no entry is
found, the destination is declared to be unreachable, and a routing-miss
message is generated if there are any listeners on the routing control
socket described below.</p>
<p class="Pp">A wildcard routing entry is specified with a zero destination
address value, and a mask of all zeroes. Wildcard routes will be used when
the system fails to find other routes matching the destination. The
combination of wildcard routes and routing redirects can provide an
economical mechanism for routing traffic.</p>
<p class="Pp">One opens the channel for passing routing control messages by
using the socket call shown in the synopsis above:</p>
<p class="Pp">The <var class="Fa">family</var> parameter may be
<code class="Dv">AF_UNSPEC</code> which will provide routing information for
all address families, or can be restricted to a specific address family by
specifying which one is desired. There can be more than one routing socket
open per system.</p>
<p class="Pp">Messages are formed by a header followed by a small number of
sockaddrs (now variable length particularly in the ISO case), interpreted by
position, and delimited by the new length entry in the sockaddr. An example
of a message with four addresses might be an ISO redirect: Destination,
Netmask, Gateway, and Author of the redirect. The interpretation of which
address are present is given by a bit mask within the header, and the
sequence is least significant to most significant bit within the vector.</p>
<p class="Pp">Any messages sent to the kernel are returned, and copies are sent
to all interested listeners. The kernel will provide the process ID for the
sender, and the sender may use an additional sequence field to distinguish
between outstanding messages. However, message replies may be lost when
kernel buffers are exhausted.</p>
<p class="Pp" id="errno">The kernel may reject certain messages, and will
indicate this by filling in the <var class="Ar">rtm_errno</var> field. The
routing code returns <code class="Er">EEXIST</code> if requested to
duplicate an existing entry, <code class="Er">ESRCH</code> if requested to
delete a non-existent entry, or <code class="Er">ENOBUFS</code> if
insufficient resources were available to install a new route. In the current
implementation, all routing processes run locally, and the values for
<var class="Ar">rtm_errno</var> are available through the normal
<a class="permalink" href="#errno"><i class="Em">errno</i></a> mechanism,
even if the routing reply message is lost.</p>
<p class="Pp">A process may avoid the expense of reading replies to its own
messages by issuing a <a class="Xr">setsockopt(2)</a> call indicating that
the <code class="Dv">SO_USELOOPBACK</code> option at the
<code class="Dv">SOL_SOCKET</code> level is to be turned off. A process may
ignore all messages from the routing socket by doing a
<a class="Xr">shutdown(2)</a> system call for further input.</p>
<p class="Pp">If a route is in use when it is deleted, the routing entry will be
marked down and removed from the routing table, but the resources associated
with it will not be reclaimed until all references to it are released. User
processes can obtain information about the routing entry to a specific
destination by using a <code class="Dv">RTM_GET</code> message, or by
calling <a class="Xr">sysctl(3)</a>.</p>
<p class="Pp">Messages include:</p>
<div class="Bd Pp Li">
<pre>#define RTM_ADD 0x1 /* Add Route */
#define RTM_DELETE 0x2 /* Delete Route */
#define RTM_CHANGE 0x3 /* Change Metrics, Flags, or Gateway */
#define RTM_GET 0x4 /* Report Information */
#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
#define RTM_REDIRECT 0x6 /* Told to use different route */
#define RTM_MISS 0x7 /* Lookup failed on this address */
#define RTM_LOCK 0x8 /* fix specified metrics */
#define RTM_RESOLVE 0xb /* request to resolve dst to LL addr - unused */
#define RTM_NEWADDR 0xc /* address being added to iface */
#define RTM_DELADDR 0xd /* address being removed from iface */
#define RTM_IFINFO 0xe /* iface going up/down etc. */
#define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
#define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
#define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */
#define RTM_IEEE80211 0x12 /* IEEE80211 wireless event */</pre>
</div>
<p class="Pp">A message header consists of one of the following:</p>
<div class="Bd Pp Li">
<pre>struct rt_msghdr {
u_short rtm_msglen; /* to skip over non-understood messages */
u_char rtm_version; /* future binary compatibility */
u_char rtm_type; /* message type */
u_short rtm_index; /* index for associated ifp */
int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
int rtm_addrs; /* bitmask identifying sockaddrs in msg */
pid_t rtm_pid; /* identify sender */
int rtm_seq; /* for sender to identify action */
int rtm_errno; /* why failed */
int rtm_fmask; /* bitmask used in RTM_CHANGE message */
u_long rtm_inits; /* which metrics we are initializing */
struct rt_metrics rtm_rmx; /* metrics themselves */
};
struct if_msghdr {
u_short ifm_msglen; /* to skip over non-understood messages */
u_char ifm_version; /* future binary compatibility */
u_char ifm_type; /* message type */
int ifm_addrs; /* like rtm_addrs */
int ifm_flags; /* value of if_flags */
u_short ifm_index; /* index for associated ifp */
struct if_data ifm_data; /* statistics and other data about if */
};
struct ifa_msghdr {
u_short ifam_msglen; /* to skip over non-understood messages */
u_char ifam_version; /* future binary compatibility */
u_char ifam_type; /* message type */
int ifam_addrs; /* like rtm_addrs */
int ifam_flags; /* value of ifa_flags */
u_short ifam_index; /* index for associated ifp */
int ifam_metric; /* value of ifa_metric */
};
struct ifma_msghdr {
u_short ifmam_msglen; /* to skip over non-understood messages */
u_char ifmam_version; /* future binary compatibility */
u_char ifmam_type; /* message type */
int ifmam_addrs; /* like rtm_addrs */
int ifmam_flags; /* value of ifa_flags */
u_short ifmam_index; /* index for associated ifp */
};
struct if_announcemsghdr {
u_short ifan_msglen; /* to skip over non-understood messages */
u_char ifan_version; /* future binary compatibility */
u_char ifan_type; /* message type */
u_short ifan_index; /* index for associated ifp */
char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
u_short ifan_what; /* what type of announcement */
};</pre>
</div>
<p class="Pp">The <code class="Dv">RTM_IFINFO</code> message uses a
<var class="Ar">if_msghdr</var> header, the
<code class="Dv">RTM_NEWADDR</code> and <code class="Dv">RTM_DELADDR</code>
messages use a <var class="Ar">ifa_msghdr</var> header, the
<code class="Dv">RTM_NEWMADDR</code> and
<code class="Dv">RTM_DELMADDR</code> messages use a
<var class="Vt">ifma_msghdr</var> header, the
<code class="Dv">RTM_IFANNOUNCE</code> message uses a
<var class="Vt">if_announcemsghdr</var> header, and all other messages use
the <var class="Ar">rt_msghdr</var> header.</p>
<p class="Pp">The “<code class="Li">struct rt_metrics</code>” and
the flag bits are as defined in <a class="Xr">rtentry(9)</a>.</p>
<p class="Pp">Specifiers for metric values in rmx_locks and rtm_inits are:</p>
<div class="Bd Pp Li">
<pre>#define RTV_MTU 0x1 /* init or lock _mtu */
#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
#define RTV_EXPIRE 0x4 /* init or lock _expire */
#define RTV_RPIPE 0x8 /* init or lock _recvpipe */
#define RTV_SPIPE 0x10 /* init or lock _sendpipe */
#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
#define RTV_RTT 0x40 /* init or lock _rtt */
#define RTV_RTTVAR 0x80 /* init or lock _rttvar */
#define RTV_WEIGHT 0x100 /* init or lock _weight */</pre>
</div>
<p class="Pp">Specifiers for which addresses are present in the messages
are:</p>
<div class="Bd Pp Li">
<pre>#define RTA_DST 0x1 /* destination sockaddr present */
#define RTA_GATEWAY 0x2 /* gateway sockaddr present */
#define RTA_NETMASK 0x4 /* netmask sockaddr present */
#define RTA_GENMASK 0x8 /* cloning mask sockaddr present - unused */
#define RTA_IFP 0x10 /* interface name sockaddr present */
#define RTA_IFA 0x20 /* interface addr sockaddr present */
#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<p class="Pp"><a class="Xr">sysctl(3)</a>, <a class="Xr">route(8)</a>,
<a class="Xr">rtentry(9)</a></p>
<p class="Pp">The constants for the <var class="Va">rtm_flags</var> field are
documented in the manual page for the <a class="Xr">route(8)</a>
utility.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">A <code class="Dv">PF_ROUTE</code> protocol family first appeared
in <span class="Ux">4.3BSD-Reno</span>.</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">November 4, 2004</td>
<td class="foot-os">FreeBSD 15.0</td>
</tr>
</table>
|
