gdb: Add gdbinfo command for printing the load address of the EFI application
PATCH 1/1 gdb: Add gdbinfo command for printing the load address of the EFI application
EFI firmware determines where to load the GRUB EFI at runtime, and so the addresses of debug symbols are not known ahead of time. There is a command defined in the gdb_grub script which will load the debug symbols at the appropriate addresses, if given given the application load address for GRUB. So add a command named "gdbinfo" to allow the user to print this GDB command string with the application load address on-demand. For the outputted GDB command to have any effect when entered into a GDB session, GDB should have been started with the script as an argument to the -x option or sourced into an active GDB session before running the outputted command.
Documentation for the gdbinfo command is also added.
--- docs/grub.texi | 13 ++++++++++++ grub-core/Makefile.core.def | 1 + grub-core/kern/efi/debug.c | 38 ++++++++++++++++++++++++++++++++++ grub-core/kern/efi/efi.c | 4 ++-- grub-core/kern/efi/init.c | 5 ++++- include/grub/efi/debug.h | 41 +++++++++++++++++++++++++++++++++++++ include/grub/efi/efi.h | 2 +- 7 files changed, 100 insertions(+), 4 deletions(-) create mode 100644 grub-core/kern/efi/debug.c create mode 100644 include/grub/efi/debug.h
docs/grub.texi +13 -0
@@ -4319,6 +4319,7 @@ you forget a command, you can run the command @command{help} * export:: Export an environment variable * false:: Do nothing, unsuccessfully * fwsetup:: Reboot into the firmware setup menu +* gdbinfo:: Provide info for debugging with GDB * gettext:: Translate a string * gptsync:: Fill an MBR based on GPT entries * halt:: Shut down your computer
@@ -4851,6 +4852,18 @@ exit successfully if so. @end deffn +@node gdbinfo +@subsection gdbinfo + +@deffn Command gdbinfo +Output text to be used as a GDB command for a GDB session using the gdb_grub +script and attached to a running GRUB instance. The GDB command that is +output will tell GDB how to load debugging symbols to their proper runtime +address. Currently this is only available for EFI platforms. See the Debugging +in the developer documentation for more information. +@end deffn + + @node gettext @subsection gettext
grub-core/Makefile.core.def +1 -0
@@ -206,6 +206,7 @@ kernel = { efi = disk/efi/efidisk.c; efi = kern/efi/efi.c; + efi = kern/efi/debug.c; efi = kern/efi/init.c; efi = kern/efi/mm.c; efi = term/efi/console.c;
grub-core/kern/efi/debug.c new file +38 -0
@@ -0,0 +1,38 @@ +/* +* GRUB -- GRand Unified Bootloader +* Copyright (C) 2022 Free Software Foundation, Inc. +* +* GRUB is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published by +* the Free Software Foundation, either version 3 of the License, or +* (at your option) any later version. +* +* GRUB is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with GRUB. If not, see <http://www.gnu.org/licenses/>. +*/ +/* debug.c - aides for debugging the EFI application */ + +#include <grub/efi/debug.h> +#include <grub/command.h> +#include <grub/i18n.h> + +static grub_err_t +grub_cmd_gdbinfo (struct grub_command *cmd __attribute__ ((unused)), +int argc __attribute__ ((unused)), +char **args __attribute__ ((unused))) +{ +grub_efi_print_gdb_info (); +return 0 ; +} + +void +grub_efi_register_debug_commands (void ) +{ +grub_register_command_lockdown ("gdbinfo" , grub_cmd_gdbinfo,0 , +N_ ("Print infomation useful for GDB debugging" )); +}
grub-core/kern/efi/efi.c +2 -2
@@ -301,7 +301,7 @@ grub_efi_get_variable (const char *var, const grub_efi_guid_t *guid,/* Search the mods section from the PE32/PE32+ image. This code uses a PE32 header, but should work with PE32+ as well. */ grub_addr_t -grub_efi_modules_addr (void ) +grub_efi_section_addr (const char *section_name) {grub_efi_loaded_image_t *image;struct grub_msdos_image_header *header;
@@ -330,7 +330,7 @@ grub_efi_modules_addr (void) i < coff_header->num_sections; i++, section++) { -if (grub_strcmp (section->name,"mods" ) ==0 ) +if (grub_strcmp (section->name, section_name) ==0 )break ; }
grub-core/kern/efi/init.c +4 -1
@@ -19,6 +19,7 @@#include <grub/efi/efi.h> #include <grub/efi/console.h> +#include <grub/efi/debug.h> #include <grub/efi/disk.h> #include <grub/efi/sb.h> #include <grub/lockdown.h>
@@ -104,7 +105,7 @@ grub_addr_t grub_modbase;void grub_efi_init (void ) { - grub_modbase =grub_efi_modules_addr (); + grub_modbase =grub_efi_section_addr ("mods" );/* First of all, initialize the console so that GRUB can display messages. */ grub_console_init ();
@@ -128,6 +129,8 @@ grub_efi_init (void) 0, 0, 0, NULL);grub_efidisk_init (); + +grub_efi_register_debug_commands (); } void (*grub_efi_net_config) (grub_efi_handle_t hnd,
include/grub/efi/debug.h new file +41 -0
41 lines not on this page · raw message
include/grub/efi/efi.h +1 -1
@@ -127,7 +127,7 @@ grub_err_t grub_arch_efi_linux_boot_image(grub_addr_t addr, grub_size_t size, char *args);#endif -grub_addr_t grub_efi_modules_addr (void ); +grub_addr_t grub_efi_section_addr (const char *section);void grub_efi_mm_init (void );void grub_efi_mm_fini (void );
Signature · 1 line
2.34.1
Quoted 4 lines · Glenn Washburn
EFI firmware determines where to load the GRUB EFI at runtime, and so the addresses of debug symbols are not known ahead of time. There is a command defined in the
gdb_grubscript which will load the debug symbols at the appropriate addresses, if given given the application load address for GRUB.
s/given given/given/
Quoted 99 lines
So add a command named "gdbinfo" to allow the user to print this GDB command string with the application load address on-demand. For the outputted GDB command to have any effect when entered into a GDB session, GDB should have been started with the script as an argument to the -x option or sourced into an active GDB session before running the outputted command.
Documentation for the gdbinfo command is also added.
Co-developed-by Peter Jones <[email protected]>Signed-off-by Peter Jones <[email protected]>Signed-off-by Glenn Washburn <[email protected]>--- docs/grub.texi | 13 ++++++++++++ grub-core/Makefile.core.def | 1 + grub-core/kern/efi/debug.c | 38 ++++++++++++++++++++++++++++++++++ grub-core/kern/efi/efi.c | 4 ++-- grub-core/kern/efi/init.c | 5 ++++- include/grub/efi/debug.h | 41 +++++++++++++++++++++++++++++++++++++ include/grub/efi/efi.h | 2 +- 7 files changed, 100 insertions(+), 4 deletions(-) create mode 100644 grub-core/kern/efi/debug.c create mode 100644 include/grub/efi/debug.hdocs/grub.texi +13
-0@@ -4319,6 +4319,7 @@ you forget a command, you can run the command @command{help} * export:: Export an environment variable * false:: Do nothing, unsuccessfully * fwsetup:: Reboot into the firmware setup menu +* gdbinfo:: Provide info for debugging with GDB * gettext:: Translate a string * gptsync:: Fill an MBR based on GPT entries * halt:: Shut down your computer@@ -4851,6 +4852,18 @@ exit successfully if so. @end deffn +@node gdbinfo +@subsection gdbinfo + +@deffn Command gdbinfo +Output text to be used as a GDB command for a GDB session using the gdb_grub +script and attached to a running GRUB instance. The GDB command that is +output will tell GDB how to load debugging symbols to their proper runtime +address. Currently this is only available for EFI platforms. See the Debugging +in the developer documentation for more information. +@end deffn + + @node gettext @subsection gettextgrub-core/Makefile.core.def +1
-0@@ -206,6 +206,7 @@ kernel = { efi = disk/efi/efidisk.c; efi = kern/efi/efi.c; + efi = kern/efi/debug.c; efi = kern/efi/init.c; efi = kern/efi/mm.c; efi = term/efi/console.c;grub-core/kern/efi/debug.c new file +27
-0@@ -0,0 +1,38 @@ +/* +* GRUB -- GRand Unified Bootloader +* Copyright (C) 2022 Free Software Foundation, Inc. +* +* GRUB is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published by +* the Free Software Foundation, either version 3 of the License, or +* (at your option) any later version. +* +* GRUB is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with GRUB. If not, see <http://www.gnu.org/licenses/>. +*/ +/* debug.c - aides for debugging the EFI application */ + +#include <grub/efi/debug.h> +#include <grub/command.h> +#include <grub/i18n.h> + +static grub_err_t +grub_cmd_gdbinfo (struct grub_command *cmd __attribute__ ((unused)), +int argc __attribute__ ((unused)), +char **args __attribute__ ((unused)))
grub-core/kern/efi/debug.c line 37
Quoted 10 lines
grub-core/kern/efi/debug.c new file +10
-0+{ +grub_efi_print_gdb_info (); +return 0 ; +} + +void +grub_efi_register_debug_commands (void ) +{ +grub_register_command_lockdown ("gdbinfo" , grub_cmd_gdbinfo,0 , +N_ ("Print infomation useful for GDB debugging" ));
I think we agreed after some discussion we can enable gdbinfo command even on UEFI platforms with Secure Boot enabled. So, I would do s/grub_register_command_lockdown/grub_register_command/
Otherwise Reviewed-by: Daniel Kiper <[email protected]>...
I can make above mentioned fixes for you before push...
Daniel
Quoted 122 lines · Daniel Kiper
Quoted 4 lines · Glenn Washburn
EFI firmware determines where to load the GRUB EFI at runtime, and so the addresses of debug symbols are not known ahead of time. There is a command defined in the
gdb_grubscript which will load the debug symbols at the appropriate addresses, if given given the application load address for GRUB.s/given given/given/
Quoted 99 lines
So add a command named "gdbinfo" to allow the user to print this GDB command string with the application load address on-demand. For the outputted GDB command to have any effect when entered into a GDB session, GDB should have been started with the script as an argument to the -x option or sourced into an active GDB session before running the outputted command.
Documentation for the gdbinfo command is also added.
Co-developed-by Peter Jones <[email protected]>Signed-off-by Peter Jones <[email protected]>Signed-off-by Glenn Washburn <[email protected]>--- docs/grub.texi | 13 ++++++++++++ grub-core/Makefile.core.def | 1 + grub-core/kern/efi/debug.c | 38 ++++++++++++++++++++++++++++++++++ grub-core/kern/efi/efi.c | 4 ++-- grub-core/kern/efi/init.c | 5 ++++- include/grub/efi/debug.h | 41 +++++++++++++++++++++++++++++++++++++ include/grub/efi/efi.h | 2 +- 7 files changed, 100 insertions(+), 4 deletions(-) create mode 100644 grub-core/kern/efi/debug.c create mode 100644 include/grub/efi/debug.hdocs/grub.texi +13
-0@@ -4319,6 +4319,7 @@ you forget a command, you can run the command @command{help} * export:: Export an environment variable * false:: Do nothing, unsuccessfully * fwsetup:: Reboot into the firmware setup menu +* gdbinfo:: Provide info for debugging with GDB * gettext:: Translate a string * gptsync:: Fill an MBR based on GPT entries * halt:: Shut down your computer@@ -4851,6 +4852,18 @@ exit successfully if so. @end deffn +@node gdbinfo +@subsection gdbinfo + +@deffn Command gdbinfo +Output text to be used as a GDB command for a GDB session using the gdb_grub +script and attached to a running GRUB instance. The GDB command that is +output will tell GDB how to load debugging symbols to their proper runtime +address. Currently this is only available for EFI platforms. See the Debugging +in the developer documentation for more information. +@end deffn + + @node gettext @subsection gettextgrub-core/Makefile.core.def +1
-0@@ -206,6 +206,7 @@ kernel = { efi = disk/efi/efidisk.c; efi = kern/efi/efi.c; + efi = kern/efi/debug.c; efi = kern/efi/init.c; efi = kern/efi/mm.c; efi = term/efi/console.c;grub-core/kern/efi/debug.c new file +27
-0@@ -0,0 +1,38 @@ +/* +* GRUB -- GRand Unified Bootloader +* Copyright (C) 2022 Free Software Foundation, Inc. +* +* GRUB is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published by +* the Free Software Foundation, either version 3 of the License, or +* (at your option) any later version. +* +* GRUB is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with GRUB. If not, see <http://www.gnu.org/licenses/>. +*/ +/* debug.c - aides for debugging the EFI application */ + +#include <grub/efi/debug.h> +#include <grub/command.h> +#include <grub/i18n.h> + +static grub_err_t +grub_cmd_gdbinfo (struct grub_command *cmd __attribute__ ((unused)), +int argc __attribute__ ((unused)), +char **args __attribute__ ((unused)))grub-core/kern/efi/debug.c line 37
Quoted 10 lines
grub-core/kern/efi/debug.c new file +10
-0+{ +grub_efi_print_gdb_info (); +return 0 ; +} + +void +grub_efi_register_debug_commands (void ) +{ +grub_register_command_lockdown ("gdbinfo" , grub_cmd_gdbinfo,0 , +N_ ("Print infomation useful for GDB debugging" ));I think we agreed after some discussion we can enable gdbinfo command even on UEFI platforms with Secure Boot enabled. So, I would do s/grub_register_command_lockdown/grub_register_command/
Quoted 3 lines
Otherwise Reviewed-by: Daniel Kiper <[email protected]>...
I can make above mentioned fixes for you before push...
Nah! This patch does not apply due to significant changes in the EFI code. Could you rebase it on top of [1].
Daniel
[1] https://lists.gnu.org/archive/html/grub-devel/2023-05/msg00147.html