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_set(const char*, const char* arg, String_set* retval)
227 retval->insert(std::string(arg));
231 parse_choices(const char* option_name, const char* arg, const char** retval,
232 const char* choices[], int num_choices)
234 for (int i = 0; i < num_choices; i++)
235 if (strcmp(choices[i], arg) == 0)
241 // If we get here, the user did not enter a valid choice, so we die.
242 std::string choices_list;
243 for (int i = 0; i < num_choices; i++)
245 choices_list += choices[i];
246 if (i != num_choices - 1)
247 choices_list += ", ";
249 gold_fatal(_("%s: must take one of the following arguments: %s"),
250 option_name, choices_list.c_str());
253 } // End namespace options.
255 // Define the handler for "special" options (set via DEFINE_special).
258 General_options::parse_help(const char*, const char*, Command_line*)
261 ::exit(EXIT_SUCCESS);
265 General_options::parse_version(const char* opt, const char*, Command_line*)
267 gold::print_version(opt[0] == '-' && opt[1] == 'v');
268 ::exit(EXIT_SUCCESS);
272 General_options::parse_V(const char*, const char*, Command_line*)
274 gold::print_version(true);
275 printf(_(" Supported targets:\n"));
276 std::vector<const char*> supported_names;
277 gold::supported_target_names(&supported_names);
278 for (std::vector<const char*>::const_iterator p = supported_names.begin();
279 p != supported_names.end();
285 General_options::parse_Bstatic(const char*, const char*, Command_line*)
287 this->set_Bdynamic(false);
291 General_options::parse_defsym(const char*, const char* arg,
292 Command_line* cmdline)
294 cmdline->script_options().define_symbol(arg);
298 General_options::parse_library(const char*, const char* arg,
299 Command_line* cmdline)
301 Input_file_argument file(arg, true, "", false, *this);
302 cmdline->inputs().add_file(file);
306 General_options::parse_R(const char* option, const char* arg,
307 Command_line* cmdline)
310 if (::stat(arg, &s) != 0 || S_ISDIR(s.st_mode))
311 this->add_to_rpath(arg);
313 this->parse_just_symbols(option, arg, cmdline);
317 General_options::parse_just_symbols(const char*, const char* arg,
318 Command_line* cmdline)
320 Input_file_argument file(arg, false, "", true, *this);
321 cmdline->inputs().add_file(file);
325 General_options::parse_static(const char*, const char*, Command_line*)
327 this->set_static(true);
331 General_options::parse_script(const char*, const char* arg,
332 Command_line* cmdline)
334 if (!read_commandline_script(arg, cmdline))
335 gold::gold_fatal(_("unable to parse script file %s"), arg);
339 General_options::parse_version_script(const char*, const char* arg,
340 Command_line* cmdline)
342 if (!read_version_script(arg, cmdline))
343 gold::gold_fatal(_("unable to parse version script file %s"), arg);
347 General_options::parse_start_group(const char*, const char*,
348 Command_line* cmdline)
350 cmdline->inputs().start_group();
354 General_options::parse_end_group(const char*, const char*,
355 Command_line* cmdline)
357 cmdline->inputs().end_group();
360 } // End namespace gold.
369 _("%s: use the --help option for usage information\n"),
371 ::exit(EXIT_FAILURE);
375 usage(const char* msg, const char *opt)
379 gold::program_name, opt, msg);
383 // Recognize input and output target names. The GNU linker accepts
384 // these with --format and --oformat. This code is intended to be
385 // minimally compatible. In practice for an ELF target this would be
386 // the same target as the input files; that name always start with
387 // "elf". Non-ELF targets would be "srec", "symbolsrec", "tekhex",
390 gold::General_options::Object_format
391 string_to_object_format(const char* arg)
393 if (strncmp(arg, "elf", 3) == 0)
394 return gold::General_options::OBJECT_FORMAT_ELF;
395 else if (strcmp(arg, "binary") == 0)
396 return gold::General_options::OBJECT_FORMAT_BINARY;
399 gold::gold_error(_("format '%s' not supported; treating as elf "
400 "(supported formats: elf, binary)"),
402 return gold::General_options::OBJECT_FORMAT_ELF;
406 // If the default sysroot is relocatable, try relocating it based on
410 get_relative_sysroot(const char* from)
412 char* path = make_relative_prefix(gold::program_name, from,
417 if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
425 // Return the default sysroot. This is set by the --with-sysroot
426 // option to configure. Note we do not free the return value of
427 // get_relative_sysroot, which is a small memory leak, but is
428 // necessary since we store this pointer directly in General_options.
431 get_default_sysroot()
433 const char* sysroot = TARGET_SYSTEM_ROOT;
434 if (*sysroot == '\0')
437 if (TARGET_SYSTEM_ROOT_RELOCATABLE)
439 char* path = get_relative_sysroot(BINDIR);
441 path = get_relative_sysroot(TOOLBINDIR);
449 // Parse a long option. Such options have the form
450 // <-|--><option>[=arg]. If "=arg" is not present but the option
451 // takes an argument, the next word is taken to the be the argument.
452 // If equals_only is set, then only the <option>=<arg> form is
453 // accepted, not the <option><space><arg> form. Returns a One_option
454 // struct or NULL if argv[i] cannot be parsed as a long option. In
455 // the not-NULL case, *arg is set to the option's argument (NULL if
456 // the option takes no argument), and *i is advanced past this option.
457 // NOTE: it is safe for argv and arg to point to the same place.
458 gold::options::One_option*
459 parse_long_option(int argc, const char** argv, bool equals_only,
460 const char** arg, int* i)
462 const char* const this_argv = argv[*i];
464 const char* equals = strchr(this_argv, '=');
465 const char* option_start = this_argv + strspn(this_argv, "-");
466 std::string option(option_start,
467 equals ? equals - option_start : strlen(option_start));
469 gold::options::Option_map::iterator it
470 = gold::options::long_options->find(option);
471 if (it == gold::options::long_options->end())
474 gold::options::One_option* retval = it->second;
476 // If the dash-count doesn't match, we fail.
477 if (this_argv[0] != '-') // no dashes at all: had better be "-z <longopt>"
479 if (retval->dashes != gold::options::DASH_Z)
482 else if (this_argv[1] != '-') // one dash
484 if (retval->dashes != gold::options::ONE_DASH
485 && retval->dashes != gold::options::EXACTLY_ONE_DASH
486 && retval->dashes != gold::options::TWO_DASHES)
489 else // two dashes (or more!)
491 if (retval->dashes != gold::options::TWO_DASHES
492 && retval->dashes != gold::options::EXACTLY_TWO_DASHES
493 && retval->dashes != gold::options::ONE_DASH)
497 // Now that we know the option is good (or else bad in a way that
498 // will cause us to die), increment i to point past this argv.
501 // Figure out the option's argument, if any.
502 if (!retval->takes_argument())
505 usage(_("unexpected argument"), this_argv);
513 else if (retval->takes_optional_argument())
514 *arg = retval->default_value;
515 else if (*i < argc && !equals_only)
518 usage(_("missing argument"), this_argv);
524 // Parse a short option. Such options have the form -<option>[arg].
525 // If "arg" is not present but the option takes an argument, the next
526 // word is taken to the be the argument. If the option does not take
527 // an argument, it may be followed by another short option. Returns a
528 // One_option struct or NULL if argv[i] cannot be parsed as a short
529 // option. In the not-NULL case, *arg is set to the option's argument
530 // (NULL if the option takes no argument), and *i is advanced past
531 // this option. This function keeps *i the same if we parsed a short
532 // option that does not take an argument, that looks to be followed by
533 // another short option in the same word.
534 gold::options::One_option*
535 parse_short_option(int argc, const char** argv, int pos_in_argv_i,
536 const char** arg, int* i)
538 const char* const this_argv = argv[*i];
540 if (this_argv[0] != '-')
543 // We handle -z as a special case.
544 static gold::options::One_option dash_z("", gold::options::DASH_Z,
545 'z', "", "-z", "Z-OPTION", false,
547 gold::options::One_option* retval = NULL;
548 if (this_argv[pos_in_argv_i] == 'z')
552 const int char_as_int = static_cast<int>(this_argv[pos_in_argv_i]);
553 if (char_as_int > 0 && char_as_int < 128)
554 retval = gold::options::short_options[char_as_int];
560 // Figure out the option's argument, if any.
561 if (!retval->takes_argument())
564 // We only advance past this argument if it's the only one in argv.
565 if (this_argv[pos_in_argv_i + 1] == '\0')
570 // If we take an argument, we'll eat up this entire argv entry.
572 if (this_argv[pos_in_argv_i + 1] != '\0')
573 *arg = this_argv + pos_in_argv_i + 1;
574 else if (retval->takes_optional_argument())
575 *arg = retval->default_value;
579 usage(_("missing argument"), this_argv);
582 // If we're a -z option, we need to parse our argument as a
583 // long-option, e.g. "-z stacksize=8192".
584 if (retval == &dash_z)
587 const char* dash_z_arg = *arg;
588 retval = parse_long_option(1, arg, true, arg, &dummy_i);
590 usage(_("unknown -z option"), dash_z_arg);
596 } // End anonymous namespace.
601 General_options::General_options()
602 : execstack_status_(General_options::EXECSTACK_FROM_INPUT), static_(false),
607 General_options::Object_format
608 General_options::format_enum() const
610 return string_to_object_format(this->format());
613 General_options::Object_format
614 General_options::oformat_enum() const
616 return string_to_object_format(this->oformat());
619 // Add the sysroot, if any, to the search paths.
622 General_options::add_sysroot()
624 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
626 this->set_sysroot(get_default_sysroot());
627 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
631 char* canonical_sysroot = lrealpath(this->sysroot());
633 for (Dir_list::iterator p = this->library_path_.value.begin();
634 p != this->library_path_.value.end();
636 p->add_sysroot(this->sysroot(), canonical_sysroot);
638 free(canonical_sysroot);
641 // Set up variables and other state that isn't set up automatically by
642 // the parse routine, and ensure options don't contradict each other
643 // and are otherwise kosher.
646 General_options::finalize()
648 // Normalize the strip modifiers. They have a total order:
649 // strip_all > strip_debug > strip_debug_gdb. If one is true, set
650 // all beneath it to true as well.
651 if (this->strip_all())
652 this->set_strip_debug(true);
653 if (this->strip_debug())
654 this->set_strip_debug_gdb(true);
656 // If the user specifies both -s and -r, convert the -s to -S.
657 // -r requires us to keep externally visible symbols!
658 if (this->strip_all() && this->relocatable())
660 this->set_strip_all(false);
661 gold_assert(this->strip_debug());
664 // For us, -dc and -dp are synonyms for --define-common.
666 this->set_define_common(true);
668 this->set_define_common(true);
670 // We also set --define-common if we're not relocatable, as long as
671 // the user didn't explicitly ask for something different.
672 if (!this->user_set_define_common())
673 this->set_define_common(!this->relocatable());
675 // execstack_status_ is a three-state variable; update it based on
677 if (this->execstack())
678 this->set_execstack_status(EXECSTACK_YES);
679 else if (this->noexecstack())
680 this->set_execstack_status(EXECSTACK_NO);
682 // Handle the optional argument for --demangle.
683 if (this->user_set_demangle())
685 this->set_do_demangle(true);
686 const char* style = this->demangle();
689 enum demangling_styles style_code;
691 style_code = cplus_demangle_name_to_style(style);
692 if (style_code == unknown_demangling)
693 gold_fatal("unknown demangling style '%s'", style);
694 cplus_demangle_set_style(style_code);
697 else if (this->user_set_no_demangle())
698 this->set_do_demangle(false);
701 // Testing COLLECT_NO_DEMANGLE makes our default demangling
702 // behaviour identical to that of gcc's linker wrapper.
703 this->set_do_demangle(getenv("COLLECT_NO_DEMANGLE") == NULL);
706 // If --thread_count is specified, it applies to
707 // --thread-count-{initial,middle,final}, though it doesn't override
709 if (this->thread_count() > 0 && this->thread_count_initial() == 0)
710 this->set_thread_count_initial(this->thread_count());
711 if (this->thread_count() > 0 && this->thread_count_middle() == 0)
712 this->set_thread_count_middle(this->thread_count());
713 if (this->thread_count() > 0 && this->thread_count_final() == 0)
714 this->set_thread_count_final(this->thread_count());
716 // Let's warn if you set the thread-count but we're going to ignore it.
717 #ifndef ENABLE_THREADS
720 gold_warning(_("ignoring --threads: "
721 "%s was compiled without thread support"),
723 this->set_threads(false);
725 if (this->thread_count() > 0 || this->thread_count_initial() > 0
726 || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
727 gold_warning(_("ignoring --thread-count: "
728 "%s was compiled without thread support"),
732 if (this->user_set_Y())
734 std::string s = this->Y();
735 if (s.compare(0, 2, "P,") == 0)
742 next_pos = s.find(':', pos);
743 size_t len = (next_pos == std::string::npos
747 this->add_to_library_path_with_sysroot(s.substr(pos, len).c_str());
750 while (next_pos != std::string::npos);
754 // Even if they don't specify it, we add -L /lib and -L /usr/lib.
755 // FIXME: We should only do this when configured in native mode.
756 this->add_to_library_path_with_sysroot("/lib");
757 this->add_to_library_path_with_sysroot("/usr/lib");
760 // Normalize library_path() by adding the sysroot to all directories
761 // in the path, as appropriate.
764 // Now that we've normalized the options, check for contradictory ones.
765 if (this->shared() && this->relocatable())
766 gold_fatal(_("-shared and -r are incompatible"));
768 if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
769 && (this->shared() || this->relocatable()))
770 gold_fatal(_("binary output format not compatible with -shared or -r"));
772 if (this->user_set_hash_bucket_empty_fraction()
773 && (this->hash_bucket_empty_fraction() < 0.0
774 || this->hash_bucket_empty_fraction() >= 1.0))
775 gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
777 this->hash_bucket_empty_fraction());
779 // FIXME: we can/should be doing a lot more sanity checking here.
782 // Search_directory methods.
784 // This is called if we have a sysroot. Apply the sysroot if
785 // appropriate. Record whether the directory is in the sysroot.
788 Search_directory::add_sysroot(const char* sysroot,
789 const char* canonical_sysroot)
791 gold_assert(*sysroot != '\0');
792 if (this->put_in_sysroot_)
794 if (!IS_DIR_SEPARATOR(this->name_[0])
795 && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
796 this->name_ = '/' + this->name_;
797 this->name_ = sysroot + this->name_;
798 this->is_in_sysroot_ = true;
802 // Check whether this entry is in the sysroot. To do this
803 // correctly, we need to use canonical names. Otherwise we will
804 // get confused by the ../../.. paths that gcc tends to use.
805 char* canonical_name = lrealpath(this->name_.c_str());
806 int canonical_name_len = strlen(canonical_name);
807 int canonical_sysroot_len = strlen(canonical_sysroot);
808 if (canonical_name_len > canonical_sysroot_len
809 && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
811 canonical_name[canonical_sysroot_len] = '\0';
812 if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
813 this->is_in_sysroot_ = true;
815 free(canonical_name);
819 // Input_arguments methods.
821 // Add a file to the list.
824 Input_arguments::add_file(const Input_file_argument& file)
826 if (!this->in_group_)
827 this->input_argument_list_.push_back(Input_argument(file));
830 gold_assert(!this->input_argument_list_.empty());
831 gold_assert(this->input_argument_list_.back().is_group());
832 this->input_argument_list_.back().group()->add_file(file);
839 Input_arguments::start_group()
842 gold_fatal(_("May not nest groups"));
843 Input_file_group* group = new Input_file_group();
844 this->input_argument_list_.push_back(Input_argument(group));
845 this->in_group_ = true;
851 Input_arguments::end_group()
853 if (!this->in_group_)
854 gold_fatal(_("Group end without group start"));
855 this->in_group_ = false;
858 // Command_line options.
860 Command_line::Command_line()
864 // Process the command line options. For process_one_option, i is the
865 // index of argv to process next, and must be an option (that is,
866 // start with a dash). The return value is the index of the next
867 // option to process (i+1 or i+2, or argc to indicate processing is
868 // done). no_more_options is set to true if (and when) "--" is seen
872 Command_line::process_one_option(int argc, const char** argv, int i,
873 bool* no_more_options)
875 gold_assert(argv[i][0] == '-' && !(*no_more_options));
877 // If we are reading "--", then just set no_more_options and return.
878 if (argv[i][1] == '-' && argv[i][2] == '\0')
880 *no_more_options = true;
885 options::One_option* option = NULL;
886 const char* arg = NULL;
888 // First, try to process argv as a long option.
889 option = parse_long_option(argc, argv, false, &arg, &new_i);
892 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
896 // Now, try to process argv as a short option. Since several short
897 // options can be combined in one argv, we may have to parse a lot
898 // until we're done reading this argv.
899 int pos_in_argv_i = 1;
902 option = parse_short_option(argc, argv, pos_in_argv_i, &arg, &new_i);
905 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
911 // I guess it's neither a long option nor a short option.
912 usage(_("unknown option"), argv[i]);
918 Command_line::process(int argc, const char** argv)
920 bool no_more_options = false;
924 this->position_options_.copy_from_options(this->options());
925 if (no_more_options || argv[i][0] != '-')
927 Input_file_argument file(argv[i], false, "", false,
928 this->position_options_);
929 this->inputs_.add_file(file);
933 i = process_one_option(argc, argv, i, &no_more_options);
936 if (this->inputs_.in_group())
938 fprintf(stderr, _("%s: missing group end\n"), program_name);
942 // Normalize the options and ensure they don't contradict each other.
943 this->options_.finalize();
946 } // End namespace gold.