malloc.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  1. /*
  2. * libc/stdlib/malloc/malloc.h -- small malloc implementation
  3. *
  4. * Copyright (C) 2002 NEC Corporation
  5. * Copyright (C) 2002 Miles Bader <miles@gnu.org>
  6. *
  7. * This file is subject to the terms and conditions of the GNU Lesser
  8. * General Public License. See the file COPYING.LIB in the main
  9. * directory of this archive for more details.
  10. *
  11. * Written by Miles Bader <miles@gnu.org>
  12. */
  13. /* The alignment we guarantee for malloc return values. We prefer this
  14. to be at least sizeof (size_t) bytes because (a) we have to allocate
  15. that many bytes for the header anyway and (b) guaranteeing word
  16. alignment can be a significant win on targets like m68k and Coldfire,
  17. where __alignof__(double) == 2. */
  18. #define MALLOC_ALIGNMENT \
  19. __alignof__ (double __attribute_aligned__ (sizeof (size_t)))
  20. /* The system pagesize... */
  21. extern size_t __pagesize;
  22. #define MALLOC_PAGE_SIZE __pagesize
  23. /* The minimum size of block we request from the the system to extend the
  24. heap for small allocations (we may request a bigger block if necessary to
  25. satisfy a particularly big request). */
  26. #define MALLOC_HEAP_EXTEND_SIZE MALLOC_PAGE_SIZE
  27. /* When a heap free-area grows above this size, try to unmap it, releasing
  28. the memory back to the system. */
  29. #define MALLOC_UNMAP_THRESHOLD (8*MALLOC_PAGE_SIZE)
  30. /* When unmapping a free-area, retain this many bytes if it's the only one,
  31. to avoid completely emptying the heap. This is only a heuristic -- the
  32. existance of another free area, even if it's smaller than
  33. MALLOC_MIN_SIZE, will cause us not to reserve anything. */
  34. #define MALLOC_MIN_SIZE (2*MALLOC_PAGE_SIZE)
  35. /* When realloc shrinks an allocation, it only does so if more than this
  36. many bytes will be freed; it must at at least HEAP_MIN_SIZE. Larger
  37. values increase speed (by reducing heap fragmentation) at the expense of
  38. space. */
  39. #define MALLOC_REALLOC_MIN_FREE_SIZE (HEAP_MIN_SIZE + 16)
  40. /* For systems with an MMU, use sbrk to map/unmap memory for the malloc
  41. heap, instead of mmap/munmap. This is a tradeoff -- sbrk is faster than
  42. mmap/munmap, and guarantees contiguous allocation, but is also less
  43. flexible, and causes the heap to only be shrinkable from the end. */
  44. #ifdef __ARCH_USE_MMU__
  45. # define MALLOC_USE_SBRK
  46. #endif
  47. /* The current implementation of munmap in uClinux doesn't work correctly:
  48. it requires that ever call to munmap exactly match a corresponding call
  49. to mmap (that is, it doesn't allow you to unmap only part of a
  50. previously allocated block, or to unmap two contiguous blocks with a
  51. single call to munmap). This behavior is broken, and uClinux should be
  52. fixed; however, until it is, we add code to work around the problem in
  53. malloc. */
  54. #ifdef __UCLIBC_UCLINUX_BROKEN_MUNMAP__
  55. /* A structure recording a block of memory mmapped by malloc. */
  56. struct malloc_mmb
  57. {
  58. void *mem; /* the mmapped block */
  59. size_t size; /* its size */
  60. struct malloc_mmb *next;
  61. };
  62. /* A list of all malloc_mmb structures describing blocks that malloc has
  63. mmapped, ordered by the block address. */
  64. extern struct malloc_mmb *__malloc_mmapped_blocks;
  65. /* A heap used for allocating malloc_mmb structures. We could allocate
  66. them from the main heap, but that tends to cause heap fragmentation in
  67. annoying ways. */
  68. extern struct heap_free_area *__malloc_mmb_heap;
  69. /* Define MALLOC_MMB_DEBUGGING to cause malloc to emit debugging info about
  70. about mmap block allocation/freeing by the `uclinux broken munmap' code
  71. to stderr, when the variable __malloc_mmb_debug is set to true. */
  72. #ifdef MALLOC_MMB_DEBUGGING
  73. # include <stdio.h>
  74. extern int __malloc_mmb_debug;
  75. # define MALLOC_MMB_DEBUG(indent, fmt, args...) \
  76. (__malloc_mmb_debug ? __malloc_debug_printf (indent, fmt , ##args) : 0)
  77. # define MALLOC_MMB_DEBUG_INDENT(indent) \
  78. (__malloc_mmb_debug ? __malloc_debug_indent (indent) : 0)
  79. # ifndef MALLOC_DEBUGGING
  80. # define MALLOC_DEBUGGING
  81. # endif
  82. #else /* !MALLOC_MMB_DEBUGGING */
  83. # define MALLOC_MMB_DEBUG(fmt, args...) (void)0
  84. # define MALLOC_MMB_DEBUG_INDENT(indent) (void)0
  85. #endif /* MALLOC_MMB_DEBUGGING */
  86. #endif /* __UCLIBC_UCLINUX_BROKEN_MUNMAP__ */
  87. /* The size of a malloc allocation is stored in a size_t word
  88. MALLOC_HEADER_SIZE bytes prior to the start address of the allocation:
  89. +--------+---------+-------------------+
  90. | SIZE |(unused) | allocation ... |
  91. +--------+---------+-------------------+
  92. ^ BASE ^ ADDR
  93. ^ ADDR - MALLOC_HEADER_SIZE
  94. */
  95. /* The amount of extra space used by the malloc header. */
  96. #define MALLOC_HEADER_SIZE \
  97. (MALLOC_ALIGNMENT < sizeof (size_t) \
  98. ? sizeof (size_t) \
  99. : MALLOC_ALIGNMENT)
  100. /* Set up the malloc header, and return the user address of a malloc block. */
  101. #define MALLOC_SETUP(base, size) \
  102. (MALLOC_SET_SIZE (base, size), (void *)((char *)base + MALLOC_HEADER_SIZE))
  103. /* Set the size of a malloc allocation, given the base address. */
  104. #define MALLOC_SET_SIZE(base, size) (*(size_t *)(base) = (size))
  105. /* Return base-address of a malloc allocation, given the user address. */
  106. #define MALLOC_BASE(addr) ((void *)((char *)addr - MALLOC_HEADER_SIZE))
  107. /* Return the size of a malloc allocation, given the user address. */
  108. #define MALLOC_SIZE(addr) (*(size_t *)MALLOC_BASE(addr))
  109. /* Locking for multithreaded apps. */
  110. #ifdef __UCLIBC_HAS_THREADS__
  111. # include <bits/uClibc_mutex.h>
  112. # define MALLOC_USE_LOCKING
  113. typedef __UCLIBC_MUTEX_TYPE malloc_mutex_t;
  114. # define MALLOC_MUTEX_INIT __UCLIBC_MUTEX_INITIALIZER
  115. # ifdef MALLOC_USE_SBRK
  116. /* This lock is used to serialize uses of the `sbrk' function (in both
  117. malloc and free, sbrk may be used several times in succession, and
  118. things will break if these multiple calls are interleaved with another
  119. thread's use of sbrk!). */
  120. extern malloc_mutex_t __malloc_sbrk_lock;
  121. # define __malloc_lock_sbrk() __UCLIBC_MUTEX_LOCK_CANCEL_UNSAFE (__malloc_sbrk_lock)
  122. # define __malloc_unlock_sbrk() __UCLIBC_MUTEX_UNLOCK_CANCEL_UNSAFE (__malloc_sbrk_lock)
  123. # endif /* MALLOC_USE_SBRK */
  124. #else /* !__UCLIBC_HAS_THREADS__ */
  125. /* Without threads, mutex operations are a nop. */
  126. # define __malloc_lock_sbrk() (void)0
  127. # define __malloc_unlock_sbrk() (void)0
  128. #endif /* __UCLIBC_HAS_THREADS__ */
  129. /* branch-prediction macros; they may already be defined by libc. */
  130. #ifndef likely
  131. #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
  132. #define likely(cond) __builtin_expect(!!(int)(cond), 1)
  133. #define unlikely(cond) __builtin_expect((int)(cond), 0)
  134. #else
  135. #define likely(cond) (cond)
  136. #define unlikely(cond) (cond)
  137. #endif
  138. #endif /* !likely */
  139. /* Define MALLOC_DEBUGGING to cause malloc to emit debugging info to stderr
  140. when the variable __malloc_debug is set to true. */
  141. #ifdef MALLOC_DEBUGGING
  142. extern void __malloc_debug_init (void);
  143. /* The number of spaces in a malloc debug indent level. */
  144. #define MALLOC_DEBUG_INDENT_SIZE 3
  145. extern int __malloc_debug, __malloc_check;
  146. # define MALLOC_DEBUG(indent, fmt, args...) \
  147. (__malloc_debug ? __malloc_debug_printf (indent, fmt , ##args) : 0)
  148. # define MALLOC_DEBUG_INDENT(indent) \
  149. (__malloc_debug ? __malloc_debug_indent (indent) : 0)
  150. extern int __malloc_debug_cur_indent;
  151. /* Print FMT and args indented at the current debug print level, followed
  152. by a newline, and change the level by INDENT. */
  153. extern void __malloc_debug_printf (int indent, const char *fmt, ...);
  154. /* Change the current debug print level by INDENT, and return the value. */
  155. #define __malloc_debug_indent(indent) (__malloc_debug_cur_indent += indent)
  156. /* Set the current debug print level to LEVEL. */
  157. #define __malloc_debug_set_indent(level) (__malloc_debug_cur_indent = level)
  158. #else /* !MALLOC_DEBUGGING */
  159. # define MALLOC_DEBUG(fmt, args...) (void)0
  160. # define MALLOC_DEBUG_INDENT(indent) (void)0
  161. #endif /* MALLOC_DEBUGGING */
  162. /* Return SZ rounded down to POWER_OF_2_SIZE (which must be power of 2). */
  163. #define MALLOC_ROUND_DOWN(sz, power_of_2_size) \
  164. ((sz) & ~(power_of_2_size - 1))
  165. /* Return SZ rounded to POWER_OF_2_SIZE (which must be power of 2). */
  166. #define MALLOC_ROUND_UP(sz, power_of_2_size) \
  167. MALLOC_ROUND_DOWN ((sz) + (power_of_2_size - 1), (power_of_2_size))
  168. /* Return SZ rounded down to a multiple MALLOC_PAGE_SIZE. */
  169. #define MALLOC_ROUND_DOWN_TO_PAGE_SIZE(sz) \
  170. MALLOC_ROUND_DOWN (sz, MALLOC_PAGE_SIZE)
  171. /* Return SZ rounded up to a multiple MALLOC_PAGE_SIZE. */
  172. #define MALLOC_ROUND_UP_TO_PAGE_SIZE(sz) \
  173. MALLOC_ROUND_UP (sz, MALLOC_PAGE_SIZE)
  174. /* The malloc heap. */
  175. extern struct heap_free_area *__malloc_heap;
  176. #ifdef __UCLIBC_HAS_THREADS__
  177. extern malloc_mutex_t __malloc_heap_lock;
  178. #ifdef __UCLIBC_UCLINUX_BROKEN_MUNMAP__
  179. extern malloc_mutex_t __malloc_mmb_heap_lock;
  180. #endif
  181. #endif