eal/windows: add pthread TLS function support
PATCH v2 1/1 eal/windows: add pthread TLS function support
Add the following functions to the pthread shim implementation for Windows as they are needed for thread safe rte_flow functions.
pthread_key_create.pthread_key_delete.pthread_getspecific.pthread_setspecific.
---
v2: fix style issues
--- lib/librte_eal/windows/include/pthread.h | 43 ++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+)
lib/librte_eal/windows/include/pthread.h +43 -0
@@ -34,6 +34,8 @@ typedef CRITICAL_SECTION pthread_mutex_t;typedef SYNCHRONIZATION_BARRIER pthread_barrier_t ; +typedef DWORD pthread_key_t ; +#define pthread_barrier_init (barrier, attr, count) \ InitializeSynchronizationBarrier(barrier, count, -1)#define pthread_barrier_wait (barrier) EnterSynchronizationBarrier(barrier, \
@@ -179,6 +181,47 @@ pthread_mutex_destroy(pthread_mutex_t *mutex)return 0 ; } +static inline int +pthread_key_create (pthread_key_t *key, + __rte_unused void (*destructor)(void *)) +{ + *key =TlsAlloc (); +if ((*key) ==TLS_OUT_OF_INDEXES ) { +RTE_LOG_WIN32_ERR ("TlsAlloc()" ); +return -ENOMEM ; + } +return 0 ; +} + +static inline int +pthread_key_delete (pthread_key_t key) +{ +if (!TlsFree (key)) { +RTE_LOG_WIN32_ERR ("TlsFree()" ); +return -1 ; + } +return 0 ; +} + +static inline void * +pthread_getspecific (pthread_key_t key) +{ +return TlsGetValue (key); +} + +static inline int +pthread_setspecific (pthread_key_t key,const void *value) +{ +/* discard const qualifier */ +char *p = (char *) (uintptr_t ) value; + +if (!TlsSetValue (key, p)) { +RTE_LOG_WIN32_ERR ("TlsSetValue()" ); +return -1 ; + } +return 0 ; +} + #ifdef __cplusplus }#endif
Signature · 1 line
2.16.1.windows.4
Quoted 8 lines · Tal Shnaiderman
Add the following functions to the pthread shim implementation for Windows as they are needed for thread safe
rte_flowfunctions.
pthread_key_create.pthread_key_delete.pthread_getspecific.pthread_setspecific.
Quoted 6 lines
Signed-off-by Tal Shnaiderman <[email protected]>---
v2: fix style issues--- lib/librte_eal/windows/include/pthread.h | 43 ++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+)
It's been planned to remove the shim, not to extend it; and to introduce a generic threading API in EAL. Why not start with these functions? It's quite an isolated set.
PATCH v3 1/1 eal: add generic thread-local-storage functions
In reply to Tal ShnaidermanAdd support for tls functionality in EAL.
The following functions are added:rte_tls_create_key - function to create a tls data key. rte_tls_delete_key - function to delete a tls data key. rte_tls_set_thread_value - function to set value bound to the tls key rte_tls_get_thread_value - function to get value bound to the tls key
tls key will be defied by the new type rte_tls_key_t
---
v3: switch from pthread shim to generic eal implementation [DmitryK]
--- lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_tls.h | 88 ++++++++++++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 +++ lib/librte_eal/unix/eal_unix_tls.c | 79 ++++++++++++++++++++++++++++++++++ lib/librte_eal/unix/meson.build | 1 + lib/librte_eal/version.map | 6 +++ lib/librte_eal/windows/eal_tls.c | 72 +++++++++++++++++++++++++++++++ lib/librte_eal/windows/meson.build | 1 + 8 files changed, 253 insertions(+) create mode 100644 lib/librte_eal/include/rte_tls.h create mode 100644 lib/librte_eal/unix/eal_unix_tls.c create mode 100644 lib/librte_eal/windows/eal_tls.c
lib/librte_eal/include/meson.build +1 -0
@@ -41,6 +41,7 @@ headers += files( 'rte_string_fns.h', 'rte_tailq.h', 'rte_time.h', + 'rte_tls.h', 'rte_trace.h', 'rte_trace_point.h', 'rte_trace_point_register.h',
lib/librte_eal/include/rte_tls.h new file +88 -0
88 lines not on this page · raw message
lib/librte_eal/rte_eal_exports.def +5 -0
@@ -306,6 +306,11 @@ EXPORTS rte_vect_get_max_simd_bitwidth rte_vect_set_max_simd_bitwidth + rte_tls_create_key + rte_tls_delete_key + rte_tls_set_thread_value + rte_tls_get_thread_value + rte_mem_lock rte_mem_map rte_mem_page_size
lib/librte_eal/unix/eal_unix_tls.c new file +79 -0
79 lines not on this page · raw message
lib/librte_eal/unix/meson.build +1 -0
@@ -5,4 +5,5 @@ sources += files( 'eal_file.c', 'eal_unix_memory.c', 'eal_unix_timer.c', + 'eal_unix_tls.c', )
lib/librte_eal/version.map +6 -0
@@ -403,6 +403,12 @@ EXPERIMENTAL { rte_service_lcore_may_be_active; rte_vect_get_max_simd_bitwidth; rte_vect_set_max_simd_bitwidth; + + # added in 21.02 + rte_tls_create_key; + rte_tls_delete_key; + rte_tls_set_thread_value; + rte_tls_get_thread_value; }; INTERNAL {
lib/librte_eal/windows/eal_tls.c new file +72 -0
72 lines not on this page · raw message
lib/librte_eal/windows/meson.build +1 -0
@@ -17,6 +17,7 @@ sources += files( 'eal_mp.c', 'eal_thread.c', 'eal_timer.c', + 'eal_tls.c', 'fnmatch.c', 'getopt.c', )
Signature · 1 line
2.16.1.windows.4
Re: [dpdk-dev] [PATCH v3] eal: add generic thread-local-storage functions
Quoted 8 lines · Tal Shnaiderman
Add support for tls functionality in EAL.
The following functions are added:
rte_tls_create_key- function to create a tls data key.rte_tls_delete_key- function to delete a tls data key.rte_tls_set_thread_value- function to set value bound to the tls keyrte_tls_get_thread_value- function to get value bound to the tls key
Quoted 5 lines
tls key will be defied by the new type
rte_tls_key_tSigned-off-by Tal Shnaiderman <[email protected]>---
v3: switch from pthread shim to generic eal implementation [DmitryK]
Hi Tal,
Unix code can be placed in common/ directory, so that it can be eventually used on Windows with external pthread implementation.
See more comments inline.
Quoted 8 lines
+++
b/lib/librte_eal/include/rte_tls.hlib/librte_eal/include/rte_tls.h new file +6
-0@@ -0,0 +1,88 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright(c) 2020 Mellanox Technologies, Ltd +*/ + +#include <rte_compat.h> +
lib/librte_eal/include/rte_tls.h line 16
Quoted 10 lines
lib/librte_eal/include/rte_tls.h new file +10
-0+#ifndef _RTE_TLS_H_ +#define _RTE_TLS_H_ + +/** +* @file +* +* TLS functions +* +* Simple TLS functionality supplied by eal. +*/
These functions are supposed to be the first part of an API that will be used instead of naked pthread in DPDK. Maybe more generic names are in order, like rte_thread.h and rte_thread_tls_create/destroy/get/set(). In particular, rte_tls_*() is confusing compared to rte_lcore_*().
lib/librte_eal/include/rte_tls.h line 21
Quoted 5 lines
lib/librte_eal/include/rte_tls.h new file +5
-0+ +/** +* Opaque pointer for tls key. +*/ +typedef struct eal_tls_key *rte_tls_key_t ;
"_t" suffix is reserved by POSIX, "rte_" prefix is sufficient.
lib/librte_eal/include/rte_tls.h line 24
Quoted 3 lines
lib/librte_eal/include/rte_tls.h new file +3
-0+ +/** +* Function to create a tls data key visible to all threads in the process
Typos: "TLS", "EAL".
lib/librte_eal/include/rte_tls.h line 30
Quoted 6 lines
lib/librte_eal/include/rte_tls.h new file +6
-0+* function need to be called once to create a key usable by all threads. +* rte_tls_key_t is an opaque pointer used to store the allocated key. +* and optional destructor can be set to be called when a thread expires. +* +* @param key +* The rte_tls_key_t will cantain the allocated key
Typo: "cantain". I'd say: "Pointer to store the allocated rte_tls_key".
lib/librte_eal/include/rte_tls.h line 32
Quoted 2 lines
lib/librte_eal/include/rte_tls.h new file +2
-0+* @param destructor +* The function to be called when the thread expires
Typo: no period (line-break will be removed by Doxygen).
lib/librte_eal/include/rte_tls.h line 33
Quoted 1 line
lib/librte_eal/include/rte_tls.h new file +1
-0+* Not supported on Windows OS.
Some drivers (net/mlx5, bus/dpaa, bus/fsmlc) rely on this feature. Admittedly, it would be hard to implement. You know net/mlx5 well, how will it be affected? Do you plan to stop relying on this feature or implement it in the future? Anyway, LGTM for now.
lib/librte_eal/include/rte_tls.h line 37
Quoted 4 lines
lib/librte_eal/include/rte_tls.h new file +4
-0+* +* @return +* On success, zero. +* On failure, a negative error number -ENOMEM or -ENOEXEC
Let's not make POSIX codes part of the API.
Quoted 4 lines
lib/librte_eal/include/rte_tls.h new file +4
-0+*/ +__rte_experimental +int +rte_tls_create_key (rte_tls_key_t *key,void (*destructor)(void *));
[...]
Quoted 4 lines
lib/librte_eal/unix/eal_unix_tls.c new file +4
-0+int +rte_tls_create_key (rte_tls_key_t *key,void (*destructor)(void *)) +{ +int err;
lib/librte_eal/unix/eal_unix_tls.c line 31
Quoted 10 lines
lib/librte_eal/unix/eal_unix_tls.c new file +10
-0+ + *key =malloc (sizeof (struct eal_tls_key )); +if ((*key) ==NULL ) { +RTE_LOG (DEBUG ,EAL ,"Cannot allocate tls key." ); +return -ENOMEM ; + } + err =pthread_key_create (&((*key)->thread_index), destructor); +if (err) { +RTE_LOG (DEBUG ,EAL ,"pthread_key_create failed: %s\n" , +rte_strerror (err));
Use strerror() for OS error codes here and below.
Quoted 6 lines
lib/librte_eal/unix/eal_unix_tls.c new file +6
-0+free (*key); +return -ENOEXEC ; + } +return 0 ; +} +
[...]
lib/librte_eal/windows/eal_tls.c line 51
Quoted 7 lines
lib/librte_eal/windows/eal_tls.c new file +7
-0+int +rte_tls_set_thread_value (rte_tls_key_t key,const void *value) +{ +if (!key) +return -EINVAL ; +/* discard const qualifier */ +char *p = (char *) (uintptr_t ) value;
Please declare all variables at the top of a block.
Quoted 4 lines
lib/librte_eal/windows/eal_tls.c new file +4
-0+ +if (!TlsSetValue (key->thread_index, p)) { +RTE_LOG_WIN32_ERR ("TlsSetValue()" ); +return -ENOEXEC ;
lib/librte_eal/windows/eal_tls.c line 65
Quoted 10 lines
lib/librte_eal/windows/eal_tls.c new file +10
-0+ } +return 0 ; +} + +void * +rte_tls_get_thread_value (rte_tls_key_t key) +{ +if (!key) + rte_errno =EINVAL ; +void *output =TlsGetValue (key->thread_index);
Same as above.
Quoted 7 lines
lib/librte_eal/windows/eal_tls.c new file +7
-0+if (GetLastError () !=ERROR_SUCCESS ) { +RTE_LOG_WIN32_ERR ("TlsGetValue()" ); + rte_errno =ENOEXEC ; +return NULL ; + } +return output; +}
Re: [dpdk-dev] [PATCH v3] eal: add generic thread-local-storage functions
Quoted 58 lines
Subject: Re: [PATCH v3] eal: add generic thread-local-storage functions
External email: Use caution opening links or attachments
Quoted 8 lines · Tal Shnaiderman
Add support for tls functionality in EAL.
The following functions are added:
rte_tls_create_key- function to create a tls data key.rte_tls_delete_key- function to delete a tls data key.rte_tls_set_thread_value- function to set value bound to the tls keyrte_tls_get_thread_value- function to get value bound to the tls keyQuoted 5 lines
tls key will be defied by the new type
rte_tls_key_tSigned-off-by Tal Shnaiderman <[email protected]>---
v3: switch from pthread shim to generic eal implementation [DmitryK]Hi Tal,
Unix code can be placed in common/ directory, so that it can be eventually used on Windows with external pthread implementation.
See more comments inline.
Quoted 7 lines
+++
b/lib/librte_eal/include/rte_tls.hlib/librte_eal/include/rte_tls.h new file +5
-0@@ -0,0 +1,88 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright(c) 2020 Mellanox Technologies, Ltd */ + +#include <rte_compat.h> +lib/librte_eal/include/rte_tls.h line 15
Quoted 10 lines
lib/librte_eal/include/rte_tls.h new file +10
-0+#ifndef _RTE_TLS_H_ +#define _RTE_TLS_H_ + +/** +* @file +* +* TLS functions +* +* Simple TLS functionality supplied by eal. +*/ These functions are supposed to be the first part of an API that will be used instead of naked pthread in DPDK. Maybe more generic names are in order, like
rte_thread.hand rte_thread_tls_create/destroy/get/set(). In particular, rte_tls_*() is confusing compared to rte_lcore_*().lib/librte_eal/include/rte_tls.h line 21
Quoted 5 lines
lib/librte_eal/include/rte_tls.h new file +5
-0+ +/** +* Opaque pointer for tls key. +*/ +typedef struct eal_tls_key *rte_tls_key_t ;"_t" suffix is reserved by POSIX, "
rte_" prefix is sufficient.
Quoted 7 lines
lib/librte_eal/include/rte_tls.h
Quoted 4 lines
lib/librte_eal/include/rte_tls.h new file +4
-0+ +/** +* Function to create a tls data key visible to all threads in the +process Typos: "TLS", "EAL".
Didn't find the EAL typo.
Quoted 12 lines
lib/librte_eal/include/rte_tls.h line 30
Quoted 6 lines
lib/librte_eal/include/rte_tls.h new file +6
-0+* function need to be called once to create a key usable by all threads. +* rte_tls_key_t is an opaque pointer used to store the allocated key. +* and optional destructor can be set to be called when a thread expires. +* +* @param key +* The rte_tls_key_t will cantain the allocated key Typo: "cantain". I'd say: "Pointer to store the allocated
rte_tls_key".lib/librte_eal/include/rte_tls.h line 32
Quoted 2 lines
lib/librte_eal/include/rte_tls.h new file +2
-0+* @param destructor +* The function to be called when the thread expires
Quoted 8 lines
Typo: no period (line-break will be removed by Doxygen).
lib/librte_eal/include/rte_tls.h line 33
Quoted 1 line
lib/librte_eal/include/rte_tls.h new file +1
-0+* Not supported on Windows OS. Some drivers (net/mlx5, bus/dpaa, bus/fsmlc) rely on this feature. Admittedly, it would be hard to implement. You know net/mlx5 well, how will it be affected? Do you plan to stop relying on this feature or implement it in the future? Anyway, LGTM for now.
In net/mlx5 we will not relay on the destructor for the Windows flow and plan to do the housekeeping in the PMD, to summarize we save HANDLE for each thread using rte_tls_set_thread_value in the PMD destruction flow we call the needed release function for each terminated thread.
I used the opaque pointer in case future development might want to implement It without breaking the API, I assumed additions to the TLS key struct on Windows side will be needed.
Thanks for the review, I'll send a v4 after fixing your comments.
Quoted 70 lines
lib/librte_eal/include/rte_tls.h line 37
Quoted 5 lines
lib/librte_eal/include/rte_tls.h new file +4
-0+* +* @return +* On success, zero. +* On failure, a negative error number -ENOMEM or -ENOEXEC Let's not make POSIX codes part of the API.
Quoted 4 lines
lib/librte_eal/include/rte_tls.h new file +4
-0+*/ +__rte_experimental +int +rte_tls_create_key (rte_tls_key_t *key,void (*destructor)(void *));[...]
lib/librte_eal/unix/eal_unix_tls.c line 31
Quoted 13 lines
lib/librte_eal/unix/eal_unix_tls.c new file +13
-0+int +rte_tls_create_key (rte_tls_key_t *key,void (*destructor)(void *)) { +int err; + + *key =malloc (sizeof (struct eal_tls_key )); +if ((*key) ==NULL ) { +RTE_LOG (DEBUG ,EAL ,"Cannot allocate tls key." ); +return -ENOMEM ; + } + err =pthread_key_create (&((*key)->thread_index), destructor); +if (err) { +RTE_LOG (DEBUG ,EAL ,"pthread_key_create failed: %s\n" , +rte_strerror (err));Use
strerror()for OS error codes here and below.Quoted 6 lines
lib/librte_eal/unix/eal_unix_tls.c new file +6
-0+free (*key); +return -ENOEXEC ; + } +return 0 ; +} +[...]
lib/librte_eal/windows/eal_tls.c line 51
Quoted 6 lines
lib/librte_eal/windows/eal_tls.c new file +6
-0+int +rte_tls_set_thread_value (rte_tls_key_t key,const void *value) { +if (!key) +return -EINVAL ; +/* discard const qualifier */ +char *p = (char *) (uintptr_t ) value;Please declare all variables at the top of a block.
lib/librte_eal/windows/eal_tls.c line 65
Quoted 13 lines
lib/librte_eal/windows/eal_tls.c new file +13
-0+ +if (!TlsSetValue (key->thread_index, p)) { +RTE_LOG_WIN32_ERR ("TlsSetValue()" ); +return -ENOEXEC ; + } +return 0 ; +} + +void * +rte_tls_get_thread_value (rte_tls_key_t key) { +if (!key) + rte_errno =EINVAL ; +void *output =TlsGetValue (key->thread_index);Same as above.
Quoted 7 lines
lib/librte_eal/windows/eal_tls.c new file +7
-0+if (GetLastError () !=ERROR_SUCCESS ) { +RTE_LOG_WIN32_ERR ("TlsGetValue()" ); + rte_errno =ENOEXEC ; +return NULL ; + } +return output; +}
PATCH v4 1/1 eal: add generic thread-local-storage functions
In reply to Tal ShnaidermanAdd support for tls functionality in EAL.
The following functions are added:rte_thread_tls_create_key - function to create a tls data key. rte_thread_tls_delete_key - function to delete a tls data key. rte_thread_tls_set_value - function to set value bound to the tls key rte_thread_tls_get_value - function to get value bound to the tls key
tls key will be defined by the new type rte_tls_key
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
common implementation is under librte_eal/common and implemented using pthread for UNIX and Windows compilation using extenral pthread libraries, when supported.
---
v3: switch from pthread shim to generic eal implementation [DmitryK]
v4: modify file names, function names, move unix code to common for future external pthreads support [DmitryK]
--- lib/librte_eal/common/meson.build | 1 + lib/librte_eal/common/rte_thread.c | 87 ++++++++++++++++++++++++++++++++++++ lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_thread.h | 88 +++++++++++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 +++ lib/librte_eal/version.map | 6 +++ lib/librte_eal/windows/meson.build | 6 +++ lib/librte_eal/windows/rte_thread.c | 82 ++++++++++++++++++++++++++++++++++ 8 files changed, 276 insertions(+) create mode 100644 lib/librte_eal/common/rte_thread.c create mode 100644 lib/librte_eal/include/rte_thread.h create mode 100644 lib/librte_eal/windows/rte_thread.c
lib/librte_eal/common/meson.build +1 -0
@@ -77,6 +77,7 @@ sources += files( 'rte_random.c', 'rte_reciprocal.c', 'rte_service.c', + 'rte_thread.c', ) if is_linux
lib/librte_eal/common/rte_thread.c new file +87 -0
87 lines not on this page · raw message
lib/librte_eal/include/meson.build +1 -0
@@ -40,6 +40,7 @@ headers += files( 'rte_service_component.h', 'rte_string_fns.h', 'rte_tailq.h', + 'rte_thread.h', 'rte_time.h', 'rte_trace.h', 'rte_trace_point.h',
lib/librte_eal/include/rte_thread.h new file +88 -0
88 lines not on this page · raw message
lib/librte_eal/rte_eal_exports.def +5 -0
@@ -306,6 +306,11 @@ EXPORTS rte_vect_get_max_simd_bitwidth rte_vect_set_max_simd_bitwidth + rte_thread_tls_create_key + rte_thread_tls_delete_key + rte_thread_tls_set_value + rte_thread_tls_get_value + rte_mem_lock rte_mem_map rte_mem_page_size
lib/librte_eal/version.map +6 -0
@@ -403,6 +403,12 @@ EXPERIMENTAL { rte_service_lcore_may_be_active; rte_vect_get_max_simd_bitwidth; rte_vect_set_max_simd_bitwidth; + + # added in 21.02 + rte_thread_tls_create_key; + rte_thread_tls_delete_key; + rte_thread_tls_set_value; + rte_thread_tls_get_value; }; INTERNAL {
lib/librte_eal/windows/meson.build +6 -0
@@ -21,4 +21,10 @@ sources += files( 'getopt.c', ) +if (dpdk_conf.has('use_external_pthread')) + sources += 'librte_eal/common/rte_thread.c' +else + sources += 'librte_eal/windows/rte_thread.c' +endif + dpdk_conf.set10('RTE_EAL_NUMA_AWARE_HUGEPAGES', true)
lib/librte_eal/windows/rte_thread.c new file +82 -0
82 lines not on this page · raw message
Signature · 1 line
2.16.1.windows.4
Re: [dpdk-dev] [PATCH v4] eal: add generic thread-local-storage functions
Quoted 5 lines
[...]
lib/librte_eal/common/rte_thread.c new file +4
-0+int +rte_thread_tls_set_value (rte_tls_key key,const void *value) +{ +int err;
lib/librte_eal/common/rte_thread.c line 72
Quoted 10 lines
lib/librte_eal/common/rte_thread.c new file +10
-0+ +if (!key) { +RTE_LOG (DEBUG ,EAL ,"invalid tls key passed to function.\n" ); +return -1 ; + } + err =pthread_setspecific (key->thread_index, value); +if (err) { +RTE_LOG (DEBUG ,EAL ,"pthread_setspecific failed: %s\n" , +strerror (err)); +free (key);
Why free(key) here? Probably a typo.
lib/librte_eal/include/rte_thread.h line 48
Quoted 11 lines
[...]
lib/librte_eal/include/rte_thread.h new file +10
-0+__rte_experimental +int +rte_thread_tls_create_key (rte_tls_key *key,void (*destructor)(void *)); + +/** +* Function to delete a TLS data key visible to all threads in the process +* rte_tls_key is the opaque pointer allocated by rte_thread_tls_create_key. +* +* @param key +* The rte_tls_key will cantain the allocated key
cantain -> contain
lib/librte_eal/windows/meson.build sources += files( · line 24
Quoted 9 lines
lib/librte_eal/windows/meson.build +1
-0@@ -21,4 +21,10 @@ sources += files( 'getopt.c', ) +if (dpdk_conf.has('use_external_pthread'))
Please describe the new option in meson_options.txt. Maybe drop "external" from the name, what do you think?
Re: [dpdk-dev] [PATCH v4] eal: add generic thread-local-storage functions
Quoted 49 lines
Subject: Re: [PATCH v4] eal: add generic thread-local-storage functions
External email: Use caution opening links or attachments
Quoted 4 lines
[...]
lib/librte_eal/common/rte_thread.c new file +3
-0+int +rte_thread_tls_set_value (rte_tls_key key,const void *value) { +int err;lib/librte_eal/common/rte_thread.c line 72
Quoted 10 lines
lib/librte_eal/common/rte_thread.c new file +10
-0+ +if (!key) { +RTE_LOG (DEBUG ,EAL ,"invalid tls key passed to function.\n" ); +return -1 ; + } + err =pthread_setspecific (key->thread_index, value); +if (err) { +RTE_LOG (DEBUG ,EAL ,"pthread_setspecific failed: %s\n" , +strerror (err)); +free (key);Why free(key) here? Probably a typo.
Review
Quoted 10 lines
[...]
(quoted diff) +9
-0+__rte_experimental +int +rte_thread_tls_create_key(rte_tls_key *key, void (*destructor)(void +*)); + +/** + * Function to delete a TLS data key visible to all threads in the +process + * rte_tls_key is the opaque pointer allocated by
rte_thread_tls_create_key.Quoted 3 lines
+ *
+ * @param key
+ * Therte_tls_keywill cantain the allocated keycantain -> contain
Quoted 9 lines
lib/librte_eal/windows/meson.build +0
-0@@ -21,4 +21,10 @@ sources += files( 'getopt.c', )
Quoted 4 lines
lib/librte_eal/windows/meson.build sources += files( · line 24
Quoted 1 line
lib/librte_eal/windows/meson.build +1
-0+if (dpdk_conf.has('use_external_pthread'))Please describe the new option in meson_options.txt. Maybe drop "external" from the name, what do you think?
How about use_windows_pthread to be clear that it's unrelated to UNIX pthreads?
Re: [dpdk-dev] [PATCH v4] eal: add generic thread-local-storage functions
Quoted 9 lines · Tal Shnaiderman
Quoted 9 lines
Quoted 9 lines
lib/librte_eal/windows/meson.build +0
-0@@ -21,4 +21,10 @@ sources += files( 'getopt.c', )
Quoted 6 lines
Quoted 4 lines
lib/librte_eal/windows/meson.build sources += files( · line 24
Quoted 1 line
lib/librte_eal/windows/meson.build +1
-0+if (dpdk_conf.has('use_external_pthread'))Please describe the new option in meson_options.txt. Maybe drop "external" from the name, what do you think?
How about
use_windows_pthreadto be clear that it's unrelated to UNIX pthreads?
Sounds good.
Re: [dpdk-dev] [EXTERNAL] Re: [PATCH v4] eal: add generic thread-local-storage functions
I wonder if this should be consistent with Nick's meson (to use external pthread library) change?
-----Original Message-----
From: Dmitry Kozlyuk <[email protected]>
Sent: Wednesday, December 23, 2020 3:59 AM
To: Tal Shnaiderman <[email protected]>
Cc: [email protected]; thomas <[email protected]>; Kadam, Pallavi <[email protected]>; [email protected]; Dmitry Malloy (MESHCHANINOV) <[email protected]>; [email protected]
Subject: [EXTERNAL] Re: [PATCH v4] eal: add generic thread-local-storage functions
Quoted 9 lines · Tal Shnaiderman
Quoted 9 lines
Quoted 9 lines
lib/librte_eal/windows/meson.build +0
-0@@ -21,4 +21,10 @@ sources += files( 'getopt.c', )
Quoted 6 lines
Quoted 4 lines
lib/librte_eal/windows/meson.build sources += files( · line 24
Quoted 1 line
lib/librte_eal/windows/meson.build +1
-0+if (dpdk_conf.has('use_external_pthread'))Please describe the new option in meson_options.txt. Maybe drop "external" from the name, what do you think?
How about
use_windows_pthreadto be clear that it's unrelated to UNIX pthreads?
Sounds good.
PATCH v5 1/1 eal: add generic thread-local-storage functions
In reply to Tal ShnaidermanAdd support for tls functionality in EAL.
The following functions are added:rte_thread_tls_create_key - function to create a tls data key. rte_thread_tls_delete_key - function to delete a tls data key. rte_thread_tls_set_value - function to set value bound to the tls key rte_thread_tls_get_value - function to get value bound to the tls key
tls key will be defined by the new type rte_tls_key
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
common implementation is under librte_eal/common and implemented using pthread for UNIX and Windows compilation using extenral pthread libraries, when supported.
---
v3: switch from pthread shim to generic eal implementation [DmitryK]
v4: modify file names, function names, move unix code to common for future external pthreads support [DmitryK]
v5: rename var used for extenal pthreads, add description in meson_options.txt. [DmitryK]
--- lib/librte_eal/common/meson.build | 1 + lib/librte_eal/common/rte_thread.c | 86 ++++++++++++++++++++++++++++++++++++ lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_thread.h | 88 +++++++++++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 +++ lib/librte_eal/version.map | 6 +++ lib/librte_eal/windows/meson.build | 6 +++ lib/librte_eal/windows/rte_thread.c | 82 ++++++++++++++++++++++++++++++++++ meson_options.txt | 2 + 9 files changed, 277 insertions(+) create mode 100644 lib/librte_eal/common/rte_thread.c create mode 100644 lib/librte_eal/include/rte_thread.h create mode 100644 lib/librte_eal/windows/rte_thread.c
lib/librte_eal/common/meson.build +1 -0
@@ -77,6 +77,7 @@ sources += files( 'rte_random.c', 'rte_reciprocal.c', 'rte_service.c', + 'rte_thread.c', ) if is_linux
lib/librte_eal/common/rte_thread.c new file +86 -0
86 lines not on this page · raw message
lib/librte_eal/include/meson.build +1 -0
@@ -40,6 +40,7 @@ headers += files( 'rte_service_component.h', 'rte_string_fns.h', 'rte_tailq.h', + 'rte_thread.h', 'rte_time.h', 'rte_trace.h', 'rte_trace_point.h',
lib/librte_eal/include/rte_thread.h new file +88 -0
88 lines not on this page · raw message
lib/librte_eal/rte_eal_exports.def +5 -0
@@ -306,6 +306,11 @@ EXPORTS rte_vect_get_max_simd_bitwidth rte_vect_set_max_simd_bitwidth + rte_thread_tls_create_key + rte_thread_tls_delete_key + rte_thread_tls_set_value + rte_thread_tls_get_value + rte_mem_lock rte_mem_map rte_mem_page_size
lib/librte_eal/version.map +6 -0
@@ -403,6 +403,12 @@ EXPERIMENTAL { rte_service_lcore_may_be_active; rte_vect_get_max_simd_bitwidth; rte_vect_set_max_simd_bitwidth; + + # added in 21.02 + rte_thread_tls_create_key; + rte_thread_tls_delete_key; + rte_thread_tls_set_value; + rte_thread_tls_get_value; }; INTERNAL {
lib/librte_eal/windows/meson.build +6 -0
@@ -21,4 +21,10 @@ sources += files( 'getopt.c', ) +if (dpdk_conf.has('use_windows_pthread')) + sources += 'librte_eal/common/rte_thread.c' +else + sources += 'librte_eal/windows/rte_thread.c' +endif + dpdk_conf.set10('RTE_EAL_NUMA_AWARE_HUGEPAGES', true)
lib/librte_eal/windows/rte_thread.c new file +82 -0
82 lines not on this page · raw message
meson_options.txt +2 -0
@@ -34,3 +34,5 @@ option('tests', type: 'boolean', value: true, description: 'build unit tests') option('use_hpet', type: 'boolean', value: false, description: 'use HPET timer in EAL') +option('use_windows_pthread', type: 'boolean', value: false, + description: 'use external pthread libraries for Windows in EAL')
Signature · 1 line
2.16.1.windows.4
Re: [dpdk-dev] [PATCH v5] eal: add generic thread-local-storage functions
Quoted 5 lines · Tal Shnaiderman
lib/librte_eal/windows/meson.build +0
-0
lib/librte_eal/windows/meson.build sources += files( · line 29
Quoted 9 lines
lib/librte_eal/windows/meson.build +6
-0@@ -21,4 +21,10 @@ sources += files( 'getopt.c', ) +if (dpdk_conf.has('use_windows_pthread')) + sources += 'librte_eal/common/rte_thread.c' +else + sources += 'librte_eal/windows/rte_thread.c' +endif +
You need get_option(), not dpdk_conf (apologies again for not being precise when I drafted the approach):
lib/librte_eal/windows/meson.build +1 -1
@@ -21,7 +21,7 @@ sources += files( 'getopt.c', ) -if (dpdk_conf.has('use_windows_pthread')) +if get_option('use_windows_pthread') sources += 'librte_eal/common/rte_thread.c' else sources += 'librte_eal/windows/rte_thread.c'
Worse, with -Duse_windows_pthread=true file in common directory includes <pthread.h>, but it finds pthread shim from windows subdirectory, not the file from external library or MinGW toolchain. So the option is not usable until the shim exists. I suggest removing the option for now, let's reintroduce it when rte_thread.h grows and the shim goes away.
Re: [dpdk-dev] [PATCH v5] eal: add generic thread-local-storage functions
Quoted 37 lines
Subject: Re: [PATCH v5] eal: add generic thread-local-storage functions
External email: Use caution opening links or attachments
Quoted 6 lines · Tal Shnaiderman
lib/librte_eal/windows/meson.build +0
-0lib/librte_eal/windows/meson.build sources += files( · line 29
Quoted 9 lines
lib/librte_eal/windows/meson.build +6
-0@@ -21,4 +21,10 @@ sources += files( 'getopt.c', ) +if (dpdk_conf.has('use_windows_pthread')) + sources += 'librte_eal/common/rte_thread.c' +else + sources += 'librte_eal/windows/rte_thread.c' +endif +You need
get_option(), notdpdk_conf(apologies again for not being precise when I drafted the approach):lib/librte_eal/windows/meson.build +1
-1@@ -21,7 +21,7 @@ sources += files( 'getopt.c', ) -if (dpdk_conf.has('use_windows_pthread')) +if get_option('use_windows_pthread') sources += 'librte_eal/common/rte_thread.c' else sources += 'librte_eal/windows/rte_thread.c'
Quoted 6 lines
Worse, with -Duse_windows_pthread=true file in common directory includes <
pthread.h>, but it finds pthread shim from windows subdirectory, not the file from external library or MinGW toolchain. So the option is not usable until the shim exists. I suggest removing the option for now, let's reintroduce it whenrte_thread.hgrows and the shim goes away.
Right, thanks for checking, I'll send a version without it.
I was planning to add support for thread priority control to address the issue of threads with realtime priority denying cpu time from OS threads, I think it will be a good opportunity to move pthread_create to the new API.
PATCH v6 1/1 eal: add generic thread-local-storage functions
In reply to Tal ShnaidermanAdd support for tls functionality in EAL.
The following functions are added:rte_thread_tls_create_key - function to create a tls data key. rte_thread_tls_delete_key - function to delete a tls data key. rte_thread_tls_set_value - function to set value bound to the tls key rte_thread_tls_get_value - function to get value bound to the tls key
tls key will be defined by the new type rte_tls_key
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
common implementation is under librte_eal/common and implemented using pthread for UNIX and Windows compilation using extenral pthread libraries, when supported.
---
v3: switch from pthread shim to generic eal implementation [DmitryK]
v4: modify file names, function names, move unix code to common for future external pthreads support [DmitryK]
v5: rename var used for extenal pthreads, add description in meson_options.txt. [DmitryK]
v6: remove external_pthread support as it collide with pthread shim implementation [DmitryK]
--- lib/librte_eal/common/meson.build | 1 + lib/librte_eal/common/rte_thread.c | 86 ++++++++++++++++++++++++++++++++++++ lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_thread.h | 88 +++++++++++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 +++ lib/librte_eal/version.map | 6 +++ lib/librte_eal/windows/meson.build | 1 + lib/librte_eal/windows/rte_thread.c | 82 ++++++++++++++++++++++++++++++++++ 8 files changed, 270 insertions(+) create mode 100644 lib/librte_eal/common/rte_thread.c create mode 100644 lib/librte_eal/include/rte_thread.h create mode 100644 lib/librte_eal/windows/rte_thread.c
lib/librte_eal/common/meson.build +1 -0
@@ -77,6 +77,7 @@ sources += files( 'rte_random.c', 'rte_reciprocal.c', 'rte_service.c', + 'rte_thread.c', ) if is_linux
lib/librte_eal/common/rte_thread.c new file +86 -0
86 lines not on this page · raw message
lib/librte_eal/include/meson.build +1 -0
@@ -40,6 +40,7 @@ headers += files( 'rte_service_component.h', 'rte_string_fns.h', 'rte_tailq.h', + 'rte_thread.h', 'rte_time.h', 'rte_trace.h', 'rte_trace_point.h',
lib/librte_eal/include/rte_thread.h new file +88 -0
88 lines not on this page · raw message
lib/librte_eal/rte_eal_exports.def +5 -0
@@ -308,6 +308,11 @@ EXPORTS rte_vect_get_max_simd_bitwidth rte_vect_set_max_simd_bitwidth + rte_thread_tls_create_key + rte_thread_tls_delete_key + rte_thread_tls_set_value + rte_thread_tls_get_value + rte_mem_lock rte_mem_map rte_mem_page_size
lib/librte_eal/version.map +6 -0
@@ -403,6 +403,12 @@ EXPERIMENTAL { rte_service_lcore_may_be_active; rte_vect_get_max_simd_bitwidth; rte_vect_set_max_simd_bitwidth; + + # added in 21.02 + rte_thread_tls_create_key; + rte_thread_tls_delete_key; + rte_thread_tls_set_value; + rte_thread_tls_get_value; }; INTERNAL {
lib/librte_eal/windows/meson.build +1 -0
@@ -19,6 +19,7 @@ sources += files( 'eal_timer.c', 'fnmatch.c', 'getopt.c', + 'rte_thread.c', ) dpdk_conf.set10('RTE_EAL_NUMA_AWARE_HUGEPAGES', true)
lib/librte_eal/windows/rte_thread.c new file +82 -0
82 lines not on this page · raw message
Signature · 1 line
2.16.1.windows.4
Re: [dpdk-dev] [PATCH v6] eal: add generic thread-local-storage functions
Quoted 18 lines · Tal Shnaiderman
Add support for tls functionality in EAL.
The following functions are added:
rte_thread_tls_create_key- function to create a tls data key.rte_thread_tls_delete_key- function to delete a tls data key.rte_thread_tls_set_value- function to set value bound to the tls keyrte_thread_tls_get_value- function to get value bound to the tls keytls key will be defined by the new type
rte_tls_keyWindows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
common implementation is under librte_eal/common and implemented using pthread for UNIX and Windows compilation using extenral pthread libraries, when supported.
Signed-off-by Tal Shnaiderman <[email protected]>
Quoted 9 lines
---
v3: switch from pthread shim to generic eal implementation [DmitryK]
v4: modify file names, function names, move unix code to common for future external pthreads support [DmitryK]
v5: rename var used for extenal pthreads, add description in meson_options.txt. [DmitryK]
v6: removeexternal_pthreadsupport as it collide with pthread shim implementation [DmitryK]
---
Re: [dpdk-dev] [PATCH v6] eal: add generic thread-local-storage functions
In reply to Tal Shnaiderman30/12/2020 12:12, Tal Shnaiderman:
Quoted 1 line
Add support for tls functionality in EAL.
You should write TLS uppercase here and below.
There is already a TLS capability in rte_per_lcore.h, using __thread keyword.
Note: I think the historical wording "lcore" is confusing. We talk about lcore, assuming the thread is bound to its lcore.
Please explain in the patch why the more complex TLS functions are required, i.e. can __thread variable be used in Windows? limitation, etc.
Quoted 5 lines
The following functions are added:
rte_thread_tls_create_key- function to create a tls data key.rte_thread_tls_delete_key- function to delete a tls data key.rte_thread_tls_set_value- function to set value bound to the tls keyrte_thread_tls_get_value- function to get value bound to the tls key
We can assume the TLS key logic is known,
but this patch is the right place to explain it.
Quoted 8 lines
tls key will be defined by the new type
rte_tls_keyWindows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
common implementation is under librte_eal/common and implemented using pthread for UNIX and Windows compilation using extenral pthread libraries, when supported.
typo: external
[...]
Quoted 3 lines
v3: switch from pthread shim to generic eal implementation [DmitryK]
v4: modify file names, function names, move unix code to common for future external pthreads support [DmitryK]
For now, there is no external pthread library.
It did not have been discussed generally in the techboard. As it is using the Unix pthread API, it sounds more logical to have this implementation in the Unix sub-directory I think.
Quoted 3 lines
lib/librte_eal/common/meson.build +1
-0+ 'rte_thread.c',
[...]
lib/librte_eal/include/meson.build headers += files( · line 43
Quoted 3 lines
lib/librte_eal/include/meson.build +1
-0+ 'rte_thread.h',
There are existing functions in rte_lcore.h and rte_per_lcore.h which are managing threads.
I think a prior patch should move such functions in rte_thread files. At least we can start moving the affinity functions,
which are not using pthread types as parameters.
lib/librte_eal/include/rte_thread.h line 5
Quoted 8 lines
lib/librte_eal/include/rte_thread.h new file +5
-0@@ -0,0 +1,88 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright(c) 2020 Mellanox Technologies, Ltd +*/ + +#include <rte_compat.h>
Why do you need rte_compat?
lib/librte_eal/include/rte_thread.h line 27
Quoted 5 lines
lib/librte_eal/include/rte_thread.h new file +5
-0+/** +* Function to create a TLS data key visible to all threads in the process +* function need to be called once to create a key usable by all threads. +* rte_tls_key is an opaque pointer used to store the allocated key. +* and optional destructor can be set to be called when a thread expires.
You may explain that the key is later used to get/set a value.
lib/librte_eal/include/rte_thread.h line 33
Quoted 6 lines
lib/librte_eal/include/rte_thread.h new file +6
-0+* +* @param key +* Pointer to store the allocated rte_tls_key +* @param destructor +* The function to be called when the thread expires. +* Not supported on Windows OS.
What happens when specifying a destructor on Windows?
lib/librte_eal/include/rte_thread.h line 41
Quoted 8 lines
lib/librte_eal/include/rte_thread.h new file +8
-0+* +* @return +* On success, zero. +* On failure, a negative number. +*/ +__rte_experimental +int +rte_thread_tls_create_key (rte_tls_key *key,void (*destructor)(void *));
For .h files, we have the return type on the same line (I know it is stupid).
I would suggest moving the verb "create" at the end of the function names.
[...]
lib/librte_eal/include/rte_thread.h line 56
Quoted 1 line
lib/librte_eal/include/rte_thread.h new file +1
-0+rte_thread_tls_delete_key(rte_tls_key key);
Could be rte_thread_tls_key_delete?
[...]
lib/librte_eal/include/rte_thread.h line 72
Quoted 1 line
lib/librte_eal/include/rte_thread.h new file +1
-0+rte_thread_tls_set_value(rte_tls_key key, const void *value);
rte_thread_tls_value_set?
lib/librte_eal/include/rte_thread.h line 86
Quoted 1 line
lib/librte_eal/include/rte_thread.h new file +1
-0+rte_thread_tls_get_value(rte_tls_key key);
rte_thread_tls_value_get?
v7 cover support generic threading functions
In reply to Tal ShnaidermanAdd API for generic threading functions in EAL which do not reference pthread API.
Tal Shnaiderman (2):
eal: move thread affinity functions to new file
eal: add generic thread-local-storage functions
lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_lcore.h | 22 +------- lib/librte_eal/include/rte_thread.h | 107 ++++++++++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 ++ lib/librte_eal/unix/meson.build | 1 + lib/librte_eal/unix/rte_thread.c | 86 +++++++++++++++++++++++++++++ lib/librte_eal/version.map | 6 ++ lib/librte_eal/windows/meson.build | 1 + lib/librte_eal/windows/rte_thread.c | 83 ++++++++++++++++++++++++++++ 9 files changed, 291 insertions(+), 21 deletions(-) create mode 100644 lib/librte_eal/include/rte_thread.h create mode 100644 lib/librte_eal/unix/rte_thread.c create mode 100644 lib/librte_eal/windows/rte_thread.c
Signature · 1 line
2.16.1.windows.4
PATCH v7 1/2 eal: move thread affinity functions to new file
Move the definition of the functions rte_thread_set_affinity and rte_thread_get_affinity to new file, rte_thread.h
The file will implement generic threading functionality and will only host threading functions which do not reference pthread API.
--- lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_lcore.h | 22 +-------------------- lib/librte_eal/include/rte_thread.h | 39 +++++++++++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+), 21 deletions(-) create mode 100644 lib/librte_eal/include/rte_thread.h
lib/librte_eal/include/meson.build +1 -0
@@ -40,6 +40,7 @@ headers += files( 'rte_service_component.h', 'rte_string_fns.h', 'rte_tailq.h', + 'rte_thread.h', 'rte_time.h', 'rte_trace.h', 'rte_trace_point.h',
lib/librte_eal/include/rte_lcore.h +1 -21
@@ -15,6 +15,7 @@#include <rte_per_lcore.h> #include <rte_eal.h> #include <rte_launch.h> +#include <rte_thread.h> #ifdef __cplusplusextern "C" {
@@ -357,27 +358,6 @@ __rte_experimentalvoid rte_lcore_dump (FILE *f); -/** -* Set core affinity of the current thread. -* Support both EAL and non-EAL thread and update TLS. -* -* @param cpusetp -* Point to cpu_set_t for setting current thread affinity. -* @return -* On success, return 0; otherwise return -1; -*/ -int rte_thread_set_affinity (rte_cpuset_t *cpusetp); - -/** -* Get core affinity of the current thread. -* -* @param cpusetp -* Point to cpu_set_t for getting current thread cpu affinity. -* It presumes input is not NULL, otherwise it causes panic. -* -*/ -void rte_thread_get_affinity (rte_cpuset_t *cpusetp); -/** * Set thread names. *
lib/librte_eal/include/rte_thread.h new file +39 -0
@@ -0,0 +1,39 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright(c) 2021 Mellanox Technologies, Ltd +*/ + +#include <rte_os.h> + +#ifndef _RTE_THREAD_H_ +#define _RTE_THREAD_H_ + +/** +* @file +* +* Threading functions +* +* Simple threads functionality supplied by EAL. +*/ + +/** +* Set core affinity of the current thread. +* Support both EAL and non-EAL thread and update TLS. +* +* @param cpusetp +* Point to cpu_set_t for setting current thread affinity. +* @return +* On success, return 0; otherwise return -1; +*/ +int rte_thread_set_affinity (rte_cpuset_t *cpusetp); + +/** +* Get core affinity of the current thread. +* +* @param cpusetp +* Point to cpu_set_t for getting current thread cpu affinity. +* It presumes input is not NULL, otherwise it causes panic. +* +*/ +void rte_thread_get_affinity (rte_cpuset_t *cpusetp); + +#endif /* _RTE_THREAD_H_ */
Signature · 1 line
2.16.1.windows.4
Re: [dpdk-dev] [PATCH v7 1/2] eal: move thread affinity functions to new file
On Tue, 5 Jan 2021 19:06:34 +0200, Tal Shnaiderman wrote:
[...]
Quoted 6 lines
lib/librte_eal/include/rte_thread.h new file +0
-0
lib/librte_eal/include/rte_thread.h line 8
Quoted 8 lines
lib/librte_eal/include/rte_thread.h new file +8
-0@@ -0,0 +1,39 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright(c) 2021 Mellanox Technologies, Ltd +*/ + +#include <rte_os.h> + +#ifndef _RTE_THREAD_H_ +#define _RTE_THREAD_H_
#ifdef __cplusplus
extern "C" {
#endif
[...]
#ifdef __cplusplus
}
#endif
Quoted 1 line
lib/librte_eal/include/rte_thread.h new file +1
-0+#endif /* _RTE_THREAD_H_ */
v8 cover support generic threading functions
In reply to Tal ShnaidermanAdd API for generic threading functions in EAL which do not reference pthread API.
---
v8:
* Documentation and minor code changes (DmitryK).
---
Tal Shnaiderman (2):
eal: move thread affinity functions to new file
eal: add generic thread-local-storage functions
lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_lcore.h | 22 +------ lib/librte_eal/include/rte_thread.h | 113 ++++++++++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 ++ lib/librte_eal/unix/meson.build | 1 + lib/librte_eal/unix/rte_thread.c | 86 +++++++++++++++++++++++++++ lib/librte_eal/version.map | 6 ++ lib/librte_eal/windows/meson.build | 1 + lib/librte_eal/windows/rte_thread.c | 83 ++++++++++++++++++++++++++ 9 files changed, 297 insertions(+), 21 deletions(-) create mode 100644 lib/librte_eal/include/rte_thread.h create mode 100644 lib/librte_eal/unix/rte_thread.c create mode 100644 lib/librte_eal/windows/rte_thread.c
Signature · 1 line
2.16.1.windows.4
PATCH v8 1/2 eal: move thread affinity functions to new file
Move the definition of the functions rte_thread_set_affinity and rte_thread_get_affinity to new file, rte_thread.h
The file will implement generic threading functionality and will only host threading functions which do not reference pthread API.
--- lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_lcore.h | 22 +---------------- lib/librte_eal/include/rte_thread.h | 47 +++++++++++++++++++++++++++++++++++++ 3 files changed, 49 insertions(+), 21 deletions(-) create mode 100644 lib/librte_eal/include/rte_thread.h
lib/librte_eal/include/meson.build +1 -0
@@ -40,6 +40,7 @@ headers += files( 'rte_service_component.h', 'rte_string_fns.h', 'rte_tailq.h', + 'rte_thread.h', 'rte_time.h', 'rte_trace.h', 'rte_trace_point.h',
lib/librte_eal/include/rte_lcore.h +1 -21
@@ -15,6 +15,7 @@#include <rte_per_lcore.h> #include <rte_eal.h> #include <rte_launch.h> +#include <rte_thread.h> #ifdef __cplusplusextern "C" {
@@ -357,27 +358,6 @@ __rte_experimentalvoid rte_lcore_dump (FILE *f); -/** -* Set core affinity of the current thread. -* Support both EAL and non-EAL thread and update TLS. -* -* @param cpusetp -* Point to cpu_set_t for setting current thread affinity. -* @return -* On success, return 0; otherwise return -1; -*/ -int rte_thread_set_affinity (rte_cpuset_t *cpusetp); - -/** -* Get core affinity of the current thread. -* -* @param cpusetp -* Point to cpu_set_t for getting current thread cpu affinity. -* It presumes input is not NULL, otherwise it causes panic. -* -*/ -void rte_thread_get_affinity (rte_cpuset_t *cpusetp); -/** * Set thread names. *
lib/librte_eal/include/rte_thread.h new file +47 -0
47 lines not on this page · raw message
Signature · 1 line
2.16.1.windows.4
PATCH v8 2/2 eal: add generic thread-local-storage functions
In reply to Tal ShnaidermanAdd support for TLS functionality in EAL.
The following functions are added:rte_thread_tls_key_create - create a TLS data key. rte_thread_tls_key_delete - delete a TLS data key. rte_thread_tls_value_set - set value bound to the TLS key rte_thread_tls_value_get - get value bound to the TLS key
TLS key is defined by the new type rte_tls_key.
The API allocates the thread local storage (TLS) key. Any thread of the process can subsequently use this key to store and retrieve values that are local to the thread.
Those functions are added in addition to TLS capability in rte_per_lcore.h to allow abstraction of the pthread layer for all operating systems.
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
Unix implementation is under librte_eal/unix and
implemented using pthread for UNIX compilation.
---
v3: switch from pthread shim to generic eal implementation [DmitryK]
v4: modify file names, function names, move unix code to common for future external pthreads support [DmitryK]
v5: rename var used for external pthreads, add description in meson_options.txt. [DmitryK]
v6: remove external_pthread support as it collide with pthread shim implementation [DmitryK]
v7: move unix code to unix instead of common, rename functions add more documentation [Thomas]
--- lib/librte_eal/include/rte_thread.h | 66 ++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 +++ lib/librte_eal/unix/meson.build | 1 + lib/librte_eal/unix/rte_thread.c | 86 +++++++++++++++++++++++++++++++++++++ lib/librte_eal/version.map | 6 +++ lib/librte_eal/windows/meson.build | 1 + lib/librte_eal/windows/rte_thread.c | 83 +++++++++++++++++++++++++++++++++++ 7 files changed, 248 insertions(+) create mode 100644 lib/librte_eal/unix/rte_thread.c create mode 100644 lib/librte_eal/windows/rte_thread.c
lib/librte_eal/include/rte_thread.h +66 -0
@@ -19,6 +19,11 @@extern "C" {#endif +/** +* TLS key type, an opaque pointer. +*/ +typedef struct eal_tls_key *rte_tls_key ; +/** * Set core affinity of the current thread. * Support both EAL and non-EAL thread and update TLS.
@@ -40,6 +45,67 @@ int rte_thread_set_affinity(rte_cpuset_t *cpusetp);*/ void rte_thread_get_affinity (rte_cpuset_t *cpusetp); +/** +* Create a TLS data key visible to all threads in the process. +* the created key is later used to get/set a value. +* and optional destructor can be set to be called when a thread exits. +* +* @param key +* Pointer to store the allocated rte_tls_key +* @param destructor +* The function to be called when the thread exits. +* Ignored on Windows OS. +* +* @return +* On success, zero. +* On failure, a negative number. +*/ + +__rte_experimental +int rte_thread_tls_key_create(rte_tls_key *key, void (*destructor)(void *)); + +/** +* Delete a TLS data key visible to all threads in the process +* rte_tls_key is the opaque pointer allocated by rte_thread_tls_key_create. +* +* @param key +* The rte_tls_key allocated by rte_thread_tls_key_create(). +* +* @return +* On success, zero. +* On failure, a negative number. +*/ +__rte_experimental +int rte_thread_tls_key_delete(rte_tls_key key); + +/** +* Set value bound to the TLS key on behalf of the calling thread +* +* @param key +* The rte_tls_key key allocated by rte_thread_tls_key_create. +* @param value +* The value bound to the rte_tls_key key for the calling thread. +* +* @return +* On success, zero. +* On failure, a negative number. +*/ +__rte_experimental +int rte_thread_tls_value_set(rte_tls_key key, const void *value); + +/** +* Get value bound to the TLS key on behalf of the calling thread +* +* @param key +* The rte_tls_key key allocated by rte_thread_tls_key_create. +* +* @return +* On success, value data pointer (can also be NULL). +* On failure, NULL and an error number is set in rte_errno. +*/ +__rte_experimental +void *rte_thread_tls_value_get(rte_tls_key key); + #ifdef __cplusplus }#endif
lib/librte_eal/rte_eal_exports.def +5 -0
@@ -306,6 +306,11 @@ EXPORTS rte_vect_get_max_simd_bitwidth rte_vect_set_max_simd_bitwidth + rte_thread_tls_key_create + rte_thread_tls_key_delete + rte_thread_tls_value_set + rte_thread_tls_value_get + rte_mem_lock rte_mem_map rte_mem_page_size
lib/librte_eal/unix/meson.build +1 -0
@@ -5,4 +5,5 @@ sources += files( 'eal_file.c', 'eal_unix_memory.c', 'eal_unix_timer.c', + 'rte_thread.c', )
lib/librte_eal/unix/rte_thread.c new file +86 -0
86 lines not on this page · raw message
lib/librte_eal/version.map +6 -0
@@ -403,6 +403,12 @@ EXPERIMENTAL { rte_service_lcore_may_be_active; rte_vect_get_max_simd_bitwidth; rte_vect_set_max_simd_bitwidth; + + # added in 21.02 + rte_thread_tls_key_create; + rte_thread_tls_key_delete; + rte_thread_tls_value_set; + rte_thread_tls_value_get; }; INTERNAL {
lib/librte_eal/windows/meson.build +1 -0
@@ -19,6 +19,7 @@ sources += files( 'eal_timer.c', 'fnmatch.c', 'getopt.c', + 'rte_thread.c', ) dpdk_conf.set10('RTE_EAL_NUMA_AWARE_HUGEPAGES', true)
lib/librte_eal/windows/rte_thread.c new file +83 -0
83 lines not on this page · raw message
Signature · 1 line
2.16.1.windows.4
Re: [dpdk-dev] [PATCH v8 2/2] eal: add generic thread-local-storage functions
On Wed, 6 Jan 2021 21:45:43 +0200, Tal Shnaiderman wrote:
[...]
Quoted 3 lines
+/**
+ * Delete a TLS data key visible to all threads in the process
+ *rte_tls_keyis the opaque pointer allocated byrte_thread_tls_key_create.
This line repeats @param key description.
Quoted 10 lines
+ *
+ * @param key
+ * Therte_tls_keyallocated byrte_thread_tls_key_create().
+ *
+ * @return
+ * On success, zero.
+ * On failure, a negative number.
+ */(quoted diff) +2
-0+__rte_experimental +int rte_thread_tls_key_delete(rte_tls_key key);
[...]
lib/librte_eal/unix/rte_thread.c line 24
Quoted 11 lines
lib/librte_eal/unix/rte_thread.c new file +11
-0+ +struct eal_tls_key { +pthread_key_t thread_index; +}; + +int +rte_thread_tls_key_create (rte_tls_key *key,void (*destructor)(void *)) +{ +int err; + + *key =malloc (sizeof (*key));
Should be sizeof(**key), which would be sizeof(struct eal_tls_key), as needed. Same for Windows file.
I had to double-check my comment on v7.
Re: [dpdk-dev] [PATCH v8 2/2] eal: add generic thread-local-storage functions
Quoted 26 lines
Subject: Re: [PATCH v8 2/2] eal: add generic thread-local-storage functions
External email: Use caution opening links or attachments
On Wed, 6 Jan 2021 21:45:43 +0200, Tal Shnaiderman wrote:
[...]Quoted 3 lines
+/**
+ * Delete a TLS data key visible to all threads in the process
+ *rte_tls_keyis the opaque pointer allocated by
rte_thread_tls_key_create.This line repeats @param key description.
Quoted 10 lines
+ *
+ * @param key
+ * Therte_tls_keyallocated byrte_thread_tls_key_create().
+ *
+ * @return
+ * On success, zero.
+ * On failure, a negative number.
+ */(quoted diff) +2
-0+__rte_experimental +int rte_thread_tls_key_delete(rte_tls_key key);[...]
Quoted 16 lines
lib/librte_eal/unix/rte_thread.c line 24
Quoted 11 lines
lib/librte_eal/unix/rte_thread.c new file +11
-0+ +struct eal_tls_key { +pthread_key_t thread_index; +}; + +int +rte_thread_tls_key_create (rte_tls_key *key,void (*destructor)(void +*)) { +int err; + + *key =malloc (sizeof (*key));Should be
sizeof(**key), which would besizeof(struct eal_tls_key), as needed.
Same for Windows file.
I had to double-check my comment on v7.
Thanks, missed this one as well, sending v9.
v9 cover support generic threading functions
In reply to Tal ShnaidermanAdd API for generic threading functions in EAL which do not reference pthread API.
---
v8:
* Documentation and minor code changes (DmitryK).
v9:
* Fix sizeof value in key creation, docu change (DmitryK)
---
Tal Shnaiderman (2):
eal: move thread affinity functions to new file
eal: add generic thread-local-storage functions
lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_lcore.h | 22 +------ lib/librte_eal/include/rte_thread.h | 112 ++++++++++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 ++ lib/librte_eal/unix/meson.build | 1 + lib/librte_eal/unix/rte_thread.c | 86 +++++++++++++++++++++++++++ lib/librte_eal/version.map | 6 ++ lib/librte_eal/windows/meson.build | 1 + lib/librte_eal/windows/rte_thread.c | 83 ++++++++++++++++++++++++++ 9 files changed, 296 insertions(+), 21 deletions(-) create mode 100644 lib/librte_eal/include/rte_thread.h create mode 100644 lib/librte_eal/unix/rte_thread.c create mode 100644 lib/librte_eal/windows/rte_thread.c
Signature · 1 line
2.16.1.windows.4
PATCH v9 1/2 eal: move thread affinity functions to new file
Move the definition of the functions rte_thread_set_affinity and rte_thread_get_affinity to new file, rte_thread.h
The file will implement generic threading functionality and will only host threading functions which do not reference pthread API.
--- lib/librte_eal/include/meson.build | 1 + lib/librte_eal/include/rte_lcore.h | 22 +---------------- lib/librte_eal/include/rte_thread.h | 47 +++++++++++++++++++++++++++++++++++++ 3 files changed, 49 insertions(+), 21 deletions(-) create mode 100644 lib/librte_eal/include/rte_thread.h
lib/librte_eal/include/meson.build +1 -0
@@ -40,6 +40,7 @@ headers += files( 'rte_service_component.h', 'rte_string_fns.h', 'rte_tailq.h', + 'rte_thread.h', 'rte_time.h', 'rte_trace.h', 'rte_trace_point.h',
lib/librte_eal/include/rte_lcore.h +1 -21
@@ -15,6 +15,7 @@#include <rte_per_lcore.h> #include <rte_eal.h> #include <rte_launch.h> +#include <rte_thread.h> #ifdef __cplusplusextern "C" {
@@ -357,27 +358,6 @@ __rte_experimentalvoid rte_lcore_dump (FILE *f); -/** -* Set core affinity of the current thread. -* Support both EAL and non-EAL thread and update TLS. -* -* @param cpusetp -* Point to cpu_set_t for setting current thread affinity. -* @return -* On success, return 0; otherwise return -1; -*/ -int rte_thread_set_affinity (rte_cpuset_t *cpusetp); - -/** -* Get core affinity of the current thread. -* -* @param cpusetp -* Point to cpu_set_t for getting current thread cpu affinity. -* It presumes input is not NULL, otherwise it causes panic. -* -*/ -void rte_thread_get_affinity (rte_cpuset_t *cpusetp); -/** * Set thread names. *
lib/librte_eal/include/rte_thread.h new file +47 -0
47 lines not on this page · raw message
Signature · 1 line
2.16.1.windows.4
PATCH v9 2/2 eal: add generic thread-local-storage functions
In reply to Tal ShnaidermanAdd support for TLS functionality in EAL.
The following functions are added:rte_thread_tls_key_create - create a TLS data key. rte_thread_tls_key_delete - delete a TLS data key. rte_thread_tls_value_set - set value bound to the TLS key rte_thread_tls_value_get - get value bound to the TLS key
TLS key is defined by the new type rte_tls_key.
The API allocates the thread local storage (TLS) key. Any thread of the process can subsequently use this key to store and retrieve values that are local to the thread.
Those functions are added in addition to TLS capability in rte_per_lcore.h to allow abstraction of the pthread layer for all operating systems.
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
Unix implementation is under librte_eal/unix and
implemented using pthread for UNIX compilation.
---
v3: switch from pthread shim to generic eal implementation [DmitryK]
v4: modify file names, function names, move unix code to common for future external pthreads support [DmitryK]
v5: rename var used for external pthreads, add description in meson_options.txt. [DmitryK]
v6: remove external_pthread support as it collide with pthread shim implementation [DmitryK]
v7: move unix code to unix instead of common, rename functions add more documentation [Thomas]
--- lib/librte_eal/include/rte_thread.h | 65 ++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 +++ lib/librte_eal/unix/meson.build | 1 + lib/librte_eal/unix/rte_thread.c | 86 +++++++++++++++++++++++++++++++++++++ lib/librte_eal/version.map | 6 +++ lib/librte_eal/windows/meson.build | 1 + lib/librte_eal/windows/rte_thread.c | 83 +++++++++++++++++++++++++++++++++++ 7 files changed, 247 insertions(+) create mode 100644 lib/librte_eal/unix/rte_thread.c create mode 100644 lib/librte_eal/windows/rte_thread.c
lib/librte_eal/include/rte_thread.h +65 -0
@@ -19,6 +19,11 @@extern "C" {#endif +/** +* TLS key type, an opaque pointer. +*/ +typedef struct eal_tls_key *rte_tls_key ; +/** * Set core affinity of the current thread. * Support both EAL and non-EAL thread and update TLS.
@@ -40,6 +45,66 @@ int rte_thread_set_affinity(rte_cpuset_t *cpusetp);*/ void rte_thread_get_affinity (rte_cpuset_t *cpusetp); +/** +* Create a TLS data key visible to all threads in the process. +* the created key is later used to get/set a value. +* and optional destructor can be set to be called when a thread exits. +* +* @param key +* Pointer to store the allocated rte_tls_key +* @param destructor +* The function to be called when the thread exits. +* Ignored on Windows OS. +* +* @return +* On success, zero. +* On failure, a negative number. +*/ + +__rte_experimental +int rte_thread_tls_key_create(rte_tls_key *key, void (*destructor)(void *)); + +/** +* Delete a TLS data key visible to all threads in the process. +* +* @param key +* The rte_tls_key allocated by rte_thread_tls_key_create(). +* +* @return +* On success, zero. +* On failure, a negative number. +*/ +__rte_experimental +int rte_thread_tls_key_delete(rte_tls_key key); + +/** +* Set value bound to the TLS key on behalf of the calling thread. +* +* @param key +* The rte_tls_key key allocated by rte_thread_tls_key_create. +* @param value +* The value bound to the rte_tls_key key for the calling thread. +* +* @return +* On success, zero. +* On failure, a negative number. +*/ +__rte_experimental +int rte_thread_tls_value_set(rte_tls_key key, const void *value); + +/** +* Get value bound to the TLS key on behalf of the calling thread. +* +* @param key +* The rte_tls_key key allocated by rte_thread_tls_key_create. +* +* @return +* On success, value data pointer (can also be NULL). +* On failure, NULL and an error number is set in rte_errno. +*/ +__rte_experimental +void *rte_thread_tls_value_get(rte_tls_key key); + #ifdef __cplusplus }#endif
lib/librte_eal/rte_eal_exports.def +5 -0
@@ -306,6 +306,11 @@ EXPORTS rte_vect_get_max_simd_bitwidth rte_vect_set_max_simd_bitwidth + rte_thread_tls_key_create + rte_thread_tls_key_delete + rte_thread_tls_value_set + rte_thread_tls_value_get + rte_mem_lock rte_mem_map rte_mem_page_size
lib/librte_eal/unix/meson.build +1 -0
@@ -5,4 +5,5 @@ sources += files( 'eal_file.c', 'eal_unix_memory.c', 'eal_unix_timer.c', + 'rte_thread.c', )
lib/librte_eal/unix/rte_thread.c new file +86 -0
86 lines not on this page · raw message
lib/librte_eal/version.map +6 -0
@@ -403,6 +403,12 @@ EXPERIMENTAL { rte_service_lcore_may_be_active; rte_vect_get_max_simd_bitwidth; rte_vect_set_max_simd_bitwidth; + + # added in 21.02 + rte_thread_tls_key_create; + rte_thread_tls_key_delete; + rte_thread_tls_value_set; + rte_thread_tls_value_get; }; INTERNAL {
lib/librte_eal/windows/meson.build +1 -0
@@ -19,6 +19,7 @@ sources += files( 'eal_timer.c', 'fnmatch.c', 'getopt.c', + 'rte_thread.c', ) dpdk_conf.set10('RTE_EAL_NUMA_AWARE_HUGEPAGES', true)
lib/librte_eal/windows/rte_thread.c new file +83 -0
83 lines not on this page · raw message
Signature · 1 line
2.16.1.windows.4
Re: [dpdk-dev] [PATCH v9 2/2] eal: add generic thread-local-storage functions
On Wed, 6 Jan 2021 22:35:53 +0200, Tal Shnaiderman wrote:
[...]
lib/librte_eal/unix/rte_thread.c line 26
Quoted 8 lines
lib/librte_eal/unix/rte_thread.c new file +8
-0+int +rte_thread_tls_key_create (rte_tls_key *key,void (*destructor)(void *)) +{ +int err; + + *key =malloc (sizeof (**key)); +if ((*key) ==NULL ) { +RTE_LOG (DEBUG ,EAL ,"Cannot allocate TLS key." );
Missing "\n", same for Windows part.
Aside from this nit, for series,
Re: [dpdk-dev] [PATCH v9 2/2] eal: add generic thread-local-storage functions
In reply to Tal ShnaidermanQuoted 18 lines · Tal Shnaiderman
Add support for TLS functionality in EAL.
The following functions are added:
rte_thread_tls_key_create- create a TLS data key.rte_thread_tls_key_delete- delete a TLS data key.rte_thread_tls_value_set- set value bound to the TLS keyrte_thread_tls_value_get- get value bound to the TLS keyTLS key is defined by the new type
rte_tls_key.The API allocates the thread local storage (TLS) key. Any thread of the process can subsequently use this key to store and retrieve values that are local to the thread.
Those functions are added in addition to TLS capability in
rte_per_lcore.hto allow abstraction of the pthread layer for all operating systems.
Quoted 8 lines
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
Unix implementation is under librte_eal/unix and implemented using pthread for UNIX compilation.
Signed-off-by Tal Shnaiderman <[email protected]>---
I'm a bit late to the party as the patch has been merged already, but perhaps as a further enhancement, you could add rte_errno setting for errors? You seem to have it only for get() API but not for others, and you pass pthread_setspecific()'s return value unmodified, even though it might return an error. Presumably, these error codes would be different on Unix and Windows, so return values would effectively be potentially different on different OS's, so perhaps it's better to return -1 with rte_errno to indicate which specific error was seen.
Signature · 2 lines
Thanks, Anatoly
Re: [dpdk-dev] [PATCH v9 2/2] eal: add generic thread-local-storage functions
Hi Tal,
Quoted 10 lines · Anatoly
Quoted 9 lines · Tal Shnaiderman
Add support for TLS functionality in EAL.
The following functions are added:
rte_thread_tls_key_create- create a TLS data key.rte_thread_tls_key_delete- delete a TLS data key.rte_thread_tls_value_set- set value bound to the TLS keyrte_thread_tls_value_get- get value bound to the TLS keyTLS key is defined by the new type
rte_tls_key.
I would suggest changing rte_tls_key to rte_thread_tls_key so that it is consistent with the API and not confused with transport layer security.
Quoted 18 lines
Quoted 17 lines
The API allocates the thread local storage (TLS) key. Any thread of the process can subsequently use this key to store and retrieve values that are local to the thread.
Those functions are added in addition to TLS capability in
rte_per_lcore.hto allow abstraction of the pthread layer for all operating systems.Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
Unix implementation is under librte_eal/unix and implemented using pthread for UNIX compilation.
Signed-off-by Tal Shnaiderman <[email protected]>---
Signature · 2 lines
Regards, Vladimir
Re: [dpdk-dev] [PATCH v9 2/2] eal: add generic thread-local-storage functions
Quoted 18 lines
Subject: Re: [dpdk-dev] [PATCH v9 2/2] eal: add generic thread-local-storage functions
External email: Use caution opening links or attachments
Hi Tal,
Quoted 9 lines · Anatoly
Quoted 8 lines · Tal Shnaiderman
Add support for TLS functionality in EAL.
The following functions are added:
rte_thread_tls_key_create- create a TLS data key.rte_thread_tls_key_delete- delete a TLS data key.rte_thread_tls_value_set- set value bound to the TLS keyrte_thread_tls_value_get- get value bound to the TLS key
Quoted 5 lines
Quoted 1 line
Quoted 1 line
TLS key is defined by the new type
rte_tls_key.I would suggest changing
rte_tls_keytorte_thread_tls_keyso that it is consistent with the API and not confused with transport layer security.
Thanks Vladimir, will modify for 21.05.
Quoted 22 lines
Quoted 9 lines
Quoted 9 lines
The API allocates the thread local storage (TLS) key.
Any thread of the process can subsequently use this key to store and retrieve values that are local to the thread.Those functions are added in addition to TLS capability in
rte_per_lcore.hto allow abstraction of the pthread layer for all operating systems.Quoted 9 lines
Quoted 8 lines
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
Unix implementation is under librte_eal/unix and implemented using pthread for UNIX compilation.
Signed-off-by Tal Shnaiderman <[email protected]>---
--
Regards,
Vladimir
Re: [dpdk-dev] [PATCH v9 2/2] eal: add generic thread-local-storage functions
In reply to Burakov, AnatolyQuoted 34 lines
Subject: Re: [dpdk-dev] [PATCH v9 2/2] eal: add generic thread-local-storage functions
External email: Use caution opening links or attachments
Quoted 18 lines · Tal Shnaiderman
Add support for TLS functionality in EAL.
The following functions are added:
rte_thread_tls_key_create- create a TLS data key.rte_thread_tls_key_delete- delete a TLS data key.rte_thread_tls_value_set- set value bound to the TLS keyrte_thread_tls_value_get- get value bound to the TLS keyTLS key is defined by the new type
rte_tls_key.The API allocates the thread local storage (TLS) key.
Any thread of the process can subsequently use this key to store and retrieve values that are local to the thread.Those functions are added in addition to TLS capability in
rte_per_lcore.hto allow abstraction of the pthread layer for all operating systems.Quoted 8 lines
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
Unix implementation is under librte_eal/unix and implemented using pthread for UNIX compilation.
Signed-off-by Tal Shnaiderman <[email protected]>---
Quoted 9 lines
I'm a bit late to the party as the patch has been merged already, but perhaps as a further enhancement, you could add
rte_errnosetting for errors? You seem to have it only forget()API but not for others, and you pass pthread_setspecific()'s return value unmodified, even though it might return an error. Presumably, these error codes would be different on Unix and Windows, so return values would effectively be potentially different on different OS's, so perhaps it's better to return -1 withrte_errnoto indicate which specific error was seen.
Thanks Anatoly, I'll add the error codes to rte_errno in 21.05.
Quoted 3 lines
--
Thanks,
Anatoly
Re: [dpdk-dev] [PATCH v9 0/2] support generic threading functions
In reply to Tal Shnaiderman06/01/2021 21:35, Tal Shnaiderman:
Quoted 3 lines
Tal Shnaiderman (2):
eal: move thread affinity functions to new file
eal: add generic thread-local-storage functions
Acked and applied with required minor changes, thanks.
PATCH v7 2/2 eal: add generic thread-local-storage functions
In reply to Tal ShnaidermanAdd support for TLS functionality in EAL.
The following functions are added:rte_thread_tls_key_create - function to create a TLS data key. rte_thread_tls_key_delete - function to delete a TLS data key. rte_thread_tls_value_set - function to set value bound to the TLS key rte_thread_tls_value_get - function to get value bound to the TLS key
TLS key will be defined by the new type rte_tls_key.
The API Allocates the thread local storage (TLS) key. Any thread of the process can subsequently use this key to store and retrieve values that are local to the thread.
Those functions are added in addition to TLS capability in rte_per_lcore.h to allow user to use the thread reasouce destruction capability in rte_thread_tls_key_create.
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
common implementation is under librte_eal/common and implemented using pthread for UNIX compilation.
---
v3: switch from pthread shim to generic eal implementation [DmitryK]
v4: modify file names, function names, move unix code to common for future external pthreads support [DmitryK]
v5: rename var used for external pthreads, add description in meson_options.txt. [DmitryK]
v6: remove external_pthread support as it collide with pthread shim implementation [DmitryK]
v7: move unix code to unix instead of common, rename functions add more documentation [Thomas]
--- lib/librte_eal/include/rte_thread.h | 68 +++++++++++++++++++++++++++++ lib/librte_eal/rte_eal_exports.def | 5 +++ lib/librte_eal/unix/meson.build | 1 + lib/librte_eal/unix/rte_thread.c | 86 +++++++++++++++++++++++++++++++++++++ lib/librte_eal/version.map | 6 +++ lib/librte_eal/windows/meson.build | 1 + lib/librte_eal/windows/rte_thread.c | 83 +++++++++++++++++++++++++++++++++++ 7 files changed, 250 insertions(+) create mode 100644 lib/librte_eal/unix/rte_thread.c create mode 100644 lib/librte_eal/windows/rte_thread.c
lib/librte_eal/include/rte_thread.h +68 -0
@@ -15,6 +15,11 @@* Simple threads functionality supplied by EAL. */ +/** +* Opaque pointer for TLS key. +*/ +typedef struct eal_tls_key *rte_tls_key ; +/** * Set core affinity of the current thread. * Support both EAL and non-EAL thread and update TLS.
@@ -36,4 +41,67 @@ int rte_thread_set_affinity(rte_cpuset_t *cpusetp);*/ void rte_thread_get_affinity (rte_cpuset_t *cpusetp); +/** +* Function to create a TLS data key visible to all threads in the process +* function need to be called once to create a key usable by all threads. +* rte_tls_key is an opaque pointer used to store the allocated key. +* which is later used to get/set a value. +* and optional destructor can be set to be called when a thread expires. +* +* @param key +* Pointer to store the allocated rte_tls_key +* @param destructor +* The function to be called when the thread expires. +* Ignored on Windows OS. +* +* @return +* On success, zero. +* On failure, a negative number. +*/ + +__rte_experimental +int rte_thread_tls_key_create(rte_tls_key *key, void (*destructor)(void *)); + +/** +* Function to delete a TLS data key visible to all threads in the process +* rte_tls_key is the opaque pointer allocated by rte_thread_tls_key_create. +* +* @param key +* The rte_tls_key will contain the allocated key +* +* @return +* On success, zero. +* On failure, a negative number. +*/ +__rte_experimental +int rte_thread_tls_key_delete(rte_tls_key key); + +/** +* Function to set value bound to the tls key on behalf of the calling thread +* +* @param key +* The rte_tls_key key allocated by rte_thread_tls_key_create. +* @param value +* The value bound to the rte_tls_key key for the calling thread. +* +* @return +* On success, zero. +* On failure, a negative number. +*/ +__rte_experimental +int rte_thread_tls_value_set(rte_tls_key key, const void *value); + +/** +* Function to get value bound to the tls key on behalf of the calling thread +* +* @param key +* The rte_tls_key key allocated by rte_thread_tls_key_create. +* +* @return +* On success, value data pointer (can also be NULL). +* On failure, NULL and an error number is set in rte_errno. +*/ +__rte_experimental +void *rte_thread_tls_value_get(rte_tls_key key); +#endif /* _RTE_THREAD_H_ */
lib/librte_eal/rte_eal_exports.def +5 -0
@@ -306,6 +306,11 @@ EXPORTS rte_vect_get_max_simd_bitwidth rte_vect_set_max_simd_bitwidth + rte_thread_tls_key_create + rte_thread_tls_key_delete + rte_thread_tls_value_set + rte_thread_tls_value_get + rte_mem_lock rte_mem_map rte_mem_page_size
lib/librte_eal/unix/meson.build +1 -0
@@ -5,4 +5,5 @@ sources += files( 'eal_file.c', 'eal_unix_memory.c', 'eal_unix_timer.c', + 'rte_thread.c', )
lib/librte_eal/unix/rte_thread.c new file +86 -0
86 lines not on this page · raw message
lib/librte_eal/version.map +6 -0
@@ -403,6 +403,12 @@ EXPERIMENTAL { rte_service_lcore_may_be_active; rte_vect_get_max_simd_bitwidth; rte_vect_set_max_simd_bitwidth; + + # added in 21.02 + rte_thread_tls_key_create; + rte_thread_tls_key_delete; + rte_thread_tls_value_set; + rte_thread_tls_value_get; }; INTERNAL {
lib/librte_eal/windows/meson.build +1 -0
@@ -19,6 +19,7 @@ sources += files( 'eal_timer.c', 'fnmatch.c', 'getopt.c', + 'rte_thread.c', ) dpdk_conf.set10('RTE_EAL_NUMA_AWARE_HUGEPAGES', true)
lib/librte_eal/windows/rte_thread.c new file +83 -0
83 lines not on this page · raw message
Signature · 1 line
2.16.1.windows.4
Re: [dpdk-dev] [PATCH v7 2/2] eal: add generic thread-local-storage functions
Quoted 7 lines · Tal Shnaiderman
Add support for TLS functionality in EAL.
The following functions are added:
rte_thread_tls_key_create- function to create a TLS data key.rte_thread_tls_key_delete- function to delete a TLS data key.rte_thread_tls_value_set- function to set value bound to the TLS keyrte_thread_tls_value_get- function to get value bound to the TLS key
"Function to" is redundant both here and in Doxygen comments.
Quoted 1 line
TLS key will be defined by the new type
rte_tls_key.
Please use present tense when describing patch content.
Quoted 1 line
The API Allocates the thread local storage (TLS) key.
Typo: "allocates".
Quoted 6 lines
Any thread of the process can subsequently use this key to store and retrieve values that are local to the thread.
Those functions are added in addition to TLS capability in
rte_per_lcore.hto allow user to use the thread reasouce destruction capability inrte_thread_tls_key_create.
Err, I assumed we're abstracting pthread, otherwise the capability has already been there. Also, a typo: "resource".
Quoted 5 lines
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
common implementation is under librte_eal/common and implemented using pthread for UNIX compilation.
librte_eal/unix
[...]
lib/librte_eal/include/rte_thread.h line 21
Quoted 4 lines
lib/librte_eal/include/rte_thread.h +4
-0+/** +* Opaque pointer for TLS key. +*/ +typedef struct eal_tls_key *rte_tls_key ;
Suggesting "TLS key type, an opaque pointer". Now it's unclear if there's a TLS key and a pointer to it or TLS key is an opaque pointer itself (which is the case, API-wise).
lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp); · line 46
Quoted 11 lines
lib/librte_eal/include/rte_thread.h +4
-0+/** * Set core affinity of the current thread. * Support both EAL and non-EAL thread and update TLS. @@ -36,4 +41,67 @@ int rte_thread_set_affinity(rte_cpuset_t *cpusetp);*/ void rte_thread_get_affinity (rte_cpuset_t *cpusetp); +/** +* Function to create a TLS data key visible to all threads in the process +* function need to be called once to create a key usable by all threads.
The sentences repeat each other and are not separated.
lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp); · line 49
Quoted 3 lines
lib/librte_eal/include/rte_thread.h +3
-0+* rte_tls_key is an opaque pointer used to store the allocated key. +* which is later used to get/set a value. +* and optional destructor can be set to be called when a thread expires.
"expires" -> "exits", here and below.
No need to repeat parameter description in function description.
Quoted 12 lines
lib/librte_eal/include/rte_thread.h +12
-0+* +* @param key +* Pointer to store the allocated rte_tls_key +* @param destructor +* The function to be called when the thread expires. +* Ignored on Windows OS. +* +* @return +* On success, zero. +* On failure, a negative number. +*/ +
lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp); · line 70
Quoted 10 lines
lib/librte_eal/include/rte_thread.h +9
-0+__rte_experimental +int rte_thread_tls_key_create(rte_tls_key *key, void (*destructor)(void *)); + +/** +* Function to delete a TLS data key visible to all threads in the process +* rte_tls_key is the opaque pointer allocated by rte_thread_tls_key_create. +* +* @param key +* The rte_tls_key will contain the allocated key
"Will"? It's an rte_tls_key key allocated by rte_thread_tls_key_create().
lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp); · line 80
Quoted 10 lines
lib/librte_eal/include/rte_thread.h +9
-0+* +* @return +* On success, zero. +* On failure, a negative number. +*/ +__rte_experimental +int rte_thread_tls_key_delete(rte_tls_key key); +/** +* Function to set value bound to the tls key on behalf of the calling thread
"tls" -> "TLS"
Quoted 10 lines
+ *
+ * @param key
+ * Therte_tls_keykey allocated byrte_thread_tls_key_create.
+ * @param value
+ * The value bound to therte_tls_keykey for the calling thread.
+ *
+ * @return
+ * On success, zero.
+ * On failure, a negative number.
+ */
lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp); · line 95
Quoted 5 lines
lib/librte_eal/include/rte_thread.h +5
-0+__rte_experimental +int rte_thread_tls_value_set(rte_tls_key key, const void *value); + +/** +* Function to get value bound to the tls key on behalf of the calling thread
"tls" -> "TLS"
Quoted 27 lines
+ *
+ * @param key
+ * Therte_tls_keykey allocated byrte_thread_tls_key_create.
+ *
+ * @return
+ * On success, value data pointer (can also be NULL).
+ * On failure, NULL and an error number is set inrte_errno.
+ */lib/librte_eal/include/rte_thread.h +3
-0+__rte_experimental +void *rte_thread_tls_value_get(rte_tls_key key); +#endif /* _RTE_THREAD_H_ */ lib/librte_eal/windows/rte_thread.c new file +8
-0@@ -0,0 +1,83 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#include <rte_common.h> +#include <rte_errno.h> +#include <rte_thread.h> +#include <rte_windows.h>
lib/librte_eal/windows/rte_thread.c line 18
Quoted 10 lines
lib/librte_eal/windows/rte_thread.c new file +10
-0+ +struct eal_tls_key { +DWORD thread_index; +}; + +int +rte_thread_tls_key_create (rte_tls_key *key, + __rte_unused void (*destructor)(void *)) +{ + *key =malloc (sizeof (struct eal_tls_key ));
sizeof(*key)
lib/librte_eal/windows/rte_thread.c line 20
Quoted 2 lines
lib/librte_eal/windows/rte_thread.c new file +2
-0+if ((*key) ==NULL ) { +RTE_LOG (DEBUG ,EAL ,"Cannot allocate tls key." );
"tls" -> "TLS"
Quoted 6 lines
lib/librte_eal/windows/rte_thread.c new file +6
-0+return -1 ; + } + (*key)->thread_index =TlsAlloc (); +if ((*key)->thread_index ==TLS_OUT_OF_INDEXES ) { +RTE_LOG_WIN32_ERR ("TlsAlloc()" ); +free (*key);
lib/librte_eal/windows/rte_thread.c line 36
Quoted 10 lines
lib/librte_eal/windows/rte_thread.c new file +10
-0+return -1 ; + } +return 0 ; +} + +int +rte_thread_tls_key_delete (rte_tls_key key) +{ +if (!key) { +RTE_LOG (DEBUG ,EAL ,"invalid tls key passed to function.\n" );
"tls" -> "TLS"
Messages should start with a capital letter.
To which "function"?
Quoted 10 lines
lib/librte_eal/windows/rte_thread.c new file +10
-0+return -1 ; + } +if (!TlsFree (key->thread_index)) { +RTE_LOG_WIN32_ERR ("TlsFree()" ); +free (key); +return -1 ; + } +free (key); +return 0 ; +}
Re: [dpdk-dev] [PATCH v7 2/2] eal: add generic thread-local-storage functions
Quoted 193 lines
Subject: Re: [PATCH v7 2/2] eal: add generic thread-local-storage functions
External email: Use caution opening links or attachments
Quoted 7 lines · Tal Shnaiderman
Add support for TLS functionality in EAL.
The following functions are added:
rte_thread_tls_key_create- function to create a TLS data key.rte_thread_tls_key_delete- function to delete a TLS data key.rte_thread_tls_value_set- function to set value bound to the TLS keyrte_thread_tls_value_get- function to get value bound to the TLS key"Function to" is redundant both here and in Doxygen comments.
Quoted 1 line
TLS key will be defined by the new type
rte_tls_key.Please use present tense when describing patch content.
Quoted 1 line
The API Allocates the thread local storage (TLS) key.
Typo: "allocates".
Quoted 6 lines
Any thread of the process can subsequently use this key to store and retrieve values that are local to the thread.
Those functions are added in addition to TLS capability in
rte_per_lcore.hto allow user to use the thread reasouce destruction capability inrte_thread_tls_key_create.Err, I assumed we're abstracting pthread, otherwise the capability has already been there. Also, a typo: "resource".
Quoted 4 lines
Windows implementation is under librte_eal/windows and implemented using WIN32 API for Windows only.
common implementation is under librte_eal/common and implemented
using
Quoted 1 line
pthread for UNIX compilation.
librte_eal/unix
[...]
lib/librte_eal/include/rte_thread.h line 21
Quoted 4 lines
lib/librte_eal/include/rte_thread.h +4
-0+/** +* Opaque pointer for TLS key. +*/ +typedef struct eal_tls_key *rte_tls_key ;Suggesting "TLS key type, an opaque pointer". Now it's unclear if there's a TLS key and a pointer to it or TLS key is an opaque pointer itself (which is the case, API-wise).
lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp); · line 47
Quoted 12 lines
lib/librte_eal/include/rte_thread.h +5
-0+/** * Set core affinity of the current thread. * Support both EAL and non-EAL thread and update TLS. @@ -36,4 +41,67 @@ int rte_thread_set_affinity(rte_cpuset_t *cpusetp);*/ void rte_thread_get_affinity (rte_cpuset_t *cpusetp); +/** +* Function to create a TLS data key visible to all threads in the +process +* function need to be called once to create a key usable by all threads. The sentences repeat each other and are not separated.
lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp); · line 49
Quoted 3 lines
lib/librte_eal/include/rte_thread.h +3
-0+* rte_tls_key is an opaque pointer used to store the allocated key. +* which is later used to get/set a value. +* and optional destructor can be set to be called when a thread expires. "expires" -> "exits", here and below.
No need to repeat parameter description in function description.
Quoted 11 lines
lib/librte_eal/include/rte_thread.h +11
-0+* +* @param key +* Pointer to store the allocated rte_tls_key +* @param destructor +* The function to be called when the thread expires. +* Ignored on Windows OS. +* +* @return +* On success, zero. +* On failure, a negative number. +*/ lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
Quoted 10 lines
lib/librte_eal/include/rte_thread.h +9
-0+ +__rte_experimental +int rte_thread_tls_key_create(rte_tls_key *key, void +(*destructor)(void *)); + +/** +* Function to delete a TLS data key visible to all threads in the +process +* rte_tls_key is the opaque pointer allocated by
rte_thread_tls_key_create.lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp); · line 70
Quoted 3 lines
lib/librte_eal/include/rte_thread.h +3
-0+* +* @param key +* The rte_tls_key will contain the allocated key "Will"? It's an
rte_tls_keykey allocated byrte_thread_tls_key_create().lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
Quoted 11 lines
lib/librte_eal/include/rte_thread.h +10
-0+* +* @return +* On success, zero. +* On failure, a negative number. +*/ +__rte_experimental +int rte_thread_tls_key_delete(rte_tls_key key); +/** +* Function to set value bound to the tls key on behalf of the +calling thread "tls" -> "TLS"
Quoted 10 lines
+ *
+ * @param key
+ * Therte_tls_keykey allocated byrte_thread_tls_key_create.
+ * @param value
+ * The value bound to therte_tls_keykey for the calling thread.
+ *
+ * @return
+ * On success, zero.
+ * On failure, a negative number.
+ */lib/librte_eal/include/rte_thread.h int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
Quoted 6 lines
lib/librte_eal/include/rte_thread.h +6
-0+__rte_experimental +int rte_thread_tls_value_set(rte_tls_key key, const void *value); + +/** +* Function to get value bound to the tls key on behalf of the +calling thread "tls" -> "TLS"
Quoted 26 lines
+ *
+ * @param key
+ * Therte_tls_keykey allocated byrte_thread_tls_key_create.
+ *
+ * @return
+ * On success, value data pointer (can also be NULL).
+ * On failure, NULL and an error number is set inrte_errno.
+ */lib/librte_eal/include/rte_thread.h +3
-0+__rte_experimental +void *rte_thread_tls_value_get(rte_tls_key key); +#endif /* _RTE_THREAD_H_ */ lib/librte_eal/windows/rte_thread.c new file +6
-0@@ -0,0 +1,83 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd */ + +#include <rte_common.h> +#include <rte_errno.h> +#include <rte_thread.h> lib/librte_eal/windows/rte_thread.c line 16
Quoted 10 lines
lib/librte_eal/windows/rte_thread.c new file +10
-0+#include <rte_windows.h> + +struct eal_tls_key { +DWORD thread_index; +}; + +int +rte_thread_tls_key_create (rte_tls_key *key, + __rte_unused void (*destructor)(void *)) { + *key =malloc (sizeof (struct eal_tls_key ));
sizeof(*key)lib/librte_eal/windows/rte_thread.c line 18
Quoted 2 lines
lib/librte_eal/windows/rte_thread.c new file +2
-0+if ((*key) ==NULL ) { +RTE_LOG (DEBUG ,EAL ,"Cannot allocate tls key." );"tls" -> "TLS"
Quoted 12 lines
lib/librte_eal/windows/rte_thread.c new file +12
-0+return -1 ; + } + (*key)->thread_index =TlsAlloc (); +if ((*key)->thread_index ==TLS_OUT_OF_INDEXES ) { +RTE_LOG_WIN32_ERR ("TlsAlloc()" ); +free (*key); +return -1 ; + } +return 0 ; +} + +int
Quoted 19 lines
lib/librte_eal/windows/rte_thread.c line 34
Quoted 4 lines
lib/librte_eal/windows/rte_thread.c new file +4
-0+rte_thread_tls_key_delete(rte_tls_key key) { +if (!key) { + RTE_LOG(DEBUG, EAL, "invalid tls key passed to +function.\n");"tls" -> "TLS"
Messages should start with a capital letter.
To which "function"?Quoted 10 lines
lib/librte_eal/windows/rte_thread.c new file +10
-0+return -1 ; + } +if (!TlsFree (key->thread_index)) { +RTE_LOG_WIN32_ERR ("TlsFree()" ); +free (key); +return -1 ; + } +free (key); +return 0 ; +}
Thanks for the review Dmitry, I'll fix and resend both patches.