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