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"
36 # define SIZE_MAX ((size_t) -1)
39 static INLINE void *opj_aligned_alloc_n(size_t alignment, size_t size)
43 /* alignment shall be power of 2 */
44 assert( (alignment != 0U) && ((alignment & (alignment - 1U)) == 0U));
45 /* alignment shall be at least sizeof(void*) */
46 assert( alignment >= sizeof(void*));
48 if (size == 0U) { /* prevent implementation defined behavior of realloc */
52 #if defined(OPJ_HAVE_POSIX_MEMALIGN)
53 /* aligned_alloc requires c11, restrict to posix_memalign for now. Quote:
54 * This function was introduced in POSIX 1003.1d. Although this function is
55 * superseded by aligned_alloc, it is more portable to older POSIX systems
56 * that do not support ISO C11. */
57 if (posix_memalign (&ptr, alignment, size))
62 #elif defined(OPJ_HAVE_MEMALIGN)
63 ptr = memalign( alignment, size );
65 #elif defined(OPJ_HAVE__ALIGNED_MALLOC)
66 ptr = _aligned_malloc(size, alignment);
69 * Generic aligned malloc implementation.
70 * Uses size_t offset for the integer manipulation of the pointer,
71 * as uintptr_t is not available in C89 to do
72 * bitwise operations on the pointer itself.
79 /* Room for padding and extra pointer stored in front of allocated area */
80 size_t overhead = alignment + sizeof(void *);
82 /* let's be extra careful */
83 assert(alignment <= (SIZE_MAX - sizeof(void *)));
85 /* Avoid integer overflow */
86 if (size > (SIZE_MAX - overhead)) {
90 mem = (OPJ_UINT8*)malloc(size + overhead);
94 /* offset = ((alignment + 1U) - ((size_t)(mem + sizeof(void*)) & alignment)) & alignment; */
95 /* Use the fact that alignment + 1U is a power of 2 */
96 offset = ((alignment ^ ((size_t)(mem + sizeof(void*)) & alignment)) + 1U) & alignment;
97 ptr = (void *)(mem + sizeof(void*) + offset);
98 ((void**) ptr)[-1] = mem;
103 static INLINE void *opj_aligned_realloc_n(void *ptr, size_t alignment, size_t new_size)
107 /* alignment shall be power of 2 */
108 assert( (alignment != 0U) && ((alignment & (alignment - 1U)) == 0U));
109 /* alignment shall be at least sizeof(void*) */
110 assert( alignment >= sizeof(void*));
112 if (new_size == 0U) { /* prevent implementation defined behavior of realloc */
116 /* no portable aligned realloc */
117 #if defined(OPJ_HAVE_POSIX_MEMALIGN) || defined(OPJ_HAVE_MEMALIGN)
118 /* glibc doc states one can mixed aligned malloc with realloc */
119 r_ptr = realloc( ptr, new_size ); /* fast path */
120 /* we simply use `size_t` to cast, since we are only interest in binary AND
122 if( ((size_t)r_ptr & (alignment - 1U)) != 0U ) {
123 /* this is non-trivial to implement a portable aligned realloc, so use a
124 * simple approach where we do not need a function that return the size of an
125 * allocated array (eg. _msize on Windows, malloc_size on MacOS,
126 * malloc_usable_size on systems with glibc) */
127 void *a_ptr = opj_aligned_alloc_n(alignment, new_size);
129 memcpy(a_ptr, r_ptr, new_size);
135 #elif defined(OPJ_HAVE__ALIGNED_MALLOC)
136 r_ptr = _aligned_realloc( ptr, new_size, alignment );
139 return opj_aligned_alloc_n(alignment, new_size);
145 size_t overhead = alignment + sizeof(void *);
147 /* let's be extra careful */
148 assert(alignment <= (SIZE_MAX - sizeof(void *)));
150 /* Avoid integer overflow */
151 if (new_size > SIZE_MAX - overhead) {
155 oldmem = ((void**) ptr)[-1];
156 newmem = (OPJ_UINT8*)realloc(oldmem, new_size + overhead);
157 if (newmem == NULL) {
161 if (newmem == oldmem) {
168 /* realloc created a new copy, realign the copied memory block */
169 old_offset = (size_t)((OPJ_UINT8*)ptr - (OPJ_UINT8*)oldmem);
171 /* offset = ((alignment + 1U) - ((size_t)(mem + sizeof(void*)) & alignment)) & alignment; */
172 /* Use the fact that alignment + 1U is a power of 2 */
173 new_offset = ((alignment ^ ((size_t)(newmem + sizeof(void*)) & alignment)) + 1U) & alignment;
174 new_offset += sizeof(void*);
175 r_ptr = (void *)(newmem + new_offset);
177 if (new_offset != old_offset) {
178 memmove(newmem + new_offset, newmem + old_offset, new_size);
180 ((void**) r_ptr)[-1] = newmem;
186 void * opj_malloc(size_t size)
188 if (size == 0U) { /* prevent implementation defined behavior of realloc */
193 void * opj_calloc(size_t num, size_t size)
195 if (size == 0U) { /* prevent implementation defined behavior of realloc */
198 /* according to C89 standard, num == 0 shall return a valid pointer */
199 return calloc(num, size);
202 void *opj_aligned_malloc(size_t size)
204 return opj_aligned_alloc_n(16U, size);
206 void * opj_aligned_realloc(void *ptr, size_t size)
208 return opj_aligned_realloc_n(ptr, 16U, size);
211 void opj_aligned_free(void* ptr)
213 #if defined(OPJ_HAVE_POSIX_MEMALIGN) || defined(OPJ_HAVE_MEMALIGN)
215 #elif defined(OPJ_HAVE__ALIGNED_MALLOC)
216 _aligned_free( ptr );
218 /* Generic implementation has malloced pointer stored in front of used area */
220 free(((void**) ptr)[-1]);
225 void * opj_realloc(void *ptr, size_t new_size)
227 if (new_size == 0U) { /* prevent implementation defined behavior of realloc */
230 return realloc(ptr, new_size);
232 void opj_free(void *ptr)