2 Copyright(c) 2017 Cavium, Inc. 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, Inc 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.
109 * ``--plcores <CORELIST>``
111 Set the list of cores to be used as producers.
113 * ``--wlcores <CORELIST>``
115 Set the list of cores to be used as workers.
117 * ``--stlist <type_list>``
119 Set the scheduled type of each stage where ``type_list`` size
120 determines the number of stages used in the test application.
121 Each type_list member can be one of the following::
123 P or p : Parallel schedule type
124 O or o : Ordered schedule type
125 A or a : Atomic schedule type
127 Application expects the ``type_list`` in comma separated form (i.e. ``--stlist o,a,a,a``)
131 Set the number of flows to produce.
135 Set the number of packets to produce. 0 implies no limit.
137 * ``--worker_deq_depth <n>``
139 Set the dequeue depth of the worker.
143 Perform forward latency measurement.
145 * ``--queue_priority``
147 Enable queue priority.
156 This is a functional test case that aims at testing the following:
158 #. Verify the ingress order maintenance.
159 #. Verify the exclusive(atomic) access to given atomic flow per eventdev port.
161 .. _table_eventdev_order_queue_test:
163 .. table:: Order queue test eventdev configuration.
165 +---+--------------+----------------+------------------------+
166 | # | Items | Value | Comments |
168 +===+==============+================+========================+
169 | 1 | nb_queues | 2 | q0(ordered), q1(atomic)|
171 +---+--------------+----------------+------------------------+
172 | 2 | nb_producers | 1 | |
174 +---+--------------+----------------+------------------------+
175 | 3 | nb_workers | >= 1 | |
177 +---+--------------+----------------+------------------------+
178 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
179 | | | 1 | port n-1. Producer uses|
181 +---+--------------+----------------+------------------------+
183 .. _figure_eventdev_order_queue_test:
185 .. figure:: img/eventdev_order_queue_test.*
187 order queue test operation.
189 The order queue test configures the eventdev with two queues and an event
190 producer to inject the events to q0(ordered) queue. Both q0(ordered) and
191 q1(atomic) are linked to all the workers.
193 The event producer maintains a sequence number per flow and injects the events
194 to the ordered queue. The worker receives the events from ordered queue and
195 forwards to atomic queue. Since the events from an ordered queue can be
196 processed in parallel on the different workers, the ingress order of events
197 might have changed on the downstream atomic queue enqueue. On enqueue to the
198 atomic queue, the eventdev PMD driver reorders the event to the original
199 ingress order(i.e producer ingress order).
201 When the event is dequeued from the atomic queue by the worker, this test
202 verifies the expected sequence number of associated event per flow by comparing
203 the free running expected sequence number per flow.
208 Supported application command line options are following::
224 Example command to run order queue test:
226 .. code-block:: console
228 sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
229 --test=order_queue --plcores 1 --wlcores 2,3
235 This test verifies the same aspects of ``order_queue`` test, the difference is
236 the number of queues used, this test operates on a single ``all types queue(atq)``
237 instead of two different queues for ordered and atomic.
239 .. _table_eventdev_order_atq_test:
241 .. table:: Order all types queue test eventdev configuration.
243 +---+--------------+----------------+------------------------+
244 | # | Items | Value | Comments |
246 +===+==============+================+========================+
247 | 1 | nb_queues | 1 | q0(all types queue) |
249 +---+--------------+----------------+------------------------+
250 | 2 | nb_producers | 1 | |
252 +---+--------------+----------------+------------------------+
253 | 3 | nb_workers | >= 1 | |
255 +---+--------------+----------------+------------------------+
256 | 4 | nb_ports | nb_workers + | Workers use port 0 to |
257 | | | 1 | port n-1.Producer uses |
259 +---+--------------+----------------+------------------------+
261 .. _figure_eventdev_order_atq_test:
263 .. figure:: img/eventdev_order_atq_test.*
265 order all types queue test operation.
270 Supported application command line options are following::
286 Example command to run order ``all types queue`` test:
288 .. code-block:: console
290 sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
291 --test=order_atq --plcores 1 --wlcores 2,3
297 This is a performance test case that aims at testing the following:
299 #. Measure the number of events can be processed in a second.
300 #. Measure the latency to forward an event.
302 .. _table_eventdev_perf_queue_test:
304 .. table:: Perf queue test eventdev configuration.
306 +---+--------------+----------------+-----------------------------------------+
307 | # | Items | Value | Comments |
309 +===+==============+================+=========================================+
310 | 1 | nb_queues | nb_producers * | Queues will be configured based on the |
311 | | | nb_stages | user requested sched type list(--stlist)|
312 +---+--------------+----------------+-----------------------------------------+
313 | 2 | nb_producers | >= 1 | Selected through --plcores command line |
315 +---+--------------+----------------+-----------------------------------------+
316 | 3 | nb_workers | >= 1 | Selected through --wlcores command line |
318 +---+--------------+----------------+-----------------------------------------+
319 | 4 | nb_ports | nb_workers + | Workers use port 0 to port n-1. |
320 | | | nb_producers | Producers use port n to port p |
321 +---+--------------+----------------+-----------------------------------------+
323 .. _figure_eventdev_perf_queue_test:
325 .. figure:: img/eventdev_perf_queue_test.*
327 perf queue test operation.
329 The perf queue test configures the eventdev with Q queues and P ports, where
330 Q and P is a function of the number of workers, the number of producers and
331 number of stages as mentioned in :numref:`table_eventdev_perf_queue_test`.
333 The user can choose the number of workers, the number of producers and number of
334 stages through the ``--wlcores``, ``--plcores`` and the ``--stlist`` application
335 command line arguments respectively.
337 The producer(s) injects the events to eventdev based the first stage sched type
338 list requested by the user through ``--stlist`` the command line argument.
340 Based on the number of stages to process(selected through ``--stlist``),
341 The application forwards the event to next upstream queue and terminates when it
342 reaches the last stage in the pipeline. On event termination, application
343 increments the number events processed and print periodically in one second
344 to get the number of events processed in one second.
346 When ``--fwd_latency`` command line option selected, the application inserts
347 the timestamp in the event on the first stage and then on termination, it
348 updates the number of cycles to forward a packet. The application uses this
349 value to compute the average latency to a forward packet.
354 Supported application command line options are following::
373 Example command to run perf queue test:
375 .. code-block:: console
377 sudo build/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
378 --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
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::
450 Example command to run perf ``all types queue`` test:
452 .. code-block:: console
454 sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
455 --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0