FFT cleanup
[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    - Neither the name of the Xiph.org Foundation nor the names of its
20    contributors may be used to endorse or promote products derived from
21    this software without specific prior written permission.
22    
23    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
27    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
35
36 #ifndef STACK_ALLOC_H
37 #define STACK_ALLOC_H
38
39 #ifdef USE_ALLOCA
40 # ifdef WIN32
41 #  include <malloc.h>
42 # else
43 #  ifdef HAVE_ALLOCA_H
44 #   include <alloca.h>
45 #  else
46 #   include <stdlib.h>
47 #  endif
48 # endif
49 #endif
50
51 /**
52  * @def ALIGN(stack, size)
53  *
54  * Aligns the stack to a 'size' boundary
55  *
56  * @param stack Stack
57  * @param size  New size boundary
58  */
59
60 /**
61  * @def PUSH(stack, size, type)
62  *
63  * Allocates 'size' elements of type 'type' on the stack
64  *
65  * @param stack Stack
66  * @param size  Number of elements
67  * @param type  Type of element
68  */
69
70 /**
71  * @def VARDECL(var)
72  *
73  * Declare variable on stack
74  *
75  * @param var Variable to declare
76  */
77
78 /**
79  * @def ALLOC(var, size, type)
80  *
81  * Allocate 'size' elements of 'type' on stack
82  *
83  * @param var  Name of variable to allocate
84  * @param size Number of elements
85  * @param type Type of element
86  */
87
88
89 #if defined(VAR_ARRAYS)
90
91 #define VARDECL(type, var)
92 #define ALLOC(var, size, type) type var[size]
93 #define SAVE_STACK
94 #define RESTORE_STACK
95 #define ALLOC_STACK
96
97 #elif defined(USE_ALLOCA)
98
99 #define VARDECL(type, var) type *var
100 #define ALLOC(var, size, type) var = ((type*)alloca(sizeof(type)*(size)))
101 #define SAVE_STACK
102 #define RESTORE_STACK
103 #define ALLOC_STACK
104
105 #else
106
107 #ifdef CELT_C
108 char *global_stack=0;
109 #else
110 extern char *global_stack;
111 #endif /*CELT_C*/
112
113 #ifdef ENABLE_VALGRIND
114
115 #include <valgrind/memcheck.h>
116
117 #ifdef CELT_C
118 char *global_stack_top=0;
119 #else
120 extern char *global_stack_top;
121 #endif /*CELT_C*/
122
123 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
124 #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))))
125 #define RESTORE_STACK ((global_stack = _saved_stack),VALGRIND_MAKE_MEM_NOACCESS(global_stack, global_stack_top-global_stack))
126 #define ALLOC_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))
127
128 #else 
129
130 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
131 #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)/sizeof(char)),(stack)+=(size)*(sizeof(type)/sizeof(char)),(type*)((stack)-(size)*(sizeof(type)/sizeof(char))))
132 #define RESTORE_STACK (global_stack = _saved_stack)
133 #define ALLOC_STACK (global_stack = (global_stack==0) ? celt_alloc_scratch(GLOBAL_STACK_SIZE) : global_stack)
134
135 #endif /*ENABLE_VALGRIND*/ 
136
137 #include "os_support.h"
138 #define VARDECL(type, var) type *var
139 #define ALLOC(var, size, type) var = PUSH(global_stack, size, type)
140 #define SAVE_STACK char *_saved_stack = global_stack;
141
142 #endif /*VAR_ARRAYS*/
143
144
145 #endif /*STACK_ALLOC_H*/