py/mpprint: Fail an assertion with unsupported format specifiers.

dxxb · dpgeorge · commit f98bb2ddcbfe · 2016-09-01T18:09:44.000+10:00
Arguments of an unknown type cannot be skipped and continuing to parse a
format string after encountering an unknown format specifier leads to
undefined behaviour.  This patch helps to find use of unsupported formats.
diff --git a/py/mpprint.c b/py/mpprint.c
@@ -537,10 +537,12 @@ int mp_vprintf(const mp_print_t *print, const char *fmt, va_list args) {
                     chrs += mp_print_int(print, arg_value, *fmt == 'd', 10, 'a', flags, fill, width);
                     break;
                 }
-                // fall through to default case to print unknown format char
+                assert(!"unsupported fmt char");
             }
             #endif
             default:
+                // if it's not %% then it's an unsupported format character
+                assert(*fmt == '%' || !"unsupported fmt char");
                 print->print_strn(print->data, fmt, 1);
                 chrs += 1;
                 break;
diff --git a/tests/unix/extra_coverage.py.exp b/tests/unix/extra_coverage.py.exp
@@ -7,7 +7,6 @@ ab abc
 
 false true
 (null)
-t
 -2147483648
 2147483648
 80000000
diff --git a/unix/coverage.c b/unix/coverage.c
@@ -12,7 +12,6 @@ STATIC mp_obj_t extra_coverage(void) {
     // mp_printf (used by ports that don't have a native printf)
     {
         mp_printf(&mp_plat_print, "# mp_printf\n");
-        mp_printf(&mp_plat_print, "%"); // nothing after percent
         mp_printf(&mp_plat_print, "%d %+d % d\n", -123, 123, 123); // sign
         mp_printf(&mp_plat_print, "%05d\n", -123); // negative number with zero padding
         mp_printf(&mp_plat_print, "%ld\n", 123); // long
@@ -21,7 +20,6 @@ STATIC mp_obj_t extra_coverage(void) {
         mp_printf(&mp_plat_print, "%.*s\n", -1, "abc"); // negative string precision
         mp_printf(&mp_plat_print, "%b %b\n", 0, 1); // bools
         mp_printf(&mp_plat_print, "%s\n", NULL); // null string
-        mp_printf(&mp_plat_print, "%t\n"); // non-format char
         mp_printf(&mp_plat_print, "%d\n", 0x80000000); // should print signed
         mp_printf(&mp_plat_print, "%u\n", 0x80000000); // should print unsigned
         mp_printf(&mp_plat_print, "%x\n", 0x80000000); // should print unsigned

Original file line number	Diff line number	Diff line change
`@@ -537,10 +537,12 @@ int mp_vprintf(const mp_print_t print, const char fmt, va_list args) {`
`537`	`537`	`chrs += mp_print_int(print, arg_value, *fmt == 'd', 10, 'a', flags, fill, width);`
`538`	`538`	`break;`
`539`	`539`	`}`
`540`		`- // fall through to default case to print unknown format char`
	`540`	`+ assert(!"unsupported fmt char");`
`541`	`541`	`}`
`542`	`542`	`#endif`
`543`	`543`	`default:`
	`544`	`+ // if it's not %% then it's an unsupported format character`
	`545`	`+ assert(*fmt == '%' \|\| !"unsupported fmt char");`
`544`	`546`	`print->print_strn(print->data, fmt, 1);`
`545`	`547`	`chrs += 1;`
`546`	`548`	`break;`