1 /* Plugin support for BFD.
2 Copyright (C) 2009-2020 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_group_name bfd_generic_group_name
106 #define bfd_plugin_bfd_discard_group bfd_generic_discard_group
107 #define bfd_plugin_section_already_linked _bfd_generic_section_already_linked
108 #define bfd_plugin_bfd_define_common_symbol bfd_generic_define_common_symbol
109 #define bfd_plugin_bfd_link_hide_symbol _bfd_generic_link_hide_symbol
110 #define bfd_plugin_bfd_define_start_stop bfd_generic_define_start_stop
111 #define bfd_plugin_bfd_copy_link_hash_symbol_type _bfd_generic_copy_link_hash_symbol_type
112 #define bfd_plugin_bfd_link_check_relocs _bfd_generic_link_check_relocs
114 static enum ld_plugin_status
115 message (int level ATTRIBUTE_UNUSED
,
116 const char * format
, ...)
119 va_start (args
, format
);
120 printf ("bfd plugin: ");
121 vprintf (format
, args
);
127 struct plugin_list_entry
129 /* These must be initialized for each IR object with LTO wrapper. */
130 ld_plugin_claim_file_handler claim_file
;
131 ld_plugin_all_symbols_read_handler all_symbols_read
;
132 ld_plugin_all_symbols_read_handler cleanup_handler
;
133 bfd_boolean has_symbol_type
;
135 struct plugin_list_entry
*next
;
137 /* These can be reused for all IR objects. */
138 const char *plugin_name
;
141 static const char *plugin_program_name
;
144 bfd_plugin_set_program_name (const char *program_name
)
146 plugin_program_name
= program_name
;
149 static struct plugin_list_entry
*plugin_list
= NULL
;
150 static struct plugin_list_entry
*current_plugin
= NULL
;
152 /* Register a claim-file handler. */
154 static enum ld_plugin_status
155 register_claim_file (ld_plugin_claim_file_handler handler
)
157 current_plugin
->claim_file
= handler
;
161 static enum ld_plugin_status
162 add_symbols (void * handle
,
164 const struct ld_plugin_symbol
* syms
)
167 struct plugin_data_struct
*plugin_data
=
168 bfd_alloc (abfd
, sizeof (plugin_data_struct
));
173 plugin_data
->nsyms
= nsyms
;
174 plugin_data
->syms
= syms
;
177 abfd
->flags
|= HAS_SYMS
;
179 abfd
->tdata
.plugin_data
= plugin_data
;
183 static enum ld_plugin_status
184 add_symbols_v2 (void *handle
, int nsyms
,
185 const struct ld_plugin_symbol
*syms
)
187 current_plugin
->has_symbol_type
= TRUE
;
188 return add_symbols (handle
, nsyms
, syms
);
192 bfd_plugin_open_input (bfd
*ibfd
, struct ld_plugin_input_file
*file
)
197 while (iobfd
->my_archive
198 && !bfd_is_thin_archive (iobfd
->my_archive
))
199 iobfd
= iobfd
->my_archive
;
200 file
->name
= bfd_get_filename (iobfd
);
202 if (!iobfd
->iostream
&& !bfd_open_file (iobfd
))
205 /* The plugin API expects that the file descriptor won't be closed
206 and reused as done by the bfd file cache. So open it again.
207 dup isn't good enough. plugin IO uses lseek/read while BFD uses
208 fseek/fread. It isn't wise to mix the unistd and stdio calls on
209 the same underlying file descriptor. */
210 file
->fd
= open (file
->name
, O_RDONLY
| O_BINARY
);
216 struct stat stat_buf
;
218 if (fstat (file
->fd
, &stat_buf
))
225 file
->filesize
= stat_buf
.st_size
;
229 file
->offset
= ibfd
->origin
;
230 file
->filesize
= arelt_size (ibfd
);
236 try_claim (bfd
*abfd
)
239 struct ld_plugin_input_file file
;
242 if (bfd_plugin_open_input (abfd
, &file
)
243 && current_plugin
->claim_file
)
245 current_plugin
->claim_file (&file
, &claimed
);
253 try_load_plugin (const char * pname
,
254 struct plugin_list_entry
* plugin_list_iter
,
256 bfd_boolean build_list_p
)
259 struct ld_plugin_tv tv
[5];
261 ld_plugin_onload onload
;
262 enum ld_plugin_status status
;
263 bfd_boolean result
= FALSE
;
265 /* NB: Each object is independent. Reuse the previous plugin from
266 the last run will lead to wrong result. */
268 memset (current_plugin
, 0,
269 offsetof (struct plugin_list_entry
, next
));
271 if (plugin_list_iter
)
272 pname
= plugin_list_iter
->plugin_name
;
274 plugin_handle
= dlopen (pname
, RTLD_NOW
);
277 /* If we are building a list of viable plugins, then
278 we do not bother the user with the details of any
279 plugins that cannot be loaded. */
281 _bfd_error_handler ("Failed to load plugin '%s', reason: %s\n",
286 if (plugin_list_iter
== NULL
)
288 size_t length_plugin_name
= strlen (pname
) + 1;
289 char *plugin_name
= bfd_malloc (length_plugin_name
);
291 if (plugin_name
== NULL
)
293 plugin_list_iter
= bfd_malloc (sizeof *plugin_list_iter
);
294 if (plugin_list_iter
== NULL
)
299 /* Make a copy of PNAME since PNAME from load_plugin () will be
301 memcpy (plugin_name
, pname
, length_plugin_name
);
302 memset (plugin_list_iter
, 0, sizeof (*plugin_list_iter
));
303 plugin_list_iter
->plugin_name
= plugin_name
;
304 plugin_list_iter
->next
= plugin_list
;
305 plugin_list
= plugin_list_iter
;
308 current_plugin
= plugin_list_iter
;
312 onload
= dlsym (plugin_handle
, "onload");
317 tv
[i
].tv_tag
= LDPT_MESSAGE
;
318 tv
[i
].tv_u
.tv_message
= message
;
321 tv
[i
].tv_tag
= LDPT_REGISTER_CLAIM_FILE_HOOK
;
322 tv
[i
].tv_u
.tv_register_claim_file
= register_claim_file
;
325 tv
[i
].tv_tag
= LDPT_ADD_SYMBOLS
;
326 tv
[i
].tv_u
.tv_add_symbols
= add_symbols
;
329 tv
[i
].tv_tag
= LDPT_ADD_SYMBOLS_V2
;
330 tv
[i
].tv_u
.tv_add_symbols
= add_symbols_v2
;
333 tv
[i
].tv_tag
= LDPT_NULL
;
334 tv
[i
].tv_u
.tv_val
= 0;
336 /* LTO plugin will call handler hooks to set up plugin handlers. */
337 status
= (*onload
)(tv
);
339 if (status
!= LDPS_OK
)
342 abfd
->plugin_format
= bfd_plugin_no
;
344 if (!current_plugin
->claim_file
)
347 if (!try_claim (abfd
))
350 abfd
->plugin_format
= bfd_plugin_yes
;
354 dlclose (plugin_handle
);
358 /* There may be plugin libraries in lib/bfd-plugins. */
359 static int has_plugin_list
= -1;
361 static bfd_cleanup (*ld_plugin_object_p
) (bfd
*);
363 static const char *plugin_name
;
366 bfd_plugin_set_plugin (const char *p
)
371 /* Return TRUE if a plugin library is used. */
374 bfd_plugin_specified_p (void)
376 return plugin_list
!= NULL
;
379 /* Return TRUE if ABFD can be claimed by linker LTO plugin. */
382 bfd_link_plugin_object_p (bfd
*abfd
)
384 if (ld_plugin_object_p
)
385 return ld_plugin_object_p (abfd
) != NULL
;
389 extern const bfd_target plugin_vec
;
391 /* Return TRUE if TARGET is a pointer to plugin_vec. */
394 bfd_plugin_target_p (const bfd_target
*target
)
396 return target
== &plugin_vec
;
399 /* Register OBJECT_P to be used by bfd_plugin_object_p. */
402 register_ld_plugin_object_p (bfd_cleanup (*object_p
) (bfd
*))
404 ld_plugin_object_p
= object_p
;
408 build_plugin_list (bfd
*abfd
)
410 /* The intent was to search ${libdir}/bfd-plugins for plugins, but
411 unfortunately the original implementation wasn't precisely that
412 when configuring binutils using --libdir. Search in the proper
413 path first, then the old one for backwards compatibility. */
414 static const char *path
[]
415 = { LIBDIR
"/bfd-plugins", BINDIR
"/../lib/bfd-plugins" };
419 if (has_plugin_list
>= 0)
422 /* Try not to search the same dir twice, by looking at st_dev and
423 st_ino for the dir. If we are on a file system that always sets
424 st_ino to zero or the actual st_ino is zero we might waste some
425 time, but that doesn't matter too much. */
428 for (i
= 0; i
< sizeof (path
) / sizeof (path
[0]); i
++)
430 char *plugin_dir
= make_relative_prefix (plugin_program_name
,
438 if (stat (plugin_dir
, &st
) == 0
439 && S_ISDIR (st
.st_mode
)
440 && !(last_st
.st_dev
== st
.st_dev
441 && last_st
.st_ino
== st
.st_ino
443 && (d
= opendir (plugin_dir
)) != NULL
)
447 last_st
.st_dev
= st
.st_dev
;
448 last_st
.st_ino
= st
.st_ino
;
449 while ((ent
= readdir (d
)) != NULL
)
453 full_name
= concat (plugin_dir
, "/", ent
->d_name
, NULL
);
454 if (stat (full_name
, &st
) == 0 && S_ISREG (st
.st_mode
))
455 (void) try_load_plugin (full_name
, NULL
, abfd
, TRUE
);
464 has_plugin_list
= plugin_list
!= NULL
;
468 load_plugin (bfd
*abfd
)
470 struct plugin_list_entry
*plugin_list_iter
;
473 return try_load_plugin (plugin_name
, plugin_list
, abfd
, FALSE
);
475 if (plugin_program_name
== NULL
)
478 build_plugin_list (abfd
);
480 for (plugin_list_iter
= plugin_list
;
482 plugin_list_iter
= plugin_list_iter
->next
)
483 if (try_load_plugin (NULL
, plugin_list_iter
, abfd
,FALSE
))
491 bfd_plugin_object_p (bfd
*abfd
)
493 if (ld_plugin_object_p
)
494 return ld_plugin_object_p (abfd
);
496 if (abfd
->plugin_format
== bfd_plugin_unknown
&& !load_plugin (abfd
))
499 return abfd
->plugin_format
== bfd_plugin_yes
? _bfd_no_cleanup
: NULL
;
502 /* Copy any private info we understand from the input bfd
503 to the output bfd. */
506 bfd_plugin_bfd_copy_private_bfd_data (bfd
*ibfd ATTRIBUTE_UNUSED
,
507 bfd
*obfd ATTRIBUTE_UNUSED
)
513 /* Copy any private info we understand from the input section
514 to the output section. */
517 bfd_plugin_bfd_copy_private_section_data (bfd
*ibfd ATTRIBUTE_UNUSED
,
518 asection
*isection ATTRIBUTE_UNUSED
,
519 bfd
*obfd ATTRIBUTE_UNUSED
,
520 asection
*osection ATTRIBUTE_UNUSED
)
526 /* Copy any private info we understand from the input symbol
527 to the output symbol. */
530 bfd_plugin_bfd_copy_private_symbol_data (bfd
*ibfd ATTRIBUTE_UNUSED
,
531 asymbol
*isymbol ATTRIBUTE_UNUSED
,
532 bfd
*obfd ATTRIBUTE_UNUSED
,
533 asymbol
*osymbol ATTRIBUTE_UNUSED
)
540 bfd_plugin_bfd_print_private_bfd_data (bfd
*abfd ATTRIBUTE_UNUSED
, PTR ptr ATTRIBUTE_UNUSED
)
547 bfd_plugin_core_file_failing_command (bfd
*abfd ATTRIBUTE_UNUSED
)
554 bfd_plugin_core_file_failing_signal (bfd
*abfd ATTRIBUTE_UNUSED
)
561 bfd_plugin_core_file_pid (bfd
*abfd ATTRIBUTE_UNUSED
)
568 bfd_plugin_get_symtab_upper_bound (bfd
*abfd
)
570 struct plugin_data_struct
*plugin_data
= abfd
->tdata
.plugin_data
;
571 long nsyms
= plugin_data
->nsyms
;
573 BFD_ASSERT (nsyms
>= 0);
575 return ((nsyms
+ 1) * sizeof (asymbol
*));
579 convert_flags (const struct ld_plugin_symbol
*sym
)
590 return BSF_GLOBAL
| BSF_WEAK
;
599 bfd_plugin_canonicalize_symtab (bfd
*abfd
,
602 struct plugin_data_struct
*plugin_data
= abfd
->tdata
.plugin_data
;
603 long nsyms
= plugin_data
->nsyms
;
604 const struct ld_plugin_symbol
*syms
= plugin_data
->syms
;
605 static asection fake_text_section
606 = BFD_FAKE_SECTION (fake_text_section
, NULL
, "plug", 0,
607 SEC_ALLOC
| SEC_LOAD
| SEC_CODE
| SEC_HAS_CONTENTS
);
608 static asection fake_data_section
609 = BFD_FAKE_SECTION (fake_data_section
, NULL
, "plug", 0,
610 SEC_ALLOC
| SEC_LOAD
| SEC_DATA
| SEC_HAS_CONTENTS
);
611 static asection fake_bss_section
612 = BFD_FAKE_SECTION (fake_bss_section
, NULL
, "plug", 0,
614 static asection fake_common_section
615 = BFD_FAKE_SECTION (fake_common_section
, NULL
, "plug", 0, SEC_IS_COMMON
);
618 for (i
= 0; i
< nsyms
; i
++)
620 asymbol
*s
= bfd_alloc (abfd
, sizeof (asymbol
));
626 s
->name
= syms
[i
].name
;
628 s
->flags
= convert_flags (&syms
[i
]);
632 s
->section
= &fake_common_section
;
636 s
->section
= bfd_und_section_ptr
;
640 if (current_plugin
->has_symbol_type
)
641 switch (syms
[i
].symbol_type
)
644 /* FIXME: Should we issue an error here ? */
646 /* What is the best fake section for LDST_UNKNOWN? */
648 s
->section
= &fake_text_section
;
651 if (syms
[i
].section_kind
== LDSSK_BSS
)
652 s
->section
= &fake_bss_section
;
654 s
->section
= &fake_data_section
;
658 s
->section
= &fake_text_section
;
664 s
->udata
.p
= (void *) &syms
[i
];
671 bfd_plugin_print_symbol (bfd
*abfd ATTRIBUTE_UNUSED
,
672 PTR afile ATTRIBUTE_UNUSED
,
673 asymbol
*symbol ATTRIBUTE_UNUSED
,
674 bfd_print_symbol_type how ATTRIBUTE_UNUSED
)
680 bfd_plugin_get_symbol_info (bfd
*abfd ATTRIBUTE_UNUSED
,
684 bfd_symbol_info (symbol
, ret
);
687 /* Make an empty symbol. */
690 bfd_plugin_make_empty_symbol (bfd
*abfd
)
692 asymbol
*new_symbol
= bfd_zalloc (abfd
, sizeof (asymbol
));
693 if (new_symbol
== NULL
)
695 new_symbol
->the_bfd
= abfd
;
700 bfd_plugin_sizeof_headers (bfd
*a ATTRIBUTE_UNUSED
,
701 struct bfd_link_info
*info ATTRIBUTE_UNUSED
)
707 const bfd_target plugin_vec
=
709 "plugin", /* Name. */
710 bfd_target_unknown_flavour
,
711 BFD_ENDIAN_LITTLE
, /* Target byte order. */
712 BFD_ENDIAN_LITTLE
, /* Target headers byte order. */
713 (HAS_RELOC
| EXEC_P
| /* Object flags. */
714 HAS_LINENO
| HAS_DEBUG
|
715 HAS_SYMS
| HAS_LOCALS
| DYNAMIC
| WP_TEXT
| D_PAGED
),
716 (SEC_CODE
| SEC_DATA
| SEC_ROM
| SEC_HAS_CONTENTS
717 | SEC_ALLOC
| SEC_LOAD
| SEC_RELOC
), /* Section flags. */
718 0, /* symbol_leading_char. */
719 '/', /* ar_pad_char. */
720 15, /* ar_max_namelen. */
721 255, /* match priority. */
723 bfd_getl64
, bfd_getl_signed_64
, bfd_putl64
,
724 bfd_getl32
, bfd_getl_signed_32
, bfd_putl32
,
725 bfd_getl16
, bfd_getl_signed_16
, bfd_putl16
, /* data */
726 bfd_getl64
, bfd_getl_signed_64
, bfd_putl64
,
727 bfd_getl32
, bfd_getl_signed_32
, bfd_putl32
,
728 bfd_getl16
, bfd_getl_signed_16
, bfd_putl16
, /* hdrs */
730 { /* bfd_check_format. */
733 bfd_generic_archive_p
,
736 { /* bfd_set_format. */
737 _bfd_bool_bfd_false_error
,
738 _bfd_bool_bfd_false_error
,
739 _bfd_generic_mkarchive
,
740 _bfd_bool_bfd_false_error
,
742 { /* bfd_write_contents. */
743 _bfd_bool_bfd_false_error
,
744 _bfd_bool_bfd_false_error
,
745 _bfd_write_archive_contents
,
746 _bfd_bool_bfd_false_error
,
749 BFD_JUMP_TABLE_GENERIC (bfd_plugin
),
750 BFD_JUMP_TABLE_COPY (bfd_plugin
),
751 BFD_JUMP_TABLE_CORE (bfd_plugin
),
752 #ifdef USE_64_BIT_ARCHIVE
753 BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_64_bit
),
755 BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff
),
757 BFD_JUMP_TABLE_SYMBOLS (bfd_plugin
),
758 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs
),
759 BFD_JUMP_TABLE_WRITE (bfd_plugin
),
760 BFD_JUMP_TABLE_LINK (bfd_plugin
),
761 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic
),
765 NULL
/* backend_data. */
767 #endif /* BFD_SUPPORTS_PLUGINS */