2017-07-07 20:29:30 +08:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2017 Linaro Limited
|
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <init.h>
|
|
|
|
#include <kernel.h>
|
|
|
|
#include <kernel_structs.h>
|
2018-01-31 12:41:47 +08:00
|
|
|
#include <kernel_internal.h>
|
2019-06-26 22:33:39 +08:00
|
|
|
#include <sys/__assert.h>
|
2018-09-19 03:32:27 +08:00
|
|
|
#include <stdbool.h>
|
2018-07-25 02:35:55 +08:00
|
|
|
#include <spinlock.h>
|
2020-08-26 05:42:33 +08:00
|
|
|
#include <sys/libc-hooks.h>
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-08-20 04:11:47 +08:00
|
|
|
#define LOG_LEVEL CONFIG_KERNEL_LOG_LEVEL
|
|
|
|
#include <logging/log.h>
|
|
|
|
LOG_MODULE_DECLARE(os);
|
|
|
|
|
2020-10-07 06:53:43 +08:00
|
|
|
struct k_spinlock z_mem_domain_lock;
|
2020-05-28 00:26:57 +08:00
|
|
|
static uint8_t max_partitions;
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-08-26 05:42:33 +08:00
|
|
|
struct k_mem_domain k_mem_domain_default;
|
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
#if __ASSERT_ON
|
|
|
|
static bool check_add_partition(struct k_mem_domain *domain,
|
|
|
|
struct k_mem_partition *part)
|
2018-03-01 06:11:41 +08:00
|
|
|
{
|
2020-08-20 06:06:37 +08:00
|
|
|
|
|
|
|
int i;
|
|
|
|
uintptr_t pstart, pend, dstart, dend;
|
|
|
|
|
|
|
|
if (part == NULL) {
|
|
|
|
LOG_ERR("NULL k_mem_partition provided");
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
#ifdef CONFIG_EXECUTE_XOR_WRITE
|
|
|
|
/* Arches where execution cannot be disabled should always return
|
|
|
|
* false to this check
|
|
|
|
*/
|
|
|
|
if (K_MEM_PARTITION_IS_EXECUTABLE(part->attr) &&
|
|
|
|
K_MEM_PARTITION_IS_WRITABLE(part->attr)) {
|
|
|
|
LOG_ERR("partition is writable and executable <start %lx>",
|
|
|
|
part->start);
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
if (part->size == 0) {
|
|
|
|
LOG_ERR("zero sized partition at %p with base 0x%lx",
|
|
|
|
part, part->start);
|
2018-03-01 06:11:41 +08:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
pstart = part->start;
|
|
|
|
pend = part->start + part->size;
|
|
|
|
|
|
|
|
if (pend <= pstart) {
|
|
|
|
LOG_ERR("invalid partition %p, wraparound detected. base 0x%lx size %zu",
|
|
|
|
part, part->start, part->size);
|
|
|
|
return false;
|
|
|
|
}
|
2018-03-01 06:11:41 +08:00
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
/* Check that this partition doesn't overlap any existing ones already
|
|
|
|
* in the domain
|
|
|
|
*/
|
|
|
|
for (i = 0; i < domain->num_partitions; i++) {
|
|
|
|
struct k_mem_partition *dpart = &domain->partitions[i];
|
2018-03-01 06:11:41 +08:00
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
if (dpart->size == 0) {
|
|
|
|
/* Unused slot */
|
2018-03-01 06:11:41 +08:00
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
dstart = dpart->start;
|
|
|
|
dend = dstart + dpart->size;
|
2018-03-01 06:11:41 +08:00
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
if (pend > dstart && dend > pstart) {
|
|
|
|
LOG_ERR("partition %p base %lx (size %zu) overlaps existing base %lx (size %zu)",
|
|
|
|
part, part->start, part->size,
|
|
|
|
dpart->start, dpart->size);
|
2018-03-01 06:11:41 +08:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
2017-10-18 08:01:48 +08:00
|
|
|
|
2018-03-01 06:11:41 +08:00
|
|
|
return true;
|
|
|
|
}
|
2020-07-18 04:48:36 +08:00
|
|
|
#endif
|
|
|
|
|
2020-05-28 00:26:57 +08:00
|
|
|
void k_mem_domain_init(struct k_mem_domain *domain, uint8_t num_parts,
|
2018-03-01 06:22:57 +08:00
|
|
|
struct k_mem_partition *parts[])
|
2017-07-07 20:29:30 +08:00
|
|
|
{
|
2018-07-25 02:35:55 +08:00
|
|
|
k_spinlock_key_t key;
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
__ASSERT_NO_MSG(domain != NULL);
|
|
|
|
__ASSERT(num_parts == 0U || parts != NULL,
|
|
|
|
"parts array is NULL and num_parts is nonzero");
|
|
|
|
__ASSERT(num_parts <= max_partitions,
|
|
|
|
"num_parts of %d exceeds maximum allowable partitions (%d)",
|
|
|
|
num_parts, max_partitions);
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-10-07 06:53:43 +08:00
|
|
|
key = k_spin_lock(&z_mem_domain_lock);
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2019-03-27 09:57:45 +08:00
|
|
|
domain->num_partitions = 0U;
|
2018-09-12 10:09:03 +08:00
|
|
|
(void)memset(domain->partitions, 0, sizeof(domain->partitions));
|
2017-07-07 20:29:30 +08:00
|
|
|
sys_dlist_init(&domain->mem_domain_q);
|
|
|
|
|
2020-08-20 04:11:47 +08:00
|
|
|
#ifdef CONFIG_ARCH_MEM_DOMAIN_DATA
|
|
|
|
int ret = arch_mem_domain_init(domain);
|
|
|
|
|
|
|
|
/* TODO propagate return values, see #24609.
|
|
|
|
*
|
|
|
|
* Not using an assertion here as this is a memory allocation error
|
|
|
|
*/
|
|
|
|
if (ret != 0) {
|
|
|
|
LOG_ERR("architecture-specific initialization failed for domain %p with %d",
|
|
|
|
domain, ret);
|
|
|
|
k_panic();
|
|
|
|
}
|
|
|
|
#endif
|
2020-10-17 07:49:41 +08:00
|
|
|
if (num_parts != 0U) {
|
|
|
|
uint32_t i;
|
|
|
|
|
|
|
|
for (i = 0U; i < num_parts; i++) {
|
|
|
|
__ASSERT(check_add_partition(domain, parts[i]),
|
|
|
|
"invalid partition index %d (%p)",
|
|
|
|
i, parts[i]);
|
|
|
|
|
|
|
|
domain->partitions[i] = *parts[i];
|
|
|
|
domain->num_partitions++;
|
|
|
|
#ifdef CONFIG_ARCH_MEM_DOMAIN_SYNCHRONOUS_API
|
|
|
|
arch_mem_domain_partition_add(domain, i);
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
}
|
2020-08-20 04:11:47 +08:00
|
|
|
|
2020-10-07 06:53:43 +08:00
|
|
|
k_spin_unlock(&z_mem_domain_lock, key);
|
2017-07-07 20:29:30 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void k_mem_domain_add_partition(struct k_mem_domain *domain,
|
2018-03-01 06:11:41 +08:00
|
|
|
struct k_mem_partition *part)
|
2017-07-07 20:29:30 +08:00
|
|
|
{
|
|
|
|
int p_idx;
|
2018-07-25 02:35:55 +08:00
|
|
|
k_spinlock_key_t key;
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
__ASSERT_NO_MSG(domain != NULL);
|
|
|
|
__ASSERT(check_add_partition(domain, part),
|
|
|
|
"invalid partition %p", part);
|
2017-10-18 08:01:48 +08:00
|
|
|
|
2020-10-07 06:53:43 +08:00
|
|
|
key = k_spin_lock(&z_mem_domain_lock);
|
2017-07-07 20:29:30 +08:00
|
|
|
|
|
|
|
for (p_idx = 0; p_idx < max_partitions; p_idx++) {
|
|
|
|
/* A zero-sized partition denotes it's a free partition */
|
2019-03-27 09:57:45 +08:00
|
|
|
if (domain->partitions[p_idx].size == 0U) {
|
2017-07-07 20:29:30 +08:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
__ASSERT(p_idx < max_partitions,
|
|
|
|
"no free partition slots available");
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-08-26 07:47:44 +08:00
|
|
|
LOG_DBG("add partition base %lx size %zu to domain %p\n",
|
|
|
|
part->start, part->size, domain);
|
|
|
|
|
2017-07-07 20:29:30 +08:00
|
|
|
domain->partitions[p_idx].start = part->start;
|
|
|
|
domain->partitions[p_idx].size = part->size;
|
|
|
|
domain->partitions[p_idx].attr = part->attr;
|
|
|
|
|
|
|
|
domain->num_partitions++;
|
|
|
|
|
2020-08-26 08:02:38 +08:00
|
|
|
#ifdef CONFIG_ARCH_MEM_DOMAIN_SYNCHRONOUS_API
|
2019-11-08 04:43:29 +08:00
|
|
|
arch_mem_domain_partition_add(domain, p_idx);
|
2020-08-26 08:02:38 +08:00
|
|
|
#endif
|
2020-10-07 06:53:43 +08:00
|
|
|
k_spin_unlock(&z_mem_domain_lock, key);
|
2017-07-07 20:29:30 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void k_mem_domain_remove_partition(struct k_mem_domain *domain,
|
|
|
|
struct k_mem_partition *part)
|
|
|
|
{
|
|
|
|
int p_idx;
|
2018-07-25 02:35:55 +08:00
|
|
|
k_spinlock_key_t key;
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-08-20 06:06:37 +08:00
|
|
|
__ASSERT_NO_MSG(domain != NULL);
|
|
|
|
__ASSERT_NO_MSG(part != NULL);
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-10-07 06:53:43 +08:00
|
|
|
key = k_spin_lock(&z_mem_domain_lock);
|
2017-07-07 20:29:30 +08:00
|
|
|
|
|
|
|
/* find a partition that matches the given start and size */
|
|
|
|
for (p_idx = 0; p_idx < max_partitions; p_idx++) {
|
|
|
|
if (domain->partitions[p_idx].start == part->start &&
|
|
|
|
domain->partitions[p_idx].size == part->size) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-03-02 10:12:49 +08:00
|
|
|
__ASSERT(p_idx < max_partitions, "no matching partition found");
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-08-26 07:47:44 +08:00
|
|
|
LOG_DBG("remove partition base %lx size %zu from domain %p\n",
|
|
|
|
part->start, part->size, domain);
|
|
|
|
|
2020-08-26 08:02:38 +08:00
|
|
|
#ifdef CONFIG_ARCH_MEM_DOMAIN_SYNCHRONOUS_API
|
2019-11-08 04:43:29 +08:00
|
|
|
arch_mem_domain_partition_remove(domain, p_idx);
|
2020-08-26 08:02:38 +08:00
|
|
|
#endif
|
2017-10-09 14:07:31 +08:00
|
|
|
|
2018-12-03 21:21:54 +08:00
|
|
|
/* A zero-sized partition denotes it's a free partition */
|
2019-03-27 09:57:45 +08:00
|
|
|
domain->partitions[p_idx].size = 0U;
|
2017-07-07 20:29:30 +08:00
|
|
|
|
|
|
|
domain->num_partitions--;
|
|
|
|
|
2020-10-07 06:53:43 +08:00
|
|
|
k_spin_unlock(&z_mem_domain_lock, key);
|
2017-07-07 20:29:30 +08:00
|
|
|
}
|
|
|
|
|
2020-10-07 04:39:29 +08:00
|
|
|
static void add_thread_locked(struct k_mem_domain *domain,
|
|
|
|
k_tid_t thread)
|
2017-07-07 20:29:30 +08:00
|
|
|
{
|
2020-08-20 06:06:37 +08:00
|
|
|
__ASSERT_NO_MSG(domain != NULL);
|
|
|
|
__ASSERT_NO_MSG(thread != NULL);
|
2017-07-07 20:29:30 +08:00
|
|
|
|
2020-08-26 07:47:44 +08:00
|
|
|
LOG_DBG("add thread %p to domain %p\n", thread, domain);
|
2017-07-07 20:29:30 +08:00
|
|
|
sys_dlist_append(&domain->mem_domain_q,
|
|
|
|
&thread->mem_domain_info.mem_domain_q_node);
|
|
|
|
thread->mem_domain_info.mem_domain = domain;
|
|
|
|
|
2020-08-26 08:02:38 +08:00
|
|
|
#ifdef CONFIG_ARCH_MEM_DOMAIN_SYNCHRONOUS_API
|
2019-11-08 04:43:29 +08:00
|
|
|
arch_mem_domain_thread_add(thread);
|
2020-08-26 08:02:38 +08:00
|
|
|
#endif
|
2020-10-07 04:39:29 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
static void remove_thread_locked(struct k_thread *thread)
|
|
|
|
{
|
|
|
|
__ASSERT_NO_MSG(thread != NULL);
|
|
|
|
LOG_DBG("remove thread %p from memory domain %p\n",
|
|
|
|
thread, thread->mem_domain_info.mem_domain);
|
|
|
|
sys_dlist_remove(&thread->mem_domain_info.mem_domain_q_node);
|
2017-12-06 19:18:28 +08:00
|
|
|
|
2020-10-07 04:39:29 +08:00
|
|
|
#ifdef CONFIG_ARCH_MEM_DOMAIN_SYNCHRONOUS_API
|
|
|
|
arch_mem_domain_thread_remove(thread);
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Called from thread object initialization */
|
|
|
|
void z_mem_domain_init_thread(struct k_thread *thread)
|
|
|
|
{
|
2020-10-07 06:53:43 +08:00
|
|
|
k_spinlock_key_t key = k_spin_lock(&z_mem_domain_lock);
|
2020-10-07 04:39:29 +08:00
|
|
|
|
|
|
|
/* New threads inherit memory domain configuration from parent */
|
|
|
|
add_thread_locked(_current->mem_domain_info.mem_domain, thread);
|
2020-10-07 06:53:43 +08:00
|
|
|
k_spin_unlock(&z_mem_domain_lock, key);
|
2020-10-07 04:39:29 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Called when thread aborts during teardown tasks. sched_spinlock is held */
|
|
|
|
void z_mem_domain_exit_thread(struct k_thread *thread)
|
|
|
|
{
|
2020-10-07 06:53:43 +08:00
|
|
|
k_spinlock_key_t key = k_spin_lock(&z_mem_domain_lock);
|
2020-10-07 04:39:29 +08:00
|
|
|
remove_thread_locked(thread);
|
2020-10-07 06:53:43 +08:00
|
|
|
k_spin_unlock(&z_mem_domain_lock, key);
|
2020-10-07 04:39:29 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void k_mem_domain_add_thread(struct k_mem_domain *domain, k_tid_t thread)
|
|
|
|
{
|
|
|
|
k_spinlock_key_t key;
|
|
|
|
|
2020-10-07 06:53:43 +08:00
|
|
|
key = k_spin_lock(&z_mem_domain_lock);
|
2020-10-21 04:26:19 +08:00
|
|
|
if (thread->mem_domain_info.mem_domain != domain) {
|
|
|
|
remove_thread_locked(thread);
|
|
|
|
add_thread_locked(domain, thread);
|
|
|
|
}
|
2020-10-07 06:53:43 +08:00
|
|
|
k_spin_unlock(&z_mem_domain_lock, key);
|
2017-07-07 20:29:30 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void k_mem_domain_remove_thread(k_tid_t thread)
|
|
|
|
{
|
2020-08-26 05:42:33 +08:00
|
|
|
k_mem_domain_add_thread(&k_mem_domain_default, thread);
|
2017-07-07 20:29:30 +08:00
|
|
|
}
|
|
|
|
|
2020-10-07 06:02:04 +08:00
|
|
|
void k_mem_domain_destroy(struct k_mem_domain *domain)
|
|
|
|
{
|
|
|
|
k_spinlock_key_t key;
|
|
|
|
sys_dnode_t *node, *next_node;
|
|
|
|
|
|
|
|
__ASSERT_NO_MSG(domain != NULL);
|
|
|
|
__ASSERT(domain != &k_mem_domain_default,
|
|
|
|
"cannot destroy default domain");
|
|
|
|
|
2020-10-07 06:53:43 +08:00
|
|
|
key = k_spin_lock(&z_mem_domain_lock);
|
2020-10-07 06:02:04 +08:00
|
|
|
|
|
|
|
#ifdef CONFIG_ARCH_MEM_DOMAIN_SYNCHRONOUS_API
|
|
|
|
arch_mem_domain_destroy(domain);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
SYS_DLIST_FOR_EACH_NODE_SAFE(&domain->mem_domain_q, node, next_node) {
|
|
|
|
struct k_thread *thread =
|
|
|
|
CONTAINER_OF(node, struct k_thread, mem_domain_info);
|
|
|
|
|
|
|
|
remove_thread_locked(thread);
|
|
|
|
add_thread_locked(&k_mem_domain_default, thread);
|
|
|
|
}
|
|
|
|
|
2020-10-07 06:53:43 +08:00
|
|
|
k_spin_unlock(&z_mem_domain_lock, key);
|
2020-10-07 06:02:04 +08:00
|
|
|
}
|
|
|
|
|
2020-05-01 02:33:38 +08:00
|
|
|
static int init_mem_domain_module(const struct device *arg)
|
2017-07-07 20:29:30 +08:00
|
|
|
{
|
|
|
|
ARG_UNUSED(arg);
|
|
|
|
|
2019-11-08 04:43:29 +08:00
|
|
|
max_partitions = arch_mem_domain_max_partitions_get();
|
2017-07-07 20:29:30 +08:00
|
|
|
/*
|
|
|
|
* max_partitions must be less than or equal to
|
|
|
|
* CONFIG_MAX_DOMAIN_PARTITIONS, or would encounter array index
|
|
|
|
* out of bounds error.
|
|
|
|
*/
|
|
|
|
__ASSERT(max_partitions <= CONFIG_MAX_DOMAIN_PARTITIONS, "");
|
|
|
|
|
2020-08-26 05:42:33 +08:00
|
|
|
k_mem_domain_init(&k_mem_domain_default, 0, NULL);
|
|
|
|
#ifdef Z_LIBC_PARTITION_EXISTS
|
|
|
|
k_mem_domain_add_partition(&k_mem_domain_default, &z_libc_partition);
|
|
|
|
#endif /* Z_LIBC_PARTITION_EXISTS */
|
|
|
|
|
2017-07-07 20:29:30 +08:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
SYS_INIT(init_mem_domain_module, PRE_KERNEL_1,
|
|
|
|
CONFIG_KERNEL_INIT_PRIORITY_DEFAULT);
|