RTEMS  5.0.0
Macros | Functions
rtl-allocator.c File Reference

RTEMS Run-Time Linker Allocator. More...

#include <stdio.h>
#include <string.h>
#include <rtems/rtl/rtl.h>
#include "rtl-alloc-heap.h"
#include <rtems/rtl/rtl-trace.h>

Macros

#define rtems_rtl_trace_tag_label(_l)   ""
 

Functions

void rtems_rtl_alloc_initialise (rtems_rtl_alloc_data *data)
 
void * rtems_rtl_alloc_new (rtems_rtl_alloc_tag tag, size_t size, bool zero)
 
void rtems_rtl_alloc_del (rtems_rtl_alloc_tag tag, void *address)
 
void rtems_rtl_alloc_wr_enable (rtems_rtl_alloc_tag tag, void *address)
 
void rtems_rtl_alloc_lock (void)
 
void rtems_rtl_alloc_unlock (void)
 
void rtems_rtl_alloc_wr_disable (rtems_rtl_alloc_tag tag, void *address)
 
rtems_rtl_allocator rtems_rtl_alloc_hook (rtems_rtl_allocator handler)
 
void rtems_rtl_alloc_indirect_new (rtems_rtl_alloc_tag tag, rtems_rtl_ptr *handle, size_t size)
 
void rtems_rtl_alloc_indirect_del (rtems_rtl_alloc_tag tag, rtems_rtl_ptr *handle)
 
rtems_rtl_alloc_tag rtems_rtl_alloc_text_tag (void)
 
rtems_rtl_alloc_tag rtems_rtl_alloc_const_tag (void)
 
rtems_rtl_alloc_tag rtems_rtl_alloc_eh_tag (void)
 
rtems_rtl_alloc_tag rtems_rtl_alloc_data_tag (void)
 
rtems_rtl_alloc_tag rtems_rtl_alloc_bss_tag (void)
 
bool rtems_rtl_alloc_module_new (void **text_base, size_t text_size, void **const_base, size_t const_size, void **eh_base, size_t eh_size, void **data_base, size_t data_size, void **bss_base, size_t bss_size)
 
void rtems_rtl_alloc_module_del (void **text_base, void **const_base, void **eh_base, void **data_base, void **bss_base)
 

Detailed Description

RTEMS Run-Time Linker Allocator.

Macro Definition Documentation

◆ rtems_rtl_trace_tag_label

#define rtems_rtl_trace_tag_label (   _l)    ""

Tags as symbols for tracing.

Function Documentation

◆ rtems_rtl_alloc_bss_tag()

rtems_rtl_alloc_tag rtems_rtl_alloc_bss_tag ( void  )

Return the default tag for bss sections.

Returns
The bss tag.

◆ rtems_rtl_alloc_const_tag()

rtems_rtl_alloc_tag rtems_rtl_alloc_const_tag ( void  )

Return the default tag for const sections.

Returns
The const tag.

◆ rtems_rtl_alloc_data_tag()

rtems_rtl_alloc_tag rtems_rtl_alloc_data_tag ( void  )

Return the default tag for data sections.

Returns
The data tag.

◆ rtems_rtl_alloc_del()

void rtems_rtl_alloc_del ( rtems_rtl_alloc_tag  tag,
void *  address 
)

The Runtime Loader allocator delete deletes allocated memory.

Parameters
tagThe type of allocation request.
addressThe memory address to delete. A NULL is ignored.

◆ rtems_rtl_alloc_eh_tag()

rtems_rtl_alloc_tag rtems_rtl_alloc_eh_tag ( void  )

Return the default tag for exception sections.

Returns
The eh tag.

◆ rtems_rtl_alloc_hook()

rtems_rtl_allocator rtems_rtl_alloc_hook ( rtems_rtl_allocator  handler)

Hook the Runtime Loader allocatior. A handler can call the previous handler in the chain to use it for specific tags. The default handler uses the system heap. Do not unhook your handler if memory it allocates has not been returned.

Parameters
handlerThe handler to use as the allocator.
Returns
rtems_rtl_alloc_handler The previous handler.

◆ rtems_rtl_alloc_indirect_del()

void rtems_rtl_alloc_indirect_del ( rtems_rtl_alloc_tag  tag,
rtems_rtl_ptr handle 
)

Free memory from an indirect handle.

Parameters
tagThe type of allocation request.
handleThe handle to free the memory from.

◆ rtems_rtl_alloc_indirect_new()

void rtems_rtl_alloc_indirect_new ( rtems_rtl_alloc_tag  tag,
rtems_rtl_ptr handle,
size_t  size 
)

Allocate memory to an indirect handle.

Parameters
tagThe type of allocation request.
handleThe handle to allocate the memory to.
sizeThe size of the allocation.

◆ rtems_rtl_alloc_initialise()

void rtems_rtl_alloc_initialise ( rtems_rtl_alloc_data data)

Initialise the allocate data.

Parameters
dataThe data to initialise.

◆ rtems_rtl_alloc_lock()

void rtems_rtl_alloc_lock ( void  )

The Runtime Loader allocator lock. An allocator that depends on a separate allocation process, for example the heap, may need to be locked during loading of an object file to make sure the locality of the memory. This call be used to lock such an allocator. Allocator calls in this interface are protected by the RTL lock.

◆ rtems_rtl_alloc_module_del()

void rtems_rtl_alloc_module_del ( void **  text_base,
void **  const_base,
void **  eh_base,
void **  data_base,
void **  bss_base 
)

Free the memory allocated to a module.

Parameters
text_basePointer to the text base pointer.
const_basePointer to the const base pointer.
eh_basePointer to the eh base pointer.
data_basePointer to the data base pointer.
bss_basePointer to the bss base pointer.

◆ rtems_rtl_alloc_module_new()

bool rtems_rtl_alloc_module_new ( void **  text_base,
size_t  text_size,
void **  const_base,
size_t  const_size,
void **  eh_base,
size_t  eh_size,
void **  data_base,
size_t  data_size,
void **  bss_base,
size_t  bss_size 
)

Allocate the memory for a module given the size of the text, const, data and bss sections. If any part of the allocation fails the no memory is allocated.

Parameters
text_basePointer to the text base pointer.
text_sizeThe size of the read/exec section.
const_basePointer to the const base pointer.
const_sizeThe size of the read only section.
eh_basePointer to the eh base pointer.
eh_sizeThe size of the eh section.
data_basePointer to the data base pointer.
data_sizeThe size of the read/write secton.
bss_basePointer to the bss base pointer.
bss_sizeThe size of the read/write.
Return values
trueThe memory has been allocated.
falseThe allocation of memory has failed.

◆ rtems_rtl_alloc_new()

void* rtems_rtl_alloc_new ( rtems_rtl_alloc_tag  tag,
size_t  size,
bool  zero 
)

The Runtime Loader allocator new allocates new memory and optionally clear the memory if requested.

Parameters
tagThe type of allocation request.
sizeThe size of the allocation.
zeroIf true the memory is cleared.
Returns
void* The memory address or NULL is not memory available.

◆ rtems_rtl_alloc_text_tag()

rtems_rtl_alloc_tag rtems_rtl_alloc_text_tag ( void  )

Return the default tag for text sections.

Returns
The text tag.

◆ rtems_rtl_alloc_unlock()

void rtems_rtl_alloc_unlock ( void  )

The Runtime Loader allocator unlock. An allocator that depends on a separate allocation process, for example the heap, may need to be locked during loading of an object file to make sure the locality of the memory. This call can be used to unlock such an allocator. Allocator calls in this interface are protected by the RTL lock.

◆ rtems_rtl_alloc_wr_disable()

void rtems_rtl_alloc_wr_disable ( rtems_rtl_alloc_tag  tag,
void *  address 
)

The Runtime Loader allocator disable write on a bloc of allocated memory.

Parameters
tagThe type of allocation request. Must match the address.
addressThe memory address to write disable. A NULL is ignored.

◆ rtems_rtl_alloc_wr_enable()

void rtems_rtl_alloc_wr_enable ( rtems_rtl_alloc_tag  tag,
void *  address 
)

The Runtime Loader allocator enable write on a bloc of allocated memory.

Parameters
tagThe type of allocation request. Must match the address.
addressThe memory address to write enable. A NULL is ignored.