Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
mem_protect.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2017, 2020 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#include <zephyr.h>
8#include <ztest.h>
9#include <kernel_structs.h>
10#include <string.h>
11#include <stdlib.h>
12
13extern void test_permission_inheritance(void);
14extern void test_inherit_resource_pool(void);
15
16extern void test_mem_domain_setup(void);
17extern void test_mem_domain_valid_access(void);
18extern void test_mem_domain_invalid_access(void);
19extern void test_mem_domain_no_writes_to_ro(void);
20extern void test_mem_domain_remove_add_partition(void);
21extern void test_mem_domain_api_supervisor_only(void);
22extern void test_mem_domain_boot_threads(void);
23extern void test_mem_domain_migration(void);
24extern void test_mem_domain_init_fail(void);
25extern void test_mem_domain_remove_part_fail(void);
26
27extern void test_macros_obtain_names_data_bss(void);
28extern void test_mem_part_assign_bss_vars_zero(void);
29extern void test_mem_part_auto_determ_size(void);
30
31extern void test_kobject_access_grant(void);
32extern void test_syscall_invalid_kobject(void);
33extern void test_thread_without_kobject_permission(void);
34extern void test_kobject_revoke_access(void);
35extern void test_kobject_grant_access_kobj(void);
36extern void test_kobject_grant_access_kobj_invalid(void);
37extern void test_kobject_release_from_user(void);
38extern void test_kobject_access_all_grant(void);
39extern void test_thread_has_residual_permissions(void);
40extern void test_kobject_access_grant_to_invalid_thread(void);
41extern void test_kobject_access_invalid_kobject(void);
42extern void test_access_kobject_without_init_access(void);
43extern void test_access_kobject_without_init_with_access(void);
44extern void test_kobject_reinitialize_thread_kobj(void);
45extern void test_create_new_thread_from_user(void);
46extern void test_new_user_thread_with_in_use_stack_obj(void);
47extern void test_create_new_thread_from_user_no_access_stack(void);
48extern void test_create_new_thread_from_user_invalid_stacksize(void);
49extern void test_create_new_thread_from_user_huge_stacksize(void);
50extern void test_create_new_supervisor_thread_from_user(void);
51extern void test_create_new_essential_thread_from_user(void);
52extern void test_create_new_higher_prio_thread_from_user(void);
53extern void test_create_new_invalid_prio_thread_from_user(void);
54extern void test_mark_thread_exit_uninitialized(void);
55extern void test_krnl_obj_static_alloc_build_time(void);
56extern void test_mem_part_overlap(void);
57extern void test_mem_part_assert_add_overmax(void);
58extern void test_kobject_access_grant_error(void);
59extern void test_kobject_access_grant_error_user(void);
60extern void test_kobject_access_grant_error_user_null(void);
61extern void test_kobject_access_all_grant_error(void);
62extern void test_kobject_release_null(void);
63extern void test_kobject_free_error(void);
64extern void test_kobject_init_error(void);
65extern void test_kobj_create_out_of_memory(void);
66extern void test_thread_alloc_out_of_idx(void);
67extern void test_alloc_kobjects(void);
68extern void test_kobject_perm_error(void);
69
70
71/* Flag needed to figure out if the fault was expected or not. */
72extern volatile bool valid_fault;
73
74static inline void set_fault_valid(bool valid)
75{
76 valid_fault = valid;
77 /* Put a barrier here, such that no instructions get ordered by the
78 * compiler before we set valid_fault. This can happen with expansion
79 * of inline syscall invocation functions.
80 */
81 compiler_barrier();
82}
83
84/* For inherit.c */
85#define INHERIT_STACK_SIZE CONFIG_MAIN_STACK_SIZE
86#define SEMAPHORE_MAX_COUNT (10)
87#define SEMAPHORE_INIT_COUNT (0)
88#define SYNC_SEM_MAX_COUNT (1)
89#define SYNC_SEM_INIT_COUNT (0)
90#define MSG_Q_SIZE (10)
91#define MSG_Q_MAX_NUM_MSGS (10)
92#define MSG_Q_ALIGN (2)
93#define PRIORITY 5
94#define STACK_SIZE (512 + CONFIG_TEST_EXTRA_STACKSIZE)
95#define BLK_SIZE_MIN 16
96#define BLK_SIZE_MAX 64
97#define BLK_NUM_MIN 8
98#define BLK_NUM_MAX 2
99#define BLK_ALIGN BLK_SIZE_MIN
100#define SEM_INIT_VAL (0U)
101#define SEM_MAX_VAL (1U)
102
103/* For mem_domain.c */
104#define MEM_DOMAIN_STACK_SIZE CONFIG_MAIN_STACK_SIZE
105#define MEM_PARTITION_INIT_NUM (1)
106#define BLK_SIZE_MIN_MD 8
107#define BLK_SIZE_MAX_MD 16
108#define BLK_NUM_MAX_MD 4
109#define BLK_ALIGN_MD BLK_SIZE_MIN_MD
110#define DESC_SIZE sizeof(struct sys_mem_pool_block)
111#define STACK_SIZE_MD (512 + CONFIG_TEST_EXTRA_STACKSIZE)
112#define PRIORITY_MD 5
113
114#if defined(CONFIG_X86)
115#define MEM_REGION_ALLOC (4096)
116#elif defined(CONFIG_ARC)
117#define MEM_REGION_ALLOC (Z_ARC_MPU_ALIGN)
118#elif defined(CONFIG_ARM64)
119#define MEM_REGION_ALLOC (4096)
120#elif defined(CONFIG_ARM)
121#define MEM_REGION_ALLOC (Z_THREAD_MIN_STACK_ALIGN)
122#elif defined(CONFIG_RISCV)
123#define MEM_REGION_ALLOC (Z_RISCV_PMP_ALIGN)
124#else
125#error "Test suite not compatible for the given architecture"
126#endif
127#define MEM_DOMAIN_ALIGNMENT __aligned(MEM_REGION_ALLOC)
128
129/* for kobject.c */
130#define KOBJECT_STACK_SIZE (512 + CONFIG_TEST_EXTRA_STACKSIZE)
131
132
133
134#if defined(CONFIG_X86_64) || defined(CONFIG_ARM64)
135#define TEST_HEAP_SIZE (2 << CONFIG_MAX_THREAD_BYTES) * 1024
136#define MAX_OBJ 512
137#else
138#define TEST_HEAP_SIZE (2 << CONFIG_MAX_THREAD_BYTES) * 256
139#define MAX_OBJ 256
140#endif
141
142#ifndef _TEST_SYSCALLS_H_
143#define _TEST_SYSCALLS_H_
144
145__syscall struct k_heap *ret_resource_pool_ptr(void);
146
147#include <syscalls/mem_protect.h>
148
149#endif /* _TEST_SYSCALLS_H_ */
kernel_structs.h
test_macros_obtain_names_data_bss
void test_macros_obtain_names_data_bss(void)
test_mem_domain_remove_part_fail
void test_mem_domain_remove_part_fail(void)
Definition: mem_domain.c:463
test_kobject_perm_error
void test_kobject_perm_error(void)
Test grant access failed in user mode.
Definition: kobject.c:1340
test_mem_domain_boot_threads
void test_mem_domain_boot_threads(void)
Show that boot threads belong to the default memory domain.
Definition: mem_domain.c:257
test_thread_has_residual_permissions
void test_thread_has_residual_permissions(void)
Test access permission of a terminated thread.
Definition: kobject.c:440
test_create_new_higher_prio_thread_from_user
void test_create_new_higher_prio_thread_from_user(void)
Thread creation with prority is higher than current thread.
Definition: kobject.c:964
test_kobject_access_invalid_kobject
void test_kobject_access_invalid_kobject(void)
Object validation checks.
Definition: kobject.c:496
test_kobject_revoke_access
void test_kobject_revoke_access(void)
Test access revoke.
Definition: kobject.c:211
test_mem_domain_invalid_access
void test_mem_domain_invalid_access(void)
Show that a user thread can't touch partitions not in its domain.
Definition: mem_domain.c:155
test_create_new_thread_from_user
void test_create_new_thread_from_user(void)
Test thread create from a user thread and check permissions.
Definition: kobject.c:628
test_thread_alloc_out_of_idx
void test_thread_alloc_out_of_idx(void)
Definition: kobject.c:1196
test_mem_domain_no_writes_to_ro
void test_mem_domain_no_writes_to_ro(void)
Show that a read-only partition can't be written to.
Definition: mem_domain.c:167
test_mem_part_assert_add_overmax
void test_mem_part_assert_add_overmax(void)
Test system assert when adding memory partitions more than possible.
Definition: mem_domain.c:417
test_kobject_release_null
void test_kobject_release_null(void)
Definition: kobject.c:363
test_kobject_grant_access_kobj
void test_kobject_grant_access_kobj(void)
Test access revoke.
Definition: kobject.c:258
test_kobject_access_all_grant_error
void test_kobject_access_all_grant_error(void)
Test grant access to all the kobject for thread.
Definition: kobject.c:120
test_create_new_invalid_prio_thread_from_user
void test_create_new_invalid_prio_thread_from_user(void)
Create a new thread whose prority is invalid.
Definition: kobject.c:1011
test_kobject_access_all_grant
void test_kobject_access_all_grant(void)
Test supervisor thread grants kernel objects all access public status.
Definition: kobject.c:391
test_kobject_access_grant_to_invalid_thread
void test_kobject_access_grant_to_invalid_thread(void)
Test grant access to a valid kobject but invalid thread id.
Definition: kobject.c:475
test_kobject_access_grant_error
void test_kobject_access_grant_error(void)
Test grant access of given NULL kobject.
Definition: kobject.c:66
test_permission_inheritance
void test_permission_inheritance(void)
Test object permission inheritance except of the parent thread object.
Definition: inherit.c:101
test_thread_without_kobject_permission
void test_thread_without_kobject_permission(void)
Test user thread can access a k_object without grant.
Definition: kobject.c:180
test_mem_domain_migration
void test_mem_domain_migration(void)
Definition: mem_domain.c:307
set_fault_valid
static void set_fault_valid(bool valid)
Definition: mem_protect.h:74
test_alloc_kobjects
void test_alloc_kobjects(void)
Test kernel object allocation.
Definition: kobject.c:1248
test_mem_part_assign_bss_vars_zero
void test_mem_part_assign_bss_vars_zero(void)
test_kobject_init_error
void test_kobject_init_error(void)
Test alloc an invalid kernel object.
Definition: kobject.c:1130
test_kobject_access_grant_error_user
void test_kobject_access_grant_error_user(void)
Test grant access of given NULL thread in usermode.
Definition: kobject.c:81
test_create_new_thread_from_user_no_access_stack
void test_create_new_thread_from_user_no_access_stack(void)
Test creates new thread from usermode without stack access.
Definition: kobject.c:722
test_kobject_free_error
void test_kobject_free_error(void)
Test free an invalid kernel object.
Definition: kobject.c:1103
test_create_new_supervisor_thread_from_user
void test_create_new_supervisor_thread_from_user(void)
Test to create a new supervisor thread from user.
Definition: kobject.c:874
test_mem_domain_setup
void test_mem_domain_setup(void)
Definition: mem_domain.c:45
test_mem_part_overlap
void test_mem_part_overlap(void)
Test system assert when new partition overlaps the existing partition.
Definition: mem_domain.c:379
valid_fault
volatile bool valid_fault
Definition: common.c:9
ret_resource_pool_ptr
struct k_heap * ret_resource_pool_ptr(void)
test_mem_domain_api_supervisor_only
void test_mem_domain_api_supervisor_only(void)
Test access memory domain APIs allowed to supervisor threads only.
Definition: mem_domain.c:239
test_kobject_grant_access_kobj_invalid
void test_kobject_grant_access_kobj_invalid(void)
Test access grant between threads.
Definition: kobject.c:304
test_kobject_access_grant
void test_kobject_access_grant(void)
Test access to a invalid semaphore who's address is NULL.
Definition: kobject.c:41
test_mem_domain_init_fail
void test_mem_domain_init_fail(void)
Test error case of initializing memory domain fail.
Definition: mem_domain.c:479
test_mem_domain_remove_add_partition
void test_mem_domain_remove_add_partition(void)
Show that adding/removing partitions works.
Definition: mem_domain.c:182
test_inherit_resource_pool
void test_inherit_resource_pool(void)
Test child thread inherits parent's thread resource pool.
Definition: inherit.c:172
test_kobject_release_from_user
void test_kobject_release_from_user(void)
Test revoke permission of a k_object from userspace.
Definition: kobject.c:338
test_krnl_obj_static_alloc_build_time
void test_krnl_obj_static_alloc_build_time(void)
test_kobj_create_out_of_memory
void test_kobj_create_out_of_memory(void)
Test kernel object until out of memory.
Definition: kobject.c:1153
test_kobject_reinitialize_thread_kobj
void test_kobject_reinitialize_thread_kobj(void)
Test to reinitialize the k_thread object.
Definition: kobject.c:582
test_access_kobject_without_init_with_access
void test_access_kobject_without_init_with_access(void)
Test syscall on a kobject which is not initialized and has access.
Definition: kobject.c:539
test_new_user_thread_with_in_use_stack_obj
void test_new_user_thread_with_in_use_stack_obj(void)
Test create new user thread from a user thread with in-use stack obj.
Definition: kobject.c:678
test_mark_thread_exit_uninitialized
void test_mark_thread_exit_uninitialized(void)
Test when thread exits, kernel marks stack objects uninitialized.
Definition: kobject.c:1054
test_kobject_access_grant_error_user_null
void test_kobject_access_grant_error_user_null(void)
Test grant access of given NULL kobject in usermode.
Definition: kobject.c:103
test_create_new_thread_from_user_invalid_stacksize
void test_create_new_thread_from_user_invalid_stacksize(void)
Test to validate user thread spawning with stack overflow.
Definition: kobject.c:766
test_access_kobject_without_init_access
void test_access_kobject_without_init_access(void)
Object validation checks without init access.
Definition: kobject.c:514
test_create_new_thread_from_user_huge_stacksize
void test_create_new_thread_from_user_huge_stacksize(void)
Test to check stack overflow from user thread.
Definition: kobject.c:820
test_create_new_essential_thread_from_user
void test_create_new_essential_thread_from_user(void)
Create a new essential thread from user.
Definition: kobject.c:918
test_mem_part_auto_determ_size
void test_mem_part_auto_determ_size(void)
test_mem_domain_valid_access
void test_mem_domain_valid_access(void)
Check if the mem_domain is configured and accessible for userspace.
Definition: mem_domain.c:144
test_syscall_invalid_kobject
void test_syscall_invalid_kobject(void)
Test syscall can take a different type of kobject.
Definition: kobject.c:149
k_heap
Definition: kernel.h:5088
ztest.h
Zephyr Testsuite.