Added few more stubs so that control reaches to DestroyDevice().
[mesa.git] / src / mesa / main / hash.c
index 72d924dcc38ef222a4c9bea6ace6b5e99217446a..99249c4be18b4c6024018aef7bcb73bc243aa9fd 100644 (file)
@@ -12,7 +12,6 @@
 
 /*
  * Mesa 3-D graphics library
- * Version:  6.5.1
  *
  * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
  *
  * 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
- * BRIAN PAUL 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.
+ * 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 "errors.h"
 #include "glheader.h"
-#include "imports.h"
-#include "glapi/glthread.h"
 #include "hash.h"
-
-
-#define TABLE_SIZE 1023  /**< Size of lookup table/array */
-
-#define HASH_FUNC(K)  ((K) % TABLE_SIZE)
-
-
-/**
- * An entry in the hash table.  
- */
-struct HashEntry {
-   GLuint Key;             /**< the entry's key */
-   void *Data;             /**< the entry's data */
-   struct HashEntry *Next; /**< pointer to next entry */
-};
-
-
-/**
- * The hash table data structure.  
- */
-struct _mesa_HashTable {
-   struct HashEntry *Table[TABLE_SIZE];  /**< the lookup table */
-   GLuint MaxKey;                        /**< highest key inserted so far */
-   _glthread_Mutex Mutex;                /**< mutual exclusion lock */
-   _glthread_Mutex WalkMutex;            /**< for _mesa_HashWalk() */
-   GLboolean InDeleteAll;                /**< Debug check */
-};
-
+#include "util/hash_table.h"
+#include "util/u_memory.h"
 
 
 /**
@@ -78,10 +50,27 @@ struct _mesa_HashTable *
 _mesa_NewHashTable(void)
 {
    struct _mesa_HashTable *table = CALLOC_STRUCT(_mesa_HashTable);
+
    if (table) {
-      _glthread_INIT_MUTEX(table->Mutex);
-      _glthread_INIT_MUTEX(table->WalkMutex);
+      table->ht = _mesa_hash_table_create(NULL, uint_key_hash,
+                                          uint_key_compare);
+      if (table->ht == NULL) {
+         free(table);
+         _mesa_error_no_memory(__func__);
+         return NULL;
+      }
+
+      _mesa_hash_table_set_deleted_key(table->ht, uint_key(DELETED_KEY_VALUE));
+      /*
+       * Needs to be recursive, since the callback in _mesa_HashWalk()
+       * is allowed to call _mesa_HashRemove().
+       */
+      mtx_init(&table->Mutex, mtx_recursive);
+   }
+   else {
+      _mesa_error_no_memory(__func__);
    }
+
    return table;
 }
 
@@ -98,22 +87,15 @@ _mesa_NewHashTable(void)
 void
 _mesa_DeleteHashTable(struct _mesa_HashTable *table)
 {
-   GLuint pos;
    assert(table);
-   for (pos = 0; pos < TABLE_SIZE; pos++) {
-      struct HashEntry *entry = table->Table[pos];
-      while (entry) {
-        struct HashEntry *next = entry->Next;
-         if (entry->Data) {
-            _mesa_problem(NULL,
-                          "In _mesa_DeleteHashTable, found non-freed data");
-         }
-        free(entry);
-        entry = next;
-      }
+
+   if (_mesa_hash_table_next_entry(table->ht, NULL) != NULL) {
+      _mesa_problem(NULL, "In _mesa_DeleteHashTable, found non-freed data");
    }
-   _glthread_DESTROY_MUTEX(table->Mutex);
-   _glthread_DESTROY_MUTEX(table->WalkMutex);
+
+   _mesa_hash_table_destroy(table->ht, NULL);
+
+   mtx_destroy(&table->Mutex);
    free(table);
 }
 
@@ -123,24 +105,24 @@ _mesa_DeleteHashTable(struct _mesa_HashTable *table)
  * Lookup an entry in the hash table, without locking.
  * \sa _mesa_HashLookup
  */
-static INLINE void *
+static inline void *
 _mesa_HashLookup_unlocked(struct _mesa_HashTable *table, GLuint key)
 {
-   GLuint pos;
-   const struct HashEntry *entry;
+   const struct hash_entry *entry;
 
    assert(table);
    assert(key);
 
-   pos = HASH_FUNC(key);
-   entry = table->Table[pos];
-   while (entry) {
-      if (entry->Key == key) {
-         return entry->Data;
-      }
-      entry = entry->Next;
-   }
-   return NULL;
+   if (key == DELETED_KEY_VALUE)
+      return table->deleted_key_data;
+
+   entry = _mesa_hash_table_search_pre_hashed(table->ht,
+                                              uint_hash(key),
+                                              uint_key(key));
+   if (!entry)
+      return NULL;
+
+   return entry->data;
 }
 
 
@@ -156,67 +138,90 @@ void *
 _mesa_HashLookup(struct _mesa_HashTable *table, GLuint key)
 {
    void *res;
-   assert(table);
-   _glthread_LOCK_MUTEX(table->Mutex);
+   _mesa_HashLockMutex(table);
    res = _mesa_HashLookup_unlocked(table, key);
-   _glthread_UNLOCK_MUTEX(table->Mutex);
+   _mesa_HashUnlockMutex(table);
    return res;
 }
 
 
 /**
- * Insert a key/pointer pair into the hash table.  
- * If an entry with this key already exists we'll replace the existing entry.
- * 
+ * Lookup an entry in the hash table without locking the mutex.
+ *
+ * The hash table mutex must be locked manually by calling
+ * _mesa_HashLockMutex() before calling this function.
+ *
  * \param table the hash table.
- * \param key the key (not zero).
- * \param data pointer to user data.
+ * \param key the key.
+ *
+ * \return pointer to user's data or NULL if key not in table
  */
-void
-_mesa_HashInsert(struct _mesa_HashTable *table, GLuint key, void *data)
+void *
+_mesa_HashLookupLocked(struct _mesa_HashTable *table, GLuint key)
 {
-   /* search for existing entry with this key */
-   GLuint pos;
-   struct HashEntry *entry;
+   return _mesa_HashLookup_unlocked(table, key);
+}
+
+
+static inline void
+_mesa_HashInsert_unlocked(struct _mesa_HashTable *table, GLuint key, void *data)
+{
+   uint32_t hash = uint_hash(key);
+   struct hash_entry *entry;
 
    assert(table);
    assert(key);
 
-   _glthread_LOCK_MUTEX(table->Mutex);
-
    if (key > table->MaxKey)
       table->MaxKey = key;
 
-   pos = HASH_FUNC(key);
-
-   /* check if replacing an existing entry with same key */
-   for (entry = table->Table[pos]; entry; entry = entry->Next) {
-      if (entry->Key == key) {
-         /* replace entry's data */
-#if 0 /* not sure this check is always valid */
-         if (entry->Data) {
-            _mesa_problem(NULL, "Memory leak detected in _mesa_HashInsert");
-         }
-#endif
-        entry->Data = data;
-         _glthread_UNLOCK_MUTEX(table->Mutex);
-        return;
+   if (key == DELETED_KEY_VALUE) {
+      table->deleted_key_data = data;
+   } else {
+      entry = _mesa_hash_table_search_pre_hashed(table->ht, hash, uint_key(key));
+      if (entry) {
+         entry->data = data;
+      } else {
+         _mesa_hash_table_insert_pre_hashed(table->ht, hash, uint_key(key), data);
       }
    }
+}
 
-   /* alloc and insert new table entry */
-   entry = MALLOC_STRUCT(HashEntry);
-   if (entry) {
-      entry->Key = key;
-      entry->Data = data;
-      entry->Next = table->Table[pos];
-      table->Table[pos] = entry;
-   }
 
-   _glthread_UNLOCK_MUTEX(table->Mutex);
+/**
+ * Insert a key/pointer pair into the hash table without locking the mutex.
+ * If an entry with this key already exists we'll replace the existing entry.
+ *
+ * The hash table mutex must be locked manually by calling
+ * _mesa_HashLockMutex() before calling this function.
+ *
+ * \param table the hash table.
+ * \param key the key (not zero).
+ * \param data pointer to user data.
+ */
+void
+_mesa_HashInsertLocked(struct _mesa_HashTable *table, GLuint key, void *data)
+{
+   _mesa_HashInsert_unlocked(table, key, data);
 }
 
 
+/**
+ * Insert a key/pointer pair into the hash table.
+ * If an entry with this key already exists we'll replace the existing entry.
+ *
+ * \param table the hash table.
+ * \param key the key (not zero).
+ * \param data pointer to user data.
+ */
+void
+_mesa_HashInsert(struct _mesa_HashTable *table, GLuint key, void *data)
+{
+   _mesa_HashLockMutex(table);
+   _mesa_HashInsert_unlocked(table, key, data);
+   _mesa_HashUnlockMutex(table);
+}
+
 
 /**
  * Remove an entry from the hash table.
@@ -227,48 +232,43 @@ _mesa_HashInsert(struct _mesa_HashTable *table, GLuint key, void *data)
  * While holding the hash table's lock, searches the entry with the matching
  * key and unlinks it.
  */
-void
-_mesa_HashRemove(struct _mesa_HashTable *table, GLuint key)
+static inline void
+_mesa_HashRemove_unlocked(struct _mesa_HashTable *table, GLuint key)
 {
-   GLuint pos;
-   struct HashEntry *entry, *prev;
+   struct hash_entry *entry;
 
    assert(table);
    assert(key);
 
-   /* have to check this outside of mutex lock */
-   if (table->InDeleteAll) {
-      _mesa_problem(NULL, "_mesa_HashRemove illegally called from "
-                    "_mesa_HashDeleteAll callback function");
-      return;
+   /* assert if _mesa_HashRemove illegally called from _mesa_HashDeleteAll
+    * callback function. Have to check this outside of mutex lock.
+    */
+   assert(!table->InDeleteAll);
+
+   if (key == DELETED_KEY_VALUE) {
+      table->deleted_key_data = NULL;
+   } else {
+      entry = _mesa_hash_table_search_pre_hashed(table->ht,
+                                                 uint_hash(key),
+                                                 uint_key(key));
+      _mesa_hash_table_remove(table->ht, entry);
    }
+}
 
-   _glthread_LOCK_MUTEX(table->Mutex);
-
-   pos = HASH_FUNC(key);
-   prev = NULL;
-   entry = table->Table[pos];
-   while (entry) {
-      if (entry->Key == key) {
-         /* found it! */
-         if (prev) {
-            prev->Next = entry->Next;
-         }
-         else {
-            table->Table[pos] = entry->Next;
-         }
-         free(entry);
-         _glthread_UNLOCK_MUTEX(table->Mutex);
-        return;
-      }
-      prev = entry;
-      entry = entry->Next;
-   }
 
-   _glthread_UNLOCK_MUTEX(table->Mutex);
+void
+_mesa_HashRemoveLocked(struct _mesa_HashTable *table, GLuint key)
+{
+   _mesa_HashRemove_unlocked(table, key);
 }
 
-
+void
+_mesa_HashRemove(struct _mesa_HashTable *table, GLuint key)
+{
+   _mesa_HashLockMutex(table);
+   _mesa_HashRemove_unlocked(table, key);
+   _mesa_HashUnlockMutex(table);
+}
 
 /**
  * Delete all entries in a hash table, but don't delete the table itself.
@@ -284,37 +284,45 @@ _mesa_HashDeleteAll(struct _mesa_HashTable *table,
                     void (*callback)(GLuint key, void *data, void *userData),
                     void *userData)
 {
-   GLuint pos;
-   ASSERT(table);
-   ASSERT(callback);
-   _glthread_LOCK_MUTEX(table->Mutex);
+   assert(callback);
+   _mesa_HashLockMutex(table);
    table->InDeleteAll = GL_TRUE;
-   for (pos = 0; pos < TABLE_SIZE; pos++) {
-      struct HashEntry *entry, *next;
-      for (entry = table->Table[pos]; entry; entry = next) {
-         callback(entry->Key, entry->Data, userData);
-         next = entry->Next;
-         free(entry);
-      }
-      table->Table[pos] = NULL;
+   hash_table_foreach(table->ht, entry) {
+      callback((uintptr_t)entry->key, entry->data, userData);
+      _mesa_hash_table_remove(table->ht, entry);
+   }
+   if (table->deleted_key_data) {
+      callback(DELETED_KEY_VALUE, table->deleted_key_data, userData);
+      table->deleted_key_data = NULL;
    }
    table->InDeleteAll = GL_FALSE;
-   _glthread_UNLOCK_MUTEX(table->Mutex);
+   _mesa_HashUnlockMutex(table);
 }
 
 
 /**
  * Walk over all entries in a hash table, calling callback function for each.
- * Note: we use a separate mutex in this function to avoid a recursive
- * locking deadlock (in case the callback calls _mesa_HashRemove()) and to
- * prevent multiple threads/contexts from getting tangled up.
- * A lock-less version of this function could be used when the table will
- * not be modified.
  * \param table  the hash table to walk
  * \param callback  the callback function
  * \param userData  arbitrary pointer to pass along to the callback
  *                  (this is typically a struct gl_context pointer)
  */
+static void
+hash_walk_unlocked(const struct _mesa_HashTable *table,
+                   void (*callback)(GLuint key, void *data, void *userData),
+                   void *userData)
+{
+   assert(table);
+   assert(callback);
+
+   hash_table_foreach(table->ht, entry) {
+      callback((uintptr_t)entry->key, entry->data, userData);
+   }
+   if (table->deleted_key_data)
+      callback(DELETED_KEY_VALUE, table->deleted_key_data, userData);
+}
+
+
 void
 _mesa_HashWalk(const struct _mesa_HashTable *table,
                void (*callback)(GLuint key, void *data, void *userData),
@@ -322,93 +330,26 @@ _mesa_HashWalk(const struct _mesa_HashTable *table,
 {
    /* cast-away const */
    struct _mesa_HashTable *table2 = (struct _mesa_HashTable *) table;
-   GLuint pos;
-   ASSERT(table);
-   ASSERT(callback);
-   _glthread_LOCK_MUTEX(table2->WalkMutex);
-   for (pos = 0; pos < TABLE_SIZE; pos++) {
-      struct HashEntry *entry, *next;
-      for (entry = table->Table[pos]; entry; entry = next) {
-         /* save 'next' pointer now in case the callback deletes the entry */
-         next = entry->Next;
-         callback(entry->Key, entry->Data, userData);
-      }
-   }
-   _glthread_UNLOCK_MUTEX(table2->WalkMutex);
-}
 
+   _mesa_HashLockMutex(table2);
+   hash_walk_unlocked(table, callback, userData);
+   _mesa_HashUnlockMutex(table2);
+}
 
-/**
- * Return the key of the "first" entry in the hash table.
- * While holding the lock, walks through all table positions until finding
- * the first entry of the first non-empty one.
- * 
- * \param table  the hash table
- * \return key for the "first" entry in the hash table.
- */
-GLuint
-_mesa_HashFirstEntry(struct _mesa_HashTable *table)
+void
+_mesa_HashWalkLocked(const struct _mesa_HashTable *table,
+               void (*callback)(GLuint key, void *data, void *userData),
+               void *userData)
 {
-   GLuint pos;
-   assert(table);
-   _glthread_LOCK_MUTEX(table->Mutex);
-   for (pos = 0; pos < TABLE_SIZE; pos++) {
-      if (table->Table[pos]) {
-         _glthread_UNLOCK_MUTEX(table->Mutex);
-         return table->Table[pos]->Key;
-      }
-   }
-   _glthread_UNLOCK_MUTEX(table->Mutex);
-   return 0;
+   hash_walk_unlocked(table, callback, userData);
 }
 
-
-/**
- * Given a hash table key, return the next key.  This is used to walk
- * over all entries in the table.  Note that the keys returned during
- * walking won't be in any particular order.
- * \return next hash key or 0 if end of table.
- */
-GLuint
-_mesa_HashNextEntry(const struct _mesa_HashTable *table, GLuint key)
+static void
+debug_print_entry(GLuint key, void *data, void *userData)
 {
-   const struct HashEntry *entry;
-   GLuint pos;
-
-   assert(table);
-   assert(key);
-
-   /* Find the entry with given key */
-   pos = HASH_FUNC(key);
-   for (entry = table->Table[pos]; entry ; entry = entry->Next) {
-      if (entry->Key == key) {
-         break;
-      }
-   }
-
-   if (!entry) {
-      /* the given key was not found, so we can't find the next entry */
-      return 0;
-   }
-
-   if (entry->Next) {
-      /* return next in linked list */
-      return entry->Next->Key;
-   }
-   else {
-      /* look for next non-empty table slot */
-      pos++;
-      while (pos < TABLE_SIZE) {
-         if (table->Table[pos]) {
-            return table->Table[pos]->Key;
-         }
-         pos++;
-      }
-      return 0;
-   }
+   _mesa_debug(NULL, "%u %p\n", key, data);
 }
 
-
 /**
  * Dump contents of hash table for debugging.
  * 
@@ -417,19 +358,12 @@ _mesa_HashNextEntry(const struct _mesa_HashTable *table, GLuint key)
 void
 _mesa_HashPrint(const struct _mesa_HashTable *table)
 {
-   GLuint pos;
-   assert(table);
-   for (pos = 0; pos < TABLE_SIZE; pos++) {
-      const struct HashEntry *entry = table->Table[pos];
-      while (entry) {
-        _mesa_debug(NULL, "%u %p\n", entry->Key, entry->Data);
-        entry = entry->Next;
-      }
-   }
+   if (table->deleted_key_data)
+      debug_print_entry(DELETED_KEY_VALUE, table->deleted_key_data, NULL);
+   _mesa_HashWalk(table, debug_print_entry, NULL);
 }
 
 
-
 /**
  * Find a block of adjacent unused hash keys.
  * 
@@ -446,11 +380,9 @@ _mesa_HashPrint(const struct _mesa_HashTable *table)
 GLuint
 _mesa_HashFindFreeKeyBlock(struct _mesa_HashTable *table, GLuint numKeys)
 {
-   const GLuint maxKey = ~((GLuint) 0);
-   _glthread_LOCK_MUTEX(table->Mutex);
+   const GLuint maxKey = ~((GLuint) 0) - 1;
    if (maxKey - numKeys > table->MaxKey) {
       /* the quick solution */
-      _glthread_UNLOCK_MUTEX(table->Mutex);
       return table->MaxKey + 1;
    }
    else {
@@ -468,80 +400,28 @@ _mesa_HashFindFreeKeyBlock(struct _mesa_HashTable *table, GLuint numKeys)
            /* this key not in use, check if we've found enough */
            freeCount++;
            if (freeCount == numKeys) {
-               _glthread_UNLOCK_MUTEX(table->Mutex);
               return freeStart;
            }
         }
       }
       /* cannot allocate a block of numKeys consecutive keys */
-      _glthread_UNLOCK_MUTEX(table->Mutex);
       return 0;
    }
 }
 
 
-#if 0 /* debug only */
-
 /**
- * Test walking over all the entries in a hash table.
+ * Return the number of entries in the hash table.
  */
-static void
-test_hash_walking(void)
-{
-   struct _mesa_HashTable *t = _mesa_NewHashTable();
-   const GLuint limit = 50000;
-   GLuint i;
-
-   /* create some entries */
-   for (i = 0; i < limit; i++) {
-      GLuint dummy;
-      GLuint k = (rand() % (limit * 10)) + 1;
-      while (_mesa_HashLookup(t, k)) {
-         /* id already in use, try another */
-         k = (rand() % (limit * 10)) + 1;
-      }
-      _mesa_HashInsert(t, k, &dummy);
-   }
-
-   /* walk over all entries */
-   {
-      GLuint k = _mesa_HashFirstEntry(t);
-      GLuint count = 0;
-      while (k) {
-         GLuint knext = _mesa_HashNextEntry(t, k);
-         assert(knext != k);
-         _mesa_HashRemove(t, k);
-         count++;
-         k = knext;
-      }
-      assert(count == limit);
-      k = _mesa_HashFirstEntry(t);
-      assert(k==0);
-   }
-
-   _mesa_DeleteHashTable(t);
-}
-
-
-void
-_mesa_test_hash_functions(void)
+GLuint
+_mesa_HashNumEntries(const struct _mesa_HashTable *table)
 {
-   int a, b, c;
-   struct _mesa_HashTable *t;
+   GLuint count = 0;
 
-   t = _mesa_NewHashTable();
-   _mesa_HashInsert(t, 501, &a);
-   _mesa_HashInsert(t, 10, &c);
-   _mesa_HashInsert(t, 0xfffffff8, &b);
-   /*_mesa_HashPrint(t);*/
+   if (table->deleted_key_data)
+      count++;
 
-   assert(_mesa_HashLookup(t,501));
-   assert(!_mesa_HashLookup(t,1313));
-   assert(_mesa_HashFindFreeKeyBlock(t, 100));
+   count += _mesa_hash_table_num_entries(table->ht);
 
-   _mesa_DeleteHashTable(t);
-
-   test_hash_walking();
+   return count;
 }
-
-#endif