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
	Helper structure to ensure that all objects containing a thread queue have the right layout. 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)

void	_Thread_queue_Add_timeout_ticks (Thread_queue_Queue queue, Thread_Control the_thread, Per_CPU_Control cpu_self, Thread_queue_Context queue_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)

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)

void	_Thread_queue_Deadlock_status (Thread_Control *the_thread)
	Sets the thread wait return code to STATUS_DEADLOCK.

void	_Thread_queue_Deadlock_fatal (Thread_Control *the_thread)
	Results in an INTERNAL_ERROR_THREAD_QUEUE_DEADLOCK fatal error.

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)

RTEMS_INLINE_ROUTINE size_t	_Thread_queue_Context_save_priority_updates (Thread_queue_Context *queue_context)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Context_restore_priority_updates (Thread_queue_Context *queue_context, size_t update_count)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Context_add_priority_update (Thread_queue_Context queue_context, Thread_Control the_thread)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Context_set_ISR_level (Thread_queue_Context *queue_context, ISR_Level level)

RTEMS_INLINE_ROUTINE Per_CPU_Control *	_Thread_queue_Dispatch_disable (Thread_queue_Context *queue_context)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Heads_initialize (Thread_queue_Heads *heads)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Queue_initialize (Thread_queue_Queue queue, const char name)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Queue_do_acquire_critical (Thread_queue_Queue queue, ISR_lock_Context lock_context)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Queue_release_critical (Thread_queue_Queue queue, ISR_lock_Context lock_context)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Queue_release (Thread_queue_Queue queue, ISR_lock_Context 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. More...

RTEMS_INLINE_ROUTINE void	_Thread_queue_Do_acquire_critical (Thread_queue_Control the_thread_queue, ISR_lock_Context lock_context)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Acquire_critical (Thread_queue_Control the_thread_queue, Thread_queue_Context queue_context)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Acquire (Thread_queue_Control the_thread_queue, Thread_queue_Context queue_context)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Do_release_critical (Thread_queue_Control the_thread_queue, ISR_lock_Context lock_context)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Release_critical (Thread_queue_Control the_thread_queue, Thread_queue_Context queue_context)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Release (Thread_queue_Control the_thread_queue, Thread_queue_Context queue_context)

Thread_Control *	_Thread_queue_Do_dequeue (Thread_queue_Control the_thread_queue, const Thread_queue_Operations operations)

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)

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)

RTEMS_INLINE_ROUTINE void	_Thread_queue_Destroy (Thread_queue_Control *the_thread_queue)

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

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

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.

◆ _Thread_queue_Dequeue

#define _Thread_queue_Dequeue	(	the_thread_queue,
		operations,
		mp_callout
	)

Value:

_Thread_queue_Do_dequeue( \
      the_thread_queue, \
      operations \
    )

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 \
      } \
    }

◆ 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 ) \
    && RTEMS_HAVE_MEMBER_SAME_TYPE( \
      object_type, \
      wait_queue_member, \
      Thread_queue_Object, \
      Wait_queue \
    ), \
    msg \
  )

◆ THREAD_QUEUE_QUEUE_TO_OBJECT

#define THREAD_QUEUE_QUEUE_TO_OBJECT ( queue )

Value:

RTEMS_CONTAINER_OF( \
    queue, \
    Thread_queue_Object, \
    Wait_queue.Queue \
  )

Typedef Documentation

◆ Thread_queue_Deadlock_callout

typedef void( * Thread_queue_Deadlock_callout) (Thread_Control *the_thread)

Thread queue deadlock callout.

Parameters

the_thread The 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]	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.

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]	queue	The actual thread queue.
[in]	the_thread	The 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]	queue	The actual thread queue.
[in]	the_thread	The 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] heads The thread queue heads.

Return values

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.

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

Return values

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.

◆ Thread_queue_Heads

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.

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

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

Returns: The previous first thread on the queue.

Function Documentation

◆ _Thread_queue_Context_initialize()

RTEMS_INLINE_ROUTINE void _Thread_queue_Context_initialize ( Thread_queue_Context * queue_context )

Initializes a thread queue context.

Parameters

queue_context The thread queue context to initialize.

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

queue_context	The thread queue context.
deadlock_callout	The 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

queue_context	The thread queue context.
enqueue_callout	The 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

queue_context The 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

queue_context	The thread queue context.
abstime	The 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

queue_context	The thread queue context.
abstime	The 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

queue_context	The thread queue context.
ticks	The timeout in ticks.

See also: _Thread_queue_Enqueue().

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

queue_context	The thread queue context.
state	The 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

queue_context	The thread queue context.
arg	The 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

queue_context	The thread queue context.
ticks	The timeout in ticks.

See also: _Thread_queue_Enqueue().

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

#include <rtems/score/threadqimpl.h>
#include <rtems/score/statesimpl.h>
#define MUTEX_TQ_OPERATIONS &_Thread_queue_Operations_priority
typedef struct {
  Thread_queue_Control Queue;
} Mutex;
void _Mutex_Obtain( Mutex *mutex )
{
  Thread_queue_Context  queue_context;
  Thread_Control       *executing;
  _Thread_queue_Context_initialize( &queue_context );
  _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 {
    _Thread_queue_Context_set_thread_state(
      &queue_context,
      STATES_WAITING_FOR_MUTEX
    );
    _Thread_queue_Context_set_enqueue_do_nothing_extra( &queue_context );
    _Thread_queue_Context_set_deadlock_callout(
      queue_context,
      _Thread_queue_Deadlock_fatal
    );
    _Thread_queue_Enqueue(
      &mutex->Queue.Queue,
      MUTEX_TQ_OPERATIONS,
      executing,
      &queue_context
    );
  }
}

Parameters

[in]	queue	The actual thread queue.
[in]	operations	The thread queue operations.
[in]	the_thread	The thread to enqueue.
[in]	queue_context	The thread queue context of the lock acquire.

◆ _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] the_thread is the 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.

#include <rtems/score/threadqimpl.h>
typedef struct {
  Thread_queue_Control  Queue;
  Thread_Control       *owner;
} Mutex;
void _Mutex_Release( Mutex *mutex )
{
  Thread_queue_Context  queue_context;
  Thread_Control       *first;
  _Thread_queue_Context_initialize( &queue_context, NULL );
  _Thread_queue_Acquire( &mutex->Queue, queue_context );
  first = _Thread_queue_First_locked( &mutex->Queue );
  mutex->owner = first;
  if ( first != NULL ) {
    _Thread_queue_Extract_critical(
      &mutex->Queue.Queue,
      mutex->Queue.operations,
      first,
      &queue_context
  );
}

Parameters

[in]	queue	The actual thread queue.
[in]	operations	The thread queue operations.
[in]	the_thread	The thread to extract.
[in]	queue_context	The 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

[in]	queue	The actual thread queue.
[in]	operations	The thread queue operations.
[in]	the_thread	The thread to extract.
[in]	queue_context	The 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.

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

[in] the_thread_queue The thread queue.

Return values

NULL	No thread is present on the thread queue.
first	The first thread on the thread queue according to the enqueue order.

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

[in]	the_thread_queue	The thread queue.
[in]	operations	The thread queue operations.

Return values

NULL	No thread is present on the thread queue.
first	The first thread on the thread queue according to the enqueue order.

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

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.

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_thread	The thread to extract.
queue	Unused.
queue_context	Unused.

Return values

the_thread Extract 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

the_thread	The thread to extract.
queue	Unused.
queue_context	Unused.

Return values

the_thread Extract 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

the_thread	The thread to extract.
queue	Unused.
queue_context	Unused.

Return values

the_thread Extract this thread.

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

[in] the_thread_queue The thread queue.

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

[in]	queue	The actual thread queue.
[in]	buffer	The buffer for the thread queue name copy.
[in]	buffer_size	The buffer size in characters.
[in]	id	The object identifier in case the thread queue is embedded in an object with identifier, otherwise it is set to 0.

Return values

The	length of the thread queue name. May be greater than or equal to the buffer size if truncation occurred.

◆ _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]	queue	The actual thread queue.
[in]	heads	The thread queue heads. It must not be NULL.
[in]	previous_owner	The previous owner thread surrendering the thread queue.
[in]	queue_context	The thread queue context of the lock acquire.
[in]	operations	The 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

[in]	unblock	The unblock indicator returned by _Thread_queue_Extract_locked().
[in]	queue	The actual thread queue.
[in]	the_thread	The thread to extract.
[in]	lock_context	The 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().

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ _Thread_queue_Context_ISR_disable

◆ _Thread_queue_Context_set_MP_callout

◆ _Thread_queue_Dequeue

◆ THREAD_QUEUE_INITIALIZER

◆ THREAD_QUEUE_OBJECT_ASSERT

◆ THREAD_QUEUE_QUEUE_TO_OBJECT

Typedef Documentation

◆ Thread_queue_Deadlock_callout

◆ Thread_queue_Enqueue_callout

◆ Thread_queue_Enqueue_operation

◆ Thread_queue_Extract_operation

◆ Thread_queue_First_operation

◆ Thread_queue_Flush_filter

◆ Thread_queue_Heads

◆ Thread_queue_Priority_actions_operation

◆ Thread_queue_Surrender_operation

Function Documentation

◆ _Thread_queue_Context_initialize()

◆ _Thread_queue_Context_set_deadlock_callout()

◆ _Thread_queue_Context_set_enqueue_callout()

◆ _Thread_queue_Context_set_enqueue_do_nothing_extra()

◆ _Thread_queue_Context_set_enqueue_timeout_monotonic_timespec()

◆ _Thread_queue_Context_set_enqueue_timeout_realtime_timespec()

◆ _Thread_queue_Context_set_enqueue_timeout_ticks()

◆ _Thread_queue_Context_set_thread_state()

◆ _Thread_queue_Context_set_timeout_argument()

◆ _Thread_queue_Context_set_timeout_ticks()

◆ _Thread_queue_Enqueue()

◆ _Thread_queue_Extract()

◆ _Thread_queue_Extract_critical()

◆ _Thread_queue_Extract_locked()

◆ _Thread_queue_Extract_with_proxy()

◆ _Thread_queue_First()

◆ _Thread_queue_First_locked()

◆ _Thread_queue_Flush_critical()

◆ _Thread_queue_Flush_default_filter()

◆ _Thread_queue_Flush_status_object_was_deleted()

◆ _Thread_queue_Flush_status_unavailable()

◆ _Thread_queue_Object_initialize()

◆ _Thread_queue_Queue_get_name_and_id()

◆ _Thread_queue_Surrender()

◆ _Thread_queue_Unblock_critical()

Variable Documentation

◆ _Thread_queue_Object_name