pw::allocator::AbstractAllocator Class Reference

Overview

A memory allocator that provides default implementations for optional methods.

This type isn't instantiated directly, but is provided to make it easier to define other allocator types.

Inheritance diagram for pw::allocator::AbstractAllocator:

Protected Member Functions
constexpr	AbstractAllocator (Capabilities capabilities)
bool	DoResize (void *, size_t) override
size_t	DoGetAllocated () const override
std::optional< Fragmentation >	DoMeasureFragmentation () const override
	Returns fragmentation information for the allocator's memory region.
Result< Layout >	DoGetInfo (InfoType, const void *) const override
Protected Member Functions inherited from pw::Allocator
constexpr	Allocator ()=default
	TODO(b/326509341): Remove when downstream consumers migrate.
constexpr	Allocator (const Capabilities &capabilities)
virtual void *	DoAllocate (Layout layout)=0
virtual bool	DoResize (void *ptr, size_t new_size)
virtual void *	DoReallocate (void *ptr, Layout new_layout)
virtual size_t	DoGetAllocated () const
virtual std::optional< Fragmentation >	DoMeasureFragmentation () const
	Returns fragmentation information for the allocator's memory region.
Protected Member Functions inherited from pw::Deallocator
constexpr	Deallocator ()=default
	TODO(b/326509341): Remove when downstream consumers migrate.
constexpr	Deallocator (const Capabilities &capabilities)

Additional Inherited Members
Public Types inherited from pw::Allocator
using	Fragmentation = allocator::Fragmentation
Public Types inherited from pw::Deallocator
using	Capabilities = allocator::Capabilities
using	Capability = allocator::Capability
using	Layout = allocator::Layout
Public Member Functions inherited from pw::Allocator
void *	Allocate (Layout layout)
template<typename T , int &... kExplicitGuard, std::enable_if_t<!std::is_array_v< T >, int > = 0, typename... Args>
T *	New (Args &&... args)
template<typename T , int &... kExplicitGuard, typename ElementType = std::remove_extent_t<T>, std::enable_if_t< is_bounded_array_v< T >, int > = 0>
ElementType *	New ()
template<typename T , int &... kExplicitGuard, typename ElementType = std::remove_extent_t<T>, std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
ElementType *	New (size_t count)
template<typename T , int &... kExplicitGuard, typename ElementType = std::remove_extent_t<T>, std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
ElementType *	New (size_t count, size_t alignment)
	Constructs an alignment-byte aligned array of count objects.
template<typename T , int &... kExplicitGuard, std::enable_if_t<!std::is_array_v< T >, int > = 0, typename... Args>
UniquePtr< T >	MakeUnique (Args &&... args)
template<typename T , std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
UniquePtr< T >	MakeUnique (size_t size)
template<typename T , std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
UniquePtr< T >	MakeUnique (size_t size, size_t alignment)
template<typename T , std::enable_if_t< is_bounded_array_v< T >, int > = 0>
UniquePtr< T >	MakeUnique ()
template<typename T , int &... kExplicitGuard, std::enable_if_t<!std::is_array_v< T >, int > = 0, typename... Args>
SharedPtr< T >	MakeShared (Args &&... args)
template<typename T , std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
SharedPtr< T >	MakeShared (size_t size)
template<typename T , std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
SharedPtr< T >	MakeShared (size_t size, size_t alignment)
template<typename T , std::enable_if_t< is_bounded_array_v< T >, int > = 0>
SharedPtr< T >	MakeShared ()
bool	Resize (void *ptr, size_t new_size)
void *	Reallocate (void *ptr, Layout new_layout)
size_t	GetAllocated () const
std::optional< Fragmentation >	MeasureFragmentation () const
	Returns fragmentation information for the allocator's memory region.
Public Member Functions inherited from pw::Deallocator
constexpr const Capabilities &	capabilities () const
constexpr bool	HasCapability (Capability capability) const
	Returns whether a given capability is enabled for this object.
void	Deallocate (void *ptr)
template<typename ElementType >
void	DeleteArray (ElementType *ptr, size_t count)
StatusWithSize	GetCapacity () const
bool	IsEqual (const Deallocator &other) const
template<typename T , int &... kExplicitGuard, std::enable_if_t<!std::is_array_v< T >, int > = 0>
void	Delete (T *ptr)
template<typename T , int &... kExplicitGuard, typename ElementType = std::remove_extent_t<T>, std::enable_if_t< is_bounded_array_v< T >, int > = 0>
void	Delete (ElementType *ptr)
template<typename T , int &... kExplicitGuard, typename ElementType = std::remove_extent_t<T>, std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
void	Delete (ElementType *ptr, size_t count)
Static Protected Attributes inherited from pw::Deallocator
template<typename T >
static constexpr bool	is_bounded_array_v = ::pw::is_bounded_array_v<T>
template<typename T >
static constexpr bool	is_unbounded_array_v = ::pw::is_unbounded_array_v<T>

Member Function Documentation

DoGetAllocated()

size_t pw::allocator::AbstractAllocator::DoGetAllocated ( ) const

inlineoverrideprotectedvirtual

Reimplemented from pw::Allocator.

Reimplemented in pw::allocator::BumpAllocator.

DoGetInfo()

Result< Layout > pw::allocator::AbstractAllocator::DoGetInfo ( InfoType  , const void *    ) const

inlineoverrideprotected

DoMeasureFragmentation()

std::optional< Fragmentation > pw::allocator::AbstractAllocator::DoMeasureFragmentation ( ) const

inlineoverrideprotectedvirtual

Returns fragmentation information for the allocator's memory region.

Reimplemented from pw::Allocator.

DoResize()

bool pw::allocator::AbstractAllocator::DoResize ( void *  , size_t    )

inlineoverrideprotectedvirtual

Modifies the size of an previously-allocated block of memory without copying any data.

Returns true if its size was changed without copying data to a new allocation; otherwise returns false.

In particular, it always returns true if the old_layout.size() equals new_size, and always returns false if the given pointer is null, the old_layout.size() is 0, or the new_size is 0.

Parameters

[in]	ptr	Pointer to previously-allocated memory.
[in]	new_size	Requested new size for the memory allocation.

Reimplemented from pw::Allocator.

---

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

• pw_allocator/public/pw_allocator/abstract_allocator.h