gold/plugin.cc

   1 // plugin.cc -- plugin manager for gold      -*- C++ -*-
   2
   3 // Copyright 2008, 2009 Free Software Foundation, Inc.
   4 // Written by Cary Coutant <ccoutant@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 <cstdio>
  24 #include <cstdarg>
  25 #include <cstring>
  26 #include <string>
  27 #include <vector>
  28 #include <dlfcn.h>
  29
  30 #include "gold.h"
  31 #include "parameters.h"
  32 #include "errors.h"
  33 #include "fileread.h"
  34 #include "layout.h"
  35 #include "options.h"
  36 #include "plugin.h"
  37 #include "target.h"
  38 #include "readsyms.h"
  39 #include "symtab.h"
  40 #include "elfcpp.h"
  41
  42 namespace gold
  43 {
  44
  45 #ifdef ENABLE_PLUGINS
  46
  47 // The linker's exported interfaces.
  48
  49 extern "C"
  50 {
  51
  52 static enum ld_plugin_status
  53 register_claim_file(ld_plugin_claim_file_handler handler);
  54
  55 static enum ld_plugin_status
  56 register_all_symbols_read(ld_plugin_all_symbols_read_handler handler);
  57
  58 static enum ld_plugin_status
  59 register_cleanup(ld_plugin_cleanup_handler handler);
  60
  61 static enum ld_plugin_status
  62 add_symbols(void *handle, int nsyms, const struct ld_plugin_symbol *syms);
  63
  64 static enum ld_plugin_status
  65 get_input_file(const void *handle, struct ld_plugin_input_file *file);
  66
  67 static enum ld_plugin_status
  68 release_input_file(const void *handle);
  69
  70 static enum ld_plugin_status
  71 get_symbols(const void *handle, int nsyms, struct ld_plugin_symbol *syms);
  72
  73 static enum ld_plugin_status
  74 add_input_file(char *pathname);
  75
  76 static enum ld_plugin_status
  77 message(int level, const char *format, ...);
  78
  79 };
  80
  81 #endif // ENABLE_PLUGINS
  82
  83 static Pluginobj* make_sized_plugin_object(Input_file* input_file,
  84                                            off_t offset, off_t filesize);
  85
  86 // Plugin methods.
  87
  88 // Load one plugin library.
  89
  90 void
  91 Plugin::load()
  92 {
  93 #ifdef ENABLE_PLUGINS
  94   // Load the plugin library.
  95   // FIXME: Look for the library in standard locations.
  96   this->handle_ = dlopen(this->filename_.c_str(), RTLD_NOW);
  97   if (this->handle_ == NULL)
  98     {
  99       gold_error(_("%s: could not load plugin library"),
 100                  this->filename_.c_str());
 101       return;
 102     }
 103
 104   // Find the plugin's onload entry point.
 105   ld_plugin_onload onload = reinterpret_cast<ld_plugin_onload>
 106     (dlsym(this->handle_, "onload"));
 107   if (onload == NULL)
 108     {
 109       gold_error(_("%s: could not find onload entry point"),
 110                  this->filename_.c_str());
 111       return;
 112     }
 113
 114   // Get the linker's version number.
 115   const char* ver = get_version_string();
 116   int major = 0;
 117   int minor = 0;
 118   sscanf(ver, "%d.%d", &major, &minor);
 119
 120   // Allocate and populate a transfer vector.
 121   const int tv_fixed_size = 13;
 122   int tv_size = this->args_.size() + tv_fixed_size;
 123   ld_plugin_tv *tv = new ld_plugin_tv[tv_size];
 124
 125   // Put LDPT_MESSAGE at the front of the list so the plugin can use it
 126   // while processing subsequent entries.
 127   int i = 0;
 128   tv[i].tv_tag = LDPT_MESSAGE;
 129   tv[i].tv_u.tv_message = message;
 130
 131   ++i;
 132   tv[i].tv_tag = LDPT_API_VERSION;
 133   tv[i].tv_u.tv_val = LD_PLUGIN_API_VERSION;
 134
 135   ++i;
 136   tv[i].tv_tag = LDPT_GOLD_VERSION;
 137   tv[i].tv_u.tv_val = major * 100 + minor;
 138
 139   ++i;
 140   tv[i].tv_tag = LDPT_LINKER_OUTPUT;
 141   if (parameters->options().relocatable())
 142     tv[i].tv_u.tv_val = LDPO_REL;
 143   else if (parameters->options().shared())
 144     tv[i].tv_u.tv_val = LDPO_DYN;
 145   else
 146     tv[i].tv_u.tv_val = LDPO_EXEC;
 147
 148   for (unsigned int j = 0; j < this->args_.size(); ++j)
 149     {
 150       ++i;
 151       tv[i].tv_tag = LDPT_OPTION;
 152       tv[i].tv_u.tv_string = this->args_[j].c_str();
 153     }
 154
 155   ++i;
 156   tv[i].tv_tag = LDPT_REGISTER_CLAIM_FILE_HOOK;
 157   tv[i].tv_u.tv_register_claim_file = register_claim_file;
 158
 159   ++i;
 160   tv[i].tv_tag = LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK;
 161   tv[i].tv_u.tv_register_all_symbols_read = register_all_symbols_read;
 162
 163   ++i;
 164   tv[i].tv_tag = LDPT_REGISTER_CLEANUP_HOOK;
 165   tv[i].tv_u.tv_register_cleanup = register_cleanup;
 166
 167   ++i;
 168   tv[i].tv_tag = LDPT_ADD_SYMBOLS;
 169   tv[i].tv_u.tv_add_symbols = add_symbols;
 170
 171   ++i;
 172   tv[i].tv_tag = LDPT_GET_INPUT_FILE;
 173   tv[i].tv_u.tv_get_input_file = get_input_file;
 174
 175   ++i;
 176   tv[i].tv_tag = LDPT_RELEASE_INPUT_FILE;
 177   tv[i].tv_u.tv_release_input_file = release_input_file;
 178
 179   ++i;
 180   tv[i].tv_tag = LDPT_GET_SYMBOLS;
 181   tv[i].tv_u.tv_get_symbols = get_symbols;
 182
 183   ++i;
 184   tv[i].tv_tag = LDPT_ADD_INPUT_FILE;
 185   tv[i].tv_u.tv_add_input_file = add_input_file;
 186
 187   ++i;
 188   tv[i].tv_tag = LDPT_NULL;
 189   tv[i].tv_u.tv_val = 0;
 190
 191   gold_assert(i == tv_size - 1);
 192
 193   // Call the onload entry point.
 194   (*onload)(tv);
 195
 196   delete[] tv;
 197 #endif // ENABLE_PLUGINS
 198 }
 199
 200 // Call the plugin claim-file handler.
 201
 202 inline bool
 203 Plugin::claim_file(struct ld_plugin_input_file *plugin_input_file)
 204 {
 205   int claimed = 0;
 206
 207   if (this->claim_file_handler_ != NULL)
 208     {
 209       (*this->claim_file_handler_)(plugin_input_file, &claimed);
 210       if (claimed)
 211         return true;
 212     }
 213   return false;
 214 }
 215
 216 // Call the all-symbols-read handler.
 217
 218 inline void
 219 Plugin::all_symbols_read()
 220 {
 221   if (this->all_symbols_read_handler_ != NULL)
 222     (*this->all_symbols_read_handler_)();
 223 }
 224
 225 // Call the cleanup handler.
 226
 227 inline void
 228 Plugin::cleanup()
 229 {
 230   if (this->cleanup_handler_ != NULL)
 231     (*this->cleanup_handler_)();
 232 }
 233
 234 // Plugin_manager methods.
 235
 236 Plugin_manager::~Plugin_manager()
 237 {
 238   for (Plugin_list::iterator p = this->plugins_.begin();
 239        p != this->plugins_.end();
 240        ++p)
 241     delete *p;
 242   this->plugins_.clear();
 243   for (Object_list::iterator obj = this->objects_.begin();
 244        obj != this->objects_.end();
 245        ++obj)
 246     delete *obj;
 247   this->objects_.clear();
 248 }
 249
 250 // Load all plugin libraries.
 251
 252 void
 253 Plugin_manager::load_plugins()
 254 {
 255   for (this->current_ = this->plugins_.begin();
 256        this->current_ != this->plugins_.end();
 257        ++this->current_)
 258     (*this->current_)->load();
 259 }
 260
 261 // Call the plugin claim-file handlers in turn to see if any claim the file.
 262
 263 Pluginobj*
 264 Plugin_manager::claim_file(Input_file* input_file, off_t offset,
 265                            off_t filesize)
 266 {
 267   if (this->in_replacement_phase_)
 268     return NULL;
 269
 270   unsigned int handle = this->objects_.size();
 271   this->input_file_ = input_file;
 272   this->plugin_input_file_.name = input_file->filename().c_str();
 273   this->plugin_input_file_.fd = input_file->file().descriptor();
 274   this->plugin_input_file_.offset = offset;
 275   this->plugin_input_file_.filesize = filesize;
 276   this->plugin_input_file_.handle = reinterpret_cast<void*>(handle);
 277
 278   for (this->current_ = this->plugins_.begin();
 279        this->current_ != this->plugins_.end();
 280        ++this->current_)
 281     {
 282       if ((*this->current_)->claim_file(&this->plugin_input_file_))
 283         {
 284           if (this->objects_.size() > handle)
 285             return this->objects_[handle];
 286
 287           // If the plugin claimed the file but did not call the
 288           // add_symbols callback, we need to create the Pluginobj now.
 289           Pluginobj* obj = this->make_plugin_object(handle);
 290           return obj;
 291         }
 292     }
 293
 294   return NULL;
 295 }
 296
 297 // Call the all-symbols-read handlers.
 298
 299 void
 300 Plugin_manager::all_symbols_read(Workqueue* workqueue, Task* task,
 301                                  Input_objects* input_objects,
 302                                  Symbol_table* symtab, Layout* layout,
 303                                  Dirsearch* dirpath, Mapfile* mapfile,
 304                                  Task_token** last_blocker)
 305 {
 306   this->in_replacement_phase_ = true;
 307   this->workqueue_ = workqueue;
 308   this->task_ = task;
 309   this->input_objects_ = input_objects;
 310   this->symtab_ = symtab;
 311   this->layout_ = layout;
 312   this->dirpath_ = dirpath;
 313   this->mapfile_ = mapfile;
 314   this->this_blocker_ = NULL;
 315
 316   for (this->current_ = this->plugins_.begin();
 317        this->current_ != this->plugins_.end();
 318        ++this->current_)
 319     (*this->current_)->all_symbols_read();
 320
 321   *last_blocker = this->this_blocker_;
 322 }
 323
 324 // Layout deferred objects.
 325
 326 void
 327 Plugin_manager::layout_deferred_objects()
 328 {
 329   Deferred_layout_list::iterator obj;
 330
 331   for (obj = this->deferred_layout_objects_.begin();
 332        obj != this->deferred_layout_objects_.end();
 333        ++obj)
 334     (*obj)->layout_deferred_sections(this->layout_);
 335 }
 336
 337 // Call the cleanup handlers.
 338
 339 void
 340 Plugin_manager::cleanup()
 341 {
 342   if (this->cleanup_done_)
 343     return;
 344   for (this->current_ = this->plugins_.begin();
 345        this->current_ != this->plugins_.end();
 346        ++this->current_)
 347     (*this->current_)->cleanup();
 348   this->cleanup_done_ = true;
 349 }
 350
 351 // Make a new Pluginobj object.  This is called when the plugin calls
 352 // the add_symbols API.
 353
 354 Pluginobj*
 355 Plugin_manager::make_plugin_object(unsigned int handle)
 356 {
 357   // Make sure we aren't asked to make an object for the same handle twice.
 358   if (this->objects_.size() != handle)
 359     return NULL;
 360
 361   Pluginobj* obj = make_sized_plugin_object(this->input_file_,
 362                                             this->plugin_input_file_.offset,
 363                                             this->plugin_input_file_.filesize);
 364   this->objects_.push_back(obj);
 365   return obj;
 366 }
 367
 368 // Get the input file information with an open (possibly re-opened)
 369 // file descriptor.
 370
 371 ld_plugin_status
 372 Plugin_manager::get_input_file(unsigned int handle,
 373                                struct ld_plugin_input_file *file)
 374 {
 375   Pluginobj* obj = this->object(handle);
 376   if (obj == NULL)
 377     return LDPS_BAD_HANDLE;
 378
 379   obj->lock(this->task_);
 380   file->name = obj->filename().c_str();
 381   file->fd = obj->descriptor();
 382   file->offset = obj->offset();
 383   file->filesize = obj->filesize();
 384   file->handle = reinterpret_cast<void*>(handle);
 385   return LDPS_OK;
 386 }
 387
 388 // Release the input file.
 389
 390 ld_plugin_status
 391 Plugin_manager::release_input_file(unsigned int handle)
 392 {
 393   Pluginobj* obj = this->object(handle);
 394   if (obj == NULL)
 395     return LDPS_BAD_HANDLE;
 396
 397   obj->unlock(this->task_);
 398   return LDPS_OK;
 399 }
 400
 401 // Add a new input file.
 402
 403 ld_plugin_status
 404 Plugin_manager::add_input_file(char *pathname)
 405 {
 406   Input_file_argument file(pathname, false, "", false, this->options_);
 407   Input_argument* input_argument = new Input_argument(file);
 408   Task_token* next_blocker = new Task_token(true);
 409   next_blocker->add_blocker();
 410   this->workqueue_->queue_soon(new Read_symbols(this->options_,
 411                                                 this->input_objects_,
 412                                                 this->symtab_,
 413                                                 this->layout_,
 414                                                 this->dirpath_,
 415                                                 this->mapfile_,
 416                                                 input_argument,
 417                                                 NULL,
 418                                                 this->this_blocker_,
 419                                                 next_blocker));
 420   this->this_blocker_ = next_blocker;
 421   return LDPS_OK;
 422 }
 423
 424 // Class Pluginobj.
 425
 426 Pluginobj::Pluginobj(const std::string& name, Input_file* input_file,
 427                      off_t offset, off_t filesize)
 428   : Object(name, input_file, false, offset),
 429     nsyms_(0), syms_(NULL), symbols_(), filesize_(filesize), comdat_map_()
 430 {
 431 }
 432
 433 // Return TRUE if a defined symbol might be reachable from outside the
 434 // universe of claimed objects.
 435
 436 static inline bool
 437 is_visible_from_outside(Symbol* lsym)
 438 {
 439   if (lsym->in_real_elf())
 440     return true;
 441   if (parameters->options().relocatable())
 442     return true;
 443   if (parameters->options().export_dynamic() || parameters->options().shared())
 444     return lsym->is_externally_visible();
 445   return false;
 446 }
 447
 448 // Get symbol resolution info.
 449
 450 ld_plugin_status
 451 Pluginobj::get_symbol_resolution_info(int nsyms, ld_plugin_symbol* syms) const
 452 {
 453   if (nsyms > this->nsyms_)
 454     return LDPS_NO_SYMS;
 455   for (int i = 0; i < nsyms; i++)
 456     {
 457       ld_plugin_symbol* isym = &syms[i];
 458       Symbol* lsym = this->symbols_[i];
 459       ld_plugin_symbol_resolution res = LDPR_UNKNOWN;
 460
 461       if (lsym->is_undefined())
 462         // The symbol remains undefined.
 463         res = LDPR_UNDEF;
 464       else if (isym->def == LDPK_UNDEF
 465                || isym->def == LDPK_WEAKUNDEF
 466                || isym->def == LDPK_COMMON)
 467         {
 468           // The original symbol was undefined or common.
 469           if (lsym->source() != Symbol::FROM_OBJECT)
 470             res = LDPR_RESOLVED_EXEC;
 471           else if (lsym->object()->pluginobj() != NULL)
 472             res = LDPR_RESOLVED_IR;
 473           else if (lsym->object()->is_dynamic())
 474             res = LDPR_RESOLVED_DYN;
 475           else
 476             res = LDPR_RESOLVED_EXEC;
 477         }
 478       else
 479         {
 480           // The original symbol was a definition.
 481           if (lsym->source() != Symbol::FROM_OBJECT)
 482             res = LDPR_PREEMPTED_REG;
 483           else if (lsym->object() == static_cast<const Object*>(this))
 484             res = (is_visible_from_outside(lsym)
 485                    ? LDPR_PREVAILING_DEF
 486                    : LDPR_PREVAILING_DEF_IRONLY);
 487           else
 488             res = (lsym->object()->pluginobj() != NULL
 489                    ? LDPR_PREEMPTED_IR
 490                    : LDPR_PREEMPTED_REG);
 491         }
 492       isym->resolution = res;
 493     }
 494   return LDPS_OK;
 495 }
 496
 497 // Return TRUE if the comdat group with key COMDAT_KEY from this object
 498 // should be kept.
 499
 500 bool
 501 Pluginobj::include_comdat_group(std::string comdat_key, Layout* layout)
 502 {
 503   std::pair<Comdat_map::iterator, bool> ins =
 504     this->comdat_map_.insert(std::make_pair(comdat_key, false));
 505
 506   // If this is the first time we've seen this comdat key, ask the
 507   // layout object whether it should be included.
 508   if (ins.second)
 509     ins.first->second = layout->add_comdat(NULL, 1, comdat_key, true);
 510
 511   return ins.first->second;
 512 }
 513
 514 // Class Sized_pluginobj.
 515
 516 template<int size, bool big_endian>
 517 Sized_pluginobj<size, big_endian>::Sized_pluginobj(
 518     const std::string& name,
 519     Input_file* input_file,
 520     off_t offset,
 521     off_t filesize)
 522   : Pluginobj(name, input_file, offset, filesize)
 523 {
 524 }
 525
 526 // Read the symbols.  Not used for plugin objects.
 527
 528 template<int size, bool big_endian>
 529 void
 530 Sized_pluginobj<size, big_endian>::do_read_symbols(Read_symbols_data*)
 531 {
 532   gold_unreachable();
 533 }
 534
 535 // Lay out the input sections.  Not used for plugin objects.
 536
 537 template<int size, bool big_endian>
 538 void
 539 Sized_pluginobj<size, big_endian>::do_layout(Symbol_table*, Layout*,
 540                                              Read_symbols_data*)
 541 {
 542   gold_unreachable();
 543 }
 544
 545 // Add the symbols to the symbol table.
 546
 547 template<int size, bool big_endian>
 548 void
 549 Sized_pluginobj<size, big_endian>::do_add_symbols(Symbol_table* symtab,
 550                                                   Read_symbols_data*,
 551                                                   Layout* layout)
 552 {
 553   const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
 554   unsigned char symbuf[sym_size];
 555   elfcpp::Sym<size, big_endian> sym(symbuf);
 556   elfcpp::Sym_write<size, big_endian> osym(symbuf);
 557
 558   typedef typename elfcpp::Elf_types<size>::Elf_WXword Elf_size_type;
 559
 560   this->symbols_.resize(this->nsyms_);
 561
 562   for (int i = 0; i < this->nsyms_; ++i)
 563     {
 564       const struct ld_plugin_symbol *isym = &this->syms_[i];
 565       const char* name = isym->name;
 566       const char* ver = isym->version;
 567       elfcpp::Elf_Half shndx;
 568       elfcpp::STB bind;
 569       elfcpp::STV vis;
 570
 571       if (name != NULL && name[0] == '\0')
 572         name = NULL;
 573       if (ver != NULL && ver[0] == '\0')
 574         ver = NULL;
 575
 576       switch (isym->def)
 577         {
 578         case LDPK_WEAKDEF:
 579         case LDPK_WEAKUNDEF:
 580           bind = elfcpp::STB_WEAK;
 581           break;
 582         case LDPK_DEF:
 583         case LDPK_UNDEF:
 584         case LDPK_COMMON:
 585         default:
 586           bind = elfcpp::STB_GLOBAL;
 587           break;
 588         }
 589
 590       switch (isym->def)
 591         {
 592         case LDPK_DEF:
 593         case LDPK_WEAKDEF:
 594           shndx = elfcpp::SHN_ABS;
 595           break;
 596         case LDPK_COMMON:
 597           shndx = elfcpp::SHN_COMMON;
 598           break;
 599         case LDPK_UNDEF:
 600         case LDPK_WEAKUNDEF:
 601         default:
 602           shndx = elfcpp::SHN_UNDEF;
 603           break;
 604         }
 605
 606       switch (isym->visibility)
 607         {
 608         case LDPV_PROTECTED:
 609           vis = elfcpp::STV_DEFAULT;
 610           break;
 611         case LDPV_INTERNAL:
 612           vis = elfcpp::STV_DEFAULT;
 613           break;
 614         case LDPV_HIDDEN:
 615           vis = elfcpp::STV_DEFAULT;
 616           break;
 617         case LDPV_DEFAULT:
 618         default:
 619           vis = elfcpp::STV_DEFAULT;
 620           break;
 621         }
 622
 623       if (isym->comdat_key != NULL
 624           && isym->comdat_key[0] != '\0'
 625           && !this->include_comdat_group(isym->comdat_key, layout))
 626         shndx = elfcpp::SHN_UNDEF;
 627
 628       osym.put_st_name(0);
 629       osym.put_st_value(0);
 630       osym.put_st_size(static_cast<Elf_size_type>(isym->size));
 631       osym.put_st_info(bind, elfcpp::STT_NOTYPE);
 632       osym.put_st_other(vis, 0);
 633       osym.put_st_shndx(shndx);
 634
 635       this->symbols_[i] =
 636         symtab->add_from_pluginobj<size, big_endian>(this, name, ver, &sym);
 637     }
 638 }
 639
 640 // Get the size of a section.  Not used for plugin objects.
 641
 642 template<int size, bool big_endian>
 643 uint64_t
 644 Sized_pluginobj<size, big_endian>::do_section_size(unsigned int)
 645 {
 646   gold_unreachable();
 647   return 0;
 648 }
 649
 650 // Get the name of a section.  Not used for plugin objects.
 651
 652 template<int size, bool big_endian>
 653 std::string
 654 Sized_pluginobj<size, big_endian>::do_section_name(unsigned int)
 655 {
 656   gold_unreachable();
 657   return std::string();
 658 }
 659
 660 // Return a view of the contents of a section.  Not used for plugin objects.
 661
 662 template<int size, bool big_endian>
 663 Object::Location
 664 Sized_pluginobj<size, big_endian>::do_section_contents(unsigned int)
 665 {
 666   Location loc(0, 0);
 667
 668   gold_unreachable();
 669   return loc;
 670 }
 671
 672 // Return section flags.  Not used for plugin objects.
 673
 674 template<int size, bool big_endian>
 675 uint64_t
 676 Sized_pluginobj<size, big_endian>::do_section_flags(unsigned int)
 677 {
 678   gold_unreachable();
 679   return 0;
 680 }
 681
 682 // Return section address.  Not used for plugin objects.
 683
 684 template<int size, bool big_endian>
 685 uint64_t
 686 Sized_pluginobj<size, big_endian>::do_section_address(unsigned int)
 687 {
 688   gold_unreachable();
 689   return 0;
 690 }
 691
 692 // Return section type.  Not used for plugin objects.
 693
 694 template<int size, bool big_endian>
 695 unsigned int
 696 Sized_pluginobj<size, big_endian>::do_section_type(unsigned int)
 697 {
 698   gold_unreachable();
 699   return 0;
 700 }
 701
 702 // Return the section link field.  Not used for plugin objects.
 703
 704 template<int size, bool big_endian>
 705 unsigned int
 706 Sized_pluginobj<size, big_endian>::do_section_link(unsigned int)
 707 {
 708   gold_unreachable();
 709   return 0;
 710 }
 711
 712 // Return the section link field.  Not used for plugin objects.
 713
 714 template<int size, bool big_endian>
 715 unsigned int
 716 Sized_pluginobj<size, big_endian>::do_section_info(unsigned int)
 717 {
 718   gold_unreachable();
 719   return 0;
 720 }
 721
 722 // Return the section alignment.  Not used for plugin objects.
 723
 724 template<int size, bool big_endian>
 725 uint64_t
 726 Sized_pluginobj<size, big_endian>::do_section_addralign(unsigned int)
 727 {
 728   gold_unreachable();
 729   return 0;
 730 }
 731
 732 // Return the Xindex structure to use.  Not used for plugin objects.
 733
 734 template<int size, bool big_endian>
 735 Xindex*
 736 Sized_pluginobj<size, big_endian>::do_initialize_xindex()
 737 {
 738   gold_unreachable();
 739   return NULL;
 740 }
 741
 742 // Get symbol counts.  Not used for plugin objects.
 743
 744 template<int size, bool big_endian>
 745 void
 746 Sized_pluginobj<size, big_endian>::do_get_global_symbol_counts(const Symbol_table*,
 747                                                    size_t*, size_t*) const
 748 {
 749   gold_unreachable();
 750 }
 751
 752 // Class Plugin_finish.  This task runs after all replacement files have
 753 // been added.  It calls each plugin's cleanup handler.
 754
 755 class Plugin_finish : public Task
 756 {
 757  public:
 758   Plugin_finish(Task_token* this_blocker, Task_token* next_blocker)
 759     : this_blocker_(this_blocker), next_blocker_(next_blocker)
 760   { }
 761
 762   ~Plugin_finish()
 763   {
 764     if (this->this_blocker_ != NULL)
 765       delete this->this_blocker_;
 766   }
 767
 768   Task_token*
 769   is_runnable()
 770   {
 771     if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
 772       return this->this_blocker_;
 773     return NULL;
 774   }
 775
 776   void
 777   locks(Task_locker* tl)
 778   { tl->add(this, this->next_blocker_); }
 779
 780   void
 781   run(Workqueue*)
 782   {
 783     Plugin_manager* plugins = parameters->options().plugins();
 784     gold_assert(plugins != NULL);
 785     plugins->cleanup();
 786   }
 787
 788   std::string
 789   get_name() const
 790   { return "Plugin_finish"; }
 791
 792  private:
 793   Task_token* this_blocker_;
 794   Task_token* next_blocker_;
 795 };
 796
 797 // Class Plugin_hook.
 798
 799 Plugin_hook::~Plugin_hook()
 800 {
 801 }
 802
 803 // Return whether a Plugin_hook task is runnable.
 804
 805 Task_token*
 806 Plugin_hook::is_runnable()
 807 {
 808   if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
 809     return this->this_blocker_;
 810   return NULL;
 811 }
 812
 813 // Return a Task_locker for a Plugin_hook task.  We don't need any
 814 // locks here.
 815
 816 void
 817 Plugin_hook::locks(Task_locker*)
 818 {
 819 }
 820
 821 // Run the "all symbols read" plugin hook.
 822
 823 void
 824 Plugin_hook::run(Workqueue* workqueue)
 825 {
 826   gold_assert(this->options_.has_plugins());
 827   this->options_.plugins()->all_symbols_read(workqueue,
 828                                              this,
 829                                              this->input_objects_,
 830                                              this->symtab_,
 831                                              this->layout_,
 832                                              this->dirpath_,
 833                                              this->mapfile_,
 834                                              &this->this_blocker_);
 835   workqueue->queue_soon(new Plugin_finish(this->this_blocker_,
 836                                           this->next_blocker_));
 837 }
 838
 839 // The C interface routines called by the plugins.
 840
 841 #ifdef ENABLE_PLUGINS
 842
 843 // Register a claim-file handler.
 844
 845 static enum ld_plugin_status
 846 register_claim_file(ld_plugin_claim_file_handler handler)
 847 {
 848   gold_assert(parameters->options().has_plugins());
 849   parameters->options().plugins()->set_claim_file_handler(handler);
 850   return LDPS_OK;
 851 }
 852
 853 // Register an all-symbols-read handler.
 854
 855 static enum ld_plugin_status
 856 register_all_symbols_read(ld_plugin_all_symbols_read_handler handler)
 857 {
 858   gold_assert(parameters->options().has_plugins());
 859   parameters->options().plugins()->set_all_symbols_read_handler(handler);
 860   return LDPS_OK;
 861 }
 862
 863 // Register a cleanup handler.
 864
 865 static enum ld_plugin_status
 866 register_cleanup(ld_plugin_cleanup_handler handler)
 867 {
 868   gold_assert(parameters->options().has_plugins());
 869   parameters->options().plugins()->set_cleanup_handler(handler);
 870   return LDPS_OK;
 871 }
 872
 873 // Add symbols from a plugin-claimed input file.
 874
 875 static enum ld_plugin_status
 876 add_symbols(void* handle, int nsyms, const ld_plugin_symbol *syms)
 877 {
 878   gold_assert(parameters->options().has_plugins());
 879   Pluginobj* obj = parameters->options().plugins()->make_plugin_object(
 880       static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
 881   if (obj == NULL)
 882     return LDPS_ERR;
 883   obj->store_incoming_symbols(nsyms, syms);
 884   return LDPS_OK;
 885 }
 886
 887 // Get the input file information with an open (possibly re-opened)
 888 // file descriptor.
 889
 890 static enum ld_plugin_status
 891 get_input_file(const void *handle, struct ld_plugin_input_file *file)
 892 {
 893   gold_assert(parameters->options().has_plugins());
 894   unsigned int obj_index =
 895       static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
 896   return parameters->options().plugins()->get_input_file(obj_index, file);
 897 }
 898
 899 // Release the input file.
 900
 901 static enum ld_plugin_status
 902 release_input_file(const void *handle)
 903 {
 904   gold_assert(parameters->options().has_plugins());
 905   unsigned int obj_index =
 906       static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
 907   return parameters->options().plugins()->release_input_file(obj_index);
 908 }
 909
 910 // Get the symbol resolution info for a plugin-claimed input file.
 911
 912 static enum ld_plugin_status
 913 get_symbols(const void * handle, int nsyms, ld_plugin_symbol* syms)
 914 {
 915   gold_assert(parameters->options().has_plugins());
 916   Pluginobj* obj = parameters->options().plugins()->object(
 917       static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
 918   if (obj == NULL)
 919     return LDPS_ERR;
 920   return obj->get_symbol_resolution_info(nsyms, syms);
 921 }
 922
 923 // Add a new (real) input file generated by a plugin.
 924
 925 static enum ld_plugin_status
 926 add_input_file(char *pathname)
 927 {
 928   gold_assert(parameters->options().has_plugins());
 929   return parameters->options().plugins()->add_input_file(pathname);
 930 }
 931
 932 // Issue a diagnostic message from a plugin.
 933
 934 static enum ld_plugin_status
 935 message(int level, const char * format, ...)
 936 {
 937   va_list args;
 938   va_start(args, format);
 939
 940   switch (level)
 941     {
 942     case LDPL_INFO:
 943       parameters->errors()->info(format, args);
 944       break;
 945     case LDPL_WARNING:
 946       parameters->errors()->warning(format, args);
 947       break;
 948     case LDPL_ERROR:
 949     default:
 950       parameters->errors()->error(format, args);
 951       break;
 952     case LDPL_FATAL:
 953       parameters->errors()->fatal(format, args);
 954       break;
 955     }
 956
 957   va_end(args);
 958   return LDPS_OK;
 959 }
 960
 961 #endif // ENABLE_PLUGINS
 962
 963 // Allocate a Pluginobj object of the appropriate size and endianness.
 964
 965 static Pluginobj*
 966 make_sized_plugin_object(Input_file* input_file, off_t offset, off_t filesize)
 967 {
 968   Target* target;
 969   Pluginobj* obj = NULL;
 970
 971   if (parameters->target_valid())
 972     target = const_cast<Target*>(&parameters->target());
 973   else
 974     target = const_cast<Target*>(&parameters->default_target());
 975
 976   if (target->get_size() == 32)
 977     {
 978       if (target->is_big_endian())
 979 #ifdef HAVE_TARGET_32_BIG
 980         obj = new Sized_pluginobj<32, true>(input_file->filename(),
 981                                             input_file, offset, filesize);
 982 #else
 983         gold_error(_("%s: not configured to support "
 984                      "32-bit big-endian object"),
 985                    input_file->filename().c_str());
 986 #endif
 987       else
 988 #ifdef HAVE_TARGET_32_LITTLE
 989         obj = new Sized_pluginobj<32, false>(input_file->filename(),
 990                                              input_file, offset, filesize);
 991 #else
 992         gold_error(_("%s: not configured to support "
 993                      "32-bit little-endian object"),
 994                    input_file->filename().c_str());
 995 #endif
 996     }
 997   else if (target->get_size() == 64)
 998     {
 999       if (target->is_big_endian())
1000 #ifdef HAVE_TARGET_64_BIG
1001         obj = new Sized_pluginobj<64, true>(input_file->filename(),
1002                                             input_file, offset, filesize);
1003 #else
1004         gold_error(_("%s: not configured to support "
1005                      "64-bit big-endian object"),
1006                    input_file->filename().c_str());
1007 #endif
1008       else
1009 #ifdef HAVE_TARGET_64_LITTLE
1010         obj = new Sized_pluginobj<64, false>(input_file->filename(),
1011                                              input_file, offset, filesize);
1012 #else
1013         gold_error(_("%s: not configured to support "
1014                      "64-bit little-endian object"),
1015                    input_file->filename().c_str());
1016 #endif
1017     }
1018
1019   gold_assert(obj != NULL);
1020   obj->set_target(target);
1021   return obj;
1022 }
1023
1024 } // End namespace gold.