RTEMS
5.1
|
Thread Queue Handler. More...
Files | |
file | threadq.h |
Constants and Structures Needed to Declare a Thread Queue. | |
file | threadqimpl.h |
Constants and Structures Associated with the Manipulation of Objects. | |
Data Structures | |
struct | Thread_queue_Lock_context |
struct | Thread_queue_Context |
Thread queue context for the thread queue methods. More... | |
struct | Thread_queue_Priority_queue |
Thread priority queue. More... | |
struct | _Thread_queue_Heads |
Thread queue heads. More... | |
struct | Thread_queue_Queue |
struct | Thread_queue_Operations |
Thread queue operations. More... | |
struct | Thread_queue_Control |
struct | Thread_queue_Syslock_queue |
Thread queue with a layout compatible to struct _Thread_queue_Queue defined in Newlib <sys/lock.h>. More... | |
struct | Thread_queue_Object |
Does nothing. More... | |
Macros | |
#define | THREAD_QUEUE_LINK_OF_PATH_NODE(node) RTEMS_CONTAINER_OF( node, Thread_queue_Link, Path_node ); |
#define | _Thread_queue_Context_ISR_disable(queue_context, level) |
#define | _Thread_queue_Context_set_MP_callout(queue_context, mp_callout) |
Sets the MP callout in the thread queue context. More... | |
#define | _Thread_queue_Queue_acquire_critical(queue, lock_stats, lock_context) _Thread_queue_Queue_do_acquire_critical( queue, lock_context ) |
#define | _Thread_queue_Dequeue(the_thread_queue, operations, mp_callout) |
Gets a pointer to a thread waiting on the_thread_queue. More... | |
#define | THREAD_QUEUE_INITIALIZER(_name) |
#define | THREAD_QUEUE_OBJECT_ASSERT(object_type, wait_queue_member, msg) |
#define | THREAD_QUEUE_QUEUE_TO_OBJECT(queue) |
Typedefs | |
typedef struct _Thread_Control | Thread_Control |
typedef struct Thread_queue_Context | Thread_queue_Context |
typedef struct Thread_queue_Queue | Thread_queue_Queue |
typedef struct Thread_queue_Operations | Thread_queue_Operations |
typedef void(* | Thread_queue_Enqueue_callout) (Thread_queue_Queue *queue, Thread_Control *the_thread, struct Per_CPU_Control *cpu_self, Thread_queue_Context *queue_context) |
Thread queue enqueue callout. More... | |
typedef void(* | Thread_queue_Deadlock_callout) (Thread_Control *the_thread) |
Thread queue deadlock callout. More... | |
typedef struct _Thread_queue_Heads | Thread_queue_Heads |
Thread queue heads. More... | |
typedef void(* | Thread_queue_Priority_actions_operation) (Thread_queue_Queue *queue, Priority_Actions *priority_actions) |
Thread queue action operation. More... | |
typedef void(* | Thread_queue_Enqueue_operation) (Thread_queue_Queue *queue, Thread_Control *the_thread, Thread_queue_Context *queue_context) |
Thread queue enqueue operation. More... | |
typedef void(* | Thread_queue_Extract_operation) (Thread_queue_Queue *queue, Thread_Control *the_thread, Thread_queue_Context *queue_context) |
Thread queue extract operation. More... | |
typedef Thread_Control *(* | Thread_queue_Surrender_operation) (Thread_queue_Queue *queue, Thread_queue_Heads *heads, Thread_Control *previous_owner, Thread_queue_Context *queue_context) |
Thread queue surrender operation. More... | |
typedef Thread_Control *(* | Thread_queue_First_operation) (Thread_queue_Heads *heads) |
Thread queue first operation. More... | |
typedef Thread_Control *(* | Thread_queue_Flush_filter) (Thread_Control *the_thread, Thread_queue_Queue *queue, Thread_queue_Context *queue_context) |
Thread queue flush filter function. More... | |
Functions | |
void | _Thread_queue_Enqueue_do_nothing_extra (Thread_queue_Queue *queue, Thread_Control *the_thread, Per_CPU_Control *cpu_self, Thread_queue_Context *queue_context) |
Does nothing. More... | |
void | _Thread_queue_Add_timeout_ticks (Thread_queue_Queue *queue, Thread_Control *the_thread, Per_CPU_Control *cpu_self, Thread_queue_Context *queue_context) |
Adds timeout ticks of the queue to the thread. More... | |
void | _Thread_queue_Add_timeout_monotonic_timespec (Thread_queue_Queue *queue, Thread_Control *the_thread, Per_CPU_Control *cpu_self, Thread_queue_Context *queue_context) |
Adds a monotonic timespec to the thread and sets the watchdog header to monotonic. More... | |
void | _Thread_queue_Add_timeout_realtime_timespec (Thread_queue_Queue *queue, Thread_Control *the_thread, Per_CPU_Control *cpu_self, Thread_queue_Context *queue_context) |
Adds a monotonic timespec to the thread and sets the watchdog header to realtime. More... | |
void | _Thread_queue_Deadlock_status (Thread_Control *the_thread) |
Sets the thread wait return code to STATUS_DEADLOCK. More... | |
void | _Thread_queue_Deadlock_fatal (Thread_Control *the_thread) |
Results in an INTERNAL_ERROR_THREAD_QUEUE_DEADLOCK fatal error. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_initialize (Thread_queue_Context *queue_context) |
Initializes a thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_thread_state (Thread_queue_Context *queue_context, States_Control thread_state) |
Sets the thread state for the thread to enqueue in the thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_timeout_ticks (Thread_queue_Context *queue_context, Watchdog_Interval ticks) |
Sets the timeout ticks in the thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_timeout_argument (Thread_queue_Context *queue_context, const void *arg) |
Sets the timeout argument in the thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_enqueue_callout (Thread_queue_Context *queue_context, Thread_queue_Enqueue_callout enqueue_callout) |
Sets the enqueue callout in the thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_enqueue_do_nothing_extra (Thread_queue_Context *queue_context) |
Sets the do nothing enqueue callout in the thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_enqueue_timeout_ticks (Thread_queue_Context *queue_context, Watchdog_Interval ticks) |
Sets the enqueue callout to add a relative monotonic timeout in ticks. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_enqueue_timeout_monotonic_timespec (Thread_queue_Context *queue_context, const struct timespec *abstime) |
Sets the enqueue callout to add an absolute monotonic timeout in timespec format. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_enqueue_timeout_realtime_timespec (Thread_queue_Context *queue_context, const struct timespec *abstime) |
Sets the enqueue callout to add an absolute realtime timeout in timespec format. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_deadlock_callout (Thread_queue_Context *queue_context, Thread_queue_Deadlock_callout deadlock_callout) |
Sets the deadlock callout in the thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_clear_priority_updates (Thread_queue_Context *queue_context) |
Clears the priority update count of the thread queue context. More... | |
RTEMS_INLINE_ROUTINE size_t | _Thread_queue_Context_save_priority_updates (Thread_queue_Context *queue_context) |
Returns the priority update count of the thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_restore_priority_updates (Thread_queue_Context *queue_context, size_t update_count) |
Sets the priority update count of the thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_add_priority_update (Thread_queue_Context *queue_context, Thread_Control *the_thread) |
Adds a priority update of the thread to the thread queue context. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Context_set_ISR_level (Thread_queue_Context *queue_context, ISR_Level level) |
Sets the thread queue context ISR level. More... | |
RTEMS_INLINE_ROUTINE Per_CPU_Control * | _Thread_queue_Dispatch_disable (Thread_queue_Context *queue_context) |
Disables dispatching in a critical section. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Heads_initialize (Thread_queue_Heads *heads) |
Initializes the thread queue heads. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Queue_initialize (Thread_queue_Queue *queue, const char *name) |
Initializes the thread queue queue with the given name. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Queue_do_acquire_critical (Thread_queue_Queue *queue, ISR_lock_Context *lock_context) |
Acquires the thread queue queue in a critical section. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Queue_release_critical (Thread_queue_Queue *queue, ISR_lock_Context *lock_context) |
Releases the thread queue queue in a critical section. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Queue_release (Thread_queue_Queue *queue, ISR_lock_Context *lock_context) |
Releases the thread queue queue and enables interrupts. More... | |
size_t | _Thread_queue_Queue_get_name_and_id (const Thread_queue_Queue *queue, char *buffer, size_t buffer_size, Objects_Id *id) |
Copies the thread queue name to the specified buffer. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Do_acquire_critical (Thread_queue_Control *the_thread_queue, ISR_lock_Context *lock_context) |
Acquires the thread queue control in a critical section. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Acquire_critical (Thread_queue_Control *the_thread_queue, Thread_queue_Context *queue_context) |
Acquires the thread queue control in a critical section. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Acquire (Thread_queue_Control *the_thread_queue, Thread_queue_Context *queue_context) |
Acquires the thread queue control in a critical section. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Do_release_critical (Thread_queue_Control *the_thread_queue, ISR_lock_Context *lock_context) |
Checks if the thread queue control is the owner of the lock. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Release_critical (Thread_queue_Control *the_thread_queue, Thread_queue_Context *queue_context) |
Releases the thread queue control in a critical section. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Release (Thread_queue_Control *the_thread_queue, Thread_queue_Context *queue_context) |
Releases the thread queue control and enables interrupts. More... | |
Thread_Control * | _Thread_queue_Do_dequeue (Thread_queue_Control *the_thread_queue, const Thread_queue_Operations *operations) |
Dequeues the first thread waiting on the thread queue and returns it. More... | |
void | _Thread_queue_Enqueue (Thread_queue_Queue *queue, const Thread_queue_Operations *operations, Thread_Control *the_thread, Thread_queue_Context *queue_context) |
Blocks the thread and places it on the thread queue. More... | |
bool | _Thread_queue_Extract_locked (Thread_queue_Queue *queue, const Thread_queue_Operations *operations, Thread_Control *the_thread, Thread_queue_Context *queue_context) |
Extracts the thread from the thread queue, restores the default wait operations and restores the default thread lock. More... | |
void | _Thread_queue_Unblock_critical (bool unblock, Thread_queue_Queue *queue, Thread_Control *the_thread, ISR_lock_Context *lock_context) |
Unblocks the thread which was on the thread queue before. More... | |
void | _Thread_queue_Extract_critical (Thread_queue_Queue *queue, const Thread_queue_Operations *operations, Thread_Control *the_thread, Thread_queue_Context *queue_context) |
Extracts the thread from the thread queue and unblocks it. More... | |
void | _Thread_queue_Extract (Thread_Control *the_thread) |
Extracts thread from thread queue. More... | |
void | _Thread_queue_Extract_with_proxy (Thread_Control *the_thread) |
Extracts the_thread from the_thread_queue. More... | |
void | _Thread_queue_Surrender (Thread_queue_Queue *queue, Thread_queue_Heads *heads, Thread_Control *previous_owner, Thread_queue_Context *queue_context, const Thread_queue_Operations *operations) |
Surrenders the thread queue previously owned by the thread to the first enqueued thread. More... | |
RTEMS_INLINE_ROUTINE bool | _Thread_queue_Is_empty (const Thread_queue_Queue *queue) |
Checks if the thread queue queue is empty. More... | |
RTEMS_INLINE_ROUTINE Thread_Control * | _Thread_queue_First_locked (Thread_queue_Control *the_thread_queue, const Thread_queue_Operations *operations) |
Returns the first thread on the thread queue if it exists, otherwise NULL . More... | |
Thread_Control * | _Thread_queue_First (Thread_queue_Control *the_thread_queue, const Thread_queue_Operations *operations) |
Returns the first thread on the thread queue if it exists, otherwise NULL . More... | |
Thread_Control * | _Thread_queue_Flush_default_filter (Thread_Control *the_thread, Thread_queue_Queue *queue, Thread_queue_Context *queue_context) |
Default thread queue flush filter function. More... | |
Thread_Control * | _Thread_queue_Flush_status_unavailable (Thread_Control *the_thread, Thread_queue_Queue *queue, Thread_queue_Context *queue_context) |
Status unavailable thread queue flush filter function. More... | |
Thread_Control * | _Thread_queue_Flush_status_object_was_deleted (Thread_Control *the_thread, Thread_queue_Queue *queue, Thread_queue_Context *queue_context) |
Status object was deleted thread queue flush filter function. More... | |
size_t | _Thread_queue_Flush_critical (Thread_queue_Queue *queue, const Thread_queue_Operations *operations, Thread_queue_Flush_filter filter, Thread_queue_Context *queue_context) |
Unblocks all threads enqueued on the thread queue. More... | |
void | _Thread_queue_Initialize (Thread_queue_Control *the_thread_queue, const char *name) |
Initializes the thread queue control to the given name. More... | |
RTEMS_INLINE_ROUTINE void | _Thread_queue_Destroy (Thread_queue_Control *the_thread_queue) |
Destroys the thread queue. More... | |
void | _Thread_queue_Object_initialize (Thread_queue_Control *the_thread_queue) |
Initializes a thread queue embedded in an object with identifier. More... | |
Variables | |
const Thread_queue_Operations | _Thread_queue_Operations_default |
const Thread_queue_Operations | _Thread_queue_Operations_FIFO |
const Thread_queue_Operations | _Thread_queue_Operations_priority |
const Thread_queue_Operations | _Thread_queue_Operations_priority_inherit |
const char | _Thread_queue_Object_name [] |
The special thread queue name to indicated that the thread queue is embedded in an object with identifier. More... | |
Thread Queue Handler.
This handler provides the capability to have threads block in ordered sets. The sets may be ordered using the FIFO or priority discipline.
#define _Thread_queue_Context_ISR_disable | ( | queue_context, | |
level | |||
) |
#define _Thread_queue_Context_set_MP_callout | ( | queue_context, | |
mp_callout | |||
) |
Sets the MP callout in the thread queue context.
[out] | queue_context | The thread queue context. |
mp_callout | Callout to unblock the thread in case it is actually a thread proxy. This parameter is only used on multiprocessing configurations. Used by thread queue extract and unblock methods for objects with multiprocessing (MP) support. |
#define _Thread_queue_Dequeue | ( | the_thread_queue, | |
operations, | |||
mp_callout | |||
) |
Gets a pointer to a thread waiting on the_thread_queue.
This function returns a pointer to a thread waiting on the_thread_queue. The selection of this thread is based on the discipline of the_thread_queue. If no threads are waiting on the_thread_queue, then NULL is returned.
#define THREAD_QUEUE_INITIALIZER | ( | _name | ) |
#define THREAD_QUEUE_OBJECT_ASSERT | ( | object_type, | |
wait_queue_member, | |||
msg | |||
) |
#define THREAD_QUEUE_QUEUE_TO_OBJECT | ( | queue | ) |
typedef void( * Thread_queue_Deadlock_callout) (Thread_Control *the_thread) |
Thread queue deadlock callout.
the_thread | The thread that detected the deadlock. |
typedef void( * Thread_queue_Enqueue_callout) (Thread_queue_Queue *queue, Thread_Control *the_thread, struct Per_CPU_Control *cpu_self, Thread_queue_Context *queue_context) |
Thread queue enqueue callout.
[in] | queue | The actual thread queue. |
[in] | the_thread | The thread to enqueue. |
[in] | cpu_self | The current processor. |
[in] | queue_context | The thread queue context of the lock acquire. |
typedef void( * Thread_queue_Enqueue_operation) (Thread_queue_Queue *queue, Thread_Control *the_thread, Thread_queue_Context *queue_context) |
Thread queue enqueue operation.
A potential thread to update the priority due to priority inheritance is returned via the thread queue context. This thread is handed over to _Thread_Priority_update().
[in] | queue | The actual thread queue. |
[in] | the_thread | The thread to enqueue on the queue. |
typedef void( * Thread_queue_Extract_operation) (Thread_queue_Queue *queue, Thread_Control *the_thread, Thread_queue_Context *queue_context) |
Thread queue extract operation.
[in] | queue | The actual thread queue. |
[in] | the_thread | The thread to extract from the thread queue. |
typedef Thread_Control*( * Thread_queue_First_operation) (Thread_queue_Heads *heads) |
Thread queue first operation.
[in] | heads | The thread queue heads. |
NULL | No thread is present on the thread queue. |
first | The first thread of the thread queue according to the insert order. This thread remains on the thread queue. |
typedef Thread_Control*( * Thread_queue_Flush_filter) (Thread_Control *the_thread, Thread_queue_Queue *queue, Thread_queue_Context *queue_context) |
Thread queue flush filter function.
Called under protection of the thread queue lock by _Thread_queue_Flush_critical() to optionally alter the thread wait information and control the iteration.
the_thread | The thread to extract. This is the first parameter to optimize for architectures that use the same register for the first parameter and the return value. |
queue | The actual thread queue. |
queue_context | The thread queue context of the lock acquire. May be used to pass additional data to the filter function via an overlay structure. The filter function should not release or acquire the thread queue lock. |
the_thread | Extract this thread. |
NULL | Do not extract this thread and stop the thread queue flush operation. Threads that are already extracted will complete the flush operation. |
typedef struct _Thread_queue_Heads Thread_queue_Heads |
Thread queue heads.
Each thread is equipped with spare thread queue heads in case it is not enqueued on a thread queue. The first thread enqueued on a thread queue will give its spare thread queue heads to that thread queue. The threads arriving at the queue will add their thread queue heads to the free chain of the queue heads provided by the first thread enqueued. Once a thread is dequeued it use the free chain to get new spare thread queue heads.
Uses a leading underscore in the structure name to allow forward declarations in standard header files provided by Newlib and GCC.
typedef void( * Thread_queue_Priority_actions_operation) (Thread_queue_Queue *queue, Priority_Actions *priority_actions) |
Thread queue action operation.
[in] | queue | The actual thread queue. |
[in] | the_thread | The thread. |
[in] | queue_context | The thread queue context providing the thread queue action set to perform. Returns the thread queue action set to perform on the thread queue owner or the empty set in case there is nothing to do. |
typedef Thread_Control*( * Thread_queue_Surrender_operation) (Thread_queue_Queue *queue, Thread_queue_Heads *heads, Thread_Control *previous_owner, Thread_queue_Context *queue_context) |
Thread queue surrender operation.
This operation must dequeue and return the first thread on the queue.
[in] | queue | The actual thread queue. |
[in] | heads | The thread queue heads. It must not be NULL. |
[in] | previous_owner | The previous owner of the thread queue. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Acquire | ( | Thread_queue_Control * | the_thread_queue, |
Thread_queue_Context * | queue_context | ||
) |
Acquires the thread queue control in a critical section.
the_thread_queue | The thread queue control to acquire. | |
[out] | queue_context | The thread queue context. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Acquire_critical | ( | Thread_queue_Control * | the_thread_queue, |
Thread_queue_Context * | queue_context | ||
) |
Acquires the thread queue control in a critical section.
the_thread_queue | The thread queue control to acquire. | |
[out] | lock_context | The interrupt lock context. |
void _Thread_queue_Add_timeout_monotonic_timespec | ( | Thread_queue_Queue * | queue, |
Thread_Control * | the_thread, | ||
Per_CPU_Control * | cpu_self, | ||
Thread_queue_Context * | queue_context | ||
) |
Adds a monotonic timespec to the thread and sets the watchdog header to monotonic.
queue | This parameter is unused. | |
[in,out] | the_thread | The thread to add the timeout and set watchdog header to monotonic. |
cpu_self | The cpu to get the monotonic watchdog header from. | |
queue_context | The thread queue context. |
void _Thread_queue_Add_timeout_realtime_timespec | ( | Thread_queue_Queue * | queue, |
Thread_Control * | the_thread, | ||
Per_CPU_Control * | cpu_self, | ||
Thread_queue_Context * | queue_context | ||
) |
Adds a monotonic timespec to the thread and sets the watchdog header to realtime.
queue | This parameter is unused. | |
[in,out] | the_thread | The thread to add the timeout and set watchdog header to realtime. |
cpu_self | The cpu to get the realtime watchdog header from. | |
queue_context | The thread queue context. |
void _Thread_queue_Add_timeout_ticks | ( | Thread_queue_Queue * | queue, |
Thread_Control * | the_thread, | ||
Per_CPU_Control * | cpu_self, | ||
Thread_queue_Context * | queue_context | ||
) |
Adds timeout ticks of the queue to the thread.
queue | This parameter is unused. | |
[in,out] | the_thread | The thread to add timeout ticks to. |
cpu_self | The cpu for the operation. | |
queue_context | The thread queue context. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_add_priority_update | ( | Thread_queue_Context * | queue_context, |
Thread_Control * | the_thread | ||
) |
Adds a priority update of the thread to the thread queue context.
[in,out] | queue_context | The thread queue context to increase the priority update count of and set the_thread in its Priority update array. |
the_thread | The thread for the priority update. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_clear_priority_updates | ( | Thread_queue_Context * | queue_context | ) |
Clears the priority update count of the thread queue context.
[out] | queue_context | The thread queue context to clear the priority update count. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_initialize | ( | Thread_queue_Context * | queue_context | ) |
Initializes a thread queue context.
[out] | queue_context | The thread queue context to initialize. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_restore_priority_updates | ( | Thread_queue_Context * | queue_context, |
size_t | update_count | ||
) |
Sets the priority update count of the thread queue context.
[out] | queue_context | The thread queue context to set the priority update count of. |
update_count | The priority update count. |
RTEMS_INLINE_ROUTINE size_t _Thread_queue_Context_save_priority_updates | ( | Thread_queue_Context * | queue_context | ) |
Returns the priority update count of the thread queue context.
queue_context | The thread queue context to get the priority update count of. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_deadlock_callout | ( | Thread_queue_Context * | queue_context, |
Thread_queue_Deadlock_callout | deadlock_callout | ||
) |
Sets the deadlock callout in the thread queue context.
A deadlock callout must be provided for _Thread_queue_Enqueue() operations that operate on thread queues which may have an owner, e.g. mutex objects. Available deadlock callouts are _Thread_queue_Deadlock_status() and _Thread_queue_Deadlock_fatal().
[out] | queue_context | The thread queue context. |
deadlock_callout | The deadlock callout. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_enqueue_callout | ( | Thread_queue_Context * | queue_context, |
Thread_queue_Enqueue_callout | enqueue_callout | ||
) |
Sets the enqueue callout in the thread queue context.
[out] | queue_context | The thread queue context. |
enqueue_callout | The enqueue callout. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_enqueue_do_nothing_extra | ( | Thread_queue_Context * | queue_context | ) |
Sets the do nothing enqueue callout in the thread queue context.
[out] | queue_context | The thread queue context. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_enqueue_timeout_monotonic_timespec | ( | Thread_queue_Context * | queue_context, |
const struct timespec * | abstime | ||
) |
Sets the enqueue callout to add an absolute monotonic timeout in timespec format.
[out] | queue_context | The thread queue context. |
abstime | The absolute monotonic timeout. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_enqueue_timeout_realtime_timespec | ( | Thread_queue_Context * | queue_context, |
const struct timespec * | abstime | ||
) |
Sets the enqueue callout to add an absolute realtime timeout in timespec format.
[out] | queue_context | The thread queue context. |
abstime | The absolute realtime timeout. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_enqueue_timeout_ticks | ( | Thread_queue_Context * | queue_context, |
Watchdog_Interval | ticks | ||
) |
Sets the enqueue callout to add a relative monotonic timeout in ticks.
[out] | queue_context | The thread queue context. |
ticks | The timeout in ticks. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_ISR_level | ( | Thread_queue_Context * | queue_context, |
ISR_Level | level | ||
) |
Sets the thread queue context ISR level.
[out] | queue_context | The thread queue context to set the ISR level of. |
level | The ISR level to set queue_context to. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_thread_state | ( | Thread_queue_Context * | queue_context, |
States_Control | thread_state | ||
) |
Sets the thread state for the thread to enqueue in the thread queue context.
[out] | queue_context | The thread queue context. |
state | The thread state. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_timeout_argument | ( | Thread_queue_Context * | queue_context, |
const void * | arg | ||
) |
Sets the timeout argument in the thread queue context.
[out] | queue_context | The thread queue context. |
arg | The timeout argument. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_timeout_ticks | ( | Thread_queue_Context * | queue_context, |
Watchdog_Interval | ticks | ||
) |
Sets the timeout ticks in the thread queue context.
[out] | queue_context | The thread queue context. |
ticks | The timeout in ticks. |
void _Thread_queue_Deadlock_fatal | ( | Thread_Control * | the_thread | ) |
Results in an INTERNAL_ERROR_THREAD_QUEUE_DEADLOCK fatal error.
the_thread | The thread for the operation. |
void _Thread_queue_Deadlock_status | ( | Thread_Control * | the_thread | ) |
Sets the thread wait return code to STATUS_DEADLOCK.
[out] | the_thread | The thread to set the wait return code to STATUS_DEADLOCK. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Destroy | ( | Thread_queue_Control * | the_thread_queue | ) |
Destroys the thread queue.
[out] | the_thread_queue | The thread queue to destroy. |
RTEMS_INLINE_ROUTINE Per_CPU_Control* _Thread_queue_Dispatch_disable | ( | Thread_queue_Context * | queue_context | ) |
Disables dispatching in a critical section.
queue_context | The thread queue context to get the lock context from. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Do_acquire_critical | ( | Thread_queue_Control * | the_thread_queue, |
ISR_lock_Context * | lock_context | ||
) |
Acquires the thread queue control in a critical section.
the_thread_queue | The thread queue control to acquire. | |
[out] | lock_context | The interrupt lock context. |
Thread_Control* _Thread_queue_Do_dequeue | ( | Thread_queue_Control * | the_thread_queue, |
const Thread_queue_Operations * | operations | ||
) |
Dequeues the first thread waiting on the thread queue and returns it.
the_thread_queue | The thread queue for the operation. |
operations | The thread queue operations. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Do_release_critical | ( | Thread_queue_Control * | the_thread_queue, |
ISR_lock_Context * | lock_context | ||
) |
Checks if the thread queue control is the owner of the lock.
the_thread_queue | The thread queue control for the verification. |
true | The thread queue control is the owner of the lock. |
false | The thread queue control is not the owner of the lock.Releases the thread queue control in a critical section. |
the_thread_queue | The thread queue control to release. | |
[out] | lock_context | The interrupt lock context. |
void _Thread_queue_Enqueue | ( | Thread_queue_Queue * | queue, |
const Thread_queue_Operations * | operations, | ||
Thread_Control * | the_thread, | ||
Thread_queue_Context * | queue_context | ||
) |
Blocks the thread and places it on the thread queue.
This enqueues the thread on the thread queue, blocks the thread, and optionally starts the thread timer in case the timeout discipline is not WATCHDOG_NO_TIMEOUT. Timeout discipline and value are in the queue_context.
The caller must be the owner of the thread queue lock. This function will release the thread queue lock and register it as the new thread lock. Thread dispatching is disabled before the thread queue lock is released. Thread dispatching is enabled once the sequence to block the thread is complete. The operation to enqueue the thread on the queue is protected by the thread queue lock. This makes it possible to use the thread queue lock to protect the state of objects embedding the thread queue and directly enter _Thread_queue_Enqueue() in case the thread must block.
The thread queue context must be set up with the following functions, otherwise the behaviour is unpredictable
queue | The actual thread queue. | |
operations | The thread queue operations. | |
[in,out] | the_thread | The thread to enqueue. |
[in,out] | queue_context | The thread queue context of the lock acquire. |
void _Thread_queue_Enqueue_do_nothing_extra | ( | Thread_queue_Queue * | queue, |
Thread_Control * | the_thread, | ||
Per_CPU_Control * | cpu_self, | ||
Thread_queue_Context * | queue_context | ||
) |
Does nothing.
queue | This parameter is unused. |
the_thread | This parameter is unused. |
cpu_self | This parameter is unused. |
queue_context | This parameter is unused. |
void _Thread_queue_Extract | ( | Thread_Control * | the_thread | ) |
Extracts thread from thread queue.
This routine removes the_thread its thread queue and cancels any timeouts associated with this blocking.
[in,out] | the_thread | The pointer to a thread control block that is to be removed |
void _Thread_queue_Extract_critical | ( | Thread_queue_Queue * | queue, |
const Thread_queue_Operations * | operations, | ||
Thread_Control * | the_thread, | ||
Thread_queue_Context * | queue_context | ||
) |
Extracts the thread from the thread queue and unblocks it.
The caller must be the owner of the thread queue lock. This function will release the thread queue lock and restore the default thread lock. Thread dispatching is disabled before the thread queue lock is released and an unblock is necessary. Thread dispatching is enabled once the sequence to unblock the thread is complete. This makes it possible to use the thread queue lock to protect the state of objects embedding the thread queue and directly enter _Thread_queue_Extract_critical() to finalize an operation in case a waiting thread exists.
queue | The actual thread queue. | |
operations | The thread queue operations. | |
[in,out] | the_thread | The thread to extract. |
[in,out] | queue_context | The thread queue context of the lock acquire. |
bool _Thread_queue_Extract_locked | ( | Thread_queue_Queue * | queue, |
const Thread_queue_Operations * | operations, | ||
Thread_Control * | the_thread, | ||
Thread_queue_Context * | queue_context | ||
) |
Extracts the thread from the thread queue, restores the default wait operations and restores the default thread lock.
The caller must be the owner of the thread queue lock. The thread queue lock is not released.
queue | The actual thread queue. | |
operations | The thread queue operations. | |
[in,out] | the_thread | The thread to extract. |
[in,out] | queue_context | The thread queue context. |
void _Thread_queue_Extract_with_proxy | ( | Thread_Control * | the_thread | ) |
Extracts the_thread from the_thread_queue.
This routine extracts the_thread from the_thread_queue and ensures that if there is a proxy for this task on another node, it is also dealt with.
[in,out] | the_thread | The pointer to a thread control block that is to be removed |
Extracts the_thread from the_thread_queue.
This routine extracts the_thread from the_thread_queue and ensures that if there is a proxy for this task on another node, it is also dealt with. A proxy is a data data that is on the thread queue on the remote node and acts as a proxy for the local thread. If the local thread was waiting on a remote operation, then the remote side of the operation must be cleaned up.
Thread_Control* _Thread_queue_First | ( | Thread_queue_Control * | the_thread_queue, |
const Thread_queue_Operations * | operations | ||
) |
Returns the first thread on the thread queue if it exists, otherwise NULL
.
the_thread_queue | The thread queue. |
first | The first thread on the thread queue according to the enqueue order. |
NULL | No thread is present on the thread queue. |
RTEMS_INLINE_ROUTINE Thread_Control* _Thread_queue_First_locked | ( | Thread_queue_Control * | the_thread_queue, |
const Thread_queue_Operations * | operations | ||
) |
Returns the first thread on the thread queue if it exists, otherwise NULL
.
The caller must be the owner of the thread queue lock. The thread queue lock is not released.
the_thread_queue | The thread queue. |
operations | The thread queue operations. |
first | The first thread on the thread queue according to the enqueue order. |
NULL | No thread is present on the thread queue. |
size_t _Thread_queue_Flush_critical | ( | Thread_queue_Queue * | queue, |
const Thread_queue_Operations * | operations, | ||
Thread_queue_Flush_filter | filter, | ||
Thread_queue_Context * | queue_context | ||
) |
Unblocks all threads enqueued on the thread queue.
This function iteratively extracts the first enqueued thread of the thread queue until the thread queue is empty or the filter function indicates a stop. The thread timers of the extracted threads are cancelled. The extracted threads are unblocked.
queue | The actual thread queue. |
operations | The thread queue operations. |
filter | The filter functions is called for each thread to extract from the thread queue. It may be used to alter the thread under protection of the thread queue lock, for example to set the thread wait return code. The return value of the filter function controls if the thread queue flush operation should stop or continue. |
queue_context | The thread queue context of the lock acquire. May be used to pass additional data to the filter function via an overlay structure. The filter function should not release or acquire the thread queue lock. |
Thread_Control* _Thread_queue_Flush_default_filter | ( | Thread_Control * | the_thread, |
Thread_queue_Queue * | queue, | ||
Thread_queue_Context * | queue_context | ||
) |
Default thread queue flush filter function.
the_thread | The thread to extract. |
queue | This parameter is unused. |
queue_context | This parameter is unused. |
the_thread | Extract this thread. |
Thread_Control* _Thread_queue_Flush_status_object_was_deleted | ( | Thread_Control * | the_thread, |
Thread_queue_Queue * | queue, | ||
Thread_queue_Context * | queue_context | ||
) |
Status object was deleted thread queue flush filter function.
Sets the thread wait return code of the thread to STATUS_OBJECT_WAS_DELETED
[out] | the_thread | The thread to extract. |
queue | This parameter is unused. | |
queue_context | This parameter is unused. |
the_thread | Extract this thread. |
Thread_Control* _Thread_queue_Flush_status_unavailable | ( | Thread_Control * | the_thread, |
Thread_queue_Queue * | queue, | ||
Thread_queue_Context * | queue_context | ||
) |
Status unavailable thread queue flush filter function.
Sets the thread wait return code of the thread to STATUS_UNAVAILABLE.
[out] | the_thread | The thread to extract. |
queue | This parameter is unused. | |
queue_context | This parameter is unused. |
the_thread | Extract this thread. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Heads_initialize | ( | Thread_queue_Heads * | heads | ) |
Initializes the thread queue heads.
[out] | heads | The thread queue heads to initialize. |
void _Thread_queue_Initialize | ( | Thread_queue_Control * | the_thread_queue, |
const char * | name | ||
) |
Initializes the thread queue control to the given name.
[out] | the_thread_queue | The thread queue control to initialize. |
name | The name for the_thread_queue. |
RTEMS_INLINE_ROUTINE bool _Thread_queue_Is_empty | ( | const Thread_queue_Queue * | queue | ) |
Checks if the thread queue queue is empty.
queue | The thread queue for the verification. |
true | queue is empty. |
false | queue is not empty. |
void _Thread_queue_Object_initialize | ( | Thread_queue_Control * | the_thread_queue | ) |
Initializes a thread queue embedded in an object with identifier.
The object must have the layout specified by Thread_queue_Object. It should be ensured with the THREAD_QUEUE_OBJECT_ASSERT() static assertion.
[out] | the_thread_queue | The thread queue. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Queue_do_acquire_critical | ( | Thread_queue_Queue * | queue, |
ISR_lock_Context * | lock_context | ||
) |
Acquires the thread queue queue in a critical section.
queue | The thread queue queue to acquire in a critical section. | |
lock_stats | The lock statistics. | |
[out] | lock_context | The interrupt lock context. |
size_t _Thread_queue_Queue_get_name_and_id | ( | const Thread_queue_Queue * | queue, |
char * | buffer, | ||
size_t | buffer_size, | ||
Objects_Id * | id | ||
) |
Copies the thread queue name to the specified buffer.
queue | The actual thread queue. | |
[out] | buffer | The buffer for the thread queue name copy. |
buffer_size | The buffer size in characters. | |
id | The object identifier in case the thread queue is embedded in an object with identifier, otherwise it is set to 0. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Queue_initialize | ( | Thread_queue_Queue * | queue, |
const char * | name | ||
) |
Initializes the thread queue queue with the given name.
[out] | queue | The thread queue queue to initialize. |
name | The name for the queue. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Queue_release | ( | Thread_queue_Queue * | queue, |
ISR_lock_Context * | lock_context | ||
) |
Releases the thread queue queue and enables interrupts.
queue | The thread queue queue to release. | |
[out] | lock_context | The interrupt lock context to enable interrupts. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Queue_release_critical | ( | Thread_queue_Queue * | queue, |
ISR_lock_Context * | lock_context | ||
) |
Releases the thread queue queue in a critical section.
queue | The thread queue queue to release in a critical section. | |
[out] | lock_context | The interrupt lock context. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Release | ( | Thread_queue_Control * | the_thread_queue, |
Thread_queue_Context * | queue_context | ||
) |
Releases the thread queue control and enables interrupts.
the_thread_queue | The thread queue control to release. | |
[out] | queue_context | The thread queue context. |
RTEMS_INLINE_ROUTINE void _Thread_queue_Release_critical | ( | Thread_queue_Control * | the_thread_queue, |
Thread_queue_Context * | queue_context | ||
) |
Releases the thread queue control in a critical section.
the_thread_queue | The thread queue control to release. | |
[out] | queue_context | The thread queue context. |
void _Thread_queue_Surrender | ( | Thread_queue_Queue * | queue, |
Thread_queue_Heads * | heads, | ||
Thread_Control * | previous_owner, | ||
Thread_queue_Context * | queue_context, | ||
const Thread_queue_Operations * | operations | ||
) |
Surrenders the thread queue previously owned by the thread to the first enqueued thread.
The owner of the thread queue must be set to NULL by the caller.
This function releases the thread queue lock. In addition it performs a thread dispatch if necessary.
[in,out] | queue | The actual thread queue. |
heads | The thread queue heads. It must not be NULL. | |
previous_owner | The previous owner thread surrendering the thread queue. | |
queue_context | The thread queue context of the lock acquire. | |
operations | The thread queue operations. |
void _Thread_queue_Unblock_critical | ( | bool | unblock, |
Thread_queue_Queue * | queue, | ||
Thread_Control * | the_thread, | ||
ISR_lock_Context * | lock_context | ||
) |
Unblocks the thread which was on the thread queue before.
The caller must be the owner of the thread queue lock. This function will release the thread queue lock. Thread dispatching is disabled before the thread queue lock is released and an unblock is necessary. Thread dispatching is enabled once the sequence to unblock the thread is complete.
unblock | The unblock indicator returned by _Thread_queue_Extract_locked(). | |
queue | The actual thread queue. | |
[in,out] | the_thread | The thread to extract. |
[in,out] | lock_context | The lock context of the lock acquire. |
const char _Thread_queue_Object_name[] |
The special thread queue name to indicated that the thread queue is embedded in an object with identifier.