1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2021 Mellanox Technologies, Ltd
6 #include <rte_compat.h>
16 * Simple threads functionality supplied by EAL.
24 * TLS key type, an opaque pointer.
26 typedef struct eal_tls_key *rte_thread_key;
31 * Set core affinity of the current thread.
32 * Support both EAL and non-EAL thread and update TLS.
35 * Pointer to CPU affinity to set.
37 * On success, return 0; otherwise return -1;
39 int rte_thread_set_affinity(rte_cpuset_t *cpusetp);
42 * Get core affinity of the current thread.
45 * Pointer to CPU affinity of current thread.
46 * It presumes input is not NULL, otherwise it causes panic.
49 void rte_thread_get_affinity(rte_cpuset_t *cpusetp);
51 #endif /* RTE_HAS_CPUSET */
54 * Create a TLS data key visible to all threads in the process.
55 * the created key is later used to get/set a value.
56 * and optional destructor can be set to be called when a thread exits.
59 * Pointer to store the allocated key.
61 * The function to be called when the thread exits.
62 * Ignored on Windows OS.
66 * On failure, a negative number and an error number is set in rte_errno.
67 * rte_errno can be: ENOMEM - Memory allocation error.
68 * ENOEXEC - Specific OS error.
72 int rte_thread_key_create(rte_thread_key *key,
73 void (*destructor)(void *));
76 * Delete a TLS data key visible to all threads in the process.
79 * The key allocated by rte_thread_key_create().
83 * On failure, a negative number and an error number is set in rte_errno.
84 * rte_errno can be: EINVAL - Invalid parameter passed.
85 * ENOEXEC - Specific OS error.
88 int rte_thread_key_delete(rte_thread_key key);
91 * Set value bound to the TLS key on behalf of the calling thread.
94 * The key allocated by rte_thread_key_create().
96 * The value bound to the rte_thread_key key for the calling thread.
100 * On failure, a negative number and an error number is set in rte_errno.
101 * rte_errno can be: EINVAL - Invalid parameter passed.
102 * ENOEXEC - Specific OS error.
105 int rte_thread_value_set(rte_thread_key key, const void *value);
108 * Get value bound to the TLS key on behalf of the calling thread.
111 * The key allocated by rte_thread_key_create().
114 * On success, value data pointer (can also be NULL).
115 * On failure, NULL and an error number is set in rte_errno.
116 * rte_errno can be: EINVAL - Invalid parameter passed.
117 * ENOEXEC - Specific OS error.
120 void *rte_thread_value_get(rte_thread_key key);
126 #endif /* _RTE_THREAD_H_ */