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_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 /* Register a claim-file handler. */
128 static ld_plugin_claim_file_handler claim_file
= NULL
;
130 static enum ld_plugin_status
131 register_claim_file (ld_plugin_claim_file_handler handler
)
133 claim_file
= handler
;
137 static enum ld_plugin_status
138 add_symbols (void * handle
,
140 const struct ld_plugin_symbol
* syms
)
143 struct plugin_data_struct
*plugin_data
=
144 bfd_alloc (abfd
, sizeof (plugin_data_struct
));
146 plugin_data
->nsyms
= nsyms
;
147 plugin_data
->syms
= syms
;
150 abfd
->flags
|= HAS_SYMS
;
152 abfd
->tdata
.plugin_data
= plugin_data
;
156 static const char *plugin_program_name
;
159 bfd_plugin_set_program_name (const char *program_name
)
161 plugin_program_name
= program_name
;
165 bfd_plugin_open_input (bfd
*ibfd
, struct ld_plugin_input_file
*file
)
170 while (iobfd
->my_archive
171 && !bfd_is_thin_archive (iobfd
->my_archive
))
172 iobfd
= iobfd
->my_archive
;
173 file
->name
= iobfd
->filename
;
175 if (!iobfd
->iostream
&& !bfd_open_file (iobfd
))
178 /* The plugin API expects that the file descriptor won't be closed
179 and reused as done by the bfd file cache. So open it again.
180 dup isn't good enough. plugin IO uses lseek/read while BFD uses
181 fseek/fread. It isn't wise to mix the unistd and stdio calls on
182 the same underlying file descriptor. */
183 file
->fd
= open (file
->name
, O_RDONLY
| O_BINARY
);
189 struct stat stat_buf
;
191 if (fstat (file
->fd
, &stat_buf
))
198 file
->filesize
= stat_buf
.st_size
;
202 file
->offset
= ibfd
->origin
;
203 file
->filesize
= arelt_size (ibfd
);
209 try_claim (bfd
*abfd
)
212 struct ld_plugin_input_file file
;
215 if (!bfd_plugin_open_input (abfd
, &file
))
218 claim_file (&file
, &claimed
);
223 struct plugin_list_entry
226 ld_plugin_claim_file_handler claim_file
;
227 struct plugin_list_entry
* next
;
230 static struct plugin_list_entry
* plugin_list
= NULL
;
233 try_load_plugin (const char *pname
, bfd
*abfd
, int *has_plugin_p
)
235 void *plugin_handle
= NULL
;
236 struct ld_plugin_tv tv
[4];
238 ld_plugin_onload onload
;
239 enum ld_plugin_status status
;
240 struct plugin_list_entry
*plugin_list_iter
;
244 plugin_handle
= dlopen (pname
, RTLD_NOW
);
247 _bfd_error_handler ("%s\n", dlerror ());
251 for (plugin_list_iter
= plugin_list
;
253 plugin_list_iter
= plugin_list_iter
->next
)
255 if (plugin_handle
== plugin_list_iter
->handle
)
257 dlclose (plugin_handle
);
258 if (!plugin_list_iter
->claim_file
)
261 register_claim_file (plugin_list_iter
->claim_file
);
262 goto have_claim_file
;
266 plugin_list_iter
= bfd_malloc (sizeof *plugin_list_iter
);
267 if (plugin_list_iter
== NULL
)
269 plugin_list_iter
->handle
= plugin_handle
;
270 plugin_list_iter
->claim_file
= NULL
;
271 plugin_list_iter
->next
= plugin_list
;
272 plugin_list
= plugin_list_iter
;
274 onload
= dlsym (plugin_handle
, "onload");
279 tv
[i
].tv_tag
= LDPT_MESSAGE
;
280 tv
[i
].tv_u
.tv_message
= message
;
283 tv
[i
].tv_tag
= LDPT_REGISTER_CLAIM_FILE_HOOK
;
284 tv
[i
].tv_u
.tv_register_claim_file
= register_claim_file
;
287 tv
[i
].tv_tag
= LDPT_ADD_SYMBOLS
;
288 tv
[i
].tv_u
.tv_add_symbols
= add_symbols
;
291 tv
[i
].tv_tag
= LDPT_NULL
;
292 tv
[i
].tv_u
.tv_val
= 0;
294 status
= (*onload
)(tv
);
296 if (status
!= LDPS_OK
)
299 plugin_list_iter
->claim_file
= claim_file
;
304 abfd
->plugin_format
= bfd_plugin_no
;
309 if (!try_claim (abfd
))
312 abfd
->plugin_format
= bfd_plugin_yes
;
316 /* There may be plugin libraries in lib/bfd-plugins. */
318 static int has_plugin
= -1;
320 static const bfd_target
*(*ld_plugin_object_p
) (bfd
*);
322 static const char *plugin_name
;
325 bfd_plugin_set_plugin (const char *p
)
328 has_plugin
= p
!= NULL
;
331 /* Return TRUE if a plugin library is used. */
334 bfd_plugin_specified_p (void)
336 return has_plugin
> 0;
339 /* Return TRUE if ABFD can be claimed by linker LTO plugin. */
342 bfd_link_plugin_object_p (bfd
*abfd
)
344 if (ld_plugin_object_p
)
345 return ld_plugin_object_p (abfd
) != NULL
;
349 extern const bfd_target plugin_vec
;
351 /* Return TRUE if TARGET is a pointer to plugin_vec. */
354 bfd_plugin_target_p (const bfd_target
*target
)
356 return target
== &plugin_vec
;
359 /* Register OBJECT_P to be used by bfd_plugin_object_p. */
362 register_ld_plugin_object_p (const bfd_target
*(*object_p
) (bfd
*))
364 ld_plugin_object_p
= object_p
;
368 load_plugin (bfd
*abfd
)
370 /* The intent was to search ${libdir}/bfd-plugins for plugins, but
371 unfortunately the original implementation wasn't precisely that
372 when configuring binutils using --libdir. Search in the proper
373 path first, then the old one for backwards compatibility. */
374 static const char *path
[]
375 = { LIBDIR
"/bfd-plugins", BINDIR
"/../lib/bfd-plugins" };
384 return try_load_plugin (plugin_name
, abfd
, &has_plugin
);
386 if (plugin_program_name
== NULL
)
389 /* Try not to search the same dir twice, by looking at st_dev and
390 st_ino for the dir. If we are on a file system that always sets
391 st_ino to zero or the actual st_ino is zero we might waste some
392 time, but that doesn't matter too much. */
395 for (i
= 0; i
< sizeof (path
) / sizeof (path
[0]); i
++)
397 char *plugin_dir
= make_relative_prefix (plugin_program_name
,
405 if (stat (plugin_dir
, &st
) == 0
406 && S_ISDIR (st
.st_mode
)
407 && !(last_st
.st_dev
== st
.st_dev
408 && last_st
.st_ino
== st
.st_ino
410 && (d
= opendir (plugin_dir
)) != NULL
)
414 last_st
.st_dev
= st
.st_dev
;
415 last_st
.st_ino
= st
.st_ino
;
416 while ((ent
= readdir (d
)) != NULL
)
420 full_name
= concat (plugin_dir
, "/", ent
->d_name
, NULL
);
421 if (stat (full_name
, &st
) == 0 && S_ISREG (st
.st_mode
))
425 found
= try_load_plugin (full_name
, abfd
, &valid_plugin
);
427 has_plugin
= valid_plugin
;
445 static const bfd_target
*
446 bfd_plugin_object_p (bfd
*abfd
)
448 if (ld_plugin_object_p
)
449 return ld_plugin_object_p (abfd
);
451 if (abfd
->plugin_format
== bfd_plugin_unknown
&& !load_plugin (abfd
))
454 return abfd
->plugin_format
== bfd_plugin_yes
? abfd
->xvec
: NULL
;
457 /* Copy any private info we understand from the input bfd
458 to the output bfd. */
461 bfd_plugin_bfd_copy_private_bfd_data (bfd
*ibfd ATTRIBUTE_UNUSED
,
462 bfd
*obfd ATTRIBUTE_UNUSED
)
468 /* Copy any private info we understand from the input section
469 to the output section. */
472 bfd_plugin_bfd_copy_private_section_data (bfd
*ibfd ATTRIBUTE_UNUSED
,
473 asection
*isection ATTRIBUTE_UNUSED
,
474 bfd
*obfd ATTRIBUTE_UNUSED
,
475 asection
*osection ATTRIBUTE_UNUSED
)
481 /* Copy any private info we understand from the input symbol
482 to the output symbol. */
485 bfd_plugin_bfd_copy_private_symbol_data (bfd
*ibfd ATTRIBUTE_UNUSED
,
486 asymbol
*isymbol ATTRIBUTE_UNUSED
,
487 bfd
*obfd ATTRIBUTE_UNUSED
,
488 asymbol
*osymbol ATTRIBUTE_UNUSED
)
495 bfd_plugin_bfd_print_private_bfd_data (bfd
*abfd ATTRIBUTE_UNUSED
, PTR ptr ATTRIBUTE_UNUSED
)
502 bfd_plugin_core_file_failing_command (bfd
*abfd ATTRIBUTE_UNUSED
)
509 bfd_plugin_core_file_failing_signal (bfd
*abfd ATTRIBUTE_UNUSED
)
516 bfd_plugin_core_file_pid (bfd
*abfd ATTRIBUTE_UNUSED
)
523 bfd_plugin_get_symtab_upper_bound (bfd
*abfd
)
525 struct plugin_data_struct
*plugin_data
= abfd
->tdata
.plugin_data
;
526 long nsyms
= plugin_data
->nsyms
;
528 BFD_ASSERT (nsyms
>= 0);
530 return ((nsyms
+ 1) * sizeof (asymbol
*));
534 convert_flags (const struct ld_plugin_symbol
*sym
)
545 return BSF_GLOBAL
| BSF_WEAK
;
554 bfd_plugin_canonicalize_symtab (bfd
*abfd
,
557 struct plugin_data_struct
*plugin_data
= abfd
->tdata
.plugin_data
;
558 long nsyms
= plugin_data
->nsyms
;
559 const struct ld_plugin_symbol
*syms
= plugin_data
->syms
;
560 static asection fake_section
561 = BFD_FAKE_SECTION (fake_section
, NULL
, "plug", 0,
562 SEC_ALLOC
| SEC_LOAD
| SEC_CODE
| SEC_HAS_CONTENTS
);
563 static asection fake_common_section
564 = BFD_FAKE_SECTION (fake_common_section
, NULL
, "plug", 0, SEC_IS_COMMON
);
567 for (i
= 0; i
< nsyms
; i
++)
569 asymbol
*s
= bfd_alloc (abfd
, sizeof (asymbol
));
575 s
->name
= syms
[i
].name
;
577 s
->flags
= convert_flags (&syms
[i
]);
581 s
->section
= &fake_common_section
;
585 s
->section
= bfd_und_section_ptr
;
589 s
->section
= &fake_section
;
595 s
->udata
.p
= (void *) &syms
[i
];
602 bfd_plugin_print_symbol (bfd
*abfd ATTRIBUTE_UNUSED
,
603 PTR afile ATTRIBUTE_UNUSED
,
604 asymbol
*symbol ATTRIBUTE_UNUSED
,
605 bfd_print_symbol_type how ATTRIBUTE_UNUSED
)
611 bfd_plugin_get_symbol_info (bfd
*abfd ATTRIBUTE_UNUSED
,
615 bfd_symbol_info (symbol
, ret
);
618 /* Make an empty symbol. */
621 bfd_plugin_make_empty_symbol (bfd
*abfd
)
623 asymbol
*new_symbol
= bfd_zalloc (abfd
, sizeof (asymbol
));
624 if (new_symbol
== NULL
)
626 new_symbol
->the_bfd
= abfd
;
631 bfd_plugin_sizeof_headers (bfd
*a ATTRIBUTE_UNUSED
,
632 struct bfd_link_info
*info ATTRIBUTE_UNUSED
)
638 const bfd_target plugin_vec
=
640 "plugin", /* Name. */
641 bfd_target_unknown_flavour
,
642 BFD_ENDIAN_LITTLE
, /* Target byte order. */
643 BFD_ENDIAN_LITTLE
, /* Target headers byte order. */
644 (HAS_RELOC
| EXEC_P
| /* Object flags. */
645 HAS_LINENO
| HAS_DEBUG
|
646 HAS_SYMS
| HAS_LOCALS
| DYNAMIC
| WP_TEXT
| D_PAGED
),
647 (SEC_CODE
| SEC_DATA
| SEC_ROM
| SEC_HAS_CONTENTS
648 | SEC_ALLOC
| SEC_LOAD
| SEC_RELOC
), /* Section flags. */
649 0, /* symbol_leading_char. */
650 '/', /* ar_pad_char. */
651 15, /* ar_max_namelen. */
652 255, /* match priority. */
654 bfd_getl64
, bfd_getl_signed_64
, bfd_putl64
,
655 bfd_getl32
, bfd_getl_signed_32
, bfd_putl32
,
656 bfd_getl16
, bfd_getl_signed_16
, bfd_putl16
, /* data */
657 bfd_getl64
, bfd_getl_signed_64
, bfd_putl64
,
658 bfd_getl32
, bfd_getl_signed_32
, bfd_putl32
,
659 bfd_getl16
, bfd_getl_signed_16
, bfd_putl16
, /* hdrs */
661 { /* bfd_check_format. */
664 bfd_generic_archive_p
,
667 { /* bfd_set_format. */
668 _bfd_bool_bfd_false_error
,
669 _bfd_bool_bfd_false_error
,
670 _bfd_generic_mkarchive
,
671 _bfd_bool_bfd_false_error
,
673 { /* bfd_write_contents. */
674 _bfd_bool_bfd_false_error
,
675 _bfd_bool_bfd_false_error
,
676 _bfd_write_archive_contents
,
677 _bfd_bool_bfd_false_error
,
680 BFD_JUMP_TABLE_GENERIC (bfd_plugin
),
681 BFD_JUMP_TABLE_COPY (bfd_plugin
),
682 BFD_JUMP_TABLE_CORE (bfd_plugin
),
683 #ifdef USE_64_BIT_ARCHIVE
684 BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_64_bit
),
686 BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff
),
688 BFD_JUMP_TABLE_SYMBOLS (bfd_plugin
),
689 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs
),
690 BFD_JUMP_TABLE_WRITE (bfd_plugin
),
691 BFD_JUMP_TABLE_LINK (bfd_plugin
),
692 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic
),
696 NULL
/* backend_data. */
698 #endif /* BFD_SUPPORTS_PLUGIN */