[PATCH v1] driver core: Allow device link operations inside sync_state()

[PATCH v1] driver core: Allow device link operations inside sync_state()

[Saravana Kannan]

Some sync_state() implementations might need to call APIs that in turn
make calls to device link APIs. So, do the sync_state() callbacks
without holding the device link lock.

Signed-off-by: Saravana Kannan <saravanak@google.com>
---
 drivers/base/core.c | 63 +++++++++++++++++++++++++++++++++++++++------
 1 file changed, 55 insertions(+), 8 deletions(-)

diff --git a/drivers/base/core.c b/drivers/base/core.c
index e6d3e6d485da..d396b0597c10 100644
--- a/drivers/base/core.c
+++ b/drivers/base/core.c
@@ -48,6 +48,8 @@ early_param("sysfs.deprecated", sysfs_deprecated_setup);
 static LIST_HEAD(wait_for_suppliers);
 static DEFINE_MUTEX(wfs_lock);
 static LIST_HEAD(deferred_sync);
+static LIST_HEAD(sync_list);
+static DEFINE_MUTEX(sync_lock);
 static unsigned int defer_sync_state_count = 1;
 
 #ifdef CONFIG_SRCU
@@ -695,7 +697,23 @@ int device_links_check_suppliers(struct device *dev)
 	return ret;
 }
 
-static void __device_links_supplier_sync_state(struct device *dev)
+/** __device_links_queue_sync_state - Queue a device for sync_state() callback
+ * @dev: Device to call sync_state() on
+ *
+ * Queues a device for a sync_state() callback when the device links write lock
+ * isn't held. This allows the sync_state() execution flow to use device links
+ * APIs.  The caller must ensure this function is called with
+ * device_links_write_lock() held.
+ *
+ * This function does a get_device() to make sure the device is not freed while
+ * on this list.
+ *
+ * So the caller must also ensure that device_links_flush_sync_list() is called
+ * as soon as the caller releases device_links_write_lock().  This is necessary
+ * to make sure the sync_state() is called in a timely fashion and the
+ * put_device() is called on this device.
+ */
+static void __device_links_queue_sync_state(struct device *dev)
 {
 	struct device_link *link;
 
@@ -709,12 +727,35 @@ static void __device_links_supplier_sync_state(struct device *dev)
 			return;
 	}
 
-	if (dev->bus->sync_state)
-		dev->bus->sync_state(dev);
-	else if (dev->driver && dev->driver->sync_state)
-		dev->driver->sync_state(dev);
-
 	dev->state_synced = true;
+
+	mutex_lock(&sync_lock);
+	WARN_ON(!list_empty(&dev->links.defer_sync));
+	if (list_empty(&dev->links.defer_sync)) {
+		get_device(dev);
+		list_add_tail(&dev->links.defer_sync, &sync_list);
+	}
+	mutex_unlock(&sync_lock);
+}
+
+static void device_links_flush_sync_list(void)
+{
+	struct device *dev, *tmp;
+
+	mutex_lock(&sync_lock);
+
+	list_for_each_entry_safe(dev, tmp, &sync_list, links.defer_sync) {
+		list_del_init(&dev->links.defer_sync);
+		device_lock(dev);
+		if (dev->bus->sync_state)
+			dev->bus->sync_state(dev);
+		else if (dev->driver && dev->driver->sync_state)
+			dev->driver->sync_state(dev);
+		device_unlock(dev);
+		put_device(dev);
+	}
+
+	mutex_unlock(&sync_lock);
 }
 
 void device_links_supplier_sync_state_pause(void)
@@ -738,11 +779,16 @@ void device_links_supplier_sync_state_resume(void)
 		goto out;
 
 	list_for_each_entry_safe(dev, tmp, &deferred_sync, links.defer_sync) {
-		__device_links_supplier_sync_state(dev);
+		/*
+		 * Delete from deferred_sync list before queuing it to
+		 * sync_list because defer_sync is used for both lists.
+		 */
 		list_del_init(&dev->links.defer_sync);
+		__device_links_queue_sync_state(dev);
 	}
 out:
 	device_links_write_unlock();
+	device_links_flush_sync_list();
 }
 
 static int sync_state_resume_initcall(void)
@@ -815,12 +861,13 @@ void device_links_driver_bound(struct device *dev)
 		if (defer_sync_state_count)
 			__device_links_supplier_defer_sync(link->supplier);
 		else
-			__device_links_supplier_sync_state(link->supplier);
+			__device_links_queue_sync_state(link->supplier);
 	}
 
 	dev->links.status = DL_DEV_DRIVER_BOUND;
 
 	device_links_write_unlock();
+	device_links_flush_sync_list();
 }
 
 static void device_link_drop_managed(struct device_link *link)
-- 
2.24.0.rc1.363.gb1bccd3e3d-goog

[PATCH v1] driver core: Clarify documentation for fwnode_operations.add_links()

[Saravana Kannan]

The wording was a bit ambiguous. So update it to make it clear.

Signed-off-by: Saravana Kannan <saravanak@google.com>
---
 include/linux/fwnode.h | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
index 766ff9bb5876..23df37f85398 100644
--- a/include/linux/fwnode.h
+++ b/include/linux/fwnode.h
@@ -94,15 +94,16 @@ struct fwnode_reference_args {
  *		available suppliers.
  *
  *		Return 0 if device links have been successfully created to all
- *		the suppliers this device needs to create device links to or if
- *		the supplier information is not known.
+ *		the known suppliers of this device or if the supplier
+ *		information is not known.
  *
- *		Return -ENODEV if and only if the suppliers needed for probing
- *		the device are not yet available to create device links to.
+ *		Return -ENODEV if the suppliers needed for probing this device
+ *		have not been registered yet (because device links can only be
+ *		created to devices registered with the driver core).
  *
- *		Return -EAGAIN if there are suppliers that need to be linked to
- *		that are not yet available but none of those suppliers are
- *		necessary for probing this device.
+ *		Return -EAGAIN if some of the suppliers of this device have not
+ *		been registered yet, but none of those suppliers are necessary
+ *		for probing the device.
  */
 struct fwnode_operations {
 	struct fwnode_handle *(*get)(struct fwnode_handle *fwnode);
-- 
2.24.0.rc1.363.gb1bccd3e3d-goog

Re: [PATCH v1] driver core: Clarify documentation for fwnode_operations.add_links()

[Rafael J. Wysocki]

On Wed, Nov 13, 2019 at 3:36 AM Saravana Kannan <saravanak@google.com> wrote:
>
> The wording was a bit ambiguous. So update it to make it clear.
>
> Signed-off-by: Saravana Kannan <saravanak@google.com>

Looks better with this change IMO:

Reviewed-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

> ---
>  include/linux/fwnode.h | 15 ++++++++-------
>  1 file changed, 8 insertions(+), 7 deletions(-)
>
> diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
> index 766ff9bb5876..23df37f85398 100644
> --- a/include/linux/fwnode.h
> +++ b/include/linux/fwnode.h
> @@ -94,15 +94,16 @@ struct fwnode_reference_args {
>   *             available suppliers.
>   *
>   *             Return 0 if device links have been successfully created to all
> - *             the suppliers this device needs to create device links to or if
> - *             the supplier information is not known.
> + *             the known suppliers of this device or if the supplier
> + *             information is not known.
>   *
> - *             Return -ENODEV if and only if the suppliers needed for probing
> - *             the device are not yet available to create device links to.
> + *             Return -ENODEV if the suppliers needed for probing this device
> + *             have not been registered yet (because device links can only be
> + *             created to devices registered with the driver core).
>   *
> - *             Return -EAGAIN if there are suppliers that need to be linked to
> - *             that are not yet available but none of those suppliers are
> - *             necessary for probing this device.
> + *             Return -EAGAIN if some of the suppliers of this device have not
> + *             been registered yet, but none of those suppliers are necessary
> + *             for probing the device.
>   */
>  struct fwnode_operations {
>         struct fwnode_handle *(*get)(struct fwnode_handle *fwnode);
> --
> 2.24.0.rc1.363.gb1bccd3e3d-goog
>

Re: [PATCH v1] driver core: Allow device link operations inside sync_state()

[Rafael J. Wysocki]

On Wed, Nov 13, 2019 at 3:36 AM Saravana Kannan <saravanak@google.com> wrote:
>
> Some sync_state() implementations might need to call APIs that in turn
> make calls to device link APIs. So, do the sync_state() callbacks
> without holding the device link lock.
>
> Signed-off-by: Saravana Kannan <saravanak@google.com>
> ---
>  drivers/base/core.c | 63 +++++++++++++++++++++++++++++++++++++++------
>  1 file changed, 55 insertions(+), 8 deletions(-)
>
> diff --git a/drivers/base/core.c b/drivers/base/core.c
> index e6d3e6d485da..d396b0597c10 100644
> --- a/drivers/base/core.c
> +++ b/drivers/base/core.c
> @@ -48,6 +48,8 @@ early_param("sysfs.deprecated", sysfs_deprecated_setup);
>  static LIST_HEAD(wait_for_suppliers);
>  static DEFINE_MUTEX(wfs_lock);
>  static LIST_HEAD(deferred_sync);
> +static LIST_HEAD(sync_list);
> +static DEFINE_MUTEX(sync_lock);
>  static unsigned int defer_sync_state_count = 1;
>
>  #ifdef CONFIG_SRCU
> @@ -695,7 +697,23 @@ int device_links_check_suppliers(struct device *dev)
>         return ret;
>  }
>
> -static void __device_links_supplier_sync_state(struct device *dev)
> +/** __device_links_queue_sync_state - Queue a device for sync_state() callback
> + * @dev: Device to call sync_state() on
> + *
> + * Queues a device for a sync_state() callback when the device links write lock
> + * isn't held. This allows the sync_state() execution flow to use device links
> + * APIs.  The caller must ensure this function is called with
> + * device_links_write_lock() held.
> + *
> + * This function does a get_device() to make sure the device is not freed while
> + * on this list.
> + *
> + * So the caller must also ensure that device_links_flush_sync_list() is called
> + * as soon as the caller releases device_links_write_lock().  This is necessary
> + * to make sure the sync_state() is called in a timely fashion and the
> + * put_device() is called on this device.
> + */
> +static void __device_links_queue_sync_state(struct device *dev)
>  {
>         struct device_link *link;
>
> @@ -709,12 +727,35 @@ static void __device_links_supplier_sync_state(struct device *dev)
>                         return;
>         }
>
> -       if (dev->bus->sync_state)
> -               dev->bus->sync_state(dev);
> -       else if (dev->driver && dev->driver->sync_state)
> -               dev->driver->sync_state(dev);
> -
>         dev->state_synced = true;
> +
> +       mutex_lock(&sync_lock);

Total nit: I add empty lines around lock/unlock as a rule to make them
more visible.

> +       WARN_ON(!list_empty(&dev->links.defer_sync));
> +       if (list_empty(&dev->links.defer_sync)) {

Do you really need to duplicate that check?

> +               get_device(dev);
> +               list_add_tail(&dev->links.defer_sync, &sync_list);
> +       }
> +       mutex_unlock(&sync_lock);
> +}

What about adding

} else {
        WARN_ON(1);
}

here instead?

> +

Kerneldoc?

> +static void device_links_flush_sync_list(void)
> +{
> +       struct device *dev, *tmp;
> +
> +       mutex_lock(&sync_lock);
> +
> +       list_for_each_entry_safe(dev, tmp, &sync_list, links.defer_sync) {
> +               list_del_init(&dev->links.defer_sync);
> +               device_lock(dev);
> +               if (dev->bus->sync_state)
> +                       dev->bus->sync_state(dev);
> +               else if (dev->driver && dev->driver->sync_state)
> +                       dev->driver->sync_state(dev);
> +               device_unlock(dev);
> +               put_device(dev);
> +       }
> +
> +       mutex_unlock(&sync_lock);
>  }
>
>  void device_links_supplier_sync_state_pause(void)
> @@ -738,11 +779,16 @@ void device_links_supplier_sync_state_resume(void)
>                 goto out;
>
>         list_for_each_entry_safe(dev, tmp, &deferred_sync, links.defer_sync) {
> -               __device_links_supplier_sync_state(dev);
> +               /*
> +                * Delete from deferred_sync list before queuing it to
> +                * sync_list because defer_sync is used for both lists.
> +                */
>                 list_del_init(&dev->links.defer_sync);
> +               __device_links_queue_sync_state(dev);
>         }
>  out:
>         device_links_write_unlock();
> +       device_links_flush_sync_list();

Wouldn't it be better to use a local list in this function instead of
the global sync_list?

I guess the idea is that you wouldn't be able to do the flush in
device_links_driver_bound() below, but do you really need that flush?

It looks like this is the only place calling
__device_links_queue_sync_state() and you do a flush right away after
the loop, so why is the extra flush in device_links_driver_bound()
needed?

>  }
>
>  static int sync_state_resume_initcall(void)
> @@ -815,12 +861,13 @@ void device_links_driver_bound(struct device *dev)
>                 if (defer_sync_state_count)
>                         __device_links_supplier_defer_sync(link->supplier);
>                 else
> -                       __device_links_supplier_sync_state(link->supplier);
> +                       __device_links_queue_sync_state(link->supplier);
>         }
>
>         dev->links.status = DL_DEV_DRIVER_BOUND;
>
>         device_links_write_unlock();
> +       device_links_flush_sync_list();

It looks like devices can be added to sync_list in parallel with each
other and so is it always OK to always flush all of them after one of
them has been bound to a driver?

>  }
>
>  static void device_link_drop_managed(struct device_link *link)
> --

Re: [PATCH v1] driver core: Allow device link operations inside sync_state()

[Rafael J. Wysocki]

On Wed, Nov 13, 2019 at 3:36 AM Saravana Kannan <saravanak@google.com> wrote:
>
> Some sync_state() implementations might need to call APIs that in turn
> make calls to device link APIs. So, do the sync_state() callbacks
> without holding the device link lock.
>
> Signed-off-by: Saravana Kannan <saravanak@google.com>
> ---
>  drivers/base/core.c | 63 +++++++++++++++++++++++++++++++++++++++------
>  1 file changed, 55 insertions(+), 8 deletions(-)
>
> diff --git a/drivers/base/core.c b/drivers/base/core.c
> index e6d3e6d485da..d396b0597c10 100644
> --- a/drivers/base/core.c
> +++ b/drivers/base/core.c
> @@ -48,6 +48,8 @@ early_param("sysfs.deprecated", sysfs_deprecated_setup);
>  static LIST_HEAD(wait_for_suppliers);
>  static DEFINE_MUTEX(wfs_lock);
>  static LIST_HEAD(deferred_sync);
> +static LIST_HEAD(sync_list);
> +static DEFINE_MUTEX(sync_lock);
>  static unsigned int defer_sync_state_count = 1;
>
>  #ifdef CONFIG_SRCU
> @@ -695,7 +697,23 @@ int device_links_check_suppliers(struct device *dev)
>         return ret;
>  }
>
> -static void __device_links_supplier_sync_state(struct device *dev)
> +/** __device_links_queue_sync_state - Queue a device for sync_state() callback
> + * @dev: Device to call sync_state() on
> + *
> + * Queues a device for a sync_state() callback when the device links write lock
> + * isn't held. This allows the sync_state() execution flow to use device links
> + * APIs.  The caller must ensure this function is called with
> + * device_links_write_lock() held.
> + *
> + * This function does a get_device() to make sure the device is not freed while
> + * on this list.
> + *
> + * So the caller must also ensure that device_links_flush_sync_list() is called
> + * as soon as the caller releases device_links_write_lock().  This is necessary
> + * to make sure the sync_state() is called in a timely fashion and the
> + * put_device() is called on this device.
> + */
> +static void __device_links_queue_sync_state(struct device *dev)
>  {
>         struct device_link *link;
>
> @@ -709,12 +727,35 @@ static void __device_links_supplier_sync_state(struct device *dev)
>                         return;
>         }
>
> -       if (dev->bus->sync_state)
> -               dev->bus->sync_state(dev);
> -       else if (dev->driver && dev->driver->sync_state)
> -               dev->driver->sync_state(dev);
> -
>         dev->state_synced = true;

BTW, this should go into device_links_flush_sync_list() too, shouldn't it?

Re: [PATCH v1] driver core: Allow device link operations inside sync_state()

[Saravana Kannan]

On Thu, Nov 14, 2019 at 1:13 AM Rafael J. Wysocki <rafael@kernel.org> wrote:
>
> On Wed, Nov 13, 2019 at 3:36 AM Saravana Kannan <saravanak@google.com> wrote:
> >
> > Some sync_state() implementations might need to call APIs that in turn
> > make calls to device link APIs. So, do the sync_state() callbacks
> > without holding the device link lock.
> >
> > Signed-off-by: Saravana Kannan <saravanak@google.com>
> > ---
> >  drivers/base/core.c | 63 +++++++++++++++++++++++++++++++++++++++------
> >  1 file changed, 55 insertions(+), 8 deletions(-)
> >
> > diff --git a/drivers/base/core.c b/drivers/base/core.c
> > index e6d3e6d485da..d396b0597c10 100644
> > --- a/drivers/base/core.c
> > +++ b/drivers/base/core.c
> > @@ -48,6 +48,8 @@ early_param("sysfs.deprecated", sysfs_deprecated_setup);
> >  static LIST_HEAD(wait_for_suppliers);
> >  static DEFINE_MUTEX(wfs_lock);
> >  static LIST_HEAD(deferred_sync);
> > +static LIST_HEAD(sync_list);
> > +static DEFINE_MUTEX(sync_lock);
> >  static unsigned int defer_sync_state_count = 1;
> >
> >  #ifdef CONFIG_SRCU
> > @@ -695,7 +697,23 @@ int device_links_check_suppliers(struct device *dev)
> >         return ret;
> >  }
> >
> > -static void __device_links_supplier_sync_state(struct device *dev)
> > +/** __device_links_queue_sync_state - Queue a device for sync_state() callback
> > + * @dev: Device to call sync_state() on
> > + *
> > + * Queues a device for a sync_state() callback when the device links write lock
> > + * isn't held. This allows the sync_state() execution flow to use device links
> > + * APIs.  The caller must ensure this function is called with
> > + * device_links_write_lock() held.
> > + *
> > + * This function does a get_device() to make sure the device is not freed while
> > + * on this list.
> > + *
> > + * So the caller must also ensure that device_links_flush_sync_list() is called
> > + * as soon as the caller releases device_links_write_lock().  This is necessary
> > + * to make sure the sync_state() is called in a timely fashion and the
> > + * put_device() is called on this device.
> > + */
> > +static void __device_links_queue_sync_state(struct device *dev)
> >  {
> >         struct device_link *link;
> >
> > @@ -709,12 +727,35 @@ static void __device_links_supplier_sync_state(struct device *dev)
> >                         return;
> >         }
> >
> > -       if (dev->bus->sync_state)
> > -               dev->bus->sync_state(dev);
> > -       else if (dev->driver && dev->driver->sync_state)
> > -               dev->driver->sync_state(dev);
> > -
> >         dev->state_synced = true;

<combining emails>
> BTW, this should go into device_links_flush_sync_list() too, shouldn't it?

Once a device is added to a sync list, it shouldn't be readded to the
list again -- that'll cause list corruption. So, I intentionally put
it here. Once a device is added to the list, it WILL get synced -- so
it's okay to flag it as such here.

For example, after all the consumers of a supplier probe and it's been
added to the sync_list, a new consumer could attach itself to the
supplier and then probe. You don't want that to cause list corruption.
I'll add a comment like:

/* Flag here to avoid trying to add the same device to the sync_list twice */

> > +
> > +       mutex_lock(&sync_lock);
>
> Total nit: I add empty lines around lock/unlock as a rule to make them
> more visible.

Ack

> > +       WARN_ON(!list_empty(&dev->links.defer_sync));
> > +       if (list_empty(&dev->links.defer_sync)) {
>
> Do you really need to duplicate that check?
>
> > +               get_device(dev);
> > +               list_add_tail(&dev->links.defer_sync, &sync_list);
> > +       }
> > +       mutex_unlock(&sync_lock);
> > +}
>
> What about adding
>
> } else {
>         WARN_ON(1);
> }
>
> here instead?

Sounds good.

>
> > +
>
> Kerneldoc?

Looked too obvious of a function and a static one to add a kernel doc
for. I can add it since you seem to want one.

> > +static void device_links_flush_sync_list(void)
> > +{
> > +       struct device *dev, *tmp;
> > +
> > +       mutex_lock(&sync_lock);
> > +
> > +       list_for_each_entry_safe(dev, tmp, &sync_list, links.defer_sync) {
> > +               list_del_init(&dev->links.defer_sync);
> > +               device_lock(dev);
> > +               if (dev->bus->sync_state)
> > +                       dev->bus->sync_state(dev);
> > +               else if (dev->driver && dev->driver->sync_state)
> > +                       dev->driver->sync_state(dev);
> > +               device_unlock(dev);
> > +               put_device(dev);
> > +       }
> > +
> > +       mutex_unlock(&sync_lock);
> >  }
> >
> >  void device_links_supplier_sync_state_pause(void)
> > @@ -738,11 +779,16 @@ void device_links_supplier_sync_state_resume(void)
> >                 goto out;
> >
> >         list_for_each_entry_safe(dev, tmp, &deferred_sync, links.defer_sync) {
> > -               __device_links_supplier_sync_state(dev);
> > +               /*
> > +                * Delete from deferred_sync list before queuing it to
> > +                * sync_list because defer_sync is used for both lists.
> > +                */
> >                 list_del_init(&dev->links.defer_sync);
> > +               __device_links_queue_sync_state(dev);
> >         }
> >  out:
> >         device_links_write_unlock();
> > +       device_links_flush_sync_list();
>
> Wouldn't it be better to use a local list in this function instead of
> the global sync_list?

Yeah, not a bad idea. But this is more flexible if we find in the
future that we need to queue to sync list in a function A which is
called by function B with device link write lock held. In that case,
function A will have to do the flushing.

> I guess the idea is that you wouldn't be able to do the flush in
> device_links_driver_bound() below,

Why do you say that? Local list would work in that case too, no?

> but do you really need that flush?

Yeah, device_links_driver_bound() is where I actually found this issue
when trying to implement sync_state() for a downstream driver.

> It looks like this is the only place calling
> __device_links_queue_sync_state() and you do a flush right away after
> the loop, so why is the extra flush in device_links_driver_bound()
> needed?

No, I call it in device_links_driver_bound() too :)

>
> >  }
> >
> >  static int sync_state_resume_initcall(void)
> > @@ -815,12 +861,13 @@ void device_links_driver_bound(struct device *dev)
> >                 if (defer_sync_state_count)
> >                         __device_links_supplier_defer_sync(link->supplier);
> >                 else
> > -                       __device_links_supplier_sync_state(link->supplier);
> > +                       __device_links_queue_sync_state(link->supplier);

See, right here.

> >         }
> >
> >         dev->links.status = DL_DEV_DRIVER_BOUND;
> >
> >         device_links_write_unlock();
> > +       device_links_flush_sync_list();
>
> It looks like devices can be added to sync_list in parallel  with each
> other

Not sure what you mean by "in parallel with each other". But, two
different threads running device_links_supplier_sync_state_resume()
and device_links_driver_bound() could end up updating the sync_list
before either one of them gets to flush it.

> and so is it always OK to always flush all of them after one of
> them has been bound to a driver?

Not sure what you mean by "after one of them has been bound to a
driver". A device won't ever get added to the sync_list unless all
it's consumers have probed. So once it's added to sync_list, it's okay
to flush it any time.

>
> >  }
> >
> >  static void device_link_drop_managed(struct device_link *link)
> > --

So as far as I can tell, the stuff that might need fixing are:
1. The spacing nit.
2. Whether we should move to a local list -- I like to keep it as is
for the flexibility.
3. Add a comment for why I set sync_state = 1 in the queuing function.

I'll skip (2) and send a patch now. And if you want to change (2), I
can update the patch again.

Thanks,
Saravana