Mercurial > hg > ucx / file diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/Writerside/topics/memory.md	Tue Feb 11 19:55:32 2025 +0100
@@ -0,0 +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.