validation: Semaphore seize wait test runner

3 files changed, 479 insertions, 0 deletions

diff --git a/spec/build/testsuites/validation/validation-0.yml b/spec/build/testsuites/validation/validation-0.yml
index 687d39796e..e77870579d 100644
--- a/spec/build/testsuites/validation/validation-0.yml
+++ b/spec/build/testsuites/validation/validation-0.yml
@@ -74,6 +74,7 @@ source:
 - testsuites/validation/tr-object-ident.c
 - testsuites/validation/tr-object-ident-local.c
 - testsuites/validation/tr-sem-seize-try.c
+- testsuites/validation/tr-sem-seize-wait.c
 - testsuites/validation/tr-tq-enqueue-ceiling.c
 - testsuites/validation/tr-tq-enqueue-deadlock.c
 - testsuites/validation/tr-tq-enqueue-fifo.c
diff --git a/testsuites/validation/tr-sem-seize-wait.c b/testsuites/validation/tr-sem-seize-wait.c
new file mode 100644
index 0000000000..ed1d8c7d0b
--- /dev/null
+++ b/testsuites/validation/tr-sem-seize-wait.c
@@ -0,0 +1,375 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestCaseScoreSemReqSeizeWait
+ */
+
+/*
+ * 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/score/statesimpl.h>
+
+#include "tr-sem-seize-wait.h"
+#include "tr-tq-enqueue-fifo.h"
+#include "tr-tq-enqueue-priority.h"
+
+#include <rtems/test.h>
+
+/**
+ * @defgroup RTEMSTestCaseScoreSemReqSeizeWait spec:/score/sem/req/seize-wait
+ *
+ * @ingroup RTEMSTestSuiteTestsuitesValidation0
+ *
+ * @{
+ */
+
+/**
+ * @brief Test context for spec:/score/sem/req/seize-wait test case.
+ */
+typedef struct {
+  /**
+   * @brief This member contains a copy of the corresponding
+   *   ScoreSemReqSeizeWait_Run() parameter.
+   */
+  TQSemContext *tq_ctx;
+
+  /**
+   * @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;
+} ScoreSemReqSeizeWait_Context;
+
+static ScoreSemReqSeizeWait_Context
+  ScoreSemReqSeizeWait_Instance;
+
+static const char * const ScoreSemReqSeizeWait_PreDesc_Count[] = {
+  "Zero",
+  "Positive",
+  "NA"
+};
+
+static const char * const * const ScoreSemReqSeizeWait_PreDesc[] = {
+  ScoreSemReqSeizeWait_PreDesc_Count,
+  NULL
+};
+
+typedef ScoreSemReqSeizeWait_Context Context;
+
+static Status_Control Status( const Context *ctx, Status_Control status )
+{
+  return TQConvertStatus( &ctx->tq_ctx->base, status );
+}
+
+static void GetProperties( TQContext *base, TQWorkerKind enqueued_worker )
+{
+  TQSemContext        *ctx;
+  T_thread_timer_state timer_state;
+
+  ctx = (TQSemContext *) base;
+  T_eq_u32(
+    ctx->base.worker_tcb[ enqueued_worker ]->current_state,
+    STATES_WAITING_FOR_SEMAPHORE
+  );
+
+  timer_state = T_get_thread_timer_state(
+    ctx->base.worker_id[ enqueued_worker ]
+  );
+
+  if ( base->wait == TQ_WAIT_TICKS ) {
+    T_eq_int( timer_state, T_THREAD_TIMER_SCHEDULED );
+  } else {
+    T_eq_int( timer_state, T_THREAD_TIMER_INACTIVE );
+  }
+
+  T_eq_u32( TQSemGetCount( ctx ), 0 );
+}
+
+static void ScoreSemReqSeizeWait_Pre_Count_Prepare(
+  ScoreSemReqSeizeWait_Context  *ctx,
+  ScoreSemReqSeizeWait_Pre_Count state
+)
+{
+  switch ( state ) {
+    case ScoreSemReqSeizeWait_Pre_Count_Zero: {
+      /*
+       * While the count of the semaphore is zero.
+       */
+      /* Done by TQEnqueuePrepareClassicSem() */
+      break;
+    }
+
+    case ScoreSemReqSeizeWait_Pre_Count_Positive: {
+      /*
+       * While the count of the semaphore is greater than zero.
+       */
+      TQSemSetCount( ctx->tq_ctx, 1 );
+      break;
+    }
+
+    case ScoreSemReqSeizeWait_Pre_Count_NA:
+      break;
+  }
+}
+
+static void ScoreSemReqSeizeWait_Post_Status_Check(
+  ScoreSemReqSeizeWait_Context    *ctx,
+  ScoreSemReqSeizeWait_Post_Status state
+)
+{
+  Status_Control status;
+
+  switch ( state ) {
+    case ScoreSemReqSeizeWait_Post_Status_Ok: {
+      /*
+       * The return status of the directive call shall be derived from
+       * STATUS_SUCCESSFUL.
+       */
+      status = TQEnqueue( &ctx->tq_ctx->base, ctx->tq_ctx->base.wait );
+      T_eq_int( status, Status( ctx, STATUS_SUCCESSFUL ) );
+      break;
+    }
+
+    case ScoreSemReqSeizeWait_Post_Status_Enqueued: {
+      /*
+       * Where the thread queue uses the FIFO discipline, the calling thread
+       * shall be enqueued in FIFO order.
+       *
+       * Where the thread queue uses the priority discipline, the calling
+       * thread shall be enqueued in priority order.
+       */
+      switch ( ctx->tq_ctx->base.discipline ) {
+        case TQ_FIFO:
+          ScoreTqReqEnqueueFifo_Run( &ctx->tq_ctx->base );
+          break;
+        case TQ_PRIORITY:
+          ScoreTqReqEnqueuePriority_Run( &ctx->tq_ctx->base );
+          break;
+        default:
+          T_unreachable();
+          break;
+      }
+      break;
+    }
+
+    case ScoreSemReqSeizeWait_Post_Status_NA:
+      break;
+  }
+}
+
+static void ScoreSemReqSeizeWait_Post_Count_Check(
+  ScoreSemReqSeizeWait_Context   *ctx,
+  ScoreSemReqSeizeWait_Post_Count state
+)
+{
+  switch ( state ) {
+    case ScoreSemReqSeizeWait_Post_Count_Nop: {
+      /*
+       * The count of the semaphore shall not be modified.
+       */
+      /* Checked by GetProperties() */
+      break;
+    }
+
+    case ScoreSemReqSeizeWait_Post_Count_MinusOne: {
+      /*
+       * The count of the semaphore shall be decremented by one.
+       */
+      T_eq_u32( TQSemGetCount( ctx->tq_ctx ), 0 );
+      break;
+    }
+
+    case ScoreSemReqSeizeWait_Post_Count_NA:
+      break;
+  }
+}
+
+static void ScoreSemReqSeizeWait_Post_Timer_Check(
+  ScoreSemReqSeizeWait_Context   *ctx,
+  ScoreSemReqSeizeWait_Post_Timer state
+)
+{
+  switch ( state ) {
+    case ScoreSemReqSeizeWait_Post_Timer_Optional: {
+      /*
+       * Where the directive was called with a timeout in clock ticks, the
+       * thread timer of the calling task shall fire after the specified clock
+       * ticks.
+       *
+       * Where the directive was called without a timeout, the thread timer of
+       * the calling task shall be inactive.
+       */
+      /* Checked by GetProperties() */
+      break;
+    }
+
+    case ScoreSemReqSeizeWait_Post_Timer_No: {
+      /*
+       * The thread timer of the calling task shall be inactive.
+       */
+      T_eq_int(
+        T_get_thread_timer_state( RTEMS_SELF ),
+        T_THREAD_TIMER_INACTIVE
+      );
+      break;
+    }
+
+    case ScoreSemReqSeizeWait_Post_Timer_NA:
+      break;
+  }
+}
+
+static void ScoreSemReqSeizeWait_Prepare( ScoreSemReqSeizeWait_Context *ctx )
+{
+  ctx->tq_ctx->base.enqueue_prepare = TQEnqueuePrepareClassicSem;
+  ctx->tq_ctx->base.enqueue_done = TQSurrenderClassicSem;
+  ctx->tq_ctx->base.get_properties = GetProperties;
+}
+
+static void ScoreSemReqSeizeWait_Action( ScoreSemReqSeizeWait_Context *ctx )
+{
+  /* Action performed by Status post-condition */
+}
+
+typedef struct {
+  uint8_t Skip : 1;
+  uint8_t Pre_Count_NA : 1;
+  uint8_t Post_Status : 2;
+  uint8_t Post_Count : 2;
+  uint8_t Post_Timer : 2;
+} ScoreSemReqSeizeWait_Entry;
+
+static const ScoreSemReqSeizeWait_Entry
+ScoreSemReqSeizeWait_Entries[] = {
+  { 0, 0, ScoreSemReqSeizeWait_Post_Status_Enqueued,
+    ScoreSemReqSeizeWait_Post_Count_Nop,
+    ScoreSemReqSeizeWait_Post_Timer_Optional },
+  { 0, 0, ScoreSemReqSeizeWait_Post_Status_Ok,
+    ScoreSemReqSeizeWait_Post_Count_MinusOne,
+    ScoreSemReqSeizeWait_Post_Timer_No }
+};
+
+static const uint8_t
+ScoreSemReqSeizeWait_Map[] = {
+  0, 1
+};
+
+static size_t ScoreSemReqSeizeWait_Scope( void *arg, char *buf, size_t n )
+{
+  ScoreSemReqSeizeWait_Context *ctx;
+
+  ctx = arg;
+
+  if ( ctx->in_action_loop ) {
+    return T_get_scope( ScoreSemReqSeizeWait_PreDesc, buf, n, ctx->pcs );
+  }
+
+  return 0;
+}
+
+static T_fixture ScoreSemReqSeizeWait_Fixture = {
+  .setup = NULL,
+  .stop = NULL,
+  .teardown = NULL,
+  .scope = ScoreSemReqSeizeWait_Scope,
+  .initial_context = &ScoreSemReqSeizeWait_Instance
+};
+
+static inline ScoreSemReqSeizeWait_Entry ScoreSemReqSeizeWait_GetEntry(
+  size_t index
+)
+{
+  return ScoreSemReqSeizeWait_Entries[
+    ScoreSemReqSeizeWait_Map[ index ]
+  ];
+}
+
+static T_fixture_node ScoreSemReqSeizeWait_Node;
+
+void ScoreSemReqSeizeWait_Run( TQSemContext *tq_ctx )
+{
+  ScoreSemReqSeizeWait_Context *ctx;
+  size_t index;
+
+  ctx = &ScoreSemReqSeizeWait_Instance;
+  ctx->tq_ctx = tq_ctx;
+
+  ctx = T_push_fixture(
+    &ScoreSemReqSeizeWait_Node,
+    &ScoreSemReqSeizeWait_Fixture
+  );
+  ctx->in_action_loop = true;
+  index = 0;
+
+  for (
+    ctx->pcs[ 0 ] = ScoreSemReqSeizeWait_Pre_Count_Zero;
+    ctx->pcs[ 0 ] < ScoreSemReqSeizeWait_Pre_Count_NA;
+    ++ctx->pcs[ 0 ]
+  ) {
+    ScoreSemReqSeizeWait_Entry entry;
+
+    entry = ScoreSemReqSeizeWait_GetEntry( index );
+    ++index;
+
+    ScoreSemReqSeizeWait_Prepare( ctx );
+    ScoreSemReqSeizeWait_Pre_Count_Prepare( ctx, ctx->pcs[ 0 ] );
+    ScoreSemReqSeizeWait_Action( ctx );
+    ScoreSemReqSeizeWait_Post_Status_Check( ctx, entry.Post_Status );
+    ScoreSemReqSeizeWait_Post_Count_Check( ctx, entry.Post_Count );
+    ScoreSemReqSeizeWait_Post_Timer_Check( ctx, entry.Post_Timer );
+  }
+
+  T_pop_fixture();
+}
+
+/** @} */
diff --git a/testsuites/validation/tr-sem-seize-wait.h b/testsuites/validation/tr-sem-seize-wait.h
new file mode 100644
index 0000000000..91d1790347
--- /dev/null
+++ b/testsuites/validation/tr-sem-seize-wait.h
@@ -0,0 +1,103 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestCaseScoreSemReqSeizeWait
+ */
+
+/*
+ * 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
+ */
+
+#ifndef _TR_SEM_SEIZE_WAIT_H
+#define _TR_SEM_SEIZE_WAIT_H
+
+#include "tx-thread-queue.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @addtogroup RTEMSTestCaseScoreSemReqSeizeWait
+ *
+ * @{
+ */
+
+typedef enum {
+  ScoreSemReqSeizeWait_Pre_Count_Zero,
+  ScoreSemReqSeizeWait_Pre_Count_Positive,
+  ScoreSemReqSeizeWait_Pre_Count_NA
+} ScoreSemReqSeizeWait_Pre_Count;
+
+typedef enum {
+  ScoreSemReqSeizeWait_Post_Status_Ok,
+  ScoreSemReqSeizeWait_Post_Status_Enqueued,
+  ScoreSemReqSeizeWait_Post_Status_NA
+} ScoreSemReqSeizeWait_Post_Status;
+
+typedef enum {
+  ScoreSemReqSeizeWait_Post_Count_Nop,
+  ScoreSemReqSeizeWait_Post_Count_MinusOne,
+  ScoreSemReqSeizeWait_Post_Count_NA
+} ScoreSemReqSeizeWait_Post_Count;
+
+typedef enum {
+  ScoreSemReqSeizeWait_Post_Timer_Optional,
+  ScoreSemReqSeizeWait_Post_Timer_No,
+  ScoreSemReqSeizeWait_Post_Timer_NA
+} ScoreSemReqSeizeWait_Post_Timer;
+
+/**
+ * @brief Runs the parameterized test case.
+ *
+ * @param[in,out] tq_ctx is the semaphore thread queue context.
+ */
+void ScoreSemReqSeizeWait_Run( TQSemContext *tq_ctx );
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _TR_SEM_SEIZE_WAIT_H */