ld/plugin.h

   1 /* Plugin control for the GNU linker.
   2    Copyright 2010 Free Software Foundation, Inc.
   3
   4    This file is part of the GNU Binutils.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
  19    MA 02110-1301, USA.  */
  20
  21 #ifndef GLD_PLUGIN_H
  22 #define GLD_PLUGIN_H
  23
  24
  25 /* This is the only forward declaration we need to avoid having
  26    to include the plugin-api.h header in order to use this file.  */
  27 struct ld_plugin_input_file;
  28
  29 /* Handle -plugin arg: find and load plugin, or return error.  */
  30 extern int plugin_opt_plugin (const char *plugin);
  31
  32 /* Accumulate option arguments for last-loaded plugin, or return
  33    error if none.  */
  34 extern int plugin_opt_plugin_arg (const char *arg);
  35
  36 /* Load up and initialise all plugins after argument parsing.  */
  37 extern int plugin_load_plugins (void);
  38
  39 /* Return name of plugin which caused an error in any of the above.  */
  40 extern const char *plugin_error_plugin (void);
  41
  42 /* Call 'claim file' hook for all plugins.  */
  43 extern int plugin_call_claim_file (const struct ld_plugin_input_file *file,
  44                 int *claimed);
  45
  46 /* Call 'all symbols read' hook for all plugins.  */
  47 extern int plugin_call_all_symbols_read (void);
  48
  49 /* Call 'cleanup' hook for all plugins.  */
  50 extern int plugin_call_cleanup (void);
  51
  52 /* Generate a dummy BFD to represent an IR file, for any callers of
  53    plugin_call_claim_file to use as the handle in the ld_plugin_input_file
  54    struct that they build to pass in.  The BFD is initially writable, so
  55    that symbols can be added to it; it must be made readable after the
  56    add_symbols hook has been called so that it can be read when linking.  */
  57 extern bfd *plugin_get_ir_dummy_bfd (const char *name, bfd *template);
  58
  59 /* Check if the BFD passed in is an IR dummy object file.  */
  60 extern bfd_boolean is_ir_dummy_bfd (const bfd *abfd);
  61
  62 /* Notice-symbol bfd linker callback hook.  */
  63 extern bfd_boolean plugin_notice (struct bfd_link_info *info,
  64                 const char *name, bfd *abfd, asection *section,
  65                 bfd_vma value);
  66
  67 /* Multiple-definition bfd linker callback hook.  */
  68 extern bfd_boolean plugin_multiple_definition (struct bfd_link_info *info,
  69                 const char *name,
  70                 bfd *obfd, asection *osec, bfd_vma oval,
  71                 bfd *nbfd, asection *nsec, bfd_vma nval);
  72
  73 #endif /* !def GLD_PLUGIN_H */