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