buddy_alloc.c 1.2025.9 → 1.2025.10

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright (C) 2021 by Stanislav Paskalev <spaskalev@protonmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

package/README.md

@@ -1,19 +1,24 @@
 # buddy_alloc
-A buddy memory allocator for C, by [Stanislav Paskalev](https://github.com/spaskalev).
 
-# Status
+A buddy memory allocator for C, by [Stanislav Paskalev](https://github.com/spaskalev). [[Latest release](https://github.com/spaskalev/buddy_alloc/releases/latest)]
 
-- [![cicd](https://github.com/spaskalev/buddy_alloc/actions/workflows/main.yml/badge.svg)](https://github.com/spaskalev/buddy_alloc/actions/workflows/main.yml) [![CodeQL](https://github.com/spaskalev/buddy_alloc/actions/workflows/codeql.yml/badge.svg)](https://github.com/spaskalev/buddy_alloc/actions/workflows/codeql.yml)
-- [Latest release](https://github.com/spaskalev/buddy_alloc/releases/latest)
+[![cicd](https://github.com/spaskalev/buddy_alloc/actions/workflows/main.yml/badge.svg)](https://github.com/spaskalev/buddy_alloc/actions/workflows/main.yml) [![CodeQL](https://github.com/spaskalev/buddy_alloc/actions/workflows/codeql.yml/badge.svg)](https://github.com/spaskalev/buddy_alloc/actions/workflows/codeql.yml)
+
+
+<br>
 
 ## Licensing
 
 This project is licensed under the 0BSD license. See the LICENSE.md file for details.
 
+<br>
+
 ## Overview
 
 This is a memory allocator suitable for use in applications that require predictable allocation and deallocation behavior. The allocator's metadata is kept separate from the arena and its size is a function of the arena and minimum allocations sizes.
 
+<br>
+
 ## Features
 
 - Bounded allocation and deallocation cost
@@ -24,18 +29,52 @@ This is a memory allocator suitable for use in applications that require predict
 - Endian-agnostic, works on both LE and BE
 - Compiles with GCC, Clang, MSVC and Pelles C
 
+<br>
+
 ## Installation
 
 Run:
-```bash
+
+```sh
 $ npm i buddy_alloc.c
 ```
 
 And then include `buddy_alloc.h` as follows:
+
 ```c
+// main.c
+#define BUDDY_ALLOC_IMPLEMENTATION
 #include "node_modules/buddy_alloc.c/buddy_alloc.h"
+
+int main() { /* ... */ }
+```
+
+And then compile with `clang` or `gcc` as usual.
+
+```bash
+$ clang main.c  # or, use gcc
+$ gcc   main.c
+```
+
+You may also use a simpler approach:
+
+```c
+// main.c
+#define BUDDY_ALLOC_IMPLEMENTATION
+#include <buddy_alloc.h>
+
+int main() { /* ... */ }
+```
+
+If you add the path `node_modules/buddy_alloc.c` to your compiler's include paths.
+
+```bash
+$ clang -I./node_modules/buddy_alloc.c main.c  # or, use gcc
+$ gcc   -I./node_modules/buddy_alloc.c main.c
 ```
 
+<br>
+
 ## Usage
 
 Initializing and using the buddy allocator with metadata external to the arena is done using the `buddy_init` function.
@@ -72,6 +111,8 @@ buddy_free(buddy, data);
 free(buddy_arena);
 ```
 
+<br>
+
 ## Metadata sizing
 
 The following table documents the allocator metadata space requirements according to desired arena (8MB to 1024GB) and alignment/minimum allocation (64B to 8KB) sizes. The resulting values are rounded up to the nearest unit.
@@ -99,6 +140,8 @@ The following table documents the allocator metadata space requirements accordin
  1024 GB |  8193MB | 4097MB | 2049MB | 1025MB |  513MB |  257MB |  129MB |   65MB |
 ```
 
+<br>
+
 ## Design
 
 The allocator was designed with the following requirements in mind.
@@ -113,6 +156,8 @@ The following were not design goals
 - To be used by multiple threads at the same time without additional locking.
 - To be a general purpose malloc() replacement.
 
+<br>
+
 ## Rationale
 
 ### Why use a custom allocator (like buddy_alloc) ?
@@ -127,6 +172,8 @@ An application developer may also need object allocation that is relocatable. Us
 
 With the introduction of the `buddy_walk` function the allocator can be used to iterate all the allocated slots with its arena. This can be used for example for a space-bounded mailbox where a failure to allocate means the mailbox is full and the walk can be used to process its content. This can also form the basis of a managed heap for garbage collection.
 
+<br>
+
 ## Implementation
 
 ```
@@ -169,7 +216,7 @@ The allocator uses a bitset-backed perfect binary tree to track allocations. The
 
 ### Allocation and deallocation
 
-The binary tree nodes are labeled with the largest allocation slot available under them. This allows allocation to happen with a limited number of operations. Allocations that cannot be satisfied are fast to fail. Once a free node of the desired size is found it is marked as used and the nodes leading to root of the tree are updated to account for any difference in the largest available size. Deallocation works in a similar way - the allocated block size for the given address is found, marked as free and the same node update as with allocation is used to update the tree upwards. 
+The binary tree nodes are labeled with the largest allocation slot available under them. This allows allocation to happen with a limited number of operations. Allocations that cannot be satisfied are fast to fail. Once a free node of the desired size is found it is marked as used and the nodes leading to root of the tree are updated to account for any difference in the largest available size. Deallocation works in a similar way - the allocated block size for the given address is found, marked as free and the same node update as with allocation is used to update the tree upwards.
 
 #### Fragmentation
 
@@ -187,6 +234,8 @@ The perfect binary tree always tracks an arena which size is a power-of-two. Whe
 
 Resizing is available for both split and embedded allocator modes and supports both growing the arena and shrinking it. Checks are present that prevent shrinking the arena when memory that is to be reduced is still allocated.
 
+<br>
+
 ## Users
 
 If you are using buddy_alloc in your project and you would like project to be featured here please send a PR or file an issue. If you like buddy_alloc please star it on GitHub so that more users can learn of it. Thanks!
@@ -201,5 +250,6 @@ If you are using buddy_alloc in your project and you would like project to be fe
 <br>
 
 
+[![SRC](https://img.shields.io/badge/src-repo-green?logo=Org)](https://github.com/spaskalev/buddy_alloc)
 [![ORG](https://img.shields.io/badge/org-nodef-green?logo=Org)](https://nodef.github.io)
 ![](https://ga-beacon.deno.dev/G-RC63DPBH3P:SH3Eq-NoQ9mwgYeHWxu7cw/github.com/nodef/buddy_alloc.c)