route.h revision 183013
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: head/sys/net/route.h 183013 2008-09-14 08:19:48Z julian $ 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 and a reference 45 * to a routing entry. These are often held by protocols 46 * in their control blocks, e.g. inpcb. 47 */ 48struct route { 49 struct rtentry *ro_rt; 50 struct sockaddr ro_dst; 51}; 52 53/* 54 * These numbers are used by reliable protocols for determining 55 * retransmission behavior and are included in the routing structure. 56 */ 57struct rt_metrics_lite { 58 u_long rmx_mtu; /* MTU for this path */ 59 u_long rmx_expire; /* lifetime for route, e.g. redirect */ 60 u_long rmx_pksent; /* packets sent using this route */ 61}; 62 63struct rt_metrics { 64 u_long rmx_locks; /* Kernel must leave these values alone */ 65 u_long rmx_mtu; /* MTU for this path */ 66 u_long rmx_hopcount; /* max hops expected */ 67 u_long rmx_expire; /* lifetime for route, e.g. redirect */ 68 u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 69 u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 70 u_long rmx_ssthresh; /* outbound gateway buffer limit */ 71 u_long rmx_rtt; /* estimated round trip time */ 72 u_long rmx_rttvar; /* estimated rtt variance */ 73 u_long rmx_pksent; /* packets sent using this route */ 74 u_long rmx_filler[4]; /* will be used for T/TCP later */ 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 85extern u_int rt_numfibs; /* number fo usable routing tables */ 86extern u_int tunnel_fib; /* tunnels use these */ 87extern u_int fwd_fib; /* packets being forwarded use these routes */ 88/* 89 * XXX kernel function pointer `rt_output' is visible to applications. 90 */ 91struct mbuf; 92 93/* 94 * We distinguish between routes to hosts and routes to networks, 95 * preferring the former if available. For each route we infer 96 * the interface to use from the gateway address supplied when 97 * the route was entered. Routes that forward packets through 98 * gateways are marked so that the output routines know to address the 99 * gateway rather than the ultimate destination. 100 */ 101#ifndef RNF_NORMAL 102#include <net/radix.h> 103#ifdef RADIX_MPATH 104#include <net/radix_mpath.h> 105#endif 106#endif 107struct rtentry { 108 struct radix_node rt_nodes[2]; /* tree glue, and other values */ 109 /* 110 * XXX struct rtentry must begin with a struct radix_node (or two!) 111 * because the code does some casts of a 'struct radix_node *' 112 * to a 'struct rtentry *' 113 */ 114#define rt_key(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_key))) 115#define rt_mask(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask))) 116 struct sockaddr *rt_gateway; /* value */ 117 u_long rt_flags; /* up/down?, host/net */ 118 struct ifnet *rt_ifp; /* the answer: interface to use */ 119 struct ifaddr *rt_ifa; /* the answer: interface address to use */ 120 struct rt_metrics_lite rt_rmx; /* metrics used by rx'ing protocols */ 121 long rt_refcnt; /* # held references */ 122 struct sockaddr *rt_genmask; /* for generation of cloned routes */ 123 caddr_t rt_llinfo; /* pointer to link level info cache */ 124 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 125 struct rtentry *rt_parent; /* cloning parent of this route */ 126 u_int rt_fibnum; /* which FIB */ 127#ifdef _KERNEL 128 /* XXX ugly, user apps use this definition but don't have a mtx def */ 129 struct mtx rt_mtx; /* mutex for routing entry */ 130#endif 131}; 132 133/* 134 * Following structure necessary for 4.3 compatibility; 135 * We should eventually move it to a compat file. 136 */ 137struct ortentry { 138 u_long rt_hash; /* to speed lookups */ 139 struct sockaddr rt_dst; /* key */ 140 struct sockaddr rt_gateway; /* value */ 141 short rt_flags; /* up/down?, host/net */ 142 short rt_refcnt; /* # held references */ 143 u_long rt_use; /* raw # packets forwarded */ 144 struct ifnet *rt_ifp; /* the answer: interface to use */ 145}; 146 147#define rt_use rt_rmx.rmx_pksent 148 149#define RTF_UP 0x1 /* route usable */ 150#define RTF_GATEWAY 0x2 /* destination is a gateway */ 151#define RTF_HOST 0x4 /* host entry (net otherwise) */ 152#define RTF_REJECT 0x8 /* host or net unreachable */ 153#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 154#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 155#define RTF_DONE 0x40 /* message confirmed */ 156/* 0x80 unused, was RTF_DELCLONE */ 157#define RTF_CLONING 0x100 /* generate new routes on use */ 158#define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 159#define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */ 160#define RTF_STATIC 0x800 /* manually added */ 161#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 162#define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 163#define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 164 165/* XXX: temporary to stay API/ABI compatible with userland */ 166#ifndef _KERNEL 167#define RTF_PRCLONING 0x10000 /* unused, for compatibility */ 168#endif 169 170#define RTF_WASCLONED 0x20000 /* route generated through cloning */ 171#define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 172/* 0x80000 unused */ 173#define RTF_PINNED 0x100000 /* future use */ 174#define RTF_LOCAL 0x200000 /* route represents a local address */ 175#define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 176#define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 177 /* 0x1000000 and up unassigned */ 178 179/* Mask of RTF flags that are allowed to be modified by RTM_CHANGE. */ 180#define RTF_FMASK \ 181 (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \ 182 RTF_REJECT | RTF_STATIC) 183 184/* 185 * Routing statistics. 186 */ 187struct rtstat { 188 short rts_badredirect; /* bogus redirect calls */ 189 short rts_dynamic; /* routes created by redirects */ 190 short rts_newgateway; /* routes modified by redirects */ 191 short rts_unreach; /* lookups which failed */ 192 short rts_wildcard; /* lookups satisfied by a wildcard */ 193}; 194/* 195 * Structures for routing messages. 196 */ 197struct rt_msghdr { 198 u_short rtm_msglen; /* to skip over non-understood messages */ 199 u_char rtm_version; /* future binary compatibility */ 200 u_char rtm_type; /* message type */ 201 u_short rtm_index; /* index for associated ifp */ 202 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 203 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 204 pid_t rtm_pid; /* identify sender */ 205 int rtm_seq; /* for sender to identify action */ 206 int rtm_errno; /* why failed */ 207 int rtm_fmask; /* bitmask used in RTM_CHANGE message */ 208#define rtm_use rtm_fmask /* deprecated, use rtm_rmx->rmx_pksent */ 209 u_long rtm_inits; /* which metrics we are initializing */ 210 struct rt_metrics rtm_rmx; /* metrics themselves */ 211}; 212 213#define RTM_VERSION 5 /* Up the ante and ignore older versions */ 214 215/* 216 * Message types. 217 */ 218#define RTM_ADD 0x1 /* Add Route */ 219#define RTM_DELETE 0x2 /* Delete Route */ 220#define RTM_CHANGE 0x3 /* Change Metrics or flags */ 221#define RTM_GET 0x4 /* Report Metrics */ 222#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 223#define RTM_REDIRECT 0x6 /* Told to use different route */ 224#define RTM_MISS 0x7 /* Lookup failed on this address */ 225#define RTM_LOCK 0x8 /* fix specified metrics */ 226#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 227#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 228#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 229#define RTM_NEWADDR 0xc /* address being added to iface */ 230#define RTM_DELADDR 0xd /* address being removed from iface */ 231#define RTM_IFINFO 0xe /* iface going up/down etc. */ 232#define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ 233#define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ 234#define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */ 235#define RTM_IEEE80211 0x12 /* IEEE80211 wireless event */ 236 237/* 238 * Bitmask values for rtm_inits and rmx_locks. 239 */ 240#define RTV_MTU 0x1 /* init or lock _mtu */ 241#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 242#define RTV_EXPIRE 0x4 /* init or lock _expire */ 243#define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 244#define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 245#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 246#define RTV_RTT 0x40 /* init or lock _rtt */ 247#define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 248 249/* 250 * Bitmask values for rtm_addrs. 251 */ 252#define RTA_DST 0x1 /* destination sockaddr present */ 253#define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 254#define RTA_NETMASK 0x4 /* netmask sockaddr present */ 255#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 256#define RTA_IFP 0x10 /* interface name sockaddr present */ 257#define RTA_IFA 0x20 /* interface addr sockaddr present */ 258#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 259#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 260 261/* 262 * Index offsets for sockaddr array for alternate internal encoding. 263 */ 264#define RTAX_DST 0 /* destination sockaddr present */ 265#define RTAX_GATEWAY 1 /* gateway sockaddr present */ 266#define RTAX_NETMASK 2 /* netmask sockaddr present */ 267#define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 268#define RTAX_IFP 4 /* interface name sockaddr present */ 269#define RTAX_IFA 5 /* interface addr sockaddr present */ 270#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 271#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 272#define RTAX_MAX 8 /* size of array to allocate */ 273 274struct rt_addrinfo { 275 int rti_addrs; 276 struct sockaddr *rti_info[RTAX_MAX]; 277 int rti_flags; 278 struct ifaddr *rti_ifa; 279 struct ifnet *rti_ifp; 280}; 281 282/* 283 * This macro returns the size of a struct sockaddr when passed 284 * through a routing socket. Basically we round up sa_len to 285 * a multiple of sizeof(long), with a minimum of sizeof(long). 286 * The check for a NULL pointer is just a convenience, probably never used. 287 * The case sa_len == 0 should only apply to empty structures. 288 */ 289#define SA_SIZE(sa) \ 290 ( (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ? \ 291 sizeof(long) : \ 292 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) ) 293 294#ifdef _KERNEL 295 296#define RT_LOCK_INIT(_rt) \ 297 mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK) 298#define RT_LOCK(_rt) mtx_lock(&(_rt)->rt_mtx) 299#define RT_TRYLOCK(_rt) mtx_trylock(&(_rt)->rt_mtx) 300#define RT_UNLOCK(_rt) mtx_unlock(&(_rt)->rt_mtx) 301#define RT_LOCK_DESTROY(_rt) mtx_destroy(&(_rt)->rt_mtx) 302#define RT_LOCK_ASSERT(_rt) mtx_assert(&(_rt)->rt_mtx, MA_OWNED) 303 304#define RT_ADDREF(_rt) do { \ 305 RT_LOCK_ASSERT(_rt); \ 306 KASSERT((_rt)->rt_refcnt >= 0, \ 307 ("negative refcnt %ld", (_rt)->rt_refcnt)); \ 308 (_rt)->rt_refcnt++; \ 309} while (0) 310 311#define RT_REMREF(_rt) do { \ 312 RT_LOCK_ASSERT(_rt); \ 313 KASSERT((_rt)->rt_refcnt > 0, \ 314 ("bogus refcnt %ld", (_rt)->rt_refcnt)); \ 315 (_rt)->rt_refcnt--; \ 316} while (0) 317 318#define RTFREE_LOCKED(_rt) do { \ 319 if ((_rt)->rt_refcnt <= 1) \ 320 rtfree(_rt); \ 321 else { \ 322 RT_REMREF(_rt); \ 323 RT_UNLOCK(_rt); \ 324 } \ 325 /* guard against invalid refs */ \ 326 _rt = 0; \ 327 } while (0) 328 329#define RTFREE(_rt) do { \ 330 RT_LOCK(_rt); \ 331 RTFREE_LOCKED(_rt); \ 332 } while (0) 333 334extern struct radix_node_head *rt_tables[][AF_MAX+1]; 335 336struct ifmultiaddr; 337 338void rt_ieee80211msg(struct ifnet *, int, void *, size_t); 339void rt_ifannouncemsg(struct ifnet *, int); 340void rt_ifmsg(struct ifnet *); 341void rt_missmsg(int, struct rt_addrinfo *, int, int); 342void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *); 343void rt_newmaddrmsg(int, struct ifmultiaddr *); 344int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *); 345 346/* 347 * Note the following locking behavior: 348 * 349 * rtalloc_ign() and rtalloc() return ro->ro_rt unlocked 350 * 351 * rtalloc1() returns a locked rtentry 352 * 353 * rtfree() and RTFREE_LOCKED() require a locked rtentry 354 * 355 * RTFREE() uses an unlocked entry. 356 */ 357 358int rtexpunge(struct rtentry *); 359void rtfree(struct rtentry *); 360int rt_check(struct rtentry **, struct rtentry **, struct sockaddr *); 361 362/* XXX MRT COMPAT VERSIONS THAT SET UNIVERSE to 0 */ 363/* Thes are used by old code not yet converted to use multiple FIBS */ 364int rt_getifa(struct rt_addrinfo *); 365void rtalloc_ign(struct route *ro, u_long ignflags); 366void rtalloc(struct route *ro); /* XXX deprecated, use rtalloc_ign(ro, 0) */ 367struct rtentry *rtalloc1(struct sockaddr *, int, u_long); 368int rtinit(struct ifaddr *, int, int); 369int rtioctl(u_long, caddr_t); 370void rtredirect(struct sockaddr *, struct sockaddr *, 371 struct sockaddr *, int, struct sockaddr *); 372int rtrequest(int, struct sockaddr *, 373 struct sockaddr *, struct sockaddr *, int, struct rtentry **); 374int rtrequest1(int, struct rt_addrinfo *, struct rtentry **); 375 376/* defaults to "all" FIBs */ 377int rtinit_fib(struct ifaddr *, int, int); 378 379/* XXX MRT NEW VERSIONS THAT USE FIBs 380 * For now the protocol indepedent versions are the same as the AF_INET ones 381 * but this will change.. 382 */ 383int rt_getifa_fib(struct rt_addrinfo *, u_int fibnum); 384void rtalloc_ign_fib(struct route *ro, u_long ignflags, u_int fibnum); 385void rtalloc_fib(struct route *ro, u_int fibnum); 386struct rtentry *rtalloc1_fib(struct sockaddr *, int, u_long, u_int); 387int rtioctl_fib(u_long, caddr_t, u_int); 388void rtredirect_fib(struct sockaddr *, struct sockaddr *, 389 struct sockaddr *, int, struct sockaddr *, u_int); 390int rtrequest_fib(int, struct sockaddr *, 391 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int); 392int rtrequest1_fib(int, struct rt_addrinfo *, struct rtentry **, u_int); 393 394#include <sys/eventhandler.h> 395typedef void (*rtevent_arp_update_fn)(void *, struct rtentry *, uint8_t *, struct sockaddr *); 396typedef void (*rtevent_redirect_fn)(void *, struct rtentry *, struct rtentry *, struct sockaddr *); 397EVENTHANDLER_DECLARE(route_arp_update_event, rtevent_arp_update_fn); 398EVENTHANDLER_DECLARE(route_redirect_event, rtevent_redirect_fn); 399#endif 400 401#endif 402