[dpdk-dev,2/2] testpmd: update testpmd documentation to include noisy forwarding mode
Checks
Commit Message
Signed-off-by: Jens Freimann <jfreimann@redhat.com>
---
doc/guides/testpmd_app_ug/run_app.rst | 27 +++++++++++++++++++++++++++
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 7 +++++--
2 files changed, 32 insertions(+), 2 deletions(-)
@@ -340,6 +340,7 @@ The commandline options are:
icmpecho
ieee1588
tm
+ noisy
* ``--rss-ip``
@@ -479,3 +480,29 @@ The commandline options are:
Set the hexadecimal bitmask of TX queue offloads.
The default value is 0.
+
+* ``--noisy-buffersize-before-sending=N``
+
+ Set the number of maximum elements of the FIFO queue to be created
+ for buffering packets. Only available with the noisy forwarding mode.
+ The default value is 0.
+
+* ``--noisy-flush-timeout=N``
+
+ Set the size of the FIFO queue to be created for buffering packets.
+ Only available with the noisy forwarding mode. The default value is 0.
+
+* ``--noisy-nb-rnd-read=N``
+
+ Set the number of reads to be done in noisy neighbour simulation memory buffer.
+ Only available with the noisy forwarding mode. The default value is 0.
+
+* ``--noisy-nb-rnd-write=N``
+
+ Set the number of writes to be done in noisy neighbour simulation memory buffer.
+ Only available with the noisy forwarding mode. The default value is 0.
+
+* ``--noisy-nb-rnd-write=N``
+
+ Set the number of r/w access to be done in noisy neighbour simulation memory buffer.
+ Only available with the noisy forwarding mode. The default value is 0.
@@ -289,7 +289,7 @@ set fwd
Set the packet forwarding mode::
testpmd> set fwd (io|mac|macswap|flowgen| \
- rxonly|txonly|csum|icmpecho) (""|retry)
+ rxonly|txonly|csum|icmpecho|noisy) (""|retry)
``retry`` can be specified for forwarding engines except ``rx_only``.
@@ -327,8 +327,11 @@ The available information categories are:
also modify the default hierarchy or specify the new hierarchy through CLI for
implementing QoS scheduler. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y`` ``CONFIG_RTE_LIBRTE_SCHED=y``.
-Example::
+* ``noisy``: Noisy neighbour simulation.
+ Simulate more realistic behavior of a guest machine engaged in receiving
+ and sending packets performing Virtual Network Function (VNF).
+Example::
testpmd> set fwd rxonly
Set rxonly packet forwarding mode