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>
39 * Kernel resident routing tables.
41 * The routing tables are initialized when interface addresses
42 * are set by making entries for all directly connected interfaces.
46 * A route consists of a destination address, a reference
47 * to a routing entry, and a reference to an llentry.
48 * These are often held by protocols in their control
52 struct rtentry *ro_rt;
53 struct llentry *ro_lle;
54 struct in_ifaddr *ro_ia;
56 struct sockaddr ro_dst;
59 #define RT_CACHING_CONTEXT 0x1 /* XXX: not used anywhere */
60 #define RT_NORTREF 0x2 /* doesn't hold reference on ro_rt */
63 u_long rmx_locks; /* Kernel must leave these values alone */
64 u_long rmx_mtu; /* MTU for this path */
65 u_long rmx_hopcount; /* max hops expected */
66 u_long rmx_expire; /* lifetime for route, e.g. redirect */
67 u_long rmx_recvpipe; /* inbound delay-bandwidth product */
68 u_long rmx_sendpipe; /* outbound delay-bandwidth product */
69 u_long rmx_ssthresh; /* outbound gateway buffer limit */
70 u_long rmx_rtt; /* estimated round trip time */
71 u_long rmx_rttvar; /* estimated rtt variance */
72 u_long rmx_pksent; /* packets sent using this route */
73 u_long rmx_weight; /* route weight */
74 u_long rmx_filler[3]; /* will be used for T/TCP later */
78 * rmx_rtt and rmx_rttvar are stored as microseconds;
79 * RTTTOPRHZ(rtt) converts to a value suitable for use
80 * by a protocol slowtimo counter.
82 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
83 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
85 #define RT_DEFAULT_FIB 0 /* Explicitly mark fib=0 restricted cases */
86 #define RT_ALL_FIBS -1 /* Announce event for every fib */
87 extern u_int rt_numfibs; /* number of usable routing tables */
88 extern u_int rt_add_addr_allfibs; /* Announce interfaces to all fibs */
91 * We distinguish between routes to hosts and routes to networks,
92 * preferring the former if available. For each route we infer
93 * the interface to use from the gateway address supplied when
94 * the route was entered. Routes that forward packets through
95 * gateways are marked so that the output routines know to address the
96 * gateway rather than the ultimate destination.
99 #include <net/radix.h>
101 #include <net/radix_mpath.h>
105 #if defined(_KERNEL) || defined(_WANT_RTENTRY)
107 struct radix_node rt_nodes[2]; /* tree glue, and other values */
109 * XXX struct rtentry must begin with a struct radix_node (or two!)
110 * because the code does some casts of a 'struct radix_node *'
111 * to a 'struct rtentry *'
113 #define rt_key(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_key)))
114 #define rt_mask(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask)))
115 struct sockaddr *rt_gateway; /* value */
116 struct ifnet *rt_ifp; /* the answer: interface to use */
117 struct ifaddr *rt_ifa; /* the answer: interface address to use */
118 int rt_flags; /* up/down?, host/net */
119 int rt_refcnt; /* # held references */
120 u_int rt_fibnum; /* which FIB */
121 u_long rt_mtu; /* MTU for this path */
122 u_long rt_weight; /* absolute weight */
123 u_long rt_expire; /* lifetime for route, e.g. redirect */
124 #define rt_endzero rt_pksent
125 counter_u64_t rt_pksent; /* packets sent using this route */
126 struct mtx rt_mtx; /* mutex for routing entry */
128 #endif /* _KERNEL || _WANT_RTENTRY */
130 #define RTF_UP 0x1 /* route usable */
131 #define RTF_GATEWAY 0x2 /* destination is a gateway */
132 #define RTF_HOST 0x4 /* host entry (net otherwise) */
133 #define RTF_REJECT 0x8 /* host or net unreachable */
134 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
135 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
136 #define RTF_DONE 0x40 /* message confirmed */
137 /* 0x80 unused, was RTF_DELCLONE */
138 /* 0x100 unused, was RTF_CLONING */
139 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
140 #define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward
142 #define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */
143 #define RTF_STATIC 0x800 /* manually added */
144 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
145 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
146 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
147 /* 0x10000 unused, was RTF_PRCLONING */
148 /* 0x20000 unused, was RTF_WASCLONED */
149 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */
151 #define RTF_PINNED 0x100000 /* route is immutable */
152 #define RTF_LOCAL 0x200000 /* route represents a local address */
153 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */
154 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */
155 /* 0x8000000 and up unassigned */
156 #define RTF_STICKY 0x10000000 /* always route dst->src */
158 #define RTF_RNH_LOCKED 0x40000000 /* radix node head is locked */
160 #define RTF_GWFLAG_COMPAT 0x80000000 /* a compatibility bit for interacting
161 with existing routing apps */
163 /* Mask of RTF flags that are allowed to be modified by RTM_CHANGE. */
165 (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \
166 RTF_REJECT | RTF_STATIC | RTF_STICKY)
169 * Routing statistics.
172 short rts_badredirect; /* bogus redirect calls */
173 short rts_dynamic; /* routes created by redirects */
174 short rts_newgateway; /* routes modified by redirects */
175 short rts_unreach; /* lookups which failed */
176 short rts_wildcard; /* lookups satisfied by a wildcard */
179 * Structures for routing messages.
182 u_short rtm_msglen; /* to skip over non-understood messages */
183 u_char rtm_version; /* future binary compatibility */
184 u_char rtm_type; /* message type */
185 u_short rtm_index; /* index for associated ifp */
186 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
187 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
188 pid_t rtm_pid; /* identify sender */
189 int rtm_seq; /* for sender to identify action */
190 int rtm_errno; /* why failed */
191 int rtm_fmask; /* bitmask used in RTM_CHANGE message */
192 u_long rtm_inits; /* which metrics we are initializing */
193 struct rt_metrics rtm_rmx; /* metrics themselves */
196 #define RTM_VERSION 5 /* Up the ante and ignore older versions */
201 #define RTM_ADD 0x1 /* Add Route */
202 #define RTM_DELETE 0x2 /* Delete Route */
203 #define RTM_CHANGE 0x3 /* Change Metrics or flags */
204 #define RTM_GET 0x4 /* Report Metrics */
205 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
206 #define RTM_REDIRECT 0x6 /* Told to use different route */
207 #define RTM_MISS 0x7 /* Lookup failed on this address */
208 #define RTM_LOCK 0x8 /* fix specified metrics */
211 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
212 #define RTM_NEWADDR 0xc /* address being added to iface */
213 #define RTM_DELADDR 0xd /* address being removed from iface */
214 #define RTM_IFINFO 0xe /* iface going up/down etc. */
215 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
216 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
217 #define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */
218 #define RTM_IEEE80211 0x12 /* IEEE80211 wireless event */
221 * Bitmask values for rtm_inits and rmx_locks.
223 #define RTV_MTU 0x1 /* init or lock _mtu */
224 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
225 #define RTV_EXPIRE 0x4 /* init or lock _expire */
226 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
227 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
228 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
229 #define RTV_RTT 0x40 /* init or lock _rtt */
230 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
231 #define RTV_WEIGHT 0x100 /* init or lock _weight */
234 * Bitmask values for rtm_addrs.
236 #define RTA_DST 0x1 /* destination sockaddr present */
237 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
238 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
239 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
240 #define RTA_IFP 0x10 /* interface name sockaddr present */
241 #define RTA_IFA 0x20 /* interface addr sockaddr present */
242 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
243 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
246 * Index offsets for sockaddr array for alternate internal encoding.
248 #define RTAX_DST 0 /* destination sockaddr present */
249 #define RTAX_GATEWAY 1 /* gateway sockaddr present */
250 #define RTAX_NETMASK 2 /* netmask sockaddr present */
251 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
252 #define RTAX_IFP 4 /* interface name sockaddr present */
253 #define RTAX_IFA 5 /* interface addr sockaddr present */
254 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
255 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
256 #define RTAX_MAX 8 /* size of array to allocate */
260 struct sockaddr *rti_info[RTAX_MAX];
262 struct ifaddr *rti_ifa;
263 struct ifnet *rti_ifp;
267 * This macro returns the size of a struct sockaddr when passed
268 * through a routing socket. Basically we round up sa_len to
269 * a multiple of sizeof(long), with a minimum of sizeof(long).
270 * The check for a NULL pointer is just a convenience, probably never used.
271 * The case sa_len == 0 should only apply to empty structures.
273 #define SA_SIZE(sa) \
274 ( (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ? \
276 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) )
280 #define RT_LINK_IS_UP(ifp) (!((ifp)->if_capabilities & IFCAP_LINKSTATE) \
281 || (ifp)->if_link_state == LINK_STATE_UP)
283 #define RT_LOCK_INIT(_rt) \
284 mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK)
285 #define RT_LOCK(_rt) mtx_lock(&(_rt)->rt_mtx)
286 #define RT_UNLOCK(_rt) mtx_unlock(&(_rt)->rt_mtx)
287 #define RT_LOCK_DESTROY(_rt) mtx_destroy(&(_rt)->rt_mtx)
288 #define RT_LOCK_ASSERT(_rt) mtx_assert(&(_rt)->rt_mtx, MA_OWNED)
289 #define RT_UNLOCK_COND(_rt) do { \
290 if (mtx_owned(&(_rt)->rt_mtx)) \
291 mtx_unlock(&(_rt)->rt_mtx); \
294 #define RT_ADDREF(_rt) do { \
295 RT_LOCK_ASSERT(_rt); \
296 KASSERT((_rt)->rt_refcnt >= 0, \
297 ("negative refcnt %d", (_rt)->rt_refcnt)); \
298 (_rt)->rt_refcnt++; \
301 #define RT_REMREF(_rt) do { \
302 RT_LOCK_ASSERT(_rt); \
303 KASSERT((_rt)->rt_refcnt > 0, \
304 ("bogus refcnt %d", (_rt)->rt_refcnt)); \
305 (_rt)->rt_refcnt--; \
308 #define RTFREE_LOCKED(_rt) do { \
309 if ((_rt)->rt_refcnt <= 1) \
315 /* guard against invalid refs */ \
319 #define RTFREE(_rt) do { \
321 RTFREE_LOCKED(_rt); \
324 #define RO_RTFREE(_ro) do { \
325 if ((_ro)->ro_rt) { \
326 if ((_ro)->ro_flags & RT_NORTREF) { \
327 (_ro)->ro_flags &= ~RT_NORTREF; \
328 (_ro)->ro_rt = NULL; \
330 RT_LOCK((_ro)->ro_rt); \
331 RTFREE_LOCKED((_ro)->ro_rt); \
336 struct radix_node_head *rt_tables_get_rnh(int, int);
340 void rt_ieee80211msg(struct ifnet *, int, void *, size_t);
341 void rt_ifannouncemsg(struct ifnet *, int);
342 void rt_ifmsg(struct ifnet *);
343 void rt_missmsg(int, struct rt_addrinfo *, int, int);
344 void rt_missmsg_fib(int, struct rt_addrinfo *, int, int, int);
345 void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
346 void rt_newaddrmsg_fib(int, struct ifaddr *, int, struct rtentry *, int);
347 int rt_addrmsg(int, struct ifaddr *, int);
348 int rt_routemsg(int, struct ifnet *ifp, int, struct rtentry *, int);
349 void rt_newmaddrmsg(int, struct ifmultiaddr *);
350 int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
351 void rt_maskedcopy(struct sockaddr *, struct sockaddr *, struct sockaddr *);
353 int rtsock_addrmsg(int, struct ifaddr *, int);
354 int rtsock_routemsg(int, struct ifnet *ifp, int, struct rtentry *, int);
357 * Note the following locking behavior:
359 * rtalloc_ign() and rtalloc() return ro->ro_rt unlocked
361 * rtalloc1() returns a locked rtentry
363 * rtfree() and RTFREE_LOCKED() require a locked rtentry
365 * RTFREE() uses an unlocked entry.
368 int rtexpunge(struct rtentry *);
369 void rtfree(struct rtentry *);
370 int rt_check(struct rtentry **, struct rtentry **, struct sockaddr *);
372 /* XXX MRT COMPAT VERSIONS THAT SET UNIVERSE to 0 */
373 /* Thes are used by old code not yet converted to use multiple FIBS */
374 int rt_getifa(struct rt_addrinfo *);
375 void rtalloc_ign(struct route *ro, u_long ignflags);
376 void rtalloc(struct route *ro); /* XXX deprecated, use rtalloc_ign(ro, 0) */
377 struct rtentry *rtalloc1(struct sockaddr *, int, u_long);
378 int rtinit(struct ifaddr *, int, int);
379 int rtioctl(u_long, caddr_t);
380 void rtredirect(struct sockaddr *, struct sockaddr *,
381 struct sockaddr *, int, struct sockaddr *);
382 int rtrequest(int, struct sockaddr *,
383 struct sockaddr *, struct sockaddr *, int, struct rtentry **);
385 /* XXX MRT NEW VERSIONS THAT USE FIBs
386 * For now the protocol indepedent versions are the same as the AF_INET ones
387 * but this will change..
389 int rt_getifa_fib(struct rt_addrinfo *, u_int fibnum);
390 void rtalloc_ign_fib(struct route *ro, u_long ignflags, u_int fibnum);
391 void rtalloc_fib(struct route *ro, u_int fibnum);
392 struct rtentry *rtalloc1_fib(struct sockaddr *, int, u_long, u_int);
393 int rtioctl_fib(u_long, caddr_t, u_int);
394 void rtredirect_fib(struct sockaddr *, struct sockaddr *,
395 struct sockaddr *, int, struct sockaddr *, u_int);
396 int rtrequest_fib(int, struct sockaddr *,
397 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int);
398 int rtrequest1_fib(int, struct rt_addrinfo *, struct rtentry **, u_int);
400 #include <sys/eventhandler.h>
401 typedef void (*rtevent_arp_update_fn)(void *, struct rtentry *, uint8_t *, struct sockaddr *);
402 typedef void (*rtevent_redirect_fn)(void *, struct rtentry *, struct rtentry *, struct sockaddr *);
403 /* route_arp_update_event is no longer generated; see arp_update_event */
404 EVENTHANDLER_DECLARE(route_arp_update_event, rtevent_arp_update_fn);
405 EVENTHANDLER_DECLARE(route_redirect_event, rtevent_redirect_fn);