contrib/gdb-7/gdb/gnulib/import/malloca.h

   1 /* Safe automatic memory allocation.
   2    Copyright (C) 2003-2007, 2009-2012 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2003.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #ifndef _MALLOCA_H
  19 #define _MALLOCA_H
  20
  21 #include <stddef.h>
  22 #include <stdlib.h>
  23
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29
  30 /* safe_alloca(N) is equivalent to alloca(N) when it is safe to call
  31    alloca(N); otherwise it returns NULL.  It either returns N bytes of
  32    memory allocated on the stack, that lasts until the function returns,
  33    or NULL.
  34    Use of safe_alloca should be avoided:
  35      - inside arguments of function calls - undefined behaviour,
  36      - in inline functions - the allocation may actually last until the
  37        calling function returns.
  38 */
  39 #if HAVE_ALLOCA
  40 /* The OS usually guarantees only one guard page at the bottom of the stack,
  41    and a page size can be as small as 4096 bytes.  So we cannot safely
  42    allocate anything larger than 4096 bytes.  Also care for the possibility
  43    of a few compiler-allocated temporary stack slots.
  44    This must be a macro, not a function.  */
  45 # define safe_alloca(N) ((N) < 4032 ? alloca (N) : NULL)
  46 #else
  47 # define safe_alloca(N) ((void) (N), NULL)
  48 #endif
  49
  50 /* malloca(N) is a safe variant of alloca(N).  It allocates N bytes of
  51    memory allocated on the stack, that must be freed using freea() before
  52    the function returns.  Upon failure, it returns NULL.  */
  53 #if HAVE_ALLOCA
  54 # define malloca(N) \
  55   ((N) < 4032 - sa_increment                                        \
  56    ? (void *) ((char *) alloca ((N) + sa_increment) + sa_increment) \
  57    : mmalloca (N))
  58 #else
  59 # define malloca(N) \
  60   mmalloca (N)
  61 #endif
  62 extern void * mmalloca (size_t n);
  63
  64 /* Free a block of memory allocated through malloca().  */
  65 #if HAVE_ALLOCA
  66 extern void freea (void *p);
  67 #else
  68 # define freea free
  69 #endif
  70
  71 /* nmalloca(N,S) is an overflow-safe variant of malloca (N * S).
  72    It allocates an array of N objects, each with S bytes of memory,
  73    on the stack.  S must be positive and N must be nonnegative.
  74    The array must be freed using freea() before the function returns.  */
  75 #if 1
  76 /* Cf. the definition of xalloc_oversized.  */
  77 # define nmalloca(n, s) \
  78     ((n) > (size_t) (sizeof (ptrdiff_t) <= sizeof (size_t) ? -1 : -2) / (s) \
  79      ? NULL \
  80      : malloca ((n) * (s)))
  81 #else
  82 extern void * nmalloca (size_t n, size_t s);
  83 #endif
  84
  85
  86 #ifdef __cplusplus
  87 }
  88 #endif
  89
  90
  91 /* ------------------- Auxiliary, non-public definitions ------------------- */
  92
  93 /* Determine the alignment of a type at compile time.  */
  94 #if defined __GNUC__
  95 # define sa_alignof __alignof__
  96 #elif defined __cplusplus
  97   template <class type> struct sa_alignof_helper { char __slot1; type __slot2; };
  98 # define sa_alignof(type) offsetof (sa_alignof_helper<type>, __slot2)
  99 #elif defined __hpux
 100   /* Work around a HP-UX 10.20 cc bug with enums constants defined as offsetof
 101      values.  */
 102 # define sa_alignof(type) (sizeof (type) <= 4 ? 4 : 8)
 103 #elif defined _AIX
 104   /* Work around an AIX 3.2.5 xlc bug with enums constants defined as offsetof
 105      values.  */
 106 # define sa_alignof(type) (sizeof (type) <= 4 ? 4 : 8)
 107 #else
 108 # define sa_alignof(type) offsetof (struct { char __slot1; type __slot2; }, __slot2)
 109 #endif
 110
 111 enum
 112 {
 113 /* The desired alignment of memory allocations is the maximum alignment
 114    among all elementary types.  */
 115   sa_alignment_long = sa_alignof (long),
 116   sa_alignment_double = sa_alignof (double),
 117 #if HAVE_LONG_LONG_INT
 118   sa_alignment_longlong = sa_alignof (long long),
 119 #endif
 120   sa_alignment_longdouble = sa_alignof (long double),
 121   sa_alignment_max = ((sa_alignment_long - 1) | (sa_alignment_double - 1)
 122 #if HAVE_LONG_LONG_INT
 123                       | (sa_alignment_longlong - 1)
 124 #endif
 125                       | (sa_alignment_longdouble - 1)
 126                      ) + 1,
 127 /* The increment that guarantees room for a magic word must be >= sizeof (int)
 128    and a multiple of sa_alignment_max.  */
 129   sa_increment = ((sizeof (int) + sa_alignment_max - 1) / sa_alignment_max) * sa_alignment_max
 130 };
 131
 132 #endif /* _MALLOCA_H */