source: libcfa/src/heap.cfa@ 56b53b2

ADT aaron-thesis arm-eh ast-experimental cleanup-dtors deferred_resn enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr no_list persistent-indexer pthread-emulation qualifiedEnum
Last change on this file since 56b53b2 was bcb14b5, checked in by Peter A. Buhr <pabuhr@…>, 7 years ago

first code review updates
  • Property mode set to 100644
File size: 39.4 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 : Thu Aug 23 06:11:44 2018
13// Update Count : 511
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
20extern "C" {
21#include <sys/mman.h> // mmap, munmap
22} // extern "C"
23
24// #comment TD : Many of these should be merged into math I believe
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 "malloc.h"
31
32
33enum {
34 __CFA_DEFAULT_MMAP_START__ = (512 * 1024 + 1),
35 __CFA_DEFAULT_HEAP_EXPANSION__ = (1 * 1024 * 1024),
36};
37
38size_t default_mmap_start() __attribute__(( weak )) {
39 return __CFA_DEFAULT_MMAP_START__;
40} // default_mmap_start
41
42size_t default_heap_expansion() __attribute__(( weak )) {
43 return __CFA_DEFAULT_HEAP_EXPANSION__;
44} // default_heap_expansion
45
46
47// supported mallopt options
48#ifndef M_MMAP_THRESHOLD
49#define M_MMAP_THRESHOLD (-1)
50#endif // M_TOP_PAD
51#ifndef M_TOP_PAD
52#define M_TOP_PAD (-2)
53#endif // M_TOP_PAD
54
55#define FASTLOOKUP
56#define __STATISTICS__
57
58#define SPINLOCK 0
59#define LOCKFREE 1
60#define BUCKETLOCK SPINLOCK
61#if BUCKETLOCK == LOCKFREE
62#include <uStackLF.h>
63#endif // LOCKFREE
64
65// #comment TD : This defined is significantly different from the __ALIGN__ define from locks.hfa
66#define ALIGN 16
67
68// enum { NoBucketSizes = 93, // number of buckets sizes
69// #ifdef FASTLOOKUP
70// LookupSizes = 65536, // number of fast lookup sizes
71// #endif // FASTLOOKUP
72// };
73#define NoBucketSizes 93 // number of buckets sizes
74#ifdef FASTLOOKUP
75#define LookupSizes 65536 // number of fast lookup sizes
76#endif // FASTLOOKUP
77
78
79static bool traceHeap = false;
80
81inline bool traceHeap() {
82 return traceHeap;
83} // traceHeap
84
85bool traceHeapOn() {
86 bool temp = traceHeap;
87 traceHeap = true;
88 return temp;
89} // traceHeapOn
90
91bool traceHeapOff() {
92 bool temp = traceHeap;
93 traceHeap = false;
94 return temp;
95} // traceHeapOff
96
97
98static bool checkFree = false;
99
100inline bool checkFree() {
101 return checkFree;
102} // checkFree
103
104bool checkFreeOn() {
105 bool temp = checkFree;
106 checkFree = true;
107 return temp;
108} // checkFreeOn
109
110bool checkFreeOff() {
111 bool temp = checkFree;
112 checkFree = false;
113 return temp;
114} // checkFreeOff
115
116
117// static bool traceHeapTerm = false;
118
119// inline bool traceHeapTerm() {
120// return traceHeapTerm;
121// } // traceHeapTerm
122
123// bool traceHeapTermOn() {
124// bool temp = traceHeapTerm;
125// traceHeapTerm = true;
126// return temp;
127// } // traceHeapTermOn
128
129// bool traceHeapTermOff() {
130// bool temp = traceHeapTerm;
131// traceHeapTerm = false;
132// return temp;
133// } // traceHeapTermOff
134
135
136#ifdef __CFA_DEBUG__
137static unsigned int allocFree; // running total of allocations minus frees
138
139static void checkUnfreed() {
140 if ( allocFree != 0 ) {
141 // DO NOT USE STREAMS AS THEY MAY BE UNAVAILABLE AT THIS POINT.
142 // char helpText[512];
143 // 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"
144 // "Possible cause is unfreed storage allocated by the program or system/library routines called from the program.\n",
145 // (long int)getpid(), allocFree, allocFree ); // always print the UNIX pid
146 // __cfaabi_dbg_bits_write( helpText, len );
147 } // if
148} // checkUnfreed
149
150extern "C" {
151 void heapAppStart() { // called by __cfaabi_appready_startup
152 allocFree = 0;
153 } // heapAppStart
154
155 void heapAppStop() { // called by __cfaabi_appready_startdown
156 fclose( stdin ); fclose( stdout );
157 checkUnfreed();
158 } // heapAppStop
159} // extern "C"
160#endif // __CFA_DEBUG__
161
162
163struct HeapManager {
164// struct FreeHeader; // forward declaration
165
166 struct Storage {
167 struct Header { // header
168 union Kind {
169 struct RealHeader {
170 union {
171 struct { // 4-byte word => 8-byte header, 8-byte word => 16-byte header
172 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ && __SIZEOF_POINTER__ == 4
173 uint32_t padding; // unused, force home/blocksize to overlay alignment in fake header
174 #endif // __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ && __SIZEOF_POINTER__ == 4
175
176 union {
177// FreeHeader * home; // allocated block points back to home locations (must overlay alignment)
178 void * home; // allocated block points back to home locations (must overlay alignment)
179 size_t blockSize; // size for munmap (must overlay alignment)
180 #if BUCKLOCK == SPINLOCK
181 Storage * next; // freed block points next freed block of same size
182 #endif // SPINLOCK
183 };
184
185 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ && __SIZEOF_POINTER__ == 4
186 uint32_t padding; // unused, force home/blocksize to overlay alignment in fake header
187 #endif // __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ && __SIZEOF_POINTER__ == 4
188 };
189 // future code
190 #if BUCKLOCK == LOCKFREE
191 Stack<Storage>::Link next; // freed block points next freed block of same size (double-wide)
192 #endif // LOCKFREE
193 };
194 } real; // RealHeader
195 struct FakeHeader {
196 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
197 uint32_t alignment; // low-order bits of home/blockSize used for tricks
198 #endif // __ORDER_LITTLE_ENDIAN__
199
200 uint32_t offset;
201
202 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
203 uint32_t alignment; // low-order bits of home/blockSize used for tricks
204 #endif // __ORDER_BIG_ENDIAN__
205 } fake; // FakeHeader
206 } kind; // Kind
207 } header; // Header
208 char pad[ALIGN - sizeof( Header )];
209 char data[0]; // storage
210 }; // Storage
211
212 static_assert( ALIGN >= sizeof( Storage ), "ALIGN < sizeof( Storage )" );
213
214 struct FreeHeader {
215 #if BUCKLOCK == SPINLOCK
216 __spinlock_t lock; // must be first field for alignment
217 Storage * freeList;
218 #elif BUCKLOCK == LOCKFREE
219 // future code
220 StackLF<Storage> freeList;
221 #else
222 #error undefined lock type for bucket lock
223 #endif // SPINLOCK
224 size_t blockSize; // size of allocations on this list
225 }; // FreeHeader
226
227 // must be first fields for alignment
228 __spinlock_t extlock; // protects allocation-buffer extension
229 FreeHeader freeLists[NoBucketSizes]; // buckets for different allocation sizes
230
231 void * heapBegin; // start of heap
232 void * heapEnd; // logical end of heap
233 size_t heapRemaining; // amount of storage not allocated in the current chunk
234}; // HeapManager
235
236static inline size_t getKey( const HeapManager.FreeHeader & freeheader ) { return freeheader.blockSize; }
237// statically allocated variables => zero filled.
238
239
240static size_t pageSize; // architecture pagesize
241static size_t heapExpand; // sbrk advance
242static size_t mmapStart; // cross over point for mmap
243static unsigned int maxBucketsUsed; // maximum number of buckets in use
244
245// Powers of 2 are common allocation sizes, so make powers of 2 generate the minimum required size.
246static const unsigned int bucketSizes[NoBucketSizes] @= { // different bucket sizes
247 16, 32, 48, 64,
248 64 + sizeof(HeapManager.Storage), 96, 112, 128, 128 + sizeof(HeapManager.Storage), 160, 192, 224,
249 256 + sizeof(HeapManager.Storage), 320, 384, 448, 512 + sizeof(HeapManager.Storage), 640, 768, 896,
250 1_024 + sizeof(HeapManager.Storage), 1_536, 2_048 + sizeof(HeapManager.Storage), 2_560, 3_072, 3_584, 4_096 + sizeof(HeapManager.Storage), 6_144,
251 8_192 + sizeof(HeapManager.Storage), 9_216, 10_240, 11_264, 12_288, 13_312, 14_336, 15_360,
252 16_384 + sizeof(HeapManager.Storage), 18_432, 20_480, 22_528, 24_576, 26_624, 28_672, 30_720,
253 32_768 + sizeof(HeapManager.Storage), 36_864, 40_960, 45_056, 49_152, 53_248, 57_344, 61_440,
254 65_536 + sizeof(HeapManager.Storage), 73_728, 81_920, 90_112, 98_304, 106_496, 114_688, 122_880,
255 131_072 + sizeof(HeapManager.Storage), 147_456, 163_840, 180_224, 196_608, 212_992, 229_376, 245_760,
256 262_144 + sizeof(HeapManager.Storage), 294_912, 327_680, 360_448, 393_216, 425_984, 458_752, 491_520,
257 524_288 + sizeof(HeapManager.Storage), 655_360, 786_432, 917_504, 1_048_576 + sizeof(HeapManager.Storage), 1_179_648, 1_310_720, 1_441_792,
258 1_572_864, 1_703_936, 1_835_008, 1_966_080, 2_097_152 + sizeof(HeapManager.Storage), 2_621_440, 3_145_728, 3_670_016,
259 4_194_304 + sizeof(HeapManager.Storage)
260};
261#ifdef FASTLOOKUP
262static unsigned char lookup[LookupSizes]; // O(1) lookup for small sizes
263#endif // FASTLOOKUP
264static int mmapFd = -1; // fake or actual fd for anonymous file
265
266
267#ifdef __CFA_DEBUG__
268static bool heapBoot = 0; // detect recursion during boot
269#endif // __CFA_DEBUG__
270static HeapManager heapManager __attribute__(( aligned (128) )) @= {}; // size of cache line to prevent false sharing
271
272// #comment TD : The return type of this function should be commented
273static inline bool setMmapStart( size_t value ) {
274 if ( value < pageSize || bucketSizes[NoBucketSizes - 1] < value ) return true;
275 mmapStart = value; // set global
276
277 // find the closest bucket size less than or equal to the mmapStart size
278 maxBucketsUsed = bsearchl( (unsigned int)mmapStart, bucketSizes, NoBucketSizes ); // binary search
279 assert( maxBucketsUsed < NoBucketSizes ); // subscript failure ?
280 assert( mmapStart <= bucketSizes[maxBucketsUsed] ); // search failure ?
281 return false;
282} // setMmapStart
283
284
285static void ?{}( HeapManager & manager ) with ( manager ) {
286 pageSize = sysconf( _SC_PAGESIZE );
287
288 for ( unsigned int i = 0; i < NoBucketSizes; i += 1 ) { // initialize the free lists
289 freeLists[i].blockSize = bucketSizes[i];
290 } // for
291
292 #ifdef FASTLOOKUP
293 unsigned int idx = 0;
294 for ( unsigned int i = 0; i < LookupSizes; i += 1 ) {
295 if ( i > bucketSizes[idx] ) idx += 1;
296 lookup[i] = idx;
297 } // for
298 #endif // FASTLOOKUP
299
300 if ( setMmapStart( default_mmap_start() ) ) {
301 abort( "HeapManager : internal error, mmap start initialization failure." );
302 } // if
303 heapExpand = default_heap_expansion();
304
305 char * End = (char *)sbrk( 0 );
306 sbrk( (char *)libCeiling( (long unsigned int)End, libAlign() ) - End ); // move start of heap to multiple of alignment
307 heapBegin = heapEnd = sbrk( 0 ); // get new start point
308 } // HeapManager
309
310
311static void ^?{}( HeapManager & ) {
312 #ifdef __STATISTICS__
313 // if ( traceHeapTerm() ) {
314 // printStats();
315 // if ( checkfree() ) checkFree( heapManager, true );
316 // } // if
317 #endif // __STATISTICS__
318 } // ~HeapManager
319
320
321static void memory_startup( void ) __attribute__(( constructor( STARTUP_PRIORITY_MEMORY ) ));
322void memory_startup( void ) {
323 #ifdef __CFA_DEBUG__
324 if ( unlikely( heapBoot ) ) { // check for recursion during system boot
325 // DO NOT USE STREAMS AS THEY MAY BE UNAVAILABLE AT THIS POINT.
326 abort( "boot() : internal error, recursively invoked during system boot." );
327 } // if
328 heapBoot = true;
329 #endif // __CFA_DEBUG__
330
331 assert( heapManager.heapBegin == 0 ); // always perform check, done once
332 heapManager{};
333} // memory_startup
334
335static void memory_shutdown( void ) __attribute__(( destructor( STARTUP_PRIORITY_MEMORY ) ));
336void memory_shutdown( void ) {
337 ^heapManager{};
338} // memory_shutdown
339
340
341#ifdef __STATISTICS__
342static unsigned long long int mmap_storage; // heap statistics counters
343static unsigned int mmap_calls;
344static unsigned long long int munmap_storage;
345static unsigned int munmap_calls;
346static unsigned long long int sbrk_storage;
347static unsigned int sbrk_calls;
348static unsigned long long int malloc_storage;
349static unsigned int malloc_calls;
350static unsigned long long int free_storage;
351static unsigned int free_calls;
352static unsigned long long int calloc_storage;
353static unsigned int calloc_calls;
354static unsigned long long int memalign_storage;
355static unsigned int memalign_calls;
356static unsigned long long int cmemalign_storage;
357static unsigned int cmemalign_calls;
358static unsigned long long int realloc_storage;
359static unsigned int realloc_calls;
360
361static int statfd; // statistics file descriptor (changed by malloc_stats_fd)
362
363
364// Use "write" because streams may be shutdown when calls are made.
365static void printStats() {
366 char helpText[512];
367 __cfaabi_dbg_bits_print_buffer( helpText, sizeof(helpText),
368 "\nHeap statistics:\n"
369 " malloc: calls %u / storage %llu\n"
370 " calloc: calls %u / storage %llu\n"
371 " memalign: calls %u / storage %llu\n"
372 " cmemalign: calls %u / storage %llu\n"
373 " realloc: calls %u / storage %llu\n"
374 " free: calls %u / storage %llu\n"
375 " mmap: calls %u / storage %llu\n"
376 " munmap: calls %u / storage %llu\n"
377 " sbrk: calls %u / storage %llu\n",
378 malloc_calls, malloc_storage,
379 calloc_calls, calloc_storage,
380 memalign_calls, memalign_storage,
381 cmemalign_calls, cmemalign_storage,
382 realloc_calls, realloc_storage,
383 free_calls, free_storage,
384 mmap_calls, mmap_storage,
385 munmap_calls, munmap_storage,
386 sbrk_calls, sbrk_storage
387 );
388} // printStats
389
390static int printStatsXML( FILE * stream ) { // see malloc_info
391 char helpText[512];
392 int len = snprintf( helpText, sizeof(helpText),
393 "<malloc version=\"1\">\n"
394 "<heap nr=\"0\">\n"
395 "<sizes>\n"
396 "</sizes>\n"
397 "<total type=\"malloc\" count=\"%u\" size=\"%llu\"/>\n"
398 "<total type=\"calloc\" count=\"%u\" size=\"%llu\"/>\n"
399 "<total type=\"memalign\" count=\"%u\" size=\"%llu\"/>\n"
400 "<total type=\"cmemalign\" count=\"%u\" size=\"%llu\"/>\n"
401 "<total type=\"realloc\" count=\"%u\" size=\"%llu\"/>\n"
402 "<total type=\"free\" count=\"%u\" size=\"%llu\"/>\n"
403 "<total type=\"mmap\" count=\"%u\" size=\"%llu\"/>\n"
404 "<total type=\"munmap\" count=\"%u\" size=\"%llu\"/>\n"
405 "<total type=\"sbrk\" count=\"%u\" size=\"%llu\"/>\n"
406 "</malloc>",
407 malloc_calls, malloc_storage,
408 calloc_calls, calloc_storage,
409 memalign_calls, memalign_storage,
410 cmemalign_calls, cmemalign_storage,
411 realloc_calls, realloc_storage,
412 free_calls, free_storage,
413 mmap_calls, mmap_storage,
414 munmap_calls, munmap_storage,
415 sbrk_calls, sbrk_storage
416 );
417 return write( fileno( stream ), helpText, len ); // -1 => error
418} // printStatsXML
419#endif // __STATISTICS__
420
421// #comment TD : Is this the samething as Out-of-Memory?
422static inline void noMemory() {
423 abort( "Heap memory exhausted at %zu bytes.\n"
424 "Possible cause is very large memory allocation and/or large amount of unfreed storage allocated by the program or system/library routines.",
425 ((char *)(sbrk( 0 )) - (char *)(heapManager.heapBegin)) );
426} // noMemory
427
428
429static inline void checkAlign( size_t alignment ) {
430 if ( alignment < sizeof(void *) || ! libPow2( alignment ) ) {
431 abort( "Alignment %zu for memory allocation is less than sizeof(void *) and/or not a power of 2.", alignment );
432 } // if
433} // checkAlign
434
435
436static inline bool setHeapExpand( size_t value ) {
437 if ( heapExpand < pageSize ) return true;
438 heapExpand = value;
439 return false;
440} // setHeapExpand
441
442
443static inline void checkHeader( bool check, const char * name, void * addr ) {
444 if ( unlikely( check ) ) { // bad address ?
445 abort( "Attempt to %s storage %p with address outside the heap.\n"
446 "Possible cause is duplicate free on same block or overwriting of memory.",
447 name, addr );
448 } // if
449} // checkHeader
450
451// #comment TD : function should be commented and/or have a more evocative name
452// this isn't either a check or a constructor which is what I would expect this function to be
453static inline void fakeHeader( HeapManager.Storage.Header *& header, size_t & size, size_t & alignment ) {
454 if ( unlikely( (header->kind.fake.alignment & 1) == 1 ) ) { // fake header ?
455 size_t offset = header->kind.fake.offset;
456 alignment = header->kind.fake.alignment & -2; // remove flag from value
457 #ifdef __CFA_DEBUG__
458 checkAlign( alignment ); // check alignment
459 #endif // __CFA_DEBUG__
460 header = (HeapManager.Storage.Header *)((char *)header - offset);
461 } // if
462} // fakeHeader
463
464// #comment TD : Why is this a define
465#define headerAddr( addr ) ((HeapManager.Storage.Header *)( (char *)addr - sizeof(HeapManager.Storage) ))
466
467static inline bool headers( const char * name, void * addr, HeapManager.Storage.Header *& header, HeapManager.FreeHeader *& freeElem, size_t & size, size_t & alignment ) with ( heapManager ) {
468 header = headerAddr( addr );
469
470 if ( unlikely( heapEnd < addr ) ) { // mmapped ?
471 fakeHeader( header, size, alignment );
472 size = header->kind.real.blockSize & -3; // mmap size
473 return true;
474 } // if
475
476 #ifdef __CFA_DEBUG__
477 checkHeader( addr < heapBegin || header < (HeapManager.Storage.Header *)heapBegin, name, addr ); // bad low address ?
478 #endif // __CFA_DEBUG__
479
480 // #comment TD : This code looks weird...
481 // It's called as the first statement of both branches of the last if, with the same parameters in all cases
482
483 // header may be safe to dereference
484 fakeHeader( header, size, alignment );
485 #ifdef __CFA_DEBUG__
486 checkHeader( header < (HeapManager.Storage.Header *)heapBegin || (HeapManager.Storage.Header *)heapEnd < header, name, addr ); // bad address ? (offset could be + or -)
487 #endif // __CFA_DEBUG__
488
489 freeElem = (HeapManager.FreeHeader *)((size_t)header->kind.real.home & -3);
490 #ifdef __CFA_DEBUG__
491 if ( freeElem < &freeLists[0] || &freeLists[NoBucketSizes] <= freeElem ) {
492 abort( "Attempt to %s storage %p with corrupted header.\n"
493 "Possible cause is duplicate free on same block or overwriting of header information.",
494 name, addr );
495 } // if
496 #endif // __CFA_DEBUG__
497 size = freeElem->blockSize;
498 return false;
499} // headers
500
501
502static inline void * extend( size_t size ) with ( heapManager ) {
503 lock( extlock __cfaabi_dbg_ctx2 );
504 ptrdiff_t rem = heapRemaining - size;
505 if ( rem < 0 ) {
506 // If the size requested is bigger than the current remaining storage, increase the size of the heap.
507
508 size_t increase = libCeiling( size > heapExpand ? size : heapExpand, libAlign() );
509 if ( sbrk( increase ) == (void *)-1 ) {
510 unlock( extlock );
511 errno = ENOMEM;
512 return 0;
513 } // if
514 #ifdef __STATISTICS__
515 sbrk_calls += 1;
516 sbrk_storage += increase;
517 #endif // __STATISTICS__
518 #ifdef __CFA_DEBUG__
519 // Set new memory to garbage so subsequent uninitialized usages might fail.
520 memset( (char *)heapEnd + heapRemaining, '\377', increase );
521 #endif // __CFA_DEBUG__
522 rem = heapRemaining + increase - size;
523 } // if
524
525 HeapManager.Storage * block = (HeapManager.Storage *)heapEnd;
526 heapRemaining = rem;
527 heapEnd = (char *)heapEnd + size;
528 unlock( extlock );
529 return block;
530} // extend
531
532
533static inline void * doMalloc( size_t size ) with ( heapManager ) {
534 HeapManager.Storage * block;
535
536 // Look up size in the size list. Make sure the user request includes space for the header that must be allocated
537 // along with the block and is a multiple of the alignment size.
538
539 size_t tsize = size + sizeof(HeapManager.Storage);
540 if ( likely( tsize < mmapStart ) ) { // small size => sbrk
541 HeapManager.FreeHeader * freeElem =
542 #ifdef FASTLOOKUP
543 tsize < LookupSizes ? &freeLists[lookup[tsize]] :
544 #endif // FASTLOOKUP
545 bsearchl( tsize, freeLists, (size_t)maxBucketsUsed ); // binary search
546 assert( freeElem <= &freeLists[maxBucketsUsed] ); // subscripting error ?
547 assert( tsize <= freeElem->blockSize ); // search failure ?
548 tsize = freeElem->blockSize; // total space needed for request
549
550 // Spin until the lock is acquired for this particular size of block.
551
552 #if defined( SPINLOCK )
553 lock( freeElem->lock __cfaabi_dbg_ctx2 );
554 block = freeElem->freeList; // remove node from stack
555 #else
556 block = freeElem->freeList.pop();
557 #endif // SPINLOCK
558 if ( unlikely( block == 0 ) ) { // no free block ?
559 #if defined( SPINLOCK )
560 unlock( freeElem->lock );
561 #endif // SPINLOCK
562
563 // Freelist for that size was empty, so carve it out of the heap if there's enough left, or get some more
564 // and then carve it off.
565
566 block = (HeapManager.Storage *)extend( tsize ); // mutual exclusion on call
567 if ( unlikely( block == 0 ) ) return 0;
568 #if defined( SPINLOCK )
569 } else {
570 freeElem->freeList = block->header.kind.real.next;
571 unlock( freeElem->lock );
572 #endif // SPINLOCK
573 } // if
574
575 block->header.kind.real.home = freeElem; // pointer back to free list of apropriate size
576 } else { // large size => mmap
577 tsize = libCeiling( tsize, pageSize ); // must be multiple of page size
578 #ifdef __STATISTICS__
579 __atomic_add_fetch( &mmap_calls, 1, __ATOMIC_SEQ_CST );
580 __atomic_add_fetch( &mmap_storage, tsize, __ATOMIC_SEQ_CST );
581 #endif // __STATISTICS__
582 block = (HeapManager.Storage *)mmap( 0, tsize, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, mmapFd, 0 );
583 if ( block == (HeapManager.Storage *)MAP_FAILED ) {
584 // Do not call strerror( errno ) as it may call malloc.
585 abort( "(HeapManager &)0x%p.doMalloc() : internal error, mmap failure, size:%zu error:%d.", &heapManager, tsize, errno );
586 } // if
587 #ifdef __CFA_DEBUG__
588 // Set new memory to garbage so subsequent uninitialized usages might fail.
589 memset( block, '\377', tsize );
590 #endif // __CFA_DEBUG__
591 block->header.kind.real.blockSize = tsize; // storage size for munmap
592 } // if
593
594 void * area = &(block->data); // adjust off header to user bytes
595
596 #ifdef __CFA_DEBUG__
597 assert( ((uintptr_t)area & (libAlign() - 1)) == 0 ); // minimum alignment ?
598 __atomic_add_fetch( &allocFree, tsize, __ATOMIC_SEQ_CST );
599 if ( traceHeap() ) {
600 enum { BufferSize = 64 };
601 char helpText[BufferSize];
602 int len = snprintf( helpText, BufferSize, "%p = Malloc( %zu ) (allocated %zu)\n", area, size, tsize );
603 // int len = snprintf( helpText, BufferSize, "Malloc %p %zu\n", area, size );
604 __cfaabi_dbg_bits_write( helpText, len );
605 } // if
606 #endif // __CFA_DEBUG__
607
608 return area;
609} // doMalloc
610
611
612static inline void doFree( void * addr ) with ( heapManager ) {
613 #ifdef __CFA_DEBUG__
614 if ( unlikely( heapManager.heapBegin == 0 ) ) {
615 abort( "doFree( %p ) : internal error, called before heap is initialized.", addr );
616 } // if
617 #endif // __CFA_DEBUG__
618
619 HeapManager.Storage.Header * header;
620 HeapManager.FreeHeader * freeElem;
621 size_t size, alignment; // not used (see realloc)
622
623 if ( headers( "free", addr, header, freeElem, size, alignment ) ) { // mmapped ?
624 #ifdef __STATISTICS__
625 __atomic_add_fetch( &munmap_calls, 1, __ATOMIC_SEQ_CST );
626 __atomic_add_fetch( &munmap_storage, size, __ATOMIC_SEQ_CST );
627 #endif // __STATISTICS__
628 if ( munmap( header, size ) == -1 ) {
629 #ifdef __CFA_DEBUG__
630 abort( "Attempt to deallocate storage %p not allocated or with corrupt header.\n"
631 "Possible cause is invalid pointer.",
632 addr );
633 #endif // __CFA_DEBUG__
634 } // if
635 } else {
636 #ifdef __CFA_DEBUG__
637 // Set free memory to garbage so subsequent usages might fail.
638 memset( ((HeapManager.Storage *)header)->data, '\377', freeElem->blockSize - sizeof( HeapManager.Storage ) );
639 #endif // __CFA_DEBUG__
640
641 #ifdef __STATISTICS__
642 free_storage += size;
643 #endif // __STATISTICS__
644 #if defined( SPINLOCK )
645 lock( freeElem->lock __cfaabi_dbg_ctx2 ); // acquire spin lock
646 header->kind.real.next = freeElem->freeList; // push on stack
647 freeElem->freeList = (HeapManager.Storage *)header;
648 unlock( freeElem->lock ); // release spin lock
649 #else
650 freeElem->freeList.push( *(HeapManager.Storage *)header );
651 #endif // SPINLOCK
652 } // if
653
654 #ifdef __CFA_DEBUG__
655 __atomic_add_fetch( &allocFree, -size, __ATOMIC_SEQ_CST );
656 if ( traceHeap() ) {
657 char helpText[64];
658 int len = snprintf( helpText, sizeof(helpText), "Free( %p ) size:%zu\n", addr, size );
659 __cfaabi_dbg_bits_write( helpText, len );
660 } // if
661 #endif // __CFA_DEBUG__
662} // doFree
663
664
665size_t checkFree( HeapManager & manager ) with ( manager ) {
666 size_t total = 0;
667 #ifdef __STATISTICS__
668 __cfaabi_dbg_bits_acquire();
669 __cfaabi_dbg_bits_print_nolock( "\nBin lists (bin size : free blocks on list)\n" );
670 #endif // __STATISTICS__
671 for ( unsigned int i = 0; i < maxBucketsUsed; i += 1 ) {
672 size_t size = freeLists[i].blockSize;
673 #ifdef __STATISTICS__
674 unsigned int N = 0;
675 #endif // __STATISTICS__
676
677 #if defined( SPINLOCK )
678 for ( HeapManager.Storage * p = freeLists[i].freeList; p != 0; p = p->header.kind.real.next ) {
679 #else
680 for ( HeapManager.Storage * p = freeLists[i].freeList.top(); p != 0; p = p->header.kind.real.next.top ) {
681 #endif // SPINLOCK
682 total += size;
683 #ifdef __STATISTICS__
684 N += 1;
685 #endif // __STATISTICS__
686 } // for
687
688 #ifdef __STATISTICS__
689 __cfaabi_dbg_bits_print_nolock( "%7zu, %-7u ", size, N );
690 if ( (i + 1) % 8 == 0 ) __cfaabi_dbg_bits_print_nolock( "\n" );
691 #endif // __STATISTICS__
692 } // for
693 #ifdef __STATISTICS__
694 __cfaabi_dbg_bits_print_nolock( "\ntotal free blocks:%zu\n", total );
695 __cfaabi_dbg_bits_release();
696 #endif // __STATISTICS__
697 return (char *)heapEnd - (char *)heapBegin - total;
698} // checkFree
699
700
701static inline void * mallocNoStats( size_t size ) { // necessary for malloc statistics
702 assert( heapManager.heapBegin != 0 );
703 void * area = doMalloc( size );
704 if ( unlikely( area == 0 ) ) errno = ENOMEM; // POSIX
705 return area;
706} // mallocNoStats
707
708
709static inline void * memalignNoStats( size_t alignment, size_t size ) { // necessary for malloc statistics
710 #ifdef __CFA_DEBUG__
711 checkAlign( alignment ); // check alignment
712 #endif // __CFA_DEBUG__
713
714 // if alignment <= default alignment, do normal malloc as two headers are unnecessary
715 if ( unlikely( alignment <= libAlign() ) ) return mallocNoStats( size );
716
717 // Allocate enough storage to guarantee an address on the alignment boundary, and sufficient space before it for
718 // administrative storage. NOTE, WHILE THERE ARE 2 HEADERS, THE FIRST ONE IS IMPLICITLY CREATED BY DOMALLOC.
719 // .-------------v-----------------v----------------v----------,
720 // | Real Header | ... padding ... | Fake Header | data ... |
721 // `-------------^-----------------^-+--------------^----------'
722 // |<--------------------------------' offset/align |<-- alignment boundary
723
724 // subtract libAlign() because it is already the minimum alignment
725 // add sizeof(Storage) for fake header
726 // #comment TD : this is the only place that calls doMalloc without calling mallocNoStats, why ?
727 char * area = (char *)doMalloc( size + alignment - libAlign() + sizeof(HeapManager.Storage) );
728 if ( unlikely( area == 0 ) ) return area;
729
730 // address in the block of the "next" alignment address
731 char * user = (char *)libCeiling( (uintptr_t)(area + sizeof(HeapManager.Storage)), alignment );
732
733 // address of header from malloc
734 HeapManager.Storage.Header * realHeader = headerAddr( area );
735 // address of fake header * before* the alignment location
736 HeapManager.Storage.Header * fakeHeader = headerAddr( user );
737 // SKULLDUGGERY: insert the offset to the start of the actual storage block and remember alignment
738 fakeHeader->kind.fake.offset = (char *)fakeHeader - (char *)realHeader;
739 // SKULLDUGGERY: odd alignment imples fake header
740 fakeHeader->kind.fake.alignment = alignment | 1;
741
742 return user;
743} // memalignNoStats
744
745
746extern "C" {
747 // The malloc() function allocates size bytes and returns a pointer to the allocated memory. The memory is not
748 // initialized. If size is 0, then malloc() returns either NULL, or a unique pointer value that can later be
749 // successfully passed to free().
750 void * malloc( size_t size ) {
751 #ifdef __STATISTICS__
752 __atomic_add_fetch( &malloc_calls, 1, __ATOMIC_SEQ_CST );
753 __atomic_add_fetch( &malloc_storage, size, __ATOMIC_SEQ_CST );
754 #endif // __STATISTICS__
755
756 return mallocNoStats( size );
757 } // malloc
758
759 // The calloc() function allocates memory for an array of nmemb elements of size bytes each and returns a pointer to
760 // the allocated memory. The memory is set to zero. If nmemb or size is 0, then calloc() returns either NULL, or a
761 // unique pointer value that can later be successfully passed to free().
762 void * calloc( size_t noOfElems, size_t elemSize ) {
763 size_t size = noOfElems * elemSize;
764 #ifdef __STATISTICS__
765 __atomic_add_fetch( &calloc_calls, 1, __ATOMIC_SEQ_CST );
766 __atomic_add_fetch( &calloc_storage, size, __ATOMIC_SEQ_CST );
767 #endif // __STATISTICS__
768
769 char * area = (char *)mallocNoStats( size );
770 if ( unlikely( area == 0 ) ) return 0;
771
772 HeapManager.Storage.Header * header;
773 HeapManager.FreeHeader * freeElem;
774 size_t asize, alignment;
775 bool mapped __attribute__(( unused )) = headers( "calloc", area, header, freeElem, asize, alignment );
776 #ifndef __CFA_DEBUG__
777 // Mapped storage is zero filled, but in debug mode mapped memory is scrubbed in doMalloc, so it has to be reset to zero.
778 if ( ! mapped )
779 #endif // __CFA_DEBUG__
780 memset( area, '\0', asize - sizeof(HeapManager.Storage) ); // set to zeros
781
782 header->kind.real.blockSize |= 2; // mark as zero filled
783 return area;
784 } // calloc
785
786 // #comment TD : Document this function
787 void * cmemalign( size_t alignment, size_t noOfElems, size_t elemSize ) {
788 size_t size = noOfElems * elemSize;
789 #ifdef __STATISTICS__
790 __atomic_add_fetch( &cmemalign_calls, 1, __ATOMIC_SEQ_CST );
791 __atomic_add_fetch( &cmemalign_storage, size, __ATOMIC_SEQ_CST );
792 #endif // __STATISTICS__
793
794 char * area = (char *)memalignNoStats( alignment, size );
795 if ( unlikely( area == 0 ) ) return 0;
796 HeapManager.Storage.Header * header;
797 HeapManager.FreeHeader * freeElem;
798 size_t asize;
799 bool mapped __attribute__(( unused )) = headers( "cmemalign", area, header, freeElem, asize, alignment );
800 #ifndef __CFA_DEBUG__
801 // Mapped storage is zero filled, but in debug mode mapped memory is scrubbed in doMalloc, so it has to be reset to zero.
802 if ( ! mapped )
803 #endif // __CFA_DEBUG__
804 memset( area, '\0', asize - ( (char *)area - (char *)header ) ); // set to zeros
805 header->kind.real.blockSize |= 2; // mark as zero filled
806
807 return area;
808 } // cmemalign
809
810 // The realloc() function changes the size of the memory block pointed to by ptr to size bytes. The contents will be
811 // unchanged in the range from the start of the region up to the minimum of the old and new sizes. If the new size
812 // is larger than the old size, the added memory will not be initialized. If ptr is NULL, then the call is
813 // equivalent to malloc(size), for all values of size; if size is equal to zero, and ptr is not NULL, then the call
814 // is equivalent to free(ptr). Unless ptr is NULL, it must have been returned by an earlier call to malloc(),
815 // calloc() or realloc(). If the area pointed to was moved, a free(ptr) is done.
816 void * realloc( void * addr, size_t size ) {
817 #ifdef __STATISTICS__
818 __atomic_add_fetch( &realloc_calls, 1, __ATOMIC_SEQ_CST );
819 #endif // __STATISTICS__
820
821 if ( unlikely( addr == 0 ) ) return mallocNoStats( size ); // special cases
822 if ( unlikely( size == 0 ) ) { free( addr ); return 0; }
823
824 HeapManager.Storage.Header * header;
825 HeapManager.FreeHeader * freeElem;
826 size_t asize, alignment = 0;
827 headers( "realloc", addr, header, freeElem, asize, alignment );
828
829 size_t usize = asize - ( (char *)addr - (char *)header ); // compute the amount of user storage in the block
830 if ( usize >= size ) { // already sufficient storage
831 // This case does not result in a new profiler entry because the previous one still exists and it must match with
832 // the free for this memory. Hence, this realloc does not appear in the profiler output.
833 return addr;
834 } // if
835
836 #ifdef __STATISTICS__
837 __atomic_add_fetch( &realloc_storage, size, __ATOMIC_SEQ_CST );
838 #endif // __STATISTICS__
839
840 void * area;
841 if ( unlikely( alignment != 0 ) ) { // previous request memalign?
842 area = memalign( alignment, size ); // create new area
843 } else {
844 area = mallocNoStats( size ); // create new area
845 } // if
846 if ( unlikely( area == 0 ) ) return 0;
847 if ( unlikely( header->kind.real.blockSize & 2 ) ) { // previous request zero fill (calloc/cmemalign) ?
848 assert( (header->kind.real.blockSize & 1) == 0 );
849 bool mapped __attribute__(( unused )) = headers( "realloc", area, header, freeElem, asize, alignment );
850 #ifndef __CFA_DEBUG__
851 // Mapped storage is zero filled, but in debug mode mapped memory is scrubbed in doMalloc, so it has to be reset to zero.
852 if ( ! mapped )
853 #endif // __CFA_DEBUG__
854 memset( (char *)area + usize, '\0', asize - ( (char *)area - (char *)header ) - usize ); // zero-fill back part
855 header->kind.real.blockSize |= 2; // mark new request as zero fill
856 } // if
857 memcpy( area, addr, usize ); // copy bytes
858 free( addr );
859 return area;
860 } // realloc
861
862
863 // The obsolete function memalign() allocates size bytes and returns a pointer to the allocated memory. The memory
864 // address will be a multiple of alignment, which must be a power of two.
865 void * memalign( size_t alignment, size_t size ) {
866 #ifdef __STATISTICS__
867 __atomic_add_fetch( &memalign_calls, 1, __ATOMIC_SEQ_CST );
868 __atomic_add_fetch( &memalign_storage, size, __ATOMIC_SEQ_CST );
869 #endif // __STATISTICS__
870
871 void * area = memalignNoStats( alignment, size );
872
873 return area;
874 } // memalign
875
876 // The function aligned_alloc() is the same as memalign(), except for the added restriction that size should be a
877 // multiple of alignment.
878 void * aligned_alloc( size_t alignment, size_t size ) {
879 return memalign( alignment, size );
880 } // aligned_alloc
881
882
883 // The function posix_memalign() allocates size bytes and places the address of the allocated memory in *memptr. The
884 // address of the allocated memory will be a multiple of alignment, which must be a power of two and a multiple of
885 // sizeof(void *). If size is 0, then posix_memalign() returns either NULL, or a unique pointer value that can later
886 // be successfully passed to free(3).
887 int posix_memalign( void ** memptr, size_t alignment, size_t size ) {
888 if ( alignment < sizeof(void *) || ! libPow2( alignment ) ) return EINVAL; // check alignment
889 * memptr = memalign( alignment, size );
890 if ( unlikely( * memptr == 0 ) ) return ENOMEM;
891 return 0;
892 } // posix_memalign
893
894 // The obsolete function valloc() allocates size bytes and returns a pointer to the allocated memory. The memory
895 // address will be a multiple of the page size. It is equivalent to memalign(sysconf(_SC_PAGESIZE),size).
896 void * valloc( size_t size ) {
897 return memalign( pageSize, size );
898 } // valloc
899
900
901 // The free() function frees the memory space pointed to by ptr, which must have been returned by a previous call to
902 // malloc(), calloc() or realloc(). Otherwise, or if free(ptr) has already been called before, undefined behavior
903 // occurs. If ptr is NULL, no operation is performed.
904 void free( void * addr ) {
905 #ifdef __STATISTICS__
906 __atomic_add_fetch( &free_calls, 1, __ATOMIC_SEQ_CST );
907 #endif // __STATISTICS__
908
909 // #comment TD : To decrease nesting I would but the special case in the
910 // else instead, plus it reads more naturally to have the
911 // short / normal case instead
912 if ( unlikely( addr == 0 ) ) { // special case
913 #ifdef __CFA_DEBUG__
914 if ( traceHeap() ) {
915 #define nullmsg "Free( 0x0 ) size:0\n"
916 // Do not debug print free( 0 ), as it can cause recursive entry from sprintf.
917 __cfaabi_dbg_bits_write( nullmsg, sizeof(nullmsg) - 1 );
918 } // if
919 #endif // __CFA_DEBUG__
920 return;
921 } // exit
922
923 doFree( addr );
924 } // free
925
926 // The mallopt() function adjusts parameters that control the behavior of the memory-allocation functions (see
927 // malloc(3)). The param argument specifies the parameter to be modified, and value specifies the new value for that
928 // parameter.
929 int mallopt( int option, int value ) {
930 choose( option ) {
931 case M_TOP_PAD:
932 if ( setHeapExpand( value ) ) fallthru default;
933 case M_MMAP_THRESHOLD:
934 if ( setMmapStart( value ) ) fallthru default;
935 default:
936 // #comment TD : 1 for unsopported feels wrong
937 return 1; // success, or unsupported
938 } // switch
939 return 0; // error
940 } // mallopt
941
942 // The malloc_trim() function attempts to release free memory at the top of the heap (by calling sbrk(2) with a
943 // suitable argument).
944 int malloc_trim( size_t ) {
945 return 0; // => impossible to release memory
946 } // malloc_trim
947
948 // The malloc_usable_size() function returns the number of usable bytes in the block pointed to by ptr, a pointer to
949 // a block of memory allocated by malloc(3) or a related function.
950 size_t malloc_usable_size( void * addr ) {
951 if ( unlikely( addr == 0 ) ) return 0; // null allocation has 0 size
952
953 HeapManager.Storage.Header * header;
954 HeapManager.FreeHeader * freeElem;
955 size_t size, alignment;
956
957 headers( "malloc_usable_size", addr, header, freeElem, size, alignment );
958 size_t usize = size - ( (char *)addr - (char *)header ); // compute the amount of user storage in the block
959 return usize;
960 } // malloc_usable_size
961
962
963 // The malloc_alignment() function returns the alignment of the allocation.
964 size_t malloc_alignment( void * addr ) {
965 if ( unlikely( addr == 0 ) ) return libAlign(); // minimum alignment
966 HeapManager.Storage.Header * header = (HeapManager.Storage.Header *)( (char *)addr - sizeof(HeapManager.Storage) );
967 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
968 return header->kind.fake.alignment & -2; // remove flag from value
969 } else {
970 return libAlign (); // minimum alignment
971 } // if
972 } // malloc_alignment
973
974
975 // The malloc_zero_fill() function returns true if the allocation is zero filled, i.e., initially allocated by calloc().
976 bool malloc_zero_fill( void * addr ) {
977 if ( unlikely( addr == 0 ) ) return false; // null allocation is not zero fill
978
979 HeapManager.Storage.Header * header = (HeapManager.Storage.Header *)( (char *)addr - sizeof(HeapManager.Storage) );
980 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
981 header = (HeapManager.Storage.Header *)((char *)header - header->kind.fake.offset);
982 } // if
983 return (header->kind.real.blockSize & 2) != 0; // zero filled (calloc/cmemalign) ?
984 } // malloc_zero_fill
985
986
987 // The malloc_stats() function prints (on default standard error) statistics about memory allocated by malloc(3) and
988 // related functions.
989 void malloc_stats( void ) {
990 #ifdef __STATISTICS__
991 printStats();
992 if ( checkFree() ) checkFree( heapManager );
993 #endif // __STATISTICS__
994 } // malloc_stats
995
996 // The malloc_stats_fd() function changes the file descripter where malloc_stats() writes the statistics.
997 int malloc_stats_fd( int fd ) {
998 #ifdef __STATISTICS__
999 int temp = statfd;
1000 statfd = fd;
1001 return temp;
1002 #else
1003 return -1;
1004 #endif // __STATISTICS__
1005 } // malloc_stats_fd
1006
1007 // The malloc_info() function exports an XML string that describes the current state of the memory-allocation
1008 // implementation in the caller. The string is printed on the file stream stream. The exported string includes
1009 // information about all arenas (see malloc(3)).
1010 int malloc_info( int options, FILE * stream ) {
1011 return printStatsXML( stream );
1012 } // malloc_info
1013
1014
1015 // The malloc_get_state() function records the current state of all malloc(3) internal bookkeeping variables (but
1016 // not the actual contents of the heap or the state of malloc_hook(3) functions pointers). The state is recorded in
1017 // a system-dependent opaque data structure dynamically allocated via malloc(3), and a pointer to that data
1018 // structure is returned as the function result. (It is the caller's responsibility to free(3) this memory.)
1019 void * malloc_get_state( void ) {
1020 return 0; // unsupported
1021 } // malloc_get_state
1022
1023
1024 // The malloc_set_state() function restores the state of all malloc(3) internal bookkeeping variables to the values
1025 // recorded in the opaque data structure pointed to by state.
1026 int malloc_set_state( void * ptr ) {
1027 return 0; // unsupported
1028 } // malloc_set_state
1029} // extern "C"
1030
1031
1032// Local Variables: //
1033// tab-width: 4 //
1034// compile-command: "cfa -nodebug -O2 heap.c" //
1035// End: //
Note: See TracBrowser for help on using the repository browser.