libbpf hashmap: fix undefined behavior in hash_bits
Subsystems (4)
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
@@ -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
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.
Signed-off-by Ian Rogers <[email protected]>---
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@@ -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
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
Signed-off-by Ian Rogers <[email protected]>---
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, becausemap->bucketswill 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@@ -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
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
Signed-off-by Ian Rogers <[email protected]>---
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, becausemap->bucketswill 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,
IanQuoted 19 lines
Quoted 19 lines
tools/lib/bpf/hashmap.h | 2 ++ 1 file changed, 2 insertions(+)tools/lib/bpf/hashmap.h +2
-1@@ -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