validation: Tests for barrier manager

1 files changed, 687 insertions, 0 deletions

diff --git a/testsuites/validation/tc-barrier-wait.c b/testsuites/validation/tc-barrier-wait.c
new file mode 100644
index 0000000000..d290332207
--- /dev/null
+++ b/testsuites/validation/tc-barrier-wait.c
@@ -0,0 +1,687 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestCaseRtemsBarrierReqWait
+ */
+
+/*
+ * 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 RTEMSTestCaseRtemsBarrierReqWait spec:/rtems/barrier/req/wait
+ *
+ * @ingroup RTEMSTestSuiteTestsuitesValidation0
+ *
+ * @{
+ */
+
+typedef enum {
+  RtemsBarrierReqWait_Pre_Barrier_NoObj,
+  RtemsBarrierReqWait_Pre_Barrier_Manual,
+  RtemsBarrierReqWait_Pre_Barrier_Auto,
+  RtemsBarrierReqWait_Pre_Barrier_NA
+} RtemsBarrierReqWait_Pre_Barrier;
+
+typedef enum {
+  RtemsBarrierReqWait_Pre_Timeout_Ticks,
+  RtemsBarrierReqWait_Pre_Timeout_Forever,
+  RtemsBarrierReqWait_Pre_Timeout_NA
+} RtemsBarrierReqWait_Pre_Timeout;
+
+typedef enum {
+  RtemsBarrierReqWait_Pre_Satisfy_Never,
+  RtemsBarrierReqWait_Pre_Satisfy_Wait,
+  RtemsBarrierReqWait_Pre_Satisfy_Release,
+  RtemsBarrierReqWait_Pre_Satisfy_Delete,
+  RtemsBarrierReqWait_Pre_Satisfy_NA
+} RtemsBarrierReqWait_Pre_Satisfy;
+
+typedef enum {
+  RtemsBarrierReqWait_Post_Status_Ok,
+  RtemsBarrierReqWait_Post_Status_InvId,
+  RtemsBarrierReqWait_Post_Status_Timeout,
+  RtemsBarrierReqWait_Post_Status_ObjDel,
+  RtemsBarrierReqWait_Post_Status_NoReturn,
+  RtemsBarrierReqWait_Post_Status_NA
+} RtemsBarrierReqWait_Post_Status;
+
+/**
+ * @brief Test context for spec:/rtems/barrier/req/wait test case.
+ */
+typedef struct {
+  rtems_id main_id;
+
+  rtems_id high_worker_id;
+
+  rtems_id low_worker_id;
+
+  rtems_id manual_release_id;
+
+  rtems_id auto_release_id;
+
+  rtems_id id;
+
+  rtems_interval timeout;
+
+  rtems_status_code status;
+
+  /**
+   * @brief This member defines the pre-condition states for the next action.
+   */
+  size_t pcs[ 3 ];
+
+  /**
+   * @brief This member indicates if the test action loop is currently
+   *   executed.
+   */
+  bool in_action_loop;
+} RtemsBarrierReqWait_Context;
+
+static RtemsBarrierReqWait_Context
+  RtemsBarrierReqWait_Instance;
+
+static const char * const RtemsBarrierReqWait_PreDesc_Barrier[] = {
+  "NoObj",
+  "Manual",
+  "Auto",
+  "NA"
+};
+
+static const char * const RtemsBarrierReqWait_PreDesc_Timeout[] = {
+  "Ticks",
+  "Forever",
+  "NA"
+};
+
+static const char * const RtemsBarrierReqWait_PreDesc_Satisfy[] = {
+  "Never",
+  "Wait",
+  "Release",
+  "Delete",
+  "NA"
+};
+
+static const char * const * const RtemsBarrierReqWait_PreDesc[] = {
+  RtemsBarrierReqWait_PreDesc_Barrier,
+  RtemsBarrierReqWait_PreDesc_Timeout,
+  RtemsBarrierReqWait_PreDesc_Satisfy,
+  NULL
+};
+
+#define NAME rtems_build_name( 'T', 'E', 'S', 'T' )
+
+#define EVENT_CHECK_TIMER RTEMS_EVENT_0
+
+#define EVENT_WAIT RTEMS_EVENT_1
+
+#define EVENT_RELEASE RTEMS_EVENT_2
+
+#define EVENT_DELETE RTEMS_EVENT_3
+
+typedef RtemsBarrierReqWait_Context Context;
+
+typedef enum {
+  PRIO_HIGH = 1,
+  PRIO_NORMAL,
+  PRIO_LOW
+} Priorities;
+
+static void SendEvents( rtems_id id, rtems_event_set events )
+{
+  rtems_status_code sc;
+
+  sc = rtems_event_send( id, events );
+  T_rsc_success( sc );
+}
+
+static void Worker( rtems_task_argument arg )
+{
+  Context *ctx;
+
+  ctx = (Context *) arg;
+
+  while ( true ) {
+    rtems_status_code sc;
+    rtems_event_set   events;
+
+    events = 0;
+    sc = rtems_event_receive(
+      RTEMS_ALL_EVENTS,
+      RTEMS_EVENT_ANY | RTEMS_WAIT,
+      RTEMS_NO_TIMEOUT,
+      &events
+    );
+    T_rsc_success( sc );
+
+    if ( ( events & EVENT_CHECK_TIMER ) != 0 ) {
+      T_eq_int(
+        T_get_thread_timer_state( ctx->main_id ),
+        T_THREAD_TIMER_INACTIVE
+      );
+    }
+
+    if ( ( events & EVENT_WAIT ) != 0 ) {
+      sc = rtems_barrier_wait( ctx->id, RTEMS_NO_TIMEOUT );
+      T_rsc_success( sc );
+    }
+
+    if ( ( events & EVENT_RELEASE ) != 0 ) {
+      uint32_t released;
+
+      sc = rtems_barrier_release( ctx->id, &released );
+      T_rsc_success( sc );
+    }
+
+    if ( ( events & EVENT_DELETE ) != 0 ) {
+      rtems_attribute     attribute_set;
+      uint32_t            maximum_waiters;
+      rtems_id           *id;
+      rtems_task_priority prio;
+
+      if ( ctx->id == ctx->manual_release_id ) {
+        attribute_set = RTEMS_BARRIER_MANUAL_RELEASE;
+        maximum_waiters = 0;
+        id = &ctx->manual_release_id;
+      } else {
+        attribute_set = RTEMS_BARRIER_AUTOMATIC_RELEASE;
+        maximum_waiters = 2;
+        id = &ctx->auto_release_id;
+      }
+
+      prio = 0;
+      sc = rtems_task_set_priority( RTEMS_SELF, PRIO_HIGH, &prio );
+      T_rsc_success( sc );
+      T_eq_u32( prio, PRIO_LOW );
+
+      sc = rtems_barrier_delete( ctx->id );
+      T_rsc_success( sc );
+
+      sc = rtems_barrier_create( NAME, attribute_set, maximum_waiters, id );
+      T_rsc_success( sc );
+
+      sc = rtems_task_set_priority( RTEMS_SELF, prio, &prio );
+      T_rsc_success( sc );
+      T_eq_u32( prio, PRIO_HIGH );
+    }
+  }
+}
+
+static void RtemsBarrierReqWait_Pre_Barrier_Prepare(
+  RtemsBarrierReqWait_Context    *ctx,
+  RtemsBarrierReqWait_Pre_Barrier state
+)
+{
+  switch ( state ) {
+    case RtemsBarrierReqWait_Pre_Barrier_NoObj: {
+      ctx->id = 0xffffffff;
+      break;
+    }
+
+    case RtemsBarrierReqWait_Pre_Barrier_Manual: {
+      ctx->id = ctx->manual_release_id;
+      break;
+    }
+
+    case RtemsBarrierReqWait_Pre_Barrier_Auto: {
+      ctx->id = ctx->auto_release_id;
+      break;
+    }
+
+    case RtemsBarrierReqWait_Pre_Barrier_NA:
+      break;
+  }
+}
+
+static void RtemsBarrierReqWait_Pre_Timeout_Prepare(
+  RtemsBarrierReqWait_Context    *ctx,
+  RtemsBarrierReqWait_Pre_Timeout state
+)
+{
+  switch ( state ) {
+    case RtemsBarrierReqWait_Pre_Timeout_Ticks: {
+      ctx->timeout = 2;
+      break;
+    }
+
+    case RtemsBarrierReqWait_Pre_Timeout_Forever: {
+      ctx->timeout = RTEMS_NO_TIMEOUT;
+      break;
+    }
+
+    case RtemsBarrierReqWait_Pre_Timeout_NA:
+      break;
+  }
+}
+
+static void RtemsBarrierReqWait_Pre_Satisfy_Prepare(
+  RtemsBarrierReqWait_Context    *ctx,
+  RtemsBarrierReqWait_Pre_Satisfy state
+)
+{
+  switch ( state ) {
+    case RtemsBarrierReqWait_Pre_Satisfy_Never: {
+      if ( ctx->timeout == RTEMS_NO_TIMEOUT ) {
+        SendEvents( ctx->low_worker_id, EVENT_CHECK_TIMER | EVENT_RELEASE );
+      }
+      break;
+    }
+
+    case RtemsBarrierReqWait_Pre_Satisfy_Wait: {
+      SendEvents( ctx->high_worker_id, EVENT_WAIT );
+      break;
+    }
+
+    case RtemsBarrierReqWait_Pre_Satisfy_Release: {
+      SendEvents( ctx->low_worker_id, EVENT_RELEASE );
+      break;
+    }
+
+    case RtemsBarrierReqWait_Pre_Satisfy_Delete: {
+      SendEvents( ctx->low_worker_id, EVENT_DELETE );
+      break;
+    }
+
+    case RtemsBarrierReqWait_Pre_Satisfy_NA:
+      break;
+  }
+}
+
+static void RtemsBarrierReqWait_Post_Status_Check(
+  RtemsBarrierReqWait_Context    *ctx,
+  RtemsBarrierReqWait_Post_Status state
+)
+{
+  switch ( state ) {
+    case RtemsBarrierReqWait_Post_Status_Ok: {
+      T_rsc_success( ctx->status );
+      break;
+    }
+
+    case RtemsBarrierReqWait_Post_Status_InvId: {
+      T_rsc( ctx->status, RTEMS_INVALID_ID );
+      break;
+    }
+
+    case RtemsBarrierReqWait_Post_Status_Timeout: {
+      T_rsc( ctx->status, RTEMS_TIMEOUT );
+      break;
+    }
+
+    case RtemsBarrierReqWait_Post_Status_ObjDel: {
+      T_rsc( ctx->status, RTEMS_OBJECT_WAS_DELETED );
+      break;
+    }
+
+    case RtemsBarrierReqWait_Post_Status_NoReturn: {
+      T_rsc_success( ctx->status );
+      break;
+    }
+
+    case RtemsBarrierReqWait_Post_Status_NA:
+      break;
+  }
+}
+
+static void RtemsBarrierReqWait_Setup( RtemsBarrierReqWait_Context *ctx )
+{
+  rtems_status_code   sc;
+  rtems_task_priority prio;
+
+  memset( ctx, 0, sizeof( *ctx ) );
+  ctx->main_id = rtems_task_self();
+
+  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_HIGH,
+    RTEMS_MINIMUM_STACK_SIZE,
+    RTEMS_DEFAULT_MODES,
+    RTEMS_DEFAULT_ATTRIBUTES,
+    &ctx->high_worker_id
+  );
+  T_assert_rsc_success( sc );
+
+  sc = rtems_task_start(
+    ctx->high_worker_id,
+    Worker,
+    (rtems_task_argument) ctx
+  );
+  T_assert_rsc_success( sc );
+
+  sc = rtems_task_create(
+    rtems_build_name( 'W', 'O', 'R', 'K' ),
+    PRIO_LOW,
+    RTEMS_MINIMUM_STACK_SIZE,
+    RTEMS_DEFAULT_MODES,
+    RTEMS_DEFAULT_ATTRIBUTES,
+    &ctx->low_worker_id
+  );
+  T_assert_rsc_success( sc );
+
+  sc = rtems_task_start(
+    ctx->low_worker_id,
+    Worker,
+    (rtems_task_argument) ctx
+  );
+  T_assert_rsc_success( sc );
+
+  sc = rtems_barrier_create(
+    NAME,
+    RTEMS_BARRIER_MANUAL_RELEASE,
+    0,
+    &ctx->manual_release_id
+  );
+  T_assert_rsc_success( sc );
+
+  sc = rtems_barrier_create(
+    NAME,
+    RTEMS_BARRIER_AUTOMATIC_RELEASE,
+    2,
+    &ctx->auto_release_id
+  );
+  T_assert_rsc_success( sc );
+}
+
+static void RtemsBarrierReqWait_Setup_Wrap( void *arg )
+{
+  RtemsBarrierReqWait_Context *ctx;
+
+  ctx = arg;
+  ctx->in_action_loop = false;
+  RtemsBarrierReqWait_Setup( ctx );
+}
+
+static void RtemsBarrierReqWait_Teardown( RtemsBarrierReqWait_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->high_worker_id != 0 ) {
+    sc = rtems_task_delete( ctx->high_worker_id );
+    T_rsc_success( sc );
+  }
+
+  if ( ctx->low_worker_id != 0 ) {
+    sc = rtems_task_delete( ctx->low_worker_id );
+    T_rsc_success( sc );
+  }
+
+  if ( ctx->manual_release_id != 0 ) {
+    sc = rtems_barrier_delete( ctx->manual_release_id );
+    T_rsc_success( sc );
+  }
+
+  if ( ctx->auto_release_id != 0 ) {
+    sc = rtems_barrier_delete( ctx->auto_release_id );
+    T_rsc_success( sc );
+  }
+}
+
+static void RtemsBarrierReqWait_Teardown_Wrap( void *arg )
+{
+  RtemsBarrierReqWait_Context *ctx;
+
+  ctx = arg;
+  ctx->in_action_loop = false;
+  RtemsBarrierReqWait_Teardown( ctx );
+}
+
+static size_t RtemsBarrierReqWait_Scope( void *arg, char *buf, size_t n )
+{
+  RtemsBarrierReqWait_Context *ctx;
+
+  ctx = arg;
+
+  if ( ctx->in_action_loop ) {
+    return T_get_scope( RtemsBarrierReqWait_PreDesc, buf, n, ctx->pcs );
+  }
+
+  return 0;
+}
+
+static T_fixture RtemsBarrierReqWait_Fixture = {
+  .setup = RtemsBarrierReqWait_Setup_Wrap,
+  .stop = NULL,
+  .teardown = RtemsBarrierReqWait_Teardown_Wrap,
+  .scope = RtemsBarrierReqWait_Scope,
+  .initial_context = &RtemsBarrierReqWait_Instance
+};
+
+static const uint8_t RtemsBarrierReqWait_TransitionMap[][ 1 ] = {
+  {
+    RtemsBarrierReqWait_Post_Status_InvId
+  }, {
+    RtemsBarrierReqWait_Post_Status_InvId
+  }, {
+    RtemsBarrierReqWait_Post_Status_InvId
+  }, {
+    RtemsBarrierReqWait_Post_Status_InvId
+  }, {
+    RtemsBarrierReqWait_Post_Status_InvId
+  }, {
+    RtemsBarrierReqWait_Post_Status_InvId
+  }, {
+    RtemsBarrierReqWait_Post_Status_InvId
+  }, {
+    RtemsBarrierReqWait_Post_Status_InvId
+  }, {
+    RtemsBarrierReqWait_Post_Status_Timeout
+  }, {
+    RtemsBarrierReqWait_Post_Status_NA
+  }, {
+    RtemsBarrierReqWait_Post_Status_Ok
+  }, {
+    RtemsBarrierReqWait_Post_Status_ObjDel
+  }, {
+    RtemsBarrierReqWait_Post_Status_NoReturn
+  }, {
+    RtemsBarrierReqWait_Post_Status_NA
+  }, {
+    RtemsBarrierReqWait_Post_Status_Ok
+  }, {
+    RtemsBarrierReqWait_Post_Status_ObjDel
+  }, {
+    RtemsBarrierReqWait_Post_Status_Timeout
+  }, {
+    RtemsBarrierReqWait_Post_Status_Ok
+  }, {
+    RtemsBarrierReqWait_Post_Status_Ok
+  }, {
+    RtemsBarrierReqWait_Post_Status_ObjDel
+  }, {
+    RtemsBarrierReqWait_Post_Status_NoReturn
+  }, {
+    RtemsBarrierReqWait_Post_Status_Ok
+  }, {
+    RtemsBarrierReqWait_Post_Status_Ok
+  }, {
+    RtemsBarrierReqWait_Post_Status_ObjDel
+  }
+};
+
+static const struct {
+  uint8_t Skip : 1;
+  uint8_t Pre_Barrier_NA : 1;
+  uint8_t Pre_Timeout_NA : 1;
+  uint8_t Pre_Satisfy_NA : 1;
+} RtemsBarrierReqWait_TransitionInfo[] = {
+  {
+    0, 0, 1, 1
+  }, {
+    0, 0, 1, 1
+  }, {
+    0, 0, 1, 1
+  }, {
+    0, 0, 1, 1
+  }, {
+    0, 0, 1, 1
+  }, {
+    0, 0, 1, 1
+  }, {
+    0, 0, 1, 1
+  }, {
+    0, 0, 1, 1
+  }, {
+    0, 0, 0, 0
+  }, {
+    1, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    1, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }, {
+    0, 0, 0, 0
+  }
+};
+
+static void RtemsBarrierReqWait_Action( RtemsBarrierReqWait_Context *ctx )
+{
+  ctx->status = rtems_barrier_wait( ctx->id, ctx->timeout );
+}
+
+/**
+ * @fn void T_case_body_RtemsBarrierReqWait( void )
+ */
+T_TEST_CASE_FIXTURE( RtemsBarrierReqWait, &RtemsBarrierReqWait_Fixture )
+{
+  RtemsBarrierReqWait_Context *ctx;
+  size_t index;
+
+  ctx = T_fixture_context();
+  ctx->in_action_loop = true;
+  index = 0;
+
+  for (
+    ctx->pcs[ 0 ] = RtemsBarrierReqWait_Pre_Barrier_NoObj;
+    ctx->pcs[ 0 ] < RtemsBarrierReqWait_Pre_Barrier_NA;
+    ++ctx->pcs[ 0 ]
+  ) {
+    if ( RtemsBarrierReqWait_TransitionInfo[ index ].Pre_Barrier_NA ) {
+      ctx->pcs[ 0 ] = RtemsBarrierReqWait_Pre_Barrier_NA;
+      index += ( RtemsBarrierReqWait_Pre_Barrier_NA - 1 )
+        * RtemsBarrierReqWait_Pre_Timeout_NA
+        * RtemsBarrierReqWait_Pre_Satisfy_NA;
+    }
+
+    for (
+      ctx->pcs[ 1 ] = RtemsBarrierReqWait_Pre_Timeout_Ticks;
+      ctx->pcs[ 1 ] < RtemsBarrierReqWait_Pre_Timeout_NA;
+      ++ctx->pcs[ 1 ]
+    ) {
+      if ( RtemsBarrierReqWait_TransitionInfo[ index ].Pre_Timeout_NA ) {
+        ctx->pcs[ 1 ] = RtemsBarrierReqWait_Pre_Timeout_NA;
+        index += ( RtemsBarrierReqWait_Pre_Timeout_NA - 1 )
+          * RtemsBarrierReqWait_Pre_Satisfy_NA;
+      }
+
+      for (
+        ctx->pcs[ 2 ] = RtemsBarrierReqWait_Pre_Satisfy_Never;
+        ctx->pcs[ 2 ] < RtemsBarrierReqWait_Pre_Satisfy_NA;
+        ++ctx->pcs[ 2 ]
+      ) {
+        if ( RtemsBarrierReqWait_TransitionInfo[ index ].Pre_Satisfy_NA ) {
+          ctx->pcs[ 2 ] = RtemsBarrierReqWait_Pre_Satisfy_NA;
+          index += ( RtemsBarrierReqWait_Pre_Satisfy_NA - 1 );
+        }
+
+        if ( RtemsBarrierReqWait_TransitionInfo[ index ].Skip ) {
+          ++index;
+          continue;
+        }
+
+        RtemsBarrierReqWait_Pre_Barrier_Prepare( ctx, ctx->pcs[ 0 ] );
+        RtemsBarrierReqWait_Pre_Timeout_Prepare( ctx, ctx->pcs[ 1 ] );
+        RtemsBarrierReqWait_Pre_Satisfy_Prepare( ctx, ctx->pcs[ 2 ] );
+        RtemsBarrierReqWait_Action( ctx );
+        RtemsBarrierReqWait_Post_Status_Check(
+          ctx,
+          RtemsBarrierReqWait_TransitionMap[ index ][ 0 ]
+        );
+        ++index;
+      }
+    }
+  }
+}
+
+/** @} */