adcdc169306bf5f589a7f7e8559331f4e33d8db1
[binutils-gdb.git] / gdb / symfile.c
1 /* Generic symbol file reading for the GNU debugger, GDB.
2
3 Copyright (C) 1990-2021 Free Software Foundation, Inc.
4
5 Contributed by Cygnus Support, using pieces from other GDB modules.
6
7 This file is part of GDB.
8
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.
13
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.
18
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/>. */
21
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 "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
65 #include <sys/types.h>
66 #include <fcntl.h>
67 #include <sys/stat.h>
68 #include <ctype.h>
69 #include <chrono>
70 #include <algorithm>
71
72 int (*deprecated_ui_load_progress_hook) (const char *section,
73 unsigned long num);
74 void (*deprecated_show_load_progress) (const char *section,
75 unsigned long section_sent,
76 unsigned long section_size,
77 unsigned long total_sent,
78 unsigned long total_size);
79 void (*deprecated_pre_add_symbol_hook) (const char *);
80 void (*deprecated_post_add_symbol_hook) (void);
81
82 using clear_symtab_users_cleanup
83 = FORWARD_SCOPE_EXIT (clear_symtab_users);
84
85 /* Global variables owned by this file. */
86
87 /* See symfile.h. */
88
89 int readnow_symbol_files;
90
91 /* See symfile.h. */
92
93 int readnever_symbol_files;
94
95 /* Functions this file defines. */
96
97 static void symbol_file_add_main_1 (const char *args, symfile_add_flags add_flags,
98 objfile_flags flags, CORE_ADDR reloff);
99
100 static const struct sym_fns *find_sym_fns (bfd *);
101
102 static void overlay_invalidate_all (void);
103
104 static void simple_free_overlay_table (void);
105
106 static void read_target_long_array (CORE_ADDR, unsigned int *, int, int,
107 enum bfd_endian);
108
109 static int simple_read_overlay_table (void);
110
111 static int simple_overlay_update_1 (struct obj_section *);
112
113 static void symfile_find_segment_sections (struct objfile *objfile);
114
115 /* List of all available sym_fns. On gdb startup, each object file reader
116 calls add_symtab_fns() to register information on each format it is
117 prepared to read. */
118
119 struct registered_sym_fns
120 {
121 registered_sym_fns (bfd_flavour sym_flavour_, const struct sym_fns *sym_fns_)
122 : sym_flavour (sym_flavour_), sym_fns (sym_fns_)
123 {}
124
125 /* BFD flavour that we handle. */
126 enum bfd_flavour sym_flavour;
127
128 /* The "vtable" of symbol functions. */
129 const struct sym_fns *sym_fns;
130 };
131
132 static std::vector<registered_sym_fns> symtab_fns;
133
134 /* Values for "set print symbol-loading". */
135
136 const char print_symbol_loading_off[] = "off";
137 const char print_symbol_loading_brief[] = "brief";
138 const char print_symbol_loading_full[] = "full";
139 static const char *print_symbol_loading_enums[] =
140 {
141 print_symbol_loading_off,
142 print_symbol_loading_brief,
143 print_symbol_loading_full,
144 NULL
145 };
146 static const char *print_symbol_loading = print_symbol_loading_full;
147
148 /* See symfile.h. */
149
150 bool auto_solib_add = true;
151 \f
152
153 /* Return non-zero if symbol-loading messages should be printed.
154 FROM_TTY is the standard from_tty argument to gdb commands.
155 If EXEC is non-zero the messages are for the executable.
156 Otherwise, messages are for shared libraries.
157 If FULL is non-zero then the caller is printing a detailed message.
158 E.g., the message includes the shared library name.
159 Otherwise, the caller is printing a brief "summary" message. */
160
161 int
162 print_symbol_loading_p (int from_tty, int exec, int full)
163 {
164 if (!from_tty && !info_verbose)
165 return 0;
166
167 if (exec)
168 {
169 /* We don't check FULL for executables, there are few such
170 messages, therefore brief == full. */
171 return print_symbol_loading != print_symbol_loading_off;
172 }
173 if (full)
174 return print_symbol_loading == print_symbol_loading_full;
175 return print_symbol_loading == print_symbol_loading_brief;
176 }
177
178 /* True if we are reading a symbol table. */
179
180 int currently_reading_symtab = 0;
181
182 /* Increment currently_reading_symtab and return a cleanup that can be
183 used to decrement it. */
184
185 scoped_restore_tmpl<int>
186 increment_reading_symtab (void)
187 {
188 gdb_assert (currently_reading_symtab >= 0);
189 return make_scoped_restore (&currently_reading_symtab,
190 currently_reading_symtab + 1);
191 }
192
193 /* Remember the lowest-addressed loadable section we've seen.
194
195 In case of equal vmas, the section with the largest size becomes the
196 lowest-addressed loadable section.
197
198 If the vmas and sizes are equal, the last section is considered the
199 lowest-addressed loadable section. */
200
201 static void
202 find_lowest_section (asection *sect, asection **lowest)
203 {
204 if (0 == (bfd_section_flags (sect) & (SEC_ALLOC | SEC_LOAD)))
205 return;
206 if (!*lowest)
207 *lowest = sect; /* First loadable section */
208 else if (bfd_section_vma (*lowest) > bfd_section_vma (sect))
209 *lowest = sect; /* A lower loadable section */
210 else if (bfd_section_vma (*lowest) == bfd_section_vma (sect)
211 && (bfd_section_size (*lowest) <= bfd_section_size (sect)))
212 *lowest = sect;
213 }
214
215 /* Build (allocate and populate) a section_addr_info struct from
216 an existing section table. */
217
218 section_addr_info
219 build_section_addr_info_from_section_table (const target_section_table &table)
220 {
221 section_addr_info sap;
222
223 for (const target_section &stp : table)
224 {
225 struct bfd_section *asect = stp.the_bfd_section;
226 bfd *abfd = asect->owner;
227
228 if (bfd_section_flags (asect) & (SEC_ALLOC | SEC_LOAD)
229 && sap.size () < table.size ())
230 sap.emplace_back (stp.addr,
231 bfd_section_name (asect),
232 gdb_bfd_section_index (abfd, asect));
233 }
234
235 return sap;
236 }
237
238 /* Create a section_addr_info from section offsets in ABFD. */
239
240 static section_addr_info
241 build_section_addr_info_from_bfd (bfd *abfd)
242 {
243 struct bfd_section *sec;
244
245 section_addr_info sap;
246 for (sec = abfd->sections; sec != NULL; sec = sec->next)
247 if (bfd_section_flags (sec) & (SEC_ALLOC | SEC_LOAD))
248 sap.emplace_back (bfd_section_vma (sec),
249 bfd_section_name (sec),
250 gdb_bfd_section_index (abfd, sec));
251
252 return sap;
253 }
254
255 /* Create a section_addr_info from section offsets in OBJFILE. */
256
257 section_addr_info
258 build_section_addr_info_from_objfile (const struct objfile *objfile)
259 {
260 int i;
261
262 /* Before reread_symbols gets rewritten it is not safe to call:
263 gdb_assert (objfile->num_sections == bfd_count_sections (objfile->obfd));
264 */
265 section_addr_info sap = build_section_addr_info_from_bfd (objfile->obfd);
266 for (i = 0; i < sap.size (); i++)
267 {
268 int sectindex = sap[i].sectindex;
269
270 sap[i].addr += objfile->section_offsets[sectindex];
271 }
272 return sap;
273 }
274
275 /* Initialize OBJFILE's sect_index_* members. */
276
277 static void
278 init_objfile_sect_indices (struct objfile *objfile)
279 {
280 asection *sect;
281 int i;
282
283 sect = bfd_get_section_by_name (objfile->obfd, ".text");
284 if (sect)
285 objfile->sect_index_text = sect->index;
286
287 sect = bfd_get_section_by_name (objfile->obfd, ".data");
288 if (sect)
289 objfile->sect_index_data = sect->index;
290
291 sect = bfd_get_section_by_name (objfile->obfd, ".bss");
292 if (sect)
293 objfile->sect_index_bss = sect->index;
294
295 sect = bfd_get_section_by_name (objfile->obfd, ".rodata");
296 if (sect)
297 objfile->sect_index_rodata = sect->index;
298
299 /* This is where things get really weird... We MUST have valid
300 indices for the various sect_index_* members or gdb will abort.
301 So if for example, there is no ".text" section, we have to
302 accomodate that. First, check for a file with the standard
303 one or two segments. */
304
305 symfile_find_segment_sections (objfile);
306
307 /* Except when explicitly adding symbol files at some address,
308 section_offsets contains nothing but zeros, so it doesn't matter
309 which slot in section_offsets the individual sect_index_* members
310 index into. So if they are all zero, it is safe to just point
311 all the currently uninitialized indices to the first slot. But
312 beware: if this is the main executable, it may be relocated
313 later, e.g. by the remote qOffsets packet, and then this will
314 be wrong! That's why we try segments first. */
315
316 for (i = 0; i < objfile->section_offsets.size (); i++)
317 {
318 if (objfile->section_offsets[i] != 0)
319 {
320 break;
321 }
322 }
323 if (i == objfile->section_offsets.size ())
324 {
325 if (objfile->sect_index_text == -1)
326 objfile->sect_index_text = 0;
327 if (objfile->sect_index_data == -1)
328 objfile->sect_index_data = 0;
329 if (objfile->sect_index_bss == -1)
330 objfile->sect_index_bss = 0;
331 if (objfile->sect_index_rodata == -1)
332 objfile->sect_index_rodata = 0;
333 }
334 }
335
336 /* Find a unique offset to use for loadable section SECT if
337 the user did not provide an offset. */
338
339 static void
340 place_section (bfd *abfd, asection *sect, section_offsets &offsets,
341 CORE_ADDR &lowest)
342 {
343 CORE_ADDR start_addr;
344 int done;
345 ULONGEST align = ((ULONGEST) 1) << bfd_section_alignment (sect);
346
347 /* We are only interested in allocated sections. */
348 if ((bfd_section_flags (sect) & SEC_ALLOC) == 0)
349 return;
350
351 /* If the user specified an offset, honor it. */
352 if (offsets[gdb_bfd_section_index (abfd, sect)] != 0)
353 return;
354
355 /* Otherwise, let's try to find a place for the section. */
356 start_addr = (lowest + align - 1) & -align;
357
358 do {
359 asection *cur_sec;
360
361 done = 1;
362
363 for (cur_sec = abfd->sections; cur_sec != NULL; cur_sec = cur_sec->next)
364 {
365 int indx = cur_sec->index;
366
367 /* We don't need to compare against ourself. */
368 if (cur_sec == sect)
369 continue;
370
371 /* We can only conflict with allocated sections. */
372 if ((bfd_section_flags (cur_sec) & SEC_ALLOC) == 0)
373 continue;
374
375 /* If the section offset is 0, either the section has not been placed
376 yet, or it was the lowest section placed (in which case LOWEST
377 will be past its end). */
378 if (offsets[indx] == 0)
379 continue;
380
381 /* If this section would overlap us, then we must move up. */
382 if (start_addr + bfd_section_size (sect) > offsets[indx]
383 && start_addr < offsets[indx] + bfd_section_size (cur_sec))
384 {
385 start_addr = offsets[indx] + bfd_section_size (cur_sec);
386 start_addr = (start_addr + align - 1) & -align;
387 done = 0;
388 break;
389 }
390
391 /* Otherwise, we appear to be OK. So far. */
392 }
393 }
394 while (!done);
395
396 offsets[gdb_bfd_section_index (abfd, sect)] = start_addr;
397 lowest = start_addr + bfd_section_size (sect);
398 }
399
400 /* Store section_addr_info as prepared (made relative and with SECTINDEX
401 filled-in) by addr_info_make_relative into SECTION_OFFSETS. */
402
403 void
404 relative_addr_info_to_section_offsets (section_offsets &section_offsets,
405 const section_addr_info &addrs)
406 {
407 int i;
408
409 section_offsets.assign (section_offsets.size (), 0);
410
411 /* Now calculate offsets for section that were specified by the caller. */
412 for (i = 0; i < addrs.size (); i++)
413 {
414 const struct other_sections *osp;
415
416 osp = &addrs[i];
417 if (osp->sectindex == -1)
418 continue;
419
420 /* Record all sections in offsets. */
421 /* The section_offsets in the objfile are here filled in using
422 the BFD index. */
423 section_offsets[osp->sectindex] = osp->addr;
424 }
425 }
426
427 /* Transform section name S for a name comparison. prelink can split section
428 `.bss' into two sections `.dynbss' and `.bss' (in this order). Similarly
429 prelink can split `.sbss' into `.sdynbss' and `.sbss'. Use virtual address
430 of the new `.dynbss' (`.sdynbss') section as the adjacent new `.bss'
431 (`.sbss') section has invalid (increased) virtual address. */
432
433 static const char *
434 addr_section_name (const char *s)
435 {
436 if (strcmp (s, ".dynbss") == 0)
437 return ".bss";
438 if (strcmp (s, ".sdynbss") == 0)
439 return ".sbss";
440
441 return s;
442 }
443
444 /* std::sort comparator for addrs_section_sort. Sort entries in
445 ascending order by their (name, sectindex) pair. sectindex makes
446 the sort by name stable. */
447
448 static bool
449 addrs_section_compar (const struct other_sections *a,
450 const struct other_sections *b)
451 {
452 int retval;
453
454 retval = strcmp (addr_section_name (a->name.c_str ()),
455 addr_section_name (b->name.c_str ()));
456 if (retval != 0)
457 return retval < 0;
458
459 return a->sectindex < b->sectindex;
460 }
461
462 /* Provide sorted array of pointers to sections of ADDRS. */
463
464 static std::vector<const struct other_sections *>
465 addrs_section_sort (const section_addr_info &addrs)
466 {
467 int i;
468
469 std::vector<const struct other_sections *> array (addrs.size ());
470 for (i = 0; i < addrs.size (); i++)
471 array[i] = &addrs[i];
472
473 std::sort (array.begin (), array.end (), addrs_section_compar);
474
475 return array;
476 }
477
478 /* Relativize absolute addresses in ADDRS into offsets based on ABFD. Fill-in
479 also SECTINDEXes specific to ABFD there. This function can be used to
480 rebase ADDRS to start referencing different BFD than before. */
481
482 void
483 addr_info_make_relative (section_addr_info *addrs, bfd *abfd)
484 {
485 asection *lower_sect;
486 CORE_ADDR lower_offset;
487 int i;
488
489 /* Find lowest loadable section to be used as starting point for
490 contiguous sections. */
491 lower_sect = NULL;
492 for (asection *iter : gdb_bfd_sections (abfd))
493 find_lowest_section (iter, &lower_sect);
494 if (lower_sect == NULL)
495 {
496 warning (_("no loadable sections found in added symbol-file %s"),
497 bfd_get_filename (abfd));
498 lower_offset = 0;
499 }
500 else
501 lower_offset = bfd_section_vma (lower_sect);
502
503 /* Create ADDRS_TO_ABFD_ADDRS array to map the sections in ADDRS to sections
504 in ABFD. Section names are not unique - there can be multiple sections of
505 the same name. Also the sections of the same name do not have to be
506 adjacent to each other. Some sections may be present only in one of the
507 files. Even sections present in both files do not have to be in the same
508 order.
509
510 Use stable sort by name for the sections in both files. Then linearly
511 scan both lists matching as most of the entries as possible. */
512
513 std::vector<const struct other_sections *> addrs_sorted
514 = addrs_section_sort (*addrs);
515
516 section_addr_info abfd_addrs = build_section_addr_info_from_bfd (abfd);
517 std::vector<const struct other_sections *> abfd_addrs_sorted
518 = addrs_section_sort (abfd_addrs);
519
520 /* Now create ADDRS_TO_ABFD_ADDRS from ADDRS_SORTED and
521 ABFD_ADDRS_SORTED. */
522
523 std::vector<const struct other_sections *>
524 addrs_to_abfd_addrs (addrs->size (), nullptr);
525
526 std::vector<const struct other_sections *>::iterator abfd_sorted_iter
527 = abfd_addrs_sorted.begin ();
528 for (const other_sections *sect : addrs_sorted)
529 {
530 const char *sect_name = addr_section_name (sect->name.c_str ());
531
532 while (abfd_sorted_iter != abfd_addrs_sorted.end ()
533 && strcmp (addr_section_name ((*abfd_sorted_iter)->name.c_str ()),
534 sect_name) < 0)
535 abfd_sorted_iter++;
536
537 if (abfd_sorted_iter != abfd_addrs_sorted.end ()
538 && strcmp (addr_section_name ((*abfd_sorted_iter)->name.c_str ()),
539 sect_name) == 0)
540 {
541 int index_in_addrs;
542
543 /* Make the found item directly addressable from ADDRS. */
544 index_in_addrs = sect - addrs->data ();
545 gdb_assert (addrs_to_abfd_addrs[index_in_addrs] == NULL);
546 addrs_to_abfd_addrs[index_in_addrs] = *abfd_sorted_iter;
547
548 /* Never use the same ABFD entry twice. */
549 abfd_sorted_iter++;
550 }
551 }
552
553 /* Calculate offsets for the loadable sections.
554 FIXME! Sections must be in order of increasing loadable section
555 so that contiguous sections can use the lower-offset!!!
556
557 Adjust offsets if the segments are not contiguous.
558 If the section is contiguous, its offset should be set to
559 the offset of the highest loadable section lower than it
560 (the loadable section directly below it in memory).
561 this_offset = lower_offset = lower_addr - lower_orig_addr */
562
563 for (i = 0; i < addrs->size (); i++)
564 {
565 const struct other_sections *sect = addrs_to_abfd_addrs[i];
566
567 if (sect)
568 {
569 /* This is the index used by BFD. */
570 (*addrs)[i].sectindex = sect->sectindex;
571
572 if ((*addrs)[i].addr != 0)
573 {
574 (*addrs)[i].addr -= sect->addr;
575 lower_offset = (*addrs)[i].addr;
576 }
577 else
578 (*addrs)[i].addr = lower_offset;
579 }
580 else
581 {
582 /* addr_section_name transformation is not used for SECT_NAME. */
583 const std::string &sect_name = (*addrs)[i].name;
584
585 /* This section does not exist in ABFD, which is normally
586 unexpected and we want to issue a warning.
587
588 However, the ELF prelinker does create a few sections which are
589 marked in the main executable as loadable (they are loaded in
590 memory from the DYNAMIC segment) and yet are not present in
591 separate debug info files. This is fine, and should not cause
592 a warning. Shared libraries contain just the section
593 ".gnu.liblist" but it is not marked as loadable there. There is
594 no other way to identify them than by their name as the sections
595 created by prelink have no special flags.
596
597 For the sections `.bss' and `.sbss' see addr_section_name. */
598
599 if (!(sect_name == ".gnu.liblist"
600 || sect_name == ".gnu.conflict"
601 || (sect_name == ".bss"
602 && i > 0
603 && (*addrs)[i - 1].name == ".dynbss"
604 && addrs_to_abfd_addrs[i - 1] != NULL)
605 || (sect_name == ".sbss"
606 && i > 0
607 && (*addrs)[i - 1].name == ".sdynbss"
608 && addrs_to_abfd_addrs[i - 1] != NULL)))
609 warning (_("section %s not found in %s"), sect_name.c_str (),
610 bfd_get_filename (abfd));
611
612 (*addrs)[i].addr = 0;
613 (*addrs)[i].sectindex = -1;
614 }
615 }
616 }
617
618 /* Parse the user's idea of an offset for dynamic linking, into our idea
619 of how to represent it for fast symbol reading. This is the default
620 version of the sym_fns.sym_offsets function for symbol readers that
621 don't need to do anything special. It allocates a section_offsets table
622 for the objectfile OBJFILE and stuffs ADDR into all of the offsets. */
623
624 void
625 default_symfile_offsets (struct objfile *objfile,
626 const section_addr_info &addrs)
627 {
628 objfile->section_offsets.resize (gdb_bfd_count_sections (objfile->obfd));
629 relative_addr_info_to_section_offsets (objfile->section_offsets, addrs);
630
631 /* For relocatable files, all loadable sections will start at zero.
632 The zero is meaningless, so try to pick arbitrary addresses such
633 that no loadable sections overlap. This algorithm is quadratic,
634 but the number of sections in a single object file is generally
635 small. */
636 if ((bfd_get_file_flags (objfile->obfd) & (EXEC_P | DYNAMIC)) == 0)
637 {
638 bfd *abfd = objfile->obfd;
639 asection *cur_sec;
640
641 for (cur_sec = abfd->sections; cur_sec != NULL; cur_sec = cur_sec->next)
642 /* We do not expect this to happen; just skip this step if the
643 relocatable file has a section with an assigned VMA. */
644 if (bfd_section_vma (cur_sec) != 0)
645 break;
646
647 if (cur_sec == NULL)
648 {
649 section_offsets &offsets = objfile->section_offsets;
650
651 /* Pick non-overlapping offsets for sections the user did not
652 place explicitly. */
653 CORE_ADDR lowest = 0;
654 for (asection *sect : gdb_bfd_sections (objfile->obfd))
655 place_section (objfile->obfd, sect, objfile->section_offsets,
656 lowest);
657
658 /* Correctly filling in the section offsets is not quite
659 enough. Relocatable files have two properties that
660 (most) shared objects do not:
661
662 - Their debug information will contain relocations. Some
663 shared libraries do also, but many do not, so this can not
664 be assumed.
665
666 - If there are multiple code sections they will be loaded
667 at different relative addresses in memory than they are
668 in the objfile, since all sections in the file will start
669 at address zero.
670
671 Because GDB has very limited ability to map from an
672 address in debug info to the correct code section,
673 it relies on adding SECT_OFF_TEXT to things which might be
674 code. If we clear all the section offsets, and set the
675 section VMAs instead, then symfile_relocate_debug_section
676 will return meaningful debug information pointing at the
677 correct sections.
678
679 GDB has too many different data structures for section
680 addresses - a bfd, objfile, and so_list all have section
681 tables, as does exec_ops. Some of these could probably
682 be eliminated. */
683
684 for (cur_sec = abfd->sections; cur_sec != NULL;
685 cur_sec = cur_sec->next)
686 {
687 if ((bfd_section_flags (cur_sec) & SEC_ALLOC) == 0)
688 continue;
689
690 bfd_set_section_vma (cur_sec, offsets[cur_sec->index]);
691 exec_set_section_address (bfd_get_filename (abfd),
692 cur_sec->index,
693 offsets[cur_sec->index]);
694 offsets[cur_sec->index] = 0;
695 }
696 }
697 }
698
699 /* Remember the bfd indexes for the .text, .data, .bss and
700 .rodata sections. */
701 init_objfile_sect_indices (objfile);
702 }
703
704 /* Divide the file into segments, which are individual relocatable units.
705 This is the default version of the sym_fns.sym_segments function for
706 symbol readers that do not have an explicit representation of segments.
707 It assumes that object files do not have segments, and fully linked
708 files have a single segment. */
709
710 symfile_segment_data_up
711 default_symfile_segments (bfd *abfd)
712 {
713 int num_sections, i;
714 asection *sect;
715 CORE_ADDR low, high;
716
717 /* Relocatable files contain enough information to position each
718 loadable section independently; they should not be relocated
719 in segments. */
720 if ((bfd_get_file_flags (abfd) & (EXEC_P | DYNAMIC)) == 0)
721 return NULL;
722
723 /* Make sure there is at least one loadable section in the file. */
724 for (sect = abfd->sections; sect != NULL; sect = sect->next)
725 {
726 if ((bfd_section_flags (sect) & SEC_ALLOC) == 0)
727 continue;
728
729 break;
730 }
731 if (sect == NULL)
732 return NULL;
733
734 low = bfd_section_vma (sect);
735 high = low + bfd_section_size (sect);
736
737 symfile_segment_data_up data (new symfile_segment_data);
738
739 num_sections = bfd_count_sections (abfd);
740
741 /* All elements are initialized to 0 (map to no segment). */
742 data->segment_info.resize (num_sections);
743
744 for (i = 0, sect = abfd->sections; sect != NULL; i++, sect = sect->next)
745 {
746 CORE_ADDR vma;
747
748 if ((bfd_section_flags (sect) & SEC_ALLOC) == 0)
749 continue;
750
751 vma = bfd_section_vma (sect);
752 if (vma < low)
753 low = vma;
754 if (vma + bfd_section_size (sect) > high)
755 high = vma + bfd_section_size (sect);
756
757 data->segment_info[i] = 1;
758 }
759
760 data->segments.emplace_back (low, high - low);
761
762 return data;
763 }
764
765 /* This is a convenience function to call sym_read for OBJFILE and
766 possibly force the partial symbols to be read. */
767
768 static void
769 read_symbols (struct objfile *objfile, symfile_add_flags add_flags)
770 {
771 (*objfile->sf->sym_read) (objfile, add_flags);
772 objfile->per_bfd->minsyms_read = true;
773
774 /* find_separate_debug_file_in_section should be called only if there is
775 single binary with no existing separate debug info file. */
776 if (!objfile->has_partial_symbols ()
777 && objfile->separate_debug_objfile == NULL
778 && objfile->separate_debug_objfile_backlink == NULL)
779 {
780 gdb_bfd_ref_ptr abfd (find_separate_debug_file_in_section (objfile));
781
782 if (abfd != NULL)
783 {
784 /* find_separate_debug_file_in_section uses the same filename for the
785 virtual section-as-bfd like the bfd filename containing the
786 section. Therefore use also non-canonical name form for the same
787 file containing the section. */
788 symbol_file_add_separate (abfd.get (),
789 bfd_get_filename (abfd.get ()),
790 add_flags | SYMFILE_NOT_FILENAME, objfile);
791 }
792 }
793 if ((add_flags & SYMFILE_NO_READ) == 0)
794 objfile->require_partial_symbols (false);
795 }
796
797 /* Initialize entry point information for this objfile. */
798
799 static void
800 init_entry_point_info (struct objfile *objfile)
801 {
802 struct entry_info *ei = &objfile->per_bfd->ei;
803
804 if (ei->initialized)
805 return;
806 ei->initialized = 1;
807
808 /* Save startup file's range of PC addresses to help blockframe.c
809 decide where the bottom of the stack is. */
810
811 if (bfd_get_file_flags (objfile->obfd) & EXEC_P)
812 {
813 /* Executable file -- record its entry point so we'll recognize
814 the startup file because it contains the entry point. */
815 ei->entry_point = bfd_get_start_address (objfile->obfd);
816 ei->entry_point_p = 1;
817 }
818 else if (bfd_get_file_flags (objfile->obfd) & DYNAMIC
819 && bfd_get_start_address (objfile->obfd) != 0)
820 {
821 /* Some shared libraries may have entry points set and be
822 runnable. There's no clear way to indicate this, so just check
823 for values other than zero. */
824 ei->entry_point = bfd_get_start_address (objfile->obfd);
825 ei->entry_point_p = 1;
826 }
827 else
828 {
829 /* Examination of non-executable.o files. Short-circuit this stuff. */
830 ei->entry_point_p = 0;
831 }
832
833 if (ei->entry_point_p)
834 {
835 struct obj_section *osect;
836 CORE_ADDR entry_point = ei->entry_point;
837 int found;
838
839 /* Make certain that the address points at real code, and not a
840 function descriptor. */
841 entry_point
842 = gdbarch_convert_from_func_ptr_addr (objfile->arch (),
843 entry_point,
844 current_top_target ());
845
846 /* Remove any ISA markers, so that this matches entries in the
847 symbol table. */
848 ei->entry_point
849 = gdbarch_addr_bits_remove (objfile->arch (), entry_point);
850
851 found = 0;
852 ALL_OBJFILE_OSECTIONS (objfile, osect)
853 {
854 struct bfd_section *sect = osect->the_bfd_section;
855
856 if (entry_point >= bfd_section_vma (sect)
857 && entry_point < (bfd_section_vma (sect)
858 + bfd_section_size (sect)))
859 {
860 ei->the_bfd_section_index
861 = gdb_bfd_section_index (objfile->obfd, sect);
862 found = 1;
863 break;
864 }
865 }
866
867 if (!found)
868 ei->the_bfd_section_index = SECT_OFF_TEXT (objfile);
869 }
870 }
871
872 /* Process a symbol file, as either the main file or as a dynamically
873 loaded file.
874
875 This function does not set the OBJFILE's entry-point info.
876
877 OBJFILE is where the symbols are to be read from.
878
879 ADDRS is the list of section load addresses. If the user has given
880 an 'add-symbol-file' command, then this is the list of offsets and
881 addresses he or she provided as arguments to the command; or, if
882 we're handling a shared library, these are the actual addresses the
883 sections are loaded at, according to the inferior's dynamic linker
884 (as gleaned by GDB's shared library code). We convert each address
885 into an offset from the section VMA's as it appears in the object
886 file, and then call the file's sym_offsets function to convert this
887 into a format-specific offset table --- a `section_offsets'.
888 The sectindex field is used to control the ordering of sections
889 with the same name. Upon return, it is updated to contain the
890 corresponding BFD section index, or -1 if the section was not found.
891
892 ADD_FLAGS encodes verbosity level, whether this is main symbol or
893 an extra symbol file such as dynamically loaded code, and whether
894 breakpoint reset should be deferred. */
895
896 static void
897 syms_from_objfile_1 (struct objfile *objfile,
898 section_addr_info *addrs,
899 symfile_add_flags add_flags)
900 {
901 section_addr_info local_addr;
902 const int mainline = add_flags & SYMFILE_MAINLINE;
903
904 objfile_set_sym_fns (objfile, find_sym_fns (objfile->obfd));
905 objfile->qf.clear ();
906
907 if (objfile->sf == NULL)
908 {
909 /* No symbols to load, but we still need to make sure
910 that the section_offsets table is allocated. */
911 int num_sections = gdb_bfd_count_sections (objfile->obfd);
912
913 objfile->section_offsets.assign (num_sections, 0);
914 return;
915 }
916
917 /* Make sure that partially constructed symbol tables will be cleaned up
918 if an error occurs during symbol reading. */
919 gdb::optional<clear_symtab_users_cleanup> defer_clear_users;
920
921 objfile_up objfile_holder (objfile);
922
923 /* If ADDRS is NULL, put together a dummy address list.
924 We now establish the convention that an addr of zero means
925 no load address was specified. */
926 if (! addrs)
927 addrs = &local_addr;
928
929 if (mainline)
930 {
931 /* We will modify the main symbol table, make sure that all its users
932 will be cleaned up if an error occurs during symbol reading. */
933 defer_clear_users.emplace ((symfile_add_flag) 0);
934
935 /* Since no error yet, throw away the old symbol table. */
936
937 if (current_program_space->symfile_object_file != NULL)
938 {
939 current_program_space->symfile_object_file->unlink ();
940 gdb_assert (current_program_space->symfile_object_file == NULL);
941 }
942
943 /* Currently we keep symbols from the add-symbol-file command.
944 If the user wants to get rid of them, they should do "symbol-file"
945 without arguments first. Not sure this is the best behavior
946 (PR 2207). */
947
948 (*objfile->sf->sym_new_init) (objfile);
949 }
950
951 /* Convert addr into an offset rather than an absolute address.
952 We find the lowest address of a loaded segment in the objfile,
953 and assume that <addr> is where that got loaded.
954
955 We no longer warn if the lowest section is not a text segment (as
956 happens for the PA64 port. */
957 if (addrs->size () > 0)
958 addr_info_make_relative (addrs, objfile->obfd);
959
960 /* Initialize symbol reading routines for this objfile, allow complaints to
961 appear for this new file, and record how verbose to be, then do the
962 initial symbol reading for this file. */
963
964 (*objfile->sf->sym_init) (objfile);
965 clear_complaints ();
966
967 (*objfile->sf->sym_offsets) (objfile, *addrs);
968
969 read_symbols (objfile, add_flags);
970
971 /* Discard cleanups as symbol reading was successful. */
972
973 objfile_holder.release ();
974 if (defer_clear_users)
975 defer_clear_users->release ();
976 }
977
978 /* Same as syms_from_objfile_1, but also initializes the objfile
979 entry-point info. */
980
981 static void
982 syms_from_objfile (struct objfile *objfile,
983 section_addr_info *addrs,
984 symfile_add_flags add_flags)
985 {
986 syms_from_objfile_1 (objfile, addrs, add_flags);
987 init_entry_point_info (objfile);
988 }
989
990 /* Perform required actions after either reading in the initial
991 symbols for a new objfile, or mapping in the symbols from a reusable
992 objfile. ADD_FLAGS is a bitmask of enum symfile_add_flags. */
993
994 static void
995 finish_new_objfile (struct objfile *objfile, symfile_add_flags add_flags)
996 {
997 /* If this is the main symbol file we have to clean up all users of the
998 old main symbol file. Otherwise it is sufficient to fixup all the
999 breakpoints that may have been redefined by this symbol file. */
1000 if (add_flags & SYMFILE_MAINLINE)
1001 {
1002 /* OK, make it the "real" symbol file. */
1003 current_program_space->symfile_object_file = objfile;
1004
1005 clear_symtab_users (add_flags);
1006 }
1007 else if ((add_flags & SYMFILE_DEFER_BP_RESET) == 0)
1008 {
1009 breakpoint_re_set ();
1010 }
1011
1012 /* We're done reading the symbol file; finish off complaints. */
1013 clear_complaints ();
1014 }
1015
1016 /* Process a symbol file, as either the main file or as a dynamically
1017 loaded file.
1018
1019 ABFD is a BFD already open on the file, as from symfile_bfd_open.
1020 A new reference is acquired by this function.
1021
1022 For NAME description see the objfile constructor.
1023
1024 ADD_FLAGS encodes verbosity, whether this is main symbol file or
1025 extra, such as dynamically loaded code, and what to do with breakpoints.
1026
1027 ADDRS is as described for syms_from_objfile_1, above.
1028 ADDRS is ignored when SYMFILE_MAINLINE bit is set in ADD_FLAGS.
1029
1030 PARENT is the original objfile if ABFD is a separate debug info file.
1031 Otherwise PARENT is NULL.
1032
1033 Upon success, returns a pointer to the objfile that was added.
1034 Upon failure, jumps back to command level (never returns). */
1035
1036 static struct objfile *
1037 symbol_file_add_with_addrs (bfd *abfd, const char *name,
1038 symfile_add_flags add_flags,
1039 section_addr_info *addrs,
1040 objfile_flags flags, struct objfile *parent)
1041 {
1042 struct objfile *objfile;
1043 const int from_tty = add_flags & SYMFILE_VERBOSE;
1044 const int mainline = add_flags & SYMFILE_MAINLINE;
1045 const int always_confirm = add_flags & SYMFILE_ALWAYS_CONFIRM;
1046 const int should_print = (print_symbol_loading_p (from_tty, mainline, 1)
1047 && (readnow_symbol_files
1048 || (add_flags & SYMFILE_NO_READ) == 0));
1049
1050 if (readnow_symbol_files)
1051 {
1052 flags |= OBJF_READNOW;
1053 add_flags &= ~SYMFILE_NO_READ;
1054 }
1055 else if (readnever_symbol_files
1056 || (parent != NULL && (parent->flags & OBJF_READNEVER)))
1057 {
1058 flags |= OBJF_READNEVER;
1059 add_flags |= SYMFILE_NO_READ;
1060 }
1061 if ((add_flags & SYMFILE_NOT_FILENAME) != 0)
1062 flags |= OBJF_NOT_FILENAME;
1063
1064 /* Give user a chance to burp if ALWAYS_CONFIRM or we'd be
1065 interactively wiping out any existing symbols. */
1066
1067 if (from_tty
1068 && (always_confirm
1069 || ((have_full_symbols () || have_partial_symbols ())
1070 && mainline))
1071 && !query (_("Load new symbol table from \"%s\"? "), name))
1072 error (_("Not confirmed."));
1073
1074 if (mainline)
1075 flags |= OBJF_MAINLINE;
1076 objfile = objfile::make (abfd, name, flags, parent);
1077
1078 /* We either created a new mapped symbol table, mapped an existing
1079 symbol table file which has not had initial symbol reading
1080 performed, or need to read an unmapped symbol table. */
1081 if (should_print)
1082 {
1083 if (deprecated_pre_add_symbol_hook)
1084 deprecated_pre_add_symbol_hook (name);
1085 else
1086 printf_filtered (_("Reading symbols from %ps...\n"),
1087 styled_string (file_name_style.style (), name));
1088 }
1089 syms_from_objfile (objfile, addrs, add_flags);
1090
1091 /* We now have at least a partial symbol table. Check to see if the
1092 user requested that all symbols be read on initial access via either
1093 the gdb startup command line or on a per symbol file basis. Expand
1094 all partial symbol tables for this objfile if so. */
1095
1096 if ((flags & OBJF_READNOW))
1097 {
1098 if (should_print)
1099 printf_filtered (_("Expanding full symbols from %ps...\n"),
1100 styled_string (file_name_style.style (), name));
1101
1102 objfile->expand_all_symtabs ();
1103 }
1104
1105 /* Note that we only print a message if we have no symbols and have
1106 no separate debug file. If there is a separate debug file which
1107 does not have symbols, we'll have emitted this message for that
1108 file, and so printing it twice is just redundant. */
1109 if (should_print && !objfile_has_symbols (objfile)
1110 && objfile->separate_debug_objfile == nullptr)
1111 printf_filtered (_("(No debugging symbols found in %ps)\n"),
1112 styled_string (file_name_style.style (), name));
1113
1114 if (should_print)
1115 {
1116 if (deprecated_post_add_symbol_hook)
1117 deprecated_post_add_symbol_hook ();
1118 }
1119
1120 /* We print some messages regardless of whether 'from_tty ||
1121 info_verbose' is true, so make sure they go out at the right
1122 time. */
1123 gdb_flush (gdb_stdout);
1124
1125 if (objfile->sf == NULL)
1126 {
1127 gdb::observers::new_objfile.notify (objfile);
1128 return objfile; /* No symbols. */
1129 }
1130
1131 finish_new_objfile (objfile, add_flags);
1132
1133 gdb::observers::new_objfile.notify (objfile);
1134
1135 bfd_cache_close_all ();
1136 return (objfile);
1137 }
1138
1139 /* Add BFD as a separate debug file for OBJFILE. For NAME description
1140 see the objfile constructor. */
1141
1142 void
1143 symbol_file_add_separate (bfd *bfd, const char *name,
1144 symfile_add_flags symfile_flags,
1145 struct objfile *objfile)
1146 {
1147 /* Create section_addr_info. We can't directly use offsets from OBJFILE
1148 because sections of BFD may not match sections of OBJFILE and because
1149 vma may have been modified by tools such as prelink. */
1150 section_addr_info sap = build_section_addr_info_from_objfile (objfile);
1151
1152 symbol_file_add_with_addrs
1153 (bfd, name, symfile_flags, &sap,
1154 objfile->flags & (OBJF_REORDERED | OBJF_SHARED | OBJF_READNOW
1155 | OBJF_USERLOADED | OBJF_MAINLINE),
1156 objfile);
1157 }
1158
1159 /* Process the symbol file ABFD, as either the main file or as a
1160 dynamically loaded file.
1161 See symbol_file_add_with_addrs's comments for details. */
1162
1163 struct objfile *
1164 symbol_file_add_from_bfd (bfd *abfd, const char *name,
1165 symfile_add_flags add_flags,
1166 section_addr_info *addrs,
1167 objfile_flags flags, struct objfile *parent)
1168 {
1169 return symbol_file_add_with_addrs (abfd, name, add_flags, addrs, flags,
1170 parent);
1171 }
1172
1173 /* Process a symbol file, as either the main file or as a dynamically
1174 loaded file. See symbol_file_add_with_addrs's comments for details. */
1175
1176 struct objfile *
1177 symbol_file_add (const char *name, symfile_add_flags add_flags,
1178 section_addr_info *addrs, objfile_flags flags)
1179 {
1180 gdb_bfd_ref_ptr bfd (symfile_bfd_open (name));
1181
1182 return symbol_file_add_from_bfd (bfd.get (), name, add_flags, addrs,
1183 flags, NULL);
1184 }
1185
1186 /* Call symbol_file_add() with default values and update whatever is
1187 affected by the loading of a new main().
1188 Used when the file is supplied in the gdb command line
1189 and by some targets with special loading requirements.
1190 The auxiliary function, symbol_file_add_main_1(), has the flags
1191 argument for the switches that can only be specified in the symbol_file
1192 command itself. */
1193
1194 void
1195 symbol_file_add_main (const char *args, symfile_add_flags add_flags)
1196 {
1197 symbol_file_add_main_1 (args, add_flags, 0, 0);
1198 }
1199
1200 static void
1201 symbol_file_add_main_1 (const char *args, symfile_add_flags add_flags,
1202 objfile_flags flags, CORE_ADDR reloff)
1203 {
1204 add_flags |= current_inferior ()->symfile_flags | SYMFILE_MAINLINE;
1205
1206 struct objfile *objfile = symbol_file_add (args, add_flags, NULL, flags);
1207 if (reloff != 0)
1208 objfile_rebase (objfile, reloff);
1209
1210 /* Getting new symbols may change our opinion about
1211 what is frameless. */
1212 reinit_frame_cache ();
1213
1214 if ((add_flags & SYMFILE_NO_READ) == 0)
1215 set_initial_language ();
1216 }
1217
1218 void
1219 symbol_file_clear (int from_tty)
1220 {
1221 if ((have_full_symbols () || have_partial_symbols ())
1222 && from_tty
1223 && (current_program_space->symfile_object_file
1224 ? !query (_("Discard symbol table from `%s'? "),
1225 objfile_name (current_program_space->symfile_object_file))
1226 : !query (_("Discard symbol table? "))))
1227 error (_("Not confirmed."));
1228
1229 /* solib descriptors may have handles to objfiles. Wipe them before their
1230 objfiles get stale by free_all_objfiles. */
1231 no_shared_libraries (NULL, from_tty);
1232
1233 current_program_space->free_all_objfiles ();
1234
1235 clear_symtab_users (0);
1236
1237 gdb_assert (current_program_space->symfile_object_file == NULL);
1238 if (from_tty)
1239 printf_filtered (_("No symbol file now.\n"));
1240 }
1241
1242 /* See symfile.h. */
1243
1244 bool separate_debug_file_debug = false;
1245
1246 static int
1247 separate_debug_file_exists (const std::string &name, unsigned long crc,
1248 struct objfile *parent_objfile)
1249 {
1250 unsigned long file_crc;
1251 int file_crc_p;
1252 struct stat parent_stat, abfd_stat;
1253 int verified_as_different;
1254
1255 /* Find a separate debug info file as if symbols would be present in
1256 PARENT_OBJFILE itself this function would not be called. .gnu_debuglink
1257 section can contain just the basename of PARENT_OBJFILE without any
1258 ".debug" suffix as "/usr/lib/debug/path/to/file" is a separate tree where
1259 the separate debug infos with the same basename can exist. */
1260
1261 if (filename_cmp (name.c_str (), objfile_name (parent_objfile)) == 0)
1262 return 0;
1263
1264 if (separate_debug_file_debug)
1265 {
1266 printf_filtered (_(" Trying %s..."), name.c_str ());
1267 gdb_flush (gdb_stdout);
1268 }
1269
1270 gdb_bfd_ref_ptr abfd (gdb_bfd_open (name.c_str (), gnutarget));
1271
1272 if (abfd == NULL)
1273 {
1274 if (separate_debug_file_debug)
1275 printf_filtered (_(" no, unable to open.\n"));
1276
1277 return 0;
1278 }
1279
1280 /* Verify symlinks were not the cause of filename_cmp name difference above.
1281
1282 Some operating systems, e.g. Windows, do not provide a meaningful
1283 st_ino; they always set it to zero. (Windows does provide a
1284 meaningful st_dev.) Files accessed from gdbservers that do not
1285 support the vFile:fstat packet will also have st_ino set to zero.
1286 Do not indicate a duplicate library in either case. While there
1287 is no guarantee that a system that provides meaningful inode
1288 numbers will never set st_ino to zero, this is merely an
1289 optimization, so we do not need to worry about false negatives. */
1290
1291 if (bfd_stat (abfd.get (), &abfd_stat) == 0
1292 && abfd_stat.st_ino != 0
1293 && bfd_stat (parent_objfile->obfd, &parent_stat) == 0)
1294 {
1295 if (abfd_stat.st_dev == parent_stat.st_dev
1296 && abfd_stat.st_ino == parent_stat.st_ino)
1297 {
1298 if (separate_debug_file_debug)
1299 printf_filtered (_(" no, same file as the objfile.\n"));
1300
1301 return 0;
1302 }
1303 verified_as_different = 1;
1304 }
1305 else
1306 verified_as_different = 0;
1307
1308 file_crc_p = gdb_bfd_crc (abfd.get (), &file_crc);
1309
1310 if (!file_crc_p)
1311 {
1312 if (separate_debug_file_debug)
1313 printf_filtered (_(" no, error computing CRC.\n"));
1314
1315 return 0;
1316 }
1317
1318 if (crc != file_crc)
1319 {
1320 unsigned long parent_crc;
1321
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. */
1325
1326 if (!verified_as_different)
1327 {
1328 if (!gdb_bfd_crc (parent_objfile->obfd, &parent_crc))
1329 {
1330 if (separate_debug_file_debug)
1331 printf_filtered (_(" no, error computing CRC.\n"));
1332
1333 return 0;
1334 }
1335 }
1336
1337 if (verified_as_different || parent_crc != file_crc)
1338 warning (_("the debug information found in \"%s\""
1339 " does not match \"%s\" (CRC mismatch).\n"),
1340 name.c_str (), objfile_name (parent_objfile));
1341
1342 if (separate_debug_file_debug)
1343 printf_filtered (_(" no, CRC doesn't match.\n"));
1344
1345 return 0;
1346 }
1347
1348 if (separate_debug_file_debug)
1349 printf_filtered (_(" yes!\n"));
1350
1351 return 1;
1352 }
1353
1354 char *debug_file_directory = NULL;
1355 static void
1356 show_debug_file_directory (struct ui_file *file, int from_tty,
1357 struct cmd_list_element *c, const char *value)
1358 {
1359 fprintf_filtered (file,
1360 _("The directory where separate debug "
1361 "symbols are searched for is \"%s\".\n"),
1362 value);
1363 }
1364
1365 #if ! defined (DEBUG_SUBDIRECTORY)
1366 #define DEBUG_SUBDIRECTORY ".debug"
1367 #endif
1368
1369 /* Find a separate debuginfo file for OBJFILE, using DIR as the directory
1370 where the original file resides (may not be the same as
1371 dirname(objfile->name) due to symlinks), and DEBUGLINK as the file we are
1372 looking for. CANON_DIR is the "realpath" form of DIR.
1373 DIR must contain a trailing '/'.
1374 Returns the path of the file with separate debug info, or an empty
1375 string. */
1376
1377 static std::string
1378 find_separate_debug_file (const char *dir,
1379 const char *canon_dir,
1380 const char *debuglink,
1381 unsigned long crc32, struct objfile *objfile)
1382 {
1383 if (separate_debug_file_debug)
1384 printf_filtered (_("\nLooking for separate debug info (debug link) for "
1385 "%s\n"), objfile_name (objfile));
1386
1387 /* First try in the same directory as the original file. */
1388 std::string debugfile = dir;
1389 debugfile += debuglink;
1390
1391 if (separate_debug_file_exists (debugfile, crc32, objfile))
1392 return debugfile;
1393
1394 /* Then try in the subdirectory named DEBUG_SUBDIRECTORY. */
1395 debugfile = dir;
1396 debugfile += DEBUG_SUBDIRECTORY;
1397 debugfile += "/";
1398 debugfile += debuglink;
1399
1400 if (separate_debug_file_exists (debugfile, crc32, objfile))
1401 return debugfile;
1402
1403 /* Then try in the global debugfile directories.
1404
1405 Keep backward compatibility so that DEBUG_FILE_DIRECTORY being "" will
1406 cause "/..." lookups. */
1407
1408 bool target_prefix = startswith (dir, "target:");
1409 const char *dir_notarget = target_prefix ? dir + strlen ("target:") : dir;
1410 std::vector<gdb::unique_xmalloc_ptr<char>> debugdir_vec
1411 = dirnames_to_char_ptr_vec (debug_file_directory);
1412 gdb::unique_xmalloc_ptr<char> canon_sysroot = gdb_realpath (gdb_sysroot);
1413
1414 /* MS-Windows/MS-DOS don't allow colons in file names; we must
1415 convert the drive letter into a one-letter directory, so that the
1416 file name resulting from splicing below will be valid.
1417
1418 FIXME: The below only works when GDB runs on MS-Windows/MS-DOS.
1419 There are various remote-debugging scenarios where such a
1420 transformation of the drive letter might be required when GDB runs
1421 on a Posix host, see
1422
1423 https://sourceware.org/ml/gdb-patches/2019-04/msg00605.html
1424
1425 If some of those scenarios need to be supported, we will need to
1426 use a different condition for HAS_DRIVE_SPEC and a different macro
1427 instead of STRIP_DRIVE_SPEC, which work on Posix systems as well. */
1428 std::string drive;
1429 if (HAS_DRIVE_SPEC (dir_notarget))
1430 {
1431 drive = dir_notarget[0];
1432 dir_notarget = STRIP_DRIVE_SPEC (dir_notarget);
1433 }
1434
1435 for (const gdb::unique_xmalloc_ptr<char> &debugdir : debugdir_vec)
1436 {
1437 debugfile = target_prefix ? "target:" : "";
1438 debugfile += debugdir.get ();
1439 debugfile += "/";
1440 debugfile += drive;
1441 debugfile += dir_notarget;
1442 debugfile += debuglink;
1443
1444 if (separate_debug_file_exists (debugfile, crc32, objfile))
1445 return debugfile;
1446
1447 const char *base_path = NULL;
1448 if (canon_dir != NULL)
1449 {
1450 if (canon_sysroot.get () != NULL)
1451 base_path = child_path (canon_sysroot.get (), canon_dir);
1452 else
1453 base_path = child_path (gdb_sysroot, canon_dir);
1454 }
1455 if (base_path != NULL)
1456 {
1457 /* If the file is in the sysroot, try using its base path in
1458 the global debugfile directory. */
1459 debugfile = target_prefix ? "target:" : "";
1460 debugfile += debugdir.get ();
1461 debugfile += "/";
1462 debugfile += base_path;
1463 debugfile += "/";
1464 debugfile += debuglink;
1465
1466 if (separate_debug_file_exists (debugfile, crc32, objfile))
1467 return debugfile;
1468
1469 /* If the file is in the sysroot, try using its base path in
1470 the sysroot's global debugfile directory. */
1471 debugfile = target_prefix ? "target:" : "";
1472 debugfile += gdb_sysroot;
1473 debugfile += debugdir.get ();
1474 debugfile += "/";
1475 debugfile += base_path;
1476 debugfile += "/";
1477 debugfile += debuglink;
1478
1479 if (separate_debug_file_exists (debugfile, crc32, objfile))
1480 return debugfile;
1481 }
1482
1483 }
1484
1485 return std::string ();
1486 }
1487
1488 /* Modify PATH to contain only "[/]directory/" part of PATH.
1489 If there were no directory separators in PATH, PATH will be empty
1490 string on return. */
1491
1492 static void
1493 terminate_after_last_dir_separator (char *path)
1494 {
1495 int i;
1496
1497 /* Strip off the final filename part, leaving the directory name,
1498 followed by a slash. The directory can be relative or absolute. */
1499 for (i = strlen(path) - 1; i >= 0; i--)
1500 if (IS_DIR_SEPARATOR (path[i]))
1501 break;
1502
1503 /* If I is -1 then no directory is present there and DIR will be "". */
1504 path[i + 1] = '\0';
1505 }
1506
1507 /* Find separate debuginfo for OBJFILE (using .gnu_debuglink section).
1508 Returns pathname, or an empty string. */
1509
1510 std::string
1511 find_separate_debug_file_by_debuglink (struct objfile *objfile)
1512 {
1513 unsigned long crc32;
1514
1515 gdb::unique_xmalloc_ptr<char> debuglink
1516 (bfd_get_debug_link_info (objfile->obfd, &crc32));
1517
1518 if (debuglink == NULL)
1519 {
1520 /* There's no separate debug info, hence there's no way we could
1521 load it => no warning. */
1522 return std::string ();
1523 }
1524
1525 std::string dir = objfile_name (objfile);
1526 terminate_after_last_dir_separator (&dir[0]);
1527 gdb::unique_xmalloc_ptr<char> canon_dir (lrealpath (dir.c_str ()));
1528
1529 std::string debugfile
1530 = find_separate_debug_file (dir.c_str (), canon_dir.get (),
1531 debuglink.get (), crc32, objfile);
1532
1533 if (debugfile.empty ())
1534 {
1535 /* For PR gdb/9538, try again with realpath (if different from the
1536 original). */
1537
1538 struct stat st_buf;
1539
1540 if (lstat (objfile_name (objfile), &st_buf) == 0
1541 && S_ISLNK (st_buf.st_mode))
1542 {
1543 gdb::unique_xmalloc_ptr<char> symlink_dir
1544 (lrealpath (objfile_name (objfile)));
1545 if (symlink_dir != NULL)
1546 {
1547 terminate_after_last_dir_separator (symlink_dir.get ());
1548 if (dir != symlink_dir.get ())
1549 {
1550 /* Different directory, so try using it. */
1551 debugfile = find_separate_debug_file (symlink_dir.get (),
1552 symlink_dir.get (),
1553 debuglink.get (),
1554 crc32,
1555 objfile);
1556 }
1557 }
1558 }
1559 }
1560
1561 return debugfile;
1562 }
1563
1564 /* Make sure that OBJF_{READNOW,READNEVER} are not set
1565 simultaneously. */
1566
1567 static void
1568 validate_readnow_readnever (objfile_flags flags)
1569 {
1570 if ((flags & OBJF_READNOW) && (flags & OBJF_READNEVER))
1571 error (_("-readnow and -readnever cannot be used simultaneously"));
1572 }
1573
1574 /* This is the symbol-file command. Read the file, analyze its
1575 symbols, and add a struct symtab to a symtab list. The syntax of
1576 the command is rather bizarre:
1577
1578 1. The function buildargv implements various quoting conventions
1579 which are undocumented and have little or nothing in common with
1580 the way things are quoted (or not quoted) elsewhere in GDB.
1581
1582 2. Options are used, which are not generally used in GDB (perhaps
1583 "set mapped on", "set readnow on" would be better)
1584
1585 3. The order of options matters, which is contrary to GNU
1586 conventions (because it is confusing and inconvenient). */
1587
1588 void
1589 symbol_file_command (const char *args, int from_tty)
1590 {
1591 dont_repeat ();
1592
1593 if (args == NULL)
1594 {
1595 symbol_file_clear (from_tty);
1596 }
1597 else
1598 {
1599 objfile_flags flags = OBJF_USERLOADED;
1600 symfile_add_flags add_flags = 0;
1601 char *name = NULL;
1602 bool stop_processing_options = false;
1603 CORE_ADDR offset = 0;
1604 int idx;
1605 char *arg;
1606
1607 if (from_tty)
1608 add_flags |= SYMFILE_VERBOSE;
1609
1610 gdb_argv built_argv (args);
1611 for (arg = built_argv[0], idx = 0; arg != NULL; arg = built_argv[++idx])
1612 {
1613 if (stop_processing_options || *arg != '-')
1614 {
1615 if (name == NULL)
1616 name = arg;
1617 else
1618 error (_("Unrecognized argument \"%s\""), arg);
1619 }
1620 else if (strcmp (arg, "-readnow") == 0)
1621 flags |= OBJF_READNOW;
1622 else if (strcmp (arg, "-readnever") == 0)
1623 flags |= OBJF_READNEVER;
1624 else if (strcmp (arg, "-o") == 0)
1625 {
1626 arg = built_argv[++idx];
1627 if (arg == NULL)
1628 error (_("Missing argument to -o"));
1629
1630 offset = parse_and_eval_address (arg);
1631 }
1632 else if (strcmp (arg, "--") == 0)
1633 stop_processing_options = true;
1634 else
1635 error (_("Unrecognized argument \"%s\""), arg);
1636 }
1637
1638 if (name == NULL)
1639 error (_("no symbol file name was specified"));
1640
1641 validate_readnow_readnever (flags);
1642
1643 /* Set SYMFILE_DEFER_BP_RESET because the proper displacement for a PIE
1644 (Position Independent Executable) main symbol file will only be
1645 computed by the solib_create_inferior_hook below. Without it,
1646 breakpoint_re_set would fail to insert the breakpoints with the zero
1647 displacement. */
1648 add_flags |= SYMFILE_DEFER_BP_RESET;
1649
1650 symbol_file_add_main_1 (name, add_flags, flags, offset);
1651
1652 solib_create_inferior_hook (from_tty);
1653
1654 /* Now it's safe to re-add the breakpoints. */
1655 breakpoint_re_set ();
1656 }
1657 }
1658
1659 /* Set the initial language. */
1660
1661 void
1662 set_initial_language (void)
1663 {
1664 if (language_mode == language_mode_manual)
1665 return;
1666 enum language lang = main_language ();
1667 /* Make C the default language. */
1668 enum language default_lang = language_c;
1669
1670 if (lang == language_unknown)
1671 {
1672 const char *name = main_name ();
1673 struct symbol *sym
1674 = lookup_symbol_in_language (name, NULL, VAR_DOMAIN, default_lang,
1675 NULL).symbol;
1676
1677 if (sym != NULL)
1678 lang = sym->language ();
1679 }
1680
1681 if (lang == language_unknown)
1682 {
1683 lang = default_lang;
1684 }
1685
1686 set_language (lang);
1687 expected_language = current_language; /* Don't warn the user. */
1688 }
1689
1690 /* Open the file specified by NAME and hand it off to BFD for
1691 preliminary analysis. Return a newly initialized bfd *, which
1692 includes a newly malloc'd` copy of NAME (tilde-expanded and made
1693 absolute). In case of trouble, error() is called. */
1694
1695 gdb_bfd_ref_ptr
1696 symfile_bfd_open (const char *name)
1697 {
1698 int desc = -1;
1699
1700 gdb::unique_xmalloc_ptr<char> absolute_name;
1701 if (!is_target_filename (name))
1702 {
1703 gdb::unique_xmalloc_ptr<char> expanded_name (tilde_expand (name));
1704
1705 /* Look down path for it, allocate 2nd new malloc'd copy. */
1706 desc = openp (getenv ("PATH"),
1707 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
1708 expanded_name.get (), O_RDONLY | O_BINARY, &absolute_name);
1709 #if defined(__GO32__) || defined(_WIN32) || defined (__CYGWIN__)
1710 if (desc < 0)
1711 {
1712 char *exename = (char *) alloca (strlen (expanded_name.get ()) + 5);
1713
1714 strcat (strcpy (exename, expanded_name.get ()), ".exe");
1715 desc = openp (getenv ("PATH"),
1716 OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH,
1717 exename, O_RDONLY | O_BINARY, &absolute_name);
1718 }
1719 #endif
1720 if (desc < 0)
1721 perror_with_name (expanded_name.get ());
1722
1723 name = absolute_name.get ();
1724 }
1725
1726 gdb_bfd_ref_ptr sym_bfd (gdb_bfd_open (name, gnutarget, desc));
1727 if (sym_bfd == NULL)
1728 error (_("`%s': can't open to read symbols: %s."), name,
1729 bfd_errmsg (bfd_get_error ()));
1730
1731 if (!gdb_bfd_has_target_filename (sym_bfd.get ()))
1732 bfd_set_cacheable (sym_bfd.get (), 1);
1733
1734 if (!bfd_check_format (sym_bfd.get (), bfd_object))
1735 error (_("`%s': can't read symbols: %s."), name,
1736 bfd_errmsg (bfd_get_error ()));
1737
1738 return sym_bfd;
1739 }
1740
1741 /* Return the section index for SECTION_NAME on OBJFILE. Return -1 if
1742 the section was not found. */
1743
1744 int
1745 get_section_index (struct objfile *objfile, const char *section_name)
1746 {
1747 asection *sect = bfd_get_section_by_name (objfile->obfd, section_name);
1748
1749 if (sect)
1750 return sect->index;
1751 else
1752 return -1;
1753 }
1754
1755 /* Link SF into the global symtab_fns list.
1756 FLAVOUR is the file format that SF handles.
1757 Called on startup by the _initialize routine in each object file format
1758 reader, to register information about each format the reader is prepared
1759 to handle. */
1760
1761 void
1762 add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *sf)
1763 {
1764 symtab_fns.emplace_back (flavour, sf);
1765 }
1766
1767 /* Initialize OBJFILE to read symbols from its associated BFD. It
1768 either returns or calls error(). The result is an initialized
1769 struct sym_fns in the objfile structure, that contains cached
1770 information about the symbol file. */
1771
1772 static const struct sym_fns *
1773 find_sym_fns (bfd *abfd)
1774 {
1775 enum bfd_flavour our_flavour = bfd_get_flavour (abfd);
1776
1777 if (our_flavour == bfd_target_srec_flavour
1778 || our_flavour == bfd_target_ihex_flavour
1779 || our_flavour == bfd_target_tekhex_flavour)
1780 return NULL; /* No symbols. */
1781
1782 for (const registered_sym_fns &rsf : symtab_fns)
1783 if (our_flavour == rsf.sym_flavour)
1784 return rsf.sym_fns;
1785
1786 error (_("I'm sorry, Dave, I can't do that. Symbol format `%s' unknown."),
1787 bfd_get_target (abfd));
1788 }
1789 \f
1790
1791 /* This function runs the load command of our current target. */
1792
1793 static void
1794 load_command (const char *arg, int from_tty)
1795 {
1796 dont_repeat ();
1797
1798 /* The user might be reloading because the binary has changed. Take
1799 this opportunity to check. */
1800 reopen_exec_file ();
1801 reread_symbols ();
1802
1803 std::string temp;
1804 if (arg == NULL)
1805 {
1806 const char *parg, *prev;
1807
1808 arg = get_exec_file (1);
1809
1810 /* We may need to quote this string so buildargv can pull it
1811 apart. */
1812 prev = parg = arg;
1813 while ((parg = strpbrk (parg, "\\\"'\t ")))
1814 {
1815 temp.append (prev, parg - prev);
1816 prev = parg++;
1817 temp.push_back ('\\');
1818 }
1819 /* If we have not copied anything yet, then we didn't see a
1820 character to quote, and we can just leave ARG unchanged. */
1821 if (!temp.empty ())
1822 {
1823 temp.append (prev);
1824 arg = temp.c_str ();
1825 }
1826 }
1827
1828 target_load (arg, from_tty);
1829
1830 /* After re-loading the executable, we don't really know which
1831 overlays are mapped any more. */
1832 overlay_cache_invalid = 1;
1833 }
1834
1835 /* This version of "load" should be usable for any target. Currently
1836 it is just used for remote targets, not inftarg.c or core files,
1837 on the theory that only in that case is it useful.
1838
1839 Avoiding xmodem and the like seems like a win (a) because we don't have
1840 to worry about finding it, and (b) On VMS, fork() is very slow and so
1841 we don't want to run a subprocess. On the other hand, I'm not sure how
1842 performance compares. */
1843
1844 static int validate_download = 0;
1845
1846 /* Opaque data for load_progress. */
1847 struct load_progress_data
1848 {
1849 /* Cumulative data. */
1850 unsigned long write_count = 0;
1851 unsigned long data_count = 0;
1852 bfd_size_type total_size = 0;
1853 };
1854
1855 /* Opaque data for load_progress for a single section. */
1856 struct load_progress_section_data
1857 {
1858 load_progress_section_data (load_progress_data *cumulative_,
1859 const char *section_name_, ULONGEST section_size_,
1860 CORE_ADDR lma_, gdb_byte *buffer_)
1861 : cumulative (cumulative_), section_name (section_name_),
1862 section_size (section_size_), lma (lma_), buffer (buffer_)
1863 {}
1864
1865 struct load_progress_data *cumulative;
1866
1867 /* Per-section data. */
1868 const char *section_name;
1869 ULONGEST section_sent = 0;
1870 ULONGEST section_size;
1871 CORE_ADDR lma;
1872 gdb_byte *buffer;
1873 };
1874
1875 /* Opaque data for load_section_callback. */
1876 struct load_section_data
1877 {
1878 load_section_data (load_progress_data *progress_data_)
1879 : progress_data (progress_data_)
1880 {}
1881
1882 ~load_section_data ()
1883 {
1884 for (auto &&request : requests)
1885 {
1886 xfree (request.data);
1887 delete ((load_progress_section_data *) request.baton);
1888 }
1889 }
1890
1891 CORE_ADDR load_offset = 0;
1892 struct load_progress_data *progress_data;
1893 std::vector<struct memory_write_request> requests;
1894 };
1895
1896 /* Target write callback routine for progress reporting. */
1897
1898 static void
1899 load_progress (ULONGEST bytes, void *untyped_arg)
1900 {
1901 struct load_progress_section_data *args
1902 = (struct load_progress_section_data *) untyped_arg;
1903 struct load_progress_data *totals;
1904
1905 if (args == NULL)
1906 /* Writing padding data. No easy way to get at the cumulative
1907 stats, so just ignore this. */
1908 return;
1909
1910 totals = args->cumulative;
1911
1912 if (bytes == 0 && args->section_sent == 0)
1913 {
1914 /* The write is just starting. Let the user know we've started
1915 this section. */
1916 current_uiout->message ("Loading section %s, size %s lma %s\n",
1917 args->section_name,
1918 hex_string (args->section_size),
1919 paddress (target_gdbarch (), args->lma));
1920 return;
1921 }
1922
1923 if (validate_download)
1924 {
1925 /* Broken memories and broken monitors manifest themselves here
1926 when bring new computers to life. This doubles already slow
1927 downloads. */
1928 /* NOTE: cagney/1999-10-18: A more efficient implementation
1929 might add a verify_memory() method to the target vector and
1930 then use that. remote.c could implement that method using
1931 the ``qCRC'' packet. */
1932 gdb::byte_vector check (bytes);
1933
1934 if (target_read_memory (args->lma, check.data (), bytes) != 0)
1935 error (_("Download verify read failed at %s"),
1936 paddress (target_gdbarch (), args->lma));
1937 if (memcmp (args->buffer, check.data (), bytes) != 0)
1938 error (_("Download verify compare failed at %s"),
1939 paddress (target_gdbarch (), args->lma));
1940 }
1941 totals->data_count += bytes;
1942 args->lma += bytes;
1943 args->buffer += bytes;
1944 totals->write_count += 1;
1945 args->section_sent += bytes;
1946 if (check_quit_flag ()
1947 || (deprecated_ui_load_progress_hook != NULL
1948 && deprecated_ui_load_progress_hook (args->section_name,
1949 args->section_sent)))
1950 error (_("Canceled the download"));
1951
1952 if (deprecated_show_load_progress != NULL)
1953 deprecated_show_load_progress (args->section_name,
1954 args->section_sent,
1955 args->section_size,
1956 totals->data_count,
1957 totals->total_size);
1958 }
1959
1960 /* Service function for generic_load. */
1961
1962 static void
1963 load_one_section (bfd *abfd, asection *asec,
1964 struct load_section_data *args)
1965 {
1966 bfd_size_type size = bfd_section_size (asec);
1967 const char *sect_name = bfd_section_name (asec);
1968
1969 if ((bfd_section_flags (asec) & SEC_LOAD) == 0)
1970 return;
1971
1972 if (size == 0)
1973 return;
1974
1975 ULONGEST begin = bfd_section_lma (asec) + args->load_offset;
1976 ULONGEST end = begin + size;
1977 gdb_byte *buffer = (gdb_byte *) xmalloc (size);
1978 bfd_get_section_contents (abfd, asec, buffer, 0, size);
1979
1980 load_progress_section_data *section_data
1981 = new load_progress_section_data (args->progress_data, sect_name, size,
1982 begin, buffer);
1983
1984 args->requests.emplace_back (begin, end, buffer, section_data);
1985 }
1986
1987 static void print_transfer_performance (struct ui_file *stream,
1988 unsigned long data_count,
1989 unsigned long write_count,
1990 std::chrono::steady_clock::duration d);
1991
1992 /* See symfile.h. */
1993
1994 void
1995 generic_load (const char *args, int from_tty)
1996 {
1997 struct load_progress_data total_progress;
1998 struct load_section_data cbdata (&total_progress);
1999 struct ui_out *uiout = current_uiout;
2000
2001 if (args == NULL)
2002 error_no_arg (_("file to load"));
2003
2004 gdb_argv argv (args);
2005
2006 gdb::unique_xmalloc_ptr<char> filename (tilde_expand (argv[0]));
2007
2008 if (argv[1] != NULL)
2009 {
2010 const char *endptr;
2011
2012 cbdata.load_offset = strtoulst (argv[1], &endptr, 0);
2013
2014 /* If the last word was not a valid number then
2015 treat it as a file name with spaces in. */
2016 if (argv[1] == endptr)
2017 error (_("Invalid download offset:%s."), argv[1]);
2018
2019 if (argv[2] != NULL)
2020 error (_("Too many parameters."));
2021 }
2022
2023 /* Open the file for loading. */
2024 gdb_bfd_ref_ptr loadfile_bfd (gdb_bfd_open (filename.get (), gnutarget));
2025 if (loadfile_bfd == NULL)
2026 perror_with_name (filename.get ());
2027
2028 if (!bfd_check_format (loadfile_bfd.get (), bfd_object))
2029 {
2030 error (_("\"%s\" is not an object file: %s"), filename.get (),
2031 bfd_errmsg (bfd_get_error ()));
2032 }
2033
2034 for (asection *asec : gdb_bfd_sections (loadfile_bfd))
2035 total_progress.total_size += bfd_section_size (asec);
2036
2037 for (asection *asec : gdb_bfd_sections (loadfile_bfd))
2038 load_one_section (loadfile_bfd.get (), asec, &cbdata);
2039
2040 using namespace std::chrono;
2041
2042 steady_clock::time_point start_time = steady_clock::now ();
2043
2044 if (target_write_memory_blocks (cbdata.requests, flash_discard,
2045 load_progress) != 0)
2046 error (_("Load failed"));
2047
2048 steady_clock::time_point end_time = steady_clock::now ();
2049
2050 CORE_ADDR entry = bfd_get_start_address (loadfile_bfd.get ());
2051 entry = gdbarch_addr_bits_remove (target_gdbarch (), entry);
2052 uiout->text ("Start address ");
2053 uiout->field_core_addr ("address", target_gdbarch (), entry);
2054 uiout->text (", load size ");
2055 uiout->field_unsigned ("load-size", total_progress.data_count);
2056 uiout->text ("\n");
2057 regcache_write_pc (get_current_regcache (), entry);
2058
2059 /* Reset breakpoints, now that we have changed the load image. For
2060 instance, breakpoints may have been set (or reset, by
2061 post_create_inferior) while connected to the target but before we
2062 loaded the program. In that case, the prologue analyzer could
2063 have read instructions from the target to find the right
2064 breakpoint locations. Loading has changed the contents of that
2065 memory. */
2066
2067 breakpoint_re_set ();
2068
2069 print_transfer_performance (gdb_stdout, total_progress.data_count,
2070 total_progress.write_count,
2071 end_time - start_time);
2072 }
2073
2074 /* Report on STREAM the performance of a memory transfer operation,
2075 such as 'load'. DATA_COUNT is the number of bytes transferred.
2076 WRITE_COUNT is the number of separate write operations, or 0, if
2077 that information is not available. TIME is how long the operation
2078 lasted. */
2079
2080 static void
2081 print_transfer_performance (struct ui_file *stream,
2082 unsigned long data_count,
2083 unsigned long write_count,
2084 std::chrono::steady_clock::duration time)
2085 {
2086 using namespace std::chrono;
2087 struct ui_out *uiout = current_uiout;
2088
2089 milliseconds ms = duration_cast<milliseconds> (time);
2090
2091 uiout->text ("Transfer rate: ");
2092 if (ms.count () > 0)
2093 {
2094 unsigned long rate = ((ULONGEST) data_count * 1000) / ms.count ();
2095
2096 if (uiout->is_mi_like_p ())
2097 {
2098 uiout->field_unsigned ("transfer-rate", rate * 8);
2099 uiout->text (" bits/sec");
2100 }
2101 else if (rate < 1024)
2102 {
2103 uiout->field_unsigned ("transfer-rate", rate);
2104 uiout->text (" bytes/sec");
2105 }
2106 else
2107 {
2108 uiout->field_unsigned ("transfer-rate", rate / 1024);
2109 uiout->text (" KB/sec");
2110 }
2111 }
2112 else
2113 {
2114 uiout->field_unsigned ("transferred-bits", (data_count * 8));
2115 uiout->text (" bits in <1 sec");
2116 }
2117 if (write_count > 0)
2118 {
2119 uiout->text (", ");
2120 uiout->field_unsigned ("write-rate", data_count / write_count);
2121 uiout->text (" bytes/write");
2122 }
2123 uiout->text (".\n");
2124 }
2125
2126 /* Add an OFFSET to the start address of each section in OBJF, except
2127 sections that were specified in ADDRS. */
2128
2129 static void
2130 set_objfile_default_section_offset (struct objfile *objf,
2131 const section_addr_info &addrs,
2132 CORE_ADDR offset)
2133 {
2134 /* Add OFFSET to all sections by default. */
2135 section_offsets offsets (objf->section_offsets.size (), offset);
2136
2137 /* Create sorted lists of all sections in ADDRS as well as all
2138 sections in OBJF. */
2139
2140 std::vector<const struct other_sections *> addrs_sorted
2141 = addrs_section_sort (addrs);
2142
2143 section_addr_info objf_addrs
2144 = build_section_addr_info_from_objfile (objf);
2145 std::vector<const struct other_sections *> objf_addrs_sorted
2146 = addrs_section_sort (objf_addrs);
2147
2148 /* Walk the BFD section list, and if a matching section is found in
2149 ADDRS_SORTED_LIST, set its offset to zero to keep its address
2150 unchanged.
2151
2152 Note that both lists may contain multiple sections with the same
2153 name, and then the sections from ADDRS are matched in BFD order
2154 (thanks to sectindex). */
2155
2156 std::vector<const struct other_sections *>::iterator addrs_sorted_iter
2157 = addrs_sorted.begin ();
2158 for (const other_sections *objf_sect : objf_addrs_sorted)
2159 {
2160 const char *objf_name = addr_section_name (objf_sect->name.c_str ());
2161 int cmp = -1;
2162
2163 while (cmp < 0 && addrs_sorted_iter != addrs_sorted.end ())
2164 {
2165 const struct other_sections *sect = *addrs_sorted_iter;
2166 const char *sect_name = addr_section_name (sect->name.c_str ());
2167 cmp = strcmp (sect_name, objf_name);
2168 if (cmp <= 0)
2169 ++addrs_sorted_iter;
2170 }
2171
2172 if (cmp == 0)
2173 offsets[objf_sect->sectindex] = 0;
2174 }
2175
2176 /* Apply the new section offsets. */
2177 objfile_relocate (objf, offsets);
2178 }
2179
2180 /* This function allows the addition of incrementally linked object files.
2181 It does not modify any state in the target, only in the debugger. */
2182
2183 static void
2184 add_symbol_file_command (const char *args, int from_tty)
2185 {
2186 struct gdbarch *gdbarch = get_current_arch ();
2187 gdb::unique_xmalloc_ptr<char> filename;
2188 char *arg;
2189 int argcnt = 0;
2190 struct objfile *objf;
2191 objfile_flags flags = OBJF_USERLOADED | OBJF_SHARED;
2192 symfile_add_flags add_flags = 0;
2193
2194 if (from_tty)
2195 add_flags |= SYMFILE_VERBOSE;
2196
2197 struct sect_opt
2198 {
2199 const char *name;
2200 const char *value;
2201 };
2202
2203 std::vector<sect_opt> sect_opts = { { ".text", NULL } };
2204 bool stop_processing_options = false;
2205 CORE_ADDR offset = 0;
2206
2207 dont_repeat ();
2208
2209 if (args == NULL)
2210 error (_("add-symbol-file takes a file name and an address"));
2211
2212 bool seen_addr = false;
2213 bool seen_offset = false;
2214 gdb_argv argv (args);
2215
2216 for (arg = argv[0], argcnt = 0; arg != NULL; arg = argv[++argcnt])
2217 {
2218 if (stop_processing_options || *arg != '-')
2219 {
2220 if (filename == NULL)
2221 {
2222 /* First non-option argument is always the filename. */
2223 filename.reset (tilde_expand (arg));
2224 }
2225 else if (!seen_addr)
2226 {
2227 /* The second non-option argument is always the text
2228 address at which to load the program. */
2229 sect_opts[0].value = arg;
2230 seen_addr = true;
2231 }
2232 else
2233 error (_("Unrecognized argument \"%s\""), arg);
2234 }
2235 else if (strcmp (arg, "-readnow") == 0)
2236 flags |= OBJF_READNOW;
2237 else if (strcmp (arg, "-readnever") == 0)
2238 flags |= OBJF_READNEVER;
2239 else if (strcmp (arg, "-s") == 0)
2240 {
2241 if (argv[argcnt + 1] == NULL)
2242 error (_("Missing section name after \"-s\""));
2243 else if (argv[argcnt + 2] == NULL)
2244 error (_("Missing section address after \"-s\""));
2245
2246 sect_opt sect = { argv[argcnt + 1], argv[argcnt + 2] };
2247
2248 sect_opts.push_back (sect);
2249 argcnt += 2;
2250 }
2251 else if (strcmp (arg, "-o") == 0)
2252 {
2253 arg = argv[++argcnt];
2254 if (arg == NULL)
2255 error (_("Missing argument to -o"));
2256
2257 offset = parse_and_eval_address (arg);
2258 seen_offset = true;
2259 }
2260 else if (strcmp (arg, "--") == 0)
2261 stop_processing_options = true;
2262 else
2263 error (_("Unrecognized argument \"%s\""), arg);
2264 }
2265
2266 if (filename == NULL)
2267 error (_("You must provide a filename to be loaded."));
2268
2269 validate_readnow_readnever (flags);
2270
2271 /* Print the prompt for the query below. And save the arguments into
2272 a sect_addr_info structure to be passed around to other
2273 functions. We have to split this up into separate print
2274 statements because hex_string returns a local static
2275 string. */
2276
2277 printf_unfiltered (_("add symbol table from file \"%s\""),
2278 filename.get ());
2279 section_addr_info section_addrs;
2280 std::vector<sect_opt>::const_iterator it = sect_opts.begin ();
2281 if (!seen_addr)
2282 ++it;
2283 for (; it != sect_opts.end (); ++it)
2284 {
2285 CORE_ADDR addr;
2286 const char *val = it->value;
2287 const char *sec = it->name;
2288
2289 if (section_addrs.empty ())
2290 printf_unfiltered (_(" at\n"));
2291 addr = parse_and_eval_address (val);
2292
2293 /* Here we store the section offsets in the order they were
2294 entered on the command line. Every array element is
2295 assigned an ascending section index to preserve the above
2296 order over an unstable sorting algorithm. This dummy
2297 index is not used for any other purpose.
2298 */
2299 section_addrs.emplace_back (addr, sec, section_addrs.size ());
2300 printf_filtered ("\t%s_addr = %s\n", sec,
2301 paddress (gdbarch, addr));
2302
2303 /* The object's sections are initialized when a
2304 call is made to build_objfile_section_table (objfile).
2305 This happens in reread_symbols.
2306 At this point, we don't know what file type this is,
2307 so we can't determine what section names are valid. */
2308 }
2309 if (seen_offset)
2310 printf_unfiltered (_("%s offset by %s\n"),
2311 (section_addrs.empty ()
2312 ? _(" with all sections")
2313 : _("with other sections")),
2314 paddress (gdbarch, offset));
2315 else if (section_addrs.empty ())
2316 printf_unfiltered ("\n");
2317
2318 if (from_tty && (!query ("%s", "")))
2319 error (_("Not confirmed."));
2320
2321 objf = symbol_file_add (filename.get (), add_flags, &section_addrs,
2322 flags);
2323 if (!objfile_has_symbols (objf) && objf->per_bfd->minimal_symbol_count <= 0)
2324 warning (_("newly-added symbol file \"%s\" does not provide any symbols"),
2325 filename.get ());
2326
2327 if (seen_offset)
2328 set_objfile_default_section_offset (objf, section_addrs, offset);
2329
2330 current_program_space->add_target_sections (objf);
2331
2332 /* Getting new symbols may change our opinion about what is
2333 frameless. */
2334 reinit_frame_cache ();
2335 }
2336 \f
2337
2338 /* This function removes a symbol file that was added via add-symbol-file. */
2339
2340 static void
2341 remove_symbol_file_command (const char *args, int from_tty)
2342 {
2343 struct objfile *objf = NULL;
2344 struct program_space *pspace = current_program_space;
2345
2346 dont_repeat ();
2347
2348 if (args == NULL)
2349 error (_("remove-symbol-file: no symbol file provided"));
2350
2351 gdb_argv argv (args);
2352
2353 if (strcmp (argv[0], "-a") == 0)
2354 {
2355 /* Interpret the next argument as an address. */
2356 CORE_ADDR addr;
2357
2358 if (argv[1] == NULL)
2359 error (_("Missing address argument"));
2360
2361 if (argv[2] != NULL)
2362 error (_("Junk after %s"), argv[1]);
2363
2364 addr = parse_and_eval_address (argv[1]);
2365
2366 for (objfile *objfile : current_program_space->objfiles ())
2367 {
2368 if ((objfile->flags & OBJF_USERLOADED) != 0
2369 && (objfile->flags & OBJF_SHARED) != 0
2370 && objfile->pspace == pspace
2371 && is_addr_in_objfile (addr, objfile))
2372 {
2373 objf = objfile;
2374 break;
2375 }
2376 }
2377 }
2378 else if (argv[0] != NULL)
2379 {
2380 /* Interpret the current argument as a file name. */
2381
2382 if (argv[1] != NULL)
2383 error (_("Junk after %s"), argv[0]);
2384
2385 gdb::unique_xmalloc_ptr<char> filename (tilde_expand (argv[0]));
2386
2387 for (objfile *objfile : current_program_space->objfiles ())
2388 {
2389 if ((objfile->flags & OBJF_USERLOADED) != 0
2390 && (objfile->flags & OBJF_SHARED) != 0
2391 && objfile->pspace == pspace
2392 && filename_cmp (filename.get (), objfile_name (objfile)) == 0)
2393 {
2394 objf = objfile;
2395 break;
2396 }
2397 }
2398 }
2399
2400 if (objf == NULL)
2401 error (_("No symbol file found"));
2402
2403 if (from_tty
2404 && !query (_("Remove symbol table from file \"%s\"? "),
2405 objfile_name (objf)))
2406 error (_("Not confirmed."));
2407
2408 objf->unlink ();
2409 clear_symtab_users (0);
2410 }
2411
2412 /* Re-read symbols if a symbol-file has changed. */
2413
2414 void
2415 reread_symbols (void)
2416 {
2417 long new_modtime;
2418 struct stat new_statbuf;
2419 int res;
2420 std::vector<struct objfile *> new_objfiles;
2421
2422 for (objfile *objfile : current_program_space->objfiles ())
2423 {
2424 if (objfile->obfd == NULL)
2425 continue;
2426
2427 /* Separate debug objfiles are handled in the main objfile. */
2428 if (objfile->separate_debug_objfile_backlink)
2429 continue;
2430
2431 /* If this object is from an archive (what you usually create with
2432 `ar', often called a `static library' on most systems, though
2433 a `shared library' on AIX is also an archive), then you should
2434 stat on the archive name, not member name. */
2435 if (objfile->obfd->my_archive)
2436 res = stat (bfd_get_filename (objfile->obfd->my_archive), &new_statbuf);
2437 else
2438 res = stat (objfile_name (objfile), &new_statbuf);
2439 if (res != 0)
2440 {
2441 /* FIXME, should use print_sys_errmsg but it's not filtered. */
2442 printf_filtered (_("`%s' has disappeared; keeping its symbols.\n"),
2443 objfile_name (objfile));
2444 continue;
2445 }
2446 new_modtime = new_statbuf.st_mtime;
2447 if (new_modtime != objfile->mtime)
2448 {
2449 printf_filtered (_("`%s' has changed; re-reading symbols.\n"),
2450 objfile_name (objfile));
2451
2452 /* There are various functions like symbol_file_add,
2453 symfile_bfd_open, syms_from_objfile, etc., which might
2454 appear to do what we want. But they have various other
2455 effects which we *don't* want. So we just do stuff
2456 ourselves. We don't worry about mapped files (for one thing,
2457 any mapped file will be out of date). */
2458
2459 /* If we get an error, blow away this objfile (not sure if
2460 that is the correct response for things like shared
2461 libraries). */
2462 objfile_up objfile_holder (objfile);
2463
2464 /* We need to do this whenever any symbols go away. */
2465 clear_symtab_users_cleanup defer_clear_users (0);
2466
2467 if (current_program_space->exec_bfd () != NULL
2468 && filename_cmp (bfd_get_filename (objfile->obfd),
2469 bfd_get_filename (current_program_space->exec_bfd ())) == 0)
2470 {
2471 /* Reload EXEC_BFD without asking anything. */
2472
2473 exec_file_attach (bfd_get_filename (objfile->obfd), 0);
2474 }
2475
2476 /* Keep the calls order approx. the same as in free_objfile. */
2477
2478 /* Free the separate debug objfiles. It will be
2479 automatically recreated by sym_read. */
2480 free_objfile_separate_debug (objfile);
2481
2482 /* Clear the stale source cache. */
2483 forget_cached_source_info ();
2484
2485 /* Remove any references to this objfile in the global
2486 value lists. */
2487 preserve_values (objfile);
2488
2489 /* Nuke all the state that we will re-read. Much of the following
2490 code which sets things to NULL really is necessary to tell
2491 other parts of GDB that there is nothing currently there.
2492
2493 Try to keep the freeing order compatible with free_objfile. */
2494
2495 if (objfile->sf != NULL)
2496 {
2497 (*objfile->sf->sym_finish) (objfile);
2498 }
2499
2500 clear_objfile_data (objfile);
2501
2502 /* Clean up any state BFD has sitting around. */
2503 {
2504 gdb_bfd_ref_ptr obfd (objfile->obfd);
2505 const char *obfd_filename;
2506
2507 obfd_filename = bfd_get_filename (objfile->obfd);
2508 /* Open the new BFD before freeing the old one, so that
2509 the filename remains live. */
2510 gdb_bfd_ref_ptr temp (gdb_bfd_open (obfd_filename, gnutarget));
2511 objfile->obfd = temp.release ();
2512 if (objfile->obfd == NULL)
2513 error (_("Can't open %s to read symbols."), obfd_filename);
2514 }
2515
2516 std::string original_name = objfile->original_name;
2517
2518 /* bfd_openr sets cacheable to true, which is what we want. */
2519 if (!bfd_check_format (objfile->obfd, bfd_object))
2520 error (_("Can't read symbols from %s: %s."), objfile_name (objfile),
2521 bfd_errmsg (bfd_get_error ()));
2522
2523 /* NB: after this call to obstack_free, objfiles_changed
2524 will need to be called (see discussion below). */
2525 obstack_free (&objfile->objfile_obstack, 0);
2526 objfile->sections = NULL;
2527 objfile->section_offsets.clear ();
2528 objfile->sect_index_bss = -1;
2529 objfile->sect_index_data = -1;
2530 objfile->sect_index_rodata = -1;
2531 objfile->sect_index_text = -1;
2532 objfile->compunit_symtabs = NULL;
2533 objfile->template_symbols = NULL;
2534 objfile->static_links.reset (nullptr);
2535
2536 /* obstack_init also initializes the obstack so it is
2537 empty. We could use obstack_specify_allocation but
2538 gdb_obstack.h specifies the alloc/dealloc functions. */
2539 obstack_init (&objfile->objfile_obstack);
2540
2541 /* set_objfile_per_bfd potentially allocates the per-bfd
2542 data on the objfile's obstack (if sharing data across
2543 multiple users is not possible), so it's important to
2544 do it *after* the obstack has been initialized. */
2545 set_objfile_per_bfd (objfile);
2546
2547 objfile->original_name
2548 = obstack_strdup (&objfile->objfile_obstack, original_name);
2549
2550 /* Reset the sym_fns pointer. The ELF reader can change it
2551 based on whether .gdb_index is present, and we need it to
2552 start over. PR symtab/15885 */
2553 objfile_set_sym_fns (objfile, find_sym_fns (objfile->obfd));
2554 objfile->qf.clear ();
2555
2556 build_objfile_section_table (objfile);
2557
2558 /* What the hell is sym_new_init for, anyway? The concept of
2559 distinguishing between the main file and additional files
2560 in this way seems rather dubious. */
2561 if (objfile == current_program_space->symfile_object_file)
2562 {
2563 (*objfile->sf->sym_new_init) (objfile);
2564 }
2565
2566 (*objfile->sf->sym_init) (objfile);
2567 clear_complaints ();
2568
2569 objfile->flags &= ~OBJF_PSYMTABS_READ;
2570
2571 /* We are about to read new symbols and potentially also
2572 DWARF information. Some targets may want to pass addresses
2573 read from DWARF DIE's through an adjustment function before
2574 saving them, like MIPS, which may call into
2575 "find_pc_section". When called, that function will make
2576 use of per-objfile program space data.
2577
2578 Since we discarded our section information above, we have
2579 dangling pointers in the per-objfile program space data
2580 structure. Force GDB to update the section mapping
2581 information by letting it know the objfile has changed,
2582 making the dangling pointers point to correct data
2583 again. */
2584
2585 objfiles_changed ();
2586
2587 /* Recompute section offsets and section indices. */
2588 objfile->sf->sym_offsets (objfile, {});
2589
2590 read_symbols (objfile, 0);
2591
2592 if (!objfile_has_symbols (objfile))
2593 {
2594 wrap_here ("");
2595 printf_filtered (_("(no debugging symbols found)\n"));
2596 wrap_here ("");
2597 }
2598
2599 /* We're done reading the symbol file; finish off complaints. */
2600 clear_complaints ();
2601
2602 /* Getting new symbols may change our opinion about what is
2603 frameless. */
2604
2605 reinit_frame_cache ();
2606
2607 /* Discard cleanups as symbol reading was successful. */
2608 objfile_holder.release ();
2609 defer_clear_users.release ();
2610
2611 /* If the mtime has changed between the time we set new_modtime
2612 and now, we *want* this to be out of date, so don't call stat
2613 again now. */
2614 objfile->mtime = new_modtime;
2615 init_entry_point_info (objfile);
2616
2617 new_objfiles.push_back (objfile);
2618 }
2619 }
2620
2621 if (!new_objfiles.empty ())
2622 {
2623 clear_symtab_users (0);
2624
2625 /* clear_objfile_data for each objfile was called before freeing it and
2626 gdb::observers::new_objfile.notify (NULL) has been called by
2627 clear_symtab_users above. Notify the new files now. */
2628 for (auto iter : new_objfiles)
2629 gdb::observers::new_objfile.notify (iter);
2630
2631 /* At least one objfile has changed, so we can consider that
2632 the executable we're debugging has changed too. */
2633 gdb::observers::executable_changed.notify ();
2634 }
2635 }
2636 \f
2637
2638 struct filename_language
2639 {
2640 filename_language (const std::string &ext_, enum language lang_)
2641 : ext (ext_), lang (lang_)
2642 {}
2643
2644 std::string ext;
2645 enum language lang;
2646 };
2647
2648 static std::vector<filename_language> filename_language_table;
2649
2650 /* See symfile.h. */
2651
2652 void
2653 add_filename_language (const char *ext, enum language lang)
2654 {
2655 gdb_assert (ext != nullptr);
2656 filename_language_table.emplace_back (ext, lang);
2657 }
2658
2659 static char *ext_args;
2660 static void
2661 show_ext_args (struct ui_file *file, int from_tty,
2662 struct cmd_list_element *c, const char *value)
2663 {
2664 fprintf_filtered (file,
2665 _("Mapping between filename extension "
2666 "and source language is \"%s\".\n"),
2667 value);
2668 }
2669
2670 static void
2671 set_ext_lang_command (const char *args,
2672 int from_tty, struct cmd_list_element *e)
2673 {
2674 char *cp = ext_args;
2675 enum language lang;
2676
2677 /* First arg is filename extension, starting with '.' */
2678 if (*cp != '.')
2679 error (_("'%s': Filename extension must begin with '.'"), ext_args);
2680
2681 /* Find end of first arg. */
2682 while (*cp && !isspace (*cp))
2683 cp++;
2684
2685 if (*cp == '\0')
2686 error (_("'%s': two arguments required -- "
2687 "filename extension and language"),
2688 ext_args);
2689
2690 /* Null-terminate first arg. */
2691 *cp++ = '\0';
2692
2693 /* Find beginning of second arg, which should be a source language. */
2694 cp = skip_spaces (cp);
2695
2696 if (*cp == '\0')
2697 error (_("'%s': two arguments required -- "
2698 "filename extension and language"),
2699 ext_args);
2700
2701 /* Lookup the language from among those we know. */
2702 lang = language_enum (cp);
2703
2704 auto it = filename_language_table.begin ();
2705 /* Now lookup the filename extension: do we already know it? */
2706 for (; it != filename_language_table.end (); it++)
2707 {
2708 if (it->ext == ext_args)
2709 break;
2710 }
2711
2712 if (it == filename_language_table.end ())
2713 {
2714 /* New file extension. */
2715 add_filename_language (ext_args, lang);
2716 }
2717 else
2718 {
2719 /* Redefining a previously known filename extension. */
2720
2721 /* if (from_tty) */
2722 /* query ("Really make files of type %s '%s'?", */
2723 /* ext_args, language_str (lang)); */
2724
2725 it->lang = lang;
2726 }
2727 }
2728
2729 static void
2730 info_ext_lang_command (const char *args, int from_tty)
2731 {
2732 printf_filtered (_("Filename extensions and the languages they represent:"));
2733 printf_filtered ("\n\n");
2734 for (const filename_language &entry : filename_language_table)
2735 printf_filtered ("\t%s\t- %s\n", entry.ext.c_str (),
2736 language_str (entry.lang));
2737 }
2738
2739 enum language
2740 deduce_language_from_filename (const char *filename)
2741 {
2742 const char *cp;
2743
2744 if (filename != NULL)
2745 if ((cp = strrchr (filename, '.')) != NULL)
2746 {
2747 for (const filename_language &entry : filename_language_table)
2748 if (entry.ext == cp)
2749 return entry.lang;
2750 }
2751
2752 return language_unknown;
2753 }
2754 \f
2755 /* Allocate and initialize a new symbol table.
2756 CUST is from the result of allocate_compunit_symtab. */
2757
2758 struct symtab *
2759 allocate_symtab (struct compunit_symtab *cust, const char *filename)
2760 {
2761 struct objfile *objfile = cust->objfile;
2762 struct symtab *symtab
2763 = OBSTACK_ZALLOC (&objfile->objfile_obstack, struct symtab);
2764
2765 symtab->filename = objfile->intern (filename);
2766 symtab->fullname = NULL;
2767 symtab->language = deduce_language_from_filename (filename);
2768
2769 /* This can be very verbose with lots of headers.
2770 Only print at higher debug levels. */
2771 if (symtab_create_debug >= 2)
2772 {
2773 /* Be a bit clever with debugging messages, and don't print objfile
2774 every time, only when it changes. */
2775 static char *last_objfile_name = NULL;
2776
2777 if (last_objfile_name == NULL
2778 || strcmp (last_objfile_name, objfile_name (objfile)) != 0)
2779 {
2780 xfree (last_objfile_name);
2781 last_objfile_name = xstrdup (objfile_name (objfile));
2782 fprintf_filtered (gdb_stdlog,
2783 "Creating one or more symtabs for objfile %s ...\n",
2784 last_objfile_name);
2785 }
2786 fprintf_filtered (gdb_stdlog,
2787 "Created symtab %s for module %s.\n",
2788 host_address_to_string (symtab), filename);
2789 }
2790
2791 /* Add it to CUST's list of symtabs. */
2792 if (cust->filetabs == NULL)
2793 {
2794 cust->filetabs = symtab;
2795 cust->last_filetab = symtab;
2796 }
2797 else
2798 {
2799 cust->last_filetab->next = symtab;
2800 cust->last_filetab = symtab;
2801 }
2802
2803 /* Backlink to the containing compunit symtab. */
2804 symtab->compunit_symtab = cust;
2805
2806 return symtab;
2807 }
2808
2809 /* Allocate and initialize a new compunit.
2810 NAME is the name of the main source file, if there is one, or some
2811 descriptive text if there are no source files. */
2812
2813 struct compunit_symtab *
2814 allocate_compunit_symtab (struct objfile *objfile, const char *name)
2815 {
2816 struct compunit_symtab *cu = OBSTACK_ZALLOC (&objfile->objfile_obstack,
2817 struct compunit_symtab);
2818 const char *saved_name;
2819
2820 cu->objfile = objfile;
2821
2822 /* The name we record here is only for display/debugging purposes.
2823 Just save the basename to avoid path issues (too long for display,
2824 relative vs absolute, etc.). */
2825 saved_name = lbasename (name);
2826 cu->name = obstack_strdup (&objfile->objfile_obstack, saved_name);
2827
2828 COMPUNIT_DEBUGFORMAT (cu) = "unknown";
2829
2830 if (symtab_create_debug)
2831 {
2832 fprintf_filtered (gdb_stdlog,
2833 "Created compunit symtab %s for %s.\n",
2834 host_address_to_string (cu),
2835 cu->name);
2836 }
2837
2838 return cu;
2839 }
2840
2841 /* Hook CU to the objfile it comes from. */
2842
2843 void
2844 add_compunit_symtab_to_objfile (struct compunit_symtab *cu)
2845 {
2846 cu->next = cu->objfile->compunit_symtabs;
2847 cu->objfile->compunit_symtabs = cu;
2848 }
2849 \f
2850
2851 /* Reset all data structures in gdb which may contain references to
2852 symbol table data. */
2853
2854 void
2855 clear_symtab_users (symfile_add_flags add_flags)
2856 {
2857 /* Someday, we should do better than this, by only blowing away
2858 the things that really need to be blown. */
2859
2860 /* Clear the "current" symtab first, because it is no longer valid.
2861 breakpoint_re_set may try to access the current symtab. */
2862 clear_current_source_symtab_and_line ();
2863
2864 clear_displays ();
2865 clear_last_displayed_sal ();
2866 clear_pc_function_cache ();
2867 gdb::observers::new_objfile.notify (NULL);
2868
2869 /* Varobj may refer to old symbols, perform a cleanup. */
2870 varobj_invalidate ();
2871
2872 /* Now that the various caches have been cleared, we can re_set
2873 our breakpoints without risking it using stale data. */
2874 if ((add_flags & SYMFILE_DEFER_BP_RESET) == 0)
2875 breakpoint_re_set ();
2876 }
2877 \f
2878 /* OVERLAYS:
2879 The following code implements an abstraction for debugging overlay sections.
2880
2881 The target model is as follows:
2882 1) The gnu linker will permit multiple sections to be mapped into the
2883 same VMA, each with its own unique LMA (or load address).
2884 2) It is assumed that some runtime mechanism exists for mapping the
2885 sections, one by one, from the load address into the VMA address.
2886 3) This code provides a mechanism for gdb to keep track of which
2887 sections should be considered to be mapped from the VMA to the LMA.
2888 This information is used for symbol lookup, and memory read/write.
2889 For instance, if a section has been mapped then its contents
2890 should be read from the VMA, otherwise from the LMA.
2891
2892 Two levels of debugger support for overlays are available. One is
2893 "manual", in which the debugger relies on the user to tell it which
2894 overlays are currently mapped. This level of support is
2895 implemented entirely in the core debugger, and the information about
2896 whether a section is mapped is kept in the objfile->obj_section table.
2897
2898 The second level of support is "automatic", and is only available if
2899 the target-specific code provides functionality to read the target's
2900 overlay mapping table, and translate its contents for the debugger
2901 (by updating the mapped state information in the obj_section tables).
2902
2903 The interface is as follows:
2904 User commands:
2905 overlay map <name> -- tell gdb to consider this section mapped
2906 overlay unmap <name> -- tell gdb to consider this section unmapped
2907 overlay list -- list the sections that GDB thinks are mapped
2908 overlay read-target -- get the target's state of what's mapped
2909 overlay off/manual/auto -- set overlay debugging state
2910 Functional interface:
2911 find_pc_mapped_section(pc): if the pc is in the range of a mapped
2912 section, return that section.
2913 find_pc_overlay(pc): find any overlay section that contains
2914 the pc, either in its VMA or its LMA
2915 section_is_mapped(sect): true if overlay is marked as mapped
2916 section_is_overlay(sect): true if section's VMA != LMA
2917 pc_in_mapped_range(pc,sec): true if pc belongs to section's VMA
2918 pc_in_unmapped_range(...): true if pc belongs to section's LMA
2919 sections_overlap(sec1, sec2): true if mapped sec1 and sec2 ranges overlap
2920 overlay_mapped_address(...): map an address from section's LMA to VMA
2921 overlay_unmapped_address(...): map an address from section's VMA to LMA
2922 symbol_overlayed_address(...): Return a "current" address for symbol:
2923 either in VMA or LMA depending on whether
2924 the symbol's section is currently mapped. */
2925
2926 /* Overlay debugging state: */
2927
2928 enum overlay_debugging_state overlay_debugging = ovly_off;
2929 int overlay_cache_invalid = 0; /* True if need to refresh mapped state. */
2930
2931 /* Function: section_is_overlay (SECTION)
2932 Returns true if SECTION has VMA not equal to LMA, ie.
2933 SECTION is loaded at an address different from where it will "run". */
2934
2935 int
2936 section_is_overlay (struct obj_section *section)
2937 {
2938 if (overlay_debugging && section)
2939 {
2940 asection *bfd_section = section->the_bfd_section;
2941
2942 if (bfd_section_lma (bfd_section) != 0
2943 && bfd_section_lma (bfd_section) != bfd_section_vma (bfd_section))
2944 return 1;
2945 }
2946
2947 return 0;
2948 }
2949
2950 /* Function: overlay_invalidate_all (void)
2951 Invalidate the mapped state of all overlay sections (mark it as stale). */
2952
2953 static void
2954 overlay_invalidate_all (void)
2955 {
2956 struct obj_section *sect;
2957
2958 for (objfile *objfile : current_program_space->objfiles ())
2959 ALL_OBJFILE_OSECTIONS (objfile, sect)
2960 if (section_is_overlay (sect))
2961 sect->ovly_mapped = -1;
2962 }
2963
2964 /* Function: section_is_mapped (SECTION)
2965 Returns true if section is an overlay, and is currently mapped.
2966
2967 Access to the ovly_mapped flag is restricted to this function, so
2968 that we can do automatic update. If the global flag
2969 OVERLAY_CACHE_INVALID is set (by wait_for_inferior), then call
2970 overlay_invalidate_all. If the mapped state of the particular
2971 section is stale, then call TARGET_OVERLAY_UPDATE to refresh it. */
2972
2973 int
2974 section_is_mapped (struct obj_section *osect)
2975 {
2976 struct gdbarch *gdbarch;
2977
2978 if (osect == 0 || !section_is_overlay (osect))
2979 return 0;
2980
2981 switch (overlay_debugging)
2982 {
2983 default:
2984 case ovly_off:
2985 return 0; /* overlay debugging off */
2986 case ovly_auto: /* overlay debugging automatic */
2987 /* Unles there is a gdbarch_overlay_update function,
2988 there's really nothing useful to do here (can't really go auto). */
2989 gdbarch = osect->objfile->arch ();
2990 if (gdbarch_overlay_update_p (gdbarch))
2991 {
2992 if (overlay_cache_invalid)
2993 {
2994 overlay_invalidate_all ();
2995 overlay_cache_invalid = 0;
2996 }
2997 if (osect->ovly_mapped == -1)
2998 gdbarch_overlay_update (gdbarch, osect);
2999 }
3000 /* fall thru */
3001 case ovly_on: /* overlay debugging manual */
3002 return osect->ovly_mapped == 1;
3003 }
3004 }
3005
3006 /* Function: pc_in_unmapped_range
3007 If PC falls into the lma range of SECTION, return true, else false. */
3008
3009 CORE_ADDR
3010 pc_in_unmapped_range (CORE_ADDR pc, struct obj_section *section)
3011 {
3012 if (section_is_overlay (section))
3013 {
3014 asection *bfd_section = section->the_bfd_section;
3015
3016 /* We assume the LMA is relocated by the same offset as the VMA. */
3017 bfd_vma size = bfd_section_size (bfd_section);
3018 CORE_ADDR offset = obj_section_offset (section);
3019
3020 if (bfd_section_lma (bfd_section) + offset <= pc
3021 && pc < bfd_section_lma (bfd_section) + offset + size)
3022 return 1;
3023 }
3024
3025 return 0;
3026 }
3027
3028 /* Function: pc_in_mapped_range
3029 If PC falls into the vma range of SECTION, return true, else false. */
3030
3031 CORE_ADDR
3032 pc_in_mapped_range (CORE_ADDR pc, struct obj_section *section)
3033 {
3034 if (section_is_overlay (section))
3035 {
3036 if (obj_section_addr (section) <= pc
3037 && pc < obj_section_endaddr (section))
3038 return 1;
3039 }
3040
3041 return 0;
3042 }
3043
3044 /* Return true if the mapped ranges of sections A and B overlap, false
3045 otherwise. */
3046
3047 static int
3048 sections_overlap (struct obj_section *a, struct obj_section *b)
3049 {
3050 CORE_ADDR a_start = obj_section_addr (a);
3051 CORE_ADDR a_end = obj_section_endaddr (a);
3052 CORE_ADDR b_start = obj_section_addr (b);
3053 CORE_ADDR b_end = obj_section_endaddr (b);
3054
3055 return (a_start < b_end && b_start < a_end);
3056 }
3057
3058 /* Function: overlay_unmapped_address (PC, SECTION)
3059 Returns the address corresponding to PC in the unmapped (load) range.
3060 May be the same as PC. */
3061
3062 CORE_ADDR
3063 overlay_unmapped_address (CORE_ADDR pc, struct obj_section *section)
3064 {
3065 if (section_is_overlay (section) && pc_in_mapped_range (pc, section))
3066 {
3067 asection *bfd_section = section->the_bfd_section;
3068
3069 return (pc + bfd_section_lma (bfd_section)
3070 - bfd_section_vma (bfd_section));
3071 }
3072
3073 return pc;
3074 }
3075
3076 /* Function: overlay_mapped_address (PC, SECTION)
3077 Returns the address corresponding to PC in the mapped (runtime) range.
3078 May be the same as PC. */
3079
3080 CORE_ADDR
3081 overlay_mapped_address (CORE_ADDR pc, struct obj_section *section)
3082 {
3083 if (section_is_overlay (section) && pc_in_unmapped_range (pc, section))
3084 {
3085 asection *bfd_section = section->the_bfd_section;
3086
3087 return (pc + bfd_section_vma (bfd_section)
3088 - bfd_section_lma (bfd_section));
3089 }
3090
3091 return pc;
3092 }
3093
3094 /* Function: symbol_overlayed_address
3095 Return one of two addresses (relative to the VMA or to the LMA),
3096 depending on whether the section is mapped or not. */
3097
3098 CORE_ADDR
3099 symbol_overlayed_address (CORE_ADDR address, struct obj_section *section)
3100 {
3101 if (overlay_debugging)
3102 {
3103 /* If the symbol has no section, just return its regular address. */
3104 if (section == 0)
3105 return address;
3106 /* If the symbol's section is not an overlay, just return its
3107 address. */
3108 if (!section_is_overlay (section))
3109 return address;
3110 /* If the symbol's section is mapped, just return its address. */
3111 if (section_is_mapped (section))
3112 return address;
3113 /*
3114 * HOWEVER: if the symbol is in an overlay section which is NOT mapped,
3115 * then return its LOADED address rather than its vma address!!
3116 */
3117 return overlay_unmapped_address (address, section);
3118 }
3119 return address;
3120 }
3121
3122 /* Function: find_pc_overlay (PC)
3123 Return the best-match overlay section for PC:
3124 If PC matches a mapped overlay section's VMA, return that section.
3125 Else if PC matches an unmapped section's VMA, return that section.
3126 Else if PC matches an unmapped section's LMA, return that section. */
3127
3128 struct obj_section *
3129 find_pc_overlay (CORE_ADDR pc)
3130 {
3131 struct obj_section *osect, *best_match = NULL;
3132
3133 if (overlay_debugging)
3134 {
3135 for (objfile *objfile : current_program_space->objfiles ())
3136 ALL_OBJFILE_OSECTIONS (objfile, osect)
3137 if (section_is_overlay (osect))
3138 {
3139 if (pc_in_mapped_range (pc, osect))
3140 {
3141 if (section_is_mapped (osect))
3142 return osect;
3143 else
3144 best_match = osect;
3145 }
3146 else if (pc_in_unmapped_range (pc, osect))
3147 best_match = osect;
3148 }
3149 }
3150 return best_match;
3151 }
3152
3153 /* Function: find_pc_mapped_section (PC)
3154 If PC falls into the VMA address range of an overlay section that is
3155 currently marked as MAPPED, return that section. Else return NULL. */
3156
3157 struct obj_section *
3158 find_pc_mapped_section (CORE_ADDR pc)
3159 {
3160 struct obj_section *osect;
3161
3162 if (overlay_debugging)
3163 {
3164 for (objfile *objfile : current_program_space->objfiles ())
3165 ALL_OBJFILE_OSECTIONS (objfile, osect)
3166 if (pc_in_mapped_range (pc, osect) && section_is_mapped (osect))
3167 return osect;
3168 }
3169
3170 return NULL;
3171 }
3172
3173 /* Function: list_overlays_command
3174 Print a list of mapped sections and their PC ranges. */
3175
3176 static void
3177 list_overlays_command (const char *args, int from_tty)
3178 {
3179 int nmapped = 0;
3180 struct obj_section *osect;
3181
3182 if (overlay_debugging)
3183 {
3184 for (objfile *objfile : current_program_space->objfiles ())
3185 ALL_OBJFILE_OSECTIONS (objfile, osect)
3186 if (section_is_mapped (osect))
3187 {
3188 struct gdbarch *gdbarch = objfile->arch ();
3189 const char *name;
3190 bfd_vma lma, vma;
3191 int size;
3192
3193 vma = bfd_section_vma (osect->the_bfd_section);
3194 lma = bfd_section_lma (osect->the_bfd_section);
3195 size = bfd_section_size (osect->the_bfd_section);
3196 name = bfd_section_name (osect->the_bfd_section);
3197
3198 printf_filtered ("Section %s, loaded at ", name);
3199 fputs_filtered (paddress (gdbarch, lma), gdb_stdout);
3200 puts_filtered (" - ");
3201 fputs_filtered (paddress (gdbarch, lma + size), gdb_stdout);
3202 printf_filtered (", mapped at ");
3203 fputs_filtered (paddress (gdbarch, vma), gdb_stdout);
3204 puts_filtered (" - ");
3205 fputs_filtered (paddress (gdbarch, vma + size), gdb_stdout);
3206 puts_filtered ("\n");
3207
3208 nmapped++;
3209 }
3210 }
3211 if (nmapped == 0)
3212 printf_filtered (_("No sections are mapped.\n"));
3213 }
3214
3215 /* Function: map_overlay_command
3216 Mark the named section as mapped (ie. residing at its VMA address). */
3217
3218 static void
3219 map_overlay_command (const char *args, int from_tty)
3220 {
3221 struct obj_section *sec, *sec2;
3222
3223 if (!overlay_debugging)
3224 error (_("Overlay debugging not enabled. Use "
3225 "either the 'overlay auto' or\n"
3226 "the 'overlay manual' command."));
3227
3228 if (args == 0 || *args == 0)
3229 error (_("Argument required: name of an overlay section"));
3230
3231 /* First, find a section matching the user supplied argument. */
3232 for (objfile *obj_file : current_program_space->objfiles ())
3233 ALL_OBJFILE_OSECTIONS (obj_file, sec)
3234 if (!strcmp (bfd_section_name (sec->the_bfd_section), args))
3235 {
3236 /* Now, check to see if the section is an overlay. */
3237 if (!section_is_overlay (sec))
3238 continue; /* not an overlay section */
3239
3240 /* Mark the overlay as "mapped". */
3241 sec->ovly_mapped = 1;
3242
3243 /* Next, make a pass and unmap any sections that are
3244 overlapped by this new section: */
3245 for (objfile *objfile2 : current_program_space->objfiles ())
3246 ALL_OBJFILE_OSECTIONS (objfile2, sec2)
3247 if (sec2->ovly_mapped && sec != sec2 && sections_overlap (sec,
3248 sec2))
3249 {
3250 if (info_verbose)
3251 printf_unfiltered (_("Note: section %s unmapped by overlap\n"),
3252 bfd_section_name (sec2->the_bfd_section));
3253 sec2->ovly_mapped = 0; /* sec2 overlaps sec: unmap sec2. */
3254 }
3255 return;
3256 }
3257 error (_("No overlay section called %s"), args);
3258 }
3259
3260 /* Function: unmap_overlay_command
3261 Mark the overlay section as unmapped
3262 (ie. resident in its LMA address range, rather than the VMA range). */
3263
3264 static void
3265 unmap_overlay_command (const char *args, int from_tty)
3266 {
3267 struct obj_section *sec = NULL;
3268
3269 if (!overlay_debugging)
3270 error (_("Overlay debugging not enabled. "
3271 "Use either the 'overlay auto' or\n"
3272 "the 'overlay manual' command."));
3273
3274 if (args == 0 || *args == 0)
3275 error (_("Argument required: name of an overlay section"));
3276
3277 /* First, find a section matching the user supplied argument. */
3278 for (objfile *objfile : current_program_space->objfiles ())
3279 ALL_OBJFILE_OSECTIONS (objfile, sec)
3280 if (!strcmp (bfd_section_name (sec->the_bfd_section), args))
3281 {
3282 if (!sec->ovly_mapped)
3283 error (_("Section %s is not mapped"), args);
3284 sec->ovly_mapped = 0;
3285 return;
3286 }
3287 error (_("No overlay section called %s"), args);
3288 }
3289
3290 /* Function: overlay_auto_command
3291 A utility command to turn on overlay debugging.
3292 Possibly this should be done via a set/show command. */
3293
3294 static void
3295 overlay_auto_command (const char *args, int from_tty)
3296 {
3297 overlay_debugging = ovly_auto;
3298 enable_overlay_breakpoints ();
3299 if (info_verbose)
3300 printf_unfiltered (_("Automatic overlay debugging enabled."));
3301 }
3302
3303 /* Function: overlay_manual_command
3304 A utility command to turn on overlay debugging.
3305 Possibly this should be done via a set/show command. */
3306
3307 static void
3308 overlay_manual_command (const char *args, int from_tty)
3309 {
3310 overlay_debugging = ovly_on;
3311 disable_overlay_breakpoints ();
3312 if (info_verbose)
3313 printf_unfiltered (_("Overlay debugging enabled."));
3314 }
3315
3316 /* Function: overlay_off_command
3317 A utility command to turn on overlay debugging.
3318 Possibly this should be done via a set/show command. */
3319
3320 static void
3321 overlay_off_command (const char *args, int from_tty)
3322 {
3323 overlay_debugging = ovly_off;
3324 disable_overlay_breakpoints ();
3325 if (info_verbose)
3326 printf_unfiltered (_("Overlay debugging disabled."));
3327 }
3328
3329 static void
3330 overlay_load_command (const char *args, int from_tty)
3331 {
3332 struct gdbarch *gdbarch = get_current_arch ();
3333
3334 if (gdbarch_overlay_update_p (gdbarch))
3335 gdbarch_overlay_update (gdbarch, NULL);
3336 else
3337 error (_("This target does not know how to read its overlay state."));
3338 }
3339
3340 /* Command list chain containing all defined "overlay" subcommands. */
3341 static struct cmd_list_element *overlaylist;
3342
3343 /* Target Overlays for the "Simplest" overlay manager:
3344
3345 This is GDB's default target overlay layer. It works with the
3346 minimal overlay manager supplied as an example by Cygnus. The
3347 entry point is via a function pointer "gdbarch_overlay_update",
3348 so targets that use a different runtime overlay manager can
3349 substitute their own overlay_update function and take over the
3350 function pointer.
3351
3352 The overlay_update function pokes around in the target's data structures
3353 to see what overlays are mapped, and updates GDB's overlay mapping with
3354 this information.
3355
3356 In this simple implementation, the target data structures are as follows:
3357 unsigned _novlys; /# number of overlay sections #/
3358 unsigned _ovly_table[_novlys][4] = {
3359 {VMA, OSIZE, LMA, MAPPED}, /# one entry per overlay section #/
3360 {..., ..., ..., ...},
3361 }
3362 unsigned _novly_regions; /# number of overlay regions #/
3363 unsigned _ovly_region_table[_novly_regions][3] = {
3364 {VMA, OSIZE, MAPPED_TO_LMA}, /# one entry per overlay region #/
3365 {..., ..., ...},
3366 }
3367 These functions will attempt to update GDB's mappedness state in the
3368 symbol section table, based on the target's mappedness state.
3369
3370 To do this, we keep a cached copy of the target's _ovly_table, and
3371 attempt to detect when the cached copy is invalidated. The main
3372 entry point is "simple_overlay_update(SECT), which looks up SECT in
3373 the cached table and re-reads only the entry for that section from
3374 the target (whenever possible). */
3375
3376 /* Cached, dynamically allocated copies of the target data structures: */
3377 static unsigned (*cache_ovly_table)[4] = 0;
3378 static unsigned cache_novlys = 0;
3379 static CORE_ADDR cache_ovly_table_base = 0;
3380 enum ovly_index
3381 {
3382 VMA, OSIZE, LMA, MAPPED
3383 };
3384
3385 /* Throw away the cached copy of _ovly_table. */
3386
3387 static void
3388 simple_free_overlay_table (void)
3389 {
3390 xfree (cache_ovly_table);
3391 cache_novlys = 0;
3392 cache_ovly_table = NULL;
3393 cache_ovly_table_base = 0;
3394 }
3395
3396 /* Read an array of ints of size SIZE from the target into a local buffer.
3397 Convert to host order. int LEN is number of ints. */
3398
3399 static void
3400 read_target_long_array (CORE_ADDR memaddr, unsigned int *myaddr,
3401 int len, int size, enum bfd_endian byte_order)
3402 {
3403 /* FIXME (alloca): Not safe if array is very large. */
3404 gdb_byte *buf = (gdb_byte *) alloca (len * size);
3405 int i;
3406
3407 read_memory (memaddr, buf, len * size);
3408 for (i = 0; i < len; i++)
3409 myaddr[i] = extract_unsigned_integer (size * i + buf, size, byte_order);
3410 }
3411
3412 /* Find and grab a copy of the target _ovly_table
3413 (and _novlys, which is needed for the table's size). */
3414
3415 static int
3416 simple_read_overlay_table (void)
3417 {
3418 struct bound_minimal_symbol novlys_msym;
3419 struct bound_minimal_symbol ovly_table_msym;
3420 struct gdbarch *gdbarch;
3421 int word_size;
3422 enum bfd_endian byte_order;
3423
3424 simple_free_overlay_table ();
3425 novlys_msym = lookup_minimal_symbol ("_novlys", NULL, NULL);
3426 if (! novlys_msym.minsym)
3427 {
3428 error (_("Error reading inferior's overlay table: "
3429 "couldn't find `_novlys' variable\n"
3430 "in inferior. Use `overlay manual' mode."));
3431 return 0;
3432 }
3433
3434 ovly_table_msym = lookup_bound_minimal_symbol ("_ovly_table");
3435 if (! ovly_table_msym.minsym)
3436 {
3437 error (_("Error reading inferior's overlay table: couldn't find "
3438 "`_ovly_table' array\n"
3439 "in inferior. Use `overlay manual' mode."));
3440 return 0;
3441 }
3442
3443 gdbarch = ovly_table_msym.objfile->arch ();
3444 word_size = gdbarch_long_bit (gdbarch) / TARGET_CHAR_BIT;
3445 byte_order = gdbarch_byte_order (gdbarch);
3446
3447 cache_novlys = read_memory_integer (BMSYMBOL_VALUE_ADDRESS (novlys_msym),
3448 4, byte_order);
3449 cache_ovly_table
3450 = (unsigned int (*)[4]) xmalloc (cache_novlys * sizeof (*cache_ovly_table));
3451 cache_ovly_table_base = BMSYMBOL_VALUE_ADDRESS (ovly_table_msym);
3452 read_target_long_array (cache_ovly_table_base,
3453 (unsigned int *) cache_ovly_table,
3454 cache_novlys * 4, word_size, byte_order);
3455
3456 return 1; /* SUCCESS */
3457 }
3458
3459 /* Function: simple_overlay_update_1
3460 A helper function for simple_overlay_update. Assuming a cached copy
3461 of _ovly_table exists, look through it to find an entry whose vma,
3462 lma and size match those of OSECT. Re-read the entry and make sure
3463 it still matches OSECT (else the table may no longer be valid).
3464 Set OSECT's mapped state to match the entry. Return: 1 for
3465 success, 0 for failure. */
3466
3467 static int
3468 simple_overlay_update_1 (struct obj_section *osect)
3469 {
3470 int i;
3471 asection *bsect = osect->the_bfd_section;
3472 struct gdbarch *gdbarch = osect->objfile->arch ();
3473 int word_size = gdbarch_long_bit (gdbarch) / TARGET_CHAR_BIT;
3474 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
3475
3476 for (i = 0; i < cache_novlys; i++)
3477 if (cache_ovly_table[i][VMA] == bfd_section_vma (bsect)
3478 && cache_ovly_table[i][LMA] == bfd_section_lma (bsect))
3479 {
3480 read_target_long_array (cache_ovly_table_base + i * word_size,
3481 (unsigned int *) cache_ovly_table[i],
3482 4, word_size, byte_order);
3483 if (cache_ovly_table[i][VMA] == bfd_section_vma (bsect)
3484 && cache_ovly_table[i][LMA] == bfd_section_lma (bsect))
3485 {
3486 osect->ovly_mapped = cache_ovly_table[i][MAPPED];
3487 return 1;
3488 }
3489 else /* Warning! Warning! Target's ovly table has changed! */
3490 return 0;
3491 }
3492 return 0;
3493 }
3494
3495 /* Function: simple_overlay_update
3496 If OSECT is NULL, then update all sections' mapped state
3497 (after re-reading the entire target _ovly_table).
3498 If OSECT is non-NULL, then try to find a matching entry in the
3499 cached ovly_table and update only OSECT's mapped state.
3500 If a cached entry can't be found or the cache isn't valid, then
3501 re-read the entire cache, and go ahead and update all sections. */
3502
3503 void
3504 simple_overlay_update (struct obj_section *osect)
3505 {
3506 /* Were we given an osect to look up? NULL means do all of them. */
3507 if (osect)
3508 /* Have we got a cached copy of the target's overlay table? */
3509 if (cache_ovly_table != NULL)
3510 {
3511 /* Does its cached location match what's currently in the
3512 symtab? */
3513 struct bound_minimal_symbol minsym
3514 = lookup_minimal_symbol ("_ovly_table", NULL, NULL);
3515
3516 if (minsym.minsym == NULL)
3517 error (_("Error reading inferior's overlay table: couldn't "
3518 "find `_ovly_table' array\n"
3519 "in inferior. Use `overlay manual' mode."));
3520
3521 if (cache_ovly_table_base == BMSYMBOL_VALUE_ADDRESS (minsym))
3522 /* Then go ahead and try to look up this single section in
3523 the cache. */
3524 if (simple_overlay_update_1 (osect))
3525 /* Found it! We're done. */
3526 return;
3527 }
3528
3529 /* Cached table no good: need to read the entire table anew.
3530 Or else we want all the sections, in which case it's actually
3531 more efficient to read the whole table in one block anyway. */
3532
3533 if (! simple_read_overlay_table ())
3534 return;
3535
3536 /* Now may as well update all sections, even if only one was requested. */
3537 for (objfile *objfile : current_program_space->objfiles ())
3538 ALL_OBJFILE_OSECTIONS (objfile, osect)
3539 if (section_is_overlay (osect))
3540 {
3541 int i;
3542 asection *bsect = osect->the_bfd_section;
3543
3544 for (i = 0; i < cache_novlys; i++)
3545 if (cache_ovly_table[i][VMA] == bfd_section_vma (bsect)
3546 && cache_ovly_table[i][LMA] == bfd_section_lma (bsect))
3547 { /* obj_section matches i'th entry in ovly_table. */
3548 osect->ovly_mapped = cache_ovly_table[i][MAPPED];
3549 break; /* finished with inner for loop: break out. */
3550 }
3551 }
3552 }
3553
3554 /* Default implementation for sym_relocate. */
3555
3556 bfd_byte *
3557 default_symfile_relocate (struct objfile *objfile, asection *sectp,
3558 bfd_byte *buf)
3559 {
3560 /* Use sectp->owner instead of objfile->obfd. sectp may point to a
3561 DWO file. */
3562 bfd *abfd = sectp->owner;
3563
3564 /* We're only interested in sections with relocation
3565 information. */
3566 if ((sectp->flags & SEC_RELOC) == 0)
3567 return NULL;
3568
3569 /* We will handle section offsets properly elsewhere, so relocate as if
3570 all sections begin at 0. */
3571 for (asection *sect : gdb_bfd_sections (abfd))
3572 {
3573 sect->output_section = sect;
3574 sect->output_offset = 0;
3575 }
3576
3577 return bfd_simple_get_relocated_section_contents (abfd, sectp, buf, NULL);
3578 }
3579
3580 /* Relocate the contents of a debug section SECTP in ABFD. The
3581 contents are stored in BUF if it is non-NULL, or returned in a
3582 malloc'd buffer otherwise.
3583
3584 For some platforms and debug info formats, shared libraries contain
3585 relocations against the debug sections (particularly for DWARF-2;
3586 one affected platform is PowerPC GNU/Linux, although it depends on
3587 the version of the linker in use). Also, ELF object files naturally
3588 have unresolved relocations for their debug sections. We need to apply
3589 the relocations in order to get the locations of symbols correct.
3590 Another example that may require relocation processing, is the
3591 DWARF-2 .eh_frame section in .o files, although it isn't strictly a
3592 debug section. */
3593
3594 bfd_byte *
3595 symfile_relocate_debug_section (struct objfile *objfile,
3596 asection *sectp, bfd_byte *buf)
3597 {
3598 gdb_assert (objfile->sf->sym_relocate);
3599
3600 return (*objfile->sf->sym_relocate) (objfile, sectp, buf);
3601 }
3602
3603 symfile_segment_data_up
3604 get_symfile_segment_data (bfd *abfd)
3605 {
3606 const struct sym_fns *sf = find_sym_fns (abfd);
3607
3608 if (sf == NULL)
3609 return NULL;
3610
3611 return sf->sym_segments (abfd);
3612 }
3613
3614 /* Given:
3615 - DATA, containing segment addresses from the object file ABFD, and
3616 the mapping from ABFD's sections onto the segments that own them,
3617 and
3618 - SEGMENT_BASES[0 .. NUM_SEGMENT_BASES - 1], holding the actual
3619 segment addresses reported by the target,
3620 store the appropriate offsets for each section in OFFSETS.
3621
3622 If there are fewer entries in SEGMENT_BASES than there are segments
3623 in DATA, then apply SEGMENT_BASES' last entry to all the segments.
3624
3625 If there are more entries, then ignore the extra. The target may
3626 not be able to distinguish between an empty data segment and a
3627 missing data segment; a missing text segment is less plausible. */
3628
3629 int
3630 symfile_map_offsets_to_segments (bfd *abfd,
3631 const struct symfile_segment_data *data,
3632 section_offsets &offsets,
3633 int num_segment_bases,
3634 const CORE_ADDR *segment_bases)
3635 {
3636 int i;
3637 asection *sect;
3638
3639 /* It doesn't make sense to call this function unless you have some
3640 segment base addresses. */
3641 gdb_assert (num_segment_bases > 0);
3642
3643 /* If we do not have segment mappings for the object file, we
3644 can not relocate it by segments. */
3645 gdb_assert (data != NULL);
3646 gdb_assert (data->segments.size () > 0);
3647
3648 for (i = 0, sect = abfd->sections; sect != NULL; i++, sect = sect->next)
3649 {
3650 int which = data->segment_info[i];
3651
3652 gdb_assert (0 <= which && which <= data->segments.size ());
3653
3654 /* Don't bother computing offsets for sections that aren't
3655 loaded as part of any segment. */
3656 if (! which)
3657 continue;
3658
3659 /* Use the last SEGMENT_BASES entry as the address of any extra
3660 segments mentioned in DATA->segment_info. */
3661 if (which > num_segment_bases)
3662 which = num_segment_bases;
3663
3664 offsets[i] = segment_bases[which - 1] - data->segments[which - 1].base;
3665 }
3666
3667 return 1;
3668 }
3669
3670 static void
3671 symfile_find_segment_sections (struct objfile *objfile)
3672 {
3673 bfd *abfd = objfile->obfd;
3674 int i;
3675 asection *sect;
3676
3677 symfile_segment_data_up data
3678 = get_symfile_segment_data (objfile->obfd);
3679 if (data == NULL)
3680 return;
3681
3682 if (data->segments.size () != 1 && data->segments.size () != 2)
3683 return;
3684
3685 for (i = 0, sect = abfd->sections; sect != NULL; i++, sect = sect->next)
3686 {
3687 int which = data->segment_info[i];
3688
3689 if (which == 1)
3690 {
3691 if (objfile->sect_index_text == -1)
3692 objfile->sect_index_text = sect->index;
3693
3694 if (objfile->sect_index_rodata == -1)
3695 objfile->sect_index_rodata = sect->index;
3696 }
3697 else if (which == 2)
3698 {
3699 if (objfile->sect_index_data == -1)
3700 objfile->sect_index_data = sect->index;
3701
3702 if (objfile->sect_index_bss == -1)
3703 objfile->sect_index_bss = sect->index;
3704 }
3705 }
3706 }
3707
3708 /* Listen for free_objfile events. */
3709
3710 static void
3711 symfile_free_objfile (struct objfile *objfile)
3712 {
3713 /* Remove the target sections owned by this objfile. */
3714 if (objfile != NULL)
3715 current_program_space->remove_target_sections ((void *) objfile);
3716 }
3717
3718 /* Wrapper around the quick_symbol_functions expand_symtabs_matching "method".
3719 Expand all symtabs that match the specified criteria.
3720 See quick_symbol_functions.expand_symtabs_matching for details. */
3721
3722 void
3723 expand_symtabs_matching
3724 (gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
3725 const lookup_name_info &lookup_name,
3726 gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
3727 gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
3728 enum search_domain kind)
3729 {
3730 for (objfile *objfile : current_program_space->objfiles ())
3731 objfile->expand_symtabs_matching (file_matcher,
3732 &lookup_name,
3733 symbol_matcher,
3734 expansion_notify, kind);
3735 }
3736
3737 /* Wrapper around the quick_symbol_functions map_symbol_filenames "method".
3738 Map function FUN over every file.
3739 See quick_symbol_functions.map_symbol_filenames for details. */
3740
3741 void
3742 map_symbol_filenames (symbol_filename_ftype *fun, void *data,
3743 int need_fullname)
3744 {
3745 for (objfile *objfile : current_program_space->objfiles ())
3746 objfile->map_symbol_filenames (fun, data, need_fullname);
3747 }
3748
3749 #if GDB_SELF_TEST
3750
3751 namespace selftests {
3752 namespace filename_language {
3753
3754 static void test_filename_language ()
3755 {
3756 /* This test messes up the filename_language_table global. */
3757 scoped_restore restore_flt = make_scoped_restore (&filename_language_table);
3758
3759 /* Test deducing an unknown extension. */
3760 language lang = deduce_language_from_filename ("myfile.blah");
3761 SELF_CHECK (lang == language_unknown);
3762
3763 /* Test deducing a known extension. */
3764 lang = deduce_language_from_filename ("myfile.c");
3765 SELF_CHECK (lang == language_c);
3766
3767 /* Test adding a new extension using the internal API. */
3768 add_filename_language (".blah", language_pascal);
3769 lang = deduce_language_from_filename ("myfile.blah");
3770 SELF_CHECK (lang == language_pascal);
3771 }
3772
3773 static void
3774 test_set_ext_lang_command ()
3775 {
3776 /* This test messes up the filename_language_table global. */
3777 scoped_restore restore_flt = make_scoped_restore (&filename_language_table);
3778
3779 /* Confirm that the .hello extension is not known. */
3780 language lang = deduce_language_from_filename ("cake.hello");
3781 SELF_CHECK (lang == language_unknown);
3782
3783 /* Test adding a new extension using the CLI command. */
3784 auto args_holder = make_unique_xstrdup (".hello rust");
3785 ext_args = args_holder.get ();
3786 set_ext_lang_command (NULL, 1, NULL);
3787
3788 lang = deduce_language_from_filename ("cake.hello");
3789 SELF_CHECK (lang == language_rust);
3790
3791 /* Test overriding an existing extension using the CLI command. */
3792 int size_before = filename_language_table.size ();
3793 args_holder.reset (xstrdup (".hello pascal"));
3794 ext_args = args_holder.get ();
3795 set_ext_lang_command (NULL, 1, NULL);
3796 int size_after = filename_language_table.size ();
3797
3798 lang = deduce_language_from_filename ("cake.hello");
3799 SELF_CHECK (lang == language_pascal);
3800 SELF_CHECK (size_before == size_after);
3801 }
3802
3803 } /* namespace filename_language */
3804 } /* namespace selftests */
3805
3806 #endif /* GDB_SELF_TEST */
3807
3808 void _initialize_symfile ();
3809 void
3810 _initialize_symfile ()
3811 {
3812 struct cmd_list_element *c;
3813
3814 gdb::observers::free_objfile.attach (symfile_free_objfile);
3815
3816 #define READNOW_READNEVER_HELP \
3817 "The '-readnow' option will cause GDB to read the entire symbol file\n\
3818 immediately. This makes the command slower, but may make future operations\n\
3819 faster.\n\
3820 The '-readnever' option will prevent GDB from reading the symbol file's\n\
3821 symbolic debug information."
3822
3823 c = add_cmd ("symbol-file", class_files, symbol_file_command, _("\
3824 Load symbol table from executable file FILE.\n\
3825 Usage: symbol-file [-readnow | -readnever] [-o OFF] FILE\n\
3826 OFF is an optional offset which is added to each section address.\n\
3827 The `file' command can also load symbol tables, as well as setting the file\n\
3828 to execute.\n" READNOW_READNEVER_HELP), &cmdlist);
3829 set_cmd_completer (c, filename_completer);
3830
3831 c = add_cmd ("add-symbol-file", class_files, add_symbol_file_command, _("\
3832 Load symbols from FILE, assuming FILE has been dynamically loaded.\n\
3833 Usage: add-symbol-file FILE [-readnow | -readnever] [-o OFF] [ADDR] \
3834 [-s SECT-NAME SECT-ADDR]...\n\
3835 ADDR is the starting address of the file's text.\n\
3836 Each '-s' argument provides a section name and address, and\n\
3837 should be specified if the data and bss segments are not contiguous\n\
3838 with the text. SECT-NAME is a section name to be loaded at SECT-ADDR.\n\
3839 OFF is an optional offset which is added to the default load addresses\n\
3840 of all sections for which no other address was specified.\n"
3841 READNOW_READNEVER_HELP),
3842 &cmdlist);
3843 set_cmd_completer (c, filename_completer);
3844
3845 c = add_cmd ("remove-symbol-file", class_files,
3846 remove_symbol_file_command, _("\
3847 Remove a symbol file added via the add-symbol-file command.\n\
3848 Usage: remove-symbol-file FILENAME\n\
3849 remove-symbol-file -a ADDRESS\n\
3850 The file to remove can be identified by its filename or by an address\n\
3851 that lies within the boundaries of this symbol file in memory."),
3852 &cmdlist);
3853
3854 c = add_cmd ("load", class_files, load_command, _("\
3855 Dynamically load FILE into the running program.\n\
3856 FILE symbols are recorded for access from GDB.\n\
3857 Usage: load [FILE] [OFFSET]\n\
3858 An optional load OFFSET may also be given as a literal address.\n\
3859 When OFFSET is provided, FILE must also be provided. FILE can be provided\n\
3860 on its own."), &cmdlist);
3861 set_cmd_completer (c, filename_completer);
3862
3863 add_basic_prefix_cmd ("overlay", class_support,
3864 _("Commands for debugging overlays."), &overlaylist,
3865 "overlay ", 0, &cmdlist);
3866
3867 add_com_alias ("ovly", "overlay", class_support, 1);
3868 add_com_alias ("ov", "overlay", class_support, 1);
3869
3870 add_cmd ("map-overlay", class_support, map_overlay_command,
3871 _("Assert that an overlay section is mapped."), &overlaylist);
3872
3873 add_cmd ("unmap-overlay", class_support, unmap_overlay_command,
3874 _("Assert that an overlay section is unmapped."), &overlaylist);
3875
3876 add_cmd ("list-overlays", class_support, list_overlays_command,
3877 _("List mappings of overlay sections."), &overlaylist);
3878
3879 add_cmd ("manual", class_support, overlay_manual_command,
3880 _("Enable overlay debugging."), &overlaylist);
3881 add_cmd ("off", class_support, overlay_off_command,
3882 _("Disable overlay debugging."), &overlaylist);
3883 add_cmd ("auto", class_support, overlay_auto_command,
3884 _("Enable automatic overlay debugging."), &overlaylist);
3885 add_cmd ("load-target", class_support, overlay_load_command,
3886 _("Read the overlay mapping state from the target."), &overlaylist);
3887
3888 /* Filename extension to source language lookup table: */
3889 add_setshow_string_noescape_cmd ("extension-language", class_files,
3890 &ext_args, _("\
3891 Set mapping between filename extension and source language."), _("\
3892 Show mapping between filename extension and source language."), _("\
3893 Usage: set extension-language .foo bar"),
3894 set_ext_lang_command,
3895 show_ext_args,
3896 &setlist, &showlist);
3897
3898 add_info ("extensions", info_ext_lang_command,
3899 _("All filename extensions associated with a source language."));
3900
3901 add_setshow_optional_filename_cmd ("debug-file-directory", class_support,
3902 &debug_file_directory, _("\
3903 Set the directories where separate debug symbols are searched for."), _("\
3904 Show the directories where separate debug symbols are searched for."), _("\
3905 Separate debug symbols are first searched for in the same\n\
3906 directory as the binary, then in the `" DEBUG_SUBDIRECTORY "' subdirectory,\n\
3907 and lastly at the path of the directory of the binary with\n\
3908 each global debug-file-directory component prepended."),
3909 NULL,
3910 show_debug_file_directory,
3911 &setlist, &showlist);
3912
3913 add_setshow_enum_cmd ("symbol-loading", no_class,
3914 print_symbol_loading_enums, &print_symbol_loading,
3915 _("\
3916 Set printing of symbol loading messages."), _("\
3917 Show printing of symbol loading messages."), _("\
3918 off == turn all messages off\n\
3919 brief == print messages for the executable,\n\
3920 and brief messages for shared libraries\n\
3921 full == print messages for the executable,\n\
3922 and messages for each shared library."),
3923 NULL,
3924 NULL,
3925 &setprintlist, &showprintlist);
3926
3927 add_setshow_boolean_cmd ("separate-debug-file", no_class,
3928 &separate_debug_file_debug, _("\
3929 Set printing of separate debug info file search debug."), _("\
3930 Show printing of separate debug info file search debug."), _("\
3931 When on, GDB prints the searched locations while looking for separate debug \
3932 info files."), NULL, NULL, &setdebuglist, &showdebuglist);
3933
3934 #if GDB_SELF_TEST
3935 selftests::register_test
3936 ("filename_language", selftests::filename_language::test_filename_language);
3937 selftests::register_test
3938 ("set_ext_lang_command",
3939 selftests::filename_language::test_set_ext_lang_command);
3940 #endif
3941 }