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.
130 * ``--prod_type_timerdev_burst``
132 Use burst mode event timer adapter as producer.
140 This is a functional test case that aims at testing the following:
142 #. Verify the ingress order maintenance.
143 #. Verify the exclusive(atomic) access to given atomic flow per eventdev port.
145 .. _table_eventdev_order_queue_test:
147 .. table:: Order queue test eventdev configuration.
149 +---+--------------+----------------+------------------------+
150 | # | Items | Value | Comments |
152 +===+==============+================+========================+
153 | 1 | nb_queues | 2 | q0(ordered), q1(atomic)|
155 +---+--------------+----------------+------------------------+
156 | 2 | nb_producers | 1 | |
158 +---+--------------+----------------+------------------------+
159 | 3 | nb_workers | >= 1 | |
161 +---+--------------+----------------+------------------------+
162 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
163 | | | 1 | port n-1. Producer uses|
165 +---+--------------+----------------+------------------------+
167 .. _figure_eventdev_order_queue_test:
169 .. figure:: img/eventdev_order_queue_test.*
171 order queue test operation.
173 The order queue test configures the eventdev with two queues and an event
174 producer to inject the events to q0(ordered) queue. Both q0(ordered) and
175 q1(atomic) are linked to all the workers.
177 The event producer maintains a sequence number per flow and injects the events
178 to the ordered queue. The worker receives the events from ordered queue and
179 forwards to atomic queue. Since the events from an ordered queue can be
180 processed in parallel on the different workers, the ingress order of events
181 might have changed on the downstream atomic queue enqueue. On enqueue to the
182 atomic queue, the eventdev PMD driver reorders the event to the original
183 ingress order(i.e producer ingress order).
185 When the event is dequeued from the atomic queue by the worker, this test
186 verifies the expected sequence number of associated event per flow by comparing
187 the free running expected sequence number per flow.
192 Supported application command line options are following::
208 Example command to run order queue test:
210 .. code-block:: console
212 sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
213 --test=order_queue --plcores 1 --wlcores 2,3
219 This test verifies the same aspects of ``order_queue`` test, the difference is
220 the number of queues used, this test operates on a single ``all types queue(atq)``
221 instead of two different queues for ordered and atomic.
223 .. _table_eventdev_order_atq_test:
225 .. table:: Order all types queue test eventdev configuration.
227 +---+--------------+----------------+------------------------+
228 | # | Items | Value | Comments |
230 +===+==============+================+========================+
231 | 1 | nb_queues | 1 | q0(all types queue) |
233 +---+--------------+----------------+------------------------+
234 | 2 | nb_producers | 1 | |
236 +---+--------------+----------------+------------------------+
237 | 3 | nb_workers | >= 1 | |
239 +---+--------------+----------------+------------------------+
240 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
241 | | | 1 | port n-1.Producer uses |
243 +---+--------------+----------------+------------------------+
245 .. _figure_eventdev_order_atq_test:
247 .. figure:: img/eventdev_order_atq_test.*
249 order all types queue test operation.
254 Supported application command line options are following::
270 Example command to run order ``all types queue`` test:
272 .. code-block:: console
274 sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
275 --test=order_atq --plcores 1 --wlcores 2,3
281 This is a performance test case that aims at testing the following:
283 #. Measure the number of events can be processed in a second.
284 #. Measure the latency to forward an event.
286 .. _table_eventdev_perf_queue_test:
288 .. table:: Perf queue test eventdev configuration.
290 +---+--------------+----------------+-----------------------------------------+
291 | # | Items | Value | Comments |
293 +===+==============+================+=========================================+
294 | 1 | nb_queues | nb_producers * | Queues will be configured based on the |
295 | | | nb_stages | user requested sched type list(--stlist)|
296 +---+--------------+----------------+-----------------------------------------+
297 | 2 | nb_producers | >= 1 | Selected through --plcores command line |
299 +---+--------------+----------------+-----------------------------------------+
300 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
302 +---+--------------+----------------+-----------------------------------------+
303 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n-1. |
304 | | | nb_producers | Producers use port n to port p |
305 +---+--------------+----------------+-----------------------------------------+
307 .. _figure_eventdev_perf_queue_test:
309 .. figure:: img/eventdev_perf_queue_test.*
311 perf queue test operation.
313 The perf queue test configures the eventdev with Q queues and P ports, where
314 Q and P is a function of the number of workers, the number of producers and
315 number of stages as mentioned in :numref:`table_eventdev_perf_queue_test`.
317 The user can choose the number of workers, the number of producers and number of
318 stages through the ``--wlcores``, ``--plcores`` and the ``--stlist`` application
319 command line arguments respectively.
321 The producer(s) injects the events to eventdev based the first stage sched type
322 list requested by the user through ``--stlist`` the command line argument.
324 Based on the number of stages to process(selected through ``--stlist``),
325 The application forwards the event to next upstream queue and terminates when it
326 reaches the last stage in the pipeline. On event termination, application
327 increments the number events processed and print periodically in one second
328 to get the number of events processed in one second.
330 When ``--fwd_latency`` command line option selected, the application inserts
331 the timestamp in the event on the first stage and then on termination, it
332 updates the number of cycles to forward a packet. The application uses this
333 value to compute the average latency to a forward packet.
335 When ``--prod_type_ethdev`` command line option is selected, the application
336 uses the probed ethernet devices as producers by configuring them as Rx
337 adapters instead of using synthetic producers.
342 Supported application command line options are following::
358 --prod_type_timerdev_burst
364 Example command to run perf queue test:
366 .. code-block:: console
368 sudo build/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
369 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
371 Example command to run perf queue test with ethernet ports:
373 .. code-block:: console
375 sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
376 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --prod_type_ethdev
378 Example command to run perf queue test with event timer adapter:
380 .. code-block:: console
382 sudo build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
383 --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
384 --prod_type_timerdev --fwd_latency
389 This is a performance test case that aims at testing the following with
390 ``all types queue`` eventdev scheme.
392 #. Measure the number of events can be processed in a second.
393 #. Measure the latency to forward an event.
395 .. _table_eventdev_perf_atq_test:
397 .. table:: Perf all types queue test eventdev configuration.
399 +---+--------------+----------------+-----------------------------------------+
400 | # | Items | Value | Comments |
402 +===+==============+================+=========================================+
403 | 1 | nb_queues | nb_producers | Queues will be configured based on the |
404 | | | | user requested sched type list(--stlist)|
405 +---+--------------+----------------+-----------------------------------------+
406 | 2 | nb_producers | >= 1 | Selected through --plcores command line |
408 +---+--------------+----------------+-----------------------------------------+
409 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
411 +---+--------------+----------------+-----------------------------------------+
412 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n-1. |
413 | | | nb_producers | Producers use port n to port p |
414 +---+--------------+----------------+-----------------------------------------+
416 .. _figure_eventdev_perf_atq_test:
418 .. figure:: img/eventdev_perf_atq_test.*
420 perf all types queue test operation.
423 The ``all types queues(atq)`` perf test configures the eventdev with Q queues
424 and P ports, where Q and P is a function of the number of workers and number of
425 producers as mentioned in :numref:`table_eventdev_perf_atq_test`.
428 The atq queue test functions as same as ``perf_queue`` test. The difference
429 is, It uses, ``all type queue scheme`` instead of separate queues for each
430 stage and thus reduces the number of queues required to realize the use case
431 and enables flow pinning as the event does not move to the next queue.
437 Supported application command line options are following::
452 --prod_type_timerdev_burst
458 Example command to run perf ``all types queue`` test:
460 .. code-block:: console
462 sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
463 --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
465 Example command to run perf ``all types queue`` test with event timer adapter:
467 .. code-block:: console
469 sudo build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
470 --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \
471 --stlist=a --prod_type_timerdev --fwd_latency
477 This is a pipeline test case that aims at testing the following:
479 #. Measure the end-to-end performance of an event dev with a ethernet dev.
480 #. Maintain packet ordering from Rx to Tx.
482 .. _table_eventdev_pipeline_queue_test:
484 .. table:: Pipeline queue test eventdev configuration.
486 +---+--------------+----------------+-----------------------------------------+
487 | # | Items | Value | Comments |
489 +===+==============+================+=========================================+
490 | 1 | nb_queues | (nb_producers | Queues will be configured based on the |
491 | | | * nb_stages) + | user requested sched type list(--stlist)|
492 | | | x | Here value of x is 1 in generic pipeline|
493 | | | | and nb_producers in lockfree pipeline |
494 +---+--------------+----------------+-----------------------------------------+
495 | 2 | nb_producers | >= 1 | Producers will be configured based on |
496 | | | | the number of detected ethernet devices.|
497 | | | | Each ethdev will be configured as an Rx |
499 +---+--------------+----------------+-----------------------------------------+
500 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
502 +---+--------------+----------------+-----------------------------------------+
503 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n. |
504 | | | nb_producers | Producers use port n+1 to port n+m, |
505 | | | | depending on the Rx adapter capability. |
506 +---+--------------+----------------+-----------------------------------------+
508 .. _figure_eventdev_pipeline_queue_test_generic:
510 .. figure:: img/eventdev_pipeline_queue_test_generic.*
512 .. _figure_eventdev_pipeline_queue_test_lockfree:
514 .. figure:: img/eventdev_pipeline_queue_test_lockfree.*
516 pipeline queue test operation.
518 The pipeline queue test configures the eventdev with Q queues and P ports,
519 where Q and P is a function of the number of workers, the number of producers
520 and number of stages as mentioned in :numref:`table_eventdev_pipeline_queue_test`.
522 The user can choose the number of workers and number of stages through the
523 ``--wlcores`` and the ``--stlist`` application command line arguments
526 The number of producers depends on the number of ethernet devices detected and
527 each ethernet device is configured as a event_eth_rx_adapter that acts as a
530 The producer(s) injects the events to eventdev based the first stage sched type
531 list requested by the user through ``--stlist`` the command line argument.
533 Based on the number of stages to process(selected through ``--stlist``),
534 The application forwards the event to next upstream queue and when it reaches
535 the last stage in the pipeline if the event type is ``atomic`` it is enqueued
536 onto ethdev Tx queue else to maintain ordering the event type is set to
537 ``atomic`` and enqueued onto the last stage queue.
539 If the ethernet has ``DEV_TX_OFFLOAD_MT_LOCKFREE`` capability then the worker
540 cores transmit the packets directly. Else the worker cores enqueue the packet
541 onto the ``SINGLE_LINK_QUEUE`` that is managed by a Tx service. The Tx service
542 dequeues the packet and transmits it.
544 On packet Tx, application increments the number events processed and print
545 periodically in one second to get the number of events processed in one
552 Supported application command line options are following::
567 * The ``--prod_type_ethdev`` is mandatory for running this test.
572 Example command to run pipeline queue test:
574 .. code-block:: console
576 sudo build/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
577 --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a
583 This is a pipeline test case that aims at testing the following with
584 ``all types queue`` eventdev scheme.
586 #. Measure the end-to-end performance of an event dev with a ethernet dev.
587 #. Maintain packet ordering from Rx to Tx.
589 .. _table_eventdev_pipeline_atq_test:
591 .. table:: Pipeline atq test eventdev configuration.
593 +---+--------------+----------------+-----------------------------------------+
594 | # | Items | Value | Comments |
596 +===+==============+================+=========================================+
597 | 1 | nb_queues | nb_producers + | Queues will be configured based on the |
598 | | | x | user requested sched type list(--stlist)|
599 | | | | where x = 1 in generic pipeline and 0 |
600 | | | | in lockfree pipeline |
601 +---+--------------+----------------+-----------------------------------------+
602 | 2 | nb_producers | >= 1 | Producers will be configured based on |
603 | | | | the number of detected ethernet devices.|
604 | | | | Each ethdev will be configured as an Rx |
606 +---+--------------+----------------+-----------------------------------------+
607 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
609 +---+--------------+----------------+-----------------------------------------+
610 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n. |
611 | | | nb_producers | Producers use port n+1 to port n+m, |
612 | | | | depending on the Rx adapter capability. |
613 +---+--------------+----------------+-----------------------------------------+
615 .. _figure_eventdev_pipeline_atq_test_generic:
617 .. figure:: img/eventdev_pipeline_atq_test_generic.*
619 .. _figure_eventdev_pipeline_atq_test_lockfree:
621 .. figure:: img/eventdev_pipeline_atq_test_lockfree.*
623 pipeline atq test operation.
625 The pipeline atq test configures the eventdev with Q queues and P ports,
626 where Q and P is a function of the number of workers, the number of producers
627 and number of stages as mentioned in :numref:`table_eventdev_pipeline_atq_test`.
629 The atq queue test functions as same as ``pipeline_queue`` test. The difference
630 is, It uses, ``all type queue scheme`` instead of separate queues for each
631 stage and thus reduces the number of queues required to realize the use case.
637 Supported application command line options are following::
652 * The ``--prod_type_ethdev`` is mandatory for running this test.
657 Example command to run pipeline queue test:
659 .. code-block:: console
661 sudo build/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
662 --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a