5.3 Memory Management

struct SerdAllocatorImpl

Definition of SerdAllocator.

typedef struct SerdAllocatorImpl SerdAllocator

A memory allocator.

This object-like structure provides an interface like the standard C functions malloc(), calloc(), realloc(), free(), and aligned_alloc(). It contains function pointers that differ from their standard counterparts by taking a context parameter (a pointer to this struct), which allows the user to implement custom stateful allocators.

typedef void *(*SerdAllocatorMallocFunc)(SerdAllocator *allocator, size_t size)

General malloc-like memory allocation function.

This works like the standard C malloc(), except has an additional handle parameter for implementing stateful allocators without static data.

typedef void *(*SerdAllocatorCallocFunc)(SerdAllocator *allocator, size_t nmemb, size_t size)

General calloc-like memory allocation function.

This works like the standard C calloc(), except has an additional handle parameter for implementing stateful allocators without static data.

typedef void *(*SerdAllocatorReallocFunc)(SerdAllocator *allocator, void *ptr, size_t size)

General realloc-like memory reallocation function.

This works like the standard C remalloc(), except has an additional handle parameter for implementing stateful allocators without static data.

typedef void (*SerdAllocatorFreeFunc)(SerdAllocator *allocator, void *ptr)

General free-like memory deallocation function.

This works like the standard C remalloc(), except has an additional handle parameter for implementing stateful allocators without static data.

typedef void *(*SerdAllocatorAlignedAllocFunc)(SerdAllocator *allocator, size_t alignment, size_t size)

General aligned_alloc-like memory deallocation function.

This works like the standard C aligned_alloc(), except has an additional handle parameter for implementing stateful allocators without static data.

typedef void (*SerdAllocatorAlignedFreeFunc)(SerdAllocator *allocator, void *ptr)

General aligned memory deallocation function.

This works like the standard C free(), but must be used to free memory allocated with the aligned_alloc() method of the allocator. This allows portability to systems (like Windows) that can not use the same free function in these cases.

SerdAllocator *serd_default_allocator(void)

Return the default allocator which simply uses the system allocator.

void serd_free(SerdAllocator *allocator, void *ptr)

Free memory allocated by Serd.

This function exists because some systems require memory allocated by a library to be freed by code in the same library. It is otherwise equivalent to the standard C free() function.

This may be used to free memory allocated using serd_default_allocator().