1 /* Support for GDB maintenance commands.
2 Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001, 2002, 2003
3 Free Software Foundation, Inc.
4 Written by Fred Fish at Cygnus Support.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
33 #include "expression.h" /* For language.h */
39 #include "cli/cli-decode.h"
41 extern void _initialize_maint_cmds (void);
43 static void maintenance_command (char *, int);
45 static void maintenance_dump_me (char *, int);
47 static void maintenance_internal_error (char *args, int from_tty);
49 static void maintenance_demangle (char *, int);
51 static void maintenance_time_display (char *, int);
53 static void maintenance_space_display (char *, int);
55 static void maintenance_info_command (char *, int);
57 static void print_section_table (bfd *, asection *, void *);
59 static void maintenance_info_sections (char *, int);
61 static void maintenance_print_command (char *, int);
63 static void maintenance_do_deprecate (char *, int);
65 /* Set this to the maximum number of seconds to wait instead of waiting forever
66 in target_wait(). If this timer times out, then it generates an error and
67 the command is aborted. This replaces most of the need for timeouts in the
68 GDB test suite, and makes it possible to distinguish between a hung target
69 and one with slow communications. */
77 maintenance_command -- access the maintenance subcommands
81 void maintenance_command (char *args, int from_tty)
88 maintenance_command (char *args, int from_tty)
90 printf_unfiltered ("\"maintenance\" must be followed by the name of a maintenance command.\n");
91 help_list (maintenancelist, "maintenance ", -1, gdb_stdout);
97 maintenance_dump_me (char *args, int from_tty)
99 if (query ("Should GDB dump core? "))
102 /* SIGQUIT by default is ignored, so use SIGABRT instead. */
103 signal (SIGABRT, SIG_DFL);
104 kill (getpid (), SIGABRT);
106 signal (SIGQUIT, SIG_DFL);
107 kill (getpid (), SIGQUIT);
113 /* Stimulate the internal error mechanism that GDB uses when an
114 internal problem is detected. Allows testing of the mechanism.
115 Also useful when the user wants to drop a core file but not exit
119 maintenance_internal_error (char *args, int from_tty)
121 internal_error (__FILE__, __LINE__, "%s", (args == NULL ? "" : args));
124 /* Stimulate the internal error mechanism that GDB uses when an
125 internal problem is detected. Allows testing of the mechanism.
126 Also useful when the user wants to drop a core file but not exit
130 maintenance_internal_warning (char *args, int from_tty)
132 internal_warning (__FILE__, __LINE__, "%s", (args == NULL ? "" : args));
135 /* Someday we should allow demangling for things other than just
136 explicit strings. For example, we might want to be able to specify
137 the address of a string in either GDB's process space or the
138 debuggee's process space, and have gdb fetch and demangle that
139 string. If we have a char* pointer "ptr" that points to a string,
140 we might want to be able to given just the name and have GDB
141 demangle and print what it points to, etc. (FIXME) */
144 maintenance_demangle (char *args, int from_tty)
148 if (args == NULL || *args == '\0')
150 printf_unfiltered ("\"maintenance demangle\" takes an argument to demangle.\n");
154 demangled = language_demangle (current_language, args,
155 DMGL_ANSI | DMGL_PARAMS);
156 if (demangled != NULL)
158 printf_unfiltered ("%s\n", demangled);
163 printf_unfiltered ("Can't demangle \"%s\"\n", args);
169 maintenance_time_display (char *args, int from_tty)
171 extern int display_time;
173 if (args == NULL || *args == '\0')
174 printf_unfiltered ("\"maintenance time\" takes a numeric argument.\n");
176 display_time = strtol (args, NULL, 10);
180 maintenance_space_display (char *args, int from_tty)
182 extern int display_space;
184 if (args == NULL || *args == '\0')
185 printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
187 display_space = strtol (args, NULL, 10);
190 /* The "maintenance info" command is defined as a prefix, with
191 allow_unknown 0. Therefore, its own definition is called only for
192 "maintenance info" with no args. */
196 maintenance_info_command (char *arg, int from_tty)
198 printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
199 help_list (maintenanceinfolist, "maintenance info ", -1, gdb_stdout);
202 /* Mini tokenizing lexer for 'maint info sections' command. */
205 match_substring (const char *string, const char *substr)
207 int substr_len = strlen(substr);
210 while ((tok = strstr (string, substr)) != NULL)
212 /* Got a partial match. Is it a whole word? */
217 /* Token is delimited at the front... */
218 if (tok[substr_len] == ' '
219 || tok[substr_len] == '\t'
220 || tok[substr_len] == '\0')
222 /* Token is delimited at the rear. Got a whole-word match. */
226 /* Token didn't match as a whole word. Advance and try again. */
233 match_bfd_flags (char *string, flagword flags)
235 if (flags & SEC_ALLOC)
236 if (match_substring (string, "ALLOC"))
238 if (flags & SEC_LOAD)
239 if (match_substring (string, "LOAD"))
241 if (flags & SEC_RELOC)
242 if (match_substring (string, "RELOC"))
244 if (flags & SEC_READONLY)
245 if (match_substring (string, "READONLY"))
247 if (flags & SEC_CODE)
248 if (match_substring (string, "CODE"))
250 if (flags & SEC_DATA)
251 if (match_substring (string, "DATA"))
254 if (match_substring (string, "ROM"))
256 if (flags & SEC_CONSTRUCTOR)
257 if (match_substring (string, "CONSTRUCTOR"))
259 if (flags & SEC_HAS_CONTENTS)
260 if (match_substring (string, "HAS_CONTENTS"))
262 if (flags & SEC_NEVER_LOAD)
263 if (match_substring (string, "NEVER_LOAD"))
265 if (flags & SEC_COFF_SHARED_LIBRARY)
266 if (match_substring (string, "COFF_SHARED_LIBRARY"))
268 if (flags & SEC_IS_COMMON)
269 if (match_substring (string, "IS_COMMON"))
276 print_bfd_flags (flagword flags)
278 if (flags & SEC_ALLOC)
279 printf_filtered (" ALLOC");
280 if (flags & SEC_LOAD)
281 printf_filtered (" LOAD");
282 if (flags & SEC_RELOC)
283 printf_filtered (" RELOC");
284 if (flags & SEC_READONLY)
285 printf_filtered (" READONLY");
286 if (flags & SEC_CODE)
287 printf_filtered (" CODE");
288 if (flags & SEC_DATA)
289 printf_filtered (" DATA");
291 printf_filtered (" ROM");
292 if (flags & SEC_CONSTRUCTOR)
293 printf_filtered (" CONSTRUCTOR");
294 if (flags & SEC_HAS_CONTENTS)
295 printf_filtered (" HAS_CONTENTS");
296 if (flags & SEC_NEVER_LOAD)
297 printf_filtered (" NEVER_LOAD");
298 if (flags & SEC_COFF_SHARED_LIBRARY)
299 printf_filtered (" COFF_SHARED_LIBRARY");
300 if (flags & SEC_IS_COMMON)
301 printf_filtered (" IS_COMMON");
305 maint_print_section_info (const char *name, flagword flags,
306 CORE_ADDR addr, CORE_ADDR endaddr,
307 unsigned long filepos)
309 /* FIXME-32x64: Need print_address_numeric with field width. */
310 printf_filtered (" 0x%s", paddr (addr));
311 printf_filtered ("->0x%s", paddr (endaddr));
312 printf_filtered (" at %s",
313 local_hex_string_custom ((unsigned long) filepos, "08l"));
314 printf_filtered (": %s", name);
315 print_bfd_flags (flags);
316 printf_filtered ("\n");
320 print_bfd_section_info (bfd *abfd,
324 flagword flags = bfd_get_section_flags (abfd, asect);
325 const char *name = bfd_section_name (abfd, asect);
327 if (arg == NULL || *((char *) arg) == '\0'
328 || match_substring ((char *) arg, name)
329 || match_bfd_flags ((char *) arg, flags))
331 CORE_ADDR addr, endaddr;
333 addr = bfd_section_vma (abfd, asect);
334 endaddr = addr + bfd_section_size (abfd, asect);
335 maint_print_section_info (name, flags, addr, endaddr, asect->filepos);
340 print_objfile_section_info (bfd *abfd,
341 struct obj_section *asect,
344 flagword flags = bfd_get_section_flags (abfd, asect->the_bfd_section);
345 const char *name = bfd_section_name (abfd, asect->the_bfd_section);
347 if (string == NULL || *string == '\0'
348 || match_substring (string, name)
349 || match_bfd_flags (string, flags))
351 maint_print_section_info (name, flags, asect->addr, asect->endaddr,
352 asect->the_bfd_section->filepos);
358 maintenance_info_sections (char *arg, int from_tty)
362 printf_filtered ("Exec file:\n");
363 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd));
365 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd));
366 if (arg && *arg && match_substring (arg, "ALLOBJ"))
368 struct objfile *ofile;
369 struct obj_section *osect;
371 /* Only this function cares about the 'ALLOBJ' argument;
372 if 'ALLOBJ' is the only argument, discard it rather than
373 passing it down to print_objfile_section_info (which
374 wouldn't know how to handle it). */
375 if (strcmp (arg, "ALLOBJ") == 0)
380 printf_filtered (" Object file: %s\n",
381 bfd_get_filename (ofile->obfd));
382 ALL_OBJFILE_OSECTIONS (ofile, osect)
384 print_objfile_section_info (ofile->obfd, osect, arg);
389 bfd_map_over_sections (exec_bfd, print_bfd_section_info, arg);
394 printf_filtered ("Core file:\n");
395 printf_filtered (" `%s', ", bfd_get_filename (core_bfd));
397 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd));
398 bfd_map_over_sections (core_bfd, print_bfd_section_info, arg);
404 maintenance_print_statistics (char *args, int from_tty)
406 print_objfile_statistics ();
407 print_symbol_bcache_statistics ();
411 maintenance_print_architecture (char *args, int from_tty)
414 gdbarch_dump (current_gdbarch, gdb_stdout);
417 struct ui_file *file = gdb_fopen (args, "w");
419 perror_with_name ("maintenance print architecture");
420 gdbarch_dump (current_gdbarch, file);
421 ui_file_delete (file);
425 /* The "maintenance print" command is defined as a prefix, with
426 allow_unknown 0. Therefore, its own definition is called only for
427 "maintenance print" with no args. */
431 maintenance_print_command (char *arg, int from_tty)
433 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
434 help_list (maintenanceprintlist, "maintenance print ", -1, gdb_stdout);
437 /* The "maintenance translate-address" command converts a section and address
438 to a symbol. This can be called in two ways:
439 maintenance translate-address <secname> <addr>
440 or maintenance translate-address <addr>
444 maintenance_translate_address (char *arg, int from_tty)
449 struct minimal_symbol *sym;
450 struct objfile *objfile;
452 if (arg == NULL || *arg == 0)
453 error ("requires argument (address or section + address)");
459 { /* See if we have a valid section name */
460 while (*p && !isspace (*p)) /* Find end of section name */
462 if (*p == '\000') /* End of command? */
463 error ("Need to specify <section-name> and <address>");
466 p++; /* Skip whitespace */
468 ALL_OBJFILES (objfile)
470 sect = bfd_get_section_by_name (objfile->obfd, arg);
476 error ("Unknown section %s.", arg);
479 address = parse_and_eval_address (p);
482 sym = lookup_minimal_symbol_by_pc_section (address, sect);
484 sym = lookup_minimal_symbol_by_pc (address);
487 printf_filtered ("%s+%s\n",
488 SYMBOL_PRINT_NAME (sym),
489 paddr_u (address - SYMBOL_VALUE_ADDRESS (sym)));
491 printf_filtered ("no symbol at %s:0x%s\n", sect->name, paddr (address));
493 printf_filtered ("no symbol at 0x%s\n", paddr (address));
499 /* When a command is deprecated the user will be warned the first time
500 the command is used. If possible, a replacement will be
504 maintenance_deprecate (char *args, int from_tty)
506 if (args == NULL || *args == '\0')
508 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
509 the command you want to deprecate, and optionally the replacement command \n\
510 enclosed in quotes.\n");
513 maintenance_do_deprecate (args, 1);
519 maintenance_undeprecate (char *args, int from_tty)
521 if (args == NULL || *args == '\0')
523 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
524 the command you want to undeprecate.\n");
527 maintenance_do_deprecate (args, 0);
531 /* You really shouldn't be using this. It is just for the testsuite.
532 Rather, you should use deprecate_cmd() when the command is created
533 in _initialize_blah().
535 This function deprecates a command and optionally assigns it a
539 maintenance_do_deprecate (char *text, int deprecate)
542 struct cmd_list_element *alias = NULL;
543 struct cmd_list_element *prefix_cmd = NULL;
544 struct cmd_list_element *cmd = NULL;
546 char *start_ptr = NULL;
547 char *end_ptr = NULL;
549 char *replacement = NULL;
554 if (!lookup_cmd_composition (text, &alias, &prefix_cmd, &cmd))
556 printf_filtered ("Can't find command '%s' to deprecate.\n", text);
562 /* look for a replacement command */
563 start_ptr = strchr (text, '\"');
564 if (start_ptr != NULL)
567 end_ptr = strrchr (start_ptr, '\"');
570 len = end_ptr - start_ptr;
571 start_ptr[len] = '\0';
572 replacement = xstrdup (start_ptr);
577 if (!start_ptr || !end_ptr)
581 /* If they used an alias, we only want to deprecate the alias.
583 Note the MALLOCED_REPLACEMENT test. If the command's replacement
584 string was allocated at compile time we don't want to free the
589 if (alias->flags & MALLOCED_REPLACEMENT)
590 xfree (alias->replacement);
593 alias->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
595 alias->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
596 alias->replacement = replacement;
597 alias->flags |= MALLOCED_REPLACEMENT;
602 if (cmd->flags & MALLOCED_REPLACEMENT)
603 xfree (cmd->replacement);
606 cmd->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
608 cmd->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
609 cmd->replacement = replacement;
610 cmd->flags |= MALLOCED_REPLACEMENT;
615 /* Maintenance set/show framework. */
617 static struct cmd_list_element *maintenance_set_cmdlist;
618 static struct cmd_list_element *maintenance_show_cmdlist;
621 maintenance_set_cmd (char *args, int from_tty)
623 printf_unfiltered ("\"maintenance set\" must be followed by the name of a set command.\n");
624 help_list (maintenance_set_cmdlist, "maintenance set ", -1, gdb_stdout);
628 maintenance_show_cmd (char *args, int from_tty)
630 cmd_show_list (maintenance_show_cmdlist, from_tty, "");
633 /* Profiling support. */
635 static int maintenance_profile_p;
637 #if defined (HAVE_MONSTARTUP) && defined (HAVE__MCLEANUP)
641 #define TEXTEND &_etext
644 #define TEXTEND &etext
647 static int profiling_state;
650 mcleanup_wrapper (void)
652 extern void _mcleanup (void);
659 maintenance_set_profile_cmd (char *args, int from_tty, struct cmd_list_element *c)
661 if (maintenance_profile_p == profiling_state)
664 profiling_state = maintenance_profile_p;
666 if (maintenance_profile_p)
668 static int profiling_initialized;
670 extern void monstartup (unsigned long, unsigned long);
673 if (!profiling_initialized)
675 atexit (mcleanup_wrapper);
676 profiling_initialized = 1;
679 /* "main" is now always the first function in the text segment, so use
680 its address for monstartup. */
681 monstartup ((unsigned long) &main, (unsigned long) TEXTEND);
685 extern void _mcleanup (void);
691 maintenance_set_profile_cmd (char *args, int from_tty, struct cmd_list_element *c)
693 error ("Profiling support is not available on this system.");
698 _initialize_maint_cmds (void)
700 struct cmd_list_element *tmpcmd;
702 add_prefix_cmd ("maintenance", class_maintenance, maintenance_command,
703 "Commands for use by GDB maintainers.\n\
704 Includes commands to dump specific internal GDB structures in\n\
705 a human readable form, to cause GDB to deliberately dump core,\n\
706 to test internal functions such as the C++/ObjC demangler, etc.",
707 &maintenancelist, "maintenance ", 0,
710 add_com_alias ("mt", "maintenance", class_maintenance, 1);
712 add_prefix_cmd ("info", class_maintenance, maintenance_info_command,
713 "Commands for showing internal info about the program being debugged.",
714 &maintenanceinfolist, "maintenance info ", 0,
716 add_alias_cmd ("i", "info", class_maintenance, 1, &maintenancelist);
718 add_cmd ("sections", class_maintenance, maintenance_info_sections,
719 "List the BFD sections of the exec and core files. \n\
720 Arguments may be any combination of:\n\
721 [one or more section names]\n\
722 ALLOC LOAD RELOC READONLY CODE DATA ROM CONSTRUCTOR\n\
723 HAS_CONTENTS NEVER_LOAD COFF_SHARED_LIBRARY IS_COMMON\n\
724 Sections matching any argument will be listed (no argument\n\
725 implies all sections). In addition, the special argument\n\
727 lists all sections from all object files, including shared libraries.",
728 &maintenanceinfolist);
730 add_prefix_cmd ("print", class_maintenance, maintenance_print_command,
731 "Maintenance command for printing GDB internal state.",
732 &maintenanceprintlist, "maintenance print ", 0,
735 add_prefix_cmd ("set", class_maintenance, maintenance_set_cmd, "\
736 Set GDB internal variables used by the GDB maintainer.\n\
737 Configure variables internal to GDB that aid in GDB's maintenance",
738 &maintenance_set_cmdlist, "maintenance set ",
742 add_prefix_cmd ("show", class_maintenance, maintenance_show_cmd, "\
743 Show GDB internal variables used by the GDB maintainer.\n\
744 Configure variables internal to GDB that aid in GDB's maintenance",
745 &maintenance_show_cmdlist, "maintenance show ",
750 add_cmd ("dump-me", class_maintenance, maintenance_dump_me,
751 "Get fatal error; make debugger dump its core.\n\
752 GDB sets its handling of SIGQUIT back to SIG_DFL and then sends\n\
753 itself a SIGQUIT signal.",
757 add_cmd ("internal-error", class_maintenance, maintenance_internal_error,
758 "Give GDB an internal error.\n\
759 Cause GDB to behave as if an internal error was detected.",
762 add_cmd ("internal-warning", class_maintenance, maintenance_internal_warning,
763 "Give GDB an internal warning.\n\
764 Cause GDB to behave as if an internal warning was reported.",
767 add_cmd ("demangle", class_maintenance, maintenance_demangle,
768 "Demangle a C++/ObjC mangled name.\n\
769 Call internal GDB demangler routine to demangle a C++ link name\n\
770 and prints the result.",
773 add_cmd ("time", class_maintenance, maintenance_time_display,
774 "Set the display of time usage.\n\
775 If nonzero, will cause the execution time for each command to be\n\
776 displayed, following the command's output.",
779 add_cmd ("space", class_maintenance, maintenance_space_display,
780 "Set the display of space usage.\n\
781 If nonzero, will cause the execution space for each command to be\n\
782 displayed, following the command's output.",
785 add_cmd ("type", class_maintenance, maintenance_print_type,
786 "Print a type chain for a given symbol.\n\
787 For each node in a type chain, print the raw data for each member of\n\
788 the type structure, and the interpretation of the data.",
789 &maintenanceprintlist);
791 add_cmd ("symbols", class_maintenance, maintenance_print_symbols,
792 "Print dump of current symbol definitions.\n\
793 Entries in the full symbol table are dumped to file OUTFILE.\n\
794 If a SOURCE file is specified, dump only that file's symbols.",
795 &maintenanceprintlist);
797 add_cmd ("msymbols", class_maintenance, maintenance_print_msymbols,
798 "Print dump of current minimal symbol definitions.\n\
799 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
800 If a SOURCE file is specified, dump only that file's minimal symbols.",
801 &maintenanceprintlist);
803 add_cmd ("psymbols", class_maintenance, maintenance_print_psymbols,
804 "Print dump of current partial symbol definitions.\n\
805 Entries in the partial symbol table are dumped to file OUTFILE.\n\
806 If a SOURCE file is specified, dump only that file's partial symbols.",
807 &maintenanceprintlist);
809 add_cmd ("objfiles", class_maintenance, maintenance_print_objfiles,
810 "Print dump of current object file definitions.",
811 &maintenanceprintlist);
813 add_cmd ("symtabs", class_maintenance, maintenance_info_symtabs,
814 "List the full symbol tables for all object files.\n\
815 This does not include information about individual symbols, blocks, or\n\
816 linetables --- just the symbol table structures themselves.\n\
817 With an argument REGEXP, list the symbol tables whose names that match that.",
818 &maintenanceinfolist);
820 add_cmd ("psymtabs", class_maintenance, maintenance_info_psymtabs,
821 "List the partial symbol tables for all object files.\n\
822 This does not include information about individual partial symbols,\n\
823 just the symbol table structures themselves.",
824 &maintenanceinfolist);
826 add_cmd ("statistics", class_maintenance, maintenance_print_statistics,
827 "Print statistics about internal gdb state.",
828 &maintenanceprintlist);
830 add_cmd ("architecture", class_maintenance, maintenance_print_architecture,
831 "Print the internal architecture configuration.\
832 Takes an optional file parameter.",
833 &maintenanceprintlist);
835 add_cmd ("check-symtabs", class_maintenance, maintenance_check_symtabs,
836 "Check consistency of psymtabs and symtabs.",
839 add_cmd ("translate-address", class_maintenance, maintenance_translate_address,
840 "Translate a section name and address to a symbol.",
843 add_cmd ("deprecate", class_maintenance, maintenance_deprecate,
844 "Deprecate a command. Note that this is just in here so the \n\
845 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
846 rather you should use the C function deprecate_cmd(). If you decide you \n\
847 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
848 replacement is optional.", &maintenancelist);
850 add_cmd ("undeprecate", class_maintenance, maintenance_undeprecate,
851 "Undeprecate a command. Note that this is just in here so the \n\
852 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
853 If you decide you want to use it: maintenance undeprecate 'commandname'",
857 add_set_cmd ("watchdog", class_maintenance, var_zinteger, (char *) &watchdog,
858 "Set watchdog timer.\n\
859 When non-zero, this timeout is used instead of waiting forever for a target to\n\
860 finish a low-level step or continue operation. If the specified amount of time\n\
861 passes without a response from the target, an error occurs.", &setlist),
865 add_setshow_boolean_cmd ("profile", class_maintenance,
866 &maintenance_profile_p,
867 "Set internal profiling.\n"
868 "When enabled GDB is profiled.",
869 "Show internal profiling.\n",
870 maintenance_set_profile_cmd, NULL,
871 &maintenance_set_cmdlist,
872 &maintenance_show_cmdlist);