#include "vault/gear/scheduler-invocation.hpp"

Description

Scheduler Layer-1 : time based dispatch.

Manages pointers to Render Activity records.

new entries passed in through the instruct_ queue
time based prioritisation in the priority_ queue
Warning
not threadsafe; requires Layer-2 to coordinate.

See also
Scheduler

SchedulerInvocation_test

Definition at line 148 of file scheduler-invocation.hpp.

Public Member Functions
	SchedulerInvocation ()

void	discardSchedule ()
	forcibly clear out the schedule

void	instruct (ActivationEvent actEvent)
	Accept an ActivationEvent with an Activity for time-bound execution.

void	feedPrioritisation ()
	Pick up all new events from the entrance queue and enqueue them to be retrieved ordered by start time.

void	feedPrioritisation (ActivationEvent actEvent)
	Feed the given Activity directly into time prioritisation, effectively bypassing the thread dispatching entrance queue.

ActivationEvent	peekHead ()

ActivationEvent	pullHead ()
	Retrieve from the scheduling queue the entry with earliest start time.

void	activate (ManifestationID manID)
	Enable entries marked with a specific ManifestationID to be processed.

void	drop (ManifestationID manID)

bool	isDue (Time now) const
	Determine if there is work to do right now.

bool	isMissed (Time now) const
	determine if the Activity at scheduler head missed it's deadline.

bool	isActivated (ManifestationID manID) const
	determine if Activities with the given ManifestationID shall be processed

bool	isOutdated (Time now) const
	determine if Activity at scheduler is outdated and should be discarded

bool	isOutOfTime (Time now) const
	detect a compulsory Activity at scheduler head with missed deadline

bool	hasPendingInput () const

bool	empty () const

Time	headTime () const

Private Types
using	InstructQueue = boost::lockfree::queue< ActivationEvent >

using	PriorityQueue = std::priority_queue< ActivationEvent >

using	ActivationSet = std::unordered_set< ManifestationID >

Static Private Member Functions
static int64_t	waterLevel (Time time)

Private Attributes
InstructQueue	instruct_

PriorityQueue	priority_

ActivationSet	allowed_

Additional Inherited Members
Private Member Functions inherited from NonCopyable
	~NonCopyable ()=default

	NonCopyable ()=default

	NonCopyable (NonCopyable const &)=delete

NonCopyable &	operator= (NonCopyable const &)=delete

Constructor & Destructor Documentation

◆ SchedulerInvocation()

SchedulerInvocation ( )

inline

Definition at line 161 of file scheduler-invocation.hpp.

Member Typedef Documentation

◆ InstructQueue

using InstructQueue = boost::lockfree::queue<ActivationEvent>

private

Definition at line 151 of file scheduler-invocation.hpp.

◆ PriorityQueue

using PriorityQueue = std::priority_queue<ActivationEvent>

private

Definition at line 152 of file scheduler-invocation.hpp.

◆ ActivationSet

using ActivationSet = std::unordered_set<ManifestationID>

private

Definition at line 153 of file scheduler-invocation.hpp.

Member Function Documentation

◆ discardSchedule()

void discardSchedule ( )

inline

forcibly clear out the schedule

Definition at line 170 of file scheduler-invocation.hpp.

References SchedulerInvocation::instruct_, and SchedulerInvocation::priority_.

Referenced by Scheduler::terminateProcessing().

Here is the caller graph for this function:

◆ instruct()

void instruct ( ActivationEvent actEvent )

inline

Accept an ActivationEvent with an Activity for time-bound execution.

Definition at line 181 of file scheduler-invocation.hpp.

References SchedulerInvocation::instruct_.

Referenced by SchedulerCommutator::postChain(), SchedulerInvocation_test::simpleUsage(), SchedulerCommutator_test::verify_dispatch(), SchedulerInvocation_test::verify_Queuing(), and SchedulerInvocation_test::verify_WaterLevel().

Here is the caller graph for this function:

◆ feedPrioritisation() [1/2]

void feedPrioritisation ( )

inline

Pick up all new events from the entrance queue and enqueue them to be retrieved ordered by start time.

Definition at line 194 of file scheduler-invocation.hpp.

References SchedulerInvocation::instruct_, and SchedulerInvocation::priority_.

Referenced by SchedulerCommutator::findWork(), SchedulerCommutator::maintainQueueHead(), SchedulerCommutator::maybeFeed(), SchedulerCommutator::postChain(), SchedulerInvocation_test::simpleUsage(), SchedulerCommutator_test::verify_dispatch(), SchedulerInvocation_test::verify_isDue(), SchedulerCommutator_test::verify_postChain(), SchedulerInvocation_test::verify_Queuing(), SchedulerInvocation_test::verify_Significance(), SchedulerInvocation_test::verify_stability(), and SchedulerInvocation_test::verify_WaterLevel().

Here is the caller graph for this function:

◆ feedPrioritisation() [2/2]

void feedPrioritisation ( ActivationEvent actEvent )

inline

Feed the given Activity directly into time prioritisation, effectively bypassing the thread dispatching entrance queue.

Remarks: Layer-2 uses this shortcut when in »grooming mode«.

Definition at line 208 of file scheduler-invocation.hpp.

References SchedulerInvocation::priority_.

◆ peekHead()

ActivationEvent peekHead ( )

inline

Returns: »empty marker« if the queue is empty, else a copy of the currently most urgent element (without dequeuing it).

Definition at line 219 of file scheduler-invocation.hpp.

References SchedulerInvocation::priority_.

Referenced by SchedulerInvocation::pullHead(), SchedulerInvocation_test::simpleUsage(), SchedulerInvocation_test::verify_isDue(), SchedulerCommutator_test::verify_postChain(), SchedulerInvocation_test::verify_Queuing(), and SchedulerInvocation_test::verify_WaterLevel().

Here is the caller graph for this function:

◆ pullHead()

ActivationEvent pullHead ( )

inline

Retrieve from the scheduling queue the entry with earliest start time.

Returns: »empty marker« if the prioritisation queue is empty, else a pointer to the most urgent Activity dequeued thereby.

Remarks: Activity Records are managed by the BlockFlow allocator.

Definition at line 232 of file scheduler-invocation.hpp.

References SchedulerInvocation::peekHead(), and SchedulerInvocation::priority_.

Referenced by SchedulerCommutator::findWork(), SchedulerCommutator::maintainQueueHead(), SchedulerInvocation_test::simpleUsage(), SchedulerInvocation_test::verify_isDue(), SchedulerCommutator_test::verify_postChain(), SchedulerInvocation_test::verify_Queuing(), SchedulerInvocation_test::verify_Significance(), SchedulerInvocation_test::verify_stability(), and SchedulerInvocation_test::verify_WaterLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ activate()

void activate ( ManifestationID manID )

inline

Enable entries marked with a specific ManifestationID to be processed.

By default, entries are marked with the default ManifestationID, which is always implicitly activated. Any other ID must be actively allowed, otherwise the entry is deemed outdated and will be silently discarded in regular processing by Layer-2.