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