net:Fix an NULL vs IS_ERR() bug for debugfs_create_dir() in i40e_dbg_init()

[PATCH v2] net:Fix an NULL vs IS_ERR() bug for debugfs_create_dir() in i40e_dbg_init()

Posted by Wang Ming 2 years, 7 months ago

The debugfs_create_dir() function returns error pointers.
It never returns NULL. Most incorrect error checks were fixed,
but the one in i40e_dbg_init() was forgotten.

Fix the remaining error check.

Signed-off-by: Wang Ming <machel@vivo.com>
---
 drivers/net/ethernet/intel/i40e/i40e_debugfs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
index 9954493cd448..62497f5565c5 100644
--- a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
+++ b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
@@ -1839,7 +1839,7 @@ void i40e_dbg_pf_exit(struct i40e_pf *pf)
 void i40e_dbg_init(void)
 {
 	i40e_dbg_root = debugfs_create_dir(i40e_driver_name, NULL);
-	if (!i40e_dbg_root)
+	if (IS_ERR(i40e_dbg_root))
 		pr_info("init of debugfs failed\n");
 }
 
-- 
2.25.1

Re: [PATCH v2] net:Fix an NULL vs IS_ERR() bug for debugfs_create_dir() in i40e_dbg_init()

Posted by Tony Nguyen 2 years, 7 months ago

On 7/12/2023 5:19 AM, Wang Ming wrote:

Please designate a tree for the patch (net or net-next) [1].

If you could include the driver (i40e) in the commit title as well. 
Also, a nit, but the title is a bit long, seems like it could be a bit 
more succinct.

> The debugfs_create_dir() function returns error pointers.
> It never returns NULL. Most incorrect error checks were fixed,
> but the one in i40e_dbg_init() was forgotten.
> 
> Fix the remaining error check.

As it's a fix, there should be a Fixes tag as well.

> Signed-off-by: Wang Ming <machel@vivo.com>
> ---
>   drivers/net/ethernet/intel/i40e/i40e_debugfs.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> index 9954493cd448..62497f5565c5 100644
> --- a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> +++ b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> @@ -1839,7 +1839,7 @@ void i40e_dbg_pf_exit(struct i40e_pf *pf)
>   void i40e_dbg_init(void)
>   {
>   	i40e_dbg_root = debugfs_create_dir(i40e_driver_name, NULL);
> -	if (!i40e_dbg_root)
> +	if (IS_ERR(i40e_dbg_root))
>   		pr_info("init of debugfs failed\n");
>   }
>   

[1] 
https://www.kernel.org/doc/html/latest/process/maintainer-netdev.html#netdev-faq

回复: [PATCH v2] net:Fix an NULL vs IS_ERR() bug for debugfs_create_dir() in i40e_dbg_init()

Posted by 王明-软件底层技术部 2 years, 7 months ago

okay, I'm following your advice and resubmitting

-----邮件原件-----
发件人: Tony Nguyen <anthony.l.nguyen@intel.com> 
发送时间: 2023年7月13日 4:57
收件人: 王明-软件底层技术部 <machel@vivo.com>; Jesse Brandeburg <jesse.brandeburg@intel.com>; David S. Miller <davem@davemloft.net>; Eric Dumazet <edumazet@google.com>; Jakub Kicinski <kuba@kernel.org>; Paolo Abeni <pabeni@redhat.com>; intel-wired-lan@lists.osuosl.org; netdev@vger.kernel.org; linux-kernel@vger.kernel.org
抄送: opensource.kernel <opensource.kernel@vivo.com>
主题: Re: [PATCH v2] net:Fix an NULL vs IS_ERR() bug for debugfs_create_dir() in i40e_dbg_init()

On 7/12/2023 5:19 AM, Wang Ming wrote:

Please designate a tree for the patch (net or net-next) [1].

If you could include the driver (i40e) in the commit title as well. 
Also, a nit, but the title is a bit long, seems like it could be a bit more succinct.

> The debugfs_create_dir() function returns error pointers.
> It never returns NULL. Most incorrect error checks were fixed, but the 
> one in i40e_dbg_init() was forgotten.
> 
> Fix the remaining error check.

As it's a fix, there should be a Fixes tag as well.

> Signed-off-by: Wang Ming <machel@vivo.com>
> ---
>   drivers/net/ethernet/intel/i40e/i40e_debugfs.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c 
> b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> index 9954493cd448..62497f5565c5 100644
> --- a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> +++ b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> @@ -1839,7 +1839,7 @@ void i40e_dbg_pf_exit(struct i40e_pf *pf)
>   void i40e_dbg_init(void)
>   {
>   	i40e_dbg_root = debugfs_create_dir(i40e_driver_name, NULL);
> -	if (!i40e_dbg_root)
> +	if (IS_ERR(i40e_dbg_root))
>   		pr_info("init of debugfs failed\n");
>   }
>   

[1]
https://www.kernel.org/doc/html/latest/process/maintainer-netdev.html#netdev-faq

回复: [PATCH v2] net:Fix an NULL vs IS_ERR() bug for debugfs_create_dir() in i40e_dbg_init()

Posted by 王明-软件底层技术部 2 years, 7 months ago

Hi Tony Nguyen
good morning, I have resubmitted patch according to your requirements, please review it when you are free, I will be very grateful.
😊
Regards,
Wang Ming
-----邮件原件-----
发件人: Tony Nguyen <anthony.l.nguyen@intel.com> 
发送时间: 2023年7月13日 4:57
收件人: 王明-软件底层技术部 <machel@vivo.com>; Jesse Brandeburg <jesse.brandeburg@intel.com>; David S. Miller <davem@davemloft.net>; Eric Dumazet <edumazet@google.com>; Jakub Kicinski <kuba@kernel.org>; Paolo Abeni <pabeni@redhat.com>; intel-wired-lan@lists.osuosl.org; netdev@vger.kernel.org; linux-kernel@vger.kernel.org
抄送: opensource.kernel <opensource.kernel@vivo.com>
主题: Re: [PATCH v2] net:Fix an NULL vs IS_ERR() bug for debugfs_create_dir() in i40e_dbg_init()

On 7/12/2023 5:19 AM, Wang Ming wrote:

Please designate a tree for the patch (net or net-next) [1].

If you could include the driver (i40e) in the commit title as well. 
Also, a nit, but the title is a bit long, seems like it could be a bit more succinct.

> The debugfs_create_dir() function returns error pointers.
> It never returns NULL. Most incorrect error checks were fixed, but the 
> one in i40e_dbg_init() was forgotten.
> 
> Fix the remaining error check.

As it's a fix, there should be a Fixes tag as well.

> Signed-off-by: Wang Ming <machel@vivo.com>
> ---
>   drivers/net/ethernet/intel/i40e/i40e_debugfs.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c 
> b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> index 9954493cd448..62497f5565c5 100644
> --- a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> +++ b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> @@ -1839,7 +1839,7 @@ void i40e_dbg_pf_exit(struct i40e_pf *pf)
>   void i40e_dbg_init(void)
>   {
>   	i40e_dbg_root = debugfs_create_dir(i40e_driver_name, NULL);
> -	if (!i40e_dbg_root)
> +	if (IS_ERR(i40e_dbg_root))
>   		pr_info("init of debugfs failed\n");
>   }
>   

[1]
https://www.kernel.org/doc/html/latest/process/maintainer-netdev.html#netdev-faq