RTEMS  5.1
Files | Data Structures | Macros | Typedefs | Functions | Variables
Thread Queue Handler

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...
 

Detailed Description

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.

Macro Definition Documentation

◆ _Thread_queue_Context_ISR_disable

#define _Thread_queue_Context_ISR_disable (   queue_context,
  level 
)
Value:
do { \
_ISR_Local_disable( level ); \
_ISR_lock_ISR_disable_profile( \
&( queue_context )->Lock_context.Lock_context \
) \
} while ( 0 )

◆ _Thread_queue_Context_set_MP_callout

#define _Thread_queue_Context_set_MP_callout (   queue_context,
  mp_callout 
)
Value:
do { \
(void) queue_context; \
} while ( 0 )

Sets the MP callout in the thread queue context.

Parameters
[out]queue_contextThe thread queue context.
mp_calloutCallout 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.

◆ _Thread_queue_Dequeue

#define _Thread_queue_Dequeue (   the_thread_queue,
  operations,
  mp_callout 
)
Value:
the_thread_queue, \
operations \
)
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.
Definition: threadqenqueue.c:742

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.

  • INTERRUPT LATENCY:
    • single case

◆ THREAD_QUEUE_INITIALIZER

#define THREAD_QUEUE_INITIALIZER (   _name)
Value:
{ \
.Queue = { \
.heads = NULL, \
.owner = NULL, \
.name = _name \
} \
}
#define NULL
Requests a GPIO pin group configuration.
Definition: bestcomm_api.h:77

◆ THREAD_QUEUE_OBJECT_ASSERT

#define THREAD_QUEUE_OBJECT_ASSERT (   object_type,
  wait_queue_member,
  msg 
)
Value:
RTEMS_STATIC_ASSERT( \
offsetof( object_type, wait_queue_member ) \
== offsetof( Thread_queue_Object, Wait_queue ) \
object_type, \
wait_queue_member, \
Wait_queue \
), \
msg \
)
#define RTEMS_HAVE_MEMBER_SAME_TYPE(_t_lhs, _m_lhs, _t_rhs, _m_rhs)
Evaluates to true if the members of two types have the same type.
Definition: basedefs.h:527
Definition: b1553brm.c:75
Does nothing.
Definition: threadqimpl.h:1445

◆ THREAD_QUEUE_QUEUE_TO_OBJECT

#define THREAD_QUEUE_QUEUE_TO_OBJECT (   queue)
Value:
queue, \
Wait_queue.Queue \
)
#define RTEMS_CONTAINER_OF(_m, _type, _member_name)
Returns a pointer to the container of a specified member pointer.
Definition: basedefs.h:430
Does nothing.
Definition: threadqimpl.h:1445

Typedef Documentation

◆ Thread_queue_Deadlock_callout

typedef void( * Thread_queue_Deadlock_callout) (Thread_Control *the_thread)

Thread queue deadlock callout.

Parameters
the_threadThe thread that detected the deadlock.
See also
_Thread_queue_Context_set_deadlock_callout().

◆ Thread_queue_Enqueue_callout

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.

Parameters
[in]queueThe actual thread queue.
[in]the_threadThe thread to enqueue.
[in]cpu_selfThe current processor.
[in]queue_contextThe thread queue context of the lock acquire.
See also
_Thread_queue_Context_set_enqueue_callout().

◆ Thread_queue_Enqueue_operation

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().

Parameters
[in]queueThe actual thread queue.
[in]the_threadThe thread to enqueue on the queue.

◆ Thread_queue_Extract_operation

typedef void( * Thread_queue_Extract_operation) (Thread_queue_Queue *queue, Thread_Control *the_thread, Thread_queue_Context *queue_context)

Thread queue extract operation.

Parameters
[in]queueThe actual thread queue.
[in]the_threadThe thread to extract from the thread queue.

◆ Thread_queue_First_operation

typedef Thread_Control*( * Thread_queue_First_operation) (Thread_queue_Heads *heads)

Thread queue first operation.

Parameters
[in]headsThe thread queue heads.
Return values
NULLNo thread is present on the thread queue.
firstThe first thread of the thread queue according to the insert order. This thread remains on the thread queue.

◆ Thread_queue_Flush_filter

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.

Parameters
the_threadThe 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.
queueThe actual thread queue.
queue_contextThe 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.
Return values
the_threadExtract this thread.
NULLDo not extract this thread and stop the thread queue flush operation. Threads that are already extracted will complete the flush operation.

◆ 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.

◆ Thread_queue_Priority_actions_operation

typedef void( * Thread_queue_Priority_actions_operation) (Thread_queue_Queue *queue, Priority_Actions *priority_actions)

Thread queue action operation.

Parameters
[in]queueThe actual thread queue.
[in]the_threadThe thread.
[in]queue_contextThe 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.

◆ Thread_queue_Surrender_operation

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.

Parameters
[in]queueThe actual thread queue.
[in]headsThe thread queue heads. It must not be NULL.
[in]previous_ownerThe previous owner of the thread queue.
Returns
The previous first thread on the queue.

Function Documentation

◆ _Thread_queue_Acquire()

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.

Parameters
the_thread_queueThe thread queue control to acquire.
[out]queue_contextThe thread queue context.

◆ _Thread_queue_Acquire_critical()

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.

Parameters
the_thread_queueThe thread queue control to acquire.
[out]lock_contextThe interrupt lock context.

◆ _Thread_queue_Add_timeout_monotonic_timespec()

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.

Parameters
queueThis parameter is unused.
[in,out]the_threadThe thread to add the timeout and set watchdog header to monotonic.
cpu_selfThe cpu to get the monotonic watchdog header from.
queue_contextThe thread queue context.

◆ _Thread_queue_Add_timeout_realtime_timespec()

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.

Parameters
queueThis parameter is unused.
[in,out]the_threadThe thread to add the timeout and set watchdog header to realtime.
cpu_selfThe cpu to get the realtime watchdog header from.
queue_contextThe thread queue context.

◆ _Thread_queue_Add_timeout_ticks()

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.

Parameters
queueThis parameter is unused.
[in,out]the_threadThe thread to add timeout ticks to.
cpu_selfThe cpu for the operation.
queue_contextThe thread queue context.

◆ _Thread_queue_Context_add_priority_update()

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.

Parameters
[in,out]queue_contextThe thread queue context to increase the priority update count of and set the_thread in its Priority update array.
the_threadThe thread for the priority update.

◆ _Thread_queue_Context_clear_priority_updates()

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.

Parameters
[out]queue_contextThe thread queue context to clear the priority update count.

◆ _Thread_queue_Context_initialize()

RTEMS_INLINE_ROUTINE void _Thread_queue_Context_initialize ( Thread_queue_Context queue_context)

Initializes a thread queue context.

Parameters
[out]queue_contextThe thread queue context to initialize.

◆ _Thread_queue_Context_restore_priority_updates()

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.

Parameters
[out]queue_contextThe thread queue context to set the priority update count of.
update_countThe priority update count.

◆ _Thread_queue_Context_save_priority_updates()

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.

Parameters
queue_contextThe thread queue context to get the priority update count of.
Returns
The priority update count of queue_context.

◆ _Thread_queue_Context_set_deadlock_callout()

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().

Parameters
[out]queue_contextThe thread queue context.
deadlock_calloutThe deadlock callout.
See also
_Thread_queue_Enqueue().

◆ _Thread_queue_Context_set_enqueue_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.

Parameters
[out]queue_contextThe thread queue context.
enqueue_calloutThe enqueue callout.
See also
_Thread_queue_Enqueue().

◆ _Thread_queue_Context_set_enqueue_do_nothing_extra()

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.

Parameters
[out]queue_contextThe thread queue context.
See also
_Thread_queue_Enqueue().

◆ _Thread_queue_Context_set_enqueue_timeout_monotonic_timespec()

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.

Parameters
[out]queue_contextThe thread queue context.
abstimeThe absolute monotonic timeout.
See also
_Thread_queue_Enqueue().

◆ _Thread_queue_Context_set_enqueue_timeout_realtime_timespec()

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.

Parameters
[out]queue_contextThe thread queue context.
abstimeThe absolute realtime timeout.
See also
_Thread_queue_Enqueue().

◆ _Thread_queue_Context_set_enqueue_timeout_ticks()

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.

Parameters
[out]queue_contextThe thread queue context.
ticksThe timeout in ticks.
See also
_Thread_queue_Enqueue().

◆ _Thread_queue_Context_set_ISR_level()

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.

Parameters
[out]queue_contextThe thread queue context to set the ISR level of.
levelThe ISR level to set queue_context to.

◆ _Thread_queue_Context_set_thread_state()

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.

Parameters
[out]queue_contextThe thread queue context.
stateThe thread state.
See also
_Thread_queue_Enqueue().

◆ _Thread_queue_Context_set_timeout_argument()

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.

Parameters
[out]queue_contextThe thread queue context.
argThe timeout argument.
See also
_Thread_queue_Enqueue().

◆ _Thread_queue_Context_set_timeout_ticks()

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.

Parameters
[out]queue_contextThe thread queue context.
ticksThe timeout in ticks.
See also
_Thread_queue_Enqueue().

◆ _Thread_queue_Deadlock_fatal()

void _Thread_queue_Deadlock_fatal ( Thread_Control the_thread)

Results in an INTERNAL_ERROR_THREAD_QUEUE_DEADLOCK fatal error.

Parameters
the_threadThe thread for the operation.

◆ _Thread_queue_Deadlock_status()

void _Thread_queue_Deadlock_status ( Thread_Control the_thread)

Sets the thread wait return code to STATUS_DEADLOCK.

Parameters
[out]the_threadThe thread to set the wait return code to STATUS_DEADLOCK.

◆ _Thread_queue_Destroy()

RTEMS_INLINE_ROUTINE void _Thread_queue_Destroy ( Thread_queue_Control the_thread_queue)

Destroys the thread queue.

Parameters
[out]the_thread_queueThe thread queue to destroy.

◆ _Thread_queue_Dispatch_disable()

RTEMS_INLINE_ROUTINE Per_CPU_Control* _Thread_queue_Dispatch_disable ( Thread_queue_Context queue_context)

Disables dispatching in a critical section.

Parameters
queue_contextThe thread queue context to get the lock context from.
Returns
The current processor.

◆ _Thread_queue_Do_acquire_critical()

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.

Parameters
the_thread_queueThe thread queue control to acquire.
[out]lock_contextThe interrupt lock context.

◆ _Thread_queue_Do_dequeue()

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.

Parameters
the_thread_queueThe thread queue for the operation.
operationsThe thread queue operations.
Returns
The first locked thread.

◆ _Thread_queue_Do_release_critical()

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.

Parameters
the_thread_queueThe thread queue control for the verification.
Return values
trueThe thread queue control is the owner of the lock.
falseThe thread queue control is not the owner of the lock.Releases the thread queue control in a critical section.
Parameters
the_thread_queueThe thread queue control to release.
[out]lock_contextThe interrupt lock context.

◆ _Thread_queue_Enqueue()

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

#define MUTEX_TQ_OPERATIONS &_Thread_queue_Operations_priority
typedef struct {
} Mutex;
void _Mutex_Obtain( Mutex *mutex )
{
Thread_queue_Context queue_context;
Thread_Control *executing;
_Thread_queue_Acquire( &mutex->Queue, queue_context );
executing = _Thread_Executing;
if ( mutex->Queue.owner == NULL ) {
mutex->Queue.owner = executing;
_Thread_queue_Release( &mutex->Queue, queue_context );
} else {
&queue_context,
);
queue_context,
);
&mutex->Queue.Queue,
MUTEX_TQ_OPERATIONS,
executing,
&queue_context
);
}
}
Parameters
queueThe actual thread queue.
operationsThe thread queue operations.
[in,out]the_threadThe thread to enqueue.
[in,out]queue_contextThe thread queue context of the lock acquire.

◆ _Thread_queue_Enqueue_do_nothing_extra()

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.

Parameters
queueThis parameter is unused.
the_threadThis parameter is unused.
cpu_selfThis parameter is unused.
queue_contextThis parameter is unused.

◆ _Thread_queue_Extract()

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.

Parameters
[in,out]the_threadThe pointer to a thread control block that is to be removed

◆ _Thread_queue_Extract_critical()

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.

typedef struct {
} Mutex;
void _Mutex_Release( Mutex *mutex )
{
Thread_queue_Context queue_context;
_Thread_queue_Acquire( &mutex->Queue, queue_context );
first = _Thread_queue_First_locked( &mutex->Queue );
mutex->owner = first;
if ( first != NULL ) {
&mutex->Queue.Queue,
mutex->Queue.operations,
first,
&queue_context
);
}
Parameters
queueThe actual thread queue.
operationsThe thread queue operations.
[in,out]the_threadThe thread to extract.
[in,out]queue_contextThe thread queue context of the lock acquire.

◆ _Thread_queue_Extract_locked()

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.

Parameters
queueThe actual thread queue.
operationsThe thread queue operations.
[in,out]the_threadThe thread to extract.
[in,out]queue_contextThe thread queue context.
Returns
Returns the unblock indicator for _Thread_queue_Unblock_critical(). True indicates, that this thread must be unblocked by the scheduler later in _Thread_queue_Unblock_critical(), and false otherwise. In case false is returned, then the thread queue enqueue procedure was interrupted. Thus it will unblock itself and the thread wait information is no longer accessible, since this thread may already block on another resource in an SMP configuration.

◆ _Thread_queue_Extract_with_proxy()

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.

Parameters
[in,out]the_threadThe 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_queue_First()

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.

Parameters
the_thread_queueThe thread queue.
Return values
firstThe first thread on the thread queue according to the enqueue order.
NULLNo thread is present on the thread queue.

◆ _Thread_queue_First_locked()

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.

Parameters
the_thread_queueThe thread queue.
operationsThe thread queue operations.
Return values
firstThe first thread on the thread queue according to the enqueue order.
NULLNo thread is present on the thread queue.

◆ _Thread_queue_Flush_critical()

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.

Parameters
queueThe actual thread queue.
operationsThe thread queue operations.
filterThe 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_contextThe 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.
Returns
The count of extracted threads.

◆ _Thread_queue_Flush_default_filter()

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.

Parameters
the_threadThe thread to extract.
queueThis parameter is unused.
queue_contextThis parameter is unused.
Return values
the_threadExtract this thread.

◆ _Thread_queue_Flush_status_object_was_deleted()

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

Parameters
[out]the_threadThe thread to extract.
queueThis parameter is unused.
queue_contextThis parameter is unused.
Return values
the_threadExtract this thread.

◆ _Thread_queue_Flush_status_unavailable()

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.

Parameters
[out]the_threadThe thread to extract.
queueThis parameter is unused.
queue_contextThis parameter is unused.
Return values
the_threadExtract this thread.

◆ _Thread_queue_Heads_initialize()

RTEMS_INLINE_ROUTINE void _Thread_queue_Heads_initialize ( Thread_queue_Heads heads)

Initializes the thread queue heads.

Parameters
[out]headsThe thread queue heads to initialize.

◆ _Thread_queue_Initialize()

void _Thread_queue_Initialize ( Thread_queue_Control the_thread_queue,
const char *  name 
)

Initializes the thread queue control to the given name.

Parameters
[out]the_thread_queueThe thread queue control to initialize.
nameThe name for the_thread_queue.

◆ _Thread_queue_Is_empty()

RTEMS_INLINE_ROUTINE bool _Thread_queue_Is_empty ( const Thread_queue_Queue queue)

Checks if the thread queue queue is empty.

Parameters
queueThe thread queue for the verification.
Return values
truequeue is empty.
falsequeue is not empty.

◆ _Thread_queue_Object_initialize()

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.

Parameters
[out]the_thread_queueThe thread queue.

◆ _Thread_queue_Queue_do_acquire_critical()

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.

Parameters
queueThe thread queue queue to acquire in a critical section.
lock_statsThe lock statistics.
[out]lock_contextThe interrupt lock context.

◆ _Thread_queue_Queue_get_name_and_id()

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.

Parameters
queueThe actual thread queue.
[out]bufferThe buffer for the thread queue name copy.
buffer_sizeThe buffer size in characters.
idThe object identifier in case the thread queue is embedded in an object with identifier, otherwise it is set to 0.
Returns
The length of the thread queue name. May be greater than or equal to the buffer size if truncation occurred.

◆ _Thread_queue_Queue_initialize()

RTEMS_INLINE_ROUTINE void _Thread_queue_Queue_initialize ( Thread_queue_Queue queue,
const char *  name 
)

Initializes the thread queue queue with the given name.

Parameters
[out]queueThe thread queue queue to initialize.
nameThe name for the queue.

◆ _Thread_queue_Queue_release()

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.

Parameters
queueThe thread queue queue to release.
[out]lock_contextThe interrupt lock context to enable interrupts.

◆ _Thread_queue_Queue_release_critical()

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.

Parameters
queueThe thread queue queue to release in a critical section.
[out]lock_contextThe interrupt lock context.

◆ _Thread_queue_Release()

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.

Parameters
the_thread_queueThe thread queue control to release.
[out]queue_contextThe thread queue context.

◆ _Thread_queue_Release_critical()

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.

Parameters
the_thread_queueThe thread queue control to release.
[out]queue_contextThe thread queue context.

◆ _Thread_queue_Surrender()

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.

Parameters
[in,out]queueThe actual thread queue.
headsThe thread queue heads. It must not be NULL.
previous_ownerThe previous owner thread surrendering the thread queue.
queue_contextThe thread queue context of the lock acquire.
operationsThe thread queue operations.

◆ _Thread_queue_Unblock_critical()

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.

Parameters
unblockThe unblock indicator returned by _Thread_queue_Extract_locked().
queueThe actual thread queue.
[in,out]the_threadThe thread to extract.
[in,out]lock_contextThe lock context of the lock acquire.

Variable Documentation

◆ _Thread_queue_Object_name

const char _Thread_queue_Object_name[]

The special thread queue name to indicated that the thread queue is embedded in an object with identifier.

See also
_Thread_queue_Object_initialize().