[src/trunk]: src/sys/net net: Fix the setting of if_link_state

[roy <roy%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/155b884fcf2d
branches:  trunk
changeset: 955307:155b884fcf2d
user:      roy <roy%NetBSD.org@localhost>
date:      Sat Sep 26 11:57:05 2020 +0000

description:
net: Fix the setting of if_link_state

Link state changes are not dependant on the interface being up, but we also
need to guard against more link state changes being scheduled when the
interface is being detached.

We do this by clearing the link queue but keeping if_link_sheduled = true.
We can check for this in both if_link_state_change() and
if_link_state_change_work() to abort early as there is no point in doing
anything if the interface is being detached because if_down() is called
in if_detach() after the workqueue has been drained to the same overall
effect.

diffstat:

 sys/net/if.c |  127 ++++++++++++++++++++++++++++++----------------------------
 sys/net/if.h |    4 +-
 2 files changed, 66 insertions(+), 65 deletions(-)

diffs (237 lines):

diff -r df4a56fe0c11 -r 155b884fcf2d sys/net/if.c
--- a/sys/net/if.c      Sat Sep 26 11:39:17 2020 +0000
+++ b/sys/net/if.c      Sat Sep 26 11:57:05 2020 +0000
@@ -1,4 +1,4 @@
-/*     $NetBSD: if.c,v 1.479 2020/07/16 15:02:08 msaitoh Exp $ */
+/*     $NetBSD: if.c,v 1.480 2020/09/26 11:57:05 roy Exp $     */
 
 /*-
  * Copyright (c) 1999, 2000, 2001, 2008 The NetBSD Foundation, Inc.
@@ -90,7 +90,7 @@
  */
 
 #include <sys/cdefs.h>
-__KERNEL_RCSID(0, "$NetBSD: if.c,v 1.479 2020/07/16 15:02:08 msaitoh Exp $");
+__KERNEL_RCSID(0, "$NetBSD: if.c,v 1.480 2020/09/26 11:57:05 roy Exp $");
 
 #if defined(_KERNEL_OPT)
 #include "opt_inet.h"
@@ -166,6 +166,20 @@
 MALLOC_DEFINE(M_IFMADDR, "ether_multi", "link-level multicast address");
 
 /*
+ * XXX reusing (ifp)->if_snd->ifq_lock rather than having another spin mutex
+ * for each ifnet.  It doesn't matter because:
+ * - if IFEF_MPSAFE is enabled, if_snd isn't used and lock contentions on
+ *   ifq_lock don't happen
+ * - if IFEF_MPSAFE is disabled, there is no lock contention on ifq_lock
+ *   because if_snd, if_link_state_change and if_link_state_change_process
+ *   are all called with KERNEL_LOCK
+ */
+#define IF_LINK_STATE_CHANGE_LOCK(ifp)         \
+       mutex_enter((ifp)->if_snd.ifq_lock)
+#define IF_LINK_STATE_CHANGE_UNLOCK(ifp)       \
+       mutex_exit((ifp)->if_snd.ifq_lock)
+
+/*
  * Global list of interfaces.
  */
 /* DEPRECATED. Remove it once kvm(3) users disappeared */
@@ -703,6 +717,7 @@
 
        ifp->if_link_state = LINK_STATE_UNKNOWN;
        ifp->if_link_queue = -1; /* all bits set, see link_state_change() */
+       ifp->if_link_scheduled = false;
 
        ifp->if_capenable = 0;
        ifp->if_csum_flags_tx = 0;
@@ -1317,7 +1332,22 @@
        s = splnet();
 
        sysctl_teardown(&ifp->if_sysctl_log);
+
        IFNET_LOCK(ifp);
+
+       /*
+        * Unset all queued link states and pretend a
+        * link state change is scheduled.
+        * This stops any more link state changes occuring for this
+        * interface while it's being detached so it's safe
+        * to drain the workqueue.
+        */
+       IF_LINK_STATE_CHANGE_LOCK(ifp);
+       ifp->if_link_queue = -1; /* all bits set, see link_state_change() */
+       ifp->if_link_scheduled = true;
+       IF_LINK_STATE_CHANGE_UNLOCK(ifp);
+       workqueue_wait(ifnet_link_state_wq, &ifp->if_link_work);
+
        if_deactivate(ifp);
        IFNET_UNLOCK(ifp);
 
@@ -2237,30 +2267,6 @@
        }
 
 /*
- * XXX reusing (ifp)->if_snd->ifq_lock rather than having another spin mutex
- * for each ifnet.  It doesn't matter because:
- * - if IFEF_MPSAFE is enabled, if_snd isn't used and lock contentions on
- *   ifq_lock don't happen
- * - if IFEF_MPSAFE is disabled, there is no lock contention on ifq_lock
- *   because if_snd, if_link_state_change and if_link_state_change_process
- *   are all called with KERNEL_LOCK
- */
-#define IF_LINK_STATE_CHANGE_LOCK(ifp)         \
-       mutex_enter((ifp)->if_snd.ifq_lock)
-#define IF_LINK_STATE_CHANGE_UNLOCK(ifp)       \
-       mutex_exit((ifp)->if_snd.ifq_lock)
-
-static void
-if_link_state_change_work_schedule(struct ifnet *ifp)
-{
-       if (ifp->if_link_cansched && !ifp->if_link_scheduled) {
-               ifp->if_link_scheduled = true;
-               workqueue_enqueue(ifnet_link_state_wq, &ifp->if_link_work,
-                   NULL);
-       }
-}
-
-/*
  * Handle a change in the interface link state and
  * queue notifications.
  */
@@ -2292,14 +2298,22 @@
        /* Find the last unset event in the queue. */
        LQ_FIND_UNSET(ifp->if_link_queue, idx);
 
-       /*
-        * Ensure link_state doesn't match the last event in the queue.
-        * ifp->if_link_state is not checked and set here because
-        * that would present an inconsistent picture to the system.
-        */
-       if (idx != 0 &&
-           LQ_ITEM(ifp->if_link_queue, idx - 1) == (uint8_t)link_state)
-               goto out;
+       if (idx == 0) {
+               /*
+                * There is no queue of link state changes.
+                * As we have the lock we can safely compare against the
+                * current link state and return if the same.
+                * Otherwise, if scheduled is true then the interface is being
+                * detached and the queue is being drained so we need
+                * to avoid queuing more work.
+                */
+                if (ifp->if_link_state == link_state || ifp->if_link_scheduled)
+                       goto out;
+       } else {
+               /* Ensure link_state doesn't match the last queued state. */
+               if (LQ_ITEM(ifp->if_link_queue, idx - 1) == (uint8_t)link_state)
+                       goto out;
+       }
 
        /* Handle queue overflow. */
        if (idx == LQ_MAX(ifp->if_link_queue)) {
@@ -2328,7 +2342,11 @@
        } else
                LQ_STORE(ifp->if_link_queue, idx, (uint8_t)link_state);
 
-       if_link_state_change_work_schedule(ifp);
+       if (ifp->if_link_scheduled)
+               goto out;
+
+       ifp->if_link_scheduled = true;
+       workqueue_enqueue(ifnet_link_state_wq, &ifp->if_link_work, NULL);
 
 out:
        IF_LINK_STATE_CHANGE_UNLOCK(ifp);
@@ -2414,27 +2432,32 @@
        struct ifnet *ifp = container_of(work, struct ifnet, if_link_work);
        int s;
        uint8_t state;
-       bool schedule;
 
        KERNEL_LOCK_UNLESS_NET_MPSAFE();
        s = splnet();
 
-       /* Pop a link state change from the queue and process it. */
+       /* Pop a link state change from the queue and process it.
+        * If there is nothing to process then if_detach() has been called.
+        * We keep if_link_scheduled = true so the queue can safely drain
+        * without more work being queued. */
        IF_LINK_STATE_CHANGE_LOCK(ifp);
-       ifp->if_link_scheduled = false;
        LQ_POP(ifp->if_link_queue, state);
        IF_LINK_STATE_CHANGE_UNLOCK(ifp);
+       if (state == LINK_STATE_UNSET)
+               goto out;
 
        if_link_state_change_process(ifp, state);
 
        /* If there is a link state change to come, schedule it. */
        IF_LINK_STATE_CHANGE_LOCK(ifp);
-       schedule = (LQ_ITEM(ifp->if_link_queue, 0) != LINK_STATE_UNSET);
+       if (LQ_ITEM(ifp->if_link_queue, 0) != LINK_STATE_UNSET) {
+               ifp->if_link_scheduled = true;
+               workqueue_enqueue(ifnet_link_state_wq, &ifp->if_link_work, NULL);
+       } else
+               ifp->if_link_scheduled = false;
        IF_LINK_STATE_CHANGE_UNLOCK(ifp);
 
-       if (schedule)
-               if_link_state_change_work_schedule(ifp);
-
+out:
        splx(s);
        KERNEL_UNLOCK_UNLESS_NET_MPSAFE();
 }
@@ -2519,22 +2542,6 @@
        pserialize_read_exit(s);
        curlwp_bindx(bound);
 
-       /*
-        * Modification of if_link_cansched is serialized with the
-        * ifnet ioctl lock.
-        *
-        * The link state change lock is taken to synchronize with the
-        * read in if_link_state_change_work_schedule().  Once we set
-        * this to false, our if_link_work won't be scheduled.  But
-        * we need to wait for our if_link_work to drain in case we
-        * lost that race.
-        */
-       IF_LINK_STATE_CHANGE_LOCK(ifp);
-       ifp->if_link_cansched = false;
-       IF_LINK_STATE_CHANGE_UNLOCK(ifp);
-
-       workqueue_wait(ifnet_link_state_wq, &ifp->if_link_work);
-
        IFQ_PURGE(&ifp->if_snd);
 #if NCARP > 0
        if (ifp->if_carp)
@@ -2607,10 +2614,6 @@
                if (dp->dom_if_up)
                        dp->dom_if_up(ifp);
        }
-
-       IF_LINK_STATE_CHANGE_LOCK(ifp);
-       ifp->if_link_cansched = true;
-       IF_LINK_STATE_CHANGE_UNLOCK(ifp);
 }
 
 /*
diff -r df4a56fe0c11 -r 155b884fcf2d sys/net/if.h
--- a/sys/net/if.h      Sat Sep 26 11:39:17 2020 +0000
+++ b/sys/net/if.h      Sat Sep 26 11:57:05 2020 +0000
@@ -1,4 +1,4 @@
-/*     $NetBSD: if.h,v 1.285 2020/09/22 14:14:17 roy Exp $     */
+/*     $NetBSD: if.h,v 1.286 2020/09/26 11:57:05 roy Exp $     */
 
 /*-
  * Copyright (c) 1999, 2000, 2001 The NetBSD Foundation, Inc.
@@ -419,8 +419,6 @@
        uint16_t        if_link_queue;  /* q: masked link state change queue */
                                        /* q: is link state work scheduled? */
        bool            if_link_scheduled;
-                                       /* q: can link state work be scheduled? */
-       bool            if_link_cansched;
        struct pslist_entry
                        if_pslist_entry;/* i: */
        struct psref_target