1 // plugin.h -- 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.
30 #include "plugin-api.h"
31 #include "workqueue.h"
36 class General_options;
46 // This class represents a single plugin library.
51 Plugin(const char* args)
54 claim_file_handler_(NULL),
55 all_symbols_read_handler_(NULL),
56 cleanup_handler_(NULL)
62 // Load the library and call its entry point.
66 // Call the claim-file handler.
68 claim_file(struct ld_plugin_input_file *plugin_input_file);
70 // Call the all-symbols-read handler.
74 // Call the cleanup handler.
78 // Register a claim-file handler.
80 set_claim_file_handler(ld_plugin_claim_file_handler handler)
81 { this->claim_file_handler_ = handler; }
83 // Register an all-symbols-read handler.
85 set_all_symbols_read_handler(ld_plugin_all_symbols_read_handler handler)
86 { this->all_symbols_read_handler_ = handler; }
88 // Register a claim-file handler.
90 set_cleanup_handler(ld_plugin_cleanup_handler handler)
91 { this->cleanup_handler_ = handler; }
94 Plugin(const Plugin&);
95 Plugin& operator=(const Plugin&);
97 // The shared library handle returned by dlopen.
99 // The argument string given to --plugin.
101 // The plugin's event handlers.
102 ld_plugin_claim_file_handler claim_file_handler_;
103 ld_plugin_all_symbols_read_handler all_symbols_read_handler_;
104 ld_plugin_cleanup_handler cleanup_handler_;
107 // A manager class for plugins.
112 Plugin_manager(const General_options& options)
113 : plugins_(), in_replacement_phase_(false), options_(options),
114 workqueue_(NULL), input_objects_(NULL), symtab_(NULL), layout_(NULL),
115 dirpath_(NULL), mapfile_(NULL), this_blocker_(NULL)
116 { this->current_ = plugins_.end(); }
120 // Add a plugin library.
122 add_plugin(const char* args)
123 { this->plugins_.push_back(new Plugin(args)); }
125 // Load all plugin libraries.
129 // Call the plugin claim-file handlers in turn to see if any claim the file.
131 claim_file(Input_file *input_file, off_t offset, off_t filesize);
133 // Call the all-symbols-read handlers.
135 all_symbols_read(Workqueue* workqueue, Input_objects* input_objects,
136 Symbol_table* symtab, Layout* layout, Dirsearch* dirpath,
137 Mapfile* mapfile, Task_token** last_blocker);
139 // Call the cleanup handlers.
143 // Register a claim-file handler.
145 set_claim_file_handler(ld_plugin_claim_file_handler handler)
147 gold_assert(this->current_ != plugins_.end());
148 (*this->current_)->set_claim_file_handler(handler);
151 // Register an all-symbols-read handler.
153 set_all_symbols_read_handler(ld_plugin_all_symbols_read_handler handler)
155 gold_assert(this->current_ != plugins_.end());
156 (*this->current_)->set_all_symbols_read_handler(handler);
159 // Register a claim-file handler.
161 set_cleanup_handler(ld_plugin_cleanup_handler handler)
163 gold_assert(this->current_ != plugins_.end());
164 (*this->current_)->set_cleanup_handler(handler);
167 // Make a new Pluginobj object. This is called when the plugin calls
168 // the add_symbols API.
170 make_plugin_object(unsigned int handle);
172 // Return the Pluginobj associated with the given HANDLE.
174 object(unsigned int handle) const
176 if (handle >= this->objects_.size())
178 return this->objects_[handle];
181 // Add a new input file.
183 add_input_file(char *pathname);
185 // Return TRUE if we are in the replacement phase.
187 in_replacement_phase() const
188 { return this->in_replacement_phase_; }
191 Plugin_manager(const Plugin_manager&);
192 Plugin_manager& operator=(const Plugin_manager&);
194 typedef std::list<Plugin*> Plugin_list;
195 typedef std::vector<Pluginobj*> Object_list;
197 // The list of plugin libraries.
198 Plugin_list plugins_;
199 // A pointer to the current plugin. Used while loading plugins.
200 Plugin_list::iterator current_;
202 // The list of plugin objects. The index of an item in this list
203 // serves as the "handle" that we pass to the plugins.
204 Object_list objects_;
206 // The file currently up for claim by the plugins.
207 Input_file* input_file_;
208 struct ld_plugin_input_file plugin_input_file_;
210 // TRUE after the all symbols read event; indicates that we are
211 // processing replacement files whose symbols should replace the
212 // placeholder symbols from the Pluginobj objects.
213 bool in_replacement_phase_;
215 const General_options& options_;
216 Workqueue* workqueue_;
217 Input_objects* input_objects_;
218 Symbol_table* symtab_;
222 Task_token* this_blocker_;
226 // An object file claimed by a plugin. This is an abstract base class.
227 // The implementation is the template class Sized_pluginobj.
229 class Pluginobj : public Object
233 typedef std::vector<Symbol*> Symbols;
235 Pluginobj(const std::string& name, Input_file* input_file, off_t offset);
237 // Fill in the symbol resolution status for the given plugin symbols.
239 get_symbol_resolution_info(int nsyms, ld_plugin_symbol* syms) const;
241 // Add symbol information to the global symbol table.
243 add_symbols(Symbol_table* symtab, Layout* layout)
244 { this->do_add_symbols(symtab, layout); }
246 // Store the incoming symbols from the plugin for later processing.
248 store_incoming_symbols(int nsyms, const struct ld_plugin_symbol* syms)
250 this->nsyms_ = nsyms;
254 // Return TRUE if the comdat group with key COMDAT_KEY from this object
257 include_comdat_group(std::string comdat_key, Layout* layout);
260 // Return TRUE if this is an object claimed by a plugin.
265 // Add symbol information to the global symbol table--implemented by
268 do_add_symbols(Symbol_table*, Layout*) = 0;
270 // The number of symbols provided by the plugin.
273 // The symbols provided by the plugin.
274 const struct ld_plugin_symbol* syms_;
276 // The entries in the symbol table for the external symbols.
280 // Map a comdat key symbol to a boolean indicating whether the comdat
281 // group in this object with that key should be kept.
282 typedef Unordered_map<std::string, bool> Comdat_map;
283 Comdat_map comdat_map_;
286 // A plugin object, size-specific version.
288 template<int size, bool big_endian>
289 class Sized_pluginobj : public Pluginobj
292 Sized_pluginobj(const std::string& name, Input_file* input_file,
297 do_read_symbols(Read_symbols_data*);
299 // Lay out the input sections.
301 do_layout(Symbol_table*, Layout*, Read_symbols_data*);
303 // Add the symbols to the symbol table.
305 do_add_symbols(Symbol_table*, Read_symbols_data*);
308 do_add_symbols(Symbol_table*, Layout*);
310 // Get the size of a section.
312 do_section_size(unsigned int shndx);
314 // Get the name of a section.
316 do_section_name(unsigned int shndx);
318 // Return a view of the contents of a section.
320 do_section_contents(unsigned int shndx);
322 // Return section flags.
324 do_section_flags(unsigned int shndx);
326 // Return section address.
328 do_section_address(unsigned int shndx);
330 // Return section type.
332 do_section_type(unsigned int shndx);
334 // Return the section link field.
336 do_section_link(unsigned int shndx);
338 // Return the section link field.
340 do_section_info(unsigned int shndx);
342 // Return the section alignment.
344 do_section_addralign(unsigned int shndx);
346 // Return the Xindex structure to use.
348 do_initialize_xindex();
350 // Get symbol counts.
352 do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const;
354 // Add placeholder symbols from a claimed file.
356 add_symbols_from_plugin(int nsyms, const ld_plugin_symbol* syms);
363 // This Task handles adding the symbols to the symbol table. These
364 // tasks must be run in the same order as the arguments appear on the
367 class Add_plugin_symbols : public Task
370 // THIS_BLOCKER is used to prevent this task from running before the
371 // one for the previous input file. NEXT_BLOCKER is used to prevent
372 // the next task from running.
373 Add_plugin_symbols(Symbol_table* symtab,
376 Task_token* this_blocker,
377 Task_token* next_blocker)
378 : symtab_(symtab), layout_(layout), obj_(obj),
379 this_blocker_(this_blocker), next_blocker_(next_blocker)
382 ~Add_plugin_symbols();
384 // The standard Task methods.
397 { return "Add_plugin_symbols " + this->obj_->name(); }
400 Symbol_table* symtab_;
403 Task_token* this_blocker_;
404 Task_token* next_blocker_;
407 // This Task handles handles the "all symbols read" event hook.
408 // The plugin may add additional input files at this time, which must
409 // be queued for reading.
411 class Plugin_hook : public Task
414 Plugin_hook(const General_options& options, Input_objects* input_objects,
415 Symbol_table* symtab, Layout* layout, Dirsearch* dirpath,
416 Mapfile* mapfile, Task_token* this_blocker,
417 Task_token* next_blocker)
418 : options_(options), input_objects_(input_objects), symtab_(symtab),
419 layout_(layout), dirpath_(dirpath), mapfile_(mapfile),
420 this_blocker_(this_blocker), next_blocker_(next_blocker)
425 // The standard Task methods.
438 { return "Plugin_hook"; }
441 // Call the plugin hook.
443 do_plugin_hook(Workqueue*);
445 const General_options& options_;
446 Input_objects* input_objects_;
447 Symbol_table* symtab_;
451 Task_token* this_blocker_;
452 Task_token* next_blocker_;
455 } // End namespace gold.
457 #endif // !defined(GOLD_PLUGIN_H)