[v3,1/2] doc: add cycles per packet in testpmd user guide
diff mbox series

Message ID 20200520032023.2649-1-dharmik.thakkar@arm.com
State Accepted, archived
Delegated to: Ferruh Yigit
Headers show
Series
  • [v3,1/2] doc: add cycles per packet in testpmd user guide
Related show

Checks

Context Check Description
ci/Intel-compilation fail Compilation issues
ci/checkpatch success coding style OK

Commit Message

Dharmik Thakkar May 20, 2020, 3:20 a.m. UTC
Update documentation for 'show fwd' testpmd runtime function to show
CPU cycles/packet example.

Signed-off-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Phil Yang <phil.yang@arm.com>
---
v3:
 - Keep existing stats and add a note providing CPU cycles/packet
   example (Ferruh)
 - Remove platform specific information (Ferruh)
 - Remove performance numbers from CPU cycles/packet example (Ferruh)
 - Fix typo in CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES (Ferruh)

v2:
 - Use shorter lines, up to 100.
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Ferruh Yigit May 20, 2020, 2:49 p.m. UTC | #1
On 5/20/2020 4:20 AM, Dharmik Thakkar wrote:
> Update documentation for 'show fwd' testpmd runtime function to show
> CPU cycles/packet example.
> 
> Signed-off-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
> Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> Reviewed-by: Phil Yang <phil.yang@arm.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Ferruh Yigit May 21, 2020, 5:41 p.m. UTC | #2
On 5/20/2020 3:49 PM, Ferruh Yigit wrote:
> On 5/20/2020 4:20 AM, Dharmik Thakkar wrote:
>> Update documentation for 'show fwd' testpmd runtime function to show
>> CPU cycles/packet example.
>>
>> Signed-off-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
>> Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
>> Reviewed-by: Phil Yang <phil.yang@arm.com>
> 
> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 

Applied to dpdk-next-net/master, thanks.

(note that not all patches in the patchset applied, only 1/2 applied)

Patch
diff mbox series

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 3ded179ee72a..a808b6a308f2 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -372,6 +372,12 @@  Example for the io forwarding engine, with some packet drops on the tx side::
      TX-packets: 548595568      TX-dropped: 128           TX-total: 548595696
      ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
+.. note::
+
+   Enabling CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES appends "CPU cycles/packet" stats, like:
+
+   CPU cycles/packet=xx.dd (total cycles=xxxx / total RX packets=xxxx) at xxx MHz clock
+
 clear fwd
 ~~~~~~~~~