Changeset 5e801dc in mainline for uspace/lib

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.

Location:

uspace/lib

Files:

• block/block.c (modified) (2 diffs)
• c/generic/adt/hash_table.c (modified) (2 diffs)
• c/generic/async/ports.c (modified) (4 diffs)
• c/generic/async/server.c (modified) (4 diffs)
• c/include/adt/hash_table.h (modified) (3 diffs)
• ext4/src/ops.c (modified) (2 diffs)
• nic/src/nic_addr_db.c (modified) (2 diffs)
• nic/src/nic_wol_virtues.c (modified) (2 diffs)

uspace/lib/block/block.c

@@ -241 +241 @@
 }
 
-static size_t cache_key_hash(void *key)
-{
-        aoff64_t *lba = (aoff64_t *)key;
+static size_t cache_key_hash(const void *key)
+{
+        const aoff64_t *lba = key;
         return *lba;
 }
@@ -253 +253 @@
 }
 
-static bool cache_key_equal(void *key, const ht_link_t *item)
-{
-        aoff64_t *lba = (aoff64_t *)key;
+static bool cache_key_equal(const void *key, const ht_link_t *item)
+{
+        const aoff64_t *lba = key;
         block_t *b = hash_table_get_inst(item, block_t, hash_link);
         return b->lba == *lba;

uspace/lib/c/generic/adt/hash_table.c

@@ -245 +245 @@
  *
  */
-ht_link_t *hash_table_find(const hash_table_t *h, void *key)
+ht_link_t *hash_table_find(const hash_table_t *h, const void *key)
 {
         assert(h && h->bucket);
@@ -303 +303 @@
  * @param key  Array of keys that will be compared against items of
  *             the hash table.
- * @param keys Number of keys in the 'key' array.
  *
  * @return Returns the number of removed items.
  */
-size_t hash_table_remove(hash_table_t *h, void *key)
+size_t hash_table_remove(hash_table_t *h, const void *key)
 {
         assert(h && h->bucket);

uspace/lib/c/generic/async/ports.c

@@ -103 +103 @@
 static hash_table_t interface_hash_table;
 
-static size_t interface_key_hash(void *key)
-{
-        iface_t iface = *(iface_t *) key;
-        return iface;
+static size_t interface_key_hash(const void *key)
+{
+        const iface_t *iface = key;
+        return *iface;
 }
 
@@ -115 +115 @@
 }
 
-static bool interface_key_equal(void *key, const ht_link_t *item)
-{
-        iface_t iface = *(iface_t *) key;
+static bool interface_key_equal(const void *key, const ht_link_t *item)
+{
+        const iface_t *iface = key;
         interface_t *interface = hash_table_get_inst(item, interface_t, link);
-        return iface == interface->iface;
+        return *iface == interface->iface;
 }
 
@@ -131 +131 @@
 };
 
-static size_t port_key_hash(void *key)
-{
-        port_id_t port_id = *(port_id_t *) key;
-        return port_id;
+static size_t port_key_hash(const void *key)
+{
+        const port_id_t *port_id = key;
+        return *port_id;
 }
 
@@ -143 +143 @@
 }
 
-static bool port_key_equal(void *key, const ht_link_t *item)
-{
-        port_id_t port_id = *(port_id_t *) key;
+static bool port_key_equal(const void *key, const ht_link_t *item)
+{
+        const port_id_t *port_id = key;
         port_t *port = hash_table_get_inst(item, port_t, link);
-        return port_id == port->id;
+        return *port_id == port->id;
 }
 

uspace/lib/c/generic/async/server.c

@@ -231 +231 @@
 static sysarg_t notification_avail = 0;
 
-static size_t client_key_hash(void *key)
-{
-        task_id_t in_task_id = *(task_id_t *) key;
-        return in_task_id;
+static size_t client_key_hash(const void *key)
+{
+        const task_id_t *in_task_id = key;
+        return *in_task_id;
 }
 
@@ -243 +243 @@
 }
 
-static bool client_key_equal(void *key, const ht_link_t *item)
-{
-        task_id_t in_task_id = *(task_id_t *) key;
+static bool client_key_equal(const void *key, const ht_link_t *item)
+{
+        const task_id_t *in_task_id = key;
         client_t *client = hash_table_get_inst(item, client_t, link);
-        return in_task_id == client->in_task_id;
+        return *in_task_id == client->in_task_id;
 }
 
@@ -490 +490 @@
 }
 
-static size_t notification_key_hash(void *key)
-{
-        sysarg_t id = *(sysarg_t *) key;
-        return id;
+static size_t notification_key_hash(const void *key)
+{
+        const sysarg_t *id = key;
+        return *id;
 }
 
@@ -503 +503 @@
 }
 
-static bool notification_key_equal(void *key, const ht_link_t *item)
-{
-        sysarg_t id = *(sysarg_t *) key;
+static bool notification_key_equal(const void *key, const ht_link_t *item)
+{
+        const sysarg_t *id = key;
         notification_t *notification =
             hash_table_get_inst(item, notification_t, htlink);
-        return id == notification->imethod;
+        return *id == notification->imethod;
 }
 

uspace/lib/c/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 *),

uspace/lib/ext4/src/ops.c

@@ -101 +101 @@
 } node_key_t;
 
-static size_t open_nodes_key_hash(void *key_arg)
-{
-        node_key_t *key = (node_key_t *)key_arg;
+static size_t open_nodes_key_hash(const void *key_arg)
+{
+        const node_key_t *key = key_arg;
         return hash_combine(key->service_id, key->index);
 }
@@ -113 +113 @@
 }
 
-static bool open_nodes_key_equal(void *key_arg, const ht_link_t *item)
-{
-        node_key_t *key = (node_key_t *)key_arg;
+static bool open_nodes_key_equal(const void *key_arg, const ht_link_t *item)
+{
+        const node_key_t *key = key_arg;
         ext4_node_t *enode = hash_table_get_inst(item, ext4_node_t, link);
 

uspace/lib/nic/src/nic_addr_db.c

@@ -62 +62 @@
 } addr_key_t;
 
-static bool nic_addr_key_equal(void *key_arg, const ht_link_t *item)
-{
-        addr_key_t *key = (addr_key_t *)key_arg;
+static bool nic_addr_key_equal(const void *key_arg, const ht_link_t *item)
+{
+        const addr_key_t *key = key_arg;
         nic_addr_entry_t *entry = member_to_inst(item, nic_addr_entry_t, link);
 
@@ -81 +81 @@
 }
 
-static size_t nic_addr_key_hash(void *k)
-{
-        addr_key_t *key = (addr_key_t *)k;
+static size_t nic_addr_key_hash(const void *k)
+{
+        const addr_key_t *key = k;
         return addr_hash(key->len, key->addr);
 }

uspace/lib/nic/src/nic_wol_virtues.c

@@ -45 +45 @@
  */
 
-static size_t nic_wv_key_hash(void *key)
-{
-        return *(nic_wv_id_t *) key;
+static size_t nic_wv_key_hash(const void *key)
+{
+        const nic_wv_id_t *k = key;
+        return *k;
 }
 
@@ -56 +57 @@
 }
 
-static bool nic_wv_key_equal(void *key, const ht_link_t *item)
-{
-        nic_wol_virtue_t *virtue = (nic_wol_virtue_t *) item;
-        return (virtue->id == *(nic_wv_id_t *) key);
+static bool nic_wv_key_equal(const void *key, const ht_link_t *item)
+{
+        const nic_wv_id_t *k = key;
+        const nic_wol_virtue_t *virtue = (const nic_wol_virtue_t *) item;
+        return (virtue->id == *k);
 }