2 * The copyright in this software is being made available under the 2-clauses
3 * BSD License, included below. This software may be subject to other third
4 * party and contributor rights, including patent rights, and no such rights
5 * are granted under this license.
7 * Copyright (c) 2005, Herve Drolon, FreeImage Team
8 * Copyright (c) 2007, Callum Lerwick <seg@haxxed.com>
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
32 #ifndef __OPJ_MALLOC_H
33 #define __OPJ_MALLOC_H
36 @brief Internal functions
38 The functions in opj_malloc.h are internal utilities used for memory management.
41 /** @defgroup MISC MISC - Miscellaneous internal functions */
44 /** @name Exported functions */
46 /* ----------------------------------------------------------------------- */
49 Allocate an uninitialized memory block
50 @param size Bytes to allocate
51 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
54 void * OPJ_CALLCONV opj_malloc(size_t size);
56 /* prevent assertion on overflow for MSVC */
58 #define opj_malloc(size) ((size_t)(size) >= (size_t)-0x100 ? NULL : malloc(size))
60 #define opj_malloc(size) malloc(size)
65 Allocate a memory block with elements initialized to 0
66 @param num Blocks to allocate
67 @param size Bytes per block to allocate
68 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
71 void * OPJ_CALLCONV opj_calloc(size_t _NumOfElements, size_t _SizeOfElements);
73 /* prevent assertion on overflow for MSVC */
75 #define opj_calloc(num, size) ((size_t)(num) != 0 && (size_t)(num) >= (size_t)-0x100 / (size_t)(size) ? NULL : calloc(num, size))
77 #define opj_calloc(num, size) calloc(num, size)
82 Allocate memory aligned to a 16 byte boundry
83 @param size Bytes to allocate
84 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
86 /* FIXME: These should be set with cmake tests, but we're currently not requiring use of cmake */
88 /* Someone should tell the mingw people that their malloc.h ought to provide _mm_malloc() */
90 #include <mm_malloc.h>
91 #define HAVE_MM_MALLOC
92 #else /* MSVC, Intel C++ */
95 #define HAVE_MM_MALLOC
98 #else /* Not _WIN32 */
100 #define HAVE_MEMALIGN
101 #elif defined(__FreeBSD__)
102 #define HAVE_POSIX_MEMALIGN
103 /* Linux x86_64 and OSX always align allocations to 16 bytes */
104 #elif !defined(__amd64__) && !defined(__APPLE__) && !defined(_AIX)
105 #define HAVE_MEMALIGN
110 #define opj_aligned_malloc(size) malloc(size)
111 #define opj_aligned_free(m) free(m)
113 #ifdef HAVE_MM_MALLOC
114 #undef opj_aligned_malloc
115 #define opj_aligned_malloc(size) _mm_malloc(size, 16)
116 #undef opj_aligned_free
117 #define opj_aligned_free(m) _mm_free(m)
121 extern void* memalign(size_t, size_t);
122 #undef opj_aligned_malloc
123 #define opj_aligned_malloc(size) memalign(16, (size))
124 #undef opj_aligned_free
125 #define opj_aligned_free(m) free(m)
128 #ifdef HAVE_POSIX_MEMALIGN
129 #undef opj_aligned_malloc
130 extern int posix_memalign(void**, size_t, size_t);
132 static INLINE void* __attribute__ ((malloc)) opj_aligned_malloc(size_t size){
134 posix_memalign(&mem, 16, size);
137 #undef opj_aligned_free
138 #define opj_aligned_free(m) free(m)
141 #ifdef ALLOC_PERF_OPT
142 #undef opj_aligned_malloc
143 #define opj_aligned_malloc(size) opj_malloc(size)
144 #undef opj_aligned_free
145 #define opj_aligned_free(m) opj_free(m)
149 Reallocate memory blocks.
150 @param m Pointer to previously allocated memory block
151 @param s New size in bytes
152 @return Returns a void pointer to the reallocated (and possibly moved) memory block
154 #ifdef ALLOC_PERF_OPT
155 void * OPJ_CALLCONV opj_realloc(void * m, size_t s);
157 /* prevent assertion on overflow for MSVC */
159 #define opj_realloc(m, s) ((size_t)(s) >= (size_t)-0x100 ? NULL : realloc(m, s))
161 #define opj_realloc(m, s) realloc(m, s)
166 Deallocates or frees a memory block.
167 @param m Previously allocated memory block to be freed
169 #ifdef ALLOC_PERF_OPT
170 void OPJ_CALLCONV opj_free(void * m);
172 #define opj_free(m) free(m)
176 #pragma GCC poison malloc calloc realloc free
179 /* ----------------------------------------------------------------------- */
184 #endif /* __OPJ_MALLOC_H */