kernel: Add kswap.h header to unbreak cycles

The xtensa-asm2 work included a patch that added nano_internal.h
includes in lots of places that needed to have _Swap defined, because
it had to break a cycle and this no longer got pulled in from the arch
headers.

Unfortunately those new includes created new and more amusing cycles
elsewhere which led to breakage on other platforms.

Break out the _Swap definition (only) into a separate header and use
that instead.  Cleaner.  Seems not to have any more hidden gotchas.

Signed-off-by: Andy Ross <andrew.j.ross@intel.com>

arch/arm/core/thread_abort.c

@@ -21,6 +21,7 @@
 #include <toolchain.h>
 #include <linker/sections.h>
 #include <ksched.h>
+#include <kswap.h>
 #include <wait_q.h>
 #include <misc/__assert.h>
 

arch/posix/core/posix_core.c

@@ -48,6 +48,7 @@
 #include "kernel_internal.h"
 #include "kernel_structs.h"
 #include "ksched.h"
+#include "kswap.h"
 
 #define PREFIX     "POSIX arch core: "
 #define ERPREFIX   PREFIX"error on "

arch/x86/core/irq_manage.c

@@ -21,6 +21,7 @@
 #include <misc/printk.h>
 #include <irq.h>
 #include <logging/kernel_event_logger.h>
+#include <kswap.h>
 
 extern void _SpuriousIntHandler(void *);
 extern void _SpuriousIntNoErrCodeHandler(void *);

arch/xtensa/core/xtensa-asm2.c

@@ -10,6 +10,7 @@
 #include <ksched.h>
 #include <kernel_structs.h>
 #include <nano_internal.h>
+#include <kswap.h>
 #include <_soc_inthandlers.h>
 
 void *xtensa_init_stack(int *stack_top,

boards/posix/native_posix/irq_handler.c

@@ -12,6 +12,7 @@
 #include "irq_offload.h"
 #include "kernel_structs.h"
 #include "kernel_internal.h"
+#include "kswap.h"
 #include "irq_ctrl.h"
 #include "posix_core.h"
 #include "board_soc.h"

kernel/include/kernel_internal.h

@@ -15,8 +15,6 @@
 #define _NANO_INTERNAL__H_
 
 #include <kernel.h>
-#include <kernel_structs.h>
-#include <ksched.h>
 
 #ifndef _ASMLANGUAGE
 
@@ -52,65 +50,6 @@ extern void _setup_new_thread(struct k_thread *new_thread,
 			      void *p1, void *p2, void *p3,
 			      int prio, u32_t options);
 
-#ifdef CONFIG_TIMESLICING
-extern void _update_time_slice_before_swap(void);
-#else
-#define _update_time_slice_before_swap() /**/
-#endif
-
-#ifdef CONFIG_STACK_SENTINEL
-extern void _check_stack_sentinel(void);
-#else
-#define _check_stack_sentinel() /**/
-#endif
-
-/* context switching and scheduling-related routines */
-#ifdef CONFIG_USE_SWITCH
-
-/* New style context switching.  _arch_switch() is a lower level
- * primitive that doesn't know about the scheduler or return value.
- * Needed for SMP, where the scheduler requires spinlocking that we
- * don't want to have to do in per-architecture assembly.
- */
-static inline unsigned int _Swap(unsigned int key)
-{
-	struct k_thread *new_thread, *old_thread;
-	int ret;
-
-	old_thread = _kernel.current;
-
-	_check_stack_sentinel();
-	_update_time_slice_before_swap();
-
-	new_thread = _get_next_ready_thread();
-
-	old_thread->swap_retval = -EAGAIN;
-
-	_kernel.current = new_thread;
-	_arch_switch(new_thread->switch_handle,
-		     &old_thread->switch_handle);
-
-	ret = _kernel.current->swap_retval;
-
-	irq_unlock(key);
-
-	return ret;
-}
-
-#else /* !CONFIG_USE_SWITCH */
-
-extern unsigned int __swap(unsigned int key);
-
-static inline unsigned int _Swap(unsigned int key)
-{
-	_check_stack_sentinel();
-	_update_time_slice_before_swap();
-
-	return __swap(key);
-}
-#endif
-
-
 #ifdef CONFIG_USERSPACE
 /**
  * @brief Get the maximum number of partitions for a memory domain

kernel/include/kswap.h

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2018 Intel Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#ifndef _KSWAP_H
+#define _KSWAP_H
+
+#include <ksched.h>
+#include <kernel_arch_func.h>
+
+#ifdef CONFIG_TIMESLICING
+extern void _update_time_slice_before_swap(void);
+#else
+#define _update_time_slice_before_swap() /**/
+#endif
+
+#ifdef CONFIG_STACK_SENTINEL
+extern void _check_stack_sentinel(void);
+#else
+#define _check_stack_sentinel() /**/
+#endif
+
+/* context switching and scheduling-related routines */
+#ifdef CONFIG_USE_SWITCH
+
+/* New style context switching.  _arch_switch() is a lower level
+ * primitive that doesn't know about the scheduler or return value.
+ * Needed for SMP, where the scheduler requires spinlocking that we
+ * don't want to have to do in per-architecture assembly.
+ */
+static inline unsigned int _Swap(unsigned int key)
+{
+	struct k_thread *new_thread, *old_thread;
+	int ret;
+
+	old_thread = _kernel.current;
+
+	_check_stack_sentinel();
+	_update_time_slice_before_swap();
+
+	new_thread = _get_next_ready_thread();
+
+	old_thread->swap_retval = -EAGAIN;
+
+	_kernel.current = new_thread;
+	_arch_switch(new_thread->switch_handle,
+		     &old_thread->switch_handle);
+
+	ret =_kernel.current->swap_retval;
+
+	irq_unlock(key);
+
+	return ret;
+}
+
+#else /* !CONFIG_USE_SWITCH */
+
+extern unsigned int __swap(unsigned int key);
+
+static inline unsigned int _Swap(unsigned int key)
+{
+	_check_stack_sentinel();
+	_update_time_slice_before_swap();
+
+	return __swap(key);
+}
+#endif
+
+#endif /* _KSWAP_H */

kernel/init.c

@@ -28,6 +28,7 @@
 #include <string.h>
 #include <misc/dlist.h>
 #include <nano_internal.h>
+#include <kswap.h>
 
 /* kernel build timestamp items */
 

kernel/mailbox.c

@@ -17,7 +17,7 @@
 #include <wait_q.h>
 #include <misc/dlist.h>
 #include <init.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 #if (CONFIG_NUM_MBOX_ASYNC_MSGS > 0)
 

kernel/mem_slab.c

@@ -13,7 +13,7 @@
 #include <misc/dlist.h>
 #include <ksched.h>
 #include <init.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 extern struct k_mem_slab _k_mem_slab_list_start[];
 extern struct k_mem_slab _k_mem_slab_list_end[];

kernel/mempool.c

@@ -10,7 +10,7 @@
 #include <init.h>
 #include <string.h>
 #include <misc/__assert.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 /* Linker-defined symbols bound the static pool structs */
 extern struct k_mem_pool _k_mem_pool_list_start[];

kernel/msg_q.c

@@ -20,7 +20,7 @@
 #include <misc/dlist.h>
 #include <init.h>
 #include <syscall_handler.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 extern struct k_msgq _k_msgq_list_start[];
 extern struct k_msgq _k_msgq_list_end[];

kernel/mutex.c

@@ -36,7 +36,7 @@
 #include <errno.h>
 #include <init.h>
 #include <syscall_handler.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 #define RECORD_STATE_CHANGE(mutex) do { } while ((0))
 #define RECORD_CONFLICT(mutex) do { } while ((0))

kernel/pipes.c

@@ -19,7 +19,7 @@
 #include <misc/dlist.h>
 #include <init.h>
 #include <syscall_handler.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 struct k_pipe_desc {
 	unsigned char *buffer;           /* Position in src/dest buffer */

kernel/poll.c

@@ -19,6 +19,7 @@
 #include <nano_internal.h>
 #include <wait_q.h>
 #include <ksched.h>
+#include <kswap.h>
 #include <misc/slist.h>
 #include <misc/dlist.h>
 #include <misc/__assert.h>

kernel/posix/pthread_barrier.c

@@ -8,7 +8,7 @@
 #include <pthread.h>
 #include "ksched.h"
 #include "wait_q.h"
-#include <nano_internal.h>
+#include <kswap.h>
 
 void ready_one_thread(_wait_q_t *wq);
 

kernel/posix/pthread_cond.c

@@ -8,7 +8,7 @@
 #include <pthread.h>
 #include "ksched.h"
 #include "wait_q.h"
-#include <nano_internal.h>
+#include <kswap.h>
 
 void ready_one_thread(_wait_q_t *wq);
 

kernel/queue.c

@@ -20,7 +20,7 @@
 #include <ksched.h>
 #include <misc/slist.h>
 #include <init.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 extern struct k_queue _k_queue_list_start[];
 extern struct k_queue _k_queue_list_end[];

kernel/sched.c

@@ -11,7 +11,7 @@
 #include <wait_q.h>
 #include <misc/util.h>
 #include <syscall_handler.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 /* the only struct _kernel instance */
 struct _kernel _kernel = {0};

kernel/sem.c

@@ -27,7 +27,7 @@
 #include <ksched.h>
 #include <init.h>
 #include <syscall_handler.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 extern struct k_sem _k_sem_list_start[];
 extern struct k_sem _k_sem_list_end[];

kernel/stack.c

@@ -18,7 +18,7 @@
 #include <misc/__assert.h>
 #include <init.h>
 #include <syscall_handler.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 extern struct k_stack _k_stack_list_start[];
 extern struct k_stack _k_stack_list_end[];

kernel/thread.c

@@ -25,6 +25,7 @@
 #include <atomic.h>
 #include <syscall_handler.h>
 #include <nano_internal.h>
+#include <kswap.h>
 
 extern struct _static_thread_data _static_thread_data_list_start[];
 extern struct _static_thread_data _static_thread_data_list_end[];

kernel/thread_abort.c

@@ -13,6 +13,8 @@
 #include <kernel.h>
 #include <kernel_structs.h>
 #include <kernel_internal.h>
+#include <nano_internal.h>
+#include <kswap.h>
 #include <string.h>
 #include <toolchain.h>
 #include <linker/sections.h>

kernel/timer.c

@@ -9,7 +9,7 @@
 #include <init.h>
 #include <wait_q.h>
 #include <syscall_handler.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 extern struct k_timer _k_timer_list_start[];
 extern struct k_timer _k_timer_list_end[];

tests/kernel/fatal/src/main.c

@@ -9,7 +9,7 @@
 #include <tc_util.h>
 #include <kernel_structs.h>
 #include <irq_offload.h>
-#include <nano_internal.h>
+#include <kswap.h>
 
 #if defined(CONFIG_X86) && defined(CONFIG_X86_MMU)
 #define STACKSIZE (8192)