Check if the schedule is empty before reading it. #184
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
The `Event::should_trigger` method uses `.begin()` on the set of times at which it needs to fire to compare that value with the current tick. However it was missing a check in the case of an empty set. When that happens, `begin()` returns a pointer to uninitialized memory and we we reading garbage out of it. If that garbage happens to be equal to the current time step, the event would fire spuriously, even though it wasn't meant to. The fix is straightforward: we just need to check if the set is empty before reading from the set. If it is empty then the event never triggers.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #184 +/- ##
=======================================
Coverage 96.25% 96.26%
=======================================
Files 36 36
Lines 1817 1819 +2
=======================================
+ Hits 1749 1751 +2
Misses 68 68 ☔ View full report in Codecov by Sentry. |
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.
The
Event::should_triggermethod uses.begin()on the set of times at which it needs to fire to compare that value with the current tick. However it was missing a check in the case of an empty set. When that happens,begin()returns a pointer to uninitialized memory and we we reading garbage out of it. If that garbage happens to be equal to the current time step, the event would fire spuriously, even though it wasn't meant to.The fix is straightforward: we just need to check if the set is empty before reading from the set. If it is empty then the event never triggers.