lh-l4v/spec/abstract
Gerwin Klein 33e6400f8a aspec: include doc build in ASpec again
Isabelle2020 doesn't allow sharing session directories between the document
session and non-document session. Instead of duplicating things, this commit
pulls the document build back into the ASpec session, but changes the build
such that the git revision is read directly from LaTeX, removing the
superfluous re-build for every git revision change (even when no relevant spec
file changed).

Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-10-27 15:52:31 +10:00
..
ARM aspec: factor out arch_mask_irq_signal 2020-06-08 20:41:10 +08:00
ARM_HYP aspec: factor out arch_mask_irq_signal 2020-06-08 20:41:10 +08:00
RISCV64 riscv: rename sbadaddr -> stval 2020-08-26 15:24:06 +10:00
X64 aspec: factor out arch_mask_irq_signal 2020-06-08 20:41:10 +08:00
document aspec: include doc build in ASpec again 2020-10-27 15:52:31 +10:00
CSpaceAcc_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
CSpace_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
CapRights_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
Decode_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
Deterministic_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
ExceptionTypes_A.thy aspec+ainvs: remove interrupt/irq from p_monad 2020-10-25 13:15:00 +11:00
Exceptions_A.thy aspec+ainvs: remove interrupt/irq from p_monad 2020-10-25 13:15:00 +11:00
Glossary_Doc.thy aspec: include doc build in ASpec again 2020-10-27 15:52:31 +10:00
Interrupt_A.thy aspec: factor out arch_mask_irq_signal 2020-06-08 20:41:10 +08:00
Intro_Doc.thy aspec: include doc build in ASpec again 2020-10-27 15:52:31 +10:00
InvocationLabels_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
Invocations_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
IpcCancel_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
Ipc_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
KHeap_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
KernelInit_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
MiscMachine_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
README.md license: provide documentation under CC-BY-SA-4.0 2020-03-16 14:19:15 +08:00
Retype_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
Schedule_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
Structures_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
Syscall_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
TcbAcc_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
Tcb_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00
VMRights_A.thy licenses: convert license tags to SPDX 2020-03-13 14:38:24 +08:00

README.md

The Abstract Specification of seL4

l4v/spec/abstract/

This directory contains the main Isabelle sources of the seL4 abstract specification. The specification draws in additional interface files from design and machine.

The specification is written in monadic style. See l4v/lib/Monad_WP/NonDetMonad for the definition of this monad.

Top-Level Theory

The top-level theory file that draws the whole specification together is Syscall_A, the top-level function in that theory is call_kernel.

This top-level function defines in-kernel behaviour. Later in the proof, in particular in invariant-abstract, this function is further wrapped in an automaton that describes system behaviour.

Entry Points

Two useful entry points for browsing the abstract specification are the theories Structures_A and ARM_Structs_A. They define the state space of the kernel model, including what capabilities and kernel objects are.

The theories Invocations_A and ArchInvocation_A define datatypes for the capability invocations/operations the kernel understands.

Most theories are named after the subsystem of the kernel they specify.

Building

The corresponding Isabelle session is ASpec. It is set up to build a human-readable PDF document. Glossary_Doc contains definitions of common seL4 terms.

To build, run in directory l4v/spec:

make ASpec

Remarks

  • Note that this specification is actually an extensible family of specifications, with predefined extension points. These points can either be left generic, as for most of the abstract invariant proofs, or they can be instantiated to more precise behaviour, such as in the theory Deterministic_A, which is used for the information flow proofs.

  • The theory Init_A does not define real kernel initialisation. Instead it is a dummy initial state for the kernel to demonstrate non-emptiness of abstract kernel invariants.

  • KernelInit_A is a paused project and not currently included in the rest of the specification.