volk_malloc.h File Reference

#include <stdlib.h>
#include <volk/volk_common.h>

Go to the source code of this file.

Functions
__VOLK_DECL_BEGIN VOLK_API void *	volk_malloc (size_t size, size_t alignment)
	Allocate size bytes of data aligned to alignment. More...
VOLK_API void	volk_free (void *aptr)
	Free's memory allocated by volk_malloc. More...

Function Documentation

volk_free()

VOLK_API void volk_free

(

void *

aptr

)

Free's memory allocated by volk_malloc.

We rely on C11 syntax and compilers and just call free in case memory was allocated with aligned_alloc or posix_memalign. Thus, in this case volk_free inherits the same behavior free exhibits. see: https://en.cppreference.com/w/c/memory/free In case _aligned_malloc was used, we call _aligned_free. see: https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/aligned-free?view=vs-2019

Parameters

aptr	The aligned pointer allocated by volk_malloc.

volk_malloc()

__VOLK_DECL_BEGIN VOLK_API void* volk_malloc	(	size_t	size,
		size_t	alignment
	)

Allocate size bytes of data aligned to alignment.

We use C11 and want to rely on C11 library features, namely we use aligned_alloc to allocate aligned memory. see: https://en.cppreference.com/w/c/memory/aligned_alloc

Not all platforms support this feature. For Apple Clang, we fall back to posix_memalign. see: https://linux.die.net/man/3/aligned_alloc For MSVC, we fall back to _aligned_malloc. see: https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/aligned-malloc?view=vs-2019

Because of the ways in which volk_malloc may allocate memory, it is important to always free volk_malloc pointers using volk_free. Mainly, in case MSVC is used. Consult corresponding documentation in case you use MSVC.

Parameters

size	The number of bytes to allocate.
alignment	The byte alignment of the allocated memory.

Returns

pointer to aligned memory.