1 // SPDX-License-Identifier: GPL-2.0-only
3 * Test cases for printf facility.
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
8 #include <linux/init.h>
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/printk.h>
12 #include <linux/random.h>
13 #include <linux/rtc.h>
14 #include <linux/slab.h>
15 #include <linux/string.h>
17 #include <linux/bitmap.h>
18 #include <linux/dcache.h>
19 #include <linux/socket.h>
22 #include <linux/gfp.h>
25 #include <linux/property.h>
27 #include "../tools/testing/selftests/kselftest_module.h"
33 #define NOWARN(option, comment, block) \
35 __diag_ignore_all(#option, comment); \
39 KSTM_MODULE_GLOBALS();
41 static char *test_buffer __initdata
;
42 static char *alloced_buffer __initdata
;
44 extern bool no_hash_pointers
;
46 static int __printf(4, 0) __init
47 do_test(int bufsize
, const char *expect
, int elen
,
48 const char *fmt
, va_list ap
)
55 memset(alloced_buffer
, FILL_CHAR
, BUF_SIZE
+ 2*PAD_SIZE
);
57 ret
= vsnprintf(test_buffer
, bufsize
, fmt
, aq
);
61 pr_warn("vsnprintf(buf, %d, \"%s\", ...) returned %d, expected %d\n",
62 bufsize
, fmt
, ret
, elen
);
66 if (memchr_inv(alloced_buffer
, FILL_CHAR
, PAD_SIZE
)) {
67 pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote before buffer\n", bufsize
, fmt
);
72 if (memchr_inv(test_buffer
, FILL_CHAR
, BUF_SIZE
+ PAD_SIZE
)) {
73 pr_warn("vsnprintf(buf, 0, \"%s\", ...) wrote to buffer\n",
80 written
= min(bufsize
-1, elen
);
81 if (test_buffer
[written
]) {
82 pr_warn("vsnprintf(buf, %d, \"%s\", ...) did not nul-terminate buffer\n",
87 if (memchr_inv(test_buffer
+ written
+ 1, FILL_CHAR
, bufsize
- (written
+ 1))) {
88 pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote beyond the nul-terminator\n",
93 if (memchr_inv(test_buffer
+ bufsize
, FILL_CHAR
, BUF_SIZE
+ PAD_SIZE
- bufsize
)) {
94 pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote beyond buffer\n", bufsize
, fmt
);
98 if (memcmp(test_buffer
, expect
, written
)) {
99 pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote '%s', expected '%.*s'\n",
100 bufsize
, fmt
, test_buffer
, written
, expect
);
106 static void __printf(3, 4) __init
107 __test(const char *expect
, int elen
, const char *fmt
, ...)
113 if (elen
>= BUF_SIZE
) {
114 pr_err("error in test suite: expected output length %d too long. Format was '%s'.\n",
123 * Every fmt+args is subjected to four tests: Three where we
124 * tell vsnprintf varying buffer sizes (plenty, not quite
125 * enough and 0), and then we also test that kvasprintf would
126 * be able to print it as expected.
128 failed_tests
+= do_test(BUF_SIZE
, expect
, elen
, fmt
, ap
);
129 rand
= 1 + prandom_u32_max(elen
+1);
130 /* Since elen < BUF_SIZE, we have 1 <= rand <= BUF_SIZE. */
131 failed_tests
+= do_test(rand
, expect
, elen
, fmt
, ap
);
132 failed_tests
+= do_test(0, expect
, elen
, fmt
, ap
);
134 p
= kvasprintf(GFP_KERNEL
, fmt
, ap
);
137 if (memcmp(p
, expect
, elen
+1)) {
138 pr_warn("kvasprintf(..., \"%s\", ...) returned '%s', expected '%s'\n",
147 #define test(expect, fmt, ...) \
148 __test(expect, strlen(expect), fmt, ##__VA_ARGS__)
153 /* Work around annoying "warning: zero-length gnu_printf format string". */
157 test("100%", "100%%");
158 test("xxx%yyy", "xxx%cyyy", '%');
159 __test("xxx\0yyy", 7, "xxx%cyyy", '\0');
165 test("0x1234abcd ", "%#-12x", 0x1234abcd);
166 test(" 0x1234abcd", "%#12x", 0x1234abcd);
167 test("0|001| 12|+123| 1234|-123|-1234", "%d|%03d|%3d|%+d|% d|%+d|% d", 0, 1, 12, 123, 1234, -123, -1234);
168 NOWARN(-Wformat
, "Intentionally test narrowing conversion specifiers.", {
169 test("0|1|1|128|255", "%hhu|%hhu|%hhu|%hhu|%hhu", 0, 1, 257, 128, -1);
170 test("0|1|1|-128|-1", "%hhd|%hhd|%hhd|%hhd|%hhd", 0, 1, 257, 128, -1);
171 test("2015122420151225", "%ho%ho%#ho", 1037, 5282, -11627);
174 * POSIX/C99: »The result of converting zero with an explicit
175 * precision of zero shall be no characters.« Hence the output
176 * from the below test should really be "00|0||| ". However,
177 * the kernel's printf also produces a single 0 in that
178 * case. This test case simply documents the current
181 test("00|0|0|0|0", "%.2d|%.1d|%.0d|%.*d|%1.0d", 0, 0, 0, 0, 0, 0);
182 #ifndef __CHAR_UNSIGNED__
185 * Passing a 'char' to a %02x specifier doesn't do
186 * what was presumably the intention when char is
187 * signed and the value is negative. One must either &
188 * with 0xff or cast to u8.
191 test("0xfffffff0|0xf0|0xf0", "%#02x|%#02x|%#02x", val
, val
& 0xff, (u8
)val
);
199 test("", "%s%.0s", "", "123");
200 test("ABCD|abc|123", "%s|%.3s|%.*s", "ABCD", "abcdef", 3, "123456");
201 test("1 | 2|3 | 4|5 ", "%-3s|%3s|%-*s|%*s|%*s", "1", "2", 3, "3", 3, "4", -3, "5");
202 test("1234 ", "%-10.4s", "123456");
203 test(" 1234", "%10.4s", "123456");
205 * POSIX and C99 say that a negative precision (which is only
206 * possible to pass via a * argument) should be treated as if
207 * the precision wasn't present, and that if the precision is
208 * omitted (as in %.s), the precision should be taken to be
209 * 0. However, the kernel's printf behave exactly opposite,
210 * treating a negative precision as 0 and treating an omitted
211 * precision specifier as if no precision was given.
213 * These test cases document the current behaviour; should
214 * anyone ever feel the need to follow the standards more
215 * closely, this can be revisited.
217 test(" ", "%4.*s", -5, "123456");
218 test("123456", "%.s", "123456");
219 test("a||", "%.s|%.0s|%.*s", "a", "b", 0, "c");
220 test("a | | ", "%-3.s|%-3.0s|%-3.*s", "a", "b", 0, "c");
223 #define PLAIN_BUF_SIZE 64 /* leave some space so we don't oops */
225 #if BITS_PER_LONG == 64
228 #define PTR ((void *)0xffff0123456789abUL)
229 #define PTR_STR "ffff0123456789ab"
230 #define PTR_VAL_NO_CRNG "(____ptrval____)"
231 #define ZEROS "00000000" /* hex 32 zero bits */
232 #define ONES "ffffffff" /* hex 32 one bits */
237 char buf
[PLAIN_BUF_SIZE
];
240 nchars
= snprintf(buf
, PLAIN_BUF_SIZE
, "%p", PTR
);
242 if (nchars
!= PTR_WIDTH
)
245 if (strncmp(buf
, PTR_VAL_NO_CRNG
, PTR_WIDTH
) == 0) {
246 pr_warn("crng possibly not yet initialized. plain 'p' buffer contains \"%s\"",
251 if (strncmp(buf
, ZEROS
, strlen(ZEROS
)) != 0)
260 #define PTR ((void *)0x456789ab)
261 #define PTR_STR "456789ab"
262 #define PTR_VAL_NO_CRNG "(ptrval)"
269 /* Format is implicitly tested for 32 bit machines by plain_hash() */
273 #endif /* BITS_PER_LONG == 64 */
276 plain_hash_to_buffer(const void *p
, char *buf
, size_t len
)
280 nchars
= snprintf(buf
, len
, "%p", p
);
282 if (nchars
!= PTR_WIDTH
)
285 if (strncmp(buf
, PTR_VAL_NO_CRNG
, PTR_WIDTH
) == 0) {
286 pr_warn("crng possibly not yet initialized. plain 'p' buffer contains \"%s\"",
297 char buf
[PLAIN_BUF_SIZE
];
300 ret
= plain_hash_to_buffer(PTR
, buf
, PLAIN_BUF_SIZE
);
304 if (strncmp(buf
, PTR_STR
, PTR_WIDTH
) == 0)
311 * We can't use test() to test %p because we don't know what output to expect
312 * after an address is hashed.
319 if (no_hash_pointers
) {
320 pr_warn("skipping plain 'p' tests");
327 pr_warn("plain 'p' does not appear to be hashed\n");
332 err
= plain_format();
334 pr_warn("hashing plain 'p' has unexpected format\n");
340 test_hashed(const char *fmt
, const void *p
)
342 char buf
[PLAIN_BUF_SIZE
];
346 * No need to increase failed test counter since this is assumed
347 * to be called after plain().
349 ret
= plain_hash_to_buffer(p
, buf
, PLAIN_BUF_SIZE
);
357 * NULL pointers aren't hashed.
362 test(ZEROS
"00000000", "%p", NULL
);
363 test(ZEROS
"00000000", "%px", NULL
);
364 test("(null)", "%pE", NULL
);
368 * Error pointers aren't hashed.
373 test(ONES
"fffffff5", "%p", ERR_PTR(-11));
374 test(ONES
"fffffff5", "%px", ERR_PTR(-11));
375 test("(efault)", "%pE", ERR_PTR(-11));
378 #define PTR_INVALID ((void *)0x000000ab)
381 invalid_pointer(void)
383 test_hashed("%p", PTR_INVALID
);
384 test(ZEROS
"000000ab", "%px", PTR_INVALID
);
385 test("(efault)", "%pE", PTR_INVALID
);
396 /* We can't test this without access to kptr_restrict. */
400 struct_resource(void)
417 const char buf
[3] = {0xc0, 0xff, 0xee};
419 test("c0 ff ee|c0:ff:ee|c0-ff-ee|c0ffee",
420 "%3ph|%3phC|%3phD|%3phN", buf
, buf
, buf
, buf
);
421 test("c0 ff ee|c0:ff:ee|c0-ff-ee|c0ffee",
422 "%*ph|%*phC|%*phD|%*phN", 3, buf
, 3, buf
, 3, buf
, 3, buf
);
428 const u8 addr
[6] = {0x2d, 0x48, 0xd6, 0xfc, 0x7a, 0x05};
430 test("2d:48:d6:fc:7a:05", "%pM", addr
);
431 test("05:7a:fc:d6:48:2d", "%pMR", addr
);
432 test("2d-48-d6-fc-7a-05", "%pMF", addr
);
433 test("2d48d6fc7a05", "%pm", addr
);
434 test("057afcd6482d", "%pmR", addr
);
440 struct sockaddr_in sa
;
442 sa
.sin_family
= AF_INET
;
443 sa
.sin_port
= cpu_to_be16(12345);
444 sa
.sin_addr
.s_addr
= cpu_to_be32(0x7f000001);
446 test("127.000.000.001|127.0.0.1", "%pi4|%pI4", &sa
.sin_addr
, &sa
.sin_addr
);
447 test("127.000.000.001|127.0.0.1", "%piS|%pIS", &sa
, &sa
);
448 sa
.sin_addr
.s_addr
= cpu_to_be32(0x01020304);
449 test("001.002.003.004:12345|1.2.3.4:12345", "%piSp|%pISp", &sa
, &sa
);
467 const char uuid
[16] = {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7,
468 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf};
470 test("00010203-0405-0607-0809-0a0b0c0d0e0f", "%pUb", uuid
);
471 test("00010203-0405-0607-0809-0A0B0C0D0E0F", "%pUB", uuid
);
472 test("03020100-0504-0706-0809-0a0b0c0d0e0f", "%pUl", uuid
);
473 test("03020100-0504-0706-0809-0A0B0C0D0E0F", "%pUL", uuid
);
476 static struct dentry test_dentry
[4] __initdata
= {
477 { .d_parent
= &test_dentry
[0],
478 .d_name
= QSTR_INIT(test_dentry
[0].d_iname
, 3),
480 { .d_parent
= &test_dentry
[0],
481 .d_name
= QSTR_INIT(test_dentry
[1].d_iname
, 5),
482 .d_iname
= "bravo" },
483 { .d_parent
= &test_dentry
[1],
484 .d_name
= QSTR_INIT(test_dentry
[2].d_iname
, 4),
486 { .d_parent
= &test_dentry
[2],
487 .d_name
= QSTR_INIT(test_dentry
[3].d_iname
, 5),
488 .d_iname
= "romeo" },
494 test("foo", "%pd", &test_dentry
[0]);
495 test("foo", "%pd2", &test_dentry
[0]);
497 test("(null)", "%pd", NULL
);
498 test("(efault)", "%pd", PTR_INVALID
);
499 test("(null)", "%pD", NULL
);
500 test("(efault)", "%pD", PTR_INVALID
);
502 test("romeo", "%pd", &test_dentry
[3]);
503 test("alfa/romeo", "%pd2", &test_dentry
[3]);
504 test("bravo/alfa/romeo", "%pd3", &test_dentry
[3]);
505 test("/bravo/alfa/romeo", "%pd4", &test_dentry
[3]);
506 test("/bravo/alfa", "%pd4", &test_dentry
[2]);
508 test("bravo/alfa |bravo/alfa ", "%-12pd2|%*pd2", &test_dentry
[2], -12, &test_dentry
[2]);
509 test(" bravo/alfa| bravo/alfa", "%12pd2|%*pd2", &test_dentry
[2], 12, &test_dentry
[2]);
513 struct_va_format(void)
521 const struct rtc_time tm
= {
529 /* 2019-01-04T15:32:23 */
530 time64_t t
= 1546615943;
532 test("(%pt?)", "%pt", &tm
);
533 test("2018-11-26T05:35:43", "%ptR", &tm
);
534 test("0118-10-26T05:35:43", "%ptRr", &tm
);
535 test("05:35:43|2018-11-26", "%ptRt|%ptRd", &tm
, &tm
);
536 test("05:35:43|0118-10-26", "%ptRtr|%ptRdr", &tm
, &tm
);
537 test("05:35:43|2018-11-26", "%ptRttr|%ptRdtr", &tm
, &tm
);
538 test("05:35:43 tr|2018-11-26 tr", "%ptRt tr|%ptRd tr", &tm
, &tm
);
540 test("2019-01-04T15:32:23", "%ptT", &t
);
541 test("0119-00-04T15:32:23", "%ptTr", &t
);
542 test("15:32:23|2019-01-04", "%ptTt|%ptTd", &t
, &t
);
543 test("15:32:23|0119-00-04", "%ptTtr|%ptTdr", &t
, &t
);
545 test("2019-01-04 15:32:23", "%ptTs", &t
);
546 test("0119-00-04 15:32:23", "%ptTsr", &t
);
547 test("15:32:23|2019-01-04", "%ptTts|%ptTds", &t
, &t
);
548 test("15:32:23|0119-00-04", "%ptTtrs|%ptTdrs", &t
, &t
);
559 const int nbits
= 1 << 16;
560 unsigned long *bits
= bitmap_zalloc(nbits
, GFP_KERNEL
);
564 bitmap_set(bits
, 1, 20);
565 bitmap_set(bits
, 60000, 15);
566 test("1-20,60000-60014", "%*pbl", nbits
, bits
);
573 DECLARE_BITMAP(bits
, 20);
574 const int primes
[] = {2,3,5,7,11,13,17,19};
577 bitmap_zero(bits
, 20);
578 test("00000|00000", "%20pb|%*pb", bits
, 20, bits
);
579 test("|", "%20pbl|%*pbl", bits
, 20, bits
);
581 for (i
= 0; i
< ARRAY_SIZE(primes
); ++i
)
582 set_bit(primes
[i
], bits
);
583 test("a28ac|a28ac", "%20pb|%*pb", bits
, 20, bits
);
584 test("2-3,5,7,11,13,17,19|2-3,5,7,11,13,17,19", "%20pbl|%*pbl", bits
, 20, bits
);
586 bitmap_fill(bits
, 20);
587 test("fffff|fffff", "%20pb|%*pb", bits
, 20, bits
);
588 test("0-19|0-19", "%20pbl|%*pbl", bits
, 20, bits
);
594 netdev_features(void)
598 struct page_flags_test
{
606 static const struct page_flags_test pft
[] = {
607 {SECTIONS_WIDTH
, SECTIONS_PGSHIFT
, SECTIONS_MASK
,
609 {NODES_WIDTH
, NODES_PGSHIFT
, NODES_MASK
,
611 {ZONES_WIDTH
, ZONES_PGSHIFT
, ZONES_MASK
,
613 {LAST_CPUPID_WIDTH
, LAST_CPUPID_PGSHIFT
, LAST_CPUPID_MASK
,
614 "%#x", "lastcpupid"},
615 {KASAN_TAG_WIDTH
, KASAN_TAG_PGSHIFT
, KASAN_TAG_MASK
,
620 page_flags_test(int section
, int node
, int zone
, int last_cpupid
,
621 int kasan_tag
, unsigned long flags
, const char *name
,
624 unsigned long values
[] = {section
, node
, zone
, last_cpupid
, kasan_tag
};
629 for (i
= 0; i
< ARRAY_SIZE(values
); i
++)
630 flags
|= (values
[i
] & pft
[i
].mask
) << pft
[i
].shift
;
632 size
= scnprintf(cmp_buf
, BUF_SIZE
, "%#lx(", flags
);
633 if (flags
& PAGEFLAGS_MASK
) {
634 size
+= scnprintf(cmp_buf
+ size
, BUF_SIZE
- size
, "%s", name
);
638 for (i
= 0; i
< ARRAY_SIZE(pft
); i
++) {
643 size
+= scnprintf(cmp_buf
+ size
, BUF_SIZE
- size
, "|");
645 size
+= scnprintf(cmp_buf
+ size
, BUF_SIZE
- size
, "%s=",
647 size
+= scnprintf(cmp_buf
+ size
, BUF_SIZE
- size
, pft
[i
].fmt
,
648 values
[i
] & pft
[i
].mask
);
652 snprintf(cmp_buf
+ size
, BUF_SIZE
- size
, ")");
654 test(cmp_buf
, "%pGp", &flags
);
664 cmp_buffer
= kmalloc(BUF_SIZE
, GFP_KERNEL
);
669 page_flags_test(0, 0, 0, 0, 0, flags
, "", cmp_buffer
);
671 flags
= 1UL << NR_PAGEFLAGS
;
672 page_flags_test(0, 0, 0, 0, 0, flags
, "", cmp_buffer
);
674 flags
|= 1UL << PG_uptodate
| 1UL << PG_dirty
| 1UL << PG_lru
675 | 1UL << PG_active
| 1UL << PG_swapbacked
;
676 page_flags_test(1, 1, 1, 0x1fffff, 1, flags
,
677 "uptodate|dirty|lru|active|swapbacked",
680 flags
= VM_READ
| VM_EXEC
| VM_MAYREAD
| VM_MAYWRITE
| VM_MAYEXEC
;
681 test("read|exec|mayread|maywrite|mayexec", "%pGv", &flags
);
684 test("GFP_TRANSHUGE", "%pGg", &gfp
);
686 gfp
= GFP_ATOMIC
|__GFP_DMA
;
687 test("GFP_ATOMIC|GFP_DMA", "%pGg", &gfp
);
690 test("__GFP_ATOMIC", "%pGg", &gfp
);
692 /* Any flags not translated by the table should remain numeric */
693 gfp
= ~__GFP_BITS_MASK
;
694 snprintf(cmp_buffer
, BUF_SIZE
, "%#lx", (unsigned long) gfp
);
695 test(cmp_buffer
, "%pGg", &gfp
);
697 snprintf(cmp_buffer
, BUF_SIZE
, "__GFP_ATOMIC|%#lx",
698 (unsigned long) gfp
);
700 test(cmp_buffer
, "%pGg", &gfp
);
705 static void __init
fwnode_pointer(void)
707 const struct software_node softnodes
[] = {
708 { .name
= "first", },
709 { .name
= "second", .parent
= &softnodes
[0], },
710 { .name
= "third", .parent
= &softnodes
[1], },
711 { NULL
/* Guardian */ }
713 const char * const full_name
= "first/second/third";
714 const char * const full_name_second
= "first/second";
715 const char * const second_name
= "second";
716 const char * const third_name
= "third";
719 rval
= software_node_register_nodes(softnodes
);
721 pr_warn("cannot register softnodes; rval %d\n", rval
);
725 test(full_name_second
, "%pfw", software_node_fwnode(&softnodes
[1]));
726 test(full_name
, "%pfw", software_node_fwnode(&softnodes
[2]));
727 test(full_name
, "%pfwf", software_node_fwnode(&softnodes
[2]));
728 test(second_name
, "%pfwP", software_node_fwnode(&softnodes
[1]));
729 test(third_name
, "%pfwP", software_node_fwnode(&softnodes
[2]));
731 software_node_unregister_nodes(softnodes
);
734 static void __init
fourcc_pointer(void)
740 { 0x3231564e, "NV12 little-endian (0x3231564e)", },
741 { 0xb231564e, "NV12 big-endian (0xb231564e)", },
742 { 0x10111213, ".... little-endian (0x10111213)", },
743 { 0x20303159, "Y10 little-endian (0x20303159)", },
747 for (i
= 0; i
< ARRAY_SIZE(try); i
++)
748 test(try[i
].str
, "%p4cc", &try[i
].code
);
754 test("-1234", "%pe", ERR_PTR(-1234));
756 /* Check that %pe with a non-ERR_PTR gets treated as ordinary %p. */
757 BUILD_BUG_ON(IS_ERR(PTR
));
758 test_hashed("%pe", PTR
);
760 #ifdef CONFIG_SYMBOLIC_ERRNAME
761 test("(-ENOTSOCK)", "(%pe)", ERR_PTR(-ENOTSOCK
));
762 test("(-EAGAIN)", "(%pe)", ERR_PTR(-EAGAIN
));
763 BUILD_BUG_ON(EAGAIN
!= EWOULDBLOCK
);
764 test("(-EAGAIN)", "(%pe)", ERR_PTR(-EWOULDBLOCK
));
765 test("[-EIO ]", "[%-8pe]", ERR_PTR(-EIO
));
766 test("[ -EIO]", "[%8pe]", ERR_PTR(-EIO
));
767 test("-EPROBE_DEFER", "%pe", ERR_PTR(-EPROBE_DEFER
));
799 static void __init
selftest(void)
801 alloced_buffer
= kmalloc(BUF_SIZE
+ 2*PAD_SIZE
, GFP_KERNEL
);
804 test_buffer
= alloced_buffer
+ PAD_SIZE
;
811 kfree(alloced_buffer
);
814 KSTM_MODULE_LOADERS(test_printf
);
815 MODULE_AUTHOR("Rasmus Villemoes <linux@rasmusvillemoes.dk>");
816 MODULE_LICENSE("GPL");