begriffs open source - cmsis-freertos/blob - Test/CBMC/proofs/Task/TaskPrioritySet/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( void )
  35 {
  36     TCB_t * pxTCB = pvPortMalloc( sizeof( TCB_t ) );
  37     uint8_t ucStaticAllocationFlag;
  38
  39     if( pxTCB == NULL )
  40     {
  41         return NULL;
  42     }
  43
  44     __CPROVER_assume( pxTCB->uxPriority < configMAX_PRIORITIES );
  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 initialise and fill the task lists so coverage is optimal.
  75  * This initialization is not guaranteed to be minimal, but it
  76  * is quite efficient and it serves the same purpose
  77  */
  78 BaseType_t xPrepareTaskLists( TaskHandle_t * xTask )
  79 {
  80     TCB_t * pxTCB = NULL;
  81
  82     __CPROVER_assert_zero_allocation();
  83
  84     prvInitialiseTaskLists();
  85
  86     pxTCB = xUnconstrainedTCB();
  87
  88     /* Needed for coverage: nondet insertion of task. */
  89     if( nondet_bool() )
  90     {
  91         TCB_t * pxOtherTCB;
  92         pxOtherTCB = xUnconstrainedTCB();
  93
  94         if( pxOtherTCB != NULL )
  95         {
  96             vListInsert( &pxReadyTasksLists[ pxOtherTCB->uxPriority ], &( pxOtherTCB->xStateListItem ) );
  97         }
  98     }
  99
 100     if( pxTCB != NULL )
 101     {
 102         /* Needed for coverage: nondeterministic insertion of task */
 103         if( nondet_bool() )
 104         {
 105             vListInsert( &pxReadyTasksLists[ pxTCB->uxPriority ], &( pxTCB->xStateListItem ) );
 106         }
 107     }
 108
 109     /* Note that `*xTask = NULL` can happen here, but this is fine -- `pxCurrentTCB` will be used instead */
 110     *xTask = pxTCB;
 111
 112     pxCurrentTCB = xUnconstrainedTCB();
 113
 114     if( pxCurrentTCB == NULL )
 115     {
 116         return pdFAIL;
 117     }
 118
 119     /* Needed for coverage: nondeterministic insertion of task */
 120     if( nondet_bool() )
 121     {
 122         vListInsert( &pxReadyTasksLists[ pxCurrentTCB->uxPriority ], &( pxCurrentTCB->xStateListItem ) );
 123
 124         /* Needed for coverage. */
 125         listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &pxReadyTasksLists[ pxCurrentTCB->uxPriority ] );
 126     }
 127
 128     return pdPASS;
 129 }