test: skip tests when missing requirements
[dpdk.git] / app / test / test_distributor_perf.c
index 1031baa..f6f1139 100644 (file)
@@ -1,46 +1,21 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2017 Intel Corporation
  */
 
 #include "test.h"
 
-#ifdef RTE_LIBRTE_DISTRIBUTOR
 #include <unistd.h>
 #include <string.h>
+#include <rte_mempool.h>
 #include <rte_cycles.h>
+#include <rte_common.h>
+#include <rte_mbuf.h>
 #include <rte_distributor.h>
+#include <rte_pause.h>
 
-#define ITER_POWER 20 /* log 2 of how many iterations we do when timing. */
-#define BURST 32
+#define ITER_POWER_CL 25 /* log 2 of how many iterations  for Cache Line test */
+#define ITER_POWER 21 /* log 2 of how many iterations we do when timing. */
+#define BURST 64
 #define BIG_BATCH 1024
 
 /* static vars - zero initialized by default */
@@ -52,10 +27,11 @@ struct worker_stats {
 } __rte_cache_aligned;
 struct worker_stats worker_stats[RTE_MAX_LCORE];
 
-/* worker thread used for testing the time to do a round-trip of a cache
+/*
+ * worker thread used for testing the time to do a round-trip of a cache
  * line between two cores and back again
  */
-static void
+static int
 flip_bit(volatile uint64_t *arg)
 {
        uint64_t old_val = 0;
@@ -65,16 +41,18 @@ flip_bit(volatile uint64_t *arg)
                old_val = *arg;
                *arg = 0;
        }
+       return 0;
 }
 
-/* test case to time the number of cycles to round-trip a cache line between
+/*
+ * test case to time the number of cycles to round-trip a cache line between
  * two cores and back again.
  */
 static void
 time_cache_line_switch(void)
 {
        /* allocate a full cache line for data, we use only first byte of it */
-       uint64_t data[CACHE_LINE_SIZE*3 / sizeof(uint64_t)];
+       uint64_t data[RTE_CACHE_LINE_SIZE*3 / sizeof(uint64_t)];
 
        unsigned i, slaveid = rte_get_next_lcore(rte_lcore_id(), 0, 0);
        volatile uint64_t *pdata = &data[0];
@@ -84,7 +62,7 @@ time_cache_line_switch(void)
                rte_pause();
 
        const uint64_t start_time = rte_rdtsc();
-       for (i = 0; i < (1 << ITER_POWER); i++) {
+       for (i = 0; i < (1 << ITER_POWER_CL); i++) {
                while (*pdata)
                        rte_pause();
                *pdata = 1;
@@ -96,13 +74,14 @@ time_cache_line_switch(void)
        *pdata = 2;
        rte_eal_wait_lcore(slaveid);
        printf("==== Cache line switch test ===\n");
-       printf("Time for %u iterations = %"PRIu64" ticks\n", (1<<ITER_POWER),
+       printf("Time for %u iterations = %"PRIu64" ticks\n", (1<<ITER_POWER_CL),
                        end_time-start_time);
        printf("Ticks per iteration = %"PRIu64"\n\n",
-                       (end_time-start_time) >> ITER_POWER);
+                       (end_time-start_time) >> ITER_POWER_CL);
 }
 
-/* returns the total count of the number of packets handled by the worker
+/*
+ * returns the total count of the number of packets handled by the worker
  * functions given below.
  */
 static unsigned
@@ -121,35 +100,44 @@ clear_packet_count(void)
        memset(&worker_stats, 0, sizeof(worker_stats));
 }
 
-/* this is the basic worker function for performance tests.
+/*
+ * This is the basic worker function for performance tests.
  * it does nothing but return packets and count them.
  */
 static int
 handle_work(void *arg)
 {
-       struct rte_mbuf *pkt = NULL;
        struct rte_distributor *d = arg;
-       unsigned count = 0;
-       unsigned id = __sync_fetch_and_add(&worker_idx, 1);
+       unsigned int count = 0;
+       unsigned int num = 0;
+       int i;
+       unsigned int id = __sync_fetch_and_add(&worker_idx, 1);
+       struct rte_mbuf *buf[8] __rte_cache_aligned;
 
-       pkt = rte_distributor_get_pkt(d, id, NULL);
+       for (i = 0; i < 8; i++)
+               buf[i] = NULL;
+
+       num = rte_distributor_get_pkt(d, id, buf, buf, num);
        while (!quit) {
-               worker_stats[id].handled_packets++, count++;
-               pkt = rte_distributor_get_pkt(d, id, pkt);
+               worker_stats[id].handled_packets += num;
+               count += num;
+               num = rte_distributor_get_pkt(d, id, buf, buf, num);
        }
-       worker_stats[id].handled_packets++, count++;
-       rte_distributor_return_pkt(d, id, pkt);
+       worker_stats[id].handled_packets += num;
+       count += num;
+       rte_distributor_return_pkt(d, id, buf, num);
        return 0;
 }
 
-/* this basic performance test just repeatedly sends in 32 packets at a time
+/*
+ * This basic performance test just repeatedly sends in 32 packets at a time
  * to the distributor and verifies at the end that we got them all in the worker
  * threads and finally how long per packet the processing took.
  */
 static inline int
 perf_test(struct rte_distributor *d, struct rte_mempool *p)
 {
-       unsigned i;
+       unsigned int i;
        uint64_t start, end;
        struct rte_mbuf *bufs[BURST];
 
@@ -160,7 +148,7 @@ perf_test(struct rte_distributor *d, struct rte_mempool *p)
        }
        /* ensure we have different hash value for each pkt */
        for (i = 0; i < BURST; i++)
-               bufs[i]->pkt.hash.rss = i;
+               bufs[i]->hash.usr = i;
 
        start = rte_rdtsc();
        for (i = 0; i < (1<<ITER_POWER); i++)
@@ -172,7 +160,8 @@ perf_test(struct rte_distributor *d, struct rte_mempool *p)
                rte_distributor_process(d, NULL, 0);
        } while (total_packet_count() < (BURST << ITER_POWER));
 
-       printf("=== Performance test of distributor ===\n");
+       rte_distributor_clear_returns(d);
+
        printf("Time per burst:  %"PRIu64"\n", (end - start) >> ITER_POWER);
        printf("Time per packet: %"PRIu64"\n\n",
                        ((end - start) >> ITER_POWER)/BURST);
@@ -192,14 +181,15 @@ perf_test(struct rte_distributor *d, struct rte_mempool *p)
 static void
 quit_workers(struct rte_distributor *d, struct rte_mempool *p)
 {
-       const unsigned num_workers = rte_lcore_count() - 1;
-       unsigned i;
+       const unsigned int num_workers = rte_lcore_count() - 1;
+       unsigned int i;
        struct rte_mbuf *bufs[RTE_MAX_LCORE];
+
        rte_mempool_get_bulk(p, (void *)bufs, num_workers);
 
        quit = 1;
        for (i = 0; i < num_workers; i++)
-               bufs[i]->pkt.hash.rss = i << 1;
+               bufs[i]->hash.usr = i << 1;
        rte_distributor_process(d, bufs, num_workers);
 
        rte_mempool_put_bulk(p, (void *)bufs, num_workers);
@@ -210,66 +200,69 @@ quit_workers(struct rte_distributor *d, struct rte_mempool *p)
        worker_idx = 0;
 }
 
-#define MBUF_SIZE (2048 + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
-
-int
+static int
 test_distributor_perf(void)
 {
-       static struct rte_distributor *d;
+       static struct rte_distributor *ds;
+       static struct rte_distributor *db;
        static struct rte_mempool *p;
 
        if (rte_lcore_count() < 2) {
-               printf("ERROR: not enough cores to test distributor\n");
-               return -1;
+               printf("Not enough cores for distributor_perf_autotest, expecting at least 2\n");
+               return TEST_SKIPPED;
        }
 
        /* first time how long it takes to round-trip a cache line */
        time_cache_line_switch();
 
-       if (d == NULL) {
-               d = rte_distributor_create("Test_perf", rte_socket_id(),
-                               rte_lcore_count() - 1);
-               if (d == NULL) {
+       if (ds == NULL) {
+               ds = rte_distributor_create("Test_perf", rte_socket_id(),
+                               rte_lcore_count() - 1,
+                               RTE_DIST_ALG_SINGLE);
+               if (ds == NULL) {
                        printf("Error creating distributor\n");
                        return -1;
                }
        } else {
-               rte_distributor_flush(d);
-               rte_distributor_clear_returns(d);
+               rte_distributor_clear_returns(ds);
+       }
+
+       if (db == NULL) {
+               db = rte_distributor_create("Test_burst", rte_socket_id(),
+                               rte_lcore_count() - 1,
+                               RTE_DIST_ALG_BURST);
+               if (db == NULL) {
+                       printf("Error creating burst distributor\n");
+                       return -1;
+               }
+       } else {
+               rte_distributor_clear_returns(db);
        }
 
        const unsigned nb_bufs = (511 * rte_lcore_count()) < BIG_BATCH ?
                        (BIG_BATCH * 2) - 1 : (511 * rte_lcore_count());
        if (p == NULL) {
-               p = rte_mempool_create("DPT_MBUF_POOL", nb_bufs,
-                               MBUF_SIZE, BURST,
-                               sizeof(struct rte_pktmbuf_pool_private),
-                               rte_pktmbuf_pool_init, NULL,
-                               rte_pktmbuf_init, NULL,
-                               rte_socket_id(), 0);
+               p = rte_pktmbuf_pool_create("DPT_MBUF_POOL", nb_bufs, BURST,
+                       0, RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
                if (p == NULL) {
                        printf("Error creating mempool\n");
                        return -1;
                }
        }
 
-       rte_eal_mp_remote_launch(handle_work, d, SKIP_MASTER);
-       if (perf_test(d, p) < 0)
+       printf("=== Performance test of distributor (single mode) ===\n");
+       rte_eal_mp_remote_launch(handle_work, ds, SKIP_MASTER);
+       if (perf_test(ds, p) < 0)
                return -1;
-       quit_workers(d, p);
-
-       return 0;
-}
-
-#else
+       quit_workers(ds, p);
 
-#include <stdio.h>
+       printf("=== Performance test of distributor (burst mode) ===\n");
+       rte_eal_mp_remote_launch(handle_work, db, SKIP_MASTER);
+       if (perf_test(db, p) < 0)
+               return -1;
+       quit_workers(db, p);
 
-int
-test_distributor_perf(void)
-{
-       printf("Distributor is not enabled in configuration\n");
        return 0;
 }
 
-#endif
+REGISTER_TEST_COMMAND(distributor_perf_autotest, test_distributor_perf);