Improved Doxygen comments
[speexdsp.git] / libspeex / stack_alloc.h
1 /* Copyright (C) 2002 Jean-Marc Valin */
2 /**
3    @file stack_alloc.h
4    @brief Temporary memory allocation on stack
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef STACK_ALLOC_H
36 #define STACK_ALLOC_H
37
38 #ifdef USE_ALLOCA
39 #include <alloca.h>
40 #endif
41
42 /**
43  * @def ALIGN(stack, size)
44  *
45  * Aligns the stack to a 'size' boundary
46  *
47  * @param stack Stack
48  * @param size  New size boundary
49  */
50
51 /**
52  * @def PUSH(stack, size, type)
53  *
54  * Allocates 'size' elements of type 'type' on the stack
55  *
56  * @param stack Stack
57  * @param size  Number of elements
58  * @param type  Type of element
59  */
60
61 /**
62  * @def PUSHS(stack, type)
63  *
64  * Allocates a struct stack 
65  *
66  * @param stack Stack
67  * @param type  Struct type
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 #ifdef ENABLE_VALGRIND
89
90 #include <valgrind/memcheck.h>
91
92 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
93
94 #define PUSH(stack, size, type) (VALGRIND_MAKE_NOACCESS(stack, 1000),ALIGN((stack),sizeof(type)),VALGRIND_MAKE_WRITABLE(stack, ((size)*sizeof(type))),(stack)+=((size)*sizeof(type)),(type*)((stack)-((size)*sizeof(type))))
95
96 #define PUSHS(stack, type) (VALGRIND_MAKE_NOACCESS(stack, 1000),ALIGN((stack),sizeof(long)),VALGRIND_MAKE_WRITABLE(stack, (sizeof(type))),(stack)+=(sizeof(type)),(type*)((stack)-(sizeof(type))))
97
98 #else
99
100 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
101
102 #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)),(stack)+=((size)*sizeof(type)),(type*)((stack)-((size)*sizeof(type))))
103
104 #define PUSHS(stack, type) (ALIGN((stack),sizeof(long)),(stack)+=(sizeof(type)),(type*)((stack)-(sizeof(type))))
105
106 #endif
107
108 #if defined(VAR_ARRAYS)
109 #define VARDECL(var) 
110 #define ALLOC(var, size, type) type var[size]
111 #elif defined(USE_ALLOCA)
112 #define VARDECL(var) var
113 #define ALLOC(var, size, type) var = alloca(sizeof(type)*size)
114 #else
115 #define VARDECL(var) var
116 #define ALLOC(var, size, type) var = PUSH(stack, size, type)
117 #endif
118
119
120 #endif