1 /* Read ELF (Executable and Linking Format) object files for GDB.
2 Copyright 1991, 1992 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 */
31 #include "stabsread.h"
32 #include "gdb-stabs.h"
33 #include "complaints.h"
37 /* The struct elfinfo is available only during ELF symbol table and
38 psymtab reading. It is destroyed at the complation of psymtab-reading.
39 It's local to elf_symfile_read. */
42 file_ptr dboffset; /* Offset to dwarf debug section */
43 unsigned int dbsize; /* Size of dwarf debug section */
44 file_ptr lnoffset; /* Offset to dwarf line number section */
45 unsigned int lnsize; /* Size of dwarf line number section */
46 asection *stabsect; /* Section pointer for .stab section */
47 asection *stabindexsect; /* Section pointer for .stab.index section */
48 asection *mdebugsect; /* Section pointer for .mdebug section */
51 /* Various things we might complain about... */
53 struct complaint section_info_complaint =
54 {"elf/stab section information %s without a preceding file symbol", 0, 0};
56 struct complaint section_info_dup_complaint =
57 {"duplicated elf/stab section information for %s", 0, 0};
59 struct complaint stab_info_mismatch_complaint =
60 {"elf/stab section information missing for %s", 0, 0};
62 struct complaint stab_info_questionable_complaint =
63 {"elf/stab section information questionable for %s", 0, 0};
66 elf_symfile_init PARAMS ((struct objfile *));
69 elf_new_init PARAMS ((struct objfile *));
72 elf_symfile_read PARAMS ((struct objfile *, struct section_offsets *, int));
75 elf_symfile_finish PARAMS ((struct objfile *));
78 elf_symtab_read PARAMS ((bfd *, CORE_ADDR, struct objfile *));
81 free_elfinfo PARAMS ((void *));
83 static struct section_offsets *
84 elf_symfile_offsets PARAMS ((struct objfile *, CORE_ADDR));
87 record_minimal_symbol_and_info PARAMS ((char *, CORE_ADDR,
88 enum minimal_symbol_type, char *,
92 elf_locate_sections PARAMS ((bfd *, asection *, void *));
94 /* We are called once per section from elf_symfile_read. We
95 need to examine each section we are passed, check to see
96 if it is something we are interested in processing, and
97 if so, stash away some access information for the section.
99 For now we recognize the dwarf debug information sections and
100 line number sections from matching their section names. The
101 ELF definition is no real help here since it has no direct
102 knowledge of DWARF (by design, so any debugging format can be
105 We also recognize the ".stab" sections used by the Sun compilers
106 released with Solaris 2.
108 FIXME: The section names should not be hardwired strings (what
109 should they be? I don't think most object file formats have enough
110 section flags to specify what kind of debug section it is
114 elf_locate_sections (ignore_abfd, sectp, eip)
119 register struct elfinfo *ei;
121 ei = (struct elfinfo *) eip;
122 if (STREQ (sectp -> name, ".debug"))
124 ei -> dboffset = sectp -> filepos;
125 ei -> dbsize = bfd_get_section_size_before_reloc (sectp);
127 else if (STREQ (sectp -> name, ".line"))
129 ei -> lnoffset = sectp -> filepos;
130 ei -> lnsize = bfd_get_section_size_before_reloc (sectp);
132 else if (STREQ (sectp -> name, ".stab"))
134 ei -> stabsect = sectp;
136 else if (STREQ (sectp -> name, ".stab.index"))
138 ei -> stabindexsect = sectp;
140 else if (STREQ (sectp -> name, ".mdebug"))
142 ei -> mdebugsect = sectp;
146 #if 0 /* Currently unused */
149 elf_interpreter (abfd)
156 interp_sec = bfd_get_section_by_name (abfd, ".interp");
159 size = bfd_section_size (abfd, interp_sec);
160 interp = alloca (size);
161 if (bfd_get_section_contents (abfd, interp_sec, interp, (file_ptr)0,
164 interp = savestring (interp, size - 1);
177 record_minimal_symbol_and_info (name, address, ms_type, info, objfile)
180 enum minimal_symbol_type ms_type;
181 char *info; /* FIXME, is this really char *? */
182 struct objfile *objfile;
186 /* Guess the section from the type. This is likely to be wrong in
192 section = SECT_OFF_TEXT;
193 #ifdef SMASH_TEXT_ADDRESS
194 SMASH_TEXT_ADDRESS (address);
199 section = SECT_OFF_DATA;
203 section = SECT_OFF_BSS;
210 name = obsavestring (name, strlen (name), &objfile -> symbol_obstack);
211 prim_record_minimal_symbol_and_info (name, address, ms_type, info, section,
219 elf_symtab_read -- read the symbol table of an ELF file
223 void elf_symtab_read (bfd *abfd, CORE_ADDR addr,
224 struct objfile *objfile)
228 Given an open bfd, a base address to relocate symbols to, and a
229 flag that specifies whether or not this bfd is for an executable
230 or not (may be shared library for example), add all the global
231 function and data symbols to the minimal symbol table.
233 In stabs-in-ELF, as implemented by Sun, there are some local symbols
234 defined in the ELF symbol table, which can be used to locate
235 the beginnings of sections from each ".o" file that was linked to
236 form the executable objfile. We gather any such info and record it
237 in data structures hung off the objfile's private data.
242 elf_symtab_read (abfd, addr, objfile)
245 struct objfile *objfile;
247 unsigned int storage_needed;
249 asymbol **symbol_table;
250 unsigned int number_of_symbols;
253 struct cleanup *back_to;
255 enum minimal_symbol_type ms_type;
256 /* If sectinfo is nonNULL, it contains section info that should end up
257 filed in the objfile. */
258 struct stab_section_info *sectinfo = NULL;
259 /* If filesym is nonzero, it points to a file symbol, but we haven't
260 seen any section info for it yet. */
261 asymbol *filesym = 0;
262 struct dbx_symfile_info *dbx = (struct dbx_symfile_info *)
263 objfile->sym_stab_info;
266 storage_needed = get_symtab_upper_bound (abfd);
267 if (storage_needed > 0)
269 symbol_table = (asymbol **) xmalloc (storage_needed);
270 back_to = make_cleanup (free, symbol_table);
271 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
272 for (i = 0; i < number_of_symbols; i++)
274 sym = symbol_table[i];
275 if (sym -> name == NULL || *sym -> name == '\0')
277 /* Skip names that don't exist (shouldn't happen), or names
278 that are null strings (may happen). */
281 if (sym -> flags & BSF_FILE)
283 /* STT_FILE debugging symbol that helps stabs-in-elf debugging.
284 Chain any old one onto the objfile; remember new sym. */
285 if (sectinfo != NULL)
287 sectinfo -> next = dbx -> stab_section_info;
288 dbx -> stab_section_info = sectinfo;
293 else if (sym -> flags & (BSF_GLOBAL | BSF_LOCAL | BSF_WEAK))
295 /* Select global/local/weak symbols. Note that bfd puts abs
296 symbols in their own section, so all symbols we are
297 interested in will have a section. */
298 /* Bfd symbols are section relative. */
299 symaddr = sym -> value + sym -> section -> vma;
300 /* Relocate all non-absolute symbols by base address. */
301 if (sym -> section != &bfd_abs_section)
305 /* For non-absolute symbols, use the type of the section
306 they are relative to, to intuit text/data. Bfd provides
307 no way of figuring this out for absolute symbols. */
308 if (sym -> section == &bfd_abs_section)
312 else if (sym -> section -> flags & SEC_CODE)
314 if (sym -> flags & BSF_GLOBAL)
318 else if (sym->name[0] == '.' && sym->name[1] == 'L')
319 /* Looks like a compiler-generated label. Skip it.
320 The assembler should be skipping these (to keep
321 executables small), but apparently with gcc on the
322 delta m88k SVR4, it loses. So to have us check too
323 should be harmless (but I encourage people to fix this
324 in the assembler instead of adding checks here). */
328 ms_type = mst_file_text;
331 else if (sym -> section -> flags & SEC_ALLOC)
333 if (sym -> flags & BSF_GLOBAL)
335 if (sym -> section -> flags & SEC_LOAD)
344 else if (sym -> flags & BSF_LOCAL)
346 /* Named Local variable in a Data section. Check its
347 name for stabs-in-elf. The STREQ macro checks the
348 first character inline, so we only actually do a
349 strcmp function call on names that start with 'B'
351 index = SECT_OFF_MAX;
352 if (STREQ ("Bbss.bss", sym -> name))
354 index = SECT_OFF_BSS;
356 else if (STREQ ("Ddata.data", sym -> name))
358 index = SECT_OFF_DATA;
360 else if (STREQ ("Drodata.rodata", sym -> name))
362 index = SECT_OFF_RODATA;
364 if (index != SECT_OFF_MAX)
366 /* Found a special local symbol. Allocate a
367 sectinfo, if needed, and fill it in. */
368 if (sectinfo == NULL)
370 sectinfo = (struct stab_section_info *)
371 xmmalloc (objfile -> md, sizeof (*sectinfo));
372 memset ((PTR) sectinfo, 0, sizeof (*sectinfo));
375 complain (§ion_info_complaint,
380 sectinfo -> filename =
381 (char *) filesym -> name;
384 if (sectinfo -> sections[index] != 0)
386 complain (§ion_info_dup_complaint,
387 sectinfo -> filename);
389 /* Bfd symbols are section relative. */
390 symaddr = sym -> value + sym -> section -> vma;
391 /* Relocate non-absolute symbols by base address. */
392 if (sym -> section != &bfd_abs_section)
396 sectinfo -> sections[index] = symaddr;
397 /* The special local symbols don't go in the
398 minimal symbol table, so ignore this one. */
401 /* Not a special stabs-in-elf symbol, do regular
402 symbol processing. */
403 if (sym -> section -> flags & SEC_LOAD)
405 ms_type = mst_file_data;
409 ms_type = mst_file_bss;
414 ms_type = mst_unknown;
419 /* FIXME: Solaris2 shared libraries include lots of
420 odd "absolute" and "undefined" symbols, that play
421 hob with actions like finding what function the PC
422 is in. Ignore them if they aren't text, data, or bss. */
423 /* ms_type = mst_unknown; */
424 continue; /* Skip this symbol. */
426 /* Pass symbol size field in via BFD. FIXME!!! */
427 size = ((elf_symbol_type *) sym) -> internal_elf_sym.st_size;
428 record_minimal_symbol_and_info ((char *) sym -> name, symaddr,
429 ms_type, (PTR) size, objfile);
432 do_cleanups (back_to);
436 /* Scan and build partial symbols for a symbol file.
437 We have been initialized by a call to elf_symfile_init, which
438 currently does nothing.
440 SECTION_OFFSETS is a set of offsets to apply to relocate the symbols
441 in each section. We simplify it down to a single offset for all
444 MAINLINE is true if we are reading the main symbol
445 table (as opposed to a shared lib or dynamically loaded file).
447 This function only does the minimum work necessary for letting the
448 user "name" things symbolically; it does not read the entire symtab.
449 Instead, it reads the external and static symbols and puts them in partial
450 symbol tables. When more extensive information is requested of a
451 file, the corresponding partial symbol table is mutated into a full
452 fledged symbol table by going back and reading the symbols
455 We look for sections with specific names, to tell us what debug
456 format to look for: FIXME!!!
458 dwarf_build_psymtabs() builds psymtabs for DWARF symbols;
459 elfstab_build_psymtabs() handles STABS symbols;
460 mdebug_build_psymtabs() handles ECOFF debugging information.
462 Note that ELF files have a "minimal" symbol table, which looks a lot
463 like a COFF symbol table, but has only the minimal information necessary
464 for linking. We process this also, and use the information to
465 build gdb's minimal symbol table. This gives us some minimal debugging
466 capability even for files compiled without -g. */
469 elf_symfile_read (objfile, section_offsets, mainline)
470 struct objfile *objfile;
471 struct section_offsets *section_offsets;
474 bfd *abfd = objfile->obfd;
476 struct cleanup *back_to;
479 init_minimal_symbol_collection ();
480 back_to = make_cleanup (discard_minimal_symbols, 0);
482 memset ((char *) &ei, 0, sizeof (ei));
484 /* Allocate struct to keep track of the symfile */
485 objfile->sym_stab_info = (PTR)
486 xmmalloc (objfile -> md, sizeof (struct dbx_symfile_info));
487 memset ((char *) objfile->sym_stab_info, 0, sizeof (struct dbx_symfile_info));
488 make_cleanup (free_elfinfo, (PTR) objfile);
490 /* Process the normal ELF symbol table first. This may write some
491 chain of info into the dbx_symfile_info in objfile->sym_stab_info,
492 which can later be used by elfstab_offset_sections. */
494 /* FIXME, should take a section_offsets param, not just an offset. */
495 offset = ANOFFSET (section_offsets, 0);
496 elf_symtab_read (abfd, offset, objfile);
498 /* Now process debugging information, which is contained in
499 special ELF sections. We first have to find them... */
501 bfd_map_over_sections (abfd, elf_locate_sections, (PTR) &ei);
502 if (ei.dboffset && ei.lnoffset)
505 dwarf_build_psymtabs (objfile,
506 section_offsets, mainline,
507 ei.dboffset, ei.dbsize,
508 ei.lnoffset, ei.lnsize);
514 /* FIXME: Sun didn't really know how to implement this well.
515 They made .stab sections that don't point to the .stabstr
516 section with the sh_link field. BFD doesn't make string table
517 sections visible to the caller. So we have to search the
518 ELF section table, not the BFD section table, for the string
520 struct elf32_internal_shdr *elf_sect;
522 elf_sect = bfd_elf_find_section (abfd, ".stabstr");
524 elfstab_build_psymtabs (objfile,
527 ei.stabsect->filepos, /* .stab offset */
528 bfd_get_section_size_before_reloc (ei.stabsect),/* .stab size */
529 (file_ptr) elf_sect->sh_offset, /* .stabstr offset */
530 elf_sect->sh_size); /* .stabstr size */
534 const struct ecoff_debug_swap *swap;
536 /* .mdebug section, presumably holding ECOFF debugging
538 swap = get_elf_backend_data (abfd)->elf_backend_ecoff_debug_swap;
540 elfmdebug_build_psymtabs (objfile, swap, ei.mdebugsect,
544 if (!have_partial_symbols ())
547 printf_filtered ("(no debugging symbols found)...");
551 /* Install any minimal symbols that have been collected as the current
552 minimal symbols for this objfile. */
554 install_minimal_symbols (objfile);
556 do_cleanups (back_to);
559 /* This cleans up the objfile's sym_stab_info pointer, and the chain of
560 stab_section_info's, that might be dangling from it. */
566 struct objfile *objfile = (struct objfile *)objp;
567 struct dbx_symfile_info *dbxinfo = (struct dbx_symfile_info *)
568 objfile->sym_stab_info;
569 struct stab_section_info *ssi, *nssi;
571 ssi = dbxinfo->stab_section_info;
575 mfree (objfile->md, ssi);
579 dbxinfo->stab_section_info = 0; /* Just say No mo info about this. */
583 /* Initialize anything that needs initializing when a completely new symbol
584 file is specified (not just adding some symbols from another file, e.g. a
587 We reinitialize buildsym, since we may be reading stabs from an ELF file. */
590 elf_new_init (ignore)
591 struct objfile *ignore;
593 stabsread_new_init ();
594 buildsym_new_init ();
597 /* Perform any local cleanups required when we are done with a particular
598 objfile. I.E, we are in the process of discarding all symbol information
599 for an objfile, freeing up all memory held for it, and unlinking the
600 objfile struct from the global list of known objfiles. */
603 elf_symfile_finish (objfile)
604 struct objfile *objfile;
606 if (objfile -> sym_stab_info != NULL)
608 mfree (objfile -> md, objfile -> sym_stab_info);
612 /* ELF specific initialization routine for reading symbols.
614 It is passed a pointer to a struct sym_fns which contains, among other
615 things, the BFD for the file whose symbols are being read, and a slot for
616 a pointer to "private data" which we can fill with goodies.
618 For now at least, we have nothing in particular to do, so this function is
622 elf_symfile_init (ignore)
623 struct objfile *ignore;
627 /* ELF specific parsing routine for section offsets.
629 Plain and simple for now. */
632 struct section_offsets *
633 elf_symfile_offsets (objfile, addr)
634 struct objfile *objfile;
637 struct section_offsets *section_offsets;
640 objfile->num_sections = SECT_OFF_MAX;
641 section_offsets = (struct section_offsets *)
642 obstack_alloc (&objfile -> psymbol_obstack,
643 sizeof (struct section_offsets)
644 + sizeof (section_offsets->offsets) * (SECT_OFF_MAX-1));
646 for (i = 0; i < SECT_OFF_MAX; i++)
647 ANOFFSET (section_offsets, i) = addr;
649 return section_offsets;
652 /* When handling an ELF file that contains Sun STABS debug info,
653 some of the debug info is relative to the particular chunk of the
654 section that was generated in its individual .o file. E.g.
655 offsets to static variables are relative to the start of the data
656 segment *for that module before linking*. This information is
657 painfully squirreled away in the ELF symbol table as local symbols
658 with wierd names. Go get 'em when needed. */
661 elfstab_offset_sections (objfile, pst)
662 struct objfile *objfile;
663 struct partial_symtab *pst;
665 char *filename = pst->filename;
666 struct dbx_symfile_info *dbx = (struct dbx_symfile_info *)
667 objfile->sym_stab_info;
668 struct stab_section_info *maybe = dbx->stab_section_info;
669 struct stab_section_info *questionable = 0;
673 /* The ELF symbol info doesn't include path names, so strip the path
674 (if any) from the psymtab filename. */
675 while (0 != (p = strchr (filename, '/')))
678 /* FIXME: This linear search could speed up significantly
679 if it was chained in the right order to match how we search it,
680 and if we unchained when we found a match. */
681 for (; maybe; maybe = maybe->next)
683 if (filename[0] == maybe->filename[0]
684 && STREQ (filename, maybe->filename))
686 /* We found a match. But there might be several source files
687 (from different directories) with the same name. */
688 if (0 == maybe->found)
690 questionable = maybe; /* Might use it later. */
694 if (maybe == 0 && questionable != 0)
696 complain (&stab_info_questionable_complaint, filename);
697 maybe = questionable;
702 /* Found it! Allocate a new psymtab struct, and fill it in. */
704 pst->section_offsets = (struct section_offsets *)
705 obstack_alloc (&objfile -> psymbol_obstack,
706 sizeof (struct section_offsets) +
707 sizeof (pst->section_offsets->offsets) * (SECT_OFF_MAX-1));
709 for (i = 0; i < SECT_OFF_MAX; i++)
710 ANOFFSET (pst->section_offsets, i) = maybe->sections[i];
714 /* We were unable to find any offsets for this file. Complain. */
715 if (dbx->stab_section_info) /* If there *is* any info, */
716 complain (&stab_info_mismatch_complaint, filename);
719 /* Register that we are able to handle ELF object file formats. */
721 static struct sym_fns elf_sym_fns =
723 bfd_target_elf_flavour,
724 elf_new_init, /* sym_new_init: init anything gbl to entire symtab */
725 elf_symfile_init, /* sym_init: read initial info, setup for sym_read() */
726 elf_symfile_read, /* sym_read: read a symbol file into symtab */
727 elf_symfile_finish, /* sym_finish: finished with file, cleanup */
728 elf_symfile_offsets, /* sym_offsets: Translate ext. to int. relocation */
729 NULL /* next: pointer to next struct sym_fns */
733 _initialize_elfread ()
735 add_symtab_fns (&elf_sym_fns);