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 * ``--prod_type_cryptodev``
125 Use crypto device as producer.
127 * ``--timer_tick_nsec``
129 Used to dictate number of nano seconds between bucket traversal of the
130 event timer adapter. Refer `rte_event_timer_adapter_conf`.
134 Used to configure event timer adapter max arm timeout in nano seconds.
138 Dictate the number of nano seconds after which the event timer expires.
142 Number of event timers each producer core will generate.
144 * ``--nb_timer_adptrs``
146 Number of event timer adapters to be used. Each adapter is used in
147 round robin manner by the producer cores.
151 Global dequeue timeout for all the event ports if the provided dequeue
152 timeout is out of the supported range of event device it will be
153 adjusted to the highest/lowest supported dequeue timeout supported.
155 * ``--crypto_adptr_mode``
157 Set crypto adapter mode. Use 0 for OP_NEW (default) and 1 for
160 * ``--crypto_op_type``
162 Set crypto operation type. Use 0 for symmetric crypto ops (default)
163 and 1 for asymmetric crypto ops.
167 Set packet mbuf size. Can be used to configure Jumbo Frames. Only
168 applicable for `pipeline_atq` and `pipeline_queue` tests.
172 Set max packet mbuf size. Can be used to configure Rx/Tx scatter gather.
173 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
175 * ``--prod_enq_burst_sz``
177 Set producer enqueue burst size. Can be used to configure the number of
178 events the producer(s) will enqueue as a burst to the event device.
179 Only applicable for `perf_queue` test.
181 * ``--nb_eth_queues``
183 Configure multiple Rx queues per each ethernet port.
184 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
186 * ``--enable_vector``
188 Enable event vector for Rx/Tx adapters.
189 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
193 Vector size to configure for the Rx adapter.
194 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
196 * ``--vector_tmo_ns``
198 Vector timeout nanoseconds to be configured for the Rx adapter.
199 Only applicable for `pipeline_atq` and `pipeline_queue` tests.
201 * ``--per_port_pool``
203 Configure unique mempool per ethernet device, the size of each pool
204 is equal to `pool_sz`.
205 Only applicable for pipeline_atq` and `pipeline_queue` tests.
214 This is a functional test case that aims at testing the following:
216 #. Verify the ingress order maintenance.
217 #. Verify the exclusive(atomic) access to given atomic flow per eventdev port.
219 .. _table_eventdev_order_queue_test:
221 .. table:: Order queue test eventdev configuration.
223 +---+--------------+----------------+------------------------+
224 | # | Items | Value | Comments |
226 +===+==============+================+========================+
227 | 1 | nb_queues | 2 | q0(ordered), q1(atomic)|
229 +---+--------------+----------------+------------------------+
230 | 2 | nb_producers | 1 | |
232 +---+--------------+----------------+------------------------+
233 | 3 | nb_workers | >= 1 | |
235 +---+--------------+----------------+------------------------+
236 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
237 | | | 1 | port n-1. Producer uses|
239 +---+--------------+----------------+------------------------+
241 .. _figure_eventdev_order_queue_test:
243 .. figure:: img/eventdev_order_queue_test.*
245 order queue test operation.
247 The order queue test configures the eventdev with two queues and an event
248 producer to inject the events to q0(ordered) queue. Both q0(ordered) and
249 q1(atomic) are linked to all the workers.
251 The event producer maintains a sequence number per flow and injects the events
252 to the ordered queue. The worker receives the events from ordered queue and
253 forwards to atomic queue. Since the events from an ordered queue can be
254 processed in parallel on the different workers, the ingress order of events
255 might have changed on the downstream atomic queue enqueue. On enqueue to the
256 atomic queue, the eventdev PMD reorders the event to the original
257 ingress order(i.e producer ingress order).
259 When the event is dequeued from the atomic queue by the worker, this test
260 verifies the expected sequence number of associated event per flow by comparing
261 the free running expected sequence number per flow.
266 Supported application command line options are following::
283 Example command to run order queue test:
285 .. code-block:: console
287 sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_sw0 -- \
288 --test=order_queue --plcores 1 --wlcores 2,3
294 This test verifies the same aspects of ``order_queue`` test, the difference is
295 the number of queues used, this test operates on a single ``all types queue(atq)``
296 instead of two different queues for ordered and atomic.
298 .. _table_eventdev_order_atq_test:
300 .. table:: Order all types queue test eventdev configuration.
302 +---+--------------+----------------+------------------------+
303 | # | Items | Value | Comments |
305 +===+==============+================+========================+
306 | 1 | nb_queues | 1 | q0(all types queue) |
308 +---+--------------+----------------+------------------------+
309 | 2 | nb_producers | 1 | |
311 +---+--------------+----------------+------------------------+
312 | 3 | nb_workers | >= 1 | |
314 +---+--------------+----------------+------------------------+
315 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
316 | | | 1 | port n-1.Producer uses |
318 +---+--------------+----------------+------------------------+
320 .. _figure_eventdev_order_atq_test:
322 .. figure:: img/eventdev_order_atq_test.*
324 order all types queue test operation.
329 Supported application command line options are following::
346 Example command to run order ``all types queue`` test:
348 .. code-block:: console
350 sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_octeontx -- \
351 --test=order_atq --plcores 1 --wlcores 2,3
357 This is a performance test case that aims at testing the following:
359 #. Measure the number of events can be processed in a second.
360 #. Measure the latency to forward an event.
362 .. _table_eventdev_perf_queue_test:
364 .. table:: Perf queue test eventdev configuration.
366 +---+--------------+----------------+-----------------------------------------+
367 | # | Items | Value | Comments |
369 +===+==============+================+=========================================+
370 | 1 | nb_queues | nb_producers * | Queues will be configured based on the |
371 | | | nb_stages | user requested sched type list(--stlist)|
372 +---+--------------+----------------+-----------------------------------------+
373 | 2 | nb_producers | >= 1 | Selected through --plcores command line |
375 +---+--------------+----------------+-----------------------------------------+
376 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
378 +---+--------------+----------------+-----------------------------------------+
379 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n-1. |
380 | | | nb_producers | Producers use port n to port p |
381 +---+--------------+----------------+-----------------------------------------+
383 .. _figure_eventdev_perf_queue_test:
385 .. figure:: img/eventdev_perf_queue_test.*
387 perf queue test operation.
389 The perf queue test configures the eventdev with Q queues and P ports, where
390 Q and P is a function of the number of workers, the number of producers and
391 number of stages as mentioned in :numref:`table_eventdev_perf_queue_test`.
393 The user can choose the number of workers, the number of producers and number of
394 stages through the ``--wlcores``, ``--plcores`` and the ``--stlist`` application
395 command line arguments respectively.
397 The producer(s) injects the events to eventdev based on the first stage sched type
398 list requested by the user through ``--stlist`` command line argument. It can
399 inject a burst of events using ``--prod_enq_burst_sz`` command line argument.
401 Based on the number of stages to process(selected through ``--stlist``),
402 The application forwards the event to next upstream queue and terminates when it
403 reaches the last stage in the pipeline. On event termination, application
404 increments the number events processed and print periodically in one second
405 to get the number of events processed in one second.
407 When ``--fwd_latency`` command line option selected, the application inserts
408 the timestamp in the event on the first stage and then on termination, it
409 updates the number of cycles to forward a packet. The application uses this
410 value to compute the average latency to a forward packet.
412 When ``--prod_type_ethdev`` command line option is selected, the application
413 uses the probed ethernet devices as producers by configuring them as Rx
414 adapters instead of using synthetic producers.
419 Supported application command line options are following::
435 --prod_type_timerdev_burst
437 --prod_type_cryptodev
450 Example command to run perf queue test:
452 .. code-block:: console
454 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
455 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
457 Example command to run perf queue test with producer enqueuing a burst of events:
459 .. code-block:: console
461 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
462 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0 \
463 --prod_enq_burst_sz=32
465 Example command to run perf queue test with ethernet ports:
467 .. code-block:: console
469 sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
470 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --prod_type_ethdev
472 Example command to run perf queue test with event timer adapter:
474 .. code-block:: console
476 sudo <build_dir>/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
477 --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
478 --prod_type_timerdev --fwd_latency
483 This is a performance test case that aims at testing the following with
484 ``all types queue`` eventdev scheme.
486 #. Measure the number of events can be processed in a second.
487 #. Measure the latency to forward an event.
489 .. _table_eventdev_perf_atq_test:
491 .. table:: Perf all types queue test eventdev configuration.
493 +---+--------------+----------------+-----------------------------------------+
494 | # | Items | Value | Comments |
496 +===+==============+================+=========================================+
497 | 1 | nb_queues | nb_producers | Queues will be configured based on the |
498 | | | | user requested sched type list(--stlist)|
499 +---+--------------+----------------+-----------------------------------------+
500 | 2 | nb_producers | >= 1 | Selected through --plcores command line |
502 +---+--------------+----------------+-----------------------------------------+
503 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
505 +---+--------------+----------------+-----------------------------------------+
506 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n-1. |
507 | | | nb_producers | Producers use port n to port p |
508 +---+--------------+----------------+-----------------------------------------+
510 .. _figure_eventdev_perf_atq_test:
512 .. figure:: img/eventdev_perf_atq_test.*
514 perf all types queue test operation.
517 The ``all types queues(atq)`` perf test configures the eventdev with Q queues
518 and P ports, where Q and P is a function of the number of workers and number of
519 producers as mentioned in :numref:`table_eventdev_perf_atq_test`.
522 The atq queue test functions as same as ``perf_queue`` test. The difference
523 is, It uses, ``all type queue scheme`` instead of separate queues for each
524 stage and thus reduces the number of queues required to realize the use case
525 and enables flow pinning as the event does not move to the next queue.
531 Supported application command line options are following::
546 --prod_type_timerdev_burst
548 --prod_type_cryptodev
560 Example command to run perf ``all types queue`` test:
562 .. code-block:: console
564 sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_octeontx -- \
565 --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
567 Example command to run perf ``all types queue`` test with event timer adapter:
569 .. code-block:: console
571 sudo <build_dir>/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
572 --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \
573 --stlist=a --prod_type_timerdev --fwd_latency
579 This is a pipeline test case that aims at testing the following:
581 #. Measure the end-to-end performance of an event dev with a ethernet dev.
582 #. Maintain packet ordering from Rx to Tx.
584 .. _table_eventdev_pipeline_queue_test:
586 .. table:: Pipeline queue test eventdev configuration.
588 +---+--------------+----------------+-----------------------------------------+
589 | # | Items | Value | Comments |
591 +===+==============+================+=========================================+
592 | 1 | nb_queues | (nb_producers | Queues will be configured based on the |
593 | | | * nb_stages) + | user requested sched type list(--stlist)|
594 | | | nb_producers | At the last stage of the schedule list |
595 | | | | the event is enqueued onto per port |
596 | | | | unique queue which is then Transmitted. |
597 +---+--------------+----------------+-----------------------------------------+
598 | 2 | nb_producers | >= 1 | Producers will be configured based on |
599 | | | | the number of detected ethernet devices.|
600 | | | | Each ethdev will be configured as an Rx |
602 +---+--------------+----------------+-----------------------------------------+
603 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
605 +---+--------------+----------------+-----------------------------------------+
606 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n. |
607 | | | (nb_produces * | Producers use port n+1 to port n+m, |
608 | | | 2) | depending on the Rx adapter capability. |
609 | | | | Consumers use port n+m+1 to port n+o |
610 | | | | depending on the Tx adapter capability. |
611 +---+--------------+----------------+-----------------------------------------+
613 .. _figure_eventdev_pipeline_queue_test_generic:
615 .. figure:: img/eventdev_pipeline_queue_test_generic.*
617 .. _figure_eventdev_pipeline_queue_test_internal_port:
619 .. figure:: img/eventdev_pipeline_queue_test_internal_port.*
621 pipeline queue test operation.
623 The pipeline queue test configures the eventdev with Q queues and P ports,
624 where Q and P is a function of the number of workers, the number of producers
625 and number of stages as mentioned in :numref:`table_eventdev_pipeline_queue_test`.
627 The user can choose the number of workers and number of stages through the
628 ``--wlcores`` and the ``--stlist`` application command line arguments
631 The number of producers depends on the number of ethernet devices detected and
632 each ethernet device is configured as a event_eth_rx_adapter that acts as a
635 The producer(s) injects the events to eventdev based the first stage sched type
636 list requested by the user through ``--stlist`` the command line argument.
638 Based on the number of stages to process(selected through ``--stlist``),
639 The application forwards the event to next upstream queue and when it reaches
640 the last stage in the pipeline if the event type is ``atomic`` it is enqueued
641 onto ethdev Tx queue else to maintain ordering the event type is set to
642 ``atomic`` and enqueued onto the last stage queue.
644 If the ethdev and eventdev pair have ``RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT``
645 capability then the worker cores enqueue the packets to the eventdev directly
646 using ``rte_event_eth_tx_adapter_enqueue`` else the worker cores enqueue the
647 packet onto the ``SINGLE_LINK_QUEUE`` that is managed by the Tx adapter.
648 The Tx adapter dequeues the packet and transmits it.
650 On packet Tx, application increments the number events processed and print
651 periodically in one second to get the number of events processed in one
658 Supported application command line options are following::
679 * The ``--prod_type_ethdev`` is mandatory for running this test.
684 Example command to run pipeline queue test:
686 .. code-block:: console
688 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
689 --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a
691 Example command to run pipeline atq test with vector events:
693 .. code-block:: console
695 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
696 --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a \
697 --enable_vector --vector_size 512
702 This is a pipeline test case that aims at testing the following with
703 ``all types queue`` eventdev scheme.
705 #. Measure the end-to-end performance of an event dev with a ethernet dev.
706 #. Maintain packet ordering from Rx to Tx.
708 .. _table_eventdev_pipeline_atq_test:
710 .. table:: Pipeline atq test eventdev configuration.
712 +---+--------------+----------------+-----------------------------------------+
713 | # | Items | Value | Comments |
715 +===+==============+================+=========================================+
716 | 1 | nb_queues | nb_producers + | Queues will be configured based on the |
717 | | | x | user requested sched type list(--stlist)|
718 | | | | where x = nb_producers in generic |
719 | | | | pipeline and 0 if all the ethdev |
720 | | | | being used have Internal port capability|
721 +---+--------------+----------------+-----------------------------------------+
722 | 2 | nb_producers | >= 1 | Producers will be configured based on |
723 | | | | the number of detected ethernet devices.|
724 | | | | Each ethdev will be configured as an Rx |
726 +---+--------------+----------------+-----------------------------------------+
727 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
729 +---+--------------+----------------+-----------------------------------------+
730 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n. |
731 | | | nb_producers + | Producers use port n+1 to port n+m, |
732 | | | x | depending on the Rx adapter capability. |
733 | | | | x = nb_producers in generic pipeline and|
734 | | | | 0 if all the ethdev being used have |
735 | | | | Internal port capability. |
736 | | | | Consumers may use port n+m+1 to port n+o|
737 | | | | depending on the Tx adapter capability. |
738 +---+--------------+----------------+-----------------------------------------+
740 .. _figure_eventdev_pipeline_atq_test_generic:
742 .. figure:: img/eventdev_pipeline_atq_test_generic.*
744 .. _figure_eventdev_pipeline_atq_test_internal_port:
746 .. figure:: img/eventdev_pipeline_atq_test_internal_port.*
748 pipeline atq test operation.
750 The pipeline atq test configures the eventdev with Q queues and P ports,
751 where Q and P is a function of the number of workers, the number of producers
752 and number of stages as mentioned in :numref:`table_eventdev_pipeline_atq_test`.
754 The atq queue test functions as same as ``pipeline_queue`` test. The difference
755 is, It uses, ``all type queue scheme`` instead of separate queues for each
756 stage and thus reduces the number of queues required to realize the use case.
762 Supported application command line options are following::
783 * The ``--prod_type_ethdev`` is mandatory for running this test.
788 Example command to run pipeline atq test:
790 .. code-block:: console
792 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
793 --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a
795 Example command to run pipeline atq test with vector events:
797 .. code-block:: console
799 sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
800 --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a \
801 --enable_vector --vector_size 512