Re: [RFC] driver core: add a virtual bus for use when a simple device/bus is needed

[Danilo Krummrich]

On Mon, Feb 03, 2025 at 10:39:58AM +0100, Greg Kroah-Hartman wrote:
> From 4c7aa0f9f0f7d25c962b70a11bad48d418b9490a Mon Sep 17 00:00:00 2001
> From: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> Date: Fri, 31 Jan 2025 15:01:32 +0100
> Subject: [PATCH] driver core: add a virtual bus for use when a simple
>  device/bus is needed
> 
> Many drivers abuse the platform driver/bus system as it provides a
> simple way to create and bind a device to a driver-specific set of
> probe/release functions.  Instead of doing that, and wasting all of the
> memory associated with a platform device, here is a "virtual" bus that
> can be used instead.
> 
> Signed-off-by: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>

I think it turned out pretty nice combining the driver and device creation for
convenience.

But I think we may still need the option to create multiple devices for the same
driver, as mentioned by Sima.

@Sima: I wonder if the number of devices could just be an argument?

> ---
>  drivers/base/Makefile          |   2 +-
>  drivers/base/base.h            |   1 +
>  drivers/base/init.c            |   1 +
>  drivers/base/virtual.c         | 196 +++++++++++++++++++++++++++++++++
>  drivers/regulator/dummy.c      |  35 ++----
>  include/linux/device/virtual.h |  32 ++++++
>  6 files changed, 239 insertions(+), 28 deletions(-)
>  create mode 100644 drivers/base/virtual.c
>  create mode 100644 include/linux/device/virtual.h
> 
> diff --git a/drivers/base/Makefile b/drivers/base/Makefile
> index 7fb21768ca36..13eec7a1a9db 100644
> --- a/drivers/base/Makefile
> +++ b/drivers/base/Makefile
> @@ -6,7 +6,7 @@ obj-y			:= component.o core.o bus.o dd.o syscore.o \
>  			   cpu.o firmware.o init.o map.o devres.o \
>  			   attribute_container.o transport_class.o \
>  			   topology.o container.o property.o cacheinfo.o \
> -			   swnode.o
> +			   swnode.o virtual.o
>  obj-$(CONFIG_AUXILIARY_BUS) += auxiliary.o
>  obj-$(CONFIG_DEVTMPFS)	+= devtmpfs.o
>  obj-y			+= power/
> diff --git a/drivers/base/base.h b/drivers/base/base.h
> index 8cf04a557bdb..1eb68e416ee1 100644
> --- a/drivers/base/base.h
> +++ b/drivers/base/base.h
> @@ -137,6 +137,7 @@ int hypervisor_init(void);
>  static inline int hypervisor_init(void) { return 0; }
>  #endif
>  int platform_bus_init(void);
> +int virtual_bus_init(void);
>  void cpu_dev_init(void);
>  void container_dev_init(void);
>  #ifdef CONFIG_AUXILIARY_BUS
> diff --git a/drivers/base/init.c b/drivers/base/init.c
> index c4954835128c..58c98a156220 100644
> --- a/drivers/base/init.c
> +++ b/drivers/base/init.c
> @@ -35,6 +35,7 @@ void __init driver_init(void)
>  	of_core_init();
>  	platform_bus_init();
>  	auxiliary_bus_init();
> +	virtual_bus_init();
>  	memory_dev_init();
>  	node_dev_init();
>  	cpu_dev_init();
> diff --git a/drivers/base/virtual.c b/drivers/base/virtual.c
> new file mode 100644
> index 000000000000..b05db4618d5c
> --- /dev/null
> +++ b/drivers/base/virtual.c
> @@ -0,0 +1,196 @@
> +// SPDX-License-Identifier: GPL-2.0-only */
> +/*
> + * Copyright (c) 2025 Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> + * Copyright (c) 2025 The Linux Foundation
> + *
> + * A "simple" virtual bus that allows devices to be created and added
> + * automatically to it.  Whenever you need a device that is not "real",
> + * use this interface instead of even thinking of using a platform device.
> + *
> + */
> +#include <linux/device/virtual.h>
> +#include <linux/err.h>
> +#include <linux/init.h>
> +#include <linux/slab.h>
> +#include <linux/string.h>
> +#include "base.h"
> +
> +/*
> + * Internal rapper structure so we can hold the memory

I guess having an internal "rapper" does make the interface even cooler! :-)

> + * for the driver and the name string of the virtual device.
> + */
> +struct virtual_object {
> +	struct virtual_device virt_dev;
> +	struct device_driver driver;
> +	const struct virtual_driver_ops *virt_ops;
> +	char name[];
> +};
> +#define to_virtual_object(x) container_of_const(dev, struct virtual_object, virt_dev.dev);
> +
> +static struct device virtual_bus = {
> +	.init_name	= "virt_bus",
> +};
> +
> +static int virtual_match(struct device *dev, const struct device_driver *drv)
> +{
> +	struct virtual_object *virt_obj = to_virtual_object(dev);
> +
> +	dev_info(dev, "%s: driver: %s\n", __func__, drv->name);
> +
> +	/* Match is simple, strcmp()! */
> +	return (strcmp(virt_obj->name, drv->name) == 0);
> +}
> +
> +static int virtual_probe(struct device *dev)
> +{
> +	struct virtual_object *virt_obj = to_virtual_object(dev);
> +	struct virtual_device *virt_dev = &virt_obj->virt_dev;
> +	const struct virtual_driver_ops *virt_ops = virt_obj->virt_ops;
> +	int ret = 0;
> +
> +	dev_info(dev, "%s\n", __func__);
> +
> +	if (virt_ops->probe)
> +		ret = virt_ops->probe(virt_dev);
> +
> +	return ret;
> +}
> +
> +static void virtual_remove(struct device *dev)
> +{
> +	struct virtual_object *virt_obj = to_virtual_object(dev);
> +	struct virtual_device *virt_dev = &virt_obj->virt_dev;
> +	const struct virtual_driver_ops *virt_ops = virt_obj->virt_ops;
> +
> +	dev_info(dev, "%s\n", __func__);
> +
> +	if (virt_ops->remove)
> +		virt_ops->remove(virt_dev);
> +}
> +
> +static const struct bus_type virtual_bus_type = {
> +	.name		= "virtual",
> +	.match		= virtual_match,
> +	.probe		= virtual_probe,
> +	.remove		= virtual_remove,
> +};
> +
> +static void virtual_device_release(struct device *dev)
> +{
> +	struct virtual_object *virt_obj = to_virtual_object(dev);
> +	struct device_driver *drv = &virt_obj->driver;
> +
> +	/*
> +	 * Now that the device is going away, it has been unbound from the
> +	 * driver we created for it, so it is safe to unregister the driver from
> +	 * the system.
> +	 */
> +	driver_unregister(drv);

This is probably becoming non-trivial if we allow multiple devices to be created
for the driver.

> +
> +	kfree(virt_obj);
> +}
> +
> +/**
> + * __virtual_device_create - create and register a virtual device and driver
> + * @virt_ops: struct virtual_driver_ops that the new device will call back into
> + * @name: name of the device and driver we are adding
> + * @owner: module owner of the device/driver
> + *
> + * Create a new virtual device and driver, both with the same name, and register
> + * them in the driver core properly.  The probe() callback of @virt_ops will be
> + * called with the new device that is created for the caller to do something
> + * with.
> + */
> +struct virtual_device *__virtual_device_create(struct virtual_driver_ops *virt_ops,
> +					       const char *name, struct module *owner)
> +{
> +	struct device_driver *drv;
> +	struct device *dev;
> +	struct virtual_object *virt_obj;
> +	struct virtual_device *virt_dev;
> +	int ret;
> +
> +	pr_info("%s: %s\n", __func__, name);
> +
> +	virt_obj = kzalloc(sizeof(*virt_obj) + strlen(name) + 1, GFP_KERNEL);
> +	if (!virt_obj)
> +		return NULL;
> +
> +	/* Save off the name of the object into local memory */
> +	strcpy(virt_obj->name, name);
> +
> +	/* Initialize the driver portion and register it with the driver core */
> +	virt_obj->virt_ops = virt_ops;

I wonder if it would make sense to allow NULL for virt_ops and use default ops
in this case.

This could be useful for the Rust side of things, since then we could probably
avoid having a virtual bus abstraction and instead would only need an
abstraction of __virtual_device_create() itself.

However, this is probalby only convenient for when we have a single device /
driver, but not multiple devices for a single driver.

The more I think about it, the less I think it's a good idea, since it'd
probably trick people into coming up with questionable constructs...

> +	drv = &virt_obj->driver;
> +
> +	drv->owner = owner;
> +	drv->name = virt_obj->name;
> +	drv->bus = &virtual_bus_type;
> +	drv->probe_type = PROBE_PREFER_ASYNCHRONOUS;
> +
> +	ret = driver_register(drv);
> +	if (ret) {
> +		pr_err("%s: driver_register for %s virtual driver failed with %d\n",
> +		       __func__, name, ret);
> +		kfree(virt_obj);
> +		return NULL;
> +	}
> +
> +	/* Initialize the device portion and register it with the driver core */
> +	virt_dev = &virt_obj->virt_dev;
> +	dev = &virt_dev->dev;
> +
> +	device_initialize(dev);
> +	dev->release = virtual_device_release;
> +	dev->parent = &virtual_bus;
> +	dev->bus = &virtual_bus_type;
> +	dev_set_name(dev, "%s", name);
> +
> +	ret = device_add(dev);
> +	if (ret) {
> +		pr_err("%s: device_add for %s virtual device failed with %d\n",
> +		       __func__, name, ret);
> +		put_device(dev);
> +		return NULL;
> +	}
> +
> +	return virt_dev;
> +}
> +EXPORT_SYMBOL_GPL(__virtual_device_create);