Step over fork/vfork syscall insn in gdbserver
[external/binutils.git] / ld / plugin.c
1 /* Plugin control for the GNU linker.
2    Copyright (C) 2010-2016 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 "libbfd.h"
25 #include "bfdlink.h"
26 #include "bfdver.h"
27 #include "ld.h"
28 #include "ldmain.h"
29 #include "ldmisc.h"
30 #include "ldexp.h"
31 #include "ldlang.h"
32 #include "ldfile.h"
33 #include "../bfd/plugin.h"
34 #include "plugin.h"
35 #include "plugin-api.h"
36 #include "elf-bfd.h"
37 #if HAVE_MMAP
38 # include <sys/mman.h>
39 # ifndef MAP_FAILED
40 #  define MAP_FAILED ((void *) -1)
41 # endif
42 # ifndef PROT_READ
43 #  define PROT_READ 0
44 # endif
45 # ifndef MAP_PRIVATE
46 #  define MAP_PRIVATE 0
47 # endif
48 #endif
49 #include <errno.h>
50 #if !(defined(errno) || defined(_MSC_VER) && defined(_INC_ERRNO))
51 extern int errno;
52 #endif
53 #if !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)
54 #include <windows.h>
55 #endif
56
57 /* Report plugin symbols.  */
58 bfd_boolean report_plugin_symbols;
59
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)"
64
65 /* Stores a single argument passed to a plugin.  */
66 typedef struct plugin_arg
67 {
68   struct plugin_arg *next;
69   const char *arg;
70 } plugin_arg_t;
71
72 /* Holds all details of a single plugin.  */
73 typedef struct plugin
74 {
75   /* Next on the list of plugins, or NULL at end of chain.  */
76   struct plugin *next;
77   /* The argument string given to --plugin.  */
78   const char *name;
79   /* The shared library handle returned by dlopen.  */
80   void *dlhandle;
81   /* The list of argument string given to --plugin-opt.  */
82   plugin_arg_t *args;
83   /* Number of args in the list, for convenience.  */
84   size_t n_args;
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;
91 } plugin_t;
92
93 typedef struct view_buffer
94 {
95   char *addr;
96   size_t filesize;
97   off_t offset;
98 } view_buffer_t;
99
100 /* The internal version of struct ld_plugin_input_file with a BFD
101    pointer.  */
102 typedef struct plugin_input_file
103 {
104   bfd *abfd;
105   view_buffer_t view_buffer;
106   char *name;
107   int fd;
108   bfd_boolean use_mmap;
109   off_t offset;
110   off_t filesize;
111 } plugin_input_file_t;
112
113 /* The master list of all plugins.  */
114 static plugin_t *plugins_list = NULL;
115
116 /* We keep a tail pointer for easy linking on the end.  */
117 static plugin_t **plugins_tail_chain_ptr = &plugins_list;
118
119 /* The last plugin added to the list, for receiving args.  */
120 static plugin_t *last_plugin = NULL;
121
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;
124
125 /* The plugin which is currently having a callback executed.  */
126 static plugin_t *called_plugin = NULL;
127
128 /* Last plugin to cause an error, if any.  */
129 static const char *error_plugin = NULL;
130
131 /* State of linker "notice" interface before we poked at it.  */
132 static bfd_boolean orig_notice_all;
133
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;
137
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;
141
142 #if HAVE_MMAP && HAVE_GETPAGESIZE
143 /* Page size used by mmap.  */
144 static off_t plugin_pagesize;
145 #endif
146
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[] =
149 {
150   LDPT_MESSAGE,
151   LDPT_API_VERSION,
152   LDPT_GNU_LD_VERSION,
153   LDPT_LINKER_OUTPUT,
154   LDPT_OUTPUT_NAME,
155   LDPT_REGISTER_CLAIM_FILE_HOOK,
156   LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK,
157   LDPT_REGISTER_CLEANUP_HOOK,
158   LDPT_ADD_SYMBOLS,
159   LDPT_GET_INPUT_FILE,
160   LDPT_GET_VIEW,
161   LDPT_RELEASE_INPUT_FILE,
162   LDPT_GET_SYMBOLS,
163   LDPT_GET_SYMBOLS_V2,
164   LDPT_ADD_INPUT_FILE,
165   LDPT_ADD_INPUT_LIBRARY,
166   LDPT_SET_EXTRA_LIBRARY_PATH
167 };
168
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);
171
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);
177
178 static const bfd_target * plugin_object_p (bfd *);
179
180 #if !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)
181
182 #define RTLD_NOW 0      /* Dummy value.  */
183
184 static void *
185 dlopen (const char *file, int mode ATTRIBUTE_UNUSED)
186 {
187   return LoadLibrary (file);
188 }
189
190 static void *
191 dlsym (void *handle, const char *name)
192 {
193   return GetProcAddress (handle, name);
194 }
195
196 static int
197 dlclose (void *handle)
198 {
199   FreeLibrary (handle);
200   return 0;
201 }
202
203 #endif /* !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)  */
204
205 #ifndef HAVE_DLFCN_H
206 static const char *
207 dlerror (void)
208 {
209   return "";
210 }
211 #endif
212
213 /* Helper function for exiting with error status.  */
214 static int
215 set_plugin_error (const char *plugin)
216 {
217   error_plugin = plugin;
218   return -1;
219 }
220
221 /* Test if an error occurred.  */
222 static bfd_boolean
223 plugin_error_p (void)
224 {
225   return error_plugin != NULL;
226 }
227
228 /* Return name of plugin which caused an error if any.  */
229 const char *
230 plugin_error_plugin (void)
231 {
232   return error_plugin ? error_plugin : _("<no plugin>");
233 }
234
235 /* Handle -plugin arg: find and load plugin, or return error.  */
236 void
237 plugin_opt_plugin (const char *plugin)
238 {
239   plugin_t *newplug;
240
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 ());
247
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;
251
252   /* Record it as current plugin for receiving args.  */
253   last_plugin = newplug;
254   last_plugin_args_tail_chain_ptr = &newplug->args;
255 }
256
257 /* Accumulate option arguments for last-loaded plugin, or return
258    error if none.  */
259 int
260 plugin_opt_plugin_arg (const char *arg)
261 {
262   plugin_arg_t *newarg;
263
264   if (!last_plugin)
265     return set_plugin_error (_("<no plugin>"));
266
267   /* Ignore -pass-through= from GCC driver.  */
268   if (*arg == '-')
269     {
270       const char *p = arg + 1;
271
272       if (*p == '-')
273         ++p;
274       if (strncmp (p, "pass-through=", 13) == 0)
275         return 0;
276     }
277
278   newarg = xmalloc (sizeof *newarg);
279   newarg->arg = arg;
280   newarg->next = NULL;
281
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++;
286   return 0;
287 }
288
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.  */
294 static bfd *
295 plugin_get_ir_dummy_bfd (const char *name, bfd *srctemplate)
296 {
297   bfd *abfd;
298   bfd_boolean bfd_plugin_target;
299
300   bfd_use_reserved_id = 1;
301   bfd_plugin_target = bfd_plugin_target_p (srctemplate->xvec);
302   abfd = bfd_create (concat (name, IRONLY_SUFFIX, (const char *) NULL),
303                      bfd_plugin_target ? link_info.output_bfd : srctemplate);
304   if (abfd != NULL)
305     {
306       abfd->flags |= BFD_LINKER_CREATED | BFD_PLUGIN;
307       if (!bfd_make_writable (abfd))
308         goto report_error;
309       if (!bfd_plugin_target)
310         {
311           bfd_set_arch_info (abfd, bfd_get_arch_info (srctemplate));
312           bfd_set_gp_size (abfd, bfd_get_gp_size (srctemplate));
313           if (!bfd_copy_private_bfd_data (srctemplate, abfd))
314             goto report_error;
315         }
316         {
317           flagword flags;
318
319           /* Create section to own the symbols.  */
320           flags = (SEC_CODE | SEC_HAS_CONTENTS | SEC_READONLY
321                    | SEC_ALLOC | SEC_LOAD | SEC_KEEP | SEC_EXCLUDE);
322           if (bfd_make_section_anyway_with_flags (abfd, ".text", flags))
323             return abfd;
324         }
325     }
326 report_error:
327   einfo (_("could not create dummy IR bfd: %F%E\n"));
328   return NULL;
329 }
330
331 /* Check if the BFD passed in is an IR dummy object file.  */
332 static inline bfd_boolean
333 is_ir_dummy_bfd (const bfd *abfd)
334 {
335   /* ABFD can sometimes legitimately be NULL, e.g. when called from one
336      of the linker callbacks for a symbol in the *ABS* or *UND* sections.  */
337   return abfd != NULL && (abfd->flags & BFD_PLUGIN) != 0;
338 }
339
340 /* Helpers to convert between BFD and GOLD symbol formats.  */
341 static enum ld_plugin_status
342 asymbol_from_plugin_symbol (bfd *abfd, asymbol *asym,
343                             const struct ld_plugin_symbol *ldsym)
344 {
345   flagword flags = BSF_NO_FLAGS;
346   struct bfd_section *section;
347
348   asym->the_bfd = abfd;
349   asym->name = (ldsym->version
350                 ? concat (ldsym->name, "@", ldsym->version, (const char *) NULL)
351                 : ldsym->name);
352   asym->value = 0;
353   switch (ldsym->def)
354     {
355     case LDPK_WEAKDEF:
356       flags = BSF_WEAK;
357       /* FALLTHRU */
358     case LDPK_DEF:
359       flags |= BSF_GLOBAL;
360       if (ldsym->comdat_key)
361         {
362           char *name = concat (".gnu.linkonce.t.", ldsym->comdat_key,
363                                (const char *) NULL);
364           section = bfd_get_section_by_name (abfd, name);
365           if (section != NULL)
366             free (name);
367           else
368             {
369               flagword sflags;
370
371               sflags = (SEC_CODE | SEC_HAS_CONTENTS | SEC_READONLY
372                         | SEC_ALLOC | SEC_LOAD | SEC_KEEP | SEC_EXCLUDE
373                         | SEC_LINK_ONCE | SEC_LINK_DUPLICATES_DISCARD);
374               section = bfd_make_section_anyway_with_flags (abfd, name, sflags);
375               if (section == NULL)
376                 return LDPS_ERR;
377             }
378         }
379       else
380         section = bfd_get_section_by_name (abfd, ".text");
381       break;
382
383     case LDPK_WEAKUNDEF:
384       flags = BSF_WEAK;
385       /* FALLTHRU */
386     case LDPK_UNDEF:
387       section = bfd_und_section_ptr;
388       break;
389
390     case LDPK_COMMON:
391       flags = BSF_GLOBAL;
392       section = bfd_com_section_ptr;
393       asym->value = ldsym->size;
394       /* For ELF targets, set alignment of common symbol to 1.  */
395       if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
396         {
397           ((elf_symbol_type *) asym)->internal_elf_sym.st_shndx = SHN_COMMON;
398           ((elf_symbol_type *) asym)->internal_elf_sym.st_value = 1;
399         }
400       break;
401
402     default:
403       return LDPS_ERR;
404     }
405   asym->flags = flags;
406   asym->section = section;
407
408   /* Visibility only applies on ELF targets.  */
409   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
410     {
411       elf_symbol_type *elfsym = elf_symbol_from (abfd, asym);
412       unsigned char visibility;
413
414       if (!elfsym)
415         einfo (_("%P%F: %s: non-ELF symbol in ELF BFD!\n"), asym->name);
416       switch (ldsym->visibility)
417         {
418         default:
419           einfo (_("%P%F: unknown ELF symbol visibility: %d!\n"),
420                  ldsym->visibility);
421         case LDPV_DEFAULT:
422           visibility = STV_DEFAULT;
423           break;
424         case LDPV_PROTECTED:
425           visibility = STV_PROTECTED;
426           break;
427         case LDPV_INTERNAL:
428           visibility = STV_INTERNAL;
429           break;
430         case LDPV_HIDDEN:
431           visibility = STV_HIDDEN;
432           break;
433         }
434       elfsym->internal_elf_sym.st_other
435         = (visibility | (elfsym->internal_elf_sym.st_other
436                          & ~ELF_ST_VISIBILITY (-1)));
437     }
438
439   return LDPS_OK;
440 }
441
442 /* Register a claim-file handler.  */
443 static enum ld_plugin_status
444 register_claim_file (ld_plugin_claim_file_handler handler)
445 {
446   ASSERT (called_plugin);
447   called_plugin->claim_file_handler = handler;
448   return LDPS_OK;
449 }
450
451 /* Register an all-symbols-read handler.  */
452 static enum ld_plugin_status
453 register_all_symbols_read (ld_plugin_all_symbols_read_handler handler)
454 {
455   ASSERT (called_plugin);
456   called_plugin->all_symbols_read_handler = handler;
457   return LDPS_OK;
458 }
459
460 /* Register a cleanup handler.  */
461 static enum ld_plugin_status
462 register_cleanup (ld_plugin_cleanup_handler handler)
463 {
464   ASSERT (called_plugin);
465   called_plugin->cleanup_handler = handler;
466   return LDPS_OK;
467 }
468
469 /* Add symbols from a plugin-claimed input file.  */
470 static enum ld_plugin_status
471 add_symbols (void *handle, int nsyms, const struct ld_plugin_symbol *syms)
472 {
473   asymbol **symptrs;
474   plugin_input_file_t *input = handle;
475   bfd *abfd = input->abfd;
476   int n;
477
478   ASSERT (called_plugin);
479   symptrs = xmalloc (nsyms * sizeof *symptrs);
480   for (n = 0; n < nsyms; n++)
481     {
482       enum ld_plugin_status rv;
483       asymbol *bfdsym;
484
485       bfdsym = bfd_make_empty_symbol (abfd);
486       symptrs[n] = bfdsym;
487       rv = asymbol_from_plugin_symbol (abfd, bfdsym, syms + n);
488       if (rv != LDPS_OK)
489         return rv;
490     }
491   bfd_set_symtab (abfd, symptrs, nsyms);
492   return LDPS_OK;
493 }
494
495 /* Get the input file information with an open (possibly re-opened)
496    file descriptor.  */
497 static enum ld_plugin_status
498 get_input_file (const void *handle, struct ld_plugin_input_file *file)
499 {
500   const plugin_input_file_t *input = handle;
501
502   ASSERT (called_plugin);
503
504   file->name = input->name;
505   file->offset = input->offset;
506   file->filesize = input->filesize;
507   file->handle = (void *) handle;
508
509   return LDPS_OK;
510 }
511
512 /* Get view of the input file.  */
513 static enum ld_plugin_status
514 get_view (const void *handle, const void **viewp)
515 {
516   plugin_input_file_t *input = (plugin_input_file_t *) handle;
517   char *buffer;
518   size_t size = input->filesize;
519   off_t offset = input->offset;
520 #if HAVE_MMAP && HAVE_GETPAGESIZE
521   off_t bias;
522 #endif
523
524   ASSERT (called_plugin);
525
526   /* FIXME: einfo should support %lld.  */
527   if ((off_t) size != input->filesize)
528     einfo (_("%P%F: unsupported input file size: %s (%ld bytes)\n"),
529            input->name, (long) input->filesize);
530
531   /* Check the cached view buffer.  */
532   if (input->view_buffer.addr != NULL
533       && input->view_buffer.filesize == size
534       && input->view_buffer.offset == offset)
535     {
536       *viewp = input->view_buffer.addr;
537       return LDPS_OK;
538     }
539
540   input->view_buffer.filesize = size;
541   input->view_buffer.offset = offset;
542
543 #if HAVE_MMAP
544 # if HAVE_GETPAGESIZE
545   bias = offset % plugin_pagesize;
546   offset -= bias;
547   size += bias;
548 # endif
549   buffer = mmap (NULL, size, PROT_READ, MAP_PRIVATE, input->fd, offset);
550   if (buffer != MAP_FAILED)
551     {
552       input->use_mmap = TRUE;
553 # if HAVE_GETPAGESIZE
554       buffer += bias;
555 # endif
556     }
557   else
558 #endif
559     {
560       char *p;
561
562       input->use_mmap = FALSE;
563
564       if (lseek (input->fd, offset, SEEK_SET) < 0)
565         return LDPS_ERR;
566
567       buffer = bfd_alloc (input->abfd, size);
568       if (buffer == NULL)
569         return LDPS_ERR;
570
571       p = buffer;
572       do
573         {
574           ssize_t got = read (input->fd, p, size);
575           if (got == 0)
576             break;
577           else if (got > 0)
578             {
579               p += got;
580               size -= got;
581             }
582           else if (errno != EINTR)
583             return LDPS_ERR;
584         }
585       while (size > 0);
586     }
587
588   input->view_buffer.addr = buffer;
589   *viewp = buffer;
590
591   return LDPS_OK;
592 }
593
594 /* Release the input file.  */
595 static enum ld_plugin_status
596 release_input_file (const void *handle)
597 {
598   plugin_input_file_t *input = (plugin_input_file_t *) handle;
599   ASSERT (called_plugin);
600   if (input->fd != -1)
601     {
602       close (input->fd);
603       input->fd = -1;
604     }
605   return LDPS_OK;
606 }
607
608 /* Return TRUE if a defined symbol might be reachable from outside the
609    universe of claimed objects.  */
610 static inline bfd_boolean
611 is_visible_from_outside (struct ld_plugin_symbol *lsym,
612                          struct bfd_link_hash_entry *blhe)
613 {
614   struct bfd_sym_chain *sym;
615
616   if (bfd_link_relocatable (&link_info))
617     return TRUE;
618   if (link_info.export_dynamic || bfd_link_dll (&link_info))
619     {
620       /* Check if symbol is hidden by version script.  */
621       if (bfd_hide_sym_by_version (link_info.version_info,
622                                    blhe->root.string))
623         return FALSE;
624       /* Only ELF symbols really have visibility.  */
625       if (bfd_get_flavour (link_info.output_bfd) == bfd_target_elf_flavour)
626         {
627           struct elf_link_hash_entry *el = (struct elf_link_hash_entry *)blhe;
628           int vis = ELF_ST_VISIBILITY (el->other);
629           return vis == STV_DEFAULT || vis == STV_PROTECTED;
630         }
631       /* On non-ELF targets, we can safely make inferences by considering
632          what visibility the plugin would have liked to apply when it first
633          sent us the symbol.  During ELF symbol processing, visibility only
634          ever becomes more restrictive, not less, when symbols are merged,
635          so this is a conservative estimate; it may give false positives,
636          declaring something visible from outside when it in fact would
637          not have been, but this will only lead to missed optimisation
638          opportunities during LTRANS at worst; it will not give false
639          negatives, which can lead to the disastrous conclusion that the
640          related symbol is IRONLY.  (See GCC PR46319 for an example.)  */
641       return (lsym->visibility == LDPV_DEFAULT
642               || lsym->visibility == LDPV_PROTECTED);
643     }
644
645   for (sym = &entry_symbol; sym != NULL; sym = sym->next)
646     if (sym->name
647         && strcmp (sym->name, blhe->root.string) == 0)
648       return TRUE;
649
650   return FALSE;
651 }
652
653 /* Get the symbol resolution info for a plugin-claimed input file.  */
654 static enum ld_plugin_status
655 get_symbols (const void *handle, int nsyms, struct ld_plugin_symbol *syms,
656              int def_ironly_exp)
657 {
658   const plugin_input_file_t *input = handle;
659   const bfd *abfd = (const bfd *) input->abfd;
660   int n;
661
662   ASSERT (called_plugin);
663   for (n = 0; n < nsyms; n++)
664     {
665       struct bfd_link_hash_entry *blhe;
666       asection *owner_sec;
667       int res;
668
669       if (syms[n].def != LDPK_UNDEF)
670         blhe = bfd_link_hash_lookup (link_info.hash, syms[n].name,
671                                      FALSE, FALSE, TRUE);
672       else
673         blhe = bfd_wrapped_link_hash_lookup (link_info.output_bfd, &link_info,
674                                              syms[n].name, FALSE, FALSE, TRUE);
675       if (!blhe)
676         {
677           res = LDPR_UNKNOWN;
678           goto report_symbol;
679         }
680
681       /* Determine resolution from blhe type and symbol's original type.  */
682       if (blhe->type == bfd_link_hash_undefined
683           || blhe->type == bfd_link_hash_undefweak)
684         {
685           res = LDPR_UNDEF;
686           goto report_symbol;
687         }
688       if (blhe->type != bfd_link_hash_defined
689           && blhe->type != bfd_link_hash_defweak
690           && blhe->type != bfd_link_hash_common)
691         {
692           /* We should not have a new, indirect or warning symbol here.  */
693           einfo ("%P%F: %s: plugin symbol table corrupt (sym type %d)\n",
694                  called_plugin->name, blhe->type);
695         }
696
697       /* Find out which section owns the symbol.  Since it's not undef,
698          it must have an owner; if it's not a common symbol, both defs
699          and weakdefs keep it in the same place. */
700       owner_sec = (blhe->type == bfd_link_hash_common
701                    ? blhe->u.c.p->section
702                    : blhe->u.def.section);
703
704
705       /* If it was originally undefined or common, then it has been
706          resolved; determine how.  */
707       if (syms[n].def == LDPK_UNDEF
708           || syms[n].def == LDPK_WEAKUNDEF
709           || syms[n].def == LDPK_COMMON)
710         {
711           if (owner_sec->owner == link_info.output_bfd)
712             res = LDPR_RESOLVED_EXEC;
713           else if (owner_sec->owner == abfd)
714             res = LDPR_PREVAILING_DEF_IRONLY;
715           else if (is_ir_dummy_bfd (owner_sec->owner))
716             res = LDPR_RESOLVED_IR;
717           else if (owner_sec->owner != NULL
718                    && (owner_sec->owner->flags & DYNAMIC) != 0)
719             res = LDPR_RESOLVED_DYN;
720           else
721             res = LDPR_RESOLVED_EXEC;
722         }
723
724       /* Was originally def, or weakdef.  Does it prevail?  If the
725          owner is the original dummy bfd that supplied it, then this
726          is the definition that has prevailed.  */
727       else if (owner_sec->owner == link_info.output_bfd)
728         res = LDPR_PREEMPTED_REG;
729       else if (owner_sec->owner == abfd)
730         res = LDPR_PREVAILING_DEF_IRONLY;
731
732       /* Was originally def, weakdef, or common, but has been pre-empted.  */
733       else if (is_ir_dummy_bfd (owner_sec->owner))
734         res = LDPR_PREEMPTED_IR;
735       else
736         res = LDPR_PREEMPTED_REG;
737
738       if (res == LDPR_PREVAILING_DEF_IRONLY)
739         {
740           /* We need to know if the sym is referenced from non-IR files.  Or
741              even potentially-referenced, perhaps in a future final link if
742              this is a partial one, perhaps dynamically at load-time if the
743              symbol is externally visible.  */
744           if (blhe->non_ir_ref)
745             res = LDPR_PREVAILING_DEF;
746           else if (is_visible_from_outside (&syms[n], blhe))
747             res = def_ironly_exp;
748         }
749
750     report_symbol:
751       syms[n].resolution = res;
752       if (report_plugin_symbols)
753         einfo (_("%P: %B: symbol `%s' "
754                  "definition: %d, visibility: %d, resolution: %d\n"),
755                abfd, syms[n].name,
756                syms[n].def, syms[n].visibility, res);
757     }
758   return LDPS_OK;
759 }
760
761 static enum ld_plugin_status
762 get_symbols_v1 (const void *handle, int nsyms, struct ld_plugin_symbol *syms)
763 {
764   return get_symbols (handle, nsyms, syms, LDPR_PREVAILING_DEF);
765 }
766
767 static enum ld_plugin_status
768 get_symbols_v2 (const void *handle, int nsyms, struct ld_plugin_symbol *syms)
769 {
770   return get_symbols (handle, nsyms, syms, LDPR_PREVAILING_DEF_IRONLY_EXP);
771 }
772
773 /* Add a new (real) input file generated by a plugin.  */
774 static enum ld_plugin_status
775 add_input_file (const char *pathname)
776 {
777   lang_input_statement_type *is;
778
779   ASSERT (called_plugin);
780   is = lang_add_input_file (xstrdup (pathname), lang_input_file_is_file_enum,
781                             NULL);
782   if (!is)
783     return LDPS_ERR;
784   is->flags.lto_output = 1;
785   return LDPS_OK;
786 }
787
788 /* Add a new (real) library required by a plugin.  */
789 static enum ld_plugin_status
790 add_input_library (const char *pathname)
791 {
792   lang_input_statement_type *is;
793
794   ASSERT (called_plugin);
795   is = lang_add_input_file (xstrdup (pathname), lang_input_file_is_l_enum,
796                             NULL);
797   if (!is)
798     return LDPS_ERR;
799   is->flags.lto_output = 1;
800   return LDPS_OK;
801 }
802
803 /* Set the extra library path to be used by libraries added via
804    add_input_library.  */
805 static enum ld_plugin_status
806 set_extra_library_path (const char *path)
807 {
808   ASSERT (called_plugin);
809   ldfile_add_library_path (xstrdup (path), FALSE);
810   return LDPS_OK;
811 }
812
813 /* Issue a diagnostic message from a plugin.  */
814 static enum ld_plugin_status
815 message (int level, const char *format, ...)
816 {
817   va_list args;
818   va_start (args, format);
819
820   switch (level)
821     {
822     case LDPL_INFO:
823       vfinfo (stdout, format, args, FALSE);
824       putchar ('\n');
825       break;
826     case LDPL_WARNING:
827       {
828         char *newfmt = ACONCAT (("%P: warning: ", format, "\n",
829                                  (const char *) NULL));
830         vfinfo (stdout, newfmt, args, TRUE);
831       }
832       break;
833     case LDPL_FATAL:
834     case LDPL_ERROR:
835     default:
836       {
837         char *newfmt = ACONCAT ((level == LDPL_FATAL ? "%P%F" : "%P%X",
838                                  ": error: ", format, "\n",
839                                  (const char *) NULL));
840         fflush (stdout);
841         vfinfo (stderr, newfmt, args, TRUE);
842         fflush (stderr);
843       }
844       break;
845     }
846
847   va_end (args);
848   return LDPS_OK;
849 }
850
851 /* Helper to size leading part of tv array and set it up. */
852 static void
853 set_tv_header (struct ld_plugin_tv *tv)
854 {
855   size_t i;
856
857   /* Version info.  */
858   static const unsigned int major = (unsigned)(BFD_VERSION / 100000000UL);
859   static const unsigned int minor = (unsigned)(BFD_VERSION / 1000000UL) % 100;
860
861   for (i = 0; i < tv_header_size; i++)
862     {
863       tv[i].tv_tag = tv_header_tags[i];
864 #define TVU(x) tv[i].tv_u.tv_ ## x
865       switch (tv[i].tv_tag)
866         {
867         case LDPT_MESSAGE:
868           TVU(message) = message;
869           break;
870         case LDPT_API_VERSION:
871           TVU(val) = LD_PLUGIN_API_VERSION;
872           break;
873         case LDPT_GNU_LD_VERSION:
874           TVU(val) = major * 100 + minor;
875           break;
876         case LDPT_LINKER_OUTPUT:
877           TVU(val) = (bfd_link_relocatable (&link_info) ? LDPO_REL
878                       : bfd_link_pde (&link_info) ? LDPO_EXEC
879                       : bfd_link_pie (&link_info) ? LDPO_PIE
880                       : LDPO_DYN);
881           break;
882         case LDPT_OUTPUT_NAME:
883           TVU(string) = output_filename;
884           break;
885         case LDPT_REGISTER_CLAIM_FILE_HOOK:
886           TVU(register_claim_file) = register_claim_file;
887           break;
888         case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK:
889           TVU(register_all_symbols_read) = register_all_symbols_read;
890           break;
891         case LDPT_REGISTER_CLEANUP_HOOK:
892           TVU(register_cleanup) = register_cleanup;
893           break;
894         case LDPT_ADD_SYMBOLS:
895           TVU(add_symbols) = add_symbols;
896           break;
897         case LDPT_GET_INPUT_FILE:
898           TVU(get_input_file) = get_input_file;
899           break;
900         case LDPT_GET_VIEW:
901           TVU(get_view) = get_view;
902           break;
903         case LDPT_RELEASE_INPUT_FILE:
904           TVU(release_input_file) = release_input_file;
905           break;
906         case LDPT_GET_SYMBOLS:
907           TVU(get_symbols) = get_symbols_v1;
908           break;
909         case LDPT_GET_SYMBOLS_V2:
910           TVU(get_symbols) = get_symbols_v2;
911           break;
912         case LDPT_ADD_INPUT_FILE:
913           TVU(add_input_file) = add_input_file;
914           break;
915         case LDPT_ADD_INPUT_LIBRARY:
916           TVU(add_input_library) = add_input_library;
917           break;
918         case LDPT_SET_EXTRA_LIBRARY_PATH:
919           TVU(set_extra_library_path) = set_extra_library_path;
920           break;
921         default:
922           /* Added a new entry to the array without adding
923              a new case to set up its value is a bug.  */
924           FAIL ();
925         }
926 #undef TVU
927     }
928 }
929
930 /* Append the per-plugin args list and trailing LDPT_NULL to tv.  */
931 static void
932 set_tv_plugin_args (plugin_t *plugin, struct ld_plugin_tv *tv)
933 {
934   plugin_arg_t *arg = plugin->args;
935   while (arg)
936     {
937       tv->tv_tag = LDPT_OPTION;
938       tv->tv_u.tv_string = arg->arg;
939       arg = arg->next;
940       tv++;
941     }
942   tv->tv_tag = LDPT_NULL;
943   tv->tv_u.tv_val = 0;
944 }
945
946 /* Load up and initialise all plugins after argument parsing.  */
947 void
948 plugin_load_plugins (void)
949 {
950   struct ld_plugin_tv *my_tv;
951   unsigned int max_args = 0;
952   plugin_t *curplug = plugins_list;
953
954   /* If there are no plugins, we need do nothing this run.  */
955   if (!curplug)
956     return;
957
958   /* First pass over plugins to find max # args needed so that we
959      can size and allocate the tv array.  */
960   while (curplug)
961     {
962       if (curplug->n_args > max_args)
963         max_args = curplug->n_args;
964       curplug = curplug->next;
965     }
966
967   /* Allocate tv array and initialise constant part.  */
968   my_tv = xmalloc ((max_args + 1 + tv_header_size) * sizeof *my_tv);
969   set_tv_header (my_tv);
970
971   /* Pass over plugins again, activating them.  */
972   curplug = plugins_list;
973   while (curplug)
974     {
975       enum ld_plugin_status rv;
976       ld_plugin_onload onloadfn;
977
978       onloadfn = (ld_plugin_onload) dlsym (curplug->dlhandle, "onload");
979       if (!onloadfn)
980         onloadfn = (ld_plugin_onload) dlsym (curplug->dlhandle, "_onload");
981       if (!onloadfn)
982         einfo (_("%P%F: %s: error loading plugin: %s\n"),
983                curplug->name, dlerror ());
984       set_tv_plugin_args (curplug, &my_tv[tv_header_size]);
985       called_plugin = curplug;
986       rv = (*onloadfn) (my_tv);
987       called_plugin = NULL;
988       if (rv != LDPS_OK)
989         einfo (_("%P%F: %s: plugin error: %d\n"), curplug->name, rv);
990       curplug = curplug->next;
991     }
992
993   /* Since plugin(s) inited ok, assume they're going to want symbol
994      resolutions, which needs us to track which symbols are referenced
995      by non-IR files using the linker's notice callback.  */
996   orig_notice_all = link_info.notice_all;
997   orig_callbacks = link_info.callbacks;
998   plugin_callbacks = *orig_callbacks;
999   plugin_callbacks.notice = &plugin_notice;
1000   link_info.notice_all = TRUE;
1001   link_info.lto_plugin_active = TRUE;
1002   link_info.callbacks = &plugin_callbacks;
1003
1004   register_ld_plugin_object_p (plugin_object_p);
1005
1006 #if HAVE_MMAP && HAVE_GETPAGESIZE
1007   plugin_pagesize = getpagesize ();
1008 #endif
1009 }
1010
1011 /* Call 'claim file' hook for all plugins.  */
1012 static int
1013 plugin_call_claim_file (const struct ld_plugin_input_file *file, int *claimed)
1014 {
1015   plugin_t *curplug = plugins_list;
1016   *claimed = FALSE;
1017   if (no_more_claiming)
1018     return 0;
1019   while (curplug && !*claimed)
1020     {
1021       if (curplug->claim_file_handler)
1022         {
1023           enum ld_plugin_status rv;
1024           called_plugin = curplug;
1025           rv = (*curplug->claim_file_handler) (file, claimed);
1026           called_plugin = NULL;
1027           if (rv != LDPS_OK)
1028             set_plugin_error (curplug->name);
1029         }
1030       curplug = curplug->next;
1031     }
1032   return plugin_error_p () ? -1 : 0;
1033 }
1034
1035 /* Duplicates a character string with memory attached to ABFD.  */
1036
1037 static char *
1038 plugin_strdup (bfd *abfd, const char *str)
1039 {
1040   size_t strlength;
1041   char *copy;
1042   strlength = strlen (str) + 1;
1043   copy = bfd_alloc (abfd, strlength);
1044   if (copy == NULL)
1045     einfo (_("%P%F: plugin_strdup failed to allocate memory: %s\n"),
1046            bfd_get_error ());
1047   memcpy (copy, str, strlength);
1048   return copy;
1049 }
1050
1051 static const bfd_target *
1052 plugin_object_p (bfd *ibfd)
1053 {
1054   int claimed;
1055   plugin_input_file_t *input;
1056   off_t offset, filesize;
1057   struct ld_plugin_input_file file;
1058   bfd *abfd;
1059   bfd_boolean inarchive;
1060   const char *name;
1061   int fd;
1062
1063   /* Don't try the dummy object file.  */
1064   if ((ibfd->flags & BFD_PLUGIN) != 0)
1065     return NULL;
1066
1067   if (ibfd->plugin_format != bfd_plugin_uknown)
1068     {
1069       if (ibfd->plugin_format == bfd_plugin_yes)
1070         return ibfd->plugin_dummy_bfd->xvec;
1071       else
1072         return NULL;
1073     }
1074
1075   inarchive = bfd_my_archive (ibfd) != NULL;
1076   name = inarchive ? bfd_my_archive (ibfd)->filename : ibfd->filename;
1077   fd = open (name, O_RDONLY | O_BINARY);
1078
1079   if (fd < 0)
1080     return NULL;
1081
1082   /* We create a dummy BFD, initially empty, to house whatever symbols
1083      the plugin may want to add.  */
1084   abfd = plugin_get_ir_dummy_bfd (ibfd->filename, ibfd);
1085
1086   input = bfd_alloc (abfd, sizeof (*input));
1087   if (input == NULL)
1088     einfo (_("%P%F: plugin failed to allocate memory for input: %s\n"),
1089            bfd_get_error ());
1090
1091   if (inarchive)
1092     {
1093       /* Offset and filesize must refer to the individual archive
1094          member, not the whole file, and must exclude the header.
1095          Fortunately for us, that is how the data is stored in the
1096          origin field of the bfd and in the arelt_data.  */
1097       offset = ibfd->origin;
1098       filesize = arelt_size (ibfd);
1099     }
1100   else
1101     {
1102       offset = 0;
1103       filesize = lseek (fd, 0, SEEK_END);
1104
1105       /* We must copy filename attached to ibfd if it is not an archive
1106          member since it may be freed by bfd_close below.  */
1107       name = plugin_strdup (abfd, name);
1108     }
1109
1110   file.name = name;
1111   file.offset = offset;
1112   file.filesize = filesize;
1113   file.fd = fd;
1114   file.handle = input;
1115
1116   input->abfd = abfd;
1117   input->view_buffer.addr = NULL;
1118   input->view_buffer.filesize = 0;
1119   input->view_buffer.offset = 0;
1120   input->fd = fd;
1121   input->use_mmap = FALSE;
1122   input->offset = offset;
1123   input->filesize = filesize;
1124   input->name = plugin_strdup (abfd, ibfd->filename);
1125
1126   claimed = 0;
1127
1128   if (plugin_call_claim_file (&file, &claimed))
1129     einfo (_("%P%F: %s: plugin reported error claiming file\n"),
1130            plugin_error_plugin ());
1131
1132   if (input->fd != -1 && ! bfd_plugin_target_p (ibfd->xvec))
1133     {
1134       /* FIXME: fd belongs to us, not the plugin.  GCC plugin, which
1135          doesn't need fd after plugin_call_claim_file, doesn't use
1136          BFD plugin target vector.  Since GCC plugin doesn't call
1137          release_input_file, we close it here.  LLVM plugin, which
1138          needs fd after plugin_call_claim_file and calls
1139          release_input_file after it is done, uses BFD plugin target
1140          vector.  This scheme doesn't work when a plugin needs fd and
1141          doesn't use BFD plugin target vector neither.  */
1142       close (fd);
1143       input->fd = -1;
1144     }
1145
1146   if (claimed)
1147     {
1148       ibfd->plugin_format = bfd_plugin_yes;
1149       ibfd->plugin_dummy_bfd = abfd;
1150       bfd_make_readable (abfd);
1151       return abfd->xvec;
1152     }
1153   else
1154     {
1155 #if HAVE_MMAP
1156       if (input->use_mmap)
1157         {
1158           /* If plugin didn't claim the file, unmap the buffer.  */
1159           char *addr = input->view_buffer.addr;
1160           off_t size = input->view_buffer.filesize;
1161 # if HAVE_GETPAGESIZE
1162           off_t bias = input->view_buffer.offset % plugin_pagesize;
1163           size += bias;
1164           addr -= bias;
1165 # endif
1166           munmap (addr, size);
1167         }
1168 #endif
1169
1170       /* If plugin didn't claim the file, we don't need the dummy bfd.
1171          Can't avoid speculatively creating it, alas.  */
1172       ibfd->plugin_format = bfd_plugin_no;
1173       bfd_close_all_done (abfd);
1174       return NULL;
1175     }
1176 }
1177
1178 void
1179 plugin_maybe_claim (lang_input_statement_type *entry)
1180 {
1181   if (plugin_object_p (entry->the_bfd))
1182     {
1183       bfd *abfd = entry->the_bfd->plugin_dummy_bfd;
1184
1185       /* Discard the real file's BFD and substitute the dummy one.  */
1186
1187       /* BFD archive handling caches elements so we can't call
1188          bfd_close for archives.  */
1189       if (entry->the_bfd->my_archive == NULL)
1190         bfd_close (entry->the_bfd);
1191       entry->the_bfd = abfd;
1192       entry->flags.claimed = 1;
1193     }
1194 }
1195
1196 /* Call 'all symbols read' hook for all plugins.  */
1197 int
1198 plugin_call_all_symbols_read (void)
1199 {
1200   plugin_t *curplug = plugins_list;
1201
1202   /* Disable any further file-claiming.  */
1203   no_more_claiming = TRUE;
1204
1205   while (curplug)
1206     {
1207       if (curplug->all_symbols_read_handler)
1208         {
1209           enum ld_plugin_status rv;
1210           called_plugin = curplug;
1211           rv = (*curplug->all_symbols_read_handler) ();
1212           called_plugin = NULL;
1213           if (rv != LDPS_OK)
1214             set_plugin_error (curplug->name);
1215         }
1216       curplug = curplug->next;
1217     }
1218   return plugin_error_p () ? -1 : 0;
1219 }
1220
1221 /* Call 'cleanup' hook for all plugins at exit.  */
1222 void
1223 plugin_call_cleanup (void)
1224 {
1225   plugin_t *curplug = plugins_list;
1226   while (curplug)
1227     {
1228       if (curplug->cleanup_handler && !curplug->cleanup_done)
1229         {
1230           enum ld_plugin_status rv;
1231           curplug->cleanup_done = TRUE;
1232           called_plugin = curplug;
1233           rv = (*curplug->cleanup_handler) ();
1234           called_plugin = NULL;
1235           if (rv != LDPS_OK)
1236             info_msg (_("%P: %s: error in plugin cleanup: %d (ignored)\n"),
1237                       curplug->name, rv);
1238           dlclose (curplug->dlhandle);
1239         }
1240       curplug = curplug->next;
1241     }
1242 }
1243
1244 /* To determine which symbols should be resolved LDPR_PREVAILING_DEF
1245    and which LDPR_PREVAILING_DEF_IRONLY, we notice all the symbols as
1246    the linker adds them to the linker hash table.  Mark those
1247    referenced from a non-IR file with non_ir_ref.  We have to
1248    notice_all symbols, because we won't necessarily know until later
1249    which ones will be contributed by IR files.  */
1250 static bfd_boolean
1251 plugin_notice (struct bfd_link_info *info,
1252                struct bfd_link_hash_entry *h,
1253                struct bfd_link_hash_entry *inh,
1254                bfd *abfd,
1255                asection *section,
1256                bfd_vma value,
1257                flagword flags)
1258 {
1259   struct bfd_link_hash_entry *orig_h = h;
1260
1261   if (h != NULL)
1262     {
1263       bfd *sym_bfd;
1264
1265       if (h->type == bfd_link_hash_warning)
1266         h = h->u.i.link;
1267
1268       /* Nothing to do here if this def/ref is from an IR dummy BFD.  */
1269       if (is_ir_dummy_bfd (abfd))
1270         ;
1271
1272       /* Making an indirect symbol counts as a reference unless this
1273          is a brand new symbol.  */
1274       else if (bfd_is_ind_section (section)
1275                || (flags & BSF_INDIRECT) != 0)
1276         {
1277           /* ??? Some of this is questionable.  See comments in
1278              _bfd_generic_link_add_one_symbol for case IND.  */
1279           if (h->type != bfd_link_hash_new)
1280             {
1281               h->non_ir_ref = TRUE;
1282               inh->non_ir_ref = TRUE;
1283             }
1284           else if (inh->type == bfd_link_hash_new)
1285             inh->non_ir_ref = TRUE;
1286         }
1287
1288       /* Nothing to do here for warning symbols.  */
1289       else if ((flags & BSF_WARNING) != 0)
1290         ;
1291
1292       /* Nothing to do here for constructor symbols.  */
1293       else if ((flags & BSF_CONSTRUCTOR) != 0)
1294         ;
1295
1296       /* If this is a ref, set non_ir_ref.  */
1297       else if (bfd_is_und_section (section))
1298         {
1299           /* Replace the undefined dummy bfd with the real one.  */
1300           if ((h->type == bfd_link_hash_undefined
1301                || h->type == bfd_link_hash_undefweak)
1302               && (h->u.undef.abfd == NULL
1303                   || (h->u.undef.abfd->flags & BFD_PLUGIN) != 0))
1304             h->u.undef.abfd = abfd;
1305           h->non_ir_ref = TRUE;
1306         }
1307
1308       /* Otherwise, it must be a new def.  Ensure any symbol defined
1309          in an IR dummy BFD takes on a new value from a real BFD.
1310          Weak symbols are not normally overridden by a new weak
1311          definition, and strong symbols will normally cause multiple
1312          definition errors.  Avoid this by making the symbol appear
1313          to be undefined.  */
1314       else if (((h->type == bfd_link_hash_defweak
1315                  || h->type == bfd_link_hash_defined)
1316                 && is_ir_dummy_bfd (sym_bfd = h->u.def.section->owner))
1317                || (h->type == bfd_link_hash_common
1318                    && is_ir_dummy_bfd (sym_bfd = h->u.c.p->section->owner)))
1319         {
1320           h->type = bfd_link_hash_undefweak;
1321           h->u.undef.abfd = sym_bfd;
1322         }
1323     }
1324
1325   /* Continue with cref/nocrossref/trace-sym processing.  */
1326   if (orig_h == NULL
1327       || orig_notice_all
1328       || (info->notice_hash != NULL
1329           && bfd_hash_lookup (info->notice_hash, orig_h->root.string,
1330                               FALSE, FALSE) != NULL))
1331     return (*orig_callbacks->notice) (info, orig_h, inh,
1332                                       abfd, section, value, flags);
1333   return TRUE;
1334 }