1 /* Read ELF (Executable and Linking Format) object files for GDB.
2 Copyright 1991, 1992, 1993, 1994, 1995, 1996 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, Boston, MA 02111-1307, USA. */
23 #include "gdb_string.h"
30 #include "stabsread.h"
31 #include "gdb-stabs.h"
32 #include "complaints.h"
35 /* The struct elfinfo is available only during ELF symbol table and
36 psymtab reading. It is destroyed at the complation of psymtab-reading.
37 It's local to elf_symfile_read. */
40 file_ptr dboffset; /* Offset to dwarf debug section */
41 unsigned int dbsize; /* Size of dwarf debug section */
42 file_ptr lnoffset; /* Offset to dwarf line number section */
43 unsigned int lnsize; /* Size of dwarf line number section */
44 asection *stabsect; /* Section pointer for .stab section */
45 asection *stabindexsect; /* Section pointer for .stab.index section */
46 asection *mdebugsect; /* Section pointer for .mdebug section */
49 /* Various things we might complain about... */
51 struct complaint section_info_complaint =
52 {"elf/stab section information %s without a preceding file symbol", 0, 0};
54 struct complaint section_info_dup_complaint =
55 {"duplicated elf/stab section information for %s", 0, 0};
57 struct complaint stab_info_mismatch_complaint =
58 {"elf/stab section information missing for %s", 0, 0};
60 struct complaint stab_info_questionable_complaint =
61 {"elf/stab section information questionable for %s", 0, 0};
64 elf_symfile_init PARAMS ((struct objfile *));
67 elf_new_init PARAMS ((struct objfile *));
70 elf_symfile_read PARAMS ((struct objfile *, struct section_offsets *, int));
73 elf_symfile_finish PARAMS ((struct objfile *));
76 elf_symtab_read PARAMS ((bfd *, CORE_ADDR, struct objfile *, int));
79 free_elfinfo PARAMS ((void *));
81 static struct minimal_symbol *
82 record_minimal_symbol_and_info PARAMS ((char *, CORE_ADDR,
83 enum minimal_symbol_type, char *,
87 elf_locate_sections PARAMS ((bfd *, asection *, void *));
89 /* We are called once per section from elf_symfile_read. We
90 need to examine each section we are passed, check to see
91 if it is something we are interested in processing, and
92 if so, stash away some access information for the section.
94 For now we recognize the dwarf debug information sections and
95 line number sections from matching their section names. The
96 ELF definition is no real help here since it has no direct
97 knowledge of DWARF (by design, so any debugging format can be
100 We also recognize the ".stab" sections used by the Sun compilers
101 released with Solaris 2.
103 FIXME: The section names should not be hardwired strings (what
104 should they be? I don't think most object file formats have enough
105 section flags to specify what kind of debug section it is
109 elf_locate_sections (ignore_abfd, sectp, eip)
114 register struct elfinfo *ei;
116 ei = (struct elfinfo *) eip;
117 if (STREQ (sectp -> name, ".debug"))
119 ei -> dboffset = sectp -> filepos;
120 ei -> dbsize = bfd_get_section_size_before_reloc (sectp);
122 else if (STREQ (sectp -> name, ".line"))
124 ei -> lnoffset = sectp -> filepos;
125 ei -> lnsize = bfd_get_section_size_before_reloc (sectp);
127 else if (STREQ (sectp -> name, ".stab"))
129 ei -> stabsect = sectp;
131 else if (STREQ (sectp -> name, ".stab.index"))
133 ei -> stabindexsect = sectp;
135 else if (STREQ (sectp -> name, ".mdebug"))
137 ei -> mdebugsect = sectp;
141 #if 0 /* Currently unused */
144 elf_interpreter (abfd)
151 interp_sec = bfd_get_section_by_name (abfd, ".interp");
154 size = bfd_section_size (abfd, interp_sec);
155 interp = alloca (size);
156 if (bfd_get_section_contents (abfd, interp_sec, interp, (file_ptr)0,
159 interp = savestring (interp, size - 1);
171 static struct minimal_symbol *
172 record_minimal_symbol_and_info (name, address, ms_type, info, objfile)
175 enum minimal_symbol_type ms_type;
176 char *info; /* FIXME, is this really char *? */
177 struct objfile *objfile;
181 /* Guess the section from the type. This is likely to be wrong in
187 section = SECT_OFF_TEXT;
188 #ifdef SMASH_TEXT_ADDRESS
189 SMASH_TEXT_ADDRESS (address);
194 section = SECT_OFF_DATA;
198 section = SECT_OFF_BSS;
205 return prim_record_minimal_symbol_and_info
206 (name, address, ms_type, info, section, objfile);
213 elf_symtab_read -- read the symbol table of an ELF file
217 void elf_symtab_read (bfd *abfd, CORE_ADDR addr,
218 struct objfile *objfile, int dynamic)
222 Given an open bfd, a base address to relocate symbols to, and a
223 flag that specifies whether or not this bfd is for an executable
224 or not (may be shared library for example), add all the global
225 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 (abfd, addr, objfile, dynamic)
239 struct objfile *objfile;
244 asymbol **symbol_table;
245 long number_of_symbols;
248 struct cleanup *back_to;
250 enum minimal_symbol_type ms_type;
251 /* If sectinfo is nonNULL, it contains section info that should end up
252 filed in the objfile. */
253 struct stab_section_info *sectinfo = NULL;
254 /* If filesym is nonzero, it points to a file symbol, but we haven't
255 seen any section info for it yet. */
256 asymbol *filesym = 0;
257 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
258 /* Name of filesym, as saved on the symbol_obstack. */
259 char *filesymname = obsavestring ("", 0, &objfile->symbol_obstack);
261 struct dbx_symfile_info *dbx = (struct dbx_symfile_info *)
262 objfile->sym_stab_info;
264 int stripped = (bfd_get_symcount (abfd) == 0);
268 storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
270 /* Nothing to be done if there is no dynamic symtab. */
271 if (storage_needed < 0)
276 storage_needed = bfd_get_symtab_upper_bound (abfd);
277 if (storage_needed < 0)
278 error ("Can't read symbols from %s: %s", bfd_get_filename (abfd),
279 bfd_errmsg (bfd_get_error ()));
281 if (storage_needed > 0)
283 symbol_table = (asymbol **) xmalloc (storage_needed);
284 back_to = make_cleanup (free, symbol_table);
286 number_of_symbols = bfd_canonicalize_dynamic_symtab (abfd,
289 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
290 if (number_of_symbols < 0)
291 error ("Can't read symbols from %s: %s", bfd_get_filename (abfd),
292 bfd_errmsg (bfd_get_error ()));
293 for (i = 0; i < number_of_symbols; i++)
295 sym = symbol_table[i];
296 if (sym -> name == NULL || *sym -> name == '\0')
298 /* Skip names that don't exist (shouldn't happen), or names
299 that are null strings (may happen). */
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 relative to the base address.
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, 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 base address. */
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 adresses
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 else if (sym -> section -> flags & SEC_CODE)
395 if (sym -> flags & BSF_GLOBAL)
399 else if ((sym->name[0] == '.' && sym->name[1] == 'L')
400 || ((sym -> flags & BSF_LOCAL)
401 && sym->name[0] == '$'
402 && sym->name[1] == 'L'))
403 /* Looks like a compiler-generated label. Skip it.
404 The assembler should be skipping these (to keep
405 executables small), but apparently with gcc on the
406 delta m88k SVR4, it loses. So to have us check too
407 should be harmless (but I encourage people to fix this
408 in the assembler instead of adding checks here). */
411 else if (sym->name[0] == '.' && sym->name[1] == '.')
413 /* Looks like a Harris compiler generated label for the
414 purpose of marking instructions that are relevant to
415 DWARF dies. The assembler can't get rid of these
416 because they are relocatable addresses that the
417 linker needs to resolve. */
423 ms_type = mst_file_text;
426 else if (sym -> section -> flags & SEC_ALLOC)
428 if (sym -> flags & BSF_GLOBAL)
430 if (sym -> section -> flags & SEC_LOAD)
439 else if (sym -> flags & BSF_LOCAL)
441 /* Named Local variable in a Data section. Check its
442 name for stabs-in-elf. The STREQ macro checks the
443 first character inline, so we only actually do a
444 strcmp function call on names that start with 'B'
446 index = SECT_OFF_MAX;
447 if (STREQ ("Bbss.bss", sym -> name))
449 index = SECT_OFF_BSS;
451 else if (STREQ ("Ddata.data", sym -> name))
453 index = SECT_OFF_DATA;
455 else if (STREQ ("Drodata.rodata", sym -> name))
457 index = SECT_OFF_RODATA;
459 if (index != SECT_OFF_MAX)
461 /* Found a special local symbol. Allocate a
462 sectinfo, if needed, and fill it in. */
463 if (sectinfo == NULL)
465 sectinfo = (struct stab_section_info *)
466 xmmalloc (objfile -> md, sizeof (*sectinfo));
467 memset ((PTR) sectinfo, 0, sizeof (*sectinfo));
470 complain (§ion_info_complaint,
475 sectinfo -> filename =
476 (char *) filesym -> name;
479 if (sectinfo -> sections[index] != 0)
481 complain (§ion_info_dup_complaint,
482 sectinfo -> filename);
484 /* Bfd symbols are section relative. */
485 symaddr = sym -> value + sym -> section -> vma;
486 /* Relocate non-absolute symbols by base address. */
487 if (sym -> section != &bfd_abs_section)
491 sectinfo -> sections[index] = symaddr;
492 /* The special local symbols don't go in the
493 minimal symbol table, so ignore this one. */
496 /* Not a special stabs-in-elf symbol, do regular
497 symbol processing. */
498 if (sym -> section -> flags & SEC_LOAD)
500 ms_type = mst_file_data;
504 ms_type = mst_file_bss;
509 ms_type = mst_unknown;
514 /* FIXME: Solaris2 shared libraries include lots of
515 odd "absolute" and "undefined" symbols, that play
516 hob with actions like finding what function the PC
517 is in. Ignore them if they aren't text, data, or bss. */
518 /* ms_type = mst_unknown; */
519 continue; /* Skip this symbol. */
521 /* Pass symbol size field in via BFD. FIXME!!! */
522 size = ((elf_symbol_type *) sym) -> internal_elf_sym.st_size;
523 msym = record_minimal_symbol_and_info
524 ((char *) sym -> name, symaddr,
525 ms_type, (PTR) size, objfile);
526 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
528 msym->filename = filesymname;
532 do_cleanups (back_to);
536 /* Scan and build partial symbols for a symbol file.
537 We have been initialized by a call to elf_symfile_init, which
538 currently does nothing.
540 SECTION_OFFSETS is a set of offsets to apply to relocate the symbols
541 in each section. We simplify it down to a single offset for all
544 MAINLINE is true if we are reading the main symbol
545 table (as opposed to a shared lib or dynamically loaded file).
547 This function only does the minimum work necessary for letting the
548 user "name" things symbolically; it does not read the entire symtab.
549 Instead, it reads the external and static symbols and puts them in partial
550 symbol tables. When more extensive information is requested of a
551 file, the corresponding partial symbol table is mutated into a full
552 fledged symbol table by going back and reading the symbols
555 We look for sections with specific names, to tell us what debug
556 format to look for: FIXME!!!
558 dwarf_build_psymtabs() builds psymtabs for DWARF symbols;
559 elfstab_build_psymtabs() handles STABS symbols;
560 mdebug_build_psymtabs() handles ECOFF debugging information.
562 Note that ELF files have a "minimal" symbol table, which looks a lot
563 like a COFF symbol table, but has only the minimal information necessary
564 for linking. We process this also, and use the information to
565 build gdb's minimal symbol table. This gives us some minimal debugging
566 capability even for files compiled without -g. */
569 elf_symfile_read (objfile, section_offsets, mainline)
570 struct objfile *objfile;
571 struct section_offsets *section_offsets;
574 bfd *abfd = objfile->obfd;
576 struct cleanup *back_to;
579 init_minimal_symbol_collection ();
580 back_to = make_cleanup (discard_minimal_symbols, 0);
582 memset ((char *) &ei, 0, sizeof (ei));
584 /* Allocate struct to keep track of the symfile */
585 objfile->sym_stab_info = (PTR)
586 xmmalloc (objfile -> md, sizeof (struct dbx_symfile_info));
587 memset ((char *) objfile->sym_stab_info, 0, sizeof (struct dbx_symfile_info));
588 make_cleanup (free_elfinfo, (PTR) objfile);
590 /* Process the normal ELF symbol table first. This may write some
591 chain of info into the dbx_symfile_info in objfile->sym_stab_info,
592 which can later be used by elfstab_offset_sections. */
594 /* FIXME, should take a section_offsets param, not just an offset. */
595 offset = ANOFFSET (section_offsets, 0);
596 elf_symtab_read (abfd, offset, objfile, 0);
598 /* Add the dynamic symbols. */
600 elf_symtab_read (abfd, offset, objfile, 1);
602 /* Now process debugging information, which is contained in
603 special ELF sections. We first have to find them... */
605 bfd_map_over_sections (abfd, elf_locate_sections, (PTR) &ei);
606 if (dwarf2_has_info (abfd) && !offset)
608 /* DWARF 2 sections */
609 dwarf2_build_psymtabs (objfile, section_offsets, mainline);
611 else if (ei.dboffset && ei.lnoffset)
614 dwarf_build_psymtabs (objfile,
615 section_offsets, mainline,
616 ei.dboffset, ei.dbsize,
617 ei.lnoffset, ei.lnsize);
623 /* Stab sections have an associated string table that looks like
624 a separate section. */
625 str_sect = bfd_get_section_by_name (abfd, ".stabstr");
627 /* FIXME should probably warn about a stab section without a stabstr. */
629 elfstab_build_psymtabs (objfile,
632 ei.stabsect->filepos,
633 bfd_section_size (abfd, ei.stabsect),
635 bfd_section_size (abfd, str_sect));
639 const struct ecoff_debug_swap *swap;
641 /* .mdebug section, presumably holding ECOFF debugging
643 swap = get_elf_backend_data (abfd)->elf_backend_ecoff_debug_swap;
645 elfmdebug_build_psymtabs (objfile, swap, ei.mdebugsect,
649 /* Install any minimal symbols that have been collected as the current
650 minimal symbols for this objfile. */
652 install_minimal_symbols (objfile);
654 do_cleanups (back_to);
657 /* This cleans up the objfile's sym_stab_info pointer, and the chain of
658 stab_section_info's, that might be dangling from it. */
664 struct objfile *objfile = (struct objfile *)objp;
665 struct dbx_symfile_info *dbxinfo = (struct dbx_symfile_info *)
666 objfile->sym_stab_info;
667 struct stab_section_info *ssi, *nssi;
669 ssi = dbxinfo->stab_section_info;
673 mfree (objfile->md, ssi);
677 dbxinfo->stab_section_info = 0; /* Just say No mo info about this. */
681 /* Initialize anything that needs initializing when a completely new symbol
682 file is specified (not just adding some symbols from another file, e.g. a
685 We reinitialize buildsym, since we may be reading stabs from an ELF file. */
688 elf_new_init (ignore)
689 struct objfile *ignore;
691 stabsread_new_init ();
692 buildsym_new_init ();
695 /* Perform any local cleanups required when we are done with a particular
696 objfile. I.E, we are in the process of discarding all symbol information
697 for an objfile, freeing up all memory held for it, and unlinking the
698 objfile struct from the global list of known objfiles. */
701 elf_symfile_finish (objfile)
702 struct objfile *objfile;
704 if (objfile -> sym_stab_info != NULL)
706 mfree (objfile -> md, objfile -> sym_stab_info);
710 /* ELF specific initialization routine for reading symbols.
712 It is passed a pointer to a struct sym_fns which contains, among other
713 things, the BFD for the file whose symbols are being read, and a slot for
714 a pointer to "private data" which we can fill with goodies.
716 For now at least, we have nothing in particular to do, so this function is
720 elf_symfile_init (objfile)
721 struct objfile *objfile;
723 /* ELF objects may be reordered, so set OBJF_REORDERED. If we
724 find this causes a significant slowdown in gdb then we could
725 set it in the debug symbol readers only when necessary. */
726 objfile->flags |= OBJF_REORDERED;
729 /* When handling an ELF file that contains Sun STABS debug info,
730 some of the debug info is relative to the particular chunk of the
731 section that was generated in its individual .o file. E.g.
732 offsets to static variables are relative to the start of the data
733 segment *for that module before linking*. This information is
734 painfully squirreled away in the ELF symbol table as local symbols
735 with wierd names. Go get 'em when needed. */
738 elfstab_offset_sections (objfile, pst)
739 struct objfile *objfile;
740 struct partial_symtab *pst;
742 char *filename = pst->filename;
743 struct dbx_symfile_info *dbx = (struct dbx_symfile_info *)
744 objfile->sym_stab_info;
745 struct stab_section_info *maybe = dbx->stab_section_info;
746 struct stab_section_info *questionable = 0;
750 /* The ELF symbol info doesn't include path names, so strip the path
751 (if any) from the psymtab filename. */
752 while (0 != (p = strchr (filename, '/')))
755 /* FIXME: This linear search could speed up significantly
756 if it was chained in the right order to match how we search it,
757 and if we unchained when we found a match. */
758 for (; maybe; maybe = maybe->next)
760 if (filename[0] == maybe->filename[0]
761 && STREQ (filename, maybe->filename))
763 /* We found a match. But there might be several source files
764 (from different directories) with the same name. */
765 if (0 == maybe->found)
767 questionable = maybe; /* Might use it later. */
771 if (maybe == 0 && questionable != 0)
773 complain (&stab_info_questionable_complaint, filename);
774 maybe = questionable;
779 /* Found it! Allocate a new psymtab struct, and fill it in. */
781 pst->section_offsets = (struct section_offsets *)
782 obstack_alloc (&objfile -> psymbol_obstack,
783 sizeof (struct section_offsets) +
784 sizeof (pst->section_offsets->offsets) * (SECT_OFF_MAX-1));
786 for (i = 0; i < SECT_OFF_MAX; i++)
787 ANOFFSET (pst->section_offsets, i) = maybe->sections[i];
791 /* We were unable to find any offsets for this file. Complain. */
792 if (dbx->stab_section_info) /* If there *is* any info, */
793 complain (&stab_info_mismatch_complaint, filename);
796 /* Register that we are able to handle ELF object file formats. */
798 static struct sym_fns elf_sym_fns =
800 bfd_target_elf_flavour,
801 elf_new_init, /* sym_new_init: init anything gbl to entire symtab */
802 elf_symfile_init, /* sym_init: read initial info, setup for sym_read() */
803 elf_symfile_read, /* sym_read: read a symbol file into symtab */
804 elf_symfile_finish, /* sym_finish: finished with file, cleanup */
805 default_symfile_offsets,
806 /* sym_offsets: Translate ext. to int. relocation */
807 NULL /* next: pointer to next struct sym_fns */
811 _initialize_elfread ()
813 add_symtab_fns (&elf_sym_fns);