1/* $NetBSD: route.h,v 1.107 2016/11/15 01:50:06 ozaki-r Exp $ */
2
3/*
4 * Copyright (c) 1980, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 * @(#)route.h 8.5 (Berkeley) 2/8/95
32 */
33
34#ifndef _NET_ROUTE_H_
35#define _NET_ROUTE_H_
36
37#include <sys/queue.h>
38#include <sys/socket.h>
39#include <sys/types.h>
40#include <net/if.h>
41
42#if !(defined(_KERNEL) || defined(_STANDALONE))
43#include <stdbool.h>
44#endif
45
46/*
47 * Kernel resident routing tables.
48 *
49 * The routing tables are initialized when interface addresses
50 * are set by making entries for all directly connected interfaces.
51 */
52
53/*
54 * A route consists of a destination address and a reference
55 * to a routing entry. These are often held by protocols
56 * in their control blocks, e.g. inpcb.
57 */
58struct route {
59 struct rtentry *_ro_rt;
60 struct sockaddr *ro_sa;
61 LIST_ENTRY(route) ro_rtcache_next;
62 bool ro_invalid;
63};
64
65/*
66 * These numbers are used by reliable protocols for determining
67 * retransmission behavior and are included in the routing structure.
68 */
69struct rt_metrics {
70 uint64_t rmx_locks; /* Kernel must leave these values alone */
71 uint64_t rmx_mtu; /* MTU for this path */
72 uint64_t rmx_hopcount; /* max hops expected */
73 uint64_t rmx_recvpipe; /* inbound delay-bandwidth product */
74 uint64_t rmx_sendpipe; /* outbound delay-bandwidth product */
75 uint64_t rmx_ssthresh; /* outbound gateway buffer limit */
76 uint64_t rmx_rtt; /* estimated round trip time */
77 uint64_t rmx_rttvar; /* estimated rtt variance */
78 time_t rmx_expire; /* lifetime for route, e.g. redirect */
79 time_t rmx_pksent; /* packets sent using this route */
80};
81
82/*
83 * rmx_rtt and rmx_rttvar are stored as microseconds;
84 * RTTTOPRHZ(rtt) converts to a value suitable for use
85 * by a protocol slowtimo counter.
86 */
87#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
88#define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
89
90/*
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.
97 */
98#ifndef RNF_NORMAL
99#include <net/radix.h>
100#endif
101struct rtentry {
102 struct radix_node rt_nodes[2]; /* tree glue, and other values */
103#define rt_mask(r) ((const struct sockaddr *)((r)->rt_nodes->rn_mask))
104 struct sockaddr *rt_gateway; /* value */
105 int rt_flags; /* up/down?, host/net */
106 int rt_refcnt; /* # held references */
107 uint64_t rt_use; /* raw # packets forwarded */
108 struct ifnet *rt_ifp; /* the answer: interface to use */
109 struct ifaddr *rt_ifa; /* the answer: interface to use */
110 uint32_t rt_ifa_seqno;
111 void * rt_llinfo; /* pointer to link level info cache */
112 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */
113 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */
114 LIST_HEAD(, rttimer) rt_timer; /* queue of timeouts for misc funcs */
115 struct rtentry *rt_parent; /* parent of cloned route */
116 struct sockaddr *_rt_key;
117 struct sockaddr *rt_tag; /* route tagging info */
118};
119
120static inline const struct sockaddr *
121rt_getkey(const struct rtentry *rt)
122{
123 return rt->_rt_key;
124}
125
126/*
127 * Following structure necessary for 4.3 compatibility;
128 * We should eventually move it to a compat file.
129 */
130struct ortentry {
131 uint32_t rt_hash; /* to speed lookups */
132 struct sockaddr rt_dst; /* key */
133 struct sockaddr rt_gateway; /* value */
134 int16_t rt_flags; /* up/down?, host/net */
135 int16_t rt_refcnt; /* # held references */
136 uint32_t rt_use; /* raw # packets forwarded */
137 struct ifnet *rt_ifp; /* the answer: interface to use */
138};
139
140#define RTF_UP 0x1 /* route usable */
141#define RTF_GATEWAY 0x2 /* destination is a gateway */
142#define RTF_HOST 0x4 /* host entry (net otherwise) */
143#define RTF_REJECT 0x8 /* host or net unreachable */
144#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
145#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
146#define RTF_DONE 0x40 /* message confirmed */
147#define RTF_MASK 0x80 /* subnet mask present */
148// #define RTF_CLONING 0x100 /* generate new routes on use */
149#define RTF_CONNECTED 0x100 /* hosts on this route are neighbours */
150// #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
151// #define RTF_LLINFO 0x400 /* generated by ARP or NDP */
152#define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */
153#define RTF_STATIC 0x800 /* manually added */
154#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
155// #define RTF_CLONED 0x2000 /* this is a cloned route */
156#define RTF_PROTO2 0x4000 /* protocol specific routing flag */
157#define RTF_PROTO1 0x8000 /* protocol specific routing flag */
158#define RTF_SRC 0x10000 /* route has fixed source address */
159#define RTF_ANNOUNCE 0x20000 /* announce new ARP or NDP entry */
160#define RTF_LOCAL 0x40000 /* route represents a local address */
161#define RTF_BROADCAST 0x80000 /* route represents a bcast address */
162
163/*
164 * Routing statistics.
165 */
166struct rtstat {
167 uint64_t rts_badredirect; /* bogus redirect calls */
168 uint64_t rts_dynamic; /* routes created by redirects */
169 uint64_t rts_newgateway; /* routes modified by redirects */
170 uint64_t rts_unreach; /* lookups which failed */
171 uint64_t rts_wildcard; /* lookups satisfied by a wildcard */
172};
173
174/*
175 * Structures for routing messages. By forcing the first member to be aligned
176 * at a 64-bit boundary, we also force the size to be a multiple of 64-bits.
177 */
178
179#if !defined(_KERNEL) || !defined(COMPAT_RTSOCK)
180/*
181 * If we aren't being compiled for backwards compatiblity, enforce 64-bit
182 * alignment so any routing message is the same regardless if the kernel
183 * is an ILP32 or LP64 kernel.
184 */
185#define __align64 __aligned(sizeof(uint64_t))
186#else
187#define __align64
188#endif
189
190struct rt_msghdr {
191 u_short rtm_msglen __align64;
192 /* to skip over non-understood messages */
193 u_char rtm_version; /* future binary compatibility */
194 u_char rtm_type; /* message type */
195 u_short rtm_index; /* index for associated ifp */
196 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
197 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
198 pid_t rtm_pid; /* identify sender */
199 int rtm_seq; /* for sender to identify action */
200 int rtm_errno; /* why failed */
201 int rtm_use; /* from rtentry */
202 int rtm_inits; /* which metrics we are initializing */
203 struct rt_metrics rtm_rmx __align64;
204 /* metrics themselves */
205};
206
207#undef __align64
208
209#define RTM_VERSION 4 /* Up the ante and ignore older versions */
210
211#define RTM_ADD 0x1 /* Add Route */
212#define RTM_DELETE 0x2 /* Delete Route */
213#define RTM_CHANGE 0x3 /* Change Metrics or flags */
214#define RTM_GET 0x4 /* Report Metrics */
215#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
216#define RTM_REDIRECT 0x6 /* Told to use different route */
217#define RTM_MISS 0x7 /* Lookup failed on this address */
218#define RTM_LOCK 0x8 /* fix specified metrics */
219#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
220#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
221// #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
222#define RTM_ONEWADDR 0xc /* Old (pre-8.0) RTM_NEWADDR message */
223#define RTM_ODELADDR 0xd /* Old (pre-8.0) RTM_DELADDR message */
224#define RTM_OOIFINFO 0xe /* Old (pre-1.5) RTM_IFINFO message */
225#define RTM_OIFINFO 0xf /* Old (pre-64bit time) RTM_IFINFO message */
226#define RTM_IFANNOUNCE 0x10 /* iface arrival/departure */
227#define RTM_IEEE80211 0x11 /* IEEE80211 wireless event */
228#define RTM_SETGATE 0x12 /* set prototype gateway for clones
229 * (see example in arp_rtrequest).
230 */
231#define RTM_LLINFO_UPD 0x13 /* indication to ARP/NDP/etc. that link-layer
232 * address has changed
233 */
234#define RTM_IFINFO 0x14 /* iface/link going up/down etc. */
235#define RTM_OCHGADDR 0x15 /* Old (pre-8.0) RTM_CHGADDR message */
236#define RTM_NEWADDR 0x16 /* address being added to iface */
237#define RTM_DELADDR 0x17 /* address being removed from iface */
238#define RTM_CHGADDR 0x18 /* address properties changed */
239
240#define RTV_MTU 0x1 /* init or lock _mtu */
241#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
242#define RTV_EXPIRE 0x4 /* init or lock _expire */
243#define RTV_RPIPE 0x8 /* init or lock _recvpipe */
244#define RTV_SPIPE 0x10 /* init or lock _sendpipe */
245#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
246#define RTV_RTT 0x40 /* init or lock _rtt */
247#define RTV_RTTVAR 0x80 /* init or lock _rttvar */
248
249/*
250 * Bitmask values for rtm_addr.
251 */
252#define RTA_DST 0x1 /* destination sockaddr present */
253#define RTA_GATEWAY 0x2 /* gateway sockaddr present */
254#define RTA_NETMASK 0x4 /* netmask sockaddr present */
255#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
256#define RTA_IFP 0x10 /* interface name sockaddr present */
257#define RTA_IFA 0x20 /* interface addr sockaddr present */
258#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
259#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
260#define RTA_TAG 0x100 /* route tag */
261
262/*
263 * Index offsets for sockaddr array for alternate internal encoding.
264 */
265#define RTAX_DST 0 /* destination sockaddr present */
266#define RTAX_GATEWAY 1 /* gateway sockaddr present */
267#define RTAX_NETMASK 2 /* netmask sockaddr present */
268#define RTAX_GENMASK 3 /* cloning mask sockaddr present */
269#define RTAX_IFP 4 /* interface name sockaddr present */
270#define RTAX_IFA 5 /* interface addr sockaddr present */
271#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
272#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
273#define RTAX_TAG 8 /* route tag */
274#define RTAX_MAX 9 /* size of array to allocate */
275
276#define RT_ROUNDUP2(a, n) ((a) > 0 ? (1 + (((a) - 1) | ((n) - 1))) : (n))
277#define RT_ROUNDUP(a) RT_ROUNDUP2((a), sizeof(uint64_t))
278#define RT_ADVANCE(x, n) (x += RT_ROUNDUP((n)->sa_len))
279
280struct rt_addrinfo {
281 int rti_addrs;
282 const struct sockaddr *rti_info[RTAX_MAX];
283 int rti_flags;
284 struct ifaddr *rti_ifa;
285 struct ifnet *rti_ifp;
286};
287
288struct route_cb {
289 int ip_count;
290 int ip6_count;
291 int unused1;
292 int mpls_count;
293 int any_count;
294};
295
296/*
297 * This structure, and the prototypes for the rt_timer_{init,remove_all,
298 * add,timer} functions all used with the kind permission of BSDI.
299 * These allow functions to be called for routes at specific times.
300 */
301
302struct rttimer {
303 TAILQ_ENTRY(rttimer) rtt_next; /* entry on timer queue */
304 LIST_ENTRY(rttimer) rtt_link; /* multiple timers per rtentry */
305 struct rttimer_queue *rtt_queue; /* back pointer to queue */
306 struct rtentry *rtt_rt; /* Back pointer to the route */
307 void (*rtt_func)(struct rtentry *, struct rttimer *);
308 time_t rtt_time; /* When this timer was registered */
309};
310
311struct rttimer_queue {
312 long rtq_timeout;
313 unsigned long rtq_count;
314 TAILQ_HEAD(, rttimer) rtq_head;
315 LIST_ENTRY(rttimer_queue) rtq_link;
316};
317
318
319struct rtbl;
320typedef struct rtbl rtbl_t;
321
322#ifdef _KERNEL
323
324struct rtbl {
325 struct radix_node_head t_rnh;
326};
327
328struct rt_walkarg {
329 int w_op;
330 int w_arg;
331 int w_given;
332 int w_needed;
333 void * w_where;
334 int w_tmemsize;
335 int w_tmemneeded;
336 void * w_tmem;
337};
338
339#if 0
340#define RT_DPRINTF(__fmt, ...) do { } while (/*CONSTCOND*/0)
341#else
342#define RT_DPRINTF(__fmt, ...) /* do nothing */
343#endif
344
345struct rtwalk {
346 int (*rw_f)(struct rtentry *, void *);
347 void *rw_v;
348};
349
350/*
351 * Global data specific to the routing socket.
352 */
353struct route_info {
354 struct sockaddr ri_dst;
355 struct sockaddr ri_src;
356 struct route_cb ri_cb;
357 int ri_maxqlen;
358 struct ifqueue ri_intrq;
359 void *ri_sih;
360};
361
362extern struct route_info route_info;
363extern struct rtstat rtstat;
364
365struct socket;
366
367void rt_init(void);
368
369int rt_timer_add(struct rtentry *,
370 void(*)(struct rtentry *, struct rttimer *),
371 struct rttimer_queue *);
372unsigned long
373 rt_timer_count(struct rttimer_queue *);
374void rt_timer_queue_change(struct rttimer_queue *, long);
375struct rttimer_queue *
376 rt_timer_queue_create(u_int);
377void rt_timer_queue_destroy(struct rttimer_queue *);
378
379void rt_newmsg(const int, const struct rtentry *);
380struct rtentry *
381 rtalloc1(const struct sockaddr *, int);
382void rtfree(struct rtentry *);
383int rtinit(struct ifaddr *, int, int);
384void rtredirect(const struct sockaddr *, const struct sockaddr *,
385 const struct sockaddr *, int, const struct sockaddr *,
386 struct rtentry **);
387int rtrequest(int, const struct sockaddr *,
388 const struct sockaddr *, const struct sockaddr *, int,
389 struct rtentry **);
390int rtrequest1(int, struct rt_addrinfo *, struct rtentry **);
391int rtrequest_newmsg(const int, const struct sockaddr *,
392 const struct sockaddr *, const struct sockaddr *, const int);
393
394int rt_ifa_addlocal(struct ifaddr *);
395int rt_ifa_remlocal(struct ifaddr *, struct ifaddr *);
396struct ifaddr *
397 rt_get_ifa(struct rtentry *);
398struct ifaddr *
399 rt_getifa(struct rt_addrinfo *, struct psref *);
400struct ifnet *
401 rt_getifp(struct rt_addrinfo *, struct psref *);
402void rt_replace_ifa(struct rtentry *, struct ifaddr *);
403int rt_setgate(struct rtentry *, const struct sockaddr *);
404
405const struct sockaddr *
406 rt_settag(struct rtentry *, const struct sockaddr *);
407struct sockaddr *
408 rt_gettag(const struct rtentry *);
409
410int rt_check_reject_route(const struct rtentry *, const struct ifnet *);
411void rt_delete_matched_entries(sa_family_t,
412 int (*)(struct rtentry *, void *), void *);
413
414static inline void
415rt_assert_referenced(const struct rtentry *rt)
416{
417
418 KASSERT(rt->rt_refcnt > 0);
419}
420
421void rtcache_copy(struct route *, const struct route *);
422void rtcache_free(struct route *);
423struct rtentry *
424 rtcache_init(struct route *);
425struct rtentry *
426 rtcache_init_noclone(struct route *);
427struct rtentry *
428 rtcache_lookup2(struct route *, const struct sockaddr *, int,
429 int *);
430int rtcache_setdst(struct route *, const struct sockaddr *);
431struct rtentry *
432 rtcache_update(struct route *, int);
433
434static inline void
435rtcache_invariants(const struct route *ro)
436{
437 KASSERT(ro->ro_sa != NULL || ro->_ro_rt == NULL);
438 KASSERT(!ro->ro_invalid || ro->_ro_rt != NULL);
439 KASSERT(ro->_ro_rt == NULL || ro->_ro_rt->rt_refcnt > 0);
440}
441
442static inline struct rtentry *
443rtcache_lookup1(struct route *ro, const struct sockaddr *dst, int clone)
444{
445 int hit;
446
447 return rtcache_lookup2(ro, dst, clone, &hit);
448}
449
450static inline struct rtentry *
451rtcache_lookup(struct route *ro, const struct sockaddr *dst)
452{
453 return rtcache_lookup1(ro, dst, 1);
454}
455
456static inline const struct sockaddr *
457rtcache_getdst(const struct route *ro)
458{
459 rtcache_invariants(ro);
460 return ro->ro_sa;
461}
462
463/* If the cache is not empty, and the cached route is still present
464 * in the routing table, return the cached route. Otherwise, return
465 * NULL.
466 */
467static inline struct rtentry *
468rtcache_validate(const struct route *ro)
469{
470 struct rtentry *rt = ro->_ro_rt;
471
472 rtcache_invariants(ro);
473
474 if (ro->ro_invalid)
475 return NULL;
476
477 if (rt != NULL && (rt->rt_flags & RTF_UP) != 0 && rt->rt_ifp != NULL)
478 return rt;
479 return NULL;
480
481}
482
483/* rtsock */
484void rt_ieee80211msg(struct ifnet *, int, void *, size_t);
485void rt_ifannouncemsg(struct ifnet *, int);
486void rt_ifmsg(struct ifnet *);
487void rt_missmsg(int, const struct rt_addrinfo *, int, int);
488struct mbuf *
489 rt_msg1(int, struct rt_addrinfo *, void *, int);
490int rt_msg3(int, struct rt_addrinfo *, void *, struct rt_walkarg *, int *);
491void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
492void route_enqueue(struct mbuf *, int);
493
494/* rtbl */
495int rt_addaddr(rtbl_t *, struct rtentry *, const struct sockaddr *);
496void rt_assert_inactive(const struct rtentry *);
497struct rtentry *
498 rt_deladdr(rtbl_t *, const struct sockaddr *,
499 const struct sockaddr *);
500rtbl_t *rt_gettable(sa_family_t);
501int rt_inithead(rtbl_t **, int);
502struct rtentry *
503 rt_lookup(rtbl_t *, const struct sockaddr *,
504 const struct sockaddr *);
505struct rtentry *
506 rt_matchaddr(rtbl_t *, const struct sockaddr *);
507int rt_refines(const struct sockaddr *, const struct sockaddr *);
508int rt_walktree(sa_family_t, int (*)(struct rtentry *, void *), void *);
509struct rtentry *
510 rtbl_search_matched_entry(sa_family_t,
511 int (*)(struct rtentry *, void *), void *);
512void rtbl_init(void);
513
514#endif /* _KERNEL */
515
516#endif /* !_NET_ROUTE_H_ */
517