1 /* Support for GDB maintenance commands.
2 Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001
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 extern void _initialize_maint_cmds (void);
41 static void maintenance_command (char *, int);
43 static void maintenance_dump_me (char *, int);
45 static void maintenance_internal_error (char *args, int from_tty);
47 static void maintenance_demangle (char *, int);
49 static void maintenance_time_display (char *, int);
51 static void maintenance_space_display (char *, int);
53 static void maintenance_info_command (char *, int);
55 static void print_section_table (bfd *, asection *, void *);
57 static void maintenance_info_sections (char *, int);
59 static void maintenance_print_command (char *, int);
61 static void maintenance_do_deprecate (char *, int);
63 /* Set this to the maximum number of seconds to wait instead of waiting forever
64 in target_wait(). If this timer times out, then it generates an error and
65 the command is aborted. This replaces most of the need for timeouts in the
66 GDB test suite, and makes it possible to distinguish between a hung target
67 and one with slow communications. */
75 maintenance_command -- access the maintenance subcommands
79 void maintenance_command (char *args, int from_tty)
86 maintenance_command (char *args, int from_tty)
88 printf_unfiltered ("\"maintenance\" must be followed by the name of a maintenance command.\n");
89 help_list (maintenancelist, "maintenance ", -1, gdb_stdout);
95 maintenance_dump_me (char *args, int from_tty)
97 if (query ("Should GDB dump core? "))
100 /* SIGQUIT by default is ignored, so use SIGABRT instead. */
101 signal (SIGABRT, SIG_DFL);
102 kill (getpid (), SIGABRT);
104 signal (SIGQUIT, SIG_DFL);
105 kill (getpid (), SIGQUIT);
111 /* Stimulate the internal error mechanism that GDB uses when an
112 internal problem is detected. Allows testing of the mechanism.
113 Also useful when the user wants to drop a core file but not exit
117 maintenance_internal_error (char *args, int from_tty)
119 internal_error (__FILE__, __LINE__,
120 "internal maintenance");
123 /* Someday we should allow demangling for things other than just
124 explicit strings. For example, we might want to be able to specify
125 the address of a string in either GDB's process space or the
126 debuggee's process space, and have gdb fetch and demangle that
127 string. If we have a char* pointer "ptr" that points to a string,
128 we might want to be able to given just the name and have GDB
129 demangle and print what it points to, etc. (FIXME) */
132 maintenance_demangle (char *args, int from_tty)
136 if (args == NULL || *args == '\0')
138 printf_unfiltered ("\"maintenance demangle\" takes an argument to demangle.\n");
142 demangled = cplus_demangle (args, DMGL_ANSI | DMGL_PARAMS);
143 if (demangled != NULL)
145 printf_unfiltered ("%s\n", demangled);
150 printf_unfiltered ("Can't demangle \"%s\"\n", args);
156 maintenance_time_display (char *args, int from_tty)
158 extern int display_time;
160 if (args == NULL || *args == '\0')
161 printf_unfiltered ("\"maintenance time\" takes a numeric argument.\n");
163 display_time = strtol (args, NULL, 10);
167 maintenance_space_display (char *args, int from_tty)
169 extern int display_space;
171 if (args == NULL || *args == '\0')
172 printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
174 display_space = strtol (args, NULL, 10);
177 /* The "maintenance info" command is defined as a prefix, with
178 allow_unknown 0. Therefore, its own definition is called only for
179 "maintenance info" with no args. */
183 maintenance_info_command (char *arg, int from_tty)
185 printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
186 help_list (maintenanceinfolist, "maintenance info ", -1, gdb_stdout);
189 /* Mini tokenizing lexer for 'maint info sections' command. */
192 match_substring (const char *string, const char *substr)
194 int substr_len = strlen(substr);
197 while ((tok = strstr (string, substr)) != NULL)
199 /* Got a partial match. Is it a whole word? */
204 /* Token is delimited at the front... */
205 if (tok[substr_len] == ' '
206 || tok[substr_len] == '\t'
207 || tok[substr_len] == '\0')
209 /* Token is delimited at the rear. Got a whole-word match. */
213 /* Token didn't match as a whole word. Advance and try again. */
220 match_bfd_flags (char *string, flagword flags)
222 if (flags & SEC_ALLOC)
223 if (match_substring (string, "ALLOC"))
225 if (flags & SEC_LOAD)
226 if (match_substring (string, "LOAD"))
228 if (flags & SEC_RELOC)
229 if (match_substring (string, "RELOC"))
231 if (flags & SEC_READONLY)
232 if (match_substring (string, "READONLY"))
234 if (flags & SEC_CODE)
235 if (match_substring (string, "CODE"))
237 if (flags & SEC_DATA)
238 if (match_substring (string, "DATA"))
241 if (match_substring (string, "ROM"))
243 if (flags & SEC_CONSTRUCTOR)
244 if (match_substring (string, "CONSTRUCTOR"))
246 if (flags & SEC_HAS_CONTENTS)
247 if (match_substring (string, "HAS_CONTENTS"))
249 if (flags & SEC_NEVER_LOAD)
250 if (match_substring (string, "NEVER_LOAD"))
252 if (flags & SEC_COFF_SHARED_LIBRARY)
253 if (match_substring (string, "COFF_SHARED_LIBRARY"))
255 if (flags & SEC_IS_COMMON)
256 if (match_substring (string, "IS_COMMON"))
263 print_bfd_flags (flagword flags)
265 if (flags & SEC_ALLOC)
266 printf_filtered (" ALLOC");
267 if (flags & SEC_LOAD)
268 printf_filtered (" LOAD");
269 if (flags & SEC_RELOC)
270 printf_filtered (" RELOC");
271 if (flags & SEC_READONLY)
272 printf_filtered (" READONLY");
273 if (flags & SEC_CODE)
274 printf_filtered (" CODE");
275 if (flags & SEC_DATA)
276 printf_filtered (" DATA");
278 printf_filtered (" ROM");
279 if (flags & SEC_CONSTRUCTOR)
280 printf_filtered (" CONSTRUCTOR");
281 if (flags & SEC_HAS_CONTENTS)
282 printf_filtered (" HAS_CONTENTS");
283 if (flags & SEC_NEVER_LOAD)
284 printf_filtered (" NEVER_LOAD");
285 if (flags & SEC_COFF_SHARED_LIBRARY)
286 printf_filtered (" COFF_SHARED_LIBRARY");
287 if (flags & SEC_IS_COMMON)
288 printf_filtered (" IS_COMMON");
292 print_section_info (const char *name, flagword flags,
293 CORE_ADDR addr, CORE_ADDR endaddr,
294 unsigned long filepos)
296 /* FIXME-32x64: Need print_address_numeric with field width. */
297 printf_filtered (" 0x%s", paddr (addr));
298 printf_filtered ("->0x%s", paddr (endaddr));
299 printf_filtered (" at 0x%s",
300 local_hex_string_custom ((unsigned long) filepos, "08l"));
301 printf_filtered (": %s", name);
302 print_bfd_flags (flags);
303 printf_filtered ("\n");
307 print_bfd_section_info (bfd *abfd,
311 flagword flags = bfd_get_section_flags (abfd, asect);
312 const char *name = bfd_section_name (abfd, asect);
314 if (arg == NULL || *((char *) arg) == '\0'
315 || match_substring ((char *) arg, name)
316 || match_bfd_flags ((char *) arg, flags))
318 CORE_ADDR addr, endaddr;
320 addr = bfd_section_vma (abfd, asect);
321 endaddr = addr + bfd_section_size (abfd, asect);
322 print_section_info (name, flags, addr, endaddr, asect->filepos);
327 print_objfile_section_info (bfd *abfd,
328 struct obj_section *asect,
331 flagword flags = bfd_get_section_flags (abfd, asect->the_bfd_section);
332 const char *name = bfd_section_name (abfd, asect->the_bfd_section);
334 if (string == NULL || *string == '\0'
335 || match_substring (string, name)
336 || match_bfd_flags (string, flags))
338 print_section_info (name, flags, asect->addr, asect->endaddr,
339 asect->the_bfd_section->filepos);
345 maintenance_info_sections (char *arg, int from_tty)
349 printf_filtered ("Exec file:\n");
350 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd));
352 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd));
353 if (arg && *arg && match_substring (arg, "ALLOBJ"))
355 struct objfile *ofile;
356 struct obj_section *osect;
358 /* Only this function cares about the 'ALLOBJ' argument;
359 if 'ALLOBJ' is the only argument, discard it rather than
360 passing it down to print_objfile_section_info (which
361 wouldn't know how to handle it). */
362 if (strcmp (arg, "ALLOBJ") == 0)
367 printf_filtered (" Object file: %s\n",
368 bfd_get_filename (ofile->obfd));
369 ALL_OBJFILE_OSECTIONS (ofile, osect)
371 print_objfile_section_info (ofile->obfd, osect, arg);
376 bfd_map_over_sections (exec_bfd, print_bfd_section_info, arg);
381 printf_filtered ("Core file:\n");
382 printf_filtered (" `%s', ", bfd_get_filename (core_bfd));
384 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd));
385 bfd_map_over_sections (core_bfd, print_bfd_section_info, arg);
391 maintenance_print_statistics (char *args, int from_tty)
393 print_objfile_statistics ();
394 print_symbol_bcache_statistics ();
398 maintenance_print_architecture (char *args, int from_tty)
401 gdbarch_dump (current_gdbarch, gdb_stdout);
404 struct ui_file *file = gdb_fopen (args, "w");
406 perror_with_name ("maintenance print architecture");
407 gdbarch_dump (current_gdbarch, file);
408 ui_file_delete (file);
412 /* The "maintenance print" command is defined as a prefix, with
413 allow_unknown 0. Therefore, its own definition is called only for
414 "maintenance print" with no args. */
418 maintenance_print_command (char *arg, int from_tty)
420 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
421 help_list (maintenanceprintlist, "maintenance print ", -1, gdb_stdout);
424 /* The "maintenance translate-address" command converts a section and address
425 to a symbol. This can be called in two ways:
426 maintenance translate-address <secname> <addr>
427 or maintenance translate-address <addr>
431 maintenance_translate_address (char *arg, int from_tty)
436 struct minimal_symbol *sym;
437 struct objfile *objfile;
439 if (arg == NULL || *arg == 0)
440 error ("requires argument (address or section + address)");
446 { /* See if we have a valid section name */
447 while (*p && !isspace (*p)) /* Find end of section name */
449 if (*p == '\000') /* End of command? */
450 error ("Need to specify <section-name> and <address>");
453 p++; /* Skip whitespace */
455 ALL_OBJFILES (objfile)
457 sect = bfd_get_section_by_name (objfile->obfd, arg);
463 error ("Unknown section %s.", arg);
466 address = parse_and_eval_address (p);
469 sym = lookup_minimal_symbol_by_pc_section (address, sect);
471 sym = lookup_minimal_symbol_by_pc (address);
474 printf_filtered ("%s+%s\n",
475 SYMBOL_SOURCE_NAME (sym),
476 paddr_u (address - SYMBOL_VALUE_ADDRESS (sym)));
478 printf_filtered ("no symbol at %s:0x%s\n", sect->name, paddr (address));
480 printf_filtered ("no symbol at 0x%s\n", paddr (address));
486 /* When a command is deprecated the user will be warned the first time
487 the command is used. If possible, a replacement will be
491 maintenance_deprecate (char *args, int from_tty)
493 if (args == NULL || *args == '\0')
495 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
496 the command you want to deprecate, and optionally the replacement command \n\
497 enclosed in quotes.\n");
500 maintenance_do_deprecate (args, 1);
506 maintenance_undeprecate (char *args, int from_tty)
508 if (args == NULL || *args == '\0')
510 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
511 the command you want to undeprecate.\n");
514 maintenance_do_deprecate (args, 0);
518 /* You really shouldn't be using this. It is just for the testsuite.
519 Rather, you should use deprecate_cmd() when the command is created
520 in _initialize_blah().
522 This function deprecates a command and optionally assigns it a
526 maintenance_do_deprecate (char *text, int deprecate)
529 struct cmd_list_element *alias = NULL;
530 struct cmd_list_element *prefix_cmd = NULL;
531 struct cmd_list_element *cmd = NULL;
533 char *start_ptr = NULL;
534 char *end_ptr = NULL;
536 char *replacement = NULL;
541 if (!lookup_cmd_composition (text, &alias, &prefix_cmd, &cmd))
543 printf_filtered ("Can't find command '%s' to deprecate.\n", text);
549 /* look for a replacement command */
550 start_ptr = strchr (text, '\"');
551 if (start_ptr != NULL)
554 end_ptr = strrchr (start_ptr, '\"');
557 len = end_ptr - start_ptr;
558 start_ptr[len] = '\0';
559 replacement = xstrdup (start_ptr);
564 if (!start_ptr || !end_ptr)
568 /* If they used an alias, we only want to deprecate the alias.
570 Note the MALLOCED_REPLACEMENT test. If the command's replacement
571 string was allocated at compile time we don't want to free the
576 if (alias->flags & MALLOCED_REPLACEMENT)
577 xfree (alias->replacement);
580 alias->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
582 alias->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
583 alias->replacement = replacement;
584 alias->flags |= MALLOCED_REPLACEMENT;
589 if (cmd->flags & MALLOCED_REPLACEMENT)
590 xfree (cmd->replacement);
593 cmd->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
595 cmd->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
596 cmd->replacement = replacement;
597 cmd->flags |= MALLOCED_REPLACEMENT;
602 /* Maintenance set/show framework. */
604 static struct cmd_list_element *maintenance_set_cmdlist;
605 static struct cmd_list_element *maintenance_show_cmdlist;
608 maintenance_set_cmd (char *args, int from_tty)
610 printf_unfiltered ("\"maintenance set\" must be followed by the name of a set command.\n");
611 help_list (maintenance_set_cmdlist, "maintenance set ", -1, gdb_stdout);
615 maintenance_show_cmd (char *args, int from_tty)
617 cmd_show_list (maintenance_show_cmdlist, from_tty, "");
621 /* Profiling support. */
623 static int maintenance_profile_p;
626 maintenance_set_profile_cmd (char *args, int from_tty, struct cmd_list_element *c)
628 maintenance_profile_p = 0;
629 warning ("\"maintenance set profile\" command not supported.\n");
634 _initialize_maint_cmds (void)
636 struct cmd_list_element *tmpcmd;
638 add_prefix_cmd ("maintenance", class_maintenance, maintenance_command,
639 "Commands for use by GDB maintainers.\n\
640 Includes commands to dump specific internal GDB structures in\n\
641 a human readable form, to cause GDB to deliberately dump core,\n\
642 to test internal functions such as the C++ demangler, etc.",
643 &maintenancelist, "maintenance ", 0,
646 add_com_alias ("mt", "maintenance", class_maintenance, 1);
648 add_prefix_cmd ("info", class_maintenance, maintenance_info_command,
649 "Commands for showing internal info about the program being debugged.",
650 &maintenanceinfolist, "maintenance info ", 0,
652 add_alias_cmd ("i", "info", class_maintenance, 1, &maintenancelist);
654 add_cmd ("sections", class_maintenance, maintenance_info_sections,
655 "List the BFD sections of the exec and core files. \n
656 Arguments may be any combination of:\n\
657 [one or more section names]\n\
658 ALLOC LOAD RELOC READONLY CODE DATA ROM CONSTRUCTOR\n\
659 HAS_CONTENTS NEVER_LOAD COFF_SHARED_LIBRARY IS_COMMON\n\
660 Sections matching any argument will be listed (no argument\n\
661 implies all sections). In addition, the special argument\n\
663 lists all sections from all object files, including shared libraries.",
664 &maintenanceinfolist);
666 add_prefix_cmd ("print", class_maintenance, maintenance_print_command,
667 "Maintenance command for printing GDB internal state.",
668 &maintenanceprintlist, "maintenance print ", 0,
671 add_prefix_cmd ("set", class_maintenance, maintenance_set_cmd, "\
672 Set GDB internal variables used by the GDB maintainer.\n\
673 Configure variables internal to GDB that aid in GDB's maintenance",
674 &maintenance_set_cmdlist, "maintenance set ",
678 add_prefix_cmd ("show", class_maintenance, maintenance_show_cmd, "\
679 Show GDB internal variables used by the GDB maintainer.\n\
680 Configure variables internal to GDB that aid in GDB's maintenance",
681 &maintenance_show_cmdlist, "maintenance show ",
686 add_cmd ("dump-me", class_maintenance, maintenance_dump_me,
687 "Get fatal error; make debugger dump its core.\n\
688 GDB sets it's handling of SIGQUIT back to SIG_DFL and then sends\n\
689 itself a SIGQUIT signal.",
693 add_cmd ("internal-error", class_maintenance, maintenance_internal_error,
694 "Give GDB an internal error.\n\
695 Cause GDB to behave as if an internal error was detected.",
698 add_cmd ("demangle", class_maintenance, maintenance_demangle,
699 "Demangle a C++ mangled name.\n\
700 Call internal GDB demangler routine to demangle a C++ link name\n\
701 and prints the result.",
704 add_cmd ("time", class_maintenance, maintenance_time_display,
705 "Set the display of time usage.\n\
706 If nonzero, will cause the execution time for each command to be\n\
707 displayed, following the command's output.",
710 add_cmd ("space", class_maintenance, maintenance_space_display,
711 "Set the display of space usage.\n\
712 If nonzero, will cause the execution space for each command to be\n\
713 displayed, following the command's output.",
716 add_cmd ("type", class_maintenance, maintenance_print_type,
717 "Print a type chain for a given symbol.\n\
718 For each node in a type chain, print the raw data for each member of\n\
719 the type structure, and the interpretation of the data.",
720 &maintenanceprintlist);
722 add_cmd ("symbols", class_maintenance, maintenance_print_symbols,
723 "Print dump of current symbol definitions.\n\
724 Entries in the full symbol table are dumped to file OUTFILE.\n\
725 If a SOURCE file is specified, dump only that file's symbols.",
726 &maintenanceprintlist);
728 add_cmd ("msymbols", class_maintenance, maintenance_print_msymbols,
729 "Print dump of current minimal symbol definitions.\n\
730 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
731 If a SOURCE file is specified, dump only that file's minimal symbols.",
732 &maintenanceprintlist);
734 add_cmd ("psymbols", class_maintenance, maintenance_print_psymbols,
735 "Print dump of current partial symbol definitions.\n\
736 Entries in the partial symbol table are dumped to file OUTFILE.\n\
737 If a SOURCE file is specified, dump only that file's partial symbols.",
738 &maintenanceprintlist);
740 add_cmd ("objfiles", class_maintenance, maintenance_print_objfiles,
741 "Print dump of current object file definitions.",
742 &maintenanceprintlist);
744 add_cmd ("statistics", class_maintenance, maintenance_print_statistics,
745 "Print statistics about internal gdb state.",
746 &maintenanceprintlist);
748 add_cmd ("architecture", class_maintenance, maintenance_print_architecture,
749 "Print the internal architecture configuration.\
750 Takes an optional file parameter.",
751 &maintenanceprintlist);
753 add_cmd ("check-symtabs", class_maintenance, maintenance_check_symtabs,
754 "Check consistency of psymtabs and symtabs.",
757 add_cmd ("translate-address", class_maintenance, maintenance_translate_address,
758 "Translate a section name and address to a symbol.",
761 add_cmd ("deprecate", class_maintenance, maintenance_deprecate,
762 "Deprecate a command. Note that this is just in here so the \n\
763 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
764 rather you should use the C function deprecate_cmd(). If you decide you \n\
765 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
766 replacement is optional.", &maintenancelist);
768 add_cmd ("undeprecate", class_maintenance, maintenance_undeprecate,
769 "Undeprecate a command. Note that this is just in here so the \n\
770 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
771 If you decide you want to use it: maintenance undeprecate 'commandname'",
775 add_set_cmd ("watchdog", class_maintenance, var_zinteger, (char *) &watchdog,
776 "Set watchdog timer.\n\
777 When non-zero, this timeout is used instead of waiting forever for a target to\n\
778 finish a low-level step or continue operation. If the specified amount of time\n\
779 passes without a response from the target, an error occurs.", &setlist),
784 /* FIXME: cagney/2001-09-24: A patch introducing a
785 add_set_boolean_cmd() is pending, the below should probably use
786 it. A patch implementing profiling is pending, this just sets up
788 tmpcmd = add_set_cmd ("profile", class_maintenance,
789 var_boolean, &maintenance_profile_p,
790 "Set internal profiling.\n\
791 When enabled GDB is profiled.",
792 &maintenance_set_cmdlist);
793 tmpcmd->function.sfunc = maintenance_set_profile_cmd;
794 add_show_from_set (tmpcmd, &maintenance_show_cmdlist);