intrte_thread_create(rte_thread_t*thread_id,constrte_thread_attr_t*thread_attr,rte_thread_functhread_func,void*arg)
Create a new thread that will invoke the 'thread_func' routine.
Parametersthread_id A pointer that will store the id of the newly created thread.
thread_attr Attributes that are used at the creation of the new thread.
thread_func The routine that the new thread will invoke when starting execution.
arg Argument to be passed to the 'thread_func' routine.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_create_control(rte_thread_t*thread,constchar*name,rte_thread_functhread_func,void*arg)
Create a control thread.
Creates a control thread with the given name and attributes. The affinity of the new thread is based on
the CPU affinity retrieved at the time rte_eal_init() was called, the EAL threads are then excluded. If
setting the name of the thread fails, the error is ignored and a debug message is logged.
Parametersthread Filled with the thread id of the new created thread.
name The name of the control thread (max RTE_THREAD_NAME_SIZE characters including '\0').
thread_func Function to be executed by the new thread.
arg Argument passed to thread_func.
Returns
On success, returns 0; on error, it returns a negative value corresponding to the error number.
__rte_internalintrte_thread_create_internal_control(rte_thread_t*id,constchar*name,rte_thread_funcfunc,void*arg)
Create an internal control thread.
Creates a control thread with the given name prefixed. If setting the name of the thread fails, the error
is ignored and logged.
The affinity of the new thread is based on the CPU affinity retrieved at the time rte_eal_init() was
called, the EAL threads are then excluded.
Parametersid Filled with the thread ID of the new created thread.
name The name of the control thread. See RTE_THREAD_INTERNAL_NAME_SIZE for maximum length. The name
of the driver or library should be first, then followed by a hyphen and more details. It will be
prefixed with RTE_THREAD_INTERNAL_PREFIX by this function.
func Function to be executed by the new thread.
arg Argument passed to func.
Returns
On success, returns 0; a negative value otherwise.
intrte_thread_join(rte_thread_tthread_id,uint32_t*value_ptr)
Waits for the thread identified by 'thread_id' to terminate
Parametersthread_id The identifier of the thread.
value_ptr Stores the exit status of the thread.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_detach(rte_thread_tthread_id)
Indicate that the return value of the thread is not needed and all thread resources should be release
when the thread terminates.
Parametersthread_id The id of the thread to be detached.
Returns
On success, return 0. On failure, return a positive errno-style error number.
rte_thread_trte_thread_self(void)
Get the id of the calling thread.
Returns
Return the thread id of the calling thread.
voidrte_thread_set_name(rte_thread_tthread_id,constchar*thread_name)
Set the name of the thread.
This API is a noop if the underlying platform does not support setting the thread name or the platform-
specific API used to set the thread name fails.
Parametersthread_id The id of the thread to set name.
thread_name The name to set. Truncated to RTE_THREAD_NAME_SIZE, including terminating NUL if
necessary.
__rte_internalvoidrte_thread_set_prefixed_name(rte_thread_tid,constchar*name)
Set the name of an internal thread with the common prefix.
This API is a noop if the underlying platform does not support setting the thread name, or if it fails.
Parametersid The ID of the thread to set name.
name The name to set after being prefixed. See RTE_THREAD_INTERNAL_NAME_SIZE for maximum length. The
name of the driver or library should be first, then followed by a hyphen and more details. It will be
prefixed with RTE_THREAD_INTERNAL_PREFIX by this function.
intrte_thread_equal(rte_thread_tt1,rte_thread_tt2)
Check if 2 thread ids are equal.
Parameterst1 First thread id.
t2 Second thread id.
Returns
If the ids are equal, return nonzero. Otherwise, return 0.
intrte_thread_attr_init(rte_thread_attr_t*attr)
Initialize the attributes of a thread. These attributes can be passed to the rte_thread_create() function
that will create a new thread and set its attributes according to attr.
Parametersattr Thread attributes to initialize.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_attr_set_priority(rte_thread_attr_t*thread_attr,enumrte_thread_prioritypriority)
Set the thread priority value in the thread attributes pointed to by 'thread_attr'.
Parametersthread_attr Points to the thread attributes in which priority will be updated.
priority Points to the value of the priority to be set.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_attr_set_affinity(rte_thread_attr_t*thread_attr,rte_cpuset_t*cpuset)
Set the CPU affinity value in the thread attributes pointed to by 'thread_attr'.
Parametersthread_attr Points to the thread attributes in which affinity will be updated.
cpuset Points to the value of the affinity to be set.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_attr_get_affinity(rte_thread_attr_t*thread_attr,rte_cpuset_t*cpuset)
Get the value of CPU affinity that is set in the thread attributes pointed to by 'thread_attr'.
Parametersthread_attr Points to the thread attributes from which affinity will be retrieved.
cpuset Pointer to the memory that will store the affinity.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_set_affinity_by_id(rte_thread_tthread_id,constrte_cpuset_t*cpuset)
Set the affinity of thread 'thread_id' to the cpu set specified by 'cpuset'.
Parametersthread_id Id of the thread for which to set the affinity.
cpuset Pointer to CPU affinity to set.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_get_affinity_by_id(rte_thread_tthread_id,rte_cpuset_t*cpuset)
Get the affinity of thread 'thread_id' and store it in 'cpuset'.
Parametersthread_id Id of the thread for which to get the affinity.
cpuset Pointer for storing the affinity value.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_set_affinity(rte_cpuset_t*cpusetp)
Set core affinity of the current thread. Support both EAL and non-EAL thread and update TLS.
Parameterscpusetp Pointer to CPU affinity to set.
Returns
On success, return 0; otherwise return -1;
voidrte_thread_get_affinity(rte_cpuset_t*cpusetp)
Get core affinity of the current thread.
Parameterscpusetp Pointer to CPU affinity of current thread. It presumes input is not NULL, otherwise it causes
panic.
intrte_thread_get_priority(rte_thread_tthread_id,enumrte_thread_priority*priority)
Get the priority of a thread.
Parametersthread_id Id of the thread for which to get priority.
priority Location to store the retrieved priority.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_set_priority(rte_thread_tthread_id,enumrte_thread_prioritypriority)
Set the priority of a thread.
Parametersthread_id Id of the thread for which to set priority.
priority Priority value to be set.
Returns
On success, return 0. On failure, return a positive errno-style error number.
intrte_thread_key_create(rte_thread_key*key,void(*)(void*)destructor)
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.
Parameterskey Pointer to store the allocated key.
destructor The function to be called when the thread exits. Ignored on Windows OS.
Returns
On success, zero. On failure, a negative number and an error number is set in rte_errno. rte_errno
can be: ENOMEM - Memory allocation error. ENOEXEC - Specific OS error.
intrte_thread_key_delete(rte_thread_keykey)
Delete a TLS data key visible to all threads in the process.
Parameterskey The key allocated by rte_thread_key_create().
Returns
On success, zero. On failure, a negative number and an error number is set in rte_errno. rte_errno
can be: EINVAL - Invalid parameter passed. ENOEXEC - Specific OS error.
intrte_thread_value_set(rte_thread_keykey,constvoid*value)
Set value bound to the TLS key on behalf of the calling thread.
Parameterskey The key allocated by rte_thread_key_create().
value The value bound to the rte_thread_key key for the calling thread.
Returns
On success, zero. On failure, a negative number and an error number is set in rte_errno. rte_errno
can be: EINVAL - Invalid parameter passed. ENOEXEC - Specific OS error.
void*rte_thread_value_get(rte_thread_keykey)
Get value bound to the TLS key on behalf of the calling thread.
Parameterskey The key allocated by rte_thread_key_create().
Returns
On success, value data pointer (can also be NULL). On failure, NULL and an error number is set in
rte_errno. rte_errno can be: EINVAL - Invalid parameter passed. ENOEXEC - Specific OS error.
Install Now
PNG Icons
