fix: Update EventManager and task::run_on_core to ignore spurious wakeups if they happen
#340
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… wakeups if they happen * Added `notified` flag to `SubscriberData` which is set / cleared appropriately and used as predicate to `cv.wait(...)` * Added `notified` bool used in `run_on_core` to ensure the `cv.wait(...)` uses it as the predicate, ensuring the blocking run on core does not return early
|
✅Static analysis result - no issues found! ✅ |
SquaredPotato
pushed a commit
to smartknob-ha/espp
that referenced
this pull request
Jan 27, 2025
… wakeups if they happen (esp-cpp#340) * fix: Update `EventManager` and `task::run_on_core` to ignore spurious wakeups if they happen * Added `notified` flag to `SubscriberData` which is set / cleared appropriately and used as predicate to `cv.wait(...)` * Added `notified` bool used in `run_on_core` to ensure the `cv.wait(...)` uses it as the predicate, ensuring the blocking run on core does not return early * update to protect shared memory with lock * fix comment
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
notifiedflag toSubscriberDatawhich is set / cleared appropriately and used as predicate tocv.wait(...)notifiedbool used inrun_on_coreto ensure thecv.wait(...)uses it as the predicate, ensuring the blocking run on core does not return earlyMotivation and Context
Spurious wakeups can happen (see c++ docs on condition variable wait and associated methods). On ESP this can happen for instance if you enable light sleep and have some time-dependent wakeups.
Even though the methods changed in this PR use
wait(...)instead ofwait_for(...)orwait_until(...), these changes were applied to ensure better adherence to programming guidelines and recommendations from the c++ reference / standard.How has this been tested?
event_manger/exampleon esp32s3task/exampleon esp32s3Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):
Event Manager example output snippet:
Task example output snippet:
Types of changes
Checklist:
Software
.github/workflows/build.ymlfile to add my new test to the automated cloud build github action.