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