GlobalAllocatorExample Struct Reference

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

Static Public Member Functions
static void *	s_allocate (size_t len, void *, void *this_)
static void	s_free (void *mem, size_t len, void *this_)

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

Detailed Description

Definition at line 6759 of file quickstart.cpp.

Constructor & Destructor Documentation

~GlobalAllocatorExample()

GlobalAllocatorExample::~GlobalAllocatorExample ( )

inline

Definition at line 6814 of file quickstart.cpp.

    {
        check_and_reset();
    }

Member Function Documentation

allocate()

void * GlobalAllocatorExample::allocate ( size_t len )

inline

Definition at line 6765 of file quickstart.cpp.

    {
        void *ptr = &memory_pool[alloc_size];
        alloc_size += len;
        ++num_allocs;
        // ensure the ptr is aligned
        uintptr_t uptr = (uintptr_t)ptr;
        const uintptr_t align = alignof(max_align_t);
        if (uptr % align)
        {
            uintptr_t prev = uptr - (uptr % align);
            uintptr_t next = prev + align;
            uintptr_t corr = next - uptr;
            ptr = (void*)(((char*)ptr) + corr);
            corr_size += corr;
        }
        C4_CHECK_MSG(alloc_size + corr_size <= memory_pool.size(),
                     "out of memory! requested=%zu+%zu available=%zu\n",
                     alloc_size, corr_size, memory_pool.size());
        return ptr;
    }

free()

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

inline

Definition at line 6787 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
    }

callbacks()

ryml::Callbacks GlobalAllocatorExample::callbacks ( )

inline

Definition at line 6797 of file quickstart.cpp.

    {
        ryml::Callbacks cb = {};
        return cb.set_user_data(this)
            .set_allocate(&GlobalAllocatorExample::s_allocate)
            .set_free(&GlobalAllocatorExample::s_free);
    }

Referenced by sample_global_allocator().

s_allocate()

void * GlobalAllocatorExample::s_allocate ( size_t len, void * , void * this_ )

inlinestatic

Definition at line 6804 of file quickstart.cpp.

    {
        return ((GlobalAllocatorExample*)this_)->allocate(len);
    }

Referenced by callbacks(), and sample_global_allocator().

s_free()

void GlobalAllocatorExample::s_free ( void * mem, size_t len, void * this_ )

inlinestatic

Definition at line 6808 of file quickstart.cpp.

    {
        ((GlobalAllocatorExample*)this_)->free(mem, len);
    }

Referenced by callbacks(), and sample_global_allocator().

check_and_reset()

void GlobalAllocatorExample::check_and_reset ( )

inline

Definition at line 6818 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 ~GlobalAllocatorExample(), and sample_global_allocator().

Member Data Documentation

memory_pool

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

Definition at line 6761 of file quickstart.cpp.

Referenced by allocate(), and free().

num_allocs

size_t GlobalAllocatorExample::num_allocs = 0

Definition at line 6762 of file quickstart.cpp.

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

alloc_size

size_t GlobalAllocatorExample::alloc_size = 0

Definition at line 6762 of file quickstart.cpp.

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

corr_size

size_t GlobalAllocatorExample::corr_size = 0

Definition at line 6762 of file quickstart.cpp.

Referenced by allocate().

num_deallocs

size_t GlobalAllocatorExample::num_deallocs = 0

Definition at line 6763 of file quickstart.cpp.

Referenced by check_and_reset(), and free().

dealloc_size

size_t GlobalAllocatorExample::dealloc_size = 0

Definition at line 6763 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