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