Chris@69: /* Copyright (C) 2002-2003 Jean-Marc Valin
Chris@69:    Copyright (C) 2007-2009 Xiph.Org Foundation */
Chris@69: /**
Chris@69:    @file stack_alloc.h
Chris@69:    @brief Temporary memory allocation on stack
Chris@69: */
Chris@69: /*
Chris@69:    Redistribution and use in source and binary forms, with or without
Chris@69:    modification, are permitted provided that the following conditions
Chris@69:    are met:
Chris@69: 
Chris@69:    - Redistributions of source code must retain the above copyright
Chris@69:    notice, this list of conditions and the following disclaimer.
Chris@69: 
Chris@69:    - Redistributions in binary form must reproduce the above copyright
Chris@69:    notice, this list of conditions and the following disclaimer in the
Chris@69:    documentation and/or other materials provided with the distribution.
Chris@69: 
Chris@69:    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@69:    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@69:    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@69:    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
Chris@69:    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
Chris@69:    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
Chris@69:    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
Chris@69:    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
Chris@69:    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
Chris@69:    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Chris@69:    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@69: */
Chris@69: 
Chris@69: #ifndef STACK_ALLOC_H
Chris@69: #define STACK_ALLOC_H
Chris@69: 
Chris@69: #include "opus_types.h"
Chris@69: #include "opus_defines.h"
Chris@69: 
Chris@69: #if (!defined (VAR_ARRAYS) && !defined (USE_ALLOCA) && !defined (NONTHREADSAFE_PSEUDOSTACK))
Chris@69: #error "Opus requires one of VAR_ARRAYS, USE_ALLOCA, or NONTHREADSAFE_PSEUDOSTACK be defined to select the temporary allocation mode."
Chris@69: #endif
Chris@69: 
Chris@69: #ifdef USE_ALLOCA
Chris@69: # ifdef WIN32
Chris@69: #  include <malloc.h>
Chris@69: # else
Chris@69: #  ifdef HAVE_ALLOCA_H
Chris@69: #   include <alloca.h>
Chris@69: #  else
Chris@69: #   include <stdlib.h>
Chris@69: #  endif
Chris@69: # endif
Chris@69: #endif
Chris@69: 
Chris@69: /**
Chris@69:  * @def ALIGN(stack, size)
Chris@69:  *
Chris@69:  * Aligns the stack to a 'size' boundary
Chris@69:  *
Chris@69:  * @param stack Stack
Chris@69:  * @param size  New size boundary
Chris@69:  */
Chris@69: 
Chris@69: /**
Chris@69:  * @def PUSH(stack, size, type)
Chris@69:  *
Chris@69:  * Allocates 'size' elements of type 'type' on the stack
Chris@69:  *
Chris@69:  * @param stack Stack
Chris@69:  * @param size  Number of elements
Chris@69:  * @param type  Type of element
Chris@69:  */
Chris@69: 
Chris@69: /**
Chris@69:  * @def VARDECL(var)
Chris@69:  *
Chris@69:  * Declare variable on stack
Chris@69:  *
Chris@69:  * @param var Variable to declare
Chris@69:  */
Chris@69: 
Chris@69: /**
Chris@69:  * @def ALLOC(var, size, type)
Chris@69:  *
Chris@69:  * Allocate 'size' elements of 'type' on stack
Chris@69:  *
Chris@69:  * @param var  Name of variable to allocate
Chris@69:  * @param size Number of elements
Chris@69:  * @param type Type of element
Chris@69:  */
Chris@69: 
Chris@69: #if defined(VAR_ARRAYS)
Chris@69: 
Chris@69: #define VARDECL(type, var)
Chris@69: #define ALLOC(var, size, type) type var[size]
Chris@69: #define SAVE_STACK
Chris@69: #define RESTORE_STACK
Chris@69: #define ALLOC_STACK
Chris@69: /* C99 does not allow VLAs of size zero */
Chris@69: #define ALLOC_NONE 1
Chris@69: 
Chris@69: #elif defined(USE_ALLOCA)
Chris@69: 
Chris@69: #define VARDECL(type, var) type *var
Chris@69: 
Chris@69: # ifdef WIN32
Chris@69: #  define ALLOC(var, size, type) var = ((type*)_alloca(sizeof(type)*(size)))
Chris@69: # else
Chris@69: #  define ALLOC(var, size, type) var = ((type*)alloca(sizeof(type)*(size)))
Chris@69: # endif
Chris@69: 
Chris@69: #define SAVE_STACK
Chris@69: #define RESTORE_STACK
Chris@69: #define ALLOC_STACK
Chris@69: #define ALLOC_NONE 0
Chris@69: 
Chris@69: #else
Chris@69: 
Chris@69: #ifdef CELT_C
Chris@69: char *scratch_ptr=0;
Chris@69: char *global_stack=0;
Chris@69: #else
Chris@69: extern char *global_stack;
Chris@69: extern char *scratch_ptr;
Chris@69: #endif /* CELT_C */
Chris@69: 
Chris@69: #ifdef ENABLE_VALGRIND
Chris@69: 
Chris@69: #include <valgrind/memcheck.h>
Chris@69: 
Chris@69: #ifdef CELT_C
Chris@69: char *global_stack_top=0;
Chris@69: #else
Chris@69: extern char *global_stack_top;
Chris@69: #endif /* CELT_C */
Chris@69: 
Chris@69: #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
Chris@69: #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))))
Chris@69: #define RESTORE_STACK ((global_stack = _saved_stack),VALGRIND_MAKE_MEM_NOACCESS(global_stack, global_stack_top-global_stack))
Chris@69: #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;
Chris@69: 
Chris@69: #else
Chris@69: 
Chris@69: #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
Chris@69: #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)/sizeof(char)),(stack)+=(size)*(sizeof(type)/sizeof(char)),(type*)((stack)-(size)*(sizeof(type)/sizeof(char))))
Chris@69: #if 0 /* Set this to 1 to instrument pseudostack usage */
Chris@69: #define RESTORE_STACK (printf("%ld %s:%d\n", global_stack-scratch_ptr, __FILE__, __LINE__),global_stack = _saved_stack)
Chris@69: #else
Chris@69: #define RESTORE_STACK (global_stack = _saved_stack)
Chris@69: #endif
Chris@69: #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;
Chris@69: 
Chris@69: #endif /* ENABLE_VALGRIND */
Chris@69: 
Chris@69: #include "os_support.h"
Chris@69: #define VARDECL(type, var) type *var
Chris@69: #define ALLOC(var, size, type) var = PUSH(global_stack, size, type)
Chris@69: #define SAVE_STACK char *_saved_stack = global_stack;
Chris@69: #define ALLOC_NONE 0
Chris@69: 
Chris@69: #endif /* VAR_ARRAYS */
Chris@69: 
Chris@69: 
Chris@69: #ifdef ENABLE_VALGRIND
Chris@69: 
Chris@69: #include <valgrind/memcheck.h>
Chris@69: #define OPUS_CHECK_ARRAY(ptr, len) VALGRIND_CHECK_MEM_IS_DEFINED(ptr, len*sizeof(*ptr))
Chris@69: #define OPUS_CHECK_VALUE(value) VALGRIND_CHECK_VALUE_IS_DEFINED(value)
Chris@69: #define OPUS_CHECK_ARRAY_COND(ptr, len) VALGRIND_CHECK_MEM_IS_DEFINED(ptr, len*sizeof(*ptr))
Chris@69: #define OPUS_CHECK_VALUE_COND(value) VALGRIND_CHECK_VALUE_IS_DEFINED(value)
Chris@69: #define OPUS_PRINT_INT(value) do {fprintf(stderr, #value " = %d at %s:%d\n", value, __FILE__, __LINE__);}while(0)
Chris@69: #define OPUS_FPRINTF fprintf
Chris@69: 
Chris@69: #else
Chris@69: 
Chris@69: static OPUS_INLINE int _opus_false(void) {return 0;}
Chris@69: #define OPUS_CHECK_ARRAY(ptr, len) _opus_false()
Chris@69: #define OPUS_CHECK_VALUE(value) _opus_false()
Chris@69: #define OPUS_PRINT_INT(value) do{}while(0)
Chris@69: #define OPUS_FPRINTF (void)
Chris@69: 
Chris@69: #endif
Chris@69: 
Chris@69: 
Chris@69: #endif /* STACK_ALLOC_H */