ld/plugin.c

   1 /* Plugin control for the GNU linker.
   2    Copyright (C) 2010-2015 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 /* Report plugin symbols.  */
  40 bfd_boolean report_plugin_symbols;
  41
  42 /* The suffix to append to the name of the real (claimed) object file
  43    when generating a dummy BFD to hold the IR symbols sent from the
  44    plugin.  For cosmetic use only; appears in maps, crefs etc.  */
  45 #define IRONLY_SUFFIX " (symbol from plugin)"
  46
  47 /* Stores a single argument passed to a plugin.  */
  48 typedef struct plugin_arg
  49 {
  50   struct plugin_arg *next;
  51   const char *arg;
  52 } plugin_arg_t;
  53
  54 /* Holds all details of a single plugin.  */
  55 typedef struct plugin
  56 {
  57   /* Next on the list of plugins, or NULL at end of chain.  */
  58   struct plugin *next;
  59   /* The argument string given to --plugin.  */
  60   const char *name;
  61   /* The shared library handle returned by dlopen.  */
  62   void *dlhandle;
  63   /* The list of argument string given to --plugin-opt.  */
  64   plugin_arg_t *args;
  65   /* Number of args in the list, for convenience.  */
  66   size_t n_args;
  67   /* The plugin's event handlers.  */
  68   ld_plugin_claim_file_handler claim_file_handler;
  69   ld_plugin_all_symbols_read_handler all_symbols_read_handler;
  70   ld_plugin_cleanup_handler cleanup_handler;
  71   /* TRUE if the cleanup handlers have been called.  */
  72   bfd_boolean cleanup_done;
  73 } plugin_t;
  74
  75 /* The master list of all plugins.  */
  76 static plugin_t *plugins_list = NULL;
  77
  78 /* We keep a tail pointer for easy linking on the end.  */
  79 static plugin_t **plugins_tail_chain_ptr = &plugins_list;
  80
  81 /* The last plugin added to the list, for receiving args.  */
  82 static plugin_t *last_plugin = NULL;
  83
  84 /* The tail of the arg chain of the last plugin added to the list.  */
  85 static plugin_arg_t **last_plugin_args_tail_chain_ptr = NULL;
  86
  87 /* The plugin which is currently having a callback executed.  */
  88 static plugin_t *called_plugin = NULL;
  89
  90 /* Last plugin to cause an error, if any.  */
  91 static const char *error_plugin = NULL;
  92
  93 /* State of linker "notice" interface before we poked at it.  */
  94 static bfd_boolean orig_notice_all;
  95
  96 /* Original linker callbacks, and the plugin version.  */
  97 static const struct bfd_link_callbacks *orig_callbacks;
  98 static struct bfd_link_callbacks plugin_callbacks;
  99
 100 /* Set at all symbols read time, to avoid recursively offering the plugin
 101    its own newly-added input files and libs to claim.  */
 102 bfd_boolean no_more_claiming = FALSE;
 103
 104 /* List of tags to set in the constant leading part of the tv array. */
 105 static const enum ld_plugin_tag tv_header_tags[] =
 106 {
 107   LDPT_MESSAGE,
 108   LDPT_API_VERSION,
 109   LDPT_GNU_LD_VERSION,
 110   LDPT_LINKER_OUTPUT,
 111   LDPT_OUTPUT_NAME,
 112   LDPT_REGISTER_CLAIM_FILE_HOOK,
 113   LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK,
 114   LDPT_REGISTER_CLEANUP_HOOK,
 115   LDPT_ADD_SYMBOLS,
 116   LDPT_GET_INPUT_FILE,
 117   LDPT_GET_VIEW,
 118   LDPT_RELEASE_INPUT_FILE,
 119   LDPT_GET_SYMBOLS,
 120   LDPT_GET_SYMBOLS_V2,
 121   LDPT_ADD_INPUT_FILE,
 122   LDPT_ADD_INPUT_LIBRARY,
 123   LDPT_SET_EXTRA_LIBRARY_PATH
 124 };
 125
 126 /* How many entries in the constant leading part of the tv array.  */
 127 static const size_t tv_header_size = ARRAY_SIZE (tv_header_tags);
 128
 129 /* Forward references.  */
 130 static bfd_boolean plugin_notice (struct bfd_link_info *,
 131                                   struct bfd_link_hash_entry *,
 132                                   struct bfd_link_hash_entry *,
 133                                   bfd *, asection *, bfd_vma, flagword);
 134
 135 #if !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)
 136
 137 #define RTLD_NOW 0      /* Dummy value.  */
 138
 139 static void *
 140 dlopen (const char *file, int mode ATTRIBUTE_UNUSED)
 141 {
 142   return LoadLibrary (file);
 143 }
 144
 145 static void *
 146 dlsym (void *handle, const char *name)
 147 {
 148   return GetProcAddress (handle, name);
 149 }
 150
 151 static int
 152 dlclose (void *handle)
 153 {
 154   FreeLibrary (handle);
 155   return 0;
 156 }
 157
 158 #endif /* !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)  */
 159
 160 #ifndef HAVE_DLFCN_H
 161 static const char *
 162 dlerror (void)
 163 {
 164   return "";
 165 }
 166 #endif
 167
 168 /* Helper function for exiting with error status.  */
 169 static int
 170 set_plugin_error (const char *plugin)
 171 {
 172   error_plugin = plugin;
 173   return -1;
 174 }
 175
 176 /* Test if an error occurred.  */
 177 static bfd_boolean
 178 plugin_error_p (void)
 179 {
 180   return error_plugin != NULL;
 181 }
 182
 183 /* Return name of plugin which caused an error if any.  */
 184 const char *
 185 plugin_error_plugin (void)
 186 {
 187   return error_plugin ? error_plugin : _("<no plugin>");
 188 }
 189
 190 /* Handle -plugin arg: find and load plugin, or return error.  */
 191 void
 192 plugin_opt_plugin (const char *plugin)
 193 {
 194   plugin_t *newplug;
 195
 196   newplug = xmalloc (sizeof *newplug);
 197   memset (newplug, 0, sizeof *newplug);
 198   newplug->name = plugin;
 199   newplug->dlhandle = dlopen (plugin, RTLD_NOW);
 200   if (!newplug->dlhandle)
 201     einfo (_("%P%F: %s: error loading plugin: %s\n"), plugin, dlerror ());
 202
 203   /* Chain on end, so when we run list it is in command-line order.  */
 204   *plugins_tail_chain_ptr = newplug;
 205   plugins_tail_chain_ptr = &newplug->next;
 206
 207   /* Record it as current plugin for receiving args.  */
 208   last_plugin = newplug;
 209   last_plugin_args_tail_chain_ptr = &newplug->args;
 210 }
 211
 212 /* Accumulate option arguments for last-loaded plugin, or return
 213    error if none.  */
 214 int
 215 plugin_opt_plugin_arg (const char *arg)
 216 {
 217   plugin_arg_t *newarg;
 218
 219   if (!last_plugin)
 220     return set_plugin_error (_("<no plugin>"));
 221
 222   /* Ignore -pass-through= from GCC driver.  */
 223   if (*arg == '-')
 224     {
 225       const char *p = arg + 1;
 226
 227       if (*p == '-')
 228         ++p;
 229       if (strncmp (p, "pass-through=", 13) == 0)
 230         return 0;
 231     }
 232
 233   newarg = xmalloc (sizeof *newarg);
 234   newarg->arg = arg;
 235   newarg->next = NULL;
 236
 237   /* Chain on end to preserve command-line order.  */
 238   *last_plugin_args_tail_chain_ptr = newarg;
 239   last_plugin_args_tail_chain_ptr = &newarg->next;
 240   last_plugin->n_args++;
 241   return 0;
 242 }
 243
 244 /* Generate a dummy BFD to represent an IR file, for any callers of
 245    plugin_call_claim_file to use as the handle in the ld_plugin_input_file
 246    struct that they build to pass in.  The BFD is initially writable, so
 247    that symbols can be added to it; it must be made readable after the
 248    add_symbols hook has been called so that it can be read when linking.  */
 249 static bfd *
 250 plugin_get_ir_dummy_bfd (const char *name, bfd *srctemplate)
 251 {
 252   bfd *abfd;
 253
 254   bfd_use_reserved_id = 1;
 255   abfd = bfd_create (concat (name, IRONLY_SUFFIX, (const char *) NULL),
 256                      srctemplate);
 257   if (abfd != NULL)
 258     {
 259       abfd->flags |= BFD_LINKER_CREATED | BFD_PLUGIN;
 260       bfd_set_arch_info (abfd, bfd_get_arch_info (srctemplate));
 261       bfd_set_gp_size (abfd, bfd_get_gp_size (srctemplate));
 262       if (bfd_make_writable (abfd)
 263           && bfd_copy_private_bfd_data (srctemplate, abfd))
 264         {
 265           flagword flags;
 266
 267           /* Create section to own the symbols.  */
 268           flags = (SEC_CODE | SEC_HAS_CONTENTS | SEC_READONLY
 269                    | SEC_ALLOC | SEC_LOAD | SEC_KEEP | SEC_EXCLUDE);
 270           if (bfd_make_section_anyway_with_flags (abfd, ".text", flags))
 271             return abfd;
 272         }
 273     }
 274   einfo (_("could not create dummy IR bfd: %F%E\n"));
 275   return NULL;
 276 }
 277
 278 /* Check if the BFD passed in is an IR dummy object file.  */
 279 static inline bfd_boolean
 280 is_ir_dummy_bfd (const bfd *abfd)
 281 {
 282   /* ABFD can sometimes legitimately be NULL, e.g. when called from one
 283      of the linker callbacks for a symbol in the *ABS* or *UND* sections.  */
 284   return abfd != NULL && (abfd->flags & BFD_PLUGIN) != 0;
 285 }
 286
 287 /* Helpers to convert between BFD and GOLD symbol formats.  */
 288 static enum ld_plugin_status
 289 asymbol_from_plugin_symbol (bfd *abfd, asymbol *asym,
 290                             const struct ld_plugin_symbol *ldsym)
 291 {
 292   flagword flags = BSF_NO_FLAGS;
 293   struct bfd_section *section;
 294
 295   asym->the_bfd = abfd;
 296   asym->name = (ldsym->version
 297                 ? concat (ldsym->name, "@", ldsym->version, (const char *) NULL)
 298                 : ldsym->name);
 299   asym->value = 0;
 300   switch (ldsym->def)
 301     {
 302     case LDPK_WEAKDEF:
 303       flags = BSF_WEAK;
 304       /* FALLTHRU */
 305     case LDPK_DEF:
 306       flags |= BSF_GLOBAL;
 307       if (ldsym->comdat_key)
 308         {
 309           char *name = concat (".gnu.linkonce.t.", ldsym->comdat_key,
 310                                (const char *) NULL);
 311           section = bfd_get_section_by_name (abfd, name);
 312           if (section != NULL)
 313             free (name);
 314           else
 315             {
 316               flagword sflags;
 317
 318               sflags = (SEC_CODE | SEC_HAS_CONTENTS | SEC_READONLY
 319                         | SEC_ALLOC | SEC_LOAD | SEC_KEEP | SEC_EXCLUDE
 320                         | SEC_LINK_ONCE | SEC_LINK_DUPLICATES_DISCARD);
 321               section = bfd_make_section_anyway_with_flags (abfd, name, sflags);
 322               if (section == NULL)
 323                 return LDPS_ERR;
 324             }
 325         }
 326       else
 327         section = bfd_get_section_by_name (abfd, ".text");
 328       break;
 329
 330     case LDPK_WEAKUNDEF:
 331       flags = BSF_WEAK;
 332       /* FALLTHRU */
 333     case LDPK_UNDEF:
 334       section = bfd_und_section_ptr;
 335       break;
 336
 337     case LDPK_COMMON:
 338       flags = BSF_GLOBAL;
 339       section = bfd_com_section_ptr;
 340       asym->value = ldsym->size;
 341       /* For ELF targets, set alignment of common symbol to 1.  */
 342       if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 343         {
 344           ((elf_symbol_type *) asym)->internal_elf_sym.st_shndx = SHN_COMMON;
 345           ((elf_symbol_type *) asym)->internal_elf_sym.st_value = 1;
 346         }
 347       break;
 348
 349     default:
 350       return LDPS_ERR;
 351     }
 352   asym->flags = flags;
 353   asym->section = section;
 354
 355   /* Visibility only applies on ELF targets.  */
 356   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
 357     {
 358       elf_symbol_type *elfsym = elf_symbol_from (abfd, asym);
 359       unsigned char visibility;
 360
 361       if (!elfsym)
 362         einfo (_("%P%F: %s: non-ELF symbol in ELF BFD!\n"), asym->name);
 363       switch (ldsym->visibility)
 364         {
 365         default:
 366           einfo (_("%P%F: unknown ELF symbol visibility: %d!\n"),
 367                  ldsym->visibility);
 368         case LDPV_DEFAULT:
 369           visibility = STV_DEFAULT;
 370           break;
 371         case LDPV_PROTECTED:
 372           visibility = STV_PROTECTED;
 373           break;
 374         case LDPV_INTERNAL:
 375           visibility = STV_INTERNAL;
 376           break;
 377         case LDPV_HIDDEN:
 378           visibility = STV_HIDDEN;
 379           break;
 380         }
 381       elfsym->internal_elf_sym.st_other
 382         = (visibility | (elfsym->internal_elf_sym.st_other
 383                          & ~ELF_ST_VISIBILITY (-1)));
 384     }
 385
 386   return LDPS_OK;
 387 }
 388
 389 /* Register a claim-file handler.  */
 390 static enum ld_plugin_status
 391 register_claim_file (ld_plugin_claim_file_handler handler)
 392 {
 393   ASSERT (called_plugin);
 394   called_plugin->claim_file_handler = handler;
 395   return LDPS_OK;
 396 }
 397
 398 /* Register an all-symbols-read handler.  */
 399 static enum ld_plugin_status
 400 register_all_symbols_read (ld_plugin_all_symbols_read_handler handler)
 401 {
 402   ASSERT (called_plugin);
 403   called_plugin->all_symbols_read_handler = handler;
 404   return LDPS_OK;
 405 }
 406
 407 /* Register a cleanup handler.  */
 408 static enum ld_plugin_status
 409 register_cleanup (ld_plugin_cleanup_handler handler)
 410 {
 411   ASSERT (called_plugin);
 412   called_plugin->cleanup_handler = handler;
 413   return LDPS_OK;
 414 }
 415
 416 /* Add symbols from a plugin-claimed input file.  */
 417 static enum ld_plugin_status
 418 add_symbols (void *handle, int nsyms, const struct ld_plugin_symbol *syms)
 419 {
 420   asymbol **symptrs;
 421   bfd *abfd = handle;
 422   int n;
 423
 424   ASSERT (called_plugin);
 425   symptrs = xmalloc (nsyms * sizeof *symptrs);
 426   for (n = 0; n < nsyms; n++)
 427     {
 428       enum ld_plugin_status rv;
 429       asymbol *bfdsym;
 430
 431       bfdsym = bfd_make_empty_symbol (abfd);
 432       symptrs[n] = bfdsym;
 433       rv = asymbol_from_plugin_symbol (abfd, bfdsym, syms + n);
 434       if (rv != LDPS_OK)
 435         return rv;
 436     }
 437   bfd_set_symtab (abfd, symptrs, nsyms);
 438   return LDPS_OK;
 439 }
 440
 441 /* Get the input file information with an open (possibly re-opened)
 442    file descriptor.  */
 443 static enum ld_plugin_status
 444 get_input_file (const void *handle ATTRIBUTE_UNUSED,
 445                 struct ld_plugin_input_file *file ATTRIBUTE_UNUSED)
 446 {
 447   ASSERT (called_plugin);
 448   return LDPS_ERR;
 449 }
 450
 451 /* Get view of the input file.  */
 452 static enum ld_plugin_status
 453 get_view (const void *handle ATTRIBUTE_UNUSED,
 454           const void **viewp ATTRIBUTE_UNUSED)
 455 {
 456   ASSERT (called_plugin);
 457   return LDPS_ERR;
 458 }
 459
 460 /* Release the input file.  */
 461 static enum ld_plugin_status
 462 release_input_file (const void *handle ATTRIBUTE_UNUSED)
 463 {
 464   ASSERT (called_plugin);
 465   return LDPS_ERR;
 466 }
 467
 468 /* Return TRUE if a defined symbol might be reachable from outside the
 469    universe of claimed objects.  */
 470 static inline bfd_boolean
 471 is_visible_from_outside (struct ld_plugin_symbol *lsym,
 472                          struct bfd_link_hash_entry *blhe)
 473 {
 474   struct bfd_sym_chain *sym;
 475
 476   if (link_info.relocatable)
 477     return TRUE;
 478   if (link_info.export_dynamic || !link_info.executable)
 479     {
 480       /* Check if symbol is hidden by version script.  */
 481       if (bfd_hide_sym_by_version (link_info.version_info,
 482                                    blhe->root.string))
 483         return FALSE;
 484       /* Only ELF symbols really have visibility.  */
 485       if (bfd_get_flavour (link_info.output_bfd) == bfd_target_elf_flavour)
 486         {
 487           struct elf_link_hash_entry *el = (struct elf_link_hash_entry *)blhe;
 488           int vis = ELF_ST_VISIBILITY (el->other);
 489           return vis == STV_DEFAULT || vis == STV_PROTECTED;
 490         }
 491       /* On non-ELF targets, we can safely make inferences by considering
 492          what visibility the plugin would have liked to apply when it first
 493          sent us the symbol.  During ELF symbol processing, visibility only
 494          ever becomes more restrictive, not less, when symbols are merged,
 495          so this is a conservative estimate; it may give false positives,
 496          declaring something visible from outside when it in fact would
 497          not have been, but this will only lead to missed optimisation
 498          opportunities during LTRANS at worst; it will not give false
 499          negatives, which can lead to the disastrous conclusion that the
 500          related symbol is IRONLY.  (See GCC PR46319 for an example.)  */
 501       return (lsym->visibility == LDPV_DEFAULT
 502               || lsym->visibility == LDPV_PROTECTED);
 503     }
 504
 505   for (sym = &entry_symbol; sym != NULL; sym = sym->next)
 506     if (sym->name
 507         && strcmp (sym->name, blhe->root.string) == 0)
 508       return TRUE;
 509
 510   return FALSE;
 511 }
 512
 513 /* Get the symbol resolution info for a plugin-claimed input file.  */
 514 static enum ld_plugin_status
 515 get_symbols (const void *handle, int nsyms, struct ld_plugin_symbol *syms,
 516              int def_ironly_exp)
 517 {
 518   const bfd *abfd = handle;
 519   int n;
 520
 521   ASSERT (called_plugin);
 522   for (n = 0; n < nsyms; n++)
 523     {
 524       struct bfd_link_hash_entry *blhe;
 525       asection *owner_sec;
 526       int res;
 527
 528       if (syms[n].def != LDPK_UNDEF)
 529         blhe = bfd_link_hash_lookup (link_info.hash, syms[n].name,
 530                                      FALSE, FALSE, TRUE);
 531       else
 532         blhe = bfd_wrapped_link_hash_lookup (link_info.output_bfd, &link_info,
 533                                              syms[n].name, FALSE, FALSE, TRUE);
 534       if (!blhe)
 535         {
 536           res = LDPR_UNKNOWN;
 537           goto report_symbol;
 538         }
 539
 540       /* Determine resolution from blhe type and symbol's original type.  */
 541       if (blhe->type == bfd_link_hash_undefined
 542           || blhe->type == bfd_link_hash_undefweak)
 543         {
 544           res = LDPR_UNDEF;
 545           goto report_symbol;
 546         }
 547       if (blhe->type != bfd_link_hash_defined
 548           && blhe->type != bfd_link_hash_defweak
 549           && blhe->type != bfd_link_hash_common)
 550         {
 551           /* We should not have a new, indirect or warning symbol here.  */
 552           einfo ("%P%F: %s: plugin symbol table corrupt (sym type %d)\n",
 553                  called_plugin->name, blhe->type);
 554         }
 555
 556       /* Find out which section owns the symbol.  Since it's not undef,
 557          it must have an owner; if it's not a common symbol, both defs
 558          and weakdefs keep it in the same place. */
 559       owner_sec = (blhe->type == bfd_link_hash_common
 560                    ? blhe->u.c.p->section
 561                    : blhe->u.def.section);
 562
 563
 564       /* If it was originally undefined or common, then it has been
 565          resolved; determine how.  */
 566       if (syms[n].def == LDPK_UNDEF
 567           || syms[n].def == LDPK_WEAKUNDEF
 568           || syms[n].def == LDPK_COMMON)
 569         {
 570           if (owner_sec->owner == link_info.output_bfd)
 571             res = LDPR_RESOLVED_EXEC;
 572           else if (owner_sec->owner == abfd)
 573             res = LDPR_PREVAILING_DEF_IRONLY;
 574           else if (is_ir_dummy_bfd (owner_sec->owner))
 575             res = LDPR_RESOLVED_IR;
 576           else if (owner_sec->owner != NULL
 577                    && (owner_sec->owner->flags & DYNAMIC) != 0)
 578             res = LDPR_RESOLVED_DYN;
 579           else
 580             res = LDPR_RESOLVED_EXEC;
 581         }
 582
 583       /* Was originally def, or weakdef.  Does it prevail?  If the
 584          owner is the original dummy bfd that supplied it, then this
 585          is the definition that has prevailed.  */
 586       else if (owner_sec->owner == link_info.output_bfd)
 587         res = LDPR_PREEMPTED_REG;
 588       else if (owner_sec->owner == abfd)
 589         res = LDPR_PREVAILING_DEF_IRONLY;
 590
 591       /* Was originally def, weakdef, or common, but has been pre-empted.  */
 592       else if (is_ir_dummy_bfd (owner_sec->owner))
 593         res = LDPR_PREEMPTED_IR;
 594       else
 595         res = LDPR_PREEMPTED_REG;
 596
 597       if (res == LDPR_PREVAILING_DEF_IRONLY)
 598         {
 599           /* We need to know if the sym is referenced from non-IR files.  Or
 600              even potentially-referenced, perhaps in a future final link if
 601              this is a partial one, perhaps dynamically at load-time if the
 602              symbol is externally visible.  */
 603           if (blhe->non_ir_ref)
 604             res = LDPR_PREVAILING_DEF;
 605           else if (is_visible_from_outside (&syms[n], blhe))
 606             res = def_ironly_exp;
 607         }
 608
 609     report_symbol:
 610       syms[n].resolution = res;
 611       if (report_plugin_symbols)
 612         einfo (_("%P: %B: symbol `%s' "
 613                  "definition: %d, visibility: %d, resolution: %d\n"),
 614                abfd, syms[n].name,
 615                syms[n].def, syms[n].visibility, res);
 616     }
 617   return LDPS_OK;
 618 }
 619
 620 static enum ld_plugin_status
 621 get_symbols_v1 (const void *handle, int nsyms, struct ld_plugin_symbol *syms)
 622 {
 623   return get_symbols (handle, nsyms, syms, LDPR_PREVAILING_DEF);
 624 }
 625
 626 static enum ld_plugin_status
 627 get_symbols_v2 (const void *handle, int nsyms, struct ld_plugin_symbol *syms)
 628 {
 629   return get_symbols (handle, nsyms, syms, LDPR_PREVAILING_DEF_IRONLY_EXP);
 630 }
 631
 632 /* Add a new (real) input file generated by a plugin.  */
 633 static enum ld_plugin_status
 634 add_input_file (const char *pathname)
 635 {
 636   ASSERT (called_plugin);
 637   if (!lang_add_input_file (xstrdup (pathname), lang_input_file_is_file_enum,
 638                             NULL))
 639     return LDPS_ERR;
 640   return LDPS_OK;
 641 }
 642
 643 /* Add a new (real) library required by a plugin.  */
 644 static enum ld_plugin_status
 645 add_input_library (const char *pathname)
 646 {
 647   ASSERT (called_plugin);
 648   if (!lang_add_input_file (xstrdup (pathname), lang_input_file_is_l_enum,
 649                             NULL))
 650     return LDPS_ERR;
 651   return LDPS_OK;
 652 }
 653
 654 /* Set the extra library path to be used by libraries added via
 655    add_input_library.  */
 656 static enum ld_plugin_status
 657 set_extra_library_path (const char *path)
 658 {
 659   ASSERT (called_plugin);
 660   ldfile_add_library_path (xstrdup (path), FALSE);
 661   return LDPS_OK;
 662 }
 663
 664 /* Issue a diagnostic message from a plugin.  */
 665 static enum ld_plugin_status
 666 message (int level, const char *format, ...)
 667 {
 668   va_list args;
 669   va_start (args, format);
 670
 671   switch (level)
 672     {
 673     case LDPL_INFO:
 674       vfinfo (stdout, format, args, FALSE);
 675       putchar ('\n');
 676       break;
 677     case LDPL_WARNING:
 678       vfinfo (stdout, format, args, TRUE);
 679       putchar ('\n');
 680       break;
 681     case LDPL_FATAL:
 682     case LDPL_ERROR:
 683     default:
 684       {
 685         char *newfmt = ACONCAT ((level == LDPL_FATAL ? "%P%F: " : "%P%X: ",
 686                                  format, "\n", (const char *) NULL));
 687         fflush (stdout);
 688         vfinfo (stderr, newfmt, args, TRUE);
 689         fflush (stderr);
 690       }
 691       break;
 692     }
 693
 694   va_end (args);
 695   return LDPS_OK;
 696 }
 697
 698 /* Helper to size leading part of tv array and set it up. */
 699 static void
 700 set_tv_header (struct ld_plugin_tv *tv)
 701 {
 702   size_t i;
 703
 704   /* Version info.  */
 705   static const unsigned int major = (unsigned)(BFD_VERSION / 100000000UL);
 706   static const unsigned int minor = (unsigned)(BFD_VERSION / 1000000UL) % 100;
 707
 708   for (i = 0; i < tv_header_size; i++)
 709     {
 710       tv[i].tv_tag = tv_header_tags[i];
 711 #define TVU(x) tv[i].tv_u.tv_ ## x
 712       switch (tv[i].tv_tag)
 713         {
 714         case LDPT_MESSAGE:
 715           TVU(message) = message;
 716           break;
 717         case LDPT_API_VERSION:
 718           TVU(val) = LD_PLUGIN_API_VERSION;
 719           break;
 720         case LDPT_GNU_LD_VERSION:
 721           TVU(val) = major * 100 + minor;
 722           break;
 723         case LDPT_LINKER_OUTPUT:
 724           TVU(val) = (link_info.relocatable
 725                       ? LDPO_REL
 726                       : (link_info.executable
 727                          ? (link_info.pie ? LDPO_PIE : LDPO_EXEC)
 728                          : LDPO_DYN));
 729           break;
 730         case LDPT_OUTPUT_NAME:
 731           TVU(string) = output_filename;
 732           break;
 733         case LDPT_REGISTER_CLAIM_FILE_HOOK:
 734           TVU(register_claim_file) = register_claim_file;
 735           break;
 736         case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK:
 737           TVU(register_all_symbols_read) = register_all_symbols_read;
 738           break;
 739         case LDPT_REGISTER_CLEANUP_HOOK:
 740           TVU(register_cleanup) = register_cleanup;
 741           break;
 742         case LDPT_ADD_SYMBOLS:
 743           TVU(add_symbols) = add_symbols;
 744           break;
 745         case LDPT_GET_INPUT_FILE:
 746           TVU(get_input_file) = get_input_file;
 747           break;
 748         case LDPT_GET_VIEW:
 749           TVU(get_view) = get_view;
 750           break;
 751         case LDPT_RELEASE_INPUT_FILE:
 752           TVU(release_input_file) = release_input_file;
 753           break;
 754         case LDPT_GET_SYMBOLS:
 755           TVU(get_symbols) = get_symbols_v1;
 756           break;
 757         case LDPT_GET_SYMBOLS_V2:
 758           TVU(get_symbols) = get_symbols_v2;
 759           break;
 760         case LDPT_ADD_INPUT_FILE:
 761           TVU(add_input_file) = add_input_file;
 762           break;
 763         case LDPT_ADD_INPUT_LIBRARY:
 764           TVU(add_input_library) = add_input_library;
 765           break;
 766         case LDPT_SET_EXTRA_LIBRARY_PATH:
 767           TVU(set_extra_library_path) = set_extra_library_path;
 768           break;
 769         default:
 770           /* Added a new entry to the array without adding
 771              a new case to set up its value is a bug.  */
 772           FAIL ();
 773         }
 774 #undef TVU
 775     }
 776 }
 777
 778 /* Append the per-plugin args list and trailing LDPT_NULL to tv.  */
 779 static void
 780 set_tv_plugin_args (plugin_t *plugin, struct ld_plugin_tv *tv)
 781 {
 782   plugin_arg_t *arg = plugin->args;
 783   while (arg)
 784     {
 785       tv->tv_tag = LDPT_OPTION;
 786       tv->tv_u.tv_string = arg->arg;
 787       arg = arg->next;
 788       tv++;
 789     }
 790   tv->tv_tag = LDPT_NULL;
 791   tv->tv_u.tv_val = 0;
 792 }
 793
 794 /* Return true if any plugins are active this run.  Only valid
 795    after options have been processed.  */
 796 bfd_boolean
 797 plugin_active_plugins_p (void)
 798 {
 799   return plugins_list != NULL;
 800 }
 801
 802 /* Load up and initialise all plugins after argument parsing.  */
 803 void
 804 plugin_load_plugins (void)
 805 {
 806   struct ld_plugin_tv *my_tv;
 807   unsigned int max_args = 0;
 808   plugin_t *curplug = plugins_list;
 809
 810   /* If there are no plugins, we need do nothing this run.  */
 811   if (!curplug)
 812     return;
 813
 814   /* First pass over plugins to find max # args needed so that we
 815      can size and allocate the tv array.  */
 816   while (curplug)
 817     {
 818       if (curplug->n_args > max_args)
 819         max_args = curplug->n_args;
 820       curplug = curplug->next;
 821     }
 822
 823   /* Allocate tv array and initialise constant part.  */
 824   my_tv = xmalloc ((max_args + 1 + tv_header_size) * sizeof *my_tv);
 825   set_tv_header (my_tv);
 826
 827   /* Pass over plugins again, activating them.  */
 828   curplug = plugins_list;
 829   while (curplug)
 830     {
 831       enum ld_plugin_status rv;
 832       ld_plugin_onload onloadfn;
 833
 834       onloadfn = (ld_plugin_onload) dlsym (curplug->dlhandle, "onload");
 835       if (!onloadfn)
 836         onloadfn = (ld_plugin_onload) dlsym (curplug->dlhandle, "_onload");
 837       if (!onloadfn)
 838         einfo (_("%P%F: %s: error loading plugin: %s\n"),
 839                curplug->name, dlerror ());
 840       set_tv_plugin_args (curplug, &my_tv[tv_header_size]);
 841       called_plugin = curplug;
 842       rv = (*onloadfn) (my_tv);
 843       called_plugin = NULL;
 844       if (rv != LDPS_OK)
 845         einfo (_("%P%F: %s: plugin error: %d\n"), curplug->name, rv);
 846       curplug = curplug->next;
 847     }
 848
 849   /* Since plugin(s) inited ok, assume they're going to want symbol
 850      resolutions, which needs us to track which symbols are referenced
 851      by non-IR files using the linker's notice callback.  */
 852   orig_notice_all = link_info.notice_all;
 853   orig_callbacks = link_info.callbacks;
 854   plugin_callbacks = *orig_callbacks;
 855   plugin_callbacks.notice = &plugin_notice;
 856   link_info.notice_all = TRUE;
 857   link_info.lto_plugin_active = TRUE;
 858   link_info.callbacks = &plugin_callbacks;
 859 }
 860
 861 /* Call 'claim file' hook for all plugins.  */
 862 static int
 863 plugin_call_claim_file (const struct ld_plugin_input_file *file, int *claimed)
 864 {
 865   plugin_t *curplug = plugins_list;
 866   *claimed = FALSE;
 867   if (no_more_claiming)
 868     return 0;
 869   while (curplug && !*claimed)
 870     {
 871       if (curplug->claim_file_handler)
 872         {
 873           enum ld_plugin_status rv;
 874           called_plugin = curplug;
 875           rv = (*curplug->claim_file_handler) (file, claimed);
 876           called_plugin = NULL;
 877           if (rv != LDPS_OK)
 878             set_plugin_error (curplug->name);
 879         }
 880       curplug = curplug->next;
 881     }
 882   return plugin_error_p () ? -1 : 0;
 883 }
 884
 885 void
 886 plugin_maybe_claim (struct ld_plugin_input_file *file,
 887                     lang_input_statement_type *entry)
 888 {
 889   int claimed = 0;
 890
 891   /* We create a dummy BFD, initially empty, to house whatever symbols
 892      the plugin may want to add.  */
 893   file->handle = plugin_get_ir_dummy_bfd (entry->the_bfd->filename,
 894                                           entry->the_bfd);
 895   if (plugin_call_claim_file (file, &claimed))
 896     einfo (_("%P%F: %s: plugin reported error claiming file\n"),
 897            plugin_error_plugin ());
 898   /* fd belongs to us, not the plugin; but we don't need it.  */
 899   close (file->fd);
 900   if (claimed)
 901     {
 902       /* Discard the real file's BFD and substitute the dummy one.  */
 903
 904       /* BFD archive handling caches elements so we can't call
 905          bfd_close for archives.  */
 906       if (entry->the_bfd->my_archive == NULL)
 907         bfd_close (entry->the_bfd);
 908       entry->the_bfd = file->handle;
 909       entry->flags.claimed = TRUE;
 910       bfd_make_readable (entry->the_bfd);
 911     }
 912   else
 913     {
 914       /* If plugin didn't claim the file, we don't need the dummy bfd.
 915          Can't avoid speculatively creating it, alas.  */
 916       bfd_close_all_done (file->handle);
 917       entry->flags.claimed = FALSE;
 918     }
 919 }
 920
 921 /* Call 'all symbols read' hook for all plugins.  */
 922 int
 923 plugin_call_all_symbols_read (void)
 924 {
 925   plugin_t *curplug = plugins_list;
 926
 927   /* Disable any further file-claiming.  */
 928   no_more_claiming = TRUE;
 929
 930   while (curplug)
 931     {
 932       if (curplug->all_symbols_read_handler)
 933         {
 934           enum ld_plugin_status rv;
 935           called_plugin = curplug;
 936           rv = (*curplug->all_symbols_read_handler) ();
 937           called_plugin = NULL;
 938           if (rv != LDPS_OK)
 939             set_plugin_error (curplug->name);
 940         }
 941       curplug = curplug->next;
 942     }
 943   return plugin_error_p () ? -1 : 0;
 944 }
 945
 946 /* Call 'cleanup' hook for all plugins at exit.  */
 947 void
 948 plugin_call_cleanup (void)
 949 {
 950   plugin_t *curplug = plugins_list;
 951   while (curplug)
 952     {
 953       if (curplug->cleanup_handler && !curplug->cleanup_done)
 954         {
 955           enum ld_plugin_status rv;
 956           curplug->cleanup_done = TRUE;
 957           called_plugin = curplug;
 958           rv = (*curplug->cleanup_handler) ();
 959           called_plugin = NULL;
 960           if (rv != LDPS_OK)
 961             info_msg (_("%P: %s: error in plugin cleanup: %d (ignored)\n"),
 962                       curplug->name, rv);
 963           dlclose (curplug->dlhandle);
 964         }
 965       curplug = curplug->next;
 966     }
 967 }
 968
 969 /* To determine which symbols should be resolved LDPR_PREVAILING_DEF
 970    and which LDPR_PREVAILING_DEF_IRONLY, we notice all the symbols as
 971    the linker adds them to the linker hash table.  Mark those
 972    referenced from a non-IR file with non_ir_ref.  We have to
 973    notice_all symbols, because we won't necessarily know until later
 974    which ones will be contributed by IR files.  */
 975 static bfd_boolean
 976 plugin_notice (struct bfd_link_info *info,
 977                struct bfd_link_hash_entry *h,
 978                struct bfd_link_hash_entry *inh,
 979                bfd *abfd,
 980                asection *section,
 981                bfd_vma value,
 982                flagword flags)
 983 {
 984   struct bfd_link_hash_entry *orig_h = h;
 985
 986   if (h != NULL)
 987     {
 988       bfd *sym_bfd;
 989
 990       if (h->type == bfd_link_hash_warning)
 991         h = h->u.i.link;
 992
 993       /* Nothing to do here if this def/ref is from an IR dummy BFD.  */
 994       if (is_ir_dummy_bfd (abfd))
 995         ;
 996
 997       /* Making an indirect symbol counts as a reference unless this
 998          is a brand new symbol.  */
 999       else if (bfd_is_ind_section (section)
1000                || (flags & BSF_INDIRECT) != 0)
1001         {
1002           /* ??? Some of this is questionable.  See comments in
1003              _bfd_generic_link_add_one_symbol for case IND.  */
1004           if (h->type != bfd_link_hash_new)
1005             {
1006               h->non_ir_ref = TRUE;
1007               inh->non_ir_ref = TRUE;
1008             }
1009           else if (inh->type == bfd_link_hash_new)
1010             inh->non_ir_ref = TRUE;
1011         }
1012
1013       /* Nothing to do here for warning symbols.  */
1014       else if ((flags & BSF_WARNING) != 0)
1015         ;
1016
1017       /* Nothing to do here for constructor symbols.  */
1018       else if ((flags & BSF_CONSTRUCTOR) != 0)
1019         ;
1020
1021       /* If this is a ref, set non_ir_ref.  */
1022       else if (bfd_is_und_section (section))
1023         {
1024           /* Replace the undefined dummy bfd with the real one.  */
1025           if ((h->type == bfd_link_hash_undefined
1026                || h->type == bfd_link_hash_undefweak)
1027               && (h->u.undef.abfd == NULL
1028                   || (h->u.undef.abfd->flags & BFD_PLUGIN) != 0))
1029             h->u.undef.abfd = abfd;
1030           h->non_ir_ref = TRUE;
1031         }
1032
1033       /* Otherwise, it must be a new def.  Ensure any symbol defined
1034          in an IR dummy BFD takes on a new value from a real BFD.
1035          Weak symbols are not normally overridden by a new weak
1036          definition, and strong symbols will normally cause multiple
1037          definition errors.  Avoid this by making the symbol appear
1038          to be undefined.  */
1039       else if (((h->type == bfd_link_hash_defweak
1040                  || h->type == bfd_link_hash_defined)
1041                 && is_ir_dummy_bfd (sym_bfd = h->u.def.section->owner))
1042                || (h->type == bfd_link_hash_common
1043                    && is_ir_dummy_bfd (sym_bfd = h->u.c.p->section->owner)))
1044         {
1045           h->type = bfd_link_hash_undefweak;
1046           h->u.undef.abfd = sym_bfd;
1047         }
1048     }
1049
1050   /* Continue with cref/nocrossref/trace-sym processing.  */
1051   if (orig_h == NULL
1052       || orig_notice_all
1053       || (info->notice_hash != NULL
1054           && bfd_hash_lookup (info->notice_hash, orig_h->root.string,
1055                               FALSE, FALSE) != NULL))
1056     return (*orig_callbacks->notice) (info, orig_h, inh,
1057                                       abfd, section, value, flags);
1058   return TRUE;
1059 }