All of lore.kernel.org
 help / color / mirror / Atom feed
* [RFC PATCH v3 00/23] Modernize U-Boot shell
@ 2022-03-31 23:26 Francis Laniel
  2022-03-31 23:26 ` [RFC PATCH v3 01/23] video: sandbox: Add dummy function for sandbox_sdl_remove_display() Francis Laniel
                   ` (23 more replies)
  0 siblings, 24 replies; 25+ messages in thread
From: Francis Laniel @ 2022-03-31 23:26 UTC (permalink / raw)
  To: u-boot
  Cc: Marek Behun, Michael Nazzareno Trimarchi, Simon Glass,
	Wolfgang Denk, Harald Seiler, Tom Rini, Francis Laniel

Hi.

First I hope you are fine and the same for your relatives.
I would also like to apologize for the delay between v2 and v3.

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 2021 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 "parser" command:
=> parser print
old
=> parser set 2021
2021> parser print
2021
2021> parser set old
=>
The default parser is the old one.

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
=> parser set 2021
2021> ut hush
Running 20 hush tests
...
Failures: 0

Thanks to the effort of Harald Seiler, I was successful booting a board:
2021> printenv board_rev
board_rev=iMX8MP
2021> boot
...
root@iMX8MPboard:~# fw_printenv board_rev
board_rev=iMX8MP

I also tested another board where both parser were successful to boot it:
=> printenv fdtfile
fdtfile=amlogic/meson-gxl-s905x-libretech-cc.dtb
=> boot
...
root@lepotato:~#
root@lepotato:~# reboot
...
=> parser set 2021
2021> printenv fdtfile
fdtfile=amlogic/meson-gxl-s905x-libretech-cc.dtb
2021> boot
...
root@lepotato:~#

I marked this contribution as RFC to indeed collect your opinion.
My goal is not to change suddenly actual shell to this one, we clearly need a
transition period to think about it.
I think it is better to see this contribution as a proof of concept which shows
it is possible to update the actual shell.

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).

Changes since v2:
* Added a small fix to compile sandbox with NO_SDL=1.
* Added a command to change parser at runtime.
* Added 2021 parser function to all run_command*().
* Adapted

Francis Laniel (23):
  video: sandbox: Add dummy function for sandbox_sdl_remove_display().
  test: Add framework to test hush behavior
  test: hush: Test hush if/else
  test/py: hush_if_test: Remove the test file
  test: hush: Test hush variable expansion
  test: hush: Test hush commands list
  test: hush: Test hush loops
  cli: Add Busybox upstream hush.c file
  cli: Port Busybox 2021 hush to U-Boot
  cli: Add menu for hush parser
  global_data.h: add GD_FLG_HUSH_OLD_PARSER flag.
  cmd: Add new parser command.
  cli: Enables using hush 2021 parser as command line parser
  cli: hush_2021: Enable variables expansion for hush 2021
  cli: hush_2021: Add functions to be called from run_command()
  cli: add hush 2021 as parser for run_command*().
  test: hush: Fix instructions list tests for hush 2021
  test: hush: Fix variable expansion tests for hush 2021
  cli: hush_2021: Enable using \< and \> as string compare operators
  cli: hush_2021: Enable if keyword
  test: hush: Fix if tests for hush 2021
  cli: hush_2021: Enable loops
  test: hush: Fix loop tests for hush 2021

 arch/sandbox/include/asm/sdl.h     |     5 +
 cmd/Kconfig                        |    21 +
 cmd/Makefile                       |     2 +
 cmd/parser.c                       |   125 +
 common/Makefile                    |     3 +-
 common/cli.c                       |    81 +-
 common/cli_hush_2021.c             |   309 +
 common/cli_hush_upstream.c         | 12795 +++++++++++++++++++++++++++
 include/asm-generic/global_data.h  |     8 +
 include/cli_hush.h                 |    49 +-
 include/test/hush.h                |    15 +
 include/test/suites.h              |     1 +
 test/Makefile                      |     3 +
 test/cmd_ut.c                      |     6 +
 test/hush/Makefile                 |    10 +
 test/hush/cmd_ut_hush.c            |    20 +
 test/hush/dollar.c                 |   234 +
 test/hush/if.c                     |   353 +
 test/hush/list.c                   |   140 +
 test/hush/loop.c                   |    90 +
 test/py/tests/test_hush_if_test.py |   184 -
 21 files changed, 14257 insertions(+), 197 deletions(-)
 create mode 100644 cmd/parser.c
 create mode 100644 common/cli_hush_2021.c
 create mode 100644 common/cli_hush_upstream.c
 create mode 100644 include/test/hush.h
 create mode 100644 test/hush/Makefile
 create mode 100644 test/hush/cmd_ut_hush.c
 create mode 100644 test/hush/dollar.c
 create mode 100644 test/hush/if.c
 create mode 100644 test/hush/list.c
 create mode 100644 test/hush/loop.c
 delete mode 100644 test/py/tests/test_hush_if_test.py

--
2.25.1


^ permalink raw reply	[flat|nested] 25+ messages in thread

end of thread, other threads:[~2022-04-21 12:20 UTC | newest]

Thread overview: 25+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-03-31 23:26 [RFC PATCH v3 00/23] Modernize U-Boot shell Francis Laniel
2022-03-31 23:26 ` [RFC PATCH v3 01/23] video: sandbox: Add dummy function for sandbox_sdl_remove_display() Francis Laniel
2022-03-31 23:26 ` [RFC PATCH v3 02/23] test: Add framework to test hush behavior Francis Laniel
2022-03-31 23:26 ` [RFC PATCH v3 03/23] test: hush: Test hush if/else Francis Laniel
2022-03-31 23:26 ` [RFC PATCH v3 04/23] test/py: hush_if_test: Remove the test file Francis Laniel
2022-03-31 23:26 ` [RFC PATCH v3 05/23] test: hush: Test hush variable expansion Francis Laniel
2022-03-31 23:26 ` [RFC PATCH v3 06/23] test: hush: Test hush commands list Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 07/23] test: hush: Test hush loops Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 08/23] cli: Add Busybox upstream hush.c file Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 09/23] cli: Port Busybox 2021 hush to U-Boot Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 10/23] cli: Add menu for hush parser Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 11/23] global_data.h: add GD_FLG_HUSH_OLD_PARSER flag Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 12/23] cmd: Add new parser command Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 13/23] cli: Enables using hush 2021 parser as command line parser Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 14/23] cli: hush_2021: Enable variables expansion for hush 2021 Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 15/23] cli: hush_2021: Add functions to be called from run_command() Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 16/23] cli: add hush 2021 as parser for run_command*() Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 17/23] test: hush: Fix instructions list tests for hush 2021 Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 18/23] test: hush: Fix variable expansion " Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 19/23] cli: hush_2021: Enable using \< and \> as string compare operators Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 20/23] cli: hush_2021: Enable if keyword Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 21/23] test: hush: Fix if tests for hush 2021 Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 22/23] cli: hush_2021: Enable loops Francis Laniel
2022-03-31 23:27 ` [RFC PATCH v3 23/23] test: hush: Fix loop tests for hush 2021 Francis Laniel
2022-04-21 12:20 ` [RFC PATCH v3 00/23] Modernize U-Boot shell Tom Rini

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.