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__
,
122 "internal maintenance");
125 /* Someday we should allow demangling for things other than just
126 explicit strings. For example, we might want to be able to specify
127 the address of a string in either GDB's process space or the
128 debuggee's process space, and have gdb fetch and demangle that
129 string. If we have a char* pointer "ptr" that points to a string,
130 we might want to be able to given just the name and have GDB
131 demangle and print what it points to, etc. (FIXME) */
134 maintenance_demangle (char *args
, int from_tty
)
138 if (args
== NULL
|| *args
== '\0')
140 printf_unfiltered ("\"maintenance demangle\" takes an argument to demangle.\n");
144 demangled
= cplus_demangle (args
, DMGL_ANSI
| DMGL_PARAMS
);
145 if (demangled
!= NULL
)
147 printf_unfiltered ("%s\n", demangled
);
152 printf_unfiltered ("Can't demangle \"%s\"\n", args
);
158 maintenance_time_display (char *args
, int from_tty
)
160 extern int display_time
;
162 if (args
== NULL
|| *args
== '\0')
163 printf_unfiltered ("\"maintenance time\" takes a numeric argument.\n");
165 display_time
= strtol (args
, NULL
, 10);
169 maintenance_space_display (char *args
, int from_tty
)
171 extern int display_space
;
173 if (args
== NULL
|| *args
== '\0')
174 printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
176 display_space
= strtol (args
, NULL
, 10);
179 /* The "maintenance info" command is defined as a prefix, with
180 allow_unknown 0. Therefore, its own definition is called only for
181 "maintenance info" with no args. */
185 maintenance_info_command (char *arg
, int from_tty
)
187 printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
188 help_list (maintenanceinfolist
, "maintenance info ", -1, gdb_stdout
);
191 /* Mini tokenizing lexer for 'maint info sections' command. */
194 match_substring (const char *string
, const char *substr
)
196 int substr_len
= strlen(substr
);
199 while ((tok
= strstr (string
, substr
)) != NULL
)
201 /* Got a partial match. Is it a whole word? */
206 /* Token is delimited at the front... */
207 if (tok
[substr_len
] == ' '
208 || tok
[substr_len
] == '\t'
209 || tok
[substr_len
] == '\0')
211 /* Token is delimited at the rear. Got a whole-word match. */
215 /* Token didn't match as a whole word. Advance and try again. */
222 match_bfd_flags (char *string
, flagword flags
)
224 if (flags
& SEC_ALLOC
)
225 if (match_substring (string
, "ALLOC"))
227 if (flags
& SEC_LOAD
)
228 if (match_substring (string
, "LOAD"))
230 if (flags
& SEC_RELOC
)
231 if (match_substring (string
, "RELOC"))
233 if (flags
& SEC_READONLY
)
234 if (match_substring (string
, "READONLY"))
236 if (flags
& SEC_CODE
)
237 if (match_substring (string
, "CODE"))
239 if (flags
& SEC_DATA
)
240 if (match_substring (string
, "DATA"))
243 if (match_substring (string
, "ROM"))
245 if (flags
& SEC_CONSTRUCTOR
)
246 if (match_substring (string
, "CONSTRUCTOR"))
248 if (flags
& SEC_HAS_CONTENTS
)
249 if (match_substring (string
, "HAS_CONTENTS"))
251 if (flags
& SEC_NEVER_LOAD
)
252 if (match_substring (string
, "NEVER_LOAD"))
254 if (flags
& SEC_COFF_SHARED_LIBRARY
)
255 if (match_substring (string
, "COFF_SHARED_LIBRARY"))
257 if (flags
& SEC_IS_COMMON
)
258 if (match_substring (string
, "IS_COMMON"))
265 print_bfd_flags (flagword flags
)
267 if (flags
& SEC_ALLOC
)
268 printf_filtered (" ALLOC");
269 if (flags
& SEC_LOAD
)
270 printf_filtered (" LOAD");
271 if (flags
& SEC_RELOC
)
272 printf_filtered (" RELOC");
273 if (flags
& SEC_READONLY
)
274 printf_filtered (" READONLY");
275 if (flags
& SEC_CODE
)
276 printf_filtered (" CODE");
277 if (flags
& SEC_DATA
)
278 printf_filtered (" DATA");
280 printf_filtered (" ROM");
281 if (flags
& SEC_CONSTRUCTOR
)
282 printf_filtered (" CONSTRUCTOR");
283 if (flags
& SEC_HAS_CONTENTS
)
284 printf_filtered (" HAS_CONTENTS");
285 if (flags
& SEC_NEVER_LOAD
)
286 printf_filtered (" NEVER_LOAD");
287 if (flags
& SEC_COFF_SHARED_LIBRARY
)
288 printf_filtered (" COFF_SHARED_LIBRARY");
289 if (flags
& SEC_IS_COMMON
)
290 printf_filtered (" IS_COMMON");
294 maint_print_section_info (const char *name
, flagword flags
,
295 CORE_ADDR addr
, CORE_ADDR endaddr
,
296 unsigned long filepos
)
298 /* FIXME-32x64: Need print_address_numeric with field width. */
299 printf_filtered (" 0x%s", paddr (addr
));
300 printf_filtered ("->0x%s", paddr (endaddr
));
301 printf_filtered (" at %s",
302 local_hex_string_custom ((unsigned long) filepos
, "08l"));
303 printf_filtered (": %s", name
);
304 print_bfd_flags (flags
);
305 printf_filtered ("\n");
309 print_bfd_section_info (bfd
*abfd
,
313 flagword flags
= bfd_get_section_flags (abfd
, asect
);
314 const char *name
= bfd_section_name (abfd
, asect
);
316 if (arg
== NULL
|| *((char *) arg
) == '\0'
317 || match_substring ((char *) arg
, name
)
318 || match_bfd_flags ((char *) arg
, flags
))
320 CORE_ADDR addr
, endaddr
;
322 addr
= bfd_section_vma (abfd
, asect
);
323 endaddr
= addr
+ bfd_section_size (abfd
, asect
);
324 maint_print_section_info (name
, flags
, addr
, endaddr
, asect
->filepos
);
329 print_objfile_section_info (bfd
*abfd
,
330 struct obj_section
*asect
,
333 flagword flags
= bfd_get_section_flags (abfd
, asect
->the_bfd_section
);
334 const char *name
= bfd_section_name (abfd
, asect
->the_bfd_section
);
336 if (string
== NULL
|| *string
== '\0'
337 || match_substring (string
, name
)
338 || match_bfd_flags (string
, flags
))
340 maint_print_section_info (name
, flags
, asect
->addr
, asect
->endaddr
,
341 asect
->the_bfd_section
->filepos
);
347 maintenance_info_sections (char *arg
, int from_tty
)
351 printf_filtered ("Exec file:\n");
352 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd
));
354 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd
));
355 if (arg
&& *arg
&& match_substring (arg
, "ALLOBJ"))
357 struct objfile
*ofile
;
358 struct obj_section
*osect
;
360 /* Only this function cares about the 'ALLOBJ' argument;
361 if 'ALLOBJ' is the only argument, discard it rather than
362 passing it down to print_objfile_section_info (which
363 wouldn't know how to handle it). */
364 if (strcmp (arg
, "ALLOBJ") == 0)
369 printf_filtered (" Object file: %s\n",
370 bfd_get_filename (ofile
->obfd
));
371 ALL_OBJFILE_OSECTIONS (ofile
, osect
)
373 print_objfile_section_info (ofile
->obfd
, osect
, arg
);
378 bfd_map_over_sections (exec_bfd
, print_bfd_section_info
, arg
);
383 printf_filtered ("Core file:\n");
384 printf_filtered (" `%s', ", bfd_get_filename (core_bfd
));
386 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd
));
387 bfd_map_over_sections (core_bfd
, print_bfd_section_info
, arg
);
393 maintenance_print_statistics (char *args
, int from_tty
)
395 print_objfile_statistics ();
396 print_symbol_bcache_statistics ();
400 maintenance_print_architecture (char *args
, int from_tty
)
403 gdbarch_dump (current_gdbarch
, gdb_stdout
);
406 struct ui_file
*file
= gdb_fopen (args
, "w");
408 perror_with_name ("maintenance print architecture");
409 gdbarch_dump (current_gdbarch
, file
);
410 ui_file_delete (file
);
414 /* The "maintenance print" command is defined as a prefix, with
415 allow_unknown 0. Therefore, its own definition is called only for
416 "maintenance print" with no args. */
420 maintenance_print_command (char *arg
, int from_tty
)
422 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
423 help_list (maintenanceprintlist
, "maintenance print ", -1, gdb_stdout
);
426 /* The "maintenance translate-address" command converts a section and address
427 to a symbol. This can be called in two ways:
428 maintenance translate-address <secname> <addr>
429 or maintenance translate-address <addr>
433 maintenance_translate_address (char *arg
, int from_tty
)
438 struct minimal_symbol
*sym
;
439 struct objfile
*objfile
;
441 if (arg
== NULL
|| *arg
== 0)
442 error ("requires argument (address or section + address)");
448 { /* See if we have a valid section name */
449 while (*p
&& !isspace (*p
)) /* Find end of section name */
451 if (*p
== '\000') /* End of command? */
452 error ("Need to specify <section-name> and <address>");
455 p
++; /* Skip whitespace */
457 ALL_OBJFILES (objfile
)
459 sect
= bfd_get_section_by_name (objfile
->obfd
, arg
);
465 error ("Unknown section %s.", arg
);
468 address
= parse_and_eval_address (p
);
471 sym
= lookup_minimal_symbol_by_pc_section (address
, sect
);
473 sym
= lookup_minimal_symbol_by_pc (address
);
476 printf_filtered ("%s+%s\n",
477 SYMBOL_SOURCE_NAME (sym
),
478 paddr_u (address
- SYMBOL_VALUE_ADDRESS (sym
)));
480 printf_filtered ("no symbol at %s:0x%s\n", sect
->name
, paddr (address
));
482 printf_filtered ("no symbol at 0x%s\n", paddr (address
));
488 /* When a command is deprecated the user will be warned the first time
489 the command is used. If possible, a replacement will be
493 maintenance_deprecate (char *args
, int from_tty
)
495 if (args
== NULL
|| *args
== '\0')
497 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
498 the command you want to deprecate, and optionally the replacement command \n\
499 enclosed in quotes.\n");
502 maintenance_do_deprecate (args
, 1);
508 maintenance_undeprecate (char *args
, int from_tty
)
510 if (args
== NULL
|| *args
== '\0')
512 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
513 the command you want to undeprecate.\n");
516 maintenance_do_deprecate (args
, 0);
520 /* You really shouldn't be using this. It is just for the testsuite.
521 Rather, you should use deprecate_cmd() when the command is created
522 in _initialize_blah().
524 This function deprecates a command and optionally assigns it a
528 maintenance_do_deprecate (char *text
, int deprecate
)
531 struct cmd_list_element
*alias
= NULL
;
532 struct cmd_list_element
*prefix_cmd
= NULL
;
533 struct cmd_list_element
*cmd
= NULL
;
535 char *start_ptr
= NULL
;
536 char *end_ptr
= NULL
;
538 char *replacement
= NULL
;
543 if (!lookup_cmd_composition (text
, &alias
, &prefix_cmd
, &cmd
))
545 printf_filtered ("Can't find command '%s' to deprecate.\n", text
);
551 /* look for a replacement command */
552 start_ptr
= strchr (text
, '\"');
553 if (start_ptr
!= NULL
)
556 end_ptr
= strrchr (start_ptr
, '\"');
559 len
= end_ptr
- start_ptr
;
560 start_ptr
[len
] = '\0';
561 replacement
= xstrdup (start_ptr
);
566 if (!start_ptr
|| !end_ptr
)
570 /* If they used an alias, we only want to deprecate the alias.
572 Note the MALLOCED_REPLACEMENT test. If the command's replacement
573 string was allocated at compile time we don't want to free the
578 if (alias
->flags
& MALLOCED_REPLACEMENT
)
579 xfree (alias
->replacement
);
582 alias
->flags
|= (DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
584 alias
->flags
&= ~(DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
585 alias
->replacement
= replacement
;
586 alias
->flags
|= MALLOCED_REPLACEMENT
;
591 if (cmd
->flags
& MALLOCED_REPLACEMENT
)
592 xfree (cmd
->replacement
);
595 cmd
->flags
|= (DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
597 cmd
->flags
&= ~(DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
598 cmd
->replacement
= replacement
;
599 cmd
->flags
|= MALLOCED_REPLACEMENT
;
604 /* Maintenance set/show framework. */
606 static struct cmd_list_element
*maintenance_set_cmdlist
;
607 static struct cmd_list_element
*maintenance_show_cmdlist
;
610 maintenance_set_cmd (char *args
, int from_tty
)
612 printf_unfiltered ("\"maintenance set\" must be followed by the name of a set command.\n");
613 help_list (maintenance_set_cmdlist
, "maintenance set ", -1, gdb_stdout
);
617 maintenance_show_cmd (char *args
, int from_tty
)
619 cmd_show_list (maintenance_show_cmdlist
, from_tty
, "");
623 /* Profiling support. */
625 static int maintenance_profile_p
;
628 maintenance_set_profile_cmd (char *args
, int from_tty
, struct cmd_list_element
*c
)
630 maintenance_profile_p
= 0;
631 warning ("\"maintenance set profile\" command not supported.\n");
636 _initialize_maint_cmds (void)
638 struct cmd_list_element
*tmpcmd
;
640 add_prefix_cmd ("maintenance", class_maintenance
, maintenance_command
,
641 "Commands for use by GDB maintainers.\n\
642 Includes commands to dump specific internal GDB structures in\n\
643 a human readable form, to cause GDB to deliberately dump core,\n\
644 to test internal functions such as the C++ demangler, etc.",
645 &maintenancelist
, "maintenance ", 0,
648 add_com_alias ("mt", "maintenance", class_maintenance
, 1);
650 add_prefix_cmd ("info", class_maintenance
, maintenance_info_command
,
651 "Commands for showing internal info about the program being debugged.",
652 &maintenanceinfolist
, "maintenance info ", 0,
654 add_alias_cmd ("i", "info", class_maintenance
, 1, &maintenancelist
);
656 add_cmd ("sections", class_maintenance
, maintenance_info_sections
,
657 "List the BFD sections of the exec and core files. \n\
658 Arguments may be any combination of:\n\
659 [one or more section names]\n\
660 ALLOC LOAD RELOC READONLY CODE DATA ROM CONSTRUCTOR\n\
661 HAS_CONTENTS NEVER_LOAD COFF_SHARED_LIBRARY IS_COMMON\n\
662 Sections matching any argument will be listed (no argument\n\
663 implies all sections). In addition, the special argument\n\
665 lists all sections from all object files, including shared libraries.",
666 &maintenanceinfolist
);
668 add_prefix_cmd ("print", class_maintenance
, maintenance_print_command
,
669 "Maintenance command for printing GDB internal state.",
670 &maintenanceprintlist
, "maintenance print ", 0,
673 add_prefix_cmd ("set", class_maintenance
, maintenance_set_cmd
, "\
674 Set GDB internal variables used by the GDB maintainer.\n\
675 Configure variables internal to GDB that aid in GDB's maintenance",
676 &maintenance_set_cmdlist
, "maintenance set ",
680 add_prefix_cmd ("show", class_maintenance
, maintenance_show_cmd
, "\
681 Show GDB internal variables used by the GDB maintainer.\n\
682 Configure variables internal to GDB that aid in GDB's maintenance",
683 &maintenance_show_cmdlist
, "maintenance show ",
688 add_cmd ("dump-me", class_maintenance
, maintenance_dump_me
,
689 "Get fatal error; make debugger dump its core.\n\
690 GDB sets it's handling of SIGQUIT back to SIG_DFL and then sends\n\
691 itself a SIGQUIT signal.",
695 add_cmd ("internal-error", class_maintenance
, maintenance_internal_error
,
696 "Give GDB an internal error.\n\
697 Cause GDB to behave as if an internal error was detected.",
700 add_cmd ("demangle", class_maintenance
, maintenance_demangle
,
701 "Demangle a C++ mangled name.\n\
702 Call internal GDB demangler routine to demangle a C++ link name\n\
703 and prints the result.",
706 add_cmd ("time", class_maintenance
, maintenance_time_display
,
707 "Set the display of time usage.\n\
708 If nonzero, will cause the execution time for each command to be\n\
709 displayed, following the command's output.",
712 add_cmd ("space", class_maintenance
, maintenance_space_display
,
713 "Set the display of space usage.\n\
714 If nonzero, will cause the execution space for each command to be\n\
715 displayed, following the command's output.",
718 add_cmd ("type", class_maintenance
, maintenance_print_type
,
719 "Print a type chain for a given symbol.\n\
720 For each node in a type chain, print the raw data for each member of\n\
721 the type structure, and the interpretation of the data.",
722 &maintenanceprintlist
);
724 add_cmd ("symbols", class_maintenance
, maintenance_print_symbols
,
725 "Print dump of current symbol definitions.\n\
726 Entries in the full symbol table are dumped to file OUTFILE.\n\
727 If a SOURCE file is specified, dump only that file's symbols.",
728 &maintenanceprintlist
);
730 add_cmd ("msymbols", class_maintenance
, maintenance_print_msymbols
,
731 "Print dump of current minimal symbol definitions.\n\
732 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
733 If a SOURCE file is specified, dump only that file's minimal symbols.",
734 &maintenanceprintlist
);
736 add_cmd ("psymbols", class_maintenance
, maintenance_print_psymbols
,
737 "Print dump of current partial symbol definitions.\n\
738 Entries in the partial symbol table are dumped to file OUTFILE.\n\
739 If a SOURCE file is specified, dump only that file's partial symbols.",
740 &maintenanceprintlist
);
742 add_cmd ("objfiles", class_maintenance
, maintenance_print_objfiles
,
743 "Print dump of current object file definitions.",
744 &maintenanceprintlist
);
746 add_cmd ("statistics", class_maintenance
, maintenance_print_statistics
,
747 "Print statistics about internal gdb state.",
748 &maintenanceprintlist
);
750 add_cmd ("architecture", class_maintenance
, maintenance_print_architecture
,
751 "Print the internal architecture configuration.\
752 Takes an optional file parameter.",
753 &maintenanceprintlist
);
755 add_cmd ("check-symtabs", class_maintenance
, maintenance_check_symtabs
,
756 "Check consistency of psymtabs and symtabs.",
759 add_cmd ("translate-address", class_maintenance
, maintenance_translate_address
,
760 "Translate a section name and address to a symbol.",
763 add_cmd ("deprecate", class_maintenance
, maintenance_deprecate
,
764 "Deprecate a command. Note that this is just in here so the \n\
765 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
766 rather you should use the C function deprecate_cmd(). If you decide you \n\
767 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
768 replacement is optional.", &maintenancelist
);
770 add_cmd ("undeprecate", class_maintenance
, maintenance_undeprecate
,
771 "Undeprecate a command. Note that this is just in here so the \n\
772 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
773 If you decide you want to use it: maintenance undeprecate 'commandname'",
777 add_set_cmd ("watchdog", class_maintenance
, var_zinteger
, (char *) &watchdog
,
778 "Set watchdog timer.\n\
779 When non-zero, this timeout is used instead of waiting forever for a target to\n\
780 finish a low-level step or continue operation. If the specified amount of time\n\
781 passes without a response from the target, an error occurs.", &setlist
),
786 /* FIXME: cagney/2001-09-24: A patch introducing a
787 add_set_boolean_cmd() is pending, the below should probably use
788 it. A patch implementing profiling is pending, this just sets up
790 tmpcmd
= add_set_cmd ("profile", class_maintenance
,
791 var_boolean
, &maintenance_profile_p
,
792 "Set internal profiling.\n\
793 When enabled GDB is profiled.",
794 &maintenance_set_cmdlist
);
795 set_cmd_sfunc (tmpcmd
, maintenance_set_profile_cmd
);
796 add_show_from_set (tmpcmd
, &maintenance_show_cmdlist
);