gold/readsyms.cc

   1 // readsyms.cc -- read input file symbols for gold
   2
   3 // Copyright 2006, 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 #include "gold.h"
  24
  25 #include <cstring>
  26
  27 #include "elfcpp.h"
  28 #include "options.h"
  29 #include "dirsearch.h"
  30 #include "symtab.h"
  31 #include "object.h"
  32 #include "archive.h"
  33 #include "script.h"
  34 #include "readsyms.h"
  35
  36 namespace gold
  37 {
  38
  39 // If we fail to open the object, then we won't create an Add_symbols
  40 // task.  However, we still need to unblock the token, or else the
  41 // link won't proceed to generate more error messages.  We can only
  42 // unblock tokens when the workqueue lock is held, so we need a dummy
  43 // task to do that.  The dummy task has to maintain the right sequence
  44 // of blocks, so we need both this_blocker and next_blocker.
  45
  46 class Unblock_token : public Task
  47 {
  48  public:
  49   Unblock_token(Task_token* this_blocker, Task_token* next_blocker)
  50     : this_blocker_(this_blocker), next_blocker_(next_blocker)
  51   { }
  52
  53   ~Unblock_token()
  54   {
  55     if (this->this_blocker_ != NULL)
  56       delete this->this_blocker_;
  57   }
  58
  59   Task_token*
  60   is_runnable()
  61   {
  62     if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
  63       return this->this_blocker_;
  64     return NULL;
  65   }
  66
  67   void
  68   locks(Task_locker* tl)
  69   { tl->add(this, this->next_blocker_); }
  70
  71   void
  72   run(Workqueue*)
  73   { }
  74
  75   std::string
  76   get_name() const
  77   { return "Unblock_token"; }
  78
  79  private:
  80   Task_token* this_blocker_;
  81   Task_token* next_blocker_;
  82 };
  83
  84 // Class read_symbols.
  85
  86 Read_symbols::~Read_symbols()
  87 {
  88   // The this_blocker_ and next_blocker_ pointers are passed on to the
  89   // Add_symbols task.
  90 }
  91
  92 // Return whether a Read_symbols task is runnable.  We can read an
  93 // ordinary input file immediately.  For an archive specified using
  94 // -l, we have to wait until the search path is complete.
  95
  96 Task_token*
  97 Read_symbols::is_runnable()
  98 {
  99   if (this->input_argument_->is_file()
 100       && this->input_argument_->file().may_need_search()
 101       && this->dirpath_->token()->is_blocked())
 102     return this->dirpath_->token();
 103
 104   return NULL;
 105 }
 106
 107 // Return a Task_locker for a Read_symbols task.  We don't need any
 108 // locks here.
 109
 110 void
 111 Read_symbols::locks(Task_locker*)
 112 {
 113 }
 114
 115 // Run a Read_symbols task.
 116
 117 void
 118 Read_symbols::run(Workqueue* workqueue)
 119 {
 120   // If we didn't queue a new task, then we need to explicitly unblock
 121   // the token.
 122   if (!this->do_read_symbols(workqueue))
 123     workqueue->queue_soon(new Unblock_token(this->this_blocker_,
 124                                             this->next_blocker_));
 125 }
 126
 127 // Open the file and read the symbols.  Return true if a new task was
 128 // queued, false if that could not happen due to some error.
 129
 130 bool
 131 Read_symbols::do_read_symbols(Workqueue* workqueue)
 132 {
 133   if (this->input_argument_->is_group())
 134     {
 135       gold_assert(this->input_group_ == NULL);
 136       this->do_group(workqueue);
 137       return true;
 138     }
 139
 140   Input_file* input_file = new Input_file(&this->input_argument_->file());
 141   if (!input_file->open(this->options_, *this->dirpath_, this))
 142     return false;
 143
 144   // Read enough of the file to pick up the entire ELF header.
 145
 146   off_t filesize = input_file->file().filesize();
 147
 148   if (filesize == 0)
 149     {
 150       gold_error(_("%s: file is empty"),
 151                  input_file->file().filename().c_str());
 152       return false;
 153     }
 154
 155   unsigned char ehdr_buf[elfcpp::Elf_sizes<64>::ehdr_size];
 156
 157   int read_size = elfcpp::Elf_sizes<64>::ehdr_size;
 158   if (filesize < read_size)
 159     read_size = filesize;
 160
 161   input_file->file().read(0, read_size, ehdr_buf);
 162
 163   if (read_size >= 4)
 164     {
 165       static unsigned char elfmagic[4] =
 166         {
 167           elfcpp::ELFMAG0, elfcpp::ELFMAG1,
 168           elfcpp::ELFMAG2, elfcpp::ELFMAG3
 169         };
 170       if (memcmp(ehdr_buf, elfmagic, 4) == 0)
 171         {
 172           // This is an ELF object.
 173
 174           Object* obj = make_elf_object(input_file->filename(),
 175                                         input_file, 0, ehdr_buf, read_size);
 176           if (obj == NULL)
 177             return false;
 178
 179           Read_symbols_data* sd = new Read_symbols_data;
 180           obj->read_symbols(sd);
 181
 182           // Opening the file locked it, so now we need to unlock it.
 183           // We need to unlock it before queuing the Add_symbols task,
 184           // because the workqueue doesn't know about our lock on the
 185           // file.  If we queue the Add_symbols task first, it will be
 186           // stuck on the end of the file lock, but since the
 187           // workqueue doesn't know about that lock, it will never
 188           // release the Add_symbols task.
 189
 190           input_file->file().unlock(this);
 191
 192           // We use queue_next because everything is cached for this
 193           // task to run right away if possible.
 194
 195           workqueue->queue_next(new Add_symbols(this->input_objects_,
 196                                                 this->symtab_, this->layout_,
 197                                                 obj, sd,
 198                                                 this->this_blocker_,
 199                                                 this->next_blocker_));
 200
 201           return true;
 202         }
 203     }
 204
 205   if (read_size >= Archive::sarmag)
 206     {
 207       if (memcmp(ehdr_buf, Archive::armag, Archive::sarmag) == 0)
 208         {
 209           // This is an archive.
 210           Archive* arch = new Archive(this->input_argument_->file().name(),
 211                                       input_file);
 212           arch->setup(this);
 213
 214           workqueue->queue_next(new Add_archive_symbols(this->symtab_,
 215                                                         this->layout_,
 216                                                         this->input_objects_,
 217                                                         arch,
 218                                                         this->input_group_,
 219                                                         this->this_blocker_,
 220                                                         this->next_blocker_));
 221           return true;
 222         }
 223     }
 224
 225   // Queue up a task to try to parse this file as a script.  We use a
 226   // separate task so that the script will be read in order with other
 227   // objects named on the command line.  Also so that we don't try to
 228   // read multiple scripts simultaneously, which could lead to
 229   // unpredictable changes to the General_options structure.
 230
 231   workqueue->queue_soon(new Read_script(this->options_,
 232                                         this->symtab_,
 233                                         this->layout_,
 234                                         this->dirpath_,
 235                                         this->input_objects_,
 236                                         this->input_group_,
 237                                         this->input_argument_,
 238                                         input_file,
 239                                         this->this_blocker_,
 240                                         this->next_blocker_));
 241   return true;
 242 }
 243
 244 // Handle a group.  We need to walk through the arguments over and
 245 // over until we don't see any new undefined symbols.  We do this by
 246 // setting off Read_symbols Tasks as usual, but recording the archive
 247 // entries instead of deleting them.  We also start a Finish_group
 248 // Task which runs after we've read all the symbols.  In that task we
 249 // process the archives in a loop until we are done.
 250
 251 void
 252 Read_symbols::do_group(Workqueue* workqueue)
 253 {
 254   Input_group* input_group = new Input_group();
 255
 256   const Input_file_group* group = this->input_argument_->group();
 257   Task_token* this_blocker = this->this_blocker_;
 258
 259   for (Input_file_group::const_iterator p = group->begin();
 260        p != group->end();
 261        ++p)
 262     {
 263       const Input_argument* arg = &*p;
 264       gold_assert(arg->is_file());
 265
 266       Task_token* next_blocker = new Task_token(true);
 267       next_blocker->add_blocker();
 268       workqueue->queue_soon(new Read_symbols(this->options_,
 269                                              this->input_objects_,
 270                                              this->symtab_, this->layout_,
 271                                              this->dirpath_, arg, input_group,
 272                                              this_blocker, next_blocker));
 273       this_blocker = next_blocker;
 274     }
 275
 276   const int saw_undefined = this->symtab_->saw_undefined();
 277   workqueue->queue_soon(new Finish_group(this->input_objects_,
 278                                          this->symtab_,
 279                                          this->layout_,
 280                                          input_group,
 281                                          saw_undefined,
 282                                          this_blocker,
 283                                          this->next_blocker_));
 284 }
 285
 286 // Return a debugging name for a Read_symbols task.
 287
 288 std::string
 289 Read_symbols::get_name() const
 290 {
 291   if (!this->input_argument_->is_group())
 292     {
 293       std::string ret("Read_symbols ");
 294       if (this->input_argument_->file().is_lib())
 295         ret += "-l";
 296       ret += this->input_argument_->file().name();
 297       return ret;
 298     }
 299
 300   std::string ret("Read_symbols group (");
 301   bool add_space = false;
 302   const Input_file_group* group = this->input_argument_->group();
 303   for (Input_file_group::const_iterator p = group->begin();
 304        p != group->end();
 305        ++p)
 306     {
 307       if (add_space)
 308         ret += ' ';
 309       ret += p->file().name();
 310       add_space = true;
 311     }
 312   return ret + ')';
 313 }
 314
 315 // Class Add_symbols.
 316
 317 Add_symbols::~Add_symbols()
 318 {
 319   if (this->this_blocker_ != NULL)
 320     delete this->this_blocker_;
 321   // next_blocker_ is deleted by the task associated with the next
 322   // input file.
 323 }
 324
 325 // We are blocked by this_blocker_.  We block next_blocker_.  We also
 326 // lock the file.
 327
 328 Task_token*
 329 Add_symbols::is_runnable()
 330 {
 331   if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
 332     return this->this_blocker_;
 333   if (this->object_->is_locked())
 334     return this->object_->token();
 335   return NULL;
 336 }
 337
 338 void
 339 Add_symbols::locks(Task_locker* tl)
 340 {
 341   tl->add(this, this->next_blocker_);
 342   tl->add(this, this->object_->token());
 343 }
 344
 345 // Add the symbols in the object to the symbol table.
 346
 347 void
 348 Add_symbols::run(Workqueue*)
 349 {
 350   if (!this->input_objects_->add_object(this->object_))
 351     {
 352       // FIXME: We need to close the descriptor here.
 353       delete this->object_;
 354     }
 355   else
 356     {
 357       this->object_->layout(this->symtab_, this->layout_, this->sd_);
 358       this->object_->add_symbols(this->symtab_, this->sd_);
 359       this->object_->release();
 360     }
 361   delete this->sd_;
 362   this->sd_ = NULL;
 363 }
 364
 365 // Class Finish_group.
 366
 367 Finish_group::~Finish_group()
 368 {
 369   if (this->this_blocker_ != NULL)
 370     delete this->this_blocker_;
 371   // next_blocker_ is deleted by the task associated with the next
 372   // input file following the group.
 373 }
 374
 375 // We need to wait for THIS_BLOCKER_ and unblock NEXT_BLOCKER_.
 376
 377 Task_token*
 378 Finish_group::is_runnable()
 379 {
 380   if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
 381     return this->this_blocker_;
 382   return NULL;
 383 }
 384
 385 void
 386 Finish_group::locks(Task_locker* tl)
 387 {
 388   tl->add(this, this->next_blocker_);
 389 }
 390
 391 // Loop over the archives until there are no new undefined symbols.
 392
 393 void
 394 Finish_group::run(Workqueue*)
 395 {
 396   int saw_undefined = this->saw_undefined_;
 397   while (saw_undefined != this->symtab_->saw_undefined())
 398     {
 399       saw_undefined = this->symtab_->saw_undefined();
 400
 401       for (Input_group::const_iterator p = this->input_group_->begin();
 402            p != this->input_group_->end();
 403            ++p)
 404         {
 405           Task_lock_obj<Archive> tl(this, *p);
 406
 407           (*p)->add_symbols(this->symtab_, this->layout_,
 408                             this->input_objects_);
 409         }
 410     }
 411
 412   // Delete all the archives now that we no longer need them.
 413   for (Input_group::const_iterator p = this->input_group_->begin();
 414        p != this->input_group_->end();
 415        ++p)
 416     delete *p;
 417   delete this->input_group_;
 418 }
 419
 420 // Class Read_script
 421
 422 Read_script::~Read_script()
 423 {
 424   if (this->this_blocker_ != NULL)
 425     delete this->this_blocker_;
 426   // next_blocker_ is deleted by the task associated with the next
 427   // input file.
 428 }
 429
 430 // We are blocked by this_blocker_.
 431
 432 Task_token*
 433 Read_script::is_runnable()
 434 {
 435   if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
 436     return this->this_blocker_;
 437   return NULL;
 438 }
 439
 440 // We don't unlock next_blocker_ here.  If the script names any input
 441 // files, then the last file will be responsible for unlocking it.
 442
 443 void
 444 Read_script::locks(Task_locker*)
 445 {
 446 }
 447
 448 // Read the script, if it is a script.
 449
 450 void
 451 Read_script::run(Workqueue* workqueue)
 452 {
 453   bool used_next_blocker;
 454   if (!read_input_script(workqueue, this->options_, this->symtab_,
 455                          this->layout_, this->dirpath_, this->input_objects_,
 456                          this->input_group_, this->input_argument_,
 457                          this->input_file_, this->next_blocker_,
 458                          &used_next_blocker))
 459     {
 460       // Here we have to handle any other input file types we need.
 461       gold_error(_("%s: not an object or archive"),
 462                  this->input_file_->file().filename().c_str());
 463     }
 464
 465   if (!used_next_blocker)
 466     {
 467       // Queue up a task to unlock next_blocker.  We can't just unlock
 468       // it here, as we don't hold the workqueue lock.
 469       workqueue->queue_soon(new Unblock_token(NULL, this->next_blocker_));
 470     }
 471 }
 472
 473 // Return a debugging name for a Read_script task.
 474
 475 std::string
 476 Read_script::get_name() const
 477 {
 478   std::string ret("Read_script ");
 479   if (this->input_argument_->file().is_lib())
 480     ret += "-l";
 481   ret += this->input_argument_->file().name();
 482   return ret;
 483 }
 484
 485 } // End namespace gold.