Skip to content

Commit

Permalink
vmh_tests: Add set of parametrized tests and test suit
Browse files Browse the repository at this point in the history 
Add enhanced vmh testing.
Add tests for: heap creation, heap creation with config, multiple
allocation tests for each heap mode.

Signed-off-by: Jakub Dabek <[email protected]>
  • Loading branch information
@dabekjakub
dabekjakub committed Feb 24, 2024
1 parent 13ba1b7 commit 64bcd75
Showing 1 changed file with 256 additions and 0 deletions.
256 changes: 256 additions & 0 deletions zephyr/test/vmh.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

#include <errno.h>
#include <stdbool.h>
#include <stdlib.h>

#include <adsp_memory_regions.h>
#include <sof/boot_test.h>
Expand All @@ -17,8 +18,263 @@

LOG_MODULE_DECLARE(sof_boot_test, CONFIG_SOF_LOG_LEVEL);

/* Test creating and freeing a virtual memory heap */
static void test_vmh_init_and_free_heap(int memory_region_attribute,
struct vmh_heap_config *config,
int core_id,
bool allocating_continuously,
bool expect_success)
{
struct vmh_heap *heap = vmh_init_heap(config, memory_region_attribute,
core_id, allocating_continuously);
if (expect_success) {
zassert_not_null(heap,
"Heap initialization expected to succeed but failed");
}
else
zassert_is_null(heap, "Heap initialization expected to fail but succeeded");

if (heap) {
int ret = vmh_free_heap(heap);

zassert_equal(ret, 0, "Failed to free heap");
}
}

/* Test for vmh_alloc and vmh_free */
static void test_vmh_alloc_free_no_check(struct vmh_heap *heap,
uint32_t alloc_size,
bool expect_success)
{
void *ptr = vmh_alloc(heap, alloc_size);

if (expect_success)
zassert_not_null(ptr, "Allocation expected to succeed but failed");
else
zassert_is_null(ptr, "Allocation expected to fail but succeeded");

if (ptr) {
int ret = vmh_free(heap, ptr);

zassert_equal(ret, 0, "Failed to free allocated memory");
}
}

static void verify_memory_content(void *ptr, uint32_t alloc_size)
{

/* Calculate check positions end and middle if applicable */
uint8_t *end_ptr = (uint8_t *)ptr + alloc_size - sizeof(uint32_t);
uint8_t *middle_ptr = (uint8_t *)ptr + (alloc_size / 2);
uint8_t test_value = 0xAA;
int test_write_size = 1;

/* Write test pattern to the allocated memory beginning middle and end */
memset(ptr, test_value, test_write_size);
memset(middle_ptr, test_value, test_write_size);
memset(end_ptr, test_value, test_write_size);

/* Verify the written test pattern at all points */
zassert_equal(*((uint8_t *)ptr), test_value,
"Memory content verification failed at the start");
zassert_equal(*end_ptr, test_value,
"Memory content verification failed at the end");
zassert_equal(*middle_ptr, test_value,
"Memory content verification failed in the middle");
}

/* Test function for vmh_alloc and vmh_free with memory read/write */
static void test_vmh_alloc_free_check(struct vmh_heap *heap,
uint32_t alloc_size,
bool expect_success)
{
void *ptr = vmh_alloc(heap, alloc_size);

if (expect_success)
zassert_not_null(ptr, "Allocation expected to succeed but failed");
else {
zassert_is_null(ptr, "Allocation expected to fail but succeeded");
return;
}

if (ptr)
verify_memory_content(ptr, alloc_size);

int ret = vmh_free(heap, ptr);

zassert_equal(ret, 0, "Failed to free allocated memory");
}

/* Test function for multiple allocations on the same heap with read/write */
static void test_vmh_multiple_allocs(struct vmh_heap *heap, int num_allocs,
uint32_t min_alloc_size,
uint32_t max_alloc_size)
{
void *ptrs[num_allocs];
uint32_t alloc_size;
bool success;
int ret;

/* Perform multiple allocations */
for (int i = 0; i < num_allocs; i++) {
/* Generate a random allocation size between min_alloc_size and max_alloc_size */
alloc_size = min_alloc_size +
k_cycle_get_32() % (max_alloc_size - min_alloc_size + 1);

ptrs[i] = vmh_alloc(heap, alloc_size);

if (!ptrs[i])
LOG_INF("Test allocation failed for size: %d", alloc_size);

zassert_true(ptrs[i] != NULL,
"Allocation of size %u expected to succeed but failed",
alloc_size);

if (ptrs[i])
verify_memory_content(ptrs[i], alloc_size);
}

for (int i = 0; i < num_allocs; i++) {
if (ptrs[i]) {
ret = vmh_free(heap, ptrs[i]);
zassert_equal(ret, 0, "Failed to free allocated memory");
}
}
}

/* Test case for multiple allocations */
static void test_vmh_alloc_multiple_times(bool allocating_continuously)
{
struct vmh_heap *heap =
vmh_init_heap(NULL, MEM_REG_ATTR_CORE_HEAP, 0, allocating_continuously);

zassert_not_null(heap, "Heap initialization failed");

/* Test multiple allocations with small sizes */
test_vmh_multiple_allocs(heap, 16, 4, 8);
test_vmh_multiple_allocs(heap, 64, 4, 8);
test_vmh_multiple_allocs(heap, 16, 4, 1024);
test_vmh_multiple_allocs(heap, 64, 4, 1024);
if (allocating_continuously) {
test_vmh_multiple_allocs(heap, 16, 1024, 4096);
test_vmh_multiple_allocs(heap, 16, 4096, 8192);
}

/* Clean up the heap after testing */
int ret = vmh_free_heap(heap);

zassert_equal(ret, 0, "Failed to free heap after multiple allocations");
}

/* Test case for vmh_alloc and vmh_free */
static void test_vmh_alloc_free(bool allocating_continuously)
{
struct vmh_heap *heap =
vmh_init_heap(NULL, MEM_REG_ATTR_CORE_HEAP, 0, allocating_continuously);

zassert_not_null(heap, "Heap initialization failed");

test_vmh_alloc_free_no_check(heap, 512, true);
test_vmh_alloc_free_no_check(heap, 1024, true);
test_vmh_alloc_free_no_check(heap, sizeof(int), true);
test_vmh_alloc_free_no_check(heap, 0, false);

test_vmh_alloc_free_check(heap, 512, true);
test_vmh_alloc_free_check(heap, 1024, true);
test_vmh_alloc_free_check(heap, sizeof(int), true);
test_vmh_alloc_free_check(heap, 0, false);

int ret = vmh_free_heap(heap);

zassert_equal(ret, 0, "Failed to free heap");

/* Could add tests with configs for heaps*/
}

/* Test case for vmh_alloc and vmh_free with and without config */
static void test_heap_creation(void)
{
test_vmh_init_and_free_heap(MEM_REG_ATTR_CORE_HEAP, NULL, 0, false, true);

/* Try to setup with pre defined heap config */
struct vmh_heap_config config = {0};

config.block_bundles_table[0].block_size = 8;

config.block_bundles_table[0].number_of_blocks = 1024;

config.block_bundles_table[1].block_size = 16;

config.block_bundles_table[1].number_of_blocks = 512;

test_vmh_init_and_free_heap(MEM_REG_ATTR_CORE_HEAP, &config, 0, false, true);
}

/* Test case for alloc/free on configured heap */
static void test_alloc_on_configured_heap(bool allocating_continuously)
{

/* Try to setup with pre defined heap config */
struct vmh_heap_config config = {0};

config.block_bundles_table[0].block_size = 32;

config.block_bundles_table[0].number_of_blocks = 256;

/* Create continuous allocation heap for success test */
struct vmh_heap *heap =
vmh_init_heap(&config, MEM_REG_ATTR_CORE_HEAP, 0, allocating_continuously);

/* Will succeed on continuous and fail with single block alloc */
test_vmh_alloc_free_check(heap, 512, allocating_continuously);

int ret = vmh_free_heap(heap);

zassert_equal(ret, 0, "Failed to free heap");
}

/* Test cases for initializing heaps on all available regions */
static void test_vmh_init_all_heaps(void)
{
int num_regions = CONFIG_MP_MAX_NUM_CPUS + VIRTUAL_REGION_COUNT;
int i;
const struct sys_mm_drv_region *virtual_memory_region =
sys_mm_drv_query_memory_regions();

/* Test initializing all types of heaps */
for (i = 0; i < num_regions; i++) {

/* Zeroed size symbolizes end of regions table */
if (!virtual_memory_region[i].size)
break;

struct vmh_heap *heap = vmh_init_heap(NULL, virtual_memory_region[i].attr,
i, true);

zassert_not_null(heap, "Heap initialization expected to succeed but failed");

/* Test if it fails when heap already exists */
test_vmh_init_and_free_heap(virtual_memory_region[i].attr, NULL, i, true,
false);

if (heap) {
int ret = vmh_free_heap(heap);

zassert_equal(ret, 0, "Failed to free heap");
}
}
}

ZTEST(sof_boot, virtual_memory_heap)
{
test_heap_creation();
test_vmh_init_all_heaps();
test_alloc_on_configured_heap(true);
test_alloc_on_configured_heap(false);
test_vmh_alloc_free(true);
test_vmh_alloc_free(false);
test_vmh_alloc_multiple_times(true);
test_vmh_alloc_multiple_times(false);

TEST_CHECK_RET(true, "virtual_memory_heap");
}

0 comments on commit 64bcd75

Please sign in to comment.