mirror of
https://github.com/AsahiLinux/u-boot
synced 2024-11-28 15:41:40 +00:00
2b28c3b871
Francis Laniel <francis.laniel@amarulasolutions.com> says: During 2021 summer, Sean Anderson wrote a contribution to add a new shell, based on LIL, to U-Boot [1, 2]. While one of the goals of this contribution was to address the fact actual U-Boot shell, which is based on Busybox hush, is old there was a discussion about adding a new shell versus updating the actual one [3, 4]. So, in this series, with Harald Seiler, we updated the actual U-Boot shell to reflect what is currently in Busybox source code. Basically, this contribution is about taking a snapshot of Busybox shell/hush.c file (as it exists in commit 37460f5da) and adapt it to suit U-Boot needs. This contribution was written to be as backward-compatible as possible to avoid breaking the existing. So, the modern hush flavor offers the same as the actual, that is to say: 1. Variable expansion. 2. Instruction lists (;, && and ||). 3. If, then and else. 4. Loops (for, while and until). No new features offered by Busybox hush were implemented (e.g. functions). It is possible to change the parser at runtime using the "cli" command: => cli print old => cli set modern => cli print modern => cli set old The default parser is the old one. Note that to use both parser, you would need to set both CONFIG_HUSH_MODERN_PARSER and CONFIG_HUSH_OLD_PARSER. In terms of testing, new unit tests were added to ut to ensure the new behavior is the same as the old one and it does not add regression. Nonetheless, if old behavior was buggy and fixed upstream, the fix is then added to U-Boot [5]. In sandbox, all of these tests pass smoothly: => printenv board board=sandbox => ut hush Running 20 hush tests ... Failures: 0 => cli set modern => ut hush Running 20 hush tests ... Failures: 0 Thanks to the effort of Harald Seiler, I was successful booting a board: => printenv fdtfile fdtfile=amlogic/meson-gxl-s905x-libretech-cc.dtb => cli get old => boot ... root@lepotato:~# root@lepotato:~# reboot ... => cli set modern => cli get modern => printenv fdtfile fdtfile=amlogic/meson-gxl-s905x-libretech-cc.dtb => boot ... root@lepotato:~# This contribution indeed adds a lot of code and there were concern about its size [6, 7]. With regard to the amount of code added, the cli_hush_upstream.c is 13030 lines long but it seems a smaller subset is really used: gcc -D__U_BOOT__ -E common/cli_hush_upstream.c | wc -l 2870 Despite this, it is better to still have the whole upstream code for the sake of easing maintenance. With regard to memory size, I conducted some experiments for version 8 of this series and for a subset of arm64 boards and found the worst case to be 4K [8]. Tom Rini conducted more research on this and also found the increase to be acceptable [9]. If you want to review it - your review will really be appreciated - here are some information regarding the commits: * commits marked as "test:" deal with unit tests. * commit "cli: Add Busybox upstream hush.c file." copies Busybox shell/hush.c into U-Boot tree, this explain why this commit contains around 12000 additions. * commit "cli: Port Busybox 2021 hush to U-Boot." modifies previously added file to permit us to use this as new shell. The really good idea of #include'ing Busybox code into a wrapper file to define some particular functions while minimizing modifications to upstream code comes from Harald Seiler. * commit "cmd: Add new parser command" adds a new command which permits selecting parser at runtime. I am not really satisfied with the fact it calls cli_init() and cli_loop() each time the parser is set, so your reviews would be welcomed. * Other commits focus on enabling features we need (e.g. if).
225 lines
6.1 KiB
C
225 lines
6.1 KiB
C
// SPDX-License-Identifier: GPL-2.0
|
|
/*
|
|
* (C) Copyright 2021
|
|
* Francis Laniel, Amarula Solutions, francis.laniel@amarulasolutions.com
|
|
*/
|
|
|
|
#include <command.h>
|
|
#include <env_attr.h>
|
|
#include <test/hush.h>
|
|
#include <test/ut.h>
|
|
#include <asm/global_data.h>
|
|
|
|
DECLARE_GLOBAL_DATA_PTR;
|
|
|
|
static int hush_test_simple_dollar(struct unit_test_state *uts)
|
|
{
|
|
console_record_reset_enable();
|
|
ut_assertok(run_command("echo $dollar_foo", 0));
|
|
ut_assert_nextline_empty();
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("echo ${dollar_foo}", 0));
|
|
ut_assert_nextline_empty();
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("dollar_foo=bar", 0));
|
|
|
|
ut_assertok(run_command("echo $dollar_foo", 0));
|
|
ut_assert_nextline("bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("echo ${dollar_foo}", 0));
|
|
ut_assert_nextline("bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("dollar_foo=\\$bar", 0));
|
|
|
|
ut_assertok(run_command("echo $dollar_foo", 0));
|
|
ut_assert_nextline("$bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("dollar_foo='$bar'", 0));
|
|
|
|
ut_assertok(run_command("echo $dollar_foo", 0));
|
|
ut_assert_nextline("$bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_asserteq(1, run_command("dollar_foo=bar quux", 0));
|
|
/* Next line contains error message */
|
|
ut_assert_skipline();
|
|
ut_assert_console_end();
|
|
|
|
ut_asserteq(1, run_command("dollar_foo='bar quux", 0));
|
|
/* Next line contains error message */
|
|
ut_assert_skipline();
|
|
|
|
if (gd->flags & GD_FLG_HUSH_MODERN_PARSER) {
|
|
/*
|
|
* For some strange reasons, the console is not empty after
|
|
* running above command.
|
|
* So, we reset it to not have side effects for other tests.
|
|
*/
|
|
console_record_reset_enable();
|
|
} else if (gd->flags & GD_FLG_HUSH_OLD_PARSER) {
|
|
ut_assert_console_end();
|
|
}
|
|
|
|
ut_asserteq(1, run_command("dollar_foo=bar quux\"", 0));
|
|
/* Two next lines contain error message */
|
|
ut_assert_skipline();
|
|
ut_assert_skipline();
|
|
|
|
if (gd->flags & GD_FLG_HUSH_MODERN_PARSER) {
|
|
/* See above comments. */
|
|
console_record_reset_enable();
|
|
} else if (gd->flags & GD_FLG_HUSH_OLD_PARSER) {
|
|
ut_assert_console_end();
|
|
}
|
|
|
|
ut_assertok(run_command("dollar_foo='bar \"quux'", 0));
|
|
|
|
ut_assertok(run_command("echo $dollar_foo", 0));
|
|
/*
|
|
* This one is buggy.
|
|
* ut_assert_nextline("bar \"quux");
|
|
* ut_assert_console_end();
|
|
*
|
|
* So, let's reset output:
|
|
*/
|
|
console_record_reset_enable();
|
|
|
|
if (gd->flags & GD_FLG_HUSH_MODERN_PARSER) {
|
|
/*
|
|
* Old parser returns an error because it waits for closing
|
|
* '\'', but this behavior is wrong as the '\'' is surrounded by
|
|
* '"', so no need to wait for a closing one.
|
|
*/
|
|
ut_assertok(run_command("dollar_foo=\"bar 'quux\"", 0));
|
|
|
|
ut_assertok(run_command("echo $dollar_foo", 0));
|
|
ut_assert_nextline("bar 'quux");
|
|
ut_assert_console_end();
|
|
} else if (gd->flags & GD_FLG_HUSH_OLD_PARSER) {
|
|
ut_asserteq(1, run_command("dollar_foo=\"bar 'quux\"", 0));
|
|
/* Next line contains error message */
|
|
ut_assert_skipline();
|
|
ut_assert_console_end();
|
|
}
|
|
|
|
ut_assertok(run_command("dollar_foo='bar quux'", 0));
|
|
ut_assertok(run_command("echo $dollar_foo", 0));
|
|
ut_assert_nextline("bar quux");
|
|
ut_assert_console_end();
|
|
|
|
if (gd->flags & GD_FLG_HUSH_MODERN_PARSER) {
|
|
/* Reset local variable. */
|
|
ut_assertok(run_command("dollar_foo=", 0));
|
|
} else if (gd->flags & GD_FLG_HUSH_OLD_PARSER) {
|
|
puts("Beware: this test set local variable dollar_foo and it cannot be unset!");
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
HUSH_TEST(hush_test_simple_dollar, 0);
|
|
|
|
static int hush_test_env_dollar(struct unit_test_state *uts)
|
|
{
|
|
env_set("env_foo", "bar");
|
|
console_record_reset_enable();
|
|
|
|
ut_assertok(run_command("echo $env_foo", 0));
|
|
ut_assert_nextline("bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("echo ${env_foo}", 0));
|
|
ut_assert_nextline("bar");
|
|
ut_assert_console_end();
|
|
|
|
/* Environment variables have priority over local variable */
|
|
ut_assertok(run_command("env_foo=quux", 0));
|
|
ut_assertok(run_command("echo ${env_foo}", 0));
|
|
ut_assert_nextline("bar");
|
|
ut_assert_console_end();
|
|
|
|
/* Clean up setting the variable */
|
|
env_set("env_foo", NULL);
|
|
|
|
if (gd->flags & GD_FLG_HUSH_MODERN_PARSER) {
|
|
/* Reset local variable. */
|
|
ut_assertok(run_command("env_foo=", 0));
|
|
} else if (gd->flags & GD_FLG_HUSH_OLD_PARSER) {
|
|
puts("Beware: this test set local variable env_foo and it cannot be unset!");
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
HUSH_TEST(hush_test_env_dollar, 0);
|
|
|
|
static int hush_test_command_dollar(struct unit_test_state *uts)
|
|
{
|
|
console_record_reset_enable();
|
|
|
|
ut_assertok(run_command("dollar_bar=\"echo bar\"", 0));
|
|
|
|
ut_assertok(run_command("$dollar_bar", 0));
|
|
ut_assert_nextline("bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("${dollar_bar}", 0));
|
|
ut_assert_nextline("bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("dollar_bar=\"echo\nbar\"", 0));
|
|
|
|
ut_assertok(run_command("$dollar_bar", 0));
|
|
ut_assert_nextline("bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("dollar_bar='echo bar\n'", 0));
|
|
|
|
ut_assertok(run_command("$dollar_bar", 0));
|
|
ut_assert_nextline("bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("dollar_bar='echo bar\\n'", 0));
|
|
|
|
ut_assertok(run_command("$dollar_bar", 0));
|
|
|
|
if (gd->flags & GD_FLG_HUSH_MODERN_PARSER) {
|
|
/*
|
|
* This difference seems to come from a bug solved in Busybox
|
|
* hush.
|
|
* Behavior of hush 2021 is coherent with bash and other shells.
|
|
*/
|
|
ut_assert_nextline("bar\\n");
|
|
} else if (gd->flags & GD_FLG_HUSH_OLD_PARSER) {
|
|
ut_assert_nextline("barn");
|
|
}
|
|
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("dollar_bar='echo $bar'", 0));
|
|
|
|
ut_assertok(run_command("$dollar_bar", 0));
|
|
ut_assert_nextline("$bar");
|
|
ut_assert_console_end();
|
|
|
|
ut_assertok(run_command("dollar_quux=quux", 0));
|
|
ut_assertok(run_command("dollar_bar=\"echo $dollar_quux\"", 0));
|
|
|
|
ut_assertok(run_command("$dollar_bar", 0));
|
|
ut_assert_nextline("quux");
|
|
ut_assert_console_end();
|
|
|
|
if (gd->flags & GD_FLG_HUSH_MODERN_PARSER) {
|
|
/* Reset local variables. */
|
|
ut_assertok(run_command("dollar_bar=", 0));
|
|
ut_assertok(run_command("dollar_quux=", 0));
|
|
} else if (gd->flags & GD_FLG_HUSH_OLD_PARSER) {
|
|
puts("Beware: this test sets local variable dollar_bar and dollar_quux and they cannot be unset!");
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
HUSH_TEST(hush_test_command_dollar, 0);
|