Skip to contentSkip to conversation

gpio: mockup: Convert to use software nodes

PATCH Superseded Andy Shevchenko 4 participants 5 messages Oct 5, 2021

Subsystems (2)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 gpio: mockup: Convert to use software nodes

The gpio-mockup driver creates a properties that are shared between platform and GPIO devices. Because of that, the properties may not be removed at the proper point of time without provoking use-after-free as shown in the backtrace:

refcount_t: underflow; use-after-free.

  WARNING: CPU: 0 PID: 103 at lib/refcount.c:28 refcount_warn_saturate+0xd1/0x120
  ...
  Call Trace:
  kobject_put+0xdc/0xf0
  software_node_notify_remove+0xa8/0xc0
  device_del+0x15a/0x3e0

That's why the driver has to manage lifetime of the software nodes by itself.

The problem originates by the old device_add_properties() API, but has been only revealed after the commit 5aeb05b27f81 ("software node: balance refcount for managed software nodes"). Hence, it's used as landmark for the backporting.

Fixes 5aeb05b27f81 ("software node: balance refcount for managed software nodes")
---
 drivers/gpio/gpio-mockup.c | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)
drivers/gpio/gpio-mockup.c +19 -3
index 0a9d746a0fe0..8b147b565e92 100644
@@ -478,8 +478,18 @@ static void gpio_mockup_unregister_pdevs(void)
 {
 	int i;
 
-	for (i = 0; i < GPIO_MOCKUP_MAX_GC; i++)
-		platform_device_unregister(gpio_mockup_pdevs[i]);
+	for (i = 0; i < GPIO_MOCKUP_MAX_GC; i++) {
+		struct platform_device *pdev;
+		struct fwnode_handle *fwnode;
+
+		pdev = gpio_mockup_pdevs[i];
+		if (!pdev)
+			continue;
+
+		fwnode = dev_fwnode(&pdev->dev);
+		platform_device_unregister(pdev);
+		fwnode_remove_software_node(fwnode);
+	}
 }
 
 static __init char **gpio_mockup_make_line_names(const char *label,
@@ -508,6 +518,7 @@ static int __init gpio_mockup_register_chip(int idx)
 	struct property_entry properties[GPIO_MOCKUP_MAX_PROP];
 	struct platform_device_info pdevinfo;
 	struct platform_device *pdev;
+	struct fwnode_handle *fwnode;
 	char **line_names = NULL;
 	char chip_label[32];
 	int prop = 0, base;
@@ -536,13 +547,18 @@ static int __init gpio_mockup_register_chip(int idx)
 					"gpio-line-names", line_names, ngpio);
 	}
 
+	fwnode = fwnode_create_software_node(properties, NULL);
+	if (IS_ERR(fwnode))
+		return PTR_ERR(fwnode);
+
 	pdevinfo.name = "gpio-mockup";
 	pdevinfo.id = idx;
-	pdevinfo.properties = properties;
+	pdevinfo.fwnode = fwnode;
 
 	pdev = platform_device_register_full(&pdevinfo);
 	kfree_strarray(line_names, ngpio);
 	if (IS_ERR(pdev)) {
+		fwnode_remove_software_node(fwnode);
 		pr_err("error registering device");
 		return PTR_ERR(pdev);
 	}
Signature · 1 line
2.33.0
Tested-by on v1 1/1
#1 lore raw
Quoted 13 lines · Andy Shevchenko

The gpio-mockup driver creates a properties that are shared between platform and GPIO devices. Because of that, the properties may not be removed at the proper point of time without provoking use-after-free as shown in the backtrace:

refcount_t: underflow; use-after-free.

  WARNING: CPU: 0 PID: 103 at lib/refcount.c:28 refcount_warn_saturate+0xd1/0x120
  ...
  Call Trace:
  kobject_put+0xdc/0xf0
  software_node_notify_remove+0xa8/0xc0
  device_del+0x15a/0x3e0
Quoted 7 lines

That's why the driver has to manage lifetime of the software nodes by itself.

The problem originates by the old device_add_properties() API, but has been only revealed after the commit 5aeb05b27f81 ("software node: balance refcount for managed software nodes"). Hence, it's used as landmark for the backporting.

Fixes 5aeb05b27f81 ("software node: balance refcount for managed software nodes")

Shouldn't that be:

Fixes bd1e336aa853 ("driver core: platform: Remove platform_device_add_properties()")
Quoted 2 lines

Other than that, looks good and works for me.

Cheers,
Kent.

Quoted 60 lines
---
 drivers/gpio/gpio-mockup.c | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)
drivers/gpio/gpio-mockup.c +19 -3
index 0a9d746a0fe0..8b147b565e92 100644
@@ -478,8 +478,18 @@ static void gpio_mockup_unregister_pdevs(void)
 {
 	int i;
 
-	for (i = 0; i < GPIO_MOCKUP_MAX_GC; i++)
-		platform_device_unregister(gpio_mockup_pdevs[i]);
+	for (i = 0; i < GPIO_MOCKUP_MAX_GC; i++) {
+		struct platform_device *pdev;
+		struct fwnode_handle *fwnode;
+
+		pdev = gpio_mockup_pdevs[i];
+		if (!pdev)
+			continue;
+
+		fwnode = dev_fwnode(&pdev->dev);
+		platform_device_unregister(pdev);
+		fwnode_remove_software_node(fwnode);
+	}
 }
 
 static __init char **gpio_mockup_make_line_names(const char *label,
@@ -508,6 +518,7 @@ static int __init gpio_mockup_register_chip(int idx)
 	struct property_entry properties[GPIO_MOCKUP_MAX_PROP];
 	struct platform_device_info pdevinfo;
 	struct platform_device *pdev;
+	struct fwnode_handle *fwnode;
 	char **line_names = NULL;
 	char chip_label[32];
 	int prop = 0, base;
@@ -536,13 +547,18 @@ static int __init gpio_mockup_register_chip(int idx)
 					"gpio-line-names", line_names, ngpio);
 	}
 
+	fwnode = fwnode_create_software_node(properties, NULL);
+	if (IS_ERR(fwnode))
+		return PTR_ERR(fwnode);
+
 	pdevinfo.name = "gpio-mockup";
 	pdevinfo.id = idx;
-	pdevinfo.properties = properties;
+	pdevinfo.fwnode = fwnode;
 
 	pdev = platform_device_register_full(&pdevinfo);
 	kfree_strarray(line_names, ngpio);
 	if (IS_ERR(pdev)) {
+		fwnode_remove_software_node(fwnode);
 		pr_err("error registering device");
 		return PTR_ERR(pdev);
 	}
Signature · 1 line
2.33.0
#2 lore raw
Quoted 17 lines · Kent Gibson
Quoted 15 lines · Andy Shevchenko

The gpio-mockup driver creates a properties that are shared between platform and GPIO devices. Because of that, the properties may not be removed at the proper point of time without provoking use-after-free as shown in the backtrace:

refcount_t: underflow; use-after-free.

  WARNING: CPU: 0 PID: 103 at lib/refcount.c:28 refcount_warn_saturate+0xd1/0x120
  ...
  Call Trace:
  kobject_put+0xdc/0xf0
  software_node_notify_remove+0xa8/0xc0
  device_del+0x15a/0x3e0

That's why the driver has to manage lifetime of the software nodes by itself.

Quoted 8 lines
Quoted 5 lines

The problem originates by the old device_add_properties() API, but has been only revealed after the commit 5aeb05b27f81 ("software node: balance refcount for managed software nodes"). Hence, it's used as landmark for the backporting.

Fixes 5aeb05b27f81 ("software node: balance refcount for managed software nodes")

Shouldn't that be:

Fixes bd1e336aa853 ("driver core: platform: Remove platform_device_add_properties()")

I think you are right. I thought that it happened during the last rc-week.

Quoted 6 lines
Quoted 2 lines

Other than that, looks good and works for me.

Thanks!

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#3 lore raw
In reply to Andy Shevchenko
Quoted 81 lines · Andy Shevchenko

The gpio-mockup driver creates a properties that are shared between platform and GPIO devices. Because of that, the properties may not be removed at the proper point of time without provoking use-after-free as shown in the backtrace:

refcount_t: underflow; use-after-free.

  WARNING: CPU: 0 PID: 103 at lib/refcount.c:28 refcount_warn_saturate+0xd1/0x120
  ...
  Call Trace:
  kobject_put+0xdc/0xf0
  software_node_notify_remove+0xa8/0xc0
  device_del+0x15a/0x3e0

That's why the driver has to manage lifetime of the software nodes by itself.

The problem originates by the old device_add_properties() API, but has been only revealed after the commit 5aeb05b27f81 ("software node: balance refcount for managed software nodes"). Hence, it's used as landmark for the backporting.

Fixes 5aeb05b27f81 ("software node: balance refcount for managed software nodes")
---
 drivers/gpio/gpio-mockup.c | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)
drivers/gpio/gpio-mockup.c +19 -4
index 0a9d746a0fe0..8b147b565e92 100644
@@ -478,8 +478,18 @@ static void gpio_mockup_unregister_pdevs(void)
 {
        int i;
 
-       for (i = 0; i < GPIO_MOCKUP_MAX_GC; i++)
-               platform_device_unregister(gpio_mockup_pdevs[i]);
+       for (i = 0; i < GPIO_MOCKUP_MAX_GC; i++) {
+               struct platform_device *pdev;
+               struct fwnode_handle *fwnode;
+
+               pdev = gpio_mockup_pdevs[i];
+               if (!pdev)
+                       continue;
+
+               fwnode = dev_fwnode(&pdev->dev);
+               platform_device_unregister(pdev);
+               fwnode_remove_software_node(fwnode);
+       }
 }
 
 static __init char **gpio_mockup_make_line_names(const char *label,
@@ -508,6 +518,7 @@ static int __init gpio_mockup_register_chip(int idx)
        struct property_entry properties[GPIO_MOCKUP_MAX_PROP];
        struct platform_device_info pdevinfo;
        struct platform_device *pdev;
+       struct fwnode_handle *fwnode;
        char **line_names = NULL;
        char chip_label[32];
        int prop = 0, base;
@@ -536,13 +547,18 @@ static int __init gpio_mockup_register_chip(int idx)
                                        "gpio-line-names", line_names, ngpio);
        }
 
+       fwnode = fwnode_create_software_node(properties, NULL);
+       if (IS_ERR(fwnode))
+               return PTR_ERR(fwnode);
+
        pdevinfo.name = "gpio-mockup";
        pdevinfo.id = idx;
-       pdevinfo.properties = properties;
+       pdevinfo.fwnode = fwnode;
 
        pdev = platform_device_register_full(&pdevinfo);
        kfree_strarray(line_names, ngpio);
        if (IS_ERR(pdev)) {
+               fwnode_remove_software_node(fwnode);
                pr_err("error registering device");
                return PTR_ERR(pdev);
        }
--
Quoted 2 lines

2.33.0

I suppose my gpio-sim patch is affected by this issue too. Thanks for fixing that.

Bart

#4 lore raw
Quoted 5 lines · Bartosz Golaszewski

On Tue, Oct 5, 2021 at 11:10 AM Andy Shevchenko
<[email protected]> wrote:

I suppose my gpio-sim patch is affected by this issue too. Thanks for fixing that.

As far as I remember the code (it was pretty much inherited from gpio-mockup) yes, it's also affected.

Btw, I just sent a v2.

Signature · 2 lines
With Best Regards,
Andy Shevchenko