Automatic date update in version.in
[binutils-gdb.git] / gdb / symfile.c
blobaea8c762ee610b8b8ae243713fdbe5fa6636bfd1
1 /* Generic symbol file reading for the GNU debugger, GDB.
3 Copyright (C) 1990-2022 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 #include "defs.h"
23 #include "arch-utils.h"
24 #include "bfdlink.h"
25 #include "symtab.h"
26 #include "gdbtypes.h"
27 #include "gdbcore.h"
28 #include "frame.h"
29 #include "target.h"
30 #include "value.h"
31 #include "symfile.h"
32 #include "objfiles.h"
33 #include "source.h"
34 #include "gdbcmd.h"
35 #include "breakpoint.h"
36 #include "language.h"
37 #include "complaints.h"
38 #include "demangle.h"
39 #include "inferior.h"
40 #include "regcache.h"
41 #include "filenames.h" /* for DOSish file names */
42 #include "gdb-stabs.h"
43 #include "gdbsupport/gdb_obstack.h"
44 #include "completer.h"
45 #include "bcache.h"
46 #include "hashtab.h"
47 #include "readline/tilde.h"
48 #include "block.h"
49 #include "observable.h"
50 #include "exec.h"
51 #include "parser-defs.h"
52 #include "varobj.h"
53 #include "elf-bfd.h"
54 #include "solib.h"
55 #include "remote.h"
56 #include "stack.h"
57 #include "gdb_bfd.h"
58 #include "cli/cli-utils.h"
59 #include "gdbsupport/byte-vector.h"
60 #include "gdbsupport/pathstuff.h"
61 #include "gdbsupport/selftest.h"
62 #include "cli/cli-style.h"
63 #include "gdbsupport/forward-scope-exit.h"
64 #include "gdbsupport/buildargv.h"
66 #include <sys/types.h>
67 #include <fcntl.h>
68 #include <sys/stat.h>
69 #include <ctype.h>
70 #include <chrono>
71 #include <algorithm>
73 int (*deprecated_ui_load_progress_hook) (const char *section,
74 unsigned long num);
75 void (*deprecated_show_load_progress) (const char *section,
76 unsigned long section_sent,
77 unsigned long section_size,
78 unsigned long total_sent,
79 unsigned long total_size);
80 void (*deprecated_pre_add_symbol_hook) (const char *);
81 void (*deprecated_post_add_symbol_hook) (void);
83 using clear_symtab_users_cleanup
84 = FORWARD_SCOPE_EXIT (clear_symtab_users);
86 /* Global variables owned by this file. */
88 /* See symfile.h. */
90 int readnow_symbol_files;
92 /* See symfile.h. */
94 int readnever_symbol_files;
96 /* Functions this file defines. */
98 static void symbol_file_add_main_1 (const char *args, symfile_add_flags add_flags,
99 objfile_flags flags, CORE_ADDR reloff);
101 static const struct sym_fns *find_sym_fns (bfd *);
103 static void overlay_invalidate_all (void);
105 static void simple_free_overlay_table (void);
107 static void read_target_long_array (CORE_ADDR, unsigned int *, int, int,
108 enum bfd_endian);
110 static int simple_read_overlay_table (void);
112 static int simple_overlay_update_1 (struct obj_section *);
114 static void symfile_find_segment_sections (struct objfile *objfile);
116 /* List of all available sym_fns. On gdb startup, each object file reader
117 calls add_symtab_fns() to register information on each format it is
118 prepared to read. */
120 struct registered_sym_fns
122 registered_sym_fns (bfd_flavour sym_flavour_, const struct sym_fns *sym_fns_)
123 : sym_flavour (sym_flavour_), sym_fns (sym_fns_)
126 /* BFD flavour that we handle. */
127 enum bfd_flavour sym_flavour;
129 /* The "vtable" of symbol functions. */
130 const struct sym_fns *sym_fns;
133 static std::vector<registered_sym_fns> symtab_fns;
135 /* Values for "set print symbol-loading". */
137 const char print_symbol_loading_off[] = "off";
138 const char print_symbol_loading_brief[] = "brief";
139 const char print_symbol_loading_full[] = "full";
140 static const char *print_symbol_loading_enums[] =
142 print_symbol_loading_off,
143 print_symbol_loading_brief,
144 print_symbol_loading_full,
145 NULL
147 static const char *print_symbol_loading = print_symbol_loading_full;
149 /* See symfile.h. */
151 bool auto_solib_add = true;
154 /* Return non-zero if symbol-loading messages should be printed.
155 FROM_TTY is the standard from_tty argument to gdb commands.
156 If EXEC is non-zero the messages are for the executable.
157 Otherwise, messages are for shared libraries.
158 If FULL is non-zero then the caller is printing a detailed message.
159 E.g., the message includes the shared library name.
160 Otherwise, the caller is printing a brief "summary" message. */
163 print_symbol_loading_p (int from_tty, int exec, int full)
165 if (!from_tty && !info_verbose)
166 return 0;
168 if (exec)
170 /* We don't check FULL for executables, there are few such
171 messages, therefore brief == full. */
172 return print_symbol_loading != print_symbol_loading_off;
174 if (full)
175 return print_symbol_loading == print_symbol_loading_full;
176 return print_symbol_loading == print_symbol_loading_brief;
179 /* True if we are reading a symbol table. */
181 int currently_reading_symtab = 0;
183 /* Increment currently_reading_symtab and return a cleanup that can be
184 used to decrement it. */
186 scoped_restore_tmpl<int>
187 increment_reading_symtab (void)
189 gdb_assert (currently_reading_symtab >= 0);
190 return make_scoped_restore (&currently_reading_symtab,
191 currently_reading_symtab + 1);
194 /* Remember the lowest-addressed loadable section we've seen.
196 In case of equal vmas, the section with the largest size becomes the
197 lowest-addressed loadable section.
199 If the vmas and sizes are equal, the last section is considered the
200 lowest-addressed loadable section. */
202 static void
203 find_lowest_section (asection *sect, asection **lowest)
205 if (0 == (bfd_section_flags (sect) & (SEC_ALLOC | SEC_LOAD)))
206 return;
207 if (!*lowest)
208 *lowest = sect; /* First loadable section */
209 else if (bfd_section_vma (*lowest) > bfd_section_vma (sect))
210 *lowest = sect; /* A lower loadable section */
211 else if (bfd_section_vma (*lowest) == bfd_section_vma (sect)
212 && (bfd_section_size (*lowest) <= bfd_section_size (sect)))
213 *lowest = sect;
216 /* Build (allocate and populate) a section_addr_info struct from
217 an existing section table. */
219 section_addr_info
220 build_section_addr_info_from_section_table (const target_section_table &table)
222 section_addr_info sap;
224 for (const target_section &stp : table)
226 struct bfd_section *asect = stp.the_bfd_section;
227 bfd *abfd = asect->owner;
229 if (bfd_section_flags (asect) & (SEC_ALLOC | SEC_LOAD)
230 && sap.size () < table.size ())
231 sap.emplace_back (stp.addr,
232 bfd_section_name (asect),
233 gdb_bfd_section_index (abfd, asect));
236 return sap;
239 /* Create a section_addr_info from section offsets in ABFD. */
241 static section_addr_info
242 build_section_addr_info_from_bfd (bfd *abfd)
244 struct bfd_section *sec;
246 section_addr_info sap;
247 for (sec = abfd->sections; sec != NULL; sec = sec->next)
248 if (bfd_section_flags (sec) & (SEC_ALLOC | SEC_LOAD))
249 sap.emplace_back (bfd_section_vma (sec),
250 bfd_section_name (sec),
251 gdb_bfd_section_index (abfd, sec));
253 return sap;
256 /* Create a section_addr_info from section offsets in OBJFILE. */
258 section_addr_info
259 build_section_addr_info_from_objfile (const struct objfile *objfile)
261 int i;
263 /* Before reread_symbols gets rewritten it is not safe to call:
264 gdb_assert (objfile->num_sections == bfd_count_sections (objfile->obfd));
266 section_addr_info sap = build_section_addr_info_from_bfd (objfile->obfd);
267 for (i = 0; i < sap.size (); i++)
269 int sectindex = sap[i].sectindex;
271 sap[i].addr += objfile->section_offsets[sectindex];
273 return sap;
276 /* Initialize OBJFILE's sect_index_* members. */
278 static void
279 init_objfile_sect_indices (struct objfile *objfile)
281 asection *sect;
282 int i;
284 sect = bfd_get_section_by_name (objfile->obfd, ".text");
285 if (sect)
286 objfile->sect_index_text = sect->index;
288 sect = bfd_get_section_by_name (objfile->obfd, ".data");
289 if (sect)
290 objfile->sect_index_data = sect->index;
292 sect = bfd_get_section_by_name (objfile->obfd, ".bss");
293 if (sect)
294 objfile->sect_index_bss = sect->index;
296 sect = bfd_get_section_by_name (objfile->obfd, ".rodata");
297 if (sect)
298 objfile->sect_index_rodata = sect->index;
300 /* This is where things get really weird... We MUST have valid
301 indices for the various sect_index_* members or gdb will abort.
302 So if for example, there is no ".text" section, we have to
303 accomodate that. First, check for a file with the standard
304 one or two segments. */
306 symfile_find_segment_sections (objfile);
308 /* Except when explicitly adding symbol files at some address,
309 section_offsets contains nothing but zeros, so it doesn't matter
310 which slot in section_offsets the individual sect_index_* members
311 index into. So if they are all zero, it is safe to just point
312 all the currently uninitialized indices to the first slot. But
313 beware: if this is the main executable, it may be relocated
314 later, e.g. by the remote qOffsets packet, and then this will
315 be wrong! That's why we try segments first. */
317 for (i = 0; i < objfile->section_offsets.size (); i++)
319 if (objfile->section_offsets[i] != 0)
321 break;
324 if (i == objfile->section_offsets.size ())
326 if (objfile->sect_index_text == -1)
327 objfile->sect_index_text = 0;
328 if (objfile->sect_index_data == -1)
329 objfile->sect_index_data = 0;
330 if (objfile->sect_index_bss == -1)
331 objfile->sect_index_bss = 0;
332 if (objfile->sect_index_rodata == -1)
333 objfile->sect_index_rodata = 0;
337 /* Find a unique offset to use for loadable section SECT if
338 the user did not provide an offset. */
340 static void
341 place_section (bfd *abfd, asection *sect, section_offsets &offsets,
342 CORE_ADDR &lowest)
344 CORE_ADDR start_addr;
345 int done;
346 ULONGEST align = ((ULONGEST) 1) << bfd_section_alignment (sect);
348 /* We are only interested in allocated sections. */
349 if ((bfd_section_flags (sect) & SEC_ALLOC) == 0)
350 return;
352 /* If the user specified an offset, honor it. */
353 if (offsets[gdb_bfd_section_index (abfd, sect)] != 0)
354 return;
356 /* Otherwise, let's try to find a place for the section. */
357 start_addr = (lowest + align - 1) & -align;
359 do {
360 asection *cur_sec;
362 done = 1;
364 for (cur_sec = abfd->sections; cur_sec != NULL; cur_sec = cur_sec->next)
366 int indx = cur_sec->index;
368 /* We don't need to compare against ourself. */
369 if (cur_sec == sect)
370 continue;
372 /* We can only conflict with allocated sections. */
373 if ((bfd_section_flags (cur_sec) & SEC_ALLOC) == 0)
374 continue;
376 /* If the section offset is 0, either the section has not been placed
377 yet, or it was the lowest section placed (in which case LOWEST
378 will be past its end). */
379 if (offsets[indx] == 0)
380 continue;
382 /* If this section would overlap us, then we must move up. */
383 if (start_addr + bfd_section_size (sect) > offsets[indx]
384 && start_addr < offsets[indx] + bfd_section_size (cur_sec))
386 start_addr = offsets[indx] + bfd_section_size (cur_sec);
387 start_addr = (start_addr + align - 1) & -align;
388 done = 0;
389 break;
392 /* Otherwise, we appear to be OK. So far. */
395 while (!done);
397 offsets[gdb_bfd_section_index (abfd, sect)] = start_addr;
398 lowest = start_addr + bfd_section_size (sect);
401 /* Store section_addr_info as prepared (made relative and with SECTINDEX
402 filled-in) by addr_info_make_relative into SECTION_OFFSETS. */
404 void
405 relative_addr_info_to_section_offsets (section_offsets &section_offsets,
406 const section_addr_info &addrs)
408 int i;
410 section_offsets.assign (section_offsets.size (), 0);
412 /* Now calculate offsets for section that were specified by the caller. */
413 for (i = 0; i < addrs.size (); i++)
415 const struct other_sections *osp;
417 osp = &addrs[i];
418 if (osp->sectindex == -1)
419 continue;
421 /* Record all sections in offsets. */
422 /* The section_offsets in the objfile are here filled in using
423 the BFD index. */
424 section_offsets[osp->sectindex] = osp->addr;
428 /* Transform section name S for a name comparison. prelink can split section
429 `.bss' into two sections `.dynbss' and `.bss' (in this order). Similarly
430 prelink can split `.sbss' into `.sdynbss' and `.sbss'. Use virtual address
431 of the new `.dynbss' (`.sdynbss') section as the adjacent new `.bss'
432 (`.sbss') section has invalid (increased) virtual address. */
434 static const char *
435 addr_section_name (const char *s)
437 if (strcmp (s, ".dynbss") == 0)
438 return ".bss";
439 if (strcmp (s, ".sdynbss") == 0)
440 return ".sbss";
442 return s;
445 /* std::sort comparator for addrs_section_sort. Sort entries in
446 ascending order by their (name, sectindex) pair. sectindex makes
447 the sort by name stable. */
449 static bool
450 addrs_section_compar (const struct other_sections *a,
451 const struct other_sections *b)
453 int retval;
455 retval = strcmp (addr_section_name (a->name.c_str ()),
456 addr_section_name (b->name.c_str ()));
457 if (retval != 0)
458 return retval < 0;
460 return a->sectindex < b->sectindex;
463 /* Provide sorted array of pointers to sections of ADDRS. */
465 static std::vector<const struct other_sections *>
466 addrs_section_sort (const section_addr_info &addrs)
468 int i;
470 std::vector<const struct other_sections *> array (addrs.size ());
471 for (i = 0; i < addrs.size (); i++)
472 array[i] = &addrs[i];
474 std::sort (array.begin (), array.end (), addrs_section_compar);
476 return array;
479 /* Relativize absolute addresses in ADDRS into offsets based on ABFD. Fill-in
480 also SECTINDEXes specific to ABFD there. This function can be used to
481 rebase ADDRS to start referencing different BFD than before. */
483 void
484 addr_info_make_relative (section_addr_info *addrs, bfd *abfd)
486 asection *lower_sect;
487 CORE_ADDR lower_offset;
488 int i;
490 /* Find lowest loadable section to be used as starting point for
491 contiguous sections. */
492 lower_sect = NULL;
493 for (asection *iter : gdb_bfd_sections (abfd))
494 find_lowest_section (iter, &lower_sect);
495 if (lower_sect == NULL)
497 warning (_("no loadable sections found in added symbol-file %s"),
498 bfd_get_filename (abfd));
499 lower_offset = 0;
501 else
502 lower_offset = bfd_section_vma (lower_sect);
504 /* Create ADDRS_TO_ABFD_ADDRS array to map the sections in ADDRS to sections
505 in ABFD. Section names are not unique - there can be multiple sections of
506 the same name. Also the sections of the same name do not have to be
507 adjacent to each other. Some sections may be present only in one of the
508 files. Even sections present in both files do not have to be in the same
509 order.
511 Use stable sort by name for the sections in both files. Then linearly
512 scan both lists matching as most of the entries as possible. */
514 std::vector<const struct other_sections *> addrs_sorted
515 = addrs_section_sort (*addrs);
517 section_addr_info abfd_addrs = build_section_addr_info_from_bfd (abfd);
518 std::vector<const struct other_sections *> abfd_addrs_sorted
519 = addrs_section_sort (abfd_addrs);
521 /* Now create ADDRS_TO_ABFD_ADDRS from ADDRS_SORTED and
522 ABFD_ADDRS_SORTED. */
524 std::vector<const struct other_sections *>
525 addrs_to_abfd_addrs (addrs->size (), nullptr);
527 std::vector<const struct other_sections *>::iterator abfd_sorted_iter
528 = abfd_addrs_sorted.begin ();
529 for (const other_sections *sect : addrs_sorted)
531 const char *sect_name = addr_section_name (sect->name.c_str ());
533 while (abfd_sorted_iter != abfd_addrs_sorted.end ()
534 && strcmp (addr_section_name ((*abfd_sorted_iter)->name.c_str ()),
535 sect_name) < 0)
536 abfd_sorted_iter++;
538 if (abfd_sorted_iter != abfd_addrs_sorted.end ()
539 && strcmp (addr_section_name ((*abfd_sorted_iter)->name.c_str ()),
540 sect_name) == 0)
542 int index_in_addrs;
544 /* Make the found item directly addressable from ADDRS. */
545 index_in_addrs = sect - addrs->data ();
546 gdb_assert (addrs_to_abfd_addrs[index_in_addrs] == NULL);
547 addrs_to_abfd_addrs[index_in_addrs] = *abfd_sorted_iter;
549 /* Never use the same ABFD entry twice. */
550 abfd_sorted_iter++;
554 /* Calculate offsets for the loadable sections.
555 FIXME! Sections must be in order of increasing loadable section
556 so that contiguous sections can use the lower-offset!!!
558 Adjust offsets if the segments are not contiguous.
559 If the section is contiguous, its offset should be set to
560 the offset of the highest loadable section lower than it
561 (the loadable section directly below it in memory).
562 this_offset = lower_offset = lower_addr - lower_orig_addr */
564 for (i = 0; i < addrs->size (); i++)
566 const struct other_sections *sect = addrs_to_abfd_addrs[i];
568 if (sect)
570 /* This is the index used by BFD. */
571 (*addrs)[i].sectindex = sect->sectindex;
573 if ((*addrs)[i].addr != 0)
575 (*addrs)[i].addr -= sect->addr;
576 lower_offset = (*addrs)[i].addr;
578 else
579 (*addrs)[i].addr = lower_offset;
581 else
583 /* addr_section_name transformation is not used for SECT_NAME. */
584 const std::string &sect_name = (*addrs)[i].name;
586 /* This section does not exist in ABFD, which is normally
587 unexpected and we want to issue a warning.
589 However, the ELF prelinker does create a few sections which are
590 marked in the main executable as loadable (they are loaded in
591 memory from the DYNAMIC segment) and yet are not present in
592 separate debug info files. This is fine, and should not cause
593 a warning. Shared libraries contain just the section
594 ".gnu.liblist" but it is not marked as loadable there. There is
595 no other way to identify them than by their name as the sections
596 created by prelink have no special flags.
598 For the sections `.bss' and `.sbss' see addr_section_name. */
600 if (!(sect_name == ".gnu.liblist"
601 || sect_name == ".gnu.conflict"
602 || (sect_name == ".bss"
603 && i > 0
604 && (*addrs)[i - 1].name == ".dynbss"
605 && addrs_to_abfd_addrs[i - 1] != NULL)
606 || (sect_name == ".sbss"
607 && i > 0
608 && (*addrs)[i - 1].name == ".sdynbss"
609 && addrs_to_abfd_addrs[i - 1] != NULL)))
610 warning (_("section %s not found in %s"), sect_name.c_str (),
611 bfd_get_filename (abfd));
613 (*addrs)[i].addr = 0;
614 (*addrs)[i].sectindex = -1;
619 /* Parse the user's idea of an offset for dynamic linking, into our idea
620 of how to represent it for fast symbol reading. This is the default
621 version of the sym_fns.sym_offsets function for symbol readers that
622 don't need to do anything special. It allocates a section_offsets table
623 for the objectfile OBJFILE and stuffs ADDR into all of the offsets. */
625 void
626 default_symfile_offsets (struct objfile *objfile,
627 const section_addr_info &addrs)
629 objfile->section_offsets.resize (gdb_bfd_count_sections (objfile->obfd));
630 relative_addr_info_to_section_offsets (objfile->section_offsets, addrs);
632 /* For relocatable files, all loadable sections will start at zero.
633 The zero is meaningless, so try to pick arbitrary addresses such
634 that no loadable sections overlap. This algorithm is quadratic,
635 but the number of sections in a single object file is generally
636 small. */
637 if ((bfd_get_file_flags (objfile->obfd) & (EXEC_P | DYNAMIC)) == 0)
639 bfd *abfd = objfile->obfd;
640 asection *cur_sec;
642 for (cur_sec = abfd->sections; cur_sec != NULL; cur_sec = cur_sec->next)
643 /* We do not expect this to happen; just skip this step if the
644 relocatable file has a section with an assigned VMA. */
645 if (bfd_section_vma (cur_sec) != 0)
646 break;
648 if (cur_sec == NULL)
650 section_offsets &offsets = objfile->section_offsets;
652 /* Pick non-overlapping offsets for sections the user did not
653 place explicitly. */
654 CORE_ADDR lowest = 0;
655 for (asection *sect : gdb_bfd_sections (objfile->obfd))
656 place_section (objfile->obfd, sect, objfile->section_offsets,
657 lowest);
659 /* Correctly filling in the section offsets is not quite
660 enough. Relocatable files have two properties that
661 (most) shared objects do not:
663 - Their debug information will contain relocations. Some
664 shared libraries do also, but many do not, so this can not
665 be assumed.
667 - If there are multiple code sections they will be loaded
668 at different relative addresses in memory than they are
669 in the objfile, since all sections in the file will start
670 at address zero.
672 Because GDB has very limited ability to map from an
673 address in debug info to the correct code section,
674 it relies on adding SECT_OFF_TEXT to things which might be
675 code. If we clear all the section offsets, and set the
676 section VMAs instead, then symfile_relocate_debug_section
677 will return meaningful debug information pointing at the
678 correct sections.
680 GDB has too many different data structures for section
681 addresses - a bfd, objfile, and so_list all have section
682 tables, as does exec_ops. Some of these could probably
683 be eliminated. */
685 for (cur_sec = abfd->sections; cur_sec != NULL;
686 cur_sec = cur_sec->next)
688 if ((bfd_section_flags (cur_sec) & SEC_ALLOC) == 0)
689 continue;
691 bfd_set_section_vma (cur_sec, offsets[cur_sec->index]);
692 exec_set_section_address (bfd_get_filename (abfd),
693 cur_sec->index,
694 offsets[cur_sec->index]);
695 offsets[cur_sec->index] = 0;
700 /* Remember the bfd indexes for the .text, .data, .bss and
701 .rodata sections. */
702 init_objfile_sect_indices (objfile);
705 /* Divide the file into segments, which are individual relocatable units.
706 This is the default version of the sym_fns.sym_segments function for
707 symbol readers that do not have an explicit representation of segments.
708 It assumes that object files do not have segments, and fully linked
709 files have a single segment. */
711 symfile_segment_data_up
712 default_symfile_segments (bfd *abfd)
714 int num_sections, i;
715 asection *sect;
716 CORE_ADDR low, high;
718 /* Relocatable files contain enough information to position each
719 loadable section independently; they should not be relocated
720 in segments. */
721 if ((bfd_get_file_flags (abfd) & (EXEC_P | DYNAMIC)) == 0)
722 return NULL;
724 /* Make sure there is at least one loadable section in the file. */
725 for (sect = abfd->sections; sect != NULL; sect = sect->next)
727 if ((bfd_section_flags (sect) & SEC_ALLOC) == 0)
728 continue;
730 break;
732 if (sect == NULL)
733 return NULL;
735 low = bfd_section_vma (sect);
736 high = low + bfd_section_size (sect);
738 symfile_segment_data_up data (new symfile_segment_data);
740 num_sections = bfd_count_sections (abfd);
742 /* All elements are initialized to 0 (map to no segment). */
743 data->segment_info.resize (num_sections);
745 for (i = 0, sect = abfd->sections; sect != NULL; i++, sect = sect->next)
747 CORE_ADDR vma;
749 if ((bfd_section_flags (sect) & SEC_ALLOC) == 0)
750 continue;
752 vma = bfd_section_vma (sect);
753 if (vma < low)
754 low = vma;
755 if (vma + bfd_section_size (sect) > high)
756 high = vma + bfd_section_size (sect);
758 data->segment_info[i] = 1;
761 data->segments.emplace_back (low, high - low);
763 return data;
766 /* This is a convenience function to call sym_read for OBJFILE and
767 possibly force the partial symbols to be read. */
769 static void
770 read_symbols (struct objfile *objfile, symfile_add_flags add_flags)
772 (*objfile->sf->sym_read) (objfile, add_flags);
773 objfile->per_bfd->minsyms_read = true;
775 /* find_separate_debug_file_in_section should be called only if there is
776 single binary with no existing separate debug info file. */
777 if (!objfile->has_partial_symbols ()
778 && objfile->separate_debug_objfile == NULL
779 && objfile->separate_debug_objfile_backlink == NULL)
781 gdb_bfd_ref_ptr abfd (find_separate_debug_file_in_section (objfile));
783 if (abfd != NULL)
785 /* find_separate_debug_file_in_section uses the same filename for the
786 virtual section-as-bfd like the bfd filename containing the
787 section. Therefore use also non-canonical name form for the same
788 file containing the section. */
789 symbol_file_add_separate (abfd.get (),
790 bfd_get_filename (abfd.get ()),
791 add_flags | SYMFILE_NOT_FILENAME, objfile);
794 if ((add_flags & SYMFILE_NO_READ) == 0)
795 objfile->require_partial_symbols (false);
798 /* Initialize entry point information for this objfile. */
800 static void
801 init_entry_point_info (struct objfile *objfile)
803 struct entry_info *ei = &objfile->per_bfd->ei;
805 if (ei->initialized)
806 return;
807 ei->initialized = 1;
809 /* Save startup file's range of PC addresses to help blockframe.c
810 decide where the bottom of the stack is. */
812 if (bfd_get_file_flags (objfile->obfd) & EXEC_P)
814 /* Executable file -- record its entry point so we'll recognize
815 the startup file because it contains the entry point. */
816 ei->entry_point = bfd_get_start_address (objfile->obfd);
817 ei->entry_point_p = 1;
819 else if (bfd_get_file_flags (objfile->obfd) & DYNAMIC
820 && bfd_get_start_address (objfile->obfd) != 0)
822 /* Some shared libraries may have entry points set and be
823 runnable. There's no clear way to indicate this, so just check
824 for values other than zero. */
825 ei->entry_point = bfd_get_start_address (objfile->obfd);
826 ei->entry_point_p = 1;
828 else
830 /* Examination of non-executable.o files. Short-circuit this stuff. */
831 ei->entry_point_p = 0;
834 if (ei->entry_point_p)
836 struct obj_section *osect;
837 CORE_ADDR entry_point = ei->entry_point;
838 int found;
840 /* Make certain that the address points at real code, and not a
841 function descriptor. */
842 entry_point = gdbarch_convert_from_func_ptr_addr
843 (objfile->arch (), entry_point, current_inferior ()->top_target ());
845 /* Remove any ISA markers, so that this matches entries in the
846 symbol table. */
847 ei->entry_point
848 = gdbarch_addr_bits_remove (objfile->arch (), entry_point);
850 found = 0;
851 ALL_OBJFILE_OSECTIONS (objfile, osect)
853 struct bfd_section *sect = osect->the_bfd_section;
855 if (entry_point >= bfd_section_vma (sect)
856 && entry_point < (bfd_section_vma (sect)
857 + bfd_section_size (sect)))
859 ei->the_bfd_section_index
860 = gdb_bfd_section_index (objfile->obfd, sect);
861 found = 1;
862 break;
866 if (!found)
867 ei->the_bfd_section_index = SECT_OFF_TEXT (objfile);
871 /* Process a symbol file, as either the main file or as a dynamically
872 loaded file.
874 This function does not set the OBJFILE's entry-point info.
876 OBJFILE is where the symbols are to be read from.
878 ADDRS is the list of section load addresses. If the user has given
879 an 'add-symbol-file' command, then this is the list of offsets and
880 addresses he or she provided as arguments to the command; or, if
881 we're handling a shared library, these are the actual addresses the
882 sections are loaded at, according to the inferior's dynamic linker
883 (as gleaned by GDB's shared library code). We convert each address
884 into an offset from the section VMA's as it appears in the object
885 file, and then call the file's sym_offsets function to convert this
886 into a format-specific offset table --- a `section_offsets'.
887 The sectindex field is used to control the ordering of sections
888 with the same name. Upon return, it is updated to contain the
889 corresponding BFD section index, or -1 if the section was not found.
891 ADD_FLAGS encodes verbosity level, whether this is main symbol or
892 an extra symbol file such as dynamically loaded code, and whether
893 breakpoint reset should be deferred. */
895 static void
896 syms_from_objfile_1 (struct objfile *objfile,
897 section_addr_info *addrs,
898 symfile_add_flags add_flags)
900 section_addr_info local_addr;
901 const int mainline = add_flags & SYMFILE_MAINLINE;
903 objfile_set_sym_fns (objfile, find_sym_fns (objfile->obfd));
904 objfile->qf.clear ();
906 if (objfile->sf == NULL)
908 /* No symbols to load, but we still need to make sure
909 that the section_offsets table is allocated. */
910 int num_sections = gdb_bfd_count_sections (objfile->obfd);
912 objfile->section_offsets.assign (num_sections, 0);
913 return;
916 /* Make sure that partially constructed symbol tables will be cleaned up
917 if an error occurs during symbol reading. */
918 gdb::optional<clear_symtab_users_cleanup> defer_clear_users;
920 objfile_up objfile_holder (objfile);
922 /* If ADDRS is NULL, put together a dummy address list.
923 We now establish the convention that an addr of zero means
924 no load address was specified. */
925 if (! addrs)
926 addrs = &local_addr;
928 if (mainline)
930 /* We will modify the main symbol table, make sure that all its users
931 will be cleaned up if an error occurs during symbol reading. */
932 defer_clear_users.emplace ((symfile_add_flag) 0);
934 /* Since no error yet, throw away the old symbol table. */
936 if (current_program_space->symfile_object_file != NULL)
938 current_program_space->symfile_object_file->unlink ();
939 gdb_assert (current_program_space->symfile_object_file == NULL);
942 /* Currently we keep symbols from the add-symbol-file command.
943 If the user wants to get rid of them, they should do "symbol-file"
944 without arguments first. Not sure this is the best behavior
945 (PR 2207). */
947 (*objfile->sf->sym_new_init) (objfile);
950 /* Convert addr into an offset rather than an absolute address.
951 We find the lowest address of a loaded segment in the objfile,
952 and assume that <addr> is where that got loaded.
954 We no longer warn if the lowest section is not a text segment (as
955 happens for the PA64 port. */
956 if (addrs->size () > 0)
957 addr_info_make_relative (addrs, objfile->obfd);
959 /* Initialize symbol reading routines for this objfile, allow complaints to
960 appear for this new file, and record how verbose to be, then do the
961 initial symbol reading for this file. */
963 (*objfile->sf->sym_init) (objfile);
964 clear_complaints ();
966 (*objfile->sf->sym_offsets) (objfile, *addrs);
968 read_symbols (objfile, add_flags);
970 /* Discard cleanups as symbol reading was successful. */
972 objfile_holder.release ();
973 if (defer_clear_users)
974 defer_clear_users->release ();
977 /* Same as syms_from_objfile_1, but also initializes the objfile
978 entry-point info. */
980 static void
981 syms_from_objfile (struct objfile *objfile,
982 section_addr_info *addrs,
983 symfile_add_flags add_flags)
985 syms_from_objfile_1 (objfile, addrs, add_flags);
986 init_entry_point_info (objfile);
989 /* Perform required actions after either reading in the initial
990 symbols for a new objfile, or mapping in the symbols from a reusable
991 objfile. ADD_FLAGS is a bitmask of enum symfile_add_flags. */
993 static void
994 finish_new_objfile (struct objfile *objfile, symfile_add_flags add_flags)
996 /* If this is the main symbol file we have to clean up all users of the
997 old main symbol file. Otherwise it is sufficient to fixup all the
998 breakpoints that may have been redefined by this symbol file. */
999 if (add_flags & SYMFILE_MAINLINE)
1001 /* OK, make it the "real" symbol file. */
1002 current_program_space->symfile_object_file = objfile;
1004 clear_symtab_users (add_flags);
1006 else if ((add_flags & SYMFILE_DEFER_BP_RESET) == 0)
1008 breakpoint_re_set ();
1011 /* We're done reading the symbol file; finish off complaints. */
1012 clear_complaints ();
1015 /* Process a symbol file, as either the main file or as a dynamically
1016 loaded file.
1018 ABFD is a BFD already open on the file, as from symfile_bfd_open.
1019 A new reference is acquired by this function.
1021 For NAME description see the objfile constructor.
1023 ADD_FLAGS encodes verbosity, whether this is main symbol file or
1024 extra, such as dynamically loaded code, and what to do with breakpoints.
1026 ADDRS is as described for syms_from_objfile_1, above.
1027 ADDRS is ignored when SYMFILE_MAINLINE bit is set in ADD_FLAGS.
1029 PARENT is the original objfile if ABFD is a separate debug info file.
1030 Otherwise PARENT is NULL.
1032 Upon success, returns a pointer to the objfile that was added.
1033 Upon failure, jumps back to command level (never returns). */
1035 static struct objfile *
1036 symbol_file_add_with_addrs (bfd *abfd, const char *name,
1037 symfile_add_flags add_flags,
1038 section_addr_info *addrs,
1039 objfile_flags flags, struct objfile *parent)
1041 struct objfile *objfile;
1042 const int from_tty = add_flags & SYMFILE_VERBOSE;
1043 const int mainline = add_flags & SYMFILE_MAINLINE;
1044 const int always_confirm = add_flags & SYMFILE_ALWAYS_CONFIRM;
1045 const int should_print = (print_symbol_loading_p (from_tty, mainline, 1)
1046 && (readnow_symbol_files
1047 || (add_flags & SYMFILE_NO_READ) == 0));
1049 if (readnow_symbol_files)
1051 flags |= OBJF_READNOW;
1052 add_flags &= ~SYMFILE_NO_READ;
1054 else if (readnever_symbol_files
1055 || (parent != NULL && (parent->flags & OBJF_READNEVER)))
1057 flags |= OBJF_READNEVER;
1058 add_flags |= SYMFILE_NO_READ;
1060 if ((add_flags & SYMFILE_NOT_FILENAME) != 0)
1061 flags |= OBJF_NOT_FILENAME;
1063 /* Give user a chance to burp if ALWAYS_CONFIRM or we'd be
1064 interactively wiping out any existing symbols. */
1066 if (from_tty
1067 && (always_confirm
1068 || ((have_full_symbols () || have_partial_symbols ())
1069 && mainline))
1070 && !query (_("Load new symbol table from \"%s\"? "), name))
1071 error (_("Not confirmed."));
1073 if (mainline)
1074 flags |= OBJF_MAINLINE;
1075 objfile = objfile::make (abfd, name, flags, parent);
1077 /* We either created a new mapped symbol table, mapped an existing
1078 symbol table file which has not had initial symbol reading
1079 performed, or need to read an unmapped symbol table. */
1080 if (should_print)
1082 if (deprecated_pre_add_symbol_hook)
1083 deprecated_pre_add_symbol_hook (name);
1084 else
1085 gdb_printf (_("Reading symbols from %ps...\n"),
1086 styled_string (file_name_style.style (), name));
1088 syms_from_objfile (objfile, addrs, add_flags);
1090 /* We now have at least a partial symbol table. Check to see if the
1091 user requested that all symbols be read on initial access via either
1092 the gdb startup command line or on a per symbol file basis. Expand
1093 all partial symbol tables for this objfile if so. */
1095 if ((flags & OBJF_READNOW))
1097 if (should_print)
1098 gdb_printf (_("Expanding full symbols from %ps...\n"),
1099 styled_string (file_name_style.style (), name));
1101 objfile->expand_all_symtabs ();
1104 /* Note that we only print a message if we have no symbols and have
1105 no separate debug file. If there is a separate debug file which
1106 does not have symbols, we'll have emitted this message for that
1107 file, and so printing it twice is just redundant. */
1108 if (should_print && !objfile_has_symbols (objfile)
1109 && objfile->separate_debug_objfile == nullptr)
1110 gdb_printf (_("(No debugging symbols found in %ps)\n"),
1111 styled_string (file_name_style.style (), name));
1113 if (should_print)
1115 if (deprecated_post_add_symbol_hook)
1116 deprecated_post_add_symbol_hook ();
1119 /* We print some messages regardless of whether 'from_tty ||
1120 info_verbose' is true, so make sure they go out at the right
1121 time. */
1122 gdb_flush (gdb_stdout);
1124 if (objfile->sf == NULL)
1126 gdb::observers::new_objfile.notify (objfile);
1127 return objfile; /* No symbols. */
1130 finish_new_objfile (objfile, add_flags);
1132 gdb::observers::new_objfile.notify (objfile);
1134 bfd_cache_close_all ();
1135 return (objfile);
1138 /* Add BFD as a separate debug file for OBJFILE. For NAME description
1139 see the objfile constructor. */
1141 void
1142 symbol_file_add_separate (bfd *bfd, const char *name,
1143 symfile_add_flags symfile_flags,
1144 struct objfile *objfile)
1146 /* Create section_addr_info. We can't directly use offsets from OBJFILE
1147 because sections of BFD may not match sections of OBJFILE and because
1148 vma may have been modified by tools such as prelink. */
1149 section_addr_info sap = build_section_addr_info_from_objfile (objfile);
1151 symbol_file_add_with_addrs
1152 (bfd, name, symfile_flags, &sap,
1153 objfile->flags & (OBJF_REORDERED | OBJF_SHARED | OBJF_READNOW
1154 | OBJF_USERLOADED | OBJF_MAINLINE),
1155 objfile);
1158 /* Process the symbol file ABFD, as either the main file or as a
1159 dynamically loaded file.
1160 See symbol_file_add_with_addrs's comments for details. */
1162 struct objfile *
1163 symbol_file_add_from_bfd (bfd *abfd, const char *name,
1164 symfile_add_flags add_flags,
1165 section_addr_info *addrs,
1166 objfile_flags flags, struct objfile *parent)
1168 return symbol_file_add_with_addrs (abfd, name, add_flags, addrs, flags,
1169 parent);
1172 /* Process a symbol file, as either the main file or as a dynamically
1173 loaded file. See symbol_file_add_with_addrs's comments for details. */
1175 struct objfile *
1176 symbol_file_add (const char *name, symfile_add_flags add_flags,
1177 section_addr_info *addrs, objfile_flags flags)
1179 gdb_bfd_ref_ptr bfd (symfile_bfd_open (name));
1181 return symbol_file_add_from_bfd (bfd.get (), name, add_flags, addrs,
1182 flags, NULL);
1185 /* Call symbol_file_add() with default values and update whatever is
1186 affected by the loading of a new main().
1187 Used when the file is supplied in the gdb command line
1188 and by some targets with special loading requirements.
1189 The auxiliary function, symbol_file_add_main_1(), has the flags
1190 argument for the switches that can only be specified in the symbol_file
1191 command itself. */
1193 void
1194 symbol_file_add_main (const char *args, symfile_add_flags add_flags)
1196 symbol_file_add_main_1 (args, add_flags, 0, 0);
1199 static void
1200 symbol_file_add_main_1 (const char *args, symfile_add_flags add_flags,
1201 objfile_flags flags, CORE_ADDR reloff)
1203 add_flags |= current_inferior ()->symfile_flags | SYMFILE_MAINLINE;
1205 struct objfile *objfile = symbol_file_add (args, add_flags, NULL, flags);
1206 if (reloff != 0)
1207 objfile_rebase (objfile, reloff);
1209 /* Getting new symbols may change our opinion about
1210 what is frameless. */
1211 reinit_frame_cache ();
1213 if ((add_flags & SYMFILE_NO_READ) == 0)
1214 set_initial_language ();
1217 void
1218 symbol_file_clear (int from_tty)
1220 if ((have_full_symbols () || have_partial_symbols ())
1221 && from_tty
1222 && (current_program_space->symfile_object_file
1223 ? !query (_("Discard symbol table from `%s'? "),
1224 objfile_name (current_program_space->symfile_object_file))
1225 : !query (_("Discard symbol table? "))))
1226 error (_("Not confirmed."));
1228 /* solib descriptors may have handles to objfiles. Wipe them before their
1229 objfiles get stale by free_all_objfiles. */
1230 no_shared_libraries (NULL, from_tty);
1232 current_program_space->free_all_objfiles ();
1234 clear_symtab_users (0);
1236 gdb_assert (current_program_space->symfile_object_file == NULL);
1237 if (from_tty)
1238 gdb_printf (_("No symbol file now.\n"));
1241 /* See symfile.h. */
1243 bool separate_debug_file_debug = false;
1245 static int
1246 separate_debug_file_exists (const std::string &name, unsigned long crc,
1247 struct objfile *parent_objfile)
1249 unsigned long file_crc;
1250 int file_crc_p;
1251 struct stat parent_stat, abfd_stat;
1252 int verified_as_different;
1254 /* Find a separate debug info file as if symbols would be present in
1255 PARENT_OBJFILE itself this function would not be called. .gnu_debuglink
1256 section can contain just the basename of PARENT_OBJFILE without any
1257 ".debug" suffix as "/usr/lib/debug/path/to/file" is a separate tree where
1258 the separate debug infos with the same basename can exist. */
1260 if (filename_cmp (name.c_str (), objfile_name (parent_objfile)) == 0)
1261 return 0;
1263 if (separate_debug_file_debug)
1265 gdb_printf (gdb_stdlog, _(" Trying %s..."), name.c_str ());
1266 gdb_flush (gdb_stdlog);
1269 gdb_bfd_ref_ptr abfd (gdb_bfd_open (name.c_str (), gnutarget));
1271 if (abfd == NULL)
1273 if (separate_debug_file_debug)
1274 gdb_printf (gdb_stdlog, _(" no, unable to open.\n"));
1276 return 0;
1279 /* Verify symlinks were not the cause of filename_cmp name difference above.
1281 Some operating systems, e.g. Windows, do not provide a meaningful
1282 st_ino; they always set it to zero. (Windows does provide a
1283 meaningful st_dev.) Files accessed from gdbservers that do not
1284 support the vFile:fstat packet will also have st_ino set to zero.
1285 Do not indicate a duplicate library in either case. While there
1286 is no guarantee that a system that provides meaningful inode
1287 numbers will never set st_ino to zero, this is merely an
1288 optimization, so we do not need to worry about false negatives. */
1290 if (bfd_stat (abfd.get (), &abfd_stat) == 0
1291 && abfd_stat.st_ino != 0
1292 && bfd_stat (parent_objfile->obfd, &parent_stat) == 0)
1294 if (abfd_stat.st_dev == parent_stat.st_dev
1295 && abfd_stat.st_ino == parent_stat.st_ino)
1297 if (separate_debug_file_debug)
1298 gdb_printf (gdb_stdlog,
1299 _(" no, same file as the objfile.\n"));
1301 return 0;
1303 verified_as_different = 1;
1305 else
1306 verified_as_different = 0;
1308 file_crc_p = gdb_bfd_crc (abfd.get (), &file_crc);
1310 if (!file_crc_p)
1312 if (separate_debug_file_debug)
1313 gdb_printf (gdb_stdlog, _(" no, error computing CRC.\n"));
1315 return 0;
1318 if (crc != file_crc)
1320 unsigned long parent_crc;
1322 /* If the files could not be verified as different with
1323 bfd_stat then we need to calculate the parent's CRC
1324 to verify whether the files are different or not. */
1326 if (!verified_as_different)
1328 if (!gdb_bfd_crc (parent_objfile->obfd, &parent_crc))
1330 if (separate_debug_file_debug)
1331 gdb_printf (gdb_stdlog,
1332 _(" no, error computing CRC.\n"));
1334 return 0;
1338 if (verified_as_different || parent_crc != file_crc)
1339 warning (_("the debug information found in \"%s\""
1340 " does not match \"%s\" (CRC mismatch).\n"),
1341 name.c_str (), objfile_name (parent_objfile));
1343 if (separate_debug_file_debug)
1344 gdb_printf (gdb_stdlog, _(" no, CRC doesn't match.\n"));
1346 return 0;
1349 if (separate_debug_file_debug)
1350 gdb_printf (gdb_stdlog, _(" yes!\n"));
1352 return 1;
1355 std::string debug_file_directory;
1356 static void
1357 show_debug_file_directory (struct ui_file *file, int from_tty,
1358 struct cmd_list_element *c, const char *value)
1360 gdb_printf (file,
1361 _("The directory where separate debug "
1362 "symbols are searched for is \"%s\".\n"),
1363 value);
1366 #if ! defined (DEBUG_SUBDIRECTORY)
1367 #define DEBUG_SUBDIRECTORY ".debug"
1368 #endif
1370 /* Find a separate debuginfo file for OBJFILE, using DIR as the directory
1371 where the original file resides (may not be the same as
1372 dirname(objfile->name) due to symlinks), and DEBUGLINK as the file we are
1373 looking for. CANON_DIR is the "realpath" form of DIR.
1374 DIR must contain a trailing '/'.
1375 Returns the path of the file with separate debug info, or an empty
1376 string. */
1378 static std::string
1379 find_separate_debug_file (const char *dir,
1380 const char *canon_dir,
1381 const char *debuglink,
1382 unsigned long crc32, struct objfile *objfile)
1384 if (separate_debug_file_debug)
1385 gdb_printf (gdb_stdlog,
1386 _("\nLooking for separate debug info (debug link) for "
1387 "%s\n"), objfile_name (objfile));
1389 /* First try in the same directory as the original file. */
1390 std::string debugfile = dir;
1391 debugfile += debuglink;
1393 if (separate_debug_file_exists (debugfile, crc32, objfile))
1394 return debugfile;
1396 /* Then try in the subdirectory named DEBUG_SUBDIRECTORY. */
1397 debugfile = dir;
1398 debugfile += DEBUG_SUBDIRECTORY;
1399 debugfile += "/";
1400 debugfile += debuglink;
1402 if (separate_debug_file_exists (debugfile, crc32, objfile))
1403 return debugfile;
1405 /* Then try in the global debugfile directories.
1407 Keep backward compatibility so that DEBUG_FILE_DIRECTORY being "" will
1408 cause "/..." lookups. */
1410 bool target_prefix = startswith (dir, "target:");
1411 const char *dir_notarget = target_prefix ? dir + strlen ("target:") : dir;
1412 std::vector<gdb::unique_xmalloc_ptr<char>> debugdir_vec
1413 = dirnames_to_char_ptr_vec (debug_file_directory.c_str ());
1414 gdb::unique_xmalloc_ptr<char> canon_sysroot
1415 = gdb_realpath (gdb_sysroot.c_str ());
1417 /* MS-Windows/MS-DOS don't allow colons in file names; we must
1418 convert the drive letter into a one-letter directory, so that the
1419 file name resulting from splicing below will be valid.
1421 FIXME: The below only works when GDB runs on MS-Windows/MS-DOS.
1422 There are various remote-debugging scenarios where such a
1423 transformation of the drive letter might be required when GDB runs
1424 on a Posix host, see
1426 https://sourceware.org/ml/gdb-patches/2019-04/msg00605.html
1428 If some of those scenarios need to be supported, we will need to
1429 use a different condition for HAS_DRIVE_SPEC and a different macro
1430 instead of STRIP_DRIVE_SPEC, which work on Posix systems as well. */
1431 std::string drive;
1432 if (HAS_DRIVE_SPEC (dir_notarget))
1434 drive = dir_notarget[0];
1435 dir_notarget = STRIP_DRIVE_SPEC (dir_notarget);
1438 for (const gdb::unique_xmalloc_ptr<char> &debugdir : debugdir_vec)
1440 debugfile = target_prefix ? "target:" : "";
1441 debugfile += debugdir;
1442 debugfile += "/";
1443 debugfile += drive;
1444 debugfile += dir_notarget;
1445 debugfile += debuglink;
1447 if (separate_debug_file_exists (debugfile, crc32, objfile))
1448 return debugfile;
1450 const char *base_path = NULL;
1451 if (canon_dir != NULL)
1453 if (canon_sysroot.get () != NULL)
1454 base_path = child_path (canon_sysroot.get (), canon_dir);
1455 else
1456 base_path = child_path (gdb_sysroot.c_str (), canon_dir);
1458 if (base_path != NULL)
1460 /* If the file is in the sysroot, try using its base path in
1461 the global debugfile directory. */
1462 debugfile = target_prefix ? "target:" : "";
1463 debugfile += debugdir;
1464 debugfile += "/";
1465 debugfile += base_path;
1466 debugfile += "/";
1467 debugfile += debuglink;
1469 if (separate_debug_file_exists (debugfile, crc32, objfile))
1470 return debugfile;
1472 /* If the file is in the sysroot, try using its base path in
1473 the sysroot's global debugfile directory. */
1474 debugfile = target_prefix ? "target:" : "";
1475 debugfile += gdb_sysroot;
1476 debugfile += debugdir;
1477 debugfile += "/";
1478 debugfile += base_path;
1479 debugfile += "/";
1480 debugfile += debuglink;
1482 if (separate_debug_file_exists (debugfile, crc32, objfile))
1483 return debugfile;
1488 return std::string ();
1491 /* Modify PATH to contain only "[/]directory/" part of PATH.
1492 If there were no directory separators in PATH, PATH will be empty
1493 string on return. */
1495 static void
1496 terminate_after_last_dir_separator (char *path)
1498 int i;
1500 /* Strip off the final filename part, leaving the directory name,
1501 followed by a slash. The directory can be relative or absolute. */
1502 for (i = strlen(path) - 1; i >= 0; i--)
1503 if (IS_DIR_SEPARATOR (path[i]))
1504 break;
1506 /* If I is -1 then no directory is present there and DIR will be "". */
1507 path[i + 1] = '\0';
1510 /* Find separate debuginfo for OBJFILE (using .gnu_debuglink section).
1511 Returns pathname, or an empty string. */
1513 std::string
1514 find_separate_debug_file_by_debuglink (struct objfile *objfile)
1516 unsigned long crc32;
1518 gdb::unique_xmalloc_ptr<char> debuglink
1519 (bfd_get_debug_link_info (objfile->obfd, &crc32));
1521 if (debuglink == NULL)
1523 /* There's no separate debug info, hence there's no way we could
1524 load it => no warning. */
1525 return std::string ();
1528 std::string dir = objfile_name (objfile);
1529 terminate_after_last_dir_separator (&dir[0]);
1530 gdb::unique_xmalloc_ptr<char> canon_dir (lrealpath (dir.c_str ()));
1532 std::string debugfile
1533 = find_separate_debug_file (dir.c_str (), canon_dir.get (),
1534 debuglink.get (), crc32, objfile);
1536 if (debugfile.empty ())
1538 /* For PR gdb/9538, try again with realpath (if different from the
1539 original). */
1541 struct stat st_buf;
1543 if (lstat (objfile_name (objfile), &st_buf) == 0
1544 && S_ISLNK (st_buf.st_mode))
1546 gdb::unique_xmalloc_ptr<char> symlink_dir
1547 (lrealpath (objfile_name (objfile)));
1548 if (symlink_dir != NULL)
1550 terminate_after_last_dir_separator (symlink_dir.get ());
1551 if (dir != symlink_dir.get ())
1553 /* Different directory, so try using it. */
1554 debugfile = find_separate_debug_file (symlink_dir.get (),
1555 symlink_dir.get (),
1556 debuglink.get (),
1557 crc32,
1558 objfile);
1564 return debugfile;
1567 /* Make sure that OBJF_{READNOW,READNEVER} are not set
1568 simultaneously. */
1570 static void
1571 validate_readnow_readnever (objfile_flags flags)
1573 if ((flags & OBJF_READNOW) && (flags & OBJF_READNEVER))
1574 error (_("-readnow and -readnever cannot be used simultaneously"));
1577 /* This is the symbol-file command. Read the file, analyze its
1578 symbols, and add a struct symtab to a symtab list. The syntax of
1579 the command is rather bizarre:
1581 1. The function buildargv implements various quoting conventions
1582 which are undocumented and have little or nothing in common with
1583 the way things are quoted (or not quoted) elsewhere in GDB.
1585 2. Options are used, which are not generally used in GDB (perhaps
1586 "set mapped on", "set readnow on" would be better)
1588 3. The order of options matters, which is contrary to GNU
1589 conventions (because it is confusing and inconvenient). */
1591 void
1592 symbol_file_command (const char *args, int from_tty)
1594 dont_repeat ();
1596 if (args == NULL)
1598 symbol_file_clear (from_tty);
1600 else
1602 objfile_flags flags = OBJF_USERLOADED;
1603 symfile_add_flags add_flags = 0;
1604 char *name = NULL;
1605 bool stop_processing_options = false;
1606 CORE_ADDR offset = 0;
1607 int idx;
1608 char *arg;
1610 if (from_tty)
1611 add_flags |= SYMFILE_VERBOSE;
1613 gdb_argv built_argv (args);
1614 for (arg = built_argv[0], idx = 0; arg != NULL; arg = built_argv[++idx])
1616 if (stop_processing_options || *arg != '-')
1618 if (name == NULL)
1619 name = arg;
1620 else
1621 error (_("Unrecognized argument \"%s\""), arg);
1623 else if (strcmp (arg, "-readnow") == 0)
1624 flags |= OBJF_READNOW;
1625 else if (strcmp (arg, "-readnever") == 0)
1626 flags |= OBJF_READNEVER;
1627 else if (strcmp (arg, "-o") == 0)
1629 arg = built_argv[++idx];
1630 if (arg == NULL)
1631 error (_("Missing argument to -o"));
1633 offset = parse_and_eval_address (arg);
1635 else if (strcmp (arg, "--") == 0)
1636 stop_processing_options = true;
1637 else
1638 error (_("Unrecognized argument \"%s\""), arg);
1641 if (name == NULL)
1642 error (_("no symbol file name was specified"));
1644 validate_readnow_readnever (flags);
1646 /* Set SYMFILE_DEFER_BP_RESET because the proper displacement for a PIE
1647 (Position Independent Executable) main symbol file will only be
1648 computed by the solib_create_inferior_hook below. Without it,
1649 breakpoint_re_set would fail to insert the breakpoints with the zero
1650 displacement. */
1651 add_flags |= SYMFILE_DEFER_BP_RESET;
1653 symbol_file_add_main_1 (name, add_flags, flags, offset);
1655 solib_create_inferior_hook (from_tty);
1657 /* Now it's safe to re-add the breakpoints. */
1658 breakpoint_re_set ();
1662 /* Set the initial language. */
1664 void
1665 set_initial_language (void)
1667 if (language_mode == language_mode_manual)
1668 return;
1669 enum language lang = main_language ();
1670 /* Make C the default language. */
1671 enum language default_lang = language_c;
1673 if (lang == language_unknown)
1675 const char *name = main_name ();
1676 struct symbol *sym
1677 = lookup_symbol_in_language (name, NULL, VAR_DOMAIN, default_lang,
1678 NULL).symbol;
1680 if (sym != NULL)
1681 lang = sym->language ();
1684 if (lang == language_unknown)
1686 lang = default_lang;
1689 set_language (lang);
1690 expected_language = current_language; /* Don't warn the user. */
1693 /* Open the file specified by NAME and hand it off to BFD for
1694 preliminary analysis. Return a newly initialized bfd *, which
1695 includes a newly malloc'd` copy of NAME (tilde-expanded and made
1696 absolute). In case of trouble, error() is called. */
1698 gdb_bfd_ref_ptr
1699 symfile_bfd_open (const char *name)
1701 int desc = -1;
1703 gdb::unique_xmalloc_ptr<char> absolute_name;
1704 if (!is_target_filename (name))
1706 gdb::unique_xmalloc_ptr<char> expanded_name (tilde_expand (name));
1708 /* Look down path for it, allocate 2nd new malloc'd copy. */
1709 desc = openp (getenv ("PATH"),
1710 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
1711 expanded_name.get (), O_RDONLY | O_BINARY, &absolute_name);
1712 #if defined(__GO32__) || defined(_WIN32) || defined (__CYGWIN__)
1713 if (desc < 0)
1715 char *exename = (char *) alloca (strlen (expanded_name.get ()) + 5);
1717 strcat (strcpy (exename, expanded_name.get ()), ".exe");
1718 desc = openp (getenv ("PATH"),
1719 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
1720 exename, O_RDONLY | O_BINARY, &absolute_name);
1722 #endif
1723 if (desc < 0)
1724 perror_with_name (expanded_name.get ());
1726 name = absolute_name.get ();
1729 gdb_bfd_ref_ptr sym_bfd (gdb_bfd_open (name, gnutarget, desc));
1730 if (sym_bfd == NULL)
1731 error (_("`%s': can't open to read symbols: %s."), name,
1732 bfd_errmsg (bfd_get_error ()));
1734 if (!gdb_bfd_has_target_filename (sym_bfd.get ()))
1735 bfd_set_cacheable (sym_bfd.get (), 1);
1737 if (!bfd_check_format (sym_bfd.get (), bfd_object))
1738 error (_("`%s': can't read symbols: %s."), name,
1739 bfd_errmsg (bfd_get_error ()));
1741 return sym_bfd;
1744 /* Return the section index for SECTION_NAME on OBJFILE. Return -1 if
1745 the section was not found. */
1748 get_section_index (struct objfile *objfile, const char *section_name)
1750 asection *sect = bfd_get_section_by_name (objfile->obfd, section_name);
1752 if (sect)
1753 return sect->index;
1754 else
1755 return -1;
1758 /* Link SF into the global symtab_fns list.
1759 FLAVOUR is the file format that SF handles.
1760 Called on startup by the _initialize routine in each object file format
1761 reader, to register information about each format the reader is prepared
1762 to handle. */
1764 void
1765 add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *sf)
1767 symtab_fns.emplace_back (flavour, sf);
1770 /* Initialize OBJFILE to read symbols from its associated BFD. It
1771 either returns or calls error(). The result is an initialized
1772 struct sym_fns in the objfile structure, that contains cached
1773 information about the symbol file. */
1775 static const struct sym_fns *
1776 find_sym_fns (bfd *abfd)
1778 enum bfd_flavour our_flavour = bfd_get_flavour (abfd);
1780 if (our_flavour == bfd_target_srec_flavour
1781 || our_flavour == bfd_target_ihex_flavour
1782 || our_flavour == bfd_target_tekhex_flavour)
1783 return NULL; /* No symbols. */
1785 for (const registered_sym_fns &rsf : symtab_fns)
1786 if (our_flavour == rsf.sym_flavour)
1787 return rsf.sym_fns;
1789 error (_("I'm sorry, Dave, I can't do that. Symbol format `%s' unknown."),
1790 bfd_get_target (abfd));
1794 /* This function runs the load command of our current target. */
1796 static void
1797 load_command (const char *arg, int from_tty)
1799 dont_repeat ();
1801 /* The user might be reloading because the binary has changed. Take
1802 this opportunity to check. */
1803 reopen_exec_file ();
1804 reread_symbols (from_tty);
1806 std::string temp;
1807 if (arg == NULL)
1809 const char *parg, *prev;
1811 arg = get_exec_file (1);
1813 /* We may need to quote this string so buildargv can pull it
1814 apart. */
1815 prev = parg = arg;
1816 while ((parg = strpbrk (parg, "\\\"'\t ")))
1818 temp.append (prev, parg - prev);
1819 prev = parg++;
1820 temp.push_back ('\\');
1822 /* If we have not copied anything yet, then we didn't see a
1823 character to quote, and we can just leave ARG unchanged. */
1824 if (!temp.empty ())
1826 temp.append (prev);
1827 arg = temp.c_str ();
1831 target_load (arg, from_tty);
1833 /* After re-loading the executable, we don't really know which
1834 overlays are mapped any more. */
1835 overlay_cache_invalid = 1;
1838 /* This version of "load" should be usable for any target. Currently
1839 it is just used for remote targets, not inftarg.c or core files,
1840 on the theory that only in that case is it useful.
1842 Avoiding xmodem and the like seems like a win (a) because we don't have
1843 to worry about finding it, and (b) On VMS, fork() is very slow and so
1844 we don't want to run a subprocess. On the other hand, I'm not sure how
1845 performance compares. */
1847 static int validate_download = 0;
1849 /* Opaque data for load_progress. */
1850 struct load_progress_data
1852 /* Cumulative data. */
1853 unsigned long write_count = 0;
1854 unsigned long data_count = 0;
1855 bfd_size_type total_size = 0;
1858 /* Opaque data for load_progress for a single section. */
1859 struct load_progress_section_data
1861 load_progress_section_data (load_progress_data *cumulative_,
1862 const char *section_name_, ULONGEST section_size_,
1863 CORE_ADDR lma_, gdb_byte *buffer_)
1864 : cumulative (cumulative_), section_name (section_name_),
1865 section_size (section_size_), lma (lma_), buffer (buffer_)
1868 struct load_progress_data *cumulative;
1870 /* Per-section data. */
1871 const char *section_name;
1872 ULONGEST section_sent = 0;
1873 ULONGEST section_size;
1874 CORE_ADDR lma;
1875 gdb_byte *buffer;
1878 /* Opaque data for load_section_callback. */
1879 struct load_section_data
1881 load_section_data (load_progress_data *progress_data_)
1882 : progress_data (progress_data_)
1885 ~load_section_data ()
1887 for (auto &&request : requests)
1889 xfree (request.data);
1890 delete ((load_progress_section_data *) request.baton);
1894 CORE_ADDR load_offset = 0;
1895 struct load_progress_data *progress_data;
1896 std::vector<struct memory_write_request> requests;
1899 /* Target write callback routine for progress reporting. */
1901 static void
1902 load_progress (ULONGEST bytes, void *untyped_arg)
1904 struct load_progress_section_data *args
1905 = (struct load_progress_section_data *) untyped_arg;
1906 struct load_progress_data *totals;
1908 if (args == NULL)
1909 /* Writing padding data. No easy way to get at the cumulative
1910 stats, so just ignore this. */
1911 return;
1913 totals = args->cumulative;
1915 if (bytes == 0 && args->section_sent == 0)
1917 /* The write is just starting. Let the user know we've started
1918 this section. */
1919 current_uiout->message ("Loading section %s, size %s lma %s\n",
1920 args->section_name,
1921 hex_string (args->section_size),
1922 paddress (target_gdbarch (), args->lma));
1923 return;
1926 if (validate_download)
1928 /* Broken memories and broken monitors manifest themselves here
1929 when bring new computers to life. This doubles already slow
1930 downloads. */
1931 /* NOTE: cagney/1999-10-18: A more efficient implementation
1932 might add a verify_memory() method to the target vector and
1933 then use that. remote.c could implement that method using
1934 the ``qCRC'' packet. */
1935 gdb::byte_vector check (bytes);
1937 if (target_read_memory (args->lma, check.data (), bytes) != 0)
1938 error (_("Download verify read failed at %s"),
1939 paddress (target_gdbarch (), args->lma));
1940 if (memcmp (args->buffer, check.data (), bytes) != 0)
1941 error (_("Download verify compare failed at %s"),
1942 paddress (target_gdbarch (), args->lma));
1944 totals->data_count += bytes;
1945 args->lma += bytes;
1946 args->buffer += bytes;
1947 totals->write_count += 1;
1948 args->section_sent += bytes;
1949 if (check_quit_flag ()
1950 || (deprecated_ui_load_progress_hook != NULL
1951 && deprecated_ui_load_progress_hook (args->section_name,
1952 args->section_sent)))
1953 error (_("Canceled the download"));
1955 if (deprecated_show_load_progress != NULL)
1956 deprecated_show_load_progress (args->section_name,
1957 args->section_sent,
1958 args->section_size,
1959 totals->data_count,
1960 totals->total_size);
1963 /* Service function for generic_load. */
1965 static void
1966 load_one_section (bfd *abfd, asection *asec,
1967 struct load_section_data *args)
1969 bfd_size_type size = bfd_section_size (asec);
1970 const char *sect_name = bfd_section_name (asec);
1972 if ((bfd_section_flags (asec) & SEC_LOAD) == 0)
1973 return;
1975 if (size == 0)
1976 return;
1978 ULONGEST begin = bfd_section_lma (asec) + args->load_offset;
1979 ULONGEST end = begin + size;
1980 gdb_byte *buffer = (gdb_byte *) xmalloc (size);
1981 bfd_get_section_contents (abfd, asec, buffer, 0, size);
1983 load_progress_section_data *section_data
1984 = new load_progress_section_data (args->progress_data, sect_name, size,
1985 begin, buffer);
1987 args->requests.emplace_back (begin, end, buffer, section_data);
1990 static void print_transfer_performance (struct ui_file *stream,
1991 unsigned long data_count,
1992 unsigned long write_count,
1993 std::chrono::steady_clock::duration d);
1995 /* See symfile.h. */
1997 void
1998 generic_load (const char *args, int from_tty)
2000 struct load_progress_data total_progress;
2001 struct load_section_data cbdata (&total_progress);
2002 struct ui_out *uiout = current_uiout;
2004 if (args == NULL)
2005 error_no_arg (_("file to load"));
2007 gdb_argv argv (args);
2009 gdb::unique_xmalloc_ptr<char> filename (tilde_expand (argv[0]));
2011 if (argv[1] != NULL)
2013 const char *endptr;
2015 cbdata.load_offset = strtoulst (argv[1], &endptr, 0);
2017 /* If the last word was not a valid number then
2018 treat it as a file name with spaces in. */
2019 if (argv[1] == endptr)
2020 error (_("Invalid download offset:%s."), argv[1]);
2022 if (argv[2] != NULL)
2023 error (_("Too many parameters."));
2026 /* Open the file for loading. */
2027 gdb_bfd_ref_ptr loadfile_bfd (gdb_bfd_open (filename.get (), gnutarget));
2028 if (loadfile_bfd == NULL)
2029 perror_with_name (filename.get ());
2031 if (!bfd_check_format (loadfile_bfd.get (), bfd_object))
2033 error (_("\"%s\" is not an object file: %s"), filename.get (),
2034 bfd_errmsg (bfd_get_error ()));
2037 for (asection *asec : gdb_bfd_sections (loadfile_bfd))
2038 total_progress.total_size += bfd_section_size (asec);
2040 for (asection *asec : gdb_bfd_sections (loadfile_bfd))
2041 load_one_section (loadfile_bfd.get (), asec, &cbdata);
2043 using namespace std::chrono;
2045 steady_clock::time_point start_time = steady_clock::now ();
2047 if (target_write_memory_blocks (cbdata.requests, flash_discard,
2048 load_progress) != 0)
2049 error (_("Load failed"));
2051 steady_clock::time_point end_time = steady_clock::now ();
2053 CORE_ADDR entry = bfd_get_start_address (loadfile_bfd.get ());
2054 entry = gdbarch_addr_bits_remove (target_gdbarch (), entry);
2055 uiout->text ("Start address ");
2056 uiout->field_core_addr ("address", target_gdbarch (), entry);
2057 uiout->text (", load size ");
2058 uiout->field_unsigned ("load-size", total_progress.data_count);
2059 uiout->text ("\n");
2060 regcache_write_pc (get_current_regcache (), entry);
2062 /* Reset breakpoints, now that we have changed the load image. For
2063 instance, breakpoints may have been set (or reset, by
2064 post_create_inferior) while connected to the target but before we
2065 loaded the program. In that case, the prologue analyzer could
2066 have read instructions from the target to find the right
2067 breakpoint locations. Loading has changed the contents of that
2068 memory. */
2070 breakpoint_re_set ();
2072 print_transfer_performance (gdb_stdout, total_progress.data_count,
2073 total_progress.write_count,
2074 end_time - start_time);
2077 /* Report on STREAM the performance of a memory transfer operation,
2078 such as 'load'. DATA_COUNT is the number of bytes transferred.
2079 WRITE_COUNT is the number of separate write operations, or 0, if
2080 that information is not available. TIME is how long the operation
2081 lasted. */
2083 static void
2084 print_transfer_performance (struct ui_file *stream,
2085 unsigned long data_count,
2086 unsigned long write_count,
2087 std::chrono::steady_clock::duration time)
2089 using namespace std::chrono;
2090 struct ui_out *uiout = current_uiout;
2092 milliseconds ms = duration_cast<milliseconds> (time);
2094 uiout->text ("Transfer rate: ");
2095 if (ms.count () > 0)
2097 unsigned long rate = ((ULONGEST) data_count * 1000) / ms.count ();
2099 if (uiout->is_mi_like_p ())
2101 uiout->field_unsigned ("transfer-rate", rate * 8);
2102 uiout->text (" bits/sec");
2104 else if (rate < 1024)
2106 uiout->field_unsigned ("transfer-rate", rate);
2107 uiout->text (" bytes/sec");
2109 else
2111 uiout->field_unsigned ("transfer-rate", rate / 1024);
2112 uiout->text (" KB/sec");
2115 else
2117 uiout->field_unsigned ("transferred-bits", (data_count * 8));
2118 uiout->text (" bits in <1 sec");
2120 if (write_count > 0)
2122 uiout->text (", ");
2123 uiout->field_unsigned ("write-rate", data_count / write_count);
2124 uiout->text (" bytes/write");
2126 uiout->text (".\n");
2129 /* Add an OFFSET to the start address of each section in OBJF, except
2130 sections that were specified in ADDRS. */
2132 static void
2133 set_objfile_default_section_offset (struct objfile *objf,
2134 const section_addr_info &addrs,
2135 CORE_ADDR offset)
2137 /* Add OFFSET to all sections by default. */
2138 section_offsets offsets (objf->section_offsets.size (), offset);
2140 /* Create sorted lists of all sections in ADDRS as well as all
2141 sections in OBJF. */
2143 std::vector<const struct other_sections *> addrs_sorted
2144 = addrs_section_sort (addrs);
2146 section_addr_info objf_addrs
2147 = build_section_addr_info_from_objfile (objf);
2148 std::vector<const struct other_sections *> objf_addrs_sorted
2149 = addrs_section_sort (objf_addrs);
2151 /* Walk the BFD section list, and if a matching section is found in
2152 ADDRS_SORTED_LIST, set its offset to zero to keep its address
2153 unchanged.
2155 Note that both lists may contain multiple sections with the same
2156 name, and then the sections from ADDRS are matched in BFD order
2157 (thanks to sectindex). */
2159 std::vector<const struct other_sections *>::iterator addrs_sorted_iter
2160 = addrs_sorted.begin ();
2161 for (const other_sections *objf_sect : objf_addrs_sorted)
2163 const char *objf_name = addr_section_name (objf_sect->name.c_str ());
2164 int cmp = -1;
2166 while (cmp < 0 && addrs_sorted_iter != addrs_sorted.end ())
2168 const struct other_sections *sect = *addrs_sorted_iter;
2169 const char *sect_name = addr_section_name (sect->name.c_str ());
2170 cmp = strcmp (sect_name, objf_name);
2171 if (cmp <= 0)
2172 ++addrs_sorted_iter;
2175 if (cmp == 0)
2176 offsets[objf_sect->sectindex] = 0;
2179 /* Apply the new section offsets. */
2180 objfile_relocate (objf, offsets);
2183 /* This function allows the addition of incrementally linked object files.
2184 It does not modify any state in the target, only in the debugger. */
2186 static void
2187 add_symbol_file_command (const char *args, int from_tty)
2189 struct gdbarch *gdbarch = get_current_arch ();
2190 gdb::unique_xmalloc_ptr<char> filename;
2191 char *arg;
2192 int argcnt = 0;
2193 struct objfile *objf;
2194 objfile_flags flags = OBJF_USERLOADED | OBJF_SHARED;
2195 symfile_add_flags add_flags = 0;
2197 if (from_tty)
2198 add_flags |= SYMFILE_VERBOSE;
2200 struct sect_opt
2202 const char *name;
2203 const char *value;
2206 std::vector<sect_opt> sect_opts = { { ".text", NULL } };
2207 bool stop_processing_options = false;
2208 CORE_ADDR offset = 0;
2210 dont_repeat ();
2212 if (args == NULL)
2213 error (_("add-symbol-file takes a file name and an address"));
2215 bool seen_addr = false;
2216 bool seen_offset = false;
2217 gdb_argv argv (args);
2219 for (arg = argv[0], argcnt = 0; arg != NULL; arg = argv[++argcnt])
2221 if (stop_processing_options || *arg != '-')
2223 if (filename == NULL)
2225 /* First non-option argument is always the filename. */
2226 filename.reset (tilde_expand (arg));
2228 else if (!seen_addr)
2230 /* The second non-option argument is always the text
2231 address at which to load the program. */
2232 sect_opts[0].value = arg;
2233 seen_addr = true;
2235 else
2236 error (_("Unrecognized argument \"%s\""), arg);
2238 else if (strcmp (arg, "-readnow") == 0)
2239 flags |= OBJF_READNOW;
2240 else if (strcmp (arg, "-readnever") == 0)
2241 flags |= OBJF_READNEVER;
2242 else if (strcmp (arg, "-s") == 0)
2244 if (argv[argcnt + 1] == NULL)
2245 error (_("Missing section name after \"-s\""));
2246 else if (argv[argcnt + 2] == NULL)
2247 error (_("Missing section address after \"-s\""));
2249 sect_opt sect = { argv[argcnt + 1], argv[argcnt + 2] };
2251 sect_opts.push_back (sect);
2252 argcnt += 2;
2254 else if (strcmp (arg, "-o") == 0)
2256 arg = argv[++argcnt];
2257 if (arg == NULL)
2258 error (_("Missing argument to -o"));
2260 offset = parse_and_eval_address (arg);
2261 seen_offset = true;
2263 else if (strcmp (arg, "--") == 0)
2264 stop_processing_options = true;
2265 else
2266 error (_("Unrecognized argument \"%s\""), arg);
2269 if (filename == NULL)
2270 error (_("You must provide a filename to be loaded."));
2272 validate_readnow_readnever (flags);
2274 /* Print the prompt for the query below. And save the arguments into
2275 a sect_addr_info structure to be passed around to other
2276 functions. We have to split this up into separate print
2277 statements because hex_string returns a local static
2278 string. */
2280 gdb_printf (_("add symbol table from file \"%s\""),
2281 filename.get ());
2282 section_addr_info section_addrs;
2283 std::vector<sect_opt>::const_iterator it = sect_opts.begin ();
2284 if (!seen_addr)
2285 ++it;
2286 for (; it != sect_opts.end (); ++it)
2288 CORE_ADDR addr;
2289 const char *val = it->value;
2290 const char *sec = it->name;
2292 if (section_addrs.empty ())
2293 gdb_printf (_(" at\n"));
2294 addr = parse_and_eval_address (val);
2296 /* Here we store the section offsets in the order they were
2297 entered on the command line. Every array element is
2298 assigned an ascending section index to preserve the above
2299 order over an unstable sorting algorithm. This dummy
2300 index is not used for any other purpose.
2302 section_addrs.emplace_back (addr, sec, section_addrs.size ());
2303 gdb_printf ("\t%s_addr = %s\n", sec,
2304 paddress (gdbarch, addr));
2306 /* The object's sections are initialized when a
2307 call is made to build_objfile_section_table (objfile).
2308 This happens in reread_symbols.
2309 At this point, we don't know what file type this is,
2310 so we can't determine what section names are valid. */
2312 if (seen_offset)
2313 gdb_printf (_("%s offset by %s\n"),
2314 (section_addrs.empty ()
2315 ? _(" with all sections")
2316 : _("with other sections")),
2317 paddress (gdbarch, offset));
2318 else if (section_addrs.empty ())
2319 gdb_printf ("\n");
2321 if (from_tty && (!query ("%s", "")))
2322 error (_("Not confirmed."));
2324 objf = symbol_file_add (filename.get (), add_flags, &section_addrs,
2325 flags);
2326 if (!objfile_has_symbols (objf) && objf->per_bfd->minimal_symbol_count <= 0)
2327 warning (_("newly-added symbol file \"%s\" does not provide any symbols"),
2328 filename.get ());
2330 if (seen_offset)
2331 set_objfile_default_section_offset (objf, section_addrs, offset);
2333 current_program_space->add_target_sections (objf);
2335 /* Getting new symbols may change our opinion about what is
2336 frameless. */
2337 reinit_frame_cache ();
2341 /* This function removes a symbol file that was added via add-symbol-file. */
2343 static void
2344 remove_symbol_file_command (const char *args, int from_tty)
2346 struct objfile *objf = NULL;
2347 struct program_space *pspace = current_program_space;
2349 dont_repeat ();
2351 if (args == NULL)
2352 error (_("remove-symbol-file: no symbol file provided"));
2354 gdb_argv argv (args);
2356 if (strcmp (argv[0], "-a") == 0)
2358 /* Interpret the next argument as an address. */
2359 CORE_ADDR addr;
2361 if (argv[1] == NULL)
2362 error (_("Missing address argument"));
2364 if (argv[2] != NULL)
2365 error (_("Junk after %s"), argv[1]);
2367 addr = parse_and_eval_address (argv[1]);
2369 for (objfile *objfile : current_program_space->objfiles ())
2371 if ((objfile->flags & OBJF_USERLOADED) != 0
2372 && (objfile->flags & OBJF_SHARED) != 0
2373 && objfile->pspace == pspace
2374 && is_addr_in_objfile (addr, objfile))
2376 objf = objfile;
2377 break;
2381 else if (argv[0] != NULL)
2383 /* Interpret the current argument as a file name. */
2385 if (argv[1] != NULL)
2386 error (_("Junk after %s"), argv[0]);
2388 gdb::unique_xmalloc_ptr<char> filename (tilde_expand (argv[0]));
2390 for (objfile *objfile : current_program_space->objfiles ())
2392 if ((objfile->flags & OBJF_USERLOADED) != 0
2393 && (objfile->flags & OBJF_SHARED) != 0
2394 && objfile->pspace == pspace
2395 && filename_cmp (filename.get (), objfile_name (objfile)) == 0)
2397 objf = objfile;
2398 break;
2403 if (objf == NULL)
2404 error (_("No symbol file found"));
2406 if (from_tty
2407 && !query (_("Remove symbol table from file \"%s\"? "),
2408 objfile_name (objf)))
2409 error (_("Not confirmed."));
2411 objf->unlink ();
2412 clear_symtab_users (0);
2415 /* Re-read symbols if a symbol-file has changed. */
2417 void
2418 reread_symbols (int from_tty)
2420 long new_modtime;
2421 struct stat new_statbuf;
2422 int res;
2423 std::vector<struct objfile *> new_objfiles;
2425 for (objfile *objfile : current_program_space->objfiles ())
2427 if (objfile->obfd == NULL)
2428 continue;
2430 /* Separate debug objfiles are handled in the main objfile. */
2431 if (objfile->separate_debug_objfile_backlink)
2432 continue;
2434 /* If this object is from an archive (what you usually create with
2435 `ar', often called a `static library' on most systems, though
2436 a `shared library' on AIX is also an archive), then you should
2437 stat on the archive name, not member name. */
2438 if (objfile->obfd->my_archive)
2439 res = stat (bfd_get_filename (objfile->obfd->my_archive), &new_statbuf);
2440 else
2441 res = stat (objfile_name (objfile), &new_statbuf);
2442 if (res != 0)
2444 /* FIXME, should use print_sys_errmsg but it's not filtered. */
2445 gdb_printf (_("`%s' has disappeared; keeping its symbols.\n"),
2446 objfile_name (objfile));
2447 continue;
2449 new_modtime = new_statbuf.st_mtime;
2450 if (new_modtime != objfile->mtime)
2452 gdb_printf (_("`%s' has changed; re-reading symbols.\n"),
2453 objfile_name (objfile));
2455 /* There are various functions like symbol_file_add,
2456 symfile_bfd_open, syms_from_objfile, etc., which might
2457 appear to do what we want. But they have various other
2458 effects which we *don't* want. So we just do stuff
2459 ourselves. We don't worry about mapped files (for one thing,
2460 any mapped file will be out of date). */
2462 /* If we get an error, blow away this objfile (not sure if
2463 that is the correct response for things like shared
2464 libraries). */
2465 objfile_up objfile_holder (objfile);
2467 /* We need to do this whenever any symbols go away. */
2468 clear_symtab_users_cleanup defer_clear_users (0);
2470 if (current_program_space->exec_bfd () != NULL
2471 && filename_cmp (bfd_get_filename (objfile->obfd),
2472 bfd_get_filename (current_program_space->exec_bfd ())) == 0)
2474 /* Reload EXEC_BFD without asking anything. */
2476 exec_file_attach (bfd_get_filename (objfile->obfd), 0);
2479 /* Keep the calls order approx. the same as in free_objfile. */
2481 /* Free the separate debug objfiles. It will be
2482 automatically recreated by sym_read. */
2483 free_objfile_separate_debug (objfile);
2485 /* Clear the stale source cache. */
2486 forget_cached_source_info ();
2488 /* Remove any references to this objfile in the global
2489 value lists. */
2490 preserve_values (objfile);
2492 /* Nuke all the state that we will re-read. Much of the following
2493 code which sets things to NULL really is necessary to tell
2494 other parts of GDB that there is nothing currently there.
2496 Try to keep the freeing order compatible with free_objfile. */
2498 if (objfile->sf != NULL)
2500 (*objfile->sf->sym_finish) (objfile);
2503 objfile->registry_fields.clear_registry ();
2505 /* Clean up any state BFD has sitting around. */
2507 gdb_bfd_ref_ptr obfd (objfile->obfd);
2508 const char *obfd_filename;
2510 obfd_filename = bfd_get_filename (objfile->obfd);
2511 /* Open the new BFD before freeing the old one, so that
2512 the filename remains live. */
2513 gdb_bfd_ref_ptr temp (gdb_bfd_open (obfd_filename, gnutarget));
2514 objfile->obfd = temp.release ();
2515 if (objfile->obfd == NULL)
2516 error (_("Can't open %s to read symbols."), obfd_filename);
2519 std::string original_name = objfile->original_name;
2521 /* bfd_openr sets cacheable to true, which is what we want. */
2522 if (!bfd_check_format (objfile->obfd, bfd_object))
2523 error (_("Can't read symbols from %s: %s."), objfile_name (objfile),
2524 bfd_errmsg (bfd_get_error ()));
2526 /* NB: after this call to obstack_free, objfiles_changed
2527 will need to be called (see discussion below). */
2528 obstack_free (&objfile->objfile_obstack, 0);
2529 objfile->sections = NULL;
2530 objfile->section_offsets.clear ();
2531 objfile->sect_index_bss = -1;
2532 objfile->sect_index_data = -1;
2533 objfile->sect_index_rodata = -1;
2534 objfile->sect_index_text = -1;
2535 objfile->compunit_symtabs = NULL;
2536 objfile->template_symbols = NULL;
2537 objfile->static_links.reset (nullptr);
2539 /* obstack_init also initializes the obstack so it is
2540 empty. We could use obstack_specify_allocation but
2541 gdb_obstack.h specifies the alloc/dealloc functions. */
2542 obstack_init (&objfile->objfile_obstack);
2544 /* set_objfile_per_bfd potentially allocates the per-bfd
2545 data on the objfile's obstack (if sharing data across
2546 multiple users is not possible), so it's important to
2547 do it *after* the obstack has been initialized. */
2548 set_objfile_per_bfd (objfile);
2550 objfile->original_name
2551 = obstack_strdup (&objfile->objfile_obstack, original_name);
2553 /* Reset the sym_fns pointer. The ELF reader can change it
2554 based on whether .gdb_index is present, and we need it to
2555 start over. PR symtab/15885 */
2556 objfile_set_sym_fns (objfile, find_sym_fns (objfile->obfd));
2557 objfile->qf.clear ();
2559 build_objfile_section_table (objfile);
2561 /* What the hell is sym_new_init for, anyway? The concept of
2562 distinguishing between the main file and additional files
2563 in this way seems rather dubious. */
2564 if (objfile == current_program_space->symfile_object_file)
2566 (*objfile->sf->sym_new_init) (objfile);
2569 (*objfile->sf->sym_init) (objfile);
2570 clear_complaints ();
2572 objfile->flags &= ~OBJF_PSYMTABS_READ;
2574 /* We are about to read new symbols and potentially also
2575 DWARF information. Some targets may want to pass addresses
2576 read from DWARF DIE's through an adjustment function before
2577 saving them, like MIPS, which may call into
2578 "find_pc_section". When called, that function will make
2579 use of per-objfile program space data.
2581 Since we discarded our section information above, we have
2582 dangling pointers in the per-objfile program space data
2583 structure. Force GDB to update the section mapping
2584 information by letting it know the objfile has changed,
2585 making the dangling pointers point to correct data
2586 again. */
2588 objfiles_changed ();
2590 /* Recompute section offsets and section indices. */
2591 objfile->sf->sym_offsets (objfile, {});
2593 read_symbols (objfile, 0);
2595 if ((objfile->flags & OBJF_READNOW))
2597 const int mainline = objfile->flags & OBJF_MAINLINE;
2598 const int should_print = (print_symbol_loading_p (from_tty, mainline, 1)
2599 && readnow_symbol_files);
2600 if (should_print)
2601 gdb_printf (_("Expanding full symbols from %ps...\n"),
2602 styled_string (file_name_style.style (),
2603 objfile_name (objfile)));
2605 objfile->expand_all_symtabs ();
2608 if (!objfile_has_symbols (objfile))
2610 gdb_stdout->wrap_here (0);
2611 gdb_printf (_("(no debugging symbols found)\n"));
2612 gdb_stdout->wrap_here (0);
2615 /* We're done reading the symbol file; finish off complaints. */
2616 clear_complaints ();
2618 /* Getting new symbols may change our opinion about what is
2619 frameless. */
2621 reinit_frame_cache ();
2623 /* Discard cleanups as symbol reading was successful. */
2624 objfile_holder.release ();
2625 defer_clear_users.release ();
2627 /* If the mtime has changed between the time we set new_modtime
2628 and now, we *want* this to be out of date, so don't call stat
2629 again now. */
2630 objfile->mtime = new_modtime;
2631 init_entry_point_info (objfile);
2633 new_objfiles.push_back (objfile);
2637 if (!new_objfiles.empty ())
2639 clear_symtab_users (0);
2641 /* The registry for each objfile was cleared and
2642 gdb::observers::new_objfile.notify (NULL) has been called by
2643 clear_symtab_users above. Notify the new files now. */
2644 for (auto iter : new_objfiles)
2645 gdb::observers::new_objfile.notify (iter);
2647 /* At least one objfile has changed, so we can consider that
2648 the executable we're debugging has changed too. */
2649 gdb::observers::executable_changed.notify ();
2654 struct filename_language
2656 filename_language (const std::string &ext_, enum language lang_)
2657 : ext (ext_), lang (lang_)
2660 std::string ext;
2661 enum language lang;
2664 static std::vector<filename_language> filename_language_table;
2666 /* See symfile.h. */
2668 void
2669 add_filename_language (const char *ext, enum language lang)
2671 gdb_assert (ext != nullptr);
2672 filename_language_table.emplace_back (ext, lang);
2675 static std::string ext_args;
2676 static void
2677 show_ext_args (struct ui_file *file, int from_tty,
2678 struct cmd_list_element *c, const char *value)
2680 gdb_printf (file,
2681 _("Mapping between filename extension "
2682 "and source language is \"%s\".\n"),
2683 value);
2686 static void
2687 set_ext_lang_command (const char *args,
2688 int from_tty, struct cmd_list_element *e)
2690 const char *begin = ext_args.c_str ();
2691 const char *end = ext_args.c_str ();
2693 /* First arg is filename extension, starting with '.' */
2694 if (*end != '.')
2695 error (_("'%s': Filename extension must begin with '.'"), ext_args.c_str ());
2697 /* Find end of first arg. */
2698 while (*end != '\0' && !isspace (*end))
2699 end++;
2701 if (*end == '\0')
2702 error (_("'%s': two arguments required -- "
2703 "filename extension and language"),
2704 ext_args.c_str ());
2706 /* Extract first arg, the extension. */
2707 std::string extension = ext_args.substr (0, end - begin);
2709 /* Find beginning of second arg, which should be a source language. */
2710 begin = skip_spaces (end);
2712 if (*begin == '\0')
2713 error (_("'%s': two arguments required -- "
2714 "filename extension and language"),
2715 ext_args.c_str ());
2717 /* Lookup the language from among those we know. */
2718 language lang = language_enum (begin);
2720 auto it = filename_language_table.begin ();
2721 /* Now lookup the filename extension: do we already know it? */
2722 for (; it != filename_language_table.end (); it++)
2724 if (it->ext == extension)
2725 break;
2728 if (it == filename_language_table.end ())
2730 /* New file extension. */
2731 add_filename_language (extension.data (), lang);
2733 else
2735 /* Redefining a previously known filename extension. */
2737 /* if (from_tty) */
2738 /* query ("Really make files of type %s '%s'?", */
2739 /* ext_args, language_str (lang)); */
2741 it->lang = lang;
2745 static void
2746 info_ext_lang_command (const char *args, int from_tty)
2748 gdb_printf (_("Filename extensions and the languages they represent:"));
2749 gdb_printf ("\n\n");
2750 for (const filename_language &entry : filename_language_table)
2751 gdb_printf ("\t%s\t- %s\n", entry.ext.c_str (),
2752 language_str (entry.lang));
2755 enum language
2756 deduce_language_from_filename (const char *filename)
2758 const char *cp;
2760 if (filename != NULL)
2761 if ((cp = strrchr (filename, '.')) != NULL)
2763 for (const filename_language &entry : filename_language_table)
2764 if (entry.ext == cp)
2765 return entry.lang;
2768 return language_unknown;
2771 /* Allocate and initialize a new symbol table.
2772 CUST is from the result of allocate_compunit_symtab. */
2774 struct symtab *
2775 allocate_symtab (struct compunit_symtab *cust, const char *filename,
2776 const char *filename_for_id)
2778 struct objfile *objfile = cust->objfile ();
2779 struct symtab *symtab
2780 = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct symtab);
2782 symtab->filename = objfile->intern (filename);
2783 symtab->filename_for_id = objfile->intern (filename_for_id);
2784 symtab->fullname = NULL;
2785 symtab->set_language (deduce_language_from_filename (filename));
2787 /* This can be very verbose with lots of headers.
2788 Only print at higher debug levels. */
2789 if (symtab_create_debug >= 2)
2791 /* Be a bit clever with debugging messages, and don't print objfile
2792 every time, only when it changes. */
2793 static std::string last_objfile_name;
2794 const char *this_objfile_name = objfile_name (objfile);
2796 if (last_objfile_name.empty () || last_objfile_name != this_objfile_name)
2798 last_objfile_name = this_objfile_name;
2800 symtab_create_debug_printf_v
2801 ("creating one or more symtabs for objfile %s", this_objfile_name);
2804 symtab_create_debug_printf_v ("created symtab %s for module %s",
2805 host_address_to_string (symtab), filename);
2808 /* Add it to CUST's list of symtabs. */
2809 cust->add_filetab (symtab);
2811 /* Backlink to the containing compunit symtab. */
2812 symtab->set_compunit (cust);
2814 return symtab;
2817 /* Allocate and initialize a new compunit.
2818 NAME is the name of the main source file, if there is one, or some
2819 descriptive text if there are no source files. */
2821 struct compunit_symtab *
2822 allocate_compunit_symtab (struct objfile *objfile, const char *name)
2824 struct compunit_symtab *cu = OBSTACK_ZALLOC (&objfile->objfile_obstack,
2825 struct compunit_symtab);
2826 const char *saved_name;
2828 cu->set_objfile (objfile);
2830 /* The name we record here is only for display/debugging purposes.
2831 Just save the basename to avoid path issues (too long for display,
2832 relative vs absolute, etc.). */
2833 saved_name = lbasename (name);
2834 cu->name = obstack_strdup (&objfile->objfile_obstack, saved_name);
2836 cu->set_debugformat ("unknown");
2838 symtab_create_debug_printf_v ("created compunit symtab %s for %s",
2839 host_address_to_string (cu),
2840 cu->name);
2842 return cu;
2845 /* Hook CU to the objfile it comes from. */
2847 void
2848 add_compunit_symtab_to_objfile (struct compunit_symtab *cu)
2850 cu->next = cu->objfile ()->compunit_symtabs;
2851 cu->objfile ()->compunit_symtabs = cu;
2855 /* Reset all data structures in gdb which may contain references to
2856 symbol table data. */
2858 void
2859 clear_symtab_users (symfile_add_flags add_flags)
2861 /* Someday, we should do better than this, by only blowing away
2862 the things that really need to be blown. */
2864 /* Clear the "current" symtab first, because it is no longer valid.
2865 breakpoint_re_set may try to access the current symtab. */
2866 clear_current_source_symtab_and_line ();
2868 clear_displays ();
2869 clear_last_displayed_sal ();
2870 clear_pc_function_cache ();
2871 gdb::observers::new_objfile.notify (NULL);
2873 /* Varobj may refer to old symbols, perform a cleanup. */
2874 varobj_invalidate ();
2876 /* Now that the various caches have been cleared, we can re_set
2877 our breakpoints without risking it using stale data. */
2878 if ((add_flags & SYMFILE_DEFER_BP_RESET) == 0)
2879 breakpoint_re_set ();
2882 /* OVERLAYS:
2883 The following code implements an abstraction for debugging overlay sections.
2885 The target model is as follows:
2886 1) The gnu linker will permit multiple sections to be mapped into the
2887 same VMA, each with its own unique LMA (or load address).
2888 2) It is assumed that some runtime mechanism exists for mapping the
2889 sections, one by one, from the load address into the VMA address.
2890 3) This code provides a mechanism for gdb to keep track of which
2891 sections should be considered to be mapped from the VMA to the LMA.
2892 This information is used for symbol lookup, and memory read/write.
2893 For instance, if a section has been mapped then its contents
2894 should be read from the VMA, otherwise from the LMA.
2896 Two levels of debugger support for overlays are available. One is
2897 "manual", in which the debugger relies on the user to tell it which
2898 overlays are currently mapped. This level of support is
2899 implemented entirely in the core debugger, and the information about
2900 whether a section is mapped is kept in the objfile->obj_section table.
2902 The second level of support is "automatic", and is only available if
2903 the target-specific code provides functionality to read the target's
2904 overlay mapping table, and translate its contents for the debugger
2905 (by updating the mapped state information in the obj_section tables).
2907 The interface is as follows:
2908 User commands:
2909 overlay map <name> -- tell gdb to consider this section mapped
2910 overlay unmap <name> -- tell gdb to consider this section unmapped
2911 overlay list -- list the sections that GDB thinks are mapped
2912 overlay read-target -- get the target's state of what's mapped
2913 overlay off/manual/auto -- set overlay debugging state
2914 Functional interface:
2915 find_pc_mapped_section(pc): if the pc is in the range of a mapped
2916 section, return that section.
2917 find_pc_overlay(pc): find any overlay section that contains
2918 the pc, either in its VMA or its LMA
2919 section_is_mapped(sect): true if overlay is marked as mapped
2920 section_is_overlay(sect): true if section's VMA != LMA
2921 pc_in_mapped_range(pc,sec): true if pc belongs to section's VMA
2922 pc_in_unmapped_range(...): true if pc belongs to section's LMA
2923 sections_overlap(sec1, sec2): true if mapped sec1 and sec2 ranges overlap
2924 overlay_mapped_address(...): map an address from section's LMA to VMA
2925 overlay_unmapped_address(...): map an address from section's VMA to LMA
2926 symbol_overlayed_address(...): Return a "current" address for symbol:
2927 either in VMA or LMA depending on whether
2928 the symbol's section is currently mapped. */
2930 /* Overlay debugging state: */
2932 enum overlay_debugging_state overlay_debugging = ovly_off;
2933 int overlay_cache_invalid = 0; /* True if need to refresh mapped state. */
2935 /* Function: section_is_overlay (SECTION)
2936 Returns true if SECTION has VMA not equal to LMA, ie.
2937 SECTION is loaded at an address different from where it will "run". */
2940 section_is_overlay (struct obj_section *section)
2942 if (overlay_debugging && section)
2944 asection *bfd_section = section->the_bfd_section;
2946 if (bfd_section_lma (bfd_section) != 0
2947 && bfd_section_lma (bfd_section) != bfd_section_vma (bfd_section))
2948 return 1;
2951 return 0;
2954 /* Function: overlay_invalidate_all (void)
2955 Invalidate the mapped state of all overlay sections (mark it as stale). */
2957 static void
2958 overlay_invalidate_all (void)
2960 struct obj_section *sect;
2962 for (objfile *objfile : current_program_space->objfiles ())
2963 ALL_OBJFILE_OSECTIONS (objfile, sect)
2964 if (section_is_overlay (sect))
2965 sect->ovly_mapped = -1;
2968 /* Function: section_is_mapped (SECTION)
2969 Returns true if section is an overlay, and is currently mapped.
2971 Access to the ovly_mapped flag is restricted to this function, so
2972 that we can do automatic update. If the global flag
2973 OVERLAY_CACHE_INVALID is set (by wait_for_inferior), then call
2974 overlay_invalidate_all. If the mapped state of the particular
2975 section is stale, then call TARGET_OVERLAY_UPDATE to refresh it. */
2978 section_is_mapped (struct obj_section *osect)
2980 struct gdbarch *gdbarch;
2982 if (osect == 0 || !section_is_overlay (osect))
2983 return 0;
2985 switch (overlay_debugging)
2987 default:
2988 case ovly_off:
2989 return 0; /* overlay debugging off */
2990 case ovly_auto: /* overlay debugging automatic */
2991 /* Unles there is a gdbarch_overlay_update function,
2992 there's really nothing useful to do here (can't really go auto). */
2993 gdbarch = osect->objfile->arch ();
2994 if (gdbarch_overlay_update_p (gdbarch))
2996 if (overlay_cache_invalid)
2998 overlay_invalidate_all ();
2999 overlay_cache_invalid = 0;
3001 if (osect->ovly_mapped == -1)
3002 gdbarch_overlay_update (gdbarch, osect);
3004 /* fall thru */
3005 case ovly_on: /* overlay debugging manual */
3006 return osect->ovly_mapped == 1;
3010 /* Function: pc_in_unmapped_range
3011 If PC falls into the lma range of SECTION, return true, else false. */
3013 CORE_ADDR
3014 pc_in_unmapped_range (CORE_ADDR pc, struct obj_section *section)
3016 if (section_is_overlay (section))
3018 asection *bfd_section = section->the_bfd_section;
3020 /* We assume the LMA is relocated by the same offset as the VMA. */
3021 bfd_vma size = bfd_section_size (bfd_section);
3022 CORE_ADDR offset = section->offset ();
3024 if (bfd_section_lma (bfd_section) + offset <= pc
3025 && pc < bfd_section_lma (bfd_section) + offset + size)
3026 return 1;
3029 return 0;
3032 /* Function: pc_in_mapped_range
3033 If PC falls into the vma range of SECTION, return true, else false. */
3035 CORE_ADDR
3036 pc_in_mapped_range (CORE_ADDR pc, struct obj_section *section)
3038 if (section_is_overlay (section))
3040 if (section->addr () <= pc
3041 && pc < section->endaddr ())
3042 return 1;
3045 return 0;
3048 /* Return true if the mapped ranges of sections A and B overlap, false
3049 otherwise. */
3051 static int
3052 sections_overlap (struct obj_section *a, struct obj_section *b)
3054 CORE_ADDR a_start = a->addr ();
3055 CORE_ADDR a_end = a->endaddr ();
3056 CORE_ADDR b_start = b->addr ();
3057 CORE_ADDR b_end = b->endaddr ();
3059 return (a_start < b_end && b_start < a_end);
3062 /* Function: overlay_unmapped_address (PC, SECTION)
3063 Returns the address corresponding to PC in the unmapped (load) range.
3064 May be the same as PC. */
3066 CORE_ADDR
3067 overlay_unmapped_address (CORE_ADDR pc, struct obj_section *section)
3069 if (section_is_overlay (section) && pc_in_mapped_range (pc, section))
3071 asection *bfd_section = section->the_bfd_section;
3073 return (pc + bfd_section_lma (bfd_section)
3074 - bfd_section_vma (bfd_section));
3077 return pc;
3080 /* Function: overlay_mapped_address (PC, SECTION)
3081 Returns the address corresponding to PC in the mapped (runtime) range.
3082 May be the same as PC. */
3084 CORE_ADDR
3085 overlay_mapped_address (CORE_ADDR pc, struct obj_section *section)
3087 if (section_is_overlay (section) && pc_in_unmapped_range (pc, section))
3089 asection *bfd_section = section->the_bfd_section;
3091 return (pc + bfd_section_vma (bfd_section)
3092 - bfd_section_lma (bfd_section));
3095 return pc;
3098 /* Function: symbol_overlayed_address
3099 Return one of two addresses (relative to the VMA or to the LMA),
3100 depending on whether the section is mapped or not. */
3102 CORE_ADDR
3103 symbol_overlayed_address (CORE_ADDR address, struct obj_section *section)
3105 if (overlay_debugging)
3107 /* If the symbol has no section, just return its regular address. */
3108 if (section == 0)
3109 return address;
3110 /* If the symbol's section is not an overlay, just return its
3111 address. */
3112 if (!section_is_overlay (section))
3113 return address;
3114 /* If the symbol's section is mapped, just return its address. */
3115 if (section_is_mapped (section))
3116 return address;
3118 * HOWEVER: if the symbol is in an overlay section which is NOT mapped,
3119 * then return its LOADED address rather than its vma address!!
3121 return overlay_unmapped_address (address, section);
3123 return address;
3126 /* Function: find_pc_overlay (PC)
3127 Return the best-match overlay section for PC:
3128 If PC matches a mapped overlay section's VMA, return that section.
3129 Else if PC matches an unmapped section's VMA, return that section.
3130 Else if PC matches an unmapped section's LMA, return that section. */
3132 struct obj_section *
3133 find_pc_overlay (CORE_ADDR pc)
3135 struct obj_section *osect, *best_match = NULL;
3137 if (overlay_debugging)
3139 for (objfile *objfile : current_program_space->objfiles ())
3140 ALL_OBJFILE_OSECTIONS (objfile, osect)
3141 if (section_is_overlay (osect))
3143 if (pc_in_mapped_range (pc, osect))
3145 if (section_is_mapped (osect))
3146 return osect;
3147 else
3148 best_match = osect;
3150 else if (pc_in_unmapped_range (pc, osect))
3151 best_match = osect;
3154 return best_match;
3157 /* Function: find_pc_mapped_section (PC)
3158 If PC falls into the VMA address range of an overlay section that is
3159 currently marked as MAPPED, return that section. Else return NULL. */
3161 struct obj_section *
3162 find_pc_mapped_section (CORE_ADDR pc)
3164 struct obj_section *osect;
3166 if (overlay_debugging)
3168 for (objfile *objfile : current_program_space->objfiles ())
3169 ALL_OBJFILE_OSECTIONS (objfile, osect)
3170 if (pc_in_mapped_range (pc, osect) && section_is_mapped (osect))
3171 return osect;
3174 return NULL;
3177 /* Function: list_overlays_command
3178 Print a list of mapped sections and their PC ranges. */
3180 static void
3181 list_overlays_command (const char *args, int from_tty)
3183 int nmapped = 0;
3184 struct obj_section *osect;
3186 if (overlay_debugging)
3188 for (objfile *objfile : current_program_space->objfiles ())
3189 ALL_OBJFILE_OSECTIONS (objfile, osect)
3190 if (section_is_mapped (osect))
3192 struct gdbarch *gdbarch = objfile->arch ();
3193 const char *name;
3194 bfd_vma lma, vma;
3195 int size;
3197 vma = bfd_section_vma (osect->the_bfd_section);
3198 lma = bfd_section_lma (osect->the_bfd_section);
3199 size = bfd_section_size (osect->the_bfd_section);
3200 name = bfd_section_name (osect->the_bfd_section);
3202 gdb_printf ("Section %s, loaded at ", name);
3203 gdb_puts (paddress (gdbarch, lma));
3204 gdb_puts (" - ");
3205 gdb_puts (paddress (gdbarch, lma + size));
3206 gdb_printf (", mapped at ");
3207 gdb_puts (paddress (gdbarch, vma));
3208 gdb_puts (" - ");
3209 gdb_puts (paddress (gdbarch, vma + size));
3210 gdb_puts ("\n");
3212 nmapped++;
3215 if (nmapped == 0)
3216 gdb_printf (_("No sections are mapped.\n"));
3219 /* Function: map_overlay_command
3220 Mark the named section as mapped (ie. residing at its VMA address). */
3222 static void
3223 map_overlay_command (const char *args, int from_tty)
3225 struct obj_section *sec, *sec2;
3227 if (!overlay_debugging)
3228 error (_("Overlay debugging not enabled. Use "
3229 "either the 'overlay auto' or\n"
3230 "the 'overlay manual' command."));
3232 if (args == 0 || *args == 0)
3233 error (_("Argument required: name of an overlay section"));
3235 /* First, find a section matching the user supplied argument. */
3236 for (objfile *obj_file : current_program_space->objfiles ())
3237 ALL_OBJFILE_OSECTIONS (obj_file, sec)
3238 if (!strcmp (bfd_section_name (sec->the_bfd_section), args))
3240 /* Now, check to see if the section is an overlay. */
3241 if (!section_is_overlay (sec))
3242 continue; /* not an overlay section */
3244 /* Mark the overlay as "mapped". */
3245 sec->ovly_mapped = 1;
3247 /* Next, make a pass and unmap any sections that are
3248 overlapped by this new section: */
3249 for (objfile *objfile2 : current_program_space->objfiles ())
3250 ALL_OBJFILE_OSECTIONS (objfile2, sec2)
3251 if (sec2->ovly_mapped && sec != sec2 && sections_overlap (sec,
3252 sec2))
3254 if (info_verbose)
3255 gdb_printf (_("Note: section %s unmapped by overlap\n"),
3256 bfd_section_name (sec2->the_bfd_section));
3257 sec2->ovly_mapped = 0; /* sec2 overlaps sec: unmap sec2. */
3259 return;
3261 error (_("No overlay section called %s"), args);
3264 /* Function: unmap_overlay_command
3265 Mark the overlay section as unmapped
3266 (ie. resident in its LMA address range, rather than the VMA range). */
3268 static void
3269 unmap_overlay_command (const char *args, int from_tty)
3271 struct obj_section *sec = NULL;
3273 if (!overlay_debugging)
3274 error (_("Overlay debugging not enabled. "
3275 "Use either the 'overlay auto' or\n"
3276 "the 'overlay manual' command."));
3278 if (args == 0 || *args == 0)
3279 error (_("Argument required: name of an overlay section"));
3281 /* First, find a section matching the user supplied argument. */
3282 for (objfile *objfile : current_program_space->objfiles ())
3283 ALL_OBJFILE_OSECTIONS (objfile, sec)
3284 if (!strcmp (bfd_section_name (sec->the_bfd_section), args))
3286 if (!sec->ovly_mapped)
3287 error (_("Section %s is not mapped"), args);
3288 sec->ovly_mapped = 0;
3289 return;
3291 error (_("No overlay section called %s"), args);
3294 /* Function: overlay_auto_command
3295 A utility command to turn on overlay debugging.
3296 Possibly this should be done via a set/show command. */
3298 static void
3299 overlay_auto_command (const char *args, int from_tty)
3301 overlay_debugging = ovly_auto;
3302 enable_overlay_breakpoints ();
3303 if (info_verbose)
3304 gdb_printf (_("Automatic overlay debugging enabled."));
3307 /* Function: overlay_manual_command
3308 A utility command to turn on overlay debugging.
3309 Possibly this should be done via a set/show command. */
3311 static void
3312 overlay_manual_command (const char *args, int from_tty)
3314 overlay_debugging = ovly_on;
3315 disable_overlay_breakpoints ();
3316 if (info_verbose)
3317 gdb_printf (_("Overlay debugging enabled."));
3320 /* Function: overlay_off_command
3321 A utility command to turn on overlay debugging.
3322 Possibly this should be done via a set/show command. */
3324 static void
3325 overlay_off_command (const char *args, int from_tty)
3327 overlay_debugging = ovly_off;
3328 disable_overlay_breakpoints ();
3329 if (info_verbose)
3330 gdb_printf (_("Overlay debugging disabled."));
3333 static void
3334 overlay_load_command (const char *args, int from_tty)
3336 struct gdbarch *gdbarch = get_current_arch ();
3338 if (gdbarch_overlay_update_p (gdbarch))
3339 gdbarch_overlay_update (gdbarch, NULL);
3340 else
3341 error (_("This target does not know how to read its overlay state."));
3344 /* Command list chain containing all defined "overlay" subcommands. */
3345 static struct cmd_list_element *overlaylist;
3347 /* Target Overlays for the "Simplest" overlay manager:
3349 This is GDB's default target overlay layer. It works with the
3350 minimal overlay manager supplied as an example by Cygnus. The
3351 entry point is via a function pointer "gdbarch_overlay_update",
3352 so targets that use a different runtime overlay manager can
3353 substitute their own overlay_update function and take over the
3354 function pointer.
3356 The overlay_update function pokes around in the target's data structures
3357 to see what overlays are mapped, and updates GDB's overlay mapping with
3358 this information.
3360 In this simple implementation, the target data structures are as follows:
3361 unsigned _novlys; /# number of overlay sections #/
3362 unsigned _ovly_table[_novlys][4] = {
3363 {VMA, OSIZE, LMA, MAPPED}, /# one entry per overlay section #/
3364 {..., ..., ..., ...},
3366 unsigned _novly_regions; /# number of overlay regions #/
3367 unsigned _ovly_region_table[_novly_regions][3] = {
3368 {VMA, OSIZE, MAPPED_TO_LMA}, /# one entry per overlay region #/
3369 {..., ..., ...},
3371 These functions will attempt to update GDB's mappedness state in the
3372 symbol section table, based on the target's mappedness state.
3374 To do this, we keep a cached copy of the target's _ovly_table, and
3375 attempt to detect when the cached copy is invalidated. The main
3376 entry point is "simple_overlay_update(SECT), which looks up SECT in
3377 the cached table and re-reads only the entry for that section from
3378 the target (whenever possible). */
3380 /* Cached, dynamically allocated copies of the target data structures: */
3381 static unsigned (*cache_ovly_table)[4] = 0;
3382 static unsigned cache_novlys = 0;
3383 static CORE_ADDR cache_ovly_table_base = 0;
3384 enum ovly_index
3386 VMA, OSIZE, LMA, MAPPED
3389 /* Throw away the cached copy of _ovly_table. */
3391 static void
3392 simple_free_overlay_table (void)
3394 xfree (cache_ovly_table);
3395 cache_novlys = 0;
3396 cache_ovly_table = NULL;
3397 cache_ovly_table_base = 0;
3400 /* Read an array of ints of size SIZE from the target into a local buffer.
3401 Convert to host order. int LEN is number of ints. */
3403 static void
3404 read_target_long_array (CORE_ADDR memaddr, unsigned int *myaddr,
3405 int len, int size, enum bfd_endian byte_order)
3407 /* FIXME (alloca): Not safe if array is very large. */
3408 gdb_byte *buf = (gdb_byte *) alloca (len * size);
3409 int i;
3411 read_memory (memaddr, buf, len * size);
3412 for (i = 0; i < len; i++)
3413 myaddr[i] = extract_unsigned_integer (size * i + buf, size, byte_order);
3416 /* Find and grab a copy of the target _ovly_table
3417 (and _novlys, which is needed for the table's size). */
3419 static int
3420 simple_read_overlay_table (void)
3422 struct bound_minimal_symbol novlys_msym;
3423 struct bound_minimal_symbol ovly_table_msym;
3424 struct gdbarch *gdbarch;
3425 int word_size;
3426 enum bfd_endian byte_order;
3428 simple_free_overlay_table ();
3429 novlys_msym = lookup_minimal_symbol ("_novlys", NULL, NULL);
3430 if (! novlys_msym.minsym)
3432 error (_("Error reading inferior's overlay table: "
3433 "couldn't find `_novlys' variable\n"
3434 "in inferior. Use `overlay manual' mode."));
3435 return 0;
3438 ovly_table_msym = lookup_bound_minimal_symbol ("_ovly_table");
3439 if (! ovly_table_msym.minsym)
3441 error (_("Error reading inferior's overlay table: couldn't find "
3442 "`_ovly_table' array\n"
3443 "in inferior. Use `overlay manual' mode."));
3444 return 0;
3447 gdbarch = ovly_table_msym.objfile->arch ();
3448 word_size = gdbarch_long_bit (gdbarch) / TARGET_CHAR_BIT;
3449 byte_order = gdbarch_byte_order (gdbarch);
3451 cache_novlys = read_memory_integer (novlys_msym.value_address (),
3452 4, byte_order);
3453 cache_ovly_table
3454 = (unsigned int (*)[4]) xmalloc (cache_novlys * sizeof (*cache_ovly_table));
3455 cache_ovly_table_base = ovly_table_msym.value_address ();
3456 read_target_long_array (cache_ovly_table_base,
3457 (unsigned int *) cache_ovly_table,
3458 cache_novlys * 4, word_size, byte_order);
3460 return 1; /* SUCCESS */
3463 /* Function: simple_overlay_update_1
3464 A helper function for simple_overlay_update. Assuming a cached copy
3465 of _ovly_table exists, look through it to find an entry whose vma,
3466 lma and size match those of OSECT. Re-read the entry and make sure
3467 it still matches OSECT (else the table may no longer be valid).
3468 Set OSECT's mapped state to match the entry. Return: 1 for
3469 success, 0 for failure. */
3471 static int
3472 simple_overlay_update_1 (struct obj_section *osect)
3474 int i;
3475 asection *bsect = osect->the_bfd_section;
3476 struct gdbarch *gdbarch = osect->objfile->arch ();
3477 int word_size = gdbarch_long_bit (gdbarch) / TARGET_CHAR_BIT;
3478 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
3480 for (i = 0; i < cache_novlys; i++)
3481 if (cache_ovly_table[i][VMA] == bfd_section_vma (bsect)
3482 && cache_ovly_table[i][LMA] == bfd_section_lma (bsect))
3484 read_target_long_array (cache_ovly_table_base + i * word_size,
3485 (unsigned int *) cache_ovly_table[i],
3486 4, word_size, byte_order);
3487 if (cache_ovly_table[i][VMA] == bfd_section_vma (bsect)
3488 && cache_ovly_table[i][LMA] == bfd_section_lma (bsect))
3490 osect->ovly_mapped = cache_ovly_table[i][MAPPED];
3491 return 1;
3493 else /* Warning! Warning! Target's ovly table has changed! */
3494 return 0;
3496 return 0;
3499 /* Function: simple_overlay_update
3500 If OSECT is NULL, then update all sections' mapped state
3501 (after re-reading the entire target _ovly_table).
3502 If OSECT is non-NULL, then try to find a matching entry in the
3503 cached ovly_table and update only OSECT's mapped state.
3504 If a cached entry can't be found or the cache isn't valid, then
3505 re-read the entire cache, and go ahead and update all sections. */
3507 void
3508 simple_overlay_update (struct obj_section *osect)
3510 /* Were we given an osect to look up? NULL means do all of them. */
3511 if (osect)
3512 /* Have we got a cached copy of the target's overlay table? */
3513 if (cache_ovly_table != NULL)
3515 /* Does its cached location match what's currently in the
3516 symtab? */
3517 struct bound_minimal_symbol minsym
3518 = lookup_minimal_symbol ("_ovly_table", NULL, NULL);
3520 if (minsym.minsym == NULL)
3521 error (_("Error reading inferior's overlay table: couldn't "
3522 "find `_ovly_table' array\n"
3523 "in inferior. Use `overlay manual' mode."));
3525 if (cache_ovly_table_base == minsym.value_address ())
3526 /* Then go ahead and try to look up this single section in
3527 the cache. */
3528 if (simple_overlay_update_1 (osect))
3529 /* Found it! We're done. */
3530 return;
3533 /* Cached table no good: need to read the entire table anew.
3534 Or else we want all the sections, in which case it's actually
3535 more efficient to read the whole table in one block anyway. */
3537 if (! simple_read_overlay_table ())
3538 return;
3540 /* Now may as well update all sections, even if only one was requested. */
3541 for (objfile *objfile : current_program_space->objfiles ())
3542 ALL_OBJFILE_OSECTIONS (objfile, osect)
3543 if (section_is_overlay (osect))
3545 int i;
3546 asection *bsect = osect->the_bfd_section;
3548 for (i = 0; i < cache_novlys; i++)
3549 if (cache_ovly_table[i][VMA] == bfd_section_vma (bsect)
3550 && cache_ovly_table[i][LMA] == bfd_section_lma (bsect))
3551 { /* obj_section matches i'th entry in ovly_table. */
3552 osect->ovly_mapped = cache_ovly_table[i][MAPPED];
3553 break; /* finished with inner for loop: break out. */
3558 /* Default implementation for sym_relocate. */
3560 bfd_byte *
3561 default_symfile_relocate (struct objfile *objfile, asection *sectp,
3562 bfd_byte *buf)
3564 /* Use sectp->owner instead of objfile->obfd. sectp may point to a
3565 DWO file. */
3566 bfd *abfd = sectp->owner;
3568 /* We're only interested in sections with relocation
3569 information. */
3570 if ((sectp->flags & SEC_RELOC) == 0)
3571 return NULL;
3573 /* We will handle section offsets properly elsewhere, so relocate as if
3574 all sections begin at 0. */
3575 for (asection *sect : gdb_bfd_sections (abfd))
3577 sect->output_section = sect;
3578 sect->output_offset = 0;
3581 return bfd_simple_get_relocated_section_contents (abfd, sectp, buf, NULL);
3584 /* Relocate the contents of a debug section SECTP in ABFD. The
3585 contents are stored in BUF if it is non-NULL, or returned in a
3586 malloc'd buffer otherwise.
3588 For some platforms and debug info formats, shared libraries contain
3589 relocations against the debug sections (particularly for DWARF-2;
3590 one affected platform is PowerPC GNU/Linux, although it depends on
3591 the version of the linker in use). Also, ELF object files naturally
3592 have unresolved relocations for their debug sections. We need to apply
3593 the relocations in order to get the locations of symbols correct.
3594 Another example that may require relocation processing, is the
3595 DWARF-2 .eh_frame section in .o files, although it isn't strictly a
3596 debug section. */
3598 bfd_byte *
3599 symfile_relocate_debug_section (struct objfile *objfile,
3600 asection *sectp, bfd_byte *buf)
3602 gdb_assert (objfile->sf->sym_relocate);
3604 return (*objfile->sf->sym_relocate) (objfile, sectp, buf);
3607 symfile_segment_data_up
3608 get_symfile_segment_data (bfd *abfd)
3610 const struct sym_fns *sf = find_sym_fns (abfd);
3612 if (sf == NULL)
3613 return NULL;
3615 return sf->sym_segments (abfd);
3618 /* Given:
3619 - DATA, containing segment addresses from the object file ABFD, and
3620 the mapping from ABFD's sections onto the segments that own them,
3622 - SEGMENT_BASES[0 .. NUM_SEGMENT_BASES - 1], holding the actual
3623 segment addresses reported by the target,
3624 store the appropriate offsets for each section in OFFSETS.
3626 If there are fewer entries in SEGMENT_BASES than there are segments
3627 in DATA, then apply SEGMENT_BASES' last entry to all the segments.
3629 If there are more entries, then ignore the extra. The target may
3630 not be able to distinguish between an empty data segment and a
3631 missing data segment; a missing text segment is less plausible. */
3634 symfile_map_offsets_to_segments (bfd *abfd,
3635 const struct symfile_segment_data *data,
3636 section_offsets &offsets,
3637 int num_segment_bases,
3638 const CORE_ADDR *segment_bases)
3640 int i;
3641 asection *sect;
3643 /* It doesn't make sense to call this function unless you have some
3644 segment base addresses. */
3645 gdb_assert (num_segment_bases > 0);
3647 /* If we do not have segment mappings for the object file, we
3648 can not relocate it by segments. */
3649 gdb_assert (data != NULL);
3650 gdb_assert (data->segments.size () > 0);
3652 for (i = 0, sect = abfd->sections; sect != NULL; i++, sect = sect->next)
3654 int which = data->segment_info[i];
3656 gdb_assert (0 <= which && which <= data->segments.size ());
3658 /* Don't bother computing offsets for sections that aren't
3659 loaded as part of any segment. */
3660 if (! which)
3661 continue;
3663 /* Use the last SEGMENT_BASES entry as the address of any extra
3664 segments mentioned in DATA->segment_info. */
3665 if (which > num_segment_bases)
3666 which = num_segment_bases;
3668 offsets[i] = segment_bases[which - 1] - data->segments[which - 1].base;
3671 return 1;
3674 static void
3675 symfile_find_segment_sections (struct objfile *objfile)
3677 bfd *abfd = objfile->obfd;
3678 int i;
3679 asection *sect;
3681 symfile_segment_data_up data
3682 = get_symfile_segment_data (objfile->obfd);
3683 if (data == NULL)
3684 return;
3686 if (data->segments.size () != 1 && data->segments.size () != 2)
3687 return;
3689 for (i = 0, sect = abfd->sections; sect != NULL; i++, sect = sect->next)
3691 int which = data->segment_info[i];
3693 if (which == 1)
3695 if (objfile->sect_index_text == -1)
3696 objfile->sect_index_text = sect->index;
3698 if (objfile->sect_index_rodata == -1)
3699 objfile->sect_index_rodata = sect->index;
3701 else if (which == 2)
3703 if (objfile->sect_index_data == -1)
3704 objfile->sect_index_data = sect->index;
3706 if (objfile->sect_index_bss == -1)
3707 objfile->sect_index_bss = sect->index;
3712 /* Listen for free_objfile events. */
3714 static void
3715 symfile_free_objfile (struct objfile *objfile)
3717 /* Remove the target sections owned by this objfile. */
3718 if (objfile != NULL)
3719 current_program_space->remove_target_sections ((void *) objfile);
3722 /* Wrapper around the quick_symbol_functions expand_symtabs_matching "method".
3723 Expand all symtabs that match the specified criteria.
3724 See quick_symbol_functions.expand_symtabs_matching for details. */
3726 bool
3727 expand_symtabs_matching
3728 (gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
3729 const lookup_name_info &lookup_name,
3730 gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
3731 gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
3732 block_search_flags search_flags,
3733 enum search_domain kind)
3735 for (objfile *objfile : current_program_space->objfiles ())
3736 if (!objfile->expand_symtabs_matching (file_matcher,
3737 &lookup_name,
3738 symbol_matcher,
3739 expansion_notify,
3740 search_flags,
3741 UNDEF_DOMAIN,
3742 kind))
3743 return false;
3744 return true;
3747 /* Wrapper around the quick_symbol_functions map_symbol_filenames "method".
3748 Map function FUN over every file.
3749 See quick_symbol_functions.map_symbol_filenames for details. */
3751 void
3752 map_symbol_filenames (gdb::function_view<symbol_filename_ftype> fun,
3753 bool need_fullname)
3755 for (objfile *objfile : current_program_space->objfiles ())
3756 objfile->map_symbol_filenames (fun, need_fullname);
3759 #if GDB_SELF_TEST
3761 namespace selftests {
3762 namespace filename_language {
3764 static void test_filename_language ()
3766 /* This test messes up the filename_language_table global. */
3767 scoped_restore restore_flt = make_scoped_restore (&filename_language_table);
3769 /* Test deducing an unknown extension. */
3770 language lang = deduce_language_from_filename ("myfile.blah");
3771 SELF_CHECK (lang == language_unknown);
3773 /* Test deducing a known extension. */
3774 lang = deduce_language_from_filename ("myfile.c");
3775 SELF_CHECK (lang == language_c);
3777 /* Test adding a new extension using the internal API. */
3778 add_filename_language (".blah", language_pascal);
3779 lang = deduce_language_from_filename ("myfile.blah");
3780 SELF_CHECK (lang == language_pascal);
3783 static void
3784 test_set_ext_lang_command ()
3786 /* This test messes up the filename_language_table global. */
3787 scoped_restore restore_flt = make_scoped_restore (&filename_language_table);
3789 /* Confirm that the .hello extension is not known. */
3790 language lang = deduce_language_from_filename ("cake.hello");
3791 SELF_CHECK (lang == language_unknown);
3793 /* Test adding a new extension using the CLI command. */
3794 ext_args = ".hello rust";
3795 set_ext_lang_command (NULL, 1, NULL);
3797 lang = deduce_language_from_filename ("cake.hello");
3798 SELF_CHECK (lang == language_rust);
3800 /* Test overriding an existing extension using the CLI command. */
3801 int size_before = filename_language_table.size ();
3802 ext_args = ".hello pascal";
3803 set_ext_lang_command (NULL, 1, NULL);
3804 int size_after = filename_language_table.size ();
3806 lang = deduce_language_from_filename ("cake.hello");
3807 SELF_CHECK (lang == language_pascal);
3808 SELF_CHECK (size_before == size_after);
3811 } /* namespace filename_language */
3812 } /* namespace selftests */
3814 #endif /* GDB_SELF_TEST */
3816 void _initialize_symfile ();
3817 void
3818 _initialize_symfile ()
3820 struct cmd_list_element *c;
3822 gdb::observers::free_objfile.attach (symfile_free_objfile, "symfile");
3824 #define READNOW_READNEVER_HELP \
3825 "The '-readnow' option will cause GDB to read the entire symbol file\n\
3826 immediately. This makes the command slower, but may make future operations\n\
3827 faster.\n\
3828 The '-readnever' option will prevent GDB from reading the symbol file's\n\
3829 symbolic debug information."
3831 c = add_cmd ("symbol-file", class_files, symbol_file_command, _("\
3832 Load symbol table from executable file FILE.\n\
3833 Usage: symbol-file [-readnow | -readnever] [-o OFF] FILE\n\
3834 OFF is an optional offset which is added to each section address.\n\
3835 The `file' command can also load symbol tables, as well as setting the file\n\
3836 to execute.\n" READNOW_READNEVER_HELP), &cmdlist);
3837 set_cmd_completer (c, filename_completer);
3839 c = add_cmd ("add-symbol-file", class_files, add_symbol_file_command, _("\
3840 Load symbols from FILE, assuming FILE has been dynamically loaded.\n\
3841 Usage: add-symbol-file FILE [-readnow | -readnever] [-o OFF] [ADDR] \
3842 [-s SECT-NAME SECT-ADDR]...\n\
3843 ADDR is the starting address of the file's text.\n\
3844 Each '-s' argument provides a section name and address, and\n\
3845 should be specified if the data and bss segments are not contiguous\n\
3846 with the text. SECT-NAME is a section name to be loaded at SECT-ADDR.\n\
3847 OFF is an optional offset which is added to the default load addresses\n\
3848 of all sections for which no other address was specified.\n"
3849 READNOW_READNEVER_HELP),
3850 &cmdlist);
3851 set_cmd_completer (c, filename_completer);
3853 c = add_cmd ("remove-symbol-file", class_files,
3854 remove_symbol_file_command, _("\
3855 Remove a symbol file added via the add-symbol-file command.\n\
3856 Usage: remove-symbol-file FILENAME\n\
3857 remove-symbol-file -a ADDRESS\n\
3858 The file to remove can be identified by its filename or by an address\n\
3859 that lies within the boundaries of this symbol file in memory."),
3860 &cmdlist);
3862 c = add_cmd ("load", class_files, load_command, _("\
3863 Dynamically load FILE into the running program.\n\
3864 FILE symbols are recorded for access from GDB.\n\
3865 Usage: load [FILE] [OFFSET]\n\
3866 An optional load OFFSET may also be given as a literal address.\n\
3867 When OFFSET is provided, FILE must also be provided. FILE can be provided\n\
3868 on its own."), &cmdlist);
3869 set_cmd_completer (c, filename_completer);
3871 cmd_list_element *overlay_cmd
3872 = add_basic_prefix_cmd ("overlay", class_support,
3873 _("Commands for debugging overlays."), &overlaylist,
3874 0, &cmdlist);
3876 add_com_alias ("ovly", overlay_cmd, class_support, 1);
3877 add_com_alias ("ov", overlay_cmd, class_support, 1);
3879 add_cmd ("map-overlay", class_support, map_overlay_command,
3880 _("Assert that an overlay section is mapped."), &overlaylist);
3882 add_cmd ("unmap-overlay", class_support, unmap_overlay_command,
3883 _("Assert that an overlay section is unmapped."), &overlaylist);
3885 add_cmd ("list-overlays", class_support, list_overlays_command,
3886 _("List mappings of overlay sections."), &overlaylist);
3888 add_cmd ("manual", class_support, overlay_manual_command,
3889 _("Enable overlay debugging."), &overlaylist);
3890 add_cmd ("off", class_support, overlay_off_command,
3891 _("Disable overlay debugging."), &overlaylist);
3892 add_cmd ("auto", class_support, overlay_auto_command,
3893 _("Enable automatic overlay debugging."), &overlaylist);
3894 add_cmd ("load-target", class_support, overlay_load_command,
3895 _("Read the overlay mapping state from the target."), &overlaylist);
3897 /* Filename extension to source language lookup table: */
3898 add_setshow_string_noescape_cmd ("extension-language", class_files,
3899 &ext_args, _("\
3900 Set mapping between filename extension and source language."), _("\
3901 Show mapping between filename extension and source language."), _("\
3902 Usage: set extension-language .foo bar"),
3903 set_ext_lang_command,
3904 show_ext_args,
3905 &setlist, &showlist);
3907 add_info ("extensions", info_ext_lang_command,
3908 _("All filename extensions associated with a source language."));
3910 add_setshow_optional_filename_cmd ("debug-file-directory", class_support,
3911 &debug_file_directory, _("\
3912 Set the directories where separate debug symbols are searched for."), _("\
3913 Show the directories where separate debug symbols are searched for."), _("\
3914 Separate debug symbols are first searched for in the same\n\
3915 directory as the binary, then in the `" DEBUG_SUBDIRECTORY "' subdirectory,\n\
3916 and lastly at the path of the directory of the binary with\n\
3917 each global debug-file-directory component prepended."),
3918 NULL,
3919 show_debug_file_directory,
3920 &setlist, &showlist);
3922 add_setshow_enum_cmd ("symbol-loading", no_class,
3923 print_symbol_loading_enums, &print_symbol_loading,
3924 _("\
3925 Set printing of symbol loading messages."), _("\
3926 Show printing of symbol loading messages."), _("\
3927 off == turn all messages off\n\
3928 brief == print messages for the executable,\n\
3929 and brief messages for shared libraries\n\
3930 full == print messages for the executable,\n\
3931 and messages for each shared library."),
3932 NULL,
3933 NULL,
3934 &setprintlist, &showprintlist);
3936 add_setshow_boolean_cmd ("separate-debug-file", no_class,
3937 &separate_debug_file_debug, _("\
3938 Set printing of separate debug info file search debug."), _("\
3939 Show printing of separate debug info file search debug."), _("\
3940 When on, GDB prints the searched locations while looking for separate debug \
3941 info files."), NULL, NULL, &setdebuglist, &showdebuglist);
3943 #if GDB_SELF_TEST
3944 selftests::register_test
3945 ("filename_language", selftests::filename_language::test_filename_language);
3946 selftests::register_test
3947 ("set_ext_lang_command",
3948 selftests::filename_language::test_set_ext_lang_command);
3949 #endif