From 9f254f0c7b03236be615b1235cf3fc765d6000ea Mon Sep 17 00:00:00 2001 From: 3gg <3gg@shellblade.net> Date: Thu, 13 Jul 2023 08:22:18 -0700 Subject: Add mem allocator, remove listpool. --- listpool/CMakeLists.txt | 26 ------ listpool/README.md | 14 ---- listpool/include/listpool.h | 100 ----------------------- listpool/src/listpool.c | 92 --------------------- listpool/test/listpool_test.c | 183 ----------------------------------------- listpool/test/test.h | 185 ------------------------------------------ 6 files changed, 600 deletions(-) delete mode 100644 listpool/CMakeLists.txt delete mode 100644 listpool/README.md delete mode 100644 listpool/include/listpool.h delete mode 100644 listpool/src/listpool.c delete mode 100644 listpool/test/listpool_test.c delete mode 100644 listpool/test/test.h (limited to 'listpool') diff --git a/listpool/CMakeLists.txt b/listpool/CMakeLists.txt deleted file mode 100644 index 2dcd983..0000000 --- a/listpool/CMakeLists.txt +++ /dev/null @@ -1,26 +0,0 @@ -cmake_minimum_required(VERSION 3.0) - -project(listpool) - -# Library - -add_library(listpool - src/listpool.c) - -target_include_directories(listpool PUBLIC - include) - -target_link_libraries(listpool - list) - -target_compile_options(listpool PRIVATE -Wall -Wextra) - -# Test - -add_executable(listpool_test - test/listpool_test.c) - -target_link_libraries(listpool_test -listpool) - -target_compile_options(listpool_test PRIVATE -DUNIT_TEST -DNDEBUG -Wall -Wextra) diff --git a/listpool/README.md b/listpool/README.md deleted file mode 100644 index ed38980..0000000 --- a/listpool/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# Listpool - -A block allocator built from a single, contiguous array of memory that maintains -free and used blocks in doubly linked lists. - -A `listpool` is similar to a `mempool`, but the additional structure allows it -to: - -- Allocate and free blocks in constant time. -- Traverse used blocks in linear time in the number of used blocks, as opposed - to the total number of blocks like in a `mempool`. - -A `listpool` otherwise provides the same guarantees and characteristics as a -`mempool`. diff --git a/listpool/include/listpool.h b/listpool/include/listpool.h deleted file mode 100644 index 85a3b27..0000000 --- a/listpool/include/listpool.h +++ /dev/null @@ -1,100 +0,0 @@ -#pragma once - -#include "list.h" - -#include -#include -#include - -/// Define a typed listpool of a given size. -#define DEF_LISTPOOL(POOL, TYPE, NUM_BLOCKS) \ - typedef struct POOL { \ - listpool pool; \ - list nodes[NUM_BLOCKS]; \ - TYPE blocks[NUM_BLOCKS]; \ - } POOL; - -/// Creates a new listpool. -#define listpool_make(POOL) \ - { \ - assert(POOL); \ - const size_t block_size = sizeof((POOL)->blocks[0]); \ - const size_t num_blocks = sizeof((POOL)->blocks) / block_size; \ - listpool_make_( \ - &(POOL)->pool, (POOL)->nodes, (POOL)->blocks, num_blocks, block_size); \ - } - -/// Allocate a new block. -/// Return 0 if there is no memory left. -#define listpool_alloc(POOL) listpool_alloc_(&(POOL)->pool) - -/// Free the block. -/// The block pointer is conveniently set to 0. -#define listpool_free(POOL, ITEM) listpool_free_(&(POOL)->pool, (void**)ITEM) - -/// Remove a value from the list. -/// Defined here instead of DEF_LISTPOOL_IMPL() because not all types may have -/// an operator==. -#define listpool_remove(POOL, VAL) \ - { \ - listpool_foreach(POOL, iter, { \ - if (*iter == VAL) { \ - listpool_free(POOL, &iter); \ - break; \ - } \ - }); \ - } - -/// Return the ith block. -/// The block must have been allocated. -#define listpool_get_block(POOL, INDEX) \ - ((typeof((POOL)->blocks[0])*)listpool_get_block_(&(POOL)->pool, INDEX)) - -/// Get the index to the given block. -#define listpool_get_block_index(POOL, BLOCK_PTR) \ - listpool_get_block_index_(&(POOL)->pool, BLOCK_PTR) - -/// Iterate over the used items of the pool. -/// -/// The caller can use 'i' as the index of the current block. -/// -/// It is valid to mempool_free() the object at each step of the iteration. -#define listpool_foreach(POOL, ITER, BODY) \ - for (list* it_ = (POOL)->pool.used; it_; it_ = it_->next) { \ - const size_t i = it_ - (POOL)->pool.nodes; \ - typeof((POOL)->blocks[0])* ITER = &(POOL)->blocks[i]; \ - (void)ITER; \ - BODY; \ - } - -typedef struct listpool { - size_t block_size_bytes; - size_t num_blocks; - list* free; // Head of the free list. - list* used; // Head of the used list. - list* nodes; // Array of nodes. - uint8_t* blocks; // Array of blocks; -} listpool; - -/// Create a new list pool from a user-provided array of memory. -/// `nodes` must have at least `num_blocks` nodes. -/// `blocks` must be at least `num_blocks` * `block_size_bytes` bytes. -/// All blocks are zeroed out for convenience. -void listpool_make_( - listpool* pool, list* nodes, void* blocks, size_t num_blocks, - size_t block_size_bytes); - -/// Allocate a new block. -/// Return 0 if there is no memory left. -void* listpool_alloc_(listpool* pool); - -/// Free the block. -/// The block pointer is conveniently set to 0. -void listpool_free_(listpool* pool, void** block_ptr); - -/// Return the ith block. -/// The block must have been allocated. -void* listpool_get_block_(const listpool*, size_t block_index); - -/// Get the index to the given block. -size_t listpool_get_block_index_(const listpool*, const void* block); diff --git a/listpool/src/listpool.c b/listpool/src/listpool.c deleted file mode 100644 index 758062c..0000000 --- a/listpool/src/listpool.c +++ /dev/null @@ -1,92 +0,0 @@ -#include "listpool.h" - -#include - -void listpool_make_( - listpool* pool, list* nodes, void* blocks, size_t num_blocks, - size_t block_size_bytes) { - assert(pool); - pool->block_size_bytes = block_size_bytes; - pool->num_blocks = num_blocks; - pool->free = &nodes[0]; - pool->used = 0; - pool->nodes = nodes; - pool->blocks = blocks; - list_make(nodes, num_blocks); - memset(blocks, 0, num_blocks * block_size_bytes); -} - -void* listpool_alloc_(listpool* pool) { - assert(pool); - if (!pool->free) { - return 0; - } - - const size_t index = pool->free - pool->nodes; - assert(index < pool->num_blocks); - - list* free = pool->free; - pool->free = pool->free->next; - - // pool->used is always the head of the used list, so prepend the new item to - // the list. - list* new_used = free; - new_used->prev = 0; - new_used->next = pool->used; - if (pool->used) { - pool->used->prev = new_used; - } - pool->used = new_used; - - return pool->blocks + index * pool->block_size_bytes; -} - -void listpool_free_(listpool* pool, void** block_ptr) { - assert(pool); - assert(block_ptr); - - memset(*block_ptr, 0, pool->block_size_bytes); - - const size_t index = - ((uint8_t*)*block_ptr - pool->blocks) / pool->block_size_bytes; - assert(index < pool->num_blocks); - - list* item = &pool->nodes[index]; - - // We must remove the item from the used list first. - if (item->prev) { - item->prev->next = item->next; - } - if (item->next) { - item->next->prev = item->prev; - } - if (item == pool->used) { - pool->used = item->next; - } - - // pool->free is always the head of the free list, so prepend the new item to - // the list. The item is now free to wire after removing it from the used - // list. - if (!pool->free) { - pool->free = item; - } else { - item->next = pool->free; - pool->free->prev = item; - pool->free = item; - } - - *block_ptr = 0; -} - -void* listpool_get_block_(const listpool* pool, size_t block_index) { - assert(pool); - assert(block_index < pool->num_blocks); - return pool->blocks + block_index * pool->block_size_bytes; -} - -size_t listpool_get_block_index_(const listpool* pool, const void* block) { - assert(pool); - const size_t block_byte_index = (const uint8_t*)block - pool->blocks; - assert(block_byte_index % pool->block_size_bytes == 0); - return block_byte_index / pool->block_size_bytes; -} diff --git a/listpool/test/listpool_test.c b/listpool/test/listpool_test.c deleted file mode 100644 index 7a7b0cf..0000000 --- a/listpool/test/listpool_test.c +++ /dev/null @@ -1,183 +0,0 @@ -#include "listpool.h" - -#include "test.h" - -#define NUM_BLOCKS 10 - -DEF_LISTPOOL(test_pool, int, NUM_BLOCKS); - -static int count(test_pool* pool) { - int count = 0; - listpool_foreach(pool, n, { count++; }); - return count; -} - -static int sum(test_pool* pool) { - int sum = 0; - listpool_foreach(pool, n, { sum += *n; }); - return sum; -} - -// Create a pool. -TEST_CASE(listpool_create) { - test_pool pool; - listpool_make(&pool); -} - -// Allocate all N blocks. -TEST_CASE(listpool_fully_allocate) { - test_pool pool; - listpool_make(&pool); - - for (int i = 0; i < NUM_BLOCKS; ++i) { - const int* block = listpool_alloc(&pool); - TEST_TRUE(block != 0); - } -} - -// Allocate all N blocks, then free them. -TEST_CASE(listpool_fill_then_free) { - test_pool pool; - listpool_make(&pool); - - int* blocks[NUM_BLOCKS] = {0}; - for (int i = 0; i < NUM_BLOCKS; i++) { - blocks[i] = listpool_alloc(&pool); - TEST_TRUE(blocks[i] != 0); - } - - for (int i = 0; i < NUM_BLOCKS; i++) { - listpool_free(&pool, &blocks[i]); - TEST_EQUAL(blocks[i], 0); // Pointer should be set to 0 on free. - } - - TEST_EQUAL(count(&pool), 0); -} - -// Attempt to allocate blocks past the maximum pool size. -// The pool should handle the failed allocations gracefully. -TEST_CASE(listpool_allocate_beyond_max_size) { - test_pool pool; - listpool_make(&pool); - - // Fully allocate the pool. - for (int i = 0; i < NUM_BLOCKS; ++i) { - TEST_TRUE(listpool_alloc(&pool) != 0); - } - - // Past the end. - for (int i = 0; i < NUM_BLOCKS; ++i) { - TEST_EQUAL(listpool_alloc(&pool), 0); - } -} - -// Free blocks should always remain zeroed out. -// This tests the invariant right after creating the pool. -TEST_CASE(listpool_zero_free_blocks_after_creation) { - test_pool pool; - listpool_make(&pool); - - const int zero = 0; - for (int i = 0; i < NUM_BLOCKS; ++i) { - const int* block = (const int*)(pool.blocks) + i; - TEST_EQUAL(memcmp(block, &zero, sizeof(int)), 0); - } -} - -// Free blocks should always remain zeroed out. -// This tests the invariant after freeing a block. -TEST_CASE(listpool_zero_free_block_after_free) { - test_pool pool; - listpool_make(&pool); - - int* val = listpool_alloc(&pool); - TEST_TRUE(val != 0); - *val = 177; - - int* old_val = val; - listpool_free(&pool, &val); // val pointer is set to 0. - TEST_EQUAL(*old_val, 0); // Block is zeroed out after free. -} - -// Traverse an empty pool. -TEST_CASE(listpool_traverse_empty) { - test_pool pool; - listpool_make(&pool); - - TEST_EQUAL(count(&pool), 0); -} - -// Traverse a partially full pool. -TEST_CASE(listpool_traverse_partially_full) { - const int N = NUM_BLOCKS / 2; - - test_pool pool; - listpool_make(&pool); - - for (int i = 0; i < N; ++i) { - int* val = listpool_alloc(&pool); - TEST_TRUE(val != 0); - *val = i + 1; - } - - TEST_EQUAL(sum(&pool), (N) * (N + 1) / 2); -} - -// Traverse a full pool. -TEST_CASE(listpool_traverse_full) { - test_pool pool; - listpool_make(&pool); - - for (int i = 0; i < NUM_BLOCKS; ++i) { - int* val = listpool_alloc(&pool); - TEST_TRUE(val != 0); - *val = i + 1; - } - - TEST_EQUAL(sum(&pool), (NUM_BLOCKS) * (NUM_BLOCKS + 1) / 2); -} - -// Get the ith (allocated) block. -TEST_CASE(listpool_get_block) { - test_pool pool; - listpool_make(&pool); - - for (int i = 0; i < NUM_BLOCKS; ++i) { - int* block = listpool_alloc(&pool); - TEST_TRUE(block != 0); - *block = i; - TEST_EQUAL(listpool_get_block_index(&pool, block), (size_t)i); - } - - for (int i = 0; i < NUM_BLOCKS; ++i) { - TEST_EQUAL(*listpool_get_block(&pool, i), i); - } -} - -// Remove a value from the list. -TEST_CASE(listpool_remove_value) { - test_pool pool; - listpool_make(&pool); - - int* x = listpool_alloc(&pool); - int* y = listpool_alloc(&pool); - TEST_TRUE(x != 0); - TEST_TRUE(y != 0); - - *x = 155; - *y = 177; - - listpool_remove(&pool, 155); // x - - TEST_EQUAL(count(&pool), 1); - TEST_EQUAL(sum(&pool), *y); -} - -// Stress test. -// -// 1. Allocate the pool, either fully or partially. If fully, attempt to -// allocate some items past the end. -// -// 2. Free all allocated items in some random order. - -int main() { return 0; } diff --git a/listpool/test/test.h b/listpool/test/test.h deleted file mode 100644 index fd8dc22..0000000 --- a/listpool/test/test.h +++ /dev/null @@ -1,185 +0,0 @@ -// SPDX-License-Identifier: MIT -#pragma once - -#ifdef UNIT_TEST - -#include -#include -#include -#include - -#if defined(__DragonFly__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || \ - defined(__NetBSD__) || defined(__OpenBSD__) -#define USE_SYSCTL_FOR_ARGS 1 -// clang-format off -#include -#include -// clang-format on -#include // getpid -#endif - -struct test_file_metadata; - -struct test_failure { - bool present; - const char *message; - const char *file; - int line; -}; - -struct test_case_metadata { - void (*fn)(struct test_case_metadata *, struct test_file_metadata *); - struct test_failure failure; - const char *name; - struct test_case_metadata *next; -}; - -struct test_file_metadata { - bool registered; - const char *name; - struct test_file_metadata *next; - struct test_case_metadata *tests; -}; - -struct test_file_metadata __attribute__((weak)) * test_file_head; - -#define SET_FAILURE(_message) \ - metadata->failure = (struct test_failure) { \ - .message = _message, .file = __FILE__, .line = __LINE__, .present = true, \ - } - -#define TEST_EQUAL(a, b) \ - do { \ - if ((a) != (b)) { \ - SET_FAILURE(#a " != " #b); \ - return; \ - } \ - } while (0) - -#define TEST_TRUE(a) \ - do { \ - if (!(a)) { \ - SET_FAILURE(#a " is not true"); \ - return; \ - } \ - } while (0) - -#define TEST_STREQUAL(a, b) \ - do { \ - if (strcmp(a, b) != 0) { \ - SET_FAILURE(#a " != " #b); \ - return; \ - } \ - } while (0) - -#define TEST_CASE(_name) \ - static void __test_h_##_name(struct test_case_metadata *, \ - struct test_file_metadata *); \ - static struct test_file_metadata __test_h_file; \ - static struct test_case_metadata __test_h_meta_##_name = { \ - .name = #_name, \ - .fn = __test_h_##_name, \ - }; \ - static void __attribute__((constructor(101))) __test_h_##_name##_register(void) { \ - __test_h_meta_##_name.next = __test_h_file.tests; \ - __test_h_file.tests = &__test_h_meta_##_name; \ - if (!__test_h_file.registered) { \ - __test_h_file.name = __FILE__; \ - __test_h_file.next = test_file_head; \ - test_file_head = &__test_h_file; \ - __test_h_file.registered = true; \ - } \ - } \ - static void __test_h_##_name( \ - struct test_case_metadata *metadata __attribute__((unused)), \ - struct test_file_metadata *file_metadata __attribute__((unused))) - -extern void __attribute__((weak)) (*test_h_unittest_setup)(void); -/// Run defined tests, return true if all tests succeeds -/// @param[out] tests_run if not NULL, set to whether tests were run -static inline void __attribute__((constructor(102))) run_tests(void) { - bool should_run = false; -#ifdef USE_SYSCTL_FOR_ARGS - int mib[] = { - CTL_KERN, -#if defined(__NetBSD__) || defined(__OpenBSD__) - KERN_PROC_ARGS, - getpid(), - KERN_PROC_ARGV, -#else - KERN_PROC, - KERN_PROC_ARGS, - getpid(), -#endif - }; - char *arg = NULL; - size_t arglen; - sysctl(mib, sizeof(mib) / sizeof(mib[0]), NULL, &arglen, NULL, 0); - arg = malloc(arglen); - sysctl(mib, sizeof(mib) / sizeof(mib[0]), arg, &arglen, NULL, 0); -#else - FILE *cmdlinef = fopen("/proc/self/cmdline", "r"); - char *arg = NULL; - int arglen; - fscanf(cmdlinef, "%ms%n", &arg, &arglen); - fclose(cmdlinef); -#endif - for (char *pos = arg; pos < arg + arglen; pos += strlen(pos) + 1) { - if (strcmp(pos, "--unittest") == 0) { - should_run = true; - break; - } - } - free(arg); - - if (!should_run) { - return; - } - - if (&test_h_unittest_setup) { - test_h_unittest_setup(); - } - - struct test_file_metadata *i = test_file_head; - int failed = 0, success = 0; - while (i) { - fprintf(stderr, "Running tests from %s:\n", i->name); - struct test_case_metadata *j = i->tests; - while (j) { - fprintf(stderr, "\t%s ... ", j->name); - j->failure.present = false; - j->fn(j, i); - if (j->failure.present) { - fprintf(stderr, "failed (%s at %s:%d)\n", j->failure.message, - j->failure.file, j->failure.line); - failed++; - } else { - fprintf(stderr, "passed\n"); - success++; - } - j = j->next; - } - fprintf(stderr, "\n"); - i = i->next; - } - int total = failed + success; - fprintf(stderr, "Test results: passed %d/%d, failed %d/%d\n", success, total, - failed, total); - exit(failed == 0 ? EXIT_SUCCESS : EXIT_FAILURE); -} - -#else - -#include - -#define TEST_CASE(name) static void __attribute__((unused)) __test_h_##name(void) - -#define TEST_EQUAL(a, b) \ - (void)(a); \ - (void)(b) -#define TEST_TRUE(a) (void)(a) -#define TEST_STREQUAL(a, b) \ - (void)(a); \ - (void)(b) - -#endif -- cgit v1.2.3