begriffs open source - cmsis-freertos/blob - Test/VeriFast/queue/uxQueueMessagesWaiting.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 /* It may seem that the read of `pxQueue->uxMessagesWaiting` is required to be
  30  * contained in a critical region to be thread-safe. However, it is impossible for
  31  * this read to be involved in a data race due to the atomicity mechanism used by
  32  * tasks and ISRs: masking and enabling interrupts. If we assume (1) a
  33  * uniprocessor system and (2) that higher priority ISRs never call queue API
  34  * functions then masking interrupts ensures *strong isolation* meaning critical
  35  * regions protected by interrupt masking/enabling are isolated from other
  36  * critical regions and code outside of critical regions. */
  37
  38 UBaseType_t uxQueueMessagesWaitingFromISR( const QueueHandle_t xQueue )
  39 /*@requires queue(xQueue, ?Storage, ?N, ?M, ?W, ?R, ?K, ?is_locked, ?abs);@*/
  40 /*@ensures queue(xQueue, Storage, N, M, W, R, K, is_locked, abs) &*& result == K;@*/
  41 {
  42     UBaseType_t uxReturn;
  43
  44     #ifdef VERIFAST /*< const pointer declaration */
  45         Queue_t * pxQueue = xQueue;
  46     #else
  47         Queue_t * const pxQueue = xQueue;
  48     #endif
  49
  50     configASSERT( pxQueue );
  51     uxReturn = pxQueue->uxMessagesWaiting;
  52
  53     return uxReturn;
  54 }
  55
  56 UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue )
  57 /*@requires [1/2]queuehandle(xQueue, ?N, ?M, ?is_isr) &*& is_isr == false;@*/
  58 /*@ensures [1/2]queuehandle(xQueue, N, M, is_isr);@*/
  59 {
  60     UBaseType_t uxReturn;
  61
  62     configASSERT( xQueue );
  63
  64     taskENTER_CRITICAL();
  65     {
  66         /*@assert queue(xQueue, ?Storage, N, M, ?W, ?R, ?K, ?is_locked, ?abs);@*/
  67         uxReturn = ( ( Queue_t * ) xQueue )->uxMessagesWaiting;
  68         /*@close queue(xQueue, Storage, N, M, W, R, K, is_locked, abs);@*/
  69     }
  70     taskEXIT_CRITICAL();
  71
  72     return uxReturn;
  73 } /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */