1 /* Test plugin for the GNU linker.
2 Copyright (C) 2010-2021 Free Software Foundation, Inc.
4 This file is part of the GNU Binutils.
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. */
23 #if BFD_SUPPORTS_PLUGINS
24 #include "plugin-api.h"
25 /* For ARRAY_SIZE macro only - we don't link the library itself. */
26 #include "libiberty.h"
28 #include <ctype.h> /* For isdigit. */
30 extern enum ld_plugin_status
onload (struct ld_plugin_tv
*tv
);
31 static enum ld_plugin_status
onclaim_file (const struct ld_plugin_input_file
*file
,
33 static enum ld_plugin_status
onall_symbols_read (void);
34 static enum ld_plugin_status
oncleanup (void);
36 /* Helper for calling plugin api message function. */
37 #define TV_MESSAGE if (tv_message) (*tv_message)
39 /* Struct for recording files to claim / files claimed. */
40 typedef struct claim_file
42 struct claim_file
*next
;
43 struct ld_plugin_input_file file
;
45 struct ld_plugin_symbol
*symbols
;
50 /* Types of things that can be added at all symbols read time. */
51 typedef enum addfile_enum
58 /* Struct for recording files to add to final link. */
59 typedef struct add_file
61 struct add_file
*next
;
66 /* Helper macro for defining array of transfer vector tags and names. */
67 #define ADDENTRY(tag) { tag, #tag }
69 /* Struct for looking up human-readable versions of tag names. */
70 typedef struct tag_name
72 enum ld_plugin_tag tag
;
76 /* Array of all known tags and their names. */
77 static const tag_name_t tag_names
[] =
80 ADDENTRY(LDPT_API_VERSION
),
81 ADDENTRY(LDPT_GOLD_VERSION
),
82 ADDENTRY(LDPT_LINKER_OUTPUT
),
83 ADDENTRY(LDPT_OPTION
),
84 ADDENTRY(LDPT_REGISTER_CLAIM_FILE_HOOK
),
85 ADDENTRY(LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK
),
86 ADDENTRY(LDPT_REGISTER_CLEANUP_HOOK
),
87 ADDENTRY(LDPT_ADD_SYMBOLS
),
88 ADDENTRY(LDPT_GET_SYMBOLS
),
89 ADDENTRY(LDPT_GET_SYMBOLS_V2
),
90 ADDENTRY(LDPT_ADD_INPUT_FILE
),
91 ADDENTRY(LDPT_MESSAGE
),
92 ADDENTRY(LDPT_GET_INPUT_FILE
),
93 ADDENTRY(LDPT_GET_VIEW
),
94 ADDENTRY(LDPT_RELEASE_INPUT_FILE
),
95 ADDENTRY(LDPT_ADD_INPUT_LIBRARY
),
96 ADDENTRY(LDPT_OUTPUT_NAME
),
97 ADDENTRY(LDPT_SET_EXTRA_LIBRARY_PATH
),
98 ADDENTRY(LDPT_GNU_LD_VERSION
)
101 /* Function pointers to cache hooks passed at onload time. */
102 static ld_plugin_register_claim_file tv_register_claim_file
= 0;
103 static ld_plugin_register_all_symbols_read tv_register_all_symbols_read
= 0;
104 static ld_plugin_register_cleanup tv_register_cleanup
= 0;
105 static ld_plugin_add_symbols tv_add_symbols
= 0;
106 static ld_plugin_get_symbols tv_get_symbols
= 0;
107 static ld_plugin_get_symbols tv_get_symbols_v2
= 0;
108 static ld_plugin_add_input_file tv_add_input_file
= 0;
109 static ld_plugin_message tv_message
= 0;
110 static ld_plugin_get_input_file tv_get_input_file
= 0;
111 static ld_plugin_get_view tv_get_view
= 0;
112 static ld_plugin_release_input_file tv_release_input_file
= 0;
113 static ld_plugin_add_input_library tv_add_input_library
= 0;
114 static ld_plugin_set_extra_library_path tv_set_extra_library_path
= 0;
116 /* Other cached info from the transfer vector. */
117 static enum ld_plugin_output_file_type linker_output
;
118 static const char *output_name
;
120 /* Behaviour control flags set by plugin options. */
121 static enum ld_plugin_status onload_ret
= LDPS_OK
;
122 static enum ld_plugin_status claim_file_ret
= LDPS_OK
;
123 static enum ld_plugin_status all_symbols_read_ret
= LDPS_OK
;
124 static enum ld_plugin_status cleanup_ret
= LDPS_OK
;
125 static bool register_claimfile_hook
= false;
126 static bool register_allsymbolsread_hook
= false;
127 static bool register_cleanup_hook
= false;
128 static bool dumpresolutions
= false;
130 /* The master list of all claimable/claimed files. */
131 static claim_file_t
*claimfiles_list
= NULL
;
133 /* We keep a tail pointer for easy linking on the end. */
134 static claim_file_t
**claimfiles_tail_chain_ptr
= &claimfiles_list
;
136 /* The last claimed file added to the list, for receiving syms. */
137 static claim_file_t
*last_claimfile
= NULL
;
139 /* The master list of all files to add to the final link. */
140 static add_file_t
*addfiles_list
= NULL
;
142 /* We keep a tail pointer for easy linking on the end. */
143 static add_file_t
**addfiles_tail_chain_ptr
= &addfiles_list
;
145 /* Number of bytes read in claim file before deciding if the file can be
147 static int bytes_to_read_before_claim
= 0;
149 /* Add a new claimfile on the end of the chain. */
150 static enum ld_plugin_status
151 record_claim_file (const char *file
)
153 claim_file_t
*newfile
;
155 newfile
= malloc (sizeof *newfile
);
158 memset (newfile
, 0, sizeof *newfile
);
159 /* Only setup for now is remembering the name to look for. */
160 newfile
->file
.name
= file
;
161 /* Chain it on the end of the list. */
162 *claimfiles_tail_chain_ptr
= newfile
;
163 claimfiles_tail_chain_ptr
= &newfile
->next
;
164 /* Record it as active for receiving symbols to register. */
165 last_claimfile
= newfile
;
169 /* How many bytes to read before claiming (or not) an input file. */
170 static enum ld_plugin_status
171 record_read_length (const char *length
)
176 while (*tmp
!= '\0' && isdigit (*tmp
))
178 if (*tmp
!= '\0' || *length
== '\0')
181 bytes_to_read_before_claim
= atoi (length
);
185 /* Add a new addfile on the end of the chain. */
186 static enum ld_plugin_status
187 record_add_file (const char *file
, addfile_enum_t type
)
191 newfile
= malloc (sizeof *newfile
);
194 newfile
->next
= NULL
;
195 newfile
->name
= file
;
196 newfile
->type
= type
;
197 /* Chain it on the end of the list. */
198 *addfiles_tail_chain_ptr
= newfile
;
199 addfiles_tail_chain_ptr
= &newfile
->next
;
203 /* Parse a command-line argument string into a symbol definition.
204 Symbol-strings follow the colon-separated format:
205 NAME:VERSION:def:vis:size:COMDATKEY
206 where the fields in capitals are strings and those in lower
207 case are integers. We don't allow to specify a resolution as
208 doing so is not meaningful when calling the add symbols hook. */
209 static enum ld_plugin_status
210 parse_symdefstr (const char *str
, struct ld_plugin_symbol
*sym
)
214 const char *colon1
, *colon2
, *colon5
;
216 /* Locate the colons separating the first two strings. */
217 colon1
= strchr (str
, ':');
220 colon2
= strchr (colon1
+1, ':');
223 /* Name must not be empty (version may be). */
227 /* The fifth colon and trailing comdat key string are optional,
228 but the intermediate ones must all be present. */
229 colon5
= strchr (colon2
+1, ':'); /* Actually only third so far. */
232 colon5
= strchr (colon5
+1, ':'); /* Hopefully fourth now. */
235 colon5
= strchr (colon5
+1, ':'); /* Optional fifth now. */
237 /* Finally we'll use sscanf to parse the numeric fields, then
238 we'll split out the strings which we need to allocate separate
239 storage for anyway so that we can add nul termination. */
240 n
= sscanf (colon2
+ 1, "%hhi:%i:%lli", &sym
->def
, &sym
->visibility
, &size
);
244 /* Parsed successfully, so allocate strings and fill out fields. */
247 sym
->section_kind
= 0;
248 sym
->symbol_type
= 0;
249 sym
->resolution
= LDPR_UNKNOWN
;
250 sym
->name
= malloc (colon1
- str
+ 1);
253 memcpy (sym
->name
, str
, colon1
- str
);
254 sym
->name
[colon1
- str
] = '\0';
255 if (colon2
> (colon1
+ 1))
257 sym
->version
= malloc (colon2
- colon1
);
260 memcpy (sym
->version
, colon1
+ 1, colon2
- (colon1
+ 1));
261 sym
->version
[colon2
- (colon1
+ 1)] = '\0';
265 if (colon5
&& colon5
[1])
267 sym
->comdat_key
= malloc (strlen (colon5
+ 1) + 1);
268 if (!sym
->comdat_key
)
270 strcpy (sym
->comdat_key
, colon5
+ 1);
277 /* Record a symbol to be added for the last-added claimfile. */
278 static enum ld_plugin_status
279 record_claimed_file_symbol (const char *symdefstr
)
281 struct ld_plugin_symbol sym
;
283 /* Can't add symbols except as belonging to claimed files. */
287 /* If string doesn't parse correctly, give an error. */
288 if (parse_symdefstr (symdefstr
, &sym
) != LDPS_OK
)
291 /* Check for enough space, resize array if needed, and add it. */
292 if (last_claimfile
->n_syms_allocated
== last_claimfile
->n_syms_used
)
294 int new_n_syms
= last_claimfile
->n_syms_allocated
295 ? 2 * last_claimfile
->n_syms_allocated
297 last_claimfile
->symbols
= realloc (last_claimfile
->symbols
,
298 new_n_syms
* sizeof *last_claimfile
->symbols
);
299 if (!last_claimfile
->symbols
)
301 last_claimfile
->n_syms_allocated
= new_n_syms
;
303 last_claimfile
->symbols
[last_claimfile
->n_syms_used
++] = sym
;
308 /* Records the status to return from one of the registered hooks. */
309 static enum ld_plugin_status
310 set_ret_val (const char *whichval
, enum ld_plugin_status retval
)
312 if (!strcmp ("onload", whichval
))
314 else if (!strcmp ("claimfile", whichval
))
315 claim_file_ret
= retval
;
316 else if (!strcmp ("allsymbolsread", whichval
))
317 all_symbols_read_ret
= retval
;
318 else if (!strcmp ("cleanup", whichval
))
319 cleanup_ret
= retval
;
325 /* Records hooks which should be registered. */
326 static enum ld_plugin_status
327 set_register_hook (const char *whichhook
, bool yesno
)
329 if (!strcmp ("claimfile", whichhook
))
330 register_claimfile_hook
= yesno
;
331 else if (!strcmp ("allsymbolsread", whichhook
))
332 register_allsymbolsread_hook
= yesno
;
333 else if (!strcmp ("cleanup", whichhook
))
334 register_cleanup_hook
= yesno
;
340 /* Determine type of plugin option and pass to individual parsers. */
341 static enum ld_plugin_status
342 parse_option (const char *opt
)
344 if (!strncmp ("fail", opt
, 4))
345 return set_ret_val (opt
+ 4, LDPS_ERR
);
346 else if (!strncmp ("pass", opt
, 4))
347 return set_ret_val (opt
+ 4, LDPS_OK
);
348 else if (!strncmp ("register", opt
, 8))
349 return set_register_hook (opt
+ 8, true);
350 else if (!strncmp ("noregister", opt
, 10))
351 return set_register_hook (opt
+ 10, false);
352 else if (!strncmp ("claim:", opt
, 6))
353 return record_claim_file (opt
+ 6);
354 else if (!strncmp ("read:", opt
, 5))
355 return record_read_length (opt
+ 5);
356 else if (!strncmp ("sym:", opt
, 4))
357 return record_claimed_file_symbol (opt
+ 4);
358 else if (!strncmp ("add:", opt
, 4))
359 return record_add_file (opt
+ 4, ADD_FILE
);
360 else if (!strncmp ("lib:", opt
, 4))
361 return record_add_file (opt
+ 4, ADD_LIB
);
362 else if (!strncmp ("dir:", opt
, 4))
363 return record_add_file (opt
+ 4, ADD_DIR
);
364 else if (!strcmp ("dumpresolutions", opt
))
365 dumpresolutions
= true;
371 /* Output contents of transfer vector array entry in human-readable form. */
373 dump_tv_tag (size_t n
, struct ld_plugin_tv
*tv
)
379 for (tag
= 0; tag
< ARRAY_SIZE (tag_names
); tag
++)
380 if (tag_names
[tag
].tag
== tv
->tv_tag
)
382 sprintf (unknownbuf
, "unknown tag #%d", tv
->tv_tag
);
383 name
= (tag
< ARRAY_SIZE (tag_names
)) ? tag_names
[tag
].name
: unknownbuf
;
387 case LDPT_OUTPUT_NAME
:
388 TV_MESSAGE (LDPL_INFO
, "tv[%d]: %s '%s'", n
, name
,
391 case LDPT_REGISTER_CLAIM_FILE_HOOK
:
392 case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK
:
393 case LDPT_REGISTER_CLEANUP_HOOK
:
394 case LDPT_ADD_SYMBOLS
:
395 case LDPT_GET_SYMBOLS
:
396 case LDPT_GET_SYMBOLS_V2
:
397 case LDPT_ADD_INPUT_FILE
:
399 case LDPT_GET_INPUT_FILE
:
401 case LDPT_RELEASE_INPUT_FILE
:
402 case LDPT_ADD_INPUT_LIBRARY
:
403 case LDPT_SET_EXTRA_LIBRARY_PATH
:
404 TV_MESSAGE (LDPL_INFO
, "tv[%d]: %s func@0x%p", n
, name
,
405 (void *)(tv
->tv_u
.tv_message
));
408 case LDPT_API_VERSION
:
409 case LDPT_GOLD_VERSION
:
410 case LDPT_LINKER_OUTPUT
:
411 case LDPT_GNU_LD_VERSION
:
413 TV_MESSAGE (LDPL_INFO
, "tv[%d]: %s value %W (%d)", n
, name
,
414 (bfd_vma
)tv
->tv_u
.tv_val
, tv
->tv_u
.tv_val
);
419 /* Handle/record information received in a transfer vector entry. */
420 static enum ld_plugin_status
421 parse_tv_tag (struct ld_plugin_tv
*tv
)
423 #define SETVAR(x) x = tv->tv_u.x
427 return parse_option (tv
->tv_u
.tv_string
);
429 case LDPT_GOLD_VERSION
:
430 case LDPT_GNU_LD_VERSION
:
431 case LDPT_API_VERSION
:
434 case LDPT_OUTPUT_NAME
:
435 output_name
= tv
->tv_u
.tv_string
;
437 case LDPT_LINKER_OUTPUT
:
438 linker_output
= tv
->tv_u
.tv_val
;
440 case LDPT_REGISTER_CLAIM_FILE_HOOK
:
441 SETVAR(tv_register_claim_file
);
443 case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK
:
444 SETVAR(tv_register_all_symbols_read
);
446 case LDPT_REGISTER_CLEANUP_HOOK
:
447 SETVAR(tv_register_cleanup
);
449 case LDPT_ADD_SYMBOLS
:
450 SETVAR(tv_add_symbols
);
452 case LDPT_GET_SYMBOLS
:
453 SETVAR(tv_get_symbols
);
455 case LDPT_GET_SYMBOLS_V2
:
456 tv_get_symbols_v2
= tv
->tv_u
.tv_get_symbols
;
458 case LDPT_ADD_INPUT_FILE
:
459 SETVAR(tv_add_input_file
);
464 case LDPT_GET_INPUT_FILE
:
465 SETVAR(tv_get_input_file
);
470 case LDPT_RELEASE_INPUT_FILE
:
471 SETVAR(tv_release_input_file
);
473 case LDPT_ADD_INPUT_LIBRARY
:
474 SETVAR(tv_add_input_library
);
476 case LDPT_SET_EXTRA_LIBRARY_PATH
:
477 SETVAR(tv_set_extra_library_path
);
484 /* Record any useful information in transfer vector entry and display
485 it in human-readable form using the plugin API message() callback. */
486 enum ld_plugin_status
487 parse_and_dump_tv_tag (size_t n
, struct ld_plugin_tv
*tv
)
489 enum ld_plugin_status rv
= parse_tv_tag (tv
);
494 /* Standard plugin API entry point. */
495 enum ld_plugin_status
496 onload (struct ld_plugin_tv
*tv
)
499 enum ld_plugin_status rv
;
501 /* This plugin does nothing but dump the tv array. It would
502 be an error if this function was called without one. */
506 /* First entry should always be LDPT_MESSAGE, letting us get
507 hold of it easily so we can send output straight away. */
508 if (tv
[0].tv_tag
== LDPT_MESSAGE
)
509 tv_message
= tv
[0].tv_u
.tv_message
;
512 TV_MESSAGE (LDPL_INFO
, "Hello from testplugin.");
515 if ((rv
= parse_and_dump_tv_tag (n
++, tv
)) != LDPS_OK
)
517 while ((tv
++)->tv_tag
!= LDPT_NULL
);
519 /* Register hooks only if instructed by options. */
520 if (register_claimfile_hook
)
522 if (!tv_register_claim_file
)
524 TV_MESSAGE (LDPL_FATAL
, "No register_claim_file hook");
528 (*tv_register_claim_file
) (onclaim_file
);
530 if (register_allsymbolsread_hook
)
532 if (!tv_register_all_symbols_read
)
534 TV_MESSAGE (LDPL_FATAL
, "No register_all_symbols_read hook");
538 (*tv_register_all_symbols_read
) (onall_symbols_read
);
540 if (register_cleanup_hook
)
542 if (!tv_register_cleanup
)
544 TV_MESSAGE (LDPL_FATAL
, "No register_cleanup hook");
548 (*tv_register_cleanup
) (oncleanup
);
554 /* Standard plugin API registerable hook. */
555 static enum ld_plugin_status
556 onclaim_file (const struct ld_plugin_input_file
*file
, int *claimed
)
558 /* Possible read of some bytes out of the input file into a buffer. This
559 simulates a plugin that reads some file content in order to decide if
560 the file should be claimed or not. */
561 if (bytes_to_read_before_claim
> 0)
563 char *buffer
= malloc (bytes_to_read_before_claim
);
567 if (read (file
->fd
, buffer
, bytes_to_read_before_claim
) < 0)
572 /* Let's see if we want to claim this file. */
573 claim_file_t
*claimfile
= claimfiles_list
;
576 if (!strcmp (file
->name
, claimfile
->file
.name
))
578 claimfile
= claimfile
->next
;
581 /* Inform the user/testsuite. */
582 TV_MESSAGE (LDPL_INFO
, "hook called: claim_file %s [@%ld/%ld] %s",
583 file
->name
, (long)file
->offset
, (long)file
->filesize
,
584 claimfile
? "CLAIMED" : "not claimed");
587 /* If we decided to claim it, record that fact, and add any symbols
588 that were defined for it by plugin options. */
589 *claimed
= (claimfile
!= 0);
592 claimfile
->claimed
= true;
593 claimfile
->file
= *file
;
594 if (claimfile
->n_syms_used
&& !tv_add_symbols
)
596 else if (claimfile
->n_syms_used
)
597 return (*tv_add_symbols
) (claimfile
->file
.handle
,
598 claimfile
->n_syms_used
, claimfile
->symbols
);
601 return claim_file_ret
;
604 /* Standard plugin API registerable hook. */
605 static enum ld_plugin_status
606 onall_symbols_read (void)
608 static const char *resolutions
[] =
612 "LDPR_PREVAILING_DEF",
613 "LDPR_PREVAILING_DEF_IRONLY",
614 "LDPR_PREEMPTED_REG",
617 "LDPR_RESOLVED_EXEC",
619 "LDPR_PREVAILING_DEF_IRONLY_EXP",
621 claim_file_t
*claimfile
= dumpresolutions
? claimfiles_list
: NULL
;
622 add_file_t
*addfile
= addfiles_list
;
623 TV_MESSAGE (LDPL_INFO
, "hook called: all symbols read.");
624 for ( ; claimfile
; claimfile
= claimfile
->next
)
626 enum ld_plugin_status rv
;
628 if (claimfile
->n_syms_used
&& !tv_get_symbols_v2
)
630 else if (!claimfile
->n_syms_used
)
632 rv
= tv_get_symbols_v2 (claimfile
->file
.handle
, claimfile
->n_syms_used
,
636 for (n
= 0; n
< claimfile
->n_syms_used
; n
++)
637 TV_MESSAGE (LDPL_INFO
, "Sym: '%s%s%s' Resolution: %s",
638 claimfile
->symbols
[n
].name
,
639 claimfile
->symbols
[n
].version
? "@" : "",
640 (claimfile
->symbols
[n
].version
641 ? claimfile
->symbols
[n
].version
: ""),
642 resolutions
[claimfile
->symbols
[n
].resolution
]);
644 for ( ; addfile
; addfile
= addfile
->next
)
646 enum ld_plugin_status rv
;
647 if (addfile
->type
== ADD_LIB
&& tv_add_input_library
)
648 rv
= (*tv_add_input_library
) (addfile
->name
);
649 else if (addfile
->type
== ADD_FILE
&& tv_add_input_file
)
650 rv
= (*tv_add_input_file
) (addfile
->name
);
651 else if (addfile
->type
== ADD_DIR
&& tv_set_extra_library_path
)
652 rv
= (*tv_set_extra_library_path
) (addfile
->name
);
659 return all_symbols_read_ret
;
662 /* Standard plugin API registerable hook. */
663 static enum ld_plugin_status
666 TV_MESSAGE (LDPL_INFO
, "hook called: cleanup.");
670 #endif /* BFD_SUPPORTS_PLUGINS */