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       /* For ELF targets, set alignment of common symbol to 1.  */
 296       if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 297         ((elf_symbol_type *) asym)->internal_elf_sym.st_value = 1;
 298       break;
 299
 300     default:
 301       return LDPS_ERR;
 302     }
 303   asym->flags = flags;
 304   asym->section = section;
 305
 306   /* Visibility only applies on ELF targets.  */
 307   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 308     {
 309       elf_symbol_type *elfsym = elf_symbol_from (abfd, asym);
 310       if (!elfsym)
 311         einfo (_("%P%F: %s: non-ELF symbol in ELF BFD!"), asym->name);
 312       elfsym->internal_elf_sym.st_other &= ~3;
 313       elfsym->internal_elf_sym.st_other |= ldsym->visibility;
 314     }
 315
 316   return LDPS_OK;
 317 }
 318
 319 /* Register a claim-file handler.  */
 320 static enum ld_plugin_status
 321 register_claim_file (ld_plugin_claim_file_handler handler)
 322 {
 323   ASSERT (called_plugin);
 324   called_plugin->claim_file_handler = handler;
 325   return LDPS_OK;
 326 }
 327
 328 /* Register an all-symbols-read handler.  */
 329 static enum ld_plugin_status
 330 register_all_symbols_read (ld_plugin_all_symbols_read_handler handler)
 331 {
 332   ASSERT (called_plugin);
 333   called_plugin->all_symbols_read_handler = handler;
 334   return LDPS_OK;
 335 }
 336
 337 /* Register a cleanup handler.  */
 338 static enum ld_plugin_status
 339 register_cleanup (ld_plugin_cleanup_handler handler)
 340 {
 341   ASSERT (called_plugin);
 342   called_plugin->cleanup_handler = handler;
 343   return LDPS_OK;
 344 }
 345
 346 /* Add symbols from a plugin-claimed input file.  */
 347 static enum ld_plugin_status
 348 add_symbols (void *handle, int nsyms, const struct ld_plugin_symbol *syms)
 349 {
 350   asymbol **symptrs;
 351   bfd *abfd = handle;
 352   int n;
 353   ASSERT (called_plugin);
 354   symptrs = xmalloc (nsyms * sizeof *symptrs);
 355   for (n = 0; n < nsyms; n++)
 356     {
 357       enum ld_plugin_status rv;
 358       asymbol *bfdsym = bfd_make_empty_symbol (abfd);
 359       symptrs[n] = bfdsym;
 360       rv = asymbol_from_plugin_symbol (abfd, bfdsym, syms + n);
 361       if (rv != LDPS_OK)
 362         return rv;
 363     }
 364   bfd_set_symtab (abfd, symptrs, nsyms);
 365   return LDPS_OK;
 366 }
 367
 368 /* Get the input file information with an open (possibly re-opened)
 369    file descriptor.  */
 370 static enum ld_plugin_status
 371 get_input_file (const void *handle, struct ld_plugin_input_file *file)
 372 {
 373   ASSERT (called_plugin);
 374   handle = handle;
 375   file = file;
 376   return LDPS_ERR;
 377 }
 378
 379 /* Release the input file.  */
 380 static enum ld_plugin_status
 381 release_input_file (const void *handle)
 382 {
 383   ASSERT (called_plugin);
 384   handle = handle;
 385   return LDPS_ERR;
 386 }
 387
 388 /* Return TRUE if a defined symbol might be reachable from outside the
 389    universe of claimed objects.  */
 390 static inline bfd_boolean
 391 is_visible_from_outside (struct ld_plugin_symbol *lsym, asection *section,
 392                         struct bfd_link_hash_entry *blhe)
 393 {
 394   /* Section's owner may be NULL if it is the absolute
 395      section, fortunately is_ir_dummy_bfd handles that.  */
 396   if (!is_ir_dummy_bfd (section->owner))
 397     return TRUE;
 398   if (link_info.relocatable)
 399     return TRUE;
 400   if (link_info.export_dynamic || link_info.shared)
 401     {
 402       /* Only ELF symbols really have visibility.  */
 403       if (bfd_get_flavour (link_info.output_bfd) == bfd_target_elf_flavour)
 404         {
 405           struct elf_link_hash_entry *el = (struct elf_link_hash_entry *)blhe;
 406           int vis = ELF_ST_VISIBILITY (el->other);
 407           return vis == STV_DEFAULT || vis == STV_PROTECTED;
 408         }
 409       /* On non-ELF targets, we can safely make inferences by considering
 410          what visibility the plugin would have liked to apply when it first
 411          sent us the symbol.  During ELF symbol processing, visibility only
 412          ever becomes more restrictive, not less, when symbols are merged,
 413          so this is a conservative estimate; it may give false positives,
 414          declaring something visible from outside when it in fact would
 415          not have been, but this will only lead to missed optimisation
 416          opportunities during LTRANS at worst; it will not give false
 417          negatives, which can lead to the disastrous conclusion that the
 418          related symbol is IRONLY.  (See GCC PR46319 for an example.)  */
 419       return lsym->visibility == LDPV_DEFAULT
 420           || lsym->visibility == LDPV_PROTECTED;
 421     }
 422   return FALSE;
 423 }
 424
 425 /* Get the symbol resolution info for a plugin-claimed input file.  */
 426 static enum ld_plugin_status
 427 get_symbols (const void *handle, int nsyms, struct ld_plugin_symbol *syms)
 428 {
 429   const bfd *abfd = handle;
 430   int n;
 431   ASSERT (called_plugin);
 432   for (n = 0; n < nsyms; n++)
 433     {
 434       struct bfd_link_hash_entry *blhe;
 435       bfd_boolean ironly;
 436       asection *owner_sec;
 437
 438       blhe = bfd_link_hash_lookup (link_info.hash, syms[n].name,
 439                                 FALSE, FALSE, TRUE);
 440       if (!blhe)
 441         {
 442           syms[n].resolution = LDPR_UNKNOWN;
 443           continue;
 444         }
 445
 446       /* Determine resolution from blhe type and symbol's original type.  */
 447       if (blhe->type == bfd_link_hash_undefined
 448                 || blhe->type == bfd_link_hash_undefweak)
 449         {
 450           syms[n].resolution = LDPR_UNDEF;
 451           continue;
 452         }
 453       if (blhe->type != bfd_link_hash_defined
 454                 && blhe->type != bfd_link_hash_defweak
 455                 && blhe->type != bfd_link_hash_common)
 456         {
 457           /* We should not have a new, indirect or warning symbol here.  */
 458           einfo ("%P%F: %s: plugin symbol table corrupt (sym type %d)",
 459                 called_plugin->name, blhe->type);
 460         }
 461
 462       /* Find out which section owns the symbol.  Since it's not undef,
 463          it must have an owner; if it's not a common symbol, both defs
 464          and weakdefs keep it in the same place. */
 465       owner_sec = (blhe->type == bfd_link_hash_common)
 466                 ? blhe->u.c.p->section
 467                 : blhe->u.def.section;
 468
 469       /* We need to know if the sym is referenced from non-IR files.  Or
 470          even potentially-referenced, perhaps in a future final link if
 471          this is a partial one, perhaps dynamically at load-time if the
 472          symbol is externally visible.  */
 473       ironly = !is_visible_from_outside (&syms[n], owner_sec, blhe)
 474         && !bfd_hash_lookup (non_ironly_hash, syms[n].name, FALSE, FALSE);
 475
 476       /* If it was originally undefined or common, then it has been
 477          resolved; determine how.  */
 478       if (syms[n].def == LDPK_UNDEF || syms[n].def == LDPK_WEAKUNDEF
 479           || syms[n].def == LDPK_COMMON)
 480         {
 481           if (owner_sec->owner == link_info.output_bfd)
 482             syms[n].resolution = LDPR_RESOLVED_EXEC;
 483           else if (owner_sec->owner == abfd)
 484             syms[n].resolution = (ironly)
 485                                 ? LDPR_PREVAILING_DEF_IRONLY
 486                                 : LDPR_PREVAILING_DEF;
 487           else if (is_ir_dummy_bfd (owner_sec->owner))
 488             syms[n].resolution = LDPR_RESOLVED_IR;
 489           else if (owner_sec->owner->flags & DYNAMIC)
 490             syms[n].resolution =  LDPR_RESOLVED_DYN;
 491           else
 492             syms[n].resolution = LDPR_RESOLVED_EXEC;
 493           continue;
 494         }
 495
 496       /* Was originally def, or weakdef.  Does it prevail?  If the
 497          owner is the original dummy bfd that supplied it, then this
 498          is the definition that has prevailed.  */
 499       if (owner_sec->owner == link_info.output_bfd)
 500         syms[n].resolution = LDPR_PREEMPTED_REG;
 501       else if (owner_sec->owner == abfd)
 502         {
 503           syms[n].resolution = (ironly)
 504                                 ? LDPR_PREVAILING_DEF_IRONLY
 505                                 : LDPR_PREVAILING_DEF;
 506           continue;
 507         }
 508
 509       /* Was originally def, weakdef, or common, but has been pre-empted.  */
 510       syms[n].resolution = is_ir_dummy_bfd (owner_sec->owner)
 511                                 ? LDPR_PREEMPTED_IR
 512                                 : LDPR_PREEMPTED_REG;
 513     }
 514   return LDPS_OK;
 515 }
 516
 517 /* Add a new (real) input file generated by a plugin.  */
 518 static enum ld_plugin_status
 519 add_input_file (const char *pathname)
 520 {
 521   ASSERT (called_plugin);
 522   if (!lang_add_input_file (xstrdup (pathname), lang_input_file_is_file_enum,
 523         NULL))
 524     return LDPS_ERR;
 525   return LDPS_OK;
 526 }
 527
 528 /* Add a new (real) library required by a plugin.  */
 529 static enum ld_plugin_status
 530 add_input_library (const char *pathname)
 531 {
 532   ASSERT (called_plugin);
 533   if (!lang_add_input_file (xstrdup (pathname), lang_input_file_is_l_enum,
 534         NULL))
 535     return LDPS_ERR;
 536   return LDPS_OK;
 537 }
 538
 539 /* Set the extra library path to be used by libraries added via
 540    add_input_library.  */
 541 static enum ld_plugin_status
 542 set_extra_library_path (const char *path)
 543 {
 544   ASSERT (called_plugin);
 545   ldfile_add_library_path (xstrdup (path), FALSE);
 546   return LDPS_OK;
 547 }
 548
 549 /* Issue a diagnostic message from a plugin.  */
 550 static enum ld_plugin_status
 551 message (int level, const char *format, ...)
 552 {
 553   va_list args;
 554   va_start (args, format);
 555
 556   switch (level)
 557     {
 558     case LDPL_INFO:
 559       vfinfo (stdout, format, args, FALSE);
 560       break;
 561     case LDPL_WARNING:
 562       vfinfo (stdout, format, args, TRUE);
 563       break;
 564     case LDPL_FATAL:
 565     case LDPL_ERROR:
 566     default:
 567       {
 568         char *newfmt = ACONCAT ((level == LDPL_FATAL ? "%F" : "%X",
 569                                 format, NULL));
 570         vfinfo (stderr, newfmt, args, TRUE);
 571       }
 572       break;
 573     }
 574
 575   va_end (args);
 576   return LDPS_OK;
 577 }
 578
 579 /* Helper to size leading part of tv array and set it up. */
 580 static size_t
 581 set_tv_header (struct ld_plugin_tv *tv)
 582 {
 583   size_t i;
 584
 585   /* Version info.  */
 586   static const unsigned int major = (unsigned)(BFD_VERSION / 100000000UL);
 587   static const unsigned int minor = (unsigned)(BFD_VERSION / 1000000UL) % 100;
 588
 589   if (!tv)
 590     return tv_header_size;
 591
 592   for (i = 0; i < tv_header_size; i++)
 593     {
 594       tv[i].tv_tag = tv_header_tags[i];
 595 #define TVU(x) tv[i].tv_u.tv_ ## x
 596       switch (tv[i].tv_tag)
 597         {
 598           case LDPT_MESSAGE:
 599             TVU(message) = message;
 600             break;
 601           case LDPT_API_VERSION:
 602             TVU(val) = LD_PLUGIN_API_VERSION;
 603             break;
 604           case LDPT_GNU_LD_VERSION:
 605             TVU(val) = major * 100 + minor;
 606             break;
 607           case LDPT_LINKER_OUTPUT:
 608             TVU(val) = link_info.relocatable ? LDPO_REL
 609                         : (link_info.shared ? LDPO_DYN : LDPO_EXEC);
 610             break;
 611           case LDPT_OUTPUT_NAME:
 612             TVU(string) = output_filename;
 613             break;
 614           case LDPT_REGISTER_CLAIM_FILE_HOOK:
 615             TVU(register_claim_file) = register_claim_file;
 616             break;
 617           case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK:
 618             TVU(register_all_symbols_read) = register_all_symbols_read;
 619             break;
 620           case LDPT_REGISTER_CLEANUP_HOOK:
 621             TVU(register_cleanup) = register_cleanup;
 622             break;
 623           case LDPT_ADD_SYMBOLS:
 624             TVU(add_symbols) = add_symbols;
 625             break;
 626           case LDPT_GET_INPUT_FILE:
 627             TVU(get_input_file) = get_input_file;
 628             break;
 629           case LDPT_RELEASE_INPUT_FILE:
 630             TVU(release_input_file) = release_input_file;
 631             break;
 632           case LDPT_GET_SYMBOLS:
 633             TVU(get_symbols) = get_symbols;
 634             break;
 635           case LDPT_ADD_INPUT_FILE:
 636             TVU(add_input_file) = add_input_file;
 637             break;
 638           case LDPT_ADD_INPUT_LIBRARY:
 639             TVU(add_input_library) = add_input_library;
 640             break;
 641           case LDPT_SET_EXTRA_LIBRARY_PATH:
 642             TVU(set_extra_library_path) = set_extra_library_path;
 643             break;
 644           default:
 645             /* Added a new entry to the array without adding
 646                a new case to set up its value is a bug.  */
 647             FAIL ();
 648         }
 649 #undef TVU
 650     }
 651   return tv_header_size;
 652 }
 653
 654 /* Append the per-plugin args list and trailing LDPT_NULL to tv.  */
 655 static void
 656 set_tv_plugin_args (plugin_t *plugin, struct ld_plugin_tv *tv)
 657 {
 658   plugin_arg_t *arg = plugin->args;
 659   while (arg)
 660     {
 661       tv->tv_tag = LDPT_OPTION;
 662       tv->tv_u.tv_string = arg->arg;
 663       arg = arg->next;
 664       tv++;
 665     }
 666   tv->tv_tag = LDPT_NULL;
 667   tv->tv_u.tv_val = 0;
 668 }
 669
 670 /* Return true if any plugins are active this run.  Only valid
 671    after options have been processed.  */
 672 bfd_boolean
 673 plugin_active_plugins_p (void)
 674 {
 675   return plugins_list != NULL;
 676 }
 677
 678 /* Load up and initialise all plugins after argument parsing.  */
 679 int
 680 plugin_load_plugins (void)
 681 {
 682   struct ld_plugin_tv *my_tv;
 683   unsigned int max_args = 0;
 684   plugin_t *curplug = plugins_list;
 685
 686   /* If there are no plugins, we need do nothing this run.  */
 687   if (!curplug)
 688     return 0;
 689
 690   /* First pass over plugins to find max # args needed so that we
 691      can size and allocate the tv array.  */
 692   while (curplug)
 693     {
 694       if (curplug->n_args > max_args)
 695         max_args = curplug->n_args;
 696       curplug = curplug->next;
 697     }
 698
 699   /* Allocate tv array and initialise constant part.  */
 700   my_tv = xmalloc ((max_args + 1 + tv_header_size) * sizeof *my_tv);
 701   set_tv_header (my_tv);
 702
 703   /* Pass over plugins again, activating them.  */
 704   curplug = plugins_list;
 705   while (curplug)
 706     {
 707       enum ld_plugin_status rv;
 708       ld_plugin_onload onloadfn = dlsym (curplug->dlhandle, "onload");
 709       if (!onloadfn)
 710         onloadfn = dlsym (curplug->dlhandle, "_onload");
 711       if (!onloadfn)
 712         return set_plugin_error (curplug->name);
 713       set_tv_plugin_args (curplug, &my_tv[tv_header_size]);
 714       called_plugin = curplug;
 715       rv = (*onloadfn) (my_tv);
 716       called_plugin = NULL;
 717       if (rv != LDPS_OK)
 718         return set_plugin_error (curplug->name);
 719       curplug = curplug->next;
 720     }
 721
 722   /* Since plugin(s) inited ok, assume they're going to want symbol
 723      resolutions, which needs us to track which symbols are referenced
 724      by non-IR files using the linker's notice callback.  */
 725   link_info.notice_all = TRUE;
 726
 727   return 0;
 728 }
 729
 730 /* Call 'claim file' hook for all plugins.  */
 731 int
 732 plugin_call_claim_file (const struct ld_plugin_input_file *file, int *claimed)
 733 {
 734   plugin_t *curplug = plugins_list;
 735   *claimed = FALSE;
 736   if (no_more_claiming)
 737     return 0;
 738   while (curplug && !*claimed)
 739     {
 740       if (curplug->claim_file_handler)
 741         {
 742           enum ld_plugin_status rv;
 743           called_plugin = curplug;
 744           rv = (*curplug->claim_file_handler) (file, claimed);
 745           called_plugin = NULL;
 746           if (rv != LDPS_OK)
 747             set_plugin_error (curplug->name);
 748         }
 749       curplug = curplug->next;
 750     }
 751   return plugin_error_p () ? -1 : 0;
 752 }
 753
 754 /* Call 'all symbols read' hook for all plugins.  */
 755 int
 756 plugin_call_all_symbols_read (void)
 757 {
 758   plugin_t *curplug = plugins_list;
 759
 760   /* Disable any further file-claiming.  */
 761   no_more_claiming = TRUE;
 762
 763   /* If --allow-multiple-definition is in effect, we need to disable it,
 764      as the plugin infrastructure relies on the multiple_definition
 765      callback to swap out the dummy IR-only BFDs for new real ones
 766      when it starts opening the files added during this callback.  */
 767   plugin_cached_allow_multiple_defs = link_info.allow_multiple_definition;
 768   link_info.allow_multiple_definition = FALSE;
 769
 770   while (curplug)
 771     {
 772       if (curplug->all_symbols_read_handler)
 773         {
 774           enum ld_plugin_status rv;
 775           called_plugin = curplug;
 776           rv = (*curplug->all_symbols_read_handler) ();
 777           called_plugin = NULL;
 778           if (rv != LDPS_OK)
 779             set_plugin_error (curplug->name);
 780         }
 781       curplug = curplug->next;
 782     }
 783   return plugin_error_p () ? -1 : 0;
 784 }
 785
 786 /* Call 'cleanup' hook for all plugins.  */
 787 int
 788 plugin_call_cleanup (void)
 789 {
 790   plugin_t *curplug = plugins_list;
 791   while (curplug)
 792     {
 793       if (curplug->cleanup_handler && !curplug->cleanup_done)
 794         {
 795           enum ld_plugin_status rv;
 796           curplug->cleanup_done = TRUE;
 797           called_plugin = curplug;
 798           rv = (*curplug->cleanup_handler) ();
 799           called_plugin = NULL;
 800           if (rv != LDPS_OK)
 801             set_plugin_error (curplug->name);
 802           dlclose (curplug->dlhandle);
 803         }
 804       curplug = curplug->next;
 805     }
 806   return plugin_error_p () ? -1 : 0;
 807 }
 808
 809 /* Lazily init the non_ironly hash table.  */
 810 static void
 811 init_non_ironly_hash (void)
 812 {
 813   if (non_ironly_hash == NULL)
 814     {
 815       non_ironly_hash =
 816           (struct bfd_hash_table *) xmalloc (sizeof (struct bfd_hash_table));
 817       if (!bfd_hash_table_init_n (non_ironly_hash,
 818                                   bfd_hash_newfunc,
 819                                   sizeof (struct bfd_hash_entry),
 820                                   61))
 821         einfo (_("%P%F: bfd_hash_table_init failed: %E\n"));
 822     }
 823 }
 824
 825 /* To determine which symbols should be resolved LDPR_PREVAILING_DEF
 826    and which LDPR_PREVAILING_DEF_IRONLY, we notice all the symbols as
 827    the linker adds them to the linker hash table.  If we see a symbol
 828    being referenced from a non-IR file, we add it to the non_ironly hash
 829    table.  If we can't find it there at get_symbols time, we know that
 830    it was referenced only by IR files.  We have to notice_all symbols,
 831    because we won't necessarily know until later which ones will be
 832    contributed by IR files.  */
 833 bfd_boolean
 834 plugin_notice (struct bfd_link_info *info ATTRIBUTE_UNUSED,
 835                 const char *name, bfd *abfd,
 836                 asection *section, bfd_vma value ATTRIBUTE_UNUSED)
 837 {
 838   bfd_boolean is_ref = bfd_is_und_section (section);
 839   bfd_boolean is_dummy = is_ir_dummy_bfd (abfd);
 840   init_non_ironly_hash ();
 841   /* We only care about refs, not defs, indicated by section pointing
 842      to the undefined section (according to the bfd linker notice callback
 843      interface definition).  */
 844   if (is_ref && !is_dummy)
 845     {
 846       /* This is a ref from a non-IR file, so note the ref'd symbol
 847          in the non-IR-only hash.  */
 848       if (!bfd_hash_lookup (non_ironly_hash, name, TRUE, TRUE))
 849         einfo (_("%P%X: %s: hash table failure adding symbol %s"),
 850                 abfd->filename, name);
 851     }
 852   else if (!is_ref && is_dummy)
 853     {
 854       /* No further processing since this is a def from an IR dummy BFD.  */
 855       return FALSE;
 856     }
 857
 858   /* Continue with cref/nocrossref/trace-sym processing.  */
 859   return TRUE;
 860 }
 861
 862 /* When we add new object files to the link at all symbols read time,
 863    these contain the real code and symbols generated from the IR files,
 864    and so duplicate all the definitions already supplied by the dummy
 865    IR-only BFDs that we created at claim files time.  We use the linker's
 866    multiple-definitions callback hook to fix up the clash, discarding
 867    the symbol from the IR-only BFD in favour of the symbol from the
 868    real BFD.  We return true if this was not-really-a-clash because
 869    we've fixed it up, or anyway if --allow-multiple-definition was in
 870    effect (before we disabled it to ensure we got called back).  */
 871 bfd_boolean
 872 plugin_multiple_definition (struct bfd_link_info *info, const char *name,
 873                 bfd *obfd, asection *osec ATTRIBUTE_UNUSED,
 874                 bfd_vma oval ATTRIBUTE_UNUSED,
 875                 bfd *nbfd, asection *nsec, bfd_vma nval)
 876 {
 877   if (is_ir_dummy_bfd (obfd))
 878     {
 879       struct bfd_link_hash_entry *blhe = bfd_link_hash_lookup (info->hash,
 880                                         name, FALSE, FALSE, FALSE);
 881       if (!blhe)
 882         einfo (_("%P%X: %s: can't find IR symbol '%s'"), nbfd->filename,
 883                 name);
 884       else if (blhe->type != bfd_link_hash_defined)
 885         einfo (_("%P%x: %s: bad IR symbol type %d"), name, blhe->type);
 886       /* Replace it with new details.  */
 887       blhe->u.def.section = nsec;
 888       blhe->u.def.value = nval;
 889       return TRUE;
 890     }
 891   return plugin_cached_allow_multiple_defs;
 892 }