FreeRTOS-Kernel/FreeRTOS/Test/VeriFast/list
alfred gedeon ae92d8c6ee
Add uncrustify github workflow (#659)
* Add uncrustify github workflow

* Fix exclusion pattern

* fix find expression

* exclude uncrustify files

* Uncrustify common demo and test files

* exlude white space checking files

* Fix EOL whitespace checker

* Remove whitespaces from EOL

* Fix space at EOL

* Fix find spaces at EOL

Co-authored-by: Archit Aggarwal <architag@amazon.com>
2021-07-22 14:23:48 -07:00
..
listLIST_IS_EMPTY.c Add uncrustify github workflow (#659) 2021-07-22 14:23:48 -07:00
README.md List proofs and signoff (#194) 2020-08-27 11:59:12 -07:00
uxListRemove.c Add uncrustify github workflow (#659) 2021-07-22 14:23:48 -07:00
vListInitialise.c Add uncrustify github workflow (#659) 2021-07-22 14:23:48 -07:00
vListInitialiseItem.c Merge FreeRTOS 202104.00 to main (#585) 2021-04-29 14:53:40 -07:00
vListInsert.c Add uncrustify github workflow (#659) 2021-07-22 14:23:48 -07:00
vListInsertEnd.c Add uncrustify github workflow (#659) 2021-07-22 14:23:48 -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