sapi_memory.h

Go to the documentation of this file.

#ifndef SAFEAPI_OS_MEMORY_H
#define SAFEAPI_OS_MEMORY_H
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

SAFEAPI_DECLARE_STORAGE(sapi_mem_pool_storage_t, 64U);

typedef struct sapi_mem_pool_impl_s *sapi_mem_pool_handle_t;

typedef struct sapi_mem_pool_config_s
{
    size_t block_size;    
    size_t block_count;   
} sapi_mem_pool_config_t;

sapi_status_t sapi_mem_pool_create(sapi_mem_pool_storage_t *storage,
                                    const sapi_mem_pool_config_t *config,
                                    sapi_mem_pool_handle_t *out_handle);

sapi_status_t sapi_mem_pool_acquire(sapi_mem_pool_handle_t handle, void **out_block);

sapi_status_t sapi_mem_pool_release(sapi_mem_pool_handle_t handle, void *block);

sapi_status_t sapi_mem_pool_stats(sapi_mem_pool_handle_t handle,
                                   size_t *out_free_blocks,
                                   size_t *out_used_blocks);
 
/*
 * The backend vtable (sapi_mem_pool_backend_t) and
 * sapi_mem_pool_register_backend() live in
 * safeapi_backend/memory/sapi_memory_backend.h, not here (ADR-021). This
 * header is the consumer-facing surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAFEAPI_OS_MEMORY_H */
 /* MEMORY */