module ti.sdo.ipc.heaps.HeapMultiBufMP

Multi-processor fixed-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/HeapMultiBufMP.h>

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

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

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. [ more ... ]

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

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

Functions
Void	HeapMultiBufMP_construct// Initialize a new instance object inside the provided structure(HeapMultiBufMP_Struct structP, const HeapMultiBufMP_Params params, Error_Block *eb);
HeapMultiBufMP_Handle	HeapMultiBufMP_create// Allocate and initialize a new instance object and return its handle(const HeapMultiBufMP_Params params, Error_Block eb);
Void	HeapMultiBufMP_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(HeapMultiBufMP_Handle *handleP);
Void	HeapMultiBufMP_destruct// Finalize the instance object inside the provided structure(HeapMultiBufMP_Struct *structP);
Void	HeapMultiBufMP_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(HeapMultiBufMP_Params *params);
Functions common to all IHeap modules
Ptr	HeapMultiBufMP_alloc// Allocates a block of memory from the heap(HeapMultiBufMP_Handle handle, SizeT size, SizeT align, Error_Block *eb);
Void	HeapMultiBufMP_free// Free a block of memory back to the heap(HeapMultiBufMP_Handle handle, Ptr block, SizeT size);
Void	HeapMultiBufMP_getStats// Retrieve the statistics from the heap(HeapMultiBufMP_Handle handle, Memory_Stats *stats);
Bool	HeapMultiBufMP_isBlocking// Returns whether the heap may block during an `alloc()` or `free()`(HeapMultiBufMP_Handle handle);
Functions common to all target instances
	HeapMultiBufMP_handle// Convert this instance structure pointer into an instance handle, HeapMultiBufMP_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, HeapMultiBufMP_Handle_label// The label associated with this instance object, HeapMultiBufMP_Handle_name// The name of this instance object, HeapMultiBufMP_Handle_upCast// unconditionally move one level up the inheritance hierarchy, HeapMultiBufMP_Object_count// The number of statically-created instance objects, HeapMultiBufMP_Object_first// The handle of the first dynamically-created instance object, or NULL, HeapMultiBufMP_Object_get// The handle of the i-th statically-created instance object (array == NULL), HeapMultiBufMP_Object_heap// The heap used to allocate dynamically-created instance objects, HeapMultiBufMP_Object_next// The handle of the next dynamically-created instance object, or NULL, HeapMultiBufMP_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	HeapMultiBufMP_Module_getMask// Returns the diagnostics mask for this module, HeapMultiBufMP_Module_hasMask// Test whether this module has a diagnostics mask, HeapMultiBufMP_Module_heap// The heap from which this module allocates memory, HeapMultiBufMP_Module_id// Get this module's unique id, HeapMultiBufMP_Module_setMask// Set the diagnostics mask for this module, HeapMultiBufMP_Module_startupDone// Test if this module has completed startup
Typedefs
typedef struct	HeapMultiBufMP_Bucket// Structure for bucket configuration ...
typedef struct	HeapMultiBufMP_ExtendedStats// Stats structure for the getExtendedStats API ...
typedef HeapMultiBufMP_Object *	HeapMultiBufMP_Handle// Client reference to an instance object;
typedef struct	HeapMultiBufMP_Object// Opaque internal representation of an instance object HeapMultiBufMP_Object;
typedef struct	HeapMultiBufMP_Params// Instance config-params structure ...
typedef struct	HeapMultiBufMP_Struct// Opaque client structure large enough to hold an instance object HeapMultiBufMP_Struct;
Constants
extern const Assert_Id	HeapMultiBufMP_A_addrNotFound// Assert raised when an invalid block address was passed to free();
extern const Assert_Id	HeapMultiBufMP_A_invalidAlign// Assert raised when the align parameter is not a power of 2;
extern const Assert_Id	HeapMultiBufMP_A_sizeNotFound// Assert raised when an invalid buffer size was passed to free();
extern const Error_Id	HeapMultiBufMP_E_exactFail// Error raised when exact matching failed;
extern const Error_Id	HeapMultiBufMP_E_noBlocksLeft// Error raised when there are no blocks left in the buffer corresponding to the requested size/alignment;
extern const Error_Id	HeapMultiBufMP_E_size// Error raised when requested size exceeds all blockSizes;
extern const UInt	HeapMultiBufMP_maxNameLen// Maximum length for heap names;
extern const Bool	HeapMultiBufMP_trackMaxAllocs// Track the maximum number of allocated blocks;

DETAILS

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/HeapMultiBufMP.h>

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

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

It is important to note that max allocation tracking is disabled by default in trackMaxAllocs. Disabling allocation tracking improves alloc/ free performance especially when cache calls are required in shared memory.

struct HeapMultiBufMP_Bucket