buddy_alloc.c 1.2025.9 → 1.2025.11

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,42 @@ 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
-#include "node_modules/buddy_alloc.c/buddy_alloc.h"
+// main.c
+#define BUDDY_ALLOC_IMPLEMENTATION
+#include <buddy_alloc.h>
+
+int main() { /* ... */ }
+```
+
+Finally, compile while adding 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
 ```
 
+You may also use a simpler approach with the [cpoach](https://www.npmjs.com/package/cpoach.sh) tool, which automatically adds the necessary include paths of all the installed dependencies for your project.
+
+```bash
+$ cpoach clang main.c  # or, use gcc
+$ cpoach gcc   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 +101,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 +130,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 +146,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 +162,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 +206,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 +224,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 +240,7 @@ If you are using buddy_alloc in your project and you would like project to be fe
 <br>
 
 
+[![](https://raw.githubusercontent.com/qb40/designs/gh-pages/0/image/11.png)](https://wolfram77.github.io)<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)

package/buddy_alloc.h

@@ -1413,7 +1413,7 @@ static inline unsigned char *buddy_tree_bits(struct buddy_tree *t);
 static void buddy_tree_populate_size_for_order(struct buddy_tree *t);
 static inline size_t buddy_tree_size_for_order(struct buddy_tree *t, uint8_t to);
 static void write_to_internal_position(struct buddy_tree* t, struct internal_position pos, size_t value);
-static size_t read_from_internal_position(unsigned char *bitset, struct internal_position pos);
+static inline size_t read_from_internal_position(unsigned char *bitset, struct internal_position pos);
 static inline unsigned char compare_with_internal_position(unsigned char *bitset, struct internal_position pos, size_t value);
 
 #ifdef BUDDY_EXPERIMENTAL_CHANGE_TRACKING
@@ -1689,7 +1689,7 @@ static void write_to_internal_position(struct buddy_tree* t, struct internal_pos
 #endif
 }
 
-static size_t read_from_internal_position(unsigned char *bitset, struct internal_position pos) {
+static inline size_t read_from_internal_position(unsigned char *bitset, struct internal_position pos) {
     if (! bitset_test(bitset, pos.bitset_location)) {
         return 0; /* Fast test without complete extraction */
     }
@@ -2066,8 +2066,11 @@ static void bitset_set_range(unsigned char *bitset, struct bitset_range range) {
     } else {
         bitset[range.from_bucket] |= bitset_char_mask[range.from_index][7];
         bitset[range.to_bucket] |= bitset_char_mask[0][range.to_index];
-        while(++range.from_bucket != range.to_bucket) {
-            bitset[range.from_bucket] = 255u;
+
+        range.from_bucket++;
+
+        if (range.to_bucket - range.from_bucket) {
+            memset(bitset + range.from_bucket, 255u, range.to_bucket - range.from_bucket);
         }
     }
 }
@@ -2079,8 +2082,11 @@ static void bitset_clear_range(unsigned char* bitset, struct bitset_range range)
     else {
         bitset[range.from_bucket] &= ~bitset_char_mask[range.from_index][7];
         bitset[range.to_bucket] &= ~bitset_char_mask[0][range.to_index];
-        while (++range.from_bucket != range.to_bucket) {
-            bitset[range.from_bucket] = 0;
+
+        range.from_bucket++;
+
+        if (range.to_bucket - range.from_bucket) {
+            memset(bitset + range.from_bucket, 0, range.to_bucket - range.from_bucket);
         }
     }
 }

package/package.json

@@ -1,15 +1,27 @@
 {
   "name": "buddy_alloc.c",
-  "version": "1.2025.9",
+  "version": "1.2025.11",
   "description": "A single header buddy memory allocator for C & C++; Stanislav Paskalev (2021).",
-  "keywords": ["c", "library", "memory", "allocator", "buddy", "allocation"],
-  "license": "0BSD",
+  "keywords": [
+    "c",
+    "library",
+    "memory",
+    "allocator",
+    "buddy",
+    "allocation"
+  ],
+  "homepage": "https://github.com/nodef/buddy_alloc.c#readme",
+  "bugs": {
+    "url": "https://github.com/nodef/buddy_alloc.c/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nodef/buddy_alloc.c.git"
   },
-  "bugs": {
-    "url": "https://github.com/nodef/buddy_alloc.c/issues"
-  },
-  "homepage": "https://github.com/nodef/buddy_alloc.c#readme"
+  "license": "0BSD",
+  "author": "wolfram77@gmail.com",
+  "main": "buddy_alloc.h",
+  "scripts": {
+    "test": "bash build.sh test"
+  }
 }

package/CMakeLists.txt

@@ -1,21 +0,0 @@
-cmake_minimum_required(VERSION 3.10)
-project(buddy_alloc)
-set(C_STANDARD C99)
-
-# Compile C tests
-project(buddy_tests)
-set(C_STANDARD C99)
-set(SOURCE_FILES tests.c)
-add_executable(buddy_tests ${SOURCE_FILES})
-
-# Compile CPP translation unit
-project(buddy_cpp_translation_unit)
-set(CXX_STANDARD C++11)
-set(SOURCE_FILES testcxx.cpp)
-add_executable(buddy_cpp_translation_unit ${SOURCE_FILES})
-
-# Compile benchmark
-project(buddy_bench)
-set(C_STANDARD C99)
-set(SOURCE_FILES bench.c)
-add_executable(buddy_bench ${SOURCE_FILES})

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-https://github.com/spaskalev/buddy_alloc/discussions.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -1,3 +0,0 @@
-Thank you for your interest in this project! Feel free to file issues, send pull requests and participate in the discussions.
-
-Pull requests should match the coding style where applicable and preserve the test coverage and resiliency characteristics.

package/LICENSE.md

@@ -1,5 +0,0 @@
-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/Makefile

@@ -1,59 +0,0 @@
-#
-# Copyright 2021 Stanislav Paskalev <spaskalev@protonmail.com>
-#
-
-# Disable default implicit rules
-MAKEFLAGS += --no-builtin-rules
-.SUFFIXES:
-
-LLVM_VERSION?=11
-CC?=clang-$(LLVM_VERSION)
-CXX?=clang++-$(LLVM_VERSION)
-CFLAGS?=-std=c99 --coverage -pg -no-pie -fno-builtin -g -O0 -Og -fstrict-aliasing -fstack-protector-all -fsanitize=undefined -fsanitize=bounds -pedantic -Wall -Wextra -Werror -Wfatal-errors -Wformat=2 -Wformat-security -Wconversion -Wcast-qual -Wnull-dereference -Wstack-protector -Warray-bounds -Warray-bounds-pointer-arithmetic -Wassign-enum -Wbad-function-cast -Wconditional-uninitialized -Wfloat-equal -Wformat-type-confusion -Widiomatic-parentheses -Wimplicit-fallthrough -Wloop-analysis -Wpointer-arith -Wshift-sign-overflow -Wshorten-64-to-32 -Wswitch-enum -Wtautological-constant-in-range-compare -Wunreachable-code-aggressive -Wthread-safety -Wthread-safety-beta -Wcomma -Wdeclaration-after-statement -D_FORTIFY_SOURCE=3
-CXXFLAGS?=-std=c++11 --coverage -pg -no-pie -fno-builtin -g -O0 -Og -fstrict-aliasing -fstack-protector-all -fsanitize=undefined -fsanitize=bounds -pedantic -Wall -Wextra -Wformat=2 -Wformat-security -Wconversion -Wcast-qual -Wnull-dereference -Wstack-protector -Warray-bounds -Warray-bounds-pointer-arithmetic -Wassign-enum -Wbad-function-cast -Wconditional-uninitialized -Wfloat-equal -Wformat-type-confusion -Widiomatic-parentheses -Wimplicit-fallthrough -Wloop-analysis -Wpointer-arith -Wshift-sign-overflow -Wshorten-64-to-32 -Wswitch-enum -Wtautological-constant-in-range-compare -Wunreachable-code-aggressive -Wthread-safety -Wthread-safety-beta -Wcomma -Wdeclaration-after-statement -D_FORTIFY_SOURCE=3
-LLVM_COV?=llvm-cov-$(LLVM_VERSION)
-CPPCHECK?=cppcheck
-
-TESTS_SRC=tests.c
-TESTCXX_SRC=testcxx.cpp
-LIB_SRC=buddy_alloc.h
-BENCH_SRC=bench.c
-BENCH_CFLAGS?=-O2
-
-test: tests.out
-	rm -f *.gcda
-	./tests.out
-	$(LLVM_COV) gcov -b $(TESTS_SRC) | paste -s -d ',' | sed -e 's/,,/,\n/' | cut -d ',' -f 1,2,3
-	! grep  '#####:' $(LIB_SRC).gcov
-	! grep -E '^branch\s*[0-9]? never executed$$' $(LIB_SRC).gcov
-
-tests.out: $(TESTS_SRC) $(LIB_SRC) test-cppcheck check-recursion
-	$(CC) $(CFLAGS) $(TESTS_SRC) -o $@
-
-test-cppcheck: $(TESTS_SRC)
-	$(CPPCHECK) --error-exitcode=1 --inline-suppr --quiet $^
-
-test-cpp-translation-unit: $(TESTCXX_SRC)
-	$(CXX) $(CXXFLAGS) $(TESTCXX_SRC) -o $@
-
-test-multiplatform: $(TESTS_SRC)
-	# 64-bit
-	powerpc64-linux-gnu-gcc -static $(TESTS_SRC) && ./a.out
-	aarch64-linux-gnu-gcc -static $(TESTS_SRC) && ./a.out
-	# 32-bit
-	i686-linux-gnu-gcc -static -g tests.c && ./a.out
-	powerpc-linux-gnu-gcc -static $(TESTS_SRC) && ./a.out
-
-bench: $(BENCH_SRC) $(LIB_SRC)
-	$(CC) $(BENCH_CFLAGS) $(BENCH_SRC) -o $@
-	./$@
-
-check-recursion: $(LIB_SRC)
-	[ $$( cflow --no-main $(LIB_SRC) | grep -c 'recursive:' ) -eq "0" ]
-
-clean:
-	rm -f a.out *.gcda *.gcno *.gcov tests.out bench
-
-.PHONY: test clean test-cppcheck
-
-.PRECIOUS: tests.out testcxx.out

package/SECURITY.md

@@ -1,5 +0,0 @@
-# Security Policy
-
-Please report all issues via [GitHub's issues page](https://github.com/spaskalev/buddy_alloc/issues).
-
-If your report contains confidential information you can use GitHub's private reporting of a security vulnerability as documented [here](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability).

package/compile_flags.txt

@@ -1,2 +0,0 @@
--DBUDDY_ALLOC_IMPLEMENTATION
--DBUDDY_EXPERIMENTAL_CHANGE_TRACKING