gdb/maint.c

   1 /* Support for GDB maintenance commands.
   2    Copyright 1992, 1993, 1994 Free Software Foundation, Inc.
   3    Written by Fred Fish at Cygnus Support.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22
  23 #include "defs.h"
  24 #include <ctype.h>
  25 #include <signal.h>
  26 #include "command.h"
  27 #include "gdbcmd.h"
  28 #include "symtab.h"
  29 #include "gdbtypes.h"
  30 #include "demangle.h"
  31 #include "gdbcore.h"
  32 #include "expression.h"         /* For language.h */
  33 #include "language.h"
  34 #include "symfile.h"
  35 #include "objfiles.h"
  36 #include "value.h"
  37
  38 extern void _initialize_maint_cmds (void);
  39
  40 static void maintenance_command (char *, int);
  41
  42 static void maintenance_dump_me (char *, int);
  43
  44 static void maintenance_internal_error (char *args, int from_tty);
  45
  46 static void maintenance_demangle (char *, int);
  47
  48 static void maintenance_time_display (char *, int);
  49
  50 static void maintenance_space_display (char *, int);
  51
  52 static void maintenance_info_command (char *, int);
  53
  54 static void print_section_table (bfd *, asection *, PTR);
  55
  56 static void maintenance_info_sections (char *, int);
  57
  58 static void maintenance_print_command (char *, int);
  59
  60 static void maintenance_do_deprecate (char *, int);
  61
  62 /* Set this to the maximum number of seconds to wait instead of waiting forever
  63    in target_wait().  If this timer times out, then it generates an error and
  64    the command is aborted.  This replaces most of the need for timeouts in the
  65    GDB test suite, and makes it possible to distinguish between a hung target
  66    and one with slow communications.  */
  67
  68 int watchdog = 0;
  69
  70 /*
  71
  72    LOCAL FUNCTION
  73
  74    maintenance_command -- access the maintenance subcommands
  75
  76    SYNOPSIS
  77
  78    void maintenance_command (char *args, int from_tty)
  79
  80    DESCRIPTION
  81
  82  */
  83
  84 static void
  85 maintenance_command (char *args, int from_tty)
  86 {
  87   printf_unfiltered ("\"maintenance\" must be followed by the name of a maintenance command.\n");
  88   help_list (maintenancelist, "maintenance ", -1, gdb_stdout);
  89 }
  90
  91 #ifndef _WIN32
  92 /* ARGSUSED */
  93 static void
  94 maintenance_dump_me (char *args, int from_tty)
  95 {
  96   if (query ("Should GDB dump core? "))
  97     {
  98 #ifdef __DJGPP__
  99       /* SIGQUIT by default is ignored, so use SIGABRT instead.  */
 100       signal (SIGABRT, SIG_DFL);
 101       kill (getpid (), SIGABRT);
 102 #else
 103       signal (SIGQUIT, SIG_DFL);
 104       kill (getpid (), SIGQUIT);
 105 #endif
 106     }
 107 }
 108 #endif
 109
 110 /* Stimulate the internal error mechanism that GDB uses when an
 111    internal problem is detected.  Allows testing of the mechanism.
 112    Also useful when the user wants to drop a core file but not exit
 113    GDB. */
 114
 115 static void
 116 maintenance_internal_error (char *args, int from_tty)
 117 {
 118   internal_error ("internal maintenance");
 119 }
 120
 121 /* Someday we should allow demangling for things other than just
 122    explicit strings.  For example, we might want to be able to specify
 123    the address of a string in either GDB's process space or the
 124    debuggee's process space, and have gdb fetch and demangle that
 125    string.  If we have a char* pointer "ptr" that points to a string,
 126    we might want to be able to given just the name and have GDB
 127    demangle and print what it points to, etc.  (FIXME) */
 128
 129 static void
 130 maintenance_demangle (char *args, int from_tty)
 131 {
 132   char *demangled;
 133
 134   if (args == NULL || *args == '\0')
 135     {
 136       printf_unfiltered ("\"maintenance demangle\" takes an argument to demangle.\n");
 137     }
 138   else
 139     {
 140       demangled = cplus_demangle (args, DMGL_ANSI | DMGL_PARAMS);
 141       if (demangled != NULL)
 142         {
 143           printf_unfiltered ("%s\n", demangled);
 144           xfree (demangled);
 145         }
 146       else
 147         {
 148           printf_unfiltered ("Can't demangle \"%s\"\n", args);
 149         }
 150     }
 151 }
 152
 153 static void
 154 maintenance_time_display (char *args, int from_tty)
 155 {
 156   extern int display_time;
 157
 158   if (args == NULL || *args == '\0')
 159     printf_unfiltered ("\"maintenance time\" takes a numeric argument.\n");
 160   else
 161     display_time = strtol (args, NULL, 10);
 162 }
 163
 164 static void
 165 maintenance_space_display (char *args, int from_tty)
 166 {
 167   extern int display_space;
 168
 169   if (args == NULL || *args == '\0')
 170     printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
 171   else
 172     display_space = strtol (args, NULL, 10);
 173 }
 174
 175 /* The "maintenance info" command is defined as a prefix, with
 176    allow_unknown 0.  Therefore, its own definition is called only for
 177    "maintenance info" with no args.  */
 178
 179 /* ARGSUSED */
 180 static void
 181 maintenance_info_command (char *arg, int from_tty)
 182 {
 183   printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
 184   help_list (maintenanceinfolist, "maintenance info ", -1, gdb_stdout);
 185 }
 186
 187 static void
 188 print_section_table (bfd *abfd, asection *asect, PTR ignore)
 189 {
 190   flagword flags;
 191
 192   flags = bfd_get_section_flags (abfd, asect);
 193
 194   /* FIXME-32x64: Need print_address_numeric with field width.  */
 195   printf_filtered ("    %s",
 196                    local_hex_string_custom
 197                    ((unsigned long) bfd_section_vma (abfd, asect), "08l"));
 198   printf_filtered ("->%s",
 199                    local_hex_string_custom
 200                    ((unsigned long) (bfd_section_vma (abfd, asect)
 201                                      + bfd_section_size (abfd, asect)),
 202                     "08l"));
 203   printf_filtered (" at %s",
 204                    local_hex_string_custom
 205                    ((unsigned long) asect->filepos, "08l"));
 206   printf_filtered (": %s", bfd_section_name (abfd, asect));
 207
 208   if (flags & SEC_ALLOC)
 209     printf_filtered (" ALLOC");
 210   if (flags & SEC_LOAD)
 211     printf_filtered (" LOAD");
 212   if (flags & SEC_RELOC)
 213     printf_filtered (" RELOC");
 214   if (flags & SEC_READONLY)
 215     printf_filtered (" READONLY");
 216   if (flags & SEC_CODE)
 217     printf_filtered (" CODE");
 218   if (flags & SEC_DATA)
 219     printf_filtered (" DATA");
 220   if (flags & SEC_ROM)
 221     printf_filtered (" ROM");
 222   if (flags & SEC_CONSTRUCTOR)
 223     printf_filtered (" CONSTRUCTOR");
 224   if (flags & SEC_HAS_CONTENTS)
 225     printf_filtered (" HAS_CONTENTS");
 226   if (flags & SEC_NEVER_LOAD)
 227     printf_filtered (" NEVER_LOAD");
 228   if (flags & SEC_COFF_SHARED_LIBRARY)
 229     printf_filtered (" COFF_SHARED_LIBRARY");
 230   if (flags & SEC_IS_COMMON)
 231     printf_filtered (" IS_COMMON");
 232
 233   printf_filtered ("\n");
 234 }
 235
 236 /* ARGSUSED */
 237 static void
 238 maintenance_info_sections (char *arg, int from_tty)
 239 {
 240   if (exec_bfd)
 241     {
 242       printf_filtered ("Exec file:\n");
 243       printf_filtered ("    `%s', ", bfd_get_filename (exec_bfd));
 244       wrap_here ("        ");
 245       printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd));
 246       bfd_map_over_sections (exec_bfd, print_section_table, 0);
 247     }
 248
 249   if (core_bfd)
 250     {
 251       printf_filtered ("Core file:\n");
 252       printf_filtered ("    `%s', ", bfd_get_filename (core_bfd));
 253       wrap_here ("        ");
 254       printf_filtered ("file type %s.\n", bfd_get_target (core_bfd));
 255       bfd_map_over_sections (core_bfd, print_section_table, 0);
 256     }
 257 }
 258
 259 /* ARGSUSED */
 260 void
 261 maintenance_print_statistics (char *args, int from_tty)
 262 {
 263   print_objfile_statistics ();
 264   print_symbol_bcache_statistics ();
 265 }
 266
 267 void
 268 maintenance_print_architecture (char *args, int from_tty)
 269 {
 270   if (args == NULL)
 271     gdbarch_dump (current_gdbarch, gdb_stdout);
 272   else
 273     {
 274       struct ui_file *file = gdb_fopen (args, "w");
 275       if (file == NULL)
 276         perror_with_name ("maintenance print architecture");
 277       gdbarch_dump (current_gdbarch, file);
 278       ui_file_delete (file);
 279     }
 280 }
 281
 282 /* The "maintenance print" command is defined as a prefix, with
 283    allow_unknown 0.  Therefore, its own definition is called only for
 284    "maintenance print" with no args.  */
 285
 286 /* ARGSUSED */
 287 static void
 288 maintenance_print_command (char *arg, int from_tty)
 289 {
 290   printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
 291   help_list (maintenanceprintlist, "maintenance print ", -1, gdb_stdout);
 292 }
 293
 294 /* The "maintenance translate-address" command converts a section and address
 295    to a symbol.  This can be called in two ways:
 296    maintenance translate-address <secname> <addr>
 297    or   maintenance translate-address <addr>
 298  */
 299
 300 static void
 301 maintenance_translate_address (char *arg, int from_tty)
 302 {
 303   CORE_ADDR address;
 304   asection *sect;
 305   char *p;
 306   struct minimal_symbol *sym;
 307   struct objfile *objfile;
 308
 309   if (arg == NULL || *arg == 0)
 310     error ("requires argument (address or section + address)");
 311
 312   sect = NULL;
 313   p = arg;
 314
 315   if (!isdigit (*p))
 316     {                           /* See if we have a valid section name */
 317       while (*p && !isspace (*p))       /* Find end of section name */
 318         p++;
 319       if (*p == '\000')         /* End of command? */
 320         error ("Need to specify <section-name> and <address>");
 321       *p++ = '\000';
 322       while (isspace (*p))
 323         p++;                    /* Skip whitespace */
 324
 325       ALL_OBJFILES (objfile)
 326       {
 327         sect = bfd_get_section_by_name (objfile->obfd, arg);
 328         if (sect != NULL)
 329           break;
 330       }
 331
 332       if (!sect)
 333         error ("Unknown section %s.", arg);
 334     }
 335
 336   address = parse_and_eval_address (p);
 337
 338   if (sect)
 339     sym = lookup_minimal_symbol_by_pc_section (address, sect);
 340   else
 341     sym = lookup_minimal_symbol_by_pc (address);
 342
 343   if (sym)
 344     printf_filtered ("%s+%s\n",
 345                      SYMBOL_SOURCE_NAME (sym),
 346                      paddr_u (address - SYMBOL_VALUE_ADDRESS (sym)));
 347   else if (sect)
 348     printf_filtered ("no symbol at %s:0x%s\n", sect->name, paddr (address));
 349   else
 350     printf_filtered ("no symbol at 0x%s\n", paddr (address));
 351
 352   return;
 353 }
 354
 355
 356 /* When a comamnd is deprecated the user will be warned the first time
 357    the command is used.  If possible, a replacement will be
 358    offered. */
 359
 360 static void
 361 maintenance_deprecate (char *args, int from_tty)
 362 {
 363   if (args == NULL || *args == '\0')
 364     {
 365       printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
 366 the command you want to deprecate, and optionally the replacement command \n\
 367 enclosed in quotes.\n");
 368     }
 369
 370   maintenance_do_deprecate (args, 1);
 371
 372 }
 373
 374
 375 static void
 376 maintenance_undeprecate (char *args, int from_tty)
 377 {
 378   if (args == NULL || *args == '\0')
 379     {
 380       printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
 381 the command you want to undeprecate.\n");
 382     }
 383
 384   maintenance_do_deprecate (args, 0);
 385
 386 }
 387
 388 /* You really shouldn't be using this. It is just for the testsuite.
 389    Rather, you should use deprecate_cmd() when the command is created
 390    in _initialize_blah().
 391
 392    This function deprecates a command and optionally assigns it a
 393    replacement.  */
 394
 395 static void
 396 maintenance_do_deprecate (char *text, int deprecate)
 397 {
 398
 399   struct cmd_list_element *alias = NULL;
 400   struct cmd_list_element *prefix_cmd = NULL;
 401   struct cmd_list_element *cmd = NULL;
 402
 403   char *start_ptr = NULL;
 404   char *end_ptr = NULL;
 405   int len;
 406   char *replacement = NULL;
 407
 408   if (text == NULL)
 409     return;
 410
 411   if (!lookup_cmd_composition (text, &alias, &prefix_cmd, &cmd))
 412     {
 413       printf_filtered ("Can't find command '%s' to deprecate.\n", text);
 414       return;
 415     }
 416
 417   if (deprecate)
 418     {
 419       /* look for a replacement command */
 420       start_ptr = strchr (text, '\"');
 421       if (start_ptr != NULL)
 422         {
 423           start_ptr++;
 424           end_ptr = strrchr (start_ptr, '\"');
 425           if (end_ptr != NULL)
 426             {
 427               len = end_ptr - start_ptr;
 428               start_ptr[len] = '\0';
 429               replacement = xstrdup (start_ptr);
 430             }
 431         }
 432     }
 433
 434   if (!start_ptr || !end_ptr)
 435     replacement = NULL;
 436
 437
 438   /* If they used an alias, we only want to deprecate the alias.
 439
 440      Note the MALLOCED_REPLACEMENT test.  If the command's replacement
 441      string was allocated at compile time we don't want to free the
 442      memory. */
 443   if (alias)
 444     {
 445
 446       if (alias->flags & MALLOCED_REPLACEMENT)
 447         xfree (alias->replacement);
 448
 449       if (deprecate)
 450         alias->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
 451       else
 452         alias->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
 453       alias->replacement = replacement;
 454       alias->flags |= MALLOCED_REPLACEMENT;
 455       return;
 456     }
 457   else if (cmd)
 458     {
 459       if (cmd->flags & MALLOCED_REPLACEMENT)
 460         xfree (cmd->replacement);
 461
 462       if (deprecate)
 463         cmd->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
 464       else
 465         cmd->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
 466       cmd->replacement = replacement;
 467       cmd->flags |= MALLOCED_REPLACEMENT;
 468       return;
 469     }
 470 }
 471
 472
 473 void
 474 _initialize_maint_cmds (void)
 475 {
 476   add_prefix_cmd ("maintenance", class_maintenance, maintenance_command,
 477                   "Commands for use by GDB maintainers.\n\
 478 Includes commands to dump specific internal GDB structures in\n\
 479 a human readable form, to cause GDB to deliberately dump core,\n\
 480 to test internal functions such as the C++ demangler, etc.",
 481                   &maintenancelist, "maintenance ", 0,
 482                   &cmdlist);
 483
 484   add_com_alias ("mt", "maintenance", class_maintenance, 1);
 485
 486   add_prefix_cmd ("info", class_maintenance, maintenance_info_command,
 487      "Commands for showing internal info about the program being debugged.",
 488                   &maintenanceinfolist, "maintenance info ", 0,
 489                   &maintenancelist);
 490   add_alias_cmd ("i", "info", class_maintenance, 1, &maintenancelist);
 491
 492   add_cmd ("sections", class_maintenance, maintenance_info_sections,
 493            "List the BFD sections of the exec and core files.",
 494            &maintenanceinfolist);
 495
 496   add_prefix_cmd ("print", class_maintenance, maintenance_print_command,
 497                   "Maintenance command for printing GDB internal state.",
 498                   &maintenanceprintlist, "maintenance print ", 0,
 499                   &maintenancelist);
 500
 501 #ifndef _WIN32
 502   add_cmd ("dump-me", class_maintenance, maintenance_dump_me,
 503            "Get fatal error; make debugger dump its core.\n\
 504 GDB sets it's handling of SIGQUIT back to SIG_DFL and then sends\n\
 505 itself a SIGQUIT signal.",
 506            &maintenancelist);
 507 #endif
 508
 509   add_cmd ("internal-error", class_maintenance, maintenance_internal_error,
 510            "Give GDB an internal error.\n\
 511 Cause GDB to behave as if an internal error was detected.",
 512            &maintenancelist);
 513
 514   add_cmd ("demangle", class_maintenance, maintenance_demangle,
 515            "Demangle a C++ mangled name.\n\
 516 Call internal GDB demangler routine to demangle a C++ link name\n\
 517 and prints the result.",
 518            &maintenancelist);
 519
 520   add_cmd ("time", class_maintenance, maintenance_time_display,
 521            "Set the display of time usage.\n\
 522 If nonzero, will cause the execution time for each command to be\n\
 523 displayed, following the command's output.",
 524            &maintenancelist);
 525
 526   add_cmd ("space", class_maintenance, maintenance_space_display,
 527            "Set the display of space usage.\n\
 528 If nonzero, will cause the execution space for each command to be\n\
 529 displayed, following the command's output.",
 530            &maintenancelist);
 531
 532   add_cmd ("type", class_maintenance, maintenance_print_type,
 533            "Print a type chain for a given symbol.\n\
 534 For each node in a type chain, print the raw data for each member of\n\
 535 the type structure, and the interpretation of the data.",
 536            &maintenanceprintlist);
 537
 538   add_cmd ("symbols", class_maintenance, maintenance_print_symbols,
 539            "Print dump of current symbol definitions.\n\
 540 Entries in the full symbol table are dumped to file OUTFILE.\n\
 541 If a SOURCE file is specified, dump only that file's symbols.",
 542            &maintenanceprintlist);
 543
 544   add_cmd ("msymbols", class_maintenance, maintenance_print_msymbols,
 545            "Print dump of current minimal symbol definitions.\n\
 546 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
 547 If a SOURCE file is specified, dump only that file's minimal symbols.",
 548            &maintenanceprintlist);
 549
 550   add_cmd ("psymbols", class_maintenance, maintenance_print_psymbols,
 551            "Print dump of current partial symbol definitions.\n\
 552 Entries in the partial symbol table are dumped to file OUTFILE.\n\
 553 If a SOURCE file is specified, dump only that file's partial symbols.",
 554            &maintenanceprintlist);
 555
 556   add_cmd ("objfiles", class_maintenance, maintenance_print_objfiles,
 557            "Print dump of current object file definitions.",
 558            &maintenanceprintlist);
 559
 560   add_cmd ("statistics", class_maintenance, maintenance_print_statistics,
 561            "Print statistics about internal gdb state.",
 562            &maintenanceprintlist);
 563
 564   add_cmd ("architecture", class_maintenance, maintenance_print_architecture,
 565            "Print the internal architecture configuration.\
 566 Takes an optional file parameter.",
 567            &maintenanceprintlist);
 568
 569   add_cmd ("check-symtabs", class_maintenance, maintenance_check_symtabs,
 570            "Check consistency of psymtabs and symtabs.",
 571            &maintenancelist);
 572
 573   add_cmd ("translate-address", class_maintenance, maintenance_translate_address,
 574            "Translate a section name and address to a symbol.",
 575            &maintenancelist);
 576
 577   add_cmd ("deprecate", class_maintenance, maintenance_deprecate,
 578            "Deprecate a command.  Note that this is just in here so the \n\
 579 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
 580 rather you should use the C function deprecate_cmd().  If you decide you \n\
 581 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
 582 replacement is optional.", &maintenancelist);
 583
 584   add_cmd ("undeprecate", class_maintenance, maintenance_undeprecate,
 585            "Undeprecate a command.  Note that this is just in here so the \n\
 586 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
 587 If you decide you want to use it: maintenance undeprecate 'commandname'",
 588            &maintenancelist);
 589
 590   add_show_from_set (
 591                       add_set_cmd ("watchdog", class_maintenance, var_zinteger, (char *) &watchdog,
 592                                    "Set watchdog timer.\n\
 593 When non-zero, this timeout is used instead of waiting forever for a target to\n\
 594 finish a low-level step or continue operation.  If the specified amount of time\n\
 595 passes without a response from the target, an error occurs.", &setlist),
 596                       &showlist);
 597 }