1 // options.c -- handle command line options for gold
3 // Copyright 2006, 2007, 2008 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.
30 #include "filenames.h"
31 #include "libiberty.h"
33 #include "../bfd/bfdver.h"
37 #include "target-select.h"
44 Position_dependent_options::default_options_
;
49 // This global variable is set up as General_options is constructed.
50 static std::vector
<const One_option
*> registered_options
;
52 // These are set up at the same time -- the variables that accept one
53 // dash, two, or require -z. A single variable may be in more than
54 // one of thes data structures.
55 typedef Unordered_map
<std::string
, One_option
*> Option_map
;
56 static Option_map
* long_options
= NULL
;
57 static One_option
* short_options
[128];
60 One_option::register_option()
62 registered_options
.push_back(this);
64 // We can't make long_options a static Option_map because we can't
65 // guarantee that will be initialized before register_option() is
67 if (long_options
== NULL
)
68 long_options
= new Option_map
;
70 // TWO_DASHES means that two dashes are preferred, but one is ok too.
71 if (!this->longname
.empty())
72 (*long_options
)[this->longname
] = this;
74 const int shortname_as_int
= static_cast<int>(this->shortname
);
75 gold_assert(shortname_as_int
>= 0 && shortname_as_int
< 128);
76 if (this->shortname
!= '\0')
77 short_options
[shortname_as_int
] = this;
81 One_option::print() const
86 if (this->shortname
!= '\0')
88 len
+= printf("-%c", this->shortname
);
91 // -z takes long-names only.
92 gold_assert(this->dashes
!= DASH_Z
);
93 len
+= printf(" %s", gettext(this->helparg
));
97 if (!this->longname
.empty()
98 && !(this->longname
[0] == this->shortname
99 && this->longname
[1] == '\0'))
103 switch (this->dashes
)
105 case options::ONE_DASH
: case options::EXACTLY_ONE_DASH
:
108 case options::TWO_DASHES
: case options::EXACTLY_TWO_DASHES
:
111 case options::DASH_Z
:
112 len
+= printf("-z ");
117 len
+= printf("%s", this->longname
.c_str());
120 // For most options, we print "--frob FOO". But for -z
121 // we print "-z frob=FOO".
122 len
+= printf("%c%s", this->dashes
== options::DASH_Z
? '=' : ' ',
123 gettext(this->helparg
));
132 for (; len
< 30; ++len
)
135 // TODO: if we're boolean, add " (default)" when appropriate.
136 printf("%s\n", gettext(this->helpstring
));
142 printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name
);
144 std::vector
<const One_option
*>::const_iterator it
;
145 for (it
= registered_options
.begin(); it
!= registered_options
.end(); ++it
)
148 // config.guess and libtool.m4 look in ld --help output for the
149 // string "supported targets".
150 printf(_("%s: supported targets:"), gold::program_name
);
151 std::vector
<const char*> supported_names
;
152 gold::supported_target_names(&supported_names
);
153 for (std::vector
<const char*>::const_iterator p
= supported_names
.begin();
154 p
!= supported_names
.end();
159 // REPORT_BUGS_TO is defined in bfd/bfdver.h.
160 const char* report
= REPORT_BUGS_TO
;
162 printf(_("Report bugs to %s\n"), report
);
165 // For bool, arg will be NULL (boolean options take no argument);
166 // we always just set to true.
168 parse_bool(const char*, const char*, bool* retval
)
174 parse_uint(const char* option_name
, const char* arg
, int* retval
)
177 *retval
= strtol(arg
, &endptr
, 0);
178 if (*endptr
!= '\0' || retval
< 0)
179 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
184 parse_uint64(const char* option_name
, const char* arg
, uint64_t *retval
)
187 *retval
= strtoull(arg
, &endptr
, 0);
189 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
194 parse_double(const char* option_name
, const char* arg
, double* retval
)
197 *retval
= strtod(arg
, &endptr
);
199 gold_fatal(_("%s: invalid option value "
200 "(expected a floating point number): %s"),
205 parse_string(const char* option_name
, const char* arg
, const char** retval
)
208 gold_fatal(_("%s: must take a non-empty argument"), option_name
);
213 parse_optional_string(const char*, const char* arg
, const char** retval
)
219 parse_dirlist(const char*, const char* arg
, Dir_list
* retval
)
221 retval
->push_back(Search_directory(arg
, false));
225 parse_choices(const char* option_name
, const char* arg
, const char** retval
,
226 const char* choices
[], int num_choices
)
228 for (int i
= 0; i
< num_choices
; i
++)
229 if (strcmp(choices
[i
], arg
) == 0)
235 // If we get here, the user did not enter a valid choice, so we die.
236 std::string choices_list
;
237 for (int i
= 0; i
< num_choices
; i
++)
239 choices_list
+= choices
[i
];
240 if (i
!= num_choices
- 1)
241 choices_list
+= ", ";
243 gold_fatal(_("%s: must take one of the following arguments: %s"),
244 option_name
, choices_list
.c_str());
247 } // End namespace options.
249 // Define the handler for "special" options (set via DEFINE_special).
252 General_options::parse_help(const char*, const char*, Command_line
*)
255 ::exit(EXIT_SUCCESS
);
259 General_options::parse_version(const char* opt
, const char*, Command_line
*)
261 gold::print_version(opt
[0] == '-' && opt
[1] == 'v');
262 ::exit(EXIT_SUCCESS
);
266 General_options::parse_Bstatic(const char*, const char*, Command_line
*)
268 this->set_Bdynamic(false);
272 General_options::parse_defsym(const char*, const char* arg
,
273 Command_line
* cmdline
)
275 cmdline
->script_options().define_symbol(arg
);
279 General_options::parse_library(const char*, const char* arg
,
280 Command_line
* cmdline
)
282 Input_file_argument
file(arg
, true, "", false, *this);
283 cmdline
->inputs().add_file(file
);
287 General_options::parse_R(const char* option
, const char* arg
,
288 Command_line
* cmdline
)
291 if (::stat(arg
, &s
) != 0 || S_ISDIR(s
.st_mode
))
292 this->add_to_rpath(arg
);
294 this->parse_just_symbols(option
, arg
, cmdline
);
298 General_options::parse_just_symbols(const char*, const char* arg
,
299 Command_line
* cmdline
)
301 Input_file_argument
file(arg
, false, "", true, *this);
302 cmdline
->inputs().add_file(file
);
306 General_options::parse_static(const char*, const char*, Command_line
*)
308 this->set_static(true);
312 General_options::parse_script(const char*, const char* arg
,
313 Command_line
* cmdline
)
315 if (!read_commandline_script(arg
, cmdline
))
316 gold::gold_fatal(_("unable to parse script file %s"), arg
);
320 General_options::parse_version_script(const char*, const char* arg
,
321 Command_line
* cmdline
)
323 if (!read_version_script(arg
, cmdline
))
324 gold::gold_fatal(_("unable to parse version script file %s"), arg
);
328 General_options::parse_wrap(const char*, const char* arg
,
331 this->wrap_symbols_
.insert(std::string(arg
));
335 General_options::parse_start_group(const char*, const char*,
336 Command_line
* cmdline
)
338 cmdline
->inputs().start_group();
342 General_options::parse_end_group(const char*, const char*,
343 Command_line
* cmdline
)
345 cmdline
->inputs().end_group();
348 } // End namespace gold.
357 _("%s: use the --help option for usage information\n"),
359 ::exit(EXIT_FAILURE
);
363 usage(const char* msg
, const char *opt
)
367 gold::program_name
, opt
, msg
);
371 // Recognize input and output target names. The GNU linker accepts
372 // these with --format and --oformat. This code is intended to be
373 // minimally compatible. In practice for an ELF target this would be
374 // the same target as the input files; that name always start with
375 // "elf". Non-ELF targets would be "srec", "symbolsrec", "tekhex",
378 gold::General_options::Object_format
379 string_to_object_format(const char* arg
)
381 if (strncmp(arg
, "elf", 3) == 0)
382 return gold::General_options::OBJECT_FORMAT_ELF
;
383 else if (strcmp(arg
, "binary") == 0)
384 return gold::General_options::OBJECT_FORMAT_BINARY
;
387 gold::gold_error(_("format '%s' not supported; treating as elf "
388 "(supported formats: elf, binary)"),
390 return gold::General_options::OBJECT_FORMAT_ELF
;
394 // If the default sysroot is relocatable, try relocating it based on
398 get_relative_sysroot(const char* from
)
400 char* path
= make_relative_prefix(gold::program_name
, from
,
405 if (::stat(path
, &s
) == 0 && S_ISDIR(s
.st_mode
))
413 // Return the default sysroot. This is set by the --with-sysroot
414 // option to configure. Note we do not free the return value of
415 // get_relative_sysroot, which is a small memory leak, but is
416 // necessary since we store this pointer directly in General_options.
419 get_default_sysroot()
421 const char* sysroot
= TARGET_SYSTEM_ROOT
;
422 if (*sysroot
== '\0')
425 if (TARGET_SYSTEM_ROOT_RELOCATABLE
)
427 char* path
= get_relative_sysroot(BINDIR
);
429 path
= get_relative_sysroot(TOOLBINDIR
);
437 // Parse a long option. Such options have the form
438 // <-|--><option>[=arg]. If "=arg" is not present but the option
439 // takes an argument, the next word is taken to the be the argument.
440 // If equals_only is set, then only the <option>=<arg> form is
441 // accepted, not the <option><space><arg> form. Returns a One_option
442 // struct or NULL if argv[i] cannot be parsed as a long option. In
443 // the not-NULL case, *arg is set to the option's argument (NULL if
444 // the option takes no argument), and *i is advanced past this option.
445 // NOTE: it is safe for argv and arg to point to the same place.
446 gold::options::One_option
*
447 parse_long_option(int argc
, const char** argv
, bool equals_only
,
448 const char** arg
, int* i
)
450 const char* const this_argv
= argv
[*i
];
452 const char* equals
= strchr(this_argv
, '=');
453 const char* option_start
= this_argv
+ strspn(this_argv
, "-");
454 std::string
option(option_start
,
455 equals
? equals
- option_start
: strlen(option_start
));
457 gold::options::Option_map::iterator it
458 = gold::options::long_options
->find(option
);
459 if (it
== gold::options::long_options
->end())
462 gold::options::One_option
* retval
= it
->second
;
464 // If the dash-count doesn't match, we fail.
465 if (this_argv
[0] != '-') // no dashes at all: had better be "-z <longopt>"
467 if (retval
->dashes
!= gold::options::DASH_Z
)
470 else if (this_argv
[1] != '-') // one dash
472 if (retval
->dashes
!= gold::options::ONE_DASH
473 && retval
->dashes
!= gold::options::EXACTLY_ONE_DASH
474 && retval
->dashes
!= gold::options::TWO_DASHES
)
477 else // two dashes (or more!)
479 if (retval
->dashes
!= gold::options::TWO_DASHES
480 && retval
->dashes
!= gold::options::EXACTLY_TWO_DASHES
481 && retval
->dashes
!= gold::options::ONE_DASH
)
485 // Now that we know the option is good (or else bad in a way that
486 // will cause us to die), increment i to point past this argv.
489 // Figure out the option's argument, if any.
490 if (!retval
->takes_argument())
493 usage(_("unexpected argument"), this_argv
);
501 else if (retval
->takes_optional_argument())
502 *arg
= retval
->default_value
;
503 else if (*i
< argc
&& !equals_only
)
506 usage(_("missing argument"), this_argv
);
512 // Parse a short option. Such options have the form -<option>[arg].
513 // If "arg" is not present but the option takes an argument, the next
514 // word is taken to the be the argument. If the option does not take
515 // an argument, it may be followed by another short option. Returns a
516 // One_option struct or NULL if argv[i] cannot be parsed as a short
517 // option. In the not-NULL case, *arg is set to the option's argument
518 // (NULL if the option takes no argument), and *i is advanced past
519 // this option. This function keeps *i the same if we parsed a short
520 // option that does not take an argument, that looks to be followed by
521 // another short option in the same word.
522 gold::options::One_option
*
523 parse_short_option(int argc
, const char** argv
, int pos_in_argv_i
,
524 const char** arg
, int* i
)
526 const char* const this_argv
= argv
[*i
];
528 if (this_argv
[0] != '-')
531 // We handle -z as a special case.
532 static gold::options::One_option
dash_z("", gold::options::DASH_Z
,
533 'z', "", "-z", "Z-OPTION", false,
535 gold::options::One_option
* retval
= NULL
;
536 if (this_argv
[pos_in_argv_i
] == 'z')
540 const int char_as_int
= static_cast<int>(this_argv
[pos_in_argv_i
]);
541 if (char_as_int
> 0 && char_as_int
< 128)
542 retval
= gold::options::short_options
[char_as_int
];
548 // Figure out the option's argument, if any.
549 if (!retval
->takes_argument())
552 // We only advance past this argument if it's the only one in argv.
553 if (this_argv
[pos_in_argv_i
+ 1] == '\0')
558 // If we take an argument, we'll eat up this entire argv entry.
560 if (this_argv
[pos_in_argv_i
+ 1] != '\0')
561 *arg
= this_argv
+ pos_in_argv_i
+ 1;
562 else if (retval
->takes_optional_argument())
563 *arg
= retval
->default_value
;
567 usage(_("missing argument"), this_argv
);
570 // If we're a -z option, we need to parse our argument as a
571 // long-option, e.g. "-z stacksize=8192".
572 if (retval
== &dash_z
)
575 const char* dash_z_arg
= *arg
;
576 retval
= parse_long_option(1, arg
, true, arg
, &dummy_i
);
578 usage(_("unknown -z option"), dash_z_arg
);
584 } // End anonymous namespace.
589 General_options::General_options()
590 : execstack_status_(General_options::EXECSTACK_FROM_INPUT
), static_(false),
591 do_demangle_(false), wrap_symbols_()
595 General_options::Object_format
596 General_options::format_enum() const
598 return string_to_object_format(this->format());
601 General_options::Object_format
602 General_options::oformat_enum() const
604 return string_to_object_format(this->oformat());
607 // Add the sysroot, if any, to the search paths.
610 General_options::add_sysroot()
612 if (this->sysroot() == NULL
|| this->sysroot()[0] == '\0')
614 this->set_sysroot(get_default_sysroot());
615 if (this->sysroot() == NULL
|| this->sysroot()[0] == '\0')
619 char* canonical_sysroot
= lrealpath(this->sysroot());
621 for (Dir_list::iterator p
= this->library_path_
.value
.begin();
622 p
!= this->library_path_
.value
.end();
624 p
->add_sysroot(this->sysroot(), canonical_sysroot
);
626 free(canonical_sysroot
);
629 // Set up variables and other state that isn't set up automatically by
630 // the parse routine, and ensure options don't contradict each other
631 // and are otherwise kosher.
634 General_options::finalize()
636 // Normalize the strip modifiers. They have a total order:
637 // strip_all > strip_debug > strip_debug_gdb. If one is true, set
638 // all beneath it to true as well.
639 if (this->strip_all())
640 this->set_strip_debug(true);
641 if (this->strip_debug())
642 this->set_strip_debug_gdb(true);
644 // If the user specifies both -s and -r, convert the -s to -S.
645 // -r requires us to keep externally visible symbols!
646 if (this->strip_all() && this->relocatable())
648 this->set_strip_all(false);
649 gold_assert(this->strip_debug());
652 // For us, -dc and -dp are synonyms for --define-common.
654 this->set_define_common(true);
656 this->set_define_common(true);
658 // We also set --define-common if we're not relocatable, as long as
659 // the user didn't explicitly ask for something different.
660 if (!this->user_set_define_common())
661 this->set_define_common(!this->relocatable());
663 // execstack_status_ is a three-state variable; update it based on
665 if (this->execstack())
666 this->set_execstack_status(EXECSTACK_YES
);
667 else if (this->noexecstack())
668 this->set_execstack_status(EXECSTACK_NO
);
670 // Handle the optional argument for --demangle.
671 if (this->user_set_demangle())
673 this->set_do_demangle(true);
674 const char* style
= this->demangle();
677 enum demangling_styles style_code
;
679 style_code
= cplus_demangle_name_to_style(style
);
680 if (style_code
== unknown_demangling
)
681 gold_fatal("unknown demangling style '%s'", style
);
682 cplus_demangle_set_style(style_code
);
685 else if (this->user_set_no_demangle())
686 this->set_do_demangle(false);
689 // Testing COLLECT_NO_DEMANGLE makes our default demangling
690 // behaviour identical to that of gcc's linker wrapper.
691 this->set_do_demangle(getenv("COLLECT_NO_DEMANGLE") == NULL
);
694 // If --thread_count is specified, it applies to
695 // --thread-count-{initial,middle,final}, though it doesn't override
697 if (this->thread_count() > 0 && this->thread_count_initial() == 0)
698 this->set_thread_count_initial(this->thread_count());
699 if (this->thread_count() > 0 && this->thread_count_middle() == 0)
700 this->set_thread_count_middle(this->thread_count());
701 if (this->thread_count() > 0 && this->thread_count_final() == 0)
702 this->set_thread_count_final(this->thread_count());
704 // Let's warn if you set the thread-count but we're going to ignore it.
705 #ifndef ENABLE_THREADS
708 gold_warning(_("ignoring --threads: "
709 "%s was compiled without thread support"),
711 this->set_threads(false);
713 if (this->thread_count() > 0 || this->thread_count_initial() > 0
714 || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
715 gold_warning(_("ignoring --thread-count: "
716 "%s was compiled without thread support"),
720 if (this->user_set_Y())
722 std::string s
= this->Y();
723 if (s
.compare(0, 2, "P,") == 0)
730 next_pos
= s
.find(':', pos
);
731 size_t len
= (next_pos
== std::string::npos
735 this->add_to_library_path_with_sysroot(s
.substr(pos
, len
).c_str());
738 while (next_pos
!= std::string::npos
);
742 // Even if they don't specify it, we add -L /lib and -L /usr/lib.
743 // FIXME: We should only do this when configured in native mode.
744 this->add_to_library_path_with_sysroot("/lib");
745 this->add_to_library_path_with_sysroot("/usr/lib");
748 // Normalize library_path() by adding the sysroot to all directories
749 // in the path, as appropriate.
752 // Now that we've normalized the options, check for contradictory ones.
753 if (this->shared() && this->relocatable())
754 gold_fatal(_("-shared and -r are incompatible"));
756 if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
757 && (this->shared() || this->relocatable()))
758 gold_fatal(_("binary output format not compatible with -shared or -r"));
760 if (this->user_set_hash_bucket_empty_fraction()
761 && (this->hash_bucket_empty_fraction() < 0.0
762 || this->hash_bucket_empty_fraction() >= 1.0))
763 gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
765 this->hash_bucket_empty_fraction());
767 // FIXME: we can/should be doing a lot more sanity checking here.
770 // Search_directory methods.
772 // This is called if we have a sysroot. Apply the sysroot if
773 // appropriate. Record whether the directory is in the sysroot.
776 Search_directory::add_sysroot(const char* sysroot
,
777 const char* canonical_sysroot
)
779 gold_assert(*sysroot
!= '\0');
780 if (this->put_in_sysroot_
)
782 if (!IS_DIR_SEPARATOR(this->name_
[0])
783 && !IS_DIR_SEPARATOR(sysroot
[strlen(sysroot
) - 1]))
784 this->name_
= '/' + this->name_
;
785 this->name_
= sysroot
+ this->name_
;
786 this->is_in_sysroot_
= true;
790 // Check whether this entry is in the sysroot. To do this
791 // correctly, we need to use canonical names. Otherwise we will
792 // get confused by the ../../.. paths that gcc tends to use.
793 char* canonical_name
= lrealpath(this->name_
.c_str());
794 int canonical_name_len
= strlen(canonical_name
);
795 int canonical_sysroot_len
= strlen(canonical_sysroot
);
796 if (canonical_name_len
> canonical_sysroot_len
797 && IS_DIR_SEPARATOR(canonical_name
[canonical_sysroot_len
]))
799 canonical_name
[canonical_sysroot_len
] = '\0';
800 if (FILENAME_CMP(canonical_name
, canonical_sysroot
) == 0)
801 this->is_in_sysroot_
= true;
803 free(canonical_name
);
807 // Input_arguments methods.
809 // Add a file to the list.
812 Input_arguments::add_file(const Input_file_argument
& file
)
814 if (!this->in_group_
)
815 this->input_argument_list_
.push_back(Input_argument(file
));
818 gold_assert(!this->input_argument_list_
.empty());
819 gold_assert(this->input_argument_list_
.back().is_group());
820 this->input_argument_list_
.back().group()->add_file(file
);
827 Input_arguments::start_group()
830 gold_fatal(_("May not nest groups"));
831 Input_file_group
* group
= new Input_file_group();
832 this->input_argument_list_
.push_back(Input_argument(group
));
833 this->in_group_
= true;
839 Input_arguments::end_group()
841 if (!this->in_group_
)
842 gold_fatal(_("Group end without group start"));
843 this->in_group_
= false;
846 // Command_line options.
848 Command_line::Command_line()
852 // Process the command line options. For process_one_option, i is the
853 // index of argv to process next, and must be an option (that is,
854 // start with a dash). The return value is the index of the next
855 // option to process (i+1 or i+2, or argc to indicate processing is
856 // done). no_more_options is set to true if (and when) "--" is seen
860 Command_line::process_one_option(int argc
, const char** argv
, int i
,
861 bool* no_more_options
)
863 gold_assert(argv
[i
][0] == '-' && !(*no_more_options
));
865 // If we are reading "--", then just set no_more_options and return.
866 if (argv
[i
][1] == '-' && argv
[i
][2] == '\0')
868 *no_more_options
= true;
873 options::One_option
* option
= NULL
;
874 const char* arg
= NULL
;
876 // First, try to process argv as a long option.
877 option
= parse_long_option(argc
, argv
, false, &arg
, &new_i
);
880 option
->reader
->parse_to_value(argv
[i
], arg
, this, &this->options_
);
884 // Now, try to process argv as a short option. Since several short
885 // options can be combined in one argv, we may have to parse a lot
886 // until we're done reading this argv.
887 int pos_in_argv_i
= 1;
890 option
= parse_short_option(argc
, argv
, pos_in_argv_i
, &arg
, &new_i
);
893 option
->reader
->parse_to_value(argv
[i
], arg
, this, &this->options_
);
899 // I guess it's neither a long option nor a short option.
900 usage(_("unknown option"), argv
[i
]);
906 Command_line::process(int argc
, const char** argv
)
908 bool no_more_options
= false;
912 this->position_options_
.copy_from_options(this->options());
913 if (no_more_options
|| argv
[i
][0] != '-')
915 Input_file_argument
file(argv
[i
], false, "", false,
916 this->position_options_
);
917 this->inputs_
.add_file(file
);
921 i
= process_one_option(argc
, argv
, i
, &no_more_options
);
924 if (this->inputs_
.in_group())
926 fprintf(stderr
, _("%s: missing group end\n"), program_name
);
930 // Normalize the options and ensure they don't contradict each other.
931 this->options_
.finalize();
934 } // End namespace gold.