1 /* Support for GDB maintenance commands.
2 Copyright 1992, 1993, 1994 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
PARAMS ((void));
40 static void maintenance_command
PARAMS ((char *, int));
42 static void maintenance_dump_me
PARAMS ((char *, int));
44 static void maintenance_internal_error
PARAMS ((char *args
, int from_tty
));
46 static void maintenance_demangle
PARAMS ((char *, int));
48 static void maintenance_time_display
PARAMS ((char *, int));
50 static void maintenance_space_display
PARAMS ((char *, int));
52 static void maintenance_info_command
PARAMS ((char *, int));
54 static void print_section_table
PARAMS ((bfd
*, asection
*, PTR
));
56 static void maintenance_info_sections
PARAMS ((char *, int));
58 static void maintenance_print_command
PARAMS ((char *, int));
60 /* Set this to the maximum number of seconds to wait instead of waiting forever
61 in target_wait(). If this timer times out, then it generates an error and
62 the command is aborted. This replaces most of the need for timeouts in the
63 GDB test suite, and makes it possible to distinguish between a hung target
64 and one with slow communications. */
72 maintenance_command -- access the maintenance subcommands
76 void maintenance_command (char *args, int from_tty)
83 maintenance_command (args
, 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 (args
, from_tty
)
98 if (query ("Should GDB dump core? "))
101 /* SIGQUIT by default is ignored, so use SIGABRT instead. */
102 signal (SIGABRT
, SIG_DFL
);
103 kill (getpid (), SIGABRT
);
105 signal (SIGQUIT
, SIG_DFL
);
106 kill (getpid (), SIGQUIT
);
112 /* Stimulate the internal error mechanism that GDB uses when an
113 internal problem is detected. Allows testing of the mechanism.
114 Also useful when the user wants to drop a core file but not exit
118 maintenance_internal_error (char *args
, int from_tty
)
120 internal_error ("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 (args
, 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 (args
, from_tty
)
162 extern int display_time
;
164 if (args
== NULL
|| *args
== '\0')
165 printf_unfiltered ("\"maintenance time\" takes a numeric argument.\n");
167 display_time
= strtol (args
, NULL
, 10);
171 maintenance_space_display (args
, from_tty
)
175 extern int display_space
;
177 if (args
== NULL
|| *args
== '\0')
178 printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
180 display_space
= strtol (args
, NULL
, 10);
183 /* The "maintenance info" command is defined as a prefix, with
184 allow_unknown 0. Therefore, its own definition is called only for
185 "maintenance info" with no args. */
189 maintenance_info_command (arg
, from_tty
)
193 printf_unfiltered ("\"maintenance info\" must be followed by the name of an info command.\n");
194 help_list (maintenanceinfolist
, "maintenance info ", -1, gdb_stdout
);
198 print_section_table (abfd
, asect
, ignore
)
205 flags
= bfd_get_section_flags (abfd
, asect
);
207 /* FIXME-32x64: Need print_address_numeric with field width. */
208 printf_filtered (" %s",
209 local_hex_string_custom
210 ((unsigned long) bfd_section_vma (abfd
, asect
), "08l"));
211 printf_filtered ("->%s",
212 local_hex_string_custom
213 ((unsigned long) (bfd_section_vma (abfd
, asect
)
214 + bfd_section_size (abfd
, asect
)),
216 printf_filtered (" at %s",
217 local_hex_string_custom
218 ((unsigned long) asect
->filepos
, "08l"));
219 printf_filtered (": %s", bfd_section_name (abfd
, asect
));
221 if (flags
& SEC_ALLOC
)
222 printf_filtered (" ALLOC");
223 if (flags
& SEC_LOAD
)
224 printf_filtered (" LOAD");
225 if (flags
& SEC_RELOC
)
226 printf_filtered (" RELOC");
227 if (flags
& SEC_READONLY
)
228 printf_filtered (" READONLY");
229 if (flags
& SEC_CODE
)
230 printf_filtered (" CODE");
231 if (flags
& SEC_DATA
)
232 printf_filtered (" DATA");
234 printf_filtered (" ROM");
235 if (flags
& SEC_CONSTRUCTOR
)
236 printf_filtered (" CONSTRUCTOR");
237 if (flags
& SEC_HAS_CONTENTS
)
238 printf_filtered (" HAS_CONTENTS");
239 if (flags
& SEC_NEVER_LOAD
)
240 printf_filtered (" NEVER_LOAD");
241 if (flags
& SEC_COFF_SHARED_LIBRARY
)
242 printf_filtered (" COFF_SHARED_LIBRARY");
243 if (flags
& SEC_IS_COMMON
)
244 printf_filtered (" IS_COMMON");
246 printf_filtered ("\n");
251 maintenance_info_sections (arg
, from_tty
)
257 printf_filtered ("Exec file:\n");
258 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd
));
260 printf_filtered ("file type %s.\n", bfd_get_target (exec_bfd
));
261 bfd_map_over_sections (exec_bfd
, print_section_table
, 0);
266 printf_filtered ("Core file:\n");
267 printf_filtered (" `%s', ", bfd_get_filename (core_bfd
));
269 printf_filtered ("file type %s.\n", bfd_get_target (core_bfd
));
270 bfd_map_over_sections (core_bfd
, print_section_table
, 0);
276 maintenance_print_statistics (args
, from_tty
)
280 print_objfile_statistics ();
281 print_symbol_bcache_statistics ();
284 /* The "maintenance print" command is defined as a prefix, with
285 allow_unknown 0. Therefore, its own definition is called only for
286 "maintenance print" with no args. */
290 maintenance_print_command (arg
, from_tty
)
294 printf_unfiltered ("\"maintenance print\" must be followed by the name of a print command.\n");
295 help_list (maintenanceprintlist
, "maintenance print ", -1, gdb_stdout
);
298 /* The "maintenance translate-address" command converts a section and address
299 to a symbol. This can be called in two ways:
300 maintenance translate-address <secname> <addr>
301 or maintenance translate-address <addr>
305 maintenance_translate_address (arg
, from_tty
)
312 struct minimal_symbol
*sym
;
313 struct objfile
*objfile
;
315 if (arg
== NULL
|| *arg
== 0)
316 error ("requires argument (address or section + address)");
322 { /* See if we have a valid section name */
323 while (*p
&& !isspace (*p
)) /* Find end of section name */
325 if (*p
== '\000') /* End of command? */
326 error ("Need to specify <section-name> and <address>");
329 p
++; /* Skip whitespace */
331 ALL_OBJFILES (objfile
)
333 sect
= bfd_get_section_by_name (objfile
->obfd
, arg
);
339 error ("Unknown section %s.", arg
);
342 address
= parse_and_eval_address (p
);
345 sym
= lookup_minimal_symbol_by_pc_section (address
, sect
);
347 sym
= lookup_minimal_symbol_by_pc (address
);
350 printf_filtered ("%s+%s\n",
351 SYMBOL_SOURCE_NAME (sym
),
352 paddr_u (address
- SYMBOL_VALUE_ADDRESS (sym
)));
354 printf_filtered ("no symbol at %s:0x%s\n", sect
->name
, paddr (address
));
356 printf_filtered ("no symbol at 0x%s\n", paddr (address
));
362 /* When a comamnd is deprecated the user will be warned the first time
363 the command is used. If possible, a replacement will be
367 maintenance_deprecate (char *args
, int from_tty
)
369 if (args
== NULL
|| *args
== '\0')
371 printf_unfiltered ("\"maintenance deprecate\" takes an argument, \n\
372 the command you want to deprecate, and optionally the replacement command \n\
373 enclosed in quotes.\n");
376 maintenance_do_deprecate (args
, 1);
382 maintenance_undeprecate (char *args
, int from_tty
)
384 if (args
== NULL
|| *args
== '\0')
386 printf_unfiltered ("\"maintenance undeprecate\" takes an argument, \n\
387 the command you want to undeprecate.\n");
390 maintenance_do_deprecate (args
, 0);
394 /* You really shouldn't be using this. It is just for the testsuite.
395 Rather, you should use deprecate_cmd() when the command is created
396 in _initialize_blah().
398 This function deprecates a command and optionally assigns it a
402 maintenance_do_deprecate (char *text
, int deprecate
)
405 struct cmd_list_element
*alias
= NULL
;
406 struct cmd_list_element
*prefix_cmd
= NULL
;
407 struct cmd_list_element
*cmd
= NULL
;
409 char *start_ptr
= NULL
;
410 char *end_ptr
= NULL
;
412 char *replacement
= NULL
;
415 if (!lookup_cmd_composition (text
, &alias
, &prefix_cmd
, &cmd
))
417 printf_filtered ("Can't find command '%s' to deprecate.\n", text
);
423 /* look for a replacement command */
424 if (start_ptr
= strchr (text
, '\"'))
427 if (end_ptr
= strrchr (start_ptr
, '\"'))
429 len
= end_ptr
- start_ptr
;
430 start_ptr
[len
] = '\0';
431 replacement
= xstrdup (start_ptr
);
436 if (!start_ptr
|| !end_ptr
)
440 /* If they used an alias, we only want to deprecate the alias.
442 Note the MALLOCED_REPLACEMENT test. If the command's replacement
443 string was allocated at compile time we don't want to free the
448 if (alias
->flags
& MALLOCED_REPLACEMENT
)
449 free (alias
->replacement
);
452 alias
->flags
|= (DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
454 alias
->flags
&= ~(DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
455 alias
->replacement
= replacement
;
456 alias
->flags
|= MALLOCED_REPLACEMENT
;
461 if (cmd
->flags
& MALLOCED_REPLACEMENT
)
462 free (cmd
->replacement
);
465 cmd
->flags
|= (DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
467 cmd
->flags
&= ~(DEPRECATED_WARN_USER
| CMD_DEPRECATED
);
468 cmd
->replacement
= replacement
;
469 cmd
->flags
|= MALLOCED_REPLACEMENT
;
476 _initialize_maint_cmds ()
478 add_prefix_cmd ("maintenance", class_maintenance
, maintenance_command
,
479 "Commands for use by GDB maintainers.\n\
480 Includes commands to dump specific internal GDB structures in\n\
481 a human readable form, to cause GDB to deliberately dump core,\n\
482 to test internal functions such as the C++ demangler, etc.",
483 &maintenancelist
, "maintenance ", 0,
486 add_com_alias ("mt", "maintenance", class_maintenance
, 1);
488 add_prefix_cmd ("info", class_maintenance
, maintenance_info_command
,
489 "Commands for showing internal info about the program being debugged.",
490 &maintenanceinfolist
, "maintenance info ", 0,
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 ("check-symtabs", class_maintenance
, maintenance_check_symtabs
,
566 "Check consistency of psymtabs and symtabs.",
569 add_cmd ("translate-address", class_maintenance
, maintenance_translate_address
,
570 "Translate a section name and address to a symbol.",
573 add_cmd ("deprecate", class_maintenance
, maintenance_deprecate
,
574 "Deprecate a command. Note that this is just in here so the \n\
575 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
576 rather you should use the C function deprecate_cmd(). If you decide you \n\
577 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
578 replacement is optional.", &maintenancelist
);
580 add_cmd ("undeprecate", class_maintenance
, maintenance_undeprecate
,
581 "Undeprecate a command. Note that this is just in here so the \n\
582 testsuite can check the comamnd deprecator. You probably shouldn't use this,\n\
583 If you decide you want to use it: maintenance undeprecate 'commandname'",
587 add_set_cmd ("watchdog", class_maintenance
, var_zinteger
, (char *) &watchdog
,
588 "Set watchdog timer.\n\
589 When non-zero, this timeout is used instead of waiting forever for a target to\n\
590 finish a low-level step or continue operation. If the specified amount of time\n\
591 passes without a response from the target, an error occurs.", &setlist
),