1 /* Read ELF (Executable and Linking Format) object files for GDB.
2 Copyright 1991, 92, 93, 94, 95, 96, 1998 Free Software Foundation, Inc.
3 Written by Fred Fish at Cygnus Support.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
24 #include "gdb_string.h"
31 #include "stabsread.h"
32 #include "gdb-stabs.h"
33 #include "complaints.h"
36 extern void _initialize_elfread (void);
38 /* The struct elfinfo is available only during ELF symbol table and
39 psymtab reading. It is destroyed at the completion of psymtab-reading.
40 It's local to elf_symfile_read. */
44 file_ptr dboffset; /* Offset to dwarf debug section */
45 unsigned int dbsize; /* Size of dwarf debug section */
46 file_ptr lnoffset; /* Offset to dwarf line number section */
47 unsigned int lnsize; /* Size of dwarf line number section */
48 asection *stabsect; /* Section pointer for .stab section */
49 asection *stabindexsect; /* Section pointer for .stab.index section */
50 asection *mdebugsect; /* Section pointer for .mdebug section */
53 /* Various things we might complain about... */
55 struct complaint section_info_complaint =
56 {"elf/stab section information %s without a preceding file symbol", 0, 0};
58 struct complaint section_info_dup_complaint =
59 {"duplicated elf/stab section information for %s", 0, 0};
61 struct complaint stab_info_mismatch_complaint =
62 {"elf/stab section information missing for %s", 0, 0};
64 struct complaint stab_info_questionable_complaint =
65 {"elf/stab section information questionable for %s", 0, 0};
67 static void elf_symfile_init (struct objfile *);
69 static void elf_new_init (struct objfile *);
71 static void elf_symfile_read (struct objfile *, int);
73 static void elf_symfile_finish (struct objfile *);
75 static void elf_symtab_read (struct objfile *, int);
77 static void free_elfinfo (void *);
79 static struct minimal_symbol *record_minimal_symbol_and_info (char *,
89 static void elf_locate_sections (bfd *, asection *, void *);
91 /* We are called once per section from elf_symfile_read. We
92 need to examine each section we are passed, check to see
93 if it is something we are interested in processing, and
94 if so, stash away some access information for the section.
96 For now we recognize the dwarf debug information sections and
97 line number sections from matching their section names. The
98 ELF definition is no real help here since it has no direct
99 knowledge of DWARF (by design, so any debugging format can be
102 We also recognize the ".stab" sections used by the Sun compilers
103 released with Solaris 2.
105 FIXME: The section names should not be hardwired strings (what
106 should they be? I don't think most object file formats have enough
107 section flags to specify what kind of debug section it is
111 elf_locate_sections (ignore_abfd, sectp, eip)
116 register struct elfinfo *ei;
118 ei = (struct elfinfo *) eip;
119 if (STREQ (sectp->name, ".debug"))
121 ei->dboffset = sectp->filepos;
122 ei->dbsize = bfd_get_section_size_before_reloc (sectp);
124 else if (STREQ (sectp->name, ".line"))
126 ei->lnoffset = sectp->filepos;
127 ei->lnsize = bfd_get_section_size_before_reloc (sectp);
129 else if (STREQ (sectp->name, ".stab"))
131 ei->stabsect = sectp;
133 else if (STREQ (sectp->name, ".stab.index"))
135 ei->stabindexsect = sectp;
137 else if (STREQ (sectp->name, ".mdebug"))
139 ei->mdebugsect = sectp;
143 #if 0 /* Currently unused */
146 elf_interpreter (abfd)
153 interp_sec = bfd_get_section_by_name (abfd, ".interp");
156 size = bfd_section_size (abfd, interp_sec);
157 interp = alloca (size);
158 if (bfd_get_section_contents (abfd, interp_sec, interp, (file_ptr) 0,
161 interp = savestring (interp, size - 1);
173 static struct minimal_symbol *
174 record_minimal_symbol_and_info (name, address, ms_type, info, bfd_section,
178 enum minimal_symbol_type ms_type;
179 char *info; /* FIXME, is this really char *? */
180 asection *bfd_section;
181 struct objfile *objfile;
185 /* Guess the section from the type. This is likely to be wrong in
191 section = bfd_section->index;
192 #ifdef SMASH_TEXT_ADDRESS
193 SMASH_TEXT_ADDRESS (address);
200 section = bfd_section->index;
207 return prim_record_minimal_symbol_and_info
208 (name, address, ms_type, info, section, bfd_section, objfile);
215 elf_symtab_read -- read the symbol table of an ELF file
219 void elf_symtab_read (struct objfile *objfile, int dynamic)
223 Given an objfile and a flag that specifies whether or not the objfile
224 is for an executable or not (may be shared library for example), add
225 all the global function and data symbols to the minimal symbol table.
227 In stabs-in-ELF, as implemented by Sun, there are some local symbols
228 defined in the ELF symbol table, which can be used to locate
229 the beginnings of sections from each ".o" file that was linked to
230 form the executable objfile. We gather any such info and record it
231 in data structures hung off the objfile's private data.
236 elf_symtab_read (objfile, dynamic)
237 struct objfile *objfile;
242 asymbol **symbol_table;
243 long number_of_symbols;
246 struct cleanup *back_to;
249 enum minimal_symbol_type ms_type;
250 /* If sectinfo is nonNULL, it contains section info that should end up
251 filed in the objfile. */
252 struct stab_section_info *sectinfo = NULL;
253 /* If filesym is nonzero, it points to a file symbol, but we haven't
254 seen any section info for it yet. */
255 asymbol *filesym = 0;
256 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
257 /* Name of filesym, as saved on the symbol_obstack. */
258 char *filesymname = obsavestring ("", 0, &objfile->symbol_obstack);
260 struct dbx_symfile_info *dbx = objfile->sym_stab_info;
262 int stripped = (bfd_get_symcount (objfile->obfd) == 0);
266 storage_needed = bfd_get_dynamic_symtab_upper_bound (objfile->obfd);
268 /* Nothing to be done if there is no dynamic symtab. */
269 if (storage_needed < 0)
274 storage_needed = bfd_get_symtab_upper_bound (objfile->obfd);
275 if (storage_needed < 0)
276 error ("Can't read symbols from %s: %s", bfd_get_filename (objfile->obfd),
277 bfd_errmsg (bfd_get_error ()));
279 if (storage_needed > 0)
281 symbol_table = (asymbol **) xmalloc (storage_needed);
282 back_to = make_cleanup (free, symbol_table);
284 number_of_symbols = bfd_canonicalize_dynamic_symtab (objfile->obfd,
287 number_of_symbols = bfd_canonicalize_symtab (objfile->obfd, symbol_table);
288 if (number_of_symbols < 0)
289 error ("Can't read symbols from %s: %s", bfd_get_filename (objfile->obfd),
290 bfd_errmsg (bfd_get_error ()));
292 for (i = 0; i < number_of_symbols; i++)
294 sym = symbol_table[i];
295 if (sym->name == NULL || *sym->name == '\0')
297 /* Skip names that don't exist (shouldn't happen), or names
298 that are null strings (may happen). */
302 offset = ANOFFSET (objfile->section_offsets, sym->section->index);
304 && sym->section == &bfd_und_section
305 && (sym->flags & BSF_FUNCTION))
307 struct minimal_symbol *msym;
309 /* Symbol is a reference to a function defined in
311 If its value is non zero then it is usually the address
312 of the corresponding entry in the procedure linkage table,
313 plus the desired section offset.
314 If its value is zero then the dynamic linker has to resolve
315 the symbol. We are unable to find any meaningful address
316 for this symbol in the executable file, so we skip it. */
317 symaddr = sym->value;
321 msym = record_minimal_symbol_and_info
322 ((char *) sym->name, symaddr,
323 mst_solib_trampoline, NULL, sym->section, objfile);
324 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
326 msym->filename = filesymname;
331 /* If it is a nonstripped executable, do not enter dynamic
332 symbols, as the dynamic symbol table is usually a subset
333 of the main symbol table. */
334 if (dynamic && !stripped)
336 if (sym->flags & BSF_FILE)
338 /* STT_FILE debugging symbol that helps stabs-in-elf debugging.
339 Chain any old one onto the objfile; remember new sym. */
340 if (sectinfo != NULL)
342 sectinfo->next = dbx->stab_section_info;
343 dbx->stab_section_info = sectinfo;
347 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
349 obsavestring ((char *) filesym->name, strlen (filesym->name),
350 &objfile->symbol_obstack);
353 else if (sym->flags & (BSF_GLOBAL | BSF_LOCAL | BSF_WEAK))
355 struct minimal_symbol *msym;
357 /* Select global/local/weak symbols. Note that bfd puts abs
358 symbols in their own section, so all symbols we are
359 interested in will have a section. */
360 /* Bfd symbols are section relative. */
361 symaddr = sym->value + sym->section->vma;
362 /* Relocate all non-absolute symbols by the section offset. */
363 if (sym->section != &bfd_abs_section)
367 /* For non-absolute symbols, use the type of the section
368 they are relative to, to intuit text/data. Bfd provides
369 no way of figuring this out for absolute symbols. */
370 if (sym->section == &bfd_abs_section)
372 /* This is a hack to get the minimal symbol type
373 right for Irix 5, which has absolute addresses
374 with special section indices for dynamic symbols. */
375 unsigned short shndx =
376 ((elf_symbol_type *) sym)->internal_elf_sym.st_shndx;
386 case SHN_MIPS_ACOMMON:
393 /* If it is an Irix dynamic symbol, skip section name
394 symbols, relocate all others by section offset. */
395 if (ms_type != mst_abs)
397 if (sym->name[0] == '.')
402 else if (sym->section->flags & SEC_CODE)
404 if (sym->flags & BSF_GLOBAL)
408 else if ((sym->name[0] == '.' && sym->name[1] == 'L')
409 || ((sym->flags & BSF_LOCAL)
410 && sym->name[0] == '$'
411 && sym->name[1] == 'L'))
412 /* Looks like a compiler-generated label. Skip it.
413 The assembler should be skipping these (to keep
414 executables small), but apparently with gcc on the
415 delta m88k SVR4, it loses. So to have us check too
416 should be harmless (but I encourage people to fix this
417 in the assembler instead of adding checks here). */
420 else if (sym->name[0] == '.' && sym->name[1] == '.')
422 /* Looks like a Harris compiler generated label for the
423 purpose of marking instructions that are relevant to
424 DWARF dies. The assembler can't get rid of these
425 because they are relocatable addresses that the
426 linker needs to resolve. */
432 ms_type = mst_file_text;
435 else if (sym->section->flags & SEC_ALLOC)
437 if (sym->flags & BSF_GLOBAL)
439 if (sym->section->flags & SEC_LOAD)
448 else if (sym->flags & BSF_LOCAL)
450 /* Named Local variable in a Data section. Check its
451 name for stabs-in-elf. The STREQ macro checks the
452 first character inline, so we only actually do a
453 strcmp function call on names that start with 'B'
455 index = SECT_OFF_MAX;
456 if (STREQ ("Bbss.bss", sym->name))
458 index = SECT_OFF_BSS (objfile);
460 else if (STREQ ("Ddata.data", sym->name))
462 index = SECT_OFF_DATA (objfile);
464 else if (STREQ ("Drodata.rodata", sym->name))
466 index = SECT_OFF_RODATA (objfile);
468 if (index != SECT_OFF_MAX)
470 /* Found a special local symbol. Allocate a
471 sectinfo, if needed, and fill it in. */
472 if (sectinfo == NULL)
474 sectinfo = (struct stab_section_info *)
475 xmmalloc (objfile->md, sizeof (*sectinfo));
476 memset ((PTR) sectinfo, 0, sizeof (*sectinfo));
479 complain (§ion_info_complaint,
485 (char *) filesym->name;
488 if (sectinfo->sections[index] != 0)
490 complain (§ion_info_dup_complaint,
493 /* Bfd symbols are section relative. */
494 symaddr = sym->value + sym->section->vma;
495 /* Relocate non-absolute symbols by the section offset. */
496 if (sym->section != &bfd_abs_section)
500 sectinfo->sections[index] = symaddr;
501 /* The special local symbols don't go in the
502 minimal symbol table, so ignore this one. */
505 /* Not a special stabs-in-elf symbol, do regular
506 symbol processing. */
507 if (sym->section->flags & SEC_LOAD)
509 ms_type = mst_file_data;
513 ms_type = mst_file_bss;
518 ms_type = mst_unknown;
523 /* FIXME: Solaris2 shared libraries include lots of
524 odd "absolute" and "undefined" symbols, that play
525 hob with actions like finding what function the PC
526 is in. Ignore them if they aren't text, data, or bss. */
527 /* ms_type = mst_unknown; */
528 continue; /* Skip this symbol. */
530 /* Pass symbol size field in via BFD. FIXME!!! */
531 size = ((elf_symbol_type *) sym)->internal_elf_sym.st_size;
532 msym = record_minimal_symbol_and_info
533 ((char *) sym->name, symaddr,
534 ms_type, (PTR) size, sym->section, objfile);
535 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
537 msym->filename = filesymname;
539 #ifdef ELF_MAKE_MSYMBOL_SPECIAL
540 ELF_MAKE_MSYMBOL_SPECIAL (sym, msym);
544 do_cleanups (back_to);
548 /* Scan and build partial symbols for a symbol file.
549 We have been initialized by a call to elf_symfile_init, which
550 currently does nothing.
552 SECTION_OFFSETS is a set of offsets to apply to relocate the symbols
553 in each section. We simplify it down to a single offset for all
556 MAINLINE is true if we are reading the main symbol
557 table (as opposed to a shared lib or dynamically loaded file).
559 This function only does the minimum work necessary for letting the
560 user "name" things symbolically; it does not read the entire symtab.
561 Instead, it reads the external and static symbols and puts them in partial
562 symbol tables. When more extensive information is requested of a
563 file, the corresponding partial symbol table is mutated into a full
564 fledged symbol table by going back and reading the symbols
567 We look for sections with specific names, to tell us what debug
568 format to look for: FIXME!!!
570 dwarf_build_psymtabs() builds psymtabs for DWARF symbols;
571 elfstab_build_psymtabs() handles STABS symbols;
572 mdebug_build_psymtabs() handles ECOFF debugging information.
574 Note that ELF files have a "minimal" symbol table, which looks a lot
575 like a COFF symbol table, but has only the minimal information necessary
576 for linking. We process this also, and use the information to
577 build gdb's minimal symbol table. This gives us some minimal debugging
578 capability even for files compiled without -g. */
581 elf_symfile_read (objfile, mainline)
582 struct objfile *objfile;
585 bfd *abfd = objfile->obfd;
587 struct cleanup *back_to;
590 init_minimal_symbol_collection ();
591 back_to = make_cleanup_discard_minimal_symbols ();
593 memset ((char *) &ei, 0, sizeof (ei));
595 /* Allocate struct to keep track of the symfile */
596 objfile->sym_stab_info = (struct dbx_symfile_info *)
597 xmmalloc (objfile->md, sizeof (struct dbx_symfile_info));
598 memset ((char *) objfile->sym_stab_info, 0, sizeof (struct dbx_symfile_info));
599 make_cleanup (free_elfinfo, (PTR) objfile);
601 /* Process the normal ELF symbol table first. This may write some
602 chain of info into the dbx_symfile_info in objfile->sym_stab_info,
603 which can later be used by elfstab_offset_sections. */
605 elf_symtab_read (objfile, 0);
607 /* Add the dynamic symbols. */
609 elf_symtab_read (objfile, 1);
611 /* Now process debugging information, which is contained in
612 special ELF sections. */
614 /* If we are reinitializing, or if we have never loaded syms yet,
615 set table to empty. MAINLINE is cleared so that *_read_psymtab
616 functions do not all also re-initialize the psymbol table. */
619 init_psymbol_list (objfile, 0);
623 /* We first have to find them... */
624 bfd_map_over_sections (abfd, elf_locate_sections, (PTR) & ei);
626 /* ELF debugging information is inserted into the psymtab in the
627 order of least informative first - most informative last. Since
628 the psymtab table is searched `most recent insertion first' this
629 increases the probability that more detailed debug information
630 for a section is found.
632 For instance, an object file might contain both .mdebug (XCOFF)
633 and .debug_info (DWARF2) sections then .mdebug is inserted first
634 (searched last) and DWARF2 is inserted last (searched first). If
635 we don't do this then the XCOFF info is found first - for code in
636 an included file XCOFF info is useless. */
640 const struct ecoff_debug_swap *swap;
642 /* .mdebug section, presumably holding ECOFF debugging
644 swap = get_elf_backend_data (abfd)->elf_backend_ecoff_debug_swap;
646 elfmdebug_build_psymtabs (objfile, swap, ei.mdebugsect);
652 /* Stab sections have an associated string table that looks like
653 a separate section. */
654 str_sect = bfd_get_section_by_name (abfd, ".stabstr");
656 /* FIXME should probably warn about a stab section without a stabstr. */
658 elfstab_build_psymtabs (objfile,
660 ei.stabsect->filepos,
661 bfd_section_size (abfd, ei.stabsect),
663 bfd_section_size (abfd, str_sect));
665 if (dwarf2_has_info (abfd))
667 /* DWARF 2 sections */
668 dwarf2_build_psymtabs (objfile, mainline);
670 else if (ei.dboffset && ei.lnoffset)
673 dwarf_build_psymtabs (objfile,
675 ei.dboffset, ei.dbsize,
676 ei.lnoffset, ei.lnsize);
679 /* Install any minimal symbols that have been collected as the current
680 minimal symbols for this objfile. */
682 install_minimal_symbols (objfile);
684 do_cleanups (back_to);
687 /* This cleans up the objfile's sym_stab_info pointer, and the chain of
688 stab_section_info's, that might be dangling from it. */
694 struct objfile *objfile = (struct objfile *) objp;
695 struct dbx_symfile_info *dbxinfo = objfile->sym_stab_info;
696 struct stab_section_info *ssi, *nssi;
698 ssi = dbxinfo->stab_section_info;
702 mfree (objfile->md, ssi);
706 dbxinfo->stab_section_info = 0; /* Just say No mo info about this. */
710 /* Initialize anything that needs initializing when a completely new symbol
711 file is specified (not just adding some symbols from another file, e.g. a
714 We reinitialize buildsym, since we may be reading stabs from an ELF file. */
717 elf_new_init (ignore)
718 struct objfile *ignore;
720 stabsread_new_init ();
721 buildsym_new_init ();
724 /* Perform any local cleanups required when we are done with a particular
725 objfile. I.E, we are in the process of discarding all symbol information
726 for an objfile, freeing up all memory held for it, and unlinking the
727 objfile struct from the global list of known objfiles. */
730 elf_symfile_finish (objfile)
731 struct objfile *objfile;
733 if (objfile->sym_stab_info != NULL)
735 mfree (objfile->md, objfile->sym_stab_info);
739 /* ELF specific initialization routine for reading symbols.
741 It is passed a pointer to a struct sym_fns which contains, among other
742 things, the BFD for the file whose symbols are being read, and a slot for
743 a pointer to "private data" which we can fill with goodies.
745 For now at least, we have nothing in particular to do, so this function is
749 elf_symfile_init (objfile)
750 struct objfile *objfile;
752 /* ELF objects may be reordered, so set OBJF_REORDERED. If we
753 find this causes a significant slowdown in gdb then we could
754 set it in the debug symbol readers only when necessary. */
755 objfile->flags |= OBJF_REORDERED;
758 /* When handling an ELF file that contains Sun STABS debug info,
759 some of the debug info is relative to the particular chunk of the
760 section that was generated in its individual .o file. E.g.
761 offsets to static variables are relative to the start of the data
762 segment *for that module before linking*. This information is
763 painfully squirreled away in the ELF symbol table as local symbols
764 with wierd names. Go get 'em when needed. */
767 elfstab_offset_sections (objfile, pst)
768 struct objfile *objfile;
769 struct partial_symtab *pst;
771 char *filename = pst->filename;
772 struct dbx_symfile_info *dbx = objfile->sym_stab_info;
773 struct stab_section_info *maybe = dbx->stab_section_info;
774 struct stab_section_info *questionable = 0;
778 /* The ELF symbol info doesn't include path names, so strip the path
779 (if any) from the psymtab filename. */
780 while (0 != (p = strchr (filename, '/')))
783 /* FIXME: This linear search could speed up significantly
784 if it was chained in the right order to match how we search it,
785 and if we unchained when we found a match. */
786 for (; maybe; maybe = maybe->next)
788 if (filename[0] == maybe->filename[0]
789 && STREQ (filename, maybe->filename))
791 /* We found a match. But there might be several source files
792 (from different directories) with the same name. */
793 if (0 == maybe->found)
795 questionable = maybe; /* Might use it later. */
799 if (maybe == 0 && questionable != 0)
801 complain (&stab_info_questionable_complaint, filename);
802 maybe = questionable;
807 /* Found it! Allocate a new psymtab struct, and fill it in. */
809 pst->section_offsets = (struct section_offsets *)
810 obstack_alloc (&objfile->psymbol_obstack, SIZEOF_SECTION_OFFSETS);
811 for (i = 0; i < SECT_OFF_MAX; i++)
812 ANOFFSET (pst->section_offsets, i) = maybe->sections[i];
816 /* We were unable to find any offsets for this file. Complain. */
817 if (dbx->stab_section_info) /* If there *is* any info, */
818 complain (&stab_info_mismatch_complaint, filename);
821 /* Register that we are able to handle ELF object file formats. */
823 static struct sym_fns elf_sym_fns =
825 bfd_target_elf_flavour,
826 elf_new_init, /* sym_new_init: init anything gbl to entire symtab */
827 elf_symfile_init, /* sym_init: read initial info, setup for sym_read() */
828 elf_symfile_read, /* sym_read: read a symbol file into symtab */
829 elf_symfile_finish, /* sym_finish: finished with file, cleanup */
830 default_symfile_offsets, /* sym_offsets: Translate ext. to int. relocation */
831 NULL /* next: pointer to next struct sym_fns */
835 _initialize_elfread ()
837 add_symtab_fns (&elf_sym_fns);