add Memory Management Section description docs/3.1 tip

Sat, 08 Feb 2025 14:24:22 +0100

author
Mike Becker <universe@uap-core.de>
date
Sat, 08 Feb 2025 14:24:22 +0100
branch
docs/3.1
changeset 1170
49cc0bbea6a9
parent 1169
6a33a5648027

add Memory Management Section description

relates to #451

docs/Writerside/topics/memory.md file | annotate | diff | comparison | revisions
--- a/docs/Writerside/topics/memory.md	Sat Feb 08 14:13:59 2025 +0100
+++ b/docs/Writerside/topics/memory.md	Sat Feb 08 14:24:22 2025 +0100
@@ -1,1 +1,13 @@
 # Memory Management
+
+With the `CxAllocator` interface UCX provides the possibility to use custom allocator functions for different purposes.
+Many UCX functions support the use of specialized allocators or provide a second function suffixed with `_a`.
+
+For convenience, functions that are not explicitly requesting an allocator - like e.g. `cx_strdup_a()` - also accept
+`NULL` as an allocator, in which case the `cxDefaultAllocator` and stdlib functions are used.
+
+Additionally, UCX also provides a [memory pool](mempool.h.md) implementation of the allocator interface.
+
+> Although not part of the public API, UCX is also implementing the allocator interface
+> in its own test suite: `CxTestingAllocator`. This allocator keeps track of memory allocations
+> and de-allocations with the goal to detect memory management errors.  

mercurial