3 * Copyright 2008 Free Software Foundation, Inc.
5 * This file is part of GNU Radio
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)
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.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #ifndef INCLUDED_GC_ALIGNED_ALLOC_H
22 #define INCLUDED_GC_ALIGNED_ALLOC_H
24 #include <boost/shared_ptr.hpp>
27 * \brief Return pointer to chunk of storage of size size bytes.
28 * The allocation will be aligned to an \p alignment boundary.
30 * \param size is the number of bytes to allocate
31 * \param alignment is the minimum storage alignment in bytes; must be a power of 2.
33 * Throws if can't allocate memory. The storage should be freed
34 * with "free" when done. The memory is initialized to zero.
37 gc_aligned_alloc(size_t size, size_t alignment = 128);
40 * \brief Return boost::shared_ptr to chunk of storage of size size bytes.
41 * The allocation will be aligned to an \p alignment boundary.
43 * \param size is the number of bytes to allocate
44 * \param alignment is the minimum storage alignment in bytes; must be a power of 2.
46 * Throws if can't allocate memory. The storage should be freed
47 * with "free" when done. The memory is initialized to zero.
49 boost::shared_ptr<void>
50 gc_aligned_alloc_sptr(size_t size, size_t alignment = 128);
52 #endif /* INCLUDED_GC_ALIGNED_ALLOC_H */