RISC-V: cpu: refactor deprecated strncpy
PATCH 1/1 RISC-V: cpu: refactor deprecated strncpy
strncpy is deprecated for use on NUL-terminated destination strings [1].
A suitable replacement is strscpy [2] due to the fact that it guarantees NUL-termination on its destination buffer argument which is _not_ the case for strncpy!
The sv_type buffer is declared with a size of 16 which is then followed by some strncpy calls to populate the buffer with one of:
"sv32", "sv57", "sv48", "sv39" or "none". Hard-coding the max length as 5 is error-prone and involves counting the number of characters (and hopefully not forgetting to count the NUL-byte) in the raw string.
Using a pre-determined max length in combination with strscpy provides a cleaner, less error-prone as well as a less ambiguous implementation. strscpy guarantees that it's destination buffer is NUL-terminated even if it's source argument exceeds the max length as defined by the third argument.
To be clear, there is no bug (i think?) in the current implementation but the current hard-coded values in combination with using a deprecated interface make this a worthwhile change, IMO.
[1]: www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings [2]: manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html
--- arch/riscv/kernel/cpu.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)
arch/riscv/kernel/cpu.c +8 -6
@@ -17,6 +17,8 @@#include <asm/smp.h> #include <asm/pgtable.h> +#define SV_TYPE_MAX_LENGTH 16 +/* * Returns the hart ID of the given device tree node, or -ENODEV if the node * isn't an enabled and valid RISC-V hart node.
@@ -271,21 +273,21 @@ static void print_isa(struct seq_file *f, const char *isa)static void print_mmu (struct seq_file *f) { -char sv_type[16 ]; +char sv_type[SV_TYPE_MAX_LENGTH ];#ifdef CONFIG_MMU #if defined(CONFIG_32BIT ) -strncpy (sv_type,"sv32" ,5 ); +strscpy (sv_type,"sv32" ,SV_TYPE_MAX_LENGTH );#elif defined(CONFIG_64BIT )if (pgtable_l5_enabled) -strncpy (sv_type,"sv57" ,5 ); +strscpy (sv_type,"sv57" ,SV_TYPE_MAX_LENGTH );else if (pgtable_l4_enabled) -strncpy (sv_type,"sv48" ,5 ); +strscpy (sv_type,"sv48" ,SV_TYPE_MAX_LENGTH );else -strncpy (sv_type,"sv39" ,5 ); +strscpy (sv_type,"sv39" ,SV_TYPE_MAX_LENGTH );#endif #else -strncpy (sv_type,"none" ,5 ); +strscpy (sv_type,"none" ,SV_TYPE_MAX_LENGTH );#endif /* CONFIG_MMU */ seq_printf (f,"mmu\t\t: %s\n" , sv_type); }
---
base-commit: 5d0c230f1de8c7515b6567d9afba1f196fb4e2f4
change-id: 20230801-arch-riscv-kernel-14a048cc6467
Best regards,
--
Justin Stitt <[email protected]>
Hey Justin,
Quoted 11 lines · Justin Stitt
strncpyis deprecated for use on NUL-terminated destination strings [1].A suitable replacement is
strscpy[2] due to the fact that it guarantees NUL-termination on its destination buffer argument which is _not_ the case forstrncpy!The
sv_typebuffer is declared with a size of 16 which is then followed by somestrncpycalls to populate the buffer with one of:
"sv32", "sv57", "sv48", "sv39" or "none". Hard-coding the max length as 5 is error-prone and involves counting the number of characters (and hopefully not forgetting to count the NUL-byte) in the raw string.
What is error prone about it when there are only 4 characters possible?
Quoted 4 lines
Using a pre-determined max length in combination with
strscpyprovides a cleaner, less error-prone as well as a less ambiguous implementation.strscpyguarantees that it's destination buffer is NUL-terminated even if it's source argument exceeds the max length as defined by the third
Wrong its ;)
Quoted 8 lines
argument.
To be clear, there is no bug (i think?) in the current implementation but the current hard-coded values in combination with using a deprecated interface make this a worthwhile change, IMO.
[1]: www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings [2]: manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html
This link is broken, it should be
https://manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html
Also, in the future, please use the form
so
and so on.
Quoted 38 lines
Signed-off-by Justin Stitt <[email protected]>--- arch/riscv/kernel/cpu.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)arch/riscv/kernel/cpu.c +6
-4@@ -17,6 +17,8 @@#include <asm/smp.h> #include <asm/pgtable.h> +#define SV_TYPE_MAX_LENGTH 16 +/* * Returns the hart ID of the given device tree node, or -ENODEV if the node * isn't an enabled and valid RISC-V hart node. @@ -271,21 +273,21 @@ static void print_isa(struct seq_file *f, const char *isa)static void print_mmu (struct seq_file *f) { -char sv_type[16 ]; +char sv_type[SV_TYPE_MAX_LENGTH ];#ifdef CONFIG_MMU #if defined(CONFIG_32BIT ) -strncpy (sv_type,"sv32" ,5 ); +strscpy (sv_type,"sv32" ,SV_TYPE_MAX_LENGTH );#elif defined(CONFIG_64BIT )if (pgtable_l5_enabled) -strncpy (sv_type,"sv57" ,5 ); +strscpy (sv_type,"sv57" ,SV_TYPE_MAX_LENGTH );else if (pgtable_l4_enabled) -strncpy (sv_type,"sv48" ,5 ); +strscpy (sv_type,"sv48" ,SV_TYPE_MAX_LENGTH );
arch/riscv/kernel/cpu.c static void print_isa(struct seq_file *f, const char *isa) · line 293
Quoted 10 lines
arch/riscv/kernel/cpu.c +2
-2else - strncpy(sv_type, "sv39", 5); + strscpy(sv_type, "sv39", SV_TYPE_MAX_LENGTH);#endif #else -strncpy (sv_type,"none" ,5 ); +strscpy (sv_type,"none" ,SV_TYPE_MAX_LENGTH );#endif /* CONFIG_MMU */ seq_printf (f,"mmu\t\t: %s\n" , sv_type); }
This all seems rather horrible, we should probably clean it up, but that is nothing to do with your patch. To be clear, I am also not requesting a resubmission for the commit message nitpickery.
Thanks,
Conor.
_______________________________________________
linux-riscv mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-riscv
Quoted 10 lines · Conor Dooley
Hey Justin,
Quoted 6 lines · Justin Stitt
strncpyis deprecated for use on NUL-terminated destination strings [1].A suitable replacement is
strscpy[2] due to the fact that it guarantees NUL-termination on its destination buffer argument which is _not_ the case forstrncpy!
Quoted 7 lines
Quoted 5 lines
The
sv_typebuffer is declared with a size of 16 which is then followed by somestrncpycalls to populate the buffer with one of:
"sv32", "sv57", "sv48", "sv39" or "none". Hard-coding the max length as 5 is error-prone and involves counting the number of characters (and hopefully not forgetting to count the NUL-byte) in the raw string.What is error prone about it when there are only 4 characters possible?
To clarify, I don't believe there is a bug in the current implementation. However, what I believe to be
error prone is that simply miscounting the length of the raw string would result in a buffer overread.
See here: https://godbolt.org/z/5reW7a1sz
Quoted 7 lines
Quoted 5 lines
Using a pre-determined max length in combination with
strscpyprovides a cleaner, less error-prone as well as a less ambiguous implementation.strscpyguarantees that it's destination buffer is NUL-terminated even if it's source argument exceeds the max length as defined by the thirdWrong its ;)
Oops, English is hard ;(
Quoted 7 lines
Quoted 7 lines
argument.
To be clear, there is no bug (i think?) in the current implementation but the current hard-coded values in combination with using a deprecated interface make this a worthwhile change, IMO.
Quoted 5 lines
Quoted 2 lines
[1]: www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings [2]: manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html
This link is broken, it should be
https://manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html
Noted, will fix in future patches.
Quoted 10 lines
Also, in the future, please use the form
Link <url> [ref]so
and so on.
Got it. Thanks!
Quoted 54 lines
Quoted 39 lines
Signed-off-by Justin Stitt <[email protected]>--- arch/riscv/kernel/cpu.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)arch/riscv/kernel/cpu.c +6
-4@@ -17,6 +17,8 @@#include <asm/smp.h> #include <asm/pgtable.h> +#define SV_TYPE_MAX_LENGTH 16 +/* * Returns the hart ID of the given device tree node, or -ENODEV if the node * isn't an enabled and valid RISC-V hart node. @@ -271,21 +273,21 @@ static void print_isa(struct seq_file *f, const char *isa)static void print_mmu (struct seq_file *f) { -char sv_type[16 ]; +char sv_type[SV_TYPE_MAX_LENGTH ];#ifdef CONFIG_MMU #if defined(CONFIG_32BIT ) -strncpy (sv_type,"sv32" ,5 ); +strscpy (sv_type,"sv32" ,SV_TYPE_MAX_LENGTH );#elif defined(CONFIG_64BIT )if (pgtable_l5_enabled) -strncpy (sv_type,"sv57" ,5 ); +strscpy (sv_type,"sv57" ,SV_TYPE_MAX_LENGTH );else if (pgtable_l4_enabled) -strncpy (sv_type,"sv48" ,5 ); +strscpy (sv_type,"sv48" ,SV_TYPE_MAX_LENGTH );arch/riscv/kernel/cpu.c static void print_isa(struct seq_file *f, const char *isa) · line 293
Quoted 10 lines
arch/riscv/kernel/cpu.c +2
-2else - strncpy(sv_type, "sv39", 5); + strscpy(sv_type, "sv39", SV_TYPE_MAX_LENGTH);#endif #else -strncpy (sv_type,"none" ,5 ); +strscpy (sv_type,"none" ,SV_TYPE_MAX_LENGTH );#endif /* CONFIG_MMU */ seq_printf (f,"mmu\t\t: %s\n" , sv_type); }This all seems rather horrible, we should probably clean it up, but that is nothing to do with your patch. To be clear, I am also not requesting a resubmission for the commit message nitpickery.
Quoted 4 lines
Reviewed-by Conor Dooley <[email protected]>Thanks,
Conor.
--
Justin
Quoted 13 lines · Justin Stitt
strncpyis deprecated for use on NUL-terminated destination strings [1].A suitable replacement is
strscpy[2] due to the fact that it guarantees NUL-termination on its destination buffer argument which is _not_ the case forstrncpy!The
sv_typebuffer is declared with a size of 16 which is then followed by somestrncpycalls to populate the buffer with one of:
"sv32", "sv57", "sv48", "sv39" or "none". Hard-coding the max length as 5 is error-prone and involves counting the number of characters (and hopefully not forgetting to count the NUL-byte) in the raw string.
Quoted 5 lines
Using a pre-determined max length in combination with
strscpyprovides a cleaner, less error-prone as well as a less ambiguous implementation.strscpyguarantees that it's destination buffer is NUL-terminated even if it's source argument exceeds the max length as defined by the third argument.
I would imagine you’d want a BUG_ON() rather than silent truncation if that ever happened (well, silent if you ignore it then printing the truncated string).
Though really you just want a static_strcpy that looks at sizeof* for source and destination and fails to build if it doesn’t fit; there’s no reason this needs to be found at run time.
(* and __builtin_types_compatible_p(char[], ...))
Jess
Quoted 20 lines · Jessica Clarke
Quoted 13 lines · Justin Stitt
strncpyis deprecated for use on NUL-terminated destination strings [1].A suitable replacement is
strscpy[2] due to the fact that it guarantees NUL-termination on its destination buffer argument which is _not_ the case forstrncpy!The
sv_typebuffer is declared with a size of 16 which is then followed by somestrncpycalls to populate the buffer with one of:
"sv32", "sv57", "sv48", "sv39" or "none". Hard-coding the max length as 5 is error-prone and involves counting the number of characters (and hopefully not forgetting to count the NUL-byte) in the raw string.Quoted 5 lines
Using a pre-determined max length in combination with
strscpyprovides a cleaner, less error-prone as well as a less ambiguous implementation.strscpyguarantees that it's destination buffer is NUL-terminated even if it's source argument exceeds the max length as defined by the third argument.
Quoted 7 lines
I would imagine you’d want a
BUG_ON()rather than silent truncation if that ever happened (well, silent if you ignore it then printing the truncated string).Though really you just want a
static_strcpythat looks at sizeof* for source and destination and fails to build if it doesn’t fit; there’s no reason this needs to be found at run time.
FWIW, under CONFIG_FORTIFY_SOURCE, strscpy() does try to just fold away to a static strcpy when sizes are provably safe, etc.
Signature · 1 line
Kees Cook
Quoted 63 lines · Justin Stitt
strncpyis deprecated for use on NUL-terminated destination strings [1].A suitable replacement is
strscpy[2] due to the fact that it guarantees NUL-termination on its destination buffer argument which is _not_ the case forstrncpy!The
sv_typebuffer is declared with a size of 16 which is then followed by somestrncpycalls to populate the buffer with one of:
"sv32", "sv57", "sv48", "sv39" or "none". Hard-coding the max length as 5 is error-prone and involves counting the number of characters (and hopefully not forgetting to count the NUL-byte) in the raw string.Using a pre-determined max length in combination with
strscpyprovides a cleaner, less error-prone as well as a less ambiguous implementation.strscpyguarantees that it's destination buffer is NUL-terminated even if it's source argument exceeds the max length as defined by the third argument.To be clear, there is no bug (i think?) in the current implementation but the current hard-coded values in combination with using a deprecated interface make this a worthwhile change, IMO.
[1]: www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings [2]: manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html
Signed-off-by Justin Stitt <[email protected]>--- arch/riscv/kernel/cpu.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)arch/riscv/kernel/cpu.c +6
-4@@ -17,6 +17,8 @@#include <asm/smp.h> #include <asm/pgtable.h> +#define SV_TYPE_MAX_LENGTH 16 +/* * Returns the hart ID of the given device tree node, or -ENODEV if the node * isn't an enabled and valid RISC-V hart node. @@ -271,21 +273,21 @@ static void print_isa(struct seq_file *f, const char *isa)static void print_mmu (struct seq_file *f) { -char sv_type[16 ]; +char sv_type[SV_TYPE_MAX_LENGTH ];#ifdef CONFIG_MMU #if defined(CONFIG_32BIT ) -strncpy (sv_type,"sv32" ,5 ); +strscpy (sv_type,"sv32" ,SV_TYPE_MAX_LENGTH );#elif defined(CONFIG_64BIT )if (pgtable_l5_enabled) -strncpy (sv_type,"sv57" ,5 ); +strscpy (sv_type,"sv57" ,SV_TYPE_MAX_LENGTH );else if (pgtable_l4_enabled) -strncpy (sv_type,"sv48" ,5 ); +strscpy (sv_type,"sv48" ,SV_TYPE_MAX_LENGTH );
arch/riscv/kernel/cpu.c static void print_isa(struct seq_file *f, const char *isa) · line 293
Quoted 10 lines
arch/riscv/kernel/cpu.c +2
-2else - strncpy(sv_type, "sv39", 5); + strscpy(sv_type, "sv39", SV_TYPE_MAX_LENGTH);#endif #else -strncpy (sv_type,"none" ,5 ); +strscpy (sv_type,"none" ,SV_TYPE_MAX_LENGTH );#endif /* CONFIG_MMU */ seq_printf (f,"mmu\t\t: %s\n" , sv_type); }
I'd say just throw the whole buffer away and just avoid copying the .rodata strings onto the stack for no reason. They can be used directly:
static void print_mmu(struct seq_file *f)
{
const char *sv_type;#ifdef CONFIG_MMU
#if defined(CONFIG_32BIT) sv_type = "sv32"; #elif defined(CONFIG_64BIT) if (pgtable_l5_enabled) sv_type = "sv57"; else if (pgtable_l4_enabled) sv_type = "sv48"; else sv_type = "sv39"; #endif #else sv_type = "none"; #endif /* CONFIG_MMU */ seq_printf(f, "mmu\t\t: %s\n", sv_type); }
Signature · 1 line
Kees Cook