diff mbox

[dpdk-dev,v2,2/2] testpmd: update testpmd documentation to include noisy forwarding mode

Message ID 20180413113716.27968-3-jfreimann@redhat.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation fail apply patch file failure

Commit Message

Jens Freimann April 13, 2018, 11:37 a.m. UTC 
  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

Ferruh Yigit April 13, 2018, 1:19 p.m. UTC | #1 
On 4/13/2018 12:37 PM, Jens Freimann wrote:
> 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(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
> index 1fd53958a..0b7046bb0 100644
> --- a/doc/guides/testpmd_app_ug/run_app.rst
> +++ b/doc/guides/testpmd_app_ug/run_app.rst
> @@ -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.
> +
> +*   ``--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.
> +
> +*   ``--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.

Some of the there parameter names are so generic when you think them in the
scope of the whole testpmd it can be confusing and hard to understand what they
are for.

What do you think adding a prefix to all noisy neighbor related commands?

> +
> +*   ``--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.
> +
> +*   ``--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.
> +
> +*   ``--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.

<...>
Jens Freimann April 16, 2018, 8:17 p.m. UTC | #2 
On Fri, Apr 13, 2018 at 02:19:28PM +0100, Ferruh Yigit wrote:
>On 4/13/2018 12:37 PM, Jens Freimann wrote:
>> 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(-)
>>
>> diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
>> index 1fd53958a..0b7046bb0 100644
>> --- a/doc/guides/testpmd_app_ug/run_app.rst
>> +++ b/doc/guides/testpmd_app_ug/run_app.rst
>> @@ -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.
>> +
>> +*   ``--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.
>> +
>> +*   ``--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.
>
>Some of the there parameter names are so generic when you think them in the
>scope of the whole testpmd it can be confusing and hard to understand what they
>are for.
>
>What do you think adding a prefix to all noisy neighbor related commands?

Yes, I think it is  a good point. Thanks for the review!

regards,
Jens 

>
>> +
>> +*   ``--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.
>> +
>> +*   ``--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.
>> +
>> +*   ``--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.
>
><...>
diff mbox

Patch

diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index 1fd53958a..0b7046bb0 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -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.
+
+*   ``--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.
+
+*   ``--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.
+
+*   ``--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.
+
+*   ``--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.
+
+*   ``--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.
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index a766ac795..0c1f49ae3 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -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