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);
190 match_bfd_flags (char *string, flagword flags)
192 if (flags & SEC_ALLOC)
193 if (strstr (string, "ALLOC"))
195 if (flags & SEC_LOAD)
196 if (strstr (string, "LOAD"))
198 if (flags & SEC_RELOC)
199 if (strstr (string, "RELOC"))
201 if (flags & SEC_READONLY)
202 if (strstr (string, "READONLY"))
204 if (flags & SEC_CODE)
205 if (strstr (string, "CODE"))
207 if (flags & SEC_DATA)
208 if (strstr (string, "DATA"))
211 if (strstr (string, "ROM"))
213 if (flags & SEC_CONSTRUCTOR)
214 if (strstr (string, "CONSTRUCTOR"))
216 if (flags & SEC_HAS_CONTENTS)
217 if (strstr (string, "HAS_CONTENTS"))
219 if (flags & SEC_NEVER_LOAD)
220 if (strstr (string, "NEVER_LOAD"))
222 if (flags & SEC_COFF_SHARED_LIBRARY)
223 if (strstr (string, "COFF_SHARED_LIBRARY"))
225 if (flags & SEC_IS_COMMON)
226 if (strstr (string, "IS_COMMON"))
233 print_bfd_flags (flagword flags)
235 if (flags & SEC_ALLOC)
236 printf_filtered (" ALLOC");
237 if (flags & SEC_LOAD)
238 printf_filtered (" LOAD");
239 if (flags & SEC_RELOC)
240 printf_filtered (" RELOC");
241 if (flags & SEC_READONLY)
242 printf_filtered (" READONLY");
243 if (flags & SEC_CODE)
244 printf_filtered (" CODE");
245 if (flags & SEC_DATA)
246 printf_filtered (" DATA");
248 printf_filtered (" ROM");
249 if (flags & SEC_CONSTRUCTOR)
250 printf_filtered (" CONSTRUCTOR");
251 if (flags & SEC_HAS_CONTENTS)
252 printf_filtered (" HAS_CONTENTS");
253 if (flags & SEC_NEVER_LOAD)
254 printf_filtered (" NEVER_LOAD");
255 if (flags & SEC_COFF_SHARED_LIBRARY)
256 printf_filtered (" COFF_SHARED_LIBRARY");
257 if (flags & SEC_IS_COMMON)
258 printf_filtered (" IS_COMMON");
262 print_section_info (const char *name, flagword flags,
263 CORE_ADDR addr, CORE_ADDR endaddr,
264 unsigned long filepos)
266 /* FIXME-32x64: Need print_address_numeric with field width. */
267 printf_filtered (" 0x%s", paddr (addr));
268 printf_filtered ("->0x%s", paddr (endaddr));
269 printf_filtered (" at 0x%s",
270 local_hex_string_custom ((unsigned long) filepos, "08l"));
271 printf_filtered (": %s", name);
272 print_bfd_flags (flags);
273 printf_filtered ("\n");
277 print_bfd_section_info (bfd *abfd,
281 flagword flags = bfd_get_section_flags (abfd, asect);
282 const char *name = bfd_section_name (abfd, asect);
284 if (arg == NULL || *((char *) arg) == '\0' ||
285 strstr ((char *) arg, name) ||
286 match_bfd_flags ((char *) arg, flags))
288 CORE_ADDR addr, endaddr;
290 addr = bfd_section_vma (abfd, asect);
291 endaddr = addr + bfd_section_size (abfd, asect);
292 print_section_info (name, flags, addr, endaddr, asect->filepos);
297 print_objfile_section_info (bfd *abfd,
298 struct obj_section *asect,
301 flagword flags = bfd_get_section_flags (abfd, asect->the_bfd_section);
302 const char *name = bfd_section_name (abfd, asect->the_bfd_section);
304 if (string == NULL || *string == '\0' ||
305 strstr (string, name) ||
306 match_bfd_flags (string, flags))
308 print_section_info (name, flags, asect->addr, asect->endaddr,
309 asect->the_bfd_section->filepos);
315 maintenance_info_sections (char *arg, int from_tty)
319 printf_filtered ("Exec file:\n");
320 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd));
322 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd));
323 if (arg && *arg && strstr (arg, "ALLOBJ"))
325 struct objfile *ofile;
326 struct obj_section *osect;
328 /* Only this function cares about the 'ALLOBJ' argument;
329 if 'ALLOBJ' is the only argument, discard it rather than
330 passing it down to print_objfile_section_info (which
331 wouldn't know how to handle it). */
332 if (strcmp (arg, "ALLOBJ") == 0)
337 printf_filtered (" Object file: %s\n",
338 bfd_get_filename (ofile->obfd));
339 ALL_OBJFILE_OSECTIONS (ofile, osect)
341 print_objfile_section_info (ofile->obfd, osect, arg);
346 bfd_map_over_sections (exec_bfd, print_bfd_section_info, arg);
351 printf_filtered ("Core file:\n");
352 printf_filtered (" `%s', ", bfd_get_filename (core_bfd));
354 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd));
355 bfd_map_over_sections (core_bfd, print_bfd_section_info, arg);
361 maintenance_print_statistics (char *args, int from_tty)
363 print_objfile_statistics ();
364 print_symbol_bcache_statistics ();
368 maintenance_print_architecture (char *args, int from_tty)
371 gdbarch_dump (current_gdbarch, gdb_stdout);
374 struct ui_file *file = gdb_fopen (args, "w");
376 perror_with_name ("maintenance print architecture");
377 gdbarch_dump (current_gdbarch, file);
378 ui_file_delete (file);
382 /* The "maintenance print" command is defined as a prefix, with
383 allow_unknown 0. Therefore, its own definition is called only for
384 "maintenance print" with no args. */
388 maintenance_print_command (char *arg, int from_tty)
390 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
391 help_list (maintenanceprintlist, "maintenance print ", -1, gdb_stdout);
394 /* The "maintenance translate-address" command converts a section and address
395 to a symbol. This can be called in two ways:
396 maintenance translate-address <secname> <addr>
397 or maintenance translate-address <addr>
401 maintenance_translate_address (char *arg, int from_tty)
406 struct minimal_symbol *sym;
407 struct objfile *objfile;
409 if (arg == NULL || *arg == 0)
410 error ("requires argument (address or section + address)");
416 { /* See if we have a valid section name */
417 while (*p && !isspace (*p)) /* Find end of section name */
419 if (*p == '\000') /* End of command? */
420 error ("Need to specify <section-name> and <address>");
423 p++; /* Skip whitespace */
425 ALL_OBJFILES (objfile)
427 sect = bfd_get_section_by_name (objfile->obfd, arg);
433 error ("Unknown section %s.", arg);
436 address = parse_and_eval_address (p);
439 sym = lookup_minimal_symbol_by_pc_section (address, sect);
441 sym = lookup_minimal_symbol_by_pc (address);
444 printf_filtered ("%s+%s\n",
445 SYMBOL_SOURCE_NAME (sym),
446 paddr_u (address - SYMBOL_VALUE_ADDRESS (sym)));
448 printf_filtered ("no symbol at %s:0x%s\n", sect->name, paddr (address));
450 printf_filtered ("no symbol at 0x%s\n", paddr (address));
456 /* When a command is deprecated the user will be warned the first time
457 the command is used. If possible, a replacement will be
461 maintenance_deprecate (char *args, int from_tty)
463 if (args == NULL || *args == '\0')
465 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
466 the command you want to deprecate, and optionally the replacement command \n\
467 enclosed in quotes.\n");
470 maintenance_do_deprecate (args, 1);
476 maintenance_undeprecate (char *args, int from_tty)
478 if (args == NULL || *args == '\0')
480 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
481 the command you want to undeprecate.\n");
484 maintenance_do_deprecate (args, 0);
488 /* You really shouldn't be using this. It is just for the testsuite.
489 Rather, you should use deprecate_cmd() when the command is created
490 in _initialize_blah().
492 This function deprecates a command and optionally assigns it a
496 maintenance_do_deprecate (char *text, int deprecate)
499 struct cmd_list_element *alias = NULL;
500 struct cmd_list_element *prefix_cmd = NULL;
501 struct cmd_list_element *cmd = NULL;
503 char *start_ptr = NULL;
504 char *end_ptr = NULL;
506 char *replacement = NULL;
511 if (!lookup_cmd_composition (text, &alias, &prefix_cmd, &cmd))
513 printf_filtered ("Can't find command '%s' to deprecate.\n", text);
519 /* look for a replacement command */
520 start_ptr = strchr (text, '\"');
521 if (start_ptr != NULL)
524 end_ptr = strrchr (start_ptr, '\"');
527 len = end_ptr - start_ptr;
528 start_ptr[len] = '\0';
529 replacement = xstrdup (start_ptr);
534 if (!start_ptr || !end_ptr)
538 /* If they used an alias, we only want to deprecate the alias.
540 Note the MALLOCED_REPLACEMENT test. If the command's replacement
541 string was allocated at compile time we don't want to free the
546 if (alias->flags & MALLOCED_REPLACEMENT)
547 xfree (alias->replacement);
550 alias->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
552 alias->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
553 alias->replacement = replacement;
554 alias->flags |= MALLOCED_REPLACEMENT;
559 if (cmd->flags & MALLOCED_REPLACEMENT)
560 xfree (cmd->replacement);
563 cmd->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
565 cmd->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
566 cmd->replacement = replacement;
567 cmd->flags |= MALLOCED_REPLACEMENT;
572 /* Maintenance set/show framework. */
574 static struct cmd_list_element *maintenance_set_cmdlist;
575 static struct cmd_list_element *maintenance_show_cmdlist;
578 maintenance_set_cmd (char *args, int from_tty)
580 printf_unfiltered ("\"maintenance set\" must be followed by the name of a set command.\n");
581 help_list (maintenance_set_cmdlist, "maintenance set ", -1, gdb_stdout);
585 maintenance_show_cmd (char *args, int from_tty)
587 cmd_show_list (maintenance_show_cmdlist, from_tty, "");
591 /* Profiling support. */
593 static int maintenance_profile_p;
596 maintenance_set_profile_cmd (char *args, int from_tty, struct cmd_list_element *c)
598 maintenance_profile_p = 0;
599 warning ("\"maintenance set profile\" command not supported.\n");
604 _initialize_maint_cmds (void)
606 struct cmd_list_element *tmpcmd;
608 add_prefix_cmd ("maintenance", class_maintenance, maintenance_command,
609 "Commands for use by GDB maintainers.\n\
610 Includes commands to dump specific internal GDB structures in\n\
611 a human readable form, to cause GDB to deliberately dump core,\n\
612 to test internal functions such as the C++ demangler, etc.",
613 &maintenancelist, "maintenance ", 0,
616 add_com_alias ("mt", "maintenance", class_maintenance, 1);
618 add_prefix_cmd ("info", class_maintenance, maintenance_info_command,
619 "Commands for showing internal info about the program being debugged.",
620 &maintenanceinfolist, "maintenance info ", 0,
622 add_alias_cmd ("i", "info", class_maintenance, 1, &maintenancelist);
624 add_cmd ("sections", class_maintenance, maintenance_info_sections,
625 "List the BFD sections of the exec and core files. \n
626 Arguments may be any combination of:\n\
627 [one or more section names]\n\
628 ALLOC LOAD RELOC READONLY CODE DATA ROM CONSTRUCTOR\n\
629 HAS_CONTENTS NEVER_LOAD COFF_SHARED_LIBRARY IS_COMMON\n\
630 Sections matching any argument will be listed (no argument\n\
631 implies all sections). In addition, the special argument\n\
633 lists all sections from all object files, including shared libraries.",
634 &maintenanceinfolist);
636 add_prefix_cmd ("print", class_maintenance, maintenance_print_command,
637 "Maintenance command for printing GDB internal state.",
638 &maintenanceprintlist, "maintenance print ", 0,
641 add_prefix_cmd ("set", class_maintenance, maintenance_set_cmd, "\
642 Set GDB internal variables used by the GDB maintainer.\n\
643 Configure variables internal to GDB that aid in GDB's maintenance",
644 &maintenance_set_cmdlist, "maintenance set ",
648 add_prefix_cmd ("show", class_maintenance, maintenance_show_cmd, "\
649 Show GDB internal variables used by the GDB maintainer.\n\
650 Configure variables internal to GDB that aid in GDB's maintenance",
651 &maintenance_show_cmdlist, "maintenance show ",
656 add_cmd ("dump-me", class_maintenance, maintenance_dump_me,
657 "Get fatal error; make debugger dump its core.\n\
658 GDB sets it's handling of SIGQUIT back to SIG_DFL and then sends\n\
659 itself a SIGQUIT signal.",
663 add_cmd ("internal-error", class_maintenance, maintenance_internal_error,
664 "Give GDB an internal error.\n\
665 Cause GDB to behave as if an internal error was detected.",
668 add_cmd ("demangle", class_maintenance, maintenance_demangle,
669 "Demangle a C++ mangled name.\n\
670 Call internal GDB demangler routine to demangle a C++ link name\n\
671 and prints the result.",
674 add_cmd ("time", class_maintenance, maintenance_time_display,
675 "Set the display of time usage.\n\
676 If nonzero, will cause the execution time for each command to be\n\
677 displayed, following the command's output.",
680 add_cmd ("space", class_maintenance, maintenance_space_display,
681 "Set the display of space usage.\n\
682 If nonzero, will cause the execution space for each command to be\n\
683 displayed, following the command's output.",
686 add_cmd ("type", class_maintenance, maintenance_print_type,
687 "Print a type chain for a given symbol.\n\
688 For each node in a type chain, print the raw data for each member of\n\
689 the type structure, and the interpretation of the data.",
690 &maintenanceprintlist);
692 add_cmd ("symbols", class_maintenance, maintenance_print_symbols,
693 "Print dump of current symbol definitions.\n\
694 Entries in the full symbol table are dumped to file OUTFILE.\n\
695 If a SOURCE file is specified, dump only that file's symbols.",
696 &maintenanceprintlist);
698 add_cmd ("msymbols", class_maintenance, maintenance_print_msymbols,
699 "Print dump of current minimal symbol definitions.\n\
700 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
701 If a SOURCE file is specified, dump only that file's minimal symbols.",
702 &maintenanceprintlist);
704 add_cmd ("psymbols", class_maintenance, maintenance_print_psymbols,
705 "Print dump of current partial symbol definitions.\n\
706 Entries in the partial symbol table are dumped to file OUTFILE.\n\
707 If a SOURCE file is specified, dump only that file's partial symbols.",
708 &maintenanceprintlist);
710 add_cmd ("objfiles", class_maintenance, maintenance_print_objfiles,
711 "Print dump of current object file definitions.",
712 &maintenanceprintlist);
714 add_cmd ("statistics", class_maintenance, maintenance_print_statistics,
715 "Print statistics about internal gdb state.",
716 &maintenanceprintlist);
718 add_cmd ("architecture", class_maintenance, maintenance_print_architecture,
719 "Print the internal architecture configuration.\
720 Takes an optional file parameter.",
721 &maintenanceprintlist);
723 add_cmd ("check-symtabs", class_maintenance, maintenance_check_symtabs,
724 "Check consistency of psymtabs and symtabs.",
727 add_cmd ("translate-address", class_maintenance, maintenance_translate_address,
728 "Translate a section name and address to a symbol.",
731 add_cmd ("deprecate", class_maintenance, maintenance_deprecate,
732 "Deprecate a command. Note that this is just in here so the \n\
733 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
734 rather you should use the C function deprecate_cmd(). If you decide you \n\
735 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
736 replacement is optional.", &maintenancelist);
738 add_cmd ("undeprecate", class_maintenance, maintenance_undeprecate,
739 "Undeprecate a command. Note that this is just in here so the \n\
740 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
741 If you decide you want to use it: maintenance undeprecate 'commandname'",
745 add_set_cmd ("watchdog", class_maintenance, var_zinteger, (char *) &watchdog,
746 "Set watchdog timer.\n\
747 When non-zero, this timeout is used instead of waiting forever for a target to\n\
748 finish a low-level step or continue operation. If the specified amount of time\n\
749 passes without a response from the target, an error occurs.", &setlist),
754 /* FIXME: cagney/2001-09-24: A patch introducing a
755 add_set_boolean_cmd() is pending, the below should probably use
756 it. A patch implementing profiling is pending, this just sets up
758 tmpcmd = add_set_cmd ("profile", class_maintenance,
759 var_boolean, &maintenance_profile_p,
760 "Set internal profiling.\n\
761 When enabled GDB is profiled.",
762 &maintenance_set_cmdlist);
763 tmpcmd->function.sfunc = maintenance_set_profile_cmd;
764 add_show_from_set (tmpcmd, &maintenance_show_cmdlist);