2 * Copyright (c) 1980, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 2006 Pavel Fedin
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by the University of
17 * California, Berkeley and its contributors.
18 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)route.h 8.3 (Berkeley) 4/19/94
41 #include <sys/cdefs.h>
44 * Kernel resident routing tables.
46 * The routing tables are initialized when interface addresses
47 * are set by making entries for all directly connected interfaces.
51 * A route consists of a destination address and a reference
52 * to a routing entry. These are often held by protocols
53 * in their control blocks, e.g. inpcb.
56 struct rtentry
*ro_rt
;
57 struct sockaddr ro_dst
;
61 * These numbers are used by reliable protocols for determining
62 * retransmission behavior and are included in the routing structure.
65 u_long rmx_locks
; /* Kernel must leave these values alone */
66 u_long rmx_mtu
; /* MTU for this path */
67 u_long rmx_hopcount
; /* max hops expected */
68 u_long rmx_expire
; /* lifetime for route, e.g. redirect */
69 u_long rmx_recvpipe
; /* inbound delay-bandwith product */
70 u_long rmx_sendpipe
; /* outbound delay-bandwith product */
71 u_long rmx_ssthresh
; /* outbound gateway buffer limit */
72 u_long rmx_rtt
; /* estimated round trip time */
73 u_long rmx_rttvar
; /* estimated rtt variance */
74 u_long rmx_pksent
; /* packets sent using this route */
75 u_long rmx_filler
[4]; /* will be used for T/TCP later */
79 * rmx_rtt and rmx_rttvar are stored as microseconds;
80 * RTTTOPRHZ(rtt) converts to a value suitable for use
81 * by a protocol slowtimo counter.
83 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
84 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
87 * XXX kernel function pointer `rt_output' is visible to applications.
92 * We distinguish between routes to hosts and routes to networks,
93 * preferring the former if available. For each route we infer
94 * the interface to use from the gateway address supplied when
95 * the route was entered. Routes that forward packets through
96 * gateways are marked so that the output routines know to address the
97 * gateway rather than the ultimate destination.
100 #include <net/radix.h>
103 struct radix_node rt_nodes
[2]; /* tree glue, and other values */
104 #define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key))
105 #define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask))
106 struct sockaddr
*rt_gateway
; /* value */
107 short rt_filler
; /* was short flags field */
108 short rt_refcnt
; /* # held references */
109 u_long rt_flags
; /* up/down?, host/net */
110 struct ifnet
*rt_ifp
; /* the answer: interface to use */
111 struct ifaddr
*rt_ifa
; /* the answer: interface to use */
112 struct sockaddr
*rt_genmask
; /* for generation of cloned routes */
113 caddr_t rt_llinfo
; /* pointer to link level info cache */
114 struct rt_metrics rt_rmx
; /* metrics used by rx'ing protocols */
115 struct rtentry
*rt_gwroute
; /* implied entry for gatewayed routes */
116 int (*rt_output
) __P((struct rtentry
*, struct mbuf
*,
117 struct sockaddr
*, int));
118 /* output routine for this (rt,if) */
119 struct rtentry
*rt_parent
; /* cloning parent of this route */
120 void *rt_filler2
; /* more filler */
124 * Following structure necessary for 4.3 compatibility;
125 * We should eventually move it to a compat file.
128 u_long rt_hash
; /* to speed lookups */
129 struct sockaddr rt_dst
; /* key */
130 struct sockaddr rt_gateway
; /* value */
131 short rt_flags
; /* up/down?, host/net */
132 short rt_refcnt
; /* # held references */
133 u_long rt_use
; /* raw # packets forwarded */
134 struct ifnet
*rt_ifp
; /* the answer: interface to use */
137 #define rt_use rt_rmx.rmx_pksent
139 #define RTF_UP 0x1 /* route usable */
140 #define RTF_GATEWAY 0x2 /* destination is a gateway */
141 #define RTF_HOST 0x4 /* host entry (net otherwise) */
142 #define RTF_REJECT 0x8 /* host or net unreachable */
143 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
144 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
145 #define RTF_DONE 0x40 /* message confirmed */
146 #define RTF_MASK 0x80 /* subnet mask present */
147 #define RTF_CLONING 0x100 /* generate new routes on use */
148 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
149 #define RTF_LLINFO 0x400 /* generated by ARP or ESIS */
150 #define RTF_STATIC 0x800 /* manually added */
151 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
152 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
153 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
155 #define RTF_PRCLONING 0x10000 /* protocol requires cloning */
156 #define RTF_WASCLONED 0x20000 /* route generated through cloning */
157 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */
158 #define RTF_CHAINDELETE 0x80000 /* chain is being deleted (internal) */
159 #define RTF_PINNED 0x100000 /* future use */
160 /* 0x200000 and up unassigned */
163 * Routing statistics.
166 short rts_badredirect
; /* bogus redirect calls */
167 short rts_dynamic
; /* routes created by redirects */
168 short rts_newgateway
; /* routes modified by redirects */
169 short rts_unreach
; /* lookups which failed */
170 short rts_wildcard
; /* lookups satisfied by a wildcard */
173 * Structures for routing messages.
176 u_short rtm_msglen
; /* to skip over non-understood messages */
177 u_char rtm_version
; /* future binary compatibility */
178 u_char rtm_type
; /* message type */
179 u_short rtm_index
; /* index for associated ifp */
180 int rtm_flags
; /* flags, incl. kern & message, e.g. DONE */
181 int rtm_addrs
; /* bitmask identifying sockaddrs in msg */
182 pid_t rtm_pid
; /* identify sender */
183 int rtm_seq
; /* for sender to identify action */
184 int rtm_errno
; /* why failed */
185 int rtm_use
; /* from rtentry */
186 u_long rtm_inits
; /* which metrics we are initializing */
187 struct rt_metrics rtm_rmx
; /* metrics themselves */
190 #define RTM_VERSION 5 /* Up the ante and ignore older versions */
192 #define RTM_ADD 0x1 /* Add Route */
193 #define RTM_DELETE 0x2 /* Delete Route */
194 #define RTM_CHANGE 0x3 /* Change Metrics or flags */
195 #define RTM_GET 0x4 /* Report Metrics */
196 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
197 #define RTM_REDIRECT 0x6 /* Told to use different route */
198 #define RTM_MISS 0x7 /* Lookup failed on this address */
199 #define RTM_LOCK 0x8 /* fix specified metrics */
200 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
201 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
202 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
203 #define RTM_NEWADDR 0xc /* address being added to iface */
204 #define RTM_DELADDR 0xd /* address being removed from iface */
205 #define RTM_IFINFO 0xe /* iface going up/down etc. */
207 #define RTV_MTU 0x1 /* init or lock _mtu */
208 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
209 #define RTV_EXPIRE 0x4 /* init or lock _hopcount */
210 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
211 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
212 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
213 #define RTV_RTT 0x40 /* init or lock _rtt */
214 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
217 * Bitmask values for rtm_addr.
219 #define RTA_DST 0x1 /* destination sockaddr present */
220 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
221 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
222 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
223 #define RTA_IFP 0x10 /* interface name sockaddr present */
224 #define RTA_IFA 0x20 /* interface addr sockaddr present */
225 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
226 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
229 * Index offsets for sockaddr array for alternate internal encoding.
231 #define RTAX_DST 0 /* destination sockaddr present */
232 #define RTAX_GATEWAY 1 /* gateway sockaddr present */
233 #define RTAX_NETMASK 2 /* netmask sockaddr present */
234 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
235 #define RTAX_IFP 4 /* interface name sockaddr present */
236 #define RTAX_IFA 5 /* interface addr sockaddr present */
237 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
238 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
239 #define RTAX_MAX 8 /* size of array to allocate */
243 struct sockaddr
*rti_info
[RTAX_MAX
];
255 if ((rt)->rt_refcnt <= 1) \