common_stackalloc.h

   1 /*******************************************************************************
   2 Copyright (c) 2016, The OpenBLAS Project
   3 All rights reserved.
   4 Redistribution and use in source and binary forms, with or without
   5 modification, are permitted provided that the following conditions are
   6 met:
   7 1. Redistributions of source code must retain the above copyright
   8 notice, this list of conditions and the following disclaimer.
   9 2. Redistributions in binary form must reproduce the above copyright
  10 notice, this list of conditions and the following disclaimer in
  11 the documentation and/or other materials provided with the
  12 distribution.
  13 3. Neither the name of the OpenBLAS project nor the names of
  14 its contributors may be used to endorse or promote products
  15 derived from this software without specific prior written permission.
  16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 ARE DISCLAIMED. IN NO EVENT SHALL THE OPENBLAS PROJECT OR CONTRIBUTORS BE
  20 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  22 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  23 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  24 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  25 USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 *******************************************************************************/
  27
  28 #define STACK_ALLOC_PROTECT
  29 #ifdef STACK_ALLOC_PROTECT
  30 // Try to detect stack smashing
  31 #include <assert.h>
  32 #define STACK_ALLOC_PROTECT_SET volatile int stack_check = 0x7fc01234;
  33 #define STACK_ALLOC_PROTECT_CHECK assert(stack_check == 0x7fc01234);
  34 #else
  35 #define STACK_ALLOC_PROTECT_SET
  36 #define STACK_ALLOC_PROTECT_CHECK
  37 #endif
  38
  39 #if defined(MAX_STACK_ALLOC) && MAX_STACK_ALLOC > 0
  40
  41 /*
  42  * Allocate a buffer on the stack if the size is smaller than MAX_STACK_ALLOC.
  43  * Stack allocation is much faster than blas_memory_alloc or malloc, particularly
  44  * when OpenBLAS is used from a multi-threaded application.
  45  * SIZE must be carefully chosen to be:
  46  * - as small as possible to maximize the number of stack allocation
  47  * - large enough to support all architectures and kernel
  48  * Choosing a SIZE too small will lead to a stack smashing.
  49  */
  50 #define STACK_ALLOC(SIZE, TYPE, BUFFER)                                        \
  51   /* make it volatile because some function (ex: dgemv_n.S) */                 \
  52   /* do not restore all register */                                            \
  53   volatile int stack_alloc_size = SIZE;                                        \
  54   if (stack_alloc_size > MAX_STACK_ALLOC / sizeof(TYPE)) stack_alloc_size = 0; \
  55   STACK_ALLOC_PROTECT_SET                                                      \
  56   /* Avoid declaring an array of length 0 */                                   \
  57   TYPE stack_buffer[stack_alloc_size ? stack_alloc_size : 1]                   \
  58       __attribute__((aligned(0x20)));                                          \
  59   BUFFER = stack_alloc_size ? stack_buffer : (TYPE *)blas_memory_alloc(1);
  60 #else
  61   //Original OpenBLAS/GotoBLAS codes.
  62   #define STACK_ALLOC(SIZE, TYPE, BUFFER) BUFFER = (TYPE *)blas_memory_alloc(1)
  63 #endif
  64
  65
  66 #if defined(MAX_STACK_ALLOC) && MAX_STACK_ALLOC > 0
  67 #define STACK_FREE(BUFFER)    \
  68   STACK_ALLOC_PROTECT_CHECK   \
  69   if(!stack_alloc_size)       \
  70     blas_memory_free(BUFFER);
  71 #else
  72 #define STACK_FREE(BUFFER) blas_memory_free(BUFFER)
  73 #endif
  74