begriffs open source - cmsis-freertos/blob - Test/CBMC/proofs/Queue/QueueReceive/QueueReceive_harness.c

   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 "FreeRTOS.h"
  30 #include "queue.h"
  31 #include "queue_init.h"
  32 #include "tasksStubs.h"
  33 #include "cbmc.h"
  34
  35 /* prvUnlockQueue is going to decrement this value to 0 in the loop.
  36 * We need a bound for the loop. Using 4 has a reasonable performance resulting
  37 * in 3 unwinding iterations of the loop. The loop is mostly modifying a
  38 * data structure in task.c that is not in the scope of the proof. */
  39 #ifndef LOCK_BOUND
  40     #define LOCK_BOUND    4
  41 #endif
  42
  43 /* This code checks for time outs. This value is used to bound the time out
  44  * wait period. The stub function xTaskCheckForTimeOut used to model
  45  * this wait time will be bounded to this define. */
  46 #ifndef QUEUE_RECEIVE_BOUND
  47     #define QUEUE_RECEIVE_BOUND    4
  48 #endif
  49
  50 /* If the item size is not bounded, the proof does not finish in a reasonable
  51  * time due to the involved memcpy commands. */
  52 #ifndef MAX_ITEM_SIZE
  53     #define MAX_ITEM_SIZE    20
  54 #endif
  55
  56 QueueHandle_t xQueue;
  57
  58 /* This method is used to model side effects of concurrency.
  59  * The initialization of pxTimeOut is not relevant for this harness. */
  60 void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut )
  61 {
  62     __CPROVER_assert( __CPROVER_w_ok( &( pxTimeOut->xOverflowCount ), sizeof( BaseType_t ) ), "pxTimeOut should be a valid pointer and xOverflowCount writable" );
  63     __CPROVER_assert( __CPROVER_w_ok( &( pxTimeOut->xTimeOnEntering ), sizeof( TickType_t ) ), "pxTimeOut should be a valid pointer and xTimeOnEntering writable" );
  64     xQueue->uxMessagesWaiting = nondet_BaseType_t();
  65 }
  66
  67 void harness()
  68 {
  69     vInitTaskCheckForTimeOut( 0, QUEUE_RECEIVE_BOUND - 1 );
  70
  71     xQueue = xUnconstrainedQueueBoundedItemSize( MAX_ITEM_SIZE );
  72
  73
  74     TickType_t xTicksToWait;
  75
  76     if( xState == taskSCHEDULER_SUSPENDED )
  77     {
  78         xTicksToWait = 0;
  79     }
  80
  81     if( xQueue )
  82     {
  83         xQueue->cTxLock = LOCK_BOUND - 1;
  84         xQueue->cRxLock = LOCK_BOUND - 1;
  85
  86         void * pvBuffer = pvPortMalloc( xQueue->uxItemSize );
  87
  88         if( !pvBuffer )
  89         {
  90             xQueue->uxItemSize = 0;
  91         }
  92
  93         xQueueReceive( xQueue, pvBuffer, xTicksToWait );
  94     }
  95 }