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) 2015, Mathieu Malaterre <mathieu.malaterre@gmail.com>
8 * Copyright (c) 2015, Matthieu Darbois
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 #define OPJ_SKIP_POISON
33 #include "opj_includes.h"
35 #if defined(OPJ_HAVE_MALLOC_H) && defined(OPJ_HAVE_MEMALIGN)
40 # define SIZE_MAX ((size_t) -1)
43 static INLINE void *opj_aligned_alloc_n(size_t alignment, size_t size)
47 /* alignment shall be power of 2 */
48 assert( (alignment != 0U) && ((alignment & (alignment - 1U)) == 0U));
49 /* alignment shall be at least sizeof(void*) */
50 assert( alignment >= sizeof(void*));
52 if (size == 0U) { /* prevent implementation defined behavior of realloc */
56 #if defined(OPJ_HAVE_POSIX_MEMALIGN)
57 /* aligned_alloc requires c11, restrict to posix_memalign for now. Quote:
58 * This function was introduced in POSIX 1003.1d. Although this function is
59 * superseded by aligned_alloc, it is more portable to older POSIX systems
60 * that do not support ISO C11. */
61 if (posix_memalign (&ptr, alignment, size))
66 #elif defined(OPJ_HAVE_MEMALIGN)
67 ptr = memalign( alignment, size );
69 #elif defined(OPJ_HAVE__ALIGNED_MALLOC)
70 ptr = _aligned_malloc(size, alignment);
73 * Generic aligned malloc implementation.
74 * Uses size_t offset for the integer manipulation of the pointer,
75 * as uintptr_t is not available in C89 to do
76 * bitwise operations on the pointer itself.
83 /* Room for padding and extra pointer stored in front of allocated area */
84 size_t overhead = alignment + sizeof(void *);
86 /* let's be extra careful */
87 assert(alignment <= (SIZE_MAX - sizeof(void *)));
89 /* Avoid integer overflow */
90 if (size > (SIZE_MAX - overhead)) {
94 mem = (OPJ_UINT8*)malloc(size + overhead);
98 /* offset = ((alignment + 1U) - ((size_t)(mem + sizeof(void*)) & alignment)) & alignment; */
99 /* Use the fact that alignment + 1U is a power of 2 */
100 offset = ((alignment ^ ((size_t)(mem + sizeof(void*)) & alignment)) + 1U) & alignment;
101 ptr = (void *)(mem + sizeof(void*) + offset);
102 ((void**) ptr)[-1] = mem;
107 static INLINE void *opj_aligned_realloc_n(void *ptr, size_t alignment, size_t new_size)
111 /* alignment shall be power of 2 */
112 assert( (alignment != 0U) && ((alignment & (alignment - 1U)) == 0U));
113 /* alignment shall be at least sizeof(void*) */
114 assert( alignment >= sizeof(void*));
116 if (new_size == 0U) { /* prevent implementation defined behavior of realloc */
120 /* no portable aligned realloc */
121 #if defined(OPJ_HAVE_POSIX_MEMALIGN) || defined(OPJ_HAVE_MEMALIGN)
122 /* glibc doc states one can mix aligned malloc with realloc */
123 r_ptr = realloc( ptr, new_size ); /* fast path */
124 /* we simply use `size_t` to cast, since we are only interest in binary AND
126 if( ((size_t)r_ptr & (alignment - 1U)) != 0U ) {
127 /* this is non-trivial to implement a portable aligned realloc, so use a
128 * simple approach where we do not need a function that return the size of an
129 * allocated array (eg. _msize on Windows, malloc_size on MacOS,
130 * malloc_usable_size on systems with glibc) */
131 void *a_ptr = opj_aligned_alloc_n(alignment, new_size);
133 memcpy(a_ptr, r_ptr, new_size);
139 #elif defined(OPJ_HAVE__ALIGNED_MALLOC)
140 r_ptr = _aligned_realloc( ptr, new_size, alignment );
143 return opj_aligned_alloc_n(alignment, new_size);
149 size_t overhead = alignment + sizeof(void *);
151 /* let's be extra careful */
152 assert(alignment <= (SIZE_MAX - sizeof(void *)));
154 /* Avoid integer overflow */
155 if (new_size > SIZE_MAX - overhead) {
159 oldmem = ((void**) ptr)[-1];
160 newmem = (OPJ_UINT8*)realloc(oldmem, new_size + overhead);
161 if (newmem == NULL) {
165 if (newmem == oldmem) {
172 /* realloc created a new copy, realign the copied memory block */
173 old_offset = (size_t)((OPJ_UINT8*)ptr - (OPJ_UINT8*)oldmem);
175 /* offset = ((alignment + 1U) - ((size_t)(mem + sizeof(void*)) & alignment)) & alignment; */
176 /* Use the fact that alignment + 1U is a power of 2 */
177 new_offset = ((alignment ^ ((size_t)(newmem + sizeof(void*)) & alignment)) + 1U) & alignment;
178 new_offset += sizeof(void*);
179 r_ptr = (void *)(newmem + new_offset);
181 if (new_offset != old_offset) {
182 memmove(newmem + new_offset, newmem + old_offset, new_size);
184 ((void**) r_ptr)[-1] = newmem;
190 void * opj_malloc(size_t size)
192 if (size == 0U) { /* prevent implementation defined behavior of realloc */
197 void * opj_calloc(size_t num, size_t size)
199 if (size == 0U) { /* prevent implementation defined behavior of realloc */
202 /* according to C89 standard, num == 0 shall return a valid pointer */
203 return calloc(num, size);
206 void *opj_aligned_malloc(size_t size)
208 return opj_aligned_alloc_n(16U, size);
210 void * opj_aligned_realloc(void *ptr, size_t size)
212 return opj_aligned_realloc_n(ptr, 16U, size);
215 void opj_aligned_free(void* ptr)
217 #if defined(OPJ_HAVE_POSIX_MEMALIGN) || defined(OPJ_HAVE_MEMALIGN)
219 #elif defined(OPJ_HAVE__ALIGNED_MALLOC)
220 _aligned_free( ptr );
222 /* Generic implementation has malloced pointer stored in front of used area */
224 free(((void**) ptr)[-1]);
229 void * opj_realloc(void *ptr, size_t new_size)
231 if (new_size == 0U) { /* prevent implementation defined behavior of realloc */
234 return realloc(ptr, new_size);
236 void opj_free(void *ptr)