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