source: libcfa/src/heap.cfa@ 2fafe7e

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 2fafe7e was 92aca37, checked in by Peter A. Buhr <pabuhr@…>, 5 years ago

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