begriffs open source - cmsis-freertos/blob - Test/VeriFast/include/proof/queuecontracts.h

   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 #ifndef QUEUECONTRACTS_H
  28 #define QUEUECONTRACTS_H
  29
  30 #include "queue.h"
  31
  32 void prvCopyDataFromQueue( Queue_t * const pxQueue,
  33                            void * const pvBuffer );
  34 /*@requires queue(pxQueue, ?Storage, ?N, ?M, ?W, ?R, ?K, ?is_locked, ?abs) &*& 0 < K &*& chars(pvBuffer, M, _);@*/
  35
  36 /*@ensures queue_after_prvCopyDataFromQueue(pxQueue, Storage, N, M, W, (R+1)%N, K, is_locked, abs) &*&
  37  *  chars(pvBuffer, M, head(abs));@*/
  38
  39 BaseType_t prvCopyDataToQueue( Queue_t * const pxQueue,
  40                                const void * pvItemToQueue,
  41                                const BaseType_t xPosition );
  42
  43 /*@requires queue(pxQueue, ?Storage, ?N, ?M, ?W, ?R, ?K, ?is_locked, ?abs) &*&
  44  *  (K < N || xPosition == queueOVERWRITE) &*&
  45  *  chars(pvItemToQueue, M, ?x) &*&
  46  *  (xPosition == queueSEND_TO_BACK || xPosition == queueSEND_TO_FRONT || (xPosition == queueOVERWRITE && N == 1));@*/
  47
  48 /*@ensures
  49  *  (xPosition == queueSEND_TO_BACK
  50  *      ? queue(pxQueue, Storage, N, M, (W+1)%N, R, (K+1), is_locked, append(abs, singleton(x)))
  51  *      : (xPosition == queueSEND_TO_FRONT
  52  *          ? (R == 0
  53  *              ? queue(pxQueue, Storage, N, M, W, (N-1), (K+1), is_locked, cons(x, abs))
  54  *              : queue(pxQueue, Storage, N, M, W, (R-1), (K+1), is_locked, cons(x, abs)))
  55  *          : xPosition == queueOVERWRITE &*& queue(pxQueue, Storage, N, M, W, R, 1, is_locked, singleton(x)))
  56  *  ) &*&
  57  *  chars(pvItemToQueue, M, x);@*/
  58
  59 BaseType_t prvIsQueueEmpty( Queue_t * pxQueue );
  60 /*@requires [1/2]queuehandle(pxQueue, ?N, ?M, ?is_isr) &*& is_isr == false;@*/
  61 /*@ensures [1/2]queuehandle(pxQueue, N, M, is_isr);@*/
  62
  63 BaseType_t prvIsQueueFull( Queue_t * pxQueue );
  64 /*@requires [1/2]queuehandle(pxQueue, ?N, ?M, ?is_isr) &*& is_isr == false;@*/
  65 /*@ensures [1/2]queuehandle(pxQueue, N, M, is_isr);@*/
  66
  67 #endif /* QUEUECONTRACTS_H */