template.h

Go to the documentation of this file.

 
#include <derive-c/core/includes/def.h>
#if !defined(SKIP_INCLUDES)
    #include "includes.h"
#endif
 
#include <derive-c/core/alloc/def.h>
#include <derive-c/core/self/def.h>
 
#if !defined INDEX_BITS
    #if !defined PLACEHOLDERS
TEMPLATE_ERROR("The number of bits (8,16,32,64) to use for the arena's key")
    #endif
    #define INDEX_BITS 32
#endif
 
#if !defined VALUE
    #if !defined PLACEHOLDERS
TEMPLATE_ERROR("The value type to place in the arena must be defined")
    #endif
typedef struct {
    int x;
} value_t;
    #define VALUE value_t
    #define VALUE_DELETE value_delete
static void VALUE_DELETE(value_t* self);
    #define VALUE_CLONE value_clone
static value_t VALUE_CLONE(value_t const* self);
    #define VALUE_DEBUG value_debug
static void VALUE_DEBUG(VALUE const* self, dc_debug_fmt fmt, FILE* stream);
#endif
 
DC_STATIC_ASSERT(sizeof(VALUE), "VALUE must be a non-zero sized type");
 
#if !defined VALUE_DELETE
    #define VALUE_DELETE DC_NO_DELETE
#endif
 
#if !defined VALUE_CLONE
    #define VALUE_CLONE DC_COPY_CLONE
#endif
 
#if !defined VALUE_DEBUG
    #define VALUE_DEBUG DC_DEFAULT_DEBUG
#endif
 
#include <derive-c/core/index/bits_to_type/def.h>
#include <derive-c/core/index/type_to_strong/def.h>
 
#if !defined INITIAL_BLOCK_INDEX_BITS
    #define INITIAL_BLOCK_INDEX_BITS 8
#endif
 
DC_STATIC_ASSERT(INITIAL_BLOCK_INDEX_BITS < INDEX_BITS,
                 "INITIAL_BLOCK_INDEX_BITS must be less than INDEX_BITS");
DC_STATIC_ASSERT(INITIAL_BLOCK_INDEX_BITS > 0,
                 "INITIAL_BLOCK_INDEX_BITS must be greater than zero");
 
static const size_t NS(SELF, max_entries) = MAX_INDEX;
 
typedef VALUE NS(SELF, value_t);
typedef ALLOC NS(SELF, alloc_t);
 
#define SLOT NS(NAME, slot)
 
#define SLOT_INDEX_TYPE INDEX_TYPE     // [DERIVE-C] for template
#define SLOT_VALUE VALUE               // [DERIVE-C] for template
#define SLOT_VALUE_CLONE VALUE_CLONE   // [DERIVE-C] for template
#define SLOT_VALUE_CLONE VALUE_CLONE   // [DERIVE-C] for template
#define SLOT_VALUE_DELETE VALUE_DELETE // [DERIVE-C] for template
#define INTERNAL_NAME SLOT             // [DERIVE-C] for template
#include <derive-c/utils/slot/template.h>
 
typedef struct {
    // INVARIANT: If free_list == EMPTY_INDEX, then all values from [0, count)
    //            are present
    INDEX_TYPE free_list;
    size_t count;
 
    ALLOC* alloc;
    dc_gdb_marker derive_c_arena_blocks;
    mutation_tracker iterator_invalidation_tracker;
 
    // JUSTIFY: Using index type for the block exclusive end
    //  - We can use a smaller integer type (than size_t), as this is guarenteed to be smaller
    //    half the largest index.
    size_t block_current_exclusive_end;
    uint8_t block_current;
    SLOT* blocks[DC_ARENA_GEO_MAX_NUM_BLOCKS(INDEX_BITS, INITIAL_BLOCK_INDEX_BITS)];
} SELF;
 
static void PRIV(NS(SELF, set_memory_tracking))(SELF const* self) {
    for (uint8_t block_index = 0; block_index <= self->block_current; block_index++) {
        size_t block_items =
            block_index == self->block_current
                ? self->block_current_exclusive_end
                : DC_ARENA_GEO_BLOCK_TO_SIZE(block_index, INITIAL_BLOCK_INDEX_BITS);
        for (size_t offset = 0; offset < block_items; offset++) {
            SLOT* slot = &self->blocks[block_index][offset];
            if (slot->present) {
                NS(SLOT, memory_tracker_present)(slot);
            } else {
                NS(SLOT, memory_tracker_empty)(slot);
            }
        }
    }
 
    size_t tail_slots = DC_ARENA_GEO_BLOCK_TO_SIZE(self->block_current, INITIAL_BLOCK_INDEX_BITS) -
                        (self->block_current_exclusive_end - 1);
    dc_memory_tracker_set(DC_MEMORY_TRACKER_LVL_CONTAINER, DC_MEMORY_TRACKER_CAP_NONE,
                          &self->blocks[self->block_current][self->block_current_exclusive_end],
                          tail_slots * sizeof(SLOT));
}
 
#define INVARIANT_CHECK(self)                                                                      \
    DC_ASSUME(self);                                                                               \
    DC_ASSUME(DC_ARENA_GEO_BLOCK_TO_SIZE((self)->block_current, INITIAL_BLOCK_INDEX_BITS) >=       \
              (self)->block_current_exclusive_end);                                                \
    DC_ASSUME((self)->count <= MAX_INDEX);
 
static SELF NS(SELF, new)(ALLOC* alloc) {
    uint8_t initial_block = 0;
    size_t initial_block_items =
        DC_ARENA_GEO_BLOCK_TO_SIZE(initial_block, INITIAL_BLOCK_INDEX_BITS);
    SLOT* initial_block_slots = (SLOT*)NS(ALLOC, malloc)(alloc, initial_block_items * sizeof(SLOT));
    DC_ASSERT(initial_block_slots);
 
    SELF self = {
        .free_list = INDEX_NONE,
        .count = 0,
        .alloc = alloc,
        .derive_c_arena_blocks = dc_gdb_marker_new(),
        .iterator_invalidation_tracker = mutation_tracker_new(),
        .block_current_exclusive_end = 0,
        .block_current = initial_block,
        .blocks =
            {
                initial_block_slots,
            },
    };
 
    PRIV(NS(SELF, set_memory_tracking))(&self);
    return self;
}
 
static INDEX NS(SELF, insert)(SELF* self, VALUE value) {
    INVARIANT_CHECK(self);
    DC_ASSERT(self->count < MAX_INDEX);
 
    mutation_tracker_mutate(&self->iterator_invalidation_tracker);
 
    if (self->free_list != INDEX_NONE) {
        INDEX_TYPE free_index = self->free_list;
 
        uint8_t block = DC_ARENA_GEO_INDEX_TO_BLOCK(free_index, INITIAL_BLOCK_INDEX_BITS);
        size_t offset = DC_ARENA_GEO_INDEX_TO_OFFSET(free_index, block, INITIAL_BLOCK_INDEX_BITS);
        SLOT* free_slot = &self->blocks[block][offset];
 
        DC_ASSUME(!free_slot->present, "The free list should only contain free slots");
        self->free_list = free_slot->next_free;
 
        free_slot->present = true;
        NS(SLOT, fill)(free_slot, value);
        self->count++;
 
        return (INDEX){.index = free_index};
    }
 
    if (self->block_current_exclusive_end ==
        DC_ARENA_GEO_BLOCK_TO_SIZE(self->block_current, INITIAL_BLOCK_INDEX_BITS)) {
        DC_ASSUME(self->block_current < sizeof(self->blocks) / sizeof(SLOT*));
 
        self->block_current++;
        size_t block_items =
            DC_ARENA_GEO_BLOCK_TO_SIZE(self->block_current, INITIAL_BLOCK_INDEX_BITS);
        SLOT* block_slots = (SLOT*)NS(ALLOC, malloc)(self->alloc, block_items * sizeof(SLOT));
        DC_ASSERT(block_slots);
 
        self->blocks[self->block_current] = block_slots;
        self->block_current_exclusive_end = 0;
    }
 
    size_t offset = self->block_current_exclusive_end;
    NS(SLOT, fill)(&self->blocks[self->block_current][offset], value);
    INDEX_TYPE new_index = (INDEX_TYPE)(DC_ARENA_GEO_BLOCK_OFFSET_TO_INDEX(
        self->block_current, offset, INITIAL_BLOCK_INDEX_BITS));
 
    self->block_current_exclusive_end++;
    self->count++;
 
    PRIV(NS(SELF, set_memory_tracking))(self);
 
    return (INDEX){.index = new_index};
}
 
static VALUE const* NS(SELF, try_read)(SELF const* self, INDEX index) {
    INVARIANT_CHECK(self);
 
    uint8_t block = DC_ARENA_GEO_INDEX_TO_BLOCK(index.index, INITIAL_BLOCK_INDEX_BITS);
    if (block > self->block_current) {
        return NULL;
    }
 
    size_t offset = DC_ARENA_GEO_INDEX_TO_OFFSET(index.index, block, INITIAL_BLOCK_INDEX_BITS);
 
    if (block == self->block_current && offset >= self->block_current_exclusive_end) {
        return NULL;
    }
 
    SLOT* slot = &self->blocks[block][offset];
    if (!slot->present) {
        return NULL;
    }
 
    return &slot->value;
}
 
static VALUE const* NS(SELF, read)(SELF const* self, INDEX index) {
    VALUE const* value = NS(SELF, try_read)(self, index);
    DC_ASSERT(value);
    return value;
}
 
static VALUE* NS(SELF, try_write)(SELF* self, INDEX index) {
    return (VALUE*)NS(SELF, try_read)(self, index);
}
 
static VALUE* NS(SELF, write)(SELF* self, INDEX index) {
    return (VALUE*)NS(SELF, read)(self, index);
}
 
static INDEX_TYPE NS(SELF, size)(SELF const* self) {
    INVARIANT_CHECK(self);
    return self->count;
}
 
static SELF NS(SELF, clone)(SELF const* self) {
    INVARIANT_CHECK(self);
 
    SELF new_self = {
        .free_list = self->free_list,
        .count = self->count,
        .alloc = self->alloc,
        .derive_c_arena_blocks = dc_gdb_marker_new(),
        .iterator_invalidation_tracker = mutation_tracker_new(),
        .block_current_exclusive_end = self->block_current_exclusive_end,
        .block_current = self->block_current,
        .blocks = {},
    };
 
    for (size_t block_index = 0; block_index <= self->block_current; block_index++) {
        size_t block_items = DC_ARENA_GEO_BLOCK_TO_SIZE(block_index, INITIAL_BLOCK_INDEX_BITS);
        SLOT* block_slots = (SLOT*)NS(ALLOC, malloc)(self->alloc, block_items * sizeof(SLOT));
        DC_ASSERT(block_slots);
        new_self.blocks[block_index] = block_slots;
 
        size_t const to_offset =
            block_index == self->block_current ? self->block_current_exclusive_end : block_items;
 
        for (size_t offset = 0; offset < to_offset; offset++) {
            SLOT* src_slot = &self->blocks[block_index][offset];
            SLOT* dst_slot = &new_self.blocks[block_index][offset];
 
            if (src_slot->present) {
                dst_slot->present = true;
                dst_slot->value = VALUE_CLONE(&src_slot->value);
                new_self.count++;
            } else {
                dst_slot->present = false;
            }
        }
    }
 
    PRIV(NS(SELF, set_memory_tracking))(&new_self);
 
    return new_self;
}
 
static bool NS(SELF, try_remove)(SELF* self, INDEX index, VALUE* destination) {
    INVARIANT_CHECK(self);
    mutation_tracker_mutate(&self->iterator_invalidation_tracker);
 
    uint8_t block = DC_ARENA_GEO_INDEX_TO_BLOCK(index.index, INITIAL_BLOCK_INDEX_BITS);
    if (block > self->block_current) {
        return false;
    }
 
    size_t offset = DC_ARENA_GEO_INDEX_TO_OFFSET(index.index, block, INITIAL_BLOCK_INDEX_BITS);
 
    if (block == self->block_current && offset >= self->block_current_exclusive_end) {
        return false;
    }
 
    SLOT* slot = &self->blocks[block][offset];
    if (slot->present) {
        *destination = slot->value;
        slot->present = false;
        NS(SLOT, set_empty)(slot, self->free_list);
        self->free_list = index.index;
        self->count--;
        return true;
    }
    return false;
}
 
static VALUE NS(SELF, remove)(SELF* self, INDEX index) {
    INVARIANT_CHECK(self);
    mutation_tracker_mutate(&self->iterator_invalidation_tracker);
 
    VALUE value;
    DC_ASSERT(NS(SELF, try_remove)(self, index, &value));
    return value;
}
 
static void NS(SELF, delete)(SELF* self) {
    INVARIANT_CHECK(self);
 
    for (uint8_t block = 0; block <= self->block_current; block++) {
        size_t const to_offset = block == self->block_current
                                     ? self->block_current_exclusive_end
                                     : DC_ARENA_GEO_BLOCK_TO_SIZE(block, INITIAL_BLOCK_INDEX_BITS);
 
        for (size_t offset = 0; offset < to_offset; offset++) {
            SLOT* slot = &self->blocks[block][offset];
            if (slot->present) {
                VALUE_DELETE(&slot->value);
            }
        }
 
        dc_memory_tracker_set(DC_MEMORY_TRACKER_LVL_CONTAINER, DC_MEMORY_TRACKER_CAP_WRITE,
                              self->blocks[block],
                              DC_ARENA_GEO_BLOCK_TO_SIZE(block, INITIAL_BLOCK_INDEX_BITS));
        NS(ALLOC, free)(self->alloc, self->blocks[block]);
    }
}
 
#define IV_PAIR_CONST NS(SELF, iv_const)
typedef struct {
    INDEX index;
    VALUE const* value;
} IV_PAIR_CONST;
 
static IV_PAIR_CONST NS(SELF, iv_const_empty)() {
    return (IV_PAIR_CONST){
        .index = {.index = INDEX_NONE},
        .value = NULL,
    };
}
 
#define ITER_CONST NS(SELF, iter_const)
typedef IV_PAIR_CONST NS(ITER_CONST, item);
 
static bool NS(ITER_CONST, empty_item)(IV_PAIR_CONST const* item) { return item->value == NULL; }
 
typedef struct {
    SELF const* arena;
    INDEX_TYPE next_index;
    mutation_version version;
} ITER_CONST;
 
static IV_PAIR_CONST NS(ITER_CONST, next)(ITER_CONST* iter) {
    DC_ASSUME(iter);
    mutation_version_check(&iter->version);
 
    while (iter->next_index < MAX_INDEX) {
        uint8_t block = DC_ARENA_GEO_INDEX_TO_BLOCK(iter->next_index, INITIAL_BLOCK_INDEX_BITS);
        size_t offset =
            DC_ARENA_GEO_INDEX_TO_OFFSET(iter->next_index, block, INITIAL_BLOCK_INDEX_BITS);
 
        if ((block == iter->arena->block_current &&
             offset >= iter->arena->block_current_exclusive_end) ||
            (block > iter->arena->block_current)) {
            break;
        }
 
        SLOT* slot = &iter->arena->blocks[block][offset];
        if (slot->present) {
            IV_PAIR_CONST const result = {
                .index = (INDEX){.index = iter->next_index},
                .value = &slot->value,
            };
            iter->next_index++;
            return result;
        }
 
        iter->next_index++;
    }
 
    return NS(SELF, iv_const_empty)();
}
 
static ITER_CONST NS(SELF, get_iter_const)(SELF const* self) {
    INVARIANT_CHECK(self);
 
    return (ITER_CONST){
        .arena = self,
        .next_index = 0,
        .version = mutation_tracker_get(&self->iterator_invalidation_tracker),
    };
}
 
static void NS(SELF, debug)(SELF const* self, dc_debug_fmt fmt, FILE* stream) {
    fprintf(stream, EXPAND_STRING(SELF) "@%p {\n", self);
    fmt = dc_debug_fmt_scope_begin(fmt);
    dc_debug_fmt_print(fmt, stream, "count: %lu,\n", self->count);
 
    if (self->free_list == INDEX_NONE) {
        dc_debug_fmt_print(fmt, stream, "free_list: INDEX_NONE,\n");
    } else {
        dc_debug_fmt_print(fmt, stream, "free_list: %lu,\n", (size_t)self->free_list);
    }
 
    dc_debug_fmt_print(fmt, stream, "alloc: ");
    NS(ALLOC, debug)(self->alloc, fmt, stream);
    fprintf(stream, ",\n");
 
    dc_debug_fmt_print(fmt, stream, "blocks: [");
    fmt = dc_debug_fmt_scope_begin(fmt);
    for (size_t block = 0; block <= self->block_current; block++) {
        dc_debug_fmt_print(fmt, stream, "{\n");
        fmt = dc_debug_fmt_scope_begin(fmt);
 
        size_t const capacity = DC_ARENA_GEO_BLOCK_TO_SIZE(block, INITIAL_BLOCK_INDEX_BITS);
        size_t const to_offset =
            block == self->block_current ? self->block_current_exclusive_end : capacity;
 
        dc_debug_fmt_print(fmt, stream, "block_index: %lu,\n", block);
        dc_debug_fmt_print(fmt, stream, "block_ptr: %p,\n", self->blocks[block]);
        dc_debug_fmt_print(fmt, stream, "capacity: %lu,\n", capacity);
        dc_debug_fmt_print(fmt, stream, "size: %lu,\n", to_offset);
        dc_debug_fmt_print(fmt, stream, "slots: [\n");
        fmt = dc_debug_fmt_scope_begin(fmt);
 
        for (size_t offset = 0; offset < to_offset; offset++) {
            SLOT* slot = &self->blocks[block][offset];
            dc_debug_fmt_print(fmt, stream, "{\n");
            fmt = dc_debug_fmt_scope_begin(fmt);
 
            dc_debug_fmt_print(fmt, stream, "present: %s,\n", slot->present ? "true" : "false");
            if (slot->present) {
                dc_debug_fmt_print(fmt, stream, "value: ");
                VALUE_DEBUG(&slot->value, fmt, stream);
                fprintf(stream, ",\n");
            } else {
                dc_debug_fmt_print(fmt, stream, "next_free: %lu,\n", (size_t)slot->next_free);
            }
 
            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");
 
        /* Close the block's scope and print its closing brace */
        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, "}");
}
 
#undef ITER_CONST
#undef IV_PAIR_CONST
 
#define IV_PAIR NS(SELF, iv)
typedef struct {
    INDEX index;
    VALUE const* value;
} IV_PAIR;
 
static IV_PAIR NS(SELF, iv_empty)() {
    return (IV_PAIR){
        .index = {.index = INDEX_NONE},
        .value = NULL,
    };
}
 
#define ITER NS(SELF, iter)
typedef IV_PAIR NS(ITER, item);
 
static bool NS(ITER, empty_item)(IV_PAIR const* item) { return item->value == NULL; }
 
typedef struct {
    SELF* arena;
    INDEX_TYPE next_index;
    mutation_version version;
} ITER;
 
static IV_PAIR NS(ITER, next)(ITER* iter) {
    DC_ASSUME(iter);
    mutation_version_check(&iter->version);
 
    while (iter->next_index < MAX_INDEX) {
        uint8_t block = DC_ARENA_GEO_INDEX_TO_BLOCK(iter->next_index, INITIAL_BLOCK_INDEX_BITS);
        size_t offset =
            DC_ARENA_GEO_INDEX_TO_OFFSET(iter->next_index, block, INITIAL_BLOCK_INDEX_BITS);
 
        if ((block == iter->arena->block_current &&
             offset >= iter->arena->block_current_exclusive_end) ||
            (block > iter->arena->block_current)) {
            break;
        }
 
        SLOT* slot = &iter->arena->blocks[block][offset];
        if (slot->present) {
            IV_PAIR result = {
                .index = (INDEX){.index = iter->next_index},
                .value = &slot->value,
            };
            iter->next_index++;
            return result;
        }
 
        iter->next_index++;
    }
 
    return NS(SELF, iv_empty)();
}
 
static ITER NS(SELF, get_iter)(SELF* self) {
    INVARIANT_CHECK(self);
 
    return (ITER){
        .arena = self,
        .next_index = 0,
        .version = mutation_tracker_get(&self->iterator_invalidation_tracker),
    };
}
 
#undef ITER
#undef IV_PAIR
#undef INVARIANT_CHECK
#undef SLOT
#undef INITIAL_BLOCK_INDEX_BITS
 
#include <derive-c/core/index/type_to_strong/undef.h>
#include <derive-c/core/index/bits_to_type/undef.h>
 
#undef VALUE_DEBUG
#undef VALUE_CLONE
#undef VALUE_DELETE
#undef VALUE
#undef INDEX_BITS
 
DC_TRAIT_ARENA(SELF);
 
#include <derive-c/core/self/undef.h>
#include <derive-c/core/alloc/undef.h>
#include <derive-c/core/includes/undef.h>