gold/dwarf_reader.h

   1 // dwarf_reader.h -- parse dwarf2/3 debug information for gold  -*- C++ -*-
   2
   3 // Copyright 2007 Free Software Foundation, Inc.
   4 // Written by Ian Lance Taylor <iant@google.com>.
   5
   6 // This file is part of gold.
   7
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 3 of the License, or
  11 // (at your option) any later version.
  12
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
  21 // MA 02110-1301, USA.
  22
  23 #ifndef GOLD_DWARF_READER_H
  24 #define GOLD_DWARF_READER_H
  25
  26 #include <vector>
  27 #include <map>
  28
  29 #include "elfcpp.h"
  30 #include "elfcpp_swap.h"
  31 #include "dwarf.h"
  32 #include "reloc.h"
  33
  34 namespace gold
  35 {
  36
  37 template<int size, bool big_endian>
  38 class Track_relocs;
  39 struct LineStateMachine;
  40
  41 // This class is used to read the line information from the debugging
  42 // section of an object file.
  43
  44 class Dwarf_line_info
  45 {
  46  public:
  47   Dwarf_line_info()
  48   { }
  49
  50   virtual
  51   ~Dwarf_line_info()
  52   { }
  53
  54   // Given a section number and an offset, returns the associated
  55   // file and line-number, as a string: "file:lineno".  If unable
  56   // to do the mapping, returns the empty string.  You must call
  57   // read_line_mappings() before calling this function.
  58   std::string
  59   addr2line(unsigned int shndx, off_t offset)
  60   { return do_addr2line(shndx, offset); }
  61
  62   // A helper function for a single addr2line lookup.  It uses
  63   // parameters() to figure out the size and endianness.  This is less
  64   // efficient than using the templatized size and endianness, so only
  65   // call this from an un-templatized context.
  66   static std::string
  67   one_addr2line(Object* object, unsigned int shndx, off_t offset);
  68
  69  private:
  70   virtual std::string
  71   do_addr2line(unsigned int shndx, off_t offset) = 0;
  72 };
  73
  74 template<int size, bool big_endian>
  75 class Sized_dwarf_line_info
  76 {
  77  public:
  78   // Initializes a .debug_line reader for a given object file.
  79   Sized_dwarf_line_info(Object* object);
  80
  81   std::string
  82   addr2line(unsigned int shndx, off_t offset)
  83   { return do_addr2line(shndx, offset); }
  84
  85  private:
  86   std::string
  87   do_addr2line(unsigned int shndx, off_t offset);
  88
  89   // Start processing line info, and populates the offset_map_.
  90   void
  91   read_line_mappings();
  92
  93   // Reads the relocation section associated with .debug_line and
  94   // stores relocation information in reloc_map_.
  95   void
  96   read_relocs();
  97
  98   // Looks in the symtab to see what section a symbol is in.
  99   unsigned int
 100   symbol_section(unsigned int sym,
 101                  typename elfcpp::Elf_types<size>::Elf_Addr* value);
 102
 103   // Reads the DWARF2/3 header for this line info.  Each takes as input
 104   // a starting buffer position, and returns the ending position.
 105   const unsigned char*
 106   read_header_prolog(const unsigned char* lineptr);
 107
 108   const unsigned char*
 109   read_header_tables(const unsigned char* lineptr);
 110
 111   // Reads the DWARF2/3 line information.
 112   const unsigned char*
 113   read_lines(const unsigned char* lineptr);
 114
 115   // Process a single line info opcode at START using the state
 116   // machine at LSM.  Return true if we should define a line using the
 117   // current state of the line state machine.  Place the length of the
 118   // opcode in LEN.
 119   bool
 120   process_one_opcode(const unsigned char* start,
 121                      struct LineStateMachine* lsm, size_t* len);
 122
 123   // Some parts of processing differ depending on whether the input
 124   // was a .o file or not.
 125   bool input_is_relobj();
 126
 127   // If we saw anything amiss while parsing, we set this to false.
 128   // Then addr2line will always fail (rather than return possibly-
 129   // corrupt data).
 130   bool data_valid_;
 131
 132   // A DWARF2/3 line info header.  This is not the same size as in the
 133   // actual file, as the one in the file may have a 32 bit or 64 bit
 134   // lengths.
 135
 136   struct Dwarf_line_infoHeader
 137   {
 138     off_t total_length;
 139     int version;
 140     off_t prologue_length;
 141     int min_insn_length; // insn stands for instructin
 142     bool default_is_stmt; // stmt stands for statement
 143     signed char line_base;
 144     int line_range;
 145     unsigned char opcode_base;
 146     std::vector<unsigned char> std_opcode_lengths;
 147     int offset_size;
 148   } header_;
 149
 150   // buffer is the buffer for our line info, starting at exactly where
 151   // the line info to read is.
 152   const unsigned char* buffer_;
 153   const unsigned char* buffer_end_;
 154
 155   // This has relocations that point into buffer.
 156   Track_relocs<size, big_endian> track_relocs_;
 157
 158   // This is used to figure out what section to apply a relocation to.
 159   const unsigned char* symtab_buffer_;
 160   off_t symtab_buffer_size_;
 161
 162   // Holds the directories and files as we see them.  We have an array
 163   // of directory-lists, one for each .o file we're reading (usually
 164   // there will just be one, but there may be more if input is a .so).
 165   std::vector<std::vector<std::string> > directories_;
 166   // The first part is an index into directories_, the second the filename.
 167   std::vector<std::vector< std::pair<int, std::string> > > files_;
 168
 169   // An index into the current directories_ and files_ vectors.
 170   int current_header_index_;
 171
 172   // A sorted map from offset of the relocation target to the shndx
 173   // and addend for the relocation.
 174   typedef std::map<typename elfcpp::Elf_types<size>::Elf_Addr,
 175                    std::pair<unsigned int,
 176                              typename elfcpp::Elf_types<size>::Elf_Swxword> >
 177   Reloc_map;
 178   Reloc_map reloc_map_;
 179
 180   // We can't do better than to keep the offsets in a sorted vector.
 181   // Here, offset is the key, and file_num/line_num is the value.
 182   struct Offset_to_lineno_entry
 183   {
 184     off_t offset;
 185     int header_num;  // which file-list to use (i.e. which .o file are we in)
 186     int file_num;    // a pointer into files_
 187     int line_num;    // the line number in the source file
 188     // Offsets are unique within a section, so that's a sufficient sort key.
 189     bool operator<(const Offset_to_lineno_entry& that) const
 190     { return this->offset < that.offset; }
 191   };
 192   // We have a vector of offset->lineno entries for every input section.
 193   typedef Unordered_map<unsigned int, std::vector<Offset_to_lineno_entry> >
 194   Lineno_map;
 195
 196   Lineno_map line_number_map_;
 197 };
 198
 199 } // End namespace gold.
 200
 201 #endif // !defined(GOLD_DWARF_READER_H)