Changeset 5e801dc in mainline for kernel/generic/src

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:

kernel/generic/src

Files:

• adt/hash_table.c (modified) (3 diffs)
• cap/cap.c (modified) (1 diff)
• ddi/irq.c (modified) (3 diffs)
• lib/ra.c (modified) (1 diff)

kernel/generic/src/adt/hash_table.c

@@ -51 +51 @@
 #include <adt/hash_table.h>
 #include <adt/list.h>
+#include <assert.h>
 #include <stdlib.h>
-#include <assert.h>
 #include <str.h>
 
@@ -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);
@@ -306 +306 @@
  * @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);

kernel/generic/src/cap/cap.c

@@ -101 +101 @@
 }
 
-static size_t caps_key_hash(void *key)
-{
-        cap_handle_t *handle = (cap_handle_t *) key;
+static size_t caps_key_hash(const void *key)
+{
+        const cap_handle_t *handle = key;
         return hash_mix(cap_handle_raw(*handle));
 }
 
-static bool caps_key_equal(void *key, const ht_link_t *item)
-{
-        cap_handle_t *handle = (cap_handle_t *) key;
+static bool caps_key_equal(const void *key, const ht_link_t *item)
+{
+        const cap_handle_t *handle = key;
         cap_t *cap = hash_table_get_inst(item, cap_t, caps_link);
         return *handle == cap->handle;

kernel/generic/src/ddi/irq.c

@@ -73 +73 @@
 
 static size_t irq_ht_hash(const ht_link_t *);
-static size_t irq_ht_key_hash(void *);
+static size_t irq_ht_key_hash(const void *);
 static bool irq_ht_equal(const ht_link_t *, const ht_link_t *);
-static bool irq_ht_key_equal(void *, const ht_link_t *);
+static bool irq_ht_key_equal(const void *, const ht_link_t *);
 
 static hash_table_ops_t irq_ht_ops = {
@@ -208 +208 @@
 
 /** Return the hash of the key. */
-size_t irq_ht_key_hash(void *key)
-{
-        inr_t *inr = (inr_t *) key;
+size_t irq_ht_key_hash(const void *key)
+{
+        const inr_t *inr = key;
         return hash_mix(*inr);
 }
@@ -223 +223 @@
 
 /** Return true if the key is equal to the item's lookup key. */
-bool irq_ht_key_equal(void *key, const ht_link_t *item)
-{
-        inr_t *inr = (inr_t *) key;
+bool irq_ht_key_equal(const void *key, const ht_link_t *item)
+{
+        const inr_t *inr = key;
         irq_t *irq = hash_table_get_inst(item, irq_t, link);
         return irq->inr == *inr;

kernel/generic/src/lib/ra.c

@@ -67 +67 @@
 
 /** Return the hash of the key */
-static size_t used_key_hash(void *key)
-{
-        uintptr_t *base = (uintptr_t *) key;
+static size_t used_key_hash(const void *key)
+{
+        const uintptr_t *base = key;
         return hash_mix(*base);
 }
 
 /** Return true if the key is equal to the item's lookup key */
-static bool used_key_equal(void *key, const ht_link_t *item)
-{
-        uintptr_t *base = (uintptr_t *) key;
+static bool used_key_equal(const void *key, const ht_link_t *item)
+{
+        const uintptr_t *base = key;
         ra_segment_t *seg = hash_table_get_inst(item, ra_segment_t, uh_link);
         return seg->base == *base;