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