1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Tests for setexpr command
4 *
5 * Copyright 2020 Google LLC
6 * Written by Simon Glass <sjg@chromium.org>
7 */
8
9 #include <common.h>
10 #include <console.h>
11 #include <mapmem.h>
12 #include <dm/test.h>
13 #include <test/suites.h>
14 #include <test/ut.h>
15
16 #define BUF_SIZE 0x100
17
18 /* Declare a new setexpr test */
19 #define SETEXPR_TEST(_name, _flags) UNIT_TEST(_name, _flags, setexpr_test)
20
21 /* Test 'setexpr' command with simply setting integers */
setexpr_test_int(struct unit_test_state * uts)22 static int setexpr_test_int(struct unit_test_state *uts)
23 {
24 u8 *buf;
25
26 buf = map_sysmem(0, BUF_SIZE);
27 memset(buf, '\xff', BUF_SIZE);
28
29 /* byte */
30 buf[0x0] = 0x12;
31 ut_assertok(run_command("setexpr.b fred 0", 0));
32 ut_asserteq_str("0", env_get("fred"));
33 ut_assertok(run_command("setexpr.b fred *0", 0));
34 ut_asserteq_str("12", env_get("fred"));
35
36 /* 16-bit */
37 *(short *)buf = 0x2345;
38 ut_assertok(run_command("setexpr.w fred 0", 0));
39 ut_asserteq_str("0", env_get("fred"));
40 ut_assertok(run_command("setexpr.w fred *0", 0));
41 ut_asserteq_str("2345", env_get("fred"));
42
43 /* 32-bit */
44 *(u32 *)buf = 0x3456789a;
45 ut_assertok(run_command("setexpr.l fred 0", 0));
46 ut_asserteq_str("0", env_get("fred"));
47 ut_assertok(run_command("setexpr.l fred *0", 0));
48 ut_asserteq_str("3456789a", env_get("fred"));
49
50 /* 64-bit */
51 *(u64 *)buf = 0x456789abcdef0123;
52 ut_assertok(run_command("setexpr.q fred 0", 0));
53 ut_asserteq_str("0", env_get("fred"));
54 ut_assertok(run_command("setexpr.q fred *0", 0));
55 ut_asserteq_str("456789abcdef0123", env_get("fred"));
56
57 /* default */
58 ut_assertok(run_command("setexpr fred 0", 0));
59 ut_asserteq_str("0", env_get("fred"));
60 ut_assertok(run_command("setexpr fred *0", 0));
61 ut_asserteq_str("cdef0123", env_get("fred"));
62
63 unmap_sysmem(buf);
64
65 return 0;
66 }
67 SETEXPR_TEST(setexpr_test_int, UT_TESTF_CONSOLE_REC);
68
69 /* Test 'setexpr' command with + operator */
setexpr_test_plus(struct unit_test_state * uts)70 static int setexpr_test_plus(struct unit_test_state *uts)
71 {
72 char *buf;
73
74 buf = map_sysmem(0, BUF_SIZE);
75 memset(buf, '\xff', BUF_SIZE);
76
77 /* byte */
78 buf[0x0] = 0x12;
79 buf[0x10] = 0x34;
80 ut_assertok(run_command("setexpr.b fred *0 + *10", 0));
81 ut_asserteq_str("46", env_get("fred"));
82
83 /* 16-bit */
84 *(short *)buf = 0x2345;
85 *(short *)(buf + 0x10) = 0xf012;
86 ut_assertok(run_command("setexpr.w fred *0 + *10", 0));
87 ut_asserteq_str("11357", env_get("fred"));
88
89 /* 32-bit */
90 *(u32 *)buf = 0x3456789a;
91 *(u32 *)(buf + 0x10) = 0xc3384235;
92 ut_assertok(run_command("setexpr.l fred *0 + *10", 0));
93 ut_asserteq_str("f78ebacf", env_get("fred"));
94
95 /* 64-bit */
96 *(u64 *)buf = 0x456789abcdef0123;
97 *(u64 *)(buf + 0x10) = 0x4987328372849283;
98 ut_assertok(run_command("setexpr.q fred *0 + *10", 0));
99 ut_asserteq_str("8eeebc2f407393a6", env_get("fred"));
100
101 /* default */
102 ut_assertok(run_command("setexpr fred *0 + *10", 0));
103 ut_asserteq_str("1407393a6", env_get("fred"));
104
105 unmap_sysmem(buf);
106
107 return 0;
108 }
109 SETEXPR_TEST(setexpr_test_plus, UT_TESTF_CONSOLE_REC);
110
111 /* Test 'setexpr' command with other operators */
setexpr_test_oper(struct unit_test_state * uts)112 static int setexpr_test_oper(struct unit_test_state *uts)
113 {
114 char *buf;
115
116 buf = map_sysmem(0, BUF_SIZE);
117 memset(buf, '\xff', BUF_SIZE);
118
119 *(u32 *)buf = 0x1234;
120 *(u32 *)(buf + 0x10) = 0x560000;
121
122 /* Quote | to avoid confusing hush */
123 ut_assertok(run_command("setexpr fred *0 \"|\" *10", 0));
124 ut_asserteq_str("561234", env_get("fred"));
125
126 *(u32 *)buf = 0x561200;
127 *(u32 *)(buf + 0x10) = 0x1234;
128
129 /* Quote & to avoid confusing hush */
130 ut_assertok(run_command("setexpr.l fred *0 \"&\" *10", 0));
131 ut_asserteq_str("1200", env_get("fred"));
132
133 ut_assertok(run_command("setexpr.l fred *0 ^ *10", 0));
134 ut_asserteq_str("560034", env_get("fred"));
135
136 ut_assertok(run_command("setexpr.l fred *0 - *10", 0));
137 ut_asserteq_str("55ffcc", env_get("fred"));
138
139 ut_assertok(run_command("setexpr.l fred *0 * *10", 0));
140 ut_asserteq_str("61ebfa800", env_get("fred"));
141
142 ut_assertok(run_command("setexpr.l fred *0 / *10", 0));
143 ut_asserteq_str("4ba", env_get("fred"));
144
145 ut_assertok(run_command("setexpr.l fred *0 % *10", 0));
146 ut_asserteq_str("838", env_get("fred"));
147
148 unmap_sysmem(buf);
149
150 return 0;
151 }
152 SETEXPR_TEST(setexpr_test_oper, UT_TESTF_CONSOLE_REC);
153
154 /* Test 'setexpr' command with regex */
setexpr_test_regex(struct unit_test_state * uts)155 static int setexpr_test_regex(struct unit_test_state *uts)
156 {
157 char *buf, *val;
158
159 buf = map_sysmem(0, BUF_SIZE);
160
161 /* Single substitution */
162 ut_assertok(run_command("setenv fred 'this is a test'", 0));
163 ut_assertok(run_command("setexpr fred sub is us", 0));
164 val = env_get("fred");
165 ut_asserteq_str("thus is a test", val);
166
167 /* Global substitution */
168 ut_assertok(run_command("setenv fred 'this is a test'", 0));
169 ut_assertok(run_command("setexpr fred gsub is us", 0));
170 val = env_get("fred");
171 ut_asserteq_str("thus us a test", val);
172
173 /* Global substitution */
174 ut_assertok(run_command("setenv fred 'this is a test'", 0));
175 ut_assertok(run_command("setenv mary 'this is a test'", 0));
176 ut_assertok(run_command("setexpr fred gsub is us \"${mary}\"", 0));
177 val = env_get("fred");
178 ut_asserteq_str("thus us a test", val);
179 val = env_get("mary");
180 ut_asserteq_str("this is a test", val);
181
182 unmap_sysmem(buf);
183
184 return 0;
185 }
186 SETEXPR_TEST(setexpr_test_regex, UT_TESTF_CONSOLE_REC);
187
188 /* Test 'setexpr' command with regex replacement that expands the string */
setexpr_test_regex_inc(struct unit_test_state * uts)189 static int setexpr_test_regex_inc(struct unit_test_state *uts)
190 {
191 char *buf, *val;
192
193 buf = map_sysmem(0, BUF_SIZE);
194
195 ut_assertok(run_command("setenv fred 'this is a test'", 0));
196 ut_assertok(run_command("setexpr fred gsub is much_longer_string", 0));
197 val = env_get("fred");
198 ut_asserteq_str("thmuch_longer_string much_longer_string a test", val);
199 unmap_sysmem(buf);
200
201 return 0;
202 }
203 SETEXPR_TEST(setexpr_test_regex_inc, UT_TESTF_CONSOLE_REC);
204
205 /* Test setexpr_regex_sub() directly to check buffer usage */
setexpr_test_sub(struct unit_test_state * uts)206 static int setexpr_test_sub(struct unit_test_state *uts)
207 {
208 char *buf, *nbuf;
209 int i;
210
211 buf = map_sysmem(0, BUF_SIZE);
212 nbuf = map_sysmem(0x1000, BUF_SIZE);
213
214 /* Add a pattern so we can check the buffer limits */
215 memset(buf, '\xff', BUF_SIZE);
216 memset(nbuf, '\xff', BUF_SIZE);
217 for (i = BUF_SIZE; i < 0x1000; i++) {
218 buf[i] = i & 0xff;
219 nbuf[i] = i & 0xff;
220 }
221 strcpy(buf, "this is a test");
222
223 /*
224 * This is a regression test, since a bug was found in the use of
225 * memmove() in setexpr
226 */
227 ut_assertok(setexpr_regex_sub(buf, BUF_SIZE, nbuf, BUF_SIZE, "is",
228 "us it is longer", true));
229 ut_asserteq_str("thus it is longer us it is longer a test", buf);
230 for (i = BUF_SIZE; i < 0x1000; i++) {
231 ut_assertf(buf[i] == (char)i,
232 "buf byte at %x should be %02x, got %02x)\n",
233 i, i & 0xff, (u8)buf[i]);
234 ut_assertf(nbuf[i] == (char)i,
235 "nbuf byte at %x should be %02x, got %02x)\n",
236 i, i & 0xff, (u8)nbuf[i]);
237 }
238
239 unmap_sysmem(buf);
240
241 return 0;
242 }
243 SETEXPR_TEST(setexpr_test_sub, UT_TESTF_CONSOLE_REC);
244
245 /* Test setexpr_regex_sub() with back references */
setexpr_test_backref(struct unit_test_state * uts)246 static int setexpr_test_backref(struct unit_test_state *uts)
247 {
248 char *buf, *nbuf;
249 int i;
250
251 buf = map_sysmem(0, BUF_SIZE);
252 nbuf = map_sysmem(0x1000, BUF_SIZE);
253
254 /* Add a pattern so we can check the buffer limits */
255 memset(buf, '\xff', BUF_SIZE);
256 memset(nbuf, '\xff', BUF_SIZE);
257 for (i = BUF_SIZE; i < 0x1000; i++) {
258 buf[i] = i & 0xff;
259 nbuf[i] = i & 0xff;
260 }
261 strcpy(buf, "this is surely a test is it? yes this is indeed a test");
262
263 /*
264 * This is a regression test, since a bug was found in the use of
265 * memmove() in setexpr
266 */
267 ut_assertok(setexpr_regex_sub(buf, BUF_SIZE, nbuf, BUF_SIZE,
268 "(this) (is) (surely|indeed)",
269 "us \\1 \\2 \\3!", true));
270 ut_asserteq_str("us this is surely! a test is it? yes us this is indeed! a test",
271 buf);
272
273 for (i = BUF_SIZE; i < 0x1000; i++) {
274 ut_assertf(buf[i] == (char)i,
275 "buf byte at %x should be %02x, got %02x)\n",
276 i, i & 0xff, (u8)buf[i]);
277 ut_assertf(nbuf[i] == (char)i,
278 "nbuf byte at %x should be %02x, got %02x)\n",
279 i, i & 0xff, (u8)nbuf[i]);
280 }
281
282 unmap_sysmem(buf);
283
284 return 0;
285 }
286 SETEXPR_TEST(setexpr_test_backref, UT_TESTF_CONSOLE_REC);
287
288 /* Test 'setexpr' command with setting strings */
setexpr_test_str(struct unit_test_state * uts)289 static int setexpr_test_str(struct unit_test_state *uts)
290 {
291 ulong start_mem;
292 char *buf;
293
294 buf = map_sysmem(0, BUF_SIZE);
295 memset(buf, '\xff', BUF_SIZE);
296
297 /*
298 * Set 'fred' to the same length as we expect to get below, to avoid a
299 * new allocation in 'setexpr'. That way we can check for memory leaks.
300 */
301 ut_assertok(env_set("fred", "x"));
302 start_mem = ut_check_free();
303 strcpy(buf, "hello");
304 ut_asserteq(1, run_command("setexpr.s fred 0", 0));
305 ut_assertok(ut_check_delta(start_mem));
306
307 ut_assertok(env_set("fred", "12345"));
308 start_mem = ut_check_free();
309 ut_assertok(run_command("setexpr.s fred *0", 0));
310 ut_asserteq_str("hello", env_get("fred"));
311 /*
312 * This fails in CI at present.
313 *
314 * ut_assertok(ut_check_delta(start_mem));
315 */
316
317 unmap_sysmem(buf);
318
319 return 0;
320 }
321 SETEXPR_TEST(setexpr_test_str, UT_TESTF_CONSOLE_REC);
322
323
324 /* Test 'setexpr' command with concatenating strings */
setexpr_test_str_oper(struct unit_test_state * uts)325 static int setexpr_test_str_oper(struct unit_test_state *uts)
326 {
327 ulong start_mem;
328 char *buf;
329
330 buf = map_sysmem(0, BUF_SIZE);
331 memset(buf, '\xff', BUF_SIZE);
332 strcpy(buf, "hello");
333 strcpy(buf + 0x10, " there");
334
335 ut_assertok(console_record_reset_enable());
336 start_mem = ut_check_free();
337 ut_asserteq(1, run_command("setexpr.s fred *0 * *10", 0));
338 ut_assertok(ut_check_delta(start_mem));
339 ut_assert_nextline("invalid op");
340 ut_assert_console_end();
341
342 /*
343 * Set 'fred' to the same length as we expect to get below, to avoid a
344 * new allocation in 'setexpr'. That way we can check for memory leaks.
345 */
346 ut_assertok(env_set("fred", "12345012345"));
347 start_mem = ut_check_free();
348 ut_assertok(run_command("setexpr.s fred *0 + *10", 0));
349 ut_asserteq_str("hello there", env_get("fred"));
350
351 /*
352 * This check does not work with sandbox_flattree, apparently due to
353 * memory allocations in env_set().
354 *
355 * The truetype console produces lots of memory allocations even though
356 * the LCD display is not visible. But even without these, it does not
357 * work.
358 *
359 * A better test would be for dlmalloc to record the allocs and frees
360 * for a particular caller, but that is not supported.
361 *
362 * For now, drop this test.
363 *
364 * ut_assertok(ut_check_delta(start_mem));
365 */
366
367 unmap_sysmem(buf);
368
369 return 0;
370 }
371 SETEXPR_TEST(setexpr_test_str_oper, UT_TESTF_CONSOLE_REC);
372
373 /* Test 'setexpr' command with a string that is too long */
setexpr_test_str_long(struct unit_test_state * uts)374 static int setexpr_test_str_long(struct unit_test_state *uts)
375 {
376 const int size = 128 << 10; /* setexpr strings are a max of 64KB */
377 char *buf, *val;
378
379 buf = map_sysmem(0, size);
380 memset(buf, 'a', size);
381
382 /* String should be truncated to 64KB */
383 ut_assertok(run_command("setexpr.s fred *0", 0));
384 val = env_get("fred");
385 ut_asserteq(64 << 10, strlen(val));
386
387 unmap_sysmem(buf);
388
389 return 0;
390 }
391 SETEXPR_TEST(setexpr_test_str_long, UT_TESTF_CONSOLE_REC);
392
393 #ifdef CONFIG_CMD_SETEXPR_FMT
394 /* Test 'setexpr' command with simply setting integers */
setexpr_test_fmt(struct unit_test_state * uts)395 static int setexpr_test_fmt(struct unit_test_state *uts)
396 {
397 u8 *buf;
398
399 buf = map_sysmem(0, BUF_SIZE);
400 memset(buf, '\xff', BUF_SIZE);
401
402 /* Test decimal conversion */
403 ut_assertok(run_command("setexpr fred fmt %d 0xff", 0));
404 ut_asserteq_str("255", env_get("fred"));
405 /* Test hexadecimal conversion with 0x prefix and 4 digits */
406 ut_assertok(run_command("setexpr fred fmt 0x%04x 257", 0));
407 ut_asserteq_str("0x0257", env_get("fred"));
408 /* Test octal conversion with % prefix */
409 ut_assertok(run_command("setexpr fred fmt %%%o 8", 0));
410 ut_asserteq_str("%10", env_get("fred"));
411 /* Test argument surrounded by %% */
412 ut_assertok(run_command("setexpr fred fmt %%%x%% 0xff", 0));
413 ut_asserteq_str("%ff%", env_get("fred"));
414 /* Test escape sequence */
415 ut_assertok(run_command("setexpr fred fmt \"hello\\040world\"", 0));
416 ut_asserteq_str("hello world", env_get("fred"));
417 /* Test %b with string containing octal escape sequence */
418 ut_assertok(run_command("setexpr fred fmt oh%bno \137", 0));
419 ut_asserteq_str("oh_no", env_get("fred"));
420 /* Test %b with string containing \c escape sequence */
421 ut_assertok(run_command("setexpr fred fmt hello%bworld \"\\c\"", 0));
422 ut_asserteq_str("hello", env_get("fred"));
423 /* Test multiple arguments referencing environment varialbes */
424 ut_assertok(run_command("setenv a eff", 0));
425 ut_assertok(run_command("setenv b hello", 0));
426 ut_assertok(run_command("setenv c 0x63", 0));
427 ut_assertok(run_command("setenv d world", 0));
428 ut_assertok(run_command("setexpr fred fmt \"0x%08x-%s-%d-%s\" $a $b $c $d", 0));
429 ut_asserteq_str("0x00000eff-hello-99-world", env_get("fred"));
430 /* Test with two format specifiers, but only one argument */
431 ut_assertok(run_command("setexpr fred fmt %d_%x 100", 0));
432 ut_asserteq_str("256_0", env_get("fred"));
433 /* Test maximum string length */
434 ut_assertok(run_command("setexpr fred fmt \"%0127d\" 7b", 0));
435 ut_asserteq_str("0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000123", env_get("fred"));
436 /* Test maximum unsigned integer size */
437 ut_assertok(run_command("setexpr fred fmt %u ffffffffffffffff", 0));
438 ut_asserteq_str("18446744073709551615", env_get("fred"));
439 /* Test maximum positive integer size */
440 ut_assertok(run_command("setexpr fred fmt %d 7fffffffffffffff", 0));
441 ut_asserteq_str("9223372036854775807", env_get("fred"));
442 /* Test maximum negative integer size */
443 ut_assertok(run_command("setexpr fred fmt %d 8000000000000000", 0));
444 ut_asserteq_str("-9223372036854775808", env_get("fred"));
445 /* Test minimum negative integer size */
446 ut_assertok(run_command("setexpr fred fmt %d ffffffffffffffff", 0));
447 ut_asserteq_str("-1", env_get("fred"));
448 /* Test signed value with + sign */
449 ut_assertok(run_command("setexpr fred fmt %d +5", 0));
450 ut_asserteq_str("5", env_get("fred"));
451 /* Test signed value with - sign */
452 ut_assertok(run_command("setexpr fred fmt %d -4", 0));
453 ut_asserteq_str("-4", env_get("fred"));
454 /* Test unsigned value with + sign */
455 ut_assertok(run_command("setexpr fred fmt %u +3", 0));
456 ut_asserteq_str("3", env_get("fred"));
457 /* Test unsigned value with - sign */
458 ut_assertok(run_command("setexpr fred fmt %x -2", 0));
459 ut_asserteq_str("fffffffffffffffe", env_get("fred"));
460 /* Error test with missing format specifier */
461 ut_asserteq(1, run_command("setexpr fred fmd hello 0xff", 0));
462 /* Error test with invalid format type */
463 ut_asserteq(1, run_command("setexpr fred fmt %a 0xff", 0));
464 /* Error test with incomplete format specifier */
465 ut_asserteq(1, run_command("setexpr fred fmt hello% bf", 0));
466 /* Error exceeding maximum string length */
467 ut_asserteq(1, run_command("setexpr fred fmt \"%0128d\" 456", 0));
468
469 unmap_sysmem(buf);
470
471 return 0;
472 }
473
474 SETEXPR_TEST(setexpr_test_fmt, UT_TESTF_CONSOLE_REC);
475 #endif
476
do_ut_setexpr(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])477 int do_ut_setexpr(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
478 {
479 struct unit_test *tests = UNIT_TEST_SUITE_START(setexpr_test);
480 const int n_ents = UNIT_TEST_SUITE_COUNT(setexpr_test);
481
482 return cmd_ut_category("cmd_setexpr", "setexpr_test_", tests, n_ents,
483 argc, argv);
484 }
485