lib/rhashtable: fix race between rhashtable_lookup_compare and hashtable resize
Subsystems (5)
PATCH 1/1 lib/rhashtable: fix race between rhashtable_lookup_compare and hashtable resize
Hash value passed as argument into rhashtable_lookup_compare could be computed using different hash table than rhashtable_lookup_compare sees.
This patch passes key into rhashtable_lookup_compare() instead of hash and compures hash value right in place using the same table as for lookup.
Also it adds comment for rhashtable_hashfn and rhashtable_obj_hashfn:
user must prevent concurrent insert/remove otherwise returned hash value could be invalid.
--- include/linux/rhashtable.h | 2 +- lib/rhashtable.c | 12 ++++++++---- net/netlink/af_netlink.c | 5 +---- 3 files changed, 10 insertions(+), 9 deletions(-)
include/linux/rhashtable.h +1 -1
@@ -108,7 +108,7 @@ int rhashtable_expand(struct rhashtable *ht, gfp_t flags);int rhashtable_shrink (struct rhashtable *ht,gfp_t flags);void *rhashtable_lookup (const struct rhashtable *ht,const void *key); -void *rhashtable_lookup_compare (const struct rhashtable *ht,u32 hash, +void *rhashtable_lookup_compare (const struct rhashtable *ht,void *key,bool (*compare)(void *,void *),void *arg);void rhashtable_destroy (const struct rhashtable *ht);
lib/rhashtable.c +8 -4
@@ -61,6 +61,8 @@ static u32 __hashfn(const struct rhashtable *ht, const void *key,* Computes the hash value using the hash function provided in the 'hashfn' * of struct rhashtable_params. The returned value is guaranteed to be * smaller than the number of buckets in the hash table. +* +* The caller must ensure that no concurrent table mutations occur. */ u32 rhashtable_hashfn (const struct rhashtable *ht,const void *key,u32 len) {
@@ -92,6 +94,8 @@ static u32 obj_hashfn(const struct rhashtable *ht, const void *ptr, u32 hsize)* 'obj_hashfn' depending on whether the hash table is set up to work with * a fixed length key. The returned value is guaranteed to be smaller than * the number of buckets in the hash table. +* +* The caller must ensure that no concurrent table mutations occur. */ u32 rhashtable_obj_hashfn (const struct rhashtable *ht,void *ptr) {
@@ -474,7 +478,7 @@ EXPORT_SYMBOL_GPL(rhashtable_lookup);/** * rhashtable_lookup_compare - search hash table with compare function * @ht: hash table -* @hash: hash value of desired entry +* @key: pointer to key * @compare: compare function, must return true on match * @arg: argument passed on to compare function *
@@ -486,14 +490,14 @@ EXPORT_SYMBOL_GPL(rhashtable_lookup);* * Returns the first entry on which the compare function returned true. */ -void *rhashtable_lookup_compare (const struct rhashtable *ht,u32 hash, +void *rhashtable_lookup_compare (const struct rhashtable *ht,void *key,bool (*compare)(void *,void *),void *arg) {const struct bucket_table *tbl =rht_dereference_rcu (ht->tbl, ht);struct rhash_head *he; +u32 hash; -if (unlikely (hash >= tbl->size)) -return NULL ; + hash =__hashfn (ht, key, ht->p.key_len, tbl->size);rht_for_each_rcu (he, tbl->buckets[hash], ht) {if (!compare (rht_obj (ht, he), arg))
net/netlink/af_netlink.c +1 -4
@@ -1003,11 +1003,8 @@ static struct sock *__netlink_lookup(struct netlink_table *table, u32 portid, .net = net, .portid = portid, }; -u32 hash; - hash =rhashtable_hashfn (&table->hash, &portid,sizeof (portid)); - -return rhashtable_lookup_compare (&table->hash, hash, +return rhashtable_lookup_compare (&table->hash, &portid, &netlink_compare, &arg); }
Herbert Xu
maintainerQuoted 6 lines · Konstantin Khlebnikov
Hash value passed as argument into
rhashtable_lookup_comparecould be computed using different hash table thanrhashtable_lookup_comparesees.This patch passes key into
rhashtable_lookup_compare()instead of hash and compures hash value right in place using the same table as for lookup.
Quoted 8 lines
Also it adds comment for
rhashtable_hashfnandrhashtable_obj_hashfn:
user must prevent concurrent insert/remove otherwise returned hash value could be invalid.Signed-off-by Konstantin Khlebnikov <[email protected]>Fixes e341694e3eb5 ("netlink: Convert netlink_lookup() to use RCU protected hash table")Cc Stable <[email protected]> (v3.17 .. v3.19)
This could indeed explain Eric's problems with those kernels. Eric, can you rerun your test to see if this patch makes your problem go away on the pre-4.0 kernels?
Thanks!
Signature · 3 lines
Email: Herbert Xu <[email protected]> Home Page: http://gondor.apana.org.au/~herbert/ PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
Quoted 6 lines · Konstantin Khlebnikov
Hash value passed as argument into
rhashtable_lookup_comparecould be computed using different hash table thanrhashtable_lookup_comparesees.This patch passes key into
rhashtable_lookup_compare()instead of hash and compures hash value right in place using the same table as for lookup.
Quoted 8 lines
Also it adds comment for
rhashtable_hashfnandrhashtable_obj_hashfn:
user must prevent concurrent insert/remove otherwise returned hash value could be invalid.Signed-off-by Konstantin Khlebnikov <[email protected]>Fixes e341694e3eb5 ("netlink: Convert netlink_lookup() to use RCU protected hash table")Cc Stable <[email protected]> (v3.17 .. v3.19)
Nice catch.
For reference, this is a partial cherry pick of8d24c0b43125e ("rhashtable: Do hashing inside of rhashtable_lookup_compare()")
nft_hash is not affected as it doesn't use the lookup API until 4.0.
+CC Sasha Levin
FYI: this patch fixes race in netlink which leads to hung in glibc function getaddrinfo() because it doesn't handle errors at all.
Quoted 100 lines · Konstantin Khlebnikov
Hash value passed as argument into
rhashtable_lookup_comparecould be computed using different hash table thanrhashtable_lookup_comparesees.This patch passes key into
rhashtable_lookup_compare()instead of hash and compures hash value right in place using the same table as for lookup.Also it adds comment for
rhashtable_hashfnandrhashtable_obj_hashfn:
user must prevent concurrent insert/remove otherwise returned hash value could be invalid.Signed-off-by Konstantin Khlebnikov <[email protected]>Fixes e341694e3eb5 ("netlink: Convert netlink_lookup() to use RCU protected hash table")Cc Stable <[email protected]> (v3.17 .. v3.19)--- include/linux/rhashtable.h | 2 +- lib/rhashtable.c | 12 ++++++++---- net/netlink/af_netlink.c | 5 +---- 3 files changed, 10 insertions(+), 9 deletions(-)include/linux/rhashtable.h +1
-1@@ -108,7 +108,7 @@ int rhashtable_expand(struct rhashtable *ht, gfp_t flags);int rhashtable_shrink (struct rhashtable *ht,gfp_t flags);void *rhashtable_lookup (const struct rhashtable *ht,const void *key); -void *rhashtable_lookup_compare (const struct rhashtable *ht,u32 hash, +void *rhashtable_lookup_compare (const struct rhashtable *ht,void *key,bool (*compare)(void *,void *),void *arg);void rhashtable_destroy (const struct rhashtable *ht);lib/rhashtable.c +8
-4@@ -61,6 +61,8 @@ static u32 __hashfn(const struct rhashtable *ht, const void *key,* Computes the hash value using the hash function provided in the 'hashfn' * of struct rhashtable_params. The returned value is guaranteed to be * smaller than the number of buckets in the hash table. +* +* The caller must ensure that no concurrent table mutations occur. */ u32 rhashtable_hashfn (const struct rhashtable *ht,const void *key,u32 len) {@@ -92,6 +94,8 @@ static u32 obj_hashfn(const struct rhashtable *ht, const void *ptr, u32 hsize)* 'obj_hashfn' depending on whether the hash table is set up to work with * a fixed length key. The returned value is guaranteed to be smaller than * the number of buckets in the hash table. +* +* The caller must ensure that no concurrent table mutations occur. */ u32 rhashtable_obj_hashfn (const struct rhashtable *ht,void *ptr) {@@ -474,7 +478,7 @@ EXPORT_SYMBOL_GPL(rhashtable_lookup);/** * rhashtable_lookup_compare - search hash table with compare function * @ht: hash table -* @hash: hash value of desired entry +* @key: pointer to key * @compare: compare function, must return true on match * @arg: argument passed on to compare function * @@ -486,14 +490,14 @@ EXPORT_SYMBOL_GPL(rhashtable_lookup);* * Returns the first entry on which the compare function returned true. */ -void *rhashtable_lookup_compare (const struct rhashtable *ht,u32 hash, +void *rhashtable_lookup_compare (const struct rhashtable *ht,void *key,bool (*compare)(void *,void *),void *arg) {const struct bucket_table *tbl =rht_dereference_rcu (ht->tbl, ht);struct rhash_head *he; +u32 hash; -if (unlikely (hash >= tbl->size)) -return NULL ; + hash =__hashfn (ht, key, ht->p.key_len, tbl->size);rht_for_each_rcu (he, tbl->buckets[hash], ht) {if (!compare (rht_obj (ht, he), arg))net/netlink/af_netlink.c +1
-4@@ -1003,11 +1003,8 @@ static struct sock *__netlink_lookup(struct netlink_table *table, u32 portid, .net = net, .portid = portid, }; -u32 hash; - hash =rhashtable_hashfn (&table->hash, &portid,sizeof (portid)); - -return rhashtable_lookup_compare (&table->hash, hash, +return rhashtable_lookup_compare (&table->hash, &portid, &netlink_compare, &arg); }
Signature · 1 line
Konstantin