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