1 // plugin.h -- plugin manager for gold -*- C++ -*-
3 // Copyright (C) 2008-2017 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),
63 new_input_handler_(NULL),
70 // Load the library and call its entry point.
74 // Call the claim-file handler.
76 claim_file(struct ld_plugin_input_file* plugin_input_file);
78 // Call the all-symbols-read handler.
82 // Call the new_input handler.
84 new_input(struct ld_plugin_input_file* plugin_input_file);
86 // Call the cleanup handler.
90 // Register a claim-file handler.
92 set_claim_file_handler(ld_plugin_claim_file_handler handler)
93 { this->claim_file_handler_ = handler; }
95 // Register an all-symbols-read handler.
97 set_all_symbols_read_handler(ld_plugin_all_symbols_read_handler handler)
98 { this->all_symbols_read_handler_ = handler; }
100 // Register a claim-file handler.
102 set_cleanup_handler(ld_plugin_cleanup_handler handler)
103 { this->cleanup_handler_ = handler; }
105 // Register a new_input handler.
107 set_new_input_handler(ld_plugin_new_input_handler handler)
108 { this->new_input_handler_ = handler; }
112 add_option(const char* arg)
114 this->args_.push_back(arg);
118 Plugin(const Plugin&);
119 Plugin& operator=(const Plugin&);
121 // The shared library handle returned by dlopen.
123 // The argument string given to --plugin.
124 std::string filename_;
125 // The list of argument string given to --plugin-opt.
126 std::vector<std::string> args_;
127 // The plugin's event handlers.
128 ld_plugin_claim_file_handler claim_file_handler_;
129 ld_plugin_all_symbols_read_handler all_symbols_read_handler_;
130 ld_plugin_cleanup_handler cleanup_handler_;
131 ld_plugin_new_input_handler new_input_handler_;
132 // TRUE if the cleanup handlers have been called.
136 // A manager class for plugins.
141 Plugin_manager(const General_options& options)
142 : plugins_(), objects_(), deferred_layout_objects_(), input_file_(NULL),
143 plugin_input_file_(), rescannable_(), undefined_symbols_(),
144 any_claimed_(false), in_replacement_phase_(false), any_added_(false),
145 in_claim_file_handler_(false),
146 options_(options), workqueue_(NULL), task_(NULL), input_objects_(NULL),
147 symtab_(NULL), layout_(NULL), dirpath_(NULL), mapfile_(NULL),
148 this_blocker_(NULL), extra_search_path_(), lock_(NULL),
149 initialize_lock_(&lock_)
150 { this->current_ = plugins_.end(); }
154 // Add a plugin library.
156 add_plugin(const char* filename)
157 { this->plugins_.push_back(new Plugin(filename)); }
159 // Add an argument to the current plugin.
161 add_plugin_option(const char* opt)
163 Plugin* last = this->plugins_.back();
164 last->add_option(opt);
167 // Load all plugin libraries.
169 load_plugins(Layout* layout);
171 // Call the plugin claim-file handlers in turn to see if any claim the file.
173 claim_file(Input_file* input_file, off_t offset, off_t filesize,
176 // Get the object associated with the handle and check if it is an elf object.
177 // If it is not a Pluginobj, it is an elf object.
179 get_elf_object(const void* handle);
181 // True if the claim_file handler of the plugins is being called.
183 in_claim_file_handler()
184 { return in_claim_file_handler_; }
186 // Let the plugin manager save an archive for later rescanning.
187 // This takes ownership of the Archive pointer.
189 save_archive(Archive*);
191 // Let the plugin manager save an input group for later rescanning.
192 // This takes ownership of the Input_group pointer.
194 save_input_group(Input_group*);
196 // Call the all-symbols-read handlers.
198 all_symbols_read(Workqueue* workqueue, Task* task,
199 Input_objects* input_objects, Symbol_table* symtab,
200 Dirsearch* dirpath, Mapfile* mapfile,
201 Task_token** last_blocker);
203 // Tell the plugin manager that we've a new undefined symbol which
204 // may require rescanning.
206 new_undefined_symbol(Symbol*);
208 // Run deferred layout.
210 layout_deferred_objects();
212 // Call the cleanup handlers.
216 // Register a claim-file handler.
218 set_claim_file_handler(ld_plugin_claim_file_handler handler)
220 gold_assert(this->current_ != plugins_.end());
221 (*this->current_)->set_claim_file_handler(handler);
224 // Register an all-symbols-read handler.
226 set_all_symbols_read_handler(ld_plugin_all_symbols_read_handler handler)
228 gold_assert(this->current_ != plugins_.end());
229 (*this->current_)->set_all_symbols_read_handler(handler);
232 // Register a new_input handler.
234 set_new_input_handler(ld_plugin_new_input_handler handler)
236 gold_assert(this->current_ != plugins_.end());
237 (*this->current_)->set_new_input_handler(handler);
240 // Register a claim-file handler.
242 set_cleanup_handler(ld_plugin_cleanup_handler handler)
244 gold_assert(this->current_ != plugins_.end());
245 (*this->current_)->set_cleanup_handler(handler);
248 // Make a new Pluginobj object. This is called when the plugin calls
249 // the add_symbols API.
251 make_plugin_object(unsigned int handle);
253 // Return the object associated with the given HANDLE.
255 object(unsigned int handle) const
257 if (handle >= this->objects_.size())
259 return this->objects_[handle];
262 // Return TRUE if any input files have been claimed by a plugin
263 // and we are still in the initial input phase.
265 should_defer_layout() const
266 { return this->any_claimed_ && !this->in_replacement_phase_; }
268 // Add a regular object to the deferred layout list. These are
269 // objects whose layout has been deferred until after the
270 // replacement files have arrived.
272 add_deferred_layout_object(Relobj* obj)
273 { this->deferred_layout_objects_.push_back(obj); }
275 // Get input file information with an open (possibly re-opened)
278 get_input_file(unsigned int handle, struct ld_plugin_input_file* file);
281 get_view(unsigned int handle, const void **viewp);
283 // Release an input file.
285 release_input_file(unsigned int handle);
287 // Add a new input file.
289 add_input_file(const char* pathname, bool is_lib);
291 // Set the extra library path.
293 set_extra_library_path(const char* path);
295 // Return TRUE if we are in the replacement phase.
297 in_replacement_phase() const
298 { return this->in_replacement_phase_; }
301 input_objects() const
302 { return this->input_objects_; }
306 { return this->symtab_; }
310 { return this->layout_; }
313 Plugin_manager(const Plugin_manager&);
314 Plugin_manager& operator=(const Plugin_manager&);
316 // Plugin_rescan is a Task which calls the private rescan method.
317 friend class Plugin_rescan;
319 // An archive or input group which may have to be rescanned if a
320 // plugin adds a new file.
327 Input_group* input_group;
330 Rescannable(Archive* archive)
332 { this->u.archive = archive; }
334 Rescannable(Input_group* input_group)
336 { this->u.input_group = input_group; }
339 typedef std::list<Plugin*> Plugin_list;
340 typedef std::vector<Object*> Object_list;
341 typedef std::vector<Relobj*> Deferred_layout_list;
342 typedef std::vector<Rescannable> Rescannable_list;
343 typedef std::vector<Symbol*> Undefined_symbol_list;
345 // Rescan archives for undefined symbols.
349 // See whether the rescannable at index I defines SYM.
351 rescannable_defines(size_t i, Symbol* sym);
353 // The list of plugin libraries.
354 Plugin_list plugins_;
355 // A pointer to the current plugin. Used while loading plugins.
356 Plugin_list::iterator current_;
358 // The list of plugin objects. The index of an item in this list
359 // serves as the "handle" that we pass to the plugins.
360 Object_list objects_;
362 // The list of regular objects whose layout has been deferred.
363 Deferred_layout_list deferred_layout_objects_;
365 // The file currently up for claim by the plugins.
366 Input_file* input_file_;
367 struct ld_plugin_input_file plugin_input_file_;
369 // A list of archives and input groups being saved for possible
371 Rescannable_list rescannable_;
373 // A list of undefined symbols found in added files.
374 Undefined_symbol_list undefined_symbols_;
376 // Whether any input files have been claimed by a plugin.
379 // Set to true after the all symbols read event; indicates that we
380 // are processing replacement files whose symbols should replace the
381 // placeholder symbols from the Pluginobj objects.
382 bool in_replacement_phase_;
384 // Whether any input files or libraries were added by a plugin.
387 // Set to true when the claim_file handler of a plugin is called.
388 bool in_claim_file_handler_;
390 const General_options& options_;
391 Workqueue* workqueue_;
393 Input_objects* input_objects_;
394 Symbol_table* symtab_;
398 Task_token* this_blocker_;
400 // An extra directory to search for the libraries passed by
401 // add_input_library.
402 std::string extra_search_path_;
404 Initialize_lock initialize_lock_;
408 // An object file claimed by a plugin. This is an abstract base class.
409 // The implementation is the template class Sized_pluginobj.
411 class Pluginobj : public Object
415 typedef std::vector<Symbol*> Symbols;
417 Pluginobj(const std::string& name, Input_file* input_file, off_t offset,
420 // Fill in the symbol resolution status for the given plugin symbols.
422 get_symbol_resolution_info(Symbol_table* symtab,
424 ld_plugin_symbol* syms,
427 // Store the incoming symbols from the plugin for later processing.
429 store_incoming_symbols(int nsyms, const struct ld_plugin_symbol* syms)
431 this->nsyms_ = nsyms;
435 // Return TRUE if the comdat group with key COMDAT_KEY from this object
438 include_comdat_group(std::string comdat_key, Layout* layout);
440 // Return the filename.
443 { return this->input_file()->filename(); }
445 // Return the file descriptor.
448 { return this->input_file()->file().descriptor(); }
450 // Return the size of the file or archive member.
453 { return this->filesize_; }
455 // Return the word size of the object file.
458 { gold_unreachable(); }
460 // Return TRUE if this is a big-endian object file.
462 is_big_endian() const
463 { gold_unreachable(); }
466 // Return TRUE if this is an object claimed by a plugin.
471 // The number of symbols provided by the plugin.
474 // The symbols provided by the plugin.
475 const struct ld_plugin_symbol* syms_;
477 // The entries in the symbol table for the external symbols.
481 // Size of the file (or archive member).
483 // Map a comdat key symbol to a boolean indicating whether the comdat
484 // group in this object with that key should be kept.
485 typedef Unordered_map<std::string, bool> Comdat_map;
486 Comdat_map comdat_map_;
489 // A plugin object, size-specific version.
491 template<int size, bool big_endian>
492 class Sized_pluginobj : public Pluginobj
495 Sized_pluginobj(const std::string& name, Input_file* input_file,
496 off_t offset, off_t filesize);
500 do_read_symbols(Read_symbols_data*);
502 // Lay out the input sections.
504 do_layout(Symbol_table*, Layout*, Read_symbols_data*);
506 // Add the symbols to the symbol table.
508 do_add_symbols(Symbol_table*, Read_symbols_data*, Layout*);
510 Archive::Should_include
511 do_should_include_member(Symbol_table* symtab, Layout*, Read_symbols_data*,
514 // Iterate over global symbols, calling a visitor class V for each.
516 do_for_all_global_symbols(Read_symbols_data* sd,
517 Library_base::Symbol_visitor_base* v);
519 // Iterate over local symbols, calling a visitor class V for each GOT offset
520 // associated with a local symbol.
522 do_for_all_local_got_entries(Got_offset_list::Visitor* v) const;
524 // Get the size of a section.
526 do_section_size(unsigned int shndx);
528 // Get the name of a section.
530 do_section_name(unsigned int shndx) const;
532 // Return a view of the contents of a section.
534 do_section_contents(unsigned int shndx, section_size_type* plen,
537 // Return section flags.
539 do_section_flags(unsigned int shndx);
541 // Return section entsize.
543 do_section_entsize(unsigned int shndx);
545 // Return section address.
547 do_section_address(unsigned int shndx);
549 // Return section type.
551 do_section_type(unsigned int shndx);
553 // Return the section link field.
555 do_section_link(unsigned int shndx);
557 // Return the section link field.
559 do_section_info(unsigned int shndx);
561 // Return the section alignment.
563 do_section_addralign(unsigned int shndx);
565 // Return the Xindex structure to use.
567 do_initialize_xindex();
569 // Get symbol counts.
571 do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const;
573 // Get global symbols.
575 do_get_global_symbols() const;
577 // Add placeholder symbols from a claimed file.
579 add_symbols_from_plugin(int nsyms, const ld_plugin_symbol* syms);
586 // This Task handles handles the "all symbols read" event hook.
587 // The plugin may add additional input files at this time, which must
588 // be queued for reading.
590 class Plugin_hook : public Task
593 Plugin_hook(const General_options& options, Input_objects* input_objects,
594 Symbol_table* symtab, Layout* /*layout*/, Dirsearch* dirpath,
595 Mapfile* mapfile, Task_token* this_blocker,
596 Task_token* next_blocker)
597 : options_(options), input_objects_(input_objects), symtab_(symtab),
598 dirpath_(dirpath), mapfile_(mapfile),
599 this_blocker_(this_blocker), next_blocker_(next_blocker)
604 // The standard Task methods.
617 { return "Plugin_hook"; }
620 const General_options& options_;
621 Input_objects* input_objects_;
622 Symbol_table* symtab_;
625 Task_token* this_blocker_;
626 Task_token* next_blocker_;
629 } // End namespace gold.
631 #endif // !defined(GOLD_PLUGIN_H)