Big-Data-HPC-Platform/system/jlib/jmalloc.hpp

/*##############################################################################

    HPCC SYSTEMS software Copyright (C) 2012 HPCC Systems®.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
############################################################################## */


#ifndef JMALLOC_HPP
#define JMALLOC_HPP

#include "jiface.hpp"

interface IAllocator: extends IInterface
{
    virtual void * allocMem(size32_t sz)=0;
    virtual void   freeMem(void *)=0;
    virtual void * reallocMem(void *prev,size32_t sz)=0;
    virtual size32_t usableSize(const void *)=0;  
    virtual memsize_t totalAllocated()=0;   // amount allocated from OS
    virtual memsize_t totalMax()=0;         // total that can be allocated from OS
    virtual memsize_t totalRemaining()=0;   // maximum remaining
    virtual void checkPtrValid(const void * ptr)=0;   // for debugging only
    virtual void logMemLeaks(bool logdata)=0; 
    virtual void * allocMem2(size32_t sz, size32_t &usablesz)=0;               // returns size actually allocated 
    virtual void * reallocMem2(void *prev,size32_t sz, size32_t &usablesz)=0;   // returns size actually allocated 
    virtual size32_t roundupSize(size32_t sz)=0; // returns usable size would round up to

};

extern jlib_decl IAllocator *createMemoryAllocator(
    memsize_t maxtotal,                         // maximum to allocate from OS
    size32_t maxsuballocsize=1024,              // set to 0 to disable suballocation
    memsize_t mintotal=0x100000*16,             // above this amount free to OS
    bool avoidReallocFragmentation=true         // whether reallocMem should avoid fragmenting memory by copying where needed 
);

extern jlib_decl IAllocator *createGuardedMemoryAllocator( // for debug only!
    memsize_t maxtotal,                         // maximum to allocate from OS
    size32_t maxsuballocsize=1024,              // set to 0 to disable suballocation
    memsize_t mintotal=0x100000*16,             // above this amount free to OS
    bool avoidReallocFragmentation=true,            // whether reallocMem should avoid fragmenting memory by copying where needed 
    size32_t guardsize= 32
);


extern jlib_decl void testAllocator();

#endif