1 /* Plugin support for BFD.
2 Copyright (C) 2009-2019 Free Software Foundation, Inc.
4 This file is part of BFD, the Binary File Descriptor library.
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. */
24 #if BFD_SUPPORTS_PLUGINS
29 #elif defined (HAVE_WINDOWS_H)
32 #error Unknown how to handle dynamic-load-libraries.
35 #include "plugin-api.h"
38 #include "libiberty.h"
41 #if !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H)
43 #define RTLD_NOW 0 /* Dummy value. */
46 dlopen (const char *file, int mode ATTRIBUTE_UNUSED)
48 return LoadLibrary (file);
52 dlsym (void *handle, const char *name)
54 return GetProcAddress (handle, name);
57 static int ATTRIBUTE_UNUSED
58 dlclose (void *handle)
67 return "Unable to load DLL.";
70 #endif /* !defined (HAVE_DLFCN_H) && defined (HAVE_WINDOWS_H) */
72 #define bfd_plugin_close_and_cleanup _bfd_generic_close_and_cleanup
73 #define bfd_plugin_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
74 #define bfd_plugin_new_section_hook _bfd_generic_new_section_hook
75 #define bfd_plugin_get_section_contents _bfd_generic_get_section_contents
76 #define bfd_plugin_get_section_contents_in_window _bfd_generic_get_section_contents_in_window
77 #define bfd_plugin_bfd_copy_private_header_data _bfd_generic_bfd_copy_private_header_data
78 #define bfd_plugin_bfd_merge_private_bfd_data _bfd_generic_bfd_merge_private_bfd_data
79 #define bfd_plugin_bfd_copy_private_header_data _bfd_generic_bfd_copy_private_header_data
80 #define bfd_plugin_bfd_set_private_flags _bfd_generic_bfd_set_private_flags
81 #define bfd_plugin_core_file_matches_executable_p generic_core_file_matches_executable_p
82 #define bfd_plugin_bfd_is_local_label_name _bfd_nosymbols_bfd_is_local_label_name
83 #define bfd_plugin_bfd_is_target_special_symbol _bfd_bool_bfd_asymbol_false
84 #define bfd_plugin_get_lineno _bfd_nosymbols_get_lineno
85 #define bfd_plugin_find_nearest_line _bfd_nosymbols_find_nearest_line
86 #define bfd_plugin_find_line _bfd_nosymbols_find_line
87 #define bfd_plugin_find_inliner_info _bfd_nosymbols_find_inliner_info
88 #define bfd_plugin_get_symbol_version_string _bfd_nosymbols_get_symbol_version_string
89 #define bfd_plugin_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
90 #define bfd_plugin_read_minisymbols _bfd_generic_read_minisymbols
91 #define bfd_plugin_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
92 #define bfd_plugin_set_arch_mach bfd_default_set_arch_mach
93 #define bfd_plugin_set_section_contents _bfd_generic_set_section_contents
94 #define bfd_plugin_bfd_get_relocated_section_contents bfd_generic_get_relocated_section_contents
95 #define bfd_plugin_bfd_relax_section bfd_generic_relax_section
96 #define bfd_plugin_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
97 #define bfd_plugin_bfd_link_add_symbols _bfd_generic_link_add_symbols
98 #define bfd_plugin_bfd_link_just_syms _bfd_generic_link_just_syms
99 #define bfd_plugin_bfd_final_link _bfd_generic_final_link
100 #define bfd_plugin_bfd_link_split_section _bfd_generic_link_split_section
101 #define bfd_plugin_bfd_gc_sections bfd_generic_gc_sections
102 #define bfd_plugin_bfd_lookup_section_flags bfd_generic_lookup_section_flags
103 #define bfd_plugin_bfd_merge_sections bfd_generic_merge_sections
104 #define bfd_plugin_bfd_is_group_section bfd_generic_is_group_section
105 #define bfd_plugin_bfd_discard_group bfd_generic_discard_group
106 #define bfd_plugin_section_already_linked _bfd_generic_section_already_linked
107 #define bfd_plugin_bfd_define_common_symbol bfd_generic_define_common_symbol
108 #define bfd_plugin_bfd_link_hide_symbol _bfd_generic_link_hide_symbol
109 #define bfd_plugin_bfd_define_start_stop bfd_generic_define_start_stop
110 #define bfd_plugin_bfd_copy_link_hash_symbol_type _bfd_generic_copy_link_hash_symbol_type
111 #define bfd_plugin_bfd_link_check_relocs _bfd_generic_link_check_relocs
113 static enum ld_plugin_status
114 message (int level ATTRIBUTE_UNUSED,
115 const char * format, ...)
118 va_start (args, format);
119 printf ("bfd plugin: ");
120 vprintf (format, args);
126 /* Register a claim-file handler. */
127 static ld_plugin_claim_file_handler claim_file = NULL;
129 static enum ld_plugin_status
130 register_claim_file (ld_plugin_claim_file_handler handler)
132 claim_file = handler;
136 static enum ld_plugin_status
137 add_symbols (void * handle,
139 const struct ld_plugin_symbol * syms)
142 struct plugin_data_struct *plugin_data =
143 bfd_alloc (abfd, sizeof (plugin_data_struct));
145 plugin_data->nsyms = nsyms;
146 plugin_data->syms = syms;
149 abfd->flags |= HAS_SYMS;
151 abfd->tdata.plugin_data = plugin_data;
155 static const char *plugin_program_name;
158 bfd_plugin_set_program_name (const char *program_name)
160 plugin_program_name = program_name;
164 bfd_plugin_open_input (bfd *ibfd, struct ld_plugin_input_file *file)
169 while (iobfd->my_archive
170 && !bfd_is_thin_archive (iobfd->my_archive))
171 iobfd = iobfd->my_archive;
172 file->name = iobfd->filename;
174 if (!iobfd->iostream && !bfd_open_file (iobfd))
177 /* The plugin API expects that the file descriptor won't be closed
178 and reused as done by the bfd file cache. So open it again.
179 dup isn't good enough. plugin IO uses lseek/read while BFD uses
180 fseek/fread. It isn't wise to mix the unistd and stdio calls on
181 the same underlying file descriptor. */
182 file->fd = open (file->name, O_RDONLY | O_BINARY);
188 struct stat stat_buf;
190 if (fstat (file->fd, &stat_buf))
197 file->filesize = stat_buf.st_size;
201 file->offset = ibfd->origin;
202 file->filesize = arelt_size (ibfd);
208 try_claim (bfd *abfd)
211 struct ld_plugin_input_file file;
214 if (!bfd_plugin_open_input (abfd, &file))
217 claim_file (&file, &claimed);
222 struct plugin_list_entry
225 ld_plugin_claim_file_handler claim_file;
226 struct plugin_list_entry * next;
229 static struct plugin_list_entry * plugin_list = NULL;
232 try_load_plugin (const char *pname, bfd *abfd, int *has_plugin_p)
234 void *plugin_handle = NULL;
235 struct ld_plugin_tv tv[4];
237 ld_plugin_onload onload;
238 enum ld_plugin_status status;
239 struct plugin_list_entry *plugin_list_iter;
243 plugin_handle = dlopen (pname, RTLD_NOW);
246 _bfd_error_handler ("%s\n", dlerror ());
250 for (plugin_list_iter = plugin_list;
252 plugin_list_iter = plugin_list_iter->next)
254 if (plugin_handle == plugin_list_iter->handle)
256 dlclose (plugin_handle);
257 if (!plugin_list_iter->claim_file)
260 register_claim_file (plugin_list_iter->claim_file);
261 goto have_claim_file;
265 plugin_list_iter = bfd_malloc (sizeof *plugin_list_iter);
266 if (plugin_list_iter == NULL)
268 plugin_list_iter->handle = plugin_handle;
269 plugin_list_iter->claim_file = NULL;
270 plugin_list_iter->next = plugin_list;
271 plugin_list = plugin_list_iter;
273 onload = dlsym (plugin_handle, "onload");
278 tv[i].tv_tag = LDPT_MESSAGE;
279 tv[i].tv_u.tv_message = message;
282 tv[i].tv_tag = LDPT_REGISTER_CLAIM_FILE_HOOK;
283 tv[i].tv_u.tv_register_claim_file = register_claim_file;
286 tv[i].tv_tag = LDPT_ADD_SYMBOLS;
287 tv[i].tv_u.tv_add_symbols = add_symbols;
290 tv[i].tv_tag = LDPT_NULL;
291 tv[i].tv_u.tv_val = 0;
293 status = (*onload)(tv);
295 if (status != LDPS_OK)
298 plugin_list_iter->claim_file = claim_file;
303 abfd->plugin_format = bfd_plugin_no;
308 if (!try_claim (abfd))
311 abfd->plugin_format = bfd_plugin_yes;
315 /* There may be plugin libraries in lib/bfd-plugins. */
317 static int has_plugin = -1;
319 static const bfd_target *(*ld_plugin_object_p) (bfd *);
321 static const char *plugin_name;
324 bfd_plugin_set_plugin (const char *p)
327 has_plugin = p != NULL;
330 /* Return TRUE if a plugin library is used. */
333 bfd_plugin_specified_p (void)
335 return has_plugin > 0;
338 /* Return TRUE if ABFD can be claimed by linker LTO plugin. */
341 bfd_link_plugin_object_p (bfd *abfd)
343 if (ld_plugin_object_p)
344 return ld_plugin_object_p (abfd) != NULL;
348 extern const bfd_target plugin_vec;
350 /* Return TRUE if TARGET is a pointer to plugin_vec. */
353 bfd_plugin_target_p (const bfd_target *target)
355 return target == &plugin_vec;
358 /* Register OBJECT_P to be used by bfd_plugin_object_p. */
361 register_ld_plugin_object_p (const bfd_target *(*object_p) (bfd *))
363 ld_plugin_object_p = object_p;
367 load_plugin (bfd *abfd)
369 /* The intent was to search ${libdir}/bfd-plugins for plugins, but
370 unfortunately the original implementation wasn't precisely that
371 when configuring binutils using --libdir. Search in the proper
372 path first, then the old one for backwards compatibility. */
373 static const char *path[]
374 = { LIBDIR "/bfd-plugins", BINDIR "/../lib/bfd-plugins" };
383 return try_load_plugin (plugin_name, abfd, &has_plugin);
385 if (plugin_program_name == NULL)
388 /* Try not to search the same dir twice, by looking at st_dev and
389 st_ino for the dir. If we are on a file system that always sets
390 st_ino to zero or the actual st_ino is zero we might waste some
391 time, but that doesn't matter too much. */
394 for (i = 0; i < sizeof (path) / sizeof (path[0]); i++)
396 char *plugin_dir = make_relative_prefix (plugin_program_name,
404 if (stat (plugin_dir, &st) == 0
405 && S_ISDIR (st.st_mode)
406 && !(last_st.st_dev == st.st_dev
407 && last_st.st_ino == st.st_ino
409 && (d = opendir (plugin_dir)) != NULL)
413 last_st.st_dev = st.st_dev;
414 last_st.st_ino = st.st_ino;
415 while ((ent = readdir (d)) != NULL)
419 full_name = concat (plugin_dir, "/", ent->d_name, NULL);
420 if (stat (full_name, &st) == 0 && S_ISREG (st.st_mode))
424 found = try_load_plugin (full_name, abfd, &valid_plugin);
426 has_plugin = valid_plugin;
444 static const bfd_target *
445 bfd_plugin_object_p (bfd *abfd)
447 if (ld_plugin_object_p)
448 return ld_plugin_object_p (abfd);
450 if (abfd->plugin_format == bfd_plugin_unknown && !load_plugin (abfd))
453 return abfd->plugin_format == bfd_plugin_yes ? abfd->xvec : NULL;
456 /* Copy any private info we understand from the input bfd
457 to the output bfd. */
460 bfd_plugin_bfd_copy_private_bfd_data (bfd *ibfd ATTRIBUTE_UNUSED,
461 bfd *obfd ATTRIBUTE_UNUSED)
467 /* Copy any private info we understand from the input section
468 to the output section. */
471 bfd_plugin_bfd_copy_private_section_data (bfd *ibfd ATTRIBUTE_UNUSED,
472 asection *isection ATTRIBUTE_UNUSED,
473 bfd *obfd ATTRIBUTE_UNUSED,
474 asection *osection ATTRIBUTE_UNUSED)
480 /* Copy any private info we understand from the input symbol
481 to the output symbol. */
484 bfd_plugin_bfd_copy_private_symbol_data (bfd *ibfd ATTRIBUTE_UNUSED,
485 asymbol *isymbol ATTRIBUTE_UNUSED,
486 bfd *obfd ATTRIBUTE_UNUSED,
487 asymbol *osymbol ATTRIBUTE_UNUSED)
494 bfd_plugin_bfd_print_private_bfd_data (bfd *abfd ATTRIBUTE_UNUSED, PTR ptr ATTRIBUTE_UNUSED)
501 bfd_plugin_core_file_failing_command (bfd *abfd ATTRIBUTE_UNUSED)
508 bfd_plugin_core_file_failing_signal (bfd *abfd ATTRIBUTE_UNUSED)
515 bfd_plugin_core_file_pid (bfd *abfd ATTRIBUTE_UNUSED)
522 bfd_plugin_get_symtab_upper_bound (bfd *abfd)
524 struct plugin_data_struct *plugin_data = abfd->tdata.plugin_data;
525 long nsyms = plugin_data->nsyms;
527 BFD_ASSERT (nsyms >= 0);
529 return ((nsyms + 1) * sizeof (asymbol *));
533 convert_flags (const struct ld_plugin_symbol *sym)
544 return BSF_GLOBAL | BSF_WEAK;
553 bfd_plugin_canonicalize_symtab (bfd *abfd,
556 struct plugin_data_struct *plugin_data = abfd->tdata.plugin_data;
557 long nsyms = plugin_data->nsyms;
558 const struct ld_plugin_symbol *syms = plugin_data->syms;
559 static asection fake_section
560 = BFD_FAKE_SECTION (fake_section, NULL, "plug", 0,
561 SEC_ALLOC | SEC_LOAD | SEC_CODE | SEC_HAS_CONTENTS);
562 static asection fake_common_section
563 = BFD_FAKE_SECTION (fake_common_section, NULL, "plug", 0, SEC_IS_COMMON);
566 for (i = 0; i < nsyms; i++)
568 asymbol *s = bfd_alloc (abfd, sizeof (asymbol));
574 s->name = syms[i].name;
576 s->flags = convert_flags (&syms[i]);
580 s->section = &fake_common_section;
584 s->section = bfd_und_section_ptr;
588 s->section = &fake_section;
594 s->udata.p = (void *) &syms[i];
601 bfd_plugin_print_symbol (bfd *abfd ATTRIBUTE_UNUSED,
602 PTR afile ATTRIBUTE_UNUSED,
603 asymbol *symbol ATTRIBUTE_UNUSED,
604 bfd_print_symbol_type how ATTRIBUTE_UNUSED)
610 bfd_plugin_get_symbol_info (bfd *abfd ATTRIBUTE_UNUSED,
614 bfd_symbol_info (symbol, ret);
617 /* Make an empty symbol. */
620 bfd_plugin_make_empty_symbol (bfd *abfd)
622 asymbol *new_symbol = bfd_zalloc (abfd, sizeof (asymbol));
623 if (new_symbol == NULL)
625 new_symbol->the_bfd = abfd;
630 bfd_plugin_sizeof_headers (bfd *a ATTRIBUTE_UNUSED,
631 struct bfd_link_info *info ATTRIBUTE_UNUSED)
637 const bfd_target plugin_vec =
639 "plugin", /* Name. */
640 bfd_target_unknown_flavour,
641 BFD_ENDIAN_LITTLE, /* Target byte order. */
642 BFD_ENDIAN_LITTLE, /* Target headers byte order. */
643 (HAS_RELOC | EXEC_P | /* Object flags. */
644 HAS_LINENO | HAS_DEBUG |
645 HAS_SYMS | HAS_LOCALS | DYNAMIC | WP_TEXT | D_PAGED),
646 (SEC_CODE | SEC_DATA | SEC_ROM | SEC_HAS_CONTENTS
647 | SEC_ALLOC | SEC_LOAD | SEC_RELOC), /* Section flags. */
648 0, /* symbol_leading_char. */
649 '/', /* ar_pad_char. */
650 15, /* ar_max_namelen. */
651 255, /* match priority. */
653 bfd_getl64, bfd_getl_signed_64, bfd_putl64,
654 bfd_getl32, bfd_getl_signed_32, bfd_putl32,
655 bfd_getl16, bfd_getl_signed_16, bfd_putl16, /* data */
656 bfd_getl64, bfd_getl_signed_64, bfd_putl64,
657 bfd_getl32, bfd_getl_signed_32, bfd_putl32,
658 bfd_getl16, bfd_getl_signed_16, bfd_putl16, /* hdrs */
660 { /* bfd_check_format. */
663 bfd_generic_archive_p,
666 { /* bfd_set_format. */
667 _bfd_bool_bfd_false_error,
668 _bfd_bool_bfd_false_error,
669 _bfd_generic_mkarchive,
670 _bfd_bool_bfd_false_error,
672 { /* bfd_write_contents. */
673 _bfd_bool_bfd_false_error,
674 _bfd_bool_bfd_false_error,
675 _bfd_write_archive_contents,
676 _bfd_bool_bfd_false_error,
679 BFD_JUMP_TABLE_GENERIC (bfd_plugin),
680 BFD_JUMP_TABLE_COPY (bfd_plugin),
681 BFD_JUMP_TABLE_CORE (bfd_plugin),
682 #ifdef USE_64_BIT_ARCHIVE
683 BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_64_bit),
685 BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff),
687 BFD_JUMP_TABLE_SYMBOLS (bfd_plugin),
688 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
689 BFD_JUMP_TABLE_WRITE (bfd_plugin),
690 BFD_JUMP_TABLE_LINK (bfd_plugin),
691 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),
695 NULL /* backend_data. */
697 #endif /* BFD_SUPPORTS_PLUGIN */