batman-adv: Reduce tt_local hash refcnt only for removed entry [Linux 3.16.72]

This Linux kernel change "batman-adv: Reduce tt_local hash refcnt only for removed entry" is included in the Linux 3.16.72 release. This change is authored by Sven Eckelmann <sven [at] narfation.org> on Sat Feb 23 14:27:10 2019 +0100. The commit for this change in Linux stable tree is 9197085 (patch) which is from upstream commit 3d65b9a. The same Linux upstream change may have been applied to various maintained Linux releases and you can find all Linux releases containing changes from upstream 3d65b9a.

batman-adv: Reduce tt_local hash refcnt only for removed entry

commit 3d65b9accab4a7ed5038f6df403fbd5e298398c7 upstream.

The batadv_hash_remove is a function which searches the hashtable for an
entry using a needle, a hashtable bucket selection function and a compare
function. It will lock the bucket list and delete an entry when the compare
function matches it with the needle. It returns the pointer to the
hlist_node which matches or NULL when no entry matches the needle.

The batadv_tt_local_remove is not itself protected in anyway to avoid that
any other function is modifying the hashtable between the search for the
entry and the call to batadv_hash_remove. It can therefore happen that the
entry either doesn't exist anymore or an entry was deleted which is not the
same object as the needle. In such an situation, the reference counter (for
the reference stored in the hashtable) must not be reduced for the needle.
Instead the reference counter of the actually removed entry has to be
reduced.

Otherwise the reference counter will underflow and the object might be
freed before all its references were dropped. The kref helpers reported
this problem as:

  refcount_t: underflow; use-after-free.

Fixes: ef72706a0543 ("batman-adv: protect tt_local_entry from concurrent delete events")
Signed-off-by: Sven Eckelmann <[email protected]>
Signed-off-by: Simon Wunderlich <[email protected]>
[bwh: Backported to 3.16: adjust context]
Signed-off-by: Ben Hutchings <[email protected]>

There are 14 lines of Linux source code added/deleted in this change. Code changes to Linux kernel are as follows.

 net/batman-adv/translation-table.c | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/net/batman-adv/translation-table.c b/net/batman-adv/translation-table.c
index c9ac7d9..64efccf 100644
--- a/net/batman-adv/translation-table.c
+++ b/net/batman-adv/translation-table.c
@@ -1021,9 +1021,10 @@ uint16_t batadv_tt_local_remove(struct batadv_priv *bat_priv,
                const uint8_t *addr, unsigned short vid,
                const char *message, bool roaming)
 {
+   struct batadv_tt_local_entry *tt_removed_entry;
    struct batadv_tt_local_entry *tt_local_entry;
    uint16_t flags, curr_flags = BATADV_NO_FLAGS;
-   void *tt_entry_exists;
+   struct hlist_node *tt_removed_node;

    tt_local_entry = batadv_tt_local_hash_find(bat_priv, addr, vid);
    if (!tt_local_entry)
@@ -1052,15 +1053,18 @@ uint16_t batadv_tt_local_remove(struct batadv_priv *bat_priv,
     */
    batadv_tt_local_event(bat_priv, tt_local_entry, BATADV_TT_CLIENT_DEL);

-   tt_entry_exists = batadv_hash_remove(bat_priv->tt.local_hash,
+   tt_removed_node = batadv_hash_remove(bat_priv->tt.local_hash,
                         batadv_compare_tt,
                         batadv_choose_tt,
                         &tt_local_entry->common);
-   if (!tt_entry_exists)
+   if (!tt_removed_node)
        goto out;

-   /* extra call to free the local tt entry */
-   batadv_tt_local_entry_free_ref(tt_local_entry);
+   /* drop reference of remove hash entry */
+   tt_removed_entry = hlist_entry(tt_removed_node,
+                      struct batadv_tt_local_entry,
+                      common.hash_entry);
+   batadv_tt_local_entry_free_ref(tt_removed_entry);

 out:
    if (tt_local_entry)

Leave a Reply

Your email address will not be published. Required fields are marked *