Changeset 5e801dc in mainline for kernel/generic/include/adt/hash_table.h

Timestamp:

2019-02-25T14:42:38Z (6 years ago)

Author:

GitHub <noreply@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

a4e78743

Parents:

ee8d4d6

git-author:

Jiří Zárevúcky <zarevucky.jiri@…> (2019-02-25 14:42:38)

git-committer:

GitHub <noreply@…> (2019-02-25 14:42:38)

Message:

Indicate and enforce constness of hash table key in certain functions (#158)

The assumption here is that modifying key in the hash/equal functions in something completely unexpected, and not something you would ever want to do intentionally, so it makes sense to disallow it entirely to get that extra level of checking.

File:

• kernel/generic/include/adt/hash_table.h (modified) (3 diffs)

kernel/generic/include/adt/hash_table.h

@@ -53 +53 @@
 
         /** Returns the hash of the key. */
-        size_t (*key_hash)(void *key);
+        size_t (*key_hash)(const void *key);
 
         /** True if the items are equal (have the same lookup keys). */
@@ -59 +59 @@
 
         /** Returns true if the key is equal to the item's lookup key. */
-        bool (*key_equal)(void *key, const ht_link_t *item);
+        bool (*key_equal)(const void *key, const ht_link_t *item);
 
         /** Hash table item removal callback.
@@ -94 +94 @@
 extern void hash_table_insert(hash_table_t *, ht_link_t *);
 extern bool hash_table_insert_unique(hash_table_t *, ht_link_t *);
-extern ht_link_t *hash_table_find(const hash_table_t *, void *);
+extern ht_link_t *hash_table_find(const hash_table_t *, const void *);
 extern ht_link_t *hash_table_find_next(const hash_table_t *, ht_link_t *,
     ht_link_t *);
-extern size_t hash_table_remove(hash_table_t *, void *);
+extern size_t hash_table_remove(hash_table_t *, const void *);
 extern void hash_table_remove_item(hash_table_t *, ht_link_t *);
 extern void hash_table_apply(hash_table_t *, bool (*)(ht_link_t *, void *),