/*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2017 Apple Inc. All rights reserved.
*
- * @APPLE_LICENSE_HEADER_START@
- *
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License"). You may not use this file except in compliance with the
- * License. Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- *
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- *
- * @APPLE_LICENSE_HEADER_END@
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
/*
* Copyright (c) 1980, 1986, 1993
* SUCH DAMAGE.
*
* @(#)route.h 8.3 (Berkeley) 4/19/94
+ * $FreeBSD: src/sys/net/route.h,v 1.36.2.1 2000/08/16 06:14:23 jayanth Exp $
*/
#ifndef _NET_ROUTE_H_
-#define _NET_ROUTE_H_
+#define _NET_ROUTE_H_
+#include <sys/appleapiopts.h>
+#include <stdint.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+
+/*
+ * These numbers are used by reliable protocols for determining
+ * retransmission behavior and are included in the routing structure.
+ */
+struct rt_metrics {
+ u_int32_t rmx_locks; /* Kernel leaves these values alone */
+ u_int32_t rmx_mtu; /* MTU for this path */
+ u_int32_t rmx_hopcount; /* max hops expected */
+ int32_t rmx_expire; /* lifetime for route, e.g. redirect */
+ u_int32_t rmx_recvpipe; /* inbound delay-bandwidth product */
+ u_int32_t rmx_sendpipe; /* outbound delay-bandwidth product */
+ u_int32_t rmx_ssthresh; /* outbound gateway buffer limit */
+ u_int32_t rmx_rtt; /* estimated round trip time */
+ u_int32_t rmx_rttvar; /* estimated rtt variance */
+ u_int32_t rmx_pksent; /* packets sent using this route */
+ u_int32_t rmx_state; /* route state */
+ u_int32_t rmx_filler[3]; /* will be used for T/TCP later */
+};
+
+/*
+ * rmx_rtt and rmx_rttvar are stored as microseconds;
+ */
+#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
+
+#ifdef PRIVATE
+struct route_old {
+ void *ro_rt;
+ uint32_t ro_flags;
+ struct sockaddr ro_dst;
+};
+#endif /* PRIVATE */
+
+#ifdef BSD_KERNEL_PRIVATE
+#include <kern/locks.h>
+#include <net/radix.h>
+#include <net/if_llatbl.h>
+#include <sys/eventhandler.h>
+#include <net/if_dl.h>
/*
* Kernel resident routing tables.
* are set by making entries for all directly connected interfaces.
*/
+/* forward declarations */
+struct ifnet_llreach_info;
+struct rt_reach_info;
+
/*
+ * IP route structure
+ *
* A route consists of a destination address and a reference
* to a routing entry. These are often held by protocols
* in their control blocks, e.g. inpcb.
*/
struct route {
- struct rtentry *ro_rt;
- struct sockaddr ro_dst;
-};
+ /*
+ * N.B: struct route must begin with ro_{rt, lle, srcia, flags}
+ * because the code does some casts of a 'struct route_in6 *'
+ * to a 'struct route *'.
+ */
+ struct rtentry *ro_rt;
+ struct llentry *ro_lle;
-/*
- * These numbers are used by reliable protocols for determining
- * retransmission behavior and are included in the routing structure.
- */
-struct rt_metrics {
- u_long rmx_locks; /* Kernel must leave these values alone */
- u_long rmx_mtu; /* MTU for this path */
- u_long rmx_hopcount; /* max hops expected */
- u_long rmx_expire; /* lifetime for route, e.g. redirect */
- u_long rmx_recvpipe; /* inbound delay-bandwidth product */
- u_long rmx_sendpipe; /* outbound delay-bandwidth product */
- u_long rmx_ssthresh; /* outbound gateway buffer limit */
- u_long rmx_rtt; /* estimated round trip time */
- u_long rmx_rttvar; /* estimated rtt variance */
- u_long rmx_pksent; /* packets sent using this route */
- u_long rmx_filler[4]; /* will be used for T/TCP later */
+ struct ifaddr *ro_srcia;
+ uint32_t ro_flags; /* route flags (see below) */
+ struct sockaddr ro_dst;
};
-/*
- * rmx_rtt and rmx_rttvar are stored as microseconds;
- * RTTTOPRHZ(rtt) converts to a value suitable for use
- * by a protocol slowtimo counter.
- */
-#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
-#define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
+#define ROF_SRCIF_SELECTED 0x0001 /* source interface was selected */
+#if 0
+/* XXX These will be used in the changes coming in later */
+#define ROF_NORTREF 0x0002 /* doesn't hold reference on ro_rt */
+#define ROF_L2_ME 0x0004 /* dst L2 addr is our address */
+#define ROF_MAY_LOOP 0x0008 /* dst may require loop copy */
+#define ROF_HAS_HEADER 0x0010 /* mbuf already have its header prepended */
+#define ROF_REJECT 0x0020 /* Destination is reject */
+#define ROF_BLACKHOLE 0x0040 /* Destination is blackhole */
+#define ROF_HAS_GW 0x0080 /* Destination has GW */
+#endif
+#define ROF_LLE_CACHE 0x0100 /* Cache link layer */
-/*
- * XXX kernel function pointer `rt_output' is visible to applications.
- */
-struct mbuf;
+#define ROUTE_UNUSABLE(_ro) \
+ ((_ro)->ro_rt == NULL || \
+ ((_ro)->ro_rt->rt_flags & (RTF_UP|RTF_CONDEMNED)) != RTF_UP || \
+ RT_GENID_OUTOFSYNC((_ro)->ro_rt))
+
+#define _ROUTE_RELEASE_COMMON(_ro, _rnh_locked) do { \
+ if ((_ro)->ro_rt != NULL) { \
+ RT_LOCK_ASSERT_NOTHELD((_ro)->ro_rt); \
+ if (_rnh_locked) \
+ rtfree_locked((_ro)->ro_rt); \
+ else \
+ rtfree((_ro)->ro_rt); \
+ (_ro)->ro_rt = NULL; \
+ } \
+ if ((_ro)->ro_srcia != NULL) { \
+ IFA_REMREF((_ro)->ro_srcia); \
+ (_ro)->ro_srcia = NULL; \
+ (_ro)->ro_flags &= ~ROF_SRCIF_SELECTED; \
+ } \
+ if ((_ro)->ro_lle != NULL) { \
+ LLE_REMREF((_ro)->ro_lle); \
+ (_ro)->ro_lle = NULL; \
+ (_ro)->ro_flags &= ~ROF_LLE_CACHE; \
+ } \
+} while (0)
+
+#define ROUTE_RELEASE_LOCKED(_ro) _ROUTE_RELEASE_COMMON(_ro, TRUE)
+#define ROUTE_RELEASE(_ro) _ROUTE_RELEASE_COMMON(_ro, FALSE)
/*
* We distinguish between routes to hosts and routes to networks,
* gateways are marked so that the output routines know to address the
* gateway rather than the ultimate destination.
*/
-#ifndef RNF_NORMAL
-#include <net/radix.h>
-#endif
+
+#define NRTT_HIST 10
+/*
+ * Kernel routing entry structure.
+ */
struct rtentry {
struct radix_node rt_nodes[2]; /* tree glue, and other values */
-#define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key))
-#define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask))
- struct sockaddr *rt_gateway; /* value */
- short rt_filler; /* was short flags field */
- short rt_refcnt; /* # held references */
- u_long rt_flags; /* up/down?, host/net */
- struct ifnet *rt_ifp; /* the answer: interface to use */
- u_long rt_dlt; /* DLIL dl_tag */
- struct ifaddr *rt_ifa; /* the answer: interface to use */
- struct sockaddr *rt_genmask; /* for generation of cloned routes */
- caddr_t rt_llinfo; /* pointer to link level info cache */
- struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */
- struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */
- int (*rt_output) __P((struct ifnet *, struct mbuf *,
- struct sockaddr *, struct rtentry *));
- /* output routine for this (rt,if) */
- struct rtentry *rt_parent; /* cloning parent of this route */
- void *rt_filler2; /* more filler */
+#define rt_key(r) (SA((r)->rt_nodes->rn_key))
+#define rt_mask(r) (SA((r)->rt_nodes->rn_mask))
+ /*
+ * See bsd/net/route.c for synchronization notes.
+ */
+ decl_lck_mtx_data(, rt_lock); /* lock for routing entry */
+ uint32_t rt_refcnt; /* # held references */
+ uint32_t rt_flags; /* up/down?, host/net */
+ uint32_t rt_genid; /* route generation id */
+ struct sockaddr *rt_gateway; /* value */
+ struct ifnet *rt_ifp; /* the answer: interface to use */
+ struct ifaddr *rt_ifa; /* the answer: interface addr to use */
+ struct sockaddr *rt_genmask; /* for generation of cloned routes */
+ void *rt_llinfo; /* pointer to link level info cache */
+ void (*rt_llinfo_get_ri) /* llinfo get reachability info fn */
+ (struct rtentry *, struct rt_reach_info *);
+ void (*rt_llinfo_get_iflri) /* ifnet llinfo get reach. info fn */
+ (struct rtentry *, struct ifnet_llreach_info *);
+ void (*rt_llinfo_purge)(struct rtentry *); /* llinfo purge fn */
+ void (*rt_llinfo_free)(void *); /* link level info free function */
+ void (*rt_llinfo_refresh) (struct rtentry *); /* expedite llinfo refresh */
+ struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */
+#define rt_use rt_rmx.rmx_pksent
+ struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */
+ struct rtentry *rt_parent; /* cloning parent of this route */
+ struct nstat_counts *rt_stats; /* route stats */
+ void (*rt_if_ref_fn)(struct ifnet *, int); /* interface ref func */
+
+ uint32_t *rt_tree_genid; /* ptr to per-tree route_genid */
+ uint64_t rt_expire; /* expiration time in uptime seconds */
+ uint64_t base_calendartime; /* calendar time upon entry creation */
+ uint64_t base_uptime; /* uptime upon entry creation */
+ u_int32_t rtt_hist[NRTT_HIST]; /* RTT history sample by TCP connections */
+ u_int32_t rtt_min; /* minimum RTT computed from history */
+ u_int32_t rtt_expire_ts; /* RTT history expire timestamp */
+ u_int8_t rtt_index; /* Index into RTT history */
+ /* Event handler context for the rtentrt */
+ struct eventhandler_lists_ctxt rt_evhdlr_ctxt;
};
+enum {
+ ROUTE_STATUS_UPDATE = 1,
+ ROUTE_ENTRY_REFRESH,
+ ROUTE_ENTRY_DELETED,
+ ROUTE_LLENTRY_RESOLVED,
+ ROUTE_LLENTRY_UNREACH,
+ ROUTE_LLENTRY_CHANGED,
+ ROUTE_LLENTRY_STALE,
+ ROUTE_LLENTRY_TIMEDOUT,
+ ROUTE_LLENTRY_DELETED,
+ ROUTE_LLENTRY_EXPIRED,
+ ROUTE_LLENTRY_PROBED,
+ ROUTE_EVHDLR_DEREGISTER,
+};
+
+extern const char * route_event2str(int route_event);
+
+typedef void (*route_event_fn) (struct eventhandler_entry_arg,
+ struct sockaddr *, int, struct sockaddr *, int);
+EVENTHANDLER_DECLARE(route_event, route_event_fn);
+
+/*
+ * Synchronize route entry's generation ID with the tree's.
+ */
+#define RT_GENID_SYNC(_rt) do { \
+ if ((_rt)->rt_tree_genid != NULL) \
+ (_rt)->rt_genid = *(_rt)->rt_tree_genid; \
+} while (0)
+
/*
- * Following structure necessary for 4.3 compatibility;
- * We should eventually move it to a compat file.
+ * Indicates whether or not the route entry's generation ID is stale.
*/
-struct ortentry {
- u_long rt_hash; /* to speed lookups */
- struct sockaddr rt_dst; /* key */
- struct sockaddr rt_gateway; /* value */
- short rt_flags; /* up/down?, host/net */
- short rt_refcnt; /* # held references */
- u_long rt_use; /* raw # packets forwarded */
- struct ifnet *rt_ifp; /* the answer: interface to use */
+#define RT_GENID_OUTOFSYNC(_rt) \
+ ((_rt)->rt_tree_genid != NULL && \
+ *(_rt)->rt_tree_genid != (_rt)->rt_genid)
+
+enum {
+ ROUTE_OP_READ,
+ ROUTE_OP_WRITE,
};
-#define rt_use rt_rmx.rmx_pksent
+extern int route_op_entitlement_check(struct socket *, kauth_cred_t, int, boolean_t);
+#endif /* BSD_KERNEL_PRIVATE */
#define RTF_UP 0x1 /* route usable */
#define RTF_GATEWAY 0x2 /* destination is a gateway */
#define RTF_REJECT 0x8 /* host or net unreachable */
#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
-#define RTF_DONE 0x40 /* message confirmed */
-/* 0x80 unused */
-#define RTF_CLONING 0x100 /* generate new routes on use */
-#define RTF_XRESOLVE 0x200 /* external daemon resolves name */
-#define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */
-#define RTF_STATIC 0x800 /* manually added */
-#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
-#define RTF_PROTO2 0x4000 /* protocol specific routing flag */
-#define RTF_PROTO1 0x8000 /* protocol specific routing flag */
-
-#define RTF_PRCLONING 0x10000 /* protocol requires cloning */
-#define RTF_WASCLONED 0x20000 /* route generated through cloning */
-#define RTF_PROTO3 0x40000 /* protocol specific routing flag */
-/* 0x80000 unused */
-#define RTF_PINNED 0x100000 /* future use */
-#define RTF_LOCAL 0x200000 /* route represents a local address */
+#define RTF_DONE 0x40 /* message confirmed */
+#define RTF_DELCLONE 0x80 /* delete cloned route */
+#define RTF_CLONING 0x100 /* generate new routes on use */
+#define RTF_XRESOLVE 0x200 /* external daemon resolves name */
+#define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward
+ compatibility */
+#define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */
+#define RTF_STATIC 0x800 /* manually added */
+#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
+#define RTF_NOIFREF 0x2000 /* not eligible for RTF_IFREF */
+#define RTF_PROTO2 0x4000 /* protocol specific routing flag */
+#define RTF_PROTO1 0x8000 /* protocol specific routing flag */
+
+#define RTF_PRCLONING 0x10000 /* protocol requires cloning */
+#define RTF_WASCLONED 0x20000 /* route generated through cloning */
+#define RTF_PROTO3 0x40000 /* protocol specific routing flag */
+ /* 0x80000 unused */
+#define RTF_PINNED 0x100000 /* future use */
+#define RTF_LOCAL 0x200000 /* route represents a local address */
#define RTF_BROADCAST 0x400000 /* route represents a bcast address */
#define RTF_MULTICAST 0x800000 /* route represents a mcast address */
- /* 0x1000000 and up unassigned */
+#define RTF_IFSCOPE 0x1000000 /* has valid interface scope */
+#define RTF_CONDEMNED 0x2000000 /* defunct; no longer modifiable */
+#define RTF_IFREF 0x4000000 /* route holds a ref to interface */
+#define RTF_PROXY 0x8000000 /* proxying, no interface scope */
+#define RTF_ROUTER 0x10000000 /* host is a router */
+#define RTF_DEAD 0x20000000 /* Route entry is being freed */
+ /* 0x40000000 and up unassigned */
+#define RTPRF_OURS RTF_PROTO3 /* set on routes we manage */
+#define RTF_BITS \
+ "\020\1UP\2GATEWAY\3HOST\4REJECT\5DYNAMIC\6MODIFIED\7DONE" \
+ "\10DELCLONE\11CLONING\12XRESOLVE\13LLINFO\14STATIC\15BLACKHOLE" \
+ "\16NOIFREF\17PROTO2\20PROTO1\21PRCLONING\22WASCLONED\23PROTO3" \
+ "\25PINNED\26LOCAL\27BROADCAST\30MULTICAST\31IFSCOPE\32CONDEMNED" \
+ "\33IFREF\34PROXY\35ROUTER"
+
+#define IS_DIRECT_HOSTROUTE(rt) \
+ (((rt)->rt_flags & (RTF_HOST | RTF_GATEWAY)) == RTF_HOST)
/*
* Routing statistics.
*/
short rts_newgateway; /* routes modified by redirects */
short rts_unreach; /* lookups which failed */
short rts_wildcard; /* lookups satisfied by a wildcard */
+ short rts_badrtgwroute; /* route to gateway is not direct */
};
+
/*
* Structures for routing messages.
*/
int rtm_seq; /* for sender to identify action */
int rtm_errno; /* why failed */
int rtm_use; /* from rtentry */
- u_long rtm_inits; /* which metrics we are initializing */
- struct rt_metrics rtm_rmx; /* metrics themselves */
+ u_int32_t rtm_inits; /* which metrics we are initializing */
+ struct rt_metrics rtm_rmx; /* metrics themselves */
};
-#define RTM_VERSION 5 /* Up the ante and ignore older versions */
+struct rt_msghdr2 {
+ u_short rtm_msglen; /* to skip over non-understood messages */
+ u_char rtm_version; /* future binary compatibility */
+ u_char rtm_type; /* message type */
+ u_short rtm_index; /* index for associated ifp */
+ int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
+ int rtm_addrs; /* bitmask identifying sockaddrs in msg */
+ int32_t rtm_refcnt; /* reference count */
+ int rtm_parentflags; /* flags of the parent route */
+ int rtm_reserved; /* reserved field set to 0 */
+ int rtm_use; /* from rtentry */
+ u_int32_t rtm_inits; /* which metrics we are initializing */
+ struct rt_metrics rtm_rmx; /* metrics themselves */
+};
+
+#ifdef PRIVATE
+struct kev_netevent_apnfallbk_data {
+ pid_t epid; /* effective PID */
+ uuid_t euuid; /* effective UUID */
+};
+
+/*
+ * Route reachability info.
+ */
+struct rt_reach_info {
+ u_int32_t ri_refcnt; /* reference count */
+ u_int32_t ri_probes; /* total # of probes */
+ u_int64_t ri_snd_expire; /* tx expiration (calendar) time */
+ u_int64_t ri_rcv_expire; /* rx expiration (calendar) time */
+ int32_t ri_rssi; /* received signal strength */
+ int32_t ri_lqm; /* link quality metric */
+ int32_t ri_npm; /* node proximity metric */
+};
+
+/*
+ * Extended routing message header (private).
+ */
+struct rt_msghdr_ext {
+ u_short rtm_msglen; /* to skip over non-understood messages */
+ u_char rtm_version; /* future binary compatibility */
+ u_char rtm_type; /* message type */
+ u_int32_t rtm_index; /* index for associated ifp */
+ u_int32_t rtm_flags; /* flags, incl. kern & message, e.g. DONE */
+ u_int32_t rtm_reserved; /* for future use */
+ u_int32_t rtm_addrs; /* bitmask identifying sockaddrs in msg */
+ pid_t rtm_pid; /* identify sender */
+ int rtm_seq; /* for sender to identify action */
+ int rtm_errno; /* why failed */
+ u_int32_t rtm_use; /* from rtentry */
+ u_int32_t rtm_inits; /* which metrics we are initializing */
+ struct rt_metrics rtm_rmx; /* metrics themselves */
+ struct rt_reach_info rtm_ri; /* route reachability info */
+};
+#endif /* PRIVATE */
+
+#define RTM_VERSION 5 /* Up the ante and ignore older versions */
/*
* Message types.
*/
-#define RTM_ADD 0x1 /* Add Route */
-#define RTM_DELETE 0x2 /* Delete Route */
-#define RTM_CHANGE 0x3 /* Change Metrics or flags */
-#define RTM_GET 0x4 /* Report Metrics */
-#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
-#define RTM_REDIRECT 0x6 /* Told to use different route */
-#define RTM_MISS 0x7 /* Lookup failed on this address */
-#define RTM_LOCK 0x8 /* fix specified metrics */
-#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
-#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
-#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
-#define RTM_NEWADDR 0xc /* address being added to iface */
-#define RTM_DELADDR 0xd /* address being removed from iface */
-#define RTM_IFINFO 0xe /* iface going up/down etc. */
+#define RTM_ADD 0x1 /* Add Route */
+#define RTM_DELETE 0x2 /* Delete Route */
+#define RTM_CHANGE 0x3 /* Change Metrics or flags */
+#define RTM_GET 0x4 /* Report Metrics */
+#define RTM_LOSING 0x5 /* RTM_LOSING is no longer generated by xnu
+ and is deprecated */
+#define RTM_REDIRECT 0x6 /* Told to use different route */
+#define RTM_MISS 0x7 /* Lookup failed on this address */
+#define RTM_LOCK 0x8 /* fix specified metrics */
+#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
+#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
+#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
+#define RTM_NEWADDR 0xc /* address being added to iface */
+#define RTM_DELADDR 0xd /* address being removed from iface */
+#define RTM_IFINFO 0xe /* iface going up/down etc. */
#define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
#define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
+#ifdef PRIVATE
+#define RTM_GET_SILENT 0x11
+#endif /* PRIVATE */
+#define RTM_IFINFO2 0x12 /* */
+#define RTM_NEWMADDR2 0x13 /* */
+#define RTM_GET2 0x14 /* */
+#ifdef PRIVATE
+#define RTM_GET_EXT 0x15
+#endif /* PRIVATE */
/*
* Bitmask values for rtm_inits and rmx_locks.
*/
-#define RTV_MTU 0x1 /* init or lock _mtu */
-#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
-#define RTV_EXPIRE 0x4 /* init or lock _expire */
-#define RTV_RPIPE 0x8 /* init or lock _recvpipe */
-#define RTV_SPIPE 0x10 /* init or lock _sendpipe */
-#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
-#define RTV_RTT 0x40 /* init or lock _rtt */
-#define RTV_RTTVAR 0x80 /* init or lock _rttvar */
+#define RTV_MTU 0x1 /* init or lock _mtu */
+#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
+#define RTV_EXPIRE 0x4 /* init or lock _expire */
+#define RTV_RPIPE 0x8 /* init or lock _recvpipe */
+#define RTV_SPIPE 0x10 /* init or lock _sendpipe */
+#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
+#define RTV_RTT 0x40 /* init or lock _rtt */
+#define RTV_RTTVAR 0x80 /* init or lock _rttvar */
+#ifdef PRIVATE
+#define RTV_REFRESH_HOST 0x100 /* init host route to expedite refresh */
+#endif
/*
* Bitmask values for rtm_addrs.
*/
-#define RTA_DST 0x1 /* destination sockaddr present */
-#define RTA_GATEWAY 0x2 /* gateway sockaddr present */
-#define RTA_NETMASK 0x4 /* netmask sockaddr present */
-#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
-#define RTA_IFP 0x10 /* interface name sockaddr present */
-#define RTA_IFA 0x20 /* interface addr sockaddr present */
-#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
-#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
+#define RTA_DST 0x1 /* destination sockaddr present */
+#define RTA_GATEWAY 0x2 /* gateway sockaddr present */
+#define RTA_NETMASK 0x4 /* netmask sockaddr present */
+#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
+#define RTA_IFP 0x10 /* interface name sockaddr present */
+#define RTA_IFA 0x20 /* interface addr sockaddr present */
+#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
+#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
/*
* Index offsets for sockaddr array for alternate internal encoding.
*/
-#define RTAX_DST 0 /* destination sockaddr present */
-#define RTAX_GATEWAY 1 /* gateway sockaddr present */
-#define RTAX_NETMASK 2 /* netmask sockaddr present */
-#define RTAX_GENMASK 3 /* cloning mask sockaddr present */
-#define RTAX_IFP 4 /* interface name sockaddr present */
-#define RTAX_IFA 5 /* interface addr sockaddr present */
-#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
-#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
-#define RTAX_MAX 8 /* size of array to allocate */
+#define RTAX_DST 0 /* destination sockaddr present */
+#define RTAX_GATEWAY 1 /* gateway sockaddr present */
+#define RTAX_NETMASK 2 /* netmask sockaddr present */
+#define RTAX_GENMASK 3 /* cloning mask sockaddr present */
+#define RTAX_IFP 4 /* interface name sockaddr present */
+#define RTAX_IFA 5 /* interface addr sockaddr present */
+#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
+#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
+#define RTAX_MAX 8 /* size of array to allocate */
struct rt_addrinfo {
int rti_addrs;
struct sockaddr *rti_info[RTAX_MAX];
};
-struct route_cb {
- int ip_count;
- int ip6_count;
- int ipx_count;
- int ns_count;
- int iso_count;
- int any_count;
-};
+#ifdef PRIVATE
+/*
+ * For scoped routing; a zero interface scope value means nil/no scope.
+ */
+#define IFSCOPE_NONE 0
+#endif /* PRIVATE */
+
+#ifdef BSD_KERNEL_PRIVATE
+/*
+ * Generic call trace used by some subsystems (e.g. route, ifaddr)
+ */
+#define CTRACE_STACK_SIZE 8 /* depth of stack trace */
+#define CTRACE_HIST_SIZE 4 /* refcnt history size */
+typedef struct ctrace {
+ void *th; /* thread ptr */
+ void *pc[CTRACE_STACK_SIZE]; /* PC stack trace */
+} ctrace_t;
+
+extern void ctrace_record(ctrace_t *);
+
+#define RT_LOCK_ASSERT_HELD(_rt) \
+ LCK_MTX_ASSERT(&(_rt)->rt_lock, LCK_MTX_ASSERT_OWNED)
+
+#define RT_LOCK_ASSERT_NOTHELD(_rt) \
+ LCK_MTX_ASSERT(&(_rt)->rt_lock, LCK_MTX_ASSERT_NOTOWNED)
+
+#define RT_LOCK(_rt) do { \
+ rt_lock(_rt, FALSE); \
+} while (0)
+
+#define RT_LOCK_SPIN(_rt) do { \
+ rt_lock(_rt, TRUE); \
+} while (0)
+
+#define RT_CONVERT_LOCK(_rt) do { \
+ RT_LOCK_ASSERT_HELD(_rt); \
+ lck_mtx_convert_spin(&(_rt)->rt_lock); \
+} while (0)
+
+#define RT_UNLOCK(_rt) do { \
+ rt_unlock(_rt); \
+} while (0)
+
+#define RT_ADDREF_LOCKED(_rt) do { \
+ rtref(_rt); \
+} while (0)
+
+/*
+ * Spin variant mutex is used here; caller is responsible for
+ * converting any previously-held similar lock to full mutex.
+ */
+#define RT_ADDREF(_rt) do { \
+ RT_LOCK_SPIN(_rt); \
+ RT_ADDREF_LOCKED(_rt); \
+ RT_UNLOCK(_rt); \
+} while (0)
+
+#define RT_REMREF_LOCKED(_rt) do { \
+ (void) rtunref(_rt); \
+} while (0)
+
+/*
+ * Spin variant mutex is used here; caller is responsible for
+ * converting any previously-held similar lock to full mutex.
+ */
+#define RT_REMREF(_rt) do { \
+ RT_LOCK_SPIN(_rt); \
+ RT_REMREF_LOCKED(_rt); \
+ RT_UNLOCK(_rt); \
+} while (0)
-#ifdef KERNEL
-#define RTFREE(rt) \
- if ((rt)->rt_refcnt <= 1) \
- rtfree(rt); \
- else \
- (rt)->rt_refcnt--;
-#define RTHOLD(rt) { \
- if (++(rt)->rt_refcnt <= 0) \
- panic("RTHOLD"); \
-}
-
-extern struct route_cb route_cb;
+/*
+ * This macro calculates skew in wall clock, just in case the user changes the
+ * system time. This skew adjustment is required because we now keep the
+ * expiration times in uptime terms in the kernel, but the userland still
+ * expects expiration times in terms of calendar times. This is used when
+ * reporting rt_expire, ln_expire, etc. values to user space.
+ */
+#define NET_CALCULATE_CLOCKSKEW(cc, ic, cu, iu) \
+ ((cc.tv_sec - ic) - (cu - iu))
+
+extern unsigned int rt_verbose;
extern struct radix_node_head *rt_tables[AF_MAX+1];
+extern lck_mtx_t *rnh_lock;
+extern uint32_t route_genid_inet; /* INET route generation count */
+#if INET6
+extern uint32_t route_genid_inet6; /* INET6 route generation count */
+#endif /* INET6 */
+extern int rttrash;
+extern unsigned int rte_debug;
struct ifmultiaddr;
struct proc;
-void route_init __P((void));
-void rt_ifmsg __P((struct ifnet *));
-void rt_missmsg __P((int, struct rt_addrinfo *, int, int));
-void rt_newaddrmsg __P((int, struct ifaddr *, int, struct rtentry *));
-void rt_newmaddrmsg __P((int, struct ifmultiaddr *));
-int rt_setgate __P((struct rtentry *,
- struct sockaddr *, struct sockaddr *));
-void rtalloc __P((struct route *));
-void rtalloc_ign __P((struct route *, unsigned long));
-struct rtentry *
- rtalloc1 __P((struct sockaddr *, int, unsigned long));
-void rtfree __P((struct rtentry *));
-int rtinit __P((struct ifaddr *, int, int));
-int rtioctl __P((int, caddr_t, struct proc *));
-void rtredirect __P((struct sockaddr *, struct sockaddr *,
- struct sockaddr *, int, struct sockaddr *, struct rtentry **));
-int rtrequest __P((int, struct sockaddr *,
- struct sockaddr *, struct sockaddr *, int, struct rtentry **));
-#endif
+extern void route_init(void);
+extern void routegenid_update(void);
+extern void routegenid_inet_update(void);
+extern void routegenid_inet6_update(void);
+extern void rt_ifmsg(struct ifnet *);
+extern void rt_missmsg(int, struct rt_addrinfo *, int, int);
+extern void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
+extern void rt_newmaddrmsg(int, struct ifmultiaddr *);
+extern int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
+extern void set_primary_ifscope(int, unsigned int);
+extern unsigned int get_primary_ifscope(int);
+extern boolean_t rt_primary_default(struct rtentry *, struct sockaddr *);
+extern struct rtentry *rt_lookup(boolean_t, struct sockaddr *,
+ struct sockaddr *, struct radix_node_head *, unsigned int);
+extern struct rtentry *rt_lookup_coarse(boolean_t, struct sockaddr *,
+ struct sockaddr *, struct radix_node_head *);
+extern void rtalloc(struct route *);
+extern void rtalloc_scoped(struct route *, unsigned int);
+extern void rtalloc_ign(struct route *, uint32_t);
+extern void rtalloc_scoped_ign(struct route *, uint32_t, unsigned int);
+extern struct rtentry *rtalloc1(struct sockaddr *, int, uint32_t);
+extern struct rtentry *rtalloc1_scoped(struct sockaddr *, int, uint32_t,
+ unsigned int);
+extern struct rtentry *rtalloc1_scoped_locked(struct sockaddr *, int,
+ uint32_t, unsigned int);
+extern void rtfree_locked(struct rtentry *);
+extern void rtfree(struct rtentry *);
+extern void rtref(struct rtentry *);
+/*
+ * rtunref will decrement the refcount, rtfree will decrement and free if
+ * the refcount has reached zero and the route is not up.
+ * Unless you have good reason to do otherwise, use rtfree.
+ */
+extern int rtunref(struct rtentry *);
+extern void rtsetifa(struct rtentry *, struct ifaddr *);
+extern int rtinit(struct ifaddr *, int, int);
+extern int rtinit_locked(struct ifaddr *, int, int);
+extern int rtioctl(unsigned long, caddr_t, struct proc *);
+extern void rtredirect(struct ifnet *, struct sockaddr *, struct sockaddr *,
+ struct sockaddr *, int, struct sockaddr *, struct rtentry **);
+extern int rtrequest(int, struct sockaddr *,
+ struct sockaddr *, struct sockaddr *, int, struct rtentry **);
+extern int rtrequest_scoped(int, struct sockaddr *, struct sockaddr *,
+ struct sockaddr *, int, struct rtentry **, unsigned int);
+extern int rtrequest_locked(int, struct sockaddr *,
+ struct sockaddr *, struct sockaddr *, int, struct rtentry **);
+extern int rtrequest_scoped_locked(int, struct sockaddr *, struct sockaddr *,
+ struct sockaddr *, int, struct rtentry **, unsigned int);
+extern void sin_set_ifscope(struct sockaddr *, unsigned int);
+extern unsigned int sin_get_ifscope(struct sockaddr *);
+extern unsigned int sin6_get_ifscope(struct sockaddr *);
+extern void rt_lock(struct rtentry *, boolean_t);
+extern void rt_unlock(struct rtentry *);
+extern struct sockaddr *rtm_scrub(int, int, struct sockaddr *,
+ struct sockaddr *, void *, uint32_t, kauth_cred_t *);
+extern boolean_t rt_validate(struct rtentry *);
+extern void rt_set_proxy(struct rtentry *, boolean_t);
+extern void rt_set_gwroute(struct rtentry *, struct sockaddr *,
+ struct rtentry *);
+extern void rt_revalidate_gwroute(struct rtentry *, struct rtentry *);
+extern errno_t route_to_gwroute(const struct sockaddr *, struct rtentry *,
+ struct rtentry **);
+extern void rt_setexpire(struct rtentry *, uint64_t);
+extern void rt_str(struct rtentry *, char *, uint32_t, char *, uint32_t);
+extern const char *rtm2str(int);
+extern void route_copyin(struct route *, struct route *, size_t);
+extern void route_copyout(struct route *, const struct route *, size_t);
+extern boolean_t rt_ifa_is_dst(struct sockaddr *, struct ifaddr *);
+extern struct sockaddr *sa_copy(struct sockaddr *, struct sockaddr_storage *,
+ unsigned int *);
-#endif
+/*
+ * The following is used to enqueue work items for route events
+ * and also used to pass route event while walking the tree
+ */
+struct route_event {
+ struct rtentry *rt;
+ /*
+ * There's no reference taken on gwrt.
+ * We only use it to check whether we should
+ * point to rt_gateway or the embedded rt_addr
+ * structure.
+ */
+ struct rtentry *gwrt;
+ union {
+ union sockaddr_in_4_6 _rtev_ipaddr;
+ struct sockaddr_dl _rtev_lladdr;
+ char _rtev_addr_bytes[DLIL_SDLMAXLEN];
+ } rt_addr;
+ uint32_t route_event_code;
+ eventhandler_tag evtag;
+};
+
+#define rtev_ipaddr rt_addr._rtev_ipaddr
+#define rtev_lladdr rt_addr._rtev_lladdr
+#define rtev_addr_bytes rt_addr._rtev_addr_bytes
+
+extern void route_event_init(struct route_event *p_route_ev, struct rtentry *rt,
+ struct rtentry *gwrt, int route_ev_code);
+extern int route_event_walktree(struct radix_node *rn, void *arg);
+extern void route_event_enqueue_nwk_wq_entry(struct rtentry *, struct rtentry *,
+ uint32_t, eventhandler_tag, boolean_t);
+#endif /* BSD_KERNEL_PRIVATE */
+#endif /* _NET_ROUTE_H_ */
projects / apple / xnu.git / blobdiff