RTEMS: Thread Handler

| RTEMS 5.4-rc2

Loading...
Searching...
No Matches
Files | Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
Thread Handler
Internal » SuperCore

Thread Handler. More...

## Files
file | thread.h
| Constants and Structures Related with the Thread Control Block.
file | threaddispatch.h
| Constants and Structures Related with Thread Dispatch.
file | threadidledata.h
| Constants for the idle threads.
file | threadimpl.h
| Inlined Routines from the Thread Handler.
file | iterateoverthreads.c
| Iterates Over All Threads.
file | thread.c
| Initialize Thread Handler.
file | threadallocateunlimited.c
file | threadchangepriority.c
| Changes the Priority of a Thread.
file | threadclearstate.c
| Clear Thread state.
file | threadcreateidle.c
| Create Idle Thread.
file | threaddispatch.c
| Dispatch Thread.
file | threadget.c
| Maps Thread IDs to TCB Pointer.
file | threadhandler.c
| Thread Handler.
file | threadinitialize.c
| Initialize Thread.
file | threadloadenv.c
| Initializes Enviroment for A Thread.
file | threadrestart.c
| Restart Thread.
file | threadsetstate.c
| Sets States for a Thread.
file | threadstart.c
| Initializes Thread and Executes it.
file | threadstartmultitasking.c
| Start Thread Multitasking.
file | threadtimeout.c
| Thread Wait Timeout.
file | threadyield.c
| Thread Yield.

## Data Structures
struct | Thread_Entry_idle
| Data for idle thread entry. More...
struct | Thread_Entry_numeric
| Data for thread entry with one numeric argument and no return value. More...
struct | Thread_Entry_pointer
| Data for thread entry with one pointer argument and a pointer return value. More...
struct | Thread_Entry_information
| Thread entry information. More...
struct | Thread_Start_information
struct | Thread_Scheduler_control
| Thread scheduler control. More...
union | Thread_Wait_information_Object_argument_type
| Union type to hold a pointer to an immutable or a mutable object. More...
struct | Thread_Wait_information
| Information required to manage a thread while it is blocked. More...
struct | Thread_Timer_information
| Information required to manage a thread timer. More...
struct | Thread_Proxy_control
struct | Thread_Action
| Thread action. More...
struct | Thread_Keys_information
| Per-thread information for POSIX Keys. More...
struct | Thread_Action_control
| Control block to manage thread actions. More...
struct | Thread_Life_control
| Thread life control. More...
struct | Thread_Capture_control
struct | _Thread_Control
struct | Thread_Control_add_on
| Thread control add-on. More...
struct | Thread_Information
| The thread object information. More...
struct | Thread_Configuration
| The configuration of a new thread to initialize. More...
struct | Thread_Close_context

## Macros
#define | RTEMS_SCORE_THREAD_ENABLE_EXHAUST_TIMESLICE
#define | RTEMS_SCORE_THREAD_ENABLE_SCHEDULER_CALLOUT
#define | THREAD_API_FIRST THREAD_API_RTEMS
#define | THREAD_API_LAST THREAD_API_POSIX
#define | THREAD_DEFAULT_MAXIMUM_NAME_SIZE 16
| The default maximum size of a thread name in characters (including the terminating '\0' character).
#define | _Thread_queue_Heads_size sizeof(Thread_queue_Heads)
| Size of the thread queue heads of a particular application.
#define | THREAD_INFORMATION_DEFINE_ZERO(name, api, cls)
#define | THREAD_INFORMATION_DEFINE(name, api, cls, max)
#define | RTEMS_SCORE_ROBUST_THREAD_DISPATCH
| Enables a robust thread dispatch.
#define | THREAD_WAIT_FLAGS_INITIAL 0x0U
| The initial thread wait flags value set by _Thread_Initialize().
#define | THREAD_WAIT_STATE_MASK 0xffU
| Mask to get the thread wait state flags.
#define | THREAD_WAIT_STATE_INTEND_TO_BLOCK 0x1U
| Indicates that the thread begins with the blocking operation.
#define | THREAD_WAIT_STATE_BLOCKED 0x2U
| Indicates that the thread completed the blocking operation.
#define | THREAD_WAIT_STATE_READY_AGAIN 0x4U
| Indicates that a condition to end the thread wait occurred.
#define | THREAD_WAIT_CLASS_MASK 0xff00U
| Mask to get the thread wait class flags.
#define | THREAD_WAIT_CLASS_EVENT 0x100U
| Indicates that the thread waits for an event.
#define | THREAD_WAIT_CLASS_SYSTEM_EVENT 0x200U
| Indicates that the thread waits for a system event.
#define | THREAD_WAIT_CLASS_OBJECT 0x400U
| Indicates that the thread waits for an object.
#define | THREAD_WAIT_CLASS_PERIOD 0x800U
| Indicates that the thread waits for a period.

## Typedefs
typedef void *Thread | RTEMS_DEPRECATED
typedef CPU_Uint32ptr | Thread_Entry_numeric_type
| Type of the numeric argument of a thread entry function with at least one numeric argument.
typedef void(* | Thread_CPU_budget_algorithm_callout) (Thread_Control *)
typedef unsigned int | Thread_Wait_flags
| This type is able to contain several flags used to control the wait class and state of a thread.
typedef struct Thread_Action | Thread_Action
typedef void(* | Thread_Action_handler) (Thread_Control *the_thread, Thread_Action *action, ISR_lock_Context *lock_context)
| Thread action handler.
typedef void(* | rtems_per_thread_routine) (Thread_Control *)
typedef struct Thread_Configured_control | Thread_Configured_control
| The configured thread control block.
typedef Thread_queue_Heads | Thread_queue_Configured_heads
| The configured thread queue heads.
typedef void *(* | Thread_Idle_body) (uintptr_t)
| The idle thread body type.
typedef bool(* | Thread_Visitor) (Thread_Control *the_thread, void *arg)

## Enumerations
enum | Thread_CPU_budget_algorithms { THREAD_CPU_BUDGET_ALGORITHM_NONE , THREAD_CPU_BUDGET_ALGORITHM_RESET_TIMESLICE , THREAD_CPU_BUDGET_ALGORITHM_EXHAUST_TIMESLICE , THREAD_CPU_BUDGET_ALGORITHM_CALLOUT }
enum | Thread_APIs { THREAD_API_RTEMS , THREAD_API_POSIX }
enum | Thread_Life_state { THREAD_LIFE_PROTECTED = 0x1 , THREAD_LIFE_RESTARTING = 0x2 , THREAD_LIFE_TERMINATING = 0x4 , THREAD_LIFE_CHANGE_DEFERRED = 0x8 , THREAD_LIFE_DETACHED = 0x10 }
| Thread life states. More...

## Functions
void | rtems_iterate_over_all_threads (rtems_per_thread_routine routine) RTEMS_DEPRECATED
| Deprecated, use rtems_task_iterate() instead.
Objects_Control * | _Thread_Allocate_unlimited (Objects_Information *information)
| Return an inactive thread object or NULL.
RTEMS_INLINE_ROUTINE bool | _Thread_Dispatch_is_enabled (void)
| Indicates if the executing thread is inside a thread dispatch critical section.
RTEMS_INLINE_ROUTINE uint32_t | _Thread_Dispatch_get_disable_level (void)
| Gets thread dispatch disable level.
RTEMS_INLINE_ROUTINE void | _Thread_Dispatch_initialization (void)
| Thread dispatch initialization.
void | _Thread_Dispatch (void)
| Performs a thread dispatch if necessary.
void | _Thread_Dispatch_direct (Per_CPU_Control *cpu_self)
| Directly do a thread dispatch.
void | _Thread_Do_dispatch (Per_CPU_Control *cpu_self, ISR_Level level)
| Performs a thread dispatch on the current processor.
RTEMS_INLINE_ROUTINE Per_CPU_Control * | _Thread_Dispatch_disable_with_CPU (Per_CPU_Control *cpu_self, const ISR_lock_Context *lock_context)
| Disables thread dispatching inside a critical section (interrupts disabled) with the current processor.
RTEMS_INLINE_ROUTINE Per_CPU_Control * | _Thread_Dispatch_disable_critical (const ISR_lock_Context *lock_context)
| Disables thread dispatching inside a critical section (interrupts disabled).
RTEMS_INLINE_ROUTINE Per_CPU_Control * | _Thread_Dispatch_disable (void)
| Disables thread dispatching.
void | _Thread_Dispatch_enable (Per_CPU_Control *cpu_self)
| Enables thread dispatching.
RTEMS_INLINE_ROUTINE void | _Thread_Dispatch_unnest (Per_CPU_Control *cpu_self)
| Unnests thread dispatching.
RTEMS_INLINE_ROUTINE void | _Thread_Dispatch_request (Per_CPU_Control *cpu_self, Per_CPU_Control *cpu_target)
| Requests a thread dispatch on the target processor.
void | _Thread_Iterate (Thread_Visitor visitor, void *arg)
| Calls the visitor with all threads and the given argument until it is done.
void | _Thread_Initialize_information (Thread_Information *information)
| Initializes the thread information.
void | _Thread_Handler_initialization (void)
| Initializes thread handler.
void | _Thread_Create_idle (void)
| Creates idle thread.
void | _Thread_Start_multitasking (void) RTEMS_NO_RETURN
| Starts thread multitasking.
bool | _Thread_Initialize (Thread_Information *information, Thread_Control *the_thread, const Thread_Configuration *config)
| Initializes thread.
bool | _Thread_Start (Thread_Control *the_thread, const Thread_Entry_information *entry, ISR_lock_Context *lock_context)
| Initializes thread and executes it.
void | _Thread_Restart_self (Thread_Control *executing, const Thread_Entry_information *entry, ISR_lock_Context *lock_context) RTEMS_NO_RETURN
| Restarts the currently executing thread.
bool | _Thread_Restart_other (Thread_Control *the_thread, const Thread_Entry_information *entry, ISR_lock_Context *lock_context)
| Restarts the thread.
void | _Thread_Yield (Thread_Control *executing)
| Yields the currently executing thread.
Thread_Life_state | _Thread_Change_life (Thread_Life_state clear, Thread_Life_state set, Thread_Life_state ignore)
| Changes the currently executing thread to a new state with the sets.
Thread_Life_state | _Thread_Set_life_protection (Thread_Life_state state)
| Set the thread to life protected.
void | _Thread_Kill_zombies (void)
| Kills all zombie threads in the system.
void | _Thread_Exit (Thread_Control *executing, Thread_Life_state set, void *exit_value)
| Exits the currently executing thread.
void | _Thread_Join (Thread_Control *the_thread, States_Control waiting_for_join, Thread_Control *executing, Thread_queue_Context *queue_context)
| Joins the currently executing thread with the given thread to wait for.
void | _Thread_Cancel (Thread_Control *the_thread, Thread_Control *executing, void *exit_value)
| Cancels the thread.
void | _Thread_Close (Thread_Control *the_thread, Thread_Control *executing, Thread_Close_context *context)
| Closes the thread.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_ready (const Thread_Control *the_thread)
| Checks if the thread is ready.
States_Control | _Thread_Clear_state_locked (Thread_Control *the_thread, States_Control state)
| Clears the specified thread state without locking the lock context.
States_Control | _Thread_Clear_state (Thread_Control *the_thread, States_Control state)
| Clears the specified thread state.
States_Control | _Thread_Set_state_locked (Thread_Control *the_thread, States_Control state)
| Sets the specified thread state without locking the lock context.
States_Control | _Thread_Set_state (Thread_Control *the_thread, States_Control state)
| Sets the specified thread state.
void | _Thread_Load_environment (Thread_Control *the_thread)
| Initializes enviroment for a thread.
void | _Thread_Entry_adaptor_idle (Thread_Control *executing)
| Calls the start kinds idle entry of the thread.
void | _Thread_Entry_adaptor_numeric (Thread_Control *executing)
| Calls the start kinds numeric entry of the thread.
void | _Thread_Entry_adaptor_pointer (Thread_Control *executing)
| Calls the start kinds pointer entry of the thread.
void | _Thread_Handler (void)
| Wrapper function for all threads.
RTEMS_INLINE_ROUTINE void | _Thread_State_acquire_critical (Thread_Control *the_thread, ISR_lock_Context *lock_context)
| Acquires the lock context in a critical section.
RTEMS_INLINE_ROUTINE void | _Thread_State_acquire (Thread_Control *the_thread, ISR_lock_Context *lock_context)
| Disables interrupts and acquires the lock_context.
RTEMS_INLINE_ROUTINE Thread_Control * | _Thread_State_acquire_for_executing (ISR_lock_Context *lock_context)
| Disables interrupts and acquires the lock context for the currently executing thread.
RTEMS_INLINE_ROUTINE void | _Thread_State_release_critical (Thread_Control *the_thread, ISR_lock_Context *lock_context)
| Release the lock context in a critical section.
RTEMS_INLINE_ROUTINE void | _Thread_State_release (Thread_Control *the_thread, ISR_lock_Context *lock_context)
| Releases the lock context and enables interrupts.
void | _Thread_Priority_perform_actions (Thread_Control *start_of_path, Thread_queue_Context *queue_context)
| Checks if the thread is owner of the lock of the join queue.
void | _Thread_Priority_add (Thread_Control *the_thread, Priority_Node *priority_node, Thread_queue_Context *queue_context)
| Adds the specified thread priority node to the corresponding thread priority aggregation.
void | _Thread_Priority_remove (Thread_Control *the_thread, Priority_Node *priority_node, Thread_queue_Context *queue_context)
| Removes the specified thread priority node from the corresponding thread priority aggregation.
void | _Thread_Priority_changed (Thread_Control *the_thread, Priority_Node *priority_node, bool prepend_it, Thread_queue_Context *queue_context)
| Propagates a thread priority value change in the specified thread priority node to the corresponding thread priority aggregation.
RTEMS_INLINE_ROUTINE void | _Thread_Priority_change (Thread_Control *the_thread, Priority_Node *priority_node, Priority_Control new_priority, bool prepend_it, Thread_queue_Context *queue_context)
| Changes the thread priority value of the specified thread priority node in the corresponding thread priority aggregation.
void | _Thread_Priority_replace (Thread_Control *the_thread, Priority_Node *victim_node, Priority_Node *replacement_node)
| Replaces the victim priority node with the replacement priority node in the corresponding thread priority aggregation.
void | _Thread_Priority_update (Thread_queue_Context *queue_context)
| Updates the priority of all threads in the set.
RTEMS_INLINE_ROUTINE bool | _Thread_Priority_less_than (Priority_Control left, Priority_Control right)
| Updates the priority of the thread and changes it sticky level.
RTEMS_INLINE_ROUTINE Priority_Control | _Thread_Priority_highest (Priority_Control left, Priority_Control right)
| Returns the highest priority of the left and right thread priorities in the intuitive sense of priority.
RTEMS_INLINE_ROUTINE Objects_Information * | _Thread_Get_objects_information (Objects_Id id)
| Gets object information for the object id.
Thread_Control * | _Thread_Get (Objects_Id id, ISR_lock_Context *lock_context)
| Gets a thread by its identifier.
RTEMS_INLINE_ROUTINE Per_CPU_Control * | _Thread_Get_CPU (const Thread_Control *thread)
| Gets the cpu of the thread's scheduler.
RTEMS_INLINE_ROUTINE void | _Thread_Set_CPU (Thread_Control *thread, Per_CPU_Control *cpu)
| Sets the cpu of the thread's scheduler.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_executing (const Thread_Control *the_thread)
| Checks if the thread is the currently executing thread.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_heir (const Thread_Control *the_thread)
| Checks if the thread is the heir.
RTEMS_INLINE_ROUTINE void | _Thread_Unblock (Thread_Control *the_thread)
| Unblocks the thread.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_allocated_fp (const Thread_Control *the_thread)
| Checks if the floating point context of the thread is currently loaded in the floating point unit.
RTEMS_INLINE_ROUTINE void | _Thread_Save_fp (Thread_Control *executing)
| Saves the executing thread's floating point area.
RTEMS_INLINE_ROUTINE void | _Thread_Restore_fp (Thread_Control *executing)
| Restores the executing thread's floating point area.
RTEMS_INLINE_ROUTINE void | _Thread_Deallocate_fp (void)
| Deallocates the currently loaded floating point context.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_context_switch_necessary (void)
| Checks if dispatching is disabled.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_null (const Thread_Control *the_thread)
| Checks if the thread is NULL.
RTEMS_INLINE_ROUTINE uint32_t | _Thread_Get_maximum_internal_threads (void)
| Gets the maximum number of internal threads.
RTEMS_INLINE_ROUTINE Thread_Control * | _Thread_Internal_allocate (void)
| Allocates an internal thread and returns it.
RTEMS_INLINE_ROUTINE Thread_Control * | _Thread_Get_heir_and_make_it_executing (Per_CPU_Control *cpu_self)
| Gets the heir of the processor and makes it executing.
RTEMS_INLINE_ROUTINE void | _Thread_Update_CPU_time_used (Thread_Control *the_thread, Per_CPU_Control *cpu)
| Updates the cpu time used of the thread.
void | _Thread_Get_CPU_time_used (Thread_Control *the_thread, Timestamp_Control *cpu_time_used)
| Updates the used cpu time for the heir and dispatches a new heir.
RTEMS_INLINE_ROUTINE void | _Thread_Action_control_initialize (Thread_Action_control *action_control)
| Initializes the control chain of the action control.
RTEMS_INLINE_ROUTINE void | _Thread_Action_initialize (Thread_Action *action)
| Initializes the Thread action.
RTEMS_INLINE_ROUTINE void | _Thread_Add_post_switch_action (Thread_Control *the_thread, Thread_Action *action, Thread_Action_handler handler)
| Adds a post switch action to the thread with the given handler.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_life_restarting (Thread_Life_state life_state)
| Checks if the thread life state is restarting.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_life_terminating (Thread_Life_state life_state)
| Checks if the thread life state is terminating.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_life_change_allowed (Thread_Life_state life_state)
| Checks if the thread life state allos life change.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_life_changing (Thread_Life_state life_state)
| Checks if the thread life state is life changing.
RTEMS_INLINE_ROUTINE bool | _Thread_Is_joinable (const Thread_Control *the_thread)
| Checks if the thread is joinable.
RTEMS_INLINE_ROUTINE void | _Thread_Resource_count_increment (Thread_Control *the_thread)
| Increments the thread's resource count.
RTEMS_INLINE_ROUTINE void | _Thread_Resource_count_decrement (Thread_Control *the_thread)
| Decrements the thread's resource count.
RTEMS_INLINE_ROUTINE const Scheduler_Control * | _Thread_Scheduler_get_home (const Thread_Control *the_thread)
| Gets the home scheduler of the thread.
RTEMS_INLINE_ROUTINE Scheduler_Node * | _Thread_Scheduler_get_home_node (const Thread_Control *the_thread)
| Gets the scheduler's home node.
RTEMS_INLINE_ROUTINE Scheduler_Node * | _Thread_Scheduler_get_node_by_index (const Thread_Control *the_thread, size_t scheduler_index)
| Gets the thread's scheduler node by index.
RTEMS_INLINE_ROUTINE Priority_Control | _Thread_Get_priority (const Thread_Control *the_thread)
| Returns the priority of the thread.
RTEMS_INLINE_ROUTINE Priority_Control | _Thread_Get_unmapped_priority (const Thread_Control *the_thread)
| Returns the unmapped priority of the thread.
RTEMS_INLINE_ROUTINE Priority_Control | _Thread_Get_unmapped_real_priority (const Thread_Control *the_thread)
| Returns the unmapped real priority of the thread.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_acquire_default_critical (Thread_Control *the_thread, ISR_lock_Context *lock_context)
| Acquires the thread wait default lock inside a critical section (interrupts disabled).
RTEMS_INLINE_ROUTINE Thread_Control * | _Thread_Wait_acquire_default_for_executing (ISR_lock_Context *lock_context)
| Acquires the thread wait default lock and returns the executing thread.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_acquire_default (Thread_Control *the_thread, ISR_lock_Context *lock_context)
| Acquires the thread wait default lock and disables interrupts.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_release_default_critical (Thread_Control *the_thread, ISR_lock_Context *lock_context)
| Releases the thread wait default lock inside a critical section (interrupts disabled).
RTEMS_INLINE_ROUTINE void | _Thread_Wait_release_default (Thread_Control *the_thread, ISR_lock_Context *lock_context)
| Releases the thread wait default lock and restores the previous interrupt status.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_acquire_critical (Thread_Control *the_thread, Thread_queue_Context *queue_context)
| Acquires the thread wait lock inside a critical section (interrupts disabled).
RTEMS_INLINE_ROUTINE void | _Thread_Wait_acquire (Thread_Control *the_thread, Thread_queue_Context *queue_context)
| Acquires the thread wait default lock and disables interrupts.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_release_critical (Thread_Control *the_thread, Thread_queue_Context *queue_context)
| Releases the thread wait lock inside a critical section (interrupts disabled).
RTEMS_INLINE_ROUTINE void | _Thread_Wait_release (Thread_Control *the_thread, Thread_queue_Context *queue_context)
| Releases the thread wait lock and restores the previous interrupt status.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_claim (Thread_Control *the_thread, Thread_queue_Queue *queue)
| Claims the thread wait queue.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_claim_finalize (Thread_Control *the_thread, const Thread_queue_Operations *operations)
| Finalizes the thread wait queue claim via registration of the corresponding thread queue operations.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_remove_request (Thread_Control *the_thread, Thread_queue_Lock_context *queue_lock_context)
| Removes a thread wait lock request.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_restore_default (Thread_Control *the_thread)
| Restores the default thread wait queue and operations.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_tranquilize (Thread_Control *the_thread)
| Tranquilizes the thread after a wait on a thread queue.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_cancel (Thread_Control *the_thread, Thread_queue_Context *queue_context)
| Cancels a thread wait on a thread queue.
RTEMS_INLINE_ROUTINE void | _Thread_Wait_flags_set (Thread_Control *the_thread, Thread_Wait_flags flags)
| Sets the thread's wait flags.
RTEMS_INLINE_ROUTINE Thread_Wait_flags | _Thread_Wait_flags_get (const Thread_Control *the_thread)
| Gets the thread's wait flags according to the ATOMIC_ORDER_RELAXED.
RTEMS_INLINE_ROUTINE Thread_Wait_flags | _Thread_Wait_flags_get_acquire (const Thread_Control *the_thread)
| Gets the thread's wait flags according to the ATOMIC_ORDER_ACQUIRE.
RTEMS_INLINE_ROUTINE bool | _Thread_Wait_flags_try_change_release (Thread_Control *the_thread, Thread_Wait_flags expected_flags, Thread_Wait_flags desired_flags)
| Tries to change the thread wait flags with release semantics in case of success.
RTEMS_INLINE_ROUTINE bool | _Thread_Wait_flags_try_change_acquire (Thread_Control *the_thread, Thread_Wait_flags expected_flags, Thread_Wait_flags desired_flags)
| Tries to change the thread wait flags with acquire semantics.
Objects_Id | _Thread_Wait_get_id (const Thread_Control *the_thread)
| Returns the object identifier of the object containing the current thread wait queue.
RTEMS_INLINE_ROUTINE Status_Control | _Thread_Wait_get_status (const Thread_Control *the_thread)
| Get the status of the wait return code of the thread.
void | _Thread_Continue (Thread_Control *the_thread, Status_Control status)
| Cancels a blocking operation so that the thread can continue its execution.
void | _Thread_Timeout (Watchdog_Control *the_watchdog)
| General purpose thread wait timeout.
RTEMS_INLINE_ROUTINE void | _Thread_Timer_initialize (Thread_Timer_information *timer, Per_CPU_Control *cpu)
| Initializes the thread timer.
RTEMS_INLINE_ROUTINE void | _Thread_Add_timeout_ticks (Thread_Control *the_thread, Per_CPU_Control *cpu, Watchdog_Interval ticks)
| Adds timeout ticks to the thread.
RTEMS_INLINE_ROUTINE void | _Thread_Timer_insert_realtime (Thread_Control *the_thread, Per_CPU_Control *cpu, Watchdog_Service_routine_entry routine, uint64_t expire)
| Inserts the cpu's watchdog realtime into the thread's timer.
RTEMS_INLINE_ROUTINE void | _Thread_Timer_remove (Thread_Control *the_thread)
| Remove the watchdog timer from the thread.
RTEMS_INLINE_ROUTINE void | _Thread_Remove_timer_and_unblock (Thread_Control *the_thread, Thread_queue_Queue *queue)
| Remove the watchdog timer from the thread and unblock if necessary.
Status_Control | _Thread_Set_name (Thread_Control *the_thread, const char *name)
| Sets the name of the thread.
size_t | _Thread_Get_name (const Thread_Control *the_thread, char *buffer, size_t buffer_size)
| Gets the name of the thread.
RTEMS_INLINE_ROUTINE void | _Thread_Pin (Thread_Control *executing)
| Pin the executing thread.
RTEMS_INLINE_ROUTINE void | _Thread_Unpin (Thread_Control *executing, Per_CPU_Control *cpu_self)
| Unpins the thread.

## Variables
const Thread_Control_add_on | _Thread_Control_add_ons []
| Thread control add-ons.
const size_t | _Thread_Control_add_on_count
| Thread control add-on count.
const size_t | _Thread_Initial_thread_count
| Count of configured threads.
const size_t | _Thread_Maximum_name_size
| Maximum size of a thread name in characters (including the terminating '\0' character).
Thread_Information | _Thread_Information
| The internal thread objects information.
char | _Thread_Idle_stacks []
| The idle thread stacks.
const size_t | _Thread_Idle_stack_size
| The idle thread stack size in bytes.
const Thread_Idle_body | _Thread_Idle_body
| The idle thread body.
void * | rtems_ada_self
Objects_Id | _Thread_Global_constructor
| Object identifier of the global constructor thread.
Thread_Control * | _Thread_Allocated_fp

## Detailed Description

Thread Handler.

This handler encapsulates functionality related to the management of threads. This includes the creation, deletion, and scheduling of threads.

The following variables are maintained as part of the per cpu data structure.

- Idle thread pointer
- Executing thread pointer
- Heir thread pointer

## Macro Definition Documentation

## ◆ _Thread_queue_Heads_size

#define _Thread_queue_Heads_size sizeof(Thread_queue_Heads)

Size of the thread queue heads of a particular application.

In SMP configurations, this value is provided via <rtems/confdefs.h>.

## ◆ RTEMS_SCORE_ROBUST_THREAD_DISPATCH

#define RTEMS_SCORE_ROBUST_THREAD_DISPATCH

Enables a robust thread dispatch.

On each change of the thread dispatch disable level from one to zero the interrupt status is checked. In case interrupts are disabled and SMP is enabled or the CPU port needs it, then the system terminates with the fatal internal error INTERNAL_ERROR_BAD_THREAD_DISPATCH_ENVIRONMENT.

## ◆ THREAD_API_FIRST

#define THREAD_API_FIRST THREAD_API_RTEMS

This macro defines the first API which has threads.

## ◆ THREAD_API_LAST

#define THREAD_API_LAST THREAD_API_POSIX

This macro defines the last API which has threads.

## ◆ THREAD_DEFAULT_MAXIMUM_NAME_SIZE

#define THREAD_DEFAULT_MAXIMUM_NAME_SIZE 16

The default maximum size of a thread name in characters (including the terminating '\0' character).

This is the default value for the application configuration option CONFIGURE_MAXIMUM_THREAD_NAME_SIZE.

## ◆ THREAD_INFORMATION_DEFINE

#define THREAD_INFORMATION_DEFINE | ( |  | name,
|  |  | api,
|  |  | cls,
|  |  | max
| ) |  |

Value:
static Objects_Control * \
name##_Local_table[ _Objects_Maximum_per_allocation( max ) ]; \
static Thread_Configured_control \
name##_Objects[ _Objects_Maximum_per_allocation( max ) ]; \
static Thread_queue_Configured_heads \
name##_Heads[ _Objects_Maximum_per_allocation( max ) ]; \
Thread_Information name##_Information = { \
{ \
_Objects_Build_id( api, cls, 1, _Objects_Maximum_per_allocation( max ) ), \
name##_Local_table, \
_Objects_Is_unlimited( max ) ? \
_Thread_Allocate_unlimited : _Objects_Allocate_static, \
_Objects_Is_unlimited( max ) ? \
_Objects_Free_unlimited : _Objects_Free_static, \
0, \
_Objects_Is_unlimited( max ) ? _Objects_Maximum_per_allocation( max ) : 0, \
sizeof( Thread_Configured_control ), \
OBJECTS_NO_STRING_NAME, \
CHAIN_INITIALIZER_EMPTY( name##_Information.Objects.Inactive ), \
NULL, \
NULL, \
&name##_Objects[ 0 ].Control.Object \
OBJECTS_INFORMATION_MP( name##_Information.Objects, NULL ) \
}, { \
&name##_Heads[ 0 ] \
} \
}
NULL
#define NULL
Requests a GPIO pin group configuration.
Definition: bestcomm_api.h:77
CHAIN_INITIALIZER_EMPTY
#define CHAIN_INITIALIZER_EMPTY(name)
Chain initializer for an empty chain with designator name.
Definition: chainimpl.h:39
_Objects_Free_static
void _Objects_Free_static(Objects_Information *information, Objects_Control *the_object)
Free the object.
Definition: objectfreestatic.c:41
_Objects_Allocate_static
Objects_Control * _Objects_Allocate_static(Objects_Information *information)
Return an inactive object or NULL.
Definition: objectallocatestatic.c:41
OBJECTS_NO_STRING_NAME
#define OBJECTS_NO_STRING_NAME
Constant for the object information string name length to indicate that this object class has no stri...
Definition: objectdata.h:101
_Objects_Free_unlimited
void _Objects_Free_unlimited(Objects_Information *information, Objects_Control *the_object)
Free the object.
Definition: objectfree.c:24
_Thread_Allocate_unlimited
Objects_Control * _Thread_Allocate_unlimited(Objects_Information *information)
Return an inactive thread object or NULL.
Definition: threadallocateunlimited.c:66
Thread_Configured_control
struct Thread_Configured_control Thread_Configured_control
The configured thread control block.
Definition: thread.h:969
Objects_Control
Definition: objectdata.h:39
Thread_Information
The thread object information.
Definition: thread.h:997

## ◆ THREAD_INFORMATION_DEFINE_ZERO

#define THREAD_INFORMATION_DEFINE_ZERO | ( |  | name,
|  |  | api,
|  |  | cls
| ) |  |

Value:
Thread_Information name##_Information = { \
{ \
_Objects_Build_id( api, cls, 1, 0 ), \
NULL, \
_Objects_Allocate_none, \
NULL, \
0, \
0, \
0, \
0, \
CHAIN_INITIALIZER_EMPTY( name##_Information.Objects.Inactive ), \
NULL, \
NULL, \
NULL \
OBJECTS_INFORMATION_MP( name##_Information.Objects, NULL ), \
}, { \
NULL \
} \
}
_Objects_Allocate_none
Objects_Control * _Objects_Allocate_none(Objects_Information *information)
Always return NULL.
Definition: objectallocatenone.c:40

## ◆ THREAD_WAIT_STATE_INTEND_TO_BLOCK

#define THREAD_WAIT_STATE_INTEND_TO_BLOCK 0x1U

Indicates that the thread begins with the blocking operation.

A blocking operation consists of an optional watchdog initialization and the setting of the appropriate thread blocking state with the corresponding scheduler block operation.

## ◆ THREAD_WAIT_STATE_READY_AGAIN

#define THREAD_WAIT_STATE_READY_AGAIN 0x4U

Indicates that a condition to end the thread wait occurred.

This could be a timeout, a signal, an event or a resource availability.

## Typedef Documentation

## ◆ Thread_Action_handler

typedef void(* Thread_Action_handler) (Thread_Control *the_thread, Thread_Action *action, ISR_lock_Context *lock_context)

Thread action handler.

The thread action handler will be called with interrupts disabled and a corresponding lock acquired, e.g. _Thread_State_acquire(). The handler must release the corresponding lock, e.g. _Thread_State_release(). So, the corresponding lock may be used to protect private data used by the particular action.

Since the action is passed to the handler additional data may be accessed via RTEMS_CONTAINER_OF().

Parameters

  [in] | the_thread | The thread performing the action.
  [in] | action | The thread action.
  [in] | lock_context | The lock context to use for the lock release.

## ◆ Thread_Configured_control

typedef struct Thread_Configured_control Thread_Configured_control

The configured thread control block.

This type is defined in <rtems/confdefs.h> and depends on the application configuration.

## ◆ Thread_CPU_budget_algorithm_callout

typedef void(* Thread_CPU_budget_algorithm_callout) (Thread_Control *)

This defines thes the entry point for the thread specific timeslice budget management algorithm.

## ◆ Thread_Entry_numeric_type

typedef CPU_Uint32ptr Thread_Entry_numeric_type

Type of the numeric argument of a thread entry function with at least one numeric argument.

This numeric argument type designates an unsigned integer type with the property that any valid pointer to void can be converted to this type and then converted back to a pointer to void. The result will compare equal to the original pointer.

## ◆ Thread_queue_Configured_heads

typedef Thread_queue_Heads Thread_queue_Configured_heads

The configured thread queue heads.

In SMP configurations, this type is defined in <rtems/confdefs.h> and depends on the application configuration.

## ◆ Thread_Wait_flags

typedef unsigned int Thread_Wait_flags

This type is able to contain several flags used to control the wait class and state of a thread.

The mutually exclusive wait class flags are

- THREAD_WAIT_CLASS_EVENT,
- THREAD_WAIT_CLASS_SYSTEM_EVENT, and
- THREAD_WAIT_CLASS_OBJECT.

The mutually exclusive wait state flags are

- THREAD_WAIT_STATE_INTEND_TO_BLOCK,
- THREAD_WAIT_STATE_BLOCKED, and
- THREAD_WAIT_STATE_READY_AGAIN.

## Enumeration Type Documentation

## ◆ Thread_APIs

enum Thread_APIs

The following record defines the control block used to manage each thread.

Note
  It is critical that proxies and threads have identical memory images for the shared part.

Enumerator
THREAD_API_RTEMS | This value is for the Classic RTEMS API.
THREAD_API_POSIX | This value is for the POSIX API.

## ◆ Thread_CPU_budget_algorithms

enum Thread_CPU_budget_algorithms

The following lists the algorithms used to manage the thread cpu budget.

Reset Timeslice: At each context switch, reset the time quantum. Exhaust Timeslice: Only reset the quantum once it is consumed. Callout: Execute routine when budget is consumed.

## ◆ Thread_Life_state

enum Thread_Life_state

Thread life states.

The thread life states are orthogonal to the thread states used for synchronization primitives and blocking operations. They reflect the state changes triggered with thread restart and delete requests.

The individual state values must be a power of two to allow use of bit operations to manipulate and evaluate the thread life state.

## Function Documentation

## ◆ _Thread_Action_control_initialize()

RTEMS_INLINE_ROUTINE void _Thread_Action_control_initialize | ( | Thread_Action_control * | action_control | ) |

Initializes the control chain of the action control.

Parameters

  [out] | action_control | The action control to initialize.

## ◆ _Thread_Action_initialize()

RTEMS_INLINE_ROUTINE void _Thread_Action_initialize | ( | Thread_Action * | action | ) |

Initializes the Thread action.

Parameters

  [out] | action | The Thread_Action to initialize.

## ◆ _Thread_Add_post_switch_action()

RTEMS_INLINE_ROUTINE void _Thread_Add_post_switch_action | ( | Thread_Control * | the_thread,
|  | Thread_Action * | action,
|  | Thread_Action_handler | handler
| ) |  |

Adds a post switch action to the thread with the given handler.

Parameters

  [in,out] | the_thread | The thread.
  [in,out] | action | The action to add.
  | handler | The handler for the action.

## ◆ _Thread_Add_timeout_ticks()

RTEMS_INLINE_ROUTINE void _Thread_Add_timeout_ticks | ( | Thread_Control * | the_thread,
|  | Per_CPU_Control * | cpu,
|  | Watchdog_Interval | ticks
| ) |  |

Adds timeout ticks to the thread.

Parameters

  [in,out] | the_thread | The thread to add the timeout ticks to.
  | cpu | The cpu for the operation.
  | ticks | The ticks to add to the timeout ticks.

## ◆ _Thread_Allocate_unlimited()

Objects_Control * _Thread_Allocate_unlimited | ( | Objects_Information * | information | ) |

Return an inactive thread object or NULL.

Return values

  NULL | No inactive object is available.
  object | An inactive object.

## ◆ _Thread_Cancel()

void _Thread_Cancel | ( | Thread_Control * | the_thread,
|  | Thread_Control * | executing,
|  | void * | exit_value
| ) |  |

Cancels the thread.

Parameters

  [in,out] | the_thread | The thread to cancel.
  | executing | The currently executing thread.
  | exit_value | The exit value for the thread.

## ◆ _Thread_Change_life()

Thread_Life_state _Thread_Change_life | ( | Thread_Life_state | clear,
|  | Thread_Life_state | set,
|  | Thread_Life_state | ignore
| ) |  |

Changes the currently executing thread to a new state with the sets.

Parameters

  clear | States to clear.
  set | States to set.
  ignore | States to ignore.

Returns
  The previous state the thread was in.

## ◆ _Thread_Clear_state()

States_Control _Thread_Clear_state | ( | Thread_Control * | the_thread,
|  | States_Control | state
| ) |  |

Clears the specified thread state.

In the case the previous state is a non-ready state and the next state is the ready state, then the thread is unblocked by the scheduler.

Parameters

  [in,out] | the_thread | The thread.
  | state | The state to clear. It must not be zero.

Returns
  The previous state.

## ◆ _Thread_Clear_state_locked()

States_Control _Thread_Clear_state_locked | ( | Thread_Control * | the_thread,
|  | States_Control | state
| ) |  |

Clears the specified thread state without locking the lock context.

In the case the previous state is a non-ready state and the next state is the ready state, then the thread is unblocked by the scheduler.

Parameters

  [in,out] | the_thread | The thread.
  | state | The state to clear. It must not be zero.

Returns
  The thread's previous state.

## ◆ _Thread_Close()

void _Thread_Close | ( | Thread_Control * | the_thread,
|  | Thread_Control * | executing,
|  | Thread_Close_context * | context
| ) |  |

Closes the thread.

Closes the thread object and starts the thread termination sequence. In case the executing thread is not terminated, then this function waits until the terminating thread reached the zombie state.

Parameters

  | the_thread | The thread to close.
  | executing | The currently executing thread.
  [in,out] | context | The thread close context.

## ◆ _Thread_Continue()

void _Thread_Continue | ( | Thread_Control * | the_thread,
|  | Status_Control | status
| ) |  |

Cancels a blocking operation so that the thread can continue its execution.

In case this function actually cancelled the blocking operation, then the thread wait return code is set to the specified status.

A specialization of this function is _Thread_Timeout().

Parameters

  [in,out] | the_thread | The thread.
  | status | The thread wait status.

## ◆ _Thread_Create_idle()

void _Thread_Create_idle | ( | void |  | ) |

Creates idle thread.

This routine creates the idle thread.

Warning
  No thread should be created before this one.

## ◆ _Thread_Deallocate_fp()

RTEMS_INLINE_ROUTINE void _Thread_Deallocate_fp | ( | void |  | ) |

Deallocates the currently loaded floating point context.

This routine is invoked when the currently loaded floating point context is now longer associated with an active thread.

## ◆ _Thread_Dispatch()

void _Thread_Dispatch | ( | void |  | ) |

Performs a thread dispatch if necessary.

This routine is responsible for transferring control of the processor from the executing thread to the heir thread. Once the heir is running an attempt is made to run the pending post-switch thread actions.

As part of this process, it is responsible for the following actions

- update timing information of the executing thread,
- save the context of the executing thread,
- invokation of the thread switch user extensions,
- restore the context of the heir thread, and
- run of pending post-switch thread actions of the resulting executing thread.

On entry the thread dispatch level must be equal to zero.

## ◆ _Thread_Dispatch_direct()

void _Thread_Dispatch_direct | ( | Per_CPU_Control * | cpu_self | ) |

Directly do a thread dispatch.

Must be called with a thread dispatch disable level of one, otherwise the INTERNAL_ERROR_BAD_THREAD_DISPATCH_DISABLE_LEVEL will occur. This function is useful for operations which synchronously block, e.g. self restart, self deletion, yield, sleep.

Parameters

  cpu_self | The current processor.

See also
  _Thread_Dispatch().

## ◆ _Thread_Dispatch_disable()

RTEMS_INLINE_ROUTINE Per_CPU_Control * _Thread_Dispatch_disable | ( | void |  | ) |

Disables thread dispatching.

Returns
  The current processor.

## ◆ _Thread_Dispatch_disable_critical()

RTEMS_INLINE_ROUTINE Per_CPU_Control * _Thread_Dispatch_disable_critical | ( | const ISR_lock_Context * | lock_context | ) |

Disables thread dispatching inside a critical section (interrupts disabled).

Parameters

  lock_context | The lock context of the corresponding _ISR_lock_ISR_disable() that started the critical section.

Returns
  The current processor.

## ◆ _Thread_Dispatch_disable_with_CPU()

RTEMS_INLINE_ROUTINE Per_CPU_Control * _Thread_Dispatch_disable_with_CPU | ( | Per_CPU_Control * | cpu_self,
|  | const ISR_lock_Context * | lock_context
| ) |  |

Disables thread dispatching inside a critical section (interrupts disabled) with the current processor.

Parameters

  cpu_self | The current processor.
  lock_context | The lock context of the corresponding _ISR_lock_ISR_disable() that started the critical section.

Returns
  The current processor.

## ◆ _Thread_Dispatch_enable()

void _Thread_Dispatch_enable | ( | Per_CPU_Control * | cpu_self | ) |

Enables thread dispatching.

May perform a thread dispatch if necessary as a side-effect.

Parameters

  [in,out] | cpu_self | The current processor.

## ◆ _Thread_Dispatch_get_disable_level()

RTEMS_INLINE_ROUTINE uint32_t _Thread_Dispatch_get_disable_level | ( | void |  | ) |

Gets thread dispatch disable level.

Returns
  The value of the thread dispatch level.

## ◆ _Thread_Dispatch_initialization()

RTEMS_INLINE_ROUTINE void _Thread_Dispatch_initialization | ( | void |  | ) |

Thread dispatch initialization.

This routine initializes the thread dispatching subsystem.

## ◆ _Thread_Dispatch_is_enabled()

RTEMS_INLINE_ROUTINE bool _Thread_Dispatch_is_enabled | ( | void |  | ) |

Indicates if the executing thread is inside a thread dispatch critical section.

Return values

  true | Thread dispatching is enabled.
  false | The executing thread is inside a thread dispatch critical section and dispatching is not allowed.

## ◆ _Thread_Dispatch_request()

RTEMS_INLINE_ROUTINE void _Thread_Dispatch_request | ( | Per_CPU_Control * | cpu_self,
|  | Per_CPU_Control * | cpu_target
| ) |  |

Requests a thread dispatch on the target processor.

Parameters

  [in,out] | cpu_self | The current processor.
  [in,out] | cpu_target | The target processor to request a thread dispatch.

## ◆ _Thread_Dispatch_unnest()

RTEMS_INLINE_ROUTINE void _Thread_Dispatch_unnest | ( | Per_CPU_Control * | cpu_self | ) |

Unnests thread dispatching.

Parameters

  [in,out] | cpu_self | The current processor.

## ◆ _Thread_Do_dispatch()

void _Thread_Do_dispatch | ( | Per_CPU_Control * | cpu_self,
|  | ISR_Level | level
| ) |  |

Performs a thread dispatch on the current processor.

On entry the thread dispatch disable level must be equal to one and interrupts must be disabled.

This function assumes that a thread dispatch is necessary.

Parameters

  cpu_self | The current processor.
  level | The previous interrupt level.

See also
  _Thread_Dispatch().

## ◆ _Thread_Entry_adaptor_idle()

void _Thread_Entry_adaptor_idle | ( | Thread_Control * | executing | ) |

Calls the start kinds idle entry of the thread.

Parameters

  executing | The currently executing thread.

## ◆ _Thread_Entry_adaptor_numeric()

void _Thread_Entry_adaptor_numeric | ( | Thread_Control * | executing | ) |

Calls the start kinds numeric entry of the thread.

Parameters

  executing | The currently executing thread.

## ◆ _Thread_Entry_adaptor_pointer()

void _Thread_Entry_adaptor_pointer | ( | Thread_Control * | executing | ) |

Calls the start kinds pointer entry of the thread.

Stores the return value in the Wait.return_argument of the thread.

Parameters

  executing | The currently executing thread.

## ◆ _Thread_Exit()

void _Thread_Exit | ( | Thread_Control * | executing,
|  | Thread_Life_state | set,
|  | void * | exit_value
| ) |  |

Exits the currently executing thread.

Parameters

  [in,out] | executing | The currently executing thread.
  | set | The states to set.
  [out] | exit_value | Contains the exit value of the thread.

## ◆ _Thread_Get()

Thread_Control * _Thread_Get | ( | Objects_Id | id,
|  | ISR_lock_Context * | lock_context
| ) |  |

Gets a thread by its identifier.

See also
  _Objects_Get().

Parameters

  id | The id of the thread.
  lock_context | The lock context.

## ◆ _Thread_Get_CPU()

RTEMS_INLINE_ROUTINE Per_CPU_Control * _Thread_Get_CPU | ( | const Thread_Control * | thread | ) |

Gets the cpu of the thread's scheduler.

Parameters

  thread | The thread.

Returns
  The cpu of the thread's scheduler.

## ◆ _Thread_Get_CPU_time_used()

void _Thread_Get_CPU_time_used | ( | Thread_Control * | the_thread,
|  | Timestamp_Control * | cpu_time_used
| ) |  |

Updates the used cpu time for the heir and dispatches a new heir.

Parameters

  [in,out] | cpu_self | The current processor.
  [in,out] | cpu_for_heir | The processor to do a dispatch on.
  | heir | The new heir for cpu_for_heir.

Gets the used cpu time of the thread and stores it in the given Timestamp_Control.

Parameters

  | the_thread | The thread to get the used cpu time of.
  [out] | cpu_time_used | Stores the used cpu time of the_thread.

## ◆ _Thread_Get_heir_and_make_it_executing()

RTEMS_INLINE_ROUTINE Thread_Control * _Thread_Get_heir_and_make_it_executing | ( | Per_CPU_Control * | cpu_self | ) |

Gets the heir of the processor and makes it executing.

Must be called with interrupts disabled. The thread dispatch necessary indicator is cleared as a side-effect.

Parameters

  [in,out] | cpu_self | The processor to get the heir of.

Returns
  The heir thread.

See also
  _Thread_Dispatch(), _Thread_Start_multitasking() and _Thread_Dispatch_update_heir().

## ◆ _Thread_Get_maximum_internal_threads()

RTEMS_INLINE_ROUTINE uint32_t _Thread_Get_maximum_internal_threads | ( | void |  | ) |

Gets the maximum number of internal threads.

Returns
  The maximum number of internal threads.

## ◆ _Thread_Get_name()

size_t _Thread_Get_name | ( | const Thread_Control * | the_thread,
|  | char * | buffer,
|  | size_t | buffer_size
| ) |  |

Gets the name of the thread.

Parameters

  | the_thread | The thread to get the name of.
  [out] | buffer | Contains the thread's name.
  | buffer_size | The size of buffer.

Returns
  The number of bytes copied to buffer.

## ◆ _Thread_Get_objects_information()

RTEMS_INLINE_ROUTINE Objects_Information * _Thread_Get_objects_information | ( | Objects_Id | id | ) |

Gets object information for the object id.

Parameters

  id | The id of the object information.

Return values

  pointer | The object information for this id.
  NULL | The object id is not valid.

## ◆ _Thread_Get_priority()

RTEMS_INLINE_ROUTINE Priority_Control _Thread_Get_priority | ( | const Thread_Control * | the_thread | ) |

Returns the priority of the thread.

Returns the user API and thread wait information relevant thread priority. This includes temporary thread priority adjustments due to locking protocols, a job release or the POSIX sporadic server for example.

Parameters

  the_thread | The thread of which to get the priority.

Returns
  The priority of the thread.

## ◆ _Thread_Get_unmapped_priority()

RTEMS_INLINE_ROUTINE Priority_Control _Thread_Get_unmapped_priority | ( | const Thread_Control * | the_thread | ) |

Returns the unmapped priority of the thread.

Parameters

  the_thread | The thread of which to get the unmapped priority.

Returns
  The unmapped priority of the thread.

## ◆ _Thread_Get_unmapped_real_priority()

RTEMS_INLINE_ROUTINE Priority_Control _Thread_Get_unmapped_real_priority | ( | const Thread_Control * | the_thread | ) |

Returns the unmapped real priority of the thread.

Parameters

  the_thread | The thread of which to get the unmapped real priority.

Returns
  The unmapped real priority of the thread.

## ◆ _Thread_Handler()

void _Thread_Handler | ( | void |  | ) |

Wrapper function for all threads.

This routine is the wrapper function for all threads. It is the starting point for all threads. The user provided thread entry point is invoked by this routine. Operations which must be performed immediately before and after the user's thread executes are found here.

Note
  On entry, it is assumed all interrupts are blocked and that this routine needs to set the initial isr level. This may or may not actually be needed by the context switch routine and as a result interrupts may already be at there proper level. Either way, setting the initial isr level properly here is safe.

## ◆ _Thread_Handler_initialization()

void _Thread_Handler_initialization | ( | void |  | ) |

Initializes thread handler.

This routine performs the initialization necessary for this handler.

## ◆ _Thread_Initialize()

bool _Thread_Initialize | ( | Thread_Information * | information,
|  | Thread_Control * | the_thread,
|  | const Thread_Configuration * | config
| ) |  |

Initializes thread.

This routine initializes the specified the thread. It allocates all memory associated with this thread. It completes by adding the thread to the local object table so operations on this thread id are allowed.

Note
  If stack_area is NULL, it is allocated from the workspace.
  If the stack is allocated from the workspace, then it is guaranteed to be of at least minimum size.

Parameters

  information | The thread information.
  the_thread | The thread to initialize.
  config | The configuration of the thread to initialize.

Return values

  true | The thread initialization was successful.
  false | The thread initialization failed.

## ◆ _Thread_Initialize_information()

void _Thread_Initialize_information | ( | Thread_Information * | information | ) |

Initializes the thread information.

Parameters

  [out] | information | Information to initialize.

## ◆ _Thread_Internal_allocate()

RTEMS_INLINE_ROUTINE Thread_Control * _Thread_Internal_allocate | ( | void |  | ) |

Allocates an internal thread and returns it.

Return values

  pointer | Pointer to the allocated Thread_Control.
  NULL | The operation failed.

## ◆ _Thread_Is_allocated_fp()

RTEMS_INLINE_ROUTINE bool _Thread_Is_allocated_fp | ( | const Thread_Control * | the_thread | ) |

Checks if the floating point context of the thread is currently loaded in the floating point unit.

This function returns true if the floating point context of the_thread is currently loaded in the floating point unit, and false otherwise.

Parameters

  the_thread | The thread for the verification.

Return values

  true | The floating point context of the_thread is currently loaded in the floating point unit.
  false | The floating point context of the_thread is currently not loaded in the floating point unit.

## ◆ _Thread_Is_context_switch_necessary()

RTEMS_INLINE_ROUTINE bool _Thread_Is_context_switch_necessary | ( | void |  | ) |

Checks if dispatching is disabled.

This function returns true if dispatching is disabled, and false otherwise.

Return values

  true | Dispatching is disabled.
  false | Dispatching is enabled.

## ◆ _Thread_Is_executing()

RTEMS_INLINE_ROUTINE bool _Thread_Is_executing | ( | const Thread_Control * | the_thread | ) |

Checks if the thread is the currently executing thread.

This function returns true if the_thread is the currently executing thread, and false otherwise.

Parameters

  the_thread | The thread to verify if it is the currently executing thread.

Return values

  true | the_thread is the currently executing one.
  false | the_thread is not the currently executing one.

## ◆ _Thread_Is_heir()

RTEMS_INLINE_ROUTINE bool _Thread_Is_heir | ( | const Thread_Control * | the_thread | ) |

Checks if the thread is the heir.

This function returns true if the_thread is the heir thread, and false otherwise.

Parameters

  the_thread | The thread for the verification.

Return values

  true | the_thread is the heir.
  false | the_thread is not the heir.

## ◆ _Thread_Is_joinable()

RTEMS_INLINE_ROUTINE bool _Thread_Is_joinable | ( | const Thread_Control * | the_thread | ) |

Checks if the thread is joinable.

Parameters

  the_thread | The thread for the verification.

Return values

  true | life_state is joinable.
  false | life_state is not joinable.

## ◆ _Thread_Is_life_change_allowed()

RTEMS_INLINE_ROUTINE bool _Thread_Is_life_change_allowed | ( | Thread_Life_state | life_state | ) |

Checks if the thread life state allos life change.

Parameters

  life_state | The thread life state for the verification.

Return values

  true | life_state allows life change.
  false | life_state does not allow life change.

## ◆ _Thread_Is_life_changing()

RTEMS_INLINE_ROUTINE bool _Thread_Is_life_changing | ( | Thread_Life_state | life_state | ) |

Checks if the thread life state is life changing.

Parameters

  life_state | The thread life state for the verification.

Return values

  true | life_state is life changing.
  false | life_state is not life changing.

## ◆ _Thread_Is_life_restarting()

RTEMS_INLINE_ROUTINE bool _Thread_Is_life_restarting | ( | Thread_Life_state | life_state | ) |

Checks if the thread life state is restarting.

Parameters

  life_state | The thread life state for the verification.

Return values

  true | life_state is restarting.
  false | life_state is not restarting.

## ◆ _Thread_Is_life_terminating()

RTEMS_INLINE_ROUTINE bool _Thread_Is_life_terminating | ( | Thread_Life_state | life_state | ) |

Checks if the thread life state is terminating.

Parameters

  life_state | The thread life state for the verification.

Return values

  true | life_state is terminating.
  false | life_state is not terminating.

## ◆ _Thread_Is_null()

RTEMS_INLINE_ROUTINE bool _Thread_Is_null | ( | const Thread_Control * | the_thread | ) |

Checks if the thread is NULL.

Parameters

  the_thread | The thread for the verification.

Return values

  true | The thread is `NULL`.
  false | The thread is not `NULL`.

## ◆ _Thread_Is_ready()

RTEMS_INLINE_ROUTINE bool _Thread_Is_ready | ( | const Thread_Control * | the_thread | ) |

Checks if the thread is ready.

Parameters

  the_thread | The thread to check if it is ready.

Return values

  true | The thread is currently in the ready state.
  false | The thread is currently not ready.

## ◆ _Thread_Iterate()

void _Thread_Iterate | ( | Thread_Visitor | visitor,
|  | void * | arg
| ) |  |

Calls the visitor with all threads and the given argument until it is done.

Parameters

  visitor | Function that gets a thread and arg as parameters and returns if it is done.
  arg | Parameter for visitor

## ◆ _Thread_Join()

void _Thread_Join | ( | Thread_Control * | the_thread,
|  | States_Control | waiting_for_join,
|  | Thread_Control * | executing,
|  | Thread_queue_Context * | queue_context
| ) |  |

Joins the currently executing thread with the given thread to wait for.

Parameters

  [in,out] | the_thread | The thread to wait for.
  | waiting_for_join | The states control for the join.
  [in,out] | executing | The currently executing thread.
  | queue_context | The thread queue context.

## ◆ _Thread_Kill_zombies()

void _Thread_Kill_zombies | ( | void |  | ) |

Kills all zombie threads in the system.

Threads change into the zombie state as the last step in the thread termination sequence right before a context switch to the heir thread is initiated. Since the thread stack is still in use during this phase we have to postpone the thread stack reclamation until this point. On SMP configurations we may have to busy wait for context switch completion here.

## ◆ _Thread_Load_environment()

void _Thread_Load_environment | ( | Thread_Control * | the_thread | ) |

Initializes enviroment for a thread.

This routine initializes the context of the_thread to its appropriate starting state.

Parameters

  [in,out] | the_thread | The pointer to the thread control block.

## ◆ _Thread_Pin()

RTEMS_INLINE_ROUTINE void _Thread_Pin | ( | Thread_Control * | executing | ) |

Pin the executing thread.

Parameters

  executing | The currently executing thread.

## ◆ _Thread_Priority_add()

void _Thread_Priority_add | ( | Thread_Control * | the_thread,
|  | Priority_Node * | priority_node,
|  | Thread_queue_Context * | queue_context
| ) |  |

Adds the specified thread priority node to the corresponding thread priority aggregation.

The caller must be the owner of the thread wait lock.

Parameters

  the_thread | The thread.
  priority_node | The thread priority node to add.
  queue_context | The thread queue context to return an updated set of threads for _Thread_Priority_update(). The thread queue context must be initialized via _Thread_queue_Context_clear_priority_updates() before a call of this function.

See also
  _Thread_Wait_acquire().

## ◆ _Thread_Priority_change()

RTEMS_INLINE_ROUTINE void _Thread_Priority_change | ( | Thread_Control * | the_thread,
|  | Priority_Node * | priority_node,
|  | Priority_Control | new_priority,
|  | bool | prepend_it,
|  | Thread_queue_Context * | queue_context
| ) |  |

Changes the thread priority value of the specified thread priority node in the corresponding thread priority aggregation.

The caller must be the owner of the thread wait lock.

Parameters

  | the_thread | The thread.
  [out] | priority_node | The thread priority node to change.
  | new_priority | The new thread priority value of the thread priority node to change.
  | prepend_it | In case this is true, then the thread is prepended to its priority group in its home scheduler instance, otherwise it is appended.
  | queue_context | The thread queue context to return an updated set of threads for _Thread_Priority_update(). The thread queue context must be initialized via _Thread_queue_Context_clear_priority_updates() before a call of this function.

See also
  _Thread_Wait_acquire().

## ◆ _Thread_Priority_changed()

void _Thread_Priority_changed | ( | Thread_Control * | the_thread,
|  | Priority_Node * | priority_node,
|  | bool | prepend_it,
|  | Thread_queue_Context * | queue_context
| ) |  |

Propagates a thread priority value change in the specified thread priority node to the corresponding thread priority aggregation.

The caller must be the owner of the thread wait lock.

Parameters

  | the_thread | The thread.
  [out] | priority_node | The thread priority node to change.
  | prepend_it | In case this is true, then the thread is prepended to its priority group in its home scheduler instance, otherwise it is appended.
  | queue_context | The thread queue context to return an updated set of threads for _Thread_Priority_update(). The thread queue context must be initialized via _Thread_queue_Context_clear_priority_updates() before a call of this function.

See also
  _Thread_Wait_acquire().

## ◆ _Thread_Priority_highest()

RTEMS_INLINE_ROUTINE Priority_Control _Thread_Priority_highest | ( | Priority_Control | left,
|  | Priority_Control | right
| ) |  |

Returns the highest priority of the left and right thread priorities in the intuitive sense of priority.

Parameters

  left | The left thread priority.
  right | The right thread priority.

Returns
  The highest priority in the intuitive sense of priority.

## ◆ _Thread_Priority_less_than()

RTEMS_INLINE_ROUTINE bool _Thread_Priority_less_than | ( | Priority_Control | left,
|  | Priority_Control | right
| ) |  |

Updates the priority of the thread and changes it sticky level.

Parameters

  the_thread | The thread.
  sticky_level_change | The new value for the sticky level.

Checks if the left thread priority is less than the right thread priority in the intuitive sense of priority.

Parameters

  left | The left thread priority.
  right | The right thread priority.

Return values

  true | The left priority is less in the intuitive sense.
  false | The left priority is greater or equal in the intuitive sense.

## ◆ _Thread_Priority_perform_actions()

void _Thread_Priority_perform_actions | ( | Thread_Control * | start_of_path,
|  | Thread_queue_Context * | queue_context
| ) |  |

Checks if the thread is owner of the lock of the join queue.

Parameters

  the_thread | The thread for the verification.

Return values

  true | The thread is owner of the lock of the join queue.
  false | The thread is not owner of the lock of the join queue.

Performs the priority actions specified by the thread queue context along the thread queue path.

The caller must be the owner of the thread wait lock.

Parameters

  start_of_path | The start thread of the thread queue path.
  queue_context | The thread queue context specifying the thread queue path and initial thread priority actions.

See also
  _Thread_queue_Path_acquire_critical().

## ◆ _Thread_Priority_remove()

void _Thread_Priority_remove | ( | Thread_Control * | the_thread,
|  | Priority_Node * | priority_node,
|  | Thread_queue_Context * | queue_context
| ) |  |

Removes the specified thread priority node from the corresponding thread priority aggregation.

The caller must be the owner of the thread wait lock.

Parameters

  the_thread | The thread.
  priority_node | The thread priority node to remove.
  queue_context | The thread queue context to return an updated set of threads for _Thread_Priority_update(). The thread queue context must be initialized via _Thread_queue_Context_clear_priority_updates() before a call of this function.

See also
  _Thread_Wait_acquire().

## ◆ _Thread_Priority_replace()

void _Thread_Priority_replace | ( | Thread_Control * | the_thread,
|  | Priority_Node * | victim_node,
|  | Priority_Node * | replacement_node
| ) |  |

Replaces the victim priority node with the replacement priority node in the corresponding thread priority aggregation.

The caller must be the owner of the thread wait lock.

Parameters

  the_thread | The thread.
  victim_node | The victim thread priority node.
  replacement_node | The replacement thread priority node.

See also
  _Thread_Wait_acquire().

## ◆ _Thread_Priority_update()

void _Thread_Priority_update | ( | Thread_queue_Context * | queue_context | ) |

Updates the priority of all threads in the set.

Parameters

  queue_context | The thread queue context to return an updated set of threads for _Thread_Priority_update(). The thread queue context must be initialized via _Thread_queue_Context_clear_priority_updates() before a call of this function.

See also
  _Thread_Priority_add(), _Thread_Priority_change(), _Thread_Priority_changed() and _Thread_Priority_remove().

## ◆ _Thread_Remove_timer_and_unblock()

RTEMS_INLINE_ROUTINE void _Thread_Remove_timer_and_unblock | ( | Thread_Control * | the_thread,
|  | Thread_queue_Queue * | queue
| ) |  |

Remove the watchdog timer from the thread and unblock if necessary.

Parameters

  [in,out] | the_thread | The thread to remove the watchdog from and unblock if necessary.
  | queue | The thread queue.

## ◆ _Thread_Resource_count_decrement()

RTEMS_INLINE_ROUTINE void _Thread_Resource_count_decrement | ( | Thread_Control * | the_thread | ) |

Decrements the thread's resource count.

Parameters

  [in,out] | the_thread | The thread to decrement the resource count of.

## ◆ _Thread_Resource_count_increment()

RTEMS_INLINE_ROUTINE void _Thread_Resource_count_increment | ( | Thread_Control * | the_thread | ) |

Increments the thread's resource count.

Parameters

  [in,out] | the_thread | The thread to increase the resource count of.

## ◆ _Thread_Restart_other()

bool _Thread_Restart_other | ( | Thread_Control * | the_thread,
|  | const Thread_Entry_information * | entry,
|  | ISR_lock_Context * | lock_context
| ) |  |

Restarts the thread.

Parameters

  [in,out] | the_thread | The thread to restart.
  | entry | The start entry information for the_thread.
  | lock_context | The lock context.

Return values

  true | The operation was successful.
  false | The operation failed.

## ◆ _Thread_Restart_self()

void _Thread_Restart_self | ( | Thread_Control * | executing,
|  | const Thread_Entry_information * | entry,
|  | ISR_lock_Context * | lock_context
| ) |  |

Restarts the currently executing thread.

Parameters

  [in,out] | executing | The currently executing thread.
  | entry | The start entry information for executing.
  | lock_context | The lock context.

## ◆ _Thread_Restore_fp()

RTEMS_INLINE_ROUTINE void _Thread_Restore_fp | ( | Thread_Control * | executing | ) |

Restores the executing thread's floating point area.

Parameters

  executing | The currently executing thread.

## ◆ _Thread_Save_fp()

RTEMS_INLINE_ROUTINE void _Thread_Save_fp | ( | Thread_Control * | executing | ) |

Saves the executing thread's floating point area.

Parameters

  executing | The currently executing thread.

## ◆ _Thread_Scheduler_get_home()

RTEMS_INLINE_ROUTINE const Scheduler_Control * _Thread_Scheduler_get_home | ( | const Thread_Control * | the_thread | ) |

Gets the home scheduler of the thread.

Parameters

  the_thread | The thread to get the home scheduler of.

Returns
  The thread's home scheduler.

## ◆ _Thread_Scheduler_get_home_node()

RTEMS_INLINE_ROUTINE Scheduler_Node * _Thread_Scheduler_get_home_node | ( | const Thread_Control * | the_thread | ) |

Gets the scheduler's home node.

Parameters

  the_thread | The thread to get the home node of.

Returns
  The thread's home node.

## ◆ _Thread_Scheduler_get_node_by_index()

RTEMS_INLINE_ROUTINE Scheduler_Node * _Thread_Scheduler_get_node_by_index | ( | const Thread_Control * | the_thread,
|  | size_t | scheduler_index
| ) |  |

Gets the thread's scheduler node by index.

Parameters

  the_thread | The thread of which to get a scheduler node.
  scheduler_index | The index of the desired scheduler node.

Returns
  The scheduler node with the specified index.

## ◆ _Thread_Set_CPU()

RTEMS_INLINE_ROUTINE void _Thread_Set_CPU | ( | Thread_Control * | thread,
|  | Per_CPU_Control * | cpu
| ) |  |

Sets the cpu of the thread's scheduler.

Parameters

  [out] | thread | The thread.
  | cpu | The cpu to set.

## ◆ _Thread_Set_life_protection()

Thread_Life_state _Thread_Set_life_protection | ( | Thread_Life_state | state | ) |

Set the thread to life protected.

Calls _Thread_Change_life with the given state AND THREAD_LIFE_PROTECTED to set and THREAD_LIFE_PROTECTED to clear.

Parameters

  state | The states to set.

Returns
  The previous state the thread was in.

## ◆ _Thread_Set_name()

Status_Control _Thread_Set_name | ( | Thread_Control * | the_thread,
|  | const char * | name
| ) |  |

Sets the name of the thread.

Parameters

  [out] | the_thread | The thread to change the name of.
  | name | The new name for the thread.

Return values

  STATUS_SUCCESSFUL | The operation succeeded.
  STATUS_RESULT_TOO_LARGE | The name was too long.

## ◆ _Thread_Set_state()

States_Control _Thread_Set_state | ( | Thread_Control * | the_thread,
|  | States_Control | state
| ) |  |

Sets the specified thread state.

In the case the previous state is the ready state, then the thread is blocked by the scheduler.

Parameters

  [in,out] | the_thread | The thread.
  | state | The state to set. It must not be zero.

Returns
  The previous state.

## ◆ _Thread_Set_state_locked()

States_Control _Thread_Set_state_locked | ( | Thread_Control * | the_thread,
|  | States_Control | state
| ) |  |

Sets the specified thread state without locking the lock context.

In the case the previous state is the ready state, then the thread is blocked by the scheduler.

Parameters

  [in,out] | the_thread | The thread.
  | state | The state to set. It must not be zero.

Returns
  The previous state.

## ◆ _Thread_Start()

bool _Thread_Start | ( | Thread_Control * | the_thread,
|  | const Thread_Entry_information * | entry,
|  | ISR_lock_Context * | lock_context
| ) |  |

Initializes thread and executes it.

This routine initializes the executable information for a thread and makes it ready to execute. After this routine executes, the thread competes with all other threads for CPU time.

Parameters

  the_thread | The thread to be started.
  entry | The thread entry information.

## ◆ _Thread_Start_multitasking()

void _Thread_Start_multitasking | ( | void |  | ) |

Starts thread multitasking.

This routine initiates multitasking. It is invoked only as part of initialization and its invocation is the last act of the non-multitasking part of the system initialization.

## ◆ _Thread_State_acquire()

RTEMS_INLINE_ROUTINE void _Thread_State_acquire | ( | Thread_Control * | the_thread,
|  | ISR_lock_Context * | lock_context
| ) |  |

Disables interrupts and acquires the lock_context.

Parameters

  the_thread | The thread to acquire the lock context.
  lock_context | The lock context.

## ◆ _Thread_State_acquire_critical()

RTEMS_INLINE_ROUTINE void _Thread_State_acquire_critical | ( | Thread_Control * | the_thread,
|  | ISR_lock_Context * | lock_context
| ) |  |

Acquires the lock context in a critical section.

Parameters

  the_thread | The thread to acquire the lock context.
  lock_context | The lock context.

## ◆ _Thread_State_acquire_for_executing()

RTEMS_INLINE_ROUTINE Thread_Control * _Thread_State_acquire_for_executing | ( | ISR_lock_Context * | lock_context | ) |

Disables interrupts and acquires the lock context for the currently executing thread.

Parameters

  lock_context | The lock context.

Returns
  The currently executing thread.

## ◆ _Thread_State_release()

RTEMS_INLINE_ROUTINE void _Thread_State_release | ( | Thread_Control * | the_thread,
|  | ISR_lock_Context * | lock_context
| ) |  |

Releases the lock context and enables interrupts.

Parameters

  [in,out] | the_thread | The thread to release the lock context.
  [out] | lock_context | The lock context.

## ◆ _Thread_State_release_critical()

RTEMS_INLINE_ROUTINE void _Thread_State_release_critical | ( | Thread_Control * | the_thread,
|  | ISR_lock_Context * | lock_context
| ) |  |

Release the lock context in a critical section.

Parameters

  the_thread | The thread to release the lock context.
  lock_context | The lock context.

## ◆ _Thread_Timeout()

void _Thread_Timeout | ( | Watchdog_Control * | the_watchdog | ) |

General purpose thread wait timeout.

Parameters

  the_watchdog | The thread timer watchdog.

## ◆ _Thread_Timer_initialize()

RTEMS_INLINE_ROUTINE void _Thread_Timer_initialize | ( | Thread_Timer_information * | timer,
|  | Per_CPU_Control * | cpu
| ) |  |

Initializes the thread timer.

Parameters

  [in,out] | timer | The timer to initialize.
  | cpu | The cpu for the operation.

## ◆ _Thread_Timer_insert_realtime()

RTEMS_INLINE_ROUTINE void _Thread_Timer_insert_realtime | ( | Thread_Control * | the_thread,
|  | Per_CPU_Control * | cpu,
|  | Watchdog_Service_routine_entry | routine,
|  | uint64_t | expire
| ) |  |

Inserts the cpu's watchdog realtime into the thread's timer.

Parameters

  [in,out] | the_thread | for the operation.
  | cpu | The cpu to get the watchdog header from.
  | routine | The watchdog routine for the thread.
  | expire | Expiration for the watchdog.

## ◆ _Thread_Timer_remove()

RTEMS_INLINE_ROUTINE void _Thread_Timer_remove | ( | Thread_Control * | the_thread | ) |

Remove the watchdog timer from the thread.

Parameters

  [in,out] | the_thread | The thread to remove the watchdog from.

## ◆ _Thread_Unblock()

RTEMS_INLINE_ROUTINE void _Thread_Unblock | ( | Thread_Control * | the_thread | ) |

Unblocks the thread.

This routine clears any blocking state for the_thread. It performs any necessary scheduling operations including the selection of a new heir thread.

Parameters

  [in,out] | the_thread | The thread to unblock.

## ◆ _Thread_Unpin()

RTEMS_INLINE_ROUTINE void _Thread_Unpin | ( | Thread_Control * | executing,
|  | Per_CPU_Control * | cpu_self
| ) |  |

Unpins the thread.

Parameters

  executing | The currently executing thread.
  cpu_self | The cpu for the operation.

## ◆ _Thread_Update_CPU_time_used()

RTEMS_INLINE_ROUTINE void _Thread_Update_CPU_time_used | ( | Thread_Control * | the_thread,
|  | Per_CPU_Control * | cpu
| ) |  |

Updates the cpu time used of the thread.

Parameters

  [in,out] | the_thread | The thread to add additional cpu time that is used.
  | cpu | The cpu.

## ◆ _Thread_Wait_acquire()

RTEMS_INLINE_ROUTINE void _Thread_Wait_acquire | ( | Thread_Control * | the_thread,
|  | Thread_queue_Context * | queue_context
| ) |  |

Acquires the thread wait default lock and disables interrupts.

Parameters

  [in,out] | the_thread | The thread.
  [in,out] | queue_context | The thread queue context for the corresponding _Thread_Wait_release().

## ◆ _Thread_Wait_acquire_critical()

RTEMS_INLINE_ROUTINE void _Thread_Wait_acquire_critical | ( | Thread_Control * | the_thread,
|  | Thread_queue_Context * | queue_context
| ) |  |

Acquires the thread wait lock inside a critical section (interrupts disabled).

Parameters

  [in,out] | the_thread | The thread.
  [in,out] | queue_context | The thread queue context for the corresponding _Thread_Wait_release_critical().

## ◆ _Thread_Wait_acquire_default()

RTEMS_INLINE_ROUTINE void _Thread_Wait_acquire_default | ( | Thread_Control * | the_thread,
|  | ISR_lock_Context * | lock_context
| ) |  |

Acquires the thread wait default lock and disables interrupts.

Parameters

  [in,out] | the_thread | The thread.
  [out] | lock_context | The lock context used for the corresponding lock release.

See also
  _Thread_Wait_release_default().

## ◆ _Thread_Wait_acquire_default_critical()

RTEMS_INLINE_ROUTINE void _Thread_Wait_acquire_default_critical | ( | Thread_Control * | the_thread,
|  | ISR_lock_Context * | lock_context
| ) |  |

Acquires the thread wait default lock inside a critical section (interrupts disabled).

Parameters

  [in,out] | the_thread | The thread.
  | lock_context | The lock context used for the corresponding lock release.

See also
  _Thread_Wait_release_default_critical().

## ◆ _Thread_Wait_acquire_default_for_executing()

RTEMS_INLINE_ROUTINE Thread_Control * _Thread_Wait_acquire_default_for_executing | ( | ISR_lock_Context * | lock_context | ) |

Acquires the thread wait default lock and returns the executing thread.

Parameters

  lock_context | The lock context used for the corresponding lock release.

Returns
  The executing thread.

See also
  _Thread_Wait_release_default().

## ◆ _Thread_Wait_cancel()

RTEMS_INLINE_ROUTINE void _Thread_Wait_cancel | ( | Thread_Control * | the_thread,
|  | Thread_queue_Context * | queue_context
| ) |  |

Cancels a thread wait on a thread queue.

Parameters

  [in,out] | the_thread | The thread.
  | queue_context | The thread queue context used for corresponding _Thread_Wait_acquire().

## ◆ _Thread_Wait_claim()

RTEMS_INLINE_ROUTINE void _Thread_Wait_claim | ( | Thread_Control * | the_thread,
|  | Thread_queue_Queue * | queue
| ) |  |

Claims the thread wait queue.

The caller must not be the owner of the default thread wait lock. The caller must be the owner of the corresponding thread queue lock. The registration of the corresponding thread queue operations is deferred and done after the deadlock detection. This is crucial to support timeouts on SMP configurations.

Parameters

  [in,out] | the_thread | The thread.
  [in,out] | queue | The new thread queue.

See also
  _Thread_Wait_claim_finalize() and _Thread_Wait_restore_default().

## ◆ _Thread_Wait_claim_finalize()

RTEMS_INLINE_ROUTINE void _Thread_Wait_claim_finalize | ( | Thread_Control * | the_thread,
|  | const Thread_queue_Operations * | operations
| ) |  |

Finalizes the thread wait queue claim via registration of the corresponding thread queue operations.

Parameters

  [in,out] | the_thread | The thread.
  | operations | The corresponding thread queue operations.

## ◆ _Thread_Wait_flags_get()

RTEMS_INLINE_ROUTINE Thread_Wait_flags _Thread_Wait_flags_get | ( | const Thread_Control * | the_thread | ) |

Gets the thread's wait flags according to the ATOMIC_ORDER_RELAXED.

Parameters

  the_thread | The thread to get the wait flags of.

Returns
  The thread's wait flags.

## ◆ _Thread_Wait_flags_get_acquire()

RTEMS_INLINE_ROUTINE Thread_Wait_flags _Thread_Wait_flags_get_acquire | ( | const Thread_Control * | the_thread | ) |

Gets the thread's wait flags according to the ATOMIC_ORDER_ACQUIRE.

Parameters

  the_thread | The thread to get the wait flags of.

Returns
  The thread's wait flags.

## ◆ _Thread_Wait_flags_set()

RTEMS_INLINE_ROUTINE void _Thread_Wait_flags_set | ( | Thread_Control * | the_thread,
|  | Thread_Wait_flags | flags
| ) |  |

Sets the thread's wait flags.

Parameters

  [in,out] | the_thread | The thread to set the wait flags of.
  | flags | The flags to set.

## ◆ _Thread_Wait_flags_try_change_acquire()

RTEMS_INLINE_ROUTINE bool _Thread_Wait_flags_try_change_acquire | ( | Thread_Control * | the_thread,
|  | Thread_Wait_flags | expected_flags,
|  | Thread_Wait_flags | desired_flags
| ) |  |

Tries to change the thread wait flags with acquire semantics.

In case the wait flags are equal to the expected wait flags, then the wait flags are set to the desired wait flags.

Parameters

  the_thread | The thread.
  expected_flags | The expected wait flags.
  desired_flags | The desired wait flags.

Return values

  true | The wait flags were equal to the expected wait flags.
  false | The wait flags were not equal to the expected wait flags.

## ◆ _Thread_Wait_flags_try_change_release()

RTEMS_INLINE_ROUTINE bool _Thread_Wait_flags_try_change_release | ( | Thread_Control * | the_thread,
|  | Thread_Wait_flags | expected_flags,
|  | Thread_Wait_flags | desired_flags
| ) |  |

Tries to change the thread wait flags with release semantics in case of success.

Must be called inside a critical section (interrupts disabled).

In case the wait flags are equal to the expected wait flags, then the wait flags are set to the desired wait flags.

Parameters

  the_thread | The thread.
  expected_flags | The expected wait flags.
  desired_flags | The desired wait flags.

Return values

  true | The wait flags were equal to the expected wait flags.
  false | The wait flags were not equal to the expected wait flags.

## ◆ _Thread_Wait_get_id()

Objects_Id _Thread_Wait_get_id | ( | const Thread_Control * | the_thread | ) |

Returns the object identifier of the object containing the current thread wait queue.

This function may be used for debug and system information purposes. The caller must be the owner of the thread lock.

Parameters

  the_thread | The thread.

Return values

  0 | The thread waits on no thread queue currently, the thread wait queue is not contained in an object, or the current thread state provides insufficient information, e.g. the thread is in the middle of a blocking operation.
  other | The object identifier of the object containing the thread wait queue.

## ◆ _Thread_Wait_get_status()

RTEMS_INLINE_ROUTINE Status_Control _Thread_Wait_get_status | ( | const Thread_Control * | the_thread | ) |

Get the status of the wait return code of the thread.

Parameters

  the_thread | The thread to get the status of the wait return code of.

## ◆ _Thread_Wait_release()

RTEMS_INLINE_ROUTINE void _Thread_Wait_release | ( | Thread_Control * | the_thread,
|  | Thread_queue_Context * | queue_context
| ) |  |

Releases the thread wait lock and restores the previous interrupt status.

Parameters

  [in,out] | the_thread | The thread.
  [in,out] | queue_context | The thread queue context used for corresponding _Thread_Wait_acquire().

## ◆ _Thread_Wait_release_critical()

RTEMS_INLINE_ROUTINE void _Thread_Wait_release_critical | ( | Thread_Control * | the_thread,
|  | Thread_queue_Context * | queue_context
| ) |  |

Releases the thread wait lock inside a critical section (interrupts disabled).

The previous interrupt status is not restored.

Parameters

  [in,out] | the_thread | The thread.
  [in,out] | queue_context | The thread queue context used for corresponding _Thread_Wait_acquire_critical().

## ◆ _Thread_Wait_release_default()

RTEMS_INLINE_ROUTINE void _Thread_Wait_release_default | ( | Thread_Control * | the_thread,
|  | ISR_lock_Context * | lock_context
| ) |  |

Releases the thread wait default lock and restores the previous interrupt status.

Parameters

  [in,out] | the_thread | The thread.
  [out] | lock_context | The lock context used for the corresponding lock acquire.

## ◆ _Thread_Wait_release_default_critical()

RTEMS_INLINE_ROUTINE void _Thread_Wait_release_default_critical | ( | Thread_Control * | the_thread,
|  | ISR_lock_Context * | lock_context
| ) |  |

Releases the thread wait default lock inside a critical section (interrupts disabled).

The previous interrupt status is not restored.

Parameters

  [in,out] | the_thread | The thread.
  | lock_context | The lock context used for the corresponding lock acquire.

## ◆ _Thread_Wait_remove_request()

RTEMS_INLINE_ROUTINE void _Thread_Wait_remove_request | ( | Thread_Control * | the_thread,
|  | Thread_queue_Lock_context * | queue_lock_context
| ) |  |

Removes a thread wait lock request.

On SMP configurations, removes a thread wait lock request.

On other configurations, this function does nothing.

Parameters

  [in,out] | the_thread | The thread.
  [in,out] | queue_lock_context | The thread queue lock context used for corresponding _Thread_Wait_acquire().

## ◆ _Thread_Wait_restore_default()

RTEMS_INLINE_ROUTINE void _Thread_Wait_restore_default | ( | Thread_Control * | the_thread | ) |

Restores the default thread wait queue and operations.

The caller must be the owner of the current thread wait queue lock.

On SMP configurations, the pending requests are updated to use the stale thread queue operations.

Parameters

  [in,out] | the_thread | The thread.

See also
  _Thread_Wait_claim().

## ◆ _Thread_Wait_tranquilize()

RTEMS_INLINE_ROUTINE void _Thread_Wait_tranquilize | ( | Thread_Control * | the_thread | ) |

Tranquilizes the thread after a wait on a thread queue.

After the violent blocking procedure this function makes the thread calm and peaceful again so that it can carry out its normal work.

On SMP configurations, ensures that all pending thread wait lock requests completed before the thread is able to begin a new thread wait procedure.

On other configurations, this function does nothing.

It must be called after a _Thread_Wait_claim() exactly once

- after the corresponding thread queue lock was released, and
- the default wait state is restored or some other processor is about to do this.

Parameters

  the_thread | The thread.

## ◆ _Thread_Yield()

void _Thread_Yield | ( | Thread_Control * | executing | ) |

Yields the currently executing thread.

Parameters

  [in,out] | executing | The thread that performs a yield.

## ◆ rtems_iterate_over_all_threads()

void rtems_iterate_over_all_threads | ( | rtems_per_thread_routine | routine | ) |

Deprecated, use rtems_task_iterate() instead.

Use rtems_task_iterate() instead.

## Variable Documentation

## ◆ _Thread_Allocated_fp

Thread_Control* _Thread_Allocated_fp
| extern

The following points to the thread whose floating point context is currently loaded.

## ◆ _Thread_Control_add_on_count

const size_t _Thread_Control_add_on_count
| extern

Thread control add-on count.

Count of entries in _Thread_Control_add_ons.

This value is provided via <rtems/confdefs.h>.

## ◆ _Thread_Control_add_ons

const Thread_Control_add_on _Thread_Control_add_ons[]
| extern

Thread control add-ons.

The thread control block contains fields that point to application configuration dependent memory areas, like the scheduler information, the API control blocks, the user extension context table, and the Newlib re-entrancy support. Account for these areas in the configuration and avoid extra workspace allocations for these areas.

This array is provided via <rtems/confdefs.h>.

See also
  _Thread_Control_add_on_count.

## ◆ _Thread_Global_constructor

Objects_Id _Thread_Global_constructor
| extern

Object identifier of the global constructor thread.

This variable is set by _RTEMS_tasks_Initialize_user_tasks_body() or _POSIX_Threads_Initialize_user_threads_body().

It is consumed by _Thread_Handler().

## ◆ _Thread_Idle_body

const Thread_Idle_body _Thread_Idle_body
| extern

The idle thread body.

This constant is defined by the application configuration via <rtems/confdefs.h>.

## ◆ _Thread_Idle_stack_size

const size_t _Thread_Idle_stack_size
| extern

The idle thread stack size in bytes.

This constant is defined by the application configuration via <rtems/confdefs.h>.

## ◆ _Thread_Idle_stacks

char _Thread_Idle_stacks[]
| extern

The idle thread stacks.

Provided by the application via <rtems/confdefs.h>.

## ◆ _Thread_Initial_thread_count

const size_t _Thread_Initial_thread_count
| extern

Count of configured threads.

This value is provided via <rtems/confdefs.h>.

## ◆ _Thread_Maximum_name_size

const size_t _Thread_Maximum_name_size
| extern

Maximum size of a thread name in characters (including the terminating '\0' character).

This value is provided via <rtems/confdefs.h>.

## ◆ rtems_ada_self

void* rtems_ada_self
| extern

Self for the GNU Ada Run-Time