1 // plugin.h -- plugin manager for gold -*- C++ -*-
3 // Copyright (C) 2008-2014 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.
30 #include "plugin-api.h"
31 #include "workqueue.h"
36 class General_options;
51 // This class represents a single plugin library.
56 Plugin(const char* filename)
60 claim_file_handler_(NULL),
61 all_symbols_read_handler_(NULL),
62 cleanup_handler_(NULL),
69 // Load the library and call its entry point.
73 // Call the claim-file handler.
75 claim_file(struct ld_plugin_input_file* plugin_input_file);
77 // Call the all-symbols-read handler.
81 // Call the cleanup handler.
85 // Register a claim-file handler.
87 set_claim_file_handler(ld_plugin_claim_file_handler handler)
88 { this->claim_file_handler_ = handler; }
90 // Register an all-symbols-read handler.
92 set_all_symbols_read_handler(ld_plugin_all_symbols_read_handler handler)
93 { this->all_symbols_read_handler_ = handler; }
95 // Register a claim-file handler.
97 set_cleanup_handler(ld_plugin_cleanup_handler handler)
98 { this->cleanup_handler_ = handler; }
102 add_option(const char* arg)
104 this->args_.push_back(arg);
108 Plugin(const Plugin&);
109 Plugin& operator=(const Plugin&);
111 // The shared library handle returned by dlopen.
113 // The argument string given to --plugin.
114 std::string filename_;
115 // The list of argument string given to --plugin-opt.
116 std::vector<std::string> args_;
117 // The plugin's event handlers.
118 ld_plugin_claim_file_handler claim_file_handler_;
119 ld_plugin_all_symbols_read_handler all_symbols_read_handler_;
120 ld_plugin_cleanup_handler cleanup_handler_;
121 // TRUE if the cleanup handlers have been called.
125 // A manager class for plugins.
130 Plugin_manager(const General_options& options)
131 : plugins_(), objects_(), deferred_layout_objects_(), input_file_(NULL),
132 plugin_input_file_(), rescannable_(), undefined_symbols_(),
133 any_claimed_(false), in_replacement_phase_(false), any_added_(false),
134 in_claim_file_handler_(false),
135 options_(options), workqueue_(NULL), task_(NULL), input_objects_(NULL),
136 symtab_(NULL), layout_(NULL), dirpath_(NULL), mapfile_(NULL),
137 this_blocker_(NULL), extra_search_path_(), lock_(NULL),
138 initialize_lock_(&lock_)
139 { this->current_ = plugins_.end(); }
143 // Add a plugin library.
145 add_plugin(const char* filename)
146 { this->plugins_.push_back(new Plugin(filename)); }
148 // Add an argument to the current plugin.
150 add_plugin_option(const char* opt)
152 Plugin* last = this->plugins_.back();
153 last->add_option(opt);
156 // Load all plugin libraries.
158 load_plugins(Layout* layout);
160 // Call the plugin claim-file handlers in turn to see if any claim the file.
162 claim_file(Input_file* input_file, off_t offset, off_t filesize,
165 // Get the object associated with the handle and check if it is an elf object.
166 // If it is not a Pluginobj, it is an elf object.
168 get_elf_object(const void* handle);
170 // True if the claim_file handler of the plugins is being called.
172 in_claim_file_handler()
173 { return in_claim_file_handler_; }
175 // Let the plugin manager save an archive for later rescanning.
176 // This takes ownership of the Archive pointer.
178 save_archive(Archive*);
180 // Let the plugin manager save an input group for later rescanning.
181 // This takes ownership of the Input_group pointer.
183 save_input_group(Input_group*);
185 // Call the all-symbols-read handlers.
187 all_symbols_read(Workqueue* workqueue, Task* task,
188 Input_objects* input_objects, Symbol_table* symtab,
189 Dirsearch* dirpath, Mapfile* mapfile,
190 Task_token** last_blocker);
192 // Tell the plugin manager that we've a new undefined symbol which
193 // may require rescanning.
195 new_undefined_symbol(Symbol*);
197 // Run deferred layout.
199 layout_deferred_objects();
201 // Call the cleanup handlers.
205 // Register a claim-file handler.
207 set_claim_file_handler(ld_plugin_claim_file_handler handler)
209 gold_assert(this->current_ != plugins_.end());
210 (*this->current_)->set_claim_file_handler(handler);
213 // Register an all-symbols-read handler.
215 set_all_symbols_read_handler(ld_plugin_all_symbols_read_handler handler)
217 gold_assert(this->current_ != plugins_.end());
218 (*this->current_)->set_all_symbols_read_handler(handler);
221 // Register a claim-file handler.
223 set_cleanup_handler(ld_plugin_cleanup_handler handler)
225 gold_assert(this->current_ != plugins_.end());
226 (*this->current_)->set_cleanup_handler(handler);
229 // Make a new Pluginobj object. This is called when the plugin calls
230 // the add_symbols API.
232 make_plugin_object(unsigned int handle);
234 // Return the object associated with the given HANDLE.
236 object(unsigned int handle) const
238 if (handle >= this->objects_.size())
240 return this->objects_[handle];
243 // Return TRUE if any input files have been claimed by a plugin
244 // and we are still in the initial input phase.
246 should_defer_layout() const
247 { return this->any_claimed_ && !this->in_replacement_phase_; }
249 // Add a regular object to the deferred layout list. These are
250 // objects whose layout has been deferred until after the
251 // replacement files have arrived.
253 add_deferred_layout_object(Relobj* obj)
254 { this->deferred_layout_objects_.push_back(obj); }
256 // Get input file information with an open (possibly re-opened)
259 get_input_file(unsigned int handle, struct ld_plugin_input_file* file);
262 get_view(unsigned int handle, const void **viewp);
264 // Release an input file.
266 release_input_file(unsigned int handle);
268 // Add a new input file.
270 add_input_file(const char* pathname, bool is_lib);
272 // Set the extra library path.
274 set_extra_library_path(const char* path);
276 // Return TRUE if we are in the replacement phase.
278 in_replacement_phase() const
279 { return this->in_replacement_phase_; }
282 input_objects() const
283 { return this->input_objects_; }
287 { return this->layout_; }
290 Plugin_manager(const Plugin_manager&);
291 Plugin_manager& operator=(const Plugin_manager&);
293 // Plugin_rescan is a Task which calls the private rescan method.
294 friend class Plugin_rescan;
296 // An archive or input group which may have to be rescanned if a
297 // plugin adds a new file.
304 Input_group* input_group;
307 Rescannable(Archive* archive)
309 { this->u.archive = archive; }
311 Rescannable(Input_group* input_group)
313 { this->u.input_group = input_group; }
316 typedef std::list<Plugin*> Plugin_list;
317 typedef std::vector<Object*> Object_list;
318 typedef std::vector<Relobj*> Deferred_layout_list;
319 typedef std::vector<Rescannable> Rescannable_list;
320 typedef std::vector<Symbol*> Undefined_symbol_list;
322 // Rescan archives for undefined symbols.
326 // See whether the rescannable at index I defines SYM.
328 rescannable_defines(size_t i, Symbol* sym);
330 // The list of plugin libraries.
331 Plugin_list plugins_;
332 // A pointer to the current plugin. Used while loading plugins.
333 Plugin_list::iterator current_;
335 // The list of plugin objects. The index of an item in this list
336 // serves as the "handle" that we pass to the plugins.
337 Object_list objects_;
339 // The list of regular objects whose layout has been deferred.
340 Deferred_layout_list deferred_layout_objects_;
342 // The file currently up for claim by the plugins.
343 Input_file* input_file_;
344 struct ld_plugin_input_file plugin_input_file_;
346 // A list of archives and input groups being saved for possible
348 Rescannable_list rescannable_;
350 // A list of undefined symbols found in added files.
351 Undefined_symbol_list undefined_symbols_;
353 // Whether any input files have been claimed by a plugin.
356 // Set to true after the all symbols read event; indicates that we
357 // are processing replacement files whose symbols should replace the
358 // placeholder symbols from the Pluginobj objects.
359 bool in_replacement_phase_;
361 // Whether any input files or libraries were added by a plugin.
364 // Set to true when the claim_file handler of a plugin is called.
365 bool in_claim_file_handler_;
367 const General_options& options_;
368 Workqueue* workqueue_;
370 Input_objects* input_objects_;
371 Symbol_table* symtab_;
375 Task_token* this_blocker_;
377 // An extra directory to seach for the libraries passed by
378 // add_input_library.
379 std::string extra_search_path_;
381 Initialize_lock initialize_lock_;
385 // An object file claimed by a plugin. This is an abstract base class.
386 // The implementation is the template class Sized_pluginobj.
388 class Pluginobj : public Object
392 typedef std::vector<Symbol*> Symbols;
394 Pluginobj(const std::string& name, Input_file* input_file, off_t offset,
397 // Fill in the symbol resolution status for the given plugin symbols.
399 get_symbol_resolution_info(int nsyms,
400 ld_plugin_symbol* syms,
403 // Store the incoming symbols from the plugin for later processing.
405 store_incoming_symbols(int nsyms, const struct ld_plugin_symbol* syms)
407 this->nsyms_ = nsyms;
411 // Return TRUE if the comdat group with key COMDAT_KEY from this object
414 include_comdat_group(std::string comdat_key, Layout* layout);
416 // Return the filename.
419 { return this->input_file()->filename(); }
421 // Return the file descriptor.
424 { return this->input_file()->file().descriptor(); }
426 // Return the size of the file or archive member.
429 { return this->filesize_; }
432 // Return TRUE if this is an object claimed by a plugin.
437 // The number of symbols provided by the plugin.
440 // The symbols provided by the plugin.
441 const struct ld_plugin_symbol* syms_;
443 // The entries in the symbol table for the external symbols.
447 // Size of the file (or archive member).
449 // Map a comdat key symbol to a boolean indicating whether the comdat
450 // group in this object with that key should be kept.
451 typedef Unordered_map<std::string, bool> Comdat_map;
452 Comdat_map comdat_map_;
455 // A plugin object, size-specific version.
457 template<int size, bool big_endian>
458 class Sized_pluginobj : public Pluginobj
461 Sized_pluginobj(const std::string& name, Input_file* input_file,
462 off_t offset, off_t filesize);
466 do_read_symbols(Read_symbols_data*);
468 // Lay out the input sections.
470 do_layout(Symbol_table*, Layout*, Read_symbols_data*);
472 // Add the symbols to the symbol table.
474 do_add_symbols(Symbol_table*, Read_symbols_data*, Layout*);
476 Archive::Should_include
477 do_should_include_member(Symbol_table* symtab, Layout*, Read_symbols_data*,
480 // Iterate over global symbols, calling a visitor class V for each.
482 do_for_all_global_symbols(Read_symbols_data* sd,
483 Library_base::Symbol_visitor_base* v);
485 // Iterate over local symbols, calling a visitor class V for each GOT offset
486 // associated with a local symbol.
488 do_for_all_local_got_entries(Got_offset_list::Visitor* v) const;
490 // Get the size of a section.
492 do_section_size(unsigned int shndx);
494 // Get the name of a section.
496 do_section_name(unsigned int shndx) const;
498 // Return a view of the contents of a section.
500 do_section_contents(unsigned int shndx, section_size_type* plen,
503 // Return section flags.
505 do_section_flags(unsigned int shndx);
507 // Return section entsize.
509 do_section_entsize(unsigned int shndx);
511 // Return section address.
513 do_section_address(unsigned int shndx);
515 // Return section type.
517 do_section_type(unsigned int shndx);
519 // Return the section link field.
521 do_section_link(unsigned int shndx);
523 // Return the section link field.
525 do_section_info(unsigned int shndx);
527 // Return the section alignment.
529 do_section_addralign(unsigned int shndx);
531 // Return the Xindex structure to use.
533 do_initialize_xindex();
535 // Get symbol counts.
537 do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const;
539 // Get global symbols.
541 do_get_global_symbols() const;
543 // Add placeholder symbols from a claimed file.
545 add_symbols_from_plugin(int nsyms, const ld_plugin_symbol* syms);
552 // This Task handles handles the "all symbols read" event hook.
553 // The plugin may add additional input files at this time, which must
554 // be queued for reading.
556 class Plugin_hook : public Task
559 Plugin_hook(const General_options& options, Input_objects* input_objects,
560 Symbol_table* symtab, Layout* /*layout*/, Dirsearch* dirpath,
561 Mapfile* mapfile, Task_token* this_blocker,
562 Task_token* next_blocker)
563 : options_(options), input_objects_(input_objects), symtab_(symtab),
564 dirpath_(dirpath), mapfile_(mapfile),
565 this_blocker_(this_blocker), next_blocker_(next_blocker)
570 // The standard Task methods.
583 { return "Plugin_hook"; }
586 const General_options& options_;
587 Input_objects* input_objects_;
588 Symbol_table* symtab_;
591 Task_token* this_blocker_;
592 Task_token* next_blocker_;
595 } // End namespace gold.
597 #endif // !defined(GOLD_PLUGIN_H)