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/macros.h"
#include "juno/status.h"
#include "juno/module.h"
#include <stddef.h>
#include <stdalign.h>
#include "juno/memory/pointer_api.h"
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct JUNO_MEMORY_ALLOC_API_TAG JUNO_MEMORY_ALLOC_API_T;
typedef struct JUNO_MEMORY_ALLOC_ROOT_TAG JUNO_MEMORY_ALLOC_ROOT_T;
 
// @{"req": ["REQ-MEMORY-002"]}
struct JUNO_MEMORY_ALLOC_ROOT_TAG JUNO_MODULE_ROOT(JUNO_MEMORY_ALLOC_API_T,
    const JUNO_POINTER_API_T *ptPointerApi;
);
 
// @{"req": ["REQ-MEMORY-001"]}
struct JUNO_MEMORY_ALLOC_API_TAG
{
    JUNO_RESULT_POINTER_T (*Get)(JUNO_MEMORY_ALLOC_ROOT_T *ptMem, size_t zSize);
 
    JUNO_STATUS_T (*Update)(JUNO_MEMORY_ALLOC_ROOT_T *ptMem, JUNO_POINTER_T *ptMemory, size_t zNewSize);
 
    JUNO_STATUS_T (*Put)(JUNO_MEMORY_ALLOC_ROOT_T *ptMem, JUNO_POINTER_T *pvAddr);
};
 
static inline JUNO_STATUS_T JunoMemory_AllocApiVerify(const JUNO_MEMORY_ALLOC_API_T *ptAllocApi)
{
    JUNO_ASSERT_EXISTS(
        ptAllocApi &&
        ptAllocApi->Get &&
        ptAllocApi->Put &&
        ptAllocApi->Update
    );
    return JUNO_STATUS_SUCCESS;
}
 
static inline JUNO_STATUS_T JunoMemory_AllocVerify(const JUNO_MEMORY_ALLOC_ROOT_T *ptAlloc)
{
    JUNO_ASSERT_EXISTS(
        ptAlloc &&
        ptAlloc->ptApi &&
        ptAlloc->ptPointerApi
    );
    JUNO_STATUS_T tStatus = JunoMemory_AllocApiVerify(ptAlloc->ptApi);
    JUNO_ASSERT_SUCCESS(tStatus, return tStatus);
    tStatus = JunoMemory_PointerApiVerify(ptAlloc->ptPointerApi);
    JUNO_ASSERT_SUCCESS(tStatus, return tStatus);
    return tStatus;
}
 
#ifdef __cplusplus
}
#endif
#endif // JUNO_MEMORY_API_H