cleanup: include/: move app_memory/app_memdomain.h to userspace/app_m…

…emory/app_memdomain.h move app_memory/app_memdomain.h to userspace/app_memory/app_memdomain.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to zephyrproject-rtos#16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
nashif · Jul 4, 2019 · 6010734 · 6010734
1 parent ed8ecd0
commit 6010734
Show file tree

Hide file tree

Showing 11 changed files with 146 additions and 131 deletions.
diff --git a/include/app_memory/app_memdomain.h b/include/app_memory/app_memdomain.h
@@ -6,129 +6,10 @@
 #ifndef ZEPHYR_INCLUDE_APP_MEMORY_APP_MEMDOMAIN_H_
 #define ZEPHYR_INCLUDE_APP_MEMORY_APP_MEMDOMAIN_H_
 
-#include <linker/linker-defs.h>
-#include <sys/dlist.h>
-#include <kernel.h>
-
-#ifdef CONFIG_USERSPACE
-
-/**
- * @brief Name of the data section for a particular partition
- *
- * Useful for defining memory pools, or any other macro that takes a
- * section name as a parameter.
- *
- * @param id Partition name
- */
-#define K_APP_DMEM_SECTION(id) data_smem_##id##_data
-
-/**
- * @brief Name of the bss section for a particular partition
- *
- * Useful for defining memory pools, or any other macro that takes a
- * section name as a parameter.
- *
- * @param id Partition name
- */
-#define K_APP_BMEM_SECTION(id) data_smem_##id##_bss
-
-/**
- * @brief Place data in a partition's data section
- *
- * Globals tagged with this will end up in the data section for the
- * specified memory partition. This data should be initialized to some
- * desired value.
- *
- * @param id Name of the memory partition to associate this data
- */
-#define K_APP_DMEM(id) Z_GENERIC_SECTION(K_APP_DMEM_SECTION(id))
-
-/**
- * @brief Place data in a partition's bss section
- *
- * Globals tagged with this will end up in the bss section for the
- * specified memory partition. This data will be zeroed at boot.
- *
- * @param id Name of the memory partition to associate this data
- */
-#define K_APP_BMEM(id) Z_GENERIC_SECTION(K_APP_BMEM_SECTION(id))
-
-struct z_app_region {
-	void *bss_start;
-	size_t bss_size;
-};
-
-#define Z_APP_START(id) z_data_smem_##id##_part_start
-#define Z_APP_SIZE(id) z_data_smem_##id##_part_size
-#define Z_APP_BSS_START(id) z_data_smem_##id##_bss_start
-#define Z_APP_BSS_SIZE(id) z_data_smem_##id##_bss_size
-
-/* If a partition is declared with K_APPMEM_PARTITION, but never has any
- * data assigned to its contents, then no symbols with its prefix will end
- * up in the symbol table. This prevents gen_app_partitions.py from detecting
- * that the partition exists, and the linker symbols which specify partition
- * bounds will not be generated, resulting in build errors.
- *
- * What this inline assembly code does is define a symbol with no data.
- * This should work for all arches that produce ELF binaries, see
- * https://sourceware.org/binutils/docs/as/Section.html
- *
- * We don't know what active flags/type of the pushed section were, so we are
- * specific: "aw" indicates section is allocatable and writable,
- * and "@progbits" indicates the section has data.
- */
-#ifdef CONFIG_ARM
-/* ARM has a quirk in that '@' denotes a comment, so we have to send
- * %progbits to the assembler instead.
- */
-#define Z_PROGBITS_SYM	"\%"
-#else
-#define Z_PROGBITS_SYM "@"
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <userspace/app_memory/app_memdomain.h> instead."
 #endif
 
-#define Z_APPMEM_PLACEHOLDER(name) \
-	__asm__ ( \
-		".pushsection " STRINGIFY(K_APP_DMEM_SECTION(name)) \
-			",\"aw\"," Z_PROGBITS_SYM "progbits\n\t" \
-		".global " STRINGIFY(name) "_placeholder\n\t" \
-		STRINGIFY(name) "_placeholder:\n\t" \
-		".popsection\n\t")
-
-/**
- * @brief Define an application memory partition with linker support
- *
- * Defines a k_mem_paritition with the provided name.
- * This name may be used with the K_APP_DMEM and K_APP_BMEM macros to
- * place globals automatically in this partition.
- *
- * NOTE: placeholder char variable is defined here to prevent build errors
- * if a partition is defined but nothing ever placed in it.
- *
- * @param name Name of the k_mem_partition to declare
- */
-#define K_APPMEM_PARTITION_DEFINE(name) \
-	extern char Z_APP_START(name)[]; \
-	extern char Z_APP_SIZE(name)[]; \
-	struct k_mem_partition name = { \
-		.start = (u32_t) &Z_APP_START(name), \
-		.size = (u32_t) &Z_APP_SIZE(name), \
-		.attr = K_MEM_PARTITION_P_RW_U_RW \
-	}; \
-	extern char Z_APP_BSS_START(name)[]; \
-	extern char Z_APP_BSS_SIZE(name)[]; \
-	Z_GENERIC_SECTION(.app_regions.name) \
-	struct z_app_region name##_region = { \
-		.bss_start = &Z_APP_BSS_START(name), \
-		.bss_size = (size_t) &Z_APP_BSS_SIZE(name) \
-	}; \
-	Z_APPMEM_PLACEHOLDER(name);
-#else
-
-#define K_APP_BMEM(ptn)
-#define K_APP_DMEM(ptn)
-#define K_APP_DMEM_SECTION(ptn) .data
-#define K_APP_BMEM_SECTION(ptn) .bss
-#define K_APPMEM_PARTITION_DEFINE(name)
+#include <userspace/app_memory/app_memdomain.h>
 
-#endif /* CONFIG_USERSPACE */
 #endif /* ZEPHYR_INCLUDE_APP_MEMORY_APP_MEMDOMAIN_H_ */
diff --git a/include/userspace/app_memory/app_memdomain.h b/include/userspace/app_memory/app_memdomain.h
@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) 2019 Intel Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#ifndef ZEPHYR_INCLUDE_USERSPACE_APP_MEMORY_APP_MEMORY_APP_MEMDOMAIN_H_
+#define ZEPHYR_INCLUDE_USERSPACE_APP_MEMORY_APP_MEMORY_APP_MEMDOMAIN_H_
+
+#include <linker/linker-defs.h>
+#include <sys/dlist.h>
+#include <kernel.h>
+
+#ifdef CONFIG_USERSPACE
+
+/**
+ * @brief Name of the data section for a particular partition
+ *
+ * Useful for defining memory pools, or any other macro that takes a
+ * section name as a parameter.
+ *
+ * @param id Partition name
+ */
+#define K_APP_DMEM_SECTION(id) data_smem_##id##_data
+
+/**
+ * @brief Name of the bss section for a particular partition
+ *
+ * Useful for defining memory pools, or any other macro that takes a
+ * section name as a parameter.
+ *
+ * @param id Partition name
+ */
+#define K_APP_BMEM_SECTION(id) data_smem_##id##_bss
+
+/**
+ * @brief Place data in a partition's data section
+ *
+ * Globals tagged with this will end up in the data section for the
+ * specified memory partition. This data should be initialized to some
+ * desired value.
+ *
+ * @param id Name of the memory partition to associate this data
+ */
+#define K_APP_DMEM(id) Z_GENERIC_SECTION(K_APP_DMEM_SECTION(id))
+
+/**
+ * @brief Place data in a partition's bss section
+ *
+ * Globals tagged with this will end up in the bss section for the
+ * specified memory partition. This data will be zeroed at boot.
+ *
+ * @param id Name of the memory partition to associate this data
+ */
+#define K_APP_BMEM(id) Z_GENERIC_SECTION(K_APP_BMEM_SECTION(id))
+
+struct z_app_region {
+	void *bss_start;
+	size_t bss_size;
+};
+
+#define Z_APP_START(id) z_data_smem_##id##_part_start
+#define Z_APP_SIZE(id) z_data_smem_##id##_part_size
+#define Z_APP_BSS_START(id) z_data_smem_##id##_bss_start
+#define Z_APP_BSS_SIZE(id) z_data_smem_##id##_bss_size
+
+/* If a partition is declared with K_APPMEM_PARTITION, but never has any
+ * data assigned to its contents, then no symbols with its prefix will end
+ * up in the symbol table. This prevents gen_app_partitions.py from detecting
+ * that the partition exists, and the linker symbols which specify partition
+ * bounds will not be generated, resulting in build errors.
+ *
+ * What this inline assembly code does is define a symbol with no data.
+ * This should work for all arches that produce ELF binaries, see
+ * https://sourceware.org/binutils/docs/as/Section.html
+ *
+ * We don't know what active flags/type of the pushed section were, so we are
+ * specific: "aw" indicates section is allocatable and writable,
+ * and "@progbits" indicates the section has data.
+ */
+#ifdef CONFIG_ARM
+/* ARM has a quirk in that '@' denotes a comment, so we have to send
+ * %progbits to the assembler instead.
+ */
+#define Z_PROGBITS_SYM	"\%"
+#else
+#define Z_PROGBITS_SYM "@"
+#endif
+
+#define Z_APPMEM_PLACEHOLDER(name) \
+	__asm__ ( \
+		".pushsection " STRINGIFY(K_APP_DMEM_SECTION(name)) \
+			",\"aw\"," Z_PROGBITS_SYM "progbits\n\t" \
+		".global " STRINGIFY(name) "_placeholder\n\t" \
+		STRINGIFY(name) "_placeholder:\n\t" \
+		".popsection\n\t")
+
+/**
+ * @brief Define an application memory partition with linker support
+ *
+ * Defines a k_mem_paritition with the provided name.
+ * This name may be used with the K_APP_DMEM and K_APP_BMEM macros to
+ * place globals automatically in this partition.
+ *
+ * NOTE: placeholder char variable is defined here to prevent build errors
+ * if a partition is defined but nothing ever placed in it.
+ *
+ * @param name Name of the k_mem_partition to declare
+ */
+#define K_APPMEM_PARTITION_DEFINE(name) \
+	extern char Z_APP_START(name)[]; \
+	extern char Z_APP_SIZE(name)[]; \
+	struct k_mem_partition name = { \
+		.start = (u32_t) &Z_APP_START(name), \
+		.size = (u32_t) &Z_APP_SIZE(name), \
+		.attr = K_MEM_PARTITION_P_RW_U_RW \
+	}; \
+	extern char Z_APP_BSS_START(name)[]; \
+	extern char Z_APP_BSS_SIZE(name)[]; \
+	Z_GENERIC_SECTION(.app_regions.name) \
+	struct z_app_region name##_region = { \
+		.bss_start = &Z_APP_BSS_START(name), \
+		.bss_size = (size_t) &Z_APP_BSS_SIZE(name) \
+	}; \
+	Z_APPMEM_PLACEHOLDER(name);
+#else
+
+#define K_APP_BMEM(ptn)
+#define K_APP_DMEM(ptn)
+#define K_APP_DMEM_SECTION(ptn) .data
+#define K_APP_BMEM_SECTION(ptn) .bss
+#define K_APPMEM_PARTITION_DEFINE(name)
+
+#endif /* CONFIG_USERSPACE */
+#endif /* ZEPHYR_INCLUDE_USERSPACE_APP_MEMORY_APP_MEMORY_APP_MEMDOMAIN_H_ */
diff --git a/kernel/compiler_stack_protect.c b/kernel/compiler_stack_protect.c
@@ -22,7 +22,7 @@
 #include <toolchain.h>
 #include <linker/sections.h>
 #include <kernel.h>
-#include <app_memory/app_memdomain.h>
+#include <userspace/app_memory/app_memdomain.h>
 
 /**
  *

diff --git a/kernel/userspace.c b/kernel/userspace.c
@@ -18,7 +18,7 @@
 #include <device.h>
 #include <init.h>
 #include <stdbool.h>
-#include <app_memory/app_memdomain.h>
+#include <userspace/app_memory/app_memdomain.h>
 #include <sys/libc-hooks.h>
 #include <sys/mutex.h>
 

diff --git a/lib/libc/minimal/source/stdlib/malloc.c b/lib/libc/minimal/source/stdlib/malloc.c
@@ -11,7 +11,7 @@
 #include <sys/math_extras.h>
 #include <sys/mempool.h>
 #include <string.h>
-#include <app_memory/app_memdomain.h>
+#include <userspace/app_memory/app_memdomain.h>
 
 #define LOG_LEVEL CONFIG_KERNEL_LOG_LEVEL
 #include <logging/log.h>

diff --git a/lib/libc/newlib/libc-hooks.c b/lib/libc/newlib/libc-hooks.c
@@ -14,7 +14,7 @@
 #include <sys/errno_private.h>
 #include <sys/libc-hooks.h>
 #include <syscall_handler.h>
-#include <app_memory/app_memdomain.h>
+#include <userspace/app_memory/app_memdomain.h>
 #include <init.h>
 
 #define LIBC_BSS	K_APP_BMEM(z_libc_partition)

diff --git a/samples/userspace/shared_mem/src/main.h b/samples/userspace/shared_mem/src/main.h
@@ -13,7 +13,7 @@
 #include <string.h>
 #include <stdlib.h>
 
-#include <app_memory/app_memdomain.h>
+#include <userspace/app_memory/app_memdomain.h>
 #include <sys/util.h>
 
 #if defined(CONFIG_ARC)

diff --git a/subsys/testsuite/ztest/include/ztest_test.h b/subsys/testsuite/ztest/include/ztest_test.h
@@ -13,7 +13,7 @@
 #ifndef __ZTEST_TEST_H__
 #define __ZTEST_TEST_H__
 
-#include <app_memory/app_memdomain.h>
+#include <userspace/app_memory/app_memdomain.h>
 
 struct unit_test {
 	const char *name;

diff --git a/subsys/testsuite/ztest/src/ztest.c b/subsys/testsuite/ztest/src/ztest.c
@@ -6,7 +6,7 @@
 
 #include <ztest.h>
 #include <stdio.h>
-#include <app_memory/app_memdomain.h>
+#include <userspace/app_memory/app_memdomain.h>
 #ifdef CONFIG_USERSPACE
 #include <sys/libc-hooks.h>
 #endif

diff --git a/tests/benchmarks/timing_info/src/userspace_bench.c b/tests/benchmarks/timing_info/src/userspace_bench.c
@@ -14,7 +14,7 @@
 #include <tc_util.h>
 #include <ksched.h>
 #include "timing_info.h"
-#include <app_memory/app_memdomain.h>
+#include <userspace/app_memory/app_memdomain.h>
 
 K_APPMEM_PARTITION_DEFINE(bench_ptn);
 struct k_mem_domain bench_domain;

diff --git a/tests/kernel/mem_protect/userspace/src/main.c b/tests/kernel/mem_protect/userspace/src/main.c
@@ -12,7 +12,7 @@
 #include <kernel_structs.h>
 #include <string.h>
 #include <stdlib.h>
-#include <app_memory/app_memdomain.h>
+#include <userspace/app_memory/app_memdomain.h>
 #include <sys/util.h>
 #include <debug/stack.h>
 #include <syscall_handler.h>