Botan::Malloc_Allocator Class Reference

#include <defalloc.h>

Inheritance diagram for Botan::Malloc_Allocator:

Public Member Functions
void *	allocate (size_t)
void	deallocate (void *, size_t)
virtual void	destroy ()
virtual void	init ()
std::string	type () const

Static Public Member Functions
static Allocator *	get (bool locking)

Detailed Description

Allocator using malloc

Definition at line 18 of file defalloc.h.

Member Function Documentation

allocate()

void * Botan::Malloc_Allocator::allocate ( size_t n )

virtual

Allocate a block of memory

Parameters

n	how many bytes to allocate

Returns

pointer to n bytes of memory

Implements Botan::Allocator.

Definition at line 55 of file defalloc.cpp.

   {
   void* ptr = do_malloc(n, false);
   if(!ptr)
      throw Memory_Exhaustion();
   return ptr;
   }

deallocate()

void Botan::Malloc_Allocator::deallocate ( void * ptr, size_t n )

virtual

Deallocate memory allocated with allocate()

Parameters

ptr	the pointer returned by allocate()
n	the size of the block pointed to by ptr

Implements Botan::Allocator.

Definition at line 66 of file defalloc.cpp.

   {
   do_free(ptr, n, false);
   }

destroy()

virtual void Botan::Allocator::destroy ( )

inlinevirtualinherited

Shutdown the allocator

Reimplemented in Botan::Pooling_Allocator.

Definition at line 58 of file allocate.h.

{}

get()

Allocator * Botan::Allocator::get ( bool locking )

staticinherited

Acquire a pointer to an allocator

Parameters

locking

is true if the allocator should attempt to secure the memory (eg for using to store keys)

Returns

pointer to an allocator; ownership remains with library, so do not delete

Definition at line 90 of file defalloc.cpp.

   {
   std::string type = "";
   if(!locking)
      type = "malloc";
 
   Allocator* alloc = global_state().get_allocator(type);
   if(alloc)
      return alloc;
 
   throw Internal_Error("Couldn't find an allocator to use in get_allocator");
   }

References Botan::Library_State::get_allocator(), Botan::global_state(), Botan::Internal_Error::Internal_Error(), and type().

Referenced by Botan::GMP_Engine::GMP_Engine(), and Botan::MemoryRegion< T >::init().

init()

virtual void Botan::Allocator::init ( )

inlinevirtualinherited

Initialize the allocator

Definition at line 53 of file allocate.h.

{}

Referenced by Botan::Library_State::add_allocator().

type()

std::string Botan::Malloc_Allocator::type ( ) const

inlinevirtual

Returns

name of this allocator type

Implements Botan::Allocator.

Definition at line 24 of file defalloc.h.

{ return "malloc"; }

---

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

• src/alloc/system_alloc/defalloc.h
• src/alloc/system_alloc/defalloc.cpp