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

#ifndef ti_sysbios_heaps_HeapMem__include
#define ti_sysbios_heaps_HeapMem__include

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

#include <ti/sysbios/knl/Queue.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_HeapMem_long_names
#include "HeapMem_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

#define HeapMem_reqAlign sizeof(HeapMem_Header)

#define HeapMem_A_align       "Requested align is not a power of 2"

#define HeapMem_A_heapSize    "Requested heap size is too small"

#define HeapMem_A_invalidFree "Heap-block free operations must not leave the heap in an invalid state"

#define HeapMem_A_zeroBlock   "Cannot allocate size 0"

#define HeapMem_E_memory      "out of memory: handle = 0x%x, size=%u"

typedef struct {
    void * buf;
    size_t size;
} HeapMem_ExtendedStats;

typedef struct HeapMem_Header {
    struct HeapMem_Header *next;
    size_t size;
} HeapMem_Header;
typedef struct {
    size_t minBlockAlign;
    void * buf;
    size_t size;
} HeapMem_Params;

typedef struct {
    IHeap_Object iheap;
    Queue_Elem objElem;
    size_t align;
    char *buf;
    HeapMem_Header head;
    size_t minBlockAlign;
} HeapMem_Struct, *HeapMem_Handle;
typedef HeapMem_Struct HeapMem_Object;

typedef struct {
    Queue_Struct objQ;
} HeapMem_Module_State;
#define ti_sysbios_heaps_HeapMem_Handle_upCast(handle) ((IHeap_Handle)(handle))

extern void * HeapMem_alloc(HeapMem_Handle heap, size_t size, size_t align, Error_Block *eb);

extern void HeapMem_free(HeapMem_Handle heap, void * buf, size_t size);

extern bool HeapMem_isBlocking(HeapMem_Handle heap);

extern void HeapMem_getStats(HeapMem_Handle heap, Memory_Stats *statBuf);

extern void HeapMem_getExtendedStats(HeapMem_Handle heap, HeapMem_ExtendedStats *statBuf);

extern HeapMem_Handle HeapMem_create(const HeapMem_Params *params, Error_Block *eb);

extern HeapMem_Handle HeapMem_construct(HeapMem_Struct *obj, const HeapMem_Params *params);

extern void HeapMem_delete(HeapMem_Handle *heap);

extern void HeapMem_destruct(HeapMem_Struct *obj);

extern void HeapMem_restore(HeapMem_Handle heap);

extern void HeapMem_init(void);

extern void HeapMem_Params_init(HeapMem_Params *prms);

extern HeapMem_Handle HeapMem_Object_first(void);

extern HeapMem_Handle HeapMem_Object_next(HeapMem_Handle heap);

static inline HeapMem_Handle HeapMem_handle(HeapMem_Struct *str)
{
    return ((HeapMem_Handle)str);
}

static inline HeapMem_Struct * HeapMem_struct(HeapMem_Handle h)
{
    return ((HeapMem_Struct *)h);
}

#define HeapMem_module ((HeapMem_Module_State *) &(HeapMem_Module_state))

#ifdef __cplusplus
}
#endif

#endif

#undef ti_sysbios_heaps_HeapMem_long_names
#include "HeapMem_defs.h"