Add support for Sail unit tests #710
Conversation
|
Feels like these have the potential to be a lower barrier of entry for writing certain kinds of tests,(especially for tricky to reach edge cases of the system), so seems like a good idea to me. Once we get the C/assembly test situation sorted out we can think about what makes sense to run as a C test versus a unit test, but having both options seems like a net positive. |
|
@Timmmm Now that Sail 0.19 is released with unit test support, this is something that can be finished up if we still want it. Not sure that there are a whole lot of tests that should exist here instead of as first party assembly tests, but seems reasonable to include support for them. |
Timmmm
force-pushed
the
user/timh/unit_tests
branch
from
39c5491 to
6598087
Compare
Timmmm
force-pushed
the
user/timh/unit_tests
branch
from
6598087 to
e73b81d
Compare
Timmmm
force-pushed
the
user/timh/unit_tests
branch
3 times, most recently
from
8a55801 to
a1d9603
Compare
Timmmm
force-pushed
the
user/timh/unit_tests
branch
from
a1d9603 to
d4e8acd
Compare
|
Rebased & README added. |
Timmmm
added
will be merged
|
I'll see if I can sort out the Lean errors. |
This adds basic support for Sail unit tests. These have some pros and cons over C tests: Pros: * They don't require a RISC-V C compiler. * They can test internal code (hence why I've called them unit tests). * They can "cheat", e.g. to change privilege mode you can just magically `cur_privilege = Supervisor`. With C you have to implement a syscall, etc. Cons: * They are tied to internal code which will make refactoring more tedious because it means you are likely to need to update the tests. We can minimise that by using "high level" functions like `execute()`, `read_CSR()`, etc. * They only run on the Sail model, so we can't e.g. verify them against SPIKE. Currently the unit test executable reuses a load of code from the emulator, which is not ideal. When we have wrapped the model in a nice C++ library we can use that instead.
Timmmm
force-pushed
the
user/timh/unit_tests
branch
from
d4e8acd to
272ea4a
Compare
|
Rebased but it's broken now and awkward to fix due to using the Sail generated header. Will probably have to wait until runtime XLEN is merged. |
This adds basic support for Sail unit tests. These have some pros and cons over C tests:
Pros:
cur_privilege = Supervisor. With C you have to implement a syscall, etc.Cons:
execute(),read_CSR(), etc.Given the sorry state of testing in this repo, and the fact that we don't have a way of writing C tests at all yet, I think this is probably a good medium term approach.
Currently the unit test executable reuses a load of code from the emulator, which is not ideal. When we have wrapped the model in a nice C++ library we can use that instead.