Detailed Description

Core Memory Manager related APIs and services.

Operation mode

The core memory manager is a simplified allocator that only allows to allocate memory blocks without the possibility to free them.
This allocator is meant as a memory blocks provider for the other allocators such as:

C-Runtime allocator (through a compiler specific adapter module).
Heap allocator (see Memory Heaps).
Memory pools allocator (see Memory Pools).

By having a centralized memory provider the various allocators can coexist and share the main memory.
This allocator, alone, is also useful for very simple applications that just require a simple way to get memory blocks.

Precondition: In order to use the core memory manager APIs the CH_CFG_USE_MEMCORE option must be enabled in chconf.h.

Note: Compatible with RT and NIL.

Collaboration diagram for Core Memory Manager:

Data Structures
struct	memcore_t
	Type of memory core object. More...

Macros
#define	CH_CFG_MEMCORE_SIZE 0
	Managed RAM size.
#define	chCoreAllocAlignedWithOffsetI chCoreAllocFromTopI
	Allocates a memory block.
#define	chCoreAllocAlignedWithOffset chCoreAllocFromTop
	Allocates a memory block.

Typedefs
typedef void (	memgetfunc_t) (size_t size, unsigned align)
	Memory get function.
typedef void (	memgetfunc2_t) (size_t size, unsigned align, size_t offset)
	Enhanced memory get function.

Functions
void	__core_init (void)
	Low level memory manager initialization.
void *	chCoreAllocFromBaseI (size_t size, unsigned align, size_t offset)
	Allocates a memory block starting from the lowest address upward.
void *	chCoreAllocFromTopI (size_t size, unsigned align, size_t offset)
	Allocates a memory block starting from the top address downward.
void *	chCoreAllocFromBase (size_t size, unsigned align, size_t offset)
	Allocates a memory block starting from the lowest address upward.
void *	chCoreAllocFromTop (size_t size, unsigned align, size_t offset)
	Allocates a memory block starting from the top address downward.
size_t	chCoreGetStatusX (void)
	Core memory status.
static void *	chCoreAllocAlignedI (size_t size, unsigned align)
	Allocates a memory block.
static void *	chCoreAllocAligned (size_t size, unsigned align)
	Allocates a memory block.
static void *	chCoreAllocI (size_t size)
	Allocates a memory block.
static void *	chCoreAlloc (size_t size)
	Allocates a memory block.

Variables
memcore_t	ch_memcore
	Memory core descriptor.

Macro Definition Documentation

◆ CH_CFG_MEMCORE_SIZE

#define CH_CFG_MEMCORE_SIZE 0

Managed RAM size.

Size of the RAM area to be managed by the OS. If set to zero then the whole available RAM is used. The core memory is made available to the heap allocator and/or can be used directly through the simplified core memory allocator.

Note: In order to let the OS manage the whole RAM the linker script must provide the __heap_base__ and __heap_end__ symbols.; Requires CH_CFG_USE_MEMCORE.

Definition at line 52 of file chmemcore.h.

◆ chCoreAllocAlignedWithOffsetI

#define chCoreAllocAlignedWithOffsetI chCoreAllocFromTopI

Allocates a memory block.

Note: This is a generic form with unspecified allocation position.

Function Class:: This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers.

Definition at line 101 of file chmemcore.h.

Referenced by chCoreAllocAlignedI(), and chCoreAllocI().

◆ chCoreAllocAlignedWithOffset

#define chCoreAllocAlignedWithOffset chCoreAllocFromTop

Allocates a memory block.

Note: This is a generic form with unspecified allocation position.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 109 of file chmemcore.h.

Referenced by __heap_init(), chCoreAlloc(), and chCoreAllocAligned().

Typedef Documentation

◆ memgetfunc_t

typedef void *(* memgetfunc_t) (size_t size, unsigned align)

Memory get function.

Definition at line 70 of file chmemcore.h.

◆ memgetfunc2_t

typedef void *(* memgetfunc2_t) (size_t size, unsigned align, size_t offset)

Enhanced memory get function.

Definition at line 75 of file chmemcore.h.

Function Documentation

◆ __core_init()

void __core_init ( void )

Low level memory manager initialization.

Function Class:: Not an API, this function is for internal use only.

Definition at line 80 of file chmemcore.c.

References CH_CFG_MEMCORE_SIZE, and ch_memcore.

Referenced by __oslib_init().

◆ chCoreAllocFromBaseI()

void * chCoreAllocFromBaseI	(	size_t	size,
		unsigned	align,
		size_t	offset )

Allocates a memory block starting from the lowest address upward.

This function allocates a block of offset + size bytes. The returned pointer has offset bytes before its address and size bytes after.

Parameters

[in]	size	the size of the block to be allocated.
[in]	align	desired memory alignment
[in]	offset	aligned pointer offset

Returns: A pointer to the allocated memory block.

Return values

NULL	allocation failed, core memory exhausted.

Function Class:: This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers.

Definition at line 111 of file chmemcore.c.

References ch_memcore, chDbgCheck, chDbgCheckClassI, MEM_ALIGN_NEXT, and MEM_IS_VALID_ALIGNMENT.

Referenced by chCoreAllocFromBase().

◆ chCoreAllocFromTopI()

void * chCoreAllocFromTopI	(	size_t	size,
		unsigned	align,
		size_t	offset )

Allocates a memory block starting from the top address downward.

This function allocates a block of offset + size bytes. The returned pointer has offset bytes before its address and size bytes after.

Parameters

[in]	size	the size of the block to be allocated.
[in]	align	desired memory alignment
[in]	offset	aligned pointer offset

Returns: A pointer to the allocated memory block.

Return values

NULL	allocation failed, core memory exhausted.

Function Class:: This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers.

Definition at line 159 of file chmemcore.c.

References ch_memcore, chDbgCheck, chDbgCheckClassI, MEM_ALIGN_PREV, and MEM_IS_VALID_ALIGNMENT.

Referenced by chCoreAllocFromTop().

◆ chCoreAllocFromBase()

void * chCoreAllocFromBase	(	size_t	size,
		unsigned	align,
		size_t	offset )

Allocates a memory block starting from the lowest address upward.

This function allocates a block of offset + size bytes. The returned pointer has offset bytes before its address and size bytes after.

Parameters

[in]	size	the size of the block to be allocated.
[in]	align	desired memory alignment
[in]	offset	aligned pointer offset

Returns: A pointer to the allocated memory block.

Return values

NULL	allocation failed, core memory exhausted.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 207 of file chmemcore.c.

References chCoreAllocFromBaseI(), chSysLock(), and chSysUnlock().

Here is the call graph for this function:

◆ chCoreAllocFromTop()

void * chCoreAllocFromTop	(	size_t	size,
		unsigned	align,
		size_t	offset )

Allocates a memory block starting from the top address downward.

This function allocates a block of offset + size bytes. The returned pointer has offset bytes before its address and size bytes after.

Parameters

[in]	size	the size of the block to be allocated.
[in]	align	desired memory alignment
[in]	offset	aligned pointer offset

Returns: A pointer to the allocated memory block.

Return values

NULL	allocation failed, core memory exhausted.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 231 of file chmemcore.c.

References chCoreAllocFromTopI(), chSysLock(), and chSysUnlock().

Here is the call graph for this function:

◆ chCoreGetStatusX()

size_t chCoreGetStatusX ( void )

Core memory status.

Returns: The size, in bytes, of the free core memory.

Function Class:: This is an X-Class API, this function can be invoked from any context.

Definition at line 248 of file chmemcore.c.

References ch_memcore.

◆ chCoreAllocAlignedI()

void * chCoreAllocAlignedI	(	size_t	size,
		unsigned	align )

inlinestatic

Allocates a memory block.

The allocated block is guaranteed to be properly aligned to the specified alignment.

Note: This is a generic form with unspecified allocation position.

Parameters

[in]	size	the size of the block to be allocated.
[in]	align	desired memory alignment

Returns: A pointer to the allocated memory block.

Return values

NULL	allocation failed, core memory exhausted.

Function Class:: This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers.

Definition at line 149 of file chmemcore.h.

References chCoreAllocAlignedWithOffsetI.

Referenced by __factory_init().

◆ chCoreAllocAligned()

void * chCoreAllocAligned	(	size_t	size,
		unsigned	align )

inlinestatic

Allocates a memory block.

The allocated block is guaranteed to be properly aligned to the specified alignment.

Note: This is a generic form with unspecified allocation position.

Parameters

[in]	size	the size of the block to be allocated
[in]	align	desired memory alignment

Returns: A pointer to the allocated memory block.

Return values

NULL	allocation failed, core memory exhausted.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 167 of file chmemcore.h.

References chCoreAllocAlignedWithOffset.

◆ chCoreAllocI()

void * chCoreAllocI ( size_t size )

inlinestatic

Allocates a memory block.

The allocated block is guaranteed to be properly aligned for a pointer data type.

Note: This is a generic form with unspecified allocation position.

Parameters

[in] size the size of the block to be allocated.

Returns: A pointer to the allocated memory block.

Return values

NULL	allocation failed, core memory exhausted.

Function Class:: This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers.

Definition at line 184 of file chmemcore.h.

References chCoreAllocAlignedWithOffsetI.

◆ chCoreAlloc()

void * chCoreAlloc ( size_t size )

inlinestatic

Allocates a memory block.

The allocated block is guaranteed to be properly aligned for a pointer data type.

Note: This is a generic form with unspecified allocation position.

Parameters

[in] size the size of the block to be allocated.

Returns: A pointer to the allocated memory block.

Return values

NULL	allocation failed, core memory exhausted.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 201 of file chmemcore.h.

References chCoreAllocAlignedWithOffset.

Variable Documentation

◆ ch_memcore

memcore_t ch_memcore

Memory core descriptor.

Definition at line 57 of file chmemcore.c.

Referenced by __core_init(), chCoreAllocFromBaseI(), chCoreAllocFromTopI(), and chCoreGetStatusX().

Detailed Description

Operation mode

Data Structures

Macros

Typedefs

Functions

Variables

Macro Definition Documentation

◆ CH_CFG_MEMCORE_SIZE

◆ chCoreAllocAlignedWithOffsetI

◆ chCoreAllocAlignedWithOffset

Typedef Documentation

◆ memgetfunc_t

◆ memgetfunc2_t

Function Documentation

◆ __core_init()

◆ chCoreAllocFromBaseI()

◆ chCoreAllocFromTopI()

◆ chCoreAllocFromBase()

◆ chCoreAllocFromTop()

◆ chCoreGetStatusX()

◆ chCoreAllocAlignedI()

◆ chCoreAllocAligned()

◆ chCoreAllocI()

◆ chCoreAlloc()

Variable Documentation

◆ ch_memcore