validation: Thread queue enqueue deadlock runner

3 files changed, 398 insertions, 0 deletions

diff --git a/spec/build/testsuites/validation/validation-0.yml b/spec/build/testsuites/validation/validation-0.yml
index d735279272..cf229d7fb0 100644
--- a/spec/build/testsuites/validation/validation-0.yml
+++ b/spec/build/testsuites/validation/validation-0.yml
@@ -73,6 +73,7 @@ source:
 - testsuites/validation/tr-event-send-receive.c
 - testsuites/validation/tr-object-ident.c
 - testsuites/validation/tr-object-ident-local.c
+- testsuites/validation/tr-tq-enqueue-deadlock.c
 - testsuites/validation/tr-tq-enqueue-fifo.c
 - testsuites/validation/tr-tq-enqueue-priority.c
 - testsuites/validation/ts-validation-0.c
diff --git a/testsuites/validation/tr-tq-enqueue-deadlock.c b/testsuites/validation/tr-tq-enqueue-deadlock.c
new file mode 100644
index 0000000000..bdac9ab0fc
--- /dev/null
+++ b/testsuites/validation/tr-tq-enqueue-deadlock.c
@@ -0,0 +1,307 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestCaseScoreTqReqEnqueueDeadlock
+ */
+
+/*
+ * 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 "tr-tq-enqueue-deadlock.h"
+
+#include <rtems/test.h>
+
+/**
+ * @defgroup RTEMSTestCaseScoreTqReqEnqueueDeadlock \
+ *   spec:/score/tq/req/enqueue-deadlock
+ *
+ * @ingroup RTEMSTestSuiteTestsuitesValidation0
+ *
+ * @{
+ */
+
+/**
+ * @brief Test context for spec:/score/tq/req/enqueue-deadlock test case.
+ */
+typedef struct {
+  /**
+   * @brief If this member is true, then more than one mutex shall be used for
+   *   the deadlock scenario.
+   */
+  bool more;
+
+  /**
+   * @brief This member contains a copy of the corresponding
+   *   ScoreTqReqEnqueueDeadlock_Run() parameter.
+   */
+  TQContext *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;
+} ScoreTqReqEnqueueDeadlock_Context;
+
+static ScoreTqReqEnqueueDeadlock_Context
+  ScoreTqReqEnqueueDeadlock_Instance;
+
+static const char * const ScoreTqReqEnqueueDeadlock_PreDesc_Deadlock[] = {
+  "One",
+  "More",
+  "NA"
+};
+
+static const char * const * const ScoreTqReqEnqueueDeadlock_PreDesc[] = {
+  ScoreTqReqEnqueueDeadlock_PreDesc_Deadlock,
+  NULL
+};
+
+static void ScoreTqReqEnqueueDeadlock_Pre_Deadlock_Prepare(
+  ScoreTqReqEnqueueDeadlock_Context     *ctx,
+  ScoreTqReqEnqueueDeadlock_Pre_Deadlock state
+)
+{
+  switch ( state ) {
+    case ScoreTqReqEnqueueDeadlock_Pre_Deadlock_One: {
+      /*
+       * While the owner of the thread queue is enqueued on another thread
+       * queue owned by the calling thread.
+       */
+      ctx->more = false;
+      break;
+    }
+
+    case ScoreTqReqEnqueueDeadlock_Pre_Deadlock_More: {
+      /*
+       * While the owner of the thread queue is enqueued on another thread
+       * queue owned by a thread other than the calling thread, and so on,
+       * while the owner of the last thread queue of this dependency chain is
+       * enqueued on a thread queue owned by the calling thread.
+       */
+      ctx->more = true;
+      break;
+    }
+
+    case ScoreTqReqEnqueueDeadlock_Pre_Deadlock_NA:
+      break;
+  }
+}
+
+static void ScoreTqReqEnqueueDeadlock_Post_Status_Check(
+  ScoreTqReqEnqueueDeadlock_Context    *ctx,
+  ScoreTqReqEnqueueDeadlock_Post_Status state
+)
+{
+  switch ( state ) {
+    case ScoreTqReqEnqueueDeadlock_Post_Status_Deadlock: {
+      /*
+       * The return status of the directive call shall be derived from
+       * STATUS_DEADLOCK.
+       */
+      /* Checked by action */
+      break;
+    }
+
+    case ScoreTqReqEnqueueDeadlock_Post_Status_NA:
+      break;
+  }
+}
+
+static void ScoreTqReqEnqueueDeadlock_Action(
+  ScoreTqReqEnqueueDeadlock_Context *ctx
+)
+{
+  Status_Control status;
+
+  TQMutexObtain( ctx->tq_ctx, TQ_MUTEX_A );
+
+  if ( ctx->tq_ctx->enqueue_variant == TQ_ENQUEUE_STICKY ) {
+    TQSetScheduler(
+      ctx->tq_ctx,
+      TQ_BLOCKER_A,
+      ctx->tq_ctx->other_scheduler_id,
+      PRIO_HIGH
+    );
+  }
+
+  TQSendAndWaitForExecutionStop( ctx->tq_ctx, TQ_BLOCKER_A, TQ_EVENT_ENQUEUE );
+
+  if ( ctx->more ) {
+    TQSend( ctx->tq_ctx, TQ_BLOCKER_B, TQ_EVENT_MUTEX_B_OBTAIN );
+    TQSendAndWaitForExecutionStop(
+      ctx->tq_ctx,
+      TQ_BLOCKER_A,
+      TQ_EVENT_MUTEX_B_OBTAIN
+    );
+    TQSend( ctx->tq_ctx, TQ_BLOCKER_B, TQ_EVENT_MUTEX_A_OBTAIN );
+  } else {
+    TQSendAndWaitForExecutionStop(
+      ctx->tq_ctx,
+      TQ_BLOCKER_A,
+      TQ_EVENT_MUTEX_A_OBTAIN
+    );
+  }
+
+  status = TQEnqueue( ctx->tq_ctx, TQ_WAIT_FOREVER );
+  T_eq_int( status, TQConvertStatus( ctx->tq_ctx, STATUS_DEADLOCK ) );
+
+  TQMutexRelease( ctx->tq_ctx, TQ_MUTEX_A );
+
+  if ( ctx->more ) {
+    TQSend( ctx->tq_ctx, TQ_BLOCKER_B, TQ_EVENT_MUTEX_A_RELEASE );
+    TQSend( ctx->tq_ctx, TQ_BLOCKER_B, TQ_EVENT_MUTEX_B_RELEASE );
+    TQSend( ctx->tq_ctx, TQ_BLOCKER_A, TQ_EVENT_MUTEX_B_RELEASE );
+  } else {
+    TQSend( ctx->tq_ctx, TQ_BLOCKER_A, TQ_EVENT_MUTEX_A_RELEASE );
+  }
+
+  if ( ctx->tq_ctx->enqueue_variant == TQ_ENQUEUE_STICKY ) {
+    TQSend(
+      ctx->tq_ctx,
+      TQ_BLOCKER_A,
+      TQ_EVENT_SURRENDER | TQ_EVENT_RUNNER_SYNC
+    );
+    TQSynchronizeRunner();
+    TQSetScheduler(
+      ctx->tq_ctx,
+      TQ_BLOCKER_A,
+      ctx->tq_ctx->runner_scheduler_id,
+      PRIO_HIGH
+    );
+  } else {
+    TQSend( ctx->tq_ctx, TQ_BLOCKER_A, TQ_EVENT_SURRENDER );
+  }
+}
+
+typedef struct {
+  uint8_t Skip : 1;
+  uint8_t Pre_Deadlock_NA : 1;
+  uint8_t Post_Status : 1;
+} ScoreTqReqEnqueueDeadlock_Entry;
+
+static const ScoreTqReqEnqueueDeadlock_Entry
+ScoreTqReqEnqueueDeadlock_Entries[] = {
+  { 0, 0, ScoreTqReqEnqueueDeadlock_Post_Status_Deadlock }
+};
+
+static const uint8_t
+ScoreTqReqEnqueueDeadlock_Map[] = {
+  0, 0
+};
+
+static size_t ScoreTqReqEnqueueDeadlock_Scope( void *arg, char *buf, size_t n )
+{
+  ScoreTqReqEnqueueDeadlock_Context *ctx;
+
+  ctx = arg;
+
+  if ( ctx->in_action_loop ) {
+    return T_get_scope( ScoreTqReqEnqueueDeadlock_PreDesc, buf, n, ctx->pcs );
+  }
+
+  return 0;
+}
+
+static T_fixture ScoreTqReqEnqueueDeadlock_Fixture = {
+  .setup = NULL,
+  .stop = NULL,
+  .teardown = NULL,
+  .scope = ScoreTqReqEnqueueDeadlock_Scope,
+  .initial_context = &ScoreTqReqEnqueueDeadlock_Instance
+};
+
+static inline ScoreTqReqEnqueueDeadlock_Entry
+ScoreTqReqEnqueueDeadlock_GetEntry( size_t index )
+{
+  return ScoreTqReqEnqueueDeadlock_Entries[
+    ScoreTqReqEnqueueDeadlock_Map[ index ]
+  ];
+}
+
+static T_fixture_node ScoreTqReqEnqueueDeadlock_Node;
+
+void ScoreTqReqEnqueueDeadlock_Run( TQContext *tq_ctx )
+{
+  ScoreTqReqEnqueueDeadlock_Context *ctx;
+  size_t index;
+
+  ctx = &ScoreTqReqEnqueueDeadlock_Instance;
+  ctx->tq_ctx = tq_ctx;
+
+  ctx = T_push_fixture(
+    &ScoreTqReqEnqueueDeadlock_Node,
+    &ScoreTqReqEnqueueDeadlock_Fixture
+  );
+  ctx->in_action_loop = true;
+  index = 0;
+
+  for (
+    ctx->pcs[ 0 ] = ScoreTqReqEnqueueDeadlock_Pre_Deadlock_One;
+    ctx->pcs[ 0 ] < ScoreTqReqEnqueueDeadlock_Pre_Deadlock_NA;
+    ++ctx->pcs[ 0 ]
+  ) {
+    ScoreTqReqEnqueueDeadlock_Entry entry;
+
+    entry = ScoreTqReqEnqueueDeadlock_GetEntry( index );
+    ++index;
+
+    ScoreTqReqEnqueueDeadlock_Pre_Deadlock_Prepare( ctx, ctx->pcs[ 0 ] );
+    ScoreTqReqEnqueueDeadlock_Action( ctx );
+    ScoreTqReqEnqueueDeadlock_Post_Status_Check( ctx, entry.Post_Status );
+  }
+
+  T_pop_fixture();
+}
+
+/** @} */
diff --git a/testsuites/validation/tr-tq-enqueue-deadlock.h b/testsuites/validation/tr-tq-enqueue-deadlock.h
new file mode 100644
index 0000000000..6a988ee8f8
--- /dev/null
+++ b/testsuites/validation/tr-tq-enqueue-deadlock.h
@@ -0,0 +1,90 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestCaseScoreTqReqEnqueueDeadlock
+ */
+
+/*
+ * 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_TQ_ENQUEUE_DEADLOCK_H
+#define _TR_TQ_ENQUEUE_DEADLOCK_H
+
+#include "tx-thread-queue.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @addtogroup RTEMSTestCaseScoreTqReqEnqueueDeadlock
+ *
+ * @{
+ */
+
+typedef enum {
+  ScoreTqReqEnqueueDeadlock_Pre_Deadlock_One,
+  ScoreTqReqEnqueueDeadlock_Pre_Deadlock_More,
+  ScoreTqReqEnqueueDeadlock_Pre_Deadlock_NA
+} ScoreTqReqEnqueueDeadlock_Pre_Deadlock;
+
+typedef enum {
+  ScoreTqReqEnqueueDeadlock_Post_Status_Deadlock,
+  ScoreTqReqEnqueueDeadlock_Post_Status_NA
+} ScoreTqReqEnqueueDeadlock_Post_Status;
+
+/**
+ * @brief Runs the parameterized test case.
+ *
+ * @param[in,out] tq_ctx is the thread queue context.
+ */
+void ScoreTqReqEnqueueDeadlock_Run( TQContext *tq_ctx );
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _TR_TQ_ENQUEUE_DEADLOCK_H */