The encoder would crash in the PVQ search if fed NaNs via the float interface. This...
[opus.git] / libcelt / stack_alloc.h
1 /* Copyright (C) 2002-2003 Jean-Marc Valin
2    Copyright (C) 2007-2009 Xiph.Org Foundation */
3 /**
4    @file stack_alloc.h
5    @brief Temporary memory allocation on stack
6 */
7 /*
8    Redistribution and use in source and binary forms, with or without
9    modification, are permitted provided that the following conditions
10    are met:
11    
12    - Redistributions of source code must retain the above copyright
13    notice, this list of conditions and the following disclaimer.
14    
15    - Redistributions in binary form must reproduce the above copyright
16    notice, this list of conditions and the following disclaimer in the
17    documentation and/or other materials provided with the distribution.
18    
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef STACK_ALLOC_H
33 #define STACK_ALLOC_H
34
35 #ifdef USE_ALLOCA
36 # ifdef WIN32
37 #  include <malloc.h>
38 # else
39 #  ifdef HAVE_ALLOCA_H
40 #   include <alloca.h>
41 #  else
42 #   include <stdlib.h>
43 #  endif
44 # endif
45 #endif
46
47 /**
48  * @def ALIGN(stack, size)
49  *
50  * Aligns the stack to a 'size' boundary
51  *
52  * @param stack Stack
53  * @param size  New size boundary
54  */
55
56 /**
57  * @def PUSH(stack, size, type)
58  *
59  * Allocates 'size' elements of type 'type' on the stack
60  *
61  * @param stack Stack
62  * @param size  Number of elements
63  * @param type  Type of element
64  */
65
66 /**
67  * @def VARDECL(var)
68  *
69  * Declare variable on stack
70  *
71  * @param var Variable to declare
72  */
73
74 /**
75  * @def ALLOC(var, size, type)
76  *
77  * Allocate 'size' elements of 'type' on stack
78  *
79  * @param var  Name of variable to allocate
80  * @param size Number of elements
81  * @param type Type of element
82  */
83
84
85 #if defined(VAR_ARRAYS)
86
87 #define VARDECL(type, var)
88 #define ALLOC(var, size, type) type var[size]
89 #define SAVE_STACK
90 #define RESTORE_STACK
91 #define ALLOC_STACK
92
93 #elif defined(USE_ALLOCA)
94
95 #define VARDECL(type, var) type *var
96
97 # ifdef WIN32
98 #  define ALLOC(var, size, type) var = ((type*)_alloca(sizeof(type)*(size)))
99 # else
100 #  define ALLOC(var, size, type) var = ((type*)alloca(sizeof(type)*(size)))
101 # endif
102
103 #define SAVE_STACK
104 #define RESTORE_STACK
105 #define ALLOC_STACK
106
107 #else
108
109 #ifdef CELT_C
110 char *global_stack=0;
111 #else
112 extern char *global_stack;
113 #endif /*CELT_C*/
114
115 #ifdef ENABLE_VALGRIND
116
117 #include <valgrind/memcheck.h>
118
119 #ifdef CELT_C
120 char *global_stack_top=0;
121 #else
122 extern char *global_stack_top;
123 #endif /*CELT_C*/
124
125 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
126 #define PUSH(stack, size, type) (VALGRIND_MAKE_MEM_NOACCESS(stack, global_stack_top-stack),ALIGN((stack),sizeof(type)/sizeof(char)),VALGRIND_MAKE_MEM_UNDEFINED(stack, ((size)*sizeof(type)/sizeof(char))),(stack)+=(2*(size)*sizeof(type)/sizeof(char)),(type*)((stack)-(2*(size)*sizeof(type)/sizeof(char))))
127 #define RESTORE_STACK ((global_stack = _saved_stack),VALGRIND_MAKE_MEM_NOACCESS(global_stack, global_stack_top-global_stack))
128 #define ALLOC_STACK char *_saved_stack; ((global_stack = (global_stack==0) ? ((global_stack_top=celt_alloc_scratch(GLOBAL_STACK_SIZE*2)+(GLOBAL_STACK_SIZE*2))-(GLOBAL_STACK_SIZE*2)) : global_stack),VALGRIND_MAKE_MEM_NOACCESS(global_stack, global_stack_top-global_stack)); _saved_stack = global_stack;
129
130 #else 
131
132 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
133 #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)/sizeof(char)),(stack)+=(size)*(sizeof(type)/sizeof(char)),(type*)((stack)-(size)*(sizeof(type)/sizeof(char))))
134 #define RESTORE_STACK (global_stack = _saved_stack)
135 #define ALLOC_STACK char *_saved_stack; (global_stack = (global_stack==0) ? celt_alloc_scratch(GLOBAL_STACK_SIZE) : global_stack); _saved_stack = global_stack;
136
137 #endif /*ENABLE_VALGRIND*/ 
138
139 #include "os_support.h"
140 #define VARDECL(type, var) type *var
141 #define ALLOC(var, size, type) var = PUSH(global_stack, size, type)
142 #define SAVE_STACK char *_saved_stack = global_stack;
143
144 #endif /*VAR_ARRAYS*/
145
146
147 #endif /*STACK_ALLOC_H*/