1 /* Support for GDB maintenance commands.
2 Copyright 1992, 1993, 1994, 2001 Free Software Foundation, Inc.
3 Written by Fred Fish at Cygnus Support.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
32 #include "expression.h" /* For language.h */
38 extern void _initialize_maint_cmds (void);
40 static void maintenance_command (char *, int);
42 static void maintenance_dump_me (char *, int);
44 static void maintenance_internal_error (char *args
, int from_tty
);
46 static void maintenance_demangle (char *, int);
48 static void maintenance_time_display (char *, int);
50 static void maintenance_space_display (char *, int);
52 static void maintenance_info_command (char *, int);
54 static void print_section_table (bfd
*, asection
*, PTR
);
56 static void maintenance_info_sections (char *, int);
58 static void maintenance_print_command (char *, int);
60 static void maintenance_do_deprecate (char *, int);
62 /* Set this to the maximum number of seconds to wait instead of waiting forever
63 in target_wait(). If this timer times out, then it generates an error and
64 the command is aborted. This replaces most of the need for timeouts in the
65 GDB test suite, and makes it possible to distinguish between a hung target
66 and one with slow communications. */
74 maintenance_command -- access the maintenance subcommands
78 void maintenance_command (char *args, int from_tty)
85 maintenance_command (char *args
, int from_tty
)
87 printf_unfiltered ("\"maintenance\" must be followed by the name of a maintenance command.\n");
88 help_list (maintenancelist
, "maintenance ", -1, gdb_stdout
);
94 maintenance_dump_me (char *args
, int from_tty
)
96 if (query ("Should GDB dump core? "))
99 /* SIGQUIT by default is ignored, so use SIGABRT instead. */
100 signal (SIGABRT
, SIG_DFL
);
101 kill (getpid (), SIGABRT
);
103 signal (SIGQUIT
, SIG_DFL
);
104 kill (getpid (), SIGQUIT
);
110 /* Stimulate the internal error mechanism that GDB uses when an
111 internal problem is detected. Allows testing of the mechanism.
112 Also useful when the user wants to drop a core file but not exit
116 maintenance_internal_error (char *args
, int from_tty
)
118 internal_error (__FILE__
, __LINE__
,
119 "internal maintenance");
122 /* Someday we should allow demangling for things other than just
123 explicit strings. For example, we might want to be able to specify
124 the address of a string in either GDB's process space or the
125 debuggee's process space, and have gdb fetch and demangle that
126 string. If we have a char* pointer "ptr" that points to a string,
127 we might want to be able to given just the name and have GDB
128 demangle and print what it points to, etc. (FIXME) */
131 maintenance_demangle (char *args
, int from_tty
)
135 if (args
== NULL
|| *args
== '\0')
137 printf_unfiltered ("\"maintenance demangle\" takes an argument to demangle.\n");
141 demangled
= cplus_demangle (args
, DMGL_ANSI
| DMGL_PARAMS
);
142 if (demangled
!= NULL
)
144 printf_unfiltered ("%s\n", demangled
);
149 printf_unfiltered ("Can't demangle \"%s\"\n", args
);
155 maintenance_time_display (char *args
, int from_tty
)
157 extern int display_time
;
159 if (args
== NULL
|| *args
== '\0')
160 printf_unfiltered ("\"maintenance time\" takes a numeric argument.\n");
162 display_time
= strtol (args
, NULL
, 10);
166 maintenance_space_display (char *args
, int from_tty
)
168 extern int display_space
;
170 if (args
== NULL
|| *args
== '\0')
171 printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
173 display_space
= strtol (args
, NULL
, 10);
176 /* The "maintenance info" command is defined as a prefix, with
177 allow_unknown 0. Therefore, its own definition is called only for
178 "maintenance info" with no args. */
182 maintenance_info_command (char *arg
, int from_tty
)
184 printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
185 help_list (maintenanceinfolist
, "maintenance info ", -1, gdb_stdout
);
189 print_section_table (bfd
*abfd
, asection
*asect
, PTR ignore
)
193 flags
= bfd_get_section_flags (abfd
, asect
);
195 /* FIXME-32x64: Need print_address_numeric with field width. */
196 printf_filtered (" %s",
197 local_hex_string_custom
198 ((unsigned long) bfd_section_vma (abfd
, asect
), "08l"));
199 printf_filtered ("->%s",
200 local_hex_string_custom
201 ((unsigned long) (bfd_section_vma (abfd
, asect
)
202 + bfd_section_size (abfd
, asect
)),
204 printf_filtered (" at %s",
205 local_hex_string_custom
206 ((unsigned long) asect
->filepos
, "08l"));
207 printf_filtered (": %s", bfd_section_name (abfd
, asect
));
209 if (flags
& SEC_ALLOC
)
210 printf_filtered (" ALLOC");
211 if (flags
& SEC_LOAD
)
212 printf_filtered (" LOAD");
213 if (flags
& SEC_RELOC
)
214 printf_filtered (" RELOC");
215 if (flags
& SEC_READONLY
)
216 printf_filtered (" READONLY");
217 if (flags
& SEC_CODE
)
218 printf_filtered (" CODE");
219 if (flags
& SEC_DATA
)
220 printf_filtered (" DATA");
222 printf_filtered (" ROM");
223 if (flags
& SEC_CONSTRUCTOR
)
224 printf_filtered (" CONSTRUCTOR");
225 if (flags
& SEC_HAS_CONTENTS
)
226 printf_filtered (" HAS_CONTENTS");
227 if (flags
& SEC_NEVER_LOAD
)
228 printf_filtered (" NEVER_LOAD");
229 if (flags
& SEC_COFF_SHARED_LIBRARY
)
230 printf_filtered (" COFF_SHARED_LIBRARY");
231 if (flags
& SEC_IS_COMMON
)
232 printf_filtered (" IS_COMMON");
234 printf_filtered ("\n");
239 maintenance_info_sections (char *arg
, int from_tty
)
243 printf_filtered ("Exec file:\n");
244 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd
));
246 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd
));
247 bfd_map_over_sections (exec_bfd
, print_section_table
, 0);
252 printf_filtered ("Core file:\n");
253 printf_filtered (" `%s', ", bfd_get_filename (core_bfd
));
255 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd
));
256 bfd_map_over_sections (core_bfd
, print_section_table
, 0);
262 maintenance_print_statistics (char *args
, int from_tty
)
264 print_objfile_statistics ();
265 print_symbol_bcache_statistics ();
269 maintenance_print_architecture (char *args
, int from_tty
)
272 gdbarch_dump (current_gdbarch
, gdb_stdout
);
275 struct ui_file
*file
= gdb_fopen (args
, "w");
277 perror_with_name ("maintenance print architecture");
278 gdbarch_dump (current_gdbarch
, file
);
279 ui_file_delete (file
);
283 /* The "maintenance print" command is defined as a prefix, with
284 allow_unknown 0. Therefore, its own definition is called only for
285 "maintenance print" with no args. */
289 maintenance_print_command (char *arg
, int from_tty
)
291 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
292 help_list (maintenanceprintlist
, "maintenance print ", -1, gdb_stdout
);
295 /* The "maintenance translate-address" command converts a section and address
296 to a symbol. This can be called in two ways:
297 maintenance translate-address <secname> <addr>
298 or maintenance translate-address <addr>
302 maintenance_translate_address (char *arg
, int from_tty
)
307 struct minimal_symbol
*sym
;
308 struct objfile
*objfile
;
310 if (arg
== NULL
|| *arg
== 0)
311 error ("requires argument (address or section + address)");
317 { /* See if we have a valid section name */
318 while (*p
&& !isspace (*p
)) /* Find end of section name */
320 if (*p
== '\000') /* End of command? */
321 error ("Need to specify <section-name> and <address>");
324 p
++; /* Skip whitespace */
326 ALL_OBJFILES (objfile
)
328 sect
= bfd_get_section_by_name (objfile
->obfd
, arg
);
334 error ("Unknown section %s.", arg
);
337 address
= parse_and_eval_address (p
);
340 sym
= lookup_minimal_symbol_by_pc_section (address
, sect
);
342 sym
= lookup_minimal_symbol_by_pc (address
);
345 printf_filtered ("%s+%s\n",
346 SYMBOL_SOURCE_NAME (sym
),
347 paddr_u (address
- SYMBOL_VALUE_ADDRESS (sym
)));
349 printf_filtered ("no symbol at %s:0x%s\n", sect
->name
, paddr (address
));
351 printf_filtered ("no symbol at 0x%s\n", paddr (address
));
357 /* When a comamnd is deprecated the user will be warned the first time
358 the command is used. If possible, a replacement will be
362 maintenance_deprecate (char *args
, int from_tty
)
364 if (args
== NULL
|| *args
== '\0')
366 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
367 the command you want to deprecate, and optionally the replacement command \n\
368 enclosed in quotes.\n");
371 maintenance_do_deprecate (args
, 1);
377 maintenance_undeprecate (char *args
, int from_tty
)
379 if (args
== NULL
|| *args
== '\0')
381 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
382 the command you want to undeprecate.\n");
385 maintenance_do_deprecate (args
, 0);
389 /* You really shouldn't be using this. It is just for the testsuite.
390 Rather, you should use deprecate_cmd() when the command is created
391 in _initialize_blah().
393 This function deprecates a command and optionally assigns it a
397 maintenance_do_deprecate (char *text
, int deprecate
)
400 struct cmd_list_element
*alias
= NULL
;
401 struct cmd_list_element
*prefix_cmd
= NULL
;
402 struct cmd_list_element
*cmd
= NULL
;
404 char *start_ptr
= NULL
;
405 char *end_ptr
= NULL
;
407 char *replacement
= NULL
;
412 if (!lookup_cmd_composition (text
, &alias
, &prefix_cmd
, &cmd
))
414 printf_filtered ("Can't find command '%s' to deprecate.\n", text
);
420 /* look for a replacement command */
421 start_ptr
= strchr (text
, '\"');
422 if (start_ptr
!= NULL
)
425 end_ptr
= strrchr (start_ptr
, '\"');
428 len
= end_ptr
- start_ptr
;
429 start_ptr
[len
] = '\0';
430 replacement
= xstrdup (start_ptr
);
435 if (!start_ptr
|| !end_ptr
)
439 /* If they used an alias, we only want to deprecate the alias.
441 Note the MALLOCED_REPLACEMENT test. If the command's replacement
442 string was allocated at compile time we don't want to free the
447 if (alias
->flags
& MALLOCED_REPLACEMENT
)
448 xfree (alias
->replacement
);
451 alias
->flags
|= (DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
453 alias
->flags
&= ~(DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
454 alias
->replacement
= replacement
;
455 alias
->flags
|= MALLOCED_REPLACEMENT
;
460 if (cmd
->flags
& MALLOCED_REPLACEMENT
)
461 xfree (cmd
->replacement
);
464 cmd
->flags
|= (DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
466 cmd
->flags
&= ~(DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
467 cmd
->replacement
= replacement
;
468 cmd
->flags
|= MALLOCED_REPLACEMENT
;
475 _initialize_maint_cmds (void)
477 add_prefix_cmd ("maintenance", class_maintenance
, maintenance_command
,
478 "Commands for use by GDB maintainers.\n\
479 Includes commands to dump specific internal GDB structures in\n\
480 a human readable form, to cause GDB to deliberately dump core,\n\
481 to test internal functions such as the C++ demangler, etc.",
482 &maintenancelist
, "maintenance ", 0,
485 add_com_alias ("mt", "maintenance", class_maintenance
, 1);
487 add_prefix_cmd ("info", class_maintenance
, maintenance_info_command
,
488 "Commands for showing internal info about the program being debugged.",
489 &maintenanceinfolist
, "maintenance info ", 0,
491 add_alias_cmd ("i", "info", class_maintenance
, 1, &maintenancelist
);
493 add_cmd ("sections", class_maintenance
, maintenance_info_sections
,
494 "List the BFD sections of the exec and core files.",
495 &maintenanceinfolist
);
497 add_prefix_cmd ("print", class_maintenance
, maintenance_print_command
,
498 "Maintenance command for printing GDB internal state.",
499 &maintenanceprintlist
, "maintenance print ", 0,
503 add_cmd ("dump-me", class_maintenance
, maintenance_dump_me
,
504 "Get fatal error; make debugger dump its core.\n\
505 GDB sets it's handling of SIGQUIT back to SIG_DFL and then sends\n\
506 itself a SIGQUIT signal.",
510 add_cmd ("internal-error", class_maintenance
, maintenance_internal_error
,
511 "Give GDB an internal error.\n\
512 Cause GDB to behave as if an internal error was detected.",
515 add_cmd ("demangle", class_maintenance
, maintenance_demangle
,
516 "Demangle a C++ mangled name.\n\
517 Call internal GDB demangler routine to demangle a C++ link name\n\
518 and prints the result.",
521 add_cmd ("time", class_maintenance
, maintenance_time_display
,
522 "Set the display of time usage.\n\
523 If nonzero, will cause the execution time for each command to be\n\
524 displayed, following the command's output.",
527 add_cmd ("space", class_maintenance
, maintenance_space_display
,
528 "Set the display of space usage.\n\
529 If nonzero, will cause the execution space for each command to be\n\
530 displayed, following the command's output.",
533 add_cmd ("type", class_maintenance
, maintenance_print_type
,
534 "Print a type chain for a given symbol.\n\
535 For each node in a type chain, print the raw data for each member of\n\
536 the type structure, and the interpretation of the data.",
537 &maintenanceprintlist
);
539 add_cmd ("symbols", class_maintenance
, maintenance_print_symbols
,
540 "Print dump of current symbol definitions.\n\
541 Entries in the full symbol table are dumped to file OUTFILE.\n\
542 If a SOURCE file is specified, dump only that file's symbols.",
543 &maintenanceprintlist
);
545 add_cmd ("msymbols", class_maintenance
, maintenance_print_msymbols
,
546 "Print dump of current minimal symbol definitions.\n\
547 Entries in the minimal symbol table are dumped to file OUTFILE.\n\
548 If a SOURCE file is specified, dump only that file's minimal symbols.",
549 &maintenanceprintlist
);
551 add_cmd ("psymbols", class_maintenance
, maintenance_print_psymbols
,
552 "Print dump of current partial symbol definitions.\n\
553 Entries in the partial symbol table are dumped to file OUTFILE.\n\
554 If a SOURCE file is specified, dump only that file's partial symbols.",
555 &maintenanceprintlist
);
557 add_cmd ("objfiles", class_maintenance
, maintenance_print_objfiles
,
558 "Print dump of current object file definitions.",
559 &maintenanceprintlist
);
561 add_cmd ("statistics", class_maintenance
, maintenance_print_statistics
,
562 "Print statistics about internal gdb state.",
563 &maintenanceprintlist
);
565 add_cmd ("architecture", class_maintenance
, maintenance_print_architecture
,
566 "Print the internal architecture configuration.\
567 Takes an optional file parameter.",
568 &maintenanceprintlist
);
570 add_cmd ("check-symtabs", class_maintenance
, maintenance_check_symtabs
,
571 "Check consistency of psymtabs and symtabs.",
574 add_cmd ("translate-address", class_maintenance
, maintenance_translate_address
,
575 "Translate a section name and address to a symbol.",
578 add_cmd ("deprecate", class_maintenance
, maintenance_deprecate
,
579 "Deprecate a command. Note that this is just in here so the \n\
580 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
581 rather you should use the C function deprecate_cmd(). If you decide you \n\
582 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
583 replacement is optional.", &maintenancelist
);
585 add_cmd ("undeprecate", class_maintenance
, maintenance_undeprecate
,
586 "Undeprecate a command. Note that this is just in here so the \n\
587 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
588 If you decide you want to use it: maintenance undeprecate 'commandname'",
592 add_set_cmd ("watchdog", class_maintenance
, var_zinteger
, (char *) &watchdog
,
593 "Set watchdog timer.\n\
594 When non-zero, this timeout is used instead of waiting forever for a target to\n\
595 finish a low-level step or continue operation. If the specified amount of time\n\
596 passes without a response from the target, an error occurs.", &setlist
),