Failable arena allocation

Failable arena allocation these allocation functions are used when the allocation is not critical and can fail. they also perform less validation on the input parameters than the Arena memory allocation functions. More...

Collaboration diagram for Failable arena allocation:

Functions
CT_ARENA_API void	arena_opt_free (STA_RELEASE void *ptr, size_t size, arena_t *arena)
	release memory from a custom allocator More...
CT_NODISCARD CT_ARENA_API void *	arena_opt_malloc (size_t size, arena_t *arena)
	allocate memory from a custom allocator More...
CT_NODISCARD CT_ARENA_API void *	arena_opt_malloc_info (size_t size, const char *name, const void *parent, arena_t *arena)
	allocate memory from a custom allocator More...
CT_NODISCARD CT_ARENA_API void *	arena_opt_realloc (STA_RELEASE void *ptr, size_t new_size, size_t old_size, arena_t *arena)
	resize a memory allocation from a custom allocator More...
CT_NODISCARD CT_ARENA_API char *	arena_opt_strdup (const char *str, arena_t *arena)
	allocate a copy of a string from a custom allocator More...
CT_NODISCARD CT_ARENA_API char *	arena_opt_strndup (STA_READS(len) const char *str, size_t len, arena_t *arena)
	allocate a copy of a string with a maximum length from a custom allocator More...
CT_NODISCARD CT_ARENA_API void *	arena_opt_memdup (STA_READS(size) const void *ptr, size_t size, arena_t *arena)
	duplicate a memory region from a custom allocator duplicate a region of memory and return a pointer to the new memory. More...

Detailed Description

Failable arena allocation these allocation functions are used when the allocation is not critical and can fail. they also perform less validation on the input parameters than the Arena memory allocation functions.

Function Documentation

arena_opt_free()

CT_ARENA_API void arena_opt_free	(	STA_RELEASE void *	ptr,
		size_t	size,
		arena_t *	arena
	)

release memory from a custom allocator

Precondition

ptr must be allocated from arena

Parameters

arena	the allocator to use
ptr	the pointer to free
size	the size of the allocation

arena_opt_malloc()

CT_NODISCARD CT_ARENA_API void* arena_opt_malloc	(	size_t	size,
		arena_t *	arena
	)

allocate memory from a custom allocator

Precondition

arena must not be NULL

Parameters

arena	the allocator to use
size	the size of the allocation, must be greater than 0

Returns

the allocated pointer

Definition at line 47 of file arena.c.

arena_opt_malloc_info()

CT_NODISCARD CT_ARENA_API void* arena_opt_malloc_info	(	size_t	size,
		const char *	name,
		const void *	parent,
		arena_t *	arena
	)

allocate memory from a custom allocator

Precondition

ptr must be allocated from arena

arena must not be NULL

Parameters

arena	the allocator to use
size	the size of the allocation, must be greater than 0
name	the name of the allocation
parent	the parent of the allocation

Returns

the allocated pointer

Definition at line 56 of file arena.c.

arena_opt_memdup()

CT_NODISCARD CT_ARENA_API void* arena_opt_memdup	(	STA_READS(size) const void *	ptr,
		size_t	size,
		arena_t *	arena
	)

duplicate a memory region from a custom allocator duplicate a region of memory and return a pointer to the new memory.

Precondition

ptr must be a valid pointer to size bytes of memory

arena must not be NULL

Parameters

ptr	the pointer to duplicate
size	the size of the memory to duplicate
arena	the allocator to use

Returns

the duplicated memory

arena_opt_realloc()

CT_NODISCARD CT_ARENA_API void* arena_opt_realloc	(	STA_RELEASE void *	ptr,
		size_t	new_size,
		size_t	old_size,
		arena_t *	arena
	)

resize a memory allocation from a custom allocator

Precondition

ptr must be allocated from arena

Parameters

arena	the allocator to use
ptr	the pointer to reallocate
new_size	the new size of the allocation
old_size	the old size of the allocation

Returns

the reallocated pointer

arena_opt_strdup()

CT_NODISCARD CT_ARENA_API char* arena_opt_strdup	(	const char *	str,
		arena_t *	arena
	)

allocate a copy of a string from a custom allocator

Precondition

str must be a valid, null terminated, string

arena must not be NULL

Parameters

str	the string to copy
arena	the allocator to use

Returns

the allocated copy of the string

allocate a copy of a string from a custom allocator

Definition at line 11 of file arena.c.

arena_opt_strndup()

CT_NODISCARD CT_ARENA_API char* arena_opt_strndup	(	STA_READS(len) const char *	str,
		size_t	len,
		arena_t *	arena
	)

allocate a copy of a string with a maximum length from a custom allocator

Precondition

str must be a valid string of at least len characters

arena must not be NULL

Parameters

str	the string to copy
len	the maximum length of the string to copy
arena	the allocator to use

Returns

the allocated copy of the string