shinyAllocator.h

Go to the documentation of this file.

/***
 * @brief header file for shinyAllocator library
 * @filename shinyAllocator.h
 * @author Ehsan Shaghaei <ehsan2754@gmail.com>
 * @date Dec 27, 2022
 * @version 1.0.0
 *
 * @copyright 2022 GNU GENERAL PUBLIC LICENSE
 *
 */
#ifndef __shinyAllocator_h
#define __shinyAllocator_h
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define SHINYALLOCATOR_VERSION_MAJOR 1
#define SHINYALLOCATOR_VERSION_MINOR 0
 
#define SHINYALLOCATOR_ALIGNMENT (sizeof(void *) * 4U)
 
    typedef struct shinyAllocatorInstance shinyAllocatorInstance;
    typedef struct shinyAllocatorThreadSafeInstance shinyAllocatorThreadSafeInstance;
    typedef  int_fast8_t SHINY_STATUS;
    typedef struct
    {
        size_t capacity;
        size_t allocated;
        size_t peakAllocated;
        size_t peakRequestSize;
        size_t outOfMemeoryCount;
    } shinyAllocatorDiagnostics;
 
    size_t sizeof_shinyAllocatorInstance(void);
 
    size_t sizeof_shinyAllocatorThreadSafeInstance(void);
 
    shinyAllocatorDiagnostics shinyGetDiagnostics(shinyAllocatorInstance *handle);
 
    shinyAllocatorInstance *shinyInit(void *const base, const size_t size);
 
    void *shinyAllocate(shinyAllocatorInstance *const handle, const size_t amount);
 
    void shinyFree(shinyAllocatorInstance *const handle, void *const pointer);
 
    shinyAllocatorDiagnostics shinyGetDiagnosticsThreadSafe(shinyAllocatorThreadSafeInstance *const threadSafeHandle);
 
    shinyAllocatorThreadSafeInstance *shinyInitThreadSafe(void *const base, const size_t size);
 
    void *shinyAllocateThreadSafe(shinyAllocatorThreadSafeInstance *const threadSafeHandle, const size_t amount);
 
    SHINY_STATUS shinyFreeThreadSafe(shinyAllocatorThreadSafeInstance *const threadSafeHandle, void *const pointer);
 
    SHINY_STATUS shinyDeinitThreadSafe(shinyAllocatorThreadSafeInstance *const threadSafeHandle);
#ifdef __cplusplus
}
#endif
#endif // __shinyAllocator_h