share/man/man9/rtentry.9

   1 .\"
   2 .\" Copyright 1996 Massachusetts Institute of Technology
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software and
   5 .\" its documentation for any purpose and without fee is hereby
   6 .\" granted, provided that both the above copyright notice and this
   7 .\" permission notice appear in all copies, that both the above
   8 .\" copyright notice and this permission notice appear in all
   9 .\" supporting documentation, and that the name of M.I.T. not be used
  10 .\" in advertising or publicity pertaining to distribution of the
  11 .\" software without specific, written prior permission.  M.I.T. makes
  12 .\" no representations about the suitability of this software for any
  13 .\" purpose.  It is provided "as is" without express or implied
  14 .\" warranty.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  17 .\" ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  20 .\" SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23 .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24 .\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd October 16, 2013
  32 .Dt RTENTRY 9
  33 .Os
  34 .Sh NAME
  35 .Nm rtentry
  36 .Nd structure of an entry in the kernel routing table
  37 .Sh SYNOPSIS
  38 .In sys/types.h
  39 .In sys/socket.h
  40 .In net/route.h
  41 .Sh DESCRIPTION
  42 The kernel provides a common mechanism by which all protocols can store
  43 and retrieve entries from a central table of routes.
  44 Parts of this
  45 mechanism are also used to interact with user-level processes by means
  46 of a socket in the
  47 .Xr route 4
  48 pseudo-protocol family.
  49 The
  50 .In net/route.h
  51 header file defines the structures and manifest constants used in this
  52 facility.
  53 .Pp
  54 The basic structure of a route is defined by
  55 .Vt "struct rtentry" ,
  56 which includes the following fields:
  57 .Bl -tag -offset indent -width 6n
  58 .It Vt "struct radix_node rt_nodes[2]" ;
  59 Glue used by the radix-tree routines.
  60 These members also include in
  61 their substructure the key (i.e., destination address) and mask used
  62 when the route was created.
  63 The
  64 .Fn rt_key rt
  65 and
  66 .Fn rt_mask rt
  67 macros can be used to extract this information (in the form of a
  68 .Vt "struct sockaddr *" )
  69 given a
  70 .Vt "struct rtentry *" .
  71 .It Vt "struct sockaddr *rt_gateway" ;
  72 The
  73 .Dq target
  74 of the route, which can either represent a destination in its own
  75 right (some protocols will put a link-layer address here), or some
  76 intermediate stop on the way to that destination (if the
  77 .Dv RTF_GATEWAY
  78 flag is set).
  79 .It Vt "int rt_flags" ;
  80 See below.
  81 .It Vt "int rt_refcnt" ;
  82 Route entries are reference-counted; this field indicates the number
  83 of external (to the radix tree) references.
  84 .It Vt "struct ifnet *rt_ifp" ;
  85 .It Vt "struct ifaddr *rt_ifa" ;
  86 These two fields represent the
  87 .Dq answer ,
  88 as it were, to the question posed by a route lookup; that is, they
  89 name the interface and interface address to be used in sending a
  90 packet to the destination or set of destinations which this route
  91 represents.
  92 .It Vt "struct rt_metrics_lite rt_rmx" ;
  93 See below.
  94 If the
  95 .Dv RTF_UP
  96 flag is not present, the
  97 .Fn rtfree
  98 function will delete the route from the radix tree when the last
  99 reference drops.
 100 .It Vt "struct rtentry *rt_gwroute" ;
 101 This member is a reference to a route whose destination is
 102 .Va rt_gateway .
 103 It is only used for
 104 .Dv RTF_GATEWAY
 105 routes.
 106 .It Vt "struct mtx rt_mtx" ;
 107 Mutex to lock this routing entry.
 108 .El
 109 .Pp
 110 The following flag bits are defined:
 111 .Bl -tag -offset indent -width ".Dv RTF_BLACKHOLE" -compact
 112 .It Dv RTF_UP
 113 The route is not deleted.
 114 .It Dv RTF_GATEWAY
 115 The route points to an intermediate destination and not the ultimate
 116 recipient; the
 117 .Va rt_gateway
 118 and
 119 .Va rt_gwroute
 120 fields name that destination.
 121 .It Dv RTF_HOST
 122 This is a host route.
 123 .It Dv RTF_REJECT
 124 The destination is presently unreachable.
 125 This should result in an
 126 .Er EHOSTUNREACH
 127 error from output routines.
 128 .It Dv RTF_DYNAMIC
 129 This route was created dynamically by
 130 .Fn rtredirect .
 131 .It Dv RTF_MODIFIED
 132 This route was modified by
 133 .Fn rtredirect .
 134 .It Dv RTF_DONE
 135 Used only in the
 136 .Xr route 4
 137 protocol, indicating that the request was executed.
 138 .It Dv RTF_XRESOLVE
 139 When this route is returned as a result of a lookup, send a report on
 140 the
 141 .Xr route 4
 142 interface requesting that an external process perform resolution for
 143 this route.
 144 .It Dv RTF_STATIC
 145 Indicates that this route was manually added by means of the
 146 .Xr route 8
 147 command.
 148 .It Dv RTF_BLACKHOLE
 149 Requests that output sent via this route be discarded.
 150 .It Dv RTF_PROTO1
 151 .It Dv RTF_PROTO2
 152 .It Dv RTF_PROTO3
 153 Protocol-specific.
 154 .It Dv RTF_PRCLONING
 155 This flag is obsolete and simply ignored by facility.
 156 .It Dv RTF_PINNED
 157 Indicates that this route is immutable to a routing protocol.
 158 .It Dv RTF_LOCAL
 159 Indicates that the destination of this route is an address configured
 160 as belonging to this system.
 161 .It Dv RTF_BROADCAST
 162 Indicates that the destination is a broadcast address.
 163 .It Dv RTF_MULTICAST
 164 Indicates that the destination is a multicast address.
 165 .El
 166 .Pp
 167 Every route has associated with it a set of metrics, stored in
 168 .Vt "struct rt_metrics_lite" .
 169 Metrics are supplied in
 170 .Vt "struct rt_metrics"
 171 passed with routing control messages via
 172 .Xr route 4
 173 API.
 174 Currently only
 175 .Vt rmx_mtu , rmx_expire ,
 176 and
 177 .Vt rmx_pksent
 178 metrics are used in
 179 .Vt "struct rt_metrics_lite" .
 180 All others are ignored.
 181 .Pp
 182 The following metrics are defined by
 183 .Vt "struct rt_metrics" :
 184 .Bl -tag -offset indent -width 6n
 185 .It Vt "u_long rmx_locks" ;
 186 Flag bits indicating which metrics the kernel is not permitted to
 187 dynamically modify.
 188 .It Vt "u_long rmx_mtu" ;
 189 MTU for this path.
 190 .It Vt "u_long rmx_hopcount" ;
 191 Number of intermediate systems on the path to this destination.
 192 .It Vt "u_long rmx_expire" ;
 193 The time
 194 (a la
 195 .Xr time 3 )
 196 at which this route should expire, or zero if it should never expire.
 197 It is the responsibility of individual protocol suites to ensure that routes
 198 are actually deleted once they expire.
 199 .It Vt "u_long rmx_recvpipe" ;
 200 Nominally, the bandwidth-delay product for the path
 201 .Em from
 202 the destination
 203 .Em to
 204 this system.
 205 In practice, this value is used to set the size of the
 206 receive buffer (and thus the window in sliding-window protocols like
 207 .Tn TCP ) .
 208 .It Vt "u_long rmx_sendpipe" ;
 209 As before, but in the opposite direction.
 210 .It Vt "u_long rmx_ssthresh" ;
 211 The slow-start threshold used in
 212 .Tn TCP
 213 congestion-avoidance.
 214 .It Vt "u_long rmx_rtt" ;
 215 The round-trip time to this destination, in units of
 216 .Dv RMX_RTTUNIT
 217 per second.
 218 .It Vt "u_long rmx_rttvar" ;
 219 The average deviation of the round-trip time to this destination, in
 220 units of
 221 .Dv RMX_RTTUNIT
 222 per second.
 223 .It Vt "u_long rmx_pksent" ;
 224 A count of packets successfully sent via this route.
 225 .It Vt "u_long rmx_filler[4]" ;
 226 .\" XXX badly named
 227 Empty space available for protocol-specific information.
 228 .El
 229 .Sh SEE ALSO
 230 .Xr route 4 ,
 231 .Xr route 8 ,
 232 .Xr rtalloc 9
 233 .Sh HISTORY
 234 The
 235 .Vt rtentry
 236 structure first appeared in
 237 .Bx 4.2 .
 238 The radix-tree representation of the routing table and the
 239 .Vt rt_metrics
 240 structure first appeared in
 241 .Bx 4.3 reno .
 242 .Sh AUTHORS
 243 This manual page was written by
 244 .An Garrett Wollman .
 245 .Sh BUGS
 246 There are a number of historical relics remaining in this interface.
 247 The
 248 .Va rt_gateway
 249 and
 250 .Va rmx_filler
 251 fields could be named better.