template.h File Reference

#include <derive-c/core/includes/def.h>
#include "includes.h"
#include <derive-c/core/alloc/def.h>
#include <derive-c/core/self/def.h>
#include <derive-c/core/index/bits_to_type/def.h>
#include <derive-c/core/index/type_to_strong/def.h>
#include <derive-c/utils/slot/template.h>
#include <derive-c/core/index/type_to_strong/undef.h>
#include <derive-c/core/index/bits_to_type/undef.h>
#include <derive-c/core/self/undef.h>
#include <derive-c/core/alloc/undef.h>
#include <derive-c/core/includes/undef.h>

Go to the source code of this file.

Data Structures
struct	value_t
struct	SELF
	An allocator that prints to stdout when it allocates or frees memory. More...
struct	IV_PAIR
struct	ITER
struct	IV_PAIR_CONST
struct	ITER_CONST

Macros
#define	INDEX_BITS   32
	A vector-backed arena, with support for small indices.
#define	VALUE   value_t
#define	VALUE_DELETE   value_delete
#define	VALUE_CLONE   value_clone
#define	VALUE_DEBUG   value_debug
#define	CHECK_ACCESS_INDEX(self, index)
#define	RESIZE_FACTOR   2
#define	SLOT   NS(NAME, slot)
#define	SLOT_INDEX_TYPE   INDEX_TYPE
#define	SLOT_VALUE   VALUE
#define	SLOT_VALUE_CLONE   VALUE_CLONE
#define	SLOT_VALUE_CLONE   VALUE_CLONE
#define	SLOT_VALUE_DELETE   VALUE_DELETE
#define	INTERNAL_NAME   SLOT
#define	INVARIANT_CHECK(self)
#define	IV_PAIR   NS(SELF, iv)
#define	ITER   NS(SELF, iter)
#define	IV_PAIR_CONST   NS(SELF, iv_const)
#define	ITER_CONST   NS(SELF, iter_const)

Typedefs
typedef IV_PAIR	item

Functions
static void	VALUE_DELETE (value_t *)
static value_t	VALUE_CLONE (value_t const *self)
static void	VALUE_DEBUG (VALUE const *, dc_debug_fmt, FILE *)
	DC_STATIC_ASSERT (sizeof(VALUE), "VALUE must be a non-zero sized type")
static DC_PUBLIC SELF	new_with_capacity_for (INDEX_TYPE items, ref alloc_ref)
static DC_PUBLIC INDEX	insert (SELF *self, VALUE value)
static DC_PUBLIC VALUE *	try_write (SELF *self, INDEX index)
static DC_PUBLIC VALUE *	write (SELF *self, INDEX index)
static DC_PUBLIC VALUE const *	try_read (SELF const *self, INDEX index)
static DC_PUBLIC VALUE const *	read (SELF const *self, INDEX index)
static DC_PUBLIC SELF	clone (SELF const *self)
static DC_PUBLIC size_t	size (SELF const *self)
static DC_PUBLIC bool	full (SELF const *self)
static DC_PUBLIC bool	try_remove (SELF *self, INDEX index, VALUE *destination)
static DC_PUBLIC VALUE	remove (SELF *self, INDEX index)
static DC_PUBLIC IV_PAIR	iv_empty ()
static DC_PUBLIC bool	empty_item (IV_PAIR const *item)
static DC_PUBLIC bool	empty (ITER const *iter)
static DC_PUBLIC IV_PAIR	next (ITER *iter)
static DC_PUBLIC ITER	get_iter (SELF *self)
static DC_PUBLIC void	delete (SELF *self)
static DC_PUBLIC IV_PAIR_CONST	iv_const_empty ()
static DC_PUBLIC bool	empty_item (IV_PAIR_CONST const *item)
static DC_PUBLIC bool	empty (ITER_CONST const *iter)
static DC_PUBLIC IV_PAIR_CONST	next (ITER_CONST *iter)
static DC_PUBLIC ITER_CONST	get_iter_const (SELF const *self)
static DC_PUBLIC void	debug (SELF const *self, dc_debug_fmt fmt, FILE *stream)
	DC_TRAIT_ARENA (SELF)

Variables
static DC_PUBLIC const size_t	max_entries = MAX_INDEX

Macro Definition Documentation

CHECK_ACCESS_INDEX

#define CHECK_ACCESS_INDEX	(		self,
			index )

Value:

((index).index < (self)->exclusive_end)

Definition at line 51 of file template.h.

INDEX_BITS

#define INDEX_BITS   32

A vector-backed arena, with support for small indices.

Definition at line 15 of file template.h.

INTERNAL_NAME

#define INTERNAL_NAME   SLOT

Definition at line 67 of file template.h.

INVARIANT_CHECK

#define INVARIANT_CHECK

(

self

)

Value:

    DC_ASSUME(self);                                                                               \
    DC_ASSUME((self)->count <= (self)->capacity);                                                  \
    DC_ASSUME((self)->exclusive_end >= (self)->count);                                             \
    DC_ASSUME((self)->count <= MAX_INDEX);

Definition at line 90 of file template.h.

#define INVARIANT_CHECK(self)                                                                      \
    DC_ASSUME(self);                                                                               \
    DC_ASSUME((self)->count <= (self)->capacity);                                                  \
    DC_ASSUME((self)->exclusive_end >= (self)->count);                                             \
    DC_ASSUME((self)->count <= MAX_INDEX);

ITER

#define ITER   NS(SELF, iter)

Definition at line 280 of file template.h.

ITER_CONST

#define ITER_CONST   NS(SELF, iter_const)

Definition at line 366 of file template.h.

IV_PAIR

#define IV_PAIR   NS(SELF, iv)

Definition at line 269 of file template.h.

IV_PAIR_CONST

#define IV_PAIR_CONST   NS(SELF, iv_const)

Definition at line 355 of file template.h.

RESIZE_FACTOR

#define RESIZE_FACTOR   2

Definition at line 55 of file template.h.

SLOT

#define SLOT   NS(NAME, slot)

Definition at line 60 of file template.h.

SLOT_INDEX_TYPE

#define SLOT_INDEX_TYPE   INDEX_TYPE

Definition at line 62 of file template.h.

SLOT_VALUE

#define SLOT_VALUE   VALUE

Definition at line 63 of file template.h.

SLOT_VALUE_CLONE [1/2]

#define SLOT_VALUE_CLONE   VALUE_CLONE

Definition at line 64 of file template.h.

SLOT_VALUE_CLONE [2/2]

#define SLOT_VALUE_CLONE   VALUE_CLONE

Definition at line 64 of file template.h.

SLOT_VALUE_DELETE

#define SLOT_VALUE_DELETE   VALUE_DELETE

Definition at line 66 of file template.h.

VALUE

#define VALUE   value_t

Definition at line 25 of file template.h.

VALUE_CLONE

#define VALUE_CLONE   value_clone

Definition at line 28 of file template.h.

VALUE_DEBUG

#define VALUE_DEBUG   value_debug

Definition at line 30 of file template.h.

VALUE_DELETE

#define VALUE_DELETE   value_delete

Definition at line 26 of file template.h.

Typedef Documentation

item

typedef ITEM const * item

Examples

container/set.c, and container/vector.c.

Definition at line 281 of file template.h.

Function Documentation

clone()

DC_PUBLIC SELF clone ( SELF const * self )

static

Definition at line 201 of file template.h.

                                                        {
    INVARIANT_CHECK(self);
    SLOT* slots = (SLOT*)NS(ALLOC, allocate_zeroed)(self->alloc_ref, self->capacity * sizeof(SLOT));
 
    for (INDEX_TYPE index = 0; index < self->exclusive_end; index++) {
        NS(SLOT, clone_from)(&self->slots[index], &slots[index]);
    }
 
    return (SELF){
        .slots = slots,
        .capacity = self->capacity,
        .free_list = self->free_list,
        .exclusive_end = self->exclusive_end,
        .count = self->count,
        .alloc_ref = self->alloc_ref,
        .derive_c_arena_basic = dc_gdb_marker_new(),
        .iterator_invalidation_tracker = mutation_tracker_new(),
    };
}

DC_STATIC_ASSERT()

DC_STATIC_ASSERT	(	sizeof(VALUE)	,
		"VALUE must be a non-zero sized type"	)

DC_TRAIT_ARENA()

DC_TRAIT_ARENA

(

SELF

)

debug()

DC_PUBLIC void debug ( SELF const * self, dc_debug_fmt fmt, FILE * stream )

static

Definition at line 425 of file template.h.

                                                                                        {
    fprintf(stream, DC_EXPAND_STRING(SELF) "@%p {\n", (void*)self);
    fmt = dc_debug_fmt_scope_begin(fmt);
    dc_debug_fmt_print(fmt, stream, "capacity: %lu,\n", self->capacity);
    dc_debug_fmt_print(fmt, stream, "count: %lu,\n", self->count);
    dc_debug_fmt_print(fmt, stream, "slots: %p,\n", (void*)self->slots);
 
    dc_debug_fmt_print(fmt, stream, "alloc: ");
    NS(ALLOC, debug)(NS(NS(ALLOC, ref), deref)(self->alloc_ref), fmt, stream);
    fprintf(stream, ",\n");
 
    dc_debug_fmt_print(fmt, stream, "items: [");
    fmt = dc_debug_fmt_scope_begin(fmt);
 
    ITER_CONST iter = NS(SELF, get_iter_const)(self);
    for (IV_PAIR_CONST item = NS(ITER_CONST, next)(&iter); !NS(ITER_CONST, empty_item)(&item);
         item = NS(ITER_CONST, next)(&iter)) {
        dc_debug_fmt_print(fmt, stream, "{\n");
        fmt = dc_debug_fmt_scope_begin(fmt);
 
        dc_debug_fmt_print(fmt, stream, "key: ");
        NS(INDEX, debug)(&item.index, fmt, stream);
        fprintf(stream, ",\n");
 
        dc_debug_fmt_print(fmt, stream, "value: ");
        VALUE_DEBUG(item.value, fmt, stream);
        fprintf(stream, ",\n");
 
        fmt = dc_debug_fmt_scope_end(fmt);
        dc_debug_fmt_print(fmt, stream, "},\n");
    }
 
    fmt = dc_debug_fmt_scope_end(fmt);
    dc_debug_fmt_print(fmt, stream, "],\n");
    fmt = dc_debug_fmt_scope_end(fmt);
    dc_debug_fmt_print(fmt, stream, "}");
}

delete()

DC_PUBLIC void delete ( SELF * self )

static

Definition at line 340 of file template.h.

                                                   {
    INVARIANT_CHECK(self);
    ITER iter = NS(SELF, get_iter)(self);
 
    for (IV_PAIR entry = NS(ITER, next)(&iter); !NS(ITER, empty_item)(&entry);
         entry = NS(ITER, next)(&iter)) {
        VALUE_DELETE(entry.value);
    }
 
    NS(ALLOC, deallocate)(self->alloc_ref, self->slots, self->capacity * sizeof(SLOT));
}

empty() [1/2]

DC_PUBLIC bool empty ( ITER const * iter )

static

Definition at line 291 of file template.h.

                                                        {
    DC_ASSUME(iter);
    mutation_version_check(&iter->version);
    // JUSTIFY: If no entries are left, then the previous '.._next' call moved
    //          the index to the exclusive end
    // NOTE: `index + 1 > exclusive_end` implies `index >= exclusive_end`
    return iter->next_index == INDEX_NONE || iter->next_index >= iter->arena->exclusive_end;
}

empty() [2/2]

DC_PUBLIC bool empty ( ITER_CONST const * iter )

static

Definition at line 382 of file template.h.

                                                                    {
    DC_ASSUME(iter);
    mutation_version_check(&iter->version);
    return iter->next_index == INDEX_NONE || iter->next_index >= iter->arena->exclusive_end;
}

empty_item() [1/2]

DC_PUBLIC bool empty_item ( IV_PAIR const * item )

static

Definition at line 283 of file template.h.

{ return item->value == NULL; }

empty_item() [2/2]

DC_PUBLIC bool empty_item ( IV_PAIR_CONST const * item )

static

Definition at line 371 of file template.h.

                                                                            {
    return item->value == NULL;
}

full()

DC_PUBLIC bool full ( SELF const * self )

static

Definition at line 226 of file template.h.

                                                       {
    INVARIANT_CHECK(self);
    if (self->capacity == CAPACITY_EXCLUSIVE_UPPER) {
        if (self->free_list == INDEX_NONE) {
            return true;
        }
    }
    return false;
}

get_iter()

DC_PUBLIC ITER get_iter ( SELF * self )

static

Definition at line 326 of file template.h.

                                                     {
    INVARIANT_CHECK(self);
    INDEX_TYPE index = 0;
    while (index < INDEX_NONE && index < self->exclusive_end && !self->slots[index].present) {
        index++;
    }
 
    return (ITER){
        .arena = self,
        .next_index = index,
        .version = mutation_tracker_get(&self->iterator_invalidation_tracker),
    };
}

get_iter_const()

DC_PUBLIC ITER_CONST get_iter_const ( SELF const * self )

static

Definition at line 411 of file template.h.

                                                                       {
    INVARIANT_CHECK(self);
    INDEX_TYPE index = 0;
    while (index < INDEX_NONE && index < self->exclusive_end && !self->slots[index].present) {
        index++;
    }
 
    return (ITER_CONST){
        .arena = self,
        .next_index = index,
        .version = mutation_tracker_get(&self->iterator_invalidation_tracker),
    };
}

insert()

DC_PUBLIC INDEX insert ( SELF * self, VALUE value )

static

Definition at line 121 of file template.h.

                                                                 {
    INVARIANT_CHECK(self);
    DC_ASSERT(self->count < MAX_INDEX,
              "Arena is full, cannot insert {count=%lu, max_index=%lu, value=%s}",
              (size_t)self->count, (size_t)MAX_INDEX, DC_DEBUG(VALUE_DEBUG, &value));
 
    mutation_tracker_mutate(&self->iterator_invalidation_tracker);
    if (self->free_list != INDEX_NONE) {
        INDEX_TYPE free_index = self->free_list;
        SLOT* slot = &self->slots[free_index];
        DC_ASSUME(!slot->present);
 
        self->free_list = slot->next_free;
        NS(SLOT, fill)(slot, value);
 
        self->count++;
        return (INDEX){.index = free_index};
    }
 
    if (self->exclusive_end == self->capacity) {
        DC_ASSERT(self->capacity <= (CAPACITY_EXCLUSIVE_UPPER / RESIZE_FACTOR),
                  "Cannot increase capacity for new item {capacity=%lu, max_capacity=%lu, item=%s}",
                  (size_t)self->capacity, (size_t)CAPACITY_EXCLUSIVE_UPPER,
                  DC_DEBUG(VALUE_DEBUG, &value));
        size_t old_size = self->capacity * sizeof(SLOT);
        self->capacity *= RESIZE_FACTOR;
        SLOT* new_alloc = (SLOT*)NS(ALLOC, reallocate)(self->alloc_ref, self->slots, old_size,
                                                       self->capacity * sizeof(SLOT));
        self->slots = new_alloc;
 
        for (size_t index = self->exclusive_end; index < self->capacity; index++) {
            NS(SLOT, memory_tracker_empty)(&self->slots[index]);
        }
    }
 
    INDEX_TYPE new_index = (INDEX_TYPE)self->exclusive_end;
    SLOT* slot = &self->slots[new_index];
    NS(SLOT, fill)(slot, value);
 
    self->count++;
    self->exclusive_end++;
    return (INDEX){.index = new_index};
}

iv_const_empty()

DC_PUBLIC IV_PAIR_CONST iv_const_empty ( )

static

Definition at line 362 of file template.h.

                                                          {
    return (IV_PAIR_CONST){.index = (INDEX){.index = INDEX_NONE}, .value = NULL};
}

iv_empty()

DC_PUBLIC IV_PAIR iv_empty ( )

static

Definition at line 276 of file template.h.

                                              {
    return (IV_PAIR){.index = (INDEX){.index = INDEX_NONE}, .value = NULL};
}

new_with_capacity_for()

DC_PUBLIC SELF new_with_capacity_for ( INDEX_TYPE items, ref alloc_ref )

static

Definition at line 96 of file template.h.

                                                                                                  {
    DC_ASSERT(items > 0, "Cannot create arena with capacity for 0 items {items=%lu}",
              (size_t)items);
    size_t capacity = dc_math_next_power_of_2(items);
    DC_ASSERT(capacity <= CAPACITY_EXCLUSIVE_UPPER,
              "Index capacity too large {capacity=%lu, max_capacity=%lu}", (size_t)capacity,
              (size_t)CAPACITY_EXCLUSIVE_UPPER);
    SLOT* slots = (SLOT*)NS(ALLOC, allocate_zeroed)(alloc_ref, capacity * sizeof(SLOT));
 
    for (INDEX_TYPE index = 0; index < capacity; index++) {
        NS(SLOT, memory_tracker_empty)(&slots[index]);
    }
 
    return (SELF){
        .slots = slots,
        .capacity = (INDEX_TYPE)capacity,
        .free_list = INDEX_NONE,
        .exclusive_end = 0,
        .count = 0,
        .alloc_ref = alloc_ref,
        .derive_c_arena_basic = dc_gdb_marker_new(),
        .iterator_invalidation_tracker = mutation_tracker_new(),
    };
}

next() [1/2]

DC_PUBLIC IV_PAIR next ( ITER * iter )

static

Definition at line 300 of file template.h.

                                                    {
    DC_ASSUME(iter);
    mutation_version_check(&iter->version);
 
    while (iter->next_index < INDEX_NONE && iter->next_index < iter->arena->exclusive_end) {
        IV_PAIR result = {
            .index = (INDEX){.index = iter->next_index},
            .value = &iter->arena->slots[iter->next_index].value,
        };
 
        iter->next_index++;
        // advance to next present entry
        while (iter->next_index < INDEX_NONE && iter->next_index < iter->arena->exclusive_end &&
               !iter->arena->slots[iter->next_index].present) {
            iter->next_index++;
        }
 
        if (result.value && result.value == &iter->arena->slots[result.index.index].value &&
            iter->arena->slots[result.index.index].present) {
            return result;
        }
    }
 
    return NS(SELF, iv_empty)();
}

next() [2/2]

DC_PUBLIC IV_PAIR_CONST next ( ITER_CONST * iter )

static

Definition at line 388 of file template.h.

                                                                      {
    DC_ASSUME(iter);
    mutation_version_check(&iter->version);
 
    while (iter->next_index < INDEX_NONE && iter->next_index < iter->arena->exclusive_end) {
        IV_PAIR_CONST result = {
            .index = (INDEX){.index = iter->next_index},
            .value = &iter->arena->slots[iter->next_index].value,
        };
        iter->next_index++;
        while (iter->next_index != INDEX_NONE && iter->next_index < iter->arena->exclusive_end &&
               !iter->arena->slots[iter->next_index].present) {
            iter->next_index++;
        }
 
        if (result.value && iter->arena->slots[result.index.index].present) {
            return result;
        }
    }
 
    return NS(SELF, iv_const_empty)();
}

read()

DC_PUBLIC VALUE const * read ( SELF const * self, INDEX index )

static

Definition at line 195 of file template.h.

                                                                            {
    VALUE const* value = NS(SELF, try_read)(self, index);
    DC_ASSERT(value, "Cannot read item, index not found {index=%lu}", (size_t)index.index);
    return value;
}

remove()

DC_PUBLIC VALUE remove ( SELF * self, INDEX index )

static

Definition at line 259 of file template.h.

                                                                 {
    INVARIANT_CHECK(self);
    mutation_tracker_mutate(&self->iterator_invalidation_tracker);
 
    VALUE value;
    DC_ASSERT(NS(SELF, try_remove)(self, index, &value),
              "Failed to remove item, index not found {index=%lu}", (size_t)index.index);
    return value;
}

size()

DC_PUBLIC size_t size ( SELF const * self )

static

Definition at line 221 of file template.h.

                                                         {
    INVARIANT_CHECK(self);
    return self->count;
}

try_read()

DC_PUBLIC VALUE const * try_read ( SELF const * self, INDEX index )

static

Definition at line 183 of file template.h.

                                                                                {
    INVARIANT_CHECK(self);
    if (!CHECK_ACCESS_INDEX(self, index)) {
        return NULL;
    }
    SLOT* slot = &self->slots[index.index];
    if (!slot->present) {
        return NULL;
    }
    return &slot->value;
}

try_remove()

DC_PUBLIC bool try_remove ( SELF * self, INDEX index, VALUE * destination )

static

Definition at line 238 of file template.h.

                                                                                        {
    INVARIANT_CHECK(self);
    mutation_tracker_mutate(&self->iterator_invalidation_tracker);
 
    if (!CHECK_ACCESS_INDEX(self, index)) {
        return false;
    }
 
    SLOT* entry = &self->slots[index.index];
    if (entry->present) {
        *destination = entry->value;
 
        NS(SLOT, set_empty)(entry, self->free_list);
 
        self->free_list = index.index;
        self->count--;
        return true;
    }
    return false;
}

try_write()

DC_PUBLIC VALUE * try_write ( SELF * self, INDEX index )

static

Definition at line 165 of file template.h.

                                                                     {
    INVARIANT_CHECK(self);
    if (!CHECK_ACCESS_INDEX(self, index)) {
        return NULL;
    }
    SLOT* slot = &self->slots[index.index];
    if (!slot->present) {
        return NULL;
    }
    return &slot->value;
}

VALUE_CLONE()

value_t VALUE_CLONE ( value_t const * self )

static

Definition at line 29 of file template.h.

{ return *self; }

VALUE_DEBUG()

void VALUE_DEBUG ( VALUE const * , dc_debug_fmt , FILE *  )

static

Definition at line 31 of file template.h.

{}

VALUE_DELETE()

void VALUE_DELETE ( value_t * )

static

Definition at line 27 of file template.h.

{}

write()

DC_PUBLIC VALUE * write ( SELF * self, INDEX index )

static

Definition at line 177 of file template.h.

                                                                 {
    VALUE* value = NS(SELF, try_write)(self, index);
    DC_ASSERT(value, "Cannot write item, index not found {index=%lu}", (size_t)index.index);
    return value;
}

Variable Documentation

max_entries

DC_PUBLIC const size_t max_entries = MAX_INDEX

static

Definition at line 236 of file template.h.