* config.sub, config.guess: Update from upstream sources.
[binutils.git] / gold / options.cc
blob916ccf4d188772a9a55b5f1682645c7575ab3cba
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.
23 #include "gold.h"
25 #include <cstdlib>
26 #include <vector>
27 #include <iostream>
28 #include <sys/stat.h>
29 #include "filenames.h"
30 #include "libiberty.h"
32 #include "debug.h"
33 #include "script.h"
34 #include "target-select.h"
35 #include "options.h"
37 namespace gold
40 General_options
41 Position_dependent_options::default_options_;
43 namespace 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];
56 void
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
63 // first called.
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;
77 void
78 One_option::print() const
80 bool comma = false;
81 printf(" ");
82 int len = 2;
83 if (this->shortname != '\0')
85 len += printf("-%c", this->shortname);
86 if (this->helparg)
88 // -z takes long-names only.
89 gold_assert(this->dashes != DASH_Z);
90 len += printf(" %s", gettext(this->helparg));
92 comma = true;
94 if (!this->longname.empty()
95 && !(this->longname[0] == this->shortname
96 && this->longname[1] == '\0'))
98 if (comma)
99 len += printf(", ");
100 switch (this->dashes)
102 case options::ONE_DASH: case options::EXACTLY_ONE_DASH:
103 len += printf("-");
104 break;
105 case options::TWO_DASHES: case options::EXACTLY_TWO_DASHES:
106 len += printf("--");
107 break;
108 case options::DASH_Z:
109 len += printf("-z ");
110 break;
111 default:
112 gold_unreachable();
114 len += printf("%s", this->longname.c_str());
115 if (this->helparg)
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));
124 if (len >= 30)
126 printf("\n");
127 len = 0;
129 for (; len < 30; ++len)
130 std::putchar(' ');
132 // TODO: if we're boolean, add " (default)" when appropriate.
133 printf("%s\n", gettext(this->helpstring));
136 void
137 help()
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)
143 (*it)->print();
146 // For bool, arg will be NULL (boolean options take no argument);
147 // we always just set to true.
148 void
149 parse_bool(const char*, const char*, bool* retval)
151 *retval = true;
154 void
155 parse_uint(const char* option_name, const char* arg, int* retval)
157 char* endptr;
158 *retval = strtol(arg, &endptr, 0);
159 if (*endptr != '\0' || retval < 0)
160 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
161 option_name, arg);
164 void
165 parse_uint64(const char* option_name, const char* arg, uint64_t *retval)
167 char* endptr;
168 *retval = strtoull(arg, &endptr, 0);
169 if (*endptr != '\0')
170 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
171 option_name, arg);
174 void
175 parse_double(const char* option_name, const char* arg, double* retval)
177 char* endptr;
178 *retval = strtod(arg, &endptr);
179 if (*endptr != '\0')
180 gold_fatal(_("%s: invalid option value "
181 "(expected a floating point number): %s"),
182 option_name, arg);
185 void
186 parse_string(const char* option_name, const char* arg, const char** retval)
188 if (*arg == '\0')
189 gold_fatal(_("%s: must take a non-empty argument"), option_name);
190 *retval = arg;
193 void
194 parse_dirlist(const char*, const char* arg, Dir_list* retval)
196 retval->push_back(Search_directory(arg, false));
199 void
200 parse_choices(const char* option_name, const char* arg, const char** retval,
201 const char* choices[], int num_choices)
203 for (int i = 0; i < num_choices; i++)
204 if (strcmp(choices[i], arg) == 0)
206 *retval = arg;
207 return;
210 // If we get here, the user did not enter a valid choice, so we die.
211 std::string choices_list;
212 for (int i = 0; i < num_choices; i++)
214 choices_list += choices[i];
215 if (i != num_choices - 1)
216 choices_list += ", ";
218 gold_fatal(_("%s: must take one of the following arguments: %s"),
219 option_name, choices_list.c_str());
222 } // End namespace options.
224 // Define the handler for "special" options (set via DEFINE_special).
226 void
227 General_options::parse_help(const char*, const char*, Command_line*)
229 options::help();
230 ::exit(EXIT_SUCCESS);
233 void
234 General_options::parse_version(const char* opt, const char*, Command_line*)
236 gold::print_version(opt[0] == '-' && opt[1] == 'v');
237 ::exit(EXIT_SUCCESS);
240 void
241 General_options::parse_Bstatic(const char*, const char*, Command_line*)
243 this->set_Bdynamic(false);
246 void
247 General_options::parse_defsym(const char*, const char* arg,
248 Command_line* cmdline)
250 cmdline->script_options().define_symbol(arg);
253 void
254 General_options::parse_library(const char*, const char* arg,
255 Command_line* cmdline)
257 Input_file_argument file(arg, true, "", false, *this);
258 cmdline->inputs().add_file(file);
261 void
262 General_options::parse_R(const char* option, const char* arg,
263 Command_line* cmdline)
265 struct stat s;
266 if (::stat(arg, &s) != 0 || S_ISDIR(s.st_mode))
267 this->add_to_rpath(arg);
268 else
269 this->parse_just_symbols(option, arg, cmdline);
272 void
273 General_options::parse_just_symbols(const char*, const char* arg,
274 Command_line* cmdline)
276 Input_file_argument file(arg, false, "", true, *this);
277 cmdline->inputs().add_file(file);
280 void
281 General_options::parse_static(const char*, const char*, Command_line*)
283 this->set_static(true);
286 void
287 General_options::parse_script(const char*, const char* arg,
288 Command_line* cmdline)
290 if (!read_commandline_script(arg, cmdline))
291 gold::gold_fatal(_("unable to parse script file %s"), arg);
294 void
295 General_options::parse_version_script(const char*, const char* arg,
296 Command_line* cmdline)
298 if (!read_version_script(arg, cmdline))
299 gold::gold_fatal(_("unable to parse version script file %s"), arg);
302 void
303 General_options::parse_start_group(const char*, const char*,
304 Command_line* cmdline)
306 cmdline->inputs().start_group();
309 void
310 General_options::parse_end_group(const char*, const char*,
311 Command_line* cmdline)
313 cmdline->inputs().end_group();
316 } // End namespace gold.
318 namespace
321 void
322 usage()
324 fprintf(stderr,
325 _("%s: use the --help option for usage information\n"),
326 gold::program_name);
327 ::exit(EXIT_FAILURE);
330 void
331 usage(const char* msg, const char *opt)
333 fprintf(stderr,
334 _("%s: %s: %s\n"),
335 gold::program_name, opt, msg);
336 usage();
339 // Recognize input and output target names. The GNU linker accepts
340 // these with --format and --oformat. This code is intended to be
341 // minimally compatible. In practice for an ELF target this would be
342 // the same target as the input files; that name always start with
343 // "elf". Non-ELF targets would be "srec", "symbolsrec", "tekhex",
344 // "binary", "ihex".
346 gold::General_options::Object_format
347 string_to_object_format(const char* arg)
349 if (strncmp(arg, "elf", 3) == 0)
350 return gold::General_options::OBJECT_FORMAT_ELF;
351 else if (strcmp(arg, "binary") == 0)
352 return gold::General_options::OBJECT_FORMAT_BINARY;
353 else
355 gold::gold_error(_("format '%s' not supported; treating as elf "
356 "(supported formats: elf, binary)"),
357 arg);
358 return gold::General_options::OBJECT_FORMAT_ELF;
362 // If the default sysroot is relocatable, try relocating it based on
363 // the prefix FROM.
365 char*
366 get_relative_sysroot(const char* from)
368 char* path = make_relative_prefix(gold::program_name, from,
369 TARGET_SYSTEM_ROOT);
370 if (path != NULL)
372 struct stat s;
373 if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
374 return path;
375 free(path);
378 return NULL;
381 // Return the default sysroot. This is set by the --with-sysroot
382 // option to configure. Note we do not free the return value of
383 // get_relative_sysroot, which is a small memory leak, but is
384 // necessary since we store this pointer directly in General_options.
386 const char*
387 get_default_sysroot()
389 const char* sysroot = TARGET_SYSTEM_ROOT;
390 if (*sysroot == '\0')
391 return NULL;
393 if (TARGET_SYSTEM_ROOT_RELOCATABLE)
395 char* path = get_relative_sysroot(BINDIR);
396 if (path == NULL)
397 path = get_relative_sysroot(TOOLBINDIR);
398 if (path != NULL)
399 return path;
402 return sysroot;
405 // Parse a long option. Such options have the form
406 // <-|--><option>[=arg]. If "=arg" is not present but the option
407 // takes an argument, the next word is taken to the be the argument.
408 // If equals_only is set, then only the <option>=<arg> form is
409 // accepted, not the <option><space><arg> form. Returns a One_option
410 // struct or NULL if argv[i] cannot be parsed as a long option. In
411 // the not-NULL case, *arg is set to the option's argument (NULL if
412 // the option takes no argument), and *i is advanced past this option.
413 // NOTE: it is safe for argv and arg to point to the same place.
414 gold::options::One_option*
415 parse_long_option(int argc, const char** argv, bool equals_only,
416 const char** arg, int* i)
418 const char* const this_argv = argv[*i];
420 const char* equals = strchr(this_argv, '=');
421 const char* option_start = this_argv + strspn(this_argv, "-");
422 std::string option(option_start,
423 equals ? equals - option_start : strlen(option_start));
425 gold::options::Option_map::iterator it
426 = gold::options::long_options->find(option);
427 if (it == gold::options::long_options->end())
428 return NULL;
430 gold::options::One_option* retval = it->second;
432 // If the dash-count doesn't match, we fail.
433 if (this_argv[0] != '-') // no dashes at all: had better be "-z <longopt>"
435 if (retval->dashes != gold::options::DASH_Z)
436 return NULL;
438 else if (this_argv[1] != '-') // one dash
440 if (retval->dashes != gold::options::ONE_DASH
441 && retval->dashes != gold::options::EXACTLY_ONE_DASH
442 && retval->dashes != gold::options::TWO_DASHES)
443 return NULL;
445 else // two dashes (or more!)
447 if (retval->dashes != gold::options::TWO_DASHES
448 && retval->dashes != gold::options::EXACTLY_TWO_DASHES
449 && retval->dashes != gold::options::ONE_DASH)
450 return NULL;
453 // Now that we know the option is good (or else bad in a way that
454 // will cause us to die), increment i to point past this argv.
455 ++(*i);
457 // Figure out the option's argument, if any.
458 if (!retval->takes_argument())
460 if (equals)
461 usage(_("unexpected argument"), this_argv);
462 else
463 *arg = NULL;
465 else
467 if (equals)
468 *arg = equals + 1;
469 else if (*i < argc && !equals_only)
470 *arg = argv[(*i)++];
471 else
472 usage(_("missing argument"), this_argv);
475 return retval;
478 // Parse a short option. Such options have the form -<option>[arg].
479 // If "arg" is not present but the option takes an argument, the next
480 // word is taken to the be the argument. If the option does not take
481 // an argument, it may be followed by another short option. Returns a
482 // One_option struct or NULL if argv[i] cannot be parsed as a short
483 // option. In the not-NULL case, *arg is set to the option's argument
484 // (NULL if the option takes no argument), and *i is advanced past
485 // this option. This function keeps *i the same if we parsed a short
486 // option that does not take an argument, that looks to be followed by
487 // another short option in the same word.
488 gold::options::One_option*
489 parse_short_option(int argc, const char** argv, int pos_in_argv_i,
490 const char** arg, int* i)
492 const char* const this_argv = argv[*i];
494 if (this_argv[0] != '-')
495 return NULL;
497 // We handle -z as a special case.
498 static gold::options::One_option dash_z("", gold::options::DASH_Z,
499 'z', "", "-z", "Z-OPTION", NULL);
500 gold::options::One_option* retval = NULL;
501 if (this_argv[pos_in_argv_i] == 'z')
502 retval = &dash_z;
503 else
505 const int char_as_int = static_cast<int>(this_argv[pos_in_argv_i]);
506 if (char_as_int > 0 && char_as_int < 128)
507 retval = gold::options::short_options[char_as_int];
510 if (retval == NULL)
511 return NULL;
513 // Figure out the option's argument, if any.
514 if (!retval->takes_argument())
516 *arg = NULL;
517 // We only advance past this argument if it's the only one in argv.
518 if (this_argv[pos_in_argv_i + 1] == '\0')
519 ++(*i);
521 else
523 // If we take an argument, we'll eat up this entire argv entry.
524 ++(*i);
525 if (this_argv[pos_in_argv_i + 1] != '\0')
526 *arg = this_argv + pos_in_argv_i + 1;
527 else if (*i < argc)
528 *arg = argv[(*i)++];
529 else
530 usage(_("missing argument"), this_argv);
533 // If we're a -z option, we need to parse our argument as a
534 // long-option, e.g. "-z stacksize=8192".
535 if (retval == &dash_z)
537 int dummy_i = 0;
538 const char* dash_z_arg = *arg;
539 retval = parse_long_option(1, arg, true, arg, &dummy_i);
540 if (retval == NULL)
541 usage(_("unknown -z option"), dash_z_arg);
544 return retval;
547 } // End anonymous namespace.
549 namespace gold
552 General_options::General_options()
553 : execstack_status_(General_options::EXECSTACK_FROM_INPUT), static_(false)
557 General_options::Object_format
558 General_options::format_enum() const
560 return string_to_object_format(this->format());
563 General_options::Object_format
564 General_options::oformat_enum() const
566 return string_to_object_format(this->oformat());
569 // Add the sysroot, if any, to the search paths.
571 void
572 General_options::add_sysroot()
574 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
576 this->set_sysroot(get_default_sysroot());
577 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
578 return;
581 char* canonical_sysroot = lrealpath(this->sysroot());
583 for (Dir_list::iterator p = this->library_path_.value.begin();
584 p != this->library_path_.value.end();
585 ++p)
586 p->add_sysroot(this->sysroot(), canonical_sysroot);
588 free(canonical_sysroot);
591 // Set up variables and other state that isn't set up automatically by
592 // the parse routine, and ensure options don't contradict each other
593 // and are otherwise kosher.
595 void
596 General_options::finalize()
598 // Normalize the strip modifiers. They have a total order:
599 // strip_all > strip_debug > strip_debug_gdb. If one is true, set
600 // all beneath it to true as well.
601 if (this->strip_all())
602 this->set_strip_debug(true);
603 if (this->strip_debug())
604 this->set_strip_debug_gdb(true);
606 // If the user specifies both -s and -r, convert the -s to -S.
607 // -r requires us to keep externally visible symbols!
608 if (this->strip_all() && this->relocatable())
610 this->set_strip_all(false);
611 gold_assert(this->strip_debug());
614 // For us, -dc and -dp are synonyms for --define-common.
615 if (this->dc())
616 this->set_define_common(true);
617 if (this->dp())
618 this->set_define_common(true);
620 // We also set --define-common if we're not relocatable, as long as
621 // the user didn't explicitly ask for something different.
622 if (!this->user_set_define_common())
623 this->set_define_common(!this->relocatable());
625 // execstack_status_ is a three-state variable; update it based on
626 // -z [no]execstack.
627 if (this->execstack())
628 this->set_execstack_status(EXECSTACK_YES);
629 else if (this->noexecstack())
630 this->set_execstack_status(EXECSTACK_NO);
632 // If --thread_count is specified, it applies to
633 // --thread-count-{initial,middle,final}, though it doesn't override
634 // them.
635 if (this->thread_count() > 0 && this->thread_count_initial() == 0)
636 this->set_thread_count_initial(this->thread_count());
637 if (this->thread_count() > 0 && this->thread_count_middle() == 0)
638 this->set_thread_count_middle(this->thread_count());
639 if (this->thread_count() > 0 && this->thread_count_final() == 0)
640 this->set_thread_count_final(this->thread_count());
642 // Let's warn if you set the thread-count but we're going to ignore it.
643 #ifndef ENABLE_THREADS
644 if (this->threads())
646 gold_warning(_("ignoring --threads: "
647 "%s was compiled without thread support"),
648 program_name);
649 this->set_threads(false);
651 if (this->thread_count() > 0 || this->thread_count_initial() > 0
652 || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
653 gold_warning(_("ignoring --thread-count: "
654 "%s was compiled without thread support"),
655 program_name);
656 #endif
658 // Even if they don't specify it, we add -L /lib and -L /usr/lib.
659 // FIXME: We should only do this when configured in native mode.
660 this->add_to_library_path_with_sysroot("/lib");
661 this->add_to_library_path_with_sysroot("/usr/lib");
663 // Normalize library_path() by adding the sysroot to all directories
664 // in the path, as appropriate.
665 this->add_sysroot();
667 // Now that we've normalized the options, check for contradictory ones.
668 if (this->shared() && this->relocatable())
669 gold_fatal(_("-shared and -r are incompatible"));
671 if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
672 && (this->shared() || this->relocatable()))
673 gold_fatal(_("binary output format not compatible with -shared or -r"));
675 if (this->user_set_hash_bucket_empty_fraction()
676 && (this->hash_bucket_empty_fraction() < 0.0
677 || this->hash_bucket_empty_fraction() >= 1.0))
678 gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
679 "[0.0, 1.0)"),
680 this->hash_bucket_empty_fraction());
682 // FIXME: we can/should be doing a lot more sanity checking here.
685 // Search_directory methods.
687 // This is called if we have a sysroot. Apply the sysroot if
688 // appropriate. Record whether the directory is in the sysroot.
690 void
691 Search_directory::add_sysroot(const char* sysroot,
692 const char* canonical_sysroot)
694 gold_assert(*sysroot != '\0');
695 if (this->put_in_sysroot_)
697 if (!IS_DIR_SEPARATOR(this->name_[0])
698 && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
699 this->name_ = '/' + this->name_;
700 this->name_ = sysroot + this->name_;
701 this->is_in_sysroot_ = true;
703 else
705 // Check whether this entry is in the sysroot. To do this
706 // correctly, we need to use canonical names. Otherwise we will
707 // get confused by the ../../.. paths that gcc tends to use.
708 char* canonical_name = lrealpath(this->name_.c_str());
709 int canonical_name_len = strlen(canonical_name);
710 int canonical_sysroot_len = strlen(canonical_sysroot);
711 if (canonical_name_len > canonical_sysroot_len
712 && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
714 canonical_name[canonical_sysroot_len] = '\0';
715 if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
716 this->is_in_sysroot_ = true;
718 free(canonical_name);
722 // Input_arguments methods.
724 // Add a file to the list.
726 void
727 Input_arguments::add_file(const Input_file_argument& file)
729 if (!this->in_group_)
730 this->input_argument_list_.push_back(Input_argument(file));
731 else
733 gold_assert(!this->input_argument_list_.empty());
734 gold_assert(this->input_argument_list_.back().is_group());
735 this->input_argument_list_.back().group()->add_file(file);
739 // Start a group.
741 void
742 Input_arguments::start_group()
744 if (this->in_group_)
745 gold_fatal(_("May not nest groups"));
746 Input_file_group* group = new Input_file_group();
747 this->input_argument_list_.push_back(Input_argument(group));
748 this->in_group_ = true;
751 // End a group.
753 void
754 Input_arguments::end_group()
756 if (!this->in_group_)
757 gold_fatal(_("Group end without group start"));
758 this->in_group_ = false;
761 // Command_line options.
763 Command_line::Command_line()
767 // Process the command line options. For process_one_option, i is the
768 // index of argv to process next, and must be an option (that is,
769 // start with a dash). The return value is the index of the next
770 // option to process (i+1 or i+2, or argc to indicate processing is
771 // done). no_more_options is set to true if (and when) "--" is seen
772 // as an option.
775 Command_line::process_one_option(int argc, const char** argv, int i,
776 bool* no_more_options)
778 gold_assert(argv[i][0] == '-' && !(*no_more_options));
780 // If we are reading "--", then just set no_more_options and return.
781 if (argv[i][1] == '-' && argv[i][2] == '\0')
783 *no_more_options = true;
784 return i + 1;
787 int new_i = i;
788 options::One_option* option = NULL;
789 const char* arg = NULL;
791 // First, try to process argv as a long option.
792 option = parse_long_option(argc, argv, false, &arg, &new_i);
793 if (option)
795 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
796 return new_i;
799 // Now, try to process argv as a short option. Since several short
800 // options can be combined in one argv, we may have to parse a lot
801 // until we're done reading this argv.
802 int pos_in_argv_i = 1;
803 while (new_i == i)
805 option = parse_short_option(argc, argv, pos_in_argv_i, &arg, &new_i);
806 if (!option)
807 break;
808 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
809 ++pos_in_argv_i;
811 if (option)
812 return new_i;
814 // I guess it's neither a long option nor a short option.
815 usage(_("unknown option"), argv[i]);
816 return argc;
820 void
821 Command_line::process(int argc, const char** argv)
823 bool no_more_options = false;
824 int i = 0;
825 while (i < argc)
827 this->position_options_.copy_from_options(this->options());
828 if (no_more_options || argv[i][0] != '-')
830 Input_file_argument file(argv[i], false, "", false,
831 this->position_options_);
832 this->inputs_.add_file(file);
833 ++i;
835 else
836 i = process_one_option(argc, argv, i, &no_more_options);
839 if (this->inputs_.in_group())
841 fprintf(stderr, _("%s: missing group end\n"), program_name);
842 usage();
845 // Normalize the options and ensure they don't contradict each other.
846 this->options_.finalize();
849 } // End namespace gold.