source: libcfa/src/heap.cfa@ 74cfe054

ADT arm-eh ast-experimental enum forall-pointer-decay jacob/cs343-translation new-ast new-ast-unique-expr pthread-emulation qualifiedEnum
Last change on this file since 74cfe054 was dd23e66, checked in by Peter A. Buhr <pabuhr@…>, 5 years ago

add default_heap_exhausted, update resize/realloc with alignment, fix cmemalignNoStats to match callocNoStats
  • Property mode set to 100644
File size: 50.6 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2017 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// heap.c --
8//
9// Author : Peter A. Buhr
10// Created On : Tue Dec 19 21:58:35 2017
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Wed Aug 5 22:21:27 2020
13// Update Count : 853
14//
15
16#include <unistd.h> // sbrk, sysconf
17#include <stdbool.h> // true, false
18#include <stdio.h> // snprintf, fileno
19#include <errno.h> // errno
20#include <string.h> // memset, memcpy
21#include <limits.h> // ULONG_MAX
22#include <malloc.h> // memalign, malloc_usable_size
23#include <sys/mman.h> // mmap, munmap
24
25#include "bits/align.hfa" // libPow2
26#include "bits/defs.hfa" // likely, unlikely
27#include "bits/locks.hfa" // __spinlock_t
28#include "startup.hfa" // STARTUP_PRIORITY_MEMORY
29//#include "stdlib.hfa" // bsearchl
30#include "bitmanip.hfa" // ceiling
31
32#define MIN(x, y) (y > x ? x : y)
33
34static bool traceHeap = false;
35
36inline bool traceHeap() { return traceHeap; }
37
38bool traceHeapOn() {
39 bool temp = traceHeap;
40 traceHeap = true;
41 return temp;
42} // traceHeapOn
43
44bool traceHeapOff() {
45 bool temp = traceHeap;
46 traceHeap = false;
47 return temp;
48} // traceHeapOff
49
50bool traceHeapTerm() { return false; }
51
52
53static bool prtFree = false;
54
55inline bool prtFree() {
56 return prtFree;
57} // prtFree
58
59bool prtFreeOn() {
60 bool temp = prtFree;
61 prtFree = true;
62 return temp;
63} // prtFreeOn
64
65bool prtFreeOff() {
66 bool temp = prtFree;
67 prtFree = false;
68 return temp;
69} // prtFreeOff
70
71
72enum {
73 // Define the default extension heap amount in units of bytes. When the uC++ supplied heap reaches the brk address,
74 // the brk address is extended by the extension amount.
75 __CFA_DEFAULT_HEAP_EXPANSION__ = (1 * 1024 * 1024),
76
77 // Define the mmap crossover point during allocation. Allocations less than this amount are allocated from buckets;
78 // values greater than or equal to this value are mmap from the operating system.
79 __CFA_DEFAULT_MMAP_START__ = (512 * 1024 + 1),
80};
81
82size_t default_mmap_start() __attribute__(( weak )) {
83 return __CFA_DEFAULT_MMAP_START__;
84} // default_mmap_start
85
86size_t default_heap_expansion() __attribute__(( weak )) {
87 return __CFA_DEFAULT_HEAP_EXPANSION__;
88} // default_heap_expansion
89
90bool default_heap_exhausted() __attribute__(( weak )) { // find and free some storage
91 // Returning false prints "out of heap memory" message and aborts.
92 return false;
93} // default_heap_exhausted
94
95
96#ifdef __CFA_DEBUG__
97static unsigned int allocFree; // running total of allocations minus frees
98
99static void prtUnfreed() {
100 if ( allocFree != 0 ) {
101 // DO NOT USE STREAMS AS THEY MAY BE UNAVAILABLE AT THIS POINT.
102 char helpText[512];
103 int len = snprintf( helpText, sizeof(helpText), "CFA warning (UNIX pid:%ld) : program terminating with %u(0x%x) bytes of storage allocated but not freed.\n"
104 "Possible cause is unfreed storage allocated by the program or system/library routines called from the program.\n",
105 (long int)getpid(), allocFree, allocFree ); // always print the UNIX pid
106 __cfaabi_bits_write( STDERR_FILENO, helpText, len ); // print debug/nodebug
107 } // if
108} // prtUnfreed
109
110extern "C" {
111 void heapAppStart() { // called by __cfaabi_appready_startup
112 allocFree = 0;
113 } // heapAppStart
114
115 void heapAppStop() { // called by __cfaabi_appready_startdown
116 fclose( stdin ); fclose( stdout );
117 prtUnfreed();
118 } // heapAppStop
119} // extern "C"
120#endif // __CFA_DEBUG__
121
122
123// statically allocated variables => zero filled.
124static size_t pageSize; // architecture pagesize
125static size_t heapExpand; // sbrk advance
126static size_t mmapStart; // cross over point for mmap
127static unsigned int maxBucketsUsed; // maximum number of buckets in use
128
129
130#define SPINLOCK 0
131#define LOCKFREE 1
132#define BUCKETLOCK SPINLOCK
133#if BUCKETLOCK == SPINLOCK
134#elif BUCKETLOCK == LOCKFREE
135#include <stackLockFree.hfa>
136#else
137 #error undefined lock type for bucket lock
138#endif // LOCKFREE
139
140// Recursive definitions: HeapManager needs size of bucket array and bucket area needs sizeof HeapManager storage.
141// Break recusion by hardcoding number of buckets and statically checking number is correct after bucket array defined.
142enum { NoBucketSizes = 91 }; // number of buckets sizes
143
144struct HeapManager {
145 struct Storage {
146 struct Header { // header
147 union Kind {
148 struct RealHeader {
149 union {
150 struct { // 4-byte word => 8-byte header, 8-byte word => 16-byte header
151 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ && __SIZEOF_POINTER__ == 4
152 uint64_t padding; // unused, force home/blocksize to overlay alignment in fake header
153 #endif // __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ && __SIZEOF_POINTER__ == 4
154
155 union {
156 // FreeHeader * home; // allocated block points back to home locations (must overlay alignment)
157 // 2nd low-order bit => zero filled
158 void * home; // allocated block points back to home locations (must overlay alignment)
159 size_t blockSize; // size for munmap (must overlay alignment)
160 #if BUCKETLOCK == SPINLOCK
161 Storage * next; // freed block points next freed block of same size
162 #endif // SPINLOCK
163 };
164 size_t size; // allocation size in bytes
165
166 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ && __SIZEOF_POINTER__ == 4
167 uint64_t padding; // unused, force home/blocksize to overlay alignment in fake header
168 #endif // __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ && __SIZEOF_POINTER__ == 4
169 };
170 #if BUCKETLOCK == LOCKFREE
171 Link(Storage) next; // freed block points next freed block of same size (double-wide)
172 #endif // LOCKFREE
173 };
174 } real; // RealHeader
175
176 struct FakeHeader {
177 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
178 uint32_t alignment; // 1st low-order bit => fake header & alignment
179 #endif // __ORDER_LITTLE_ENDIAN__
180
181 uint32_t offset;
182
183 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
184 uint32_t alignment; // low-order bits of home/blockSize used for tricks
185 #endif // __ORDER_BIG_ENDIAN__
186 } fake; // FakeHeader
187 } kind; // Kind
188 } header; // Header
189 char pad[libAlign() - sizeof( Header )];
190 char data[0]; // storage
191 }; // Storage
192
193 static_assert( libAlign() >= sizeof( Storage ), "libAlign() < sizeof( Storage )" );
194
195 struct FreeHeader {
196 #if BUCKETLOCK == SPINLOCK
197 __spinlock_t lock; // must be first field for alignment
198 Storage * freeList;
199 #else
200 StackLF(Storage) freeList;
201 #endif // BUCKETLOCK
202 size_t blockSize; // size of allocations on this list
203 }; // FreeHeader
204
205 // must be first fields for alignment
206 __spinlock_t extlock; // protects allocation-buffer extension
207 FreeHeader freeLists[NoBucketSizes]; // buckets for different allocation sizes
208
209 void * heapBegin; // start of heap
210 void * heapEnd; // logical end of heap
211 size_t heapRemaining; // amount of storage not allocated in the current chunk
212}; // HeapManager
213
214#if BUCKETLOCK == LOCKFREE
215static inline {
216 Link(HeapManager.Storage) * ?`next( HeapManager.Storage * this ) { return &this->header.kind.real.next; }
217 void ?{}( HeapManager.FreeHeader & ) {}
218 void ^?{}( HeapManager.FreeHeader & ) {}
219} // distribution
220#endif // LOCKFREE
221
222static inline size_t getKey( const HeapManager.FreeHeader & freeheader ) { return freeheader.blockSize; }
223
224
225#define FASTLOOKUP
226#define __STATISTICS__
227
228// Bucket size must be multiple of 16.
229// Smaller multiples of 16 and powers of 2 are common allocation sizes, so make them generate the minimum required bucket size.
230// malloc(0) returns 0p, so no bucket is necessary for 0 bytes returning an address that can be freed.
231static const unsigned int bucketSizes[] @= { // different bucket sizes
232 16 + sizeof(HeapManager.Storage), 32 + sizeof(HeapManager.Storage), 48 + sizeof(HeapManager.Storage), 64 + sizeof(HeapManager.Storage), // 4
233 96 + sizeof(HeapManager.Storage), 112 + sizeof(HeapManager.Storage), 128 + sizeof(HeapManager.Storage), // 3
234 160, 192, 224, 256 + sizeof(HeapManager.Storage), // 4
235 320, 384, 448, 512 + sizeof(HeapManager.Storage), // 4
236 640, 768, 896, 1_024 + sizeof(HeapManager.Storage), // 4
237 1_536, 2_048 + sizeof(HeapManager.Storage), // 2
238 2_560, 3_072, 3_584, 4_096 + sizeof(HeapManager.Storage), // 4
239 6_144, 8_192 + sizeof(HeapManager.Storage), // 2
240 9_216, 10_240, 11_264, 12_288, 13_312, 14_336, 15_360, 16_384 + sizeof(HeapManager.Storage), // 8
241 18_432, 20_480, 22_528, 24_576, 26_624, 28_672, 30_720, 32_768 + sizeof(HeapManager.Storage), // 8
242 36_864, 40_960, 45_056, 49_152, 53_248, 57_344, 61_440, 65_536 + sizeof(HeapManager.Storage), // 8
243 73_728, 81_920, 90_112, 98_304, 106_496, 114_688, 122_880, 131_072 + sizeof(HeapManager.Storage), // 8
244 147_456, 163_840, 180_224, 196_608, 212_992, 229_376, 245_760, 262_144 + sizeof(HeapManager.Storage), // 8
245 294_912, 327_680, 360_448, 393_216, 425_984, 458_752, 491_520, 524_288 + sizeof(HeapManager.Storage), // 8
246 655_360, 786_432, 917_504, 1_048_576 + sizeof(HeapManager.Storage), // 4
247 1_179_648, 1_310_720, 1_441_792, 1_572_864, 1_703_936, 1_835_008, 1_966_080, 2_097_152 + sizeof(HeapManager.Storage), // 8
248 2_621_440, 3_145_728, 3_670_016, 4_194_304 + sizeof(HeapManager.Storage), // 4
249};
250
251static_assert( NoBucketSizes == sizeof(bucketSizes) / sizeof(bucketSizes[0]), "size of bucket array wrong" );
252
253#ifdef FASTLOOKUP
254enum { LookupSizes = 65_536 + sizeof(HeapManager.Storage) }; // number of fast lookup sizes
255static unsigned char lookup[LookupSizes]; // O(1) lookup for small sizes
256#endif // FASTLOOKUP
257
258static int mmapFd = -1; // fake or actual fd for anonymous file
259#ifdef __CFA_DEBUG__
260static bool heapBoot = 0; // detect recursion during boot
261#endif // __CFA_DEBUG__
262
263// The constructor for heapManager is called explicitly in memory_startup.
264static HeapManager heapManager __attribute__(( aligned (128) )) @= {}; // size of cache line to prevent false sharing
265
266
267#ifdef __STATISTICS__
268// Heap statistics counters.
269static unsigned long long int mmap_storage;
270static unsigned int mmap_calls;
271static unsigned long long int munmap_storage;
272static unsigned int munmap_calls;
273static unsigned long long int sbrk_storage;
274static unsigned int sbrk_calls;
275static unsigned long long int malloc_storage;
276static unsigned int malloc_calls;
277static unsigned long long int free_storage;
278static unsigned int free_calls;
279static unsigned long long int aalloc_storage;
280static unsigned int aalloc_calls;
281static unsigned long long int calloc_storage;
282static unsigned int calloc_calls;
283static unsigned long long int memalign_storage;
284static unsigned int memalign_calls;
285static unsigned long long int amemalign_storage;
286static unsigned int amemalign_calls;
287static unsigned long long int cmemalign_storage;
288static unsigned int cmemalign_calls;
289static unsigned long long int resize_storage;
290static unsigned int resize_calls;
291static unsigned long long int realloc_storage;
292static unsigned int realloc_calls;
293// Statistics file descriptor (changed by malloc_stats_fd).
294static int statfd = STDERR_FILENO; // default stderr
295
296// Use "write" because streams may be shutdown when calls are made.
297static void printStats() {
298 char helpText[1024];
299 __cfaabi_bits_print_buffer( STDERR_FILENO, helpText, sizeof(helpText),
300 "\nHeap statistics:\n"
301 " malloc: calls %u / storage %llu\n"
302 " aalloc: calls %u / storage %llu\n"
303 " calloc: calls %u / storage %llu\n"
304 " memalign: calls %u / storage %llu\n"
305 " amemalign: calls %u / storage %llu\n"
306 " cmemalign: calls %u / storage %llu\n"
307 " resize: calls %u / storage %llu\n"
308 " realloc: calls %u / storage %llu\n"
309 " free: calls %u / storage %llu\n"
310 " mmap: calls %u / storage %llu\n"
311 " munmap: calls %u / storage %llu\n"
312 " sbrk: calls %u / storage %llu\n",
313 malloc_calls, malloc_storage,
314 aalloc_calls, calloc_storage,
315 calloc_calls, calloc_storage,
316 memalign_calls, memalign_storage,
317 amemalign_calls, amemalign_storage,
318 cmemalign_calls, cmemalign_storage,
319 resize_calls, resize_storage,
320 realloc_calls, realloc_storage,
321 free_calls, free_storage,
322 mmap_calls, mmap_storage,
323 munmap_calls, munmap_storage,
324 sbrk_calls, sbrk_storage
325 );
326} // printStats
327
328static int printStatsXML( FILE * stream ) { // see malloc_info
329 char helpText[1024];
330 int len = snprintf( helpText, sizeof(helpText),
331 "<malloc version=\"1\">\n"
332 "<heap nr=\"0\">\n"
333 "<sizes>\n"
334 "</sizes>\n"
335 "<total type=\"malloc\" count=\"%u\" size=\"%llu\"/>\n"
336 "<total type=\"aalloc\" count=\"%u\" size=\"%llu\"/>\n"
337 "<total type=\"calloc\" count=\"%u\" size=\"%llu\"/>\n"
338 "<total type=\"memalign\" count=\"%u\" size=\"%llu\"/>\n"
339 "<total type=\"amemalign\" count=\"%u\" size=\"%llu\"/>\n"
340 "<total type=\"cmemalign\" count=\"%u\" size=\"%llu\"/>\n"
341 "<total type=\"resize\" count=\"%u\" size=\"%llu\"/>\n"
342 "<total type=\"realloc\" count=\"%u\" size=\"%llu\"/>\n"
343 "<total type=\"free\" count=\"%u\" size=\"%llu\"/>\n"
344 "<total type=\"mmap\" count=\"%u\" size=\"%llu\"/>\n"
345 "<total type=\"munmap\" count=\"%u\" size=\"%llu\"/>\n"
346 "<total type=\"sbrk\" count=\"%u\" size=\"%llu\"/>\n"
347 "</malloc>",
348 malloc_calls, malloc_storage,
349 aalloc_calls, aalloc_storage,
350 calloc_calls, calloc_storage,
351 memalign_calls, memalign_storage,
352 amemalign_calls, amemalign_storage,
353 cmemalign_calls, cmemalign_storage,
354 resize_calls, resize_storage,
355 realloc_calls, realloc_storage,
356 free_calls, free_storage,
357 mmap_calls, mmap_storage,
358 munmap_calls, munmap_storage,
359 sbrk_calls, sbrk_storage
360 );
361 __cfaabi_bits_write( fileno( stream ), helpText, len ); // ensures all bytes written or exit
362 return len;
363} // printStatsXML
364#endif // __STATISTICS__
365
366
367// thunk problem
368size_t Bsearchl( unsigned int key, const unsigned int * vals, size_t dim ) {
369 size_t l = 0, m, h = dim;
370 while ( l < h ) {
371 m = (l + h) / 2;
372 if ( (unsigned int &)(vals[m]) < key ) { // cast away const
373 l = m + 1;
374 } else {
375 h = m;
376 } // if
377 } // while
378 return l;
379} // Bsearchl
380
381
382static inline bool setMmapStart( size_t value ) { // true => mmapped, false => sbrk
383 if ( value < pageSize || bucketSizes[NoBucketSizes - 1] < value ) return false;
384 mmapStart = value; // set global
385
386 // find the closest bucket size less than or equal to the mmapStart size
387 maxBucketsUsed = Bsearchl( (unsigned int)mmapStart, bucketSizes, NoBucketSizes ); // binary search
388 assert( maxBucketsUsed < NoBucketSizes ); // subscript failure ?
389 assert( mmapStart <= bucketSizes[maxBucketsUsed] ); // search failure ?
390 return true;
391} // setMmapStart
392
393
394// <-------+----------------------------------------------------> bsize (bucket size)
395// |header |addr
396//==================================================================================
397// align/offset |
398// <-----------------<------------+-----------------------------> bsize (bucket size)
399// |fake-header | addr
400#define headerAddr( addr ) ((HeapManager.Storage.Header *)( (char *)addr - sizeof(HeapManager.Storage) ))
401#define realHeader( header ) ((HeapManager.Storage.Header *)((char *)header - header->kind.fake.offset))
402
403// <-------<<--------------------- dsize ---------------------->> bsize (bucket size)
404// |header |addr
405//==================================================================================
406// align/offset |
407// <------------------------------<<---------- dsize --------->>> bsize (bucket size)
408// |fake-header |addr
409#define dataStorage( bsize, addr, header ) (bsize - ( (char *)addr - (char *)header ))
410
411
412// static inline void noMemory() {
413// abort( "Heap memory exhausted at %zu bytes.\n"
414// "Possible cause is very large memory allocation and/or large amount of unfreed storage allocated by the program or system/library routines.",
415// ((char *)(sbrk( 0 )) - (char *)(heapManager.heapBegin)) );
416// } // noMemory
417
418
419static inline void checkAlign( size_t alignment ) {
420 if ( alignment < libAlign() || ! libPow2( alignment ) ) {
421 abort( "Alignment %zu for memory allocation is less than %d and/or not a power of 2.", alignment, libAlign() );
422 } // if
423} // checkAlign
424
425
426static inline void checkHeader( bool check, const char name[], void * addr ) {
427 if ( unlikely( check ) ) { // bad address ?
428 abort( "Attempt to %s storage %p with address outside the heap.\n"
429 "Possible cause is duplicate free on same block or overwriting of memory.",
430 name, addr );
431 } // if
432} // checkHeader
433
434
435static inline void fakeHeader( HeapManager.Storage.Header *& header, size_t & alignment ) {
436 if ( unlikely( (header->kind.fake.alignment & 1) == 1 ) ) { // fake header ?
437 alignment = header->kind.fake.alignment & -2; // remove flag from value
438 #ifdef __CFA_DEBUG__
439 checkAlign( alignment ); // check alignment
440 #endif // __CFA_DEBUG__
441 header = realHeader( header ); // backup from fake to real header
442 } else {
443 alignment = 0;
444 } // if
445} // fakeHeader
446
447
448static inline bool headers( const char name[] __attribute__(( unused )), void * addr, HeapManager.Storage.Header *& header, HeapManager.FreeHeader *& freeElem,
449 size_t & size, size_t & alignment ) with( heapManager ) {
450 header = headerAddr( addr );
451
452 if ( unlikely( heapEnd < addr ) ) { // mmapped ?
453 fakeHeader( header, alignment );
454 size = header->kind.real.blockSize & -3; // mmap size
455 return true;
456 } // if
457
458 #ifdef __CFA_DEBUG__
459 checkHeader( addr < heapBegin, name, addr ); // bad low address ?
460 #endif // __CFA_DEBUG__
461
462 // header may be safe to dereference
463 fakeHeader( header, alignment );
464 #ifdef __CFA_DEBUG__
465 checkHeader( header < (HeapManager.Storage.Header *)heapBegin || (HeapManager.Storage.Header *)heapEnd < header, name, addr ); // bad address ? (offset could be + or -)
466 #endif // __CFA_DEBUG__
467
468 freeElem = (HeapManager.FreeHeader *)((size_t)header->kind.real.home & -3);
469 #ifdef __CFA_DEBUG__
470 if ( freeElem < &freeLists[0] || &freeLists[NoBucketSizes] <= freeElem ) {
471 abort( "Attempt to %s storage %p with corrupted header.\n"
472 "Possible cause is duplicate free on same block or overwriting of header information.",
473 name, addr );
474 } // if
475 #endif // __CFA_DEBUG__
476 size = freeElem->blockSize;
477 return false;
478} // headers
479
480#define NO_MEMORY_MSG "no heap memory available for allocating %zd new bytes."
481
482static inline void * extend( size_t size ) with( heapManager ) {
483 lock( extlock __cfaabi_dbg_ctx2 );
484 ptrdiff_t rem = heapRemaining - size;
485 if ( rem < 0 ) {
486 // If the size requested is bigger than the current remaining storage, increase the size of the heap.
487
488 size_t increase = libCeiling( size > heapExpand ? size : heapExpand, libAlign() );
489 Succeed:
490 {
491 if ( sbrk( increase ) != (void *)-1 ) break Succeed; // succeed ?
492 if ( default_heap_exhausted() ) { // try fix
493 if ( sbrk( increase ) != (void *)-1 ) break Succeed; // succeed ?
494 } // if
495 unlock( extlock );
496 abort( NO_MEMORY_MSG, size ); // give up
497 }
498 #ifdef __STATISTICS__
499 sbrk_calls += 1;
500 sbrk_storage += increase;
501 #endif // __STATISTICS__
502 #ifdef __CFA_DEBUG__
503 // Set new memory to garbage so subsequent uninitialized usages might fail.
504 memset( (char *)heapEnd + heapRemaining, '\377', increase );
505 #endif // __CFA_DEBUG__
506 rem = heapRemaining + increase - size;
507 } // if
508
509 HeapManager.Storage * block = (HeapManager.Storage *)heapEnd;
510 heapRemaining = rem;
511 heapEnd = (char *)heapEnd + size;
512 unlock( extlock );
513 return block;
514} // extend
515
516
517static inline void * doMalloc( size_t size ) with( heapManager ) {
518 HeapManager.Storage * block; // pointer to new block of storage
519
520 // Look up size in the size list. Make sure the user request includes space for the header that must be allocated
521 // along with the block and is a multiple of the alignment size.
522
523 if ( unlikely( size > ULONG_MAX - sizeof(HeapManager.Storage) ) ) return 0p;
524 size_t tsize = size + sizeof(HeapManager.Storage);
525 if ( likely( tsize < mmapStart ) ) { // small size => sbrk
526 size_t posn;
527 #ifdef FASTLOOKUP
528 if ( tsize < LookupSizes ) posn = lookup[tsize];
529 else
530 #endif // FASTLOOKUP
531 posn = Bsearchl( (unsigned int)tsize, bucketSizes, (size_t)maxBucketsUsed );
532 HeapManager.FreeHeader * freeElem = &freeLists[posn];
533 // #ifdef FASTLOOKUP
534 // if ( tsize < LookupSizes )
535 // freeElem = &freeLists[lookup[tsize]];
536 // else
537 // #endif // FASTLOOKUP
538 // freeElem = bsearchl( tsize, freeLists, (size_t)maxBucketsUsed ); // binary search
539 // HeapManager.FreeHeader * freeElem =
540 // #ifdef FASTLOOKUP
541 // tsize < LookupSizes ? &freeLists[lookup[tsize]] :
542 // #endif // FASTLOOKUP
543 // bsearchl( tsize, freeLists, (size_t)maxBucketsUsed ); // binary search
544 assert( freeElem <= &freeLists[maxBucketsUsed] ); // subscripting error ?
545 assert( tsize <= freeElem->blockSize ); // search failure ?
546 tsize = freeElem->blockSize; // total space needed for request
547
548 // Spin until the lock is acquired for this particular size of block.
549
550 #if BUCKETLOCK == SPINLOCK
551 lock( freeElem->lock __cfaabi_dbg_ctx2 );
552 block = freeElem->freeList; // remove node from stack
553 #else
554 block = pop( freeElem->freeList );
555 #endif // BUCKETLOCK
556 if ( unlikely( block == 0p ) ) { // no free block ?
557 #if BUCKETLOCK == SPINLOCK
558 unlock( freeElem->lock );
559 #endif // BUCKETLOCK
560
561 // Freelist for that size was empty, so carve it out of the heap if there's enough left, or get some more
562 // and then carve it off.
563
564 block = (HeapManager.Storage *)extend( tsize ); // mutual exclusion on call
565 #if BUCKETLOCK == SPINLOCK
566 } else {
567 freeElem->freeList = block->header.kind.real.next;
568 unlock( freeElem->lock );
569 #endif // BUCKETLOCK
570 } // if
571
572 block->header.kind.real.home = freeElem; // pointer back to free list of apropriate size
573 } else { // large size => mmap
574 if ( unlikely( size > ULONG_MAX - pageSize ) ) return 0p;
575 tsize = libCeiling( tsize, pageSize ); // must be multiple of page size
576 #ifdef __STATISTICS__
577 __atomic_add_fetch( &mmap_calls, 1, __ATOMIC_SEQ_CST );
578 __atomic_add_fetch( &mmap_storage, tsize, __ATOMIC_SEQ_CST );
579 #endif // __STATISTICS__
580 Succeed:
581 {
582 block = (HeapManager.Storage *)mmap( 0, tsize, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, mmapFd, 0 );
583 if ( block != (HeapManager.Storage *)MAP_FAILED ) break Succeed; // succeed ?
584 if ( errno == ENOMEM && default_heap_exhausted() ) { // out of memory and try again ?
585 block = (HeapManager.Storage *)mmap( 0, tsize, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, mmapFd, 0 );
586 if ( block != (HeapManager.Storage *)MAP_FAILED ) break Succeed; // succeed ?
587 } // if
588 if ( errno == ENOMEM ) abort( NO_MEMORY_MSG, tsize );
589 // Do not call strerror( errno ) as it may call malloc.
590 abort( "(HeapManager &)0x%p.doMalloc() : internal error, mmap failure, size:%zu error:%d.", &heapManager, tsize, errno );
591 }
592 #ifdef __CFA_DEBUG__
593 // Set new memory to garbage so subsequent uninitialized usages might fail.
594 memset( block, '\377', tsize );
595 #endif // __CFA_DEBUG__
596 block->header.kind.real.blockSize = tsize; // storage size for munmap
597 } // if
598
599 block->header.kind.real.size = size; // store allocation size
600 void * addr = &(block->data); // adjust off header to user bytes
601
602 #ifdef __CFA_DEBUG__
603 assert( ((uintptr_t)addr & (libAlign() - 1)) == 0 ); // minimum alignment ?
604 __atomic_add_fetch( &allocFree, tsize, __ATOMIC_SEQ_CST );
605 if ( traceHeap() ) {
606 enum { BufferSize = 64 };
607 char helpText[BufferSize];
608 int len = snprintf( helpText, BufferSize, "%p = Malloc( %zu ) (allocated %zu)\n", addr, size, tsize );
609 // int len = snprintf( helpText, BufferSize, "Malloc %p %zu\n", addr, size );
610 __cfaabi_bits_write( STDERR_FILENO, helpText, len ); // print debug/nodebug
611 } // if
612 #endif // __CFA_DEBUG__
613
614 return addr;
615} // doMalloc
616
617
618static inline void doFree( void * addr ) with( heapManager ) {
619 #ifdef __CFA_DEBUG__
620 if ( unlikely( heapManager.heapBegin == 0p ) ) {
621 abort( "doFree( %p ) : internal error, called before heap is initialized.", addr );
622 } // if
623 #endif // __CFA_DEBUG__
624
625 HeapManager.Storage.Header * header;
626 HeapManager.FreeHeader * freeElem;
627 size_t size, alignment; // not used (see realloc)
628
629 if ( headers( "free", addr, header, freeElem, size, alignment ) ) { // mmapped ?
630 #ifdef __STATISTICS__
631 __atomic_add_fetch( &munmap_calls, 1, __ATOMIC_SEQ_CST );
632 __atomic_add_fetch( &munmap_storage, size, __ATOMIC_SEQ_CST );
633 #endif // __STATISTICS__
634 if ( munmap( header, size ) == -1 ) {
635 #ifdef __CFA_DEBUG__
636 abort( "Attempt to deallocate storage %p not allocated or with corrupt header.\n"
637 "Possible cause is invalid pointer.",
638 addr );
639 #endif // __CFA_DEBUG__
640 } // if
641 } else {
642 #ifdef __CFA_DEBUG__
643 // Set free memory to garbage so subsequent usages might fail.
644 memset( ((HeapManager.Storage *)header)->data, '\377', freeElem->blockSize - sizeof( HeapManager.Storage ) );
645 #endif // __CFA_DEBUG__
646
647 #ifdef __STATISTICS__
648 free_storage += size;
649 #endif // __STATISTICS__
650 #if BUCKETLOCK == SPINLOCK
651 lock( freeElem->lock __cfaabi_dbg_ctx2 ); // acquire spin lock
652 header->kind.real.next = freeElem->freeList; // push on stack
653 freeElem->freeList = (HeapManager.Storage *)header;
654 unlock( freeElem->lock ); // release spin lock
655 #else
656 push( freeElem->freeList, *(HeapManager.Storage *)header );
657 #endif // BUCKETLOCK
658 } // if
659
660 #ifdef __CFA_DEBUG__
661 __atomic_add_fetch( &allocFree, -size, __ATOMIC_SEQ_CST );
662 if ( traceHeap() ) {
663 enum { BufferSize = 64 };
664 char helpText[BufferSize];
665 int len = snprintf( helpText, sizeof(helpText), "Free( %p ) size:%zu\n", addr, size );
666 __cfaabi_bits_write( STDERR_FILENO, helpText, len ); // print debug/nodebug
667 } // if
668 #endif // __CFA_DEBUG__
669} // doFree
670
671
672size_t prtFree( HeapManager & manager ) with( manager ) {
673 size_t total = 0;
674 #ifdef __STATISTICS__
675 __cfaabi_bits_acquire();
676 __cfaabi_bits_print_nolock( STDERR_FILENO, "\nBin lists (bin size : free blocks on list)\n" );
677 #endif // __STATISTICS__
678 for ( unsigned int i = 0; i < maxBucketsUsed; i += 1 ) {
679 size_t size = freeLists[i].blockSize;
680 #ifdef __STATISTICS__
681 unsigned int N = 0;
682 #endif // __STATISTICS__
683
684 #if BUCKETLOCK == SPINLOCK
685 for ( HeapManager.Storage * p = freeLists[i].freeList; p != 0p; p = p->header.kind.real.next ) {
686 #else
687 for ( HeapManager.Storage * p = top( freeLists[i].freeList ); p != 0p; /* p = getNext( p )->top */) {
688 typeof(p) temp = ( p )`next->top; // FIX ME: direct assignent fails, initialization works
689 p = temp;
690 #endif // BUCKETLOCK
691 total += size;
692 #ifdef __STATISTICS__
693 N += 1;
694 #endif // __STATISTICS__
695 } // for
696
697 #ifdef __STATISTICS__
698 __cfaabi_bits_print_nolock( STDERR_FILENO, "%7zu, %-7u ", size, N );
699 if ( (i + 1) % 8 == 0 ) __cfaabi_bits_print_nolock( STDERR_FILENO, "\n" );
700 #endif // __STATISTICS__
701 } // for
702 #ifdef __STATISTICS__
703 __cfaabi_bits_print_nolock( STDERR_FILENO, "\ntotal free blocks:%zu\n", total );
704 __cfaabi_bits_release();
705 #endif // __STATISTICS__
706 return (char *)heapEnd - (char *)heapBegin - total;
707} // prtFree
708
709
710static void ?{}( HeapManager & manager ) with( manager ) {
711 pageSize = sysconf( _SC_PAGESIZE );
712
713 for ( unsigned int i = 0; i < NoBucketSizes; i += 1 ) { // initialize the free lists
714 freeLists[i].blockSize = bucketSizes[i];
715 } // for
716
717 #ifdef FASTLOOKUP
718 unsigned int idx = 0;
719 for ( unsigned int i = 0; i < LookupSizes; i += 1 ) {
720 if ( i > bucketSizes[idx] ) idx += 1;
721 lookup[i] = idx;
722 } // for
723 #endif // FASTLOOKUP
724
725 if ( ! setMmapStart( default_mmap_start() ) ) {
726 abort( "HeapManager : internal error, mmap start initialization failure." );
727 } // if
728 heapExpand = default_heap_expansion();
729
730 char * end = (char *)sbrk( 0 );
731 heapBegin = heapEnd = sbrk( (char *)libCeiling( (long unsigned int)end, libAlign() ) - end ); // move start of heap to multiple of alignment
732} // HeapManager
733
734
735static void ^?{}( HeapManager & ) {
736 #ifdef __STATISTICS__
737 if ( traceHeapTerm() ) {
738 printStats();
739 // if ( prtfree() ) prtFree( heapManager, true );
740 } // if
741 #endif // __STATISTICS__
742} // ~HeapManager
743
744
745static void memory_startup( void ) __attribute__(( constructor( STARTUP_PRIORITY_MEMORY ) ));
746void memory_startup( void ) {
747 #ifdef __CFA_DEBUG__
748 if ( unlikely( heapBoot ) ) { // check for recursion during system boot
749 // DO NOT USE STREAMS AS THEY MAY BE UNAVAILABLE AT THIS POINT.
750 abort( "boot() : internal error, recursively invoked during system boot." );
751 } // if
752 heapBoot = true;
753 #endif // __CFA_DEBUG__
754
755 //assert( heapManager.heapBegin != 0 );
756 //heapManager{};
757 if ( heapManager.heapBegin == 0p ) heapManager{}; // sanity check
758} // memory_startup
759
760static void memory_shutdown( void ) __attribute__(( destructor( STARTUP_PRIORITY_MEMORY ) ));
761void memory_shutdown( void ) {
762 ^heapManager{};
763} // memory_shutdown
764
765
766static inline void * mallocNoStats( size_t size ) { // necessary for malloc statistics
767 verify( heapManager.heapBegin != 0 ); // called before memory_startup ?
768 if ( unlikely( size ) == 0 ) return 0p; // 0 BYTE ALLOCATION RETURNS NULL POINTER
769
770#if __SIZEOF_POINTER__ == 8
771 verify( size < ((typeof(size_t))1 << 48) );
772#endif // __SIZEOF_POINTER__ == 8
773 return doMalloc( size );
774} // mallocNoStats
775
776
777static inline void * callocNoStats( size_t dim, size_t elemSize ) {
778 size_t size = dim * elemSize;
779 if ( unlikely( size ) == 0 ) return 0p; // 0 BYTE ALLOCATION RETURNS NULL POINTER
780 char * addr = (char *)mallocNoStats( size );
781
782 HeapManager.Storage.Header * header;
783 HeapManager.FreeHeader * freeElem;
784 size_t bsize, alignment;
785 #ifndef __CFA_DEBUG__
786 bool mapped =
787 #endif // __CFA_DEBUG__
788 headers( "calloc", addr, header, freeElem, bsize, alignment );
789 #ifndef __CFA_DEBUG__
790
791 // Mapped storage is zero filled, but in debug mode mapped memory is scrubbed in doMalloc, so it has to be reset to zero.
792 if ( ! mapped )
793 #endif // __CFA_DEBUG__
794 // <-------0000000000000000000000000000UUUUUUUUUUUUUUUUUUUUUUUUU> bsize (bucket size) U => undefined
795 // `-header`-addr `-size
796 memset( addr, '\0', size ); // set to zeros
797
798 header->kind.real.blockSize |= 2; // mark as zero filled
799 return addr;
800} // callocNoStats
801
802
803static inline void * memalignNoStats( size_t alignment, size_t size ) { // necessary for malloc statistics
804 if ( unlikely( size ) == 0 ) return 0p; // 0 BYTE ALLOCATION RETURNS NULL POINTER
805
806 #ifdef __CFA_DEBUG__
807 checkAlign( alignment ); // check alignment
808 #endif // __CFA_DEBUG__
809
810 // if alignment <= default alignment, do normal malloc as two headers are unnecessary
811 if ( unlikely( alignment <= libAlign() ) ) return mallocNoStats( size );
812
813 // Allocate enough storage to guarantee an address on the alignment boundary, and sufficient space before it for
814 // administrative storage. NOTE, WHILE THERE ARE 2 HEADERS, THE FIRST ONE IS IMPLICITLY CREATED BY DOMALLOC.
815 // .-------------v-----------------v----------------v----------,
816 // | Real Header | ... padding ... | Fake Header | data ... |
817 // `-------------^-----------------^-+--------------^----------'
818 // |<--------------------------------' offset/align |<-- alignment boundary
819
820 // subtract libAlign() because it is already the minimum alignment
821 // add sizeof(Storage) for fake header
822 char * addr = (char *)mallocNoStats( size + alignment - libAlign() + sizeof(HeapManager.Storage) );
823
824 // address in the block of the "next" alignment address
825 char * user = (char *)libCeiling( (uintptr_t)(addr + sizeof(HeapManager.Storage)), alignment );
826
827 // address of header from malloc
828 HeapManager.Storage.Header * realHeader = headerAddr( addr );
829 realHeader->kind.real.size = size; // correct size to eliminate above alignment offset
830 // address of fake header * before* the alignment location
831 HeapManager.Storage.Header * fakeHeader = headerAddr( user );
832 // SKULLDUGGERY: insert the offset to the start of the actual storage block and remember alignment
833 fakeHeader->kind.fake.offset = (char *)fakeHeader - (char *)realHeader;
834 // SKULLDUGGERY: odd alignment imples fake header
835 fakeHeader->kind.fake.alignment = alignment | 1;
836
837 return user;
838} // memalignNoStats
839
840
841static inline void * cmemalignNoStats( size_t alignment, size_t dim, size_t elemSize ) {
842 size_t size = dim * elemSize;
843 if ( unlikely( size ) == 0 ) return 0p; // 0 BYTE ALLOCATION RETURNS NULL POINTER
844 char * addr = (char *)memalignNoStats( alignment, size );
845
846 HeapManager.Storage.Header * header;
847 HeapManager.FreeHeader * freeElem;
848 size_t bsize;
849 #ifndef __CFA_DEBUG__
850 bool mapped =
851 #endif // __CFA_DEBUG__
852 headers( "cmemalign", addr, header, freeElem, bsize, alignment );
853 #ifndef __CFA_DEBUG__
854
855 // Mapped storage is zero filled, but in debug mode mapped memory is scrubbed in doMalloc, so it has to be reset to zero.
856 if ( ! mapped )
857 #endif // __CFA_DEBUG__
858 // <-------0000000000000000000000000000UUUUUUUUUUUUUUUUUUUUUUUUU> bsize (bucket size) U => undefined
859 // `-header`-addr `-size
860 memset( addr, '\0', size ); // set to zeros
861
862 header->kind.real.blockSize |= 2; // mark as zero filled
863 return addr;
864} // cmemalignNoStats
865
866
867// supported mallopt options
868#ifndef M_MMAP_THRESHOLD
869#define M_MMAP_THRESHOLD (-1)
870#endif // M_TOP_PAD
871#ifndef M_TOP_PAD
872#define M_TOP_PAD (-2)
873#endif // M_TOP_PAD
874
875
876extern "C" {
877 // Allocates size bytes and returns a pointer to the allocated memory. The contents are undefined. If size is 0,
878 // then malloc() returns a unique pointer value that can later be successfully passed to free().
879 void * malloc( size_t size ) {
880 #ifdef __STATISTICS__
881 __atomic_add_fetch( &malloc_calls, 1, __ATOMIC_SEQ_CST );
882 __atomic_add_fetch( &malloc_storage, size, __ATOMIC_SEQ_CST );
883 #endif // __STATISTICS__
884
885 return mallocNoStats( size );
886 } // malloc
887
888
889 // Same as malloc() except size bytes is an array of dim elements each of elemSize bytes.
890 void * aalloc( size_t dim, size_t elemSize ) {
891 #ifdef __STATISTICS__
892 __atomic_add_fetch( &aalloc_calls, 1, __ATOMIC_SEQ_CST );
893 __atomic_add_fetch( &aalloc_storage, dim * elemSize, __ATOMIC_SEQ_CST );
894 #endif // __STATISTICS__
895
896 return mallocNoStats( dim * elemSize );
897 } // aalloc
898
899
900 // Same as aalloc() with memory set to zero.
901 void * calloc( size_t dim, size_t elemSize ) {
902 #ifdef __STATISTICS__
903 __atomic_add_fetch( &calloc_calls, 1, __ATOMIC_SEQ_CST );
904 __atomic_add_fetch( &calloc_storage, dim * elemSize, __ATOMIC_SEQ_CST );
905 #endif // __STATISTICS__
906
907 return callocNoStats( dim, elemSize );
908 } // calloc
909
910 // Change the size of the memory block pointed to by oaddr to size bytes. The contents are undefined. If oaddr is
911 // 0p, then the call is equivalent to malloc(size), for all values of size; if size is equal to zero, and oaddr is
912 // not 0p, then the call is equivalent to free(oaddr). Unless oaddr is 0p, it must have been returned by an earlier
913 // call to malloc(), alloc(), calloc() or realloc(). If the area pointed to was moved, a free(oaddr) is done.
914 void * resize( void * oaddr, size_t size ) {
915 #ifdef __STATISTICS__
916 __atomic_add_fetch( &resize_calls, 1, __ATOMIC_SEQ_CST );
917 __atomic_add_fetch( &resize_storage, size, __ATOMIC_SEQ_CST );
918 #endif // __STATISTICS__
919
920 // If size is equal to 0, either NULL or a pointer suitable to be passed to free() is returned.
921 if ( unlikely( size == 0 ) ) { free( oaddr ); return 0p; } // special cases
922 if ( unlikely( oaddr == 0p ) ) return mallocNoStats( size );
923
924 HeapManager.Storage.Header * header;
925 HeapManager.FreeHeader * freeElem;
926 size_t bsize, oalign = 0;
927 headers( "resize", oaddr, header, freeElem, bsize, oalign );
928
929 size_t odsize = dataStorage( bsize, oaddr, header ); // data storage available in bucket
930 // same size, DO NOT preserve STICKY PROPERTIES.
931 if ( oalign == 0 && size <= odsize && odsize <= size * 2 ) { // allow 50% wasted storage for smaller size
932 header->kind.real.blockSize &= -2; // no alignment and turn off 0 fill
933 header->kind.real.size = size; // reset allocation size
934 return oaddr;
935 } // if
936
937 // change size, DO NOT preserve STICKY PROPERTIES.
938 free( oaddr );
939 return mallocNoStats( size ); // create new area
940 } // resize
941
942
943 // Same as resize() but the contents are unchanged in the range from the start of the region up to the minimum of
944 // the old and new sizes.
945 void * realloc( void * oaddr, size_t size ) {
946 #ifdef __STATISTICS__
947 __atomic_add_fetch( &realloc_calls, 1, __ATOMIC_SEQ_CST );
948 __atomic_add_fetch( &realloc_storage, size, __ATOMIC_SEQ_CST );
949 #endif // __STATISTICS__
950
951 // If size is equal to 0, either NULL or a pointer suitable to be passed to free() is returned.
952 if ( unlikely( size == 0 ) ) { free( oaddr ); return 0p; } // special cases
953 if ( unlikely( oaddr == 0p ) ) return mallocNoStats( size );
954
955 HeapManager.Storage.Header * header;
956 HeapManager.FreeHeader * freeElem;
957 size_t bsize, oalign = 0;
958 headers( "realloc", oaddr, header, freeElem, bsize, oalign );
959
960 size_t odsize = dataStorage( bsize, oaddr, header ); // data storage available in bucket
961 size_t osize = header->kind.real.size; // old allocation size
962 bool ozfill = (header->kind.real.blockSize & 2) != 0; // old allocation zero filled
963 if ( unlikely( size <= odsize ) && size > odsize / 2 ) { // allow up to 50% wasted storage
964 header->kind.real.size = size; // reset allocation size
965 if ( unlikely( ozfill ) && size > osize ) { // previous request zero fill and larger ?
966 memset( (char *)oaddr + osize, (int)'\0', size - osize ); // initialize added storage
967 } // if
968 return oaddr;
969 } // if
970
971 // change size and copy old content to new storage
972
973 void * naddr;
974 if ( likely( oalign == 0 ) ) { // previous request memalign?
975 naddr = mallocNoStats( size ); // create new area
976 } else {
977 naddr = memalignNoStats( oalign, size ); // create new aligned area
978 } // if
979
980 headers( "realloc", naddr, header, freeElem, bsize, oalign );
981 memcpy( naddr, oaddr, MIN( osize, size ) ); // copy bytes
982 free( oaddr );
983
984 if ( unlikely( ozfill ) ) { // previous request zero fill ?
985 header->kind.real.blockSize |= 2; // mark new request as zero filled
986 if ( size > osize ) { // previous request larger ?
987 memset( (char *)naddr + osize, (int)'\0', size - osize ); // initialize added storage
988 } // if
989 } // if
990 return naddr;
991 } // realloc
992
993 // Same as malloc() except the memory address is a multiple of alignment, which must be a power of two. (obsolete)
994 void * memalign( size_t alignment, size_t size ) {
995 #ifdef __STATISTICS__
996 __atomic_add_fetch( &memalign_calls, 1, __ATOMIC_SEQ_CST );
997 __atomic_add_fetch( &memalign_storage, size, __ATOMIC_SEQ_CST );
998 #endif // __STATISTICS__
999
1000 return memalignNoStats( alignment, size );
1001 } // memalign
1002
1003
1004 // Same as aalloc() with memory alignment.
1005 void * amemalign( size_t alignment, size_t dim, size_t elemSize ) {
1006 #ifdef __STATISTICS__
1007 __atomic_add_fetch( &cmemalign_calls, 1, __ATOMIC_SEQ_CST );
1008 __atomic_add_fetch( &cmemalign_storage, dim * elemSize, __ATOMIC_SEQ_CST );
1009 #endif // __STATISTICS__
1010
1011 return memalignNoStats( alignment, dim * elemSize );
1012 } // amemalign
1013
1014
1015 // Same as calloc() with memory alignment.
1016 void * cmemalign( size_t alignment, size_t dim, size_t elemSize ) {
1017 #ifdef __STATISTICS__
1018 __atomic_add_fetch( &cmemalign_calls, 1, __ATOMIC_SEQ_CST );
1019 __atomic_add_fetch( &cmemalign_storage, dim * elemSize, __ATOMIC_SEQ_CST );
1020 #endif // __STATISTICS__
1021
1022 return cmemalignNoStats( alignment, dim, elemSize );
1023 } // cmemalign
1024
1025 // Same as memalign(), but ISO/IEC 2011 C11 Section 7.22.2 states: the value of size shall be an integral multiple
1026 // of alignment. This requirement is universally ignored.
1027 void * aligned_alloc( size_t alignment, size_t size ) {
1028 return memalign( alignment, size );
1029 } // aligned_alloc
1030
1031
1032 // Allocates size bytes and places the address of the allocated memory in *memptr. The address of the allocated
1033 // memory shall be a multiple of alignment, which must be a power of two and a multiple of sizeof(void *). If size
1034 // is 0, then posix_memalign() returns either 0p, or a unique pointer value that can later be successfully passed to
1035 // free(3).
1036 int posix_memalign( void ** memptr, size_t alignment, size_t size ) {
1037 if ( alignment < sizeof(void *) || ! libPow2( alignment ) ) return EINVAL; // check alignment
1038 * memptr = memalign( alignment, size );
1039 return 0;
1040 } // posix_memalign
1041
1042 // Allocates size bytes and returns a pointer to the allocated memory. The memory address shall be a multiple of the
1043 // page size. It is equivalent to memalign(sysconf(_SC_PAGESIZE),size).
1044 void * valloc( size_t size ) {
1045 return memalign( pageSize, size );
1046 } // valloc
1047
1048
1049 // Same as valloc but rounds size to multiple of page size.
1050 void * pvalloc( size_t size ) {
1051 return memalign( pageSize, libCeiling( size, pageSize ) );
1052 } // pvalloc
1053
1054
1055 // Frees the memory space pointed to by ptr, which must have been returned by a previous call to malloc(), calloc()
1056 // or realloc(). Otherwise, or if free(ptr) has already been called before, undefined behaviour occurs. If ptr is
1057 // 0p, no operation is performed.
1058 void free( void * addr ) {
1059 #ifdef __STATISTICS__
1060 __atomic_add_fetch( &free_calls, 1, __ATOMIC_SEQ_CST );
1061 #endif // __STATISTICS__
1062
1063 if ( unlikely( addr == 0p ) ) { // special case
1064 // #ifdef __CFA_DEBUG__
1065 // if ( traceHeap() ) {
1066 // #define nullmsg "Free( 0x0 ) size:0\n"
1067 // // Do not debug print free( 0p ), as it can cause recursive entry from sprintf.
1068 // __cfaabi_dbg_write( nullmsg, sizeof(nullmsg) - 1 );
1069 // } // if
1070 // #endif // __CFA_DEBUG__
1071 return;
1072 } // exit
1073
1074 doFree( addr );
1075 } // free
1076
1077
1078 // Returns the alignment of an allocation.
1079 size_t malloc_alignment( void * addr ) {
1080 if ( unlikely( addr == 0p ) ) return libAlign(); // minimum alignment
1081 HeapManager.Storage.Header * header = headerAddr( addr );
1082 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1083 return header->kind.fake.alignment & -2; // remove flag from value
1084 } else {
1085 return libAlign(); // minimum alignment
1086 } // if
1087 } // malloc_alignment
1088
1089 // Set the alignment for an the allocation and return previous alignment or 0 if no alignment.
1090 size_t $malloc_alignment_set( void * addr, size_t alignment ) {
1091 if ( unlikely( addr == 0p ) ) return libAlign(); // minimum alignment
1092 size_t ret;
1093 HeapManager.Storage.Header * header = headerAddr( addr );
1094 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1095 ret = header->kind.fake.alignment & -2; // remove flag from old value
1096 header->kind.fake.alignment = alignment | 1; // add flag to new value
1097 } else {
1098 ret = 0; // => no alignment to change
1099 } // if
1100 return ret;
1101 } // $malloc_alignment_set
1102
1103
1104 // Returns true if the allocation is zero filled, e.g., allocated by calloc().
1105 bool malloc_zero_fill( void * addr ) {
1106 if ( unlikely( addr == 0p ) ) return false; // null allocation is not zero fill
1107 HeapManager.Storage.Header * header = headerAddr( addr );
1108 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1109 header = realHeader( header ); // backup from fake to real header
1110 } // if
1111 return (header->kind.real.blockSize & 2) != 0; // zero filled ?
1112 } // malloc_zero_fill
1113
1114 // Set allocation is zero filled and return previous zero filled.
1115 bool $malloc_zero_fill_set( void * addr ) {
1116 if ( unlikely( addr == 0p ) ) return false; // null allocation is not zero fill
1117 HeapManager.Storage.Header * header = headerAddr( addr );
1118 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1119 header = realHeader( header ); // backup from fake to real header
1120 } // if
1121 bool ret = (header->kind.real.blockSize & 2) != 0; // zero filled ?
1122 header->kind.real.blockSize |= 2; // mark as zero filled
1123 return ret;
1124 } // $malloc_zero_fill_set
1125
1126
1127 // Returns original total allocation size (not bucket size) => array size is dimension * sizeif(T).
1128 size_t malloc_size( void * addr ) {
1129 if ( unlikely( addr == 0p ) ) return 0; // null allocation has zero size
1130 HeapManager.Storage.Header * header = headerAddr( addr );
1131 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1132 header = realHeader( header ); // backup from fake to real header
1133 } // if
1134 return header->kind.real.size;
1135 } // malloc_size
1136
1137 // Set allocation size and return previous size.
1138 size_t $malloc_size_set( void * addr, size_t size ) {
1139 if ( unlikely( addr == 0p ) ) return 0; // null allocation has 0 size
1140 HeapManager.Storage.Header * header = headerAddr( addr );
1141 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1142 header = realHeader( header ); // backup from fake to real header
1143 } // if
1144 size_t ret = header->kind.real.size;
1145 header->kind.real.size = size;
1146 return ret;
1147 } // $malloc_size_set
1148
1149
1150 // Returns the number of usable bytes in the block pointed to by ptr, a pointer to a block of memory allocated by
1151 // malloc or a related function.
1152 size_t malloc_usable_size( void * addr ) {
1153 if ( unlikely( addr == 0p ) ) return 0; // null allocation has 0 size
1154 HeapManager.Storage.Header * header;
1155 HeapManager.FreeHeader * freeElem;
1156 size_t bsize, alignment;
1157
1158 headers( "malloc_usable_size", addr, header, freeElem, bsize, alignment );
1159 return dataStorage( bsize, addr, header ); // data storage in bucket
1160 } // malloc_usable_size
1161
1162
1163 // Prints (on default standard error) statistics about memory allocated by malloc and related functions.
1164 void malloc_stats( void ) {
1165 #ifdef __STATISTICS__
1166 printStats();
1167 if ( prtFree() ) prtFree( heapManager );
1168 #endif // __STATISTICS__
1169 } // malloc_stats
1170
1171 // Changes the file descripter where malloc_stats() writes statistics.
1172 int malloc_stats_fd( int fd __attribute__(( unused )) ) {
1173 #ifdef __STATISTICS__
1174 int temp = statfd;
1175 statfd = fd;
1176 return temp;
1177 #else
1178 return -1;
1179 #endif // __STATISTICS__
1180 } // malloc_stats_fd
1181
1182
1183 // Adjusts parameters that control the behaviour of the memory-allocation functions (see malloc). The param argument
1184 // specifies the parameter to be modified, and value specifies the new value for that parameter.
1185 int mallopt( int option, int value ) {
1186 choose( option ) {
1187 case M_TOP_PAD:
1188 heapExpand = ceiling( value, pageSize ); return 1;
1189 case M_MMAP_THRESHOLD:
1190 if ( setMmapStart( value ) ) return 1;
1191 break;
1192 } // switch
1193 return 0; // error, unsupported
1194 } // mallopt
1195
1196 // Attempt to release free memory at the top of the heap (by calling sbrk with a suitable argument).
1197 int malloc_trim( size_t ) {
1198 return 0; // => impossible to release memory
1199 } // malloc_trim
1200
1201
1202 // Exports an XML string that describes the current state of the memory-allocation implementation in the caller.
1203 // The string is printed on the file stream stream. The exported string includes information about all arenas (see
1204 // malloc).
1205 int malloc_info( int options, FILE * stream ) {
1206 if ( options != 0 ) { errno = EINVAL; return -1; }
1207 return printStatsXML( stream );
1208 } // malloc_info
1209
1210
1211 // Records the current state of all malloc internal bookkeeping variables (but not the actual contents of the heap
1212 // or the state of malloc_hook functions pointers). The state is recorded in a system-dependent opaque data
1213 // structure dynamically allocated via malloc, and a pointer to that data structure is returned as the function
1214 // result. (The caller must free this memory.)
1215 void * malloc_get_state( void ) {
1216 return 0p; // unsupported
1217 } // malloc_get_state
1218
1219
1220 // Restores the state of all malloc internal bookkeeping variables to the values recorded in the opaque data
1221 // structure pointed to by state.
1222 int malloc_set_state( void * ptr ) {
1223 return 0; // unsupported
1224 } // malloc_set_state
1225} // extern "C"
1226
1227
1228// Must have CFA linkage to overload with C linkage realloc.
1229void * resize( void * oaddr, size_t nalign, size_t size ) {
1230 #ifdef __STATISTICS__
1231 __atomic_add_fetch( &resize_calls, 1, __ATOMIC_SEQ_CST );
1232 __atomic_add_fetch( &resize_storage, size, __ATOMIC_SEQ_CST );
1233 #endif // __STATISTICS__
1234
1235 // If size is equal to 0, either NULL or a pointer suitable to be passed to free() is returned.
1236 if ( unlikely( size == 0 ) ) { free( oaddr ); return 0p; } // special cases
1237 if ( unlikely( oaddr == 0p ) ) return memalignNoStats( nalign, size );
1238
1239 if ( unlikely( nalign == 0 ) ) nalign = libAlign(); // reset alignment to minimum
1240 #ifdef __CFA_DEBUG__
1241 else
1242 checkAlign( nalign ); // check alignment
1243 #endif // __CFA_DEBUG__
1244
1245 HeapManager.Storage.Header * header;
1246 HeapManager.FreeHeader * freeElem;
1247 size_t bsize, oalign = 0;
1248 headers( "resize", oaddr, header, freeElem, bsize, oalign );
1249 size_t odsize = dataStorage( bsize, oaddr, header ); // data storage available in bucket
1250
1251 if ( oalign <= nalign && (uintptr_t)oaddr % nalign == 0 ) { // <= alignment and new alignment happens to match
1252 if ( oalign >= libAlign() ) { // fake header ?
1253 headerAddr( oaddr )->kind.fake.alignment = nalign | 1; // update alignment (could be the same)
1254 } // if
1255 if ( size <= odsize && odsize <= size * 2 ) { // allow 50% wasted storage for smaller size
1256 header->kind.real.blockSize &= -2; // turn off 0 fill
1257 header->kind.real.size = size; // reset allocation size
1258 return oaddr;
1259 } // if
1260 } // if
1261
1262 // change size, DO NOT preserve STICKY PROPERTIES.
1263 free( oaddr );
1264 return memalignNoStats( nalign, size ); // create new aligned area
1265} // resize
1266
1267
1268void * realloc( void * oaddr, size_t nalign, size_t size ) {
1269 if ( unlikely( nalign == 0 ) ) nalign = libAlign(); // reset alignment to minimum
1270 #ifdef __CFA_DEBUG__
1271 else
1272 checkAlign( nalign ); // check alignment
1273 #endif // __CFA_DEBUG__
1274
1275 HeapManager.Storage.Header * header;
1276 HeapManager.FreeHeader * freeElem;
1277 size_t bsize, oalign = 0;
1278 headers( "realloc", oaddr, header, freeElem, bsize, oalign );
1279
1280 if ( oalign <= nalign && (uintptr_t)oaddr % nalign == 0 ) { // <= alignment and new alignment happens to match
1281 if ( oalign >= libAlign() ) { // fake header ?
1282 headerAddr( oaddr )->kind.fake.alignment = nalign | 1; // update alignment (could be the same)
1283 } // if
1284 return realloc( oaddr, size );
1285 } // if
1286
1287 // change size and copy old content to new storage
1288
1289 #ifdef __STATISTICS__
1290 __atomic_add_fetch( &realloc_calls, 1, __ATOMIC_SEQ_CST );
1291 __atomic_add_fetch( &realloc_storage, size, __ATOMIC_SEQ_CST );
1292 #endif // __STATISTICS__
1293
1294 // If size is equal to 0, either NULL or a pointer suitable to be passed to free() is returned.
1295 if ( unlikely( size == 0 ) ) { free( oaddr ); return 0p; } // special cases
1296 if ( unlikely( oaddr == 0p ) ) return memalignNoStats( nalign, size );
1297
1298 size_t osize = header->kind.real.size; // old allocation size
1299 bool ozfill = (header->kind.real.blockSize & 2) != 0; // old allocation zero filled
1300
1301 void * naddr = memalignNoStats( nalign, size ); // create new aligned area
1302
1303 headers( "realloc", naddr, header, freeElem, bsize, oalign );
1304 memcpy( naddr, oaddr, MIN( osize, size ) ); // copy bytes
1305 free( oaddr );
1306
1307 if ( unlikely( ozfill ) ) { // previous request zero fill ?
1308 header->kind.real.blockSize |= 2; // mark new request as zero filled
1309 if ( size > osize ) { // previous request larger ?
1310 memset( (char *)naddr + osize, (int)'\0', size - osize ); // initialize added storage
1311 } // if
1312 } // if
1313 return naddr;
1314} // realloc
1315
1316
1317// Local Variables: //
1318// tab-width: 4 //
1319// compile-command: "cfa -nodebug -O2 heap.cfa" //
1320// End: //
Note: See TracBrowser for help on using the repository browser.