Skip to contentSkip to conversation

libbpf hashmap: fix undefined behavior in hash_bits

PATCH In review Ian Rogers 2 participants 4 messages May 8, 2020

Subsystems (4)
lore
Share & tools
lore

Ian Rogers

author
#0 lore raw

PATCH 1/1 libbpf hashmap: fix undefined behavior in hash_bits

If bits is 0, the case when the map is empty, then the >> is the size of the register which is undefined behavior - on x86 it is the same as a shift by 0. Fix by handling the 0 case explicitly.

---
 tools/lib/bpf/hashmap.h | 2 ++
 1 file changed, 2 insertions(+)
tools/lib/bpf/hashmap.h +2 -0
index d5ef212a55ba..781db653d16c 100644
@@ -19,6 +19,8 @@
 static inline size_t hash_bits(size_t h, int bits)
 {
 	/* shuffle bits and return requested number of upper bits */
+	if (bits == 0)
+		return 0;
 	return (h * 11400714819323198485llu) >> (__WORDSIZE - bits);
 }
 
Signature · 1 line
2.26.2.645.ge9eca65c58-goog
#1 lore raw
Quoted 7 lines · Ian Rogers

If bits is 0, the case when the map is empty, then the >> is the size of the register which is undefined behavior - on x86 it is the same as a shift by 0. Fix by handling the 0 case explicitly.

---

No need. The only case when bits can be 0 is when hashmap is completely empty (no elements have ever been added yet). In that case, it doesn't matter what value hash_bits() returns, hashmap__for_each_key_entry/hashmap__for_each_key_entry_safe will behave correctly, because map->buckets will be NULL.

Quoted 19 lines
 tools/lib/bpf/hashmap.h | 2 ++
 1 file changed, 2 insertions(+)
tools/lib/bpf/hashmap.h +2 -1
index d5ef212a55ba..781db653d16c 100644
@@ -19,6 +19,8 @@
 static inline size_t hash_bits(size_t h, int bits)
 {
        /* shuffle bits and return requested number of upper bits */
+       if (bits == 0)
+               return 0;
        return (h * 11400714819323198485llu) >> (__WORDSIZE - bits);
 }
 
--

2.26.2.645.ge9eca65c58-goog

author
#2 lore raw
Quoted 7 lines · Andrii Nakryiko
Quoted 5 lines · Ian Rogers

If bits is 0, the case when the map is empty, then the >> is the size of the register which is undefined behavior - on x86 it is the same as a shift by 0. Fix by handling the 0 case explicitly.

Quoted 8 lines
Quoted 2 lines

---

No need. The only case when bits can be 0 is when hashmap is completely empty (no elements have ever been added yet). In that case, it doesn't matter what value hash_bits() returns, hashmap__for_each_key_entry/hashmap__for_each_key_entry_safe will behave correctly, because map->buckets will be NULL.

Agreed. Unfortunately the LLVM undefined behavior sanitizer (I've not tested with GCC to the same extent) will cause an exit when it sees >> 64 regardless of whether the value is used or not. It'd be possible to #ifdef this code on whether a sanitizer was present.

Thanks,
Ian

Quoted 19 lines
Quoted 19 lines
 tools/lib/bpf/hashmap.h | 2 ++
 1 file changed, 2 insertions(+)
tools/lib/bpf/hashmap.h +2 -1
index d5ef212a55ba..781db653d16c 100644
@@ -19,6 +19,8 @@
 static inline size_t hash_bits(size_t h, int bits)
 {
        /* shuffle bits and return requested number of upper bits */
+       if (bits == 0)
+               return 0;
        return (h * 11400714819323198485llu) >> (__WORDSIZE - bits);
 }
 
--

2.26.2.645.ge9eca65c58-goog

#3 lore raw
Quoted 19 lines · Ian Rogers
Quoted 7 lines · Andrii Nakryiko
Quoted 5 lines · Ian Rogers

If bits is 0, the case when the map is empty, then the >> is the size of the register which is undefined behavior - on x86 it is the same as a shift by 0. Fix by handling the 0 case explicitly.

Quoted 8 lines
Quoted 2 lines

---

No need. The only case when bits can be 0 is when hashmap is completely empty (no elements have ever been added yet). In that case, it doesn't matter what value hash_bits() returns, hashmap__for_each_key_entry/hashmap__for_each_key_entry_safe will behave correctly, because map->buckets will be NULL.

Quoted 4 lines

Agreed. Unfortunately the LLVM undefined behavior sanitizer (I've not tested with GCC to the same extent) will cause an exit when it sees >> 64 regardless of whether the value is used or not. It'd be possible to #ifdef this code on whether a sanitizer was present.

Yeah, let's do that rather than slowing down hashing function.

Quoted 23 lines

Thanks,
Ian

Quoted 19 lines
Quoted 19 lines
 tools/lib/bpf/hashmap.h | 2 ++
 1 file changed, 2 insertions(+)
tools/lib/bpf/hashmap.h +2 -1
index d5ef212a55ba..781db653d16c 100644
@@ -19,6 +19,8 @@
 static inline size_t hash_bits(size_t h, int bits)
 {
        /* shuffle bits and return requested number of upper bits */
+       if (bits == 0)
+               return 0;
        return (h * 11400714819323198485llu) >> (__WORDSIZE - bits);
 }
 
--

2.26.2.645.ge9eca65c58-goog