gold/readsyms.h

   1 // readsyms.h -- read input file symbols for gold   -*- C++ -*-
   2
   3 // Copyright 2006, 2007, 2008 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_READSYMS_H
  24 #define GOLD_READSYMS_H
  25
  26 #include <vector>
  27
  28 #include "workqueue.h"
  29 #include "object.h"
  30
  31 namespace gold
  32 {
  33
  34 class Input_objects;
  35 class Symbol_table;
  36 class Input_group;
  37 class Archive;
  38
  39 // This Task is responsible for reading the symbols from an input
  40 // file.  This also includes reading the relocations so that we can
  41 // check for any that require a PLT and/or a GOT.  After the data has
  42 // been read, this queues up another task to actually add the symbols
  43 // to the symbol table.  The tasks are separated because the file
  44 // reading can occur in parallel but adding the symbols must be done
  45 // in the order of the input files.
  46
  47 class Read_symbols : public Task
  48 {
  49  public:
  50   // DIRPATH is the list of directories to search for libraries.
  51   // INPUT is the file to read.  INPUT_GROUP is not NULL if we are in
  52   // the middle of an input group.  THIS_BLOCKER is used to prevent
  53   // the associated Add_symbols task from running before the previous
  54   // one has completed; it will be NULL for the first task.
  55   // NEXT_BLOCKER is used to block the next input file from adding
  56   // symbols.
  57   Read_symbols(const General_options& options, Input_objects* input_objects,
  58                Symbol_table* symtab, Layout* layout, Dirsearch* dirpath,
  59                Mapfile* mapfile, const Input_argument* input_argument,
  60                Input_group* input_group, Task_token* this_blocker,
  61                Task_token* next_blocker)
  62     : options_(options), input_objects_(input_objects), symtab_(symtab),
  63       layout_(layout), dirpath_(dirpath), mapfile_(mapfile),
  64       input_argument_(input_argument), input_group_(input_group),
  65       this_blocker_(this_blocker), next_blocker_(next_blocker)
  66   { }
  67
  68   ~Read_symbols();
  69
  70   // The standard Task methods.
  71
  72   Task_token*
  73   is_runnable();
  74
  75   void
  76   locks(Task_locker*);
  77
  78   void
  79   run(Workqueue*);
  80
  81   std::string
  82   get_name() const;
  83
  84  private:
  85   // Handle an archive group.
  86   void
  87   do_group(Workqueue*);
  88
  89   // Open and identify the file.
  90   bool
  91   do_read_symbols(Workqueue*);
  92
  93   const General_options& options_;
  94   Input_objects* input_objects_;
  95   Symbol_table* symtab_;
  96   Layout* layout_;
  97   Dirsearch* dirpath_;
  98   Mapfile* mapfile_;
  99   const Input_argument* input_argument_;
 100   Input_group* input_group_;
 101   Task_token* this_blocker_;
 102   Task_token* next_blocker_;
 103 };
 104
 105 // This Task handles adding the symbols to the symbol table.  These
 106 // tasks must be run in the same order as the arguments appear on the
 107 // command line.
 108
 109 class Add_symbols : public Task
 110 {
 111  public:
 112   // THIS_BLOCKER is used to prevent this task from running before the
 113   // one for the previous input file.  NEXT_BLOCKER is used to prevent
 114   // the next task from running.
 115   Add_symbols(Input_objects* input_objects, Symbol_table* symtab,
 116               Layout* layout, Object* object,
 117               Read_symbols_data* sd, Task_token* this_blocker,
 118               Task_token* next_blocker)
 119     : input_objects_(input_objects), symtab_(symtab), layout_(layout),
 120       object_(object), sd_(sd), this_blocker_(this_blocker),
 121       next_blocker_(next_blocker)
 122   { }
 123
 124   ~Add_symbols();
 125
 126   // The standard Task methods.
 127
 128   Task_token*
 129   is_runnable();
 130
 131   void
 132   locks(Task_locker*);
 133
 134   void
 135   run(Workqueue*);
 136
 137   std::string
 138   get_name() const
 139   { return "Add_symbols " + this->object_->name(); }
 140
 141 private:
 142   Input_objects* input_objects_;
 143   Symbol_table* symtab_;
 144   Layout* layout_;
 145   Object* object_;
 146   Read_symbols_data* sd_;
 147   Task_token* this_blocker_;
 148   Task_token* next_blocker_;
 149 };
 150
 151 // This class is used to track the archives in a group.
 152
 153 class Input_group
 154 {
 155  public:
 156   typedef std::vector<Archive*> Archives;
 157   typedef Archives::const_iterator const_iterator;
 158
 159   Input_group()
 160     : archives_()
 161   { }
 162
 163   // Add an archive to the group.
 164   void
 165   add_archive(Archive* arch)
 166   { this->archives_.push_back(arch); }
 167
 168   // Loop over the archives in the group.
 169
 170   const_iterator
 171   begin() const
 172   { return this->archives_.begin(); }
 173
 174   const_iterator
 175   end() const
 176   { return this->archives_.end(); }
 177
 178  private:
 179   Archives archives_;
 180 };
 181
 182 // This class is used to finish up handling a group.  It is just a
 183 // closure.
 184
 185 class Finish_group : public Task
 186 {
 187  public:
 188   Finish_group(Input_objects* input_objects, Symbol_table* symtab,
 189                Layout* layout, Mapfile* mapfile, Input_group* input_group,
 190                int saw_undefined, Task_token* this_blocker,
 191                Task_token* next_blocker)
 192     : input_objects_(input_objects), symtab_(symtab),
 193       layout_(layout), mapfile_(mapfile), input_group_(input_group),
 194       saw_undefined_(saw_undefined), this_blocker_(this_blocker),
 195       next_blocker_(next_blocker)
 196   { }
 197
 198   ~Finish_group();
 199
 200   // The standard Task methods.
 201
 202   Task_token*
 203   is_runnable();
 204
 205   void
 206   locks(Task_locker*);
 207
 208   void
 209   run(Workqueue*);
 210
 211   std::string
 212   get_name() const
 213   { return "Finish_group"; }
 214
 215  private:
 216   Input_objects* input_objects_;
 217   Symbol_table* symtab_;
 218   Layout* layout_;
 219   Mapfile* mapfile_;
 220   Input_group* input_group_;
 221   int saw_undefined_;
 222   Task_token* this_blocker_;
 223   Task_token* next_blocker_;
 224 };
 225
 226 // This class is used to read a file which was not recognized as an
 227 // object or archive.  It tries to read it as a linker script, using
 228 // the tokens to serialize with the calls to Add_symbols.
 229
 230 class Read_script : public Task
 231 {
 232  public:
 233   Read_script(const General_options& options, Symbol_table* symtab,
 234               Layout* layout, Dirsearch* dirpath, Input_objects* input_objects,
 235               Mapfile* mapfile, Input_group* input_group,
 236               const Input_argument* input_argument,
 237               Input_file* input_file, Task_token* this_blocker,
 238               Task_token* next_blocker)
 239     : options_(options), symtab_(symtab), layout_(layout), dirpath_(dirpath),
 240       input_objects_(input_objects), mapfile_(mapfile),
 241       input_group_(input_group), input_argument_(input_argument),
 242       input_file_(input_file), this_blocker_(this_blocker),
 243       next_blocker_(next_blocker)
 244   { }
 245
 246   ~Read_script();
 247
 248   // The standard Task methods.
 249
 250   Task_token*
 251   is_runnable();
 252
 253   void
 254   locks(Task_locker*);
 255
 256   void
 257   run(Workqueue*);
 258
 259   std::string
 260   get_name() const;
 261
 262  private:
 263   const General_options& options_;
 264   Symbol_table* symtab_;
 265   Layout* layout_;
 266   Dirsearch* dirpath_;
 267   Input_objects* input_objects_;
 268   Mapfile* mapfile_;
 269   Input_group* input_group_;
 270   const Input_argument* input_argument_;
 271   Input_file* input_file_;
 272   Task_token* this_blocker_;
 273   Task_token* next_blocker_;
 274 };
 275
 276 } // end namespace gold
 277
 278 #endif // !defined(GOLD_READSYMS_H)