[PATCH 12/15] efi_loader: Add a command to show the EFI log
Simon Glass
sjg at chromium.org
Mon Oct 28 13:48:03 CET 2024
Add a simple command which lists the log. Avoid creating any new records
when this command is invoked.
Signed-off-by: Simon Glass <sjg at chromium.org>
---
cmd/efidebug.c | 53 +++++++++++++++---
doc/usage/cmd/efidebug.rst | 109 +++++++++++++++++++++++++++++++++++++
doc/usage/index.rst | 1 +
3 files changed, 155 insertions(+), 8 deletions(-)
create mode 100644 doc/usage/cmd/efidebug.rst
diff --git a/cmd/efidebug.c b/cmd/efidebug.c
index e040fe75fa1..bba984b2b75 100644
--- a/cmd/efidebug.c
+++ b/cmd/efidebug.c
@@ -10,6 +10,7 @@
#include <dm/device.h>
#include <efi_dt_fixup.h>
#include <efi_load_initrd.h>
+#include <efi_log.h>
#include <efi_loader.h>
#include <efi_rng.h>
#include <efi_variable.h>
@@ -511,6 +512,33 @@ static int do_efi_show_images(struct cmd_tbl *cmdtp, int flag,
return CMD_RET_SUCCESS;
}
+/**
+ * do_efi_show_log() - show UEFI log of boot-services calls
+ *
+ * @cmdtp: Command table
+ * @flag: Command flag
+ * @argc: Number of arguments
+ * @argv: Argument array
+ * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
+ *
+ * Implement efidebug "log" sub-command.
+ * Show UEFI log records.
+ */
+static int do_efi_show_log(struct cmd_tbl *cmdtp, int flag,
+ int argc, char *const argv[])
+{
+ if (!IS_ENABLED(CONFIG_EFI_LOG)) {
+ printf("Please enable CONFIG_EFI_LOG to use the log\n");
+ return CMD_RET_FAILURE;
+ }
+ if (efi_log_show()) {
+ printf("Failed\n");
+ return CMD_RET_FAILURE;
+ }
+
+ return CMD_RET_SUCCESS;
+}
+
static const char * const efi_mem_type_string[] = {
[EFI_RESERVED_MEMORY_TYPE] = "RESERVED",
[EFI_LOADER_CODE] = "LOADER CODE",
@@ -1563,6 +1591,7 @@ static struct cmd_tbl cmd_efidebug_sub[] = {
"", ""),
U_BOOT_CMD_MKENT(images, CONFIG_SYS_MAXARGS, 1, do_efi_show_images,
"", ""),
+ U_BOOT_CMD_MKENT(log, CONFIG_SYS_MAXARGS, 1, do_efi_show_log, "", ""),
U_BOOT_CMD_MKENT(memmap, CONFIG_SYS_MAXARGS, 1, do_efi_show_memmap,
"", ""),
U_BOOT_CMD_MKENT(tables, CONFIG_SYS_MAXARGS, 1, do_efi_show_tables,
@@ -1597,19 +1626,25 @@ static int do_efidebug(struct cmd_tbl *cmdtp, int flag,
argc--; argv++;
- /* Initialize UEFI drivers */
- r = efi_init_obj_list();
- if (r != EFI_SUCCESS) {
- printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
- r & ~EFI_ERROR_MASK);
- return CMD_RET_FAILURE;
- }
-
cp = find_cmd_tbl(argv[0], cmd_efidebug_sub,
ARRAY_SIZE(cmd_efidebug_sub));
if (!cp)
return CMD_RET_USAGE;
+ /*
+ * Calling efi_init_obj_list() can add log records, so avoid it if just
+ * showing the log
+ */
+ if (cp->cmd != do_efi_show_log) {
+ /* Initialize UEFI drivers */
+ r = efi_init_obj_list();
+ if (r != EFI_SUCCESS) {
+ printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
+ r & ~EFI_ERROR_MASK);
+ return CMD_RET_FAILURE;
+ }
+ }
+
return cp->cmd(cmdtp, flag, argc, argv);
}
@@ -1655,6 +1690,8 @@ U_BOOT_LONGHELP(efidebug,
" - show UEFI handles\n"
"efidebug images\n"
" - show loaded images\n"
+ "efidebug log\n"
+ " - show UEFI log\n"
"efidebug memmap\n"
" - show UEFI memory map\n"
"efidebug tables\n"
diff --git a/doc/usage/cmd/efidebug.rst b/doc/usage/cmd/efidebug.rst
new file mode 100644
index 00000000000..5eca4079f82
--- /dev/null
+++ b/doc/usage/cmd/efidebug.rst
@@ -0,0 +1,109 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. Copyright 2024 Google LLC
+.. Written by Simon Glass <sjg at chromium.org>
+
+.. index::
+ single: efidebug (command)
+
+efidebug command
+================
+
+Synopsis
+--------
+
+::
+
+ efidebug log
+
+Description
+-----------
+
+The *efidebug* command provides access to debugging features for the EFI-loader
+subsystem.
+
+Only one of the subcommands are documented at present.
+
+efidebug log
+~~~~~~~~~~~~
+
+This shows a log of EFI boot-services calls which have been handled since U-Boot
+started. This can be useful to see what the app is doing, or even what U-Boot
+itself has called.
+
+
+Example
+-------
+
+This shows checking the log, then using 'efidebug tables' to fully set up the
+EFI-loader subsystem, then checking the log again::
+
+ => efidebug log
+ EFI log (size 158)
+ 0 alloc_pool bt-data size 33/51 buf 7fffd8448ad0 *buf 7c20010 ret OK
+ 1 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448a80 *mem 7c20000 ret OK
+ 2 alloc_pool bt-data size 60/96 buf 7fffd8448ac0 *buf 7c1f010 ret OK
+ 3 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448a60 *mem 7c1f000 ret OK
+ 4 alloc_pool bt-data size 60/96 buf 7fffd8448ac0 *buf 7c1e010 ret OK
+ 5 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448a60 *mem 7c1e000 ret OK
+ 6 records
+ => efidebug tables
+ efi_var_to_file() Cannot persist EFI variables without system partition
+ 0000000017bfc010 36122546-f7ef-4c8f-bd9b-eb8525b50c0b EFI Conformance Profiles Table
+ 0000000017bd4010 b122a263-3661-4f68-9929-78f8b0d62180 EFI System Resource Table
+ 0000000017bd8010 1e2ed096-30e2-4254-bd89-863bbef82325 TCG2 Final Events Table
+ 0000000017bd6010 eb66918a-7eef-402a-842e-931d21c38ae9 Runtime properties
+ 0000000008c49000 8868e871-e4f1-11d3-bc22-0080c73c8881 ACPI table
+ 0000000018c5b000 f2fd1544-9794-4a2c-992e-e5bbcf20e394 SMBIOS3 table
+ => efidebug log
+ EFI log (size a20)
+ 0 alloc_pool bt-data size 33/51 buf 7fffd8448ad0 *buf 7c20010 ret OK
+ 1 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448a80 *mem 7c20000 ret OK
+ 2 alloc_pool bt-data size 60/96 buf 7fffd8448ac0 *buf 7c1f010 ret OK
+ 3 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448a60 *mem 7c1f000 ret OK
+ 4 alloc_pool bt-data size 60/96 buf 7fffd8448ac0 *buf 7c1e010 ret OK
+ 5 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448a60 *mem 7c1e000 ret OK
+ 6 alloc_pages any-pages rt-data pgs 20/32 mem 7fffd8448838 *mem 7bfe000 ret OK
+ 7 alloc_pool rt-data size 60/96 buf 7fffd84487e0 *buf 7bfd010 ret OK
+ 8 alloc_pages any-pages rt-data pgs 1 mem 7fffd8448780 *mem 7bfd000 ret OK
+ 9 alloc_pool rt-data size 180/384 buf 56f190ffd890 *buf 7bfc010 ret OK
+ 10 alloc_pages any-pages rt-data pgs 1 mem 7fffd8448800 *mem 7bfc000 ret OK
+ 11 alloc_pool bt-data size 4 buf 7fffd8448840 *buf 7bfb010 ret OK
+ 12 alloc_pages any-pages bt-data pgs 1 mem 7fffd84487f0 *mem 7bfb000 ret OK
+ 13 alloc_pool bt-data size 10/16 buf 7fffd8448728 *buf 7bfa010 ret OK
+ 14 alloc_pages any-pages bt-data pgs 1 mem 7fffd84486d0 *mem 7bfa000 ret OK
+ 15 alloc_pool bt-data size 60/96 buf 7fffd84487e0 *buf 7bf9010 ret OK
+ 16 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448780 *mem 7bf9000 ret OK
+ 17 alloc_pool bt-data size 10000/65536 buf 56f19100fae0 *buf 7be8010 ret OK
+ 18 alloc_pages any-pages bt-data pgs 11/17 mem 7fffd84487d0 *mem 7be8000 ret OK
+ 19 alloc_pool acpi-nvs size 10000/65536 buf 56f19100fae8 *buf 7bd7010 ret OK
+ 20 alloc_pages any-pages acpi-nvs pgs 11/17 mem 7fffd84487d0 *mem 7bd7000 ret OK
+ 21 alloc_pool bt-data size 60/96 buf 7fffd84487d0 *buf 7bd6010 ret OK
+ 22 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448770 *mem 7bd6000 ret OK
+ 23 alloc_pool rt-data size 8 buf 7fffd8448818 *buf 7bd5010 ret OK
+ 24 alloc_pages any-pages rt-data pgs 1 mem 7fffd84487c0 *mem 7bd5000 ret OK
+ 25 alloc_pool bt-data size 8 buf 7fffd8448360 *buf 7bd4010 ret OK
+ 26 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448160 *mem 7bd4000 ret OK
+ 27 alloc_pool bt-data size f0/240 buf 7fffd8448378 *buf 7bd3010 ret OK
+ 28 alloc_pages any-pages bt-data pgs 1 mem 7fffd84482d0 *mem 7bd3000 ret OK
+ 29 free_pool buf 7bd3010 ret OK
+ 30 free_pages mem 7bd3000 pag 1 ret OK
+ 31 alloc_pool bt-data size 60/96 buf 7fffd84482d8 *buf 7bd3010 ret OK
+ 32 alloc_pages any-pages bt-data pgs 1 mem 7fffd8448280 *mem 7bd3000 ret OK
+ 33 free_pool buf 7bfa010 ret OK
+ 34 free_pages mem 7bfa000 pag 1 ret OK
+ 35 alloc_pool bt-data size f0/240 buf 7fffd8448380 *buf 7bfa010 ret OK
+ 36 alloc_pages any-pages bt-data pgs 1 mem 7fffd84482d0 *mem 7bfa000 ret OK
+ 37 free_pool buf 7bfa010 ret OK
+ 38 free_pages mem 7bfa000 pag 1 ret OK
+ 39 free_pool buf 7bd4010 ret OK
+ 40 free_pages mem 7bd4000 pag 1 ret OK
+ 41 alloc_pool bt-data size 61/97 buf 7fffd8448810 *buf 7bfa010 ret OK
+ 42 alloc_pages any-pages bt-data pgs 1 mem 7fffd84487c0 *mem 7bfa000 ret OK
+ 43 alloc_pool bt-data size 60/96 buf 7fffd8448800 *buf 7bd4010 ret OK
+ 44 alloc_pages any-pages bt-data pgs 1 mem 7fffd84487a0 *mem 7bd4000 ret OK
+ 45 alloc_pool bt-data size 60/96 buf 7fffd8448800 *buf 7bd2010 ret OK
+ 46 alloc_pages any-pages bt-data pgs 1 mem 7fffd84487a0 *mem 7bd2000 ret OK
+ 47 alloc_pool bt-data size 60/96 buf 7fffd8448810 *buf 7bd1010 ret OK
+ 48 alloc_pages any-pages bt-data pgs 1 mem 7fffd84487b0 *mem 7bd1000 ret OK
+ 49 records
+ =>
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 24b2d2637b1..a2340d9a7e0 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -59,6 +59,7 @@ Shell commands
cmd/echo
cmd/efi
cmd/eficonfig
+ cmd/efidebug
cmd/env
cmd/event
cmd/exception
--
2.43.0
More information about the U-Boot
mailing list