Skip to content

Commit c57b62a

Browse files
committed
Added some guidance on how to read the proof.
1 parent 1eb83cd commit c57b62a

File tree

1 file changed

+11
-0
lines changed
  • Test/VeriFast/tasks/vTaskSwitchContext

1 file changed

+11
-0
lines changed

Test/VeriFast/tasks/vTaskSwitchContext/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,17 @@ Both scripts expect the command line arguments explained below.
198198
- \<FONT_SIZE\> is an optional argument specifying the IDE's font size.
199199

200200

201+
# Reading the Proof
202+
The most important aspects that we have to understand in order to understand the proof are the following, in this order:
203+
- The locking discipline, cf. `proof/port_locking_contracts.h`
204+
- The lock invariants, cf. `proof/lock_predicates.h`. The invariants use the ready list and task predicates defined in `proof/ready_list_predicates.h` and `task_predicates.h`.
205+
- The contracts for the functions we verified, i.e., `vTaskSwitchContext` and `prvSelectHighestPriorityTask`, cf. `src/tasks.c`.
206+
207+
We propose to first skim the above mentioned files -- in the given order -- and the documentation they provide to get an overview of how the proof is structured.
208+
209+
210+
211+
201212
# Maintaining the Proof
202213
This directory contains annotated copies of FreeRTOS source and header files.
203214
The annotations in these files tell VeriFast which functions it should verify and what the proof looks like.

0 commit comments

Comments
 (0)