Add support for IDLE Thread stack allocator

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 #4524.

6 files changed, 228 insertions, 0 deletions

diff --git a/testsuites/sptests/spstkalloc03/init.c b/testsuites/sptests/spstkalloc03/init.c
new file mode 100644
index 0000000000..348afe7328
--- /dev/null
+++ b/testsuites/sptests/spstkalloc03/init.c
@@ -0,0 +1,103 @@
+/*
+ *  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>
+
+#include <rtems/score/percpu.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 ***
diff --git a/testsuites/sptests/spstkalloc04/init.c b/testsuites/sptests/spstkalloc04/init.c
new file mode 100644
index 0000000000..16f4ec65ca
--- /dev/null
+++ b/testsuites/sptests/spstkalloc04/init.c
@@ -0,0 +1,82 @@
+/*
+ *  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>
+
+#include <rtems/score/percpu.h>
+
+const char rtems_test_name[] = "SPSTKALLOC 4";
+
+static int thread_stacks_count = 0;
+
+static rtems_task Init(
+  rtems_task_argument ignored
+)
+{
+  rtems_print_printer_fprintf_putc(&rtems_test_printer);
+  TEST_BEGIN();
+  rtems_test_assert(thread_stacks_count == 1);
+  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_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 IDLE thread stack allocators. This is a special
+ * case where there is an IDLE thread stack allocator but no custom
+ * allocator set for other threads.
+ */
+#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/spstkalloc04/spstkalloc04.doc b/testsuites/sptests/spstkalloc04/spstkalloc04.doc
new file mode 100644
index 0000000000..a1ed5b22cb
--- /dev/null
+++ b/testsuites/sptests/spstkalloc04/spstkalloc04.doc
@@ -0,0 +1,20 @@
+#  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:  spstkalloc04
+
+directives:
+
+concepts:
+
++ Ensure that the task stack allocator including IDLE thread
+  stack allocator works when a custom allocator is NOT provided
+  for other threads.
+
diff --git a/testsuites/sptests/spstkalloc04/spstkalloc04.scn b/testsuites/sptests/spstkalloc04/spstkalloc04.scn
new file mode 100644
index 0000000000..f0919ec2d4
--- /dev/null
+++ b/testsuites/sptests/spstkalloc04/spstkalloc04.scn
@@ -0,0 +1,2 @@
+*** BEGIN OF TEST SPSTKALLOC 4 ***
+*** END OF TEST SPSTKALLOC 4 ***