src/lib/openjp2/opj_malloc.h

   1 /*\r
   2  * Copyright (c) 2005, Herve Drolon, FreeImage Team\r
   3  * Copyright (c) 2007, Callum Lerwick <seg@haxxed.com>\r
   4  * All rights reserved.\r
   5  *\r
   6  * Redistribution and use in source and binary forms, with or without\r
   7  * modification, are permitted provided that the following conditions\r
   8  * are met:\r
   9  * 1. Redistributions of source code must retain the above copyright\r
  10  *    notice, this list of conditions and the following disclaimer.\r
  11  * 2. Redistributions in binary form must reproduce the above copyright\r
  12  *    notice, this list of conditions and the following disclaimer in the\r
  13  *    documentation and/or other materials provided with the distribution.\r
  14  *\r
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
  16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
  19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
  20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
  21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
  24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
  25  * POSSIBILITY OF SUCH DAMAGE.\r
  26  */\r
  27 #ifndef __OPJ_MALLOC_H\r
  28 #define __OPJ_MALLOC_H\r
  29 /**\r
  30 @file opj_malloc.h\r
  31 @brief Internal functions\r
  32 \r
  33 The functions in opj_malloc.h are internal utilities used for memory management.\r
  34 */\r
  35 \r
  36 /** @defgroup MISC MISC - Miscellaneous internal functions */\r
  37 /*@{*/\r
  38 \r
  39 /** @name Exported functions */\r
  40 /*@{*/\r
  41 /* ----------------------------------------------------------------------- */\r
  42 \r
  43 /**\r
  44 Allocate an uninitialized memory block\r
  45 @param size Bytes to allocate\r
  46 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available\r
  47 */\r
  48 #ifdef ALLOC_PERF_OPT\r
  49 void * OPJ_CALLCONV opj_malloc(size_t size);\r
  50 #else\r
  51 #define opj_malloc(size) malloc(size)\r
  52 #endif\r
  53 \r
  54 /**\r
  55 Allocate a memory block with elements initialized to 0\r
  56 @param num Blocks to allocate\r
  57 @param size Bytes per block to allocate\r
  58 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available\r
  59 */\r
  60 #ifdef ALLOC_PERF_OPT\r
  61 void * OPJ_CALLCONV opj_calloc(size_t _NumOfElements, size_t _SizeOfElements);\r
  62 #else\r
  63 #define opj_calloc(num, size) calloc(num, size)\r
  64 #endif\r
  65 \r
  66 /**\r
  67 Allocate memory aligned to a 16 byte boundry\r
  68 @param size Bytes to allocate\r
  69 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available\r
  70 */\r
  71 /* FIXME: These should be set with cmake tests, but we're currently not requiring use of cmake */\r
  72 #ifdef _WIN32\r
  73         /* Someone should tell the mingw people that their malloc.h ought to provide _mm_malloc() */\r
  74         #ifdef __GNUC__\r
  75                 #include <mm_malloc.h>\r
  76                 #define HAVE_MM_MALLOC\r
  77         #else /* MSVC, Intel C++ */\r
  78                 #include <malloc.h>\r
  79                 #ifdef _mm_malloc\r
  80                         #define HAVE_MM_MALLOC\r
  81                 #endif\r
  82         #endif\r
  83 #else /* Not _WIN32 */\r
  84         #if defined(__sun)\r
  85                 #define HAVE_MEMALIGN\r
  86         /* Linux x86_64 and OSX always align allocations to 16 bytes */\r
  87         #elif !defined(__amd64__) && !defined(__APPLE__)        \r
  88                 #define HAVE_MEMALIGN\r
  89                 #include <malloc.h>                     \r
  90         #endif\r
  91 #endif\r
  92 \r
  93 #define opj_aligned_malloc(size) malloc(size)\r
  94 #define opj_aligned_free(m) free(m)\r
  95 \r
  96 #ifdef HAVE_MM_MALLOC\r
  97         #undef opj_aligned_malloc\r
  98         #define opj_aligned_malloc(size) _mm_malloc(size, 16)\r
  99         #undef opj_aligned_free\r
 100         #define opj_aligned_free(m) _mm_free(m)\r
 101 #endif\r
 102 \r
 103 #ifdef HAVE_MEMALIGN\r
 104         extern void* memalign(size_t, size_t);\r
 105         #undef opj_aligned_malloc\r
 106         #define opj_aligned_malloc(size) memalign(16, (size))\r
 107         #undef opj_aligned_free\r
 108         #define opj_aligned_free(m) free(m)\r
 109 #endif\r
 110 \r
 111 #ifdef HAVE_POSIX_MEMALIGN\r
 112         #undef opj_aligned_malloc\r
 113         extern int posix_memalign(void**, size_t, size_t);\r
 114 \r
 115         static INLINE void* __attribute__ ((malloc)) opj_aligned_malloc(size_t size){\r
 116                 void* mem = NULL;\r
 117                 posix_memalign(&mem, 16, size);\r
 118                 return mem;\r
 119         }\r
 120         #undef opj_aligned_free\r
 121         #define opj_aligned_free(m) free(m)\r
 122 #endif\r
 123 \r
 124 #ifdef ALLOC_PERF_OPT\r
 125         #undef opj_aligned_malloc\r
 126         #define opj_aligned_malloc(size) opj_malloc(size)\r
 127         #undef opj_aligned_free\r
 128         #define opj_aligned_free(m) opj_free(m)\r
 129 #endif\r
 130 \r
 131 /**\r
 132 Reallocate memory blocks.\r
 133 @param m Pointer to previously allocated memory block\r
 134 @param s New size in bytes\r
 135 @return Returns a void pointer to the reallocated (and possibly moved) memory block\r
 136 */\r
 137 #ifdef ALLOC_PERF_OPT\r
 138 void * OPJ_CALLCONV opj_realloc(void * m, size_t s);\r
 139 #else\r
 140 #define opj_realloc(m, s) realloc(m, s)\r
 141 #endif\r
 142 \r
 143 /**\r
 144 Deallocates or frees a memory block.\r
 145 @param m Previously allocated memory block to be freed\r
 146 */\r
 147 #ifdef ALLOC_PERF_OPT\r
 148 void OPJ_CALLCONV opj_free(void * m);\r
 149 #else\r
 150 #define opj_free(m) free(m)\r
 151 #endif\r
 152 \r
 153 #ifdef __GNUC__\r
 154 #pragma GCC poison malloc calloc realloc free\r
 155 #endif\r
 156 \r
 157 /* ----------------------------------------------------------------------- */\r
 158 /*@}*/\r
 159 \r
 160 /*@}*/\r
 161 \r
 162 #endif /* __OPJ_MALLOC_H */\r
 163 \r