Context Navigation

heap.cfa @ f76ff0b

ADTarm-ehast-experimentalenumforall-pointer-decayjacob/cs343-translationnew-ast-unique-exprpthread-emulationqualifiedEnum

Last change on this file since f76ff0b was f76ff0b, checked in by m3zulfiq <m3zulfiq@…>, 4 years ago
alloc2.txt: added expected output file for test alloc2.cfa. heap.cfa: removed alignment bugs from realloc and resize with alignment. stdlib.hfa: removed debug prints from alloc interface. alloc2.cfa, malloc.cfa: uncommented tests that were previously commented because of a bug in realloc and resize.
Property mode set to `100644`
File size: 50.6 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format