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