1 // options.c -- handle command line options for gold
3 // Copyright 2006, 2007, 2008 Free Software Foundation, Inc.
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.
29 #include "filenames.h"
30 #include "libiberty.h"
34 #include "target-select.h"
41 Position_dependent_options::default_options_;
46 // This global variable is set up as General_options is constructed.
47 static std::vector<const One_option*> registered_options;
49 // These are set up at the same time -- the variables that accept one
50 // dash, two, or require -z. A single variable may be in more than
51 // one of thes data structures.
52 typedef Unordered_map<std::string, One_option*> Option_map;
53 static Option_map* long_options = NULL;
54 static One_option* short_options[128];
57 One_option::register_option()
59 registered_options.push_back(this);
61 // We can't make long_options a static Option_map because we can't
62 // guarantee that will be initialized before register_option() is
64 if (long_options == NULL)
65 long_options = new Option_map;
67 // TWO_DASHES means that two dashes are preferred, but one is ok too.
68 if (!this->longname.empty())
69 (*long_options)[this->longname] = this;
71 const int shortname_as_int = static_cast<int>(this->shortname);
72 gold_assert(shortname_as_int >= 0 && shortname_as_int < 128);
73 if (this->shortname != '\0')
74 short_options[shortname_as_int] = this;
78 One_option::print() const
83 if (this->shortname != '\0')
85 len += printf("-%c", this->shortname);
88 // -z takes long-names only.
89 gold_assert(this->dashes != DASH_Z);
90 len += printf(" %s", gettext(this->helparg));
94 if (!this->longname.empty()
95 && !(this->longname[0] == this->shortname
96 && this->longname[1] == '\0'))
100 switch (this->dashes)
102 case options::ONE_DASH: case options::EXACTLY_ONE_DASH:
105 case options::TWO_DASHES: case options::EXACTLY_TWO_DASHES:
108 case options::DASH_Z:
109 len += printf("-z ");
114 len += printf("%s", this->longname.c_str());
117 // For most options, we print "--frob FOO". But for -z
118 // we print "-z frob=FOO".
119 len += printf("%c%s", this->dashes == options::DASH_Z ? '=' : ' ',
120 gettext(this->helparg));
129 for (; len < 30; ++len)
132 // TODO: if we're boolean, add " (default)" when appropriate.
133 printf("%s\n", gettext(this->helpstring));
139 printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name);
141 std::vector<const One_option*>::const_iterator it;
142 for (it = registered_options.begin(); it != registered_options.end(); ++it)
146 // For bool, arg will be NULL (boolean options take no argument);
147 // we always just set to true.
149 parse_bool(const char*, const char*, bool* retval)
155 parse_uint(const char* option_name, const char* arg, int* retval)
158 *retval = strtol(arg, &endptr, 0);
159 if (*endptr != '\0' || retval < 0)
160 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
165 parse_uint64(const char* option_name, const char* arg, uint64_t *retval)
168 *retval = strtoull(arg, &endptr, 0);
170 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
175 parse_string(const char* option_name, const char* arg, const char** retval)
178 gold_fatal(_("%s: must take a non-empty argument"), option_name);
183 parse_dirlist(const char*, const char* arg, Dir_list* retval)
185 retval->push_back(Search_directory(arg, false));
189 parse_choices(const char* option_name, const char* arg, const char** retval,
190 const char* choices[], int num_choices)
192 for (int i = 0; i < num_choices; i++)
193 if (strcmp(choices[i], arg) == 0)
199 // If we get here, the user did not enter a valid choice, so we die.
200 std::string choices_list;
201 for (int i = 0; i < num_choices; i++)
203 choices_list += choices[i];
204 if (i != num_choices - 1)
205 choices_list += ", ";
207 gold_fatal(_("%s: must take one of the following arguments: %s"),
208 option_name, choices_list.c_str());
211 } // End namespace options.
213 // Define the handler for "special" options (set via DEFINE_special).
216 General_options::parse_help(const char*, const char*, Command_line*)
219 ::exit(EXIT_SUCCESS);
223 General_options::parse_version(const char* opt, const char*, Command_line*)
225 gold::print_version(opt[0] == '-' && opt[1] == 'v');
226 ::exit(EXIT_SUCCESS);
230 General_options::parse_Bstatic(const char*, const char*, Command_line*)
232 this->set_Bdynamic(false);
236 General_options::parse_defsym(const char*, const char* arg,
237 Command_line* cmdline)
239 cmdline->script_options().define_symbol(arg);
243 General_options::parse_library(const char*, const char* arg,
244 Command_line* cmdline)
246 Input_file_argument file(arg, true, "", false, *this);
247 cmdline->inputs().add_file(file);
251 General_options::parse_R(const char* option, const char* arg,
252 Command_line* cmdline)
255 if (::stat(arg, &s) != 0 || S_ISDIR(s.st_mode))
256 this->add_to_rpath(arg);
258 this->parse_just_symbols(option, arg, cmdline);
262 General_options::parse_just_symbols(const char*, const char* arg,
263 Command_line* cmdline)
265 Input_file_argument file(arg, false, "", true, *this);
266 cmdline->inputs().add_file(file);
270 General_options::parse_static(const char*, const char*, Command_line*)
272 this->set_static(true);
276 General_options::parse_script(const char*, const char* arg,
277 Command_line* cmdline)
279 if (!read_commandline_script(arg, cmdline))
280 gold::gold_fatal(_("unable to parse script file %s"), arg);
284 General_options::parse_version_script(const char*, const char* arg,
285 Command_line* cmdline)
287 if (!read_version_script(arg, cmdline))
288 gold::gold_fatal(_("unable to parse version script file %s"), arg);
292 General_options::parse_start_group(const char*, const char*,
293 Command_line* cmdline)
295 cmdline->inputs().start_group();
299 General_options::parse_end_group(const char*, const char*,
300 Command_line* cmdline)
302 cmdline->inputs().end_group();
305 } // End namespace gold.
314 _("%s: use the --help option for usage information\n"),
316 ::exit(EXIT_FAILURE);
320 usage(const char* msg, const char *opt)
324 gold::program_name, opt, msg);
328 // Recognize input and output target names. The GNU linker accepts
329 // these with --format and --oformat. This code is intended to be
330 // minimally compatible. In practice for an ELF target this would be
331 // the same target as the input files; that name always start with
332 // "elf". Non-ELF targets would be "srec", "symbolsrec", "tekhex",
335 gold::General_options::Object_format
336 string_to_object_format(const char* arg)
338 if (strncmp(arg, "elf", 3) == 0)
339 return gold::General_options::OBJECT_FORMAT_ELF;
340 else if (strcmp(arg, "binary") == 0)
341 return gold::General_options::OBJECT_FORMAT_BINARY;
344 gold::gold_error(_("format '%s' not supported; treating as elf "
345 "(supported formats: elf, binary)"),
347 return gold::General_options::OBJECT_FORMAT_ELF;
351 // If the default sysroot is relocatable, try relocating it based on
355 get_relative_sysroot(const char* from)
357 char* path = make_relative_prefix(gold::program_name, from,
362 if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
370 // Return the default sysroot. This is set by the --with-sysroot
371 // option to configure. Note we do not free the return value of
372 // get_relative_sysroot, which is a small memory leak, but is
373 // necessary since we store this pointer directly in General_options.
376 get_default_sysroot()
378 const char* sysroot = TARGET_SYSTEM_ROOT;
379 if (*sysroot == '\0')
382 if (TARGET_SYSTEM_ROOT_RELOCATABLE)
384 char* path = get_relative_sysroot(BINDIR);
386 path = get_relative_sysroot(TOOLBINDIR);
394 // Parse a long option. Such options have the form
395 // <-|--><option>[=arg]. If "=arg" is not present but the option
396 // takes an argument, the next word is taken to the be the argument.
397 // If equals_only is set, then only the <option>=<arg> form is
398 // accepted, not the <option><space><arg> form. Returns a One_option
399 // struct or NULL if argv[i] cannot be parsed as a long option. In
400 // the not-NULL case, *arg is set to the option's argument (NULL if
401 // the option takes no argument), and *i is advanced past this option.
402 // NOTE: it is safe for argv and arg to point to the same place.
403 gold::options::One_option*
404 parse_long_option(int argc, const char** argv, bool equals_only,
405 const char** arg, int* i)
407 const char* const this_argv = argv[*i];
409 const char* equals = strchr(this_argv, '=');
410 const char* option_start = this_argv + strspn(this_argv, "-");
411 std::string option(option_start,
412 equals ? equals - option_start : strlen(option_start));
414 gold::options::Option_map::iterator it
415 = gold::options::long_options->find(option);
416 if (it == gold::options::long_options->end())
419 gold::options::One_option* retval = it->second;
421 // If the dash-count doesn't match, we fail.
422 if (this_argv[0] != '-') // no dashes at all: had better be "-z <longopt>"
424 if (retval->dashes != gold::options::DASH_Z)
427 else if (this_argv[1] != '-') // one dash
429 if (retval->dashes != gold::options::ONE_DASH
430 && retval->dashes != gold::options::EXACTLY_ONE_DASH
431 && retval->dashes != gold::options::TWO_DASHES)
434 else // two dashes (or more!)
436 if (retval->dashes != gold::options::TWO_DASHES
437 && retval->dashes != gold::options::EXACTLY_TWO_DASHES
438 && retval->dashes != gold::options::ONE_DASH)
442 // Now that we know the option is good (or else bad in a way that
443 // will cause us to die), increment i to point past this argv.
446 // Figure out the option's argument, if any.
447 if (!retval->takes_argument())
450 usage(_("unexpected argument"), this_argv);
458 else if (*i < argc && !equals_only)
461 usage(_("missing argument"), this_argv);
467 // Parse a short option. Such options have the form -<option>[arg].
468 // If "arg" is not present but the option takes an argument, the next
469 // word is taken to the be the argument. If the option does not take
470 // an argument, it may be followed by another short option. Returns a
471 // One_option struct or NULL if argv[i] cannot be parsed as a short
472 // option. In the not-NULL case, *arg is set to the option's argument
473 // (NULL if the option takes no argument), and *i is advanced past
474 // this option. This function keeps *i the same if we parsed a short
475 // option that does not take an argument, that looks to be followed by
476 // another short option in the same word.
477 gold::options::One_option*
478 parse_short_option(int argc, const char** argv, int pos_in_argv_i,
479 const char** arg, int* i)
481 const char* const this_argv = argv[*i];
483 if (this_argv[0] != '-')
486 // We handle -z as a special case.
487 static gold::options::One_option dash_z("", gold::options::DASH_Z,
488 'z', "", "-z", "Z-OPTION", NULL);
489 gold::options::One_option* retval = NULL;
490 if (this_argv[pos_in_argv_i] == 'z')
494 const int char_as_int = static_cast<int>(this_argv[pos_in_argv_i]);
495 if (char_as_int > 0 && char_as_int < 128)
496 retval = gold::options::short_options[char_as_int];
502 // Figure out the option's argument, if any.
503 if (!retval->takes_argument())
506 // We only advance past this argument if it's the only one in argv.
507 if (this_argv[pos_in_argv_i + 1] == '\0')
512 // If we take an argument, we'll eat up this entire argv entry.
514 if (this_argv[pos_in_argv_i + 1] != '\0')
515 *arg = this_argv + pos_in_argv_i + 1;
519 usage(_("missing argument"), this_argv);
522 // If we're a -z option, we need to parse our argument as a
523 // long-option, e.g. "-z stacksize=8192".
524 if (retval == &dash_z)
527 const char* dash_z_arg = *arg;
528 retval = parse_long_option(1, arg, true, arg, &dummy_i);
530 usage(_("unknown -z option"), dash_z_arg);
536 } // End anonymous namespace.
541 General_options::General_options()
542 : execstack_status_(General_options::EXECSTACK_FROM_INPUT), static_(false)
546 General_options::Object_format
547 General_options::format_enum() const
549 return string_to_object_format(this->format());
552 General_options::Object_format
553 General_options::oformat_enum() const
555 return string_to_object_format(this->oformat());
558 // Add the sysroot, if any, to the search paths.
561 General_options::add_sysroot()
563 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
565 this->set_sysroot(get_default_sysroot());
566 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
570 char* canonical_sysroot = lrealpath(this->sysroot());
572 for (Dir_list::iterator p = this->library_path_.value.begin();
573 p != this->library_path_.value.end();
575 p->add_sysroot(this->sysroot(), canonical_sysroot);
577 free(canonical_sysroot);
580 // Set up variables and other state that isn't set up automatically by
581 // the parse routine, and ensure options don't contradict each other
582 // and are otherwise kosher.
585 General_options::finalize()
587 // Normalize the strip modifiers. They have a total order:
588 // strip_all > strip_debug > strip_debug_gdb. If one is true, set
589 // all beneath it to true as well.
590 if (this->strip_all())
591 this->set_strip_debug(true);
592 if (this->strip_debug())
593 this->set_strip_debug_gdb(true);
595 // If the user specifies both -s and -r, convert the -s to -S.
596 // -r requires us to keep externally visible symbols!
597 if (this->strip_all() && this->relocatable())
599 this->set_strip_all(false);
600 gold_assert(this->strip_debug());
603 // For us, -dc and -dp are synonyms for --define-common.
605 this->set_define_common(true);
607 this->set_define_common(true);
609 // We also set --define-common if we're not relocatable, as long as
610 // the user didn't explicitly ask for something different.
611 if (!this->user_set_define_common())
612 this->set_define_common(!this->relocatable());
614 // execstack_status_ is a three-state variable; update it based on
616 if (this->execstack())
617 this->set_execstack_status(EXECSTACK_YES);
618 else if (this->noexecstack())
619 this->set_execstack_status(EXECSTACK_NO);
621 // If --thread_count is specified, it applies to
622 // --thread-count-{initial,middle,final}, though it doesn't override
624 if (this->thread_count() > 0 && this->thread_count_initial() == 0)
625 this->set_thread_count_initial(this->thread_count());
626 if (this->thread_count() > 0 && this->thread_count_middle() == 0)
627 this->set_thread_count_middle(this->thread_count());
628 if (this->thread_count() > 0 && this->thread_count_final() == 0)
629 this->set_thread_count_final(this->thread_count());
631 // Let's warn if you set the thread-count but we're going to ignore it.
632 #ifndef ENABLE_THREADS
635 gold_warning(_("ignoring --threads: "
636 "%s was compiled without thread support"),
638 this->set_threads(false);
640 if (this->thread_count() > 0 || this->thread_count_initial() > 0
641 || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
642 gold_warning(_("ignoring --thread-count: "
643 "%s was compiled without thread support"),
647 // Even if they don't specify it, we add -L /lib and -L /usr/lib.
648 // FIXME: We should only do this when configured in native mode.
649 this->add_to_library_path_with_sysroot("/lib");
650 this->add_to_library_path_with_sysroot("/usr/lib");
652 // Normalize library_path() by adding the sysroot to all directories
653 // in the path, as appropriate.
656 // Now that we've normalized the options, check for contradictory ones.
657 if (this->shared() && this->relocatable())
658 gold_fatal(_("-shared and -r are incompatible"));
660 if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
661 && (this->shared() || this->relocatable()))
662 gold_fatal(_("binary output format not compatible with -shared or -r"));
664 // FIXME: we can/should be doing a lot more sanity checking here.
667 // Search_directory methods.
669 // This is called if we have a sysroot. Apply the sysroot if
670 // appropriate. Record whether the directory is in the sysroot.
673 Search_directory::add_sysroot(const char* sysroot,
674 const char* canonical_sysroot)
676 gold_assert(*sysroot != '\0');
677 if (this->put_in_sysroot_)
679 if (!IS_DIR_SEPARATOR(this->name_[0])
680 && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
681 this->name_ = '/' + this->name_;
682 this->name_ = sysroot + this->name_;
683 this->is_in_sysroot_ = true;
687 // Check whether this entry is in the sysroot. To do this
688 // correctly, we need to use canonical names. Otherwise we will
689 // get confused by the ../../.. paths that gcc tends to use.
690 char* canonical_name = lrealpath(this->name_.c_str());
691 int canonical_name_len = strlen(canonical_name);
692 int canonical_sysroot_len = strlen(canonical_sysroot);
693 if (canonical_name_len > canonical_sysroot_len
694 && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
696 canonical_name[canonical_sysroot_len] = '\0';
697 if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
698 this->is_in_sysroot_ = true;
700 free(canonical_name);
704 // Input_arguments methods.
706 // Add a file to the list.
709 Input_arguments::add_file(const Input_file_argument& file)
711 if (!this->in_group_)
712 this->input_argument_list_.push_back(Input_argument(file));
715 gold_assert(!this->input_argument_list_.empty());
716 gold_assert(this->input_argument_list_.back().is_group());
717 this->input_argument_list_.back().group()->add_file(file);
724 Input_arguments::start_group()
727 gold_fatal(_("May not nest groups"));
728 Input_file_group* group = new Input_file_group();
729 this->input_argument_list_.push_back(Input_argument(group));
730 this->in_group_ = true;
736 Input_arguments::end_group()
738 if (!this->in_group_)
739 gold_fatal(_("Group end without group start"));
740 this->in_group_ = false;
743 // Command_line options.
745 Command_line::Command_line()
749 // Process the command line options. For process_one_option, i is the
750 // index of argv to process next, and must be an option (that is,
751 // start with a dash). The return value is the index of the next
752 // option to process (i+1 or i+2, or argc to indicate processing is
753 // done). no_more_options is set to true if (and when) "--" is seen
757 Command_line::process_one_option(int argc, const char** argv, int i,
758 bool* no_more_options)
760 gold_assert(argv[i][0] == '-' && !(*no_more_options));
762 // If we are reading "--", then just set no_more_options and return.
763 if (argv[i][1] == '-' && argv[i][2] == '\0')
765 *no_more_options = true;
770 options::One_option* option = NULL;
771 const char* arg = NULL;
773 // First, try to process argv as a long option.
774 option = parse_long_option(argc, argv, false, &arg, &new_i);
777 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
781 // Now, try to process argv as a short option. Since several short
782 // options can be combined in one argv, we may have to parse a lot
783 // until we're done reading this argv.
784 int pos_in_argv_i = 1;
787 option = parse_short_option(argc, argv, pos_in_argv_i, &arg, &new_i);
790 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
796 // I guess it's neither a long option nor a short option.
797 usage(_("unknown option"), argv[i]);
803 Command_line::process(int argc, const char** argv)
805 bool no_more_options = false;
809 this->position_options_.copy_from_options(this->options());
810 if (no_more_options || argv[i][0] != '-')
812 Input_file_argument file(argv[i], false, "", false,
813 this->position_options_);
814 this->inputs_.add_file(file);
818 i = process_one_option(argc, argv, i, &no_more_options);
821 if (this->inputs_.in_group())
823 fprintf(stderr, _("%s: missing group end\n"), program_name);
827 // Normalize the options and ensure they don't contradict each other.
828 this->options_.finalize();
831 } // End namespace gold.