bsd/net/route.h

   1 /*
   2  * Copyright (c) 2000-2016 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_filler[4];  /* will be used for T/TCP later */
  87 };
  88
  89 /*
  90  * rmx_rtt and rmx_rttvar are stored as microseconds;
  91  */
  92 #define RTM_RTTUNIT     1000000 /* units for rtt, rttvar, as units per sec */
  93
  94 #ifdef PRIVATE
  95 struct route_old {
  96         void            *ro_rt;
  97         uint32_t        ro_flags;
  98         struct sockaddr ro_dst;
  99 };
 100 #endif /* PRIVATE */
 101
 102 #ifdef BSD_KERNEL_PRIVATE
 103 #include <kern/locks.h>
 104 #include <net/radix.h>
 105
 106 /*
 107  * Kernel resident routing tables.
 108  *
 109  * The routing tables are initialized when interface addresses
 110  * are set by making entries for all directly connected interfaces.
 111  */
 112
 113 /* forward declarations */
 114 struct ifnet_llreach_info;
 115 struct rt_reach_info;
 116
 117 /*
 118  * IP route structure
 119  *
 120  * A route consists of a destination address and a reference
 121  * to a routing entry.  These are often held by protocols
 122  * in their control blocks, e.g. inpcb.
 123  */
 124 struct route {
 125         /*
 126          * N.B: struct route must begin with ro_{rt,srcia,flags}
 127          * because the code does some casts of a 'struct route_in6 *'
 128          * to a 'struct route *'.
 129          */
 130         struct rtentry  *ro_rt;
 131         struct ifaddr   *ro_srcia;
 132         uint32_t        ro_flags;       /* route flags (see below) */
 133         struct sockaddr ro_dst;
 134 };
 135
 136 #define ROF_SRCIF_SELECTED      0x1     /* source interface was selected */
 137
 138 #define ROUTE_UNUSABLE(_ro)                                             \
 139         ((_ro)->ro_rt == NULL ||                                        \
 140         ((_ro)->ro_rt->rt_flags & (RTF_UP|RTF_CONDEMNED)) != RTF_UP ||  \
 141         RT_GENID_OUTOFSYNC((_ro)->ro_rt))
 142
 143 #define _ROUTE_RELEASE_COMMON(_ro, _rnh_locked) do {                    \
 144         if ((_ro)->ro_rt != NULL) {                                     \
 145                 RT_LOCK_ASSERT_NOTHELD((_ro)->ro_rt);                   \
 146                 if (_rnh_locked)                                        \
 147                         rtfree_locked((_ro)->ro_rt);                    \
 148                 else                                                    \
 149                         rtfree((_ro)->ro_rt);                           \
 150                 (_ro)->ro_rt = NULL;                                    \
 151         }                                                               \
 152         if ((_ro)->ro_srcia != NULL) {                                  \
 153                 IFA_REMREF((_ro)->ro_srcia);                            \
 154                 (_ro)->ro_srcia = NULL;                                 \
 155                 (_ro)->ro_flags &= ~ROF_SRCIF_SELECTED;                 \
 156         }                                                               \
 157 } while (0)
 158
 159 #define ROUTE_RELEASE_LOCKED(_ro)       _ROUTE_RELEASE_COMMON(_ro, TRUE)
 160 #define ROUTE_RELEASE(_ro)              _ROUTE_RELEASE_COMMON(_ro, FALSE)
 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
 171 #define NRTT_HIST       10
 172 /*
 173  * Kernel routing entry structure.
 174  */
 175 struct rtentry {
 176         struct  radix_node rt_nodes[2]; /* tree glue, and other values */
 177 #define rt_key(r)       (SA((r)->rt_nodes->rn_key))
 178 #define rt_mask(r)      (SA((r)->rt_nodes->rn_mask))
 179         /*
 180          * See bsd/net/route.c for synchronization notes.
 181          */
 182         decl_lck_mtx_data(, rt_lock);   /* lock for routing entry */
 183         uint32_t rt_refcnt;             /* # held references */
 184         uint32_t rt_flags;              /* up/down?, host/net */
 185         uint32_t rt_genid;              /* route generation id */
 186         struct sockaddr *rt_gateway;    /* value */
 187         struct ifnet *rt_ifp;           /* the answer: interface to use */
 188         struct ifaddr *rt_ifa;          /* the answer: interface addr to use */
 189         struct sockaddr *rt_genmask;    /* for generation of cloned routes */
 190         void *rt_llinfo;                /* pointer to link level info cache */
 191         void (*rt_llinfo_get_ri)        /* llinfo get reachability info fn */
 192             (struct rtentry *, struct rt_reach_info *);
 193         void (*rt_llinfo_get_iflri)     /* ifnet llinfo get reach. info fn */
 194             (struct rtentry *, struct ifnet_llreach_info *);
 195         void (*rt_llinfo_purge)(struct rtentry *); /* llinfo purge fn */
 196         void (*rt_llinfo_free)(void *); /* link level info free function */
 197         void (*rt_llinfo_refresh) (struct rtentry *); /* expedite llinfo refresh */
 198         struct rt_metrics rt_rmx;       /* metrics used by rx'ing protocols */
 199 #define rt_use rt_rmx.rmx_pksent
 200         struct rtentry *rt_gwroute;     /* implied entry for gatewayed routes */
 201         struct rtentry *rt_parent;      /* cloning parent of this route */
 202         struct nstat_counts *rt_stats;  /* route stats */
 203         void (*rt_if_ref_fn)(struct ifnet *, int); /* interface ref func */
 204
 205         uint32_t *rt_tree_genid;        /* ptr to per-tree route_genid */
 206         uint64_t rt_expire;             /* expiration time in uptime seconds */
 207         uint64_t base_calendartime;     /* calendar time upon entry creation */
 208         uint64_t base_uptime;           /* uptime upon entry creation */
 209         u_int32_t rtt_hist[NRTT_HIST];  /* RTT history sample by TCP connections */
 210         u_int32_t rtt_min;              /* minimum RTT computed from history */
 211         u_int32_t rtt_expire_ts;        /* RTT history expire timestamp */
 212         u_int8_t rtt_index;             /* Index into RTT history */
 213 };
 214
 215 /*
 216  * Synchronize route entry's generation ID with the tree's.
 217  */
 218 #define RT_GENID_SYNC(_rt) do {                                         \
 219         if ((_rt)->rt_tree_genid != NULL)                               \
 220                 (_rt)->rt_genid = *(_rt)->rt_tree_genid;                \
 221 } while (0)
 222
 223 /*
 224  * Indicates whether or not the route entry's generation ID is stale.
 225  */
 226 #define RT_GENID_OUTOFSYNC(_rt)                                         \
 227         ((_rt)->rt_tree_genid != NULL &&                                \
 228         *(_rt)->rt_tree_genid != (_rt)->rt_genid)
 229
 230 #endif /* BSD_KERNEL_PRIVATE */
 231
 232 #define RTF_UP          0x1             /* route usable */
 233 #define RTF_GATEWAY     0x2             /* destination is a gateway */
 234 #define RTF_HOST        0x4             /* host entry (net otherwise) */
 235 #define RTF_REJECT      0x8             /* host or net unreachable */
 236 #define RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
 237 #define RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
 238 #define RTF_DONE        0x40            /* message confirmed */
 239 #define RTF_DELCLONE    0x80            /* delete cloned route */
 240 #define RTF_CLONING     0x100           /* generate new routes on use */
 241 #define RTF_XRESOLVE    0x200           /* external daemon resolves name */
 242 #define RTF_LLINFO      0x400           /* generated by link layer (e.g. ARP) */
 243 #define RTF_STATIC      0x800           /* manually added */
 244 #define RTF_BLACKHOLE   0x1000          /* just discard pkts (during updates) */
 245 #define RTF_NOIFREF     0x2000          /* not eligible for RTF_IFREF */
 246 #define RTF_PROTO2      0x4000          /* protocol specific routing flag */
 247 #define RTF_PROTO1      0x8000          /* protocol specific routing flag */
 248
 249 #define RTF_PRCLONING   0x10000         /* protocol requires cloning */
 250 #define RTF_WASCLONED   0x20000         /* route generated through cloning */
 251 #define RTF_PROTO3      0x40000         /* protocol specific routing flag */
 252                                         /* 0x80000 unused */
 253 #define RTF_PINNED      0x100000        /* future use */
 254 #define RTF_LOCAL       0x200000        /* route represents a local address */
 255 #define RTF_BROADCAST   0x400000        /* route represents a bcast address */
 256 #define RTF_MULTICAST   0x800000        /* route represents a mcast address */
 257 #define RTF_IFSCOPE     0x1000000       /* has valid interface scope */
 258 #define RTF_CONDEMNED   0x2000000       /* defunct; no longer modifiable */
 259 #define RTF_IFREF       0x4000000       /* route holds a ref to interface */
 260 #define RTF_PROXY       0x8000000       /* proxying, no interface scope */
 261 #define RTF_ROUTER      0x10000000      /* host is a router */
 262                                         /* 0x20000000 and up unassigned */
 263
 264 #define RTF_BITS \
 265         "\020\1UP\2GATEWAY\3HOST\4REJECT\5DYNAMIC\6MODIFIED\7DONE" \
 266         "\10DELCLONE\11CLONING\12XRESOLVE\13LLINFO\14STATIC\15BLACKHOLE" \
 267         "\16NOIFREF\17PROTO2\20PROTO1\21PRCLONING\22WASCLONED\23PROTO3" \
 268         "\25PINNED\26LOCAL\27BROADCAST\30MULTICAST\31IFSCOPE\32CONDEMNED" \
 269         "\33IFREF\34PROXY\35ROUTER"
 270
 271 /*
 272  * Routing statistics.
 273  */
 274 struct  rtstat {
 275         short   rts_badredirect;        /* bogus redirect calls */
 276         short   rts_dynamic;            /* routes created by redirects */
 277         short   rts_newgateway;         /* routes modified by redirects */
 278         short   rts_unreach;            /* lookups which failed */
 279         short   rts_wildcard;           /* lookups satisfied by a wildcard */
 280 };
 281
 282 /*
 283  * Structures for routing messages.
 284  */
 285 struct rt_msghdr {
 286         u_short rtm_msglen;     /* to skip over non-understood messages */
 287         u_char  rtm_version;    /* future binary compatibility */
 288         u_char  rtm_type;       /* message type */
 289         u_short rtm_index;      /* index for associated ifp */
 290         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
 291         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
 292         pid_t   rtm_pid;        /* identify sender */
 293         int     rtm_seq;        /* for sender to identify action */
 294         int     rtm_errno;      /* why failed */
 295         int     rtm_use;        /* from rtentry */
 296         u_int32_t rtm_inits;    /* which metrics we are initializing */
 297         struct rt_metrics rtm_rmx; /* metrics themselves */
 298 };
 299
 300 struct rt_msghdr2 {
 301         u_short rtm_msglen;     /* to skip over non-understood messages */
 302         u_char  rtm_version;    /* future binary compatibility */
 303         u_char  rtm_type;       /* message type */
 304         u_short rtm_index;      /* index for associated ifp */
 305         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
 306         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
 307         int32_t rtm_refcnt;     /* reference count */
 308         int     rtm_parentflags; /* flags of the parent route */
 309         int     rtm_reserved;   /* reserved field set to 0 */
 310         int     rtm_use;        /* from rtentry */
 311         u_int32_t rtm_inits;    /* which metrics we are initializing */
 312         struct rt_metrics rtm_rmx; /* metrics themselves */
 313 };
 314
 315 #ifdef PRIVATE
 316 struct kev_netevent_apnfallbk_data {
 317         pid_t           epid;           /* effective PID */
 318         uuid_t          euuid;          /* effective UUID */
 319 };
 320
 321 /*
 322  * Route reachability info.
 323  */
 324 struct rt_reach_info {
 325         u_int32_t       ri_refcnt;      /* reference count */
 326         u_int32_t       ri_probes;      /* total # of probes */
 327         u_int64_t       ri_snd_expire;  /* tx expiration (calendar) time */
 328         u_int64_t       ri_rcv_expire;  /* rx expiration (calendar) time */
 329         int32_t         ri_rssi;        /* received signal strength */
 330         int32_t         ri_lqm;         /* link quality metric */
 331         int32_t         ri_npm;         /* node proximity metric */
 332 };
 333
 334 /*
 335  * Extended routing message header (private).
 336  */
 337 struct rt_msghdr_ext {
 338         u_short rtm_msglen;     /* to skip over non-understood messages */
 339         u_char  rtm_version;    /* future binary compatibility */
 340         u_char  rtm_type;       /* message type */
 341         u_int32_t rtm_index;    /* index for associated ifp */
 342         u_int32_t rtm_flags;    /* flags, incl. kern & message, e.g. DONE */
 343         u_int32_t rtm_reserved; /* for future use */
 344         u_int32_t rtm_addrs;    /* bitmask identifying sockaddrs in msg */
 345         pid_t   rtm_pid;        /* identify sender */
 346         int     rtm_seq;        /* for sender to identify action */
 347         int     rtm_errno;      /* why failed */
 348         u_int32_t rtm_use;      /* from rtentry */
 349         u_int32_t rtm_inits;    /* which metrics we are initializing */
 350         struct rt_metrics rtm_rmx;      /* metrics themselves */
 351         struct rt_reach_info rtm_ri;    /* route reachability info */
 352 };
 353 #endif /* PRIVATE */
 354
 355 #define RTM_VERSION     5       /* Up the ante and ignore older versions */
 356
 357 /*
 358  * Message types.
 359  */
 360 #define RTM_ADD         0x1     /* Add Route */
 361 #define RTM_DELETE      0x2     /* Delete Route */
 362 #define RTM_CHANGE      0x3     /* Change Metrics or flags */
 363 #define RTM_GET         0x4     /* Report Metrics */
 364 #define RTM_LOSING      0x5     /* RTM_LOSING is no longer generated by xnu
 365                                    and is deprecated */
 366 #define RTM_REDIRECT    0x6     /* Told to use different route */
 367 #define RTM_MISS        0x7     /* Lookup failed on this address */
 368 #define RTM_LOCK        0x8     /* fix specified metrics */
 369 #define RTM_OLDADD      0x9     /* caused by SIOCADDRT */
 370 #define RTM_OLDDEL      0xa     /* caused by SIOCDELRT */
 371 #define RTM_RESOLVE     0xb     /* req to resolve dst to LL addr */
 372 #define RTM_NEWADDR     0xc     /* address being added to iface */
 373 #define RTM_DELADDR     0xd     /* address being removed from iface */
 374 #define RTM_IFINFO      0xe     /* iface going up/down etc. */
 375 #define RTM_NEWMADDR    0xf     /* mcast group membership being added to if */
 376 #define RTM_DELMADDR    0x10    /* mcast group membership being deleted */
 377 #ifdef PRIVATE
 378 #define RTM_GET_SILENT  0x11
 379 #endif /* PRIVATE */
 380 #define RTM_IFINFO2     0x12    /* */
 381 #define RTM_NEWMADDR2   0x13    /* */
 382 #define RTM_GET2        0x14    /* */
 383 #ifdef PRIVATE
 384 #define RTM_GET_EXT     0x15
 385 #endif /* PRIVATE */
 386
 387 #ifdef BSD_KERNEL_PRIVATE
 388 /* RTM flags */
 389 #define RTMF_HIDE_LLADDR                0x00000001
 390 #endif /* BSD_KERNEL_PRIVATE */
 391 /*
 392  * Bitmask values for rtm_inits and rmx_locks.
 393  */
 394 #define RTV_MTU         0x1     /* init or lock _mtu */
 395 #define RTV_HOPCOUNT    0x2     /* init or lock _hopcount */
 396 #define RTV_EXPIRE      0x4     /* init or lock _expire */
 397 #define RTV_RPIPE       0x8     /* init or lock _recvpipe */
 398 #define RTV_SPIPE       0x10    /* init or lock _sendpipe */
 399 #define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
 400 #define RTV_RTT         0x40    /* init or lock _rtt */
 401 #define RTV_RTTVAR      0x80    /* init or lock _rttvar */
 402 #ifdef PRIVATE
 403 #define RTV_REFRESH_HOST        0x100   /* init host route to expedite refresh */
 404 #endif
 405
 406 /*
 407  * Bitmask values for rtm_addrs.
 408  */
 409 #define RTA_DST         0x1     /* destination sockaddr present */
 410 #define RTA_GATEWAY     0x2     /* gateway sockaddr present */
 411 #define RTA_NETMASK     0x4     /* netmask sockaddr present */
 412 #define RTA_GENMASK     0x8     /* cloning mask sockaddr present */
 413 #define RTA_IFP         0x10    /* interface name sockaddr present */
 414 #define RTA_IFA         0x20    /* interface addr sockaddr present */
 415 #define RTA_AUTHOR      0x40    /* sockaddr for author of redirect */
 416 #define RTA_BRD         0x80    /* for NEWADDR, broadcast or p-p dest addr */
 417
 418 /*
 419  * Index offsets for sockaddr array for alternate internal encoding.
 420  */
 421 #define RTAX_DST        0       /* destination sockaddr present */
 422 #define RTAX_GATEWAY    1       /* gateway sockaddr present */
 423 #define RTAX_NETMASK    2       /* netmask sockaddr present */
 424 #define RTAX_GENMASK    3       /* cloning mask sockaddr present */
 425 #define RTAX_IFP        4       /* interface name sockaddr present */
 426 #define RTAX_IFA        5       /* interface addr sockaddr present */
 427 #define RTAX_AUTHOR     6       /* sockaddr for author of redirect */
 428 #define RTAX_BRD        7       /* for NEWADDR, broadcast or p-p dest addr */
 429 #define RTAX_MAX        8       /* size of array to allocate */
 430
 431 struct rt_addrinfo {
 432         int     rti_addrs;
 433         struct  sockaddr *rti_info[RTAX_MAX];
 434 };
 435
 436 #ifdef PRIVATE
 437 /*
 438  * For scoped routing; a zero interface scope value means nil/no scope.
 439  */
 440 #define IFSCOPE_NONE    0
 441 #endif /* PRIVATE */
 442
 443 #ifdef BSD_KERNEL_PRIVATE
 444 /*
 445  * Generic call trace used by some subsystems (e.g. route, ifaddr)
 446  */
 447 #define CTRACE_STACK_SIZE       8               /* depth of stack trace */
 448 #define CTRACE_HIST_SIZE        4               /* refcnt history size */
 449 typedef struct ctrace {
 450         void    *th;                            /* thread ptr */
 451         void    *pc[CTRACE_STACK_SIZE];         /* PC stack trace */
 452 } ctrace_t;
 453
 454 extern void ctrace_record(ctrace_t *);
 455
 456 #define RT_LOCK_ASSERT_HELD(_rt)                                        \
 457         lck_mtx_assert(&(_rt)->rt_lock, LCK_MTX_ASSERT_OWNED)
 458
 459 #define RT_LOCK_ASSERT_NOTHELD(_rt)                                     \
 460         lck_mtx_assert(&(_rt)->rt_lock, LCK_MTX_ASSERT_NOTOWNED)
 461
 462 #define RT_LOCK(_rt) do {                                               \
 463         rt_lock(_rt, FALSE);                                            \
 464 } while (0)
 465
 466 #define RT_LOCK_SPIN(_rt) do {                                          \
 467         rt_lock(_rt, TRUE);                                             \
 468 } while (0)
 469
 470 #define RT_CONVERT_LOCK(_rt) do {                                       \
 471         RT_LOCK_ASSERT_HELD(_rt);                                       \
 472         lck_mtx_convert_spin(&(_rt)->rt_lock);                          \
 473 } while (0)
 474
 475 #define RT_UNLOCK(_rt) do {                                             \
 476         rt_unlock(_rt);                                                 \
 477 } while (0)
 478
 479 #define RT_ADDREF_LOCKED(_rt) do {                                      \
 480         rtref(_rt);                                                     \
 481 } while (0)
 482
 483 /*
 484  * Spin variant mutex is used here; caller is responsible for
 485  * converting any previously-held similar lock to full mutex.
 486  */
 487 #define RT_ADDREF(_rt) do {                                             \
 488         RT_LOCK_SPIN(_rt);                                              \
 489         RT_ADDREF_LOCKED(_rt);                                          \
 490         RT_UNLOCK(_rt);                                                 \
 491 } while (0)
 492
 493 #define RT_REMREF_LOCKED(_rt) do {                                      \
 494         (void) rtunref(_rt);                                            \
 495 } while (0)
 496
 497 /*
 498  * Spin variant mutex is used here; caller is responsible for
 499  * converting any previously-held similar lock to full mutex.
 500  */
 501 #define RT_REMREF(_rt) do {                                             \
 502         RT_LOCK_SPIN(_rt);                                              \
 503         RT_REMREF_LOCKED(_rt);                                          \
 504         RT_UNLOCK(_rt);                                                 \
 505 } while (0)
 506
 507 /*
 508  * This macro calculates skew in wall clock, just in case the user changes the
 509  * system time. This skew adjustment is required because we now keep the
 510  * expiration times in uptime terms in the kernel, but the userland still
 511  * expects expiration times in terms of calendar times.  This is used when
 512  * reporting rt_expire, ln_expire, etc. values to user space.
 513  */
 514 #define NET_CALCULATE_CLOCKSKEW(cc, ic, cu, iu)                         \
 515         ((cc.tv_sec - ic) - (cu - iu))
 516
 517 extern unsigned int rt_verbose;
 518 extern struct radix_node_head *rt_tables[AF_MAX+1];
 519 extern lck_mtx_t *rnh_lock;
 520 extern uint32_t route_genid_inet;       /* INET route generation count */
 521 #if INET6
 522 extern uint32_t route_genid_inet6;      /* INET6 route generation count */
 523 #endif /* INET6 */
 524 extern int rttrash;
 525 extern unsigned int rte_debug;
 526
 527 struct ifmultiaddr;
 528 struct proc;
 529
 530 extern void route_init(void);
 531 extern void routegenid_update(void);
 532 extern void routegenid_inet_update(void);
 533 extern void routegenid_inet6_update(void);
 534 extern void rt_ifmsg(struct ifnet *);
 535 extern void rt_missmsg(int, struct rt_addrinfo *, int, int);
 536 extern void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
 537 extern void rt_newmaddrmsg(int, struct ifmultiaddr *);
 538 extern int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
 539 extern void set_primary_ifscope(int, unsigned int);
 540 extern unsigned int get_primary_ifscope(int);
 541 extern boolean_t rt_primary_default(struct rtentry *, struct sockaddr *);
 542 extern struct rtentry *rt_lookup(boolean_t, struct sockaddr *,
 543     struct sockaddr *, struct radix_node_head *, unsigned int);
 544 extern struct rtentry *rt_lookup_coarse(boolean_t, struct sockaddr *,
 545     struct sockaddr *, struct radix_node_head *);
 546 extern void rtalloc(struct route *);
 547 extern void rtalloc_scoped(struct route *, unsigned int);
 548 extern void rtalloc_ign(struct route *, uint32_t);
 549 extern void rtalloc_scoped_ign(struct route *, uint32_t, unsigned int);
 550 extern struct rtentry *rtalloc1(struct sockaddr *, int, uint32_t);
 551 extern struct rtentry *rtalloc1_scoped(struct sockaddr *, int, uint32_t,
 552     unsigned int);
 553 extern struct rtentry *rtalloc1_scoped_locked(struct sockaddr *, int,
 554     uint32_t, unsigned int);
 555 extern void rtfree_locked(struct rtentry *);
 556 extern void rtfree(struct rtentry *);
 557 extern void rtref(struct rtentry *);
 558 /*
 559  * rtunref will decrement the refcount, rtfree will decrement and free if
 560  * the refcount has reached zero and the route is not up.
 561  * Unless you have good reason to do otherwise, use rtfree.
 562  */
 563 extern int rtunref(struct rtentry *);
 564 extern void rtsetifa(struct rtentry *, struct ifaddr *);
 565 extern int rtinit(struct ifaddr *, int, int);
 566 extern int rtinit_locked(struct ifaddr *, int, int);
 567 extern int rtioctl(unsigned long, caddr_t, struct proc *);
 568 extern void rtredirect(struct ifnet *, struct sockaddr *, struct sockaddr *,
 569     struct sockaddr *, int, struct sockaddr *, struct rtentry **);
 570 extern int rtrequest(int, struct sockaddr *,
 571     struct sockaddr *, struct sockaddr *, int, struct rtentry **);
 572 extern int rtrequest_scoped(int, struct sockaddr *, struct sockaddr *,
 573     struct sockaddr *, int, struct rtentry **, unsigned int);
 574 extern int rtrequest_locked(int, struct sockaddr *,
 575     struct sockaddr *, struct sockaddr *, int, struct rtentry **);
 576 extern int rtrequest_scoped_locked(int, struct sockaddr *, struct sockaddr *,
 577     struct sockaddr *, int, struct rtentry **, unsigned int);
 578 extern void sin_set_ifscope(struct sockaddr *, unsigned int);
 579 extern unsigned int sin_get_ifscope(struct sockaddr *);
 580 extern unsigned int sin6_get_ifscope(struct sockaddr *);
 581 extern void rt_lock(struct rtentry *, boolean_t);
 582 extern void rt_unlock(struct rtentry *);
 583 extern struct sockaddr *rtm_scrub(int, int, struct sockaddr *,
 584     struct sockaddr *, void *, uint32_t, kauth_cred_t *, uint32_t);
 585 extern boolean_t rt_validate(struct rtentry *);
 586 extern void rt_set_proxy(struct rtentry *, boolean_t);
 587 extern void rt_set_gwroute(struct rtentry *, struct sockaddr *,
 588     struct rtentry *);
 589 extern void rt_revalidate_gwroute(struct rtentry *, struct rtentry *);
 590 extern errno_t route_to_gwroute(const struct sockaddr *, struct rtentry *,
 591     struct rtentry **);
 592 extern void rt_setexpire(struct rtentry *, uint64_t);
 593 extern void rt_str(struct rtentry *, char *, uint32_t, char *, uint32_t);
 594 extern const char *rtm2str(int);
 595 extern void route_copyin(struct route *, struct route *, size_t);
 596 extern void route_copyout(struct route *, const struct route *, size_t);
 597 extern boolean_t rt_ifa_is_dst(struct sockaddr *, struct ifaddr *);
 598 extern struct sockaddr *sa_copy(struct sockaddr *, struct sockaddr_storage *,
 599     unsigned int *);
 600 #endif /* BSD_KERNEL_PRIVATE */
 601 #endif /* _NET_ROUTE_H_ */