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();
118 static enum ld_plugin_status
119 allow_unique_segment_for_sections();
121 static enum ld_plugin_status
122 unique_segment_for_sections(const char* segment_name,
125 const struct ld_plugin_section *section_list,
126 unsigned int num_sections);
129 #endif // ENABLE_PLUGINS
131 static Pluginobj* make_sized_plugin_object(Input_file* input_file,
132 off_t offset, off_t filesize);
136 // Load one plugin library.
141 #ifdef ENABLE_PLUGINS
142 // Load the plugin library.
143 // FIXME: Look for the library in standard locations.
144 this->handle_ = dlopen(this->filename_.c_str(), RTLD_NOW);
145 if (this->handle_ == NULL)
147 gold_error(_("%s: could not load plugin library: %s"),
148 this->filename_.c_str(), dlerror());
152 // Find the plugin's onload entry point.
153 void* ptr = dlsym(this->handle_, "onload");
156 gold_error(_("%s: could not find onload entry point"),
157 this->filename_.c_str());
160 ld_plugin_onload onload;
161 gold_assert(sizeof(onload) == sizeof(ptr));
162 memcpy(&onload, &ptr, sizeof(ptr));
164 // Get the linker's version number.
165 const char* ver = get_version_string();
168 sscanf(ver, "%d.%d", &major, &minor);
170 // Allocate and populate a transfer vector.
171 const int tv_fixed_size = 26;
173 int tv_size = this->args_.size() + tv_fixed_size;
174 ld_plugin_tv* tv = new ld_plugin_tv[tv_size];
176 // Put LDPT_MESSAGE at the front of the list so the plugin can use it
177 // while processing subsequent entries.
179 tv[i].tv_tag = LDPT_MESSAGE;
180 tv[i].tv_u.tv_message = message;
183 tv[i].tv_tag = LDPT_API_VERSION;
184 tv[i].tv_u.tv_val = LD_PLUGIN_API_VERSION;
187 tv[i].tv_tag = LDPT_GOLD_VERSION;
188 tv[i].tv_u.tv_val = major * 100 + minor;
191 tv[i].tv_tag = LDPT_LINKER_OUTPUT;
192 if (parameters->options().relocatable())
193 tv[i].tv_u.tv_val = LDPO_REL;
194 else if (parameters->options().shared())
195 tv[i].tv_u.tv_val = LDPO_DYN;
196 else if (parameters->options().pie())
197 tv[i].tv_u.tv_val = LDPO_PIE;
199 tv[i].tv_u.tv_val = LDPO_EXEC;
202 tv[i].tv_tag = LDPT_OUTPUT_NAME;
203 tv[i].tv_u.tv_string = parameters->options().output();
205 for (unsigned int j = 0; j < this->args_.size(); ++j)
208 tv[i].tv_tag = LDPT_OPTION;
209 tv[i].tv_u.tv_string = this->args_[j].c_str();
213 tv[i].tv_tag = LDPT_REGISTER_CLAIM_FILE_HOOK;
214 tv[i].tv_u.tv_register_claim_file = register_claim_file;
217 tv[i].tv_tag = LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK;
218 tv[i].tv_u.tv_register_all_symbols_read = register_all_symbols_read;
221 tv[i].tv_tag = LDPT_REGISTER_CLEANUP_HOOK;
222 tv[i].tv_u.tv_register_cleanup = register_cleanup;
225 tv[i].tv_tag = LDPT_ADD_SYMBOLS;
226 tv[i].tv_u.tv_add_symbols = add_symbols;
229 tv[i].tv_tag = LDPT_GET_INPUT_FILE;
230 tv[i].tv_u.tv_get_input_file = get_input_file;
233 tv[i].tv_tag = LDPT_GET_VIEW;
234 tv[i].tv_u.tv_get_view = get_view;
237 tv[i].tv_tag = LDPT_RELEASE_INPUT_FILE;
238 tv[i].tv_u.tv_release_input_file = release_input_file;
241 tv[i].tv_tag = LDPT_GET_SYMBOLS;
242 tv[i].tv_u.tv_get_symbols = get_symbols;
245 tv[i].tv_tag = LDPT_GET_SYMBOLS_V2;
246 tv[i].tv_u.tv_get_symbols = get_symbols_v2;
249 tv[i].tv_tag = LDPT_ADD_INPUT_FILE;
250 tv[i].tv_u.tv_add_input_file = add_input_file;
253 tv[i].tv_tag = LDPT_ADD_INPUT_LIBRARY;
254 tv[i].tv_u.tv_add_input_library = add_input_library;
257 tv[i].tv_tag = LDPT_SET_EXTRA_LIBRARY_PATH;
258 tv[i].tv_u.tv_set_extra_library_path = set_extra_library_path;
261 tv[i].tv_tag = LDPT_GET_INPUT_SECTION_COUNT;
262 tv[i].tv_u.tv_get_input_section_count = get_input_section_count;
265 tv[i].tv_tag = LDPT_GET_INPUT_SECTION_TYPE;
266 tv[i].tv_u.tv_get_input_section_type = get_input_section_type;
269 tv[i].tv_tag = LDPT_GET_INPUT_SECTION_NAME;
270 tv[i].tv_u.tv_get_input_section_name = get_input_section_name;
273 tv[i].tv_tag = LDPT_GET_INPUT_SECTION_CONTENTS;
274 tv[i].tv_u.tv_get_input_section_contents = get_input_section_contents;
277 tv[i].tv_tag = LDPT_UPDATE_SECTION_ORDER;
278 tv[i].tv_u.tv_update_section_order = update_section_order;
281 tv[i].tv_tag = LDPT_ALLOW_SECTION_ORDERING;
282 tv[i].tv_u.tv_allow_section_ordering = allow_section_ordering;
285 tv[i].tv_tag = LDPT_ALLOW_UNIQUE_SEGMENT_FOR_SECTIONS;
286 tv[i].tv_u.tv_allow_unique_segment_for_sections
287 = allow_unique_segment_for_sections;
290 tv[i].tv_tag = LDPT_UNIQUE_SEGMENT_FOR_SECTIONS;
291 tv[i].tv_u.tv_unique_segment_for_sections = unique_segment_for_sections;
294 tv[i].tv_tag = LDPT_NULL;
295 tv[i].tv_u.tv_val = 0;
297 gold_assert(i == tv_size - 1);
299 // Call the onload entry point.
303 #endif // ENABLE_PLUGINS
306 // Call the plugin claim-file handler.
309 Plugin::claim_file(struct ld_plugin_input_file* plugin_input_file)
313 if (this->claim_file_handler_ != NULL)
315 (*this->claim_file_handler_)(plugin_input_file, &claimed);
322 // Call the all-symbols-read handler.
325 Plugin::all_symbols_read()
327 if (this->all_symbols_read_handler_ != NULL)
328 (*this->all_symbols_read_handler_)();
331 // Call the cleanup handler.
336 if (this->cleanup_handler_ != NULL && !this->cleanup_done_)
338 // Set this flag before calling to prevent a recursive plunge
339 // in the event that a plugin's cleanup handler issues a
341 this->cleanup_done_ = true;
342 (*this->cleanup_handler_)();
346 // This task is used to rescan archives as needed.
348 class Plugin_rescan : public Task
351 Plugin_rescan(Task_token* this_blocker, Task_token* next_blocker)
352 : this_blocker_(this_blocker), next_blocker_(next_blocker)
357 delete this->this_blocker_;
363 if (this->this_blocker_->is_blocked())
364 return this->this_blocker_;
369 locks(Task_locker* tl)
370 { tl->add(this, this->next_blocker_); }
374 { parameters->options().plugins()->rescan(this); }
378 { return "Plugin_rescan"; }
381 Task_token* this_blocker_;
382 Task_token* next_blocker_;
385 // Plugin_manager methods.
387 Plugin_manager::~Plugin_manager()
389 for (Plugin_list::iterator p = this->plugins_.begin();
390 p != this->plugins_.end();
393 this->plugins_.clear();
394 for (Object_list::iterator obj = this->objects_.begin();
395 obj != this->objects_.end();
398 this->objects_.clear();
401 // Load all plugin libraries.
404 Plugin_manager::load_plugins(Layout* layout)
406 this->layout_ = layout;
407 for (this->current_ = this->plugins_.begin();
408 this->current_ != this->plugins_.end();
410 (*this->current_)->load();
413 // Call the plugin claim-file handlers in turn to see if any claim the file.
416 Plugin_manager::claim_file(Input_file* input_file, off_t offset,
417 off_t filesize, Object* elf_object)
419 if (this->in_replacement_phase_)
422 unsigned int handle = this->objects_.size();
423 this->input_file_ = input_file;
424 this->plugin_input_file_.name = input_file->filename().c_str();
425 this->plugin_input_file_.fd = input_file->file().descriptor();
426 this->plugin_input_file_.offset = offset;
427 this->plugin_input_file_.filesize = filesize;
428 this->plugin_input_file_.handle = reinterpret_cast<void*>(handle);
429 if (elf_object != NULL)
430 this->objects_.push_back(elf_object);
431 this->in_claim_file_handler_ = true;
433 for (this->current_ = this->plugins_.begin();
434 this->current_ != this->plugins_.end();
437 if ((*this->current_)->claim_file(&this->plugin_input_file_))
439 this->any_claimed_ = true;
440 this->in_claim_file_handler_ = false;
442 if (this->objects_.size() > handle
443 && this->objects_[handle]->pluginobj() != NULL)
444 return this->objects_[handle]->pluginobj();
446 // If the plugin claimed the file but did not call the
447 // add_symbols callback, we need to create the Pluginobj now.
448 Pluginobj* obj = this->make_plugin_object(handle);
453 this->in_claim_file_handler_ = false;
457 // Save an archive. This is used so that a plugin can add a file
458 // which refers to a symbol which was not previously referenced. In
459 // that case we want to pretend that the symbol was referenced before,
460 // and pull in the archive object.
463 Plugin_manager::save_archive(Archive* archive)
465 if (this->in_replacement_phase_ || !this->any_claimed_)
468 this->rescannable_.push_back(Rescannable(archive));
471 // Save an Input_group. This is like save_archive.
474 Plugin_manager::save_input_group(Input_group* input_group)
476 if (this->in_replacement_phase_ || !this->any_claimed_)
479 this->rescannable_.push_back(Rescannable(input_group));
482 // Call the all-symbols-read handlers.
485 Plugin_manager::all_symbols_read(Workqueue* workqueue, Task* task,
486 Input_objects* input_objects,
487 Symbol_table* symtab,
488 Dirsearch* dirpath, Mapfile* mapfile,
489 Task_token** last_blocker)
491 this->in_replacement_phase_ = true;
492 this->workqueue_ = workqueue;
494 this->input_objects_ = input_objects;
495 this->symtab_ = symtab;
496 this->dirpath_ = dirpath;
497 this->mapfile_ = mapfile;
498 this->this_blocker_ = NULL;
500 for (this->current_ = this->plugins_.begin();
501 this->current_ != this->plugins_.end();
503 (*this->current_)->all_symbols_read();
505 if (this->any_added_)
507 Task_token* next_blocker = new Task_token(true);
508 next_blocker->add_blocker();
509 workqueue->queue(new Plugin_rescan(this->this_blocker_, next_blocker));
510 this->this_blocker_ = next_blocker;
513 *last_blocker = this->this_blocker_;
516 // This is called when we see a new undefined symbol. If we are in
517 // the replacement phase, this means that we may need to rescan some
518 // archives we have previously seen.
521 Plugin_manager::new_undefined_symbol(Symbol* sym)
523 if (this->in_replacement_phase_)
524 this->undefined_symbols_.push_back(sym);
527 // Rescan archives as needed. This handles the case where a new
528 // object file added by a plugin has an undefined reference to some
529 // symbol defined in an archive.
532 Plugin_manager::rescan(Task* task)
534 size_t rescan_pos = 0;
535 size_t rescan_size = this->rescannable_.size();
536 while (!this->undefined_symbols_.empty())
538 if (rescan_pos >= rescan_size)
540 this->undefined_symbols_.clear();
544 Undefined_symbol_list undefs;
545 undefs.reserve(this->undefined_symbols_.size());
546 this->undefined_symbols_.swap(undefs);
548 size_t min_rescan_pos = rescan_size;
550 for (Undefined_symbol_list::const_iterator p = undefs.begin();
554 if (!(*p)->is_undefined())
557 this->undefined_symbols_.push_back(*p);
559 // Find the first rescan archive which defines this symbol,
560 // starting at the current rescan position. The rescan position
561 // exists so that given -la -lb -lc we don't look for undefined
562 // symbols in -lb back in -la, but instead get the definition
563 // from -lc. Don't bother to look past the current minimum
565 for (size_t i = rescan_pos; i < min_rescan_pos; ++i)
567 if (this->rescannable_defines(i, *p))
575 if (min_rescan_pos >= rescan_size)
577 // We didn't find any rescannable archives which define any
578 // undefined symbols.
582 const Rescannable& r(this->rescannable_[min_rescan_pos]);
585 Task_lock_obj<Archive> tl(task, r.u.archive);
586 r.u.archive->add_symbols(this->symtab_, this->layout_,
587 this->input_objects_, this->mapfile_);
591 size_t next_saw_undefined = this->symtab_->saw_undefined();
592 size_t saw_undefined;
595 saw_undefined = next_saw_undefined;
597 for (Input_group::const_iterator p = r.u.input_group->begin();
598 p != r.u.input_group->end();
601 Task_lock_obj<Archive> tl(task, *p);
603 (*p)->add_symbols(this->symtab_, this->layout_,
604 this->input_objects_, this->mapfile_);
607 next_saw_undefined = this->symtab_->saw_undefined();
609 while (saw_undefined != next_saw_undefined);
612 for (size_t i = rescan_pos; i < min_rescan_pos + 1; ++i)
614 if (this->rescannable_[i].is_archive)
615 delete this->rescannable_[i].u.archive;
617 delete this->rescannable_[i].u.input_group;
620 rescan_pos = min_rescan_pos + 1;
624 // Return whether the rescannable at index I defines SYM.
627 Plugin_manager::rescannable_defines(size_t i, Symbol* sym)
629 const Rescannable& r(this->rescannable_[i]);
631 return r.u.archive->defines_symbol(sym);
634 for (Input_group::const_iterator p = r.u.input_group->begin();
635 p != r.u.input_group->end();
638 if ((*p)->defines_symbol(sym))
645 // Layout deferred objects.
648 Plugin_manager::layout_deferred_objects()
650 Deferred_layout_list::iterator obj;
652 for (obj = this->deferred_layout_objects_.begin();
653 obj != this->deferred_layout_objects_.end();
656 // Lock the object so we can read from it. This is only called
657 // single-threaded from queue_middle_tasks, so it is OK to lock.
658 // Unfortunately we have no way to pass in a Task token.
659 const Task* dummy_task = reinterpret_cast<const Task*>(-1);
660 Task_lock_obj<Object> tl(dummy_task, *obj);
661 (*obj)->layout_deferred_sections(this->layout_);
665 // Call the cleanup handlers.
668 Plugin_manager::cleanup()
670 for (this->current_ = this->plugins_.begin();
671 this->current_ != this->plugins_.end();
673 (*this->current_)->cleanup();
676 // Make a new Pluginobj object. This is called when the plugin calls
677 // the add_symbols API.
680 Plugin_manager::make_plugin_object(unsigned int handle)
682 // Make sure we aren't asked to make an object for the same handle twice.
683 if (this->objects_.size() != handle
684 && this->objects_[handle]->pluginobj() != NULL)
687 Pluginobj* obj = make_sized_plugin_object(this->input_file_,
688 this->plugin_input_file_.offset,
689 this->plugin_input_file_.filesize);
692 // If the elf object for this file was pushed into the objects_ vector, delete
693 // it to make room for the Pluginobj as this file is claimed.
694 if (this->objects_.size() != handle)
695 this->objects_.pop_back();
697 this->objects_.push_back(obj);
701 // Get the input file information with an open (possibly re-opened)
705 Plugin_manager::get_input_file(unsigned int handle,
706 struct ld_plugin_input_file* file)
708 Pluginobj* obj = this->object(handle)->pluginobj();
710 return LDPS_BAD_HANDLE;
712 obj->lock(this->task_);
713 file->name = obj->filename().c_str();
714 file->fd = obj->descriptor();
715 file->offset = obj->offset();
716 file->filesize = obj->filesize();
717 file->handle = reinterpret_cast<void*>(handle);
721 // Release the input file.
724 Plugin_manager::release_input_file(unsigned int handle)
726 if (this->object(handle) == NULL)
727 return LDPS_BAD_HANDLE;
729 Pluginobj* obj = this->object(handle)->pluginobj();
732 return LDPS_BAD_HANDLE;
734 obj->unlock(this->task_);
738 // Get the elf object corresponding to the handle. Return NULL if we
739 // found a Pluginobj instead.
742 Plugin_manager::get_elf_object(const void* handle)
744 Object* obj = this->object(
745 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
747 // The object should not be a Pluginobj.
749 || obj->pluginobj() != NULL)
756 Plugin_manager::get_view(unsigned int handle, const void **viewp)
760 Input_file *input_file;
761 if (this->in_claim_file_handler_)
763 // We are being called from the claim_file hook.
764 const struct ld_plugin_input_file &f = this->plugin_input_file_;
766 filesize = f.filesize;
767 input_file = this->input_file_;
771 // An already claimed file.
772 if (this->object(handle) == NULL)
773 return LDPS_BAD_HANDLE;
774 Pluginobj* obj = this->object(handle)->pluginobj();
776 return LDPS_BAD_HANDLE;
777 offset = obj->offset();
778 filesize = obj->filesize();
779 input_file = obj->input_file();
781 *viewp = (void*) input_file->file().get_view(offset, 0, filesize, false,
786 // Add a new library path.
789 Plugin_manager::set_extra_library_path(const char* path)
791 this->extra_search_path_ = std::string(path);
795 // Add a new input file.
798 Plugin_manager::add_input_file(const char* pathname, bool is_lib)
800 Input_file_argument file(pathname,
802 ? Input_file_argument::INPUT_FILE_TYPE_LIBRARY
803 : Input_file_argument::INPUT_FILE_TYPE_FILE),
805 ? this->extra_search_path_.c_str()
809 Input_argument* input_argument = new Input_argument(file);
810 Task_token* next_blocker = new Task_token(true);
811 next_blocker->add_blocker();
812 if (parameters->incremental())
813 gold_error(_("input files added by plug-ins in --incremental mode not "
815 this->workqueue_->queue_soon(new Read_symbols(this->input_objects_,
826 this->this_blocker_ = next_blocker;
827 this->any_added_ = true;
833 Pluginobj::Pluginobj(const std::string& name, Input_file* input_file,
834 off_t offset, off_t filesize)
835 : Object(name, input_file, false, offset),
836 nsyms_(0), syms_(NULL), symbols_(), filesize_(filesize), comdat_map_()
840 // Return TRUE if a defined symbol is referenced from outside the
841 // universe of claimed objects. Only references from relocatable,
842 // non-IR (unclaimed) objects count as a reference. References from
843 // dynamic objects count only as "visible".
846 is_referenced_from_outside(Symbol* lsym)
848 if (lsym->in_real_elf())
850 if (parameters->options().relocatable())
852 if (parameters->options().is_undefined(lsym->name()))
857 // Return TRUE if a defined symbol might be reachable from outside the
861 is_visible_from_outside(Symbol* lsym)
865 if (parameters->options().export_dynamic() || parameters->options().shared())
866 return lsym->is_externally_visible();
870 // Get symbol resolution info.
873 Pluginobj::get_symbol_resolution_info(int nsyms,
874 ld_plugin_symbol* syms,
877 // For version 1 of this interface, we cannot use
878 // LDPR_PREVAILING_DEF_IRONLY_EXP, so we return LDPR_PREVAILING_DEF
880 const ld_plugin_symbol_resolution ldpr_prevailing_def_ironly_exp
882 ? LDPR_PREVAILING_DEF_IRONLY_EXP
883 : LDPR_PREVAILING_DEF);
885 if (nsyms > this->nsyms_)
888 if (static_cast<size_t>(nsyms) > this->symbols_.size())
890 // We never decided to include this object. We mark all symbols as
892 gold_assert(this->symbols_.size() == 0);
893 for (int i = 0; i < nsyms; i++)
894 syms[i].resolution = LDPR_PREEMPTED_REG;
898 for (int i = 0; i < nsyms; i++)
900 ld_plugin_symbol* isym = &syms[i];
901 Symbol* lsym = this->symbols_[i];
902 ld_plugin_symbol_resolution res = LDPR_UNKNOWN;
904 if (lsym->is_undefined())
905 // The symbol remains undefined.
907 else if (isym->def == LDPK_UNDEF
908 || isym->def == LDPK_WEAKUNDEF
909 || isym->def == LDPK_COMMON)
911 // The original symbol was undefined or common.
912 if (lsym->source() != Symbol::FROM_OBJECT)
913 res = LDPR_RESOLVED_EXEC;
914 else if (lsym->object()->pluginobj() == this)
916 if (is_referenced_from_outside(lsym))
917 res = LDPR_PREVAILING_DEF;
918 else if (is_visible_from_outside(lsym))
919 res = ldpr_prevailing_def_ironly_exp;
921 res = LDPR_PREVAILING_DEF_IRONLY;
923 else if (lsym->object()->pluginobj() != NULL)
924 res = LDPR_RESOLVED_IR;
925 else if (lsym->object()->is_dynamic())
926 res = LDPR_RESOLVED_DYN;
928 res = LDPR_RESOLVED_EXEC;
932 // The original symbol was a definition.
933 if (lsym->source() != Symbol::FROM_OBJECT)
934 res = LDPR_PREEMPTED_REG;
935 else if (lsym->object() == static_cast<const Object*>(this))
937 if (is_referenced_from_outside(lsym))
938 res = LDPR_PREVAILING_DEF;
939 else if (is_visible_from_outside(lsym))
940 res = ldpr_prevailing_def_ironly_exp;
942 res = LDPR_PREVAILING_DEF_IRONLY;
945 res = (lsym->object()->pluginobj() != NULL
947 : LDPR_PREEMPTED_REG);
949 isym->resolution = res;
954 // Return TRUE if the comdat group with key COMDAT_KEY from this object
958 Pluginobj::include_comdat_group(std::string comdat_key, Layout* layout)
960 std::pair<Comdat_map::iterator, bool> ins =
961 this->comdat_map_.insert(std::make_pair(comdat_key, false));
963 // If this is the first time we've seen this comdat key, ask the
964 // layout object whether it should be included.
966 ins.first->second = layout->find_or_add_kept_section(comdat_key,
970 return ins.first->second;
973 // Class Sized_pluginobj.
975 template<int size, bool big_endian>
976 Sized_pluginobj<size, big_endian>::Sized_pluginobj(
977 const std::string& name,
978 Input_file* input_file,
981 : Pluginobj(name, input_file, offset, filesize)
985 // Read the symbols. Not used for plugin objects.
987 template<int size, bool big_endian>
989 Sized_pluginobj<size, big_endian>::do_read_symbols(Read_symbols_data*)
994 // Lay out the input sections. Not used for plugin objects.
996 template<int size, bool big_endian>
998 Sized_pluginobj<size, big_endian>::do_layout(Symbol_table*, Layout*,
1004 // Add the symbols to the symbol table.
1006 template<int size, bool big_endian>
1008 Sized_pluginobj<size, big_endian>::do_add_symbols(Symbol_table* symtab,
1012 const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
1013 unsigned char symbuf[sym_size];
1014 elfcpp::Sym<size, big_endian> sym(symbuf);
1015 elfcpp::Sym_write<size, big_endian> osym(symbuf);
1017 typedef typename elfcpp::Elf_types<size>::Elf_WXword Elf_size_type;
1019 this->symbols_.resize(this->nsyms_);
1021 for (int i = 0; i < this->nsyms_; ++i)
1023 const struct ld_plugin_symbol* isym = &this->syms_[i];
1024 const char* name = isym->name;
1025 const char* ver = isym->version;
1026 elfcpp::Elf_Half shndx;
1030 if (name != NULL && name[0] == '\0')
1032 if (ver != NULL && ver[0] == '\0')
1038 case LDPK_WEAKUNDEF:
1039 bind = elfcpp::STB_WEAK;
1045 bind = elfcpp::STB_GLOBAL;
1053 shndx = elfcpp::SHN_ABS;
1056 shndx = elfcpp::SHN_COMMON;
1059 case LDPK_WEAKUNDEF:
1061 shndx = elfcpp::SHN_UNDEF;
1065 switch (isym->visibility)
1067 case LDPV_PROTECTED:
1068 vis = elfcpp::STV_PROTECTED;
1071 vis = elfcpp::STV_INTERNAL;
1074 vis = elfcpp::STV_HIDDEN;
1078 vis = elfcpp::STV_DEFAULT;
1082 if (isym->comdat_key != NULL
1083 && isym->comdat_key[0] != '\0'
1084 && !this->include_comdat_group(isym->comdat_key, layout))
1085 shndx = elfcpp::SHN_UNDEF;
1087 osym.put_st_name(0);
1088 osym.put_st_value(0);
1089 osym.put_st_size(static_cast<Elf_size_type>(isym->size));
1090 osym.put_st_info(bind, elfcpp::STT_NOTYPE);
1091 osym.put_st_other(vis, 0);
1092 osym.put_st_shndx(shndx);
1095 symtab->add_from_pluginobj<size, big_endian>(this, name, ver, &sym);
1099 template<int size, bool big_endian>
1100 Archive::Should_include
1101 Sized_pluginobj<size, big_endian>::do_should_include_member(
1102 Symbol_table* symtab,
1107 char* tmpbuf = NULL;
1108 size_t tmpbuflen = 0;
1110 for (int i = 0; i < this->nsyms_; ++i)
1112 const struct ld_plugin_symbol& sym = this->syms_[i];
1113 const char* name = sym.name;
1115 Archive::Should_include t = Archive::should_include_member(symtab,
1121 if (t == Archive::SHOULD_INCLUDE_YES)
1130 return Archive::SHOULD_INCLUDE_UNKNOWN;
1133 // Iterate over global symbols, calling a visitor class V for each.
1135 template<int size, bool big_endian>
1137 Sized_pluginobj<size, big_endian>::do_for_all_global_symbols(
1139 Library_base::Symbol_visitor_base* v)
1141 for (int i = 0; i < this->nsyms_; ++i)
1143 const struct ld_plugin_symbol& sym = this->syms_[i];
1144 if (sym.def != LDPK_UNDEF)
1149 // Iterate over local symbols, calling a visitor class V for each GOT offset
1150 // associated with a local symbol.
1151 template<int size, bool big_endian>
1153 Sized_pluginobj<size, big_endian>::do_for_all_local_got_entries(
1154 Got_offset_list::Visitor*) const
1159 // Get the size of a section. Not used for plugin objects.
1161 template<int size, bool big_endian>
1163 Sized_pluginobj<size, big_endian>::do_section_size(unsigned int)
1169 // Get the name of a section. Not used for plugin objects.
1171 template<int size, bool big_endian>
1173 Sized_pluginobj<size, big_endian>::do_section_name(unsigned int)
1176 return std::string();
1179 // Return a view of the contents of a section. Not used for plugin objects.
1181 template<int size, bool big_endian>
1182 const unsigned char*
1183 Sized_pluginobj<size, big_endian>::do_section_contents(
1192 // Return section flags. Not used for plugin objects.
1194 template<int size, bool big_endian>
1196 Sized_pluginobj<size, big_endian>::do_section_flags(unsigned int)
1202 // Return section entsize. Not used for plugin objects.
1204 template<int size, bool big_endian>
1206 Sized_pluginobj<size, big_endian>::do_section_entsize(unsigned int)
1212 // Return section address. Not used for plugin objects.
1214 template<int size, bool big_endian>
1216 Sized_pluginobj<size, big_endian>::do_section_address(unsigned int)
1222 // Return section type. Not used for plugin objects.
1224 template<int size, bool big_endian>
1226 Sized_pluginobj<size, big_endian>::do_section_type(unsigned int)
1232 // Return the section link field. Not used for plugin objects.
1234 template<int size, bool big_endian>
1236 Sized_pluginobj<size, big_endian>::do_section_link(unsigned int)
1242 // Return the section link field. Not used for plugin objects.
1244 template<int size, bool big_endian>
1246 Sized_pluginobj<size, big_endian>::do_section_info(unsigned int)
1252 // Return the section alignment. Not used for plugin objects.
1254 template<int size, bool big_endian>
1256 Sized_pluginobj<size, big_endian>::do_section_addralign(unsigned int)
1262 // Return the Xindex structure to use. Not used for plugin objects.
1264 template<int size, bool big_endian>
1266 Sized_pluginobj<size, big_endian>::do_initialize_xindex()
1272 // Get symbol counts. Don't count plugin objects; the replacement
1273 // files will provide the counts.
1275 template<int size, bool big_endian>
1277 Sized_pluginobj<size, big_endian>::do_get_global_symbol_counts(
1278 const Symbol_table*,
1286 // Get symbols. Not used for plugin objects.
1288 template<int size, bool big_endian>
1289 const Object::Symbols*
1290 Sized_pluginobj<size, big_endian>::do_get_global_symbols() const
1295 // Class Plugin_finish. This task runs after all replacement files have
1296 // been added. For now, it's a placeholder for a possible plugin API
1297 // to allow the plugin to release most of its resources. The cleanup
1298 // handlers must be called later, because they can remove the temporary
1299 // object files that are needed until the end of the link.
1301 class Plugin_finish : public Task
1304 Plugin_finish(Task_token* this_blocker, Task_token* next_blocker)
1305 : this_blocker_(this_blocker), next_blocker_(next_blocker)
1310 if (this->this_blocker_ != NULL)
1311 delete this->this_blocker_;
1317 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
1318 return this->this_blocker_;
1323 locks(Task_locker* tl)
1324 { tl->add(this, this->next_blocker_); }
1329 // We could call early cleanup handlers here.
1334 { return "Plugin_finish"; }
1337 Task_token* this_blocker_;
1338 Task_token* next_blocker_;
1341 // Class Plugin_hook.
1343 Plugin_hook::~Plugin_hook()
1347 // Return whether a Plugin_hook task is runnable.
1350 Plugin_hook::is_runnable()
1352 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
1353 return this->this_blocker_;
1357 // Return a Task_locker for a Plugin_hook task. We don't need any
1361 Plugin_hook::locks(Task_locker*)
1365 // Run the "all symbols read" plugin hook.
1368 Plugin_hook::run(Workqueue* workqueue)
1370 gold_assert(this->options_.has_plugins());
1371 Symbol* start_sym = this->symtab_->lookup(parameters->entry());
1372 if (start_sym != NULL)
1373 start_sym->set_in_real_elf();
1375 this->options_.plugins()->all_symbols_read(workqueue,
1377 this->input_objects_,
1381 &this->this_blocker_);
1382 workqueue->queue_soon(new Plugin_finish(this->this_blocker_,
1383 this->next_blocker_));
1386 // The C interface routines called by the plugins.
1388 #ifdef ENABLE_PLUGINS
1390 // Register a claim-file handler.
1392 static enum ld_plugin_status
1393 register_claim_file(ld_plugin_claim_file_handler handler)
1395 gold_assert(parameters->options().has_plugins());
1396 parameters->options().plugins()->set_claim_file_handler(handler);
1400 // Register an all-symbols-read handler.
1402 static enum ld_plugin_status
1403 register_all_symbols_read(ld_plugin_all_symbols_read_handler handler)
1405 gold_assert(parameters->options().has_plugins());
1406 parameters->options().plugins()->set_all_symbols_read_handler(handler);
1410 // Register a cleanup handler.
1412 static enum ld_plugin_status
1413 register_cleanup(ld_plugin_cleanup_handler handler)
1415 gold_assert(parameters->options().has_plugins());
1416 parameters->options().plugins()->set_cleanup_handler(handler);
1420 // Add symbols from a plugin-claimed input file.
1422 static enum ld_plugin_status
1423 add_symbols(void* handle, int nsyms, const ld_plugin_symbol* syms)
1425 gold_assert(parameters->options().has_plugins());
1426 Pluginobj* obj = parameters->options().plugins()->make_plugin_object(
1427 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
1430 obj->store_incoming_symbols(nsyms, syms);
1434 // Get the input file information with an open (possibly re-opened)
1437 static enum ld_plugin_status
1438 get_input_file(const void* handle, struct ld_plugin_input_file* file)
1440 gold_assert(parameters->options().has_plugins());
1441 unsigned int obj_index =
1442 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
1443 return parameters->options().plugins()->get_input_file(obj_index, file);
1446 // Release the input file.
1448 static enum ld_plugin_status
1449 release_input_file(const void* handle)
1451 gold_assert(parameters->options().has_plugins());
1452 unsigned int obj_index =
1453 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
1454 return parameters->options().plugins()->release_input_file(obj_index);
1457 static enum ld_plugin_status
1458 get_view(const void *handle, const void **viewp)
1460 gold_assert(parameters->options().has_plugins());
1461 unsigned int obj_index =
1462 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle));
1463 return parameters->options().plugins()->get_view(obj_index, viewp);
1466 // Get the symbol resolution info for a plugin-claimed input file.
1468 static enum ld_plugin_status
1469 get_symbols(const void* handle, int nsyms, ld_plugin_symbol* syms)
1471 gold_assert(parameters->options().has_plugins());
1472 Object* obj = parameters->options().plugins()->object(
1473 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
1476 Pluginobj* plugin_obj = obj->pluginobj();
1477 if (plugin_obj == NULL)
1479 return plugin_obj->get_symbol_resolution_info(nsyms, syms, 1);
1482 // Version 2 of the above. The only difference is that this version
1483 // is allowed to return the resolution code LDPR_PREVAILING_DEF_IRONLY_EXP.
1485 static enum ld_plugin_status
1486 get_symbols_v2(const void* handle, int nsyms, ld_plugin_symbol* syms)
1488 gold_assert(parameters->options().has_plugins());
1489 Object* obj = parameters->options().plugins()->object(
1490 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
1493 Pluginobj* plugin_obj = obj->pluginobj();
1494 if (plugin_obj == NULL)
1496 return plugin_obj->get_symbol_resolution_info(nsyms, syms, 2);
1499 // Add a new (real) input file generated by a plugin.
1501 static enum ld_plugin_status
1502 add_input_file(const char* pathname)
1504 gold_assert(parameters->options().has_plugins());
1505 return parameters->options().plugins()->add_input_file(pathname, false);
1508 // Add a new (real) library required by a plugin.
1510 static enum ld_plugin_status
1511 add_input_library(const char* pathname)
1513 gold_assert(parameters->options().has_plugins());
1514 return parameters->options().plugins()->add_input_file(pathname, true);
1517 // Set the extra library path to be used by libraries added via
1518 // add_input_library
1520 static enum ld_plugin_status
1521 set_extra_library_path(const char* path)
1523 gold_assert(parameters->options().has_plugins());
1524 return parameters->options().plugins()->set_extra_library_path(path);
1527 // Issue a diagnostic message from a plugin.
1529 static enum ld_plugin_status
1530 message(int level, const char* format, ...)
1533 va_start(args, format);
1538 parameters->errors()->info(format, args);
1541 parameters->errors()->warning(format, args);
1545 parameters->errors()->error(format, args);
1548 parameters->errors()->fatal(format, args);
1556 // Get the section count of the object corresponding to the handle. This
1557 // plugin interface can only be called in the claim_file handler of the plugin.
1559 static enum ld_plugin_status
1560 get_input_section_count(const void* handle, unsigned int* count)
1562 gold_assert(parameters->options().has_plugins());
1564 if (!parameters->options().plugins()->in_claim_file_handler())
1567 Object* obj = parameters->options().plugins()->get_elf_object(handle);
1572 *count = obj->shnum();
1576 // Get the type of the specified section in the object corresponding
1577 // to the handle. This plugin interface can only be called in the
1578 // claim_file handler of the plugin.
1580 static enum ld_plugin_status
1581 get_input_section_type(const struct ld_plugin_section section,
1584 gold_assert(parameters->options().has_plugins());
1586 if (!parameters->options().plugins()->in_claim_file_handler())
1590 = parameters->options().plugins()->get_elf_object(section.handle);
1593 return LDPS_BAD_HANDLE;
1595 *type = obj->section_type(section.shndx);
1599 // Get the name of the specified section in the object corresponding
1600 // to the handle. This plugin interface can only be called in the
1601 // claim_file handler of the plugin.
1603 static enum ld_plugin_status
1604 get_input_section_name(const struct ld_plugin_section section,
1605 char** section_name_ptr)
1607 gold_assert(parameters->options().has_plugins());
1609 if (!parameters->options().plugins()->in_claim_file_handler())
1613 = parameters->options().plugins()->get_elf_object(section.handle);
1616 return LDPS_BAD_HANDLE;
1618 // Check if the object is locked before getting the section name.
1619 gold_assert(obj->is_locked());
1621 const std::string section_name = obj->section_name(section.shndx);
1622 *section_name_ptr = static_cast<char*>(malloc(section_name.length() + 1));
1623 memcpy(*section_name_ptr, section_name.c_str(), section_name.length() + 1);
1627 // Get the contents of the specified section in the object corresponding
1628 // to the handle. This plugin interface can only be called in the
1629 // claim_file handler of the plugin.
1631 static enum ld_plugin_status
1632 get_input_section_contents(const struct ld_plugin_section section,
1633 const unsigned char** section_contents_ptr,
1636 gold_assert(parameters->options().has_plugins());
1638 if (!parameters->options().plugins()->in_claim_file_handler())
1642 = parameters->options().plugins()->get_elf_object(section.handle);
1645 return LDPS_BAD_HANDLE;
1647 // Check if the object is locked before getting the section contents.
1648 gold_assert(obj->is_locked());
1650 section_size_type plen;
1651 *section_contents_ptr
1652 = obj->section_contents(section.shndx, &plen, false);
1657 // Specify the ordering of sections in the final layout. The sections are
1658 // specified as (handle,shndx) pairs in the two arrays in the order in
1659 // which they should appear in the final layout.
1661 static enum ld_plugin_status
1662 update_section_order(const struct ld_plugin_section* section_list,
1663 unsigned int num_sections)
1665 gold_assert(parameters->options().has_plugins());
1667 if (num_sections == 0)
1670 if (section_list == NULL)
1673 Layout* layout = parameters->options().plugins()->layout();
1674 gold_assert (layout != NULL);
1676 std::map<Section_id, unsigned int>* order_map
1677 = layout->get_section_order_map();
1679 /* Store the mapping from Section_id to section position in layout's
1680 order_map to consult after output sections are added. */
1681 for (unsigned int i = 0; i < num_sections; ++i)
1683 Object* obj = parameters->options().plugins()->get_elf_object(
1684 section_list[i].handle);
1686 return LDPS_BAD_HANDLE;
1687 unsigned int shndx = section_list[i].shndx;
1688 Section_id secn_id(obj, shndx);
1689 (*order_map)[secn_id] = i + 1;
1695 // Let the linker know that the sections could be reordered.
1697 static enum ld_plugin_status
1698 allow_section_ordering()
1700 gold_assert(parameters->options().has_plugins());
1701 Layout* layout = parameters->options().plugins()->layout();
1702 layout->set_section_ordering_specified();
1706 // Let the linker know that a subset of sections could be mapped
1707 // to a unique segment.
1709 static enum ld_plugin_status
1710 allow_unique_segment_for_sections()
1712 gold_assert(parameters->options().has_plugins());
1713 Layout* layout = parameters->options().plugins()->layout();
1714 layout->set_unique_segment_for_sections_specified();
1718 // This function should map the list of sections specified in the
1719 // SECTION_LIST to a unique segment. ELF segments do not have names
1720 // and the NAME is used to identify Output Section which should contain
1721 // the list of sections. This Output Section will then be mapped to
1722 // a unique segment. FLAGS is used to specify if any additional segment
1723 // flags need to be set. For instance, a specific segment flag can be
1724 // set to identify this segment. Unsetting segment flags is not possible.
1725 // ALIGN specifies the alignment of the segment.
1727 static enum ld_plugin_status
1728 unique_segment_for_sections(const char* segment_name,
1731 const struct ld_plugin_section* section_list,
1732 unsigned int num_sections)
1734 gold_assert(parameters->options().has_plugins());
1736 if (num_sections == 0)
1739 if (section_list == NULL)
1742 Layout* layout = parameters->options().plugins()->layout();
1743 gold_assert (layout != NULL);
1745 Layout::Unique_segment_info* s = new Layout::Unique_segment_info;
1746 s->name = segment_name;
1750 for (unsigned int i = 0; i < num_sections; ++i)
1752 Object* obj = parameters->options().plugins()->get_elf_object(
1753 section_list[i].handle);
1755 return LDPS_BAD_HANDLE;
1756 unsigned int shndx = section_list[i].shndx;
1757 Const_section_id secn_id(obj, shndx);
1758 layout->insert_section_segment_map(secn_id, s);
1764 #endif // ENABLE_PLUGINS
1766 // Allocate a Pluginobj object of the appropriate size and endianness.
1769 make_sized_plugin_object(Input_file* input_file, off_t offset, off_t filesize)
1771 Pluginobj* obj = NULL;
1773 parameters_force_valid_target();
1774 const Target& target(parameters->target());
1776 if (target.get_size() == 32)
1778 if (target.is_big_endian())
1779 #ifdef HAVE_TARGET_32_BIG
1780 obj = new Sized_pluginobj<32, true>(input_file->filename(),
1781 input_file, offset, filesize);
1783 gold_error(_("%s: not configured to support "
1784 "32-bit big-endian object"),
1785 input_file->filename().c_str());
1788 #ifdef HAVE_TARGET_32_LITTLE
1789 obj = new Sized_pluginobj<32, false>(input_file->filename(),
1790 input_file, offset, filesize);
1792 gold_error(_("%s: not configured to support "
1793 "32-bit little-endian object"),
1794 input_file->filename().c_str());
1797 else if (target.get_size() == 64)
1799 if (target.is_big_endian())
1800 #ifdef HAVE_TARGET_64_BIG
1801 obj = new Sized_pluginobj<64, true>(input_file->filename(),
1802 input_file, offset, filesize);
1804 gold_error(_("%s: not configured to support "
1805 "64-bit big-endian object"),
1806 input_file->filename().c_str());
1809 #ifdef HAVE_TARGET_64_LITTLE
1810 obj = new Sized_pluginobj<64, false>(input_file->filename(),
1811 input_file, offset, filesize);
1813 gold_error(_("%s: not configured to support "
1814 "64-bit little-endian object"),
1815 input_file->filename().c_str());
1819 gold_assert(obj != NULL);
1823 } // End namespace gold.