doc: improve event core description in vDPA mlx5
PATCH 1/1 doc: improve event core description in vDPA mlx5
The event core is mlx5 vDPA driver devarg that selects the CPU core for the internal timer thread used to manage data-path events into the driver.
Emphasize that this CPU should be isolated for vDPA mlx5 devices only in order to save the performance and latency of the device.
--- doc/guides/vdpadevs/mlx5.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)
doc/guides/vdpadevs/mlx5.rst +7 -2
@@ -86,8 +86,13 @@ for an additional list of options shared with other mlx5 drivers. - ``event_core`` parameter [int] - CPU core number to set polling thread affinity to, default to control plane - cpu. + The CPU core number of the timer thread, default: EAL main lcore. + +.. note:: + + This core can be shared among different mlx5 vDPA devices as `event_core` but + using it also for other tasks may affect the performance and the latency of the + mlx5 vDPA devices. - ``max_conf_threads`` parameter [int]
Signature · 1 line
2.25.1
Quoted 41 lines
-----Original Message-----
From: Matan Azrad <[email protected]>
Sent: Sunday, November 13, 2022 5:22 PM
To: Maxime Coquelin <[email protected]>
Cc: [email protected]
Subject: [PATCH] doc: improve event core description in vDPA mlx5The event core is mlx5 vDPA driver devarg that selects the CPU core for the internal timer thread used to manage data-path events into the driver.
Emphasize that this CPU should be isolated for vDPA mlx5 devices only in order to save the performance and latency of the device.
Signed-off-by Matan Azrad <[email protected]>--- doc/guides/vdpadevs/mlx5.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)doc/guides/vdpadevs/mlx5.rst +0
-0@@ -86,8 +86,13 @@ for an additional list of options shared with othermlx5 drivers.
- ``event_core`` parameter [int]
- CPU core number to set polling thread affinity to, default to control plane
doc/guides/vdpadevs/mlx5.rst +5
-1- cpu. + The CPU core number of the timer thread, default: EAL main lcore. + +.. note:: + + This core can be shared among different mlx5 vDPA devices as
event_corebut
+ using it also for other tasks may affect the performance and the
latency of the
+ mlx5 vDPA devices.
Quoted 4 lines
- ``max_conf_threads`` parameter [int]
--
2.25.1
Thomas Monjalon
AppliedQuoted 10 lines
Quoted 8 lines
The event core is mlx5 vDPA driver devarg that selects the CPU core for the internal timer thread used to manage data-path events into the driver.
Emphasize that this CPU should be isolated for vDPA mlx5 devices only in order to save the performance and latency of the device.
Signed-off-by Matan Azrad <[email protected]>Reviewed-by Chenbo Xia <[email protected]>
Applied, thanks.