stack_alloc.h

00001 /* Copyright (C) 2002 Jean-Marc Valin */
00002 /**
00003    @file stack_alloc.h
00004    @brief Temporary memory allocation on stack
00005 */
00006 /*
00007    Redistribution and use in source and binary forms, with or without
00008    modification, are permitted provided that the following conditions
00009    are met:
00010    
00011    - Redistributions of source code must retain the above copyright
00012    notice, this list of conditions and the following disclaimer.
00013    
00014    - Redistributions in binary form must reproduce the above copyright
00015    notice, this list of conditions and the following disclaimer in the
00016    documentation and/or other materials provided with the distribution.
00017    
00018    - Neither the name of the Xiph.org Foundation nor the names of its
00019    contributors may be used to endorse or promote products derived from
00020    this software without specific prior written permission.
00021    
00022    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00025    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
00026    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00027    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00028    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 */
00034 
00035 #ifndef STACK_ALLOC_H
00036 #define STACK_ALLOC_H
00037 
00038 #ifdef USE_ALLOCA
00039 #ifdef WIN32
00040 #include <malloc.h>
00041 #else
00042 #include <alloca.h>
00043 #endif
00044 #endif
00045 
00046 /**
00047  * @def ALIGN(stack, size)
00048  *
00049  * Aligns the stack to a 'size' boundary
00050  *
00051  * @param stack Stack
00052  * @param size  New size boundary
00053  */
00054 
00055 /**
00056  * @def PUSH(stack, size, type)
00057  *
00058  * Allocates 'size' elements of type 'type' on the stack
00059  *
00060  * @param stack Stack
00061  * @param size  Number of elements
00062  * @param type  Type of element
00063  */
00064 
00065 /**
00066  * @def PUSHS(stack, type)
00067  *
00068  * Allocates a struct stack 
00069  *
00070  * @param stack Stack
00071  * @param type  Struct type
00072  */
00073 
00074 /**
00075  * @def VARDECL(var)
00076  *
00077  * Declare variable on stack
00078  *
00079  * @param var Variable to declare
00080  */
00081 
00082 /**
00083  * @def ALLOC(var, size, type)
00084  *
00085  * Allocate 'size' elements of 'type' on stack
00086  *
00087  * @param var  Name of variable to allocate
00088  * @param size Number of elements
00089  * @param type Type of element
00090  */
00091 
00092 #ifdef BAIDU_SPEEX_ENCODE_STACK_MONITOR
00093 extern char *g_p_spx_enc_stk_top;
00094 #endif
00095 
00096 #ifdef ENABLE_VALGRIND
00097 
00098 #include <valgrind/memcheck.h>
00099 
00100 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
00101 
00102 #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))))
00103 
00104 #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))))
00105 
00106 #else
00107 
00108 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
00109 
00110 #ifdef BAIDU_SPEEX_ENCODE_STACK_MONITOR
00111 #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)),(stack)+=((size)*sizeof(type)), (g_p_spx_enc_stk_top = (stack > g_p_spx_enc_stk_top) ? (stack):g_p_spx_enc_stk_top), (type*)((stack)-((size)*sizeof(type))))
00112 #else
00113 #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)),(stack)+=((size)*sizeof(type)),(type*)((stack)-((size)*sizeof(type))))
00114 #endif
00115 
00116 
00117 #define PUSHS(stack, type) (ALIGN((stack),sizeof(long)),(stack)+=(sizeof(type)),(type*)((stack)-(sizeof(type))))
00118 
00119 #endif
00120 
00121 #if defined(VAR_ARRAYS)
00122 #define VARDECL(var) 
00123 #define ALLOC(var, size, type) type var[size]
00124 #elif defined(USE_ALLOCA)
00125 #define VARDECL(var) var
00126 #define ALLOC(var, size, type) var = alloca(sizeof(type)*(size))
00127 #else
00128 #define VARDECL(var) var
00129 #define ALLOC(var, size, type) var = PUSH(stack, size, type)
00130 #endif
00131 
00132 
00133 #endif