route.h revision 1.52
1/* $NetBSD: route.h,v 1.52 2007/03/04 06:03:18 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/* 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 */ 54struct route { 55 struct rtentry *ro_rt; 56 struct sockaddr ro_dst; 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 */ 64struct 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 96struct rtentry { 97 struct radix_node rt_nodes[2]; /* tree glue, and other values */ 98/*XXXUNCONST*/ 99#define rt_key(r) ((struct sockaddr *)__UNCONST((r)->rt_nodes->rn_key)) 100/*XXXUNCONST*/ 101#define rt_mask(r) ((struct sockaddr *)__UNCONST((r)->rt_nodes->rn_mask)) 102 struct sockaddr *rt_gateway; /* value */ 103 int rt_flags; /* up/down?, host/net */ 104 int rt_refcnt; /* # held references */ 105 u_long rt_use; /* raw # packets forwarded */ 106 struct ifnet *rt_ifp; /* the answer: interface to use */ 107 struct ifaddr *rt_ifa; /* the answer: interface to use */ 108 uint32_t rt_ifa_seqno; 109 const struct sockaddr *rt_genmask; /* for generation of cloned routes */ 110 void * rt_llinfo; /* pointer to link level info cache */ 111 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */ 112 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 113 LIST_HEAD(, rttimer) rt_timer; /* queue of timeouts for misc funcs */ 114 struct rtentry *rt_parent; /* parent of cloned route */ 115}; 116 117/* 118 * Following structure necessary for 4.3 compatibility; 119 * We should eventually move it to a compat file. 120 */ 121struct ortentry { 122 u_int32_t rt_hash; /* to speed lookups */ 123 struct sockaddr rt_dst; /* key */ 124 struct sockaddr rt_gateway; /* value */ 125 int16_t rt_flags; /* up/down?, host/net */ 126 int16_t rt_refcnt; /* # held references */ 127 u_int32_t rt_use; /* raw # packets forwarded */ 128 struct ifnet *rt_ifp; /* the answer: interface to use */ 129}; 130 131#define RTF_UP 0x1 /* route usable */ 132#define RTF_GATEWAY 0x2 /* destination is a gateway */ 133#define RTF_HOST 0x4 /* host entry (net otherwise) */ 134#define RTF_REJECT 0x8 /* host or net unreachable */ 135#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 136#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 137#define RTF_DONE 0x40 /* message confirmed */ 138#define RTF_MASK 0x80 /* subnet mask present */ 139#define RTF_CLONING 0x100 /* generate new routes on use */ 140#define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 141#define RTF_LLINFO 0x400 /* generated by ARP or ESIS */ 142#define RTF_STATIC 0x800 /* manually added */ 143#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 144#define RTF_CLONED 0x2000 /* this is a cloned route */ 145#define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 146#define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 147#define RTF_SRC 0x10000 /* route has fixed source address */ 148 149 150/* 151 * Routing statistics. 152 */ 153struct rtstat { 154 u_quad_t rts_badredirect; /* bogus redirect calls */ 155 u_quad_t rts_dynamic; /* routes created by redirects */ 156 u_quad_t rts_newgateway; /* routes modified by redirects */ 157 u_quad_t rts_unreach; /* lookups which failed */ 158 u_quad_t rts_wildcard; /* lookups satisfied by a wildcard */ 159}; 160/* 161 * Structures for routing messages. 162 */ 163struct rt_msghdr { 164 u_short rtm_msglen; /* to skip over non-understood messages */ 165 u_char rtm_version; /* future binary compatibility */ 166 u_char rtm_type; /* message type */ 167 u_short rtm_index; /* index for associated ifp */ 168 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 169 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 170 pid_t rtm_pid; /* identify sender */ 171 int rtm_seq; /* for sender to identify action */ 172 int rtm_errno; /* why failed */ 173 int rtm_use; /* from rtentry */ 174 u_long rtm_inits; /* which metrics we are initializing */ 175 struct rt_metrics rtm_rmx; /* metrics themselves */ 176}; 177 178#define RTM_VERSION 3 /* Up the ante and ignore older versions */ 179 180#define RTM_ADD 0x1 /* Add Route */ 181#define RTM_DELETE 0x2 /* Delete Route */ 182#define RTM_CHANGE 0x3 /* Change Metrics or flags */ 183#define RTM_GET 0x4 /* Report Metrics */ 184#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 185#define RTM_REDIRECT 0x6 /* Told to use different route */ 186#define RTM_MISS 0x7 /* Lookup failed on this address */ 187#define RTM_LOCK 0x8 /* fix specified metrics */ 188#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 189#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 190#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 191#define RTM_NEWADDR 0xc /* address being added to iface */ 192#define RTM_DELADDR 0xd /* address being removed from iface */ 193#define RTM_OIFINFO 0xe /* Old (pre-1.5) RTM_IFINFO message */ 194#define RTM_IFINFO 0xf /* iface/link going up/down etc. */ 195#define RTM_IFANNOUNCE 0x10 /* iface arrival/departure */ 196#define RTM_IEEE80211 0x11 /* IEEE80211 wireless event */ 197 198#define RTV_MTU 0x1 /* init or lock _mtu */ 199#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 200#define RTV_EXPIRE 0x4 /* init or lock _expire */ 201#define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 202#define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 203#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 204#define RTV_RTT 0x40 /* init or lock _rtt */ 205#define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 206 207/* 208 * Bitmask values for rtm_addr. 209 */ 210#define RTA_DST 0x1 /* destination sockaddr present */ 211#define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 212#define RTA_NETMASK 0x4 /* netmask sockaddr present */ 213#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 214#define RTA_IFP 0x10 /* interface name sockaddr present */ 215#define RTA_IFA 0x20 /* interface addr sockaddr present */ 216#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 217#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 218 219/* 220 * Index offsets for sockaddr array for alternate internal encoding. 221 */ 222#define RTAX_DST 0 /* destination sockaddr present */ 223#define RTAX_GATEWAY 1 /* gateway sockaddr present */ 224#define RTAX_NETMASK 2 /* netmask sockaddr present */ 225#define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 226#define RTAX_IFP 4 /* interface name sockaddr present */ 227#define RTAX_IFA 5 /* interface addr sockaddr present */ 228#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 229#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 230#define RTAX_MAX 8 /* size of array to allocate */ 231 232struct rt_addrinfo { 233 int rti_addrs; 234 const struct sockaddr *rti_info[RTAX_MAX]; 235 int rti_flags; 236 struct ifaddr *rti_ifa; 237 struct ifnet *rti_ifp; 238 struct rt_msghdr *rti_rtm; 239}; 240 241struct route_cb { 242 int ip_count; 243 int ip6_count; 244 int ipx_count; 245 int ns_count; 246 int iso_count; 247 int any_count; 248}; 249 250/* 251 * This structure, and the prototypes for the rt_timer_{init,remove_all, 252 * add,timer} functions all used with the kind permission of BSDI. 253 * These allow functions to be called for routes at specific times. 254 */ 255 256struct rttimer { 257 TAILQ_ENTRY(rttimer) rtt_next; /* entry on timer queue */ 258 LIST_ENTRY(rttimer) rtt_link; /* multiple timers per rtentry */ 259 struct rttimer_queue *rtt_queue; /* back pointer to queue */ 260 struct rtentry *rtt_rt; /* Back pointer to the route */ 261 void (*rtt_func)(struct rtentry *, struct rttimer *); 262 time_t rtt_time; /* When this timer was registered */ 263}; 264 265struct rttimer_queue { 266 long rtq_timeout; 267 unsigned long rtq_count; 268 TAILQ_HEAD(, rttimer) rtq_head; 269 LIST_ENTRY(rttimer_queue) rtq_link; 270}; 271 272 273#ifdef _KERNEL 274extern struct route_cb route_cb; 275extern struct rtstat rtstat; 276extern struct radix_node_head *rt_tables[AF_MAX+1]; 277 278struct socket; 279 280void route_init(void); 281int route_output(struct mbuf *, ...); 282int route_usrreq(struct socket *, 283 int, struct mbuf *, struct mbuf *, struct mbuf *, struct lwp *); 284void rt_ifannouncemsg(struct ifnet *, int); 285void rt_ieee80211msg(struct ifnet *, int, void *, size_t); 286void rt_ifmsg(struct ifnet *); 287void rt_maskedcopy(const struct sockaddr *, 288 struct sockaddr *, const struct sockaddr *); 289void rt_missmsg(int, struct rt_addrinfo *, int, int); 290void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *); 291int rt_setgate(struct rtentry *, 292 const struct sockaddr *, const struct sockaddr *); 293void rt_setmetrics(u_long, const struct rt_metrics *, struct rt_metrics *); 294int rt_timer_add(struct rtentry *, 295 void(*)(struct rtentry *, struct rttimer *), 296 struct rttimer_queue *); 297void rt_timer_init(void); 298struct rttimer_queue * 299 rt_timer_queue_create(u_int); 300void rt_timer_queue_change(struct rttimer_queue *, long); 301void rt_timer_queue_remove_all(struct rttimer_queue *, int); 302void rt_timer_queue_destroy(struct rttimer_queue *, int); 303void rt_timer_remove_all(struct rtentry *, int); 304unsigned long rt_timer_count(struct rttimer_queue *); 305void rt_timer_timer(void *); 306void rtable_init(void **); 307void rtalloc(struct route *); 308void rtcache(struct route *); 309void rtflushall(int); 310void rtflush(struct route *); 311struct rtentry * 312 rtalloc1(const struct sockaddr *, int); 313void rtfree(struct rtentry *); 314int rt_getifa(struct rt_addrinfo *); 315int rtinit(struct ifaddr *, int, int); 316int rtioctl(u_long, void *, struct lwp *); 317void rtredirect(const struct sockaddr *, const struct sockaddr *, 318 const struct sockaddr *, int, const struct sockaddr *, 319 struct rtentry **); 320int rtrequest(int, const struct sockaddr *, 321 const struct sockaddr *, const struct sockaddr *, int, 322 struct rtentry **); 323int rtrequest1(int, struct rt_addrinfo *, struct rtentry **); 324 325struct ifaddr *rt_get_ifa(struct rtentry *); 326void rt_replace_ifa(struct rtentry *, struct ifaddr *); 327 328struct rtentry *rtfindparent(struct radix_node_head *, struct route *); 329 330#ifdef RTCACHE_DEBUG 331#define rtcache_init(ro) rtcache_init_debug(__func__, ro) 332#define rtcache_init_noclone(ro) rtcache_init_noclone_debug(__func__, ro) 333#define rtcache_copy(ro, oro, len) rtcache_copy_debug(__func__, ro, oro, len) 334void rtcache_init_debug(const char *, struct route *); 335void rtcache_init_noclone_debug(const char *, struct route *); 336void rtcache_copy_debug(const char *, struct route *, const struct route *, size_t); 337#else 338void rtcache_init(struct route *); 339void rtcache_init_noclone(struct route *); 340void rtcache_copy(struct route *, const struct route *, size_t); 341#endif 342 343void rtcache_update(struct route *); 344void rtcache_free(struct route *); 345 346static inline const struct sockaddr * 347rtcache_getdst(const struct route *ro) 348{ 349 return &ro->ro_dst; 350} 351 352static inline void 353rtcache_setdst(struct route *ro, struct sockaddr *sa) 354{ 355#if 0 356 KASSERT(ro->ro_sa != sa); 357 rtcache_free(ro); 358 ro->ro_sa = sa; 359#endif 360} 361 362static inline void 363rtcache_check(struct route *ro) 364{ 365 /* XXX The rt_ifp check should be asserted. */ 366 if (ro->ro_rt != NULL && 367 ((ro->ro_rt->rt_flags & RTF_UP) == 0 || 368 ro->ro_rt->rt_ifp == NULL)) 369 rtcache_update(ro); 370 KASSERT(ro->ro_rt == NULL || ro->ro_rt->rt_ifp != NULL); 371} 372 373static inline void 374RTFREE(struct rtentry *rt) 375{ 376 if (rt->rt_refcnt <= 1) 377 rtfree(rt); 378 else 379 rt->rt_refcnt--; 380} 381 382#endif /* _KERNEL */ 383#endif /* !_NET_ROUTE_H_ */ 384