testsuites/validation/tr-fatal-too-large-tls-size.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup AcfgValFatalTooLargeTlsSize
0007  */
0008
0009 /*
0010  * Copyright (C) 2021 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.h>
0056 #include <rtems/score/thread.h>
0057
0058 #include "tr-fatal-too-large-tls-size.h"
0059
0060 #include <rtems/test.h>
0061
0062 /**
0063  * @defgroup AcfgValFatalTooLargeTlsSize \
0064  *   spec:/acfg/val/fatal-too-large-tls-size
0065  *
0066  * @ingroup TestsuitesFatalTooLargeTlsSize
0067  *
0068  * @brief Tests a fatal error.
0069  *
0070  * This test case performs the following actions:
0071  *
0072  * - The test action is carried out by providing a thread-local storage object
0073  *   of sufficient size with respect to the application configuration of the
0074  *   test suite.
0075  *
0076  *   - Check that the expected fatal source is present.
0077  *
0078  *   - Check that the expected fatal code is present.
0079  *
0080  *   - Check that the CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE application
0081  *     configuration option resulted in the expected system setting.
0082  *
0083  * @{
0084  */
0085
0086 /**
0087  * @brief Test context for spec:/acfg/val/fatal-too-large-tls-size test case.
0088  */
0089 typedef struct {
0090   /**
0091    * @brief This member contains a copy of the corresponding
0092    *   AcfgValFatalTooLargeTlsSize_Run() parameter.
0093    */
0094   rtems_fatal_source source;
0095
0096   /**
0097    * @brief This member contains a copy of the corresponding
0098    *   AcfgValFatalTooLargeTlsSize_Run() parameter.
0099    */
0100   rtems_fatal_code code;
0101 } AcfgValFatalTooLargeTlsSize_Context;
0102
0103 static AcfgValFatalTooLargeTlsSize_Context
0104   AcfgValFatalTooLargeTlsSize_Instance;
0105
0106 static volatile _Thread_local uint8_t large_tls_object[ RTEMS_TASK_STORAGE_ALIGNMENT + 1 ];
0107
0108 static volatile bool shall_not_load_the_value;
0109
0110 static T_fixture AcfgValFatalTooLargeTlsSize_Fixture = {
0111   .setup = NULL,
0112   .stop = NULL,
0113   .teardown = NULL,
0114   .scope = NULL,
0115   .initial_context = &AcfgValFatalTooLargeTlsSize_Instance
0116 };
0117
0118 /**
0119  * @brief The test action is carried out by providing a thread-local storage
0120  *   object of sufficient size with respect to the application configuration of
0121  *   the test suite.
0122  */
0123 static void AcfgValFatalTooLargeTlsSize_Action_0(
0124   AcfgValFatalTooLargeTlsSize_Context *ctx
0125 )
0126 {
0127   if ( shall_not_load_the_value ) {
0128     uint8_t value;
0129
0130     value = large_tls_object[ 0 ];
0131     RTEMS_OBFUSCATE_VARIABLE( value );
0132   }
0133
0134   /*
0135    * Check that the expected fatal source is present.
0136    */
0137   T_step_eq_int( 0, ctx->source, INTERNAL_ERROR_CORE );
0138
0139   /*
0140    * Check that the expected fatal code is present.
0141    */
0142   T_step_eq_ulong(
0143     1,
0144     ctx->code,
0145     INTERNAL_ERROR_TOO_LARGE_TLS_SIZE
0146   );
0147
0148   /*
0149    * Check that the CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE application
0150    * configuration option resulted in the expected system setting.
0151    */
0152   T_step_eq_sz(
0153     2,
0154     _Thread_Maximum_TLS_size,
0155     RTEMS_TASK_STORAGE_ALIGNMENT
0156   );
0157 }
0158
0159 void AcfgValFatalTooLargeTlsSize_Run(
0160   rtems_fatal_source source,
0161   rtems_fatal_code   code
0162 )
0163 {
0164   AcfgValFatalTooLargeTlsSize_Context *ctx;
0165
0166   ctx = &AcfgValFatalTooLargeTlsSize_Instance;
0167   ctx->source = source;
0168   ctx->code = code;
0169
0170   ctx = T_case_begin(
0171     "AcfgValFatalTooLargeTlsSize",
0172     &AcfgValFatalTooLargeTlsSize_Fixture
0173   );
0174
0175   T_plan( 3 );
0176
0177   AcfgValFatalTooLargeTlsSize_Action_0( ctx );
0178
0179   T_case_end();
0180 }
0181
0182 /** @} */