1 /* Plugin support for BFD.
2 Copyright (C) 2009-2022 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_nearest_line_with_alt _bfd_nosymbols_find_nearest_line_with_alt
87 #define bfd_plugin_find_line _bfd_nosymbols_find_line
88 #define bfd_plugin_find_inliner_info _bfd_nosymbols_find_inliner_info
89 #define bfd_plugin_get_symbol_version_string _bfd_nosymbols_get_symbol_version_string
90 #define bfd_plugin_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
91 #define bfd_plugin_read_minisymbols _bfd_generic_read_minisymbols
92 #define bfd_plugin_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
93 #define bfd_plugin_set_arch_mach bfd_default_set_arch_mach
94 #define bfd_plugin_set_section_contents _bfd_generic_set_section_contents
95 #define bfd_plugin_bfd_get_relocated_section_contents bfd_generic_get_relocated_section_contents
96 #define bfd_plugin_bfd_relax_section bfd_generic_relax_section
97 #define bfd_plugin_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
98 #define bfd_plugin_bfd_link_add_symbols _bfd_generic_link_add_symbols
99 #define bfd_plugin_bfd_link_just_syms _bfd_generic_link_just_syms
100 #define bfd_plugin_bfd_final_link _bfd_generic_final_link
101 #define bfd_plugin_bfd_link_split_section _bfd_generic_link_split_section
102 #define bfd_plugin_bfd_gc_sections bfd_generic_gc_sections
103 #define bfd_plugin_bfd_lookup_section_flags bfd_generic_lookup_section_flags
104 #define bfd_plugin_bfd_merge_sections bfd_generic_merge_sections
105 #define bfd_plugin_bfd_is_group_section bfd_generic_is_group_section
106 #define bfd_plugin_bfd_group_name bfd_generic_group_name
107 #define bfd_plugin_bfd_discard_group bfd_generic_discard_group
108 #define bfd_plugin_section_already_linked _bfd_generic_section_already_linked
109 #define bfd_plugin_bfd_define_common_symbol bfd_generic_define_common_symbol
110 #define bfd_plugin_bfd_link_hide_symbol _bfd_generic_link_hide_symbol
111 #define bfd_plugin_bfd_define_start_stop bfd_generic_define_start_stop
112 #define bfd_plugin_bfd_copy_link_hash_symbol_type _bfd_generic_copy_link_hash_symbol_type
113 #define bfd_plugin_bfd_link_check_relocs _bfd_generic_link_check_relocs
115 static enum ld_plugin_status
116 message (int level ATTRIBUTE_UNUSED
,
117 const char * format
, ...)
120 va_start (args
, format
);
121 printf ("bfd plugin: ");
122 vprintf (format
, args
);
128 struct plugin_list_entry
130 /* These must be initialized for each IR object with LTO wrapper. */
131 ld_plugin_claim_file_handler claim_file
;
132 ld_plugin_all_symbols_read_handler all_symbols_read
;
133 ld_plugin_all_symbols_read_handler cleanup_handler
;
134 bool has_symbol_type
;
136 struct plugin_list_entry
*next
;
138 /* These can be reused for all IR objects. */
139 const char *plugin_name
;
142 static const char *plugin_program_name
;
145 bfd_plugin_set_program_name (const char *program_name
)
147 plugin_program_name
= program_name
;
150 static struct plugin_list_entry
*plugin_list
= NULL
;
151 static struct plugin_list_entry
*current_plugin
= NULL
;
153 /* Register a claim-file handler. */
155 static enum ld_plugin_status
156 register_claim_file (ld_plugin_claim_file_handler handler
)
158 current_plugin
->claim_file
= handler
;
162 static enum ld_plugin_status
163 add_symbols (void * handle
,
165 const struct ld_plugin_symbol
* syms
)
168 struct plugin_data_struct
*plugin_data
=
169 bfd_alloc (abfd
, sizeof (plugin_data_struct
));
174 plugin_data
->nsyms
= nsyms
;
175 plugin_data
->syms
= syms
;
178 abfd
->flags
|= HAS_SYMS
;
180 abfd
->tdata
.plugin_data
= plugin_data
;
184 static enum ld_plugin_status
185 add_symbols_v2 (void *handle
, int nsyms
,
186 const struct ld_plugin_symbol
*syms
)
188 current_plugin
->has_symbol_type
= true;
189 return add_symbols (handle
, nsyms
, syms
);
193 bfd_plugin_open_input (bfd
*ibfd
, struct ld_plugin_input_file
*file
)
199 while (iobfd
->my_archive
200 && !bfd_is_thin_archive (iobfd
->my_archive
))
201 iobfd
= iobfd
->my_archive
;
202 file
->name
= bfd_get_filename (iobfd
);
204 if (!iobfd
->iostream
&& !bfd_open_file (iobfd
))
207 /* Reuse the archive plugin file descriptor. */
209 fd
= iobfd
->archive_plugin_fd
;
215 /* The plugin API expects that the file descriptor won't be closed
216 and reused as done by the bfd file cache. So open it again.
217 dup isn't good enough. plugin IO uses lseek/read while BFD uses
218 fseek/fread. It isn't wise to mix the unistd and stdio calls on
219 the same underlying file descriptor. */
220 fd
= open (file
->name
, O_RDONLY
| O_BINARY
);
229 #ifdef HAVE_GETRLIMIT
232 /* Complicated links involving lots of files and/or large
233 archives can exhaust the number of file descriptors
234 available to us. If possible, try to allocate more
236 if (getrlimit (RLIMIT_NOFILE
, & lim
) == 0
237 && lim
.rlim_cur
< lim
.rlim_max
)
239 lim
.rlim_cur
= lim
.rlim_max
;
240 if (setrlimit (RLIMIT_NOFILE
, &lim
) == 0)
241 fd
= open (file
->name
, O_RDONLY
| O_BINARY
);
247 _bfd_error_handler (_("plugin framework: out of file descriptors. Try using fewer objects/archives\n"));
256 struct stat stat_buf
;
258 if (fstat (fd
, &stat_buf
))
265 file
->filesize
= stat_buf
.st_size
;
269 /* Cache the archive plugin file descriptor. */
270 iobfd
->archive_plugin_fd
= fd
;
271 iobfd
->archive_plugin_fd_open_count
++;
273 file
->offset
= ibfd
->origin
;
274 file
->filesize
= arelt_size (ibfd
);
281 /* Close the plugin file descriptor FD. If ABFD isn't NULL, it is an
285 bfd_plugin_close_file_descriptor (bfd
*abfd
, int fd
)
291 while (abfd
->my_archive
292 && !bfd_is_thin_archive (abfd
->my_archive
))
293 abfd
= abfd
->my_archive
;
295 /* Close the file descriptor if there is no archive plugin file
297 if (abfd
->archive_plugin_fd
== -1)
303 abfd
->archive_plugin_fd_open_count
--;
304 /* Dup the archive plugin file descriptor for later use, which
305 will be closed by _bfd_archive_close_and_cleanup. */
306 if (abfd
->archive_plugin_fd_open_count
== 0)
308 abfd
->archive_plugin_fd
= dup (fd
);
315 try_claim (bfd
*abfd
)
318 struct ld_plugin_input_file file
;
321 if (bfd_plugin_open_input (abfd
, &file
)
322 && current_plugin
->claim_file
)
324 current_plugin
->claim_file (&file
, &claimed
);
325 bfd_plugin_close_file_descriptor ((abfd
->my_archive
!= NULL
334 try_load_plugin (const char *pname
,
335 struct plugin_list_entry
*plugin_list_iter
,
340 struct ld_plugin_tv tv
[5];
342 ld_plugin_onload onload
;
343 enum ld_plugin_status status
;
346 /* NB: Each object is independent. Reuse the previous plugin from
347 the last run will lead to wrong result. */
349 memset (current_plugin
, 0,
350 offsetof (struct plugin_list_entry
, next
));
352 if (plugin_list_iter
)
353 pname
= plugin_list_iter
->plugin_name
;
355 plugin_handle
= dlopen (pname
, RTLD_NOW
);
358 /* If we are building a list of viable plugins, then
359 we do not bother the user with the details of any
360 plugins that cannot be loaded. */
362 _bfd_error_handler ("Failed to load plugin '%s', reason: %s\n",
367 if (plugin_list_iter
== NULL
)
369 size_t length_plugin_name
= strlen (pname
) + 1;
370 char *plugin_name
= bfd_malloc (length_plugin_name
);
372 if (plugin_name
== NULL
)
374 plugin_list_iter
= bfd_malloc (sizeof *plugin_list_iter
);
375 if (plugin_list_iter
== NULL
)
380 /* Make a copy of PNAME since PNAME from load_plugin () will be
382 memcpy (plugin_name
, pname
, length_plugin_name
);
383 memset (plugin_list_iter
, 0, sizeof (*plugin_list_iter
));
384 plugin_list_iter
->plugin_name
= plugin_name
;
385 plugin_list_iter
->next
= plugin_list
;
386 plugin_list
= plugin_list_iter
;
389 current_plugin
= plugin_list_iter
;
393 onload
= dlsym (plugin_handle
, "onload");
398 tv
[i
].tv_tag
= LDPT_MESSAGE
;
399 tv
[i
].tv_u
.tv_message
= message
;
402 tv
[i
].tv_tag
= LDPT_REGISTER_CLAIM_FILE_HOOK
;
403 tv
[i
].tv_u
.tv_register_claim_file
= register_claim_file
;
406 tv
[i
].tv_tag
= LDPT_ADD_SYMBOLS
;
407 tv
[i
].tv_u
.tv_add_symbols
= add_symbols
;
410 tv
[i
].tv_tag
= LDPT_ADD_SYMBOLS_V2
;
411 tv
[i
].tv_u
.tv_add_symbols
= add_symbols_v2
;
414 tv
[i
].tv_tag
= LDPT_NULL
;
415 tv
[i
].tv_u
.tv_val
= 0;
417 /* LTO plugin will call handler hooks to set up plugin handlers. */
418 status
= (*onload
)(tv
);
420 if (status
!= LDPS_OK
)
423 abfd
->plugin_format
= bfd_plugin_no
;
425 if (!current_plugin
->claim_file
)
428 if (!try_claim (abfd
))
431 abfd
->plugin_format
= bfd_plugin_yes
;
435 dlclose (plugin_handle
);
439 /* There may be plugin libraries in lib/bfd-plugins. */
440 static int has_plugin_list
= -1;
442 static bfd_cleanup (*ld_plugin_object_p
) (bfd
*);
444 static const char *plugin_name
;
447 bfd_plugin_set_plugin (const char *p
)
452 /* Return TRUE if a plugin library is used. */
455 bfd_plugin_specified_p (void)
457 return plugin_list
!= NULL
;
460 /* Return TRUE if ABFD can be claimed by linker LTO plugin. */
463 bfd_link_plugin_object_p (bfd
*abfd
)
465 if (ld_plugin_object_p
)
466 return ld_plugin_object_p (abfd
) != NULL
;
470 extern const bfd_target plugin_vec
;
472 /* Return TRUE if TARGET is a pointer to plugin_vec. */
475 bfd_plugin_target_p (const bfd_target
*target
)
477 return target
== &plugin_vec
;
480 /* Register OBJECT_P to be used by bfd_plugin_object_p. */
483 register_ld_plugin_object_p (bfd_cleanup (*object_p
) (bfd
*))
485 ld_plugin_object_p
= object_p
;
489 build_plugin_list (bfd
*abfd
)
491 /* The intent was to search ${libdir}/bfd-plugins for plugins, but
492 unfortunately the original implementation wasn't precisely that
493 when configuring binutils using --libdir. Search in the proper
494 path first, then the old one for backwards compatibility. */
495 static const char *path
[]
496 = { LIBDIR
"/bfd-plugins", BINDIR
"/../lib/bfd-plugins" };
500 if (has_plugin_list
>= 0)
503 /* Try not to search the same dir twice, by looking at st_dev and
504 st_ino for the dir. If we are on a file system that always sets
505 st_ino to zero or the actual st_ino is zero we might waste some
506 time, but that doesn't matter too much. */
509 for (i
= 0; i
< sizeof (path
) / sizeof (path
[0]); i
++)
511 char *plugin_dir
= make_relative_prefix (plugin_program_name
,
519 if (stat (plugin_dir
, &st
) == 0
520 && S_ISDIR (st
.st_mode
)
521 && !(last_st
.st_dev
== st
.st_dev
522 && last_st
.st_ino
== st
.st_ino
524 && (d
= opendir (plugin_dir
)) != NULL
)
528 last_st
.st_dev
= st
.st_dev
;
529 last_st
.st_ino
= st
.st_ino
;
530 while ((ent
= readdir (d
)) != NULL
)
534 full_name
= concat (plugin_dir
, "/", ent
->d_name
, NULL
);
535 if (stat (full_name
, &st
) == 0 && S_ISREG (st
.st_mode
))
536 (void) try_load_plugin (full_name
, NULL
, abfd
, true);
545 has_plugin_list
= plugin_list
!= NULL
;
549 load_plugin (bfd
*abfd
)
551 struct plugin_list_entry
*plugin_list_iter
;
554 return try_load_plugin (plugin_name
, plugin_list
, abfd
, false);
556 if (plugin_program_name
== NULL
)
559 build_plugin_list (abfd
);
561 for (plugin_list_iter
= plugin_list
;
563 plugin_list_iter
= plugin_list_iter
->next
)
564 if (try_load_plugin (NULL
, plugin_list_iter
, abfd
, false))
572 bfd_plugin_object_p (bfd
*abfd
)
574 if (ld_plugin_object_p
)
575 return ld_plugin_object_p (abfd
);
577 if (abfd
->plugin_format
== bfd_plugin_unknown
&& !load_plugin (abfd
))
580 return abfd
->plugin_format
== bfd_plugin_yes
? _bfd_no_cleanup
: NULL
;
583 /* Copy any private info we understand from the input bfd
584 to the output bfd. */
587 bfd_plugin_bfd_copy_private_bfd_data (bfd
*ibfd ATTRIBUTE_UNUSED
,
588 bfd
*obfd ATTRIBUTE_UNUSED
)
594 /* Copy any private info we understand from the input section
595 to the output section. */
598 bfd_plugin_bfd_copy_private_section_data (bfd
*ibfd ATTRIBUTE_UNUSED
,
599 asection
*isection ATTRIBUTE_UNUSED
,
600 bfd
*obfd ATTRIBUTE_UNUSED
,
601 asection
*osection ATTRIBUTE_UNUSED
)
607 /* Copy any private info we understand from the input symbol
608 to the output symbol. */
611 bfd_plugin_bfd_copy_private_symbol_data (bfd
*ibfd ATTRIBUTE_UNUSED
,
612 asymbol
*isymbol ATTRIBUTE_UNUSED
,
613 bfd
*obfd ATTRIBUTE_UNUSED
,
614 asymbol
*osymbol ATTRIBUTE_UNUSED
)
621 bfd_plugin_bfd_print_private_bfd_data (bfd
*abfd ATTRIBUTE_UNUSED
, void *ptr ATTRIBUTE_UNUSED
)
628 bfd_plugin_core_file_failing_command (bfd
*abfd ATTRIBUTE_UNUSED
)
635 bfd_plugin_core_file_failing_signal (bfd
*abfd ATTRIBUTE_UNUSED
)
642 bfd_plugin_core_file_pid (bfd
*abfd ATTRIBUTE_UNUSED
)
649 bfd_plugin_get_symtab_upper_bound (bfd
*abfd
)
651 struct plugin_data_struct
*plugin_data
= abfd
->tdata
.plugin_data
;
652 long nsyms
= plugin_data
->nsyms
;
654 BFD_ASSERT (nsyms
>= 0);
656 return ((nsyms
+ 1) * sizeof (asymbol
*));
660 convert_flags (const struct ld_plugin_symbol
*sym
)
671 return BSF_GLOBAL
| BSF_WEAK
;
680 bfd_plugin_canonicalize_symtab (bfd
*abfd
,
683 struct plugin_data_struct
*plugin_data
= abfd
->tdata
.plugin_data
;
684 long nsyms
= plugin_data
->nsyms
;
685 const struct ld_plugin_symbol
*syms
= plugin_data
->syms
;
686 static asection fake_text_section
687 = BFD_FAKE_SECTION (fake_text_section
, NULL
, "plug", 0,
688 SEC_ALLOC
| SEC_LOAD
| SEC_CODE
| SEC_HAS_CONTENTS
);
689 static asection fake_data_section
690 = BFD_FAKE_SECTION (fake_data_section
, NULL
, "plug", 0,
691 SEC_ALLOC
| SEC_LOAD
| SEC_DATA
| SEC_HAS_CONTENTS
);
692 static asection fake_bss_section
693 = BFD_FAKE_SECTION (fake_bss_section
, NULL
, "plug", 0,
695 static asection fake_common_section
696 = BFD_FAKE_SECTION (fake_common_section
, NULL
, "plug", 0, SEC_IS_COMMON
);
699 for (i
= 0; i
< nsyms
; i
++)
701 asymbol
*s
= bfd_alloc (abfd
, sizeof (asymbol
));
707 s
->name
= syms
[i
].name
;
709 s
->flags
= convert_flags (&syms
[i
]);
713 s
->section
= &fake_common_section
;
717 s
->section
= bfd_und_section_ptr
;
721 if (current_plugin
->has_symbol_type
)
722 switch (syms
[i
].symbol_type
)
725 /* FIXME: Should we issue an error here ? */
727 /* What is the best fake section for LDST_UNKNOWN? */
729 s
->section
= &fake_text_section
;
732 if (syms
[i
].section_kind
== LDSSK_BSS
)
733 s
->section
= &fake_bss_section
;
735 s
->section
= &fake_data_section
;
739 s
->section
= &fake_text_section
;
745 s
->udata
.p
= (void *) &syms
[i
];
752 bfd_plugin_print_symbol (bfd
*abfd ATTRIBUTE_UNUSED
,
753 void *afile ATTRIBUTE_UNUSED
,
754 asymbol
*symbol ATTRIBUTE_UNUSED
,
755 bfd_print_symbol_type how ATTRIBUTE_UNUSED
)
761 bfd_plugin_get_symbol_info (bfd
*abfd ATTRIBUTE_UNUSED
,
765 bfd_symbol_info (symbol
, ret
);
768 /* Make an empty symbol. */
771 bfd_plugin_make_empty_symbol (bfd
*abfd
)
773 asymbol
*new_symbol
= bfd_zalloc (abfd
, sizeof (asymbol
));
774 if (new_symbol
== NULL
)
776 new_symbol
->the_bfd
= abfd
;
781 bfd_plugin_sizeof_headers (bfd
*a ATTRIBUTE_UNUSED
,
782 struct bfd_link_info
*info ATTRIBUTE_UNUSED
)
788 const bfd_target plugin_vec
=
790 "plugin", /* Name. */
791 bfd_target_unknown_flavour
,
792 BFD_ENDIAN_LITTLE
, /* Target byte order. */
793 BFD_ENDIAN_LITTLE
, /* Target headers byte order. */
794 (HAS_RELOC
| EXEC_P
| /* Object flags. */
795 HAS_LINENO
| HAS_DEBUG
|
796 HAS_SYMS
| HAS_LOCALS
| DYNAMIC
| WP_TEXT
| D_PAGED
),
797 (SEC_CODE
| SEC_DATA
| SEC_ROM
| SEC_HAS_CONTENTS
798 | SEC_ALLOC
| SEC_LOAD
| SEC_RELOC
), /* Section flags. */
799 0, /* symbol_leading_char. */
800 '/', /* ar_pad_char. */
801 15, /* ar_max_namelen. */
802 255, /* match priority. */
803 TARGET_KEEP_UNUSED_SECTION_SYMBOLS
, /* keep unused section symbols. */
805 bfd_getl64
, bfd_getl_signed_64
, bfd_putl64
,
806 bfd_getl32
, bfd_getl_signed_32
, bfd_putl32
,
807 bfd_getl16
, bfd_getl_signed_16
, bfd_putl16
, /* data */
808 bfd_getl64
, bfd_getl_signed_64
, bfd_putl64
,
809 bfd_getl32
, bfd_getl_signed_32
, bfd_putl32
,
810 bfd_getl16
, bfd_getl_signed_16
, bfd_putl16
, /* hdrs */
812 { /* bfd_check_format. */
815 bfd_generic_archive_p
,
818 { /* bfd_set_format. */
819 _bfd_bool_bfd_false_error
,
820 _bfd_bool_bfd_false_error
,
821 _bfd_generic_mkarchive
,
822 _bfd_bool_bfd_false_error
,
824 { /* bfd_write_contents. */
825 _bfd_bool_bfd_false_error
,
826 _bfd_bool_bfd_false_error
,
827 _bfd_write_archive_contents
,
828 _bfd_bool_bfd_false_error
,
831 BFD_JUMP_TABLE_GENERIC (bfd_plugin
),
832 BFD_JUMP_TABLE_COPY (bfd_plugin
),
833 BFD_JUMP_TABLE_CORE (bfd_plugin
),
834 #ifdef USE_64_BIT_ARCHIVE
835 BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_64_bit
),
837 BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff
),
839 BFD_JUMP_TABLE_SYMBOLS (bfd_plugin
),
840 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs
),
841 BFD_JUMP_TABLE_WRITE (bfd_plugin
),
842 BFD_JUMP_TABLE_LINK (bfd_plugin
),
843 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic
),
847 NULL
/* backend_data. */
849 #endif /* BFD_SUPPORTS_PLUGINS */