Relocatable Memory Management Routines

Collaboration diagram for Relocatable Memory Management Routines:

Typedefs
typedef struct apr_rmm_t	apr_rmm_t
typedef apr_size_t	apr_rmm_off_t
Functions
	APU_DECLARE (apr_status_t) apr_rmm_init(apr_rmm_t **rmm
	APU_DECLARE (apr_rmm_off_t) apr_rmm_malloc(apr_rmm_t *rmm
	APU_DECLARE (void *) apr_rmm_addr_get(apr_rmm_t *rmm
Variables
apr_anylock_t *	lock
apr_anylock_t void *	membuf
apr_anylock_t void apr_size_t	memsize
apr_anylock_t void apr_size_t apr_pool_t *	cont
apr_size_t	reqsize
void *	entity

---

Typedef Documentation

typedef apr_size_t apr_rmm_off_t

Fundamental allocation unit, within a specific apr_rmm_t

Definition at line 43 of file apr_rmm.h.

typedef struct apr_rmm_t apr_rmm_t

Structure to access Relocatable, Managed Memory

Definition at line 40 of file apr_rmm.h.

---

Function Documentation

APU_DECLARE

(

apr_status_t

)

Initialize a relocatable memory block to be managed by the apr_rmm API.

Parameters:

rmm	The relocatable memory block
lock	An apr_anylock_t of the appropriate type of lock, or NULL if no locking is required.
membuf	The block of relocatable memory to be managed
memsize	The size of relocatable memory block to be managed
cont	The pool to use for local storage and management

Remarks:

Both

Parameters:

membuf	and
memsize	must be aligned (for instance using APR_ALIGN_DEFAULT).

Destroy a managed memory block.

Parameters:

rmm	The relocatable memory block to destroy

Attach to a relocatable memory block already managed by the apr_rmm API.

Parameters:

rmm	The relocatable memory block
lock	An apr_anylock_t of the appropriate type of lock
membuf	The block of relocatable memory already under management
cont	The pool to use for local storage and management

Detach from the managed block of memory.

Parameters:

rmm	The relocatable memory block to detach from

Free allocation returned by apr_rmm_malloc or apr_rmm_calloc.

Parameters:

rmm	The relocatable memory block
entity	The memory allocation to free

APU_DECLARE

(

apr_rmm_off_t

)

Allocate memory from the block of relocatable memory.

Parameters:

rmm	The relocatable memory block
reqsize	How much memory to allocate

Realloc memory from the block of relocatable memory.

Parameters:

rmm	The relocatable memory block
entity	The memory allocation to realloc
reqsize	The new size

Allocate memory from the block of relocatable memory and initialize it to zero.

Parameters:

rmm	The relocatable memory block
reqsize	How much memory to allocate

Compute the offset of a relocatable allocation of memory

Parameters:

rmm	The relocatable memory block
entity	The physical address to convert to an offset

Compute the required overallocation of memory needed to fit n allocs

Parameters:

n	The number of alloc/calloc regions desired

APU_DECLARE

(

void *

)

Retrieve the physical address of a relocatable allocation of memory

Parameters:

rmm	The relocatable memory block
entity	The memory allocation to free

Returns:

address The address, aligned with APR_ALIGN_DEFAULT.

---

Variable Documentation

apr_anylock_t void apr_pool_t* cont

Definition at line 56 of file apr_rmm.h.

void * entity

Definition at line 95 of file apr_rmm.h.

apr_anylock_t * lock

Definition at line 56 of file apr_rmm.h.

apr_anylock_t void * membuf

Definition at line 56 of file apr_rmm.h.

apr_anylock_t void apr_size_t memsize

Definition at line 56 of file apr_rmm.h.

apr_size_t reqsize

Definition at line 87 of file apr_rmm.h.