scsi: core: Safe warning about bad dev info string
PATCH 1/1 scsi: core: Safe warning about bad dev info string
Both "model" and "strflags" are passed to "%s" even when one or both are NULL.
It is safe because vsprintf() would detect the NULL pointer and print "(null)". But it is a kernel-specific feature and compiler warns about it:
<warning>
In file included from include/linux/kernel.h:19,
from arch/x86/include/asm/percpu.h:27,
from arch/x86/include/asm/current.h:6,
from include/linux/sched.h:12,
from include/linux/blkdev.h:5,
from drivers/scsi/scsi_devinfo.c:3: drivers/scsi/scsi_devinfo.c: In function 'scsi_dev_info_list_add_str':
Quoted 1 line
Quoted 1 line
include/linux/printk.h:434:44: warning: '%s' directive argument is null [-Wformat-overflow=]
434 | #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__)
| ^
include/linux/printk.h:430:3: note: in definition of macro 'printk_index_wrap'
430 | _p_func(_fmt, ##__VA_ARGS__); \
| ^~~~~~~
drivers/scsi/scsi_devinfo.c:551:4: note: in expansion of macro 'printk'
551 | printk(KERN_ERR "%s: bad dev info string '%s' '%s'"
| ^~~~~~
drivers/scsi/scsi_devinfo.c:552:14: note: format string is defined here
552 | " '%s'\n", __func__, vendor, model,
| ^~</warning>
Do not rely on the kernel specific behavior and print the message a safe way.
---
Note: The patch is only compile tested.
drivers/scsi/scsi_devinfo.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/scsi/scsi_devinfo.c +3 -3
@@ -551,9 +551,9 @@ static int scsi_dev_info_list_add_str(char *dev_list)if (model) strflags =strsep (&next, next_check);if (!model || !strflags) { -printk (KERN_ERR "%s: bad dev info string '%s' '%s'" -" '%s'\n" , __func__, vendor, model, - strflags); +pr_err ("%s: bad dev info string '%s' '%s' '%s'\n" , + __func__, vendor, model ? model :"" , + strflags ? strflags :"" ); res = -EINVAL ; }else res = scsi_dev_info_list_add(0 /* compatible */, vendor,
Signature · 1 line
2.43.0
Quoted 47 lines · Petr Mladek
Both "model" and "strflags" are passed to "%s" even when one or both are NULL.
It is safe because
vsprintf()would detect the NULL pointer and print "(null)". But it is a kernel-specific feature and compiler warns about it:<warning>
In file included frominclude/linux/kernel.h:19,
fromarch/x86/include/asm/percpu.h:27, fromarch/x86/include/asm/current.h:6, frominclude/linux/sched.h:12,
frominclude/linux/blkdev.h:5,
fromdrivers/scsi/scsi_devinfo.c:3:
drivers/scsi/scsi_devinfo.c: In function 'scsi_dev_info_list_add_str':Quoted 1 line
Quoted 1 line
include/linux/printk.h:434:44: warning: '%s' directive argument is null [-Wformat-overflow=]434 | #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__) | ^ include/linux/printk.h:430:3: note: in definition of macro 'printk_index_wrap' 430 | _p_func(_fmt, ##__VA_ARGS__); \ | ^~~~~~~ drivers/scsi/scsi_devinfo.c:551:4: note: in expansion of macro 'printk' 551 | printk(KERN_ERR "%s: bad dev info string '%s' '%s'" | ^~~~~~ drivers/scsi/scsi_devinfo.c:552:14: note: format string is defined here 552 | " '%s'\n", __func__, vendor, model, | ^~</warning>
Do not rely on the kernel specific behavior and print the message a safe way.
Reported-by kernel test robot <[email protected]>Signed-off-by Petr Mladek <[email protected]>---
Note: The patch is only compile tested.drivers/scsi/scsi_devinfo.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)drivers/scsi/scsi_devinfo.c +0
-0@@ -551,9 +551,9 @@ static int scsi_dev_info_list_add_str(char *dev_list)if (model) strflags =strsep (&next, next_check);
drivers/scsi/scsi_devinfo.c static int scsi_dev_info_list_add_str(char *dev_list) · line 559
Quoted 10 lines
drivers/scsi/scsi_devinfo.c +3
-3if (!model || !strflags) { -printk (KERN_ERR "%s: bad dev info string '%s' '%s'" -" '%s'\n" , __func__, vendor, model, - strflags); +pr_err ("%s: bad dev info string '%s' '%s' '%s'\n" , + __func__, vendor, model ? model :"" , + strflags ? strflags :"" ); res = -EINVAL ; }else res = scsi_dev_info_list_add(0 /* compatible */, vendor,
Expressions like "model ? model : """ can be shortened into "model ? : """.
Anyway:
Hi Petr,
Quoted 45 lines · Petr Mladek
Both "model" and "strflags" are passed to "%s" even when one or both are NULL.
It is safe because
vsprintf()would detect the NULL pointer and print "(null)". But it is a kernel-specific feature and compiler warns about it:<warning>
In file included frominclude/linux/kernel.h:19,from arch/x86/include/asm/percpu.h:27, from arch/x86/include/asm/current.h:6, from include/linux/sched.h:12, from include/linux/blkdev.h:5, from drivers/scsi/scsi_devinfo.c:3:
drivers/scsi/scsi_devinfo.c: In function 'scsi_dev_info_list_add_str':Quoted 1 line
Quoted 1 line
include/linux/printk.h:434:44: warning: '%s' directive argument is null [-Wformat-overflow=]434 | #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__) | ^ include/linux/printk.h:430:3: note: in definition of macro 'printk_index_wrap' 430 | _p_func(_fmt, ##__VA_ARGS__); \ | ^~~~~~~ drivers/scsi/scsi_devinfo.c:551:4: note: in expansion of macro 'printk' 551 | printk(KERN_ERR "%s: bad dev info string '%s' '%s'" | ^~~~~~ drivers/scsi/scsi_devinfo.c:552:14: note: format string is defined here 552 | " '%s'\n", __func__, vendor, model, | ^~</warning>
Do not rely on the kernel specific behavior and print the message a safe way.
Reported-by kernel test robot <[email protected]>Signed-off-by Petr Mladek <[email protected]>---
Note: The patch is only compile tested.drivers/scsi/scsi_devinfo.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)drivers/scsi/scsi_devinfo.c +0
-0
drivers/scsi/scsi_devinfo.c static int scsi_dev_info_list_add_str(char *dev_list) · line 556
Quoted 9 lines
drivers/scsi/scsi_devinfo.c +3
-3@@ -551,9 +551,9 @@ static int scsi_dev_info_list_add_str(char *dev_list)if (model) strflags =strsep (&next, next_check);if (!model || !strflags) { -printk (KERN_ERR "%s: bad dev info string '%s' '%s'" -" '%s'\n" , __func__, vendor, model, - strflags); +pr_err ("%s: bad dev info string '%s' '%s' '%s'\n" , + __func__, vendor, model ? model :"" , + strflags ? strflags :"" );
Do we really want to make this change?
The kernel's vsprintf() implementation has supported NULL pointers since forever, and lots of code relies on that behavior.
Perhaps this warning can be disabled instead?
drivers/scsi/scsi_devinfo.c static int scsi_dev_info_list_add_str(char *dev_list) · line 559
Quoted 3 lines
drivers/scsi/scsi_devinfo.c +0
-0res = -EINVAL ; }else res = scsi_dev_info_list_add(0 /* compatible */, vendor,
Gr{oetje,eeting}s,
Geert
Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected] In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
Quoted 54 lines · Geert Uytterhoeven
Hi Petr,
Quoted 51 lines · Petr Mladek
Both "model" and "strflags" are passed to "%s" even when one or both are NULL.
It is safe because
vsprintf()would detect the NULL pointer and print "(null)". But it is a kernel-specific feature and compiler warns about it:<warning>
In file included frominclude/linux/kernel.h:19,from arch/x86/include/asm/percpu.h:27, from arch/x86/include/asm/current.h:6, from include/linux/sched.h:12, from include/linux/blkdev.h:5, from drivers/scsi/scsi_devinfo.c:3:
drivers/scsi/scsi_devinfo.c: In function 'scsi_dev_info_list_add_str':Quoted 1 line
Quoted 1 line
include/linux/printk.h:434:44: warning: '%s' directive argument is null [-Wformat-overflow=]434 | #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__) | ^ include/linux/printk.h:430:3: note: in definition of macro 'printk_index_wrap' 430 | _p_func(_fmt, ##__VA_ARGS__); \ | ^~~~~~~ drivers/scsi/scsi_devinfo.c:551:4: note: in expansion of macro 'printk' 551 | printk(KERN_ERR "%s: bad dev info string '%s' '%s'" | ^~~~~~ drivers/scsi/scsi_devinfo.c:552:14: note: format string is defined here 552 | " '%s'\n", __func__, vendor, model, | ^~</warning>
Do not rely on the kernel specific behavior and print the message a safe way.
Reported-by kernel test robot <[email protected]>Signed-off-by Petr Mladek <[email protected]>---
Note: The patch is only compile tested.drivers/scsi/scsi_devinfo.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)drivers/scsi/scsi_devinfo.c +0
-2@@ -551,9 +551,9 @@ static int scsi_dev_info_list_add_str(char *dev_list)if (model) strflags =strsep (&next, next_check);if (!model || !strflags) { - printk(KERN_ERR "%s: bad dev info string '%s' '%s'" - " '%s'\n", __func__, vendor, model,
Quoted 8 lines
drivers/scsi/scsi_devinfo.c static int scsi_dev_info_list_add_str(char *dev_list) · line 556
Quoted 4 lines
drivers/scsi/scsi_devinfo.c +3
-1- strflags); +pr_err ("%s: bad dev info string '%s' '%s' '%s'\n" , + __func__, vendor, model ? model :"" , + strflags ? strflags :"" );Do we really want to make this change?
The kernel'svsprintf()implementation has supported NULL pointers since forever, and lots of code relies on that behavior.
Yeah, it was safe even in the first git commit. And it was probably safe long before.
Well, I can't find easily how much code relies on this. I would personally do not rely on it when writing new code.
Quoted 1 line
Perhaps this warning can be disabled instead?
IMHO, it is not a good idea to disable the warning. I believe that it checks also other scenarios and can find real problems.
Also I think that compilers are getting more and more "clever". So keeping the "suspicious" code might be fighting with windmills.
Best Regards,
Petr
Hi Petr,
Quoted 62 lines · Petr Mladek
Quoted 52 lines · Geert Uytterhoeven
Quoted 51 lines · Petr Mladek
Both "model" and "strflags" are passed to "%s" even when one or both are NULL.
It is safe because
vsprintf()would detect the NULL pointer and print "(null)". But it is a kernel-specific feature and compiler warns about it:<warning>
In file included frominclude/linux/kernel.h:19,from arch/x86/include/asm/percpu.h:27, from arch/x86/include/asm/current.h:6, from include/linux/sched.h:12, from include/linux/blkdev.h:5, from drivers/scsi/scsi_devinfo.c:3:
drivers/scsi/scsi_devinfo.c: In function 'scsi_dev_info_list_add_str':Quoted 1 line
Quoted 1 line
include/linux/printk.h:434:44: warning: '%s' directive argument is null [-Wformat-overflow=]434 | #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__) | ^ include/linux/printk.h:430:3: note: in definition of macro 'printk_index_wrap' 430 | _p_func(_fmt, ##__VA_ARGS__); \ | ^~~~~~~ drivers/scsi/scsi_devinfo.c:551:4: note: in expansion of macro 'printk' 551 | printk(KERN_ERR "%s: bad dev info string '%s' '%s'" | ^~~~~~ drivers/scsi/scsi_devinfo.c:552:14: note: format string is defined here 552 | " '%s'\n", __func__, vendor, model, | ^~</warning>
Do not rely on the kernel specific behavior and print the message a safe way.
Reported-by kernel test robot <[email protected]>Signed-off-by Petr Mladek <[email protected]>---
Note: The patch is only compile tested.drivers/scsi/scsi_devinfo.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)drivers/scsi/scsi_devinfo.c +0
-2@@ -551,9 +551,9 @@ static int scsi_dev_info_list_add_str(char *dev_list)if (model) strflags =strsep (&next, next_check);if (!model || !strflags) { - printk(KERN_ERR "%s: bad dev info string '%s' '%s'" - " '%s'\n", __func__, vendor, model,Quoted 8 lines
drivers/scsi/scsi_devinfo.c static int scsi_dev_info_list_add_str(char *dev_list) · line 556
Quoted 4 lines
drivers/scsi/scsi_devinfo.c +3
-1- strflags); +pr_err ("%s: bad dev info string '%s' '%s' '%s'\n" , + __func__, vendor, model ? model :"" , + strflags ? strflags :"" );Do we really want to make this change?
The kernel'svsprintf()implementation has supported NULL pointers since forever, and lots of code relies on that behavior.
Quoted 5 lines
Yeah, it was safe even in the first git commit. And it was probably safe long before.
Well, I can't find easily how much code relies on this. I would personally do not rely on it when writing new code.
Lots of debug code relies on this when printing string pointers. It doesn't warn because the compiler cannot prove (yet) that such a pointer can be NULL...
Quoted 4 lines
Quoted 1 line
Perhaps this warning can be disabled instead?
IMHO, it is not a good idea to disable the warning. I believe that it checks also other scenarios and can find real problems.
True.
Quoted 2 lines
Also I think that compilers are getting more and more "clever". So keeping the "suspicious" code might be fighting with windmills.
Also true, unfortunately.
So one day the whole "if (!model || !strflags) { ... }" block might be optimized away, when the compiler decides that NULL pointers are Undefined Behavior, and thus this cannot happen.
Gr{oetje,eeting}s,
Geert
Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected] In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
Quoted 27 lines · Petr Mladek
Both "model" and "strflags" are passed to "%s" even when one or both are NULL.
It is safe because
vsprintf()would detect the NULL pointer and print "(null)". But it is a kernel-specific feature and compiler warns about it:<warning>
In file included frominclude/linux/kernel.h:19,from arch/x86/include/asm/percpu.h:27, from arch/x86/include/asm/current.h:6, from include/linux/sched.h:12, from include/linux/blkdev.h:5, from drivers/scsi/scsi_devinfo.c:3:
drivers/scsi/scsi_devinfo.c: In function 'scsi_dev_info_list_add_str':Quoted 1 line
Quoted 1 line
include/linux/printk.h:434:44: warning: '%s' directive argument is null [-Wformat-overflow=]434 | #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__) | ^ include/linux/printk.h:430:3: note: in definition of macro 'printk_index_wrap' 430 | _p_func(_fmt, ##__VA_ARGS__); \ | ^~~~~~~ drivers/scsi/scsi_devinfo.c:551:4: note: in expansion of macro 'printk' 551 | printk(KERN_ERR "%s: bad dev info string '%s' '%s'" | ^~~~~~ drivers/scsi/scsi_devinfo.c:552:14: note: format string is defined here 552 | " '%s'\n", __func__, vendor, model, | ^~
Quoted 3 lines
</warning>
Do not rely on the kernel specific behavior and print the message a safe way.
While I agree with the other thread that in reality this is ok, it's worth reducing the addition to LKP noise for now and worrying about that later.
Thanks!
Quoted 30 lines
Reported-by kernel test robot <[email protected]>Signed-off-by Petr Mladek <[email protected]>---
Note: The patch is only compile tested.
drivers/scsi/scsi_devinfo.c| 6 +++---1 file changed, 3 insertions(+), 3 deletions(-)drivers/scsi/scsi_devinfo.c +3
-3@@ -551,9 +551,9 @@ static int scsi_dev_info_list_add_str(char *dev_list)if (model) strflags =strsep (&next, next_check);if (!model || !strflags) { -printk (KERN_ERR "%s: bad dev info string '%s' '%s'" -" '%s'\n" , __func__, vendor, model, - strflags); +pr_err ("%s: bad dev info string '%s' '%s' '%s'\n" , + __func__, vendor, model ? model :"" , + strflags ? strflags :"" ); res = -EINVAL ; }else res = scsi_dev_info_list_add(0 /* compatible */, vendor,Signature · 1 line
2.43.0
Martin K. Petersen
AppliedQuoted 8 lines · Petr Mladek
Both "model" and "strflags" are passed to "%s" even when one or both are NULL.
It is safe because
vsprintf()would detect the NULL pointer and print "(null)". But it is a kernel-specific feature and compiler warns about it:[...]
Applied to 6.9/scsi-queue, thanks!
[1/1] scsi: core: Safe warning about bad dev info string
https://git.kernel.org/mkp/scsi/c/796cae1a79b1
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering