validation/bsps/tc-fatal-smp-shutdown.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup BspValFatalSmpShutdown
0007  */
0008
0009 /*
0010  * Copyright (C) 2021, 2024 embedded brains GmbH & Co. KG
0011  *
0012  * Redistribution and use in source and binary forms, with or without
0013  * modification, are permitted provided that the following conditions
0014  * are met:
0015  * 1. Redistributions of source code must retain the above copyright
0016  *    notice, this list of conditions and the following disclaimer.
0017  * 2. Redistributions in binary form must reproduce the above copyright
0018  *    notice, this list of conditions and the following disclaimer in the
0019  *    documentation and/or other materials provided with the distribution.
0020  *
0021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0022  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0024  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0025  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0026  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0027  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0030  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0031  * POSSIBILITY OF SUCH DAMAGE.
0032  */
0033
0034 /*
0035  * This file is part of the RTEMS quality process and was automatically
0036  * generated.  If you find something that needs to be fixed or
0037  * worded better please post a report or patch to an RTEMS mailing list
0038  * or raise a bug report:
0039  *
0040  * https://www.rtems.org/bugs.html
0041  *
0042  * For information on updating and regenerating please refer to the How-To
0043  * section in the Software Requirements Engineering chapter of the
0044  * RTEMS Software Engineering manual.  The manual is provided as a part of
0045  * a release.  For development sources please refer to the online
0046  * documentation at:
0047  *
0048  * https://docs.rtems.org
0049  */
0050
0051 #ifdef HAVE_CONFIG_H
0052 #include "config.h"
0053 #endif
0054
0055 #include <rtems/sysinit.h>
0056 #include <rtems/score/smpimpl.h>
0057
0058 #include "tx-support.h"
0059
0060 #include <rtems/test.h>
0061
0062 /**
0063  * @defgroup BspValFatalSmpShutdown spec:/bsp/val/fatal-smp-shutdown
0064  *
0065  * @ingroup TestsuitesBspsFatalExtension
0066  *
0067  * @brief Tests the BSP-specific fatal extension shutdown procedure.
0068  *
0069  * This test case performs the following actions:
0070  *
0071  * - Check the effects of the BSP-specific fatal extension.
0072  *
0073  *   - Wait until the second processor is idle.
0074  *
0075  *   - Check that the RTEMS_FATAL_SOURCE_SMP with SMP_FATAL_SHUTDOWN_RESPONSE
0076  *     fatal error occurred exactly once.
0077  *
0078  *   - Check that the RTEMS_FATAL_SOURCE_SMP with SMP_FATAL_SHUTDOWN_RESPONSE
0079  *     fatal error occurred on the second processor.
0080  *
0081  * @{
0082  */
0083
0084 static Atomic_Uint shutdown_response_counter;
0085
0086 static uint32_t shutdown_response_cpu_index = UINT32_MAX;
0087
0088 static unsigned int Add( Atomic_Uint *a, unsigned int b )
0089 {
0090   return _Atomic_Fetch_add_uint( a, b, ATOMIC_ORDER_RELAXED );
0091 }
0092
0093 static void ShutdownFatalHandler(
0094   rtems_fatal_source source,
0095   rtems_fatal_code   code,
0096   void              *arg
0097 )
0098 {
0099   T_null( arg );
0100
0101   if (
0102     source == RTEMS_FATAL_SOURCE_SMP &&
0103     code == SMP_FATAL_SHUTDOWN_RESPONSE
0104   ) {
0105     (void) Add( &shutdown_response_counter, 1 );
0106     shutdown_response_cpu_index = rtems_scheduler_get_processor();
0107   }
0108 }
0109
0110 static void InitBspValFatalSmpShutdown( void )
0111 {
0112   SetFatalHandler( ShutdownFatalHandler, NULL );
0113 }
0114
0115 RTEMS_SYSINIT_ITEM(
0116   InitBspValFatalSmpShutdown,
0117   RTEMS_SYSINIT_DEVICE_DRIVERS,
0118   RTEMS_SYSINIT_ORDER_MIDDLE
0119 );
0120
0121 static Atomic_Uint idle_counter;
0122
0123 void *__real__CPU_Thread_Idle_body( void *arg );
0124
0125 void *__wrap__CPU_Thread_Idle_body( void *arg );
0126
0127 void *__wrap__CPU_Thread_Idle_body( void *arg )
0128 {
0129   (void) Add( &idle_counter, 1 );
0130   return __real__CPU_Thread_Idle_body( arg );
0131 }
0132
0133 /**
0134  * @brief Check the effects of the BSP-specific fatal extension.
0135  */
0136 static void BspValFatalSmpShutdown_Action_0( void )
0137 {
0138   unsigned int counter;
0139
0140   /*
0141    * Wait until the second processor is idle.
0142    */
0143   do {
0144     counter = _Atomic_Load_uint( &idle_counter, ATOMIC_ORDER_RELAXED );
0145   } while ( counter != 2U );
0146
0147   /*
0148    * Check that the RTEMS_FATAL_SOURCE_SMP with SMP_FATAL_SHUTDOWN_RESPONSE
0149    * fatal error occurred exactly once.
0150    */
0151   counter = Add( &shutdown_response_counter, 0 );
0152   T_step_eq_uint( 0, counter, 1 );
0153
0154   /*
0155    * Check that the RTEMS_FATAL_SOURCE_SMP with SMP_FATAL_SHUTDOWN_RESPONSE
0156    * fatal error occurred on the second processor.
0157    */
0158   T_step_eq_u32( 1, shutdown_response_cpu_index, 1 );
0159 }
0160
0161 /**
0162  * @fn void T_case_body_BspValFatalSmpShutdown( void )
0163  */
0164 T_TEST_CASE( BspValFatalSmpShutdown )
0165 {
0166   T_plan( 2 );
0167
0168   BspValFatalSmpShutdown_Action_0();
0169 }
0170
0171 /** @} */