src/gallium/auxiliary/util/u_hash_table.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * General purpose hash table.
  30  */
  31
  32 #ifndef U_HASH_TABLE_H_
  33 #define U_HASH_TABLE_H_
  34
  35
  36 #include "pipe/p_defines.h"
  37
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 struct hash_table;
  44
  45
  46 /**
  47  * Create an hash table.
  48  *
  49  * @param hash hash function
  50  * @param equal should return true for two equal keys.
  51  */
  52 struct hash_table *
  53 util_hash_table_create(uint32_t (*hash)(const void *key),
  54                        bool (*equal)(const void *key1, const void *key2));
  55
  56 /**
  57  * Create a hash table where the keys are generic pointers.
  58  */
  59 struct hash_table *
  60 util_hash_table_create_ptr_keys(void);
  61
  62
  63 /**
  64  * Create a hash table where the keys are device FDs.
  65  */
  66 struct hash_table *
  67 util_hash_table_create_fd_keys(void);
  68
  69
  70 enum pipe_error
  71 util_hash_table_set(struct hash_table *ht,
  72                     void *key,
  73                     void *value);
  74
  75 void *
  76 util_hash_table_get(struct hash_table *ht,
  77                     void *key);
  78
  79
  80 void
  81 util_hash_table_remove(struct hash_table *ht,
  82                        void *key);
  83
  84
  85 void
  86 util_hash_table_clear(struct hash_table *ht);
  87
  88
  89 enum pipe_error
  90 util_hash_table_foreach(struct hash_table *ht,
  91                         enum pipe_error (*callback)
  92                         (void *key, void *value, void *data),
  93                         void *data);
  94
  95
  96 size_t
  97 util_hash_table_count(struct hash_table *ht);
  98
  99
 100 void
 101 util_hash_table_destroy(struct hash_table *ht);
 102
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif /* U_HASH_TABLE_H_ */