pw::allocator::internal::GenericBlockAllocator Class Reference

Overview

Block-independent base class of BlockAllocator.

This class contains static methods which do not depend on the template parameters of BlockAllocator that are used to determine block/ type. This allows the methods to be defined in a separate source file and use macros that cannot be used in headers, e.g. PW_CHECK.

This class should not be used directly. Instead, use BlockAllocator or one of its specializations.

Inheritance diagram for pw::allocator::internal::GenericBlockAllocator:

Public Member Functions
	GenericBlockAllocator (const GenericBlockAllocator &)=delete
GenericBlockAllocator &	operator= (const GenericBlockAllocator &)=delete
	GenericBlockAllocator (GenericBlockAllocator &&)=delete
GenericBlockAllocator &	operator= (GenericBlockAllocator &&)=delete
Public Member Functions inherited from pw::Allocator
void *	Allocate (Layout layout)
template<typename T , int &... kExplicitGuard, typename... Args>
std::enable_if_t<!std::is_array_v< T >, 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 >
T *	NewArray (size_t count)
template<typename T >
T *	NewArray (size_t count, size_t alignment)
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 , int &... kExplicitGuard, std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
UniquePtr< T >	MakeUnique (size_t size)
template<typename T , int &... kExplicitGuard, std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
UniquePtr< T >	MakeUnique (size_t size, size_t alignment)
template<typename T , int &... kExplicitGuard, std::enable_if_t< is_bounded_array_v< T >, int > = 0>
UniquePtr< T >	MakeUnique ()
template<typename T >
UniquePtr< T[]>	MakeUniqueArray (size_t size)
template<typename T >
UniquePtr< T[]>	MakeUniqueArray (size_t size, size_t alignment)
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 , int &... kExplicitGuard, std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
SharedPtr< T >	MakeShared (size_t size)
template<typename T , int &... kExplicitGuard, std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
SharedPtr< T >	MakeShared (size_t size, size_t alignment)
template<typename T , int &... kExplicitGuard, std::enable_if_t< is_bounded_array_v< T >, int > = 0>
SharedPtr< T >	MakeShared ()
bool	Resize (void *ptr, size_t new_size)
bool	Resize (void *ptr, Layout layout, size_t new_size)
void *	Reallocate (void *ptr, Layout new_layout)
void *	Reallocate (void *ptr, Layout old_layout, size_t new_size)
size_t	GetAllocated () const
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)
void	Deallocate (void *ptr, Layout layout)
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)

Protected Member Functions
constexpr	GenericBlockAllocator (Capabilities capabilities)
Protected Member Functions inherited from pw::Allocator
constexpr	Allocator ()=default
	TODO(b/326509341): Remove when downstream consumers migrate.
constexpr	Allocator (const Capabilities &capabilities)
Protected Member Functions inherited from pw::Deallocator
constexpr	Deallocator ()=default
	TODO(b/326509341): Remove when downstream consumers migrate.
constexpr	Deallocator (const Capabilities &capabilities)
template<typename T , int &... kExplicitGuard, typename ElementType = std::remove_extent_t<T>, std::enable_if_t< is_unbounded_array_v< T >, int > = 0>
UniquePtr< T >	WrapUnique (ElementType *ptr, size_t size)

Static Protected Member Functions
template<typename BlockType >
static constexpr Capabilities	GetCapabilities ()
static void	CrashOnAllocated (const void *allocated)
static void	CrashOnOutOfRange (const void *freed)
static void	CrashOnDoubleFree (const void *freed)
	Crashes with an informational message that a given block was freed twice.

Additional Inherited Members
Public Types inherited from pw::Deallocator
using	Capabilities = allocator::Capabilities
using	Capability = allocator::Capability
using	Layout = allocator::Layout
Static Protected Attributes inherited from pw::Deallocator
template<typename T >
static constexpr bool	is_bounded_array_v
template<typename T >
static constexpr bool	is_unbounded_array_v

Member Function Documentation

CrashOnAllocated()

static void pw::allocator::internal::GenericBlockAllocator::CrashOnAllocated ( const void *  allocated )

staticprotected

Crashes with an informational message that a given block is allocated.

This method is meant to be called by SplitFreeListAllocators destructor. There must not be any outstanding allocations from an when it is destroyed.

CrashOnOutOfRange()

static void pw::allocator::internal::GenericBlockAllocator::CrashOnOutOfRange ( const void *  freed )

staticprotected

Crashes with an informational message that a given pointer does not belong to this allocator.

---

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

• pw_allocator/public/pw_allocator/block_allocator.h