1 /* Debug logging for the symbol file functions for the GNU debugger, GDB.
3 Copyright (C) 2013-2015 Free Software Foundation, Inc.
5 Contributed by Cygnus Support, using pieces from other GDB modules.
7 This file is part of GDB.
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.
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.
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/>. */
22 /* Note: Be careful with functions that can throw errors.
23 We want to see a logging message regardless of whether an error was thrown.
24 This typically means printing a message before calling the real function
25 and then if the function returns a result printing a message after it
36 /* We need to save a pointer to the real symbol functions.
37 Plus, the debug versions are malloc'd because we have to NULL out the
38 ones that are NULL in the real copy. */
40 struct debug_sym_fns_data
42 const struct sym_fns *real_sf;
43 struct sym_fns debug_sf;
46 /* We need to record a pointer to the real set of functions for each
48 static const struct objfile_data *symfile_debug_objfile_data_key;
50 /* If non-zero all calls to the symfile functions are logged. */
51 static int debug_symfile = 0;
53 /* Return non-zero if symfile debug logging is installed. */
56 symfile_debug_installed (struct objfile *objfile)
58 return (objfile->sf != NULL
59 && objfile_data (objfile, symfile_debug_objfile_data_key) != NULL);
62 /* Utility return the name to print for SYMTAB. */
65 debug_symtab_name (struct symtab *symtab)
67 return symtab_to_filename_for_display (symtab);
70 /* Debugging version of struct quick_symbol_functions. */
73 debug_qf_has_symbols (struct objfile *objfile)
75 const struct debug_sym_fns_data *debug_data =
76 objfile_data (objfile, symfile_debug_objfile_data_key);
79 retval = debug_data->real_sf->qf->has_symbols (objfile);
81 fprintf_filtered (gdb_stdlog, "qf->has_symbols (%s) = %d\n",
82 objfile_debug_name (objfile), retval);
87 static struct symtab *
88 debug_qf_find_last_source_symtab (struct objfile *objfile)
90 const struct debug_sym_fns_data *debug_data =
91 objfile_data (objfile, symfile_debug_objfile_data_key);
92 struct symtab *retval;
94 fprintf_filtered (gdb_stdlog, "qf->find_last_source_symtab (%s)\n",
95 objfile_debug_name (objfile));
97 retval = debug_data->real_sf->qf->find_last_source_symtab (objfile);
99 fprintf_filtered (gdb_stdlog, "qf->find_last_source_symtab (...) = %s\n",
100 retval ? debug_symtab_name (retval) : "NULL");
106 debug_qf_forget_cached_source_info (struct objfile *objfile)
108 const struct debug_sym_fns_data *debug_data =
109 objfile_data (objfile, symfile_debug_objfile_data_key);
111 fprintf_filtered (gdb_stdlog, "qf->forget_cached_source_info (%s)\n",
112 objfile_debug_name (objfile));
114 debug_data->real_sf->qf->forget_cached_source_info (objfile);
118 debug_qf_map_symtabs_matching_filename (struct objfile *objfile,
120 const char *real_path,
121 int (*callback) (struct symtab *,
125 const struct debug_sym_fns_data *debug_data =
126 objfile_data (objfile, symfile_debug_objfile_data_key);
129 fprintf_filtered (gdb_stdlog,
130 "qf->map_symtabs_matching_filename (%s, \"%s\", \"%s\", %s, %s)\n",
131 objfile_debug_name (objfile), name,
132 real_path ? real_path : NULL,
133 host_address_to_string (callback),
134 host_address_to_string (data));
136 retval = debug_data->real_sf->qf->map_symtabs_matching_filename
137 (objfile, name, real_path, callback, data);
139 fprintf_filtered (gdb_stdlog,
140 "qf->map_symtabs_matching_filename (...) = %d\n",
146 static struct compunit_symtab *
147 debug_qf_lookup_symbol (struct objfile *objfile, int kind, const char *name,
150 const struct debug_sym_fns_data *debug_data =
151 objfile_data (objfile, symfile_debug_objfile_data_key);
152 struct compunit_symtab *retval;
154 fprintf_filtered (gdb_stdlog,
155 "qf->lookup_symbol (%s, %d, \"%s\", %s)\n",
156 objfile_debug_name (objfile), kind, name,
157 domain_name (domain));
159 retval = debug_data->real_sf->qf->lookup_symbol (objfile, kind, name,
162 fprintf_filtered (gdb_stdlog, "qf->lookup_symbol (...) = %s\n",
164 ? debug_symtab_name (compunit_primary_filetab (retval))
171 debug_qf_print_stats (struct objfile *objfile)
173 const struct debug_sym_fns_data *debug_data =
174 objfile_data (objfile, symfile_debug_objfile_data_key);
176 fprintf_filtered (gdb_stdlog, "qf->print_stats (%s)\n",
177 objfile_debug_name (objfile));
179 debug_data->real_sf->qf->print_stats (objfile);
183 debug_qf_dump (struct objfile *objfile)
185 const struct debug_sym_fns_data *debug_data =
186 objfile_data (objfile, symfile_debug_objfile_data_key);
188 fprintf_filtered (gdb_stdlog, "qf->dump (%s)\n",
189 objfile_debug_name (objfile));
191 debug_data->real_sf->qf->dump (objfile);
195 debug_qf_relocate (struct objfile *objfile,
196 const struct section_offsets *new_offsets,
197 const struct section_offsets *delta)
199 const struct debug_sym_fns_data *debug_data =
200 objfile_data (objfile, symfile_debug_objfile_data_key);
202 fprintf_filtered (gdb_stdlog, "qf->relocate (%s, %s, %s)\n",
203 objfile_debug_name (objfile),
204 host_address_to_string (new_offsets),
205 host_address_to_string (delta));
207 debug_data->real_sf->qf->relocate (objfile, new_offsets, delta);
211 debug_qf_expand_symtabs_for_function (struct objfile *objfile,
212 const char *func_name)
214 const struct debug_sym_fns_data *debug_data =
215 objfile_data (objfile, symfile_debug_objfile_data_key);
217 fprintf_filtered (gdb_stdlog,
218 "qf->expand_symtabs_for_function (%s, \"%s\")\n",
219 objfile_debug_name (objfile), func_name);
221 debug_data->real_sf->qf->expand_symtabs_for_function (objfile, func_name);
225 debug_qf_expand_all_symtabs (struct objfile *objfile)
227 const struct debug_sym_fns_data *debug_data =
228 objfile_data (objfile, symfile_debug_objfile_data_key);
230 fprintf_filtered (gdb_stdlog, "qf->expand_all_symtabs (%s)\n",
231 objfile_debug_name (objfile));
233 debug_data->real_sf->qf->expand_all_symtabs (objfile);
237 debug_qf_expand_symtabs_with_fullname (struct objfile *objfile,
238 const char *fullname)
240 const struct debug_sym_fns_data *debug_data =
241 objfile_data (objfile, symfile_debug_objfile_data_key);
243 fprintf_filtered (gdb_stdlog,
244 "qf->expand_symtabs_with_fullname (%s, \"%s\")\n",
245 objfile_debug_name (objfile), fullname);
247 debug_data->real_sf->qf->expand_symtabs_with_fullname (objfile, fullname);
251 debug_qf_map_matching_symbols (struct objfile *objfile,
252 const char *name, domain_enum namespace,
254 int (*callback) (struct block *,
255 struct symbol *, void *),
257 symbol_compare_ftype *match,
258 symbol_compare_ftype *ordered_compare)
260 const struct debug_sym_fns_data *debug_data =
261 objfile_data (objfile, symfile_debug_objfile_data_key);
263 fprintf_filtered (gdb_stdlog,
264 "qf->map_matching_symbols (%s, \"%s\", %s, %d, %s, %s, %s, %s)\n",
265 objfile_debug_name (objfile), name,
266 domain_name (namespace), global,
267 host_address_to_string (callback),
268 host_address_to_string (data),
269 host_address_to_string (match),
270 host_address_to_string (ordered_compare));
272 debug_data->real_sf->qf->map_matching_symbols (objfile, name,
280 debug_qf_expand_symtabs_matching
281 (struct objfile *objfile,
282 expand_symtabs_file_matcher_ftype *file_matcher,
283 expand_symtabs_symbol_matcher_ftype *symbol_matcher,
284 enum search_domain kind, void *data)
286 const struct debug_sym_fns_data *debug_data =
287 objfile_data (objfile, symfile_debug_objfile_data_key);
289 fprintf_filtered (gdb_stdlog,
290 "qf->expand_symtabs_matching (%s, %s, %s, %s, %s)\n",
291 objfile_debug_name (objfile),
292 host_address_to_string (file_matcher),
293 host_address_to_string (symbol_matcher),
294 search_domain_name (kind),
295 host_address_to_string (data));
297 debug_data->real_sf->qf->expand_symtabs_matching (objfile,
303 static struct compunit_symtab *
304 debug_qf_find_pc_sect_compunit_symtab (struct objfile *objfile,
305 struct bound_minimal_symbol msymbol,
307 struct obj_section *section,
310 const struct debug_sym_fns_data *debug_data =
311 objfile_data (objfile, symfile_debug_objfile_data_key);
312 struct compunit_symtab *retval;
314 fprintf_filtered (gdb_stdlog,
315 "qf->find_pc_sect_compunit_symtab (%s, %s, %s, %s, %d)\n",
316 objfile_debug_name (objfile),
317 host_address_to_string (msymbol.minsym),
319 host_address_to_string (section),
323 = debug_data->real_sf->qf->find_pc_sect_compunit_symtab (objfile, msymbol,
327 fprintf_filtered (gdb_stdlog,
328 "qf->find_pc_sect_compunit_symtab (...) = %s\n",
330 ? debug_symtab_name (compunit_primary_filetab (retval))
337 debug_qf_map_symbol_filenames (struct objfile *objfile,
338 symbol_filename_ftype *fun, void *data,
341 const struct debug_sym_fns_data *debug_data =
342 objfile_data (objfile, symfile_debug_objfile_data_key);
343 fprintf_filtered (gdb_stdlog,
344 "qf->map_symbol_filenames (%s, %s, %s, %d)\n",
345 objfile_debug_name (objfile),
346 host_address_to_string (fun),
347 host_address_to_string (data),
350 debug_data->real_sf->qf->map_symbol_filenames (objfile, fun, data,
354 static const struct quick_symbol_functions debug_sym_quick_functions =
356 debug_qf_has_symbols,
357 debug_qf_find_last_source_symtab,
358 debug_qf_forget_cached_source_info,
359 debug_qf_map_symtabs_matching_filename,
360 debug_qf_lookup_symbol,
361 debug_qf_print_stats,
364 debug_qf_expand_symtabs_for_function,
365 debug_qf_expand_all_symtabs,
366 debug_qf_expand_symtabs_with_fullname,
367 debug_qf_map_matching_symbols,
368 debug_qf_expand_symtabs_matching,
369 debug_qf_find_pc_sect_compunit_symtab,
370 debug_qf_map_symbol_filenames
373 /* Debugging version of struct sym_probe_fns. */
375 static VEC (probe_p) *
376 debug_sym_get_probes (struct objfile *objfile)
378 const struct debug_sym_fns_data *debug_data =
379 objfile_data (objfile, symfile_debug_objfile_data_key);
380 VEC (probe_p) *retval;
382 retval = debug_data->real_sf->sym_probe_fns->sym_get_probes (objfile);
384 fprintf_filtered (gdb_stdlog,
385 "probes->sym_get_probes (%s) = %s\n",
386 objfile_debug_name (objfile),
387 host_address_to_string (retval));
392 static const struct sym_probe_fns debug_sym_probe_fns =
394 debug_sym_get_probes,
397 /* Debugging version of struct sym_fns. */
400 debug_sym_new_init (struct objfile *objfile)
402 const struct debug_sym_fns_data *debug_data =
403 objfile_data (objfile, symfile_debug_objfile_data_key);
405 fprintf_filtered (gdb_stdlog, "sf->sym_new_init (%s)\n",
406 objfile_debug_name (objfile));
408 debug_data->real_sf->sym_new_init (objfile);
412 debug_sym_init (struct objfile *objfile)
414 const struct debug_sym_fns_data *debug_data =
415 objfile_data (objfile, symfile_debug_objfile_data_key);
417 fprintf_filtered (gdb_stdlog, "sf->sym_init (%s)\n",
418 objfile_debug_name (objfile));
420 debug_data->real_sf->sym_init (objfile);
424 debug_sym_read (struct objfile *objfile, int symfile_flags)
426 const struct debug_sym_fns_data *debug_data =
427 objfile_data (objfile, symfile_debug_objfile_data_key);
429 fprintf_filtered (gdb_stdlog, "sf->sym_read (%s, 0x%x)\n",
430 objfile_debug_name (objfile), symfile_flags);
432 debug_data->real_sf->sym_read (objfile, symfile_flags);
436 debug_sym_read_psymbols (struct objfile *objfile)
438 const struct debug_sym_fns_data *debug_data =
439 objfile_data (objfile, symfile_debug_objfile_data_key);
441 fprintf_filtered (gdb_stdlog, "sf->sym_read_psymbols (%s)\n",
442 objfile_debug_name (objfile));
444 debug_data->real_sf->sym_read_psymbols (objfile);
448 debug_sym_finish (struct objfile *objfile)
450 const struct debug_sym_fns_data *debug_data =
451 objfile_data (objfile, symfile_debug_objfile_data_key);
453 fprintf_filtered (gdb_stdlog, "sf->sym_finish (%s)\n",
454 objfile_debug_name (objfile));
456 debug_data->real_sf->sym_finish (objfile);
460 debug_sym_offsets (struct objfile *objfile,
461 const struct section_addr_info *info)
463 const struct debug_sym_fns_data *debug_data =
464 objfile_data (objfile, symfile_debug_objfile_data_key);
466 fprintf_filtered (gdb_stdlog, "sf->sym_offsets (%s, %s)\n",
467 objfile_debug_name (objfile),
468 host_address_to_string (info));
470 debug_data->real_sf->sym_offsets (objfile, info);
473 static struct symfile_segment_data *
474 debug_sym_segments (bfd *abfd)
476 /* This API function is annoying, it doesn't take a "this" pointer.
477 Fortunately it is only used in one place where we (re-)lookup the
478 sym_fns table to use. Thus we will never be called. */
479 gdb_assert_not_reached ("debug_sym_segments called");
483 debug_sym_read_linetable (struct objfile *objfile)
485 const struct debug_sym_fns_data *debug_data =
486 objfile_data (objfile, symfile_debug_objfile_data_key);
488 fprintf_filtered (gdb_stdlog, "sf->sym_read_linetable (%s)\n",
489 objfile_debug_name (objfile));
491 debug_data->real_sf->sym_read_linetable (objfile);
495 debug_sym_relocate (struct objfile *objfile, asection *sectp, bfd_byte *buf)
497 const struct debug_sym_fns_data *debug_data =
498 objfile_data (objfile, symfile_debug_objfile_data_key);
501 retval = debug_data->real_sf->sym_relocate (objfile, sectp, buf);
503 fprintf_filtered (gdb_stdlog,
504 "sf->sym_relocate (%s, %s, %s) = %s\n",
505 objfile_debug_name (objfile),
506 host_address_to_string (sectp),
507 host_address_to_string (buf),
508 host_address_to_string (retval));
513 /* Template of debugging version of struct sym_fns.
514 A copy is made, with sym_flavour updated, and a pointer to the real table
515 installed in real_sf, and then a pointer to the copy is installed in the
518 static const struct sym_fns debug_sym_fns =
523 debug_sym_read_psymbols,
527 debug_sym_read_linetable,
529 &debug_sym_probe_fns,
530 &debug_sym_quick_functions
533 /* Free the copy of sym_fns recorded in the registry. */
536 symfile_debug_free_objfile (struct objfile *objfile, void *datum)
541 /* Install the debugging versions of the symfile functions for OBJFILE.
542 Do not call this if the debug versions are already installed. */
545 install_symfile_debug_logging (struct objfile *objfile)
547 const struct sym_fns *real_sf;
548 struct debug_sym_fns_data *debug_data;
550 /* The debug versions should not already be installed. */
551 gdb_assert (!symfile_debug_installed (objfile));
553 real_sf = objfile->sf;
555 /* Alas we have to preserve NULL entries in REAL_SF. */
556 debug_data = XCNEW (struct debug_sym_fns_data);
558 #define COPY_SF_PTR(from, to, name, func) \
561 (to)->debug_sf.name = func; \
564 COPY_SF_PTR (real_sf, debug_data, sym_new_init, debug_sym_new_init);
565 COPY_SF_PTR (real_sf, debug_data, sym_init, debug_sym_init);
566 COPY_SF_PTR (real_sf, debug_data, sym_read, debug_sym_read);
567 COPY_SF_PTR (real_sf, debug_data, sym_read_psymbols,
568 debug_sym_read_psymbols);
569 COPY_SF_PTR (real_sf, debug_data, sym_finish, debug_sym_finish);
570 COPY_SF_PTR (real_sf, debug_data, sym_offsets, debug_sym_offsets);
571 COPY_SF_PTR (real_sf, debug_data, sym_segments, debug_sym_segments);
572 COPY_SF_PTR (real_sf, debug_data, sym_read_linetable,
573 debug_sym_read_linetable);
574 COPY_SF_PTR (real_sf, debug_data, sym_relocate, debug_sym_relocate);
575 if (real_sf->sym_probe_fns)
576 debug_data->debug_sf.sym_probe_fns = &debug_sym_probe_fns;
577 debug_data->debug_sf.qf = &debug_sym_quick_functions;
581 debug_data->real_sf = real_sf;
582 set_objfile_data (objfile, symfile_debug_objfile_data_key, debug_data);
583 objfile->sf = &debug_data->debug_sf;
586 /* Uninstall the debugging versions of the symfile functions for OBJFILE.
587 Do not call this if the debug versions are not installed. */
590 uninstall_symfile_debug_logging (struct objfile *objfile)
592 struct debug_sym_fns_data *debug_data;
594 /* The debug versions should be currently installed. */
595 gdb_assert (symfile_debug_installed (objfile));
597 debug_data = objfile_data (objfile, symfile_debug_objfile_data_key);
599 objfile->sf = debug_data->real_sf;
601 set_objfile_data (objfile, symfile_debug_objfile_data_key, NULL);
604 /* Call this function to set OBJFILE->SF.
605 Do not set OBJFILE->SF directly. */
608 objfile_set_sym_fns (struct objfile *objfile, const struct sym_fns *sf)
610 if (symfile_debug_installed (objfile))
612 gdb_assert (debug_symfile);
613 /* Remove the current one, and reinstall a new one later. */
614 uninstall_symfile_debug_logging (objfile);
617 /* Assume debug logging is disabled. */
620 /* Turn debug logging on if enabled. */
622 install_symfile_debug_logging (objfile);
626 set_debug_symfile (char *args, int from_tty, struct cmd_list_element *c)
628 struct program_space *pspace;
629 struct objfile *objfile;
632 ALL_PSPACE_OBJFILES (pspace, objfile)
636 if (!symfile_debug_installed (objfile))
637 install_symfile_debug_logging (objfile);
641 if (symfile_debug_installed (objfile))
642 uninstall_symfile_debug_logging (objfile);
648 show_debug_symfile (struct ui_file *file, int from_tty,
649 struct cmd_list_element *c, const char *value)
651 fprintf_filtered (file, _("Symfile debugging is %s.\n"), value);
654 initialize_file_ftype _initialize_symfile_debug;
657 _initialize_symfile_debug (void)
659 symfile_debug_objfile_data_key
660 = register_objfile_data_with_cleanup (NULL, symfile_debug_free_objfile);
662 add_setshow_boolean_cmd ("symfile", no_class, &debug_symfile, _("\
663 Set debugging of the symfile functions."), _("\
664 Show debugging of the symfile functions."), _("\
665 When enabled, all calls to the symfile functions are logged."),
666 set_debug_symfile, show_debug_symfile,
667 &setdebuglist, &showdebuglist);
669 /* Note: We don't need a new-objfile observer because debug logging
670 will be installed when objfile init'n calls objfile_set_sym_fns. */