FreeRTOS-Kernel/FreeRTOS/Test/VeriFast/list
Nathan Chong 4f87f485d5
Update VeriFast proofs (#836)
* Undo syntax changes preventing VeriFast parsing

* Update proofs inline with source changes

Outstanding:
  - xQueueGenericReset return code
  - Not using prvIncrementQueueTxLock or prvIncrementQueueRxLock macros

* Remove git hash check

* Document new changes between proven code and implementation

* Update copyright header

* VeriFast proofs: turn off uncrustify checks

Uncrustify requires formatting of comments that is at odds with VeriFast's
proof annotations, which are contained within comments.

* Update ci.yml

Co-authored-by: Joseph Julicher <jjulicher@mac.com>
Co-authored-by: Aniruddha Kanhere <60444055+AniruddhaKanhere@users.noreply.github.com>
2022-10-27 14:54:38 -07:00
..
listLIST_IS_EMPTY.c Update VeriFast proofs (#836) 2022-10-27 14:54:38 -07:00
README.md List proofs and signoff (#194) 2020-08-27 11:59:12 -07:00
uxListRemove.c Update VeriFast proofs (#836) 2022-10-27 14:54:38 -07:00
vListInitialise.c Update VeriFast proofs (#836) 2022-10-27 14:54:38 -07:00
vListInitialiseItem.c Update VeriFast proofs (#836) 2022-10-27 14:54:38 -07:00
vListInsert.c Update VeriFast proofs (#836) 2022-10-27 14:54:38 -07:00
vListInsertEnd.c Update VeriFast proofs (#836) 2022-10-27 14:54:38 -07:00

FreeRTOS list proofs

The list predicates and proofs are inspired by and based on the work from Ferreira et al. (STTT'14).

The main shape predicate is a doubly-linked list segment (DLS), as defined by Ferreira et al. in Fig 15. A DLS is defined by two xLIST_ITEM struct pointers n and m (possibly pointing to the same item) which are the start and end of the segment. We track the item pointers and values within the DLS in the lists cells and vals, respectively. Therefore n and m are the first and last items of cells.

          +--+     +--+
 -----n-> |*n| ... |*m| -mnext->
 <-nprev- |  |     |  | <-m-----
          +--+     +--+
          ^-----------^
           DLS(n, nprev, mnext, m)

With base case: n == m (single item case)

          +--+
 -----n-> |*n| -mnext->
 <-nprev- |  | <-n-----
          +--+
          ^--^
          xLIST_ITEM
          DLS(n, nprev, mnext, n)

Cons case:

          +--+      +--+     +--+
 -----n-> |*n| -o-> |*o| ... |*m| -mnext->
 <-nprev- |  | <-n- |  |     |  | <-m-----
          +--+      +--+     +--+
          ^--^      ^-----------^
          xLIST_ITEM DLS(o, n, mnext, m)

          ^---------------------^
          DLS(n, nprev, mnext, m)

A DLS can be made into a well-formed list by joining n and m into a cycle. Note that unlike Ferreira et al.'s list shape predicate, we always start with the sentinel end item to avoid a top-level case-split. So in the following diagram the start and end of the DLS are end and the item-before-end endprev.

 .-----------------------------------.
 |     +--------+     +--------+     |
  `--> |*end    | ... |*endprev| ----'
 .---- |        |     |        | <---.
 |     +--------+     +--------+     |
  `----------------------------------'
       ^-----------------------^
        DLS(end, endprev, end, endprev)

References