module ti.sdo.ipc.heaps.HeapMemMP

Multi-processor variable size buffer heap implementation

C synopsis
Individual elements
XDCscript usage
Individual elements

This module has a common header that can be found in the ti.ipc package. Application code should include the common header file (not the RTSC-generated one):

#include <ti/ipc/HeapMemMP.h>

The RTSC module must be used in the application's RTSC configuration file (.cfg) if runtime APIs will be used in the application:

HeapMemMP = xdc.useModule('ti.sdo.ipc.heaps.HeapMemMP');

Documentation for all runtime APIs, instance configuration parameters, error codes macros and type definitions available to the application integrator can be found in the Doxygen documenation for the IPC product. However, the documentation presented on this page should be referred to for information specific to the RTSC module, such as module configuration, Errors, and Asserts.

C synopsis target-domain sourced in ti/sdo/ipc/heaps/HeapMemMP.xdc

#include <ti/sdo/ipc/heaps/HeapMemMP.h>

Functions
Void	HeapMemMP_construct// Initialize a new instance object inside the provided structure(HeapMemMP_Struct structP, const HeapMemMP_Params params, Error_Block *eb);
HeapMemMP_Handle	HeapMemMP_create// Allocate and initialize a new instance object and return its handle(const HeapMemMP_Params params, Error_Block eb);
Void	HeapMemMP_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(HeapMemMP_Handle *handleP);
Void	HeapMemMP_destruct// Finalize the instance object inside the provided structure(HeapMemMP_Struct *structP);
Void	HeapMemMP_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(HeapMemMP_Params *params);
Functions common to all IHeap modules
Ptr	HeapMemMP_alloc// Allocates a block of memory from the heap(HeapMemMP_Handle handle, SizeT size, SizeT align, Error_Block *eb);
Void	HeapMemMP_free// Free a block of memory back to the heap(HeapMemMP_Handle handle, Ptr block, SizeT size);
Void	HeapMemMP_getStats// Retrieve the statistics from the heap(HeapMemMP_Handle handle, Memory_Stats *stats);
Bool	HeapMemMP_isBlocking// Returns whether the heap may block during an `alloc()` or `free()`(HeapMemMP_Handle handle);
Functions common to all target instances
	HeapMemMP_handle// Convert this instance structure pointer into an instance handle, HeapMemMP_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, HeapMemMP_Handle_label// The label associated with this instance object, HeapMemMP_Handle_name// The name of this instance object, HeapMemMP_Handle_upCast// unconditionally move one level up the inheritance hierarchy, HeapMemMP_Object_count// The number of statically-created instance objects, HeapMemMP_Object_first// The handle of the first dynamically-created instance object, or NULL, HeapMemMP_Object_get// The handle of the i-th statically-created instance object (array == NULL), HeapMemMP_Object_heap// The heap used to allocate dynamically-created instance objects, HeapMemMP_Object_next// The handle of the next dynamically-created instance object, or NULL, HeapMemMP_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	HeapMemMP_Module_getMask// Returns the diagnostics mask for this module, HeapMemMP_Module_hasMask// Test whether this module has a diagnostics mask, HeapMemMP_Module_heap// The heap from which this module allocates memory, HeapMemMP_Module_id// Get this module's unique id, HeapMemMP_Module_setMask// Set the diagnostics mask for this module, HeapMemMP_Module_startupDone// Test if this module has completed startup
Typedefs
typedef struct	HeapMemMP_ExtendedStats// Stats structure for the getExtendedStats API ...
typedef HeapMemMP_Object *	HeapMemMP_Handle// Client reference to an instance object;
typedef struct	HeapMemMP_Object// Opaque internal representation of an instance object HeapMemMP_Object;
typedef struct	HeapMemMP_Params// Instance config-params structure ...
typedef struct	HeapMemMP_Struct// Opaque client structure large enough to hold an instance object HeapMemMP_Struct;
Constants
extern const Assert_Id	HeapMemMP_A_align// Assert raised when the requested alignment is not a power of 2;
extern const Assert_Id	HeapMemMP_A_heapSize// Assert raised when the requested heap size is too small;
extern const Assert_Id	HeapMemMP_A_invalidFree// Assert raised when the free detects that an invalid addr or size;
extern const Assert_Id	HeapMemMP_A_zeroBlock// Assert raised when a block of size 0 is requested;
extern const Error_Id	HeapMemMP_E_memory// Raised when requested size exceeds largest free block;
extern const UInt	HeapMemMP_maxNameLen// Maximum length for heap names;

struct HeapMemMP_ExtendedStats