CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE

Add this application configuration option.  This configuration option can be
used to reserve space for the dynamic linking of modules with thread-local
storage objects.

Add RTEMS_TASK_STORAGE_ALIGNMENT to define the minium alignment of a
thread-local storage size.

Update #4074.

cpukit/doxygen/appl-config.h

@@ -801,6 +801,43 @@
  */
 #define CONFIGURE_MAXIMUM_TASKS
 
+/**
+ * @brief This configuration option is an integer define.
+ *
+ * If the value of this configuration option is greater than zero, then it
+ * defines the maximum thread-local storage size, otherwise the thread-local
+ * storage size is defined by the linker depending on the thread-local storage
+ * objects used by the application in the statically-linked executable.
+ *
+ * @par Default Value
+ * The default value is 0.
+ *
+ * @par Value Constraints
+ * The value of this configuration option shall be greater than or equal to 0
+ * and less than or equal to <a
+ * href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
+ *
+ * @par Notes
+ * @parblock
+ * This configuration option can be used to reserve space for the dynamic
+ * linking of modules with thread-local storage objects.
+ *
+ * If the thread-local storage size defined by the thread-local storage objects
+ * used by the application in the statically-linked executable is greater than
+ * a non-zero value of this configuration option, then a fatal error will occur
+ * during system initialization.
+ *
+ * Use RTEMS_ALIGN_UP() and #RTEMS_TASK_STORAGE_ALIGNMENT to adjust the size to
+ * meet the minimum alignment requirement of a thread-local storage area.
+ *
+ * The actual thread-local storage size is determined when the application
+ * executable is linked.  The ``rtems-exeinfo`` command line tool included in
+ * the RTEMS Tools can be used to obtain the thread-local storage size and
+ * alignment of an application executable.
+ * @endparblock
+ */
+#define CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
+
 /**
  * @brief This configuration option is an integer define.
  *

cpukit/include/rtems/confdefs/threads.h

@@ -84,6 +84,10 @@
   #define CONFIGURE_MAXIMUM_THREAD_NAME_SIZE THREAD_DEFAULT_MAXIMUM_NAME_SIZE
 #endif
 
+#ifndef CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
+  #define CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE 0
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -125,6 +129,9 @@ typedef union {
 
 const size_t _Thread_Maximum_name_size = CONFIGURE_MAXIMUM_THREAD_NAME_SIZE;
 
+const size_t _Thread_Maximum_TLS_size =
+  CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE;
+
 struct Thread_Configured_control {
   Thread_Control Control;
   #if CONFIGURE_MAXIMUM_USER_EXTENSIONS > 0

cpukit/include/rtems/rtems/tasks.h

@@ -164,6 +164,15 @@ rtems_status_code rtems_task_create(
   rtems_id            *id
 );
 
+/**
+ * @brief This constant defines the recommended alignment of a task storage
+ *   area in bytes.
+ *
+ * Use it with RTEMS_ALIGNED() to define the alignment of a statically
+ * allocated task storage area.
+ */
+#define RTEMS_TASK_STORAGE_ALIGNMENT CPU_HEAP_ALIGNMENT
+
 /**
  * @brief RTEMS Task Name to Id
  *

cpukit/include/rtems/score/interr.h

@@ -203,7 +203,8 @@ typedef enum {
   INTERNAL_ERROR_LIBIO_STDERR_FD_OPEN_FAILED = 37,
   INTERNAL_ERROR_ILLEGAL_USE_OF_FLOATING_POINT_UNIT = 38,
   INTERNAL_ERROR_ARC4RANDOM_GETENTROPY_FAIL = 39,
-  INTERNAL_ERROR_NO_MEMORY_FOR_PER_CPU_DATA = 40
+  INTERNAL_ERROR_NO_MEMORY_FOR_PER_CPU_DATA = 40,
+  INTERNAL_ERROR_TOO_LARGE_TLS_SIZE = 41
 } Internal_errors_Core_list;
 
 typedef CPU_Uint32ptr Internal_errors_t;

cpukit/include/rtems/score/thread.h

@@ -953,6 +953,16 @@ extern const size_t _Thread_Initial_thread_count;
  */
 extern const size_t _Thread_Maximum_name_size;
 
+/**
+ * @brief If this constant is greater than zero, then it defines the maximum
+ * thread-local storage size, otherwise the thread-local storage size is defined
+ * by the linker depending on the thread-local storage objects used by the
+ * application in the statically-linked executable.
+ *
+ * This value is provided via <rtems/confdefs.h>.
+ */
+extern const size_t _Thread_Maximum_TLS_size;
+
 /**
  * @brief The configured thread control block.
  *

cpukit/sapi/src/interrtext.c

@@ -7,7 +7,7 @@
  */
 
 /*
- * Copyright (c) 2012, 2018 embedded brains GmbH.  All rights reserved.
+ * Copyright (c) 2012, 2020 embedded brains GmbH.  All rights reserved.
  *
  *  embedded brains GmbH
  *  Dornierstr. 4
@@ -67,7 +67,8 @@ static const char *const internal_error_text[] = {
   "INTERNAL_ERROR_LIBIO_STDERR_FD_OPEN_FAILED",
   "INTERNAL_ERROR_ILLEGAL_USE_OF_FLOATING_POINT_UNIT",
   "INTERNAL_ERROR_ARC4RANDOM_GETENTROPY_FAIL",
-  "INTERNAL_ERROR_NO_MEMORY_FOR_PER_CPU_DATA"
+  "INTERNAL_ERROR_NO_MEMORY_FOR_PER_CPU_DATA",
+  "INTERNAL_ERROR_TOO_LARGE_TLS_SIZE"
 };
 
 const char *rtems_internal_error_text( rtems_fatal_code error )

cpukit/score/src/tlsallocsize.c

@@ -1,7 +1,7 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /*
- * SPDX-License-Identifier: BSD-2-Clause
+ * Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
- *
- * Copyright (C) 2014, 2019 embedded brains GmbH
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -30,6 +30,8 @@
 #endif
 
 #include <rtems/score/tls.h>
+#include <rtems/score/interr.h>
+#include <rtems/score/thread.h>
 
 static uintptr_t _TLS_Allocation_size;
 
@@ -65,6 +67,14 @@ uintptr_t _TLS_Get_allocation_size( void )
     allocation_size += sizeof(TLS_Dynamic_thread_vector);
 #endif
 
+    if ( _Thread_Maximum_TLS_size != 0 ) {
+      if ( allocation_size <= _Thread_Maximum_TLS_size ) {
+        allocation_size = _Thread_Maximum_TLS_size;
+      } else {
+        _Internal_error( INTERNAL_ERROR_TOO_LARGE_TLS_SIZE );
+      }
+    }
+
     _TLS_Allocation_size = allocation_size;
   }
 

spec/build/testsuites/sptests/grp.yml

@@ -256,6 +256,8 @@ links:
   uid: spfatal31
 - role: build-dependency
   uid: spfatal32
+- role: build-dependency
+  uid: spfatal33
 - role: build-dependency
   uid: spfifo01
 - role: build-dependency

spec/build/testsuites/sptests/spfatal33.yml

@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+build-type: test-program
+cflags: []
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+cppflags: []
+cxxflags: []
+enabled-by: true
+features: c cprogram
+includes: []
+ldflags: []
+links: []
+source:
+- testsuites/sptests/spfatal33/init.c
+stlib: []
+target: testsuites/sptests/spfatal33.exe
+type: build
+use-after: []
+use-before: []

testsuites/sptests/spfatal33/init.c

@@ -0,0 +1,55 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/*
+ * Copyright (C) 2020 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.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "../spfatal_support/spfatal.h"
+
+#define FATAL_ERROR_TEST_NAME       "33"
+#define FATAL_ERROR_DESCRIPTION     "provoke too large TLS size"
+#define FATAL_ERROR_EXPECTED_SOURCE INTERNAL_ERROR_CORE
+#define FATAL_ERROR_EXPECTED_ERROR  INTERNAL_ERROR_TOO_LARGE_TLS_SIZE
+
+static _Thread_local short tls;
+
+static void force_error(void)
+{
+  long var;
+
+  var = tls;
+  RTEMS_OBFUSCATE_VARIABLE( var );
+  tls = var;
+
+  /* Not reached */
+  rtems_test_assert( 0 );
+}
+
+#define CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE 1
+
+#include "../spfatal_support/spfatalimpl.h"

testsuites/sptests/spfatal33/spfatal33.doc

@@ -0,0 +1,11 @@
+This file describes the directives and concepts tested by this test set.
+
+test set name: spfatal33
+
+directives:
+
+  - _TLS_Get_allocation_size()
+
+concepts:
+
+  - Provoke a too large TLS size.

testsuites/sptests/spfatal33/spfatal33.scn

@@ -0,0 +1,16 @@
+*** BEGIN OF TEST SPFATAL 33 ***
+*** TEST VERSION: 6.0.0.40a6a37e27a5e112bb3e383c196c6094f3498298
+*** TEST STATE: EXPECTED_PASS
+*** TEST BUILD: RTEMS_DEBUG
+*** TEST TOOLS: 10.2.1 20200904 (RTEMS 6, RSB 47f32b8b1a597b5ed3475722bdc155249ef51115, Newlib a0d7982)
+Fatal error (provoke too large TLS size) hit
+
+*** END OF TEST SPFATAL 33 ***
+
+
+*** FATAL ***
+fatal source: 0 (INTERNAL_ERROR_CORE)
+fatal code: 41 (INTERNAL_ERROR_TOO_LARGE_TLS_SIZE)
+RTEMS version: 6.0.0.40a6a37e27a5e112bb3e383c196c6094f3498298
+RTEMS tools: 10.2.1 20200904 (RTEMS 6, RSB 47f32b8b1a597b5ed3475722bdc155249ef51115, Newlib a0d7982)
+executing thread is NULL

testsuites/sptests/spinternalerror02/init.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, 2018 embedded brains GmbH.  All rights reserved.
+ * Copyright (c) 2012, 2020 embedded brains GmbH.  All rights reserved.
  *
  *  embedded brains GmbH
  *  Donierstr. 4
@@ -36,7 +36,7 @@ static void test_internal_error_text(void)
   } while ( text != text_last );
 
   rtems_test_assert(
-    error - 3 == INTERNAL_ERROR_NO_MEMORY_FOR_PER_CPU_DATA
+    error - 3 == INTERNAL_ERROR_TOO_LARGE_TLS_SIZE
   );
 }