#include <single_timer_executor.h>

Inheritance diagram for SingleTimerExecutor:

Collaboration diagram for SingleTimerExecutor:

[legend]

Public Member Functions
	SingleTimerExecutor ()

void	scheduleByTimestamp (const char msg, scheduling_s scheduling, efitimeus_t timeUs, action_s action) override
	Schedule an event at specific delay after now. More...

void	scheduleByTimestampNt (const char msg, scheduling_s scheduling, efitick_t timeNt, action_s action) override

void	scheduleForLater (const char msg, scheduling_s scheduling, int delayUs, action_s action) override

void	cancel (scheduling_s *scheduling) override

void	onTimerCallback ()

Data Fields
int	timerCallbackCounter = 0

int	scheduleCounter = 0

int	maxExecuteCounter = 0

int	executeCounter

int	executeAllPendingActionsInvocationCounter = 0

Private Member Functions
void	executeAllPendingActions ()

void	scheduleTimerCallback ()

Private Attributes
EventQueue	queue

bool	reentrantFlag = false

Detailed Description

Definition at line 13 of file single_timer_executor.h.

Constructor & Destructor Documentation

◆ SingleTimerExecutor()

SingleTimerExecutor::SingleTimerExecutor ( )

Definition at line 42 of file single_timer_executor.cpp.

     : queue(US2NT(8))
 {
 }

Member Function Documentation

◆ cancel()

void SingleTimerExecutor::cancel ( scheduling_s * scheduling )

overridevirtual

Implements ExecutorInterface.

Definition at line 94 of file single_timer_executor.cpp.

                                                          {
     // Lock for queue removal - we may already be locked, but that's ok
     chibios_rt::CriticalSectionLocker csl;
  
     queue.remove(scheduling);
 }

Referenced by TriggerScheduler::scheduleEventsUntilNextTriggerTooth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeAllPendingActions()

void SingleTimerExecutor::executeAllPendingActions ( )

private

Let's execute actions we should execute at this point. reentrantFlag takes care of the use case where the actions we are executing are scheduling further invocations

in real life it could be that while we executing listeners time passes and it's already time to execute next listeners. TODO: add a counter & figure out a limit of iterations?

Definition at line 113 of file single_timer_executor.cpp.

                                                    {
     ScopePerf perf(PE::SingleTimerExecutorDoExecute);
  
     executeAllPendingActionsInvocationCounter++;
     /**
      * Let's execute actions we should execute at this point.
      * reentrantFlag takes care of the use case where the actions we are executing are scheduling
      * further invocations
      */
     reentrantFlag = true;
  
     /**
      * in real life it could be that while we executing listeners time passes and it's already time to execute
      * next listeners.
      * TODO: add a counter & figure out a limit of iterations?
      */
  
     // starts at -1 because do..while will run a minimum of once
     executeCounter = -1;
  
     bool didExecute;
     do {
         efitick_t nowNt = getTimeNowNt();
         didExecute = queue.executeOne(nowNt);
  
         // if we're stuck in a loop executing lots of events, panic!
         if (executeCounter++ == 500) {
             firmwareError(ObdCode::CUSTOM_ERR_LOCK_ISSUE, "Maximum scheduling run length exceeded - CPU load too high");
         }
  
     } while (didExecute);
  
     maxExecuteCounter = maxI(maxExecuteCounter, executeCounter);
  
     if (!isLocked()) {
         firmwareError(ObdCode::CUSTOM_ERR_LOCK_ISSUE, "Someone has stolen my lock");
         return;
     }
     reentrantFlag = false;
 }

Referenced by onTimerCallback(), and scheduleByTimestampNt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onTimerCallback()

void SingleTimerExecutor::onTimerCallback ( )

Definition at line 101 of file single_timer_executor.cpp.

                                           {
     timerCallbackCounter++;
  
     chibios_rt::CriticalSectionLocker csl;
  
     executeAllPendingActions();
     scheduleTimerCallback();
 }

Referenced by globalTimerCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scheduleByTimestamp()

void SingleTimerExecutor::scheduleByTimestamp	(	const char *	msg,
		scheduling_s *	scheduling,
		efitimeus_t	timeUs,
		action_s	action
	)

overridevirtual

Schedule an event at specific delay after now.

Invokes event callback after the specified amount of time. callback would be executed either on ISR thread or current thread if we would need to execute right away

Parameters

[in,out]	scheduling	Data structure to keep this event in the collection.
[in]	delayUs	the number of microseconds before the output signal immediate output if delay is zero.
[in]	dwell	the number of ticks of output duration.

Implements ExecutorInterface.

Definition at line 62 of file single_timer_executor.cpp.

                                                                                                                             {
     scheduleByTimestampNt(msg, scheduling, US2NT(timeUs), action);
 }

Referenced by scheduleForLater(), and toggleTestAndScheduleNext().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scheduleByTimestampNt()

void SingleTimerExecutor::scheduleByTimestampNt	(	const char *	msg,
		scheduling_s *	scheduling,
		efitick_t	timeNt,
		action_s	action
	)

overridevirtual

Implements ExecutorInterface.

Definition at line 66 of file single_timer_executor.cpp.

                                                                                                                         {
     ScopePerf perf(PE::SingleTimerExecutorScheduleByTimestamp);
  
 #if EFI_ENABLE_ASSERTS
     efidur_t deltaTimeNt = nt - getTimeNowNt();
  
     if (deltaTimeNt >= TOO_FAR_INTO_FUTURE_NT) {
         // we are trying to set callback for too far into the future. This does not look right at all
         int32_t intDeltaTimeNt = (int32_t)deltaTimeNt;
         firmwareError(ObdCode::CUSTOM_ERR_TASK_TIMER_OVERFLOW, "scheduleByTimestampNt() too far: %d %s", intDeltaTimeNt, msg);
         return;
     }
 #endif
  
     scheduleCounter++;
  
     // Lock for queue insertion - we may already be locked, but that's ok
     chibios_rt::CriticalSectionLocker csl;
  
     bool needToResetTimer = queue.insertTask(scheduling, nt, action);
     if (!reentrantFlag) {
         executeAllPendingActions();
         if (needToResetTimer) {
             scheduleTimerCallback();
         }
     }
 }

Referenced by fireSparkAndPrepareNextSchedule(), runBench(), scheduleByAngle(), scheduleByTimestamp(), and triggerScopeGetBuffer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scheduleForLater()

void SingleTimerExecutor::scheduleForLater	(	const char *	msg,
		scheduling_s *	scheduling,
		int	delayUs,
		action_s	action
	)

overridevirtual

Implements ExecutorInterface.

Definition at line 48 of file single_timer_executor.cpp.

                                                                                                                   {
     scheduleByTimestamp(msg, scheduling, getTimeNowUs() + delayUs, action);
 }

Referenced by initPwmTester(), testCallback(), validateHardwareTimer(), and watchDogBuddyCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scheduleTimerCallback()

void SingleTimerExecutor::scheduleTimerCallback ( )

private

This method is always invoked under a lock

Let's grab fresh time value

Definition at line 157 of file single_timer_executor.cpp.

                                                 {
     ScopePerf perf(PE::SingleTimerExecutorScheduleTimerCallback);
  
     /**
      * Let's grab fresh time value
      */
     efitick_t nowNt = getTimeNowNt();
     expected<efitick_t> nextEventTimeNt = queue.getNextEventTime(nowNt);
  
     if (!nextEventTimeNt) {
         return; // no pending events in the queue
     }
  
     efiAssertVoid(ObdCode::CUSTOM_ERR_6625, nextEventTimeNt.Value > nowNt, "setTimer constraint");
  
     setHardwareSchedulerTimer(nowNt, nextEventTimeNt.Value);
 }