D-Bus 1.15.12
|
DBusHashTable data structure. More...
Data Structures | |
struct | DBusHashIter |
Hash iterator object. More... | |
Macros | |
#define | DBUS_HASH_POLLABLE DBUS_HASH_INT |
Typedefs | |
typedef int(* | KeyCompareFunc) (const void *key_a, const void *key_b) |
Key comparison function. | |
typedef struct DBusHashTable | DBusHashTable |
Public opaque hash table object. | |
typedef struct DBusHashIter | DBusHashIter |
Public opaque hash table iterator object. | |
typedef struct DBusPreallocatedHash | DBusPreallocatedHash |
A preallocated hash entry. | |
Enumerations | |
enum | DBusHashType { DBUS_HASH_STRING , DBUS_HASH_INT , DBUS_HASH_UINTPTR } |
Indicates the type of a key in the hash table. More... | |
Functions | |
DBusHashTable * | _dbus_hash_table_new (DBusHashType type, DBusFreeFunction key_free_function, DBusFreeFunction value_free_function) |
Constructs a new hash table. | |
DBusHashTable * | _dbus_hash_table_ref (DBusHashTable *table) |
Increments the reference count for a hash table. | |
void | _dbus_hash_table_unref (DBusHashTable *table) |
Decrements the reference count for a hash table, freeing the hash table if the count reaches zero. | |
void | _dbus_hash_table_remove_all (DBusHashTable *table) |
Removed all entries from a hash table. | |
void | _dbus_hash_iter_init (DBusHashTable *table, DBusHashIter *iter) |
Initializes a hash table iterator. | |
dbus_bool_t | _dbus_hash_iter_next (DBusHashIter *iter) |
Move the hash iterator forward one step, to the next hash entry. | |
void | _dbus_hash_iter_remove_entry (DBusHashIter *iter) |
Removes the current entry from the hash table. | |
void * | _dbus_hash_iter_get_value (DBusHashIter *iter) |
Gets the value of the current entry. | |
void | _dbus_hash_iter_set_value (DBusHashIter *iter, void *value) |
Sets the value of the current entry. | |
int | _dbus_hash_iter_get_int_key (DBusHashIter *iter) |
Gets the key for the current entry. | |
uintptr_t | _dbus_hash_iter_get_uintptr_key (DBusHashIter *iter) |
Gets the key for the current entry. | |
const char * | _dbus_hash_iter_get_string_key (DBusHashIter *iter) |
Gets the key for the current entry. | |
dbus_bool_t | _dbus_hash_iter_lookup (DBusHashTable *table, void *key, dbus_bool_t create_if_not_found, DBusHashIter *iter) |
A low-level but efficient interface for manipulating the hash table. | |
void * | _dbus_hash_table_lookup_string (DBusHashTable *table, const char *key) |
Looks up the value for a given string in a hash table of type DBUS_HASH_STRING. | |
void * | _dbus_hash_table_lookup_int (DBusHashTable *table, int key) |
Looks up the value for a given integer in a hash table of type DBUS_HASH_INT. | |
void * | _dbus_hash_table_lookup_uintptr (DBusHashTable *table, uintptr_t key) |
Looks up the value for a given integer in a hash table of type DBUS_HASH_UINTPTR. | |
dbus_bool_t | _dbus_hash_table_remove_string (DBusHashTable *table, const char *key) |
Removes the hash entry for the given key. | |
dbus_bool_t | _dbus_hash_table_remove_int (DBusHashTable *table, int key) |
Removes the hash entry for the given key. | |
dbus_bool_t | _dbus_hash_table_remove_uintptr (DBusHashTable *table, uintptr_t key) |
Removes the hash entry for the given key. | |
dbus_bool_t | _dbus_hash_table_insert_string (DBusHashTable *table, char *key, void *value) |
Creates a hash entry with the given key and value. | |
dbus_bool_t | _dbus_hash_table_insert_int (DBusHashTable *table, int key, void *value) |
Creates a hash entry with the given key and value. | |
dbus_bool_t | _dbus_hash_table_insert_uintptr (DBusHashTable *table, uintptr_t key, void *value) |
Creates a hash entry with the given key and value. | |
DBusPreallocatedHash * | _dbus_hash_table_preallocate_entry (DBusHashTable *table) |
Preallocate an opaque data blob that allows us to insert into the hash table at a later time without allocating any memory. | |
void | _dbus_hash_table_free_preallocated_entry (DBusHashTable *table, DBusPreallocatedHash *preallocated) |
Frees an opaque DBusPreallocatedHash that was not used in order to insert into the hash table. | |
void | _dbus_hash_table_insert_string_preallocated (DBusHashTable *table, DBusPreallocatedHash *preallocated, char *key, void *value) |
Inserts a string-keyed entry into the hash table, using a preallocated data block from _dbus_hash_table_preallocate_entry(). | |
int | _dbus_hash_table_get_n_entries (DBusHashTable *table) |
Gets the number of hash entries in a hash table. | |
dbus_bool_t | _dbus_hash_table_from_array (DBusHashTable *table, char **array, char delimiter) |
Imports a string array into a hash table The hash table needs to be initialized with string keys, and dbus_free() as both key and value free-function. | |
char ** | _dbus_hash_table_to_array (DBusHashTable *table, char delimiter) |
Creates a string array from a hash table. | |
DBusHashTable data structure.
Types and functions related to DBusHashTable.
#define DBUS_HASH_POLLABLE DBUS_HASH_INT |
Definition at line 166 of file dbus-hash.h.
Public opaque hash table iterator object.
Definition at line 60 of file dbus-hash.h.
Public opaque hash table object.
Definition at line 59 of file dbus-hash.h.
typedef struct DBusPreallocatedHash DBusPreallocatedHash |
A preallocated hash entry.
Definition at line 150 of file dbus-hash.h.
typedef int(* KeyCompareFunc) (const void *key_a, const void *key_b) |
Key comparison function.
Definition at line 895 of file dbus-hash.c.
enum DBusHashType |
Indicates the type of a key in the hash table.
Enumerator | |
---|---|
DBUS_HASH_STRING | Hash keys are strings. |
DBUS_HASH_INT | Hash keys are integers. |
DBUS_HASH_UINTPTR | Hash keys are integer capable to hold a pointer. |
Definition at line 67 of file dbus-hash.h.
DBUS_PRIVATE_EXPORT int _dbus_hash_iter_get_int_key | ( | DBusHashIter * | iter | ) |
Gets the key for the current entry.
Only works for hash tables of type DBUS_HASH_INT.
iter | the hash table iterator. |
Definition at line 666 of file dbus-hash.c.
References _dbus_assert, _DBUS_POINTER_TO_INT, DBusRealHashIter::entry, DBusHashEntry::key, NULL, and DBusRealHashIter::table.
DBUS_PRIVATE_EXPORT const char * _dbus_hash_iter_get_string_key | ( | DBusHashIter * | iter | ) |
Gets the key for the current entry.
Only works for hash tables of type DBUS_HASH_STRING
iter | the hash table iterator. |
Definition at line 703 of file dbus-hash.c.
References _dbus_assert, DBusRealHashIter::entry, DBusHashEntry::key, NULL, and DBusRealHashIter::table.
Referenced by _dbus_hash_table_to_array().
DBUS_PRIVATE_EXPORT uintptr_t _dbus_hash_iter_get_uintptr_key | ( | DBusHashIter * | iter | ) |
Gets the key for the current entry.
Only works for hash tables of type DBUS_HASH_UINTPTR.
iter | the hash table iterator. |
Definition at line 685 of file dbus-hash.c.
References _dbus_assert, DBusRealHashIter::entry, DBusHashEntry::key, NULL, and DBusRealHashIter::table.
DBUS_PRIVATE_EXPORT void * _dbus_hash_iter_get_value | ( | DBusHashIter * | iter | ) |
Gets the value of the current entry.
iter | the hash table iterator. |
Definition at line 620 of file dbus-hash.c.
References _dbus_assert, DBusRealHashIter::entry, NULL, DBusRealHashIter::table, and DBusHashEntry::value.
Referenced by _dbus_hash_table_to_array().
DBUS_PRIVATE_EXPORT void _dbus_hash_iter_init | ( | DBusHashTable * | table, |
DBusHashIter * | iter | ||
) |
Initializes a hash table iterator.
To iterate over all entries in a hash table, use the following code (the printf assumes a hash from strings to strings obviously):
The iterator is initialized pointing "one before" the first hash entry. The first call to _dbus_hash_iter_next() moves it onto the first valid entry or returns FALSE if the hash table is empty. Subsequent calls move to the next valid entry or return FALSE if there are no more entries.
Note that it is guaranteed to be safe to remove a hash entry during iteration, but it is not safe to add a hash entry.
table | the hash table to iterate over. |
iter | the iterator to initialize. |
Definition at line 524 of file dbus-hash.c.
References DBusRealHashIter::bucket, DBusRealHashIter::entry, n_entries, DBusRealHashIter::n_entries_on_init, DBusRealHashIter::next_bucket, DBusRealHashIter::next_entry, NULL, and DBusRealHashIter::table.
Referenced by _dbus_hash_table_remove_all(), and _dbus_hash_table_to_array().
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_hash_iter_lookup | ( | DBusHashTable * | table, |
void * | key, | ||
dbus_bool_t | create_if_not_found, | ||
DBusHashIter * | iter | ||
) |
A low-level but efficient interface for manipulating the hash table.
It's efficient because you can get, set, and optionally create the hash entry while only running the hash function one time.
Note that while calling _dbus_hash_iter_next() on the iterator filled in by this function may work, it's completely undefined which entries are after this iter and which are before it. So it would be silly to iterate using this iterator.
If the hash entry is created, its value will be initialized to all bits zero.
FALSE may be returned due to memory allocation failure, or because create_if_not_found was FALSE and the entry did not exist.
If create_if_not_found is TRUE, the hash table takes ownership of the key that's passed in (either using it to create the entry, or freeing it immediately).
For a hash table of type DBUS_HASH_INT, cast the int key to the key parameter using _DBUS_INT_TO_POINTER().
table | the hash table. |
key | the hash key. |
create_if_not_found | if TRUE, create the entry if it didn't exist. |
iter | the iterator to initialize. |
Definition at line 748 of file dbus-hash.c.
References _dbus_assert, DBusRealHashIter::bucket, buckets, DBusRealHashIter::entry, FALSE, find_function, free_key_function, DBusHashEntry::key, n_buckets, n_entries, DBusRealHashIter::n_entries_on_init, DBusHashEntry::next, DBusRealHashIter::next_bucket, DBusRealHashIter::next_entry, NULL, DBusRealHashIter::table, and TRUE.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_hash_iter_next | ( | DBusHashIter * | iter | ) |
Move the hash iterator forward one step, to the next hash entry.
The documentation for _dbus_hash_iter_init() explains in more detail.
iter | the iterator to move forward. |
Definition at line 550 of file dbus-hash.c.
References _dbus_assert, DBusRealHashIter::bucket, buckets, DBusRealHashIter::entry, FALSE, n_buckets, n_entries, DBusRealHashIter::n_entries_on_init, DBusHashEntry::next, DBusRealHashIter::next_bucket, DBusRealHashIter::next_entry, NULL, DBusRealHashIter::table, and TRUE.
Referenced by _dbus_hash_table_remove_all(), and _dbus_hash_table_to_array().
DBUS_PRIVATE_EXPORT void _dbus_hash_iter_remove_entry | ( | DBusHashIter * | iter | ) |
Removes the current entry from the hash table.
If a key_free_function or value_free_function was provided to _dbus_hash_table_new(), frees the key and/or value for this entry.
iter | the hash table iterator. |
Definition at line 599 of file dbus-hash.c.
References _dbus_assert, DBusRealHashIter::bucket, DBusRealHashIter::entry, NULL, and DBusRealHashIter::table.
Referenced by _dbus_hash_table_remove_all().
DBUS_PRIVATE_EXPORT void _dbus_hash_iter_set_value | ( | DBusHashIter * | iter, |
void * | value | ||
) |
Sets the value of the current entry.
If the hash table has a value_free_function it will be used to free the previous value. The hash table will own the passed-in value (it will not be copied).
iter | the hash table iterator. |
value | the new value. |
Definition at line 643 of file dbus-hash.c.
References _dbus_assert, DBusRealHashIter::entry, free_value_function, NULL, DBusRealHashIter::table, and DBusHashEntry::value.
DBUS_PRIVATE_EXPORT void _dbus_hash_table_free_preallocated_entry | ( | DBusHashTable * | table, |
DBusPreallocatedHash * | preallocated | ||
) |
Frees an opaque DBusPreallocatedHash that was not used in order to insert into the hash table.
table | the hash table |
preallocated | the preallocated data |
Definition at line 1403 of file dbus-hash.c.
References _dbus_assert, _dbus_mem_pool_dealloc(), entry_pool, and NULL.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_hash_table_from_array | ( | DBusHashTable * | table, |
char ** | array, | ||
char | delimiter | ||
) |
Imports a string array into a hash table The hash table needs to be initialized with string keys, and dbus_free() as both key and value free-function.
table | the hash table |
array | the string array to import |
delimiter | the delimiter to separate key and value |
Definition at line 1479 of file dbus-hash.c.
References _dbus_assert, _dbus_hash_table_insert_string(), _dbus_string_append(), _dbus_string_free(), _dbus_string_init(), _dbus_string_set_length(), _dbus_string_split_on_byte(), _dbus_string_steal_data(), FALSE, NULL, and TRUE.
DBUS_PRIVATE_EXPORT int _dbus_hash_table_get_n_entries | ( | DBusHashTable * | table | ) |
Gets the number of hash entries in a hash table.
table | the hash table. |
Definition at line 1461 of file dbus-hash.c.
References n_entries.
Referenced by _dbus_hash_table_to_array().
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_hash_table_insert_int | ( | DBusHashTable * | table, |
int | key, | ||
void * | value | ||
) |
Creates a hash entry with the given key and value.
The key and value are not copied; they are stored in the hash table by reference. If an entry with the given key already exists, the previous key and value are overwritten (and freed if the hash table has a key_free_function and/or value_free_function).
Returns FALSE if memory for the new hash entry can't be allocated.
table | the hash table. |
key | the hash entry key. |
value | the hash entry value. |
Definition at line 1312 of file dbus-hash.c.
References _dbus_assert, _DBUS_INT_TO_POINTER, DBUS_HASH_INT, FALSE, find_function, free_key_function, free_value_function, DBusHashEntry::key, key_type, NULL, TRUE, and DBusHashEntry::value.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_hash_table_insert_string | ( | DBusHashTable * | table, |
char * | key, | ||
void * | value | ||
) |
Creates a hash entry with the given key and value.
The key and value are not copied; they are stored in the hash table by reference. If an entry with the given key already exists, the previous key and value are overwritten (and freed if the hash table has a key_free_function and/or value_free_function).
Returns FALSE if memory for the new hash entry can't be allocated.
table | the hash table. |
key | the hash entry key. |
value | the hash entry value. |
Definition at line 1278 of file dbus-hash.c.
References _dbus_assert, _dbus_hash_table_insert_string_preallocated(), _dbus_hash_table_preallocate_entry(), DBUS_HASH_STRING, FALSE, key_type, NULL, and TRUE.
Referenced by _dbus_hash_table_from_array(), _dbus_user_database_lookup(), and _dbus_user_database_lookup_group().
DBUS_PRIVATE_EXPORT void _dbus_hash_table_insert_string_preallocated | ( | DBusHashTable * | table, |
DBusPreallocatedHash * | preallocated, | ||
char * | key, | ||
void * | value | ||
) |
Inserts a string-keyed entry into the hash table, using a preallocated data block from _dbus_hash_table_preallocate_entry().
This function cannot fail due to lack of memory. The DBusPreallocatedHash object is consumed and should not be reused or freed. Otherwise this function works just like _dbus_hash_table_insert_string().
table | the hash table |
preallocated | the preallocated data |
key | the hash key |
value | the value |
Definition at line 1430 of file dbus-hash.c.
References _dbus_assert, DBUS_HASH_STRING, find_function, free_key_function, free_value_function, DBusHashEntry::key, key_type, NULL, TRUE, and DBusHashEntry::value.
Referenced by _dbus_hash_table_insert_string().
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_hash_table_insert_uintptr | ( | DBusHashTable * | table, |
uintptr_t | key, | ||
void * | value | ||
) |
Creates a hash entry with the given key and value.
The key and value are not copied; they are stored in the hash table by reference. If an entry with the given key already exists, the previous key and value are overwritten (and freed if the hash table has a key_free_function and/or value_free_function).
Returns FALSE if memory for the new hash entry can't be allocated.
table | the hash table. |
key | the hash entry key. |
value | the hash entry value. |
Definition at line 1353 of file dbus-hash.c.
References _dbus_assert, DBUS_HASH_UINTPTR, FALSE, find_function, free_key_function, free_value_function, DBusHashEntry::key, key_type, NULL, TRUE, and DBusHashEntry::value.
Referenced by _dbus_user_database_lookup(), and _dbus_user_database_lookup_group().
DBUS_PRIVATE_EXPORT void * _dbus_hash_table_lookup_int | ( | DBusHashTable * | table, |
int | key | ||
) |
Looks up the value for a given integer in a hash table of type DBUS_HASH_INT.
Returns NULL if the value is not present. (A not-present entry is indistinguishable from an entry with a value of NULL.)
table | the hash table. |
key | the integer to look up. |
Definition at line 1138 of file dbus-hash.c.
References _dbus_assert, _DBUS_INT_TO_POINTER, DBUS_HASH_INT, FALSE, find_function, key_type, NULL, and DBusHashEntry::value.
Referenced by _dbus_connection_queue_received_message_link(), and dbus_connection_dispatch().
DBUS_PRIVATE_EXPORT void * _dbus_hash_table_lookup_string | ( | DBusHashTable * | table, |
const char * | key | ||
) |
Looks up the value for a given string in a hash table of type DBUS_HASH_STRING.
Returns NULL if the value is not present. (A not-present entry is indistinguishable from an entry with a value of NULL.)
table | the hash table. |
key | the string to look up. |
Definition at line 1113 of file dbus-hash.c.
References _dbus_assert, DBUS_HASH_STRING, FALSE, find_function, key_type, NULL, and DBusHashEntry::value.
Referenced by _dbus_user_database_lookup(), and _dbus_user_database_lookup_group().
DBUS_PRIVATE_EXPORT void * _dbus_hash_table_lookup_uintptr | ( | DBusHashTable * | table, |
uintptr_t | key | ||
) |
Looks up the value for a given integer in a hash table of type DBUS_HASH_UINTPTR.
Returns NULL if the value is not present. (A not-present entry is indistinguishable from an entry with a value of NULL.)
table | the hash table. |
key | the integer to look up. |
Definition at line 1163 of file dbus-hash.c.
References _dbus_assert, DBUS_HASH_UINTPTR, FALSE, find_function, key_type, NULL, and DBusHashEntry::value.
Referenced by _dbus_user_database_lookup(), and _dbus_user_database_lookup_group().
DBUS_PRIVATE_EXPORT DBusHashTable * _dbus_hash_table_new | ( | DBusHashType | type, |
DBusFreeFunction | key_free_function, | ||
DBusFreeFunction | value_free_function | ||
) |
Constructs a new hash table.
Should be freed with _dbus_hash_table_unref(). If memory cannot be allocated for the hash table, returns NULL.
type | the type of hash key to use. |
key_free_function | function to free hash keys. |
value_free_function | function to free hash values. |
Definition at line 292 of file dbus-hash.c.
References _dbus_assert, _dbus_assert_not_reached, _dbus_mem_pool_new(), _DBUS_N_ELEMENTS, buckets, dbus_free(), DBUS_HASH_INT, DBUS_HASH_STRING, DBUS_HASH_UINTPTR, dbus_new0, DBUS_SMALL_HASH_TABLE, down_shift, entry_pool, find_function, free_key_function, free_value_function, hi_rebuild_size, key_type, lo_rebuild_size, mask, n_buckets, n_entries, NULL, REBUILD_MULTIPLIER, refcount, static_buckets, and TRUE.
Referenced by _dbus_connection_new_for_transport(), and _dbus_user_database_new().
DBUS_PRIVATE_EXPORT DBusPreallocatedHash * _dbus_hash_table_preallocate_entry | ( | DBusHashTable * | table | ) |
Preallocate an opaque data blob that allows us to insert into the hash table at a later time without allocating any memory.
table | the hash table |
Definition at line 1386 of file dbus-hash.c.
Referenced by _dbus_hash_table_insert_string().
DBUS_PRIVATE_EXPORT DBusHashTable * _dbus_hash_table_ref | ( | DBusHashTable * | table | ) |
Increments the reference count for a hash table.
table | the hash table to add a reference to. |
Definition at line 354 of file dbus-hash.c.
References refcount.
void _dbus_hash_table_remove_all | ( | DBusHashTable * | table | ) |
Removed all entries from a hash table.
table | the hash table to remove all entries from. |
Definition at line 425 of file dbus-hash.c.
References _dbus_hash_iter_init(), _dbus_hash_iter_next(), and _dbus_hash_iter_remove_entry().
Referenced by _dbus_user_database_flush().
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_hash_table_remove_int | ( | DBusHashTable * | table, |
int | key | ||
) |
Removes the hash entry for the given key.
If no hash entry for the key exists, does nothing.
table | the hash table. |
key | the hash key. |
Definition at line 1215 of file dbus-hash.c.
References _dbus_assert, _DBUS_INT_TO_POINTER, DBUS_HASH_INT, FALSE, find_function, key_type, NULL, and TRUE.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_hash_table_remove_string | ( | DBusHashTable * | table, |
const char * | key | ||
) |
Removes the hash entry for the given key.
If no hash entry for the key exists, does nothing.
table | the hash table. |
key | the hash key. |
Definition at line 1187 of file dbus-hash.c.
References _dbus_assert, DBUS_HASH_STRING, FALSE, find_function, key_type, NULL, and TRUE.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_hash_table_remove_uintptr | ( | DBusHashTable * | table, |
uintptr_t | key | ||
) |
Removes the hash entry for the given key.
If no hash entry for the key exists, does nothing.
table | the hash table. |
key | the hash key. |
Definition at line 1243 of file dbus-hash.c.
References _dbus_assert, DBUS_HASH_UINTPTR, FALSE, find_function, key_type, NULL, and TRUE.
Referenced by _dbus_user_database_lookup(), and _dbus_user_database_lookup_group().
DBUS_PRIVATE_EXPORT char ** _dbus_hash_table_to_array | ( | DBusHashTable * | table, |
char | delimiter | ||
) |
Creates a string array from a hash table.
table | the hash table |
delimiter | the delimiter to join key and value |
Definition at line 1544 of file dbus-hash.c.
References _dbus_assert, _dbus_hash_iter_get_string_key(), _dbus_hash_iter_get_value(), _dbus_hash_iter_init(), _dbus_hash_iter_next(), _dbus_hash_table_get_n_entries(), _dbus_string_append_printf(), _dbus_string_free(), _dbus_string_init(), _dbus_string_steal_data(), dbus_free_string_array(), dbus_new0, and NULL.
DBUS_PRIVATE_EXPORT void _dbus_hash_table_unref | ( | DBusHashTable * | table | ) |
Decrements the reference count for a hash table, freeing the hash table if the count reaches zero.
table | the hash table to remove a reference from. |
Definition at line 368 of file dbus-hash.c.
References _dbus_mem_pool_free(), buckets, dbus_free(), entry_pool, n_buckets, DBusHashEntry::next, NULL, refcount, and static_buckets.
Referenced by _dbus_connection_new_for_transport(), and _dbus_user_database_unref().