driver core: Fix device link device name collision
Subsystems (2)
PATCH v4 1/1 driver core: Fix device link device name collision
The device link device's name was of the form:
<supplier-dev-name>--<consumer-dev-name>
This can cause name collision as reported here [1] as device names are not globally unique. Since device names have to be unique within the bus/class, add the bus/class name as a prefix to the device names used to construct the device link device name.
So the devuce link device's name will be of the form:
<supplier-bus-name>:<supplier-dev-name>--<consumer-bus-name>:<consumer-dev-name>
[1] - https://lore.kernel.org/lkml/[email protected]/
--- Documentation/ABI/testing/sysfs-class-devlink | 4 +-- .../ABI/testing/sysfs-devices-consumer | 5 ++-- .../ABI/testing/sysfs-devices-supplier | 5 ++-- drivers/base/core.c | 27 ++++++++++--------- include/linux/device.h | 12 +++++++++ 5 files changed, 35 insertions(+), 18 deletions(-)
Documentation/ABI/testing/sysfs-class-devlink +2 -2
@@ -5,8 +5,8 @@ Description: Provide a place in sysfs for the device link objects in the kernel at any given time. The name of a device link directory, denoted as ... above, is of the form <supplier>--<consumer> - where <supplier> is the supplier device name and <consumer> is - the consumer device name. + where <supplier> is the supplier bus:device name and <consumer> + is the consumer bus:device name. What: /sys/class/devlink/.../auto_remove_on Date: May 2020
Documentation/ABI/testing/sysfs-devices-consumer +3 -2
@@ -4,5 +4,6 @@ Contact: Saravana Kannan <[email protected]> Description: The /sys/devices/.../consumer:<consumer> are symlinks to device links where this device is the supplier. <consumer> denotes the - name of the consumer in that device link. There can be zero or - more of these symlinks for a given device. + name of the consumer in that device link and is of the form + bus:device name. There can be zero or more of these symlinks + for a given device.
Documentation/ABI/testing/sysfs-devices-supplier +3 -2
@@ -4,5 +4,6 @@ Contact: Saravana Kannan <[email protected]> Description: The /sys/devices/.../supplier:<supplier> are symlinks to device links where this device is the consumer. <supplier> denotes the - name of the supplier in that device link. There can be zero or - more of these symlinks for a given device. + name of the supplier in that device link and is of the form + bus:device name. There can be zero or more of these symlinks + for a given device.
drivers/base/core.c +15 -12
@@ -456,7 +456,9 @@ static int devlink_add_symlinks(struct device *dev,struct device *con = link->consumer;char *buf; - len =max (strlen (dev_name (sup)),strlen (dev_name (con))); + len =max (strlen (dev_bus_name (sup)) +strlen (dev_name (sup)), +strlen (dev_bus_name (con)) +strlen (dev_name (con))); + len +=strlen (":" ); len +=strlen ("supplier:" ) +1 ; buf =kzalloc (len,GFP_KERNEL );if (!buf)
@@ -470,12 +472,12 @@ static int devlink_add_symlinks(struct device *dev,if (ret) goto err_con; -snprintf (buf, len,"consumer:%s" ,dev_name (con)); +snprintf (buf, len,"consumer:%s:%s" ,dev_bus_name (con),dev_name (con)); ret =sysfs_create_link (&sup->kobj, &link->link_dev.kobj, buf);if (ret) goto err_con_dev; -snprintf (buf, len,"supplier:%s" ,dev_name (sup)); +snprintf (buf, len,"supplier:%s:%s" ,dev_bus_name (sup),dev_name (sup)); ret =sysfs_create_link (&con->kobj, &link->link_dev.kobj, buf);if (ret) goto err_sup_dev;
@@ -483,7 +485,7 @@ static int devlink_add_symlinks(struct device *dev, goto out; err_sup_dev: -snprintf (buf, len,"consumer:%s" ,dev_name (con)); +snprintf (buf, len,"consumer:%s:%s" ,dev_bus_name (con),dev_name (con));sysfs_remove_link (&sup->kobj, buf); err_con_dev:sysfs_remove_link (&link->link_dev.kobj,"consumer" );
@@ -506,7 +508,9 @@ static void devlink_remove_symlinks(struct device *dev,sysfs_remove_link (&link->link_dev.kobj,"consumer" );sysfs_remove_link (&link->link_dev.kobj,"supplier" ); - len =max (strlen (dev_name (sup)),strlen (dev_name (con))); + len =max (strlen (dev_bus_name (sup)) +strlen (dev_name (sup)), +strlen (dev_bus_name (con)) +strlen (dev_name (con))); + len +=strlen (":" ); len +=strlen ("supplier:" ) +1 ; buf =kzalloc (len,GFP_KERNEL );if (!buf) {
@@ -514,9 +518,9 @@ static void devlink_remove_symlinks(struct device *dev,return ; } -snprintf (buf, len,"supplier:%s" ,dev_name (sup)); +snprintf (buf, len,"supplier:%s:%s" ,dev_bus_name (sup),dev_name (sup));sysfs_remove_link (&con->kobj, buf); -snprintf (buf, len,"consumer:%s" ,dev_name (con)); +snprintf (buf, len,"consumer:%s:%s" ,dev_bus_name (con),dev_name (con));sysfs_remove_link (&sup->kobj, buf);kfree (buf); }
@@ -737,8 +741,9 @@ struct device_link *device_link_add(struct device *consumer, link->link_dev.class = &devlink_class;device_set_pm_not_required (&link->link_dev); -dev_set_name (&link->link_dev,"%s--%s" , -dev_name (supplier),dev_name (consumer)); +dev_set_name (&link->link_dev,"%s:%s--%s:%s" , +dev_bus_name (supplier),dev_name (supplier), +dev_bus_name (consumer),dev_name (consumer));if (device_register (&link->link_dev)) {put_device (consumer);put_device (supplier);
@@ -1808,9 +1813,7 @@ const char *dev_driver_string(const struct device *dev)* never change once they are set, so they don't need special care. */ drv =READ_ONCE (dev->driver); -return drv ? drv->name : - (dev->bus ? dev->bus->name : - (dev->class ? dev->class->name :"" )); +return drv ? drv->name :dev_bus_name (dev); }EXPORT_SYMBOL (dev_driver_string);
include/linux/device.h +12 -0
@@ -609,6 +609,18 @@ static inline const char *dev_name(const struct device *dev)return kobject_name (&dev->kobj); } +/** +* dev_bus_name - Return a device's bus/class name, if at all possible +* @dev: struct device to get the bus/class name of +* +* Will return the name of the bus/class the device is attached to. If it is +* not attached to a bus/class, an empty string will be returned. +*/ +static inline const char *dev_bus_name (const struct device *dev) +{ +return dev->bus ? dev->bus->name : (dev->class ? dev->class->name :"" ); +} + __printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...);#ifdef CONFIG_NUMA
Signature · 1 line
2.30.0.284.gd98b1dd5eaa7-goog
Am 2021-01-09 23:45, schrieb Saravana Kannan:
Quoted 11 lines
The device link device's name was of the form:
<supplier-dev-name>--<consumer-dev-name>This can cause name collision as reported here [1] as device names are not globally unique. Since device names have to be unique within the bus/class, add the bus/class name as a prefix to the device names used to construct the device link device name.
So the devuce link device's name will be of the form:
<supplier-bus-name>:<supplier-dev-name>--<consumer-bus-name>:<consumer-dev-name>
Quoted 6 lines
[1] - https://lore.kernel.org/lkml/[email protected]/
Fixes 287905e68dd2 ("driver core: Expose device link details in sysfs")Reported-by Michael Walle <[email protected]>Signed-off-by Saravana Kannan <[email protected]>
Thanks!
-michael
Greg Kroah-Hartman
maintainerQuoted 17 lines · Saravana Kannan
The device link device's name was of the form:
<supplier-dev-name>--<consumer-dev-name>This can cause name collision as reported here [1] as device names are not globally unique. Since device names have to be unique within the bus/class, add the bus/class name as a prefix to the device names used to construct the device link device name.
So the devuce link device's name will be of the form:
<supplier-bus-name>:<supplier-dev-name>--<consumer-bus-name>:<consumer-dev-name>[1] - https://lore.kernel.org/lkml/[email protected]/
Fixes 287905e68dd2 ("driver core: Expose device link details in sysfs")Reported-by Michael Walle <[email protected]>Signed-off-by Saravana Kannan <[email protected]>
Quoted 8 lines
--- Documentation/ABI/testing/sysfs-class-devlink | 4 +-- .../ABI/testing/sysfs-devices-consumer | 5 ++-- .../ABI/testing/sysfs-devices-supplier | 5 ++-- drivers/base/core.c | 27 ++++++++++--------- include/linux/device.h | 12 +++++++++ 5 files changed, 35 insertions(+), 18 deletions(-)
Hi,
This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.
You are receiving this message because of the following common error(s) as indicated below:
- This looks like a new version of a previously submitted patch, but you did not list below the --- line any changes from the previous version. Please read the section entitled "The canonical patch format" in the kernel file, Documentation/SubmittingPatches for what needs to be done here to properly describe this.
If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.
thanks,
greg k-h's patch email bot