diff options
Diffstat (limited to 'doc')
92 files changed, 1006 insertions, 214 deletions
diff --git a/doc/guides/compressdevs/overview.rst b/doc/guides/compressdevs/overview.rst index 70bbe82b..809e4e6e 100644 --- a/doc/guides/compressdevs/overview.rst +++ b/doc/guides/compressdevs/overview.rst @@ -18,7 +18,7 @@ Supported Feature Flags without making any modifications to it (no compression done). - "OOP SGL In SGL Out" feature flag stands for - "Out-of-place Scatter-gather list Input, Scatter-gater list Output", + "Out-of-place Scatter-gather list Input, Scatter-gather list Output", which means PMD supports different scatter-gather styled input and output buffers (i.e. both can consists of multiple segments). diff --git a/doc/guides/conf.py b/doc/guides/conf.py index da99a3f8..a85f6c9d 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -391,6 +391,11 @@ def setup(app): 'AEAD', 'AEAD algorithms in crypto drivers', 'AEAD algorithm') + table_file = dirname(__file__) + '/cryptodevs/overview_asym_table.txt' + generate_overview_table(table_file, 5, + 'Asymmetric', + 'Asymmetric algorithms in crypto drivers', + 'Asymmetric algorithm') table_file = dirname(__file__) + '/compressdevs/overview_feature_table.txt' generate_overview_table(table_file, 1, 'Features', diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst index d96698a7..656563dd 100644 --- a/doc/guides/contributing/coding_style.rst +++ b/doc/guides/contributing/coding_style.rst @@ -825,10 +825,10 @@ format. .. code-block:: python sources = files('file1.c', ...) - headers = files('file1.c', ...) + headers = files('file1.h', ...) -The will build based on a number of conventions and assumptions within the DPDK +This will build based on a number of conventions and assumptions within the DPDK itself, for example, that the library name is the same as the directory name in which the files are stored. diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index c72280a2..408859e2 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -40,14 +40,14 @@ The main directories that contain files related to documentation are shown below |-- ... -The API documentation is built from `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_ comments in the header files. +The API documentation is built from `Doxygen <http://www.doxygen.nl>`_ comments in the header files. These files are mainly in the ``lib/librte_*`` directories although some of the Poll Mode Drivers in ``drivers/net`` are also documented with Doxygen. The configuration files that are used to control the Doxygen output are in the ``doc/api`` directory. The user guides such as *The Programmers Guide* and the *FreeBSD* and *Linux Getting Started* Guides are generated -from RST markup text files using the `Sphinx <http://sphinx-doc.org/index.html>`_ Documentation Generator. +from RST markup text files using the `Sphinx <http://sphinx-doc.org>`_ Documentation Generator. These files are included in the ``doc/guides/`` directory. The output is controlled by the ``doc/guides/conf.py`` file. @@ -174,7 +174,8 @@ For full support with figure and table captioning the latest version of Sphinx c sudo pip install --upgrade sphinx sudo pip install --upgrade sphinx_rtd_theme -For further information on getting started with Sphinx see the `Sphinx Tutorial <http://sphinx-doc.org/tutorial.html>`_. +For further information on getting started with Sphinx see the +`Sphinx Getting Started <http://www.sphinx-doc.org/en/master/usage/quickstart.html>`_. .. Note:: @@ -596,7 +597,7 @@ Doxygen Guidelines The DPDK API is documented using Doxygen comment annotations in the header files. Doxygen is a very powerful tool, it is extremely configurable and with a little effort can be used to create expressive documents. -See the `Doxygen website <http://www.stack.nl/~dimitri/doxygen/>`_ for full details on how to use it. +See the `Doxygen website <http://www.doxygen.nl>`_ for full details on how to use it. The following are some guidelines for use of Doxygen in the DPDK API documentation: diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index a64bb036..1bd91b7e 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -8,7 +8,7 @@ Contributing Code to DPDK This document outlines the guidelines for submitting code to DPDK. -The DPDK development process is modelled (loosely) on the Linux Kernel development model so it is worth reading the +The DPDK development process is modeled (loosely) on the Linux Kernel development model so it is worth reading the Linux kernel guide on submitting patches: `How to Get Your Change Into the Linux Kernel <https://www.kernel.org/doc/html/latest/process/submitting-patches.html>`_. The rationale for many of the DPDK guidelines is explained in greater detail in the kernel guidelines. @@ -32,6 +32,10 @@ The mailing list for DPDK development is `dev@dpdk.org <http://mails.dpdk.org/ar Contributors will need to `register for the mailing list <http://mails.dpdk.org/listinfo/dev>`_ in order to submit patches. It is also worth registering for the DPDK `Patchwork <http://patches.dpdk.org/project/dpdk/list/>`_ +If you are using the GitHub service, you can link your repository to +the ``travis-ci.org`` build service. When you push patches to your GitHub +repository, the travis service will automatically build your changes. + The development process requires some familiarity with the ``git`` version control system. Refer to the `Pro Git Book <http://www.git-scm.com/book/>`_ for further information. diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst index 01b36247..fe17c7f1 100644 --- a/doc/guides/contributing/versioning.rst +++ b/doc/guides/contributing/versioning.rst @@ -548,26 +548,29 @@ utilities which can be installed via a package manager. For example:: The syntax of the ``validate-abi.sh`` utility is:: - ./devtools/validate-abi.sh <REV1> <REV2> <TARGET> + ./devtools/validate-abi.sh <REV1> <REV2> Where ``REV1`` and ``REV2`` are valid gitrevisions(7) https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html -on the local repo and target is the usual DPDK compilation target. +on the local repo. For example:: # Check between the previous and latest commit: - ./devtools/validate-abi.sh HEAD~1 HEAD x86_64-native-linuxapp-gcc + ./devtools/validate-abi.sh HEAD~1 HEAD + + # Check on a specific compilation target: + ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD # Check between two tags: - ./devtools/validate-abi.sh v2.0.0 v2.1.0 x86_64-native-linuxapp-gcc + ./devtools/validate-abi.sh v2.0.0 v2.1.0 # Check between git master and local topic-branch "vhost-hacking": - ./devtools/validate-abi.sh master vhost-hacking x86_64-native-linuxapp-gcc + ./devtools/validate-abi.sh master vhost-hacking After the validation script completes (it can take a while since it need to compile both tags) it will create compatibility reports in the -``./compat_report`` directory. Listed incompatibilities can be found as -follows:: +``./abi-check/compat_report`` directory. Listed incompatibilities can be found +as follows:: - grep -lr Incompatible compat_reports/ + grep -lr Incompatible abi-check/compat_reports/ diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst index d9fd41ae..ccfc137f 100644 --- a/doc/guides/cryptodevs/aesni_mb.rst +++ b/doc/guides/cryptodevs/aesni_mb.rst @@ -125,7 +125,7 @@ Extra notes For AES Counter mode (AES-CTR), the library supports two different sizes for Initialization Vector (IV): -* 12 bytes: used mainly for IPSec, as it requires 12 bytes from the user, which internally +* 12 bytes: used mainly for IPsec, as it requires 12 bytes from the user, which internally are appended the counter block (4 bytes), which is set to 1 for the first block (no padding required from the user) diff --git a/doc/guides/cryptodevs/features/aesni_gcm.ini b/doc/guides/cryptodevs/features/aesni_gcm.ini index b9e9c906..fdd3df69 100644 --- a/doc/guides/cryptodevs/features/aesni_gcm.ini +++ b/doc/guides/cryptodevs/features/aesni_gcm.ini @@ -30,3 +30,8 @@ AES GMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'aesni_gcm' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/aesni_mb.ini b/doc/guides/cryptodevs/features/aesni_mb.ini index f7295745..9b4428ef 100644 --- a/doc/guides/cryptodevs/features/aesni_mb.ini +++ b/doc/guides/cryptodevs/features/aesni_mb.ini @@ -32,16 +32,30 @@ DES DOCSIS BPI = Y ; [Auth] MD5 HMAC = Y +SHA1 = Y SHA1 HMAC = Y +SHA224 = Y SHA224 HMAC = Y +SHA256 = Y SHA256 HMAC = Y +SHA384 = Y SHA384 HMAC = Y +SHA512 = Y SHA512 HMAC = Y AES XCBC MAC = Y AES CMAC (128) = Y +AES GMAC = Y ; ; Supported AEAD algorithms of the 'aesni_mb' crypto driver. ; [AEAD] AES CCM (128) = Y +AES GCM (128) = Y +AES GCM (192) = Y +AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'aesni_mb' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/features/armv8.ini b/doc/guides/cryptodevs/features/armv8.ini index 1e104771..e588f902 100644 --- a/doc/guides/cryptodevs/features/armv8.ini +++ b/doc/guides/cryptodevs/features/armv8.ini @@ -26,3 +26,8 @@ SHA256 HMAC = Y ; Supported AEAD algorithms of the 'armv8' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'armv8' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/features/caam_jr.ini b/doc/guides/cryptodevs/features/caam_jr.ini index 68f8d819..c64bd35d 100644 --- a/doc/guides/cryptodevs/features/caam_jr.ini +++ b/doc/guides/cryptodevs/features/caam_jr.ini @@ -44,3 +44,8 @@ SHA512 HMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'dpaa2_sec' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/ccp.ini b/doc/guides/cryptodevs/features/ccp.ini index 4722e135..2970076b 100644 --- a/doc/guides/cryptodevs/features/ccp.ini +++ b/doc/guides/cryptodevs/features/ccp.ini @@ -57,3 +57,8 @@ SHA3_512 HMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'ccp' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/default.ini b/doc/guides/cryptodevs/features/default.ini index 810da0d7..73ec389b 100644 --- a/doc/guides/cryptodevs/features/default.ini +++ b/doc/guides/cryptodevs/features/default.ini @@ -95,3 +95,12 @@ AES GCM (256) = AES CCM (128) = AES CCM (192) = AES CCM (256) = +; +; Supported Asymmetric algorithms of a default crypto driver. +; +[Asymmetric] +RSA = +DSA = +Modular Exponentiation = +Modular Inversion = +Diffie-hellman =
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/dpaa2_sec.ini b/doc/guides/cryptodevs/features/dpaa2_sec.ini index 69700df4..9f4e4029 100644 --- a/doc/guides/cryptodevs/features/dpaa2_sec.ini +++ b/doc/guides/cryptodevs/features/dpaa2_sec.ini @@ -44,3 +44,8 @@ SHA512 HMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'dpaa2_sec' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/dpaa_sec.ini b/doc/guides/cryptodevs/features/dpaa_sec.ini index 937b621c..954a7080 100644 --- a/doc/guides/cryptodevs/features/dpaa_sec.ini +++ b/doc/guides/cryptodevs/features/dpaa_sec.ini @@ -44,3 +44,8 @@ SHA512 HMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'dpaa_sec' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/kasumi.ini b/doc/guides/cryptodevs/features/kasumi.ini index 0e138f5a..f3d06100 100644 --- a/doc/guides/cryptodevs/features/kasumi.ini +++ b/doc/guides/cryptodevs/features/kasumi.ini @@ -22,3 +22,8 @@ KASUMI F9 = Y ; Supported AEAD algorithms of the 'kasumi' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'kasumi' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/mvsam.ini b/doc/guides/cryptodevs/features/mvsam.ini index 0cc90a53..829deff6 100644 --- a/doc/guides/cryptodevs/features/mvsam.ini +++ b/doc/guides/cryptodevs/features/mvsam.ini @@ -52,3 +52,8 @@ AES GMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'mvsam' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/null.ini b/doc/guides/cryptodevs/features/null.ini index ecf5779a..a1c3e22a 100644 --- a/doc/guides/cryptodevs/features/null.ini +++ b/doc/guides/cryptodevs/features/null.ini @@ -24,3 +24,8 @@ NULL = Y ; Supported AEAD algorithms of the 'null' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'null' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/octeontx.ini b/doc/guides/cryptodevs/features/octeontx.ini index 307ab88c..1735b8f5 100644 --- a/doc/guides/cryptodevs/features/octeontx.ini +++ b/doc/guides/cryptodevs/features/octeontx.ini @@ -60,3 +60,8 @@ ZUC EIA3 = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'octeontx' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/qat.ini b/doc/guides/cryptodevs/features/qat.ini index 4f15ee0e..7955d884 100644 --- a/doc/guides/cryptodevs/features/qat.ini +++ b/doc/guides/cryptodevs/features/qat.ini @@ -60,3 +60,8 @@ AES GCM (256) = Y AES CCM (128) = Y AES CCM (192) = Y AES CCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'qat' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/features/snow3g.ini b/doc/guides/cryptodevs/features/snow3g.ini index 27713617..ec2daf6c 100644 --- a/doc/guides/cryptodevs/features/snow3g.ini +++ b/doc/guides/cryptodevs/features/snow3g.ini @@ -22,3 +22,8 @@ SNOW3G UIA2 = Y ; Supported AEAD algorithms of the 'snow3g' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'snow3g' crypto driver. +; +[Asymmetric]
\ No newline at end of file diff --git a/doc/guides/cryptodevs/features/virtio.ini b/doc/guides/cryptodevs/features/virtio.ini index 168fc174..b59f1669 100644 --- a/doc/guides/cryptodevs/features/virtio.ini +++ b/doc/guides/cryptodevs/features/virtio.ini @@ -24,3 +24,8 @@ SHA1 HMAC = Y ; Supported AEAD algorithms of the 'virtio' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'virtio' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/features/zuc.ini b/doc/guides/cryptodevs/features/zuc.ini index 5bb02afd..9b6a4287 100644 --- a/doc/guides/cryptodevs/features/zuc.ini +++ b/doc/guides/cryptodevs/features/zuc.ini @@ -22,3 +22,8 @@ ZUC EIA3 = Y ; Supported AEAD algorithms of the 'zuc' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'zuc' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/openssl.rst b/doc/guides/cryptodevs/openssl.rst index bdc30f66..2ac8090c 100644 --- a/doc/guides/cryptodevs/openssl.rst +++ b/doc/guides/cryptodevs/openssl.rst @@ -46,6 +46,14 @@ Supported AEAD algorithms: * ``RTE_CRYPTO_AEAD_AES_GCM`` * ``RTE_CRYPTO_AEAD_AES_CCM`` +Supported Asymmetric Crypto algorithms: + +* ``RTE_CRYPTO_ASYM_XFORM_RSA`` +* ``RTE_CRYPTO_ASYM_XFORM_DSA`` +* ``RTE_CRYPTO_ASYM_XFORM_DH`` +* ``RTE_CRYPTO_ASYM_XFORM_MODINV`` +* ``RTE_CRYPTO_ASYM_XFORM_MODEX`` + Installation ------------ diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst index 607e758d..f9f8c7be 100644 --- a/doc/guides/cryptodevs/overview.rst +++ b/doc/guides/cryptodevs/overview.rst @@ -18,7 +18,7 @@ Supported Feature Flags being the operation in-place (input address = output address). - "OOP SGL In SGL Out" feature flag stands for - "Out-of-place Scatter-gather list Input, Scatter-gater list Output", + "Out-of-place Scatter-gather list Input, Scatter-gather list Output", which means pmd supports different scatter-gather styled input and output buffers (i.e. both can consists of multiple segments). @@ -58,3 +58,10 @@ Supported AEAD Algorithms .. _table_crypto_pmd_aead_algos: .. include:: overview_aead_table.txt + +Supported Asymmetric Algorithms +------------------------------- + +.. _table_crypto_pmd_asym_algos: + +.. include:: overview_asym_table.txt diff --git a/doc/guides/cryptodevs/scheduler.rst b/doc/guides/cryptodevs/scheduler.rst index a754a27e..7004ca43 100644 --- a/doc/guides/cryptodevs/scheduler.rst +++ b/doc/guides/cryptodevs/scheduler.rst @@ -165,7 +165,7 @@ operation: For pure small packet size (64 bytes) traffic however the multi-core mode is not an optimal solution, as it doesn't give significant per-core performance improvement. For mixed traffic (IMIX) the optimal number of worker cores is around 2-3. - For large packets (1.5 Kbytes) scheduler shows linear scaling in performance + For large packets (1.5 kbytes) scheduler shows linear scaling in performance up to eight cores. Each worker uses its own slave cryptodev. Only software cryptodevs are supported. Only the same type of cryptodevs should be used concurrently. diff --git a/doc/guides/eventdevs/opdl.rst b/doc/guides/eventdevs/opdl.rst index 0262a337..979f6cd8 100644 --- a/doc/guides/eventdevs/opdl.rst +++ b/doc/guides/eventdevs/opdl.rst @@ -8,7 +8,7 @@ The OPDL (Ordered Packet Distribution Library) eventdev is a specific\ implementation of the eventdev API. It is particularly suited to packet\ processing workloads that have high throughput and low latency requirements.\ All packets follow the same path through the device. The order in which\ -packets follow is determinted by the order in which queues are set up.\ +packets follow is determined by the order in which queues are set up.\ Events are left on the ring until they are transmitted. As a result packets\ do not go out of order diff --git a/doc/guides/eventdevs/sw.rst b/doc/guides/eventdevs/sw.rst index afdcad76..04c8b030 100644 --- a/doc/guides/eventdevs/sw.rst +++ b/doc/guides/eventdevs/sw.rst @@ -70,7 +70,7 @@ Credit Quanta The credit quanta is the number of credits that a port will fetch at a time from the instance's credit pool. Higher numbers will cause less overhead in the atomic credit fetch code, however it also reduces the overall number of credits -in the system faster. A balanced number (eg 32) ensures that only small numbers +in the system faster. A balanced number (e.g. 32) ensures that only small numbers of credits are pre-allocated at a time, while also mitigating performance impact of the atomics. @@ -100,7 +100,7 @@ feature would be significant. ~~~~~~~~~~~~~~~~~~ The software eventdev does not support creating queues that handle all types of -traffic. An eventdev with this capability allows enqueueing Atomic, Ordered and +traffic. An eventdev with this capability allows enqueuing Atomic, Ordered and Parallel traffic to the same queue, but scheduling each of them appropriately. The reason to not allow Atomic, Ordered and Parallel event types in the diff --git a/doc/guides/howto/lm_bond_virtio_sriov.rst b/doc/guides/howto/lm_bond_virtio_sriov.rst index a47d6dbf..4e5ef4d5 100644 --- a/doc/guides/howto/lm_bond_virtio_sriov.rst +++ b/doc/guides/howto/lm_bond_virtio_sriov.rst @@ -328,7 +328,7 @@ On host_server_2: Terminal 1 .. code-block:: console - testomd> show port info all + testpmd> show port info all testpmd> show port stats all testpmd> show bonding config 2 testpmd> port attach 0000:00:04.0 diff --git a/doc/guides/howto/lm_virtio_vhost_user.rst b/doc/guides/howto/lm_virtio_vhost_user.rst index 3f5ebd58..019c124d 100644 --- a/doc/guides/howto/lm_virtio_vhost_user.rst +++ b/doc/guides/howto/lm_virtio_vhost_user.rst @@ -243,7 +243,7 @@ On host_server_2: Terminal 1 .. code-block:: console - testomd> show port info all + testpmd> show port info all testpmd> show port stats all Virtio traffic is seen at P0 and P1. @@ -338,7 +338,7 @@ reset_vf_on_212_131.sh #!/bin/sh # This script is run on the host 10.237.212.131 to reset SRIOV - # BDF for Ninatic NIC is 0000:06:00.0 + # BDF for Niantic NIC is 0000:06:00.0 cat /sys/bus/pci/devices/0000\:06\:00.0/max_vfs echo 0 > /sys/bus/pci/devices/0000\:06\:00.0/max_vfs cat /sys/bus/pci/devices/0000\:06\:00.0/max_vfs diff --git a/doc/guides/howto/rte_flow.rst b/doc/guides/howto/rte_flow.rst index 6a8534d9..e080570e 100644 --- a/doc/guides/howto/rte_flow.rst +++ b/doc/guides/howto/rte_flow.rst @@ -23,7 +23,7 @@ In this example we will create a simple rule that drops packets whose IPv4 destination equals 192.168.3.2. This code is equivalent to the following testpmd command (wrapped for clarity):: - tpmd> flow create 0 ingress pattern eth / vlan / + testpmd> flow create 0 ingress pattern eth / vlan / ipv4 dst is 192.168.3.2 / end actions drop / end Code @@ -118,7 +118,7 @@ a mask. This code is equivalent to the following testpmd command (wrapped for clarity):: - tpmd> flow create 0 ingress pattern eth / vlan / + testpmd> flow create 0 ingress pattern eth / vlan / ipv4 dst spec 192.168.3.0 dst mask 255.255.255.0 / end actions drop / end @@ -219,7 +219,7 @@ In this example we will create a rule that routes all vlan id 123 to queue 3. This code is equivalent to the following testpmd command (wrapped for clarity):: - tpmd> flow create 0 ingress pattern eth / vlan vid spec 123 / + testpmd> flow create 0 ingress pattern eth / vlan vid spec 123 / end actions queue index 3 / end Code diff --git a/doc/guides/howto/virtio_user_as_exceptional_path.rst b/doc/guides/howto/virtio_user_as_exceptional_path.rst index 4910c12d..ec021af3 100644 --- a/doc/guides/howto/virtio_user_as_exceptional_path.rst +++ b/doc/guides/howto/virtio_user_as_exceptional_path.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2016 Intel Corporation. -.. _virtio_user_as_excpetional_path: +.. _virtio_user_as_exceptional_path: Virtio_user as Exceptional Path =============================== @@ -22,7 +22,7 @@ solution is very promising in: * Features vhost-net is born to be a networking solution, which has lots of networking - related featuers, like multi queue, tso, multi-seg mbuf, etc. + related features, like multi queue, tso, multi-seg mbuf, etc. * Performance @@ -38,7 +38,7 @@ in :numref:`figure_virtio_user_as_exceptional_path`. .. figure:: img/virtio_user_as_exceptional_path.* - Overview of a DPDK app using virtio-user as excpetional path + Overview of a DPDK app using virtio-user as exceptional path Sample Usage @@ -75,7 +75,7 @@ compiling the kernel and those kernel modules should be inserted. * ``queues`` - Number of multi-queues. Each qeueue will be served by a kthread. For example: + Number of multi-queues. Each queue will be served by a kthread. For example: .. code-block:: console diff --git a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst index 9d1f0fa0..fd7a46c8 100644 --- a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst +++ b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst @@ -14,25 +14,25 @@ This chapter describes how to cross compile DPDK for ARM64 from x86 build hosts. Obtain the cross tool chain --------------------------- The latest cross compile tool chain can be downloaded from: -https://releases.linaro.org/components/toolchain/binaries/latest/aarch64-linux-gnu/. +https://developer.arm.com/open-source/gnu-toolchain/gnu-a/downloads. -Following is the step to get the version 7.2.1, latest one at the time of this writing. +Following is the step to get the version 8.2, latest one at the time of this writing. .. code-block:: console - wget https://releases.linaro.org/components/toolchain/binaries/latest/aarch64-linux-gnu/gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu.tar.xz + wget https://developer.arm.com/-/media/Files/downloads/gnu-a/8.2-2019.01/gcc-arm-8.2-2019.01-x86_64-aarch64-linux-gnu.tar.xz Unzip and add into the PATH --------------------------- .. code-block:: console - tar -xvf gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu.tar.xz - export PATH=$PATH:<cross_install_dir>/gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu/bin + tar -xvf gcc-arm-8.2-2019.01-x86_64-aarch64-linux-gnu.tar.xz + export PATH=$PATH:<cross_install_dir>/gcc-arm-8.2-2019.01-x86_64-aarch64-linux-gnu/bin .. note:: - For the host requirements and other info, refer to the release note section: https://releases.linaro.org/components/toolchain/binaries/latest/ + For the host requirements and other info, refer to the release note section: https://releases.linaro.org/components/toolchain/binaries/ Getting the prerequisite library -------------------------------- @@ -69,8 +69,8 @@ Copy the NUMA header files and lib to the cross compiler's directories: .. code-block:: console - cp <numa_install_dir>/include/numa*.h <cross_install_dir>/gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu/bin/../aarch64-linux-gnu/libc/usr/include/ - cp <numa_install_dir>/lib/libnuma.a <cross_install_dir>/gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu/lib/gcc/aarch64-linux-gnu/7.2.1/ + cp <numa_install_dir>/include/numa*.h <cross_install_dir>/gcc-arm-8.2-2019.01-x86_64-aarch64-linux-gnu/bin/../aarch64-linux-gnu/libc/usr/include/ + cp <numa_install_dir>/lib/libnuma.a <cross_install_dir>/gcc-arm-8.2-2019.01-x86_64-aarch64-linux-gnu/lib/gcc/aarch64-linux-gnu/8.2/ .. _configure_and_cross_compile_dpdk_build: diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst index 1c6f86a2..735bc6ee 100644 --- a/doc/guides/linux_gsg/sys_reqs.rst +++ b/doc/guides/linux_gsg/sys_reqs.rst @@ -184,7 +184,7 @@ In the case of a dual-socket NUMA system, the number of hugepages reserved at boot time is generally divided equally between the two sockets (on the assumption that sufficient memory is present on both sockets). -See the Documentation/kernel-parameters.txt file in your Linux source tree for further details of these and other kernel options. +See the Documentation/admin-guide/kernel-parameters.txt file in your Linux source tree for further details of these and other kernel options. **Alternative:** diff --git a/doc/guides/nics/atlantic.rst b/doc/guides/nics/atlantic.rst index 80591b13..f6f2c66b 100644 --- a/doc/guides/nics/atlantic.rst +++ b/doc/guides/nics/atlantic.rst @@ -18,7 +18,7 @@ Supported features - Port statistics - RSS (Receive Side Scaling) - Checksum offload -- Jumbo Frame upto 16K +- Jumbo Frame up to 16K Configuration Information ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index 58d88eef..39106274 100644 --- a/doc/guides/nics/cxgbe.rst +++ b/doc/guides/nics/cxgbe.rst @@ -126,7 +126,7 @@ enabling debugging options may affect system performance. - ``CONFIG_RTE_LIBRTE_CXGBE_TPUT`` (default **y**) - Toggle behaviour to prefer Throughput or Latency. + Toggle behavior to prefer Throughput or Latency. Runtime Options ~~~~~~~~~~~~~~~ @@ -140,7 +140,7 @@ be passed as part of EAL arguments. For example, - ``keep_ovlan`` (default **0**) - Toggle behaviour to keep/strip outer VLAN in Q-in-Q packets. If + Toggle behavior to keep/strip outer VLAN in Q-in-Q packets. If enabled, the outer VLAN tag is preserved in Q-in-Q packets. Otherwise, the outer VLAN tag is stripped in Q-in-Q packets. diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst index 2173673b..5900ed0d 100644 --- a/doc/guides/nics/dpaa.rst +++ b/doc/guides/nics/dpaa.rst @@ -251,7 +251,7 @@ state during application initialization: automatically be assigned from the these high perf PUSH queues. Any queue configuration beyond that will be standard Rx queues. The application can choose to change their number if HW portals are limited. - The valid values are from '0' to '4'. The valuse shall be set to '0' if the + The valid values are from '0' to '4'. The values shall be set to '0' if the application want to use eventdev with DPAA device. diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index 769dc4e1..04370e4c 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -379,7 +379,7 @@ active -- Ethernet, crypto, compression, etc. DPBP based Mempool driver ~~~~~~~~~~~~~~~~~~~~~~~~~ -The DPBP driver is bound to a DPBP objects and provides sevices to +The DPBP driver is bound to a DPBP objects and provides services to create a hardware offloaded packet buffer mempool. DPAA2 NIC Driver diff --git a/doc/guides/nics/enetc.rst b/doc/guides/nics/enetc.rst index 8038bf20..376768d3 100644 --- a/doc/guides/nics/enetc.rst +++ b/doc/guides/nics/enetc.rst @@ -69,7 +69,7 @@ Supported ENETC SoCs Prerequisites ~~~~~~~~~~~~~ -There are three main pre-requisities for executing ENETC PMD on a ENETC +There are three main pre-requisites for executing ENETC PMD on a ENETC compatible board: 1. **ARM 64 Tool Chain** diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index bc38f51a..c1b83b9b 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -224,7 +224,7 @@ the use of SR-IOV. passthrough devices do not require libvirt, port profiles, and VM-FEX. -.. _enic-genic-flow-api: +.. _enic-generic-flow-api: Generic Flow API support ------------------------ @@ -247,7 +247,7 @@ Generic Flow API is supported. The baseline support is: in the pattern. - Attributes: ingress - - Items: eth, ipv4, ipv6, udp, tcp, vxlan, inner eth, ipv4, ipv6, udp, tcp + - Items: eth, vlan, ipv4, ipv6, udp, tcp, vxlan, inner eth, vlan, ipv4, ipv6, udp, tcp - Actions: queue and void - Selectors: 'is', 'spec' and 'mask'. 'last' is not supported - In total, up to 64 bytes of mask is allowed across all headers @@ -255,7 +255,7 @@ Generic Flow API is supported. The baseline support is: - **1300 and later series VICS with advanced filters enabled** - Attributes: ingress - - Items: eth, ipv4, ipv6, udp, tcp, vxlan, inner eth, ipv4, ipv6, udp, tcp + - Items: eth, vlan, ipv4, ipv6, udp, tcp, vxlan, inner eth, vlan, ipv4, ipv6, udp, tcp - Actions: queue, mark, drop, flag and void - Selectors: 'is', 'spec' and 'mask'. 'last' is not supported - In total, up to 64 bytes of mask is allowed across all headers @@ -266,6 +266,12 @@ Generic Flow API is supported. The baseline support is: - Action: count +The VIC performs packet matching after applying VLAN strip. If VLAN +stripping is enabled, EtherType in the ETH item corresponds to the +stripped VLAN header's EtherType. Stripping does not affect the VLAN +item. TCI and EtherType in the VLAN item are matched against those in +the (stripped) VLAN header whether stripping is enabled or disabled. + More features may be added in future firmware and new versions of the VIC. Please refer to the release notes. @@ -450,6 +456,7 @@ PKT_RX_VLAN_STRIPPED mbuf flags would not be set. This mode is enabled with the 1000 for 1300 series VICs). Filters are checked for matching in the order they were added. Since there currently is no grouping or priority support, 'catch-all' filters should be added last. + - The supported range of IDs for the 'MARK' action is 0 - 0xFFFD. - **Statistics** diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index d3f90483..d57ddc2f 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -285,7 +285,7 @@ Inner RSS Supports RX RSS hashing on Inner headers. -* **[users] rte_flow_action_rss**: ``level``. +* **[uses] rte_flow_action_rss**: ``level``. * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_HASH``, ``mbuf.rss``. @@ -495,7 +495,7 @@ Supports adding traffic mirroring rules. Inline crypto ------------- -Supports inline crypto processing (eg. inline IPsec). See Security library and PMD documentation for more details. +Supports inline crypto processing (e.g. inline IPsec). See Security library and PMD documentation for more details. * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SECURITY``, * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_SECURITY``. diff --git a/doc/guides/nics/features/qede.ini b/doc/guides/nics/features/qede.ini index 0d081002..f69e4f84 100644 --- a/doc/guides/nics/features/qede.ini +++ b/doc/guides/nics/features/qede.ini @@ -23,6 +23,7 @@ N-tuple filter = Y Tunnel filter = Y Flow director = Y Flow control = Y +Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index 40bf0f14..62e90d9f 100644 --- a/doc/guides/nics/i40e.rst +++ b/doc/guides/nics/i40e.rst @@ -571,7 +571,7 @@ bandwidth setting. TC TX scheduling mode setting ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -There're 2 TX scheduling modes for TCs, round robin and strict priority mode. +There are 2 TX scheduling modes for TCs, round robin and strict priority mode. If a TC is set to strict priority mode, it can consume unlimited bandwidth. It means if APP has set the max bandwidth for that TC, it comes to no effect. diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst index 1c294b06..975143f8 100644 --- a/doc/guides/nics/ixgbe.rst +++ b/doc/guides/nics/ixgbe.rst @@ -203,8 +203,8 @@ as a workaround. X550 does not support legacy interrupt mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Desccription -^^^^^^^^^^^^ +Description +^^^^^^^^^^^ X550 cannot get interrupts if using ``uio_pci_generic`` module or using legacy interrupt mode of ``igb_uio`` or ``vfio``. Because the errata of X550 states that the Interrupt Status bit is not implemented. The errata is the item #22 diff --git a/doc/guides/nics/kni.rst b/doc/guides/nics/kni.rst index 204fbd56..c4fc9637 100644 --- a/doc/guides/nics/kni.rst +++ b/doc/guides/nics/kni.rst @@ -64,7 +64,7 @@ backend device by default. PMD arguments ------------- -``no_request_thread``, by default PMD creates a phtread for each KNI interface +``no_request_thread``, by default PMD creates a pthread for each KNI interface to handle Linux network interface control commands, like ``ifconfig kni0 up`` With ``no_request_thread`` option, pthread is not created and control commands diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 436898ac..31238ae3 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -85,6 +85,11 @@ Limitations - Forked secondary process not supported. - All mempools must be initialized before rte_eth_dev_start(). + - External memory unregistered in EAL memseg list cannot be used for DMA + unless such memory has been registered by ``mlx5_mr_update_ext_mp()`` in + primary process and remapped to the same virtual address in secondary + process. If the external memory is registered by primary process but has + different virtual address in secondary process, unexpected error may happen. - Flow pattern without any specific vlan will match for vlan packets as well: @@ -148,7 +153,7 @@ Limitations - E-Switch VXLAN decapsulation Flow: - - can be appiled to PF port only. + - can be applied to PF port only. - must specify VF port action (packet redirection from PF to VF). - must specify tunnel outer UDP local (destination) port, wildcards not allowed. - must specify tunnel outer VNI, wildcards not allowed. @@ -163,7 +168,7 @@ Limitations - must specify the VXLAN item with tunnel outer parameters. - must specify the tunnel outer VNI in the VXLAN item. - must specify the tunnel outer remote (destination) UDP port in the VXLAN item. - - must specify the tunnel outer local (source) IPv4 or IPv6 in the , this address will locally (with scope link) assigned to the outer network interace, wildcards not allowed. + - must specify the tunnel outer local (source) IPv4 or IPv6 in the , this address will locally (with scope link) assigned to the outer network interface, wildcards not allowed. - must specify the tunnel outer remote (destination) IPv4 or IPv6 in the VXLAN item, group IPs allowed. - must specify the tunnel outer destination MAC address in the VXLAN item, this address will be used to create neigh rule. @@ -306,7 +311,7 @@ Run-time configuration buffers per a packet, one large buffer is posted in order to receive multiple packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides and each stride receives one packet. MPRQ can improve throughput for - small-packet tarffic. + small-packet traffic. When MPRQ is enabled, max_rx_pkt_len can be larger than the size of user-provided mbuf even if DEV_RX_OFFLOAD_SCATTER isn't enabled. PMD will @@ -317,7 +322,7 @@ Run-time configuration - ``mprq_log_stride_num`` parameter [int] Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more - strides can reduce PCIe tarffic further. If configured value is not in the + strides can reduce PCIe traffic further. If configured value is not in the range of device capability, the default value will be set with a warning message. The default value is 4 which is 16 strides per a buffer, valid only if ``mprq_en`` is set. @@ -564,7 +569,7 @@ Either RDMA Core library with a recent enough Linux kernel release (recommended) or Mellanox OFED, which provides compatibility with older releases. -RMDA Core with Linux Kernel +RDMA Core with Linux Kernel ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_) diff --git a/doc/guides/nics/mvpp2.rst b/doc/guides/nics/mvpp2.rst index b2ddeab5..f63d8587 100644 --- a/doc/guides/nics/mvpp2.rst +++ b/doc/guides/nics/mvpp2.rst @@ -91,7 +91,7 @@ Limitations chance to start in a sane state. - MUSDK architecture does not support changing configuration in run time. - All nessesary configurations should be done before first dev_start(). + All necessary configurations should be done before first dev_start(). - RX queue start/stop is not supported. diff --git a/doc/guides/nics/netvsc.rst b/doc/guides/nics/netvsc.rst index 87fabf5b..6dbb9a55 100644 --- a/doc/guides/nics/netvsc.rst +++ b/doc/guides/nics/netvsc.rst @@ -89,7 +89,7 @@ operations: .. Note:: - The dpkd-devbind.py script can not be used since it only handles PCI devices. + The dpdk-devbind.py script can not be used since it only handles PCI devices. Prerequisites diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index 40065284..f449b19d 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -96,7 +96,7 @@ Non-supported Features The features not yet supported include: -- Receive queue interupts +- Receive queue interrupts - Priority-based flow control @@ -207,12 +207,12 @@ Supported actions: Validating flow rules depends on the firmware variant. -Ethernet destinaton individual/group match -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Ethernet destination individual/group match +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Ethernet item supports I/G matching, if only the corresponding bit is set -in the mask of destination address. If destinaton address in the spec is -multicast, it matches all multicast (and broadcast) packets, oherwise it +in the mask of destination address. If destination address in the spec is +multicast, it matches all multicast (and broadcast) packets, otherwise it matches unicast packets that are not filtered by other flow rules. Exceptions to flow rules @@ -346,10 +346,10 @@ boolean parameters value. - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**) - Choose hardware tunning to be optimized for either throughput or + Choose hardware tuning to be optimized for either throughput or low-latency. **auto** allows NIC firmware to make a choice based on - installed licences and firmware variant configured using **sfboot**. + installed licenses and firmware variant configured using **sfboot**. - ``stats_update_period_ms`` [long] (default **1000**) diff --git a/doc/guides/nics/szedata2.rst b/doc/guides/nics/szedata2.rst index a2092f9c..94dba82d 100644 --- a/doc/guides/nics/szedata2.rst +++ b/doc/guides/nics/szedata2.rst @@ -89,7 +89,7 @@ The NFB cards are multi-port multi-queue cards, where (generally) data from any Ethernet port may be sent to any queue. They were historically represented in DPDK as a single port. -However, the new NFB-200G2QL card employs an addon cable which allows to connect +However, the new NFB-200G2QL card employs an add-on cable which allows to connect it to two physical PCI-E slots at the same time (see the diagram below). This is done to allow 200 Gbps of traffic to be transferred through the PCI-E bus (note that a single PCI-E 3.0 x16 slot provides only 125 Gbps theoretical diff --git a/doc/guides/nics/tap.rst b/doc/guides/nics/tap.rst index 9a3d7b34..14c669b7 100644 --- a/doc/guides/nics/tap.rst +++ b/doc/guides/nics/tap.rst @@ -40,7 +40,7 @@ actual MAC address: ``00:64:74:61:70:[00-FF]``. --vdev=net_tap0,mac="00:64:74:61:70:11" The MAC address will have a user value passed as string. The MAC address is in -format with delimeter ``:``. The string is byte converted to hex and you get +format with delimiter ``:``. The string is byte converted to hex and you get the actual MAC address: ``00:64:74:61:70:11``. It is possible to specify a remote netdevice to capture packets from by adding diff --git a/doc/guides/platform/dpaa.rst b/doc/guides/platform/dpaa.rst index 39048715..6005f222 100644 --- a/doc/guides/platform/dpaa.rst +++ b/doc/guides/platform/dpaa.rst @@ -4,7 +4,7 @@ NXP QorIQ DPAA Board Support Package ==================================== -This doc has information about steps to setup QorIq dpaa +This doc has information about steps to setup QorIQ dpaa based layerscape platform and information about common offload hw block drivers of **NXP QorIQ DPAA** SoC family. @@ -38,7 +38,7 @@ Common Offload HW Block Drivers Steps To Setup Platform ----------------------- -There are four main pre-requisities for executing DPAA PMD on a DPAA +There are four main pre-requisites for executing DPAA PMD on a DPAA compatible board: 1. **ARM 64 Tool Chain** diff --git a/doc/guides/platform/dpaa2.rst b/doc/guides/platform/dpaa2.rst index 5a64406e..2586af0f 100644 --- a/doc/guides/platform/dpaa2.rst +++ b/doc/guides/platform/dpaa2.rst @@ -4,7 +4,7 @@ NXP QorIQ DPAA2 Board Support Package ===================================== -This doc has information about steps to setup NXP QoriQ DPAA2 platform +This doc has information about steps to setup NXP QorIQ DPAA2 platform and information about common offload hw block drivers of **NXP QorIQ DPAA2** SoC family. @@ -48,7 +48,7 @@ Common Offload HW Block Drivers Steps To Setup Platform ----------------------- -There are four main pre-requisities for executing DPAA2 PMD on a DPAA2 +There are four main pre-requisites for executing DPAA2 PMD on a DPAA2 compatible board: 1. **ARM 64 Tool Chain** diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst index 9de14443..658ffd40 100644 --- a/doc/guides/prog_guide/bbdev.rst +++ b/doc/guides/prog_guide/bbdev.rst @@ -78,7 +78,7 @@ From the application point of view, each instance of a bbdev device consists of one or more queues identified by queue IDs. While different devices may have different capabilities (e.g. support different operation types), all queues on a device support identical configuration possibilities. A queue is configured -for only one type of operation and is configured at initializations time. +for only one type of operation and is configured at initialization time. When an operation is enqueued to a specific queue ID, the result is dequeued from the same queue ID. @@ -678,7 +678,7 @@ bbdev framework, by giving a sample code performing a loop-back operation with a baseband processor capable of transceiving data packets. The following sample C-like pseudo-code shows the basic steps to encode several -buffers using (**sw_trubo**) bbdev PMD. +buffers using (**sw_turbo**) bbdev PMD. .. code-block:: c diff --git a/doc/guides/prog_guide/compressdev.rst b/doc/guides/prog_guide/compressdev.rst index 87e26490..3ba4238c 100644 --- a/doc/guides/prog_guide/compressdev.rst +++ b/doc/guides/prog_guide/compressdev.rst @@ -17,7 +17,7 @@ Device Creation Physical compression devices are discovered during the bus probe of the EAL function which is executed at DPDK initialization, based on their unique device identifier. -For eg. PCI devices can be identified using PCI BDF (bus/bridge, device, function). +For e.g. PCI devices can be identified using PCI BDF (bus/bridge, device, function). Specific physical compression devices, like other physical devices in DPDK can be white-listed or black-listed using the EAL command line options. @@ -379,7 +379,7 @@ using priv_xform would look like: setup op->m_src and op->m_dst; } num_enqd = rte_compressdev_enqueue_burst(cdev_id, 0, comp_ops, NUM_OPS); - /* wait for this to complete before enqueing next*/ + /* wait for this to complete before enqueuing next*/ do { num_deque = rte_compressdev_dequeue_burst(cdev_id, 0 , &processed_ops, NUM_OPS); } while (num_dqud < num_enqd); @@ -526,7 +526,7 @@ An example pseudocode to set up and process a stream having NUM_CHUNKS with each op->src.length = CHUNK_LEN; op->input_chksum = 0; num_enqd = rte_compressdev_enqueue_burst(cdev_id, 0, &op[i], 1); - /* wait for this to complete before enqueing next*/ + /* wait for this to complete before enqueuing next*/ do { num_deqd = rte_compressdev_dequeue_burst(cdev_id, 0 , &processed_ops, 1); } while (num_deqd < num_enqd); diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst index 8ee33c87..23770ffd 100644 --- a/doc/guides/prog_guide/cryptodev_lib.rst +++ b/doc/guides/prog_guide/cryptodev_lib.rst @@ -14,7 +14,7 @@ and AEAD symmetric and asymmetric Crypto operations. Design Principles ----------------- -The cryptodev library follows the same basic principles as those used in DPDKs +The cryptodev library follows the same basic principles as those used in DPDK's Ethernet Device framework. The Crypto framework provides a generic Crypto device framework which supports both physical (hardware) and virtual (software) Crypto devices as well as a generic Crypto API which allows Crypto devices to be @@ -48,7 +48,7 @@ From the command line using the --vdev EAL option * If DPDK application requires multiple software crypto PMD devices then required number of ``--vdev`` with appropriate libraries are to be added. - * An Application with crypto PMD instaces sharing the same library requires unique ID. + * An Application with crypto PMD instances sharing the same library requires unique ID. Example: ``--vdev 'crypto_aesni_mb0' --vdev 'crypto_aesni_mb1'`` @@ -382,7 +382,7 @@ Operation Management and Allocation The cryptodev library provides an API set for managing Crypto operations which utilize the Mempool Library to allocate operation buffers. Therefore, it ensures -that the crytpo operation is interleaved optimally across the channels and +that the crypto operation is interleaved optimally across the channels and ranks for optimal processing. A ``rte_crypto_op`` contains a field indicating the pool that it originated from. When calling ``rte_crypto_op_free(op)``, the operation returns to its original pool. @@ -586,7 +586,7 @@ Sample code There are various sample applications that show how to use the cryptodev library, such as the L2fwd with Crypto sample application (L2fwd-crypto) and -the IPSec Security Gateway application (ipsec-secgw). +the IPsec Security Gateway application (ipsec-secgw). While these applications demonstrate how an application can be created to perform generic crypto operation, the required complexity hides the basic steps of @@ -767,7 +767,7 @@ using one of the crypto PMDs available in DPDK. /* * Dequeue the crypto operations until all the operations - * are proccessed in the crypto device. + * are processed in the crypto device. */ uint16_t num_dequeued_ops, total_num_dequeued_ops = 0; do { @@ -846,7 +846,7 @@ the order in which the transforms are passed indicates the order of the chaining Not all asymmetric crypto xforms are supported for chaining. Currently supported asymmetric crypto chaining is Diffie-Hellman private key generation followed by public generation. Also, currently API does not support chaining of symmetric and -asymmetric crypto xfroms. +asymmetric crypto xforms. Each xform defines specific asymmetric crypto algo. Currently supported are: * RSA diff --git a/doc/guides/prog_guide/dev_kit_build_system.rst b/doc/guides/prog_guide/dev_kit_build_system.rst index da83a31e..a851a811 100644 --- a/doc/guides/prog_guide/dev_kit_build_system.rst +++ b/doc/guides/prog_guide/dev_kit_build_system.rst @@ -216,8 +216,6 @@ Objects Misc ^^^^ -* rte.doc.mk: Documentation in the development kit framework - * rte.gnuconfigure.mk: Build an application that is configure-based. * rte.subdir.mk: Build several directories in the development kit framework. @@ -249,7 +247,7 @@ Creates the following symbol: Which ``dpdk-pmdinfogen`` scans for. Using this information other relevant bits of data can be exported from the object file and used to produce a hardware support description, that ``dpdk-pmdinfogen`` then encodes into a -json formatted string in the following format: +JSON formatted string in the following format: .. code-block:: c diff --git a/doc/guides/prog_guide/efd_lib.rst b/doc/guides/prog_guide/efd_lib.rst index cb1a1df8..2b355ff2 100644 --- a/doc/guides/prog_guide/efd_lib.rst +++ b/doc/guides/prog_guide/efd_lib.rst @@ -423,6 +423,6 @@ References 1- EFD is based on collaborative research work between Intel and Carnegie Mellon University (CMU), interested readers can refer to the paper -“Scaling Up Clustered Network Appliances with ScaleBricks;” Dong Zhou et al. +"Scaling Up Clustered Network Appliances with ScaleBricks" Dong Zhou et al. at SIGCOMM 2015 (`http://conferences.sigcomm.org/sigcomm/2015/pdf/papers/p241.pdf`) for more information. diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index 426acfc2..2bb77b01 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -147,6 +147,14 @@ A default validator callback is provided by EAL, which can be enabled with a ``--socket-limit`` command-line option, for a simple way to limit maximum amount of memory that can be used by DPDK application. +.. warning:: + Memory subsystem uses DPDK IPC internally, so memory allocations/callbacks + and IPC must not be mixed: it is not safe to allocate/free memory inside + memory-related or IPC callbacks, and it is not safe to use IPC inside + memory-related callbacks. See chapter + :ref:`Multi-process Support <Multi-process_Support>` for more details about + DPDK IPC. + + Legacy memory mode This mode is enabled by specifying ``--legacy-mem`` command-line switch to the @@ -441,6 +449,28 @@ Those TLS include *_cpuset* and *_socket_id*: * *_socket_id* stores the NUMA node of the CPU set. If the CPUs in CPU set belong to different NUMA node, the *_socket_id* will be set to SOCKET_ID_ANY. +Control Thread API +~~~~~~~~~~~~~~~~~~ + +It is possible to create Control Threads using the public API +``rte_ctrl_thread_create()``. +Those threads can be used for management/infrastructure tasks and are used +internally by DPDK for multi process support and interrupt handling. + +Those threads will be scheduled on CPUs part of the original process CPU +affinity from which the dataplane and service lcores are excluded. + +For example, on a 8 CPUs system, starting a dpdk application with -l 2,3 +(dataplane cores), then depending on the affinity configuration which can be +controlled with tools like taskset (Linux) or cpuset (FreeBSD), + +- with no affinity configuration, the Control Threads will end up on + 0-1,4-7 CPUs. +- with affinity restricted to 2-4, the Control Threads will end up on + CPU 4. +- with affinity restricted to 2-3, the Control Threads will end up on + CPU 2 (master lcore, which is the default when no CPU is available). + .. _known_issue_label: Known Issues @@ -626,7 +656,7 @@ The most important fields in the structure and how they are used are described b Malloc heap is a doubly-linked list, where each element keeps track of its previous and next elements. Due to the fact that hugepage memory can come and -go, neighbouring malloc elements may not necessarily be adjacent in memory. +go, neighboring malloc elements may not necessarily be adjacent in memory. Also, since a malloc element may span multiple pages, its contents may not necessarily be IOVA-contiguous either - each malloc element is only guaranteed to be virtually contiguous. diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst index 0166bb45..7bc559c8 100644 --- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst +++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst @@ -157,7 +157,7 @@ The servicing_weight member of struct rte_event_eth_rx_adapter_queue_conf is applicable when the adapter uses a service core function. The application has to enable Rx queue interrupts when configuring the ethernet device using the ``rte_eth_dev_configure()`` function and then use a servicing_weight -of zero when addding the Rx queue to the adapter. +of zero when adding the Rx queue to the adapter. The adapter creates a thread blocked on the interrupt, on an interrupt this thread enqueues the port id and the queue id to a ring buffer. The adapter @@ -175,9 +175,9 @@ Rx Callback for SW Rx Adapter For SW based packet transfers, i.e., when the ``RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT`` is not set in the adapter's capabilities flags for a particular ethernet device, the service function -temporarily enqueues mbufs to an event buffer before batch enqueueing these +temporarily enqueues mbufs to an event buffer before batch enqueuing these to the event device. If the buffer fills up, the service function stops -dequeueing packets from the ethernet device. The application may want to +dequeuing packets from the ethernet device. The application may want to monitor the buffer fill level and instruct the service function to selectively enqueue packets to the event device. The application may also use some other criteria to decide which packets should enter the event device even when diff --git a/doc/guides/prog_guide/eventdev.rst b/doc/guides/prog_guide/eventdev.rst index 8fcae546..27c51d25 100644 --- a/doc/guides/prog_guide/eventdev.rst +++ b/doc/guides/prog_guide/eventdev.rst @@ -42,7 +42,7 @@ The rte_event structure contains the following metadata fields, which the application fills in to have the event scheduled as required: * ``flow_id`` - The targeted flow identifier for the enq/deq operation. -* ``event_type`` - The source of this event, eg RTE_EVENT_TYPE_ETHDEV or CPU. +* ``event_type`` - The source of this event, e.g. RTE_EVENT_TYPE_ETHDEV or CPU. * ``sub_event_type`` - Distinguishes events inside the application, that have the same event_type (see above) * ``op`` - This field takes one of the RTE_EVENT_OP_* values, and tells the @@ -265,7 +265,7 @@ Linking Queues and Ports The final step is to "wire up" the ports to the queues. After this, the eventdev is capable of scheduling events, and when cores request work to do, the correct events are provided to that core. Note that the RX core takes input -from eg: a NIC so it is not linked to any eventdev queues. +from e.g.: a NIC so it is not linked to any eventdev queues. Linking all workers to atomic queues, and the TX core to the single-link queue can be achieved like this: @@ -276,7 +276,7 @@ can be achieved like this: uint8_t tx_port_id = 5; uint8_t atomic_qs[] = {0, 1}; uint8_t single_link_q = 2; - uin8t_t priority = RTE_EVENT_DEV_PRIORITY_NORMAL; + uint8_t priority = RTE_EVENT_DEV_PRIORITY_NORMAL; for(int worker_port_id = 1; worker_port_id <= 4; worker_port_id++) { int links_made = rte_event_port_link(dev_id, worker_port_id, atomic_qs, NULL, 2); diff --git a/doc/guides/prog_guide/kernel_nic_interface.rst b/doc/guides/prog_guide/kernel_nic_interface.rst index 33ea980e..7b8a481a 100644 --- a/doc/guides/prog_guide/kernel_nic_interface.rst +++ b/doc/guides/prog_guide/kernel_nic_interface.rst @@ -225,7 +225,7 @@ application functions: ``config_promiscusity``: - Called when the user changes the promiscusity state of the KNI + Called when the user changes the promiscuity state of the KNI interface. For example, when the user runs ``ip link set promisc [on|off] dev <ifaceX>``. If the user sets this callback function to NULL, but sets the ``port_id`` field to a value other than -1, a default diff --git a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst index 56abee54..2459fd24 100644 --- a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +++ b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst @@ -477,22 +477,22 @@ Create a bonded device in round robin mode with two slaves specified by their PC .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0, slave=0000:00a:00.01,slave=0000:004:00.00' -- --port-topology=chained + $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00' -- --port-topology=chained Create a bonded device in round robin mode with two slaves specified by their PCI address and an overriding MAC address: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0, slave=0000:00a:00.01,slave=0000:004:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained + $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained Create a bonded device in active backup mode with two slaves specified, and a primary slave specified by their PCI addresses: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1, slave=0000:00a:00.01,slave=0000:004:00.00,primary=0000:00a:00.01' -- --port-topology=chained + $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,slave=0000:0a:00.01,slave=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained Create a bonded device in balance mode with two slaves specified by their PCI addresses, and a transmission policy of layer 3 + 4 forwarding: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2, slave=0000:00a:00.01,slave=0000:004:00.00,xmit_policy=l34' -- --port-topology=chained + $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,slave=0000:0a:00.01,slave=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained diff --git a/doc/guides/prog_guide/lpm_lib.rst b/doc/guides/prog_guide/lpm_lib.rst index 99563a4a..1609a57d 100644 --- a/doc/guides/prog_guide/lpm_lib.rst +++ b/doc/guides/prog_guide/lpm_lib.rst @@ -195,4 +195,4 @@ References `http://www.ietf.org/rfc/rfc1519 <http://www.ietf.org/rfc/rfc1519>`_ * Pankaj Gupta, Algorithms for Routing Lookups and Packet Classification, PhD Thesis, Stanford University, - 2000 (`http://klamath.stanford.edu/~pankaj/thesis/ thesis_1sided.pdf <http://klamath.stanford.edu/~pankaj/thesis/%20thesis_1sided.pdf>`_ ) + 2000 (`http://klamath.stanford.edu/~pankaj/thesis/thesis_1sided.pdf <http://klamath.stanford.edu/~pankaj/thesis/thesis_1sided.pdf>`_ ) diff --git a/doc/guides/prog_guide/metrics_lib.rst b/doc/guides/prog_guide/metrics_lib.rst index e68e4e74..89bc7d68 100644 --- a/doc/guides/prog_guide/metrics_lib.rst +++ b/doc/guides/prog_guide/metrics_lib.rst @@ -25,7 +25,7 @@ individual device. Since the metrics library is self-contained, the only restriction on port numbers is that they are less than ``RTE_MAX_ETHPORTS`` - there is no requirement for the ports to actually exist. -Initialising the library +Initializing the library ------------------------ Before the library can be used, it has to be initialized by calling diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst index 1384fe33..a84083b9 100644 --- a/doc/guides/prog_guide/multi_proc_support.rst +++ b/doc/guides/prog_guide/multi_proc_support.rst @@ -176,7 +176,7 @@ Some of these are documented below: * The use of function pointers between multiple processes running based of different compiled binaries is not supported, since the location of a given function in one process may be different to its location in a second. - This prevents the librte_hash library from behaving properly as in a multi-threaded instance, + This prevents the librte_hash library from behaving properly as in a multi-process instance, since it uses a pointer to the hash function internally. To work around this issue, it is recommended that multi-process applications perform the hash calculations by directly calling @@ -263,9 +263,9 @@ To send a request, a message descriptor ``rte_mp_msg`` must be populated. Additionally, a ``timespec`` value must be specified as a timeout, after which IPC will stop waiting and return. -For synchronous synchronous requests, the ``rte_mp_reply`` descriptor must also -be created. This is where the responses will be stored. The list of fields that -will be populated by IPC are as follows: +For synchronous requests, the ``rte_mp_reply`` descriptor must also be created. +This is where the responses will be stored. +The list of fields that will be populated by IPC are as follows: * ``nb_sent`` - number indicating how many requests were sent (i.e. how many peer processes were active at the time of the request). @@ -273,7 +273,7 @@ will be populated by IPC are as follows: those peer processes that were active at the time of request, how many have replied) * ``msgs`` - pointer to where all of the responses are stored. The order in - which responses appear is undefined. Whendoing sycnrhonous requests, this + which responses appear is undefined. When doing synchronous requests, this memory must be freed by the requestor after request completes! For asynchronous requests, a function pointer to the callback function must be @@ -309,6 +309,13 @@ If a response is required, a new ``rte_mp_msg`` message descriptor must be constructed and sent via ``rte_mp_reply()`` function, along with ``peer`` pointer. The resulting response will then be delivered to the correct requestor. +.. warning:: + Simply returning a value when processing a request callback will not send a + response to the request - it must always be explicitly sent even in case + of errors. Implementation of error signalling rests with the application, + there is no built-in way to indicate success or error for a request. Failing + to do so will cause the requestor to time out while waiting on a response. + Misc considerations ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -318,6 +325,11 @@ supported. However, since sending messages (not requests) does not involve an IPC thread, sending messages while processing another message or request is supported. +Since the memory sybsystem uses IPC internally, memory allocations and IPC must +not be mixed: it is not safe to use IPC inside a memory-related callback, nor is +it safe to allocate/free memory inside IPC callbacks. Attempting to do so may +lead to a deadlock. + Asynchronous request callbacks may be triggered either from IPC thread or from interrupt thread, depending on whether the request has timed out. It is therefore suggested to avoid waiting for interrupt-based events (such as alarms) diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst index b2cf4835..6fae39f9 100644 --- a/doc/guides/prog_guide/poll_mode_drv.rst +++ b/doc/guides/prog_guide/poll_mode_drv.rst @@ -374,9 +374,9 @@ parameters to those ports. this argument allows user to specify which switch ports to enable port representors for.:: - -w BDBF,representor=0 - -w BDBF,representor=[0,4,6,9] - -w BDBF,representor=[0-31] + -w DBDF,representor=0 + -w DBDF,representor=[0,4,6,9] + -w DBDF,representor=[0-31] Note: PMDs are not required to support the standard device arguments and users should consult the relevant PMD documentation to see support devargs. diff --git a/doc/guides/prog_guide/profile_app.rst b/doc/guides/prog_guide/profile_app.rst index 02f05614..c1b29f93 100644 --- a/doc/guides/prog_guide/profile_app.rst +++ b/doc/guides/prog_guide/profile_app.rst @@ -64,7 +64,7 @@ The default ``cntvct_el0`` based ``rte_rdtsc()`` provides a portable means to get a wall clock counter in user space. Typically it runs at <= 100MHz. The alternative method to enable ``rte_rdtsc()`` for a high resolution wall -clock counter is through the armv8 PMU subsystem. The PMU cycle counter runs +clock counter is through the ARMv8 PMU subsystem. The PMU cycle counter runs at CPU frequency. However, access to the PMU cycle counter from user space is not enabled by default in the arm64 linux kernel. It is possible to enable cycle counter for user space access by configuring the PMU from the privileged @@ -75,7 +75,7 @@ scheme. Application can choose the PMU based implementation with ``CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU``. The example below shows the steps to configure the PMU based cycle counter on -an armv8 machine. +an ARMv8 machine. .. code-block:: console diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index dbf4999a..4e9b4440 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2131,7 +2131,7 @@ as defined in the ``rte_flow_action_raw_decap`` This action modifies the payload of matched flows. The data supplied must be a valid header, either holding layer 2 data in case of removing layer 2 -before eincapsulation of layer 3 tunnel (for example MPLSoGRE) or complete +before encapsulation of layer 3 tunnel (for example MPLSoGRE) or complete tunnel definition starting from layer 2 and moving to the tunnel item itself. When applied to the original packet the resulting packet must be a valid packet. @@ -2281,7 +2281,7 @@ Action: ``DEC_TTL`` Decrease TTL value. If there is no valid RTE_FLOW_ITEM_TYPE_IPV4 or RTE_FLOW_ITEM_TYPE_IPV6 -in pattern, Some PMDs will reject rule because behaviour will be undefined. +in pattern, Some PMDs will reject rule because behavior will be undefined. .. _table_rte_flow_action_dec_ttl: @@ -2299,7 +2299,7 @@ Action: ``SET_TTL`` Assigns a new TTL value. If there is no valid RTE_FLOW_ITEM_TYPE_IPV4 or RTE_FLOW_ITEM_TYPE_IPV6 -in pattern, Some PMDs will reject rule because behaviour will be undefined. +in pattern, Some PMDs will reject rule because behavior will be undefined. .. _table_rte_flow_action_set_ttl: @@ -2725,7 +2725,7 @@ Caveats - API operations are synchronous and blocking (``EAGAIN`` cannot be returned). -- There is no provision for reentrancy/multi-thread safety, although nothing +- There is no provision for re-entrancy/multi-thread safety, although nothing should prevent different devices from being configured at the same time. PMDs may protect their control path functions accordingly. diff --git a/doc/guides/prog_guide/rte_security.rst b/doc/guides/prog_guide/rte_security.rst index cb70caa7..7d0734a3 100644 --- a/doc/guides/prog_guide/rte_security.rst +++ b/doc/guides/prog_guide/rte_security.rst @@ -40,7 +40,7 @@ Inline Crypto ~~~~~~~~~~~~~ RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO: -The crypto processing for security protocol (e.g. IPSec) is processed +The crypto processing for security protocol (e.g. IPsec) is processed inline during receive and transmission on NIC port. The flow based security action should be configured on the port. @@ -48,7 +48,7 @@ Ingress Data path - The packet is decrypted in RX path and relevant crypto status is set in Rx descriptors. After the successful inline crypto processing the packet is presented to host as a regular Rx packet however all security protocol related headers are still attached to the -packet. e.g. In case of IPSec, the IPSec tunnel headers (if any), +packet. e.g. In case of IPsec, the IPsec tunnel headers (if any), ESP/AH headers will remain in the packet but the received packet contains the decrypted data where the encrypted data was when the packet arrived. The driver Rx path check the descriptors and and based on the @@ -111,7 +111,7 @@ Inline protocol offload ~~~~~~~~~~~~~~~~~~~~~~~ RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL: -The crypto and protocol processing for security protocol (e.g. IPSec) +The crypto and protocol processing for security protocol (e.g. IPsec) is processed inline during receive and transmission. The flow based security action should be configured on the port. @@ -119,7 +119,7 @@ Ingress Data path - The packet is decrypted in the RX path and relevant crypto status is set in the Rx descriptors. After the successful inline crypto processing the packet is presented to the host as a regular Rx packet but all security protocol related headers are optionally removed from the -packet. e.g. in the case of IPSec, the IPSec tunnel headers (if any), +packet. e.g. in the case of IPsec, the IPsec tunnel headers (if any), ESP/AH headers will be removed from the packet and the received packet will contains the decrypted packet only. The driver Rx path checks the descriptors and based on the crypto status sets additional flags in @@ -132,7 +132,7 @@ to identify the security processing done on the packet. The underlying device in this case is stateful. It is expected that the device shall support crypto processing for all kind of packets matching to a given flow, this includes fragmented packets (post reassembly). - E.g. in case of IPSec the device may internally manage anti-replay etc. + E.g. in case of IPsec the device may internally manage anti-replay etc. It will provide a configuration option for anti-replay behavior i.e. to drop the packets or pass them to driver with error flags set in the descriptor. @@ -150,7 +150,7 @@ to cross the MTU size. .. note:: The underlying device will manage state information required for egress - processing. E.g. in case of IPSec, the seq number will be added to the + processing. E.g. in case of IPsec, the seq number will be added to the packet, however the device shall provide indication when the sequence number is about to overflow. The underlying device may support post encryption TSO. @@ -199,13 +199,13 @@ crypto device. Decryption: The packet is sent to the crypto device for security protocol processing. The device will decrypt the packet and it will also optionally remove additional security headers from the packet. -E.g. in case of IPSec, IPSec tunnel headers (if any), ESP/AH headers +E.g. in case of IPsec, IPsec tunnel headers (if any), ESP/AH headers will be removed from the packet and the decrypted packet may contain plain data only. .. note:: - In case of IPSec the device may internally manage anti-replay etc. + In case of IPsec the device may internally manage anti-replay etc. It will provide a configuration option for anti-replay behavior i.e. to drop the packets or pass them to driver with error flags set in descriptor. @@ -217,7 +217,7 @@ for any protocol header addition. .. note:: - In the case of IPSec, the seq number will be added to the packet, + In the case of IPsec, the seq number will be added to the packet, It shall provide an indication when the sequence number is about to overflow. @@ -549,7 +549,7 @@ IPsec related configuration parameters are defined in ``rte_security_ipsec_xform struct rte_security_ipsec_sa_options options; /**< various SA options */ enum rte_security_ipsec_sa_direction direction; - /**< IPSec SA Direction - Egress/Ingress */ + /**< IPsec SA Direction - Egress/Ingress */ enum rte_security_ipsec_sa_protocol proto; /**< IPsec SA Protocol - AH/ESP */ enum rte_security_ipsec_sa_mode mode; diff --git a/doc/guides/prog_guide/traffic_management.rst b/doc/guides/prog_guide/traffic_management.rst index 98ac4310..05b34d93 100644 --- a/doc/guides/prog_guide/traffic_management.rst +++ b/doc/guides/prog_guide/traffic_management.rst @@ -39,7 +39,7 @@ whether a specific implementation does meet the needs to the user application. At the TM level, users can get high level idea with the help of various parameters such as maximum number of nodes, maximum number of hierarchical levels, maximum number of shapers, maximum number of private shapers, type of -scheduling algorithm (Strict Priority, Weighted Fair Queueing , etc.), etc., +scheduling algorithm (Strict Priority, Weighted Fair Queuing , etc.), etc., supported by the implementation. Likewise, users can query the capability of the TM at the hierarchical level to diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst index c77df338..27c3af8f 100644 --- a/doc/guides/prog_guide/vhost_lib.rst +++ b/doc/guides/prog_guide/vhost_lib.rst @@ -63,7 +63,7 @@ The following is an overview of some key Vhost API functions: 512). * zero copy is really good for VM2VM case. For iperf between two VMs, the - boost could be above 70% (when TSO is enableld). + boost could be above 70% (when TSO is enabled). * For zero copy in VM2NIC case, guest Tx used vring may be starved if the PMD driver consume the mbuf but not release them timely. diff --git a/doc/guides/rawdevs/ifpga_rawdev.rst b/doc/guides/rawdevs/ifpga_rawdev.rst index d400db6e..a3d92a62 100644 --- a/doc/guides/rawdevs/ifpga_rawdev.rst +++ b/doc/guides/rawdevs/ifpga_rawdev.rst @@ -91,7 +91,7 @@ Run-time parameters ------------------- This driver is invoked automatically in systems added with Intel FPGA, -but PR and IFPGA Bus scan is trigged by command line using +but PR and IFPGA Bus scan is triggered by command line using ``--vdev 'ifpga_rawdev_cfg`` EAL option. The following device parameters are supported: diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst index 358dfa32..276327c1 100644 --- a/doc/guides/rel_notes/known_issues.rst +++ b/doc/guides/rel_notes/known_issues.rst @@ -676,7 +676,7 @@ igb uio legacy mode can not be used in X710/XL710/XXV710 **Description**: X710/XL710/XXV710 NICs lack support for indicating INTx is asserted via the interrupt - bit in the PCI status register. Linux delected them from INTx support table. The related + bit in the PCI status register. Linux deleted them from INTx support table. The related `commit <https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/commit/drivers/pci/quirks.c?id=8bcf4525c5d43306c5fd07e132bc8650e3491aec>`_. **Implication**: @@ -722,9 +722,9 @@ Linux kernel 4.10.0 iommu attribute read error **Description**: When VT-d is enabled (``iommu=pt intel_iommu=on``), reading IOMMU attributes from /sys/devices/virtual/iommu/dmarXXX/intel-iommu/cap on Linux kernel 4.10.0 error. - This bug is fixed in `Linux commmit a7fdb6e648fb + This bug is fixed in `Linux commit a7fdb6e648fb <https://patchwork.kernel.org/patch/9595727/>`_, - This bug is introduced in `Linux commmit 39ab9555c241 + This bug is introduced in `Linux commit 39ab9555c241 <https://patchwork.kernel.org/patch/9554403/>`_, **Implication**: @@ -842,7 +842,7 @@ AVX-512 support disabled drop. On DPDK v19.02 ``AVX-512`` disable scope is reduced to ``GCC`` and ``binutils version 2.30`` based - on information accured from the GCC community defect. + on information accrued from the GCC community defect. **Reason**: Generated ``AVX-512`` code cause crash: diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst index 2a93af32..6448b6cb 100644 --- a/doc/guides/rel_notes/release_17_11.rst +++ b/doc/guides/rel_notes/release_17_11.rst @@ -168,7 +168,7 @@ New Features * The DES CBC algorithm. * The DES DOCSIS BPI algorithm. - This change requires version 0.47 of the IPSec Multi-buffer library. For + This change requires version 0.47 of the IPsec Multi-buffer library. For more details see the :doc:`../cryptodevs/aesni_mb` documentation. * **Updated the OpenSSL PMD.** @@ -198,7 +198,7 @@ New Features * **Added the Security Offload Library.** Added an experimental library - ``rte_security``. This provide security APIs - for protocols like IPSec using inline ipsec offload to ethernet devices or + for protocols like IPsec using inline ipsec offload to ethernet devices or full protocol offload with lookaside crypto devices. See the :doc:`../prog_guide/rte_security` section of the DPDK Programmers @@ -207,11 +207,11 @@ New Features * **Updated the DPAA2_SEC crypto driver to support rte_security.** Updated the ``dpaa2_sec`` crypto PMD to support ``rte_security`` lookaside - protocol offload for IPSec. + protocol offload for IPsec. * **Updated the IXGBE ethernet driver to support rte_security.** - Updated ixgbe ethernet PMD to support ``rte_security`` inline IPSec offload. + Updated ixgbe ethernet PMD to support ``rte_security`` inline IPsec offload. * **Updated i40e driver to support GTP-C/GTP-U.** @@ -509,7 +509,7 @@ ABI Changes * **New parameter added to rte_eth_dev.** A new parameter ``security_ctx`` has been added to ``rte_eth_dev`` to - support security operations like IPSec inline. + support security operations like IPsec inline. * **New parameter added to rte_cryptodev.** diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst index 2f386fc5..071e010d 100644 --- a/doc/guides/rel_notes/release_18_11.rst +++ b/doc/guides/rel_notes/release_18_11.rst @@ -862,8 +862,8 @@ Tested Platforms * Ubuntu 18.04.1 LTS with NXP QorIQ LSDK 1809 support packages * Ubuntu 16.04.3 LTS with NXP QorIQ LSDK 1803 support packages -Fixes and Validation in 18.11 Stable Release --------------------------------------------- +18.11.1 Release Notes +---------------------- 18.11.1 Fixes ~~~~~~~~~~~~~ @@ -1177,3 +1177,514 @@ Fixes and Validation in 18.11 Stable Release * vhost single/multi queues and cross-NUMA * vhostclient reconnect * vhost live migration with single/multi queues and cross-NUMA + +18.11.2 Release Notes +---------------------- + +18.11.2 Fixes +~~~~~~~~~~~~~ + +* acl: fix compiler flags with meson and AVX2 runtime +* app/bbdev: replace sprintf with snprintf or strlcpy +* app/crypto-perf: check range of socket id +* app/pdump: remove only created vdevs +* app/test: fix build with musl libc +* app/test: fix flags with meson +* app/test: fix sprintf with strlcat +* app/testpmd: add missing newline when showing statistics +* app/testpmd: extend forwarding statistics to 64 bits +* app/testpmd: fix a typo in log message +* app/testpmd: fix help info for interactive commands +* app/testpmd: fix hex string parser support for flow API +* app/testpmd: fix mempool free on exit +* app/testpmd: fix offload flags after port config +* app/testpmd: fix return value check +* app/testpmd: fix stdout flush after printing stats +* app/testpmd: fix Tx QinQ set +* app/testpmd: fix Tx VLAN and QinQ dependency +* app/testpmd: fix typo in comment +* app/testpmd: fix unintentional integer overflow +* app/testpmd: fix variable use before null check +* app/testpmd: remove unused field from port struct +* app/testpmd: remove useless casts on statistics +* bitrate: fix unchecked return value +* build: fix crash by disabling AVX512 with binutils 2.31 +* build: fix meson binutils workaround +* build: fix ninja install on FreeBSD +* build: remove meson warning for Arm +* build: use default flags for default Arm machine +* bus/dpaa: fix Rx discard register mask +* bus/fslmc: decrease log level for unsupported devices +* bus/fslmc: fix build with musl libc +* bus/fslmc: fix warning with GCC 9 +* bus/fslmc: fix warning with GCC 9 +* bus/fslmc: remove unused include of error.h +* bus/vdev: fix debug message on probing +* bus/vdev: fix hotplug twice +* bus/vmbus: fix check for mmap failure +* bus/vmbus: fix resource leak on error +* bus/vmbus: fix secondary process setup +* bus/vmbus: map ring in secondary process +* bus/vmbus: stop mapping if empty resource found +* cfgfile: replace strcat with strlcat +* ci: add a distinguisher to the extra Travis builds +* ci: enable ccache in Travis +* ci: introduce Travis builds for GitHub repositories +* common/cpt: fix null auth only +* compress/isal: fix compression stream initialization +* compress/isal: fix getting information about CPU +* compress/qat: fix setup inter buffers +* crypto/caam_jr: fix memory leak and illegal access +* crypto/caam_jr: fix shared descriptor endianness +* crypto/caam_jr: fix total length in auth only s/g +* cryptodev: fix driver name comparison +* crypto/dpaa2_sec: fix offset calculation for GCM +* crypto/dpaa2_sec: fix session clearing +* crypto/dpaa: fix session destroy +* crypto/kasumi: fix dependency check +* crypto/openssl: fix big numbers after computations +* crypto/openssl: fix modexp +* crypto/qat: fix null cipher algo for non 8-byte multiple +* crypto/snow3g: add to meson build +* crypto/virtio: fix IV offset +* crypto/virtio: use local log type +* crypto/zuc: fix dependency check +* devtools: accept experimental symbol promotion +* devtools: add libelf dependency to build test +* devtools: fix build test on FreeBSD +* devtools: fix check of symbol added as stable API +* devtools: fix result of svg include check +* devtools: fix symbol name in check log +* devtools: fix test of some build options +* devtools: skip meson build for missing compilers +* devtools: support older compilers with meson test +* devtools: test build of zlib PMD +* doc: add flow API to qede NIC features +* doc: add missing algorithms for AESNI-MB PMD +* doc: fix ABI check script examples +* doc: fix a minor typo in testpmd guide +* doc: fix broken link in LPM guide +* doc: fix examples in bonding guide +* doc: fix formatting in testpmd guide +* doc: fix heading levels in bbdev test guide +* doc: fix interactive commands in testpmd guide +* doc: fix JSON interface for power sample +* doc: fix link in Linux getting started guide +* doc: fix links to doxygen and sphinx sites +* doc: fix missing asymmetric crypto table +* doc: fix PCI whitelist typo in prog guide +* doc: fix spelling in testpmd guide +* doc: fix spelling reported by aspell in comments +* doc: fix spelling reported by aspell in guides +* doc: fix tag for inner RSS feature +* doc: fix two typos in contributing guide +* doc: fix typo in IPC guide +* doc: fix typo in mlx5 guide +* doc: fix typos in mlx5 guide +* doc: fix typos in testpmd user guide +* doc: remove reference to rte.doc.mk in programmers guide +* doc: update cross Arm toolchain in Linux guide +* drivers/event: disable OcteonTx for buggy Arm compilers +* drivers: fix SPDX license id consistency +* drivers/net: fix possible overflow using strlcat +* drivers/net: fix shifting 32-bit signed variable 31 times +* drivers/qat: fix queue pair NUMA node +* eal: fix check when retrieving current CPU affinity +* eal: fix cleanup in no-shconf mode +* eal: fix control threads pinnning +* eal: fix core list validation with disabled cores +* eal: fix formatting of hotplug error message +* eal: fix typo in comment of vector function +* eal: initialize alarms early +* eal/linux: fix log levels for pagemap reading failure +* eal/linux: remove thread ID from debug message +* eal/ppc: fix global memory barrier +* eal: remove dead code in core list parsing +* eal: restrict control threads to startup CPU affinity +* eal: support strlcat function +* eal: tighten permissions on shared memory files +* ethdev: fix a typo +* ethdev: fix method name in doxygen comment +* ethdev: fix typo in error messages +* ethdev: remove unused variable +* eventdev: fix crypto adapter +* eventdev: fix Rx adapter event flush +* eventdev: update references to removed function +* event/dsw: fix capability flags +* event/dsw: ignore scheduling type for single-link queues +* event/opdl: replace sprintf with snprintf +* event/sw: fix enqueue checks in self-test +* examples/ethtool: fix two typos +* examples/fips_validation: fix CMAC test +* examples/ip_pipeline: disable build when no epoll +* examples/ipsec-secgw: fix AES-CTR block size +* examples/ipsec-secgw: fix build error log +* examples/ipsec-secgw: fix debug logs +* examples/ipsec-secgw: fix SPD no-match case +* examples/l2fwd-cat: fix build on FreeBSD +* examples/multi_process: fix buffer underrun +* examples/power: fix buffer overrun +* examples/power: fix build with some disabled PMDs +* examples/power: fix json null termination +* examples/power: fix overflowed value +* examples/power: fix resource leak +* examples/power: fix string null termination +* examples/power: fix string overflow +* examples/power: fix unreachable VF MAC init +* examples/vhost_crypto: fix dependency on vhost library +* examples/vhost_scsi: fix null-check for parameter +* hash: fix doc about thread/process safety +* hash: fix position returned in free slots +* hash: fix total entries count +* ipc: add warnings about correct API usage +* ipc: add warnings about not using IPC with memory API +* ipc: fix memory leak on request failure +* ipc: fix send error handling +* ipc: handle more invalid parameter cases +* ipc: harden message receive +* ipc: unlock on failure +* kni: fix build with Linux 5.1 +* kni: fix type for MAC address +* maintainers: update for IBM POWER +* malloc: fix documentation of realloc function +* malloc: fix IPC message initialization +* mbuf: fix a typo +* mbuf: update Tx VLAN and QinQ flags documentation +* mem: limit use of address hint +* mempool/dpaa2: fix continuous print on empty pool +* mem: warn user when running without NUMA support +* mk: disable packed member pointer warning for telemetry +* mk: disable warning for packed member pointer +* mk: fix AVX512 disabled warning on non x86 +* mk: fix build of shared library with libbsd +* net/atlantic: bad logic with offsets talking with firmware +* net/atlantic: eeprom get/set should consider offset +* net/atlantic: eliminate excessive log levels on Rx/Tx +* net/atlantic: enable broadcast traffic +* net/atlantic: error handling for mailbox access +* net/atlantic: extra line at eof +* net/atlantic: fix buffer overflow +* net/atlantic: fix EEPROM get for small and uneven lengths +* net/atlantic: fix link configuration +* net/atlantic: fix max eeprom size +* net/atlantic: fix missing VLAN filter offload +* net/atlantic: fix negative error codes +* net/atlantic: fix xstats return +* net/atlantic: flow control settings synchronization on rx +* net/atlantic: remove extra checks for error codes +* net/atlantic: remove unused variable +* net/atlantic: use capability bits to detect eeprom access +* net/atlantic: validity check for eeprom dev address +* net/avf: fix admin queue interrupt for ICE +* net/bnx2x: fix DMAE timeout +* net/bnx2x: fix memory leak +* net/bnx2x: fix MTU for jumbo frame +* net/bnx2x: fix optic module verification +* net/bnx2x: fix race for periodic flags +* net/bnx2x: fix ramrod timeout +* net/bnxt: fix big endian build +* net/bnxt: fix Rx VLAN offload flags +* net/bnxt: silence IOVA warnings +* net/bnxt: support IOVA VA mode +* net/bnxt: suppress spurious error log +* net/bonding: avoid warning for invalid port +* net/bonding: fix buffer length when printing strings +* net/bonding: fix LACP negotiation +* net/bonding: fix link status +* net/bonding: fix packet count type for LACP +* net/bonding: fix port id types +* net/bonding: fix queue index types +* net/bonding: fix slave id types +* net/bonding: fix slave Tx burst for mode 4 +* net/bonding: fix Tx in 802.3ad mode +* net/bonding: fix values of descriptor limits +* net/cxgbe: fix colliding function names +* net/cxgbe: fix missing checksum flags and packet type +* net/cxgbe: update Chelsio T5/T6 NIC device ids +* net/enetc: fix big endian build and buffer allocation +* net/enetc: fix crash at high speed traffic +* net/enetc: fix SMMU unhandled context fault +* net/enic: allow flow mark ID 0 +* net/enic: check for unsupported flow item types +* net/enic: fix endianness in VLAN match +* net/enic: fix flow director SCTP matching +* net/enic: fix inner packet matching +* net/enic: fix max MTU calculation +* net/enic: fix SCTP match for flow API +* net/enic: fix VLAN inner type matching for old hardware +* net/enic: fix VXLAN match +* net/enic: move arguments into struct +* net/enic: reset VXLAN port regardless of overlay offload +* net: fix Tx VLAN flag for offload emulation +* net/fm10k: fix VLAN strip offload flag +* net/i40e: fix dereference before check when getting EEPROM +* net/i40e: fix dereference before null check in mbuf release +* net/i40e: fix link speed for X722 +* net/i40e: fix logging on VF close +* net/i40e: fix queue number check +* net/i40e: fix scattered Rx enabling +* net/i40e: fix time sync for 25G +* net/i40e: forbid two RSS flow rules +* net/i40e: log when provided RSS key is not valid +* net/iavf: fix info get +* net/ixgbe: fix warning with GCC 9 +* net/ixgbe: restore VLAN filter for VF +* net/kni: fix return value check +* net/mlx4: change device reference for secondary process +* net/mlx4: fix memory region cleanup +* net/mlx5: check Tx queue size overflow +* net/mlx5: fix comments mixing Rx and Tx +* net/mlx5: fix errno typos in comments +* net/mlx5: fix external memory registration +* net/mlx5: fix flow priorities probing error path +* net/mlx5: fix hex dump of error completion +* net/mlx5: fix instruction hotspot on replenishing Rx buffer +* net/mlx5: fix max number of queues for NEON Tx +* net/mlx5: fix memory event on secondary process +* net/mlx5: fix memory region cleanup +* net/mlx5: fix Multi-Packet RQ mempool name +* net/mlx5: fix packet inline on Tx queue wraparound +* net/mlx5: fix release of Rx queue object +* net/mlx5: fix RSS validation function +* net/mlx5: fix sync when handling Tx completions +* net/mlx5: fix Tx metadata for multi-segment packet +* net/mlx: prefix private structure +* net/mlx: remove debug messages on datapath +* net/netvsc: fix include of fcntl.h +* net/netvsc: fix VF support with secondary process +* net/netvsc: remove useless condition +* net/netvsc: reset mbuf port on VF Rx +* net/nfp: check return value +* net/nfp: fix build with musl libc +* net/nfp: fix file descriptor check +* net/nfp: fix memory leak +* net/nfp: fix possible buffer overflow +* net/nfp: fix potential integer overflow +* net/nfp: fix RSS query +* net/nfp: fix setting MAC address +* net/octeontx: fix vdev name +* net/pcap: fix memory leak +* net/qede: fix Rx packet drop +* net/qede: fix Tx packet prepare for tunnel packets +* net/qede: support IOVA VA mode +* net/ring: avoid hard-coded length +* net/ring: check length of ring name +* net/ring: fix coding style +* net/ring: fix return value check +* net/ring: use calloc style where appropriate +* net/sfc: fix logging from secondary process +* net/sfc: fix MTU change to check Rx scatter consistency +* net/sfc: fix speed capabilities reported in device info +* net/sfc: improve TSO header length check in EF10 datapath +* net/sfc: improve TSO header length check in EFX datapath +* net/sfc: log port ID as 16-bit unsigned integer on panic +* net/sfc: remove control path logging from Rx queue count +* net/softnic: fix possible buffer overflow +* net/tap: fix getting max iovec +* net/tap: fix memory leak on IPC request +* net/tap: fix multi process reply buffer +* net/tap: fix multi-process request +* net/tap: fix potential IPC buffer overrun +* net/vdev_netvsc: fix device cast +* net/virtio: add barrier in interrupt enable +* net/virtio: add barriers for extra descriptors on Rx split +* net/virtio: fix buffer leak on VLAN insert +* net/virtio: fix dangling pointer on failure +* net/virtio: fix duplicate naming of include guard +* net/virtio: fix in-order Tx path for split ring +* net/virtio: remove forward declaration +* net/virtio: remove useless condition +* net/virtio: set offload flag for jumbo frames +* net/virtio-user: fix multi-process support +* net/virtio-user: fix multiqueue with vhost kernel +* net/virtio-user: fix return value check +* net/vmxnet3: add VLAN filter capability +* power: fix cache line alignment +* power: fix governor storage to trim newlines +* power: fix thread-safety environment modification +* power: remove unused variable +* raw/dpaa2_cmdif: fix warnings with GCC 9 +* raw/dpaa2_qdma: fix spin lock release +* raw/dpaa2_qdma: fix to support multiprocess execution +* raw/ifpga: fix file descriptor leak in error path +* raw/ifpga: modify log output +* raw/skeleton: fix warnings with GCC 9 +* Revert "app/testpmd: fix offload flags after port config" +* ring: enforce reading tail before slots +* ring: fix an error message +* ring: fix namesize macro documentation block +* rwlock: reimplement with atomic builtins +* spinlock: reimplement with atomic one-way barrier +* table: fix arm64 hash function selection +* telemetry: fix mapping of statistics +* test/barrier: fix allocation check +* test/barrier: fix for Power CPUs +* test/barrier: fix typo in log +* test/bonding: fix MAC assignment for re-run +* test: clean remaining trace of devargs autotest +* test/compress: fix missing header include +* test/crypto: fix duplicate id used by CCP device +* test/crypto: fix possible overflow using strlcat +* test/distributor: replace sprintf with strlcpy +* test/event: replace sprintf with snprintf +* test/hash: replace sprintf with snprintf +* test/pmd_perf: fix the way to drain the port +* test/spinlock: amortize the cost of getting time +* test/spinlock: remove delay for correct benchmarking +* version: 18.11.2-rc1 +* vfio: document multiprocess limitation for container API +* vhost/crypto: fix parens +* vhost: fix device leak on connection add failure +* vhost: fix interrupt suppression for the split ring +* vhost: fix null pointer checking +* vhost: fix passing destroyed device to destroy callback +* vhost: fix potential use-after-free for memory region +* vhost: fix potential use-after-free for zero copy mbuf +* vhost: fix silent queue enabling with legacy guests +* vhost: fix sprintf with snprintf +* vhost: prevent disabled rings to be processed with zero-copy +* vhost: restore mbuf first when freeing zmbuf + +18.11.2 Validation +~~~~~~~~~~~~~~~~~~ + +* IBM(R) Testing + + * Tests run + + * Single port stability test using l3fwd (16 cpus) and TRex + * 64 and 1500 byte packets at a 0.0% drop rate for 4 hours each + + * System tested + + * IBM Power9 Model 8335-101 CPU: 2.3 (pvr 004e 1203) + + * Tested NICs + + * ConnectX-5 (fw 16.23.1020). + + * OS Tested + + * Ubuntu 18.04.2 LTS (kernel 4.15.0-47-generic) + +* Intel(R) Openvswitch Testing + + * OVS testing against head OVS Master and OVS 2.11.0 with VSPERF + + * Tested NICs + + * i40e (X710) and i40eVF + * ixgbe (82599ES) and ixgbeVF + * igb (I350) and igbVF + + * Functionality + + * P2P + * PVP + * PVVP + * PV-PV in parallel + * Hotplug + * Multiqueue + * Vhostuserclient reconnect + * Vhost cross-NUMA awareness + * Jumbo frames + * Rate limiting + * QoS policer + +* Mellanox(R) Testing + + * Basic functionality + + * Send and receive multiple types of traffic + * testpmd xstats counter test + * testpmd timestamp test + * Changing/checking link status through testpmd + * RTE flow and flow_director tests + * Some RSS tests + * VLAN stripping and insertion tests + * Checksum and TSO tests + * ptype tests + * Port interrupt testing + * Multi-process testing + + * OFED versions tested + + * MLNX_OFED_LINUX-4.5-1.0.1.0 + * MLNX_OFED_LINUX-4.6-1.0.1.1 + + * Tested NICs + + * ConnectX-4 Lx (fw 14.25.1010). + * ConnectX-5 (fw 16.25.1010). + + * OS tested + + * RHEL7.4 (kernel 3.10.0-693.el7.x86_64). + +* Microsoft(R) Azure Testing + + * Images + + * Canonical UbuntuServer 16.04-LTS latest + * Canonical UbuntuServer 18.04-DAILY-LTS latest + * RedHat RHEL 7-RAW latest + * RedHat RHEL 7.5 latest + * Openlogic CentOS 7.5 latest + * SUSE SLES 15 latest + + * Drivers + + * Mellanox and netvsc poll-mode drivers + + * Functionality + + * VM to VM traffic + * SRIOV/Failsafe + * Single and multicore performance + +* Red Hat(R) Testing + + * RHEL 7 and RHEL 8 + * Functionality + + * PF + * VF + * vhost single/multi queues and cross-NUMA + * vhostclient reconnect + * vhost live migration with single/multi queues and cross-NUMA + * OVS PVP + + * Tested NICs + + * X540-AT2 NIC(ixgbe, 10G) + +* Intel(R) Testing + + * Basic Intel(R) NIC(ixgbe and i40e) testing + + * vlan + * vxlan + * Jumbo frames + * Generic filter + * Flow director + * PF and VF + * Intel NIC single core/NIC performance + + * Basic cryptodev and virtio testing + + * cryptodev + * vhost/virtio basic loopback, PVP and performance test + +18.11.2 Known Issues +~~~~~~~~~~~~~~~~~~~~ + +* DPDK 18.11.2 contains fixes up to DPDK v19.05. Issues identified/fixed in DPDK master branch after DPDK v19.05 may be present in DPDK 18.11.2 +* testpmd: queue specific offloads may be over-written by the default config. This is not a regression from earlier DPDK 18.11 releases. + +Fixes skipped and status unresolved +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* dcfbc594f net/iavf: fix queue interrupt for ice (18.02) +* 281bd1aa3 net/iavf: fix stats reset (18.02) +* fe252fb69 test/rwlock: benchmark on all available cores (1.2.3r0) +* 6fef1ae4f test/rwlock: amortize the cost of getting time (1.2.3r0) diff --git a/doc/guides/sample_app_ug/bbdev_app.rst b/doc/guides/sample_app_ug/bbdev_app.rst index 653f972f..6ade9c6e 100644 --- a/doc/guides/sample_app_ug/bbdev_app.rst +++ b/doc/guides/sample_app_ug/bbdev_app.rst @@ -68,7 +68,7 @@ The application accepts a number of command line options: where: -* ``e ENCODING_CORES``: hexmask for encoding lcored (default = 0x2) +* ``e ENCODING_CORES``: hexmask for encoding lcores (default = 0x2) * ``d DECODING_CORES``: hexmask for decoding lcores (default = 0x4) * ``p ETH_PORT_ID``: ethernet port ID (default = 0) * ``b BBDEV_ID``: BBDev ID (default = 0) @@ -87,7 +87,7 @@ issue the command: $ ./build/bbdev --vdev='baseband_turbo_sw' -w <NIC0PCIADDR> -c 0x38 --socket-mem=2,2 \ --file-prefix=bbdev -- -e 0x10 -d 0x20 -where, NIC0PCIADDR is the PCI addresse of the Rx port +where, NIC0PCIADDR is the PCI address of the Rx port This command creates one virtual bbdev devices ``baseband_turbo_sw`` where the device gets linked to a corresponding ethernet port as whitelisted by diff --git a/doc/guides/sample_app_ug/eventdev_pipeline.rst b/doc/guides/sample_app_ug/eventdev_pipeline.rst index 0ec02907..dc7972aa 100644 --- a/doc/guides/sample_app_ug/eventdev_pipeline.rst +++ b/doc/guides/sample_app_ug/eventdev_pipeline.rst @@ -49,7 +49,7 @@ these settings is shown below: ./build/eventdev_pipeline --vdev event_sw0 -- -r1 -t1 -e4 -w FF00 -s4 -n0 -c32 -W1000 -D The application has some sanity checking built-in, so if there is a function -(eg; the RX core) which doesn't have a cpu core mask assigned, the application +(e.g.; the RX core) which doesn't have a cpu core mask assigned, the application will print an error message: .. code-block:: console diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst index 159bcf73..90704194 100644 --- a/doc/guides/sample_app_ug/intro.rst +++ b/doc/guides/sample_app_ug/intro.rst @@ -106,7 +106,7 @@ examples are highlighted below. (packet arrival) and TX (packet transmission) by adding callbacks to the RX and TX packet processing functions. -* :doc:`IPSec Security Gateway<ipsec_secgw>`: The IPSec Security +* :doc:`IPsec Security Gateway<ipsec_secgw>`: The IPsec Security Gateway application is minimal example of something closer to a real world example. This is also a good example of an application using the DPDK Cryptodev framework. diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst b/doc/guides/sample_app_ug/ip_pipeline.rst index 447a544d..4da0fcf8 100644 --- a/doc/guides/sample_app_ug/ip_pipeline.rst +++ b/doc/guides/sample_app_ug/ip_pipeline.rst @@ -113,7 +113,7 @@ Application stages Initialization ~~~~~~~~~~~~~~ -During this stage, EAL layer is initialised and application specific arguments are parsed. Furthermore, the data strcutures +During this stage, EAL layer is initialised and application specific arguments are parsed. Furthermore, the data structures (i.e. linked lists) for application objects are initialized. In case of any initialization error, an error message is displayed and the application is terminated. @@ -185,7 +185,7 @@ Examples +-----------------------+----------------------+----------------+------------------------------------+ | IP routing | LPM (IPv4) | Forward | 1. Mempool Create | | | | | 2. Link create | - | | * Key = IP dest addr | | 3. Pipeline creat | + | | * Key = IP dest addr | | 3. Pipeline create | | | * Offset = 286 | | 4. Pipeline port in/out | | | * Table size = 4K | | 5. Pipeline table | | | | | 6. Pipeline port in table | diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst index 4869a011..5f7d3973 100644 --- a/doc/guides/sample_app_ug/ipsec_secgw.rst +++ b/doc/guides/sample_app_ug/ipsec_secgw.rst @@ -25,8 +25,8 @@ The application classifies the ports as *Protected* and *Unprotected*. Thus, traffic received on an Unprotected or Protected port is consider Inbound or Outbound respectively. -The application also supports complete IPSec protocol offload to hardware -(Look aside crypto accelarator or using ethernet device). It also support +The application also supports complete IPsec protocol offload to hardware +(Look aside crypto accelerator or using ethernet device). It also support inline ipsec processing by the supported ethernet device during transmission. These modes can be selected during the SA creation configuration. diff --git a/doc/guides/sample_app_ug/performance_thread.rst b/doc/guides/sample_app_ug/performance_thread.rst index fbd30a5e..96f0fc6f 100644 --- a/doc/guides/sample_app_ug/performance_thread.rst +++ b/doc/guides/sample_app_ug/performance_thread.rst @@ -500,8 +500,8 @@ An application may save and retrieve a single pointer to application data in the L-thread struct. For legacy and backward compatibility reasons two alternative methods are also -offered, the first is modelled directly on the pthread get/set specific APIs, -the second approach is modelled on the ``RTE_PER_LCORE`` macros, whereby +offered, the first is modeled directly on the pthread get/set specific APIs, +the second approach is modeled on the ``RTE_PER_LCORE`` macros, whereby ``PER_LTHREAD`` macros are introduced, in both cases the storage is local to the L-thread. diff --git a/doc/guides/sample_app_ug/qos_metering.rst b/doc/guides/sample_app_ug/qos_metering.rst index 2e8e0175..d75f7da5 100644 --- a/doc/guides/sample_app_ug/qos_metering.rst +++ b/doc/guides/sample_app_ug/qos_metering.rst @@ -151,5 +151,5 @@ In this particular case: * For the rest of the cases, the color is changed to red. .. note:: - * In color blind mode, first row GREEN colour is only valid. + * In color blind mode, first row GREEN color is only valid. * To drop the packet, policer_table action has to be set to DROP. diff --git a/doc/guides/sample_app_ug/test_pipeline.rst b/doc/guides/sample_app_ug/test_pipeline.rst index a9370c80..af9665b2 100644 --- a/doc/guides/sample_app_ug/test_pipeline.rst +++ b/doc/guides/sample_app_ug/test_pipeline.rst @@ -32,7 +32,7 @@ Compiling the Application ------------------------- To compile the sample application see :doc:`compiling` -The application is located in the ``$RTE_SDK/test/test-pipline`` directory. +The application is located in the ``$RTE_SDK/test/test-pipeline`` directory. Running the Application diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst index df4d6f9a..a71ada65 100644 --- a/doc/guides/sample_app_ug/vhost.rst +++ b/doc/guides/sample_app_ug/vhost.rst @@ -116,7 +116,7 @@ will create it. Put simply, it's the server to create the socket file. The vm2vm parameter sets the mode of packet switching between guests in the host. -- 0 disables vm2vm, impling that VM's packets will always go to the NIC port. +- 0 disables vm2vm, implying that VM's packets will always go to the NIC port. - 1 means a normal mac lookup packet routing. - 2 means hardware mode packet forwarding between guests, it allows packets go to the NIC port, hardware L2 switch will determine which guest the @@ -148,7 +148,7 @@ default value is 15. **--dequeue-zero-copy** Dequeue zero copy will be enabled when this option is given. it is worth to -note that if NIC is binded to driver with iommu enabled, dequeue zero copy +note that if NIC is bound to driver with iommu enabled, dequeue zero copy cannot work at VM2NIC mode (vm2vm=0) due to currently we don't setup iommu dma mapping for guest memory. diff --git a/doc/guides/sample_app_ug/vhost_scsi.rst b/doc/guides/sample_app_ug/vhost_scsi.rst index 7ab7d0d5..6b9bf62e 100644 --- a/doc/guides/sample_app_ug/vhost_scsi.rst +++ b/doc/guides/sample_app_ug/vhost_scsi.rst @@ -63,7 +63,7 @@ Vhost_scsi Common Issues * vhost_scsi can not start with block size 512 Bytes: - Currently DPDK vhost library was designed for NET device(althrough the APIs + Currently DPDK vhost library was designed for NET device(although the APIs are generic now), for 512 Bytes block device, Qemu BIOS(x86 BIOS Enhanced Disk Device) will enumerate all block device and do some IOs to those block devices with 512 Bytes sector size. DPDK vhost library can not process such diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst index 5be9f24d..a7b7a2c7 100644 --- a/doc/guides/sample_app_ug/vm_power_management.rst +++ b/doc/guides/sample_app_ug/vm_power_management.rst @@ -339,7 +339,7 @@ monitoring of branch ratio on cores doing busy polling via PMDs. When this parameter is used, the list of cores specified will monitor the ratio between branch hits and branch misses. A tightly polling PMD thread will have a - very low branch ratio, so the core frequency will be scaled down to the minimim + very low branch ratio, so the core frequency will be scaled down to the minimum allowed value. When packets are received, the code path will alter, causing the branch ratio to increase. When the ratio goes above the ratio threshold, the core frequency will be scaled up to the maximum allowed value. @@ -379,7 +379,7 @@ the file. The fifo is at /tmp/powermonitor/fifo -The jason string can be a policy or instruction, and takes the following +The JSON string can be a policy or instruction, and takes the following format: .. code-block:: javascript @@ -592,7 +592,7 @@ Profile destroy example: .. code-block:: javascript - {"profile": { + {"policy": { "name": "ubuntu", "command": "destroy", }} @@ -601,8 +601,9 @@ Power command example: .. code-block:: javascript - {"command": { + {"instruction": { "name": "ubuntu", + "command": "power", "unit": "SCALE_MAX", "resource_id": 10 }} @@ -729,7 +730,7 @@ policy down to the host application. These parameters are as follows: A comma-separated list of cores in the VM that the user wants the host application to monitor. The list of cores in any vm starts at zero, and these are mapped to the physical cores by the host application once the policy is passed down. - Valid syntax includes individial cores '2,3,4', or a range of cores '2-4', or a + Valid syntax includes individual cores '2,3,4', or a range of cores '2-4', or a combination of both '1,3,5-7' .. code-block:: console @@ -737,7 +738,7 @@ policy down to the host application. These parameters are as follows: --busy-hours {list of busy hours} A comma-separated list of hours within which to set the core frequency to maximum. - Valid syntax includes individial hours '2,3,4', or a range of hours '2-4', or a + Valid syntax includes individual hours '2,3,4', or a range of hours '2-4', or a combination of both '1,3,5-7'. Valid hours are 0 to 23. .. code-block:: console @@ -745,7 +746,7 @@ policy down to the host application. These parameters are as follows: --quiet-hours {list of quiet hours} A comma-separated list of hours within which to set the core frequency to minimum. - Valid syntax includes individial hours '2,3,4', or a range of hours '2-4', or a + Valid syntax includes individual hours '2,3,4', or a range of hours '2-4', or a combination of both '1,3,5-7'. Valid hours are 0 to 23. .. code-block:: console diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst index 4495ed03..89df0316 100644 --- a/doc/guides/testpmd_app_ug/run_app.rst +++ b/doc/guides/testpmd_app_ug/run_app.rst @@ -22,7 +22,7 @@ They must be separated from the EAL options, shown in the previous section, with sudo ./testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2 -The commandline options are: +The command line options are: * ``-i, --interactive`` @@ -365,7 +365,7 @@ The commandline options are: * ``--hot-plug`` - Enable device event monitor machenism for hotplug. + Enable device event monitor mechanism for hotplug. * ``--vxlan-gpe-port=N`` @@ -405,21 +405,21 @@ The commandline options are: * ``--noisy-lkup-memory=N`` - Set the size of the noisy neighbour simulation memory buffer in MB to N. + Set the size of the noisy neighbor simulation memory buffer in MB to N. Only available with the noisy forwarding mode. The default value is 0. * ``--noisy-lkup-num-reads=N`` - Set the number of reads to be done in noisy neighbour simulation memory buffer to N. + Set the number of reads to be done in noisy neighbor simulation memory buffer to N. Only available with the noisy forwarding mode. The default value is 0. * ``--noisy-lkup-num-writes=N`` - Set the number of writes to be done in noisy neighbour simulation memory buffer to N. + Set the number of writes to be done in noisy neighbor simulation memory buffer to N. Only available with the noisy forwarding mode. The default value is 0. * ``--noisy-lkup-num-reads-writes=N`` - Set the number of r/w accesses to be done in noisy neighbour simulation memory buffer to N. + Set the number of r/w accesses to be done in noisy neighbor simulation memory buffer to N. Only available with the noisy forwarding mode. The default value is 0. diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index 854af2d5..81f10727 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -302,7 +302,7 @@ The available information categories are: This is the default mode. * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them. - Default application behaviour is to set source Ethernet address to that of the transmitting interface, and destination + Default application behavior is to set source Ethernet address to that of the transmitting interface, and destination address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address. @@ -325,7 +325,7 @@ The available information categories are: * ``softnic``: Demonstrates the softnic forwarding operation. In this mode, packet forwarding is similar to I/O mode except for the fact that packets are loopback to the softnic ports only. Therefore, portmask parameter should be set to softnic port only. The various software based custom NIC pipelines specified through the softnic firmware (DPDK packet framework script) can be tested in this mode. Furthermore, it allows to build 5-level hierarchical QoS scheduler as a default option that can be enabled through CLI once testpmd application is initialised. The user can modify the default scheduler hierarchy or can specify the new QoS Scheduler hierarchy through CLI. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y``. -* ``noisy``: Noisy neighbour simulation. +* ``noisy``: Noisy neighbor simulation. Simulate more realistic behavior of a guest machine engaged in receiving and sending packets performing Virtual Network Function (VNF). @@ -430,6 +430,56 @@ Show Tx metadata value set for a specific port:: testpmd> show port (port_id) tx_metadata +dump physmem +~~~~~~~~~~~~ + +Dumps all physical memory segment layouts:: + + testpmd> dump_physmem + +dump memzone +~~~~~~~~~~~~ + +Dumps the layout of all memory zones:: + + testpmd> dump_memzone + + +dump struct size +~~~~~~~~~~~~~~~~ + +Dumps the size of all memory structures:: + + testpmd> dump_struct_sizes + +dump ring +~~~~~~~~~ + +Dumps the status of all or specific element in DPDK rings:: + + testpmd> dump_ring [ring_name] + +dump mempool +~~~~~~~~~~~~ + +Dumps the statistics of all or specific memory pool:: + + testpmd> dump_mempool [mempool_name] + +dump devargs +~~~~~~~~~~~~ + +Dumps the user device list:: + + testpmd> dump_devargs + +dump log types +~~~~~~~~~~~~~~ + +Dumps the log level for all the dpdk modules:: + + testpmd> dump_log_types + Configuration Functions ----------------------- @@ -476,9 +526,11 @@ Where: * ``level`` is the log level. For example, to change the global log level:: + testpmd> set log global (level) Regexes can also be used for type. To change log level of user1, user2 and user3:: + testpmd> set log user[1-3] (level) set nbport @@ -930,11 +982,12 @@ Flush all queue region related configuration on a port:: where: -* "on"is just an enable function which server for other configuration, +* ``on``: is just an enable function which server for other configuration, it is for all configuration about queue region from up layer, - at first will only keep in DPDK softwarestored in driver, + at first will only keep in DPDK software stored in driver, only after "flush on", it commit all configuration to HW. - "off" is just clean all configuration about queue region just now, + +* ``off``: is just clean all configuration about queue region just now, and restore all to DPDK i40e driver default config when start up. Show all queue region related configuration info on a port:: @@ -1002,6 +1055,20 @@ Display the status of TCP Segmentation Offload:: testpmd> tso show (port_id) +tunnel tso set +~~~~~~~~~~~~~~ + +Set tso segment size of tunneled packets for a port in csum engine:: + + testpmd> tunnel_tso set (tso_segsz) (port_id) + +tunnel tso show +~~~~~~~~~~~~~~~ + +Display the status of tunneled TCP Segmentation Offload for a port:: + + testpmd> tunnel_tso show (port_id) + set port - gro ~~~~~~~~~~~~~~ @@ -1123,6 +1190,22 @@ Remove a MAC address from a port:: testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX) +mcast_addr add +~~~~~~~~~~~~~~ + +To add the multicast MAC address to/from the set of multicast addresses +filtered by port:: + + testpmd> mcast_addr add (port_id) (mcast_addr) + +mcast_addr remove +~~~~~~~~~~~~~~~~~ + +To remove the multicast MAC address to/from the set of multicast addresses +filtered by port:: + + testpmd> mcast_addr remove (port_id) (mcast_addr) + mac_addr add (for VF) ~~~~~~~~~~~~~~~~~~~~~ @@ -1583,7 +1666,7 @@ Configure the outer layer to encapsulate a packet inside a VXLAN tunnel:: udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \ eth-src (eth-src) eth-dst (eth-dst) -Those command will set an internal configuration inside testpmd, any following +These commands will set an internal configuration inside testpmd, any following flow rule using the action vxlan_encap will use the last configuration set. To have a different encapsulation header, one of those commands must be called before the flow rule creation. @@ -1598,7 +1681,7 @@ Configure the outer layer to encapsulate a packet inside a NVGRE tunnel:: set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \ ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst) -Those command will set an internal configuration inside testpmd, any following +These commands will set an internal configuration inside testpmd, any following flow rule using the action nvgre_encap will use the last configuration set. To have a different encapsulation header, one of those commands must be called before the flow rule creation. @@ -1641,7 +1724,7 @@ Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel:: ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \ eth-src (eth-src) eth-dst (eth-dst) -Those command will set an internal configuration inside testpmd, any following +These commands will set an internal configuration inside testpmd, any following flow rule using the action mplsogre_encap will use the last configuration set. To have a different encapsulation header, one of those commands must be called before the flow rule creation. @@ -1654,7 +1737,7 @@ Configure the outer layer to decapsulate MPLSoGRE packet:: set mplsogre_decap ip-version (ipv4|ipv6) set mplsogre_decap-with-vlan ip-version (ipv4|ipv6) -Those command will set an internal configuration inside testpmd, any following +These commands will set an internal configuration inside testpmd, any following flow rule using the action mplsogre_decap will use the last configuration set. To have a different decapsulation header, one of those commands must be called before the flow rule creation. @@ -1671,7 +1754,7 @@ Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel:: udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \ vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst) -Those command will set an internal configuration inside testpmd, any following +These commands will set an internal configuration inside testpmd, any following flow rule using the action mplsoudp_encap will use the last configuration set. To have a different encapsulation header, one of those commands must be called before the flow rule creation. @@ -1684,7 +1767,7 @@ Configure the outer layer to decapsulate MPLSoUDP packet:: set mplsoudp_decap ip-version (ipv4|ipv6) set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6) -Those command will set an internal configuration inside testpmd, any following +These commands will set an internal configuration inside testpmd, any following flow rule using the action mplsoudp_decap will use the last configuration set. To have a different decapsulation header, one of those commands must be called before the flow rule creation. @@ -2113,11 +2196,13 @@ port config input set ~~~~~~~~~~~~~~~~~~~~~ Config RSS/FDIR/FDIR flexible payload input set for some pctype:: + testpmd> port config (port_id) pctype (pctype_id) \ (hash_inset|fdir_inset|fdir_flx_inset) \ (get|set|clear) field (field_idx) Clear RSS/FDIR/FDIR flexible payload input set for some pctype:: + testpmd> port config (port_id) pctype (pctype_id) \ (hash_inset|fdir_inset|fdir_flx_inset) clear all @@ -2130,6 +2215,7 @@ port config udp_tunnel_port ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols:: + testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve (udp_port) port config tx_metadata @@ -2140,6 +2226,26 @@ testpmd will add this value to any Tx packet sent from this port:: testpmd> port config (port_id) tx_metadata (value) +port config mtu +~~~~~~~~~~~~~~~ + +To configure MTU(Maximum Transmission Unit) on devices using testpmd:: + + testpmd> port config mtu (port_id) (value) + +port config rss hash key +~~~~~~~~~~~~~~~~~~~~~~~~ + +To configure the RSS hash key used to compute the RSS +hash of input [IP] packets received on port:: + + testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\ + ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\ + ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\ + ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\ + ipv6-udp-ex <string of hex digits \ + (variable length, NIC dependent)>) + Link Bonding Functions ---------------------- @@ -2246,7 +2352,7 @@ set bonding lacp dedicated_queue ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic -when in mode 4 (link-aggregration-802.3ad):: +when in mode 4 (link-aggregation-802.3ad):: testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable) @@ -2254,7 +2360,7 @@ when in mode 4 (link-aggregration-802.3ad):: set bonding agg_mode ~~~~~~~~~~~~~~~~~~~~ -Enable one of the specific aggregators mode when in mode 4 (link-aggregration-802.3ad):: +Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad):: testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable) @@ -2648,8 +2754,8 @@ where: * ``shared_shaper_id``: Shared shaper ID to be deleted. -Set port traffic management hiearchy node private shaper -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Set port traffic management hierarchy node private shaper +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ set the port traffic management hierarchy node private shaper:: @@ -2700,7 +2806,7 @@ Delete the WRED profile:: Add port traffic management hierarchy nonleaf node ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add nonleaf node to port traffic management hiearchy:: +Add nonleaf node to port traffic management hierarchy:: testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \ (priority) (weight) (level_id) (shaper_profile_id) \ @@ -2715,7 +2821,7 @@ where: * ``weight``: Node weight (lowest weight is one). The node weight is relative to the weight sum of all siblings that have the same priority. It is used by the WFQ algorithm running on the parent node for scheduling this node. -* ``level_id``: Hiearchy level of the node. +* ``level_id``: Hierarchy level of the node. * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by the node. * ``n_sp_priorities``: Number of strict priorities. @@ -2726,7 +2832,7 @@ where: Add port traffic management hierarchy leaf node ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add leaf node to port traffic management hiearchy:: +Add leaf node to port traffic management hierarchy:: testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \ (priority) (weight) (level_id) (shaper_profile_id) \ @@ -2741,7 +2847,7 @@ where: * ``weight``: Node weight (lowest weight is one). The node weight is relative to the weight sum of all siblings that have the same priority. It is used by the WFQ algorithm running on the parent node for scheduling this node. -* ``level_id``: Hiearchy level of the node. +* ``level_id``: Hierarchy level of the node. * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by the node. * ``cman_mode``: Congestion management mode to be enabled for this node. @@ -2753,7 +2859,7 @@ where: Delete port traffic management hierarchy node ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete node from port traffic management hiearchy:: +Delete node from port traffic management hierarchy:: testpmd> del port tm node (port_id) (node_id) @@ -3705,7 +3811,7 @@ This section lists supported pattern items and their attributes, if any. - ``sla {MAC-48}``: source Ethernet LLA. -- ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery target Ethernet +- ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet link-layer address option. - ``tla {MAC-48}``: target Ethernet LLA. @@ -3946,7 +4052,7 @@ This section lists supported actions and their attributes, if any. - ``dec_ttl``: Performs a decrease TTL value action -- ``set_ttl``: Set TTL value with specificed value +- ``set_ttl``: Set TTL value with specified value - ``ttl_value {unsigned}``: The new TTL value to be set - ``set_mac_src``: set source MAC address @@ -4467,7 +4573,7 @@ The following sections show functions to load/unload eBPF based filters. bpf-load ~~~~~~~~ -Load an eBPF program as a callback for partciular RX/TX queue:: +Load an eBPF program as a callback for particular RX/TX queue:: testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename) @@ -4490,13 +4596,13 @@ For example: cd test/bpf clang -O2 -target bpf -c t1.c -Then to load (and JIT compile) t1.o at RX queue 0, port 1:: +Then to load (and JIT compile) t1.o at RX queue 0, port 1: .. code-block:: console testpmd> bpf-load rx 1 0 J ./dpdk.org/test/bpf/t1.o -To load (not JITed) t1.o at TX queue 0, port 0:: +To load (not JITed) t1.o at TX queue 0, port 0: .. code-block:: console @@ -4505,7 +4611,7 @@ To load (not JITed) t1.o at TX queue 0, port 0:: bpf-unload ~~~~~~~~~~ -Unload previously loaded eBPF program for partciular RX/TX queue:: +Unload previously loaded eBPF program for particular RX/TX queue:: testpmd> bpf-unload rx|tx (portid) (queueid) diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst index c366af4e..2fc65441 100644 --- a/doc/guides/tools/cryptoperf.rst +++ b/doc/guides/tools/cryptoperf.rst @@ -59,7 +59,7 @@ To set on the linearization options add below definition to the **Step 3: Build the application** Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the -``dpdk-test-crypto-perf`` applcation. +``dpdk-test-crypto-perf`` application. Initially, the user must select a DPDK target to choose the correct target type and compiler options to use when building the libraries. @@ -80,7 +80,7 @@ EAL Options ~~~~~~~~~~~ The following are the EAL command-line options that can be used in conjunction -with the ``dpdk-test-crypto-perf`` applcation. +with the ``dpdk-test-crypto-perf`` application. See the DPDK Getting Started Guides for more information on these options. * ``-c <COREMASK>`` or ``-l <CORELIST>`` @@ -96,10 +96,10 @@ See the DPDK Getting Started Guides for more information on these options. Add a virtual device. -Appication Options -~~~~~~~~~~~~~~~~~~ +Application Options +~~~~~~~~~~~~~~~~~~~ -The following are the appication command-line options: +The following are the application command-line options: * ``--ptest type`` @@ -338,13 +338,13 @@ Test Vector File The test vector file is a text file contain information about test vectors. The file is made of the sections. The first section doesn't have header. It contain global information used in each test variant vectors - -typically information about plaintext, ciphertext, cipher key, aut key, +typically information about plaintext, ciphertext, cipher key, auth key, initial vector. All other sections begin header. The sections contain particular information typically digest. **Format of the file:** -Each line beginig with sign '#' contain comment and it is ignored by parser:: +Each line beginning with sign '#' contain comment and it is ignored by parser:: # <comment> @@ -352,16 +352,16 @@ Header line is just name in square bracket:: [<section name>] -Data line contain information tocken then sign '=' and +Data line contain information token then sign '=' and a string of bytes in C byte array format:: - <tocken> = <C byte array> + <token> = <C byte array> -**Tockens list:** +**Tokens list:** * ``plaintext`` - Original plaintext to be crypted. + Original plaintext to be encrypted. * ``ciphertext`` diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst index d5b5ed6a..e9a0b79d 100644 --- a/doc/guides/tools/proc_info.rst +++ b/doc/guides/tools/proc_info.rst @@ -48,7 +48,7 @@ Limitations * When running ``dpdk-procinfo`` with shared library mode, it is required to pass the same NIC PMD libraries as used for the primary application. Any - mismatch in PMD library arguments can lead to undefined behaviour and results + mismatch in PMD library arguments can lead to undefined behavior and results affecting primary application too. * Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP. diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst index 5caa9023..a8cb6fbb 100644 --- a/doc/guides/tools/testbbdev.rst +++ b/doc/guides/tools/testbbdev.rst @@ -139,7 +139,7 @@ There are 6 main test cases that can be executed using testbbdev tool: * Latency measurement [-c latency] - Measures the time consumed from the first enqueue until the first appearance of a dequeued result - - This measurment represents the full latency of a bbdev operation + - This measurement represents the full latency of a bbdev operation (encode or decode) to execute * Poll-mode Throughput measurement [-c throughput] @@ -307,7 +307,7 @@ baseband_null device does not have to be defined explicitly as it is created by Test Vector files -================= +----------------- Test Vector files contain the data which is used to set turbo decoder/encoder parameters and buffers for validation purpose. New test vector files should be @@ -316,7 +316,7 @@ the syntax of the test vector files is in the following section. Basic principles for test vector files --------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Line started with ``#`` is treated as a comment and is ignored. If variable is a chain of values, values should be separated by a comma. If @@ -351,7 +351,7 @@ documented in *rte_bbdev_op.h* Turbo decoder test vectors template ------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For turbo decoder it has to be always set to ``RTE_BBDEV_OP_TURBO_DEC`` @@ -528,7 +528,7 @@ Following statuses can be used: Turbo encoder test vectors template ------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For turbo encoder it has to be always set to ``RTE_BBDEV_OP_TURBO_ENC`` |