userspace: move mem domain defines
This now has its own header instead of kernel.h. The code is unchanged other than a forward declaration of k_tid_t. Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
This commit is contained in:
Andrew Boie
Anas Nashif
parent
2660878f14
commit
75d5c0bc4b
3 changed files with 152 additions and 133 deletions
151
include/app_memory/mem_domain.h
Normal file
151
include/app_memory/mem_domain.h
Normal file
|
|
@ -0,0 +1,151 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2017 Linaro Limited
|
||||||
|
* Copyright (c) 2018-2020 Intel Corporation
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef INCLUDE_APP_MEMPORY_MEM_DOMAIN_H
|
||||||
|
#define INCLUDE_APP_MEMPORY_MEM_DOMAIN_H
|
||||||
|
|
||||||
|
#include <stdint.h>
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <sys/dlist.h>
|
||||||
|
|
||||||
|
/* Forward declaration */
|
||||||
|
struct k_thread;
|
||||||
|
typedef struct k_thread *k_tid_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup mem_domain_apis Memory domain APIs
|
||||||
|
* @ingroup kernel_apis
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @def K_MEM_PARTITION_DEFINE
|
||||||
|
* @brief Used to declare a memory partition
|
||||||
|
*/
|
||||||
|
#ifdef _ARCH_MEM_PARTITION_ALIGN_CHECK
|
||||||
|
#define K_MEM_PARTITION_DEFINE(name, start, size, attr) \
|
||||||
|
_ARCH_MEM_PARTITION_ALIGN_CHECK(start, size); \
|
||||||
|
struct k_mem_partition name =\
|
||||||
|
{ (uintptr_t)start, size, attr}
|
||||||
|
#else
|
||||||
|
#define K_MEM_PARTITION_DEFINE(name, start, size, attr) \
|
||||||
|
struct k_mem_partition name =\
|
||||||
|
{ (uintptr_t)start, size, attr}
|
||||||
|
#endif /* _ARCH_MEM_PARTITION_ALIGN_CHECK */
|
||||||
|
|
||||||
|
/* memory partition */
|
||||||
|
struct k_mem_partition {
|
||||||
|
/** start address of memory partition */
|
||||||
|
uintptr_t start;
|
||||||
|
/** size of memory partition */
|
||||||
|
size_t size;
|
||||||
|
#if defined(CONFIG_MEMORY_PROTECTION)
|
||||||
|
/** attribute of memory partition */
|
||||||
|
k_mem_partition_attr_t attr;
|
||||||
|
#endif /* CONFIG_MEMORY_PROTECTION */
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Memory Domain
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
struct k_mem_domain {
|
||||||
|
#ifdef CONFIG_USERSPACE
|
||||||
|
/** partitions in the domain */
|
||||||
|
struct k_mem_partition partitions[CONFIG_MAX_DOMAIN_PARTITIONS];
|
||||||
|
#endif /* CONFIG_USERSPACE */
|
||||||
|
/** domain q */
|
||||||
|
sys_dlist_t mem_domain_q;
|
||||||
|
/** number of partitions in the domain */
|
||||||
|
uint8_t num_partitions;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Initialize a memory domain.
|
||||||
|
*
|
||||||
|
* Initialize a memory domain with given name and memory partitions.
|
||||||
|
*
|
||||||
|
* See documentation for k_mem_domain_add_partition() for details about
|
||||||
|
* partition constraints.
|
||||||
|
*
|
||||||
|
* @param domain The memory domain to be initialized.
|
||||||
|
* @param num_parts The number of array items of "parts" parameter.
|
||||||
|
* @param parts An array of pointers to the memory partitions. Can be NULL
|
||||||
|
* if num_parts is zero.
|
||||||
|
*/
|
||||||
|
extern void k_mem_domain_init(struct k_mem_domain *domain, uint8_t num_parts,
|
||||||
|
struct k_mem_partition *parts[]);
|
||||||
|
/**
|
||||||
|
* @brief Destroy a memory domain.
|
||||||
|
*
|
||||||
|
* Destroy a memory domain.
|
||||||
|
*
|
||||||
|
* @param domain The memory domain to be destroyed.
|
||||||
|
*/
|
||||||
|
extern void k_mem_domain_destroy(struct k_mem_domain *domain);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Add a memory partition into a memory domain.
|
||||||
|
*
|
||||||
|
* Add a memory partition into a memory domain. Partitions must conform to
|
||||||
|
* the following constraints:
|
||||||
|
*
|
||||||
|
* - Partition bounds must be within system RAM boundaries on MMU-based
|
||||||
|
* systems.
|
||||||
|
* - Partitions in the same memory domain may not overlap each other.
|
||||||
|
* - Partitions must not be defined which expose private kernel
|
||||||
|
* data structures or kernel objects.
|
||||||
|
* - The starting address alignment, and the partition size must conform to
|
||||||
|
* the constraints of the underlying memory management hardware, which
|
||||||
|
* varies per architecture.
|
||||||
|
* - Memory domain partitions are only intended to control access to memory
|
||||||
|
* from user mode threads.
|
||||||
|
*
|
||||||
|
* Violating these constraints may lead to CPU exceptions or undefined
|
||||||
|
* behavior.
|
||||||
|
*
|
||||||
|
* @param domain The memory domain to be added a memory partition.
|
||||||
|
* @param part The memory partition to be added
|
||||||
|
*/
|
||||||
|
extern void k_mem_domain_add_partition(struct k_mem_domain *domain,
|
||||||
|
struct k_mem_partition *part);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Remove a memory partition from a memory domain.
|
||||||
|
*
|
||||||
|
* Remove a memory partition from a memory domain.
|
||||||
|
*
|
||||||
|
* @param domain The memory domain to be removed a memory partition.
|
||||||
|
* @param part The memory partition to be removed
|
||||||
|
*/
|
||||||
|
extern void k_mem_domain_remove_partition(struct k_mem_domain *domain,
|
||||||
|
struct k_mem_partition *part);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Add a thread into a memory domain.
|
||||||
|
*
|
||||||
|
* Add a thread into a memory domain.
|
||||||
|
*
|
||||||
|
* @param domain The memory domain that the thread is going to be added into.
|
||||||
|
* @param thread ID of thread going to be added into the memory domain.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
extern void k_mem_domain_add_thread(struct k_mem_domain *domain,
|
||||||
|
k_tid_t thread);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Remove a thread from its memory domain.
|
||||||
|
*
|
||||||
|
* Remove a thread from its memory domain.
|
||||||
|
*
|
||||||
|
* @param thread ID of thread going to be removed from its memory domain.
|
||||||
|
*/
|
||||||
|
extern void k_mem_domain_remove_thread(k_tid_t thread);
|
||||||
|
|
||||||
|
/** @} */
|
||||||
|
#endif /* INCLUDE_APP_MEMORY_MEM_DOMAIN_H */
|
||||||
133
include/kernel.h
133
include/kernel.h
|
|
@ -5323,139 +5323,6 @@ extern bool z_is_thread_essential(void);
|
||||||
*/
|
*/
|
||||||
extern void z_timer_expiration_handler(struct _timeout *t);
|
extern void z_timer_expiration_handler(struct _timeout *t);
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup mem_domain_apis Memory domain APIs
|
|
||||||
* @ingroup kernel_apis
|
|
||||||
* @{
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @def K_MEM_PARTITION_DEFINE
|
|
||||||
* @brief Used to declare a memory partition
|
|
||||||
*/
|
|
||||||
#ifdef _ARCH_MEM_PARTITION_ALIGN_CHECK
|
|
||||||
#define K_MEM_PARTITION_DEFINE(name, start, size, attr) \
|
|
||||||
_ARCH_MEM_PARTITION_ALIGN_CHECK(start, size); \
|
|
||||||
struct k_mem_partition name =\
|
|
||||||
{ (uintptr_t)start, size, attr}
|
|
||||||
#else
|
|
||||||
#define K_MEM_PARTITION_DEFINE(name, start, size, attr) \
|
|
||||||
struct k_mem_partition name =\
|
|
||||||
{ (uintptr_t)start, size, attr}
|
|
||||||
#endif /* _ARCH_MEM_PARTITION_ALIGN_CHECK */
|
|
||||||
|
|
||||||
/* memory partition */
|
|
||||||
struct k_mem_partition {
|
|
||||||
/** start address of memory partition */
|
|
||||||
uintptr_t start;
|
|
||||||
/** size of memory partition */
|
|
||||||
size_t size;
|
|
||||||
#if defined(CONFIG_MEMORY_PROTECTION)
|
|
||||||
/** attribute of memory partition */
|
|
||||||
k_mem_partition_attr_t attr;
|
|
||||||
#endif /* CONFIG_MEMORY_PROTECTION */
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Memory Domain
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
struct k_mem_domain {
|
|
||||||
#ifdef CONFIG_USERSPACE
|
|
||||||
/** partitions in the domain */
|
|
||||||
struct k_mem_partition partitions[CONFIG_MAX_DOMAIN_PARTITIONS];
|
|
||||||
#endif /* CONFIG_USERSPACE */
|
|
||||||
/** domain q */
|
|
||||||
sys_dlist_t mem_domain_q;
|
|
||||||
/** number of partitions in the domain */
|
|
||||||
uint8_t num_partitions;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Initialize a memory domain.
|
|
||||||
*
|
|
||||||
* Initialize a memory domain with given name and memory partitions.
|
|
||||||
*
|
|
||||||
* See documentation for k_mem_domain_add_partition() for details about
|
|
||||||
* partition constraints.
|
|
||||||
*
|
|
||||||
* @param domain The memory domain to be initialized.
|
|
||||||
* @param num_parts The number of array items of "parts" parameter.
|
|
||||||
* @param parts An array of pointers to the memory partitions. Can be NULL
|
|
||||||
* if num_parts is zero.
|
|
||||||
*/
|
|
||||||
extern void k_mem_domain_init(struct k_mem_domain *domain, uint8_t num_parts,
|
|
||||||
struct k_mem_partition *parts[]);
|
|
||||||
/**
|
|
||||||
* @brief Destroy a memory domain.
|
|
||||||
*
|
|
||||||
* Destroy a memory domain.
|
|
||||||
*
|
|
||||||
* @param domain The memory domain to be destroyed.
|
|
||||||
*/
|
|
||||||
extern void k_mem_domain_destroy(struct k_mem_domain *domain);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Add a memory partition into a memory domain.
|
|
||||||
*
|
|
||||||
* Add a memory partition into a memory domain. Partitions must conform to
|
|
||||||
* the following constraints:
|
|
||||||
*
|
|
||||||
* - Partition bounds must be within system RAM boundaries on MMU-based
|
|
||||||
* systems.
|
|
||||||
* - Partitions in the same memory domain may not overlap each other.
|
|
||||||
* - Partitions must not be defined which expose private kernel
|
|
||||||
* data structures or kernel objects.
|
|
||||||
* - The starting address alignment, and the partition size must conform to
|
|
||||||
* the constraints of the underlying memory management hardware, which
|
|
||||||
* varies per architecture.
|
|
||||||
* - Memory domain partitions are only intended to control access to memory
|
|
||||||
* from user mode threads.
|
|
||||||
*
|
|
||||||
* Violating these constraints may lead to CPU exceptions or undefined
|
|
||||||
* behavior.
|
|
||||||
*
|
|
||||||
* @param domain The memory domain to be added a memory partition.
|
|
||||||
* @param part The memory partition to be added
|
|
||||||
*/
|
|
||||||
extern void k_mem_domain_add_partition(struct k_mem_domain *domain,
|
|
||||||
struct k_mem_partition *part);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Remove a memory partition from a memory domain.
|
|
||||||
*
|
|
||||||
* Remove a memory partition from a memory domain.
|
|
||||||
*
|
|
||||||
* @param domain The memory domain to be removed a memory partition.
|
|
||||||
* @param part The memory partition to be removed
|
|
||||||
*/
|
|
||||||
extern void k_mem_domain_remove_partition(struct k_mem_domain *domain,
|
|
||||||
struct k_mem_partition *part);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Add a thread into a memory domain.
|
|
||||||
*
|
|
||||||
* Add a thread into a memory domain.
|
|
||||||
*
|
|
||||||
* @param domain The memory domain that the thread is going to be added into.
|
|
||||||
* @param thread ID of thread going to be added into the memory domain.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
extern void k_mem_domain_add_thread(struct k_mem_domain *domain,
|
|
||||||
k_tid_t thread);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Remove a thread from its memory domain.
|
|
||||||
*
|
|
||||||
* Remove a thread from its memory domain.
|
|
||||||
*
|
|
||||||
* @param thread ID of thread going to be removed from its memory domain.
|
|
||||||
*/
|
|
||||||
extern void k_mem_domain_remove_thread(k_tid_t thread);
|
|
||||||
|
|
||||||
/** @} */
|
|
||||||
|
|
||||||
#ifdef CONFIG_PRINTK
|
#ifdef CONFIG_PRINTK
|
||||||
/**
|
/**
|
||||||
* @brief Emit a character buffer to the console device
|
* @brief Emit a character buffer to the console device
|
||||||
|
|
|
||||||
|
|
@ -42,5 +42,6 @@
|
||||||
#include <fatal.h>
|
#include <fatal.h>
|
||||||
#include <irq.h>
|
#include <irq.h>
|
||||||
#include <sys/thread_stack.h>
|
#include <sys/thread_stack.h>
|
||||||
|
#include <app_memory/mem_domain.h>
|
||||||
|
|
||||||
#endif /* ZEPHYR_INCLUDE_KERNEL_INCLUDES_H_ */
|
#endif /* ZEPHYR_INCLUDE_KERNEL_INCLUDES_H_ */
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue