lib/string_helpers: drop redundant allocation in kasprintf_strarray
Subsystems (2)
PATCH 1/2 lib/string_helpers: drop redundant allocation in kasprintf_strarray
kasprintf_strarray() returns an array of N strings and kfree_strarray() also frees N entries. However, kasprintf_strarray() currently allocates N+1 char pointers. Allocate exactly N pointers instead of N+1.
Also update the kernel-doc for @n.
--- lib/string_helpers.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
lib/string_helpers.c +2 -2
@@ -752,7 +752,7 @@ EXPORT_SYMBOL_GPL(kstrdup_and_replace);* kasprintf_strarray - allocate and fill array of sequential strings * @gfp: flags for the slab allocator * @prefix: prefix to be used -* @n: amount of lines to be allocated and filled +* @n: number of strings to be allocated and filled * * Allocates and fills @n strings using pattern "%s-%zu", where prefix * is provided by caller. The caller is responsible to free them with
@@ -765,7 +765,7 @@ char **kasprintf_strarray(gfp_t gfp, const char *prefix, size_t n)char **names;size_t i; - names =kcalloc (n +1 ,sizeof (char *), gfp); + names =kcalloc (n,sizeof (char *), gfp);if (!names)return NULL ;
PATCH 2/2 lib/string_helpers: annotate struct strarray with __counted_by_ptr
Add the __counted_by_ptr() compiler attribute to 'array' to improve bounds checking via CONFIG_UBSAN_BOUNDS and CONFIG_FORTIFY_SOURCE.
--- lib/string_helpers.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
lib/string_helpers.c +2 -2
@@ -805,7 +805,7 @@ void kfree_strarray(char **array, size_t n)EXPORT_SYMBOL_GPL (kfree_strarray);struct strarray { -char **array; + char **array __counted_by_ptr(n);size_t n; };
@@ -824,13 +824,13 @@ char **devm_kasprintf_strarray(struct device *dev, const char *prefix, size_t n)if (!ptr)return ERR_PTR (-ENOMEM ); + ptr->n = n; ptr->array =kasprintf_strarray (GFP_KERNEL , prefix, n);if (!ptr->array) {devres_free (ptr);return ERR_PTR (-ENOMEM ); } - ptr->n = n;devres_add (dev, ptr);return ptr->array;
Quoted 5 lines · Thorsten Blum
kasprintf_strarray()returns an array of N strings andkfree_strarray()also frees N entries. However,kasprintf_strarray()currently allocates N+1 char pointers. Allocate exactly N pointers instead of N+1.Also update the kernel-doc for @n.
Have you checked all current users that they do not rely on the NULL terminated array?
Note, that was done on purpose that once allocated it can allow user to drop the track of the number of strings and rely on NULL terminator. I.o.w. the number of strings may be just a local variable somewhere where kasprintf_strarray() is called.
I tend to NAK this change, rather you can update kernel-doc to explain why it's done this way (see above).
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 9 lines · Andy Shevchenko
Quoted 5 lines · Thorsten Blum
kasprintf_strarray()returns an array of N strings andkfree_strarray()also frees N entries. However,kasprintf_strarray()currently allocates N+1 char pointers. Allocate exactly N pointers instead of N+1.Also update the kernel-doc for @n.
Have you checked all current users that they do not rely on the NULL terminated array?
Yes, I've checked all call sites, and none of them rely on the NULL terminator. Specifically, I checked:
drivers/gpio/gpio-mockup.c
which uses PROPERTY_ENTRY_STRING_ARRAY_LEN(), and
drivers/pinctrl/bcm/pinctrl-bcm4908.c
drivers/pinctrl/intel/pinctrl-intel-platform.c
drivers/pinctrl/meson/pinctrl-amlogic-a4.c
drivers/pinctrl/mvebu/pinctrl-armada-37xx.c
drivers/pinctrl/pinctrl-at91.c
drivers/pinctrl/pinctrl-rockchip.c
drivers/pinctrl/pinctrl-st.c
all of which use the size N to iterate over the returned array.
Also, kfree_strarray() explicitly takes the number of entries N, indicating that callers are expected to keep track of it.
Quoted 7 lines
Note, that was done on purpose that once allocated it can allow user to drop the track of the number of strings and rely on NULL terminator. I.o.w. the number of strings may be just a local variable somewhere where
kasprintf_strarray()is called.I tend to NAK this change, rather you can update kernel-doc to explain why it's done this way (see above).
Quoted 26 lines · Thorsten Blum
Quoted 9 lines · Andy Shevchenko
Quoted 5 lines · Thorsten Blum
kasprintf_strarray()returns an array of N strings andkfree_strarray()also frees N entries. However,kasprintf_strarray()currently allocates N+1 char pointers. Allocate exactly N pointers instead of N+1.Also update the kernel-doc for @n.
Have you checked all current users that they do not rely on the NULL terminated array?
Yes, I've checked all call sites, and none of them rely on the NULL terminator. Specifically, I checked:
drivers/gpio/gpio-mockup.cwhich uses
PROPERTY_ENTRY_STRING_ARRAY_LEN(), and
drivers/pinctrl/bcm/pinctrl-bcm4908.c
drivers/pinctrl/intel/pinctrl-intel-platform.c
drivers/pinctrl/meson/pinctrl-amlogic-a4.c
drivers/pinctrl/mvebu/pinctrl-armada-37xx.c
drivers/pinctrl/pinctrl-at91.c
drivers/pinctrl/pinctrl-rockchip.c
drivers/pinctrl/pinctrl-st.c
Quoted 1 line
all of which use the size N to iterate over the returned array.
Thanks for confirming.
Quoted 2 lines
Also,
kfree_strarray()explicitly takes the number of entries N, indicating that callers are expected to keep track of it.
Still we might have an API that requires a NULL terminated arrays (when it doesn't take size), which a caller wants to use.
Quoted 7 lines
Quoted 7 lines
Note, that was done on purpose that once allocated it can allow user to drop the track of the number of strings and rely on NULL terminator. I.o.w. the number of strings may be just a local variable somewhere where
kasprintf_strarray()is called.I tend to NAK this change, rather you can update kernel-doc to explain why it's done this way (see above).
Given pros and cons, and what David said I'm still not sure that this is going to be a beneficial patch. I leave it Kees and Andrew to decide.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Hi Kees and Andrew,
Quoted 42 lines · Andy Shevchenko
Quoted 26 lines · Thorsten Blum
Quoted 9 lines · Andy Shevchenko
Quoted 5 lines · Thorsten Blum
kasprintf_strarray()returns an array of N strings andkfree_strarray()also frees N entries. However,kasprintf_strarray()currently allocates N+1 char pointers. Allocate exactly N pointers instead of N+1.Also update the kernel-doc for @n.
Have you checked all current users that they do not rely on the NULL terminated array?
Yes, I've checked all call sites, and none of them rely on the NULL terminator. Specifically, I checked:
drivers/gpio/gpio-mockup.cwhich uses
PROPERTY_ENTRY_STRING_ARRAY_LEN(), and
drivers/pinctrl/bcm/pinctrl-bcm4908.c
drivers/pinctrl/intel/pinctrl-intel-platform.c
drivers/pinctrl/meson/pinctrl-amlogic-a4.c
drivers/pinctrl/mvebu/pinctrl-armada-37xx.c
drivers/pinctrl/pinctrl-at91.c
drivers/pinctrl/pinctrl-rockchip.c
drivers/pinctrl/pinctrl-st.cQuoted 1 line
all of which use the size N to iterate over the returned array.
Thanks for confirming.
Quoted 2 lines
Also,
kfree_strarray()explicitly takes the number of entries N, indicating that callers are expected to keep track of it.Still we might have an API that requires a NULL terminated arrays (when it doesn't take size), which a caller wants to use.
Quoted 5 lines
Quoted 5 lines
Note, that was done on purpose that once allocated it can allow user to drop the track of the number of strings and rely on NULL terminator. I.o.w. the number of strings may be just a local variable somewhere where
kasprintf_strarray()is called.
Quoted 5 lines
Quoted 2 lines
Quoted 2 lines
I tend to NAK this change, rather you can update kernel-doc to explain why it's done this way (see above).
Given pros and cons, and what David said I'm still not sure that this is going to be a beneficial patch. I leave it Kees and Andrew to decide.
What's your take on this and the __counted_by_ptr() annotation from patch 2/2?
Thanks,
Thorsten
Kees Cook
maintainerQuoted 39 lines · Thorsten Blum
Hi Kees and Andrew,
Quoted 36 lines · Andy Shevchenko
Quoted 26 lines · Thorsten Blum
Quoted 9 lines · Andy Shevchenko
Quoted 5 lines · Thorsten Blum
kasprintf_strarray()returns an array of N strings andkfree_strarray()also frees N entries. However,kasprintf_strarray()currently allocates N+1 char pointers. Allocate exactly N pointers instead of N+1.Also update the kernel-doc for @n.
Have you checked all current users that they do not rely on the NULL terminated array?
Yes, I've checked all call sites, and none of them rely on the NULL terminator. Specifically, I checked:
drivers/gpio/gpio-mockup.cwhich uses
PROPERTY_ENTRY_STRING_ARRAY_LEN(), and
drivers/pinctrl/bcm/pinctrl-bcm4908.c
drivers/pinctrl/intel/pinctrl-intel-platform.c
drivers/pinctrl/meson/pinctrl-amlogic-a4.c
drivers/pinctrl/mvebu/pinctrl-armada-37xx.c
drivers/pinctrl/pinctrl-at91.c
drivers/pinctrl/pinctrl-rockchip.c
drivers/pinctrl/pinctrl-st.cQuoted 1 line
all of which use the size N to iterate over the returned array.
Thanks for confirming.
Quoted 2 lines
Also,
kfree_strarray()explicitly takes the number of entries N, indicating that callers are expected to keep track of it.Still we might have an API that requires a NULL terminated arrays (when it doesn't take size), which a caller wants to use.
What I find problematic here is that we allocate N+1 and free N. And this is repeated in wrappers too, like devm_kasprintf_strarray(), which explicitly tracks N for the later devm free. How has kmemleak missed this?
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Note, that was done on purpose that once allocated it can allow user to drop the track of the number of strings and rely on NULL terminator. I.o.w. the number of strings may be just a local variable somewhere where
kasprintf_strarray()is called.
Quoted 8 lines
Quoted 5 lines
Quoted 2 lines
Quoted 2 lines
I tend to NAK this change, rather you can update kernel-doc to explain why it's done this way (see above).
Given pros and cons, and what David said I'm still not sure that this is going to be a beneficial patch. I leave it Kees and Andrew to decide.
What's your take on this and the
__counted_by_ptr()annotation from patch 2/2?
I think both patches look good.
Signature · 1 line
Kees Cook
Quoted 10 lines · On Wed, 15 Apr 2026 17:42:41 +0300 Andy Shevchenko…
Quoted 5 lines · Thorsten Blum
kasprintf_strarray()returns an array of N strings andkfree_strarray()also frees N entries. However,kasprintf_strarray()currently allocates N+1 char pointers. Allocate exactly N pointers instead of N+1.Also update the kernel-doc for @n.
Have you checked all current users that they do not rely on the NULL terminated array?
Quoted 8 lines
Note, that was done on purpose that once allocated it can allow user to drop the track of the number of strings and rely on NULL terminator. I.o.w. the number of strings may be just a local variable somewhere where
kasprintf_strarray()is called.I tend to NAK this change, rather you can update kernel-doc to explain why it's done this way (see above).
It isn't as though it is going to make much difference to the memory footprint.
Allocating an extra trailing NULL is just a bit safer.
David
Quoted 8 lines · Thorsten Blum
kasprintf_strarray()returns an array of N strings andkfree_strarray()also frees N entries. However,kasprintf_strarray()currently allocates N+1 char pointers. Allocate exactly N pointers instead of N+1.Also update the kernel-doc for @n.
[...]
Applied to for-next/hardening, thanks!
[1/2] lib/string_helpers: drop redundant allocation in kasprintf_strarray
https://git.kernel.org/kees/c/233e1ab98026 [2/2] lib/string_helpers: annotate struct strarray with __counted_by_ptr https://git.kernel.org/kees/c/8f64fb098a5b
Take care,
Signature · 1 line
Kees Cook