Skip to main content
Pigweed's logo Pigweed
code_xml
  1. Home
  2. Reference
  3. C/C++
  4. pw::allocator::TaggingAllocator Class Reference
pw::allocator::TaggingAllocator Class Reference

Overview

A FramingAllocator that stores "tag" tokens with each allocation.

This can aid in attribution when debugging.

Inheritance diagram for pw::allocator::TaggingAllocator:
pw::allocator::FramingAllocator< pw::tokenizer::Token > pw::allocator::internal::BaseFramingAllocator< ErrorHandler > pw::allocator::ForwardingAllocator pw::Allocator pw::Deallocator

Public Member Functions

constexpr TaggingAllocator (pw::tokenizer::Token default_token, Allocator &allocator)
 
pw::tokenizer::Token GetToken (const void *ptr) const
 
void SetToken (void *ptr, pw::tokenizer::Token token) const
 
- 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)
 
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.
 
bool IsEqual (const Deallocator &other) const
 
void Deallocate (void *ptr)
 
template<typename ElementType >
void DeleteArray (ElementType *ptr, size_t count)
 
template<typename ElementType >
void Destroy (ElementType *ptr, size_t count)
 
StatusWithSize GetCapacity () const
 
size_t GetAllocated () const
 
std::optional< size_t > GetAllocatedBytes () 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

void * DoAllocate (Layout layout) override
 
- Protected Member Functions inherited from pw::allocator::FramingAllocator< pw::tokenizer::Token >
constexpr FramingAllocator (pw::Allocator &allocator)
 
void * DoAllocate (Layout layout) override
 
void DoDeallocate (void *ptr) override
 
bool DoResize (void *ptr, size_t new_size) override
 
bool DoBeforeReallocate (void *ptr, Layout new_layout) override
 
void DoAfterReallocateCopy (void *ptr, Layout new_layout, void *new_ptr) override
 
Result< Layout > DoGetInfo (Deallocator::InfoType info_type, const void *ptr) const override
 
void * GetFrame (void *data) const
 
const void * GetFrame (const void *data) const
 
pw::tokenizer::Token * GetPrefix (void *data) const
 
const pw::tokenizer::Token * GetPrefix (const void *data) const
 
void * GetData (void *frame) const
 
const void * GetData (const void *data) const
 
void * GetSuffix (void *data) const
 
const void * GetSuffix (const void *data) const
 
- Protected Member Functions inherited from pw::allocator::internal::BaseFramingAllocator< ErrorHandler >
constexpr BaseFramingAllocator (Allocator &allocator)
 
ByteSpan AllocateFrame (Layout prefix, Layout data, Layout suffix)
 
bool ResizeFrame (void *data, size_t new_size, Layout suffix, void *tmp_suffix)
 
Result< Layout > GetFrameInfo (InfoType info_type, const void *data, Layout suffix) const
 
Result< size_t > GetFrameSize (const void *frame) const
 
- Protected Member Functions inherited from pw::allocator::ForwardingAllocator
constexpr ForwardingAllocator (const Capabilities &capabilities) noexcept
 
constexpr ForwardingAllocator (pw::Allocator &allocator) noexcept
 
constexpr void Init (pw::Allocator &allocator)
 
constexpr pw::Allocator & allocator ()
 
constexpr const pw::Allocator & allocator () const
 
void * DoAllocate (Layout layout) override
 
void DoDeallocate (void *ptr) override
 
bool DoResize (void *ptr, size_t new_size) override
 
bool DoBeforeReallocate (void *ptr, Layout new_layout) override
 
void DoAfterReallocateCopy (void *ptr, Layout new_layout, void *new_ptr) override
 
void DoAfterReallocateDone (Layout new_layout, void *new_ptr) override
 
size_t DoGetAllocated () const override
 
std::optional< size_t > DoGetAllocatedBytes () const override
 
std::optional< Fragmentation > DoMeasureFragmentation () const override
 Returns fragmentation information for the allocator's memory region.
 
Result< Layout > DoGetInfo (InfoType info_type, const void *ptr) const override
 
- Protected Member Functions inherited from pw::Allocator
constexpr Allocator () noexcept=default
 TODO(b/326509341): Remove when downstream consumers migrate.
 
constexpr Allocator (const Capabilities &capabilities) noexcept
 
virtual void * DoAllocate (Layout layout)=0
 
virtual bool DoResize (void *ptr, size_t new_size)
 
virtual void * DoReallocate (void *ptr, Layout new_layout)
 
virtual bool DoBeforeReallocate (void *ptr, Layout new_layout)
 
virtual void DoAfterReallocateCopy (void *ptr, Layout new_layout, void *new_ptr)
 
virtual void DoAfterReallocateDone (Layout new_layout, void *new_ptr)
 
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)
 
Result< Layout > GetInfo (InfoType info_type, const void *ptr) const
 
virtual size_t DoGetAllocated () const
 
virtual std::optional< size_t > DoGetAllocatedBytes () const
 
Result< Layout > GetRequestedLayout (const void *ptr) const
 
Result< Layout > GetUsableLayout (const void *ptr) const
 
Result< Layout > GetAllocatedLayout (const void *ptr) const
 
bool Recognizes (const void *ptr) const
 
virtual void DoDeallocate (void *ptr)=0
 
virtual Result< Layout > DoGetInfo (InfoType info_type, const void *ptr) const
 

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
 
- Static Public Attributes inherited from pw::Deallocator
static constexpr size_t kGetAllocatedUnsupported = size_t(-1)
 
- Protected Types inherited from pw::allocator::FramingAllocator< pw::tokenizer::Token >
using Base = internal::BaseFramingAllocator< internal::DefaultFrameErrorHandler >
 
- Protected Types inherited from pw::Deallocator
enum class  InfoType {
  kRequestedLayoutOf , kUsableLayoutOf , kAllocatedLayoutOf , kCapacity ,
  kRecognizes
}
 
- Static Protected Member Functions inherited from pw::allocator::internal::BaseFramingAllocator< ErrorHandler >
static constexpr size_t Distance (const void *start, const void *end)
 Returns the distance between two pointers in bytes.
 
static void UpdateOffsets (void *frame, void *data, void *suffix)
 
static void * GetFrame (void *data, bool has_suffix, bool checked=true)
 
static const void * GetFrame (const void *data, bool has_suffix, bool checked=true)
 
static void * GetData (void *frame, Result< size_t > frame_size, Layout prefix)
 
static const void * GetData (const void *frame, Result< size_t > frame_size, Layout prefix)
 
static void * GetSuffix (void *data, size_t data_size, Layout suffix)
 
static const void * GetSuffix (const void *data, size_t data_size, Layout suffix)
 
- Static Protected Member Functions inherited from pw::Allocator
static bool BeforeReallocate (Allocator &allocator, void *ptr, Layout new_layout)
 
static void AfterReallocateCopy (Allocator &allocator, void *ptr, Layout new_layout, void *new_ptr)
 
static void AfterReallocateDone (Allocator &allocator, Layout new_layout, void *new_ptr)
 
- Static Protected Member Functions inherited from pw::Deallocator
static Result< Layout > GetInfo (const Deallocator &deallocator, InfoType info_type, const void *ptr)
 
static Result< Layout > GetRequestedLayout (const Deallocator &deallocator, const void *ptr)
 
static Result< Layout > GetUsableLayout (const Deallocator &deallocator, const void *ptr)
 
static Result< Layout > GetAllocatedLayout (const Deallocator &deallocator, const void *ptr)
 
static bool Recognizes (const Deallocator &deallocator, const void *ptr)
 
- 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

◆ DoAllocate()

void * pw::allocator::TaggingAllocator::DoAllocate ( Layout  layout)
overrideprotectedvirtual

Allocates a block of memory with the specified size and alignment.

Returns nullptr if the allocation cannot be made, or the layout has a size of 0.

Parameters
[in]layoutDescribes the memory to be allocated.

Reimplemented from pw::allocator::ForwardingAllocator.

◆ GetToken()

pw::tokenizer::Token pw::allocator::TaggingAllocator::GetToken ( const void *  ptr) const

Returns the token associated with the given allocation. Pointer must be to an allocation by a TaggingAllocator.

◆ SetToken()

void pw::allocator::TaggingAllocator::SetToken ( void *  ptr,
pw::tokenizer::Token  token 
) const

Sets the token associated with the given allocation. Pointer must be to an allocation by a TaggingAllocator.


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