1 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
3 * Test cases for lib/string_helpers.c module.
5 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7 #include <kunit/test.h>
8 #include <linux/array_size.h>
9 #include <linux/kernel.h>
10 #include <linux/random.h>
11 #include <linux/string.h>
12 #include <linux/string_helpers.h>
14 static void test_string_check_buf(struct kunit
*test
,
15 const char *name
, unsigned int flags
,
17 char *out_real
, size_t q_real
,
18 char *out_test
, size_t q_test
)
20 KUNIT_ASSERT_EQ_MSG(test
, q_real
, q_test
, "name:%s", name
);
21 KUNIT_EXPECT_MEMEQ_MSG(test
, out_test
, out_real
, q_test
,
31 static const struct test_string strings
[] = {
33 .in
= "\\f\\ \\n\\r\\t\\v",
34 .out
= "\f\\ \n\r\t\v",
35 .flags
= UNESCAPE_SPACE
,
38 .in
= "\\40\\1\\387\\0064\\05\\040\\8a\\110\\777",
39 .out
= " \001\00387\0064\005 \\8aH?7",
40 .flags
= UNESCAPE_OCTAL
,
43 .in
= "\\xv\\xa\\x2c\\xD\\x6f2",
45 .flags
= UNESCAPE_HEX
,
48 .in
= "\\h\\\\\\\"\\a\\e\\",
49 .out
= "\\h\\\"\a\e\\",
50 .flags
= UNESCAPE_SPECIAL
,
54 static void test_string_unescape(struct kunit
*test
,
55 const char *name
, unsigned int flags
,
59 char *in
= kunit_kzalloc(test
, q_real
, GFP_KERNEL
);
60 char *out_test
= kunit_kzalloc(test
, q_real
, GFP_KERNEL
);
61 char *out_real
= kunit_kzalloc(test
, q_real
, GFP_KERNEL
);
62 int i
, p
= 0, q_test
= 0;
64 KUNIT_ASSERT_NOT_ERR_OR_NULL(test
, in
);
65 KUNIT_ASSERT_NOT_ERR_OR_NULL(test
, out_test
);
66 KUNIT_ASSERT_NOT_ERR_OR_NULL(test
, out_real
);
68 for (i
= 0; i
< ARRAY_SIZE(strings
); i
++) {
69 const char *s
= strings
[i
].in
;
70 int len
= strlen(strings
[i
].in
);
72 /* Copy string to in buffer */
73 memcpy(&in
[p
], s
, len
);
76 /* Copy expected result for given flags */
77 if (flags
& strings
[i
].flags
) {
79 len
= strlen(strings
[i
].out
);
81 memcpy(&out_test
[q_test
], s
, len
);
86 /* Call string_unescape and compare result */
88 memcpy(out_real
, in
, p
);
89 if (flags
== UNESCAPE_ANY
)
90 q_real
= string_unescape_any_inplace(out_real
);
92 q_real
= string_unescape_inplace(out_real
, flags
);
93 } else if (flags
== UNESCAPE_ANY
) {
94 q_real
= string_unescape_any(in
, out_real
, q_real
);
96 q_real
= string_unescape(in
, out_real
, q_real
, flags
);
99 test_string_check_buf(test
, name
, flags
, in
, p
- 1, out_real
, q_real
,
103 struct test_string_1
{
108 #define TEST_STRING_2_MAX_S1 32
109 struct test_string_2
{
111 struct test_string_1 s1
[TEST_STRING_2_MAX_S1
];
114 #define TEST_STRING_2_DICT_0 NULL
115 static const struct test_string_2 escape0
[] = {{
116 .in
= "\f\\ \n\r\t\v",
118 .out
= "\\f\\ \\n\\r\\t\\v",
119 .flags
= ESCAPE_SPACE
,
121 .out
= "\\f\\134\\040\\n\\r\\t\\v",
122 .flags
= ESCAPE_SPACE
| ESCAPE_OCTAL
,
124 .out
= "\\f\\x5c\\x20\\n\\r\\t\\v",
125 .flags
= ESCAPE_SPACE
| ESCAPE_HEX
,
130 .in
= "\\h\\\"\a\e\\",
132 .out
= "\\\\h\\\\\\\"\\a\\e\\\\",
133 .flags
= ESCAPE_SPECIAL
,
135 .out
= "\\\\\\150\\\\\\\"\\a\\e\\\\",
136 .flags
= ESCAPE_SPECIAL
| ESCAPE_OCTAL
,
138 .out
= "\\\\\\x68\\\\\\\"\\a\\e\\\\",
139 .flags
= ESCAPE_SPECIAL
| ESCAPE_HEX
,
144 .in
= "\eb \\C\007\"\x90\r]",
146 .out
= "\eb \\C\007\"\x90\\r]",
147 .flags
= ESCAPE_SPACE
,
149 .out
= "\\eb \\\\C\\a\\\"\x90\r]",
150 .flags
= ESCAPE_SPECIAL
,
152 .out
= "\\eb \\\\C\\a\\\"\x90\\r]",
153 .flags
= ESCAPE_SPACE
| ESCAPE_SPECIAL
,
155 .out
= "\\033\\142\\040\\134\\103\\007\\042\\220\\015\\135",
156 .flags
= ESCAPE_OCTAL
,
158 .out
= "\\033\\142\\040\\134\\103\\007\\042\\220\\r\\135",
159 .flags
= ESCAPE_SPACE
| ESCAPE_OCTAL
,
161 .out
= "\\e\\142\\040\\\\\\103\\a\\\"\\220\\015\\135",
162 .flags
= ESCAPE_SPECIAL
| ESCAPE_OCTAL
,
164 .out
= "\\e\\142\\040\\\\\\103\\a\\\"\\220\\r\\135",
165 .flags
= ESCAPE_SPACE
| ESCAPE_SPECIAL
| ESCAPE_OCTAL
,
167 .out
= "\eb \\C\007\"\x90\r]",
170 .out
= "\eb \\C\007\"\x90\\r]",
171 .flags
= ESCAPE_SPACE
| ESCAPE_NP
,
173 .out
= "\\eb \\C\\a\"\x90\r]",
174 .flags
= ESCAPE_SPECIAL
| ESCAPE_NP
,
176 .out
= "\\eb \\C\\a\"\x90\\r]",
177 .flags
= ESCAPE_SPACE
| ESCAPE_SPECIAL
| ESCAPE_NP
,
179 .out
= "\\033b \\C\\007\"\\220\\015]",
180 .flags
= ESCAPE_OCTAL
| ESCAPE_NP
,
182 .out
= "\\033b \\C\\007\"\\220\\r]",
183 .flags
= ESCAPE_SPACE
| ESCAPE_OCTAL
| ESCAPE_NP
,
185 .out
= "\\eb \\C\\a\"\\220\\r]",
186 .flags
= ESCAPE_SPECIAL
| ESCAPE_SPACE
| ESCAPE_OCTAL
|
189 .out
= "\\x1bb \\C\\x07\"\\x90\\x0d]",
190 .flags
= ESCAPE_NP
| ESCAPE_HEX
,
195 .in
= "\007 \eb\"\x90\xCF\r",
197 .out
= "\007 \eb\"\\220\\317\r",
198 .flags
= ESCAPE_OCTAL
| ESCAPE_NA
,
200 .out
= "\007 \eb\"\\x90\\xcf\r",
201 .flags
= ESCAPE_HEX
| ESCAPE_NA
,
203 .out
= "\007 \eb\"\x90\xCF\r",
212 #define TEST_STRING_2_DICT_1 "b\\ \t\r\xCF"
213 static const struct test_string_2 escape1
[] = {{
214 .in
= "\f\\ \n\r\t\v",
216 .out
= "\f\\134\\040\n\\015\\011\v",
217 .flags
= ESCAPE_OCTAL
,
219 .out
= "\f\\x5c\\x20\n\\x0d\\x09\v",
222 .out
= "\f\\134\\040\n\\015\\011\v",
223 .flags
= ESCAPE_ANY
| ESCAPE_APPEND
,
225 .out
= "\\014\\134\\040\\012\\015\\011\\013",
226 .flags
= ESCAPE_OCTAL
| ESCAPE_APPEND
| ESCAPE_NAP
,
228 .out
= "\\x0c\\x5c\\x20\\x0a\\x0d\\x09\\x0b",
229 .flags
= ESCAPE_HEX
| ESCAPE_APPEND
| ESCAPE_NAP
,
231 .out
= "\f\\134\\040\n\\015\\011\v",
232 .flags
= ESCAPE_OCTAL
| ESCAPE_APPEND
| ESCAPE_NA
,
234 .out
= "\f\\x5c\\x20\n\\x0d\\x09\v",
235 .flags
= ESCAPE_HEX
| ESCAPE_APPEND
| ESCAPE_NA
,
240 .in
= "\\h\\\"\a\xCF\e\\",
242 .out
= "\\134h\\134\"\a\\317\e\\134",
243 .flags
= ESCAPE_OCTAL
,
245 .out
= "\\134h\\134\"\a\\317\e\\134",
246 .flags
= ESCAPE_ANY
| ESCAPE_APPEND
,
248 .out
= "\\134h\\134\"\\007\\317\\033\\134",
249 .flags
= ESCAPE_OCTAL
| ESCAPE_APPEND
| ESCAPE_NAP
,
251 .out
= "\\134h\\134\"\a\\317\e\\134",
252 .flags
= ESCAPE_OCTAL
| ESCAPE_APPEND
| ESCAPE_NA
,
257 .in
= "\eb \\C\007\"\x90\r]",
259 .out
= "\e\\142\\040\\134C\007\"\x90\\015]",
260 .flags
= ESCAPE_OCTAL
,
265 .in
= "\007 \eb\"\x90\xCF\r",
267 .out
= "\007 \eb\"\x90\xCF\r",
270 .out
= "\007 \eb\"\x90\xCF\r",
271 .flags
= ESCAPE_SPACE
| ESCAPE_NA
,
273 .out
= "\007 \eb\"\x90\xCF\r",
274 .flags
= ESCAPE_SPECIAL
| ESCAPE_NA
,
276 .out
= "\007 \eb\"\x90\xCF\r",
277 .flags
= ESCAPE_SPACE
| ESCAPE_SPECIAL
| ESCAPE_NA
,
279 .out
= "\007 \eb\"\x90\\317\r",
280 .flags
= ESCAPE_OCTAL
| ESCAPE_NA
,
282 .out
= "\007 \eb\"\x90\\317\r",
283 .flags
= ESCAPE_SPACE
| ESCAPE_OCTAL
| ESCAPE_NA
,
285 .out
= "\007 \eb\"\x90\\317\r",
286 .flags
= ESCAPE_SPECIAL
| ESCAPE_OCTAL
| ESCAPE_NA
,
288 .out
= "\007 \eb\"\x90\\317\r",
289 .flags
= ESCAPE_ANY
| ESCAPE_NA
,
291 .out
= "\007 \eb\"\x90\\xcf\r",
292 .flags
= ESCAPE_HEX
| ESCAPE_NA
,
294 .out
= "\007 \eb\"\x90\\xcf\r",
295 .flags
= ESCAPE_SPACE
| ESCAPE_HEX
| ESCAPE_NA
,
297 .out
= "\007 \eb\"\x90\\xcf\r",
298 .flags
= ESCAPE_SPECIAL
| ESCAPE_HEX
| ESCAPE_NA
,
300 .out
= "\007 \eb\"\x90\\xcf\r",
301 .flags
= ESCAPE_SPACE
| ESCAPE_SPECIAL
| ESCAPE_HEX
| ESCAPE_NA
,
306 .in
= "\007 \eb\"\x90\xCF\r",
308 .out
= "\007 \eb\"\x90\xCF\r",
311 .out
= "\007 \eb\"\x90\xCF\\r",
312 .flags
= ESCAPE_SPACE
| ESCAPE_NAP
,
314 .out
= "\007 \eb\"\x90\xCF\r",
315 .flags
= ESCAPE_SPECIAL
| ESCAPE_NAP
,
317 .out
= "\007 \eb\"\x90\xCF\\r",
318 .flags
= ESCAPE_SPACE
| ESCAPE_SPECIAL
| ESCAPE_NAP
,
320 .out
= "\007 \eb\"\x90\\317\\015",
321 .flags
= ESCAPE_OCTAL
| ESCAPE_NAP
,
323 .out
= "\007 \eb\"\x90\\317\\r",
324 .flags
= ESCAPE_SPACE
| ESCAPE_OCTAL
| ESCAPE_NAP
,
326 .out
= "\007 \eb\"\x90\\317\\015",
327 .flags
= ESCAPE_SPECIAL
| ESCAPE_OCTAL
| ESCAPE_NAP
,
329 .out
= "\007 \eb\"\x90\\317\r",
330 .flags
= ESCAPE_ANY
| ESCAPE_NAP
,
332 .out
= "\007 \eb\"\x90\\xcf\\x0d",
333 .flags
= ESCAPE_HEX
| ESCAPE_NAP
,
335 .out
= "\007 \eb\"\x90\\xcf\\r",
336 .flags
= ESCAPE_SPACE
| ESCAPE_HEX
| ESCAPE_NAP
,
338 .out
= "\007 \eb\"\x90\\xcf\\x0d",
339 .flags
= ESCAPE_SPECIAL
| ESCAPE_HEX
| ESCAPE_NAP
,
341 .out
= "\007 \eb\"\x90\\xcf\\r",
342 .flags
= ESCAPE_SPACE
| ESCAPE_SPECIAL
| ESCAPE_HEX
| ESCAPE_NAP
,
350 static const struct test_string strings_upper
[] = {
352 .in
= "abcdefgh1234567890test",
353 .out
= "ABCDEFGH1234567890TEST",
356 .in
= "abCdeFgH1234567890TesT",
357 .out
= "ABCDEFGH1234567890TEST",
361 static const struct test_string strings_lower
[] = {
363 .in
= "ABCDEFGH1234567890TEST",
364 .out
= "abcdefgh1234567890test",
367 .in
= "abCdeFgH1234567890TesT",
368 .out
= "abcdefgh1234567890test",
372 static const char *test_string_find_match(const struct test_string_2
*s2
,
375 const struct test_string_1
*s1
= s2
->s1
;
381 /* Test cases are NULL-aware */
382 flags
&= ~ESCAPE_NULL
;
384 /* ESCAPE_OCTAL has a higher priority */
385 if (flags
& ESCAPE_OCTAL
)
386 flags
&= ~ESCAPE_HEX
;
388 for (i
= 0; i
< TEST_STRING_2_MAX_S1
&& s1
->out
; i
++, s1
++)
389 if (s1
->flags
== flags
)
395 test_string_escape_overflow(struct kunit
*test
,
396 const char *in
, int p
, unsigned int flags
, const char *esc
,
397 int q_test
, const char *name
)
401 q_real
= string_escape_mem(in
, p
, NULL
, 0, flags
, esc
);
402 KUNIT_EXPECT_EQ_MSG(test
, q_real
, q_test
, "name:%s: flags:%#x", name
, flags
);
405 static void test_string_escape(struct kunit
*test
, const char *name
,
406 const struct test_string_2
*s2
,
407 unsigned int flags
, const char *esc
)
409 size_t out_size
= 512;
410 char *out_test
= kunit_kzalloc(test
, out_size
, GFP_KERNEL
);
411 char *out_real
= kunit_kzalloc(test
, out_size
, GFP_KERNEL
);
412 char *in
= kunit_kzalloc(test
, 256, GFP_KERNEL
);
413 int p
= 0, q_test
= 0;
416 KUNIT_ASSERT_NOT_ERR_OR_NULL(test
, out_test
);
417 KUNIT_ASSERT_NOT_ERR_OR_NULL(test
, out_real
);
418 KUNIT_ASSERT_NOT_ERR_OR_NULL(test
, in
);
420 for (; s2
->in
; s2
++) {
425 if (flags
& ESCAPE_NULL
) {
427 /* '\0' passes isascii() test */
428 if (flags
& ESCAPE_NA
&& !(flags
& ESCAPE_APPEND
&& esc
)) {
429 out_test
[q_test
++] = '\0';
431 out_test
[q_test
++] = '\\';
432 out_test
[q_test
++] = '0';
436 /* Don't try strings that have no output */
437 out
= test_string_find_match(s2
, flags
);
441 /* Copy string to in buffer */
442 len
= strlen(s2
->in
);
443 memcpy(&in
[p
], s2
->in
, len
);
446 /* Copy expected result for given flags */
448 memcpy(&out_test
[q_test
], out
, len
);
452 q_real
= string_escape_mem(in
, p
, out_real
, out_size
, flags
, esc
);
454 test_string_check_buf(test
, name
, flags
, in
, p
, out_real
, q_real
, out_test
,
457 test_string_escape_overflow(test
, in
, p
, flags
, esc
, q_test
, name
);
460 #define string_get_size_maxbuf 16
461 #define test_string_get_size_one(size, blk_size, exp_result10, exp_result2) \
463 BUILD_BUG_ON(sizeof(exp_result10) >= string_get_size_maxbuf); \
464 BUILD_BUG_ON(sizeof(exp_result2) >= string_get_size_maxbuf); \
465 __test_string_get_size(test, (size), (blk_size), (exp_result10), \
470 static void test_string_get_size_check(struct kunit
*test
,
477 KUNIT_EXPECT_MEMEQ_MSG(test
, res
, exp
, strlen(exp
) + 1,
478 "string_get_size(size = %llu, blk_size = %llu, units = %s)",
479 size
, blk_size
, units
);
482 static void __strchrcut(char *dst
, const char *src
, const char *cut
)
484 const char *from
= src
;
488 len
= strcspn(from
, cut
);
489 memcpy(dst
, from
, len
);
496 static void __test_string_get_size_one(struct kunit
*test
,
497 const u64 size
, const u64 blk_size
,
498 const char *exp_result10
,
499 const char *exp_result2
,
500 enum string_size_units units
,
503 char buf10
[string_get_size_maxbuf
];
504 char buf2
[string_get_size_maxbuf
];
505 char exp10
[string_get_size_maxbuf
];
506 char exp2
[string_get_size_maxbuf
];
510 sprintf(prefix10
, "STRING_UNITS_10 [%s]", cut
);
511 sprintf(prefix2
, "STRING_UNITS_2 [%s]", cut
);
513 __strchrcut(exp10
, exp_result10
, cut
);
514 __strchrcut(exp2
, exp_result2
, cut
);
516 string_get_size(size
, blk_size
, STRING_UNITS_10
| units
, buf10
, sizeof(buf10
));
517 string_get_size(size
, blk_size
, STRING_UNITS_2
| units
, buf2
, sizeof(buf2
));
519 test_string_get_size_check(test
, prefix10
, exp10
, buf10
, size
, blk_size
);
520 test_string_get_size_check(test
, prefix2
, exp2
, buf2
, size
, blk_size
);
523 static void __test_string_get_size(struct kunit
*test
,
524 const u64 size
, const u64 blk_size
,
525 const char *exp_result10
,
526 const char *exp_result2
)
529 enum string_size_units units
;
531 } get_size_test_cases
[] = {
533 { STRING_UNITS_NO_SPACE
, " " },
534 { STRING_UNITS_NO_SPACE
| STRING_UNITS_NO_BYTES
, " B" },
535 { STRING_UNITS_NO_BYTES
, "B" },
539 for (i
= 0; i
< ARRAY_SIZE(get_size_test_cases
); i
++)
540 __test_string_get_size_one(test
, size
, blk_size
,
541 exp_result10
, exp_result2
,
542 get_size_test_cases
[i
].units
,
543 get_size_test_cases
[i
].cut
);
546 static void test_get_size(struct kunit
*test
)
549 test_string_get_size_one(0, 512, "0 B", "0 B");
550 test_string_get_size_one(1, 512, "512 B", "512 B");
551 test_string_get_size_one(1100, 1, "1.10 kB", "1.07 KiB");
554 test_string_get_size_one(16384, 512, "8.39 MB", "8.00 MiB");
555 test_string_get_size_one(500118192, 512, "256 GB", "238 GiB");
556 test_string_get_size_one(8192, 4096, "33.6 MB", "32.0 MiB");
558 /* weird block sizes */
559 test_string_get_size_one(3000, 1900, "5.70 MB", "5.44 MiB");
562 test_string_get_size_one(U64_MAX
, 4096, "75.6 ZB", "64.0 ZiB");
563 test_string_get_size_one(4096, U64_MAX
, "75.6 ZB", "64.0 ZiB");
566 static void test_upper_lower(struct kunit
*test
)
571 for (i
= 0; i
< ARRAY_SIZE(strings_upper
); i
++) {
572 const char *s
= strings_upper
[i
].in
;
573 int len
= strlen(strings_upper
[i
].in
) + 1;
575 dst
= kmalloc(len
, GFP_KERNEL
);
576 KUNIT_ASSERT_NOT_NULL(test
, dst
);
578 string_upper(dst
, s
);
579 KUNIT_EXPECT_STREQ(test
, dst
, strings_upper
[i
].out
);
583 for (i
= 0; i
< ARRAY_SIZE(strings_lower
); i
++) {
584 const char *s
= strings_lower
[i
].in
;
585 int len
= strlen(strings_lower
[i
].in
) + 1;
587 dst
= kmalloc(len
, GFP_KERNEL
);
588 KUNIT_ASSERT_NOT_NULL(test
, dst
);
590 string_lower(dst
, s
);
591 KUNIT_EXPECT_STREQ(test
, dst
, strings_lower
[i
].out
);
596 static void test_unescape(struct kunit
*test
)
600 for (i
= 0; i
< UNESCAPE_ALL_MASK
+ 1; i
++)
601 test_string_unescape(test
, "unescape", i
, false);
602 test_string_unescape(test
, "unescape inplace",
603 get_random_u32_below(UNESCAPE_ALL_MASK
+ 1), true);
605 /* Without dictionary */
606 for (i
= 0; i
< ESCAPE_ALL_MASK
+ 1; i
++)
607 test_string_escape(test
, "escape 0", escape0
, i
, TEST_STRING_2_DICT_0
);
609 /* With dictionary */
610 for (i
= 0; i
< ESCAPE_ALL_MASK
+ 1; i
++)
611 test_string_escape(test
, "escape 1", escape1
, i
, TEST_STRING_2_DICT_1
);
614 static struct kunit_case string_helpers_test_cases
[] = {
615 KUNIT_CASE(test_get_size
),
616 KUNIT_CASE(test_upper_lower
),
617 KUNIT_CASE(test_unescape
),
621 static struct kunit_suite string_helpers_test_suite
= {
622 .name
= "string_helpers",
623 .test_cases
= string_helpers_test_cases
,
626 kunit_test_suites(&string_helpers_test_suite
);
628 MODULE_DESCRIPTION("Test cases for string helpers module");
629 MODULE_LICENSE("Dual BSD/GPL");