1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2017 Cavium, Inc
4 dpdk-test-eventdev Application
5 ==============================
7 The ``dpdk-test-eventdev`` tool is a Data Plane Development Kit (DPDK)
8 application that allows exercising various eventdev use cases.
9 This application has a generic framework to add new eventdev based test cases to
10 verify functionality and measure the performance parameters of DPDK eventdev
14 Running the Application
15 -----------------------
17 The application has a number of command line options:
19 .. code-block:: console
21 dpdk-test-eventdev [EAL Options] -- [application options]
26 The following are the EAL command-line options that can be used in conjunction
27 with the ``dpdk-test-eventdev`` application.
28 See the DPDK Getting Started Guides for more information on these options.
30 * ``-c <COREMASK>`` or ``-l <CORELIST>``
32 Set the hexadecimal bitmask of the cores to run on. The corelist is a
35 * ``--vdev <driver><id>``
37 Add a virtual eventdev device.
42 The following are the application command-line options:
46 Set verbose level. Default is 1. Value > 1 displays more details.
50 Set the device id of the event device.
54 Set test name, where ``name`` is one of the following::
65 Set the socket id of the application resources.
69 Set the number of mbufs to be allocated from the mempool.
71 * ``--plcores <CORELIST>``
73 Set the list of cores to be used as producers.
75 * ``--wlcores <CORELIST>``
77 Set the list of cores to be used as workers.
79 * ``--stlist <type_list>``
81 Set the scheduled type of each stage where ``type_list`` size
82 determines the number of stages used in the test application.
83 Each type_list member can be one of the following::
85 P or p : Parallel schedule type
86 O or o : Ordered schedule type
87 A or a : Atomic schedule type
89 Application expects the ``type_list`` in comma separated form (i.e. ``--stlist o,a,a,a``)
93 Set the number of flows to produce.
97 Set the number of packets to produce. 0 implies no limit.
99 * ``--worker_deq_depth <n>``
101 Set the dequeue depth of the worker.
105 Perform forward latency measurement.
107 * ``--queue_priority``
109 Enable queue priority.
111 * ``--prod_type_ethdev``
113 Use ethernet device as producer.
115 * ``--prod_type_timerdev``
117 Use event timer adapter as producer.
119 * ``--prod_type_timerdev_burst``
121 Use burst mode event timer adapter as producer.
123 * ``--timer_tick_nsec``
125 Used to dictate number of nano seconds between bucket traversal of the
126 event timer adapter. Refer `rte_event_timer_adapter_conf`.
130 Used to configure event timer adapter max arm timeout in nano seconds.
134 Dictate the number of nano seconds after which the event timer expires.
138 Number of event timers each producer core will generate.
140 * ``--nb_timer_adptrs``
142 Number of event timer adapters to be used. Each adapter is used in
143 round robin manner by the producer cores.
147 Global dequeue timeout for all the event ports if the provided dequeue
148 timeout is out of the supported range of event device it will be
149 adjusted to the highest/lowest supported dequeue timeout supported.
153 Set packet mbuf size. Can be used to configure Jumbo Frames. Only
154 applicable for `pipeline_atq` and `pipeline_queue` tests.
158 Set max packet mbuf size. Can be used to configure Rx/Tx scatter gather.
159 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
161 * ``--prod_enq_burst_sz``
163 Set producer enqueue burst size. Can be used to configure the number of
164 events the producer(s) will enqueue as a burst to the event device.
165 Only applicable for `perf_queue` test.
167 * ``--nb_eth_queues``
169 Configure multiple Rx queues per each ethernet port.
170 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
172 * ``--enable_vector``
174 Enable event vector for Rx/Tx adapters.
175 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
179 Vector size to configure for the Rx adapter.
180 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
182 * ``--vector_tmo_ns``
184 Vector timeout nanoseconds to be configured for the Rx adapter.
185 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
187 * ``--per_port_pool``
189 Configure unique mempool per ethernet device, the size of each pool
190 is equal to `pool_sz`.
191 Only applicable for pipeline_atq` and `pipeline_queue` tests.
200 This is a functional test case that aims at testing the following:
202 #. Verify the ingress order maintenance.
203 #. Verify the exclusive(atomic) access to given atomic flow per eventdev port.
205 .. _table_eventdev_order_queue_test:
207 .. table:: Order queue test eventdev configuration.
209 +---+--------------+----------------+------------------------+
210 | # | Items | Value | Comments |
212 +===+==============+================+========================+
213 | 1 | nb_queues | 2 | q0(ordered), q1(atomic)|
215 +---+--------------+----------------+------------------------+
216 | 2 | nb_producers | 1 | |
218 +---+--------------+----------------+------------------------+
219 | 3 | nb_workers | >= 1 | |
221 +---+--------------+----------------+------------------------+
222 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
223 | | | 1 | port n-1. Producer uses|
225 +---+--------------+----------------+------------------------+
227 .. _figure_eventdev_order_queue_test:
229 .. figure:: img/eventdev_order_queue_test.*
231 order queue test operation.
233 The order queue test configures the eventdev with two queues and an event
234 producer to inject the events to q0(ordered) queue. Both q0(ordered) and
235 q1(atomic) are linked to all the workers.
237 The event producer maintains a sequence number per flow and injects the events
238 to the ordered queue. The worker receives the events from ordered queue and
239 forwards to atomic queue. Since the events from an ordered queue can be
240 processed in parallel on the different workers, the ingress order of events
241 might have changed on the downstream atomic queue enqueue. On enqueue to the
242 atomic queue, the eventdev PMD driver reorders the event to the original
243 ingress order(i.e producer ingress order).
245 When the event is dequeued from the atomic queue by the worker, this test
246 verifies the expected sequence number of associated event per flow by comparing
247 the free running expected sequence number per flow.
252 Supported application command line options are following::
269 Example command to run order queue test:
271 .. code-block:: console
273 sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_sw0 -- \
274 --test=order_queue --plcores 1 --wlcores 2,3
280 This test verifies the same aspects of ``order_queue`` test, the difference is
281 the number of queues used, this test operates on a single ``all types queue(atq)``
282 instead of two different queues for ordered and atomic.
284 .. _table_eventdev_order_atq_test:
286 .. table:: Order all types queue test eventdev configuration.
288 +---+--------------+----------------+------------------------+
289 | # | Items | Value | Comments |
291 +===+==============+================+========================+
292 | 1 | nb_queues | 1 | q0(all types queue) |
294 +---+--------------+----------------+------------------------+
295 | 2 | nb_producers | 1 | |
297 +---+--------------+----------------+------------------------+
298 | 3 | nb_workers | >= 1 | |
300 +---+--------------+----------------+------------------------+
301 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
302 | | | 1 | port n-1.Producer uses |
304 +---+--------------+----------------+------------------------+
306 .. _figure_eventdev_order_atq_test:
308 .. figure:: img/eventdev_order_atq_test.*
310 order all types queue test operation.
315 Supported application command line options are following::
332 Example command to run order ``all types queue`` test:
334 .. code-block:: console
336 sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_octeontx -- \
337 --test=order_atq --plcores 1 --wlcores 2,3
343 This is a performance test case that aims at testing the following:
345 #. Measure the number of events can be processed in a second.
346 #. Measure the latency to forward an event.
348 .. _table_eventdev_perf_queue_test:
350 .. table:: Perf queue test eventdev configuration.
352 +---+--------------+----------------+-----------------------------------------+
353 | # | Items | Value | Comments |
355 +===+==============+================+=========================================+
356 | 1 | nb_queues | nb_producers * | Queues will be configured based on the |
357 | | | nb_stages | user requested sched type list(--stlist)|
358 +---+--------------+----------------+-----------------------------------------+
359 | 2 | nb_producers | >= 1 | Selected through --plcores command line |
361 +---+--------------+----------------+-----------------------------------------+
362 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
364 +---+--------------+----------------+-----------------------------------------+
365 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n-1. |
366 | | | nb_producers | Producers use port n to port p |
367 +---+--------------+----------------+-----------------------------------------+
369 .. _figure_eventdev_perf_queue_test:
371 .. figure:: img/eventdev_perf_queue_test.*
373 perf queue test operation.
375 The perf queue test configures the eventdev with Q queues and P ports, where
376 Q and P is a function of the number of workers, the number of producers and
377 number of stages as mentioned in :numref:`table_eventdev_perf_queue_test`.
379 The user can choose the number of workers, the number of producers and number of
380 stages through the ``--wlcores``, ``--plcores`` and the ``--stlist`` application
381 command line arguments respectively.
383 The producer(s) injects the events to eventdev based on the first stage sched type
384 list requested by the user through ``--stlist`` command line argument. It can
385 inject a burst of events using ``--prod_enq_burst_sz`` command line argument.
387 Based on the number of stages to process(selected through ``--stlist``),
388 The application forwards the event to next upstream queue and terminates when it
389 reaches the last stage in the pipeline. On event termination, application
390 increments the number events processed and print periodically in one second
391 to get the number of events processed in one second.
393 When ``--fwd_latency`` command line option selected, the application inserts
394 the timestamp in the event on the first stage and then on termination, it
395 updates the number of cycles to forward a packet. The application uses this
396 value to compute the average latency to a forward packet.
398 When ``--prod_type_ethdev`` command line option is selected, the application
399 uses the probed ethernet devices as producers by configuring them as Rx
400 adapters instead of using synthetic producers.
405 Supported application command line options are following::
421 --prod_type_timerdev_burst
434 Example command to run perf queue test:
436 .. code-block:: console
438 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
439 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
441 Example command to run perf queue test with producer enqueuing a burst of events:
443 .. code-block:: console
445 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
446 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0 \
447 --prod_enq_burst_sz=32
449 Example command to run perf queue test with ethernet ports:
451 .. code-block:: console
453 sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
454 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --prod_type_ethdev
456 Example command to run perf queue test with event timer adapter:
458 .. code-block:: console
460 sudo <build_dir>/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
461 --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
462 --prod_type_timerdev --fwd_latency
467 This is a performance test case that aims at testing the following with
468 ``all types queue`` eventdev scheme.
470 #. Measure the number of events can be processed in a second.
471 #. Measure the latency to forward an event.
473 .. _table_eventdev_perf_atq_test:
475 .. table:: Perf all types queue test eventdev configuration.
477 +---+--------------+----------------+-----------------------------------------+
478 | # | Items | Value | Comments |
480 +===+==============+================+=========================================+
481 | 1 | nb_queues | nb_producers | Queues will be configured based on the |
482 | | | | user requested sched type list(--stlist)|
483 +---+--------------+----------------+-----------------------------------------+
484 | 2 | nb_producers | >= 1 | Selected through --plcores command line |
486 +---+--------------+----------------+-----------------------------------------+
487 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
489 +---+--------------+----------------+-----------------------------------------+
490 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n-1. |
491 | | | nb_producers | Producers use port n to port p |
492 +---+--------------+----------------+-----------------------------------------+
494 .. _figure_eventdev_perf_atq_test:
496 .. figure:: img/eventdev_perf_atq_test.*
498 perf all types queue test operation.
501 The ``all types queues(atq)`` perf test configures the eventdev with Q queues
502 and P ports, where Q and P is a function of the number of workers and number of
503 producers as mentioned in :numref:`table_eventdev_perf_atq_test`.
506 The atq queue test functions as same as ``perf_queue`` test. The difference
507 is, It uses, ``all type queue scheme`` instead of separate queues for each
508 stage and thus reduces the number of queues required to realize the use case
509 and enables flow pinning as the event does not move to the next queue.
515 Supported application command line options are following::
530 --prod_type_timerdev_burst
542 Example command to run perf ``all types queue`` test:
544 .. code-block:: console
546 sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_octeontx -- \
547 --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
549 Example command to run perf ``all types queue`` test with event timer adapter:
551 .. code-block:: console
553 sudo <build_dir>/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
554 --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \
555 --stlist=a --prod_type_timerdev --fwd_latency
561 This is a pipeline test case that aims at testing the following:
563 #. Measure the end-to-end performance of an event dev with a ethernet dev.
564 #. Maintain packet ordering from Rx to Tx.
566 .. _table_eventdev_pipeline_queue_test:
568 .. table:: Pipeline queue test eventdev configuration.
570 +---+--------------+----------------+-----------------------------------------+
571 | # | Items | Value | Comments |
573 +===+==============+================+=========================================+
574 | 1 | nb_queues | (nb_producers | Queues will be configured based on the |
575 | | | * nb_stages) + | user requested sched type list(--stlist)|
576 | | | nb_producers | At the last stage of the schedule list |
577 | | | | the event is enqueued onto per port |
578 | | | | unique queue which is then Transmitted. |
579 +---+--------------+----------------+-----------------------------------------+
580 | 2 | nb_producers | >= 1 | Producers will be configured based on |
581 | | | | the number of detected ethernet devices.|
582 | | | | Each ethdev will be configured as an Rx |
584 +---+--------------+----------------+-----------------------------------------+
585 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
587 +---+--------------+----------------+-----------------------------------------+
588 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n. |
589 | | | (nb_produces * | Producers use port n+1 to port n+m, |
590 | | | 2) | depending on the Rx adapter capability. |
591 | | | | Consumers use port n+m+1 to port n+o |
592 | | | | depending on the Tx adapter capability. |
593 +---+--------------+----------------+-----------------------------------------+
595 .. _figure_eventdev_pipeline_queue_test_generic:
597 .. figure:: img/eventdev_pipeline_queue_test_generic.*
599 .. _figure_eventdev_pipeline_queue_test_internal_port:
601 .. figure:: img/eventdev_pipeline_queue_test_internal_port.*
603 pipeline queue test operation.
605 The pipeline queue test configures the eventdev with Q queues and P ports,
606 where Q and P is a function of the number of workers, the number of producers
607 and number of stages as mentioned in :numref:`table_eventdev_pipeline_queue_test`.
609 The user can choose the number of workers and number of stages through the
610 ``--wlcores`` and the ``--stlist`` application command line arguments
613 The number of producers depends on the number of ethernet devices detected and
614 each ethernet device is configured as a event_eth_rx_adapter that acts as a
617 The producer(s) injects the events to eventdev based the first stage sched type
618 list requested by the user through ``--stlist`` the command line argument.
620 Based on the number of stages to process(selected through ``--stlist``),
621 The application forwards the event to next upstream queue and when it reaches
622 the last stage in the pipeline if the event type is ``atomic`` it is enqueued
623 onto ethdev Tx queue else to maintain ordering the event type is set to
624 ``atomic`` and enqueued onto the last stage queue.
626 If the ethdev and eventdev pair have ``RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT``
627 capability then the worker cores enqueue the packets to the eventdev directly
628 using ``rte_event_eth_tx_adapter_enqueue`` else the worker cores enqueue the
629 packet onto the ``SINGLE_LINK_QUEUE`` that is managed by the Tx adapter.
630 The Tx adapter dequeues the packet and transmits it.
632 On packet Tx, application increments the number events processed and print
633 periodically in one second to get the number of events processed in one
640 Supported application command line options are following::
661 * The ``--prod_type_ethdev`` is mandatory for running this test.
666 Example command to run pipeline queue test:
668 .. code-block:: console
670 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
671 --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a
673 Example command to run pipeline atq test with vector events:
675 .. code-block:: console
677 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
678 --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a \
679 --enable_vector --vector_size 512
684 This is a pipeline test case that aims at testing the following with
685 ``all types queue`` eventdev scheme.
687 #. Measure the end-to-end performance of an event dev with a ethernet dev.
688 #. Maintain packet ordering from Rx to Tx.
690 .. _table_eventdev_pipeline_atq_test:
692 .. table:: Pipeline atq test eventdev configuration.
694 +---+--------------+----------------+-----------------------------------------+
695 | # | Items | Value | Comments |
697 +===+==============+================+=========================================+
698 | 1 | nb_queues | nb_producers + | Queues will be configured based on the |
699 | | | x | user requested sched type list(--stlist)|
700 | | | | where x = nb_producers in generic |
701 | | | | pipeline and 0 if all the ethdev |
702 | | | | being used have Internal port capability|
703 +---+--------------+----------------+-----------------------------------------+
704 | 2 | nb_producers | >= 1 | Producers will be configured based on |
705 | | | | the number of detected ethernet devices.|
706 | | | | Each ethdev will be configured as an Rx |
708 +---+--------------+----------------+-----------------------------------------+
709 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
711 +---+--------------+----------------+-----------------------------------------+
712 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n. |
713 | | | nb_producers + | Producers use port n+1 to port n+m, |
714 | | | x | depending on the Rx adapter capability. |
715 | | | | x = nb_producers in generic pipeline and|
716 | | | | 0 if all the ethdev being used have |
717 | | | | Internal port capability. |
718 | | | | Consumers may use port n+m+1 to port n+o|
719 | | | | depending on the Tx adapter capability. |
720 +---+--------------+----------------+-----------------------------------------+
722 .. _figure_eventdev_pipeline_atq_test_generic:
724 .. figure:: img/eventdev_pipeline_atq_test_generic.*
726 .. _figure_eventdev_pipeline_atq_test_internal_port:
728 .. figure:: img/eventdev_pipeline_atq_test_internal_port.*
730 pipeline atq test operation.
732 The pipeline atq test configures the eventdev with Q queues and P ports,
733 where Q and P is a function of the number of workers, the number of producers
734 and number of stages as mentioned in :numref:`table_eventdev_pipeline_atq_test`.
736 The atq queue test functions as same as ``pipeline_queue`` test. The difference
737 is, It uses, ``all type queue scheme`` instead of separate queues for each
738 stage and thus reduces the number of queues required to realize the use case.
744 Supported application command line options are following::
765 * The ``--prod_type_ethdev`` is mandatory for running this test.
770 Example command to run pipeline atq test:
772 .. code-block:: console
774 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
775 --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a
777 Example command to run pipeline atq test with vector events:
779 .. code-block:: console
781 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
782 --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a \
783 --enable_vector --vector_size 512