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. */
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 section_offsets *
82 elf_symfile_offsets PARAMS ((struct objfile *, CORE_ADDR));
85 record_minimal_symbol_and_info PARAMS ((char *, CORE_ADDR,
86 enum minimal_symbol_type, char *,
90 elf_locate_sections PARAMS ((bfd *, asection *, void *));
92 /* We are called once per section from elf_symfile_read. We
93 need to examine each section we are passed, check to see
94 if it is something we are interested in processing, and
95 if so, stash away some access information for the section.
97 For now we recognize the dwarf debug information sections and
98 line number sections from matching their section names. The
99 ELF definition is no real help here since it has no direct
100 knowledge of DWARF (by design, so any debugging format can be
103 We also recognize the ".stab" sections used by the Sun compilers
104 released with Solaris 2.
106 FIXME: The section names should not be hardwired strings (what
107 should they be? I don't think most object file formats have enough
108 section flags to specify what kind of debug section it is
112 elf_locate_sections (ignore_abfd, sectp, eip)
117 register struct elfinfo *ei;
119 ei = (struct elfinfo *) eip;
120 if (STREQ (sectp -> name, ".debug"))
122 ei -> dboffset = sectp -> filepos;
123 ei -> dbsize = bfd_get_section_size_before_reloc (sectp);
125 else if (STREQ (sectp -> name, ".line"))
127 ei -> lnoffset = sectp -> filepos;
128 ei -> lnsize = bfd_get_section_size_before_reloc (sectp);
130 else if (STREQ (sectp -> name, ".stab"))
132 ei -> stabsect = sectp;
134 else if (STREQ (sectp -> name, ".stab.index"))
136 ei -> stabindexsect = sectp;
138 else if (STREQ (sectp -> name, ".mdebug"))
140 ei -> mdebugsect = sectp;
144 #if 0 /* Currently unused */
147 elf_interpreter (abfd)
154 interp_sec = bfd_get_section_by_name (abfd, ".interp");
157 size = bfd_section_size (abfd, interp_sec);
158 interp = alloca (size);
159 if (bfd_get_section_contents (abfd, interp_sec, interp, (file_ptr)0,
162 interp = savestring (interp, size - 1);
175 record_minimal_symbol_and_info (name, address, ms_type, info, objfile)
178 enum minimal_symbol_type ms_type;
179 char *info; /* FIXME, is this really char *? */
180 struct objfile *objfile;
184 /* Guess the section from the type. This is likely to be wrong in
190 section = SECT_OFF_TEXT;
191 #ifdef SMASH_TEXT_ADDRESS
192 SMASH_TEXT_ADDRESS (address);
197 section = SECT_OFF_DATA;
201 section = SECT_OFF_BSS;
208 name = obsavestring (name, strlen (name), &objfile -> symbol_obstack);
209 prim_record_minimal_symbol_and_info (name, address, ms_type, info, section,
217 elf_symtab_read -- read the symbol table of an ELF file
221 void elf_symtab_read (bfd *abfd, CORE_ADDR addr,
222 struct objfile *objfile)
226 Given an open bfd, a base address to relocate symbols to, and a
227 flag that specifies whether or not this bfd is for an executable
228 or not (may be shared library for example), add all the global
229 function and data symbols to the minimal symbol table.
231 In stabs-in-ELF, as implemented by Sun, there are some local symbols
232 defined in the ELF symbol table, which can be used to locate
233 the beginnings of sections from each ".o" file that was linked to
234 form the executable objfile. We gather any such info and record it
235 in data structures hung off the objfile's private data.
240 elf_symtab_read (abfd, addr, objfile, dynamic)
243 struct objfile *objfile;
248 asymbol **symbol_table;
249 long number_of_symbols;
252 struct cleanup *back_to;
254 enum minimal_symbol_type ms_type;
255 /* If sectinfo is nonNULL, it contains section info that should end up
256 filed in the objfile. */
257 struct stab_section_info *sectinfo = NULL;
258 /* If filesym is nonzero, it points to a file symbol, but we haven't
259 seen any section info for it yet. */
260 asymbol *filesym = 0;
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). */
303 /* If it is a nonstripped executable, do not enter dynamic
304 symbols, as the dynamic symbol table is usually a subset
305 of the main symbol table.
306 On Irix 5 however, the symbols for the procedure linkage
307 table entries have meaningful values only in the dynamic
308 symbol table, so we always examine undefined symbols. */
309 if (dynamic && !stripped && sym -> section != &bfd_und_section)
311 if (sym -> flags & BSF_FILE)
313 /* STT_FILE debugging symbol that helps stabs-in-elf debugging.
314 Chain any old one onto the objfile; remember new sym. */
315 if (sectinfo != NULL)
317 sectinfo -> next = dbx -> stab_section_info;
318 dbx -> stab_section_info = sectinfo;
323 else if (sym -> flags & (BSF_GLOBAL | BSF_LOCAL | BSF_WEAK))
325 /* Select global/local/weak symbols. Note that bfd puts abs
326 symbols in their own section, so all symbols we are
327 interested in will have a section. */
328 /* Bfd symbols are section relative. */
329 symaddr = sym -> value + sym -> section -> vma;
330 /* Relocate all non-absolute symbols by base address. */
331 if (sym -> section != &bfd_abs_section)
335 /* For non-absolute symbols, use the type of the section
336 they are relative to, to intuit text/data. Bfd provides
337 no way of figuring this out for absolute symbols. */
338 if (sym -> section == &bfd_und_section
339 && (sym -> flags & BSF_GLOBAL)
340 && (sym -> flags & BSF_FUNCTION))
342 /* Symbol is a reference to a function defined in
344 If its value is non zero then it is usually the
345 absolute address of the corresponding entry in
346 the procedure linkage table.
347 If its value is zero then the dynamic linker has to
348 resolve the symbol. We are unable to find any
349 meaningful address for this symbol in the
350 executable file, so we skip it.
351 Irix 5 has a zero value for all shared library functions
352 in the main symbol table, but the dynamic symbol table
353 provides the right values. */
354 ms_type = mst_solib_trampoline;
355 symaddr = sym -> value;
360 else if (sym -> section == &bfd_abs_section)
362 /* This is a hack to get the minimal symbol type
363 right for Irix 5, which has absolute adresses
364 with special section indices for dynamic symbols. */
365 unsigned short shndx =
366 ((elf_symbol_type *) sym)->internal_elf_sym.st_shndx;
376 case SHN_MIPS_ACOMMON:
383 else if (sym -> section -> flags & SEC_CODE)
385 if (sym -> flags & BSF_GLOBAL)
389 else if ((sym->name[0] == '.' && sym->name[1] == 'L')
390 || ((sym -> flags & BSF_LOCAL)
391 && sym->name[0] == 'L'
392 && sym->name[1] == 'L'))
393 /* Looks like a compiler-generated label. Skip it.
394 The assembler should be skipping these (to keep
395 executables small), but apparently with gcc on the
396 delta m88k SVR4, it loses. So to have us check too
397 should be harmless (but I encourage people to fix this
398 in the assembler instead of adding checks here). */
402 ms_type = mst_file_text;
405 else if (sym -> section -> flags & SEC_ALLOC)
407 if (sym -> flags & BSF_GLOBAL)
409 if (sym -> section -> flags & SEC_LOAD)
418 else if (sym -> flags & BSF_LOCAL)
420 /* Named Local variable in a Data section. Check its
421 name for stabs-in-elf. The STREQ macro checks the
422 first character inline, so we only actually do a
423 strcmp function call on names that start with 'B'
425 index = SECT_OFF_MAX;
426 if (STREQ ("Bbss.bss", sym -> name))
428 index = SECT_OFF_BSS;
430 else if (STREQ ("Ddata.data", sym -> name))
432 index = SECT_OFF_DATA;
434 else if (STREQ ("Drodata.rodata", sym -> name))
436 index = SECT_OFF_RODATA;
438 if (index != SECT_OFF_MAX)
440 /* Found a special local symbol. Allocate a
441 sectinfo, if needed, and fill it in. */
442 if (sectinfo == NULL)
444 sectinfo = (struct stab_section_info *)
445 xmmalloc (objfile -> md, sizeof (*sectinfo));
446 memset ((PTR) sectinfo, 0, sizeof (*sectinfo));
449 complain (§ion_info_complaint,
454 sectinfo -> filename =
455 (char *) filesym -> name;
458 if (sectinfo -> sections[index] != 0)
460 complain (§ion_info_dup_complaint,
461 sectinfo -> filename);
463 /* Bfd symbols are section relative. */
464 symaddr = sym -> value + sym -> section -> vma;
465 /* Relocate non-absolute symbols by base address. */
466 if (sym -> section != &bfd_abs_section)
470 sectinfo -> sections[index] = symaddr;
471 /* The special local symbols don't go in the
472 minimal symbol table, so ignore this one. */
475 /* Not a special stabs-in-elf symbol, do regular
476 symbol processing. */
477 if (sym -> section -> flags & SEC_LOAD)
479 ms_type = mst_file_data;
483 ms_type = mst_file_bss;
488 ms_type = mst_unknown;
493 /* FIXME: Solaris2 shared libraries include lots of
494 odd "absolute" and "undefined" symbols, that play
495 hob with actions like finding what function the PC
496 is in. Ignore them if they aren't text, data, or bss. */
497 /* ms_type = mst_unknown; */
498 continue; /* Skip this symbol. */
500 /* Pass symbol size field in via BFD. FIXME!!! */
501 size = ((elf_symbol_type *) sym) -> internal_elf_sym.st_size;
502 record_minimal_symbol_and_info ((char *) sym -> name, symaddr,
503 ms_type, (PTR) size, objfile);
506 do_cleanups (back_to);
510 /* Scan and build partial symbols for a symbol file.
511 We have been initialized by a call to elf_symfile_init, which
512 currently does nothing.
514 SECTION_OFFSETS is a set of offsets to apply to relocate the symbols
515 in each section. We simplify it down to a single offset for all
518 MAINLINE is true if we are reading the main symbol
519 table (as opposed to a shared lib or dynamically loaded file).
521 This function only does the minimum work necessary for letting the
522 user "name" things symbolically; it does not read the entire symtab.
523 Instead, it reads the external and static symbols and puts them in partial
524 symbol tables. When more extensive information is requested of a
525 file, the corresponding partial symbol table is mutated into a full
526 fledged symbol table by going back and reading the symbols
529 We look for sections with specific names, to tell us what debug
530 format to look for: FIXME!!!
532 dwarf_build_psymtabs() builds psymtabs for DWARF symbols;
533 elfstab_build_psymtabs() handles STABS symbols;
534 mdebug_build_psymtabs() handles ECOFF debugging information.
536 Note that ELF files have a "minimal" symbol table, which looks a lot
537 like a COFF symbol table, but has only the minimal information necessary
538 for linking. We process this also, and use the information to
539 build gdb's minimal symbol table. This gives us some minimal debugging
540 capability even for files compiled without -g. */
543 elf_symfile_read (objfile, section_offsets, mainline)
544 struct objfile *objfile;
545 struct section_offsets *section_offsets;
548 bfd *abfd = objfile->obfd;
550 struct cleanup *back_to;
553 init_minimal_symbol_collection ();
554 back_to = make_cleanup (discard_minimal_symbols, 0);
556 memset ((char *) &ei, 0, sizeof (ei));
558 /* Allocate struct to keep track of the symfile */
559 objfile->sym_stab_info = (PTR)
560 xmmalloc (objfile -> md, sizeof (struct dbx_symfile_info));
561 memset ((char *) objfile->sym_stab_info, 0, sizeof (struct dbx_symfile_info));
562 make_cleanup (free_elfinfo, (PTR) objfile);
564 /* Process the normal ELF symbol table first. This may write some
565 chain of info into the dbx_symfile_info in objfile->sym_stab_info,
566 which can later be used by elfstab_offset_sections. */
568 /* FIXME, should take a section_offsets param, not just an offset. */
569 offset = ANOFFSET (section_offsets, 0);
570 elf_symtab_read (abfd, offset, objfile, 0);
572 /* Add the dynamic symbols. */
574 elf_symtab_read (abfd, offset, objfile, 1);
576 /* Now process debugging information, which is contained in
577 special ELF sections. We first have to find them... */
579 bfd_map_over_sections (abfd, elf_locate_sections, (PTR) &ei);
580 if (ei.dboffset && ei.lnoffset)
583 dwarf_build_psymtabs (objfile,
584 section_offsets, mainline,
585 ei.dboffset, ei.dbsize,
586 ei.lnoffset, ei.lnsize);
592 /* Stab sections have an associated string table that looks like
593 a separate section. */
594 str_sect = bfd_get_section_by_name (abfd, ".stabstr");
596 /* FIXME should probably warn about a stab section without a stabstr. */
598 elfstab_build_psymtabs (objfile,
601 ei.stabsect->filepos,
602 bfd_section_size (abfd, ei.stabsect),
604 bfd_section_size (abfd, str_sect));
608 const struct ecoff_debug_swap *swap;
610 /* .mdebug section, presumably holding ECOFF debugging
612 swap = get_elf_backend_data (abfd)->elf_backend_ecoff_debug_swap;
614 elfmdebug_build_psymtabs (objfile, swap, ei.mdebugsect,
618 /* Install any minimal symbols that have been collected as the current
619 minimal symbols for this objfile. */
621 install_minimal_symbols (objfile);
623 do_cleanups (back_to);
626 /* This cleans up the objfile's sym_stab_info pointer, and the chain of
627 stab_section_info's, that might be dangling from it. */
633 struct objfile *objfile = (struct objfile *)objp;
634 struct dbx_symfile_info *dbxinfo = (struct dbx_symfile_info *)
635 objfile->sym_stab_info;
636 struct stab_section_info *ssi, *nssi;
638 ssi = dbxinfo->stab_section_info;
642 mfree (objfile->md, ssi);
646 dbxinfo->stab_section_info = 0; /* Just say No mo info about this. */
650 /* Initialize anything that needs initializing when a completely new symbol
651 file is specified (not just adding some symbols from another file, e.g. a
654 We reinitialize buildsym, since we may be reading stabs from an ELF file. */
657 elf_new_init (ignore)
658 struct objfile *ignore;
660 stabsread_new_init ();
661 buildsym_new_init ();
664 /* Perform any local cleanups required when we are done with a particular
665 objfile. I.E, we are in the process of discarding all symbol information
666 for an objfile, freeing up all memory held for it, and unlinking the
667 objfile struct from the global list of known objfiles. */
670 elf_symfile_finish (objfile)
671 struct objfile *objfile;
673 if (objfile -> sym_stab_info != NULL)
675 mfree (objfile -> md, objfile -> sym_stab_info);
679 /* ELF specific initialization routine for reading symbols.
681 It is passed a pointer to a struct sym_fns which contains, among other
682 things, the BFD for the file whose symbols are being read, and a slot for
683 a pointer to "private data" which we can fill with goodies.
685 For now at least, we have nothing in particular to do, so this function is
689 elf_symfile_init (ignore)
690 struct objfile *ignore;
694 /* ELF specific parsing routine for section offsets.
696 Plain and simple for now. */
699 struct section_offsets *
700 elf_symfile_offsets (objfile, addr)
701 struct objfile *objfile;
704 struct section_offsets *section_offsets;
707 objfile->num_sections = SECT_OFF_MAX;
708 section_offsets = (struct section_offsets *)
709 obstack_alloc (&objfile -> psymbol_obstack,
710 sizeof (struct section_offsets)
711 + sizeof (section_offsets->offsets) * (SECT_OFF_MAX-1));
713 for (i = 0; i < SECT_OFF_MAX; i++)
714 ANOFFSET (section_offsets, i) = addr;
716 return section_offsets;
719 /* When handling an ELF file that contains Sun STABS debug info,
720 some of the debug info is relative to the particular chunk of the
721 section that was generated in its individual .o file. E.g.
722 offsets to static variables are relative to the start of the data
723 segment *for that module before linking*. This information is
724 painfully squirreled away in the ELF symbol table as local symbols
725 with wierd names. Go get 'em when needed. */
728 elfstab_offset_sections (objfile, pst)
729 struct objfile *objfile;
730 struct partial_symtab *pst;
732 char *filename = pst->filename;
733 struct dbx_symfile_info *dbx = (struct dbx_symfile_info *)
734 objfile->sym_stab_info;
735 struct stab_section_info *maybe = dbx->stab_section_info;
736 struct stab_section_info *questionable = 0;
740 /* The ELF symbol info doesn't include path names, so strip the path
741 (if any) from the psymtab filename. */
742 while (0 != (p = strchr (filename, '/')))
745 /* FIXME: This linear search could speed up significantly
746 if it was chained in the right order to match how we search it,
747 and if we unchained when we found a match. */
748 for (; maybe; maybe = maybe->next)
750 if (filename[0] == maybe->filename[0]
751 && STREQ (filename, maybe->filename))
753 /* We found a match. But there might be several source files
754 (from different directories) with the same name. */
755 if (0 == maybe->found)
757 questionable = maybe; /* Might use it later. */
761 if (maybe == 0 && questionable != 0)
763 complain (&stab_info_questionable_complaint, filename);
764 maybe = questionable;
769 /* Found it! Allocate a new psymtab struct, and fill it in. */
771 pst->section_offsets = (struct section_offsets *)
772 obstack_alloc (&objfile -> psymbol_obstack,
773 sizeof (struct section_offsets) +
774 sizeof (pst->section_offsets->offsets) * (SECT_OFF_MAX-1));
776 for (i = 0; i < SECT_OFF_MAX; i++)
777 ANOFFSET (pst->section_offsets, i) = maybe->sections[i];
781 /* We were unable to find any offsets for this file. Complain. */
782 if (dbx->stab_section_info) /* If there *is* any info, */
783 complain (&stab_info_mismatch_complaint, filename);
786 /* Register that we are able to handle ELF object file formats. */
788 static struct sym_fns elf_sym_fns =
790 bfd_target_elf_flavour,
791 elf_new_init, /* sym_new_init: init anything gbl to entire symtab */
792 elf_symfile_init, /* sym_init: read initial info, setup for sym_read() */
793 elf_symfile_read, /* sym_read: read a symbol file into symtab */
794 elf_symfile_finish, /* sym_finish: finished with file, cleanup */
795 elf_symfile_offsets, /* sym_offsets: Translate ext. to int. relocation */
796 NULL /* next: pointer to next struct sym_fns */
800 _initialize_elfread ()
802 add_symtab_fns (&elf_sym_fns);