summaryrefslogtreecommitdiffstats
path: root/testsuites/validation/tc-barrier-delete.c
blob: 5cfbee8c06c9894c25833ad68d4768f453c56ad3 (plain)
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
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSTestCaseRtemsBarrierReqDelete
 */

/*
 * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 *
 * 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 <string.h>

#include <rtems/test.h>

/**
 * @defgroup RTEMSTestCaseRtemsBarrierReqDelete spec:/rtems/barrier/req/delete
 *
 * @ingroup RTEMSTestSuiteTestsuitesValidation0
 *
 * @{
 */

typedef enum {
  RtemsBarrierReqDelete_Pre_Id_NoObj,
  RtemsBarrierReqDelete_Pre_Id_Barrier,
  RtemsBarrierReqDelete_Pre_Id_NA
} RtemsBarrierReqDelete_Pre_Id;

typedef enum {
  RtemsBarrierReqDelete_Post_Status_Ok,
  RtemsBarrierReqDelete_Post_Status_InvId,
  RtemsBarrierReqDelete_Post_Status_NA
} RtemsBarrierReqDelete_Post_Status;

typedef enum {
  RtemsBarrierReqDelete_Post_Name_Valid,
  RtemsBarrierReqDelete_Post_Name_Invalid,
  RtemsBarrierReqDelete_Post_Name_NA
} RtemsBarrierReqDelete_Post_Name;

typedef enum {
  RtemsBarrierReqDelete_Post_Flush_Yes,
  RtemsBarrierReqDelete_Post_Flush_No,
  RtemsBarrierReqDelete_Post_Flush_NA
} RtemsBarrierReqDelete_Post_Flush;

/**
 * @brief Test context for spec:/rtems/barrier/req/delete test case.
 */
typedef struct {
  rtems_id worker_id;

  rtems_id barrier_id;

  uint32_t wait_done;

  uint32_t wait_expected;

  rtems_id id;

  rtems_status_code status;

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

  /**
   * @brief This member indicates if the test action loop is currently
   *   executed.
   */
  bool in_action_loop;
} RtemsBarrierReqDelete_Context;

static RtemsBarrierReqDelete_Context
  RtemsBarrierReqDelete_Instance;

static const char * const RtemsBarrierReqDelete_PreDesc_Id[] = {
  "NoObj",
  "Barrier",
  "NA"
};

static const char * const * const RtemsBarrierReqDelete_PreDesc[] = {
  RtemsBarrierReqDelete_PreDesc_Id,
  NULL
};

#define NAME rtems_build_name( 'T', 'E', 'S', 'T' )

typedef RtemsBarrierReqDelete_Context Context;

typedef enum {
  PRIO_HIGH = 1,
  PRIO_NORMAL,
  PRIO_LOW
} Priorities;

static void Worker( rtems_task_argument arg )
{
  Context *ctx;

  ctx = (Context *) arg;

  while ( true ) {
    rtems_status_code   sc;
    rtems_task_priority prio;

    T_eq_u32( ctx->barrier_id, 0 );

    sc = rtems_barrier_create(
      NAME,
      RTEMS_DEFAULT_ATTRIBUTES,
      0,
      &ctx->barrier_id
    );
    T_rsc_success( sc );

    sc = rtems_barrier_wait(
      ctx->barrier_id,
      RTEMS_NO_TIMEOUT
    );
    T_rsc( sc, RTEMS_OBJECT_WAS_DELETED );

    ++ctx->wait_done;

    prio = 0;
    sc = rtems_task_set_priority( RTEMS_SELF, PRIO_LOW, &prio );
    T_rsc_success( sc );
    T_eq_u32( prio, PRIO_HIGH );
  }
}

static void RtemsBarrierReqDelete_Pre_Id_Prepare(
  RtemsBarrierReqDelete_Context *ctx,
  RtemsBarrierReqDelete_Pre_Id   state
)
{
  switch ( state ) {
    case RtemsBarrierReqDelete_Pre_Id_NoObj: {
      /*
       * While the ``id`` parameter is not associated with a barrier.
       */
      ctx->id = 0;
      break;
    }

    case RtemsBarrierReqDelete_Pre_Id_Barrier: {
      /*
       * While the ``id`` parameter is associated with a barrier.
       */
      ctx->id = ctx->barrier_id;
      break;
    }

    case RtemsBarrierReqDelete_Pre_Id_NA:
      break;
  }
}

static void RtemsBarrierReqDelete_Post_Status_Check(
  RtemsBarrierReqDelete_Context    *ctx,
  RtemsBarrierReqDelete_Post_Status state
)
{
  switch ( state ) {
    case RtemsBarrierReqDelete_Post_Status_Ok: {
      /*
       * The return status of rtems_barrier_delete() shall be RTEMS_SUCCESSFUL.
       */
      ctx->barrier_id = 0;
      T_rsc_success( ctx->status );
      break;
    }

    case RtemsBarrierReqDelete_Post_Status_InvId: {
      /*
       * The return status of rtems_barrier_delete() shall be RTEMS_INVALID_ID.
       */
      T_rsc( ctx->status, RTEMS_INVALID_ID );
      break;
    }

    case RtemsBarrierReqDelete_Post_Status_NA:
      break;
  }
}

static void RtemsBarrierReqDelete_Post_Name_Check(
  RtemsBarrierReqDelete_Context  *ctx,
  RtemsBarrierReqDelete_Post_Name state
)
{
  rtems_status_code sc;
  rtems_id          id;

  switch ( state ) {
    case RtemsBarrierReqDelete_Post_Name_Valid: {
      /*
       * The unique object name shall identify a barrier.
       */
      id = 0;
      sc = rtems_barrier_ident( NAME, &id );
      T_rsc_success( sc );
      T_eq_u32( id, ctx->barrier_id );
      break;
    }

    case RtemsBarrierReqDelete_Post_Name_Invalid: {
      /*
       * The unique object name shall not identify a barrier.
       */
      sc = rtems_barrier_ident( NAME, &id );
      T_rsc( sc, RTEMS_INVALID_NAME );
      break;
    }

    case RtemsBarrierReqDelete_Post_Name_NA:
      break;
  }
}

static void RtemsBarrierReqDelete_Post_Flush_Check(
  RtemsBarrierReqDelete_Context   *ctx,
  RtemsBarrierReqDelete_Post_Flush state
)
{
  switch ( state ) {
    case RtemsBarrierReqDelete_Post_Flush_Yes: {
      /*
       * Tasks waiting at the barrier shall be unblocked.
       */
      ++ctx->wait_expected;
      T_eq_u32( ctx->wait_done, ctx->wait_expected );
      break;
    }

    case RtemsBarrierReqDelete_Post_Flush_No: {
      /*
       * Tasks waiting at the barrier shall remain blocked.
       */
      T_eq_u32( ctx->wait_done, ctx->wait_expected );
      break;
    }

    case RtemsBarrierReqDelete_Post_Flush_NA:
      break;
  }
}

static void RtemsBarrierReqDelete_Setup( RtemsBarrierReqDelete_Context *ctx )
{
  rtems_status_code   sc;
  rtems_task_priority prio;

  memset( ctx, 0, sizeof( *ctx ) );

  prio = 0;
  sc = rtems_task_set_priority( RTEMS_SELF, PRIO_NORMAL, &prio );
  T_rsc_success( sc );
  T_eq_u32( prio, PRIO_HIGH );

  sc = rtems_task_create(
    rtems_build_name( 'W', 'O', 'R', 'K' ),
    PRIO_LOW,
    RTEMS_MINIMUM_STACK_SIZE,
    RTEMS_DEFAULT_MODES,
    RTEMS_DEFAULT_ATTRIBUTES,
    &ctx->worker_id
  );
  T_assert_rsc_success( sc );

  sc = rtems_task_start( ctx->worker_id, Worker, (rtems_task_argument) ctx );
  T_assert_rsc_success( sc );
}

static void RtemsBarrierReqDelete_Setup_Wrap( void *arg )
{
  RtemsBarrierReqDelete_Context *ctx;

  ctx = arg;
  ctx->in_action_loop = false;
  RtemsBarrierReqDelete_Setup( ctx );
}

static void RtemsBarrierReqDelete_Teardown(
  RtemsBarrierReqDelete_Context *ctx
)
{
  rtems_status_code   sc;
  rtems_task_priority prio;

  prio = 0;
  sc = rtems_task_set_priority( RTEMS_SELF, PRIO_HIGH, &prio );
  T_rsc_success( sc );
  T_eq_u32( prio, PRIO_NORMAL );

  if ( ctx->worker_id != 0 ) {
    sc = rtems_task_delete( ctx->worker_id );
    T_rsc_success( sc );
  }
}

static void RtemsBarrierReqDelete_Teardown_Wrap( void *arg )
{
  RtemsBarrierReqDelete_Context *ctx;

  ctx = arg;
  ctx->in_action_loop = false;
  RtemsBarrierReqDelete_Teardown( ctx );
}

static void RtemsBarrierReqDelete_Prepare( RtemsBarrierReqDelete_Context *ctx )
{
  rtems_status_code   sc;
  rtems_task_priority prio;

  prio = 0;
  sc = rtems_task_set_priority( ctx->worker_id, PRIO_HIGH, &prio );
  T_rsc_success( sc );
  T_true( prio == PRIO_LOW || prio == PRIO_HIGH );
}

static void RtemsBarrierReqDelete_Action( RtemsBarrierReqDelete_Context *ctx )
{
  ctx->status = rtems_barrier_delete( ctx->id );
}

static void RtemsBarrierReqDelete_Cleanup( RtemsBarrierReqDelete_Context *ctx )
{
  if ( ctx->barrier_id != 0 ) {
    rtems_status_code sc;

    sc = rtems_barrier_delete( ctx->barrier_id );
    T_rsc_success( sc );

    ++ctx->wait_expected;
    T_eq_u32( ctx->wait_done, ctx->wait_expected );

    ctx->barrier_id = 0;
  }
}

typedef struct {
  uint8_t Skip : 1;
  uint8_t Pre_Id_NA : 1;
  uint8_t Post_Status : 2;
  uint8_t Post_Name : 2;
  uint8_t Post_Flush : 2;
} RtemsBarrierReqDelete_Entry;

static const RtemsBarrierReqDelete_Entry
RtemsBarrierReqDelete_Entries[] = {
  { 0, 0, RtemsBarrierReqDelete_Post_Status_InvId,
    RtemsBarrierReqDelete_Post_Name_Valid, RtemsBarrierReqDelete_Post_Flush_No },
  { 0, 0, RtemsBarrierReqDelete_Post_Status_Ok,
    RtemsBarrierReqDelete_Post_Name_Invalid,
    RtemsBarrierReqDelete_Post_Flush_Yes }
};

static const uint8_t
RtemsBarrierReqDelete_Map[] = {
  0, 1
};

static size_t RtemsBarrierReqDelete_Scope( void *arg, char *buf, size_t n )
{
  RtemsBarrierReqDelete_Context *ctx;

  ctx = arg;

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

  return 0;
}

static T_fixture RtemsBarrierReqDelete_Fixture = {
  .setup = RtemsBarrierReqDelete_Setup_Wrap,
  .stop = NULL,
  .teardown = RtemsBarrierReqDelete_Teardown_Wrap,
  .scope = RtemsBarrierReqDelete_Scope,
  .initial_context = &RtemsBarrierReqDelete_Instance
};

static inline RtemsBarrierReqDelete_Entry RtemsBarrierReqDelete_GetEntry(
  size_t index
)
{
  return RtemsBarrierReqDelete_Entries[
    RtemsBarrierReqDelete_Map[ index ]
  ];
}

/**
 * @fn void T_case_body_RtemsBarrierReqDelete( void )
 */
T_TEST_CASE_FIXTURE( RtemsBarrierReqDelete, &RtemsBarrierReqDelete_Fixture )
{
  RtemsBarrierReqDelete_Context *ctx;
  RtemsBarrierReqDelete_Entry entry;
  size_t index;

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

  for (
    ctx->pcs[ 0 ] = RtemsBarrierReqDelete_Pre_Id_NoObj;
    ctx->pcs[ 0 ] < RtemsBarrierReqDelete_Pre_Id_NA;
    ++ctx->pcs[ 0 ]
  ) {
    entry = RtemsBarrierReqDelete_GetEntry( index );

    if ( entry.Pre_Id_NA ) {
      ctx->pcs[ 0 ] = RtemsBarrierReqDelete_Pre_Id_NA;
      index += ( RtemsBarrierReqDelete_Pre_Id_NA - 1 );
    }

    if ( entry.Skip ) {
      ++index;
      continue;
    }

    RtemsBarrierReqDelete_Prepare( ctx );
    RtemsBarrierReqDelete_Pre_Id_Prepare( ctx, ctx->pcs[ 0 ] );
    RtemsBarrierReqDelete_Action( ctx );
    RtemsBarrierReqDelete_Post_Status_Check( ctx, entry.Post_Status );
    RtemsBarrierReqDelete_Post_Name_Check( ctx, entry.Post_Name );
    RtemsBarrierReqDelete_Post_Flush_Check( ctx, entry.Post_Flush );
    RtemsBarrierReqDelete_Cleanup( ctx );
    ++index;
  }
}

/** @} */