doc: testpmd application user guide

The 1.7 DPDK_TestPMD_App_UG  document in MSWord has been converted to rst format for
use with Sphinx. There is an rst file for each chapter and an index.rst file
which contains the table of contents.
The top level index file has been modified to include this guide.

This is the fourth document from a set of 6 documents.

Signed-off-by:  Bernard Iremonger <bernard.iremonger@intel.com>
This commit is contained in:
Bernard Iremonger 2014-11-04 13:56:59 +00:00 committed by Thomas Monjalon
parent 6630bc4244
commit ac718398f4
7 changed files with 2243 additions and 0 deletions

View File

@ -39,4 +39,5 @@ Contents:
linux_gsg/index linux_gsg/index
freebsd_gsg/index freebsd_gsg/index
testpmd_app_ug/index
rel_notes/index rel_notes/index

View File

@ -0,0 +1,61 @@
.. BSD LICENSE
Copyright(c) 2010-2014 Intel Corporation. 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 Intel Corporation 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.
Compiling the Application
=========================
The testpmd application is compiled as part of the main compilation of the Intel® DPDK libraries and tools.
Refer to the Intel® DPDK Getting Started Guide for details.
The basic compilation steps are:
#. Set the required environmental variables and go to the source directory:
.. code-block:: console
export RTE_SDK=/path/to/rte_sdk
cd $RTE_SDK
#. Set the compilation target. For example:
.. code-block:: console
export RTE_TARGET=x86_64-native-linuxapp-gcc
#. Build the application:
.. code-block:: console
make install T=$RTE_TARGET
The compiled application will be located at:
.. code-block:: console
$RTE_SDK/$RTE_TARGET/build/app/testpmd

View File

@ -0,0 +1,92 @@
.. BSD LICENSE
Copyright(c) 2010-2014 Intel Corporation. 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 Intel Corporation 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.
Testpmd Application User Guide
==============================
June 2014
INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS,
INTEL ASSUMES NO LIABILITY WHATSOEVER AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY,
RELATING TO SALE AND/OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE,
MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT,
COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT.
A "Mission Critical Application" is any application in which failure of the Intel Product could result,
directly or indirectly, in personal injury or death.
SHOULD YOU PURCHASE OR USE INTEL'S PRODUCTS FOR ANY SUCH MISSION CRITICAL APPLICATION,
YOU SHALL INDEMNIFY AND HOLD INTEL AND ITS SUBSIDIARIES, SUBCONTRACTORS AND AFFILIATES,
AND THE DIRECTORS, OFFICERS, AND EMPLOYEES OF EACH, HARMLESS AGAINST ALL CLAIMS COSTS,
DAMAGES, AND EXPENSES AND REASONABLE ATTORNEYS' FEES ARISING OUT OF,
DIRECTLY OR INDIRECTLY, ANY CLAIM OF PRODUCT LIABILITY, PERSONAL INJURY,
OR DEATH ARISING IN ANY WAY OUT OF SUCH MISSION CRITICAL APPLICATION,
WHETHER OR NOT INTEL OR ITS SUBCONTRACTOR WAS NEGLIGENT IN THE DESIGN,
MANUFACTURE, OR WARNING OF THE INTEL PRODUCT OR ANY OF ITS PARTS.
Intel may make changes to specifications and product descriptions at any time, without notice.
Designers must not rely on the absence or characteristics of any features or instructions marked "reserved" or "undefined".
Intel reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them.
The information here is subject to change without notice. Do not finalize a design with this information.
The products described in this document may contain design defects or errors known as errata which may cause the product to deviate from published specifications.
Current characterized errata are available on request.
Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order.
Copies of documents which have an order number and are referenced in this document, or other Intel literature, may be obtained by calling 1-800-548- 4725,
or go to: http://www.intel.com/design/literature.htm
Any software source code reprinted in this document is furnished for informational purposes only and may only be used or copied and no license,
express or implied, by estoppel or otherwise, to any of the reprinted source code is granted by this document.
Code Names are only for use by Intel to identify products, platforms, programs, services, etc. ("products") in development by Intel that
have not been made commercially available to the public, i.e., announced, launched or shipped. They are never to be used as "commercial" names for products.
Also, they are not intended to function as trademarks.
Intel and the Intel logo are trademarks of Intel Corporation in the U.S. and/or other countries.
\*Other names and brands may be claimed as the property of others.
Copyright © 2013-2014, Intel Corporation. All rights reserved.
**Contents**
.. toctree::
:maxdepth: 3
:numbered:
intro
overview
build_app
run_app
testpmd_funcs

View File

@ -0,0 +1,72 @@
.. BSD LICENSE
Copyright(c) 2010-2014 Intel Corporation. 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 Intel Corporation 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.
Introduction
============
This document is a user guide for the testpmd example application that is shipped as part of the Intel® Data Plane Development Kit.
The testpmd application can be used to test the Intel® DPDK in a packet forwarding mode
and also to access NIC hardware features such as Flow Director.
It also serves as a example of how to build a more fully-featured application using the Intel® DPDK SDK.
DocumentationRoadmap
--------------------
The following is a list of Intel® DPDK documents in the suggested reading order:
* **Release Notes** : Provides release-specific information, including supported features,
limitations, fixed issues, known issues and so on.
Also, provides the answers to frequently asked questions in FAQ format.
* **Getting Started Guide** (this document): Describes how to install and configure the Intel® DPDK;
designed to get users up and running quickly with the software.
* **Programmer's Guide** : Describes:
* The software architecture and how to use it (through examples), specifically in a Linux* application (linuxapp) environment
* The content of the Intel® DPDK, the build system
(including the commands that can be used in the root Intel® DPDK Makefile to build the development kit and an application)
and guidelines for porting an application
* Optimizations used in the software and those that should be considered for new development
A glossary of terms is also provided.
* **API Reference** : Provides detailed information about Intel® DPDK functions, data structures and other programming constructs.
* **Sample Applications User Guide** : Describes a set of sample applications.
Each chapter describes a sample application that showcases specific functionality and
provides instructions on how to compile, run and use the sample application.
.. note::
These documents are available for download as a separate documentation package at the same location as the Intel® DPDK code package.

View File

@ -0,0 +1,35 @@
.. BSD LICENSE
Copyright(c) 2010-2014 Intel Corporation. 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 Intel Corporation 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.
Overview
========
The following sections show how to build and run the testpmd application and
how to configure the application from the command line and the run-time environment.

View File

@ -0,0 +1,390 @@
.. BSD LICENSE
Copyright(c) 2010-2014 Intel Corporation. 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 Intel Corporation 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.
Running the Application
=======================
EAL Command-line Options
------------------------
The following are the EAL command-line options that can be used in conjunction with the testpmd,
or any other Intel® DPDK application.
See the Intel® DPDK Getting Started Guide for more information on these options.
* -c COREMASK
Set the hexadecimal bitmask of the cores to run on.
* -n NUM
Set the number of memory channels to use.
* -b, --pci-blacklist domain:bus:devid.func
Blacklist a PCI devise to prevent EAL from using it. Multiple -b options are allowed.
* -d LIB.so
Load an external driver. Multiple -d options are allowed.
* -w, --pci-whitelist domain:bus:devid:func
Add a PCI device in white list.
* -m MB
Memory to allocate. See also --socket-mem.
* -r NUM
Set the number of memory ranks (auto-detected by default).
* -v
Display the version information on startup.
* --xen-dom0
Support application running on Xen Domain0 without hugetlbfs.
* --syslog
Set the syslog facility.
* --socket-mem
Set the memory to allocate on specific sockets (use comma separated values).
* --huge-dir
Specify the directory where the hugetlbfs is mounted.
* --proc-type
Set the type of the current process.
* --file-prefix
Prefix for hugepage filenames.
* -vmware-tsc-map
Use VMware TSC map instead of native RDTSC.
* --vdev
Add a virtual device, with format "<driver><id>[,key=val, ...]", e.g. --vdev=eth_pcap0,iface=eth2.
* --base-virtaddr
Specify base virtual address.
* --create-uio-dev
Create /dev/uioX (usually done by hotplug).
* --no-shconf
No shared config (mmap'd files).
* --no-pci
Disable pci.
* --no-hpet
Disable hpet.
* --no-huge
Use malloc instead of hugetlbfs.
Testpmd Command-line Options
----------------------------
The following are the command-line options for the testpmd applications.
They must be separated from the EAL options, shown in the previous section, with a -- separator:
.. code-block:: console
sudo ./testpmd -c 0xF -n 4 -- -i --portmask=0x1 --nb-cores=2
* -i, --interactive
Run testpmd in interactive mode.
In this mode, the testpmd starts with a prompt that can be used to start and stop forwarding,
configure the application and display stats on the current packet processing session.
See the Section 5.0, "Test Runtime Functions" section for more details.
In non-interactive mode,
the application starts with the configuration specified on the command-line and
immediately enters forwarding mode.
* -h, --help
Display a help message and quit.
* -a, --auto-start
Start forwarding on init.
* --nb-cores=N
Set the number of forwarding cores,
where 1 <= N <= number of cores or RTE_MAX_LCORE from the configuration file.
The default value is 1.
* --nb-ports=N
Set the number of forwarding ports,
where 1 <= N <= number of ports on the board or RTE_MAX_ETHPORTS from the configuration file.
The default value is the number of ports on the board.
* --coremask=0xXX
Set the hexadecimal bitmask of the cores running the packet forwarding test.
The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
* --portmask=0xXX
Set the hexadecimal bitmask of the ports used by the packet forwarding test.
* --numa
Enable NUMA-aware allocation of RX/TX rings and of RX memory buffers (mbufs).
* --port-numa-config=(port,socket)[,(port,socket)]
Specify the socket on which the memory pool to be used by the port will be allocated.
* --ring-numa-config=(port,flag,socket)[,(port,flag,socket)]
Specify the socket on which the TX/RX rings for the port will be allocated.
Where flag is 1 for RX, 2 for TX, and 3 for RX and TX.
* --socket-num=N
Set the socket from which all memory is allocated in NUMA mode,
where 0 <= N < number of sockets on the board.
* --mbuf-size=N
Set the data size of the mbufs used to N bytes, where N < 65536. The default value is 2048.
* --total-num-mbufs=N
Set the number of mbufs to be allocated in the mbuf pools, where N > 1024.
* --max-pkt-len=N
Set the maximum packet size to N bytes, where N >= 64. The default value is 1518.
* --eth-peers-configfile=name
Use a configuration file containing the Ethernet addresses of the peer ports.
The configuration file should contain the Ethernet addresses on separate lines:
XX:XX:XX:XX:XX:01
XX:XX:XX:XX:XX:02
...
* --eth-peer=N,XX:XX:XX:XX:XX:XX
Set the MAC address XX:XX:XX:XX:XX:XX of the peer port N,
where 0 <= N < RTE_MAX_ETHPORTS from the configuration file.
* --pkt-filter-mode=mode
Set Flow Director mode where mode is either none (the default), signature or perfect.
See the Section 5.6, "Flow Director Functions" for more detail.
* --pkt-filter-report-hash=mode
Set Flow Director hash match reporting mode where mode is none, match (the default) or always.
* --pkt-filter-size=N
Set Flow Director allocated memory size, where N is 64K, 128K or 256K.
Sizes are in kilobytes. The default is 64.
* --pkt-filter-flexbytes-offset=N
Set the flexbytes offset.
The offset is defined in words (not bytes) counted from the first byte of the destination Ethernet MAC address,
where N is 0 <= N <= 32.
The default value is 0x6.
* --pkt-filter-drop-queue=N
Set the drop-queue.
In perfect filter mode, when a rule is added with queue = -1, the packet will be enqueued into the RX drop-queue.
If the drop-queue does not exist, the packet is dropped. The default value is N=127.
* --crc-strip
Enable hardware CRC stripping.
* --enable-rx-cksum
Enable hardware RX checksum offload.
* --disable-hw-vlan
Disable hardware VLAN.
* --enable-drop-en
Enable per-queue packet drop for packets with no descriptors.
* --disable-rss
Disable RSS (Receive Side Scaling).
* --port-topology=mode
Set port topology, where mode is paired(the default) or chained.
In paired mode, the forwarding is between pairs of ports, for example: (0,1), (2,3), (4,5).
In chained mode, the forwarding is to the next available port in the port mask, for example: (0,1), (1,2), (2,0).
The ordering of the ports can be changed using the portlist testpmd runtime function.
* --forward-mode=N
Set forwarding mode. (N: io|mac|mac_retry|mac_swap|flowgen|rxonly|txonly|csum|icmpecho)
* --rss-ip
Set RSS functions for IPv4/IPv6 only.
* --rss-udp
Set RSS functions for IPv4/IPv6 and UDP.
* --rxq=N
Set the number of RX queues per port to N, where 1 <= N <= 65535.
The default value is 1.
* --rxd=N
Set the number of descriptors in the RX rings to N, where N > 0.
The default value is 128.
* --txq=N
Set the number of TX queues per port to N, where 1 <= N <= 65535.
The default value is 1.
* --txd=N
Set the number of descriptors in the TX rings to N, where N > 0.
The default value is 512.
* --burst=N
Set the number of packets per burst to N, where 1 <= N <= 512.
The default value is 16.
* --mbcache=N
Set the cache of mbuf memory pools to N, where 0 <= N <= 512.
The default value is 16.
* --rxpt=N
Set the prefetch threshold register of RX rings to N, where N >= 0.
The default value is 8.
* --rxht=N
Set the host threshold register of RX rings to N, where N >= 0.
The default value is 8.
* --rxfreet=N
Set the free threshold of RX descriptors to N, where 0 <= N < value of --rxd.
The default value is 0.
* --rxwt=N
Set the write-back threshold register of RX rings to N, where N >= 0.
The default value is 4.
* --txpt=N
Set the prefetch threshold register of TX rings to N, where N >= 0.
The default value is 36.
* --txht=N
Set the host threshold register of TX rings to N, where N >= 0.
The default value is 0.
* --txwt=N
Set the write-back threshold register of TX rings to N, where N >= 0.
The default value is 0.
* --txfreet=N
Set the transmit free threshold of TX rings to N, where 0 <= N <= value of --txd.
The default value is 0.
* --txrst=N
Set the transmit RS bit threshold of TX rings to N, where 0 <= N <= value of --txd.
The default value is 0.
* --txqflags=0xXXXXXXXX
Set the hexadecimal bitmask of TX queue flags, where 0 <= N <= 0x7FFFFFFF.
The default value is 0.
* --rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]
Set the RX queues statistics counters mapping 0 <= mapping <= 15.
* --tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]
Set the TX queues statistics counters mapping 0 <= mapping <= 15.
* --no-flush-rx
Don't flush the RX streams before starting forwarding. Used mainly with PCAP drivers.
* --txpkts=X[,Y]
Set TX segment sizes.
* --disable-link-check
Disable check on link status when starting/stopping ports.

File diff suppressed because it is too large Load Diff