Constify commands maint.c, plus maintenance_print_type
[binutils-gdb.git] / gdb / maint.c
1 /* Support for GDB maintenance commands.
2
3 Copyright (C) 1992-2017 Free Software Foundation, Inc.
4
5 Written by Fred Fish at Cygnus Support.
6
7 This file is part of GDB.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21
22
23 #include "defs.h"
24 #include "arch-utils.h"
25 #include <ctype.h>
26 #include <signal.h>
27 #include "command.h"
28 #include "gdbcmd.h"
29 #include "symtab.h"
30 #include "block.h"
31 #include "gdbtypes.h"
32 #include "demangle.h"
33 #include "gdbcore.h"
34 #include "expression.h" /* For language.h */
35 #include "language.h"
36 #include "symfile.h"
37 #include "objfiles.h"
38 #include "value.h"
39 #include "top.h"
40 #include "maint.h"
41 #include "selftest.h"
42
43 #include "cli/cli-decode.h"
44 #include "cli/cli-utils.h"
45 #include "cli/cli-setshow.h"
46
47 static void maintenance_command (char *, int);
48
49 static void maintenance_internal_error (char *args, int from_tty);
50
51 static void maintenance_space_display (char *, int);
52
53 static void maintenance_info_command (char *, int);
54
55 static void maintenance_print_command (char *, int);
56
57 static void maintenance_do_deprecate (const char *, int);
58
59 /* Set this to the maximum number of seconds to wait instead of waiting forever
60 in target_wait(). If this timer times out, then it generates an error and
61 the command is aborted. This replaces most of the need for timeouts in the
62 GDB test suite, and makes it possible to distinguish between a hung target
63 and one with slow communications. */
64
65 int watchdog = 0;
66 static void
67 show_watchdog (struct ui_file *file, int from_tty,
68 struct cmd_list_element *c, const char *value)
69 {
70 fprintf_filtered (file, _("Watchdog timer is %s.\n"), value);
71 }
72
73 /* Access the maintenance subcommands. */
74
75 static void
76 maintenance_command (char *args, int from_tty)
77 {
78 printf_unfiltered (_("\"maintenance\" must be followed by "
79 "the name of a maintenance command.\n"));
80 help_list (maintenancelist, "maintenance ", all_commands, gdb_stdout);
81 }
82
83 #ifndef _WIN32
84 static void
85 maintenance_dump_me (const char *args, int from_tty)
86 {
87 if (query (_("Should GDB dump core? ")))
88 {
89 #ifdef __DJGPP__
90 /* SIGQUIT by default is ignored, so use SIGABRT instead. */
91 signal (SIGABRT, SIG_DFL);
92 kill (getpid (), SIGABRT);
93 #else
94 signal (SIGQUIT, SIG_DFL);
95 kill (getpid (), SIGQUIT);
96 #endif
97 }
98 }
99 #endif
100
101 /* Stimulate the internal error mechanism that GDB uses when an
102 internal problem is detected. Allows testing of the mechanism.
103 Also useful when the user wants to drop a core file but not exit
104 GDB. */
105
106 static void
107 maintenance_internal_error (char *args, int from_tty)
108 {
109 internal_error (__FILE__, __LINE__, "%s", (args == NULL ? "" : args));
110 }
111
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
115 GDB. */
116
117 static void
118 maintenance_internal_warning (char *args, int from_tty)
119 {
120 internal_warning (__FILE__, __LINE__, "%s", (args == NULL ? "" : args));
121 }
122
123 /* Stimulate the internal error mechanism that GDB uses when an
124 demangler problem is detected. Allows testing of the mechanism. */
125
126 static void
127 maintenance_demangler_warning (char *args, int from_tty)
128 {
129 demangler_warning (__FILE__, __LINE__, "%s", (args == NULL ? "" : args));
130 }
131
132 /* Old command to demangle a string. The command has been moved to "demangle".
133 It is kept for now because otherwise "mt demangle" gets interpreted as
134 "mt demangler-warning" which artificially creates an internal gdb error. */
135
136 static void
137 maintenance_demangle (const char *args, int from_tty)
138 {
139 printf_filtered (_("This command has been moved to \"demangle\".\n"));
140 }
141
142 static void
143 maintenance_time_display (const char *args, int from_tty)
144 {
145 if (args == NULL || *args == '\0')
146 printf_unfiltered (_("\"maintenance time\" takes a numeric argument.\n"));
147 else
148 set_per_command_time (strtol (args, NULL, 10));
149 }
150
151 static void
152 maintenance_space_display (char *args, int from_tty)
153 {
154 if (args == NULL || *args == '\0')
155 printf_unfiltered ("\"maintenance space\" takes a numeric argument.\n");
156 else
157 set_per_command_space (strtol (args, NULL, 10));
158 }
159
160 /* The "maintenance info" command is defined as a prefix, with
161 allow_unknown 0. Therefore, its own definition is called only for
162 "maintenance info" with no args. */
163
164 static void
165 maintenance_info_command (char *arg, int from_tty)
166 {
167 printf_unfiltered (_("\"maintenance info\" must be followed "
168 "by the name of an info command.\n"));
169 help_list (maintenanceinfolist, "maintenance info ", all_commands,
170 gdb_stdout);
171 }
172
173 /* The "maintenance check" command is defined as a prefix, with
174 allow_unknown 0. Therefore, its own definition is called only for
175 "maintenance check" with no args. */
176
177 static void
178 maintenance_check_command (char *arg, int from_tty)
179 {
180 printf_unfiltered (_("\"maintenance check\" must be followed "
181 "by the name of a check command.\n"));
182 help_list (maintenancechecklist, "maintenance check ", all_commands,
183 gdb_stdout);
184 }
185
186 /* Mini tokenizing lexer for 'maint info sections' command. */
187
188 static int
189 match_substring (const char *string, const char *substr)
190 {
191 int substr_len = strlen(substr);
192 const char *tok;
193
194 while ((tok = strstr (string, substr)) != NULL)
195 {
196 /* Got a partial match. Is it a whole word? */
197 if (tok == string
198 || tok[-1] == ' '
199 || tok[-1] == '\t')
200 {
201 /* Token is delimited at the front... */
202 if (tok[substr_len] == ' '
203 || tok[substr_len] == '\t'
204 || tok[substr_len] == '\0')
205 {
206 /* Token is delimited at the rear. Got a whole-word match. */
207 return 1;
208 }
209 }
210 /* Token didn't match as a whole word. Advance and try again. */
211 string = tok + 1;
212 }
213 return 0;
214 }
215
216 static int
217 match_bfd_flags (const char *string, flagword flags)
218 {
219 if (flags & SEC_ALLOC)
220 if (match_substring (string, "ALLOC"))
221 return 1;
222 if (flags & SEC_LOAD)
223 if (match_substring (string, "LOAD"))
224 return 1;
225 if (flags & SEC_RELOC)
226 if (match_substring (string, "RELOC"))
227 return 1;
228 if (flags & SEC_READONLY)
229 if (match_substring (string, "READONLY"))
230 return 1;
231 if (flags & SEC_CODE)
232 if (match_substring (string, "CODE"))
233 return 1;
234 if (flags & SEC_DATA)
235 if (match_substring (string, "DATA"))
236 return 1;
237 if (flags & SEC_ROM)
238 if (match_substring (string, "ROM"))
239 return 1;
240 if (flags & SEC_CONSTRUCTOR)
241 if (match_substring (string, "CONSTRUCTOR"))
242 return 1;
243 if (flags & SEC_HAS_CONTENTS)
244 if (match_substring (string, "HAS_CONTENTS"))
245 return 1;
246 if (flags & SEC_NEVER_LOAD)
247 if (match_substring (string, "NEVER_LOAD"))
248 return 1;
249 if (flags & SEC_COFF_SHARED_LIBRARY)
250 if (match_substring (string, "COFF_SHARED_LIBRARY"))
251 return 1;
252 if (flags & SEC_IS_COMMON)
253 if (match_substring (string, "IS_COMMON"))
254 return 1;
255
256 return 0;
257 }
258
259 static void
260 print_bfd_flags (flagword flags)
261 {
262 if (flags & SEC_ALLOC)
263 printf_filtered (" ALLOC");
264 if (flags & SEC_LOAD)
265 printf_filtered (" LOAD");
266 if (flags & SEC_RELOC)
267 printf_filtered (" RELOC");
268 if (flags & SEC_READONLY)
269 printf_filtered (" READONLY");
270 if (flags & SEC_CODE)
271 printf_filtered (" CODE");
272 if (flags & SEC_DATA)
273 printf_filtered (" DATA");
274 if (flags & SEC_ROM)
275 printf_filtered (" ROM");
276 if (flags & SEC_CONSTRUCTOR)
277 printf_filtered (" CONSTRUCTOR");
278 if (flags & SEC_HAS_CONTENTS)
279 printf_filtered (" HAS_CONTENTS");
280 if (flags & SEC_NEVER_LOAD)
281 printf_filtered (" NEVER_LOAD");
282 if (flags & SEC_COFF_SHARED_LIBRARY)
283 printf_filtered (" COFF_SHARED_LIBRARY");
284 if (flags & SEC_IS_COMMON)
285 printf_filtered (" IS_COMMON");
286 }
287
288 static void
289 maint_print_section_info (const char *name, flagword flags,
290 CORE_ADDR addr, CORE_ADDR endaddr,
291 unsigned long filepos, int addr_size)
292 {
293 printf_filtered (" %s", hex_string_custom (addr, addr_size));
294 printf_filtered ("->%s", hex_string_custom (endaddr, addr_size));
295 printf_filtered (" at %s",
296 hex_string_custom ((unsigned long) filepos, 8));
297 printf_filtered (": %s", name);
298 print_bfd_flags (flags);
299 printf_filtered ("\n");
300 }
301
302 static void
303 print_bfd_section_info (bfd *abfd,
304 asection *asect,
305 void *datum)
306 {
307 flagword flags = bfd_get_section_flags (abfd, asect);
308 const char *name = bfd_section_name (abfd, asect);
309 const char *arg = (const char *) datum;
310
311 if (arg == NULL || *arg == '\0'
312 || match_substring (arg, name)
313 || match_bfd_flags (arg, flags))
314 {
315 struct gdbarch *gdbarch = gdbarch_from_bfd (abfd);
316 int addr_size = gdbarch_addr_bit (gdbarch) / 8;
317 CORE_ADDR addr, endaddr;
318
319 addr = bfd_section_vma (abfd, asect);
320 endaddr = addr + bfd_section_size (abfd, asect);
321 printf_filtered (" [%d] ", gdb_bfd_section_index (abfd, asect));
322 maint_print_section_info (name, flags, addr, endaddr,
323 asect->filepos, addr_size);
324 }
325 }
326
327 static void
328 print_objfile_section_info (bfd *abfd,
329 struct obj_section *asect,
330 const char *string)
331 {
332 flagword flags = bfd_get_section_flags (abfd, asect->the_bfd_section);
333 const char *name = bfd_section_name (abfd, asect->the_bfd_section);
334
335 if (string == NULL || *string == '\0'
336 || match_substring (string, name)
337 || match_bfd_flags (string, flags))
338 {
339 struct gdbarch *gdbarch = gdbarch_from_bfd (abfd);
340 int addr_size = gdbarch_addr_bit (gdbarch) / 8;
341
342 maint_print_section_info (name, flags,
343 obj_section_addr (asect),
344 obj_section_endaddr (asect),
345 asect->the_bfd_section->filepos,
346 addr_size);
347 }
348 }
349
350 static void
351 maintenance_info_sections (const char *arg, int from_tty)
352 {
353 if (exec_bfd)
354 {
355 printf_filtered (_("Exec file:\n"));
356 printf_filtered (" `%s', ", bfd_get_filename (exec_bfd));
357 wrap_here (" ");
358 printf_filtered (_("file type %s.\n"), bfd_get_target (exec_bfd));
359 if (arg && *arg && match_substring (arg, "ALLOBJ"))
360 {
361 struct objfile *ofile;
362 struct obj_section *osect;
363
364 /* Only this function cares about the 'ALLOBJ' argument;
365 if 'ALLOBJ' is the only argument, discard it rather than
366 passing it down to print_objfile_section_info (which
367 wouldn't know how to handle it). */
368 if (strcmp (arg, "ALLOBJ") == 0)
369 arg = NULL;
370
371 ALL_OBJFILES (ofile)
372 {
373 printf_filtered (_(" Object file: %s\n"),
374 bfd_get_filename (ofile->obfd));
375 ALL_OBJFILE_OSECTIONS (ofile, osect)
376 {
377 print_objfile_section_info (ofile->obfd, osect, arg);
378 }
379 }
380 }
381 else
382 bfd_map_over_sections (exec_bfd, print_bfd_section_info, (void *) arg);
383 }
384
385 if (core_bfd)
386 {
387 printf_filtered (_("Core file:\n"));
388 printf_filtered (" `%s', ", bfd_get_filename (core_bfd));
389 wrap_here (" ");
390 printf_filtered (_("file type %s.\n"), bfd_get_target (core_bfd));
391 bfd_map_over_sections (core_bfd, print_bfd_section_info, (void *) arg);
392 }
393 }
394
395 static void
396 maintenance_print_statistics (const char *args, int from_tty)
397 {
398 print_objfile_statistics ();
399 print_symbol_bcache_statistics ();
400 }
401
402 static void
403 maintenance_print_architecture (char *args, int from_tty)
404 {
405 struct gdbarch *gdbarch = get_current_arch ();
406
407 if (args == NULL)
408 gdbarch_dump (gdbarch, gdb_stdout);
409 else
410 {
411 stdio_file file;
412
413 if (!file.open (args, "w"))
414 perror_with_name (_("maintenance print architecture"));
415 gdbarch_dump (gdbarch, &file);
416 }
417 }
418
419 /* The "maintenance print" command is defined as a prefix, with
420 allow_unknown 0. Therefore, its own definition is called only for
421 "maintenance print" with no args. */
422
423 static void
424 maintenance_print_command (char *arg, int from_tty)
425 {
426 printf_unfiltered (_("\"maintenance print\" must be followed "
427 "by the name of a print command.\n"));
428 help_list (maintenanceprintlist, "maintenance print ", all_commands,
429 gdb_stdout);
430 }
431
432 /* The "maintenance translate-address" command converts a section and address
433 to a symbol. This can be called in two ways:
434 maintenance translate-address <secname> <addr>
435 or maintenance translate-address <addr>. */
436
437 static void
438 maintenance_translate_address (char *arg, int from_tty)
439 {
440 CORE_ADDR address;
441 struct obj_section *sect;
442 char *p;
443 struct bound_minimal_symbol sym;
444 struct objfile *objfile;
445
446 if (arg == NULL || *arg == 0)
447 error (_("requires argument (address or section + address)"));
448
449 sect = NULL;
450 p = arg;
451
452 if (!isdigit (*p))
453 { /* See if we have a valid section name. */
454 while (*p && !isspace (*p)) /* Find end of section name. */
455 p++;
456 if (*p == '\000') /* End of command? */
457 error (_("Need to specify <section-name> and <address>"));
458 *p++ = '\000';
459 p = skip_spaces (p);
460
461 ALL_OBJSECTIONS (objfile, sect)
462 {
463 if (strcmp (sect->the_bfd_section->name, arg) == 0)
464 break;
465 }
466
467 if (!objfile)
468 error (_("Unknown section %s."), arg);
469 }
470
471 address = parse_and_eval_address (p);
472
473 if (sect)
474 sym = lookup_minimal_symbol_by_pc_section (address, sect);
475 else
476 sym = lookup_minimal_symbol_by_pc (address);
477
478 if (sym.minsym)
479 {
480 const char *symbol_name = MSYMBOL_PRINT_NAME (sym.minsym);
481 const char *symbol_offset
482 = pulongest (address - BMSYMBOL_VALUE_ADDRESS (sym));
483
484 sect = MSYMBOL_OBJ_SECTION(sym.objfile, sym.minsym);
485 if (sect != NULL)
486 {
487 const char *section_name;
488 const char *obj_name;
489
490 gdb_assert (sect->the_bfd_section && sect->the_bfd_section->name);
491 section_name = sect->the_bfd_section->name;
492
493 gdb_assert (sect->objfile && objfile_name (sect->objfile));
494 obj_name = objfile_name (sect->objfile);
495
496 if (MULTI_OBJFILE_P ())
497 printf_filtered (_("%s + %s in section %s of %s\n"),
498 symbol_name, symbol_offset,
499 section_name, obj_name);
500 else
501 printf_filtered (_("%s + %s in section %s\n"),
502 symbol_name, symbol_offset, section_name);
503 }
504 else
505 printf_filtered (_("%s + %s\n"), symbol_name, symbol_offset);
506 }
507 else if (sect)
508 printf_filtered (_("no symbol at %s:%s\n"),
509 sect->the_bfd_section->name, hex_string (address));
510 else
511 printf_filtered (_("no symbol at %s\n"), hex_string (address));
512
513 return;
514 }
515
516
517 /* When a command is deprecated the user will be warned the first time
518 the command is used. If possible, a replacement will be
519 offered. */
520
521 static void
522 maintenance_deprecate (const char *args, int from_tty)
523 {
524 if (args == NULL || *args == '\0')
525 {
526 printf_unfiltered (_("\"maintenance deprecate\" takes an argument,\n\
527 the command you want to deprecate, and optionally the replacement command\n\
528 enclosed in quotes.\n"));
529 }
530
531 maintenance_do_deprecate (args, 1);
532 }
533
534
535 static void
536 maintenance_undeprecate (const char *args, int from_tty)
537 {
538 if (args == NULL || *args == '\0')
539 {
540 printf_unfiltered (_("\"maintenance undeprecate\" takes an argument, \n\
541 the command you want to undeprecate.\n"));
542 }
543
544 maintenance_do_deprecate (args, 0);
545 }
546
547 /* You really shouldn't be using this. It is just for the testsuite.
548 Rather, you should use deprecate_cmd() when the command is created
549 in _initialize_blah().
550
551 This function deprecates a command and optionally assigns it a
552 replacement. */
553
554 static void
555 maintenance_do_deprecate (const char *text, int deprecate)
556 {
557 struct cmd_list_element *alias = NULL;
558 struct cmd_list_element *prefix_cmd = NULL;
559 struct cmd_list_element *cmd = NULL;
560
561 const char *start_ptr = NULL;
562 const char *end_ptr = NULL;
563 int len;
564 char *replacement = NULL;
565
566 if (text == NULL)
567 return;
568
569 if (!lookup_cmd_composition (text, &alias, &prefix_cmd, &cmd))
570 {
571 printf_filtered (_("Can't find command '%s' to deprecate.\n"), text);
572 return;
573 }
574
575 if (deprecate)
576 {
577 /* Look for a replacement command. */
578 start_ptr = strchr (text, '\"');
579 if (start_ptr != NULL)
580 {
581 start_ptr++;
582 end_ptr = strrchr (start_ptr, '\"');
583 if (end_ptr != NULL)
584 {
585 len = end_ptr - start_ptr;
586 replacement = savestring (start_ptr, len);
587 }
588 }
589 }
590
591 if (!start_ptr || !end_ptr)
592 replacement = NULL;
593
594
595 /* If they used an alias, we only want to deprecate the alias.
596
597 Note the MALLOCED_REPLACEMENT test. If the command's replacement
598 string was allocated at compile time we don't want to free the
599 memory. */
600 if (alias)
601 {
602 if (alias->malloced_replacement)
603 xfree ((char *) alias->replacement);
604
605 if (deprecate)
606 {
607 alias->deprecated_warn_user = 1;
608 alias->cmd_deprecated = 1;
609 }
610 else
611 {
612 alias->deprecated_warn_user = 0;
613 alias->cmd_deprecated = 0;
614 }
615 alias->replacement = replacement;
616 alias->malloced_replacement = 1;
617 return;
618 }
619 else if (cmd)
620 {
621 if (cmd->malloced_replacement)
622 xfree ((char *) cmd->replacement);
623
624 if (deprecate)
625 {
626 cmd->deprecated_warn_user = 1;
627 cmd->cmd_deprecated = 1;
628 }
629 else
630 {
631 cmd->deprecated_warn_user = 0;
632 cmd->cmd_deprecated = 0;
633 }
634 cmd->replacement = replacement;
635 cmd->malloced_replacement = 1;
636 return;
637 }
638 xfree (replacement);
639 }
640
641 /* Maintenance set/show framework. */
642
643 struct cmd_list_element *maintenance_set_cmdlist;
644 struct cmd_list_element *maintenance_show_cmdlist;
645
646 static void
647 maintenance_set_cmd (char *args, int from_tty)
648 {
649 printf_unfiltered (_("\"maintenance set\" must be followed "
650 "by the name of a set command.\n"));
651 help_list (maintenance_set_cmdlist, "maintenance set ", all_commands,
652 gdb_stdout);
653 }
654
655 static void
656 maintenance_show_cmd (char *args, int from_tty)
657 {
658 cmd_show_list (maintenance_show_cmdlist, from_tty, "");
659 }
660
661 /* Profiling support. */
662
663 static int maintenance_profile_p;
664 static void
665 show_maintenance_profile_p (struct ui_file *file, int from_tty,
666 struct cmd_list_element *c, const char *value)
667 {
668 fprintf_filtered (file, _("Internal profiling is %s.\n"), value);
669 }
670
671 #ifdef HAVE__ETEXT
672 extern char _etext;
673 #define TEXTEND &_etext
674 #elif defined (HAVE_ETEXT)
675 extern char etext;
676 #define TEXTEND &etext
677 #endif
678
679 #if defined (HAVE_MONSTARTUP) && defined (HAVE__MCLEANUP) && defined (TEXTEND)
680
681 static int profiling_state;
682
683 EXTERN_C void _mcleanup (void);
684
685 static void
686 mcleanup_wrapper (void)
687 {
688 if (profiling_state)
689 _mcleanup ();
690 }
691
692 EXTERN_C void monstartup (unsigned long, unsigned long);
693 extern int main ();
694
695 static void
696 maintenance_set_profile_cmd (char *args, int from_tty,
697 struct cmd_list_element *c)
698 {
699 if (maintenance_profile_p == profiling_state)
700 return;
701
702 profiling_state = maintenance_profile_p;
703
704 if (maintenance_profile_p)
705 {
706 static int profiling_initialized;
707
708 if (!profiling_initialized)
709 {
710 atexit (mcleanup_wrapper);
711 profiling_initialized = 1;
712 }
713
714 /* "main" is now always the first function in the text segment, so use
715 its address for monstartup. */
716 monstartup ((unsigned long) &main, (unsigned long) TEXTEND);
717 }
718 else
719 {
720 extern void _mcleanup (void);
721
722 _mcleanup ();
723 }
724 }
725 #else
726 static void
727 maintenance_set_profile_cmd (char *args, int from_tty,
728 struct cmd_list_element *c)
729 {
730 error (_("Profiling support is not available on this system."));
731 }
732 #endif
733 \f
734 /* If nonzero, display time usage both at startup and for each command. */
735
736 static int per_command_time;
737
738 /* If nonzero, display space usage both at startup and for each command. */
739
740 static int per_command_space;
741
742 /* If nonzero, display basic symtab stats for each command. */
743
744 static int per_command_symtab;
745
746 /* mt per-command commands. */
747
748 static struct cmd_list_element *per_command_setlist;
749 static struct cmd_list_element *per_command_showlist;
750
751 /* Set whether to display time statistics to NEW_VALUE
752 (non-zero means true). */
753
754 void
755 set_per_command_time (int new_value)
756 {
757 per_command_time = new_value;
758 }
759
760 /* Set whether to display space statistics to NEW_VALUE
761 (non-zero means true). */
762
763 void
764 set_per_command_space (int new_value)
765 {
766 per_command_space = new_value;
767 }
768
769 /* Count the number of symtabs and blocks. */
770
771 static void
772 count_symtabs_and_blocks (int *nr_symtabs_ptr, int *nr_compunit_symtabs_ptr,
773 int *nr_blocks_ptr)
774 {
775 struct objfile *o;
776 struct compunit_symtab *cu;
777 struct symtab *s;
778 int nr_symtabs = 0;
779 int nr_compunit_symtabs = 0;
780 int nr_blocks = 0;
781
782 /* When collecting statistics during startup, this is called before
783 pretty much anything in gdb has been initialized, and thus
784 current_program_space may be NULL. */
785 if (current_program_space != NULL)
786 {
787 ALL_COMPUNITS (o, cu)
788 {
789 ++nr_compunit_symtabs;
790 nr_blocks += BLOCKVECTOR_NBLOCKS (COMPUNIT_BLOCKVECTOR (cu));
791 ALL_COMPUNIT_FILETABS (cu, s)
792 ++nr_symtabs;
793 }
794 }
795
796 *nr_symtabs_ptr = nr_symtabs;
797 *nr_compunit_symtabs_ptr = nr_compunit_symtabs;
798 *nr_blocks_ptr = nr_blocks;
799 }
800
801 /* As indicated by display_time and display_space, report GDB's
802 elapsed time and space usage from the base time and space recorded
803 in this object. */
804
805 scoped_command_stats::~scoped_command_stats ()
806 {
807 /* Early exit if we're not reporting any stats. It can be expensive to
808 compute the pre-command values so don't collect them at all if we're
809 not reporting stats. Alas this doesn't work in the startup case because
810 we don't know yet whether we will be reporting the stats. For the
811 startup case collect the data anyway (it should be cheap at this point),
812 and leave it to the reporter to decide whether to print them. */
813 if (m_msg_type
814 && !per_command_time
815 && !per_command_space
816 && !per_command_symtab)
817 return;
818
819 if (m_time_enabled && per_command_time)
820 {
821 using namespace std::chrono;
822
823 run_time_clock::duration cmd_time
824 = run_time_clock::now () - m_start_cpu_time;
825
826 steady_clock::duration wall_time
827 = steady_clock::now () - m_start_wall_time;
828 /* Subtract time spend in prompt_for_continue from walltime. */
829 wall_time -= get_prompt_for_continue_wait_time ();
830
831 printf_unfiltered (!m_msg_type
832 ? _("Startup time: %.6f (cpu), %.6f (wall)\n")
833 : _("Command execution time: %.6f (cpu), %.6f (wall)\n"),
834 duration<double> (cmd_time).count (),
835 duration<double> (wall_time).count ());
836 }
837
838 if (m_space_enabled && per_command_space)
839 {
840 #ifdef HAVE_SBRK
841 char *lim = (char *) sbrk (0);
842
843 long space_now = lim - lim_at_start;
844 long space_diff = space_now - m_start_space;
845
846 printf_unfiltered (!m_msg_type
847 ? _("Space used: %ld (%s%ld during startup)\n")
848 : _("Space used: %ld (%s%ld for this command)\n"),
849 space_now,
850 (space_diff >= 0 ? "+" : ""),
851 space_diff);
852 #endif
853 }
854
855 if (m_symtab_enabled && per_command_symtab)
856 {
857 int nr_symtabs, nr_compunit_symtabs, nr_blocks;
858
859 count_symtabs_and_blocks (&nr_symtabs, &nr_compunit_symtabs, &nr_blocks);
860 printf_unfiltered (_("#symtabs: %d (+%d),"
861 " #compunits: %d (+%d),"
862 " #blocks: %d (+%d)\n"),
863 nr_symtabs,
864 nr_symtabs - m_start_nr_symtabs,
865 nr_compunit_symtabs,
866 (nr_compunit_symtabs
867 - m_start_nr_compunit_symtabs),
868 nr_blocks,
869 nr_blocks - m_start_nr_blocks);
870 }
871 }
872
873 scoped_command_stats::scoped_command_stats (bool msg_type)
874 : m_msg_type (msg_type)
875 {
876 if (!m_msg_type || per_command_space)
877 {
878 #ifdef HAVE_SBRK
879 char *lim = (char *) sbrk (0);
880 m_start_space = lim - lim_at_start;
881 m_space_enabled = 1;
882 #endif
883 }
884 else
885 m_space_enabled = 0;
886
887 if (msg_type == 0 || per_command_time)
888 {
889 using namespace std::chrono;
890
891 m_start_cpu_time = run_time_clock::now ();
892 m_start_wall_time = steady_clock::now ();
893 m_time_enabled = 1;
894 }
895 else
896 m_time_enabled = 0;
897
898 if (msg_type == 0 || per_command_symtab)
899 {
900 int nr_symtabs, nr_compunit_symtabs, nr_blocks;
901
902 count_symtabs_and_blocks (&nr_symtabs, &nr_compunit_symtabs, &nr_blocks);
903 m_start_nr_symtabs = nr_symtabs;
904 m_start_nr_compunit_symtabs = nr_compunit_symtabs;
905 m_start_nr_blocks = nr_blocks;
906 m_symtab_enabled = 1;
907 }
908 else
909 m_symtab_enabled = 0;
910
911 /* Initialize timer to keep track of how long we waited for the user. */
912 reset_prompt_for_continue_wait_time ();
913 }
914
915 /* Handle unknown "mt set per-command" arguments.
916 In this case have "mt set per-command on|off" affect every setting. */
917
918 static void
919 set_per_command_cmd (char *args, int from_tty)
920 {
921 struct cmd_list_element *list;
922 int val;
923
924 val = parse_cli_boolean_value (args);
925 if (val < 0)
926 error (_("Bad value for 'mt set per-command no'."));
927
928 for (list = per_command_setlist; list != NULL; list = list->next)
929 if (list->var_type == var_boolean)
930 {
931 gdb_assert (list->type == set_cmd);
932 do_set_command (args, from_tty, list);
933 }
934 }
935
936 /* Command "show per-command" displays summary of all the current
937 "show per-command " settings. */
938
939 static void
940 show_per_command_cmd (char *args, int from_tty)
941 {
942 cmd_show_list (per_command_showlist, from_tty, "");
943 }
944 \f
945
946 /* The "maintenance selftest" command. */
947
948 static void
949 maintenance_selftest (const char *args, int from_tty)
950 {
951 selftests::run_tests (args);
952 }
953
954 static void
955 maintenance_info_selftests (char *arg, int from_tty)
956 {
957 printf_filtered ("Registered selftests:\n");
958 selftests::for_each_selftest ([] (const std::string &name) {
959 printf_filtered (" - %s\n", name.c_str ());
960 });
961 }
962
963 \f
964 void
965 _initialize_maint_cmds (void)
966 {
967 struct cmd_list_element *cmd;
968
969 add_prefix_cmd ("maintenance", class_maintenance, maintenance_command, _("\
970 Commands for use by GDB maintainers.\n\
971 Includes commands to dump specific internal GDB structures in\n\
972 a human readable form, to cause GDB to deliberately dump core, etc."),
973 &maintenancelist, "maintenance ", 0,
974 &cmdlist);
975
976 add_com_alias ("mt", "maintenance", class_maintenance, 1);
977
978 add_prefix_cmd ("info", class_maintenance, maintenance_info_command, _("\
979 Commands for showing internal info about the program being debugged."),
980 &maintenanceinfolist, "maintenance info ", 0,
981 &maintenancelist);
982 add_alias_cmd ("i", "info", class_maintenance, 1, &maintenancelist);
983
984 add_cmd ("sections", class_maintenance, maintenance_info_sections, _("\
985 List the BFD sections of the exec and core files. \n\
986 Arguments may be any combination of:\n\
987 [one or more section names]\n\
988 ALLOC LOAD RELOC READONLY CODE DATA ROM CONSTRUCTOR\n\
989 HAS_CONTENTS NEVER_LOAD COFF_SHARED_LIBRARY IS_COMMON\n\
990 Sections matching any argument will be listed (no argument\n\
991 implies all sections). In addition, the special argument\n\
992 ALLOBJ\n\
993 lists all sections from all object files, including shared libraries."),
994 &maintenanceinfolist);
995
996 add_prefix_cmd ("print", class_maintenance, maintenance_print_command,
997 _("Maintenance command for printing GDB internal state."),
998 &maintenanceprintlist, "maintenance print ", 0,
999 &maintenancelist);
1000
1001 add_prefix_cmd ("set", class_maintenance, maintenance_set_cmd, _("\
1002 Set GDB internal variables used by the GDB maintainer.\n\
1003 Configure variables internal to GDB that aid in GDB's maintenance"),
1004 &maintenance_set_cmdlist, "maintenance set ",
1005 0/*allow-unknown*/,
1006 &maintenancelist);
1007
1008 add_prefix_cmd ("show", class_maintenance, maintenance_show_cmd, _("\
1009 Show GDB internal variables used by the GDB maintainer.\n\
1010 Configure variables internal to GDB that aid in GDB's maintenance"),
1011 &maintenance_show_cmdlist, "maintenance show ",
1012 0/*allow-unknown*/,
1013 &maintenancelist);
1014
1015 #ifndef _WIN32
1016 add_cmd ("dump-me", class_maintenance, maintenance_dump_me, _("\
1017 Get fatal error; make debugger dump its core.\n\
1018 GDB sets its handling of SIGQUIT back to SIG_DFL and then sends\n\
1019 itself a SIGQUIT signal."),
1020 &maintenancelist);
1021 #endif
1022
1023 add_cmd ("internal-error", class_maintenance,
1024 maintenance_internal_error, _("\
1025 Give GDB an internal error.\n\
1026 Cause GDB to behave as if an internal error was detected."),
1027 &maintenancelist);
1028
1029 add_cmd ("internal-warning", class_maintenance,
1030 maintenance_internal_warning, _("\
1031 Give GDB an internal warning.\n\
1032 Cause GDB to behave as if an internal warning was reported."),
1033 &maintenancelist);
1034
1035 add_cmd ("demangler-warning", class_maintenance,
1036 maintenance_demangler_warning, _("\
1037 Give GDB a demangler warning.\n\
1038 Cause GDB to behave as if a demangler warning was reported."),
1039 &maintenancelist);
1040
1041 cmd = add_cmd ("demangle", class_maintenance, maintenance_demangle, _("\
1042 This command has been moved to \"demangle\"."),
1043 &maintenancelist);
1044 deprecate_cmd (cmd, "demangle");
1045
1046 add_prefix_cmd ("per-command", class_maintenance, set_per_command_cmd, _("\
1047 Per-command statistics settings."),
1048 &per_command_setlist, "set per-command ",
1049 1/*allow-unknown*/, &maintenance_set_cmdlist);
1050
1051 add_prefix_cmd ("per-command", class_maintenance, show_per_command_cmd, _("\
1052 Show per-command statistics settings."),
1053 &per_command_showlist, "show per-command ",
1054 0/*allow-unknown*/, &maintenance_show_cmdlist);
1055
1056 add_setshow_boolean_cmd ("time", class_maintenance,
1057 &per_command_time, _("\
1058 Set whether to display per-command execution time."), _("\
1059 Show whether to display per-command execution time."),
1060 _("\
1061 If enabled, the execution time for each command will be\n\
1062 displayed following the command's output."),
1063 NULL, NULL,
1064 &per_command_setlist, &per_command_showlist);
1065
1066 add_setshow_boolean_cmd ("space", class_maintenance,
1067 &per_command_space, _("\
1068 Set whether to display per-command space usage."), _("\
1069 Show whether to display per-command space usage."),
1070 _("\
1071 If enabled, the space usage for each command will be\n\
1072 displayed following the command's output."),
1073 NULL, NULL,
1074 &per_command_setlist, &per_command_showlist);
1075
1076 add_setshow_boolean_cmd ("symtab", class_maintenance,
1077 &per_command_symtab, _("\
1078 Set whether to display per-command symtab statistics."), _("\
1079 Show whether to display per-command symtab statistics."),
1080 _("\
1081 If enabled, the basic symtab statistics for each command will be\n\
1082 displayed following the command's output."),
1083 NULL, NULL,
1084 &per_command_setlist, &per_command_showlist);
1085
1086 /* This is equivalent to "mt set per-command time on".
1087 Kept because some people are used to typing "mt time 1". */
1088 add_cmd ("time", class_maintenance, maintenance_time_display, _("\
1089 Set the display of time usage.\n\
1090 If nonzero, will cause the execution time for each command to be\n\
1091 displayed, following the command's output."),
1092 &maintenancelist);
1093
1094 /* This is equivalent to "mt set per-command space on".
1095 Kept because some people are used to typing "mt space 1". */
1096 add_cmd ("space", class_maintenance, maintenance_space_display, _("\
1097 Set the display of space usage.\n\
1098 If nonzero, will cause the execution space for each command to be\n\
1099 displayed, following the command's output."),
1100 &maintenancelist);
1101
1102 add_cmd ("type", class_maintenance, maintenance_print_type, _("\
1103 Print a type chain for a given symbol.\n\
1104 For each node in a type chain, print the raw data for each member of\n\
1105 the type structure, and the interpretation of the data."),
1106 &maintenanceprintlist);
1107
1108 add_cmd ("statistics", class_maintenance, maintenance_print_statistics,
1109 _("Print statistics about internal gdb state."),
1110 &maintenanceprintlist);
1111
1112 add_cmd ("architecture", class_maintenance,
1113 maintenance_print_architecture, _("\
1114 Print the internal architecture configuration.\n\
1115 Takes an optional file parameter."),
1116 &maintenanceprintlist);
1117
1118 add_prefix_cmd ("check", class_maintenance, maintenance_check_command, _("\
1119 Commands for checking internal gdb state."),
1120 &maintenancechecklist, "maintenance check ", 0,
1121 &maintenancelist);
1122
1123 add_cmd ("translate-address", class_maintenance,
1124 maintenance_translate_address,
1125 _("Translate a section name and address to a symbol."),
1126 &maintenancelist);
1127
1128 add_cmd ("deprecate", class_maintenance, maintenance_deprecate, _("\
1129 Deprecate a command. Note that this is just in here so the \n\
1130 testsuite can check the command deprecator. You probably shouldn't use this,\n\
1131 rather you should use the C function deprecate_cmd(). If you decide you \n\
1132 want to use it: maintenance deprecate 'commandname' \"replacement\". The \n\
1133 replacement is optional."), &maintenancelist);
1134
1135 add_cmd ("undeprecate", class_maintenance, maintenance_undeprecate, _("\
1136 Undeprecate a command. Note that this is just in here so the \n\
1137 testsuite can check the command deprecator. You probably shouldn't use this,\n\
1138 If you decide you want to use it: maintenance undeprecate 'commandname'"),
1139 &maintenancelist);
1140
1141 add_cmd ("selftest", class_maintenance, maintenance_selftest, _("\
1142 Run gdb's unit tests.\n\
1143 Usage: maintenance selftest [filter]\n\
1144 This will run any unit tests that were built in to gdb.\n\
1145 If a filter is given, only the tests with that value in their name will ran."),
1146 &maintenancelist);
1147
1148 add_cmd ("selftests", class_maintenance, maintenance_info_selftests,
1149 _("List the registered selftests."), &maintenanceinfolist);
1150
1151 add_setshow_zinteger_cmd ("watchdog", class_maintenance, &watchdog, _("\
1152 Set watchdog timer."), _("\
1153 Show watchdog timer."), _("\
1154 When non-zero, this timeout is used instead of waiting forever for a target\n\
1155 to finish a low-level step or continue operation. If the specified amount\n\
1156 of time passes without a response from the target, an error occurs."),
1157 NULL,
1158 show_watchdog,
1159 &setlist, &showlist);
1160
1161 add_setshow_boolean_cmd ("profile", class_maintenance,
1162 &maintenance_profile_p, _("\
1163 Set internal profiling."), _("\
1164 Show internal profiling."), _("\
1165 When enabled GDB is profiled."),
1166 maintenance_set_profile_cmd,
1167 show_maintenance_profile_p,
1168 &maintenance_set_cmdlist,
1169 &maintenance_show_cmdlist);
1170 }