examples: use SPDX tag for Intel copyright files
[dpdk.git] / examples / distributor / main.c
index a8a5e80..c7dec76 100644 (file)
@@ -1,34 +1,5 @@
-/*-
- *   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 <stdint.h>
 #include <rte_debug.h>
 #include <rte_prefetch.h>
 #include <rte_distributor.h>
+#include <rte_pause.h>
 
-#define RX_RING_SIZE 256
+#define RX_RING_SIZE 512
 #define TX_RING_SIZE 512
 #define NUM_MBUFS ((64*1024)-1)
-#define MBUF_CACHE_SIZE 250
-#define BURST_SIZE 32
-#define RTE_RING_SZ 1024
+#define MBUF_CACHE_SIZE 128
+#define BURST_SIZE 64
+#define SCHED_RX_RING_SZ 8192
+#define SCHED_TX_RING_SZ 65536
+#define BURST_SIZE_TX 32
 
 #define RTE_LOGTYPE_DISTRAPP RTE_LOGTYPE_USER1
 
@@ -62,6 +36,7 @@ static uint32_t enabled_port_mask;
 volatile uint8_t quit_signal;
 volatile uint8_t quit_signal_rx;
 volatile uint8_t quit_signal_dist;
+volatile uint8_t quit_signal_work;
 
 static volatile struct app_stats {
        struct {
@@ -129,12 +104,14 @@ static void print_stats(void);
  * coming from the mbuf_pool passed as parameter
  */
 static inline int
-port_init(uint8_t port, struct rte_mempool *mbuf_pool)
+port_init(uint16_t port, struct rte_mempool *mbuf_pool)
 {
        struct rte_eth_conf port_conf = port_conf_default;
        const uint16_t rxRings = 1, txRings = rte_lcore_count() - 1;
        int retval;
        uint16_t q;
+       uint16_t nb_rxd = RX_RING_SIZE;
+       uint16_t nb_txd = TX_RING_SIZE;
 
        if (port >= rte_eth_dev_count())
                return -1;
@@ -143,8 +120,12 @@ port_init(uint8_t port, struct rte_mempool *mbuf_pool)
        if (retval != 0)
                return retval;
 
+       retval = rte_eth_dev_adjust_nb_rx_tx_desc(port, &nb_rxd, &nb_txd);
+       if (retval != 0)
+               return retval;
+
        for (q = 0; q < rxRings; q++) {
-               retval = rte_eth_rx_queue_setup(port, q, RX_RING_SIZE,
+               retval = rte_eth_rx_queue_setup(port, q, nb_rxd,
                                                rte_eth_dev_socket_id(port),
                                                NULL, mbuf_pool);
                if (retval < 0)
@@ -152,7 +133,7 @@ port_init(uint8_t port, struct rte_mempool *mbuf_pool)
        }
 
        for (q = 0; q < txRings; q++) {
-               retval = rte_eth_tx_queue_setup(port, q, TX_RING_SIZE,
+               retval = rte_eth_tx_queue_setup(port, q, nb_txd,
                                                rte_eth_dev_socket_id(port),
                                                NULL);
                if (retval < 0)
@@ -165,13 +146,14 @@ port_init(uint8_t port, struct rte_mempool *mbuf_pool)
 
        struct rte_eth_link link;
        rte_eth_link_get_nowait(port, &link);
-       if (!link.link_status) {
+       while (!link.link_status) {
+               printf("Waiting for Link up on port %"PRIu16"\n", port);
                sleep(1);
                rte_eth_link_get_nowait(port, &link);
        }
 
        if (!link.link_status) {
-               printf("Link down on port %"PRIu8"\n", port);
+               printf("Link down on port %"PRIu16"\n", port);
                return 0;
        }
 
@@ -179,7 +161,7 @@ port_init(uint8_t port, struct rte_mempool *mbuf_pool)
        rte_eth_macaddr_get(port, &addr);
        printf("Port %u MAC: %02"PRIx8" %02"PRIx8" %02"PRIx8
                        " %02"PRIx8" %02"PRIx8" %02"PRIx8"\n",
-                       (unsigned)port,
+                       port,
                        addr.addr_bytes[0], addr.addr_bytes[1],
                        addr.addr_bytes[2], addr.addr_bytes[3],
                        addr.addr_bytes[4], addr.addr_bytes[5]);
@@ -192,40 +174,18 @@ port_init(uint8_t port, struct rte_mempool *mbuf_pool)
 struct lcore_params {
        unsigned worker_id;
        struct rte_distributor *d;
-       struct rte_ring *r;
+       struct rte_ring *rx_dist_ring;
+       struct rte_ring *dist_tx_ring;
        struct rte_mempool *mem_pool;
 };
 
-static int
-quit_workers(struct rte_distributor *d, struct rte_mempool *p)
-{
-       const unsigned num_workers = rte_lcore_count() - 2;
-       unsigned i;
-       struct rte_mbuf *bufs[num_workers];
-
-       if (rte_mempool_get_bulk(p, (void *)bufs, num_workers) != 0) {
-               printf("line %d: Error getting mbufs from pool\n", __LINE__);
-               return -1;
-       }
-
-       for (i = 0; i < num_workers; i++)
-               bufs[i]->hash.rss = i << 1;
-
-       rte_distributor_process(d, bufs, num_workers);
-       rte_mempool_put_bulk(p, (void *)bufs, num_workers);
-
-       return 0;
-}
-
 static int
 lcore_rx(struct lcore_params *p)
 {
-       struct rte_distributor *d = p->d;
-       struct rte_mempool *mem_pool = p->mem_pool;
-       struct rte_ring *r = p->r;
-       const uint8_t nb_ports = rte_eth_dev_count();
+       const uint16_t nb_ports = rte_eth_dev_count();
        const int socket_id = rte_socket_id();
-       uint8_t port;
+       uint16_t port;
+       struct rte_mbuf *bufs[BURST_SIZE*2];
 
        for (port = 0; port < nb_ports; port++) {
                /* skip ports that are not enabled */
@@ -249,7 +209,6 @@ lcore_rx(struct lcore_params *p)
                                port = 0;
                        continue;
                }
-               struct rte_mbuf *bufs[BURST_SIZE*2];
                const uint16_t nb_rx = rte_eth_rx_burst(port, 0, bufs,
                                BURST_SIZE);
                if (unlikely(nb_rx == 0)) {
@@ -259,9 +218,15 @@ lcore_rx(struct lcore_params *p)
                }
                app_stats.rx.rx_pkts += nb_rx;
 
-               rte_distributor_process(d, bufs, nb_rx);
-               const uint16_t nb_ret = rte_distributor_returned_pkts(d,
-                               bufs, BURST_SIZE*2);
+/*
+ * You can run the distributor on the rx core with this code. Returned
+ * packets are then send straight to the tx core.
+ */
+#if 0
+       rte_distributor_process(d, bufs, nb_rx);
+       const uint16_t nb_ret = rte_distributor_returned_pktsd,
+                       bufs, BURST_SIZE*2);
+
                app_stats.rx.returned_pkts += nb_ret;
                if (unlikely(nb_ret == 0)) {
                        if (++port == nb_ports)
@@ -269,9 +234,25 @@ lcore_rx(struct lcore_params *p)
                        continue;
                }
 
-               uint16_t sent = rte_ring_enqueue_burst(r, (void *)bufs, nb_ret);
+               struct rte_ring *tx_ring = p->dist_tx_ring;
+               uint16_t sent = rte_ring_enqueue_burst(tx_ring,
+                               (void *)bufs, nb_ret, NULL);
+#else
+               uint16_t nb_ret = nb_rx;
+               /*
+                * Swap the following two lines if you want the rx traffic
+                * to go directly to tx, no distribution.
+                */
+               struct rte_ring *out_ring = p->rx_dist_ring;
+               /* struct rte_ring *out_ring = p->dist_tx_ring; */
+
+               uint16_t sent = rte_ring_enqueue_burst(out_ring,
+                               (void *)bufs, nb_ret, NULL);
+#endif
+
                app_stats.rx.enqueued_pkts += sent;
                if (unlikely(sent < nb_ret)) {
+                       app_stats.rx.enqdrop_pkts +=  nb_ret - sent;
                        RTE_LOG_DP(DEBUG, DISTRAPP,
                                "%s:Packet loss due to full ring\n", __func__);
                        while (sent < nb_ret)
@@ -280,33 +261,21 @@ lcore_rx(struct lcore_params *p)
                if (++port == nb_ports)
                        port = 0;
        }
-       rte_distributor_process(d, NULL, 0);
-       /* flush distributor to bring to known state */
-       rte_distributor_flush(d);
        /* set worker & tx threads quit flag */
+       printf("\nCore %u exiting rx task.\n", rte_lcore_id());
        quit_signal = 1;
-       /*
-        * worker threads may hang in get packet as
-        * distributor process is not running, just make sure workers
-        * get packets till quit_signal is actually been
-        * received and they gracefully shutdown
-        */
-       if (quit_workers(d, mem_pool) != 0)
-               return -1;
-       /* rx thread should quit at last */
        return 0;
 }
 
 static inline void
 flush_one_port(struct output_buffer *outbuf, uint8_t outp)
 {
-       unsigned nb_tx = rte_eth_tx_burst(outp, 0, outbuf->mbufs,
-                       outbuf->count);
-       app_stats.tx.tx_pkts += nb_tx;
+       unsigned int nb_tx = rte_eth_tx_burst(outp, 0,
+                       outbuf->mbufs, outbuf->count);
+       app_stats.tx.tx_pkts += outbuf->count;
 
        if (unlikely(nb_tx < outbuf->count)) {
-               RTE_LOG_DP(DEBUG, DISTRAPP,
-                       "%s:Packet loss with tx_burst\n", __func__);
+               app_stats.tx.enqdrop_pkts +=  outbuf->count - nb_tx;
                do {
                        rte_pktmbuf_free(outbuf->mbufs[nb_tx]);
                } while (++nb_tx < outbuf->count);
@@ -315,9 +284,10 @@ flush_one_port(struct output_buffer *outbuf, uint8_t outp)
 }
 
 static inline void
-flush_all_ports(struct output_buffer *tx_buffers, uint8_t nb_ports)
+flush_all_ports(struct output_buffer *tx_buffers, uint16_t nb_ports)
 {
-       uint8_t outp;
+       uint16_t outp;
+
        for (outp = 0; outp < nb_ports; outp++) {
                /* skip ports that are not enabled */
                if ((enabled_port_mask & (1 << outp)) == 0)
@@ -330,13 +300,65 @@ flush_all_ports(struct output_buffer *tx_buffers, uint8_t nb_ports)
        }
 }
 
+
+
+static int
+lcore_distributor(struct lcore_params *p)
+{
+       struct rte_ring *in_r = p->rx_dist_ring;
+       struct rte_ring *out_r = p->dist_tx_ring;
+       struct rte_mbuf *bufs[BURST_SIZE * 4];
+       struct rte_distributor *d = p->d;
+
+       printf("\nCore %u acting as distributor core.\n", rte_lcore_id());
+       while (!quit_signal_dist) {
+               const uint16_t nb_rx = rte_ring_dequeue_burst(in_r,
+                               (void *)bufs, BURST_SIZE*1, NULL);
+               if (nb_rx) {
+                       app_stats.dist.in_pkts += nb_rx;
+
+                       /* Distribute the packets */
+                       rte_distributor_process(d, bufs, nb_rx);
+                       /* Handle Returns */
+                       const uint16_t nb_ret =
+                               rte_distributor_returned_pkts(d,
+                                       bufs, BURST_SIZE*2);
+
+                       if (unlikely(nb_ret == 0))
+                               continue;
+                       app_stats.dist.ret_pkts += nb_ret;
+
+                       uint16_t sent = rte_ring_enqueue_burst(out_r,
+                                       (void *)bufs, nb_ret, NULL);
+                       app_stats.dist.sent_pkts += sent;
+                       if (unlikely(sent < nb_ret)) {
+                               app_stats.dist.enqdrop_pkts += nb_ret - sent;
+                               RTE_LOG(DEBUG, DISTRAPP,
+                                       "%s:Packet loss due to full out ring\n",
+                                       __func__);
+                               while (sent < nb_ret)
+                                       rte_pktmbuf_free(bufs[sent++]);
+                       }
+               }
+       }
+       printf("\nCore %u exiting distributor task.\n", rte_lcore_id());
+       quit_signal_work = 1;
+
+       rte_distributor_flush(d);
+       /* Unblock any returns so workers can exit */
+       rte_distributor_clear_returns(d);
+       quit_signal_rx = 1;
+       return 0;
+}
+
+
 static int
 lcore_tx(struct rte_ring *in_r)
 {
        static struct output_buffer tx_buffers[RTE_MAX_ETHPORTS];
-       const uint8_t nb_ports = rte_eth_dev_count();
+       const uint16_t nb_ports = rte_eth_dev_count();
        const int socket_id = rte_socket_id();
-       uint8_t port;
+       uint16_t port;
 
        for (port = 0; port < nb_ports; port++) {
                /* skip ports that are not enabled */
@@ -358,9 +380,9 @@ lcore_tx(struct rte_ring *in_r)
                        if ((enabled_port_mask & (1 << port)) == 0)
                                continue;
 
-                       struct rte_mbuf *bufs[BURST_SIZE];
+                       struct rte_mbuf *bufs[BURST_SIZE_TX];
                        const uint16_t nb_rx = rte_ring_dequeue_burst(in_r,
-                                       (void *)bufs, BURST_SIZE);
+                                       (void *)bufs, BURST_SIZE_TX, NULL);
                        app_stats.tx.dequeue_pkts += nb_rx;
 
                        /* if we get no traffic, flush anything we have */
@@ -389,11 +411,12 @@ lcore_tx(struct rte_ring *in_r)
 
                                outbuf = &tx_buffers[outp];
                                outbuf->mbufs[outbuf->count++] = bufs[i];
-                               if (outbuf->count == BURST_SIZE)
+                               if (outbuf->count == BURST_SIZE_TX)
                                        flush_one_port(outbuf, outp);
                        }
                }
        }
+       printf("\nCore %u exiting tx task.\n", rte_lcore_id());
        return 0;
 }
 
@@ -402,7 +425,7 @@ int_handler(int sig_num)
 {
        printf("Exiting on signal %d\n", sig_num);
        /* set quit flag for rx thread to exit */
-       quit_signal_rx = 1;
+       quit_signal_dist = 1;
 }
 
 static void
@@ -515,8 +538,10 @@ lcore_worker(struct lcore_params *p)
        for (i = 0; i < 8; i++)
                buf[i] = NULL;
 
+       app_stats.worker_pkts[p->worker_id] = 1;
+
        printf("\nCore %u acting as worker core.\n", rte_lcore_id());
-       while (!quit_signal) {
+       while (!quit_signal_work) {
                num = rte_distributor_get_pkt(d, id, buf, buf, num);
                /* Do a little bit of work for each packet */
                for (i = 0; i < num; i++) {
@@ -526,6 +551,10 @@ lcore_worker(struct lcore_params *p)
                                rte_pause();
                        buf[i]->port ^= xor_val;
                }
+
+               app_stats.worker_pkts[p->worker_id] += num;
+               if (num > 0)
+                       app_stats.worker_bursts[p->worker_id][num-1]++;
        }
        return 0;
 }
@@ -607,11 +636,12 @@ main(int argc, char *argv[])
 {
        struct rte_mempool *mbuf_pool;
        struct rte_distributor *d;
-       struct rte_ring *output_ring;
+       struct rte_ring *dist_tx_ring;
+       struct rte_ring *rx_dist_ring;
        unsigned lcore_id, worker_id = 0;
        unsigned nb_ports;
-       uint8_t portid;
-       uint8_t nb_ports_available;
+       uint16_t portid;
+       uint16_t nb_ports_available;
        uint64_t t, freq;
 
        /* catch ctrl-c so we can print on exit */
@@ -629,10 +659,12 @@ main(int argc, char *argv[])
        if (ret < 0)
                rte_exit(EXIT_FAILURE, "Invalid distributor parameters\n");
 
-       if (rte_lcore_count() < 3)
+       if (rte_lcore_count() < 5)
                rte_exit(EXIT_FAILURE, "Error, This application needs at "
-                               "least 3 logical cores to run:\n"
-                               "1 lcore for packet RX and distribution\n"
+                               "least 5 logical cores to run:\n"
+                               "1 lcore for stats (can be core 0)\n"
+                               "1 lcore for packet RX\n"
+                               "1 lcore for distribution\n"
                                "1 lcore for packet TX\n"
                                "and at least 1 lcore for worker threads\n");
 
@@ -659,10 +691,10 @@ main(int argc, char *argv[])
                        continue;
                }
                /* init port */
-               printf("Initializing port %u... done\n", (unsigned) portid);
+               printf("Initializing port %u... done\n", portid);
 
                if (port_init(portid, mbuf_pool) != 0)
-                       rte_exit(EXIT_FAILURE, "Cannot initialize port %"PRIu8"\n",
+                       rte_exit(EXIT_FAILURE, "Cannot initialize port %u\n",
                                        portid);
        }
 
@@ -672,41 +704,72 @@ main(int argc, char *argv[])
        }
 
        d = rte_distributor_create("PKT_DIST", rte_socket_id(),
-                       rte_lcore_count() - 2,
+                       rte_lcore_count() - 4,
                        RTE_DIST_ALG_BURST);
        if (d == NULL)
                rte_exit(EXIT_FAILURE, "Cannot create distributor\n");
 
        /*
-        * scheduler ring is read only by the transmitter core, but written to
-        * by multiple threads
+        * scheduler ring is read by the transmitter core, and written to
+        * by scheduler core
         */
-       output_ring = rte_ring_create("Output_ring", RTE_RING_SZ,
-                       rte_socket_id(), RING_F_SC_DEQ);
-       if (output_ring == NULL)
+       dist_tx_ring = rte_ring_create("Output_ring", SCHED_TX_RING_SZ,
+                       rte_socket_id(), RING_F_SC_DEQ | RING_F_SP_ENQ);
+       if (dist_tx_ring == NULL)
+               rte_exit(EXIT_FAILURE, "Cannot create output ring\n");
+
+       rx_dist_ring = rte_ring_create("Input_ring", SCHED_RX_RING_SZ,
+                       rte_socket_id(), RING_F_SC_DEQ | RING_F_SP_ENQ);
+       if (rx_dist_ring == NULL)
                rte_exit(EXIT_FAILURE, "Cannot create output ring\n");
 
        RTE_LCORE_FOREACH_SLAVE(lcore_id) {
-               if (worker_id == rte_lcore_count() - 2)
+               if (worker_id == rte_lcore_count() - 3) {
+                       printf("Starting distributor on lcore_id %d\n",
+                                       lcore_id);
+                       /* distributor core */
+                       struct lcore_params *p =
+                                       rte_malloc(NULL, sizeof(*p), 0);
+                       if (!p)
+                               rte_panic("malloc failure\n");
+                       *p = (struct lcore_params){worker_id, d,
+                               rx_dist_ring, dist_tx_ring, mbuf_pool};
+                       rte_eal_remote_launch(
+                               (lcore_function_t *)lcore_distributor,
+                               p, lcore_id);
+               } else if (worker_id == rte_lcore_count() - 4) {
+                       printf("Starting tx  on worker_id %d, lcore_id %d\n",
+                                       worker_id, lcore_id);
+                       /* tx core */
                        rte_eal_remote_launch((lcore_function_t *)lcore_tx,
-                                       output_ring, lcore_id);
-               else {
+                                       dist_tx_ring, lcore_id);
+               } else if (worker_id == rte_lcore_count() - 2) {
+                       printf("Starting rx on worker_id %d, lcore_id %d\n",
+                                       worker_id, lcore_id);
+                       /* rx core */
                        struct lcore_params *p =
                                        rte_malloc(NULL, sizeof(*p), 0);
                        if (!p)
                                rte_panic("malloc failure\n");
-                       *p = (struct lcore_params){worker_id, d, output_ring, mbuf_pool};
+                       *p = (struct lcore_params){worker_id, d, rx_dist_ring,
+                                       dist_tx_ring, mbuf_pool};
+                       rte_eal_remote_launch((lcore_function_t *)lcore_rx,
+                                       p, lcore_id);
+               } else {
+                       printf("Starting worker on worker_id %d, lcore_id %d\n",
+                                       worker_id, lcore_id);
+                       struct lcore_params *p =
+                                       rte_malloc(NULL, sizeof(*p), 0);
+                       if (!p)
+                               rte_panic("malloc failure\n");
+                       *p = (struct lcore_params){worker_id, d, rx_dist_ring,
+                                       dist_tx_ring, mbuf_pool};
 
                        rte_eal_remote_launch((lcore_function_t *)lcore_worker,
                                        p, lcore_id);
                }
                worker_id++;
        }
-       /* call lcore_main on master core only */
-       struct lcore_params p = { 0, d, output_ring, mbuf_pool};
-
-       if (lcore_rx(&p) != 0)
-               return -1;
 
        freq = rte_get_timer_hz();
        t = rte_rdtsc() + freq;