gallium: Simple and efficient cache.

Fixed size hash table. Collisions are handled by simply destroying the
previous entry.

It hasn't received much testing yet.

6 files changed, 476 insertions, 0 deletions

diff --git a/src/gallium/auxiliary/util/Makefile b/src/gallium/auxiliary/util/Makefile
index d3951e4e7d7..5c227c1eb54 100644
--- a/src/gallium/auxiliary/util/Makefile
+++ b/src/gallium/auxiliary/util/Makefile
@@ -6,10 +6,12 @@ LIBNAME = util
 C_SOURCES = \
 	p_debug.c \
 	u_blit.c \
+	u_cache.c \
 	u_draw_quad.c \
 	u_gen_mipmap.c \
 	u_handle_table.c \
 	u_hash_table.c \
+	u_hash.c \
 	u_math.c \
 	u_mm.c \
 	u_rect.c \
diff --git a/src/gallium/auxiliary/util/SConscript b/src/gallium/auxiliary/util/SConscript
index e65c17b1cc8..1ef06631bf3 100644
--- a/src/gallium/auxiliary/util/SConscript
+++ b/src/gallium/auxiliary/util/SConscript
@@ -7,9 +7,11 @@ util = env.ConvenienceLibrary(
 		'p_debug_mem.c',
 		'p_debug_prof.c',
 		'u_blit.c',
+		'u_cache.c',
 		'u_draw_quad.c',
 		'u_gen_mipmap.c',
 		'u_handle_table.c',
+		'u_hash.c',
 		'u_hash_table.c',
 		'u_math.c',
 		'u_mm.c',
diff --git a/src/gallium/auxiliary/util/u_cache.c b/src/gallium/auxiliary/util/u_cache.c
new file mode 100644
index 00000000000..69a52687fbc
--- /dev/null
+++ b/src/gallium/auxiliary/util/u_cache.c
@@ -0,0 +1,209 @@
+/**************************************************************************
+ *
+ * Copyright 2008 VMware, Inc.
+ * All Rights Reserved.
+ *
+ * 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, sub license, 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 (including the
+ * next paragraph) 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 NON-INFRINGEMENT.
+ * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS 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.
+ *
+ **************************************************************************/
+
+/**
+ * @file
+ * Simple cache implementation.
+ *
+ * We simply have fixed size array, and destroy previous values on collision. 
+ * 
+ * @author Jose Fonseca <[email protected]>
+ */
+
+
+#include "pipe/p_compiler.h"
+#include "pipe/p_debug.h"
+
+#include "util/u_math.h"
+#include "util/u_memory.h"
+#include "util/u_cache.h"
+
+
+struct util_cache_entry
+{
+   void *key;
+   void *value;
+   
+#ifdef DEBUG
+   unsigned count;
+#endif
+};
+
+
+struct util_cache
+{
+   /** Hash function */
+   uint32_t (*hash)(void *key);
+   
+   /** Compare two keys */
+   int (*compare)(void *key1, void *key2);
+
+   /** Destroy a (key, value) pair */
+   void (*destroy)(void *key, void *value);
+
+   uint32_t size;
+   
+   struct util_cache_entry *entries;
+   
+#ifdef DEBUG
+   unsigned count;
+#endif
+};
+
+
+struct util_cache *
+util_cache_create(uint32_t (*hash)(void *key),
+                int (*compare)(void *key1, void *key2),
+                void (*destroy)(void *key, void *value),
+                uint32_t size)
+{
+   struct util_cache *cache;
+   
+   cache = CALLOC_STRUCT(util_cache);
+   if(!cache)
+      return NULL;
+   
+   cache->hash = hash;
+   cache->compare = compare;
+   cache->destroy = destroy;
+   cache->size = size;
+   
+   cache->entries = CALLOC(size, sizeof(struct util_cache_entry));
+   if(!cache->entries) {
+      FREE(cache);
+      return NULL;
+   }
+   
+   return cache;
+}
+
+
+static INLINE struct util_cache_entry *
+util_cache_entry_get(struct util_cache *cache,
+                     void *key)
+{
+   uint32_t hash;
+   
+   hash = cache->hash(key);
+
+   return &cache->entries[hash % cache->size];
+}
+
+static INLINE void
+util_cache_entry_destroy(struct util_cache *cache,
+                         struct util_cache_entry *entry)
+{
+   void *key = entry->key;
+   void *value = entry->value;
+   
+   entry->key = NULL;
+   entry->value = NULL;
+   
+   if(key || value)
+      if(cache->destroy)
+         cache->destroy(key, value);
+}
+
+
+void
+util_cache_set(struct util_cache *cache,
+               void *key,
+               void *value)
+{
+   struct util_cache_entry *entry;
+
+   assert(cache);
+
+   entry = util_cache_entry_get(cache, key);
+   util_cache_entry_destroy(cache, entry);
+   
+#ifdef DEBUG
+   ++entry->count;
+   ++cache->count;
+#endif
+   
+   entry->key = key;
+   entry->value = value;
+}
+
+
+void *
+util_cache_get(struct util_cache *cache, 
+               void *key)
+{
+   struct util_cache_entry *entry;
+
+   assert(cache);
+
+   entry = util_cache_entry_get(cache, key);
+   if(!entry->key && !entry->value)
+      return NULL;
+   
+   if(cache->compare(key, entry->key) != 0)
+      return NULL;
+   
+   return entry->value;
+}
+
+
+void 
+util_cache_clear(struct util_cache *cache)
+{
+   uint32_t i;
+
+   assert(cache);
+   
+   for(i = 0; i < cache->size; ++i)
+      util_cache_entry_destroy(cache, &cache->entries[i]);
+}
+
+
+void
+util_cache_destroy(struct util_cache *cache)
+{
+   assert(cache);
+
+#ifdef DEBUG
+   if(cache->count >= 20*cache->size) {
+      /* Normal approximation of the Poisson distribution */
+      double mean = (double)cache->count/(double)cache->size;
+      double stddev = sqrt(mean);
+      unsigned i;
+      for(i = 0; i < cache->size; ++i) {
+         double z = fabs(cache->count - mean)/stddev;
+         /* This assert should not fail 99.9999998027% of the times, unless 
+          * the hash function is a poor one */
+         assert(z <= 6.0);
+      }
+   }
+#endif
+      
+   util_cache_clear(cache);
+   
+   FREE(cache->entries);
+   FREE(cache);
+}
diff --git a/src/gallium/auxiliary/util/u_cache.h b/src/gallium/auxiliary/util/u_cache.h
new file mode 100644
index 00000000000..835e0837349
--- /dev/null
+++ b/src/gallium/auxiliary/util/u_cache.h
@@ -0,0 +1,87 @@
+/**************************************************************************
+ *
+ * Copyright 2008 VMware, Inc.
+ * All Rights Reserved.
+ *
+ * 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, sub license, 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 (including the
+ * next paragraph) 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 NON-INFRINGEMENT.
+ * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS 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.
+ *
+ **************************************************************************/
+
+/**
+ * @file
+ * Simple cache.
+ *
+ * @author Jose Fonseca <[email protected]>
+ */
+
+#ifndef U_CACHE_H_
+#define U_CACHE_H_
+
+
+#include "pipe/p_compiler.h"
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+   
+/**
+ * Least Recently Used (LRU) cache.
+ */
+struct util_cache;
+
+
+/**
+ * Create a cache.
+ * 
+ * @param hash hash function
+ * @param compare should return 0 for two equal keys
+ * @param destroy destruction callback (optional)
+ * @param size maximum number of entries
+ */
+struct util_cache *
+util_cache_create(uint32_t (*hash)(void *key),
+                int (*compare)(void *key1, void *key2),
+                void (*destroy)(void *key, void *value),
+                uint32_t size);
+
+void
+util_cache_set(struct util_cache *cache,
+             void *key,
+             void *value);
+
+void *
+util_cache_get(struct util_cache *cache, 
+             void *key);
+
+void
+util_cache_clear(struct util_cache *cache);
+
+void
+util_cache_destroy(struct util_cache *cache);
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* U_CACHE_H_ */
diff --git a/src/gallium/auxiliary/util/u_hash.c b/src/gallium/auxiliary/util/u_hash.c
new file mode 100644
index 00000000000..508a31f2cbd
--- /dev/null
+++ b/src/gallium/auxiliary/util/u_hash.c
@@ -0,0 +1,121 @@
+/**************************************************************************
+ *
+ * Copyright 2008 VMware, Inc.
+ * All Rights Reserved.
+ *
+ * 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, sub license, 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 (including the
+ * next paragraph) 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 NON-INFRINGEMENT.
+ * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS 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.
+ *
+ **************************************************************************/
+
+/**
+ * @file
+ * Hash functions implementation.
+ * 
+ * @author Jose Fonseca
+ */
+
+
+#include "u_hash.h"
+
+
+static uint32_t 
+util_crc32_table[256] = {
+   0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 
+   0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3, 
+   0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988, 
+   0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 
+   0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, 
+   0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 
+   0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 
+   0x14015c4f, 0x63066cd9, 0xfa0f3d63, 0x8d080df5, 
+   0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172, 
+   0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 
+   0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 
+   0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 
+   0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 
+   0x21b4f4b5, 0x56b3c423, 0xcfba9599, 0xb8bda50f, 
+   0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, 
+   0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 
+   0x76dc4190, 0x01db7106, 0x98d220bc, 0xefd5102a, 
+   0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433, 
+   0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 
+   0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01, 
+   0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 
+   0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 
+   0x65b0d9c6, 0x12b7e950, 0x8bbeb8ea, 0xfcb9887c, 
+   0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65, 
+   0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 
+   0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 
+   0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0, 
+   0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 
+   0x5005713c, 0x270241aa, 0xbe0b1010, 0xc90c2086, 
+   0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, 
+   0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 
+   0x59b33d17, 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 
+   0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a, 
+   0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 
+   0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, 
+   0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 
+   0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 
+   0xf762575d, 0x806567cb, 0x196c3671, 0x6e6b06e7, 
+   0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc, 
+   0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 
+   0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 
+   0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 
+   0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 
+   0xdf60efc3, 0xa867df55, 0x316e8eef, 0x4669be79, 
+   0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, 
+   0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 
+   0xc5ba3bbe, 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 
+   0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d, 
+   0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 
+   0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713, 
+   0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 
+   0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 
+   0x86d3d2d4, 0xf1d4e242, 0x68ddb3f8, 0x1fda836e, 
+   0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777, 
+   0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 
+   0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 
+   0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 
+   0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 
+   0xaed16a4a, 0xd9d65adc, 0x40df0b66, 0x37d83bf0, 
+   0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9, 
+   0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 
+   0xbad03605, 0xcdd70693, 0x54de5729, 0x23d967bf, 
+   0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94, 
+   0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
+};
+
+
+/**
+ * @sa http://www.w3.org/TR/PNG/#D-CRCAppendix
+ */
+uint32_t
+util_hash_crc32(void *data, size_t size)
+{
+   uint8_t *p = (uint8_t *)data;
+   uint32_t crc = 0xffffffff;
+ 
+   while (size--)
+      crc = util_crc32_table[(crc ^ *p++) & 0xff] ^ (crc >> 8);
+   
+   return crc;
+}
diff --git a/src/gallium/auxiliary/util/u_hash.h b/src/gallium/auxiliary/util/u_hash.h
new file mode 100644
index 00000000000..76c3513e4a0
--- /dev/null
+++ b/src/gallium/auxiliary/util/u_hash.h
@@ -0,0 +1,55 @@
+/**************************************************************************
+ *
+ * Copyright 2008 VMware, Inc.
+ * All Rights Reserved.
+ *
+ * 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, sub license, 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 (including the
+ * next paragraph) 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 NON-INFRINGEMENT.
+ * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS 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.
+ *
+ **************************************************************************/
+
+/**
+ * @file
+ * Hash functions.
+ * 
+ * @author Jose Fonseca <[email protected]>
+ */
+
+#ifndef U_HASH_H_
+#define U_HASH_H_
+
+
+#include "pipe/p_compiler.h"
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+   
+uint32_t
+util_hash_crc32(void *data, size_t size);
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* U_HASH_H_ */