]> begriffs open source - cmsis-freertos/blob - Test/CBMC/proofs/Task/TaskSwitchContext/tasks_test_access_functions.h
Updated pack to FreeRTOS 10.4.4
[cmsis-freertos] / Test / CBMC / proofs / Task / TaskSwitchContext / tasks_test_access_functions.h
1 /*
2  * FreeRTOS memory safety proofs with CBMC.
3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without
8  * restriction, including without limitation the rights to use, copy,
9  * modify, merge, publish, distribute, sublicense, and/or sell copies
10  * of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  *
25  * http://aws.amazon.com/freertos
26  * http://www.FreeRTOS.org
27  */
28
29 #include "cbmc.h"
30
31 /*
32  * We allocate a TCB and set some members to basic values
33  */
34 TaskHandle_t xUnconstrainedTCB( UBaseType_t uxPriority )
35 {
36     TCB_t * pxTCB = pvPortMalloc( sizeof( TCB_t ) );
37
38     if( pxTCB == NULL )
39     {
40         return NULL;
41     }
42
43     /* uxPriority is set to a specific priority */
44     pxTCB->uxPriority = uxPriority;
45
46     vListInitialiseItem( &( pxTCB->xStateListItem ) );
47     vListInitialiseItem( &( pxTCB->xEventListItem ) );
48
49     listSET_LIST_ITEM_OWNER( &( pxTCB->xStateListItem ), pxTCB );
50     listSET_LIST_ITEM_OWNER( &( pxTCB->xEventListItem ), pxTCB );
51
52     if( nondet_bool() )
53     {
54         listSET_LIST_ITEM_VALUE( &( pxTCB->xStateListItem ), pxTCB->uxPriority );
55     }
56     else
57     {
58         listSET_LIST_ITEM_VALUE( &( pxTCB->xStateListItem ), portMAX_DELAY );
59     }
60
61     if( nondet_bool() )
62     {
63         listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxTCB->uxPriority );
64     }
65     else
66     {
67         listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), portMAX_DELAY );
68     }
69
70     return pxTCB;
71 }
72
73 /*
74  * We set the values of relevant global
75  * variables to nondeterministic values
76  */
77 void vSetGlobalVariables( void )
78 {
79     uxSchedulerSuspended = nondet_ubasetype();
80 }
81
82 /*
83  * We initialize and fill with one item each ready tasks list
84  * so that the assertion on line 175 (tasks.c) does not fail
85  */
86 BaseType_t xPrepareTaskLists( void )
87 {
88     TCB_t * pxTCB = NULL;
89
90     __CPROVER_assert_zero_allocation();
91
92     prvInitialiseTaskLists();
93
94     for( int i = 0; i < configMAX_PRIORITIES; ++i )
95     {
96         pxTCB = xUnconstrainedTCB( i );
97
98         if( pxTCB == NULL )
99         {
100             return pdFAIL;
101         }
102
103         vListInsert( &pxReadyTasksLists[ pxTCB->uxPriority ], &( pxTCB->xStateListItem ) );
104     }
105
106     listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &pxReadyTasksLists[ configMAX_PRIORITIES - 1 ] );
107
108     return pdPASS;
109 }