ACE_Allocator Class Reference

Interface for a dynamic memory allocator that uses inheritance and dynamic binding to provide extensible mechanisms for allocating and deallocating memory. More...

#include <Malloc_Base.h>

Inheritance diagram for ACE_Allocator:

Collaboration diagram for ACE_Allocator:

Public Types
typedef size_t	size_type
	Unsigned integer type used for specifying memory block lengths.

Public Member Functions
	ACE_Allocator ()
	"No-op" constructor (needed to make certain compilers happy).
virtual	~ACE_Allocator ()
	Virtual destructor.
virtual void *	malloc (size_type nbytes)=0
	Allocate nbytes, but don't give them any initial value.
virtual void *	calloc (size_type nbytes, char initial_value='\0')=0
	Allocate nbytes, giving them initial_value.
virtual void *	calloc (size_type n_elem, size_type elem_size, char initial_value='\0')=0
virtual void	free (void *ptr)=0
	Free ptr (must have been allocated by ACE_Allocator::malloc()).
virtual int	remove ()=0
	Remove any resources associated with this memory manager.
virtual int	bind (const char *name, void *pointer, int duplicates=0)=0
virtual int	trybind (const char *name, void *&pointer)=0
virtual int	find (const char *name, void *&pointer)=0
virtual int	find (const char *name)=0
	Returns 0 if the name is in the mapping. -1, otherwise.
virtual int	unbind (const char *name)=0
virtual int	unbind (const char *name, void *&pointer)=0
virtual int	sync (ssize_t len=-1, int flags=MS_SYNC)=0
virtual int	sync (void *addr, size_type len, int flags=MS_SYNC)=0
virtual int	protect (ssize_t len=-1, int prot=PROT_RDWR)=0
virtual int	protect (void *addr, size_type len, int prot=PROT_RDWR)=0
virtual void	dump () const =0
	Dump the state of the object.

Static Public Member Functions
static ACE_Allocator *	instance ()
	Get pointer to a default ACE_Allocator.
static ACE_Allocator *	instance (ACE_Allocator *)
static void	close_singleton ()
	Delete the dynamically allocated Singleton.

Static Private Attributes
static ACE_Allocator *	allocator_ = 0
	Pointer to a process-wide ACE_Allocator instance.

Detailed Description

Interface for a dynamic memory allocator that uses inheritance and dynamic binding to provide extensible mechanisms for allocating and deallocating memory.

Member Typedef Documentation

size_type

typedef size_t ACE_Allocator::size_type

Unsigned integer type used for specifying memory block lengths.

Constructor & Destructor Documentation

ACE_Allocator()

ACE_Allocator::ACE_Allocator

(

)

"No-op" constructor (needed to make certain compilers happy).

~ACE_Allocator()

ACE_Allocator::~ACE_Allocator ( )

virtual

Virtual destructor.

Member Function Documentation

bind()

virtual int ACE_Allocator::bind ( const char * name, void * pointer, int duplicates = 0 )

pure virtual

Associate name with pointer. If duplicates == 0 then do not allow duplicate name/pointer associations, else if duplicates != 0 then allow duplicate name/pointer associations. Returns 0 if successfully binds (1) a previously unbound name or (2) duplicates != 0, returns 1 if trying to bind a previously bound name and duplicates == 0, else returns -1 if a resource failure occurs.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

calloc() [1/2]

virtual void * ACE_Allocator::calloc ( size_type n_elem, size_type elem_size, char initial_value = '\0' )

pure virtual

Allocate n_elem each of size elem_size, giving them initial_value.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Cached_Allocator< T, ACE_LOCK >, ACE_Cached_Allocator< ACE_Node< ACE_Event_Tuple >, ACE_SYNCH_NULL_MUTEX >, ACE_Dynamic_Cached_Allocator< ACE_LOCK >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

calloc() [2/2]

virtual void * ACE_Allocator::calloc ( size_type nbytes, char initial_value = '\0' )

pure virtual

Allocate nbytes, giving them initial_value.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Cached_Allocator< T, ACE_LOCK >, ACE_Cached_Allocator< ACE_Node< ACE_Event_Tuple >, ACE_SYNCH_NULL_MUTEX >, ACE_Dynamic_Cached_Allocator< ACE_LOCK >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

close_singleton()

void ACE_Allocator::close_singleton ( )

static

Delete the dynamically allocated Singleton.

dump()

virtual void ACE_Allocator::dump ( ) const

pure virtual

Dump the state of the object.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

find() [1/2]

virtual int ACE_Allocator::find ( const char * name )

pure virtual

Returns 0 if the name is in the mapping. -1, otherwise.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

find() [2/2]

virtual int ACE_Allocator::find ( const char * name, void *& pointer )

pure virtual

Locate name and pass out parameter via pointer. If found, return 0, returns -1 if failure occurs.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

free()

virtual void ACE_Allocator::free ( void * ptr )

pure virtual

Free ptr (must have been allocated by ACE_Allocator::malloc()).

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Cached_Allocator< T, ACE_LOCK >, ACE_Cached_Allocator< ACE_Node< ACE_Event_Tuple >, ACE_SYNCH_NULL_MUTEX >, ACE_Dynamic_Cached_Allocator< ACE_LOCK >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

instance() [1/2]

ACE_Allocator * ACE_Allocator::instance ( )

static

Get pointer to a default ACE_Allocator.

instance() [2/2]

ACE_Allocator * ACE_Allocator::instance ( ACE_Allocator * r )

static

Set pointer to a process-wide ACE_Allocator and return existing pointer.

malloc()

virtual void * ACE_Allocator::malloc ( size_type nbytes )

pure virtual

Allocate nbytes, but don't give them any initial value.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Cached_Allocator< T, ACE_LOCK >, ACE_Cached_Allocator< ACE_Node< ACE_Event_Tuple >, ACE_SYNCH_NULL_MUTEX >, ACE_Dynamic_Cached_Allocator< ACE_LOCK >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

protect() [1/2]

virtual int ACE_Allocator::protect ( ssize_t len = -1, int prot = PROT_RDWR )

pure virtual

Change the protection of the pages of the mapped region to prot starting at <this->base_addr_> up to len bytes. If len == -1 then change protection of all pages in the mapped region.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

protect() [2/2]

virtual int ACE_Allocator::protect ( void * addr, size_type len, int prot = PROT_RDWR )

pure virtual

Change the protection of the pages of the mapped region to prot starting at addr up to len bytes.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

remove()

virtual int ACE_Allocator::remove ( )

pure virtual

Remove any resources associated with this memory manager.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

sync() [1/2]

virtual int ACE_Allocator::sync ( ssize_t len = -1, int flags = MS_SYNC )

pure virtual

Sync len bytes of the memory region to the backing store starting at this->base_addr_. If len == -1 then sync the whole region.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

sync() [2/2]

virtual int ACE_Allocator::sync ( void * addr, size_type len, int flags = MS_SYNC )

pure virtual

Sync len bytes of the memory region to the backing store starting at addr.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

trybind()

virtual int ACE_Allocator::trybind ( const char * name, void *& pointer )

pure virtual

Associate name with pointer. Does not allow duplicate name/pointer associations. Returns 0 if successfully binds (1) a previously unbound name, 1 if trying to bind a previously bound name, or returns -1 if a resource failure occurs. When this call returns pointer's value will always reference the void * that name is associated with. Thus, if the caller needs to use pointer (e.g., to free it) a copy must be maintained by the caller.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

unbind() [1/2]

virtual int ACE_Allocator::unbind ( const char * name )

pure virtual

Unbind (remove) the name from the map. Don't return the pointer to the caller

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

unbind() [2/2]

virtual int ACE_Allocator::unbind ( const char * name, void *& pointer )

pure virtual

Break any association of name. Returns the value of pointer in case the caller needs to deallocate memory.

Implemented in ACE_Allocator_Adapter< MALLOC >, ACE_Allocator_Adapter< ACE_Malloc< ACE_LOCAL_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MEM_POOL_2, ACE_LOCK > >, ACE_Allocator_Adapter< ACE_Malloc< ACE_MMAP_MEMORY_POOL, ACE_SYNCH_MUTEX > >, ACE_New_Allocator, and ACE_Static_Allocator_Base.

Member Data Documentation

allocator_

ACE_Allocator * ACE_Allocator::allocator_ = 0

staticprivate

Pointer to a process-wide ACE_Allocator instance.

---

The documentation for this class was generated from the following files:

• Malloc_Base.h
• Malloc.cpp
• Malloc_Allocator.cpp