Region Manager

The Region Manager provides facilities to dynamically allocate memory in variable sized units. More...

Files
file	region.h
	This header file defines the Region Manager API.

Functions
rtems_status_code	rtems_region_create (rtems_name name, void *starting_address, uintptr_t length, uintptr_t page_size, rtems_attribute attribute_set, rtems_id *id)
	% More...
rtems_status_code	rtems_region_delete (rtems_id id)
	% More...
rtems_status_code	rtems_region_extend (rtems_id id, void *starting_address, uintptr_t length)
	% More...
rtems_status_code	rtems_region_get_free_information (rtems_id id, Heap_Information_block *the_info)
	% More...
rtems_status_code	rtems_region_get_information (rtems_id id, Heap_Information_block *the_info)
	% More...
rtems_status_code	rtems_region_get_segment (rtems_id id, uintptr_t size, rtems_option option_set, rtems_interval timeout, void **segment)
	% More...
rtems_status_code	rtems_region_get_segment_size (rtems_id id, void *segment, uintptr_t *size)
	% More...
rtems_status_code	rtems_region_ident (rtems_name name, rtems_id *id)
	Identifies a region object by the specified object name. More...
rtems_status_code	rtems_region_resize_segment (rtems_id id, void *segment, uintptr_t size, uintptr_t *old_size)
	% More...
rtems_status_code	rtems_region_return_segment (rtems_id id, void *segment)
	% More...

Detailed Description

The Region Manager provides facilities to dynamically allocate memory in variable sized units.

Function Documentation

rtems_region_create()

rtems_status_code rtems_region_create	(	rtems_name	name,
		void *	starting_address,
		uintptr_t	length,
		uintptr_t	page_size,
		rtems_attribute	attribute_set,
		rtems_id *	id
	)

%

Parameters

name	%
starting_address	%
length	%
page_size	%
attribute_set	%
id	%

rtems_region_delete()

rtems_status_code rtems_region_delete

(

rtems_id

id

)

%

Parameters

id

%

rtems_region_extend()

rtems_status_code rtems_region_extend	(	rtems_id	id,
		void *	starting_address,
		uintptr_t	length
	)

%

Parameters

id	%
starting_address	%
length	%

rtems_region_get_free_information()

rtems_status_code rtems_region_get_free_information	(	rtems_id	id,
		Heap_Information_block *	the_info
	)

%

Parameters

id	%
the_info	%

rtems_region_get_information()

rtems_status_code rtems_region_get_information	(	rtems_id	id,
		Heap_Information_block *	the_info
	)

%

Parameters

id	%
the_info	%

rtems_region_get_segment()

rtems_status_code rtems_region_get_segment	(	rtems_id	id,
		uintptr_t	size,
		rtems_option	option_set,
		rtems_interval	timeout,
		void **	segment
	)

%

Parameters

id	%
size	%
option_set	%
timeout	%
segment	%

rtems_region_get_segment_size()

rtems_status_code rtems_region_get_segment_size	(	rtems_id	id,
		void *	segment,
		uintptr_t *	size
	)

%

Parameters

id	%
segment	%
size	%

rtems_region_ident()

rtems_status_code rtems_region_ident	(	rtems_name	name,
		rtems_id *	id
	)

Identifies a region object by the specified object name.

This directive obtains the region identifier associated with the region name specified in name.

If the region name is not unique, then the region identifier will match the first region with that name in the search order. However, this region identifier is not guaranteed to correspond to the desired region. The region identifier is used with other region related directives to access the region.

The objects are searched from lowest to the highest index. Only the local node is searched.

Parameters

	name	is the object name to look up.
[out]	id	is the pointer to an object identifier variable. The object identifier of an object with the specified name will be stored in this variable, in case of a successful operation.

Return values

RTEMS_SUCCESSFUL	The requested operation was successful.
RTEMS_INVALID_ADDRESS	The id parameter was NULL.
RTEMS_INVALID_NAME	The name parameter was 0.
RTEMS_INVALID_NAME	There was no object with the specified name on the local node.

rtems_region_resize_segment()

rtems_status_code rtems_region_resize_segment	(	rtems_id	id,
		void *	segment,
		uintptr_t	size,
		uintptr_t *	old_size
	)

%

Parameters

id	%
segment	%
size	%
old_size	%

rtems_region_return_segment()

rtems_status_code rtems_region_return_segment	(	rtems_id	id,
		void *	segment
	)

%

Parameters

id	%
segment	%