1 // options.c -- handle command line options for gold
3 // Copyright (C) 2006-2024 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
6 // This file is part of gold.
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
32 #include "filenames.h"
33 #include "libiberty.h"
35 #include "../bfd/bfdver.h"
39 #include "target-select.h"
47 Position_dependent_options::default_options_
;
52 // This flag is TRUE if we should register the command-line options as they
53 // are constructed. It is set after construction of the options within
54 // class Position_dependent_options.
55 static bool ready_to_register
= false;
57 // This global variable is set up as General_options is constructed.
58 static std::vector
<const One_option
*> registered_options
;
60 // These are set up at the same time -- the variables that accept one
61 // dash, two, or require -z. A single variable may be in more than
62 // one of these data structures.
63 typedef Unordered_map
<std::string
, One_option
*> Option_map
;
64 static Option_map
* long_options
= NULL
;
65 static One_option
* short_options
[128];
68 One_option::register_option()
70 if (!ready_to_register
)
73 registered_options
.push_back(this);
75 // We can't make long_options a static Option_map because we can't
76 // guarantee that will be initialized before register_option() is
78 if (long_options
== NULL
)
79 long_options
= new Option_map
;
81 // TWO_DASHES means that two dashes are preferred, but one is ok too.
82 if (!this->longname
.empty())
83 (*long_options
)[this->longname
] = this;
85 const int shortname_as_int
= static_cast<int>(this->shortname
);
86 gold_assert(shortname_as_int
>= 0 && shortname_as_int
< 128);
87 if (this->shortname
!= '\0')
89 gold_assert(short_options
[shortname_as_int
] == NULL
);
90 short_options
[shortname_as_int
] = this;
95 One_option::print() const
100 if (this->shortname
!= '\0')
102 len
+= printf("-%c", this->shortname
);
105 // -z takes long-names only.
106 gold_assert(this->dashes
!= DASH_Z
);
107 len
+= printf(" %s", gettext(this->helparg
));
111 if (!this->longname
.empty()
112 && !(this->longname
[0] == this->shortname
113 && this->longname
[1] == '\0'))
117 switch (this->dashes
)
119 case options::ONE_DASH
: case options::EXACTLY_ONE_DASH
:
122 case options::TWO_DASHES
: case options::EXACTLY_TWO_DASHES
:
125 case options::DASH_Z
:
126 len
+= printf("-z ");
131 len
+= printf("%s", this->longname
.c_str());
134 // For most options, we print "--frob FOO". But for -z
135 // we print "-z frob=FOO".
136 len
+= printf("%c%s", this->dashes
== options::DASH_Z
? '=' : ' ',
137 gettext(this->helparg
));
146 for (; len
< 30; ++len
)
149 printf("%s", gettext(this->helpstring
));
150 if (this->is_default
)
151 printf(" (%s)", _("default"));
158 printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name
);
160 std::vector
<const One_option
*>::const_iterator it
;
161 for (it
= registered_options
.begin(); it
!= registered_options
.end(); ++it
)
164 // config.guess and libtool.m4 look in ld --help output for the
165 // string "supported targets".
166 printf(_("%s: supported targets:"), gold::program_name
);
167 std::vector
<const char*> supported_names
;
168 gold::supported_target_names(&supported_names
);
169 for (std::vector
<const char*>::const_iterator p
= supported_names
.begin();
170 p
!= supported_names
.end();
175 printf(_("%s: supported emulations:"), gold::program_name
);
176 supported_names
.clear();
177 gold::supported_emulation_names(&supported_names
);
178 for (std::vector
<const char*>::const_iterator p
= supported_names
.begin();
179 p
!= supported_names
.end();
184 // REPORT_BUGS_TO is defined in bfd/bfdver.h.
185 const char* report
= REPORT_BUGS_TO
;
187 printf(_("Report bugs to %s\n"), report
);
190 // For bool, arg will be NULL (boolean options take no argument);
191 // we always just set to true.
193 parse_bool(const char*, const char*, bool* retval
)
199 parse_uint(const char* option_name
, const char* arg
, int* retval
)
202 *retval
= strtol(arg
, &endptr
, 0);
203 if (*endptr
!= '\0' || *retval
< 0)
204 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
209 parse_int(const char* option_name
, const char* arg
, int* retval
)
212 *retval
= strtol(arg
, &endptr
, 0);
214 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
219 parse_uint64(const char* option_name
, const char* arg
, uint64_t* retval
)
222 *retval
= strtoull(arg
, &endptr
, 0);
224 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
229 parse_double(const char* option_name
, const char* arg
, double* retval
)
232 *retval
= strtod(arg
, &endptr
);
234 gold_fatal(_("%s: invalid option value "
235 "(expected a floating point number): %s"),
240 parse_percent(const char* option_name
, const char* arg
, double* retval
)
243 *retval
= strtod(arg
, &endptr
) / 100.0;
245 gold_fatal(_("%s: invalid option value "
246 "(expected a floating point number): %s"),
251 parse_string(const char* option_name
, const char* arg
, const char** retval
)
254 gold_fatal(_("%s: must take a non-empty argument"), option_name
);
259 parse_optional_string(const char*, const char* arg
, const char** retval
)
265 parse_dirlist(const char*, const char* arg
, Dir_list
* retval
)
267 retval
->push_back(Search_directory(arg
, false));
271 parse_set(const char*, const char* arg
, String_set
* retval
)
273 retval
->insert(std::string(arg
));
277 parse_choices(const char* option_name
, const char* arg
, const char** retval
,
278 const char* choices
[], int num_choices
)
280 for (int i
= 0; i
< num_choices
; i
++)
281 if (strcmp(choices
[i
], arg
) == 0)
287 // If we get here, the user did not enter a valid choice, so we die.
288 std::string choices_list
;
289 for (int i
= 0; i
< num_choices
; i
++)
291 choices_list
+= choices
[i
];
292 if (i
!= num_choices
- 1)
293 choices_list
+= ", ";
295 gold_fatal(_("%s: must take one of the following arguments: %s"),
296 option_name
, choices_list
.c_str());
299 } // End namespace options.
301 // Define the handler for "special" options (set via DEFINE_special).
304 General_options::parse_help(const char*, const char*, Command_line
*)
307 ::exit(EXIT_SUCCESS
);
311 General_options::parse_version(const char* opt
, const char*, Command_line
*)
313 bool print_short
= (opt
[0] == '-' && opt
[1] == 'v');
314 gold::print_version(print_short
);
315 this->printed_version_
= true;
317 ::exit(EXIT_SUCCESS
);
321 General_options::parse_V(const char*, const char*, Command_line
*)
323 gold::print_version(true);
324 this->printed_version_
= true;
326 printf(_(" Supported targets:\n"));
327 std::vector
<const char*> supported_names
;
328 gold::supported_target_names(&supported_names
);
329 for (std::vector
<const char*>::const_iterator p
= supported_names
.begin();
330 p
!= supported_names
.end();
334 printf(_(" Supported emulations:\n"));
335 supported_names
.clear();
336 gold::supported_emulation_names(&supported_names
);
337 for (std::vector
<const char*>::const_iterator p
= supported_names
.begin();
338 p
!= supported_names
.end();
344 General_options::parse_Bno_symbolic(const char*, const char*,
347 this->bsymbolic_
= BSYMBOLIC_NONE
;
351 General_options::parse_Bsymbolic_functions(const char*, const char*,
354 this->bsymbolic_
= BSYMBOLIC_FUNCTIONS
;
358 General_options::parse_Bsymbolic(const char*, const char*,
361 this->bsymbolic_
= BSYMBOLIC_ALL
;
365 General_options::parse_defsym(const char*, const char* arg
,
366 Command_line
* cmdline
)
368 cmdline
->script_options().define_symbol(arg
);
372 General_options::parse_discard_all(const char*, const char*,
375 this->discard_locals_
= DISCARD_ALL
;
379 General_options::parse_discard_locals(const char*, const char*,
382 this->discard_locals_
= DISCARD_LOCALS
;
386 General_options::parse_discard_none(const char*, const char*,
389 this->discard_locals_
= DISCARD_NONE
;
393 General_options::parse_incremental(const char*, const char*,
396 this->incremental_mode_
= INCREMENTAL_AUTO
;
400 General_options::parse_no_incremental(const char*, const char*,
403 this->incremental_mode_
= INCREMENTAL_OFF
;
407 General_options::parse_incremental_full(const char*, const char*,
410 this->incremental_mode_
= INCREMENTAL_FULL
;
414 General_options::parse_incremental_update(const char*, const char*,
417 this->incremental_mode_
= INCREMENTAL_UPDATE
;
421 General_options::parse_incremental_changed(const char*, const char*,
424 this->implicit_incremental_
= true;
425 this->incremental_disposition_
= INCREMENTAL_CHANGED
;
429 General_options::parse_incremental_unchanged(const char*, const char*,
432 this->implicit_incremental_
= true;
433 this->incremental_disposition_
= INCREMENTAL_UNCHANGED
;
437 General_options::parse_incremental_unknown(const char*, const char*,
440 this->implicit_incremental_
= true;
441 this->incremental_disposition_
= INCREMENTAL_CHECK
;
445 General_options::parse_incremental_startup_unchanged(const char*, const char*,
448 this->implicit_incremental_
= true;
449 this->incremental_startup_disposition_
= INCREMENTAL_UNCHANGED
;
453 General_options::parse_library(const char*, const char* arg
,
454 Command_line
* cmdline
)
456 Input_file_argument::Input_file_type type
;
460 type
= Input_file_argument::INPUT_FILE_TYPE_SEARCHED_FILE
;
465 type
= Input_file_argument::INPUT_FILE_TYPE_LIBRARY
;
468 Input_file_argument
file(name
, type
, "", false, *this);
469 cmdline
->inputs().add_file(file
);
473 General_options::parse_plugin(const char*, const char* arg
,
476 this->add_plugin(arg
);
479 // Parse --plugin-opt.
482 General_options::parse_plugin_opt(const char*, const char* arg
,
485 this->add_plugin_option(arg
);
489 General_options::parse_no_power10_stubs(const char*, const char*,
492 this->set_power10_stubs("no");
493 this->set_user_set_power10_stubs();
497 General_options::parse_R(const char* option
, const char* arg
,
498 Command_line
* cmdline
)
501 if (::stat(arg
, &s
) != 0 || S_ISDIR(s
.st_mode
))
502 this->add_to_rpath(arg
);
504 this->parse_just_symbols(option
, arg
, cmdline
);
508 General_options::parse_just_symbols(const char*, const char* arg
,
509 Command_line
* cmdline
)
511 Input_file_argument
file(arg
, Input_file_argument::INPUT_FILE_TYPE_FILE
,
513 cmdline
->inputs().add_file(file
);
516 // Handle --section-start.
519 General_options::parse_section_start(const char*, const char* arg
,
522 const char* eq
= strchr(arg
, '=');
525 gold_error(_("invalid argument to --section-start; "
526 "must be SECTION=ADDRESS"));
530 std::string
section_name(arg
, eq
- arg
);
533 const char* val_start
= eq
;
534 if (eq
[0] == '0' && (eq
[1] == 'x' || eq
[1] == 'X'))
538 gold_error(_("--section-start address missing"));
543 for (; *eq
!= '\0'; ++eq
)
547 gold_error(_("--section-start argument %s is not a valid hex number"),
552 addr
+= hex_value(*eq
);
555 this->section_starts_
[section_name
] = addr
;
558 // Look up a --section-start value.
561 General_options::section_start(const char* secname
, uint64_t* paddr
) const
563 if (this->section_starts_
.empty())
565 std::map
<std::string
, uint64_t>::const_iterator p
=
566 this->section_starts_
.find(secname
);
567 if (p
== this->section_starts_
.end())
574 General_options::parse_static(const char*, const char*, Command_line
*)
576 this->set_static(true);
580 General_options::parse_script(const char*, const char* arg
,
581 Command_line
* cmdline
)
583 if (!read_commandline_script(arg
, cmdline
))
584 gold::gold_fatal(_("unable to parse script file %s"), arg
);
588 General_options::parse_version_script(const char*, const char* arg
,
589 Command_line
* cmdline
)
591 if (!read_version_script(arg
, cmdline
))
592 gold::gold_fatal(_("unable to parse version script file %s"), arg
);
596 General_options::parse_dynamic_list(const char*, const char* arg
,
597 Command_line
* cmdline
)
599 if (!read_dynamic_list(arg
, cmdline
, &this->dynamic_list_
))
600 gold::gold_fatal(_("unable to parse dynamic-list script file %s"), arg
);
601 this->have_dynamic_list_
= true;
605 General_options::parse_start_group(const char*, const char*,
606 Command_line
* cmdline
)
608 cmdline
->inputs().start_group();
612 General_options::parse_end_group(const char*, const char*,
613 Command_line
* cmdline
)
615 cmdline
->inputs().end_group();
619 General_options::parse_start_lib(const char*, const char*,
620 Command_line
* cmdline
)
622 cmdline
->inputs().start_lib(cmdline
->position_dependent_options());
626 General_options::parse_end_lib(const char*, const char*,
627 Command_line
* cmdline
)
629 cmdline
->inputs().end_lib();
632 // The function add_excluded_libs() in ld/ldlang.c of GNU ld breaks up a list
633 // of names separated by commas or colons and puts them in a linked list.
634 // We implement the same parsing of names here but store names in an unordered
635 // map to speed up searching of names.
638 General_options::parse_exclude_libs(const char*, const char* arg
,
645 size_t length
= strcspn(p
, ",:");
646 this->excluded_libs_
.insert(std::string(p
, length
));
647 p
+= (p
[length
] ? length
+ 1 : length
);
651 // The checking logic is based on the function check_excluded_libs() in
652 // ld/ldlang.c of GNU ld but our implementation is different because we use
653 // an unordered map instead of a linked list, which is what GNU ld uses. GNU
654 // ld searches sequentially in the excluded libs list. For a given archive,
655 // a match is found if the archive's name matches exactly one of the list
656 // entry or if the archive's name is of the form FOO.a and FOO matches exactly
657 // one of the list entry. An entry "ALL" in the list is considered as a
658 // wild-card and matches any given name.
661 General_options::check_excluded_libs(const std::string
&name
) const
663 Unordered_set
<std::string
>::const_iterator p
;
665 // Exit early for the most common case.
666 if (excluded_libs_
.empty())
669 // If we see "ALL", all archives are excluded from automatic export.
670 p
= excluded_libs_
.find(std::string("ALL"));
671 if (p
!= excluded_libs_
.end())
674 // First strip off any directories in name.
675 const char* basename
= lbasename(name
.c_str());
677 // Try finding an exact match.
678 p
= excluded_libs_
.find(std::string(basename
));
679 if (p
!= excluded_libs_
.end())
682 // Try matching NAME without ".a" at the end.
683 size_t length
= strlen(basename
);
685 && (basename
[length
- 2] == '.')
686 && (basename
[length
- 1] == 'a'))
688 p
= excluded_libs_
.find(std::string(basename
, length
- 2));
689 if (p
!= excluded_libs_
.end())
696 // Recognize input and output target names. The GNU linker accepts
697 // these with --format and --oformat. This code is intended to be
698 // minimally compatible. In practice for an ELF target this would be
699 // the same target as the input files; that name always start with
700 // "elf". Non-ELF targets would be "srec", "symbolsrec", "tekhex",
703 General_options::Object_format
704 General_options::string_to_object_format(const char* arg
)
706 if (strncmp(arg
, "elf", 3) == 0 || strcmp(arg
, "default") == 0)
707 return gold::General_options::OBJECT_FORMAT_ELF
;
708 else if (strcmp(arg
, "binary") == 0)
709 return gold::General_options::OBJECT_FORMAT_BINARY
;
712 gold::gold_error(_("format '%s' not supported; treating as elf "
713 "(supported formats: elf, binary)"),
715 return gold::General_options::OBJECT_FORMAT_ELF
;
720 General_options::object_format_to_string(General_options::Object_format fmt
)
724 case General_options::OBJECT_FORMAT_ELF
:
726 case General_options::OBJECT_FORMAT_BINARY
:
734 General_options::parse_fix_v4bx(const char*, const char*,
737 this->fix_v4bx_
= FIX_V4BX_REPLACE
;
741 General_options::parse_fix_v4bx_interworking(const char*, const char*,
744 this->fix_v4bx_
= FIX_V4BX_INTERWORKING
;
748 General_options::parse_EB(const char*, const char*, Command_line
*)
750 this->endianness_
= ENDIANNESS_BIG
;
754 General_options::parse_EL(const char*, const char*, Command_line
*)
756 this->endianness_
= ENDIANNESS_LITTLE
;
760 General_options::copy_from_posdep_options(
761 const Position_dependent_options
& posdep
)
763 this->set_as_needed(posdep
.as_needed());
764 this->set_Bdynamic(posdep
.Bdynamic());
766 General_options::object_format_to_string(posdep
.format_enum()));
767 this->set_whole_archive(posdep
.whole_archive());
768 this->set_incremental_disposition(posdep
.incremental_disposition());
772 General_options::parse_push_state(const char*, const char*, Command_line
*)
774 Position_dependent_options
* posdep
= new Position_dependent_options(*this);
775 this->options_stack_
.push_back(posdep
);
779 General_options::parse_pop_state(const char*, const char*, Command_line
*)
781 if (this->options_stack_
.empty())
783 gold::gold_error(_("unbalanced --push-state/--pop-state"));
786 Position_dependent_options
* posdep
= this->options_stack_
.back();
787 this->options_stack_
.pop_back();
788 this->copy_from_posdep_options(*posdep
);
792 } // End namespace gold.
801 _("%s: use the --help option for usage information\n"),
803 ::exit(EXIT_FAILURE
);
807 usage(const char* msg
, const char* opt
)
811 gold::program_name
, opt
, msg
);
815 // If the default sysroot is relocatable, try relocating it based on
819 get_relative_sysroot(const char* from
)
821 char* path
= make_relative_prefix(gold::program_name
, from
,
826 if (::stat(path
, &s
) == 0 && S_ISDIR(s
.st_mode
))
834 // Return the default sysroot. This is set by the --with-sysroot
835 // option to configure. Note we do not free the return value of
836 // get_relative_sysroot, which is a small memory leak, but is
837 // necessary since we store this pointer directly in General_options.
840 get_default_sysroot()
842 const char* sysroot
= TARGET_SYSTEM_ROOT
;
843 if (*sysroot
== '\0')
846 if (TARGET_SYSTEM_ROOT_RELOCATABLE
)
848 char* path
= get_relative_sysroot(BINDIR
);
850 path
= get_relative_sysroot(TOOLBINDIR
);
858 // Parse a long option. Such options have the form
859 // <-|--><option>[=arg]. If "=arg" is not present but the option
860 // takes an argument, the next word is taken to the be the argument.
861 // If equals_only is set, then only the <option>=<arg> form is
862 // accepted, not the <option><space><arg> form. Returns a One_option
863 // struct or NULL if argv[i] cannot be parsed as a long option. In
864 // the not-NULL case, *arg is set to the option's argument (NULL if
865 // the option takes no argument), and *i is advanced past this option.
866 // NOTE: it is safe for argv and arg to point to the same place.
867 gold::options::One_option
*
868 parse_long_option(int argc
, const char** argv
, bool equals_only
,
869 const char** arg
, int* i
)
871 const char* const this_argv
= argv
[*i
];
873 const char* equals
= strchr(this_argv
, '=');
874 const char* option_start
= this_argv
+ strspn(this_argv
, "-");
875 std::string
option(option_start
,
876 equals
? equals
- option_start
: strlen(option_start
));
878 gold::options::Option_map::iterator it
879 = gold::options::long_options
->find(option
);
880 if (it
== gold::options::long_options
->end())
883 gold::options::One_option
* retval
= it
->second
;
885 // If the dash-count doesn't match, we fail.
886 if (this_argv
[0] != '-') // no dashes at all: had better be "-z <longopt>"
888 if (retval
->dashes
!= gold::options::DASH_Z
)
891 else if (this_argv
[1] != '-') // one dash
893 if (retval
->dashes
!= gold::options::ONE_DASH
894 && retval
->dashes
!= gold::options::EXACTLY_ONE_DASH
895 && retval
->dashes
!= gold::options::TWO_DASHES
)
898 else // two dashes (or more!)
900 if (retval
->dashes
!= gold::options::TWO_DASHES
901 && retval
->dashes
!= gold::options::EXACTLY_TWO_DASHES
902 && retval
->dashes
!= gold::options::ONE_DASH
)
906 // Now that we know the option is good (or else bad in a way that
907 // will cause us to die), increment i to point past this argv.
910 // Figure out the option's argument, if any.
911 if (!retval
->takes_argument())
914 usage(_("unexpected argument"), this_argv
);
922 else if (retval
->takes_optional_argument())
923 *arg
= retval
->default_value
;
924 else if (*i
< argc
&& !equals_only
)
927 usage(_("missing argument"), this_argv
);
933 // Parse a short option. Such options have the form -<option>[arg].
934 // If "arg" is not present but the option takes an argument, the next
935 // word is taken to the be the argument. If the option does not take
936 // an argument, it may be followed by another short option. Returns a
937 // One_option struct or NULL if argv[i] cannot be parsed as a short
938 // option. In the not-NULL case, *arg is set to the option's argument
939 // (NULL if the option takes no argument), and *i is advanced past
940 // this option. This function keeps *i the same if we parsed a short
941 // option that does not take an argument, that looks to be followed by
942 // another short option in the same word.
943 gold::options::One_option
*
944 parse_short_option(int argc
, const char** argv
, int pos_in_argv_i
,
945 const char** arg
, int* i
)
947 const char* const this_argv
= argv
[*i
];
949 if (this_argv
[0] != '-')
952 // We handle -z as a special case.
953 static gold::options::One_option
dash_z("", gold::options::DASH_Z
,
954 'z', "", NULL
, "Z-OPTION", false,
956 gold::options::One_option
* retval
= NULL
;
957 if (this_argv
[pos_in_argv_i
] == 'z')
961 const int char_as_int
= static_cast<int>(this_argv
[pos_in_argv_i
]);
962 if (char_as_int
> 0 && char_as_int
< 128)
963 retval
= gold::options::short_options
[char_as_int
];
969 // Figure out the option's argument, if any.
970 if (!retval
->takes_argument())
973 // We only advance past this argument if it's the only one in argv.
974 if (this_argv
[pos_in_argv_i
+ 1] == '\0')
979 // If we take an argument, we'll eat up this entire argv entry.
981 if (this_argv
[pos_in_argv_i
+ 1] != '\0')
982 *arg
= this_argv
+ pos_in_argv_i
+ 1;
983 else if (retval
->takes_optional_argument())
984 *arg
= retval
->default_value
;
988 usage(_("missing argument"), this_argv
);
991 // If we're a -z option, we need to parse our argument as a
992 // long-option, e.g. "-z stacksize=8192".
993 if (retval
== &dash_z
)
996 const char* dash_z_arg
= *arg
;
997 retval
= parse_long_option(1, arg
, true, arg
, &dummy_i
);
999 usage(_("unknown -z option"), dash_z_arg
);
1005 } // End anonymous namespace.
1010 General_options::General_options()
1011 : bsymbolic_(BSYMBOLIC_NONE
),
1012 printed_version_(false),
1013 execstack_status_(EXECSTACK_FROM_INPUT
),
1014 icf_status_(ICF_NONE
),
1016 do_demangle_(false),
1019 have_dynamic_list_(false),
1020 incremental_mode_(INCREMENTAL_OFF
),
1021 incremental_disposition_(INCREMENTAL_STARTUP
),
1022 incremental_startup_disposition_(INCREMENTAL_CHECK
),
1023 implicit_incremental_(false),
1025 symbols_to_retain_(),
1027 fix_v4bx_(FIX_V4BX_NONE
),
1028 endianness_(ENDIANNESS_NOT_SET
),
1029 discard_locals_(DISCARD_SEC_MERGE
),
1030 orphan_handling_enum_(ORPHAN_PLACE
),
1031 start_stop_visibility_enum_(elfcpp::STV_PROTECTED
)
1033 // Turn off option registration once construction is complete.
1034 gold::options::ready_to_register
= false;
1037 General_options::Object_format
1038 General_options::format_enum() const
1040 return General_options::string_to_object_format(this->format());
1043 General_options::Object_format
1044 General_options::oformat_enum() const
1046 return General_options::string_to_object_format(this->oformat());
1049 // Add the sysroot, if any, to the search paths.
1052 General_options::add_sysroot()
1054 if (this->sysroot() == NULL
|| this->sysroot()[0] == '\0')
1056 this->set_sysroot(get_default_sysroot());
1057 if (this->sysroot() == NULL
|| this->sysroot()[0] == '\0')
1061 char* canonical_sysroot
= lrealpath(this->sysroot());
1063 for (Dir_list::iterator p
= this->library_path_
.value
.begin();
1064 p
!= this->library_path_
.value
.end();
1066 p
->add_sysroot(this->sysroot(), canonical_sysroot
);
1068 free(canonical_sysroot
);
1071 // Return whether FILENAME is in a system directory.
1074 General_options::is_in_system_directory(const std::string
& filename
) const
1076 for (Dir_list::const_iterator p
= this->library_path_
.value
.begin();
1077 p
!= this->library_path_
.value
.end();
1080 // We use a straight string comparison rather than calling
1081 // FILENAME_CMP because we are only interested in the cases
1082 // where we found the file in a system directory, which means
1083 // that we used the directory name as a prefix for a -L search.
1084 if (p
->is_system_directory()
1085 && filename
.compare(0, p
->name().size(), p
->name()) == 0)
1091 // Add a plugin to the list of plugins.
1094 General_options::add_plugin(const char* filename
)
1096 if (this->plugins_
== NULL
)
1097 this->plugins_
= new Plugin_manager(*this);
1098 this->plugins_
->add_plugin(filename
);
1101 // Add a plugin option to a plugin.
1104 General_options::add_plugin_option(const char* arg
)
1106 if (this->plugins_
== NULL
)
1107 gold_fatal("--plugin-opt requires --plugin.");
1108 this->plugins_
->add_plugin_option(arg
);
1111 // Set up variables and other state that isn't set up automatically by
1112 // the parse routine, and ensure options don't contradict each other
1113 // and are otherwise kosher.
1116 General_options::finalize()
1118 // Normalize the strip modifiers. They have a total order:
1119 // strip_all > strip_debug > strip_non_line > strip_debug_gdb.
1120 // If one is true, set all beneath it to true as well.
1121 if (this->strip_all())
1122 this->set_strip_debug(true);
1123 if (this->strip_debug())
1124 this->set_strip_debug_non_line(true);
1125 if (this->strip_debug_non_line())
1126 this->set_strip_debug_gdb(true);
1128 if (this->Bshareable())
1129 this->set_shared(true);
1131 // If the user specifies both -s and -r, convert the -s to -S.
1132 // -r requires us to keep externally visible symbols!
1133 if (this->strip_all() && this->relocatable())
1135 this->set_strip_all(false);
1136 gold_assert(this->strip_debug());
1139 // For us, -dc and -dp are synonyms for --define-common.
1141 this->set_define_common(true);
1143 this->set_define_common(true);
1145 // We also set --define-common if we're not relocatable, as long as
1146 // the user didn't explicitly ask for something different.
1147 if (!this->user_set_define_common())
1148 this->set_define_common(!this->relocatable());
1150 // execstack_status_ is a three-state variable; update it based on
1151 // -z [no]execstack.
1152 if (this->execstack())
1153 this->set_execstack_status(EXECSTACK_YES
);
1154 else if (this->noexecstack())
1155 this->set_execstack_status(EXECSTACK_NO
);
1157 // icf_status_ is a three-state variable; update it based on the
1158 // value of this->icf().
1159 if (strcmp(this->icf(), "none") == 0)
1160 this->set_icf_status(ICF_NONE
);
1161 else if (strcmp(this->icf(), "safe") == 0)
1162 this->set_icf_status(ICF_SAFE
);
1164 this->set_icf_status(ICF_ALL
);
1166 // Handle the optional argument for --demangle.
1167 if (this->user_set_demangle())
1169 this->set_do_demangle(true);
1170 const char* style
= this->demangle();
1173 enum demangling_styles style_code
;
1175 style_code
= cplus_demangle_name_to_style(style
);
1176 if (style_code
== unknown_demangling
)
1177 gold_fatal("unknown demangling style '%s'", style
);
1178 cplus_demangle_set_style(style_code
);
1181 else if (this->user_set_no_demangle())
1182 this->set_do_demangle(false);
1185 // Testing COLLECT_NO_DEMANGLE makes our default demangling
1186 // behaviour identical to that of gcc's linker wrapper.
1187 this->set_do_demangle(getenv("COLLECT_NO_DEMANGLE") == NULL
);
1190 // Parse the --orphan-handling argument.
1191 if (this->user_set_orphan_handling())
1193 if (strcmp(this->orphan_handling(), "place") == 0)
1194 this->set_orphan_handling_enum(ORPHAN_PLACE
);
1195 else if (strcmp(this->orphan_handling(), "discard") == 0)
1196 this->set_orphan_handling_enum(ORPHAN_DISCARD
);
1197 else if (strcmp(this->orphan_handling(), "warn") == 0)
1198 this->set_orphan_handling_enum(ORPHAN_WARN
);
1199 else if (strcmp(this->orphan_handling(), "error") == 0)
1200 this->set_orphan_handling_enum(ORPHAN_ERROR
);
1203 // Parse the -z start-stop-visibility argument.
1204 if (this->user_set_start_stop_visibility())
1206 if (strcmp(this->start_stop_visibility(), "default") == 0)
1207 this->set_start_stop_visibility_enum(elfcpp::STV_DEFAULT
);
1208 else if (strcmp(this->start_stop_visibility(), "internal") == 0)
1209 this->set_start_stop_visibility_enum(elfcpp::STV_INTERNAL
);
1210 else if (strcmp(this->start_stop_visibility(), "hidden") == 0)
1211 this->set_start_stop_visibility_enum(elfcpp::STV_HIDDEN
);
1212 else if (strcmp(this->start_stop_visibility(), "protected") == 0)
1213 this->set_start_stop_visibility_enum(elfcpp::STV_PROTECTED
);
1216 // Parse the --power10-stubs argument.
1217 if (!this->user_set_power10_stubs())
1219 // --power10-stubs without an arg is equivalent to --power10-stubs=yes
1220 // but not specifying --power10-stubs at all should be equivalent to
1221 // --power10-stubs=auto. This doesn't fit into the notion of
1222 // "default_value", used both as a static initializer and to provide
1223 // a missing optional arg. Fix it here.
1224 this->set_power10_stubs("auto");
1225 this->set_power10_stubs_enum(POWER10_STUBS_AUTO
);
1229 if (strcmp(this->power10_stubs(), "auto") == 0)
1230 this->set_power10_stubs_enum(POWER10_STUBS_AUTO
);
1231 else if (strcmp(this->power10_stubs(), "no") == 0)
1232 this->set_power10_stubs_enum(POWER10_STUBS_NO
);
1233 else if (strcmp(this->power10_stubs(), "yes") == 0)
1234 this->set_power10_stubs_enum(POWER10_STUBS_YES
);
1237 // -M is equivalent to "-Map -".
1238 if (this->print_map() && !this->user_set_Map())
1241 this->set_user_set_Map();
1244 // Using -n or -N implies -static.
1245 if (this->nmagic() || this->omagic())
1246 this->set_static(true);
1248 // If --thread_count is specified, it applies to
1249 // --thread-count-{initial,middle,final}, though it doesn't override
1251 if (this->thread_count() > 0 && this->thread_count_initial() == 0)
1252 this->set_thread_count_initial(this->thread_count());
1253 if (this->thread_count() > 0 && this->thread_count_middle() == 0)
1254 this->set_thread_count_middle(this->thread_count());
1255 if (this->thread_count() > 0 && this->thread_count_final() == 0)
1256 this->set_thread_count_final(this->thread_count());
1258 // Let's warn if you set the thread-count but we're going to ignore it.
1259 #ifndef ENABLE_THREADS
1260 if (this->threads())
1262 gold_warning(_("ignoring --threads: "
1263 "%s was compiled without thread support"),
1265 this->set_threads(false);
1267 if (this->thread_count() > 0 || this->thread_count_initial() > 0
1268 || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
1269 gold_warning(_("ignoring --thread-count: "
1270 "%s was compiled without thread support"),
1274 #ifndef ENABLE_PLUGINS
1275 if (this->has_plugins())
1276 gold_fatal(_("cannot use --plugin: "
1277 "%s was compiled without plugin support"),
1281 std::string libpath
;
1282 if (this->user_set_Y())
1284 libpath
= this->Y();
1285 if (libpath
.compare(0, 2, "P,") == 0)
1286 libpath
.erase(0, 2);
1288 else if (!this->nostdlib())
1290 #ifndef NATIVE_LINKER
1291 #define NATIVE_LINKER 0
1293 const char* p
= LIB_PATH
;
1294 if (strcmp(p
, "::DEFAULT::") != 0)
1296 else if (NATIVE_LINKER
1297 || this->user_set_sysroot()
1298 || *TARGET_SYSTEM_ROOT
!= '\0')
1300 this->add_to_library_path_with_sysroot("/lib");
1301 this->add_to_library_path_with_sysroot("/usr/lib");
1304 this->add_to_library_path_with_sysroot(TOOLLIBDIR
);
1307 if (!libpath
.empty())
1313 next_pos
= libpath
.find(':', pos
);
1314 size_t len
= (next_pos
== std::string::npos
1318 this->add_to_library_path_with_sysroot(libpath
.substr(pos
, len
));
1321 while (next_pos
!= std::string::npos
);
1324 // Parse the contents of -retain-symbols-file into a set.
1325 if (this->retain_symbols_file())
1328 in
.open(this->retain_symbols_file());
1330 gold_fatal(_("unable to open -retain-symbols-file file %s: %s"),
1331 this->retain_symbols_file(), strerror(errno
));
1333 std::getline(in
, line
); // this chops off the trailing \n, if any
1336 if (!line
.empty() && line
[line
.length() - 1] == '\r') // Windows
1337 line
.resize(line
.length() - 1);
1338 this->symbols_to_retain_
.insert(line
);
1339 std::getline(in
, line
);
1343 // -Bgroup implies --unresolved-symbols=report-all.
1344 if (this->Bgroup() && !this->user_set_unresolved_symbols())
1345 this->set_unresolved_symbols("report-all");
1347 // -shared implies --allow-shlib-undefined. Currently
1348 // ---allow-shlib-undefined controls warnings issued based on the
1349 // -symbol table. --unresolved-symbols controls warnings issued
1350 // -based on relocations.
1351 if (this->shared() && !this->user_set_allow_shlib_undefined())
1352 this->set_allow_shlib_undefined(true);
1354 // Normalize library_path() by adding the sysroot to all directories
1355 // in the path, as appropriate.
1356 this->add_sysroot();
1358 // Now that we've normalized the options, check for contradictory ones.
1359 if (this->shared() && this->is_static())
1360 gold_fatal(_("-shared and -static are incompatible"));
1361 if (this->shared() && this->pie())
1362 gold_fatal(_("-shared and -pie are incompatible"));
1363 if (this->pie() && this->is_static())
1364 gold_fatal(_("-pie and -static are incompatible"));
1366 if (this->shared() && this->relocatable())
1367 gold_fatal(_("-shared and -r are incompatible"));
1368 if (this->pie() && this->relocatable())
1369 gold_fatal(_("-pie and -r are incompatible"));
1371 if (!this->shared())
1373 if (this->filter() != NULL
)
1374 gold_fatal(_("-F/--filter may not used without -shared"));
1375 if (this->any_auxiliary())
1376 gold_fatal(_("-f/--auxiliary may not be used without -shared"));
1379 // TODO: implement support for -retain-symbols-file with -r, if needed.
1380 if (this->relocatable() && this->retain_symbols_file())
1381 gold_fatal(_("-retain-symbols-file does not yet work with -r"));
1383 if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
1386 || this->relocatable()))
1387 gold_fatal(_("binary output format not compatible "
1388 "with -shared or -pie or -r"));
1390 if (this->user_set_hash_bucket_empty_fraction()
1391 && (this->hash_bucket_empty_fraction() < 0.0
1392 || this->hash_bucket_empty_fraction() >= 1.0))
1393 gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
1395 this->hash_bucket_empty_fraction());
1397 if (this->implicit_incremental_
&& this->incremental_mode_
== INCREMENTAL_OFF
)
1398 gold_fatal(_("Options --incremental-changed, --incremental-unchanged, "
1399 "--incremental-unknown require the use of --incremental"));
1401 // Check for options that are not compatible with incremental linking.
1402 // Where an option can be disabled without seriously changing the semantics
1403 // of the link, we turn the option off; otherwise, we issue a fatal error.
1405 if (this->incremental_mode_
!= INCREMENTAL_OFF
)
1407 if (this->relocatable())
1408 gold_fatal(_("incremental linking is not compatible with -r"));
1409 if (this->emit_relocs())
1410 gold_fatal(_("incremental linking is not compatible with "
1412 if (this->has_plugins())
1413 gold_fatal(_("incremental linking is not compatible with --plugin"));
1415 gold_fatal(_("incremental linking is not compatible with -z relro"));
1417 gold_fatal(_("incremental linking is not compatible with -pie"));
1418 if (this->gc_sections())
1420 gold_warning(_("ignoring --gc-sections for an incremental link"));
1421 this->set_gc_sections(false);
1423 if (this->icf_enabled())
1425 gold_warning(_("ignoring --icf for an incremental link"));
1426 this->set_icf_status(ICF_NONE
);
1428 if (strcmp(this->compress_debug_sections(), "none") != 0)
1430 gold_warning(_("ignoring --compress-debug-sections for an "
1431 "incremental link"));
1432 this->set_compress_debug_sections("none");
1437 if (strcmp(this->compress_debug_sections(), "zstd") == 0)
1439 gold_error(_("--compress-debug-sections=zstd: gold is not built with "
1441 this->set_compress_debug_sections("none");
1445 // --rosegment-gap implies --rosegment.
1446 if (this->user_set_rosegment_gap())
1447 this->set_rosegment(true);
1449 // FIXME: we can/should be doing a lot more sanity checking here.
1452 // Search_directory methods.
1454 // This is called if we have a sysroot. Apply the sysroot if
1455 // appropriate. Record whether the directory is in the sysroot.
1458 Search_directory::add_sysroot(const char* sysroot
,
1459 const char* canonical_sysroot
)
1461 gold_assert(*sysroot
!= '\0');
1462 if (this->put_in_sysroot_
)
1464 if (!IS_DIR_SEPARATOR(this->name_
[0])
1465 && !IS_DIR_SEPARATOR(sysroot
[strlen(sysroot
) - 1]))
1466 this->name_
= '/' + this->name_
;
1467 this->name_
= sysroot
+ this->name_
;
1468 this->is_in_sysroot_
= true;
1472 // Check whether this entry is in the sysroot. To do this
1473 // correctly, we need to use canonical names. Otherwise we will
1474 // get confused by the ../../.. paths that gcc tends to use.
1475 char* canonical_name
= lrealpath(this->name_
.c_str());
1476 int canonical_name_len
= strlen(canonical_name
);
1477 int canonical_sysroot_len
= strlen(canonical_sysroot
);
1478 if (canonical_name_len
> canonical_sysroot_len
1479 && IS_DIR_SEPARATOR(canonical_name
[canonical_sysroot_len
]))
1481 canonical_name
[canonical_sysroot_len
] = '\0';
1482 if (FILENAME_CMP(canonical_name
, canonical_sysroot
) == 0)
1483 this->is_in_sysroot_
= true;
1485 free(canonical_name
);
1489 // Input_arguments methods.
1491 // Add a file to the list.
1494 Input_arguments::add_file(Input_file_argument
& file
)
1496 file
.set_arg_serial(++this->file_count_
);
1497 if (this->in_group_
)
1499 gold_assert(!this->input_argument_list_
.empty());
1500 gold_assert(this->input_argument_list_
.back().is_group());
1501 return this->input_argument_list_
.back().group()->add_file(file
);
1505 gold_assert(!this->input_argument_list_
.empty());
1506 gold_assert(this->input_argument_list_
.back().is_lib());
1507 return this->input_argument_list_
.back().lib()->add_file(file
);
1509 this->input_argument_list_
.push_back(Input_argument(file
));
1510 return this->input_argument_list_
.back();
1516 Input_arguments::start_group()
1518 if (this->in_group_
)
1519 gold_fatal(_("May not nest groups"));
1521 gold_fatal(_("may not nest groups in libraries"));
1522 Input_file_group
* group
= new Input_file_group();
1523 this->input_argument_list_
.push_back(Input_argument(group
));
1524 this->in_group_
= true;
1530 Input_arguments::end_group()
1532 if (!this->in_group_
)
1533 gold_fatal(_("Group end without group start"));
1534 this->in_group_
= false;
1540 Input_arguments::start_lib(const Position_dependent_options
& options
)
1543 gold_fatal(_("may not nest libraries"));
1544 if (this->in_group_
)
1545 gold_fatal(_("may not nest libraries in groups"));
1546 Input_file_lib
* lib
= new Input_file_lib(options
);
1547 this->input_argument_list_
.push_back(Input_argument(lib
));
1548 this->in_lib_
= true;
1554 Input_arguments::end_lib()
1557 gold_fatal(_("lib end without lib start"));
1558 this->in_lib_
= false;
1561 // Command_line options.
1563 Command_line::Command_line()
1567 // Pre_options is the hook that sets the ready_to_register flag.
1569 Command_line::Pre_options::Pre_options()
1571 gold::options::ready_to_register
= true;
1574 // Process the command line options. For process_one_option, i is the
1575 // index of argv to process next, and must be an option (that is,
1576 // start with a dash). The return value is the index of the next
1577 // option to process (i+1 or i+2, or argc to indicate processing is
1578 // done). no_more_options is set to true if (and when) "--" is seen
1582 Command_line::process_one_option(int argc
, const char** argv
, int i
,
1583 bool* no_more_options
)
1585 gold_assert(argv
[i
][0] == '-' && !(*no_more_options
));
1587 // If we are reading "--", then just set no_more_options and return.
1588 if (argv
[i
][1] == '-' && argv
[i
][2] == '\0')
1590 *no_more_options
= true;
1595 options::One_option
* option
= NULL
;
1596 const char* arg
= NULL
;
1598 // First, try to process argv as a long option.
1599 option
= parse_long_option(argc
, argv
, false, &arg
, &new_i
);
1602 option
->reader
->parse_to_value(argv
[i
], arg
, this, &this->options_
);
1606 // Now, try to process argv as a short option. Since several short
1607 // options can be combined in one argv, we may have to parse a lot
1608 // until we're done reading this argv.
1609 int pos_in_argv_i
= 1;
1612 option
= parse_short_option(argc
, argv
, pos_in_argv_i
, &arg
, &new_i
);
1615 option
->reader
->parse_to_value(argv
[i
], arg
, this, &this->options_
);
1621 // I guess it's neither a long option nor a short option.
1622 usage(_("unknown option"), argv
[i
]);
1628 Command_line::process(int argc
, const char** argv
)
1630 bool no_more_options
= false;
1634 this->position_options_
.copy_from_options(this->options());
1635 if (no_more_options
|| argv
[i
][0] != '-')
1637 Input_file_argument
file(argv
[i
],
1638 Input_file_argument::INPUT_FILE_TYPE_FILE
,
1639 "", false, this->position_options_
);
1640 this->inputs_
.add_file(file
);
1644 i
= process_one_option(argc
, argv
, i
, &no_more_options
);
1647 if (this->inputs_
.in_group())
1649 fprintf(stderr
, _("%s: missing group end\n"), program_name
);
1653 if (this->inputs_
.in_lib())
1655 fprintf(stderr
, _("%s: missing lib end\n"), program_name
);
1659 // Normalize the options and ensure they don't contradict each other.
1660 this->options_
.finalize();
1663 // Finalize the version script options and return them.
1665 const Version_script_info
&
1666 Command_line::version_script()
1668 this->options_
.finalize_dynamic_list();
1669 Version_script_info
* vsi
= this->script_options_
.version_script_info();
1674 } // End namespace gold.