adbrucker
/
lh-l4v
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme: explain L4V_ARCH and spec generation (#586) 

We have so far not been mentioning L4V_ARCH in the instructions and
haven't pointed out which sessions need generated input.

Add this information to the instructions.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
This commit is contained in:
Gerwin Klein 2023-03-01 16:53:37 +11:00 committed by GitHub
parent aa53e9a84c
commit 244e7d464f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -165,44 +165,55 @@ Running the Proofs
------------------ ------------------
If Isabelle is set up correctly, a full test for the proofs in this repository If Isabelle is set up correctly, a full test for the proofs in this repository
can be run with the command for seL4 on the `ARM` architecture can be run with the command
./run_tests L4V_ARCH=ARM ./run_tests
from the directory `l4v/`. from the directory `l4v/`.
Not all of the proof sessions can be built directly with the `isabelle build` command. Set the environment variable `L4V_ARCH` to one of `ARM`, `ARM_HYP`, `X64`,
The seL4 verification proofs depend on Isabelle specifications that are `RISCV64`, or `AARCH64` to get the proofs for the respective architecture. `ARM`
generated from the C source code and Haskell model. has the most complete set of proofs, the other architectures tend to support
Therefore, it's recommended to always build using the supplied makefiles, only a subset of the proof sessions defined for `ARM`.
which will ensure that these generated specs are up to date.
Not all of the proof sessions can be built directly with the `isabelle build`
command. The seL4 proofs depend on Isabelle specifications that are generated
from the C source code and Haskell model. Therefore, it is recommended to always
build using the `run_tests` command or the supplied Makefiles, which will ensure
that these generated specs are up to date.
To do this, enter one level under the `l4v/` directory and run `make <session-name>`. To do this, enter one level under the `l4v/` directory and run `make <session-name>`.
For example, to build the C refinement proof session, do For example, to build the abstract specification, do
cd l4v/proof
make CRefine
As another example, to build the session for the Haskell model, do
export L4V_ARCH=ARM
cd l4v/spec cd l4v/spec
make ExecSpec make ASpec
See the `HEAPS` variable in the corresponding `Makefile` for available targets. See the `HEAPS` variable in the corresponding `Makefile` for available targets.
The sessions that directly depend on generated sources are `ASpec`, `ExecSpec`,
and `CKernel`. These, and all sessions that depend on them, need to be run using
`run_tests` or `make`.
Proof sessions that do not depend on generated inputs can be built directly with Proof sessions that do not depend on generated inputs can be built directly with
./isabelle/bin/isabelle build -d . -v -b <session name> ./isabelle/bin/isabelle build -d . -v -b <session name>
from the directory `l4v/`. For available sessions, see the corresponding from the directory `l4v/`. For available sessions and their dependencies, see
`ROOT` files in this repository. There is roughly one session corresponding to the corresponding `ROOT` files in this repository. There is roughly one session
each major directory in the repository. corresponding to each major directory in the repository.
For interactively exploring, say the invariant proof of the abstract For interactively exploring, say the invariant proof of the abstract
specification with a pre-built logic image for the abstract specification and specification on `ARM`, note that in `proof/ROOT` the parent session for
all of the invariant proof's dependencies, run `AInvs` is `ASpec` and therefore run:
export L4V_ARCH=ARM
./run_tests ASpec
./isabelle/bin/isabelle jedit -d . -R AInvs ./isabelle/bin/isabelle jedit -d . -R AInvs
in `l4v/` and open one of the files in `proof/invariant-abstract`. or, if you prefer `make`:
export L4V_ARCH=ARM
cd spec; make ASpec
../isabelle/bin/isabelle jedit -d . -R AInvs
in `l4v/` and open one of the files in `proof/invariant-abstract`.