Skip to contentSkip to conversation

drm/of: free the iterator object on failure

PATCH Superseded Steven Price 3 participants 10 messages Jul 12, 2021 – Jul 15, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/of: free the iterator object on failure

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 4ee48cc5586b ("drm: of: Fix double-free bug")
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Daniel's email[1] made me take a look at this function and it appears that for_each_child_of_node()'s interface had caused a bad bug fix due to the hidden reference counting in the iterator.

[1] https://lore.kernel.org/r/YOxQ5TbkNrqCGBDJ%40phenom.ffwll.local

drivers/gpu/drm/drm_of.c +3 -1
index 197c57477344..997b8827fed2 100644
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;
Signature · 1 line
2.20.1
#1 lore raw

+ Pavel

Quoted 51 lines

-----Original Message-----
From: Steven Price <[email protected]>
Sent: 12 July 2021 16:58
To: Daniel Vetter <[email protected]>; David Airlie <[email protected]>; Maarten Lankhorst <[email protected]>; Maxime Ripard <[email protected]>; Thomas Zimmermann <[email protected]>
Cc: Steven Price <[email protected]>; [email protected]; [email protected]; Biju Das <[email protected]>; Laurent Pinchart <[email protected]>
Subject: [PATCH] drm/of: free the iterator object on failure

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 4ee48cc5586b ("drm: of: Fix double-free bug")
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Daniel's email[1] made me take a look at this function and it appears that for_each_child_of_node()'s interface had caused a bad bug fix due to the hidden reference counting in the iterator.

[1]
https://jpn01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flore.ker
nel.org%2Fr%2FYOxQ5TbkNrqCGBDJ%2540phenom.ffwll.local&amp;data=04%7C01%7Cb iju.das.jz%40bp.renesas.com%7Cb0570b66e03a43fb8fa008d9454dddaa%7C53d82571d a1947e49cb4625a166a4a2a%7C0%7C0%7C637617023006562683%7CUnknown%7CTWFpbGZsb 3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C10 00&amp;sdata=cQICPYJzmgNkFsNw1wMH9Or73rohnCCGH1DrUg3hvhw%3D&amp;reserved=0

drivers/gpu/drm/drm_of.c index renamed from drivers/gpu/drm/drm_of.c +0 -0

197c57477344..997b8827fed2 100644

drivers/gpu/drm/drm_of.c +3 -2
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;
--

2.20.1

#2 lore raw
In reply to Steven Price

Hi Steven,

Thank you for the patch.

Quoted 5 lines · Steven Price

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 4ee48cc5586b ("drm: of: Fix double-free bug")

I don't think the Fixes tag is correct, the issue was already present before 4ee48cc5586b. The fix looks right though.

Quoted 27 lines
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Daniel's email[1] made me take a look at this function and it appears that for_each_child_of_node()'s interface had caused a bad bug fix due to the hidden reference counting in the iterator.

[1] https://lore.kernel.org/r/YOxQ5TbkNrqCGBDJ%40phenom.ffwll.local

drivers/gpu/drm/drm_of.c +3 -1
index 197c57477344..997b8827fed2 100644
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;
Signature · 3 lines
Regards,

Laurent Pinchart
#3 lore raw
Quoted 5 lines · Laurent Pinchart

Hi Steven,

Thank you for the patch.

On Mon, Jul 12, 2021 at 04:57:58PM +0100, Steven Price wrote:

Quoted 8 lines
Quoted 5 lines

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 4ee48cc5586b ("drm: of: Fix double-free bug")

I don't think the Fixes tag is correct, the issue was already present before 4ee48cc5586b. The fix looks right though.

I'm not sure quite what you mean by "already present". As I understand it the timeline was:

1. 6529007522de drm: of: Add drm_of_lvds_get_dual_link_pixel_order The function was originally added. This made the mistake twice of calling of_node_put() on the wrong variable (remote_port rather than endpoint).

2. 4ee48cc5586b drm: of: Fix double-free bug
One of the of_node_put() calls was removed as it was a double-free. This left the first incorrect of_node_put() in place, and the second is now a straight leak.

3. b557a5f8da57 drm/of: free the right object
This (correctly) fixes the first of_node_put() to free endpoint. And the post from Daniel was what caused me to look.

4. This patch
Reintroduces the of_node_put() removed in (2) but putting endpoint rather than remote_port.

I've put (2) in the Fixes line as this patch is fixing the leak introduced by that patch, but that in itself was of course 'fixing' the double free of the original patch.

Steve

Quoted 28 lines
Quoted 27 lines
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Daniel's email[1] made me take a look at this function and it appears that for_each_child_of_node()'s interface had caused a bad bug fix due to the hidden reference counting in the iterator.

[1] https://lore.kernel.org/r/YOxQ5TbkNrqCGBDJ%40phenom.ffwll.local

drivers/gpu/drm/drm_of.c +3 -1
index 197c57477344..997b8827fed2 100644
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;
#4 lore raw

Hi Steven,

Quoted 11 lines · Steven Price
Quoted 9 lines · Laurent Pinchart
Quoted 5 lines · Steven Price

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 4ee48cc5586b ("drm: of: Fix double-free bug")

I don't think the Fixes tag is correct, the issue was already present before 4ee48cc5586b. The fix looks right though.

Quoted 7 lines

I'm not sure quite what you mean by "already present". As I understand it the timeline was:

1. 6529007522de drm: of: Add drm_of_lvds_get_dual_link_pixel_order The function was originally added. This made the mistake twice of calling of_node_put() on the wrong variable (remote_port rather than endpoint).

Correct.

Quoted 4 lines

2. 4ee48cc5586b drm: of: Fix double-free bug
One of the of_node_put() calls was removed as it was a double-free. This left the first incorrect of_node_put() in place, and the second is now a straight leak.

That's right, but this commit didn't introduce the leak, it was already there in 6529007522de (in addition to the double-free).

Quoted 39 lines

3. b557a5f8da57 drm/of: free the right object
This (correctly) fixes the first of_node_put() to free endpoint. And the post from Daniel was what caused me to look.

4. This patch
Reintroduces the of_node_put() removed in (2) but putting endpoint rather than remote_port.

I've put (2) in the Fixes line as this patch is fixing the leak introduced by that patch, but that in itself was of course 'fixing' the double free of the original patch.

Quoted 27 lines
Quoted 27 lines
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Daniel's email[1] made me take a look at this function and it appears that for_each_child_of_node()'s interface had caused a bad bug fix due to the hidden reference counting in the iterator.

[1] https://lore.kernel.org/r/YOxQ5TbkNrqCGBDJ%40phenom.ffwll.local

drivers/gpu/drm/drm_of.c +3 -1
index 197c57477344..997b8827fed2 100644
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;
Signature · 3 lines
Regards,

Laurent Pinchart
#5 lore raw
Quoted 1 line · Laurent Pinchart

Hi Steven,

Hi Laurent,

Quoted 22 lines · Steven Price
Quoted 11 lines · Laurent Pinchart
Quoted 9 lines · Steven Price
Quoted 5 lines

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 4ee48cc5586b ("drm: of: Fix double-free bug")

I don't think the Fixes tag is correct, the issue was already present before 4ee48cc5586b. The fix looks right though.

Quoted 7 lines

I'm not sure quite what you mean by "already present". As I understand it the timeline was:

1. 6529007522de drm: of: Add drm_of_lvds_get_dual_link_pixel_order The function was originally added. This made the mistake twice of calling of_node_put() on the wrong variable (remote_port rather than endpoint).

Correct.

Quoted 7 lines
Quoted 4 lines

2. 4ee48cc5586b drm: of: Fix double-free bug
One of the of_node_put() calls was removed as it was a double-free. This left the first incorrect of_node_put() in place, and the second is now a straight leak.

That's right, but this commit didn't introduce the leak, it was already there in 6529007522de (in addition to the double-free).

Ah, I see what you mean. My thought process was that the original comment had the bug "using the wrong variable", and (2) (partially) fixed that but in the process introduced a new bug (a memory leak). But I guess technically the memory leak was there from the beginning.

The other reason I referenced (2) in the Fixes line is because this patch depends on patch (2), whereas it won't apply cleanly without.

However I don't think it really matters either way: (2) has already been backported, and either way this needs fixing if either (1) or (2) are present.

Would you like me to resend with a "Fixes: 6529007522de drm: of: Add drm_of_lvds_get_dual_link_pixel_order", or are you happy to just fix this up when merging?

Thanks,

Steve

Quoted 40 lines
Quoted 39 lines

3. b557a5f8da57 drm/of: free the right object
This (correctly) fixes the first of_node_put() to free endpoint. And the post from Daniel was what caused me to look.

4. This patch
Reintroduces the of_node_put() removed in (2) but putting endpoint rather than remote_port.

I've put (2) in the Fixes line as this patch is fixing the leak introduced by that patch, but that in itself was of course 'fixing' the double free of the original patch.

Quoted 27 lines
Quoted 27 lines
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Daniel's email[1] made me take a look at this function and it appears that for_each_child_of_node()'s interface had caused a bad bug fix due to the hidden reference counting in the iterator.

[1] https://lore.kernel.org/r/YOxQ5TbkNrqCGBDJ%40phenom.ffwll.local

drivers/gpu/drm/drm_of.c +3 -1
index 197c57477344..997b8827fed2 100644
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;
#6 lore raw

Hi Steven,

Quoted 39 lines · Steven Price
Quoted 22 lines · Laurent Pinchart
Quoted 11 lines · Steven Price
Quoted 9 lines · Laurent Pinchart
Quoted 5 lines · Steven Price

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 4ee48cc5586b ("drm: of: Fix double-free bug")

I don't think the Fixes tag is correct, the issue was already present before 4ee48cc5586b. The fix looks right though.

Quoted 7 lines

I'm not sure quite what you mean by "already present". As I understand it the timeline was:

1. 6529007522de drm: of: Add drm_of_lvds_get_dual_link_pixel_order The function was originally added. This made the mistake twice of calling of_node_put() on the wrong variable (remote_port rather than endpoint).

Correct.

Quoted 7 lines
Quoted 4 lines

2. 4ee48cc5586b drm: of: Fix double-free bug
One of the of_node_put() calls was removed as it was a double-free. This left the first incorrect of_node_put() in place, and the second is now a straight leak.

That's right, but this commit didn't introduce the leak, it was already there in 6529007522de (in addition to the double-free).

Ah, I see what you mean. My thought process was that the original comment had the bug "using the wrong variable", and (2) (partially) fixed that but in the process introduced a new bug (a memory leak). But I guess technically the memory leak was there from the beginning.

The other reason I referenced (2) in the Fixes line is because this patch depends on patch (2), whereas it won't apply cleanly without.

Quoted 7 lines

However I don't think it really matters either way: (2) has already been backported, and either way this needs fixing if either (1) or (2) are present.

Would you like me to resend with a "Fixes: 6529007522de drm: of: Add drm_of_lvds_get_dual_link_pixel_order", or are you happy to just fix this up when merging?

I don't mind either way, from my point of view it can be fixed up by whoever will pick the patch up and merge it.

Quoted 39 lines
Quoted 39 lines
Quoted 39 lines

3. b557a5f8da57 drm/of: free the right object
This (correctly) fixes the first of_node_put() to free endpoint. And the post from Daniel was what caused me to look.

4. This patch
Reintroduces the of_node_put() removed in (2) but putting endpoint rather than remote_port.

I've put (2) in the Fixes line as this patch is fixing the leak introduced by that patch, but that in itself was of course 'fixing' the double free of the original patch.

Quoted 27 lines
Quoted 27 lines
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Daniel's email[1] made me take a look at this function and it appears that for_each_child_of_node()'s interface had caused a bad bug fix due to the hidden reference counting in the iterator.

[1] https://lore.kernel.org/r/YOxQ5TbkNrqCGBDJ%40phenom.ffwll.local

drivers/gpu/drm/drm_of.c +3 -1
index 197c57477344..997b8827fed2 100644
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;
Signature · 3 lines
Regards,

Laurent Pinchart
#7 lore raw

PATCH v2 1/1 drm/of: free the iterator object on failure

In reply to Steven Price

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 6529007522de ("drm: of: Add drm_of_lvds_get_dual_link_pixel_order")
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

v2: Fixes now refers to the original commit as suggested by Laurent, rather than 4ee48cc5586b ("drm: of: Fix double-free bug") which only fixed part of the problem. Note that 4ee48cc5586b is a dependency for this patch to cleanly apply.

drivers/gpu/drm/drm_of.c +3 -1
index 197c57477344..997b8827fed2 100644
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;
Signature · 1 line
2.20.1
Reviewed-by on v2 1/1
#8 lore raw

Hi Steven,

Thank you for the patch.

Quoted 6 lines · Steven Price

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 6529007522de ("drm: of: Add drm_of_lvds_get_dual_link_pixel_order")
Quoted 25 lines
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

v2: Fixes now refers to the original commit as suggested by Laurent, rather than 4ee48cc5586b ("drm: of: Fix double-free bug") which only fixed part of the problem. Note that 4ee48cc5586b is a dependency for this patch to cleanly apply.

drivers/gpu/drm/drm_of.c +3 -1
index 197c57477344..997b8827fed2 100644
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;
Signature · 3 lines
Regards,

Laurent Pinchart
author Applied
#9 lore raw
Quoted 5 lines · Laurent Pinchart

Hi Steven,

Thank you for the patch.

On Wed, Jul 14, 2021 at 03:33:00PM +0100, Steven Price wrote:

Quoted 8 lines
Quoted 6 lines

When bailing out due to the sanity check the iterator value needs to be freed because the early return prevents for_each_child_of_node() from doing the dereference itself.

Fixes 6529007522de ("drm: of: Add drm_of_lvds_get_dual_link_pixel_order")

Thanks! Applied to drm-misc-next.

Steve

Quoted 26 lines
Quoted 25 lines
---
 drivers/gpu/drm/drm_of.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

v2: Fixes now refers to the original commit as suggested by Laurent, rather than 4ee48cc5586b ("drm: of: Fix double-free bug") which only fixed part of the problem. Note that 4ee48cc5586b is a dependency for this patch to cleanly apply.

drivers/gpu/drm/drm_of.c +3 -1
index 197c57477344..997b8827fed2 100644
@@ -331,8 +331,10 @@ static int drm_of_lvds_get_remote_pixels_type(
 		 * configurations by passing the endpoints explicitly to
 		 * drm_of_lvds_get_dual_link_pixel_order().
 		 */
-		if (!current_pt || pixels_type != current_pt)
+		if (!current_pt || pixels_type != current_pt) {
+			of_node_put(endpoint);
 			return -EINVAL;
+		}
 	}
 
 	return pixels_type;