From 64b20e7fb5e2f7e538004f26f41e770de798d210 Mon Sep 17 00:00:00 2001 From: Guduri Prathyusha Date: Tue, 4 Jul 2017 10:23:23 +0530 Subject: [PATCH] doc: describe the new eventdev test application Add documentation to describe usage of eventdev test application and supported command line arguments. Signed-off-by: Guduri Prathyusha Signed-off-by: Jerin Jacob Acked-by: Harry van Haaren Acked-by: John McNamara --- MAINTAINERS | 1 + doc/guides/tools/index.rst | 2 +- doc/guides/tools/testeventdev.rst | 152 ++++++++++++++++++++++++++++++ 3 files changed, 154 insertions(+), 1 deletion(-) create mode 100644 doc/guides/tools/testeventdev.rst diff --git a/MAINTAINERS b/MAINTAINERS index a1989de241..8dd7303170 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -799,6 +799,7 @@ F: doc/guides/tools/cryptoperf.rst Eventdev test application M: Jerin Jacob F: app/test-eventdev/ +F: doc/guides/tools/testeventdev.rst Procinfo tool M: Maryam Tahhan diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst index 6dc5d202a5..c9133ec84c 100644 --- a/doc/guides/tools/index.rst +++ b/doc/guides/tools/index.rst @@ -40,4 +40,4 @@ DPDK Tools User Guides pmdinfo devbind cryptoperf - + testeventdev diff --git a/doc/guides/tools/testeventdev.rst b/doc/guides/tools/testeventdev.rst new file mode 100644 index 0000000000..f8240e7ba9 --- /dev/null +++ b/doc/guides/tools/testeventdev.rst @@ -0,0 +1,152 @@ +.. BSD LICENSE + Copyright(c) 2017 Cavium. All rights reserved. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Cavium nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +dpdk-test-eventdev Application +============================== + +The ``dpdk-test-eventdev`` tool is a Data Plane Development Kit (DPDK) +application that allows exercising various eventdev use cases. +This application has a generic framework to add new eventdev based test cases to +verify functionality and measure the performance parameters of DPDK eventdev +devices. + +Compiling the Application +------------------------- + +**Build the application** + +Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the +``dpdk-test-eventdev`` application. + +Initially, the user must select a DPDK target to choose the correct target type +and compiler options to use when building the libraries. +The user must have all libraries, modules, updates and compilers installed +in the system prior to this, +as described in the earlier chapters in this Getting Started Guide. + +Running the Application +----------------------- + +The application has a number of command line options: + +.. code-block:: console + + dpdk-test-eventdev [EAL Options] -- [application options] + +EAL Options +~~~~~~~~~~~ + +The following are the EAL command-line options that can be used in conjunction +with the ``dpdk-test-eventdev`` application. +See the DPDK Getting Started Guides for more information on these options. + +* ``-c `` or ``-l `` + + Set the hexadecimal bitmask of the cores to run on. The corelist is a + list of cores to use. + +* ``--vdev `` + + Add a virtual eventdev device. + +Application Options +~~~~~~~~~~~~~~~~~~~ + +The following are the application command-line options: + +* ``--verbose`` + + Set verbose level. Default is 1. Value > 1 displays more details. + +* ``--dev `` + + Set the device id of the event device. + +* ``--test `` + + Set test name, where ``name`` is one of the following:: + + order_queue + order_atq + perf_queue + perf_atq + +* ``--socket_id `` + + Set the socket id of the application resources. + +* ``--pool-sz `` + + Set the number of mbufs to be allocated from the mempool. + +* ``--slcore `` + + Set the scheduler lcore id.(Valid when eventdev is not RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED capable) + +* ``--plcores `` + + Set the list of cores to be used as producers. + +* ``--wlcores `` + + Set the list of cores to be used as workers. + +* ``--stlist `` + + Set the scheduled type of each stage where ``type_list`` size + determines the number of stages used in the test application. + Each type_list member can be one of the following:: + + P or p : Parallel schedule type + O or o : Ordered schedule type + A or a : Atomic schedule type + + Application expects the ``type_list`` in comma separated form (i.e. ``--stlist o,a,a,a``) + +* ``--nb_flows `` + + Set the number of flows to produce. + +* ``--nb_pkts `` + + Set the number of packets to produce. 0 implies no limit. + +* ``--worker_deq_depth `` + + Set the dequeue depth of the worker. + +* ``--fwd_latency`` + + Perform forward latency measurement. + +* ``--queue_priority`` + + Enable queue priority. + -- 2.20.1