From 00aae45698b9c791332fa78e5398ee5dfeac81c4 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Thu, 8 Apr 2021 16:00:30 +0200 Subject: validation: Thread queue FIFO enqueue test runner --- spec/build/testsuites/validation/validation-0.yml | 1 + testsuites/validation/tr-tq-enqueue-fifo.c | 308 ++++++++++++++++++++++ testsuites/validation/tr-tq-enqueue-fifo.h | 91 +++++++ 3 files changed, 400 insertions(+) create mode 100644 testsuites/validation/tr-tq-enqueue-fifo.c create mode 100644 testsuites/validation/tr-tq-enqueue-fifo.h diff --git a/spec/build/testsuites/validation/validation-0.yml b/spec/build/testsuites/validation/validation-0.yml index fc711af3dd..7a19ef9127 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-fifo.c - testsuites/validation/ts-validation-0.c stlib: [] target: testsuites/validation/ts-validation-0.exe diff --git a/testsuites/validation/tr-tq-enqueue-fifo.c b/testsuites/validation/tr-tq-enqueue-fifo.c new file mode 100644 index 0000000000..2be9e1a933 --- /dev/null +++ b/testsuites/validation/tr-tq-enqueue-fifo.c @@ -0,0 +1,308 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseScoreTqReqEnqueueFifo + */ + +/* + * 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-fifo.h" + +#include + +/** + * @defgroup RTEMSTestCaseScoreTqReqEnqueueFifo spec:/score/tq/req/enqueue-fifo + * + * @ingroup RTEMSTestSuiteTestsuitesValidation0 + * + * @{ + */ + +/** + * @brief Test context for spec:/score/tq/req/enqueue-fifo test case. + */ +typedef struct { + /** + * @brief This member contains a copy of the corresponding + * ScoreTqReqEnqueueFifo_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; +} ScoreTqReqEnqueueFifo_Context; + +static ScoreTqReqEnqueueFifo_Context + ScoreTqReqEnqueueFifo_Instance; + +static const char * const ScoreTqReqEnqueueFifo_PreDesc_Queue[] = { + "Empty", + "NonEmpty", + "NA" +}; + +static const char * const * const ScoreTqReqEnqueueFifo_PreDesc[] = { + ScoreTqReqEnqueueFifo_PreDesc_Queue, + NULL +}; + +typedef ScoreTqReqEnqueueFifo_Context Context; + +static const rtems_tcb *GetUnblock( Context *ctx, size_t *index ) +{ + return TQGetNextUnblock( ctx->tq_ctx, index )->thread; +} + +static const rtems_tcb *GetTCB( Context *ctx, TQWorkerKind worker ) +{ + return ctx->tq_ctx->worker_tcb[ worker ]; +} + +static void ScoreTqReqEnqueueFifo_Pre_Queue_Prepare( + ScoreTqReqEnqueueFifo_Context *ctx, + ScoreTqReqEnqueueFifo_Pre_Queue state +) +{ + switch ( state ) { + case ScoreTqReqEnqueueFifo_Pre_Queue_Empty: { + /* + * While the queue is empty. + */ + ctx->tq_ctx->how_many = 1; + break; + } + + case ScoreTqReqEnqueueFifo_Pre_Queue_NonEmpty: { + /* + * While the queue is non-empty. + */ + ctx->tq_ctx->how_many = 2; + break; + } + + case ScoreTqReqEnqueueFifo_Pre_Queue_NA: + break; + } +} + +static void ScoreTqReqEnqueueFifo_Post_Position_Check( + ScoreTqReqEnqueueFifo_Context *ctx, + ScoreTqReqEnqueueFifo_Post_Position state +) +{ + size_t i; + + i = 0; + + /* Event receives */ + T_eq_ptr( GetUnblock( ctx, &i ), GetTCB( ctx, TQ_BLOCKER_C ) ); + T_eq_ptr( GetUnblock( ctx, &i ), GetTCB( ctx, TQ_BLOCKER_A ) ); + + switch ( state ) { + case ScoreTqReqEnqueueFifo_Post_Position_First: { + /* + * The thread shall be the first thread in the queue. + */ + T_eq_ptr( GetUnblock( ctx, &i ), GetTCB( ctx, TQ_BLOCKER_C ) ); + T_eq_ptr( GetUnblock( ctx, &i ), NULL ); + break; + } + + case ScoreTqReqEnqueueFifo_Post_Position_Last: { + /* + * The thread shall be the last thread in the queue. + */ + T_eq_ptr( GetUnblock( ctx, &i ), GetTCB( ctx, TQ_BLOCKER_B ) ); + T_eq_ptr( GetUnblock( ctx, &i ), GetTCB( ctx, TQ_BLOCKER_C ) ); + T_eq_ptr( GetUnblock( ctx, &i ), NULL ); + break; + } + + case ScoreTqReqEnqueueFifo_Post_Position_NA: + break; + } +} + +static void ScoreTqReqEnqueueFifo_Setup( ScoreTqReqEnqueueFifo_Context *ctx ) +{ + TQSetPriority( ctx->tq_ctx, TQ_BLOCKER_A, PRIO_ULTRA_HIGH ); + TQSetPriority( ctx->tq_ctx, TQ_BLOCKER_B, PRIO_VERY_HIGH ); + TQSetPriority( ctx->tq_ctx, TQ_BLOCKER_C, PRIO_HIGH ); +} + +static void ScoreTqReqEnqueueFifo_Setup_Wrap( void *arg ) +{ + ScoreTqReqEnqueueFifo_Context *ctx; + + ctx = arg; + ctx->in_action_loop = false; + ScoreTqReqEnqueueFifo_Setup( ctx ); +} + +static void ScoreTqReqEnqueueFifo_Teardown( + ScoreTqReqEnqueueFifo_Context *ctx +) +{ + TQReset( ctx->tq_ctx ); +} + +static void ScoreTqReqEnqueueFifo_Teardown_Wrap( void *arg ) +{ + ScoreTqReqEnqueueFifo_Context *ctx; + + ctx = arg; + ctx->in_action_loop = false; + ScoreTqReqEnqueueFifo_Teardown( ctx ); +} + +static void ScoreTqReqEnqueueFifo_Action( ScoreTqReqEnqueueFifo_Context *ctx ) +{ + TQSend( ctx->tq_ctx, TQ_BLOCKER_A, TQ_EVENT_ENQUEUE_PREPARE ); + + if ( ctx->tq_ctx->how_many >= 2 ) { + TQSend( ctx->tq_ctx, TQ_BLOCKER_B, TQ_EVENT_ENQUEUE | TQ_EVENT_SURRENDER ); + } + + TQSchedulerRecordStart( ctx->tq_ctx ); + TQSend( ctx->tq_ctx, TQ_BLOCKER_C, TQ_EVENT_ENQUEUE | TQ_EVENT_SURRENDER ); + TQSend( ctx->tq_ctx, TQ_BLOCKER_A, TQ_EVENT_ENQUEUE_DONE ); + TQSchedulerRecordStop( ctx->tq_ctx ); +} + +typedef struct { + uint8_t Skip : 1; + uint8_t Pre_Queue_NA : 1; + uint8_t Post_Position : 2; +} ScoreTqReqEnqueueFifo_Entry; + +static const ScoreTqReqEnqueueFifo_Entry +ScoreTqReqEnqueueFifo_Entries[] = { + { 0, 0, ScoreTqReqEnqueueFifo_Post_Position_First }, + { 0, 0, ScoreTqReqEnqueueFifo_Post_Position_Last } +}; + +static const uint8_t +ScoreTqReqEnqueueFifo_Map[] = { + 0, 1 +}; + +static size_t ScoreTqReqEnqueueFifo_Scope( void *arg, char *buf, size_t n ) +{ + ScoreTqReqEnqueueFifo_Context *ctx; + + ctx = arg; + + if ( ctx->in_action_loop ) { + return T_get_scope( ScoreTqReqEnqueueFifo_PreDesc, buf, n, ctx->pcs ); + } + + return 0; +} + +static T_fixture ScoreTqReqEnqueueFifo_Fixture = { + .setup = ScoreTqReqEnqueueFifo_Setup_Wrap, + .stop = NULL, + .teardown = ScoreTqReqEnqueueFifo_Teardown_Wrap, + .scope = ScoreTqReqEnqueueFifo_Scope, + .initial_context = &ScoreTqReqEnqueueFifo_Instance +}; + +static inline ScoreTqReqEnqueueFifo_Entry ScoreTqReqEnqueueFifo_GetEntry( + size_t index +) +{ + return ScoreTqReqEnqueueFifo_Entries[ + ScoreTqReqEnqueueFifo_Map[ index ] + ]; +} + +static T_fixture_node ScoreTqReqEnqueueFifo_Node; + +void ScoreTqReqEnqueueFifo_Run( TQContext *tq_ctx ) +{ + ScoreTqReqEnqueueFifo_Context *ctx; + size_t index; + + ctx = &ScoreTqReqEnqueueFifo_Instance; + ctx->tq_ctx = tq_ctx; + + ctx = T_push_fixture( + &ScoreTqReqEnqueueFifo_Node, + &ScoreTqReqEnqueueFifo_Fixture + ); + ctx->in_action_loop = true; + index = 0; + + for ( + ctx->pcs[ 0 ] = ScoreTqReqEnqueueFifo_Pre_Queue_Empty; + ctx->pcs[ 0 ] < ScoreTqReqEnqueueFifo_Pre_Queue_NA; + ++ctx->pcs[ 0 ] + ) { + ScoreTqReqEnqueueFifo_Entry entry; + + entry = ScoreTqReqEnqueueFifo_GetEntry( index ); + ++index; + + ScoreTqReqEnqueueFifo_Pre_Queue_Prepare( ctx, ctx->pcs[ 0 ] ); + ScoreTqReqEnqueueFifo_Action( ctx ); + ScoreTqReqEnqueueFifo_Post_Position_Check( ctx, entry.Post_Position ); + } + + T_pop_fixture(); +} + +/** @} */ diff --git a/testsuites/validation/tr-tq-enqueue-fifo.h b/testsuites/validation/tr-tq-enqueue-fifo.h new file mode 100644 index 0000000000..776cded8b9 --- /dev/null +++ b/testsuites/validation/tr-tq-enqueue-fifo.h @@ -0,0 +1,91 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSTestCaseScoreTqReqEnqueueFifo + */ + +/* + * 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_FIFO_H +#define _TR_TQ_ENQUEUE_FIFO_H + +#include "tx-thread-queue.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @addtogroup RTEMSTestCaseScoreTqReqEnqueueFifo + * + * @{ + */ + +typedef enum { + ScoreTqReqEnqueueFifo_Pre_Queue_Empty, + ScoreTqReqEnqueueFifo_Pre_Queue_NonEmpty, + ScoreTqReqEnqueueFifo_Pre_Queue_NA +} ScoreTqReqEnqueueFifo_Pre_Queue; + +typedef enum { + ScoreTqReqEnqueueFifo_Post_Position_First, + ScoreTqReqEnqueueFifo_Post_Position_Last, + ScoreTqReqEnqueueFifo_Post_Position_NA +} ScoreTqReqEnqueueFifo_Post_Position; + +/** + * @brief Runs the parameterized test case. + * + * @param[in,out] tq_ctx is the thread queue test context. + */ +void ScoreTqReqEnqueueFifo_Run( TQContext *tq_ctx ); + +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif /* _TR_TQ_ENQUEUE_FIFO_H */ -- cgit v1.2.3