rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-02 10:20:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Clarify rtems_heap_extend()

Browse Source 
Update #1747.
This commit is contained in:
Sebastian Huber 2017-01-27 08:06:56 +01:00
parent dc3ef53711
commit 9889463c23
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
c-user/region_manager.rst
View File

@ -154,12 +154,6 @@ The ``rtems_region_extend`` directive may be used to add memory to an existing
region. The caller specifies the size in bytes and starting address of the
memory being added.
.. note::
Please see the release notes or RTEMS source code for information regarding
restrictions on the location of the memory being added in relation to memory
already in the region.
Acquiring a Segment
-------------------
@ -417,15 +411,23 @@ DIRECTIVE STATUS CODES:
- invalid address of area to add
DESCRIPTION:
This directive adds the memory which starts at starting_address for length
bytes to the region specified by id.
This directive adds the memory area which starts at
:c:data:`starting_address` for :c:data:`length` bytes to the region
specified by :c:data:`id`.
There are no alignment requirements for the memory area. The memory area
must be big enough to contain some maintenance blocks. It must not overlap
parts of the current heap memory areas. Disconnected memory areas added to
the heap will lead to used blocks which cover the gaps. Extending with an
inappropriate memory area will corrupt the heap resulting in undefined
behaviour.
NOTES:
This directive will obtain the allocator mutex and may cause the calling
task to be preempted.
The calling task does not have to be the task that created the region. Any
local task that knows the region id can extend the region.
local task that knows the region identifier can extend the region.
.. raw:: latex