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