Managed memory allocator

Collaboration diagram for Managed memory allocator:

Files
file	mmem.c
file	mmem.h

Macros
#define	MMEM_PTR(m)
	Get a pointer to the managed memory. More...

Functions
int	mmem_alloc (struct mmem *m, unsigned int size)
	Allocate a managed memory block. More...
void	mmem_free (struct mmem *m)
	Deallocate a managed memory block. More...
void	mmem_init (void)
	Initialize the managed memory module. More...

Detailed Description

The managed memory allocator is a fragmentation-free memory manager. It keeps the allocated memory free from fragmentation by compacting the memory when blocks are freed. A program that uses the managed memory module cannot be sure that allocated memory stays in place. Therefore, a level of indirection is used: access to allocated memory must always be done using a special macro.

Note

This module has not been heavily tested.

Macro Definition Documentation

#define MMEM_PTR

(

m

)

Get a pointer to the managed memory.

Parameters

m	A pointer to the struct mmem

Returns

A pointer to the memory block, or NULL if memory could not be allocated.

Author

Adam Dunkels

        This macro is used to get a pointer to a memory block
        allocated with mmem_alloc().

Definition at line 75 of file mmem.h.

Function Documentation

int mmem_alloc	(	struct mmem *	m,
		unsigned int	size
	)

Allocate a managed memory block.

Parameters

m	A pointer to a struct mmem.
size	The size of the requested memory block

Returns

Non-zero if the memory could be allocated, zero if memory was not available.

Author

Adam Dunkels

        This function allocates a chunk of managed memory. The
        memory allocated with this function must be deallocated
        using the mmem_free() function.

        \note This function does NOT return a pointer to the
        allocated memory, but a pointer to a structure that
        contains information about the managed memory. The
        macro MMEM_PTR() is used to get a pointer to the
        allocated memory.

Definition at line 83 of file mmem.c.

References list_add().

void mmem_free

(

struct mmem *

m

)

Deallocate a managed memory block.

Parameters

m	A pointer to the managed memory block

Author

Adam Dunkels

        This function deallocates a managed memory block that
        previously has been allocated with mmem_alloc().

Definition at line 119 of file mmem.c.

References list_remove().

void mmem_init

(

void

)

Initialize the managed memory module.

Author

Adam Dunkels

        This function initializes the managed memory module and
        should be called before any other function from the
        module.

Definition at line 152 of file mmem.c.

References list_init().