1 /* Linker file opening and searching.
2 Copyright (C) 1991-2020 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. */
25 #include "safe-ctype.h"
35 #include "libiberty.h"
36 #include "filenames.h"
38 #include "plugin-api.h"
40 #endif /* ENABLE_PLUGINS */
42 bfd_boolean ldfile_assumed_script
= FALSE
;
43 const char *ldfile_output_machine_name
= "";
44 unsigned long ldfile_output_machine
;
45 enum bfd_architecture ldfile_output_architecture
;
46 search_dirs_type
*search_head
;
49 static char *slash
= "";
51 #if defined (_WIN32) && !defined (__CYGWIN32__)
52 static char *slash
= "\\";
54 static char *slash
= "/";
58 typedef struct search_arch
61 struct search_arch
*next
;
64 static search_dirs_type
**search_tail_ptr
= &search_head
;
65 static search_arch_type
*search_arch_head
;
66 static search_arch_type
**search_arch_tail_ptr
= &search_arch_head
;
68 /* Test whether a pathname, after canonicalization, is the same or a
69 sub-directory of the sysroot directory. */
72 is_sysrooted_pathname (const char *name
)
78 if (ld_canon_sysroot
== NULL
)
81 realname
= lrealpath (name
);
82 len
= strlen (realname
);
84 if (len
> ld_canon_sysroot_len
85 && IS_DIR_SEPARATOR (realname
[ld_canon_sysroot_len
]))
87 realname
[ld_canon_sysroot_len
] = '\0';
88 result
= FILENAME_CMP (ld_canon_sysroot
, realname
) == 0;
95 /* Adds NAME to the library search path.
96 Makes a copy of NAME using xmalloc(). */
99 ldfile_add_library_path (const char *name
, bfd_boolean cmdline
)
101 search_dirs_type
*new_dirs
;
103 if (!cmdline
&& config
.only_cmd_line_lib_dirs
)
106 new_dirs
= (search_dirs_type
*) xmalloc (sizeof (search_dirs_type
));
107 new_dirs
->next
= NULL
;
108 new_dirs
->cmdline
= cmdline
;
109 *search_tail_ptr
= new_dirs
;
110 search_tail_ptr
= &new_dirs
->next
;
112 /* If a directory is marked as honoring sysroot, prepend the sysroot path
115 new_dirs
->name
= concat (ld_sysroot
, name
+ 1, (const char *) NULL
);
116 else if (CONST_STRNEQ (name
, "$SYSROOT"))
117 new_dirs
->name
= concat (ld_sysroot
, name
+ strlen ("$SYSROOT"), (const char *) NULL
);
119 new_dirs
->name
= xstrdup (name
);
122 /* Try to open a BFD for a lang_input_statement. */
125 ldfile_try_open_bfd (const char *attempt
,
126 lang_input_statement_type
*entry
)
128 entry
->the_bfd
= bfd_openr (attempt
, entry
->target
);
132 if (entry
->the_bfd
== NULL
)
133 info_msg (_("attempt to open %s failed\n"), attempt
);
135 info_msg (_("attempt to open %s succeeded\n"), attempt
);
138 if (entry
->the_bfd
== NULL
)
140 if (bfd_get_error () == bfd_error_invalid_target
)
141 einfo (_("%F%P: invalid BFD target `%s'\n"), entry
->target
);
145 /* Linker needs to decompress sections. */
146 entry
->the_bfd
->flags
|= BFD_DECOMPRESS
;
148 /* This is a linker input BFD. */
149 entry
->the_bfd
->is_linker_input
= 1;
151 #ifdef ENABLE_PLUGINS
152 if (entry
->flags
.lto_output
)
153 entry
->the_bfd
->lto_output
= 1;
156 /* If we are searching for this file, see if the architecture is
157 compatible with the output file. If it isn't, keep searching.
158 If we can't open the file as an object file, stop the search
159 here. If we are statically linking, ensure that we don't link
162 In the code below, it's OK to exit early if the check fails,
163 closing the checked BFD and returning FALSE, but if the BFD
164 checks out compatible, do not exit early returning TRUE, or
165 the plugins will not get a chance to claim the file. */
167 if (entry
->flags
.search_dirs
|| !entry
->flags
.dynamic
)
171 if (bfd_check_format (entry
->the_bfd
, bfd_archive
))
172 check
= bfd_openr_next_archived_file (entry
->the_bfd
, NULL
);
174 check
= entry
->the_bfd
;
178 if (!bfd_check_format (check
, bfd_object
))
180 if (check
== entry
->the_bfd
181 && entry
->flags
.search_dirs
182 && bfd_get_error () == bfd_error_file_not_recognized
183 && !ldemul_unrecognized_file (entry
))
186 char *arg
, *arg1
, *arg2
, *arg3
;
189 /* Try to interpret the file as a linker script. */
190 ldfile_open_command_file (attempt
);
192 ldfile_assumed_script
= TRUE
;
193 parser_input
= input_selected
;
195 token
= INPUT_SCRIPT
;
201 if ((token
= yylex ()) != '(')
203 if ((token
= yylex ()) != NAME
)
211 if ((token
= yylex ()) != NAME
)
217 if ((token
= yylex ()) != ','
218 || (token
= yylex ()) != NAME
)
229 switch (command_line
.endian
)
235 arg
= arg2
? arg2
: arg1
; break;
237 arg
= arg3
? arg3
: arg1
; break;
239 if (strcmp (arg
, lang_get_output_target ()) != 0)
243 if (arg2
) free (arg2
);
244 if (arg3
) free (arg3
);
248 case VERS_IDENTIFIER
:
253 if (yylval
.bigint
.str
)
254 free (yylval
.bigint
.str
);
260 ldfile_assumed_script
= FALSE
;
265 if (command_line
.warn_search_mismatch
)
266 einfo (_("%P: skipping incompatible %s "
267 "when searching for %s\n"),
268 attempt
, entry
->local_sym_name
);
269 bfd_close (entry
->the_bfd
);
270 entry
->the_bfd
= NULL
;
277 if (!entry
->flags
.dynamic
&& (entry
->the_bfd
->flags
& DYNAMIC
) != 0)
279 einfo (_("%F%P: attempted static link of dynamic object `%s'\n"),
281 bfd_close (entry
->the_bfd
);
282 entry
->the_bfd
= NULL
;
286 if (entry
->flags
.search_dirs
287 && !bfd_arch_get_compatible (check
, link_info
.output_bfd
,
288 command_line
.accept_unknown_input_arch
)
289 /* XCOFF archives can have 32 and 64 bit objects. */
290 && !(bfd_get_flavour (check
) == bfd_target_xcoff_flavour
291 && (bfd_get_flavour (link_info
.output_bfd
)
292 == bfd_target_xcoff_flavour
)
293 && bfd_check_format (entry
->the_bfd
, bfd_archive
)))
295 if (command_line
.warn_search_mismatch
)
296 einfo (_("%P: skipping incompatible %s "
297 "when searching for %s\n"),
298 attempt
, entry
->local_sym_name
);
299 bfd_close (entry
->the_bfd
);
300 entry
->the_bfd
= NULL
;
306 #ifdef ENABLE_PLUGINS
307 /* If plugins are active, they get first chance to claim
308 any successfully-opened input file. We skip archives
309 here; the plugin wants us to offer it the individual
310 members when we enumerate them, not the whole file. We
311 also ignore corefiles, because that's just weird. It is
312 a needed side-effect of calling bfd_check_format with
313 bfd_object that it sets the bfd's arch and mach, which
314 will be needed when and if we want to bfd_create a new
315 one using this one as a template. */
316 if (link_info
.lto_plugin_active
318 && bfd_check_format (entry
->the_bfd
, bfd_object
))
319 plugin_maybe_claim (entry
);
320 #endif /* ENABLE_PLUGINS */
322 /* It opened OK, the format checked out, and the plugins have had
323 their chance to claim it, so this is success. */
327 /* Search for and open the file specified by ENTRY. If it is an
328 archive, use ARCH, LIB and SUFFIX to modify the file name. */
331 ldfile_open_file_search (const char *arch
,
332 lang_input_statement_type
*entry
,
336 search_dirs_type
*search
;
338 /* If this is not an archive, try to open it in the current
340 if (!entry
->flags
.maybe_archive
)
342 if (entry
->flags
.sysrooted
&& IS_ABSOLUTE_PATH (entry
->filename
))
344 char *name
= concat (ld_sysroot
, entry
->filename
,
345 (const char *) NULL
);
346 if (ldfile_try_open_bfd (name
, entry
))
348 entry
->filename
= name
;
353 else if (ldfile_try_open_bfd (entry
->filename
, entry
))
356 if (IS_ABSOLUTE_PATH (entry
->filename
))
360 for (search
= search_head
; search
!= NULL
; search
= search
->next
)
364 if (entry
->flags
.dynamic
&& !bfd_link_relocatable (&link_info
))
366 if (ldemul_open_dynamic_archive (arch
, search
, entry
))
370 if (entry
->flags
.maybe_archive
&& !entry
->flags
.full_name_provided
)
371 string
= concat (search
->name
, slash
, lib
, entry
->filename
,
372 arch
, suffix
, (const char *) NULL
);
374 string
= concat (search
->name
, slash
, entry
->filename
,
377 if (ldfile_try_open_bfd (string
, entry
))
379 entry
->filename
= string
;
389 /* Open the input file specified by ENTRY.
390 PR 4437: Do not stop on the first missing file, but
391 continue processing other input files in case there
392 are more errors to report. */
395 ldfile_open_file (lang_input_statement_type
*entry
)
397 if (entry
->the_bfd
!= NULL
)
400 if (!entry
->flags
.search_dirs
)
402 if (ldfile_try_open_bfd (entry
->filename
, entry
))
405 if (filename_cmp (entry
->filename
, entry
->local_sym_name
) != 0)
406 einfo (_("%P: cannot find %s (%s): %E\n"),
407 entry
->filename
, entry
->local_sym_name
);
409 einfo (_("%P: cannot find %s: %E\n"), entry
->local_sym_name
);
411 entry
->flags
.missing_file
= TRUE
;
412 input_flags
.missing_file
= TRUE
;
416 search_arch_type
*arch
;
417 bfd_boolean found
= FALSE
;
419 /* If extra_search_path is set, entry->filename is a relative path.
420 Search the directory of the current linker script before searching
422 if (entry
->extra_search_path
)
424 char *path
= concat (entry
->extra_search_path
, slash
, entry
->filename
,
426 if (ldfile_try_open_bfd (path
, entry
))
428 entry
->filename
= path
;
429 entry
->flags
.search_dirs
= FALSE
;
436 /* Try to open <filename><suffix> or lib<filename><suffix>.a. */
437 for (arch
= search_arch_head
; arch
!= NULL
; arch
= arch
->next
)
439 found
= ldfile_open_file_search (arch
->name
, entry
, "lib", ".a");
443 found
= ldfile_open_file_search (arch
->name
, entry
, ":lib", ".a");
447 found
= ldemul_find_potential_libraries (arch
->name
, entry
);
452 /* If we have found the file, we don't need to search directories
455 entry
->flags
.search_dirs
= FALSE
;
458 if (entry
->flags
.sysrooted
460 && IS_ABSOLUTE_PATH (entry
->local_sym_name
))
461 einfo (_("%P: cannot find %s inside %s\n"),
462 entry
->local_sym_name
, ld_sysroot
);
464 einfo (_("%P: cannot find %s\n"), entry
->local_sym_name
);
466 /* PR 25747: Be kind to users who forgot to add the
467 "lib" prefix to their library when it was created. */
468 for (arch
= search_arch_head
; arch
!= NULL
; arch
= arch
->next
)
470 if (ldfile_open_file_search (arch
->name
, entry
, "", ".a"))
472 const char * base
= lbasename (entry
->filename
);
474 einfo (_("%P: note to link with %s use -l:%s or rename it to lib%s\n"),
475 entry
->filename
, base
, base
);
476 bfd_close (entry
->the_bfd
);
477 entry
->the_bfd
= NULL
;
481 entry
->flags
.missing_file
= TRUE
;
482 input_flags
.missing_file
= TRUE
;
487 /* Try to open NAME. */
490 try_open (const char *name
, bfd_boolean
*sysrooted
)
494 result
= fopen (name
, "r");
497 *sysrooted
= is_sysrooted_pathname (name
);
502 info_msg (_("cannot find script file %s\n"), name
);
504 info_msg (_("opened script file %s\n"), name
);
510 /* Return TRUE iff directory DIR contains an "ldscripts" subdirectory. */
513 check_for_scripts_dir (char *dir
)
519 buf
= concat (dir
, "/ldscripts", (const char *) NULL
);
520 res
= stat (buf
, &s
) == 0 && S_ISDIR (s
.st_mode
);
525 /* Return the default directory for finding script files.
526 We look for the "ldscripts" directory in:
528 SCRIPTDIR (passed from Makefile)
529 (adjusted according to the current location of the binary)
530 the dir where this program is (for using it from the build tree). */
533 find_scripts_dir (void)
537 dir
= make_relative_prefix (program_name
, BINDIR
, SCRIPTDIR
);
540 if (check_for_scripts_dir (dir
))
545 dir
= make_relative_prefix (program_name
, TOOLBINDIR
, SCRIPTDIR
);
548 if (check_for_scripts_dir (dir
))
553 /* Look for "ldscripts" in the dir where our binary is. */
554 dir
= make_relative_prefix (program_name
, ".", ".");
557 if (check_for_scripts_dir (dir
))
565 /* If DEFAULT_ONLY is false, try to open NAME; if that fails, look for
566 it in directories specified with -L, then in the default script
567 directory. If DEFAULT_ONLY is true, the search is restricted to
568 the default script location. */
571 ldfile_find_command_file (const char *name
,
572 bfd_boolean default_only
,
573 bfd_boolean
*sysrooted
)
575 search_dirs_type
*search
;
578 static search_dirs_type
*script_search
;
582 /* First try raw name. */
583 result
= try_open (name
, sysrooted
);
590 char *script_dir
= find_scripts_dir ();
593 search_dirs_type
**save_tail_ptr
= search_tail_ptr
;
594 search_tail_ptr
= &script_search
;
595 ldfile_add_library_path (script_dir
, TRUE
);
596 search_tail_ptr
= save_tail_ptr
;
600 /* Temporarily append script_search to the path list so that the
601 paths specified with -L will be searched first. */
602 *search_tail_ptr
= script_search
;
604 /* Try now prefixes. */
605 for (search
= default_only
? script_search
: search_head
;
607 search
= search
->next
)
609 path
= concat (search
->name
, slash
, name
, (const char *) NULL
);
610 result
= try_open (path
, sysrooted
);
616 /* Restore the original path list. */
617 *search_tail_ptr
= NULL
;
622 enum script_open_style
{
628 struct script_name_list
630 struct script_name_list
*next
;
631 enum script_open_style open_how
;
635 /* Open command file NAME. */
638 ldfile_open_command_file_1 (const char *name
, enum script_open_style open_how
)
640 FILE *ldlex_input_stack
;
641 bfd_boolean sysrooted
;
642 static struct script_name_list
*processed_scripts
= NULL
;
643 struct script_name_list
*script
;
646 /* PR 24576: Catch the case where the user has accidentally included
647 the same linker script twice. */
648 for (script
= processed_scripts
; script
!= NULL
; script
= script
->next
)
650 if ((open_how
!= script_nonT
|| script
->open_how
!= script_nonT
)
651 && strcmp (name
, script
->name
) == 0)
653 einfo (_("%F%P: error: linker script file '%s'"
654 " appears multiple times\n"), name
);
659 /* FIXME: This memory is never freed, but that should not really matter.
660 It will be released when the linker exits, and it is unlikely to ever
661 be more than a few tens of bytes. */
663 script
= xmalloc (sizeof (*script
) + len
);
664 script
->next
= processed_scripts
;
665 script
->open_how
= open_how
;
666 memcpy (script
->name
, name
, len
+ 1);
667 processed_scripts
= script
;
669 ldlex_input_stack
= ldfile_find_command_file (name
,
670 open_how
== script_defaultT
,
672 if (ldlex_input_stack
== NULL
)
674 bfd_set_error (bfd_error_system_call
);
675 einfo (_("%F%P: cannot open linker script file %s: %E\n"), name
);
679 lex_push_file (ldlex_input_stack
, name
, sysrooted
);
683 saved_script_handle
= ldlex_input_stack
;
686 /* Open command file NAME in the current directory, -L directories,
687 the default script location, in that order. */
690 ldfile_open_command_file (const char *name
)
692 ldfile_open_command_file_1 (name
, script_nonT
);
696 ldfile_open_script_file (const char *name
)
698 ldfile_open_command_file_1 (name
, script_T
);
701 /* Open command file NAME at the default script location. */
704 ldfile_open_default_command_file (const char *name
)
706 ldfile_open_command_file_1 (name
, script_defaultT
);
710 ldfile_add_arch (const char *in_name
)
712 char *name
= xstrdup (in_name
);
713 search_arch_type
*new_arch
714 = (search_arch_type
*) xmalloc (sizeof (search_arch_type
));
716 ldfile_output_machine_name
= in_name
;
718 new_arch
->name
= name
;
719 new_arch
->next
= NULL
;
722 *name
= TOLOWER (*name
);
725 *search_arch_tail_ptr
= new_arch
;
726 search_arch_tail_ptr
= &new_arch
->next
;
730 /* Set the output architecture. */
733 ldfile_set_output_arch (const char *string
, enum bfd_architecture defarch
)
735 const bfd_arch_info_type
*arch
= bfd_scan_arch (string
);
739 ldfile_output_architecture
= arch
->arch
;
740 ldfile_output_machine
= arch
->mach
;
741 ldfile_output_machine_name
= arch
->printable_name
;
743 else if (defarch
!= bfd_arch_unknown
)
744 ldfile_output_architecture
= defarch
;
746 einfo (_("%F%P: cannot represent machine `%s'\n"), string
);