Update CommandReturn in preparation for the Command implementation.
#299
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
jrvanwhy
added
the
significant
`libtock_platform` does not provide safe constructors for `CommandReturn`, as in a process binary it is supposed to only be created by invocations of the Command system call. However, fake drivers for unit tests (as well as many unit tests) have a need to create their own `CommandReturn` values. To avoid a proliferation of `unsafe`, I added safe constructors for `CommandReturn` to `libtock_unittest`. For testing purposes, I added unconditional `Debug` derives to some of the `libtock_platform` types. These are meant only for use in host-based tests: embedded code should use a lighter-weight solution (we're currently trying out `ufmt` for this).
hudson-ayers
approved these changes
May 13, 2021
alistair23
approved these changes
May 14, 2021
|
bors r+ |
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.
This makes the following change to
CommandReturn, which are needed by my implementation of the Command system call and its tests:Debug. This is not a replacement forufmt-based debugging, but rather to support unit tests (e.g.assert_eq!).usizetou32, asRawSyscallsno longer returns its registers asusizes. I discovered that code that interacts withCommandReturnis cleaner if we storeu32s inCommandReturnrather thanRegisters.newis nowpubrather thanpub(crate), aslibtock_unittestneeds to createCommandReturnvalues.CommandReturn::raw_values, which will be used bylibtock_unittestto transformCommandReturns from fake drivers and expected syscalls into register values forRawSyscalls.CommandReturnconstructors tolibtock_unittest.libtock_platformintentionally does not expose safe constructors, as a process binary should only create aCommandReturnby calling the Command system call. However,libtock_unittestand unit tests based on it need to createCommandReturnvalues as well, so I added safe constructors.The combination of 1 and 5 required me to add
DebugtoErrorCodeandReturnVariant, so I did that as well.