HeapMultiBuf.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.
 *
 */
/*
 * ======== HeapMultiBuf.h ========
 */

#ifndef ti_sysbios_heaps_HeapMultiBuf__include
#define ti_sysbios_heaps_HeapMultiBuf__include

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

#include <ti/sysbios/heaps/HeapBuf.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_HeapMultiBuf_long_names
#include "HeapMultiBuf_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

#define HeapMultiBuf_A_blockNotFreed "Invalid block address on the free. Failed to free block back to heap."

#define HeapMultiBuf_E_size "requested size is too big: handle=0x%x, size=%u"

typedef struct {
    bool blockBorrow;
    int numBufs;
    HeapBuf_Params *bufParams;
} HeapMultiBuf_Params;

typedef struct {
    HeapBuf_Handle heapBuf;
    void * lastAddr;
} HeapMultiBuf_AddrPair;
typedef struct {
    IHeap_Object iheap;
    Queue_Elem objElem;
    bool blockBorrow;
    int numHeapBufs;
    int numBufs;
    HeapBuf_Handle *bufsBySize;
    HeapMultiBuf_AddrPair *bufsByAddr;
} HeapMultiBuf_Struct, *HeapMultiBuf_Handle;

typedef HeapMultiBuf_Struct HeapMultiBuf_Object;

typedef struct {
    Queue_Struct objQ;
} HeapMultiBuf_Module_State;
#define ti_sysbios_heaps_HeapMultiBuf_Handle_upCast(handle) ((IHeap_Handle)(handle))

extern void * HeapMultiBuf_alloc(HeapMultiBuf_Handle handle, size_t size, size_t align, Error_Block *eb);

extern void HeapMultiBuf_free(HeapMultiBuf_Handle handle, void * buf, size_t size);

extern bool HeapMultiBuf_isBlocking(HeapMultiBuf_Handle handle);

extern void HeapMultiBuf_getStats(HeapMultiBuf_Handle handle, Memory_Stats *statBuf);

extern HeapMultiBuf_Handle HeapMultiBuf_create(const HeapMultiBuf_Params *params, Error_Block *eb);

extern HeapMultiBuf_Handle HeapMultiBuf_construct(HeapMultiBuf_Struct *obj, const HeapMultiBuf_Params *params, Error_Block *eb);

extern void HeapMultiBuf_delete(HeapMultiBuf_Handle *handle);

extern void HeapMultiBuf_destruct(HeapMultiBuf_Struct *obj);

extern void HeapMultiBuf_Params_init(HeapMultiBuf_Params *prms);

extern HeapMultiBuf_Handle HeapMultiBuf_Object_first(void);

extern HeapMultiBuf_Handle HeapMultiBuf_Object_next(HeapMultiBuf_Handle heap);

static inline HeapMultiBuf_Handle HeapMultiBuf_handle(HeapMultiBuf_Struct *str)
{
    return ((HeapMultiBuf_Handle)str);
}

static inline HeapMultiBuf_Struct * HeapMultiBuf_struct(HeapMultiBuf_Handle h)
{
    return ((HeapMultiBuf_Struct *)h);
}

#define HeapMultiBuf_module ((HeapMultiBuf_Module_State *) &(HeapMultiBuf_Module_state))

#ifdef __cplusplus
}
#endif

#endif

#undef ti_sysbios_heaps_HeapMultiBuf_long_names
#include "HeapMultiBuf_defs.h"