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

#ifndef ti_sysbios_heaps_HeapBuf__include
#define ti_sysbios_heaps_HeapBuf__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_HeapBuf_long_names
#include "HeapBuf_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

/*
 * Error and Assert Ids
 */

#define HeapBuf_A_nullBuf "buf parameter cannot be null"

#define HeapBuf_A_bufAlign "buf not properly aligned"

#define HeapBuf_A_invalidAlign "align parameter must be 0 or a power of 2 >= the value of Memory_getMaxDefaultTypeAlign()"

#define HeapBuf_A_invalidRequestedAlign "align parameter 1) must be 0 or a power of 2 and 2) not greater than the heaps alignment"

#define HeapBuf_A_invalidBlockSize "blockSize must be large enough to hold at least two pointers"

#define HeapBuf_A_zeroBlocks "numBlocks cannot be zero"

#define HeapBuf_A_zeroBufSize "bufSize cannot be zero"

#define HeapBuf_A_invalidBufSize "HeapBuf_create's bufSize parameter is invalid (too small)"

#define HeapBuf_A_noBlocksToFree "Cannot call HeapBuf_free when no blocks have been allocated"

#define HeapBuf_A_invalidFree "Invalid free"

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

typedef struct {
    unsigned int maxAllocatedBlocks;
    unsigned int numAllocatedBlocks;
} HeapBuf_ExtendedStats;

typedef struct {
    size_t align;
    unsigned int numBlocks;
    size_t blockSize;
    size_t bufSize;
    void * buf;
} HeapBuf_Params;

typedef struct {
    IHeap_Object iheap;
    Queue_Elem objElem;
    size_t blockSize;
    size_t align;
    unsigned int numBlocks;
    size_t bufSize;
    char *buf;
    unsigned int numFreeBlocks;
    unsigned int minFreeBlocks;
    Queue_Struct freeList;
} HeapBuf_Struct, *HeapBuf_Handle;

typedef HeapBuf_Struct HeapBuf_Object;

typedef struct {
    Queue_Struct objQ;
} HeapBuf_Module_State;
#define ti_sysbios_heaps_HeapBuf_Handle_upCast(handle) ((IHeap_Handle)(handle))

extern void * HeapBuf_alloc(HeapBuf_Handle heap, size_t size, size_t align, Error_Block *eb);

/*
 * @brief Free a block of allocated memory.
 *
 * @param heap heap handle
 * @param buf address of allocated block
 * @param size size
 */
extern void HeapBuf_free(HeapBuf_Handle heap, void * buf, size_t size);

extern bool HeapBuf_isBlocking(HeapBuf_Handle heap);

extern void HeapBuf_getStats(HeapBuf_Handle heap, Memory_Stats *statBuf);

extern void HeapBuf_getExtendedStats(HeapBuf_Handle heap, HeapBuf_ExtendedStats *statBuf);

extern HeapBuf_Handle HeapBuf_create(const HeapBuf_Params *params, Error_Block *eb);


extern HeapBuf_Handle HeapBuf_construct(HeapBuf_Struct *obj, const HeapBuf_Params *params, Error_Block *eb);

extern void HeapBuf_delete(HeapBuf_Handle *heap);

extern void HeapBuf_destruct(HeapBuf_Struct *obj);

extern void HeapBuf_Params_init(HeapBuf_Params *prms);

extern HeapBuf_Handle HeapBuf_Object_first(void);

extern HeapBuf_Handle HeapBuf_Object_next(HeapBuf_Handle heap);

extern size_t HeapBuf_getBlockSize(HeapBuf_Handle heap);

extern void HeapBuf_mergeHeapBufs(HeapBuf_Handle h1, HeapBuf_Handle h2);

static inline HeapBuf_Handle HeapBuf_handle(HeapBuf_Struct *str)
{
    return ((HeapBuf_Handle)str);
}

static inline HeapBuf_Struct * HeapBuf_struct(HeapBuf_Handle h)
{
    return ((HeapBuf_Struct *)h);
}

#define HeapBuf_module ((HeapBuf_Module_State *) &(HeapBuf_Module_state))

#ifdef __cplusplus
}
#endif

#endif

#undef ti_sysbios_heaps_HeapBuf_long_names
#include "HeapBuf_defs.h"