[PATCH] PCI: fix reference leak in pci_alloc_child_bus()

[PATCH] PCI: fix reference leak in pci_alloc_child_bus()

[Ma Ke]

When device_register(&child->dev) failed, calling put_device() to
explicitly release child->dev. Otherwise, it could cause double free
problem.

Found by code review.

Cc: stable@vger.kernel.org
Fixes: 4f535093cf8f ("PCI: Put pci_dev in device tree as early as possible")
Signed-off-by: Ma Ke <make_ruc2021@163.com>
---
 drivers/pci/probe.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/drivers/pci/probe.c b/drivers/pci/probe.c
index 2e81ab0f5a25..d3146c588d7f 100644
--- a/drivers/pci/probe.c
+++ b/drivers/pci/probe.c
@@ -1174,7 +1174,10 @@ static struct pci_bus *pci_alloc_child_bus(struct pci_bus *parent,
 add_dev:
 	pci_set_bus_msi_domain(child);
 	ret = device_register(&child->dev);
-	WARN_ON(ret < 0);
+	if (ret) {
+		WARN_ON(ret < 0);
+		put_device(&child->dev);
+	}
 
 	pcibios_add_bus(child);
 
-- 
2.25.1

Re: [PATCH] PCI: fix reference leak in pci_alloc_child_bus()

[Ilpo Järvinen]

On Tue, 17 Dec 2024, Ma Ke wrote:

> When device_register(&child->dev) failed, calling put_device() to
> explicitly release child->dev. Otherwise, it could cause double free
> problem.
> 
> Found by code review.
> 
> Cc: stable@vger.kernel.org
> Fixes: 4f535093cf8f ("PCI: Put pci_dev in device tree as early as possible")
> Signed-off-by: Ma Ke <make_ruc2021@163.com>
> ---
>  drivers/pci/probe.c | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/pci/probe.c b/drivers/pci/probe.c
> index 2e81ab0f5a25..d3146c588d7f 100644
> --- a/drivers/pci/probe.c
> +++ b/drivers/pci/probe.c
> @@ -1174,7 +1174,10 @@ static struct pci_bus *pci_alloc_child_bus(struct pci_bus *parent,
>  add_dev:
>  	pci_set_bus_msi_domain(child);
>  	ret = device_register(&child->dev);
> -	WARN_ON(ret < 0);
> +	if (ret) {
> +		WARN_ON(ret < 0);

The usual way is:

	if (WARN_ON(ret < 0))

> +		put_device(&child->dev);
> +	}
>  
>  	pcibios_add_bus(child);

But more serious problem here is that should this code even proceed as if 
nothing happened when an error occurs? pci_register_host_bridge() does 
proper rollback when device_register() fails but this function doesn't.

Into the same vein, is using WARN_ON() even correct here? Why should this 
print a stacktrace if device_register() fails instead of simply printing 
and error?

-- 
 i.

Re: [PATCH] PCI: fix reference leak in pci_alloc_child_bus()

[Ma Ke]

Ilpo Järvinen<ilpo.jarvinen@linux.intel.com> wrote:
> Ma Ke <make_ruc2021@163.com> writes:
> > When device_register(&child->dev) failed, calling put_device() to
> > explicitly release child->dev. Otherwise, it could cause double free
> > problem.
> > 
> > Found by code review.
> > 
> > Cc: stable@vger.kernel.org
> > Fixes: 4f535093cf8f ("PCI: Put pci_dev in device tree as early as possible")
> > Signed-off-by: Ma Ke <make_ruc2021@163.com>
> > ---
> >  drivers/pci/probe.c | 5 ++++-
> >  1 file changed, 4 insertions(+), 1 deletion(-)
> > 
> > diff --git a/drivers/pci/probe.c b/drivers/pci/probe.c
> > index 2e81ab0f5a25..d3146c588d7f 100644
> > --- a/drivers/pci/probe.c
> > +++ b/drivers/pci/probe.c
> > @@ -1174,7 +1174,10 @@ static struct pci_bus *pci_alloc_child_bus(struct pci_bus *parent,
> >  add_dev:
> >  	pci_set_bus_msi_domain(child);
> >  	ret = device_register(&child->dev);
> > -	WARN_ON(ret < 0);
> > +	if (ret) {
> > +		WARN_ON(ret < 0);
> 
> The usual way is:
> 
> 	if (WARN_ON(ret < 0))
> 
> > +		put_device(&child->dev);
> > +	}
> >  
> >  	pcibios_add_bus(child);
> 
> But more serious problem here is that should this code even proceed as if 
> nothing happened when an error occurs? pci_register_host_bridge() does 
> proper rollback when device_register() fails but this function doesn't.
> 
> Into the same vein, is using WARN_ON() even correct here? Why should this 
> print a stacktrace if device_register() fails instead of simply printing 
> and error?
Thank you for your guidance and suggestions. I have the same confusion
about the simple handling(WARN_ON()) of errors if device_add() fails. 
I am looking forward to receiving guidance and insights from other 
experts.

--
Regards,

Ma Ke

[PATCH] PCI: fix reference leak in pci_alloc_child_bus()

[Ma Ke]

When device_register(&child->dev) failed, calling put_device() to
explicitly release child->dev. Otherwise, it could cause double free
problem.

Found by code review.

Signed-off-by: Ma Ke <make24@iscas.ac.cn>
---
 drivers/pci/probe.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/drivers/pci/probe.c b/drivers/pci/probe.c
index 2e81ab0f5a25..a61070ce5f88 100644
--- a/drivers/pci/probe.c
+++ b/drivers/pci/probe.c
@@ -1174,7 +1174,10 @@ static struct pci_bus *pci_alloc_child_bus(struct pci_bus *parent,
 add_dev:
 	pci_set_bus_msi_domain(child);
 	ret = device_register(&child->dev);
-	WARN_ON(ret < 0);
+	if (WARN_ON(ret < 0)) {
+		put_device(&child->dev);
+		return ERR_PTR(ret);
+	}
 
 	pcibios_add_bus(child);
 
-- 
2.25.1

Re: [PATCH] PCI: fix reference leak in pci_alloc_child_bus()

[Christophe JAILLET]

Le 07/01/2025 à 12:07, Ma Ke a écrit :
> When device_register(&child->dev) failed, calling put_device() to
> explicitly release child->dev. Otherwise, it could cause double free
> problem.
> 
> Found by code review.
> 
> Signed-off-by: Ma Ke <make24@iscas.ac.cn>
> ---
>   drivers/pci/probe.c | 5 ++++-
>   1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/pci/probe.c b/drivers/pci/probe.c
> index 2e81ab0f5a25..a61070ce5f88 100644
> --- a/drivers/pci/probe.c
> +++ b/drivers/pci/probe.c
> @@ -1174,7 +1174,10 @@ static struct pci_bus *pci_alloc_child_bus(struct pci_bus *parent,
>   add_dev:
>   	pci_set_bus_msi_domain(child);
>   	ret = device_register(&child->dev);
> -	WARN_ON(ret < 0);
> +	if (WARN_ON(ret < 0)) {
> +		put_device(&child->dev);
> +		return ERR_PTR(ret);

Previously, the code was continuing the execution. I don't know it is 
correct to return at this point.

Anyway, returning ERR_PTR(ret) just looks wrong, because 
pci_add_new_bus() expect NULL in case of error.
Should ERR_PTR(ret) be returned, it is likely basd thing would happen there.

CJ

> +	}
>   
>   	pcibios_add_bus(child);
>