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_table (bfd *abfd, asection *asect, void *arg)
267 flags = bfd_get_section_flags (abfd, asect);
269 if (string == NULL || *string == '\0' ||
270 strstr (string, bfd_get_section_name (abfd, asect)) ||
271 match_bfd_flags (string, flags))
273 /* FIXME-32x64: Need print_address_numeric with field width. */
274 printf_filtered (" %s",
275 local_hex_string_custom
276 ((unsigned long) bfd_section_vma (abfd, asect),
278 printf_filtered ("->%s",
279 local_hex_string_custom
280 ((unsigned long) (bfd_section_vma (abfd, asect)
281 + bfd_section_size (abfd, asect)),
283 printf_filtered (" at %s",
284 local_hex_string_custom
285 ((unsigned long) asect->filepos, "08l"));
286 printf_filtered (": %s", bfd_section_name (abfd, asect));
288 print_bfd_flags (flags);
290 printf_filtered ("\n");
296 maintenance_info_sections (char *arg, int from_tty)
300 printf_filtered ("Exec file:\n");
301 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd));
303 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd));
304 bfd_map_over_sections (exec_bfd, print_section_table, arg);
309 printf_filtered ("Core file:\n");
310 printf_filtered (" `%s', ", bfd_get_filename (core_bfd));
312 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd));
313 bfd_map_over_sections (core_bfd, print_section_table, arg);
319 maintenance_print_statistics (char *args, int from_tty)
321 print_objfile_statistics ();
322 print_symbol_bcache_statistics ();
326 maintenance_print_architecture (char *args, int from_tty)
329 gdbarch_dump (current_gdbarch, gdb_stdout);
332 struct ui_file *file = gdb_fopen (args, "w");
334 perror_with_name ("maintenance print architecture");
335 gdbarch_dump (current_gdbarch, file);
336 ui_file_delete (file);
340 /* The "maintenance print" command is defined as a prefix, with
341 allow_unknown 0. Therefore, its own definition is called only for
342 "maintenance print" with no args. */
346 maintenance_print_command (char *arg, int from_tty)
348 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
349 help_list (maintenanceprintlist, "maintenance print ", -1, gdb_stdout);
352 /* The "maintenance translate-address" command converts a section and address
353 to a symbol. This can be called in two ways:
354 maintenance translate-address <secname> <addr>
355 or maintenance translate-address <addr>
359 maintenance_translate_address (char *arg, int from_tty)
364 struct minimal_symbol *sym;
365 struct objfile *objfile;
367 if (arg == NULL || *arg == 0)
368 error ("requires argument (address or section + address)");
374 { /* See if we have a valid section name */
375 while (*p && !isspace (*p)) /* Find end of section name */
377 if (*p == '\000') /* End of command? */
378 error ("Need to specify <section-name> and <address>");
381 p++; /* Skip whitespace */
383 ALL_OBJFILES (objfile)
385 sect = bfd_get_section_by_name (objfile->obfd, arg);
391 error ("Unknown section %s.", arg);
394 address = parse_and_eval_address (p);
397 sym = lookup_minimal_symbol_by_pc_section (address, sect);
399 sym = lookup_minimal_symbol_by_pc (address);
402 printf_filtered ("%s+%s\n",
403 SYMBOL_SOURCE_NAME (sym),
404 paddr_u (address - SYMBOL_VALUE_ADDRESS (sym)));
406 printf_filtered ("no symbol at %s:0x%s\n", sect->name, paddr (address));
408 printf_filtered ("no symbol at 0x%s\n", paddr (address));
414 /* When a command is deprecated the user will be warned the first time
415 the command is used. If possible, a replacement will be
419 maintenance_deprecate (char *args, int from_tty)
421 if (args == NULL || *args == '\0')
423 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
424 the command you want to deprecate, and optionally the replacement command \n\
425 enclosed in quotes.\n");
428 maintenance_do_deprecate (args, 1);
434 maintenance_undeprecate (char *args, int from_tty)
436 if (args == NULL || *args == '\0')
438 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
439 the command you want to undeprecate.\n");
442 maintenance_do_deprecate (args, 0);
446 /* You really shouldn't be using this. It is just for the testsuite.
447 Rather, you should use deprecate_cmd() when the command is created
448 in _initialize_blah().
450 This function deprecates a command and optionally assigns it a
454 maintenance_do_deprecate (char *text, int deprecate)
457 struct cmd_list_element *alias = NULL;
458 struct cmd_list_element *prefix_cmd = NULL;
459 struct cmd_list_element *cmd = NULL;
461 char *start_ptr = NULL;
462 char *end_ptr = NULL;
464 char *replacement = NULL;
469 if (!lookup_cmd_composition (text, &alias, &prefix_cmd, &cmd))
471 printf_filtered ("Can't find command '%s' to deprecate.\n", text);
477 /* look for a replacement command */
478 start_ptr = strchr (text, '\"');
479 if (start_ptr != NULL)
482 end_ptr = strrchr (start_ptr, '\"');
485 len = end_ptr - start_ptr;
486 start_ptr[len] = '\0';
487 replacement = xstrdup (start_ptr);
492 if (!start_ptr || !end_ptr)
496 /* If they used an alias, we only want to deprecate the alias.
498 Note the MALLOCED_REPLACEMENT test. If the command's replacement
499 string was allocated at compile time we don't want to free the
504 if (alias->flags & MALLOCED_REPLACEMENT)
505 xfree (alias->replacement);
508 alias->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
510 alias->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
511 alias->replacement = replacement;
512 alias->flags |= MALLOCED_REPLACEMENT;
517 if (cmd->flags & MALLOCED_REPLACEMENT)
518 xfree (cmd->replacement);
521 cmd->flags |= (DEPRECATED_WARN_USER | CMD_DEPRECATED);
523 cmd->flags &= ~(DEPRECATED_WARN_USER | CMD_DEPRECATED);
524 cmd->replacement = replacement;
525 cmd->flags |= MALLOCED_REPLACEMENT;
530 /* Maintenance set/show framework. */
532 static struct cmd_list_element *maintenance_set_cmdlist;
533 static struct cmd_list_element *maintenance_show_cmdlist;
536 maintenance_set_cmd (char *args, int from_tty)
538 printf_unfiltered ("\"maintenance set\" must be followed by the name of a set command.\n");
539 help_list (maintenance_set_cmdlist, "maintenance set ", -1, gdb_stdout);
543 maintenance_show_cmd (char *args, int from_tty)
545 cmd_show_list (maintenance_show_cmdlist, from_tty, "");
549 /* Profiling support. */
551 static int maintenance_profile_p;
554 maintenance_set_profile_cmd (char *args, int from_tty, struct cmd_list_element *c)
556 maintenance_profile_p = 0;
557 warning ("\"maintenance set profile\" command not supported.\n");
562 _initialize_maint_cmds (void)
564 struct cmd_list_element *tmpcmd;
566 add_prefix_cmd ("maintenance", class_maintenance, maintenance_command,
567 "Commands for use by GDB maintainers.\n\
568 Includes commands to dump specific internal GDB structures in\n\
569 a human readable form, to cause GDB to deliberately dump core,\n\
570 to test internal functions such as the C++ demangler, etc.",
571 &maintenancelist, "maintenance ", 0,
574 add_com_alias ("mt", "maintenance", class_maintenance, 1);
576 add_prefix_cmd ("info", class_maintenance, maintenance_info_command,
577 "Commands for showing internal info about the program being debugged.",
578 &maintenanceinfolist, "maintenance info ", 0,
580 add_alias_cmd ("i", "info", class_maintenance, 1, &maintenancelist);
582 add_cmd ("sections", class_maintenance, maintenance_info_sections,
583 "List the BFD sections of the exec and core files.",
584 &maintenanceinfolist);
586 add_prefix_cmd ("print", class_maintenance, maintenance_print_command,
587 "Maintenance command for printing GDB internal state.",
588 &maintenanceprintlist, "maintenance print ", 0,
591 add_prefix_cmd ("set", class_maintenance, maintenance_set_cmd, "\
592 Set GDB internal variables used by the GDB maintainer.\n\
593 Configure variables internal to GDB that aid in GDB's maintenance",
594 &maintenance_set_cmdlist, "maintenance set ",
598 add_prefix_cmd ("show", class_maintenance, maintenance_show_cmd, "\
599 Show GDB internal variables used by the GDB maintainer.\n\
600 Configure variables internal to GDB that aid in GDB's maintenance",
601 &maintenance_show_cmdlist, "maintenance show ",
606 add_cmd ("dump-me", class_maintenance, maintenance_dump_me,
607 "Get fatal error; make debugger dump its core.\n\
608 GDB sets it's handling of SIGQUIT back to SIG_DFL and then sends\n\
609 itself a SIGQUIT signal.",
613 add_cmd ("internal-error", class_maintenance, maintenance_internal_error,
614 "Give GDB an internal error.\n\
615 Cause GDB to behave as if an internal error was detected.",
618 add_cmd ("demangle", class_maintenance, maintenance_demangle,
619 "Demangle a C++ mangled name.\n\
620 Call internal GDB demangler routine to demangle a C++ link name\n\
621 and prints the result.",
624 add_cmd ("time", class_maintenance, maintenance_time_display,
625 "Set the display of time usage.\n\
626 If nonzero, will cause the execution time for each command to be\n\
627 displayed, following the command's output.",
630 add_cmd ("space", class_maintenance, maintenance_space_display,
631 "Set the display of space usage.\n\
632 If nonzero, will cause the execution space for each command to be\n\
633 displayed, following the command's output.",
636 add_cmd ("type", class_maintenance, maintenance_print_type,
637 "Print a type chain for a given symbol.\n\
638 For each node in a type chain, print the raw data for each member of\n\
639 the type structure, and the interpretation of the data.",
640 &maintenanceprintlist);
642 add_cmd ("symbols", class_maintenance, maintenance_print_symbols,
643 "Print dump of current symbol definitions.\n\
644 Entries in the full symbol table are dumped to file OUTFILE.\n\
645 If a SOURCE file is specified, dump only that file's symbols.",
646 &maintenanceprintlist);
648 add_cmd ("msymbols", class_maintenance, maintenance_print_msymbols,
649 "Print dump of current minimal symbol definitions.\n\
650 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
651 If a SOURCE file is specified, dump only that file's minimal symbols.",
652 &maintenanceprintlist);
654 add_cmd ("psymbols", class_maintenance, maintenance_print_psymbols,
655 "Print dump of current partial symbol definitions.\n\
656 Entries in the partial symbol table are dumped to file OUTFILE.\n\
657 If a SOURCE file is specified, dump only that file's partial symbols.",
658 &maintenanceprintlist);
660 add_cmd ("objfiles", class_maintenance, maintenance_print_objfiles,
661 "Print dump of current object file definitions.",
662 &maintenanceprintlist);
664 add_cmd ("statistics", class_maintenance, maintenance_print_statistics,
665 "Print statistics about internal gdb state.",
666 &maintenanceprintlist);
668 add_cmd ("architecture", class_maintenance, maintenance_print_architecture,
669 "Print the internal architecture configuration.\
670 Takes an optional file parameter.",
671 &maintenanceprintlist);
673 add_cmd ("check-symtabs", class_maintenance, maintenance_check_symtabs,
674 "Check consistency of psymtabs and symtabs.",
677 add_cmd ("translate-address", class_maintenance, maintenance_translate_address,
678 "Translate a section name and address to a symbol.",
681 add_cmd ("deprecate", class_maintenance, maintenance_deprecate,
682 "Deprecate a command. Note that this is just in here so the \n\
683 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
684 rather you should use the C function deprecate_cmd(). If you decide you \n\
685 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
686 replacement is optional.", &maintenancelist);
688 add_cmd ("undeprecate", class_maintenance, maintenance_undeprecate,
689 "Undeprecate a command. Note that this is just in here so the \n\
690 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
691 If you decide you want to use it: maintenance undeprecate 'commandname'",
695 add_set_cmd ("watchdog", class_maintenance, var_zinteger, (char *) &watchdog,
696 "Set watchdog timer.\n\
697 When non-zero, this timeout is used instead of waiting forever for a target to\n\
698 finish a low-level step or continue operation. If the specified amount of time\n\
699 passes without a response from the target, an error occurs.", &setlist),
704 /* FIXME: cagney/2001-09-24: A patch introducing a
705 add_set_boolean_cmd() is pending, the below should probably use
706 it. A patch implementing profiling is pending, this just sets up
708 tmpcmd = add_set_cmd ("profile", class_maintenance,
709 var_boolean, &maintenance_profile_p,
710 "Set internal profiling.\n\
711 When enabled GDB is profiled.",
712 &maintenance_set_cmdlist);
713 tmpcmd->function.sfunc = maintenance_set_profile_cmd;
714 add_show_from_set (tmpcmd, &maintenance_show_cmdlist);