GNU Radio 3.7.3 C++ API
volk_malloc.h
Go to the documentation of this file.
1
/* -*- c -*- */
2
/*
3
* Copyright 2014 Free Software Foundation, Inc.
4
*
5
* This file is part of GNU Radio
6
*
7
* GNU Radio is free software; you can redistribute it and/or modify
8
* it under the terms of the GNU General Public License as published by
9
* the Free Software Foundation; either version 3, or (at your option)
10
* any later version.
11
*
12
* GNU Radio is distributed in the hope that it will be useful,
13
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
* GNU General Public License for more details.
16
*
17
* You should have received a copy of the GNU General Public License
18
* along with GNU Radio; see the file COPYING. If not, write to
19
* the Free Software Foundation, Inc., 51 Franklin Street,
20
* Boston, MA 02110-1301, USA.
21
*/
22
23
#ifndef INCLUDED_VOLK_MALLOC_H
24
#define INCLUDED_VOLK_MALLOC_H
25
26
#include <
volk/volk_common.h
>
27
#include <stdlib.h>
28
29
__VOLK_DECL_BEGIN
30
31
/*!
32
* \brief Allocate \p size bytes of data aligned to \p alignment.
33
*
34
* \details
35
* Because we don't have a standard method to allocate buffers in
36
* memory that are guaranteed to be on an alignment, VOLK handles this
37
* itself. The volk_malloc function behaves like malloc in that it
38
* returns a pointer to the allocated memory. However, it also takes
39
* in an alignment specfication, which is usually something like 16 or
40
* 32 to ensure that the aligned memory is located on a particular
41
* byte boundary for use with SIMD.
42
*
43
* Internally, the volk_malloc first checks if the compiler is C11
44
* compliant and uses the new aligned_alloc method. If not, it checks
45
* if the system is POSIX compliant and uses posix_memalign. If that
46
* fails, volk_malloc handles the memory allocation and alignment
47
* internally.
48
*
49
* Because of the ways in which volk_malloc may allocate memory, it is
50
* important to always free volk_malloc pointers using volk_free.
51
*
52
* \param size The number of bytes to allocate.
53
* \param alignment The byte alignment of the allocated memory.
54
* \return pointer to aligned memory.
55
*/
56
VOLK_API
void
*
volk_malloc
(
size_t
size,
size_t
alignment
);
57
58
/*!
59
* \brief Free's memory allocated by volk_malloc.
60
* \param aptr The aligned pointer allocaed by volk_malloc.
61
*/
62
VOLK_API
void
volk_free
(
void
*aptr);
63
64
__VOLK_DECL_END
65
66
#endif
/* INCLUDED_VOLK_MALLOC_H */
gnuradio
volk
include
volk
volk_malloc.h
Generated by
1.8.3.1