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 COPYRIGHT OWNER
23 OR 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 #include "opus_types.h"
36 #include "opus_defines.h"
37
38 #if (!defined (VAR_ARRAYS) && !defined (USE_ALLOCA) && !defined (NONTHREADSAFE_PSEUDOSTACK))
39 #error "Opus requires one of VAR_ARRAYS, USE_ALLOCA, or NONTHREADSAFE_PSEUDOSTACK be defined to select the temporary allocation mode."
40 #endif
41
42 #ifdef USE_ALLOCA
43 # ifdef _WIN32
44 # include <malloc.h>
45 # else
46 # ifdef HAVE_ALLOCA_H
47 # include <alloca.h>
48 # else
49 # include <stdlib.h>
50 # endif
51 # endif
52 #endif
53
54 /**
55 * @def ALIGN(stack, size)
56 *
57 * Aligns the stack to a 'size' boundary
58 *
59 * @param stack Stack
60 * @param size New size boundary
61 */
62
63 /**
64 * @def PUSH(stack, size, type)
65 *
66 * Allocates 'size' elements of type 'type' on the stack
67 *
68 * @param stack Stack
69 * @param size Number of elements
70 * @param type Type of element
71 */
72
73 /**
74 * @def VARDECL(var)
75 *
76 * Declare variable on stack
77 *
78 * @param var Variable to declare
79 */
80
81 /**
82 * @def ALLOC(var, size, type)
83 *
84 * Allocate 'size' elements of 'type' on stack
85 *
86 * @param var Name of variable to allocate
87 * @param size Number of elements
88 * @param type Type of element
89 */
90
91 #ifndef SIMD_EXTRA_ALLOC_BYTES
92 #error define SIMD_EXTRA_ALLOC_BYTES appropriately in your makefile
93 /*
94 * Useful values:
95 * 0 for an all-scalar processor, which should never over-read the arrays
96 * 16 for an implementation using ARM Neon or X86 SSE4 instructions, which work
97 * with blocks of 16 bytes (128 bits)
98 */
99 #endif
100
101 #if defined(VAR_ARRAYS)
102
103 #define VARDECL(type, var)
104 // include a full SIMD width afterwards;
105 #define ALLOC(var, size, type) type var[(size) + ((SIMD_EXTRA_ALLOC_BYTES)/sizeof(type))]
106
107 #define SAVE_STACK
108 #define RESTORE_STACK
109 #define ALLOC_STACK
110 /* C99 does not allow VLAs of size zero */
111 #define ALLOC_NONE 1
112
113 #elif defined(USE_ALLOCA)
114
115 #define VARDECL(type, var) type *var
116
117 # ifdef _WIN32
118 # define ALLOC(var, size, type) var = \
119 ((type*)_alloca(sizeof(type)*(size) + SIMD_EXTRA_ALLOC_BYTES))
120 # else
121 # define ALLOC(var, size, type) var = \
122 ((type*)alloca(sizeof(type)*(size) + SIMD_EXTRA_ALLOC_BYTES))
123 # endif
124
125 #define SAVE_STACK
126 #define RESTORE_STACK
127 #define ALLOC_STACK
128 #define ALLOC_NONE 0
129
130 #else
131
132 #ifdef CELT_C
133 char *scratch_ptr=0;
134 char *global_stack=0;
135 #else
136 extern char *global_stack;
137 extern char *scratch_ptr;
138 #endif /* CELT_C */
139
140 #ifdef ENABLE_VALGRIND
141
142 #include <valgrind/memcheck.h>
143
144 #ifdef CELT_C
145 char *global_stack_top=0;
146 #else
147 extern char *global_stack_top;
148 #endif /* CELT_C */
149
150 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
151 #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))))
152 #define RESTORE_STACK ((global_stack = _saved_stack),VALGRIND_MAKE_MEM_NOACCESS(global_stack, global_stack_top-global_stack))
153 #define ALLOC_STACK char *_saved_stack; ((global_stack = (global_stack==0) ? ((global_stack_top=opus_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;
154
155 #else
156
157 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
158 #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)/(sizeof(char))),(stack)+=(size)*(sizeof(type)/(sizeof(char))),(type*)((stack)-(size)*(sizeof(type)/(sizeof(char)))))
159 #if 0 /* Set this to 1 to instrument pseudostack usage */
160 #define RESTORE_STACK (printf("%ld %s:%d\n", global_stack-scratch_ptr, __FILE__, __LINE__),global_stack = _saved_stack)
161 #else
162 #define RESTORE_STACK (global_stack = _saved_stack)
163 #endif
164 #define ALLOC_STACK char *_saved_stack; (global_stack = (global_stack==0) ? (scratch_ptr=opus_alloc_scratch(GLOBAL_STACK_SIZE)) : global_stack); _saved_stack = global_stack;
165
166 #endif /* ENABLE_VALGRIND */
167
168 // this path has NOT been modified to be safe in the face of SIMD over-reads
169 #if SIMD_EXTRA_ALLOC_BYTES != 0
170 #error "ALLOC() is not updated in this configuration to provide for SIMD over-reads"
171 #endif
172
173 #include "os_support.h"
174 #define VARDECL(type, var) type *var
175 #define ALLOC(var, size, type) var = PUSH(global_stack, size, type)
176 #define SAVE_STACK char *_saved_stack = global_stack;
177 #define ALLOC_NONE 0
178
179 #endif /* VAR_ARRAYS */
180
181
182 #ifdef ENABLE_VALGRIND
183
184 #include <valgrind/memcheck.h>
185 #define OPUS_CHECK_ARRAY(ptr, len) VALGRIND_CHECK_MEM_IS_DEFINED(ptr, len*sizeof(*ptr))
186 #define OPUS_CHECK_VALUE(value) VALGRIND_CHECK_VALUE_IS_DEFINED(value)
187 #define OPUS_CHECK_ARRAY_COND(ptr, len) VALGRIND_CHECK_MEM_IS_DEFINED(ptr, len*sizeof(*ptr))
188 #define OPUS_CHECK_VALUE_COND(value) VALGRIND_CHECK_VALUE_IS_DEFINED(value)
189 #define OPUS_PRINT_INT(value) do {fprintf(stderr, #value " = %d at %s:%d\n", value, __FILE__, __LINE__);}while(0)
190 #define OPUS_FPRINTF fprintf
191
192 #else
193
_opus_false(void)194 static OPUS_INLINE int _opus_false(void) {return 0;}
195 #define OPUS_CHECK_ARRAY(ptr, len) _opus_false()
196 #define OPUS_CHECK_VALUE(value) _opus_false()
197 #define OPUS_PRINT_INT(value) do{}while(0)
198 #define OPUS_FPRINTF (void)
199
200 #endif
201
202
203 #endif /* STACK_ALLOC_H */
204