memory_api.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_API_H
#define JUNO_MEMORY_API_H
#include "juno/status.h"
#include "juno/module.h"
#include <stddef.h>
#ifdef __cplusplus
extern "C"
{
#endif
#define JUNO_REF(name) REF##name
#define JUNO_NEW_REF(name) JUNO_MEMORY_T *JUNO_REF(name)
 
typedef struct JUNO_MEMORY_TAG JUNO_MEMORY_T;
 
struct JUNO_MEMORY_BLOCK_METADATA_TAG
{
    uint8_t *ptFreeMem;
};
 
struct JUNO_MEMORY_TAG
{
    void *pvAddr;
    size_t zSize;
    size_t iRefCount;
};
 
typedef struct JUNO_MEMORY_ALLOC_API_TAG JUNO_MEMORY_ALLOC_API_T;
 
typedef union JUNO_MEMORY_ALLOC_TAG JUNO_MEMORY_ALLOC_T;
typedef struct JUNO_MEMORY_ALLOC_ROOT_TAG JUNO_MEMORY_ALLOC_ROOT_T;
 
struct JUNO_MEMORY_ALLOC_ROOT_TAG JUNO_MODULE_ROOT(JUNO_MEMORY_ALLOC_API_T, JUNO_MODULE_EMPTY);
 
struct JUNO_MEMORY_ALLOC_API_TAG
{
    JUNO_STATUS_T (*Get)(JUNO_MEMORY_ALLOC_T *ptMem, JUNO_MEMORY_T *pvRetAddr, size_t zSize);
 
    JUNO_STATUS_T (*Update)(JUNO_MEMORY_ALLOC_T *ptMem, JUNO_MEMORY_T *ptMemory, size_t zNewSize);
 
    JUNO_STATUS_T (*Put)(JUNO_MEMORY_ALLOC_T *ptMem, JUNO_MEMORY_T *pvAddr);
};
 
 
static inline JUNO_MEMORY_T * Juno_MemoryGetRef(JUNO_MEMORY_T *ptMemory)
{
    if(ptMemory->iRefCount)
    {
        ptMemory->iRefCount += 1;
    }
    return ptMemory;
}
 
static inline void Juno_MemoryPutRef(JUNO_MEMORY_T *ptMemory)
{
    if(ptMemory->iRefCount)
    {
        ptMemory->iRefCount -= 1;
    }
}
 
 
 
#ifdef __cplusplus
}
#endif
#endif // JUNO_MEMORY_API_H