IHeap.h

Go to the documentation of this file.

/* 
 *  ============================================================================
 *
 *  Copyright (c) 2008-2012, Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  
 *  *  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  
 *  *  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.
 *  
 *  *  Neither the name of Texas Instruments Incorporated nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *  
 *  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 OWNER 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.
 *  Contact information for paper mail:
 *  Texas Instruments
 *  Post Office Box 655303
 *  Dallas, Texas 75265
 *  Contact information: 
 *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
 *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
 *  ============================================================================
 *  
 */



#ifndef HEAP_H_0x7033
#define HEAP_H_0x7033


/* OSAL and utils */
#include <ti/syslink/utils/MemoryDefs.h>
#include <ti/syslink/utils/Trace.h>


#if defined (__cplusplus)
extern "C" {
#endif


/* =============================================================================
 *  Forward declarations
 * =============================================================================
 */
typedef struct IHeap_Object_tag IHeap_Object;

typedef IHeap_Object * IHeap_Handle;


/* =============================================================================
 *  Function pointer types for heap operations
 * =============================================================================
 */
typedef Ptr (*IHeap_allocFxn) (IHeap_Handle    handle,
                               SizeT           size,
                               SizeT           align);

typedef Void (*IHeap_freeFxn) (IHeap_Handle handle,
                               Ptr          block,
                               SizeT        size);

typedef Void (*IHeap_getStatsFxn) (IHeap_Handle    handle,
                                   Memory_Stats  * stats);

/*
 * ! @brief Type for function pointer to indicate whether the heap may block
 *          during an alloc or free call
 */
typedef Bool (*IHeap_isBlockingFxn) (IHeap_Handle handle);

typedef Ptr (*IHeap_getKnlHandleFxn) (IHeap_Handle handle);


/* =============================================================================
 * Structures & Enums
 * =============================================================================
 */
struct IHeap_Object_tag {
    IHeap_allocFxn               alloc;
    IHeap_freeFxn                free;
    IHeap_getStatsFxn            getStats;
    IHeap_isBlockingFxn          isBlocking;
    IHeap_getKnlHandleFxn        getKnlHandle;
    Ptr                          obj;
};


/* =============================================================================
 *  APIs
 * =============================================================================
 */
static inline Ptr IHeap_alloc (IHeap_Handle    handle,
                               SizeT           size,
                               SizeT           align)
{
    Ptr buffer;

    GT_assert (curTrace, (((IHeap_Object *) handle)->alloc != NULL));
    buffer = ((IHeap_Object *) handle)->alloc (handle, size, align);
    return (buffer);
}


static inline Void IHeap_free (IHeap_Handle handle,
                               Ptr          block,
                               SizeT        size)
{
    GT_assert (curTrace, (((IHeap_Object *) handle)->free != NULL));
    ((IHeap_Object *) handle)->free (handle, block, size);
}


static inline Void IHeap_getStats (IHeap_Handle    handle,
                                   Memory_Stats  * stats)
{
    GT_assert (curTrace, (((IHeap_Object *) handle)->getStats != NULL));
    ((IHeap_Object *) handle)->getStats (handle, stats);
}


static inline Bool IHeap_isBlocking (IHeap_Handle    handle)
{
    Bool isBlocking;
    GT_assert (curTrace, (((IHeap_Object *) handle)->isBlocking != NULL));
    isBlocking = ((IHeap_Object *) handle)->isBlocking (handle);
    return (isBlocking);
}


static inline Ptr IHeap_getKnlHandle (IHeap_Handle    handle)
{
    Ptr knlHandle;
    GT_assert (curTrace, (((IHeap_Object *) handle)->getKnlHandle != NULL));
    knlHandle = ((IHeap_Object *) handle)->getKnlHandle (handle);
    return (knlHandle);
}


#if defined (__cplusplus)
}
#endif /* defined (__cplusplus) */


#endif /* HEAP_H_0x7033 */