memory_block.h

Go to the documentation of this file.

/*
    MIT License
 
    Copyright (c) 2025 Robin A. Onsay
 
    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files
    (the "Software"), to deal in the Software without restriction,
    including without limitation the rights to use, copy, modify, merge,
    publish, distribute, sublicense, and/or sell copies of the Software,
    and to permit persons to whom the Software is furnished to do so,
    subject to the following conditions:
 
    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
*/
 
#ifndef JUNO_MEMORY_BLOCK_H
#define JUNO_MEMORY_BLOCK_H
#include "juno/module.h"
#include "juno/status.h"
#include "juno/memory/memory_api.h"
#ifdef __cplusplus
extern "C"
{
#endif
 
 
#ifdef __cplusplus
#define JUNO_MEMORY_BLOCK(name, type, length) static type name[length] = {}
#else
#define JUNO_MEMORY_BLOCK(name, type, length) static type name[length] = {0}
#endif
 
#ifdef __cplusplus
#define JUNO_MEMORY_BLOCK_METADATA(name, length) static JUNO_MEMORY_BLOCK_METADATA_T name[length] = {}
#else
#define JUNO_MEMORY_BLOCK_METADATA(name, length) static JUNO_MEMORY_BLOCK_METADATA_T name[length] = {0}
#endif
 
 
typedef struct JUNO_MEMORY_BLOCK_METADATA_TAG JUNO_MEMORY_BLOCK_METADATA_T;
typedef struct JUNO_MEMORY_BLOCK_TAG JUNO_MEMORY_BLOCK_T;
typedef struct JUNO_MEMORY_ALLOC_BLOCK_TAG JUNO_MEMORY_ALLOC_BLOCK_T;
 
struct JUNO_MEMORY_ALLOC_BLOCK_TAG JUNO_MODULE_DERIVE(JUNO_MEMORY_ALLOC_ROOT_T,
    uint8_t *pvMemory;                  
    JUNO_MEMORY_BLOCK_METADATA_T *ptMetadata; 
    size_t zTypeSize;                   
    size_t zLength;                     
    size_t zUsed;                       
    size_t zFreed;                      
);
 
#ifndef JUNO_MEMORY_CUSTOM
union JUNO_MEMORY_ALLOC_TAG JUNO_MODULE(JUNO_MEMORY_ALLOC_API_T, JUNO_MEMORY_ALLOC_ROOT_T,
    JUNO_MEMORY_ALLOC_BLOCK_T tJunoMemoryBlock;
);
#endif
 
JUNO_STATUS_T JunoMemory_BlockApi(JUNO_MEMORY_ALLOC_T *ptJunoMemory,
    void *pvMemory,
    JUNO_MEMORY_BLOCK_METADATA_T *ptMetadata,
    size_t zTypeSize,
    size_t zLength,
    JUNO_FAILURE_HANDLER_T pfcnFailureHandler,
    JUNO_USER_DATA_T *pvFailureUserData
);
#ifdef __cplusplus
}
#endif
#endif // JUNO_MEMORY_BLOCK_H