1 /* Do various things to symbol tables (other than lookup), for GDB.
3 Copyright (C) 1986-2000, 2002-2004, 2007-2012 Free Software
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 3 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, see <http://www.gnu.org/licenses/>. */
25 #include "filenames.h"
28 #include "breakpoint.h"
30 #include "gdb_obstack.h"
31 #include "exceptions.h"
35 #include "gdb_regex.h"
37 #include "dictionary.h"
39 #include "gdb_string.h"
40 #include "readline/readline.h"
45 #define DEV_TTY "/dev/tty"
48 /* Unfortunately for debugging, stderr is usually a macro. This is painful
49 when calling functions that take FILE *'s from the debugger.
50 So we make a variable which has the same value and which is accessible when
51 debugging GDB with itself. Because stdin et al need not be constants,
52 we initialize them in the _initialize_symmisc function at the bottom
58 /* Prototypes for local functions */
60 static void dump_symtab (struct objfile
*, struct symtab
*,
63 static void dump_msymbols (struct objfile
*, struct ui_file
*);
65 static void dump_objfile (struct objfile
*);
67 static int block_depth (struct block
*);
69 void _initialize_symmisc (void);
71 struct print_symbol_args
73 struct gdbarch
*gdbarch
;
74 struct symbol
*symbol
;
76 struct ui_file
*outfile
;
79 static int print_symbol (void *);
83 print_symbol_bcache_statistics (void)
85 struct program_space
*pspace
;
86 struct objfile
*objfile
;
90 ALL_PSPACE_OBJFILES (pspace
, objfile
)
92 printf_filtered (_("Byte cache statistics for '%s':\n"), objfile
->name
);
93 print_bcache_statistics (psymbol_bcache_get_bcache (objfile
->psymbol_cache
),
94 "partial symbol cache");
95 print_bcache_statistics (objfile
->macro_cache
, "preprocessor macro cache");
96 print_bcache_statistics (objfile
->filename_cache
, "file name cache");
102 print_objfile_statistics (void)
104 struct program_space
*pspace
;
105 struct objfile
*objfile
;
107 int i
, linetables
, blockvectors
;
111 ALL_PSPACE_OBJFILES (pspace
, objfile
)
113 printf_filtered (_("Statistics for '%s':\n"), objfile
->name
);
114 if (OBJSTAT (objfile
, n_stabs
) > 0)
115 printf_filtered (_(" Number of \"stab\" symbols read: %d\n"),
116 OBJSTAT (objfile
, n_stabs
));
117 if (OBJSTAT (objfile
, n_minsyms
) > 0)
118 printf_filtered (_(" Number of \"minimal\" symbols read: %d\n"),
119 OBJSTAT (objfile
, n_minsyms
));
120 if (OBJSTAT (objfile
, n_psyms
) > 0)
121 printf_filtered (_(" Number of \"partial\" symbols read: %d\n"),
122 OBJSTAT (objfile
, n_psyms
));
123 if (OBJSTAT (objfile
, n_syms
) > 0)
124 printf_filtered (_(" Number of \"full\" symbols read: %d\n"),
125 OBJSTAT (objfile
, n_syms
));
126 if (OBJSTAT (objfile
, n_types
) > 0)
127 printf_filtered (_(" Number of \"types\" defined: %d\n"),
128 OBJSTAT (objfile
, n_types
));
130 objfile
->sf
->qf
->print_stats (objfile
);
131 i
= linetables
= blockvectors
= 0;
132 ALL_OBJFILE_SYMTABS (objfile
, s
)
135 if (s
->linetable
!= NULL
)
140 printf_filtered (_(" Number of symbol tables: %d\n"), i
);
141 printf_filtered (_(" Number of symbol tables with line tables: %d\n"),
143 printf_filtered (_(" Number of symbol tables with blockvectors: %d\n"),
146 if (OBJSTAT (objfile
, sz_strtab
) > 0)
147 printf_filtered (_(" Space used by a.out string tables: %d\n"),
148 OBJSTAT (objfile
, sz_strtab
));
149 printf_filtered (_(" Total memory used for objfile obstack: %d\n"),
150 obstack_memory_used (&objfile
->objfile_obstack
));
151 printf_filtered (_(" Total memory used for psymbol cache: %d\n"),
152 bcache_memory_used (psymbol_bcache_get_bcache
153 (objfile
->psymbol_cache
)));
154 printf_filtered (_(" Total memory used for macro cache: %d\n"),
155 bcache_memory_used (objfile
->macro_cache
));
156 printf_filtered (_(" Total memory used for file name cache: %d\n"),
157 bcache_memory_used (objfile
->filename_cache
));
163 dump_objfile (struct objfile
*objfile
)
165 struct symtab
*symtab
;
167 printf_filtered ("\nObject file %s: ", objfile
->name
);
168 printf_filtered ("Objfile at ");
169 gdb_print_host_address (objfile
, gdb_stdout
);
170 printf_filtered (", bfd at ");
171 gdb_print_host_address (objfile
->obfd
, gdb_stdout
);
172 printf_filtered (", %d minsyms\n\n",
173 objfile
->minimal_symbol_count
);
176 objfile
->sf
->qf
->dump (objfile
);
178 if (objfile
->symtabs
)
180 printf_filtered ("Symtabs:\n");
181 for (symtab
= objfile
->symtabs
;
183 symtab
= symtab
->next
)
185 printf_filtered ("%s at ", symtab
->filename
);
186 gdb_print_host_address (symtab
, gdb_stdout
);
187 printf_filtered (", ");
188 if (symtab
->objfile
!= objfile
)
190 printf_filtered ("NOT ON CHAIN! ");
194 printf_filtered ("\n\n");
198 /* Print minimal symbols from this objfile. */
201 dump_msymbols (struct objfile
*objfile
, struct ui_file
*outfile
)
203 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
204 struct minimal_symbol
*msymbol
;
208 fprintf_filtered (outfile
, "\nObject file %s:\n\n", objfile
->name
);
209 if (objfile
->minimal_symbol_count
== 0)
211 fprintf_filtered (outfile
, "No minimal symbols found.\n");
215 ALL_OBJFILE_MSYMBOLS (objfile
, msymbol
)
217 struct obj_section
*section
= SYMBOL_OBJ_SECTION (msymbol
);
219 switch (MSYMBOL_TYPE (msymbol
))
227 case mst_text_gnu_ifunc
:
230 case mst_solib_trampoline
:
255 fprintf_filtered (outfile
, "[%2d] %c ", index
, ms_type
);
256 fputs_filtered (paddress (gdbarch
, SYMBOL_VALUE_ADDRESS (msymbol
)),
258 fprintf_filtered (outfile
, " %s", SYMBOL_LINKAGE_NAME (msymbol
));
260 fprintf_filtered (outfile
, " section %s",
261 bfd_section_name (objfile
->obfd
,
262 section
->the_bfd_section
));
263 if (SYMBOL_DEMANGLED_NAME (msymbol
) != NULL
)
265 fprintf_filtered (outfile
, " %s", SYMBOL_DEMANGLED_NAME (msymbol
));
267 if (msymbol
->filename
)
268 fprintf_filtered (outfile
, " %s", msymbol
->filename
);
269 fputs_filtered ("\n", outfile
);
272 if (objfile
->minimal_symbol_count
!= index
)
274 warning (_("internal error: minimal symbol count %d != %d"),
275 objfile
->minimal_symbol_count
, index
);
277 fprintf_filtered (outfile
, "\n");
281 dump_symtab_1 (struct objfile
*objfile
, struct symtab
*symtab
,
282 struct ui_file
*outfile
)
284 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
286 struct dict_iterator iter
;
289 struct blockvector
*bv
;
294 fprintf_filtered (outfile
, "\nSymtab for file %s\n", symtab
->filename
);
296 fprintf_filtered (outfile
, "Compilation directory is %s\n",
298 fprintf_filtered (outfile
, "Read from object file %s (", objfile
->name
);
299 gdb_print_host_address (objfile
, outfile
);
300 fprintf_filtered (outfile
, ")\n");
301 fprintf_filtered (outfile
, "Language: %s\n",
302 language_str (symtab
->language
));
304 /* First print the line table. */
305 l
= LINETABLE (symtab
);
308 fprintf_filtered (outfile
, "\nLine table:\n\n");
310 for (i
= 0; i
< len
; i
++)
312 fprintf_filtered (outfile
, " line %d at ", l
->item
[i
].line
);
313 fputs_filtered (paddress (gdbarch
, l
->item
[i
].pc
), outfile
);
314 fprintf_filtered (outfile
, "\n");
317 /* Now print the block info, but only for primary symtabs since we will
318 print lots of duplicate info otherwise. */
321 fprintf_filtered (outfile
, "\nBlockvector:\n\n");
322 bv
= BLOCKVECTOR (symtab
);
323 len
= BLOCKVECTOR_NBLOCKS (bv
);
324 for (i
= 0; i
< len
; i
++)
326 b
= BLOCKVECTOR_BLOCK (bv
, i
);
327 depth
= block_depth (b
) * 2;
328 print_spaces (depth
, outfile
);
329 fprintf_filtered (outfile
, "block #%03d, object at ", i
);
330 gdb_print_host_address (b
, outfile
);
331 if (BLOCK_SUPERBLOCK (b
))
333 fprintf_filtered (outfile
, " under ");
334 gdb_print_host_address (BLOCK_SUPERBLOCK (b
), outfile
);
336 /* drow/2002-07-10: We could save the total symbols count
337 even if we're using a hashtable, but nothing else but this message
339 fprintf_filtered (outfile
, ", %d syms/buckets in ",
340 dict_size (BLOCK_DICT (b
)));
341 fputs_filtered (paddress (gdbarch
, BLOCK_START (b
)), outfile
);
342 fprintf_filtered (outfile
, "..");
343 fputs_filtered (paddress (gdbarch
, BLOCK_END (b
)), outfile
);
344 if (BLOCK_FUNCTION (b
))
346 fprintf_filtered (outfile
, ", function %s",
347 SYMBOL_LINKAGE_NAME (BLOCK_FUNCTION (b
)));
348 if (SYMBOL_DEMANGLED_NAME (BLOCK_FUNCTION (b
)) != NULL
)
350 fprintf_filtered (outfile
, ", %s",
351 SYMBOL_DEMANGLED_NAME (BLOCK_FUNCTION (b
)));
354 fprintf_filtered (outfile
, "\n");
355 /* Now print each symbol in this block (in no particular order, if
356 we're using a hashtable). Note that we only want this
357 block, not any blocks from included symtabs. */
358 ALL_DICT_SYMBOLS (BLOCK_DICT (b
), iter
, sym
)
360 struct print_symbol_args s
;
366 catch_errors (print_symbol
, &s
, "Error printing symbol:\n",
370 fprintf_filtered (outfile
, "\n");
374 fprintf_filtered (outfile
, "\nBlockvector same as previous symtab\n\n");
379 dump_symtab (struct objfile
*objfile
, struct symtab
*symtab
,
380 struct ui_file
*outfile
)
382 /* Set the current language to the language of the symtab we're dumping
383 because certain routines used during dump_symtab() use the current
384 language to print an image of the symbol. We'll restore it later.
385 But use only real languages, not placeholders. */
386 if (symtab
->language
!= language_unknown
387 && symtab
->language
!= language_auto
)
389 enum language saved_lang
;
391 saved_lang
= set_language (symtab
->language
);
393 dump_symtab_1 (objfile
, symtab
, outfile
);
395 set_language (saved_lang
);
398 dump_symtab_1 (objfile
, symtab
, outfile
);
402 maintenance_print_symbols (char *args
, int from_tty
)
405 struct ui_file
*outfile
;
406 struct cleanup
*cleanups
;
407 char *symname
= NULL
;
408 char *filename
= DEV_TTY
;
409 struct objfile
*objfile
;
416 error (_("Arguments missing: an output file name "
417 "and an optional symbol file name"));
419 argv
= gdb_buildargv (args
);
420 cleanups
= make_cleanup_freeargv (argv
);
425 /* If a second arg is supplied, it is a source file name to match on. */
432 filename
= tilde_expand (filename
);
433 make_cleanup (xfree
, filename
);
435 outfile
= gdb_fopen (filename
, FOPEN_WT
);
437 perror_with_name (filename
);
438 make_cleanup_ui_file_delete (outfile
);
441 ALL_SYMTABS (objfile
, s
)
442 if (symname
== NULL
|| filename_cmp (symname
, s
->filename
) == 0)
443 dump_symtab (objfile
, s
, outfile
);
445 do_cleanups (cleanups
);
448 /* Print symbol ARGS->SYMBOL on ARGS->OUTFILE. ARGS->DEPTH says how
449 far to indent. ARGS is really a struct print_symbol_args *, but is
450 declared as char * to get it past catch_errors. Returns 0 for error,
454 print_symbol (void *args
)
456 struct gdbarch
*gdbarch
= ((struct print_symbol_args
*) args
)->gdbarch
;
457 struct symbol
*symbol
= ((struct print_symbol_args
*) args
)->symbol
;
458 int depth
= ((struct print_symbol_args
*) args
)->depth
;
459 struct ui_file
*outfile
= ((struct print_symbol_args
*) args
)->outfile
;
460 struct obj_section
*section
= SYMBOL_OBJ_SECTION (symbol
);
462 print_spaces (depth
, outfile
);
463 if (SYMBOL_DOMAIN (symbol
) == LABEL_DOMAIN
)
465 fprintf_filtered (outfile
, "label %s at ", SYMBOL_PRINT_NAME (symbol
));
466 fputs_filtered (paddress (gdbarch
, SYMBOL_VALUE_ADDRESS (symbol
)),
469 fprintf_filtered (outfile
, " section %s\n",
470 bfd_section_name (section
->the_bfd_section
->owner
,
471 section
->the_bfd_section
));
473 fprintf_filtered (outfile
, "\n");
476 if (SYMBOL_DOMAIN (symbol
) == STRUCT_DOMAIN
)
478 if (TYPE_TAG_NAME (SYMBOL_TYPE (symbol
)))
480 LA_PRINT_TYPE (SYMBOL_TYPE (symbol
), "", outfile
, 1, depth
);
484 fprintf_filtered (outfile
, "%s %s = ",
485 (TYPE_CODE (SYMBOL_TYPE (symbol
)) == TYPE_CODE_ENUM
487 : (TYPE_CODE (SYMBOL_TYPE (symbol
)) == TYPE_CODE_STRUCT
488 ? "struct" : "union")),
489 SYMBOL_LINKAGE_NAME (symbol
));
490 LA_PRINT_TYPE (SYMBOL_TYPE (symbol
), "", outfile
, 1, depth
);
492 fprintf_filtered (outfile
, ";\n");
496 if (SYMBOL_CLASS (symbol
) == LOC_TYPEDEF
)
497 fprintf_filtered (outfile
, "typedef ");
498 if (SYMBOL_TYPE (symbol
))
500 /* Print details of types, except for enums where it's clutter. */
501 LA_PRINT_TYPE (SYMBOL_TYPE (symbol
), SYMBOL_PRINT_NAME (symbol
),
503 TYPE_CODE (SYMBOL_TYPE (symbol
)) != TYPE_CODE_ENUM
,
505 fprintf_filtered (outfile
, "; ");
508 fprintf_filtered (outfile
, "%s ", SYMBOL_PRINT_NAME (symbol
));
510 switch (SYMBOL_CLASS (symbol
))
513 fprintf_filtered (outfile
, "const %s (%s)",
514 plongest (SYMBOL_VALUE (symbol
)),
515 hex_string (SYMBOL_VALUE (symbol
)));
518 case LOC_CONST_BYTES
:
521 struct type
*type
= check_typedef (SYMBOL_TYPE (symbol
));
523 fprintf_filtered (outfile
, "const %u hex bytes:",
525 for (i
= 0; i
< TYPE_LENGTH (type
); i
++)
526 fprintf_filtered (outfile
, " %02x",
527 (unsigned) SYMBOL_VALUE_BYTES (symbol
)[i
]);
532 fprintf_filtered (outfile
, "static at ");
533 fputs_filtered (paddress (gdbarch
, SYMBOL_VALUE_ADDRESS (symbol
)),
536 fprintf_filtered (outfile
, " section %s",
537 bfd_section_name (section
->the_bfd_section
->owner
,
538 section
->the_bfd_section
));
542 if (SYMBOL_IS_ARGUMENT (symbol
))
543 fprintf_filtered (outfile
, "parameter register %s",
544 plongest (SYMBOL_VALUE (symbol
)));
546 fprintf_filtered (outfile
, "register %s",
547 plongest (SYMBOL_VALUE (symbol
)));
551 fprintf_filtered (outfile
, "arg at offset %s",
552 hex_string (SYMBOL_VALUE (symbol
)));
556 fprintf_filtered (outfile
, "reference arg at %s",
557 hex_string (SYMBOL_VALUE (symbol
)));
560 case LOC_REGPARM_ADDR
:
561 fprintf_filtered (outfile
, "address parameter register %s",
562 plongest (SYMBOL_VALUE (symbol
)));
566 fprintf_filtered (outfile
, "local at offset %s",
567 hex_string (SYMBOL_VALUE (symbol
)));
574 fprintf_filtered (outfile
, "label at ");
575 fputs_filtered (paddress (gdbarch
, SYMBOL_VALUE_ADDRESS (symbol
)),
578 fprintf_filtered (outfile
, " section %s",
579 bfd_section_name (section
->the_bfd_section
->owner
,
580 section
->the_bfd_section
));
584 fprintf_filtered (outfile
, "block object ");
585 gdb_print_host_address (SYMBOL_BLOCK_VALUE (symbol
), outfile
);
586 fprintf_filtered (outfile
, ", ");
587 fputs_filtered (paddress (gdbarch
,
588 BLOCK_START (SYMBOL_BLOCK_VALUE (symbol
))),
590 fprintf_filtered (outfile
, "..");
591 fputs_filtered (paddress (gdbarch
,
592 BLOCK_END (SYMBOL_BLOCK_VALUE (symbol
))),
595 fprintf_filtered (outfile
, " section %s",
596 bfd_section_name (section
->the_bfd_section
->owner
,
597 section
->the_bfd_section
));
601 fprintf_filtered (outfile
, "computed at runtime");
605 fprintf_filtered (outfile
, "unresolved");
608 case LOC_OPTIMIZED_OUT
:
609 fprintf_filtered (outfile
, "optimized out");
613 fprintf_filtered (outfile
, "botched symbol class %x",
614 SYMBOL_CLASS (symbol
));
618 fprintf_filtered (outfile
, "\n");
623 maintenance_print_msymbols (char *args
, int from_tty
)
626 struct ui_file
*outfile
;
627 struct cleanup
*cleanups
;
628 char *filename
= DEV_TTY
;
629 char *symname
= NULL
;
630 struct program_space
*pspace
;
631 struct objfile
*objfile
;
633 struct stat sym_st
, obj_st
;
639 error (_("print-msymbols takes an output file "
640 "name and optional symbol file name"));
642 argv
= gdb_buildargv (args
);
643 cleanups
= make_cleanup_freeargv (argv
);
648 /* If a second arg is supplied, it is a source file name to match on. */
651 symname
= xfullpath (argv
[1]);
652 make_cleanup (xfree
, symname
);
653 if (symname
&& stat (symname
, &sym_st
))
654 perror_with_name (symname
);
658 filename
= tilde_expand (filename
);
659 make_cleanup (xfree
, filename
);
661 outfile
= gdb_fopen (filename
, FOPEN_WT
);
663 perror_with_name (filename
);
664 make_cleanup_ui_file_delete (outfile
);
668 ALL_PSPACE_OBJFILES (pspace
, objfile
)
669 if (symname
== NULL
|| (!stat (objfile
->name
, &obj_st
)
670 && sym_st
.st_ino
== obj_st
.st_ino
))
671 dump_msymbols (objfile
, outfile
);
673 fprintf_filtered (outfile
, "\n\n");
674 do_cleanups (cleanups
);
678 maintenance_print_objfiles (char *ignore
, int from_tty
)
680 struct program_space
*pspace
;
681 struct objfile
*objfile
;
687 ALL_PSPACE_OBJFILES (pspace
, objfile
)
688 dump_objfile (objfile
);
693 /* List all the symbol tables whose names match REGEXP (optional). */
695 maintenance_info_symtabs (char *regexp
, int from_tty
)
697 struct program_space
*pspace
;
698 struct objfile
*objfile
;
704 ALL_PSPACE_OBJFILES (pspace
, objfile
)
706 struct symtab
*symtab
;
708 /* We don't want to print anything for this objfile until we
709 actually find a symtab whose name matches. */
710 int printed_objfile_start
= 0;
712 ALL_OBJFILE_SYMTABS (objfile
, symtab
)
717 || re_exec (symtab
->filename
))
719 if (! printed_objfile_start
)
721 printf_filtered ("{ objfile %s ", objfile
->name
);
723 printf_filtered ("((struct objfile *) %s)\n",
724 host_address_to_string (objfile
));
725 printed_objfile_start
= 1;
728 printf_filtered (" { symtab %s ", symtab
->filename
);
730 printf_filtered ("((struct symtab *) %s)\n",
731 host_address_to_string (symtab
));
732 printf_filtered (" dirname %s\n",
733 symtab
->dirname
? symtab
->dirname
: "(null)");
734 printf_filtered (" fullname %s\n",
735 symtab
->fullname
? symtab
->fullname
: "(null)");
737 "blockvector ((struct blockvector *) %s)%s\n",
738 host_address_to_string (symtab
->blockvector
),
739 symtab
->primary
? " (primary)" : "");
741 "linetable ((struct linetable *) %s)\n",
742 host_address_to_string (symtab
->linetable
));
743 printf_filtered (" debugformat %s\n",
744 symtab
->debugformat
);
745 printf_filtered (" }\n");
749 if (printed_objfile_start
)
750 printf_filtered ("}\n");
755 /* Return the nexting depth of a block within other blocks in its symtab. */
758 block_depth (struct block
*block
)
762 while ((block
= BLOCK_SUPERBLOCK (block
)) != NULL
)
770 /* Do early runtime initializations. */
772 _initialize_symmisc (void)