clHeapApi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */

#ifndef _CL_HEAP_API_H_
#define _CL_HEAP_API_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <clPoolIpi.h>
#include <clMemStats.h>

typedef enum {
    CL_HEAP_PREALLOCATED_MODE, 
    
    CL_HEAP_NATIVE_MODE, 
    
    CL_HEAP_CUSTOM_MODE, 
    
} ClHeapModeT;

typedef struct {
    ClHeapModeT mode; 

    ClBoolT lazy; 

    ClPoolConfigT *pPoolConfig;

    ClUint32T numPools;    
} ClHeapConfigT;

/*****************************************************************************
 *  Functions
 *****************************************************************************/

ClPtrT clHeapAllocate(CL_IN ClUint32T size);
void clHeapFree(CL_IN ClPtrT pAddress);
ClPtrT clHeapCalloc(CL_IN ClUint32T numChunks,CL_IN ClUint32T chunkSize);
/*****************************************************************************/

#ifndef __KERNEL__
/*****************************************************************************/
ClRcT clHeapLibInitialize(CL_IN const ClHeapConfigT *pHeapConfig);
/*****************************************************************************/

ClRcT clHeapLibFinalize(void);
/*****************************************************************************/
ClRcT clHeapInit(void);
/*****************************************************************************/
ClRcT clHeapExit(void);
/*****************************************************************************/

ClPtrT clHeapRealloc(CL_IN ClPtrT pAddress,CL_IN ClUint32T size);
/*****************************************************************************/

ClRcT clHeapShrink(CL_IN const ClPoolShrinkOptionsT *pShrinkOptions);
/*****************************************************************************/

ClRcT clHeapModeGet(CL_OUT ClHeapModeT *pMode);
/*****************************************************************************/

ClRcT clHeapStatsGet(CL_OUT ClMemStatsT *pHeapStats);
/*****************************************************************************/

ClRcT clHeapPoolStatsGet(CL_IN ClUint32T numPools,CL_OUT ClUint32T *pPoolSize,CL_OUT ClPoolStatsT *pHeapPoolStats);
/*****************************************************************************/

ClRcT clHeapLibCustomInitialize(const ClHeapConfigT *pHeapConfig);
/*****************************************************************************/

ClRcT clHeapLibCustomFinalize(void);
/*****************************************************************************/

ClRcT clHeapHooksRegister(CL_IN ClPtrT (*allocHook) (ClUint32T),
                     CL_IN ClPtrT (*reallocHook)(ClPtrT ,ClUint32T),
                     CL_IN ClPtrT (*callocHook)(ClUint32T,ClUint32T),
                     CL_IN void (*freeHook)(ClPtrT )
                     );
/*****************************************************************************/

ClRcT clHeapHooksDeregister(void);
/*****************************************************************************/

#endif

#ifdef __cplusplus
}
#endif

#endif