Move Edu program status history to FRAM #328
Merged
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #328 +/- ##
=========================================
Coverage ? 87.27%
=========================================
Files ? 37
Lines ? 1352
Branches ? 50
=========================================
Hits ? 1180
Misses ? 172
Partials ? 0 ☔ View full report in Codecov by Sentry. |
jeromehue
force-pushed
the
move-edu-proghistory-fram
branch
from
0593f19 to
3f90355
Compare
PatrickKa
requested changes
Oct 5, 2024
Comment on lines
22
to
26
| auto entry = programStatusHistory.Get(i); | ||
| if(entry.startTime == startTime and entry.programId == programId) | ||
| { | ||
| programStatusHistory.vals[i].status = newStatus; | ||
| entry.status = newStatus; | ||
| programStatusHistory.Set(i, entry); |
There was a problem hiding this comment.
I just realized that this is not thread-safe in the sense that someone might call PushBack() between Get() and Set(). This would mean that the index i might point to a different location/entry. We somehow need to ensure that getting and setting the entry is atomic. The only way that I can think of right now that would achieve that is to add RingArray<T>::FindAndReplace(predicate, newData/Element/Entry) where predicate is a callable that takes a T const & and returns something convertible to bool.
Add a new RingArray programStatusHistory variable, and a new update() method for it.
The only missing thing is to test that the fram is correctly written, i.e something like `Require(fram::ram::memory[address] == value)`.
Remove useless variables and clang-format comments.
Remove dependency to Edu module.
- Shorten `FindAndReplace()` signature - Rename `ComputeSize()` to `FramSize()` - Add some comments
Also fix the test since the cache entries remain even after resetting the FRAM memory to zero.
Since `RingArray` uses the Thread-safe Interface pattern, public functions must not call other public functions because that would lead to recursive locking. Rodos' semaphores might support that but I think it is cleaner and easier to reason about if we stick to the pattern and ensure that we only ever enter the semaphore once. `FindAndReplace()` used `Get()` and `Set()` so I had to make private implementation functions (`DoGet()` and `DoSet()`) for them that do all the work except for creating the `ScopeProtector`.
There was a warning about a narrowing conversion from 64 to 32 bits, so I changed the underlying type of `RingArray::RingIndex` from `std::size_t` to that of `fram::Size` which is `std::uint32_t`.
PatrickKa
force-pushed
the
move-edu-proghistory-fram
branch
from
516a364 to
17a700c
Compare
PatrickKa
approved these changes
Oct 21, 2024
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
Move EDU program status history to FRAM by using the
fram::RingArrayto store program status history entries. Additionally, improve the unit test forRingArraywith the addition of a custom typeRingArraytest case.Fixes #204