[RTEMS 5] Add support for IDLE Thread stack allocator
Joel Sherrill
joel at rtems.org
Mon Oct 4 16:11:06 UTC 2021
Add a stack allocator hook specifically for allocation of IDLE thread stacks.
This allows the user to decide if IDLE thread stacks are statically allocated
or handled by the same custom allocator mechanism as other thread stacks.
Closes #4520.
---
cpukit/include/rtems/confdefs/percpu.h | 20 +++-
cpukit/include/rtems/confdefs/wkspace.h | 13 +++
cpukit/include/rtems/config.h | 3 +
cpukit/include/rtems/score/stack.h | 24 +++++
cpukit/score/src/stackallocator.c | 3 +
cpukit/score/src/threadcreateidle.c | 18 +++-
testsuites/sptests/spstkalloc03/init.c | 98 +++++++++++++++++++
.../sptests/spstkalloc03/spstkalloc03.doc | 19 ++++
.../sptests/spstkalloc03/spstkalloc03.scn | 2 +
9 files changed, 192 insertions(+), 8 deletions(-)
create mode 100644 testsuites/sptests/spstkalloc03/init.c
create mode 100644 testsuites/sptests/spstkalloc03/spstkalloc03.doc
create mode 100644 testsuites/sptests/spstkalloc03/spstkalloc03.scn
diff --git a/cpukit/include/rtems/confdefs/percpu.h b/cpukit/include/rtems/confdefs/percpu.h
index f3a9a4f3e7..a6ba4fece0 100644
--- a/cpukit/include/rtems/confdefs/percpu.h
+++ b/cpukit/include/rtems/confdefs/percpu.h
@@ -133,11 +133,21 @@ RTEMS_DEFINE_GLOBAL_SYMBOL(
const size_t _Thread_Idle_stack_size = CONFIGURE_IDLE_TASK_STACK_SIZE;
-char _Thread_Idle_stacks[
- _CONFIGURE_MAXIMUM_PROCESSORS
- * ( CONFIGURE_IDLE_TASK_STACK_SIZE + CPU_IDLE_TASK_IS_FP * CONTEXT_FP_SIZE )
-] RTEMS_ALIGNED( CPU_INTERRUPT_STACK_ALIGNMENT )
-RTEMS_SECTION( ".rtemsstack.idle" );
+/*
+ * If the user provides a custom idle stack allocator, then we do not need
+ * memory reserved for the stacks but the symbol is still referenced in
+ * threadcreateidle.c. The code path just never uses it. Make it minimal
+ * size to proceed.
+ */
+ char _Thread_Idle_stacks[
+#ifdef CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
+ 1
+#else
+ _CONFIGURE_MAXIMUM_PROCESSORS
+ * ( CONFIGURE_IDLE_TASK_STACK_SIZE + CPU_IDLE_TASK_IS_FP * CONTEXT_FP_SIZE )
+#endif
+ ] RTEMS_ALIGNED( CPU_INTERRUPT_STACK_ALIGNMENT )
+ RTEMS_SECTION( ".rtemsstack.idle" );
#if defined(CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION) && \
!defined(CONFIGURE_IDLE_TASK_BODY)
diff --git a/cpukit/include/rtems/confdefs/wkspace.h b/cpukit/include/rtems/confdefs/wkspace.h
index 484dde20ea..abe4cd50af 100644
--- a/cpukit/include/rtems/confdefs/wkspace.h
+++ b/cpukit/include/rtems/confdefs/wkspace.h
@@ -132,12 +132,14 @@ const uintptr_t _Stack_Space_size = _CONFIGURE_STACK_SPACE_SIZE;
#if defined(CONFIGURE_TASK_STACK_ALLOCATOR) \
&& defined(CONFIGURE_TASK_STACK_DEALLOCATOR)
+ /* Custom allocator may or may not use the work space. */
#ifdef CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE
const bool _Stack_Allocator_avoids_workspace = true;
#else
const bool _Stack_Allocator_avoids_workspace = false;
#endif
+ /* Custom allocator may or may not need initialization. */
#ifdef CONFIGURE_TASK_STACK_ALLOCATOR_INIT
const Stack_Allocator_initialize _Stack_Allocator_initialize =
CONFIGURE_TASK_STACK_ALLOCATOR_INIT;
@@ -145,11 +147,22 @@ const uintptr_t _Stack_Space_size = _CONFIGURE_STACK_SPACE_SIZE;
const Stack_Allocator_initialize _Stack_Allocator_initialize = NULL;
#endif
+ /* Custom allocator must include allocate and free */
const Stack_Allocator_allocate _Stack_Allocator_allocate =
CONFIGURE_TASK_STACK_ALLOCATOR;
const Stack_Allocator_free _Stack_Allocator_free =
CONFIGURE_TASK_STACK_DEALLOCATOR;
+
+ /* Custom allocator MAY include allocate IDLE thread stacks */
+ #ifdef CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE
+ const Stack_Allocator_allocate_for_idle _Stack_Allocator_allocate_for_idle =
+ CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE;
+ #else
+ const Stack_Allocator_allocate_for_idle _Stack_Allocator_allocate_for_idle =
+ NULL;
+ #endif
+
#elif defined(CONFIGURE_TASK_STACK_ALLOCATOR) \
|| defined(CONFIGURE_TASK_STACK_DEALLOCATOR)
#error "CONFIGURE_TASK_STACK_ALLOCATOR and CONFIGURE_TASK_STACK_DEALLOCATOR must be both defined or both undefined"
diff --git a/cpukit/include/rtems/config.h b/cpukit/include/rtems/config.h
index e82c7abf11..a826581658 100644
--- a/cpukit/include/rtems/config.h
+++ b/cpukit/include/rtems/config.h
@@ -129,6 +129,9 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
#define rtems_configuration_get_stack_free_hook() \
(_Stack_Allocator_free)
+#define rtems_configuration_get_stack_allocate_for_idle_hook() \
+ (_Stack_Allocator_allocate_for_idle)
+
/**
* This macro assists in accessing the field which indicates whether
* RTEMS is responsible for zeroing the Executive Workspace.
diff --git a/cpukit/include/rtems/score/stack.h b/cpukit/include/rtems/score/stack.h
index df1df74867..9c60b4f15e 100644
--- a/cpukit/include/rtems/score/stack.h
+++ b/cpukit/include/rtems/score/stack.h
@@ -81,6 +81,23 @@ typedef void *( *Stack_Allocator_allocate )( size_t stack_size );
*/
typedef void ( *Stack_Allocator_free )( void *addr );
+/**
+ * @brief Stack allocator allocate for idle handler.
+ *
+ * The allocate for idle handler is optional even when the user thread stack
+ * allocator and deallocator are configured.
+ *
+ * @param cpu The index of the CPU for the IDLE thread using this stack
+ * @param stack_size The size of the stack area to allocate in bytes.
+ *
+ * @retval NULL Not enough memory.
+ * @retval other Pointer to begin of stack area.
+ */
+typedef void *( *Stack_Allocator_allocate_for_idle )(
+ uint32_t cpu,
+ size_t stack_size
+);
+
/**
* @brief The minimum stack size.
*
@@ -124,6 +141,13 @@ extern const Stack_Allocator_allocate _Stack_Allocator_allocate;
extern const Stack_Allocator_free _Stack_Allocator_free;
/** @} */
+/**
+ * @brief The stack allocator allocate stack for idle thread handler.
+ *
+ * Application provided via <rtems/confdefs.h>.
+ */
+extern const Stack_Allocator_allocate_for_idle
+ _Stack_Allocator_allocate_for_idle;
#ifdef __cplusplus
}
diff --git a/cpukit/score/src/stackallocator.c b/cpukit/score/src/stackallocator.c
index 404b98fa1c..fd06d382a2 100644
--- a/cpukit/score/src/stackallocator.c
+++ b/cpukit/score/src/stackallocator.c
@@ -39,3 +39,6 @@ const Stack_Allocator_initialize _Stack_Allocator_initialize = NULL;
const Stack_Allocator_allocate _Stack_Allocator_allocate = _Workspace_Allocate;
const Stack_Allocator_free _Stack_Allocator_free = _Workspace_Free;
+
+const Stack_Allocator_allocate_for_idle _Stack_Allocator_allocate_for_idle =
+ NULL;
diff --git a/cpukit/score/src/threadcreateidle.c b/cpukit/score/src/threadcreateidle.c
index 1e18ad07cc..440f67f69b 100644
--- a/cpukit/score/src/threadcreateidle.c
+++ b/cpukit/score/src/threadcreateidle.c
@@ -53,9 +53,21 @@ static void _Thread_Create_idle_for_CPU( Per_CPU_Control *cpu )
config.is_preemptible = true;
config.stack_size = _Thread_Idle_stack_size
+ CPU_IDLE_TASK_IS_FP * CONTEXT_FP_SIZE;
- config.stack_area = &_Thread_Idle_stacks[
- _Per_CPU_Get_index( cpu ) * config.stack_size
- ];
+
+ /*
+ * The IDLE thread stacks mau be statically allocated or there may be a
+ * custom allocator provided just as with user threads.
+ */
+ if ( _Stack_Allocator_allocate_for_idle == NULL ) {
+ config.stack_area = &_Thread_Idle_stacks[
+ _Per_CPU_Get_index( cpu ) * config.stack_size
+ ];
+ } else {
+ config.stack_area = (*_Stack_Allocator_allocate_for_idle)(
+ _Per_CPU_Get_index( cpu ),
+ config.stack_size
+ );
+ }
/*
* The entire workspace is zeroed during its initialization. Thus, all
diff --git a/testsuites/sptests/spstkalloc03/init.c b/testsuites/sptests/spstkalloc03/init.c
new file mode 100644
index 0000000000..4afcb6bb1f
--- /dev/null
+++ b/testsuites/sptests/spstkalloc03/init.c
@@ -0,0 +1,98 @@
+/*
+ * COPYRIGHT (c) 2021.
+ * On-Line Applications Research Corporation (OAR).
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.org/license/LICENSE.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <rtems.h>
+#include <tmacros.h>
+
+const char rtems_test_name[] = "SPSTKALLOC 3";
+
+static int thread_stacks_count = 0xff;
+
+static rtems_task Init(
+ rtems_task_argument ignored
+)
+{
+ rtems_print_printer_fprintf_putc(&rtems_test_printer);
+ TEST_BEGIN();
+ rtems_test_assert(thread_stacks_count == 2);
+ TEST_END();
+ rtems_test_exit( 0 );
+}
+
+static uint8_t stack_memory[RTEMS_MINIMUM_STACK_SIZE * 4];
+
+static int stack_offset_next;
+
+static void *allocate_helper(size_t size)
+{
+ size_t next;
+ void *alloc;
+
+ next = stack_offset_next + size;
+ rtems_test_assert( next < sizeof(stack_memory) );
+
+ alloc = &stack_memory[stack_offset_next];
+ stack_offset_next = next;
+ return alloc;
+}
+
+static void thread_stacks_initialize(size_t stack_space_size)
+{
+ rtems_test_assert(thread_stacks_count == 0xff);
+ thread_stacks_count = 0;
+}
+
+static void *thread_stacks_allocate(size_t stack_size)
+{
+ rtems_test_assert(thread_stacks_count == 1);
+ thread_stacks_count++;
+ return allocate_helper(stack_size);
+}
+
+static void thread_stacks_free(void *addr)
+{
+ rtems_test_assert(false);
+}
+
+static void *thread_stacks_allocate_for_idle(uint32_t cpu, size_t stack_size)
+{
+ rtems_test_assert(thread_stacks_count == 0);
+ thread_stacks_count++;
+ return allocate_helper(stack_size);
+}
+
+/*
+ * Configure the thread stack allocators to not use the workspace. This should
+ * eliminate all uses of the Workspace for most BSPs.
+ */
+#define CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE
+#define CONFIGURE_TASK_STACK_ALLOCATOR_INIT thread_stacks_initialize
+#define CONFIGURE_TASK_STACK_ALLOCATOR thread_stacks_allocate
+#define CONFIGURE_TASK_STACK_DEALLOCATOR thread_stacks_free
+#define CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE thread_stacks_allocate_for_idle
+
+
+/* NOTICE: the clock driver is explicitly disabled */
+#define CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
+#define CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER
+
+#define CONFIGURE_MAXIMUM_TASKS 1
+
+#define CONFIGURE_RTEMS_INIT_TASKS_TABLE
+
+#define CONFIGURE_INIT_TASK_ATTRIBUTES RTEMS_FLOATING_POINT
+
+#define CONFIGURE_INITIAL_EXTENSIONS RTEMS_TEST_INITIAL_EXTENSION
+
+#define CONFIGURE_INIT
+#include <rtems/confdefs.h>
diff --git a/testsuites/sptests/spstkalloc03/spstkalloc03.doc b/testsuites/sptests/spstkalloc03/spstkalloc03.doc
new file mode 100644
index 0000000000..797716b623
--- /dev/null
+++ b/testsuites/sptests/spstkalloc03/spstkalloc03.doc
@@ -0,0 +1,19 @@
+# COPYRIGHT (c) 2021.
+# On-Line Applications Research Corporation (OAR).
+#
+# The license and distribution terms for this file may be
+# found in the file LICENSE in this distribution or at
+# http://www.rtems.org/license/LICENSE.
+#
+
+This file describes the directives and concepts tested by this test set.
+
+test set name: spstkalloc03
+
+directives:
+
+concepts:
+
++ Ensure that the task stack allocator including IDLE thread
+ stack allocator works.
+
diff --git a/testsuites/sptests/spstkalloc03/spstkalloc03.scn b/testsuites/sptests/spstkalloc03/spstkalloc03.scn
new file mode 100644
index 0000000000..45c67ef1fb
--- /dev/null
+++ b/testsuites/sptests/spstkalloc03/spstkalloc03.scn
@@ -0,0 +1,2 @@
+*** BEGIN OF TEST SPSTKALLOC 3 ***
+*** END OF TEST SPSTKALLOC 3 ***
--
2.24.4
More information about the devel
mailing list