]> git.xonotic.org Git - xonotic/gmqcc.git/blobdiff - stat.c
Fix a sizeof bug
[xonotic/gmqcc.git] / stat.c
diff --git a/stat.c b/stat.c
index 5c1a6f486e2dfb2a9cdcb598da30e14638e41207..287ec0bf583721cd4e2a980d385ded02180963bd 100644 (file)
--- a/stat.c
+++ b/stat.c
@@ -1,3 +1,30 @@
+/*
+ * Copyright (C) 2012, 2013
+ *     Dale Weiler
+ *     Wolfgang Bumiller
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+ * of the Software, and to permit persons to whom the Software is furnished to do
+ * so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include <string.h>
+#include <stdlib.h>
+
 #include "gmqcc.h"
 
 /*
@@ -17,6 +44,11 @@ typedef struct stat_mem_block_s {
     struct stat_mem_block_s *prev;
 } stat_mem_block_t;
 
+typedef struct {
+    size_t key;
+    size_t value;
+} stat_size_entry_t, **stat_size_table_t;
+
 static uint64_t          stat_mem_allocated         = 0;
 static uint64_t          stat_mem_deallocated       = 0;
 static uint64_t          stat_mem_allocated_total   = 0;
@@ -32,6 +64,39 @@ static stat_size_table_t stat_size_vectors          = NULL;
 static stat_size_table_t stat_size_hashtables       = NULL;
 static stat_mem_block_t *stat_mem_block_root        = NULL;
 
+/*
+ * A tiny size_t key-value hashtbale for tracking vector and hashtable
+ * sizes. We can use it for other things too, if we need to. This is
+ * very TIGHT, and efficent in terms of space though.
+ */
+static stat_size_table_t stat_size_new(void) {
+    return (stat_size_table_t)memset(
+        mem_a(sizeof(stat_size_entry_t*) * ST_SIZE),
+        0, ST_SIZE * sizeof(stat_size_entry_t*)
+    );
+}
+
+static void stat_size_del(stat_size_table_t table) {
+    size_t i = 0;
+    for (; i < ST_SIZE; i++) if(table[i]) mem_d(table[i]);
+    mem_d(table);
+}
+
+static stat_size_entry_t *stat_size_get(stat_size_table_t table, size_t key) {
+    size_t hash = (key % ST_SIZE);
+    while (table[hash] && table[hash]->key != key)
+        hash = (hash + 1) % ST_SIZE;
+    return table[hash];
+}
+static void stat_size_put(stat_size_table_t table, size_t key, size_t value) {
+    size_t hash = (key % ST_SIZE);
+    while (table[hash] && table[hash]->key != key)
+        hash = (hash + 1) % ST_SIZE;
+    table[hash]        = (stat_size_entry_t*)mem_a(sizeof(stat_size_entry_t));
+    table[hash]->key   = key;
+    table[hash]->value = value;
+}
+
 /*
  * A basic header of information wrapper allocator. Simply stores
  * information as a header, returns the memory + 1 past it, can be
@@ -40,24 +105,24 @@ static stat_mem_block_t *stat_mem_block_root        = NULL;
 void *stat_mem_allocate(size_t size, size_t line, const char *file) {
     stat_mem_block_t *info = (stat_mem_block_t*)malloc(sizeof(stat_mem_block_t) + size);
     void             *data = (void*)(info + 1);
-    
+
     if(!info)
         return NULL;
-        
+
     info->line = line;
     info->size = size;
     info->file = file;
     info->prev = NULL;
     info->next = stat_mem_block_root;
-    
+
     if (stat_mem_block_root)
         stat_mem_block_root->prev = info;
-        
+
     stat_mem_block_root       = info;
     stat_mem_allocated       += size;
     stat_mem_high            += size;
     stat_mem_allocated_total ++;
-    
+
     if (stat_mem_high > stat_mem_peak)
         stat_mem_peak = stat_mem_high;
 
@@ -66,76 +131,76 @@ void *stat_mem_allocate(size_t size, size_t line, const char *file) {
 
 void stat_mem_deallocate(void *ptr) {
     stat_mem_block_t *info = NULL;
-    
+
     if (!ptr)
         return;
-        
+
     info = ((stat_mem_block_t*)ptr - 1);
-    
+
     stat_mem_deallocated       += info->size;
     stat_mem_high              -= info->size;
     stat_mem_deallocated_total ++;
-    
+
     if (info->prev) info->prev->next = info->next;
     if (info->next) info->next->prev = info->prev;
-    
+
     /* move ahead */
     if (info == stat_mem_block_root)
         stat_mem_block_root = info->next;
-        
+
     free(info);
 }
 
 void *stat_mem_reallocate(void *ptr, size_t size, size_t line, const char *file) {
     stat_mem_block_t *oldinfo = NULL;
     stat_mem_block_t *newinfo;
-    
+
     if (!ptr)
         return stat_mem_allocate(size, line, file);
-    
+
     /* stay consistent with glic */
     if (!size) {
         stat_mem_deallocate(ptr);
         return NULL;
     }
-    
+
     oldinfo = ((stat_mem_block_t*)ptr - 1);
     newinfo = ((stat_mem_block_t*)malloc(sizeof(stat_mem_block_t) + size));
-    
+
     if (!newinfo) {
         stat_mem_deallocate(ptr);
         return NULL;
     }
-    
+
     memcpy(newinfo+1, oldinfo+1, oldinfo->size);
-    
+
     if (oldinfo->prev) oldinfo->prev->next = oldinfo->next;
     if (oldinfo->next) oldinfo->next->prev = oldinfo->prev;
-    
+
     /* move ahead */
     if (oldinfo == stat_mem_block_root)
         stat_mem_block_root = oldinfo->next;
-        
+
     newinfo->line = line;
     newinfo->size = size;
     newinfo->file = file;
     newinfo->prev = NULL;
     newinfo->next = stat_mem_block_root;
-    
+
     if (stat_mem_block_root)
         stat_mem_block_root->prev = newinfo;
-    
+
     stat_mem_block_root = newinfo;
     stat_mem_allocated -= oldinfo->size;
     stat_mem_high      -= oldinfo->size;
     stat_mem_allocated += newinfo->size;
     stat_mem_high      += newinfo->size;
-    
+
     if (stat_mem_high > stat_mem_peak)
         stat_mem_peak = stat_mem_high;
-        
+
     free(oldinfo);
-    
+
     return newinfo + 1;
 }
 
@@ -147,16 +212,16 @@ void *stat_mem_reallocate(void *ptr, size_t size, size_t line, const char *file)
 char *stat_mem_strdup(const char *src, size_t line, const char *file, bool empty) {
     size_t len = 0;
     char  *ptr = NULL;
-    
+
     if (!src)
         return NULL;
-    
+
     len = strlen(src);
     if (((!empty) ? len : true) && (ptr = (char*)stat_mem_allocate(len + 1, line, file))) {
         memcpy(ptr, src, len);
         ptr[len] = '\0';
     }
-    
+
     stat_used_strdups ++;
     return ptr;
 }
@@ -169,7 +234,7 @@ void _util_vec_grow(void **a, size_t i, size_t s) {
     size_t             m = 0;
     stat_size_entry_t *e = NULL;
     void              *p = NULL;
-    
+
     if (*a) {
         m = 2 * d->allocated + i;
         p = mem_r(d, s * m + sizeof(vector_t));
@@ -179,7 +244,7 @@ void _util_vec_grow(void **a, size_t i, size_t s) {
         ((vector_t*)p)->used = 0;
         stat_used_vectors++;
     }
-    
+
     if (!stat_size_vectors)
         stat_size_vectors = stat_size_new();
 
@@ -205,6 +270,104 @@ typedef struct hash_node_t {
     struct hash_node_t *next;  /* next node (linked list)        */
 } hash_node_t;
 
+/*
+ * This is a patched version of the Murmur2 hashing function to use
+ * a proper pre-mix and post-mix setup. Infact this is Murmur3 for
+ * the most part just reinvented.
+ * 
+ * Murmur 2 contains an inner loop such as:
+ * while (l >= 4) {
+ *      u32 k = *(u32*)d;
+ *      k *= m;
+ *      k ^= k >> r;
+ *      k *= m;
+ * 
+ *      h *= m;
+ *      h ^= k;
+ *      d += 4;
+ *      l -= 4;
+ * }
+ * 
+ * The two u32s that form the key are the same value x (pulled from data)
+ * this premix stage will perform the same results for both values. Unrolled
+ * this produces just:
+ *  x *= m;
+ *  x ^= x >> r;
+ *  x *= m;
+ *
+ *  h *= m;
+ *  h ^= x;
+ *  h *= m;
+ *  h ^= x;
+ * 
+ * This appears to be fine, except what happens when m == 1? well x
+ * cancels out entierly, leaving just:
+ *  x ^= x >> r;
+ *  h ^= x;
+ *  h ^= x;
+ * 
+ * So all keys hash to the same value, but how often does m == 1?
+ * well, it turns out testing x for all possible values yeilds only
+ * 172,013,942 unique results instead of 2^32. So nearly ~4.6 bits
+ * are cancelled out on average!
+ * 
+ * This means we have a 14.5% (rounded) chance of colliding more, which
+ * results in another bucket/chain for the hashtable.
+ *
+ * We fix it buy upgrading the pre and post mix ssystems to align with murmur
+ * hash 3.
+ */
+#if 1
+#define GMQCC_ROTL32(X, R) (((X) << (R)) | ((X) >> (32 - (R))))
+GMQCC_INLINE size_t util_hthash(hash_table_t *ht, const char *key) {
+    const unsigned char *data   = (const unsigned char *)key;
+    const size_t         len    = strlen(key);
+    const size_t         block  = len / 4;
+    const uint32_t       mask1  = 0xCC9E2D51;
+    const uint32_t       mask2  = 0x1B873593;
+    const uint32_t      *blocks = (const uint32_t*)(data + block * 4);
+    const unsigned char *tail   = (const unsigned char *)(data + block * 4);
+
+    size_t   i;
+    uint32_t k;
+    uint32_t h = 0x1EF0 ^ len;
+
+    for (i = -block; i; i++) {
+        k  = blocks[i];
+        k *= mask1;
+        k  = GMQCC_ROTL32(k, 15);
+        k *= mask2;
+        h ^= k;
+        h  = GMQCC_ROTL32(h, 13);
+        h  = h * 5 + 0xE6546B64;
+    }
+
+    k = 0;
+    switch (len & 3) {
+        case 3:
+            k ^= tail[2] << 16;
+        case 2:
+            k ^= tail[1] << 8;
+        case 1:
+            k ^= tail[0];
+            k *= mask1;
+            k  = GMQCC_ROTL32(k, 15);
+            k *= mask2;
+            h ^= k;
+    }
+
+    h ^= len;
+    h ^= h >> 16;
+    h *= 0x85EBCA6B;
+    h ^= h >> 13;
+    h *= 0xC2B2AE35;
+    h ^= h >> 16;
+
+    return (size_t) (h % ht->size);
+}
+#undef GMQCC_ROTL32
+#else
+/* We keep the old for reference */
 GMQCC_INLINE size_t util_hthash(hash_table_t *ht, const char *key) {
     const uint32_t       mix   = 0x5BD1E995;
     const uint32_t       rot   = 24;
@@ -239,6 +402,7 @@ GMQCC_INLINE size_t util_hthash(hash_table_t *ht, const char *key) {
 
     return (size_t) (hash % ht->size);
 }
+#endif
 
 static hash_node_t *_util_htnewpair(const char *key, void *value) {
     hash_node_t *node;
@@ -266,10 +430,10 @@ static hash_node_t *_util_htnewpair(const char *key, void *value) {
 hash_table_t *util_htnew(size_t size) {
     hash_table_t      *hashtable = NULL;
     stat_size_entry_t *find      = NULL;
-    
+
     if (size < 1)
         return NULL;
-        
+
     if (!stat_size_hashtables)
         stat_size_hashtables = stat_size_new();
 
@@ -280,18 +444,18 @@ hash_table_t *util_htnew(size_t size) {
         mem_d(hashtable);
         return NULL;
     }
-    
+
     if ((find = stat_size_get(stat_size_hashtables, size)))
         find->value++;
     else {
-        stat_used_hashtables++;
+        stat_type_hashtables++;
         stat_size_put(stat_size_hashtables, size, 1);
     }
 
     hashtable->size = size;
     memset(hashtable->table, 0, sizeof(hash_node_t*) * size);
 
-    stat_type_hashtables++;
+    stat_used_hashtables++;
     return hashtable;
 }
 
@@ -383,7 +547,8 @@ void *code_util_str_htgeth(hash_table_t *ht, const char *key, size_t bin) {
  */
 void util_htrem(hash_table_t *ht, void (*callback)(void *data)) {
     size_t i = 0;
-    for (; i < ht->size; i++) {
+
+    for (; i < ht->size; ++i) {
         hash_node_t *n = ht->table[i];
         hash_node_t *p;
 
@@ -394,7 +559,7 @@ void util_htrem(hash_table_t *ht, void (*callback)(void *data)) {
             if (callback)
                 callback(n->value);
             p = n;
-            n = n->next;
+            n = p->next;
             mem_d(p);
         }
 
@@ -431,39 +596,6 @@ void util_htdel(hash_table_t *ht) {
     util_htrem(ht, NULL);
 }
 
-/*
- * A tiny size_t key-value hashtbale for tracking vector and hashtable
- * sizes. We can use it for other things too, if we need to. This is
- * very TIGHT, and efficent in terms of space though.
- */
-stat_size_table_t stat_size_new() {
-    return (stat_size_table_t)memset(
-        mem_a(sizeof(stat_size_entry_t*) * ST_SIZE),
-        0, ST_SIZE * sizeof(stat_size_entry_t*)
-    );
-}
-
-void stat_size_del(stat_size_table_t table) {
-    size_t i = 0;
-    for (; i < ST_SIZE; i++) if(table[i]) mem_d(table[i]);
-    mem_d(table);
-}
-
-stat_size_entry_t *stat_size_get(stat_size_table_t table, size_t key) {
-    size_t hash = (key % ST_SIZE);
-    while (table[hash] && table[hash]->key != key)
-        hash = (hash + 1) % ST_SIZE;
-    return table[hash];
-}
-void stat_size_put(stat_size_table_t table, size_t key, size_t value) {
-    size_t hash = (key % ST_SIZE);
-    while (table[hash] && table[hash]->key != key)
-        hash = (hash + 1) % ST_SIZE;
-    table[hash] = (stat_size_entry_t*)mem_a(sizeof(stat_size_entry_t));
-    table[hash]->key = key;
-    table[hash]->value = value;
-}
-
 /*
  * The following functions below implement printing / dumping of statistical
  * information.
@@ -480,7 +612,7 @@ static void stat_dump_mem_contents(stat_mem_block_t *memory, uint16_t cols) {
                 con_out("%c",
                     (j >= memory->size)
                         ? ' '
-                        : (isprint(((unsigned char*)(memory + 1))[j]))
+                        : (util_isprint(((unsigned char*)(memory + 1))[j]))
                             ? 0xFF & ((unsigned char*)(memory + 1)) [j]
                             : '.'
                 );
@@ -490,7 +622,7 @@ static void stat_dump_mem_contents(stat_mem_block_t *memory, uint16_t cols) {
     }
 }
 
-static void stat_dump_mem_leaks() {
+static void stat_dump_mem_leaks(void) {
     stat_mem_block_t *info;
     for (info = stat_mem_block_root; info; info = info->next) {
         con_out("lost: %u (bytes) at %s:%u\n",
@@ -498,13 +630,13 @@ static void stat_dump_mem_leaks() {
             info->file,
             info->line
         );
-        
+
         stat_dump_mem_contents(info, OPTS_OPTION_U16(OPTION_MEMDUMPCOLS));
     }
 }
 
-static void stat_dump_mem_info() {
-    con_out("Memory information:\n\
+static void stat_dump_mem_info(void) {
+    con_out("Memory Information:\n\
     Total allocations:   %llu\n\
     Total deallocations: %llu\n\
     Total allocated:     %f (MB)\n\
@@ -515,7 +647,7 @@ static void stat_dump_mem_info() {
         stat_mem_deallocated_total,
         (float)(stat_mem_allocated)                        / 1048576.0f,
         (float)(stat_mem_deallocated)                      / 1048576.0f,
-        (float)(stat_mem_high)                             / 1048576.0f,
+        (float)(stat_mem_peak)                             / 1048576.0f,
         (float)(stat_mem_allocated - stat_mem_deallocated) / 1048576.0f,
         stat_mem_allocated_total - stat_mem_deallocated_total
     );
@@ -523,8 +655,11 @@ static void stat_dump_mem_info() {
 
 static void stat_dump_stats_table(stat_size_table_t table, const char *string, uint64_t *size) {
     size_t i,j;
-    
-    for (i = 0, j = 0; i < ST_SIZE; i++) {
+
+    if (!table)
+        return;
+
+    for (i = 0, j = 1; i < ST_SIZE; i++) {
         stat_size_entry_t *entry;
 
         if (!(entry = table[i]))
@@ -532,25 +667,18 @@ static void stat_dump_stats_table(stat_size_table_t table, const char *string, u
 
         con_out(string, (unsigned)j, (unsigned)entry->key, (unsigned)entry->value);
         j++;
-        
+
         if (size)
             *size += entry->key * entry->value;
     }
 }
 
 void stat_info() {
-    if (OPTS_OPTION_BOOL(OPTION_DEBUG))
-        stat_dump_mem_leaks();
-
-    if (OPTS_OPTION_BOOL(OPTION_DEBUG) ||
-        OPTS_OPTION_BOOL(OPTION_MEMCHK))
-        stat_dump_mem_info();
-
     if (OPTS_OPTION_BOOL(OPTION_MEMCHK) ||
         OPTS_OPTION_BOOL(OPTION_STATISTICS)) {
-        uint64_t mem;
-        
-        con_out("\nAdditional Statistics:\n\
+        uint64_t mem = 0;
+
+        con_out("Memory Statistics:\n\
     Total vectors allocated:    %llu\n\
     Total string duplicates:    %llu\n\
     Total hashtables allocated: %llu\n\
@@ -560,26 +688,26 @@ void stat_info() {
             stat_used_hashtables,
             stat_type_vectors
         );
-        
+
         stat_dump_stats_table (
             stat_size_vectors,
-            "        %2u| # of %4u byte vectors: %u\n",
+            "        %2u| # of %5u byte vectors: %u\n",
             &mem
         );
-        
+
         con_out (
             "    Total unique hashtable sizes: %llu\n",
             stat_type_hashtables
         );
-        
+
         stat_dump_stats_table (
             stat_size_hashtables,
-            "        %2u| # of %4u element hashtables: %u\n",
+            "        %2u| # of %5u element hashtables: %u\n",
             NULL
         );
-        
+
         con_out (
-            "    Total vector memory:          %f (MB)\n",
+            "    Total vector memory:          %f (MB)\n\n",
             (float)(mem) / 1048576.0f
         );
     }
@@ -588,5 +716,12 @@ void stat_info() {
         stat_size_del(stat_size_vectors);
     if (stat_size_hashtables)
         stat_size_del(stat_size_hashtables);
+
+    if (OPTS_OPTION_BOOL(OPTION_DEBUG) ||
+        OPTS_OPTION_BOOL(OPTION_MEMCHK))
+        stat_dump_mem_info();
+
+    if (OPTS_OPTION_BOOL(OPTION_DEBUG))
+        stat_dump_mem_leaks();
 }
 #undef ST_SIZE