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"
45 Position_dependent_options::default_options_;
50 // This global variable is set up as General_options is constructed.
51 static std::vector<const One_option*> registered_options;
53 // These are set up at the same time -- the variables that accept one
54 // dash, two, or require -z. A single variable may be in more than
55 // one of thes data structures.
56 typedef Unordered_map<std::string, One_option*> Option_map;
57 static Option_map* long_options = NULL;
58 static One_option* short_options[128];
61 One_option::register_option()
63 registered_options.push_back(this);
65 // We can't make long_options a static Option_map because we can't
66 // guarantee that will be initialized before register_option() is
68 if (long_options == NULL)
69 long_options = new Option_map;
71 // TWO_DASHES means that two dashes are preferred, but one is ok too.
72 if (!this->longname.empty())
73 (*long_options)[this->longname] = this;
75 const int shortname_as_int = static_cast<int>(this->shortname);
76 gold_assert(shortname_as_int >= 0 && shortname_as_int < 128);
77 if (this->shortname != '\0')
78 short_options[shortname_as_int] = this;
82 One_option::print() const
87 if (this->shortname != '\0')
89 len += printf("-%c", this->shortname);
92 // -z takes long-names only.
93 gold_assert(this->dashes != DASH_Z);
94 len += printf(" %s", gettext(this->helparg));
98 if (!this->longname.empty()
99 && !(this->longname[0] == this->shortname
100 && this->longname[1] == '\0'))
104 switch (this->dashes)
106 case options::ONE_DASH: case options::EXACTLY_ONE_DASH:
109 case options::TWO_DASHES: case options::EXACTLY_TWO_DASHES:
112 case options::DASH_Z:
113 len += printf("-z ");
118 len += printf("%s", this->longname.c_str());
121 // For most options, we print "--frob FOO". But for -z
122 // we print "-z frob=FOO".
123 len += printf("%c%s", this->dashes == options::DASH_Z ? '=' : ' ',
124 gettext(this->helparg));
133 for (; len < 30; ++len)
136 // TODO: if we're boolean, add " (default)" when appropriate.
137 printf("%s\n", gettext(this->helpstring));
143 printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name);
145 std::vector<const One_option*>::const_iterator it;
146 for (it = registered_options.begin(); it != registered_options.end(); ++it)
149 // config.guess and libtool.m4 look in ld --help output for the
150 // string "supported targets".
151 printf(_("%s: supported targets:"), gold::program_name);
152 std::vector<const char*> supported_names;
153 gold::supported_target_names(&supported_names);
154 for (std::vector<const char*>::const_iterator p = supported_names.begin();
155 p != supported_names.end();
160 // REPORT_BUGS_TO is defined in bfd/bfdver.h.
161 const char* report = REPORT_BUGS_TO;
163 printf(_("Report bugs to %s\n"), report);
166 // For bool, arg will be NULL (boolean options take no argument);
167 // we always just set to true.
169 parse_bool(const char*, const char*, bool* retval)
175 parse_uint(const char* option_name, const char* arg, int* retval)
178 *retval = strtol(arg, &endptr, 0);
179 if (*endptr != '\0' || retval < 0)
180 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
185 parse_uint64(const char* option_name, const char* arg, uint64_t *retval)
188 *retval = strtoull(arg, &endptr, 0);
190 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
195 parse_double(const char* option_name, const char* arg, double* retval)
198 *retval = strtod(arg, &endptr);
200 gold_fatal(_("%s: invalid option value "
201 "(expected a floating point number): %s"),
206 parse_string(const char* option_name, const char* arg, const char** retval)
209 gold_fatal(_("%s: must take a non-empty argument"), option_name);
214 parse_optional_string(const char*, const char* arg, const char** retval)
220 parse_dirlist(const char*, const char* arg, Dir_list* retval)
222 retval->push_back(Search_directory(arg, false));
226 parse_set(const char*, const char* arg, String_set* retval)
228 retval->insert(std::string(arg));
232 parse_choices(const char* option_name, const char* arg, const char** retval,
233 const char* choices[], int num_choices)
235 for (int i = 0; i < num_choices; i++)
236 if (strcmp(choices[i], arg) == 0)
242 // If we get here, the user did not enter a valid choice, so we die.
243 std::string choices_list;
244 for (int i = 0; i < num_choices; i++)
246 choices_list += choices[i];
247 if (i != num_choices - 1)
248 choices_list += ", ";
250 gold_fatal(_("%s: must take one of the following arguments: %s"),
251 option_name, choices_list.c_str());
254 } // End namespace options.
256 // Define the handler for "special" options (set via DEFINE_special).
259 General_options::parse_help(const char*, const char*, Command_line*)
262 ::exit(EXIT_SUCCESS);
266 General_options::parse_version(const char* opt, const char*, Command_line*)
268 gold::print_version(opt[0] == '-' && opt[1] == 'v');
269 ::exit(EXIT_SUCCESS);
273 General_options::parse_V(const char*, const char*, Command_line*)
275 gold::print_version(true);
276 printf(_(" Supported targets:\n"));
277 std::vector<const char*> supported_names;
278 gold::supported_target_names(&supported_names);
279 for (std::vector<const char*>::const_iterator p = supported_names.begin();
280 p != supported_names.end();
286 General_options::parse_defsym(const char*, const char* arg,
287 Command_line* cmdline)
289 cmdline->script_options().define_symbol(arg);
293 General_options::parse_library(const char*, const char* arg,
294 Command_line* cmdline)
296 Input_file_argument file(arg, true, "", false, *this);
297 cmdline->inputs().add_file(file);
300 #ifdef ENABLE_PLUGINS
302 General_options::parse_plugin(const char*, const char* arg,
305 this->add_plugin(arg);
307 #endif // ENABLE_PLUGINS
310 General_options::parse_R(const char* option, const char* arg,
311 Command_line* cmdline)
314 if (::stat(arg, &s) != 0 || S_ISDIR(s.st_mode))
315 this->add_to_rpath(arg);
317 this->parse_just_symbols(option, arg, cmdline);
321 General_options::parse_just_symbols(const char*, const char* arg,
322 Command_line* cmdline)
324 Input_file_argument file(arg, false, "", true, *this);
325 cmdline->inputs().add_file(file);
329 General_options::parse_static(const char*, const char*, Command_line*)
331 this->set_static(true);
335 General_options::parse_script(const char*, const char* arg,
336 Command_line* cmdline)
338 if (!read_commandline_script(arg, cmdline))
339 gold::gold_fatal(_("unable to parse script file %s"), arg);
343 General_options::parse_version_script(const char*, const char* arg,
344 Command_line* cmdline)
346 if (!read_version_script(arg, cmdline))
347 gold::gold_fatal(_("unable to parse version script file %s"), arg);
351 General_options::parse_start_group(const char*, const char*,
352 Command_line* cmdline)
354 cmdline->inputs().start_group();
358 General_options::parse_end_group(const char*, const char*,
359 Command_line* cmdline)
361 cmdline->inputs().end_group();
364 } // End namespace gold.
373 _("%s: use the --help option for usage information\n"),
375 ::exit(EXIT_FAILURE);
379 usage(const char* msg, const char *opt)
383 gold::program_name, opt, msg);
387 // Recognize input and output target names. The GNU linker accepts
388 // these with --format and --oformat. This code is intended to be
389 // minimally compatible. In practice for an ELF target this would be
390 // the same target as the input files; that name always start with
391 // "elf". Non-ELF targets would be "srec", "symbolsrec", "tekhex",
394 gold::General_options::Object_format
395 string_to_object_format(const char* arg)
397 if (strncmp(arg, "elf", 3) == 0)
398 return gold::General_options::OBJECT_FORMAT_ELF;
399 else if (strcmp(arg, "binary") == 0)
400 return gold::General_options::OBJECT_FORMAT_BINARY;
403 gold::gold_error(_("format '%s' not supported; treating as elf "
404 "(supported formats: elf, binary)"),
406 return gold::General_options::OBJECT_FORMAT_ELF;
410 // If the default sysroot is relocatable, try relocating it based on
414 get_relative_sysroot(const char* from)
416 char* path = make_relative_prefix(gold::program_name, from,
421 if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
429 // Return the default sysroot. This is set by the --with-sysroot
430 // option to configure. Note we do not free the return value of
431 // get_relative_sysroot, which is a small memory leak, but is
432 // necessary since we store this pointer directly in General_options.
435 get_default_sysroot()
437 const char* sysroot = TARGET_SYSTEM_ROOT;
438 if (*sysroot == '\0')
441 if (TARGET_SYSTEM_ROOT_RELOCATABLE)
443 char* path = get_relative_sysroot(BINDIR);
445 path = get_relative_sysroot(TOOLBINDIR);
453 // Parse a long option. Such options have the form
454 // <-|--><option>[=arg]. If "=arg" is not present but the option
455 // takes an argument, the next word is taken to the be the argument.
456 // If equals_only is set, then only the <option>=<arg> form is
457 // accepted, not the <option><space><arg> form. Returns a One_option
458 // struct or NULL if argv[i] cannot be parsed as a long option. In
459 // the not-NULL case, *arg is set to the option's argument (NULL if
460 // the option takes no argument), and *i is advanced past this option.
461 // NOTE: it is safe for argv and arg to point to the same place.
462 gold::options::One_option*
463 parse_long_option(int argc, const char** argv, bool equals_only,
464 const char** arg, int* i)
466 const char* const this_argv = argv[*i];
468 const char* equals = strchr(this_argv, '=');
469 const char* option_start = this_argv + strspn(this_argv, "-");
470 std::string option(option_start,
471 equals ? equals - option_start : strlen(option_start));
473 gold::options::Option_map::iterator it
474 = gold::options::long_options->find(option);
475 if (it == gold::options::long_options->end())
478 gold::options::One_option* retval = it->second;
480 // If the dash-count doesn't match, we fail.
481 if (this_argv[0] != '-') // no dashes at all: had better be "-z <longopt>"
483 if (retval->dashes != gold::options::DASH_Z)
486 else if (this_argv[1] != '-') // one dash
488 if (retval->dashes != gold::options::ONE_DASH
489 && retval->dashes != gold::options::EXACTLY_ONE_DASH
490 && retval->dashes != gold::options::TWO_DASHES)
493 else // two dashes (or more!)
495 if (retval->dashes != gold::options::TWO_DASHES
496 && retval->dashes != gold::options::EXACTLY_TWO_DASHES
497 && retval->dashes != gold::options::ONE_DASH)
501 // Now that we know the option is good (or else bad in a way that
502 // will cause us to die), increment i to point past this argv.
505 // Figure out the option's argument, if any.
506 if (!retval->takes_argument())
509 usage(_("unexpected argument"), this_argv);
517 else if (retval->takes_optional_argument())
518 *arg = retval->default_value;
519 else if (*i < argc && !equals_only)
522 usage(_("missing argument"), this_argv);
528 // Parse a short option. Such options have the form -<option>[arg].
529 // If "arg" is not present but the option takes an argument, the next
530 // word is taken to the be the argument. If the option does not take
531 // an argument, it may be followed by another short option. Returns a
532 // One_option struct or NULL if argv[i] cannot be parsed as a short
533 // option. In the not-NULL case, *arg is set to the option's argument
534 // (NULL if the option takes no argument), and *i is advanced past
535 // this option. This function keeps *i the same if we parsed a short
536 // option that does not take an argument, that looks to be followed by
537 // another short option in the same word.
538 gold::options::One_option*
539 parse_short_option(int argc, const char** argv, int pos_in_argv_i,
540 const char** arg, int* i)
542 const char* const this_argv = argv[*i];
544 if (this_argv[0] != '-')
547 // We handle -z as a special case.
548 static gold::options::One_option dash_z("", gold::options::DASH_Z,
549 'z', "", "-z", "Z-OPTION", false,
551 gold::options::One_option* retval = NULL;
552 if (this_argv[pos_in_argv_i] == 'z')
556 const int char_as_int = static_cast<int>(this_argv[pos_in_argv_i]);
557 if (char_as_int > 0 && char_as_int < 128)
558 retval = gold::options::short_options[char_as_int];
564 // Figure out the option's argument, if any.
565 if (!retval->takes_argument())
568 // We only advance past this argument if it's the only one in argv.
569 if (this_argv[pos_in_argv_i + 1] == '\0')
574 // If we take an argument, we'll eat up this entire argv entry.
576 if (this_argv[pos_in_argv_i + 1] != '\0')
577 *arg = this_argv + pos_in_argv_i + 1;
578 else if (retval->takes_optional_argument())
579 *arg = retval->default_value;
583 usage(_("missing argument"), this_argv);
586 // If we're a -z option, we need to parse our argument as a
587 // long-option, e.g. "-z stacksize=8192".
588 if (retval == &dash_z)
591 const char* dash_z_arg = *arg;
592 retval = parse_long_option(1, arg, true, arg, &dummy_i);
594 usage(_("unknown -z option"), dash_z_arg);
600 } // End anonymous namespace.
605 General_options::General_options()
606 : execstack_status_(General_options::EXECSTACK_FROM_INPUT), static_(false),
607 do_demangle_(false), plugins_()
611 General_options::Object_format
612 General_options::format_enum() const
614 return string_to_object_format(this->format());
617 General_options::Object_format
618 General_options::oformat_enum() const
620 return string_to_object_format(this->oformat());
623 // Add the sysroot, if any, to the search paths.
626 General_options::add_sysroot()
628 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
630 this->set_sysroot(get_default_sysroot());
631 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
635 char* canonical_sysroot = lrealpath(this->sysroot());
637 for (Dir_list::iterator p = this->library_path_.value.begin();
638 p != this->library_path_.value.end();
640 p->add_sysroot(this->sysroot(), canonical_sysroot);
642 free(canonical_sysroot);
645 // Add a plugin and its arguments to the list of plugins.
648 General_options::add_plugin(const char* arg)
650 if (this->plugins_ == NULL)
651 this->plugins_ = new Plugin_manager(*this);
652 this->plugins_->add_plugin(arg);
655 // Set up variables and other state that isn't set up automatically by
656 // the parse routine, and ensure options don't contradict each other
657 // and are otherwise kosher.
660 General_options::finalize()
662 // Normalize the strip modifiers. They have a total order:
663 // strip_all > strip_debug > strip_non_line > strip_debug_gdb.
664 // If one is true, set all beneath it to true as well.
665 if (this->strip_all())
666 this->set_strip_debug(true);
667 if (this->strip_debug())
668 this->set_strip_debug_non_line(true);
669 if (this->strip_debug_non_line())
670 this->set_strip_debug_gdb(true);
672 // If the user specifies both -s and -r, convert the -s to -S.
673 // -r requires us to keep externally visible symbols!
674 if (this->strip_all() && this->relocatable())
676 this->set_strip_all(false);
677 gold_assert(this->strip_debug());
680 // For us, -dc and -dp are synonyms for --define-common.
682 this->set_define_common(true);
684 this->set_define_common(true);
686 // We also set --define-common if we're not relocatable, as long as
687 // the user didn't explicitly ask for something different.
688 if (!this->user_set_define_common())
689 this->set_define_common(!this->relocatable());
691 // execstack_status_ is a three-state variable; update it based on
693 if (this->execstack())
694 this->set_execstack_status(EXECSTACK_YES);
695 else if (this->noexecstack())
696 this->set_execstack_status(EXECSTACK_NO);
698 // Handle the optional argument for --demangle.
699 if (this->user_set_demangle())
701 this->set_do_demangle(true);
702 const char* style = this->demangle();
705 enum demangling_styles style_code;
707 style_code = cplus_demangle_name_to_style(style);
708 if (style_code == unknown_demangling)
709 gold_fatal("unknown demangling style '%s'", style);
710 cplus_demangle_set_style(style_code);
713 else if (this->user_set_no_demangle())
714 this->set_do_demangle(false);
717 // Testing COLLECT_NO_DEMANGLE makes our default demangling
718 // behaviour identical to that of gcc's linker wrapper.
719 this->set_do_demangle(getenv("COLLECT_NO_DEMANGLE") == NULL);
722 // -M is equivalent to "-Map -".
723 if (this->print_map() && !this->user_set_Map())
726 this->set_user_set_Map();
729 // Using -n or -N implies -static.
730 if (this->nmagic() || this->omagic())
731 this->set_static(true);
733 // If --thread_count is specified, it applies to
734 // --thread-count-{initial,middle,final}, though it doesn't override
736 if (this->thread_count() > 0 && this->thread_count_initial() == 0)
737 this->set_thread_count_initial(this->thread_count());
738 if (this->thread_count() > 0 && this->thread_count_middle() == 0)
739 this->set_thread_count_middle(this->thread_count());
740 if (this->thread_count() > 0 && this->thread_count_final() == 0)
741 this->set_thread_count_final(this->thread_count());
743 // Let's warn if you set the thread-count but we're going to ignore it.
744 #ifndef ENABLE_THREADS
747 gold_warning(_("ignoring --threads: "
748 "%s was compiled without thread support"),
750 this->set_threads(false);
752 if (this->thread_count() > 0 || this->thread_count_initial() > 0
753 || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
754 gold_warning(_("ignoring --thread-count: "
755 "%s was compiled without thread support"),
759 if (this->user_set_Y())
761 std::string s = this->Y();
762 if (s.compare(0, 2, "P,") == 0)
769 next_pos = s.find(':', pos);
770 size_t len = (next_pos == std::string::npos
774 this->add_to_library_path_with_sysroot(s.substr(pos, len).c_str());
777 while (next_pos != std::string::npos);
781 // Even if they don't specify it, we add -L /lib and -L /usr/lib.
782 // FIXME: We should only do this when configured in native mode.
783 this->add_to_library_path_with_sysroot("/lib");
784 this->add_to_library_path_with_sysroot("/usr/lib");
787 if (this->shared() && !this->user_set_allow_shlib_undefined())
788 this->set_allow_shlib_undefined(true);
790 // Normalize library_path() by adding the sysroot to all directories
791 // in the path, as appropriate.
794 // Now that we've normalized the options, check for contradictory ones.
795 if (this->shared() && this->relocatable())
796 gold_fatal(_("-shared and -r are incompatible"));
798 if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
799 && (this->shared() || this->relocatable()))
800 gold_fatal(_("binary output format not compatible with -shared or -r"));
802 if (this->user_set_hash_bucket_empty_fraction()
803 && (this->hash_bucket_empty_fraction() < 0.0
804 || this->hash_bucket_empty_fraction() >= 1.0))
805 gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
807 this->hash_bucket_empty_fraction());
809 // FIXME: we can/should be doing a lot more sanity checking here.
812 // Search_directory methods.
814 // This is called if we have a sysroot. Apply the sysroot if
815 // appropriate. Record whether the directory is in the sysroot.
818 Search_directory::add_sysroot(const char* sysroot,
819 const char* canonical_sysroot)
821 gold_assert(*sysroot != '\0');
822 if (this->put_in_sysroot_)
824 if (!IS_DIR_SEPARATOR(this->name_[0])
825 && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
826 this->name_ = '/' + this->name_;
827 this->name_ = sysroot + this->name_;
828 this->is_in_sysroot_ = true;
832 // Check whether this entry is in the sysroot. To do this
833 // correctly, we need to use canonical names. Otherwise we will
834 // get confused by the ../../.. paths that gcc tends to use.
835 char* canonical_name = lrealpath(this->name_.c_str());
836 int canonical_name_len = strlen(canonical_name);
837 int canonical_sysroot_len = strlen(canonical_sysroot);
838 if (canonical_name_len > canonical_sysroot_len
839 && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
841 canonical_name[canonical_sysroot_len] = '\0';
842 if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
843 this->is_in_sysroot_ = true;
845 free(canonical_name);
849 // Input_arguments methods.
851 // Add a file to the list.
854 Input_arguments::add_file(const Input_file_argument& file)
856 if (!this->in_group_)
857 this->input_argument_list_.push_back(Input_argument(file));
860 gold_assert(!this->input_argument_list_.empty());
861 gold_assert(this->input_argument_list_.back().is_group());
862 this->input_argument_list_.back().group()->add_file(file);
869 Input_arguments::start_group()
872 gold_fatal(_("May not nest groups"));
873 Input_file_group* group = new Input_file_group();
874 this->input_argument_list_.push_back(Input_argument(group));
875 this->in_group_ = true;
881 Input_arguments::end_group()
883 if (!this->in_group_)
884 gold_fatal(_("Group end without group start"));
885 this->in_group_ = false;
888 // Command_line options.
890 Command_line::Command_line()
894 // Process the command line options. For process_one_option, i is the
895 // index of argv to process next, and must be an option (that is,
896 // start with a dash). The return value is the index of the next
897 // option to process (i+1 or i+2, or argc to indicate processing is
898 // done). no_more_options is set to true if (and when) "--" is seen
902 Command_line::process_one_option(int argc, const char** argv, int i,
903 bool* no_more_options)
905 gold_assert(argv[i][0] == '-' && !(*no_more_options));
907 // If we are reading "--", then just set no_more_options and return.
908 if (argv[i][1] == '-' && argv[i][2] == '\0')
910 *no_more_options = true;
915 options::One_option* option = NULL;
916 const char* arg = NULL;
918 // First, try to process argv as a long option.
919 option = parse_long_option(argc, argv, false, &arg, &new_i);
922 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
926 // Now, try to process argv as a short option. Since several short
927 // options can be combined in one argv, we may have to parse a lot
928 // until we're done reading this argv.
929 int pos_in_argv_i = 1;
932 option = parse_short_option(argc, argv, pos_in_argv_i, &arg, &new_i);
935 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
941 // I guess it's neither a long option nor a short option.
942 usage(_("unknown option"), argv[i]);
948 Command_line::process(int argc, const char** argv)
950 bool no_more_options = false;
954 this->position_options_.copy_from_options(this->options());
955 if (no_more_options || argv[i][0] != '-')
957 Input_file_argument file(argv[i], false, "", false,
958 this->position_options_);
959 this->inputs_.add_file(file);
963 i = process_one_option(argc, argv, i, &no_more_options);
966 if (this->inputs_.in_group())
968 fprintf(stderr, _("%s: missing group end\n"), program_name);
972 // Normalize the options and ensure they don't contradict each other.
973 this->options_.finalize();
976 } // End namespace gold.