2 * Copyright (c) 1980, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#)route.h 8.4 (Berkeley) 1/9/95
36 #include <sys/counter.h>
40 * Kernel resident routing tables.
42 * The routing tables are initialized when interface addresses
43 * are set by making entries for all directly connected interfaces.
47 * Struct route consiste of a destination address,
48 * a route entry pointer, link-layer prepend data pointer along
52 struct rtentry *ro_rt;
56 uint16_t ro_mtu; /* saved ro_rt mtu */
58 struct sockaddr ro_dst;
61 #define RT_L2_ME_BIT 2 /* dst L2 addr is our address */
62 #define RT_MAY_LOOP_BIT 3 /* dst may require loop copy */
63 #define RT_HAS_HEADER_BIT 4 /* mbuf already have its header prepended */
65 #define RT_CACHING_CONTEXT 0x1 /* XXX: not used anywhere */
66 #define RT_NORTREF 0x2 /* doesn't hold reference on ro_rt */
67 #define RT_L2_ME (1 << RT_L2_ME_BIT) /* 0x0004 */
68 #define RT_MAY_LOOP (1 << RT_MAY_LOOP_BIT) /* 0x0008 */
69 #define RT_HAS_HEADER (1 << RT_HAS_HEADER_BIT) /* 0x0010 */
71 #define RT_REJECT 0x0020 /* Destination is reject */
72 #define RT_BLACKHOLE 0x0040 /* Destination is blackhole */
73 #define RT_HAS_GW 0x0080 /* Destination has GW */
76 u_long rmx_locks; /* Kernel must leave these values alone */
77 u_long rmx_mtu; /* MTU for this path */
78 u_long rmx_hopcount; /* max hops expected */
79 u_long rmx_expire; /* lifetime for route, e.g. redirect */
80 u_long rmx_recvpipe; /* inbound delay-bandwidth product */
81 u_long rmx_sendpipe; /* outbound delay-bandwidth product */
82 u_long rmx_ssthresh; /* outbound gateway buffer limit */
83 u_long rmx_rtt; /* estimated round trip time */
84 u_long rmx_rttvar; /* estimated rtt variance */
85 u_long rmx_pksent; /* packets sent using this route */
86 u_long rmx_weight; /* route weight */
87 u_long rmx_filler[3]; /* will be used for T/TCP later */
91 * rmx_rtt and rmx_rttvar are stored as microseconds;
92 * RTTTOPRHZ(rtt) converts to a value suitable for use
93 * by a protocol slowtimo counter.
95 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
96 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
98 /* lle state is exported in rmx_state rt_metrics field */
99 #define rmx_state rmx_weight
102 * Keep a generation count of routing table, incremented on route addition,
103 * so we can invalidate caches. This is accessed without a lock, as precision
106 typedef volatile u_int rt_gen_t; /* tree generation (for adds) */
107 #define RT_GEN(fibnum, af) rt_tables_get_gen(fibnum, af)
109 #define RT_DEFAULT_FIB 0 /* Explicitly mark fib=0 restricted cases */
110 #define RT_ALL_FIBS -1 /* Announce event for every fib */
112 extern u_int rt_numfibs; /* number of usable routing tables */
113 VNET_DECLARE(u_int, rt_add_addr_allfibs); /* Announce interfaces to all fibs */
114 #define V_rt_add_addr_allfibs VNET(rt_add_addr_allfibs)
118 * We distinguish between routes to hosts and routes to networks,
119 * preferring the former if available. For each route we infer
120 * the interface to use from the gateway address supplied when
121 * the route was entered. Routes that forward packets through
122 * gateways are marked so that the output routines know to address the
123 * gateway rather than the ultimate destination.
126 #include <net/radix.h>
128 #include <net/radix_mpath.h>
132 #if defined(_KERNEL) || defined(_WANT_RTENTRY)
134 struct radix_node rt_nodes[2]; /* tree glue, and other values */
136 * XXX struct rtentry must begin with a struct radix_node (or two!)
137 * because the code does some casts of a 'struct radix_node *'
138 * to a 'struct rtentry *'
140 #define rt_key(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_key)))
141 #define rt_mask(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask)))
142 struct sockaddr *rt_gateway; /* value */
143 struct ifnet *rt_ifp; /* the answer: interface to use */
144 struct ifaddr *rt_ifa; /* the answer: interface address to use */
145 int rt_flags; /* up/down?, host/net */
146 int rt_refcnt; /* # held references */
147 u_int rt_fibnum; /* which FIB */
148 u_long rt_mtu; /* MTU for this path */
149 u_long rt_weight; /* absolute weight */
150 u_long rt_expire; /* lifetime for route, e.g. redirect */
151 #define rt_endzero rt_pksent
152 counter_u64_t rt_pksent; /* packets sent using this route */
153 struct mtx rt_mtx; /* mutex for routing entry */
154 struct rtentry *rt_chain; /* pointer to next rtentry to delete */
156 #endif /* _KERNEL || _WANT_RTENTRY */
158 #define RTF_UP 0x1 /* route usable */
159 #define RTF_GATEWAY 0x2 /* destination is a gateway */
160 #define RTF_HOST 0x4 /* host entry (net otherwise) */
161 #define RTF_REJECT 0x8 /* host or net unreachable */
162 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
163 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
164 #define RTF_DONE 0x40 /* message confirmed */
165 /* 0x80 unused, was RTF_DELCLONE */
166 /* 0x100 unused, was RTF_CLONING */
167 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
168 #define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward
170 #define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */
171 #define RTF_STATIC 0x800 /* manually added */
172 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
173 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
174 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
175 /* 0x10000 unused, was RTF_PRCLONING */
176 /* 0x20000 unused, was RTF_WASCLONED */
177 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */
178 #define RTF_FIXEDMTU 0x80000 /* MTU was explicitly specified */
179 #define RTF_PINNED 0x100000 /* route is immutable */
180 #define RTF_LOCAL 0x200000 /* route represents a local address */
181 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */
182 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */
183 /* 0x8000000 and up unassigned */
184 #define RTF_STICKY 0x10000000 /* always route dst->src */
186 #define RTF_RNH_LOCKED 0x40000000 /* unused */
188 #define RTF_GWFLAG_COMPAT 0x80000000 /* a compatibility bit for interacting
189 with existing routing apps */
191 /* Mask of RTF flags that are allowed to be modified by RTM_CHANGE. */
193 (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \
194 RTF_REJECT | RTF_STATIC | RTF_STICKY)
197 * fib_ nexthop API flags.
200 /* Consumer-visible nexthop info flags */
201 #define NHF_REJECT 0x0010 /* RTF_REJECT */
202 #define NHF_BLACKHOLE 0x0020 /* RTF_BLACKHOLE */
203 #define NHF_REDIRECT 0x0040 /* RTF_DYNAMIC|RTF_MODIFIED */
204 #define NHF_DEFAULT 0x0080 /* Default route */
205 #define NHF_BROADCAST 0x0100 /* RTF_BROADCAST */
206 #define NHF_GATEWAY 0x0200 /* RTF_GATEWAY */
208 /* Nexthop request flags */
209 #define NHR_IFAIF 0x01 /* Return ifa_ifp interface */
210 #define NHR_REF 0x02 /* For future use */
212 /* Control plane route request flags */
213 #define NHR_COPY 0x100 /* Copy rte data */
216 /* rte<>ro_flags translation */
218 rt_update_ro_flags(struct route *ro)
220 int rt_flags = ro->ro_rt->rt_flags;
222 ro->ro_flags &= ~ (RT_REJECT|RT_BLACKHOLE|RT_HAS_GW);
224 ro->ro_flags |= (rt_flags & RTF_REJECT) ? RT_REJECT : 0;
225 ro->ro_flags |= (rt_flags & RTF_BLACKHOLE) ? RT_BLACKHOLE : 0;
226 ro->ro_flags |= (rt_flags & RTF_GATEWAY) ? RT_HAS_GW : 0;
231 * Routing statistics.
234 short rts_badredirect; /* bogus redirect calls */
235 short rts_dynamic; /* routes created by redirects */
236 short rts_newgateway; /* routes modified by redirects */
237 short rts_unreach; /* lookups which failed */
238 short rts_wildcard; /* lookups satisfied by a wildcard */
241 * Structures for routing messages.
244 u_short rtm_msglen; /* to skip over non-understood messages */
245 u_char rtm_version; /* future binary compatibility */
246 u_char rtm_type; /* message type */
247 u_short rtm_index; /* index for associated ifp */
248 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
249 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
250 pid_t rtm_pid; /* identify sender */
251 int rtm_seq; /* for sender to identify action */
252 int rtm_errno; /* why failed */
253 int rtm_fmask; /* bitmask used in RTM_CHANGE message */
254 u_long rtm_inits; /* which metrics we are initializing */
255 struct rt_metrics rtm_rmx; /* metrics themselves */
258 #define RTM_VERSION 5 /* Up the ante and ignore older versions */
263 #define RTM_ADD 0x1 /* Add Route */
264 #define RTM_DELETE 0x2 /* Delete Route */
265 #define RTM_CHANGE 0x3 /* Change Metrics or flags */
266 #define RTM_GET 0x4 /* Report Metrics */
267 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
268 #define RTM_REDIRECT 0x6 /* Told to use different route */
269 #define RTM_MISS 0x7 /* Lookup failed on this address */
270 #define RTM_LOCK 0x8 /* fix specified metrics */
273 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
274 #define RTM_NEWADDR 0xc /* address being added to iface */
275 #define RTM_DELADDR 0xd /* address being removed from iface */
276 #define RTM_IFINFO 0xe /* iface going up/down etc. */
277 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
278 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
279 #define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */
280 #define RTM_IEEE80211 0x12 /* IEEE80211 wireless event */
283 * Bitmask values for rtm_inits and rmx_locks.
285 #define RTV_MTU 0x1 /* init or lock _mtu */
286 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
287 #define RTV_EXPIRE 0x4 /* init or lock _expire */
288 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
289 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
290 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
291 #define RTV_RTT 0x40 /* init or lock _rtt */
292 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
293 #define RTV_WEIGHT 0x100 /* init or lock _weight */
296 * Bitmask values for rtm_addrs.
298 #define RTA_DST 0x1 /* destination sockaddr present */
299 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
300 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
301 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
302 #define RTA_IFP 0x10 /* interface name sockaddr present */
303 #define RTA_IFA 0x20 /* interface addr sockaddr present */
304 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
305 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
308 * Index offsets for sockaddr array for alternate internal encoding.
310 #define RTAX_DST 0 /* destination sockaddr present */
311 #define RTAX_GATEWAY 1 /* gateway sockaddr present */
312 #define RTAX_NETMASK 2 /* netmask sockaddr present */
313 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
314 #define RTAX_IFP 4 /* interface name sockaddr present */
315 #define RTAX_IFA 5 /* interface addr sockaddr present */
316 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
317 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
318 #define RTAX_MAX 8 /* size of array to allocate */
320 typedef int rt_filter_f_t(const struct rtentry *, void *);
323 int rti_addrs; /* Route RTF_ flags */
324 int rti_flags; /* Route RTF_ flags */
325 struct sockaddr *rti_info[RTAX_MAX]; /* Sockaddr data */
326 struct ifaddr *rti_ifa; /* value of rt_ifa addr */
327 struct ifnet *rti_ifp; /* route interface */
328 rt_filter_f_t *rti_filter; /* filter function */
329 void *rti_filterdata; /* filter paramenters */
330 u_long rti_mflags; /* metrics RTV_ flags */
331 u_long rti_spare; /* Will be used for fib */
332 struct rt_metrics *rti_rmx; /* Pointer to route metrics */
336 * This macro returns the size of a struct sockaddr when passed
337 * through a routing socket. Basically we round up sa_len to
338 * a multiple of sizeof(long), with a minimum of sizeof(long).
339 * The check for a NULL pointer is just a convenience, probably never used.
340 * The case sa_len == 0 should only apply to empty structures.
342 #define SA_SIZE(sa) \
343 ( (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ? \
345 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) )
347 #define sa_equal(a, b) ( \
348 (((const struct sockaddr *)(a))->sa_len == ((const struct sockaddr *)(b))->sa_len) && \
349 (bcmp((a), (b), ((const struct sockaddr *)(b))->sa_len) == 0))
353 #define RT_LINK_IS_UP(ifp) (!((ifp)->if_capabilities & IFCAP_LINKSTATE) \
354 || (ifp)->if_link_state == LINK_STATE_UP)
356 #define RT_LOCK_INIT(_rt) \
357 mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK)
358 #define RT_LOCK(_rt) mtx_lock(&(_rt)->rt_mtx)
359 #define RT_UNLOCK(_rt) mtx_unlock(&(_rt)->rt_mtx)
360 #define RT_LOCK_DESTROY(_rt) mtx_destroy(&(_rt)->rt_mtx)
361 #define RT_LOCK_ASSERT(_rt) mtx_assert(&(_rt)->rt_mtx, MA_OWNED)
362 #define RT_UNLOCK_COND(_rt) do { \
363 if (mtx_owned(&(_rt)->rt_mtx)) \
364 mtx_unlock(&(_rt)->rt_mtx); \
367 #define RT_ADDREF(_rt) do { \
368 RT_LOCK_ASSERT(_rt); \
369 KASSERT((_rt)->rt_refcnt >= 0, \
370 ("negative refcnt %d", (_rt)->rt_refcnt)); \
371 (_rt)->rt_refcnt++; \
374 #define RT_REMREF(_rt) do { \
375 RT_LOCK_ASSERT(_rt); \
376 KASSERT((_rt)->rt_refcnt > 0, \
377 ("bogus refcnt %d", (_rt)->rt_refcnt)); \
378 (_rt)->rt_refcnt--; \
381 #define RTFREE_LOCKED(_rt) do { \
382 if ((_rt)->rt_refcnt <= 1) \
388 /* guard against invalid refs */ \
392 #define RTFREE(_rt) do { \
394 RTFREE_LOCKED(_rt); \
397 #define RO_RTFREE(_ro) do { \
398 if ((_ro)->ro_rt) { \
399 if ((_ro)->ro_flags & RT_NORTREF) { \
400 (_ro)->ro_flags &= ~RT_NORTREF; \
401 (_ro)->ro_rt = NULL; \
403 RT_LOCK((_ro)->ro_rt); \
404 RTFREE_LOCKED((_ro)->ro_rt); \
410 * Validate a cached route based on a supplied cookie. If there is an
411 * out-of-date cache, simply free it. Update the generation number
412 * for the new allocation
414 #define RT_VALIDATE(ro, cookiep, fibnum) do { \
415 rt_gen_t cookie = RT_GEN(fibnum, (ro)->ro_dst.sa_family); \
416 if (*(cookiep) != cookie && (ro)->ro_rt != NULL) { \
417 RTFREE((ro)->ro_rt); \
418 (ro)->ro_rt = NULL; \
419 *(cookiep) = cookie; \
426 void rt_ieee80211msg(struct ifnet *, int, void *, size_t);
427 void rt_ifannouncemsg(struct ifnet *, int);
428 void rt_ifmsg(struct ifnet *);
429 void rt_missmsg(int, struct rt_addrinfo *, int, int);
430 void rt_missmsg_fib(int, struct rt_addrinfo *, int, int, int);
431 void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
432 void rt_newaddrmsg_fib(int, struct ifaddr *, int, struct rtentry *, int);
433 int rt_addrmsg(int, struct ifaddr *, int);
434 int rt_routemsg(int, struct ifnet *ifp, int, struct rtentry *, int);
435 void rt_newmaddrmsg(int, struct ifmultiaddr *);
436 int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
437 void rt_maskedcopy(struct sockaddr *, struct sockaddr *, struct sockaddr *);
438 struct rib_head *rt_table_init(int);
439 void rt_table_destroy(struct rib_head *);
440 u_int rt_tables_get_gen(int table, int fam);
442 int rtsock_addrmsg(int, struct ifaddr *, int);
443 int rtsock_routemsg(int, struct ifnet *ifp, int, struct rtentry *, int);
446 * Note the following locking behavior:
448 * rtalloc1() returns a locked rtentry
450 * rtfree() and RTFREE_LOCKED() require a locked rtentry
452 * RTFREE() uses an unlocked entry.
455 void rtfree(struct rtentry *);
456 void rt_updatemtu(struct ifnet *);
458 typedef int rt_walktree_f_t(struct rtentry *, void *);
459 typedef void rt_setwarg_t(struct rib_head *, uint32_t, int, void *);
460 void rt_foreach_fib_walk(int af, rt_setwarg_t *, rt_walktree_f_t *, void *);
461 void rt_foreach_fib_walk_del(int af, rt_filter_f_t *filter_f, void *arg);
462 void rt_flushifroutes(struct ifnet *ifp);
464 /* XXX MRT COMPAT VERSIONS THAT SET UNIVERSE to 0 */
465 /* Thes are used by old code not yet converted to use multiple FIBS */
466 struct rtentry *rtalloc1(struct sockaddr *, int, u_long);
467 int rtinit(struct ifaddr *, int, int);
469 /* XXX MRT NEW VERSIONS THAT USE FIBs
470 * For now the protocol indepedent versions are the same as the AF_INET ones
471 * but this will change..
473 int rt_getifa_fib(struct rt_addrinfo *, u_int fibnum);
474 void rtalloc_ign_fib(struct route *ro, u_long ignflags, u_int fibnum);
475 struct rtentry *rtalloc1_fib(struct sockaddr *, int, u_long, u_int);
476 int rtioctl_fib(u_long, caddr_t, u_int);
477 void rtredirect_fib(struct sockaddr *, struct sockaddr *,
478 struct sockaddr *, int, struct sockaddr *, u_int);
479 int rtrequest_fib(int, struct sockaddr *,
480 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int);
481 int rtrequest1_fib(int, struct rt_addrinfo *, struct rtentry **, u_int);
482 int rib_lookup_info(uint32_t, const struct sockaddr *, uint32_t, uint32_t,
483 struct rt_addrinfo *);
484 void rib_free_info(struct rt_addrinfo *info);