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
13 Compiling the Application
14 -------------------------
16 **Build the application**
18 Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
19 ``dpdk-test-eventdev`` application.
21 Initially, the user must select a DPDK target to choose the correct target type
22 and compiler options to use when building the libraries.
23 The user must have all libraries, modules, updates and compilers installed
24 in the system prior to this,
25 as described in the earlier chapters in this Getting Started Guide.
27 Running the Application
28 -----------------------
30 The application has a number of command line options:
32 .. code-block:: console
34 dpdk-test-eventdev [EAL Options] -- [application options]
39 The following are the EAL command-line options that can be used in conjunction
40 with the ``dpdk-test-eventdev`` application.
41 See the DPDK Getting Started Guides for more information on these options.
43 * ``-c <COREMASK>`` or ``-l <CORELIST>``
45 Set the hexadecimal bitmask of the cores to run on. The corelist is a
48 * ``--vdev <driver><id>``
50 Add a virtual eventdev device.
55 The following are the application command-line options:
59 Set verbose level. Default is 1. Value > 1 displays more details.
63 Set the device id of the event device.
67 Set test name, where ``name`` is one of the following::
76 Set the socket id of the application resources.
80 Set the number of mbufs to be allocated from the mempool.
82 * ``--plcores <CORELIST>``
84 Set the list of cores to be used as producers.
86 * ``--wlcores <CORELIST>``
88 Set the list of cores to be used as workers.
90 * ``--stlist <type_list>``
92 Set the scheduled type of each stage where ``type_list`` size
93 determines the number of stages used in the test application.
94 Each type_list member can be one of the following::
96 P or p : Parallel schedule type
97 O or o : Ordered schedule type
98 A or a : Atomic schedule type
100 Application expects the ``type_list`` in comma separated form (i.e. ``--stlist o,a,a,a``)
104 Set the number of flows to produce.
108 Set the number of packets to produce. 0 implies no limit.
110 * ``--worker_deq_depth <n>``
112 Set the dequeue depth of the worker.
116 Perform forward latency measurement.
118 * ``--queue_priority``
120 Enable queue priority.
122 * ``--prod_type_ethdev``
124 Use ethernet device as producer.
126 * ``--prod_type_timerdev``
128 Use event timer adapter as producer.
136 This is a functional test case that aims at testing the following:
138 #. Verify the ingress order maintenance.
139 #. Verify the exclusive(atomic) access to given atomic flow per eventdev port.
141 .. _table_eventdev_order_queue_test:
143 .. table:: Order queue test eventdev configuration.
145 +---+--------------+----------------+------------------------+
146 | # | Items | Value | Comments |
148 +===+==============+================+========================+
149 | 1 | nb_queues | 2 | q0(ordered), q1(atomic)|
151 +---+--------------+----------------+------------------------+
152 | 2 | nb_producers | 1 | |
154 +---+--------------+----------------+------------------------+
155 | 3 | nb_workers | >= 1 | |
157 +---+--------------+----------------+------------------------+
158 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
159 | | | 1 | port n-1. Producer uses|
161 +---+--------------+----------------+------------------------+
163 .. _figure_eventdev_order_queue_test:
165 .. figure:: img/eventdev_order_queue_test.*
167 order queue test operation.
169 The order queue test configures the eventdev with two queues and an event
170 producer to inject the events to q0(ordered) queue. Both q0(ordered) and
171 q1(atomic) are linked to all the workers.
173 The event producer maintains a sequence number per flow and injects the events
174 to the ordered queue. The worker receives the events from ordered queue and
175 forwards to atomic queue. Since the events from an ordered queue can be
176 processed in parallel on the different workers, the ingress order of events
177 might have changed on the downstream atomic queue enqueue. On enqueue to the
178 atomic queue, the eventdev PMD driver reorders the event to the original
179 ingress order(i.e producer ingress order).
181 When the event is dequeued from the atomic queue by the worker, this test
182 verifies the expected sequence number of associated event per flow by comparing
183 the free running expected sequence number per flow.
188 Supported application command line options are following::
204 Example command to run order queue test:
206 .. code-block:: console
208 sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
209 --test=order_queue --plcores 1 --wlcores 2,3
215 This test verifies the same aspects of ``order_queue`` test, the difference is
216 the number of queues used, this test operates on a single ``all types queue(atq)``
217 instead of two different queues for ordered and atomic.
219 .. _table_eventdev_order_atq_test:
221 .. table:: Order all types queue test eventdev configuration.
223 +---+--------------+----------------+------------------------+
224 | # | Items | Value | Comments |
226 +===+==============+================+========================+
227 | 1 | nb_queues | 1 | q0(all types queue) |
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_atq_test:
243 .. figure:: img/eventdev_order_atq_test.*
245 order all types queue test operation.
250 Supported application command line options are following::
266 Example command to run order ``all types queue`` test:
268 .. code-block:: console
270 sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
271 --test=order_atq --plcores 1 --wlcores 2,3
277 This is a performance test case that aims at testing the following:
279 #. Measure the number of events can be processed in a second.
280 #. Measure the latency to forward an event.
282 .. _table_eventdev_perf_queue_test:
284 .. table:: Perf queue test eventdev configuration.
286 +---+--------------+----------------+-----------------------------------------+
287 | # | Items | Value | Comments |
289 +===+==============+================+=========================================+
290 | 1 | nb_queues | nb_producers * | Queues will be configured based on the |
291 | | | nb_stages | user requested sched type list(--stlist)|
292 +---+--------------+----------------+-----------------------------------------+
293 | 2 | nb_producers | >= 1 | Selected through --plcores command line |
295 +---+--------------+----------------+-----------------------------------------+
296 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
298 +---+--------------+----------------+-----------------------------------------+
299 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n-1. |
300 | | | nb_producers | Producers use port n to port p |
301 +---+--------------+----------------+-----------------------------------------+
303 .. _figure_eventdev_perf_queue_test:
305 .. figure:: img/eventdev_perf_queue_test.*
307 perf queue test operation.
309 The perf queue test configures the eventdev with Q queues and P ports, where
310 Q and P is a function of the number of workers, the number of producers and
311 number of stages as mentioned in :numref:`table_eventdev_perf_queue_test`.
313 The user can choose the number of workers, the number of producers and number of
314 stages through the ``--wlcores``, ``--plcores`` and the ``--stlist`` application
315 command line arguments respectively.
317 The producer(s) injects the events to eventdev based the first stage sched type
318 list requested by the user through ``--stlist`` the command line argument.
320 Based on the number of stages to process(selected through ``--stlist``),
321 The application forwards the event to next upstream queue and terminates when it
322 reaches the last stage in the pipeline. On event termination, application
323 increments the number events processed and print periodically in one second
324 to get the number of events processed in one second.
326 When ``--fwd_latency`` command line option selected, the application inserts
327 the timestamp in the event on the first stage and then on termination, it
328 updates the number of cycles to forward a packet. The application uses this
329 value to compute the average latency to a forward packet.
331 When ``--prod_type_ethdev`` command line option is selected, the application
332 uses the probed ethernet devices as producers by configuring them as Rx
333 adapters instead of using synthetic producers.
338 Supported application command line options are following::
359 Example command to run perf queue test:
361 .. code-block:: console
363 sudo build/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
364 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
366 Example command to run perf queue test with ethernet ports:
368 .. code-block:: console
370 sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
371 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --prod_type_ethdev
373 Example command to run perf queue test with event timer adapter:
375 .. code-block:: console
377 sudo build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
378 --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
379 --prod_type_timerdev --fwd_latency
384 This is a performance test case that aims at testing the following with
385 ``all types queue`` eventdev scheme.
387 #. Measure the number of events can be processed in a second.
388 #. Measure the latency to forward an event.
390 .. _table_eventdev_perf_atq_test:
392 .. table:: Perf all types queue test eventdev configuration.
394 +---+--------------+----------------+-----------------------------------------+
395 | # | Items | Value | Comments |
397 +===+==============+================+=========================================+
398 | 1 | nb_queues | nb_producers | Queues will be configured based on the |
399 | | | | user requested sched type list(--stlist)|
400 +---+--------------+----------------+-----------------------------------------+
401 | 2 | nb_producers | >= 1 | Selected through --plcores command line |
403 +---+--------------+----------------+-----------------------------------------+
404 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
406 +---+--------------+----------------+-----------------------------------------+
407 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n-1. |
408 | | | nb_producers | Producers use port n to port p |
409 +---+--------------+----------------+-----------------------------------------+
411 .. _figure_eventdev_perf_atq_test:
413 .. figure:: img/eventdev_perf_atq_test.*
415 perf all types queue test operation.
418 The ``all types queues(atq)`` perf test configures the eventdev with Q queues
419 and P ports, where Q and P is a function of the number of workers and number of
420 producers as mentioned in :numref:`table_eventdev_perf_atq_test`.
423 The atq queue test functions as same as ``perf_queue`` test. The difference
424 is, It uses, ``all type queue scheme`` instead of separate queues for each
425 stage and thus reduces the number of queues required to realize the use case
426 and enables flow pinning as the event does not move to the next queue.
432 Supported application command line options are following::
452 Example command to run perf ``all types queue`` test:
454 .. code-block:: console
456 sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
457 --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
459 Example command to run perf ``all types queue`` test with event timer adapter:
461 .. code-block:: console
463 sudo build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
464 --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \
465 --stlist=a --prod_type_timerdev --fwd_latency
471 This is a pipeline test case that aims at testing the following:
473 #. Measure the end-to-end performance of an event dev with a ethernet dev.
474 #. Maintain packet ordering from Rx to Tx.
476 .. _table_eventdev_pipeline_queue_test:
478 .. table:: Pipeline queue test eventdev configuration.
480 +---+--------------+----------------+-----------------------------------------+
481 | # | Items | Value | Comments |
483 +===+==============+================+=========================================+
484 | 1 | nb_queues | (nb_producers | Queues will be configured based on the |
485 | | | * nb_stages) + | user requested sched type list(--stlist)|
486 | | | x | Here value of x is 1 in generic pipeline|
487 | | | | and nb_producers in lockfree pipeline |
488 +---+--------------+----------------+-----------------------------------------+
489 | 2 | nb_producers | >= 1 | Producers will be configured based on |
490 | | | | the number of detected ethernet devices.|
491 | | | | Each ethdev will be configured as an Rx |
493 +---+--------------+----------------+-----------------------------------------+
494 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
496 +---+--------------+----------------+-----------------------------------------+
497 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n. |
498 | | | nb_producers | Producers use port n+1 to port n+m, |
499 | | | | depending on the Rx adapter capability. |
500 +---+--------------+----------------+-----------------------------------------+
502 .. _figure_eventdev_pipeline_queue_test_generic:
504 .. figure:: img/eventdev_pipeline_queue_test_generic.*
506 .. _figure_eventdev_pipeline_queue_test_lockfree:
508 .. figure:: img/eventdev_pipeline_queue_test_lockfree.*
510 pipeline queue test operation.
512 The pipeline queue test configures the eventdev with Q queues and P ports,
513 where Q and P is a function of the number of workers, the number of producers
514 and number of stages as mentioned in :numref:`table_eventdev_pipeline_queue_test`.
516 The user can choose the number of workers and number of stages through the
517 ``--wlcores`` and the ``--stlist`` application command line arguments
520 The number of producers depends on the number of ethernet devices detected and
521 each ethernet device is configured as a event_eth_rx_adapter that acts as a
524 The producer(s) injects the events to eventdev based the first stage sched type
525 list requested by the user through ``--stlist`` the command line argument.
527 Based on the number of stages to process(selected through ``--stlist``),
528 The application forwards the event to next upstream queue and when it reaches
529 the last stage in the pipeline if the event type is ``atomic`` it is enqueued
530 onto ethdev Tx queue else to maintain ordering the event type is set to
531 ``atomic`` and enqueued onto the last stage queue.
533 If the ethernet has ``DEV_TX_OFFLOAD_MT_LOCKFREE`` capability then the worker
534 cores transmit the packets directly. Else the worker cores enqueue the packet
535 onto the ``SINGLE_LINK_QUEUE`` that is managed by a Tx service. The Tx service
536 dequeues the packet and transmits it.
538 On packet Tx, application increments the number events processed and print
539 periodically in one second to get the number of events processed in one
546 Supported application command line options are following::
561 * The ``--prod_type_ethdev`` is mandatory for running this test.
566 Example command to run pipeline queue test:
568 .. code-block:: console
570 sudo build/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
571 --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a
577 This is a pipeline test case that aims at testing the following with
578 ``all types queue`` eventdev scheme.
580 #. Measure the end-to-end performance of an event dev with a ethernet dev.
581 #. Maintain packet ordering from Rx to Tx.
583 .. _table_eventdev_pipeline_atq_test:
585 .. table:: Pipeline atq test eventdev configuration.
587 +---+--------------+----------------+-----------------------------------------+
588 | # | Items | Value | Comments |
590 +===+==============+================+=========================================+
591 | 1 | nb_queues | nb_producers + | Queues will be configured based on the |
592 | | | x | user requested sched type list(--stlist)|
593 | | | | where x = 1 in generic pipeline and 0 |
594 | | | | in lockfree pipeline |
595 +---+--------------+----------------+-----------------------------------------+
596 | 2 | nb_producers | >= 1 | Producers will be configured based on |
597 | | | | the number of detected ethernet devices.|
598 | | | | Each ethdev will be configured as an Rx |
600 +---+--------------+----------------+-----------------------------------------+
601 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
603 +---+--------------+----------------+-----------------------------------------+
604 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n. |
605 | | | nb_producers | Producers use port n+1 to port n+m, |
606 | | | | depending on the Rx adapter capability. |
607 +---+--------------+----------------+-----------------------------------------+
609 .. _figure_eventdev_pipeline_atq_test_generic:
611 .. figure:: img/eventdev_pipeline_atq_test_generic.*
613 .. _figure_eventdev_pipeline_atq_test_lockfree:
615 .. figure:: img/eventdev_pipeline_atq_test_lockfree.*
617 pipeline atq test operation.
619 The pipeline atq test configures the eventdev with Q queues and P ports,
620 where Q and P is a function of the number of workers, the number of producers
621 and number of stages as mentioned in :numref:`table_eventdev_pipeline_atq_test`.
623 The atq queue test functions as same as ``pipeline_queue`` test. The difference
624 is, It uses, ``all type queue scheme`` instead of separate queues for each
625 stage and thus reduces the number of queues required to realize the use case.
631 Supported application command line options are following::
646 * The ``--prod_type_ethdev`` is mandatory for running this test.
651 Example command to run pipeline queue test:
653 .. code-block:: console
655 sudo build/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
656 --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a