userspace: remove APPLICATION_MEMORY feature

This was never a long-term solution, more of a gross hack
to get test cases working until we could figure out a good
end-to-end solution for memory domains that generated
appropriate linker sections. Now that we have this with
the app shared memory feature, and have converted all tests
to remove it, delete this feature.

To date all userspace APIs have been tagged as 'experimental'
which sidesteps deprecation policies.

Signed-off-by: Andrew Boie <[email protected]>

Author: Andrew Boie

CMakeLists.txt

@@ -341,12 +341,9 @@ zephyr_cc_option(-Wpointer-arith)
 
 # Declare MPU userspace dependencies before the linker scripts to make
 # sure the order of dependencies are met
-if(CONFIG_APP_SHARED_MEM AND CONFIG_USERSPACE)
+if(CONFIG_USERSPACE)
+  if(CONFIG_APP_SHARED_MEM)
     set(APP_SMEM_DEP app_smem_linker)
-endif()
-if(CONFIG_CPU_HAS_MPU AND CONFIG_USERSPACE)
-  if(CONFIG_MPU_REQUIRES_POWER_OF_TWO_ALIGNMENT AND CONFIG_ARC AND CONFIG_APPLICATION_MEMORY)
-    set(ALIGN_SIZING_DEP app_sizing_prebuilt linker_app_sizing_script)
   endif()
   if(CONFIG_ARM)
     set(PRIV_STACK_DEP priv_stacks_prebuilt)
@@ -745,101 +742,6 @@ endforeach()
 
 get_property(OUTPUT_FORMAT        GLOBAL PROPERTY PROPERTY_OUTPUT_FORMAT)
 
-if(CONFIG_APPLICATION_MEMORY)
-  # Objects default to being in kernel space, and then we exclude
-  # certain items.
-  set(kernel_object_file_list
-    ${ZEPHYR_LIBS_PROPERTY}
-    kernel
-    )
-  list(
-    REMOVE_ITEM
-    kernel_object_file_list
-    app
-    )
-
-  # The zephyr libraries in zephyr/lib/ and zephyr/test/ belong in
-  # userspace.
-
-  # NB: The business logic for determing what source files are in
-  # kernel space and what source files are in user space is
-  # fragile. Fix ASAP.
-  #
-  # The intended design is that certain directories are designated as
-  # containing userspace code and others for kernel space code. The
-  # implementation we have however is not working on directories of
-  # code, it is working on zephyr libraries. It is exploiting the fact
-  # that zephyr libraries follow a naming scheme as described in
-  # extensions.cmake:zephyr_library_get_current_dir_lib_name
-  #
-  # But code from test/ and lib/ that is placed in the "zephyr"
-  # library (with zephyr_sources()) will not be in a library that is
-  # prefixed with lib__ or test__ and will end up in the wrong address
-  # space.
-  set(application_space_dirs
-    lib
-    tests
-    )
-  foreach(f ${kernel_object_file_list})
-    foreach(app_dir ${application_space_dirs})
-      if(${f} MATCHES "^${app_dir}__") # Begins with ${app_dir}__, e.g. lib__libc
-        list(
-          REMOVE_ITEM
-          kernel_object_file_list
-          ${f}
-          )
-      endif()
-    endforeach()
-  endforeach()
-
-  # Create a list ks, with relative paths to kernel space libs.
-  foreach(f ${kernel_object_file_list})
-    get_target_property(target_name       ${f} NAME)
-    get_target_property(target_binary_dir ${f} BINARY_DIR)
-
-    string(REPLACE
-      ${PROJECT_BINARY_DIR}
-      ""
-      fixed_path
-      ${target_binary_dir}
-      )
-
-    # Append / if not empty
-    if(fixed_path)
-      set(fixed_path "${fixed_path}/")
-    endif()
-
-    # Cut off leading / if present
-    if(fixed_path MATCHES "^/.+")
-      string(SUBSTRING ${fixed_path} 1 -1 fixed_path)
-    endif()
-
-    set(fixed_path "${fixed_path}lib${target_name}.a")
-
-    if(CMAKE_GENERATOR STREQUAL "Ninja")
-      # Ninja invokes the linker from the root of the build directory
-      # (APPLICATION_BINARY_DIR) instead of from the build/zephyr
-      # directory (PROJECT_BINARY_DIR). So for linker-defs.h to get
-      # the correct path we need to prefix with zephyr/.
-      set(fixed_path "zephyr/${fixed_path}")
-    endif()
-
-    list(APPEND ks ${fixed_path})
-  endforeach()
-
-  # We are done constructing kernel_object_file_list, now we inject
-  # this list into the linker script through the define
-  # KERNELSPACE_OBJECT_FILES
-  set(def -DKERNELSPACE_OBJECT_FILES=)
-  foreach(f ${ks})
-    set(def "${def} ${f}")
-  endforeach()
-  set_property(GLOBAL APPEND PROPERTY
-    PROPERTY_LINKER_SCRIPT_DEFINES
-    ${def}
-    )
-endif() # CONFIG_APPLICATION_MEMORY
-
 if (CONFIG_CODE_DATA_RELOCATION)
   set(CODE_RELOCATION_DEP code_relocation_source_lib)
 endif() # CONFIG_CODE_DATA_RELOCATION
@@ -1244,52 +1146,7 @@ if(CONFIG_APP_SHARED_MEM AND CONFIG_USERSPACE)
     )
 endif()
 
-if(CONFIG_CPU_HAS_MPU AND CONFIG_USERSPACE)
-
-  if(CONFIG_MPU_REQUIRES_POWER_OF_TWO_ALIGNMENT AND CONFIG_ARC AND CONFIG_APPLICATION_MEMORY)
-
-    construct_add_custom_command_for_linker_pass(linker_app_sizing custom_command)
-    add_custom_command(
-      ${custom_command}
-      )
-
-    add_custom_target(
-      linker_app_sizing_script
-      DEPENDS
-      linker_app_sizing.cmd
-      ${OFFSETS_H_TARGET}
-      ${APP_SMEM_DEP}
-      ${CODE_RELOCATION_DEP}
-    )
-
-    set_property(TARGET
-      linker_app_sizing_script
-      PROPERTY INCLUDE_DIRECTORIES
-      ${ZEPHYR_INCLUDE_DIRS}
-      )
-
-    # For systems with MPUs, the size of the application data section must
-    # be determined so that MPU alignment requirements can be met.
-    # Create a app_sizing_prebuilt target so we can do this before the
-    # other ELF files are built
-    set(GEN_APP_ALIGN $ENV{ZEPHYR_BASE}/scripts/gen_alignment_script.py)
-    add_executable(       app_sizing_prebuilt misc/empty_file.c)
-    target_link_libraries(app_sizing_prebuilt ${TOPT} ${PROJECT_BINARY_DIR}/linker_app_sizing.cmd ${zephyr_lnk} ${CODE_RELOCATION_DEP})
-    set_property(TARGET   app_sizing_prebuilt PROPERTY LINK_DEPENDS ${PROJECT_BINARY_DIR}/linker_app_sizing.cmd)
-    add_dependencies(     app_sizing_prebuilt linker_app_sizing_script ${OFFSETS_LIB} ${CODE_RELOCATION_DEP} )
-
-    add_custom_command(
-      TARGET app_sizing_prebuilt
-      POST_BUILD
-      COMMAND ${PYTHON_EXECUTABLE} ${GEN_APP_ALIGN}
-      --output ./include/generated/app_data_alignment.ld
-      --kernel $<TARGET_FILE:app_sizing_prebuilt>
-      VERBATIM
-      WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/
-   )
-  endif()
-
-if(CONFIG_ARM)
+if(CONFIG_USERSPACE AND CONFIG_ARM)
   construct_add_custom_command_for_linker_pass(linker_priv_stacks custom_command)
   add_custom_command(
     ${custom_command}
@@ -1317,8 +1174,6 @@ if(CONFIG_ARM)
   add_dependencies(     priv_stacks_prebuilt ${ALIGN_SIZING_DEP} linker_priv_stacks_script ${OFFSETS_LIB})
 endif()
 
-endif()
-
 # FIXME: Is there any way to get rid of empty_file.c?
 add_executable(       ${ZEPHYR_PREBUILT_EXECUTABLE} misc/empty_file.c)
 target_link_libraries(${ZEPHYR_PREBUILT_EXECUTABLE} ${TOPT} ${PROJECT_BINARY_DIR}/linker.cmd ${PRIV_STACK_LIB} ${zephyr_lnk} ${CODE_RELOCATION_DEP})

arch/arc/core/mpu/arc_mpu.c

@@ -447,51 +447,19 @@ void arc_core_mpu_configure_user_context(struct k_thread *thread)
 	/* for kernel threads, no need to configure user context */
 	if (!(thread->base.user_options & K_USER)) {
 #if defined(CONFIG_APP_SHARED_MEM) && CONFIG_ARC_MPU_VER == 3
-/*
- * APP_SHARED_MEM is handled here, all privileged threads have the right
- * to access it. APPLICATION_MEMORY will be handled as a static memory region
- */
+		/* APP_SHARED_MEM is handled here, all privileged threads have
+		 * the right to access it.
+		 */
 		base = (u32_t)&_app_smem_start;
 		size = (u32_t)&_app_smem_size;
-		_region_init(_get_region_index_by_type(THREAD_APP_DATA_REGION)
-			     , base, size, _get_region_attr_by_type(THREAD_APP_DATA_REGION));
+		_region_init(_get_region_index_by_type(THREAD_APP_DATA_REGION),
+			     base, size,
+			     _get_region_attr_by_type(THREAD_APP_DATA_REGION));
 #endif
 		return;
 	}
 
 	arc_core_mpu_configure(THREAD_STACK_USER_REGION, base, size);
-
-	/* configure app data portion */
-#ifdef CONFIG_APPLICATION_MEMORY
-#if CONFIG_ARC_MPU_VER == 2
-	/*
-	 * _app_ram_size is guaranteed to be power of two, and
-	 * _app_ram_start is guaranteed to be aligned _app_ram_size
-	 * in linker template
-	 */
-	base = (u32_t)&__app_ram_start;
-	size = (u32_t)&__app_ram_size;
-
-	/* set up app data region if exists, otherwise disable */
-	if (size > 0) {
-		arc_core_mpu_configure(THREAD_APP_DATA_REGION, base, size);
-	}
-#elif CONFIG_ARC_MPU_VER == 3
-	/*
-	 * ARC MPV v3 doesn't support MPU region overlap.
-	 * Application memory should be a static memory, defined in mpu_config
-	 *
-	 * here, need to clear THREAD_APP_DATA_REGION for user thread as it will
-	 * be set by kernel thread to to access app_shared mem. For user thread
-	 * the handling of app_shared mem is done by
-	 * THREAD_DOMAIN_PARTITION_REGION
-	 */
-#if defined(CONFIG_APP_SHARED_MEM)
-	_region_init(_get_region_index_by_type(THREAD_APP_DATA_REGION)
-		     , 0, 0, 0);
-#endif
-#endif
-#endif
 }
 
 /**

arch/arm/core/cortex_m/mpu/arm_core_mpu.c

@@ -65,13 +65,6 @@ void _arch_configure_static_mpu_regions(void)
 	 * MPU regions.
 	 */
 	const struct k_mem_partition static_regions[] = {
-#if defined(CONFIG_APPLICATION_MEMORY)
-		{
-		.start = (u32_t)&__app_ram_start,
-		.size = (u32_t)&__app_ram_end - (u32_t)&__app_ram_start,
-		.attr = K_MEM_PARTITION_P_RW_U_RW,
-		},
-#endif /* CONFIG_APPLICATION_MEMORY */
 #if defined(CONFIG_COVERAGE_GCOV) && defined(CONFIG_USERSPACE)
 		{
 		.start = (u32_t)&__gcov_bss_start,
@@ -105,13 +98,6 @@ void _arch_configure_static_mpu_regions(void)
 	 * initialization.
 	 */
 	const struct k_mem_partition dyn_region_areas[] = {
-#if defined(CONFIG_APPLICATION_MEMORY)
-	/* Dynamic areas are also allowed in Application Memory. */
-		{
-		.start = (u32_t)&__app_ram_start,
-		.size = (u32_t)&__app_ram_end - (u32_t)&__app_ram_start,
-		},
-#endif /* CONFIG_APPLICATION_MEMORY */
 		{
 		.start = _MPU_DYNAMIC_REGIONS_AREA_START,
 		.size =  _MPU_DYNAMIC_REGIONS_AREA_SIZE,

arch/x86/core/crt0.S

@@ -314,14 +314,6 @@ __csSet:
 
 	call	_x86_data_copy
 
-#ifdef CONFIG_APPLICATION_MEMORY
-	movl	$__app_data_ram_start, %edi /* DATA in RAM (dest) */
-	movl	$__app_data_rom_start, %esi /* DATA in ROM (src) */
-	movl	$__app_data_num_words, %ecx /* Size of DATA in quad bytes */
-
-	call	_x86_data_copy
-#endif /* CONFIG_APPLICATION_MEMORY */
-
 #ifdef CONFIG_APP_SHARED_MEM
 	movl	$_app_smem_start, %edi /* DATA in RAM (dest) */
 	movl	$_app_smem_rom_start, %esi /* DATA in ROM (src) */
@@ -348,12 +340,6 @@ __csSet:
 	call	_x86_bss_zero
 #endif /* CONFIG_COVERAGE_GCOV */
 
-#ifdef CONFIG_APPLICATION_MEMORY
-	movl	$__app_bss_start, %edi		/* load app BSS start address */
-	movl	$__app_bss_num_words, %ecx	/* number of quad bytes */
-	call	_x86_bss_zero
-#endif
-
 #ifdef CONFIG_GDT_DYNAMIC
 	/* activate RAM-based Global Descriptor Table (GDT) */
 	lgdt	%ds:_gdt

arch/x86/core/x86_mmu.c

@@ -20,11 +20,6 @@
 MMU_BOOT_REGION((u32_t)&_image_rom_start, (u32_t)&_image_rom_size,
 		MMU_ENTRY_READ | MMU_ENTRY_USER);
 
-#ifdef CONFIG_APPLICATION_MEMORY
-/* User threads by default can read/write app-level memory. */
-MMU_BOOT_REGION((u32_t)&__app_ram_start, (u32_t)&__app_ram_size,
-		MMU_ENTRY_WRITE | MMU_ENTRY_USER | MMU_ENTRY_EXECUTE_DISABLE);
-#endif
 #ifdef CONFIG_APP_SHARED_MEM
 MMU_BOOT_REGION((u32_t)&_app_smem_start, (u32_t)&_app_smem_size,
 		MMU_ENTRY_WRITE | MMU_ENTRY_USER | MMU_ENTRY_EXECUTE_DISABLE);

boards/arc/em_starterkit/arc_mpu_regions.c

@@ -11,22 +11,6 @@
 
 #ifdef CONFIG_USERSPACE
 static struct arc_mpu_region mpu_regions[] = {
-#if CONFIG_ARC_MPU_VER == 3 && defined(CONFIG_APPLICATION_MEMORY)
-	/* Region ICCM */
-	MPU_REGION_ENTRY("IMAGE ROM",
-			 (u32_t) _image_rom_start,
-			 (u32_t) _image_rom_size,
-			 REGION_FLASH_ATTR),
-	MPU_REGION_ENTRY("APP MEMORY",
-			 (u32_t) __app_ram_start,
-			 (u32_t) __app_ram_size,
-			 REGION_RAM_ATTR),
-	MPU_REGION_ENTRY("KERNEL MEMORY",
-			 (u32_t) __kernel_ram_start,
-			 (u32_t) __kernel_ram_size,
-			 AUX_MPU_RDP_KW | AUX_MPU_RDP_KR),
-
-#else
 #if DT_ICCM_SIZE > 0
 	/* Region ICCM */
 	MPU_REGION_ENTRY("ICCM",
@@ -49,7 +33,6 @@ static struct arc_mpu_region mpu_regions[] = {
 			AUX_MPU_RDP_KW | AUX_MPU_RDP_KR |
 			AUX_MPU_RDP_KE | AUX_MPU_RDP_UE),
 #endif
-#endif /* ARC_MPU_VER == 3 */
 	/* Region Peripheral */
 	MPU_REGION_ENTRY("PERIPHERAL",
 			 0xF0000000,

boards/arc/nsim_em/arc_mpu_regions.c

@@ -11,16 +11,12 @@
 
 #ifdef CONFIG_USERSPACE
 static struct arc_mpu_region mpu_regions[] = {
-#if CONFIG_ARC_MPU_VER == 3 && defined(CONFIG_APPLICATION_MEMORY)
+#if CONFIG_ARC_MPU_VER == 3
 	/* Region ICCM */
 	MPU_REGION_ENTRY("IMAGE ROM",
 			 (u32_t) _image_rom_start,
 			 (u32_t) _image_rom_size,
 			 REGION_FLASH_ATTR),
-	MPU_REGION_ENTRY("APP MEMORY",
-			 (u32_t) __app_ram_start,
-			 (u32_t) __app_ram_size,
-			 REGION_RAM_ATTR),
 	MPU_REGION_ENTRY("KERNEL MEMORY",
 			 (u32_t) __kernel_ram_start,
 			 (u32_t) __kernel_ram_size,

doc/reference/kernel/usermode/kernelobjects.rst

@@ -56,17 +56,8 @@ call APIs, several conditions must be met on how the kernel object is declared:
   in a special table of kernel object metadata.  Kernel objects may be members
   of arrays or embedded within other data structures.
 
-* Kernel objects must be located in memory reserved for the kernel. If
-  :option:`CONFIG_APPLICATION_MEMORY` is used, all declarations of kernel
-  objects inside application code must be prefixed with the :c:macro:`__kernel`
-  attribute so that they are placed in the right memory sections. The APIs for
-  statically declaring and initializing kernel objects (such as
-  :c:macro:`K_SEM_DEFINE()`) automatically do this. However, uninitialized
-  kernel objects need to be tagged like this:
-
-.. code-block:: c
-
-    __kernel struct k_sem my_sem;
+* Kernel objects must be located in memory reserved for the kernel. They
+  must not be located in any memory partitions that are user-accessible.
 
 * Any memory reserved for a kernel object must be used exclusively for that
   object. Kernel objects may not be members of a union data type.
@@ -232,7 +223,7 @@ are embedded within some larger struct and initialized statically.
         ...
     };
 
-    __kernel struct foo my_foo = {
+    struct foo my_foo = {
         .sem = _K_SEM_INITIALIZER(my_foo.sem, 0, 1),
         ...
     };
@@ -274,7 +265,7 @@ Configuration Options
 Related configuration options:
 
 * :option:`CONFIG_USERSPACE`
-* :option:`CONFIG_APPLICATION_MEMORY`
+* :option:`CONFIG_APP_SHARED_MEM`
 * :option:`CONFIG_MAX_THREAD_BYTES`
 
 API Reference