1 /* Debug logging for the symbol file functions for the GNU debugger, GDB.
3 Copyright (C) 2013-2019 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
31 #include "observable.h"
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 = ((const struct debug_sym_fns_data *)
77 objfile_data (objfile, symfile_debug_objfile_data_key));
80 retval = debug_data->real_sf->qf->has_symbols (objfile);
82 fprintf_filtered (gdb_stdlog, "qf->has_symbols (%s) = %d\n",
83 objfile_debug_name (objfile), retval);
88 static struct symtab *
89 debug_qf_find_last_source_symtab (struct objfile *objfile)
91 const struct debug_sym_fns_data *debug_data
92 = ((const struct debug_sym_fns_data *)
93 objfile_data (objfile, symfile_debug_objfile_data_key));
94 struct symtab *retval;
96 fprintf_filtered (gdb_stdlog, "qf->find_last_source_symtab (%s)\n",
97 objfile_debug_name (objfile));
99 retval = debug_data->real_sf->qf->find_last_source_symtab (objfile);
101 fprintf_filtered (gdb_stdlog, "qf->find_last_source_symtab (...) = %s\n",
102 retval ? debug_symtab_name (retval) : "NULL");
108 debug_qf_forget_cached_source_info (struct objfile *objfile)
110 const struct debug_sym_fns_data *debug_data
111 = ((const struct debug_sym_fns_data *)
112 objfile_data (objfile, symfile_debug_objfile_data_key));
114 fprintf_filtered (gdb_stdlog, "qf->forget_cached_source_info (%s)\n",
115 objfile_debug_name (objfile));
117 debug_data->real_sf->qf->forget_cached_source_info (objfile);
121 debug_qf_map_symtabs_matching_filename
122 (struct objfile *objfile, const char *name, const char *real_path,
123 gdb::function_view<bool (symtab *)> callback)
125 const struct debug_sym_fns_data *debug_data
126 = ((const struct debug_sym_fns_data *)
127 objfile_data (objfile, symfile_debug_objfile_data_key));
129 fprintf_filtered (gdb_stdlog,
130 "qf->map_symtabs_matching_filename (%s, \"%s\", \"%s\", %s)\n",
131 objfile_debug_name (objfile), name,
132 real_path ? real_path : NULL,
133 host_address_to_string (&callback));
135 bool retval = (debug_data->real_sf->qf->map_symtabs_matching_filename
136 (objfile, name, real_path, callback));
138 fprintf_filtered (gdb_stdlog,
139 "qf->map_symtabs_matching_filename (...) = %d\n",
145 static struct compunit_symtab *
146 debug_qf_lookup_symbol (struct objfile *objfile, int kind, const char *name,
149 const struct debug_sym_fns_data *debug_data
150 = ((const struct debug_sym_fns_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 = ((const struct debug_sym_fns_data *)
175 objfile_data (objfile, symfile_debug_objfile_data_key));
177 fprintf_filtered (gdb_stdlog, "qf->print_stats (%s)\n",
178 objfile_debug_name (objfile));
180 debug_data->real_sf->qf->print_stats (objfile);
184 debug_qf_dump (struct objfile *objfile)
186 const struct debug_sym_fns_data *debug_data
187 = ((const struct debug_sym_fns_data *)
188 objfile_data (objfile, symfile_debug_objfile_data_key));
190 fprintf_filtered (gdb_stdlog, "qf->dump (%s)\n",
191 objfile_debug_name (objfile));
193 debug_data->real_sf->qf->dump (objfile);
197 debug_qf_expand_symtabs_for_function (struct objfile *objfile,
198 const char *func_name)
200 const struct debug_sym_fns_data *debug_data
201 = ((const struct debug_sym_fns_data *)
202 objfile_data (objfile, symfile_debug_objfile_data_key));
204 fprintf_filtered (gdb_stdlog,
205 "qf->expand_symtabs_for_function (%s, \"%s\")\n",
206 objfile_debug_name (objfile), func_name);
208 debug_data->real_sf->qf->expand_symtabs_for_function (objfile, func_name);
212 debug_qf_expand_all_symtabs (struct objfile *objfile)
214 const struct debug_sym_fns_data *debug_data
215 = ((const struct debug_sym_fns_data *)
216 objfile_data (objfile, symfile_debug_objfile_data_key));
218 fprintf_filtered (gdb_stdlog, "qf->expand_all_symtabs (%s)\n",
219 objfile_debug_name (objfile));
221 debug_data->real_sf->qf->expand_all_symtabs (objfile);
225 debug_qf_expand_symtabs_with_fullname (struct objfile *objfile,
226 const char *fullname)
228 const struct debug_sym_fns_data *debug_data
229 = ((const struct debug_sym_fns_data *)
230 objfile_data (objfile, symfile_debug_objfile_data_key));
232 fprintf_filtered (gdb_stdlog,
233 "qf->expand_symtabs_with_fullname (%s, \"%s\")\n",
234 objfile_debug_name (objfile), fullname);
236 debug_data->real_sf->qf->expand_symtabs_with_fullname (objfile, fullname);
240 debug_qf_map_matching_symbols (struct objfile *objfile,
241 const char *name, domain_enum domain,
243 int (*callback) (struct block *,
244 struct symbol *, void *),
246 symbol_name_match_type match,
247 symbol_compare_ftype *ordered_compare)
249 const struct debug_sym_fns_data *debug_data
250 = ((const struct debug_sym_fns_data *)
251 objfile_data (objfile, symfile_debug_objfile_data_key));
253 fprintf_filtered (gdb_stdlog,
254 "qf->map_matching_symbols (%s, \"%s\", %s, %d, %s, %s, %s, %s)\n",
255 objfile_debug_name (objfile), name,
256 domain_name (domain), global,
257 host_address_to_string (callback),
258 host_address_to_string (data),
259 plongest ((LONGEST) match),
260 host_address_to_string (ordered_compare));
262 debug_data->real_sf->qf->map_matching_symbols (objfile, name,
270 debug_qf_expand_symtabs_matching
271 (struct objfile *objfile,
272 gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
273 const lookup_name_info &lookup_name,
274 gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
275 gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
276 enum search_domain kind)
278 const struct debug_sym_fns_data *debug_data
279 = ((const struct debug_sym_fns_data *)
280 objfile_data (objfile, symfile_debug_objfile_data_key));
282 fprintf_filtered (gdb_stdlog,
283 "qf->expand_symtabs_matching (%s, %s, %s, %s, %s)\n",
284 objfile_debug_name (objfile),
285 host_address_to_string (&file_matcher),
286 host_address_to_string (&symbol_matcher),
287 host_address_to_string (&expansion_notify),
288 search_domain_name (kind));
290 debug_data->real_sf->qf->expand_symtabs_matching (objfile,
298 static struct compunit_symtab *
299 debug_qf_find_pc_sect_compunit_symtab (struct objfile *objfile,
300 struct bound_minimal_symbol msymbol,
302 struct obj_section *section,
305 const struct debug_sym_fns_data *debug_data
306 = ((const struct debug_sym_fns_data *)
307 objfile_data (objfile, symfile_debug_objfile_data_key));
308 struct compunit_symtab *retval;
310 fprintf_filtered (gdb_stdlog,
311 "qf->find_pc_sect_compunit_symtab (%s, %s, %s, %s, %d)\n",
312 objfile_debug_name (objfile),
313 host_address_to_string (msymbol.minsym),
315 host_address_to_string (section),
319 = debug_data->real_sf->qf->find_pc_sect_compunit_symtab (objfile, msymbol,
323 fprintf_filtered (gdb_stdlog,
324 "qf->find_pc_sect_compunit_symtab (...) = %s\n",
326 ? debug_symtab_name (compunit_primary_filetab (retval))
333 debug_qf_map_symbol_filenames (struct objfile *objfile,
334 symbol_filename_ftype *fun, void *data,
337 const struct debug_sym_fns_data *debug_data
338 = ((const struct debug_sym_fns_data *)
339 objfile_data (objfile, symfile_debug_objfile_data_key));
340 fprintf_filtered (gdb_stdlog,
341 "qf->map_symbol_filenames (%s, %s, %s, %d)\n",
342 objfile_debug_name (objfile),
343 host_address_to_string (fun),
344 host_address_to_string (data),
347 debug_data->real_sf->qf->map_symbol_filenames (objfile, fun, data,
351 static struct compunit_symtab *
352 debug_qf_find_compunit_symtab_by_address (struct objfile *objfile,
355 const struct debug_sym_fns_data *debug_data
356 = ((const struct debug_sym_fns_data *)
357 objfile_data (objfile, symfile_debug_objfile_data_key));
358 fprintf_filtered (gdb_stdlog,
359 "qf->find_compunit_symtab_by_address (%s, %s)\n",
360 objfile_debug_name (objfile),
361 hex_string (address));
363 struct compunit_symtab *result = NULL;
364 if (debug_data->real_sf->qf->map_symbol_filenames != NULL)
366 = debug_data->real_sf->qf->find_compunit_symtab_by_address (objfile,
369 fprintf_filtered (gdb_stdlog,
370 "qf->find_compunit_symtab_by_address (...) = %s\n",
372 ? debug_symtab_name (compunit_primary_filetab (result))
378 static const struct quick_symbol_functions debug_sym_quick_functions =
380 debug_qf_has_symbols,
381 debug_qf_find_last_source_symtab,
382 debug_qf_forget_cached_source_info,
383 debug_qf_map_symtabs_matching_filename,
384 debug_qf_lookup_symbol,
385 debug_qf_print_stats,
387 debug_qf_expand_symtabs_for_function,
388 debug_qf_expand_all_symtabs,
389 debug_qf_expand_symtabs_with_fullname,
390 debug_qf_map_matching_symbols,
391 debug_qf_expand_symtabs_matching,
392 debug_qf_find_pc_sect_compunit_symtab,
393 debug_qf_find_compunit_symtab_by_address,
394 debug_qf_map_symbol_filenames
397 /* Debugging version of struct sym_probe_fns. */
399 static const std::vector<probe *> &
400 debug_sym_get_probes (struct objfile *objfile)
402 const struct debug_sym_fns_data *debug_data
403 = ((const struct debug_sym_fns_data *)
404 objfile_data (objfile, symfile_debug_objfile_data_key));
406 const std::vector<probe *> &retval
407 = debug_data->real_sf->sym_probe_fns->sym_get_probes (objfile);
409 fprintf_filtered (gdb_stdlog,
410 "probes->sym_get_probes (%s) = %s\n",
411 objfile_debug_name (objfile),
412 host_address_to_string (retval.data ()));
417 static const struct sym_probe_fns debug_sym_probe_fns =
419 debug_sym_get_probes,
422 /* Debugging version of struct sym_fns. */
425 debug_sym_new_init (struct objfile *objfile)
427 const struct debug_sym_fns_data *debug_data
428 = ((const struct debug_sym_fns_data *)
429 objfile_data (objfile, symfile_debug_objfile_data_key));
431 fprintf_filtered (gdb_stdlog, "sf->sym_new_init (%s)\n",
432 objfile_debug_name (objfile));
434 debug_data->real_sf->sym_new_init (objfile);
438 debug_sym_init (struct objfile *objfile)
440 const struct debug_sym_fns_data *debug_data
441 = ((const struct debug_sym_fns_data *)
442 objfile_data (objfile, symfile_debug_objfile_data_key));
444 fprintf_filtered (gdb_stdlog, "sf->sym_init (%s)\n",
445 objfile_debug_name (objfile));
447 debug_data->real_sf->sym_init (objfile);
451 debug_sym_read (struct objfile *objfile, symfile_add_flags symfile_flags)
453 const struct debug_sym_fns_data *debug_data
454 = ((const struct debug_sym_fns_data *)
455 objfile_data (objfile, symfile_debug_objfile_data_key));
457 fprintf_filtered (gdb_stdlog, "sf->sym_read (%s, 0x%x)\n",
458 objfile_debug_name (objfile), (unsigned) symfile_flags);
460 debug_data->real_sf->sym_read (objfile, symfile_flags);
464 debug_sym_read_psymbols (struct objfile *objfile)
466 const struct debug_sym_fns_data *debug_data
467 = ((const struct debug_sym_fns_data *)
468 objfile_data (objfile, symfile_debug_objfile_data_key));
470 fprintf_filtered (gdb_stdlog, "sf->sym_read_psymbols (%s)\n",
471 objfile_debug_name (objfile));
473 debug_data->real_sf->sym_read_psymbols (objfile);
477 debug_sym_finish (struct objfile *objfile)
479 const struct debug_sym_fns_data *debug_data
480 = ((const struct debug_sym_fns_data *)
481 objfile_data (objfile, symfile_debug_objfile_data_key));
483 fprintf_filtered (gdb_stdlog, "sf->sym_finish (%s)\n",
484 objfile_debug_name (objfile));
486 debug_data->real_sf->sym_finish (objfile);
490 debug_sym_offsets (struct objfile *objfile,
491 const section_addr_info &info)
493 const struct debug_sym_fns_data *debug_data
494 = ((const struct debug_sym_fns_data *)
495 objfile_data (objfile, symfile_debug_objfile_data_key));
497 fprintf_filtered (gdb_stdlog, "sf->sym_offsets (%s, %s)\n",
498 objfile_debug_name (objfile),
499 host_address_to_string (&info));
501 debug_data->real_sf->sym_offsets (objfile, info);
504 static struct symfile_segment_data *
505 debug_sym_segments (bfd *abfd)
507 /* This API function is annoying, it doesn't take a "this" pointer.
508 Fortunately it is only used in one place where we (re-)lookup the
509 sym_fns table to use. Thus we will never be called. */
510 gdb_assert_not_reached ("debug_sym_segments called");
514 debug_sym_read_linetable (struct objfile *objfile)
516 const struct debug_sym_fns_data *debug_data
517 = ((const struct debug_sym_fns_data *)
518 objfile_data (objfile, symfile_debug_objfile_data_key));
520 fprintf_filtered (gdb_stdlog, "sf->sym_read_linetable (%s)\n",
521 objfile_debug_name (objfile));
523 debug_data->real_sf->sym_read_linetable (objfile);
527 debug_sym_relocate (struct objfile *objfile, asection *sectp, bfd_byte *buf)
529 const struct debug_sym_fns_data *debug_data
530 = ((const struct debug_sym_fns_data *)
531 objfile_data (objfile, symfile_debug_objfile_data_key));
534 retval = debug_data->real_sf->sym_relocate (objfile, sectp, buf);
536 fprintf_filtered (gdb_stdlog,
537 "sf->sym_relocate (%s, %s, %s) = %s\n",
538 objfile_debug_name (objfile),
539 host_address_to_string (sectp),
540 host_address_to_string (buf),
541 host_address_to_string (retval));
546 /* Template of debugging version of struct sym_fns.
547 A copy is made, with sym_flavour updated, and a pointer to the real table
548 installed in real_sf, and then a pointer to the copy is installed in the
551 static const struct sym_fns debug_sym_fns =
556 debug_sym_read_psymbols,
560 debug_sym_read_linetable,
562 &debug_sym_probe_fns,
563 &debug_sym_quick_functions
566 /* Free the copy of sym_fns recorded in the registry. */
569 symfile_debug_free_objfile (struct objfile *objfile, void *datum)
574 /* Install the debugging versions of the symfile functions for OBJFILE.
575 Do not call this if the debug versions are already installed. */
578 install_symfile_debug_logging (struct objfile *objfile)
580 const struct sym_fns *real_sf;
581 struct debug_sym_fns_data *debug_data;
583 /* The debug versions should not already be installed. */
584 gdb_assert (!symfile_debug_installed (objfile));
586 real_sf = objfile->sf;
588 /* Alas we have to preserve NULL entries in REAL_SF. */
589 debug_data = XCNEW (struct debug_sym_fns_data);
591 #define COPY_SF_PTR(from, to, name, func) \
594 (to)->debug_sf.name = func; \
597 COPY_SF_PTR (real_sf, debug_data, sym_new_init, debug_sym_new_init);
598 COPY_SF_PTR (real_sf, debug_data, sym_init, debug_sym_init);
599 COPY_SF_PTR (real_sf, debug_data, sym_read, debug_sym_read);
600 COPY_SF_PTR (real_sf, debug_data, sym_read_psymbols,
601 debug_sym_read_psymbols);
602 COPY_SF_PTR (real_sf, debug_data, sym_finish, debug_sym_finish);
603 COPY_SF_PTR (real_sf, debug_data, sym_offsets, debug_sym_offsets);
604 COPY_SF_PTR (real_sf, debug_data, sym_segments, debug_sym_segments);
605 COPY_SF_PTR (real_sf, debug_data, sym_read_linetable,
606 debug_sym_read_linetable);
607 COPY_SF_PTR (real_sf, debug_data, sym_relocate, debug_sym_relocate);
608 if (real_sf->sym_probe_fns)
609 debug_data->debug_sf.sym_probe_fns = &debug_sym_probe_fns;
610 debug_data->debug_sf.qf = &debug_sym_quick_functions;
614 debug_data->real_sf = real_sf;
615 set_objfile_data (objfile, symfile_debug_objfile_data_key, debug_data);
616 objfile->sf = &debug_data->debug_sf;
619 /* Uninstall the debugging versions of the symfile functions for OBJFILE.
620 Do not call this if the debug versions are not installed. */
623 uninstall_symfile_debug_logging (struct objfile *objfile)
625 struct debug_sym_fns_data *debug_data;
627 /* The debug versions should be currently installed. */
628 gdb_assert (symfile_debug_installed (objfile));
630 debug_data = ((struct debug_sym_fns_data *)
631 objfile_data (objfile, symfile_debug_objfile_data_key));
633 objfile->sf = debug_data->real_sf;
635 set_objfile_data (objfile, symfile_debug_objfile_data_key, NULL);
638 /* Call this function to set OBJFILE->SF.
639 Do not set OBJFILE->SF directly. */
642 objfile_set_sym_fns (struct objfile *objfile, const struct sym_fns *sf)
644 if (symfile_debug_installed (objfile))
646 gdb_assert (debug_symfile);
647 /* Remove the current one, and reinstall a new one later. */
648 uninstall_symfile_debug_logging (objfile);
651 /* Assume debug logging is disabled. */
654 /* Turn debug logging on if enabled. */
656 install_symfile_debug_logging (objfile);
660 set_debug_symfile (const char *args, int from_tty, struct cmd_list_element *c)
662 struct program_space *pspace;
665 for (objfile *objfile : pspace->objfiles ())
669 if (!symfile_debug_installed (objfile))
670 install_symfile_debug_logging (objfile);
674 if (symfile_debug_installed (objfile))
675 uninstall_symfile_debug_logging (objfile);
681 show_debug_symfile (struct ui_file *file, int from_tty,
682 struct cmd_list_element *c, const char *value)
684 fprintf_filtered (file, _("Symfile debugging is %s.\n"), value);
688 _initialize_symfile_debug (void)
690 symfile_debug_objfile_data_key
691 = register_objfile_data_with_cleanup (NULL, symfile_debug_free_objfile);
693 add_setshow_boolean_cmd ("symfile", no_class, &debug_symfile, _("\
694 Set debugging of the symfile functions."), _("\
695 Show debugging of the symfile functions."), _("\
696 When enabled, all calls to the symfile functions are logged."),
697 set_debug_symfile, show_debug_symfile,
698 &setdebuglist, &showdebuglist);
700 /* Note: We don't need a new-objfile observer because debug logging
701 will be installed when objfile init'n calls objfile_set_sym_fns. */