]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/net/dlil.h
xnu-2782.40.9.tar.gz
[apple/xnu.git] / bsd / net / dlil.h
index e91dc7a018bf848778bdf2e42a787e41c5467231..da72b75f3b1e4a6d317812ca1c4e9af0124b095b 100644 (file)
@@ -1,8 +1,8 @@
 /*
- * Copyright (c) 2009 Apple Inc. All rights reserved.
+ * Copyright (c) 1999-2013 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
  * 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,
  * 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) 1999 Apple Computer, Inc. 
  *
- *     Data Link Inteface Layer
- *     Author: Ted Walker
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 #ifndef DLIL_H
-#define DLIL_H
+#define        DLIL_H
 #ifdef KERNEL
 
 #include <sys/kernel_types.h>
@@ -45,10 +39,6 @@ enum {
        BPF_TAP_INPUT_OUTPUT
 };
 
-/* Ethernet specific types */
-#define DLIL_DESC_ETYPE2       4
-#define DLIL_DESC_SAP          5
-#define DLIL_DESC_SNAP         6
 /*
  * DLIL_DESC_ETYPE2 - native_type must point to 2 byte ethernet raw protocol,
  *                    variants.native_type_length must be set to 2
@@ -64,49 +54,143 @@ enum {
  * The length of the protocol data specified at native_type must be set in
  * variants.native_type_length.
  */
+/* Ethernet specific types */
+#define        DLIL_DESC_ETYPE2        4
+#define        DLIL_DESC_SAP           5
+#define        DLIL_DESC_SNAP          6
 
 #ifdef KERNEL_PRIVATE
-
 #include <net/if.h>
 #include <net/if_var.h>
+#include <net/classq/classq.h>
+#include <net/flowadv.h>
 #include <sys/kern_event.h>
 #include <kern/thread.h>
 #include <kern/locks.h>
 
-#if __STDC__
+#ifdef BSD_KERNEL_PRIVATE
+/* Operations on timespecs. */
+#define        net_timerclear(tvp)     (tvp)->tv_sec = (tvp)->tv_nsec = 0
+
+#define        net_timerisset(tvp)     ((tvp)->tv_sec || (tvp)->tv_nsec)
+
+#define        net_timercmp(tvp, uvp, cmp)                                     \
+       (((tvp)->tv_sec == (uvp)->tv_sec) ?                             \
+       ((tvp)->tv_nsec cmp (uvp)->tv_nsec) :                           \
+       ((tvp)->tv_sec cmp (uvp)->tv_sec))
+
+#define        net_timeradd(tvp, uvp, vvp) do {                                \
+       (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;                  \
+       (vvp)->tv_nsec = (tvp)->tv_nsec + (uvp)->tv_nsec;               \
+       if ((vvp)->tv_nsec >= (long)NSEC_PER_SEC) {                     \
+               (vvp)->tv_sec++;                                        \
+               (vvp)->tv_nsec -= NSEC_PER_SEC;                         \
+       }                                                               \
+} while (0)
+
+#define        net_timersub(tvp, uvp, vvp) do {                                \
+       (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;                  \
+       (vvp)->tv_nsec = (tvp)->tv_nsec - (uvp)->tv_nsec;               \
+       if ((vvp)->tv_nsec < 0) {                                       \
+               (vvp)->tv_sec--;                                        \
+               (vvp)->tv_nsec += NSEC_PER_SEC;                         \
+       }                                                               \
+} while (0)
+
+#define        net_timernsec(tvp, nsp) do {                                    \
+       *(nsp) = (tvp)->tv_nsec;                                        \
+       if ((tvp)->tv_sec > 0)                                          \
+               *(nsp) += ((tvp)->tv_sec * (integer_t)NSEC_PER_SEC);            \
+} while (0)
+
+#define        net_nsectimer(nsp, tvp) do {                                    \
+       u_int64_t __nsp = *(nsp);                                       \
+       net_timerclear(tvp);                                            \
+       while ((__nsp) >= NSEC_PER_SEC) {                               \
+               (tvp)->tv_sec++;                                        \
+               (__nsp) -= NSEC_PER_SEC;                                \
+       }                                                               \
+       (tvp)->tv_nsec = (__nsp);                                       \
+} while (0)
 
 struct ifnet;
 struct mbuf;
 struct ether_header;
 struct sockaddr_dl;
-
-#endif
-
-#ifdef BSD_KERNEL_PRIVATE
-struct ifnet_stat_increment_param;
 struct iff_filter;
 
+#define        DLIL_THREADNAME_LEN     32
+
+/*
+ * DLIL input thread info
+ */
 struct dlil_threading_info {
-       mbuf_t          mbuf_head;      /* start of mbuf list from if */
-       mbuf_t          mbuf_tail;
-       u_int32_t       mbuf_count;
-       boolean_t       net_affinity;   /* affinity set is available */
-       u_int32_t       input_waiting;  /* DLIL condition of thread */
-       struct thread   *input_thread;  /* thread data for this input */
-       struct thread   *workloop_thread; /* current workloop thread */
-       u_int32_t       tag;            /* current affinity tag */
-       lck_mtx_t       *input_lck;     
+       decl_lck_mtx_data(, input_lck);
        lck_grp_t       *lck_grp;       /* lock group (for lock stats) */
-       char            input_name[32];          
+       u_int32_t       input_waiting;  /* DLIL condition of thread */
+       u_int32_t       wtot;           /* # of wakeup requests */
+       char            input_name[DLIL_THREADNAME_LEN]; /* name storage */
+       struct ifnet    *ifp;           /* pointer to interface */
+       class_queue_t   rcvq_pkts;      /* queue of pkts */
+       struct ifnet_stat_increment_param stats; /* incremental statistics */
+       /*
+        * Thread affinity (workloop and DLIL threads).
+        */
+       boolean_t       net_affinity;   /* affinity set is available */
+       struct thread   *input_thr;     /* input thread */
+       struct thread   *wloop_thr;     /* workloop thread */
+       struct thread   *poll_thr;      /* poll thread */
+       u_int32_t       tag;            /* affinity tag */
+       /*
+        * Opportunistic polling.
+        */
+       ifnet_model_t   mode;           /* current mode */
+       struct pktcntr  tstats;         /* incremental polling statistics */
+       struct if_rxpoll_stats pstats;  /* polling statistics */
+#define        rxpoll_offreq   pstats.ifi_poll_off_req
+#define        rxpoll_offerr   pstats.ifi_poll_off_err
+#define        rxpoll_onreq    pstats.ifi_poll_on_req
+#define        rxpoll_onerr    pstats.ifi_poll_on_err
+#define        rxpoll_wavg     pstats.ifi_poll_wakeups_avg
+#define        rxpoll_wlowat   pstats.ifi_poll_wakeups_lowat
+#define        rxpoll_whiwat   pstats.ifi_poll_wakeups_hiwat
+#define        rxpoll_pavg     pstats.ifi_poll_packets_avg
+#define        rxpoll_pmin     pstats.ifi_poll_packets_min
+#define        rxpoll_pmax     pstats.ifi_poll_packets_max
+#define        rxpoll_plowat   pstats.ifi_poll_packets_lowat
+#define        rxpoll_phiwat   pstats.ifi_poll_packets_hiwat
+#define        rxpoll_bavg     pstats.ifi_poll_bytes_avg
+#define        rxpoll_bmin     pstats.ifi_poll_bytes_min
+#define        rxpoll_bmax     pstats.ifi_poll_bytes_max
+#define        rxpoll_blowat   pstats.ifi_poll_bytes_lowat
+#define        rxpoll_bhiwat   pstats.ifi_poll_bytes_hiwat
+#define        rxpoll_plim     pstats.ifi_poll_packets_limit
+#define        rxpoll_ival     pstats.ifi_poll_interval_time
+       struct pktcntr  sstats;         /* packets and bytes per sampling */
+       struct timespec mode_holdtime;  /* mode holdtime in nsec */
+       struct timespec mode_lasttime;  /* last mode change time in nsec */
+       struct timespec sample_holdtime; /* sampling holdtime in nsec */
+       struct timespec sample_lasttime; /* last sampling time in nsec */
+       struct timespec dbg_lasttime;   /* last debug message time in nsec */
 #if IFNET_INPUT_SANITY_CHK
-       u_int32_t       input_wake_cnt; /* number of times the thread was awaken with packets to process */
-       u_long          input_mbuf_cnt; /* total number of mbuf packets processed by this thread */
+       /*
+        * For debugging.
+        */
+       u_int64_t       input_mbuf_cnt; /* total # of packets processed */
 #endif
 };
 
 /*
-       The following are shared with kpi_protocol.c so that it may wakeup
-       the input thread to run through packets queued for protocol input.
+ * DLIL input thread info (for main/loopback input thread)
+ */
+struct dlil_main_threading_info {
+       struct dlil_threading_info      inp;
+       class_queue_t                   lo_rcvq_pkts; /* queue of lo0 pkts */
+};
+
+/*
+ * The following are shared with kpi_protocol.c so that it may wakeup
+ * the input thread to run through packets queued for protocol input.
 */
 #define        DLIL_INPUT_RUNNING      0x80000000
 #define        DLIL_INPUT_WAITING      0x40000000
@@ -114,80 +198,144 @@ struct dlil_threading_info {
 #define        DLIL_PROTO_WAITING      0x10000000
 #define        DLIL_INPUT_TERMINATE    0x08000000
 
-void dlil_init(void);
+/*
+ * Flags for dlil_attach_filter()
+ */
+#define DLIL_IFF_TSO            0x01    /* Interface filter supports TSO */
 
-errno_t dlil_set_bpf_tap(ifnet_t ifp, bpf_tap_mode mode,
-                                                bpf_packet_func callback);
+extern int dlil_verbose;
+extern uint32_t hwcksum_dbg;
+extern uint32_t hwcksum_tx;
+extern uint32_t hwcksum_rx;
+extern struct dlil_threading_info *dlil_main_input_thread;
+
+extern void dlil_init(void);
+
+extern errno_t ifp_if_ioctl(struct ifnet *, unsigned long, void *);
+
+extern errno_t dlil_set_bpf_tap(ifnet_t, bpf_tap_mode, bpf_packet_func);
 
 /*
- * Send arp internal bypasses the check for
- * IPv4LL.
+ * Send arp internal bypasses the check for IPv4LL.
  */
-errno_t
-dlil_send_arp_internal(
-       ifnet_t ifp,
-       u_int16_t arpop,
-       const struct sockaddr_dl* sender_hw,
-       const struct sockaddr* sender_proto,
-       const struct sockaddr_dl* target_hw,
-       const struct sockaddr* target_proto);
-
-int
-dlil_output(
-       ifnet_t                                 ifp,
-       protocol_family_t               proto_family,
-       mbuf_t                                  packetlist,
-       void                                    *route,
-       const struct sockaddr   *dest,
-       int                                             raw);
-
-errno_t
-dlil_resolve_multi(
-       struct ifnet *ifp,
-       const struct sockaddr *proto_addr,
-       struct sockaddr *ll_addr,
-       size_t ll_len);
-
-errno_t
-dlil_send_arp(
-       ifnet_t ifp,
-       u_int16_t arpop,
-       const struct sockaddr_dl* sender_hw,
-       const struct sockaddr* sender_proto,
-       const struct sockaddr_dl* target_hw,
-       const struct sockaddr* target_proto);
-
-int dlil_attach_filter(ifnet_t ifp, const struct iff_filter *if_filter,
-                                          interface_filter_t *filter_ref);
-void dlil_detach_filter(interface_filter_t filter);
-int dlil_detach_protocol(ifnet_t ifp, u_int32_t protocol);
+extern errno_t dlil_send_arp_internal(ifnet_t, u_int16_t,
+    const struct sockaddr_dl *, const struct sockaddr *,
+    const struct sockaddr_dl *, const struct sockaddr *);
+
+/*
+ * The following constants are used with the net_thread_mark_apply and
+ * net_thread_is_unmarked functions to control the bits in the uu_network_marks
+ * field of the uthread structure.
+ */
+#define        NET_THREAD_HELD_PF      0x1     /* thread is holding PF lock */
+#define        NET_THREAD_HELD_DOMAIN  0x2     /* thread is holding domain_proto_mtx */
+#define        NET_THREAD_CKREQ_LLADDR 0x4     /* thread reqs MACF check for LLADDR */
+
+/*
+ * net_thread_marks_t is a pointer to a phantom structure type used for
+ * manipulating the uthread:uu_network_marks field.  As an example...
+ *
+ *   static const u_int32_t bits = NET_THREAD_CKREQ_LLADDR;
+ *   struct uthread *uth = get_bsdthread_info(current_thread());
+ *
+ *   net_thread_marks_t marks = net_thread_marks_push(bits);
+ *   VERIFY((uth->uu_network_marks & NET_THREAD_CKREQ_LLADDR) != 0);
+ *   net_thread_marks_pop(marks);
+ *
+ * The net_thread_marks_push() function returns an encoding of the bits
+ * that were changed from zero to one in the uu_network_marks field. When
+ * the net_thread_marks_pop() function later processes that value, it
+ * resets the bits to their previous value.
+ *
+ * The net_thread_unmarks_push() and net_thread_unmarks_pop() functions
+ * are similar to net_thread_marks_push() and net_thread_marks_pop() except
+ * they clear the marks bits in the guarded section rather than set them.
+ *
+ * The net_thread_is_marked() and net_thread_is_unmarked() functions return
+ * the subset of the bits that are currently set or cleared (respectively)
+ * in the uthread:uu_network_marks field.
+ *
+ * Finally, the value of the net_thread_marks_none constant is provided for
+ * comparing for equality with the value returned when no bits in the marks
+ * field are changed by the push.
+ *
+ * It is not significant that a value of type net_thread_marks_t may
+ * compare as equal to the NULL pointer.
+ */
+struct net_thread_marks;
+typedef const struct net_thread_marks *net_thread_marks_t;
+
+extern const net_thread_marks_t net_thread_marks_none;
+
+extern net_thread_marks_t net_thread_marks_push(u_int32_t);
+extern net_thread_marks_t net_thread_unmarks_push(u_int32_t);
+extern void net_thread_marks_pop(net_thread_marks_t);
+extern void net_thread_unmarks_pop(net_thread_marks_t);
+extern u_int32_t net_thread_is_marked(u_int32_t);
+extern u_int32_t net_thread_is_unmarked(u_int32_t);
+
+extern int dlil_output(ifnet_t, protocol_family_t, mbuf_t, void *,
+    const struct sockaddr *, int, struct flowadv *);
+
+extern void dlil_input_packet_list(struct ifnet *, struct mbuf *);
+extern void dlil_input_packet_list_extended(struct ifnet *, struct mbuf *,
+    u_int32_t, ifnet_model_t);
+
+extern errno_t dlil_resolve_multi(struct ifnet *,
+    const struct sockaddr *, struct sockaddr *, size_t);
+
+extern errno_t dlil_send_arp(ifnet_t, u_int16_t, const struct sockaddr_dl *,
+    const struct sockaddr *, const struct sockaddr_dl *,
+    const struct sockaddr *, u_int32_t);
+
+extern int dlil_attach_filter(ifnet_t, const struct iff_filter *,
+    interface_filter_t *, u_int32_t);
+extern void dlil_detach_filter(interface_filter_t);
+
 extern void dlil_proto_unplumb_all(ifnet_t);
 
-#endif /* BSD_KERNEL_PRIVATE */
+extern void dlil_post_msg(struct ifnet *, u_int32_t, u_int32_t,
+    struct net_event_data *, u_int32_t);
 
-void
-dlil_post_msg(struct ifnet *ifp,u_int32_t event_subclass, u_int32_t event_code, 
-                  struct net_event_data *event_data, u_int32_t event_data_len);
+extern int dlil_alloc_local_stats(struct ifnet *);
 
-/* 
+/*
  * dlil_if_acquire is obsolete. Use ifnet_allocate.
  */
-
-int dlil_if_acquire(u_int32_t family, const void *uniqueid, size_t uniqueid_len, 
-                       struct ifnet **ifp);
-                       
-
-/* 
+extern int dlil_if_acquire(u_int32_t, const void *, size_t, struct ifnet **);
+/*
  * dlil_if_release is obsolete. The equivalent is called automatically when
  * an interface is detached.
  */
+extern void dlil_if_release(struct ifnet *ifp);
 
-void dlil_if_release(struct ifnet *ifp);
-
-#if IFNET_ROUTE_REFCNT
 extern u_int32_t ifnet_aggressive_drainers;
-#endif /* IFNET_ROUTE_REFCNT */
 
+extern errno_t dlil_if_ref(struct ifnet *);
+extern errno_t dlil_if_free(struct ifnet *);
+
+extern void dlil_node_present(struct ifnet *, struct sockaddr *, int32_t, int,
+    int, u_int8_t[48]);
+extern void dlil_node_absent(struct ifnet *, struct sockaddr *);
+
+extern const void *dlil_ifaddr_bytes(const struct sockaddr_dl *, size_t *,
+    kauth_cred_t *);
+
+extern void dlil_report_issues(struct ifnet *, u_int8_t[DLIL_MODIDLEN],
+    u_int8_t[DLIL_MODARGLEN]);
+
+#define PROTO_HASH_SLOTS       4
+
+extern int proto_hash_value(u_int32_t);
+
+extern const char *dlil_kev_dl_code_str(u_int32_t);
+
+extern errno_t dlil_rxpoll_set_params(struct ifnet *,
+    struct ifnet_poll_params *, boolean_t);
+extern errno_t dlil_rxpoll_get_params(struct ifnet *,
+    struct ifnet_poll_params *);
+
+#endif /* BSD_KERNEL_PRIVATE */
 #endif /* KERNEL_PRIVATE */
 #endif /* KERNEL */
 #endif /* DLIL_H */