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;
89 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");
101 print_objfile_statistics (void)
103 struct program_space *pspace;
104 struct objfile *objfile;
106 int i, linetables, blockvectors;
109 ALL_PSPACE_OBJFILES (pspace, objfile)
112 printf_filtered (_("Statistics for '%s':\n"), objfile->name);
113 if (OBJSTAT (objfile, n_stabs) > 0)
114 printf_filtered (_(" Number of \"stab\" symbols read: %d\n"),
115 OBJSTAT (objfile, n_stabs));
116 if (OBJSTAT (objfile, n_minsyms) > 0)
117 printf_filtered (_(" Number of \"minimal\" symbols read: %d\n"),
118 OBJSTAT (objfile, n_minsyms));
119 if (OBJSTAT (objfile, n_psyms) > 0)
120 printf_filtered (_(" Number of \"partial\" symbols read: %d\n"),
121 OBJSTAT (objfile, n_psyms));
122 if (OBJSTAT (objfile, n_syms) > 0)
123 printf_filtered (_(" Number of \"full\" symbols read: %d\n"),
124 OBJSTAT (objfile, n_syms));
125 if (OBJSTAT (objfile, n_types) > 0)
126 printf_filtered (_(" Number of \"types\" defined: %d\n"),
127 OBJSTAT (objfile, n_types));
129 objfile->sf->qf->print_stats (objfile);
130 i = linetables = blockvectors = 0;
131 ALL_OBJFILE_SYMTABS (objfile, s)
134 if (s->linetable != NULL)
139 printf_filtered (_(" Number of symbol tables: %d\n"), i);
140 printf_filtered (_(" Number of symbol tables with line tables: %d\n"),
142 printf_filtered (_(" Number of symbol tables with blockvectors: %d\n"),
145 if (OBJSTAT (objfile, sz_strtab) > 0)
146 printf_filtered (_(" Space used by a.out string tables: %d\n"),
147 OBJSTAT (objfile, sz_strtab));
148 printf_filtered (_(" Total memory used for objfile obstack: %d\n"),
149 obstack_memory_used (&objfile->objfile_obstack));
150 printf_filtered (_(" Total memory used for psymbol cache: %d\n"),
151 bcache_memory_used (psymbol_bcache_get_bcache
152 (objfile->psymbol_cache)));
153 printf_filtered (_(" Total memory used for macro cache: %d\n"),
154 bcache_memory_used (objfile->macro_cache));
155 printf_filtered (_(" Total memory used for file name cache: %d\n"),
156 bcache_memory_used (objfile->filename_cache));
161 dump_objfile (struct objfile *objfile)
163 struct symtab *symtab;
165 printf_filtered ("\nObject file %s: ", objfile->name);
166 printf_filtered ("Objfile at ");
167 gdb_print_host_address (objfile, gdb_stdout);
168 printf_filtered (", bfd at ");
169 gdb_print_host_address (objfile->obfd, gdb_stdout);
170 printf_filtered (", %d minsyms\n\n",
171 objfile->minimal_symbol_count);
174 objfile->sf->qf->dump (objfile);
176 if (objfile->symtabs)
178 printf_filtered ("Symtabs:\n");
179 for (symtab = objfile->symtabs;
181 symtab = symtab->next)
183 printf_filtered ("%s at ", symtab->filename);
184 gdb_print_host_address (symtab, gdb_stdout);
185 printf_filtered (", ");
186 if (symtab->objfile != objfile)
188 printf_filtered ("NOT ON CHAIN! ");
192 printf_filtered ("\n\n");
196 /* Print minimal symbols from this objfile. */
199 dump_msymbols (struct objfile *objfile, struct ui_file *outfile)
201 struct gdbarch *gdbarch = get_objfile_arch (objfile);
202 struct minimal_symbol *msymbol;
206 fprintf_filtered (outfile, "\nObject file %s:\n\n", objfile->name);
207 if (objfile->minimal_symbol_count == 0)
209 fprintf_filtered (outfile, "No minimal symbols found.\n");
213 ALL_OBJFILE_MSYMBOLS (objfile, msymbol)
215 struct obj_section *section = SYMBOL_OBJ_SECTION (msymbol);
217 switch (MSYMBOL_TYPE (msymbol))
225 case mst_text_gnu_ifunc:
228 case mst_solib_trampoline:
253 fprintf_filtered (outfile, "[%2d] %c ", index, ms_type);
254 fputs_filtered (paddress (gdbarch, SYMBOL_VALUE_ADDRESS (msymbol)),
256 fprintf_filtered (outfile, " %s", SYMBOL_LINKAGE_NAME (msymbol));
258 fprintf_filtered (outfile, " section %s",
259 bfd_section_name (objfile->obfd,
260 section->the_bfd_section));
261 if (SYMBOL_DEMANGLED_NAME (msymbol) != NULL)
263 fprintf_filtered (outfile, " %s", SYMBOL_DEMANGLED_NAME (msymbol));
265 if (msymbol->filename)
266 fprintf_filtered (outfile, " %s", msymbol->filename);
267 fputs_filtered ("\n", outfile);
270 if (objfile->minimal_symbol_count != index)
272 warning (_("internal error: minimal symbol count %d != %d"),
273 objfile->minimal_symbol_count, index);
275 fprintf_filtered (outfile, "\n");
279 dump_symtab_1 (struct objfile *objfile, struct symtab *symtab,
280 struct ui_file *outfile)
282 struct gdbarch *gdbarch = get_objfile_arch (objfile);
284 struct dict_iterator iter;
287 struct blockvector *bv;
292 fprintf_filtered (outfile, "\nSymtab for file %s\n", symtab->filename);
294 fprintf_filtered (outfile, "Compilation directory is %s\n",
296 fprintf_filtered (outfile, "Read from object file %s (", objfile->name);
297 gdb_print_host_address (objfile, outfile);
298 fprintf_filtered (outfile, ")\n");
299 fprintf_filtered (outfile, "Language: %s\n",
300 language_str (symtab->language));
302 /* First print the line table. */
303 l = LINETABLE (symtab);
306 fprintf_filtered (outfile, "\nLine table:\n\n");
308 for (i = 0; i < len; i++)
310 fprintf_filtered (outfile, " line %d at ", l->item[i].line);
311 fputs_filtered (paddress (gdbarch, l->item[i].pc), outfile);
312 fprintf_filtered (outfile, "\n");
315 /* Now print the block info, but only for primary symtabs since we will
316 print lots of duplicate info otherwise. */
319 fprintf_filtered (outfile, "\nBlockvector:\n\n");
320 bv = BLOCKVECTOR (symtab);
321 len = BLOCKVECTOR_NBLOCKS (bv);
322 for (i = 0; i < len; i++)
324 b = BLOCKVECTOR_BLOCK (bv, i);
325 depth = block_depth (b) * 2;
326 print_spaces (depth, outfile);
327 fprintf_filtered (outfile, "block #%03d, object at ", i);
328 gdb_print_host_address (b, outfile);
329 if (BLOCK_SUPERBLOCK (b))
331 fprintf_filtered (outfile, " under ");
332 gdb_print_host_address (BLOCK_SUPERBLOCK (b), outfile);
334 /* drow/2002-07-10: We could save the total symbols count
335 even if we're using a hashtable, but nothing else but this message
337 fprintf_filtered (outfile, ", %d syms/buckets in ",
338 dict_size (BLOCK_DICT (b)));
339 fputs_filtered (paddress (gdbarch, BLOCK_START (b)), outfile);
340 fprintf_filtered (outfile, "..");
341 fputs_filtered (paddress (gdbarch, BLOCK_END (b)), outfile);
342 if (BLOCK_FUNCTION (b))
344 fprintf_filtered (outfile, ", function %s",
345 SYMBOL_LINKAGE_NAME (BLOCK_FUNCTION (b)));
346 if (SYMBOL_DEMANGLED_NAME (BLOCK_FUNCTION (b)) != NULL)
348 fprintf_filtered (outfile, ", %s",
349 SYMBOL_DEMANGLED_NAME (BLOCK_FUNCTION (b)));
352 fprintf_filtered (outfile, "\n");
353 /* Now print each symbol in this block (in no particular order, if
354 we're using a hashtable). Note that we only want this
355 block, not any blocks from included symtabs. */
356 ALL_DICT_SYMBOLS (BLOCK_DICT (b), iter, sym)
358 struct print_symbol_args s;
364 catch_errors (print_symbol, &s, "Error printing symbol:\n",
368 fprintf_filtered (outfile, "\n");
372 fprintf_filtered (outfile, "\nBlockvector same as previous symtab\n\n");
377 dump_symtab (struct objfile *objfile, struct symtab *symtab,
378 struct ui_file *outfile)
380 /* Set the current language to the language of the symtab we're dumping
381 because certain routines used during dump_symtab() use the current
382 language to print an image of the symbol. We'll restore it later.
383 But use only real languages, not placeholders. */
384 if (symtab->language != language_unknown
385 && symtab->language != language_auto)
387 enum language saved_lang;
389 saved_lang = set_language (symtab->language);
391 dump_symtab_1 (objfile, symtab, outfile);
393 set_language (saved_lang);
396 dump_symtab_1 (objfile, symtab, outfile);
400 maintenance_print_symbols (char *args, int from_tty)
403 struct ui_file *outfile;
404 struct cleanup *cleanups;
405 char *symname = NULL;
406 char *filename = DEV_TTY;
407 struct objfile *objfile;
414 error (_("Arguments missing: an output file name "
415 "and an optional symbol file name"));
417 argv = gdb_buildargv (args);
418 cleanups = make_cleanup_freeargv (argv);
423 /* If a second arg is supplied, it is a source file name to match on. */
430 filename = tilde_expand (filename);
431 make_cleanup (xfree, filename);
433 outfile = gdb_fopen (filename, FOPEN_WT);
435 perror_with_name (filename);
436 make_cleanup_ui_file_delete (outfile);
438 ALL_SYMTABS (objfile, s)
441 if (symname == NULL || filename_cmp (symname, s->filename) == 0)
442 dump_symtab (objfile, s, outfile);
444 do_cleanups (cleanups);
447 /* Print symbol ARGS->SYMBOL on ARGS->OUTFILE. ARGS->DEPTH says how
448 far to indent. ARGS is really a struct print_symbol_args *, but is
449 declared as char * to get it past catch_errors. Returns 0 for error,
453 print_symbol (void *args)
455 struct gdbarch *gdbarch = ((struct print_symbol_args *) args)->gdbarch;
456 struct symbol *symbol = ((struct print_symbol_args *) args)->symbol;
457 int depth = ((struct print_symbol_args *) args)->depth;
458 struct ui_file *outfile = ((struct print_symbol_args *) args)->outfile;
459 struct obj_section *section = SYMBOL_OBJ_SECTION (symbol);
461 print_spaces (depth, outfile);
462 if (SYMBOL_DOMAIN (symbol) == LABEL_DOMAIN)
464 fprintf_filtered (outfile, "label %s at ", SYMBOL_PRINT_NAME (symbol));
465 fputs_filtered (paddress (gdbarch, SYMBOL_VALUE_ADDRESS (symbol)),
468 fprintf_filtered (outfile, " section %s\n",
469 bfd_section_name (section->the_bfd_section->owner,
470 section->the_bfd_section));
472 fprintf_filtered (outfile, "\n");
475 if (SYMBOL_DOMAIN (symbol) == STRUCT_DOMAIN)
477 if (TYPE_TAG_NAME (SYMBOL_TYPE (symbol)))
479 LA_PRINT_TYPE (SYMBOL_TYPE (symbol), "", outfile, 1, depth);
483 fprintf_filtered (outfile, "%s %s = ",
484 (TYPE_CODE (SYMBOL_TYPE (symbol)) == TYPE_CODE_ENUM
486 : (TYPE_CODE (SYMBOL_TYPE (symbol)) == TYPE_CODE_STRUCT
487 ? "struct" : "union")),
488 SYMBOL_LINKAGE_NAME (symbol));
489 LA_PRINT_TYPE (SYMBOL_TYPE (symbol), "", outfile, 1, depth);
491 fprintf_filtered (outfile, ";\n");
495 if (SYMBOL_CLASS (symbol) == LOC_TYPEDEF)
496 fprintf_filtered (outfile, "typedef ");
497 if (SYMBOL_TYPE (symbol))
499 /* Print details of types, except for enums where it's clutter. */
500 LA_PRINT_TYPE (SYMBOL_TYPE (symbol), SYMBOL_PRINT_NAME (symbol),
502 TYPE_CODE (SYMBOL_TYPE (symbol)) != TYPE_CODE_ENUM,
504 fprintf_filtered (outfile, "; ");
507 fprintf_filtered (outfile, "%s ", SYMBOL_PRINT_NAME (symbol));
509 switch (SYMBOL_CLASS (symbol))
512 fprintf_filtered (outfile, "const %s (%s)",
513 plongest (SYMBOL_VALUE (symbol)),
514 hex_string (SYMBOL_VALUE (symbol)));
517 case LOC_CONST_BYTES:
520 struct type *type = check_typedef (SYMBOL_TYPE (symbol));
522 fprintf_filtered (outfile, "const %u hex bytes:",
524 for (i = 0; i < TYPE_LENGTH (type); i++)
525 fprintf_filtered (outfile, " %02x",
526 (unsigned) SYMBOL_VALUE_BYTES (symbol)[i]);
531 fprintf_filtered (outfile, "static at ");
532 fputs_filtered (paddress (gdbarch, SYMBOL_VALUE_ADDRESS (symbol)),
535 fprintf_filtered (outfile, " section %s",
536 bfd_section_name (section->the_bfd_section->owner,
537 section->the_bfd_section));
541 if (SYMBOL_IS_ARGUMENT (symbol))
542 fprintf_filtered (outfile, "parameter register %s",
543 plongest (SYMBOL_VALUE (symbol)));
545 fprintf_filtered (outfile, "register %s",
546 plongest (SYMBOL_VALUE (symbol)));
550 fprintf_filtered (outfile, "arg at offset %s",
551 hex_string (SYMBOL_VALUE (symbol)));
555 fprintf_filtered (outfile, "reference arg at %s",
556 hex_string (SYMBOL_VALUE (symbol)));
559 case LOC_REGPARM_ADDR:
560 fprintf_filtered (outfile, "address parameter register %s",
561 plongest (SYMBOL_VALUE (symbol)));
565 fprintf_filtered (outfile, "local at offset %s",
566 hex_string (SYMBOL_VALUE (symbol)));
573 fprintf_filtered (outfile, "label at ");
574 fputs_filtered (paddress (gdbarch, SYMBOL_VALUE_ADDRESS (symbol)),
577 fprintf_filtered (outfile, " section %s",
578 bfd_section_name (section->the_bfd_section->owner,
579 section->the_bfd_section));
583 fprintf_filtered (outfile, "block object ");
584 gdb_print_host_address (SYMBOL_BLOCK_VALUE (symbol), outfile);
585 fprintf_filtered (outfile, ", ");
586 fputs_filtered (paddress (gdbarch,
587 BLOCK_START (SYMBOL_BLOCK_VALUE (symbol))),
589 fprintf_filtered (outfile, "..");
590 fputs_filtered (paddress (gdbarch,
591 BLOCK_END (SYMBOL_BLOCK_VALUE (symbol))),
594 fprintf_filtered (outfile, " section %s",
595 bfd_section_name (section->the_bfd_section->owner,
596 section->the_bfd_section));
600 fprintf_filtered (outfile, "computed at runtime");
604 fprintf_filtered (outfile, "unresolved");
607 case LOC_OPTIMIZED_OUT:
608 fprintf_filtered (outfile, "optimized out");
612 fprintf_filtered (outfile, "botched symbol class %x",
613 SYMBOL_CLASS (symbol));
617 fprintf_filtered (outfile, "\n");
622 maintenance_print_msymbols (char *args, int from_tty)
625 struct ui_file *outfile;
626 struct cleanup *cleanups;
627 char *filename = DEV_TTY;
628 char *symname = NULL;
629 struct program_space *pspace;
630 struct objfile *objfile;
632 struct stat sym_st, obj_st;
638 error (_("print-msymbols takes an output file "
639 "name and optional symbol file name"));
641 argv = gdb_buildargv (args);
642 cleanups = make_cleanup_freeargv (argv);
647 /* If a second arg is supplied, it is a source file name to match on. */
650 symname = xfullpath (argv[1]);
651 make_cleanup (xfree, symname);
652 if (symname && stat (symname, &sym_st))
653 perror_with_name (symname);
657 filename = tilde_expand (filename);
658 make_cleanup (xfree, filename);
660 outfile = gdb_fopen (filename, FOPEN_WT);
662 perror_with_name (filename);
663 make_cleanup_ui_file_delete (outfile);
666 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;
686 ALL_PSPACE_OBJFILES (pspace, objfile)
689 dump_objfile (objfile);
694 /* List all the symbol tables whose names match REGEXP (optional). */
696 maintenance_info_symtabs (char *regexp, int from_tty)
698 struct program_space *pspace;
699 struct objfile *objfile;
705 ALL_PSPACE_OBJFILES (pspace, objfile)
707 struct symtab *symtab;
709 /* We don't want to print anything for this objfile until we
710 actually find a symtab whose name matches. */
711 int printed_objfile_start = 0;
713 ALL_OBJFILE_SYMTABS (objfile, symtab)
718 || re_exec (symtab->filename))
720 if (! printed_objfile_start)
722 printf_filtered ("{ objfile %s ", objfile->name);
724 printf_filtered ("((struct objfile *) %s)\n",
725 host_address_to_string (objfile));
726 printed_objfile_start = 1;
729 printf_filtered (" { symtab %s ", symtab->filename);
731 printf_filtered ("((struct symtab *) %s)\n",
732 host_address_to_string (symtab));
733 printf_filtered (" dirname %s\n",
734 symtab->dirname ? symtab->dirname : "(null)");
735 printf_filtered (" fullname %s\n",
736 symtab->fullname ? symtab->fullname : "(null)");
738 "blockvector ((struct blockvector *) %s)%s\n",
739 host_address_to_string (symtab->blockvector),
740 symtab->primary ? " (primary)" : "");
742 "linetable ((struct linetable *) %s)\n",
743 host_address_to_string (symtab->linetable));
744 printf_filtered (" debugformat %s\n",
745 symtab->debugformat);
746 printf_filtered (" }\n");
750 if (printed_objfile_start)
751 printf_filtered ("}\n");
756 /* Return the nexting depth of a block within other blocks in its symtab. */
759 block_depth (struct block *block)
763 while ((block = BLOCK_SUPERBLOCK (block)) != NULL)
771 /* Do early runtime initializations. */
773 _initialize_symmisc (void)