1 /* Read ELF (Executable and Linking Format) object files for GDB.
2 Copyright 1991, 1992, 1993, 1994 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., 675 Mass Ave, Cambridge, MA 02139, USA. */
23 #include <time.h> /* For time_t in libbfd.h. */
24 #include <sys/types.h> /* For time_t, if not in time.h. */
25 #include "libbfd.h" /* For bfd_elf_find_section */
32 #include "stabsread.h"
33 #include "gdb-stabs.h"
34 #include "complaints.h"
38 /* The struct elfinfo is available only during ELF symbol table and
39 psymtab reading. It is destroyed at the complation of psymtab-reading.
40 It's local to elf_symfile_read. */
43 file_ptr dboffset; /* Offset to dwarf debug section */
44 unsigned int dbsize; /* Size of dwarf debug section */
45 file_ptr lnoffset; /* Offset to dwarf line number section */
46 unsigned int lnsize; /* Size of dwarf line number section */
47 asection *stabsect; /* Section pointer for .stab section */
48 asection *stabindexsect; /* Section pointer for .stab.index section */
49 asection *mdebugsect; /* Section pointer for .mdebug section */
52 /* Various things we might complain about... */
54 struct complaint section_info_complaint =
55 {"elf/stab section information %s without a preceding file symbol", 0, 0};
57 struct complaint section_info_dup_complaint =
58 {"duplicated elf/stab section information for %s", 0, 0};
60 struct complaint stab_info_mismatch_complaint =
61 {"elf/stab section information missing for %s", 0, 0};
63 struct complaint stab_info_questionable_complaint =
64 {"elf/stab section information questionable for %s", 0, 0};
67 elf_symfile_init PARAMS ((struct objfile *));
70 elf_new_init PARAMS ((struct objfile *));
73 elf_symfile_read PARAMS ((struct objfile *, struct section_offsets *, int));
76 elf_symfile_finish PARAMS ((struct objfile *));
79 elf_symtab_read PARAMS ((bfd *, CORE_ADDR, struct objfile *, int));
82 free_elfinfo PARAMS ((void *));
84 static struct section_offsets *
85 elf_symfile_offsets PARAMS ((struct objfile *, CORE_ADDR));
88 record_minimal_symbol_and_info PARAMS ((char *, CORE_ADDR,
89 enum minimal_symbol_type, char *,
93 elf_locate_sections PARAMS ((bfd *, asection *, void *));
95 /* We are called once per section from elf_symfile_read. We
96 need to examine each section we are passed, check to see
97 if it is something we are interested in processing, and
98 if so, stash away some access information for the section.
100 For now we recognize the dwarf debug information sections and
101 line number sections from matching their section names. The
102 ELF definition is no real help here since it has no direct
103 knowledge of DWARF (by design, so any debugging format can be
106 We also recognize the ".stab" sections used by the Sun compilers
107 released with Solaris 2.
109 FIXME: The section names should not be hardwired strings (what
110 should they be? I don't think most object file formats have enough
111 section flags to specify what kind of debug section it is
115 elf_locate_sections (ignore_abfd, sectp, eip)
120 register struct elfinfo *ei;
122 ei = (struct elfinfo *) eip;
123 if (STREQ (sectp -> name, ".debug"))
125 ei -> dboffset = sectp -> filepos;
126 ei -> dbsize = bfd_get_section_size_before_reloc (sectp);
128 else if (STREQ (sectp -> name, ".line"))
130 ei -> lnoffset = sectp -> filepos;
131 ei -> lnsize = bfd_get_section_size_before_reloc (sectp);
133 else if (STREQ (sectp -> name, ".stab"))
135 ei -> stabsect = sectp;
137 else if (STREQ (sectp -> name, ".stab.index"))
139 ei -> stabindexsect = sectp;
141 else if (STREQ (sectp -> name, ".mdebug"))
143 ei -> mdebugsect = sectp;
147 #if 0 /* Currently unused */
150 elf_interpreter (abfd)
157 interp_sec = bfd_get_section_by_name (abfd, ".interp");
160 size = bfd_section_size (abfd, interp_sec);
161 interp = alloca (size);
162 if (bfd_get_section_contents (abfd, interp_sec, interp, (file_ptr)0,
165 interp = savestring (interp, size - 1);
178 record_minimal_symbol_and_info (name, address, ms_type, info, objfile)
181 enum minimal_symbol_type ms_type;
182 char *info; /* FIXME, is this really char *? */
183 struct objfile *objfile;
187 /* Guess the section from the type. This is likely to be wrong in
193 section = SECT_OFF_TEXT;
194 #ifdef SMASH_TEXT_ADDRESS
195 SMASH_TEXT_ADDRESS (address);
200 section = SECT_OFF_DATA;
204 section = SECT_OFF_BSS;
211 name = obsavestring (name, strlen (name), &objfile -> symbol_obstack);
212 prim_record_minimal_symbol_and_info (name, address, ms_type, info, section,
220 elf_symtab_read -- read the symbol table of an ELF file
224 void elf_symtab_read (bfd *abfd, CORE_ADDR addr,
225 struct objfile *objfile)
229 Given an open bfd, a base address to relocate symbols to, and a
230 flag that specifies whether or not this bfd is for an executable
231 or not (may be shared library for example), add all the global
232 function and data symbols to the minimal symbol table.
234 In stabs-in-ELF, as implemented by Sun, there are some local symbols
235 defined in the ELF symbol table, which can be used to locate
236 the beginnings of sections from each ".o" file that was linked to
237 form the executable objfile. We gather any such info and record it
238 in data structures hung off the objfile's private data.
243 elf_symtab_read (abfd, addr, objfile, dynamic)
246 struct objfile *objfile;
251 asymbol **symbol_table;
252 long number_of_symbols;
255 struct cleanup *back_to;
257 enum minimal_symbol_type ms_type;
258 /* If sectinfo is nonNULL, it contains section info that should end up
259 filed in the objfile. */
260 struct stab_section_info *sectinfo = NULL;
261 /* If filesym is nonzero, it points to a file symbol, but we haven't
262 seen any section info for it yet. */
263 asymbol *filesym = 0;
264 struct dbx_symfile_info *dbx = (struct dbx_symfile_info *)
265 objfile->sym_stab_info;
267 int stripped = (bfd_get_symcount (abfd) == 0);
270 storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);
272 storage_needed = bfd_get_symtab_upper_bound (abfd);
273 if (storage_needed < 0)
274 error ("Can't read symbols from %s: %s", bfd_get_filename (abfd),
275 bfd_errmsg (bfd_get_error ()));
276 if (storage_needed > 0)
278 symbol_table = (asymbol **) xmalloc (storage_needed);
279 back_to = make_cleanup (free, symbol_table);
281 number_of_symbols = bfd_canonicalize_dynamic_symtab (abfd,
284 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
285 if (number_of_symbols < 0)
286 error ("Can't read symbols from %s: %s", bfd_get_filename (abfd),
287 bfd_errmsg (bfd_get_error ()));
288 for (i = 0; i < number_of_symbols; i++)
290 sym = symbol_table[i];
291 if (sym -> name == NULL || *sym -> name == '\0')
293 /* Skip names that don't exist (shouldn't happen), or names
294 that are null strings (may happen). */
298 /* If it is a nonstripped executable, do not enter dynamic
299 symbols, as the dynamic symbol table is usually a subset
300 of the main symbol table.
301 On Irix 5 however, the symbols for the procedure linkage
302 table entries have meaningful values only in the dynamic
303 symbol table, so we always examine undefined symbols. */
304 if (dynamic && !stripped && sym -> section != &bfd_und_section)
306 if (sym -> flags & BSF_FILE)
308 /* STT_FILE debugging symbol that helps stabs-in-elf debugging.
309 Chain any old one onto the objfile; remember new sym. */
310 if (sectinfo != NULL)
312 sectinfo -> next = dbx -> stab_section_info;
313 dbx -> stab_section_info = sectinfo;
318 else if (sym -> flags & (BSF_GLOBAL | BSF_LOCAL | BSF_WEAK))
320 /* Select global/local/weak symbols. Note that bfd puts abs
321 symbols in their own section, so all symbols we are
322 interested in will have a section. */
323 /* Bfd symbols are section relative. */
324 symaddr = sym -> value + sym -> section -> vma;
325 /* Relocate all non-absolute symbols by base address. */
326 if (sym -> section != &bfd_abs_section)
330 /* For non-absolute symbols, use the type of the section
331 they are relative to, to intuit text/data. Bfd provides
332 no way of figuring this out for absolute symbols. */
333 if (sym -> section == &bfd_und_section
334 && (sym -> flags & BSF_GLOBAL)
335 && (sym -> flags & BSF_FUNCTION))
337 /* Symbol is a reference to a function defined in
339 If its value is non zero then it is usually the
340 absolute address of the corresponding entry in
341 the procedure linkage table.
342 If its value is zero then the dynamic linker has to
343 resolve the symbol. We are unable to find any
344 meaningful address for this symbol in the
345 executable file, so we skip it.
346 Irix 5 has a zero value for all shared library functions
347 in the main symbol table, but the dynamic symbol table
348 provides the right values. */
349 ms_type = mst_solib_trampoline;
350 symaddr = sym -> value;
354 else if (sym -> section == &bfd_abs_section)
356 /* This is a hack to get the minimal symbol type
357 right for Irix 5, which has absolute adresses
358 with special section indices for dynamic symbols. */
359 unsigned short shndx =
360 ((elf_symbol_type *) sym)->internal_elf_sym.st_shndx;
370 case SHN_MIPS_ACOMMON:
377 else if (sym -> section -> flags & SEC_CODE)
379 if (sym -> flags & BSF_GLOBAL)
383 else if (sym->name[0] == '.' && sym->name[1] == 'L')
384 /* Looks like a compiler-generated label. Skip it.
385 The assembler should be skipping these (to keep
386 executables small), but apparently with gcc on the
387 delta m88k SVR4, it loses. So to have us check too
388 should be harmless (but I encourage people to fix this
389 in the assembler instead of adding checks here). */
393 ms_type = mst_file_text;
396 else if (sym -> section -> flags & SEC_ALLOC)
398 if (sym -> flags & BSF_GLOBAL)
400 if (sym -> section -> flags & SEC_LOAD)
409 else if (sym -> flags & BSF_LOCAL)
411 /* Named Local variable in a Data section. Check its
412 name for stabs-in-elf. The STREQ macro checks the
413 first character inline, so we only actually do a
414 strcmp function call on names that start with 'B'
416 index = SECT_OFF_MAX;
417 if (STREQ ("Bbss.bss", sym -> name))
419 index = SECT_OFF_BSS;
421 else if (STREQ ("Ddata.data", sym -> name))
423 index = SECT_OFF_DATA;
425 else if (STREQ ("Drodata.rodata", sym -> name))
427 index = SECT_OFF_RODATA;
429 if (index != SECT_OFF_MAX)
431 /* Found a special local symbol. Allocate a
432 sectinfo, if needed, and fill it in. */
433 if (sectinfo == NULL)
435 sectinfo = (struct stab_section_info *)
436 xmmalloc (objfile -> md, sizeof (*sectinfo));
437 memset ((PTR) sectinfo, 0, sizeof (*sectinfo));
440 complain (§ion_info_complaint,
445 sectinfo -> filename =
446 (char *) filesym -> name;
449 if (sectinfo -> sections[index] != 0)
451 complain (§ion_info_dup_complaint,
452 sectinfo -> filename);
454 /* Bfd symbols are section relative. */
455 symaddr = sym -> value + sym -> section -> vma;
456 /* Relocate non-absolute symbols by base address. */
457 if (sym -> section != &bfd_abs_section)
461 sectinfo -> sections[index] = symaddr;
462 /* The special local symbols don't go in the
463 minimal symbol table, so ignore this one. */
466 /* Not a special stabs-in-elf symbol, do regular
467 symbol processing. */
468 if (sym -> section -> flags & SEC_LOAD)
470 ms_type = mst_file_data;
474 ms_type = mst_file_bss;
479 ms_type = mst_unknown;
484 /* FIXME: Solaris2 shared libraries include lots of
485 odd "absolute" and "undefined" symbols, that play
486 hob with actions like finding what function the PC
487 is in. Ignore them if they aren't text, data, or bss. */
488 /* ms_type = mst_unknown; */
489 continue; /* Skip this symbol. */
491 /* Pass symbol size field in via BFD. FIXME!!! */
492 size = ((elf_symbol_type *) sym) -> internal_elf_sym.st_size;
493 record_minimal_symbol_and_info ((char *) sym -> name, symaddr,
494 ms_type, (PTR) size, objfile);
497 do_cleanups (back_to);
501 /* Scan and build partial symbols for a symbol file.
502 We have been initialized by a call to elf_symfile_init, which
503 currently does nothing.
505 SECTION_OFFSETS is a set of offsets to apply to relocate the symbols
506 in each section. We simplify it down to a single offset for all
509 MAINLINE is true if we are reading the main symbol
510 table (as opposed to a shared lib or dynamically loaded file).
512 This function only does the minimum work necessary for letting the
513 user "name" things symbolically; it does not read the entire symtab.
514 Instead, it reads the external and static symbols and puts them in partial
515 symbol tables. When more extensive information is requested of a
516 file, the corresponding partial symbol table is mutated into a full
517 fledged symbol table by going back and reading the symbols
520 We look for sections with specific names, to tell us what debug
521 format to look for: FIXME!!!
523 dwarf_build_psymtabs() builds psymtabs for DWARF symbols;
524 elfstab_build_psymtabs() handles STABS symbols;
525 mdebug_build_psymtabs() handles ECOFF debugging information.
527 Note that ELF files have a "minimal" symbol table, which looks a lot
528 like a COFF symbol table, but has only the minimal information necessary
529 for linking. We process this also, and use the information to
530 build gdb's minimal symbol table. This gives us some minimal debugging
531 capability even for files compiled without -g. */
534 elf_symfile_read (objfile, section_offsets, mainline)
535 struct objfile *objfile;
536 struct section_offsets *section_offsets;
539 bfd *abfd = objfile->obfd;
541 struct cleanup *back_to;
544 init_minimal_symbol_collection ();
545 back_to = make_cleanup (discard_minimal_symbols, 0);
547 memset ((char *) &ei, 0, sizeof (ei));
549 /* Allocate struct to keep track of the symfile */
550 objfile->sym_stab_info = (PTR)
551 xmmalloc (objfile -> md, sizeof (struct dbx_symfile_info));
552 memset ((char *) objfile->sym_stab_info, 0, sizeof (struct dbx_symfile_info));
553 make_cleanup (free_elfinfo, (PTR) objfile);
555 /* Process the normal ELF symbol table first. This may write some
556 chain of info into the dbx_symfile_info in objfile->sym_stab_info,
557 which can later be used by elfstab_offset_sections. */
559 /* FIXME, should take a section_offsets param, not just an offset. */
560 offset = ANOFFSET (section_offsets, 0);
561 elf_symtab_read (abfd, offset, objfile, 0);
563 /* Add the dynamic symbols if we are reading the main symbol table. */
566 elf_symtab_read (abfd, offset, objfile, 1);
568 /* Now process debugging information, which is contained in
569 special ELF sections. We first have to find them... */
571 bfd_map_over_sections (abfd, elf_locate_sections, (PTR) &ei);
572 if (ei.dboffset && ei.lnoffset)
575 dwarf_build_psymtabs (objfile,
576 section_offsets, mainline,
577 ei.dboffset, ei.dbsize,
578 ei.lnoffset, ei.lnsize);
584 /* FIXME: Sun didn't really know how to implement this well.
585 They made .stab sections that don't point to the .stabstr
586 section with the sh_link field. BFD doesn't make string table
587 sections visible to the caller. So we have to search the
588 ELF section table, not the BFD section table, for the string
590 struct elf32_internal_shdr *elf_sect;
592 elf_sect = bfd_elf_find_section (abfd, ".stabstr");
594 elfstab_build_psymtabs (objfile,
597 ei.stabsect->filepos, /* .stab offset */
598 bfd_get_section_size_before_reloc (ei.stabsect),/* .stab size */
599 (file_ptr) elf_sect->sh_offset, /* .stabstr offset */
600 elf_sect->sh_size); /* .stabstr size */
604 const struct ecoff_debug_swap *swap;
606 /* .mdebug section, presumably holding ECOFF debugging
608 swap = get_elf_backend_data (abfd)->elf_backend_ecoff_debug_swap;
610 elfmdebug_build_psymtabs (objfile, swap, ei.mdebugsect,
614 if (!have_partial_symbols ())
617 printf_filtered ("(no debugging symbols found)...");
621 /* Install any minimal symbols that have been collected as the current
622 minimal symbols for this objfile. */
624 install_minimal_symbols (objfile);
626 do_cleanups (back_to);
629 /* This cleans up the objfile's sym_stab_info pointer, and the chain of
630 stab_section_info's, that might be dangling from it. */
636 struct objfile *objfile = (struct objfile *)objp;
637 struct dbx_symfile_info *dbxinfo = (struct dbx_symfile_info *)
638 objfile->sym_stab_info;
639 struct stab_section_info *ssi, *nssi;
641 ssi = dbxinfo->stab_section_info;
645 mfree (objfile->md, ssi);
649 dbxinfo->stab_section_info = 0; /* Just say No mo info about this. */
653 /* Initialize anything that needs initializing when a completely new symbol
654 file is specified (not just adding some symbols from another file, e.g. a
657 We reinitialize buildsym, since we may be reading stabs from an ELF file. */
660 elf_new_init (ignore)
661 struct objfile *ignore;
663 stabsread_new_init ();
664 buildsym_new_init ();
667 /* Perform any local cleanups required when we are done with a particular
668 objfile. I.E, we are in the process of discarding all symbol information
669 for an objfile, freeing up all memory held for it, and unlinking the
670 objfile struct from the global list of known objfiles. */
673 elf_symfile_finish (objfile)
674 struct objfile *objfile;
676 if (objfile -> sym_stab_info != NULL)
678 mfree (objfile -> md, objfile -> sym_stab_info);
682 /* ELF specific initialization routine for reading symbols.
684 It is passed a pointer to a struct sym_fns which contains, among other
685 things, the BFD for the file whose symbols are being read, and a slot for
686 a pointer to "private data" which we can fill with goodies.
688 For now at least, we have nothing in particular to do, so this function is
692 elf_symfile_init (ignore)
693 struct objfile *ignore;
697 /* ELF specific parsing routine for section offsets.
699 Plain and simple for now. */
702 struct section_offsets *
703 elf_symfile_offsets (objfile, addr)
704 struct objfile *objfile;
707 struct section_offsets *section_offsets;
710 objfile->num_sections = SECT_OFF_MAX;
711 section_offsets = (struct section_offsets *)
712 obstack_alloc (&objfile -> psymbol_obstack,
713 sizeof (struct section_offsets)
714 + sizeof (section_offsets->offsets) * (SECT_OFF_MAX-1));
716 for (i = 0; i < SECT_OFF_MAX; i++)
717 ANOFFSET (section_offsets, i) = addr;
719 return section_offsets;
722 /* When handling an ELF file that contains Sun STABS debug info,
723 some of the debug info is relative to the particular chunk of the
724 section that was generated in its individual .o file. E.g.
725 offsets to static variables are relative to the start of the data
726 segment *for that module before linking*. This information is
727 painfully squirreled away in the ELF symbol table as local symbols
728 with wierd names. Go get 'em when needed. */
731 elfstab_offset_sections (objfile, pst)
732 struct objfile *objfile;
733 struct partial_symtab *pst;
735 char *filename = pst->filename;
736 struct dbx_symfile_info *dbx = (struct dbx_symfile_info *)
737 objfile->sym_stab_info;
738 struct stab_section_info *maybe = dbx->stab_section_info;
739 struct stab_section_info *questionable = 0;
743 /* The ELF symbol info doesn't include path names, so strip the path
744 (if any) from the psymtab filename. */
745 while (0 != (p = strchr (filename, '/')))
748 /* FIXME: This linear search could speed up significantly
749 if it was chained in the right order to match how we search it,
750 and if we unchained when we found a match. */
751 for (; maybe; maybe = maybe->next)
753 if (filename[0] == maybe->filename[0]
754 && STREQ (filename, maybe->filename))
756 /* We found a match. But there might be several source files
757 (from different directories) with the same name. */
758 if (0 == maybe->found)
760 questionable = maybe; /* Might use it later. */
764 if (maybe == 0 && questionable != 0)
766 complain (&stab_info_questionable_complaint, filename);
767 maybe = questionable;
772 /* Found it! Allocate a new psymtab struct, and fill it in. */
774 pst->section_offsets = (struct section_offsets *)
775 obstack_alloc (&objfile -> psymbol_obstack,
776 sizeof (struct section_offsets) +
777 sizeof (pst->section_offsets->offsets) * (SECT_OFF_MAX-1));
779 for (i = 0; i < SECT_OFF_MAX; i++)
780 ANOFFSET (pst->section_offsets, i) = maybe->sections[i];
784 /* We were unable to find any offsets for this file. Complain. */
785 if (dbx->stab_section_info) /* If there *is* any info, */
786 complain (&stab_info_mismatch_complaint, filename);
789 /* Register that we are able to handle ELF object file formats. */
791 static struct sym_fns elf_sym_fns =
793 bfd_target_elf_flavour,
794 elf_new_init, /* sym_new_init: init anything gbl to entire symtab */
795 elf_symfile_init, /* sym_init: read initial info, setup for sym_read() */
796 elf_symfile_read, /* sym_read: read a symbol file into symtab */
797 elf_symfile_finish, /* sym_finish: finished with file, cleanup */
798 elf_symfile_offsets, /* sym_offsets: Translate ext. to int. relocation */
799 NULL /* next: pointer to next struct sym_fns */
803 _initialize_elfread ()
805 add_symtab_fns (&elf_sym_fns);