libmemalloc.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024-2025 Rafael V. Volkmer
 * SPDX-FileCopyrightText: <rafael.v.volkmer@gmail.com>
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
 
/*< C++ Compatibility >*/
#ifdef __cplusplus
extern "C"
{
#endif
 
/*< Dependencies >*/
#include <pthread.h>
#include <stdatomic.h>
#include <stdbool.h>
#include <stdint.h>
#include <string.h>
 
/*< Implemented >*/
#include "memalloc_utils.h"
 
#define GC_INTERVAL_MS (uint16_t)(100U)
 
typedef enum AllocationStrategy
{
  FIRST_FIT = (uint8_t)(0u), 
  NEXT_FIT  = (uint8_t)(1u), 
  BEST_FIT  = (uint8_t)(2u) 
} allocation_strategy_t;
 
__LIBMEMALLOC_API void *MEM_memset(void *const  source,
                                   const int    value,
                                   const size_t size);
 
__LIBMEMALLOC_API void *MEM_memcpy(void *const  dest,
                                   const void  *src,
                                   const size_t size);
 
__LIBMEMALLOC_API void *MEM_allocFirstFit(const size_t size)
  __LIBMEMALLOC_MALLOC;
 
__LIBMEMALLOC_API void *MEM_allocBestFit(const size_t size)
  __LIBMEMALLOC_MALLOC;
 
__LIBMEMALLOC_API void *MEM_allocNextFit(const size_t size)
  __LIBMEMALLOC_MALLOC;
 
__LIBMEMALLOC_API void *MEM_alloc(const size_t                size,
                                  const allocation_strategy_t strategy)
  __LIBMEMALLOC_MALLOC;
 
__LIBMEMALLOC_API void *MEM_calloc(const size_t                size,
                                   const allocation_strategy_t strategy)
  __LIBMEMALLOC_MALLOC;
 
__LIBMEMALLOC_API void *MEM_realloc(void *const                 ptr,
                                    const size_t                new_size,
                                    const allocation_strategy_t strategy)
  __LIBMEMALLOC_REALLOC;
 
__LIBMEMALLOC_API int MEM_free(void *const ptr);
 
#if defined(GARBACE_COLLECTOR)
 
__LIBMEMALLOC_API int MEM_enableGc(mem_allocator_t *const allocator);
 
__LIBMEMALLOC_API int MEM_disableGc(mem_allocator_t *const allocator);
 
#endif
 
/*< C++ Compatibility >*/
#ifdef __cplusplus
}
#endif
 
/*< end of header file >*/