espressif/binutils-gdb
1
0
Fork 0
mirror of https://github.com/espressif/binutils-gdb.git synced 2025-06-19 00:59:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

gdb: rework "set debuginfod" commands

Browse Source 
As discussed here [1], do some re-work in the "set debuginfod commands".

First, use "set debuginfod enabled on/off/ask" instead of "set
debuginfod on/off/ask".  This is more MI-friendly, and it gives an
output that makes more sense in "info set", for example.

Then, make the show commands not call "error" when debuginfod support is
not compiled in.  This makes the commands "show" and "show debuginfod"
stop early, breaking gdb.base/default.exp:

    Running /home/smarchi/src/binutils-gdb/gdb/testsuite/gdb.base/default.exp ...
    FAIL: gdb.base/default.exp: info set
    FAIL: gdb.base/default.exp: show

 - Make the "debuginfod enabled" setting default to "off" when debuginfod
   support is not compiled in, and "ask" otherwise.
 - Make the setter of "debuginfod enabled" error out when debuginfod
   support is not compiled in, so that "debuginfod enabled" will always
   remain "off" in that case.
 - Make the setter of "debuginfod verbose" work in any case.  I don't
   see the harm in letting the user change that setting, since the user will
   hit an error if they try to enable the use of debuginfod.
 - I would do the same for the "debuginfod urls" setter, but because
   this one needs to see the DEBUGINFOD_URLS_ENV_VAR macro, provided by
   libdebuginfod, I made that one error out as well if debuginfod
   support is not compiled it (otherwise, I would have left it like
   "debuginfod verbose".  Alternatively, we could hard-code
   "DEBUGINFOD_URLS" in the code (in fact, it was prior to this patch,
   but I think it was an oversight, as other spots use
   DEBUGINFOD_URLS_ENV_VAR), or use a dummy string to store the setting,
   but I don't really see the value in that.

Rename debuginfod_enable to debuginfod_enabled, just so it matches the
setting name.

[1] https://sourceware.org/pipermail/gdb-patches/2021-October/182937.html

Change-Id: I45fdb2993f668226a5639228951362b7800f09d5
Co-Authored-By: Aaron Merey <amerey@redhat.com>
This commit is contained in:
Simon Marchi
2021-11-02 12:21:31 -04:00
committed by Simon Marchi
parent aa70a99eb0
commit 333f35b631
3 changed files with 142 additions and 203 deletions
Download Patch File Download Diff File Expand all files Collapse all files

312
gdb/debuginfod-support.c
View File

@ -32,8 +32,22 @@ static const char debuginfod_on[] = "on";
static const char debuginfod_off[] = "off"; static const char debuginfod_off[] = "off";
static const char debuginfod_ask[] = "ask"; static const char debuginfod_ask[] = "ask";
static const char *debuginfod_enable = debuginfod_ask; static const char *debuginfod_enabled_enum[] =
static unsigned debuginfod_verbose = 1; {
debuginfod_on,
debuginfod_off,
debuginfod_ask,
nullptr
};
static const char *debuginfod_enabled =
#if defined(HAVE_LIBDEBUGINFOD)
debuginfod_ask;
#else
debuginfod_off;
#endif
static unsigned int debuginfod_verbose = 1;
#ifndef HAVE_LIBDEBUGINFOD #ifndef HAVE_LIBDEBUGINFOD
scoped_fd scoped_fd
@ -56,70 +70,6 @@ debuginfod_debuginfo_query (const unsigned char *build_id,
#define NO_IMPL _("Support for debuginfod is not compiled into GDB.") #define NO_IMPL _("Support for debuginfod is not compiled into GDB.")
/* Stub set/show commands that indicate debuginfod is not supported. */
static void
set_debuginfod_on_command (const char *args, int from_tty)
{
error (NO_IMPL);
debuginfod_enable = debuginfod_off;
}
static void
set_debuginfod_off_command (const char *args, int from_tty)
{
error (NO_IMPL);
debuginfod_enable = debuginfod_off;
}
static void
set_debuginfod_ask_command (const char *args, int from_tty)
{
error (NO_IMPL);
debuginfod_enable = debuginfod_off;
}
static void
show_debuginfod_status_command (const char *args, int from_tty)
{
error (NO_IMPL);
}
static void
set_debuginfod_urls_command (const std::string& urls)
{
error (NO_IMPL);
}
static const std::string&
get_debuginfod_urls_command ()
{
static std::string empty;
return empty;
}
static void
show_debuginfod_urls_command (struct ui_file *file, int from_tty,
struct cmd_list_element *cmd, const char *value)
{
error (NO_IMPL);
}
static void
set_debuginfod_verbose_command (const char *args, int from_tty,
struct cmd_list_element *c)
{
error (NO_IMPL);
debuginfod_verbose = 0;
}
static void
show_debuginfod_verbose_command (struct ui_file *file, int from_tty,
struct cmd_list_element *cmd,
const char *value)
{
error (NO_IMPL);
}
#else #else
#include <elfutils/debuginfod.h> #include <elfutils/debuginfod.h>
@ -147,96 +97,6 @@ struct debuginfod_client_deleter
using debuginfod_client_up using debuginfod_client_up
= std::unique_ptr<debuginfod_client, debuginfod_client_deleter>; = std::unique_ptr<debuginfod_client, debuginfod_client_deleter>;
/* Enable debuginfod. */
static void
set_debuginfod_on_command (const char *args, int from_tty)
{
debuginfod_enable = debuginfod_on;
}
/* Disable debuginfod. */
static void
set_debuginfod_off_command (const char *args, int from_tty)
{
debuginfod_enable = debuginfod_off;
}
/* Before next query, ask user whether to enable debuginfod. */
static void
set_debuginfod_ask_command (const char *args, int from_tty)
{
debuginfod_enable = debuginfod_ask;
}
/* Show whether debuginfod is enabled. */
static void
show_debuginfod_status_command (const char *args, int from_tty)
{
printf_unfiltered (_("Debuginfod functionality is currently set to " \
"\"%s\".\n"), debuginfod_enable);
}
/* Set the URLs that debuginfod will query. */
static void
set_debuginfod_urls_command (const std::string& urls)
{
if (setenv ("DEBUGINFOD_URLS", urls.c_str (), 1) != 0)
warning (_("Unable to set debuginfod URLs: %s"), safe_strerror (errno));
}
/* Get current debuginfod URLs. */
static const std::string&
get_debuginfod_urls_command ()
{
static std::string urls;
const char *envvar = getenv (DEBUGINFOD_URLS_ENV_VAR);
if (envvar != nullptr)
urls = envvar;
else
urls.clear ();
return urls;
}
/* Show the URLs that debuginfod will query. */
static void
show_debuginfod_urls_command (struct ui_file *file, int from_tty,
struct cmd_list_element *cmd, const char *value)
{
if (value == nullptr || value[0] == '\0')
fprintf_unfiltered (file, _("Debuginfod URLs have not been set.\n"));
else
fprintf_filtered (file, _("Debuginfod URLs are currently set to:\n%s\n"),
value);
}
/* No-op setter used for compatibility when gdb is built without debuginfod. */
static void
set_debuginfod_verbose_command (const char *args, int from_tty,
struct cmd_list_element *c)
{
return;
}
/* Show verbosity. */
static void
show_debuginfod_verbose_command (struct ui_file *file, int from_tty,
struct cmd_list_element *cmd, const char *value)
{
fprintf_filtered (file, _("Debuginfod verbose output is set to %s.\n"),
value);
}
static int static int
progressfn (debuginfod_client *c, long cur, long total) progressfn (debuginfod_client *c, long cur, long total)
{ {
@ -293,15 +153,15 @@ get_debuginfod_client ()
whether to enable debuginfod. */ whether to enable debuginfod. */
static bool static bool
debuginfod_enabled () debuginfod_is_enabled ()
{ {
const char *urls = getenv (DEBUGINFOD_URLS_ENV_VAR); const char *urls = getenv (DEBUGINFOD_URLS_ENV_VAR);
if (urls == nullptr || urls[0] == '\0' if (urls == nullptr || urls[0] == '\0'
|| debuginfod_enable == debuginfod_off) || debuginfod_enabled == debuginfod_off)
return false; return false;
if (debuginfod_enable == debuginfod_ask) if (debuginfod_enabled == debuginfod_ask)
{ {
int resp = nquery (_("\nThis GDB supports auto-downloading debuginfo " \ int resp = nquery (_("\nThis GDB supports auto-downloading debuginfo " \
"from the following URLs:\n%s\nEnable debuginfod " \ "from the following URLs:\n%s\nEnable debuginfod " \
@ -310,16 +170,16 @@ debuginfod_enabled ()
if (!resp) if (!resp)
{ {
printf_filtered (_("Debuginfod has been disabled.\nTo make this " \ printf_filtered (_("Debuginfod has been disabled.\nTo make this " \
"setting permanent, add \'set debuginfod off\' " \ "setting permanent, add \'set debuginfod " \
"to .gdbinit.\n")); "enabled off\' to .gdbinit.\n"));
debuginfod_enable = debuginfod_off; debuginfod_enabled = debuginfod_off;
return false; return false;
} }
printf_filtered (_("Debuginfod has been enabled.\nTo make this " \ printf_filtered (_("Debuginfod has been enabled.\nTo make this " \
"setting permanent, add \'set debuginfod on\' " \ "setting permanent, add \'set debuginfod enabled " \
"to .gdbinit.\n")); "on\' to .gdbinit.\n"));
debuginfod_enable = debuginfod_on; debuginfod_enabled = debuginfod_on;
} }
return true; return true;
@ -333,7 +193,7 @@ debuginfod_source_query (const unsigned char *build_id,
const char *srcpath, const char *srcpath,
gdb::unique_xmalloc_ptr<char> *destname) gdb::unique_xmalloc_ptr<char> *destname)
{ {
if (!debuginfod_enabled ()) if (!debuginfod_is_enabled ())
return scoped_fd (-ENOSYS); return scoped_fd (-ENOSYS);
debuginfod_client *c = get_debuginfod_client (); debuginfod_client *c = get_debuginfod_client ();
@ -370,7 +230,7 @@ debuginfod_debuginfo_query (const unsigned char *build_id,
const char *filename, const char *filename,
gdb::unique_xmalloc_ptr<char> *destname) gdb::unique_xmalloc_ptr<char> *destname)
{ {
if (!debuginfod_enabled ()) if (!debuginfod_is_enabled ())
return scoped_fd (-ENOSYS); return scoped_fd (-ENOSYS);
debuginfod_client *c = get_debuginfod_client (); debuginfod_client *c = get_debuginfod_client ();
@ -398,6 +258,90 @@ debuginfod_debuginfo_query (const unsigned char *build_id,
} }
#endif #endif
/* Set callback for "set debuginfod enabled". */
static void
set_debuginfod_enabled (const char *value)
{
#if defined(HAVE_LIBDEBUGINFOD)
debuginfod_enabled = value;
#else
error (NO_IMPL);
#endif
}
/* Get callback for "set debuginfod enabled". */
static const char *
get_debuginfod_enabled ()
{
return debuginfod_enabled;
}
/* Show callback for "set debuginfod enabled". */
static void
show_debuginfod_enabled (ui_file *file, int from_tty, cmd_list_element *cmd,
const char *value)
{
printf_unfiltered (_("Debuginfod functionality is currently set to "
"\"%s\".\n"), debuginfod_enabled);
}
/* Set callback for "set debuginfod urls". */
static void
set_debuginfod_urls (const std::string &urls)
{
#if defined(HAVE_LIBDEBUGINFOD)
if (setenv (DEBUGINFOD_URLS_ENV_VAR, urls.c_str (), 1) != 0)
warning (_("Unable to set debuginfod URLs: %s"), safe_strerror (errno));
#else
error (NO_IMPL);
#endif
}
/* Get callback for "set debuginfod urls". */
static const std::string&
get_debuginfod_urls ()
{
static std::string urls;
#if defined(HAVE_LIBDEBUGINFOD)
const char *envvar = getenv (DEBUGINFOD_URLS_ENV_VAR);
if (envvar != nullptr)
urls = envvar;
else
urls.clear ();
#endif
return urls;
}
/* Show callback for "set debuginfod urls". */
static void
show_debuginfod_urls (ui_file *file, int from_tty, cmd_list_element *cmd,
const char *value)
{
if (value[0] == '\0')
fprintf_unfiltered (file, _("Debuginfod URLs have not been set.\n"));
else
fprintf_filtered (file, _("Debuginfod URLs are currently set to:\n%s\n"),
value);
}
/* Show callback for "set debuginfod verbose". */
static void
show_debuginfod_verbose_command (ui_file *file, int from_tty,
cmd_list_element *cmd, const char *value)
{
fprintf_filtered (file, _("Debuginfod verbose output is set to %s.\n"),
value);
}
/* Register debuginfod commands. */ /* Register debuginfod commands. */
void _initialize_debuginfod (); void _initialize_debuginfod ();
@ -412,22 +356,16 @@ _initialize_debuginfod ()
&show_debuginfod_prefix_list, &show_debuginfod_prefix_list,
&setlist, &showlist); &setlist, &showlist);
/* set debuginfod on */ add_setshow_enum_cmd ("enabled", class_run, debuginfod_enabled_enum,
add_cmd ("on", class_run, set_debuginfod_on_command, _("Set whether to use debuginfod."),
_("Enable debuginfod."), &set_debuginfod_prefix_list); _("Show whether to use debuginfod."),
_("\
/* set debuginfod off */ When on, enable the use of debuginfod to download missing debug info and\n\
add_cmd ("off", class_run, set_debuginfod_off_command, source files."),
_("Disable debuginfod."), &set_debuginfod_prefix_list); set_debuginfod_enabled,
get_debuginfod_enabled,
/* set debuginfod ask */ show_debuginfod_enabled,
add_cmd ("ask", class_run, set_debuginfod_ask_command, _("\ &set_debuginfod_prefix_list,
Ask the user whether to enable debuginfod before performing the next query."),
&set_debuginfod_prefix_list);
/* show debuginfod status */
add_cmd ("status", class_run, show_debuginfod_status_command,
_("Show whether debuginfod is set to \"on\", \"off\" or \"ask\"."),
&show_debuginfod_prefix_list); &show_debuginfod_prefix_list);
/* set/show debuginfod urls */ /* set/show debuginfod urls */
@ -437,9 +375,9 @@ Show the list of debuginfod server URLs."), _("\
Manage the space-separated list of debuginfod server URLs that GDB will query \ Manage the space-separated list of debuginfod server URLs that GDB will query \
when missing debuginfo, executables or source files.\nThe default value is \ when missing debuginfo, executables or source files.\nThe default value is \
copied from the DEBUGINFOD_URLS environment variable."), copied from the DEBUGINFOD_URLS environment variable."),
set_debuginfod_urls_command, set_debuginfod_urls,
get_debuginfod_urls_command, get_debuginfod_urls,
show_debuginfod_urls_command, show_debuginfod_urls,
&set_debuginfod_prefix_list, &set_debuginfod_prefix_list,
&show_debuginfod_prefix_list); &show_debuginfod_prefix_list);
@ -450,7 +388,7 @@ Set verbosity of debuginfod output."), _("\
Show debuginfod debugging."), _("\ Show debuginfod debugging."), _("\
When set to a non-zero value, display verbose output for each debuginfod \ When set to a non-zero value, display verbose output for each debuginfod \
query.\nTo disable, set to zero. Verbose output is displayed by default."), query.\nTo disable, set to zero. Verbose output is displayed by default."),
set_debuginfod_verbose_command, nullptr,
show_debuginfod_verbose_command, show_debuginfod_verbose_command,
&set_debuginfod_prefix_list, &set_debuginfod_prefix_list,
&show_debuginfod_prefix_list); &show_debuginfod_prefix_list);

27
gdb/doc/gdb.texinfo
View File

@ -47114,27 +47114,28 @@ regarding @code{debuginfod}.
@value{GDBN} provides the following commands for configuring @code{debuginfod}. @value{GDBN} provides the following commands for configuring @code{debuginfod}.
@table @code @table @code
@kindex set debuginfod @kindex set debuginfod enabled
@anchor{set debuginfod} @anchor{set debuginfod enabled}
@item set debuginfod @item set debuginfod enabled
@itemx set debuginfod on @itemx set debuginfod enabled on
@cindex enable debuginfod @cindex enable debuginfod
@value{GDBN} will attempt to query @code{debuginfod} servers when missing debug @value{GDBN} will attempt to query @code{debuginfod} servers when missing debug
info or source files. info or source files.
@item set debuginfod off @item set debuginfod enabled off
@value{GDBN} will not attempt to query @code{debuginfod} servers when missing @value{GDBN} will not attempt to query @code{debuginfod} servers when missing
debug info or source files. By default, @code{debuginfod} is set to @code{off} debug info or source files. By default, @code{debuginfod enabled} is set to
for non-interactive sessions. @code{off} for non-interactive sessions.
@item set debuginfod ask @item set debuginfod enabled ask
@value{GDBN} will prompt the user to enable or disable @code{debuginfod} before @value{GDBN} will prompt the user to enable or disable @code{debuginfod} before
attempting to perform the next query. By default, @code{debuginfod} is set to attempting to perform the next query. By default, @code{debuginfod enabled}
@code{ask} for interactive sessions. is set to @code{ask} for interactive sessions.
@kindex show debuginfod status @kindex show debuginfod enabled
@item show debuginfod status @item show debuginfod enabled
Show whether @code{debuginfod} is set to @code{on}, @code{off} or @code{ask}. Display whether @code{debuginfod enabled} is set to @code{on}, @code{off} or
@code{ask}.
@kindex set debuginfod urls @kindex set debuginfod urls
@cindex configure debuginfod URLs @cindex configure debuginfod URLs

4
gdb/testsuite/gdb.debuginfod/fetch_src_and_symbols.exp
View File

@ -246,7 +246,7 @@ proc local_url { } {
clean_restart clean_restart
gdb_test "file $binfile" ".*No debugging symbols.*" \ gdb_test "file $binfile" ".*No debugging symbols.*" \
"file [file tail $binfile] cmd" "file [file tail $binfile] cmd"
gdb_test_no_output "set debuginfod off" gdb_test_no_output "set debuginfod enabled off"
gdb_test_no_output "set debuginfod urls http://127.0.0.1:$port" gdb_test_no_output "set debuginfod urls http://127.0.0.1:$port"
# gdb shouldn't find the debuginfo since debuginfod has been disabled # gdb shouldn't find the debuginfo since debuginfod has been disabled
@ -254,7 +254,7 @@ proc local_url { } {
"file [file tail $binfile] cmd off" "file [file tail $binfile] cmd off"
# Enable debuginfod and fetch the debuginfo # Enable debuginfod and fetch the debuginfo
gdb_test_no_output "set debuginfod on" gdb_test_no_output "set debuginfod enabled on"
gdb_test "file $binfile" ".*Reading symbols from.*debuginfo.*" \ gdb_test "file $binfile" ".*Reading symbols from.*debuginfo.*" \
"file [file tail $binfile] cmd on" "file [file tail $binfile] cmd on"
} }