Skip to contentSkip to conversation

gpio: cdev: sanitize the label before requesting the interrupt

PATCH Superseded Bartosz Golaszewski 2 participants 4 messages Mar 22, 2024

Subsystems (3)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 gpio: cdev: sanitize the label before requesting the interrupt

From: Bartosz Golaszewski <[email protected]>

When an interrupt is requested, a procfs directory is created under "/proc/irq/<irqnum>/<label>" where <label> is the string passed to one of the request_irq() variants.

What follows is that the string must not contain the "/" character or the procfs mkdir operation will fail. We don't have such constraints for GPIO consumer labels which are used verbatim as interrupt labels for GPIO irqs. We must therefore sanitize the consumer string before requesting the interrupt.

Let's replace all "/" with ":".

---
v1 -> v2:
- use ':' as the delimiter instead of '-'
- return -ENOMEM if creating the label fails

 drivers/gpio/gpiolib-cdev.c | 34 +++++++++++++++++++++++++++++-----
 1 file changed, 29 insertions(+), 5 deletions(-)
drivers/gpio/gpiolib-cdev.c +29 -5
index f384fa278764..7a102ebac428 100644
@@ -1083,10 +1083,20 @@ static u32 gpio_v2_line_config_debounce_period(struct gpio_v2_line_config *lc,
 	return 0;
 }
 
+static inline char *make_irq_label(const char *orig)
+{
+	return kstrdup_and_replace(orig, '/', ':', GFP_KERNEL);
+}
+
+static inline void free_irq_label(const char *label)
+{
+	kfree(label);
+}
+
 static void edge_detector_stop(struct line *line)
 {
 	if (line->irq) {
-		free_irq(line->irq, line);
+		free_irq_label(free_irq(line->irq, line));
 		line->irq = 0;
 	}
 
@@ -1110,6 +1120,7 @@ static int edge_detector_setup(struct line *line,
 	unsigned long irqflags = 0;
 	u64 eflags;
 	int irq, ret;
+	char *label;
 
 	eflags = edflags & GPIO_V2_LINE_EDGE_FLAGS;
 	if (eflags && !kfifo_initialized(&line->req->events)) {
@@ -1146,11 +1157,17 @@ static int edge_detector_setup(struct line *line,
 			IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
 	irqflags |= IRQF_ONESHOT;
 
+	label = make_irq_label(line->req->label);
+	if (!label)
+		return -ENOMEM;
+
 	/* Request a thread to read the events */
 	ret = request_threaded_irq(irq, edge_irq_handler, edge_irq_thread,
-				   irqflags, line->req->label, line);
-	if (ret)
+				   irqflags, label, line);
+	if (ret) {
+		free_irq_label(label);
 		return ret;
+	}
 
 	line->irq = irq;
 	return 0;
@@ -1973,7 +1990,7 @@ static void lineevent_free(struct lineevent_state *le)
 		blocking_notifier_chain_unregister(&le->gdev->device_notifier,
 						   &le->device_unregistered_nb);
 	if (le->irq)
-		free_irq(le->irq, le);
+		free_irq_label(free_irq(le->irq, le));
 	if (le->desc)
 		gpiod_free(le->desc);
 	kfree(le->label);
@@ -2114,6 +2131,7 @@ static int lineevent_create(struct gpio_device *gdev, void __user *ip)
 	int fd;
 	int ret;
 	int irq, irqflags = 0;
+	char *label;
 
 	if (copy_from_user(&eventreq, ip, sizeof(eventreq)))
 		return -EFAULT;
@@ -2198,12 +2216,18 @@ static int lineevent_create(struct gpio_device *gdev, void __user *ip)
 	if (ret)
 		goto out_free_le;
 
+	label = make_irq_label(le->label);
+	if (!label) {
+		ret = -ENOMEM;
+		goto out_free_le;
+	}
+
 	/* Request a thread to read the events */
 	ret = request_threaded_irq(irq,
 				   lineevent_irq_handler,
 				   lineevent_irq_thread,
 				   irqflags,
-				   le->label,
+				   label,
 				   le);
 	if (ret)
 		goto out_free_le;
Signature · 1 line
2.40.1
reviewer
#1 lore raw
Quoted 12 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

drivers/gpio/gpiolib-cdev.c +6 -0
@@ -2198,12 +2216,18 @@ static int lineevent_create(struct gpio_device *gdev, void __user *ip)
 	if (ret)
 		goto out_free_le;
 
+	label = make_irq_label(le->label);
+	if (!label) {
+		ret = -ENOMEM;
+		goto out_free_le;
+	}
+

drivers/gpio/gpiolib-cdev.c static int lineevent_create(struct gpio_device *gdev, void __user *ip) · line 2233

Quoted 10 lines
drivers/gpio/gpiolib-cdev.c +1 -1
 	/* Request a thread to read the events */
 	ret = request_threaded_irq(irq,
 				   lineevent_irq_handler,
 				   lineevent_irq_thread,
 				   irqflags,
-				   le->label,
+				   label,
 				   le);
 	if (ret)
 		goto out_free_le;

Leaks label if the request_threaded_irq() fails.

Cheers,
Kent.

#2 lore raw
Quoted 18 lines · Kent Gibson
Quoted 16 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

drivers/gpio/gpiolib-cdev.c +6 -0
@@ -2198,12 +2216,18 @@ static int lineevent_create(struct gpio_device *gdev, void __user *ip)
      if (ret)
              goto out_free_le;
 
+     label = make_irq_label(le->label);
+     if (!label) {
+             ret = -ENOMEM;
+             goto out_free_le;
+     }
+
      /* Request a thread to read the events */
      ret = request_threaded_irq(irq,
                                 lineevent_irq_handler,
                                 lineevent_irq_thread,
Quoted 9 lines

drivers/gpio/gpiolib-cdev.c static int lineevent_create(struct gpio_device *gdev, void __user *ip) · line 2233

Quoted 6 lines
drivers/gpio/gpiolib-cdev.c +1 -1
                                 irqflags,
-                                le->label,
+                                label,
                                 le);
      if (ret)
              goto out_free_le;

Leaks label if the request_threaded_irq() fails.

Ah, dammit, I didn't catch the fact that irq_free() will not return the label address if the request failed.

Nice catch.

Bart

reviewer
#3 lore raw
Quoted 29 lines · Bartosz Golaszewski
Quoted 18 lines · Kent Gibson
Quoted 16 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

drivers/gpio/gpiolib-cdev.c +6 -0
@@ -2198,12 +2216,18 @@ static int lineevent_create(struct gpio_device *gdev, void __user *ip)
      if (ret)
              goto out_free_le;
 
+     label = make_irq_label(le->label);
+     if (!label) {
+             ret = -ENOMEM;
+             goto out_free_le;
+     }
+
      /* Request a thread to read the events */
      ret = request_threaded_irq(irq,
                                 lineevent_irq_handler,
                                 lineevent_irq_thread,
Quoted 9 lines

drivers/gpio/gpiolib-cdev.c static int lineevent_create(struct gpio_device *gdev, void __user *ip) · line 2233

Quoted 6 lines
drivers/gpio/gpiolib-cdev.c +1 -1
                                 irqflags,
-                                le->label,
+                                label,
                                 le);
      if (ret)
              goto out_free_le;

Leaks label if the request_threaded_irq() fails.

Quoted 3 lines

Ah, dammit, I didn't catch the fact that irq_free() will not return the label address if the request failed.

You caught it in edge_detector_setup() - you call free_irq_label() if request_threaded_irq() fails there.

Quoted 1 line

Nice catch.

The give away here is that the goto targets are the same. Bit irritated that I didn't catch it earlier - got distracted by the return code problem.

Anyway, third time lucky.

Cheers,
Kent.