1 // plugin.cc -- plugin manager for gold -*- C++ -*-
3 // Copyright 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
4 // Written by Cary Coutant <ccoutant@google.com>.
6 // This file is part of gold.
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.
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.
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.
35 #include "parameters.h"
51 // The linker's exported interfaces.
56 static enum ld_plugin_status
57 register_claim_file(ld_plugin_claim_file_handler handler);
59 static enum ld_plugin_status
60 register_all_symbols_read(ld_plugin_all_symbols_read_handler handler);
62 static enum ld_plugin_status
63 register_cleanup(ld_plugin_cleanup_handler handler);
65 static enum ld_plugin_status
66 add_symbols(void *handle, int nsyms, const struct ld_plugin_symbol *syms);
68 static enum ld_plugin_status
69 get_input_file(const void *handle, struct ld_plugin_input_file *file);
71 static enum ld_plugin_status
72 get_view(const void *handle, const void **viewp);
74 static enum ld_plugin_status
75 release_input_file(const void *handle);
77 static enum ld_plugin_status
78 get_symbols(const void *handle, int nsyms, struct ld_plugin_symbol *syms);
80 static enum ld_plugin_status
81 get_symbols_v2(const void *handle, int nsyms, struct ld_plugin_symbol *syms);
83 static enum ld_plugin_status
84 add_input_file(const char *pathname);
86 static enum ld_plugin_status
87 add_input_library(const char *pathname);
89 static enum ld_plugin_status
90 set_extra_library_path(const char *path);
92 static enum ld_plugin_status
93 message(int level, const char *format, ...);
95 static enum ld_plugin_status
96 get_input_section_count(const void* handle, unsigned int* count);
98 static enum ld_plugin_status
99 get_input_section_type(const struct ld_plugin_section section,
102 static enum ld_plugin_status
103 get_input_section_name(const struct ld_plugin_section section,
104 char** section_name_ptr);
106 static enum ld_plugin_status
107 get_input_section_contents(const struct ld_plugin_section section,
108 const unsigned char** section_contents,
111 static enum ld_plugin_status
112 update_section_order(const struct ld_plugin_section *section_list,
113 unsigned int num_sections);
115 static enum ld_plugin_status
116 allow_section_ordering();
120 #endif // ENABLE_PLUGINS
122 static Pluginobj* make_sized_plugin_object(Input_file* input_file,
123 off_t offset, off_t filesize);
127 // Load one plugin library.
132 #ifdef ENABLE_PLUGINS
133 // Load the plugin library.
134 // FIXME: Look for the library in standard locations.
135 this->handle_ = dlopen(this->filename_.c_str(), RTLD_NOW);
136 if (this->handle_ == NULL)
138 gold_error(_("%s: could not load plugin library: %s"),
139 this->filename_.c_str(), dlerror());
143 // Find the plugin's onload entry point.
144 void* ptr = dlsym(this->handle_, "onload");
147 gold_error(_("%s: could not find onload entry point"),
148 this->filename_.c_str());
151 ld_plugin_onload onload;
152 gold_assert(sizeof(onload) == sizeof(ptr));
153 memcpy(&onload, &ptr, sizeof(ptr));
155 // Get the linker's version number.
156 const char* ver = get_version_string();
159 sscanf(ver, "%d.%d", &major, &minor);
161 // Allocate and populate a transfer vector.
162 const int tv_fixed_size = 24;
164 int tv_size = this->args_.size() + tv_fixed_size;
165 ld_plugin_tv* tv = new ld_plugin_tv[tv_size];
167 // Put LDPT_MESSAGE at the front of the list so the plugin can use it
168 // while processing subsequent entries.
170 tv[i].tv_tag = LDPT_MESSAGE;
171 tv[i].tv_u.tv_message = message;
174 tv[i].tv_tag = LDPT_API_VERSION;
175 tv[i].tv_u.tv_val = LD_PLUGIN_API_VERSION;
178 tv[i].tv_tag = LDPT_GOLD_VERSION;
179 tv[i].tv_u.tv_val = major * 100 + minor;
182 tv[i].tv_tag = LDPT_LINKER_OUTPUT;
183 if (parameters->options().relocatable())
184 tv[i].tv_u.tv_val = LDPO_REL;
185 else if (parameters->options().shared())
186 tv[i].tv_u.tv_val = LDPO_DYN;
187 else if (parameters->options().pie())
188 tv[i].tv_u.tv_val = LDPO_PIE;
190 tv[i].tv_u.tv_val = LDPO_EXEC;
193 tv[i].tv_tag = LDPT_OUTPUT_NAME;
194 tv[i].tv_u.tv_string = parameters->options().output();
196 for (unsigned int j = 0; j < this->args_.size(); ++j)
199 tv[i].tv_tag = LDPT_OPTION;
200 tv[i].tv_u.tv_string = this->args_[j].c_str();
204 tv[i].tv_tag = LDPT_REGISTER_CLAIM_FILE_HOOK;
205 tv[i].tv_u.tv_register_claim_file = register_claim_file;
208 tv[i].tv_tag = LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK;
209 tv[i].tv_u.tv_register_all_symbols_read = register_all_symbols_read;
212 tv[i].tv_tag = LDPT_REGISTER_CLEANUP_HOOK;
213 tv[i].tv_u.tv_register_cleanup = register_cleanup;
216 tv[i].tv_tag = LDPT_ADD_SYMBOLS;
217 tv[i].tv_u.tv_add_symbols = add_symbols;
220 tv[i].tv_tag = LDPT_GET_INPUT_FILE;
221 tv[i].tv_u.tv_get_input_file = get_input_file;
224 tv[i].tv_tag = LDPT_GET_VIEW;
225 tv[i].tv_u.tv_get_view = get_view;
228 tv[i].tv_tag = LDPT_RELEASE_INPUT_FILE;
229 tv[i].tv_u.tv_release_input_file = release_input_file;
232 tv[i].tv_tag = LDPT_GET_SYMBOLS;
233 tv[i].tv_u.tv_get_symbols = get_symbols;
236 tv[i].tv_tag = LDPT_GET_SYMBOLS_V2;
237 tv[i].tv_u.tv_get_symbols = get_symbols_v2;
240 tv[i].tv_tag = LDPT_ADD_INPUT_FILE;
241 tv[i].tv_u.tv_add_input_file = add_input_file;
244 tv[i].tv_tag = LDPT_ADD_INPUT_LIBRARY;
245 tv[i].tv_u.tv_add_input_library = add_input_library;
248 tv[i].tv_tag = LDPT_SET_EXTRA_LIBRARY_PATH;
249 tv[i].tv_u.tv_set_extra_library_path = set_extra_library_path;
252 tv[i].tv_tag = LDPT_GET_INPUT_SECTION_COUNT;
253 tv[i].tv_u.tv_get_input_section_count = get_input_section_count;
256 tv[i].tv_tag = LDPT_GET_INPUT_SECTION_TYPE;
257 tv[i].tv_u.tv_get_input_section_type = get_input_section_type;
260 tv[i].tv_tag = LDPT_GET_INPUT_SECTION_NAME;
261 tv[i].tv_u.tv_get_input_section_name = get_input_section_name;
264 tv[i].tv_tag = LDPT_GET_INPUT_SECTION_CONTENTS;
265 tv[i].tv_u.tv_get_input_section_contents = get_input_section_contents;
268 tv[i].tv_tag = LDPT_UPDATE_SECTION_ORDER;
269 tv[i].tv_u.tv_update_section_order = update_section_order;
272 tv[i].tv_tag = LDPT_ALLOW_SECTION_ORDERING;
273 tv[i].tv_u.tv_allow_section_ordering = allow_section_ordering;
276 tv[i].tv_tag = LDPT_NULL;
277 tv[i].tv_u.tv_val = 0;
279 gold_assert(i == tv_size - 1);
281 // Call the onload entry point.
285 #endif // ENABLE_PLUGINS
288 // Call the plugin claim-file handler.
291 Plugin::claim_file(struct ld_plugin_input_file* plugin_input_file)
295 if (this->claim_file_handler_ != NULL)
297 (*this->claim_file_handler_)(plugin_input_file, &claimed);
304 // Call the all-symbols-read handler.
307 Plugin::all_symbols_read()
309 if (this->all_symbols_read_handler_ != NULL)
310 (*this->all_symbols_read_handler_)();
313 // Call the cleanup handler.
318 if (this->cleanup_handler_ != NULL && !this->cleanup_done_)
320 // Set this flag before calling to prevent a recursive plunge
321 // in the event that a plugin's cleanup handler issues a
323 this->cleanup_done_ = true;
324 (*this->cleanup_handler_)();
328 // This task is used to rescan archives as needed.
330 class Plugin_rescan : public Task
333 Plugin_rescan(Task_token* this_blocker, Task_token* next_blocker)
334 : this_blocker_(this_blocker), next_blocker_(next_blocker)
339 delete this->this_blocker_;
345 if (this->this_blocker_->is_blocked())
346 return this->this_blocker_;
351 locks(Task_locker* tl)
352 { tl->add(this, this->next_blocker_); }
356 { parameters->options().plugins()->rescan(this); }
360 { return "Plugin_rescan"; }
363 Task_token* this_blocker_;
364 Task_token* next_blocker_;
367 // Plugin_manager methods.
369 Plugin_manager::~Plugin_manager()
371 for (Plugin_list::iterator p = this->plugins_.begin();
372 p != this->plugins_.end();
375 this->plugins_.clear();
376 for (Object_list::iterator obj = this->objects_.begin();
377 obj != this->objects_.end();
380 this->objects_.clear();
383 // Load all plugin libraries.
386 Plugin_manager::load_plugins(Layout* layout)
388 this->layout_ = layout;
389 for (this->current_ = this->plugins_.begin();
390 this->current_ != this->plugins_.end();
392 (*this->current_)->load();
395 // Call the plugin claim-file handlers in turn to see if any claim the file.
398 Plugin_manager::claim_file(Input_file* input_file, off_t offset,
399 off_t filesize, Object* elf_object)
401 if (this->in_replacement_phase_)
404 unsigned int handle = this->objects_.size();
405 this->input_file_ = input_file;
406 this->plugin_input_file_.name = input_file->filename().c_str();
407 this->plugin_input_file_.fd = input_file->file().descriptor();
408 this->plugin_input_file_.offset = offset;
409 this->plugin_input_file_.filesize = filesize;
410 this->plugin_input_file_.handle = reinterpret_cast<void*>(handle);
411 if (elf_object != NULL)
412 this->objects_.push_back(elf_object);
413 this->in_claim_file_handler_ = true;
415 for (this->current_ = this->plugins_.begin();
416 this->current_ != this->plugins_.end();
419 if ((*this->current_)->claim_file(&this->plugin_input_file_))
421 this->any_claimed_ = true;
422 this->in_claim_file_handler_ = false;
424 if (this->objects_.size() > handle
425 && this->objects_[handle]->pluginobj() != NULL)
426 return this->objects_[handle]->pluginobj();
428 // If the plugin claimed the file but did not call the
429 // add_symbols callback, we need to create the Pluginobj now.
430 Pluginobj* obj = this->make_plugin_object(handle);
435 this->in_claim_file_handler_ = false;
439 // Save an archive. This is used so that a plugin can add a file
440 // which refers to a symbol which was not previously referenced. In
441 // that case we want to pretend that the symbol was referenced before,
442 // and pull in the archive object.
445 Plugin_manager::save_archive(Archive* archive)
447 if (this->in_replacement_phase_ || !this->any_claimed_)
450 this->rescannable_.push_back(Rescannable(archive));
453 // Save an Input_group. This is like save_archive.
456 Plugin_manager::save_input_group(Input_group* input_group)
458 if (this->in_replacement_phase_ || !this->any_claimed_)
461 this->rescannable_.push_back(Rescannable(input_group));
464 // Call the all-symbols-read handlers.
467 Plugin_manager::all_symbols_read(Workqueue* workqueue, Task* task,
468 Input_objects* input_objects,
469 Symbol_table* symtab,
470 Dirsearch* dirpath, Mapfile* mapfile,
471 Task_token** last_blocker)
473 this->in_replacement_phase_ = true;
474 this->workqueue_ = workqueue;
476 this->input_objects_ = input_objects;
477 this->symtab_ = symtab;
478 this->dirpath_ = dirpath;
479 this->mapfile_ = mapfile;
480 this->this_blocker_ = NULL;
482 for (this->current_ = this->plugins_.begin();
483 this->current_ != this->plugins_.end();
485 (*this->current_)->all_symbols_read();
487 if (this->any_added_)
489 Task_token* next_blocker = new Task_token(true);
490 next_blocker->add_blocker();
491 workqueue->queue(new Plugin_rescan(this->this_blocker_, next_blocker));
492 this->this_blocker_ = next_blocker;
495 *last_blocker = this->this_blocker_;
498 // This is called when we see a new undefined symbol. If we are in
499 // the replacement phase, this means that we may need to rescan some
500 // archives we have previously seen.
503 Plugin_manager::new_undefined_symbol(Symbol* sym)
505 if (this->in_replacement_phase_)
506 this->undefined_symbols_.push_back(sym);
509 // Rescan archives as needed. This handles the case where a new
510 // object file added by a plugin has an undefined reference to some
511 // symbol defined in an archive.
514 Plugin_manager::rescan(Task* task)
516 size_t rescan_pos = 0;
517 size_t rescan_size = this->rescannable_.size();
518 while (!this->undefined_symbols_.empty())
520 if (rescan_pos >= rescan_size)
522 this->undefined_symbols_.clear();
526 Undefined_symbol_list undefs;
527 undefs.reserve(this->undefined_symbols_.size());
528 this->undefined_symbols_.swap(undefs);
530 size_t min_rescan_pos = rescan_size;
532 for (Undefined_symbol_list::const_iterator p = undefs.begin();
536 if (!(*p)->is_undefined())
539 this->undefined_symbols_.push_back(*p);
541 // Find the first rescan archive which defines this symbol,
542 // starting at the current rescan position. The rescan position
543 // exists so that given -la -lb -lc we don't look for undefined
544 // symbols in -lb back in -la, but instead get the definition
545 // from -lc. Don't bother to look past the current minimum
547 for (size_t i = rescan_pos; i < min_rescan_pos; ++i)
549 if (this->rescannable_defines(i, *p))
557 if (min_rescan_pos >= rescan_size)
559 // We didn't find any rescannable archives which define any
560 // undefined symbols.
564 const Rescannable& r(this->rescannable_[min_rescan_pos]);
567 Task_lock_obj<Archive> tl(task, r.u.archive);
568 r.u.archive->add_symbols(this->symtab_, this->layout_,
569 this->input_objects_, this->mapfile_);
573 size_t next_saw_undefined = this->symtab_->saw_undefined();
574 size_t saw_undefined;
577 saw_undefined = next_saw_undefined;
579 for (Input_group::const_iterator p = r.u.input_group->begin();
580 p != r.u.input_group->end();
583 Task_lock_obj<Archive> tl(task, *p);
585 (*p)->add_symbols(this->symtab_, this->layout_,
586 this->input_objects_, this->mapfile_);
589 next_saw_undefined = this->symtab_->saw_undefined();
591 while (saw_undefined != next_saw_undefined);
594 for (size_t i = rescan_pos; i < min_rescan_pos + 1; ++i)
596 if (this->rescannable_[i].is_archive)
597 delete this->rescannable_[i].u.archive;
599 delete this->rescannable_[i].u.input_group;
602 rescan_pos = min_rescan_pos + 1;
606 // Return whether the rescannable at index I defines SYM.
609 Plugin_manager::rescannable_defines(size_t i, Symbol* sym)
611 const Rescannable& r(this->rescannable_[i]);
613 return r.u.archive->defines_symbol(sym);
616 for (Input_group::const_iterator p = r.u.input_group->begin();
617 p != r.u.input_group->end();
620 if ((*p)->defines_symbol(sym))
627 // Layout deferred objects.
630 Plugin_manager::layout_deferred_objects()
632 Deferred_layout_list::iterator obj;
634 for (obj = this->deferred_layout_objects_.begin();
635 obj != this->deferred_layout_objects_.end();
638 // Lock the object so we can read from it. This is only called
639 // single-threaded from queue_middle_tasks, so it is OK to lock.
640 // Unfortunately we have no way to pass in a Task token.
641 const Task* dummy_task = reinterpret_cast<const Task*>(-1);
642 Task_lock_obj<Object> tl(dummy_task, *obj);
643 (*obj)->layout_deferred_sections(this->layout_);
647 // Call the cleanup handlers.
650 Plugin_manager::cleanup()
652 for (this->current_ = this->plugins_.begin();
653 this->current_ != this->plugins_.end();
655 (*this->current_)->cleanup();
658 // Make a new Pluginobj object. This is called when the plugin calls
659 // the add_symbols API.
662 Plugin_manager::make_plugin_object(unsigned int handle)
664 // Make sure we aren't asked to make an object for the same handle twice.
665 if (this->objects_.size() != handle
666 && this->objects_[handle]->pluginobj() != NULL)
669 Pluginobj* obj = make_sized_plugin_object(this->input_file_,
670 this->plugin_input_file_.offset,
671 this->plugin_input_file_.filesize);
674 // If the elf object for this file was pushed into the objects_ vector, delete
675 // it to make room for the Pluginobj as this file is claimed.
676 if (this->objects_.size() != handle)
677 this->objects_.pop_back();
679 this->objects_.push_back(obj);
683 // Get the input file information with an open (possibly re-opened)
687 Plugin_manager::get_input_file(unsigned int handle,
688 struct ld_plugin_input_file* file)
690 Pluginobj* obj = this->object(handle)->pluginobj();
692 return LDPS_BAD_HANDLE;
694 obj->lock(this->task_);
695 file->name = obj->filename().c_str();
696 file->fd = obj->descriptor();
697 file->offset = obj->offset();
698 file->filesize = obj->filesize();
699 file->handle = reinterpret_cast<void*>(handle);
703 // Release the input file.
706 Plugin_manager::release_input_file(unsigned int handle)
708 if (this->object(handle) == NULL)
709 return LDPS_BAD_HANDLE;
711 Pluginobj* obj = this->object(handle)->pluginobj();
714 return LDPS_BAD_HANDLE;
716 obj->unlock(this->task_);
720 // Get the elf object corresponding to the handle. Return NULL if we
721 // found a Pluginobj instead.
724 Plugin_manager::get_elf_object(const void* handle)
726 Object* obj = this->object(
727 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
729 // The object should not be a Pluginobj.
731 || obj->pluginobj() != NULL)
738 Plugin_manager::get_view(unsigned int handle, const void **viewp)
742 Input_file *input_file;
743 if (this->in_claim_file_handler_)
745 // We are being called from the claim_file hook.
746 const struct ld_plugin_input_file &f = this->plugin_input_file_;
748 filesize = f.filesize;
749 input_file = this->input_file_;
753 // An already claimed file.
754 if (this->object(handle) == NULL)
755 return LDPS_BAD_HANDLE;
756 Pluginobj* obj = this->object(handle)->pluginobj();
758 return LDPS_BAD_HANDLE;
759 offset = obj->offset();
760 filesize = obj->filesize();
761 input_file = obj->input_file();
763 *viewp = (void*) input_file->file().get_view(offset, 0, filesize, false,
768 // Add a new library path.
771 Plugin_manager::set_extra_library_path(const char* path)
773 this->extra_search_path_ = std::string(path);
777 // Add a new input file.
780 Plugin_manager::add_input_file(const char* pathname, bool is_lib)
782 Input_file_argument file(pathname,
784 ? Input_file_argument::INPUT_FILE_TYPE_LIBRARY
785 : Input_file_argument::INPUT_FILE_TYPE_FILE),
787 ? this->extra_search_path_.c_str()
791 Input_argument* input_argument = new Input_argument(file);
792 Task_token* next_blocker = new Task_token(true);
793 next_blocker->add_blocker();
794 if (parameters->incremental())
795 gold_error(_("input files added by plug-ins in --incremental mode not "
797 this->workqueue_->queue_soon(new Read_symbols(this->input_objects_,
808 this->this_blocker_ = next_blocker;
809 this->any_added_ = true;
815 Pluginobj::Pluginobj(const std::string& name, Input_file* input_file,
816 off_t offset, off_t filesize)
817 : Object(name, input_file, false, offset),
818 nsyms_(0), syms_(NULL), symbols_(), filesize_(filesize), comdat_map_()
822 // Return TRUE if a defined symbol is referenced from outside the
823 // universe of claimed objects. Only references from relocatable,
824 // non-IR (unclaimed) objects count as a reference. References from
825 // dynamic objects count only as "visible".
828 is_referenced_from_outside(Symbol* lsym)
830 if (lsym->in_real_elf())
832 if (parameters->options().relocatable())
834 if (parameters->options().is_undefined(lsym->name()))
839 // Return TRUE if a defined symbol might be reachable from outside the
843 is_visible_from_outside(Symbol* lsym)
847 if (parameters->options().export_dynamic() || parameters->options().shared())
848 return lsym->is_externally_visible();
852 // Get symbol resolution info.
855 Pluginobj::get_symbol_resolution_info(int nsyms,
856 ld_plugin_symbol* syms,
859 // For version 1 of this interface, we cannot use
860 // LDPR_PREVAILING_DEF_IRONLY_EXP, so we return LDPR_PREVAILING_DEF
862 const ld_plugin_symbol_resolution ldpr_prevailing_def_ironly_exp
864 ? LDPR_PREVAILING_DEF_IRONLY_EXP
865 : LDPR_PREVAILING_DEF);
867 if (nsyms > this->nsyms_)
870 if (static_cast<size_t>(nsyms) > this->symbols_.size())
872 // We never decided to include this object. We mark all symbols as
874 gold_assert(this->symbols_.size() == 0);
875 for (int i = 0; i < nsyms; i++)
876 syms[i].resolution = LDPR_PREEMPTED_REG;
880 for (int i = 0; i < nsyms; i++)
882 ld_plugin_symbol* isym = &syms[i];
883 Symbol* lsym = this->symbols_[i];
884 ld_plugin_symbol_resolution res = LDPR_UNKNOWN;
886 if (lsym->is_undefined())
887 // The symbol remains undefined.
889 else if (isym->def == LDPK_UNDEF
890 || isym->def == LDPK_WEAKUNDEF
891 || isym->def == LDPK_COMMON)
893 // The original symbol was undefined or common.
894 if (lsym->source() != Symbol::FROM_OBJECT)
895 res = LDPR_RESOLVED_EXEC;
896 else if (lsym->object()->pluginobj() == this)
898 if (is_referenced_from_outside(lsym))
899 res = LDPR_PREVAILING_DEF;
900 else if (is_visible_from_outside(lsym))
901 res = ldpr_prevailing_def_ironly_exp;
903 res = LDPR_PREVAILING_DEF_IRONLY;
905 else if (lsym->object()->pluginobj() != NULL)
906 res = LDPR_RESOLVED_IR;
907 else if (lsym->object()->is_dynamic())
908 res = LDPR_RESOLVED_DYN;
910 res = LDPR_RESOLVED_EXEC;
914 // The original symbol was a definition.
915 if (lsym->source() != Symbol::FROM_OBJECT)
916 res = LDPR_PREEMPTED_REG;
917 else if (lsym->object() == static_cast<const Object*>(this))
919 if (is_referenced_from_outside(lsym))
920 res = LDPR_PREVAILING_DEF;
921 else if (is_visible_from_outside(lsym))
922 res = ldpr_prevailing_def_ironly_exp;
924 res = LDPR_PREVAILING_DEF_IRONLY;
927 res = (lsym->object()->pluginobj() != NULL
929 : LDPR_PREEMPTED_REG);
931 isym->resolution = res;
936 // Return TRUE if the comdat group with key COMDAT_KEY from this object
940 Pluginobj::include_comdat_group(std::string comdat_key, Layout* layout)
942 std::pair<Comdat_map::iterator, bool> ins =
943 this->comdat_map_.insert(std::make_pair(comdat_key, false));
945 // If this is the first time we've seen this comdat key, ask the
946 // layout object whether it should be included.
948 ins.first->second = layout->find_or_add_kept_section(comdat_key,
952 return ins.first->second;
955 // Class Sized_pluginobj.
957 template<int size, bool big_endian>
958 Sized_pluginobj<size, big_endian>::Sized_pluginobj(
959 const std::string& name,
960 Input_file* input_file,
963 : Pluginobj(name, input_file, offset, filesize)
967 // Read the symbols. Not used for plugin objects.
969 template<int size, bool big_endian>
971 Sized_pluginobj<size, big_endian>::do_read_symbols(Read_symbols_data*)
976 // Lay out the input sections. Not used for plugin objects.
978 template<int size, bool big_endian>
980 Sized_pluginobj<size, big_endian>::do_layout(Symbol_table*, Layout*,
986 // Add the symbols to the symbol table.
988 template<int size, bool big_endian>
990 Sized_pluginobj<size, big_endian>::do_add_symbols(Symbol_table* symtab,
994 const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
995 unsigned char symbuf[sym_size];
996 elfcpp::Sym<size, big_endian> sym(symbuf);
997 elfcpp::Sym_write<size, big_endian> osym(symbuf);
999 typedef typename elfcpp::Elf_types<size>::Elf_WXword Elf_size_type;
1001 this->symbols_.resize(this->nsyms_);
1003 for (int i = 0; i < this->nsyms_; ++i)
1005 const struct ld_plugin_symbol* isym = &this->syms_[i];
1006 const char* name = isym->name;
1007 const char* ver = isym->version;
1008 elfcpp::Elf_Half shndx;
1012 if (name != NULL && name[0] == '\0')
1014 if (ver != NULL && ver[0] == '\0')
1020 case LDPK_WEAKUNDEF:
1021 bind = elfcpp::STB_WEAK;
1027 bind = elfcpp::STB_GLOBAL;
1035 shndx = elfcpp::SHN_ABS;
1038 shndx = elfcpp::SHN_COMMON;
1041 case LDPK_WEAKUNDEF:
1043 shndx = elfcpp::SHN_UNDEF;
1047 switch (isym->visibility)
1049 case LDPV_PROTECTED:
1050 vis = elfcpp::STV_PROTECTED;
1053 vis = elfcpp::STV_INTERNAL;
1056 vis = elfcpp::STV_HIDDEN;
1060 vis = elfcpp::STV_DEFAULT;
1064 if (isym->comdat_key != NULL
1065 && isym->comdat_key[0] != '\0'
1066 && !this->include_comdat_group(isym->comdat_key, layout))
1067 shndx = elfcpp::SHN_UNDEF;
1069 osym.put_st_name(0);
1070 osym.put_st_value(0);
1071 osym.put_st_size(static_cast<Elf_size_type>(isym->size));
1072 osym.put_st_info(bind, elfcpp::STT_NOTYPE);
1073 osym.put_st_other(vis, 0);
1074 osym.put_st_shndx(shndx);
1077 symtab->add_from_pluginobj<size, big_endian>(this, name, ver, &sym);
1081 template<int size, bool big_endian>
1082 Archive::Should_include
1083 Sized_pluginobj<size, big_endian>::do_should_include_member(
1084 Symbol_table* symtab,
1089 char* tmpbuf = NULL;
1090 size_t tmpbuflen = 0;
1092 for (int i = 0; i < this->nsyms_; ++i)
1094 const struct ld_plugin_symbol& sym = this->syms_[i];
1095 const char* name = sym.name;
1097 Archive::Should_include t = Archive::should_include_member(symtab,
1103 if (t == Archive::SHOULD_INCLUDE_YES)
1112 return Archive::SHOULD_INCLUDE_UNKNOWN;
1115 // Iterate over global symbols, calling a visitor class V for each.
1117 template<int size, bool big_endian>
1119 Sized_pluginobj<size, big_endian>::do_for_all_global_symbols(
1121 Library_base::Symbol_visitor_base* v)
1123 for (int i = 0; i < this->nsyms_; ++i)
1125 const struct ld_plugin_symbol& sym = this->syms_[i];
1126 if (sym.def != LDPK_UNDEF)
1131 // Iterate over local symbols, calling a visitor class V for each GOT offset
1132 // associated with a local symbol.
1133 template<int size, bool big_endian>
1135 Sized_pluginobj<size, big_endian>::do_for_all_local_got_entries(
1136 Got_offset_list::Visitor*) const
1141 // Get the size of a section. Not used for plugin objects.
1143 template<int size, bool big_endian>
1145 Sized_pluginobj<size, big_endian>::do_section_size(unsigned int)
1151 // Get the name of a section. Not used for plugin objects.
1153 template<int size, bool big_endian>
1155 Sized_pluginobj<size, big_endian>::do_section_name(unsigned int)
1158 return std::string();
1161 // Return a view of the contents of a section. Not used for plugin objects.
1163 template<int size, bool big_endian>
1164 const unsigned char*
1165 Sized_pluginobj<size, big_endian>::do_section_contents(
1174 // Return section flags. Not used for plugin objects.
1176 template<int size, bool big_endian>
1178 Sized_pluginobj<size, big_endian>::do_section_flags(unsigned int)
1184 // Return section entsize. Not used for plugin objects.
1186 template<int size, bool big_endian>
1188 Sized_pluginobj<size, big_endian>::do_section_entsize(unsigned int)
1194 // Return section address. Not used for plugin objects.
1196 template<int size, bool big_endian>
1198 Sized_pluginobj<size, big_endian>::do_section_address(unsigned int)
1204 // Return section type. Not used for plugin objects.
1206 template<int size, bool big_endian>
1208 Sized_pluginobj<size, big_endian>::do_section_type(unsigned int)
1214 // Return the section link field. Not used for plugin objects.
1216 template<int size, bool big_endian>
1218 Sized_pluginobj<size, big_endian>::do_section_link(unsigned int)
1224 // Return the section link field. Not used for plugin objects.
1226 template<int size, bool big_endian>
1228 Sized_pluginobj<size, big_endian>::do_section_info(unsigned int)
1234 // Return the section alignment. Not used for plugin objects.
1236 template<int size, bool big_endian>
1238 Sized_pluginobj<size, big_endian>::do_section_addralign(unsigned int)
1244 // Return the Xindex structure to use. Not used for plugin objects.
1246 template<int size, bool big_endian>
1248 Sized_pluginobj<size, big_endian>::do_initialize_xindex()
1254 // Get symbol counts. Don't count plugin objects; the replacement
1255 // files will provide the counts.
1257 template<int size, bool big_endian>
1259 Sized_pluginobj<size, big_endian>::do_get_global_symbol_counts(
1260 const Symbol_table*,
1268 // Get symbols. Not used for plugin objects.
1270 template<int size, bool big_endian>
1271 const Object::Symbols*
1272 Sized_pluginobj<size, big_endian>::do_get_global_symbols() const
1277 // Class Plugin_finish. This task runs after all replacement files have
1278 // been added. For now, it's a placeholder for a possible plugin API
1279 // to allow the plugin to release most of its resources. The cleanup
1280 // handlers must be called later, because they can remove the temporary
1281 // object files that are needed until the end of the link.
1283 class Plugin_finish : public Task
1286 Plugin_finish(Task_token* this_blocker, Task_token* next_blocker)
1287 : this_blocker_(this_blocker), next_blocker_(next_blocker)
1292 if (this->this_blocker_ != NULL)
1293 delete this->this_blocker_;
1299 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
1300 return this->this_blocker_;
1305 locks(Task_locker* tl)
1306 { tl->add(this, this->next_blocker_); }
1311 // We could call early cleanup handlers here.
1316 { return "Plugin_finish"; }
1319 Task_token* this_blocker_;
1320 Task_token* next_blocker_;
1323 // Class Plugin_hook.
1325 Plugin_hook::~Plugin_hook()
1329 // Return whether a Plugin_hook task is runnable.
1332 Plugin_hook::is_runnable()
1334 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
1335 return this->this_blocker_;
1339 // Return a Task_locker for a Plugin_hook task. We don't need any
1343 Plugin_hook::locks(Task_locker*)
1347 // Run the "all symbols read" plugin hook.
1350 Plugin_hook::run(Workqueue* workqueue)
1352 gold_assert(this->options_.has_plugins());
1353 Symbol* start_sym = this->symtab_->lookup(parameters->entry());
1354 if (start_sym != NULL)
1355 start_sym->set_in_real_elf();
1357 this->options_.plugins()->all_symbols_read(workqueue,
1359 this->input_objects_,
1363 &this->this_blocker_);
1364 workqueue->queue_soon(new Plugin_finish(this->this_blocker_,
1365 this->next_blocker_));
1368 // The C interface routines called by the plugins.
1370 #ifdef ENABLE_PLUGINS
1372 // Register a claim-file handler.
1374 static enum ld_plugin_status
1375 register_claim_file(ld_plugin_claim_file_handler handler)
1377 gold_assert(parameters->options().has_plugins());
1378 parameters->options().plugins()->set_claim_file_handler(handler);
1382 // Register an all-symbols-read handler.
1384 static enum ld_plugin_status
1385 register_all_symbols_read(ld_plugin_all_symbols_read_handler handler)
1387 gold_assert(parameters->options().has_plugins());
1388 parameters->options().plugins()->set_all_symbols_read_handler(handler);
1392 // Register a cleanup handler.
1394 static enum ld_plugin_status
1395 register_cleanup(ld_plugin_cleanup_handler handler)
1397 gold_assert(parameters->options().has_plugins());
1398 parameters->options().plugins()->set_cleanup_handler(handler);
1402 // Add symbols from a plugin-claimed input file.
1404 static enum ld_plugin_status
1405 add_symbols(void* handle, int nsyms, const ld_plugin_symbol* syms)
1407 gold_assert(parameters->options().has_plugins());
1408 Pluginobj* obj = parameters->options().plugins()->make_plugin_object(
1409 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
1412 obj->store_incoming_symbols(nsyms, syms);
1416 // Get the input file information with an open (possibly re-opened)
1419 static enum ld_plugin_status
1420 get_input_file(const void* handle, struct ld_plugin_input_file* file)
1422 gold_assert(parameters->options().has_plugins());
1423 unsigned int obj_index =
1424 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
1425 return parameters->options().plugins()->get_input_file(obj_index, file);
1428 // Release the input file.
1430 static enum ld_plugin_status
1431 release_input_file(const void* handle)
1433 gold_assert(parameters->options().has_plugins());
1434 unsigned int obj_index =
1435 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
1436 return parameters->options().plugins()->release_input_file(obj_index);
1439 static enum ld_plugin_status
1440 get_view(const void *handle, const void **viewp)
1442 gold_assert(parameters->options().has_plugins());
1443 unsigned int obj_index =
1444 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
1445 return parameters->options().plugins()->get_view(obj_index, viewp);
1448 // Get the symbol resolution info for a plugin-claimed input file.
1450 static enum ld_plugin_status
1451 get_symbols(const void* handle, int nsyms, ld_plugin_symbol* syms)
1453 gold_assert(parameters->options().has_plugins());
1454 Object* obj = parameters->options().plugins()->object(
1455 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
1458 Pluginobj* plugin_obj = obj->pluginobj();
1459 if (plugin_obj == NULL)
1461 return plugin_obj->get_symbol_resolution_info(nsyms, syms, 1);
1464 // Version 2 of the above. The only difference is that this version
1465 // is allowed to return the resolution code LDPR_PREVAILING_DEF_IRONLY_EXP.
1467 static enum ld_plugin_status
1468 get_symbols_v2(const void* handle, int nsyms, ld_plugin_symbol* syms)
1470 gold_assert(parameters->options().has_plugins());
1471 Object* obj = parameters->options().plugins()->object(
1472 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
1475 Pluginobj* plugin_obj = obj->pluginobj();
1476 if (plugin_obj == NULL)
1478 return plugin_obj->get_symbol_resolution_info(nsyms, syms, 2);
1481 // Add a new (real) input file generated by a plugin.
1483 static enum ld_plugin_status
1484 add_input_file(const char* pathname)
1486 gold_assert(parameters->options().has_plugins());
1487 return parameters->options().plugins()->add_input_file(pathname, false);
1490 // Add a new (real) library required by a plugin.
1492 static enum ld_plugin_status
1493 add_input_library(const char* pathname)
1495 gold_assert(parameters->options().has_plugins());
1496 return parameters->options().plugins()->add_input_file(pathname, true);
1499 // Set the extra library path to be used by libraries added via
1500 // add_input_library
1502 static enum ld_plugin_status
1503 set_extra_library_path(const char* path)
1505 gold_assert(parameters->options().has_plugins());
1506 return parameters->options().plugins()->set_extra_library_path(path);
1509 // Issue a diagnostic message from a plugin.
1511 static enum ld_plugin_status
1512 message(int level, const char* format, ...)
1515 va_start(args, format);
1520 parameters->errors()->info(format, args);
1523 parameters->errors()->warning(format, args);
1527 parameters->errors()->error(format, args);
1530 parameters->errors()->fatal(format, args);
1538 // Get the section count of the object corresponding to the handle. This
1539 // plugin interface can only be called in the claim_file handler of the plugin.
1541 static enum ld_plugin_status
1542 get_input_section_count(const void* handle, unsigned int* count)
1544 gold_assert(parameters->options().has_plugins());
1546 if (!parameters->options().plugins()->in_claim_file_handler())
1549 Object* obj = parameters->options().plugins()->get_elf_object(handle);
1554 *count = obj->shnum();
1558 // Get the type of the specified section in the object corresponding
1559 // to the handle. This plugin interface can only be called in the
1560 // claim_file handler of the plugin.
1562 static enum ld_plugin_status
1563 get_input_section_type(const struct ld_plugin_section section,
1566 gold_assert(parameters->options().has_plugins());
1568 if (!parameters->options().plugins()->in_claim_file_handler())
1572 = parameters->options().plugins()->get_elf_object(section.handle);
1575 return LDPS_BAD_HANDLE;
1577 *type = obj->section_type(section.shndx);
1581 // Get the name of the specified section in the object corresponding
1582 // to the handle. This plugin interface can only be called in the
1583 // claim_file handler of the plugin.
1585 static enum ld_plugin_status
1586 get_input_section_name(const struct ld_plugin_section section,
1587 char** section_name_ptr)
1589 gold_assert(parameters->options().has_plugins());
1591 if (!parameters->options().plugins()->in_claim_file_handler())
1595 = parameters->options().plugins()->get_elf_object(section.handle);
1598 return LDPS_BAD_HANDLE;
1600 // Check if the object is locked before getting the section name.
1601 gold_assert(obj->is_locked());
1603 const std::string section_name = obj->section_name(section.shndx);
1604 *section_name_ptr = static_cast<char*>(malloc(section_name.length() + 1));
1605 memcpy(*section_name_ptr, section_name.c_str(), section_name.length() + 1);
1609 // Get the contents of the specified section in the object corresponding
1610 // to the handle. This plugin interface can only be called in the
1611 // claim_file handler of the plugin.
1613 static enum ld_plugin_status
1614 get_input_section_contents(const struct ld_plugin_section section,
1615 const unsigned char** section_contents_ptr,
1618 gold_assert(parameters->options().has_plugins());
1620 if (!parameters->options().plugins()->in_claim_file_handler())
1624 = parameters->options().plugins()->get_elf_object(section.handle);
1627 return LDPS_BAD_HANDLE;
1629 // Check if the object is locked before getting the section contents.
1630 gold_assert(obj->is_locked());
1632 section_size_type plen;
1633 *section_contents_ptr
1634 = obj->section_contents(section.shndx, &plen, false);
1639 // Specify the ordering of sections in the final layout. The sections are
1640 // specified as (handle,shndx) pairs in the two arrays in the order in
1641 // which they should appear in the final layout.
1643 static enum ld_plugin_status
1644 update_section_order(const struct ld_plugin_section* section_list,
1645 unsigned int num_sections)
1647 gold_assert(parameters->options().has_plugins());
1649 if (num_sections == 0)
1652 if (section_list == NULL)
1655 Layout* layout = parameters->options().plugins()->layout();
1656 gold_assert (layout != NULL);
1658 std::map<Section_id, unsigned int>* order_map
1659 = layout->get_section_order_map();
1661 /* Store the mapping from Section_id to section position in layout's
1662 order_map to consult after output sections are added. */
1663 for (unsigned int i = 0; i < num_sections; ++i)
1665 Object* obj = parameters->options().plugins()->get_elf_object(
1666 section_list[i].handle);
1668 return LDPS_BAD_HANDLE;
1669 unsigned int shndx = section_list[i].shndx;
1670 Section_id secn_id(obj, shndx);
1671 (*order_map)[secn_id] = i + 1;
1677 // Let the linker know that the sections could be reordered.
1679 static enum ld_plugin_status
1680 allow_section_ordering()
1682 gold_assert(parameters->options().has_plugins());
1683 Layout* layout = parameters->options().plugins()->layout();
1684 layout->set_section_ordering_specified();
1688 #endif // ENABLE_PLUGINS
1690 // Allocate a Pluginobj object of the appropriate size and endianness.
1693 make_sized_plugin_object(Input_file* input_file, off_t offset, off_t filesize)
1695 Pluginobj* obj = NULL;
1697 parameters_force_valid_target();
1698 const Target& target(parameters->target());
1700 if (target.get_size() == 32)
1702 if (target.is_big_endian())
1703 #ifdef HAVE_TARGET_32_BIG
1704 obj = new Sized_pluginobj<32, true>(input_file->filename(),
1705 input_file, offset, filesize);
1707 gold_error(_("%s: not configured to support "
1708 "32-bit big-endian object"),
1709 input_file->filename().c_str());
1712 #ifdef HAVE_TARGET_32_LITTLE
1713 obj = new Sized_pluginobj<32, false>(input_file->filename(),
1714 input_file, offset, filesize);
1716 gold_error(_("%s: not configured to support "
1717 "32-bit little-endian object"),
1718 input_file->filename().c_str());
1721 else if (target.get_size() == 64)
1723 if (target.is_big_endian())
1724 #ifdef HAVE_TARGET_64_BIG
1725 obj = new Sized_pluginobj<64, true>(input_file->filename(),
1726 input_file, offset, filesize);
1728 gold_error(_("%s: not configured to support "
1729 "64-bit big-endian object"),
1730 input_file->filename().c_str());
1733 #ifdef HAVE_TARGET_64_LITTLE
1734 obj = new Sized_pluginobj<64, false>(input_file->filename(),
1735 input_file, offset, filesize);
1737 gold_error(_("%s: not configured to support "
1738 "64-bit little-endian object"),
1739 input_file->filename().c_str());
1743 gold_assert(obj != NULL);
1747 } // End namespace gold.