diff mbox series

[v2] of: overlay: fix memory leak in add_changeset_node()

Message ID 20221121035335.809316-1-zengheng4@huawei.com
State Changes Requested, archived
Headers show
Series [v2] of: overlay: fix memory leak in add_changeset_node() | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 1 warnings, 11 lines checked
robh/patch-applied fail build log
robh/checkpatch warning total: 0 errors, 1 warnings, 11 lines checked
robh/patch-applied fail build log

Commit Message

Zeng Heng Nov. 21, 2022, 3:53 a.m. UTC
When of_changeset_attach_node() returns fail and tchild is
over of life cycle which is duplicated by __of_node_dup(),
it needs to call of_node_put() to release tchild in
error handle route.

Otherwise, there are some memory leak reported about the node:

unreferenced object 0xffff88810cd1e800 (size 256):
  backtrace:
    kmalloc_trace
    __of_node_dup
    add_changeset_node (inlined)
    build_changeset_next_level

unreferenced object 0xffff888113721240 (size 16):
  backtrace:
    __kmalloc_node_track_caller
    kstrdup
    __of_node_dup
    add_changeset_node (inlined)
    build_changeset_next_level

unreferenced object 0xffff88810a38d400 (size 128):
  backtrace:
    kmalloc_trace
    __of_prop_dup
    add_changeset_property
    build_changeset_next_level

Fixes: 0290c4ca2536 ("of: overlay: rename identifiers to more reflect what they do")
Signed-off-by: Zeng Heng <zengheng4@huawei.com>
---
 drivers/of/overlay.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Zeng Heng Nov. 21, 2022, 6:07 a.m. UTC | #1
+cc linux-kernel-mail-list


On 2022/11/21 11:53, Zeng Heng wrote:
> When of_changeset_attach_node() returns fail and tchild is
> over of life cycle which is duplicated by __of_node_dup(),
> it needs to call of_node_put() to release tchild in
> error handle route.
>
> Otherwise, there are some memory leak reported about the node:
>
> unreferenced object 0xffff88810cd1e800 (size 256):
>    backtrace:
>      kmalloc_trace
>      __of_node_dup
>      add_changeset_node (inlined)
>      build_changeset_next_level
>
> unreferenced object 0xffff888113721240 (size 16):
>    backtrace:
>      __kmalloc_node_track_caller
>      kstrdup
>      __of_node_dup
>      add_changeset_node (inlined)
>      build_changeset_next_level
>
> unreferenced object 0xffff88810a38d400 (size 128):
>    backtrace:
>      kmalloc_trace
>      __of_prop_dup
>      add_changeset_property
>      build_changeset_next_level
>
> Fixes: 0290c4ca2536 ("of: overlay: rename identifiers to more reflect what they do")
> Signed-off-by: Zeng Heng <zengheng4@huawei.com>
> ---
>   drivers/of/overlay.c | 4 +++-
>   1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
> index bd8ff4df723d..a5189a0ec0a3 100644
> --- a/drivers/of/overlay.c
> +++ b/drivers/of/overlay.c
> @@ -436,8 +436,10 @@ static int add_changeset_node(struct overlay_changeset *ovcs,
>   		of_node_set_flag(tchild, OF_OVERLAY);
>   
>   		ret = of_changeset_attach_node(&ovcs->cset, tchild);
> -		if (ret)
> +		if (ret) {
> +			of_node_put(tchild);
>   			return ret;
> +		}
>   
>   		target_child.np = tchild;
>   		target_child.in_livetree = false;
Frank Rowand Nov. 23, 2022, 12:29 a.m. UTC | #2
Hi Zeng,

In the future, please do not send a new version of a patch series as a reply
to a previous thread.  For people who leave threads collapsed in their email
client (like me), there is a good chance that the new patch version email
will not be noticed.

More below...

On 11/20/22 21:53, Zeng Heng wrote:

> When of_changeset_attach_node() returns fail and tchild is
> over of life cycle which is duplicated by __of_node_dup(),
> it needs to call of_node_put() to release tchild in
> error handle route.

This does not seem correct.  I will explain this in the patch v1
thread.

> 
> Otherwise, there are some memory leak reported about the node:
> 
> unreferenced object 0xffff88810cd1e800 (size 256):
>   backtrace:
>     kmalloc_trace
>     __of_node_dup
>     add_changeset_node (inlined)
>     build_changeset_next_level
> 
> unreferenced object 0xffff888113721240 (size 16):
>   backtrace:
>     __kmalloc_node_track_caller
>     kstrdup
>     __of_node_dup
>     add_changeset_node (inlined)
>     build_changeset_next_level
> 
> unreferenced object 0xffff88810a38d400 (size 128):
>   backtrace:
>     kmalloc_trace
>     __of_prop_dup
>     add_changeset_property
>     build_changeset_next_level
> 

> Fixes: 0290c4ca2536 ("of: overlay: rename identifiers to more reflect what they do")

You have to dig deeper.  The code that introduced the issue is even older:

7518b5890d8a of/overlay: Introduce DT overlay support

-Frank


> Signed-off-by: Zeng Heng <zengheng4@huawei.com>
> ---
>  drivers/of/overlay.c | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
> index bd8ff4df723d..a5189a0ec0a3 100644
> --- a/drivers/of/overlay.c
> +++ b/drivers/of/overlay.c
> @@ -436,8 +436,10 @@ static int add_changeset_node(struct overlay_changeset *ovcs,
>  		of_node_set_flag(tchild, OF_OVERLAY);
>  
>  		ret = of_changeset_attach_node(&ovcs->cset, tchild);
> -		if (ret)
> +		if (ret) {
> +			of_node_put(tchild);
>  			return ret;
> +		}
>  
>  		target_child.np = tchild;
>  		target_child.in_livetree = false;
Frank Rowand Nov. 23, 2022, 1:16 a.m. UTC | #3
On 11/22/22 18:29, Frank Rowand wrote:
> Hi Zeng,
> 
> In the future, please do not send a new version of a patch series as a reply
> to a previous thread.  For people who leave threads collapsed in their email
> client (like me), there is a good chance that the new patch version email
> will not be noticed.
> 
> More below...
> 
> On 11/20/22 21:53, Zeng Heng wrote:
> 
>> When of_changeset_attach_node() returns fail and tchild is
>> over of life cycle which is duplicated by __of_node_dup(),
>> it needs to call of_node_put() to release tchild in
>> error handle route.
> 
> This does not seem correct.  I will explain this in the patch v1
> thread.

After reading throught the code some more, and confusing myself a bit,
I think the proposed patch of adding the of_node_put(tchild) is correct.

I'll run it through my tests and then reply again, hopefully tommorrow.

-Frank

> 
>>
>> Otherwise, there are some memory leak reported about the node:
>>
>> unreferenced object 0xffff88810cd1e800 (size 256):
>>   backtrace:
>>     kmalloc_trace
>>     __of_node_dup
>>     add_changeset_node (inlined)
>>     build_changeset_next_level
>>
>> unreferenced object 0xffff888113721240 (size 16):
>>   backtrace:
>>     __kmalloc_node_track_caller
>>     kstrdup
>>     __of_node_dup
>>     add_changeset_node (inlined)
>>     build_changeset_next_level
>>
>> unreferenced object 0xffff88810a38d400 (size 128):
>>   backtrace:
>>     kmalloc_trace
>>     __of_prop_dup
>>     add_changeset_property
>>     build_changeset_next_level
>>
> 
>> Fixes: 0290c4ca2536 ("of: overlay: rename identifiers to more reflect what they do")
> 
> You have to dig deeper.  The code that introduced the issue is even older:
> 
> 7518b5890d8a of/overlay: Introduce DT overlay support
> 
> -Frank
> 
> 
>> Signed-off-by: Zeng Heng <zengheng4@huawei.com>
>> ---
>>  drivers/of/overlay.c | 4 +++-
>>  1 file changed, 3 insertions(+), 1 deletion(-)
>>
>> diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
>> index bd8ff4df723d..a5189a0ec0a3 100644
>> --- a/drivers/of/overlay.c
>> +++ b/drivers/of/overlay.c
>> @@ -436,8 +436,10 @@ static int add_changeset_node(struct overlay_changeset *ovcs,
>>  		of_node_set_flag(tchild, OF_OVERLAY);
>>  
>>  		ret = of_changeset_attach_node(&ovcs->cset, tchild);
>> -		if (ret)
>> +		if (ret) {
>> +			of_node_put(tchild);
>>  			return ret;
>> +		}
>>  
>>  		target_child.np = tchild;
>>  		target_child.in_livetree = false;
>
Zeng Heng Nov. 23, 2022, 1:41 a.m. UTC | #4
On 2022/11/23 8:29, Frank Rowand wrote:
> Hi Zeng,
>
> In the future, please do not send a new version of a patch series as a reply
> to a previous thread.  For people who leave threads collapsed in their email
> client (like me), there is a good chance that the new patch version email
> will not be noticed.
>
> More below...

Get it. Thanks for your suggestion.

With B. R.,

Zeng Heng

>
> On 11/20/22 21:53, Zeng Heng wrote:
>
>> When of_changeset_attach_node() returns fail and tchild is
>> over of life cycle which is duplicated by __of_node_dup(),
>> it needs to call of_node_put() to release tchild in
>> error handle route.
> This does not seem correct.  I will explain this in the patch v1
> thread.
>
>> Otherwise, there are some memory leak reported about the node:
>>
>> unreferenced object 0xffff88810cd1e800 (size 256):
>>    backtrace:
>>      kmalloc_trace
>>      __of_node_dup
>>      add_changeset_node (inlined)
>>      build_changeset_next_level
>>
>> unreferenced object 0xffff888113721240 (size 16):
>>    backtrace:
>>      __kmalloc_node_track_caller
>>      kstrdup
>>      __of_node_dup
>>      add_changeset_node (inlined)
>>      build_changeset_next_level
>>
>> unreferenced object 0xffff88810a38d400 (size 128):
>>    backtrace:
>>      kmalloc_trace
>>      __of_prop_dup
>>      add_changeset_property
>>      build_changeset_next_level
>>
>> Fixes: 0290c4ca2536 ("of: overlay: rename identifiers to more reflect what they do")
> You have to dig deeper.  The code that introduced the issue is even older:
>
> 7518b5890d8a of/overlay: Introduce DT overlay support
>
> -Frank
>
>
>> Signed-off-by: Zeng Heng <zengheng4@huawei.com>
>> ---
>>   drivers/of/overlay.c | 4 +++-
>>   1 file changed, 3 insertions(+), 1 deletion(-)
>>
>> diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
>> index bd8ff4df723d..a5189a0ec0a3 100644
>> --- a/drivers/of/overlay.c
>> +++ b/drivers/of/overlay.c
>> @@ -436,8 +436,10 @@ static int add_changeset_node(struct overlay_changeset *ovcs,
>>   		of_node_set_flag(tchild, OF_OVERLAY);
>>   
>>   		ret = of_changeset_attach_node(&ovcs->cset, tchild);
>> -		if (ret)
>> +		if (ret) {
>> +			of_node_put(tchild);
>>   			return ret;
>> +		}
>>   
>>   		target_child.np = tchild;
>>   		target_child.in_livetree = false;
Zeng Heng Nov. 23, 2022, 1:52 a.m. UTC | #5
On 2022/11/23 9:16, Frank Rowand wrote:
> On 11/22/22 18:29, Frank Rowand wrote:
>> Hi Zeng,
>>
>> In the future, please do not send a new version of a patch series as a reply
>> to a previous thread.  For people who leave threads collapsed in their email
>> client (like me), there is a good chance that the new patch version email
>> will not be noticed.
>>
>> More below...
>>
>> On 11/20/22 21:53, Zeng Heng wrote:
>>
>>> When of_changeset_attach_node() returns fail and tchild is
>>> over of life cycle which is duplicated by __of_node_dup(),
>>> it needs to call of_node_put() to release tchild in
>>> error handle route.
>> This does not seem correct.  I will explain this in the patch v1
>> thread.
> After reading throught the code some more, and confusing myself a bit,
> I think the proposed patch of adding the of_node_put(tchild) is correct.
>
> I'll run it through my tests and then reply again, hopefully tommorrow.
>
> -Frank

Many thanks to your patient review.


My work is injecting fault(like ENOMEM by failslab) into every corners 
per single time,

so i would send the corresponding patch even if the probability of error 
is low.


And continue digging.


With best regards,

Zeng Heng

>
>>> Otherwise, there are some memory leak reported about the node:
>>>
>>> unreferenced object 0xffff88810cd1e800 (size 256):
>>>    backtrace:
>>>      kmalloc_trace
>>>      __of_node_dup
>>>      add_changeset_node (inlined)
>>>      build_changeset_next_level
>>>
>>> unreferenced object 0xffff888113721240 (size 16):
>>>    backtrace:
>>>      __kmalloc_node_track_caller
>>>      kstrdup
>>>      __of_node_dup
>>>      add_changeset_node (inlined)
>>>      build_changeset_next_level
>>>
>>> unreferenced object 0xffff88810a38d400 (size 128):
>>>    backtrace:
>>>      kmalloc_trace
>>>      __of_prop_dup
>>>      add_changeset_property
>>>      build_changeset_next_level
>>>
>>> Fixes: 0290c4ca2536 ("of: overlay: rename identifiers to more reflect what they do")
>> You have to dig deeper.  The code that introduced the issue is even older:
>>
>> 7518b5890d8a of/overlay: Introduce DT overlay support
>>
>> -Frank
>>
>>
>>> Signed-off-by: Zeng Heng <zengheng4@huawei.com>
>>> ---
>>>   drivers/of/overlay.c | 4 +++-
>>>   1 file changed, 3 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
>>> index bd8ff4df723d..a5189a0ec0a3 100644
>>> --- a/drivers/of/overlay.c
>>> +++ b/drivers/of/overlay.c
>>> @@ -436,8 +436,10 @@ static int add_changeset_node(struct overlay_changeset *ovcs,
>>>   		of_node_set_flag(tchild, OF_OVERLAY);
>>>   
>>>   		ret = of_changeset_attach_node(&ovcs->cset, tchild);
>>> -		if (ret)
>>> +		if (ret) {
>>> +			of_node_put(tchild);
>>>   			return ret;
>>> +		}
>>>   
>>>   		target_child.np = tchild;
>>>   		target_child.in_livetree = false;
diff mbox series

Patch

diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
index bd8ff4df723d..a5189a0ec0a3 100644
--- a/drivers/of/overlay.c
+++ b/drivers/of/overlay.c
@@ -436,8 +436,10 @@  static int add_changeset_node(struct overlay_changeset *ovcs,
 		of_node_set_flag(tchild, OF_OVERLAY);
 
 		ret = of_changeset_attach_node(&ovcs->cset, tchild);
-		if (ret)
+		if (ret) {
+			of_node_put(tchild);
 			return ret;
+		}
 
 		target_child.np = tchild;
 		target_child.in_livetree = false;