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