6b49459e44329d4727517ab99b99b1419ed6d7af
[external/binutils.git] / gold / options.cc
1 // options.c -- handle command line options for gold
2
3 // Copyright 2006, 2007, 2008, 2009, 2010, 2011, 2013
4 // Free Software Foundation, Inc.
5 // Written by Ian Lance Taylor <iant@google.com>.
6
7 // This file is part of gold.
8
9 // This program is free software; you can redistribute it and/or modify
10 // it under the terms of the GNU General Public License as published by
11 // the Free Software Foundation; either version 3 of the License, or
12 // (at your option) any later version.
13
14 // This program is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 // GNU General Public License for more details.
18
19 // You should have received a copy of the GNU General Public License
20 // along with this program; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
22 // MA 02110-1301, USA.
23
24 #include "gold.h"
25
26 #include <cerrno>
27 #include <cstdlib>
28 #include <cstring>
29 #include <fstream>
30 #include <vector>
31 #include <iostream>
32 #include <sys/stat.h>
33 #include "filenames.h"
34 #include "libiberty.h"
35 #include "demangle.h"
36 #include "../bfd/bfdver.h"
37
38 #include "debug.h"
39 #include "script.h"
40 #include "target-select.h"
41 #include "options.h"
42 #include "plugin.h"
43
44 namespace gold
45 {
46
47 General_options
48 Position_dependent_options::default_options_;
49
50 namespace options
51 {
52
53 // This flag is TRUE if we should register the command-line options as they
54 // are constructed.  It is set after construction of the options within
55 // class Position_dependent_options.
56 static bool ready_to_register = false;
57
58 // This global variable is set up as General_options is constructed.
59 static std::vector<const One_option*> registered_options;
60
61 // These are set up at the same time -- the variables that accept one
62 // dash, two, or require -z.  A single variable may be in more than
63 // one of these data structures.
64 typedef Unordered_map<std::string, One_option*> Option_map;
65 static Option_map* long_options = NULL;
66 static One_option* short_options[128];
67
68 void
69 One_option::register_option()
70 {
71   if (!ready_to_register)
72     return;
73
74   registered_options.push_back(this);
75
76   // We can't make long_options a static Option_map because we can't
77   // guarantee that will be initialized before register_option() is
78   // first called.
79   if (long_options == NULL)
80     long_options = new Option_map;
81
82   // TWO_DASHES means that two dashes are preferred, but one is ok too.
83   if (!this->longname.empty())
84     (*long_options)[this->longname] = this;
85
86   const int shortname_as_int = static_cast<int>(this->shortname);
87   gold_assert(shortname_as_int >= 0 && shortname_as_int < 128);
88   if (this->shortname != '\0')
89     {
90       gold_assert(short_options[shortname_as_int] == NULL);
91       short_options[shortname_as_int] = this;
92     }
93 }
94
95 void
96 One_option::print() const
97 {
98   bool comma = false;
99   printf("  ");
100   int len = 2;
101   if (this->shortname != '\0')
102     {
103       len += printf("-%c", this->shortname);
104       if (this->helparg)
105         {
106           // -z takes long-names only.
107           gold_assert(this->dashes != DASH_Z);
108           len += printf(" %s", gettext(this->helparg));
109         }
110       comma = true;
111     }
112   if (!this->longname.empty()
113       && !(this->longname[0] == this->shortname
114            && this->longname[1] == '\0'))
115     {
116       if (comma)
117         len += printf(", ");
118       switch (this->dashes)
119         {
120         case options::ONE_DASH: case options::EXACTLY_ONE_DASH:
121           len += printf("-");
122           break;
123         case options::TWO_DASHES: case options::EXACTLY_TWO_DASHES:
124           len += printf("--");
125           break;
126         case options::DASH_Z:
127           len += printf("-z ");
128           break;
129         default:
130           gold_unreachable();
131         }
132       len += printf("%s", this->longname.c_str());
133       if (this->helparg)
134         {
135           // For most options, we print "--frob FOO".  But for -z
136           // we print "-z frob=FOO".
137           len += printf("%c%s", this->dashes == options::DASH_Z ? '=' : ' ',
138                         gettext(this->helparg));
139         }
140     }
141
142   if (len >= 30)
143     {
144       printf("\n");
145       len = 0;
146     }
147   for (; len < 30; ++len)
148     std::putchar(' ');
149
150   // TODO: if we're boolean, add " (default)" when appropriate.
151   printf("%s\n", gettext(this->helpstring));
152 }
153
154 void
155 help()
156 {
157   printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name);
158
159   std::vector<const One_option*>::const_iterator it;
160   for (it = registered_options.begin(); it != registered_options.end(); ++it)
161     (*it)->print();
162
163   // config.guess and libtool.m4 look in ld --help output for the
164   // string "supported targets".
165   printf(_("%s: supported targets:"), gold::program_name);
166   std::vector<const char*> supported_names;
167   gold::supported_target_names(&supported_names);
168   for (std::vector<const char*>::const_iterator p = supported_names.begin();
169        p != supported_names.end();
170        ++p)
171     printf(" %s", *p);
172   printf("\n");
173
174   printf(_("%s: supported emulations:"), gold::program_name);
175   supported_names.clear();
176   gold::supported_emulation_names(&supported_names);
177   for (std::vector<const char*>::const_iterator p = supported_names.begin();
178        p != supported_names.end();
179        ++p)
180     printf(" %s", *p);
181   printf("\n");
182
183   // REPORT_BUGS_TO is defined in bfd/bfdver.h.
184   const char* report = REPORT_BUGS_TO;
185   if (*report != '\0')
186     printf(_("Report bugs to %s\n"), report);
187 }
188
189 // For bool, arg will be NULL (boolean options take no argument);
190 // we always just set to true.
191 void
192 parse_bool(const char*, const char*, bool* retval)
193 {
194   *retval = true;
195 }
196
197 void
198 parse_uint(const char* option_name, const char* arg, int* retval)
199 {
200   char* endptr;
201   *retval = strtol(arg, &endptr, 0);
202   if (*endptr != '\0' || *retval < 0)
203     gold_fatal(_("%s: invalid option value (expected an integer): %s"),
204                option_name, arg);
205 }
206
207 void
208 parse_int(const char* option_name, const char* arg, int* retval)
209 {
210   char* endptr;
211   *retval = strtol(arg, &endptr, 0);
212   if (*endptr != '\0')
213     gold_fatal(_("%s: invalid option value (expected an integer): %s"),
214                option_name, arg);
215 }
216
217 void
218 parse_uint64(const char* option_name, const char* arg, uint64_t* retval)
219 {
220   char* endptr;
221   *retval = strtoull(arg, &endptr, 0);
222   if (*endptr != '\0')
223     gold_fatal(_("%s: invalid option value (expected an integer): %s"),
224                option_name, arg);
225 }
226
227 void
228 parse_double(const char* option_name, const char* arg, double* retval)
229 {
230   char* endptr;
231   *retval = strtod(arg, &endptr);
232   if (*endptr != '\0')
233     gold_fatal(_("%s: invalid option value "
234                  "(expected a floating point number): %s"),
235                option_name, arg);
236 }
237
238 void
239 parse_percent(const char* option_name, const char* arg, double* retval)
240 {
241   char* endptr;
242   *retval = strtod(arg, &endptr) / 100.0;
243   if (*endptr != '\0')
244     gold_fatal(_("%s: invalid option value "
245                  "(expected a floating point number): %s"),
246                option_name, arg);
247 }
248
249 void
250 parse_string(const char* option_name, const char* arg, const char** retval)
251 {
252   if (*arg == '\0')
253     gold_fatal(_("%s: must take a non-empty argument"), option_name);
254   *retval = arg;
255 }
256
257 void
258 parse_optional_string(const char*, const char* arg, const char** retval)
259 {
260   *retval = arg;
261 }
262
263 void
264 parse_dirlist(const char*, const char* arg, Dir_list* retval)
265 {
266   retval->push_back(Search_directory(arg, false));
267 }
268
269 void
270 parse_set(const char*, const char* arg, String_set* retval)
271 {
272   retval->insert(std::string(arg));
273 }
274
275 void
276 parse_choices(const char* option_name, const char* arg, const char** retval,
277               const char* choices[], int num_choices)
278 {
279   for (int i = 0; i < num_choices; i++)
280     if (strcmp(choices[i], arg) == 0)
281       {
282         *retval = arg;
283         return;
284       }
285
286   // If we get here, the user did not enter a valid choice, so we die.
287   std::string choices_list;
288   for (int i = 0; i < num_choices; i++)
289     {
290       choices_list += choices[i];
291       if (i != num_choices - 1)
292         choices_list += ", ";
293     }
294   gold_fatal(_("%s: must take one of the following arguments: %s"),
295              option_name, choices_list.c_str());
296 }
297
298 } // End namespace options.
299
300 // Define the handler for "special" options (set via DEFINE_special).
301
302 void
303 General_options::parse_help(const char*, const char*, Command_line*)
304 {
305   options::help();
306   ::exit(EXIT_SUCCESS);
307 }
308
309 void
310 General_options::parse_version(const char* opt, const char*, Command_line*)
311 {
312   bool print_short = (opt[0] == '-' && opt[1] == 'v');
313   gold::print_version(print_short);
314   this->printed_version_ = true;
315   if (!print_short)
316     ::exit(EXIT_SUCCESS);
317 }
318
319 void
320 General_options::parse_V(const char*, const char*, Command_line*)
321 {
322   gold::print_version(true);
323   this->printed_version_ = true;
324
325   printf(_("  Supported targets:\n"));
326   std::vector<const char*> supported_names;
327   gold::supported_target_names(&supported_names);
328   for (std::vector<const char*>::const_iterator p = supported_names.begin();
329        p != supported_names.end();
330        ++p)
331     printf("   %s\n", *p);
332
333   printf(_("  Supported emulations:\n"));
334   supported_names.clear();
335   gold::supported_emulation_names(&supported_names);
336   for (std::vector<const char*>::const_iterator p = supported_names.begin();
337        p != supported_names.end();
338        ++p)
339     printf("   %s\n", *p);
340 }
341
342 void
343 General_options::parse_defsym(const char*, const char* arg,
344                               Command_line* cmdline)
345 {
346   cmdline->script_options().define_symbol(arg);
347 }
348
349 void
350 General_options::parse_incremental(const char*, const char*,
351                                    Command_line*)
352 {
353   this->incremental_mode_ = INCREMENTAL_AUTO;
354 }
355
356 void
357 General_options::parse_no_incremental(const char*, const char*,
358                                       Command_line*)
359 {
360   this->incremental_mode_ = INCREMENTAL_OFF;
361 }
362
363 void
364 General_options::parse_incremental_full(const char*, const char*,
365                                         Command_line*)
366 {
367   this->incremental_mode_ = INCREMENTAL_FULL;
368 }
369
370 void
371 General_options::parse_incremental_update(const char*, const char*,
372                                           Command_line*)
373 {
374   this->incremental_mode_ = INCREMENTAL_UPDATE;
375 }
376
377 void
378 General_options::parse_incremental_changed(const char*, const char*,
379                                            Command_line*)
380 {
381   this->implicit_incremental_ = true;
382   this->incremental_disposition_ = INCREMENTAL_CHANGED;
383 }
384
385 void
386 General_options::parse_incremental_unchanged(const char*, const char*,
387                                              Command_line*)
388 {
389   this->implicit_incremental_ = true;
390   this->incremental_disposition_ = INCREMENTAL_UNCHANGED;
391 }
392
393 void
394 General_options::parse_incremental_unknown(const char*, const char*,
395                                            Command_line*)
396 {
397   this->implicit_incremental_ = true;
398   this->incremental_disposition_ = INCREMENTAL_CHECK;
399 }
400
401 void
402 General_options::parse_incremental_startup_unchanged(const char*, const char*,
403                                                      Command_line*)
404 {
405   this->implicit_incremental_ = true;
406   this->incremental_startup_disposition_ = INCREMENTAL_UNCHANGED;
407 }
408
409 void
410 General_options::parse_library(const char*, const char* arg,
411                                Command_line* cmdline)
412 {
413   Input_file_argument::Input_file_type type;
414   const char* name;
415   if (arg[0] == ':')
416     {
417       type = Input_file_argument::INPUT_FILE_TYPE_SEARCHED_FILE;
418       name = arg + 1;
419     }
420   else
421     {
422       type = Input_file_argument::INPUT_FILE_TYPE_LIBRARY;
423       name = arg;
424     }
425   Input_file_argument file(name, type, "", false, *this);
426   cmdline->inputs().add_file(file);
427 }
428
429 #ifdef ENABLE_PLUGINS
430 void
431 General_options::parse_plugin(const char*, const char* arg,
432                               Command_line*)
433 {
434   this->add_plugin(arg);
435 }
436
437 // Parse --plugin-opt.
438
439 void
440 General_options::parse_plugin_opt(const char*, const char* arg,
441                                   Command_line*)
442 {
443   this->add_plugin_option(arg);
444 }
445 #endif // ENABLE_PLUGINS
446
447 void
448 General_options::parse_R(const char* option, const char* arg,
449                          Command_line* cmdline)
450 {
451   struct stat s;
452   if (::stat(arg, &s) != 0 || S_ISDIR(s.st_mode))
453     this->add_to_rpath(arg);
454   else
455     this->parse_just_symbols(option, arg, cmdline);
456 }
457
458 void
459 General_options::parse_just_symbols(const char*, const char* arg,
460                                     Command_line* cmdline)
461 {
462   Input_file_argument file(arg, Input_file_argument::INPUT_FILE_TYPE_FILE,
463                            "", true, *this);
464   cmdline->inputs().add_file(file);
465 }
466
467 // Handle --section-start.
468
469 void
470 General_options::parse_section_start(const char*, const char* arg,
471                                      Command_line*)
472 {
473   const char* eq = strchr(arg, '=');
474   if (eq == NULL)
475     {
476       gold_error(_("invalid argument to --section-start; "
477                    "must be SECTION=ADDRESS"));
478       return;
479     }
480
481   std::string section_name(arg, eq - arg);
482
483   ++eq;
484   const char* val_start = eq;
485   if (eq[0] == '0' && (eq[1] == 'x' || eq[1] == 'X'))
486     eq += 2;
487   if (*eq == '\0')
488     {
489       gold_error(_("--section-start address missing"));
490       return;
491     }
492   uint64_t addr = 0;
493   hex_init();
494   for (; *eq != '\0'; ++eq)
495     {
496       if (!hex_p(*eq))
497         {
498           gold_error(_("--section-start argument %s is not a valid hex number"),
499                      val_start);
500           return;
501         }
502       addr <<= 4;
503       addr += hex_value(*eq);
504     }
505
506   this->section_starts_[section_name] = addr;
507 }
508
509 // Look up a --section-start value.
510
511 bool
512 General_options::section_start(const char* secname, uint64_t* paddr) const
513 {
514   if (this->section_starts_.empty())
515     return false;
516   std::map<std::string, uint64_t>::const_iterator p =
517     this->section_starts_.find(secname);
518   if (p == this->section_starts_.end())
519     return false;
520   *paddr = p->second;
521   return true;
522 }
523
524 void
525 General_options::parse_static(const char*, const char*, Command_line*)
526 {
527   this->set_static(true);
528 }
529
530 void
531 General_options::parse_script(const char*, const char* arg,
532                               Command_line* cmdline)
533 {
534   if (!read_commandline_script(arg, cmdline))
535     gold::gold_fatal(_("unable to parse script file %s"), arg);
536 }
537
538 void
539 General_options::parse_version_script(const char*, const char* arg,
540                                       Command_line* cmdline)
541 {
542   if (!read_version_script(arg, cmdline))
543     gold::gold_fatal(_("unable to parse version script file %s"), arg);
544 }
545
546 void
547 General_options::parse_dynamic_list(const char*, const char* arg,
548                                     Command_line* cmdline)
549 {
550   if (!read_dynamic_list(arg, cmdline, &this->dynamic_list_))
551     gold::gold_fatal(_("unable to parse dynamic-list script file %s"), arg);
552   this->have_dynamic_list_ = true;
553 }
554
555 void
556 General_options::parse_start_group(const char*, const char*,
557                                    Command_line* cmdline)
558 {
559   cmdline->inputs().start_group();
560 }
561
562 void
563 General_options::parse_end_group(const char*, const char*,
564                                  Command_line* cmdline)
565 {
566   cmdline->inputs().end_group();
567 }
568
569 void
570 General_options::parse_start_lib(const char*, const char*,
571                                  Command_line* cmdline)
572 {
573   cmdline->inputs().start_lib(cmdline->position_dependent_options());
574 }
575
576 void
577 General_options::parse_end_lib(const char*, const char*,
578                                Command_line* cmdline)
579 {
580   cmdline->inputs().end_lib();
581 }
582
583 // The function add_excluded_libs() in ld/ldlang.c of GNU ld breaks up a list
584 // of names separated by commas or colons and puts them in a linked list.
585 // We implement the same parsing of names here but store names in an unordered
586 // map to speed up searching of names.
587
588 void
589 General_options::parse_exclude_libs(const char*, const char* arg,
590                                     Command_line*)
591 {
592   const char* p = arg;
593
594   while (*p != '\0')
595     {
596       size_t length = strcspn(p, ",:");
597       this->excluded_libs_.insert(std::string(p, length));
598       p += (p[length] ? length + 1 : length);
599     }
600 }
601
602 // The checking logic is based on the function check_excluded_libs() in
603 // ld/ldlang.c of GNU ld but our implementation is different because we use
604 // an unordered map instead of a linked list, which is what GNU ld uses.  GNU
605 // ld searches sequentially in the excluded libs list.  For a given archive,
606 // a match is found if the archive's name matches exactly one of the list
607 // entry or if the archive's name is of the form FOO.a and FOO matches exactly
608 // one of the list entry.  An entry "ALL" in the list is considered as a
609 // wild-card and matches any given name.
610
611 bool
612 General_options::check_excluded_libs(const std::string &name) const
613 {
614   Unordered_set<std::string>::const_iterator p;
615
616   // Exit early for the most common case.
617   if (excluded_libs_.empty())
618     return false;
619
620   // If we see "ALL", all archives are excluded from automatic export.
621   p = excluded_libs_.find(std::string("ALL"));
622   if (p != excluded_libs_.end())
623     return true;
624
625   // First strip off any directories in name.
626   const char* basename = lbasename(name.c_str());
627
628   // Try finding an exact match.
629   p = excluded_libs_.find(std::string(basename));
630   if (p != excluded_libs_.end())
631     return true;
632
633   // Try matching NAME without ".a" at the end.
634   size_t length = strlen(basename);
635   if ((length >= 2)
636       && (basename[length - 2] == '.')
637       && (basename[length - 1] == 'a'))
638     {
639       p = excluded_libs_.find(std::string(basename, length - 2));
640       if (p != excluded_libs_.end())
641         return true;
642     }
643
644   return false;
645 }
646
647 // Recognize input and output target names.  The GNU linker accepts
648 // these with --format and --oformat.  This code is intended to be
649 // minimally compatible.  In practice for an ELF target this would be
650 // the same target as the input files; that name always start with
651 // "elf".  Non-ELF targets would be "srec", "symbolsrec", "tekhex",
652 // "binary", "ihex".
653
654 General_options::Object_format
655 General_options::string_to_object_format(const char* arg)
656 {
657   if (strncmp(arg, "elf", 3) == 0 || strcmp(arg, "default") == 0)
658     return gold::General_options::OBJECT_FORMAT_ELF;
659   else if (strcmp(arg, "binary") == 0)
660     return gold::General_options::OBJECT_FORMAT_BINARY;
661   else
662     {
663       gold::gold_error(_("format '%s' not supported; treating as elf "
664                          "(supported formats: elf, binary)"),
665                        arg);
666       return gold::General_options::OBJECT_FORMAT_ELF;
667     }
668 }
669
670 void
671 General_options::parse_fix_v4bx(const char*, const char*,
672                                 Command_line*)
673 {
674   this->fix_v4bx_ = FIX_V4BX_REPLACE;
675 }
676
677 void
678 General_options::parse_fix_v4bx_interworking(const char*, const char*,
679                                              Command_line*)
680 {
681   this->fix_v4bx_ = FIX_V4BX_INTERWORKING;
682 }
683
684 void
685 General_options::parse_EB(const char*, const char*, Command_line*)
686 {
687   this->endianness_ = ENDIANNESS_BIG;
688 }
689
690 void
691 General_options::parse_EL(const char*, const char*, Command_line*)
692 {
693   this->endianness_ = ENDIANNESS_LITTLE;
694 }
695
696 } // End namespace gold.
697
698 namespace
699 {
700
701 void
702 usage()
703 {
704   fprintf(stderr,
705           _("%s: use the --help option for usage information\n"),
706           gold::program_name);
707   ::exit(EXIT_FAILURE);
708 }
709
710 void
711 usage(const char* msg, const char* opt)
712 {
713   fprintf(stderr,
714           _("%s: %s: %s\n"),
715           gold::program_name, opt, msg);
716   usage();
717 }
718
719 // If the default sysroot is relocatable, try relocating it based on
720 // the prefix FROM.
721
722 static char*
723 get_relative_sysroot(const char* from)
724 {
725   char* path = make_relative_prefix(gold::program_name, from,
726                                     TARGET_SYSTEM_ROOT);
727   if (path != NULL)
728     {
729       struct stat s;
730       if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
731         return path;
732       free(path);
733     }
734
735   return NULL;
736 }
737
738 // Return the default sysroot.  This is set by the --with-sysroot
739 // option to configure.  Note we do not free the return value of
740 // get_relative_sysroot, which is a small memory leak, but is
741 // necessary since we store this pointer directly in General_options.
742
743 static const char*
744 get_default_sysroot()
745 {
746   const char* sysroot = TARGET_SYSTEM_ROOT;
747   if (*sysroot == '\0')
748     return NULL;
749
750   if (TARGET_SYSTEM_ROOT_RELOCATABLE)
751     {
752       char* path = get_relative_sysroot(BINDIR);
753       if (path == NULL)
754         path = get_relative_sysroot(TOOLBINDIR);
755       if (path != NULL)
756         return path;
757     }
758
759   return sysroot;
760 }
761
762 // Parse a long option.  Such options have the form
763 // <-|--><option>[=arg].  If "=arg" is not present but the option
764 // takes an argument, the next word is taken to the be the argument.
765 // If equals_only is set, then only the <option>=<arg> form is
766 // accepted, not the <option><space><arg> form.  Returns a One_option
767 // struct or NULL if argv[i] cannot be parsed as a long option.  In
768 // the not-NULL case, *arg is set to the option's argument (NULL if
769 // the option takes no argument), and *i is advanced past this option.
770 // NOTE: it is safe for argv and arg to point to the same place.
771 gold::options::One_option*
772 parse_long_option(int argc, const char** argv, bool equals_only,
773                   const char** arg, int* i)
774 {
775   const char* const this_argv = argv[*i];
776
777   const char* equals = strchr(this_argv, '=');
778   const char* option_start = this_argv + strspn(this_argv, "-");
779   std::string option(option_start,
780                      equals ? equals - option_start : strlen(option_start));
781
782   gold::options::Option_map::iterator it
783       = gold::options::long_options->find(option);
784   if (it == gold::options::long_options->end())
785     return NULL;
786
787   gold::options::One_option* retval = it->second;
788
789   // If the dash-count doesn't match, we fail.
790   if (this_argv[0] != '-')  // no dashes at all: had better be "-z <longopt>"
791     {
792       if (retval->dashes != gold::options::DASH_Z)
793         return NULL;
794     }
795   else if (this_argv[1] != '-')   // one dash
796     {
797       if (retval->dashes != gold::options::ONE_DASH
798           && retval->dashes != gold::options::EXACTLY_ONE_DASH
799           && retval->dashes != gold::options::TWO_DASHES)
800         return NULL;
801     }
802   else                            // two dashes (or more!)
803     {
804       if (retval->dashes != gold::options::TWO_DASHES
805           && retval->dashes != gold::options::EXACTLY_TWO_DASHES
806           && retval->dashes != gold::options::ONE_DASH)
807         return NULL;
808     }
809
810   // Now that we know the option is good (or else bad in a way that
811   // will cause us to die), increment i to point past this argv.
812   ++(*i);
813
814   // Figure out the option's argument, if any.
815   if (!retval->takes_argument())
816     {
817       if (equals)
818         usage(_("unexpected argument"), this_argv);
819       else
820         *arg = NULL;
821     }
822   else
823     {
824       if (equals)
825         *arg = equals + 1;
826       else if (retval->takes_optional_argument())
827         *arg = retval->default_value;
828       else if (*i < argc && !equals_only)
829         *arg = argv[(*i)++];
830       else
831         usage(_("missing argument"), this_argv);
832     }
833
834   return retval;
835 }
836
837 // Parse a short option.  Such options have the form -<option>[arg].
838 // If "arg" is not present but the option takes an argument, the next
839 // word is taken to the be the argument.  If the option does not take
840 // an argument, it may be followed by another short option.  Returns a
841 // One_option struct or NULL if argv[i] cannot be parsed as a short
842 // option.  In the not-NULL case, *arg is set to the option's argument
843 // (NULL if the option takes no argument), and *i is advanced past
844 // this option.  This function keeps *i the same if we parsed a short
845 // option that does not take an argument, that looks to be followed by
846 // another short option in the same word.
847 gold::options::One_option*
848 parse_short_option(int argc, const char** argv, int pos_in_argv_i,
849                    const char** arg, int* i)
850 {
851   const char* const this_argv = argv[*i];
852
853   if (this_argv[0] != '-')
854     return NULL;
855
856   // We handle -z as a special case.
857   static gold::options::One_option dash_z("", gold::options::DASH_Z,
858                                           'z', "", NULL, "Z-OPTION", false,
859                                           NULL);
860   gold::options::One_option* retval = NULL;
861   if (this_argv[pos_in_argv_i] == 'z')
862     retval = &dash_z;
863   else
864     {
865       const int char_as_int = static_cast<int>(this_argv[pos_in_argv_i]);
866       if (char_as_int > 0 && char_as_int < 128)
867         retval = gold::options::short_options[char_as_int];
868     }
869
870   if (retval == NULL)
871     return NULL;
872
873   // Figure out the option's argument, if any.
874   if (!retval->takes_argument())
875     {
876       *arg = NULL;
877       // We only advance past this argument if it's the only one in argv.
878       if (this_argv[pos_in_argv_i + 1] == '\0')
879         ++(*i);
880     }
881   else
882     {
883       // If we take an argument, we'll eat up this entire argv entry.
884       ++(*i);
885       if (this_argv[pos_in_argv_i + 1] != '\0')
886         *arg = this_argv + pos_in_argv_i + 1;
887       else if (retval->takes_optional_argument())
888         *arg = retval->default_value;
889       else if (*i < argc)
890         *arg = argv[(*i)++];
891       else
892         usage(_("missing argument"), this_argv);
893     }
894
895   // If we're a -z option, we need to parse our argument as a
896   // long-option, e.g. "-z stacksize=8192".
897   if (retval == &dash_z)
898     {
899       int dummy_i = 0;
900       const char* dash_z_arg = *arg;
901       retval = parse_long_option(1, arg, true, arg, &dummy_i);
902       if (retval == NULL)
903         usage(_("unknown -z option"), dash_z_arg);
904     }
905
906   return retval;
907 }
908
909 } // End anonymous namespace.
910
911 namespace gold
912 {
913
914 General_options::General_options()
915   : printed_version_(false),
916     execstack_status_(EXECSTACK_FROM_INPUT),
917     icf_status_(ICF_NONE),
918     static_(false),
919     do_demangle_(false),
920     plugins_(NULL),
921     dynamic_list_(),
922     have_dynamic_list_(false),
923     incremental_mode_(INCREMENTAL_OFF),
924     incremental_disposition_(INCREMENTAL_STARTUP),
925     incremental_startup_disposition_(INCREMENTAL_CHECK),
926     implicit_incremental_(false),
927     excluded_libs_(),
928     symbols_to_retain_(),
929     section_starts_(),
930     fix_v4bx_(FIX_V4BX_NONE),
931     endianness_(ENDIANNESS_NOT_SET)
932 {
933   // Turn off option registration once construction is complete.
934   gold::options::ready_to_register = false;
935 }
936
937 General_options::Object_format
938 General_options::format_enum() const
939 {
940   return General_options::string_to_object_format(this->format());
941 }
942
943 General_options::Object_format
944 General_options::oformat_enum() const
945 {
946   return General_options::string_to_object_format(this->oformat());
947 }
948
949 // Add the sysroot, if any, to the search paths.
950
951 void
952 General_options::add_sysroot()
953 {
954   if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
955     {
956       this->set_sysroot(get_default_sysroot());
957       if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
958         return;
959     }
960
961   char* canonical_sysroot = lrealpath(this->sysroot());
962
963   for (Dir_list::iterator p = this->library_path_.value.begin();
964        p != this->library_path_.value.end();
965        ++p)
966     p->add_sysroot(this->sysroot(), canonical_sysroot);
967
968   free(canonical_sysroot);
969 }
970
971 // Return whether FILENAME is in a system directory.
972
973 bool
974 General_options::is_in_system_directory(const std::string& filename) const
975 {
976   for (Dir_list::const_iterator p = this->library_path_.value.begin();
977        p != this->library_path_.value.end();
978        ++p)
979     {
980       // We use a straight string comparison rather than calling
981       // FILENAME_CMP because we are only interested in the cases
982       // where we found the file in a system directory, which means
983       // that we used the directory name as a prefix for a -L search.
984       if (p->is_system_directory()
985           && filename.compare(0, p->name().size(), p->name()) == 0)
986         return true;
987     }
988   return false;
989 }
990
991 // Add a plugin to the list of plugins.
992
993 void
994 General_options::add_plugin(const char* filename)
995 {
996   if (this->plugins_ == NULL)
997     this->plugins_ = new Plugin_manager(*this);
998   this->plugins_->add_plugin(filename);
999 }
1000
1001 // Add a plugin option to a plugin.
1002
1003 void
1004 General_options::add_plugin_option(const char* arg)
1005 {
1006   if (this->plugins_ == NULL)
1007     gold_fatal("--plugin-opt requires --plugin.");
1008   this->plugins_->add_plugin_option(arg);
1009 }
1010
1011 // Set up variables and other state that isn't set up automatically by
1012 // the parse routine, and ensure options don't contradict each other
1013 // and are otherwise kosher.
1014
1015 void
1016 General_options::finalize()
1017 {
1018   // Normalize the strip modifiers.  They have a total order:
1019   // strip_all > strip_debug > strip_non_line > strip_debug_gdb.
1020   // If one is true, set all beneath it to true as well.
1021   if (this->strip_all())
1022     this->set_strip_debug(true);
1023   if (this->strip_debug())
1024     this->set_strip_debug_non_line(true);
1025   if (this->strip_debug_non_line())
1026     this->set_strip_debug_gdb(true);
1027
1028   if (this->Bshareable())
1029     this->set_shared(true);
1030
1031   // If the user specifies both -s and -r, convert the -s to -S.
1032   // -r requires us to keep externally visible symbols!
1033   if (this->strip_all() && this->relocatable())
1034     {
1035       this->set_strip_all(false);
1036       gold_assert(this->strip_debug());
1037     }
1038
1039   // For us, -dc and -dp are synonyms for --define-common.
1040   if (this->dc())
1041     this->set_define_common(true);
1042   if (this->dp())
1043     this->set_define_common(true);
1044
1045   // We also set --define-common if we're not relocatable, as long as
1046   // the user didn't explicitly ask for something different.
1047   if (!this->user_set_define_common())
1048     this->set_define_common(!this->relocatable());
1049
1050   // execstack_status_ is a three-state variable; update it based on
1051   // -z [no]execstack.
1052   if (this->execstack())
1053     this->set_execstack_status(EXECSTACK_YES);
1054   else if (this->noexecstack())
1055     this->set_execstack_status(EXECSTACK_NO);
1056
1057   // icf_status_ is a three-state variable; update it based on the
1058   // value of this->icf().
1059   if (strcmp(this->icf(), "none") == 0)
1060     this->set_icf_status(ICF_NONE);
1061   else if (strcmp(this->icf(), "safe") == 0)
1062     this->set_icf_status(ICF_SAFE);
1063   else
1064     this->set_icf_status(ICF_ALL);
1065
1066   // Handle the optional argument for --demangle.
1067   if (this->user_set_demangle())
1068     {
1069       this->set_do_demangle(true);
1070       const char* style = this->demangle();
1071       if (*style != '\0')
1072         {
1073           enum demangling_styles style_code;
1074
1075           style_code = cplus_demangle_name_to_style(style);
1076           if (style_code == unknown_demangling)
1077             gold_fatal("unknown demangling style '%s'", style);
1078           cplus_demangle_set_style(style_code);
1079         }
1080     }
1081   else if (this->user_set_no_demangle())
1082     this->set_do_demangle(false);
1083   else
1084     {
1085       // Testing COLLECT_NO_DEMANGLE makes our default demangling
1086       // behaviour identical to that of gcc's linker wrapper.
1087       this->set_do_demangle(getenv("COLLECT_NO_DEMANGLE") == NULL);
1088     }
1089
1090   // -M is equivalent to "-Map -".
1091   if (this->print_map() && !this->user_set_Map())
1092     {
1093       this->set_Map("-");
1094       this->set_user_set_Map();
1095     }
1096
1097   // Using -n or -N implies -static.
1098   if (this->nmagic() || this->omagic())
1099     this->set_static(true);
1100
1101   // If --thread_count is specified, it applies to
1102   // --thread-count-{initial,middle,final}, though it doesn't override
1103   // them.
1104   if (this->thread_count() > 0 && this->thread_count_initial() == 0)
1105     this->set_thread_count_initial(this->thread_count());
1106   if (this->thread_count() > 0 && this->thread_count_middle() == 0)
1107     this->set_thread_count_middle(this->thread_count());
1108   if (this->thread_count() > 0 && this->thread_count_final() == 0)
1109     this->set_thread_count_final(this->thread_count());
1110
1111   // Let's warn if you set the thread-count but we're going to ignore it.
1112 #ifndef ENABLE_THREADS
1113   if (this->threads())
1114     {
1115       gold_warning(_("ignoring --threads: "
1116                      "%s was compiled without thread support"),
1117                    program_name);
1118       this->set_threads(false);
1119     }
1120   if (this->thread_count() > 0 || this->thread_count_initial() > 0
1121       || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
1122     gold_warning(_("ignoring --thread-count: "
1123                    "%s was compiled without thread support"),
1124                  program_name);
1125 #endif
1126
1127   std::string libpath;
1128   if (this->user_set_Y())
1129     {
1130       libpath = this->Y();
1131       if (libpath.compare(0, 2, "P,") == 0)
1132         libpath.erase(0, 2);
1133     }
1134   else if (!this->nostdlib())
1135     {
1136 #ifndef NATIVE_LINKER
1137 #define NATIVE_LINKER 0
1138 #endif
1139       const char* p = LIB_PATH;
1140       if (strcmp(p, "::DEFAULT::") != 0)
1141         libpath = p;
1142       else if (NATIVE_LINKER
1143                || this->user_set_sysroot()
1144                || *TARGET_SYSTEM_ROOT != '\0')
1145         {
1146           this->add_to_library_path_with_sysroot("/lib");
1147           this->add_to_library_path_with_sysroot("/usr/lib");
1148         }
1149       else
1150         this->add_to_library_path_with_sysroot(TOOLLIBDIR);
1151     }
1152
1153   if (!libpath.empty())
1154     {
1155       size_t pos = 0;
1156       size_t next_pos;
1157       do
1158         {
1159           next_pos = libpath.find(':', pos);
1160           size_t len = (next_pos == std::string::npos
1161                         ? next_pos
1162                         : next_pos - pos);
1163           if (len != 0)
1164             this->add_to_library_path_with_sysroot(libpath.substr(pos, len));
1165           pos = next_pos + 1;
1166         }
1167       while (next_pos != std::string::npos);
1168     }
1169
1170   // Parse the contents of -retain-symbols-file into a set.
1171   if (this->retain_symbols_file())
1172     {
1173       std::ifstream in;
1174       in.open(this->retain_symbols_file());
1175       if (!in)
1176         gold_fatal(_("unable to open -retain-symbols-file file %s: %s"),
1177                    this->retain_symbols_file(), strerror(errno));
1178       std::string line;
1179       std::getline(in, line);   // this chops off the trailing \n, if any
1180       while (in)
1181         {
1182           if (!line.empty() && line[line.length() - 1] == '\r')   // Windows
1183             line.resize(line.length() - 1);
1184           this->symbols_to_retain_.insert(line);
1185           std::getline(in, line);
1186         }
1187     }
1188
1189   // -Bgroup implies --unresolved-symbols=report-all.
1190   if (this->Bgroup() && !this->user_set_unresolved_symbols())
1191     this->set_unresolved_symbols("report-all");
1192
1193   // -shared implies --allow-shlib-undefined.  Currently
1194   // ---allow-shlib-undefined controls warnings issued based on the
1195   // -symbol table.  --unresolved-symbols controls warnings issued
1196   // -based on relocations.
1197   if (this->shared() && !this->user_set_allow_shlib_undefined())
1198     this->set_allow_shlib_undefined(true);
1199
1200   // Normalize library_path() by adding the sysroot to all directories
1201   // in the path, as appropriate.
1202   this->add_sysroot();
1203
1204   // --dynamic-list overrides -Bsymbolic and -Bsymbolic-functions.
1205   if (this->have_dynamic_list())
1206     {
1207       this->set_Bsymbolic(false);
1208       this->set_Bsymbolic_functions(false);
1209     }
1210
1211   // Now that we've normalized the options, check for contradictory ones.
1212   if (this->shared() && this->is_static())
1213     gold_fatal(_("-shared and -static are incompatible"));
1214   if (this->shared() && this->pie())
1215     gold_fatal(_("-shared and -pie are incompatible"));
1216   if (this->pie() && this->is_static())
1217     gold_fatal(_("-pie and -static are incompatible"));
1218
1219   if (this->shared() && this->relocatable())
1220     gold_fatal(_("-shared and -r are incompatible"));
1221   if (this->pie() && this->relocatable())
1222     gold_fatal(_("-pie and -r are incompatible"));
1223
1224   if (!this->shared())
1225     {
1226       if (this->filter() != NULL)
1227         gold_fatal(_("-F/--filter may not used without -shared"));
1228       if (this->any_auxiliary())
1229         gold_fatal(_("-f/--auxiliary may not be used without -shared"));
1230     }
1231
1232   // TODO: implement support for -retain-symbols-file with -r, if needed.
1233   if (this->relocatable() && this->retain_symbols_file())
1234     gold_fatal(_("-retain-symbols-file does not yet work with -r"));
1235
1236   if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
1237       && (this->shared()
1238           || this->pie()
1239           || this->relocatable()))
1240     gold_fatal(_("binary output format not compatible "
1241                  "with -shared or -pie or -r"));
1242
1243   if (this->user_set_hash_bucket_empty_fraction()
1244       && (this->hash_bucket_empty_fraction() < 0.0
1245           || this->hash_bucket_empty_fraction() >= 1.0))
1246     gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
1247                  "[0.0, 1.0)"),
1248                this->hash_bucket_empty_fraction());
1249
1250   if (this->implicit_incremental_ && this->incremental_mode_ == INCREMENTAL_OFF)
1251     gold_fatal(_("Options --incremental-changed, --incremental-unchanged, "
1252                  "--incremental-unknown require the use of --incremental"));
1253
1254   // Check for options that are not compatible with incremental linking.
1255   // Where an option can be disabled without seriously changing the semantics
1256   // of the link, we turn the option off; otherwise, we issue a fatal error.
1257
1258   if (this->incremental_mode_ != INCREMENTAL_OFF)
1259     {
1260       if (this->relocatable())
1261         gold_fatal(_("incremental linking is not compatible with -r"));
1262       if (this->emit_relocs())
1263         gold_fatal(_("incremental linking is not compatible with "
1264                      "--emit-relocs"));
1265       if (this->has_plugins())
1266         gold_fatal(_("incremental linking is not compatible with --plugin"));
1267       if (this->gc_sections())
1268         {
1269           gold_warning(_("ignoring --gc-sections for an incremental link"));
1270           this->set_gc_sections(false);
1271         }
1272       if (this->icf_enabled())
1273         {
1274           gold_warning(_("ignoring --icf for an incremental link"));
1275           this->set_icf_status(ICF_NONE);
1276         }
1277       if (strcmp(this->compress_debug_sections(), "none") != 0)
1278         {
1279           gold_warning(_("ignoring --compress-debug-sections for an "
1280                          "incremental link"));
1281           this->set_compress_debug_sections("none");
1282         }
1283     }
1284
1285   // --rosegment-gap implies --rosegment.
1286   if (this->user_set_rosegment_gap())
1287     this->set_rosegment(true);
1288
1289   // FIXME: we can/should be doing a lot more sanity checking here.
1290 }
1291
1292 // Search_directory methods.
1293
1294 // This is called if we have a sysroot.  Apply the sysroot if
1295 // appropriate.  Record whether the directory is in the sysroot.
1296
1297 void
1298 Search_directory::add_sysroot(const char* sysroot,
1299                               const char* canonical_sysroot)
1300 {
1301   gold_assert(*sysroot != '\0');
1302   if (this->put_in_sysroot_)
1303     {
1304       if (!IS_DIR_SEPARATOR(this->name_[0])
1305           && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
1306         this->name_ = '/' + this->name_;
1307       this->name_ = sysroot + this->name_;
1308       this->is_in_sysroot_ = true;
1309     }
1310   else
1311     {
1312       // Check whether this entry is in the sysroot.  To do this
1313       // correctly, we need to use canonical names.  Otherwise we will
1314       // get confused by the ../../.. paths that gcc tends to use.
1315       char* canonical_name = lrealpath(this->name_.c_str());
1316       int canonical_name_len = strlen(canonical_name);
1317       int canonical_sysroot_len = strlen(canonical_sysroot);
1318       if (canonical_name_len > canonical_sysroot_len
1319           && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
1320         {
1321           canonical_name[canonical_sysroot_len] = '\0';
1322           if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
1323             this->is_in_sysroot_ = true;
1324         }
1325       free(canonical_name);
1326     }
1327 }
1328
1329 // Input_arguments methods.
1330
1331 // Add a file to the list.
1332
1333 Input_argument&
1334 Input_arguments::add_file(Input_file_argument& file)
1335 {
1336   file.set_arg_serial(++this->file_count_);
1337   if (this->in_group_)
1338     {
1339       gold_assert(!this->input_argument_list_.empty());
1340       gold_assert(this->input_argument_list_.back().is_group());
1341       return this->input_argument_list_.back().group()->add_file(file);
1342     }
1343   if (this->in_lib_)
1344     {
1345       gold_assert(!this->input_argument_list_.empty());
1346       gold_assert(this->input_argument_list_.back().is_lib());
1347       return this->input_argument_list_.back().lib()->add_file(file);
1348     }
1349   this->input_argument_list_.push_back(Input_argument(file));
1350   return this->input_argument_list_.back();
1351 }
1352
1353 // Start a group.
1354
1355 void
1356 Input_arguments::start_group()
1357 {
1358   if (this->in_group_)
1359     gold_fatal(_("May not nest groups"));
1360   if (this->in_lib_)
1361     gold_fatal(_("may not nest groups in libraries"));
1362   Input_file_group* group = new Input_file_group();
1363   this->input_argument_list_.push_back(Input_argument(group));
1364   this->in_group_ = true;
1365 }
1366
1367 // End a group.
1368
1369 void
1370 Input_arguments::end_group()
1371 {
1372   if (!this->in_group_)
1373     gold_fatal(_("Group end without group start"));
1374   this->in_group_ = false;
1375 }
1376
1377 // Start a lib.
1378
1379 void
1380 Input_arguments::start_lib(const Position_dependent_options& options)
1381 {
1382   if (this->in_lib_)
1383     gold_fatal(_("may not nest libraries"));
1384   if (this->in_group_)
1385     gold_fatal(_("may not nest libraries in groups"));
1386   Input_file_lib* lib = new Input_file_lib(options);
1387   this->input_argument_list_.push_back(Input_argument(lib));
1388   this->in_lib_ = true;
1389 }
1390
1391 // End a lib.
1392
1393 void
1394 Input_arguments::end_lib()
1395 {
1396   if (!this->in_lib_)
1397     gold_fatal(_("lib end without lib start"));
1398   this->in_lib_ = false;
1399 }
1400
1401 // Command_line options.
1402
1403 Command_line::Command_line()
1404 {
1405 }
1406
1407 // Pre_options is the hook that sets the ready_to_register flag.
1408
1409 Command_line::Pre_options::Pre_options()
1410 {
1411   gold::options::ready_to_register = true;
1412 }
1413
1414 // Process the command line options.  For process_one_option, i is the
1415 // index of argv to process next, and must be an option (that is,
1416 // start with a dash).  The return value is the index of the next
1417 // option to process (i+1 or i+2, or argc to indicate processing is
1418 // done).  no_more_options is set to true if (and when) "--" is seen
1419 // as an option.
1420
1421 int
1422 Command_line::process_one_option(int argc, const char** argv, int i,
1423                                  bool* no_more_options)
1424 {
1425   gold_assert(argv[i][0] == '-' && !(*no_more_options));
1426
1427   // If we are reading "--", then just set no_more_options and return.
1428   if (argv[i][1] == '-' && argv[i][2] == '\0')
1429     {
1430       *no_more_options = true;
1431       return i + 1;
1432     }
1433
1434   int new_i = i;
1435   options::One_option* option = NULL;
1436   const char* arg = NULL;
1437
1438   // First, try to process argv as a long option.
1439   option = parse_long_option(argc, argv, false, &arg, &new_i);
1440   if (option)
1441     {
1442       option->reader->parse_to_value(argv[i], arg, this, &this->options_);
1443       return new_i;
1444     }
1445
1446   // Now, try to process argv as a short option.  Since several short
1447   // options can be combined in one argv, we may have to parse a lot
1448   // until we're done reading this argv.
1449   int pos_in_argv_i = 1;
1450   while (new_i == i)
1451     {
1452       option = parse_short_option(argc, argv, pos_in_argv_i, &arg, &new_i);
1453       if (!option)
1454         break;
1455       option->reader->parse_to_value(argv[i], arg, this, &this->options_);
1456       ++pos_in_argv_i;
1457     }
1458   if (option)
1459     return new_i;
1460
1461   // I guess it's neither a long option nor a short option.
1462   usage(_("unknown option"), argv[i]);
1463   return argc;
1464 }
1465
1466
1467 void
1468 Command_line::process(int argc, const char** argv)
1469 {
1470   bool no_more_options = false;
1471   int i = 0;
1472   while (i < argc)
1473     {
1474       this->position_options_.copy_from_options(this->options());
1475       if (no_more_options || argv[i][0] != '-')
1476         {
1477           Input_file_argument file(argv[i],
1478                                    Input_file_argument::INPUT_FILE_TYPE_FILE,
1479                                    "", false, this->position_options_);
1480           this->inputs_.add_file(file);
1481           ++i;
1482         }
1483       else
1484         i = process_one_option(argc, argv, i, &no_more_options);
1485     }
1486
1487   if (this->inputs_.in_group())
1488     {
1489       fprintf(stderr, _("%s: missing group end\n"), program_name);
1490       usage();
1491     }
1492
1493   // Normalize the options and ensure they don't contradict each other.
1494   this->options_.finalize();
1495 }
1496
1497 // Finalize the version script options and return them.
1498
1499 const Version_script_info&
1500 Command_line::version_script()
1501 {
1502   this->options_.finalize_dynamic_list();
1503   Version_script_info* vsi = this->script_options_.version_script_info();
1504   vsi->finalize();
1505   return *vsi;
1506 }
1507
1508 } // End namespace gold.