[linux.git] / lib / test_printf.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Test cases for printf facility.
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/printk.h>
#include <linux/random.h>
#include <linux/rtc.h>
#include <linux/slab.h>
#include <linux/string.h>

#include <linux/bitmap.h>
#include <linux/dcache.h>
#include <linux/socket.h>
#include <linux/in.h>

#include <linux/gfp.h>
#include <linux/mm.h>

#include "../tools/testing/selftests/kselftest_module.h"

#define BUF_SIZE 256
#define PAD_SIZE 16
#define FILL_CHAR '$'

static unsigned total_tests __initdata;
static unsigned failed_tests __initdata;
static char *test_buffer __initdata;
static char *alloced_buffer __initdata;

static int __printf(4, 0) __init
do_test(int bufsize, const char *expect, int elen,
	const char *fmt, va_list ap)
{
	va_list aq;
	int ret, written;

	total_tests++;

	memset(alloced_buffer, FILL_CHAR, BUF_SIZE + 2*PAD_SIZE);
	va_copy(aq, ap);
	ret = vsnprintf(test_buffer, bufsize, fmt, aq);
	va_end(aq);

	if (ret != elen) {
		pr_warn("vsnprintf(buf, %d, \"%s\", ...) returned %d, expected %d\n",
			bufsize, fmt, ret, elen);
		return 1;
	}

	if (memchr_inv(alloced_buffer, FILL_CHAR, PAD_SIZE)) {
		pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote before buffer\n", bufsize, fmt);
		return 1;
	}

	if (!bufsize) {
		if (memchr_inv(test_buffer, FILL_CHAR, BUF_SIZE + PAD_SIZE)) {
			pr_warn("vsnprintf(buf, 0, \"%s\", ...) wrote to buffer\n",
				fmt);
			return 1;
		}
		return 0;
	}

	written = min(bufsize-1, elen);
	if (test_buffer[written]) {
		pr_warn("vsnprintf(buf, %d, \"%s\", ...) did not nul-terminate buffer\n",
			bufsize, fmt);
		return 1;
	}

	if (memchr_inv(test_buffer + written + 1, FILL_CHAR, BUF_SIZE + PAD_SIZE - (written + 1))) {
		pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote beyond the nul-terminator\n",
			bufsize, fmt);
		return 1;
	}

	if (memcmp(test_buffer, expect, written)) {
		pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote '%s', expected '%.*s'\n",
			bufsize, fmt, test_buffer, written, expect);
		return 1;
	}
	return 0;
}

static void __printf(3, 4) __init
__test(const char *expect, int elen, const char *fmt, ...)
{
	va_list ap;
	int rand;
	char *p;

	if (elen >= BUF_SIZE) {
		pr_err("error in test suite: expected output length %d too long. Format was '%s'.\n",
		       elen, fmt);
		failed_tests++;
		return;
	}

	va_start(ap, fmt);

	/*
	 * Every fmt+args is subjected to four tests: Three where we
	 * tell vsnprintf varying buffer sizes (plenty, not quite
	 * enough and 0), and then we also test that kvasprintf would
	 * be able to print it as expected.
	 */
	failed_tests += do_test(BUF_SIZE, expect, elen, fmt, ap);
	rand = 1 + prandom_u32_max(elen+1);
	/* Since elen < BUF_SIZE, we have 1 <= rand <= BUF_SIZE. */
	failed_tests += do_test(rand, expect, elen, fmt, ap);
	failed_tests += do_test(0, expect, elen, fmt, ap);

	p = kvasprintf(GFP_KERNEL, fmt, ap);
	if (p) {
		total_tests++;
		if (memcmp(p, expect, elen+1)) {
			pr_warn("kvasprintf(..., \"%s\", ...) returned '%s', expected '%s'\n",
				fmt, p, expect);
			failed_tests++;
		}
		kfree(p);
	}
	va_end(ap);
}

#define test(expect, fmt, ...)					\
	__test(expect, strlen(expect), fmt, ##__VA_ARGS__)

static void __init
test_basic(void)
{
	/* Work around annoying "warning: zero-length gnu_printf format string". */
	char nul = '\0';

	test("", &nul);
	test("100%", "100%%");
	test("xxx%yyy", "xxx%cyyy", '%');
	__test("xxx\0yyy", 7, "xxx%cyyy", '\0');
}

static void __init
test_number(void)
{
	test("0x1234abcd  ", "%#-12x", 0x1234abcd);
	test("  0x1234abcd", "%#12x", 0x1234abcd);
	test("0|001| 12|+123| 1234|-123|-1234", "%d|%03d|%3d|%+d|% d|%+d|% d", 0, 1, 12, 123, 1234, -123, -1234);
	test("0|1|1|128|255", "%hhu|%hhu|%hhu|%hhu|%hhu", 0, 1, 257, 128, -1);
	test("0|1|1|-128|-1", "%hhd|%hhd|%hhd|%hhd|%hhd", 0, 1, 257, 128, -1);
	test("2015122420151225", "%ho%ho%#ho", 1037, 5282, -11627);
	/*
	 * POSIX/C99: »The result of converting zero with an explicit
	 * precision of zero shall be no characters.« Hence the output
	 * from the below test should really be "00|0||| ". However,
	 * the kernel's printf also produces a single 0 in that
	 * case. This test case simply documents the current
	 * behaviour.
	 */
	test("00|0|0|0|0", "%.2d|%.1d|%.0d|%.*d|%1.0d", 0, 0, 0, 0, 0, 0);
#ifndef __CHAR_UNSIGNED__
	{
		/*
		 * Passing a 'char' to a %02x specifier doesn't do
		 * what was presumably the intention when char is
		 * signed and the value is negative. One must either &
		 * with 0xff or cast to u8.
		 */
		char val = -16;
		test("0xfffffff0|0xf0|0xf0", "%#02x|%#02x|%#02x", val, val & 0xff, (u8)val);
	}
#endif
}

static void __init
test_string(void)
{
	test("", "%s%.0s", "", "123");
	test("ABCD|abc|123", "%s|%.3s|%.*s", "ABCD", "abcdef", 3, "123456");
	test("1  |  2|3  |  4|5  ", "%-3s|%3s|%-*s|%*s|%*s", "1", "2", 3, "3", 3, "4", -3, "5");
	test("1234      ", "%-10.4s", "123456");
	test("      1234", "%10.4s", "123456");
	/*
	 * POSIX and C99 say that a negative precision (which is only
	 * possible to pass via a * argument) should be treated as if
	 * the precision wasn't present, and that if the precision is
	 * omitted (as in %.s), the precision should be taken to be
	 * 0. However, the kernel's printf behave exactly opposite,
	 * treating a negative precision as 0 and treating an omitted
	 * precision specifier as if no precision was given.
	 *
	 * These test cases document the current behaviour; should
	 * anyone ever feel the need to follow the standards more
	 * closely, this can be revisited.
	 */
	test("    ", "%4.*s", -5, "123456");
	test("123456", "%.s", "123456");
	test("a||", "%.s|%.0s|%.*s", "a", "b", 0, "c");
	test("a  |   |   ", "%-3.s|%-3.0s|%-3.*s", "a", "b", 0, "c");
}

#define PLAIN_BUF_SIZE 64	/* leave some space so we don't oops */

#if BITS_PER_LONG == 64

#define PTR_WIDTH 16
#define PTR ((void *)0xffff0123456789abUL)
#define PTR_STR "ffff0123456789ab"
#define PTR_VAL_NO_CRNG "(____ptrval____)"
#define ZEROS "00000000"	/* hex 32 zero bits */

static int __init
plain_format(void)
{
	char buf[PLAIN_BUF_SIZE];
	int nchars;

	nchars = snprintf(buf, PLAIN_BUF_SIZE, "%p", PTR);

	if (nchars != PTR_WIDTH)
		return -1;

	if (strncmp(buf, PTR_VAL_NO_CRNG, PTR_WIDTH) == 0) {
		pr_warn("crng possibly not yet initialized. plain 'p' buffer contains \"%s\"",
			PTR_VAL_NO_CRNG);
		return 0;
	}

	if (strncmp(buf, ZEROS, strlen(ZEROS)) != 0)
		return -1;

	return 0;
}

#else

#define PTR_WIDTH 8
#define PTR ((void *)0x456789ab)
#define PTR_STR "456789ab"
#define PTR_VAL_NO_CRNG "(ptrval)"
#define ZEROS ""

static int __init
plain_format(void)
{
	/* Format is implicitly tested for 32 bit machines by plain_hash() */
	return 0;
}

#endif	/* BITS_PER_LONG == 64 */

static int __init
plain_hash_to_buffer(const void *p, char *buf, size_t len)
{
	int nchars;

	nchars = snprintf(buf, len, "%p", p);

	if (nchars != PTR_WIDTH)
		return -1;

	if (strncmp(buf, PTR_VAL_NO_CRNG, PTR_WIDTH) == 0) {
		pr_warn("crng possibly not yet initialized. plain 'p' buffer contains \"%s\"",
			PTR_VAL_NO_CRNG);
		return 0;
	}

	return 0;
}

static int __init
plain_hash(void)
{
	char buf[PLAIN_BUF_SIZE];
	int ret;

	ret = plain_hash_to_buffer(PTR, buf, PLAIN_BUF_SIZE);
	if (ret)
		return ret;

	if (strncmp(buf, PTR_STR, PTR_WIDTH) == 0)
		return -1;

	return 0;
}

/*
 * We can't use test() to test %p because we don't know what output to expect
 * after an address is hashed.
 */
static void __init
plain(void)
{
	int err;

	err = plain_hash();
	if (err) {
		pr_warn("plain 'p' does not appear to be hashed\n");
		failed_tests++;
		return;
	}

	err = plain_format();
	if (err) {
		pr_warn("hashing plain 'p' has unexpected format\n");
		failed_tests++;
	}
}

static void __init
test_hashed(const char *fmt, const void *p)
{
	char buf[PLAIN_BUF_SIZE];
	int ret;

	/*
	 * No need to increase failed test counter since this is assumed
	 * to be called after plain().
	 */
	ret = plain_hash_to_buffer(p, buf, PLAIN_BUF_SIZE);
	if (ret)
		return;

	test(buf, fmt, p);
}

static void __init
null_pointer(void)
{
	test_hashed("%p", NULL);
	test(ZEROS "00000000", "%px", NULL);
	test("(null)", "%pE", NULL);
}

#define PTR_INVALID ((void *)0x000000ab)

static void __init
invalid_pointer(void)
{
	test_hashed("%p", PTR_INVALID);
	test(ZEROS "000000ab", "%px", PTR_INVALID);
	test("(efault)", "%pE", PTR_INVALID);
}

static void __init
symbol_ptr(void)
{
}

static void __init
kernel_ptr(void)
{
	/* We can't test this without access to kptr_restrict. */
}

static void __init
struct_resource(void)
{
}

static void __init
addr(void)
{
}

static void __init
escaped_str(void)
{
}

static void __init
hex_string(void)
{
	const char buf[3] = {0xc0, 0xff, 0xee};

	test("c0 ff ee|c0:ff:ee|c0-ff-ee|c0ffee",
	     "%3ph|%3phC|%3phD|%3phN", buf, buf, buf, buf);
	test("c0 ff ee|c0:ff:ee|c0-ff-ee|c0ffee",
	     "%*ph|%*phC|%*phD|%*phN", 3, buf, 3, buf, 3, buf, 3, buf);
}

static void __init
mac(void)
{
	const u8 addr[6] = {0x2d, 0x48, 0xd6, 0xfc, 0x7a, 0x05};

	test("2d:48:d6:fc:7a:05", "%pM", addr);
	test("05:7a:fc:d6:48:2d", "%pMR", addr);
	test("2d-48-d6-fc-7a-05", "%pMF", addr);
	test("2d48d6fc7a05", "%pm", addr);
	test("057afcd6482d", "%pmR", addr);
}

static void __init
ip4(void)
{
	struct sockaddr_in sa;

	sa.sin_family = AF_INET;
	sa.sin_port = cpu_to_be16(12345);
	sa.sin_addr.s_addr = cpu_to_be32(0x7f000001);

	test("127.000.000.001|127.0.0.1", "%pi4|%pI4", &sa.sin_addr, &sa.sin_addr);
	test("127.000.000.001|127.0.0.1", "%piS|%pIS", &sa, &sa);
	sa.sin_addr.s_addr = cpu_to_be32(0x01020304);
	test("001.002.003.004:12345|1.2.3.4:12345", "%piSp|%pISp", &sa, &sa);
}

static void __init
ip6(void)
{
}

static void __init
ip(void)
{
	ip4();
	ip6();
}

static void __init
uuid(void)
{
	const char uuid[16] = {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7,
			       0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf};

	test("00010203-0405-0607-0809-0a0b0c0d0e0f", "%pUb", uuid);
	test("00010203-0405-0607-0809-0A0B0C0D0E0F", "%pUB", uuid);
	test("03020100-0504-0706-0809-0a0b0c0d0e0f", "%pUl", uuid);
	test("03020100-0504-0706-0809-0A0B0C0D0E0F", "%pUL", uuid);
}

static struct dentry test_dentry[4] __initdata = {
	{ .d_parent = &test_dentry[0],
	  .d_name = QSTR_INIT(test_dentry[0].d_iname, 3),
	  .d_iname = "foo" },
	{ .d_parent = &test_dentry[0],
	  .d_name = QSTR_INIT(test_dentry[1].d_iname, 5),
	  .d_iname = "bravo" },
	{ .d_parent = &test_dentry[1],
	  .d_name = QSTR_INIT(test_dentry[2].d_iname, 4),
	  .d_iname = "alfa" },
	{ .d_parent = &test_dentry[2],
	  .d_name = QSTR_INIT(test_dentry[3].d_iname, 5),
	  .d_iname = "romeo" },
};

static void __init
dentry(void)
{
	test("foo", "%pd", &test_dentry[0]);
	test("foo", "%pd2", &test_dentry[0]);

	test("(null)", "%pd", NULL);
	test("(efault)", "%pd", PTR_INVALID);
	test("(null)", "%pD", NULL);
	test("(efault)", "%pD", PTR_INVALID);

	test("romeo", "%pd", &test_dentry[3]);
	test("alfa/romeo", "%pd2", &test_dentry[3]);
	test("bravo/alfa/romeo", "%pd3", &test_dentry[3]);
	test("/bravo/alfa/romeo", "%pd4", &test_dentry[3]);
	test("/bravo/alfa", "%pd4", &test_dentry[2]);

	test("bravo/alfa  |bravo/alfa  ", "%-12pd2|%*pd2", &test_dentry[2], -12, &test_dentry[2]);
	test("  bravo/alfa|  bravo/alfa", "%12pd2|%*pd2", &test_dentry[2], 12, &test_dentry[2]);
}

static void __init
struct_va_format(void)
{
}

static void __init
struct_rtc_time(void)
{
	/* 1543210543 */
	const struct rtc_time tm = {
		.tm_sec = 43,
		.tm_min = 35,
		.tm_hour = 5,
		.tm_mday = 26,
		.tm_mon = 10,
		.tm_year = 118,
	};

	test("(%ptR?)", "%pt", &tm);
	test("2018-11-26T05:35:43", "%ptR", &tm);
	test("0118-10-26T05:35:43", "%ptRr", &tm);
	test("05:35:43|2018-11-26", "%ptRt|%ptRd", &tm, &tm);
	test("05:35:43|0118-10-26", "%ptRtr|%ptRdr", &tm, &tm);
	test("05:35:43|2018-11-26", "%ptRttr|%ptRdtr", &tm, &tm);
	test("05:35:43 tr|2018-11-26 tr", "%ptRt tr|%ptRd tr", &tm, &tm);
}

static void __init
struct_clk(void)
{
}

static void __init
large_bitmap(void)
{
	const int nbits = 1 << 16;
	unsigned long *bits = bitmap_zalloc(nbits, GFP_KERNEL);
	if (!bits)
		return;

	bitmap_set(bits, 1, 20);
	bitmap_set(bits, 60000, 15);
	test("1-20,60000-60014", "%*pbl", nbits, bits);
	bitmap_free(bits);
}

static void __init
bitmap(void)
{
	DECLARE_BITMAP(bits, 20);
	const int primes[] = {2,3,5,7,11,13,17,19};
	int i;

	bitmap_zero(bits, 20);
	test("00000|00000", "%20pb|%*pb", bits, 20, bits);
	test("|", "%20pbl|%*pbl", bits, 20, bits);

	for (i = 0; i < ARRAY_SIZE(primes); ++i)
		set_bit(primes[i], bits);
	test("a28ac|a28ac", "%20pb|%*pb", bits, 20, bits);
	test("2-3,5,7,11,13,17,19|2-3,5,7,11,13,17,19", "%20pbl|%*pbl", bits, 20, bits);

	bitmap_fill(bits, 20);
	test("fffff|fffff", "%20pb|%*pb", bits, 20, bits);
	test("0-19|0-19", "%20pbl|%*pbl", bits, 20, bits);

	large_bitmap();
}

static void __init
netdev_features(void)
{
}

static void __init
flags(void)
{
	unsigned long flags;
	gfp_t gfp;
	char *cmp_buffer;

	flags = 0;
	test("", "%pGp", &flags);

	/* Page flags should filter the zone id */
	flags = 1UL << NR_PAGEFLAGS;
	test("", "%pGp", &flags);

	flags |= 1UL << PG_uptodate | 1UL << PG_dirty | 1UL << PG_lru
		| 1UL << PG_active | 1UL << PG_swapbacked;
	test("uptodate|dirty|lru|active|swapbacked", "%pGp", &flags);


	flags = VM_READ | VM_EXEC | VM_MAYREAD | VM_MAYWRITE | VM_MAYEXEC
			| VM_DENYWRITE;
	test("read|exec|mayread|maywrite|mayexec|denywrite", "%pGv", &flags);

	gfp = GFP_TRANSHUGE;
	test("GFP_TRANSHUGE", "%pGg", &gfp);

	gfp = GFP_ATOMIC|__GFP_DMA;
	test("GFP_ATOMIC|GFP_DMA", "%pGg", &gfp);

	gfp = __GFP_ATOMIC;
	test("__GFP_ATOMIC", "%pGg", &gfp);

	cmp_buffer = kmalloc(BUF_SIZE, GFP_KERNEL);
	if (!cmp_buffer)
		return;

	/* Any flags not translated by the table should remain numeric */
	gfp = ~__GFP_BITS_MASK;
	snprintf(cmp_buffer, BUF_SIZE, "%#lx", (unsigned long) gfp);
	test(cmp_buffer, "%pGg", &gfp);

	snprintf(cmp_buffer, BUF_SIZE, "__GFP_ATOMIC|%#lx",
							(unsigned long) gfp);
	gfp |= __GFP_ATOMIC;
	test(cmp_buffer, "%pGg", &gfp);

	kfree(cmp_buffer);
}

static void __init
test_pointer(void)
{
	plain();
	null_pointer();
	invalid_pointer();
	symbol_ptr();
	kernel_ptr();
	struct_resource();
	addr();
	escaped_str();
	hex_string();
	mac();
	ip();
	uuid();
	dentry();
	struct_va_format();
	struct_rtc_time();
	struct_clk();
	bitmap();
	netdev_features();
	flags();
}

static void __init selftest(void)
{
	alloced_buffer = kmalloc(BUF_SIZE + 2*PAD_SIZE, GFP_KERNEL);
	if (!alloced_buffer)
		return;
	test_buffer = alloced_buffer + PAD_SIZE;

	test_basic();
	test_number();
	test_string();
	test_pointer();

	kfree(alloced_buffer);
}

KSTM_MODULE_LOADERS(test_printf);
MODULE_AUTHOR("Rasmus Villemoes <[email protected]>");
MODULE_LICENSE("GPL");
Commit	Line	Data
09c434b8	1	// SPDX-License-Identifier: GPL-2.0-only
707cc728 RV	2	/*
	3	* Test cases for printf facility.
	4	*/
	5
	6	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	7
	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>
4d42c447	13	#include <linux/rtc.h>
707cc728 RV	14	#include <linux/slab.h>
	15	#include <linux/string.h>
	16
857cca4d	17	#include <linux/bitmap.h>
251c7234	18	#include <linux/dcache.h>
707cc728 RV	19	#include <linux/socket.h>
	20	#include <linux/in.h>
	21
edf14cdb VB	22	#include <linux/gfp.h>
	23	#include <linux/mm.h>
	24
6b1a4d5b TH	25	#include "../tools/testing/selftests/kselftest_module.h"
6b1a4d5b TH	26
707cc728	27	#define BUF_SIZE 256
331e4deb	28	#define PAD_SIZE 16
707cc728 RV	29	#define FILL_CHAR '$'
707cc728 RV	30
707cc728 RV	31	static unsigned total_tests __initdata;
	32	static unsigned failed_tests __initdata;
	33	static char *test_buffer __initdata;
331e4deb	34	static char *alloced_buffer __initdata;
707cc728 RV	35
	36	static int __printf(4, 0) __init
	37	do_test(int bufsize, const char *expect, int elen,
	38	const char *fmt, va_list ap)
	39	{
	40	va_list aq;
	41	int ret, written;
	42
	43	total_tests++;
	44
331e4deb	45	memset(alloced_buffer, FILL_CHAR, BUF_SIZE + 2*PAD_SIZE);
707cc728 RV	46	va_copy(aq, ap);
	47	ret = vsnprintf(test_buffer, bufsize, fmt, aq);
	48	va_end(aq);
	49
	50	if (ret != elen) {
	51	pr_warn("vsnprintf(buf, %d, \"%s\", ...) returned %d, expected %d\n",
	52	bufsize, fmt, ret, elen);
	53	return 1;
	54	}
	55
331e4deb RV	56	if (memchr_inv(alloced_buffer, FILL_CHAR, PAD_SIZE)) {
	57	pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote before buffer\n", bufsize, fmt);
	58	return 1;
	59	}
	60
707cc728	61	if (!bufsize) {
331e4deb	62	if (memchr_inv(test_buffer, FILL_CHAR, BUF_SIZE + PAD_SIZE)) {
707cc728 RV	63	pr_warn("vsnprintf(buf, 0, \"%s\", ...) wrote to buffer\n",
	64	fmt);
	65	return 1;
	66	}
	67	return 0;
	68	}
	69
	70	written = min(bufsize-1, elen);
	71	if (test_buffer[written]) {
	72	pr_warn("vsnprintf(buf, %d, \"%s\", ...) did not nul-terminate buffer\n",
	73	bufsize, fmt);
	74	return 1;
	75	}
	76
331e4deb RV	77	if (memchr_inv(test_buffer + written + 1, FILL_CHAR, BUF_SIZE + PAD_SIZE - (written + 1))) {
	78	pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote beyond the nul-terminator\n",
	79	bufsize, fmt);
	80	return 1;
	81	}
	82
707cc728 RV	83	if (memcmp(test_buffer, expect, written)) {
	84	pr_warn("vsnprintf(buf, %d, \"%s\", ...) wrote '%s', expected '%.*s'\n",
	85	bufsize, fmt, test_buffer, written, expect);
	86	return 1;
	87	}
	88	return 0;
	89	}
	90
	91	static void __printf(3, 4) __init
	92	__test(const char expect, int elen, const char fmt, ...)
	93	{
	94	va_list ap;
	95	int rand;
	96	char *p;
	97
fd0515d5 RV	98	if (elen >= BUF_SIZE) {
	99	pr_err("error in test suite: expected output length %d too long. Format was '%s'.\n",
	100	elen, fmt);
	101	failed_tests++;
	102	return;
	103	}
707cc728 RV	104
	105	va_start(ap, fmt);
	106
	107	/*
	108	* Every fmt+args is subjected to four tests: Three where we
	109	* tell vsnprintf varying buffer sizes (plenty, not quite
	110	* enough and 0), and then we also test that kvasprintf would
	111	* be able to print it as expected.
	112	*/
	113	failed_tests += do_test(BUF_SIZE, expect, elen, fmt, ap);
	114	rand = 1 + prandom_u32_max(elen+1);
	115	/* Since elen < BUF_SIZE, we have 1 <= rand <= BUF_SIZE. */
	116	failed_tests += do_test(rand, expect, elen, fmt, ap);
	117	failed_tests += do_test(0, expect, elen, fmt, ap);
	118
	119	p = kvasprintf(GFP_KERNEL, fmt, ap);
	120	if (p) {
b79a7db3	121	total_tests++;
707cc728 RV	122	if (memcmp(p, expect, elen+1)) {
	123	pr_warn("kvasprintf(..., \"%s\", ...) returned '%s', expected '%s'\n",
	124	fmt, p, expect);
	125	failed_tests++;
	126	}
	127	kfree(p);
	128	}
	129	va_end(ap);
	130	}
	131
	132	#define test(expect, fmt, ...) \
	133	__test(expect, strlen(expect), fmt, ##__VA_ARGS__)
	134
	135	static void __init
	136	test_basic(void)
	137	{
	138	/* Work around annoying "warning: zero-length gnu_printf format string". */
	139	char nul = '\0';
	140
	141	test("", &nul);
	142	test("100%", "100%%");
	143	test("xxx%yyy", "xxx%cyyy", '%');
	144	__test("xxx\0yyy", 7, "xxx%cyyy", '\0');
	145	}
	146
	147	static void __init
	148	test_number(void)
	149	{
	150	test("0x1234abcd ", "%#-12x", 0x1234abcd);
	151	test(" 0x1234abcd", "%#12x", 0x1234abcd);
	152	test("0\|001\| 12\|+123\| 1234\|-123\|-1234", "%d\|%03d\|%3d\|%+d\|% d\|%+d\|% d", 0, 1, 12, 123, 1234, -123, -1234);
1ca8e8eb RV	153	test("0\|1\|1\|128\|255", "%hhu\|%hhu\|%hhu\|%hhu\|%hhu", 0, 1, 257, 128, -1);
	154	test("0\|1\|1\|-128\|-1", "%hhd\|%hhd\|%hhd\|%hhd\|%hhd", 0, 1, 257, 128, -1);
	155	test("2015122420151225", "%ho%ho%#ho", 1037, 5282, -11627);
	156	/*
	157	* POSIX/C99: »The result of converting zero with an explicit
	158	* precision of zero shall be no characters.« Hence the output
	159	* from the below test should really be "00\|0\|\|\| ". However,
	160	* the kernel's printf also produces a single 0 in that
	161	* case. This test case simply documents the current
	162	* behaviour.
	163	*/
	164	test("00\|0\|0\|0\|0", "%.2d\|%.1d\|%.0d\|%.*d\|%1.0d", 0, 0, 0, 0, 0, 0);
	165	#ifndef __CHAR_UNSIGNED__
	166	{
	167	/*
	168	* Passing a 'char' to a %02x specifier doesn't do
	169	* what was presumably the intention when char is
	170	* signed and the value is negative. One must either &
	171	* with 0xff or cast to u8.
	172	*/
	173	char val = -16;
	174	test("0xfffffff0\|0xf0\|0xf0", "%#02x\|%#02x\|%#02x", val, val & 0xff, (u8)val);
	175	}
	176	#endif
707cc728 RV	177	}
	178
	179	static void __init
	180	test_string(void)
	181	{
	182	test("", "%s%.0s", "", "123");
	183	test("ABCD\|abc\|123", "%s\|%.3s\|%.*s", "ABCD", "abcdef", 3, "123456");
	184	test("1 \| 2\|3 \| 4\|5 ", "%-3s\|%3s\|%-s\|%s\|%*s", "1", "2", 3, "3", 3, "4", -3, "5");
f176eb4c RV	185	test("1234 ", "%-10.4s", "123456");
f176eb4c RV	186	test(" 1234", "%10.4s", "123456");
707cc728	187	/*
f176eb4c RV	188	* POSIX and C99 say that a negative precision (which is only
	189	* possible to pass via a * argument) should be treated as if
	190	* the precision wasn't present, and that if the precision is
	191	* omitted (as in %.s), the precision should be taken to be
	192	* 0. However, the kernel's printf behave exactly opposite,
	193	* treating a negative precision as 0 and treating an omitted
	194	* precision specifier as if no precision was given.
	195	*
	196	* These test cases document the current behaviour; should
	197	* anyone ever feel the need to follow the standards more
	198	* closely, this can be revisited.
707cc728	199	*/
f176eb4c RV	200	test(" ", "%4.*s", -5, "123456");
f176eb4c RV	201	test("123456", "%.s", "123456");
707cc728 RV	202	test("a\|\|", "%.s\|%.0s\|%.*s", "a", "b", 0, "c");
	203	test("a \| \| ", "%-3.s\|%-3.0s\|%-3.*s", "a", "b", 0, "c");
	204	}
	205
ad67b74d TH	206	#define PLAIN_BUF_SIZE 64 /* leave some space so we don't oops */
	207
	208	#if BITS_PER_LONG == 64
	209
	210	#define PTR_WIDTH 16
c604b407	211	#define PTR ((void *)0xffff0123456789abUL)
ad67b74d	212	#define PTR_STR "ffff0123456789ab"
ce041c43	213	#define PTR_VAL_NO_CRNG "(____ptrval____)"
ad67b74d TH	214	#define ZEROS "00000000" /* hex 32 zero bits */
	215
	216	static int __init
	217	plain_format(void)
	218	{
	219	char buf[PLAIN_BUF_SIZE];
	220	int nchars;
	221
	222	nchars = snprintf(buf, PLAIN_BUF_SIZE, "%p", PTR);
	223
ce041c43 TE	224	if (nchars != PTR_WIDTH)
	225	return -1;
	226
	227	if (strncmp(buf, PTR_VAL_NO_CRNG, PTR_WIDTH) == 0) {
	228	pr_warn("crng possibly not yet initialized. plain 'p' buffer contains \"%s\"",
	229	PTR_VAL_NO_CRNG);
	230	return 0;
	231	}
	232
	233	if (strncmp(buf, ZEROS, strlen(ZEROS)) != 0)
ad67b74d TH	234	return -1;
	235
	236	return 0;
	237	}
	238
	239	#else
	240
	241	#define PTR_WIDTH 8
	242	#define PTR ((void *)0x456789ab)
	243	#define PTR_STR "456789ab"
ce041c43	244	#define PTR_VAL_NO_CRNG "(ptrval)"
3e5903eb	245	#define ZEROS ""
ad67b74d TH	246
	247	static int __init
	248	plain_format(void)
	249	{
	250	/* Format is implicitly tested for 32 bit machines by plain_hash() */
	251	return 0;
	252	}
	253
	254	#endif /* BITS_PER_LONG == 64 */
	255
	256	static int __init
4d42c447	257	plain_hash_to_buffer(const void p, char buf, size_t len)
ad67b74d	258	{
ad67b74d TH	259	int nchars;
ad67b74d TH	260
4d42c447	261	nchars = snprintf(buf, len, "%p", p);
ad67b74d	262
ce041c43 TE	263	if (nchars != PTR_WIDTH)
	264	return -1;
	265
	266	if (strncmp(buf, PTR_VAL_NO_CRNG, PTR_WIDTH) == 0) {
	267	pr_warn("crng possibly not yet initialized. plain 'p' buffer contains \"%s\"",
	268	PTR_VAL_NO_CRNG);
	269	return 0;
	270	}
	271
4d42c447 AS	272	return 0;
	273	}
	274
4d42c447 AS	275	static int __init
	276	plain_hash(void)
	277	{
	278	char buf[PLAIN_BUF_SIZE];
	279	int ret;
	280
	281	ret = plain_hash_to_buffer(PTR, buf, PLAIN_BUF_SIZE);
	282	if (ret)
	283	return ret;
	284
ce041c43	285	if (strncmp(buf, PTR_STR, PTR_WIDTH) == 0)
ad67b74d TH	286	return -1;
	287
	288	return 0;
	289	}
	290
	291	/*
	292	* We can't use test() to test %p because we don't know what output to expect
	293	* after an address is hashed.
	294	*/
707cc728 RV	295	static void __init
	296	plain(void)
	297	{
ad67b74d	298	int err;
707cc728	299
ad67b74d TH	300	err = plain_hash();
	301	if (err) {
	302	pr_warn("plain 'p' does not appear to be hashed\n");
	303	failed_tests++;
	304	return;
	305	}
	306
	307	err = plain_format();
	308	if (err) {
	309	pr_warn("hashing plain 'p' has unexpected format\n");
	310	failed_tests++;
	311	}
707cc728 RV	312	}
707cc728 RV	313
4d42c447 AS	314	static void __init
	315	test_hashed(const char fmt, const void p)
	316	{
	317	char buf[PLAIN_BUF_SIZE];
	318	int ret;
	319
	320	/*
	321	* No need to increase failed test counter since this is assumed
	322	* to be called after plain().
	323	*/
	324	ret = plain_hash_to_buffer(p, buf, PLAIN_BUF_SIZE);
	325	if (ret)
	326	return;
	327
	328	test(buf, fmt, p);
	329	}
	330
3e5903eb PM	331	static void __init
	332	null_pointer(void)
	333	{
	334	test_hashed("%p", NULL);
	335	test(ZEROS "00000000", "%px", NULL);
	336	test("(null)", "%pE", NULL);
	337	}
	338
	339	#define PTR_INVALID ((void *)0x000000ab)
	340
	341	static void __init
	342	invalid_pointer(void)
	343	{
	344	test_hashed("%p", PTR_INVALID);
	345	test(ZEROS "000000ab", "%px", PTR_INVALID);
	346	test("(efault)", "%pE", PTR_INVALID);
	347	}
	348
707cc728 RV	349	static void __init
	350	symbol_ptr(void)
	351	{
	352	}
	353
	354	static void __init
	355	kernel_ptr(void)
	356	{
ad67b74d	357	/* We can't test this without access to kptr_restrict. */
707cc728 RV	358	}
	359
	360	static void __init
	361	struct_resource(void)
	362	{
	363	}
	364
	365	static void __init
	366	addr(void)
	367	{
	368	}
	369
	370	static void __init
	371	escaped_str(void)
	372	{
	373	}
	374
	375	static void __init
	376	hex_string(void)
	377	{
	378	const char buf[3] = {0xc0, 0xff, 0xee};
	379
	380	test("c0 ff ee\|c0:ff:ee\|c0-ff-ee\|c0ffee",
	381	"%3ph\|%3phC\|%3phD\|%3phN", buf, buf, buf, buf);
	382	test("c0 ff ee\|c0:ff:ee\|c0-ff-ee\|c0ffee",
	383	"%ph\|%phC\|%phD\|%phN", 3, buf, 3, buf, 3, buf, 3, buf);
	384	}
	385
	386	static void __init
	387	mac(void)
	388	{
	389	const u8 addr[6] = {0x2d, 0x48, 0xd6, 0xfc, 0x7a, 0x05};
	390
	391	test("2d:48:d6:fc:7a:05", "%pM", addr);
	392	test("05:7a:fc:d6:48:2d", "%pMR", addr);
	393	test("2d-48-d6-fc-7a-05", "%pMF", addr);
	394	test("2d48d6fc7a05", "%pm", addr);
	395	test("057afcd6482d", "%pmR", addr);
	396	}
	397
	398	static void __init
	399	ip4(void)
	400	{
	401	struct sockaddr_in sa;
	402
	403	sa.sin_family = AF_INET;
	404	sa.sin_port = cpu_to_be16(12345);
	405	sa.sin_addr.s_addr = cpu_to_be32(0x7f000001);
	406
	407	test("127.000.000.001\|127.0.0.1", "%pi4\|%pI4", &sa.sin_addr, &sa.sin_addr);
	408	test("127.000.000.001\|127.0.0.1", "%piS\|%pIS", &sa, &sa);
	409	sa.sin_addr.s_addr = cpu_to_be32(0x01020304);
	410	test("001.002.003.004:12345\|1.2.3.4:12345", "%piSp\|%pISp", &sa, &sa);
	411	}
	412
	413	static void __init
	414	ip6(void)
	415	{
	416	}
	417
	418	static void __init
	419	ip(void)
	420	{
	421	ip4();
422	ip6();
423	}
424
425	static void __init
426	uuid(void)
427	{
428	const char uuid[16] = {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7,
429	0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf};
430
431	test("00010203-0405-0607-0809-0a0b0c0d0e0f", "%pUb", uuid);
432	test("00010203-0405-0607-0809-0A0B0C0D0E0F", "%pUB", uuid);
433	test("03020100-0504-0706-0809-0a0b0c0d0e0f", "%pUl", uuid);
434	test("03020100-0504-0706-0809-0A0B0C0D0E0F", "%pUL", uuid);
435	}
436
251c7234 RV	437	static struct dentry test_dentry[4] __initdata = {
	438	{ .d_parent = &test_dentry[0],
	439	.d_name = QSTR_INIT(test_dentry[0].d_iname, 3),
	440	.d_iname = "foo" },
	441	{ .d_parent = &test_dentry[0],
	442	.d_name = QSTR_INIT(test_dentry[1].d_iname, 5),
	443	.d_iname = "bravo" },
	444	{ .d_parent = &test_dentry[1],
	445	.d_name = QSTR_INIT(test_dentry[2].d_iname, 4),
	446	.d_iname = "alfa" },
	447	{ .d_parent = &test_dentry[2],
	448	.d_name = QSTR_INIT(test_dentry[3].d_iname, 5),
	449	.d_iname = "romeo" },
	450	};
	451
707cc728 RV	452	static void __init
	453	dentry(void)
	454	{
251c7234 RV	455	test("foo", "%pd", &test_dentry[0]);
	456	test("foo", "%pd2", &test_dentry[0]);
	457
cf6b7921 JH	458	test("(null)", "%pd", NULL);
cf6b7921 JH	459	test("(efault)", "%pd", PTR_INVALID);
cf6b7921 JH	460	test("(null)", "%pD", NULL);
	461	test("(efault)", "%pD", PTR_INVALID);
	462
251c7234 RV	463	test("romeo", "%pd", &test_dentry[3]);
	464	test("alfa/romeo", "%pd2", &test_dentry[3]);
	465	test("bravo/alfa/romeo", "%pd3", &test_dentry[3]);
	466	test("/bravo/alfa/romeo", "%pd4", &test_dentry[3]);
	467	test("/bravo/alfa", "%pd4", &test_dentry[2]);
	468
	469	test("bravo/alfa \|bravo/alfa ", "%-12pd2\|%*pd2", &test_dentry[2], -12, &test_dentry[2]);
	470	test(" bravo/alfa\| bravo/alfa", "%12pd2\|%*pd2", &test_dentry[2], 12, &test_dentry[2]);
707cc728 RV	471	}
	472
	473	static void __init
	474	struct_va_format(void)
	475	{
	476	}
	477
4d42c447 AS	478	static void __init
	479	struct_rtc_time(void)
	480	{
	481	/* 1543210543 */
	482	const struct rtc_time tm = {
	483	.tm_sec = 43,
	484	.tm_min = 35,
	485	.tm_hour = 5,
	486	.tm_mday = 26,
	487	.tm_mon = 10,
	488	.tm_year = 118,
	489	};
	490
0b74d4d7	491	test("(%ptR?)", "%pt", &tm);
4d42c447 AS	492	test("2018-11-26T05:35:43", "%ptR", &tm);
	493	test("0118-10-26T05:35:43", "%ptRr", &tm);
	494	test("05:35:43\|2018-11-26", "%ptRt\|%ptRd", &tm, &tm);
	495	test("05:35:43\|0118-10-26", "%ptRtr\|%ptRdr", &tm, &tm);
	496	test("05:35:43\|2018-11-26", "%ptRttr\|%ptRdtr", &tm, &tm);
	497	test("05:35:43 tr\|2018-11-26 tr", "%ptRt tr\|%ptRd tr", &tm, &tm);
	498	}
	499
707cc728 RV	500	static void __init
	501	struct_clk(void)
	502	{
	503	}
	504
857cca4d RV	505	static void __init
	506	large_bitmap(void)
	507	{
	508	const int nbits = 1 << 16;
2821fd0c	509	unsigned long *bits = bitmap_zalloc(nbits, GFP_KERNEL);
857cca4d RV	510	if (!bits)
	511	return;
	512
	513	bitmap_set(bits, 1, 20);
	514	bitmap_set(bits, 60000, 15);
	515	test("1-20,60000-60014", "%*pbl", nbits, bits);
2821fd0c	516	bitmap_free(bits);
857cca4d RV	517	}
857cca4d RV	518
707cc728 RV	519	static void __init
	520	bitmap(void)
	521	{
	522	DECLARE_BITMAP(bits, 20);
	523	const int primes[] = {2,3,5,7,11,13,17,19};
	524	int i;
	525
	526	bitmap_zero(bits, 20);
	527	test("00000\|00000", "%20pb\|%*pb", bits, 20, bits);
	528	test("\|", "%20pbl\|%*pbl", bits, 20, bits);
	529
	530	for (i = 0; i < ARRAY_SIZE(primes); ++i)
	531	set_bit(primes[i], bits);
	532	test("a28ac\|a28ac", "%20pb\|%*pb", bits, 20, bits);
	533	test("2-3,5,7,11,13,17,19\|2-3,5,7,11,13,17,19", "%20pbl\|%*pbl", bits, 20, bits);
	534
	535	bitmap_fill(bits, 20);
	536	test("fffff\|fffff", "%20pb\|%*pb", bits, 20, bits);
	537	test("0-19\|0-19", "%20pbl\|%*pbl", bits, 20, bits);
857cca4d RV	538
857cca4d RV	539	large_bitmap();
707cc728 RV	540	}
	541
	542	static void __init
	543	netdev_features(void)
	544	{
	545	}
	546
edf14cdb VB	547	static void __init
	548	flags(void)
	549	{
	550	unsigned long flags;
	551	gfp_t gfp;
	552	char *cmp_buffer;
	553
	554	flags = 0;
	555	test("", "%pGp", &flags);
	556
	557	/* Page flags should filter the zone id */
	558	flags = 1UL << NR_PAGEFLAGS;
	559	test("", "%pGp", &flags);
	560
	561	flags \|= 1UL << PG_uptodate \| 1UL << PG_dirty \| 1UL << PG_lru
	562	\| 1UL << PG_active \| 1UL << PG_swapbacked;
	563	test("uptodate\|dirty\|lru\|active\|swapbacked", "%pGp", &flags);
	564
	565
	566	flags = VM_READ \| VM_EXEC \| VM_MAYREAD \| VM_MAYWRITE \| VM_MAYEXEC
	567	\| VM_DENYWRITE;
	568	test("read\|exec\|mayread\|maywrite\|mayexec\|denywrite", "%pGv", &flags);
	569
	570	gfp = GFP_TRANSHUGE;
	571	test("GFP_TRANSHUGE", "%pGg", &gfp);
	572
	573	gfp = GFP_ATOMIC\|__GFP_DMA;
	574	test("GFP_ATOMIC\|GFP_DMA", "%pGg", &gfp);
	575
	576	gfp = __GFP_ATOMIC;
	577	test("__GFP_ATOMIC", "%pGg", &gfp);
	578
	579	cmp_buffer = kmalloc(BUF_SIZE, GFP_KERNEL);
	580	if (!cmp_buffer)
	581	return;
	582
	583	/* Any flags not translated by the table should remain numeric */
	584	gfp = ~__GFP_BITS_MASK;
	585	snprintf(cmp_buffer, BUF_SIZE, "%#lx", (unsigned long) gfp);
	586	test(cmp_buffer, "%pGg", &gfp);
	587
	588	snprintf(cmp_buffer, BUF_SIZE, "__GFP_ATOMIC\|%#lx",
	589	(unsigned long) gfp);
	590	gfp \|= __GFP_ATOMIC;
	591	test(cmp_buffer, "%pGg", &gfp);
	592
	593	kfree(cmp_buffer);
	594	}
	595
707cc728 RV	596	static void __init
	597	test_pointer(void)
	598	{
	599	plain();
3e5903eb PM	600	null_pointer();
3e5903eb PM	601	invalid_pointer();
707cc728 RV	602	symbol_ptr();
	603	kernel_ptr();
	604	struct_resource();
	605	addr();
	606	escaped_str();
	607	hex_string();
	608	mac();
	609	ip();
	610	uuid();
	611	dentry();
	612	struct_va_format();
4d42c447	613	struct_rtc_time();
707cc728 RV	614	struct_clk();
	615	bitmap();
	616	netdev_features();
edf14cdb	617	flags();
707cc728 RV	618	}
707cc728 RV	619
6b1a4d5b	620	static void __init selftest(void)
707cc728	621	{
331e4deb RV	622	alloced_buffer = kmalloc(BUF_SIZE + 2*PAD_SIZE, GFP_KERNEL);
331e4deb RV	623	if (!alloced_buffer)
6b1a4d5b	624	return;
331e4deb	625	test_buffer = alloced_buffer + PAD_SIZE;
707cc728 RV	626
	627	test_basic();
	628	test_number();
	629	test_string();
	630	test_pointer();
	631
331e4deb	632	kfree(alloced_buffer);
707cc728 RV	633	}
707cc728 RV	634
6b1a4d5b	635	KSTM_MODULE_LOADERS(test_printf);
707cc728 RV	636	MODULE_AUTHOR("Rasmus Villemoes <[email protected]>");
707cc728 RV	637	MODULE_LICENSE("GPL");