gold/gc.h

   1 // gc.h -- garbage collection of unused sections
   2
   3 // Copyright 2009, 2010 Free Software Foundation, Inc.
   4 // Written by Sriraman Tallam <tmsriram@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_GC_H
  24 #define GOLD_GC_H
  25
  26 #include <queue>
  27 #include <vector>
  28
  29 #include "elfcpp.h"
  30 #include "symtab.h"
  31 #include "icf.h"
  32
  33 namespace gold
  34 {
  35
  36 class Object;
  37
  38 template<int size, bool big_endian>
  39 class Sized_relobj;
  40
  41 template<int sh_type, int size, bool big_endian>
  42 class Reloc_types;
  43
  44 class Output_section;
  45 class General_options;
  46 class Layout;
  47
  48 typedef std::pair<Object *, unsigned int> Section_id;
  49
  50 class Garbage_collection
  51 {
  52   struct Section_id_hash
  53   {
  54     size_t operator()(const Section_id& loc) const
  55     { return reinterpret_cast<uintptr_t>(loc.first) ^ loc.second; }
  56   };
  57
  58  public:
  59
  60   typedef Unordered_set<Section_id, Section_id_hash> Sections_reachable;
  61   typedef std::map<Section_id, Sections_reachable> Section_ref;
  62   typedef std::queue<Section_id> Worklist_type;
  63
  64   Garbage_collection()
  65   : is_worklist_ready_(false)
  66   { }
  67
  68   // Accessor methods for the private members.
  69
  70   Sections_reachable&
  71   referenced_list()
  72   { return referenced_list_; }
  73
  74   Section_ref&
  75   section_reloc_map()
  76   { return this->section_reloc_map_; }
  77
  78   Worklist_type&
  79   worklist()
  80   { return this->work_list_; }
  81
  82   bool
  83   is_worklist_ready()
  84   { return this->is_worklist_ready_; }
  85
  86   void
  87   worklist_ready()
  88   { this->is_worklist_ready_ = true; }
  89
  90   void
  91   do_transitive_closure();
  92
  93   bool
  94   is_section_garbage(Object* obj, unsigned int shndx)
  95   { return (this->referenced_list().find(Section_id(obj, shndx))
  96             == this->referenced_list().end()); }
  97  private:
  98
  99   Worklist_type work_list_;
 100   bool is_worklist_ready_;
 101   Section_ref section_reloc_map_;
 102   Sections_reachable referenced_list_;
 103 };
 104
 105 // Data to pass between successive invocations of do_layout
 106 // in object.cc while garbage collecting.  This data structure
 107 // is filled by using the data from Read_symbols_data.
 108
 109 struct Symbols_data
 110 {
 111   // Section headers.
 112   unsigned char* section_headers_data;
 113   // Section names.
 114   unsigned char* section_names_data;
 115   // Size of section name data in bytes.
 116   section_size_type section_names_size;
 117   // Symbol data.
 118   unsigned char* symbols_data;
 119   // Size of symbol data in bytes.
 120   section_size_type symbols_size;
 121   // Offset of external symbols within symbol data.  This structure
 122   // sometimes contains only external symbols, in which case this will
 123   // be zero.  Sometimes it contains all symbols.
 124   section_offset_type external_symbols_offset;
 125   // Symbol names.
 126   unsigned char* symbol_names_data;
 127   // Size of symbol name data in bytes.
 128   section_size_type symbol_names_size;
 129 };
 130
 131 // This function implements the generic part of reloc
 132 // processing to map a section to all the sections it
 133 // references through relocs.  It is called only during
 134 // garbage collection (--gc-sections) and identical code
 135 // folding (--icf).
 136
 137 template<int size, bool big_endian, typename Target_type, int sh_type,
 138          typename Scan>
 139 inline void
 140 gc_process_relocs(
 141     Symbol_table* symtab,
 142     Layout*,
 143     Target_type* ,
 144     Sized_relobj<size, big_endian>* src_obj,
 145     unsigned int src_indx,
 146     const unsigned char* prelocs,
 147     size_t reloc_count,
 148     Output_section*,
 149     bool ,
 150     size_t local_count,
 151     const unsigned char* plocal_syms)
 152 {
 153   Object *dst_obj;
 154   unsigned int dst_indx;
 155
 156   typedef typename Reloc_types<sh_type, size, big_endian>::Reloc Reltype;
 157   const int reloc_size = Reloc_types<sh_type, size, big_endian>::reloc_size;
 158   const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
 159
 160   std::vector<Section_id>* secvec = NULL;
 161   std::vector<Symbol*>* symvec = NULL;
 162   std::vector<std::pair<long long, long long> >* addendvec = NULL;
 163   bool is_icf_tracked = false;
 164
 165   if (parameters->options().icf_enabled()
 166       && is_section_foldable_candidate(src_obj->section_name(src_indx).c_str()))
 167     {
 168       is_icf_tracked = true;
 169       Section_id src_id(src_obj, src_indx);
 170       secvec = &symtab->icf()->section_reloc_list()[src_id];
 171       symvec = &symtab->icf()->symbol_reloc_list()[src_id];
 172       addendvec = &symtab->icf()->addend_reloc_list()[src_id];
 173     }
 174
 175   for (size_t i = 0; i < reloc_count; ++i, prelocs += reloc_size)
 176     {
 177       Reltype reloc(prelocs);
 178       typename elfcpp::Elf_types<size>::Elf_WXword r_info = reloc.get_r_info();
 179       unsigned int r_sym = elfcpp::elf_r_sym<size>(r_info);
 180       typename elfcpp::Elf_types<size>::Elf_Swxword addend =
 181       Reloc_types<sh_type, size, big_endian>::get_reloc_addend_noerror(&reloc);
 182
 183       if (r_sym < local_count)
 184         {
 185           gold_assert(plocal_syms != NULL);
 186           typename elfcpp::Sym<size, big_endian> lsym(plocal_syms
 187                                                       + r_sym * sym_size);
 188           unsigned int shndx = lsym.get_st_shndx();
 189           bool is_ordinary;
 190           shndx = src_obj->adjust_sym_shndx(r_sym, shndx, &is_ordinary);
 191           if (!is_ordinary)
 192             continue;
 193           dst_obj = src_obj;
 194           dst_indx = shndx;
 195           Section_id dst_id(dst_obj, dst_indx);
 196           if (is_icf_tracked)
 197             {
 198               (*secvec).push_back(dst_id);
 199               (*symvec).push_back(NULL);
 200               long long symvalue = static_cast<long long>(lsym.get_st_value());
 201               (*addendvec).push_back(std::make_pair(symvalue,
 202                                               static_cast<long long>(addend)));
 203             }
 204           if (shndx == src_indx)
 205             continue;
 206         }
 207       else
 208         {
 209           Symbol* gsym = src_obj->global_symbol(r_sym);
 210           gold_assert(gsym != NULL);
 211           if (gsym->is_forwarder())
 212             gsym = symtab->resolve_forwards(gsym);
 213           if (gsym->source() != Symbol::FROM_OBJECT)
 214             continue;
 215           bool is_ordinary;
 216           dst_obj = gsym->object();
 217           dst_indx = gsym->shndx(&is_ordinary);
 218           if (!is_ordinary)
 219             continue;
 220           Section_id dst_id(dst_obj, dst_indx);
 221           if (is_icf_tracked)
 222             {
 223               (*secvec).push_back(dst_id);
 224               (*symvec).push_back(gsym);
 225               Sized_symbol<size>* sized_gsym =
 226                         static_cast<Sized_symbol<size>* >(gsym);
 227               long long symvalue =
 228                         static_cast<long long>(sized_gsym->value());
 229               (*addendvec).push_back(std::make_pair(symvalue,
 230                                         static_cast<long long>(addend)));
 231             }
 232         }
 233       if (parameters->options().gc_sections())
 234         {
 235           Section_id src_id(src_obj, src_indx);
 236           Section_id dst_id(dst_obj, dst_indx);
 237           Garbage_collection::Section_ref::iterator map_it;
 238           map_it = symtab->gc()->section_reloc_map().find(src_id);
 239           if (map_it == symtab->gc()->section_reloc_map().end())
 240             {
 241               symtab->gc()->section_reloc_map()[src_id].insert(dst_id);
 242             }
 243           else
 244             {
 245               Garbage_collection::Sections_reachable& v(map_it->second);
 246               v.insert(dst_id);
 247             }
 248         }
 249     }
 250   return;
 251 }
 252
 253 } // End of namespace gold.
 254
 255 #endif