summaryrefslogtreecommitdiffstats
path: root/testsuites/validation/tc-message-flush-pending.c
blob: 48ade108d0d75c3835c9f70dc19f1a76e2cdf047 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RtemsMessageReqFlushPending
 */

/*
 * Copyright (C) 2021 embedded brains GmbH & Co. KG
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <rtems.h>

#include "tx-support.h"

#include <rtems/test.h>

/**
 * @defgroup RtemsMessageReqFlushPending spec:/rtems/message/req/flush-pending
 *
 * @ingroup TestsuitesValidationNoClock0
 *
 * @{
 */

typedef enum {
  RtemsMessageReqFlushPending_Pre_Count_Valid,
  RtemsMessageReqFlushPending_Pre_Count_Null,
  RtemsMessageReqFlushPending_Pre_Count_NA
} RtemsMessageReqFlushPending_Pre_Count;

typedef enum {
  RtemsMessageReqFlushPending_Pre_Id_Valid,
  RtemsMessageReqFlushPending_Pre_Id_Invalid,
  RtemsMessageReqFlushPending_Pre_Id_NA
} RtemsMessageReqFlushPending_Pre_Id;

typedef enum {
  RtemsMessageReqFlushPending_Pre_MsgQueue_Empty,
  RtemsMessageReqFlushPending_Pre_MsgQueue_Several,
  RtemsMessageReqFlushPending_Pre_MsgQueue_NA
} RtemsMessageReqFlushPending_Pre_MsgQueue;

typedef enum {
  RtemsMessageReqFlushPending_Pre_Receivers_Waiting,
  RtemsMessageReqFlushPending_Pre_Receivers_None,
  RtemsMessageReqFlushPending_Pre_Receivers_NA
} RtemsMessageReqFlushPending_Pre_Receivers;

typedef enum {
  RtemsMessageReqFlushPending_Pre_Directive_Flush,
  RtemsMessageReqFlushPending_Pre_Directive_Pending,
  RtemsMessageReqFlushPending_Pre_Directive_NA
} RtemsMessageReqFlushPending_Pre_Directive;

typedef enum {
  RtemsMessageReqFlushPending_Pre_Storage_Nop,
  RtemsMessageReqFlushPending_Pre_Storage_NA
} RtemsMessageReqFlushPending_Pre_Storage;

typedef enum {
  RtemsMessageReqFlushPending_Post_Status_Ok,
  RtemsMessageReqFlushPending_Post_Status_InvId,
  RtemsMessageReqFlushPending_Post_Status_InvAddr,
  RtemsMessageReqFlushPending_Post_Status_NA
} RtemsMessageReqFlushPending_Post_Status;

typedef enum {
  RtemsMessageReqFlushPending_Post_Count_Zero,
  RtemsMessageReqFlushPending_Post_Count_Set,
  RtemsMessageReqFlushPending_Post_Count_Nop,
  RtemsMessageReqFlushPending_Post_Count_NA
} RtemsMessageReqFlushPending_Post_Count;

typedef enum {
  RtemsMessageReqFlushPending_Post_MsgQueue_Empty,
  RtemsMessageReqFlushPending_Post_MsgQueue_Nop,
  RtemsMessageReqFlushPending_Post_MsgQueue_NA
} RtemsMessageReqFlushPending_Post_MsgQueue;

typedef enum {
  RtemsMessageReqFlushPending_Post_Receivers_Nop,
  RtemsMessageReqFlushPending_Post_Receivers_NA
} RtemsMessageReqFlushPending_Post_Receivers;

typedef struct {
  uint16_t Skip : 1;
  uint16_t Pre_Count_NA : 1;
  uint16_t Pre_Id_NA : 1;
  uint16_t Pre_MsgQueue_NA : 1;
  uint16_t Pre_Receivers_NA : 1;
  uint16_t Pre_Directive_NA : 1;
  uint16_t Pre_Storage_NA : 1;
  uint16_t Post_Status : 2;
  uint16_t Post_Count : 2;
  uint16_t Post_MsgQueue : 2;
  uint16_t Post_Receivers : 1;
} RtemsMessageReqFlushPending_Entry;

#define MAXIMUM_PENDING_MESSAGES 3
#define MAXIMUM_MESSAGE_SIZE     5
#define NUMBER_OF_WORKERS        3

/**
 * @brief Test context for spec:/rtems/message/req/flush-pending test case.
 */
typedef struct {
  /**
   * @brief This member contains a valid ID of a message queue.
   */
  rtems_id message_queue_id;

  /**
   * @brief This member is used as storage area for the message queue.
   */
  RTEMS_MESSAGE_QUEUE_BUFFER( MAXIMUM_MESSAGE_SIZE )
    storage_area[ MAXIMUM_PENDING_MESSAGES ];

  /**
   * @brief This member contains the returned status codes of the receivers.
   */
  rtems_status_code receive_status[ NUMBER_OF_WORKERS ];

  /**
   * @brief This member specifies the directive to be called as action.
   *
   * This is either rtems_message_queue_flush() or
   * rtems_message_queue_get_number_pending().
   */
  rtems_status_code (*action)( rtems_id id, uint32_t *count );

  /**
   * @brief This member specifies the ``id`` parameter of the action.
   */
  rtems_id id_param;

  /**
   * @brief This member specifies the ``count`` parameter of the action.
   */
  uint32_t *count_param;

  /**
   * @brief This member contains the returned status code of the action.
   */
  rtems_status_code status;

  /**
   * @brief This member contains the value returned in parameter ``count`` of
   *   the action.
   */
  uint32_t count;

  /**
   * @brief This member contains the task identifiers of the worker tasks.
   */
  rtems_id worker_id[ NUMBER_OF_WORKERS ];

  /**
   * @brief This member contains a pointer to a function which is executed to
   *   check that the action has not changed the content of the message queue.
   */
  void (*check_msgq_unchanged)( void *ctx_in );

  struct {
    /**
     * @brief This member defines the pre-condition states for the next action.
     */
    size_t pcs[ 6 ];

    /**
     * @brief If this member is true, then the test action loop is executed.
     */
    bool in_action_loop;

    /**
     * @brief This member contains the next transition map index.
     */
    size_t index;

    /**
     * @brief This member contains the current transition map entry.
     */
    RtemsMessageReqFlushPending_Entry entry;

    /**
     * @brief If this member is true, then the current transition variant
     *   should be skipped.
     */
    bool skip;
  } Map;
} RtemsMessageReqFlushPending_Context;

static RtemsMessageReqFlushPending_Context
  RtemsMessageReqFlushPending_Instance;

static const char * const RtemsMessageReqFlushPending_PreDesc_Count[] = {
  "Valid",
  "Null",
  "NA"
};

static const char * const RtemsMessageReqFlushPending_PreDesc_Id[] = {
  "Valid",
  "Invalid",
  "NA"
};

static const char * const RtemsMessageReqFlushPending_PreDesc_MsgQueue[] = {
  "Empty",
  "Several",
  "NA"
};

static const char * const RtemsMessageReqFlushPending_PreDesc_Receivers[] = {
  "Waiting",
  "None",
  "NA"
};

static const char * const RtemsMessageReqFlushPending_PreDesc_Directive[] = {
  "Flush",
  "Pending",
  "NA"
};

static const char * const RtemsMessageReqFlushPending_PreDesc_Storage[] = {
  "Nop",
  "NA"
};

static const char * const * const RtemsMessageReqFlushPending_PreDesc[] = {
  RtemsMessageReqFlushPending_PreDesc_Count,
  RtemsMessageReqFlushPending_PreDesc_Id,
  RtemsMessageReqFlushPending_PreDesc_MsgQueue,
  RtemsMessageReqFlushPending_PreDesc_Receivers,
  RtemsMessageReqFlushPending_PreDesc_Directive,
  RtemsMessageReqFlushPending_PreDesc_Storage,
  NULL
};

typedef RtemsMessageReqFlushPending_Context Context;
static const uint32_t NUMBER_OF_PENDING_MESSAGES = 2;
static const rtems_interval TIMEOUT_TICKS = 1;
static const rtems_event_set EVENT_RECEIVE = RTEMS_EVENT_17;
static const uint8_t queued_message[] = { 200, 201, 202 };

static void Receive( Context *ctx, size_t worker_index )
{
  size_t size;
  uint8_t buffer[ MAXIMUM_MESSAGE_SIZE ];

  ctx->receive_status[worker_index] = rtems_message_queue_receive(
    ctx->message_queue_id,
    buffer,
    &size,
    RTEMS_WAIT,
    TIMEOUT_TICKS
  );
}

static void WorkerTask( rtems_task_argument argument )
{
  static size_t worker_number = 0;
  size_t worker_index = worker_number++;
  Context *ctx = (Context *) argument;

  while ( true ) {
    ReceiveAnyEvents();
    Receive( ctx, worker_index );
  }
}

static void CheckForNoMessage(
  Context *ctx,
  rtems_status_code status,
  uint8_t *message_buffer,
  size_t message_size
)
{
  (void) ctx;
  (void) message_buffer;
  (void) message_size;
  T_rsc( status, RTEMS_UNSATISFIED  );
}

static void CheckForQueuedMessage(
  Context *ctx,
  rtems_status_code status,
  uint8_t *message_buffer,
  size_t message_size
)
{
  (void) ctx;
  T_rsc_success( status );
  T_eq_u32( message_size, sizeof( queued_message ) );
  T_eq_mem( message_buffer, queued_message, sizeof( queued_message ) );
}

static void PopMessage(
  Context *ctx,
  void (*check_fn)(
    Context *ctx,
    rtems_status_code status,
    uint8_t *message_buffer,
    size_t message_size
  )
)
{
  rtems_status_code status;
  uint8_t message_buffer[ MAXIMUM_MESSAGE_SIZE ];
  size_t message_size;

  status = rtems_message_queue_receive(
    ctx->message_queue_id,
    &message_buffer,
    &message_size,
    RTEMS_LOCAL | RTEMS_NO_WAIT,
    RTEMS_NO_TIMEOUT
  );

 check_fn( ctx, status, message_buffer, message_size );
}

static void CheckForNoMessageInQueue( void *ctx_in )
{
  Context *ctx = ctx_in;
  PopMessage( ctx, CheckForNoMessage );
}

static void CheckForSeveralMessagesInQueue( void *ctx_in )
{
  Context *ctx = ctx_in;
  uint32_t i;
  for ( i = 0; i < NUMBER_OF_PENDING_MESSAGES; ++i ) {
    PopMessage( ctx, CheckForQueuedMessage );
  }
  PopMessage( ctx, CheckForNoMessage );
}

static void SendMsg( Context *ctx )
{
  rtems_status_code status;

  status = rtems_message_queue_send(
    ctx->message_queue_id,
    queued_message,
    sizeof( queued_message )
  );
  T_rsc_success( status );
}

static void RtemsMessageReqFlushPending_Pre_Count_Prepare(
  RtemsMessageReqFlushPending_Context  *ctx,
  RtemsMessageReqFlushPending_Pre_Count state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Pre_Count_Valid: {
      /*
       * While the ``count`` parameter references an ``uint32_t`` object.
       */
      ctx->count_param = &ctx->count;
      break;
    }

    case RtemsMessageReqFlushPending_Pre_Count_Null: {
      /*
       * While the ``count`` parameter is NULL.
       */
      ctx->count_param = NULL;
      break;
    }

    case RtemsMessageReqFlushPending_Pre_Count_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Pre_Id_Prepare(
  RtemsMessageReqFlushPending_Context *ctx,
  RtemsMessageReqFlushPending_Pre_Id   state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Pre_Id_Valid: {
      /*
       * While the ``id`` parameter is valid.
       */
      ctx->id_param = ctx->message_queue_id;
      break;
    }

    case RtemsMessageReqFlushPending_Pre_Id_Invalid: {
      /*
       * While the ``id`` parameter is invalid.
       */
      ctx->id_param = RTEMS_ID_NONE;
      break;
    }

    case RtemsMessageReqFlushPending_Pre_Id_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Pre_MsgQueue_Prepare(
  RtemsMessageReqFlushPending_Context     *ctx,
  RtemsMessageReqFlushPending_Pre_MsgQueue state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Pre_MsgQueue_Empty: {
      /*
       * While there is no message in the message queue.
       */
      /* Message queue is already empty. */
      ctx->check_msgq_unchanged = CheckForNoMessageInQueue;
      break;
    }

    case RtemsMessageReqFlushPending_Pre_MsgQueue_Several: {
      /*
       * While there are messages in the message queue.
       */
      uint32_t i;
      for ( i = 0; i < NUMBER_OF_PENDING_MESSAGES; ++i ) {
        SendMsg( ctx );
      }
      ctx->check_msgq_unchanged = CheckForSeveralMessagesInQueue;
      break;
    }

    case RtemsMessageReqFlushPending_Pre_MsgQueue_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Pre_Receivers_Prepare(
  RtemsMessageReqFlushPending_Context      *ctx,
  RtemsMessageReqFlushPending_Pre_Receivers state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Pre_Receivers_Waiting: {
      /*
       * While one or more receivers are waiting to receive a message.
       */
      size_t i;
      for ( i = 0; i < NUMBER_OF_WORKERS; ++i ) {
        SendEvents( ctx->worker_id[i], EVENT_RECEIVE );
      }
      break;
    }

    case RtemsMessageReqFlushPending_Pre_Receivers_None: {
      /*
       * While no receiver is waiting to receive a message.
       */
      /* There is already no receiver waiting. */
      break;
    }

    case RtemsMessageReqFlushPending_Pre_Receivers_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Pre_Directive_Prepare(
  RtemsMessageReqFlushPending_Context      *ctx,
  RtemsMessageReqFlushPending_Pre_Directive state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Pre_Directive_Flush: {
      /*
       * While the directive rtems_message_queue_flush() is called.
       */
      ctx->action = rtems_message_queue_flush;
      break;
    }

    case RtemsMessageReqFlushPending_Pre_Directive_Pending: {
      /*
       * While the directive rtems_message_queue_get_number_pending() is
       * called.
       */
      ctx->action = rtems_message_queue_get_number_pending;
      break;
    }

    case RtemsMessageReqFlushPending_Pre_Directive_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Pre_Storage_Prepare(
  RtemsMessageReqFlushPending_Context    *ctx,
  RtemsMessageReqFlushPending_Pre_Storage state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Pre_Storage_Nop: {
      /*
       * While the memory area to which a pointer is provided as member
       * storage_area of type rtems_message_queue_config when the message queue
       * is constructed by rtems_message_queue_construct() is altered only by
       * the RTEMS operating system.
       */
      /* Only a requirement text. */
      break;
    }

    case RtemsMessageReqFlushPending_Pre_Storage_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Post_Status_Check(
  RtemsMessageReqFlushPending_Context    *ctx,
  RtemsMessageReqFlushPending_Post_Status state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Post_Status_Ok: {
      /*
       * The return status of the called directive (rtems_message_queue_flush()
       * or rtems_message_queue_get_number_pending()) shall be RTEMS_SUCCESSFUL
       */
      T_rsc_success( ctx->status );
      break;
    }

    case RtemsMessageReqFlushPending_Post_Status_InvId: {
      /*
       * The return status of the called directive (rtems_message_queue_flush()
       * or rtems_message_queue_get_number_pending()) shall be
       * RTEMS_INVALID_ID.
       */
      T_rsc( ctx->status, RTEMS_INVALID_ID );
      break;
    }

    case RtemsMessageReqFlushPending_Post_Status_InvAddr: {
      /*
       * The return status of the called directive (rtems_message_queue_flush()
       * or rtems_message_queue_get_number_pending()) shall be
       * RTEMS_INVALID_ADDRESS.
       */
      T_rsc( ctx->status, RTEMS_INVALID_ADDRESS );
      break;
    }

    case RtemsMessageReqFlushPending_Post_Status_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Post_Count_Check(
  RtemsMessageReqFlushPending_Context   *ctx,
  RtemsMessageReqFlushPending_Post_Count state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Post_Count_Zero: {
      /*
       * The value of the object referenced by the ``count`` parameter shall be
       * 0 after the return of the rtems_message_queue_flush() or
       * rtems_message_queue_get_number_pending() call.
       */
      T_eq_u32( ctx->count, 0 );
      break;
    }

    case RtemsMessageReqFlushPending_Post_Count_Set: {
      /*
       * The rtems_message_queue_get_number_pending() directive shall set the
       * value of the object referenced by the ``count`` parameter to the
       * number of messages present in the message queue at a point in time
       * during the single execution of the
       * rtems_message_queue_get_number_pending() directive.
       *
       * The rtems_message_queue_flush() directive shall set the value of the
       * object referenced by the ``count`` parameter to the number of messages
       * it removed from the message queue during the single execution of the
       * rtems_message_queue_flush() directive.
       */
      T_eq_u32( ctx->count, NUMBER_OF_PENDING_MESSAGES );
      break;
    }

    case RtemsMessageReqFlushPending_Post_Count_Nop: {
      /*
       * The value of the object referenced by the ``count`` parameter in past
       * call to rtems_message_queue_flush() or
       * rtems_message_queue_get_number_pending() shall not be accessed by the
       * rtems_message_queue_flush() or
       * rtems_message_queue_get_number_pending() call (see also Nop).
       */
      T_eq_u32( ctx->count, UINT8_MAX );
      break;
    }

    case RtemsMessageReqFlushPending_Post_Count_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Post_MsgQueue_Check(
  RtemsMessageReqFlushPending_Context      *ctx,
  RtemsMessageReqFlushPending_Post_MsgQueue state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Post_MsgQueue_Empty: {
      /*
       * The message queue shall contain no messages after the last call to
       * ``id``.
       */
      PopMessage( ctx, CheckForNoMessage );
      break;
    }

    case RtemsMessageReqFlushPending_Post_MsgQueue_Nop: {
      /*
       * Objects referenced by the ``id`` parameter in the past call to
       * rtems_message_queue_flush() or
       * rtems_message_queue_get_number_pending() shall not be changed by that
       * call (see also Nop).
       */
      ctx->check_msgq_unchanged( ctx );
      break;
    }

    case RtemsMessageReqFlushPending_Post_MsgQueue_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Post_Receivers_Check(
  RtemsMessageReqFlushPending_Context       *ctx,
  RtemsMessageReqFlushPending_Post_Receivers state
)
{
  switch ( state ) {
    case RtemsMessageReqFlushPending_Post_Receivers_Nop: {
      /*
       * The receivers waiting for a message at the message queue shall not be
       * affected by the call to the rtems_message_queue_flush() or
       * rtems_message_queue_get_number_pending() directive.
       */
      size_t i;
      for ( i = 0; i < NUMBER_OF_WORKERS; ++i ) {
        T_rsc( ctx->receive_status[i], RTEMS_TIMEOUT );
      }
      break;
    }

    case RtemsMessageReqFlushPending_Post_Receivers_NA:
      break;
  }
}

static void RtemsMessageReqFlushPending_Setup(
  RtemsMessageReqFlushPending_Context *ctx
)
{
  size_t i;
  SetSelfPriority( PRIO_NORMAL );

  for ( i = 0; i < NUMBER_OF_WORKERS; ++i ) {
    ctx->worker_id[i] = CreateTask( "WORK", PRIO_HIGH );
    StartTask( ctx->worker_id[i], WorkerTask, ctx );
  }
}

static void RtemsMessageReqFlushPending_Setup_Wrap( void *arg )
{
  RtemsMessageReqFlushPending_Context *ctx;

  ctx = arg;
  ctx->Map.in_action_loop = false;
  RtemsMessageReqFlushPending_Setup( ctx );
}

static void RtemsMessageReqFlushPending_Teardown(
  RtemsMessageReqFlushPending_Context *ctx
)
{
  size_t i;

  for ( i = 0; i < NUMBER_OF_WORKERS; ++i ) {
    DeleteTask( ctx->worker_id[i] );
  }
  RestoreRunnerPriority();
}

static void RtemsMessageReqFlushPending_Teardown_Wrap( void *arg )
{
  RtemsMessageReqFlushPending_Context *ctx;

  ctx = arg;
  ctx->Map.in_action_loop = false;
  RtemsMessageReqFlushPending_Teardown( ctx );
}

static void RtemsMessageReqFlushPending_Prepare(
  RtemsMessageReqFlushPending_Context *ctx
)
{
  rtems_status_code status;

  rtems_message_queue_config config = {
    .name                     = rtems_build_name( 'M', 'S', 'G', 'Q' ),
    .maximum_pending_messages = MAXIMUM_PENDING_MESSAGES,
    .maximum_message_size     = MAXIMUM_MESSAGE_SIZE,
    .storage_area             = ctx->storage_area,
    .storage_size             = sizeof( ctx->storage_area ),
    .storage_free             = NULL,
    .attributes               = RTEMS_DEFAULT_ATTRIBUTES
  };

  status = rtems_message_queue_construct(
    &config,
    &ctx->message_queue_id
  );
  T_rsc_success( status );

  ctx->count = UINT8_MAX;
}

static void RtemsMessageReqFlushPending_Action(
  RtemsMessageReqFlushPending_Context *ctx
)
{
  ctx->status = (ctx->action)(
    ctx->id_param,
    ctx->count_param
  );

  FinalClockTick();
}

static void RtemsMessageReqFlushPending_Cleanup(
  RtemsMessageReqFlushPending_Context *ctx
)
{
  T_rsc_success( rtems_message_queue_delete( ctx->message_queue_id ) );
}

static const RtemsMessageReqFlushPending_Entry
RtemsMessageReqFlushPending_Entries[] = {
  { 1, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_NA,
    RtemsMessageReqFlushPending_Post_Count_NA,
    RtemsMessageReqFlushPending_Post_MsgQueue_NA,
    RtemsMessageReqFlushPending_Post_Receivers_NA },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_InvAddr,
    RtemsMessageReqFlushPending_Post_Count_Nop,
    RtemsMessageReqFlushPending_Post_MsgQueue_Nop,
    RtemsMessageReqFlushPending_Post_Receivers_NA },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_InvId,
    RtemsMessageReqFlushPending_Post_Count_Nop,
    RtemsMessageReqFlushPending_Post_MsgQueue_Nop,
    RtemsMessageReqFlushPending_Post_Receivers_NA },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_InvAddr,
    RtemsMessageReqFlushPending_Post_Count_Nop,
    RtemsMessageReqFlushPending_Post_MsgQueue_Nop,
    RtemsMessageReqFlushPending_Post_Receivers_Nop },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_InvId,
    RtemsMessageReqFlushPending_Post_Count_Nop,
    RtemsMessageReqFlushPending_Post_MsgQueue_Nop,
    RtemsMessageReqFlushPending_Post_Receivers_Nop },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_Ok,
    RtemsMessageReqFlushPending_Post_Count_Zero,
    RtemsMessageReqFlushPending_Post_MsgQueue_Empty,
    RtemsMessageReqFlushPending_Post_Receivers_Nop },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_Ok,
    RtemsMessageReqFlushPending_Post_Count_Zero,
    RtemsMessageReqFlushPending_Post_MsgQueue_Nop,
    RtemsMessageReqFlushPending_Post_Receivers_Nop },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_Ok,
    RtemsMessageReqFlushPending_Post_Count_Zero,
    RtemsMessageReqFlushPending_Post_MsgQueue_Empty,
    RtemsMessageReqFlushPending_Post_Receivers_NA },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_Ok,
    RtemsMessageReqFlushPending_Post_Count_Zero,
    RtemsMessageReqFlushPending_Post_MsgQueue_Nop,
    RtemsMessageReqFlushPending_Post_Receivers_NA },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_Ok,
    RtemsMessageReqFlushPending_Post_Count_Set,
    RtemsMessageReqFlushPending_Post_MsgQueue_Empty,
    RtemsMessageReqFlushPending_Post_Receivers_NA },
  { 0, 0, 0, 0, 0, 0, 0, RtemsMessageReqFlushPending_Post_Status_Ok,
    RtemsMessageReqFlushPending_Post_Count_Set,
    RtemsMessageReqFlushPending_Post_MsgQueue_Nop,
    RtemsMessageReqFlushPending_Post_Receivers_NA }
};

static const uint8_t
RtemsMessageReqFlushPending_Map[] = {
  5, 6, 7, 8, 0, 0, 9, 10, 4, 4, 2, 2, 0, 0, 2, 2, 3, 3, 1, 1, 0, 0, 1, 1, 3,
  3, 1, 1, 0, 0, 1, 1
};

static size_t RtemsMessageReqFlushPending_Scope(
  void  *arg,
  char  *buf,
  size_t n
)
{
  RtemsMessageReqFlushPending_Context *ctx;

  ctx = arg;

  if ( ctx->Map.in_action_loop ) {
    return T_get_scope(
      RtemsMessageReqFlushPending_PreDesc,
      buf,
      n,
      ctx->Map.pcs
    );
  }

  return 0;
}

static T_fixture RtemsMessageReqFlushPending_Fixture = {
  .setup = RtemsMessageReqFlushPending_Setup_Wrap,
  .stop = NULL,
  .teardown = RtemsMessageReqFlushPending_Teardown_Wrap,
  .scope = RtemsMessageReqFlushPending_Scope,
  .initial_context = &RtemsMessageReqFlushPending_Instance
};

static inline RtemsMessageReqFlushPending_Entry
RtemsMessageReqFlushPending_PopEntry(
  RtemsMessageReqFlushPending_Context *ctx
)
{
  size_t index;

  index = ctx->Map.index;
  ctx->Map.index = index + 1;
  return RtemsMessageReqFlushPending_Entries[
    RtemsMessageReqFlushPending_Map[ index ]
  ];
}

static void RtemsMessageReqFlushPending_TestVariant(
  RtemsMessageReqFlushPending_Context *ctx
)
{
  RtemsMessageReqFlushPending_Pre_Count_Prepare( ctx, ctx->Map.pcs[ 0 ] );
  RtemsMessageReqFlushPending_Pre_Id_Prepare( ctx, ctx->Map.pcs[ 1 ] );
  RtemsMessageReqFlushPending_Pre_MsgQueue_Prepare( ctx, ctx->Map.pcs[ 2 ] );
  RtemsMessageReqFlushPending_Pre_Receivers_Prepare( ctx, ctx->Map.pcs[ 3 ] );
  RtemsMessageReqFlushPending_Pre_Directive_Prepare( ctx, ctx->Map.pcs[ 4 ] );
  RtemsMessageReqFlushPending_Pre_Storage_Prepare( ctx, ctx->Map.pcs[ 5 ] );
  RtemsMessageReqFlushPending_Action( ctx );
  RtemsMessageReqFlushPending_Post_Status_Check(
    ctx,
    ctx->Map.entry.Post_Status
  );
  RtemsMessageReqFlushPending_Post_Count_Check(
    ctx,
    ctx->Map.entry.Post_Count
  );
  RtemsMessageReqFlushPending_Post_MsgQueue_Check(
    ctx,
    ctx->Map.entry.Post_MsgQueue
  );
  RtemsMessageReqFlushPending_Post_Receivers_Check(
    ctx,
    ctx->Map.entry.Post_Receivers
  );
}

/**
 * @fn void T_case_body_RtemsMessageReqFlushPending( void )
 */
T_TEST_CASE_FIXTURE(
  RtemsMessageReqFlushPending,
  &RtemsMessageReqFlushPending_Fixture
)
{
  RtemsMessageReqFlushPending_Context *ctx;

  ctx = T_fixture_context();
  ctx->Map.in_action_loop = true;
  ctx->Map.index = 0;

  for (
    ctx->Map.pcs[ 0 ] = RtemsMessageReqFlushPending_Pre_Count_Valid;
    ctx->Map.pcs[ 0 ] < RtemsMessageReqFlushPending_Pre_Count_NA;
    ++ctx->Map.pcs[ 0 ]
  ) {
    for (
      ctx->Map.pcs[ 1 ] = RtemsMessageReqFlushPending_Pre_Id_Valid;
      ctx->Map.pcs[ 1 ] < RtemsMessageReqFlushPending_Pre_Id_NA;
      ++ctx->Map.pcs[ 1 ]
    ) {
      for (
        ctx->Map.pcs[ 2 ] = RtemsMessageReqFlushPending_Pre_MsgQueue_Empty;
        ctx->Map.pcs[ 2 ] < RtemsMessageReqFlushPending_Pre_MsgQueue_NA;
        ++ctx->Map.pcs[ 2 ]
      ) {
        for (
          ctx->Map.pcs[ 3 ] = RtemsMessageReqFlushPending_Pre_Receivers_Waiting;
          ctx->Map.pcs[ 3 ] < RtemsMessageReqFlushPending_Pre_Receivers_NA;
          ++ctx->Map.pcs[ 3 ]
        ) {
          for (
            ctx->Map.pcs[ 4 ] = RtemsMessageReqFlushPending_Pre_Directive_Flush;
            ctx->Map.pcs[ 4 ] < RtemsMessageReqFlushPending_Pre_Directive_NA;
            ++ctx->Map.pcs[ 4 ]
          ) {
            for (
              ctx->Map.pcs[ 5 ] = RtemsMessageReqFlushPending_Pre_Storage_Nop;
              ctx->Map.pcs[ 5 ] < RtemsMessageReqFlushPending_Pre_Storage_NA;
              ++ctx->Map.pcs[ 5 ]
            ) {
              ctx->Map.entry = RtemsMessageReqFlushPending_PopEntry( ctx );

              if ( ctx->Map.entry.Skip ) {
                continue;
              }

              RtemsMessageReqFlushPending_Prepare( ctx );
              RtemsMessageReqFlushPending_TestVariant( ctx );
              RtemsMessageReqFlushPending_Cleanup( ctx );
            }
          }
        }
      }
    }
  }
}

/** @} */