1 /* 2 * Copyright (c) 2000-2017 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 /* 29 * Copyright (c) 1980, 1986, 1993 30 * The Regents of the University of California. All rights reserved. 31 * 32 * Redistribution and use in source and binary forms, with or without 33 * modification, are permitted provided that the following conditions 34 * are met: 35 * 1. Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * 2. Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in the 39 * documentation and/or other materials provided with the distribution. 40 * 3. All advertising materials mentioning features or use of this software 41 * must display the following acknowledgement: 42 * This product includes software developed by the University of 43 * California, Berkeley and its contributors. 44 * 4. Neither the name of the University nor the names of its contributors 45 * may be used to endorse or promote products derived from this software 46 * without specific prior written permission. 47 * 48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 58 * SUCH DAMAGE. 59 * 60 * @(#)route.h 8.3 (Berkeley) 4/19/94 61 * $FreeBSD: src/sys/net/route.h,v 1.36.2.1 2000/08/16 06:14:23 jayanth Exp $ 62 */ 63 64 #ifndef _NET_ROUTE_H_ 65 #define _NET_ROUTE_H_ 66 #include <sys/appleapiopts.h> 67 #include <stdint.h> 68 #include <sys/types.h> 69 #include <sys/socket.h> 70 71 /* 72 * These numbers are used by reliable protocols for determining 73 * retransmission behavior and are included in the routing structure. 74 */ 75 struct rt_metrics { 76 u_int32_t rmx_locks; /* Kernel leaves these values alone */ 77 u_int32_t rmx_mtu; /* MTU for this path */ 78 u_int32_t rmx_hopcount; /* max hops expected */ 79 int32_t rmx_expire; /* lifetime for route, e.g. redirect */ 80 u_int32_t rmx_recvpipe; /* inbound delay-bandwidth product */ 81 u_int32_t rmx_sendpipe; /* outbound delay-bandwidth product */ 82 u_int32_t rmx_ssthresh; /* outbound gateway buffer limit */ 83 u_int32_t rmx_rtt; /* estimated round trip time */ 84 u_int32_t rmx_rttvar; /* estimated rtt variance */ 85 u_int32_t rmx_pksent; /* packets sent using this route */ 86 u_int32_t rmx_state; /* route state */ 87 u_int32_t rmx_filler[3]; /* will be used for TCP's peer-MSS cache */ 88 }; 89 90 /* 91 * rmx_rtt and rmx_rttvar are stored as microseconds; 92 */ 93 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 94 95 #ifdef PRIVATE 96 struct route_old { 97 void *ro_rt; 98 uint32_t ro_flags; 99 struct sockaddr ro_dst; 100 }; 101 #endif /* PRIVATE */ 102 103 #ifdef BSD_KERNEL_PRIVATE 104 #include <kern/locks.h> 105 #include <net/radix.h> 106 #include <net/if_llatbl.h> 107 #include <sys/eventhandler.h> 108 #include <net/if_dl.h> 109 110 extern boolean_t trigger_v6_defrtr_select; 111 /* 112 * Kernel resident routing tables. 113 * 114 * The routing tables are initialized when interface addresses 115 * are set by making entries for all directly connected interfaces. 116 */ 117 118 /* forward declarations */ 119 struct ifnet_llreach_info; 120 struct rt_reach_info; 121 122 /* 123 * IP route structure 124 * 125 * A route consists of a destination address and a reference 126 * to a routing entry. These are often held by protocols 127 * in their control blocks, e.g. inpcb. 128 */ 129 struct route { 130 /* 131 * N.B: struct route must begin with ro_{rt, lle, srcia, flags} 132 * because the code does some casts of a 'struct route_in6 *' 133 * to a 'struct route *'. 134 */ 135 struct rtentry *ro_rt; 136 struct llentry *ro_lle; 137 138 struct ifaddr *ro_srcia; 139 uint32_t ro_flags; /* route flags (see below) */ 140 struct sockaddr ro_dst; 141 }; 142 143 #define ROF_SRCIF_SELECTED 0x0001 /* source interface was selected */ 144 #if 0 145 /* XXX These will be used in the changes coming in later */ 146 #define ROF_NORTREF 0x0002 /* doesn't hold reference on ro_rt */ 147 #define ROF_L2_ME 0x0004 /* dst L2 addr is our address */ 148 #define ROF_MAY_LOOP 0x0008 /* dst may require loop copy */ 149 #define ROF_HAS_HEADER 0x0010 /* mbuf already have its header prepended */ 150 #define ROF_REJECT 0x0020 /* Destination is reject */ 151 #define ROF_BLACKHOLE 0x0040 /* Destination is blackhole */ 152 #define ROF_HAS_GW 0x0080 /* Destination has GW */ 153 #endif 154 #define ROF_LLE_CACHE 0x0100 /* Cache link layer */ 155 156 #define ROUTE_UNUSABLE(_ro) \ 157 ((_ro)->ro_rt == NULL || \ 158 ((_ro)->ro_rt->rt_flags & (RTF_UP|RTF_CONDEMNED)) != RTF_UP || \ 159 RT_GENID_OUTOFSYNC((_ro)->ro_rt)) 160 161 #define _ROUTE_RELEASE_COMMON(_ro, _rnh_locked) do { \ 162 if ((_ro)->ro_rt != NULL) { \ 163 RT_LOCK_ASSERT_NOTHELD((_ro)->ro_rt); \ 164 if (_rnh_locked) \ 165 rtfree_locked((_ro)->ro_rt); \ 166 else \ 167 rtfree((_ro)->ro_rt); \ 168 (_ro)->ro_rt = NULL; \ 169 } \ 170 if ((_ro)->ro_srcia != NULL) { \ 171 IFA_REMREF((_ro)->ro_srcia); \ 172 (_ro)->ro_srcia = NULL; \ 173 (_ro)->ro_flags &= ~ROF_SRCIF_SELECTED; \ 174 } \ 175 if ((_ro)->ro_lle != NULL) { \ 176 LLE_REMREF((_ro)->ro_lle); \ 177 (_ro)->ro_lle = NULL; \ 178 (_ro)->ro_flags &= ~ROF_LLE_CACHE; \ 179 } \ 180 } while (0) 181 182 #define ROUTE_RELEASE_LOCKED(_ro) _ROUTE_RELEASE_COMMON(_ro, TRUE) 183 #define ROUTE_RELEASE(_ro) _ROUTE_RELEASE_COMMON(_ro, FALSE) 184 185 /* 186 * We distinguish between routes to hosts and routes to networks, 187 * preferring the former if available. For each route we infer 188 * the interface to use from the gateway address supplied when 189 * the route was entered. Routes that forward packets through 190 * gateways are marked so that the output routines know to address the 191 * gateway rather than the ultimate destination. 192 */ 193 194 #define NRTT_HIST 10 195 /* 196 * Kernel routing entry structure. 197 */ 198 struct rtentry { 199 struct radix_node rt_nodes[2]; /* tree glue, and other values */ 200 #define rt_key(r) (SA((r)->rt_nodes->rn_key)) 201 #define rt_mask(r) (SA((r)->rt_nodes->rn_mask)) 202 /* 203 * See bsd/net/route.c for synchronization notes. 204 */ 205 decl_lck_mtx_data(, rt_lock); /* lock for routing entry */ 206 uint32_t rt_refcnt; /* # held references */ 207 uint32_t rt_flags; /* up/down?, host/net */ 208 uint32_t rt_genid; /* route generation id */ 209 struct sockaddr *rt_gateway; /* value */ 210 struct ifnet *rt_ifp; /* the answer: interface to use */ 211 struct ifaddr *rt_ifa; /* the answer: interface addr to use */ 212 struct sockaddr *rt_genmask; /* for generation of cloned routes */ 213 void *rt_llinfo; /* pointer to link level info cache */ 214 void (*rt_llinfo_get_ri) /* llinfo get reachability info fn */ 215 (struct rtentry *, struct rt_reach_info *); 216 void (*rt_llinfo_get_iflri) /* ifnet llinfo get reach. info fn */ 217 (struct rtentry *, struct ifnet_llreach_info *); 218 void (*rt_llinfo_purge)(struct rtentry *); /* llinfo purge fn */ 219 void (*rt_llinfo_free)(void *); /* link level info free function */ 220 void (*rt_llinfo_refresh) (struct rtentry *); /* expedite llinfo refresh */ 221 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */ 222 #define rt_use rt_rmx.rmx_pksent 223 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 224 struct rtentry *rt_parent; /* cloning parent of this route */ 225 struct nstat_counts *rt_stats; /* route stats */ 226 void (*rt_if_ref_fn)(struct ifnet *, int); /* interface ref func */ 227 228 uint32_t *rt_tree_genid; /* ptr to per-tree route_genid */ 229 uint64_t rt_expire; /* expiration time in uptime seconds */ 230 uint64_t base_calendartime; /* calendar time upon entry creation */ 231 uint64_t base_uptime; /* uptime upon entry creation */ 232 u_int32_t rtt_hist[NRTT_HIST]; /* RTT history sample by TCP connections */ 233 u_int32_t rtt_min; /* minimum RTT computed from history */ 234 u_int32_t rtt_expire_ts; /* RTT history expire timestamp */ 235 u_int8_t rtt_index; /* Index into RTT history */ 236 /* Event handler context for the rtentrt */ 237 struct eventhandler_lists_ctxt rt_evhdlr_ctxt; 238 }; 239 240 #define rt_key_free(r) \ 241 (kheap_free_addr)(KHEAP_DATA_BUFFERS, rt_key(r)) 242 243 enum { 244 ROUTE_STATUS_UPDATE = 1, 245 ROUTE_ENTRY_REFRESH, 246 ROUTE_ENTRY_DELETED, 247 ROUTE_LLENTRY_RESOLVED, 248 ROUTE_LLENTRY_UNREACH, 249 ROUTE_LLENTRY_CHANGED, 250 ROUTE_LLENTRY_STALE, 251 ROUTE_LLENTRY_TIMEDOUT, 252 ROUTE_LLENTRY_DELETED, 253 ROUTE_LLENTRY_EXPIRED, 254 ROUTE_LLENTRY_PROBED, 255 ROUTE_EVHDLR_DEREGISTER, 256 }; 257 258 extern const char * route_event2str(int route_event); 259 260 typedef void (*route_event_fn) (struct eventhandler_entry_arg, 261 struct sockaddr *, int, struct sockaddr *, int); 262 EVENTHANDLER_DECLARE(route_event, route_event_fn); 263 264 /* 265 * Synchronize route entry's generation ID with the tree's. 266 */ 267 #define RT_GENID_SYNC(_rt) do { \ 268 if ((_rt)->rt_tree_genid != NULL) \ 269 (_rt)->rt_genid = *(_rt)->rt_tree_genid; \ 270 } while (0) 271 272 /* 273 * Indicates whether or not the route entry's generation ID is stale. 274 */ 275 #define RT_GENID_OUTOFSYNC(_rt) \ 276 ((_rt)->rt_tree_genid != NULL && \ 277 *(_rt)->rt_tree_genid != (_rt)->rt_genid) 278 279 enum { 280 ROUTE_OP_READ, 281 ROUTE_OP_WRITE, 282 }; 283 284 extern int route_op_entitlement_check(struct socket *, kauth_cred_t, int, boolean_t); 285 #endif /* BSD_KERNEL_PRIVATE */ 286 287 #define RTF_UP 0x1 /* route usable */ 288 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 289 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 290 #define RTF_REJECT 0x8 /* host or net unreachable */ 291 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 292 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 293 #define RTF_DONE 0x40 /* message confirmed */ 294 #define RTF_DELCLONE 0x80 /* delete cloned route */ 295 #define RTF_CLONING 0x100 /* generate new routes on use */ 296 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 297 #define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward 298 * compatibility */ 299 #define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */ 300 #define RTF_STATIC 0x800 /* manually added */ 301 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 302 #define RTF_NOIFREF 0x2000 /* not eligible for RTF_IFREF */ 303 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 304 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 305 306 #define RTF_PRCLONING 0x10000 /* protocol requires cloning */ 307 #define RTF_WASCLONED 0x20000 /* route generated through cloning */ 308 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 309 /* 0x80000 unused */ 310 #define RTF_PINNED 0x100000 /* future use */ 311 #define RTF_LOCAL 0x200000 /* route represents a local address */ 312 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 313 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 314 #define RTF_IFSCOPE 0x1000000 /* has valid interface scope */ 315 #define RTF_CONDEMNED 0x2000000 /* defunct; no longer modifiable */ 316 #define RTF_IFREF 0x4000000 /* route holds a ref to interface */ 317 #define RTF_PROXY 0x8000000 /* proxying, no interface scope */ 318 #define RTF_ROUTER 0x10000000 /* host is a router */ 319 #define RTF_DEAD 0x20000000 /* Route entry is being freed */ 320 #define RTF_GLOBAL 0x40000000 /* route to destination of the global internet */ 321 /* 0x80000000 unassigned */ 322 323 #define RTPRF_OURS RTF_PROTO3 /* set on routes we manage */ 324 #define RTF_BITS \ 325 "\020\1UP\2GATEWAY\3HOST\4REJECT\5DYNAMIC\6MODIFIED\7DONE" \ 326 "\10DELCLONE\11CLONING\12XRESOLVE\13LLINFO\14STATIC\15BLACKHOLE" \ 327 "\16NOIFREF\17PROTO2\20PROTO1\21PRCLONING\22WASCLONED\23PROTO3" \ 328 "\25PINNED\26LOCAL\27BROADCAST\30MULTICAST\31IFSCOPE\32CONDEMNED" \ 329 "\33IFREF\34PROXY\35ROUTER\37GLOBAL" 330 331 #define IS_DIRECT_HOSTROUTE(rt) \ 332 (((rt)->rt_flags & (RTF_HOST | RTF_GATEWAY)) == RTF_HOST) 333 334 #define IS_DYNAMIC_DIRECT_HOSTROUTE(rt) \ 335 (((rt)->rt_flags & (RTF_CLONING | RTF_PRCLONING | RTF_HOST | RTF_LLINFO |\ 336 RTF_WASCLONED | RTF_GATEWAY)) ==\ 337 (RTF_HOST | RTF_LLINFO | RTF_WASCLONED)) 338 /* 339 * Routing statistics. 340 */ 341 struct rtstat { 342 short rts_badredirect; /* bogus redirect calls */ 343 short rts_dynamic; /* routes created by redirects */ 344 short rts_newgateway; /* routes modified by redirects */ 345 short rts_unreach; /* lookups which failed */ 346 short rts_wildcard; /* lookups satisfied by a wildcard */ 347 short rts_badrtgwroute; /* route to gateway is not direct */ 348 }; 349 350 /* 351 * Structures for routing messages. 352 */ 353 struct rt_msghdr { 354 u_short rtm_msglen; /* to skip over non-understood messages */ 355 u_char rtm_version; /* future binary compatibility */ 356 u_char rtm_type; /* message type */ 357 u_short rtm_index; /* index for associated ifp */ 358 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 359 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 360 pid_t rtm_pid; /* identify sender */ 361 int rtm_seq; /* for sender to identify action */ 362 int rtm_errno; /* why failed */ 363 int rtm_use; /* from rtentry */ 364 u_int32_t rtm_inits; /* which metrics we are initializing */ 365 struct rt_metrics rtm_rmx; /* metrics themselves */ 366 }; 367 368 struct rt_msghdr2 { 369 u_short rtm_msglen; /* to skip over non-understood messages */ 370 u_char rtm_version; /* future binary compatibility */ 371 u_char rtm_type; /* message type */ 372 u_short rtm_index; /* index for associated ifp */ 373 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 374 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 375 int32_t rtm_refcnt; /* reference count */ 376 int rtm_parentflags; /* flags of the parent route */ 377 int rtm_reserved; /* reserved field set to 0 */ 378 int rtm_use; /* from rtentry */ 379 u_int32_t rtm_inits; /* which metrics we are initializing */ 380 struct rt_metrics rtm_rmx; /* metrics themselves */ 381 }; 382 383 #ifdef PRIVATE 384 struct kev_netevent_apnfallbk_data { 385 pid_t epid; /* effective PID */ 386 uuid_t euuid; /* effective UUID */ 387 }; 388 389 /* 390 * Route reachability info. 391 */ 392 struct rt_reach_info { 393 u_int32_t ri_refcnt; /* reference count */ 394 u_int32_t ri_probes; /* total # of probes */ 395 u_int64_t ri_snd_expire; /* tx expiration (calendar) time */ 396 u_int64_t ri_rcv_expire; /* rx expiration (calendar) time */ 397 int32_t ri_rssi; /* received signal strength */ 398 int32_t ri_lqm; /* link quality metric */ 399 int32_t ri_npm; /* node proximity metric */ 400 }; 401 402 /* 403 * Extended routing message header (private). 404 */ 405 struct rt_msghdr_ext { 406 u_short rtm_msglen; /* to skip over non-understood messages */ 407 u_char rtm_version; /* future binary compatibility */ 408 u_char rtm_type; /* message type */ 409 u_int32_t rtm_index; /* index for associated ifp */ 410 u_int32_t rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 411 u_int32_t rtm_reserved; /* for future use */ 412 u_int32_t rtm_addrs; /* bitmask identifying sockaddrs in msg */ 413 pid_t rtm_pid; /* identify sender */ 414 int rtm_seq; /* for sender to identify action */ 415 int rtm_errno; /* why failed */ 416 u_int32_t rtm_use; /* from rtentry */ 417 u_int32_t rtm_inits; /* which metrics we are initializing */ 418 struct rt_metrics rtm_rmx; /* metrics themselves */ 419 struct rt_reach_info rtm_ri; /* route reachability info */ 420 }; 421 #endif /* PRIVATE */ 422 423 #define RTM_VERSION 5 /* Up the ante and ignore older versions */ 424 425 /* 426 * Message types. 427 */ 428 #define RTM_ADD 0x1 /* Add Route */ 429 #define RTM_DELETE 0x2 /* Delete Route */ 430 #define RTM_CHANGE 0x3 /* Change Metrics or flags */ 431 #define RTM_GET 0x4 /* Report Metrics */ 432 #define RTM_LOSING 0x5 /* RTM_LOSING is no longer generated by xnu 433 * and is deprecated */ 434 #define RTM_REDIRECT 0x6 /* Told to use different route */ 435 #define RTM_MISS 0x7 /* Lookup failed on this address */ 436 #define RTM_LOCK 0x8 /* fix specified metrics */ 437 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 438 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 439 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 440 #define RTM_NEWADDR 0xc /* address being added to iface */ 441 #define RTM_DELADDR 0xd /* address being removed from iface */ 442 #define RTM_IFINFO 0xe /* iface going up/down etc. */ 443 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ 444 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ 445 #ifdef PRIVATE 446 #define RTM_GET_SILENT 0x11 447 #endif /* PRIVATE */ 448 #define RTM_IFINFO2 0x12 /* */ 449 #define RTM_NEWMADDR2 0x13 /* */ 450 #define RTM_GET2 0x14 /* */ 451 #ifdef PRIVATE 452 #define RTM_GET_EXT 0x15 453 #endif /* PRIVATE */ 454 455 /* 456 * Bitmask values for rtm_inits and rmx_locks. 457 */ 458 #define RTV_MTU 0x1 /* init or lock _mtu */ 459 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 460 #define RTV_EXPIRE 0x4 /* init or lock _expire */ 461 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 462 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 463 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 464 #define RTV_RTT 0x40 /* init or lock _rtt */ 465 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 466 #ifdef PRIVATE 467 #define RTV_REFRESH_HOST 0x100 /* init host route to expedite refresh */ 468 #endif 469 470 /* 471 * Bitmask values for rtm_addrs. 472 */ 473 #define RTA_DST 0x1 /* destination sockaddr present */ 474 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 475 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 476 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 477 #define RTA_IFP 0x10 /* interface name sockaddr present */ 478 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 479 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 480 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 481 482 /* 483 * Index offsets for sockaddr array for alternate internal encoding. 484 */ 485 #define RTAX_DST 0 /* destination sockaddr present */ 486 #define RTAX_GATEWAY 1 /* gateway sockaddr present */ 487 #define RTAX_NETMASK 2 /* netmask sockaddr present */ 488 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 489 #define RTAX_IFP 4 /* interface name sockaddr present */ 490 #define RTAX_IFA 5 /* interface addr sockaddr present */ 491 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 492 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 493 #define RTAX_MAX 8 /* size of array to allocate */ 494 495 struct rt_addrinfo { 496 int rti_addrs; 497 struct sockaddr *rti_info[RTAX_MAX]; 498 }; 499 500 #ifdef PRIVATE 501 /* 502 * For scoped routing; a zero interface scope value means nil/no scope. 503 */ 504 #define IFSCOPE_NONE 0 505 #define IFSCOPE_UNKNOWN IFSCOPE_NONE 506 #endif /* PRIVATE */ 507 508 #ifdef BSD_KERNEL_PRIVATE 509 /* 510 * Generic call trace used by some subsystems (e.g. route, ifaddr) 511 */ 512 #define CTRACE_STACK_SIZE 8 /* depth of stack trace */ 513 #define CTRACE_HIST_SIZE 4 /* refcnt history size */ 514 typedef struct ctrace { 515 void *th; /* thread ptr */ 516 void *pc[CTRACE_STACK_SIZE]; /* PC stack trace */ 517 } ctrace_t; 518 519 extern void ctrace_record(ctrace_t *); 520 521 #define RT_LOCK_ASSERT_HELD(_rt) \ 522 LCK_MTX_ASSERT(&(_rt)->rt_lock, LCK_MTX_ASSERT_OWNED) 523 524 #define RT_LOCK_ASSERT_NOTHELD(_rt) \ 525 LCK_MTX_ASSERT(&(_rt)->rt_lock, LCK_MTX_ASSERT_NOTOWNED) 526 527 #define RT_LOCK(_rt) do { \ 528 rt_lock(_rt, FALSE); \ 529 } while (0) 530 531 #define RT_LOCK_SPIN(_rt) do { \ 532 rt_lock(_rt, TRUE); \ 533 } while (0) 534 535 #define RT_CONVERT_LOCK(_rt) do { \ 536 RT_LOCK_ASSERT_HELD(_rt); \ 537 lck_mtx_convert_spin(&(_rt)->rt_lock); \ 538 } while (0) 539 540 #define RT_UNLOCK(_rt) do { \ 541 rt_unlock(_rt); \ 542 } while (0) 543 544 #define RT_ADDREF_LOCKED(_rt) do { \ 545 rtref(_rt); \ 546 } while (0) 547 548 /* 549 * Spin variant mutex is used here; caller is responsible for 550 * converting any previously-held similar lock to full mutex. 551 */ 552 #define RT_ADDREF(_rt) do { \ 553 RT_LOCK_SPIN(_rt); \ 554 RT_ADDREF_LOCKED(_rt); \ 555 RT_UNLOCK(_rt); \ 556 } while (0) 557 558 #define RT_REMREF_LOCKED(_rt) do { \ 559 (void) rtunref(_rt); \ 560 } while (0) 561 562 /* 563 * Spin variant mutex is used here; caller is responsible for 564 * converting any previously-held similar lock to full mutex. 565 */ 566 #define RT_REMREF(_rt) do { \ 567 RT_LOCK_SPIN(_rt); \ 568 RT_REMREF_LOCKED(_rt); \ 569 RT_UNLOCK(_rt); \ 570 } while (0) 571 572 /* 573 * This macro calculates skew in wall clock, just in case the user changes the 574 * system time. This skew adjustment is required because we now keep the 575 * expiration times in uptime terms in the kernel, but the userland still 576 * expects expiration times in terms of calendar times. This is used when 577 * reporting rt_expire, ln_expire, etc. values to user space. 578 */ 579 #define NET_CALCULATE_CLOCKSKEW(cc, ic, cu, iu) \ 580 ((cc.tv_sec - ic) - (cu - iu)) 581 582 extern unsigned int rt_verbose; 583 extern struct radix_node_head *rt_tables[AF_MAX + 1]; 584 extern lck_mtx_t rnh_lock_data; 585 #define rnh_lock (&rnh_lock_data) 586 extern uint32_t route_genid_inet; /* INET route generation count */ 587 extern uint32_t route_genid_inet6; /* INET6 route generation count */ 588 extern int rttrash; 589 extern unsigned int rte_debug; 590 591 struct ifmultiaddr; 592 struct proc; 593 594 extern void route_init(void); 595 extern void routegenid_update(void); 596 extern void routegenid_inet_update(void); 597 extern void routegenid_inet6_update(void); 598 extern void rt_ifmsg(struct ifnet *); 599 extern void rt_missmsg(u_char, struct rt_addrinfo *, int, int); 600 extern void rt_newaddrmsg(u_char, struct ifaddr *, int, struct rtentry *); 601 extern void rt_newmaddrmsg(u_char, struct ifmultiaddr *); 602 extern int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *); 603 extern void set_primary_ifscope(int, unsigned int); 604 extern unsigned int get_primary_ifscope(int); 605 extern boolean_t rt_primary_default(struct rtentry *, struct sockaddr *); 606 extern struct rtentry *rt_lookup(boolean_t, struct sockaddr *, 607 struct sockaddr *, struct radix_node_head *, unsigned int); 608 extern struct rtentry *rt_lookup_coarse(boolean_t, struct sockaddr *, 609 struct sockaddr *, struct radix_node_head *); 610 extern void rtalloc(struct route *); 611 extern void rtalloc_scoped(struct route *, unsigned int); 612 extern void rtalloc_ign(struct route *, uint32_t); 613 extern void rtalloc_scoped_ign(struct route *, uint32_t, unsigned int); 614 extern struct rtentry *rtalloc1(struct sockaddr *, int, uint32_t); 615 extern struct rtentry *rtalloc1_scoped(struct sockaddr *, int, uint32_t, 616 unsigned int); 617 extern struct rtentry *rtalloc1_scoped_locked(struct sockaddr *, int, 618 uint32_t, unsigned int); 619 extern void rtfree_locked(struct rtentry *); 620 extern void rtfree(struct rtentry *); 621 extern void rtref(struct rtentry *); 622 /* 623 * rtunref will decrement the refcount, rtfree will decrement and free if 624 * the refcount has reached zero and the route is not up. 625 * Unless you have good reason to do otherwise, use rtfree. 626 */ 627 extern int rtunref(struct rtentry *); 628 extern void rtsetifa(struct rtentry *, struct ifaddr *); 629 extern int rtinit(struct ifaddr *, uint8_t, int); 630 extern int rtinit_locked(struct ifaddr *, uint8_t, int); 631 extern int rtioctl(unsigned long, caddr_t, struct proc *); 632 extern void rtredirect(struct ifnet *, struct sockaddr *, struct sockaddr *, 633 struct sockaddr *, int, struct sockaddr *, struct rtentry **); 634 extern int rtrequest(int, struct sockaddr *, 635 struct sockaddr *, struct sockaddr *, int, struct rtentry **); 636 extern int rtrequest_scoped(int, struct sockaddr *, struct sockaddr *, 637 struct sockaddr *, int, struct rtentry **, unsigned int); 638 extern int rtrequest_locked(int, struct sockaddr *, 639 struct sockaddr *, struct sockaddr *, int, struct rtentry **); 640 extern int rtrequest_scoped_locked(int, struct sockaddr *, struct sockaddr *, 641 struct sockaddr *, int, struct rtentry **, unsigned int); 642 extern void sin_set_ifscope(struct sockaddr *, unsigned int); 643 extern unsigned int sin_get_ifscope(struct sockaddr *); 644 extern unsigned int sin6_get_ifscope(struct sockaddr *); 645 extern void rt_lock(struct rtentry *, boolean_t); 646 extern void rt_unlock(struct rtentry *); 647 extern struct sockaddr *rtm_scrub(int, int, struct sockaddr *, 648 struct sockaddr *, void *, uint32_t, kauth_cred_t *); 649 extern boolean_t rt_validate(struct rtentry *); 650 extern void rt_set_proxy(struct rtentry *, boolean_t); 651 extern void rt_set_gwroute(struct rtentry *, struct sockaddr *, 652 struct rtentry *); 653 extern void rt_revalidate_gwroute(struct rtentry *, struct rtentry *); 654 extern errno_t route_to_gwroute(const struct sockaddr *, struct rtentry *, 655 struct rtentry **); 656 extern void rt_setexpire(struct rtentry *, uint64_t); 657 extern void rt_str(struct rtentry *, char *, uint32_t, char *, uint32_t); 658 extern const char *rtm2str(int); 659 extern void route_copyin(struct route *, struct route *, size_t); 660 extern void route_copyout(struct route *, const struct route *, size_t); 661 extern boolean_t rt_ifa_is_dst(struct sockaddr *, struct ifaddr *); 662 extern struct sockaddr *sa_copy(struct sockaddr *, struct sockaddr_storage *, 663 unsigned int *); 664 665 /* 666 * The following is used to enqueue work items for route events 667 * and also used to pass route event while walking the tree 668 */ 669 struct route_event { 670 struct rtentry *rt; 671 /* 672 * There's no reference taken on gwrt. 673 * We only use it to check whether we should 674 * point to rt_gateway or the embedded rt_addr 675 * structure. 676 */ 677 struct rtentry *gwrt; 678 union { 679 union sockaddr_in_4_6 _rtev_ipaddr; 680 struct sockaddr_dl _rtev_lladdr; 681 char _rtev_addr_bytes[DLIL_SDLMAXLEN]; 682 } rt_addr; 683 uint32_t route_event_code; 684 eventhandler_tag evtag; 685 }; 686 687 #define rtev_ipaddr rt_addr._rtev_ipaddr 688 #define rtev_lladdr rt_addr._rtev_lladdr 689 #define rtev_addr_bytes rt_addr._rtev_addr_bytes 690 691 extern void route_event_init(struct route_event *p_route_ev, struct rtentry *rt, 692 struct rtentry *gwrt, int route_ev_code); 693 extern int route_event_walktree(struct radix_node *rn, void *arg); 694 extern void route_event_enqueue_nwk_wq_entry(struct rtentry *, struct rtentry *, 695 uint32_t, eventhandler_tag, boolean_t); 696 #endif /* BSD_KERNEL_PRIVATE */ 697 #endif /* _NET_ROUTE_H_ */ 698