malloca.h 4.6 KB

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