1 /* Support for GDB maintenance commands.
2 Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001, 2002
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
= cplus_demangle (args
, 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. */
195 maintenance_info_command (char *arg
, int from_tty
)
197 printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
198 help_list (maintenanceinfolist
, "maintenance info ", -1, gdb_stdout
);
201 /* Mini tokenizing lexer for 'maint info sections' command. */
204 match_substring (const char *string
, const char *substr
)
206 int substr_len
= strlen(substr
);
209 while ((tok
= strstr (string
, substr
)) != NULL
)
211 /* Got a partial match. Is it a whole word? */
216 /* Token is delimited at the front... */
217 if (tok
[substr_len
] == ' '
218 || tok
[substr_len
] == '\t'
219 || tok
[substr_len
] == '\0')
221 /* Token is delimited at the rear. Got a whole-word match. */
225 /* Token didn't match as a whole word. Advance and try again. */
232 match_bfd_flags (char *string
, flagword flags
)
234 if (flags
& SEC_ALLOC
)
235 if (match_substring (string
, "ALLOC"))
237 if (flags
& SEC_LOAD
)
238 if (match_substring (string
, "LOAD"))
240 if (flags
& SEC_RELOC
)
241 if (match_substring (string
, "RELOC"))
243 if (flags
& SEC_READONLY
)
244 if (match_substring (string
, "READONLY"))
246 if (flags
& SEC_CODE
)
247 if (match_substring (string
, "CODE"))
249 if (flags
& SEC_DATA
)
250 if (match_substring (string
, "DATA"))
253 if (match_substring (string
, "ROM"))
255 if (flags
& SEC_CONSTRUCTOR
)
256 if (match_substring (string
, "CONSTRUCTOR"))
258 if (flags
& SEC_HAS_CONTENTS
)
259 if (match_substring (string
, "HAS_CONTENTS"))
261 if (flags
& SEC_NEVER_LOAD
)
262 if (match_substring (string
, "NEVER_LOAD"))
264 if (flags
& SEC_COFF_SHARED_LIBRARY
)
265 if (match_substring (string
, "COFF_SHARED_LIBRARY"))
267 if (flags
& SEC_IS_COMMON
)
268 if (match_substring (string
, "IS_COMMON"))
275 print_bfd_flags (flagword flags
)
277 if (flags
& SEC_ALLOC
)
278 printf_filtered (" ALLOC");
279 if (flags
& SEC_LOAD
)
280 printf_filtered (" LOAD");
281 if (flags
& SEC_RELOC
)
282 printf_filtered (" RELOC");
283 if (flags
& SEC_READONLY
)
284 printf_filtered (" READONLY");
285 if (flags
& SEC_CODE
)
286 printf_filtered (" CODE");
287 if (flags
& SEC_DATA
)
288 printf_filtered (" DATA");
290 printf_filtered (" ROM");
291 if (flags
& SEC_CONSTRUCTOR
)
292 printf_filtered (" CONSTRUCTOR");
293 if (flags
& SEC_HAS_CONTENTS
)
294 printf_filtered (" HAS_CONTENTS");
295 if (flags
& SEC_NEVER_LOAD
)
296 printf_filtered (" NEVER_LOAD");
297 if (flags
& SEC_COFF_SHARED_LIBRARY
)
298 printf_filtered (" COFF_SHARED_LIBRARY");
299 if (flags
& SEC_IS_COMMON
)
300 printf_filtered (" IS_COMMON");
304 maint_print_section_info (const char *name
, flagword flags
,
305 CORE_ADDR addr
, CORE_ADDR endaddr
,
306 unsigned long filepos
)
308 /* FIXME-32x64: Need print_address_numeric with field width. */
309 printf_filtered (" 0x%s", paddr (addr
));
310 printf_filtered ("->0x%s", paddr (endaddr
));
311 printf_filtered (" at %s",
312 local_hex_string_custom ((unsigned long) filepos
, "08l"));
313 printf_filtered (": %s", name
);
314 print_bfd_flags (flags
);
315 printf_filtered ("\n");
319 print_bfd_section_info (bfd
*abfd
,
323 flagword flags
= bfd_get_section_flags (abfd
, asect
);
324 const char *name
= bfd_section_name (abfd
, asect
);
326 if (arg
== NULL
|| *((char *) arg
) == '\0'
327 || match_substring ((char *) arg
, name
)
328 || match_bfd_flags ((char *) arg
, flags
))
330 CORE_ADDR addr
, endaddr
;
332 addr
= bfd_section_vma (abfd
, asect
);
333 endaddr
= addr
+ bfd_section_size (abfd
, asect
);
334 maint_print_section_info (name
, flags
, addr
, endaddr
, asect
->filepos
);
339 print_objfile_section_info (bfd
*abfd
,
340 struct obj_section
*asect
,
343 flagword flags
= bfd_get_section_flags (abfd
, asect
->the_bfd_section
);
344 const char *name
= bfd_section_name (abfd
, asect
->the_bfd_section
);
346 if (string
== NULL
|| *string
== '\0'
347 || match_substring (string
, name
)
348 || match_bfd_flags (string
, flags
))
350 maint_print_section_info (name
, flags
, asect
->addr
, asect
->endaddr
,
351 asect
->the_bfd_section
->filepos
);
357 maintenance_info_sections (char *arg
, int from_tty
)
361 printf_filtered ("Exec file:\n");
362 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd
));
364 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd
));
365 if (arg
&& *arg
&& match_substring (arg
, "ALLOBJ"))
367 struct objfile
*ofile
;
368 struct obj_section
*osect
;
370 /* Only this function cares about the 'ALLOBJ' argument;
371 if 'ALLOBJ' is the only argument, discard it rather than
372 passing it down to print_objfile_section_info (which
373 wouldn't know how to handle it). */
374 if (strcmp (arg
, "ALLOBJ") == 0)
379 printf_filtered (" Object file: %s\n",
380 bfd_get_filename (ofile
->obfd
));
381 ALL_OBJFILE_OSECTIONS (ofile
, osect
)
383 print_objfile_section_info (ofile
->obfd
, osect
, arg
);
388 bfd_map_over_sections (exec_bfd
, print_bfd_section_info
, arg
);
393 printf_filtered ("Core file:\n");
394 printf_filtered (" `%s', ", bfd_get_filename (core_bfd
));
396 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd
));
397 bfd_map_over_sections (core_bfd
, print_bfd_section_info
, arg
);
403 maintenance_print_statistics (char *args
, int from_tty
)
405 print_objfile_statistics ();
406 print_symbol_bcache_statistics ();
410 maintenance_print_architecture (char *args
, int from_tty
)
413 gdbarch_dump (current_gdbarch
, gdb_stdout
);
416 struct ui_file
*file
= gdb_fopen (args
, "w");
418 perror_with_name ("maintenance print architecture");
419 gdbarch_dump (current_gdbarch
, file
);
420 ui_file_delete (file
);
424 /* The "maintenance print" command is defined as a prefix, with
425 allow_unknown 0. Therefore, its own definition is called only for
426 "maintenance print" with no args. */
430 maintenance_print_command (char *arg
, int from_tty
)
432 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
433 help_list (maintenanceprintlist
, "maintenance print ", -1, gdb_stdout
);
436 /* The "maintenance translate-address" command converts a section and address
437 to a symbol. This can be called in two ways:
438 maintenance translate-address <secname> <addr>
439 or maintenance translate-address <addr>
443 maintenance_translate_address (char *arg
, int from_tty
)
448 struct minimal_symbol
*sym
;
449 struct objfile
*objfile
;
451 if (arg
== NULL
|| *arg
== 0)
452 error ("requires argument (address or section + address)");
458 { /* See if we have a valid section name */
459 while (*p
&& !isspace (*p
)) /* Find end of section name */
461 if (*p
== '\000') /* End of command? */
462 error ("Need to specify <section-name> and <address>");
465 p
++; /* Skip whitespace */
467 ALL_OBJFILES (objfile
)
469 sect
= bfd_get_section_by_name (objfile
->obfd
, arg
);
475 error ("Unknown section %s.", arg
);
478 address
= parse_and_eval_address (p
);
481 sym
= lookup_minimal_symbol_by_pc_section (address
, sect
);
483 sym
= lookup_minimal_symbol_by_pc (address
);
486 printf_filtered ("%s+%s\n",
487 SYMBOL_SOURCE_NAME (sym
),
488 paddr_u (address
- SYMBOL_VALUE_ADDRESS (sym
)));
490 printf_filtered ("no symbol at %s:0x%s\n", sect
->name
, paddr (address
));
492 printf_filtered ("no symbol at 0x%s\n", paddr (address
));
498 /* When a command is deprecated the user will be warned the first time
499 the command is used. If possible, a replacement will be
503 maintenance_deprecate (char *args
, int from_tty
)
505 if (args
== NULL
|| *args
== '\0')
507 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
508 the command you want to deprecate, and optionally the replacement command \n\
509 enclosed in quotes.\n");
512 maintenance_do_deprecate (args
, 1);
518 maintenance_undeprecate (char *args
, int from_tty
)
520 if (args
== NULL
|| *args
== '\0')
522 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
523 the command you want to undeprecate.\n");
526 maintenance_do_deprecate (args
, 0);
530 /* You really shouldn't be using this. It is just for the testsuite.
531 Rather, you should use deprecate_cmd() when the command is created
532 in _initialize_blah().
534 This function deprecates a command and optionally assigns it a
538 maintenance_do_deprecate (char *text
, int deprecate
)
541 struct cmd_list_element
*alias
= NULL
;
542 struct cmd_list_element
*prefix_cmd
= NULL
;
543 struct cmd_list_element
*cmd
= NULL
;
545 char *start_ptr
= NULL
;
546 char *end_ptr
= NULL
;
548 char *replacement
= NULL
;
553 if (!lookup_cmd_composition (text
, &alias
, &prefix_cmd
, &cmd
))
555 printf_filtered ("Can't find command '%s' to deprecate.\n", text
);
561 /* look for a replacement command */
562 start_ptr
= strchr (text
, '\"');
563 if (start_ptr
!= NULL
)
566 end_ptr
= strrchr (start_ptr
, '\"');
569 len
= end_ptr
- start_ptr
;
570 start_ptr
[len
] = '\0';
571 replacement
= xstrdup (start_ptr
);
576 if (!start_ptr
|| !end_ptr
)
580 /* If they used an alias, we only want to deprecate the alias.
582 Note the MALLOCED_REPLACEMENT test. If the command's replacement
583 string was allocated at compile time we don't want to free the
588 if (alias
->flags
& MALLOCED_REPLACEMENT
)
589 xfree (alias
->replacement
);
592 alias
->flags
|= (DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
594 alias
->flags
&= ~(DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
595 alias
->replacement
= replacement
;
596 alias
->flags
|= MALLOCED_REPLACEMENT
;
601 if (cmd
->flags
& MALLOCED_REPLACEMENT
)
602 xfree (cmd
->replacement
);
605 cmd
->flags
|= (DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
607 cmd
->flags
&= ~(DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
608 cmd
->replacement
= replacement
;
609 cmd
->flags
|= MALLOCED_REPLACEMENT
;
614 /* Maintenance set/show framework. */
616 static struct cmd_list_element
*maintenance_set_cmdlist
;
617 static struct cmd_list_element
*maintenance_show_cmdlist
;
620 maintenance_set_cmd (char *args
, int from_tty
)
622 printf_unfiltered ("\"maintenance set\" must be followed by the name of a set command.\n");
623 help_list (maintenance_set_cmdlist
, "maintenance set ", -1, gdb_stdout
);
627 maintenance_show_cmd (char *args
, int from_tty
)
629 cmd_show_list (maintenance_show_cmdlist
, from_tty
, "");
633 /* Profiling support. */
635 static int maintenance_profile_p
;
638 maintenance_set_profile_cmd (char *args
, int from_tty
, struct cmd_list_element
*c
)
640 maintenance_profile_p
= 0;
641 warning ("\"maintenance set profile\" command not supported.\n");
646 _initialize_maint_cmds (void)
648 struct cmd_list_element
*tmpcmd
;
650 add_prefix_cmd ("maintenance", class_maintenance
, maintenance_command
,
651 "Commands for use by GDB maintainers.\n\
652 Includes commands to dump specific internal GDB structures in\n\
653 a human readable form, to cause GDB to deliberately dump core,\n\
654 to test internal functions such as the C++ demangler, etc.",
655 &maintenancelist
, "maintenance ", 0,
658 add_com_alias ("mt", "maintenance", class_maintenance
, 1);
660 add_prefix_cmd ("info", class_maintenance
, maintenance_info_command
,
661 "Commands for showing internal info about the program being debugged.",
662 &maintenanceinfolist
, "maintenance info ", 0,
664 add_alias_cmd ("i", "info", class_maintenance
, 1, &maintenancelist
);
666 add_cmd ("sections", class_maintenance
, maintenance_info_sections
,
667 "List the BFD sections of the exec and core files. \n\
668 Arguments may be any combination of:\n\
669 [one or more section names]\n\
670 ALLOC LOAD RELOC READONLY CODE DATA ROM CONSTRUCTOR\n\
671 HAS_CONTENTS NEVER_LOAD COFF_SHARED_LIBRARY IS_COMMON\n\
672 Sections matching any argument will be listed (no argument\n\
673 implies all sections). In addition, the special argument\n\
675 lists all sections from all object files, including shared libraries.",
676 &maintenanceinfolist
);
678 add_prefix_cmd ("print", class_maintenance
, maintenance_print_command
,
679 "Maintenance command for printing GDB internal state.",
680 &maintenanceprintlist
, "maintenance print ", 0,
683 add_prefix_cmd ("set", class_maintenance
, maintenance_set_cmd
, "\
684 Set GDB internal variables used by the GDB maintainer.\n\
685 Configure variables internal to GDB that aid in GDB's maintenance",
686 &maintenance_set_cmdlist
, "maintenance set ",
690 add_prefix_cmd ("show", class_maintenance
, maintenance_show_cmd
, "\
691 Show GDB internal variables used by the GDB maintainer.\n\
692 Configure variables internal to GDB that aid in GDB's maintenance",
693 &maintenance_show_cmdlist
, "maintenance show ",
698 add_cmd ("dump-me", class_maintenance
, maintenance_dump_me
,
699 "Get fatal error; make debugger dump its core.\n\
700 GDB sets it's handling of SIGQUIT back to SIG_DFL and then sends\n\
701 itself a SIGQUIT signal.",
705 add_cmd ("internal-error", class_maintenance
, maintenance_internal_error
,
706 "Give GDB an internal error.\n\
707 Cause GDB to behave as if an internal error was detected.",
710 add_cmd ("internal-warning", class_maintenance
, maintenance_internal_warning
,
711 "Give GDB an internal warning.\n\
712 Cause GDB to behave as if an internal warning was reported.",
715 add_cmd ("demangle", class_maintenance
, maintenance_demangle
,
716 "Demangle a C++ mangled name.\n\
717 Call internal GDB demangler routine to demangle a C++ link name\n\
718 and prints the result.",
721 add_cmd ("time", class_maintenance
, maintenance_time_display
,
722 "Set the display of time usage.\n\
723 If nonzero, will cause the execution time for each command to be\n\
724 displayed, following the command's output.",
727 add_cmd ("space", class_maintenance
, maintenance_space_display
,
728 "Set the display of space usage.\n\
729 If nonzero, will cause the execution space for each command to be\n\
730 displayed, following the command's output.",
733 add_cmd ("type", class_maintenance
, maintenance_print_type
,
734 "Print a type chain for a given symbol.\n\
735 For each node in a type chain, print the raw data for each member of\n\
736 the type structure, and the interpretation of the data.",
737 &maintenanceprintlist
);
739 add_cmd ("symbols", class_maintenance
, maintenance_print_symbols
,
740 "Print dump of current symbol definitions.\n\
741 Entries in the full symbol table are dumped to file OUTFILE.\n\
742 If a SOURCE file is specified, dump only that file's symbols.",
743 &maintenanceprintlist
);
745 add_cmd ("msymbols", class_maintenance
, maintenance_print_msymbols
,
746 "Print dump of current minimal symbol definitions.\n\
747 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
748 If a SOURCE file is specified, dump only that file's minimal symbols.",
749 &maintenanceprintlist
);
751 add_cmd ("psymbols", class_maintenance
, maintenance_print_psymbols
,
752 "Print dump of current partial symbol definitions.\n\
753 Entries in the partial symbol table are dumped to file OUTFILE.\n\
754 If a SOURCE file is specified, dump only that file's partial symbols.",
755 &maintenanceprintlist
);
757 add_cmd ("objfiles", class_maintenance
, maintenance_print_objfiles
,
758 "Print dump of current object file definitions.",
759 &maintenanceprintlist
);
761 add_cmd ("statistics", class_maintenance
, maintenance_print_statistics
,
762 "Print statistics about internal gdb state.",
763 &maintenanceprintlist
);
765 add_cmd ("architecture", class_maintenance
, maintenance_print_architecture
,
766 "Print the internal architecture configuration.\
767 Takes an optional file parameter.",
768 &maintenanceprintlist
);
770 add_cmd ("check-symtabs", class_maintenance
, maintenance_check_symtabs
,
771 "Check consistency of psymtabs and symtabs.",
774 add_cmd ("translate-address", class_maintenance
, maintenance_translate_address
,
775 "Translate a section name and address to a symbol.",
778 add_cmd ("deprecate", class_maintenance
, maintenance_deprecate
,
779 "Deprecate a command. Note that this is just in here so the \n\
780 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
781 rather you should use the C function deprecate_cmd(). If you decide you \n\
782 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
783 replacement is optional.", &maintenancelist
);
785 add_cmd ("undeprecate", class_maintenance
, maintenance_undeprecate
,
786 "Undeprecate a command. Note that this is just in here so the \n\
787 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
788 If you decide you want to use it: maintenance undeprecate 'commandname'",
792 add_set_cmd ("watchdog", class_maintenance
, var_zinteger
, (char *) &watchdog
,
793 "Set watchdog timer.\n\
794 When non-zero, this timeout is used instead of waiting forever for a target to\n\
795 finish a low-level step or continue operation. If the specified amount of time\n\
796 passes without a response from the target, an error occurs.", &setlist
),
801 /* FIXME: cagney/2002-06-15: A patch implementing profiling is
802 pending, this just sets up the framework. */
803 tmpcmd
= add_setshow_boolean_cmd ("profile", class_maintenance
,
804 var_boolean
, &maintenance_profile_p
, "\
805 Set internal profiling.\n\
806 When enabled GDB is profiled.", "\
807 Show internal profiling.\n",
808 maintenance_set_profile_cmd
, NULL
,
809 &maintenance_set_cmdlist
,
810 &maintenance_show_cmdlist
);