1 // plugin.c -- plugin manager for gold -*- C++ -*-
3 // Copyright 2008 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.
31 #include "parameters.h"
47 // The linker's exported interfaces.
52 static enum ld_plugin_status
53 register_claim_file(ld_plugin_claim_file_handler handler);
55 static enum ld_plugin_status
56 register_all_symbols_read(ld_plugin_all_symbols_read_handler handler);
58 static enum ld_plugin_status
59 register_cleanup(ld_plugin_cleanup_handler handler);
61 static enum ld_plugin_status
62 add_symbols(void *handle, int nsyms, const struct ld_plugin_symbol *syms);
64 static enum ld_plugin_status
65 get_symbols(const void *handle, int nsyms, struct ld_plugin_symbol *syms);
67 static enum ld_plugin_status
68 add_input_file(char *pathname);
70 static enum ld_plugin_status
71 message(int level, const char *format, ...);
75 #endif // ENABLE_PLUGINS
77 static Pluginobj* make_sized_plugin_object(Input_file* input_file,
82 // Load one plugin library.
88 // Load the plugin library.
89 // FIXME: Look for the library in standard locations.
90 this->handle_ = dlopen(this->filename_.c_str(), RTLD_NOW);
91 if (this->handle_ == NULL)
93 gold_error(_("%s: could not load plugin library"),
94 this->filename_.c_str());
98 // Find the plugin's onload entry point.
99 ld_plugin_onload onload = reinterpret_cast<ld_plugin_onload>
100 (dlsym(this->handle_, "onload"));
103 gold_error(_("%s: could not find onload entry point"),
104 this->filename_.c_str());
108 // Get the linker's version number.
109 const char* ver = get_version_string();
112 sscanf(ver, "%d.%d", &major, &minor);
114 // Allocate and populate a transfer vector.
115 const int tv_fixed_size = 11;
116 int tv_size = this->args_.size() + tv_fixed_size;
117 ld_plugin_tv *tv = new ld_plugin_tv[tv_size];
119 // Put LDPT_MESSAGE at the front of the list so the plugin can use it
120 // while processing subsequent entries.
122 tv[i].tv_tag = LDPT_MESSAGE;
123 tv[i].tv_u.tv_message = message;
126 tv[i].tv_tag = LDPT_API_VERSION;
127 tv[i].tv_u.tv_val = LD_PLUGIN_API_VERSION;
130 tv[i].tv_tag = LDPT_GOLD_VERSION;
131 tv[i].tv_u.tv_val = major * 100 + minor;
134 tv[i].tv_tag = LDPT_LINKER_OUTPUT;
135 if (parameters->options().relocatable())
136 tv[i].tv_u.tv_val = LDPO_REL;
137 else if (parameters->options().shared())
138 tv[i].tv_u.tv_val = LDPO_DYN;
140 tv[i].tv_u.tv_val = LDPO_EXEC;
142 for (unsigned int j = 0; j < this->args_.size(); ++j)
145 tv[i].tv_tag = LDPT_OPTION;
146 tv[i].tv_u.tv_string = this->args_[j].c_str();
150 tv[i].tv_tag = LDPT_REGISTER_CLAIM_FILE_HOOK;
151 tv[i].tv_u.tv_register_claim_file = register_claim_file;
154 tv[i].tv_tag = LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK;
155 tv[i].tv_u.tv_register_all_symbols_read = register_all_symbols_read;
158 tv[i].tv_tag = LDPT_REGISTER_CLEANUP_HOOK;
159 tv[i].tv_u.tv_register_cleanup = register_cleanup;
162 tv[i].tv_tag = LDPT_ADD_SYMBOLS;
163 tv[i].tv_u.tv_add_symbols = add_symbols;
166 tv[i].tv_tag = LDPT_GET_SYMBOLS;
167 tv[i].tv_u.tv_get_symbols = get_symbols;
170 tv[i].tv_tag = LDPT_ADD_INPUT_FILE;
171 tv[i].tv_u.tv_add_input_file = add_input_file;
174 tv[i].tv_tag = LDPT_NULL;
175 tv[i].tv_u.tv_val = 0;
177 gold_assert(i == tv_size - 1);
179 // Call the onload entry point.
183 #endif // ENABLE_PLUGINS
186 // Call the plugin claim-file handler.
189 Plugin::claim_file(struct ld_plugin_input_file *plugin_input_file)
193 if (this->claim_file_handler_ != NULL)
195 (*this->claim_file_handler_)(plugin_input_file, &claimed);
202 // Call the all-symbols-read handler.
205 Plugin::all_symbols_read()
207 if (this->all_symbols_read_handler_ != NULL)
208 (*this->all_symbols_read_handler_)();
211 // Call the cleanup handler.
216 if (this->cleanup_handler_ != NULL)
217 (*this->cleanup_handler_)();
220 // Plugin_manager methods.
222 Plugin_manager::~Plugin_manager()
224 for (Plugin_list::iterator p = this->plugins_.begin();
225 p != this->plugins_.end();
228 this->plugins_.clear();
229 for (Object_list::iterator obj = this->objects_.begin();
230 obj != this->objects_.end();
233 this->objects_.clear();
236 // Load all plugin libraries.
239 Plugin_manager::load_plugins()
241 for (this->current_ = this->plugins_.begin();
242 this->current_ != this->plugins_.end();
244 (*this->current_)->load();
247 // Call the plugin claim-file handlers in turn to see if any claim the file.
250 Plugin_manager::claim_file(Input_file* input_file, off_t offset,
253 if (this->in_replacement_phase_)
256 unsigned int handle = this->objects_.size();
257 this->input_file_ = input_file;
258 this->plugin_input_file_.name = input_file->filename().c_str();
259 this->plugin_input_file_.fd = input_file->file().descriptor();
260 this->plugin_input_file_.offset = offset;
261 this->plugin_input_file_.filesize = filesize;
262 this->plugin_input_file_.handle = reinterpret_cast<void*>(handle);
264 for (this->current_ = this->plugins_.begin();
265 this->current_ != this->plugins_.end();
268 if ((*this->current_)->claim_file(&this->plugin_input_file_))
270 if (this->objects_.size() > handle)
271 return this->objects_[handle];
273 // If the plugin claimed the file but did not call the
274 // add_symbols callback, we need to create the Pluginobj now.
275 Pluginobj* obj = this->make_plugin_object(handle);
283 // Call the all-symbols-read handlers.
286 Plugin_manager::all_symbols_read(Workqueue* workqueue,
287 Input_objects* input_objects,
288 Symbol_table* symtab, Layout* layout,
289 Dirsearch* dirpath, Mapfile* mapfile,
290 Task_token** last_blocker)
292 this->in_replacement_phase_ = true;
293 this->workqueue_ = workqueue;
294 this->input_objects_ = input_objects;
295 this->symtab_ = symtab;
296 this->layout_ = layout;
297 this->dirpath_ = dirpath;
298 this->mapfile_ = mapfile;
299 this->this_blocker_ = NULL;
301 for (this->current_ = this->plugins_.begin();
302 this->current_ != this->plugins_.end();
304 (*this->current_)->all_symbols_read();
306 *last_blocker = this->this_blocker_;
309 // Layout deferred sections and call the cleanup handlers.
312 Plugin_manager::finish()
314 Deferred_layout_list::iterator obj;
316 for (obj = this->deferred_layout_objects_.begin();
317 obj != this->deferred_layout_objects_.end();
319 (*obj)->layout_deferred_sections(this->layout_);
321 for (this->current_ = this->plugins_.begin();
322 this->current_ != this->plugins_.end();
324 (*this->current_)->cleanup();
327 // Make a new Pluginobj object. This is called when the plugin calls
328 // the add_symbols API.
331 Plugin_manager::make_plugin_object(unsigned int handle)
333 // Make sure we aren't asked to make an object for the same handle twice.
334 if (this->objects_.size() != handle)
337 Pluginobj* obj = make_sized_plugin_object(this->input_file_,
338 this->plugin_input_file_.offset);
339 this->objects_.push_back(obj);
343 // Add a new input file.
346 Plugin_manager::add_input_file(char *pathname)
348 Input_file_argument file(pathname, false, "", false, this->options_);
349 Input_argument* input_argument = new Input_argument(file);
350 Task_token* next_blocker = new Task_token(true);
351 next_blocker->add_blocker();
352 this->workqueue_->queue_soon(new Read_symbols(this->options_,
353 this->input_objects_,
362 this->this_blocker_ = next_blocker;
368 Pluginobj::Pluginobj(const std::string& name, Input_file* input_file,
370 : Object(name, input_file, false, offset),
371 nsyms_(0), syms_(NULL), symbols_(), comdat_map_()
375 // Return TRUE if a defined symbol might be reachable from outside the
376 // universe of claimed objects.
379 is_visible_from_outside(Symbol* lsym)
381 if (lsym->in_real_elf())
383 if (parameters->options().relocatable())
385 if (parameters->options().export_dynamic() || parameters->options().shared())
386 return lsym->is_externally_visible();
390 // Get symbol resolution info.
393 Pluginobj::get_symbol_resolution_info(int nsyms, ld_plugin_symbol* syms) const
395 if (nsyms > this->nsyms_)
397 for (int i = 0; i < nsyms; i++)
399 ld_plugin_symbol* isym = &syms[i];
400 Symbol* lsym = this->symbols_[i];
401 ld_plugin_symbol_resolution res = LDPR_UNKNOWN;
403 if (lsym->is_undefined())
404 // The symbol remains undefined.
406 else if (isym->def == LDPK_UNDEF
407 || isym->def == LDPK_WEAKUNDEF
408 || isym->def == LDPK_COMMON)
410 // The original symbol was undefined or common.
411 if (lsym->source() != Symbol::FROM_OBJECT)
412 res = LDPR_RESOLVED_EXEC;
413 else if (lsym->object()->pluginobj() != NULL)
414 res = LDPR_RESOLVED_IR;
415 else if (lsym->object()->is_dynamic())
416 res = LDPR_RESOLVED_DYN;
418 res = LDPR_RESOLVED_EXEC;
422 // The original symbol was a definition.
423 if (lsym->source() != Symbol::FROM_OBJECT)
424 res = LDPR_PREEMPTED_REG;
425 else if (lsym->object() == static_cast<const Object*>(this))
426 res = (is_visible_from_outside(lsym)
427 ? LDPR_PREVAILING_DEF
428 : LDPR_PREVAILING_DEF_IRONLY);
430 res = (lsym->object()->pluginobj() != NULL
432 : LDPR_PREEMPTED_REG);
434 isym->resolution = res;
439 // Return TRUE if the comdat group with key COMDAT_KEY from this object
443 Pluginobj::include_comdat_group(std::string comdat_key, Layout* layout)
445 std::pair<Comdat_map::iterator, bool> ins =
446 this->comdat_map_.insert(std::make_pair(comdat_key, false));
448 // If this is the first time we've seen this comdat key, ask the
449 // layout object whether it should be included.
451 ins.first->second = layout->add_comdat(NULL, 1, comdat_key, true);
453 return ins.first->second;
456 // Class Sized_pluginobj.
458 template<int size, bool big_endian>
459 Sized_pluginobj<size, big_endian>::Sized_pluginobj(
460 const std::string& name,
461 Input_file* input_file,
463 : Pluginobj(name, input_file, offset)
467 // Read the symbols. Not used for plugin objects.
469 template<int size, bool big_endian>
471 Sized_pluginobj<size, big_endian>::do_read_symbols(Read_symbols_data*)
476 // Lay out the input sections. Not used for plugin objects.
478 template<int size, bool big_endian>
480 Sized_pluginobj<size, big_endian>::do_layout(Symbol_table*, Layout*,
486 // Add the symbols to the symbol table.
488 template<int size, bool big_endian>
490 Sized_pluginobj<size, big_endian>::do_add_symbols(Symbol_table*,
496 template<int size, bool big_endian>
498 Sized_pluginobj<size, big_endian>::do_add_symbols(Symbol_table* symtab,
501 const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
502 unsigned char symbuf[sym_size];
503 elfcpp::Sym<size, big_endian> sym(symbuf);
504 elfcpp::Sym_write<size, big_endian> osym(symbuf);
506 typedef typename elfcpp::Elf_types<size>::Elf_WXword Elf_size_type;
508 this->symbols_.resize(this->nsyms_);
510 for (int i = 0; i < this->nsyms_; ++i)
512 const struct ld_plugin_symbol *isym = &this->syms_[i];
513 const char* name = isym->name;
514 const char* ver = isym->version;
515 elfcpp::Elf_Half shndx;
519 if (name != NULL && name[0] == '\0')
521 if (ver != NULL && ver[0] == '\0')
528 bind = elfcpp::STB_WEAK;
534 bind = elfcpp::STB_GLOBAL;
542 shndx = elfcpp::SHN_ABS;
545 shndx = elfcpp::SHN_COMMON;
550 shndx = elfcpp::SHN_UNDEF;
554 switch (isym->visibility)
557 vis = elfcpp::STV_DEFAULT;
560 vis = elfcpp::STV_DEFAULT;
563 vis = elfcpp::STV_DEFAULT;
567 vis = elfcpp::STV_DEFAULT;
571 if (isym->comdat_key != NULL
572 && isym->comdat_key[0] != '\0'
573 && !this->include_comdat_group(isym->comdat_key, layout))
574 shndx = elfcpp::SHN_UNDEF;
577 osym.put_st_value(0);
578 osym.put_st_size(static_cast<Elf_size_type>(isym->size));
579 osym.put_st_info(bind, elfcpp::STT_NOTYPE);
580 osym.put_st_other(vis, 0);
581 osym.put_st_shndx(shndx);
584 symtab->add_from_pluginobj<size, big_endian>(this, name, ver, &sym);
588 // Get the size of a section. Not used for plugin objects.
590 template<int size, bool big_endian>
592 Sized_pluginobj<size, big_endian>::do_section_size(unsigned int)
598 // Get the name of a section. Not used for plugin objects.
600 template<int size, bool big_endian>
602 Sized_pluginobj<size, big_endian>::do_section_name(unsigned int)
605 return std::string();
608 // Return a view of the contents of a section. Not used for plugin objects.
610 template<int size, bool big_endian>
612 Sized_pluginobj<size, big_endian>::do_section_contents(unsigned int)
620 // Return section flags. Not used for plugin objects.
622 template<int size, bool big_endian>
624 Sized_pluginobj<size, big_endian>::do_section_flags(unsigned int)
630 // Return section address. Not used for plugin objects.
632 template<int size, bool big_endian>
634 Sized_pluginobj<size, big_endian>::do_section_address(unsigned int)
640 // Return section type. Not used for plugin objects.
642 template<int size, bool big_endian>
644 Sized_pluginobj<size, big_endian>::do_section_type(unsigned int)
650 // Return the section link field. Not used for plugin objects.
652 template<int size, bool big_endian>
654 Sized_pluginobj<size, big_endian>::do_section_link(unsigned int)
660 // Return the section link field. Not used for plugin objects.
662 template<int size, bool big_endian>
664 Sized_pluginobj<size, big_endian>::do_section_info(unsigned int)
670 // Return the section alignment. Not used for plugin objects.
672 template<int size, bool big_endian>
674 Sized_pluginobj<size, big_endian>::do_section_addralign(unsigned int)
680 // Return the Xindex structure to use. Not used for plugin objects.
682 template<int size, bool big_endian>
684 Sized_pluginobj<size, big_endian>::do_initialize_xindex()
690 // Get symbol counts. Not used for plugin objects.
692 template<int size, bool big_endian>
694 Sized_pluginobj<size, big_endian>::do_get_global_symbol_counts(const Symbol_table*,
695 size_t*, size_t*) const
700 // Class Add_plugin_symbols.
702 Add_plugin_symbols::~Add_plugin_symbols()
704 if (this->this_blocker_ != NULL)
705 delete this->this_blocker_;
706 // next_blocker_ is deleted by the task associated with the next
710 // We are blocked by this_blocker_. We block next_blocker_. We also
714 Add_plugin_symbols::is_runnable()
716 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
717 return this->this_blocker_;
718 if (this->obj_->is_locked())
719 return this->obj_->token();
724 Add_plugin_symbols::locks(Task_locker* tl)
726 tl->add(this, this->next_blocker_);
727 tl->add(this, this->obj_->token());
730 // Add the symbols in the object to the symbol table.
733 Add_plugin_symbols::run(Workqueue*)
735 this->obj_->add_symbols(this->symtab_, this->layout_);
738 // Class Plugin_finish. This task runs after all replacement files have
739 // been added. It calls Layout::layout for any deferred sections and
740 // calls each plugin's cleanup handler.
742 class Plugin_finish : public Task
745 Plugin_finish(Task_token* this_blocker, Task_token* next_blocker)
746 : this_blocker_(this_blocker), next_blocker_(next_blocker)
751 if (this->this_blocker_ != NULL)
752 delete this->this_blocker_;
758 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
759 return this->this_blocker_;
764 locks(Task_locker* tl)
765 { tl->add(this, this->next_blocker_); }
769 { parameters->options().plugins()->finish(); }
773 { return "Plugin_finish"; }
776 Task_token* this_blocker_;
777 Task_token* next_blocker_;
780 // Class Plugin_hook.
782 Plugin_hook::~Plugin_hook()
786 // Return whether a Plugin_hook task is runnable.
789 Plugin_hook::is_runnable()
791 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
792 return this->this_blocker_;
796 // Return a Task_locker for a Plugin_hook task. We don't need any
800 Plugin_hook::locks(Task_locker*)
804 // Run the "all symbols read" plugin hook.
807 Plugin_hook::run(Workqueue* workqueue)
809 gold_assert(this->options_.has_plugins());
810 this->options_.plugins()->all_symbols_read(workqueue,
811 this->input_objects_,
816 &this->this_blocker_);
817 workqueue->queue_soon(new Plugin_finish(this->this_blocker_,
818 this->next_blocker_));
821 // The C interface routines called by the plugins.
823 #ifdef ENABLE_PLUGINS
825 // Register a claim-file handler.
827 static enum ld_plugin_status
828 register_claim_file(ld_plugin_claim_file_handler handler)
830 gold_assert(parameters->options().has_plugins());
831 parameters->options().plugins()->set_claim_file_handler(handler);
835 // Register an all-symbols-read handler.
837 static enum ld_plugin_status
838 register_all_symbols_read(ld_plugin_all_symbols_read_handler handler)
840 gold_assert(parameters->options().has_plugins());
841 parameters->options().plugins()->set_all_symbols_read_handler(handler);
845 // Register a cleanup handler.
847 static enum ld_plugin_status
848 register_cleanup(ld_plugin_cleanup_handler handler)
850 gold_assert(parameters->options().has_plugins());
851 parameters->options().plugins()->set_cleanup_handler(handler);
855 // Add symbols from a plugin-claimed input file.
857 static enum ld_plugin_status
858 add_symbols(void* handle, int nsyms, const ld_plugin_symbol *syms)
860 gold_assert(parameters->options().has_plugins());
861 Pluginobj* obj = parameters->options().plugins()->make_plugin_object(
862 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
865 obj->store_incoming_symbols(nsyms, syms);
869 // Get the symbol resolution info for a plugin-claimed input file.
871 static enum ld_plugin_status
872 get_symbols(const void * handle, int nsyms, ld_plugin_symbol* syms)
874 gold_assert(parameters->options().has_plugins());
875 Pluginobj* obj = parameters->options().plugins()->object(
876 static_cast<unsigned int>(reinterpret_cast<intptr_t>(handle)));
879 return obj->get_symbol_resolution_info(nsyms, syms);
882 // Add a new (real) input file generated by a plugin.
884 static enum ld_plugin_status
885 add_input_file(char *pathname)
887 gold_assert(parameters->options().has_plugins());
888 return parameters->options().plugins()->add_input_file(pathname);
891 // Issue a diagnostic message from a plugin.
893 static enum ld_plugin_status
894 message(int level, const char * format, ...)
897 va_start(args, format);
902 parameters->errors()->info(format, args);
905 parameters->errors()->warning(format, args);
909 parameters->errors()->error(format, args);
912 parameters->errors()->fatal(format, args);
920 #endif // ENABLE_PLUGINS
922 // Allocate a Pluginobj object of the appropriate size and endianness.
925 make_sized_plugin_object(Input_file* input_file, off_t offset)
928 Pluginobj* obj = NULL;
930 if (parameters->target_valid())
931 target = const_cast<Target*>(¶meters->target());
933 target = const_cast<Target*>(¶meters->default_target());
935 if (target->get_size() == 32)
937 if (target->is_big_endian())
938 #ifdef HAVE_TARGET_32_BIG
939 obj = new Sized_pluginobj<32, true>(input_file->filename(),
942 gold_error(_("%s: not configured to support "
943 "32-bit big-endian object"),
944 input_file->filename().c_str());
947 #ifdef HAVE_TARGET_32_LITTLE
948 obj = new Sized_pluginobj<32, false>(input_file->filename(),
951 gold_error(_("%s: not configured to support "
952 "32-bit little-endian object"),
953 input_file->filename().c_str());
956 else if (target->get_size() == 64)
958 if (target->is_big_endian())
959 #ifdef HAVE_TARGET_64_BIG
960 obj = new Sized_pluginobj<64, true>(input_file->filename(),
963 gold_error(_("%s: not configured to support "
964 "64-bit big-endian object"),
965 input_file->filename().c_str());
968 #ifdef HAVE_TARGET_64_LITTLE
969 obj = new Sized_pluginobj<64, false>(input_file->filename(),
972 gold_error(_("%s: not configured to support "
973 "64-bit little-endian object"),
974 input_file->filename().c_str());
978 gold_assert(obj != NULL);
979 obj->set_target(target);
983 } // End namespace gold.