RTEMS GNU Tools On-Line Library

Functions

2.2: Function Descriptions

These are the details on the functions that make up the mmalloc package.

void *mmalloc_attach (int fd, void *baseaddr);

Initialize access to a mmalloc managed region.

If fd is a valid file descriptor for an open file, then data for the mmalloc managed region is mapped to that file. Otherwise `/dev/zero' is used and the data will not exist in any filesystem object.

If the open file corresponding to fd is from a previous use of mmalloc and passes some basic sanity checks to ensure that it is compatible with the current mmalloc package, then its data is mapped in and is immediately accessible at the same addresses in the current process as the process that created the file.

If baseaddr is not NULL, the mapping is established starting at the specified address in the process address space. If baseaddr is NULL, the mmalloc package chooses a suitable address at which to start the mapped region, which will be the value of the previous mapping if opening an existing file which was previously built by mmalloc, or for new files will be a value chosen by mmap.

Specifying baseaddr provides more control over where the regions start and how big they can be before bumping into existing mapped regions or future mapped regions.

On success, returns a malloc descriptor which is used in subsequent calls to other mmalloc package functions. It is explicitly `void *' (`char *' for systems that don't fully support void) so that users of the package don't have to worry about the actual implementation details.

On failure returns NULL.

void *mmalloc_detach (void *md);

Terminate access to a mmalloc managed region identified by the descriptor md, by closing the base file and unmapping all memory pages associated with the region.

Returns NULL on success.

Returns the malloc descriptor on failure, which can subsequently be used for further action (such as obtaining more information about the nature of the failure).

void *mmalloc (void *md, size_t size);

Given an mmalloc descriptor md, allocate additional memory of size bytes in the associated mapped region.

*mrealloc (void *md, void *ptr, size_t size);

Given an mmalloc descriptor md and a pointer to memory previously allocated by mmalloc in ptr, reallocate the memory to be size bytes long, possibly moving the existing contents of memory if necessary.

void *mvalloc (void *md, size_t size);

Like mmalloc but the resulting memory is aligned on a page boundary.

void mfree (void *md, void *ptr);

Given an mmalloc descriptor md and a pointer to memory previously allocated by mmalloc in ptr, free the previously allocated memory.

int mmalloc_errno (void *md);

Given a mmalloc descriptor, if the last mmalloc operation failed for some reason due to a system call failure, then returns the associated errno. Returns 0 otherwise. (This function is not yet implemented).