mirror of
https://github.com/gnss-sdr/gnss-sdr
synced 2024-06-18 11:09:56 +00:00
67 lines
2.3 KiB
C
67 lines
2.3 KiB
C
/*!
|
|
* \file volk_gnsssdr_malloc.h
|
|
* \brief The volk_gnsssdr_malloc function behaves like malloc in that it
|
|
* returns a pointer to the allocated memory.
|
|
* \author Andres Cecilia, 2014. a.cecilia.luque(at)gmail.com
|
|
*
|
|
* GNSS-SDR is a Global Navigation Satellite System software-defined receiver.
|
|
* This file is part of GNSS-SDR.
|
|
*
|
|
* Copyright (C) 2010-2019 (see AUTHORS file for a list of contributors)
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
*/
|
|
|
|
#ifndef INCLUDED_VOLK_GNSSSDR_MALLOC_H
|
|
#define INCLUDED_VOLK_GNSSSDR_MALLOC_H
|
|
|
|
#include <volk_gnsssdr/volk_gnsssdr_common.h>
|
|
#include <stdlib.h>
|
|
|
|
__VOLK_DECL_BEGIN
|
|
|
|
/*!
|
|
* \brief Allocate \p size bytes of data aligned to \p alignment.
|
|
*
|
|
* \details
|
|
* 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_gnsssdr_malloc may allocate memory, it is
|
|
* important to always free volk_gnsssdr_malloc pointers using volk_gnsssdr_free.
|
|
* Mainly, in case MSVC is used. Consult corresponding documentation
|
|
* in case you use MSVC.
|
|
*
|
|
* \param size The number of bytes to allocate.
|
|
* \param alignment The byte alignment of the allocated memory.
|
|
* \return pointer to aligned memory.
|
|
*/
|
|
VOLK_API void *volk_gnsssdr_malloc(size_t size, size_t alignment);
|
|
|
|
|
|
/*!
|
|
* \brief Free's memory allocated by volk_gnsssdr_malloc.
|
|
*
|
|
* \details
|
|
* 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_gnsssdr_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
|
|
*
|
|
* \param aptr The aligned pointer allocated by volk_gnsssdr_malloc.
|
|
*/
|
|
VOLK_API void volk_gnsssdr_free(void *aptr);
|
|
|
|
__VOLK_DECL_END
|
|
|
|
#endif /* INCLUDED_VOLK_GNSSSDR_MALLOC_H */
|