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 * 3. 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;
53 struct llentry *ro_lle;
55 * ro_prepend and ro_plen are only used for bpf to pass in a
56 * preformed header. They are not cacheable.
61 uint16_t ro_mtu; /* saved ro_rt mtu */
63 struct sockaddr ro_dst;
66 #define RT_L2_ME_BIT 2 /* dst L2 addr is our address */
67 #define RT_MAY_LOOP_BIT 3 /* dst may require loop copy */
68 #define RT_HAS_HEADER_BIT 4 /* mbuf already have its header prepended */
70 #define RT_L2_ME (1 << RT_L2_ME_BIT) /* 0x0004 */
71 #define RT_MAY_LOOP (1 << RT_MAY_LOOP_BIT) /* 0x0008 */
72 #define RT_HAS_HEADER (1 << RT_HAS_HEADER_BIT) /* 0x0010 */
74 #define RT_REJECT 0x0020 /* Destination is reject */
75 #define RT_BLACKHOLE 0x0040 /* Destination is blackhole */
76 #define RT_HAS_GW 0x0080 /* Destination has GW */
77 #define RT_LLE_CACHE 0x0100 /* Cache link layer */
80 u_long rmx_locks; /* Kernel must leave these values alone */
81 u_long rmx_mtu; /* MTU for this path */
82 u_long rmx_hopcount; /* max hops expected */
83 u_long rmx_expire; /* lifetime for route, e.g. redirect */
84 u_long rmx_recvpipe; /* inbound delay-bandwidth product */
85 u_long rmx_sendpipe; /* outbound delay-bandwidth product */
86 u_long rmx_ssthresh; /* outbound gateway buffer limit */
87 u_long rmx_rtt; /* estimated round trip time */
88 u_long rmx_rttvar; /* estimated rtt variance */
89 u_long rmx_pksent; /* packets sent using this route */
90 u_long rmx_weight; /* route weight */
91 u_long rmx_filler[3]; /* will be used for T/TCP later */
95 * rmx_rtt and rmx_rttvar are stored as microseconds;
96 * RTTTOPRHZ(rtt) converts to a value suitable for use
97 * by a protocol slowtimo counter.
99 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
100 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
102 /* lle state is exported in rmx_state rt_metrics field */
103 #define rmx_state rmx_weight
106 * Keep a generation count of routing table, incremented on route addition,
107 * so we can invalidate caches. This is accessed without a lock, as precision
110 typedef volatile u_int rt_gen_t; /* tree generation (for adds) */
111 #define RT_GEN(fibnum, af) rt_tables_get_gen(fibnum, af)
113 #define RT_DEFAULT_FIB 0 /* Explicitly mark fib=0 restricted cases */
114 #define RT_ALL_FIBS -1 /* Announce event for every fib */
116 extern u_int rt_numfibs; /* number of usable routing tables */
117 VNET_DECLARE(u_int, rt_add_addr_allfibs); /* Announce interfaces to all fibs */
118 #define V_rt_add_addr_allfibs VNET(rt_add_addr_allfibs)
122 * We distinguish between routes to hosts and routes to networks,
123 * preferring the former if available. For each route we infer
124 * the interface to use from the gateway address supplied when
125 * the route was entered. Routes that forward packets through
126 * gateways are marked so that the output routines know to address the
127 * gateway rather than the ultimate destination.
130 #include <net/radix.h>
132 #include <net/radix_mpath.h>
138 struct radix_node rt_nodes[2]; /* tree glue, and other values */
140 * XXX struct rtentry must begin with a struct radix_node (or two!)
141 * because the code does some casts of a 'struct radix_node *'
142 * to a 'struct rtentry *'
144 #define rt_key(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_key)))
145 #define rt_mask(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask)))
146 struct sockaddr *rt_gateway; /* value */
147 struct ifnet *rt_ifp; /* the answer: interface to use */
148 struct ifaddr *rt_ifa; /* the answer: interface address to use */
149 int rt_flags; /* up/down?, host/net */
150 int rt_refcnt; /* # held references */
151 u_int rt_fibnum; /* which FIB */
152 u_long rt_mtu; /* MTU for this path */
153 u_long rt_weight; /* absolute weight */
154 u_long rt_expire; /* lifetime for route, e.g. redirect */
155 #define rt_endzero rt_pksent
156 counter_u64_t rt_pksent; /* packets sent using this route */
157 struct mtx rt_mtx; /* mutex for routing entry */
158 struct rtentry *rt_chain; /* pointer to next rtentry to delete */
162 #define RTF_UP 0x1 /* route usable */
163 #define RTF_GATEWAY 0x2 /* destination is a gateway */
164 #define RTF_HOST 0x4 /* host entry (net otherwise) */
165 #define RTF_REJECT 0x8 /* host or net unreachable */
166 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
167 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
168 #define RTF_DONE 0x40 /* message confirmed */
169 /* 0x80 unused, was RTF_DELCLONE */
170 /* 0x100 unused, was RTF_CLONING */
171 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
172 #define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward
174 #define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */
175 #define RTF_STATIC 0x800 /* manually added */
176 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
177 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
178 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
179 /* 0x10000 unused, was RTF_PRCLONING */
180 /* 0x20000 unused, was RTF_WASCLONED */
181 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */
182 #define RTF_FIXEDMTU 0x80000 /* MTU was explicitly specified */
183 #define RTF_PINNED 0x100000 /* route is immutable */
184 #define RTF_LOCAL 0x200000 /* route represents a local address */
185 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */
186 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */
187 /* 0x8000000 and up unassigned */
188 #define RTF_STICKY 0x10000000 /* always route dst->src */
190 #define RTF_RNH_LOCKED 0x40000000 /* radix node head is locked */
192 #define RTF_GWFLAG_COMPAT 0x80000000 /* a compatibility bit for interacting
193 with existing routing apps */
195 /* Mask of RTF flags that are allowed to be modified by RTM_CHANGE. */
197 (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \
198 RTF_REJECT | RTF_STATIC | RTF_STICKY)
201 * fib_ nexthop API flags.
204 /* Consumer-visible nexthop info flags */
205 #define NHF_REJECT 0x0010 /* RTF_REJECT */
206 #define NHF_BLACKHOLE 0x0020 /* RTF_BLACKHOLE */
207 #define NHF_REDIRECT 0x0040 /* RTF_DYNAMIC|RTF_MODIFIED */
208 #define NHF_DEFAULT 0x0080 /* Default route */
209 #define NHF_BROADCAST 0x0100 /* RTF_BROADCAST */
210 #define NHF_GATEWAY 0x0200 /* RTF_GATEWAY */
212 /* Nexthop request flags */
213 #define NHR_IFAIF 0x01 /* Return ifa_ifp interface */
214 #define NHR_REF 0x02 /* For future use */
216 /* Control plane route request flags */
217 #define NHR_COPY 0x100 /* Copy rte data */
220 /* rte<>ro_flags translation */
222 rt_update_ro_flags(struct route *ro)
224 int rt_flags = ro->ro_rt->rt_flags;
226 ro->ro_flags &= ~ (RT_REJECT|RT_BLACKHOLE|RT_HAS_GW);
228 ro->ro_flags |= (rt_flags & RTF_REJECT) ? RT_REJECT : 0;
229 ro->ro_flags |= (rt_flags & RTF_BLACKHOLE) ? RT_BLACKHOLE : 0;
230 ro->ro_flags |= (rt_flags & RTF_GATEWAY) ? RT_HAS_GW : 0;
235 * Routing statistics.
238 short rts_badredirect; /* bogus redirect calls */
239 short rts_dynamic; /* routes created by redirects */
240 short rts_newgateway; /* routes modified by redirects */
241 short rts_unreach; /* lookups which failed */
242 short rts_wildcard; /* lookups satisfied by a wildcard */
245 * Structures for routing messages.
248 u_short rtm_msglen; /* to skip over non-understood messages */
249 u_char rtm_version; /* future binary compatibility */
250 u_char rtm_type; /* message type */
251 u_short rtm_index; /* index for associated ifp */
252 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
253 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
254 pid_t rtm_pid; /* identify sender */
255 int rtm_seq; /* for sender to identify action */
256 int rtm_errno; /* why failed */
257 int rtm_fmask; /* bitmask used in RTM_CHANGE message */
258 u_long rtm_inits; /* which metrics we are initializing */
259 struct rt_metrics rtm_rmx; /* metrics themselves */
262 #define RTM_VERSION 5 /* Up the ante and ignore older versions */
267 * The format for each message is annotated below using the following
270 * (1) struct rt_msghdr
271 * (2) struct ifa_msghdr
272 * (3) struct if_msghdr
273 * (4) struct ifma_msghdr
274 * (5) struct if_announcemsghdr
277 #define RTM_ADD 0x1 /* (1) Add Route */
278 #define RTM_DELETE 0x2 /* (1) Delete Route */
279 #define RTM_CHANGE 0x3 /* (1) Change Metrics or flags */
280 #define RTM_GET 0x4 /* (1) Report Metrics */
281 #define RTM_LOSING 0x5 /* (1) Kernel Suspects Partitioning */
282 #define RTM_REDIRECT 0x6 /* (1) Told to use different route */
283 #define RTM_MISS 0x7 /* (1) Lookup failed on this address */
284 #define RTM_LOCK 0x8 /* (1) fix specified metrics */
287 #define RTM_RESOLVE 0xb /* (1) req to resolve dst to LL addr */
288 #define RTM_NEWADDR 0xc /* (2) address being added to iface */
289 #define RTM_DELADDR 0xd /* (2) address being removed from iface */
290 #define RTM_IFINFO 0xe /* (3) iface going up/down etc. */
291 #define RTM_NEWMADDR 0xf /* (4) mcast group membership being added to if */
292 #define RTM_DELMADDR 0x10 /* (4) mcast group membership being deleted */
293 #define RTM_IFANNOUNCE 0x11 /* (5) iface arrival/departure */
294 #define RTM_IEEE80211 0x12 /* (5) IEEE80211 wireless event */
297 * Bitmask values for rtm_inits and rmx_locks.
299 #define RTV_MTU 0x1 /* init or lock _mtu */
300 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
301 #define RTV_EXPIRE 0x4 /* init or lock _expire */
302 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
303 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
304 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
305 #define RTV_RTT 0x40 /* init or lock _rtt */
306 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
307 #define RTV_WEIGHT 0x100 /* init or lock _weight */
310 * Bitmask values for rtm_addrs.
312 #define RTA_DST 0x1 /* destination sockaddr present */
313 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
314 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
315 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
316 #define RTA_IFP 0x10 /* interface name sockaddr present */
317 #define RTA_IFA 0x20 /* interface addr sockaddr present */
318 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
319 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
322 * Index offsets for sockaddr array for alternate internal encoding.
324 #define RTAX_DST 0 /* destination sockaddr present */
325 #define RTAX_GATEWAY 1 /* gateway sockaddr present */
326 #define RTAX_NETMASK 2 /* netmask sockaddr present */
327 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
328 #define RTAX_IFP 4 /* interface name sockaddr present */
329 #define RTAX_IFA 5 /* interface addr sockaddr present */
330 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
331 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
332 #define RTAX_MAX 8 /* size of array to allocate */
334 typedef int rt_filter_f_t(const struct rtentry *, void *);
337 int rti_addrs; /* Route RTF_ flags */
338 int rti_flags; /* Route RTF_ flags */
339 struct sockaddr *rti_info[RTAX_MAX]; /* Sockaddr data */
340 struct ifaddr *rti_ifa; /* value of rt_ifa addr */
341 struct ifnet *rti_ifp; /* route interface */
342 rt_filter_f_t *rti_filter; /* filter function */
343 void *rti_filterdata; /* filter paramenters */
344 u_long rti_mflags; /* metrics RTV_ flags */
345 u_long rti_spare; /* Will be used for fib */
346 struct rt_metrics *rti_rmx; /* Pointer to route metrics */
350 * This macro returns the size of a struct sockaddr when passed
351 * through a routing socket. Basically we round up sa_len to
352 * a multiple of sizeof(long), with a minimum of sizeof(long).
353 * The case sa_len == 0 should only apply to empty structures.
355 #define SA_SIZE(sa) \
356 ( (((struct sockaddr *)(sa))->sa_len == 0) ? \
358 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) )
360 #define sa_equal(a, b) ( \
361 (((const struct sockaddr *)(a))->sa_len == ((const struct sockaddr *)(b))->sa_len) && \
362 (bcmp((a), (b), ((const struct sockaddr *)(b))->sa_len) == 0))
366 #define RT_LINK_IS_UP(ifp) (!((ifp)->if_capabilities & IFCAP_LINKSTATE) \
367 || (ifp)->if_link_state == LINK_STATE_UP)
369 #define RT_LOCK_INIT(_rt) \
370 mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK | MTX_NEW)
371 #define RT_LOCK(_rt) mtx_lock(&(_rt)->rt_mtx)
372 #define RT_UNLOCK(_rt) mtx_unlock(&(_rt)->rt_mtx)
373 #define RT_LOCK_DESTROY(_rt) mtx_destroy(&(_rt)->rt_mtx)
374 #define RT_LOCK_ASSERT(_rt) mtx_assert(&(_rt)->rt_mtx, MA_OWNED)
375 #define RT_UNLOCK_COND(_rt) do { \
376 if (mtx_owned(&(_rt)->rt_mtx)) \
377 mtx_unlock(&(_rt)->rt_mtx); \
380 #define RT_ADDREF(_rt) do { \
381 RT_LOCK_ASSERT(_rt); \
382 KASSERT((_rt)->rt_refcnt >= 0, \
383 ("negative refcnt %d", (_rt)->rt_refcnt)); \
384 (_rt)->rt_refcnt++; \
387 #define RT_REMREF(_rt) do { \
388 RT_LOCK_ASSERT(_rt); \
389 KASSERT((_rt)->rt_refcnt > 0, \
390 ("bogus refcnt %d", (_rt)->rt_refcnt)); \
391 (_rt)->rt_refcnt--; \
394 #define RTFREE_LOCKED(_rt) do { \
395 if ((_rt)->rt_refcnt <= 1) \
401 /* guard against invalid refs */ \
405 #define RTFREE(_rt) do { \
407 RTFREE_LOCKED(_rt); \
410 #define RO_RTFREE(_ro) do { \
411 if ((_ro)->ro_rt) { \
412 RT_LOCK((_ro)->ro_rt); \
413 RTFREE_LOCKED((_ro)->ro_rt); \
418 * Validate a cached route based on a supplied cookie. If there is an
419 * out-of-date cache, simply free it. Update the generation number
420 * for the new allocation
422 #define RT_VALIDATE(ro, cookiep, fibnum) do { \
423 rt_gen_t cookie = RT_GEN(fibnum, (ro)->ro_dst.sa_family); \
424 if (*(cookiep) != cookie) { \
425 if ((ro)->ro_rt != NULL) { \
426 RTFREE((ro)->ro_rt); \
427 (ro)->ro_rt = NULL; \
429 *(cookiep) = cookie; \
436 void rt_ieee80211msg(struct ifnet *, int, void *, size_t);
437 void rt_ifannouncemsg(struct ifnet *, int);
438 void rt_ifmsg(struct ifnet *);
439 void rt_missmsg(int, struct rt_addrinfo *, int, int);
440 void rt_missmsg_fib(int, struct rt_addrinfo *, int, int, int);
441 void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
442 void rt_newaddrmsg_fib(int, struct ifaddr *, int, struct rtentry *, int);
443 int rt_addrmsg(int, struct ifaddr *, int);
444 int rt_routemsg(int, struct ifnet *ifp, int, struct rtentry *, int);
445 void rt_newmaddrmsg(int, struct ifmultiaddr *);
446 int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
447 void rt_maskedcopy(struct sockaddr *, struct sockaddr *, struct sockaddr *);
448 struct rib_head *rt_table_init(int);
449 void rt_table_destroy(struct rib_head *);
450 u_int rt_tables_get_gen(int table, int fam);
452 int rtsock_addrmsg(int, struct ifaddr *, int);
453 int rtsock_routemsg(int, struct ifnet *ifp, int, struct rtentry *, int);
456 * Note the following locking behavior:
458 * rtalloc1() returns a locked rtentry
460 * rtfree() and RTFREE_LOCKED() require a locked rtentry
462 * RTFREE() uses an unlocked entry.
465 void rtfree(struct rtentry *);
466 void rt_updatemtu(struct ifnet *);
468 typedef int rt_walktree_f_t(struct rtentry *, void *);
469 typedef void rt_setwarg_t(struct rib_head *, uint32_t, int, void *);
470 void rt_foreach_fib_walk(int af, rt_setwarg_t *, rt_walktree_f_t *, void *);
471 void rt_foreach_fib_walk_del(int af, rt_filter_f_t *filter_f, void *arg);
472 void rt_flushifroutes_af(struct ifnet *, int);
473 void rt_flushifroutes(struct ifnet *ifp);
475 /* XXX MRT COMPAT VERSIONS THAT SET UNIVERSE to 0 */
476 /* Thes are used by old code not yet converted to use multiple FIBS */
477 struct rtentry *rtalloc1(struct sockaddr *, int, u_long);
478 int rtinit(struct ifaddr *, int, int);
480 /* XXX MRT NEW VERSIONS THAT USE FIBs
481 * For now the protocol indepedent versions are the same as the AF_INET ones
482 * but this will change..
484 int rt_getifa_fib(struct rt_addrinfo *, u_int fibnum);
485 void rtalloc_ign_fib(struct route *ro, u_long ignflags, u_int fibnum);
486 struct rtentry *rtalloc1_fib(struct sockaddr *, int, u_long, u_int);
487 int rtioctl_fib(u_long, caddr_t, u_int);
488 void rtredirect_fib(struct sockaddr *, struct sockaddr *,
489 struct sockaddr *, int, struct sockaddr *, u_int);
490 int rtrequest_fib(int, struct sockaddr *,
491 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int);
492 int rtrequest1_fib(int, struct rt_addrinfo *, struct rtentry **, u_int);
493 int rib_lookup_info(uint32_t, const struct sockaddr *, uint32_t, uint32_t,
494 struct rt_addrinfo *);
495 void rib_free_info(struct rt_addrinfo *info);