2 * Copyright (C) 2012, 2013
6 * Permission is hereby granted, free of charge, to any person obtaining a copy of
7 * this software and associated documentation files (the "Software"), to deal in
8 * the Software without restriction, including without limitation the rights to
9 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10 * of the Software, and to permit persons to whom the Software is furnished to do
11 * so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 * GMQCC performs tons of allocations, constructions, and crazyness
32 * all around. When trying to optimizes systems, or just get fancy
33 * statistics out of the compiler, it's often printf mess. This file
34 * implements the statistics system of the compiler. I.E the allocator
35 * we use to track allocations, and other systems of interest.
39 typedef struct stat_mem_block_s {
43 struct stat_mem_block_s *next;
44 struct stat_mem_block_s *prev;
50 } stat_size_entry_t, **stat_size_table_t;
52 static uint64_t stat_mem_allocated = 0;
53 static uint64_t stat_mem_deallocated = 0;
54 static uint64_t stat_mem_allocated_total = 0;
55 static uint64_t stat_mem_deallocated_total = 0;
56 static uint64_t stat_mem_high = 0;
57 static uint64_t stat_mem_peak = 0;
58 static uint64_t stat_used_strdups = 0;
59 static uint64_t stat_used_vectors = 0;
60 static uint64_t stat_used_hashtables = 0;
61 static uint64_t stat_type_vectors = 0;
62 static uint64_t stat_type_hashtables = 0;
63 static stat_size_table_t stat_size_vectors = NULL;
64 static stat_size_table_t stat_size_hashtables = NULL;
65 static stat_mem_block_t *stat_mem_block_root = NULL;
68 * A tiny size_t key-value hashtbale for tracking vector and hashtable
69 * sizes. We can use it for other things too, if we need to. This is
70 * very TIGHT, and efficent in terms of space though.
72 static stat_size_table_t stat_size_new(void) {
73 return (stat_size_table_t)memset(
74 mem_a(sizeof(stat_size_entry_t*) * ST_SIZE),
75 0, ST_SIZE * sizeof(stat_size_entry_t*)
79 static void stat_size_del(stat_size_table_t table) {
81 for (; i < ST_SIZE; i++) if(table[i]) mem_d(table[i]);
85 static stat_size_entry_t *stat_size_get(stat_size_table_t table, size_t key) {
86 size_t hash = (key % ST_SIZE);
87 while (table[hash] && table[hash]->key != key)
88 hash = (hash + 1) % ST_SIZE;
91 static void stat_size_put(stat_size_table_t table, size_t key, size_t value) {
92 size_t hash = (key % ST_SIZE);
93 while (table[hash] && table[hash]->key != key)
94 hash = (hash + 1) % ST_SIZE;
95 table[hash] = (stat_size_entry_t*)mem_a(sizeof(stat_size_entry_t));
96 table[hash]->key = key;
97 table[hash]->value = value;
101 * A basic header of information wrapper allocator. Simply stores
102 * information as a header, returns the memory + 1 past it, can be
103 * retrieved again with - 1. Where type is stat_mem_block_t*.
105 void *stat_mem_allocate(size_t size, size_t line, const char *file) {
106 stat_mem_block_t *info = (stat_mem_block_t*)malloc(sizeof(stat_mem_block_t) + size);
107 void *data = (void*)(info + 1);
116 info->next = stat_mem_block_root;
118 if (stat_mem_block_root)
119 stat_mem_block_root->prev = info;
121 stat_mem_block_root = info;
122 stat_mem_allocated += size;
123 stat_mem_high += size;
124 stat_mem_allocated_total ++;
126 if (stat_mem_high > stat_mem_peak)
127 stat_mem_peak = stat_mem_high;
132 void stat_mem_deallocate(void *ptr) {
133 stat_mem_block_t *info = NULL;
138 info = ((stat_mem_block_t*)ptr - 1);
140 stat_mem_deallocated += info->size;
141 stat_mem_high -= info->size;
142 stat_mem_deallocated_total ++;
144 if (info->prev) info->prev->next = info->next;
145 if (info->next) info->next->prev = info->prev;
148 if (info == stat_mem_block_root)
149 stat_mem_block_root = info->next;
154 void *stat_mem_reallocate(void *ptr, size_t size, size_t line, const char *file) {
155 stat_mem_block_t *oldinfo = NULL;
156 stat_mem_block_t *newinfo;
159 return stat_mem_allocate(size, line, file);
161 /* stay consistent with glic */
163 stat_mem_deallocate(ptr);
167 oldinfo = ((stat_mem_block_t*)ptr - 1);
168 newinfo = ((stat_mem_block_t*)malloc(sizeof(stat_mem_block_t) + size));
171 stat_mem_deallocate(ptr);
175 memcpy(newinfo+1, oldinfo+1, oldinfo->size);
177 if (oldinfo->prev) oldinfo->prev->next = oldinfo->next;
178 if (oldinfo->next) oldinfo->next->prev = oldinfo->prev;
181 if (oldinfo == stat_mem_block_root)
182 stat_mem_block_root = oldinfo->next;
184 newinfo->line = line;
185 newinfo->size = size;
186 newinfo->file = file;
187 newinfo->prev = NULL;
188 newinfo->next = stat_mem_block_root;
190 if (stat_mem_block_root)
191 stat_mem_block_root->prev = newinfo;
193 stat_mem_block_root = newinfo;
194 stat_mem_allocated -= oldinfo->size;
195 stat_mem_high -= oldinfo->size;
196 stat_mem_allocated += newinfo->size;
197 stat_mem_high += newinfo->size;
199 if (stat_mem_high > stat_mem_peak)
200 stat_mem_peak = stat_mem_high;
208 * strdup does it's own malloc, we need to track malloc. We don't want
209 * to overwrite malloc though, infact, we can't really hook it at all
210 * without library specific assumptions. So we re implement strdup.
212 char *stat_mem_strdup(const char *src, size_t line, const char *file, bool empty) {
220 if (((!empty) ? len : true) && (ptr = (char*)stat_mem_allocate(len + 1, line, file))) {
221 memcpy(ptr, src, len);
225 stat_used_strdups ++;
230 * The reallocate function for resizing vectors.
232 void _util_vec_grow(void **a, size_t i, size_t s) {
233 vector_t *d = vec_meta(*a);
235 stat_size_entry_t *e = NULL;
239 m = 2 * d->allocated + i;
240 p = mem_r(d, s * m + sizeof(vector_t));
243 p = mem_a(s * m + sizeof(vector_t));
244 ((vector_t*)p)->used = 0;
248 if (!stat_size_vectors)
249 stat_size_vectors = stat_size_new();
251 if ((e = stat_size_get(stat_size_vectors, s))) {
254 stat_size_put(stat_size_vectors, s, 1); /* start off with 1 */
258 *a = (vector_t*)p + 1;
259 vec_meta(*a)->allocated = m;
263 * Hash table for generic data, based on dynamic memory allocations
264 * all around. This is the internal interface, please look for
265 * EXPOSED INTERFACE comment below
267 typedef struct hash_node_t {
268 char *key; /* the key for this node in table */
269 void *value; /* pointer to the data as void* */
270 struct hash_node_t *next; /* next node (linked list) */
274 * This is a patched version of the Murmur2 hashing function to use
275 * a proper pre-mix and post-mix setup. Infact this is Murmur3 for
276 * the most part just reinvented.
278 * Murmur 2 contains an inner loop such as:
291 * The two u32s that form the key are the same value x (pulled from data)
292 * this premix stage will perform the same results for both values. Unrolled
293 * this produces just:
303 * This appears to be fine, except what happens when m == 1? well x
304 * cancels out entierly, leaving just:
309 * So all keys hash to the same value, but how often does m == 1?
310 * well, it turns out testing x for all possible values yeilds only
311 * 172,013,942 unique results instead of 2^32. So nearly ~4.6 bits
312 * are cancelled out on average!
314 * This means we have a 14.5% (rounded) chance of colliding more, which
315 * results in another bucket/chain for the hashtable.
317 * We fix it buy upgrading the pre and post mix ssystems to align with murmur
321 #define GMQCC_ROTL32(X, R) (((X) << (R)) | ((X) >> (32 - (R))))
322 GMQCC_INLINE size_t util_hthash(hash_table_t *ht, const char *key) {
323 const unsigned char *data = (const unsigned char *)key;
324 const size_t len = strlen(key);
325 const size_t block = len / 4;
326 const uint32_t mask1 = 0xCC9E2D51;
327 const uint32_t mask2 = 0x1B873593;
328 const uint32_t *blocks = (const uint32_t*)(data + block * 4);
329 const unsigned char *tail = (const unsigned char *)(data + block * 4);
333 uint32_t h = 0x1EF0 ^ len;
335 for (i = -block; i; i++) {
338 k = GMQCC_ROTL32(k, 15);
341 h = GMQCC_ROTL32(h, 13);
342 h = h * 5 + 0xE6546B64;
354 k = GMQCC_ROTL32(k, 15);
366 return (size_t) (h % ht->size);
370 /* We keep the old for reference */
371 GMQCC_INLINE size_t util_hthash(hash_table_t *ht, const char *key) {
372 const uint32_t mix = 0x5BD1E995;
373 const uint32_t rot = 24;
374 size_t size = strlen(key);
375 uint32_t hash = 0x1EF0 /* LICRC TAB */ ^ size;
377 const unsigned char *data = (const unsigned char*)key;
380 alias = (data[0] | (data[1] << 8) | (data[2] << 16) | (data[3] << 24));
382 alias ^= alias >> rot;
393 case 3: hash ^= data[2] << 16;
394 case 2: hash ^= data[1] << 8;
395 case 1: hash ^= data[0];
403 return (size_t) (hash % ht->size);
407 static hash_node_t *_util_htnewpair(const char *key, void *value) {
409 if (!(node = (hash_node_t*)mem_a(sizeof(hash_node_t))))
412 if (!(node->key = util_strdupe(key))) {
424 * EXPOSED INTERFACE for the hashtable implementation
425 * util_htnew(size) -- to make a new hashtable
426 * util_htset(table, key, value, sizeof(value)) -- to set something in the table
427 * util_htget(table, key) -- to get something from the table
428 * util_htdel(table) -- to delete the table
430 hash_table_t *util_htnew(size_t size) {
431 hash_table_t *hashtable = NULL;
432 stat_size_entry_t *find = NULL;
437 if (!stat_size_hashtables)
438 stat_size_hashtables = stat_size_new();
440 if (!(hashtable = (hash_table_t*)mem_a(sizeof(hash_table_t))))
443 if (!(hashtable->table = (hash_node_t**)mem_a(sizeof(hash_node_t*) * size))) {
448 if ((find = stat_size_get(stat_size_hashtables, size)))
451 stat_type_hashtables++;
452 stat_size_put(stat_size_hashtables, size, 1);
455 hashtable->size = size;
456 memset(hashtable->table, 0, sizeof(hash_node_t*) * size);
458 stat_used_hashtables++;
462 void util_htseth(hash_table_t *ht, const char *key, size_t bin, void *value) {
463 hash_node_t *newnode = NULL;
464 hash_node_t *next = NULL;
465 hash_node_t *last = NULL;
467 next = ht->table[bin];
469 while (next && next->key && strcmp(key, next->key) > 0)
470 last = next, next = next->next;
472 /* already in table, do a replace */
473 if (next && next->key && strcmp(key, next->key) == 0) {
476 /* not found, grow a pair man :P */
477 newnode = _util_htnewpair(key, value);
478 if (next == ht->table[bin]) {
479 newnode->next = next;
480 ht->table[bin] = newnode;
482 last->next = newnode;
484 newnode->next = next;
485 last->next = newnode;
490 void util_htset(hash_table_t *ht, const char *key, void *value) {
491 util_htseth(ht, key, util_hthash(ht, key), value);
494 void *util_htgeth(hash_table_t *ht, const char *key, size_t bin) {
495 hash_node_t *pair = ht->table[bin];
497 while (pair && pair->key && strcmp(key, pair->key) > 0)
500 if (!pair || !pair->key || strcmp(key, pair->key) != 0)
506 void *util_htget(hash_table_t *ht, const char *key) {
507 return util_htgeth(ht, key, util_hthash(ht, key));
510 void *code_util_str_htgeth(hash_table_t *ht, const char *key, size_t bin) {
515 keylen = strlen(key);
517 pair = ht->table[bin];
518 while (pair && pair->key) {
519 len = strlen(pair->key);
525 cmp = strcmp(key, pair->key);
533 cmp = strcmp(key, pair->key + len - keylen);
535 uintptr_t up = (uintptr_t)pair->value;
545 * Free all allocated data in a hashtable, this is quite the amount
548 void util_htrem(hash_table_t *ht, void (*callback)(void *data)) {
551 for (; i < ht->size; ++i) {
552 hash_node_t *n = ht->table[i];
572 void util_htrmh(hash_table_t *ht, const char *key, size_t bin, void (*cb)(void*)) {
573 hash_node_t **pair = &ht->table[bin];
576 while (*pair && (*pair)->key && strcmp(key, (*pair)->key) > 0)
577 pair = &(*pair)->next;
580 if (!tmp || !tmp->key || strcmp(key, tmp->key) != 0)
591 void util_htrm(hash_table_t *ht, const char *key, void (*cb)(void*)) {
592 util_htrmh(ht, key, util_hthash(ht, key), cb);
595 void util_htdel(hash_table_t *ht) {
596 util_htrem(ht, NULL);
600 * The following functions below implement printing / dumping of statistical
603 static void stat_dump_mem_contents(stat_mem_block_t *memory, uint16_t cols) {
605 for (i = 0; i < memory->size + ((memory->size % cols) ? (cols - memory->size % cols) : 0); i++) {
606 if (i % cols == 0) con_out(" 0x%06X: ", i);
607 if (i < memory->size) con_out("%02X " , 0xFF & ((unsigned char*)(memory + 1))[i]);
610 if ((uint16_t)(i % cols) == (cols - 1)) {
611 for (j = i - (cols - 1); j <= i; j++) {
615 : (util_isprint(((unsigned char*)(memory + 1))[j]))
616 ? 0xFF & ((unsigned char*)(memory + 1)) [j]
625 static void stat_dump_mem_leaks(void) {
626 stat_mem_block_t *info;
627 for (info = stat_mem_block_root; info; info = info->next) {
628 con_out("lost: %u (bytes) at %s:%u\n",
634 stat_dump_mem_contents(info, OPTS_OPTION_U16(OPTION_MEMDUMPCOLS));
638 static void stat_dump_mem_info(void) {
639 con_out("Memory Information:\n\
640 Total allocations: %llu\n\
641 Total deallocations: %llu\n\
642 Total allocated: %f (MB)\n\
643 Total deallocated: %f (MB)\n\
644 Total peak memory: %f (MB)\n\
645 Total leaked memory: %f (MB) in %llu allocations\n",
646 stat_mem_allocated_total,
647 stat_mem_deallocated_total,
648 (float)(stat_mem_allocated) / 1048576.0f,
649 (float)(stat_mem_deallocated) / 1048576.0f,
650 (float)(stat_mem_peak) / 1048576.0f,
651 (float)(stat_mem_allocated - stat_mem_deallocated) / 1048576.0f,
652 stat_mem_allocated_total - stat_mem_deallocated_total
656 static void stat_dump_stats_table(stat_size_table_t table, const char *string, uint64_t *size) {
662 for (i = 0, j = 1; i < ST_SIZE; i++) {
663 stat_size_entry_t *entry;
665 if (!(entry = table[i]))
668 con_out(string, (unsigned)j, (unsigned)entry->key, (unsigned)entry->value);
672 *size += entry->key * entry->value;
677 if (OPTS_OPTION_BOOL(OPTION_MEMCHK) ||
678 OPTS_OPTION_BOOL(OPTION_STATISTICS)) {
681 con_out("Memory Statistics:\n\
682 Total vectors allocated: %llu\n\
683 Total string duplicates: %llu\n\
684 Total hashtables allocated: %llu\n\
685 Total unique vector sizes: %llu\n",
688 stat_used_hashtables,
692 stat_dump_stats_table (
694 " %2u| # of %5u byte vectors: %u\n",
699 " Total unique hashtable sizes: %llu\n",
703 stat_dump_stats_table (
704 stat_size_hashtables,
705 " %2u| # of %5u element hashtables: %u\n",
710 " Total vector memory: %f (MB)\n\n",
711 (float)(mem) / 1048576.0f
715 if (stat_size_vectors)
716 stat_size_del(stat_size_vectors);
717 if (stat_size_hashtables)
718 stat_size_del(stat_size_hashtables);
720 if (OPTS_OPTION_BOOL(OPTION_DEBUG) ||
721 OPTS_OPTION_BOOL(OPTION_MEMCHK))
722 stat_dump_mem_info();
724 if (OPTS_OPTION_BOOL(OPTION_DEBUG))
725 stat_dump_mem_leaks();