2 Copyright(c) 2017 Cavium. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Cavium nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 dpdk-test-eventdev Application
32 ==============================
34 The ``dpdk-test-eventdev`` tool is a Data Plane Development Kit (DPDK)
35 application that allows exercising various eventdev use cases.
36 This application has a generic framework to add new eventdev based test cases to
37 verify functionality and measure the performance parameters of DPDK eventdev
40 Compiling the Application
41 -------------------------
43 **Build the application**
45 Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
46 ``dpdk-test-eventdev`` application.
48 Initially, the user must select a DPDK target to choose the correct target type
49 and compiler options to use when building the libraries.
50 The user must have all libraries, modules, updates and compilers installed
51 in the system prior to this,
52 as described in the earlier chapters in this Getting Started Guide.
54 Running the Application
55 -----------------------
57 The application has a number of command line options:
59 .. code-block:: console
61 dpdk-test-eventdev [EAL Options] -- [application options]
66 The following are the EAL command-line options that can be used in conjunction
67 with the ``dpdk-test-eventdev`` application.
68 See the DPDK Getting Started Guides for more information on these options.
70 * ``-c <COREMASK>`` or ``-l <CORELIST>``
72 Set the hexadecimal bitmask of the cores to run on. The corelist is a
75 * ``--vdev <driver><id>``
77 Add a virtual eventdev device.
82 The following are the application command-line options:
86 Set verbose level. Default is 1. Value > 1 displays more details.
90 Set the device id of the event device.
94 Set test name, where ``name`` is one of the following::
101 * ``--socket_id <n>``
103 Set the socket id of the application resources.
107 Set the number of mbufs to be allocated from the mempool.
111 Set the scheduler lcore id.(Valid when eventdev is not RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED capable)
113 * ``--plcores <CORELIST>``
115 Set the list of cores to be used as producers.
117 * ``--wlcores <CORELIST>``
119 Set the list of cores to be used as workers.
121 * ``--stlist <type_list>``
123 Set the scheduled type of each stage where ``type_list`` size
124 determines the number of stages used in the test application.
125 Each type_list member can be one of the following::
127 P or p : Parallel schedule type
128 O or o : Ordered schedule type
129 A or a : Atomic schedule type
131 Application expects the ``type_list`` in comma separated form (i.e. ``--stlist o,a,a,a``)
135 Set the number of flows to produce.
139 Set the number of packets to produce. 0 implies no limit.
141 * ``--worker_deq_depth <n>``
143 Set the dequeue depth of the worker.
147 Perform forward latency measurement.
149 * ``--queue_priority``
151 Enable queue priority.
160 This is a functional test case that aims at testing the following:
162 #. Verify the ingress order maintenance.
163 #. Verify the exclusive(atomic) access to given atomic flow per eventdev port.
165 .. _table_eventdev_order_queue_test:
167 .. table:: Order queue test eventdev configuration.
169 +---+--------------+----------------+------------------------+
170 | # | Items | Value | Comments |
172 +===+==============+================+========================+
173 | 1 | nb_queues | 2 | q0(ordered), q1(atomic)|
175 +---+--------------+----------------+------------------------+
176 | 2 | nb_producers | 1 | |
178 +---+--------------+----------------+------------------------+
179 | 3 | nb_workers | >= 1 | |
181 +---+--------------+----------------+------------------------+
182 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
183 | | | 1 | port n-1. Producer uses|
185 +---+--------------+----------------+------------------------+
187 .. _figure_eventdev_order_queue_test:
189 .. figure:: img/eventdev_order_queue_test.*
191 order queue test operation.
193 The order queue test configures the eventdev with two queues and an event
194 producer to inject the events to q0(ordered) queue. Both q0(ordered) and
195 q1(atomic) are linked to all the workers.
197 The event producer maintains a sequence number per flow and injects the events
198 to the ordered queue. The worker receives the events from ordered queue and
199 forwards to atomic queue. Since the events from an ordered queue can be
200 processed in parallel on the different workers, the ingress order of events
201 might have changed on the downstream atomic queue enqueue. On enqueue to the
202 atomic queue, the eventdev PMD driver reorders the event to the original
203 ingress order(i.e producer ingress order).
205 When the event is dequeued from the atomic queue by the worker, this test
206 verifies the expected sequence number of associated event per flow by comparing
207 the free running expected sequence number per flow.
212 Supported application command line options are following::
228 Example command to run order queue test:
230 .. code-block:: console
232 sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
233 --test=order_queue --plcores 1 --wlcores 2,3
239 This test verifies the same aspects of ``order_queue`` test, the difference is
240 the number of queues used, this test operates on a single ``all types queue(atq)``
241 instead of two different queues for ordered and atomic.
243 .. _table_eventdev_order_atq_test:
245 .. table:: Order all types queue test eventdev configuration.
247 +---+--------------+----------------+------------------------+
248 | # | Items | Value | Comments |
250 +===+==============+================+========================+
251 | 1 | nb_queues | 1 | q0(all types queue) |
253 +---+--------------+----------------+------------------------+
254 | 2 | nb_producers | 1 | |
256 +---+--------------+----------------+------------------------+
257 | 3 | nb_workers | >= 1 | |
259 +---+--------------+----------------+------------------------+
260 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
261 | | | 1 | port n-1.Producer uses |
263 +---+--------------+----------------+------------------------+
265 .. _figure_eventdev_order_atq_test:
267 .. figure:: img/eventdev_order_atq_test.*
269 order all types queue test operation.
274 Supported application command line options are following::
290 Example command to run order ``all types queue`` test:
292 .. code-block:: console
294 sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
295 --test=order_atq --plcores 1 --wlcores 2,3