unleashed-firmware/furi/core/memmgr.h

/**
 * @file memmgr.h
 * Furi: memory managment API and glue
 */

#pragma once

#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include "check.h"

#ifdef __cplusplus
extern "C" {
#endif

// define for test case "link against furi memmgr"
#define FURI_MEMMGR_GUARD 1

/** Get free heap size
 *
 * @return     free heap size in bytes
 */
size_t memmgr_get_free_heap(void);

/** Get total heap size
 *
 * @return     total heap size in bytes
 */
size_t memmgr_get_total_heap(void);

/** Get heap watermark
 *
 * @return     minimum heap in bytes
 */
size_t memmgr_get_minimum_free_heap(void);

/**
 * An aligned version of malloc, used when you need to get the aligned space on the heap
 * Freeing the received address is performed ONLY through the aligned_free function
 * @param size 
 * @param alignment 
 * @return void* 
 */
void* aligned_malloc(size_t size, size_t alignment);

/**
 * Freed space obtained through the aligned_malloc function
 * @param p pointer to result of aligned_malloc
 */
void aligned_free(void* p);

/**
 * @brief Allocate memory from separate memory pool. That memory can't be freed.
 * 
 * @param size 
 * @return void* 
 */
void* memmgr_alloc_from_pool(size_t size);

/**
 * @brief Get free memory pool size
 * 
 * @return size_t 
 */
size_t memmgr_pool_get_free(void);

/**
 * @brief Get max free block size from memory pool
 * 
 * @return size_t 
 */
size_t memmgr_pool_get_max_block(void);

#ifdef __cplusplus
}
#endif