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