Skip to contentSkip to conversation

doc: add profile with vtune section to prog guide

PATCH In review [email protected] 3 participants 3 messages Dec 2, 2020 – Jan 13, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: add profile with vtune section to prog guide

From: Eugeny Parshutin <[email protected]>

Return back 'profiling with vtune' section to profiling programmers guide with updated instruction on how to enable vtune profiling with meson configuration option.

---
 doc/guides/prog_guide/profile_app.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
doc/guides/prog_guide/profile_app.rst +14 -0
index 709368198..c87ca5d9d 100644
@@ -33,6 +33,20 @@ Refer to the
 for details about application profiling.
 
 
+Profiling with VTune
+~~~~~~~~~~~~~~~~~~~~
+
+To allow VTune attaching to the DPDK application, reconfigure a DPDK build
+folder by passing ``-Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1`` meson option
+and recompile the DPDK:
+
+.. code-block:: console
+
+    meson build
+    meson configure build -Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1
+    ninja -C build
+
+
 Profiling on ARM64
 ------------------
 
Signature · 1 line
2.25.1
Acked-by on v1 1/1
#1 lore raw
Quoted 22 lines · On Wed, Dec 02, 2020 at 08:48:06PM +0300, [email protected]…

From: Eugeny Parshutin <[email protected]>

Return back 'profiling with vtune' section to profiling programmers guide with updated instruction on how to enable vtune profiling with meson configuration option.

---
 doc/guides/prog_guide/profile_app.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
doc/guides/prog_guide/profile_app.rst +3 -0
index 709368198..c87ca5d9d 100644
@@ -33,6 +33,20 @@ Refer to the
 for details about application profiling.
 
 
+Profiling with VTune
+~~~~~~~~~~~~~~~~~~~~
+

doc/guides/prog_guide/profile_app.rst Refer to the · line 48

Quoted 10 lines
doc/guides/prog_guide/profile_app.rst +10 -0
+To allow VTune attaching to the DPDK application, reconfigure a DPDK build
+folder by passing ``-Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1`` meson option
+and recompile the DPDK:
+
+.. code-block:: console
+
+    meson build
+    meson configure build -Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1
+    ninja -C build
+

Since the VTUNE parts seem to be protected by just "#ifdef" rather than a check for a specific value, I think the "=1" can be omitted in the instructions. That should also make the quoted unnecessary.

With that change to simplify things,

#2 lore raw

13/01/2021 18:11, Bruce Richardson:

Quoted 26 lines · On Wed, Dec 02, 2020 at 08:48:06PM +0300, [email protected]…
Quoted 11 lines

From: Eugeny Parshutin <[email protected]>

Return back 'profiling with vtune' section to profiling programmers guide with updated instruction on how to enable vtune profiling with meson configuration option.

---

doc/guides/prog_guide/profile_app.rst +3 -0
+Profiling with VTune
+~~~~~~~~~~~~~~~~~~~~
+

doc/guides/prog_guide/profile_app.rst Refer to the · line 48

Quoted 10 lines
doc/guides/prog_guide/profile_app.rst +10 -0
+To allow VTune attaching to the DPDK application, reconfigure a DPDK build
+folder by passing ``-Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1`` meson option
+and recompile the DPDK:
+
+.. code-block:: console
+
+    meson build
+    meson configure build -Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1
+    ninja -C build
+

Since the VTUNE parts seem to be protected by just "#ifdef" rather than a check for a specific value, I think the "=1" can be omitted in the instructions. That should also make the quoted unnecessary.

Quoted 3 lines

With that change to simplify things,

Fixes 89c67ae2cba7 ("doc: remove references to make from prog guide")

Applied with above changes, thanks.