source: libcfa/src/heap.cfa@ 84f49be

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

modify location of mmapped storage to either side of the heap, and fix pattern for memory scrubbing
  • Property mode set to 100644
File size: 52.5 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 : Wed Dec 16 12:28:25 2020
13// Update Count : 1023
14//
15
16#include <unistd.h> // sbrk, sysconf
17#include <stdlib.h> // EXIT_FAILURE
18#include <stdbool.h> // true, false
19#include <stdio.h> // snprintf, fileno
20#include <errno.h> // errno
21#include <string.h> // memset, memcpy
22#include <limits.h> // ULONG_MAX
23#include <malloc.h> // memalign, malloc_usable_size
24#include <sys/mman.h> // mmap, munmap
25
26#include "bits/align.hfa" // libAlign
27#include "bits/defs.hfa" // likely, unlikely
28#include "bits/locks.hfa" // __spinlock_t
29#include "startup.hfa" // STARTUP_PRIORITY_MEMORY
30#include "math.hfa" // ceiling
31#include "bitmanip.hfa" // is_pow2, ceiling2
32
33static bool traceHeap = false;
34
35inline bool traceHeap() { return traceHeap; }
36
37bool traceHeapOn() {
38 bool temp = traceHeap;
39 traceHeap = true;
40 return temp;
41} // traceHeapOn
42
43bool traceHeapOff() {
44 bool temp = traceHeap;
45 traceHeap = false;
46 return temp;
47} // traceHeapOff
48
49bool traceHeapTerm() { return false; }
50
51
52static bool prtFree = false;
53
54inline bool prtFree() {
55 return prtFree;
56} // prtFree
57
58bool prtFreeOn() {
59 bool temp = prtFree;
60 prtFree = true;
61 return temp;
62} // prtFreeOn
63
64bool prtFreeOff() {
65 bool temp = prtFree;
66 prtFree = false;
67 return temp;
68} // prtFreeOff
69
70
71enum {
72 // Define the default extension heap amount in units of bytes. When the uC++ supplied heap reaches the brk address,
73 // the brk address is extended by the extension amount.
74 __CFA_DEFAULT_HEAP_EXPANSION__ = (10 * 1024 * 1024),
75
76 // Define the mmap crossover point during allocation. Allocations less than this amount are allocated from buckets;
77 // values greater than or equal to this value are mmap from the operating system.
78 __CFA_DEFAULT_MMAP_START__ = (512 * 1024 + 1),
79};
80
81size_t default_mmap_start() __attribute__(( weak )) {
82 return __CFA_DEFAULT_MMAP_START__;
83} // default_mmap_start
84
85size_t default_heap_expansion() __attribute__(( weak )) {
86 return __CFA_DEFAULT_HEAP_EXPANSION__;
87} // default_heap_expansion
88
89
90#ifdef __CFA_DEBUG__
91static size_t allocUnfreed; // running total of allocations minus frees
92
93static void prtUnfreed() {
94 if ( allocUnfreed != 0 ) {
95 // DO NOT USE STREAMS AS THEY MAY BE UNAVAILABLE AT THIS POINT.
96 char helpText[512];
97 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"
98 "Possible cause is unfreed storage allocated by the program or system/library routines called from the program.\n",
99 (long int)getpid(), allocUnfreed, allocUnfreed ); // always print the UNIX pid
100 __cfaabi_bits_write( STDERR_FILENO, helpText, len ); // print debug/nodebug
101 } // if
102} // prtUnfreed
103
104extern "C" {
105 void heapAppStart() { // called by __cfaabi_appready_startup
106 allocUnfreed = 0;
107 } // heapAppStart
108
109 void heapAppStop() { // called by __cfaabi_appready_startdown
110 fclose( stdin ); fclose( stdout );
111 prtUnfreed();
112 } // heapAppStop
113} // extern "C"
114#endif // __CFA_DEBUG__
115
116
117// statically allocated variables => zero filled.
118size_t __page_size; // architecture pagesize
119int __map_prot; // common mmap/mprotect protection
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 const off_t 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 < __page_size || 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( addr < heapBegin || 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( header < (HeapManager.Storage.Header *)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#ifdef __CFA_DEBUG__
469#if __SIZEOF_POINTER__ == 4
470#define MASK 0xdeadbeef
471#else
472#define MASK 0xdeadbeefdeadbeef
473#endif
474#define STRIDE size_t
475
476static void * Memset( void * addr, STRIDE size ) { // debug only
477 if ( size % sizeof(STRIDE) != 0 ) abort( "Memset() : internal error, size %zd not multiple of %zd.", size, sizeof(STRIDE) );
478 if ( (STRIDE)addr % sizeof(STRIDE) != 0 ) abort( "Memset() : internal error, addr %p not multiple of %zd.", addr, sizeof(STRIDE) );
479
480 STRIDE * end = (STRIDE *)addr + size / sizeof(STRIDE);
481 for ( STRIDE * p = (STRIDE *)addr; p < end; p += 1 ) *p = MASK;
482 return addr;
483} // Memset
484#endif // __CFA_DEBUG__
485
486
487#define NO_MEMORY_MSG "insufficient heap memory available for allocating %zd new bytes."
488
489static inline void * extend( size_t size ) with( heapManager ) {
490 lock( extlock __cfaabi_dbg_ctx2 );
491 ptrdiff_t rem = heapRemaining - size;
492 if ( rem < 0 ) {
493 // If the size requested is bigger than the current remaining storage, increase the size of the heap.
494
495 size_t increase = ceiling2( size > heapExpand ? size : heapExpand, __page_size );
496 // Do not call abort or strerror( errno ) as they may call malloc.
497 if ( sbrk( increase ) == (void *)-1 ) { // failed, no memory ?
498 unlock( extlock );
499 __cfaabi_bits_print_nolock( STDERR_FILENO, NO_MEMORY_MSG, size );
500 _exit( EXIT_FAILURE );
501 } // if
502 if ( mprotect( (char *)heapEnd + heapRemaining, increase, __map_prot ) ) {
503 unlock( extlock );
504 __cfaabi_bits_print_nolock( STDERR_FILENO, "extend() : internal error, mprotect failure, heapEnd:%p size:%zd, errno:%d.\n", heapEnd, increase, errno );
505 _exit( EXIT_FAILURE );
506 } // if
507 #ifdef __STATISTICS__
508 sbrk_calls += 1;
509 sbrk_storage += increase;
510 #endif // __STATISTICS__
511 #ifdef __CFA_DEBUG__
512 // Set new memory to garbage so subsequent uninitialized usages might fail.
513 memset( (char *)heapEnd + heapRemaining, '\xde', increase );
514 //Memset( (char *)heapEnd + heapRemaining, increase );
515 #endif // __CFA_DEBUG__
516 rem = heapRemaining + increase - size;
517 } // if
518
519 HeapManager.Storage * block = (HeapManager.Storage *)heapEnd;
520 heapRemaining = rem;
521 heapEnd = (char *)heapEnd + size;
522 unlock( extlock );
523 return block;
524} // extend
525
526
527static inline void * doMalloc( size_t size ) with( heapManager ) {
528 HeapManager.Storage * block; // pointer to new block of storage
529
530 // Look up size in the size list. Make sure the user request includes space for the header that must be allocated
531 // along with the block and is a multiple of the alignment size.
532
533 if ( unlikely( size > ULONG_MAX - sizeof(HeapManager.Storage) ) ) return 0p;
534 size_t tsize = size + sizeof(HeapManager.Storage);
535 if ( likely( tsize < mmapStart ) ) { // small size => sbrk
536 size_t posn;
537 #ifdef FASTLOOKUP
538 if ( tsize < LookupSizes ) posn = lookup[tsize];
539 else
540 #endif // FASTLOOKUP
541 posn = Bsearchl( (unsigned int)tsize, bucketSizes, (size_t)maxBucketsUsed );
542 HeapManager.FreeHeader * freeElem = &freeLists[posn];
543 verify( freeElem <= &freeLists[maxBucketsUsed] ); // subscripting error ?
544 verify( tsize <= freeElem->blockSize ); // search failure ?
545 tsize = freeElem->blockSize; // total space needed for request
546
547 // Spin until the lock is acquired for this particular size of block.
548
549 #if BUCKETLOCK == SPINLOCK
550 lock( freeElem->lock __cfaabi_dbg_ctx2 );
551 block = freeElem->freeList; // remove node from stack
552 #else
553 block = pop( freeElem->freeList );
554 #endif // BUCKETLOCK
555 if ( unlikely( block == 0p ) ) { // no free block ?
556 #if BUCKETLOCK == SPINLOCK
557 unlock( freeElem->lock );
558 #endif // BUCKETLOCK
559
560 // Freelist for that size was empty, so carve it out of the heap if there's enough left, or get some more
561 // and then carve it off.
562
563 block = (HeapManager.Storage *)extend( tsize ); // mutual exclusion on call
564 #if BUCKETLOCK == SPINLOCK
565 } else {
566 freeElem->freeList = block->header.kind.real.next;
567 unlock( freeElem->lock );
568 #endif // BUCKETLOCK
569 } // if
570
571 block->header.kind.real.home = freeElem; // pointer back to free list of apropriate size
572 } else { // large size => mmap
573 if ( unlikely( size > ULONG_MAX - __page_size ) ) return 0p;
574 tsize = ceiling2( tsize, __page_size ); // must be multiple of page size
575 #ifdef __STATISTICS__
576 __atomic_add_fetch( &mmap_calls, 1, __ATOMIC_SEQ_CST );
577 __atomic_add_fetch( &mmap_storage, tsize, __ATOMIC_SEQ_CST );
578 #endif // __STATISTICS__
579
580 block = (HeapManager.Storage *)mmap( 0, tsize, __map_prot, MAP_PRIVATE | MAP_ANONYMOUS, mmapFd, 0 );
581 if ( block == (HeapManager.Storage *)MAP_FAILED ) { // failed ?
582 if ( errno == ENOMEM ) abort( NO_MEMORY_MSG, tsize ); // no memory
583 // Do not call strerror( errno ) as it may call malloc.
584 abort( "(HeapManager &)0x%p.doMalloc() : internal error, mmap failure, size:%zu errno:%d.", &heapManager, tsize, errno );
585 } //if
586 #ifdef __CFA_DEBUG__
587 // Set new memory to garbage so subsequent uninitialized usages might fail.
588 memset( block, '\xde', tsize );
589 //Memset( block, tsize );
590 #endif // __CFA_DEBUG__
591 block->header.kind.real.blockSize = tsize; // storage size for munmap
592 } // if
593
594 block->header.kind.real.size = size; // store allocation size
595 void * addr = &(block->data); // adjust off header to user bytes
596 verify( ((uintptr_t)addr & (libAlign() - 1)) == 0 ); // minimum alignment ?
597
598 #ifdef __CFA_DEBUG__
599 __atomic_add_fetch( &allocUnfreed, tsize, __ATOMIC_SEQ_CST );
600 if ( traceHeap() ) {
601 enum { BufferSize = 64 };
602 char helpText[BufferSize];
603 int len = snprintf( helpText, BufferSize, "%p = Malloc( %zu ) (allocated %zu)\n", addr, size, tsize );
604 __cfaabi_bits_write( STDERR_FILENO, helpText, len ); // print debug/nodebug
605 } // if
606 #endif // __CFA_DEBUG__
607
608 return addr;
609} // doMalloc
610
611
612static inline void doFree( void * addr ) with( heapManager ) {
613 #ifdef __CFA_DEBUG__
614 if ( unlikely( heapManager.heapBegin == 0p ) ) {
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 abort( "Attempt to deallocate storage %p not allocated or with corrupt header.\n"
630 "Possible cause is invalid pointer.",
631 addr );
632 } // if
633 } else {
634 #ifdef __CFA_DEBUG__
635 // Set free memory to garbage so subsequent usages might fail.
636 memset( ((HeapManager.Storage *)header)->data, '\xde', freeElem->blockSize - sizeof( HeapManager.Storage ) );
637 //Memset( ((HeapManager.Storage *)header)->data, freeElem->blockSize - sizeof( HeapManager.Storage ) );
638 #endif // __CFA_DEBUG__
639
640 #ifdef __STATISTICS__
641 free_storage += size;
642 #endif // __STATISTICS__
643 #if BUCKETLOCK == SPINLOCK
644 lock( freeElem->lock __cfaabi_dbg_ctx2 ); // acquire spin lock
645 header->kind.real.next = freeElem->freeList; // push on stack
646 freeElem->freeList = (HeapManager.Storage *)header;
647 unlock( freeElem->lock ); // release spin lock
648 #else
649 push( freeElem->freeList, *(HeapManager.Storage *)header );
650 #endif // BUCKETLOCK
651 } // if
652
653 #ifdef __CFA_DEBUG__
654 __atomic_add_fetch( &allocUnfreed, -size, __ATOMIC_SEQ_CST );
655 if ( traceHeap() ) {
656 char helpText[64];
657 int len = snprintf( helpText, sizeof(helpText), "Free( %p ) size:%zu\n", addr, size );
658 __cfaabi_bits_write( STDERR_FILENO, helpText, len ); // print debug/nodebug
659 } // if
660 #endif // __CFA_DEBUG__
661} // doFree
662
663
664size_t prtFree( HeapManager & manager ) with( manager ) {
665 size_t total = 0;
666 #ifdef __STATISTICS__
667 __cfaabi_bits_acquire();
668 __cfaabi_bits_print_nolock( STDERR_FILENO, "\nBin lists (bin size : free blocks on list)\n" );
669 #endif // __STATISTICS__
670 for ( unsigned int i = 0; i < maxBucketsUsed; i += 1 ) {
671 size_t size = freeLists[i].blockSize;
672 #ifdef __STATISTICS__
673 unsigned int N = 0;
674 #endif // __STATISTICS__
675
676 #if BUCKETLOCK == SPINLOCK
677 for ( HeapManager.Storage * p = freeLists[i].freeList; p != 0p; p = p->header.kind.real.next ) {
678 #else
679 for(;;) {
680// for ( HeapManager.Storage * p = top( freeLists[i].freeList ); p != 0p; p = (p)`next->top ) {
681// for ( HeapManager.Storage * p = top( freeLists[i].freeList ); p != 0p; /* p = getNext( p )->top */) {
682// HeapManager.Storage * temp = p->header.kind.real.next.top; // FIX ME: direct assignent fails, initialization works`
683// typeof(p) temp = (( p )`next)->top; // FIX ME: direct assignent fails, initialization works`
684// p = temp;
685 #endif // BUCKETLOCK
686 total += size;
687 #ifdef __STATISTICS__
688 N += 1;
689 #endif // __STATISTICS__
690 } // for
691
692 #ifdef __STATISTICS__
693 __cfaabi_bits_print_nolock( STDERR_FILENO, "%7zu, %-7u ", size, N );
694 if ( (i + 1) % 8 == 0 ) __cfaabi_bits_print_nolock( STDERR_FILENO, "\n" );
695 #endif // __STATISTICS__
696 } // for
697 #ifdef __STATISTICS__
698 __cfaabi_bits_print_nolock( STDERR_FILENO, "\ntotal free blocks:%zu\n", total );
699 __cfaabi_bits_release();
700 #endif // __STATISTICS__
701 return (char *)heapEnd - (char *)heapBegin - total;
702} // prtFree
703
704
705static void ?{}( HeapManager & manager ) with( manager ) {
706 __page_size = sysconf( _SC_PAGESIZE );
707 __map_prot = PROT_READ | PROT_WRITE | PROT_EXEC;
708
709 for ( unsigned int i = 0; i < NoBucketSizes; i += 1 ) { // initialize the free lists
710 freeLists[i].blockSize = bucketSizes[i];
711 } // for
712
713 #ifdef FASTLOOKUP
714 unsigned int idx = 0;
715 for ( unsigned int i = 0; i < LookupSizes; i += 1 ) {
716 if ( i > bucketSizes[idx] ) idx += 1;
717 lookup[i] = idx;
718 } // for
719 #endif // FASTLOOKUP
720
721 if ( ! setMmapStart( default_mmap_start() ) ) {
722 abort( "HeapManager : internal error, mmap start initialization failure." );
723 } // if
724 heapExpand = default_heap_expansion();
725
726 char * end = (char *)sbrk( 0 );
727 heapBegin = heapEnd = sbrk( (char *)ceiling2( (long unsigned int)end, __page_size ) - end ); // move start of heap to multiple of alignment
728} // HeapManager
729
730
731static void ^?{}( HeapManager & ) {
732 #ifdef __STATISTICS__
733 if ( traceHeapTerm() ) {
734 printStats();
735 // prtUnfreed() called in heapAppStop()
736 } // if
737 #endif // __STATISTICS__
738} // ~HeapManager
739
740
741static void memory_startup( void ) __attribute__(( constructor( STARTUP_PRIORITY_MEMORY ) ));
742void memory_startup( void ) {
743 #ifdef __CFA_DEBUG__
744 if ( heapBoot ) { // check for recursion during system boot
745 abort( "boot() : internal error, recursively invoked during system boot." );
746 } // if
747 heapBoot = true;
748 #endif // __CFA_DEBUG__
749
750 //verify( heapManager.heapBegin != 0 );
751 //heapManager{};
752 if ( heapManager.heapBegin == 0p ) heapManager{}; // sanity check
753} // memory_startup
754
755static void memory_shutdown( void ) __attribute__(( destructor( STARTUP_PRIORITY_MEMORY ) ));
756void memory_shutdown( void ) {
757 ^heapManager{};
758} // memory_shutdown
759
760
761static inline void * mallocNoStats( size_t size ) { // necessary for malloc statistics
762 verify( heapManager.heapBegin != 0p ); // called before memory_startup ?
763 if ( unlikely( size ) == 0 ) return 0p; // 0 BYTE ALLOCATION RETURNS NULL POINTER
764
765#if __SIZEOF_POINTER__ == 8
766 verify( size < ((typeof(size_t))1 << 48) );
767#endif // __SIZEOF_POINTER__ == 8
768 return doMalloc( size );
769} // mallocNoStats
770
771
772static inline void * callocNoStats( size_t dim, size_t elemSize ) {
773 size_t size = dim * elemSize;
774 if ( unlikely( size ) == 0 ) return 0p; // 0 BYTE ALLOCATION RETURNS NULL POINTER
775 char * addr = (char *)mallocNoStats( size );
776
777 HeapManager.Storage.Header * header;
778 HeapManager.FreeHeader * freeElem;
779 size_t bsize, alignment;
780 #ifndef __CFA_DEBUG__
781 bool mapped =
782 #endif // __CFA_DEBUG__
783 headers( "calloc", addr, header, freeElem, bsize, alignment );
784 #ifndef __CFA_DEBUG__
785
786 // Mapped storage is zero filled, but in debug mode mapped memory is scrubbed in doMalloc, so it has to be reset to zero.
787 if ( ! mapped )
788 #endif // __CFA_DEBUG__
789 // <-------0000000000000000000000000000UUUUUUUUUUUUUUUUUUUUUUUUU> bsize (bucket size) U => undefined
790 // `-header`-addr `-size
791 memset( addr, '\0', size ); // set to zeros
792
793 header->kind.real.blockSize |= 2; // mark as zero filled
794 return addr;
795} // callocNoStats
796
797
798static inline void * memalignNoStats( size_t alignment, size_t size ) {
799 if ( unlikely( size ) == 0 ) return 0p; // 0 BYTE ALLOCATION RETURNS NULL POINTER
800
801 #ifdef __CFA_DEBUG__
802 checkAlign( alignment ); // check alignment
803 #endif // __CFA_DEBUG__
804
805 // if alignment <= default alignment, do normal malloc as two headers are unnecessary
806 if ( unlikely( alignment <= libAlign() ) ) return mallocNoStats( size );
807
808 // Allocate enough storage to guarantee an address on the alignment boundary, and sufficient space before it for
809 // administrative storage. NOTE, WHILE THERE ARE 2 HEADERS, THE FIRST ONE IS IMPLICITLY CREATED BY DOMALLOC.
810 // .-------------v-----------------v----------------v----------,
811 // | Real Header | ... padding ... | Fake Header | data ... |
812 // `-------------^-----------------^-+--------------^----------'
813 // |<--------------------------------' offset/align |<-- alignment boundary
814
815 // subtract libAlign() because it is already the minimum alignment
816 // add sizeof(Storage) for fake header
817 char * addr = (char *)mallocNoStats( size + alignment - libAlign() + sizeof(HeapManager.Storage) );
818
819 // address in the block of the "next" alignment address
820 char * user = (char *)ceiling2( (uintptr_t)(addr + sizeof(HeapManager.Storage)), alignment );
821
822 // address of header from malloc
823 HeapManager.Storage.Header * realHeader = headerAddr( addr );
824 realHeader->kind.real.size = size; // correct size to eliminate above alignment offset
825 // address of fake header * before* the alignment location
826 HeapManager.Storage.Header * fakeHeader = headerAddr( user );
827 // SKULLDUGGERY: insert the offset to the start of the actual storage block and remember alignment
828 fakeHeader->kind.fake.offset = (char *)fakeHeader - (char *)realHeader;
829 // SKULLDUGGERY: odd alignment imples fake header
830 fakeHeader->kind.fake.alignment = alignment | 1;
831
832 return user;
833} // memalignNoStats
834
835
836static inline void * cmemalignNoStats( size_t alignment, size_t dim, size_t elemSize ) {
837 size_t size = dim * elemSize;
838 if ( unlikely( size ) == 0 ) return 0p; // 0 BYTE ALLOCATION RETURNS NULL POINTER
839 char * addr = (char *)memalignNoStats( alignment, size );
840
841 HeapManager.Storage.Header * header;
842 HeapManager.FreeHeader * freeElem;
843 size_t bsize;
844 #ifndef __CFA_DEBUG__
845 bool mapped =
846 #endif // __CFA_DEBUG__
847 headers( "cmemalign", addr, header, freeElem, bsize, alignment );
848
849 // Mapped storage is zero filled, but in debug mode mapped memory is scrubbed in doMalloc, so it has to be reset to zero.
850 #ifndef __CFA_DEBUG__
851 if ( ! mapped )
852 #endif // __CFA_DEBUG__
853 // <-------0000000000000000000000000000UUUUUUUUUUUUUUUUUUUUUUUUU> bsize (bucket size) U => undefined
854 // `-header`-addr `-size
855 memset( addr, '\0', size ); // set to zeros
856
857 header->kind.real.blockSize |= 2; // mark as zero filled
858 return addr;
859} // cmemalignNoStats
860
861
862extern "C" {
863 // Allocates size bytes and returns a pointer to the allocated memory. The contents are undefined. If size is 0,
864 // then malloc() returns a unique pointer value that can later be successfully passed to free().
865 void * malloc( size_t size ) {
866 #ifdef __STATISTICS__
867 __atomic_add_fetch( &malloc_calls, 1, __ATOMIC_SEQ_CST );
868 __atomic_add_fetch( &malloc_storage, size, __ATOMIC_SEQ_CST );
869 #endif // __STATISTICS__
870
871 return mallocNoStats( size );
872 } // malloc
873
874
875 // Same as malloc() except size bytes is an array of dim elements each of elemSize bytes.
876 void * aalloc( size_t dim, size_t elemSize ) {
877 size_t size = dim * elemSize;
878 #ifdef __STATISTICS__
879 __atomic_add_fetch( &aalloc_calls, 1, __ATOMIC_SEQ_CST );
880 __atomic_add_fetch( &aalloc_storage, size, __ATOMIC_SEQ_CST );
881 #endif // __STATISTICS__
882
883 return mallocNoStats( size );
884 } // aalloc
885
886
887 // Same as aalloc() with memory set to zero.
888 void * calloc( size_t dim, size_t elemSize ) {
889 #ifdef __STATISTICS__
890 __atomic_add_fetch( &calloc_calls, 1, __ATOMIC_SEQ_CST );
891 __atomic_add_fetch( &calloc_storage, dim * elemSize, __ATOMIC_SEQ_CST );
892 #endif // __STATISTICS__
893
894 return callocNoStats( dim, elemSize );
895 } // calloc
896
897
898 // Change the size of the memory block pointed to by oaddr to size bytes. The contents are undefined. If oaddr is
899 // 0p, then the call is equivalent to malloc(size), for all values of size; if size is equal to zero, and oaddr is
900 // not 0p, then the call is equivalent to free(oaddr). Unless oaddr is 0p, it must have been returned by an earlier
901 // call to malloc(), alloc(), calloc() or realloc(). If the area pointed to was moved, a free(oaddr) is done.
902 void * resize( void * oaddr, size_t size ) {
903 #ifdef __STATISTICS__
904 __atomic_add_fetch( &resize_calls, 1, __ATOMIC_SEQ_CST );
905 #endif // __STATISTICS__
906
907 // If size is equal to 0, either NULL or a pointer suitable to be passed to free() is returned.
908 if ( unlikely( size == 0 ) ) { free( oaddr ); return 0p; } // special cases
909 if ( unlikely( oaddr == 0p ) ) {
910 #ifdef __STATISTICS__
911 __atomic_add_fetch( &resize_storage, size, __ATOMIC_SEQ_CST );
912 #endif // __STATISTICS__
913 return mallocNoStats( size );
914 } // if
915
916 HeapManager.Storage.Header * header;
917 HeapManager.FreeHeader * freeElem;
918 size_t bsize, oalign;
919 headers( "resize", oaddr, header, freeElem, bsize, oalign );
920 size_t odsize = dataStorage( bsize, oaddr, header ); // data storage available in bucket
921
922 // same size, DO NOT preserve STICKY PROPERTIES.
923 if ( oalign == libAlign() && size <= odsize && odsize <= size * 2 ) { // allow 50% wasted storage for smaller size
924 header->kind.real.blockSize &= -2; // no alignment and turn off 0 fill
925 header->kind.real.size = size; // reset allocation size
926 return oaddr;
927 } // if
928
929 #ifdef __STATISTICS__
930 __atomic_add_fetch( &resize_storage, size, __ATOMIC_SEQ_CST );
931 #endif // __STATISTICS__
932
933 // change size, DO NOT preserve STICKY PROPERTIES.
934 free( oaddr );
935 return mallocNoStats( size ); // create new area
936 } // resize
937
938
939 // Same as resize() but the contents are unchanged in the range from the start of the region up to the minimum of
940 // the old and new sizes.
941 void * realloc( void * oaddr, size_t size ) {
942 #ifdef __STATISTICS__
943 __atomic_add_fetch( &realloc_calls, 1, __ATOMIC_SEQ_CST );
944 #endif // __STATISTICS__
945
946 // If size is equal to 0, either NULL or a pointer suitable to be passed to free() is returned.
947 if ( unlikely( size == 0 ) ) { free( oaddr ); return 0p; } // special cases
948 if ( unlikely( oaddr == 0p ) ) {
949 #ifdef __STATISTICS__
950 __atomic_add_fetch( &realloc_storage, size, __ATOMIC_SEQ_CST );
951 #endif // __STATISTICS__
952 return mallocNoStats( size );
953 } // if
954
955 HeapManager.Storage.Header * header;
956 HeapManager.FreeHeader * freeElem;
957 size_t bsize, oalign;
958 headers( "realloc", oaddr, header, freeElem, bsize, oalign );
959
960 size_t odsize = dataStorage( bsize, oaddr, header ); // data storage available in bucket
961 size_t osize = header->kind.real.size; // old allocation size
962 bool ozfill = (header->kind.real.blockSize & 2); // old allocation zero filled
963 if ( unlikely( size <= odsize ) && odsize <= size * 2 ) { // allow up to 50% wasted storage
964 header->kind.real.size = size; // reset allocation size
965 if ( unlikely( ozfill ) && size > osize ) { // previous request zero fill and larger ?
966 memset( (char *)oaddr + osize, '\0', size - osize ); // initialize added storage
967 } // if
968 return oaddr;
969 } // if
970
971 #ifdef __STATISTICS__
972 __atomic_add_fetch( &realloc_storage, size, __ATOMIC_SEQ_CST );
973 #endif // __STATISTICS__
974
975 // change size and copy old content to new storage
976
977 void * naddr;
978 if ( likely( oalign == libAlign() ) ) { // previous request not aligned ?
979 naddr = mallocNoStats( size ); // create new area
980 } else {
981 naddr = memalignNoStats( oalign, size ); // create new aligned area
982 } // if
983
984 headers( "realloc", naddr, header, freeElem, bsize, oalign );
985 memcpy( naddr, oaddr, min( osize, size ) ); // copy bytes
986 free( oaddr );
987
988 if ( unlikely( ozfill ) ) { // previous request zero fill ?
989 header->kind.real.blockSize |= 2; // mark new request as zero filled
990 if ( size > osize ) { // previous request larger ?
991 memset( (char *)naddr + osize, '\0', size - osize ); // initialize added storage
992 } // if
993 } // if
994 return naddr;
995 } // realloc
996
997
998 // Same as malloc() except the memory address is a multiple of alignment, which must be a power of two. (obsolete)
999 void * memalign( size_t alignment, size_t size ) {
1000 #ifdef __STATISTICS__
1001 __atomic_add_fetch( &memalign_calls, 1, __ATOMIC_SEQ_CST );
1002 __atomic_add_fetch( &memalign_storage, size, __ATOMIC_SEQ_CST );
1003 #endif // __STATISTICS__
1004
1005 return memalignNoStats( alignment, size );
1006 } // memalign
1007
1008
1009 // Same as aalloc() with memory alignment.
1010 void * amemalign( size_t alignment, size_t dim, size_t elemSize ) {
1011 size_t size = dim * elemSize;
1012 #ifdef __STATISTICS__
1013 __atomic_add_fetch( &cmemalign_calls, 1, __ATOMIC_SEQ_CST );
1014 __atomic_add_fetch( &cmemalign_storage, size, __ATOMIC_SEQ_CST );
1015 #endif // __STATISTICS__
1016
1017 return memalignNoStats( alignment, size );
1018 } // amemalign
1019
1020
1021 // Same as calloc() with memory alignment.
1022 void * cmemalign( size_t alignment, size_t dim, size_t elemSize ) {
1023 #ifdef __STATISTICS__
1024 __atomic_add_fetch( &cmemalign_calls, 1, __ATOMIC_SEQ_CST );
1025 __atomic_add_fetch( &cmemalign_storage, dim * elemSize, __ATOMIC_SEQ_CST );
1026 #endif // __STATISTICS__
1027
1028 return cmemalignNoStats( alignment, dim, elemSize );
1029 } // cmemalign
1030
1031
1032 // Same as memalign(), but ISO/IEC 2011 C11 Section 7.22.2 states: the value of size shall be an integral multiple
1033 // of alignment. This requirement is universally ignored.
1034 void * aligned_alloc( size_t alignment, size_t size ) {
1035 return memalign( alignment, size );
1036 } // aligned_alloc
1037
1038
1039 // Allocates size bytes and places the address of the allocated memory in *memptr. The address of the allocated
1040 // memory shall be a multiple of alignment, which must be a power of two and a multiple of sizeof(void *). If size
1041 // is 0, then posix_memalign() returns either 0p, or a unique pointer value that can later be successfully passed to
1042 // free(3).
1043 int posix_memalign( void ** memptr, size_t alignment, size_t size ) {
1044 if ( alignment < libAlign() || ! is_pow2( alignment ) ) return EINVAL; // check alignment
1045 * memptr = memalign( alignment, size );
1046 return 0;
1047 } // posix_memalign
1048
1049
1050 // Allocates size bytes and returns a pointer to the allocated memory. The memory address shall be a multiple of the
1051 // page size. It is equivalent to memalign(sysconf(_SC_PAGESIZE),size).
1052 void * valloc( size_t size ) {
1053 return memalign( __page_size, size );
1054 } // valloc
1055
1056
1057 // Same as valloc but rounds size to multiple of page size.
1058 void * pvalloc( size_t size ) {
1059 return memalign( __page_size, ceiling2( size, __page_size ) );
1060 } // pvalloc
1061
1062
1063 // Frees the memory space pointed to by ptr, which must have been returned by a previous call to malloc(), calloc()
1064 // or realloc(). Otherwise, or if free(ptr) has already been called before, undefined behaviour occurs. If ptr is
1065 // 0p, no operation is performed.
1066 void free( void * addr ) {
1067 #ifdef __STATISTICS__
1068 __atomic_add_fetch( &free_calls, 1, __ATOMIC_SEQ_CST );
1069 #endif // __STATISTICS__
1070
1071 if ( unlikely( addr == 0p ) ) { // special case
1072 // #ifdef __CFA_DEBUG__
1073 // if ( traceHeap() ) {
1074 // #define nullmsg "Free( 0x0 ) size:0\n"
1075 // // Do not debug print free( 0p ), as it can cause recursive entry from sprintf.
1076 // __cfaabi_dbg_write( nullmsg, sizeof(nullmsg) - 1 );
1077 // } // if
1078 // #endif // __CFA_DEBUG__
1079 return;
1080 } // exit
1081
1082 doFree( addr );
1083 } // free
1084
1085
1086 // Returns the alignment of an allocation.
1087 size_t malloc_alignment( void * addr ) {
1088 if ( unlikely( addr == 0p ) ) return libAlign(); // minimum alignment
1089 HeapManager.Storage.Header * header = headerAddr( addr );
1090 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1091 return header->kind.fake.alignment & -2; // remove flag from value
1092 } else {
1093 return libAlign(); // minimum alignment
1094 } // if
1095 } // malloc_alignment
1096
1097
1098 // Set the alignment for an the allocation and return previous alignment or 0 if no alignment.
1099 size_t $malloc_alignment_set( void * addr, size_t alignment ) {
1100 if ( unlikely( addr == 0p ) ) return libAlign(); // minimum alignment
1101 size_t ret;
1102 HeapManager.Storage.Header * header = headerAddr( addr );
1103 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1104 ret = header->kind.fake.alignment & -2; // remove flag from old value
1105 header->kind.fake.alignment = alignment | 1; // add flag to new value
1106 } else {
1107 ret = 0; // => no alignment to change
1108 } // if
1109 return ret;
1110 } // $malloc_alignment_set
1111
1112
1113 // Returns true if the allocation is zero filled, e.g., allocated by calloc().
1114 bool malloc_zero_fill( void * addr ) {
1115 if ( unlikely( addr == 0p ) ) return false; // null allocation is not zero fill
1116 HeapManager.Storage.Header * header = headerAddr( addr );
1117 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1118 header = realHeader( header ); // backup from fake to real header
1119 } // if
1120 return (header->kind.real.blockSize & 2) != 0; // zero filled ?
1121 } // malloc_zero_fill
1122
1123 // Set allocation is zero filled and return previous zero filled.
1124 bool $malloc_zero_fill_set( void * addr ) {
1125 if ( unlikely( addr == 0p ) ) return false; // null allocation is not zero fill
1126 HeapManager.Storage.Header * header = headerAddr( addr );
1127 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1128 header = realHeader( header ); // backup from fake to real header
1129 } // if
1130 bool ret = (header->kind.real.blockSize & 2) != 0; // zero filled ?
1131 header->kind.real.blockSize |= 2; // mark as zero filled
1132 return ret;
1133 } // $malloc_zero_fill_set
1134
1135
1136 // Returns original total allocation size (not bucket size) => array size is dimension * sizeif(T).
1137 size_t malloc_size( void * addr ) {
1138 if ( unlikely( addr == 0p ) ) return 0; // null allocation has zero size
1139 HeapManager.Storage.Header * header = headerAddr( addr );
1140 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1141 header = realHeader( header ); // backup from fake to real header
1142 } // if
1143 return header->kind.real.size;
1144 } // malloc_size
1145
1146 // Set allocation size and return previous size.
1147 size_t $malloc_size_set( void * addr, size_t size ) {
1148 if ( unlikely( addr == 0p ) ) return 0; // null allocation has 0 size
1149 HeapManager.Storage.Header * header = headerAddr( addr );
1150 if ( (header->kind.fake.alignment & 1) == 1 ) { // fake header ?
1151 header = realHeader( header ); // backup from fake to real header
1152 } // if
1153 size_t ret = header->kind.real.size;
1154 header->kind.real.size = size;
1155 return ret;
1156 } // $malloc_size_set
1157
1158
1159 // Returns the number of usable bytes in the block pointed to by ptr, a pointer to a block of memory allocated by
1160 // malloc or a related function.
1161 size_t malloc_usable_size( void * addr ) {
1162 if ( unlikely( addr == 0p ) ) return 0; // null allocation has 0 size
1163 HeapManager.Storage.Header * header;
1164 HeapManager.FreeHeader * freeElem;
1165 size_t bsize, alignment;
1166
1167 headers( "malloc_usable_size", addr, header, freeElem, bsize, alignment );
1168 return dataStorage( bsize, addr, header ); // data storage in bucket
1169 } // malloc_usable_size
1170
1171
1172 // Prints (on default standard error) statistics about memory allocated by malloc and related functions.
1173 void malloc_stats( void ) {
1174 #ifdef __STATISTICS__
1175 printStats();
1176 if ( prtFree() ) prtFree( heapManager );
1177 #endif // __STATISTICS__
1178 } // malloc_stats
1179
1180
1181 // Changes the file descripter where malloc_stats() writes statistics.
1182 int malloc_stats_fd( int fd __attribute__(( unused )) ) {
1183 #ifdef __STATISTICS__
1184 int temp = stat_fd;
1185 stat_fd = fd;
1186 return temp;
1187 #else
1188 return -1;
1189 #endif // __STATISTICS__
1190 } // malloc_stats_fd
1191
1192
1193 // Adjusts parameters that control the behaviour of the memory-allocation functions (see malloc). The param argument
1194 // specifies the parameter to be modified, and value specifies the new value for that parameter.
1195 int mallopt( int option, int value ) {
1196 choose( option ) {
1197 case M_TOP_PAD:
1198 heapExpand = ceiling2( value, __page_size ); return 1;
1199 case M_MMAP_THRESHOLD:
1200 if ( setMmapStart( value ) ) return 1;
1201 break;
1202 } // switch
1203 return 0; // error, unsupported
1204 } // mallopt
1205
1206
1207 // Attempt to release free memory at the top of the heap (by calling sbrk with a suitable argument).
1208 int malloc_trim( size_t ) {
1209 return 0; // => impossible to release memory
1210 } // malloc_trim
1211
1212
1213 // Exports an XML string that describes the current state of the memory-allocation implementation in the caller.
1214 // The string is printed on the file stream stream. The exported string includes information about all arenas (see
1215 // malloc).
1216 int malloc_info( int options, FILE * stream ) {
1217 if ( options != 0 ) { errno = EINVAL; return -1; }
1218 #ifdef __STATISTICS__
1219 return printStatsXML( stream );
1220 #else
1221 return 0; // unsupported
1222 #endif // __STATISTICS__
1223 } // malloc_info
1224
1225
1226 // Records the current state of all malloc internal bookkeeping variables (but not the actual contents of the heap
1227 // or the state of malloc_hook functions pointers). The state is recorded in a system-dependent opaque data
1228 // structure dynamically allocated via malloc, and a pointer to that data structure is returned as the function
1229 // result. (The caller must free this memory.)
1230 void * malloc_get_state( void ) {
1231 return 0p; // unsupported
1232 } // malloc_get_state
1233
1234
1235 // Restores the state of all malloc internal bookkeeping variables to the values recorded in the opaque data
1236 // structure pointed to by state.
1237 int malloc_set_state( void * ) {
1238 return 0; // unsupported
1239 } // malloc_set_state
1240} // extern "C"
1241
1242
1243// Must have CFA linkage to overload with C linkage realloc.
1244void * resize( void * oaddr, size_t nalign, size_t size ) {
1245 #ifdef __STATISTICS__
1246 __atomic_add_fetch( &resize_calls, 1, __ATOMIC_SEQ_CST );
1247 #endif // __STATISTICS__
1248
1249 if ( unlikely( nalign < libAlign() ) ) nalign = libAlign(); // reset alignment to minimum
1250 #ifdef __CFA_DEBUG__
1251 else
1252 checkAlign( nalign ); // check alignment
1253 #endif // __CFA_DEBUG__
1254
1255 // If size is equal to 0, either NULL or a pointer suitable to be passed to free() is returned.
1256 if ( unlikely( size == 0 ) ) { free( oaddr ); return 0p; } // special cases
1257 if ( unlikely( oaddr == 0p ) ) {
1258 #ifdef __STATISTICS__
1259 __atomic_add_fetch( &resize_storage, size, __ATOMIC_SEQ_CST );
1260 #endif // __STATISTICS__
1261 return memalignNoStats( nalign, size );
1262 } // if
1263
1264 // Attempt to reuse existing alignment.
1265 HeapManager.Storage.Header * header = headerAddr( oaddr );
1266 bool isFakeHeader = header->kind.fake.alignment & 1; // old fake header ?
1267 size_t oalign;
1268 if ( isFakeHeader ) {
1269 oalign = header->kind.fake.alignment & -2; // old alignment
1270 if ( (uintptr_t)oaddr % nalign == 0 // lucky match ?
1271 && ( oalign <= nalign // going down
1272 || (oalign >= nalign && oalign <= 256) ) // little alignment storage wasted ?
1273 ) {
1274 headerAddr( oaddr )->kind.fake.alignment = nalign | 1; // update alignment (could be the same)
1275 HeapManager.FreeHeader * freeElem;
1276 size_t bsize, oalign;
1277 headers( "resize", oaddr, header, freeElem, bsize, oalign );
1278 size_t odsize = dataStorage( bsize, oaddr, header ); // data storage available in bucket
1279
1280 if ( size <= odsize && odsize <= size * 2 ) { // allow 50% wasted data storage
1281 headerAddr( oaddr )->kind.fake.alignment = nalign | 1; // update alignment (could be the same)
1282
1283 header->kind.real.blockSize &= -2; // turn off 0 fill
1284 header->kind.real.size = size; // reset allocation size
1285 return oaddr;
1286 } // if
1287 } // if
1288 } else if ( ! isFakeHeader // old real header (aligned on libAlign) ?
1289 && nalign == libAlign() ) { // new alignment also on libAlign => no fake header needed
1290 return resize( oaddr, size ); // duplicate special case checks
1291 } // if
1292
1293 #ifdef __STATISTICS__
1294 __atomic_add_fetch( &resize_storage, size, __ATOMIC_SEQ_CST );
1295 #endif // __STATISTICS__
1296
1297 // change size, DO NOT preserve STICKY PROPERTIES.
1298 free( oaddr );
1299 return memalignNoStats( nalign, size ); // create new aligned area
1300} // resize
1301
1302
1303void * realloc( void * oaddr, size_t nalign, size_t size ) {
1304 if ( unlikely( nalign < libAlign() ) ) nalign = libAlign(); // reset alignment to minimum
1305 #ifdef __CFA_DEBUG__
1306 else
1307 checkAlign( nalign ); // check alignment
1308 #endif // __CFA_DEBUG__
1309
1310 // If size is equal to 0, either NULL or a pointer suitable to be passed to free() is returned.
1311 if ( unlikely( size == 0 ) ) { free( oaddr ); return 0p; } // special cases
1312 if ( unlikely( oaddr == 0p ) ) {
1313 #ifdef __STATISTICS__
1314 __atomic_add_fetch( &realloc_calls, 1, __ATOMIC_SEQ_CST );
1315 __atomic_add_fetch( &realloc_storage, size, __ATOMIC_SEQ_CST );
1316 #endif // __STATISTICS__
1317 return memalignNoStats( nalign, size );
1318 } // if
1319
1320 // Attempt to reuse existing alignment.
1321 HeapManager.Storage.Header * header = headerAddr( oaddr );
1322 bool isFakeHeader = header->kind.fake.alignment & 1; // old fake header ?
1323 size_t oalign;
1324 if ( isFakeHeader ) {
1325 oalign = header->kind.fake.alignment & -2; // old alignment
1326 if ( (uintptr_t)oaddr % nalign == 0 // lucky match ?
1327 && ( oalign <= nalign // going down
1328 || (oalign >= nalign && oalign <= 256) ) // little alignment storage wasted ?
1329 ) {
1330 headerAddr( oaddr )->kind.fake.alignment = nalign | 1; // update alignment (could be the same)
1331 return realloc( oaddr, size ); // duplicate alignment and special case checks
1332 } // if
1333 } else if ( ! isFakeHeader // old real header (aligned on libAlign) ?
1334 && nalign == libAlign() ) // new alignment also on libAlign => no fake header needed
1335 return realloc( oaddr, size ); // duplicate alignment and special case checks
1336
1337 #ifdef __STATISTICS__
1338 __atomic_add_fetch( &realloc_calls, 1, __ATOMIC_SEQ_CST );
1339 __atomic_add_fetch( &realloc_storage, size, __ATOMIC_SEQ_CST );
1340 #endif // __STATISTICS__
1341
1342 HeapManager.FreeHeader * freeElem;
1343 size_t bsize;
1344 headers( "realloc", oaddr, header, freeElem, bsize, oalign );
1345
1346 // change size and copy old content to new storage
1347
1348 size_t osize = header->kind.real.size; // old allocation size
1349 bool ozfill = (header->kind.real.blockSize & 2); // old allocation zero filled
1350
1351 void * naddr = memalignNoStats( nalign, size ); // create new aligned area
1352
1353 headers( "realloc", naddr, header, freeElem, bsize, oalign );
1354 memcpy( naddr, oaddr, min( osize, size ) ); // copy bytes
1355 free( oaddr );
1356
1357 if ( unlikely( ozfill ) ) { // previous request zero fill ?
1358 header->kind.real.blockSize |= 2; // mark new request as zero filled
1359 if ( size > osize ) { // previous request larger ?
1360 memset( (char *)naddr + osize, '\0', size - osize ); // initialize added storage
1361 } // if
1362 } // if
1363 return naddr;
1364} // realloc
1365
1366
1367// Local Variables: //
1368// tab-width: 4 //
1369// compile-command: "cfa -nodebug -O2 heap.cfa" //
1370// End: //
Note: See TracBrowser for help on using the repository browser.