arena.h

/*
                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

   Copyright 2024 Carter Dugan
*/


/*
    #########################
    ####                 ####
    #### ARENA ALLOCATOR ####
    ####   QUICK GUIDE   ####
    ####                 ####
    #########################

See README.md for more in-depth usage docs and an
example.

QUICK USAGE:
  One file in one translation unit must have the
  following before including "arena.h", replacing
  the macro values appropriately when desired.

        ```
        #define ARENA_IMPLEMENTATION

        // All of these are optional
        #define ARENA_MALLOC <stdlib_malloc_like_allocator>
        #define ARENA_FREE <stdlib_free_like_deallocator>
        #define ARENA_MEMCPY <stdlib_memcpy_like_copier>

        // for debug functionality, you can also do:
        #define ARENA_DEBUG

        // If you would like to change the default alignment for
        // allocations, you can define:
        #define ARENA_DEFAULT_ALIGNMENT <alignment_value>
        ```

  There is also a C89-friendly macro for
  determining the alignment of a type.
        ```
        ARENA_ALIGNOF(type)
        ```
  This evaluates to C11 alignof(type) when compiled
  for C11 or later, but also allows the same
  behavior for C89 and C99

  After doing that, you can `#include "arena.h"`
  And for any other file in any other translation
  unit in the build, you can `#include "arena.h"`
  like you normally would by itself.
*/



#ifndef ARENA_H
#define ARENA_H



#include <stddef.h>



#if __STDC_VERSION__ >= 201112L
    #include <stdalign.h>
    #define ARENA_ALIGNOF(type) alignof(type)
#else
    #define ARENA_ALIGNOF(type) offsetof(struct { char c; type d; }, d)
#endif



#ifndef ARENA_DEFAULT_ALIGNMENT
    #define ARENA_DEFAULT_ALIGNMENT ARENA_ALIGNOF(size_t)
#endif



#ifdef ARENA_DEBUG



#include <stdlib.h>



typedef struct Arena_Allocation_s
{
    size_t index;
    size_t size;
    char *pointer;
    struct Arena_Allocation_s *next;
} Arena_Allocation;



#endif /* ARENA_DEBUG */



typedef struct
{
    char *region;
    size_t index;
    size_t size;

    #ifdef ARENA_DEBUG
    unsigned long allocations;
    Arena_Allocation *head_allocation;
    #endif /* ARENA_DEBUG */
} Arena;



void              arena_init                  (Arena *, void *, size_t);
Arena*            arena_create                (size_t);
void*             arena_alloc                 (Arena *, size_t);
void*             arena_alloc_aligned         (Arena *, size_t, unsigned int);
size_t            arena_copy                  (Arena *, Arena *);
void              arena_clear                 (Arena *);
void              arena_destroy               (Arena *);
#ifdef ARENA_DEBUG
Arena_Allocation* arena_get_allocation_struct (Arena *, void *);
void              arena_add_allocation        (Arena *, size_t );
void              arena_delete_allocation_list(Arena *);
#endif /* ARENA DEBUG */



/*
Initialize an arena object with pointers to the arena and a
pre-allocated region, as well as the size of the provided
region. Good for using the stack instead of the heap, if you
so desire.

Parameters:
  Arena *arena    |   The arena object being initialized.
  void *region    |   The region to be arena-fyed.
  size_t size     |   The size of the region in bytes.
*/
void arena_init(Arena *arena, void *region, size_t size);



/*
Allocate and return a pointer to memory to the arena
with a region with the specified size. Providing a
size of zero results in a failure. Be sure to destory
with arena_destroy later.

Parameters:
  size_t size    |    The size (in bytes) of the arena
                      memory region.
Return:
  Pointer to arena on success, NULL on failure
*/
Arena* arena_create(size_t size);



/*
Return a pointer to a portion of specified size of the
specified arena's region. Nothing will restrict you
from allocating more memory than you specified, so be
mindful of your memory (as you should anyways) or you
will get some hard-to-track bugs. By default, memory is
aligned by alignof(size_t), but you can change this by
#defining ARENA_DEFAULT_ALIGNMENT before #include'ing
arena.h. Providing a size of zero results in a failure.

Parameters:
  Arena *arena    |    The arena of which the pointer
                       from the region will be
                       distributed
  size_t size     |    The size (in bytes) of
                       allocated memory planned to be
                       used.
Return:
  Pointer to arena region segment on success, NULL on
  failure.
*/
void* arena_alloc(Arena *arena, size_t size);



/*
Same as arena_alloc, except you can specify a memory
alignment for allocations.

Return a pointer to a portion of specified size of the
specified arena's region. Nothing will restrict you
from allocating more memory than you specified, so be
mindful of your memory (as you should anyways) or you
will get some hard-to-track bugs. Providing a size of
zero results in a failure.

Parameters:
  Arena *arena              |    The arena of which the pointer
                                 from the region will be
                                 distributed
  size_t size               |    The size (in bytes) of
                                 allocated memory planned to be
                                 used.
  unsigned int alignment    |    Alignment (in bytes) for each
                                 memory allocation.
Return:
  Pointer to arena region segment on success, NULL on
  failure.
*/
void* arena_alloc_aligned(Arena *arena, size_t size, unsigned int alignment);



/*
Copy the memory contents of one arena to another.

Parameters:
  Arena *src     |    The arena being copied, the source.
  Arena *dest    |    The arena being copied to. Must be created/allocated
                      already.

Return:
  Number of bytes copied.
*/
size_t arena_copy(Arena *dest, Arena *src);



/*
Reset the pointer to the arena region to the beginning
of the allocation. Allows reuse of the memory without
expensive frees.

Parameters:
  Arena *arena    |    The arena to be cleared.
*/
void arena_clear(Arena* arena);



/*
Free the memory allocated for the entire arena region.

Parameters:
  Arena *arena    |    The arena to be destroyed.
*/
void arena_destroy(Arena *arena);



#ifdef ARENA_DEBUG



/*
Returns a pointer to the allocation struct associated
with a pointer to a segment in the specified arena's
region.

Parameters:
  Arena *arena    |    The arena whose region should
                       have a portion pointed to by
                       ptr.
  void *ptr       |    The ptr being searched for
                       within the arena in order to
                       find an allocation struct
                       associated with it.
*/
Arena_Allocation* arena_get_allocation_struct(Arena *arena, void *ptr);



/*
Adds an arena allocation to the arena's linked list of
allocations under debug.

Parameters:
  Arena *arena    |    The arena whose allocation list
                       should be added to
  size_t size     |    The size of the allocation being
                       added.
*/
void arena_add_allocation(Arena *arena, size_t size);



/*
Deletes the arena's linked list of allocations under
debug.

Parameters:
  Arena *arena    |    The arena whose allocation list
                       is being deleted.
*/
void arena_delete_allocation_list(Arena *arena);



#endif /* ARENA_DEBUG */



#ifdef ARENA_IMPLEMENTATION



#ifndef ARENA_MALLOC
    #include <stdlib.h>
    #define ARENA_MALLOC malloc
#endif /* !ARENA_MALLOC */



#ifndef ARENA_FREE
    #include <stdlib.h>
    #define ARENA_FREE free
#endif /* !ARENA_FREE */



#ifndef ARENA_MEMCPY
    #include <string.h>
    #define ARENA_MEMCPY memcpy
#endif /* !ARENA_MEMCPY */



void arena_init(Arena *arena, void *region, size_t size)
{
    if (!arena)
    {
        return;
    }
    
    if ((region == NULL) ^ (size == 0))
    {
        return;
    }

    arena->region = region;
    arena->index = 0;
    arena->size = size;

    #ifdef ARENA_DEBUG
    arena->head_allocation = NULL;
    arena->allocations = 0;
    #endif /* ARENA_DEBUG */
}



Arena* arena_create(size_t size)
{
    Arena *arena;
    void *region;

    if (size == 0)
    {
        return NULL;
    }

    /* A malloc of 0 is implementation defined, so the above check is necessary */
    arena = ARENA_MALLOC(sizeof(Arena));
    if (arena == NULL)
    {
        return NULL;
    }

    region = ARENA_MALLOC(size);
    if (region == NULL)
    {
        return NULL;
    }

    arena_init(arena, region, size);

    return arena;
}



void* arena_alloc(Arena *arena, size_t size)
{
    return arena_alloc_aligned(arena, size, ARENA_DEFAULT_ALIGNMENT);
}



void* arena_alloc_aligned(Arena *arena, size_t size, unsigned int alignment)
{
    unsigned int offset;

    if (size == 0)
    {
        return NULL;
    }

    if (arena == NULL || arena->region == NULL)
    {
        return NULL;
    }

    if (alignment != 0)
    {
        offset = (size_t)(arena->region + arena->index) % alignment;
        if (offset > 0)
        {
            arena->index = arena->index - offset + alignment;
        }
    }
    else
    {
        offset = 0;
    }

    if (arena->size - arena->index < size)
    {
        return NULL;
    }

    #ifdef ARENA_DEBUG
    arena_add_allocation(arena, size);
    #endif /* ARENA_DEBUG */

    arena->index += size;
    return arena->region + (arena->index - size);
}



size_t arena_copy(Arena *dest, Arena *src)
{
    size_t bytes;

    if (dest == NULL || src == NULL)
    {
        return 0;
    }

    if (src->index < dest->size)
    {
        bytes = src->index;
    }
    else
    {
        bytes = dest->size;
    }

    ARENA_MEMCPY(dest->region, src->region, bytes);
    dest->index = bytes;

    return bytes;
}



void arena_clear(Arena *arena)
{
    if (arena == NULL)
    {
        return;
    }

    arena->index = 0;

    #ifdef ARENA_DEBUG
    arena_delete_allocation_list(arena);
    #endif /* ARENA_DEBUG */
}



void arena_destroy(Arena *arena)
{
    if (arena == NULL)
    {
        return;
    }

    #ifdef ARENA_DEBUG
    arena_delete_allocation_list(arena);
    #endif /* ARENA_DEBUG */

    if (arena->region != NULL)
    {
        ARENA_FREE(arena->region);
    }

    ARENA_FREE(arena);
}



#ifdef ARENA_DEBUG



Arena_Allocation* arena_get_allocation_struct(Arena *arena, void *ptr)
{
    Arena_Allocation *current;

    if (arena == NULL || ptr == NULL)
    {
        return NULL;
    }

    current = arena->head_allocation;
    while (current != NULL)
    {
        if (current->pointer == (char *)ptr)
        {
            return current;
        }
        current = current->next;
    }

    return NULL;
}



void arena_add_allocation(Arena *arena, size_t size)
{
    if (arena == NULL)
    {
        return;
    }

    if (arena->head_allocation == NULL)
    {
        arena->head_allocation = malloc(sizeof(Arena_Allocation));
        arena->head_allocation->index = arena->index;
        arena->head_allocation->size = size;
        arena->head_allocation->pointer = arena->region + arena->index;
        arena->head_allocation->next = NULL;
    }
    else
    {
        Arena_Allocation *current = arena->head_allocation;
        while (current->next != NULL)
        {
            current = current->next;
        }

        current->next = malloc(sizeof(Arena_Allocation));
        current->next->index = arena->index;
        current->next->size = size;
        current->next->pointer = arena->region + arena->index;
        current->next->next = NULL;
    }

    arena->allocations++;
}



void arena_delete_allocation_list(Arena *arena)
{
    if (arena == NULL)
    {
        return;
    }

    while (arena->head_allocation != NULL)
    {
        Arena_Allocation *next = arena->head_allocation->next;
        free(arena->head_allocation);
        arena->head_allocation = next;
    }

    arena->allocations = 0;
    arena->head_allocation = NULL;
}



#endif /* ARENA_DEBUG */



#endif /* ARENA_IMPLEMENTATION */



#endif /* ARENA_H */