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

#ifndef ti_sysbios_heaps_HeapTrack__include
#define ti_sysbios_heaps_HeapTrack__include

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

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

#define HeapTrack_A_doubleFree "Buffer already free"

#define HeapTrack_A_bufOverflow "Buffer overflow"

#define HeapTrack_A_notEmpty "Heap not empty"

#define HeapTrack_A_nullObject "HeapTrack_printHeap called with null obj"

typedef struct {
    uintptr_t scribble;
    Queue_Elem queElem;
    size_t size;
    uint32_t tick;
    Task_Handle taskHandle;
} HeapTrack_Tracker;

typedef struct {
    IHeap_Handle heap;
} HeapTrack_Params;

typedef struct {
    IHeap_Object iheap;
    Queue_Elem objElem;
    IHeap_Handle internalHeap;
    Queue_Struct trackQueue;
    size_t size;
    size_t peak;
    size_t sizeWithoutTracker;
    size_t peakWithoutTracker;
} HeapTrack_Struct, *HeapTrack_Handle;

typedef struct {
    Queue_Struct objQ;
} HeapTrack_Module_State;

#define ti_sysbios_heaps_HeapTrack_NOSCRIBBLE    0x05101920
#define ti_sysbios_heaps_HeapTrack_STARTSCRIBBLE 0xa5a5a5a5

typedef HeapTrack_Struct HeapTrack_Object;

#define ti_sysbios_heaps_HeapTrack_Handle_upCast(handle) ((IHeap_Handle)(handle))

extern void * HeapTrack_alloc(HeapTrack_Handle heap, size_t size, size_t align, Error_Block *eb);

extern void HeapTrack_free(HeapTrack_Handle heap, void * buf, size_t size);

extern bool HeapTrack_isBlocking(HeapTrack_Handle heap);

extern void HeapTrack_getStats(HeapTrack_Handle heap, Memory_Stats *stats);

extern void HeapTrack_printTask(Task_Handle task);

extern void HeapTrack_printHeap(HeapTrack_Handle heap);

extern HeapTrack_Handle HeapTrack_Object_first(void);

extern HeapTrack_Handle HeapTrack_Object_next(HeapTrack_Handle heap);

extern HeapTrack_Handle HeapTrack_create(const HeapTrack_Params *params, Error_Block *eb);

extern HeapTrack_Handle HeapTrack_construct(HeapTrack_Struct *obj, const HeapTrack_Params *params);

extern void HeapTrack_delete(HeapTrack_Handle *heap);

extern void HeapTrack_destruct(HeapTrack_Struct *obj);

extern void HeapTrack_Params_init(HeapTrack_Params *prms);

extern HeapTrack_Handle HeapTrack_Object_first(void);

extern HeapTrack_Handle HeapTrack_Object_next(HeapTrack_Handle heap);

static inline HeapTrack_Handle HeapTrack_handle(HeapTrack_Struct *str)
{
    return ((HeapTrack_Handle)str);
}

static inline HeapTrack_Struct * HeapTrack_struct(HeapTrack_Handle h)
{
    return ((HeapTrack_Struct *)h);
}

extern void HeapTrack_init(void);
#define HeapTrack_module ((HeapTrack_Module_State *) &(HeapTrack_Module_state))

#ifdef __cplusplus
}
#endif

#endif

#undef ti_sysbios_heaps_HeapTrack_long_names
#include "HeapTrack_defs.h"