doc: update definition of lcore id and lcore index
PATCH 1/1 doc: update definition of lcore id and lcore index
Added examples in lcore index for better
explanation on various examples,
Sited examples for lcore id.
--- lib/librte_eal/common/include/rte_lcore.h | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-)
lib/librte_eal/common/include/rte_lcore.h +15 -2
@@ -57,7 +57,9 @@ RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per thread "lcore id". */RTE_DECLARE_PER_LCORE (rte_cpuset_t, _cpuset);/**< Per thread "cpuset". */ /** -* Return the ID of the execution unit we are running on. +* Return the Application thread ID of the execution unit. +* If option '-l' or '-c' is provided the lcore ID is the actual +* CPU ID. * @return * Logical core ID (in EAL thread) or LCORE_ID_ANY (in non-EAL thread) */
@@ -94,8 +96,19 @@ rte_lcore_count(void)/** * Return the index of the lcore starting from zero. -* The order is physical or given by command line (-l option). * +* For example: <Core parameters - Mapping description> +* 1. '-c 0xf0' - CPU core ID 4 is index 0, 5 +* is 1 and so on. +* +* 2. '-l 22-25' - CPU core ID 22 is index 0 +* 23 is 1 and so on. +* +* 3. '-l 22,18' - CPU core ID 22 is index 0 and +* 18 is 1 +* +* 4. '-c 0xcc' - CPU core ID 2 is index 0, 3 is index 1, +* 6 is index 2 and 7 is index 3. * @param lcore_id * The targeted lcore, or -1 for the current one. * @return
Signature · 1 line
2.9.5
Quoted 14 lines · Marko Kovacevic
Added examples in lcore index for better
explanation on various examples,
Sited examples for lcore id.Signed-off-by Marko Kovacevic <[email protected]>--- lib/librte_eal/common/include/rte_lcore.h | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-)lib/librte_eal/common/include/rte_lcore.h +0
-0
lib/librte_eal/common/include/rte_lcore.h RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per thread "lcore id". */ · line 62
Quoted 7 lines
lib/librte_eal/common/include/rte_lcore.h +3
-1@@ -57,7 +57,9 @@ RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per thread "lcore id". */RTE_DECLARE_PER_LCORE (rte_cpuset_t, _cpuset);/**< Per thread "cpuset". */ /** -* Return the ID of the execution unit we are running on. +* Return the Application thread ID of the execution unit. +* If option '-l' or '-c' is provided the lcore ID is the actual +* CPU ID.
Good idea to clarify this!
I'd suggest the second sentence might do with being reworked a little though - the lcore ID will also be the processor id even if no args i.e. no -c or -l arguments are passed.
How about:
* Note: in most cases the lcore id returned here will also correspond
* to the processor id of the CPU on which the thread is pinned, this * will not be the case if the user has explicitly changed the thread to * core affinities using --lcores EAL argument e.g. --lcores '(0-3)@10' * to run threads with lcore IDs 0, 1, 2 and 3 on physical core 10.
It's longer, I know, but hopefully a bit clearer for the user.
/Bruce
PATCH v2 1/1 doc: update definition of lcore id and lcore index
In reply to Marko KovacevicAdded examples in lcore index for better
explanation on various examples,
Sited examples for lcore id.
---
V2:
- Added clearer description to lcore id - Bruce
- Reframed examples for lcore index - Bruce
--- lib/librte_eal/common/include/rte_lcore.h | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-)
lib/librte_eal/common/include/rte_lcore.h +12 -2
@@ -57,7 +57,12 @@ RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per thread "lcore id". */RTE_DECLARE_PER_LCORE (rte_cpuset_t, _cpuset);/**< Per thread "cpuset". */ /** -* Return the ID of the execution unit we are running on. +* Return the Application thread ID of the execution unit. +* +* If option '-l' or '-c' is provided the lcore ID is the actual +* CPU ID. If option '--lcore' is provided the lcore ID is the +* index starting from 0. +* * @return * Logical core ID (in EAL thread) or LCORE_ID_ANY (in non-EAL thread) */
@@ -94,7 +99,12 @@ rte_lcore_count(void)/** * Return the index of the lcore starting from zero. -* The order is physical or given by command line (-l option). +* +* When option -c or -l is given, the index corresponds +* to the order in the list. +* For example: +* -c 0x30, lcore 4 has index 0, and 5 has index 1. +* -l 22,18 lcore 22 has index 0, and 18 has index 1. * * @param lcore_id * The targeted lcore, or -1 for the current one.
Signature · 1 line
2.9.5
PATCH v3 1/1 doc: update definition of lcore id and lcore index
Added examples in lcore index for better explanation on various examples, Sited examples for lcore id.
---
V3:
- Rephrased examples for lcore index and id - Bruce
V2:
- Added clearer description to lcore id - Bruce
- Reframed examples for lcore index - Bruce
--- lib/librte_eal/common/include/rte_lcore.h | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-)
lib/librte_eal/common/include/rte_lcore.h +14 -2
@@ -57,7 +57,14 @@ RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per thread "lcore id". */RTE_DECLARE_PER_LCORE (rte_cpuset_t, _cpuset);/**< Per thread "cpuset". */ /** -* Return the ID of the execution unit we are running on. +* Return the Application thread ID of the execution unit. +* +* Note: in most cases the lcore id returned here will also correspond +* to the processor id of the CPU on which the thread is pinned, this +* will not be the case if the user has explicitly changed the thread to +* core affinities using --lcores EAL argument e.g. --lcores '(0-3)@10' +* to run threads with lcore IDs 0, 1, 2 and 3 on physical core 10.. +* * @return * Logical core ID (in EAL thread) or LCORE_ID_ANY (in non-EAL thread) */
@@ -94,7 +101,12 @@ rte_lcore_count(void)/** * Return the index of the lcore starting from zero. -* The order is physical or given by command line (-l option). +* +* When option -c or -l is given, the index corresponds +* to the order in the list. +* For example: +* -c 0x30, lcore 4 has index 0, and 5 has index 1. +* -l 22,18 lcore 22 has index 0, and 18 has index 1. * * @param lcore_id * The targeted lcore, or -1 for the current one.
Signature · 1 line
2.9.5
Quoted 12 lines
-----Original Message-----
From: Kovacevic, Marko
Sent: Friday, February 2, 2018 3:03 PM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Varghese, Vipin <[email protected]>; Richardson, Bruce <[email protected]>; [email protected]; Kovacevic, Marko <[email protected]>
Subject: [PATCH v3] doc: update definition of lcore id and lcore index
Quoted 2 lines
Added examples in lcore index for better explanation on various examples, Sited examples for lcore id.
Thomas Monjalon
AppliedQuoted 4 lines
Quoted 2 lines
Added examples in lcore index for better explanation on various examples, Sited examples for lcore id.
Acked-by John McNamara <[email protected]>
Applied, thanks