1 /* Support for GDB maintenance commands.
2 Copyright 1992, 1993, 1994 Free Software Foundation, Inc.
3 Written by Fred Fish at Cygnus Support.
5 This file is part of GDB.
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.
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.
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. */
32 #include "expression.h" /* For language.h */
38 extern void _initialize_maint_cmds (void);
40 static void maintenance_command (char *, int);
42 static void maintenance_dump_me (char *, int);
44 static void maintenance_internal_error (char *args, int from_tty);
46 static void maintenance_demangle (char *, int);
48 static void maintenance_time_display (char *, int);
50 static void maintenance_space_display (char *, int);
52 static void maintenance_info_command (char *, int);
54 static void print_section_table (bfd *, asection *, PTR);
56 static void maintenance_info_sections (char *, int);
58 static void maintenance_print_command (char *, int);
60 static void maintenance_do_deprecate (char *, int);
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. */
74 maintenance_command -- access the maintenance subcommands
78 void maintenance_command (char *args, int from_tty)
85 maintenance_command (args, from_tty)
89 printf_unfiltered ("\"maintenance\" must be followed by the name of a maintenance command.\n");
90 help_list (maintenancelist, "maintenance ", -1, gdb_stdout);
96 maintenance_dump_me (args, from_tty)
100 if (query ("Should GDB dump core? "))
103 /* SIGQUIT by default is ignored, so use SIGABRT instead. */
104 signal (SIGABRT, SIG_DFL);
105 kill (getpid (), SIGABRT);
107 signal (SIGQUIT, SIG_DFL);
108 kill (getpid (), SIGQUIT);
114 /* Stimulate the internal error mechanism that GDB uses when an
115 internal problem is detected. Allows testing of the mechanism.
116 Also useful when the user wants to drop a core file but not exit
120 maintenance_internal_error (char *args, int from_tty)
122 internal_error ("internal maintenance");
125 /* Someday we should allow demangling for things other than just
126 explicit strings. For example, we might want to be able to specify
127 the address of a string in either GDB's process space or the
128 debuggee's process space, and have gdb fetch and demangle that
129 string. If we have a char* pointer "ptr" that points to a string,
130 we might want to be able to given just the name and have GDB
131 demangle and print what it points to, etc. (FIXME) */
134 maintenance_demangle (args, from_tty)
140 if (args == NULL || *args == '\0')
142 printf_unfiltered ("\"maintenance demangle\" takes an argument to demangle.\n");
146 demangled = cplus_demangle (args, DMGL_ANSI | DMGL_PARAMS);
147 if (demangled != NULL)
149 printf_unfiltered ("%s\n", demangled);
154 printf_unfiltered ("Can't demangle \"%s\"\n", args);
160 maintenance_time_display (args, from_tty)
164 extern int display_time;
166 if (args == NULL || *args == '\0')
167 printf_unfiltered ("\"maintenance time\" takes a numeric argument.\n");
169 display_time = strtol (args, NULL, 10);
173 maintenance_space_display (args, from_tty)
177 extern int display_space;
179 if (args == NULL || *args == '\0')
180 printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
182 display_space = strtol (args, NULL, 10);
185 /* The "maintenance info" command is defined as a prefix, with
186 allow_unknown 0. Therefore, its own definition is called only for
187 "maintenance info" with no args. */
191 maintenance_info_command (arg, from_tty)
195 printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
196 help_list (maintenanceinfolist, "maintenance info ", -1, gdb_stdout);
200 print_section_table (abfd, asect, ignore)
207 flags = bfd_get_section_flags (abfd, asect);
209 /* FIXME-32x64: Need print_address_numeric with field width. */
210 printf_filtered (" %s",
211 local_hex_string_custom
212 ((unsigned long) bfd_section_vma (abfd, asect), "08l"));
213 printf_filtered ("->%s",
214 local_hex_string_custom
215 ((unsigned long) (bfd_section_vma (abfd, asect)
216 + bfd_section_size (abfd, asect)),
218 printf_filtered (" at %s",
219 local_hex_string_custom
220 ((unsigned long) asect->filepos, "08l"));
221 printf_filtered (": %s", bfd_section_name (abfd, asect));
223 if (flags & SEC_ALLOC)
224 printf_filtered (" ALLOC");
225 if (flags & SEC_LOAD)
226 printf_filtered (" LOAD");
227 if (flags & SEC_RELOC)
228 printf_filtered (" RELOC");
229 if (flags & SEC_READONLY)
230 printf_filtered (" READONLY");
231 if (flags & SEC_CODE)
232 printf_filtered (" CODE");
233 if (flags & SEC_DATA)
234 printf_filtered (" DATA");
236 printf_filtered (" ROM");
237 if (flags & SEC_CONSTRUCTOR)
238 printf_filtered (" CONSTRUCTOR");
239 if (flags & SEC_HAS_CONTENTS)
240 printf_filtered (" HAS_CONTENTS");
241 if (flags & SEC_NEVER_LOAD)
242 printf_filtered (" NEVER_LOAD");
243 if (flags & SEC_COFF_SHARED_LIBRARY)
244 printf_filtered (" COFF_SHARED_LIBRARY");
245 if (flags & SEC_IS_COMMON)
246 printf_filtered (" IS_COMMON");
248 printf_filtered ("\n");
253 maintenance_info_sections (arg, from_tty)
259 printf_filtered ("Exec file:\n");
260 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd));
262 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd));
263 bfd_map_over_sections (exec_bfd, print_section_table, 0);
268 printf_filtered ("Core file:\n");
269 printf_filtered (" `%s', ", bfd_get_filename (core_bfd));
271 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd));
272 bfd_map_over_sections (core_bfd, print_section_table, 0);
278 maintenance_print_statistics (args, from_tty)
282 print_objfile_statistics ();
283 print_symbol_bcache_statistics ();
286 /* The "maintenance print" command is defined as a prefix, with
287 allow_unknown 0. Therefore, its own definition is called only for
288 "maintenance print" with no args. */
292 maintenance_print_command (arg, from_tty)
296 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
297 help_list (maintenanceprintlist, "maintenance print ", -1, gdb_stdout);
300 /* The "maintenance translate-address" command converts a section and address
301 to a symbol. This can be called in two ways:
302 maintenance translate-address <secname> <addr>
303 or maintenance translate-address <addr>
307 maintenance_translate_address (arg, from_tty)
314 struct minimal_symbol *sym;
315 struct objfile *objfile;
317 if (arg == NULL || *arg == 0)
318 error ("requires argument (address or section + address)");
324 { /* See if we have a valid section name */
325 while (*p && !isspace (*p)) /* Find end of section name */
327 if (*p == '\000') /* End of command? */
328 error ("Need to specify <section-name> and <address>");
331 p++; /* Skip whitespace */
333 ALL_OBJFILES (objfile)
335 sect = bfd_get_section_by_name (objfile->obfd, arg);
341 error ("Unknown section %s.", arg);
344 address = parse_and_eval_address (p);
347 sym = lookup_minimal_symbol_by_pc_section (address, sect);
349 sym = lookup_minimal_symbol_by_pc (address);
352 printf_filtered ("%s+%s\n",
353 SYMBOL_SOURCE_NAME (sym),
354 paddr_u (address - SYMBOL_VALUE_ADDRESS (sym)));
356 printf_filtered ("no symbol at %s:0x%s\n", sect->name, paddr (address));
358 printf_filtered ("no symbol at 0x%s\n", paddr (address));
364 /* When a comamnd is deprecated the user will be warned the first time
365 the command is used. If possible, a replacement will be
369 maintenance_deprecate (char *args, int from_tty)
371 if (args == NULL || *args == '\0')
373 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
374 the command you want to deprecate, and optionally the replacement command \n\
375 enclosed in quotes.\n");
378 maintenance_do_deprecate (args, 1);
384 maintenance_undeprecate (char *args, int from_tty)
386 if (args == NULL || *args == '\0')
388 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
389 the command you want to undeprecate.\n");
392 maintenance_do_deprecate (args, 0);
396 /* You really shouldn't be using this. It is just for the testsuite.
397 Rather, you should use deprecate_cmd() when the command is created
398 in _initialize_blah().
400 This function deprecates a command and optionally assigns it a
404 maintenance_do_deprecate (char *text, int deprecate)
407 struct cmd_list_element *alias = NULL;
408 struct cmd_list_element *prefix_cmd = NULL;
409 struct cmd_list_element *cmd = NULL;
411 char *start_ptr = NULL;
412 char *end_ptr = NULL;
414 char *replacement = NULL;
419 if (!lookup_cmd_composition (text, &alias, &prefix_cmd, &cmd))
421 printf_filtered ("Can't find command '%s' to deprecate.\n", text);
427 /* look for a replacement command */
428 start_ptr = strchr (text, '\"');
429 if (start_ptr != NULL)
432 end_ptr = strrchr (start_ptr, '\"');
435 len = end_ptr - start_ptr;
436 start_ptr[len] = '\0';
437 replacement = xstrdup (start_ptr);
442 if (!start_ptr || !end_ptr)
446 /* If they used an alias, we only want to deprecate the alias.
448 Note the MALLOCED_REPLACEMENT test. If the command's replacement
449 string was allocated at compile time we don't want to free the
454 if (alias->flags & MALLOCED_REPLACEMENT)
455 free (alias->replacement);
458 alias->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
460 alias->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
461 alias->replacement = replacement;
462 alias->flags |= MALLOCED_REPLACEMENT;
467 if (cmd->flags & MALLOCED_REPLACEMENT)
468 free (cmd->replacement);
471 cmd->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
473 cmd->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
474 cmd->replacement = replacement;
475 cmd->flags |= MALLOCED_REPLACEMENT;
482 _initialize_maint_cmds ()
484 add_prefix_cmd ("maintenance", class_maintenance, maintenance_command,
485 "Commands for use by GDB maintainers.\n\
486 Includes commands to dump specific internal GDB structures in\n\
487 a human readable form, to cause GDB to deliberately dump core,\n\
488 to test internal functions such as the C++ demangler, etc.",
489 &maintenancelist, "maintenance ", 0,
492 add_com_alias ("mt", "maintenance", class_maintenance, 1);
494 add_prefix_cmd ("info", class_maintenance, maintenance_info_command,
495 "Commands for showing internal info about the program being debugged.",
496 &maintenanceinfolist, "maintenance info ", 0,
498 add_alias_cmd ("i", "info", class_maintenance, 1, &maintenancelist);
500 add_cmd ("sections", class_maintenance, maintenance_info_sections,
501 "List the BFD sections of the exec and core files.",
502 &maintenanceinfolist);
504 add_prefix_cmd ("print", class_maintenance, maintenance_print_command,
505 "Maintenance command for printing GDB internal state.",
506 &maintenanceprintlist, "maintenance print ", 0,
510 add_cmd ("dump-me", class_maintenance, maintenance_dump_me,
511 "Get fatal error; make debugger dump its core.\n\
512 GDB sets it's handling of SIGQUIT back to SIG_DFL and then sends\n\
513 itself a SIGQUIT signal.",
517 add_cmd ("internal-error", class_maintenance, maintenance_internal_error,
518 "Give GDB an internal error.\n\
519 Cause GDB to behave as if an internal error was detected.",
522 add_cmd ("demangle", class_maintenance, maintenance_demangle,
523 "Demangle a C++ mangled name.\n\
524 Call internal GDB demangler routine to demangle a C++ link name\n\
525 and prints the result.",
528 add_cmd ("time", class_maintenance, maintenance_time_display,
529 "Set the display of time usage.\n\
530 If nonzero, will cause the execution time for each command to be\n\
531 displayed, following the command's output.",
534 add_cmd ("space", class_maintenance, maintenance_space_display,
535 "Set the display of space usage.\n\
536 If nonzero, will cause the execution space for each command to be\n\
537 displayed, following the command's output.",
540 add_cmd ("type", class_maintenance, maintenance_print_type,
541 "Print a type chain for a given symbol.\n\
542 For each node in a type chain, print the raw data for each member of\n\
543 the type structure, and the interpretation of the data.",
544 &maintenanceprintlist);
546 add_cmd ("symbols", class_maintenance, maintenance_print_symbols,
547 "Print dump of current symbol definitions.\n\
548 Entries in the full symbol table are dumped to file OUTFILE.\n\
549 If a SOURCE file is specified, dump only that file's symbols.",
550 &maintenanceprintlist);
552 add_cmd ("msymbols", class_maintenance, maintenance_print_msymbols,
553 "Print dump of current minimal symbol definitions.\n\
554 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
555 If a SOURCE file is specified, dump only that file's minimal symbols.",
556 &maintenanceprintlist);
558 add_cmd ("psymbols", class_maintenance, maintenance_print_psymbols,
559 "Print dump of current partial symbol definitions.\n\
560 Entries in the partial symbol table are dumped to file OUTFILE.\n\
561 If a SOURCE file is specified, dump only that file's partial symbols.",
562 &maintenanceprintlist);
564 add_cmd ("objfiles", class_maintenance, maintenance_print_objfiles,
565 "Print dump of current object file definitions.",
566 &maintenanceprintlist);
568 add_cmd ("statistics", class_maintenance, maintenance_print_statistics,
569 "Print statistics about internal gdb state.",
570 &maintenanceprintlist);
572 add_cmd ("check-symtabs", class_maintenance, maintenance_check_symtabs,
573 "Check consistency of psymtabs and symtabs.",
576 add_cmd ("translate-address", class_maintenance, maintenance_translate_address,
577 "Translate a section name and address to a symbol.",
580 add_cmd ("deprecate", class_maintenance, maintenance_deprecate,
581 "Deprecate a command. Note that this is just in here so the \n\
582 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
583 rather you should use the C function deprecate_cmd(). If you decide you \n\
584 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
585 replacement is optional.", &maintenancelist);
587 add_cmd ("undeprecate", class_maintenance, maintenance_undeprecate,
588 "Undeprecate a command. Note that this is just in here so the \n\
589 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
590 If you decide you want to use it: maintenance undeprecate 'commandname'",
594 add_set_cmd ("watchdog", class_maintenance, var_zinteger, (char *) &watchdog,
595 "Set watchdog timer.\n\
596 When non-zero, this timeout is used instead of waiting forever for a target to\n\
597 finish a low-level step or continue operation. If the specified amount of time\n\
598 passes without a response from the target, an error occurs.", &setlist),