src/lib/openjp2/opj_malloc.c

   1 /*
   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.
   6  *
   7  * Copyright (c) 2015, Mathieu Malaterre <mathieu.malaterre@gmail.com>
   8  * Copyright (c) 2015, Matthieu Darbois
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  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.
  19  *
  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.
  31  */
  32 #define OPJ_SKIP_POISON
  33 #include "opj_includes.h"
  34
  35 static INLINE void *opj_aligned_alloc_n(size_t alignment, size_t size)
  36 {
  37   void* ptr;
  38
  39   /* alignment shall be power of 2 */
  40   assert( (alignment != 0U) && ((alignment & (alignment - 1U)) == 0U));
  41
  42   if (size == 0U) { /* prevent implementation defined behavior of realloc */
  43     return NULL;
  44   }
  45
  46 #if defined(HAVE_POSIX_MEMALIGN)
  47   /* aligned_alloc requires c11, restrict to posix_memalign for now. Quote:
  48    * This function was introduced in POSIX 1003.1d. Although this function is
  49    * superseded by aligned_alloc, it is more portable to older POSIX systems
  50    * that do not support ISO C11.  */
  51   if (posix_memalign (&ptr, alignment, size))
  52   {
  53     ptr = NULL;
  54   }
  55   /* older linux */
  56 #elif defined(HAVE_MEMALIGN)
  57   ptr = memalign( alignment, size );
  58 /* _MSC_VER */
  59 #elif defined(HAVE__ALIGNED_MALLOC)
  60   ptr = _aligned_malloc(size, alignment);
  61 #else
  62 /* TODO: _mm_malloc(x,y) */
  63 #error missing aligned alloc function
  64 #endif
  65   return ptr;
  66 }
  67 static INLINE void *opj_aligned_realloc_n(void *ptr, size_t alignment, size_t new_size)
  68 {
  69   void *r_ptr;
  70
  71   /* alignment shall be power of 2 */
  72   assert( (alignment != 0U) && ((alignment & (alignment - 1U)) == 0U));
  73
  74   if (new_size == 0U) { /* prevent implementation defined behavior of realloc */
  75     return NULL;
  76   }
  77
  78 /* no portable aligned realloc */
  79 #if defined(HAVE_POSIX_MEMALIGN) || defined(HAVE_MEMALIGN)
  80   /* glibc doc states one can mixed aligned malloc with realloc */
  81   r_ptr = realloc( ptr, new_size ); /* fast path */
  82   /* we simply use `size_t` to cast, since we are only interest in binary AND
  83    * operator */
  84   if( ((size_t)r_ptr & (alignment - 1U)) != 0U ) {
  85     /* this is non-trivial to implement a portable aligned realloc, so use a
  86      * simple approach where we do not need a function that return the size of an
  87      * allocated array (eg. _msize on Windows, malloc_size on MacOS,
  88      * malloc_usable_size on systems with glibc) */
  89     void *a_ptr = opj_aligned_alloc_n(alignment, new_size);
  90     if (a_ptr != NULL) {
  91       memcpy(a_ptr, r_ptr, new_size);
  92     }
  93     free( r_ptr );
  94     r_ptr = a_ptr;
  95   }
  96 /* _MSC_VER */
  97 #elif defined(HAVE__ALIGNED_MALLOC)
  98   r_ptr = _aligned_realloc( ptr, new_size, alignment );
  99 #else
 100 /* TODO: _mm_malloc(x,y) */
 101 #error missing aligned realloc function
 102 #endif
 103         return r_ptr;
 104 }
 105 void * opj_malloc(size_t size)
 106 {
 107   if (size == 0U) { /* prevent implementation defined behavior of realloc */
 108     return NULL;
 109   }
 110   return malloc(size);
 111 }
 112 void * opj_calloc(size_t num, size_t size)
 113 {
 114   if (size == 0U) { /* prevent implementation defined behavior of realloc */
 115     return NULL;
 116   }
 117   /* according to C89 standard, num == 0 shall return a valid pointer */
 118   return calloc(num, size);
 119 }
 120
 121 void *opj_aligned_malloc(size_t size)
 122 {
 123   return opj_aligned_alloc_n(16U, size);
 124 }
 125 void * opj_aligned_realloc(void *ptr, size_t size)
 126 {
 127   return opj_aligned_realloc_n(ptr, 16U, size);
 128 }
 129
 130 void opj_aligned_free(void* ptr)
 131 {
 132 #ifdef HAVE__ALIGNED_MALLOC
 133   _aligned_free( ptr );
 134 #else
 135   free( ptr );
 136 #endif
 137 }
 138
 139 void * opj_realloc(void *ptr, size_t new_size)
 140 {
 141   if (new_size == 0U) { /* prevent implementation defined behavior of realloc */
 142     return NULL;
 143   }
 144   return realloc(ptr, new_size);
 145 }
 146 void opj_free(void *ptr)
 147 {
 148   free(ptr);
 149 }