/* Linker file opening and searching.
Copyright (C) 1991-2024 Free Software Foundation, Inc.
This file is part of the GNU Binutils.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
MA 02110-1301, USA. */
typedef struct input_remap
{
const char * pattern; /* Pattern to match input files. */
const char * renamed; /* Filename to use if the pattern matches. */
struct input_remap * next; /* Link in a chain of these structures. */
} input_remap;
/* Look for special filenames that mean that the input file should be ignored. */
if (strcmp (renamed, "/dev/null") == 0
|| strcmp (renamed, "NUL") == 0)
new_entry->renamed = NULL;
else
/* FIXME: Should we add sanity checking of the 'renamed' string ? */
new_entry->renamed = xstrdup (renamed);
/* It would be easier to add this new node at the start of the chain,
but users expect that remapping will occur in the order in which
they occur on the command line, and in the remapping files. */
if (input_remaps == NULL)
{
input_remaps = new_entry;
}
else
{
struct input_remap * i;
for (i = input_remaps; i->next != NULL; i = i->next)
;
i->next = new_entry;
}
}
void
ldfile_remap_input_free (void)
{
while (input_remaps != NULL)
{
struct input_remap * i = input_remaps;
f = fopen (file, FOPEN_RT);
if (f == NULL)
return false;
size_t linelen = 256;
char * line = xmalloc (linelen);
do
{
char * p = line;
char * q;
/* Normally this would use getline(3), but we need to be portable. */
while ((q = fgets (p, linelen - (p - line), f)) != NULL
&& strlen (q) == linelen - (p - line) - 1
&& line[linelen - 2] != '\n')
{
line = xrealloc (line, 2 * linelen);
p = line + linelen - 1;
linelen += linelen;
}
if (q == NULL && p == line)
break;
p = strchr (line, '\n');
if (p)
*p = '\0';
/* Because the file format does not know any form of quoting we
can search forward for the next '#' character and if found
make it terminating the line. */
p = strchr (line, '#');
if (p)
*p = '\0';
/* Remove leading whitespace. NUL is no whitespace character. */
p = line;
while (*p == ' ' || *p == '\f' || *p == '\r' || *p == '\t' || *p == '\v')
++p;
/* If the line is blank it is ignored. */
if (*p == '\0')
continue;
char * pattern = p;
/* Advance past the pattern. We accept whitespace or '=' as an
end-of-pattern marker. */
while (*p && *p != '=' && *p != ' ' && *p != '\t' && *p != '\f'
&& *p != '\r' && *p != '\v')
++p;
if (verbose)
{
if (entry->the_bfd == NULL)
info_msg (_("attempt to open %s failed\n"), attempt);
else
info_msg (_("attempt to open %s succeeded\n"), attempt);
}
if (entry->the_bfd == NULL)
{
if (bfd_get_error () == bfd_error_invalid_target)
einfo (_("%F%P: invalid BFD target `%s'\n"), entry->target);
return false;
}
/* PR 30568: Do not track lto generated temporary object files. */
#if BFD_SUPPORTS_PLUGINS
if (!entry->flags.lto_output)
#endif
track_dependency_files (attempt);
/* Linker needs to decompress sections. */
entry->the_bfd->flags |= BFD_DECOMPRESS;
/* This is a linker input BFD. */
entry->the_bfd->is_linker_input = 1;
#if BFD_SUPPORTS_PLUGINS
if (entry->flags.lto_output)
entry->the_bfd->lto_output = 1;
#endif
/* If we are searching for this file, see if the architecture is
compatible with the output file. If it isn't, keep searching.
If we can't open the file as an object file, stop the search
here. If we are statically linking, ensure that we don't link
a dynamic object.
In the code below, it's OK to exit early if the check fails,
closing the checked BFD and returning false, but if the BFD
checks out compatible, do not exit early returning true, or
the plugins will not get a chance to claim the file. */
if (entry->flags.search_dirs || !entry->flags.dynamic)
{
bfd *check;
if (!entry->flags.dynamic && (entry->the_bfd->flags & DYNAMIC) != 0)
{
einfo (_("%F%P: attempted static link of dynamic object `%s'\n"),
attempt);
bfd_close (entry->the_bfd);
entry->the_bfd = NULL;
return false;
}
if (entry->flags.search_dirs
&& !bfd_arch_get_compatible (check, link_info.output_bfd,
command_line.accept_unknown_input_arch)
/* XCOFF archives can have 32 and 64 bit objects. */
&& !(bfd_get_flavour (check) == bfd_target_xcoff_flavour
&& (bfd_get_flavour (link_info.output_bfd)
== bfd_target_xcoff_flavour)
&& bfd_check_format (entry->the_bfd, bfd_archive)))
{
if (command_line.warn_search_mismatch)
einfo (_("%P: skipping incompatible %s "
"when searching for %s\n"),
attempt, entry->local_sym_name);
bfd_close (entry->the_bfd);
entry->the_bfd = NULL;
return false;
}
}
}
success:
#if BFD_SUPPORTS_PLUGINS
/* If plugins are active, they get first chance to claim
any successfully-opened input file. We skip archives
here; the plugin wants us to offer it the individual
members when we enumerate them, not the whole file. We
also ignore corefiles, because that's just weird. It is
a needed side-effect of calling bfd_check_format with
bfd_object that it sets the bfd's arch and mach, which
will be needed when and if we want to bfd_create a new
one using this one as a template. */
if (link_info.lto_plugin_active
&& !no_more_claiming
&& bfd_check_format (entry->the_bfd, bfd_object))
plugin_maybe_claim (entry);
#endif /* BFD_SUPPORTS_PLUGINS */
/* It opened OK, the format checked out, and the plugins have had
their chance to claim it, so this is success. */
return true;
}
/* Search for and open the file specified by ENTRY. If it is an
archive, use ARCH, LIB and SUFFIX to modify the file name. */
/* If this is not an archive, try to open it in the current
directory first. */
if (!entry->flags.maybe_archive)
{
if (entry->flags.sysrooted && IS_ABSOLUTE_PATH (entry->filename))
{
char *name = concat (ld_sysroot, entry->filename,
(const char *) NULL);
if (ldfile_try_open_bfd (name, entry))
{
entry->filename = name;
return true;
}
free (name);
}
else if (ldfile_try_open_bfd (entry->filename, entry))
return true;
if (IS_ABSOLUTE_PATH (entry->filename))
return false;
}
/* Open the input file specified by ENTRY.
PR 4437: Do not stop on the first missing file, but
continue processing other input files in case there
are more errors to report. */
void
ldfile_open_file (lang_input_statement_type *entry)
{
if (entry->the_bfd != NULL)
return;
if (!entry->flags.search_dirs)
{
if (ldfile_try_open_bfd (entry->filename, entry))
return;
/* If extra_search_path is set, entry->filename is a relative path.
Search the directory of the current linker script before searching
other paths. */
if (entry->extra_search_path)
{
char *path = concat (entry->extra_search_path, slash, entry->filename,
(const char *)0);
if (ldfile_try_open_bfd (path, entry))
{
entry->filename = path;
entry->flags.search_dirs = false;
return;
}
free (path);
}
/* Try to open <filename><suffix> or lib<filename><suffix>.a. */
for (arch = search_arch_head; arch != NULL; arch = arch->next)
{
found = ldfile_open_file_search (arch->name, entry, "lib", ".a");
if (found)
break;
#ifdef VMS
found = ldfile_open_file_search (arch->name, entry, ":lib", ".a");
if (found)
break;
#endif
found = ldemul_find_potential_libraries (arch->name, entry);
if (found)
break;
}
/* If we have found the file, we don't need to search directories
again. */
if (found)
entry->flags.search_dirs = false;
else
{
if (entry->flags.sysrooted
&& ld_sysroot
&& IS_ABSOLUTE_PATH (entry->local_sym_name))
einfo (_("%P: cannot find %s inside %s\n"),
entry->local_sym_name, ld_sysroot);
#if SUPPORT_ERROR_HANDLING_SCRIPT
else if (error_handling_script != NULL)
{
char * argv[4];
const char * res;
int status, err;
if (verbose)
einfo (_("%P: About to run error handling script '%s' with arguments: '%s' '%s'\n"),
argv[0], argv[1], argv[2]);
res = pex_one (PEX_SEARCH, error_handling_script, argv,
N_("error handling script"),
NULL /* Send stdout to random, temp file. */,
NULL /* Write to stderr. */,
&status, &err);
if (res != NULL)
{
einfo (_("%P: Failed to run error handling script '%s', reason: "),
error_handling_script);
/* FIXME: We assume here that errrno == err. */
perror (res);
}
else /* We ignore the return status of the script
and always print the error message. */
einfo (_("%P: cannot find %s: %E\n"), entry->local_sym_name);
}
#endif
else
einfo (_("%P: cannot find %s: %E\n"), entry->local_sym_name);
/* PR 25747: Be kind to users who forgot to add the
"lib" prefix to their library when it was created. */
for (arch = search_arch_head; arch != NULL; arch = arch->next)
{
if (ldfile_open_file_search (arch->name, entry, "", ".a"))
{
const char * base = lbasename (entry->filename);
einfo (_("%P: note to link with %s use -l:%s or rename it to lib%s\n"),
entry->filename, base, base);
bfd_close (entry->the_bfd);
entry->the_bfd = NULL;
break;
}
}
/* Return the default directory for finding script files.
We look for the "ldscripts" directory in:
SCRIPTDIR (passed from Makefile)
(adjusted according to the current location of the binary)
the dir where this program is (for using it from the build tree). */
dir = make_relative_prefix (program_name, BINDIR, SCRIPTDIR);
if (dir)
{
if (check_for_scripts_dir (dir))
return dir;
free (dir);
}
dir = make_relative_prefix (program_name, TOOLBINDIR, SCRIPTDIR);
if (dir)
{
if (check_for_scripts_dir (dir))
return dir;
free (dir);
}
/* Look for "ldscripts" in the dir where our binary is. */
dir = make_relative_prefix (program_name, ".", ".");
if (dir)
{
if (check_for_scripts_dir (dir))
return dir;
free (dir);
}
return NULL;
}
/* If DEFAULT_ONLY is false, try to open NAME; if that fails, look for
it in directories specified with -L, then in the default script
directory. If DEFAULT_ONLY is true, the search is restricted to
the default script location. */
/* PR 24576: Catch the case where the user has accidentally included
the same linker script twice. */
for (script = processed_scripts; script != NULL; script = script->next)
{
if ((open_how != script_nonT || script->open_how != script_nonT)
&& strcmp (name, script->name) == 0)
{
einfo (_("%F%P: error: linker script file '%s'"
" appears multiple times\n"), name);
return;
}
}
/* FIXME: This memory is never freed, but that should not really matter.
It will be released when the linker exits, and it is unlikely to ever
be more than a few tens of bytes. */
len = strlen (name);
script = xmalloc (sizeof (*script) + len);
script->next = processed_scripts;
script->open_how = open_how;
memcpy (script->name, name, len + 1);
processed_scripts = script;