[wpilib] Fix repeat TimedRobot callbacks on loop overrun (#4101)

If one of the *Init() functions takes several multiples of the nominal
loop time, the callbacks after that will run, then increment their
expiration time by the nominal loop time. Since the new expiration time
is still in the past, this will cause the callback to get repeatedly run
in quick succession until its expiration time catches up with the
current time.

This change keeps incrementing the expiration time until it's in the
future, which will avoid repeated runs. This doesn't delay other
callbacks, so they'll get a chance to run once before their expiration
times are corrected.

The other option is correcting all the expiration times at once, which
would starve the other callbacks even longer so that the callback
scheduling returns to a regular cadence sooner. The problem with this
approach is if a previous callback overruns the start of the next
callback, the next callback could potentially never get a chance to run.
This commit is contained in:
Tyler Veness
2024-07-16 22:56:36 -07:00
committed by GitHub
parent 57fa388724
commit 15001afb31
3 changed files with 66 additions and 46 deletions

View File

@@ -4,6 +4,7 @@
#pragma once
#include <chrono>
#include <functional>
#include <utility>
#include <vector>
@@ -14,7 +15,7 @@
#include <wpi/priority_queue.h>
#include "frc/IterativeRobotBase.h"
#include "frc/Timer.h"
#include "frc/RobotController.h"
namespace frc {
@@ -73,8 +74,8 @@ class TimedRobot : public IterativeRobotBase {
class Callback {
public:
std::function<void()> func;
units::second_t period;
units::second_t expirationTime;
std::chrono::microseconds period;
std::chrono::microseconds expirationTime;
/**
* Construct a callback container.
@@ -84,15 +85,15 @@ class TimedRobot : public IterativeRobotBase {
* @param period The period at which to run the callback.
* @param offset The offset from the common starting time.
*/
Callback(std::function<void()> func, units::second_t startTime,
units::second_t period, units::second_t offset)
Callback(std::function<void()> func, std::chrono::microseconds startTime,
std::chrono::microseconds period, std::chrono::microseconds offset)
: func{std::move(func)},
period{period},
expirationTime{startTime + offset +
units::math::floor(
(Timer::GetFPGATimestamp() - startTime) / period) *
period +
period} {}
expirationTime(
startTime + offset + period +
(std::chrono::microseconds{frc::RobotController::GetFPGATime()} -
startTime) /
period * period) {}
bool operator>(const Callback& rhs) const {
return expirationTime > rhs.expirationTime;
@@ -100,7 +101,7 @@ class TimedRobot : public IterativeRobotBase {
};
hal::Handle<HAL_NotifierHandle> m_notifier;
units::second_t m_startTime;
std::chrono::microseconds m_startTime;
wpi::priority_queue<Callback, std::vector<Callback>, std::greater<Callback>>
m_callbacks;