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