[PATCH net v2] net: lan966x: remove debugfs directory in probe() error path

[PATCH net v2] net: lan966x: remove debugfs directory in probe() error path

[Herve Codina]

A debugfs directory entry is create early during probe(). This entry is
not removed on error path leading to some "already present" issues in
case of EPROBE_DEFER.

Create this entry later in the probe() code to avoid the need to change
many 'return' in 'goto' and add the removal in the already present error
path.

Fixes: 942814840127 ("net: lan966x: Add VCAP debugFS support")
Cc: <stable@vger.kernel.org>
Signed-off-by: Herve Codina <herve.codina@bootlin.com>
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
---
 drivers/net/ethernet/microchip/lan966x/lan966x_main.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/drivers/net/ethernet/microchip/lan966x/lan966x_main.c b/drivers/net/ethernet/microchip/lan966x/lan966x_main.c
index 2635ef8958c8..61d88207eed4 100644
--- a/drivers/net/ethernet/microchip/lan966x/lan966x_main.c
+++ b/drivers/net/ethernet/microchip/lan966x/lan966x_main.c
@@ -1087,8 +1087,6 @@ static int lan966x_probe(struct platform_device *pdev)
 	platform_set_drvdata(pdev, lan966x);
 	lan966x->dev = &pdev->dev;
 
-	lan966x->debugfs_root = debugfs_create_dir("lan966x", NULL);
-
 	if (!device_get_mac_address(&pdev->dev, mac_addr)) {
 		ether_addr_copy(lan966x->base_mac, mac_addr);
 	} else {
@@ -1179,6 +1177,8 @@ static int lan966x_probe(struct platform_device *pdev)
 		return dev_err_probe(&pdev->dev, -ENODEV,
 				     "no ethernet-ports child found\n");
 
+	lan966x->debugfs_root = debugfs_create_dir("lan966x", NULL);
+
 	/* init switch */
 	lan966x_init(lan966x);
 	lan966x_stats_init(lan966x);
@@ -1257,6 +1257,8 @@ static int lan966x_probe(struct platform_device *pdev)
 	destroy_workqueue(lan966x->stats_queue);
 	mutex_destroy(&lan966x->stats_lock);
 
+	debugfs_remove_recursive(lan966x->debugfs_root);
+
 	return err;
 }
 
-- 

This patch was previously sent as part of a bigger series:
  https://lore.kernel.org/lkml/20240430083730.134918-9-herve.codina@bootlin.com/
As it is a simple fix, this v2 is the patch extracted from the series
and sent alone to net.

Changes v1 -> v2
  Add 'Reviewed-by: Andrew Lunn <andrew@lunn.ch>'

2.44.0

Re: [PATCH net v2] net: lan966x: remove debugfs directory in probe() error path

[Horatiu Vultur]

Hi,

The 05/13/2024 13:18, Herve Codina wrote:
> 
> A debugfs directory entry is create early during probe(). This entry is
> not removed on error path leading to some "already present" issues in
> case of EPROBE_DEFER.
> 
> Create this entry later in the probe() code to avoid the need to change
> many 'return' in 'goto' and add the removal in the already present error
> path.
> 
> Fixes: 942814840127 ("net: lan966x: Add VCAP debugFS support")
> Cc: <stable@vger.kernel.org>
> Signed-off-by: Herve Codina <herve.codina@bootlin.com>
> Reviewed-by: Andrew Lunn <andrew@lunn.ch>

This looks OK to me. As the debugfs_root is used inside lan966x_vcap_init
which is called at the end of the probe.

Reviewed-by: Horatiu Vultur <horatiu.vultur@microchip.com>

> ---
>  drivers/net/ethernet/microchip/lan966x/lan966x_main.c | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/net/ethernet/microchip/lan966x/lan966x_main.c b/drivers/net/ethernet/microchip/lan966x/lan966x_main.c
> index 2635ef8958c8..61d88207eed4 100644
> --- a/drivers/net/ethernet/microchip/lan966x/lan966x_main.c
> +++ b/drivers/net/ethernet/microchip/lan966x/lan966x_main.c
> @@ -1087,8 +1087,6 @@ static int lan966x_probe(struct platform_device *pdev)
>         platform_set_drvdata(pdev, lan966x);
>         lan966x->dev = &pdev->dev;
> 
> -       lan966x->debugfs_root = debugfs_create_dir("lan966x", NULL);
> -
>         if (!device_get_mac_address(&pdev->dev, mac_addr)) {
>                 ether_addr_copy(lan966x->base_mac, mac_addr);
>         } else {
> @@ -1179,6 +1177,8 @@ static int lan966x_probe(struct platform_device *pdev)
>                 return dev_err_probe(&pdev->dev, -ENODEV,
>                                      "no ethernet-ports child found\n");
> 
> +       lan966x->debugfs_root = debugfs_create_dir("lan966x", NULL);
> +
>         /* init switch */
>         lan966x_init(lan966x);
>         lan966x_stats_init(lan966x);
> @@ -1257,6 +1257,8 @@ static int lan966x_probe(struct platform_device *pdev)
>         destroy_workqueue(lan966x->stats_queue);
>         mutex_destroy(&lan966x->stats_lock);
> 
> +       debugfs_remove_recursive(lan966x->debugfs_root);
> +
>         return err;
>  }
> 
> --
> 
> This patch was previously sent as part of a bigger series:
>   https://lore.kernel.org/lkml/20240430083730.134918-9-herve.codina@bootlin.com/
> As it is a simple fix, this v2 is the patch extracted from the series
> and sent alone to net.
> 
> Changes v1 -> v2
>   Add 'Reviewed-by: Andrew Lunn <andrew@lunn.ch>'
> 
> 2.44.0

-- 
/Horatiu

Re: [PATCH net v2] net: lan966x: remove debugfs directory in probe() error path

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (main)
by David S. Miller <davem@davemloft.net>:

On Mon, 13 May 2024 13:18:53 +0200 you wrote:
> A debugfs directory entry is create early during probe(). This entry is
> not removed on error path leading to some "already present" issues in
> case of EPROBE_DEFER.
> 
> Create this entry later in the probe() code to avoid the need to change
> many 'return' in 'goto' and add the removal in the already present error
> path.
> 
> [...]

Here is the summary with links:
  - [net,v2] net: lan966x: remove debugfs directory in probe() error path
    https://git.kernel.org/netdev/net/c/99975ad644c7

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html