PerTreeMemoryExample Struct Reference

an example for a per-tree memory allocator More...

Public Member Functions
ryml::Callbacks	callbacks () const
void *	allocate (size_t len)
void	free (void *mem, size_t len)
	~PerTreeMemoryExample ()
void	check_and_reset ()

Public Attributes
std::vector< char >	memory_pool = std::vector<char>(10u * 1024u)
size_t	num_allocs = 0
size_t	alloc_size = 0
size_t	num_deallocs = 0
size_t	dealloc_size = 0

Detailed Description

an example for a per-tree memory allocator

Definition at line 6897 of file quickstart.cpp.

Constructor & Destructor Documentation

~PerTreeMemoryExample()

PerTreeMemoryExample::~PerTreeMemoryExample ( )

inline

Definition at line 6939 of file quickstart.cpp.

    {
        check_and_reset();
    }

Member Function Documentation

callbacks()

ryml::Callbacks PerTreeMemoryExample::callbacks ( ) const

inline

Definition at line 6903 of file quickstart.cpp.

    {
        // Above we used static functions to bridge to our methods.
        // To show a different approach, we employ lambdas here.
        // Note that there can be no captures in the lambdas
        // because these are C-style function pointers.
        ryml::Callbacks cb;
        cb.m_user_data = (void*) this;
        cb.m_allocate = [](size_t len, void *, void *data){ return ((PerTreeMemoryExample*) data)->allocate(len); };
        cb.m_free = [](void *mem, size_t len, void *data){ return ((PerTreeMemoryExample*) data)->free(mem, len); };
        return cb;
    }

Referenced by sample_per_tree_allocator().

allocate()

void * PerTreeMemoryExample::allocate ( size_t len )

inline

Definition at line 6916 of file quickstart.cpp.

    {
        void *ptr = &memory_pool[alloc_size];
        alloc_size += len;
        ++num_allocs;
        if C4_UNLIKELY(alloc_size > memory_pool.size())
        {
            std::cerr << "out of memory! requested=" << alloc_size << " vs " << memory_pool.size() << " available" << std::endl; // LCOV_EXCL_LINE
            std::abort(); // LCOV_EXCL_LINE
        }
        return ptr;
    }

free()

void PerTreeMemoryExample::free ( void * mem, size_t len )

inline

Definition at line 6929 of file quickstart.cpp.

    {
        CHECK((char*)mem     >= &memory_pool.front() && (char*)mem     <  &memory_pool.back());
        CHECK((char*)mem+len >= &memory_pool.front() && (char*)mem+len <= &memory_pool.back());
        dealloc_size += len;
        ++num_deallocs;
        // no need to free here
    }

check_and_reset()

void PerTreeMemoryExample::check_and_reset ( )

inline

Definition at line 6943 of file quickstart.cpp.

    {
        std::cout << "size: alloc=" << alloc_size << " dealloc=" << dealloc_size << std::endl;
        std::cout << "count: #allocs=" << num_allocs << " #deallocs=" << num_deallocs << std::endl;
        CHECK(num_allocs == num_deallocs);
        CHECK(alloc_size >= dealloc_size); // failure here means a double free
        CHECK(alloc_size == dealloc_size); // failure here means a leak
        num_allocs = 0;
        num_deallocs = 0;
        alloc_size = 0;
        dealloc_size = 0;
    }

Referenced by ~PerTreeMemoryExample().

Member Data Documentation

memory_pool

std::vector<char> PerTreeMemoryExample::memory_pool = std::vector<char>(10u * 1024u)

Definition at line 6899 of file quickstart.cpp.

Referenced by allocate(), and free().

num_allocs

size_t PerTreeMemoryExample::num_allocs = 0

Definition at line 6900 of file quickstart.cpp.

Referenced by allocate(), check_and_reset(), and sample_per_tree_allocator().

alloc_size

size_t PerTreeMemoryExample::alloc_size = 0

Definition at line 6900 of file quickstart.cpp.

Referenced by allocate(), check_and_reset(), and sample_per_tree_allocator().

num_deallocs

size_t PerTreeMemoryExample::num_deallocs = 0

Definition at line 6901 of file quickstart.cpp.

Referenced by check_and_reset(), and free().

dealloc_size

size_t PerTreeMemoryExample::dealloc_size = 0

Definition at line 6901 of file quickstart.cpp.

Referenced by check_and_reset(), and free().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/latest/samples/quickstart.cpp