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 = get_random_u32_inclusive(1, 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);
187 test("", "%s%.0s", "", "123");
188 test("ABCD|abc|123", "%s|%.3s|%.*s", "ABCD", "abcdef", 3, "123456");
189 test("1 | 2|3 | 4|5 ", "%-3s|%3s|%-*s|%*s|%*s", "1", "2", 3, "3", 3, "4", -3, "5");
190 test("1234 ", "%-10.4s", "123456");
191 test(" 1234", "%10.4s", "123456");
193 * POSIX and C99 say that a negative precision (which is only
194 * possible to pass via a * argument) should be treated as if
195 * the precision wasn't present, and that if the precision is
196 * omitted (as in %.s), the precision should be taken to be
197 * 0. However, the kernel's printf behave exactly opposite,
198 * treating a negative precision as 0 and treating an omitted
199 * precision specifier as if no precision was given.
201 * These test cases document the current behaviour; should
202 * anyone ever feel the need to follow the standards more
203 * closely, this can be revisited.
205 test(" ", "%4.*s", -5, "123456");
206 test("123456", "%.s", "123456");
207 test("a||", "%.s|%.0s|%.*s", "a", "b", 0, "c");
208 test("a | | ", "%-3.s|%-3.0s|%-3.*s", "a", "b", 0, "c");
211 #define PLAIN_BUF_SIZE 64 /* leave some space so we don't oops */
213 #if BITS_PER_LONG == 64
216 #define PTR ((void *)0xffff0123456789abUL)
217 #define PTR_STR "ffff0123456789ab"
218 #define PTR_VAL_NO_CRNG "(____ptrval____)"
219 #define ZEROS "00000000" /* hex 32 zero bits */
220 #define ONES "ffffffff" /* hex 32 one bits */
225 char buf[PLAIN_BUF_SIZE];
228 nchars = snprintf(buf, PLAIN_BUF_SIZE, "%p", PTR);
230 if (nchars != PTR_WIDTH)
233 if (strncmp(buf, PTR_VAL_NO_CRNG, PTR_WIDTH) == 0) {
234 pr_warn("crng possibly not yet initialized. plain 'p' buffer contains \"%s\"",
239 if (strncmp(buf, ZEROS, strlen(ZEROS)) != 0)
248 #define PTR ((void *)0x456789ab)
249 #define PTR_STR "456789ab"
250 #define PTR_VAL_NO_CRNG "(ptrval)"
257 /* Format is implicitly tested for 32 bit machines by plain_hash() */
261 #endif /* BITS_PER_LONG == 64 */
264 plain_hash_to_buffer(const void *p, char *buf, size_t len)
268 nchars = snprintf(buf, len, "%p", p);
270 if (nchars != PTR_WIDTH)
273 if (strncmp(buf, PTR_VAL_NO_CRNG, PTR_WIDTH) == 0) {
274 pr_warn("crng possibly not yet initialized. plain 'p' buffer contains \"%s\"",
285 char buf[PLAIN_BUF_SIZE];
288 ret = plain_hash_to_buffer(PTR, buf, PLAIN_BUF_SIZE);
292 if (strncmp(buf, PTR_STR, PTR_WIDTH) == 0)
299 * We can't use test() to test %p because we don't know what output to expect
300 * after an address is hashed.
307 if (no_hash_pointers) {
308 pr_warn("skipping plain 'p' tests");
315 pr_warn("plain 'p' does not appear to be hashed\n");
320 err = plain_format();
322 pr_warn("hashing plain 'p' has unexpected format\n");
328 test_hashed(const char *fmt, const void *p)
330 char buf[PLAIN_BUF_SIZE];
334 * No need to increase failed test counter since this is assumed
335 * to be called after plain().
337 ret = plain_hash_to_buffer(p, buf, PLAIN_BUF_SIZE);
345 * NULL pointers aren't hashed.
350 test(ZEROS "00000000", "%p", NULL);
351 test(ZEROS "00000000", "%px", NULL);
352 test("(null)", "%pE", NULL);
356 * Error pointers aren't hashed.
361 test(ONES "fffffff5", "%p", ERR_PTR(-11));
362 test(ONES "fffffff5", "%px", ERR_PTR(-11));
363 test("(efault)", "%pE", ERR_PTR(-11));
366 #define PTR_INVALID ((void *)0x000000ab)
369 invalid_pointer(void)
371 test_hashed("%p", PTR_INVALID);
372 test(ZEROS "000000ab", "%px", PTR_INVALID);
373 test("(efault)", "%pE", PTR_INVALID);
384 /* We can't test this without access to kptr_restrict. */
388 struct_resource(void)
405 const char buf[3] = {0xc0, 0xff, 0xee};
407 test("c0 ff ee|c0:ff:ee|c0-ff-ee|c0ffee",
408 "%3ph|%3phC|%3phD|%3phN", buf, buf, buf, buf);
409 test("c0 ff ee|c0:ff:ee|c0-ff-ee|c0ffee",
410 "%*ph|%*phC|%*phD|%*phN", 3, buf, 3, buf, 3, buf, 3, buf);
416 const u8 addr[6] = {0x2d, 0x48, 0xd6, 0xfc, 0x7a, 0x05};
418 test("2d:48:d6:fc:7a:05", "%pM", addr);
419 test("05:7a:fc:d6:48:2d", "%pMR", addr);
420 test("2d-48-d6-fc-7a-05", "%pMF", addr);
421 test("2d48d6fc7a05", "%pm", addr);
422 test("057afcd6482d", "%pmR", addr);
428 struct sockaddr_in sa;
430 sa.sin_family = AF_INET;
431 sa.sin_port = cpu_to_be16(12345);
432 sa.sin_addr.s_addr = cpu_to_be32(0x7f000001);
434 test("127.000.000.001|127.0.0.1", "%pi4|%pI4", &sa.sin_addr, &sa.sin_addr);
435 test("127.000.000.001|127.0.0.1", "%piS|%pIS", &sa, &sa);
436 sa.sin_addr.s_addr = cpu_to_be32(0x01020304);
437 test("001.002.003.004:12345|1.2.3.4:12345", "%piSp|%pISp", &sa, &sa);
455 const char uuid[16] = {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7,
456 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf};
458 test("00010203-0405-0607-0809-0a0b0c0d0e0f", "%pUb", uuid);
459 test("00010203-0405-0607-0809-0A0B0C0D0E0F", "%pUB", uuid);
460 test("03020100-0504-0706-0809-0a0b0c0d0e0f", "%pUl", uuid);
461 test("03020100-0504-0706-0809-0A0B0C0D0E0F", "%pUL", uuid);
464 static struct dentry test_dentry[4] __initdata = {
465 { .d_parent = &test_dentry[0],
466 .d_name = QSTR_INIT(test_dentry[0].d_iname, 3),
468 { .d_parent = &test_dentry[0],
469 .d_name = QSTR_INIT(test_dentry[1].d_iname, 5),
470 .d_iname = "bravo" },
471 { .d_parent = &test_dentry[1],
472 .d_name = QSTR_INIT(test_dentry[2].d_iname, 4),
474 { .d_parent = &test_dentry[2],
475 .d_name = QSTR_INIT(test_dentry[3].d_iname, 5),
476 .d_iname = "romeo" },
482 test("foo", "%pd", &test_dentry[0]);
483 test("foo", "%pd2", &test_dentry[0]);
485 test("(null)", "%pd", NULL);
486 test("(efault)", "%pd", PTR_INVALID);
487 test("(null)", "%pD", NULL);
488 test("(efault)", "%pD", PTR_INVALID);
490 test("romeo", "%pd", &test_dentry[3]);
491 test("alfa/romeo", "%pd2", &test_dentry[3]);
492 test("bravo/alfa/romeo", "%pd3", &test_dentry[3]);
493 test("/bravo/alfa/romeo", "%pd4", &test_dentry[3]);
494 test("/bravo/alfa", "%pd4", &test_dentry[2]);
496 test("bravo/alfa |bravo/alfa ", "%-12pd2|%*pd2", &test_dentry[2], -12, &test_dentry[2]);
497 test(" bravo/alfa| bravo/alfa", "%12pd2|%*pd2", &test_dentry[2], 12, &test_dentry[2]);
501 struct_va_format(void)
509 const struct rtc_time tm = {
517 /* 2019-01-04T15:32:23 */
518 time64_t t = 1546615943;
520 test("(%pt?)", "%pt", &tm);
521 test("2018-11-26T05:35:43", "%ptR", &tm);
522 test("0118-10-26T05:35:43", "%ptRr", &tm);
523 test("05:35:43|2018-11-26", "%ptRt|%ptRd", &tm, &tm);
524 test("05:35:43|0118-10-26", "%ptRtr|%ptRdr", &tm, &tm);
525 test("05:35:43|2018-11-26", "%ptRttr|%ptRdtr", &tm, &tm);
526 test("05:35:43 tr|2018-11-26 tr", "%ptRt tr|%ptRd tr", &tm, &tm);
528 test("2019-01-04T15:32:23", "%ptT", &t);
529 test("0119-00-04T15:32:23", "%ptTr", &t);
530 test("15:32:23|2019-01-04", "%ptTt|%ptTd", &t, &t);
531 test("15:32:23|0119-00-04", "%ptTtr|%ptTdr", &t, &t);
533 test("2019-01-04 15:32:23", "%ptTs", &t);
534 test("0119-00-04 15:32:23", "%ptTsr", &t);
535 test("15:32:23|2019-01-04", "%ptTts|%ptTds", &t, &t);
536 test("15:32:23|0119-00-04", "%ptTtrs|%ptTdrs", &t, &t);
547 const int nbits = 1 << 16;
548 unsigned long *bits = bitmap_zalloc(nbits, GFP_KERNEL);
552 bitmap_set(bits, 1, 20);
553 bitmap_set(bits, 60000, 15);
554 test("1-20,60000-60014", "%*pbl", nbits, bits);
561 DECLARE_BITMAP(bits, 20);
562 const int primes[] = {2,3,5,7,11,13,17,19};
565 bitmap_zero(bits, 20);
566 test("00000|00000", "%20pb|%*pb", bits, 20, bits);
567 test("|", "%20pbl|%*pbl", bits, 20, bits);
569 for (i = 0; i < ARRAY_SIZE(primes); ++i)
570 set_bit(primes[i], bits);
571 test("a28ac|a28ac", "%20pb|%*pb", bits, 20, bits);
572 test("2-3,5,7,11,13,17,19|2-3,5,7,11,13,17,19", "%20pbl|%*pbl", bits, 20, bits);
574 bitmap_fill(bits, 20);
575 test("fffff|fffff", "%20pb|%*pb", bits, 20, bits);
576 test("0-19|0-19", "%20pbl|%*pbl", bits, 20, bits);
582 netdev_features(void)
586 struct page_flags_test {
594 static const struct page_flags_test pft[] = {
595 {SECTIONS_WIDTH, SECTIONS_PGSHIFT, SECTIONS_MASK,
597 {NODES_WIDTH, NODES_PGSHIFT, NODES_MASK,
599 {ZONES_WIDTH, ZONES_PGSHIFT, ZONES_MASK,
601 {LAST_CPUPID_WIDTH, LAST_CPUPID_PGSHIFT, LAST_CPUPID_MASK,
602 "%#x", "lastcpupid"},
603 {KASAN_TAG_WIDTH, KASAN_TAG_PGSHIFT, KASAN_TAG_MASK,
608 page_flags_test(int section, int node, int zone, int last_cpupid,
609 int kasan_tag, unsigned long flags, const char *name,
612 unsigned long values[] = {section, node, zone, last_cpupid, kasan_tag};
617 for (i = 0; i < ARRAY_SIZE(values); i++)
618 flags |= (values[i] & pft[i].mask) << pft[i].shift;
620 size = scnprintf(cmp_buf, BUF_SIZE, "%#lx(", flags);
621 if (flags & PAGEFLAGS_MASK) {
622 size += scnprintf(cmp_buf + size, BUF_SIZE - size, "%s", name);
626 for (i = 0; i < ARRAY_SIZE(pft); i++) {
631 size += scnprintf(cmp_buf + size, BUF_SIZE - size, "|");
633 size += scnprintf(cmp_buf + size, BUF_SIZE - size, "%s=",
635 size += scnprintf(cmp_buf + size, BUF_SIZE - size, pft[i].fmt,
636 values[i] & pft[i].mask);
640 snprintf(cmp_buf + size, BUF_SIZE - size, ")");
642 test(cmp_buf, "%pGp", &flags);
645 static void __init page_type_test(unsigned int page_type, const char *name,
650 size = scnprintf(cmp_buf, BUF_SIZE, "%#x(", page_type);
651 if (page_type_has_type(page_type))
652 size += scnprintf(cmp_buf + size, BUF_SIZE - size, "%s", name);
654 snprintf(cmp_buf + size, BUF_SIZE - size, ")");
655 test(cmp_buf, "%pGt", &page_type);
664 unsigned int page_type;
666 cmp_buffer = kmalloc(BUF_SIZE, GFP_KERNEL);
671 page_flags_test(0, 0, 0, 0, 0, flags, "", cmp_buffer);
673 flags = 1UL << NR_PAGEFLAGS;
674 page_flags_test(0, 0, 0, 0, 0, flags, "", cmp_buffer);
676 flags |= 1UL << PG_uptodate | 1UL << PG_dirty | 1UL << PG_lru
677 | 1UL << PG_active | 1UL << PG_swapbacked;
678 page_flags_test(1, 1, 1, 0x1fffff, 1, flags,
679 "uptodate|dirty|lru|active|swapbacked",
682 flags = VM_READ | VM_EXEC | VM_MAYREAD | VM_MAYWRITE | VM_MAYEXEC;
683 test("read|exec|mayread|maywrite|mayexec", "%pGv", &flags);
686 test("GFP_TRANSHUGE", "%pGg", &gfp);
688 gfp = GFP_ATOMIC|__GFP_DMA;
689 test("GFP_ATOMIC|GFP_DMA", "%pGg", &gfp);
692 test("__GFP_HIGH", "%pGg", &gfp);
694 /* Any flags not translated by the table should remain numeric */
695 gfp = ~__GFP_BITS_MASK;
696 snprintf(cmp_buffer, BUF_SIZE, "%#lx", (unsigned long) gfp);
697 test(cmp_buffer, "%pGg", &gfp);
699 snprintf(cmp_buffer, BUF_SIZE, "__GFP_HIGH|%#lx",
700 (unsigned long) gfp);
702 test(cmp_buffer, "%pGg", &gfp);
705 page_type_test(page_type, "", cmp_buffer);
708 page_type_test(page_type, "", cmp_buffer);
710 page_type = ~PG_buddy;
711 page_type_test(page_type, "buddy", cmp_buffer);
713 page_type = ~(PG_table | PG_buddy);
714 page_type_test(page_type, "table|buddy", cmp_buffer);
719 static void __init fwnode_pointer(void)
721 const struct software_node first = { .name = "first" };
722 const struct software_node second = { .name = "second", .parent = &first };
723 const struct software_node third = { .name = "third", .parent = &second };
724 const struct software_node *group[] = { &first, &second, &third, NULL };
725 const char * const full_name_second = "first/second";
726 const char * const full_name_third = "first/second/third";
727 const char * const second_name = "second";
728 const char * const third_name = "third";
731 rval = software_node_register_node_group(group);
733 pr_warn("cannot register softnodes; rval %d\n", rval);
737 test(full_name_second, "%pfw", software_node_fwnode(&second));
738 test(full_name_third, "%pfw", software_node_fwnode(&third));
739 test(full_name_third, "%pfwf", software_node_fwnode(&third));
740 test(second_name, "%pfwP", software_node_fwnode(&second));
741 test(third_name, "%pfwP", software_node_fwnode(&third));
743 software_node_unregister_node_group(group);
746 static void __init fourcc_pointer(void)
752 { 0x3231564e, "NV12 little-endian (0x3231564e)", },
753 { 0xb231564e, "NV12 big-endian (0xb231564e)", },
754 { 0x10111213, ".... little-endian (0x10111213)", },
755 { 0x20303159, "Y10 little-endian (0x20303159)", },
759 for (i = 0; i < ARRAY_SIZE(try); i++)
760 test(try[i].str, "%p4cc", &try[i].code);
766 test("-1234", "%pe", ERR_PTR(-1234));
768 /* Check that %pe with a non-ERR_PTR gets treated as ordinary %p. */
769 BUILD_BUG_ON(IS_ERR(PTR));
770 test_hashed("%pe", PTR);
772 #ifdef CONFIG_SYMBOLIC_ERRNAME
773 test("(-ENOTSOCK)", "(%pe)", ERR_PTR(-ENOTSOCK));
774 test("(-EAGAIN)", "(%pe)", ERR_PTR(-EAGAIN));
775 BUILD_BUG_ON(EAGAIN != EWOULDBLOCK);
776 test("(-EAGAIN)", "(%pe)", ERR_PTR(-EWOULDBLOCK));
777 test("[-EIO ]", "[%-8pe]", ERR_PTR(-EIO));
778 test("[ -EIO]", "[%8pe]", ERR_PTR(-EIO));
779 test("-EPROBE_DEFER", "%pe", ERR_PTR(-EPROBE_DEFER));
811 static void __init selftest(void)
813 alloced_buffer = kmalloc(BUF_SIZE + 2*PAD_SIZE, GFP_KERNEL);
816 test_buffer = alloced_buffer + PAD_SIZE;
823 kfree(alloced_buffer);
826 KSTM_MODULE_LOADERS(test_printf);
827 MODULE_AUTHOR("Rasmus Villemoes <linux@rasmusvillemoes.dk>");
828 MODULE_LICENSE("GPL");