1 /* Plugin control for the GNU linker.
2 Copyright (C) 2010-2015 Free Software Foundation, Inc.
4 This file is part of the GNU Binutils.
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.
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.
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. */
22 #include "libiberty.h"
33 #include "../bfd/plugin.h"
35 #include "plugin-api.h"
38 # include <sys/mman.h>
40 # define MAP_FAILED ((void *) -1)
46 # define MAP_PRIVATE 0
50 #if !(defined(errno) || defined(_MSC_VER) && defined(_INC_ERRNO))
53 #if !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)
57 /* Report plugin symbols. */
58 bfd_boolean report_plugin_symbols;
60 /* The suffix to append to the name of the real (claimed) object file
61 when generating a dummy BFD to hold the IR symbols sent from the
62 plugin. For cosmetic use only; appears in maps, crefs etc. */
63 #define IRONLY_SUFFIX " (symbol from plugin)"
65 /* Stores a single argument passed to a plugin. */
66 typedef struct plugin_arg
68 struct plugin_arg *next;
72 /* Holds all details of a single plugin. */
75 /* Next on the list of plugins, or NULL at end of chain. */
77 /* The argument string given to --plugin. */
79 /* The shared library handle returned by dlopen. */
81 /* The list of argument string given to --plugin-opt. */
83 /* Number of args in the list, for convenience. */
85 /* The plugin's event handlers. */
86 ld_plugin_claim_file_handler claim_file_handler;
87 ld_plugin_all_symbols_read_handler all_symbols_read_handler;
88 ld_plugin_cleanup_handler cleanup_handler;
89 /* TRUE if the cleanup handlers have been called. */
90 bfd_boolean cleanup_done;
93 typedef struct view_buffer
100 /* The internal version of struct ld_plugin_input_file with a BFD
102 typedef struct plugin_input_file
105 view_buffer_t view_buffer;
108 bfd_boolean use_mmap;
111 } plugin_input_file_t;
113 /* The master list of all plugins. */
114 static plugin_t *plugins_list = NULL;
116 /* We keep a tail pointer for easy linking on the end. */
117 static plugin_t **plugins_tail_chain_ptr = &plugins_list;
119 /* The last plugin added to the list, for receiving args. */
120 static plugin_t *last_plugin = NULL;
122 /* The tail of the arg chain of the last plugin added to the list. */
123 static plugin_arg_t **last_plugin_args_tail_chain_ptr = NULL;
125 /* The plugin which is currently having a callback executed. */
126 static plugin_t *called_plugin = NULL;
128 /* Last plugin to cause an error, if any. */
129 static const char *error_plugin = NULL;
131 /* State of linker "notice" interface before we poked at it. */
132 static bfd_boolean orig_notice_all;
134 /* Original linker callbacks, and the plugin version. */
135 static const struct bfd_link_callbacks *orig_callbacks;
136 static struct bfd_link_callbacks plugin_callbacks;
138 /* Set at all symbols read time, to avoid recursively offering the plugin
139 its own newly-added input files and libs to claim. */
140 bfd_boolean no_more_claiming = FALSE;
142 #if HAVE_MMAP && HAVE_GETPAGESIZE
143 /* Page size used by mmap. */
144 static off_t plugin_pagesize;
147 /* List of tags to set in the constant leading part of the tv array. */
148 static const enum ld_plugin_tag tv_header_tags[] =
155 LDPT_REGISTER_CLAIM_FILE_HOOK,
156 LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK,
157 LDPT_REGISTER_CLEANUP_HOOK,
161 LDPT_RELEASE_INPUT_FILE,
165 LDPT_ADD_INPUT_LIBRARY,
166 LDPT_SET_EXTRA_LIBRARY_PATH
169 /* How many entries in the constant leading part of the tv array. */
170 static const size_t tv_header_size = ARRAY_SIZE (tv_header_tags);
172 /* Forward references. */
173 static bfd_boolean plugin_notice (struct bfd_link_info *,
174 struct bfd_link_hash_entry *,
175 struct bfd_link_hash_entry *,
176 bfd *, asection *, bfd_vma, flagword);
178 static const bfd_target * plugin_object_p (bfd *);
180 #if !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)
182 #define RTLD_NOW 0 /* Dummy value. */
185 dlopen (const char *file, int mode ATTRIBUTE_UNUSED)
187 return LoadLibrary (file);
191 dlsym (void *handle, const char *name)
193 return GetProcAddress (handle, name);
197 dlclose (void *handle)
199 FreeLibrary (handle);
203 #endif /* !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H) */
213 /* Helper function for exiting with error status. */
215 set_plugin_error (const char *plugin)
217 error_plugin = plugin;
221 /* Test if an error occurred. */
223 plugin_error_p (void)
225 return error_plugin != NULL;
228 /* Return name of plugin which caused an error if any. */
230 plugin_error_plugin (void)
232 return error_plugin ? error_plugin : _("<no plugin>");
235 /* Handle -plugin arg: find and load plugin, or return error. */
237 plugin_opt_plugin (const char *plugin)
241 newplug = xmalloc (sizeof *newplug);
242 memset (newplug, 0, sizeof *newplug);
243 newplug->name = plugin;
244 newplug->dlhandle = dlopen (plugin, RTLD_NOW);
245 if (!newplug->dlhandle)
246 einfo (_("%P%F: %s: error loading plugin: %s\n"), plugin, dlerror ());
248 /* Chain on end, so when we run list it is in command-line order. */
249 *plugins_tail_chain_ptr = newplug;
250 plugins_tail_chain_ptr = &newplug->next;
252 /* Record it as current plugin for receiving args. */
253 last_plugin = newplug;
254 last_plugin_args_tail_chain_ptr = &newplug->args;
257 /* Accumulate option arguments for last-loaded plugin, or return
260 plugin_opt_plugin_arg (const char *arg)
262 plugin_arg_t *newarg;
265 return set_plugin_error (_("<no plugin>"));
267 /* Ignore -pass-through= from GCC driver. */
270 const char *p = arg + 1;
274 if (strncmp (p, "pass-through=", 13) == 0)
278 newarg = xmalloc (sizeof *newarg);
282 /* Chain on end to preserve command-line order. */
283 *last_plugin_args_tail_chain_ptr = newarg;
284 last_plugin_args_tail_chain_ptr = &newarg->next;
285 last_plugin->n_args++;
289 /* Generate a dummy BFD to represent an IR file, for any callers of
290 plugin_call_claim_file to use as the handle in the ld_plugin_input_file
291 struct that they build to pass in. The BFD is initially writable, so
292 that symbols can be added to it; it must be made readable after the
293 add_symbols hook has been called so that it can be read when linking. */
295 plugin_get_ir_dummy_bfd (const char *name, bfd *srctemplate)
299 bfd_use_reserved_id = 1;
300 abfd = bfd_create (concat (name, IRONLY_SUFFIX, (const char *) NULL),
301 link_info.output_bfd);
304 abfd->flags |= BFD_LINKER_CREATED | BFD_PLUGIN;
305 if (!bfd_make_writable (abfd))
307 if (! bfd_plugin_target_p (srctemplate->xvec))
309 bfd_set_arch_info (abfd, bfd_get_arch_info (srctemplate));
310 bfd_set_gp_size (abfd, bfd_get_gp_size (srctemplate));
311 if (!bfd_copy_private_bfd_data (srctemplate, abfd))
317 /* Create section to own the symbols. */
318 flags = (SEC_CODE | SEC_HAS_CONTENTS | SEC_READONLY
319 | SEC_ALLOC | SEC_LOAD | SEC_KEEP | SEC_EXCLUDE);
320 if (bfd_make_section_anyway_with_flags (abfd, ".text", flags))
325 einfo (_("could not create dummy IR bfd: %F%E\n"));
329 /* Check if the BFD passed in is an IR dummy object file. */
330 static inline bfd_boolean
331 is_ir_dummy_bfd (const bfd *abfd)
333 /* ABFD can sometimes legitimately be NULL, e.g. when called from one
334 of the linker callbacks for a symbol in the *ABS* or *UND* sections. */
335 return abfd != NULL && (abfd->flags & BFD_PLUGIN) != 0;
338 /* Helpers to convert between BFD and GOLD symbol formats. */
339 static enum ld_plugin_status
340 asymbol_from_plugin_symbol (bfd *abfd, asymbol *asym,
341 const struct ld_plugin_symbol *ldsym)
343 flagword flags = BSF_NO_FLAGS;
344 struct bfd_section *section;
346 asym->the_bfd = abfd;
347 asym->name = (ldsym->version
348 ? concat (ldsym->name, "@", ldsym->version, (const char *) NULL)
358 if (ldsym->comdat_key)
360 char *name = concat (".gnu.linkonce.t.", ldsym->comdat_key,
361 (const char *) NULL);
362 section = bfd_get_section_by_name (abfd, name);
369 sflags = (SEC_CODE | SEC_HAS_CONTENTS | SEC_READONLY
370 | SEC_ALLOC | SEC_LOAD | SEC_KEEP | SEC_EXCLUDE
371 | SEC_LINK_ONCE | SEC_LINK_DUPLICATES_DISCARD);
372 section = bfd_make_section_anyway_with_flags (abfd, name, sflags);
378 section = bfd_get_section_by_name (abfd, ".text");
385 section = bfd_und_section_ptr;
390 section = bfd_com_section_ptr;
391 asym->value = ldsym->size;
392 /* For ELF targets, set alignment of common symbol to 1. */
393 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
395 ((elf_symbol_type *) asym)->internal_elf_sym.st_shndx = SHN_COMMON;
396 ((elf_symbol_type *) asym)->internal_elf_sym.st_value = 1;
404 asym->section = section;
406 /* Visibility only applies on ELF targets. */
407 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
409 elf_symbol_type *elfsym = elf_symbol_from (abfd, asym);
410 unsigned char visibility;
413 einfo (_("%P%F: %s: non-ELF symbol in ELF BFD!\n"), asym->name);
414 switch (ldsym->visibility)
417 einfo (_("%P%F: unknown ELF symbol visibility: %d!\n"),
420 visibility = STV_DEFAULT;
423 visibility = STV_PROTECTED;
426 visibility = STV_INTERNAL;
429 visibility = STV_HIDDEN;
432 elfsym->internal_elf_sym.st_other
433 = (visibility | (elfsym->internal_elf_sym.st_other
434 & ~ELF_ST_VISIBILITY (-1)));
440 /* Register a claim-file handler. */
441 static enum ld_plugin_status
442 register_claim_file (ld_plugin_claim_file_handler handler)
444 ASSERT (called_plugin);
445 called_plugin->claim_file_handler = handler;
449 /* Register an all-symbols-read handler. */
450 static enum ld_plugin_status
451 register_all_symbols_read (ld_plugin_all_symbols_read_handler handler)
453 ASSERT (called_plugin);
454 called_plugin->all_symbols_read_handler = handler;
458 /* Register a cleanup handler. */
459 static enum ld_plugin_status
460 register_cleanup (ld_plugin_cleanup_handler handler)
462 ASSERT (called_plugin);
463 called_plugin->cleanup_handler = handler;
467 /* Add symbols from a plugin-claimed input file. */
468 static enum ld_plugin_status
469 add_symbols (void *handle, int nsyms, const struct ld_plugin_symbol *syms)
472 plugin_input_file_t *input = handle;
473 bfd *abfd = input->abfd;
476 ASSERT (called_plugin);
477 symptrs = xmalloc (nsyms * sizeof *symptrs);
478 for (n = 0; n < nsyms; n++)
480 enum ld_plugin_status rv;
483 bfdsym = bfd_make_empty_symbol (abfd);
485 rv = asymbol_from_plugin_symbol (abfd, bfdsym, syms + n);
489 bfd_set_symtab (abfd, symptrs, nsyms);
493 /* Get the input file information with an open (possibly re-opened)
495 static enum ld_plugin_status
496 get_input_file (const void *handle, struct ld_plugin_input_file *file)
498 const plugin_input_file_t *input = handle;
500 ASSERT (called_plugin);
502 file->name = input->name;
503 file->offset = input->offset;
504 file->filesize = input->filesize;
505 file->handle = (void *) handle;
510 /* Get view of the input file. */
511 static enum ld_plugin_status
512 get_view (const void *handle, const void **viewp)
514 plugin_input_file_t *input = (plugin_input_file_t *) handle;
516 size_t size = input->filesize;
517 off_t offset = input->offset;
518 #if HAVE_MMAP && HAVE_GETPAGESIZE
522 ASSERT (called_plugin);
524 /* FIXME: einfo should support %lld. */
525 if ((off_t) size != input->filesize)
526 einfo (_("%P%F: unsupported input file size: %s (%ld bytes)\n"),
527 input->name, (long) input->filesize);
529 /* Check the cached view buffer. */
530 if (input->view_buffer.addr != NULL
531 && input->view_buffer.filesize == size
532 && input->view_buffer.offset == offset)
534 *viewp = input->view_buffer.addr;
538 input->view_buffer.filesize = size;
539 input->view_buffer.offset = offset;
542 # if HAVE_GETPAGESIZE
543 bias = offset % plugin_pagesize;
547 buffer = mmap (NULL, size, PROT_READ, MAP_PRIVATE, input->fd, offset);
548 if (buffer != MAP_FAILED)
550 input->use_mmap = TRUE;
551 # if HAVE_GETPAGESIZE
560 input->use_mmap = FALSE;
562 if (lseek (input->fd, offset, SEEK_SET) < 0)
565 buffer = bfd_alloc (input->abfd, size);
572 ssize_t got = read (input->fd, p, size);
580 else if (errno != EINTR)
586 input->view_buffer.addr = buffer;
592 /* Release the input file. */
593 static enum ld_plugin_status
594 release_input_file (const void *handle)
596 plugin_input_file_t *input = (plugin_input_file_t *) handle;
597 ASSERT (called_plugin);
606 /* Return TRUE if a defined symbol might be reachable from outside the
607 universe of claimed objects. */
608 static inline bfd_boolean
609 is_visible_from_outside (struct ld_plugin_symbol *lsym,
610 struct bfd_link_hash_entry *blhe)
612 struct bfd_sym_chain *sym;
614 if (link_info.relocatable)
616 if (link_info.export_dynamic || !link_info.executable)
618 /* Check if symbol is hidden by version script. */
619 if (bfd_hide_sym_by_version (link_info.version_info,
622 /* Only ELF symbols really have visibility. */
623 if (bfd_get_flavour (link_info.output_bfd) == bfd_target_elf_flavour)
625 struct elf_link_hash_entry *el = (struct elf_link_hash_entry *)blhe;
626 int vis = ELF_ST_VISIBILITY (el->other);
627 return vis == STV_DEFAULT || vis == STV_PROTECTED;
629 /* On non-ELF targets, we can safely make inferences by considering
630 what visibility the plugin would have liked to apply when it first
631 sent us the symbol. During ELF symbol processing, visibility only
632 ever becomes more restrictive, not less, when symbols are merged,
633 so this is a conservative estimate; it may give false positives,
634 declaring something visible from outside when it in fact would
635 not have been, but this will only lead to missed optimisation
636 opportunities during LTRANS at worst; it will not give false
637 negatives, which can lead to the disastrous conclusion that the
638 related symbol is IRONLY. (See GCC PR46319 for an example.) */
639 return (lsym->visibility == LDPV_DEFAULT
640 || lsym->visibility == LDPV_PROTECTED);
643 for (sym = &entry_symbol; sym != NULL; sym = sym->next)
645 && strcmp (sym->name, blhe->root.string) == 0)
651 /* Get the symbol resolution info for a plugin-claimed input file. */
652 static enum ld_plugin_status
653 get_symbols (const void *handle, int nsyms, struct ld_plugin_symbol *syms,
656 const plugin_input_file_t *input = handle;
657 const bfd *abfd = (const bfd *) input->abfd;
660 ASSERT (called_plugin);
661 for (n = 0; n < nsyms; n++)
663 struct bfd_link_hash_entry *blhe;
667 if (syms[n].def != LDPK_UNDEF)
668 blhe = bfd_link_hash_lookup (link_info.hash, syms[n].name,
671 blhe = bfd_wrapped_link_hash_lookup (link_info.output_bfd, &link_info,
672 syms[n].name, FALSE, FALSE, TRUE);
679 /* Determine resolution from blhe type and symbol's original type. */
680 if (blhe->type == bfd_link_hash_undefined
681 || blhe->type == bfd_link_hash_undefweak)
686 if (blhe->type != bfd_link_hash_defined
687 && blhe->type != bfd_link_hash_defweak
688 && blhe->type != bfd_link_hash_common)
690 /* We should not have a new, indirect or warning symbol here. */
691 einfo ("%P%F: %s: plugin symbol table corrupt (sym type %d)\n",
692 called_plugin->name, blhe->type);
695 /* Find out which section owns the symbol. Since it's not undef,
696 it must have an owner; if it's not a common symbol, both defs
697 and weakdefs keep it in the same place. */
698 owner_sec = (blhe->type == bfd_link_hash_common
699 ? blhe->u.c.p->section
700 : blhe->u.def.section);
703 /* If it was originally undefined or common, then it has been
704 resolved; determine how. */
705 if (syms[n].def == LDPK_UNDEF
706 || syms[n].def == LDPK_WEAKUNDEF
707 || syms[n].def == LDPK_COMMON)
709 if (owner_sec->owner == link_info.output_bfd)
710 res = LDPR_RESOLVED_EXEC;
711 else if (owner_sec->owner == abfd)
712 res = LDPR_PREVAILING_DEF_IRONLY;
713 else if (is_ir_dummy_bfd (owner_sec->owner))
714 res = LDPR_RESOLVED_IR;
715 else if (owner_sec->owner != NULL
716 && (owner_sec->owner->flags & DYNAMIC) != 0)
717 res = LDPR_RESOLVED_DYN;
719 res = LDPR_RESOLVED_EXEC;
722 /* Was originally def, or weakdef. Does it prevail? If the
723 owner is the original dummy bfd that supplied it, then this
724 is the definition that has prevailed. */
725 else if (owner_sec->owner == link_info.output_bfd)
726 res = LDPR_PREEMPTED_REG;
727 else if (owner_sec->owner == abfd)
728 res = LDPR_PREVAILING_DEF_IRONLY;
730 /* Was originally def, weakdef, or common, but has been pre-empted. */
731 else if (is_ir_dummy_bfd (owner_sec->owner))
732 res = LDPR_PREEMPTED_IR;
734 res = LDPR_PREEMPTED_REG;
736 if (res == LDPR_PREVAILING_DEF_IRONLY)
738 /* We need to know if the sym is referenced from non-IR files. Or
739 even potentially-referenced, perhaps in a future final link if
740 this is a partial one, perhaps dynamically at load-time if the
741 symbol is externally visible. */
742 if (blhe->non_ir_ref)
743 res = LDPR_PREVAILING_DEF;
744 else if (is_visible_from_outside (&syms[n], blhe))
745 res = def_ironly_exp;
749 syms[n].resolution = res;
750 if (report_plugin_symbols)
751 einfo (_("%P: %B: symbol `%s' "
752 "definition: %d, visibility: %d, resolution: %d\n"),
754 syms[n].def, syms[n].visibility, res);
759 static enum ld_plugin_status
760 get_symbols_v1 (const void *handle, int nsyms, struct ld_plugin_symbol *syms)
762 return get_symbols (handle, nsyms, syms, LDPR_PREVAILING_DEF);
765 static enum ld_plugin_status
766 get_symbols_v2 (const void *handle, int nsyms, struct ld_plugin_symbol *syms)
768 return get_symbols (handle, nsyms, syms, LDPR_PREVAILING_DEF_IRONLY_EXP);
771 /* Add a new (real) input file generated by a plugin. */
772 static enum ld_plugin_status
773 add_input_file (const char *pathname)
775 ASSERT (called_plugin);
776 if (!lang_add_input_file (xstrdup (pathname), lang_input_file_is_file_enum,
782 /* Add a new (real) library required by a plugin. */
783 static enum ld_plugin_status
784 add_input_library (const char *pathname)
786 ASSERT (called_plugin);
787 if (!lang_add_input_file (xstrdup (pathname), lang_input_file_is_l_enum,
793 /* Set the extra library path to be used by libraries added via
794 add_input_library. */
795 static enum ld_plugin_status
796 set_extra_library_path (const char *path)
798 ASSERT (called_plugin);
799 ldfile_add_library_path (xstrdup (path), FALSE);
803 /* Issue a diagnostic message from a plugin. */
804 static enum ld_plugin_status
805 message (int level, const char *format, ...)
808 va_start (args, format);
813 vfinfo (stdout, format, args, FALSE);
817 vfinfo (stdout, format, args, TRUE);
824 char *newfmt = ACONCAT ((level == LDPL_FATAL ? "%P%F: " : "%P%X: ",
825 format, "\n", (const char *) NULL));
827 vfinfo (stderr, newfmt, args, TRUE);
837 /* Helper to size leading part of tv array and set it up. */
839 set_tv_header (struct ld_plugin_tv *tv)
844 static const unsigned int major = (unsigned)(BFD_VERSION / 100000000UL);
845 static const unsigned int minor = (unsigned)(BFD_VERSION / 1000000UL) % 100;
847 for (i = 0; i < tv_header_size; i++)
849 tv[i].tv_tag = tv_header_tags[i];
850 #define TVU(x) tv[i].tv_u.tv_ ## x
851 switch (tv[i].tv_tag)
854 TVU(message) = message;
856 case LDPT_API_VERSION:
857 TVU(val) = LD_PLUGIN_API_VERSION;
859 case LDPT_GNU_LD_VERSION:
860 TVU(val) = major * 100 + minor;
862 case LDPT_LINKER_OUTPUT:
863 TVU(val) = (link_info.relocatable
865 : (link_info.executable
866 ? (link_info.pie ? LDPO_PIE : LDPO_EXEC)
869 case LDPT_OUTPUT_NAME:
870 TVU(string) = output_filename;
872 case LDPT_REGISTER_CLAIM_FILE_HOOK:
873 TVU(register_claim_file) = register_claim_file;
875 case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK:
876 TVU(register_all_symbols_read) = register_all_symbols_read;
878 case LDPT_REGISTER_CLEANUP_HOOK:
879 TVU(register_cleanup) = register_cleanup;
881 case LDPT_ADD_SYMBOLS:
882 TVU(add_symbols) = add_symbols;
884 case LDPT_GET_INPUT_FILE:
885 TVU(get_input_file) = get_input_file;
888 TVU(get_view) = get_view;
890 case LDPT_RELEASE_INPUT_FILE:
891 TVU(release_input_file) = release_input_file;
893 case LDPT_GET_SYMBOLS:
894 TVU(get_symbols) = get_symbols_v1;
896 case LDPT_GET_SYMBOLS_V2:
897 TVU(get_symbols) = get_symbols_v2;
899 case LDPT_ADD_INPUT_FILE:
900 TVU(add_input_file) = add_input_file;
902 case LDPT_ADD_INPUT_LIBRARY:
903 TVU(add_input_library) = add_input_library;
905 case LDPT_SET_EXTRA_LIBRARY_PATH:
906 TVU(set_extra_library_path) = set_extra_library_path;
909 /* Added a new entry to the array without adding
910 a new case to set up its value is a bug. */
917 /* Append the per-plugin args list and trailing LDPT_NULL to tv. */
919 set_tv_plugin_args (plugin_t *plugin, struct ld_plugin_tv *tv)
921 plugin_arg_t *arg = plugin->args;
924 tv->tv_tag = LDPT_OPTION;
925 tv->tv_u.tv_string = arg->arg;
929 tv->tv_tag = LDPT_NULL;
933 /* Load up and initialise all plugins after argument parsing. */
935 plugin_load_plugins (void)
937 struct ld_plugin_tv *my_tv;
938 unsigned int max_args = 0;
939 plugin_t *curplug = plugins_list;
941 /* If there are no plugins, we need do nothing this run. */
945 /* First pass over plugins to find max # args needed so that we
946 can size and allocate the tv array. */
949 if (curplug->n_args > max_args)
950 max_args = curplug->n_args;
951 curplug = curplug->next;
954 /* Allocate tv array and initialise constant part. */
955 my_tv = xmalloc ((max_args + 1 + tv_header_size) * sizeof *my_tv);
956 set_tv_header (my_tv);
958 /* Pass over plugins again, activating them. */
959 curplug = plugins_list;
962 enum ld_plugin_status rv;
963 ld_plugin_onload onloadfn;
965 onloadfn = (ld_plugin_onload) dlsym (curplug->dlhandle, "onload");
967 onloadfn = (ld_plugin_onload) dlsym (curplug->dlhandle, "_onload");
969 einfo (_("%P%F: %s: error loading plugin: %s\n"),
970 curplug->name, dlerror ());
971 set_tv_plugin_args (curplug, &my_tv[tv_header_size]);
972 called_plugin = curplug;
973 rv = (*onloadfn) (my_tv);
974 called_plugin = NULL;
976 einfo (_("%P%F: %s: plugin error: %d\n"), curplug->name, rv);
977 curplug = curplug->next;
980 /* Since plugin(s) inited ok, assume they're going to want symbol
981 resolutions, which needs us to track which symbols are referenced
982 by non-IR files using the linker's notice callback. */
983 orig_notice_all = link_info.notice_all;
984 orig_callbacks = link_info.callbacks;
985 plugin_callbacks = *orig_callbacks;
986 plugin_callbacks.notice = &plugin_notice;
987 link_info.notice_all = TRUE;
988 link_info.lto_plugin_active = TRUE;
989 link_info.callbacks = &plugin_callbacks;
991 register_ld_plugin_object_p (plugin_object_p);
993 #if HAVE_MMAP && HAVE_GETPAGESIZE
994 plugin_pagesize = getpagesize ();;
998 /* Call 'claim file' hook for all plugins. */
1000 plugin_call_claim_file (const struct ld_plugin_input_file *file, int *claimed)
1002 plugin_t *curplug = plugins_list;
1004 if (no_more_claiming)
1006 while (curplug && !*claimed)
1008 if (curplug->claim_file_handler)
1010 enum ld_plugin_status rv;
1011 called_plugin = curplug;
1012 rv = (*curplug->claim_file_handler) (file, claimed);
1013 called_plugin = NULL;
1015 set_plugin_error (curplug->name);
1017 curplug = curplug->next;
1019 return plugin_error_p () ? -1 : 0;
1022 /* Duplicates a character string with memory attached to ABFD. */
1025 plugin_strdup (bfd *abfd, const char *str)
1029 strlength = strlen (str) + 1;
1030 copy = bfd_alloc (abfd, strlength);
1032 einfo (_("%P%F: plugin_strdup failed to allocate memory: %s\n"),
1034 memcpy (copy, str, strlength);
1038 static const bfd_target *
1039 plugin_object_p (bfd *ibfd)
1042 plugin_input_file_t *input;
1043 off_t offset, filesize;
1044 struct ld_plugin_input_file file;
1046 bfd_boolean inarchive;
1050 /* Don't try the dummy object file. */
1051 if ((ibfd->flags & BFD_PLUGIN) != 0)
1054 if (ibfd->plugin_format != bfd_plugin_uknown)
1056 if (ibfd->plugin_format == bfd_plugin_yes)
1057 return ibfd->plugin_dummy_bfd->xvec;
1062 inarchive = bfd_my_archive (ibfd) != NULL;
1063 name = inarchive ? bfd_my_archive (ibfd)->filename : ibfd->filename;
1064 fd = open (name, O_RDONLY | O_BINARY);
1069 /* We create a dummy BFD, initially empty, to house whatever symbols
1070 the plugin may want to add. */
1071 abfd = plugin_get_ir_dummy_bfd (ibfd->filename, ibfd);
1073 input = bfd_alloc (abfd, sizeof (*input));
1075 einfo (_("%P%F: plugin failed to allocate memory for input: %s\n"),
1080 /* Offset and filesize must refer to the individual archive
1081 member, not the whole file, and must exclude the header.
1082 Fortunately for us, that is how the data is stored in the
1083 origin field of the bfd and in the arelt_data. */
1084 offset = ibfd->origin;
1085 filesize = arelt_size (ibfd);
1090 filesize = lseek (fd, 0, SEEK_END);
1092 /* We must copy filename attached to ibfd if it is not an archive
1093 member since it may be freed by bfd_close below. */
1094 name = plugin_strdup (abfd, name);
1098 file.offset = offset;
1099 file.filesize = filesize;
1101 file.handle = input;
1104 input->view_buffer.addr = NULL;
1105 input->view_buffer.filesize = 0;
1106 input->view_buffer.offset = 0;
1108 input->use_mmap = FALSE;
1109 input->offset = offset;
1110 input->filesize = filesize;
1111 input->name = plugin_strdup (abfd, ibfd->filename);
1115 if (plugin_call_claim_file (&file, &claimed))
1116 einfo (_("%P%F: %s: plugin reported error claiming file\n"),
1117 plugin_error_plugin ());
1119 if (input->fd != -1 && ! bfd_plugin_target_p (ibfd->xvec))
1121 /* FIXME: fd belongs to us, not the plugin. GCC plugin, which
1122 doesn't need fd after plugin_call_claim_file, doesn't use
1123 BFD plugin target vector. Since GCC plugin doesn't call
1124 release_input_file, we close it here. LLVM plugin, which
1125 needs fd after plugin_call_claim_file and calls
1126 release_input_file after it is done, uses BFD plugin target
1127 vector. This scheme doesn't work when a plugin needs fd and
1128 doesn't use BFD plugin target vector neither. */
1135 ibfd->plugin_format = bfd_plugin_yes;
1136 ibfd->plugin_dummy_bfd = abfd;
1137 bfd_make_readable (abfd);
1143 if (input->use_mmap)
1145 /* If plugin didn't claim the file, unmap the buffer. */
1146 char *addr = input->view_buffer.addr;
1147 off_t size = input->view_buffer.filesize;
1148 # if HAVE_GETPAGESIZE
1149 off_t bias = input->view_buffer.offset % plugin_pagesize;
1153 munmap (addr, size);
1157 /* If plugin didn't claim the file, we don't need the dummy bfd.
1158 Can't avoid speculatively creating it, alas. */
1159 ibfd->plugin_format = bfd_plugin_no;
1160 bfd_close_all_done (abfd);
1166 plugin_maybe_claim (lang_input_statement_type *entry)
1168 if (plugin_object_p (entry->the_bfd))
1170 bfd *abfd = entry->the_bfd->plugin_dummy_bfd;
1172 /* Discard the real file's BFD and substitute the dummy one. */
1174 /* BFD archive handling caches elements so we can't call
1175 bfd_close for archives. */
1176 if (entry->the_bfd->my_archive == NULL)
1177 bfd_close (entry->the_bfd);
1178 entry->the_bfd = abfd;
1179 entry->flags.claimed = 1;
1183 /* Call 'all symbols read' hook for all plugins. */
1185 plugin_call_all_symbols_read (void)
1187 plugin_t *curplug = plugins_list;
1189 /* Disable any further file-claiming. */
1190 no_more_claiming = TRUE;
1194 if (curplug->all_symbols_read_handler)
1196 enum ld_plugin_status rv;
1197 called_plugin = curplug;
1198 rv = (*curplug->all_symbols_read_handler) ();
1199 called_plugin = NULL;
1201 set_plugin_error (curplug->name);
1203 curplug = curplug->next;
1205 return plugin_error_p () ? -1 : 0;
1208 /* Call 'cleanup' hook for all plugins at exit. */
1210 plugin_call_cleanup (void)
1212 plugin_t *curplug = plugins_list;
1215 if (curplug->cleanup_handler && !curplug->cleanup_done)
1217 enum ld_plugin_status rv;
1218 curplug->cleanup_done = TRUE;
1219 called_plugin = curplug;
1220 rv = (*curplug->cleanup_handler) ();
1221 called_plugin = NULL;
1223 info_msg (_("%P: %s: error in plugin cleanup: %d (ignored)\n"),
1225 dlclose (curplug->dlhandle);
1227 curplug = curplug->next;
1231 /* To determine which symbols should be resolved LDPR_PREVAILING_DEF
1232 and which LDPR_PREVAILING_DEF_IRONLY, we notice all the symbols as
1233 the linker adds them to the linker hash table. Mark those
1234 referenced from a non-IR file with non_ir_ref. We have to
1235 notice_all symbols, because we won't necessarily know until later
1236 which ones will be contributed by IR files. */
1238 plugin_notice (struct bfd_link_info *info,
1239 struct bfd_link_hash_entry *h,
1240 struct bfd_link_hash_entry *inh,
1246 struct bfd_link_hash_entry *orig_h = h;
1252 if (h->type == bfd_link_hash_warning)
1255 /* Nothing to do here if this def/ref is from an IR dummy BFD. */
1256 if (is_ir_dummy_bfd (abfd))
1259 /* Making an indirect symbol counts as a reference unless this
1260 is a brand new symbol. */
1261 else if (bfd_is_ind_section (section)
1262 || (flags & BSF_INDIRECT) != 0)
1264 /* ??? Some of this is questionable. See comments in
1265 _bfd_generic_link_add_one_symbol for case IND. */
1266 if (h->type != bfd_link_hash_new)
1268 h->non_ir_ref = TRUE;
1269 inh->non_ir_ref = TRUE;
1271 else if (inh->type == bfd_link_hash_new)
1272 inh->non_ir_ref = TRUE;
1275 /* Nothing to do here for warning symbols. */
1276 else if ((flags & BSF_WARNING) != 0)
1279 /* Nothing to do here for constructor symbols. */
1280 else if ((flags & BSF_CONSTRUCTOR) != 0)
1283 /* If this is a ref, set non_ir_ref. */
1284 else if (bfd_is_und_section (section))
1286 /* Replace the undefined dummy bfd with the real one. */
1287 if ((h->type == bfd_link_hash_undefined
1288 || h->type == bfd_link_hash_undefweak)
1289 && (h->u.undef.abfd == NULL
1290 || (h->u.undef.abfd->flags & BFD_PLUGIN) != 0))
1291 h->u.undef.abfd = abfd;
1292 h->non_ir_ref = TRUE;
1295 /* Otherwise, it must be a new def. Ensure any symbol defined
1296 in an IR dummy BFD takes on a new value from a real BFD.
1297 Weak symbols are not normally overridden by a new weak
1298 definition, and strong symbols will normally cause multiple
1299 definition errors. Avoid this by making the symbol appear
1301 else if (((h->type == bfd_link_hash_defweak
1302 || h->type == bfd_link_hash_defined)
1303 && is_ir_dummy_bfd (sym_bfd = h->u.def.section->owner))
1304 || (h->type == bfd_link_hash_common
1305 && is_ir_dummy_bfd (sym_bfd = h->u.c.p->section->owner)))
1307 h->type = bfd_link_hash_undefweak;
1308 h->u.undef.abfd = sym_bfd;
1312 /* Continue with cref/nocrossref/trace-sym processing. */
1315 || (info->notice_hash != NULL
1316 && bfd_hash_lookup (info->notice_hash, orig_h->root.string,
1317 FALSE, FALSE) != NULL))
1318 return (*orig_callbacks->notice) (info, orig_h, inh,
1319 abfd, section, value, flags);