[dpdk-dev,v3,4/4] doc: update test eventdev documentation
Checks
Commit Message
Update documentation to include new options added for using event timer
adapter as a producer.
Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
---
doc/guides/tools/testeventdev.rst | 60 +++++++++++++++++++++++++++++++++++++++
1 file changed, 60 insertions(+)
Comments
-----Original Message-----
> Date: Thu, 5 Apr 2018 17:23:29 +0530
> From: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> To: jerin.jacob@caviumnetworks.com, santosh.shukla@caviumnetworks.com,
> erik.g.carrillo@intel.com
> Cc: dev@dpdk.org, Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Subject: [dpdk-dev] [PATCH v3 4/4] doc: update test eventdev documentation
> X-Mailer: git-send-email 2.16.3
>
> Update documentation to include new options added for using event timer
> adapter as a producer.
>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> ---
> doc/guides/tools/testeventdev.rst | 60 +++++++++++++++++++++++++++++++++++++++
> 1 file changed, 60 insertions(+)
>
> diff --git a/doc/guides/tools/testeventdev.rst b/doc/guides/tools/testeventdev.rst
> index 77480ffe9..eb3bc3ae5 100644
> --- a/doc/guides/tools/testeventdev.rst
> +++ b/doc/guides/tools/testeventdev.rst
> @@ -123,6 +123,36 @@ The following are the application command-line options:
>
> Use ethernet device as producer.
>
> +* ``--prod_type_timerdev``
> +
> + Use event timer adapter as producer.
> +
> + * ``--prod_type_timerdev_burst``
> +
> + Use burst mode event timer adapter as producer.
> +
> + * ``--bkt_tck_nsec``
> +
> + Used to dictate number of nano seconds between bucket traversal of the
> + event timer adapter. Refer `rte_event_timer_adapter_conf`.
IMO, instead of "bkt_tck_nsec", it makes sense to call it as
"resolution" or "timer_tick_ns"(it is the term used in
rte_event_timer_adapter_conf spec). If you agree, please change the code and
documentation accordingly.
> +
> + * ``--max_tmo_nsec``
> +
> + Used to configure event timer adapter max arm timeout in nano seconds.
> +
> + * ``--nb_bkt_tcks``
> +
> + Dictate the number of bucket ticks after which the event timer expires.
IMO, instead of "nb_bkt_tcks", it makes sense to call it as
"expiry_ns" or something similar. Please express all configuration
option in nano seconds so that user should not know the internals of
implementation.
> +
> + * ``--nb_timers``
> +
> + Number of event timers each producer core will generate.
> +
> + * ``--nb_timer_adptrs``
> +
> + Number of event timer adapters to be used. Each adapter is used in
> + round robin manner by the producer cores.
> +
> Eventdev Tests
> --------------
>
> @@ -347,6 +377,13 @@ Supported application command line options are following::
> --fwd_latency
> --queue_priority
> --prod_type_ethdev
> + --prod_type_timerdev_burst
> + --prod_type_timerdev
> + --bkt_tck_nsec
see above
> + --max_tmo_nsec
> + --nb_bkt_tcks
see above
> + --nb_timers
> + --nb_timer_adptrs
>
> Example
> ^^^^^^^
> @@ -365,6 +402,14 @@ Example command to run perf queue test with ethernet ports:
> sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
> --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --prod_type_ethdev
>
> +Example command to run perf queue test with event timer adapter:
> +
> +.. code-block:: console
> +
> + sudo build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
> + --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
> + --prod_type_timerdev --fwd_latency
> +
> PERF_ATQ Test
> ~~~~~~~~~~~~~~~
>
> @@ -431,6 +476,13 @@ Supported application command line options are following::
> --worker_deq_depth
> --fwd_latency
> --prod_type_ethdev
> + --prod_type_timerdev_burst
> + --prod_type_timerdev
> + --bkt_tck_nsec
see above
> + --max_tmo_nsec
> + --nb_bkt_tcks
see above.
> + --nb_timers
> + --nb_timer_adptrs
With above name changes in documentation and code:
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
@@ -123,6 +123,36 @@ The following are the application command-line options:
Use ethernet device as producer.
+* ``--prod_type_timerdev``
+
+ Use event timer adapter as producer.
+
+ * ``--prod_type_timerdev_burst``
+
+ Use burst mode event timer adapter as producer.
+
+ * ``--bkt_tck_nsec``
+
+ Used to dictate number of nano seconds between bucket traversal of the
+ event timer adapter. Refer `rte_event_timer_adapter_conf`.
+
+ * ``--max_tmo_nsec``
+
+ Used to configure event timer adapter max arm timeout in nano seconds.
+
+ * ``--nb_bkt_tcks``
+
+ Dictate the number of bucket ticks after which the event timer expires.
+
+ * ``--nb_timers``
+
+ Number of event timers each producer core will generate.
+
+ * ``--nb_timer_adptrs``
+
+ Number of event timer adapters to be used. Each adapter is used in
+ round robin manner by the producer cores.
+
Eventdev Tests
--------------
@@ -347,6 +377,13 @@ Supported application command line options are following::
--fwd_latency
--queue_priority
--prod_type_ethdev
+ --prod_type_timerdev_burst
+ --prod_type_timerdev
+ --bkt_tck_nsec
+ --max_tmo_nsec
+ --nb_bkt_tcks
+ --nb_timers
+ --nb_timer_adptrs
Example
^^^^^^^
@@ -365,6 +402,14 @@ Example command to run perf queue test with ethernet ports:
sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
--test=perf_queue --plcores=2 --wlcore=3 --stlist=p --prod_type_ethdev
+Example command to run perf queue test with event timer adapter:
+
+.. code-block:: console
+
+ sudo build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
+ --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
+ --prod_type_timerdev --fwd_latency
+
PERF_ATQ Test
~~~~~~~~~~~~~~~
@@ -431,6 +476,13 @@ Supported application command line options are following::
--worker_deq_depth
--fwd_latency
--prod_type_ethdev
+ --prod_type_timerdev_burst
+ --prod_type_timerdev
+ --bkt_tck_nsec
+ --max_tmo_nsec
+ --nb_bkt_tcks
+ --nb_timers
+ --nb_timer_adptrs
Example
^^^^^^^
@@ -442,6 +494,14 @@ Example command to run perf ``all types queue`` test:
sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
--test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
+Example command to run perf ``all types queue`` test with event timer adapter:
+
+.. code-block:: console
+
+ sudo build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
+ --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \
+ --stlist=a --prod_type_timerdev --fwd_latency
+
PIPELINE_QUEUE Test
~~~~~~~~~~~~~~~~~~~