src/mesa/main/hash.h

   1 /**
   2  * \file hash.h
   3  * Generic hash table.
   4  */
   5
   6 /*
   7  * Mesa 3-D graphics library
   8  *
   9  * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a
  12  * copy of this software and associated documentation files (the "Software"),
  13  * to deal in the Software without restriction, including without limitation
  14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  15  * and/or sell copies of the Software, and to permit persons to whom the
  16  * Software is furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included
  19  * in all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  22  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  25  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  27  * OTHER DEALINGS IN THE SOFTWARE.
  28  */
  29
  30
  31 #ifndef HASH_H
  32 #define HASH_H
  33
  34
  35 #include "glheader.h"
  36 #include "imports.h"
  37
  38
  39 /**
  40  * The hash table data structure.
  41  */
  42 struct _mesa_HashTable {
  43    struct hash_table *ht;
  44    GLuint MaxKey;                        /**< highest key inserted so far */
  45    mtx_t Mutex;                          /**< mutual exclusion lock */
  46    GLboolean InDeleteAll;                /**< Debug check */
  47    /** Value that would be in the table for DELETED_KEY_VALUE. */
  48    void *deleted_key_data;
  49 };
  50
  51 extern struct _mesa_HashTable *_mesa_NewHashTable(void);
  52
  53 extern void _mesa_DeleteHashTable(struct _mesa_HashTable *table);
  54
  55 extern void *_mesa_HashLookup(struct _mesa_HashTable *table, GLuint key);
  56
  57 extern void _mesa_HashInsert(struct _mesa_HashTable *table, GLuint key, void *data);
  58
  59 extern void _mesa_HashRemove(struct _mesa_HashTable *table, GLuint key);
  60
  61 /**
  62  * Lock the hash table mutex.
  63  *
  64  * This function should be used when multiple objects need
  65  * to be looked up in the hash table, to avoid having to lock
  66  * and unlock the mutex each time.
  67  *
  68  * \param table the hash table.
  69  */
  70 static inline void
  71 _mesa_HashLockMutex(struct _mesa_HashTable *table)
  72 {
  73    assert(table);
  74    mtx_lock(&table->Mutex);
  75 }
  76
  77
  78 /**
  79  * Unlock the hash table mutex.
  80  *
  81  * \param table the hash table.
  82  */
  83 static inline void
  84 _mesa_HashUnlockMutex(struct _mesa_HashTable *table)
  85 {
  86    assert(table);
  87    mtx_unlock(&table->Mutex);
  88 }
  89
  90 extern void *_mesa_HashLookupLocked(struct _mesa_HashTable *table, GLuint key);
  91
  92 extern void _mesa_HashInsertLocked(struct _mesa_HashTable *table,
  93                                    GLuint key, void *data);
  94
  95 extern void _mesa_HashRemoveLocked(struct _mesa_HashTable *table, GLuint key);
  96
  97 extern void
  98 _mesa_HashDeleteAll(struct _mesa_HashTable *table,
  99                     void (*callback)(GLuint key, void *data, void *userData),
 100                     void *userData);
 101
 102 extern void
 103 _mesa_HashWalk(const struct _mesa_HashTable *table,
 104                void (*callback)(GLuint key, void *data, void *userData),
 105                void *userData);
 106
 107 extern void
 108 _mesa_HashWalkLocked(const struct _mesa_HashTable *table,
 109                      void (*callback)(GLuint key, void *data, void *userData),
 110                      void *userData);
 111
 112 extern void _mesa_HashPrint(const struct _mesa_HashTable *table);
 113
 114 extern GLuint _mesa_HashFindFreeKeyBlock(struct _mesa_HashTable *table, GLuint numKeys);
 115
 116 extern GLuint
 117 _mesa_HashNumEntries(const struct _mesa_HashTable *table);
 118
 119 extern void _mesa_test_hash_functions(void);
 120
 121
 122 #endif