Re: [dpdk-dev] [PATCH v4 13/13] doc: add pipeline test in eventdev test guide

[Jerin Jacob <jerin.jacob@caviumnetworks.com>]

-----Original Message-----
> Date: Fri, 12 Jan 2018 22:14:16 +0530
> From: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> To: jerin.jacob@caviumnetworks.com, santosh.shukla@caviumnetworks.com,
>  harry.van.haaren@intel.com, gage.eads@intel.com, hemant.agrawal@nxp.com,
>  nipun.gupta@nxp.com, liang.j.ma@intel.com
> Cc: dev@dpdk.org, Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Subject: [dpdk-dev] [PATCH v4 13/13] doc: add pipeline test in eventdev
>  test guide
> X-Mailer: git-send-email 2.14.1
> 
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> ---
>  .../tools/img/eventdev_pipeline_atq_test.svg       | 3340 ++++++++++++++++++
>  .../tools/img/eventdev_pipeline_queue_test.svg     | 3541 ++++++++++++++++++++
>  doc/guides/tools/testeventdev.rst                  |  181 +
>  3 files changed, 7062 insertions(+)
>  create mode 100644 doc/guides/tools/img/eventdev_pipeline_atq_test.svg
>  create mode 100644 doc/guides/tools/img/eventdev_pipeline_queue_test.svg

Some suggestions in the diagram,
1) In total_queues = equation, Please add some mean full info on the last "number of producers"
2) Have separate diagram for "Tx generic" and "Tx lockfree" case to
understand the follow easily.
3) IMO, The backward arrow towards queue from port(The red one) is may
not depicting the actual flow from the application perspective.
4) Same comments apply for PIPELINE_ATQ diagram


>     sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
>                  --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
> +
> +
> +PIPELINE_QUEUE Test
> +~~~~~~~~~~~~~~~~~~~
> +
> +This is a pipeline test case that aims at testing the following:
> +
> +#. Measure the end-to-end performance of an event dev with a ethernet dev.
> +#. Maintain packet ordering from Rx to Tx.
> +
> +.. _table_eventdev_pipeline_queue_test:
> +
> +.. table:: Pipeline queue test eventdev configuration.
> +
> +   +---+--------------+----------------+-----------------------------------------+
> +   | # | Items        | Value          | Comments                                |
> +   |   |              |                |                                         |
> +   +===+==============+================+=========================================+
> +   | 1 | nb_queues    | (nb_producers  | Queues will be configured based on the  |
> +   |   |              | * nb_stages) + | user requested sched type list(--stlist)|
> +   |   |              | x              | Here value of x depends on ethernet dev |
> +   |   |              |                | Tx capability (MT_LOCKFREE).            |

I think, it will be good to say the value of _x_ for MT_LOCKFREE vs non MT_LOCKFREE case

Another than above comments, It looks good to me.

> +   +---+--------------+----------------+-----------------------------------------+
> +   | 2 | nb_producers | >= 1           | Producers will be configured based on   |
> +   |   |              |                | the number of detected ethernet devices.|
> +   |   |              |                | Each ethdev will be configured as an Rx |
> +   |   |              |                | adapter.                                |
> +   +---+--------------+----------------+-----------------------------------------+
> +   | 3 | nb_workers   | >= 1           | Selected through --wlcores command line |
> +   |   |              |                | argument                                |
> +   +---+--------------+----------------+-----------------------------------------+
> +   | 4 | nb_ports     | nb_workers +   | Workers use port 0 to port n.           |
> +   |   |              | nb_producers   | Producers use port n+1 to port n+m,     |
> +   |   |              |                | depending on the Rx adapter capability. |
> +   +---+--------------+----------------+-----------------------------------------+
> +
> +.. _figure_eventdev_pipeline_queue_test:
> +
> +.. figure:: img/eventdev_pipeline_queue_test.*