PR 11225
[binutils.git] / gold / options.cc
blobf377387ed234ae6d22fa65e2e997649b507c1333
1 // options.c -- handle command line options for gold
3 // Copyright 2006, 2007, 2008, 2009 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 <cerrno>
26 #include <cstdlib>
27 #include <cstring>
28 #include <fstream>
29 #include <vector>
30 #include <iostream>
31 #include <sys/stat.h>
32 #include "filenames.h"
33 #include "libiberty.h"
34 #include "demangle.h"
35 #include "../bfd/bfdver.h"
37 #include "debug.h"
38 #include "script.h"
39 #include "target-select.h"
40 #include "options.h"
41 #include "plugin.h"
43 namespace gold
46 General_options
47 Position_dependent_options::default_options_;
49 namespace options
52 // This flag is TRUE if we should register the command-line options as they
53 // are constructed. It is set after contruction of the options within
54 // class Position_dependent_options.
55 static bool ready_to_register = false;
57 // This global variable is set up as General_options is constructed.
58 static std::vector<const One_option*> registered_options;
60 // These are set up at the same time -- the variables that accept one
61 // dash, two, or require -z. A single variable may be in more than
62 // one of thes data structures.
63 typedef Unordered_map<std::string, One_option*> Option_map;
64 static Option_map* long_options = NULL;
65 static One_option* short_options[128];
67 void
68 One_option::register_option()
70 if (!ready_to_register)
71 return;
73 registered_options.push_back(this);
75 // We can't make long_options a static Option_map because we can't
76 // guarantee that will be initialized before register_option() is
77 // first called.
78 if (long_options == NULL)
79 long_options = new Option_map;
81 // TWO_DASHES means that two dashes are preferred, but one is ok too.
82 if (!this->longname.empty())
83 (*long_options)[this->longname] = this;
85 const int shortname_as_int = static_cast<int>(this->shortname);
86 gold_assert(shortname_as_int >= 0 && shortname_as_int < 128);
87 if (this->shortname != '\0')
89 gold_assert(short_options[shortname_as_int] == NULL);
90 short_options[shortname_as_int] = this;
94 void
95 One_option::print() const
97 bool comma = false;
98 printf(" ");
99 int len = 2;
100 if (this->shortname != '\0')
102 len += printf("-%c", this->shortname);
103 if (this->helparg)
105 // -z takes long-names only.
106 gold_assert(this->dashes != DASH_Z);
107 len += printf(" %s", gettext(this->helparg));
109 comma = true;
111 if (!this->longname.empty()
112 && !(this->longname[0] == this->shortname
113 && this->longname[1] == '\0'))
115 if (comma)
116 len += printf(", ");
117 switch (this->dashes)
119 case options::ONE_DASH: case options::EXACTLY_ONE_DASH:
120 len += printf("-");
121 break;
122 case options::TWO_DASHES: case options::EXACTLY_TWO_DASHES:
123 len += printf("--");
124 break;
125 case options::DASH_Z:
126 len += printf("-z ");
127 break;
128 default:
129 gold_unreachable();
131 len += printf("%s", this->longname.c_str());
132 if (this->helparg)
134 // For most options, we print "--frob FOO". But for -z
135 // we print "-z frob=FOO".
136 len += printf("%c%s", this->dashes == options::DASH_Z ? '=' : ' ',
137 gettext(this->helparg));
141 if (len >= 30)
143 printf("\n");
144 len = 0;
146 for (; len < 30; ++len)
147 std::putchar(' ');
149 // TODO: if we're boolean, add " (default)" when appropriate.
150 printf("%s\n", gettext(this->helpstring));
153 void
154 help()
156 printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name);
158 std::vector<const One_option*>::const_iterator it;
159 for (it = registered_options.begin(); it != registered_options.end(); ++it)
160 (*it)->print();
162 // config.guess and libtool.m4 look in ld --help output for the
163 // string "supported targets".
164 printf(_("%s: supported targets:"), gold::program_name);
165 std::vector<const char*> supported_names;
166 gold::supported_target_names(&supported_names);
167 for (std::vector<const char*>::const_iterator p = supported_names.begin();
168 p != supported_names.end();
169 ++p)
170 printf(" %s", *p);
171 printf("\n");
173 // REPORT_BUGS_TO is defined in bfd/bfdver.h.
174 const char* report = REPORT_BUGS_TO;
175 if (*report != '\0')
176 printf(_("Report bugs to %s\n"), report);
179 // For bool, arg will be NULL (boolean options take no argument);
180 // we always just set to true.
181 void
182 parse_bool(const char*, const char*, bool* retval)
184 *retval = true;
187 void
188 parse_uint(const char* option_name, const char* arg, int* retval)
190 char* endptr;
191 *retval = strtol(arg, &endptr, 0);
192 if (*endptr != '\0' || retval < 0)
193 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
194 option_name, arg);
197 void
198 parse_int(const char* option_name, const char* arg, int* retval)
200 char* endptr;
201 *retval = strtol(arg, &endptr, 0);
202 if (*endptr != '\0')
203 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
204 option_name, arg);
207 void
208 parse_uint64(const char* option_name, const char* arg, uint64_t *retval)
210 char* endptr;
211 *retval = strtoull(arg, &endptr, 0);
212 if (*endptr != '\0')
213 gold_fatal(_("%s: invalid option value (expected an integer): %s"),
214 option_name, arg);
217 void
218 parse_double(const char* option_name, const char* arg, double* retval)
220 char* endptr;
221 *retval = strtod(arg, &endptr);
222 if (*endptr != '\0')
223 gold_fatal(_("%s: invalid option value "
224 "(expected a floating point number): %s"),
225 option_name, arg);
228 void
229 parse_string(const char* option_name, const char* arg, const char** retval)
231 if (*arg == '\0')
232 gold_fatal(_("%s: must take a non-empty argument"), option_name);
233 *retval = arg;
236 void
237 parse_optional_string(const char*, const char* arg, const char** retval)
239 *retval = arg;
242 void
243 parse_dirlist(const char*, const char* arg, Dir_list* retval)
245 retval->push_back(Search_directory(arg, false));
248 void
249 parse_set(const char*, const char* arg, String_set* retval)
251 retval->insert(std::string(arg));
254 void
255 parse_choices(const char* option_name, const char* arg, const char** retval,
256 const char* choices[], int num_choices)
258 for (int i = 0; i < num_choices; i++)
259 if (strcmp(choices[i], arg) == 0)
261 *retval = arg;
262 return;
265 // If we get here, the user did not enter a valid choice, so we die.
266 std::string choices_list;
267 for (int i = 0; i < num_choices; i++)
269 choices_list += choices[i];
270 if (i != num_choices - 1)
271 choices_list += ", ";
273 gold_fatal(_("%s: must take one of the following arguments: %s"),
274 option_name, choices_list.c_str());
277 } // End namespace options.
279 // Define the handler for "special" options (set via DEFINE_special).
281 void
282 General_options::parse_help(const char*, const char*, Command_line*)
284 options::help();
285 ::exit(EXIT_SUCCESS);
288 void
289 General_options::parse_version(const char* opt, const char*, Command_line*)
291 bool print_short = (opt[0] == '-' && opt[1] == 'v');
292 gold::print_version(print_short);
293 this->printed_version_ = true;
294 if (!print_short)
295 ::exit(EXIT_SUCCESS);
298 void
299 General_options::parse_V(const char*, const char*, Command_line*)
301 gold::print_version(true);
302 this->printed_version_ = true;
303 printf(_(" Supported targets:\n"));
304 std::vector<const char*> supported_names;
305 gold::supported_target_names(&supported_names);
306 for (std::vector<const char*>::const_iterator p = supported_names.begin();
307 p != supported_names.end();
308 ++p)
309 printf(" %s\n", *p);
312 void
313 General_options::parse_defsym(const char*, const char* arg,
314 Command_line* cmdline)
316 cmdline->script_options().define_symbol(arg);
319 void
320 General_options::parse_incremental_changed(const char*, const char*,
321 Command_line*)
323 this->implicit_incremental_ = true;
324 this->incremental_disposition_ = INCREMENTAL_CHANGED;
327 void
328 General_options::parse_incremental_unchanged(const char*, const char*,
329 Command_line*)
331 this->implicit_incremental_ = true;
332 this->incremental_disposition_ = INCREMENTAL_UNCHANGED;
335 void
336 General_options::parse_incremental_unknown(const char*, const char*,
337 Command_line*)
339 this->implicit_incremental_ = true;
340 this->incremental_disposition_ = INCREMENTAL_CHECK;
343 void
344 General_options::parse_library(const char*, const char* arg,
345 Command_line* cmdline)
347 Input_file_argument::Input_file_type type;
348 const char *name;
349 if (arg[0] == ':')
351 type = Input_file_argument::INPUT_FILE_TYPE_SEARCHED_FILE;
352 name = arg + 1;
354 else
356 type = Input_file_argument::INPUT_FILE_TYPE_LIBRARY;
357 name = arg;
359 Input_file_argument file(name, type, "", false, *this);
360 cmdline->inputs().add_file(file);
363 #ifdef ENABLE_PLUGINS
364 void
365 General_options::parse_plugin(const char*, const char* arg,
366 Command_line*)
368 this->add_plugin(arg);
371 // Parse --plugin-opt.
373 void
374 General_options::parse_plugin_opt(const char*, const char* arg,
375 Command_line*)
377 this->add_plugin_option(arg);
379 #endif // ENABLE_PLUGINS
381 void
382 General_options::parse_R(const char* option, const char* arg,
383 Command_line* cmdline)
385 struct stat s;
386 if (::stat(arg, &s) != 0 || S_ISDIR(s.st_mode))
387 this->add_to_rpath(arg);
388 else
389 this->parse_just_symbols(option, arg, cmdline);
392 void
393 General_options::parse_just_symbols(const char*, const char* arg,
394 Command_line* cmdline)
396 Input_file_argument file(arg, Input_file_argument::INPUT_FILE_TYPE_FILE,
397 "", true, *this);
398 cmdline->inputs().add_file(file);
401 // Handle --section-start.
403 void
404 General_options::parse_section_start(const char*, const char* arg,
405 Command_line*)
407 const char* eq = strchr(arg, '=');
408 if (eq == NULL)
410 gold_error(_("invalid argument to --section-start; "
411 "must be SECTION=ADDRESS"));
412 return;
415 std::string section_name(arg, eq - arg);
417 ++eq;
418 const char* val_start = eq;
419 if (eq[0] == '0' && (eq[1] == 'x' || eq[1] == 'X'))
420 eq += 2;
421 if (*eq == '\0')
423 gold_error(_("--section-start address missing"));
424 return;
426 uint64_t addr = 0;
427 hex_init();
428 for (; *eq != '\0'; ++eq)
430 if (!hex_p(*eq))
432 gold_error(_("--section-start argument %s is not a valid hex number"),
433 val_start);
434 return;
436 addr <<= 4;
437 addr += hex_value(*eq);
440 this->section_starts_[section_name] = addr;
443 // Look up a --section-start value.
445 bool
446 General_options::section_start(const char* secname, uint64_t* paddr) const
448 if (this->section_starts_.empty())
449 return false;
450 std::map<std::string, uint64_t>::const_iterator p =
451 this->section_starts_.find(secname);
452 if (p == this->section_starts_.end())
453 return false;
454 *paddr = p->second;
455 return true;
458 void
459 General_options::parse_static(const char*, const char*, Command_line*)
461 this->set_static(true);
464 void
465 General_options::parse_script(const char*, const char* arg,
466 Command_line* cmdline)
468 if (!read_commandline_script(arg, cmdline))
469 gold::gold_fatal(_("unable to parse script file %s"), arg);
472 void
473 General_options::parse_version_script(const char*, const char* arg,
474 Command_line* cmdline)
476 if (!read_version_script(arg, cmdline))
477 gold::gold_fatal(_("unable to parse version script file %s"), arg);
480 void
481 General_options::parse_dynamic_list(const char*, const char* arg,
482 Command_line* cmdline)
484 if (!read_dynamic_list(arg, cmdline, &this->dynamic_list_))
485 gold::gold_fatal(_("unable to parse dynamic-list script file %s"), arg);
488 void
489 General_options::parse_start_group(const char*, const char*,
490 Command_line* cmdline)
492 cmdline->inputs().start_group();
495 void
496 General_options::parse_end_group(const char*, const char*,
497 Command_line* cmdline)
499 cmdline->inputs().end_group();
502 // The function add_excluded_libs() in ld/ldlang.c of GNU ld breaks up a list
503 // of names seperated by commas or colons and puts them in a linked list.
504 // We implement the same parsing of names here but store names in an unordered
505 // map to speed up searching of names.
507 void
508 General_options::parse_exclude_libs(const char*, const char* arg,
509 Command_line*)
511 const char *p = arg;
513 while (*p != '\0')
515 size_t length = strcspn(p, ",:");
516 this->excluded_libs_.insert(std::string(p, length));
517 p += (p[length] ? length + 1 : length);
521 // The checking logic is based on the function check_excluded_libs() in
522 // ld/ldlang.c of GNU ld but our implementation is different because we use
523 // an unordered map instead of a linked list, which is what GNU ld uses. GNU
524 // ld searches sequentially in the excluded libs list. For a given archive,
525 // a match is found if the archive's name matches exactly one of the list
526 // entry or if the archive's name is of the form FOO.a and FOO matches exactly
527 // one of the list entry. An entry "ALL" in the list is considered as a
528 // wild-card and matches any given name.
530 bool
531 General_options::check_excluded_libs (const std::string &name) const
533 Unordered_set<std::string>::const_iterator p;
535 // Exit early for the most common case.
536 if (excluded_libs_.empty())
537 return false;
539 // If we see "ALL", all archives are excluded from automatic export.
540 p = excluded_libs_.find(std::string("ALL"));
541 if (p != excluded_libs_.end())
542 return true;
544 // First strip off any directories in name.
545 const char *basename = lbasename(name.c_str());
547 // Try finding an exact match.
548 p = excluded_libs_.find(std::string(basename));
549 if (p != excluded_libs_.end())
550 return true;
552 // Try matching NAME without ".a" at the end.
553 size_t length = strlen(basename);
554 if ((length >= 2)
555 && (basename[length - 2] == '.')
556 && (basename[length - 1] == 'a'))
558 p = excluded_libs_.find(std::string(basename, length - 2));
559 if (p != excluded_libs_.end())
560 return true;
563 return false;
566 // Recognize input and output target names. The GNU linker accepts
567 // these with --format and --oformat. This code is intended to be
568 // minimally compatible. In practice for an ELF target this would be
569 // the same target as the input files; that name always start with
570 // "elf". Non-ELF targets would be "srec", "symbolsrec", "tekhex",
571 // "binary", "ihex".
573 General_options::Object_format
574 General_options::string_to_object_format(const char* arg)
576 if (strncmp(arg, "elf", 3) == 0)
577 return gold::General_options::OBJECT_FORMAT_ELF;
578 else if (strcmp(arg, "binary") == 0)
579 return gold::General_options::OBJECT_FORMAT_BINARY;
580 else
582 gold::gold_error(_("format '%s' not supported; treating as elf "
583 "(supported formats: elf, binary)"),
584 arg);
585 return gold::General_options::OBJECT_FORMAT_ELF;
589 void
590 General_options::parse_fix_v4bx(const char*, const char*,
591 Command_line*)
593 this->fix_v4bx_ = FIX_V4BX_REPLACE;
596 void
597 General_options::parse_fix_v4bx_interworking(const char*, const char*,
598 Command_line*)
600 this->fix_v4bx_ = FIX_V4BX_INTERWORKING;
603 } // End namespace gold.
605 namespace
608 void
609 usage()
611 fprintf(stderr,
612 _("%s: use the --help option for usage information\n"),
613 gold::program_name);
614 ::exit(EXIT_FAILURE);
617 void
618 usage(const char* msg, const char *opt)
620 fprintf(stderr,
621 _("%s: %s: %s\n"),
622 gold::program_name, opt, msg);
623 usage();
626 // If the default sysroot is relocatable, try relocating it based on
627 // the prefix FROM.
629 static char*
630 get_relative_sysroot(const char* from)
632 char* path = make_relative_prefix(gold::program_name, from,
633 TARGET_SYSTEM_ROOT);
634 if (path != NULL)
636 struct stat s;
637 if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
638 return path;
639 free(path);
642 return NULL;
645 // Return the default sysroot. This is set by the --with-sysroot
646 // option to configure. Note we do not free the return value of
647 // get_relative_sysroot, which is a small memory leak, but is
648 // necessary since we store this pointer directly in General_options.
650 static const char*
651 get_default_sysroot()
653 const char* sysroot = TARGET_SYSTEM_ROOT;
654 if (*sysroot == '\0')
655 return NULL;
657 if (TARGET_SYSTEM_ROOT_RELOCATABLE)
659 char* path = get_relative_sysroot(BINDIR);
660 if (path == NULL)
661 path = get_relative_sysroot(TOOLBINDIR);
662 if (path != NULL)
663 return path;
666 return sysroot;
669 // Parse a long option. Such options have the form
670 // <-|--><option>[=arg]. If "=arg" is not present but the option
671 // takes an argument, the next word is taken to the be the argument.
672 // If equals_only is set, then only the <option>=<arg> form is
673 // accepted, not the <option><space><arg> form. Returns a One_option
674 // struct or NULL if argv[i] cannot be parsed as a long option. In
675 // the not-NULL case, *arg is set to the option's argument (NULL if
676 // the option takes no argument), and *i is advanced past this option.
677 // NOTE: it is safe for argv and arg to point to the same place.
678 gold::options::One_option*
679 parse_long_option(int argc, const char** argv, bool equals_only,
680 const char** arg, int* i)
682 const char* const this_argv = argv[*i];
684 const char* equals = strchr(this_argv, '=');
685 const char* option_start = this_argv + strspn(this_argv, "-");
686 std::string option(option_start,
687 equals ? equals - option_start : strlen(option_start));
689 gold::options::Option_map::iterator it
690 = gold::options::long_options->find(option);
691 if (it == gold::options::long_options->end())
692 return NULL;
694 gold::options::One_option* retval = it->second;
696 // If the dash-count doesn't match, we fail.
697 if (this_argv[0] != '-') // no dashes at all: had better be "-z <longopt>"
699 if (retval->dashes != gold::options::DASH_Z)
700 return NULL;
702 else if (this_argv[1] != '-') // one dash
704 if (retval->dashes != gold::options::ONE_DASH
705 && retval->dashes != gold::options::EXACTLY_ONE_DASH
706 && retval->dashes != gold::options::TWO_DASHES)
707 return NULL;
709 else // two dashes (or more!)
711 if (retval->dashes != gold::options::TWO_DASHES
712 && retval->dashes != gold::options::EXACTLY_TWO_DASHES
713 && retval->dashes != gold::options::ONE_DASH)
714 return NULL;
717 // Now that we know the option is good (or else bad in a way that
718 // will cause us to die), increment i to point past this argv.
719 ++(*i);
721 // Figure out the option's argument, if any.
722 if (!retval->takes_argument())
724 if (equals)
725 usage(_("unexpected argument"), this_argv);
726 else
727 *arg = NULL;
729 else
731 if (equals)
732 *arg = equals + 1;
733 else if (retval->takes_optional_argument())
734 *arg = retval->default_value;
735 else if (*i < argc && !equals_only)
736 *arg = argv[(*i)++];
737 else
738 usage(_("missing argument"), this_argv);
741 return retval;
744 // Parse a short option. Such options have the form -<option>[arg].
745 // If "arg" is not present but the option takes an argument, the next
746 // word is taken to the be the argument. If the option does not take
747 // an argument, it may be followed by another short option. Returns a
748 // One_option struct or NULL if argv[i] cannot be parsed as a short
749 // option. In the not-NULL case, *arg is set to the option's argument
750 // (NULL if the option takes no argument), and *i is advanced past
751 // this option. This function keeps *i the same if we parsed a short
752 // option that does not take an argument, that looks to be followed by
753 // another short option in the same word.
754 gold::options::One_option*
755 parse_short_option(int argc, const char** argv, int pos_in_argv_i,
756 const char** arg, int* i)
758 const char* const this_argv = argv[*i];
760 if (this_argv[0] != '-')
761 return NULL;
763 // We handle -z as a special case.
764 static gold::options::One_option dash_z("", gold::options::DASH_Z,
765 'z', "", NULL, "Z-OPTION", false,
766 NULL);
767 gold::options::One_option* retval = NULL;
768 if (this_argv[pos_in_argv_i] == 'z')
769 retval = &dash_z;
770 else
772 const int char_as_int = static_cast<int>(this_argv[pos_in_argv_i]);
773 if (char_as_int > 0 && char_as_int < 128)
774 retval = gold::options::short_options[char_as_int];
777 if (retval == NULL)
778 return NULL;
780 // Figure out the option's argument, if any.
781 if (!retval->takes_argument())
783 *arg = NULL;
784 // We only advance past this argument if it's the only one in argv.
785 if (this_argv[pos_in_argv_i + 1] == '\0')
786 ++(*i);
788 else
790 // If we take an argument, we'll eat up this entire argv entry.
791 ++(*i);
792 if (this_argv[pos_in_argv_i + 1] != '\0')
793 *arg = this_argv + pos_in_argv_i + 1;
794 else if (retval->takes_optional_argument())
795 *arg = retval->default_value;
796 else if (*i < argc)
797 *arg = argv[(*i)++];
798 else
799 usage(_("missing argument"), this_argv);
802 // If we're a -z option, we need to parse our argument as a
803 // long-option, e.g. "-z stacksize=8192".
804 if (retval == &dash_z)
806 int dummy_i = 0;
807 const char* dash_z_arg = *arg;
808 retval = parse_long_option(1, arg, true, arg, &dummy_i);
809 if (retval == NULL)
810 usage(_("unknown -z option"), dash_z_arg);
813 return retval;
816 } // End anonymous namespace.
818 namespace gold
821 General_options::General_options()
822 : printed_version_(false),
823 execstack_status_(EXECSTACK_FROM_INPUT),
824 icf_status_(ICF_NONE),
825 static_(false),
826 do_demangle_(false),
827 plugins_(NULL),
828 dynamic_list_(),
829 incremental_disposition_(INCREMENTAL_CHECK),
830 implicit_incremental_(false),
831 excluded_libs_(),
832 symbols_to_retain_(),
833 section_starts_()
835 // Turn off option registration once construction is complete.
836 gold::options::ready_to_register = false;
839 General_options::Object_format
840 General_options::format_enum() const
842 return General_options::string_to_object_format(this->format());
845 General_options::Object_format
846 General_options::oformat_enum() const
848 return General_options::string_to_object_format(this->oformat());
851 // Add the sysroot, if any, to the search paths.
853 void
854 General_options::add_sysroot()
856 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
858 this->set_sysroot(get_default_sysroot());
859 if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
860 return;
863 char* canonical_sysroot = lrealpath(this->sysroot());
865 for (Dir_list::iterator p = this->library_path_.value.begin();
866 p != this->library_path_.value.end();
867 ++p)
868 p->add_sysroot(this->sysroot(), canonical_sysroot);
870 free(canonical_sysroot);
873 // Return whether FILENAME is in a system directory.
875 bool
876 General_options::is_in_system_directory(const std::string& filename) const
878 for (Dir_list::const_iterator p = this->library_path_.value.begin();
879 p != this->library_path_.value.end();
880 ++p)
882 // We use a straight string comparison rather than calling
883 // FILENAME_CMP because we are only interested in the cases
884 // where we found the file in a system directory, which means
885 // that we used the directory name as a prefix for a -L search.
886 if (p->is_system_directory()
887 && filename.compare(0, p->name().size(), p->name()) == 0)
888 return true;
890 return false;
893 // Add a plugin to the list of plugins.
895 void
896 General_options::add_plugin(const char* filename)
898 if (this->plugins_ == NULL)
899 this->plugins_ = new Plugin_manager(*this);
900 this->plugins_->add_plugin(filename);
903 // Add a plugin option to a plugin.
905 void
906 General_options::add_plugin_option(const char* arg)
908 if (this->plugins_ == NULL)
909 gold_fatal("--plugin-opt requires --plugin.");
910 this->plugins_->add_plugin_option(arg);
913 // Set up variables and other state that isn't set up automatically by
914 // the parse routine, and ensure options don't contradict each other
915 // and are otherwise kosher.
917 void
918 General_options::finalize()
920 // Normalize the strip modifiers. They have a total order:
921 // strip_all > strip_debug > strip_non_line > strip_debug_gdb.
922 // If one is true, set all beneath it to true as well.
923 if (this->strip_all())
924 this->set_strip_debug(true);
925 if (this->strip_debug())
926 this->set_strip_debug_non_line(true);
927 if (this->strip_debug_non_line())
928 this->set_strip_debug_gdb(true);
930 if (this->Bshareable())
931 this->set_shared(true);
933 // If the user specifies both -s and -r, convert the -s to -S.
934 // -r requires us to keep externally visible symbols!
935 if (this->strip_all() && this->relocatable())
937 this->set_strip_all(false);
938 gold_assert(this->strip_debug());
941 // For us, -dc and -dp are synonyms for --define-common.
942 if (this->dc())
943 this->set_define_common(true);
944 if (this->dp())
945 this->set_define_common(true);
947 // We also set --define-common if we're not relocatable, as long as
948 // the user didn't explicitly ask for something different.
949 if (!this->user_set_define_common())
950 this->set_define_common(!this->relocatable());
952 // execstack_status_ is a three-state variable; update it based on
953 // -z [no]execstack.
954 if (this->execstack())
955 this->set_execstack_status(EXECSTACK_YES);
956 else if (this->noexecstack())
957 this->set_execstack_status(EXECSTACK_NO);
959 // icf_status_ is a three-state variable; update it based on the
960 // value of this->icf().
961 if (strcmp(this->icf(), "none") == 0)
962 this->set_icf_status(ICF_NONE);
963 else if (strcmp(this->icf(), "safe") == 0)
964 this->set_icf_status(ICF_SAFE);
965 else
966 this->set_icf_status(ICF_ALL);
968 // Handle the optional argument for --demangle.
969 if (this->user_set_demangle())
971 this->set_do_demangle(true);
972 const char* style = this->demangle();
973 if (*style != '\0')
975 enum demangling_styles style_code;
977 style_code = cplus_demangle_name_to_style(style);
978 if (style_code == unknown_demangling)
979 gold_fatal("unknown demangling style '%s'", style);
980 cplus_demangle_set_style(style_code);
983 else if (this->user_set_no_demangle())
984 this->set_do_demangle(false);
985 else
987 // Testing COLLECT_NO_DEMANGLE makes our default demangling
988 // behaviour identical to that of gcc's linker wrapper.
989 this->set_do_demangle(getenv("COLLECT_NO_DEMANGLE") == NULL);
992 // -M is equivalent to "-Map -".
993 if (this->print_map() && !this->user_set_Map())
995 this->set_Map("-");
996 this->set_user_set_Map();
999 // Using -n or -N implies -static.
1000 if (this->nmagic() || this->omagic())
1001 this->set_static(true);
1003 // If --thread_count is specified, it applies to
1004 // --thread-count-{initial,middle,final}, though it doesn't override
1005 // them.
1006 if (this->thread_count() > 0 && this->thread_count_initial() == 0)
1007 this->set_thread_count_initial(this->thread_count());
1008 if (this->thread_count() > 0 && this->thread_count_middle() == 0)
1009 this->set_thread_count_middle(this->thread_count());
1010 if (this->thread_count() > 0 && this->thread_count_final() == 0)
1011 this->set_thread_count_final(this->thread_count());
1013 // Let's warn if you set the thread-count but we're going to ignore it.
1014 #ifndef ENABLE_THREADS
1015 if (this->threads())
1017 gold_warning(_("ignoring --threads: "
1018 "%s was compiled without thread support"),
1019 program_name);
1020 this->set_threads(false);
1022 if (this->thread_count() > 0 || this->thread_count_initial() > 0
1023 || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
1024 gold_warning(_("ignoring --thread-count: "
1025 "%s was compiled without thread support"),
1026 program_name);
1027 #endif
1029 if (this->user_set_Y())
1031 std::string s = this->Y();
1032 if (s.compare(0, 2, "P,") == 0)
1033 s.erase(0, 2);
1035 size_t pos = 0;
1036 size_t next_pos;
1039 next_pos = s.find(':', pos);
1040 size_t len = (next_pos == std::string::npos
1041 ? next_pos
1042 : next_pos - pos);
1043 if (len != 0)
1044 this->add_to_library_path_with_sysroot(s.substr(pos, len).c_str());
1045 pos = next_pos + 1;
1047 while (next_pos != std::string::npos);
1049 else
1051 // Even if they don't specify it, we add -L /lib and -L /usr/lib.
1052 // FIXME: We should only do this when configured in native mode.
1053 this->add_to_library_path_with_sysroot("/lib");
1054 this->add_to_library_path_with_sysroot("/usr/lib");
1057 // Parse the contents of -retain-symbols-file into a set.
1058 if (this->retain_symbols_file())
1060 std::ifstream in;
1061 in.open(this->retain_symbols_file());
1062 if (!in)
1063 gold_fatal(_("unable to open -retain-symbols-file file %s: %s"),
1064 this->retain_symbols_file(), strerror(errno));
1065 std::string line;
1066 std::getline(in, line); // this chops off the trailing \n, if any
1067 while (in)
1069 if (!line.empty() && line[line.length() - 1] == '\r') // Windows
1070 line.resize(line.length() - 1);
1071 this->symbols_to_retain_.insert(line);
1072 std::getline(in, line);
1076 if (this->shared() && !this->user_set_allow_shlib_undefined())
1077 this->set_allow_shlib_undefined(true);
1079 // Normalize library_path() by adding the sysroot to all directories
1080 // in the path, as appropriate.
1081 this->add_sysroot();
1083 // Now that we've normalized the options, check for contradictory ones.
1084 if (this->shared() && this->is_static())
1085 gold_fatal(_("-shared and -static are incompatible"));
1086 if (this->shared() && this->pie())
1087 gold_fatal(_("-shared and -pie are incompatible"));
1089 if (this->shared() && this->relocatable())
1090 gold_fatal(_("-shared and -r are incompatible"));
1091 if (this->pie() && this->relocatable())
1092 gold_fatal(_("-pie and -r are incompatible"));
1094 // TODO: implement support for -retain-symbols-file with -r, if needed.
1095 if (this->relocatable() && this->retain_symbols_file())
1096 gold_fatal(_("-retain-symbols-file does not yet work with -r"));
1098 if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
1099 && (this->shared()
1100 || this->pie()
1101 || this->relocatable()))
1102 gold_fatal(_("binary output format not compatible "
1103 "with -shared or -pie or -r"));
1105 if (this->user_set_hash_bucket_empty_fraction()
1106 && (this->hash_bucket_empty_fraction() < 0.0
1107 || this->hash_bucket_empty_fraction() >= 1.0))
1108 gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
1109 "[0.0, 1.0)"),
1110 this->hash_bucket_empty_fraction());
1112 if (this->implicit_incremental_ && !this->incremental())
1113 gold_fatal(_("Options --incremental-changed, --incremental-unchanged, "
1114 "--incremental-unknown require the use of --incremental"));
1116 // FIXME: we can/should be doing a lot more sanity checking here.
1119 // Search_directory methods.
1121 // This is called if we have a sysroot. Apply the sysroot if
1122 // appropriate. Record whether the directory is in the sysroot.
1124 void
1125 Search_directory::add_sysroot(const char* sysroot,
1126 const char* canonical_sysroot)
1128 gold_assert(*sysroot != '\0');
1129 if (this->put_in_sysroot_)
1131 if (!IS_DIR_SEPARATOR(this->name_[0])
1132 && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
1133 this->name_ = '/' + this->name_;
1134 this->name_ = sysroot + this->name_;
1135 this->is_in_sysroot_ = true;
1137 else
1139 // Check whether this entry is in the sysroot. To do this
1140 // correctly, we need to use canonical names. Otherwise we will
1141 // get confused by the ../../.. paths that gcc tends to use.
1142 char* canonical_name = lrealpath(this->name_.c_str());
1143 int canonical_name_len = strlen(canonical_name);
1144 int canonical_sysroot_len = strlen(canonical_sysroot);
1145 if (canonical_name_len > canonical_sysroot_len
1146 && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
1148 canonical_name[canonical_sysroot_len] = '\0';
1149 if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
1150 this->is_in_sysroot_ = true;
1152 free(canonical_name);
1156 // Input_arguments methods.
1158 // Add a file to the list.
1160 void
1161 Input_arguments::add_file(const Input_file_argument& file)
1163 if (!this->in_group_)
1164 this->input_argument_list_.push_back(Input_argument(file));
1165 else
1167 gold_assert(!this->input_argument_list_.empty());
1168 gold_assert(this->input_argument_list_.back().is_group());
1169 this->input_argument_list_.back().group()->add_file(file);
1173 // Start a group.
1175 void
1176 Input_arguments::start_group()
1178 if (this->in_group_)
1179 gold_fatal(_("May not nest groups"));
1180 Input_file_group* group = new Input_file_group();
1181 this->input_argument_list_.push_back(Input_argument(group));
1182 this->in_group_ = true;
1185 // End a group.
1187 void
1188 Input_arguments::end_group()
1190 if (!this->in_group_)
1191 gold_fatal(_("Group end without group start"));
1192 this->in_group_ = false;
1195 // Command_line options.
1197 Command_line::Command_line()
1201 // Pre_options is the hook that sets the ready_to_register flag.
1203 Command_line::Pre_options::Pre_options()
1205 gold::options::ready_to_register = true;
1208 // Process the command line options. For process_one_option, i is the
1209 // index of argv to process next, and must be an option (that is,
1210 // start with a dash). The return value is the index of the next
1211 // option to process (i+1 or i+2, or argc to indicate processing is
1212 // done). no_more_options is set to true if (and when) "--" is seen
1213 // as an option.
1216 Command_line::process_one_option(int argc, const char** argv, int i,
1217 bool* no_more_options)
1219 gold_assert(argv[i][0] == '-' && !(*no_more_options));
1221 // If we are reading "--", then just set no_more_options and return.
1222 if (argv[i][1] == '-' && argv[i][2] == '\0')
1224 *no_more_options = true;
1225 return i + 1;
1228 int new_i = i;
1229 options::One_option* option = NULL;
1230 const char* arg = NULL;
1232 // First, try to process argv as a long option.
1233 option = parse_long_option(argc, argv, false, &arg, &new_i);
1234 if (option)
1236 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
1237 return new_i;
1240 // Now, try to process argv as a short option. Since several short
1241 // options can be combined in one argv, we may have to parse a lot
1242 // until we're done reading this argv.
1243 int pos_in_argv_i = 1;
1244 while (new_i == i)
1246 option = parse_short_option(argc, argv, pos_in_argv_i, &arg, &new_i);
1247 if (!option)
1248 break;
1249 option->reader->parse_to_value(argv[i], arg, this, &this->options_);
1250 ++pos_in_argv_i;
1252 if (option)
1253 return new_i;
1255 // I guess it's neither a long option nor a short option.
1256 usage(_("unknown option"), argv[i]);
1257 return argc;
1261 void
1262 Command_line::process(int argc, const char** argv)
1264 bool no_more_options = false;
1265 int i = 0;
1266 while (i < argc)
1268 this->position_options_.copy_from_options(this->options());
1269 if (no_more_options || argv[i][0] != '-')
1271 Input_file_argument file(argv[i],
1272 Input_file_argument::INPUT_FILE_TYPE_FILE,
1273 "", false, this->position_options_);
1274 this->inputs_.add_file(file);
1275 ++i;
1277 else
1278 i = process_one_option(argc, argv, i, &no_more_options);
1281 if (this->inputs_.in_group())
1283 fprintf(stderr, _("%s: missing group end\n"), program_name);
1284 usage();
1287 // Normalize the options and ensure they don't contradict each other.
1288 this->options_.finalize();
1291 // Finalize the version script options and return them.
1293 const Version_script_info&
1294 Command_line::version_script()
1296 this->options_.finalize_dynamic_list();
1297 Version_script_info* vsi = this->script_options_.version_script_info();
1298 vsi->finalize();
1299 return *vsi;
1302 } // End namespace gold.