2022-04-04 02:02:40 +01:00
|
|
|
/*
|
2012-11-07 07:18:41 +00:00
|
|
|
* Copyright © 2009,2012 Intel Corporation
|
|
|
|
*
|
|
|
|
* 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 (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 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.
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Eric Anholt <eric@anholt.net>
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2012-11-14 05:18:09 +00:00
|
|
|
#ifndef _HASH_TABLE_H
|
|
|
|
#define _HASH_TABLE_H
|
|
|
|
|
2014-07-23 22:58:52 +01:00
|
|
|
#include <stdlib.h>
|
2012-11-07 07:18:41 +00:00
|
|
|
#include <inttypes.h>
|
|
|
|
#include <stdbool.h>
|
2014-07-23 22:58:52 +01:00
|
|
|
#include "macros.h"
|
2012-11-07 07:18:41 +00:00
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
|
|
|
struct hash_entry {
|
|
|
|
uint32_t hash;
|
|
|
|
const void *key;
|
|
|
|
void *data;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct hash_table {
|
|
|
|
struct hash_entry *table;
|
util/hash_table: Rework the API to know about hashing
Previously, the hash_table API required the user to do all of the hashing
of keys as it passed them in. Since the hashing function is intrinsically
tied to the comparison function, it makes sense for the hash table to know
about it. Also, it makes for a somewhat clumsy API as the user is
constantly calling hashing functions many of which have long names. This
is especially bad when the standard call looks something like
_mesa_hash_table_insert(ht, _mesa_pointer_hash(key), key, data);
In the above case, there is no reason why the hash table shouldn't do the
hashing for you. We leave the option for you to do your own hashing if
it's more efficient, but it's no longer needed. Also, if you do do your
own hashing, the hash table will assert that your hash matches what it
expects out of the hashing function. This should make it harder to mess up
your hashing.
v2: change to call the old entrypoint "pre_hashed" rather than
"with_hash", like cworth's equivalent change upstream (change by
anholt, acked-in-general by Jason).
Signed-off-by: Jason Ekstrand <jason.ekstrand@intel.com>
Signed-off-by: Eric Anholt <eric@anholt.net>
Reviewed-by: Eric Anholt <eric@anholt.net>
2014-11-25 06:19:50 +00:00
|
|
|
uint32_t (*key_hash_function)(const void *key);
|
2012-11-07 07:18:41 +00:00
|
|
|
bool (*key_equals_function)(const void *a, const void *b);
|
|
|
|
const void *deleted_key;
|
|
|
|
uint32_t size;
|
|
|
|
uint32_t rehash;
|
2019-05-21 11:56:31 +01:00
|
|
|
uint64_t size_magic;
|
|
|
|
uint64_t rehash_magic;
|
2012-11-07 07:18:41 +00:00
|
|
|
uint32_t max_entries;
|
|
|
|
uint32_t size_index;
|
|
|
|
uint32_t entries;
|
|
|
|
uint32_t deleted_entries;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct hash_table *
|
|
|
|
_mesa_hash_table_create(void *mem_ctx,
|
util/hash_table: Rework the API to know about hashing
Previously, the hash_table API required the user to do all of the hashing
of keys as it passed them in. Since the hashing function is intrinsically
tied to the comparison function, it makes sense for the hash table to know
about it. Also, it makes for a somewhat clumsy API as the user is
constantly calling hashing functions many of which have long names. This
is especially bad when the standard call looks something like
_mesa_hash_table_insert(ht, _mesa_pointer_hash(key), key, data);
In the above case, there is no reason why the hash table shouldn't do the
hashing for you. We leave the option for you to do your own hashing if
it's more efficient, but it's no longer needed. Also, if you do do your
own hashing, the hash table will assert that your hash matches what it
expects out of the hashing function. This should make it harder to mess up
your hashing.
v2: change to call the old entrypoint "pre_hashed" rather than
"with_hash", like cworth's equivalent change upstream (change by
anholt, acked-in-general by Jason).
Signed-off-by: Jason Ekstrand <jason.ekstrand@intel.com>
Signed-off-by: Eric Anholt <eric@anholt.net>
Reviewed-by: Eric Anholt <eric@anholt.net>
2014-11-25 06:19:50 +00:00
|
|
|
uint32_t (*key_hash_function)(const void *key),
|
2012-11-07 07:18:41 +00:00
|
|
|
bool (*key_equals_function)(const void *a,
|
|
|
|
const void *b));
|
2018-11-21 21:45:52 +00:00
|
|
|
|
|
|
|
bool
|
|
|
|
_mesa_hash_table_init(struct hash_table *ht,
|
|
|
|
void *mem_ctx,
|
|
|
|
uint32_t (*key_hash_function)(const void *key),
|
|
|
|
bool (*key_equals_function)(const void *a,
|
|
|
|
const void *b));
|
|
|
|
|
2021-05-01 20:08:31 +01:00
|
|
|
struct hash_table *
|
|
|
|
_mesa_hash_table_create_u32_keys(void *mem_ctx);
|
|
|
|
|
2017-01-09 22:01:50 +00:00
|
|
|
struct hash_table *
|
|
|
|
_mesa_hash_table_clone(struct hash_table *src, void *dst_mem_ctx);
|
2012-11-07 07:18:41 +00:00
|
|
|
void _mesa_hash_table_destroy(struct hash_table *ht,
|
|
|
|
void (*delete_function)(struct hash_entry *entry));
|
2016-01-06 19:50:46 +00:00
|
|
|
void _mesa_hash_table_clear(struct hash_table *ht,
|
|
|
|
void (*delete_function)(struct hash_entry *entry));
|
2012-11-07 07:18:41 +00:00
|
|
|
void _mesa_hash_table_set_deleted_key(struct hash_table *ht,
|
|
|
|
const void *deleted_key);
|
|
|
|
|
2016-01-11 20:07:27 +00:00
|
|
|
static inline uint32_t _mesa_hash_table_num_entries(struct hash_table *ht)
|
|
|
|
{
|
|
|
|
return ht->entries;
|
|
|
|
}
|
|
|
|
|
2012-11-07 07:18:41 +00:00
|
|
|
struct hash_entry *
|
util/hash_table: Rework the API to know about hashing
Previously, the hash_table API required the user to do all of the hashing
of keys as it passed them in. Since the hashing function is intrinsically
tied to the comparison function, it makes sense for the hash table to know
about it. Also, it makes for a somewhat clumsy API as the user is
constantly calling hashing functions many of which have long names. This
is especially bad when the standard call looks something like
_mesa_hash_table_insert(ht, _mesa_pointer_hash(key), key, data);
In the above case, there is no reason why the hash table shouldn't do the
hashing for you. We leave the option for you to do your own hashing if
it's more efficient, but it's no longer needed. Also, if you do do your
own hashing, the hash table will assert that your hash matches what it
expects out of the hashing function. This should make it harder to mess up
your hashing.
v2: change to call the old entrypoint "pre_hashed" rather than
"with_hash", like cworth's equivalent change upstream (change by
anholt, acked-in-general by Jason).
Signed-off-by: Jason Ekstrand <jason.ekstrand@intel.com>
Signed-off-by: Eric Anholt <eric@anholt.net>
Reviewed-by: Eric Anholt <eric@anholt.net>
2014-11-25 06:19:50 +00:00
|
|
|
_mesa_hash_table_insert(struct hash_table *ht, const void *key, void *data);
|
2012-11-07 07:18:41 +00:00
|
|
|
struct hash_entry *
|
2015-01-15 15:58:07 +00:00
|
|
|
_mesa_hash_table_insert_pre_hashed(struct hash_table *ht, uint32_t hash,
|
|
|
|
const void *key, void *data);
|
util/hash_table: Rework the API to know about hashing
Previously, the hash_table API required the user to do all of the hashing
of keys as it passed them in. Since the hashing function is intrinsically
tied to the comparison function, it makes sense for the hash table to know
about it. Also, it makes for a somewhat clumsy API as the user is
constantly calling hashing functions many of which have long names. This
is especially bad when the standard call looks something like
_mesa_hash_table_insert(ht, _mesa_pointer_hash(key), key, data);
In the above case, there is no reason why the hash table shouldn't do the
hashing for you. We leave the option for you to do your own hashing if
it's more efficient, but it's no longer needed. Also, if you do do your
own hashing, the hash table will assert that your hash matches what it
expects out of the hashing function. This should make it harder to mess up
your hashing.
v2: change to call the old entrypoint "pre_hashed" rather than
"with_hash", like cworth's equivalent change upstream (change by
anholt, acked-in-general by Jason).
Signed-off-by: Jason Ekstrand <jason.ekstrand@intel.com>
Signed-off-by: Eric Anholt <eric@anholt.net>
Reviewed-by: Eric Anholt <eric@anholt.net>
2014-11-25 06:19:50 +00:00
|
|
|
struct hash_entry *
|
|
|
|
_mesa_hash_table_search(struct hash_table *ht, const void *key);
|
|
|
|
struct hash_entry *
|
|
|
|
_mesa_hash_table_search_pre_hashed(struct hash_table *ht, uint32_t hash,
|
|
|
|
const void *key);
|
2012-11-07 07:18:41 +00:00
|
|
|
void _mesa_hash_table_remove(struct hash_table *ht,
|
|
|
|
struct hash_entry *entry);
|
2018-07-12 19:17:04 +01:00
|
|
|
void _mesa_hash_table_remove_key(struct hash_table *ht,
|
|
|
|
const void *key);
|
2012-11-07 07:18:41 +00:00
|
|
|
|
|
|
|
struct hash_entry *_mesa_hash_table_next_entry(struct hash_table *ht,
|
|
|
|
struct hash_entry *entry);
|
2021-01-12 19:49:48 +00:00
|
|
|
struct hash_entry *_mesa_hash_table_next_entry_unsafe(const struct hash_table *ht,
|
|
|
|
struct hash_entry *entry);
|
2012-11-07 07:18:41 +00:00
|
|
|
struct hash_entry *
|
|
|
|
_mesa_hash_table_random_entry(struct hash_table *ht,
|
|
|
|
bool (*predicate)(struct hash_entry *entry));
|
|
|
|
|
|
|
|
uint32_t _mesa_hash_data(const void *data, size_t size);
|
2020-10-08 15:49:01 +01:00
|
|
|
uint32_t _mesa_hash_data_with_seed(const void *data, size_t size, uint32_t seed);
|
2020-01-18 06:38:31 +00:00
|
|
|
|
|
|
|
uint32_t _mesa_hash_int(const void *key);
|
|
|
|
uint32_t _mesa_hash_uint(const void *key);
|
|
|
|
uint32_t _mesa_hash_u32(const void *key);
|
2017-10-27 17:43:45 +01:00
|
|
|
uint32_t _mesa_hash_string(const void *key);
|
2021-10-26 02:01:08 +01:00
|
|
|
uint32_t _mesa_hash_string_with_length(const void *_key, unsigned length);
|
2020-01-18 06:38:31 +00:00
|
|
|
uint32_t _mesa_hash_pointer(const void *pointer);
|
|
|
|
|
|
|
|
bool _mesa_key_int_equal(const void *a, const void *b);
|
|
|
|
bool _mesa_key_uint_equal(const void *a, const void *b);
|
|
|
|
bool _mesa_key_u32_equal(const void *a, const void *b);
|
2012-11-07 07:18:41 +00:00
|
|
|
bool _mesa_key_string_equal(const void *a, const void *b);
|
|
|
|
bool _mesa_key_pointer_equal(const void *a, const void *b);
|
|
|
|
|
2018-09-12 00:37:33 +01:00
|
|
|
struct hash_table *
|
|
|
|
_mesa_pointer_hash_table_create(void *mem_ctx);
|
|
|
|
|
2020-10-06 21:30:47 +01:00
|
|
|
bool
|
|
|
|
_mesa_hash_table_reserve(struct hash_table *ht, unsigned size);
|
2012-11-07 07:18:41 +00:00
|
|
|
/**
|
|
|
|
* This foreach function is safe against deletion (which just replaces
|
|
|
|
* an entry's data with the deleted marker), but not against insertion
|
|
|
|
* (which may rehash the table, making entry a dangling pointer).
|
|
|
|
*/
|
2018-10-20 18:00:08 +01:00
|
|
|
#define hash_table_foreach(ht, entry) \
|
|
|
|
for (struct hash_entry *entry = _mesa_hash_table_next_entry(ht, NULL); \
|
|
|
|
entry != NULL; \
|
2012-11-07 07:18:41 +00:00
|
|
|
entry = _mesa_hash_table_next_entry(ht, entry))
|
2021-01-12 19:49:48 +00:00
|
|
|
/**
|
|
|
|
* This foreach function destroys the table as it iterates.
|
|
|
|
* It is not safe to use when inserting or removing entries.
|
|
|
|
*/
|
|
|
|
#define hash_table_foreach_remove(ht, entry) \
|
|
|
|
for (struct hash_entry *entry = _mesa_hash_table_next_entry_unsafe(ht, NULL); \
|
|
|
|
(ht)->entries; \
|
|
|
|
entry->hash = 0, entry->key = (void*)NULL, entry->data = NULL, \
|
|
|
|
(ht)->entries--, entry = _mesa_hash_table_next_entry_unsafe(ht, entry))
|
2012-11-07 07:18:41 +00:00
|
|
|
|
2016-08-16 21:10:17 +01:00
|
|
|
static inline void
|
|
|
|
hash_table_call_foreach(struct hash_table *ht,
|
|
|
|
void (*callback)(const void *key,
|
|
|
|
void *data,
|
|
|
|
void *closure),
|
|
|
|
void *closure)
|
|
|
|
{
|
|
|
|
hash_table_foreach(ht, entry)
|
|
|
|
callback(entry->key, entry->data, closure);
|
|
|
|
}
|
|
|
|
|
2017-06-12 15:51:04 +01:00
|
|
|
/**
|
|
|
|
* Hash table wrapper which supports 64-bit keys.
|
|
|
|
*/
|
|
|
|
struct hash_table_u64 {
|
|
|
|
struct hash_table *table;
|
2019-06-10 20:10:54 +01:00
|
|
|
void *freed_key_data;
|
2017-06-12 15:51:04 +01:00
|
|
|
void *deleted_key_data;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct hash_table_u64 *
|
|
|
|
_mesa_hash_table_u64_create(void *mem_ctx);
|
|
|
|
|
|
|
|
void
|
2021-04-27 11:08:50 +01:00
|
|
|
_mesa_hash_table_u64_destroy(struct hash_table_u64 *ht);
|
2017-06-12 15:51:04 +01:00
|
|
|
|
|
|
|
void
|
|
|
|
_mesa_hash_table_u64_insert(struct hash_table_u64 *ht, uint64_t key,
|
|
|
|
void *data);
|
|
|
|
|
|
|
|
void *
|
|
|
|
_mesa_hash_table_u64_search(struct hash_table_u64 *ht, uint64_t key);
|
|
|
|
|
|
|
|
void
|
|
|
|
_mesa_hash_table_u64_remove(struct hash_table_u64 *ht, uint64_t key);
|
|
|
|
|
2019-06-10 22:23:34 +01:00
|
|
|
void
|
2021-04-27 11:08:50 +01:00
|
|
|
_mesa_hash_table_u64_clear(struct hash_table_u64 *ht);
|
2019-06-10 22:23:34 +01:00
|
|
|
|
2012-11-07 07:18:41 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
} /* extern C */
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* _HASH_TABLE_H */
|