Skip to contentSkip to conversation

arch: powerpc: platforms: 85xx: Add missing of_node_put in sgy_cts1000.c

PATCH In review Liang He 3 participants 7 messages Jun 16, 2022 – Jun 17, 2022

Subsystems (2)
lore
Share & tools
lore

Liang He

author
#0 lore raw

PATCH v2 1/1 arch: powerpc: platforms: 85xx: Add missing of_node_put in sgy_cts1000.c

In gpio_halt_probe(), of_find_matching_node() will return a node pointer with refcount incremented. We should use of_node_put() in each fail path or when it is not used anymore.

---
changelog:

v2: use goto-label patch style advised by Christophe.
v1: add of_node_put() before each exit.

 arch/powerpc/platforms/85xx/sgy_cts1000.c | 27 +++++++++++++++--------
 1 file changed, 18 insertions(+), 9 deletions(-)
arch/powerpc/platforms/85xx/sgy_cts1000.c +18 -9
index 98ae64075193..e280f963d88c 100644
@@ -73,6 +73,7 @@ static int gpio_halt_probe(struct platform_device *pdev)
 	struct device_node *node = pdev->dev.of_node;
 	int gpio, err, irq;
 	int trigger;
+	int ret;
 
 	if (!node)
 		return -ENODEV;
@@ -84,20 +85,24 @@ static int gpio_halt_probe(struct platform_device *pdev)
 
 	/* Technically we could just read the first one, but punish
 	 * DT writers for invalid form. */
-	if (of_gpio_count(halt_node) != 1)
-		return -EINVAL;
+	if (of_gpio_count(halt_node) != 1) {
+		ret = -EINVAL;
+		goto err_put;
+	}
 
 	/* Get the gpio number relative to the dynamic base. */
 	gpio = of_get_gpio_flags(halt_node, 0, &flags);
-	if (!gpio_is_valid(gpio))
-		return -EINVAL;
+	if (!gpio_is_valid(gpio)) {
+		ret = -EINVAL;
+		gotot err_put;
+	}
 
 	err = gpio_request(gpio, "gpio-halt");
 	if (err) {
 		printk(KERN_ERR "gpio-halt: error requesting GPIO %d.\n",
 		       gpio);
-		halt_node = NULL;
-		return err;
+		ret = err;
+		goto err_put;
 	}
 
 	trigger = (flags == OF_GPIO_ACTIVE_LOW);
@@ -112,8 +117,8 @@ static int gpio_halt_probe(struct platform_device *pdev)
 		printk(KERN_ERR "gpio-halt: error requesting IRQ %d for "
 		       "GPIO %d.\n", irq, gpio);
 		gpio_free(gpio);
-		halt_node = NULL;
-		return err;
+		ret = err;
+		goto err_put;
 	}
 
 	/* Register our halt function */
@@ -122,8 +127,12 @@ static int gpio_halt_probe(struct platform_device *pdev)
 
 	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
 	       " irq).\n", gpio, trigger, irq);
+	ret = 0;
 
-	return 0;
+err_put:
+	of_node_put(halt_node);
+	halt_node = NULL;
+	return ret;
 }
 
 static int gpio_halt_remove(struct platform_device *pdev)
Signature · 1 line
2.25.1
#1 lore raw

Le 16/06/2022 à 17:19, Liang He a écrit :

Quoted 69 lines

In gpio_halt_probe(), of_find_matching_node() will return a node pointer with refcount incremented. We should use of_node_put() in each fail path or when it is not used anymore.

---
changelog:

v2: use goto-label patch style advised by Christophe.
v1: add of_node_put() before each exit.

  arch/powerpc/platforms/85xx/sgy_cts1000.c | 27 +++++++++++++++--------
  1 file changed, 18 insertions(+), 9 deletions(-)
arch/powerpc/platforms/85xx/sgy_cts1000.c +13 -8
index 98ae64075193..e280f963d88c 100644
@@ -73,6 +73,7 @@ static int gpio_halt_probe(struct platform_device *pdev)
  	struct device_node *node = pdev->dev.of_node;
  	int gpio, err, irq;
  	int trigger;
+	int ret;
 
  	if (!node)
  		return -ENODEV;
@@ -84,20 +85,24 @@ static int gpio_halt_probe(struct platform_device *pdev)
 
  	/* Technically we could just read the first one, but punish
  	 * DT writers for invalid form. */
-	if (of_gpio_count(halt_node) != 1)
-		return -EINVAL;
+	if (of_gpio_count(halt_node) != 1) {
+		ret = -EINVAL;
+		goto err_put;
+	}
 
  	/* Get the gpio number relative to the dynamic base. */
  	gpio = of_get_gpio_flags(halt_node, 0, &flags);
-	if (!gpio_is_valid(gpio))
-		return -EINVAL;
+	if (!gpio_is_valid(gpio)) {
+		ret = -EINVAL;
+		gotot err_put;
+	}
 
  	err = gpio_request(gpio, "gpio-halt");
  	if (err) {
  		printk(KERN_ERR "gpio-halt: error requesting GPIO %d.\n",
  		       gpio);
-		halt_node = NULL;
-		return err;
+		ret = err;
+		goto err_put;
  	}
 
  	trigger = (flags == OF_GPIO_ACTIVE_LOW);
@@ -112,8 +117,8 @@ static int gpio_halt_probe(struct platform_device *pdev)
  		printk(KERN_ERR "gpio-halt: error requesting IRQ %d for "
  		       "GPIO %d.\n", irq, gpio);
  		gpio_free(gpio);
-		halt_node = NULL;
-		return err;
+		ret = err;
+		goto err_put;
  	}
 
  	/* Register our halt function */

arch/powerpc/platforms/85xx/sgy_cts1000.c static int gpio_halt_probe(struct platform_device *pdev) · line 134

Quoted 9 lines
arch/powerpc/platforms/85xx/sgy_cts1000.c +4 -1
@@ -122,8 +127,12 @@ static int gpio_halt_probe(struct platform_device *pdev)
 
  	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
  	       " irq).\n", gpio, trigger, irq);
+	ret = 0;
 
-	return 0;
+err_put:
+	of_node_put(halt_node);
+	halt_node = NULL;

Hi,
so now we set 'halt_node' to NULL even in the normal case. This is really spurious.

Look at gpio_halt_cb(), but I think that this is just wrong and badly breaks this driver.

CJ

Quoted 4 lines
arch/powerpc/platforms/85xx/sgy_cts1000.c +1 -0
+	return ret;
  }
 
  static int gpio_halt_remove(struct platform_device *pdev)
#2 lore raw
Quoted 20 lines · Christophe JAILLET

Le 16/06/2022 à 17:19, Liang He a écrit :

Quoted 19 lines

In gpio_halt_probe(), of_find_matching_node() will return a node pointer with refcount incremented. We should use of_node_put() in each fail path or when it is not used anymore.

---
changelog:

v2: use goto-label patch style advised by Christophe.
v1: add of_node_put() before each exit.

  arch/powerpc/platforms/85xx/sgy_cts1000.c | 27 +++++++++++++++--------
  1 file changed, 18 insertions(+), 9 deletions(-)
arch/powerpc/platforms/85xx/sgy_cts1000.c +0 -0
index 98ae64075193..e280f963d88c 100644
@@ -73,6 +73,7 @@ static int gpio_halt_probe(struct platform_device *pdev)

...

Quoted 15 lines

arch/powerpc/platforms/85xx/sgy_cts1000.c static int gpio_halt_probe(struct platform_device *pdev) · line 134

Quoted 10 lines
arch/powerpc/platforms/85xx/sgy_cts1000.c +4 -1
@@ -122,8 +127,12 @@ static int gpio_halt_probe(struct platform_device *pdev)
 
  	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
  	       " irq).\n", gpio, trigger, irq);
+	ret = 0;
 
-	return 0;
+err_put:
+	of_node_put(halt_node);
+	halt_node = NULL;

Hi,
so now we set 'halt_node' to NULL even in the normal case. This is really spurious.

Quoted 2 lines

Look at gpio_halt_cb(), but I think that this is just wrong and badly breaks this driver.

I agree, thanks for reviewing.

I think the cleanest solution is to use a local variable for the node in the body of gpio_halt_probe(), and only assign to halt_node once all the checks have passed.

So something like:

        struct device_node *child_node;

	child_node = of_find_matching_node(node, child_match);
        ...

	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
	       " irq).\n", gpio, trigger, irq);
        ret = 0;
        halt_node = of_node_get(child_node);

out_put:

        of_node_put(child_node);
        
	return ret;
}

cheers

author
#3 lore raw
Quoted 58 lines · Michael Ellerman
Quoted 20 lines · Christophe JAILLET

Le 16/06/2022 à 17:19, Liang He a écrit :

Quoted 19 lines

In gpio_halt_probe(), of_find_matching_node() will return a node pointer with refcount incremented. We should use of_node_put() in each fail path or when it is not used anymore.

---
changelog:

v2: use goto-label patch style advised by Christophe.
v1: add of_node_put() before each exit.

  arch/powerpc/platforms/85xx/sgy_cts1000.c | 27 +++++++++++++++--------
  1 file changed, 18 insertions(+), 9 deletions(-)
arch/powerpc/platforms/85xx/sgy_cts1000.c +0 -0
index 98ae64075193..e280f963d88c 100644
@@ -73,6 +73,7 @@ static int gpio_halt_probe(struct platform_device *pdev)

...

Quoted 15 lines

arch/powerpc/platforms/85xx/sgy_cts1000.c static int gpio_halt_probe(struct platform_device *pdev) · line 134

Quoted 10 lines
arch/powerpc/platforms/85xx/sgy_cts1000.c +4 -1
@@ -122,8 +127,12 @@ static int gpio_halt_probe(struct platform_device *pdev)
 
  	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
  	       " irq).\n", gpio, trigger, irq);
+	ret = 0;
 
-	return 0;
+err_put:
+	of_node_put(halt_node);
+	halt_node = NULL;

Hi,
so now we set 'halt_node' to NULL even in the normal case. This is really spurious.

Quoted 2 lines

Look at gpio_halt_cb(), but I think that this is just wrong and badly breaks this driver.

I agree, thanks for reviewing.

I think the cleanest solution is to use a local variable for the node in the body of gpio_halt_probe(), and only assign to halt_node once all the checks have passed.

So something like:

       struct device_node *child_node;

	child_node = of_find_matching_node(node, child_match);
       ...

	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
	       " irq).\n", gpio, trigger, irq);
       ret = 0;
       halt_node = of_node_get(child_node);
Quoted 8 lines

out_put:

       of_node_put(child_node);
       
	return ret;
}

cheers

Thanks, Michael and Christophe.

I will send a patch based on your reviews.

Liang

author
#4 lore raw
In reply to Michael Ellerman
Quoted 58 lines · Michael Ellerman
Quoted 20 lines · Christophe JAILLET

Le 16/06/2022 à 17:19, Liang He a écrit :

Quoted 19 lines

In gpio_halt_probe(), of_find_matching_node() will return a node pointer with refcount incremented. We should use of_node_put() in each fail path or when it is not used anymore.

---
changelog:

v2: use goto-label patch style advised by Christophe.
v1: add of_node_put() before each exit.

  arch/powerpc/platforms/85xx/sgy_cts1000.c | 27 +++++++++++++++--------
  1 file changed, 18 insertions(+), 9 deletions(-)
arch/powerpc/platforms/85xx/sgy_cts1000.c +0 -0
index 98ae64075193..e280f963d88c 100644
@@ -73,6 +73,7 @@ static int gpio_halt_probe(struct platform_device *pdev)

...

Quoted 15 lines

arch/powerpc/platforms/85xx/sgy_cts1000.c static int gpio_halt_probe(struct platform_device *pdev) · line 134

Quoted 10 lines
arch/powerpc/platforms/85xx/sgy_cts1000.c +4 -1
@@ -122,8 +127,12 @@ static int gpio_halt_probe(struct platform_device *pdev)
 
  	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
  	       " irq).\n", gpio, trigger, irq);
+	ret = 0;
 
-	return 0;
+err_put:
+	of_node_put(halt_node);
+	halt_node = NULL;

Hi,
so now we set 'halt_node' to NULL even in the normal case. This is really spurious.

Quoted 2 lines

Look at gpio_halt_cb(), but I think that this is just wrong and badly breaks this driver.

I agree, thanks for reviewing.

I think the cleanest solution is to use a local variable for the node in the body of gpio_halt_probe(), and only assign to halt_node once all the checks have passed.

So something like:

       struct device_node *child_node;

	child_node = of_find_matching_node(node, child_match);
       ...

	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
	       " irq).\n", gpio, trigger, irq);
       ret = 0;
       halt_node = of_node_get(child_node);
Quoted 8 lines

out_put:

       of_node_put(child_node);
       
	return ret;
}

cheers

Hi, Michael and Christophe,

I am writing the new patch based on Michael's advice. However, I wonder if there is any place to call of_node_put(halt_node)? As I do not exactly know if gpio_halt_remove() or anyother place can correctly release this global reference?
If not, it is correct that I add a of_node_put(halt_node) in gpio_halt_remove(), right?

Thanks and wait for your replies.

Liang

#5 lore raw
Quoted 66 lines · Liang He
Quoted 65 lines · Michael Ellerman
Quoted 20 lines · Christophe JAILLET

Le 16/06/2022 à 17:19, Liang He a écrit :

Quoted 19 lines

In gpio_halt_probe(), of_find_matching_node() will return a node pointer with refcount incremented. We should use of_node_put() in each fail path or when it is not used anymore.

---
changelog:

v2: use goto-label patch style advised by Christophe.
v1: add of_node_put() before each exit.

  arch/powerpc/platforms/85xx/sgy_cts1000.c | 27 +++++++++++++++--------
  1 file changed, 18 insertions(+), 9 deletions(-)
arch/powerpc/platforms/85xx/sgy_cts1000.c +0 -0
index 98ae64075193..e280f963d88c 100644
@@ -73,6 +73,7 @@ static int gpio_halt_probe(struct platform_device *pdev)

...

Quoted 15 lines

arch/powerpc/platforms/85xx/sgy_cts1000.c static int gpio_halt_probe(struct platform_device *pdev) · line 134

Quoted 10 lines
arch/powerpc/platforms/85xx/sgy_cts1000.c +4 -1
@@ -122,8 +127,12 @@ static int gpio_halt_probe(struct platform_device *pdev)
 
  	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
  	       " irq).\n", gpio, trigger, irq);
+	ret = 0;
 
-	return 0;
+err_put:
+	of_node_put(halt_node);
+	halt_node = NULL;

Hi,
so now we set 'halt_node' to NULL even in the normal case. This is really spurious.

Quoted 2 lines

Look at gpio_halt_cb(), but I think that this is just wrong and badly breaks this driver.

I agree, thanks for reviewing.

I think the cleanest solution is to use a local variable for the node in the body of gpio_halt_probe(), and only assign to halt_node once all the checks have passed.

So something like:

       struct device_node *child_node;

	child_node = of_find_matching_node(node, child_match);
       ...

	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
	       " irq).\n", gpio, trigger, irq);
       ret = 0;
       halt_node = of_node_get(child_node);

out_put:

       of_node_put(child_node);
       
	return ret;
}
Quoted 8 lines
Quoted 1 line

cheers

Hi, Michael and Christophe,

I am writing the new patch based on Michael's advice. However, I wonder if there is any place to call of_node_put(halt_node)? As I do not exactly know if gpio_halt_remove() or anyother place can correctly release this global reference?
If not, it is correct that I add a of_node_put(halt_node) in gpio_halt_remove(), right?

Yes I think so, just before it's set to NULL, eg:

arch/powerpc/platforms/85xx/sgy_cts1000.c +1 -0
index 98ae64075193..7beb3cd420ba 100644
@@ -139,6 +139,7 @@ static int gpio_halt_remove(struct platform_device *pdev)
 
 		gpio_free(gpio);
 
+		of_node_put(halt_node);
 		halt_node = NULL;
 	}
 

cheers

author
#6 lore raw

 2022-06-17 12:29:02,"Michael Ellerman" <[email protected]> 写道:
Quoted 91 lines
Quoted 66 lines · Liang He
Quoted 65 lines · Michael Ellerman
Quoted 20 lines · Christophe JAILLET

Le 16/06/2022 à 17:19, Liang He a écrit :

Quoted 19 lines

In gpio_halt_probe(), of_find_matching_node() will return a node pointer with refcount incremented. We should use of_node_put() in each fail path or when it is not used anymore.

---
changelog:

v2: use goto-label patch style advised by Christophe.
v1: add of_node_put() before each exit.

  arch/powerpc/platforms/85xx/sgy_cts1000.c | 27 +++++++++++++++--------
  1 file changed, 18 insertions(+), 9 deletions(-)
arch/powerpc/platforms/85xx/sgy_cts1000.c +0 -0
index 98ae64075193..e280f963d88c 100644
@@ -73,6 +73,7 @@ static int gpio_halt_probe(struct platform_device *pdev)

...

Quoted 15 lines

arch/powerpc/platforms/85xx/sgy_cts1000.c static int gpio_halt_probe(struct platform_device *pdev) · line 134

Quoted 10 lines
arch/powerpc/platforms/85xx/sgy_cts1000.c +4 -1
@@ -122,8 +127,12 @@ static int gpio_halt_probe(struct platform_device *pdev)
 
  	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
  	       " irq).\n", gpio, trigger, irq);
+	ret = 0;
 
-	return 0;
+err_put:
+	of_node_put(halt_node);
+	halt_node = NULL;

Hi,
so now we set 'halt_node' to NULL even in the normal case. This is really spurious.

Quoted 2 lines

Look at gpio_halt_cb(), but I think that this is just wrong and badly breaks this driver.

I agree, thanks for reviewing.

I think the cleanest solution is to use a local variable for the node in the body of gpio_halt_probe(), and only assign to halt_node once all the checks have passed.

So something like:

       struct device_node *child_node;

	child_node = of_find_matching_node(node, child_match);
       ...

	printk(KERN_INFO "gpio-halt: registered GPIO %d (%d trigger, %d"
	       " irq).\n", gpio, trigger, irq);
       ret = 0;
       halt_node = of_node_get(child_node);

out_put:

       of_node_put(child_node);
       
	return ret;
}
Quoted 8 lines
Quoted 1 line

cheers

Hi, Michael and Christophe,

I am writing the new patch based on Michael's advice. However, I wonder if there is any place to call of_node_put(halt_node)? As I do not exactly know if gpio_halt_remove() or anyother place can correctly release this global reference?
If not, it is correct that I add a of_node_put(halt_node) in gpio_halt_remove(), right?

Yes I think so, just before it's set to NULL, eg:

arch/powerpc/platforms/85xx/sgy_cts1000.c +1 -0
index 98ae64075193..7beb3cd420ba 100644
@@ -139,6 +139,7 @@ static int gpio_halt_remove(struct platform_device *pdev)
 
 		gpio_free(gpio);
 
+		of_node_put(halt_node);
 		halt_node = NULL;
 	}
 
Quoted 1 line

cheers

Ok, I will make the new patch soon.