ld/plugin.c

   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 #include "sysdep.h"
  22 #include "libiberty.h"
  23 #include "bfd.h"
  24 #include "bfdlink.h"
  25 #include "bfdver.h"
  26 #include "ld.h"
  27 #include "ldmain.h"
  28 #include "ldmisc.h"
  29 #include "ldexp.h"
  30 #include "ldlang.h"
  31 #include "ldfile.h"
  32 #include "plugin.h"
  33 #include "plugin-api.h"
  34 #include "elf-bfd.h"
  35 #if !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)
  36 #include <Windows.h>
  37 #endif
  38
  39 /* The suffix to append to the name of the real (claimed) object file
  40    when generating a dummy BFD to hold the IR symbols sent from the
  41    plugin.  */
  42 #define IRONLY_SUFFIX           ".ironly\004"
  43
  44 /* This is sizeof an array of chars, not sizeof a const char *.  We
  45    also have to avoid inadvertently counting the trailing NUL.  */
  46 #define IRONLY_SUFFIX_LEN       (sizeof (IRONLY_SUFFIX) - 1)
  47
  48 /* Stores a single argument passed to a plugin.  */
  49 typedef struct plugin_arg
  50 {
  51   struct plugin_arg *next;
  52   const char *arg;
  53 } plugin_arg_t;
  54
  55 /* Holds all details of a single plugin.  */
  56 typedef struct plugin
  57 {
  58   /* Next on the list of plugins, or NULL at end of chain.  */
  59   struct plugin *next;
  60   /* The argument string given to --plugin.  */
  61   const char *name;
  62   /* The shared library handle returned by dlopen.  */
  63   void *dlhandle;
  64   /* The list of argument string given to --plugin-opt.  */
  65   plugin_arg_t *args;
  66   /* Number of args in the list, for convenience.  */
  67   size_t n_args;
  68   /* The plugin's event handlers.  */
  69   ld_plugin_claim_file_handler claim_file_handler;
  70   ld_plugin_all_symbols_read_handler all_symbols_read_handler;
  71   ld_plugin_cleanup_handler cleanup_handler;
  72   /* TRUE if the cleanup handlers have been called.  */
  73   bfd_boolean cleanup_done;
  74 } plugin_t;
  75
  76 /* The master list of all plugins.  */
  77 static plugin_t *plugins_list = NULL;
  78
  79 /* We keep a tail pointer for easy linking on the end.  */
  80 static plugin_t **plugins_tail_chain_ptr = &plugins_list;
  81
  82 /* The last plugin added to the list, for receiving args.  */
  83 static plugin_t *last_plugin = NULL;
  84
  85 /* The tail of the arg chain of the last plugin added to the list.  */
  86 static plugin_arg_t **last_plugin_args_tail_chain_ptr = NULL;
  87
  88 /* The plugin which is currently having a callback executed.  */
  89 static plugin_t *called_plugin = NULL;
  90
  91 /* Last plugin to cause an error, if any.  */
  92 static const char *error_plugin = NULL;
  93
  94 /* A hash table that records symbols referenced by non-IR files.  Used
  95    at get_symbols time to determine whether any prevailing defs from
  96    IR files are referenced only from other IR files, so tthat we can
  97    we can distinguish the LDPR_PREVAILING_DEF and LDPR_PREVAILING_DEF_IRONLY
  98    cases when establishing symbol resolutions.  */
  99 static struct bfd_hash_table *non_ironly_hash = NULL;
 100
 101 /* Set at all symbols read time, to avoid recursively offering the plugin
 102    its own newly-added input files and libs to claim.  */
 103 static bfd_boolean no_more_claiming = FALSE;
 104
 105 /* If the --allow-multiple-definition command-line option is active, we
 106    have to disable it so that BFD always calls our hook, and simulate the
 107    effect (when not resolving IR vs. real symbols) ourselves by ensuring
 108    TRUE is returned from the hook.  */
 109 static bfd_boolean plugin_cached_allow_multiple_defs = FALSE;
 110
 111 /* List of tags to set in the constant leading part of the tv array. */
 112 static const enum ld_plugin_tag tv_header_tags[] =
 113 {
 114   LDPT_MESSAGE,
 115   LDPT_API_VERSION,
 116   LDPT_GNU_LD_VERSION,
 117   LDPT_LINKER_OUTPUT,
 118   LDPT_OUTPUT_NAME,
 119   LDPT_REGISTER_CLAIM_FILE_HOOK,
 120   LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK,
 121   LDPT_REGISTER_CLEANUP_HOOK,
 122   LDPT_ADD_SYMBOLS,
 123   LDPT_GET_INPUT_FILE,
 124   LDPT_RELEASE_INPUT_FILE,
 125   LDPT_GET_SYMBOLS,
 126   LDPT_ADD_INPUT_FILE,
 127   LDPT_ADD_INPUT_LIBRARY,
 128   LDPT_SET_EXTRA_LIBRARY_PATH
 129 };
 130
 131 /* How many entries in the constant leading part of the tv array.  */
 132 static const size_t tv_header_size = ARRAY_SIZE (tv_header_tags);
 133
 134 #if !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)
 135
 136 #define RTLD_NOW 0      /* Dummy value.  */
 137
 138 static void *
 139 dlopen (const char *file, int mode ATTRIBUTE_UNUSED)
 140 {
 141   return LoadLibrary (file);
 142 }
 143
 144 static void *
 145 dlsym (void *handle, const char *name)
 146 {
 147   return GetProcAddress (handle, name);
 148 }
 149
 150 static int
 151 dlclose (void *handle)
 152 {
 153   FreeLibrary (handle);
 154   return 0;
 155 }
 156
 157 #endif /* !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)  */
 158
 159 /* Helper function for exiting with error status.  */
 160 static int
 161 set_plugin_error (const char *plugin)
 162 {
 163   error_plugin = plugin;
 164   return -1;
 165 }
 166
 167 /* Test if an error occurred.  */
 168 static bfd_boolean
 169 plugin_error_p (void)
 170 {
 171   return error_plugin != NULL;
 172 }
 173
 174 /* Return name of plugin which caused an error if any.  */
 175 const char *
 176 plugin_error_plugin (void)
 177 {
 178   return error_plugin ? error_plugin : _("<no plugin>");
 179 }
 180
 181 /* Handle -plugin arg: find and load plugin, or return error.  */
 182 int
 183 plugin_opt_plugin (const char *plugin)
 184 {
 185   plugin_t *newplug;
 186
 187   newplug = xmalloc (sizeof *newplug);
 188   memset (newplug, 0, sizeof *newplug);
 189   newplug->name = plugin;
 190   newplug->dlhandle = dlopen (plugin, RTLD_NOW);
 191   if (!newplug->dlhandle)
 192     return set_plugin_error (plugin);
 193
 194   /* Chain on end, so when we run list it is in command-line order.  */
 195   *plugins_tail_chain_ptr = newplug;
 196   plugins_tail_chain_ptr = &newplug->next;
 197
 198   /* Record it as current plugin for receiving args.  */
 199   last_plugin = newplug;
 200   last_plugin_args_tail_chain_ptr = &newplug->args;
 201   return 0;
 202 }
 203
 204 /* Accumulate option arguments for last-loaded plugin, or return
 205    error if none.  */
 206 int
 207 plugin_opt_plugin_arg (const char *arg)
 208 {
 209   plugin_arg_t *newarg;
 210
 211   if (!last_plugin)
 212     return set_plugin_error (_("<no plugin>"));
 213
 214   newarg = xmalloc (sizeof *newarg);
 215   newarg->arg = arg;
 216   newarg->next = NULL;
 217
 218   /* Chain on end to preserve command-line order.  */
 219   *last_plugin_args_tail_chain_ptr = newarg;
 220   last_plugin_args_tail_chain_ptr = &newarg->next;
 221   last_plugin->n_args++;
 222   return 0;
 223 }
 224
 225 /* Create a dummy BFD.  */
 226 bfd *
 227 plugin_get_ir_dummy_bfd (const char *name, bfd *srctemplate)
 228 {
 229   asection *sec;
 230   bfd *abfd;
 231
 232   bfd_use_reserved_id = 1;
 233   abfd = bfd_create (concat (name, IRONLY_SUFFIX, (const char *)NULL),
 234                      srctemplate);
 235   bfd_set_arch_info (abfd, bfd_get_arch_info (srctemplate));
 236   bfd_make_writable (abfd);
 237   /* Create a minimal set of sections to own the symbols.  */
 238   sec = bfd_make_section_old_way (abfd, ".text");
 239   bfd_set_section_flags (abfd, sec,
 240                          (SEC_CODE | SEC_HAS_CONTENTS | SEC_READONLY
 241                           | SEC_ALLOC | SEC_LOAD | SEC_KEEP));
 242   sec->output_section = sec;
 243   sec->output_offset = 0;
 244   return abfd;
 245 }
 246
 247 /* Check if the BFD passed in is an IR dummy object file.  */
 248 static bfd_boolean
 249 is_ir_dummy_bfd (const bfd *abfd)
 250 {
 251   size_t namlen;
 252
 253   if (abfd == NULL)
 254     return FALSE;
 255   namlen = strlen (abfd->filename);
 256   if (namlen < IRONLY_SUFFIX_LEN)
 257     return FALSE;
 258   return !strcmp (abfd->filename + namlen - IRONLY_SUFFIX_LEN, IRONLY_SUFFIX);
 259 }
 260
 261 /* Helpers to convert between BFD and GOLD symbol formats.  */
 262 static enum ld_plugin_status
 263 asymbol_from_plugin_symbol (bfd *abfd, asymbol *asym,
 264                                 const struct ld_plugin_symbol *ldsym)
 265 {
 266   flagword flags = BSF_NO_FLAGS;
 267   struct bfd_section *section;
 268
 269   asym->the_bfd = abfd;
 270   asym->name = ldsym->version
 271                 ? concat (ldsym->name, "@", ldsym->version, NULL)
 272                 : ldsym->name;
 273   asym->value = 0;
 274   switch (ldsym->def)
 275     {
 276     case LDPK_WEAKDEF:
 277       flags = BSF_WEAK;
 278       /* FALLTHRU */
 279     case LDPK_DEF:
 280       flags |= BSF_GLOBAL;
 281       section = bfd_get_section_by_name (abfd, ".text");
 282       break;
 283
 284     case LDPK_WEAKUNDEF:
 285       flags = BSF_WEAK;
 286       /* FALLTHRU */
 287     case LDPK_UNDEF:
 288       section = bfd_und_section_ptr;
 289       break;
 290
 291     case LDPK_COMMON:
 292       flags = BSF_GLOBAL;
 293       section = bfd_com_section_ptr;
 294       asym->value = ldsym->size;
 295       break;
 296
 297     default:
 298       return LDPS_ERR;
 299     }
 300   asym->flags = flags;
 301   asym->section = section;
 302
 303   /* Visibility only applies on ELF targets.  */
 304   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 305     {
 306       elf_symbol_type *elfsym = elf_symbol_from (abfd, asym);
 307       if (!elfsym)
 308         einfo (_("%P%F: %s: non-ELF symbol in ELF BFD!"), asym->name);
 309       elfsym->internal_elf_sym.st_other &= ~3;
 310       elfsym->internal_elf_sym.st_other |= ldsym->visibility;
 311     }
 312
 313   return LDPS_OK;
 314 }
 315
 316 /* Register a claim-file handler.  */
 317 static enum ld_plugin_status
 318 register_claim_file (ld_plugin_claim_file_handler handler)
 319 {
 320   ASSERT (called_plugin);
 321   called_plugin->claim_file_handler = handler;
 322   return LDPS_OK;
 323 }
 324
 325 /* Register an all-symbols-read handler.  */
 326 static enum ld_plugin_status
 327 register_all_symbols_read (ld_plugin_all_symbols_read_handler handler)
 328 {
 329   ASSERT (called_plugin);
 330   called_plugin->all_symbols_read_handler = handler;
 331   return LDPS_OK;
 332 }
 333
 334 /* Register a cleanup handler.  */
 335 static enum ld_plugin_status
 336 register_cleanup (ld_plugin_cleanup_handler handler)
 337 {
 338   ASSERT (called_plugin);
 339   called_plugin->cleanup_handler = handler;
 340   return LDPS_OK;
 341 }
 342
 343 /* Add symbols from a plugin-claimed input file.  */
 344 static enum ld_plugin_status
 345 add_symbols (void *handle, int nsyms, const struct ld_plugin_symbol *syms)
 346 {
 347   asymbol **symptrs;
 348   bfd *abfd = handle;
 349   int n;
 350   ASSERT (called_plugin);
 351   symptrs = xmalloc (nsyms * sizeof *symptrs);
 352   for (n = 0; n < nsyms; n++)
 353     {
 354       enum ld_plugin_status rv;
 355       asymbol *bfdsym = bfd_make_empty_symbol (abfd);
 356       symptrs[n] = bfdsym;
 357       rv = asymbol_from_plugin_symbol (abfd, bfdsym, syms + n);
 358       if (rv != LDPS_OK)
 359         return rv;
 360     }
 361   bfd_set_symtab (abfd, symptrs, nsyms);
 362   return LDPS_OK;
 363 }
 364
 365 /* Get the input file information with an open (possibly re-opened)
 366    file descriptor.  */
 367 static enum ld_plugin_status
 368 get_input_file (const void *handle, struct ld_plugin_input_file *file)
 369 {
 370   ASSERT (called_plugin);
 371   handle = handle;
 372   file = file;
 373   return LDPS_ERR;
 374 }
 375
 376 /* Release the input file.  */
 377 static enum ld_plugin_status
 378 release_input_file (const void *handle)
 379 {
 380   ASSERT (called_plugin);
 381   handle = handle;
 382   return LDPS_ERR;
 383 }
 384
 385 /* Return TRUE if a defined symbol might be reachable from outside the
 386    universe of claimed objects.  */
 387 static inline bfd_boolean
 388 is_visible_from_outside (struct ld_plugin_symbol *lsym, asection *section,
 389                         struct bfd_link_hash_entry *blhe)
 390 {
 391   /* Section's owner may be NULL if it is the absolute
 392      section, fortunately is_ir_dummy_bfd handles that.  */
 393   if (!is_ir_dummy_bfd (section->owner))
 394     return TRUE;
 395   if (link_info.relocatable)
 396     return TRUE;
 397   if (link_info.export_dynamic || link_info.shared)
 398     {
 399       /* Only ELF symbols really have visibility.  */
 400       if (bfd_get_flavour (link_info.output_bfd) == bfd_target_elf_flavour)
 401         {
 402           struct elf_link_hash_entry *el = (struct elf_link_hash_entry *)blhe;
 403           int vis = ELF_ST_VISIBILITY (el->other);
 404           return vis == STV_DEFAULT || vis == STV_PROTECTED;
 405         }
 406       /* On non-ELF targets, we can safely make inferences by considering
 407          what visibility the plugin would have liked to apply when it first
 408          sent us the symbol.  During ELF symbol processing, visibility only
 409          ever becomes more restrictive, not less, when symbols are merged,
 410          so this is a conservative estimate; it may give false positives,
 411          declaring something visible from outside when it in fact would
 412          not have been, but this will only lead to missed optimisation
 413          opportunities during LTRANS at worst; it will not give false
 414          negatives, which can lead to the disastrous conclusion that the
 415          related symbol is IRONLY.  (See GCC PR46319 for an example.)  */
 416       return lsym->visibility == LDPV_DEFAULT
 417           || lsym->visibility == LDPV_PROTECTED;
 418     }
 419   return FALSE;
 420 }
 421
 422 /* Get the symbol resolution info for a plugin-claimed input file.  */
 423 static enum ld_plugin_status
 424 get_symbols (const void *handle, int nsyms, struct ld_plugin_symbol *syms)
 425 {
 426   const bfd *abfd = handle;
 427   int n;
 428   ASSERT (called_plugin);
 429   for (n = 0; n < nsyms; n++)
 430     {
 431       struct bfd_link_hash_entry *blhe;
 432       bfd_boolean ironly;
 433       asection *owner_sec;
 434
 435       blhe = bfd_link_hash_lookup (link_info.hash, syms[n].name,
 436                                 FALSE, FALSE, TRUE);
 437       if (!blhe)
 438         {
 439           syms[n].resolution = LDPR_UNKNOWN;
 440           continue;
 441         }
 442
 443       /* Determine resolution from blhe type and symbol's original type.  */
 444       if (blhe->type == bfd_link_hash_undefined
 445                 || blhe->type == bfd_link_hash_undefweak)
 446         {
 447           syms[n].resolution = LDPR_UNDEF;
 448           continue;
 449         }
 450       if (blhe->type != bfd_link_hash_defined
 451                 && blhe->type != bfd_link_hash_defweak
 452                 && blhe->type != bfd_link_hash_common)
 453         {
 454           /* We should not have a new, indirect or warning symbol here.  */
 455           einfo ("%P%F: %s: plugin symbol table corrupt (sym type %d)",
 456                 called_plugin->name, blhe->type);
 457         }
 458
 459       /* Find out which section owns the symbol.  Since it's not undef,
 460          it must have an owner; if it's not a common symbol, both defs
 461          and weakdefs keep it in the same place. */
 462       owner_sec = (blhe->type == bfd_link_hash_common)
 463                 ? blhe->u.c.p->section
 464                 : blhe->u.def.section;
 465
 466       /* We need to know if the sym is referenced from non-IR files.  Or
 467          even potentially-referenced, perhaps in a future final link if
 468          this is a partial one, perhaps dynamically at load-time if the
 469          symbol is externally visible.  */
 470       ironly = !is_visible_from_outside (&syms[n], owner_sec, blhe)
 471         && !bfd_hash_lookup (non_ironly_hash, syms[n].name, FALSE, FALSE);
 472
 473       /* If it was originally undefined or common, then it has been
 474          resolved; determine how.  */
 475       if (syms[n].def == LDPK_UNDEF || syms[n].def == LDPK_WEAKUNDEF
 476           || syms[n].def == LDPK_COMMON)
 477         {
 478           if (owner_sec->owner == link_info.output_bfd)
 479             syms[n].resolution = LDPR_RESOLVED_EXEC;
 480           else if (owner_sec->owner == abfd)
 481             syms[n].resolution = (ironly)
 482                                 ? LDPR_PREVAILING_DEF_IRONLY
 483                                 : LDPR_PREVAILING_DEF;
 484           else if (is_ir_dummy_bfd (owner_sec->owner))
 485             syms[n].resolution = LDPR_RESOLVED_IR;
 486           else if (owner_sec->owner->flags & DYNAMIC)
 487             syms[n].resolution =  LDPR_RESOLVED_DYN;
 488           else
 489             syms[n].resolution = LDPR_RESOLVED_EXEC;
 490           continue;
 491         }
 492
 493       /* Was originally def, or weakdef.  Does it prevail?  If the
 494          owner is the original dummy bfd that supplied it, then this
 495          is the definition that has prevailed.  */
 496       if (owner_sec->owner == link_info.output_bfd)
 497         syms[n].resolution = LDPR_PREEMPTED_REG;
 498       else if (owner_sec->owner == abfd)
 499         {
 500           syms[n].resolution = (ironly)
 501                                 ? LDPR_PREVAILING_DEF_IRONLY
 502                                 : LDPR_PREVAILING_DEF;
 503           continue;
 504         }
 505
 506       /* Was originally def, weakdef, or common, but has been pre-empted.  */
 507       syms[n].resolution = is_ir_dummy_bfd (owner_sec->owner)
 508                                 ? LDPR_PREEMPTED_IR
 509                                 : LDPR_PREEMPTED_REG;
 510     }
 511   return LDPS_OK;
 512 }
 513
 514 /* Add a new (real) input file generated by a plugin.  */
 515 static enum ld_plugin_status
 516 add_input_file (const char *pathname)
 517 {
 518   ASSERT (called_plugin);
 519   if (!lang_add_input_file (xstrdup (pathname), lang_input_file_is_file_enum,
 520         NULL))
 521     return LDPS_ERR;
 522   return LDPS_OK;
 523 }
 524
 525 /* Add a new (real) library required by a plugin.  */
 526 static enum ld_plugin_status
 527 add_input_library (const char *pathname)
 528 {
 529   ASSERT (called_plugin);
 530   if (!lang_add_input_file (xstrdup (pathname), lang_input_file_is_l_enum,
 531         NULL))
 532     return LDPS_ERR;
 533   return LDPS_OK;
 534 }
 535
 536 /* Set the extra library path to be used by libraries added via
 537    add_input_library.  */
 538 static enum ld_plugin_status
 539 set_extra_library_path (const char *path)
 540 {
 541   ASSERT (called_plugin);
 542   ldfile_add_library_path (xstrdup (path), FALSE);
 543   return LDPS_OK;
 544 }
 545
 546 /* Issue a diagnostic message from a plugin.  */
 547 static enum ld_plugin_status
 548 message (int level, const char *format, ...)
 549 {
 550   va_list args;
 551   va_start (args, format);
 552
 553   switch (level)
 554     {
 555     case LDPL_INFO:
 556       vfinfo (stdout, format, args, FALSE);
 557       break;
 558     case LDPL_WARNING:
 559       vfinfo (stdout, format, args, TRUE);
 560       break;
 561     case LDPL_FATAL:
 562     case LDPL_ERROR:
 563     default:
 564       {
 565         char *newfmt = ACONCAT ((level == LDPL_FATAL ? "%F" : "%X",
 566                                 format, NULL));
 567         vfinfo (stderr, newfmt, args, TRUE);
 568       }
 569       break;
 570     }
 571
 572   va_end (args);
 573   return LDPS_OK;
 574 }
 575
 576 /* Helper to size leading part of tv array and set it up. */
 577 static size_t
 578 set_tv_header (struct ld_plugin_tv *tv)
 579 {
 580   size_t i;
 581
 582   /* Version info.  */
 583   static const unsigned int major = (unsigned)(BFD_VERSION / 100000000UL);
 584   static const unsigned int minor = (unsigned)(BFD_VERSION / 1000000UL) % 100;
 585
 586   if (!tv)
 587     return tv_header_size;
 588
 589   for (i = 0; i < tv_header_size; i++)
 590     {
 591       tv[i].tv_tag = tv_header_tags[i];
 592 #define TVU(x) tv[i].tv_u.tv_ ## x
 593       switch (tv[i].tv_tag)
 594         {
 595           case LDPT_MESSAGE:
 596             TVU(message) = message;
 597             break;
 598           case LDPT_API_VERSION:
 599             TVU(val) = LD_PLUGIN_API_VERSION;
 600             break;
 601           case LDPT_GNU_LD_VERSION:
 602             TVU(val) = major * 100 + minor;
 603             break;
 604           case LDPT_LINKER_OUTPUT:
 605             TVU(val) = link_info.relocatable ? LDPO_REL
 606                         : (link_info.shared ? LDPO_DYN : LDPO_EXEC);
 607             break;
 608           case LDPT_OUTPUT_NAME:
 609             TVU(string) = output_filename;
 610             break;
 611           case LDPT_REGISTER_CLAIM_FILE_HOOK:
 612             TVU(register_claim_file) = register_claim_file;
 613             break;
 614           case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK:
 615             TVU(register_all_symbols_read) = register_all_symbols_read;
 616             break;
 617           case LDPT_REGISTER_CLEANUP_HOOK:
 618             TVU(register_cleanup) = register_cleanup;
 619             break;
 620           case LDPT_ADD_SYMBOLS:
 621             TVU(add_symbols) = add_symbols;
 622             break;
 623           case LDPT_GET_INPUT_FILE:
 624             TVU(get_input_file) = get_input_file;
 625             break;
 626           case LDPT_RELEASE_INPUT_FILE:
 627             TVU(release_input_file) = release_input_file;
 628             break;
 629           case LDPT_GET_SYMBOLS:
 630             TVU(get_symbols) = get_symbols;
 631             break;
 632           case LDPT_ADD_INPUT_FILE:
 633             TVU(add_input_file) = add_input_file;
 634             break;
 635           case LDPT_ADD_INPUT_LIBRARY:
 636             TVU(add_input_library) = add_input_library;
 637             break;
 638           case LDPT_SET_EXTRA_LIBRARY_PATH:
 639             TVU(set_extra_library_path) = set_extra_library_path;
 640             break;
 641           default:
 642             /* Added a new entry to the array without adding
 643                a new case to set up its value is a bug.  */
 644             FAIL ();
 645         }
 646 #undef TVU
 647     }
 648   return tv_header_size;
 649 }
 650
 651 /* Append the per-plugin args list and trailing LDPT_NULL to tv.  */
 652 static void
 653 set_tv_plugin_args (plugin_t *plugin, struct ld_plugin_tv *tv)
 654 {
 655   plugin_arg_t *arg = plugin->args;
 656   while (arg)
 657     {
 658       tv->tv_tag = LDPT_OPTION;
 659       tv->tv_u.tv_string = arg->arg;
 660       arg = arg->next;
 661       tv++;
 662     }
 663   tv->tv_tag = LDPT_NULL;
 664   tv->tv_u.tv_val = 0;
 665 }
 666
 667 /* Return true if any plugins are active this run.  Only valid
 668    after options have been processed.  */
 669 bfd_boolean
 670 plugin_active_plugins_p (void)
 671 {
 672   return plugins_list != NULL;
 673 }
 674
 675 /* Load up and initialise all plugins after argument parsing.  */
 676 int
 677 plugin_load_plugins (void)
 678 {
 679   struct ld_plugin_tv *my_tv;
 680   unsigned int max_args = 0;
 681   plugin_t *curplug = plugins_list;
 682
 683   /* If there are no plugins, we need do nothing this run.  */
 684   if (!curplug)
 685     return 0;
 686
 687   /* First pass over plugins to find max # args needed so that we
 688      can size and allocate the tv array.  */
 689   while (curplug)
 690     {
 691       if (curplug->n_args > max_args)
 692         max_args = curplug->n_args;
 693       curplug = curplug->next;
 694     }
 695
 696   /* Allocate tv array and initialise constant part.  */
 697   my_tv = xmalloc ((max_args + 1 + tv_header_size) * sizeof *my_tv);
 698   set_tv_header (my_tv);
 699
 700   /* Pass over plugins again, activating them.  */
 701   curplug = plugins_list;
 702   while (curplug)
 703     {
 704       enum ld_plugin_status rv;
 705       ld_plugin_onload onloadfn = dlsym (curplug->dlhandle, "onload");
 706       if (!onloadfn)
 707         onloadfn = dlsym (curplug->dlhandle, "_onload");
 708       if (!onloadfn)
 709         return set_plugin_error (curplug->name);
 710       set_tv_plugin_args (curplug, &my_tv[tv_header_size]);
 711       called_plugin = curplug;
 712       rv = (*onloadfn) (my_tv);
 713       called_plugin = NULL;
 714       if (rv != LDPS_OK)
 715         return set_plugin_error (curplug->name);
 716       curplug = curplug->next;
 717     }
 718
 719   /* Since plugin(s) inited ok, assume they're going to want symbol
 720      resolutions, which needs us to track which symbols are referenced
 721      by non-IR files using the linker's notice callback.  */
 722   link_info.notice_all = TRUE;
 723
 724   return 0;
 725 }
 726
 727 /* Call 'claim file' hook for all plugins.  */
 728 int
 729 plugin_call_claim_file (const struct ld_plugin_input_file *file, int *claimed)
 730 {
 731   plugin_t *curplug = plugins_list;
 732   *claimed = FALSE;
 733   if (no_more_claiming)
 734     return 0;
 735   while (curplug && !*claimed)
 736     {
 737       if (curplug->claim_file_handler)
 738         {
 739           enum ld_plugin_status rv;
 740           called_plugin = curplug;
 741           rv = (*curplug->claim_file_handler) (file, claimed);
 742           called_plugin = NULL;
 743           if (rv != LDPS_OK)
 744             set_plugin_error (curplug->name);
 745         }
 746       curplug = curplug->next;
 747     }
 748   return plugin_error_p () ? -1 : 0;
 749 }
 750
 751 /* Call 'all symbols read' hook for all plugins.  */
 752 int
 753 plugin_call_all_symbols_read (void)
 754 {
 755   plugin_t *curplug = plugins_list;
 756
 757   /* Disable any further file-claiming.  */
 758   no_more_claiming = TRUE;
 759
 760   /* If --allow-multiple-definition is in effect, we need to disable it,
 761      as the plugin infrastructure relies on the multiple_definition
 762      callback to swap out the dummy IR-only BFDs for new real ones
 763      when it starts opening the files added during this callback.  */
 764   plugin_cached_allow_multiple_defs = link_info.allow_multiple_definition;
 765   link_info.allow_multiple_definition = FALSE;
 766
 767   while (curplug)
 768     {
 769       if (curplug->all_symbols_read_handler)
 770         {
 771           enum ld_plugin_status rv;
 772           called_plugin = curplug;
 773           rv = (*curplug->all_symbols_read_handler) ();
 774           called_plugin = NULL;
 775           if (rv != LDPS_OK)
 776             set_plugin_error (curplug->name);
 777         }
 778       curplug = curplug->next;
 779     }
 780   return plugin_error_p () ? -1 : 0;
 781 }
 782
 783 /* Call 'cleanup' hook for all plugins.  */
 784 int
 785 plugin_call_cleanup (void)
 786 {
 787   plugin_t *curplug = plugins_list;
 788   while (curplug)
 789     {
 790       if (curplug->cleanup_handler && !curplug->cleanup_done)
 791         {
 792           enum ld_plugin_status rv;
 793           curplug->cleanup_done = TRUE;
 794           called_plugin = curplug;
 795           rv = (*curplug->cleanup_handler) ();
 796           called_plugin = NULL;
 797           if (rv != LDPS_OK)
 798             set_plugin_error (curplug->name);
 799           dlclose (curplug->dlhandle);
 800         }
 801       curplug = curplug->next;
 802     }
 803   return plugin_error_p () ? -1 : 0;
 804 }
 805
 806 /* Lazily init the non_ironly hash table.  */
 807 static void
 808 init_non_ironly_hash (void)
 809 {
 810   if (non_ironly_hash == NULL)
 811     {
 812       non_ironly_hash =
 813           (struct bfd_hash_table *) xmalloc (sizeof (struct bfd_hash_table));
 814       if (!bfd_hash_table_init_n (non_ironly_hash,
 815                                   bfd_hash_newfunc,
 816                                   sizeof (struct bfd_hash_entry),
 817                                   61))
 818         einfo (_("%P%F: bfd_hash_table_init failed: %E\n"));
 819     }
 820 }
 821
 822 /* To determine which symbols should be resolved LDPR_PREVAILING_DEF
 823    and which LDPR_PREVAILING_DEF_IRONLY, we notice all the symbols as
 824    the linker adds them to the linker hash table.  If we see a symbol
 825    being referenced from a non-IR file, we add it to the non_ironly hash
 826    table.  If we can't find it there at get_symbols time, we know that
 827    it was referenced only by IR files.  We have to notice_all symbols,
 828    because we won't necessarily know until later which ones will be
 829    contributed by IR files.  */
 830 bfd_boolean
 831 plugin_notice (struct bfd_link_info *info ATTRIBUTE_UNUSED,
 832                 const char *name, bfd *abfd,
 833                 asection *section, bfd_vma value ATTRIBUTE_UNUSED)
 834 {
 835   bfd_boolean is_ref = bfd_is_und_section (section);
 836   bfd_boolean is_dummy = is_ir_dummy_bfd (abfd);
 837   init_non_ironly_hash ();
 838   /* We only care about refs, not defs, indicated by section pointing
 839      to the undefined section (according to the bfd linker notice callback
 840      interface definition).  */
 841   if (is_ref && !is_dummy)
 842     {
 843       /* This is a ref from a non-IR file, so note the ref'd symbol
 844          in the non-IR-only hash.  */
 845       if (!bfd_hash_lookup (non_ironly_hash, name, TRUE, TRUE))
 846         einfo (_("%P%X: %s: hash table failure adding symbol %s"),
 847                 abfd->filename, name);
 848     }
 849   else if (!is_ref && is_dummy)
 850     {
 851       /* No further processing since this is a def from an IR dummy BFD.  */
 852       return FALSE;
 853     }
 854
 855   /* Continue with cref/nocrossref/trace-sym processing.  */
 856   return TRUE;
 857 }
 858
 859 /* When we add new object files to the link at all symbols read time,
 860    these contain the real code and symbols generated from the IR files,
 861    and so duplicate all the definitions already supplied by the dummy
 862    IR-only BFDs that we created at claim files time.  We use the linker's
 863    multiple-definitions callback hook to fix up the clash, discarding
 864    the symbol from the IR-only BFD in favour of the symbol from the
 865    real BFD.  We return true if this was not-really-a-clash because
 866    we've fixed it up, or anyway if --allow-multiple-definition was in
 867    effect (before we disabled it to ensure we got called back).  */
 868 bfd_boolean
 869 plugin_multiple_definition (struct bfd_link_info *info, const char *name,
 870                 bfd *obfd, asection *osec ATTRIBUTE_UNUSED,
 871                 bfd_vma oval ATTRIBUTE_UNUSED,
 872                 bfd *nbfd, asection *nsec, bfd_vma nval)
 873 {
 874   if (is_ir_dummy_bfd (obfd))
 875     {
 876       struct bfd_link_hash_entry *blhe = bfd_link_hash_lookup (info->hash,
 877                                         name, FALSE, FALSE, FALSE);
 878       if (!blhe)
 879         einfo (_("%P%X: %s: can't find IR symbol '%s'"), nbfd->filename,
 880                 name);
 881       else if (blhe->type != bfd_link_hash_defined)
 882         einfo (_("%P%x: %s: bad IR symbol type %d"), name, blhe->type);
 883       /* Replace it with new details.  */
 884       blhe->u.def.section = nsec;
 885       blhe->u.def.value = nval;
 886       return TRUE;
 887     }
 888   return plugin_cached_allow_multiple_defs;
 889 }