apps/codecs/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 #include "config-speex.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 PUSHS(stack, type)
  73  *
  74  * Allocates a struct stack
  75  *
  76  * @param stack Stack
  77  * @param type  Struct type
  78  */
  79
  80 /**
  81  * @def VARDECL(var)
  82  *
  83  * Declare variable on stack
  84  *
  85  * @param var Variable to declare
  86  */
  87
  88 /**
  89  * @def ALLOC(var, size, type)
  90  *
  91  * Allocate 'size' elements of 'type' on stack
  92  *
  93  * @param var  Name of variable to allocate
  94  * @param size Number of elements
  95  * @param type Type of element
  96  */
  97
  98 #ifdef ENABLE_VALGRIND
  99
 100 #include <valgrind/memcheck.h>
 101
 102 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
 103
 104 #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))))
 105
 106 #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))))
 107
 108 #else
 109
 110 #define ALIGN(stack, size) ((stack) += ((size) - (long)(stack)) & ((size) - 1))
 111
 112 #define PUSH(stack, size, type) (ALIGN((stack),sizeof(type)),(stack)+=((size)*sizeof(type)),(type*)((stack)-((size)*sizeof(type))))
 113
 114 #define PUSHS(stack, type) (ALIGN((stack),sizeof(long)),(stack)+=(sizeof(type)),(type*)((stack)-(sizeof(type))))
 115
 116 #endif
 117
 118 #if defined(VAR_ARRAYS)
 119 #define VARDECL(var)
 120 #define ALLOC(var, size, type) type var[size]
 121 #elif defined(USE_ALLOCA)
 122 #define VARDECL(var) var
 123 #define ALLOC(var, size, type) var = alloca(sizeof(type)*(size))
 124 #else
 125 #define VARDECL(var) var
 126 #define ALLOC(var, size, type) var = PUSH(stack, size, type)
 127 #endif
 128
 129
 130 #endif