Merge pull request #5 from ChrisPardy/addFsmTimeoutDetection

add functionality to tell if a wait on a signal timed out
alexhgreen07 · Oct 22, 2021 · 65fd2cb · 65fd2cb
2 parents e14d061 + f27d3da
commit 65fd2cb
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 0 deletions.
diff --git a/emb/fsm.cpp b/emb/fsm.cpp
@@ -23,6 +23,8 @@ void Fsm::sleep(unsigned long milliseconds) {
   scheduler->sleepCurrentExecutor(milliseconds);
 }
 
+bool Fsm::expired() { return lastSignal == NULL; }
+
 void Fsm::wait(Signal &signal, unsigned long milliseconds) {
   assert(scheduler != NULL);
   signal.waitCurrentExecutor(*scheduler, milliseconds);
@@ -127,6 +129,7 @@ void Scheduler::wakeupExpired(list<Entry> &pendingList) {
     if (clock.millis() >= current->value.expiry) {
       pendingList.remove(0);
       current->value.signal = NULL;
+      current->value.fsm->lastSignal = NULL;
       ready.insert(*current);
     } else {
       break;
@@ -164,6 +167,7 @@ void Scheduler::wakeup(list<Entry> &pendingList, Signal &signal, bool all,
     if (current->value.signal == &signal) {
       pendingList.remove(*current);
       current->value.signal = NULL;
+      current->value.fsm->lastSignal = &signal;
       pending.insert(*current);
       if (!all)
         break;

diff --git a/emb/fsm.hpp b/emb/fsm.hpp
@@ -39,6 +39,8 @@ class Fsm {
   void wait(Signal &signal, unsigned long milliseconds = (unsigned long)-1);
   void sleep(unsigned long milliseconds);
 
+  bool expired();
+
   Scheduler *scheduler;
 
 private:
@@ -50,6 +52,7 @@ class Fsm {
   void execute();
   State next;
   Fsm *parent;
+  Signal *lastSignal;
 };
 
 class Scheduler {

diff --git a/test/test_fsm.cpp b/test/test_fsm.cpp
@@ -7,6 +7,8 @@
 using emb::array;
 using namespace FsmFramework;
 
+bool TestFsm::expired() { return Fsm::expired(); }
+
 void TestFsm::initial() {}
 
 void TestFsm::increment() { counter++; }
@@ -169,6 +171,7 @@ TEST(Fsm, WaitsForSignal) {
   for (auto &fsm : otherFsms) {
     LONGS_EQUAL(totalExecutionCount, fsm.counter);
   }
+  CHECK_FALSE(testFsm.expired());
 }
 
 TEST(Fsm, WaitsForBroadcast) {
@@ -213,6 +216,7 @@ TEST(Fsm, WaitsForSignalTimeout) {
   for (auto &fsm : otherFsms) {
     LONGS_EQUAL(totalExecutionCount, fsm.counter);
   }
+  CHECK(testFsm.expired());
 }
 
 TEST(Fsm, WaitsForMultipleSignals) {

diff --git a/test/test_fsm.hpp b/test/test_fsm.hpp
@@ -38,6 +38,8 @@ struct FsmTestGroupBase : public Utest {
 
 struct TestFsm : public Fsm {
 
+  bool expired();
+
   virtual void initial() override;
   void increment();
   void ping();