route.h revision 232292
1/*- 2 * Copyright (c) 1980, 1986, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)route.h 8.4 (Berkeley) 1/9/95 30 * $FreeBSD: stable/9/sys/net/route.h 232292 2012-02-29 09:47:26Z bz $ 31 */ 32 33#ifndef _NET_ROUTE_H_ 34#define _NET_ROUTE_H_ 35 36/* 37 * Kernel resident routing tables. 38 * 39 * The routing tables are initialized when interface addresses 40 * are set by making entries for all directly connected interfaces. 41 */ 42 43/* 44 * A route consists of a destination address, a reference 45 * to a routing entry, and a reference to an llentry. 46 * These are often held by protocols in their control 47 * blocks, e.g. inpcb. 48 */ 49struct route { 50 struct rtentry *ro_rt; 51 struct llentry *ro_lle; 52 struct in_ifaddr *ro_ia; 53 int ro_flags; 54 struct sockaddr ro_dst; 55}; 56 57#define RT_CACHING_CONTEXT 0x1 58 59/* 60 * These numbers are used by reliable protocols for determining 61 * retransmission behavior and are included in the routing structure. 62 */ 63struct rt_metrics_lite { 64 u_long rmx_mtu; /* MTU for this path */ 65 u_long rmx_expire; /* lifetime for route, e.g. redirect */ 66 u_long rmx_pksent; /* packets sent using this route */ 67 u_long rmx_weight; /* absolute weight */ 68}; 69 70struct rt_metrics { 71 u_long rmx_locks; /* Kernel must leave these values alone */ 72 u_long rmx_mtu; /* MTU for this path */ 73 u_long rmx_hopcount; /* max hops expected */ 74 u_long rmx_expire; /* lifetime for route, e.g. redirect */ 75 u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 76 u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 77 u_long rmx_ssthresh; /* outbound gateway buffer limit */ 78 u_long rmx_rtt; /* estimated round trip time */ 79 u_long rmx_rttvar; /* estimated rtt variance */ 80 u_long rmx_pksent; /* packets sent using this route */ 81 u_long rmx_weight; /* route weight */ 82 u_long rmx_filler[3]; /* will be used for T/TCP later */ 83}; 84 85/* 86 * rmx_rtt and rmx_rttvar are stored as microseconds; 87 * RTTTOPRHZ(rtt) converts to a value suitable for use 88 * by a protocol slowtimo counter. 89 */ 90#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 91#define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 92 93/* MRT compile-time constants */ 94#ifdef _KERNEL 95 #ifndef ROUTETABLES 96 #define RT_NUMFIBS 1 97 #define RT_MAXFIBS 1 98 #else 99 /* while we use 4 bits in the mbuf flags, we are limited to 16 */ 100 #define RT_MAXFIBS 16 101 #if ROUTETABLES > RT_MAXFIBS 102 #define RT_NUMFIBS RT_MAXFIBS 103 #error "ROUTETABLES defined too big" 104 #else 105 #if ROUTETABLES == 0 106 #define RT_NUMFIBS 1 107 #else 108 #define RT_NUMFIBS ROUTETABLES 109 #endif 110 #endif 111 #endif 112#endif 113 114#define RT_DEFAULT_FIB 0 /* Explicitly mark fib=0 restricted cases */ 115extern u_int rt_numfibs; /* number fo usable routing tables */ 116/* 117 * XXX kernel function pointer `rt_output' is visible to applications. 118 */ 119struct mbuf; 120 121/* 122 * We distinguish between routes to hosts and routes to networks, 123 * preferring the former if available. For each route we infer 124 * the interface to use from the gateway address supplied when 125 * the route was entered. Routes that forward packets through 126 * gateways are marked so that the output routines know to address the 127 * gateway rather than the ultimate destination. 128 */ 129#ifndef RNF_NORMAL 130#include <net/radix.h> 131#ifdef RADIX_MPATH 132#include <net/radix_mpath.h> 133#endif 134#endif 135struct rtentry { 136 struct radix_node rt_nodes[2]; /* tree glue, and other values */ 137 /* 138 * XXX struct rtentry must begin with a struct radix_node (or two!) 139 * because the code does some casts of a 'struct radix_node *' 140 * to a 'struct rtentry *' 141 */ 142#define rt_key(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_key))) 143#define rt_mask(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask))) 144 struct sockaddr *rt_gateway; /* value */ 145 int rt_flags; /* up/down?, host/net */ 146 int rt_refcnt; /* # held references */ 147 struct ifnet *rt_ifp; /* the answer: interface to use */ 148 struct ifaddr *rt_ifa; /* the answer: interface address to use */ 149 struct rt_metrics_lite rt_rmx; /* metrics used by rx'ing protocols */ 150 u_int rt_fibnum; /* which FIB */ 151#ifdef _KERNEL 152 /* XXX ugly, user apps use this definition but don't have a mtx def */ 153 struct mtx rt_mtx; /* mutex for routing entry */ 154#endif 155}; 156 157/* 158 * Following structure necessary for 4.3 compatibility; 159 * We should eventually move it to a compat file. 160 */ 161struct ortentry { 162 u_long rt_hash; /* to speed lookups */ 163 struct sockaddr rt_dst; /* key */ 164 struct sockaddr rt_gateway; /* value */ 165 short rt_flags; /* up/down?, host/net */ 166 short rt_refcnt; /* # held references */ 167 u_long rt_use; /* raw # packets forwarded */ 168 struct ifnet *rt_ifp; /* the answer: interface to use */ 169}; 170 171#define rt_use rt_rmx.rmx_pksent 172 173#define RTF_UP 0x1 /* route usable */ 174#define RTF_GATEWAY 0x2 /* destination is a gateway */ 175#define RTF_HOST 0x4 /* host entry (net otherwise) */ 176#define RTF_REJECT 0x8 /* host or net unreachable */ 177#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 178#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 179#define RTF_DONE 0x40 /* message confirmed */ 180/* 0x80 unused, was RTF_DELCLONE */ 181/* 0x100 unused, was RTF_CLONING */ 182#define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 183#define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward 184 compatibility */ 185#define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */ 186#define RTF_STATIC 0x800 /* manually added */ 187#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 188#define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 189#define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 190 191/* XXX: temporary to stay API/ABI compatible with userland */ 192#ifndef _KERNEL 193#define RTF_PRCLONING 0x10000 /* unused, for compatibility */ 194#endif 195 196/* 0x20000 unused, was RTF_WASCLONED */ 197#define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 198/* 0x80000 unused */ 199#define RTF_PINNED 0x100000 /* future use */ 200#define RTF_LOCAL 0x200000 /* route represents a local address */ 201#define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 202#define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 203 /* 0x8000000 and up unassigned */ 204#define RTF_STICKY 0x10000000 /* always route dst->src */ 205 206#define RTF_RNH_LOCKED 0x40000000 /* radix node head is locked */ 207 208/* Mask of RTF flags that are allowed to be modified by RTM_CHANGE. */ 209#define RTF_FMASK \ 210 (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \ 211 RTF_REJECT | RTF_STATIC | RTF_STICKY) 212 213/* 214 * Routing statistics. 215 */ 216struct rtstat { 217 short rts_badredirect; /* bogus redirect calls */ 218 short rts_dynamic; /* routes created by redirects */ 219 short rts_newgateway; /* routes modified by redirects */ 220 short rts_unreach; /* lookups which failed */ 221 short rts_wildcard; /* lookups satisfied by a wildcard */ 222}; 223/* 224 * Structures for routing messages. 225 */ 226struct rt_msghdr { 227 u_short rtm_msglen; /* to skip over non-understood messages */ 228 u_char rtm_version; /* future binary compatibility */ 229 u_char rtm_type; /* message type */ 230 u_short rtm_index; /* index for associated ifp */ 231 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 232 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 233 pid_t rtm_pid; /* identify sender */ 234 int rtm_seq; /* for sender to identify action */ 235 int rtm_errno; /* why failed */ 236 int rtm_fmask; /* bitmask used in RTM_CHANGE message */ 237 u_long rtm_inits; /* which metrics we are initializing */ 238 struct rt_metrics rtm_rmx; /* metrics themselves */ 239}; 240 241#define RTM_VERSION 5 /* Up the ante and ignore older versions */ 242 243/* 244 * Message types. 245 */ 246#define RTM_ADD 0x1 /* Add Route */ 247#define RTM_DELETE 0x2 /* Delete Route */ 248#define RTM_CHANGE 0x3 /* Change Metrics or flags */ 249#define RTM_GET 0x4 /* Report Metrics */ 250#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 251#define RTM_REDIRECT 0x6 /* Told to use different route */ 252#define RTM_MISS 0x7 /* Lookup failed on this address */ 253#define RTM_LOCK 0x8 /* fix specified metrics */ 254#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 255#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 256#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 257#define RTM_NEWADDR 0xc /* address being added to iface */ 258#define RTM_DELADDR 0xd /* address being removed from iface */ 259#define RTM_IFINFO 0xe /* iface going up/down etc. */ 260#define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ 261#define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ 262#define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */ 263#define RTM_IEEE80211 0x12 /* IEEE80211 wireless event */ 264 265/* 266 * Bitmask values for rtm_inits and rmx_locks. 267 */ 268#define RTV_MTU 0x1 /* init or lock _mtu */ 269#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 270#define RTV_EXPIRE 0x4 /* init or lock _expire */ 271#define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 272#define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 273#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 274#define RTV_RTT 0x40 /* init or lock _rtt */ 275#define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 276#define RTV_WEIGHT 0x100 /* init or lock _weight */ 277 278/* 279 * Bitmask values for rtm_addrs. 280 */ 281#define RTA_DST 0x1 /* destination sockaddr present */ 282#define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 283#define RTA_NETMASK 0x4 /* netmask sockaddr present */ 284#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 285#define RTA_IFP 0x10 /* interface name sockaddr present */ 286#define RTA_IFA 0x20 /* interface addr sockaddr present */ 287#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 288#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 289 290/* 291 * Index offsets for sockaddr array for alternate internal encoding. 292 */ 293#define RTAX_DST 0 /* destination sockaddr present */ 294#define RTAX_GATEWAY 1 /* gateway sockaddr present */ 295#define RTAX_NETMASK 2 /* netmask sockaddr present */ 296#define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 297#define RTAX_IFP 4 /* interface name sockaddr present */ 298#define RTAX_IFA 5 /* interface addr sockaddr present */ 299#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 300#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 301#define RTAX_MAX 8 /* size of array to allocate */ 302 303struct rt_addrinfo { 304 int rti_addrs; 305 struct sockaddr *rti_info[RTAX_MAX]; 306 int rti_flags; 307 struct ifaddr *rti_ifa; 308 struct ifnet *rti_ifp; 309}; 310 311/* 312 * This macro returns the size of a struct sockaddr when passed 313 * through a routing socket. Basically we round up sa_len to 314 * a multiple of sizeof(long), with a minimum of sizeof(long). 315 * The check for a NULL pointer is just a convenience, probably never used. 316 * The case sa_len == 0 should only apply to empty structures. 317 */ 318#define SA_SIZE(sa) \ 319 ( (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ? \ 320 sizeof(long) : \ 321 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) ) 322 323#ifdef _KERNEL 324 325#define RT_LINK_IS_UP(ifp) (!((ifp)->if_capabilities & IFCAP_LINKSTATE) \ 326 || (ifp)->if_link_state == LINK_STATE_UP) 327 328#define RT_LOCK_INIT(_rt) \ 329 mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK) 330#define RT_LOCK(_rt) mtx_lock(&(_rt)->rt_mtx) 331#define RT_UNLOCK(_rt) mtx_unlock(&(_rt)->rt_mtx) 332#define RT_LOCK_DESTROY(_rt) mtx_destroy(&(_rt)->rt_mtx) 333#define RT_LOCK_ASSERT(_rt) mtx_assert(&(_rt)->rt_mtx, MA_OWNED) 334 335#define RT_ADDREF(_rt) do { \ 336 RT_LOCK_ASSERT(_rt); \ 337 KASSERT((_rt)->rt_refcnt >= 0, \ 338 ("negative refcnt %d", (_rt)->rt_refcnt)); \ 339 (_rt)->rt_refcnt++; \ 340} while (0) 341 342#define RT_REMREF(_rt) do { \ 343 RT_LOCK_ASSERT(_rt); \ 344 KASSERT((_rt)->rt_refcnt > 0, \ 345 ("bogus refcnt %d", (_rt)->rt_refcnt)); \ 346 (_rt)->rt_refcnt--; \ 347} while (0) 348 349#define RTFREE_LOCKED(_rt) do { \ 350 if ((_rt)->rt_refcnt <= 1) \ 351 rtfree(_rt); \ 352 else { \ 353 RT_REMREF(_rt); \ 354 RT_UNLOCK(_rt); \ 355 } \ 356 /* guard against invalid refs */ \ 357 _rt = 0; \ 358} while (0) 359 360#define RTFREE(_rt) do { \ 361 RT_LOCK(_rt); \ 362 RTFREE_LOCKED(_rt); \ 363} while (0) 364 365struct radix_node_head *rt_tables_get_rnh(int, int); 366 367struct ifmultiaddr; 368 369void rt_ieee80211msg(struct ifnet *, int, void *, size_t); 370void rt_ifannouncemsg(struct ifnet *, int); 371void rt_ifmsg(struct ifnet *); 372void rt_missmsg(int, struct rt_addrinfo *, int, int); 373void rt_missmsg_fib(int, struct rt_addrinfo *, int, int, int); 374void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *); 375void rt_newaddrmsg_fib(int, struct ifaddr *, int, struct rtentry *, int); 376void rt_newmaddrmsg(int, struct ifmultiaddr *); 377int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *); 378void rt_maskedcopy(struct sockaddr *, struct sockaddr *, struct sockaddr *); 379 380/* 381 * Note the following locking behavior: 382 * 383 * rtalloc_ign() and rtalloc() return ro->ro_rt unlocked 384 * 385 * rtalloc1() returns a locked rtentry 386 * 387 * rtfree() and RTFREE_LOCKED() require a locked rtentry 388 * 389 * RTFREE() uses an unlocked entry. 390 */ 391 392int rtexpunge(struct rtentry *); 393void rtfree(struct rtentry *); 394int rt_check(struct rtentry **, struct rtentry **, struct sockaddr *); 395 396/* XXX MRT COMPAT VERSIONS THAT SET UNIVERSE to 0 */ 397/* Thes are used by old code not yet converted to use multiple FIBS */ 398int rt_getifa(struct rt_addrinfo *); 399void rtalloc_ign(struct route *ro, u_long ignflags); 400void rtalloc(struct route *ro); /* XXX deprecated, use rtalloc_ign(ro, 0) */ 401struct rtentry *rtalloc1(struct sockaddr *, int, u_long); 402int rtinit(struct ifaddr *, int, int); 403int rtioctl(u_long, caddr_t); 404void rtredirect(struct sockaddr *, struct sockaddr *, 405 struct sockaddr *, int, struct sockaddr *); 406int rtrequest(int, struct sockaddr *, 407 struct sockaddr *, struct sockaddr *, int, struct rtentry **); 408 409#ifndef BURN_BRIDGES 410/* defaults to "all" FIBs */ 411int rtinit_fib(struct ifaddr *, int, int); 412#endif 413 414/* XXX MRT NEW VERSIONS THAT USE FIBs 415 * For now the protocol indepedent versions are the same as the AF_INET ones 416 * but this will change.. 417 */ 418int rt_getifa_fib(struct rt_addrinfo *, u_int fibnum); 419void rtalloc_ign_fib(struct route *ro, u_long ignflags, u_int fibnum); 420void rtalloc_fib(struct route *ro, u_int fibnum); 421struct rtentry *rtalloc1_fib(struct sockaddr *, int, u_long, u_int); 422int rtioctl_fib(u_long, caddr_t, u_int); 423void rtredirect_fib(struct sockaddr *, struct sockaddr *, 424 struct sockaddr *, int, struct sockaddr *, u_int); 425int rtrequest_fib(int, struct sockaddr *, 426 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int); 427int rtrequest1_fib(int, struct rt_addrinfo *, struct rtentry **, u_int); 428 429#include <sys/eventhandler.h> 430typedef void (*rtevent_arp_update_fn)(void *, struct rtentry *, uint8_t *, struct sockaddr *); 431typedef void (*rtevent_redirect_fn)(void *, struct rtentry *, struct rtentry *, struct sockaddr *); 432/* route_arp_update_event is no longer generated; see arp_update_event */ 433EVENTHANDLER_DECLARE(route_arp_update_event, rtevent_arp_update_fn); 434EVENTHANDLER_DECLARE(route_redirect_event, rtevent_redirect_fn); 435#endif 436 437#endif 438