Deterministic Priority Scheduler. More...

Files
file	schedulerpriority.h
	Thread Manipulation with the Priority-Based Scheduler.

file	schedulerpriorityimpl.h
	Inlined Routines Associated with the Manipulation of the Priority-Based Scheduling Structures.

Data Structures
struct	Scheduler_priority_Context

struct	Scheduler_priority_Ready_queue
	Data for ready queue operations. More...

struct	Scheduler_priority_Node
	Scheduler node specialization for Deterministic Priority schedulers. More...

Macros
#define	SCHEDULER_PRIORITY_ENTRY_POINTS

Functions
void	_Scheduler_priority_Initialize (const Scheduler_Control *scheduler)
	Initializes the priority scheduler. More...

void	_Scheduler_priority_Block (const Scheduler_Control scheduler, Thread_Control the_thread, Scheduler_Node *node)
	Blocks the thread. More...

void	_Scheduler_priority_Schedule (const Scheduler_Control scheduler, Thread_Control the_thread)
	Sets the heir thread to be the next ready thread. More...

void	_Scheduler_priority_Unblock (const Scheduler_Control scheduler, Thread_Control the_thread, Scheduler_Node *node)
	Unblocks the thread. More...

void	_Scheduler_priority_Update_priority (const Scheduler_Control scheduler, Thread_Control the_thread, Scheduler_Node *base_node)
	Updates the priority of the node. More...

void	_Scheduler_priority_Node_initialize (const Scheduler_Control scheduler, Scheduler_Node node, Thread_Control *the_thread, Priority_Control priority)
	Initializes the node with the given priority. More...

void	_Scheduler_priority_Yield (const Scheduler_Control scheduler, Thread_Control the_thread, Scheduler_Node *node)
	Performs the yield of a thread. More...

RTEMS_INLINE_ROUTINE Scheduler_priority_Context *	_Scheduler_priority_Get_context (const Scheduler_Control *scheduler)
	Gets the context of the scheduler. More...

RTEMS_INLINE_ROUTINE Scheduler_priority_Node *	_Scheduler_priority_Thread_get_node (Thread_Control *the_thread)
	Gets the scheduler node of the thread. More...

RTEMS_INLINE_ROUTINE Scheduler_priority_Node *	_Scheduler_priority_Node_downcast (Scheduler_Node *node)
	Gets the priority node of the scheduler node. More...

RTEMS_INLINE_ROUTINE void	_Scheduler_priority_Ready_queue_initialize (Chain_Control *ready_queues, Priority_Control maximum_priority)
	Ready queue initialization. More...

RTEMS_INLINE_ROUTINE void	_Scheduler_priority_Ready_queue_enqueue (Chain_Node node, Scheduler_priority_Ready_queue ready_queue, Priority_bit_map_Control *bit_map)
	Enqueues a node on the specified ready queue. More...

RTEMS_INLINE_ROUTINE void	_Scheduler_priority_Ready_queue_enqueue_first (Chain_Node node, Scheduler_priority_Ready_queue ready_queue, Priority_bit_map_Control *bit_map)
	Enqueues a node on the specified ready queue as first. More...

RTEMS_INLINE_ROUTINE void	_Scheduler_priority_Ready_queue_extract (Chain_Node node, Scheduler_priority_Ready_queue ready_queue, Priority_bit_map_Control *bit_map)
	Extracts a node from the specified ready queue. More...

RTEMS_INLINE_ROUTINE void	_Scheduler_priority_Extract_body (const Scheduler_Control scheduler, Thread_Control the_thread, Scheduler_Node *node)
	Extracts a node from the context of the scheduler. More...

RTEMS_INLINE_ROUTINE Chain_Node *	_Scheduler_priority_Ready_queue_first (Priority_bit_map_Control bit_map, Chain_Control ready_queues)
	Returns a pointer to the first node. More...

RTEMS_INLINE_ROUTINE void	_Scheduler_priority_Schedule_body (const Scheduler_Control scheduler, Thread_Control the_thread, bool force_dispatch)
	Scheduling decision logic. More...

RTEMS_INLINE_ROUTINE void	_Scheduler_priority_Ready_queue_update (Scheduler_priority_Ready_queue ready_queue, unsigned int new_priority, Priority_bit_map_Control bit_map, Chain_Control *ready_queues)
	Updates the specified ready queue data according to the new priority value. More...

Detailed Description

Deterministic Priority Scheduler.

Macro Definition Documentation

◆ SCHEDULER_PRIORITY_ENTRY_POINTS

#define SCHEDULER_PRIORITY_ENTRY_POINTS

Value:

{ \
    _Scheduler_priority_Initialize,       /* initialize entry point */ \
    _Scheduler_priority_Schedule,         /* schedule entry point */ \
    _Scheduler_priority_Yield,            /* yield entry point */ \
    _Scheduler_priority_Block,            /* block entry point */ \
    _Scheduler_priority_Unblock,          /* unblock entry point */ \
    _Scheduler_priority_Update_priority,  /* update priority entry point */ \
    _Scheduler_default_Map_priority,      /* map priority entry point */ \
    _Scheduler_default_Unmap_priority,    /* unmap priority entry point */ \
    SCHEDULER_OPERATION_DEFAULT_ASK_FOR_HELP \
    _Scheduler_priority_Node_initialize,  /* node initialize entry point */ \
    _Scheduler_default_Node_destroy,      /* node destroy entry point */ \
    _Scheduler_default_Release_job,       /* new period of task */ \
    _Scheduler_default_Cancel_job,        /* cancel period of task */ \
    _Scheduler_default_Tick,              /* tick entry point */ \
    _Scheduler_default_Start_idle         /* start idle entry point */ \
    SCHEDULER_OPERATION_DEFAULT_GET_SET_AFFINITY \
  }

Entry points for the Deterministic Priority Based Scheduler.

Function Documentation

◆ _Scheduler_priority_Block()

void _Scheduler_priority_Block	(	const Scheduler_Control *	scheduler,
		Thread_Control *	the_thread,
		Scheduler_Node *	node
	)

Blocks the thread.

Parameters

	scheduler	The scheduler instance.
[in,out]	the_thread	The thread to block.
[in,out]	node	The thread's scheduler node.

◆ _Scheduler_priority_Extract_body()

RTEMS_INLINE_ROUTINE void _Scheduler_priority_Extract_body	(	const Scheduler_Control *	scheduler,
		Thread_Control *	the_thread,
		Scheduler_Node *	node
	)

Extracts a node from the context of the scheduler.

Parameters

	scheduler	The scheduler instance.
	the_thread	The thread of which the node will be extracted.
[in,out]	The	node which preserves the ready queue.

◆ _Scheduler_priority_Get_context()

RTEMS_INLINE_ROUTINE Scheduler_priority_Context* _Scheduler_priority_Get_context ( const Scheduler_Control * scheduler )

Gets the context of the scheduler.

Parameters

scheduler The scheduler to get the context of.

Returns: The context of the scheduler.

◆ _Scheduler_priority_Initialize()

void _Scheduler_priority_Initialize ( const Scheduler_Control * scheduler )

Initializes the priority scheduler.

This routine initializes the priority scheduler.

Parameters

scheduler The scheduler to initialize.

◆ _Scheduler_priority_Node_downcast()

RTEMS_INLINE_ROUTINE Scheduler_priority_Node* _Scheduler_priority_Node_downcast ( Scheduler_Node * node )

Gets the priority node of the scheduler node.

Parameters

node	The node to get the priority node of.

Returns: The priority node.

◆ _Scheduler_priority_Node_initialize()

void _Scheduler_priority_Node_initialize	(	const Scheduler_Control *	scheduler,
		Scheduler_Node *	node,
		Thread_Control *	the_thread,
		Priority_Control	priority
	)

Initializes the node with the given priority.

Parameters

	scheduler	The scheduler instance.
[out]	node	The node to initialize.
	the_thread	The thread of the scheduler node.
	priority	The priority for the initialization.

◆ _Scheduler_priority_Ready_queue_enqueue()

RTEMS_INLINE_ROUTINE void _Scheduler_priority_Ready_queue_enqueue	(	Chain_Node *	node,
		Scheduler_priority_Ready_queue *	ready_queue,
		Priority_bit_map_Control *	bit_map
	)

Enqueues a node on the specified ready queue.

The node is placed as the last element of its priority group.

Parameters

	node	The node to enqueue.
[in,out]	ready_queue	The ready queue.
[out]	bit_map	The priority bit map of the scheduler instance.

◆ _Scheduler_priority_Ready_queue_enqueue_first()

RTEMS_INLINE_ROUTINE void _Scheduler_priority_Ready_queue_enqueue_first	(	Chain_Node *	node,
		Scheduler_priority_Ready_queue *	ready_queue,
		Priority_bit_map_Control *	bit_map
	)

Enqueues a node on the specified ready queue as first.

The node is placed as the first element of its priority group.

Parameters

	node	The node to enqueue as first.
[in,out]	ready_queue	The ready queue.
[out]	bit_map	The priority bit map of the scheduler instance.

◆ _Scheduler_priority_Ready_queue_extract()

RTEMS_INLINE_ROUTINE void _Scheduler_priority_Ready_queue_extract	(	Chain_Node *	node,
		Scheduler_priority_Ready_queue *	ready_queue,
		Priority_bit_map_Control *	bit_map
	)

Extracts a node from the specified ready queue.

Parameters

	node	The node to extract.
[in,out]	ready_queue	The ready queue.
[out]	bit_map	The priority bit map of the scheduler instance.

◆ _Scheduler_priority_Ready_queue_first()

RTEMS_INLINE_ROUTINE Chain_Node* _Scheduler_priority_Ready_queue_first	(	Priority_bit_map_Control *	bit_map,
		Chain_Control *	ready_queues
	)

Returns a pointer to the first node.

This routines returns a pointer to the first node on ready_queues.

Parameters

bit_map	The priority bit map of the scheduler instance.
ready_queues	The ready queues of the scheduler instance.

Returns: This method returns the first node.

◆ _Scheduler_priority_Ready_queue_initialize()

RTEMS_INLINE_ROUTINE void _Scheduler_priority_Ready_queue_initialize	(	Chain_Control *	ready_queues,
		Priority_Control	maximum_priority
	)

Ready queue initialization.

This routine initializes ready_queues for priority-based scheduling.

Parameters

[out]	ready_queues	The ready queue to initialize.
	maximum_priority	The maximum priority in the ready queue.

◆ _Scheduler_priority_Ready_queue_update()

RTEMS_INLINE_ROUTINE void _Scheduler_priority_Ready_queue_update	(	Scheduler_priority_Ready_queue *	ready_queue,
		unsigned int	new_priority,
		Priority_bit_map_Control *	bit_map,
		Chain_Control *	ready_queues
	)

Updates the specified ready queue data according to the new priority value.

Parameters

[in,out]	ready_queue	The ready queue.
	new_priority	The new priority.
	bit_map	The priority bit map of the scheduler instance.
	ready_queues	The ready queues of the scheduler instance.

◆ _Scheduler_priority_Schedule()

void _Scheduler_priority_Schedule	(	const Scheduler_Control *	scheduler,
		Thread_Control *	the_thread
	)

Sets the heir thread to be the next ready thread.

This kernel routine sets the heir thread to be the next ready thread by invoking the_scheduler->ready_queue->operations->first().

Parameters

scheduler	The scheduler instance.
the_thread	The thread for the operation.

◆ _Scheduler_priority_Schedule_body()

RTEMS_INLINE_ROUTINE void _Scheduler_priority_Schedule_body	(	const Scheduler_Control *	scheduler,
		Thread_Control *	the_thread,
		bool	force_dispatch
	)

Scheduling decision logic.

This kernel routine implements scheduling decision logic for priority-based scheduling.

Parameters

[in,out]	scheduler	The scheduler instance.
	the_thread	This parameter is unused.
	force_dispatch	Indicates whether the dispatch happens also if the currently executing thread is set as not preemptible.

◆ _Scheduler_priority_Thread_get_node()

RTEMS_INLINE_ROUTINE Scheduler_priority_Node* _Scheduler_priority_Thread_get_node ( Thread_Control * the_thread )

Gets the scheduler node of the thread.

Parameters

the_thread The thread to get the scheduler node of.

Returns: The scheduler node of the_thread.

◆ _Scheduler_priority_Unblock()

void _Scheduler_priority_Unblock	(	const Scheduler_Control *	scheduler,
		Thread_Control *	the_thread,
		Scheduler_Node *	node
	)

Unblocks the thread.

Parameters

	scheduler	The scheduler instance.
[in,out]	the_thread	The thread to unblock.
[in,out]	node	The thread's scheduler node.

◆ _Scheduler_priority_Update_priority()

void _Scheduler_priority_Update_priority	(	const Scheduler_Control *	scheduler,
		Thread_Control *	the_thread,
		Scheduler_Node *	base_node
	)

Updates the priority of the node.

Parameters

scheduler	The scheduler instance.
the_thread	The thread for the operation.
base_node	The thread's scheduler node.

◆ _Scheduler_priority_Yield()

void _Scheduler_priority_Yield	(	const Scheduler_Control *	scheduler,
		Thread_Control *	the_thread,
		Scheduler_Node *	node
	)

Performs the yield of a thread.

Parameters

	scheduler	The scheduler instance.
[in,out]	the_thread	The thread that performed the yield operation.
	node	The scheduler node of the_thread.

Files

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ SCHEDULER_PRIORITY_ENTRY_POINTS

Function Documentation

◆ _Scheduler_priority_Block()

◆ _Scheduler_priority_Extract_body()

◆ _Scheduler_priority_Get_context()

◆ _Scheduler_priority_Initialize()

◆ _Scheduler_priority_Node_downcast()

◆ _Scheduler_priority_Node_initialize()

◆ _Scheduler_priority_Ready_queue_enqueue()

◆ _Scheduler_priority_Ready_queue_enqueue_first()

◆ _Scheduler_priority_Ready_queue_extract()

◆ _Scheduler_priority_Ready_queue_first()

◆ _Scheduler_priority_Ready_queue_initialize()

◆ _Scheduler_priority_Ready_queue_update()

◆ _Scheduler_priority_Schedule()

◆ _Scheduler_priority_Schedule_body()

◆ _Scheduler_priority_Thread_get_node()

◆ _Scheduler_priority_Unblock()

◆ _Scheduler_priority_Update_priority()

◆ _Scheduler_priority_Yield()