]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/net/pktsched/pktsched.c
xnu-7195.101.1.tar.gz
[apple/xnu.git] / bsd / net / pktsched / pktsched.c
index e757dc893b6b681838cfc67328ed77de05543e06..e569f9d3ba63bb36c321ad37aa00f26910ef3e0f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2017 Apple Inc. All rights reserved.
+ * Copyright (c) 2011-2020 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  *
 #include <sys/mcache.h>
 #include <sys/sysctl.h>
 
+#include <dev/random/randomdev.h>
 #include <net/if.h>
 #include <net/if_var.h>
 #include <net/if_dl.h>
 #include <net/if_types.h>
 #include <net/net_osdep.h>
 #include <net/pktsched/pktsched.h>
-#include <net/pktsched/pktsched_tcq.h>
-#include <net/pktsched/pktsched_qfq.h>
 #include <net/pktsched/pktsched_fq_codel.h>
+#include <net/pktsched/pktsched_netem.h>
 
 #include <pexpert/pexpert.h>
 
 
 u_int32_t machclk_freq = 0;
 u_int64_t machclk_per_sec = 0;
-u_int32_t pktsched_verbose;    /* more noise if greater than 1 */
+u_int32_t pktsched_verbose = 0; /* more noise if greater than 1 */
 
 static void init_machclk(void);
 
-SYSCTL_NODE(_net, OID_AUTO, pktsched, CTLFLAG_RW|CTLFLAG_LOCKED, 0, "pktsched");
+SYSCTL_NODE(_net, OID_AUTO, pktsched, CTLFLAG_RW | CTLFLAG_LOCKED, 0, "pktsched");
 
-SYSCTL_UINT(_net_pktsched, OID_AUTO, verbose, CTLFLAG_RW|CTLFLAG_LOCKED,
-       &pktsched_verbose, 0, "Packet scheduler verbosity level");
+SYSCTL_UINT(_net_pktsched, OID_AUTO, verbose, CTLFLAG_RW | CTLFLAG_LOCKED,
+    &pktsched_verbose, 0, "Packet scheduler verbosity level");
 
 void
 pktsched_init(void)
@@ -70,8 +70,7 @@ pktsched_init(void)
                /* NOTREACHED */
        }
 
-       tcq_init();
-       qfq_init();
+       netem_init();
 }
 
 static void
@@ -81,7 +80,7 @@ init_machclk(void)
         * Initialize machclk_freq using the timerbase frequency
         * value from device specific info.
         */
-       machclk_freq = gPEClockFrequencyInfo.timebase_frequency_hz;
+       machclk_freq = (uint32_t)gPEClockFrequencyInfo.timebase_frequency_hz;
 
        clock_interval_to_absolutetime_interval(1, NSEC_PER_SEC,
            &machclk_per_sec);
@@ -93,7 +92,7 @@ pktsched_abs_to_nsecs(u_int64_t abstime)
        u_int64_t nsecs;
 
        absolutetime_to_nanoseconds(abstime, &nsecs);
-       return (nsecs);
+       return nsecs;
 }
 
 u_int64_t
@@ -102,7 +101,7 @@ pktsched_nsecs_to_abstime(u_int64_t nsecs)
        u_int64_t abstime;
 
        nanoseconds_to_absolutetime(nsecs, &abstime);
-       return (abstime);
+       return abstime;
 }
 
 int
@@ -117,8 +116,9 @@ pktsched_setup(struct ifclassq *ifq, u_int32_t scheduler, u_int32_t sflags,
        VERIFY(machclk_freq != 0);
 
        /* Nothing to do unless the scheduler type changes */
-       if (ifq->ifcq_type == scheduler)
-               return (0);
+       if (ifq->ifcq_type == scheduler) {
+               return 0;
+       }
 
        /*
         * Remember the flags that need to be restored upon success, as
@@ -127,44 +127,24 @@ pktsched_setup(struct ifclassq *ifq, u_int32_t scheduler, u_int32_t sflags,
        rflags = (ifq->ifcq_flags & IFCQF_ENABLED);
 
        if (ifq->ifcq_type != PKTSCHEDT_NONE) {
-               (void) pktsched_teardown(ifq);
+               pktsched_teardown(ifq);
 
                /* Teardown should have succeeded */
                VERIFY(ifq->ifcq_type == PKTSCHEDT_NONE);
                VERIFY(ifq->ifcq_disc == NULL);
-               VERIFY(ifq->ifcq_enqueue == NULL);
-               VERIFY(ifq->ifcq_dequeue == NULL);
-               VERIFY(ifq->ifcq_dequeue_sc == NULL);
-               VERIFY(ifq->ifcq_request == NULL);
-       }
-
-       switch (scheduler) {
-       case PKTSCHEDT_TCQ:
-               error = tcq_setup_ifclassq(ifq, sflags, ptype);
-               break;
-
-       case PKTSCHEDT_QFQ:
-               error = qfq_setup_ifclassq(ifq, sflags, ptype);
-               break;
-       case PKTSCHEDT_FQ_CODEL:
-               error = fq_if_setup_ifclassq(ifq, sflags, ptype);
-               break;
-       default:
-               error = ENXIO;
-               break;
        }
 
-       if (error == 0)
+       error = fq_if_setup_ifclassq(ifq, sflags, ptype);
+       if (error == 0) {
                ifq->ifcq_flags |= rflags;
+       }
 
-       return (error);
+       return error;
 }
 
-int
+void
 pktsched_teardown(struct ifclassq *ifq)
 {
-       int error = 0;
-
        IFCQ_LOCK_ASSERT_HELD(ifq);
 
        if_qflush(ifq->ifcq_ifp, 1);
@@ -172,98 +152,166 @@ pktsched_teardown(struct ifclassq *ifq)
 
        ifq->ifcq_flags &= ~IFCQF_ENABLED;
 
-       switch (ifq->ifcq_type) {
-       case PKTSCHEDT_NONE:
-               break;
-
-       case PKTSCHEDT_TCQ:
-               error = tcq_teardown_ifclassq(ifq);
-               break;
-
-       case PKTSCHEDT_QFQ:
-               error = qfq_teardown_ifclassq(ifq);
-               break;
-
-       case PKTSCHEDT_FQ_CODEL:
-               error = fq_if_teardown_ifclassq(ifq);
-               break;
-       default:
-               error = ENXIO;
-               break;
+       if (ifq->ifcq_type == PKTSCHEDT_FQ_CODEL) {
+               /* Could be PKTSCHEDT_NONE */
+               fq_if_teardown_ifclassq(ifq);
        }
-       return (error);
+
+       return;
 }
 
 int
 pktsched_getqstats(struct ifclassq *ifq, u_int32_t qid,
     struct if_ifclassq_stats *ifqs)
 {
-       int error;
+       int error = 0;
 
        IFCQ_LOCK_ASSERT_HELD(ifq);
 
-       switch (ifq->ifcq_type) {
-       case PKTSCHEDT_TCQ:
-               error = tcq_getqstats_ifclassq(ifq, qid, ifqs);
-               break;
-
-       case PKTSCHEDT_QFQ:
-               error = qfq_getqstats_ifclassq(ifq, qid, ifqs);
-               break;
-
-       case PKTSCHEDT_FQ_CODEL:
+       if (ifq->ifcq_type == PKTSCHEDT_FQ_CODEL) {
+               /* Could be PKTSCHEDT_NONE */
                error = fq_if_getqstats_ifclassq(ifq, qid, ifqs);
-               break;
-       default:
-               error = ENXIO;
-               break;
        }
 
-       return (error);
+       return error;
 }
 
 void
-pktsched_pkt_encap(pktsched_pkt_t *pkt, classq_pkt_type_t ptype, void *pp)
+pktsched_pkt_encap(pktsched_pkt_t *pkt, classq_pkt_t *cpkt)
 {
-       pkt->pktsched_ptype = ptype;
-       pkt->pktsched_pkt = pp;
+       pkt->pktsched_pkt = *cpkt;
+       pkt->pktsched_tail = *cpkt;
+       pkt->pktsched_pcnt = 1;
 
-       switch (ptype) {
+       switch (cpkt->cp_ptype) {
        case QP_MBUF:
                pkt->pktsched_plen =
-                   (uint32_t)m_pktlen((struct mbuf *)pkt->pktsched_pkt);
+                   (uint32_t)m_pktlen(pkt->pktsched_pkt_mbuf);
                break;
 
 
        default:
                VERIFY(0);
                /* NOTREACHED */
+               __builtin_unreachable();
        }
 }
 
 void
-pktsched_free_pkt(pktsched_pkt_t *pkt)
+pktsched_pkt_encap_chain(pktsched_pkt_t *pkt, classq_pkt_t *cpkt,
+    classq_pkt_t *tail, uint32_t cnt, uint32_t bytes)
 {
-       switch (pkt->pktsched_ptype) {
+       pkt->pktsched_pkt = *cpkt;
+       pkt->pktsched_tail = *tail;
+       pkt->pktsched_pcnt = cnt;
+       pkt->pktsched_plen = bytes;
+
+       switch (cpkt->cp_ptype) {
        case QP_MBUF:
-               m_freem(pkt->pktsched_pkt);
                break;
 
 
        default:
                VERIFY(0);
                /* NOTREACHED */
+               __builtin_unreachable();
        }
+}
 
-       pkt->pktsched_pkt = NULL;
-       pkt->pktsched_plen = 0;
-       pkt->pktsched_ptype = 0;
+int
+pktsched_clone_pkt(pktsched_pkt_t *pkt1, pktsched_pkt_t *pkt2)
+{
+       struct mbuf *m1, *m2;
+
+       ASSERT(pkt1 != NULL);
+       ASSERT(pkt1->pktsched_pkt_mbuf != NULL);
+       ASSERT(pkt1->pktsched_pcnt == 1);
+
+       /* allow in place clone, but make sure pkt2->pktsched_pkt won't leak */
+       ASSERT((pkt1 == pkt2 && pkt1->pktsched_pkt_mbuf ==
+           pkt2->pktsched_pkt_mbuf) || (pkt1 != pkt2 &&
+           pkt2->pktsched_pkt_mbuf == NULL));
+
+       switch (pkt1->pktsched_ptype) {
+       case QP_MBUF:
+               m1 = (struct mbuf *)pkt1->pktsched_pkt_mbuf;
+               m2 = m_dup(m1, M_NOWAIT);
+               if (__improbable(m2 == NULL)) {
+                       return ENOBUFS;
+               }
+               pkt2->pktsched_pkt_mbuf = m2;
+               break;
+
+
+       default:
+               VERIFY(0);
+               /* NOTREACHED */
+               __builtin_unreachable();
+       }
+
+       pkt2->pktsched_plen = pkt1->pktsched_plen;
+       pkt2->pktsched_ptype = pkt1->pktsched_ptype;
+       pkt2->pktsched_tail = pkt2->pktsched_pkt;
+       pkt2->pktsched_pcnt = 1;
+       return 0;
 }
 
-uint32_t
-pktsched_get_pkt_len(pktsched_pkt_t *pkt)
+void
+pktsched_corrupt_packet(pktsched_pkt_t *pkt)
 {
-       return (pkt->pktsched_plen);
+       struct mbuf *m = NULL;
+       uint8_t *data = NULL;
+       uint32_t data_len = 0;
+       uint32_t rand32, rand_off, rand_bit;
+
+       switch (pkt->pktsched_ptype) {
+       case QP_MBUF:
+               m = pkt->pktsched_pkt_mbuf;
+               data = mtod(m, uint8_t *);
+               data_len = m->m_pkthdr.len;
+               break;
+
+       default:
+               /* NOTREACHED */
+               VERIFY(0);
+               __builtin_unreachable();
+       }
+
+       read_frandom(&rand32, sizeof(rand32));
+       rand_bit = rand32 & 0x8;
+       rand_off = (rand32 >> 3) % data_len;
+       data[rand_off] ^= 1 << rand_bit;
+}
+
+void
+pktsched_free_pkt(pktsched_pkt_t *pkt)
+{
+       uint32_t cnt = pkt->pktsched_pcnt;
+       ASSERT(cnt != 0);
+
+       switch (pkt->pktsched_ptype) {
+       case QP_MBUF: {
+               struct mbuf *m;
+
+               m = pkt->pktsched_pkt_mbuf;
+               if (cnt == 1) {
+                       VERIFY(m->m_nextpkt == NULL);
+               } else {
+                       VERIFY(m->m_nextpkt != NULL);
+               }
+               m_freem_list(m);
+               break;
+       }
+
+       default:
+               VERIFY(0);
+               /* NOTREACHED */
+               __builtin_unreachable();
+       }
+       pkt->pktsched_pkt = CLASSQ_PKT_INITIALIZER(pkt->pktsched_pkt);
+       pkt->pktsched_tail = CLASSQ_PKT_INITIALIZER(pkt->pktsched_tail);
+       pkt->pktsched_plen = 0;
+       pkt->pktsched_pcnt = 0;
 }
 
 mbuf_svc_class_t
@@ -273,44 +321,46 @@ pktsched_get_pkt_svc(pktsched_pkt_t *pkt)
 
        switch (pkt->pktsched_ptype) {
        case QP_MBUF:
-               svc = m_get_service_class((mbuf_t)pkt->pktsched_pkt);
+               svc = m_get_service_class(pkt->pktsched_pkt_mbuf);
                break;
 
 
        default:
                VERIFY(0);
                /* NOTREACHED */
+               __builtin_unreachable();
        }
 
-       return (svc);
+       return svc;
 }
 
 void
-pktsched_get_pkt_vars(pktsched_pkt_t *pkt, uint32_t **flags,
+pktsched_get_pkt_vars(pktsched_pkt_t *pkt, volatile uint32_t **flags,
     uint64_t **timestamp, uint32_t *flowid, uint8_t *flowsrc, uint8_t *proto,
-    uint32_t *tcp_start_seq)
+    uint32_t *comp_gencnt)
 {
        switch (pkt->pktsched_ptype) {
        case QP_MBUF: {
-               struct mbuf *m = (struct mbuf *)pkt->pktsched_pkt;
-               struct pkthdr *pkth = &m->m_pkthdr;
+               struct pkthdr *pkth = &(pkt->pktsched_pkt_mbuf->m_pkthdr);
 
-               if (flags != NULL)
+               if (flags != NULL) {
                        *flags = &pkth->pkt_flags;
-               if (timestamp != NULL)
+               }
+               if (timestamp != NULL) {
                        *timestamp = &pkth->pkt_timestamp;
-               if (flowid != NULL)
+               }
+               if (flowid != NULL) {
                        *flowid = pkth->pkt_flowid;
-               if (flowsrc != NULL)
+               }
+               if (flowsrc != NULL) {
                        *flowsrc = pkth->pkt_flowsrc;
-               if (proto != NULL)
+               }
+               if (proto != NULL) {
                        *proto = pkth->pkt_proto;
-               /*
-                * caller should use this value only if PKTF_START_SEQ
-                * is set in the mbuf packet flags
-                */
-               if (tcp_start_seq != NULL)
-                       *tcp_start_seq = pkth->tx_start_seq;
+               }
+               if (comp_gencnt != NULL) {
+                       *comp_gencnt = pkth->comp_gencnt;
+               }
 
                break;
        }
@@ -319,6 +369,7 @@ pktsched_get_pkt_vars(pktsched_pkt_t *pkt, uint32_t **flags,
        default:
                VERIFY(0);
                /* NOTREACHED */
+               __builtin_unreachable();
        }
 }
 
@@ -330,14 +381,15 @@ pktsched_alloc_fcentry(pktsched_pkt_t *pkt, struct ifnet *ifp, int how)
 
        switch (pkt->pktsched_ptype) {
        case QP_MBUF: {
-               struct mbuf *m = (struct mbuf *)pkt->pktsched_pkt;
+               struct mbuf *m = pkt->pktsched_pkt_mbuf;
 
                fce = flowadv_alloc_entry(how);
-               if (fce == NULL)
+               if (fce == NULL) {
                        break;
+               }
 
-               _CASSERT(sizeof (m->m_pkthdr.pkt_flowid) ==
-                   sizeof (fce->fce_flowid));
+               _CASSERT(sizeof(m->m_pkthdr.pkt_flowid) ==
+                   sizeof(fce->fce_flowid));
 
                fce->fce_flowsrc_type = m->m_pkthdr.pkt_flowsrc;
                fce->fce_flowid = m->m_pkthdr.pkt_flowid;
@@ -348,9 +400,10 @@ pktsched_alloc_fcentry(pktsched_pkt_t *pkt, struct ifnet *ifp, int how)
        default:
                VERIFY(0);
                /* NOTREACHED */
+               __builtin_unreachable();
        }
 
-       return (fce);
+       return fce;
 }
 
 uint32_t *
@@ -360,12 +413,10 @@ pktsched_get_pkt_sfb_vars(pktsched_pkt_t *pkt, uint32_t **sfb_flags)
 
        switch (pkt->pktsched_ptype) {
        case QP_MBUF: {
-               struct mbuf *m = (struct mbuf *)pkt->pktsched_pkt;
-               struct pkthdr *pkth = &m->m_pkthdr;
-
-               _CASSERT(sizeof (pkth->pkt_mpriv_hash) == sizeof (uint32_t));
-               _CASSERT(sizeof (pkth->pkt_mpriv_flags) == sizeof (uint32_t));
+               struct pkthdr *pkth = &(pkt->pktsched_pkt_mbuf->m_pkthdr);
 
+               _CASSERT(sizeof(pkth->pkt_mpriv_hash) == sizeof(uint32_t));
+               _CASSERT(sizeof(pkth->pkt_mpriv_flags) == sizeof(uint32_t));
                *sfb_flags = &pkth->pkt_mpriv_flags;
                hashp = &pkth->pkt_mpriv_hash;
                break;
@@ -375,7 +426,8 @@ pktsched_get_pkt_sfb_vars(pktsched_pkt_t *pkt, uint32_t **sfb_flags)
        default:
                VERIFY(0);
                /* NOTREACHED */
+               __builtin_unreachable();
        }
 
-       return (hashp);
+       return hashp;
 }