ra8_arena_t Struct Reference

Caller-owned bump-arena state over one tier region. More...

#include <ra8_arena.h>

Data Fields
uint8_t *	base
	First byte of the tier region.
uint32_t	size
	Region length in bytes.
uint32_t	used
	High-water mark (bytes carved so far).

Detailed Description

Caller-owned bump-arena state over one tier region.

Zero-initialise and pass to ra8_arena_init. The backing region must out-live the arena and every block carved from it. Fields are private.

Invariant

used <= size.

Since

0.1.0

Definition at line 56 of file ra8_arena.h.

Field Documentation

base

uint8_t* ra8_arena_t::base

First byte of the tier region.

Definition at line 57 of file ra8_arena.h.

Referenced by ra8_arena_carve(), and ra8_arena_init().

size

uint32_t ra8_arena_t::size

Region length in bytes.

Definition at line 58 of file ra8_arena.h.

Referenced by ra8_arena_carve(), ra8_arena_init(), and ra8_arena_remaining().

used

uint32_t ra8_arena_t::used

High-water mark (bytes carved so far).

Definition at line 59 of file ra8_arena.h.

Referenced by ra8_arena_carve(), ra8_arena_init(), and ra8_arena_remaining().

---

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

• libs/ra8_mem/inc/ra8_arena.h