[#BloombergLP-bslma-MallocFreeAllocator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslma.adoc[bslma]::MallocFreeAllocator
:relfileprefix: ../../
:mrdocs:

This class provides direct access to the system‐supplied (native) global `std::malloc` and `std::free`.

== Synopsis

Declared in `<bslma_mallocfreeallocator.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class MallocFreeAllocator
    : public xref:BloombergLP/bslma/Allocator.adoc[Allocator]
----

== Description

A `static` method is provided for obtaining a unique, process wide object of this class, which is valid from the time the method is called until after the program (not just `main`) exits.

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslma/Allocator.adoc[Allocator]`
| Pure abstract protocol for clients and suppliers of raw memory.
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/size_type.adoc[`size_type`] 
| Alias for an unsigned integral type capable of representing the number of bytes in this platform's virtual address space.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/MallocFreeAllocator/2constructor.adoc[`MallocFreeAllocator`]         [.small]#[constructor]#
| Create an allocator that uses `std::malloc` and `std::free` to supply memory. Note that all objects of this class share the same underlying resource.
| xref:BloombergLP/bslma/MallocFreeAllocator/2destructor.adoc[`~MallocFreeAllocator`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy this allocator.
| xref:BloombergLP/bslma/Allocator/operator_assign.adoc[`operator=`] 
| 
| xref:BloombergLP/bslma/MallocFreeAllocator/allocate-0b.adoc[`allocate`] 
| Return a newly allocated block of memory of the specified `size` bytes.
| xref:BloombergLP/bslma/MallocFreeAllocator/deallocate-07.adoc[`deallocate`] 
| Return the memory block at the specified `address` to this allocator.
| xref:BloombergLP/bslma/Allocator/deleteObject-09.adoc[`deleteObject`] 
| `deleteObject` overloads
| xref:BloombergLP/bslma/Allocator/deleteObjectRaw-06f.adoc[`deleteObjectRaw`] 
| `deleteObjectRaw` overloads
| xref:BloombergLP/bslma/Allocator/is_equal.adoc[`is_equal`] 
| 
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/MallocFreeAllocator/singleton.adoc[`singleton`] 
| Return a reference to a valid object of this class.
| xref:BloombergLP/bslma/Allocator/throwBadAlloc.adoc[`throwBadAlloc`] 
| Throw `std::bad_alloc` or abort the program.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/do_allocate.adoc[`do_allocate`]  [.small]#[virtual]#
| Return a newly allocated block of at least `bytes` with `alignment`.
| xref:BloombergLP/bslma/Allocator/do_deallocate.adoc[`do_deallocate`]  [.small]#[virtual]#
| Return the memory block at `p` having `bytes` and `alignment`.
| xref:BloombergLP/bslma/Allocator/do_is_equal.adoc[`do_is_equal`]  [.small]#[virtual]#
| Return whether this allocator can exchange memory with `other`.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#