gdb/debuginfod-support.c

   1 /* debuginfod utilities for GDB.
   2    Copyright (C) 2020-2022 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #include "defs.h"
  20 #include "diagnostics.h"
  21 #include <errno.h>
  22 #include "gdbsupport/scoped_fd.h"
  23 #include "debuginfod-support.h"
  24 #include "gdbsupport/gdb_optional.h"
  25 #include "cli/cli-cmds.h"
  26 #include "cli/cli-style.h"
  27 #include "target.h"
  28
  29 /* Set/show debuginfod commands.  */
  30 static cmd_list_element *set_debuginfod_prefix_list;
  31 static cmd_list_element *show_debuginfod_prefix_list;
  32
  33 static const char debuginfod_on[] = "on";
  34 static const char debuginfod_off[] = "off";
  35 static const char debuginfod_ask[] = "ask";
  36
  37 static const char *debuginfod_enabled_enum[] =
  38 {
  39   debuginfod_on,
  40   debuginfod_off,
  41   debuginfod_ask,
  42   nullptr
  43 };
  44
  45 static const char *debuginfod_enabled =
  46 #if defined(HAVE_LIBDEBUGINFOD)
  47   debuginfod_ask;
  48 #else
  49   debuginfod_off;
  50 #endif
  51
  52 static unsigned int debuginfod_verbose = 1;
  53
  54 #ifndef HAVE_LIBDEBUGINFOD
  55 scoped_fd
  56 debuginfod_source_query (const unsigned char *build_id,
  57                          int build_id_len,
  58                          const char *srcpath,
  59                          gdb::unique_xmalloc_ptr<char> *destname)
  60 {
  61   return scoped_fd (-ENOSYS);
  62 }
  63
  64 scoped_fd
  65 debuginfod_debuginfo_query (const unsigned char *build_id,
  66                             int build_id_len,
  67                             const char *filename,
  68                             gdb::unique_xmalloc_ptr<char> *destname)
  69 {
  70   return scoped_fd (-ENOSYS);
  71 }
  72
  73 scoped_fd
  74 debuginfod_exec_query (const unsigned char *build_id,
  75                        int build_id_len,
  76                        const char *filename,
  77                        gdb::unique_xmalloc_ptr<char> *destname)
  78 {
  79   return scoped_fd (-ENOSYS);
  80 }
  81
  82 #define NO_IMPL _("Support for debuginfod is not compiled into GDB.")
  83
  84 #else
  85 #include <elfutils/debuginfod.h>
  86
  87 struct user_data
  88 {
  89   user_data (const char *desc, const char *fname)
  90     : desc (desc), fname (fname), has_printed (false)
  91   { }
  92
  93   const char * const desc;
  94   const char * const fname;
  95   bool has_printed;
  96 };
  97
  98 /* Deleter for a debuginfod_client.  */
  99
 100 struct debuginfod_client_deleter
 101 {
 102   void operator() (debuginfod_client *c)
 103   {
 104     debuginfod_end (c);
 105   }
 106 };
 107
 108 using debuginfod_client_up
 109   = std::unique_ptr<debuginfod_client, debuginfod_client_deleter>;
 110
 111 static int
 112 progressfn (debuginfod_client *c, long cur, long total)
 113 {
 114   user_data *data = static_cast<user_data *> (debuginfod_get_user_data (c));
 115   gdb_assert (data != nullptr);
 116
 117   if (check_quit_flag ())
 118     {
 119       gdb_printf ("Cancelling download of %s %ps...\n",
 120                   data->desc,
 121                   styled_string (file_name_style.style (), data->fname));
 122       return 1;
 123     }
 124
 125   if (!data->has_printed)
 126     {
 127       /* Include the transfer size, if available.  */
 128       if (total > 0)
 129         {
 130           float size = 1.0f * total / 1024;
 131           const char *unit = "KB";
 132
 133           /* If size is greater than 0.01 MB, set unit to MB.  */
 134           if (size > 10.24)
 135             {
 136               size /= 1024;
 137               unit = "MB";
 138             }
 139
 140           gdb_printf ("Downloading %.2f %s %s %ps...\n",
 141                       size, unit, data->desc,
 142                       styled_string (file_name_style.style (),
 143                                      data->fname));
 144         }
 145       else
 146         gdb_printf ("Downloading %s %ps...\n", data->desc,
 147                     styled_string (file_name_style.style (), data->fname));
 148
 149       data->has_printed = true;
 150     }
 151
 152   return 0;
 153 }
 154
 155 static debuginfod_client *
 156 get_debuginfod_client ()
 157 {
 158   static debuginfod_client_up global_client;
 159
 160   if (global_client == nullptr)
 161     {
 162       global_client.reset (debuginfod_begin ());
 163
 164       if (global_client != nullptr)
 165         debuginfod_set_progressfn (global_client.get (), progressfn);
 166     }
 167
 168   return global_client.get ();
 169 }
 170
 171 /* Check if debuginfod is enabled.  If configured to do so, ask the user
 172    whether to enable debuginfod.  */
 173
 174 static bool
 175 debuginfod_is_enabled ()
 176 {
 177   const char *urls = skip_spaces (getenv (DEBUGINFOD_URLS_ENV_VAR));
 178
 179   if (debuginfod_enabled == debuginfod_off
 180       || urls == nullptr
 181       || *urls == '\0')
 182     return false;
 183
 184   if (debuginfod_enabled == debuginfod_ask)
 185     {
 186       gdb_printf (_("\nThis GDB supports auto-downloading debuginfo " \
 187                     "from the following URLs:\n"));
 188
 189       gdb::string_view url_view (urls);
 190       while (true)
 191         {
 192           size_t off = url_view.find_first_not_of (' ');
 193           if (off == gdb::string_view::npos)
 194             break;
 195           url_view = url_view.substr (off);
 196           /* g++ 11.2.1 on s390x, g++ 11.3.1 on ppc64le and g++ 11 on
 197              hppa seem convinced url_view might be of SIZE_MAX length.
 198              And so complains because the length of an array can only
 199              be PTRDIFF_MAX.  */
 200           DIAGNOSTIC_PUSH
 201           DIAGNOSTIC_IGNORE_STRINGOP_OVERREAD
 202           off = url_view.find_first_of (' ');
 203           DIAGNOSTIC_POP
 204           gdb_printf
 205             (_("  <%ps>\n"),
 206              styled_string (file_name_style.style (),
 207                             gdb::to_string (url_view.substr (0,
 208                                                              off)).c_str ()));
 209           if (off == gdb::string_view::npos)
 210             break;
 211           url_view = url_view.substr (off);
 212         }
 213
 214       int resp = nquery (_("Enable debuginfod for this session? "));
 215       if (!resp)
 216         {
 217           gdb_printf (_("Debuginfod has been disabled.\nTo make this " \
 218                         "setting permanent, add \'set debuginfod " \
 219                         "enabled off\' to .gdbinit.\n"));
 220           debuginfod_enabled = debuginfod_off;
 221           return false;
 222         }
 223
 224       gdb_printf (_("Debuginfod has been enabled.\nTo make this " \
 225                     "setting permanent, add \'set debuginfod enabled " \
 226                     "on\' to .gdbinit.\n"));
 227       debuginfod_enabled = debuginfod_on;
 228     }
 229
 230   return true;
 231 }
 232
 233 /* See debuginfod-support.h  */
 234
 235 scoped_fd
 236 debuginfod_source_query (const unsigned char *build_id,
 237                          int build_id_len,
 238                          const char *srcpath,
 239                          gdb::unique_xmalloc_ptr<char> *destname)
 240 {
 241   if (!debuginfod_is_enabled ())
 242     return scoped_fd (-ENOSYS);
 243
 244   debuginfod_client *c = get_debuginfod_client ();
 245
 246   if (c == nullptr)
 247     return scoped_fd (-ENOMEM);
 248
 249   char *dname = nullptr;
 250   user_data data ("source file", srcpath);
 251
 252   debuginfod_set_user_data (c, &data);
 253   gdb::optional<target_terminal::scoped_restore_terminal_state> term_state;
 254   if (target_supports_terminal_ours ())
 255     {
 256       term_state.emplace ();
 257       target_terminal::ours ();
 258     }
 259
 260   scoped_fd fd (debuginfod_find_source (c,
 261                                         build_id,
 262                                         build_id_len,
 263                                         srcpath,
 264                                         &dname));
 265   debuginfod_set_user_data (c, nullptr);
 266
 267   if (fd.get () < 0 && fd.get () != -ENOENT)
 268     gdb_printf (_("Download failed: %s.  Continuing without source file %ps.\n"),
 269                 safe_strerror (-fd.get ()),
 270                 styled_string (file_name_style.style (),  srcpath));
 271
 272   if (fd.get () >= 0)
 273     destname->reset (dname);
 274
 275   return fd;
 276 }
 277
 278 /* See debuginfod-support.h  */
 279
 280 scoped_fd
 281 debuginfod_debuginfo_query (const unsigned char *build_id,
 282                             int build_id_len,
 283                             const char *filename,
 284                             gdb::unique_xmalloc_ptr<char> *destname)
 285 {
 286   if (!debuginfod_is_enabled ())
 287     return scoped_fd (-ENOSYS);
 288
 289   debuginfod_client *c = get_debuginfod_client ();
 290
 291   if (c == nullptr)
 292     return scoped_fd (-ENOMEM);
 293
 294   char *dname = nullptr;
 295   user_data data ("separate debug info for", filename);
 296
 297   debuginfod_set_user_data (c, &data);
 298   gdb::optional<target_terminal::scoped_restore_terminal_state> term_state;
 299   if (target_supports_terminal_ours ())
 300     {
 301       term_state.emplace ();
 302       target_terminal::ours ();
 303     }
 304
 305   scoped_fd fd (debuginfod_find_debuginfo (c, build_id, build_id_len,
 306                                            &dname));
 307   debuginfod_set_user_data (c, nullptr);
 308
 309   if (fd.get () < 0 && fd.get () != -ENOENT)
 310     gdb_printf (_("Download failed: %s.  Continuing without debug info for %ps.\n"),
 311                 safe_strerror (-fd.get ()),
 312                 styled_string (file_name_style.style (),  filename));
 313
 314   if (fd.get () >= 0)
 315     destname->reset (dname);
 316
 317   return fd;
 318 }
 319
 320 /* See debuginfod-support.h  */
 321
 322 scoped_fd
 323 debuginfod_exec_query (const unsigned char *build_id,
 324                        int build_id_len,
 325                        const char *filename,
 326                        gdb::unique_xmalloc_ptr<char> *destname)
 327 {
 328   if (!debuginfod_is_enabled ())
 329     return scoped_fd (-ENOSYS);
 330
 331   debuginfod_client *c = get_debuginfod_client ();
 332
 333   if (c == nullptr)
 334     return scoped_fd (-ENOMEM);
 335
 336   char *dname = nullptr;
 337   user_data data ("executable for", filename);
 338
 339   debuginfod_set_user_data (c, &data);
 340   gdb::optional<target_terminal::scoped_restore_terminal_state> term_state;
 341   if (target_supports_terminal_ours ())
 342     {
 343       term_state.emplace ();
 344       target_terminal::ours ();
 345     }
 346
 347   scoped_fd fd (debuginfod_find_executable (c, build_id, build_id_len, &dname));
 348   debuginfod_set_user_data (c, nullptr);
 349
 350   if (fd.get () < 0 && fd.get () != -ENOENT)
 351     gdb_printf (_("Download failed: %s. " \
 352                   "Continuing without executable for %ps.\n"),
 353                 safe_strerror (-fd.get ()),
 354                 styled_string (file_name_style.style (),  filename));
 355
 356   if (fd.get () >= 0)
 357     destname->reset (dname);
 358
 359   return fd;
 360 }
 361 #endif
 362
 363 /* Set callback for "set debuginfod enabled".  */
 364
 365 static void
 366 set_debuginfod_enabled (const char *value)
 367 {
 368 #if defined(HAVE_LIBDEBUGINFOD)
 369   debuginfod_enabled = value;
 370 #else
 371   /* Disabling debuginfod when gdb is not built with it is a no-op.  */
 372   if (value != debuginfod_off)
 373     error (NO_IMPL);
 374 #endif
 375 }
 376
 377 /* Get callback for "set debuginfod enabled".  */
 378
 379 static const char *
 380 get_debuginfod_enabled ()
 381 {
 382   return debuginfod_enabled;
 383 }
 384
 385 /* Show callback for "set debuginfod enabled".  */
 386
 387 static void
 388 show_debuginfod_enabled (ui_file *file, int from_tty, cmd_list_element *cmd,
 389                          const char *value)
 390 {
 391   gdb_printf (file,
 392               _("Debuginfod functionality is currently set to "
 393                 "\"%s\".\n"), debuginfod_enabled);
 394 }
 395
 396 /* Set callback for "set debuginfod urls".  */
 397
 398 static void
 399 set_debuginfod_urls (const std::string &urls)
 400 {
 401 #if defined(HAVE_LIBDEBUGINFOD)
 402   if (setenv (DEBUGINFOD_URLS_ENV_VAR, urls.c_str (), 1) != 0)
 403     warning (_("Unable to set debuginfod URLs: %s"), safe_strerror (errno));
 404 #else
 405   error (NO_IMPL);
 406 #endif
 407 }
 408
 409 /* Get callback for "set debuginfod urls".  */
 410
 411 static const std::string&
 412 get_debuginfod_urls ()
 413 {
 414   static std::string urls;
 415 #if defined(HAVE_LIBDEBUGINFOD)
 416   const char *envvar = getenv (DEBUGINFOD_URLS_ENV_VAR);
 417
 418   if (envvar != nullptr)
 419     urls = envvar;
 420   else
 421     urls.clear ();
 422 #endif
 423
 424   return urls;
 425 }
 426
 427 /* Show callback for "set debuginfod urls".  */
 428
 429 static void
 430 show_debuginfod_urls (ui_file *file, int from_tty, cmd_list_element *cmd,
 431                       const char *value)
 432 {
 433   if (value[0] == '\0')
 434     gdb_printf (file, _("Debuginfod URLs have not been set.\n"));
 435   else
 436     gdb_printf (file, _("Debuginfod URLs are currently set to:\n%s\n"),
 437                 value);
 438 }
 439
 440 /* Show callback for "set debuginfod verbose".  */
 441
 442 static void
 443 show_debuginfod_verbose_command (ui_file *file, int from_tty,
 444                                  cmd_list_element *cmd, const char *value)
 445 {
 446   gdb_printf (file, _("Debuginfod verbose output is set to %s.\n"),
 447               value);
 448 }
 449
 450 /* Register debuginfod commands.  */
 451
 452 void _initialize_debuginfod ();
 453 void
 454 _initialize_debuginfod ()
 455 {
 456   /* set/show debuginfod */
 457   add_setshow_prefix_cmd ("debuginfod", class_run,
 458                           _("Set debuginfod options."),
 459                           _("Show debuginfod options."),
 460                           &set_debuginfod_prefix_list,
 461                           &show_debuginfod_prefix_list,
 462                           &setlist, &showlist);
 463
 464   add_setshow_enum_cmd ("enabled", class_run, debuginfod_enabled_enum,
 465                         _("Set whether to use debuginfod."),
 466                         _("Show whether to use debuginfod."),
 467                         _("\
 468 When on, enable the use of debuginfod to download missing debug info and\n\
 469 source files."),
 470                         set_debuginfod_enabled,
 471                         get_debuginfod_enabled,
 472                         show_debuginfod_enabled,
 473                         &set_debuginfod_prefix_list,
 474                         &show_debuginfod_prefix_list);
 475
 476   /* set/show debuginfod urls */
 477   add_setshow_string_noescape_cmd ("urls", class_run, _("\
 478 Set the list of debuginfod server URLs."), _("\
 479 Show the list of debuginfod server URLs."), _("\
 480 Manage the space-separated list of debuginfod server URLs that GDB will query \
 481 when missing debuginfo, executables or source files.\nThe default value is \
 482 copied from the DEBUGINFOD_URLS environment variable."),
 483                                    set_debuginfod_urls,
 484                                    get_debuginfod_urls,
 485                                    show_debuginfod_urls,
 486                                    &set_debuginfod_prefix_list,
 487                                    &show_debuginfod_prefix_list);
 488
 489   /* set/show debuginfod verbose */
 490   add_setshow_zuinteger_cmd ("verbose", class_support,
 491                              &debuginfod_verbose, _("\
 492 Set verbosity of debuginfod output."), _("\
 493 Show debuginfod debugging."), _("\
 494 When set to a non-zero value, display verbose output for each debuginfod \
 495 query.\nTo disable, set to zero.  Verbose output is displayed by default."),
 496                              nullptr,
 497                              show_debuginfod_verbose_command,
 498                              &set_debuginfod_prefix_list,
 499                              &show_debuginfod_prefix_list);
 500 }