HeapCallback.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020, Texas Instruments Incorporated - https://www.ti.com
 * All rights reserved.
 *
 * 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.
 *
 */
/*
 * ======== HeapCallback.h ========
 */

#ifndef ti_sysbios_heaps_HeapCallback__include
#define ti_sysbios_heaps_HeapCallback__include

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#include <ti/sysbios/runtime/Error.h>
#include <ti/sysbios/runtime/IHeap.h>
#include <ti/sysbios/runtime/Memory.h>

/* BIOS 6.x compatibility, use -Dxdc_std__include to disable */
#include <xdc/std.h>

#define ti_sysbios_heaps_HeapCallback_long_names
#include "HeapCallback_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

#define ti_sysbios_heaps_HeapCallback_Handle_upCast(handle) ((IHeap_Handle)(handle))

typedef void * (*HeapCallback_AllocInstFxn)(uintptr_t context, size_t size, size_t align);

typedef uintptr_t (*HeapCallback_CreateInstFxn)(uintptr_t arg);

typedef void (*HeapCallback_DeleteInstFxn)(uintptr_t context);

typedef void (*HeapCallback_FreeInstFxn)(uintptr_t context, void * addr, size_t size);

typedef void (*HeapCallback_GetStatsInstFxn)(uintptr_t context, Memory_Stats *stats);

typedef bool (*HeapCallback_IsBlockingInstFxn)(uintptr_t context);

typedef struct {
    uintptr_t arg;
} HeapCallback_Params;

typedef struct {
    IHeap_Object iheap;
    Queue_Elem objElem;
    uintptr_t context;
} HeapCallback_Struct, *HeapCallback_Handle;

typedef HeapCallback_Struct HeapCallback_Object;

typedef struct {
    Queue_Struct objQ;
} HeapCallback_Module_State;
extern void * HeapCallback_alloc(HeapCallback_Handle handle, size_t size, size_t align, Error_Block *eb);

extern void HeapCallback_free(HeapCallback_Handle handle, void * buf, size_t size);

extern bool HeapCallback_isBlocking(HeapCallback_Handle handle);

extern void HeapCallback_getStats(HeapCallback_Handle handle, Memory_Stats *stats);

extern HeapCallback_Handle HeapCallback_create(const HeapCallback_Params *params, Error_Block *eb);

extern HeapCallback_Handle HeapCallback_construct(HeapCallback_Struct *obj, const HeapCallback_Params *params);

extern void HeapCallback_delete(HeapCallback_Handle *handle);

extern void HeapCallback_destruct(HeapCallback_Struct *obj);

extern void HeapCallback_Params_init(HeapCallback_Params *prms);

extern HeapCallback_Handle HeapCallback_Object_first(void);

extern HeapCallback_Handle HeapCallback_Object_next(HeapCallback_Handle heap);

static inline HeapCallback_Handle HeapCallback_handle(HeapCallback_Struct *str)
{
    return ((HeapCallback_Handle)str);
}

static inline HeapCallback_Struct * HeapCallback_struct(HeapCallback_Handle h)
{
    return ((HeapCallback_Struct *)h);
}

extern void HeapCallback_init(void);
#define HeapCallback_module ((HeapCallback_Module_State *) &(HeapCallback_Module_state))

#ifdef __cplusplus
}
#endif

#endif

#undef ti_sysbios_heaps_HeapCallback_long_names
#include "HeapCallback_defs.h"