source: libcfa/src/heap.cfa @ 95cb63b

ADTarm-ehast-experimentalenumforall-pointer-decayjacob/cs343-translationnew-astnew-ast-unique-exprpthread-emulationqualifiedEnum
Last change on this file since 95cb63b was 9c438546, checked in by Peter A. Buhr <pabuhr@…>, 4 years ago

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