]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/net/if_llreach.h
xnu-1699.22.73.tar.gz
[apple/xnu.git] / bsd / net / if_llreach.h
diff --git a/bsd/net/if_llreach.h b/bsd/net/if_llreach.h
new file mode 100644 (file)
index 0000000..e922fb0
--- /dev/null
@@ -0,0 +1,150 @@
+/*
+ * Copyright (c) 2011 Apple Inc. All rights reserved.
+ *
+ * @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, 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@
+ */
+
+#ifndef        _NET_IF_LLREACH_H_
+#define        _NET_IF_LLREACH_H_
+
+#ifdef PRIVATE
+#ifdef  __cplusplus
+extern "C" {
+#endif
+
+#include <sys/types.h>
+
+/*
+ * Per-interface link-layer reachability information (private).
+ */
+#define        IF_LLREACHINFO_ADDRLEN  64              /* max ll addr len */
+
+struct if_llreach_info {
+       u_int32_t               lri_refcnt;     /* reference count */
+       u_int32_t               lri_ifindex;    /* interface index */
+       u_int64_t               lri_expire;     /* expiration (calendar) time */
+       u_int32_t               lri_probes;     /* total # of probes */
+       u_int16_t               lri_reserved;   /* for future use */
+       u_int16_t               lri_proto;      /* ll proto */
+       u_int8_t                lri_addr[IF_LLREACHINFO_ADDRLEN]; /* ll addr */
+};
+
+#ifdef XNU_KERNEL_PRIVATE
+#include <sys/tree.h>
+#include <kern/lock.h>
+#include <net/ethernet.h>
+#include <netinet/in.h>
+#if INET6
+#include <netinet6/in6_var.h>
+#include <netinet6/nd6.h>
+#endif /* INET6 */
+
+/*
+ * Link-layer reachability is based off node constants in RFC4861.
+ */
+#if INET6
+#define        LL_BASE_REACHABLE       REACHABLE_TIME
+#else
+#define        LL_BASE_REACHABLE       30000   /* msec */
+#endif /* !INET6 */
+
+/*
+ * Per-interface link-layer reachability.  (Currently only for ARP/Ethernet.)
+ */
+#define        IF_LLREACH_MAXLEN       ETHER_ADDR_LEN
+
+struct if_llreach {
+       decl_lck_mtx_data(, lr_lock);
+       RB_ENTRY(if_llreach)    lr_link;        /* RB tree links */
+       struct ifnet            *lr_ifp;        /* back pointer to ifnet */
+       u_int32_t               lr_refcnt;      /* reference count */
+       u_int32_t               lr_reqcnt;      /* RB tree request count */
+       u_int32_t               lr_debug;       /* see ifa_debug flags */
+       u_int32_t               lr_probes;      /* number of probes so far */
+       u_int64_t               lr_basecal;     /* base calendar time */
+       u_int64_t               lr_baseup;      /* base uptime */
+       u_int64_t               lr_lastrcvd;    /* last-heard-of timestamp */
+       u_int32_t               lr_basereachable; /* baseline time */
+       u_int32_t               lr_reachable;   /* reachable time */
+       struct lr_key_s {
+               u_int16_t       proto;          /* ll proto */
+               u_int8_t        addr[IF_LLREACH_MAXLEN]; /* ll addr */
+       } lr_key;
+};
+
+RB_PROTOTYPE_SC_PREV(__private_extern__, ll_reach_tree, if_llreach,
+    ls_link, ifllr_cmp);
+
+#define        IFLR_LOCK_ASSERT_HELD(_iflr)                                    \
+       lck_mtx_assert(&(_iflr)->lr_lock, LCK_MTX_ASSERT_OWNED)
+
+#define        IFLR_LOCK_ASSERT_NOTHELD(_iflr)                         \
+       lck_mtx_assert(&(_iflr)->lr_lock, LCK_MTX_ASSERT_NOTOWNED)
+
+#define        IFLR_LOCK(_iflr)                                                \
+       lck_mtx_lock(&(_iflr)->lr_lock)
+
+#define        IFLR_LOCK_SPIN(_iflr)                                           \
+       lck_mtx_lock_spin(&(_iflr)->lr_lock)
+
+#define        IFLR_CONVERT_LOCK(_iflr) do {                                   \
+       IFLR_LOCK_ASSERT_HELD(_iflr);                                   \
+       lck_mtx_convert_spin(&(_iflr)->lr_lock);                        \
+} while (0)
+
+#define        IFLR_UNLOCK(_iflr)                                              \
+       lck_mtx_unlock(&(_iflr)->lr_lock)
+
+#define        IFLR_ADDREF(_iflr)                                              \
+       iflr_addref(_iflr, 0)
+
+#define        IFLR_ADDREF_LOCKED(_iflr)                                       \
+       iflr_addref(_iflr, 1)
+
+#define        IFLR_REMREF(_iflr)                                              \
+       iflr_remref(_iflr)
+
+extern void ifnet_llreach_init(void);
+extern void ifnet_llreach_ifattach(struct ifnet *, boolean_t);
+extern void ifnet_llreach_ifdetach(struct ifnet *);
+extern struct if_llreach *ifnet_llreach_alloc(struct ifnet *, u_int16_t, void *,
+    unsigned int, u_int64_t);
+extern void ifnet_llreach_free(struct if_llreach *);
+extern int ifnet_llreach_reachable(struct if_llreach *);
+extern int ifnet_llreach_reachable_delta(struct if_llreach *, u_int64_t);
+extern void ifnet_llreach_set_reachable(struct ifnet *, u_int16_t, void *,
+    unsigned int);
+extern u_int64_t ifnet_llreach_up2cal(struct if_llreach *, u_int64_t);
+extern void ifnet_lr2ri(struct if_llreach *, struct rt_reach_info *);
+extern void ifnet_lr2lri(struct if_llreach *, struct if_llreach_info *);
+extern void iflr_addref(struct if_llreach *, int);
+extern void iflr_remref(struct if_llreach *);
+#endif /* XNU_KERNEL_PRIVATE */
+
+#ifdef  __cplusplus
+}
+#endif
+#endif /* PRIVATE */
+#endif /* !_NET_IF_LLREACH_H_ */