drivers/base/core: refcount kobject and bus on device attribute read / store
Subsystems (2)
PATCH v2 1/1 drivers/base/core: refcount kobject and bus on device attribute read / store
It's possible today to have a device attribute read or store race against device removal. When this happens there is a small chance that the dereference for the private data area of the driver is NULL.
Let's consider the zram driver as an example. Its possible to run into a race where a sysfs knob is being used, we get preempted, and a zram device is removed before we complete use of the sysfs knob. This can happen for instance on block devices, where for instance the zram block devices just part of the private data of the block device.
For instance this can happen in the following two situations as examples to illustrate this better:
CPU 1 CPU 2destroy_devices
...
compact_store()
zram = dev_to_zram(dev);idr_for_each(zram_remove_cb
zram_remove
...
kfree(zram)
down_read(&zram->init_lock);
CPU 1 CPU 2hot_remove_store
compact_store()
zram = dev_to_zram(dev);
zram_remove
kfree(zram)
down_read(&zram->init_lock);To ensure the private data pointer is valid we could use bdget() / bdput() in between access, however that would mean doing that in all sysfs reads/stores on the driver. Instead a generic solution for all drivers is to ensure the device kobject is still valid and also the bus, if a bus is present.
This issue does not fix a known crash, however this race was spotted by Minchan Kim through code inspection upon code review of another zram patch.
--- drivers/base/base.h | 2 ++ drivers/base/bus.c | 4 ++-- drivers/base/core.c | 36 ++++++++++++++++++++++++++++++++---- 3 files changed, 36 insertions(+), 6 deletions(-)
drivers/base/base.h +2 -0
@@ -127,6 +127,8 @@ static inline void auxiliary_bus_init(void) { }struct kobject *virtual_device_parent (struct device *dev); +extern struct bus_type *bus_get (struct bus_type *bus); +extern void bus_put (struct bus_type *bus);extern int bus_add_device (struct device *dev);extern void bus_probe_device (struct device *dev);extern void bus_remove_device (struct device *dev);
drivers/base/bus.c +2 -2
@@ -39,7 +39,7 @@ static struct kset *system_kset;static int __must_check bus_rescan_devices_helper (struct device *dev,void *data); -static struct bus_type *bus_get (struct bus_type *bus) +struct bus_type *bus_get (struct bus_type *bus) {if (bus) {kset_get (&bus->p->subsys);
@@ -48,7 +48,7 @@ static struct bus_type *bus_get(struct bus_type *bus)return NULL ; } -static void bus_put (struct bus_type *bus) +void bus_put (struct bus_type *bus) {if (bus)kset_put (&bus->p->subsys);
drivers/base/core.c +32 -4
@@ -2042,28 +2042,56 @@ EXPORT_SYMBOL(dev_driver_string);static ssize_t dev_attr_show (struct kobject *kobj,struct attribute *attr,char *buf) { -struct device_attribute *dev_attr =to_dev_attr (attr); -struct device *dev =kobj_to_dev (kobj); +struct device_attribute *dev_attr; +struct device *dev; +struct bus_type *bus =NULL ;ssize_t ret = -EIO ; + dev =get_device (kobj_to_dev (kobj)); +if (dev->bus) { + bus =bus_get (dev->bus); +if (!bus) + goto out; + } + + dev_attr =to_dev_attr (attr);if (dev_attr->show) ret = dev_attr->show (dev, dev_attr, buf);if (ret >= (ssize_t )PAGE_SIZE ) {printk ("dev_attr_show: %pS returned bad count\n" , dev_attr->show); } + +bus_put (bus); +out: +put_device (dev); +return ret; }static ssize_t dev_attr_store (struct kobject *kobj,struct attribute *attr,const char *buf,size_t count) { -struct device_attribute *dev_attr =to_dev_attr (attr); -struct device *dev =kobj_to_dev (kobj); +struct device_attribute *dev_attr; +struct device *dev; +struct bus_type *bus =NULL ;ssize_t ret = -EIO ; + dev =get_device (kobj_to_dev (kobj)); +if (dev->bus) { + bus =bus_get (dev->bus); +if (!bus) + goto out; + } + + dev_attr =to_dev_attr (attr);if (dev_attr->store) ret = dev_attr->store (dev, dev_attr, buf, count); + +bus_put (bus); +out: +put_device (dev); +return ret; }
Signature · 1 line
2.30.2
Greg KH
maintainerQuoted 154 lines · Luis Chamberlain
It's possible today to have a device attribute read or store race against device removal. When this happens there is a small chance that the dereference for the private data area of the driver is NULL.
Let's consider the zram driver as an example. Its possible to run into a race where a sysfs knob is being used, we get preempted, and a zram device is removed before we complete use of the sysfs knob. This can happen for instance on block devices, where for instance the zram block devices just part of the private data of the block device.
For instance this can happen in the following two situations as examples to illustrate this better:
CPU 1 CPU 2
destroy_devices
...compact_store() zram = dev_to_zram(dev);idr_for_each(zram_remove_cb
zram_remove
...
kfree(zram)
down_read(&zram->init_lock);CPU 1 CPU 2
hot_remove_storecompact_store() zram = dev_to_zram(dev); zram_remove kfree(zram) down_read(&zram->init_lock);To ensure the private data pointer is valid we could use
bdget()/bdput()in between access, however that would mean doing that in all sysfs reads/stores on the driver. Instead a generic solution for all drivers is to ensure the device kobject is still valid and also the bus, if a bus is present.This issue does not fix a known crash, however this race was spotted by Minchan Kim through code inspection upon code review of another zram patch.
Suggested-by Greg Kroah-Hartman <[email protected]>Signed-off-by Luis Chamberlain <[email protected]>--- drivers/base/base.h | 2 ++ drivers/base/bus.c | 4 ++-- drivers/base/core.c | 36 ++++++++++++++++++++++++++++++++---- 3 files changed, 36 insertions(+), 6 deletions(-)drivers/base/base.h +2
-0@@ -127,6 +127,8 @@ static inline void auxiliary_bus_init(void) { }struct kobject *virtual_device_parent (struct device *dev); +extern struct bus_type *bus_get (struct bus_type *bus); +extern void bus_put (struct bus_type *bus);extern int bus_add_device (struct device *dev);extern void bus_probe_device (struct device *dev);extern void bus_remove_device (struct device *dev);drivers/base/bus.c +2
-2@@ -39,7 +39,7 @@ static struct kset *system_kset;static int __must_check bus_rescan_devices_helper (struct device *dev,void *data); -static struct bus_type *bus_get (struct bus_type *bus) +struct bus_type *bus_get (struct bus_type *bus) {if (bus) {kset_get (&bus->p->subsys);@@ -48,7 +48,7 @@ static struct bus_type *bus_get(struct bus_type *bus)return NULL ; } -static void bus_put (struct bus_type *bus) +void bus_put (struct bus_type *bus) {if (bus)kset_put (&bus->p->subsys);drivers/base/core.c +32
-4@@ -2042,28 +2042,56 @@ EXPORT_SYMBOL(dev_driver_string);static ssize_t dev_attr_show (struct kobject *kobj,struct attribute *attr,char *buf) { -struct device_attribute *dev_attr =to_dev_attr (attr); -struct device *dev =kobj_to_dev (kobj); +struct device_attribute *dev_attr; +struct device *dev; +struct bus_type *bus =NULL ;ssize_t ret = -EIO ; + dev =get_device (kobj_to_dev (kobj)); +if (dev->bus) { + bus =bus_get (dev->bus); +if (!bus) + goto out; + } + + dev_attr =to_dev_attr (attr);if (dev_attr->show) ret = dev_attr->show (dev, dev_attr, buf);if (ret >= (ssize_t )PAGE_SIZE ) {printk ("dev_attr_show: %pS returned bad count\n" , dev_attr->show); } + +bus_put (bus); +out: +put_device (dev); +return ret; }static ssize_t dev_attr_store (struct kobject *kobj,struct attribute *attr,const char *buf,size_t count) { -struct device_attribute *dev_attr =to_dev_attr (attr); -struct device *dev =kobj_to_dev (kobj); +struct device_attribute *dev_attr; +struct device *dev; +struct bus_type *bus =NULL ;ssize_t ret = -EIO ; + dev =get_device (kobj_to_dev (kobj)); +if (dev->bus) { + bus =bus_get (dev->bus); +if (!bus) + goto out; + } + + dev_attr =to_dev_attr (attr);if (dev_attr->store) ret = dev_attr->store (dev, dev_attr, buf, count); + +bus_put (bus); +out: +put_device (dev); +return ret; }Signature · 1 line
2.30.2
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