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
55 void * OPJ_CALLCONV opj_malloc(size_t size);
57 /* prevent assertion on overflow for MSVC */
59 #define opj_malloc(size) ((size_t)(size) >= (size_t)-0x100 ? NULL : malloc(size))
61 #define opj_malloc(size) malloc(size)
66 Allocate a memory block with elements initialized to 0
67 @param num Blocks to allocate
68 @param size Bytes per block to allocate
69 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
72 void * OPJ_CALLCONV opj_calloc(size_t _NumOfElements, size_t _SizeOfElements);
74 /* prevent assertion on overflow for MSVC */
76 #define opj_calloc(num, size) ((size_t)(num) != 0 && (size_t)(num) >= (size_t)-0x100 / (size_t)(size) ? NULL : calloc(num, size))
78 #define opj_calloc(num, size) calloc(num, size)
83 Allocate memory aligned to a 16 byte boundry
84 @param size Bytes to allocate
85 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
87 /* FIXME: These should be set with cmake tests, but we're currently not requiring use of cmake */
89 /* Someone should tell the mingw people that their malloc.h ought to provide _mm_malloc() */
91 #include <mm_malloc.h>
92 #define HAVE_MM_MALLOC
93 #else /* MSVC, Intel C++ */
96 #define HAVE_MM_MALLOC
99 #else /* Not _WIN32 */
101 #define HAVE_MEMALIGN
102 #elif defined(__FreeBSD__)
103 #define HAVE_POSIX_MEMALIGN
104 /* Linux x86_64 and OSX always align allocations to 16 bytes */
105 #elif !defined(__amd64__) && !defined(__APPLE__) && !defined(_AIX)
106 #define HAVE_MEMALIGN
111 #define opj_aligned_malloc(size) malloc(size)
112 #define opj_aligned_free(m) free(m)
114 #ifdef HAVE_MM_MALLOC
115 #undef opj_aligned_malloc
116 #define opj_aligned_malloc(size) _mm_malloc(size, 16)
117 #undef opj_aligned_free
118 #define opj_aligned_free(m) _mm_free(m)
122 extern void* memalign(size_t, size_t);
123 #undef opj_aligned_malloc
124 #define opj_aligned_malloc(size) memalign(16, (size))
125 #undef opj_aligned_free
126 #define opj_aligned_free(m) free(m)
129 #ifdef HAVE_POSIX_MEMALIGN
130 #undef opj_aligned_malloc
131 extern int posix_memalign(void**, size_t, size_t);
133 static INLINE void* __attribute__ ((malloc)) opj_aligned_malloc(size_t size){
135 posix_memalign(&mem, 16, size);
138 #undef opj_aligned_free
139 #define opj_aligned_free(m) free(m)
142 #ifdef ALLOC_PERF_OPT
143 #undef opj_aligned_malloc
144 #define opj_aligned_malloc(size) opj_malloc(size)
145 #undef opj_aligned_free
146 #define opj_aligned_free(m) opj_free(m)
150 Reallocate memory blocks.
151 @param m Pointer to previously allocated memory block
152 @param s New size in bytes
153 @return Returns a void pointer to the reallocated (and possibly moved) memory block
155 #ifdef ALLOC_PERF_OPT
156 void * OPJ_CALLCONV opj_realloc(void * m, size_t s);
158 /* prevent assertion on overflow for MSVC */
160 #define opj_realloc(m, s) ((size_t)(s) >= (size_t)-0x100 ? NULL : realloc(m, s))
162 #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 */