gold/plugin.cc

   1 // plugin.cc -- plugin manager for gold      -*- C++ -*-
   2
   3 // Copyright (C) 2008-2014 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 "gold.h"
  24
  25 #include <cstdio>
  26 #include <cstdarg>
  27 #include <cstring>
  28 #include <string>
  29 #include <vector>
  30
  31 #ifdef ENABLE_PLUGINS
  32 #ifdef HAVE_DLFCN_H
  33 #include <dlfcn.h>
  34 #elif defined (HAVE_WINDOWS_H)
  35 #include <windows.h>
  36 #else
  37 #error Unknown how to handle dynamic-load-libraries.
  38 #endif
  39
  40 #if !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)
  41
  42 #define RTLD_NOW 0      /* Dummy value.  */
  43 static void *
  44 dlopen(const char *file, int mode ATTRIBUTE_UNUSED)
  45 {
  46   return LoadLibrary(file);
  47 }
  48
  49 static void *
  50 dlsym(void *handle, const char *name)
  51 {
  52   return reinterpret_cast<void *>(
  53      GetProcAddress(static_cast<HMODULE>(handle),name));
  54 }
  55
  56 static const char *
  57 dlerror(void)
  58 {
  59   return "unable to load dll";
  60 }
  61
  62 #endif /* !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)  */
  63 #endif /* ENABLE_PLUGINS */
  64
  65 #include "parameters.h"
  66 #include "errors.h"
  67 #include "fileread.h"
  68 #include "layout.h"
  69 #include "options.h"
  70 #include "plugin.h"
  71 #include "target.h"
  72 #include "readsyms.h"
  73 #include "symtab.h"
  74 #include "descriptors.h"
  75 #include "elfcpp.h"
  76
  77 namespace gold
  78 {
  79
  80 #ifdef ENABLE_PLUGINS
  81
  82 // The linker's exported interfaces.
  83
  84 extern "C"
  85 {
  86
  87 static enum ld_plugin_status
  88 register_claim_file(ld_plugin_claim_file_handler handler);
  89
  90 static enum ld_plugin_status
  91 register_all_symbols_read(ld_plugin_all_symbols_read_handler handler);
  92
  93 static enum ld_plugin_status
  94 register_cleanup(ld_plugin_cleanup_handler handler);
  95
  96 static enum ld_plugin_status
  97 add_symbols(void *handle, int nsyms, const struct ld_plugin_symbol *syms);
  98
  99 static enum ld_plugin_status
 100 get_input_file(const void *handle, struct ld_plugin_input_file *file);
 101
 102 static enum ld_plugin_status
 103 get_view(const void *handle, const void **viewp);
 104
 105 static enum ld_plugin_status
 106 release_input_file(const void *handle);
 107
 108 static enum ld_plugin_status
 109 get_symbols(const void *handle, int nsyms, struct ld_plugin_symbol *syms);
 110
 111 static enum ld_plugin_status
 112 get_symbols_v2(const void *handle, int nsyms, struct ld_plugin_symbol *syms);
 113
 114 static enum ld_plugin_status
 115 add_input_file(const char *pathname);
 116
 117 static enum ld_plugin_status
 118 add_input_library(const char *pathname);
 119
 120 static enum ld_plugin_status
 121 set_extra_library_path(const char *path);
 122
 123 static enum ld_plugin_status
 124 message(int level, const char *format, ...);
 125
 126 static enum ld_plugin_status
 127 get_input_section_count(const void* handle, unsigned int* count);
 128
 129 static enum ld_plugin_status
 130 get_input_section_type(const struct ld_plugin_section section,
 131                        unsigned int* type);
 132
 133 static enum ld_plugin_status
 134 get_input_section_name(const struct ld_plugin_section section,
 135                        char** section_name_ptr);
 136
 137 static enum ld_plugin_status
 138 get_input_section_contents(const struct ld_plugin_section section,
 139                            const unsigned char** section_contents,
 140                            size_t* len);
 141
 142 static enum ld_plugin_status
 143 update_section_order(const struct ld_plugin_section *section_list,
 144                      unsigned int num_sections);
 145
 146 static enum ld_plugin_status
 147 allow_section_ordering();
 148
 149 static enum ld_plugin_status
 150 allow_unique_segment_for_sections();
 151
 152 static enum ld_plugin_status
 153 unique_segment_for_sections(const char* segment_name,
 154                             uint64_t flags,
 155                             uint64_t align,
 156                             const struct ld_plugin_section *section_list,
 157                             unsigned int num_sections);
 158 };
 159
 160 #endif // ENABLE_PLUGINS
 161
 162 static Pluginobj* make_sized_plugin_object(Input_file* input_file,
 163                                            off_t offset, off_t filesize);
 164
 165 // Plugin methods.
 166
 167 // Load one plugin library.
 168
 169 void
 170 Plugin::load()
 171 {
 172 #ifdef ENABLE_PLUGINS
 173   // Load the plugin library.
 174   // FIXME: Look for the library in standard locations.
 175   this->handle_ = dlopen(this->filename_.c_str(), RTLD_NOW);
 176   if (this->handle_ == NULL)
 177     {
 178       gold_error(_("%s: could not load plugin library: %s"),
 179                  this->filename_.c_str(), dlerror());
 180       return;
 181     }
 182
 183   // Find the plugin's onload entry point.
 184   void* ptr = dlsym(this->handle_, "onload");
 185   if (ptr == NULL)
 186     {
 187       gold_error(_("%s: could not find onload entry point"),
 188                  this->filename_.c_str());
 189       return;
 190     }
 191   ld_plugin_onload onload;
 192   gold_assert(sizeof(onload) == sizeof(ptr));
 193   memcpy(&onload, &ptr, sizeof(ptr));
 194
 195   // Get the linker's version number.
 196   const char* ver = get_version_string();
 197   int major = 0;
 198   int minor = 0;
 199   sscanf(ver, "%d.%d", &major, &minor);
 200
 201   // Allocate and populate a transfer vector.
 202   const int tv_fixed_size = 26;
 203
 204   int tv_size = this->args_.size() + tv_fixed_size;
 205   ld_plugin_tv* tv = new ld_plugin_tv[tv_size];
 206
 207   // Put LDPT_MESSAGE at the front of the list so the plugin can use it
 208   // while processing subsequent entries.
 209   int i = 0;
 210   tv[i].tv_tag = LDPT_MESSAGE;
 211   tv[i].tv_u.tv_message = message;
 212
 213   ++i;
 214   tv[i].tv_tag = LDPT_API_VERSION;
 215   tv[i].tv_u.tv_val = LD_PLUGIN_API_VERSION;
 216
 217   ++i;
 218   tv[i].tv_tag = LDPT_GOLD_VERSION;
 219   tv[i].tv_u.tv_val = major * 100 + minor;
 220
 221   ++i;
 222   tv[i].tv_tag = LDPT_LINKER_OUTPUT;
 223   if (parameters->options().relocatable())
 224     tv[i].tv_u.tv_val = LDPO_REL;
 225   else if (parameters->options().shared())
 226     tv[i].tv_u.tv_val = LDPO_DYN;
 227   else if (parameters->options().pie())
 228     tv[i].tv_u.tv_val = LDPO_PIE;
 229   else
 230     tv[i].tv_u.tv_val = LDPO_EXEC;
 231
 232   ++i;
 233   tv[i].tv_tag = LDPT_OUTPUT_NAME;
 234   tv[i].tv_u.tv_string = parameters->options().output();
 235
 236   for (unsigned int j = 0; j < this->args_.size(); ++j)
 237     {
 238       ++i;
 239       tv[i].tv_tag = LDPT_OPTION;
 240       tv[i].tv_u.tv_string = this->args_[j].c_str();
 241     }
 242
 243   ++i;
 244   tv[i].tv_tag = LDPT_REGISTER_CLAIM_FILE_HOOK;
 245   tv[i].tv_u.tv_register_claim_file = register_claim_file;
 246
 247   ++i;
 248   tv[i].tv_tag = LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK;
 249   tv[i].tv_u.tv_register_all_symbols_read = register_all_symbols_read;
 250
 251   ++i;
 252   tv[i].tv_tag = LDPT_REGISTER_CLEANUP_HOOK;
 253   tv[i].tv_u.tv_register_cleanup = register_cleanup;
 254
 255   ++i;
 256   tv[i].tv_tag = LDPT_ADD_SYMBOLS;
 257   tv[i].tv_u.tv_add_symbols = add_symbols;
 258
 259   ++i;
 260   tv[i].tv_tag = LDPT_GET_INPUT_FILE;
 261   tv[i].tv_u.tv_get_input_file = get_input_file;
 262
 263   ++i;
 264   tv[i].tv_tag = LDPT_GET_VIEW;
 265   tv[i].tv_u.tv_get_view = get_view;
 266
 267   ++i;
 268   tv[i].tv_tag = LDPT_RELEASE_INPUT_FILE;
 269   tv[i].tv_u.tv_release_input_file = release_input_file;
 270
 271   ++i;
 272   tv[i].tv_tag = LDPT_GET_SYMBOLS;
 273   tv[i].tv_u.tv_get_symbols = get_symbols;
 274
 275   ++i;
 276   tv[i].tv_tag = LDPT_GET_SYMBOLS_V2;
 277   tv[i].tv_u.tv_get_symbols = get_symbols_v2;
 278
 279   ++i;
 280   tv[i].tv_tag = LDPT_ADD_INPUT_FILE;
 281   tv[i].tv_u.tv_add_input_file = add_input_file;
 282
 283   ++i;
 284   tv[i].tv_tag = LDPT_ADD_INPUT_LIBRARY;
 285   tv[i].tv_u.tv_add_input_library = add_input_library;
 286
 287   ++i;
 288   tv[i].tv_tag = LDPT_SET_EXTRA_LIBRARY_PATH;
 289   tv[i].tv_u.tv_set_extra_library_path = set_extra_library_path;
 290
 291   ++i;
 292   tv[i].tv_tag = LDPT_GET_INPUT_SECTION_COUNT;
 293   tv[i].tv_u.tv_get_input_section_count = get_input_section_count;
 294
 295   ++i;
 296   tv[i].tv_tag = LDPT_GET_INPUT_SECTION_TYPE;
 297   tv[i].tv_u.tv_get_input_section_type = get_input_section_type;
 298
 299   ++i;
 300   tv[i].tv_tag = LDPT_GET_INPUT_SECTION_NAME;
 301   tv[i].tv_u.tv_get_input_section_name = get_input_section_name;
 302
 303   ++i;
 304   tv[i].tv_tag = LDPT_GET_INPUT_SECTION_CONTENTS;
 305   tv[i].tv_u.tv_get_input_section_contents = get_input_section_contents;
 306
 307   ++i;
 308   tv[i].tv_tag = LDPT_UPDATE_SECTION_ORDER;
 309   tv[i].tv_u.tv_update_section_order = update_section_order;
 310
 311   ++i;
 312   tv[i].tv_tag = LDPT_ALLOW_SECTION_ORDERING;
 313   tv[i].tv_u.tv_allow_section_ordering = allow_section_ordering;
 314
 315   ++i;
 316   tv[i].tv_tag = LDPT_ALLOW_UNIQUE_SEGMENT_FOR_SECTIONS;
 317   tv[i].tv_u.tv_allow_unique_segment_for_sections
 318     = allow_unique_segment_for_sections;
 319
 320   ++i;
 321   tv[i].tv_tag = LDPT_UNIQUE_SEGMENT_FOR_SECTIONS;
 322   tv[i].tv_u.tv_unique_segment_for_sections = unique_segment_for_sections;
 323
 324   ++i;
 325   tv[i].tv_tag = LDPT_NULL;
 326   tv[i].tv_u.tv_val = 0;
 327
 328   gold_assert(i == tv_size - 1);
 329
 330   // Call the onload entry point.
 331   (*onload)(tv);
 332
 333   delete[] tv;
 334 #endif // ENABLE_PLUGINS
 335 }
 336
 337 // Call the plugin claim-file handler.
 338
 339 inline bool
 340 Plugin::claim_file(struct ld_plugin_input_file* plugin_input_file)
 341 {
 342   int claimed = 0;
 343
 344   if (this->claim_file_handler_ != NULL)
 345     {
 346       (*this->claim_file_handler_)(plugin_input_file, &claimed);
 347       if (claimed)
 348         return true;
 349     }
 350   return false;
 351 }
 352
 353 // Call the all-symbols-read handler.
 354
 355 inline void
 356 Plugin::all_symbols_read()
 357 {
 358   if (this->all_symbols_read_handler_ != NULL)
 359     (*this->all_symbols_read_handler_)();
 360 }
 361
 362 // Call the cleanup handler.
 363
 364 inline void
 365 Plugin::cleanup()
 366 {
 367   if (this->cleanup_handler_ != NULL && !this->cleanup_done_)
 368     {
 369       // Set this flag before calling to prevent a recursive plunge
 370       // in the event that a plugin's cleanup handler issues a
 371       // fatal error.
 372       this->cleanup_done_ = true;
 373       (*this->cleanup_handler_)();
 374     }
 375 }
 376
 377 // This task is used to rescan archives as needed.
 378
 379 class Plugin_rescan : public Task
 380 {
 381  public:
 382   Plugin_rescan(Task_token* this_blocker, Task_token* next_blocker)
 383     : this_blocker_(this_blocker), next_blocker_(next_blocker)
 384   { }
 385
 386   ~Plugin_rescan()
 387   {
 388     delete this->this_blocker_;
 389   }
 390
 391   Task_token*
 392   is_runnable()
 393   {
 394     if (this->this_blocker_->is_blocked())
 395       return this->this_blocker_;
 396     return NULL;
 397   }
 398
 399   void
 400   locks(Task_locker* tl)
 401   { tl->add(this, this->next_blocker_); }
 402
 403   void
 404   run(Workqueue*)
 405   { parameters->options().plugins()->rescan(this); }
 406
 407   std::string
 408   get_name() const
 409   { return "Plugin_rescan"; }
 410
 411  private:
 412   Task_token* this_blocker_;
 413   Task_token* next_blocker_;
 414 };
 415
 416 // Plugin_manager methods.
 417
 418 Plugin_manager::~Plugin_manager()
 419 {
 420   for (Plugin_list::iterator p = this->plugins_.begin();
 421        p != this->plugins_.end();
 422        ++p)
 423     delete *p;
 424   this->plugins_.clear();
 425   for (Object_list::iterator obj = this->objects_.begin();
 426        obj != this->objects_.end();
 427        ++obj)
 428     delete *obj;
 429   this->objects_.clear();
 430 }
 431
 432 // Load all plugin libraries.
 433
 434 void
 435 Plugin_manager::load_plugins(Layout* layout)
 436 {
 437   this->layout_ = layout;
 438   for (this->current_ = this->plugins_.begin();
 439        this->current_ != this->plugins_.end();
 440        ++this->current_)
 441     (*this->current_)->load();
 442 }
 443
 444 // Call the plugin claim-file handlers in turn to see if any claim the file.
 445
 446 Pluginobj*
 447 Plugin_manager::claim_file(Input_file* input_file, off_t offset,
 448                            off_t filesize, Object* elf_object)
 449 {
 450   if (this->in_replacement_phase_)
 451     return NULL;
 452
 453   unsigned int handle = this->objects_.size();
 454   this->input_file_ = input_file;
 455   this->plugin_input_file_.name = input_file->filename().c_str();
 456   this->plugin_input_file_.fd = input_file->file().descriptor();
 457   this->plugin_input_file_.offset = offset;
 458   this->plugin_input_file_.filesize = filesize;
 459   this->plugin_input_file_.handle = reinterpret_cast<void*>(handle);
 460   if (elf_object != NULL)
 461     this->objects_.push_back(elf_object);
 462   this->in_claim_file_handler_ = true;
 463
 464   for (this->current_ = this->plugins_.begin();
 465        this->current_ != this->plugins_.end();
 466        ++this->current_)
 467     {
 468       if ((*this->current_)->claim_file(&this->plugin_input_file_))
 469         {
 470           this->any_claimed_ = true;
 471           this->in_claim_file_handler_ = false;
 472
 473           if (this->objects_.size() > handle
 474               && this->objects_[handle]->pluginobj() != NULL)
 475             return this->objects_[handle]->pluginobj();
 476
 477           // If the plugin claimed the file but did not call the
 478           // add_symbols callback, we need to create the Pluginobj now.
 479           Pluginobj* obj = this->make_plugin_object(handle);
 480           return obj;
 481         }
 482     }
 483
 484   this->in_claim_file_handler_ = false;
 485   return NULL;
 486 }
 487
 488 // Save an archive.  This is used so that a plugin can add a file
 489 // which refers to a symbol which was not previously referenced.  In
 490 // that case we want to pretend that the symbol was referenced before,
 491 // and pull in the archive object.
 492
 493 void
 494 Plugin_manager::save_archive(Archive* archive)
 495 {
 496   if (this->in_replacement_phase_ || !this->any_claimed_)
 497     delete archive;
 498   else
 499     this->rescannable_.push_back(Rescannable(archive));
 500 }
 501
 502 // Save an Input_group.  This is like save_archive.
 503
 504 void
 505 Plugin_manager::save_input_group(Input_group* input_group)
 506 {
 507   if (this->in_replacement_phase_ || !this->any_claimed_)
 508     delete input_group;
 509   else
 510     this->rescannable_.push_back(Rescannable(input_group));
 511 }
 512
 513 // Call the all-symbols-read handlers.
 514
 515 void
 516 Plugin_manager::all_symbols_read(Workqueue* workqueue, Task* task,
 517                                  Input_objects* input_objects,
 518                                  Symbol_table* symtab,
 519                                  Dirsearch* dirpath, Mapfile* mapfile,
 520                                  Task_token** last_blocker)
 521 {
 522   this->in_replacement_phase_ = true;
 523   this->workqueue_ = workqueue;
 524   this->task_ = task;
 525   this->input_objects_ = input_objects;
 526   this->symtab_ = symtab;
 527   this->dirpath_ = dirpath;
 528   this->mapfile_ = mapfile;
 529   this->this_blocker_ = NULL;
 530
 531   for (this->current_ = this->plugins_.begin();
 532        this->current_ != this->plugins_.end();
 533        ++this->current_)
 534     (*this->current_)->all_symbols_read();
 535
 536   if (this->any_added_)
 537     {
 538       Task_token* next_blocker = new Task_token(true);
 539       next_blocker->add_blocker();
 540       workqueue->queue(new Plugin_rescan(this->this_blocker_, next_blocker));
 541       this->this_blocker_ = next_blocker;
 542     }
 543
 544   *last_blocker = this->this_blocker_;
 545 }
 546
 547 // This is called when we see a new undefined symbol.  If we are in
 548 // the replacement phase, this means that we may need to rescan some
 549 // archives we have previously seen.
 550
 551 void
 552 Plugin_manager::new_undefined_symbol(Symbol* sym)
 553 {
 554   if (this->in_replacement_phase_)
 555     this->undefined_symbols_.push_back(sym);
 556 }
 557
 558 // Rescan archives as needed.  This handles the case where a new
 559 // object file added by a plugin has an undefined reference to some
 560 // symbol defined in an archive.
 561
 562 void
 563 Plugin_manager::rescan(Task* task)
 564 {
 565   size_t rescan_pos = 0;
 566   size_t rescan_size = this->rescannable_.size();
 567   while (!this->undefined_symbols_.empty())
 568     {
 569       if (rescan_pos >= rescan_size)
 570         {
 571           this->undefined_symbols_.clear();
 572           return;
 573         }
 574
 575       Undefined_symbol_list undefs;
 576       undefs.reserve(this->undefined_symbols_.size());
 577       this->undefined_symbols_.swap(undefs);
 578
 579       size_t min_rescan_pos = rescan_size;
 580
 581       for (Undefined_symbol_list::const_iterator p = undefs.begin();
 582            p != undefs.end();
 583            ++p)
 584         {
 585           if (!(*p)->is_undefined())
 586             continue;
 587
 588           this->undefined_symbols_.push_back(*p);
 589
 590           // Find the first rescan archive which defines this symbol,
 591           // starting at the current rescan position.  The rescan position
 592           // exists so that given -la -lb -lc we don't look for undefined
 593           // symbols in -lb back in -la, but instead get the definition
 594           // from -lc.  Don't bother to look past the current minimum
 595           // rescan position.
 596           for (size_t i = rescan_pos; i < min_rescan_pos; ++i)
 597             {
 598               if (this->rescannable_defines(i, *p))
 599                 {
 600                   min_rescan_pos = i;
 601                   break;
 602                 }
 603             }
 604         }
 605
 606       if (min_rescan_pos >= rescan_size)
 607         {
 608           // We didn't find any rescannable archives which define any
 609           // undefined symbols.
 610           return;
 611         }
 612
 613       const Rescannable& r(this->rescannable_[min_rescan_pos]);
 614       if (r.is_archive)
 615         {
 616           Task_lock_obj<Archive> tl(task, r.u.archive);
 617           r.u.archive->add_symbols(this->symtab_, this->layout_,
 618                                    this->input_objects_, this->mapfile_);
 619         }
 620       else
 621         {
 622           size_t next_saw_undefined = this->symtab_->saw_undefined();
 623           size_t saw_undefined;
 624           do
 625             {
 626               saw_undefined = next_saw_undefined;
 627
 628               for (Input_group::const_iterator p = r.u.input_group->begin();
 629                    p != r.u.input_group->end();
 630                    ++p)
 631                 {
 632                   Task_lock_obj<Archive> tl(task, *p);
 633
 634                   (*p)->add_symbols(this->symtab_, this->layout_,
 635                                     this->input_objects_, this->mapfile_);
 636                 }
 637
 638               next_saw_undefined = this->symtab_->saw_undefined();
 639             }
 640           while (saw_undefined != next_saw_undefined);
 641         }
 642
 643       for (size_t i = rescan_pos; i < min_rescan_pos + 1; ++i)
 644         {
 645           if (this->rescannable_[i].is_archive)
 646             delete this->rescannable_[i].u.archive;
 647           else
 648             delete this->rescannable_[i].u.input_group;
 649         }
 650
 651       rescan_pos = min_rescan_pos + 1;
 652     }
 653 }
 654
 655 // Return whether the rescannable at index I defines SYM.
 656
 657 bool
 658 Plugin_manager::rescannable_defines(size_t i, Symbol* sym)
 659 {
 660   const Rescannable& r(this->rescannable_[i]);
 661   if (r.is_archive)
 662     return r.u.archive->defines_symbol(sym);
 663   else
 664     {
 665       for (Input_group::const_iterator p = r.u.input_group->begin();
 666            p != r.u.input_group->end();
 667            ++p)
 668         {
 669           if ((*p)->defines_symbol(sym))
 670             return true;
 671         }
 672       return false;
 673     }
 674 }
 675
 676 // Layout deferred objects.
 677
 678 void
 679 Plugin_manager::layout_deferred_objects()
 680 {
 681   Deferred_layout_list::iterator obj;
 682
 683   for (obj = this->deferred_layout_objects_.begin();
 684        obj != this->deferred_layout_objects_.end();
 685        ++obj)
 686     {
 687       // Lock the object so we can read from it.  This is only called
 688       // single-threaded from queue_middle_tasks, so it is OK to lock.
 689       // Unfortunately we have no way to pass in a Task token.
 690       const Task* dummy_task = reinterpret_cast<const Task*>(-1);
 691       Task_lock_obj<Object> tl(dummy_task, *obj);
 692       (*obj)->layout_deferred_sections(this->layout_);
 693     }
 694 }
 695
 696 // Call the cleanup handlers.
 697
 698 void
 699 Plugin_manager::cleanup()
 700 {
 701   if (this->any_added_)
 702     {
 703       // If any input files were added, close all the input files.
 704       // This is because the plugin may want to remove them, and on
 705       // Windows you are not allowed to remove an open file.
 706       close_all_descriptors();
 707     }
 708
 709   for (this->current_ = this->plugins_.begin();
 710        this->current_ != this->plugins_.end();
 711        ++this->current_)
 712     (*this->current_)->cleanup();
 713 }
 714
 715 // Make a new Pluginobj object.  This is called when the plugin calls
 716 // the add_symbols API.
 717
 718 Pluginobj*
 719 Plugin_manager::make_plugin_object(unsigned int handle)
 720 {
 721   // Make sure we aren't asked to make an object for the same handle twice.
 722   if (this->objects_.size() != handle
 723       && this->objects_[handle]->pluginobj() != NULL)
 724     return NULL;
 725
 726   Pluginobj* obj = make_sized_plugin_object(this->input_file_,
 727                                             this->plugin_input_file_.offset,
 728                                             this->plugin_input_file_.filesize);
 729
 730
 731   // If the elf object for this file was pushed into the objects_ vector, delete
 732   // it to make room for the Pluginobj as this file is claimed.
 733   if (this->objects_.size() != handle)
 734     this->objects_.pop_back();
 735
 736   this->objects_.push_back(obj);
 737   return obj;
 738 }
 739
 740 // Get the input file information with an open (possibly re-opened)
 741 // file descriptor.
 742
 743 ld_plugin_status
 744 Plugin_manager::get_input_file(unsigned int handle,
 745                                struct ld_plugin_input_file* file)
 746 {
 747   Pluginobj* obj = this->object(handle)->pluginobj();
 748   if (obj == NULL)
 749     return LDPS_BAD_HANDLE;
 750
 751   obj->lock(this->task_);
 752   file->name = obj->filename().c_str();
 753   file->fd = obj->descriptor();
 754   file->offset = obj->offset();
 755   file->filesize = obj->filesize();
 756   file->handle = reinterpret_cast<void*>(handle);
 757   return LDPS_OK;
 758 }
 759
 760 // Release the input file.
 761
 762 ld_plugin_status
 763 Plugin_manager::release_input_file(unsigned int handle)
 764 {
 765   if (this->object(handle) == NULL)
 766     return LDPS_BAD_HANDLE;
 767
 768   Pluginobj* obj = this->object(handle)->pluginobj();
 769
 770   if (obj == NULL)
 771     return LDPS_BAD_HANDLE;
 772
 773   obj->unlock(this->task_);
 774   return LDPS_OK;
 775 }
 776
 777 // Get the elf object corresponding to the handle. Return NULL if we
 778 // found a Pluginobj instead.
 779
 780 Object*
 781 Plugin_manager::get_elf_object(const void* handle)
 782 {
 783   Object* obj = this->object(
 784       static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
 785
 786   // The object should not be a Pluginobj.
 787   if (obj == NULL
 788       || obj->pluginobj() != NULL)
 789     return NULL;
 790
 791   return obj;
 792 }
 793
 794 ld_plugin_status
 795 Plugin_manager::get_view(unsigned int handle, const void **viewp)
 796 {
 797   off_t offset;
 798   size_t filesize;
 799   Input_file *input_file;
 800   if (this->in_claim_file_handler_)
 801     {
 802       // We are being called from the claim_file hook.
 803       const struct ld_plugin_input_file &f = this->plugin_input_file_;
 804       offset = f.offset;
 805       filesize = f.filesize;
 806       input_file = this->input_file_;
 807     }
 808   else
 809     {
 810       // An already claimed file.
 811       if (this->object(handle) == NULL)
 812         return LDPS_BAD_HANDLE;
 813       Pluginobj* obj = this->object(handle)->pluginobj();
 814       if (obj == NULL)
 815         return LDPS_BAD_HANDLE;
 816       offset = obj->offset();
 817       filesize = obj->filesize();
 818       input_file = obj->input_file();
 819     }
 820   *viewp = (void*) input_file->file().get_view(offset, 0, filesize, false,
 821                                                false);
 822   return LDPS_OK;
 823 }
 824
 825 // Add a new library path.
 826
 827 ld_plugin_status
 828 Plugin_manager::set_extra_library_path(const char* path)
 829 {
 830   this->extra_search_path_ = std::string(path);
 831   return LDPS_OK;
 832 }
 833
 834 // Add a new input file.
 835
 836 ld_plugin_status
 837 Plugin_manager::add_input_file(const char* pathname, bool is_lib)
 838 {
 839   Input_file_argument file(pathname,
 840                            (is_lib
 841                             ? Input_file_argument::INPUT_FILE_TYPE_LIBRARY
 842                             : Input_file_argument::INPUT_FILE_TYPE_FILE),
 843                            (is_lib
 844                             ? this->extra_search_path_.c_str()
 845                             : ""),
 846                            false,
 847                            this->options_);
 848   Input_argument* input_argument = new Input_argument(file);
 849   Task_token* next_blocker = new Task_token(true);
 850   next_blocker->add_blocker();
 851   if (parameters->incremental())
 852     gold_error(_("input files added by plug-ins in --incremental mode not "
 853                  "supported yet"));
 854   this->workqueue_->queue_soon(new Read_symbols(this->input_objects_,
 855                                                 this->symtab_,
 856                                                 this->layout_,
 857                                                 this->dirpath_,
 858                                                 0,
 859                                                 this->mapfile_,
 860                                                 input_argument,
 861                                                 NULL,
 862                                                 NULL,
 863                                                 this->this_blocker_,
 864                                                 next_blocker));
 865   this->this_blocker_ = next_blocker;
 866   this->any_added_ = true;
 867   return LDPS_OK;
 868 }
 869
 870 // Class Pluginobj.
 871
 872 Pluginobj::Pluginobj(const std::string& name, Input_file* input_file,
 873                      off_t offset, off_t filesize)
 874   : Object(name, input_file, false, offset),
 875     nsyms_(0), syms_(NULL), symbols_(), filesize_(filesize), comdat_map_()
 876 {
 877 }
 878
 879 // Return TRUE if a defined symbol is referenced from outside the
 880 // universe of claimed objects.  Only references from relocatable,
 881 // non-IR (unclaimed) objects count as a reference.  References from
 882 // dynamic objects count only as "visible".
 883
 884 static inline bool
 885 is_referenced_from_outside(Symbol* lsym)
 886 {
 887   if (lsym->in_real_elf())
 888     return true;
 889   if (parameters->options().relocatable())
 890     return true;
 891   if (parameters->options().is_undefined(lsym->name()))
 892     return true;
 893   return false;
 894 }
 895
 896 // Return TRUE if a defined symbol might be reachable from outside the
 897 // load module.
 898
 899 static inline bool
 900 is_visible_from_outside(Symbol* lsym)
 901 {
 902   if (lsym->in_dyn())
 903     return true;
 904   if (parameters->options().export_dynamic() || parameters->options().shared())
 905     return lsym->is_externally_visible();
 906   return false;
 907 }
 908
 909 // Get symbol resolution info.
 910
 911 ld_plugin_status
 912 Pluginobj::get_symbol_resolution_info(int nsyms,
 913                                       ld_plugin_symbol* syms,
 914                                       int version) const
 915 {
 916   // For version 1 of this interface, we cannot use
 917   // LDPR_PREVAILING_DEF_IRONLY_EXP, so we return LDPR_PREVAILING_DEF
 918   // instead.
 919   const ld_plugin_symbol_resolution ldpr_prevailing_def_ironly_exp
 920       = (version > 1
 921          ? LDPR_PREVAILING_DEF_IRONLY_EXP
 922          : LDPR_PREVAILING_DEF);
 923
 924   if (nsyms > this->nsyms_)
 925     return LDPS_NO_SYMS;
 926
 927   if (static_cast<size_t>(nsyms) > this->symbols_.size())
 928     {
 929       // We never decided to include this object. We mark all symbols as
 930       // preempted.
 931       gold_assert(this->symbols_.size() == 0);
 932       for (int i = 0; i < nsyms; i++)
 933         syms[i].resolution = LDPR_PREEMPTED_REG;
 934       return LDPS_OK;
 935     }
 936
 937   for (int i = 0; i < nsyms; i++)
 938     {
 939       ld_plugin_symbol* isym = &syms[i];
 940       Symbol* lsym = this->symbols_[i];
 941       ld_plugin_symbol_resolution res = LDPR_UNKNOWN;
 942
 943       if (lsym->is_undefined())
 944         // The symbol remains undefined.
 945         res = LDPR_UNDEF;
 946       else if (isym->def == LDPK_UNDEF
 947                || isym->def == LDPK_WEAKUNDEF
 948                || isym->def == LDPK_COMMON)
 949         {
 950           // The original symbol was undefined or common.
 951           if (lsym->source() != Symbol::FROM_OBJECT)
 952             res = LDPR_RESOLVED_EXEC;
 953           else if (lsym->object()->pluginobj() == this)
 954             {
 955               if (is_referenced_from_outside(lsym))
 956                 res = LDPR_PREVAILING_DEF;
 957               else if (is_visible_from_outside(lsym))
 958                 res = ldpr_prevailing_def_ironly_exp;
 959               else
 960                 res = LDPR_PREVAILING_DEF_IRONLY;
 961             }
 962           else if (lsym->object()->pluginobj() != NULL)
 963             res = LDPR_RESOLVED_IR;
 964           else if (lsym->object()->is_dynamic())
 965             res = LDPR_RESOLVED_DYN;
 966           else
 967             res = LDPR_RESOLVED_EXEC;
 968         }
 969       else
 970         {
 971           // The original symbol was a definition.
 972           if (lsym->source() != Symbol::FROM_OBJECT)
 973             res = LDPR_PREEMPTED_REG;
 974           else if (lsym->object() == static_cast<const Object*>(this))
 975             {
 976               if (is_referenced_from_outside(lsym))
 977                 res = LDPR_PREVAILING_DEF;
 978               else if (is_visible_from_outside(lsym))
 979                 res = ldpr_prevailing_def_ironly_exp;
 980               else
 981                 res = LDPR_PREVAILING_DEF_IRONLY;
 982             }
 983           else
 984             res = (lsym->object()->pluginobj() != NULL
 985                    ? LDPR_PREEMPTED_IR
 986                    : LDPR_PREEMPTED_REG);
 987         }
 988       isym->resolution = res;
 989     }
 990   return LDPS_OK;
 991 }
 992
 993 // Return TRUE if the comdat group with key COMDAT_KEY from this object
 994 // should be kept.
 995
 996 bool
 997 Pluginobj::include_comdat_group(std::string comdat_key, Layout* layout)
 998 {
 999   std::pair<Comdat_map::iterator, bool> ins =
1000     this->comdat_map_.insert(std::make_pair(comdat_key, false));
1001
1002   // If this is the first time we've seen this comdat key, ask the
1003   // layout object whether it should be included.
1004   if (ins.second)
1005     ins.first->second = layout->find_or_add_kept_section(comdat_key,
1006                                                          NULL, 0, true,
1007                                                          true, NULL);
1008
1009   return ins.first->second;
1010 }
1011
1012 // Class Sized_pluginobj.
1013
1014 template<int size, bool big_endian>
1015 Sized_pluginobj<size, big_endian>::Sized_pluginobj(
1016     const std::string& name,
1017     Input_file* input_file,
1018     off_t offset,
1019     off_t filesize)
1020   : Pluginobj(name, input_file, offset, filesize)
1021 {
1022 }
1023
1024 // Read the symbols.  Not used for plugin objects.
1025
1026 template<int size, bool big_endian>
1027 void
1028 Sized_pluginobj<size, big_endian>::do_read_symbols(Read_symbols_data*)
1029 {
1030   gold_unreachable();
1031 }
1032
1033 // Lay out the input sections.  Not used for plugin objects.
1034
1035 template<int size, bool big_endian>
1036 void
1037 Sized_pluginobj<size, big_endian>::do_layout(Symbol_table*, Layout*,
1038                                              Read_symbols_data*)
1039 {
1040   gold_unreachable();
1041 }
1042
1043 // Add the symbols to the symbol table.
1044
1045 template<int size, bool big_endian>
1046 void
1047 Sized_pluginobj<size, big_endian>::do_add_symbols(Symbol_table* symtab,
1048                                                   Read_symbols_data*,
1049                                                   Layout* layout)
1050 {
1051   const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
1052   unsigned char symbuf[sym_size];
1053   elfcpp::Sym<size, big_endian> sym(symbuf);
1054   elfcpp::Sym_write<size, big_endian> osym(symbuf);
1055
1056   this->symbols_.resize(this->nsyms_);
1057
1058   for (int i = 0; i < this->nsyms_; ++i)
1059     {
1060       const struct ld_plugin_symbol* isym = &this->syms_[i];
1061       const char* name = isym->name;
1062       const char* ver = isym->version;
1063       elfcpp::Elf_Half shndx;
1064       elfcpp::STB bind;
1065       elfcpp::STV vis;
1066
1067       if (name != NULL && name[0] == '\0')
1068         name = NULL;
1069       if (ver != NULL && ver[0] == '\0')
1070         ver = NULL;
1071
1072       switch (isym->def)
1073         {
1074         case LDPK_WEAKDEF:
1075         case LDPK_WEAKUNDEF:
1076           bind = elfcpp::STB_WEAK;
1077           break;
1078         case LDPK_DEF:
1079         case LDPK_UNDEF:
1080         case LDPK_COMMON:
1081         default:
1082           bind = elfcpp::STB_GLOBAL;
1083           break;
1084         }
1085
1086       switch (isym->def)
1087         {
1088         case LDPK_DEF:
1089         case LDPK_WEAKDEF:
1090           shndx = elfcpp::SHN_ABS;
1091           break;
1092         case LDPK_COMMON:
1093           shndx = elfcpp::SHN_COMMON;
1094           break;
1095         case LDPK_UNDEF:
1096         case LDPK_WEAKUNDEF:
1097         default:
1098           shndx = elfcpp::SHN_UNDEF;
1099           break;
1100         }
1101
1102       switch (isym->visibility)
1103         {
1104         case LDPV_PROTECTED:
1105           vis = elfcpp::STV_PROTECTED;
1106           break;
1107         case LDPV_INTERNAL:
1108           vis = elfcpp::STV_INTERNAL;
1109           break;
1110         case LDPV_HIDDEN:
1111           vis = elfcpp::STV_HIDDEN;
1112           break;
1113         case LDPV_DEFAULT:
1114         default:
1115           vis = elfcpp::STV_DEFAULT;
1116           break;
1117         }
1118
1119       if (isym->comdat_key != NULL
1120           && isym->comdat_key[0] != '\0'
1121           && !this->include_comdat_group(isym->comdat_key, layout))
1122         shndx = elfcpp::SHN_UNDEF;
1123
1124       osym.put_st_name(0);
1125       osym.put_st_value(0);
1126       osym.put_st_size(0);
1127       osym.put_st_info(bind, elfcpp::STT_NOTYPE);
1128       osym.put_st_other(vis, 0);
1129       osym.put_st_shndx(shndx);
1130
1131       this->symbols_[i] =
1132         symtab->add_from_pluginobj<size, big_endian>(this, name, ver, &sym);
1133     }
1134 }
1135
1136 template<int size, bool big_endian>
1137 Archive::Should_include
1138 Sized_pluginobj<size, big_endian>::do_should_include_member(
1139     Symbol_table* symtab,
1140     Layout* layout,
1141     Read_symbols_data*,
1142     std::string* why)
1143 {
1144   char* tmpbuf = NULL;
1145   size_t tmpbuflen = 0;
1146
1147   for (int i = 0; i < this->nsyms_; ++i)
1148     {
1149       const struct ld_plugin_symbol& sym = this->syms_[i];
1150       const char* name = sym.name;
1151       Symbol* symbol;
1152       Archive::Should_include t = Archive::should_include_member(symtab,
1153                                                                  layout,
1154                                                                  name,
1155                                                                  &symbol, why,
1156                                                                  &tmpbuf,
1157                                                                  &tmpbuflen);
1158       if (t == Archive::SHOULD_INCLUDE_YES)
1159         {
1160           if (tmpbuf != NULL)
1161             free(tmpbuf);
1162           return t;
1163         }
1164     }
1165   if (tmpbuf != NULL)
1166     free(tmpbuf);
1167   return Archive::SHOULD_INCLUDE_UNKNOWN;
1168 }
1169
1170 // Iterate over global symbols, calling a visitor class V for each.
1171
1172 template<int size, bool big_endian>
1173 void
1174 Sized_pluginobj<size, big_endian>::do_for_all_global_symbols(
1175     Read_symbols_data*,
1176     Library_base::Symbol_visitor_base* v)
1177 {
1178   for (int i = 0; i < this->nsyms_; ++i)
1179     {
1180       const struct ld_plugin_symbol& sym = this->syms_[i];
1181       if (sym.def != LDPK_UNDEF)
1182         v->visit(sym.name);
1183     }
1184 }
1185
1186 // Iterate over local symbols, calling a visitor class V for each GOT offset
1187 // associated with a local symbol.
1188 template<int size, bool big_endian>
1189 void
1190 Sized_pluginobj<size, big_endian>::do_for_all_local_got_entries(
1191     Got_offset_list::Visitor*) const
1192 {
1193   gold_unreachable();
1194 }
1195
1196 // Get the size of a section.  Not used for plugin objects.
1197
1198 template<int size, bool big_endian>
1199 uint64_t
1200 Sized_pluginobj<size, big_endian>::do_section_size(unsigned int)
1201 {
1202   gold_unreachable();
1203   return 0;
1204 }
1205
1206 // Get the name of a section.  Not used for plugin objects.
1207
1208 template<int size, bool big_endian>
1209 std::string
1210 Sized_pluginobj<size, big_endian>::do_section_name(unsigned int) const
1211 {
1212   gold_unreachable();
1213   return std::string();
1214 }
1215
1216 // Return a view of the contents of a section.  Not used for plugin objects.
1217
1218 template<int size, bool big_endian>
1219 const unsigned char*
1220 Sized_pluginobj<size, big_endian>::do_section_contents(
1221     unsigned int,
1222     section_size_type*,
1223     bool)
1224 {
1225   gold_unreachable();
1226   return NULL;
1227 }
1228
1229 // Return section flags.  Not used for plugin objects.
1230
1231 template<int size, bool big_endian>
1232 uint64_t
1233 Sized_pluginobj<size, big_endian>::do_section_flags(unsigned int)
1234 {
1235   gold_unreachable();
1236   return 0;
1237 }
1238
1239 // Return section entsize.  Not used for plugin objects.
1240
1241 template<int size, bool big_endian>
1242 uint64_t
1243 Sized_pluginobj<size, big_endian>::do_section_entsize(unsigned int)
1244 {
1245   gold_unreachable();
1246   return 0;
1247 }
1248
1249 // Return section address.  Not used for plugin objects.
1250
1251 template<int size, bool big_endian>
1252 uint64_t
1253 Sized_pluginobj<size, big_endian>::do_section_address(unsigned int)
1254 {
1255   gold_unreachable();
1256   return 0;
1257 }
1258
1259 // Return section type.  Not used for plugin objects.
1260
1261 template<int size, bool big_endian>
1262 unsigned int
1263 Sized_pluginobj<size, big_endian>::do_section_type(unsigned int)
1264 {
1265   gold_unreachable();
1266   return 0;
1267 }
1268
1269 // Return the section link field.  Not used for plugin objects.
1270
1271 template<int size, bool big_endian>
1272 unsigned int
1273 Sized_pluginobj<size, big_endian>::do_section_link(unsigned int)
1274 {
1275   gold_unreachable();
1276   return 0;
1277 }
1278
1279 // Return the section link field.  Not used for plugin objects.
1280
1281 template<int size, bool big_endian>
1282 unsigned int
1283 Sized_pluginobj<size, big_endian>::do_section_info(unsigned int)
1284 {
1285   gold_unreachable();
1286   return 0;
1287 }
1288
1289 // Return the section alignment.  Not used for plugin objects.
1290
1291 template<int size, bool big_endian>
1292 uint64_t
1293 Sized_pluginobj<size, big_endian>::do_section_addralign(unsigned int)
1294 {
1295   gold_unreachable();
1296   return 0;
1297 }
1298
1299 // Return the Xindex structure to use.  Not used for plugin objects.
1300
1301 template<int size, bool big_endian>
1302 Xindex*
1303 Sized_pluginobj<size, big_endian>::do_initialize_xindex()
1304 {
1305   gold_unreachable();
1306   return NULL;
1307 }
1308
1309 // Get symbol counts.  Don't count plugin objects; the replacement
1310 // files will provide the counts.
1311
1312 template<int size, bool big_endian>
1313 void
1314 Sized_pluginobj<size, big_endian>::do_get_global_symbol_counts(
1315     const Symbol_table*,
1316     size_t* defined,
1317     size_t* used) const
1318 {
1319   *defined = 0;
1320   *used = 0;
1321 }
1322
1323 // Get symbols.  Not used for plugin objects.
1324
1325 template<int size, bool big_endian>
1326 const Object::Symbols*
1327 Sized_pluginobj<size, big_endian>::do_get_global_symbols() const
1328 {
1329   gold_unreachable();
1330 }
1331
1332 // Class Plugin_finish.  This task runs after all replacement files have
1333 // been added.  For now, it's a placeholder for a possible plugin API
1334 // to allow the plugin to release most of its resources.  The cleanup
1335 // handlers must be called later, because they can remove the temporary
1336 // object files that are needed until the end of the link.
1337
1338 class Plugin_finish : public Task
1339 {
1340  public:
1341   Plugin_finish(Task_token* this_blocker, Task_token* next_blocker)
1342     : this_blocker_(this_blocker), next_blocker_(next_blocker)
1343   { }
1344
1345   ~Plugin_finish()
1346   {
1347     if (this->this_blocker_ != NULL)
1348       delete this->this_blocker_;
1349   }
1350
1351   Task_token*
1352   is_runnable()
1353   {
1354     if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
1355       return this->this_blocker_;
1356     return NULL;
1357   }
1358
1359   void
1360   locks(Task_locker* tl)
1361   { tl->add(this, this->next_blocker_); }
1362
1363   void
1364   run(Workqueue*)
1365   {
1366     // We could call early cleanup handlers here.
1367   }
1368
1369   std::string
1370   get_name() const
1371   { return "Plugin_finish"; }
1372
1373  private:
1374   Task_token* this_blocker_;
1375   Task_token* next_blocker_;
1376 };
1377
1378 // Class Plugin_hook.
1379
1380 Plugin_hook::~Plugin_hook()
1381 {
1382 }
1383
1384 // Return whether a Plugin_hook task is runnable.
1385
1386 Task_token*
1387 Plugin_hook::is_runnable()
1388 {
1389   if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
1390     return this->this_blocker_;
1391   return NULL;
1392 }
1393
1394 // Return a Task_locker for a Plugin_hook task.  We don't need any
1395 // locks here.
1396
1397 void
1398 Plugin_hook::locks(Task_locker*)
1399 {
1400 }
1401
1402 // Run the "all symbols read" plugin hook.
1403
1404 void
1405 Plugin_hook::run(Workqueue* workqueue)
1406 {
1407   gold_assert(this->options_.has_plugins());
1408   Symbol* start_sym = this->symtab_->lookup(parameters->entry());
1409   if (start_sym != NULL)
1410     start_sym->set_in_real_elf();
1411
1412   this->options_.plugins()->all_symbols_read(workqueue,
1413                                              this,
1414                                              this->input_objects_,
1415                                              this->symtab_,
1416                                              this->dirpath_,
1417                                              this->mapfile_,
1418                                              &this->this_blocker_);
1419   workqueue->queue_soon(new Plugin_finish(this->this_blocker_,
1420                                           this->next_blocker_));
1421 }
1422
1423 // The C interface routines called by the plugins.
1424
1425 #ifdef ENABLE_PLUGINS
1426
1427 // Register a claim-file handler.
1428
1429 static enum ld_plugin_status
1430 register_claim_file(ld_plugin_claim_file_handler handler)
1431 {
1432   gold_assert(parameters->options().has_plugins());
1433   parameters->options().plugins()->set_claim_file_handler(handler);
1434   return LDPS_OK;
1435 }
1436
1437 // Register an all-symbols-read handler.
1438
1439 static enum ld_plugin_status
1440 register_all_symbols_read(ld_plugin_all_symbols_read_handler handler)
1441 {
1442   gold_assert(parameters->options().has_plugins());
1443   parameters->options().plugins()->set_all_symbols_read_handler(handler);
1444   return LDPS_OK;
1445 }
1446
1447 // Register a cleanup handler.
1448
1449 static enum ld_plugin_status
1450 register_cleanup(ld_plugin_cleanup_handler handler)
1451 {
1452   gold_assert(parameters->options().has_plugins());
1453   parameters->options().plugins()->set_cleanup_handler(handler);
1454   return LDPS_OK;
1455 }
1456
1457 // Add symbols from a plugin-claimed input file.
1458
1459 static enum ld_plugin_status
1460 add_symbols(void* handle, int nsyms, const ld_plugin_symbol* syms)
1461 {
1462   gold_assert(parameters->options().has_plugins());
1463   Pluginobj* obj = parameters->options().plugins()->make_plugin_object(
1464       static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
1465   if (obj == NULL)
1466     return LDPS_ERR;
1467   obj->store_incoming_symbols(nsyms, syms);
1468   return LDPS_OK;
1469 }
1470
1471 // Get the input file information with an open (possibly re-opened)
1472 // file descriptor.
1473
1474 static enum ld_plugin_status
1475 get_input_file(const void* handle, struct ld_plugin_input_file* file)
1476 {
1477   gold_assert(parameters->options().has_plugins());
1478   unsigned int obj_index =
1479       static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
1480   return parameters->options().plugins()->get_input_file(obj_index, file);
1481 }
1482
1483 // Release the input file.
1484
1485 static enum ld_plugin_status
1486 release_input_file(const void* handle)
1487 {
1488   gold_assert(parameters->options().has_plugins());
1489   unsigned int obj_index =
1490       static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
1491   return parameters->options().plugins()->release_input_file(obj_index);
1492 }
1493
1494 static enum ld_plugin_status
1495 get_view(const void *handle, const void **viewp)
1496 {
1497   gold_assert(parameters->options().has_plugins());
1498   unsigned int obj_index =
1499       static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
1500   return parameters->options().plugins()->get_view(obj_index, viewp);
1501 }
1502
1503 // Get the symbol resolution info for a plugin-claimed input file.
1504
1505 static enum ld_plugin_status
1506 get_symbols(const void* handle, int nsyms, ld_plugin_symbol* syms)
1507 {
1508   gold_assert(parameters->options().has_plugins());
1509   Object* obj = parameters->options().plugins()->object(
1510     static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
1511   if (obj == NULL)
1512     return LDPS_ERR;
1513   Pluginobj* plugin_obj = obj->pluginobj();
1514   if (plugin_obj == NULL)
1515     return LDPS_ERR;
1516   return plugin_obj->get_symbol_resolution_info(nsyms, syms, 1);
1517 }
1518
1519 // Version 2 of the above.  The only difference is that this version
1520 // is allowed to return the resolution code LDPR_PREVAILING_DEF_IRONLY_EXP.
1521
1522 static enum ld_plugin_status
1523 get_symbols_v2(const void* handle, int nsyms, ld_plugin_symbol* syms)
1524 {
1525   gold_assert(parameters->options().has_plugins());
1526   Object* obj = parameters->options().plugins()->object(
1527     static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
1528   if (obj == NULL)
1529     return LDPS_ERR;
1530   Pluginobj* plugin_obj = obj->pluginobj();
1531   if (plugin_obj == NULL)
1532     return LDPS_ERR;
1533   return plugin_obj->get_symbol_resolution_info(nsyms, syms, 2);
1534 }
1535
1536 // Add a new (real) input file generated by a plugin.
1537
1538 static enum ld_plugin_status
1539 add_input_file(const char* pathname)
1540 {
1541   gold_assert(parameters->options().has_plugins());
1542   return parameters->options().plugins()->add_input_file(pathname, false);
1543 }
1544
1545 // Add a new (real) library required by a plugin.
1546
1547 static enum ld_plugin_status
1548 add_input_library(const char* pathname)
1549 {
1550   gold_assert(parameters->options().has_plugins());
1551   return parameters->options().plugins()->add_input_file(pathname, true);
1552 }
1553
1554 // Set the extra library path to be used by libraries added via
1555 // add_input_library
1556
1557 static enum ld_plugin_status
1558 set_extra_library_path(const char* path)
1559 {
1560   gold_assert(parameters->options().has_plugins());
1561   return parameters->options().plugins()->set_extra_library_path(path);
1562 }
1563
1564 // Issue a diagnostic message from a plugin.
1565
1566 static enum ld_plugin_status
1567 message(int level, const char* format, ...)
1568 {
1569   va_list args;
1570   va_start(args, format);
1571
1572   switch (level)
1573     {
1574     case LDPL_INFO:
1575       parameters->errors()->info(format, args);
1576       break;
1577     case LDPL_WARNING:
1578       parameters->errors()->warning(format, args);
1579       break;
1580     case LDPL_ERROR:
1581     default:
1582       parameters->errors()->error(format, args);
1583       break;
1584     case LDPL_FATAL:
1585       parameters->errors()->fatal(format, args);
1586       break;
1587     }
1588
1589   va_end(args);
1590   return LDPS_OK;
1591 }
1592
1593 // Get the section count of the object corresponding to the handle.  This
1594 // plugin interface can only be called in the claim_file handler of the plugin.
1595
1596 static enum ld_plugin_status
1597 get_input_section_count(const void* handle, unsigned int* count)
1598 {
1599   gold_assert(parameters->options().has_plugins());
1600
1601   if (!parameters->options().plugins()->in_claim_file_handler())
1602     return LDPS_ERR;
1603
1604   Object* obj = parameters->options().plugins()->get_elf_object(handle);
1605
1606   if (obj == NULL)
1607     return LDPS_ERR;
1608
1609   *count = obj->shnum();
1610   return LDPS_OK;
1611 }
1612
1613 // Get the type of the specified section in the object corresponding
1614 // to the handle.  This plugin interface can only be called in the
1615 // claim_file handler of the plugin.
1616
1617 static enum ld_plugin_status
1618 get_input_section_type(const struct ld_plugin_section section,
1619                        unsigned int* type)
1620 {
1621   gold_assert(parameters->options().has_plugins());
1622
1623   if (!parameters->options().plugins()->in_claim_file_handler())
1624     return LDPS_ERR;
1625
1626   Object* obj
1627     = parameters->options().plugins()->get_elf_object(section.handle);
1628
1629   if (obj == NULL)
1630     return LDPS_BAD_HANDLE;
1631
1632   *type = obj->section_type(section.shndx);
1633   return LDPS_OK;
1634 }
1635
1636 // Get the name of the specified section in the object corresponding
1637 // to the handle.  This plugin interface can only be called in the
1638 // claim_file handler of the plugin.
1639
1640 static enum ld_plugin_status
1641 get_input_section_name(const struct ld_plugin_section section,
1642                        char** section_name_ptr)
1643 {
1644   gold_assert(parameters->options().has_plugins());
1645
1646   if (!parameters->options().plugins()->in_claim_file_handler())
1647     return LDPS_ERR;
1648
1649   Object* obj
1650     = parameters->options().plugins()->get_elf_object(section.handle);
1651
1652   if (obj == NULL)
1653     return LDPS_BAD_HANDLE;
1654
1655   // Check if the object is locked before getting the section name.
1656   gold_assert(obj->is_locked());
1657
1658   const std::string section_name = obj->section_name(section.shndx);
1659   *section_name_ptr = static_cast<char*>(malloc(section_name.length() + 1));
1660   memcpy(*section_name_ptr, section_name.c_str(), section_name.length() + 1);
1661   return LDPS_OK;
1662 }
1663
1664 // Get the contents of the specified section in the object corresponding
1665 // to the handle.  This plugin interface can only be called in the
1666 // claim_file handler of the plugin.
1667
1668 static enum ld_plugin_status
1669 get_input_section_contents(const struct ld_plugin_section section,
1670                            const unsigned char** section_contents_ptr,
1671                            size_t* len)
1672 {
1673   gold_assert(parameters->options().has_plugins());
1674
1675   if (!parameters->options().plugins()->in_claim_file_handler())
1676     return LDPS_ERR;
1677
1678   Object* obj
1679     = parameters->options().plugins()->get_elf_object(section.handle);
1680
1681   if (obj == NULL)
1682     return LDPS_BAD_HANDLE;
1683
1684   // Check if the object is locked before getting the section contents.
1685   gold_assert(obj->is_locked());
1686
1687   section_size_type plen;
1688   *section_contents_ptr
1689       = obj->section_contents(section.shndx, &plen, false);
1690   *len = plen;
1691   return LDPS_OK;
1692 }
1693
1694 // Specify the ordering of sections in the final layout. The sections are
1695 // specified as (handle,shndx) pairs in the two arrays in the order in
1696 // which they should appear in the final layout.
1697
1698 static enum ld_plugin_status
1699 update_section_order(const struct ld_plugin_section* section_list,
1700                      unsigned int num_sections)
1701 {
1702   gold_assert(parameters->options().has_plugins());
1703
1704   if (num_sections == 0)
1705     return LDPS_OK;
1706
1707   if (section_list == NULL)
1708     return LDPS_ERR;
1709
1710   Layout* layout = parameters->options().plugins()->layout();
1711   gold_assert (layout != NULL);
1712
1713   std::map<Section_id, unsigned int>* order_map
1714     = layout->get_section_order_map();
1715
1716   /* Store the mapping from Section_id to section position in layout's
1717      order_map to consult after output sections are added.  */
1718   for (unsigned int i = 0; i < num_sections; ++i)
1719     {
1720       Object* obj = parameters->options().plugins()->get_elf_object(
1721           section_list[i].handle);
1722       if (obj == NULL)
1723         return LDPS_BAD_HANDLE;
1724       unsigned int shndx = section_list[i].shndx;
1725       Section_id secn_id(obj, shndx);
1726       (*order_map)[secn_id] = i + 1;
1727     }
1728
1729   return LDPS_OK;
1730 }
1731
1732 // Let the linker know that the sections could be reordered.
1733
1734 static enum ld_plugin_status
1735 allow_section_ordering()
1736 {
1737   gold_assert(parameters->options().has_plugins());
1738   Layout* layout = parameters->options().plugins()->layout();
1739   layout->set_section_ordering_specified();
1740   return LDPS_OK;
1741 }
1742
1743 // Let the linker know that a subset of sections could be mapped
1744 // to a unique segment.
1745
1746 static enum ld_plugin_status
1747 allow_unique_segment_for_sections()
1748 {
1749   gold_assert(parameters->options().has_plugins());
1750   Layout* layout = parameters->options().plugins()->layout();
1751   layout->set_unique_segment_for_sections_specified();
1752   return LDPS_OK;
1753 }
1754
1755 // This function should map the list of sections specified in the
1756 // SECTION_LIST to a unique segment.  ELF segments do not have names
1757 // and the NAME is used to identify Output Section which should contain
1758 // the list of sections.  This Output Section will then be mapped to
1759 // a unique segment.  FLAGS is used to specify if any additional segment
1760 // flags need to be set.  For instance, a specific segment flag can be
1761 // set to identify this segment.  Unsetting segment flags is not possible.
1762 // ALIGN specifies the alignment of the segment.
1763
1764 static enum ld_plugin_status
1765 unique_segment_for_sections(const char* segment_name,
1766                             uint64_t flags,
1767                             uint64_t align,
1768                             const struct ld_plugin_section* section_list,
1769                             unsigned int num_sections)
1770 {
1771   gold_assert(parameters->options().has_plugins());
1772
1773   if (num_sections == 0)
1774     return LDPS_OK;
1775
1776   if (section_list == NULL)
1777     return LDPS_ERR;
1778
1779   Layout* layout = parameters->options().plugins()->layout();
1780   gold_assert (layout != NULL);
1781
1782   Layout::Unique_segment_info* s = new Layout::Unique_segment_info;
1783   s->name = segment_name;
1784   s->flags = flags;
1785   s->align = align;
1786
1787   for (unsigned int i = 0; i < num_sections; ++i)
1788     {
1789       Object* obj = parameters->options().plugins()->get_elf_object(
1790           section_list[i].handle);
1791       if (obj == NULL)
1792         return LDPS_BAD_HANDLE;
1793       unsigned int shndx = section_list[i].shndx;
1794       Const_section_id secn_id(obj, shndx);
1795       layout->insert_section_segment_map(secn_id, s);
1796     }
1797
1798   return LDPS_OK;
1799 }
1800
1801 #endif // ENABLE_PLUGINS
1802
1803 // Allocate a Pluginobj object of the appropriate size and endianness.
1804
1805 static Pluginobj*
1806 make_sized_plugin_object(Input_file* input_file, off_t offset, off_t filesize)
1807 {
1808   Pluginobj* obj = NULL;
1809
1810   parameters_force_valid_target();
1811   const Target& target(parameters->target());
1812
1813   if (target.get_size() == 32)
1814     {
1815       if (target.is_big_endian())
1816 #ifdef HAVE_TARGET_32_BIG
1817         obj = new Sized_pluginobj<32, true>(input_file->filename(),
1818                                             input_file, offset, filesize);
1819 #else
1820         gold_error(_("%s: not configured to support "
1821                      "32-bit big-endian object"),
1822                    input_file->filename().c_str());
1823 #endif
1824       else
1825 #ifdef HAVE_TARGET_32_LITTLE
1826         obj = new Sized_pluginobj<32, false>(input_file->filename(),
1827                                              input_file, offset, filesize);
1828 #else
1829         gold_error(_("%s: not configured to support "
1830                      "32-bit little-endian object"),
1831                    input_file->filename().c_str());
1832 #endif
1833     }
1834   else if (target.get_size() == 64)
1835     {
1836       if (target.is_big_endian())
1837 #ifdef HAVE_TARGET_64_BIG
1838         obj = new Sized_pluginobj<64, true>(input_file->filename(),
1839                                             input_file, offset, filesize);
1840 #else
1841         gold_error(_("%s: not configured to support "
1842                      "64-bit big-endian object"),
1843                    input_file->filename().c_str());
1844 #endif
1845       else
1846 #ifdef HAVE_TARGET_64_LITTLE
1847         obj = new Sized_pluginobj<64, false>(input_file->filename(),
1848                                              input_file, offset, filesize);
1849 #else
1850         gold_error(_("%s: not configured to support "
1851                      "64-bit little-endian object"),
1852                    input_file->filename().c_str());
1853 #endif
1854     }
1855
1856   gold_assert(obj != NULL);
1857   return obj;
1858 }
1859
1860 } // End namespace gold.