1 /* $NetBSD: route.h,v 1.72 2009/01/11 02:45:54 christos 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 }; 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_XRESOLVE 0x200 /* external daemon resolves name */ 162 #define RTF_LLINFO 0x400 /* generated by ARP or ESIS */ 163 #define RTF_STATIC 0x800 /* manually added */ 164 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 165 #define RTF_CLONED 0x2000 /* this is a cloned route */ 166 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 167 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 168 #define RTF_SRC 0x10000 /* route has fixed source address */ 169 170 171 /* 172 * Routing statistics. 173 */ 174 struct rtstat { 175 u_quad_t rts_badredirect; /* bogus redirect calls */ 176 u_quad_t rts_dynamic; /* routes created by redirects */ 177 u_quad_t rts_newgateway; /* routes modified by redirects */ 178 u_quad_t rts_unreach; /* lookups which failed */ 179 u_quad_t rts_wildcard; /* lookups satisfied by a wildcard */ 180 }; 181 /* 182 * Structures for routing messages. 183 */ 184 struct rt_msghdr { 185 u_short rtm_msglen; /* to skip over non-understood messages */ 186 u_char rtm_version; /* future binary compatibility */ 187 u_char rtm_type; /* message type */ 188 u_short rtm_index; /* index for associated ifp */ 189 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 190 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 191 pid_t rtm_pid; /* identify sender */ 192 int rtm_seq; /* for sender to identify action */ 193 int rtm_errno; /* why failed */ 194 int rtm_use; /* from rtentry */ 195 u_long rtm_inits; /* which metrics we are initializing */ 196 struct rt_metrics rtm_rmx; /* metrics themselves */ 197 }; 198 199 #define RTM_VERSION 3 /* Up the ante and ignore older versions */ 200 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 */ 209 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 210 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 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_OOIFINFO 0xe /* Old (pre-1.5) RTM_IFINFO message */ 215 #define RTM_OIFINFO 0xf /* Old (pre-6.0) RTM_IFINFO message */ 216 #define RTM_IFANNOUNCE 0x10 /* iface arrival/departure */ 217 #define RTM_IEEE80211 0x11 /* IEEE80211 wireless event */ 218 #define RTM_SETGATE 0x12 /* set prototype gateway for clones 219 * (see example in arp_rtrequest). 220 */ 221 #define RTM_LLINFO_UPD 0x13 /* indication to ARP/NDP/etc. that link-layer 222 * address has changed 223 */ 224 #define RTM_IFINFO 0x14 /* iface/link going up/down etc. */ 225 226 #define RTV_MTU 0x1 /* init or lock _mtu */ 227 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 228 #define RTV_EXPIRE 0x4 /* init or lock _expire */ 229 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 230 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 231 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 232 #define RTV_RTT 0x40 /* init or lock _rtt */ 233 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 234 235 /* 236 * Bitmask values for rtm_addr. 237 */ 238 #define RTA_DST 0x1 /* destination sockaddr present */ 239 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 240 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 241 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 242 #define RTA_IFP 0x10 /* interface name sockaddr present */ 243 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 244 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 245 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 246 247 /* 248 * Index offsets for sockaddr array for alternate internal encoding. 249 */ 250 #define RTAX_DST 0 /* destination sockaddr present */ 251 #define RTAX_GATEWAY 1 /* gateway sockaddr present */ 252 #define RTAX_NETMASK 2 /* netmask sockaddr present */ 253 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 254 #define RTAX_IFP 4 /* interface name sockaddr present */ 255 #define RTAX_IFA 5 /* interface addr sockaddr present */ 256 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 257 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 258 #define RTAX_MAX 8 /* size of array to allocate */ 259 260 struct rt_addrinfo { 261 int rti_addrs; 262 const struct sockaddr *rti_info[RTAX_MAX]; 263 int rti_flags; 264 struct ifaddr *rti_ifa; 265 struct ifnet *rti_ifp; 266 struct rt_msghdr *rti_rtm; 267 }; 268 269 struct route_cb { 270 int ip_count; 271 int ip6_count; 272 int ipx_count; 273 int ns_count; 274 int iso_count; 275 int any_count; 276 }; 277 278 /* 279 * This structure, and the prototypes for the rt_timer_{init,remove_all, 280 * add,timer} functions all used with the kind permission of BSDI. 281 * These allow functions to be called for routes at specific times. 282 */ 283 284 struct rttimer { 285 TAILQ_ENTRY(rttimer) rtt_next; /* entry on timer queue */ 286 LIST_ENTRY(rttimer) rtt_link; /* multiple timers per rtentry */ 287 struct rttimer_queue *rtt_queue; /* back pointer to queue */ 288 struct rtentry *rtt_rt; /* Back pointer to the route */ 289 void (*rtt_func)(struct rtentry *, struct rttimer *); 290 time_t rtt_time; /* When this timer was registered */ 291 }; 292 293 struct rttimer_queue { 294 long rtq_timeout; 295 unsigned long rtq_count; 296 TAILQ_HEAD(, rttimer) rtq_head; 297 LIST_ENTRY(rttimer_queue) rtq_link; 298 }; 299 300 301 #ifdef _KERNEL 302 303 extern struct sockaddr route_dst; 304 extern struct sockaddr route_src; 305 extern struct sockproto route_proto; 306 307 struct rt_walkarg { 308 int w_op; 309 int w_arg; 310 int w_given; 311 int w_needed; 312 void * w_where; 313 int w_tmemsize; 314 int w_tmemneeded; 315 void * w_tmem; 316 }; 317 318 #if 0 319 #define RT_DPRINTF(__fmt, ...) do { } while (/*CONSTCOND*/0) 320 #else 321 #define RT_DPRINTF(__fmt, ...) /* do nothing */ 322 #endif 323 324 struct rtwalk { 325 int (*rw_f)(struct rtentry *, void *); 326 void *rw_v; 327 }; 328 extern struct route_cb route_cb; 329 extern struct rtstat rtstat; 330 extern struct radix_node_head *rt_tables[AF_MAX+1]; 331 332 struct socket; 333 struct dom_rtlist; 334 335 void route_init(void); 336 int route_output(struct mbuf *, ...); 337 int route_usrreq(struct socket *, 338 int, struct mbuf *, struct mbuf *, struct mbuf *, struct lwp *); 339 void rt_init(void); 340 void rt_ifannouncemsg(struct ifnet *, int); 341 void rt_ieee80211msg(struct ifnet *, int, void *, size_t); 342 void rt_ifmsg(struct ifnet *); 343 void rt_maskedcopy(const struct sockaddr *, 344 struct sockaddr *, const struct sockaddr *); 345 void rt_missmsg(int, struct rt_addrinfo *, int, int); 346 struct mbuf *rt_msg1(int, struct rt_addrinfo *, void *, int); 347 void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *); 348 int rt_setgate(struct rtentry *, const struct sockaddr *); 349 void rt_setmetrics(u_long, const struct rt_metrics *, struct nrt_metrics *); 350 int rt_timer_add(struct rtentry *, 351 void(*)(struct rtentry *, struct rttimer *), 352 struct rttimer_queue *); 353 void rt_timer_init(void); 354 struct rttimer_queue * 355 rt_timer_queue_create(u_int); 356 void rt_timer_queue_change(struct rttimer_queue *, long); 357 void rt_timer_queue_remove_all(struct rttimer_queue *, int); 358 void rt_timer_queue_destroy(struct rttimer_queue *, int); 359 void rt_timer_remove_all(struct rtentry *, int); 360 unsigned long rt_timer_count(struct rttimer_queue *); 361 void rt_timer_timer(void *); 362 void rtable_init(void **); 363 void rtcache(struct route *); 364 void rtflushall(int); 365 struct rtentry * 366 rtalloc1(const struct sockaddr *, int); 367 void rtfree(struct rtentry *); 368 int rt_getifa(struct rt_addrinfo *); 369 int rtinit(struct ifaddr *, int, int); 370 int rtioctl(u_long, void *, struct lwp *); 371 void rtredirect(const struct sockaddr *, const struct sockaddr *, 372 const struct sockaddr *, int, const struct sockaddr *, 373 struct rtentry **); 374 int rtrequest(int, const struct sockaddr *, 375 const struct sockaddr *, const struct sockaddr *, int, 376 struct rtentry **); 377 int rtrequest1(int, struct rt_addrinfo *, struct rtentry **); 378 379 struct ifaddr *rt_get_ifa(struct rtentry *); 380 void rt_replace_ifa(struct rtentry *, struct ifaddr *); 381 382 static inline void 383 rt_destroy(struct rtentry *rt) 384 { 385 if (rt->_rt_key != NULL) 386 sockaddr_free(rt->_rt_key); 387 if (rt->rt_gateway != NULL) 388 sockaddr_free(rt->rt_gateway); 389 rt->_rt_key = rt->rt_gateway = NULL; 390 } 391 392 static inline const struct sockaddr * 393 rt_setkey(struct rtentry *rt, const struct sockaddr *key, int flags) 394 { 395 if (rt->_rt_key == key) 396 goto out; 397 398 if (rt->_rt_key != NULL) 399 sockaddr_free(rt->_rt_key); 400 rt->_rt_key = sockaddr_dup(key, flags); 401 out: 402 KASSERT(rt->_rt_key != NULL); 403 rt->rt_nodes->rn_key = (const char *)rt->_rt_key; 404 return rt->_rt_key; 405 } 406 407 struct rtentry *rtfindparent(struct radix_node_head *, struct route *); 408 409 struct rtentry *rtcache_init(struct route *); 410 struct rtentry *rtcache_init_noclone(struct route *); 411 void rtcache_copy(struct route *, const struct route *); 412 void rtcache_invalidate(struct dom_rtlist *); 413 414 struct rtentry *rtcache_lookup2(struct route *, const struct sockaddr *, int, 415 int *); 416 void rtcache_clear(struct route *); 417 struct rtentry *rtcache_update(struct route *, int); 418 void rtcache_free(struct route *); 419 int rtcache_setdst(struct route *, const struct sockaddr *); 420 421 static inline void 422 rtcache_invariants(const struct route *ro) 423 { 424 KASSERT(ro->ro_sa != NULL || ro->_ro_rt == NULL); 425 KASSERT(!ro->ro_invalid || ro->_ro_rt != NULL); 426 } 427 428 static inline struct rtentry * 429 rtcache_lookup1(struct route *ro, const struct sockaddr *dst, int clone) 430 { 431 int hit; 432 433 return rtcache_lookup2(ro, dst, clone, &hit); 434 } 435 436 static inline struct rtentry * 437 rtcache_lookup_noclone(struct route *ro, const struct sockaddr *dst) 438 { 439 return rtcache_lookup1(ro, dst, 0); 440 } 441 442 static inline struct rtentry * 443 rtcache_lookup(struct route *ro, const struct sockaddr *dst) 444 { 445 return rtcache_lookup1(ro, dst, 1); 446 } 447 448 static inline const struct sockaddr * 449 rtcache_getdst(const struct route *ro) 450 { 451 rtcache_invariants(ro); 452 return ro->ro_sa; 453 } 454 455 /* If the cache is not empty, and the cached route is still present 456 * in the routing table, return the cached route. Otherwise, return 457 * NULL. 458 */ 459 static inline struct rtentry * 460 rtcache_validate(const struct route *ro) 461 { 462 struct rtentry *rt = ro->_ro_rt; 463 464 rtcache_invariants(ro); 465 466 if (ro->ro_invalid) 467 return NULL; 468 469 if (rt != NULL && (rt->rt_flags & RTF_UP) != 0 && rt->rt_ifp != NULL) 470 return rt; 471 return NULL; 472 473 } 474 475 static inline void 476 RTFREE(struct rtentry *rt) 477 { 478 if (rt->rt_refcnt <= 1) 479 rtfree(rt); 480 else 481 rt->rt_refcnt--; 482 } 483 484 int 485 rt_walktree(sa_family_t, int (*)(struct rtentry *, void *), void *); 486 void route_enqueue(struct mbuf *, int); 487 488 #endif /* _KERNEL */ 489 #endif /* !_NET_ROUTE_H_ */ 490