docs/doc7.0/memory_8h_source.html

/*  *************************************************************************************

    Copyright (c) 2021, Lowell D. Thomas

    All rights reserved.


    This file is part of APG Version 7.0.

    APG Version 7.0 may be used under the terms of the BSD 2-Clause License.


    Redistribution and use in source and binary forms, with or without

    modification, are permitted provided that the following conditions are met:


    1. Redistributions of source code must retain the above copyright notice, this

       list of conditions and the following disclaimer.


    2. Redistributions in binary form must reproduce the above copyright notice,

       this list of conditions and the following disclaimer in the documentation

       and/or other materials provided with the distribution.


    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


*   *************************************************************************************/

#ifndef LIB_MEMORY_H_

#define LIB_MEMORY_H_


typedef struct {

    aint uiAllocations;

    aint uiReAllocations;

    aint uiFrees;

    aint uiCells;

    aint uiMaxCells;

    aint uiHeapBytes;

    aint uiMaxHeapBytes;

} mem_stats;


void* vpMemCtor(exception* spException);

void vMemDtor(void* vpCtx);

abool bMemValidate(void* vpCtx);

void* vpMemAlloc(void* vpCtx, aint uiBytes);

void vMemFree(void* vpCtx, const void* vpData);

void* vpMemRealloc(void* vpCtx, const void* vpData, aint uiBytes);

aint uiMemCount(void* vpCtx);

void vMemClear(void* vpCtx);

void vMemStats(void* vpCtx, mem_stats* spStats);

exception* spMemException(void* vpCtx);


#endif /* LIB_MEMORY_H_ */