headers: Refactor kernel_structs.h and introduce kernel_arch.h.

This commit refactors kernel_structs.h to be more truthful to its name
(i.e. define kernel structures only), and introduces kernel_arch.h to
provide the definitions that are not kernel structure related and were
previously provided by kernel_structs.h.

In addition, this commit updates all required inclusions of
kernel_structs.h to use kernel_arch.h instead and makes the necessary
adjustments to resolve header dependencies.

The primary reason for refactoring kernel_structs.h is to remove its
dependency on kernel.h so that the kernel structure definitions
provided by it can be used in arch headers (for instance, in
include/arch/arm/irq.h). This was not possible until now due to a
circular dependency of these headers as described in the issue #3056.

Signed-off-by: Stephanos Ioannidis <[email protected]>

Author: stephanosio

arch/arm/core/cortex_m/fault.c

@@ -11,11 +11,8 @@
  * Common fault handler for ARM Cortex-M processors.
  */
 
-#include <toolchain.h>
-#include <linker/sections.h>
-
 #include <kernel.h>
-#include <kernel_structs.h>
+#include <kernel_arch.h>
 #include <inttypes.h>
 #include <exc_handle.h>
 #include <logging/log.h>

arch/arm/core/cortex_r/fault.c

@@ -5,7 +5,7 @@
  */
 
 #include <kernel.h>
-#include <kernel_structs.h>
+#include <kernel_arch.h>
 
 /**
  *

arch/arm/core/fatal.c

@@ -17,7 +17,7 @@
 #include <inttypes.h>
 
 #include <kernel.h>
-#include <kernel_structs.h>
+#include <kernel_arch.h>
 #include <logging/log.h>
 LOG_MODULE_DECLARE(os);
 

arch/arm/core/offsets/offsets.c

@@ -23,6 +23,8 @@
  */
 
 #include <gen_offset.h>
+#include <kernel.h>
+#include <kernel_arch_data.h>
 #include <kernel_structs.h>
 #include <kernel_offsets.h>
 

arch/arm/core/swap.c

@@ -6,7 +6,7 @@
 
 #include <kernel.h>
 #include <toolchain.h>
-#include <kernel_structs.h>
+#include <kernel_arch.h>
 
 #ifdef CONFIG_EXECUTION_BENCHMARKING
 extern void read_timer_start_of_swap(void);

arch/arm/core/thread.c

@@ -14,7 +14,7 @@
 
 #include <kernel.h>
 #include <toolchain.h>
-#include <kernel_structs.h>
+#include <kernel_arch.h>
 #include <wait_q.h>
 
 #ifdef CONFIG_USERSPACE

arch/arm/include/kernel_arch_func.h

@@ -22,6 +22,8 @@
 #ifndef ZEPHYR_ARCH_ARM_INCLUDE_KERNEL_ARCH_FUNC_H_
 #define ZEPHYR_ARCH_ARM_INCLUDE_KERNEL_ARCH_FUNC_H_
 
+#include <kernel_arch_data.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif

arch/nios2/core/crt0.S

@@ -4,7 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <kernel_structs.h>
+#include <toolchain.h>
+#include <linker/sections.h>
 
 /* exports */
 GTEXT(__start)

arch/nios2/core/exception.S

@@ -4,7 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <kernel_structs.h>
+#include <toolchain.h>
+#include <linker/sections.h>
 #include <offsets_short.h>
 
 /* exports */

arch/nios2/core/prep_c.c

@@ -16,11 +16,7 @@
  * initialization is performed.
  */
 
-#include <zephyr/types.h>
-#include <toolchain.h>
-#include <linker/linker-defs.h>
-#include <kernel_structs.h>
-#include <kernel_internal.h>
+#include <kernel_arch.h>
 
 /**
  *

arch/nios2/core/reset.S

@@ -4,9 +4,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <arch/cpu.h>
-#include <kernel_structs.h>
+#include <toolchain.h>
 #include <offsets_short.h>
+#include <arch/cpu.h>
 
 GTEXT(__start)
 

arch/nios2/core/swap.S

@@ -4,7 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <kernel_structs.h>
+#include <toolchain.h>
+#include <linker/sections.h>
 #include <offsets_short.h>
 
 /* exports */

arch/nios2/include/kernel_arch_func.h

@@ -20,6 +20,8 @@
 #ifndef ZEPHYR_ARCH_NIOS2_INCLUDE_KERNEL_ARCH_FUNC_H_
 #define ZEPHYR_ARCH_NIOS2_INCLUDE_KERNEL_ARCH_FUNC_H_
 
+#include <kernel_arch_data.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif

arch/riscv/core/irq_manage.c

@@ -4,8 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <toolchain.h>
-#include <kernel_structs.h>
+#include <kernel.h>
+#include <kernel_arch.h>
 #include <logging/log.h>
 LOG_MODULE_DECLARE(os);
 

arch/riscv/core/isr.S

@@ -7,8 +7,8 @@
 
 #include <toolchain.h>
 #include <linker/sections.h>
-#include <kernel_structs.h>
 #include <offsets_short.h>
+#include <arch/cpu.h>
 
 /* imports */
 GDATA(_sw_isr_table)

arch/riscv/core/reset.S

@@ -5,7 +5,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <kernel_structs.h>
+#include <toolchain.h>
+#include <linker/sections.h>
 
 /* exports */
 GTEXT(__initialize)

arch/riscv/core/swap.S

@@ -4,9 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <irq.h>
-#include <kernel_structs.h>
+#include <toolchain.h>
+#include <linker/sections.h>
 #include <offsets_short.h>
+#include <arch/cpu.h>
 
 /* exports */
 GTEXT(z_arch_swap)

arch/riscv/include/kernel_arch_func.h

@@ -15,7 +15,7 @@
 #ifndef ZEPHYR_ARCH_RISCV_INCLUDE_KERNEL_ARCH_FUNC_H_
 #define ZEPHYR_ARCH_RISCV_INCLUDE_KERNEL_ARCH_FUNC_H_
 
-#include <soc.h>
+#include <kernel_arch_data.h>
 
 #ifdef __cplusplus
 extern "C" {

arch/x86/core/ia32/cache_s.S

@@ -10,6 +10,8 @@
  * This module contains functions for manipulating caches.
  */
 
+#include <toolchain.h>
+#include <linker/sections.h>
 #include <arch/x86/ia32/asm.h>
 
 #ifndef CONFIG_CLFLUSH_INSTRUCTION_SUPPORTED

arch/x86/core/ia32/crt0.S

@@ -11,6 +11,8 @@
  * after having been loaded into RAM.
  */
 
+#include <toolchain.h>
+#include <linker/sections.h>
 #include <arch/x86/ia32/asm.h>
 #include <arch/x86/msr.h>
 #include <kernel_arch_data.h>

arch/x86/core/ia32/excstub.S

@@ -14,10 +14,11 @@
  * and exiting a C exception handler.
  */
 
-#include <kernel_structs.h>
+#include <toolchain.h>
+#include <linker/sections.h>
+#include <offsets_short.h>
 #include <arch/x86/ia32/asm.h>
 #include <arch/x86/ia32/arch.h> /* For MK_ISR_NAME */
-#include <offsets_short.h>
 
 
 	/* exports (internal APIs) */

arch/x86/core/ia32/fatal.c

@@ -13,7 +13,7 @@
 #include <linker/sections.h>
 
 #include <kernel.h>
-#include <kernel_structs.h>
+#include <kernel_arch.h>
 #include <drivers/interrupt_controller/sysapic.h>
 #include <arch/x86/ia32/segmentation.h>
 #include <ia32/exception.h>

arch/x86/core/ia32/float.c

@@ -43,8 +43,7 @@
  * to enable FP register sharing on its behalf.
  */
 
-#include <kernel_structs.h>
-#include <toolchain.h>
+#include <kernel_arch.h>
 
 /* SSE control/status register default value (used by assembler code) */
 extern u32_t _sse_mxcsr_default_value;

arch/x86/core/ia32/intstub.S

@@ -14,9 +14,10 @@
  * entering and exiting a C interrupt handler.
  */
 
-#include <kernel_structs.h>
-#include <arch/x86/ia32/asm.h>
+#include <toolchain.h>
+#include <linker/sections.h>
 #include <offsets_short.h>
+#include <arch/x86/ia32/asm.h>
 #include <arch/cpu.h>
 #include <drivers/interrupt_controller/sysapic.h>
 

arch/x86/core/ia32/swap.S

@@ -11,9 +11,12 @@
  * This module implements the z_arch_swap() routine for the IA-32 architecture.
  */
 
-#include <kernel_structs.h>
-#include <arch/x86/ia32/asm.h>
+#include <toolchain.h>
+#include <linker/sections.h>
 #include <offsets_short.h>
+#include <kernel.h>
+#include <kernel_arch_data.h>
+#include <arch/x86/ia32/asm.h>
 
 	/* exports (internal APIs) */
 

arch/x86/core/ia32/userspace.S

@@ -4,10 +4,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <kernel_structs.h>
+#include <toolchain.h>
+#include <linker/sections.h>
+#include <offsets_short.h>
 #include <arch/x86/ia32/asm.h>
 #include <arch/cpu.h>
-#include <offsets_short.h>
 #include <syscall.h>
 
 /* Exports */

arch/x86/core/ia32/x86_mmu.c

@@ -8,7 +8,7 @@
 #include <arch/x86/mmustructs.h>
 #include <linker/linker-defs.h>
 #include <kernel_internal.h>
-#include <kernel_structs.h>
+#include <kernel_arch.h>
 #include <init.h>
 #include <ctype.h>
 #include <string.h>

arch/x86/core/prep_c.c

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <kernel_structs.h>
+#include <kernel_arch.h>
 #include <arch/x86/acpi.h>
 #include <arch/x86/multiboot.h>
 

arch/x86/include/ia32/kernel_arch_func.h

@@ -12,7 +12,7 @@
 
 #ifndef _ASMLANGUAGE
 
-#include <stddef.h> /* For size_t */
+#include <kernel_arch_data.h>
 
 #ifdef __cplusplus
 extern "C" {

arch/x86/include/intel64/kernel_arch_func.h

@@ -6,7 +6,7 @@
 #ifndef ZEPHYR_ARCH_X86_INCLUDE_INTEL64_KERNEL_ARCH_FUNC_H_
 #define ZEPHYR_ARCH_X86_INCLUDE_INTEL64_KERNEL_ARCH_FUNC_H_
 
-#include <kernel_structs.h>
+#include <kernel_arch_data.h>
 
 #ifndef _ASMLANGUAGE
 

arch/xtensa/core/offsets/offsets.c

@@ -27,8 +27,8 @@
 
 /* list of headers that define whose structure offsets will be generated */
 
+#include <kernel_arch_data.h>
 #include <kernel_structs.h>
-
 #include <kernel_offsets.h>
 
 /* Xtensa-specific k_thread structure member offsets */

include/arch/arm/irq.h

@@ -14,6 +14,7 @@
 #ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_IRQ_H_
 #define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_IRQ_H_
 
+#include <kernel_structs.h>
 #include <irq.h>
 #include <sw_isr_table.h>
 #include <stdbool.h>

include/sys/mutex.h

@@ -110,7 +110,7 @@ static inline int sys_mutex_unlock(struct sys_mutex *mutex)
 
 #else
 #include <kernel.h>
-#include <kernel_structs.h>
+#include <kernel_arch.h>
 
 struct sys_mutex {
 	struct k_mutex kernel_mutex;

kernel/errno.c

@@ -12,8 +12,8 @@
  * context switching.
  */
 
-#include <kernel_structs.h>
-#include <syscall_handler.h>
+#include <kernel.h>
+#include <kernel_arch.h>
 
 /*
  * Define _k_neg_eagain for use in assembly files as errno.h is