choco_memory.h

Go to the documentation of this file.

 
#ifndef GLCE_ENGINE_CORE_MEMORY_CHOCO_MEMORY_H
#define GLCE_ENGINE_CORE_MEMORY_CHOCO_MEMORY_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
 
#ifdef TEST_BUILD
#include <stdint.h>
#endif
 
typedef enum {
    MEMORY_TAG_SYSTEM,      
    MEMORY_TAG_STRING,      
    MEMORY_TAG_RING_QUEUE,  
    MEMORY_TAG_RENDERER,    
    MEMORY_TAG_FILE_IO,     
    MEMORY_TAG_MAX,         
} memory_tag_t;
 
typedef enum {
    MEMORY_SYSTEM_SUCCESS = 0,      
    MEMORY_SYSTEM_INVALID_ARGUMENT, 
    MEMORY_SYSTEM_RUNTIME_ERROR,    
    MEMORY_SYSTEM_LIMIT_EXCEEDED,   
    MEMORY_SYSTEM_NO_MEMORY,        
} memory_system_result_t;
 
memory_system_result_t memory_system_create(void);
 
void memory_system_destroy(void);
 
memory_system_result_t memory_system_allocate(size_t size_, memory_tag_t mem_tag_, void** out_ptr_);
 
void memory_system_free(void* ptr_, size_t size_, memory_tag_t mem_tag_);
 
void memory_system_report(void);
 
#ifdef TEST_BUILD
void memory_system_test_param_set(int32_t malloc_fail_n_);
 
void memory_system_rslt_code_set(memory_system_result_t result_code_);
 
void memory_system_test_param_reset(void);
#endif
 
#ifdef __cplusplus
}
#endif
#endif