Skip to contentSkip to conversation

kunit: alloc_string_stream_fragment error handling bug fix

PATCH In review YoungJun.park 4 participants 4 messages Oct 28, 2022 – Oct 31, 2022

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

PATCH 1/1 kunit: alloc_string_stream_fragment error handling bug fix

When it fails to allocate fragment, it does not free and return error. And check the pointer inappropriately.

---
 lib/kunit/string-stream.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
lib/kunit/string-stream.c +4 -2
index 72659a9773e3..0228fe814e96 100644
@@ -23,8 +23,10 @@ static struct string_stream_fragment *alloc_string_stream_fragment(
 		return ERR_PTR(-ENOMEM);
 
 	frag->fragment = kunit_kmalloc(test, len, gfp);
-	if (!frag->fragment)
+	if (!frag->fragment) {
+		kunit_kfree(test, frag);
 		return ERR_PTR(-ENOMEM);
+	}
 
 	return frag;
 }
@@ -56,7 +58,7 @@ int string_stream_vadd(struct string_stream *stream,
 	frag_container = alloc_string_stream_fragment(stream->test,
 						      len,
 						      stream->gfp);
-	if (!frag_container)
+	if (IS_ERR(frag_container))
 		return -ENOMEM;
 
 	len = vsnprintf(frag_container->fragment, len, fmt, args);
Signature · 1 line
2.25.1
#1 lore raw
Quoted 13 lines · YoungJun.park

When it fails to allocate fragment, it does not free and return error. And check the pointer inappropriately.

---
 lib/kunit/string-stream.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
lib/kunit/string-stream.c +0 -0
index 72659a9773e3..0228fe814e96 100644

lib/kunit/string-stream.c static struct string_stream_fragment *alloc_string_stream_fragment( · line 27

Quoted 6 lines
lib/kunit/string-stream.c +2 -1
@@ -23,8 +23,10 @@ static struct string_stream_fragment *alloc_string_stream_fragment(
 		return ERR_PTR(-ENOMEM);
 
 	frag->fragment = kunit_kmalloc(test, len, gfp);
-	if (!frag->fragment)
+	if (!frag->fragment) {
+		kunit_kfree(test, frag);

I don't believe that kunit_kfree is necessary here, because kunit_kmalloc is like kmalloc, but the allocation is test managed, which means that the allocation is managed by the test case and is automatically cleaned up after the test case concludes.

So, the original version seems correct: if the allocation fails, alloc_string_stream_fragment will return NULL and string_stream_vadd will check if frag_container is different than NULL.

Best Regards,
- Maíra Canal

Quoted 14 lines
lib/kunit/string-stream.c +2 -1
 		return ERR_PTR(-ENOMEM);
+	}
 
 	return frag;
 }
@@ -56,7 +58,7 @@ int string_stream_vadd(struct string_stream *stream,
 	frag_container = alloc_string_stream_fragment(stream->test,
 						      len,
 						      stream->gfp);
-	if (!frag_container)
+	if (IS_ERR(frag_container))
 		return -ENOMEM;
 
 	len = vsnprintf(frag_container->fragment, len, fmt, args);
Reviewed-by on v1 1/1
#2 lore raw
In reply to YoungJun.park
Quoted 6 lines · YoungJun.park

When it fails to allocate fragment, it does not free and return error. And check the pointer inappropriately.

---

Thanks! As Maíra points out, the added kunit_kfree() call isn't strictly necessary, though it definitely doesn't hurt (and it's probably a nice thing to free memory early if we're already in a pretty dire memory situation). So I think it's an improvement.

The IS_ERR check is definitely a fix, though.

Cheers,
-- David

Quoted 35 lines
 lib/kunit/string-stream.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
lib/kunit/string-stream.c +4 -3
index 72659a9773e3..0228fe814e96 100644
@@ -23,8 +23,10 @@ static struct string_stream_fragment *alloc_string_stream_fragment(
                return ERR_PTR(-ENOMEM);
 
        frag->fragment = kunit_kmalloc(test, len, gfp);
-       if (!frag->fragment)
+       if (!frag->fragment) {
+               kunit_kfree(test, frag);
                return ERR_PTR(-ENOMEM);
+       }
 
        return frag;
 }
@@ -56,7 +58,7 @@ int string_stream_vadd(struct string_stream *stream,
        frag_container = alloc_string_stream_fragment(stream->test,
                                                      len,
                                                      stream->gfp);
-       if (!frag_container)
+       if (IS_ERR(frag_container))
                return -ENOMEM;
 
        len = vsnprintf(frag_container->fragment, len, fmt, args);
--

2.25.1

--
You received this message because you are subscribed to the Google Groups "KUnit Development" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20221028144241.634012-1-her0gyugyu%40gmail.com.

#3 lore raw
Quoted 9 lines · David Gow' via KUnit Development
Quoted 6 lines · YoungJun.park

When it fails to allocate fragment, it does not free and return error. And check the pointer inappropriately.

---

Quoted 6 lines

Thanks! As Maíra points out, the added kunit_kfree() call isn't strictly necessary, though it definitely doesn't hurt (and it's probably a nice thing to free memory early if we're already in a pretty dire memory situation). So I think it's an improvement.

The IS_ERR check is definitely a fix, though.

Note: the IS_ERR check was fixed already in
https://patchwork.kernel.org/project/linux-kselftest/patch/Y0kt1aCTHO4r2CmL@kili/
That change has made its way into torvalds/master.
So we could rebase this patch and reword it to talk just about the early kfree().

Re free memory early:
It'll save us sizeof(struct string_stream_fragment) + sizeof(struct kunit_resource), i.e. 24 + 56 = 80 bytes (on UML/x86_64). So it's not much, but I guess it could help in edge cases.

Daniel