[thirdparty/linux.git] / lib / test-string_helpers.c

/*
 * Test cases for lib/string_helpers.c module.
 */
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

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

static __init bool test_string_check_buf(const char *name, unsigned int flags,
					 char *in, size_t p,
					 char *out_real, size_t q_real,
					 char *out_test, size_t q_test)
{
	if (q_real == q_test && !memcmp(out_test, out_real, q_test))
		return true;

	pr_warn("Test '%s' failed: flags = %#x\n", name, flags);

	print_hex_dump(KERN_WARNING, "Input: ", DUMP_PREFIX_NONE, 16, 1,
		       in, p, true);
	print_hex_dump(KERN_WARNING, "Expected: ", DUMP_PREFIX_NONE, 16, 1,
		       out_test, q_test, true);
	print_hex_dump(KERN_WARNING, "Got: ", DUMP_PREFIX_NONE, 16, 1,
		       out_real, q_real, true);

	return false;
}

struct test_string {
	const char *in;
	const char *out;
	unsigned int flags;
};

static const struct test_string strings[] __initconst = {
	{
		.in = "\\f\\ \\n\\r\\t\\v",
		.out = "\f\\ \n\r\t\v",
		.flags = UNESCAPE_SPACE,
	},
	{
		.in = "\\40\\1\\387\\0064\\05\\040\\8a\\110\\777",
		.out = " \001\00387\0064\005 \\8aH?7",
		.flags = UNESCAPE_OCTAL,
	},
	{
		.in = "\\xv\\xa\\x2c\\xD\\x6f2",
		.out = "\\xv\n,\ro2",
		.flags = UNESCAPE_HEX,
	},
	{
		.in = "\\h\\\\\\\"\\a\\e\\",
		.out = "\\h\\\"\a\e\\",
		.flags = UNESCAPE_SPECIAL,
	},
};

static void __init test_string_unescape(const char *name, unsigned int flags,
					bool inplace)
{
	int q_real = 256;
	char *in = kmalloc(q_real, GFP_KERNEL);
	char *out_test = kmalloc(q_real, GFP_KERNEL);
	char *out_real = kmalloc(q_real, GFP_KERNEL);
	int i, p = 0, q_test = 0;

	if (!in || !out_test || !out_real)
		goto out;

	for (i = 0; i < ARRAY_SIZE(strings); i++) {
		const char *s = strings[i].in;
		int len = strlen(strings[i].in);

		/* Copy string to in buffer */
		memcpy(&in[p], s, len);
		p += len;

		/* Copy expected result for given flags */
		if (flags & strings[i].flags) {
			s = strings[i].out;
			len = strlen(strings[i].out);
		}
		memcpy(&out_test[q_test], s, len);
		q_test += len;
	}
	in[p++] = '\0';

	/* Call string_unescape and compare result */
	if (inplace) {
		memcpy(out_real, in, p);
		if (flags == UNESCAPE_ANY)
			q_real = string_unescape_any_inplace(out_real);
		else
			q_real = string_unescape_inplace(out_real, flags);
	} else if (flags == UNESCAPE_ANY) {
		q_real = string_unescape_any(in, out_real, q_real);
	} else {
		q_real = string_unescape(in, out_real, q_real, flags);
	}

	test_string_check_buf(name, flags, in, p - 1, out_real, q_real,
			      out_test, q_test);
out:
	kfree(out_real);
	kfree(out_test);
	kfree(in);
}

struct test_string_1 {
	const char *out;
	unsigned int flags;
};

#define	TEST_STRING_2_MAX_S1		32
struct test_string_2 {
	const char *in;
	struct test_string_1 s1[TEST_STRING_2_MAX_S1];
};

#define	TEST_STRING_2_DICT_0		NULL
static const struct test_string_2 escape0[] __initconst = {{
	.in = "\f\\ \n\r\t\v",
	.s1 = {{
		.out = "\\f\\ \\n\\r\\t\\v",
		.flags = ESCAPE_SPACE,
	},{
		.out = "\\f\\134\\040\\n\\r\\t\\v",
		.flags = ESCAPE_SPACE | ESCAPE_OCTAL,
	},{
		.out = "\\f\\x5c\\x20\\n\\r\\t\\v",
		.flags = ESCAPE_SPACE | ESCAPE_HEX,
	},{
		/* terminator */
	}},
},{
	.in = "\\h\\\"\a\e\\",
	.s1 = {{
		.out = "\\\\h\\\\\"\\a\\e\\\\",
		.flags = ESCAPE_SPECIAL,
	},{
		.out = "\\\\\\150\\\\\\042\\a\\e\\\\",
		.flags = ESCAPE_SPECIAL | ESCAPE_OCTAL,
	},{
		.out = "\\\\\\x68\\\\\\x22\\a\\e\\\\",
		.flags = ESCAPE_SPECIAL | ESCAPE_HEX,
	},{
		/* terminator */
	}},
},{
	.in = "\eb \\C\007\"\x90\r]",
	.s1 = {{
		.out = "\eb \\C\007\"\x90\\r]",
		.flags = ESCAPE_SPACE,
	},{
		.out = "\\eb \\\\C\\a\"\x90\r]",
		.flags = ESCAPE_SPECIAL,
	},{
		.out = "\\eb \\\\C\\a\"\x90\\r]",
		.flags = ESCAPE_SPACE | ESCAPE_SPECIAL,
	},{
		.out = "\\033\\142\\040\\134\\103\\007\\042\\220\\015\\135",
		.flags = ESCAPE_OCTAL,
	},{
		.out = "\\033\\142\\040\\134\\103\\007\\042\\220\\r\\135",
		.flags = ESCAPE_SPACE | ESCAPE_OCTAL,
	},{
		.out = "\\e\\142\\040\\\\\\103\\a\\042\\220\\015\\135",
		.flags = ESCAPE_SPECIAL | ESCAPE_OCTAL,
	},{
		.out = "\\e\\142\\040\\\\\\103\\a\\042\\220\\r\\135",
		.flags = ESCAPE_SPACE | ESCAPE_SPECIAL | ESCAPE_OCTAL,
	},{
		.out = "\eb \\C\007\"\x90\r]",
		.flags = ESCAPE_NP,
	},{
		.out = "\eb \\C\007\"\x90\\r]",
		.flags = ESCAPE_SPACE | ESCAPE_NP,
	},{
		.out = "\\eb \\C\\a\"\x90\r]",
		.flags = ESCAPE_SPECIAL | ESCAPE_NP,
	},{
		.out = "\\eb \\C\\a\"\x90\\r]",
		.flags = ESCAPE_SPACE | ESCAPE_SPECIAL | ESCAPE_NP,
	},{
		.out = "\\033b \\C\\007\"\\220\\015]",
		.flags = ESCAPE_OCTAL | ESCAPE_NP,
	},{
		.out = "\\033b \\C\\007\"\\220\\r]",
		.flags = ESCAPE_SPACE | ESCAPE_OCTAL | ESCAPE_NP,
	},{
		.out = "\\eb \\C\\a\"\\220\\r]",
		.flags = ESCAPE_SPECIAL | ESCAPE_SPACE | ESCAPE_OCTAL |
			 ESCAPE_NP,
	},{
		.out = "\\x1bb \\C\\x07\"\\x90\\x0d]",
		.flags = ESCAPE_NP | ESCAPE_HEX,
	},{
		/* terminator */
	}},
},{
	/* terminator */
}};

#define	TEST_STRING_2_DICT_1		"b\\ \t\r"
static const struct test_string_2 escape1[] __initconst = {{
	.in = "\f\\ \n\r\t\v",
	.s1 = {{
		.out = "\f\\134\\040\n\\015\\011\v",
		.flags = ESCAPE_OCTAL,
	},{
		.out = "\f\\x5c\\x20\n\\x0d\\x09\v",
		.flags = ESCAPE_HEX,
	},{
		/* terminator */
	}},
},{
	.in = "\\h\\\"\a\e\\",
	.s1 = {{
		.out = "\\134h\\134\"\a\e\\134",
		.flags = ESCAPE_OCTAL,
	},{
		/* terminator */
	}},
},{
	.in = "\eb \\C\007\"\x90\r]",
	.s1 = {{
		.out = "\e\\142\\040\\134C\007\"\x90\\015]",
		.flags = ESCAPE_OCTAL,
	},{
		/* terminator */
	}},
},{
	/* terminator */
}};

static const struct test_string strings_upper[] __initconst = {
	{
		.in = "abcdefgh1234567890test",
		.out = "ABCDEFGH1234567890TEST",
	},
	{
		.in = "abCdeFgH1234567890TesT",
		.out = "ABCDEFGH1234567890TEST",
	},
};

static const struct test_string strings_lower[] __initconst = {
	{
		.in = "ABCDEFGH1234567890TEST",
		.out = "abcdefgh1234567890test",
	},
	{
		.in = "abCdeFgH1234567890TesT",
		.out = "abcdefgh1234567890test",
	},
};

static __init const char *test_string_find_match(const struct test_string_2 *s2,
						 unsigned int flags)
{
	const struct test_string_1 *s1 = s2->s1;
	unsigned int i;

	if (!flags)
		return s2->in;

	/* Test cases are NULL-aware */
	flags &= ~ESCAPE_NULL;

	/* ESCAPE_OCTAL has a higher priority */
	if (flags & ESCAPE_OCTAL)
		flags &= ~ESCAPE_HEX;

	for (i = 0; i < TEST_STRING_2_MAX_S1 && s1->out; i++, s1++)
		if (s1->flags == flags)
			return s1->out;
	return NULL;
}

static __init void
test_string_escape_overflow(const char *in, int p, unsigned int flags, const char *esc,
			    int q_test, const char *name)
{
	int q_real;

	q_real = string_escape_mem(in, p, NULL, 0, flags, esc);
	if (q_real != q_test)
		pr_warn("Test '%s' failed: flags = %#x, osz = 0, expected %d, got %d\n",
			name, flags, q_test, q_real);
}

static __init void test_string_escape(const char *name,
				      const struct test_string_2 *s2,
				      unsigned int flags, const char *esc)
{
	size_t out_size = 512;
	char *out_test = kmalloc(out_size, GFP_KERNEL);
	char *out_real = kmalloc(out_size, GFP_KERNEL);
	char *in = kmalloc(256, GFP_KERNEL);
	int p = 0, q_test = 0;
	int q_real;

	if (!out_test || !out_real || !in)
		goto out;

	for (; s2->in; s2++) {
		const char *out;
		int len;

		/* NULL injection */
		if (flags & ESCAPE_NULL) {
			in[p++] = '\0';
			out_test[q_test++] = '\\';
			out_test[q_test++] = '0';
		}

		/* Don't try strings that have no output */
		out = test_string_find_match(s2, flags);
		if (!out)
			continue;

		/* Copy string to in buffer */
		len = strlen(s2->in);
		memcpy(&in[p], s2->in, len);
		p += len;

		/* Copy expected result for given flags */
		len = strlen(out);
		memcpy(&out_test[q_test], out, len);
		q_test += len;
	}

	q_real = string_escape_mem(in, p, out_real, out_size, flags, esc);

	test_string_check_buf(name, flags, in, p, out_real, q_real, out_test,
			      q_test);

	test_string_escape_overflow(in, p, flags, esc, q_test, name);

out:
	kfree(in);
	kfree(out_real);
	kfree(out_test);
}

#define string_get_size_maxbuf 16
#define test_string_get_size_one(size, blk_size, exp_result10, exp_result2)    \
	do {                                                                   \
		BUILD_BUG_ON(sizeof(exp_result10) >= string_get_size_maxbuf);  \
		BUILD_BUG_ON(sizeof(exp_result2) >= string_get_size_maxbuf);   \
		__test_string_get_size((size), (blk_size), (exp_result10),     \
				       (exp_result2));                         \
	} while (0)


static __init void test_string_get_size_check(const char *units,
					      const char *exp,
					      char *res,
					      const u64 size,
					      const u64 blk_size)
{
	if (!memcmp(res, exp, strlen(exp) + 1))
		return;

	res[string_get_size_maxbuf - 1] = '\0';

	pr_warn("Test 'test_string_get_size' failed!\n");
	pr_warn("string_get_size(size = %llu, blk_size = %llu, units = %s)\n",
		size, blk_size, units);
	pr_warn("expected: '%s', got '%s'\n", exp, res);
}

static __init void __test_string_get_size(const u64 size, const u64 blk_size,
					  const char *exp_result10,
					  const char *exp_result2)
{
	char buf10[string_get_size_maxbuf];
	char buf2[string_get_size_maxbuf];

	string_get_size(size, blk_size, STRING_UNITS_10, buf10, sizeof(buf10));
	string_get_size(size, blk_size, STRING_UNITS_2, buf2, sizeof(buf2));

	test_string_get_size_check("STRING_UNITS_10", exp_result10, buf10,
				   size, blk_size);

	test_string_get_size_check("STRING_UNITS_2", exp_result2, buf2,
				   size, blk_size);
}

static __init void test_string_get_size(void)
{
	/* small values */
	test_string_get_size_one(0, 512, "0 B", "0 B");
	test_string_get_size_one(1, 512, "512 B", "512 B");
	test_string_get_size_one(1100, 1, "1.10 kB", "1.07 KiB");

	/* normal values */
	test_string_get_size_one(16384, 512, "8.39 MB", "8.00 MiB");
	test_string_get_size_one(500118192, 512, "256 GB", "238 GiB");
	test_string_get_size_one(8192, 4096, "33.6 MB", "32.0 MiB");

	/* weird block sizes */
	test_string_get_size_one(3000, 1900, "5.70 MB", "5.44 MiB");

	/* huge values */
	test_string_get_size_one(U64_MAX, 4096, "75.6 ZB", "64.0 ZiB");
	test_string_get_size_one(4096, U64_MAX, "75.6 ZB", "64.0 ZiB");
}

static void __init test_string_upper_lower(void)
{
	char *dst;
	int i;

	for (i = 0; i < ARRAY_SIZE(strings_upper); i++) {
		const char *s = strings_upper[i].in;
		int len = strlen(strings_upper[i].in) + 1;

		dst = kmalloc(len, GFP_KERNEL);
		if (!dst)
			return;

		string_upper(dst, s);
		if (memcmp(dst, strings_upper[i].out, len)) {
			pr_warn("Test 'string_upper' failed : expected %s, got %s!\n",
				strings_upper[i].out, dst);
			kfree(dst);
			return;
		}
		kfree(dst);
	}

	for (i = 0; i < ARRAY_SIZE(strings_lower); i++) {
		const char *s = strings_lower[i].in;
		int len = strlen(strings_lower[i].in) + 1;

		dst = kmalloc(len, GFP_KERNEL);
		if (!dst)
			return;

		string_lower(dst, s);
		if (memcmp(dst, strings_lower[i].out, len)) {
			pr_warn("Test 'string_lower failed : : expected %s, got %s!\n",
				strings_lower[i].out, dst);
			kfree(dst);
			return;
		}
		kfree(dst);
	}
}

static int __init test_string_helpers_init(void)
{
	unsigned int i;

	pr_info("Running tests...\n");
	for (i = 0; i < UNESCAPE_ANY + 1; i++)
		test_string_unescape("unescape", i, false);
	test_string_unescape("unescape inplace",
			     get_random_int() % (UNESCAPE_ANY + 1), true);

	/* Without dictionary */
	for (i = 0; i < (ESCAPE_ANY_NP | ESCAPE_HEX) + 1; i++)
		test_string_escape("escape 0", escape0, i, TEST_STRING_2_DICT_0);

	/* With dictionary */
	for (i = 0; i < (ESCAPE_ANY_NP | ESCAPE_HEX) + 1; i++)
		test_string_escape("escape 1", escape1, i, TEST_STRING_2_DICT_1);

	/* Test string_get_size() */
	test_string_get_size();

	/* Test string upper(), string_lower() */
	test_string_upper_lower();

	return -EINVAL;
}
module_init(test_string_helpers_init);
MODULE_LICENSE("Dual BSD/GPL");
Commit	Line	Data
16c7fa05 AS	1	/*
	2	* Test cases for lib/string_helpers.c module.
	3	*/
	4	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	5
	6	#include <linux/init.h>
	7	#include <linux/kernel.h>
c8250381	8	#include <linux/slab.h>
16c7fa05 AS	9	#include <linux/module.h>
	10	#include <linux/random.h>
	11	#include <linux/string.h>
	12	#include <linux/string_helpers.h>
	13
45ff337a AS	14	static __init bool test_string_check_buf(const char *name, unsigned int flags,
	15	char *in, size_t p,
	16	char *out_real, size_t q_real,
	17	char *out_test, size_t q_test)
	18	{
	19	if (q_real == q_test && !memcmp(out_test, out_real, q_test))
	20	return true;
	21
229563b1	22	pr_warn("Test '%s' failed: flags = %#x\n", name, flags);
45ff337a AS	23
	24	print_hex_dump(KERN_WARNING, "Input: ", DUMP_PREFIX_NONE, 16, 1,
	25	in, p, true);
	26	print_hex_dump(KERN_WARNING, "Expected: ", DUMP_PREFIX_NONE, 16, 1,
	27	out_test, q_test, true);
	28	print_hex_dump(KERN_WARNING, "Got: ", DUMP_PREFIX_NONE, 16, 1,
	29	out_real, q_real, true);
	30
	31	return false;
	32	}
	33
16c7fa05 AS	34	struct test_string {
	35	const char *in;
	36	const char *out;
	37	unsigned int flags;
	38	};
	39
	40	static const struct test_string strings[] __initconst = {
	41	{
	42	.in = "\\f\\ \\n\\r\\t\\v",
	43	.out = "\f\\ \n\r\t\v",
	44	.flags = UNESCAPE_SPACE,
	45	},
	46	{
	47	.in = "\\40\\1\\387\\0064\\05\\040\\8a\\110\\777",
	48	.out = " \001\00387\0064\005 \\8aH?7",
	49	.flags = UNESCAPE_OCTAL,
	50	},
	51	{
	52	.in = "\\xv\\xa\\x2c\\xD\\x6f2",
	53	.out = "\\xv\n,\ro2",
	54	.flags = UNESCAPE_HEX,
	55	},
	56	{
	57	.in = "\\h\\\\\\\"\\a\\e\\",
	58	.out = "\\h\\\"\a\e\\",
	59	.flags = UNESCAPE_SPECIAL,
	60	},
	61	};
	62
45ff337a AS	63	static void __init test_string_unescape(const char *name, unsigned int flags,
45ff337a AS	64	bool inplace)
16c7fa05	65	{
c8250381 AS	66	int q_real = 256;
	67	char *in = kmalloc(q_real, GFP_KERNEL);
	68	char *out_test = kmalloc(q_real, GFP_KERNEL);
	69	char *out_real = kmalloc(q_real, GFP_KERNEL);
	70	int i, p = 0, q_test = 0;
	71
	72	if (!in \|\| !out_test \|\| !out_real)
	73	goto out;
16c7fa05 AS	74
	75	for (i = 0; i < ARRAY_SIZE(strings); i++) {
	76	const char *s = strings[i].in;
	77	int len = strlen(strings[i].in);
	78
	79	/* Copy string to in buffer */
	80	memcpy(&in[p], s, len);
	81	p += len;
	82
	83	/* Copy expected result for given flags */
	84	if (flags & strings[i].flags) {
	85	s = strings[i].out;
	86	len = strlen(strings[i].out);
	87	}
	88	memcpy(&out_test[q_test], s, len);
	89	q_test += len;
	90	}
	91	in[p++] = '\0';
	92
	93	/* Call string_unescape and compare result */
	94	if (inplace) {
	95	memcpy(out_real, in, p);
	96	if (flags == UNESCAPE_ANY)
	97	q_real = string_unescape_any_inplace(out_real);
	98	else
	99	q_real = string_unescape_inplace(out_real, flags);
	100	} else if (flags == UNESCAPE_ANY) {
	101	q_real = string_unescape_any(in, out_real, q_real);
	102	} else {
	103	q_real = string_unescape(in, out_real, q_real, flags);
	104	}
	105
45ff337a AS	106	test_string_check_buf(name, flags, in, p - 1, out_real, q_real,
45ff337a AS	107	out_test, q_test);
c8250381 AS	108	out:
	109	kfree(out_real);
	110	kfree(out_test);
	111	kfree(in);
	112	}
	113
	114	struct test_string_1 {
	115	const char *out;
	116	unsigned int flags;
	117	};
	118
	119	#define TEST_STRING_2_MAX_S1 32
	120	struct test_string_2 {
	121	const char *in;
	122	struct test_string_1 s1[TEST_STRING_2_MAX_S1];
	123	};
	124
	125	#define TEST_STRING_2_DICT_0 NULL
	126	static const struct test_string_2 escape0[] __initconst = {{
	127	.in = "\f\\ \n\r\t\v",
	128	.s1 = {{
	129	.out = "\\f\\ \\n\\r\\t\\v",
	130	.flags = ESCAPE_SPACE,
	131	},{
	132	.out = "\\f\\134\\040\\n\\r\\t\\v",
	133	.flags = ESCAPE_SPACE \| ESCAPE_OCTAL,
	134	},{
	135	.out = "\\f\\x5c\\x20\\n\\r\\t\\v",
	136	.flags = ESCAPE_SPACE \| ESCAPE_HEX,
	137	},{
	138	/* terminator */
	139	}},
	140	},{
	141	.in = "\\h\\\"\a\e\\",
	142	.s1 = {{
	143	.out = "\\\\h\\\\\"\\a\\e\\\\",
	144	.flags = ESCAPE_SPECIAL,
	145	},{
	146	.out = "\\\\\\150\\\\\\042\\a\\e\\\\",
	147	.flags = ESCAPE_SPECIAL \| ESCAPE_OCTAL,
	148	},{
	149	.out = "\\\\\\x68\\\\\\x22\\a\\e\\\\",
	150	.flags = ESCAPE_SPECIAL \| ESCAPE_HEX,
	151	},{
	152	/* terminator */
	153	}},
	154	},{
	155	.in = "\eb \\C\007\"\x90\r]",
	156	.s1 = {{
	157	.out = "\eb \\C\007\"\x90\\r]",
	158	.flags = ESCAPE_SPACE,
	159	},{
	160	.out = "\\eb \\\\C\\a\"\x90\r]",
	161	.flags = ESCAPE_SPECIAL,
	162	},{
	163	.out = "\\eb \\\\C\\a\"\x90\\r]",
	164	.flags = ESCAPE_SPACE \| ESCAPE_SPECIAL,
	165	},{
	166	.out = "\\033\\142\\040\\134\\103\\007\\042\\220\\015\\135",
	167	.flags = ESCAPE_OCTAL,
	168	},{
	169	.out = "\\033\\142\\040\\134\\103\\007\\042\\220\\r\\135",
	170	.flags = ESCAPE_SPACE \| ESCAPE_OCTAL,
	171	},{
172	.out = "\\e\\142\\040\\\\\\103\\a\\042\\220\\015\\135",
173	.flags = ESCAPE_SPECIAL \| ESCAPE_OCTAL,
174	},{
175	.out = "\\e\\142\\040\\\\\\103\\a\\042\\220\\r\\135",
176	.flags = ESCAPE_SPACE \| ESCAPE_SPECIAL \| ESCAPE_OCTAL,
177	},{
178	.out = "\eb \\C\007\"\x90\r]",
179	.flags = ESCAPE_NP,
180	},{
181	.out = "\eb \\C\007\"\x90\\r]",
182	.flags = ESCAPE_SPACE \| ESCAPE_NP,
183	},{
184	.out = "\\eb \\C\\a\"\x90\r]",
185	.flags = ESCAPE_SPECIAL \| ESCAPE_NP,
186	},{
187	.out = "\\eb \\C\\a\"\x90\\r]",
188	.flags = ESCAPE_SPACE \| ESCAPE_SPECIAL \| ESCAPE_NP,
189	},{
190	.out = "\\033b \\C\\007\"\\220\\015]",
191	.flags = ESCAPE_OCTAL \| ESCAPE_NP,
192	},{
193	.out = "\\033b \\C\\007\"\\220\\r]",
194	.flags = ESCAPE_SPACE \| ESCAPE_OCTAL \| ESCAPE_NP,
195	},{
196	.out = "\\eb \\C\\a\"\\220\\r]",
197	.flags = ESCAPE_SPECIAL \| ESCAPE_SPACE \| ESCAPE_OCTAL \|
198	ESCAPE_NP,
199	},{
200	.out = "\\x1bb \\C\\x07\"\\x90\\x0d]",
201	.flags = ESCAPE_NP \| ESCAPE_HEX,
202	},{
203	/* terminator */
204	}},
205	},{
206	/* terminator */
207	}};
208
209	#define TEST_STRING_2_DICT_1 "b\\ \t\r"
210	static const struct test_string_2 escape1[] __initconst = {{
211	.in = "\f\\ \n\r\t\v",
212	.s1 = {{
213	.out = "\f\\134\\040\n\\015\\011\v",
214	.flags = ESCAPE_OCTAL,
215	},{
216	.out = "\f\\x5c\\x20\n\\x0d\\x09\v",
217	.flags = ESCAPE_HEX,
218	},{
219	/* terminator */
220	}},
221	},{
222	.in = "\\h\\\"\a\e\\",
223	.s1 = {{
224	.out = "\\134h\\134\"\a\e\\134",
225	.flags = ESCAPE_OCTAL,
226	},{
227	/* terminator */
228	}},
229	},{
230	.in = "\eb \\C\007\"\x90\r]",
231	.s1 = {{
232	.out = "\e\\142\\040\\134C\007\"\x90\\015]",
233	.flags = ESCAPE_OCTAL,
234	},{
235	/* terminator */
236	}},
237	},{
238	/* terminator */
239	}};
240
1e0f548b VP	241	static const struct test_string strings_upper[] __initconst = {
	242	{
	243	.in = "abcdefgh1234567890test",
	244	.out = "ABCDEFGH1234567890TEST",
	245	},
	246	{
	247	.in = "abCdeFgH1234567890TesT",
	248	.out = "ABCDEFGH1234567890TEST",
	249	},
	250	};
	251
	252	static const struct test_string strings_lower[] __initconst = {
	253	{
	254	.in = "ABCDEFGH1234567890TEST",
	255	.out = "abcdefgh1234567890test",
	256	},
	257	{
	258	.in = "abCdeFgH1234567890TesT",
	259	.out = "abcdefgh1234567890test",
	260	},
	261	};
	262
c8250381 AS	263	static __init const char test_string_find_match(const struct test_string_2 s2,
	264	unsigned int flags)
	265	{
	266	const struct test_string_1 *s1 = s2->s1;
	267	unsigned int i;
	268
	269	if (!flags)
	270	return s2->in;
	271
	272	/* Test cases are NULL-aware */
	273	flags &= ~ESCAPE_NULL;
	274
	275	/* ESCAPE_OCTAL has a higher priority */
	276	if (flags & ESCAPE_OCTAL)
	277	flags &= ~ESCAPE_HEX;
	278
	279	for (i = 0; i < TEST_STRING_2_MAX_S1 && s1->out; i++, s1++)
	280	if (s1->flags == flags)
	281	return s1->out;
	282	return NULL;
	283	}
	284
41416f23 RV	285	static __init void
	286	test_string_escape_overflow(const char in, int p, unsigned int flags, const char esc,
	287	int q_test, const char *name)
	288	{
	289	int q_real;
	290
	291	q_real = string_escape_mem(in, p, NULL, 0, flags, esc);
	292	if (q_real != q_test)
229563b1	293	pr_warn("Test '%s' failed: flags = %#x, osz = 0, expected %d, got %d\n",
41416f23 RV	294	name, flags, q_test, q_real);
	295	}
	296
c8250381 AS	297	static __init void test_string_escape(const char *name,
	298	const struct test_string_2 *s2,
	299	unsigned int flags, const char *esc)
	300	{
41416f23 RV	301	size_t out_size = 512;
	302	char *out_test = kmalloc(out_size, GFP_KERNEL);
	303	char *out_real = kmalloc(out_size, GFP_KERNEL);
c8250381	304	char *in = kmalloc(256, GFP_KERNEL);
c8250381	305	int p = 0, q_test = 0;
41416f23	306	int q_real;
c8250381 AS	307
	308	if (!out_test \|\| !out_real \|\| !in)
	309	goto out;
	310
	311	for (; s2->in; s2++) {
	312	const char *out;
	313	int len;
	314
	315	/* NULL injection */
	316	if (flags & ESCAPE_NULL) {
	317	in[p++] = '\0';
	318	out_test[q_test++] = '\\';
	319	out_test[q_test++] = '0';
	320	}
	321
	322	/* Don't try strings that have no output */
	323	out = test_string_find_match(s2, flags);
	324	if (!out)
	325	continue;
	326
	327	/* Copy string to in buffer */
	328	len = strlen(s2->in);
	329	memcpy(&in[p], s2->in, len);
	330	p += len;
	331
	332	/* Copy expected result for given flags */
	333	len = strlen(out);
	334	memcpy(&out_test[q_test], out, len);
	335	q_test += len;
	336	}
	337
41416f23	338	q_real = string_escape_mem(in, p, out_real, out_size, flags, esc);
c8250381 AS	339
	340	test_string_check_buf(name, flags, in, p, out_real, q_real, out_test,
	341	q_test);
41416f23 RV	342
	343	test_string_escape_overflow(in, p, flags, esc, q_test, name);
	344
c8250381 AS	345	out:
	346	kfree(in);
	347	kfree(out_real);
	348	kfree(out_test);
	349	}
	350
943ba650	351	#define string_get_size_maxbuf 16
72676bb5	352	#define test_string_get_size_one(size, blk_size, exp_result10, exp_result2) \
943ba650	353	do { \
72676bb5 VK	354	BUILD_BUG_ON(sizeof(exp_result10) >= string_get_size_maxbuf); \
	355	BUILD_BUG_ON(sizeof(exp_result2) >= string_get_size_maxbuf); \
	356	__test_string_get_size((size), (blk_size), (exp_result10), \
	357	(exp_result2)); \
943ba650 VK	358	} while (0)
	359
	360
72676bb5 VK	361	static __init void test_string_get_size_check(const char *units,
	362	const char *exp,
	363	char *res,
	364	const u64 size,
	365	const u64 blk_size)
943ba650	366	{
72676bb5	367	if (!memcmp(res, exp, strlen(exp) + 1))
943ba650 VK	368	return;
943ba650 VK	369
72676bb5 VK	370	res[string_get_size_maxbuf - 1] = '\0';
	371
	372	pr_warn("Test 'test_string_get_size' failed!\n");
	373	pr_warn("string_get_size(size = %llu, blk_size = %llu, units = %s)\n",
943ba650	374	size, blk_size, units);
72676bb5 VK	375	pr_warn("expected: '%s', got '%s'\n", exp, res);
	376	}
	377
	378	static __init void __test_string_get_size(const u64 size, const u64 blk_size,
	379	const char *exp_result10,
	380	const char *exp_result2)
	381	{
	382	char buf10[string_get_size_maxbuf];
	383	char buf2[string_get_size_maxbuf];
	384
	385	string_get_size(size, blk_size, STRING_UNITS_10, buf10, sizeof(buf10));
	386	string_get_size(size, blk_size, STRING_UNITS_2, buf2, sizeof(buf2));
	387
	388	test_string_get_size_check("STRING_UNITS_10", exp_result10, buf10,
	389	size, blk_size);
	390
	391	test_string_get_size_check("STRING_UNITS_2", exp_result2, buf2,
	392	size, blk_size);
943ba650 VK	393	}
	394
	395	static __init void test_string_get_size(void)
	396	{
72676bb5 VK	397	/* small values */
	398	test_string_get_size_one(0, 512, "0 B", "0 B");
	399	test_string_get_size_one(1, 512, "512 B", "512 B");
	400	test_string_get_size_one(1100, 1, "1.10 kB", "1.07 KiB");
	401
	402	/* normal values */
	403	test_string_get_size_one(16384, 512, "8.39 MB", "8.00 MiB");
	404	test_string_get_size_one(500118192, 512, "256 GB", "238 GiB");
	405	test_string_get_size_one(8192, 4096, "33.6 MB", "32.0 MiB");
	406
	407	/* weird block sizes */
	408	test_string_get_size_one(3000, 1900, "5.70 MB", "5.44 MiB");
	409
	410	/* huge values */
	411	test_string_get_size_one(U64_MAX, 4096, "75.6 ZB", "64.0 ZiB");
	412	test_string_get_size_one(4096, U64_MAX, "75.6 ZB", "64.0 ZiB");
943ba650 VK	413	}
943ba650 VK	414
1e0f548b VP	415	static void __init test_string_upper_lower(void)
	416	{
	417	char *dst;
	418	int i;
	419
	420	for (i = 0; i < ARRAY_SIZE(strings_upper); i++) {
	421	const char *s = strings_upper[i].in;
	422	int len = strlen(strings_upper[i].in) + 1;
	423
	424	dst = kmalloc(len, GFP_KERNEL);
	425	if (!dst)
	426	return;
	427
	428	string_upper(dst, s);
	429	if (memcmp(dst, strings_upper[i].out, len)) {
	430	pr_warn("Test 'string_upper' failed : expected %s, got %s!\n",
	431	strings_upper[i].out, dst);
	432	kfree(dst);
	433	return;
	434	}
	435	kfree(dst);
	436	}
	437
	438	for (i = 0; i < ARRAY_SIZE(strings_lower); i++) {
	439	const char *s = strings_lower[i].in;
	440	int len = strlen(strings_lower[i].in) + 1;
	441
	442	dst = kmalloc(len, GFP_KERNEL);
	443	if (!dst)
	444	return;
	445
	446	string_lower(dst, s);
	447	if (memcmp(dst, strings_lower[i].out, len)) {
	448	pr_warn("Test 'string_lower failed : : expected %s, got %s!\n",
	449	strings_lower[i].out, dst);
	450	kfree(dst);
	451	return;
	452	}
	453	kfree(dst);
	454	}
	455	}
	456
16c7fa05 AS	457	static int __init test_string_helpers_init(void)
	458	{
	459	unsigned int i;
	460
	461	pr_info("Running tests...\n");
	462	for (i = 0; i < UNESCAPE_ANY + 1; i++)
45ff337a AS	463	test_string_unescape("unescape", i, false);
	464	test_string_unescape("unescape inplace",
	465	get_random_int() % (UNESCAPE_ANY + 1), true);
16c7fa05	466
c8250381 AS	467	/* Without dictionary */
	468	for (i = 0; i < (ESCAPE_ANY_NP \| ESCAPE_HEX) + 1; i++)
	469	test_string_escape("escape 0", escape0, i, TEST_STRING_2_DICT_0);
	470
	471	/* With dictionary */
	472	for (i = 0; i < (ESCAPE_ANY_NP \| ESCAPE_HEX) + 1; i++)
	473	test_string_escape("escape 1", escape1, i, TEST_STRING_2_DICT_1);
	474
943ba650 VK	475	/* Test string_get_size() */
	476	test_string_get_size();
	477
1e0f548b VP	478	/* Test string upper(), string_lower() */
	479	test_string_upper_lower();
	480
16c7fa05 AS	481	return -EINVAL;
	482	}
	483	module_init(test_string_helpers_init);
	484	MODULE_LICENSE("Dual BSD/GPL");