1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1980, 1986, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)route.h 8.4 (Berkeley) 1/9/95 32 * $FreeBSD$ 33 */ 34 35 #ifndef _NET_ROUTE_H_ 36 #define _NET_ROUTE_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 * Struct route consiste of a destination address, 47 * a route entry pointer, link-layer prepend data pointer along 48 * with its length. 49 */ 50 struct route { 51 struct nhop_object *ro_nh; 52 struct llentry *ro_lle; 53 /* 54 * ro_prepend and ro_plen are only used for bpf to pass in a 55 * preformed header. They are not cacheable. 56 */ 57 char *ro_prepend; 58 uint16_t ro_plen; 59 uint16_t ro_flags; 60 uint16_t ro_mtu; /* saved ro_rt mtu */ 61 uint16_t spare; 62 struct sockaddr ro_dst; 63 }; 64 65 #define RT_L2_ME_BIT 2 /* dst L2 addr is our address */ 66 #define RT_MAY_LOOP_BIT 3 /* dst may require loop copy */ 67 #define RT_HAS_HEADER_BIT 4 /* mbuf already have its header prepended */ 68 69 #define RT_L2_ME (1 << RT_L2_ME_BIT) /* 0x0004 */ 70 #define RT_MAY_LOOP (1 << RT_MAY_LOOP_BIT) /* 0x0008 */ 71 #define RT_HAS_HEADER (1 << RT_HAS_HEADER_BIT) /* 0x0010 */ 72 73 #define RT_REJECT 0x0020 /* Destination is reject */ 74 #define RT_BLACKHOLE 0x0040 /* Destination is blackhole */ 75 #define RT_HAS_GW 0x0080 /* Destination has GW */ 76 #define RT_LLE_CACHE 0x0100 /* Cache link layer */ 77 78 struct rt_metrics { 79 u_long rmx_locks; /* Kernel must leave these values alone */ 80 u_long rmx_mtu; /* MTU for this path */ 81 u_long rmx_hopcount; /* max hops expected */ 82 u_long rmx_expire; /* lifetime for route, e.g. redirect */ 83 u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 84 u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 85 u_long rmx_ssthresh; /* outbound gateway buffer limit */ 86 u_long rmx_rtt; /* estimated round trip time */ 87 u_long rmx_rttvar; /* estimated rtt variance */ 88 u_long rmx_pksent; /* packets sent using this route */ 89 u_long rmx_weight; /* route weight */ 90 u_long rmx_nhidx; /* route nexhop index */ 91 u_long rmx_filler[2]; /* will be used for T/TCP later */ 92 }; 93 94 /* 95 * rmx_rtt and rmx_rttvar are stored as microseconds; 96 * RTTTOPRHZ(rtt) converts to a value suitable for use 97 * by a protocol slowtimo counter. 98 */ 99 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 100 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 101 102 /* lle state is exported in rmx_state rt_metrics field */ 103 #define rmx_state rmx_weight 104 105 /* default route weight */ 106 #define RT_DEFAULT_WEIGHT 1 107 #define RT_MAX_WEIGHT 16777215 /* 3 bytes */ 108 109 /* 110 * Keep a generation count of routing table, incremented on route addition, 111 * so we can invalidate caches. This is accessed without a lock, as precision 112 * is not required. 113 */ 114 typedef volatile u_int rt_gen_t; /* tree generation (for adds) */ 115 #define RT_GEN(fibnum, af) rt_tables_get_gen(fibnum, af) 116 117 #define RT_DEFAULT_FIB 0 /* Explicitly mark fib=0 restricted cases */ 118 #define RT_ALL_FIBS -1 /* Announce event for every fib */ 119 #ifdef _KERNEL 120 VNET_DECLARE(uint32_t, _rt_numfibs); /* number of existing route tables */ 121 #define V_rt_numfibs VNET(_rt_numfibs) 122 /* temporary compat arg */ 123 #define rt_numfibs V_rt_numfibs 124 VNET_DECLARE(u_int, rt_add_addr_allfibs); /* Announce interfaces to all fibs */ 125 #define V_rt_add_addr_allfibs VNET(rt_add_addr_allfibs) 126 127 /* Calculate flowid for locally-originated packets */ 128 #define V_fib_hash_outbound VNET(fib_hash_outbound) 129 VNET_DECLARE(u_int, fib_hash_outbound); 130 131 /* Outbound flowid generation rules */ 132 #ifdef RSS 133 134 #define fib4_calc_packet_hash xps_proto_software_hash_v4 135 #define fib6_calc_packet_hash xps_proto_software_hash_v6 136 #define CALC_FLOWID_OUTBOUND_SENDTO true 137 138 #ifdef ROUTE_MPATH 139 #define CALC_FLOWID_OUTBOUND V_fib_hash_outbound 140 #else 141 #define CALC_FLOWID_OUTBOUND false 142 #endif 143 144 #else /* !RSS */ 145 146 #define fib4_calc_packet_hash fib4_calc_software_hash 147 #define fib6_calc_packet_hash fib6_calc_software_hash 148 149 #ifdef ROUTE_MPATH 150 #define CALC_FLOWID_OUTBOUND_SENDTO V_fib_hash_outbound 151 #define CALC_FLOWID_OUTBOUND V_fib_hash_outbound 152 #else 153 #define CALC_FLOWID_OUTBOUND_SENDTO false 154 #define CALC_FLOWID_OUTBOUND false 155 #endif 156 157 #endif /* RSS */ 158 159 160 #endif /* _KERNEL */ 161 162 /* 163 * We distinguish between routes to hosts and routes to networks, 164 * preferring the former if available. For each route we infer 165 * the interface to use from the gateway address supplied when 166 * the route was entered. Routes that forward packets through 167 * gateways are marked so that the output routines know to address the 168 * gateway rather than the ultimate destination. 169 */ 170 #define RTF_UP 0x1 /* route usable */ 171 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 172 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 173 #define RTF_REJECT 0x8 /* host or net unreachable */ 174 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 175 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 176 #define RTF_DONE 0x40 /* message confirmed */ 177 /* 0x80 unused, was RTF_DELCLONE */ 178 /* 0x100 unused, was RTF_CLONING */ 179 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 180 #define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward 181 compatibility */ 182 #define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */ 183 #define RTF_STATIC 0x800 /* manually added */ 184 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 185 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 186 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 187 /* 0x10000 unused, was RTF_PRCLONING */ 188 /* 0x20000 unused, was RTF_WASCLONED */ 189 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 190 #define RTF_FIXEDMTU 0x80000 /* MTU was explicitly specified */ 191 #define RTF_PINNED 0x100000 /* route is immutable */ 192 #define RTF_LOCAL 0x200000 /* route represents a local address */ 193 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 194 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 195 /* 0x8000000 and up unassigned */ 196 #define RTF_STICKY 0x10000000 /* always route dst->src */ 197 198 #define RTF_RNH_LOCKED 0x40000000 /* radix node head is locked */ 199 200 #define RTF_GWFLAG_COMPAT 0x80000000 /* a compatibility bit for interacting 201 with existing routing apps */ 202 203 /* Mask of RTF flags that are allowed to be modified by RTM_CHANGE. */ 204 #define RTF_FMASK \ 205 (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \ 206 RTF_REJECT | RTF_STATIC | RTF_STICKY) 207 208 /* 209 * fib_ nexthop API flags. 210 */ 211 212 /* Consumer-visible nexthop info flags */ 213 #define NHF_MULTIPATH 0x0008 /* Nexhop is a nexthop group */ 214 #define NHF_REJECT 0x0010 /* RTF_REJECT */ 215 #define NHF_BLACKHOLE 0x0020 /* RTF_BLACKHOLE */ 216 #define NHF_REDIRECT 0x0040 /* RTF_DYNAMIC|RTF_MODIFIED */ 217 #define NHF_DEFAULT 0x0080 /* Default route */ 218 #define NHF_BROADCAST 0x0100 /* RTF_BROADCAST */ 219 #define NHF_GATEWAY 0x0200 /* RTF_GATEWAY */ 220 #define NHF_HOST 0x0400 /* RTF_HOST */ 221 222 /* Nexthop request flags */ 223 #define NHR_NONE 0x00 /* empty flags field */ 224 #define NHR_REF 0x01 /* reference nexhop */ 225 #define NHR_NODEFAULT 0x02 /* uRPF: do not consider default route */ 226 227 /* Control plane route request flags */ 228 #define NHR_COPY 0x100 /* Copy rte data */ 229 #define NHR_UNLOCKED 0x200 /* Do not lock table */ 230 231 /* 232 * Routing statistics. 233 */ 234 struct rtstat { 235 uint64_t rts_badredirect; /* bogus redirect calls */ 236 uint64_t rts_dynamic; /* routes created by redirects */ 237 uint64_t rts_newgateway; /* routes modified by redirects */ 238 uint64_t rts_unreach; /* lookups which failed */ 239 uint64_t rts_wildcard; /* lookups satisfied by a wildcard */ 240 uint64_t rts_nh_idx_alloc_failure; /* nexthop index alloc failure*/ 241 uint64_t rts_nh_alloc_failure; /* nexthop allocation failure*/ 242 uint64_t rts_add_failure; /* # of route addition failures */ 243 uint64_t rts_add_retry; /* # of route addition retries */ 244 uint64_t rts_del_failure; /* # of route deletion failure */ 245 uint64_t rts_del_retry; /* # of route deletion retries */ 246 }; 247 248 /* 249 * Structures for routing messages. 250 */ 251 struct rt_msghdr { 252 u_short rtm_msglen; /* to skip over non-understood messages */ 253 u_char rtm_version; /* future binary compatibility */ 254 u_char rtm_type; /* message type */ 255 u_short rtm_index; /* index for associated ifp */ 256 u_short _rtm_spare1; 257 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 258 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 259 pid_t rtm_pid; /* identify sender */ 260 int rtm_seq; /* for sender to identify action */ 261 int rtm_errno; /* why failed */ 262 int rtm_fmask; /* bitmask used in RTM_CHANGE message */ 263 u_long rtm_inits; /* which metrics we are initializing */ 264 struct rt_metrics rtm_rmx; /* metrics themselves */ 265 }; 266 267 #define RTM_VERSION 5 /* Up the ante and ignore older versions */ 268 269 /* 270 * Message types. 271 * 272 * The format for each message is annotated below using the following 273 * identifiers: 274 * 275 * (1) struct rt_msghdr 276 * (2) struct ifa_msghdr 277 * (3) struct if_msghdr 278 * (4) struct ifma_msghdr 279 * (5) struct if_announcemsghdr 280 * 281 */ 282 #define RTM_ADD 0x1 /* (1) Add Route */ 283 #define RTM_DELETE 0x2 /* (1) Delete Route */ 284 #define RTM_CHANGE 0x3 /* (1) Change Metrics or flags */ 285 #define RTM_GET 0x4 /* (1) Report Metrics */ 286 #define RTM_LOSING 0x5 /* (1) Kernel Suspects Partitioning */ 287 #define RTM_REDIRECT 0x6 /* (1) Told to use different route */ 288 #define RTM_MISS 0x7 /* (1) Lookup failed on this address */ 289 #define RTM_LOCK 0x8 /* (1) fix specified metrics */ 290 /* 0x9 */ 291 /* 0xa */ 292 #define RTM_RESOLVE 0xb /* (1) req to resolve dst to LL addr */ 293 #define RTM_NEWADDR 0xc /* (2) address being added to iface */ 294 #define RTM_DELADDR 0xd /* (2) address being removed from iface */ 295 #define RTM_IFINFO 0xe /* (3) iface going up/down etc. */ 296 #define RTM_NEWMADDR 0xf /* (4) mcast group membership being added to if */ 297 #define RTM_DELMADDR 0x10 /* (4) mcast group membership being deleted */ 298 #define RTM_IFANNOUNCE 0x11 /* (5) iface arrival/departure */ 299 #define RTM_IEEE80211 0x12 /* (5) IEEE80211 wireless event */ 300 301 /* 302 * Bitmask values for rtm_inits and rmx_locks. 303 */ 304 #define RTV_MTU 0x1 /* init or lock _mtu */ 305 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 306 #define RTV_EXPIRE 0x4 /* init or lock _expire */ 307 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 308 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 309 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 310 #define RTV_RTT 0x40 /* init or lock _rtt */ 311 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 312 #define RTV_WEIGHT 0x100 /* init or lock _weight */ 313 314 /* 315 * Bitmask values for rtm_addrs. 316 */ 317 #define RTA_DST 0x1 /* destination sockaddr present */ 318 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 319 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 320 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 321 #define RTA_IFP 0x10 /* interface name sockaddr present */ 322 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 323 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 324 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 325 326 /* 327 * Index offsets for sockaddr array for alternate internal encoding. 328 */ 329 #define RTAX_DST 0 /* destination sockaddr present */ 330 #define RTAX_GATEWAY 1 /* gateway sockaddr present */ 331 #define RTAX_NETMASK 2 /* netmask sockaddr present */ 332 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 333 #define RTAX_IFP 4 /* interface name sockaddr present */ 334 #define RTAX_IFA 5 /* interface addr sockaddr present */ 335 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 336 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 337 #define RTAX_MAX 8 /* size of array to allocate */ 338 339 struct rtentry; 340 struct nhop_object; 341 typedef int rib_filter_f_t(const struct rtentry *, const struct nhop_object *, 342 void *); 343 344 struct rt_addrinfo { 345 int rti_addrs; /* Route RTF_ flags */ 346 int rti_flags; /* Route RTF_ flags */ 347 struct sockaddr *rti_info[RTAX_MAX]; /* Sockaddr data */ 348 struct ifaddr *rti_ifa; /* value of rt_ifa addr */ 349 struct ifnet *rti_ifp; /* route interface */ 350 rib_filter_f_t *rti_filter; /* filter function */ 351 void *rti_filterdata; /* filter paramenters */ 352 u_long rti_mflags; /* metrics RTV_ flags */ 353 u_long rti_spare; /* Will be used for fib */ 354 struct rt_metrics *rti_rmx; /* Pointer to route metrics */ 355 }; 356 357 /* 358 * This macro returns the size of a struct sockaddr when passed 359 * through a routing socket. Basically we round up sa_len to 360 * a multiple of sizeof(long), with a minimum of sizeof(long). 361 * The case sa_len == 0 should only apply to empty structures. 362 */ 363 #define SA_SIZE(sa) \ 364 ( (((struct sockaddr *)(sa))->sa_len == 0) ? \ 365 sizeof(long) : \ 366 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) ) 367 368 #define sa_equal(a, b) ( \ 369 (((const struct sockaddr *)(a))->sa_len == ((const struct sockaddr *)(b))->sa_len) && \ 370 (bcmp((a), (b), ((const struct sockaddr *)(b))->sa_len) == 0)) 371 372 #ifdef _KERNEL 373 374 #define RT_LINK_IS_UP(ifp) (!((ifp)->if_capabilities & IFCAP_LINKSTATE) \ 375 || (ifp)->if_link_state == LINK_STATE_UP) 376 377 #define RO_NHFREE(_ro) do { \ 378 if ((_ro)->ro_nh) { \ 379 NH_FREE((_ro)->ro_nh); \ 380 (_ro)->ro_nh = NULL; \ 381 } \ 382 } while (0) 383 384 #define RO_INVALIDATE_CACHE(ro) do { \ 385 if ((ro)->ro_lle != NULL) { \ 386 LLE_FREE((ro)->ro_lle); \ 387 (ro)->ro_lle = NULL; \ 388 } \ 389 if ((ro)->ro_nh != NULL) { \ 390 NH_FREE((ro)->ro_nh); \ 391 (ro)->ro_nh = NULL; \ 392 } \ 393 } while (0) 394 395 /* 396 * Validate a cached route based on a supplied cookie. If there is an 397 * out-of-date cache, simply free it. Update the generation number 398 * for the new allocation 399 */ 400 #define NH_VALIDATE(ro, cookiep, fibnum) do { \ 401 rt_gen_t cookie = RT_GEN(fibnum, (ro)->ro_dst.sa_family); \ 402 if (*(cookiep) != cookie) { \ 403 RO_INVALIDATE_CACHE(ro); \ 404 *(cookiep) = cookie; \ 405 } \ 406 } while (0) 407 408 struct ifmultiaddr; 409 struct rib_head; 410 411 void rt_ieee80211msg(struct ifnet *, int, void *, size_t); 412 void rt_ifannouncemsg(struct ifnet *, int); 413 void rt_ifmsg(struct ifnet *); 414 void rt_missmsg(int, struct rt_addrinfo *, int, int); 415 void rt_missmsg_fib(int, struct rt_addrinfo *, int, int, int); 416 int rt_addrmsg(int, struct ifaddr *, int); 417 int rt_routemsg(int, struct rtentry *, struct nhop_object *, int); 418 int rt_routemsg_info(int, struct rt_addrinfo *, int); 419 void rt_newmaddrmsg(int, struct ifmultiaddr *); 420 void rt_maskedcopy(struct sockaddr *, struct sockaddr *, struct sockaddr *); 421 struct rib_head *rt_table_init(int, int, u_int); 422 void rt_table_destroy(struct rib_head *); 423 u_int rt_tables_get_gen(uint32_t table, sa_family_t family); 424 425 struct sockaddr *rtsock_fix_netmask(const struct sockaddr *dst, 426 const struct sockaddr *smask, struct sockaddr_storage *dmask); 427 428 void rt_updatemtu(struct ifnet *); 429 430 void rt_flushifroutes(struct ifnet *ifp); 431 432 /* XXX MRT NEW VERSIONS THAT USE FIBs 433 * For now the protocol indepedent versions are the same as the AF_INET ones 434 * but this will change.. 435 */ 436 int rtioctl_fib(u_long, caddr_t, u_int); 437 int rib_lookup_info(uint32_t, const struct sockaddr *, uint32_t, uint32_t, 438 struct rt_addrinfo *); 439 void rib_free_info(struct rt_addrinfo *info); 440 441 /* New API */ 442 void rib_flush_routes_family(int family); 443 struct nhop_object *rib_lookup(uint32_t fibnum, const struct sockaddr *dst, 444 uint32_t flags, uint32_t flowid); 445 #endif 446 447 #endif 448