lib/vsprintf: Fixes size check
Subsystems (2)
v3 cover lib/vsprintf: Fixes size check
Hi,
Here is the 3rd version of patches to fix vsnprintf().
- Fix to limit the size of width and precision.
- Warn if the return size is over INT_MAX.
Previous version is here;
https://lore.kernel.org/all/177397887883.33018.9867883986177366222.stgit@devnote2/
In this version, check and update witdth and precision before assigning to spec data structure [1/2] and use a local variable to be better readability [2/2].
Recently we discussed snprintf() usage in bootconfig and found snprintf() design has a problem[1]. It returns the required or printed size in 'int' but the maxlen is passed by 'size_t'. The maxlen is already limited by INT_MAX, but if the expected print size becomes bigger than INT_MAX, it can return negative value. We also found width and precision size check does not work.
[1] https://lore.kernel.org/all/[email protected]/
Thank you,
---
Masami Hiramatsu (Google) (2):
lib/vsprintf: Fix to check field_width and precision lib/vsprintf: Limit the returning size to INT_MAX
lib/vsprintf.c | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-)
--
Masami Hiramatsu (Google) <[email protected]>
PATCH v3 1/2 lib/vsprintf: Fix to check field_width and precision
From: Masami Hiramatsu (Google) <[email protected]>
Check the field_width and presition correctly. Previously it depends on the bitfield conversion from int to check out-of-range error. However, commit 938df695e98d ("vsprintf: associate the format state with the format pointer") changed those fields to int.
We need to check the out-of-range correctly without bitfield conversion.
---
Changes in v3:
- Check and update width and precision before assigning to spec.
Changes in v2:
- Fix to use logical split.
--- lib/vsprintf.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)
lib/vsprintf.c +8 -6
@@ -2802,19 +2802,21 @@ struct fmt format_decode(struct fmt fmt, struct printf_spec *spec)static void set_field_width (struct printf_spec *spec,int width) { - spec->field_width = width; -if (WARN_ONCE (spec->field_width != width,"field width %d too large" , width)) { - spec->field_width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); +if (WARN_ONCE (width >FIELD_WIDTH_MAX || width < -FIELD_WIDTH_MAX , +"field width %d too large" , width)) { + width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); } + spec->field_width = width; }static void set_precision (struct printf_spec *spec,int prec) { - spec->precision = prec; -if (WARN_ONCE (spec->precision != prec,"precision %d too large" , prec)) { - spec->precision =clamp (prec,0 ,PRECISION_MAX ); +if (WARN_ONCE (prec >PRECISION_MAX || prec <0 , +"precision %d too large" , prec)) { + prec =clamp (prec,0 ,PRECISION_MAX ); } + spec->precision = prec; }/*
Andy Shevchenko
reviewerRe: [PATCH v3 1/2] lib/vsprintf: Fix to check field_width and precision
Quoted 6 lines · Masami Hiramatsu (Google)
Check the
field_widthand presition correctly. Previously it depends on the bitfield conversion from int to check out-of-range error. However, commit938df695e98d("vsprintf: associate the format state with the format pointer") changed those fields to int.
We need to check the out-of-range correctly without bitfield conversion.
...
Quoted 15 lines
static void
set_field_width(struct printf_spec *spec, int width){lib/vsprintf.c +4
-3- spec->field_width = width; -if (WARN_ONCE (spec->field_width != width,"field width %d too large" , width)) { - spec->field_width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); +if (WARN_ONCE (width >FIELD_WIDTH_MAX || width < -FIELD_WIDTH_MAX , +"field width %d too large" , width)) { + width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); } + spec->field_width = width; }static void set_precision (struct printf_spec *spec,int prec)
lib/vsprintf.c struct fmt format_decode(struct fmt fmt, struct printf_spec *spec) · line 2820
Quoted 10 lines
lib/vsprintf.c +4
-3{ - spec->precision = prec; -if (WARN_ONCE (spec->precision != prec,"precision %d too large" , prec)) { - spec->precision =clamp (prec,0 ,PRECISION_MAX ); +if (WARN_ONCE (prec >PRECISION_MAX || prec <0 , +"precision %d too large" , prec)) { + prec =clamp (prec,0 ,PRECISION_MAX ); } + spec->precision = prec; }
Looking at this, perhaps
#define clamp_WARN_*(...) ...
Potential users besides these two:
arch/powerpc/platforms/pseries/papr-sysparm.c-39- drivers/gpu/drm/drm_color_mgmt.c-142- drivers/gpu/drm/i915/display/intel_backlight.c-48- drivers/media/i2c/vgxy61.c-952-
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v3 1/2] lib/vsprintf: Fix to check field_width and precision
Quoted 39 lines · On Mon, 23 Mar 2026 15:27:31 +0200 Andy Shevchenko…
Quoted 6 lines · Masami Hiramatsu (Google)
Check the
field_widthand presition correctly. Previously it depends on the bitfield conversion from int to check out-of-range error. However, commit938df695e98d("vsprintf: associate the format state with the format pointer") changed those fields to int.
We need to check the out-of-range correctly without bitfield conversion....
Quoted 15 lines
static void
set_field_width(struct printf_spec *spec, int width){lib/vsprintf.c +4
-3- spec->field_width = width; -if (WARN_ONCE (spec->field_width != width,"field width %d too large" , width)) { - spec->field_width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); +if (WARN_ONCE (width >FIELD_WIDTH_MAX || width < -FIELD_WIDTH_MAX , +"field width %d too large" , width)) { + width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); } + spec->field_width = width; }static void set_precision (struct printf_spec *spec,int prec)lib/vsprintf.c struct fmt format_decode(struct fmt fmt, struct printf_spec *spec) · line 2820
Quoted 10 lines
lib/vsprintf.c +4
-3{ - spec->precision = prec; -if (WARN_ONCE (spec->precision != prec,"precision %d too large" , prec)) { - spec->precision =clamp (prec,0 ,PRECISION_MAX ); +if (WARN_ONCE (prec >PRECISION_MAX || prec <0 , +"precision %d too large" , prec)) { + prec =clamp (prec,0 ,PRECISION_MAX ); } + spec->precision = prec; }Looking at this, perhaps
Quoted 2 lines
#define clamp_WARN_*(...) ...
When I looked at this I did wonder whether the compiler would manage to only do the comparisons once.
Even if it doesn't the separate WARN is more readable.
Or maybe:
spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX); WARN_ON(spec->field_width != width, "field width %d too large", width);
I'd be more worried about the bloat and system panic for all the systems with panic_on_warn set (the default for many distos).
(And, like panic_on_oops, it doesn't give time for the error to get into the system logs.)
I've also just fixed nolibc's handling of %*.*s (which is in 'next' since I only wrote it recently), the above is actually broken. Negative 'precision' (all values) are fine, they just request the default.
So the patch needs a big fat NACK...
David
Quoted 8 lines
Potential users besides these two:
arch/powerpc/platforms/pseries/papr-sysparm.c-39-drivers/gpu/drm/drm_color_mgmt.c-142-drivers/gpu/drm/i915/display/intel_backlight.c-48-drivers/media/i2c/vgxy61.c-952-
Petr Mladek
maintainerRe: [PATCH v3 1/2] lib/vsprintf: Fix to check field_width and precision
Quoted 42 lines · David Laight
Quoted 39 lines · On Mon, 23 Mar 2026 15:27:31 +0200 Andy Shevchenko…
Quoted 6 lines · Masami Hiramatsu (Google)
Check the
field_widthand presition correctly. Previously it depends on the bitfield conversion from int to check out-of-range error. However, commit938df695e98d("vsprintf: associate the format state with the format pointer") changed those fields to int.
We need to check the out-of-range correctly without bitfield conversion....
Quoted 15 lines
static void
set_field_width(struct printf_spec *spec, int width){lib/vsprintf.c +4
-3- spec->field_width = width; -if (WARN_ONCE (spec->field_width != width,"field width %d too large" , width)) { - spec->field_width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); +if (WARN_ONCE (width >FIELD_WIDTH_MAX || width < -FIELD_WIDTH_MAX , +"field width %d too large" , width)) { + width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); } + spec->field_width = width; }static void set_precision (struct printf_spec *spec,int prec)lib/vsprintf.c struct fmt format_decode(struct fmt fmt, struct printf_spec *spec) · line 2820
Quoted 10 lines
lib/vsprintf.c +4
-3{ - spec->precision = prec; -if (WARN_ONCE (spec->precision != prec,"precision %d too large" , prec)) { - spec->precision =clamp (prec,0 ,PRECISION_MAX ); +if (WARN_ONCE (prec >PRECISION_MAX || prec <0 , +"precision %d too large" , prec)) { + prec =clamp (prec,0 ,PRECISION_MAX ); } + spec->precision = prec; }Looking at this, perhaps
Quoted 2 lines
Quoted 2 lines
#define clamp_WARN_*(...) ...
It would make sense. But I do not want to force Masami to do so.
Quoted 2 lines
When I looked at this I did wonder whether the compiler would manage to only do the comparisons once.
I believe that compilers would optimize this.
Quoted 5 lines
Even if it doesn't the separate WARN is more readable.
Or maybe:
spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX); WARN_ON(spec->field_width != width, "field width %d too large", width);
But this is fine as well.
Quoted 4 lines
I'd be more worried about the bloat and system panic for all the systems with
panic_on_warnset (the default for many distos).
(And, likepanic_on_oops, it doesn't give time for the error to get into the system logs.)
The WARN_ONCE() has been added by the commit 4d72ba014b4b09 ("lib/vsprintf.c:
warn about too large precisions and field widths"). The motivation was that it was used also by some %p? modifiers, e.g. for the bitfield size, where a clamped value might cause more confusion.
I do not want to open a bike shedding whether it is important enough or not. I agree that it likely is not a reason to panic but it was there 10 years so I could live with it.
That said, I always thought about introducing a macro which would print a message+backtrace but it would not panic, e.g. SOFT_WARN() or INFO() or MSG_AND_BT(level, msg, ...). But it seems to be out of scope of this patchset.
Quoted 3 lines
I've also just fixed nolibc's handling of %*.*s (which is in 'next' since I only wrote it recently), the above is actually broken. Negative 'precision' (all values) are fine, they just request the default.
Great catch! We should clamp the precision to (0, PRECISION_MAX). But we should warn only when it is outside of (-PRECISION_MAX, PRECISION_MAX).
Quoted 1 line
So the patch needs a big fat NACK...
What is an acceptable solution then, please?
Frankly, I would like to stay on earth. This started as a simple fix of a regression added a year ago. For me, any solution which restores the year old behavior is good enough.
We might need to find another volunteer to implement a better solution, e.g. the new non-panicing MSG_AND_BT() macro.
Alternatively, we could remove the WARN_ONCE() completely. It looks acceptable for me. But Rasmus would need to agree as well.
Best Regards,
Petr
Re: [PATCH v3 1/2] lib/vsprintf: Fix to check field_width and precision
Quoted 1 line · On Tue, 24 Mar 2026 17:45:49 +0100 Petr Mladek <[email protected]> wrote:
On Mon 2026-03-23 13:59:05, David Laight wrote:
...
Quoted 6 lines
Quoted 3 lines
I've also just fixed nolibc's handling of %*.*s (which is in 'next' since I only wrote it recently), the above is actually broken. Negative 'precision' (all values) are fine, they just request the default.
Great catch! We should clamp the precision to (0,
PRECISION_MAX). But we should warn only when it is outside of (-PRECISION_MAX,PRECISION_MAX).
No, you are going to clamp it needs to be to (-1, PRECISION_MAX); but max(precision, PRECISION_MAX) if fine now the value is being saved in an int.
And there is no need to warn about changing negative values - they all mean exactly the same thing.
There isn't actually any need to worry about large precision values for %s - they request truncation, precision only increases the output for numbers.
Quoted 4 lines
Quoted 2 lines
So the patch needs a big fat NACK...
What is an acceptable solution then, please?
You could do:
spec->precision = clamp(prec, -1, PRECISION_MAX); if (spec->precision < prec) WARN(...); David
Quoted 13 lines
Frankly, I would like to stay on earth. This started as a simple fix of a regression added a year ago. For me, any solution which restores the year old behavior is good enough.
We might need to find another volunteer to implement a better solution, e.g. the new non-panicing
MSG_AND_BT()macro.Alternatively, we could remove the
WARN_ONCE()completely. It looks acceptable for me. But Rasmus would need to agree as well.Best Regards,
Petr
Re: [PATCH v3 1/2] lib/vsprintf: Fix to check field_width and precision
Quoted 9 lines · On Tue, 24 Mar 2026 17:24:33 +0000 David Laight <[email protected]>…
Quoted 1 line · On Tue, 24 Mar 2026 17:45:49 +0100 Petr Mladek <[email protected]> wrote:
On Mon 2026-03-23 13:59:05, David Laight wrote:
...
Quoted 4 lines
Quoted 3 lines
I've also just fixed nolibc's handling of %*.*s (which is in 'next' since I only wrote it recently), the above is actually broken. Negative 'precision' (all values) are fine, they just request the default.
Quoted 8 lines
Quoted 2 lines
Great catch! We should clamp the precision to (0,
PRECISION_MAX). But we should warn only when it is outside of (-PRECISION_MAX,PRECISION_MAX).No, you are going to clamp it needs to be to (-1,
PRECISION_MAX); butmax(precision, PRECISION_MAX)if fine now the value is being saved in an int.
And there is no need to warn about changing negative values - they all mean exactly the same thing.
Ah, indeed.
"A negative precision is taken as if the precision were omitted."
Quoted 7 lines
There isn't actually any need to worry about large precision values for %s - they request truncation, precision only increases the output for numbers.
Quoted 3 lines
Quoted 2 lines
So the patch needs a big fat NACK...
Quoted 8 lines
Quoted 1 line
What is an acceptable solution then, please?
You could do:
spec->precision = clamp(prec, -1, PRECISION_MAX); if (spec->precision < prec) WARN(...); David
Ah, that looks good to me. Let me update it.
Thanks,
Quoted 15 lines
Quoted 14 lines
Frankly, I would like to stay on earth. This started as a simple fix of a regression added a year ago. For me, any solution which restores the year old behavior is good enough.
We might need to find another volunteer to implement a better solution, e.g. the new non-panicing
MSG_AND_BT()macro.Alternatively, we could remove the
WARN_ONCE()completely. It looks acceptable for me. But Rasmus would need to agree as well.Best Regards,
Petr
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>
Re: [PATCH v3 1/2] lib/vsprintf: Fix to check field_width and precision
Quoted 21 lines · On Wed, 25 Mar 2026 09:33:20 +0900 Masami Hiramatsu (Google)…
Quoted 9 lines · On Tue, 24 Mar 2026 17:24:33 +0000 David Laight <[email protected]>…
Quoted 1 line · On Tue, 24 Mar 2026 17:45:49 +0100 Petr Mladek <[email protected]> wrote:
On Mon 2026-03-23 13:59:05, David Laight wrote:
...
Quoted 4 lines
Quoted 3 lines
I've also just fixed nolibc's handling of %*.*s (which is in 'next' since I only wrote it recently), the above is actually broken. Negative 'precision' (all values) are fine, they just request the default.
Quoted 8 lines
Quoted 2 lines
Great catch! We should clamp the precision to (0,
PRECISION_MAX). But we should warn only when it is outside of (-PRECISION_MAX,PRECISION_MAX).No, you are going to clamp it needs to be to (-1,
PRECISION_MAX); butmax(precision, PRECISION_MAX)if fine now the value is being saved in an int.
And there is no need to warn about changing negative values - they all mean exactly the same thing.
Quoted 3 lines
Ah, indeed.
"A negative precision is taken as if the precision were omitted."
Hmm, and format_decode() does not accept -1 precision. We need another patch to fix it.
spec->precision = -1;
if (unlikely(*fmt.str == '.')) {
fmt.str++;
if (isdigit(*fmt.str)) { <---- isdigit() accepts '0'-'9', not '-'.
spec->precision = skip_atoi(&fmt.str); <--- this only returns positive value.
if (spec->precision < 0)
spec->precision = 0;
} else if (*fmt.str == '*') {Thanks,
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>
Re: [PATCH v3 1/2] lib/vsprintf: Fix to check field_width and precision
Quoted 31 lines · On Wed, 25 Mar 2026 10:17:04 +0900 Masami Hiramatsu (Google)…
Quoted 21 lines · On Wed, 25 Mar 2026 09:33:20 +0900 Masami Hiramatsu (Google)…
Quoted 9 lines · On Tue, 24 Mar 2026 17:24:33 +0000 David Laight <[email protected]>…
Quoted 1 line · On Tue, 24 Mar 2026 17:45:49 +0100 Petr Mladek <[email protected]> wrote:
On Mon 2026-03-23 13:59:05, David Laight wrote:
...
Quoted 4 lines
Quoted 3 lines
I've also just fixed nolibc's handling of %*.*s (which is in 'next' since I only wrote it recently), the above is actually broken. Negative 'precision' (all values) are fine, they just request the default.
Quoted 8 lines
Quoted 2 lines
Great catch! We should clamp the precision to (0,
PRECISION_MAX). But we should warn only when it is outside of (-PRECISION_MAX,PRECISION_MAX).No, you are going to clamp it needs to be to (-1,
PRECISION_MAX); butmax(precision, PRECISION_MAX)if fine now the value is being saved in an int.
And there is no need to warn about changing negative values - they all mean exactly the same thing.Quoted 3 lines
Ah, indeed.
"A negative precision is taken as if the precision were omitted."
Hmm, and
format_decode()does not accept -1 precision. We need another patch to fix it.
Quoted 7 lines
spec->precision = -1;
if (unlikely(*fmt.str == '.')) {
fmt.str++;
if (isdigit(*fmt.str)) { <---- isdigit() accepts '0'-'9', not '-'.
spec->precision = skip_atoi(&fmt.str); <--- this only returns positive value.
if (spec->precision < 0)
spec->precision = 0;That is fine, you aren't allowed a negative value there - just for "%.*d".
David
Quoted 4 lines
} else if (*fmt.str == '*') {Thanks,
Re: [PATCH v3 1/2] lib/vsprintf: Fix to check field_width and precision
In reply to Andy ShevchenkoQuoted 42 lines · On Mon, 23 Mar 2026 15:27:31 +0200 Andy Shevchenko…
Quoted 6 lines · Masami Hiramatsu (Google)
Check the
field_widthand presition correctly. Previously it depends on the bitfield conversion from int to check out-of-range error. However, commit938df695e98d("vsprintf: associate the format state with the format pointer") changed those fields to int.
We need to check the out-of-range correctly without bitfield conversion....
Quoted 15 lines
static void
set_field_width(struct printf_spec *spec, int width){lib/vsprintf.c +4
-3- spec->field_width = width; -if (WARN_ONCE (spec->field_width != width,"field width %d too large" , width)) { - spec->field_width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); +if (WARN_ONCE (width >FIELD_WIDTH_MAX || width < -FIELD_WIDTH_MAX , +"field width %d too large" , width)) { + width =clamp (width, -FIELD_WIDTH_MAX ,FIELD_WIDTH_MAX ); } + spec->field_width = width; }static void set_precision (struct printf_spec *spec,int prec)lib/vsprintf.c struct fmt format_decode(struct fmt fmt, struct printf_spec *spec) · line 2820
Quoted 10 lines
lib/vsprintf.c +4
-3{ - spec->precision = prec; -if (WARN_ONCE (spec->precision != prec,"precision %d too large" , prec)) { - spec->precision =clamp (prec,0 ,PRECISION_MAX ); +if (WARN_ONCE (prec >PRECISION_MAX || prec <0 , +"precision %d too large" , prec)) { + prec =clamp (prec,0 ,PRECISION_MAX ); } + spec->precision = prec; }Looking at this, perhaps
#define clamp_WARN_*(...) ...
Quoted 6 lines
Potential users besides these two:
arch/powerpc/platforms/pseries/papr-sysparm.c-39-drivers/gpu/drm/drm_color_mgmt.c-142-drivers/gpu/drm/i915/display/intel_backlight.c-48-drivers/media/i2c/vgxy61.c-952-
Hmm, that will be an improvement, not a fix. I would like to keep this as small as possible so that we can cleanly apply it to stable trees, and introduce such new macro to for-next.
Thank you,
Quoted 6 lines
Signature · 3 lines
-- With Best Regards, Andy Shevchenko
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>
PATCH v3 2/2 lib/vsprintf: Limit the returning size to INT_MAX
In reply to Masami Hiramatsu (Google)From: Masami Hiramatsu (Google) <[email protected]>
The return value of vsnprintf() can overflow INT_MAX and return a minus value. In the @size is checked input overflow, but it does not check the output, which is expected required size.
This should never happen but it should be checked and limited.
---
Changes in v3:
- Use local variable for better readability.
--- lib/vsprintf.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)
lib/vsprintf.c +6 -1
@@ -2866,6 +2866,7 @@ static unsigned long long convert_num_spec(unsigned int val, int size, struct print vsnprintf (char *buf,size_t size,const char *fmt_str,va_list args) {char *str, *end; +size_t ret_size;struct printf_spec spec = {0 };struct fmt fmt = { .str = fmt_str,
@@ -2985,8 +2986,12 @@ int vsnprintf(char *buf, size_t size, const char *fmt_str, va_list args) }/* the trailing null byte doesn't count towards the total */ -return str-buf; + ret_size = str - buf; +/* Make sure the return value is within the positive integer range */ +if (WARN_ON_ONCE (ret_size >INT_MAX )) + ret_size =INT_MAX ; +return ret_size; }EXPORT_SYMBOL (vsnprintf);
Re: [PATCH v3 2/2] lib/vsprintf: Limit the returning size to INT_MAX
Quoted 9 lines · Masami Hiramatsu (Google)
From: Masami Hiramatsu (Google) <[email protected]>
The return value of
vsnprintf()can overflowINT_MAXand return a minus value. In the @size is checked input overflow, but it does not check the output, which is expected required size.This should never happen but it should be checked and limited.
Signed-off-by Masami Hiramatsu (Google) <[email protected]>
It looks good to me. And the WARN_ON_ONCE() looks acceptable to me. It is already used for checking the input size parameter in vsnprintf(), and bstr_printf().
Best Regards,
Petr