stk_c_memory.h

Go to the documentation of this file.

/*
 * SuperTinyKernel(TM) RTOS: Lightweight High-Performance Deterministic C++ RTOS for Embedded Systems.
 *
 * Source: https://github.com/SuperTinyKernel-RTOS
 *
 * Copyright (c) 2022-2026 Neutron Code Limited <stk@neutroncode.com>. All Rights Reserved.
 * License: MIT License, see LICENSE for a full text.
 */
 
#ifndef STK_C_MEMORY_H_
#define STK_C_MEMORY_H_
 
#include "stk_c.h"

 
#ifdef __cplusplus
extern "C" {
#endif
 
// =============================================================================
// Configuration macros
// =============================================================================

#ifndef STK_C_BLOCKPOOL_MAX
    #define STK_C_BLOCKPOOL_MAX (8U)
#endif
 
// =============================================================================
// Storage helper macros
// =============================================================================

#define STK_BLOCKPOOL_ALIGN (sizeof(stk_word_t))

#define STK_BLOCKPOOL_ALIGN_BLOCK_SIZE(raw_size) \
    (((raw_size) < STK_BLOCKPOOL_ALIGN) \
        ? STK_BLOCKPOOL_ALIGN \
        : (((raw_size) + (STK_BLOCKPOOL_ALIGN - 1U)) & ~(STK_BLOCKPOOL_ALIGN - 1U)))

#define STK_BLOCKPOOL_STORAGE_SIZE(capacity, raw_block_size) \
    ((capacity) * STK_BLOCKPOOL_ALIGN_BLOCK_SIZE(raw_block_size))

#define STK_BLOCKPOOL_STORAGE_DECL(name, capacity, raw_block_size) \
    static stk_word_t name[STK_BLOCKPOOL_STORAGE_SIZE(capacity, raw_block_size) / sizeof(stk_word_t)]
 
// =============================================================================
// Types
// =============================================================================

typedef struct stk_blockpool_t stk_blockpool_t;
 
// =============================================================================
// Lifecycle - heap storage
// =============================================================================

stk_blockpool_t *stk_blockpool_create(size_t      capacity,
                                      size_t      raw_block_size,
                                      const char *name);

stk_blockpool_t *stk_blockpool_create_static(size_t      capacity,
                                             size_t      raw_block_size,
                                             uint8_t    *storage,
                                             size_t      storage_size,
                                             const char *name);

void stk_blockpool_destroy(stk_blockpool_t *pool);
 
// =============================================================================
// Allocation
// =============================================================================

void *stk_blockpool_alloc(stk_blockpool_t *pool);

void *stk_blockpool_timed_alloc(stk_blockpool_t *pool, stk_timeout_t timeout);

void *stk_blockpool_try_alloc(stk_blockpool_t *pool);
 
// =============================================================================
// Deallocation
// =============================================================================

bool stk_blockpool_free(stk_blockpool_t *pool, void *ptr);
 
// =============================================================================
// Query
// =============================================================================

bool stk_blockpool_is_storage_valid(const stk_blockpool_t *pool);

size_t stk_blockpool_get_capacity(const stk_blockpool_t *pool);

size_t stk_blockpool_get_block_size(const stk_blockpool_t *pool);

size_t stk_blockpool_get_used_count(const stk_blockpool_t *pool);

size_t stk_blockpool_get_free_count(const stk_blockpool_t *pool);

bool stk_blockpool_is_full(const stk_blockpool_t *pool);

bool stk_blockpool_is_empty(const stk_blockpool_t *pool);
 
#ifdef __cplusplus
}
#endif

 
#endif /* STK_C_MEMORY_H_ */