1 /* Debug logging for the symbol file functions for the GNU debugger, GDB.
3 Copyright (C) 2013-2017 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 = ((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_relocate (struct objfile
*objfile
,
198 const struct section_offsets
*new_offsets
,
199 const struct section_offsets
*delta
)
201 const struct debug_sym_fns_data
*debug_data
202 = ((const struct debug_sym_fns_data
*)
203 objfile_data (objfile
, symfile_debug_objfile_data_key
));
205 fprintf_filtered (gdb_stdlog
, "qf->relocate (%s, %s, %s)\n",
206 objfile_debug_name (objfile
),
207 host_address_to_string (new_offsets
),
208 host_address_to_string (delta
));
210 debug_data
->real_sf
->qf
->relocate (objfile
, new_offsets
, delta
);
214 debug_qf_expand_symtabs_for_function (struct objfile
*objfile
,
215 const char *func_name
)
217 const struct debug_sym_fns_data
*debug_data
218 = ((const struct debug_sym_fns_data
*)
219 objfile_data (objfile
, symfile_debug_objfile_data_key
));
221 fprintf_filtered (gdb_stdlog
,
222 "qf->expand_symtabs_for_function (%s, \"%s\")\n",
223 objfile_debug_name (objfile
), func_name
);
225 debug_data
->real_sf
->qf
->expand_symtabs_for_function (objfile
, func_name
);
229 debug_qf_expand_all_symtabs (struct objfile
*objfile
)
231 const struct debug_sym_fns_data
*debug_data
232 = ((const struct debug_sym_fns_data
*)
233 objfile_data (objfile
, symfile_debug_objfile_data_key
));
235 fprintf_filtered (gdb_stdlog
, "qf->expand_all_symtabs (%s)\n",
236 objfile_debug_name (objfile
));
238 debug_data
->real_sf
->qf
->expand_all_symtabs (objfile
);
242 debug_qf_expand_symtabs_with_fullname (struct objfile
*objfile
,
243 const char *fullname
)
245 const struct debug_sym_fns_data
*debug_data
246 = ((const struct debug_sym_fns_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 objfile_debug_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 domain
,
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 = ((const struct debug_sym_fns_data
*)
268 objfile_data (objfile
, symfile_debug_objfile_data_key
));
270 fprintf_filtered (gdb_stdlog
,
271 "qf->map_matching_symbols (%s, \"%s\", %s, %d, %s, %s, %s, %s)\n",
272 objfile_debug_name (objfile
), name
,
273 domain_name (domain
), global
,
274 host_address_to_string (callback
),
275 host_address_to_string (data
),
276 host_address_to_string (match
),
277 host_address_to_string (ordered_compare
));
279 debug_data
->real_sf
->qf
->map_matching_symbols (objfile
, name
,
287 debug_qf_expand_symtabs_matching
288 (struct objfile
*objfile
,
289 gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
290 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
291 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
292 enum search_domain kind
)
294 const struct debug_sym_fns_data
*debug_data
295 = ((const struct debug_sym_fns_data
*)
296 objfile_data (objfile
, symfile_debug_objfile_data_key
));
298 fprintf_filtered (gdb_stdlog
,
299 "qf->expand_symtabs_matching (%s, %s, %s, %s, %s)\n",
300 objfile_debug_name (objfile
),
301 host_address_to_string (&file_matcher
),
302 host_address_to_string (&symbol_matcher
),
303 host_address_to_string (&expansion_notify
),
304 search_domain_name (kind
));
306 debug_data
->real_sf
->qf
->expand_symtabs_matching (objfile
,
313 static struct compunit_symtab
*
314 debug_qf_find_pc_sect_compunit_symtab (struct objfile
*objfile
,
315 struct bound_minimal_symbol msymbol
,
317 struct obj_section
*section
,
320 const struct debug_sym_fns_data
*debug_data
321 = ((const struct debug_sym_fns_data
*)
322 objfile_data (objfile
, symfile_debug_objfile_data_key
));
323 struct compunit_symtab
*retval
;
325 fprintf_filtered (gdb_stdlog
,
326 "qf->find_pc_sect_compunit_symtab (%s, %s, %s, %s, %d)\n",
327 objfile_debug_name (objfile
),
328 host_address_to_string (msymbol
.minsym
),
330 host_address_to_string (section
),
334 = debug_data
->real_sf
->qf
->find_pc_sect_compunit_symtab (objfile
, msymbol
,
338 fprintf_filtered (gdb_stdlog
,
339 "qf->find_pc_sect_compunit_symtab (...) = %s\n",
341 ? debug_symtab_name (compunit_primary_filetab (retval
))
348 debug_qf_map_symbol_filenames (struct objfile
*objfile
,
349 symbol_filename_ftype
*fun
, void *data
,
352 const struct debug_sym_fns_data
*debug_data
353 = ((const struct debug_sym_fns_data
*)
354 objfile_data (objfile
, symfile_debug_objfile_data_key
));
355 fprintf_filtered (gdb_stdlog
,
356 "qf->map_symbol_filenames (%s, %s, %s, %d)\n",
357 objfile_debug_name (objfile
),
358 host_address_to_string (fun
),
359 host_address_to_string (data
),
362 debug_data
->real_sf
->qf
->map_symbol_filenames (objfile
, fun
, data
,
366 static const struct quick_symbol_functions debug_sym_quick_functions
=
368 debug_qf_has_symbols
,
369 debug_qf_find_last_source_symtab
,
370 debug_qf_forget_cached_source_info
,
371 debug_qf_map_symtabs_matching_filename
,
372 debug_qf_lookup_symbol
,
373 debug_qf_print_stats
,
376 debug_qf_expand_symtabs_for_function
,
377 debug_qf_expand_all_symtabs
,
378 debug_qf_expand_symtabs_with_fullname
,
379 debug_qf_map_matching_symbols
,
380 debug_qf_expand_symtabs_matching
,
381 debug_qf_find_pc_sect_compunit_symtab
,
382 debug_qf_map_symbol_filenames
385 /* Debugging version of struct sym_probe_fns. */
387 static const std::vector
<probe
*> &
388 debug_sym_get_probes (struct objfile
*objfile
)
390 const struct debug_sym_fns_data
*debug_data
391 = ((const struct debug_sym_fns_data
*)
392 objfile_data (objfile
, symfile_debug_objfile_data_key
));
394 const std::vector
<probe
*> &retval
395 = debug_data
->real_sf
->sym_probe_fns
->sym_get_probes (objfile
);
397 fprintf_filtered (gdb_stdlog
,
398 "probes->sym_get_probes (%s) = %s\n",
399 objfile_debug_name (objfile
),
400 host_address_to_string (retval
.data ()));
405 static const struct sym_probe_fns debug_sym_probe_fns
=
407 debug_sym_get_probes
,
410 /* Debugging version of struct sym_fns. */
413 debug_sym_new_init (struct objfile
*objfile
)
415 const struct debug_sym_fns_data
*debug_data
416 = ((const struct debug_sym_fns_data
*)
417 objfile_data (objfile
, symfile_debug_objfile_data_key
));
419 fprintf_filtered (gdb_stdlog
, "sf->sym_new_init (%s)\n",
420 objfile_debug_name (objfile
));
422 debug_data
->real_sf
->sym_new_init (objfile
);
426 debug_sym_init (struct objfile
*objfile
)
428 const struct debug_sym_fns_data
*debug_data
429 = ((const struct debug_sym_fns_data
*)
430 objfile_data (objfile
, symfile_debug_objfile_data_key
));
432 fprintf_filtered (gdb_stdlog
, "sf->sym_init (%s)\n",
433 objfile_debug_name (objfile
));
435 debug_data
->real_sf
->sym_init (objfile
);
439 debug_sym_read (struct objfile
*objfile
, symfile_add_flags symfile_flags
)
441 const struct debug_sym_fns_data
*debug_data
442 = ((const struct debug_sym_fns_data
*)
443 objfile_data (objfile
, symfile_debug_objfile_data_key
));
445 fprintf_filtered (gdb_stdlog
, "sf->sym_read (%s, 0x%x)\n",
446 objfile_debug_name (objfile
), (unsigned) symfile_flags
);
448 debug_data
->real_sf
->sym_read (objfile
, symfile_flags
);
452 debug_sym_read_psymbols (struct objfile
*objfile
)
454 const struct debug_sym_fns_data
*debug_data
455 = ((const struct debug_sym_fns_data
*)
456 objfile_data (objfile
, symfile_debug_objfile_data_key
));
458 fprintf_filtered (gdb_stdlog
, "sf->sym_read_psymbols (%s)\n",
459 objfile_debug_name (objfile
));
461 debug_data
->real_sf
->sym_read_psymbols (objfile
);
465 debug_sym_finish (struct objfile
*objfile
)
467 const struct debug_sym_fns_data
*debug_data
468 = ((const struct debug_sym_fns_data
*)
469 objfile_data (objfile
, symfile_debug_objfile_data_key
));
471 fprintf_filtered (gdb_stdlog
, "sf->sym_finish (%s)\n",
472 objfile_debug_name (objfile
));
474 debug_data
->real_sf
->sym_finish (objfile
);
478 debug_sym_offsets (struct objfile
*objfile
,
479 const struct section_addr_info
*info
)
481 const struct debug_sym_fns_data
*debug_data
482 = ((const struct debug_sym_fns_data
*)
483 objfile_data (objfile
, symfile_debug_objfile_data_key
));
485 fprintf_filtered (gdb_stdlog
, "sf->sym_offsets (%s, %s)\n",
486 objfile_debug_name (objfile
),
487 host_address_to_string (info
));
489 debug_data
->real_sf
->sym_offsets (objfile
, info
);
492 static struct symfile_segment_data
*
493 debug_sym_segments (bfd
*abfd
)
495 /* This API function is annoying, it doesn't take a "this" pointer.
496 Fortunately it is only used in one place where we (re-)lookup the
497 sym_fns table to use. Thus we will never be called. */
498 gdb_assert_not_reached ("debug_sym_segments called");
502 debug_sym_read_linetable (struct objfile
*objfile
)
504 const struct debug_sym_fns_data
*debug_data
505 = ((const struct debug_sym_fns_data
*)
506 objfile_data (objfile
, symfile_debug_objfile_data_key
));
508 fprintf_filtered (gdb_stdlog
, "sf->sym_read_linetable (%s)\n",
509 objfile_debug_name (objfile
));
511 debug_data
->real_sf
->sym_read_linetable (objfile
);
515 debug_sym_relocate (struct objfile
*objfile
, asection
*sectp
, bfd_byte
*buf
)
517 const struct debug_sym_fns_data
*debug_data
518 = ((const struct debug_sym_fns_data
*)
519 objfile_data (objfile
, symfile_debug_objfile_data_key
));
522 retval
= debug_data
->real_sf
->sym_relocate (objfile
, sectp
, buf
);
524 fprintf_filtered (gdb_stdlog
,
525 "sf->sym_relocate (%s, %s, %s) = %s\n",
526 objfile_debug_name (objfile
),
527 host_address_to_string (sectp
),
528 host_address_to_string (buf
),
529 host_address_to_string (retval
));
534 /* Template of debugging version of struct sym_fns.
535 A copy is made, with sym_flavour updated, and a pointer to the real table
536 installed in real_sf, and then a pointer to the copy is installed in the
539 static const struct sym_fns debug_sym_fns
=
544 debug_sym_read_psymbols
,
548 debug_sym_read_linetable
,
550 &debug_sym_probe_fns
,
551 &debug_sym_quick_functions
554 /* Free the copy of sym_fns recorded in the registry. */
557 symfile_debug_free_objfile (struct objfile
*objfile
, void *datum
)
562 /* Install the debugging versions of the symfile functions for OBJFILE.
563 Do not call this if the debug versions are already installed. */
566 install_symfile_debug_logging (struct objfile
*objfile
)
568 const struct sym_fns
*real_sf
;
569 struct debug_sym_fns_data
*debug_data
;
571 /* The debug versions should not already be installed. */
572 gdb_assert (!symfile_debug_installed (objfile
));
574 real_sf
= objfile
->sf
;
576 /* Alas we have to preserve NULL entries in REAL_SF. */
577 debug_data
= XCNEW (struct debug_sym_fns_data
);
579 #define COPY_SF_PTR(from, to, name, func) \
582 (to)->debug_sf.name = func; \
585 COPY_SF_PTR (real_sf
, debug_data
, sym_new_init
, debug_sym_new_init
);
586 COPY_SF_PTR (real_sf
, debug_data
, sym_init
, debug_sym_init
);
587 COPY_SF_PTR (real_sf
, debug_data
, sym_read
, debug_sym_read
);
588 COPY_SF_PTR (real_sf
, debug_data
, sym_read_psymbols
,
589 debug_sym_read_psymbols
);
590 COPY_SF_PTR (real_sf
, debug_data
, sym_finish
, debug_sym_finish
);
591 COPY_SF_PTR (real_sf
, debug_data
, sym_offsets
, debug_sym_offsets
);
592 COPY_SF_PTR (real_sf
, debug_data
, sym_segments
, debug_sym_segments
);
593 COPY_SF_PTR (real_sf
, debug_data
, sym_read_linetable
,
594 debug_sym_read_linetable
);
595 COPY_SF_PTR (real_sf
, debug_data
, sym_relocate
, debug_sym_relocate
);
596 if (real_sf
->sym_probe_fns
)
597 debug_data
->debug_sf
.sym_probe_fns
= &debug_sym_probe_fns
;
598 debug_data
->debug_sf
.qf
= &debug_sym_quick_functions
;
602 debug_data
->real_sf
= real_sf
;
603 set_objfile_data (objfile
, symfile_debug_objfile_data_key
, debug_data
);
604 objfile
->sf
= &debug_data
->debug_sf
;
607 /* Uninstall the debugging versions of the symfile functions for OBJFILE.
608 Do not call this if the debug versions are not installed. */
611 uninstall_symfile_debug_logging (struct objfile
*objfile
)
613 struct debug_sym_fns_data
*debug_data
;
615 /* The debug versions should be currently installed. */
616 gdb_assert (symfile_debug_installed (objfile
));
618 debug_data
= ((struct debug_sym_fns_data
*)
619 objfile_data (objfile
, symfile_debug_objfile_data_key
));
621 objfile
->sf
= debug_data
->real_sf
;
623 set_objfile_data (objfile
, symfile_debug_objfile_data_key
, NULL
);
626 /* Call this function to set OBJFILE->SF.
627 Do not set OBJFILE->SF directly. */
630 objfile_set_sym_fns (struct objfile
*objfile
, const struct sym_fns
*sf
)
632 if (symfile_debug_installed (objfile
))
634 gdb_assert (debug_symfile
);
635 /* Remove the current one, and reinstall a new one later. */
636 uninstall_symfile_debug_logging (objfile
);
639 /* Assume debug logging is disabled. */
642 /* Turn debug logging on if enabled. */
644 install_symfile_debug_logging (objfile
);
648 set_debug_symfile (char *args
, int from_tty
, struct cmd_list_element
*c
)
650 struct program_space
*pspace
;
651 struct objfile
*objfile
;
654 ALL_PSPACE_OBJFILES (pspace
, objfile
)
658 if (!symfile_debug_installed (objfile
))
659 install_symfile_debug_logging (objfile
);
663 if (symfile_debug_installed (objfile
))
664 uninstall_symfile_debug_logging (objfile
);
670 show_debug_symfile (struct ui_file
*file
, int from_tty
,
671 struct cmd_list_element
*c
, const char *value
)
673 fprintf_filtered (file
, _("Symfile debugging is %s.\n"), value
);
677 _initialize_symfile_debug (void)
679 symfile_debug_objfile_data_key
680 = register_objfile_data_with_cleanup (NULL
, symfile_debug_free_objfile
);
682 add_setshow_boolean_cmd ("symfile", no_class
, &debug_symfile
, _("\
683 Set debugging of the symfile functions."), _("\
684 Show debugging of the symfile functions."), _("\
685 When enabled, all calls to the symfile functions are logged."),
686 set_debug_symfile
, show_debug_symfile
,
687 &setdebuglist
, &showdebuglist
);
689 /* Note: We don't need a new-objfile observer because debug logging
690 will be installed when objfile init'n calls objfile_set_sym_fns. */