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