Support multiple allocators, add TLSF allocator and create cmake switches

CMakeLists.txt

@@ -55,6 +55,12 @@ set(
 	CACHE STRING         "Git commit hash (used by CI)"
 )
 
+set(PSN00BSDK_LIBC_ALLOCATORS CUSTOM AFF TLSF)
+set(
+	PSN00BSDK_LIBC_ALLOCATOR AFF
+	CACHE STRING             "Allocator to use in libc implementation (one of ${PSN00BSDK_LIBC_ALLOCATORS})"
+)
+
 # Attempt to automatically select a suitable CMake generator to build libpsn00b
 # and the examples. Only Ninja and makefile-based generators can be used, as
 # other generators (VS and Xcode) do not allow custom toolchains to be used.
@@ -73,6 +79,12 @@ if(NOT LIBPSN00B_GENERATOR MATCHES ".*(Make|Makefiles|Ninja)( Multi-Config)?$")
 	endif()
 endif()
 
+list(FIND PSN00BSDK_LIBC_ALLOCATORS ${PSN00BSDK_LIBC_ALLOCATOR} index)
+if (index EQUAL -1)
+	message(FATAL_ERROR "Invalid allocator: ${PSN00BSDK_LIBC_ALLOCATOR} (must be CUSTOM, AFF or TLSF)")
+endif()
+set(PSN00BSDK_LIBC_ALLOCATOR ${index})
+
 string(TIMESTAMP PSN00BSDK_BUILD_DATE UTC)
 
 # Forward some important variables to mkpsxiso and to the subprojects (they are
@@ -89,6 +101,8 @@ set(
 	-DPSN00BSDK_BUILD_DATE:STRING=${PSN00BSDK_BUILD_DATE}
 	-DPSN00BSDK_GIT_TAG:STRING=${PSN00BSDK_GIT_TAG}
 	-DPSN00BSDK_GIT_COMMIT:STRING=${PSN00BSDK_GIT_COMMIT}
+	-DPSN00BSDK_LIBC_ALLOCATOR:STRING=${PSN00BSDK_LIBC_ALLOCATOR}
+	-DPSN00BSDK_LIBC_ALLOCATORS:STRING=${PSN00BSDK_LIBC_ALLOCATORS}
 )
 set(
 	_tools_args

README.md

@@ -96,8 +96,7 @@ the basics of the graphics and controller APIs.
 
 * `libpsxpress`: Add an API for SPU-ADPCM audio encoding at runtime.
 
-* `libc`: Improve the memory allocation framework with multiple allocators,
-  replace the string functions with optimized implementations and maybe add
+* `libc`: Replace the string functions with optimized implementations and maybe add
   helpers to manage swapping between main RAM and VRAM/SPU RAM.
 
 * Add a full controller and memory card API that does not depend on the BIOS

doc/allocator_implementation.md

@@ -0,0 +1,41 @@
+# Allocator Implementation
+
+Supplying a custom allocator implementation can be done via the
+`CUSTOM` value supplied to the `PSN00BSDK_SDK_ALLOCATOR` cmake
+parameter.
+
+## Functions
+
+Using this variant requires the user to implement several calls
+that are bound as weak functions (via `__attribute__((weak))`)
+within the libc implementation. You are required to implement
+the following to satisfy the `stdlib.h` header:
+
+```c
+void InitHeap(void* addr, size_t size);
+void TrackHeapUsage(ptrdiff_t alloc_incr);
+void GetHeapUsage(HeapUsage* usage);
+
+void* malloc(size_t size);
+void* calloc(size_t num, size_t size);
+void* realloc(void* ptr, size_t size);
+void free(void* ptr);
+```
+
+For reference implementations, see the [aff.c](../libpsn00b/libc/aff.c) and [tlsf.c](../libpsn00b/libc/tlsf.c)
+sources within the SDK.
+
+## Placeholder Details
+
+Internally, the default placeholder implementations that are bound when
+you provide the `CUSTOM` variant via cmake all contain logging statements
+that will cause the application to terminate immediately upon invocation
+of any allocator function calls. For example:
+
+```c
+void* malloc(size_t size) {
+	_sdk_log("[ERROR] Unimplemented custom allocator handle: void* malloc(size_t)\n");
+	abort();
+	return NULL;
+}
+```

doc/cmake_reference.md

@@ -331,6 +331,23 @@ rather than setting this variable.
 `PSN00BSDK_TARGET` must be set regardless of whether or not `PSN00BSDK_TC` is
 also set.
 
+### `PSN00BSDK_LIBC_ALLOCATOR` (`STRING`)
+
+Allocator implementation to use for the libc memory allocation API functions.
+This MUST be one of the following:
+
+1. `AFF`: Allocated first-fit, similar to that of the standard glibc allocator.
+2. `TLSF`: Two-level segregated-fit designed for latency sensitive applications.
+   It has a bounded response time, performs faster than glibc-like allocators
+   and has a lower base overhead and per-allocation overhead.
+3. `CUSTOM`: User-defined implementation of the allocation primitives.
+
+For details on the specific functions required to be implemented as well as any
+additional details, see the documentation on [allocator implementation](./allocator_implementation.md).
+
+**IMPORTANT**: If an allocator is not specified when compliling the SDK, the `AFF` allocator will
+be used by default.
+
 ## Internal settings
 
 These settings are not stored in CMake's cache and can only be set from within

libpsn00b/CMakeLists.txt

@@ -50,6 +50,7 @@ foreach(_library IN LISTS PSN00BSDK_LIBRARIES)
 		)
 
 		target_compile_definitions(${_name} PRIVATE SDK_LIBRARY_NAME="${_library}")
+		target_compile_definitions(${_name} PRIVATE SDK_ALLOC_IMPL=${PSN00BSDK_LIBC_ALLOCATOR})
 	endforeach()
 endforeach()
 

libpsn00b/cmake/internal_setup.cmake

@@ -40,6 +40,9 @@ if(TARGET psn00bsdk)
 endif()
 link_libraries(-lgcc)
 
+# Guaranteed to not be -1 here
+set(PSN00BSDK_LIBC_ALLOCATOR ${index})
+
 # DON'T CHANGE THE ORDER or you'll break the libraries' internal dependencies.
 set(
 	PSN00BSDK_LIBRARIES

libpsn00b/include/assert.h

@@ -14,7 +14,7 @@
 extern "C" {
 #endif
 
-void _assert_abort(const char *file, int line, const char *expr);
+__attribute__((noreturn)) void _assert_abort(const char *file, int line, const char *expr);
 
 #ifdef __cplusplus
 }
@@ -25,6 +25,7 @@ void _assert_abort(const char *file, int line, const char *expr);
 #define assert(expr)
 #define _sdk_log(fmt, ...)
 #define _sdk_assert(expr, fmt, ...)
+#define _sdk_assert_abort(expr, fmt, ...)
 #define _sdk_validate_args_void(expr)
 #define _sdk_validate_args(expr, ret)
 
@@ -46,6 +47,11 @@ void _assert_abort(const char *file, int line, const char *expr);
 		_sdk_log(fmt, __VA_ARGS__); \
 		return ret; \
 	}
+#define _sdk_assert_abort(expr, fmt, ...) \
+	if (!(expr)) { \
+		_sdk_log(fmt, __VA_ARGS__); \
+		assert(expr); \
+	}
 #define _sdk_validate_args_void(expr) \
 	if (!(expr)) { \
 		_sdk_log("invalid args to %s() (%s)\n", __func__, #expr); \

libpsn00b/include/stdlib.h

@@ -30,7 +30,7 @@ extern "C" {
 extern int __argc;
 extern const char **__argv;
 
-void abort(void);
+__attribute__((noreturn)) void abort(void);
 
 int abs(int value);
 int rand(void);
@@ -42,9 +42,9 @@ long long strtoll(const char *str, char **str_end, int base);
 //double strtod(const char *str, char **str_end);
 //long double strtold(const char *str, char **str_end);
 
-void InitHeap(void *addr, size_t size);
 void *sbrk(ptrdiff_t incr);
 
+void InitHeap(void *addr, size_t size);
 void TrackHeapUsage(ptrdiff_t alloc_incr);
 void GetHeapUsage(HeapUsage *usage);