[trunk] Start FolderReorgProposal task
[openjpeg.git] / src / lib / openjp2 / opj_malloc.h
diff --git a/src/lib/openjp2/opj_malloc.h b/src/lib/openjp2/opj_malloc.h
new file mode 100644 (file)
index 0000000..0b1d4fc
--- /dev/null
@@ -0,0 +1,163 @@
+/*\r
+ * Copyright (c) 2005, Herve Drolon, FreeImage Team\r
+ * Copyright (c) 2007, Callum Lerwick <seg@haxxed.com>\r
+ * All rights reserved.\r
+ *\r
+ * Redistribution and use in source and binary forms, with or without\r
+ * modification, are permitted provided that the following conditions\r
+ * are met:\r
+ * 1. Redistributions of source code must retain the above copyright\r
+ *    notice, this list of conditions and the following disclaimer.\r
+ * 2. Redistributions in binary form must reproduce the above copyright\r
+ *    notice, this list of conditions and the following disclaimer in the\r
+ *    documentation and/or other materials provided with the distribution.\r
+ *\r
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
+ * POSSIBILITY OF SUCH DAMAGE.\r
+ */\r
+#ifndef __OPJ_MALLOC_H\r
+#define __OPJ_MALLOC_H\r
+/**\r
+@file opj_malloc.h\r
+@brief Internal functions\r
+\r
+The functions in opj_malloc.h are internal utilities used for memory management.\r
+*/\r
+\r
+/** @defgroup MISC MISC - Miscellaneous internal functions */\r
+/*@{*/\r
+\r
+/** @name Exported functions */\r
+/*@{*/\r
+/* ----------------------------------------------------------------------- */\r
+\r
+/**\r
+Allocate an uninitialized memory block\r
+@param size Bytes to allocate\r
+@return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available\r
+*/\r
+#ifdef ALLOC_PERF_OPT\r
+void * OPJ_CALLCONV opj_malloc(size_t size);\r
+#else\r
+#define opj_malloc(size) malloc(size)\r
+#endif\r
+\r
+/**\r
+Allocate a memory block with elements initialized to 0\r
+@param num Blocks to allocate\r
+@param size Bytes per block to allocate\r
+@return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available\r
+*/\r
+#ifdef ALLOC_PERF_OPT\r
+void * OPJ_CALLCONV opj_calloc(size_t _NumOfElements, size_t _SizeOfElements);\r
+#else\r
+#define opj_calloc(num, size) calloc(num, size)\r
+#endif\r
+\r
+/**\r
+Allocate memory aligned to a 16 byte boundry\r
+@param size Bytes to allocate\r
+@return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available\r
+*/\r
+/* FIXME: These should be set with cmake tests, but we're currently not requiring use of cmake */\r
+#ifdef _WIN32\r
+       /* Someone should tell the mingw people that their malloc.h ought to provide _mm_malloc() */\r
+       #ifdef __GNUC__\r
+               #include <mm_malloc.h>\r
+               #define HAVE_MM_MALLOC\r
+       #else /* MSVC, Intel C++ */\r
+               #include <malloc.h>\r
+               #ifdef _mm_malloc\r
+                       #define HAVE_MM_MALLOC\r
+               #endif\r
+       #endif\r
+#else /* Not _WIN32 */\r
+       #if defined(__sun)\r
+               #define HAVE_MEMALIGN\r
+       /* Linux x86_64 and OSX always align allocations to 16 bytes */\r
+       #elif !defined(__amd64__) && !defined(__APPLE__)        \r
+               #define HAVE_MEMALIGN\r
+               #include <malloc.h>                     \r
+       #endif\r
+#endif\r
+\r
+#define opj_aligned_malloc(size) malloc(size)\r
+#define opj_aligned_free(m) free(m)\r
+\r
+#ifdef HAVE_MM_MALLOC\r
+       #undef opj_aligned_malloc\r
+       #define opj_aligned_malloc(size) _mm_malloc(size, 16)\r
+       #undef opj_aligned_free\r
+       #define opj_aligned_free(m) _mm_free(m)\r
+#endif\r
+\r
+#ifdef HAVE_MEMALIGN\r
+       extern void* memalign(size_t, size_t);\r
+       #undef opj_aligned_malloc\r
+       #define opj_aligned_malloc(size) memalign(16, (size))\r
+       #undef opj_aligned_free\r
+       #define opj_aligned_free(m) free(m)\r
+#endif\r
+\r
+#ifdef HAVE_POSIX_MEMALIGN\r
+       #undef opj_aligned_malloc\r
+       extern int posix_memalign(void**, size_t, size_t);\r
+\r
+       static INLINE void* __attribute__ ((malloc)) opj_aligned_malloc(size_t size){\r
+               void* mem = NULL;\r
+               posix_memalign(&mem, 16, size);\r
+               return mem;\r
+       }\r
+       #undef opj_aligned_free\r
+       #define opj_aligned_free(m) free(m)\r
+#endif\r
+\r
+#ifdef ALLOC_PERF_OPT\r
+       #undef opj_aligned_malloc\r
+       #define opj_aligned_malloc(size) opj_malloc(size)\r
+       #undef opj_aligned_free\r
+       #define opj_aligned_free(m) opj_free(m)\r
+#endif\r
+\r
+/**\r
+Reallocate memory blocks.\r
+@param m Pointer to previously allocated memory block\r
+@param s New size in bytes\r
+@return Returns a void pointer to the reallocated (and possibly moved) memory block\r
+*/\r
+#ifdef ALLOC_PERF_OPT\r
+void * OPJ_CALLCONV opj_realloc(void * m, size_t s);\r
+#else\r
+#define opj_realloc(m, s) realloc(m, s)\r
+#endif\r
+\r
+/**\r
+Deallocates or frees a memory block.\r
+@param m Previously allocated memory block to be freed\r
+*/\r
+#ifdef ALLOC_PERF_OPT\r
+void OPJ_CALLCONV opj_free(void * m);\r
+#else\r
+#define opj_free(m) free(m)\r
+#endif\r
+\r
+#ifdef __GNUC__\r
+#pragma GCC poison malloc calloc realloc free\r
+#endif\r
+\r
+/* ----------------------------------------------------------------------- */\r
+/*@}*/\r
+\r
+/*@}*/\r
+\r
+#endif /* __OPJ_MALLOC_H */\r
+\r