Skip to contentSkip to conversation

gpio: initialize descriptor SRCU structure before adding OF-based chips

PATCH In review Bartosz Golaszewski 2 participants 4 messages Feb 12, 2024 – Feb 14, 2024 GPIO

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 gpio: initialize descriptor SRCU structure before adding OF-based chips

From: Bartosz Golaszewski <[email protected]>

In certain situations we may end up taking the GPIO descriptor SRCU read lock in of_gpiochip_add() before the SRCU struct is initialized. Move the initialization before the call to of_gpiochip_add().

Fixes be711caa87c5 ("gpio: add SRCU infrastructure to struct gpio_desc")
Fixes 1f2bcb8c8ccd ("gpio: protect the descriptor label with SRCU")
---
 drivers/gpio/gpiolib.c | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
drivers/gpio/gpiolib.c +9 -9
index 82811d9a4477..f5434e559382 100644
@@ -991,10 +991,6 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 	if (ret)
 		goto err_cleanup_gdev_srcu;
 
-	ret = of_gpiochip_add(gc);
-	if (ret)
-		goto err_free_gpiochip_mask;
-
 	for (i = 0; i < gc->ngpio; i++) {
 		struct gpio_desc *desc = &gdev->descs[i];
 
@@ -1002,7 +998,7 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 		if (ret) {
 			for (j = 0; j < i; j++)
 				cleanup_srcu_struct(&gdev->descs[j].srcu);
-			goto err_remove_of_chip;
+			goto err_free_gpiochip_mask;
 		}
 
 		if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
@@ -1014,10 +1010,14 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 		}
 	}
 
-	ret = gpiochip_add_pin_ranges(gc);
+	ret = of_gpiochip_add(gc);
 	if (ret)
 		goto err_cleanup_desc_srcu;
 
+	ret = gpiochip_add_pin_ranges(gc);
+	if (ret)
+		goto err_remove_of_chip;
+
 	acpi_gpiochip_add(gc);
 
 	machine_gpiochip_add(gc);
@@ -1055,12 +1055,12 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 	gpiochip_irqchip_free_valid_mask(gc);
 err_remove_acpi_chip:
 	acpi_gpiochip_remove(gc);
-err_cleanup_desc_srcu:
-	for (i = 0; i < gdev->ngpio; i++)
-		cleanup_srcu_struct(&gdev->descs[i].srcu);
 err_remove_of_chip:
 	gpiochip_free_hogs(gc);
 	of_gpiochip_remove(gc);
+err_cleanup_desc_srcu:
+	for (i = 0; i < gdev->ngpio; i++)
+		cleanup_srcu_struct(&gdev->descs[i].srcu);
 err_free_gpiochip_mask:
 	gpiochip_remove_pin_ranges(gc);
 	gpiochip_free_valid_mask(gc);
Signature · 1 line
2.40.1
#1 lore raw
Quoted 5 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

In certain situations we may end up taking the GPIO descriptor SRCU read lock in of_gpiochip_add() before the SRCU struct is initialized. Move the initialization before the call to of_gpiochip_add().

...

This is a bit unclear why you moved to that place and how it had been tested.

Quoted 24 lines
drivers/gpio/gpiolib.c +0 -4
@@ -991,10 +991,6 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 	if (ret)
 		goto err_cleanup_gdev_srcu;
 
-	ret = of_gpiochip_add(gc);
-	if (ret)
-		goto err_free_gpiochip_mask;
-
 	for (i = 0; i < gc->ngpio; i++) {
 		struct gpio_desc *desc = &gdev->descs[i];
 
(quoted diff) +1 -1
 		if (ret) {
 			for (j = 0; j < i; j++)
 				cleanup_srcu_struct(&gdev->descs[j].srcu);
-			goto err_remove_of_chip;
+			goto err_free_gpiochip_mask;
 		}
 
 		if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
 
 		}
 	}
 

Review

Quoted 10 lines
(quoted diff) +5 -1
-	ret = gpiochip_add_pin_ranges(gc);
+	ret = of_gpiochip_add(gc);
 	if (ret)
 		goto err_cleanup_desc_srcu;
 
+	ret = gpiochip_add_pin_ranges(gc);
+	if (ret)
+		goto err_remove_of_chip;
+
 	acpi_gpiochip_add(gc);

My logic tells me that if you need to call gpiochip_add_pin_ranges() before calling of_gpiochip_add(). It won't collide right now, but allows to cleanup further (with the gpio-ranges parser be generalized for fwnodes and be moved to gpiolib.c from gpiolib-of.c).

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#2 lore raw
Quoted 4 lines · Andy Shevchenko
Quoted 2 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

Quoted 8 lines
Quoted 3 lines

In certain situations we may end up taking the GPIO descriptor SRCU read lock in of_gpiochip_add() before the SRCU struct is initialized. Move the initialization before the call to of_gpiochip_add().

...

This is a bit unclear why you moved to that place and how it had been tested.

I didn't move it, I just added SRCU before it. It can be triggered by a simple hog from DT. The link leads to a crash report.

Quoted 35 lines
Quoted 24 lines
drivers/gpio/gpiolib.c +0 -4
@@ -991,10 +991,6 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
      if (ret)
              goto err_cleanup_gdev_srcu;
 
-     ret = of_gpiochip_add(gc);
-     if (ret)
-             goto err_free_gpiochip_mask;
-
      for (i = 0; i < gc->ngpio; i++) {
              struct gpio_desc *desc = &gdev->descs[i];
 
              if (ret) {
                      for (j = 0; j < i; j++)
                              cleanup_srcu_struct(&gdev->descs[j].srcu);
drivers/gpio/gpiolib.c +1 -1
-                     goto err_remove_of_chip;
+                     goto err_free_gpiochip_mask;
              }
 
              if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
 
              }
      }
 

drivers/gpio/gpiolib.c int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data, · line 1021

Quoted 10 lines
drivers/gpio/gpiolib.c +5 -1
-     ret = gpiochip_add_pin_ranges(gc);
+     ret = of_gpiochip_add(gc);
      if (ret)
              goto err_cleanup_desc_srcu;
 
+     ret = gpiochip_add_pin_ranges(gc);
+     if (ret)
+             goto err_remove_of_chip;
+
      acpi_gpiochip_add(gc);
Quoted 5 lines

My logic tells me that if you need to call gpiochip_add_pin_ranges() before calling of_gpiochip_add(). It won't collide right now, but allows to cleanup further (with the gpio-ranges parser be generalized for fwnodes and be moved to gpiolib.c from gpiolib-of.c).

But it was already called before gpiochip_add_pin_ranges() so it's material for another patch.

Bart

Quoted 5 lines

--
With Best Regards,
Andy Shevchenko

#3 lore raw
In reply to Bartosz Golaszewski
Quoted 7 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

In certain situations we may end up taking the GPIO descriptor SRCU read lock in of_gpiochip_add() before the SRCU struct is initialized. Move the initialization before the call to of_gpiochip_add().

Quoted 6 lines
Fixes be711caa87c5 ("gpio: add SRCU infrastructure to struct gpio_desc")
Fixes 1f2bcb8c8ccd ("gpio: protect the descriptor label with SRCU")

---

I'm queuing this quickly because next is currently broken for many platforms.

Bartosz