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