1 /* Debug logging for the symbol file functions for the GNU debugger, GDB.
3 Copyright (C) 2013-2014 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 to return the name to print for OBJFILE. */
65 debug_objfile_name (const struct objfile *objfile)
67 return lbasename (objfile->original_name);
70 /* Utility return the name to print for SYMTAB. */
73 debug_symtab_name (struct symtab *symtab)
75 return symtab_to_filename_for_display (symtab);
78 /* Debugging version of struct quick_symbol_functions. */
81 debug_qf_has_symbols (struct objfile *objfile)
83 const struct debug_sym_fns_data *debug_data =
84 objfile_data (objfile, symfile_debug_objfile_data_key);
87 retval = debug_data->real_sf->qf->has_symbols (objfile);
89 fprintf_filtered (gdb_stdlog, "qf->has_symbols (%s) = %d\n",
90 debug_objfile_name (objfile), retval);
95 static struct symtab *
96 debug_qf_find_last_source_symtab (struct objfile *objfile)
98 const struct debug_sym_fns_data *debug_data =
99 objfile_data (objfile, symfile_debug_objfile_data_key);
100 struct symtab *retval;
102 fprintf_filtered (gdb_stdlog, "qf->find_last_source_symtab (%s)\n",
103 debug_objfile_name (objfile));
105 retval = debug_data->real_sf->qf->find_last_source_symtab (objfile);
107 fprintf_filtered (gdb_stdlog, "qf->find_last_source_symtab (...) = %s\n",
108 retval ? debug_symtab_name (retval) : "NULL");
114 debug_qf_forget_cached_source_info (struct objfile *objfile)
116 const struct debug_sym_fns_data *debug_data =
117 objfile_data (objfile, symfile_debug_objfile_data_key);
119 fprintf_filtered (gdb_stdlog, "qf->forget_cached_source_info (%s)\n",
120 debug_objfile_name (objfile));
122 debug_data->real_sf->qf->forget_cached_source_info (objfile);
126 debug_qf_map_symtabs_matching_filename (struct objfile *objfile,
128 const char *real_path,
129 int (*callback) (struct symtab *,
133 const struct debug_sym_fns_data *debug_data =
134 objfile_data (objfile, symfile_debug_objfile_data_key);
137 fprintf_filtered (gdb_stdlog,
138 "qf->map_symtabs_matching_filename (%s, \"%s\", \"%s\", %s, %s)\n",
139 debug_objfile_name (objfile), name,
140 real_path ? real_path : NULL,
141 host_address_to_string (callback),
142 host_address_to_string (data));
144 retval = debug_data->real_sf->qf->map_symtabs_matching_filename
145 (objfile, name, real_path, callback, data);
147 fprintf_filtered (gdb_stdlog,
148 "qf->map_symtabs_matching_filename (...) = %d\n",
154 static struct symtab *
155 debug_qf_lookup_symbol (struct objfile *objfile, int kind, const char *name,
158 const struct debug_sym_fns_data *debug_data =
159 objfile_data (objfile, symfile_debug_objfile_data_key);
160 struct symtab *retval;
162 fprintf_filtered (gdb_stdlog,
163 "qf->lookup_symbol (%s, %d, \"%s\", %s)\n",
164 debug_objfile_name (objfile), kind, name,
165 domain_name (domain));
167 retval = debug_data->real_sf->qf->lookup_symbol (objfile, kind, name,
170 fprintf_filtered (gdb_stdlog, "qf->lookup_symbol (...) = %s\n",
171 retval ? debug_symtab_name (retval) : "NULL");
177 debug_qf_print_stats (struct objfile *objfile)
179 const struct debug_sym_fns_data *debug_data =
180 objfile_data (objfile, symfile_debug_objfile_data_key);
182 fprintf_filtered (gdb_stdlog, "qf->print_stats (%s)\n",
183 debug_objfile_name (objfile));
185 debug_data->real_sf->qf->print_stats (objfile);
189 debug_qf_dump (struct objfile *objfile)
191 const struct debug_sym_fns_data *debug_data =
192 objfile_data (objfile, symfile_debug_objfile_data_key);
194 fprintf_filtered (gdb_stdlog, "qf->dump (%s)\n",
195 debug_objfile_name (objfile));
197 debug_data->real_sf->qf->dump (objfile);
201 debug_qf_relocate (struct objfile *objfile,
202 const struct section_offsets *new_offsets,
203 const struct section_offsets *delta)
205 const struct debug_sym_fns_data *debug_data =
206 objfile_data (objfile, symfile_debug_objfile_data_key);
208 fprintf_filtered (gdb_stdlog, "qf->relocate (%s, %s, %s)\n",
209 debug_objfile_name (objfile),
210 host_address_to_string (new_offsets),
211 host_address_to_string (delta));
213 debug_data->real_sf->qf->relocate (objfile, new_offsets, delta);
217 debug_qf_expand_symtabs_for_function (struct objfile *objfile,
218 const char *func_name)
220 const struct debug_sym_fns_data *debug_data =
221 objfile_data (objfile, symfile_debug_objfile_data_key);
223 fprintf_filtered (gdb_stdlog,
224 "qf->expand_symtabs_for_function (%s, \"%s\")\n",
225 debug_objfile_name (objfile), func_name);
227 debug_data->real_sf->qf->expand_symtabs_for_function (objfile, func_name);
231 debug_qf_expand_all_symtabs (struct objfile *objfile)
233 const struct debug_sym_fns_data *debug_data =
234 objfile_data (objfile, symfile_debug_objfile_data_key);
236 fprintf_filtered (gdb_stdlog, "qf->expand_all_symtabs (%s)\n",
237 debug_objfile_name (objfile));
239 debug_data->real_sf->qf->expand_all_symtabs (objfile);
243 debug_qf_expand_symtabs_with_fullname (struct objfile *objfile,
244 const char *fullname)
246 const struct debug_sym_fns_data *debug_data =
247 objfile_data (objfile, symfile_debug_objfile_data_key);
249 fprintf_filtered (gdb_stdlog,
250 "qf->expand_symtabs_with_fullname (%s, \"%s\")\n",
251 debug_objfile_name (objfile), fullname);
253 debug_data->real_sf->qf->expand_symtabs_with_fullname (objfile, fullname);
257 debug_qf_map_matching_symbols (struct objfile *objfile,
258 const char *name, domain_enum namespace,
260 int (*callback) (struct block *,
261 struct symbol *, void *),
263 symbol_compare_ftype *match,
264 symbol_compare_ftype *ordered_compare)
266 const struct debug_sym_fns_data *debug_data =
267 objfile_data (objfile, symfile_debug_objfile_data_key);
269 fprintf_filtered (gdb_stdlog,
270 "qf->map_matching_symbols (%s, \"%s\", %s, %d, %s, %s, %s, %s)\n",
271 debug_objfile_name (objfile), name,
272 domain_name (namespace), global,
273 host_address_to_string (callback),
274 host_address_to_string (data),
275 host_address_to_string (match),
276 host_address_to_string (ordered_compare));
278 debug_data->real_sf->qf->map_matching_symbols (objfile, name,
286 debug_qf_expand_symtabs_matching
287 (struct objfile *objfile,
288 expand_symtabs_file_matcher_ftype *file_matcher,
289 expand_symtabs_symbol_matcher_ftype *symbol_matcher,
290 enum search_domain kind, void *data)
292 const struct debug_sym_fns_data *debug_data =
293 objfile_data (objfile, symfile_debug_objfile_data_key);
295 fprintf_filtered (gdb_stdlog,
296 "qf->expand_symtabs_matching (%s, %s, %s, %s, %s)\n",
297 debug_objfile_name (objfile),
298 host_address_to_string (file_matcher),
299 host_address_to_string (symbol_matcher),
300 search_domain_name (kind),
301 host_address_to_string (data));
303 debug_data->real_sf->qf->expand_symtabs_matching (objfile,
309 static struct symtab *
310 debug_qf_find_pc_sect_symtab (struct objfile *objfile,
311 struct bound_minimal_symbol msymbol,
313 struct obj_section *section,
316 const struct debug_sym_fns_data *debug_data =
317 objfile_data (objfile, symfile_debug_objfile_data_key);
318 struct symtab *retval;
320 fprintf_filtered (gdb_stdlog,
321 "qf->find_pc_sect_symtab (%s, %s, %s, %s, %d)\n",
322 debug_objfile_name (objfile),
323 host_address_to_string (msymbol.minsym),
325 host_address_to_string (section),
328 retval = debug_data->real_sf->qf->find_pc_sect_symtab (objfile, msymbol,
332 fprintf_filtered (gdb_stdlog, "qf->find_pc_sect_symtab (...) = %s\n",
333 retval ? debug_symtab_name (retval) : "NULL");
339 debug_qf_map_symbol_filenames (struct objfile *objfile,
340 symbol_filename_ftype *fun, void *data,
343 const struct debug_sym_fns_data *debug_data =
344 objfile_data (objfile, symfile_debug_objfile_data_key);
345 fprintf_filtered (gdb_stdlog,
346 "qf->map_symbol_filenames (%s, %s, %s, %d)\n",
347 debug_objfile_name (objfile),
348 host_address_to_string (fun),
349 host_address_to_string (data),
352 debug_data->real_sf->qf->map_symbol_filenames (objfile, fun, data,
356 static const struct quick_symbol_functions debug_sym_quick_functions =
358 debug_qf_has_symbols,
359 debug_qf_find_last_source_symtab,
360 debug_qf_forget_cached_source_info,
361 debug_qf_map_symtabs_matching_filename,
362 debug_qf_lookup_symbol,
363 debug_qf_print_stats,
366 debug_qf_expand_symtabs_for_function,
367 debug_qf_expand_all_symtabs,
368 debug_qf_expand_symtabs_with_fullname,
369 debug_qf_map_matching_symbols,
370 debug_qf_expand_symtabs_matching,
371 debug_qf_find_pc_sect_symtab,
372 debug_qf_map_symbol_filenames
375 /* Debugging version of struct sym_probe_fns. */
377 static VEC (probe_p) *
378 debug_sym_get_probes (struct objfile *objfile)
380 const struct debug_sym_fns_data *debug_data =
381 objfile_data (objfile, symfile_debug_objfile_data_key);
382 VEC (probe_p) *retval;
384 retval = debug_data->real_sf->sym_probe_fns->sym_get_probes (objfile);
386 fprintf_filtered (gdb_stdlog,
387 "probes->sym_get_probes (%s) = %s\n",
388 debug_objfile_name (objfile),
389 host_address_to_string (retval));
394 static const struct sym_probe_fns debug_sym_probe_fns =
396 debug_sym_get_probes,
399 /* Debugging version of struct sym_fns. */
402 debug_sym_new_init (struct objfile *objfile)
404 const struct debug_sym_fns_data *debug_data =
405 objfile_data (objfile, symfile_debug_objfile_data_key);
407 fprintf_filtered (gdb_stdlog, "sf->sym_new_init (%s)\n",
408 debug_objfile_name (objfile));
410 debug_data->real_sf->sym_new_init (objfile);
414 debug_sym_init (struct objfile *objfile)
416 const struct debug_sym_fns_data *debug_data =
417 objfile_data (objfile, symfile_debug_objfile_data_key);
419 fprintf_filtered (gdb_stdlog, "sf->sym_init (%s)\n",
420 debug_objfile_name (objfile));
422 debug_data->real_sf->sym_init (objfile);
426 debug_sym_read (struct objfile *objfile, int symfile_flags)
428 const struct debug_sym_fns_data *debug_data =
429 objfile_data (objfile, symfile_debug_objfile_data_key);
431 fprintf_filtered (gdb_stdlog, "sf->sym_read (%s, 0x%x)\n",
432 debug_objfile_name (objfile), symfile_flags);
434 debug_data->real_sf->sym_read (objfile, symfile_flags);
438 debug_sym_read_psymbols (struct objfile *objfile)
440 const struct debug_sym_fns_data *debug_data =
441 objfile_data (objfile, symfile_debug_objfile_data_key);
443 fprintf_filtered (gdb_stdlog, "sf->sym_read_psymbols (%s)\n",
444 debug_objfile_name (objfile));
446 debug_data->real_sf->sym_read_psymbols (objfile);
450 debug_sym_finish (struct objfile *objfile)
452 const struct debug_sym_fns_data *debug_data =
453 objfile_data (objfile, symfile_debug_objfile_data_key);
455 fprintf_filtered (gdb_stdlog, "sf->sym_finish (%s)\n",
456 debug_objfile_name (objfile));
458 debug_data->real_sf->sym_finish (objfile);
462 debug_sym_offsets (struct objfile *objfile,
463 const struct section_addr_info *info)
465 const struct debug_sym_fns_data *debug_data =
466 objfile_data (objfile, symfile_debug_objfile_data_key);
468 fprintf_filtered (gdb_stdlog, "sf->sym_offsets (%s, %s)\n",
469 debug_objfile_name (objfile),
470 host_address_to_string (info));
472 debug_data->real_sf->sym_offsets (objfile, info);
475 static struct symfile_segment_data *
476 debug_sym_segments (bfd *abfd)
478 /* This API function is annoying, it doesn't take a "this" pointer.
479 Fortunately it is only used in one place where we (re-)lookup the
480 sym_fns table to use. Thus we will never be called. */
481 gdb_assert_not_reached ("debug_sym_segments called");
485 debug_sym_read_linetable (struct objfile *objfile)
487 const struct debug_sym_fns_data *debug_data =
488 objfile_data (objfile, symfile_debug_objfile_data_key);
490 fprintf_filtered (gdb_stdlog, "sf->sym_read_linetable (%s)\n",
491 debug_objfile_name (objfile));
493 debug_data->real_sf->sym_read_linetable (objfile);
497 debug_sym_relocate (struct objfile *objfile, asection *sectp, bfd_byte *buf)
499 const struct debug_sym_fns_data *debug_data =
500 objfile_data (objfile, symfile_debug_objfile_data_key);
503 retval = debug_data->real_sf->sym_relocate (objfile, sectp, buf);
505 fprintf_filtered (gdb_stdlog,
506 "sf->sym_relocate (%s, %s, %s) = %s\n",
507 debug_objfile_name (objfile),
508 host_address_to_string (sectp),
509 host_address_to_string (buf),
510 host_address_to_string (retval));
515 /* Template of debugging version of struct sym_fns.
516 A copy is made, with sym_flavour updated, and a pointer to the real table
517 installed in real_sf, and then a pointer to the copy is installed in the
520 static const struct sym_fns debug_sym_fns =
525 debug_sym_read_psymbols,
529 debug_sym_read_linetable,
531 &debug_sym_probe_fns,
532 &debug_sym_quick_functions
535 /* Free the copy of sym_fns recorded in the registry. */
538 symfile_debug_free_objfile (struct objfile *objfile, void *datum)
543 /* Install the debugging versions of the symfile functions for OBJFILE.
544 Do not call this if the debug versions are already installed. */
547 install_symfile_debug_logging (struct objfile *objfile)
549 const struct sym_fns *real_sf;
550 struct debug_sym_fns_data *debug_data;
552 /* The debug versions should not already be installed. */
553 gdb_assert (!symfile_debug_installed (objfile));
555 real_sf = objfile->sf;
557 /* Alas we have to preserve NULL entries in REAL_SF. */
558 debug_data = XCNEW (struct debug_sym_fns_data);
560 #define COPY_SF_PTR(from, to, name, func) \
563 (to)->debug_sf.name = func; \
566 COPY_SF_PTR (real_sf, debug_data, sym_new_init, debug_sym_new_init);
567 COPY_SF_PTR (real_sf, debug_data, sym_init, debug_sym_init);
568 COPY_SF_PTR (real_sf, debug_data, sym_read, debug_sym_read);
569 COPY_SF_PTR (real_sf, debug_data, sym_read_psymbols,
570 debug_sym_read_psymbols);
571 COPY_SF_PTR (real_sf, debug_data, sym_finish, debug_sym_finish);
572 COPY_SF_PTR (real_sf, debug_data, sym_offsets, debug_sym_offsets);
573 COPY_SF_PTR (real_sf, debug_data, sym_segments, debug_sym_segments);
574 COPY_SF_PTR (real_sf, debug_data, sym_read_linetable,
575 debug_sym_read_linetable);
576 COPY_SF_PTR (real_sf, debug_data, sym_relocate, debug_sym_relocate);
577 if (real_sf->sym_probe_fns)
578 debug_data->debug_sf.sym_probe_fns = &debug_sym_probe_fns;
579 debug_data->debug_sf.qf = &debug_sym_quick_functions;
583 debug_data->real_sf = real_sf;
584 set_objfile_data (objfile, symfile_debug_objfile_data_key, debug_data);
585 objfile->sf = &debug_data->debug_sf;
588 /* Uninstall the debugging versions of the symfile functions for OBJFILE.
589 Do not call this if the debug versions are not installed. */
592 uninstall_symfile_debug_logging (struct objfile *objfile)
594 struct debug_sym_fns_data *debug_data;
596 /* The debug versions should be currently installed. */
597 gdb_assert (symfile_debug_installed (objfile));
599 debug_data = objfile_data (objfile, symfile_debug_objfile_data_key);
601 objfile->sf = debug_data->real_sf;
603 set_objfile_data (objfile, symfile_debug_objfile_data_key, NULL);
606 /* Call this function to set OBJFILE->SF.
607 Do not set OBJFILE->SF directly. */
610 objfile_set_sym_fns (struct objfile *objfile, const struct sym_fns *sf)
612 if (symfile_debug_installed (objfile))
614 gdb_assert (debug_symfile);
615 /* Remove the current one, and reinstall a new one later. */
616 uninstall_symfile_debug_logging (objfile);
619 /* Assume debug logging is disabled. */
622 /* Turn debug logging on if enabled. */
624 install_symfile_debug_logging (objfile);
628 set_debug_symfile (char *args, int from_tty, struct cmd_list_element *c)
630 struct program_space *pspace;
631 struct objfile *objfile;
634 ALL_PSPACE_OBJFILES (pspace, objfile)
638 if (!symfile_debug_installed (objfile))
639 install_symfile_debug_logging (objfile);
643 if (symfile_debug_installed (objfile))
644 uninstall_symfile_debug_logging (objfile);
650 show_debug_symfile (struct ui_file *file, int from_tty,
651 struct cmd_list_element *c, const char *value)
653 fprintf_filtered (file, _("Symfile debugging is %s.\n"), value);
656 initialize_file_ftype _initialize_symfile_debug;
659 _initialize_symfile_debug (void)
661 symfile_debug_objfile_data_key
662 = register_objfile_data_with_cleanup (NULL, symfile_debug_free_objfile);
664 add_setshow_boolean_cmd ("symfile", no_class, &debug_symfile, _("\
665 Set debugging of the symfile functions."), _("\
666 Show debugging of the symfile functions."), _("\
667 When enabled, all calls to the symfile functions are logged."),
668 set_debug_symfile, show_debug_symfile,
669 &setdebuglist, &showdebuglist);
671 /* Note: We don't need a new-objfile observer because debug logging
672 will be installed when objfile init'n calls objfile_set_sym_fns. */