[v4,2/2] testpmd: update testpmd doc to include noisy forwarding mode
Checks
Commit Message
From: Jens Freimann <jfreimann@redhat.com>
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(-)
Comments
Hi Maxime,
> -----Original Message-----
> From: Maxime Coquelin [mailto:maxime.coquelin@redhat.com]
> Sent: Saturday, June 23, 2018 9:09 AM
> To: Iremonger, Bernard <bernard.iremonger@intel.com>; dev@dpdk.org
> Cc: ailan@redhat.com; jan.scheurich@ericsson.com; vkaplans@redhat.com;
> Richardson, Bruce <bruce.richardson@intel.com>; thomas@monjalon.net;
> Ananyev, Konstantin <konstantin.ananyev@intel.com>; Yigit, Ferruh
> <ferruh.yigit@intel.com>; Jens Freimann <jfreimann@redhat.com>
> Subject: [PATCH v4 2/2] testpmd: update testpmd doc to include noisy
> forwarding mode
>
The patch title should app/testpmd instead of testpmd.
> From: Jens Freimann <jfreimann@redhat.com>
>
> Signed-off-by: Jens Freimann <jfreimann@redhat.com>
> ---
<snip>
This patch could be squashed into the first patch.
Regards,
Bernard.
@@ -340,6 +340,7 @@ The commandline options are:
icmpecho
ieee1588
tm
+ noisy
* ``--rss-ip``
@@ -498,3 +499,29 @@ The commandline options are:
* ``--no-mlockall``
Disable locking all memory.
+
+* ``--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