begriffs open source - cmsis-freertos/blob - Test/VeriFast/queue/prvLockQueue.c

   1 /*
   2  * FreeRTOS V202111.00
   3  * Copyright (C) Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * https://www.FreeRTOS.org
  23  * https://github.com/FreeRTOS
  24  *
  25  */
  26
  27 #include "proof/queue.h"
  28
  29 /* In this case we cannot wrap the macro in a function call to give a function
  30  * contract because we require annotations within the macro body, which is not
  31  * supported by VeriFast */
  32 #define prvLockQueue( pxQueue )                            \
  33     taskENTER_CRITICAL();                                  \
  34     {                                                      \
  35         if( ( pxQueue )->cRxLock == queueUNLOCKED )        \
  36         {                                                  \
  37             ( pxQueue )->cRxLock = queueLOCKED_UNMODIFIED; \
  38         }                                                  \
  39         if( ( pxQueue )->cTxLock == queueUNLOCKED )        \
  40         {                                                  \
  41             ( pxQueue )->cTxLock = queueLOCKED_UNMODIFIED; \
  42         }                                                  \
  43     }                                                      \
  44     taskEXIT_CRITICAL()
  45
  46 void wrapper_prvLockQueue( QueueHandle_t xQueue )
  47
  48 /*@requires [1/2]queuehandle(xQueue, ?N, ?M, ?is_isr) &*& is_isr == false &*&
  49  *  [1/2]queuelock(xQueue);@*/
  50
  51 /*@ensures [1/2]queuehandle(xQueue, N, M, is_isr) &*&
  52  *  [1/2]xQueue->locked |-> ?m &*&
  53  *  mutex_held(m, queue_locked_invariant(xQueue), currentThread, 1/2) &*&
  54  *  queue_locked_invariant(xQueue)();@*/
  55 {
  56     taskENTER_CRITICAL();
  57     /*@open queue(xQueue, ?Storage, N, M, ?W, ?R, ?K, ?is_locked, ?abs);@*/
  58     {
  59         if( ( xQueue )->cRxLock == queueUNLOCKED )
  60         {
  61             ( xQueue )->cRxLock = queueLOCKED_UNMODIFIED;
  62         }
  63
  64         if( ( xQueue )->cTxLock == queueUNLOCKED )
  65         {
  66             ( xQueue )->cTxLock = queueLOCKED_UNMODIFIED;
  67         }
  68     }
  69     /*@close queue(xQueue, Storage, N, M, W, R, K, true, abs);@*/
  70     taskEXIT_CRITICAL();
  71     #ifdef VERIFAST /*< ghost action */
  72         mutex_acquire( xQueue->locked );
  73     #endif
  74 }