8ff8d87c55cc22cd76964a2bc49ebcadc8b490fb
[blender-staging.git] / extern / Eigen2 / Eigen / src / Core / util / Memory.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <g.gael@free.fr>
5 // Copyright (C) 2008-2009 Benoit Jacob <jacob.benoit.1@gmail.com>
6 // Copyright (C) 2009 Kenneth Riddile <kfriddile@yahoo.com>
7 //
8 // Eigen is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU Lesser General Public
10 // License as published by the Free Software Foundation; either
11 // version 3 of the License, or (at your option) any later version.
12 //
13 // Alternatively, you can redistribute it and/or
14 // modify it under the terms of the GNU General Public License as
15 // published by the Free Software Foundation; either version 2 of
16 // the License, or (at your option) any later version.
17 //
18 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
19 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
21 // GNU General Public License for more details.
22 //
23 // You should have received a copy of the GNU Lesser General Public
24 // License and a copy of the GNU General Public License along with
25 // Eigen. If not, see <http://www.gnu.org/licenses/>.
26
27 #ifndef EIGEN_MEMORY_H
28 #define EIGEN_MEMORY_H
29
30 // FreeBSD 6 seems to have 16-byte aligned malloc
31 // See http://svn.freebsd.org/viewvc/base/stable/6/lib/libc/stdlib/malloc.c?view=markup
32 // FreeBSD 7 seems to have 16-byte aligned malloc except on ARM and MIPS architectures
33 // See http://svn.freebsd.org/viewvc/base/stable/7/lib/libc/stdlib/malloc.c?view=markup
34 #if defined(__FreeBSD__) && !defined(__arm__) && !defined(__mips__)
35 #define EIGEN_FREEBSD_MALLOC_ALREADY_ALIGNED 1
36 #else
37 #define EIGEN_FREEBSD_MALLOC_ALREADY_ALIGNED 0
38 #endif
39
40 #include <stddef.h>
41
42 #if defined(__APPLE__) || defined(_WIN64) || EIGEN_FREEBSD_MALLOC_ALREADY_ALIGNED
43   #define EIGEN_MALLOC_ALREADY_ALIGNED 1
44 #else
45   #define EIGEN_MALLOC_ALREADY_ALIGNED 0
46 #endif
47
48 #if ((defined _GNU_SOURCE) || ((defined _XOPEN_SOURCE) && (_XOPEN_SOURCE >= 600))) && (defined _POSIX_ADVISORY_INFO) && (_POSIX_ADVISORY_INFO > 0)
49   #define EIGEN_HAS_POSIX_MEMALIGN 1
50 #else
51   #define EIGEN_HAS_POSIX_MEMALIGN 0
52 #endif
53
54 #ifdef EIGEN_VECTORIZE_SSE
55   #define EIGEN_HAS_MM_MALLOC 1
56 #else
57   #define EIGEN_HAS_MM_MALLOC 0
58 #endif
59
60 /** \internal like malloc, but the returned pointer is guaranteed to be 16-byte aligned.
61   * Fast, but wastes 16 additional bytes of memory.
62   * Does not throw any exception.
63   */
64 inline void* ei_handmade_aligned_malloc(size_t size)
65 {
66   void *original = malloc(size+16);
67   void *aligned = reinterpret_cast<void*>((reinterpret_cast<size_t>(original) & ~(size_t(15))) + 16);
68   *(reinterpret_cast<void**>(aligned) - 1) = original;
69   return aligned;
70 }
71
72 /** \internal frees memory allocated with ei_handmade_aligned_malloc */
73 inline void ei_handmade_aligned_free(void *ptr)
74 {
75   if(ptr)
76     free(*(reinterpret_cast<void**>(ptr) - 1));
77 }
78
79 /** \internal allocates \a size bytes. The returned pointer is guaranteed to have 16 bytes alignment.
80   * On allocation error, the returned pointer is null, and if exceptions are enabled then a std::bad_alloc is thrown.
81   */
82 inline void* ei_aligned_malloc(size_t size)
83 {
84   #ifdef EIGEN_NO_MALLOC
85     ei_assert(false && "heap allocation is forbidden (EIGEN_NO_MALLOC is defined)");
86   #endif
87
88   void *result;  
89   #if !EIGEN_ALIGN
90     result = malloc(size);
91   #elif EIGEN_MALLOC_ALREADY_ALIGNED
92     result = malloc(size);
93   #elif EIGEN_HAS_POSIX_MEMALIGN
94     if(posix_memalign(&result, 16, size)) result = 0;
95   #elif EIGEN_HAS_MM_MALLOC
96     result = _mm_malloc(size, 16);
97   #elif (defined _MSC_VER)
98     result = _aligned_malloc(size, 16);
99   #else
100     result = ei_handmade_aligned_malloc(size);
101   #endif
102     
103   #ifdef EIGEN_EXCEPTIONS
104     if(result == 0)
105       throw std::bad_alloc();
106   #endif
107   return result;
108 }
109
110 /** allocates \a size bytes. If Align is true, then the returned ptr is 16-byte-aligned.
111   * On allocation error, the returned pointer is null, and if exceptions are enabled then a std::bad_alloc is thrown.
112   */
113 template<bool Align> inline void* ei_conditional_aligned_malloc(size_t size)
114 {
115   return ei_aligned_malloc(size);
116 }
117
118 template<> inline void* ei_conditional_aligned_malloc<false>(size_t size)
119 {
120   #ifdef EIGEN_NO_MALLOC
121     ei_assert(false && "heap allocation is forbidden (EIGEN_NO_MALLOC is defined)");
122   #endif
123
124   void *result = malloc(size);
125   #ifdef EIGEN_EXCEPTIONS
126     if(!result) throw std::bad_alloc();
127   #endif
128   return result;
129 }
130
131 /** \internal construct the elements of an array.
132   * The \a size parameter tells on how many objects to call the constructor of T.
133   */
134 template<typename T> inline T* ei_construct_elements_of_array(T *ptr, size_t size)
135 {
136   for (size_t i=0; i < size; ++i) ::new (ptr + i) T;
137   return ptr;
138 }
139
140 /** allocates \a size objects of type T. The returned pointer is guaranteed to have 16 bytes alignment.
141   * On allocation error, the returned pointer is undefined, but if exceptions are enabled then a std::bad_alloc is thrown.
142   * The default constructor of T is called.
143   */
144 template<typename T> inline T* ei_aligned_new(size_t size)
145 {
146   T *result = reinterpret_cast<T*>(ei_aligned_malloc(sizeof(T)*size));
147   return ei_construct_elements_of_array(result, size);
148 }
149
150 template<typename T, bool Align> inline T* ei_conditional_aligned_new(size_t size)
151 {
152   T *result = reinterpret_cast<T*>(ei_conditional_aligned_malloc<Align>(sizeof(T)*size));
153   return ei_construct_elements_of_array(result, size);
154 }
155
156 /** \internal free memory allocated with ei_aligned_malloc
157   */
158 inline void ei_aligned_free(void *ptr)
159 {
160   #if !EIGEN_ALIGN
161     free(ptr);
162   #elif EIGEN_MALLOC_ALREADY_ALIGNED
163     free(ptr);
164   #elif EIGEN_HAS_POSIX_MEMALIGN
165     free(ptr);
166   #elif EIGEN_HAS_MM_MALLOC
167     _mm_free(ptr);
168   #elif defined(_MSC_VER)
169     _aligned_free(ptr);
170   #else
171     ei_handmade_aligned_free(ptr);
172   #endif
173 }
174
175 /** \internal free memory allocated with ei_conditional_aligned_malloc
176   */
177 template<bool Align> inline void ei_conditional_aligned_free(void *ptr)
178 {
179   ei_aligned_free(ptr);
180 }
181
182 template<> inline void ei_conditional_aligned_free<false>(void *ptr)
183 {
184   free(ptr);
185 }
186
187 /** \internal destruct the elements of an array.
188   * The \a size parameters tells on how many objects to call the destructor of T.
189   */
190 template<typename T> inline void ei_destruct_elements_of_array(T *ptr, size_t size)
191 {
192   // always destruct an array starting from the end.
193   while(size) ptr[--size].~T();
194 }
195
196 /** \internal delete objects constructed with ei_aligned_new
197   * The \a size parameters tells on how many objects to call the destructor of T.
198   */
199 template<typename T> inline void ei_aligned_delete(T *ptr, size_t size)
200 {
201   ei_destruct_elements_of_array<T>(ptr, size);
202   ei_aligned_free(ptr);
203 }
204
205 /** \internal delete objects constructed with ei_conditional_aligned_new
206   * The \a size parameters tells on how many objects to call the destructor of T.
207   */
208 template<typename T, bool Align> inline void ei_conditional_aligned_delete(T *ptr, size_t size)
209 {
210   ei_destruct_elements_of_array<T>(ptr, size);
211   ei_conditional_aligned_free<Align>(ptr);
212 }
213
214 /** \internal \returns the number of elements which have to be skipped such that data are 16 bytes aligned */
215 template<typename Scalar>
216 inline static int ei_alignmentOffset(const Scalar* ptr, int maxOffset)
217 {
218   typedef typename ei_packet_traits<Scalar>::type Packet;
219   const int PacketSize = ei_packet_traits<Scalar>::size;
220   const int PacketAlignedMask = PacketSize-1;
221   const bool Vectorized = PacketSize>1;
222   return Vectorized
223           ? std::min<int>( (PacketSize - (int((size_t(ptr)/sizeof(Scalar))) & PacketAlignedMask))
224                            & PacketAlignedMask, maxOffset)
225           : 0;
226 }
227
228 /** \internal
229   * ei_aligned_stack_alloc(SIZE) allocates an aligned buffer of SIZE bytes
230   * on the stack if SIZE is smaller than EIGEN_STACK_ALLOCATION_LIMIT.
231   * Otherwise the memory is allocated on the heap.
232   * Data allocated with ei_aligned_stack_alloc \b must be freed by calling ei_aligned_stack_free(PTR,SIZE).
233   * \code
234   * float * data = ei_aligned_stack_alloc(float,array.size());
235   * // ...
236   * ei_aligned_stack_free(data,float,array.size());
237   * \endcode
238   */
239 #ifdef __linux__
240   #define ei_aligned_stack_alloc(SIZE) (SIZE<=EIGEN_STACK_ALLOCATION_LIMIT) \
241                                     ? alloca(SIZE) \
242                                     : ei_aligned_malloc(SIZE)
243   #define ei_aligned_stack_free(PTR,SIZE) if(SIZE>EIGEN_STACK_ALLOCATION_LIMIT) ei_aligned_free(PTR)
244 #else
245   #define ei_aligned_stack_alloc(SIZE) ei_aligned_malloc(SIZE)
246   #define ei_aligned_stack_free(PTR,SIZE) ei_aligned_free(PTR)
247 #endif
248
249 #define ei_aligned_stack_new(TYPE,SIZE) ei_construct_elements_of_array(reinterpret_cast<TYPE*>(ei_aligned_stack_alloc(sizeof(TYPE)*SIZE)), SIZE)
250 #define ei_aligned_stack_delete(TYPE,PTR,SIZE) do {ei_destruct_elements_of_array<TYPE>(PTR, SIZE); \
251                                                    ei_aligned_stack_free(PTR,sizeof(TYPE)*SIZE);} while(0)
252
253
254 #if EIGEN_ALIGN
255   #ifdef EIGEN_EXCEPTIONS
256     #define EIGEN_MAKE_ALIGNED_OPERATOR_NEW_NOTHROW(NeedsToAlign) \
257       void* operator new(size_t size, const std::nothrow_t&) throw() { \
258         try { return Eigen::ei_conditional_aligned_malloc<NeedsToAlign>(size); } \
259         catch (...) { return 0; } \
260         return 0; \
261       }
262   #else
263     #define EIGEN_MAKE_ALIGNED_OPERATOR_NEW_NOTHROW(NeedsToAlign) \
264       void* operator new(size_t size, const std::nothrow_t&) throw() { \
265         return Eigen::ei_conditional_aligned_malloc<NeedsToAlign>(size); \
266       }
267   #endif
268
269   #define EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF(NeedsToAlign) \
270       void *operator new(size_t size) { \
271         return Eigen::ei_conditional_aligned_malloc<NeedsToAlign>(size); \
272       } \
273       void *operator new[](size_t size) { \
274         return Eigen::ei_conditional_aligned_malloc<NeedsToAlign>(size); \
275       } \
276       void operator delete(void * ptr) throw() { Eigen::ei_conditional_aligned_free<NeedsToAlign>(ptr); } \
277       void operator delete[](void * ptr) throw() { Eigen::ei_conditional_aligned_free<NeedsToAlign>(ptr); } \
278       /* in-place new and delete. since (at least afaik) there is no actual   */ \
279       /* memory allocated we can safely let the default implementation handle */ \
280       /* this particular case. */ \
281       static void *operator new(size_t size, void *ptr) { return ::operator new(size,ptr); } \
282       void operator delete(void * memory, void *ptr) throw() { return ::operator delete(memory,ptr); } \
283       /* nothrow-new (returns zero instead of std::bad_alloc) */ \
284       EIGEN_MAKE_ALIGNED_OPERATOR_NEW_NOTHROW(NeedsToAlign) \
285       void operator delete(void *ptr, const std::nothrow_t&) throw() { \
286         Eigen::ei_conditional_aligned_free<NeedsToAlign>(ptr); \
287       } \
288       typedef void ei_operator_new_marker_type;
289 #else
290   #define EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF(NeedsToAlign)
291 #endif
292
293 #define EIGEN_MAKE_ALIGNED_OPERATOR_NEW EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF(true)
294 #define EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF_VECTORIZABLE_FIXED_SIZE(Scalar,Size) \
295   EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF(((Size)!=Eigen::Dynamic) && ((sizeof(Scalar)*(Size))%16==0))
296
297
298 /** \class aligned_allocator
299 *
300 * \brief stl compatible allocator to use with with 16 byte aligned types
301 *
302 * Example:
303 * \code
304 * // Matrix4f requires 16 bytes alignment:
305 * std::map< int, Matrix4f, std::less<int>, aligned_allocator<Matrix4f> > my_map_mat4;
306 * // Vector3f does not require 16 bytes alignment, no need to use Eigen's allocator:
307 * std::map< int, Vector3f > my_map_vec3;
308 * \endcode
309 *
310 */
311 template<class T>
312 class aligned_allocator
313 {
314 public:
315     typedef size_t    size_type;
316     typedef ptrdiff_t difference_type;
317     typedef T*        pointer;
318     typedef const T*  const_pointer;
319     typedef T&        reference;
320     typedef const T&  const_reference;
321     typedef T         value_type;
322
323     template<class U>
324     struct rebind
325     {
326         typedef aligned_allocator<U> other;
327     };
328
329     pointer address( reference value ) const
330     {
331         return &value;
332     }
333
334     const_pointer address( const_reference value ) const
335     {
336         return &value;
337     }
338
339     aligned_allocator() throw()
340     {
341     }
342
343     aligned_allocator( const aligned_allocator& ) throw()
344     {
345     }
346
347     template<class U>
348     aligned_allocator( const aligned_allocator<U>& ) throw()
349     {
350     }
351
352     ~aligned_allocator() throw()
353     {
354     }
355
356     size_type max_size() const throw()
357     {
358         return std::numeric_limits<size_type>::max();
359     }
360
361     pointer allocate( size_type num, const_pointer* hint = 0 )
362     {
363         static_cast<void>( hint ); // suppress unused variable warning
364         return static_cast<pointer>( ei_aligned_malloc( num * sizeof(T) ) );
365     }
366
367     void construct( pointer p, const T& value )
368     {
369         ::new( p ) T( value );
370     }
371
372     void destroy( pointer p )
373     {
374         p->~T();
375     }
376
377     void deallocate( pointer p, size_type /*num*/ )
378     {
379         ei_aligned_free( p );
380     }
381     
382     bool operator!=(const aligned_allocator<T>& other) const
383     { return false; }
384     
385     bool operator==(const aligned_allocator<T>& other) const
386     { return true; }
387 };
388
389 #endif // EIGEN_MEMORY_H