public inbox for stable@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] media: vimc: fix reference leak on failed device registration
@ 2026-04-15 15:45 Guangshuo Li
  2026-04-15 16:01 ` Shuah Khan
  0 siblings, 1 reply; 5+ messages in thread
From: Guangshuo Li @ 2026-04-15 15:45 UTC (permalink / raw)
  To: Shuah Khan, Kieran Bingham, Mauro Carvalho Chehab, Hans Verkuil,
	Dafna Hirschfeld, linux-media, linux-kernel
  Cc: Guangshuo Li, stable

When platform_device_register() fails in vimc_init(), the embedded
struct device in vimc_pdev has already been initialized by
device_initialize(), but the failure path returns the error without
dropping the device reference for the current platform device:

  vimc_init()
    -> platform_device_register(&vimc_pdev)
       -> device_initialize(&vimc_pdev.dev)
       -> setup_pdev_dma_masks(&vimc_pdev)
       -> platform_device_add(&vimc_pdev)

This leads to a reference leak when platform_device_register() fails.
Fix this by calling platform_device_put() before returning the error.

The issue was identified by a static analysis tool I developed and
confirmed by manual review.

Fixes: 4babf057c143f ("media: vimc: allocate vimc_device dynamically")
Cc: stable@vger.kernel.org
Signed-off-by: Guangshuo Li <lgs201920130244@gmail.com>
---
 drivers/media/test-drivers/vimc/vimc-core.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/media/test-drivers/vimc/vimc-core.c b/drivers/media/test-drivers/vimc/vimc-core.c
index 15167e127461..fee0c7a09c4f 100644
--- a/drivers/media/test-drivers/vimc/vimc-core.c
+++ b/drivers/media/test-drivers/vimc/vimc-core.c
@@ -421,6 +421,7 @@ static int __init vimc_init(void)
 	if (ret) {
 		dev_err(&vimc_pdev.dev,
 			"platform device registration failed (err=%d)\n", ret);
+		platform_device_put(&vimc_pdev);
 		return ret;
 	}
 
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] media: vimc: fix reference leak on failed device registration
  2026-04-15 15:45 [PATCH] media: vimc: fix reference leak on failed device registration Guangshuo Li
@ 2026-04-15 16:01 ` Shuah Khan
  2026-04-15 16:56   ` Guangshuo Li
  0 siblings, 1 reply; 5+ messages in thread
From: Shuah Khan @ 2026-04-15 16:01 UTC (permalink / raw)
  To: Guangshuo Li, Kieran Bingham, Mauro Carvalho Chehab, Hans Verkuil,
	Dafna Hirschfeld, linux-media, linux-kernel
  Cc: stable, Shuah Khan

On 4/15/26 09:45, Guangshuo Li wrote:
> When platform_device_register() fails in vimc_init(), the embedded
> struct device in vimc_pdev has already been initialized by
> device_initialize(), but the failure path returns the error without
> dropping the device reference for the current platform device:
> 
>    vimc_init()
>      -> platform_device_register(&vimc_pdev)
>         -> device_initialize(&vimc_pdev.dev)
>         -> setup_pdev_dma_masks(&vimc_pdev)
>         -> platform_device_add(&vimc_pdev)
> 
> This leads to a reference leak when platform_device_register() fails.
> Fix this by calling platform_device_put() before returning the error.
> 
> The issue was identified by a static analysis tool I developed and
> confirmed by manual review.

Can you share your manual review?

Can other static analysis tools for example scripts/coccinelle support
your findings?

> 
> Fixes: 4babf057c143f ("media: vimc: allocate vimc_device dynamically")
> Cc: stable@vger.kernel.org
> Signed-off-by: Guangshuo Li <lgs201920130244@gmail.com>
> ---
>   drivers/media/test-drivers/vimc/vimc-core.c | 1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/media/test-drivers/vimc/vimc-core.c b/drivers/media/test-drivers/vimc/vimc-core.c
> index 15167e127461..fee0c7a09c4f 100644
> --- a/drivers/media/test-drivers/vimc/vimc-core.c
> +++ b/drivers/media/test-drivers/vimc/vimc-core.c
> @@ -421,6 +421,7 @@ static int __init vimc_init(void)
>   	if (ret) {
>   		dev_err(&vimc_pdev.dev,
>   			"platform device registration failed (err=%d)\n", ret);
> +		platform_device_put(&vimc_pdev);

Where does platform_device_get() happen when platform_device_register() fails?

thanks,
-- Shuah

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] media: vimc: fix reference leak on failed device registration
  2026-04-15 16:01 ` Shuah Khan
@ 2026-04-15 16:56   ` Guangshuo Li
  2026-04-15 20:49     ` Shuah Khan
  0 siblings, 1 reply; 5+ messages in thread
From: Guangshuo Li @ 2026-04-15 16:56 UTC (permalink / raw)
  To: Shuah Khan
  Cc: Kieran Bingham, Mauro Carvalho Chehab, Hans Verkuil,
	Dafna Hirschfeld, linux-media, linux-kernel, stable

Hi Shuah,

Thanks for reviewing.

On Thu, 16 Apr 2026 at 00:01, Shuah Khan <skhan@linuxfoundation.org> wrote:
>

>
> Can you share your manual review?
>
> Can other static analysis tools for example scripts/coccinelle support
> your findings?
>
> >
> > Fixes: 4babf057c143f ("media: vimc: allocate vimc_device dynamically")
> > Cc: stable@vger.kernel.org
> > Signed-off-by: Guangshuo Li <lgs201920130244@gmail.com>
> > ---
> >   drivers/media/test-drivers/vimc/vimc-core.c | 1 +
> >   1 file changed, 1 insertion(+)
> >
> > diff --git a/drivers/media/test-drivers/vimc/vimc-core.c b/drivers/media/test-drivers/vimc/vimc-core.c
> > index 15167e127461..fee0c7a09c4f 100644
> > --- a/drivers/media/test-drivers/vimc/vimc-core.c
> > +++ b/drivers/media/test-drivers/vimc/vimc-core.c
> > @@ -421,6 +421,7 @@ static int __init vimc_init(void)
> >       if (ret) {
> >               dev_err(&vimc_pdev.dev,
> >                       "platform device registration failed (err=%d)\n", ret);
> > +             platform_device_put(&vimc_pdev);
>
> Where does platform_device_get() happen when platform_device_register() fails?
>
> thanks,
> -- Shuah

My manual review was based on the platform_device_register() call
chain and its documented lifetime rules.

The relevant code path is:

ret = platform_device_register(&vimc_pdev);
if (ret) {
dev_err(&vimc_pdev.dev,
"platform device registration failed (err=%d)\n", ret);
return ret;
}

and

int platform_device_register(struct platform_device *pdev)
{
device_initialize(&pdev->dev);
setup_pdev_dma_masks(pdev);
return platform_device_add(pdev);
}

If platform_device_add() fails, platform_device_register() returns an
error, but the reference initialized by device_initialize() is still
owned by the caller. The API documentation for platform_device_register()
also explicitly says:

"Never directly free @pdev after calling this function, even if it
returned an error! Always use platform_device_put() to give up the
reference initialised in this function instead."

So there is no matching platform_device_get() on the failure path.
The reference comes from device_initialize(), and platform_device_put()
is needed to drop that initial reference when registration fails.

That was also how I manually confirmed the issue after the tool report:
I checked the platform_device_register() / platform_device_add()
implementation and verified that the vimc failure path returns directly
without calling platform_device_put().

I found this issue using a tool I recently developed. The scan was run
on kernel version v7.0-1262-g4fa12523f7bc.

Thanks,
Guangshuo

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] media: vimc: fix reference leak on failed device registration
  2026-04-15 16:56   ` Guangshuo Li
@ 2026-04-15 20:49     ` Shuah Khan
  2026-04-16  9:11       ` Guangshuo Li
  0 siblings, 1 reply; 5+ messages in thread
From: Shuah Khan @ 2026-04-15 20:49 UTC (permalink / raw)
  To: Guangshuo Li
  Cc: Kieran Bingham, Mauro Carvalho Chehab, Hans Verkuil,
	Dafna Hirschfeld, linux-media, linux-kernel, stable, Shuah Khan

On 4/15/26 10:56, Guangshuo Li wrote:
> Hi Shuah,
> 
> Thanks for reviewing.
> 
> On Thu, 16 Apr 2026 at 00:01, Shuah Khan <skhan@linuxfoundation.org> wrote:
>>
> 
>>
>> Can you share your manual review?
>>
>> Can other static analysis tools for example scripts/coccinelle support
>> your findings?
>>

Did you try other static analysis tools in the kernel?

>>>
>>> Fixes: 4babf057c143f ("media: vimc: allocate vimc_device dynamically")
>>> Cc: stable@vger.kernel.org
>>> Signed-off-by: Guangshuo Li <lgs201920130244@gmail.com>
>>> ---
>>>    drivers/media/test-drivers/vimc/vimc-core.c | 1 +
>>>    1 file changed, 1 insertion(+)
>>>
>>> diff --git a/drivers/media/test-drivers/vimc/vimc-core.c b/drivers/media/test-drivers/vimc/vimc-core.c
>>> index 15167e127461..fee0c7a09c4f 100644
>>> --- a/drivers/media/test-drivers/vimc/vimc-core.c
>>> +++ b/drivers/media/test-drivers/vimc/vimc-core.c
>>> @@ -421,6 +421,7 @@ static int __init vimc_init(void)
>>>        if (ret) {
>>>                dev_err(&vimc_pdev.dev,
>>>                        "platform device registration failed (err=%d)\n", ret);
>>> +             platform_device_put(&vimc_pdev);
>>
>> Where does platform_device_get() happen when platform_device_register() fails?
>>
>> thanks,
>> -- Shuah
> 
> My manual review was based on the platform_device_register() call
> chain and its documented lifetime rules.
> 
> The relevant code path is:
> 
> ret = platform_device_register(&vimc_pdev);
> if (ret) {
> dev_err(&vimc_pdev.dev,
> "platform device registration failed (err=%d)\n", ret);
> return ret;
> }
> 
> and
> 
> int platform_device_register(struct platform_device *pdev)
> {
> device_initialize(&pdev->dev);
> setup_pdev_dma_masks(pdev);
> return platform_device_add(pdev);
> }
> 
> If platform_device_add() fails, platform_device_register() returns an
> error, but the reference initialized by device_initialize() is still
> owned by the caller. The API documentation for platform_device_register()
> also explicitly says:
> 
> "Never directly free @pdev after calling this function, even if it
> returned an error! Always use platform_device_put() to give up the
> reference initialised in this function instead."
> 
> So there is no matching platform_device_get() on the failure path.
> The reference comes from device_initialize(), and platform_device_put()
> is needed to drop that initial reference when registration fails.
> 
> That was also how I manually confirmed the issue after the tool report:
> I checked the platform_device_register() / platform_device_add()
> implementation and verified that the vimc failure path returns directly
> without calling platform_device_put().
> 
> I found this issue using a tool I recently developed. The scan was run
> on kernel version v7.0-1262-g4fa12523f7bc.

There are several calls to platform_device_register() all over the kernel.
Did your tool find all other cases or just this one?

thanks,
-- Shuah

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] media: vimc: fix reference leak on failed device registration
  2026-04-15 20:49     ` Shuah Khan
@ 2026-04-16  9:11       ` Guangshuo Li
  0 siblings, 0 replies; 5+ messages in thread
From: Guangshuo Li @ 2026-04-16  9:11 UTC (permalink / raw)
  To: Shuah Khan
  Cc: Kieran Bingham, Mauro Carvalho Chehab, Hans Verkuil,
	Dafna Hirschfeld, linux-media, linux-kernel, stable

Hi Shuah,

Thanks for reviewing.

On Thu, 16 Apr 2026 at 04:49, Shuah Khan <skhan@linuxfoundation.org> wrote:
>
> On 4/15/26 10:56, Guangshuo Li wrote:
> > Hi Shuah,
> >
> > Thanks for reviewing.
> >
> > On Thu, 16 Apr 2026 at 00:01, Shuah Khan <skhan@linuxfoundation.org> wrote:
> >>
> >
> >>
> >> Can you share your manual review?
> >>
> >> Can other static analysis tools for example scripts/coccinelle support
> >> your findings?
> >>
>
> Did you try other static analysis tools in the kernel?
>
I have not used other static analysis tools for this case.

> There are several calls to platform_device_register() all over the kernel.
> Did your tool find all other cases or just this one?
>
> thanks,
> -- Shuah

My tool also identified other similar issues in the kernel, and I have
posted corresponding patches for them, for example:

[PATCH] eeprom: digsy_mtc: fix reference leak on failed device registration
https://patchew.org/linux/20260415165203.3584869-1-lgs201920130244@gmail.com/

[PATCH] arm_pmu: acpi: fix reference leak on failed device registration
https://patchew.org/linux/20260415174159.3625777-1-lgs201920130244@gmail.com/

Thanks,
Guangshuo

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2026-04-16  9:11 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-04-15 15:45 [PATCH] media: vimc: fix reference leak on failed device registration Guangshuo Li
2026-04-15 16:01 ` Shuah Khan
2026-04-15 16:56   ` Guangshuo Li
2026-04-15 20:49     ` Shuah Khan
2026-04-16  9:11       ` Guangshuo Li

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox