netdev - Re: [PATCH net-next v2 06/11] net: stmmac: dwmac-qcom-ethqos: Convert to platform remove callback returning void

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAH=2Ntyc-Oi-FCNQJbLwgyWT8Tt7tVpHO7HOc=hM2RdNweOzjg@mail.gmail.com>
Date: Tue, 9 May 2023 13:21:56 +0530
From: Bhupesh Sharma <bhupesh.sharma@...aro.org>
To: Uwe Kleine-König <u.kleine-koenig@...gutronix.de>
Cc: Vinod Koul <vkoul@...nel.org>, Giuseppe Cavallaro <peppe.cavallaro@...com>, 
	Alexandre Torgue <alexandre.torgue@...s.st.com>, Jose Abreu <joabreu@...opsys.com>, 
	"David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, 
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>, 
	Maxime Coquelin <mcoquelin.stm32@...il.com>, netdev@...r.kernel.org, 
	linux-stm32@...md-mailman.stormreply.com, 
	linux-arm-kernel@...ts.infradead.org, kernel@...gutronix.de, 
	Simon Horman <simon.horman@...igine.com>
Subject: Re: [PATCH net-next v2 06/11] net: stmmac: dwmac-qcom-ethqos: Convert
 to platform remove callback returning void

Hi Uwe,

On Mon, 8 May 2023 at 19:56, Uwe Kleine-König
<u.kleine-koenig@...gutronix.de> wrote:
>
> The .remove() callback for a platform driver returns an int which makes
> many driver authors wrongly assume it's possible to do error handling by
> returning an error code. However the value returned is (mostly) ignored

^^^ mostly, here seems confusing. Only if the return value is ignored
marking the function
as 'void' makes sense IMO.

> and this typically results in resource leaks. To improve here there is a
> quest to make the remove callback return void. In the first step of this
> quest all drivers are converted to .remove_new() which already returns
> void.
>
> Trivially convert this driver from always returning zero in the remove
> callback to the void returning variant.
>
> Reviewed-by: Simon Horman <simon.horman@...igine.com>
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@...gutronix.de>
> ---
>  drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c b/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c
> index bf17c6c8f2eb..1db97a5209c4 100644
> --- a/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c
> +++ b/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c
> @@ -665,14 +665,12 @@ static int qcom_ethqos_probe(struct platform_device *pdev)
>         return ret;
>  }
>
> -static int qcom_ethqos_remove(struct platform_device *pdev)
> +static void qcom_ethqos_remove(struct platform_device *pdev)
>  {
>         struct qcom_ethqos *ethqos = get_stmmac_bsp_priv(&pdev->dev);
>
>         stmmac_pltfr_remove(pdev);
>         ethqos_clks_config(ethqos, false);
> -
> -       return 0;
>  }
>
>  static const struct of_device_id qcom_ethqos_match[] = {
> @@ -685,7 +683,7 @@ MODULE_DEVICE_TABLE(of, qcom_ethqos_match);
>
>  static struct platform_driver qcom_ethqos_driver = {
>         .probe  = qcom_ethqos_probe,
> -       .remove = qcom_ethqos_remove,
> +       .remove_new = qcom_ethqos_remove,
>         .driver = {
>                 .name           = "qcom-ethqos",
>                 .pm             = &stmmac_pltfr_pm_ops,
> --
> 2.39.2

Also a small note (maybe a TBD) indicating that 'remove_new' will be
eventually replaced with 'remove' would make reading this easier. Rest
seems fine, so:

Reviewed-by: Bhupesh Sharma <bhupesh.sharma@...aro.org>

Thanks.