begriffs open source - cmsis-freertos/blob - Test/CBMC/proofs/Queue/QueueTakeMutexRecursive/QueueTakeMutexRecursive_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 "tasksStubs.h"
  32 #include "queue_datastructure.h"
  33 #include "cbmc.h"
  34
  35 QueueHandle_t xMutex;
  36
  37 void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut )
  38 {
  39     /* QueueSemaphoreTake might be blocked to wait for
  40      * another process to release a token to the semaphore.
  41      * This is currently not in the CBMC model. Anyhow,
  42      * vTaskInternalSetTimeOutState is set a timeout for
  43      * QueueSemaphoreTake operation. We use this to model a successful
  44      * release during wait time. */
  45     UBaseType_t bound;
  46
  47     __CPROVER_assume( ( bound >= 0 && xMutex->uxLength >= bound ) );
  48     xMutex->uxMessagesWaiting = bound;
  49 }
  50
  51 BaseType_t xTaskGetSchedulerState( void )
  52 {
  53     BaseType_t ret;
  54
  55     __CPROVER_assume( ret != taskSCHEDULER_SUSPENDED );
  56     return ret;
  57 }
  58
  59 void harness()
  60 {
  61     uint8_t ucQueueType;
  62
  63     xMutex = xQueueCreateMutex( ucQueueType );
  64     TickType_t xTicksToWait;
  65
  66     /* Init task stub to make sure that the QueueSemaphoreTake_BOUND - 1
  67      * loop iteration simulates a time out */
  68     vInitTaskCheckForTimeOut( 0, QueueSemaphoreTake_BOUND - 1 );
  69
  70     if( xMutex )
  71     {
  72         xMutex->cTxLock = PRV_UNLOCK_UNWINDING_BOUND - 1;
  73         xMutex->cRxLock = PRV_UNLOCK_UNWINDING_BOUND - 1;
  74         xMutex->uxMessagesWaiting = nondet_UBaseType_t();
  75         xQueueTakeMutexRecursive( xMutex, xTicksToWait );
  76     }
  77 }