1 /* Support for GDB maintenance commands.
3 Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
4 2002, 2003, 2004 Free Software Foundation, Inc.
6 Written by Fred Fish at Cygnus Support.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
35 #include "expression.h" /* For language.h */
41 #include "cli/cli-decode.h"
43 extern void _initialize_maint_cmds (void);
45 static void maintenance_command (char *, int);
47 static void maintenance_dump_me (char *, int);
49 static void maintenance_internal_error (char *args, int from_tty);
51 static void maintenance_demangle (char *, int);
53 static void maintenance_time_display (char *, int);
55 static void maintenance_space_display (char *, int);
57 static void maintenance_info_command (char *, int);
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);
96 maintenance_dump_me (char *args, int from_tty)
98 if (query ("Should GDB dump core? "))
101 /* SIGQUIT by default is ignored, so use SIGABRT instead. */
102 signal (SIGABRT, SIG_DFL);
103 kill (getpid (), SIGABRT);
105 signal (SIGQUIT, SIG_DFL);
106 kill (getpid (), SIGQUIT);
112 /* Stimulate the internal error mechanism that GDB uses when an
113 internal problem is detected. Allows testing of the mechanism.
114 Also useful when the user wants to drop a core file but not exit
118 maintenance_internal_error (char *args, int from_tty)
120 internal_error (__FILE__, __LINE__, "%s", (args == NULL ? "" : args));
123 /* Stimulate the internal error mechanism that GDB uses when an
124 internal problem is detected. Allows testing of the mechanism.
125 Also useful when the user wants to drop a core file but not exit
129 maintenance_internal_warning (char *args, int from_tty)
131 internal_warning (__FILE__, __LINE__, "%s", (args == NULL ? "" : args));
134 /* Someday we should allow demangling for things other than just
135 explicit strings. For example, we might want to be able to specify
136 the address of a string in either GDB's process space or the
137 debuggee's process space, and have gdb fetch and demangle that
138 string. If we have a char* pointer "ptr" that points to a string,
139 we might want to be able to given just the name and have GDB
140 demangle and print what it points to, etc. (FIXME) */
143 maintenance_demangle (char *args, int from_tty)
147 if (args == NULL || *args == '\0')
149 printf_unfiltered ("\"maintenance demangle\" takes an argument to demangle.\n");
153 demangled = language_demangle (current_language, args,
154 DMGL_ANSI | DMGL_PARAMS);
155 if (demangled != NULL)
157 printf_unfiltered ("%s\n", demangled);
162 printf_unfiltered ("Can't demangle \"%s\"\n", args);
168 maintenance_time_display (char *args, int from_tty)
170 extern int display_time;
172 if (args == NULL || *args == '\0')
173 printf_unfiltered ("\"maintenance time\" takes a numeric argument.\n");
175 display_time = strtol (args, NULL, 10);
179 maintenance_space_display (char *args, int from_tty)
181 extern int display_space;
183 if (args == NULL || *args == '\0')
184 printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
186 display_space = strtol (args, NULL, 10);
189 /* The "maintenance info" command is defined as a prefix, with
190 allow_unknown 0. Therefore, its own definition is called only for
191 "maintenance info" with no args. */
194 maintenance_info_command (char *arg, int from_tty)
196 printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
197 help_list (maintenanceinfolist, "maintenance info ", -1, gdb_stdout);
200 /* Mini tokenizing lexer for 'maint info sections' command. */
203 match_substring (const char *string, const char *substr)
205 int substr_len = strlen(substr);
208 while ((tok = strstr (string, substr)) != NULL)
210 /* Got a partial match. Is it a whole word? */
215 /* Token is delimited at the front... */
216 if (tok[substr_len] == ' '
217 || tok[substr_len] == '\t'
218 || tok[substr_len] == '\0')
220 /* Token is delimited at the rear. Got a whole-word match. */
224 /* Token didn't match as a whole word. Advance and try again. */
231 match_bfd_flags (char *string, flagword flags)
233 if (flags & SEC_ALLOC)
234 if (match_substring (string, "ALLOC"))
236 if (flags & SEC_LOAD)
237 if (match_substring (string, "LOAD"))
239 if (flags & SEC_RELOC)
240 if (match_substring (string, "RELOC"))
242 if (flags & SEC_READONLY)
243 if (match_substring (string, "READONLY"))
245 if (flags & SEC_CODE)
246 if (match_substring (string, "CODE"))
248 if (flags & SEC_DATA)
249 if (match_substring (string, "DATA"))
252 if (match_substring (string, "ROM"))
254 if (flags & SEC_CONSTRUCTOR)
255 if (match_substring (string, "CONSTRUCTOR"))
257 if (flags & SEC_HAS_CONTENTS)
258 if (match_substring (string, "HAS_CONTENTS"))
260 if (flags & SEC_NEVER_LOAD)
261 if (match_substring (string, "NEVER_LOAD"))
263 if (flags & SEC_COFF_SHARED_LIBRARY)
264 if (match_substring (string, "COFF_SHARED_LIBRARY"))
266 if (flags & SEC_IS_COMMON)
267 if (match_substring (string, "IS_COMMON"))
274 print_bfd_flags (flagword flags)
276 if (flags & SEC_ALLOC)
277 printf_filtered (" ALLOC");
278 if (flags & SEC_LOAD)
279 printf_filtered (" LOAD");
280 if (flags & SEC_RELOC)
281 printf_filtered (" RELOC");
282 if (flags & SEC_READONLY)
283 printf_filtered (" READONLY");
284 if (flags & SEC_CODE)
285 printf_filtered (" CODE");
286 if (flags & SEC_DATA)
287 printf_filtered (" DATA");
289 printf_filtered (" ROM");
290 if (flags & SEC_CONSTRUCTOR)
291 printf_filtered (" CONSTRUCTOR");
292 if (flags & SEC_HAS_CONTENTS)
293 printf_filtered (" HAS_CONTENTS");
294 if (flags & SEC_NEVER_LOAD)
295 printf_filtered (" NEVER_LOAD");
296 if (flags & SEC_COFF_SHARED_LIBRARY)
297 printf_filtered (" COFF_SHARED_LIBRARY");
298 if (flags & SEC_IS_COMMON)
299 printf_filtered (" IS_COMMON");
303 maint_print_section_info (const char *name, flagword flags,
304 CORE_ADDR addr, CORE_ADDR endaddr,
305 unsigned long filepos)
307 /* FIXME-32x64: Need print_address_numeric with field width. */
308 printf_filtered (" 0x%s", paddr (addr));
309 printf_filtered ("->0x%s", paddr (endaddr));
310 printf_filtered (" at %s",
311 hex_string_custom ((unsigned long) filepos, 8));
312 printf_filtered (": %s", name);
313 print_bfd_flags (flags);
314 printf_filtered ("\n");
318 print_bfd_section_info (bfd *abfd,
322 flagword flags = bfd_get_section_flags (abfd, asect);
323 const char *name = bfd_section_name (abfd, asect);
325 if (arg == NULL || *((char *) arg) == '\0'
326 || match_substring ((char *) arg, name)
327 || match_bfd_flags ((char *) arg, flags))
329 CORE_ADDR addr, endaddr;
331 addr = bfd_section_vma (abfd, asect);
332 endaddr = addr + bfd_section_size (abfd, asect);
333 maint_print_section_info (name, flags, addr, endaddr, asect->filepos);
338 print_objfile_section_info (bfd *abfd,
339 struct obj_section *asect,
342 flagword flags = bfd_get_section_flags (abfd, asect->the_bfd_section);
343 const char *name = bfd_section_name (abfd, asect->the_bfd_section);
345 if (string == NULL || *string == '\0'
346 || match_substring (string, name)
347 || match_bfd_flags (string, flags))
349 maint_print_section_info (name, flags, asect->addr, asect->endaddr,
350 asect->the_bfd_section->filepos);
355 maintenance_info_sections (char *arg, int from_tty)
359 printf_filtered ("Exec file:\n");
360 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd));
362 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd));
363 if (arg && *arg && match_substring (arg, "ALLOBJ"))
365 struct objfile *ofile;
366 struct obj_section *osect;
368 /* Only this function cares about the 'ALLOBJ' argument;
369 if 'ALLOBJ' is the only argument, discard it rather than
370 passing it down to print_objfile_section_info (which
371 wouldn't know how to handle it). */
372 if (strcmp (arg, "ALLOBJ") == 0)
377 printf_filtered (" Object file: %s\n",
378 bfd_get_filename (ofile->obfd));
379 ALL_OBJFILE_OSECTIONS (ofile, osect)
381 print_objfile_section_info (ofile->obfd, osect, arg);
386 bfd_map_over_sections (exec_bfd, print_bfd_section_info, arg);
391 printf_filtered ("Core file:\n");
392 printf_filtered (" `%s', ", bfd_get_filename (core_bfd));
394 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd));
395 bfd_map_over_sections (core_bfd, print_bfd_section_info, arg);
400 maintenance_print_statistics (char *args, int from_tty)
402 print_objfile_statistics ();
403 print_symbol_bcache_statistics ();
407 maintenance_print_architecture (char *args, int from_tty)
410 gdbarch_dump (current_gdbarch, gdb_stdout);
413 struct ui_file *file = gdb_fopen (args, "w");
415 perror_with_name (_("maintenance print architecture"));
416 gdbarch_dump (current_gdbarch, file);
417 ui_file_delete (file);
421 /* The "maintenance print" command is defined as a prefix, with
422 allow_unknown 0. Therefore, its own definition is called only for
423 "maintenance print" with no args. */
426 maintenance_print_command (char *arg, int from_tty)
428 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
429 help_list (maintenanceprintlist, "maintenance print ", -1, gdb_stdout);
432 /* The "maintenance translate-address" command converts a section and address
433 to a symbol. This can be called in two ways:
434 maintenance translate-address <secname> <addr>
435 or maintenance translate-address <addr>
439 maintenance_translate_address (char *arg, int from_tty)
444 struct minimal_symbol *sym;
445 struct objfile *objfile;
447 if (arg == NULL || *arg == 0)
448 error (_("requires argument (address or section + address)"));
454 { /* See if we have a valid section name */
455 while (*p && !isspace (*p)) /* Find end of section name */
457 if (*p == '\000') /* End of command? */
458 error (_("Need to specify <section-name> and <address>"));
461 p++; /* Skip whitespace */
463 ALL_OBJFILES (objfile)
465 sect = bfd_get_section_by_name (objfile->obfd, arg);
471 error (_("Unknown section %s."), arg);
474 address = parse_and_eval_address (p);
477 sym = lookup_minimal_symbol_by_pc_section (address, sect);
479 sym = lookup_minimal_symbol_by_pc (address);
482 printf_filtered ("%s+%s\n",
483 SYMBOL_PRINT_NAME (sym),
484 paddr_u (address - SYMBOL_VALUE_ADDRESS (sym)));
486 printf_filtered ("no symbol at %s:0x%s\n", sect->name, paddr (address));
488 printf_filtered ("no symbol at 0x%s\n", paddr (address));
494 /* When a command is deprecated the user will be warned the first time
495 the command is used. If possible, a replacement will be
499 maintenance_deprecate (char *args, int from_tty)
501 if (args == NULL || *args == '\0')
503 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
504 the command you want to deprecate, and optionally the replacement command \n\
505 enclosed in quotes.\n");
508 maintenance_do_deprecate (args, 1);
514 maintenance_undeprecate (char *args, int from_tty)
516 if (args == NULL || *args == '\0')
518 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
519 the command you want to undeprecate.\n");
522 maintenance_do_deprecate (args, 0);
526 /* You really shouldn't be using this. It is just for the testsuite.
527 Rather, you should use deprecate_cmd() when the command is created
528 in _initialize_blah().
530 This function deprecates a command and optionally assigns it a
534 maintenance_do_deprecate (char *text, int deprecate)
537 struct cmd_list_element *alias = NULL;
538 struct cmd_list_element *prefix_cmd = NULL;
539 struct cmd_list_element *cmd = NULL;
541 char *start_ptr = NULL;
542 char *end_ptr = NULL;
544 char *replacement = NULL;
549 if (!lookup_cmd_composition (text, &alias, &prefix_cmd, &cmd))
551 printf_filtered ("Can't find command '%s' to deprecate.\n", text);
557 /* look for a replacement command */
558 start_ptr = strchr (text, '\"');
559 if (start_ptr != NULL)
562 end_ptr = strrchr (start_ptr, '\"');
565 len = end_ptr - start_ptr;
566 start_ptr[len] = '\0';
567 replacement = xstrdup (start_ptr);
572 if (!start_ptr || !end_ptr)
576 /* If they used an alias, we only want to deprecate the alias.
578 Note the MALLOCED_REPLACEMENT test. If the command's replacement
579 string was allocated at compile time we don't want to free the
584 if (alias->flags & MALLOCED_REPLACEMENT)
585 xfree (alias->replacement);
588 alias->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
590 alias->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
591 alias->replacement = replacement;
592 alias->flags |= MALLOCED_REPLACEMENT;
597 if (cmd->flags & MALLOCED_REPLACEMENT)
598 xfree (cmd->replacement);
601 cmd->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
603 cmd->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
604 cmd->replacement = replacement;
605 cmd->flags |= MALLOCED_REPLACEMENT;
610 /* Maintenance set/show framework. */
612 struct cmd_list_element *maintenance_set_cmdlist;
613 struct cmd_list_element *maintenance_show_cmdlist;
616 maintenance_set_cmd (char *args, int from_tty)
618 printf_unfiltered ("\"maintenance set\" must be followed by the name of a set command.\n");
619 help_list (maintenance_set_cmdlist, "maintenance set ", -1, gdb_stdout);
623 maintenance_show_cmd (char *args, int from_tty)
625 cmd_show_list (maintenance_show_cmdlist, from_tty, "");
628 /* Profiling support. */
630 static int maintenance_profile_p;
632 #if defined (HAVE_MONSTARTUP) && defined (HAVE__MCLEANUP)
636 #define TEXTEND &_etext
639 #define TEXTEND &etext
642 static int profiling_state;
645 mcleanup_wrapper (void)
647 extern void _mcleanup (void);
654 maintenance_set_profile_cmd (char *args, int from_tty, struct cmd_list_element *c)
656 if (maintenance_profile_p == profiling_state)
659 profiling_state = maintenance_profile_p;
661 if (maintenance_profile_p)
663 static int profiling_initialized;
665 extern void monstartup (unsigned long, unsigned long);
668 if (!profiling_initialized)
670 atexit (mcleanup_wrapper);
671 profiling_initialized = 1;
674 /* "main" is now always the first function in the text segment, so use
675 its address for monstartup. */
676 monstartup ((unsigned long) &main, (unsigned long) TEXTEND);
680 extern void _mcleanup (void);
686 maintenance_set_profile_cmd (char *args, int from_tty, struct cmd_list_element *c)
688 error (_("Profiling support is not available on this system."));
693 _initialize_maint_cmds (void)
695 struct cmd_list_element *tmpcmd;
697 add_prefix_cmd ("maintenance", class_maintenance, maintenance_command,
698 "Commands for use by GDB maintainers.\n\
699 Includes commands to dump specific internal GDB structures in\n\
700 a human readable form, to cause GDB to deliberately dump core,\n\
701 to test internal functions such as the C++/ObjC demangler, etc.",
702 &maintenancelist, "maintenance ", 0,
705 add_com_alias ("mt", "maintenance", class_maintenance, 1);
707 add_prefix_cmd ("info", class_maintenance, maintenance_info_command,
708 "Commands for showing internal info about the program being debugged.",
709 &maintenanceinfolist, "maintenance info ", 0,
711 add_alias_cmd ("i", "info", class_maintenance, 1, &maintenancelist);
713 add_cmd ("sections", class_maintenance, maintenance_info_sections,
714 "List the BFD sections of the exec and core files. \n\
715 Arguments may be any combination of:\n\
716 [one or more section names]\n\
717 ALLOC LOAD RELOC READONLY CODE DATA ROM CONSTRUCTOR\n\
718 HAS_CONTENTS NEVER_LOAD COFF_SHARED_LIBRARY IS_COMMON\n\
719 Sections matching any argument will be listed (no argument\n\
720 implies all sections). In addition, the special argument\n\
722 lists all sections from all object files, including shared libraries.",
723 &maintenanceinfolist);
725 add_prefix_cmd ("print", class_maintenance, maintenance_print_command,
726 "Maintenance command for printing GDB internal state.",
727 &maintenanceprintlist, "maintenance print ", 0,
730 add_prefix_cmd ("set", class_maintenance, maintenance_set_cmd, "\
731 Set GDB internal variables used by the GDB maintainer.\n\
732 Configure variables internal to GDB that aid in GDB's maintenance",
733 &maintenance_set_cmdlist, "maintenance set ",
737 add_prefix_cmd ("show", class_maintenance, maintenance_show_cmd, "\
738 Show GDB internal variables used by the GDB maintainer.\n\
739 Configure variables internal to GDB that aid in GDB's maintenance",
740 &maintenance_show_cmdlist, "maintenance show ",
745 add_cmd ("dump-me", class_maintenance, maintenance_dump_me,
746 "Get fatal error; make debugger dump its core.\n\
747 GDB sets its handling of SIGQUIT back to SIG_DFL and then sends\n\
748 itself a SIGQUIT signal.",
752 add_cmd ("internal-error", class_maintenance, maintenance_internal_error,
753 "Give GDB an internal error.\n\
754 Cause GDB to behave as if an internal error was detected.",
757 add_cmd ("internal-warning", class_maintenance, maintenance_internal_warning,
758 "Give GDB an internal warning.\n\
759 Cause GDB to behave as if an internal warning was reported.",
762 add_cmd ("demangle", class_maintenance, maintenance_demangle,
763 "Demangle a C++/ObjC mangled name.\n\
764 Call internal GDB demangler routine to demangle a C++ link name\n\
765 and prints the result.",
768 add_cmd ("time", class_maintenance, maintenance_time_display,
769 "Set the display of time usage.\n\
770 If nonzero, will cause the execution time for each command to be\n\
771 displayed, following the command's output.",
774 add_cmd ("space", class_maintenance, maintenance_space_display,
775 "Set the display of space usage.\n\
776 If nonzero, will cause the execution space for each command to be\n\
777 displayed, following the command's output.",
780 add_cmd ("type", class_maintenance, maintenance_print_type,
781 "Print a type chain for a given symbol.\n\
782 For each node in a type chain, print the raw data for each member of\n\
783 the type structure, and the interpretation of the data.",
784 &maintenanceprintlist);
786 add_cmd ("symbols", class_maintenance, maintenance_print_symbols,
787 "Print dump of current symbol definitions.\n\
788 Entries in the full symbol table are dumped to file OUTFILE.\n\
789 If a SOURCE file is specified, dump only that file's symbols.",
790 &maintenanceprintlist);
792 add_cmd ("msymbols", class_maintenance, maintenance_print_msymbols,
793 "Print dump of current minimal symbol definitions.\n\
794 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
795 If a SOURCE file is specified, dump only that file's minimal symbols.",
796 &maintenanceprintlist);
798 add_cmd ("psymbols", class_maintenance, maintenance_print_psymbols,
799 "Print dump of current partial symbol definitions.\n\
800 Entries in the partial symbol table are dumped to file OUTFILE.\n\
801 If a SOURCE file is specified, dump only that file's partial symbols.",
802 &maintenanceprintlist);
804 add_cmd ("objfiles", class_maintenance, maintenance_print_objfiles,
805 "Print dump of current object file definitions.",
806 &maintenanceprintlist);
808 add_cmd ("symtabs", class_maintenance, maintenance_info_symtabs,
809 "List the full symbol tables for all object files.\n\
810 This does not include information about individual symbols, blocks, or\n\
811 linetables --- just the symbol table structures themselves.\n\
812 With an argument REGEXP, list the symbol tables whose names that match that.",
813 &maintenanceinfolist);
815 add_cmd ("psymtabs", class_maintenance, maintenance_info_psymtabs,
816 "List the partial symbol tables for all object files.\n\
817 This does not include information about individual partial symbols,\n\
818 just the symbol table structures themselves.",
819 &maintenanceinfolist);
821 add_cmd ("statistics", class_maintenance, maintenance_print_statistics,
822 "Print statistics about internal gdb state.",
823 &maintenanceprintlist);
825 add_cmd ("architecture", class_maintenance, maintenance_print_architecture,
826 "Print the internal architecture configuration.\
827 Takes an optional file parameter.",
828 &maintenanceprintlist);
830 add_cmd ("check-symtabs", class_maintenance, maintenance_check_symtabs,
831 "Check consistency of psymtabs and symtabs.",
834 add_cmd ("translate-address", class_maintenance, maintenance_translate_address,
835 "Translate a section name and address to a symbol.",
838 add_cmd ("deprecate", class_maintenance, maintenance_deprecate,
839 "Deprecate a command. Note that this is just in here so the \n\
840 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
841 rather you should use the C function deprecate_cmd(). If you decide you \n\
842 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
843 replacement is optional.", &maintenancelist);
845 add_cmd ("undeprecate", class_maintenance, maintenance_undeprecate,
846 "Undeprecate a command. Note that this is just in here so the \n\
847 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
848 If you decide you want to use it: maintenance undeprecate 'commandname'",
851 deprecated_add_show_from_set
852 (add_set_cmd ("watchdog", class_maintenance, var_zinteger,
854 "Set watchdog timer.\n\
855 When non-zero, this timeout is used instead of waiting forever for a target\n\
856 to finish a low-level step or continue operation. If the specified amount\n\
857 of time passes without a response from the target, an error occurs.",
862 add_setshow_boolean_cmd ("profile", class_maintenance,
863 &maintenance_profile_p, "\
864 Set internal profiling.", "\
865 Show internal profiling.", "\
866 When enabled GDB is profiled.",
867 NULL, /* PRINT: Internal profiling is %s. */
868 maintenance_set_profile_cmd, NULL,
869 &maintenance_set_cmdlist,
870 &maintenance_show_cmdlist);