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