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_defsym(const char*, const char* arg,
286 Command_line* cmdline)
288 cmdline->script_options().define_symbol(arg);
292 General_options::parse_library(const char*, const char* arg,
293 Command_line* cmdline)
295 Input_file_argument file(arg, true, "", false, *this);
296 cmdline->inputs().add_file(file);
300 General_options::parse_R(const char* option, const char* arg,
301 Command_line* cmdline)
304 if (::stat(arg, &s) != 0 || S_ISDIR(s.st_mode))
305 this->add_to_rpath(arg);
307 this->parse_just_symbols(option, arg, cmdline);
311 General_options::parse_just_symbols(const char*, const char* arg,
312 Command_line* cmdline)
314 Input_file_argument file(arg, false, "", true, *this);
315 cmdline->inputs().add_file(file);
319 General_options::parse_static(const char*, const char*, Command_line*)
321 this->set_static(true);
325 General_options::parse_script(const char*, const char* arg,
326 Command_line* cmdline)
328 if (!read_commandline_script(arg, cmdline))
329 gold::gold_fatal(_("unable to parse script file %s"), arg);
333 General_options::parse_version_script(const char*, const char* arg,
334 Command_line* cmdline)
336 if (!read_version_script(arg, cmdline))
337 gold::gold_fatal(_("unable to parse version script file %s"), arg);
341 General_options::parse_start_group(const char*, const char*,
342 Command_line* cmdline)
344 cmdline->inputs().start_group();
348 General_options::parse_end_group(const char*, const char*,
349 Command_line* cmdline)
351 cmdline->inputs().end_group();
354 } // End namespace gold.
363 _("%s: use the --help option for usage information\n"),
365 ::exit(EXIT_FAILURE);
369 usage(const char* msg, const char *opt)
373 gold::program_name, opt, msg);
377 // Recognize input and output target names. The GNU linker accepts
378 // these with --format and --oformat. This code is intended to be
379 // minimally compatible. In practice for an ELF target this would be
380 // the same target as the input files; that name always start with
381 // "elf". Non-ELF targets would be "srec", "symbolsrec", "tekhex",
384 gold::General_options::Object_format
385 string_to_object_format(const char* arg)
387 if (strncmp(arg, "elf", 3) == 0)
388 return gold::General_options::OBJECT_FORMAT_ELF;
389 else if (strcmp(arg, "binary") == 0)
390 return gold::General_options::OBJECT_FORMAT_BINARY;
393 gold::gold_error(_("format '%s' not supported; treating as elf "
394 "(supported formats: elf, binary)"),
396 return gold::General_options::OBJECT_FORMAT_ELF;
400 // If the default sysroot is relocatable, try relocating it based on
404 get_relative_sysroot(const char* from)
406 char* path = make_relative_prefix(gold::program_name, from,
411 if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
419 // Return the default sysroot. This is set by the --with-sysroot
420 // option to configure. Note we do not free the return value of
421 // get_relative_sysroot, which is a small memory leak, but is
422 // necessary since we store this pointer directly in General_options.
425 get_default_sysroot()
427 const char* sysroot = TARGET_SYSTEM_ROOT;
428 if (*sysroot == '\0')
431 if (TARGET_SYSTEM_ROOT_RELOCATABLE)
433 char* path = get_relative_sysroot(BINDIR);
435 path = get_relative_sysroot(TOOLBINDIR);
443 // Parse a long option. Such options have the form
444 // <-|--><option>[=arg]. If "=arg" is not present but the option
445 // takes an argument, the next word is taken to the be the argument.
446 // If equals_only is set, then only the <option>=<arg> form is
447 // accepted, not the <option><space><arg> form. Returns a One_option
448 // struct or NULL if argv[i] cannot be parsed as a long option. In
449 // the not-NULL case, *arg is set to the option's argument (NULL if
450 // the option takes no argument), and *i is advanced past this option.
451 // NOTE: it is safe for argv and arg to point to the same place.
452 gold::options::One_option*
453 parse_long_option(int argc, const char** argv, bool equals_only,
454 const char** arg, int* i)
456 const char* const this_argv = argv[*i];
458 const char* equals = strchr(this_argv, '=');
459 const char* option_start = this_argv + strspn(this_argv, "-");
460 std::string option(option_start,
461 equals ? equals - option_start : strlen(option_start));
463 gold::options::Option_map::iterator it
464 = gold::options::long_options->find(option);
465 if (it == gold::options::long_options->end())
468 gold::options::One_option* retval = it->second;
470 // If the dash-count doesn't match, we fail.
471 if (this_argv[0] != '-') // no dashes at all: had better be "-z <longopt>"
473 if (retval->dashes != gold::options::DASH_Z)
476 else if (this_argv[1] != '-') // one dash
478 if (retval->dashes != gold::options::ONE_DASH
479 && retval->dashes != gold::options::EXACTLY_ONE_DASH
480 && retval->dashes != gold::options::TWO_DASHES)
483 else // two dashes (or more!)
485 if (retval->dashes != gold::options::TWO_DASHES
486 && retval->dashes != gold::options::EXACTLY_TWO_DASHES
487 && retval->dashes != gold::options::ONE_DASH)
491 // Now that we know the option is good (or else bad in a way that
492 // will cause us to die), increment i to point past this argv.
495 // Figure out the option's argument, if any.
496 if (!retval->takes_argument())
499 usage(_("unexpected argument"), this_argv);
507 else if (retval->takes_optional_argument())
508 *arg = retval->default_value;
509 else if (*i < argc && !equals_only)
512 usage(_("missing argument"), this_argv);
518 // Parse a short option. Such options have the form -<option>[arg].
519 // If "arg" is not present but the option takes an argument, the next
520 // word is taken to the be the argument. If the option does not take
521 // an argument, it may be followed by another short option. Returns a
522 // One_option struct or NULL if argv[i] cannot be parsed as a short
523 // option. In the not-NULL case, *arg is set to the option's argument
524 // (NULL if the option takes no argument), and *i is advanced past
525 // this option. This function keeps *i the same if we parsed a short
526 // option that does not take an argument, that looks to be followed by
527 // another short option in the same word.
528 gold::options::One_option*
529 parse_short_option(int argc, const char** argv, int pos_in_argv_i,
530 const char** arg, int* i)
532 const char* const this_argv = argv[*i];
534 if (this_argv[0] != '-')
537 // We handle -z as a special case.
538 static gold::options::One_option dash_z("", gold::options::DASH_Z,
539 'z', "", "-z", "Z-OPTION", false,
541 gold::options::One_option* retval = NULL;
542 if (this_argv[pos_in_argv_i] == 'z')
546 const int char_as_int = static_cast<int>(this_argv[pos_in_argv_i]);
547 if (char_as_int > 0 && char_as_int < 128)
548 retval = gold::options::short_options[char_as_int];
554 // Figure out the option's argument, if any.
555 if (!retval->takes_argument())
558 // We only advance past this argument if it's the only one in argv.
559 if (this_argv[pos_in_argv_i + 1] == '\0')
564 // If we take an argument, we'll eat up this entire argv entry.
566 if (this_argv[pos_in_argv_i + 1] != '\0')
567 *arg = this_argv + pos_in_argv_i + 1;
568 else if (retval->takes_optional_argument())
569 *arg = retval->default_value;
573 usage(_("missing argument"), this_argv);
576 // If we're a -z option, we need to parse our argument as a
577 // long-option, e.g. "-z stacksize=8192".
578 if (retval == &dash_z)
581 const char* dash_z_arg = *arg;
582 retval = parse_long_option(1, arg, true, arg, &dummy_i);
584 usage(_("unknown -z option"), dash_z_arg);
590 } // End anonymous namespace.
595 General_options::General_options()
596 : execstack_status_(General_options::EXECSTACK_FROM_INPUT), static_(false),
601 General_options::Object_format
602 General_options::format_enum() const
604 return string_to_object_format(this->format());
607 General_options::Object_format
608 General_options::oformat_enum() const
610 return string_to_object_format(this->oformat());
613 // Add the sysroot, if any, to the search paths.
616 General_options::add_sysroot()
618 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
620 this->set_sysroot(get_default_sysroot());
621 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
625 char* canonical_sysroot = lrealpath(this->sysroot());
627 for (Dir_list::iterator p = this->library_path_.value.begin();
628 p != this->library_path_.value.end();
630 p->add_sysroot(this->sysroot(), canonical_sysroot);
632 free(canonical_sysroot);
635 // Set up variables and other state that isn't set up automatically by
636 // the parse routine, and ensure options don't contradict each other
637 // and are otherwise kosher.
640 General_options::finalize()
642 // Normalize the strip modifiers. They have a total order:
643 // strip_all > strip_debug > strip_non_line > strip_debug_gdb.
644 // If one is true, set all beneath it to true as well.
645 if (this->strip_all())
646 this->set_strip_debug(true);
647 if (this->strip_debug())
648 this->set_strip_debug_non_line(true);
649 if (this->strip_debug_non_line())
650 this->set_strip_debug_gdb(true);
652 // If the user specifies both -s and -r, convert the -s to -S.
653 // -r requires us to keep externally visible symbols!
654 if (this->strip_all() && this->relocatable())
656 this->set_strip_all(false);
657 gold_assert(this->strip_debug());
660 // For us, -dc and -dp are synonyms for --define-common.
662 this->set_define_common(true);
664 this->set_define_common(true);
666 // We also set --define-common if we're not relocatable, as long as
667 // the user didn't explicitly ask for something different.
668 if (!this->user_set_define_common())
669 this->set_define_common(!this->relocatable());
671 // execstack_status_ is a three-state variable; update it based on
673 if (this->execstack())
674 this->set_execstack_status(EXECSTACK_YES);
675 else if (this->noexecstack())
676 this->set_execstack_status(EXECSTACK_NO);
678 // Handle the optional argument for --demangle.
679 if (this->user_set_demangle())
681 this->set_do_demangle(true);
682 const char* style = this->demangle();
685 enum demangling_styles style_code;
687 style_code = cplus_demangle_name_to_style(style);
688 if (style_code == unknown_demangling)
689 gold_fatal("unknown demangling style '%s'", style);
690 cplus_demangle_set_style(style_code);
693 else if (this->user_set_no_demangle())
694 this->set_do_demangle(false);
697 // Testing COLLECT_NO_DEMANGLE makes our default demangling
698 // behaviour identical to that of gcc's linker wrapper.
699 this->set_do_demangle(getenv("COLLECT_NO_DEMANGLE") == NULL);
702 // -M is equivalent to "-Map -".
703 if (this->print_map() && !this->user_set_Map())
706 this->set_user_set_Map();
709 // Using -n or -N implies -static.
710 if (this->nmagic() || this->omagic())
711 this->set_static(true);
713 // If --thread_count is specified, it applies to
714 // --thread-count-{initial,middle,final}, though it doesn't override
716 if (this->thread_count() > 0 && this->thread_count_initial() == 0)
717 this->set_thread_count_initial(this->thread_count());
718 if (this->thread_count() > 0 && this->thread_count_middle() == 0)
719 this->set_thread_count_middle(this->thread_count());
720 if (this->thread_count() > 0 && this->thread_count_final() == 0)
721 this->set_thread_count_final(this->thread_count());
723 // Let's warn if you set the thread-count but we're going to ignore it.
724 #ifndef ENABLE_THREADS
727 gold_warning(_("ignoring --threads: "
728 "%s was compiled without thread support"),
730 this->set_threads(false);
732 if (this->thread_count() > 0 || this->thread_count_initial() > 0
733 || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
734 gold_warning(_("ignoring --thread-count: "
735 "%s was compiled without thread support"),
739 if (this->user_set_Y())
741 std::string s = this->Y();
742 if (s.compare(0, 2, "P,") == 0)
749 next_pos = s.find(':', pos);
750 size_t len = (next_pos == std::string::npos
754 this->add_to_library_path_with_sysroot(s.substr(pos, len).c_str());
757 while (next_pos != std::string::npos);
761 // Even if they don't specify it, we add -L /lib and -L /usr/lib.
762 // FIXME: We should only do this when configured in native mode.
763 this->add_to_library_path_with_sysroot("/lib");
764 this->add_to_library_path_with_sysroot("/usr/lib");
767 if (this->shared() && !this->user_set_allow_shlib_undefined())
768 this->set_allow_shlib_undefined(true);
770 // Normalize library_path() by adding the sysroot to all directories
771 // in the path, as appropriate.
774 // Now that we've normalized the options, check for contradictory ones.
775 if (this->shared() && this->relocatable())
776 gold_fatal(_("-shared and -r are incompatible"));
778 if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
779 && (this->shared() || this->relocatable()))
780 gold_fatal(_("binary output format not compatible with -shared or -r"));
782 if (this->user_set_hash_bucket_empty_fraction()
783 && (this->hash_bucket_empty_fraction() < 0.0
784 || this->hash_bucket_empty_fraction() >= 1.0))
785 gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
787 this->hash_bucket_empty_fraction());
789 // FIXME: we can/should be doing a lot more sanity checking here.
792 // Search_directory methods.
794 // This is called if we have a sysroot. Apply the sysroot if
795 // appropriate. Record whether the directory is in the sysroot.
798 Search_directory::add_sysroot(const char* sysroot,
799 const char* canonical_sysroot)
801 gold_assert(*sysroot != '\0');
802 if (this->put_in_sysroot_)
804 if (!IS_DIR_SEPARATOR(this->name_[0])
805 && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
806 this->name_ = '/' + this->name_;
807 this->name_ = sysroot + this->name_;
808 this->is_in_sysroot_ = true;
812 // Check whether this entry is in the sysroot. To do this
813 // correctly, we need to use canonical names. Otherwise we will
814 // get confused by the ../../.. paths that gcc tends to use.
815 char* canonical_name = lrealpath(this->name_.c_str());
816 int canonical_name_len = strlen(canonical_name);
817 int canonical_sysroot_len = strlen(canonical_sysroot);
818 if (canonical_name_len > canonical_sysroot_len
819 && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
821 canonical_name[canonical_sysroot_len] = '\0';
822 if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
823 this->is_in_sysroot_ = true;
825 free(canonical_name);
829 // Input_arguments methods.
831 // Add a file to the list.
834 Input_arguments::add_file(const Input_file_argument& file)
836 if (!this->in_group_)
837 this->input_argument_list_.push_back(Input_argument(file));
840 gold_assert(!this->input_argument_list_.empty());
841 gold_assert(this->input_argument_list_.back().is_group());
842 this->input_argument_list_.back().group()->add_file(file);
849 Input_arguments::start_group()
852 gold_fatal(_("May not nest groups"));
853 Input_file_group* group = new Input_file_group();
854 this->input_argument_list_.push_back(Input_argument(group));
855 this->in_group_ = true;
861 Input_arguments::end_group()
863 if (!this->in_group_)
864 gold_fatal(_("Group end without group start"));
865 this->in_group_ = false;
868 // Command_line options.
870 Command_line::Command_line()
874 // Process the command line options. For process_one_option, i is the
875 // index of argv to process next, and must be an option (that is,
876 // start with a dash). The return value is the index of the next
877 // option to process (i+1 or i+2, or argc to indicate processing is
878 // done). no_more_options is set to true if (and when) "--" is seen
882 Command_line::process_one_option(int argc, const char** argv, int i,
883 bool* no_more_options)
885 gold_assert(argv[i][0] == '-' && !(*no_more_options));
887 // If we are reading "--", then just set no_more_options and return.
888 if (argv[i][1] == '-' && argv[i][2] == '\0')
890 *no_more_options = true;
895 options::One_option* option = NULL;
896 const char* arg = NULL;
898 // First, try to process argv as a long option.
899 option = parse_long_option(argc, argv, false, &arg, &new_i);
902 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
906 // Now, try to process argv as a short option. Since several short
907 // options can be combined in one argv, we may have to parse a lot
908 // until we're done reading this argv.
909 int pos_in_argv_i = 1;
912 option = parse_short_option(argc, argv, pos_in_argv_i, &arg, &new_i);
915 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
921 // I guess it's neither a long option nor a short option.
922 usage(_("unknown option"), argv[i]);
928 Command_line::process(int argc, const char** argv)
930 bool no_more_options = false;
934 this->position_options_.copy_from_options(this->options());
935 if (no_more_options || argv[i][0] != '-')
937 Input_file_argument file(argv[i], false, "", false,
938 this->position_options_);
939 this->inputs_.add_file(file);
943 i = process_one_option(argc, argv, i, &no_more_options);
946 if (this->inputs_.in_group())
948 fprintf(stderr, _("%s: missing group end\n"), program_name);
952 // Normalize the options and ensure they don't contradict each other.
953 this->options_.finalize();
956 } // End namespace gold.