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

#ifndef ti_sysbios_runtime_Memory__include
#define ti_sysbios_runtime_Memory__include

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

#include <ti/sysbios/runtime/Error.h>
#include <ti/sysbios/runtime/IHeap.h>

/* BIOS 6.x compatibility, use -Dxdc_std__include to disable */
#include <xdc/std.h>

#define ti_sysbios_runtime_Memory_long_names
#include "Memory_defs.h"

#define Memory_Size size_t   /* for BIOS 6.x compatibility */

#ifdef __cplusplus
extern "C" {
#endif

#define Memory_Q_BLOCKING (1)

typedef struct {
    size_t totalSize;
    size_t totalFreeSize;
    size_t largestFreeSize;
} Memory_Stats;

typedef void * (*IHeap_AllocFxn) (void *, size_t, size_t, Error_Block *);
typedef void (*IHeap_FreeFxn) (void *, void *, size_t);
typedef bool (*IHeap_IsBlockingFxn) (void *);
typedef void (*IHeap_GetStatsFxn) (void *, Memory_Stats *);

/*
 * TODO -- should be in IHeap.h -- break the circular dependency
 * between Memory.h and IHeap.h
 */
typedef struct IHeap_Object {
    IHeap_AllocFxn alloc;
    IHeap_FreeFxn free;
    IHeap_IsBlockingFxn isBlocking;
    IHeap_GetStatsFxn getStats; 
} IHeap_Object, *IHeap_Handle;
extern IHeap_Handle Memory_defaultHeapInstance;

extern void * Memory_alloc(IHeap_Handle heap, size_t size, size_t align, Error_Block *eb);

extern void * Memory_calloc(IHeap_Handle heap, size_t size, size_t align, Error_Block *eb);

extern void Memory_free(IHeap_Handle heap, void * block, size_t size);

extern size_t Memory_getMaxDefaultTypeAlign(void);

extern void Memory_getStats(IHeap_Handle heap, Memory_Stats *stats);

extern bool Memory_query(IHeap_Handle heap, int qual);

extern IHeap_Handle Memory_getDefaultHeap(void);

extern void Memory_setDefaultHeap(IHeap_Handle heap);

extern void * Memory_valloc(IHeap_Handle heap, size_t size, size_t align, char value, Error_Block *eb);

#ifdef __cplusplus
}
#endif

#endif /* ti_sysbios_runtime_Memory__include */

#undef ti_sysbios_runtime_Memory_long_names
#include "Memory_defs.h"