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