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, Boston, MA 02111-1307, USA.  */
  20
  21
  22 #include "defs.h"
  23
  24 #if MAINTENANCE_CMDS    /* Entire rest of file goes away if not including maint cmds */
  25
  26 #include <signal.h>
  27 #include "command.h"
  28 #include "gdbcmd.h"
  29 #include "symtab.h"
  30 #include "gdbtypes.h"
  31 #include "demangle.h"
  32 #include "gdbcore.h"
  33 #include "expression.h" /* For language.h */
  34 #include "language.h"
  35 #include "symfile.h"
  36 #include "objfiles.h"
  37
  38 #ifdef HAVE_UNISTD_H
  39 #include <unistd.h>
  40 #endif
  41
  42 static void maintenance_command PARAMS ((char *, int));
  43
  44 static void maintenance_dump_me PARAMS ((char *, int));
  45
  46 static void maintenance_demangle PARAMS ((char *, int));
  47
  48 static void maintenance_time_display PARAMS ((char *, int));
  49
  50 static void maintenance_space_display PARAMS ((char *, int));
  51
  52 static void maintenance_info_command PARAMS ((char *, int));
  53
  54 static void print_section_table PARAMS ((bfd *, asection *, PTR));
  55
  56 static void maintenance_info_sections PARAMS ((char *, int));
  57
  58 static void maintenance_print_command PARAMS ((char *, int));
  59
  60 /* Set this to the maximum number of seconds to wait instead of waiting forever
  61    in target_wait().  If this timer times out, then it generates an error and
  62    the command is aborted.  This replaces most of the need for timeouts in the
  63    GDB test suite, and makes it possible to distinguish between a hung target
  64    and one with slow communications.  */
  65
  66 int watchdog = 0;
  67
  68 /*
  69
  70 LOCAL FUNCTION
  71
  72         maintenance_command -- access the maintenance subcommands
  73
  74 SYNOPSIS
  75
  76         void maintenance_command (char *args, int from_tty)
  77
  78 DESCRIPTION
  79
  80 */
  81
  82 static void
  83 maintenance_command (args, from_tty)
  84      char *args;
  85      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
  92 /* ARGSUSED */
  93 static void
  94 maintenance_dump_me (args, from_tty)
  95      char *args;
  96      int from_tty;
  97 {
  98   if (query ("Should GDB dump core? "))
  99     {
 100       signal (SIGQUIT, SIG_DFL);
 101       kill (getpid (), SIGQUIT);
 102     }
 103 }
 104
 105 /*  Someday we should allow demangling for things other than just
 106     explicit strings.  For example, we might want to be able to
 107     specify the address of a string in either GDB's process space
 108     or the debuggee's process space, and have gdb fetch and demangle
 109     that string.  If we have a char* pointer "ptr" that points to
 110     a string, we might want to be able to given just the name and
 111     have GDB demangle and print what it points to, etc.  (FIXME) */
 112
 113 static void
 114 maintenance_demangle (args, from_tty)
 115      char *args;
 116      int from_tty;
 117 {
 118   char *demangled;
 119
 120   if (args == NULL || *args == '\0')
 121     {
 122       printf_unfiltered ("\"maintenance demangle\" takes an argument to demangle.\n");
 123     }
 124   else
 125     {
 126       demangled = cplus_demangle (args, DMGL_ANSI | DMGL_PARAMS);
 127       if (demangled != NULL)
 128         {
 129           printf_unfiltered ("%s\n", demangled);
 130           free (demangled);
 131         }
 132       else
 133         {
 134           printf_unfiltered ("Can't demangle \"%s\"\n", args);
 135         }
 136     }
 137 }
 138
 139 static void
 140 maintenance_time_display (args, from_tty)
 141      char *args;
 142      int from_tty;
 143 {
 144   extern int display_time;
 145
 146   if (args == NULL || *args == '\0')
 147     printf_unfiltered ("\"maintenance time\" takes a numeric argument.\n");
 148   else
 149     display_time = strtol (args, NULL, 10);
 150 }
 151
 152 static void
 153 maintenance_space_display (args, from_tty)
 154      char *args;
 155      int from_tty;
 156 {
 157   extern int display_space;
 158
 159   if (args == NULL || *args == '\0')
 160     printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
 161   else
 162     display_space = strtol (args, NULL, 10);
 163 }
 164
 165 /* The "maintenance info" command is defined as a prefix, with allow_unknown 0.
 166    Therefore, its own definition is called only for "maintenance info" with
 167    no args.  */
 168
 169 /* ARGSUSED */
 170 static void
 171 maintenance_info_command (arg, from_tty)
 172      char *arg;
 173      int from_tty;
 174 {
 175   printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
 176   help_list (maintenanceinfolist, "maintenance info ", -1, gdb_stdout);
 177 }
 178
 179 static void
 180 print_section_table (abfd, asect, ignore)
 181      bfd *abfd;
 182      asection *asect;
 183      PTR ignore;
 184 {
 185   flagword flags;
 186
 187   flags = bfd_get_section_flags (abfd, asect);
 188
 189   /* FIXME-32x64: Need print_address_numeric with field width.  */
 190   printf_filtered ("    %s",
 191                    local_hex_string_custom
 192                      ((unsigned long) bfd_section_vma (abfd, asect), "08l"));
 193   printf_filtered ("->%s",
 194                    local_hex_string_custom
 195                      ((unsigned long) (bfd_section_vma (abfd, asect)
 196                                        + bfd_section_size (abfd, asect)),
 197                       "08l"));
 198   printf_filtered (" at %s",
 199                    local_hex_string_custom
 200                      ((unsigned long) asect->filepos, "08l"));
 201   printf_filtered (": %s", bfd_section_name (abfd, asect));
 202
 203   if (flags & SEC_ALLOC)
 204     printf_filtered (" ALLOC");
 205   if (flags & SEC_LOAD)
 206     printf_filtered (" LOAD");
 207   if (flags & SEC_RELOC)
 208     printf_filtered (" RELOC");
 209   if (flags & SEC_READONLY)
 210     printf_filtered (" READONLY");
 211   if (flags & SEC_CODE)
 212     printf_filtered (" CODE");
 213   if (flags & SEC_DATA)
 214     printf_filtered (" DATA");
 215   if (flags & SEC_ROM)
 216     printf_filtered (" ROM");
 217   if (flags & SEC_CONSTRUCTOR)
 218     printf_filtered (" CONSTRUCTOR");
 219   if (flags & SEC_HAS_CONTENTS)
 220     printf_filtered (" HAS_CONTENTS");
 221   if (flags & SEC_NEVER_LOAD)
 222     printf_filtered (" NEVER_LOAD");
 223   if (flags & SEC_COFF_SHARED_LIBRARY)
 224     printf_filtered (" COFF_SHARED_LIBRARY");
 225   if (flags & SEC_IS_COMMON)
 226     printf_filtered (" IS_COMMON");
 227
 228   printf_filtered ("\n");
 229 }
 230
 231 /* ARGSUSED */
 232 static void
 233 maintenance_info_sections (arg, from_tty)
 234      char *arg;
 235      int from_tty;
 236 {
 237   if (exec_bfd)
 238     {
 239       printf_filtered ("Exec file:\n");
 240       printf_filtered ("    `%s', ", bfd_get_filename(exec_bfd));
 241       wrap_here ("        ");
 242       printf_filtered ("file type %s.\n", bfd_get_target(exec_bfd));
 243       bfd_map_over_sections(exec_bfd, print_section_table, 0);
 244     }
 245
 246   if (core_bfd)
 247     {
 248       printf_filtered ("Core file:\n");
 249       printf_filtered ("    `%s', ", bfd_get_filename(core_bfd));
 250       wrap_here ("        ");
 251       printf_filtered ("file type %s.\n", bfd_get_target(core_bfd));
 252       bfd_map_over_sections(core_bfd, print_section_table, 0);
 253     }
 254 }
 255
 256 /* ARGSUSED */
 257 void
 258 maintenance_print_statistics (args, from_tty)
 259      char *args;
 260      int from_tty;
 261 {
 262   print_objfile_statistics ();
 263   print_symbol_bcache_statistics ();
 264 }
 265
 266 /* The "maintenance print" command is defined as a prefix, with allow_unknown
 267    0.  Therefore, its own definition is called only for "maintenance print"
 268    with no args.  */
 269
 270 /* ARGSUSED */
 271 static void
 272 maintenance_print_command (arg, from_tty)
 273      char *arg;
 274      int from_tty;
 275 {
 276   printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
 277   help_list (maintenanceprintlist, "maintenance print ", -1, gdb_stdout);
 278 }
 279
 280 #endif  /* MAINTENANCE_CMDS */
 281
 282 void
 283 _initialize_maint_cmds ()
 284 {
 285 #if MAINTENANCE_CMDS    /* Entire file goes away if not including maint cmds */
 286   add_prefix_cmd ("maintenance", class_maintenance, maintenance_command,
 287                   "Commands for use by GDB maintainers.\n\
 288 Includes commands to dump specific internal GDB structures in\n\
 289 a human readable form, to cause GDB to deliberately dump core,\n\
 290 to test internal functions such as the C++ demangler, etc.",
 291                   &maintenancelist, "maintenance ", 0,
 292                   &cmdlist);
 293
 294   add_com_alias ("mt", "maintenance", class_maintenance, 1);
 295
 296   add_prefix_cmd ("info", class_maintenance, maintenance_info_command,
 297                   "Commands for showing internal info about the program being debugged.",
 298                   &maintenanceinfolist, "maintenance info ", 0,
 299                   &maintenancelist);
 300
 301   add_cmd ("sections", class_maintenance, maintenance_info_sections,
 302            "List the BFD sections of the exec and core files.",
 303            &maintenanceinfolist);
 304
 305   add_prefix_cmd ("print", class_maintenance, maintenance_print_command,
 306                   "Maintenance command for printing GDB internal state.",
 307                   &maintenanceprintlist, "maintenance print ", 0,
 308                   &maintenancelist);
 309
 310   add_cmd ("dump-me", class_maintenance, maintenance_dump_me,
 311            "Get fatal error; make debugger dump its core.\n\
 312 GDB sets it's handling of SIGQUIT back to SIG_DFL and then sends\n\
 313 itself a SIGQUIT signal.",
 314            &maintenancelist);
 315
 316   add_cmd ("demangle", class_maintenance, maintenance_demangle,
 317            "Demangle a C++ mangled name.\n\
 318 Call internal GDB demangler routine to demangle a C++ link name\n\
 319 and prints the result.",
 320            &maintenancelist);
 321
 322   add_cmd ("time", class_maintenance, maintenance_time_display,
 323            "Set the display of time usage.\n\
 324 If nonzero, will cause the execution time for each command to be\n\
 325 displayed, following the command's output.",
 326            &maintenancelist);
 327
 328   add_cmd ("space", class_maintenance, maintenance_space_display,
 329            "Set the display of space usage.\n\
 330 If nonzero, will cause the execution space for each command to be\n\
 331 displayed, following the command's output.",
 332            &maintenancelist);
 333
 334   add_cmd ("type", class_maintenance, maintenance_print_type,
 335            "Print a type chain for a given symbol.\n\
 336 For each node in a type chain, print the raw data for each member of\n\
 337 the type structure, and the interpretation of the data.",
 338            &maintenanceprintlist);
 339
 340   add_cmd ("symbols", class_maintenance, maintenance_print_symbols,
 341            "Print dump of current symbol definitions.\n\
 342 Entries in the full symbol table are dumped to file OUTFILE.\n\
 343 If a SOURCE file is specified, dump only that file's symbols.",
 344            &maintenanceprintlist);
 345
 346   add_cmd ("msymbols", class_maintenance, maintenance_print_msymbols,
 347            "Print dump of current minimal symbol definitions.\n\
 348 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
 349 If a SOURCE file is specified, dump only that file's minimal symbols.",
 350            &maintenanceprintlist);
 351
 352   add_cmd ("psymbols", class_maintenance, maintenance_print_psymbols,
 353            "Print dump of current partial symbol definitions.\n\
 354 Entries in the partial symbol table are dumped to file OUTFILE.\n\
 355 If a SOURCE file is specified, dump only that file's partial symbols.",
 356            &maintenanceprintlist);
 357
 358   add_cmd ("objfiles", class_maintenance, maintenance_print_objfiles,
 359            "Print dump of current object file definitions.",
 360            &maintenanceprintlist);
 361
 362   add_cmd ("statistics", class_maintenance, maintenance_print_statistics,
 363            "Print statistics about internal gdb state.",
 364            &maintenanceprintlist);
 365
 366   add_cmd ("check-symtabs", class_maintenance, maintenance_check_symtabs,
 367            "Check consistency of psymtabs and symtabs.",
 368            &maintenancelist);
 369
 370   add_show_from_set (
 371     add_set_cmd ("watchdog", class_maintenance, var_zinteger, (char *)&watchdog,
 372                  "Set watchdog timer.\n\
 373 When non-zero, this timeout is used instead of waiting forever for a target to\n\
 374 finish a low-level step or continue operation.  If the specified amount of time\n\
 375 passes without a response from the target, an error occurs.", &setlist),
 376                      &showlist);
 377 #endif  /* MAINTENANCE_CMDS */
 378 }