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

#ifndef ti_sysbios_heaps_HeapMin__include
#define ti_sysbios_heaps_HeapMin__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_HeapMin_long_names
#include "HeapMin_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

#define HeapMin_A_zeroSize "heap size must be > 0"

#define HeapMin_E_freeError "free() invalid in growth-only HeapMin"

typedef struct {
    IHeap_Object iheap;
    Queue_Elem objElem;
    size_t remainSize;
    size_t startSize;
    char *buf;
} HeapMin_Struct, HeapMin_Object, *HeapMin_Handle;

typedef struct {
    Queue_Struct objQ;
} HeapMin_Module_State;
typedef struct {
    char *buf;
    size_t size;
} HeapMin_Params;


#define HeapMin_Handle_upCast(handle) ((IHeap_Handle)(handle))

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

extern void HeapMin_free(void *handle, void * buf, size_t size);

extern bool HeapMin_isBlocking(void *handle);

extern void HeapMin_getStats(void *handle, Memory_Stats *statBuf);

extern HeapMin_Handle HeapMin_create(const HeapMin_Params *params, Error_Block *eb);

extern HeapMin_Handle HeapMin_construct(HeapMin_Struct *obj, const HeapMin_Params *params);

extern void HeapMin_delete(HeapMin_Handle *handle);

extern void HeapMin_destruct(HeapMin_Struct *obj);

extern void HeapMin_Params_init(HeapMin_Params *prms);

extern HeapMin_Handle HeapMin_Object_first(void);

extern HeapMin_Handle HeapMin_Object_next(HeapMin_Handle heap);

extern void HeapMin_init(void);

static inline HeapMin_Handle HeapMin_handle(HeapMin_Struct *str)
{
    return ((HeapMin_Handle)str);
}

static inline HeapMin_Struct * HeapMin_struct(HeapMin_Handle h)
{
    return ((HeapMin_Struct *)h);
}

#define HeapMin_module ((HeapMin_Module_State *) &(HeapMin_Module_state))

#ifdef __cplusplus
}
#endif

#endif /* ti_sysbios_heaps_HeapMin__include */

#undef ti_sysbios_heaps_HeapMin_long_names
#include "HeapMin_defs.h"