mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-12 04:25:23 +00:00
2d7460482d
This commit refactors kernel and arch headers to establish a boundary
between private and public interface headers.
The refactoring strategy used in this commit is detailed in the issue
This commit introduces the following major changes:
1. Establish a clear boundary between private and public headers by
removing "kernel/include" and "arch/*/include" from the global
include paths. Ideally, only kernel/ and arch/*/ source files should
reference the headers in these directories. If these headers must be
used by a component, these include paths shall be manually added to
the CMakeLists.txt file of the component. This is intended to
discourage applications from including private kernel and arch
headers either knowingly and unknowingly.
- kernel/include/ (PRIVATE)
This directory contains the private headers that provide private
kernel definitions which should not be visible outside the kernel
and arch source code. All public kernel definitions must be added
to an appropriate header located under include/.
- arch/*/include/ (PRIVATE)
This directory contains the private headers that provide private
architecture-specific definitions which should not be visible
outside the arch and kernel source code. All public architecture-
specific definitions must be added to an appropriate header located
under include/arch/*/.
- include/ AND include/sys/ (PUBLIC)
This directory contains the public headers that provide public
kernel definitions which can be referenced by both kernel and
application code.
- include/arch/*/ (PUBLIC)
This directory contains the public headers that provide public
architecture-specific definitions which can be referenced by both
kernel and application code.
2. Split arch_interface.h into "kernel-to-arch interface" and "public
arch interface" divisions.
- kernel/include/kernel_arch_interface.h
* provides private "kernel-to-arch interface" definition.
* includes arch/*/include/kernel_arch_func.h to ensure that the
interface function implementations are always available.
* includes sys/arch_interface.h so that public arch interface
definitions are automatically included when including this file.
- arch/*/include/kernel_arch_func.h
* provides architecture-specific "kernel-to-arch interface"
implementation.
* only the functions that will be used in kernel and arch source
files are defined here.
- include/sys/arch_interface.h
* provides "public arch interface" definition.
* includes include/arch/arch_inlines.h to ensure that the
architecture-specific public inline interface function
implementations are always available.
- include/arch/arch_inlines.h
* includes architecture-specific arch_inlines.h in
include/arch/*/arch_inline.h.
- include/arch/*/arch_inline.h
* provides architecture-specific "public arch interface" inline
function implementation.
* supersedes include/sys/arch_inline.h.
3. Refactor kernel and the existing architecture implementations.
- Remove circular dependency of kernel and arch headers. The
following general rules should be observed:
* Never include any private headers from public headers
* Never include kernel_internal.h in kernel_arch_data.h
* Always include kernel_arch_data.h from kernel_arch_func.h
* Never include kernel.h from kernel_struct.h either directly or
indirectly. Only add the kernel structures that must be referenced
from public arch headers in this file.
- Relocate syscall_handler.h to include/ so it can be used in the
public code. This is necessary because many user-mode public codes
reference the functions defined in this header.
- Relocate kernel_arch_thread.h to include/arch/*/thread.h. This is
necessary to provide architecture-specific thread definition for
'struct k_thread' in kernel.h.
- Remove any private header dependencies from public headers using
the following methods:
* If dependency is not required, simply omit
* If dependency is required,
- Relocate a portion of the required dependencies from the
private header to an appropriate public header OR
- Relocate the required private header to make it public.
This commit supersedes #20047, addresses #19666, and fixes #3056.
Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
96 lines
3.5 KiB
C
96 lines
3.5 KiB
C
/*
|
|
* Copyright (c) 2017 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#include <kernel.h>
|
|
|
|
#define OPENOCD_UNIMPLEMENTED 0xffffffff
|
|
|
|
#if defined(CONFIG_OPENOCD_SUPPORT) && defined(CONFIG_THREAD_MONITOR)
|
|
enum {
|
|
OPENOCD_OFFSET_VERSION,
|
|
OPENOCD_OFFSET_K_CURR_THREAD,
|
|
OPENOCD_OFFSET_K_THREADS,
|
|
OPENOCD_OFFSET_T_ENTRY,
|
|
OPENOCD_OFFSET_T_NEXT_THREAD,
|
|
OPENOCD_OFFSET_T_STATE,
|
|
OPENOCD_OFFSET_T_USER_OPTIONS,
|
|
OPENOCD_OFFSET_T_PRIO,
|
|
OPENOCD_OFFSET_T_STACK_PTR,
|
|
OPENOCD_OFFSET_T_NAME,
|
|
OPENOCD_OFFSET_T_ARCH,
|
|
OPENOCD_OFFSET_T_PREEMPT_FLOAT,
|
|
OPENOCD_OFFSET_T_COOP_FLOAT,
|
|
};
|
|
|
|
/* Forward-compatibility notes: 1) Only append items to this table; otherwise
|
|
* OpenOCD versions that expect less items will read garbage values.
|
|
* 2) Avoid incompatible changes that affect the interpretation of existing
|
|
* items. But if you have to do them, increment OPENOCD_OFFSET_VERSION
|
|
* and submit a patch for OpenOCD to deal with both the old and new scheme.
|
|
* Only version 1 is backward compatible to version 0.
|
|
*/
|
|
__attribute__((used, section(".openocd_dbg")))
|
|
size_t _kernel_openocd_offsets[] = {
|
|
/* Version 0 starts */
|
|
[OPENOCD_OFFSET_VERSION] = 1,
|
|
[OPENOCD_OFFSET_K_CURR_THREAD] = offsetof(struct z_kernel, current),
|
|
[OPENOCD_OFFSET_K_THREADS] = offsetof(struct z_kernel, threads),
|
|
[OPENOCD_OFFSET_T_ENTRY] = offsetof(struct k_thread, entry),
|
|
[OPENOCD_OFFSET_T_NEXT_THREAD] = offsetof(struct k_thread, next_thread),
|
|
[OPENOCD_OFFSET_T_STATE] = offsetof(struct _thread_base, thread_state),
|
|
[OPENOCD_OFFSET_T_USER_OPTIONS] = offsetof(struct _thread_base,
|
|
user_options),
|
|
[OPENOCD_OFFSET_T_PRIO] = offsetof(struct _thread_base, prio),
|
|
#if defined(CONFIG_ARM)
|
|
[OPENOCD_OFFSET_T_STACK_PTR] = offsetof(struct k_thread,
|
|
callee_saved.psp),
|
|
#elif defined(CONFIG_ARC)
|
|
[OPENOCD_OFFSET_T_STACK_PTR] = offsetof(struct k_thread,
|
|
callee_saved.sp),
|
|
#elif defined(CONFIG_X86)
|
|
[OPENOCD_OFFSET_T_STACK_PTR] = offsetof(struct k_thread,
|
|
callee_saved.esp),
|
|
#elif defined(CONFIG_NIOS2)
|
|
[OPENOCD_OFFSET_T_STACK_PTR] = offsetof(struct k_thread,
|
|
callee_saved.sp),
|
|
#elif defined(CONFIG_RISCV)
|
|
[OPENOCD_OFFSET_T_STACK_PTR] = offsetof(struct k_thread,
|
|
callee_saved.sp),
|
|
#else
|
|
/* Use a special value so that OpenOCD knows that obtaining the stack
|
|
* pointer is not possible on this particular architecture.
|
|
*/
|
|
#warning Please define OPENOCD_OFFSET_T_STACK_PTR for this architecture
|
|
[OPENOCD_OFFSET_T_STACK_PTR] = OPENOCD_UNIMPLEMENTED,
|
|
#endif
|
|
/* Version 0 ends */
|
|
|
|
[OPENOCD_OFFSET_T_NAME] = offsetof(struct k_thread, name),
|
|
[OPENOCD_OFFSET_T_ARCH] = offsetof(struct k_thread, arch),
|
|
#if defined(CONFIG_FLOAT) && defined(CONFIG_FP_SHARING) && defined(CONFIG_ARM)
|
|
[OPENOCD_OFFSET_T_PREEMPT_FLOAT] = offsetof(struct _thread_arch,
|
|
preempt_float),
|
|
[OPENOCD_OFFSET_T_COOP_FLOAT] = OPENOCD_UNIMPLEMENTED,
|
|
#elif defined(CONFIG_FLOAT) && defined(CONFIG_X86)
|
|
[OPENOCD_OFFSET_T_PREEMPT_FLOAT] = offsetof(struct _thread_arch,
|
|
preempFloatReg),
|
|
[OPENOCD_OFFSET_T_COOP_FLOAT] = OPENOCD_UNIMPLEMENTED,
|
|
#else
|
|
[OPENOCD_OFFSET_T_PREEMPT_FLOAT] = OPENOCD_UNIMPLEMENTED,
|
|
[OPENOCD_OFFSET_T_COOP_FLOAT] = OPENOCD_UNIMPLEMENTED,
|
|
#endif
|
|
/* Version is still 1, but existence of following elements must be
|
|
* checked with _kernel_openocd_num_offsets.
|
|
*/
|
|
};
|
|
|
|
__attribute__((used, section(".openocd_dbg")))
|
|
size_t _kernel_openocd_num_offsets = ARRAY_SIZE(_kernel_openocd_offsets);
|
|
|
|
__attribute__((used, section(".openocd_dbg")))
|
|
u8_t _kernel_openocd_size_t_size = (u8_t)sizeof(size_t);
|
|
#endif
|