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 #include <net/vnet.h> 39 40 /* 41 * Kernel resident routing tables. 42 * 43 * The routing tables are initialized when interface addresses 44 * are set by making entries for all directly connected interfaces. 45 */ 46 47 /* 48 * Struct route consiste of a destination address, 49 * a route entry pointer, link-layer prepend data pointer along 50 * with its length. 51 */ 52 struct route { 53 struct nhop_object *ro_nh; 54 struct llentry *ro_lle; 55 /* 56 * ro_prepend and ro_plen are only used for bpf to pass in a 57 * preformed header. They are not cacheable. 58 */ 59 char *ro_prepend; 60 uint16_t ro_plen; 61 uint16_t ro_flags; 62 uint16_t ro_mtu; /* saved ro_rt mtu */ 63 uint16_t spare; 64 struct sockaddr ro_dst; 65 }; 66 67 #define RT_L2_ME_BIT 2 /* dst L2 addr is our address */ 68 #define RT_MAY_LOOP_BIT 3 /* dst may require loop copy */ 69 #define RT_HAS_HEADER_BIT 4 /* mbuf already have its header prepended */ 70 71 #define RT_L2_ME (1 << RT_L2_ME_BIT) /* 0x0004 */ 72 #define RT_MAY_LOOP (1 << RT_MAY_LOOP_BIT) /* 0x0008 */ 73 #define RT_HAS_HEADER (1 << RT_HAS_HEADER_BIT) /* 0x0010 */ 74 75 #define RT_REJECT 0x0020 /* Destination is reject */ 76 #define RT_BLACKHOLE 0x0040 /* Destination is blackhole */ 77 #define RT_HAS_GW 0x0080 /* Destination has GW */ 78 #define RT_LLE_CACHE 0x0100 /* Cache link layer */ 79 80 struct rt_metrics { 81 u_long rmx_locks; /* Kernel must leave these values alone */ 82 u_long rmx_mtu; /* MTU for this path */ 83 u_long rmx_hopcount; /* max hops expected */ 84 u_long rmx_expire; /* lifetime for route, e.g. redirect */ 85 u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 86 u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 87 u_long rmx_ssthresh; /* outbound gateway buffer limit */ 88 u_long rmx_rtt; /* estimated round trip time */ 89 u_long rmx_rttvar; /* estimated rtt variance */ 90 u_long rmx_pksent; /* packets sent using this route */ 91 u_long rmx_weight; /* route weight */ 92 u_long rmx_nhidx; /* route nexhop index */ 93 u_long rmx_filler[2]; /* will be used for T/TCP later */ 94 }; 95 96 /* 97 * rmx_rtt and rmx_rttvar are stored as microseconds; 98 * RTTTOPRHZ(rtt) converts to a value suitable for use 99 * by a protocol slowtimo counter. 100 */ 101 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 102 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 103 104 /* lle state is exported in rmx_state rt_metrics field */ 105 #define rmx_state rmx_weight 106 107 /* 108 * Keep a generation count of routing table, incremented on route addition, 109 * so we can invalidate caches. This is accessed without a lock, as precision 110 * is not required. 111 */ 112 typedef volatile u_int rt_gen_t; /* tree generation (for adds) */ 113 #define RT_GEN(fibnum, af) rt_tables_get_gen(fibnum, af) 114 115 #define RT_DEFAULT_FIB 0 /* Explicitly mark fib=0 restricted cases */ 116 #define RT_ALL_FIBS -1 /* Announce event for every fib */ 117 #ifdef _KERNEL 118 extern u_int rt_numfibs; /* number of usable routing tables */ 119 VNET_DECLARE(u_int, rt_add_addr_allfibs); /* Announce interfaces to all fibs */ 120 #define V_rt_add_addr_allfibs VNET(rt_add_addr_allfibs) 121 #endif 122 123 /* 124 * We distinguish between routes to hosts and routes to networks, 125 * preferring the former if available. For each route we infer 126 * the interface to use from the gateway address supplied when 127 * the route was entered. Routes that forward packets through 128 * gateways are marked so that the output routines know to address the 129 * gateway rather than the ultimate destination. 130 */ 131 #define RTF_UP 0x1 /* route usable */ 132 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 133 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 134 #define RTF_REJECT 0x8 /* host or net unreachable */ 135 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 136 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 137 #define RTF_DONE 0x40 /* message confirmed */ 138 /* 0x80 unused, was RTF_DELCLONE */ 139 /* 0x100 unused, was RTF_CLONING */ 140 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 141 #define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward 142 compatibility */ 143 #define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */ 144 #define RTF_STATIC 0x800 /* manually added */ 145 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 146 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 147 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 148 /* 0x10000 unused, was RTF_PRCLONING */ 149 /* 0x20000 unused, was RTF_WASCLONED */ 150 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 151 #define RTF_FIXEDMTU 0x80000 /* MTU was explicitly specified */ 152 #define RTF_PINNED 0x100000 /* route is immutable */ 153 #define RTF_LOCAL 0x200000 /* route represents a local address */ 154 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 155 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 156 /* 0x8000000 and up unassigned */ 157 #define RTF_STICKY 0x10000000 /* always route dst->src */ 158 159 #define RTF_RNH_LOCKED 0x40000000 /* radix node head is locked */ 160 161 #define RTF_GWFLAG_COMPAT 0x80000000 /* a compatibility bit for interacting 162 with existing routing apps */ 163 164 /* Mask of RTF flags that are allowed to be modified by RTM_CHANGE. */ 165 #define RTF_FMASK \ 166 (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \ 167 RTF_REJECT | RTF_STATIC | RTF_STICKY) 168 169 /* 170 * fib_ nexthop API flags. 171 */ 172 173 /* Consumer-visible nexthop info flags */ 174 #define NHF_REJECT 0x0010 /* RTF_REJECT */ 175 #define NHF_BLACKHOLE 0x0020 /* RTF_BLACKHOLE */ 176 #define NHF_REDIRECT 0x0040 /* RTF_DYNAMIC|RTF_MODIFIED */ 177 #define NHF_DEFAULT 0x0080 /* Default route */ 178 #define NHF_BROADCAST 0x0100 /* RTF_BROADCAST */ 179 #define NHF_GATEWAY 0x0200 /* RTF_GATEWAY */ 180 #define NHF_HOST 0x0400 /* RTF_HOST */ 181 182 /* Nexthop request flags */ 183 #define NHR_NONE 0x00 /* empty flags field */ 184 #define NHR_IFAIF 0x01 /* Return ifa_ifp interface */ 185 #define NHR_REF 0x02 /* For future use */ 186 187 /* uRPF */ 188 #define NHR_NODEFAULT 0x04 /* do not consider default route */ 189 190 /* Control plane route request flags */ 191 #define NHR_COPY 0x100 /* Copy rte data */ 192 193 /* 194 * Routing statistics. 195 */ 196 struct rtstat { 197 uint64_t rts_badredirect; /* bogus redirect calls */ 198 uint64_t rts_dynamic; /* routes created by redirects */ 199 uint64_t rts_newgateway; /* routes modified by redirects */ 200 uint64_t rts_unreach; /* lookups which failed */ 201 uint64_t rts_wildcard; /* lookups satisfied by a wildcard */ 202 uint64_t rts_nh_idx_alloc_failure; /* nexthop index alloc failure*/ 203 uint64_t rts_nh_alloc_failure; /* nexthop allocation failure*/ 204 }; 205 206 /* 207 * Structures for routing messages. 208 */ 209 struct rt_msghdr { 210 u_short rtm_msglen; /* to skip over non-understood messages */ 211 u_char rtm_version; /* future binary compatibility */ 212 u_char rtm_type; /* message type */ 213 u_short rtm_index; /* index for associated ifp */ 214 u_short _rtm_spare1; 215 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 216 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 217 pid_t rtm_pid; /* identify sender */ 218 int rtm_seq; /* for sender to identify action */ 219 int rtm_errno; /* why failed */ 220 int rtm_fmask; /* bitmask used in RTM_CHANGE message */ 221 u_long rtm_inits; /* which metrics we are initializing */ 222 struct rt_metrics rtm_rmx; /* metrics themselves */ 223 }; 224 225 #define RTM_VERSION 5 /* Up the ante and ignore older versions */ 226 227 /* 228 * Message types. 229 * 230 * The format for each message is annotated below using the following 231 * identifiers: 232 * 233 * (1) struct rt_msghdr 234 * (2) struct ifa_msghdr 235 * (3) struct if_msghdr 236 * (4) struct ifma_msghdr 237 * (5) struct if_announcemsghdr 238 * 239 */ 240 #define RTM_ADD 0x1 /* (1) Add Route */ 241 #define RTM_DELETE 0x2 /* (1) Delete Route */ 242 #define RTM_CHANGE 0x3 /* (1) Change Metrics or flags */ 243 #define RTM_GET 0x4 /* (1) Report Metrics */ 244 #define RTM_LOSING 0x5 /* (1) Kernel Suspects Partitioning */ 245 #define RTM_REDIRECT 0x6 /* (1) Told to use different route */ 246 #define RTM_MISS 0x7 /* (1) Lookup failed on this address */ 247 #define RTM_LOCK 0x8 /* (1) fix specified metrics */ 248 /* 0x9 */ 249 /* 0xa */ 250 #define RTM_RESOLVE 0xb /* (1) req to resolve dst to LL addr */ 251 #define RTM_NEWADDR 0xc /* (2) address being added to iface */ 252 #define RTM_DELADDR 0xd /* (2) address being removed from iface */ 253 #define RTM_IFINFO 0xe /* (3) iface going up/down etc. */ 254 #define RTM_NEWMADDR 0xf /* (4) mcast group membership being added to if */ 255 #define RTM_DELMADDR 0x10 /* (4) mcast group membership being deleted */ 256 #define RTM_IFANNOUNCE 0x11 /* (5) iface arrival/departure */ 257 #define RTM_IEEE80211 0x12 /* (5) 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 struct rtentry; 298 struct nhop_object; 299 typedef int rt_filter_f_t(const struct rtentry *, const struct nhop_object *, 300 void *); 301 302 struct rt_addrinfo { 303 int rti_addrs; /* Route RTF_ flags */ 304 int rti_flags; /* Route RTF_ flags */ 305 struct sockaddr *rti_info[RTAX_MAX]; /* Sockaddr data */ 306 struct ifaddr *rti_ifa; /* value of rt_ifa addr */ 307 struct ifnet *rti_ifp; /* route interface */ 308 rt_filter_f_t *rti_filter; /* filter function */ 309 void *rti_filterdata; /* filter paramenters */ 310 u_long rti_mflags; /* metrics RTV_ flags */ 311 u_long rti_spare; /* Will be used for fib */ 312 struct rt_metrics *rti_rmx; /* Pointer to route metrics */ 313 }; 314 315 /* 316 * This macro returns the size of a struct sockaddr when passed 317 * through a routing socket. Basically we round up sa_len to 318 * a multiple of sizeof(long), with a minimum of sizeof(long). 319 * The case sa_len == 0 should only apply to empty structures. 320 */ 321 #define SA_SIZE(sa) \ 322 ( (((struct sockaddr *)(sa))->sa_len == 0) ? \ 323 sizeof(long) : \ 324 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) ) 325 326 #define sa_equal(a, b) ( \ 327 (((const struct sockaddr *)(a))->sa_len == ((const struct sockaddr *)(b))->sa_len) && \ 328 (bcmp((a), (b), ((const struct sockaddr *)(b))->sa_len) == 0)) 329 330 #ifdef _KERNEL 331 332 #define RT_LINK_IS_UP(ifp) (!((ifp)->if_capabilities & IFCAP_LINKSTATE) \ 333 || (ifp)->if_link_state == LINK_STATE_UP) 334 335 #define RO_NHFREE(_ro) do { \ 336 if ((_ro)->ro_nh) { \ 337 NH_FREE((_ro)->ro_nh); \ 338 (_ro)->ro_nh = NULL; \ 339 } \ 340 } while (0) 341 342 #define RO_INVALIDATE_CACHE(ro) do { \ 343 if ((ro)->ro_lle != NULL) { \ 344 LLE_FREE((ro)->ro_lle); \ 345 (ro)->ro_lle = NULL; \ 346 } \ 347 if ((ro)->ro_nh != NULL) { \ 348 NH_FREE((ro)->ro_nh); \ 349 (ro)->ro_nh = NULL; \ 350 } \ 351 } while (0) 352 353 /* 354 * Validate a cached route based on a supplied cookie. If there is an 355 * out-of-date cache, simply free it. Update the generation number 356 * for the new allocation 357 */ 358 #define NH_VALIDATE(ro, cookiep, fibnum) do { \ 359 rt_gen_t cookie = RT_GEN(fibnum, (ro)->ro_dst.sa_family); \ 360 if (*(cookiep) != cookie) { \ 361 RO_INVALIDATE_CACHE(ro); \ 362 *(cookiep) = cookie; \ 363 } \ 364 } while (0) 365 366 struct ifmultiaddr; 367 struct rib_head; 368 369 void rt_ieee80211msg(struct ifnet *, int, void *, size_t); 370 void rt_ifannouncemsg(struct ifnet *, int); 371 void rt_ifmsg(struct ifnet *); 372 void rt_missmsg(int, struct rt_addrinfo *, int, int); 373 void rt_missmsg_fib(int, struct rt_addrinfo *, int, int, int); 374 void rt_newaddrmsg_fib(int, struct ifaddr *, struct rtentry *, int); 375 int rt_addrmsg(int, struct ifaddr *, int); 376 int rt_routemsg(int, struct rtentry *, struct ifnet *ifp, int, int); 377 int rt_routemsg_info(int, struct rt_addrinfo *, int); 378 void rt_newmaddrmsg(int, struct ifmultiaddr *); 379 void rt_maskedcopy(struct sockaddr *, struct sockaddr *, struct sockaddr *); 380 struct rib_head *rt_table_init(int, int, u_int); 381 void rt_table_destroy(struct rib_head *); 382 u_int rt_tables_get_gen(int table, int fam); 383 384 int rtsock_addrmsg(int, struct ifaddr *, int); 385 int rtsock_routemsg(int, struct rtentry *, struct ifnet *ifp, int, int); 386 int rtsock_routemsg_info(int, struct rt_addrinfo *, int); 387 388 struct sockaddr *rtsock_fix_netmask(const struct sockaddr *dst, 389 const struct sockaddr *smask, struct sockaddr_storage *dmask); 390 /* 391 * Note the following locking behavior: 392 * 393 * rtfree() and RTFREE_LOCKED() require a locked rtentry 394 * 395 * RTFREE() uses an unlocked entry. 396 */ 397 398 void rtfree(struct rtentry *); 399 void rtfree_func(struct rtentry *); 400 void rt_updatemtu(struct ifnet *); 401 402 void rt_flushifroutes_af(struct ifnet *, int); 403 void rt_flushifroutes(struct ifnet *ifp); 404 405 /* XXX MRT COMPAT VERSIONS THAT SET UNIVERSE to 0 */ 406 /* Thes are used by old code not yet converted to use multiple FIBS */ 407 int rtinit(struct ifaddr *, int, int); 408 409 /* XXX MRT NEW VERSIONS THAT USE FIBs 410 * For now the protocol indepedent versions are the same as the AF_INET ones 411 * but this will change.. 412 */ 413 int rtioctl_fib(u_long, caddr_t, u_int); 414 int rtrequest_fib(int, struct sockaddr *, 415 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int); 416 int rtrequest1_fib(int, struct rt_addrinfo *, struct rtentry **, u_int); 417 int rib_lookup_info(uint32_t, const struct sockaddr *, uint32_t, uint32_t, 418 struct rt_addrinfo *); 419 void rib_free_info(struct rt_addrinfo *info); 420 421 /* New API */ 422 struct nhop_object *rib_lookup(uint32_t fibnum, const struct sockaddr *dst, 423 uint32_t flags, uint32_t flowid); 424 #endif 425 426 #endif 427