Merge branch 'vendor/GREP'
[dragonfly.git] / contrib / binutils-2.24 / 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 }
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     incremental_mode_(INCREMENTAL_OFF),
922     incremental_disposition_(INCREMENTAL_STARTUP),
923     incremental_startup_disposition_(INCREMENTAL_CHECK),
924     implicit_incremental_(false),
925     excluded_libs_(),
926     symbols_to_retain_(),
927     section_starts_(),
928     fix_v4bx_(FIX_V4BX_NONE),
929     endianness_(ENDIANNESS_NOT_SET)
930 {
931   // Turn off option registration once construction is complete.
932   gold::options::ready_to_register = false;
933 }
934
935 General_options::Object_format
936 General_options::format_enum() const
937 {
938   return General_options::string_to_object_format(this->format());
939 }
940
941 General_options::Object_format
942 General_options::oformat_enum() const
943 {
944   return General_options::string_to_object_format(this->oformat());
945 }
946
947 // Add the sysroot, if any, to the search paths.
948
949 void
950 General_options::add_sysroot()
951 {
952   if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
953     {
954       this->set_sysroot(get_default_sysroot());
955       if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
956         return;
957     }
958
959   char* canonical_sysroot = lrealpath(this->sysroot());
960
961   for (Dir_list::iterator p = this->library_path_.value.begin();
962        p != this->library_path_.value.end();
963        ++p)
964     p->add_sysroot(this->sysroot(), canonical_sysroot);
965
966   free(canonical_sysroot);
967 }
968
969 // Return whether FILENAME is in a system directory.
970
971 bool
972 General_options::is_in_system_directory(const std::string& filename) const
973 {
974   for (Dir_list::const_iterator p = this->library_path_.value.begin();
975        p != this->library_path_.value.end();
976        ++p)
977     {
978       // We use a straight string comparison rather than calling
979       // FILENAME_CMP because we are only interested in the cases
980       // where we found the file in a system directory, which means
981       // that we used the directory name as a prefix for a -L search.
982       if (p->is_system_directory()
983           && filename.compare(0, p->name().size(), p->name()) == 0)
984         return true;
985     }
986   return false;
987 }
988
989 // Add a plugin to the list of plugins.
990
991 void
992 General_options::add_plugin(const char* filename)
993 {
994   if (this->plugins_ == NULL)
995     this->plugins_ = new Plugin_manager(*this);
996   this->plugins_->add_plugin(filename);
997 }
998
999 // Add a plugin option to a plugin.
1000
1001 void
1002 General_options::add_plugin_option(const char* arg)
1003 {
1004   if (this->plugins_ == NULL)
1005     gold_fatal("--plugin-opt requires --plugin.");
1006   this->plugins_->add_plugin_option(arg);
1007 }
1008
1009 // Set up variables and other state that isn't set up automatically by
1010 // the parse routine, and ensure options don't contradict each other
1011 // and are otherwise kosher.
1012
1013 void
1014 General_options::finalize()
1015 {
1016   // Normalize the strip modifiers.  They have a total order:
1017   // strip_all > strip_debug > strip_non_line > strip_debug_gdb.
1018   // If one is true, set all beneath it to true as well.
1019   if (this->strip_all())
1020     this->set_strip_debug(true);
1021   if (this->strip_debug())
1022     this->set_strip_debug_non_line(true);
1023   if (this->strip_debug_non_line())
1024     this->set_strip_debug_gdb(true);
1025
1026   if (this->Bshareable())
1027     this->set_shared(true);
1028
1029   // If the user specifies both -s and -r, convert the -s to -S.
1030   // -r requires us to keep externally visible symbols!
1031   if (this->strip_all() && this->relocatable())
1032     {
1033       this->set_strip_all(false);
1034       gold_assert(this->strip_debug());
1035     }
1036
1037   // For us, -dc and -dp are synonyms for --define-common.
1038   if (this->dc())
1039     this->set_define_common(true);
1040   if (this->dp())
1041     this->set_define_common(true);
1042
1043   // We also set --define-common if we're not relocatable, as long as
1044   // the user didn't explicitly ask for something different.
1045   if (!this->user_set_define_common())
1046     this->set_define_common(!this->relocatable());
1047
1048   // execstack_status_ is a three-state variable; update it based on
1049   // -z [no]execstack.
1050   if (this->execstack())
1051     this->set_execstack_status(EXECSTACK_YES);
1052   else if (this->noexecstack())
1053     this->set_execstack_status(EXECSTACK_NO);
1054
1055   // icf_status_ is a three-state variable; update it based on the
1056   // value of this->icf().
1057   if (strcmp(this->icf(), "none") == 0)
1058     this->set_icf_status(ICF_NONE);
1059   else if (strcmp(this->icf(), "safe") == 0)
1060     this->set_icf_status(ICF_SAFE);
1061   else
1062     this->set_icf_status(ICF_ALL);
1063
1064   // Handle the optional argument for --demangle.
1065   if (this->user_set_demangle())
1066     {
1067       this->set_do_demangle(true);
1068       const char* style = this->demangle();
1069       if (*style != '\0')
1070         {
1071           enum demangling_styles style_code;
1072
1073           style_code = cplus_demangle_name_to_style(style);
1074           if (style_code == unknown_demangling)
1075             gold_fatal("unknown demangling style '%s'", style);
1076           cplus_demangle_set_style(style_code);
1077         }
1078     }
1079   else if (this->user_set_no_demangle())
1080     this->set_do_demangle(false);
1081   else
1082     {
1083       // Testing COLLECT_NO_DEMANGLE makes our default demangling
1084       // behaviour identical to that of gcc's linker wrapper.
1085       this->set_do_demangle(getenv("COLLECT_NO_DEMANGLE") == NULL);
1086     }
1087
1088   // -M is equivalent to "-Map -".
1089   if (this->print_map() && !this->user_set_Map())
1090     {
1091       this->set_Map("-");
1092       this->set_user_set_Map();
1093     }
1094
1095   // Using -n or -N implies -static.
1096   if (this->nmagic() || this->omagic())
1097     this->set_static(true);
1098
1099   // If --thread_count is specified, it applies to
1100   // --thread-count-{initial,middle,final}, though it doesn't override
1101   // them.
1102   if (this->thread_count() > 0 && this->thread_count_initial() == 0)
1103     this->set_thread_count_initial(this->thread_count());
1104   if (this->thread_count() > 0 && this->thread_count_middle() == 0)
1105     this->set_thread_count_middle(this->thread_count());
1106   if (this->thread_count() > 0 && this->thread_count_final() == 0)
1107     this->set_thread_count_final(this->thread_count());
1108
1109   // Let's warn if you set the thread-count but we're going to ignore it.
1110 #ifndef ENABLE_THREADS
1111   if (this->threads())
1112     {
1113       gold_warning(_("ignoring --threads: "
1114                      "%s was compiled without thread support"),
1115                    program_name);
1116       this->set_threads(false);
1117     }
1118   if (this->thread_count() > 0 || this->thread_count_initial() > 0
1119       || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
1120     gold_warning(_("ignoring --thread-count: "
1121                    "%s was compiled without thread support"),
1122                  program_name);
1123 #endif
1124
1125   std::string libpath;
1126   if (this->user_set_Y())
1127     {
1128       libpath = this->Y();
1129       if (libpath.compare(0, 2, "P,") == 0)
1130         libpath.erase(0, 2);
1131     }
1132   else if (!this->nostdlib())
1133     {
1134 #ifndef NATIVE_LINKER
1135 #define NATIVE_LINKER 0
1136 #endif
1137       const char* p = LIB_PATH;
1138       if (strcmp(p, "::DEFAULT::") != 0)
1139         libpath = p;
1140       else if (NATIVE_LINKER
1141                || this->user_set_sysroot()
1142                || *TARGET_SYSTEM_ROOT != '\0')
1143         {
1144           this->add_to_library_path_with_sysroot(USRDATA_PREFIX "/lib");
1145           this->add_to_library_path_with_sysroot(USRDATA_PREFIX "/usr/lib");
1146         }
1147       else
1148         this->add_to_library_path_with_sysroot(TOOLLIBDIR);
1149     }
1150
1151   if (!libpath.empty())
1152     {
1153       size_t pos = 0;
1154       size_t next_pos;
1155       do
1156         {
1157           next_pos = libpath.find(':', pos);
1158           size_t len = (next_pos == std::string::npos
1159                         ? next_pos
1160                         : next_pos - pos);
1161           if (len != 0)
1162             this->add_to_library_path_with_sysroot(libpath.substr(pos, len));
1163           pos = next_pos + 1;
1164         }
1165       while (next_pos != std::string::npos);
1166     }
1167
1168   // Parse the contents of -retain-symbols-file into a set.
1169   if (this->retain_symbols_file())
1170     {
1171       std::ifstream in;
1172       in.open(this->retain_symbols_file());
1173       if (!in)
1174         gold_fatal(_("unable to open -retain-symbols-file file %s: %s"),
1175                    this->retain_symbols_file(), strerror(errno));
1176       std::string line;
1177       std::getline(in, line);   // this chops off the trailing \n, if any
1178       while (in)
1179         {
1180           if (!line.empty() && line[line.length() - 1] == '\r')   // Windows
1181             line.resize(line.length() - 1);
1182           this->symbols_to_retain_.insert(line);
1183           std::getline(in, line);
1184         }
1185     }
1186
1187   // -Bgroup implies --unresolved-symbols=report-all.
1188   if (this->Bgroup() && !this->user_set_unresolved_symbols())
1189     this->set_unresolved_symbols("report-all");
1190
1191   // -shared implies --allow-shlib-undefined.  Currently
1192   // ---allow-shlib-undefined controls warnings issued based on the
1193   // -symbol table.  --unresolved-symbols controls warnings issued
1194   // -based on relocations.
1195   if (this->shared() && !this->user_set_allow_shlib_undefined())
1196     this->set_allow_shlib_undefined(true);
1197
1198   // Normalize library_path() by adding the sysroot to all directories
1199   // in the path, as appropriate.
1200   this->add_sysroot();
1201
1202   // Now that we've normalized the options, check for contradictory ones.
1203   if (this->shared() && this->is_static())
1204     gold_fatal(_("-shared and -static are incompatible"));
1205   if (this->shared() && this->pie())
1206     gold_fatal(_("-shared and -pie are incompatible"));
1207   if (this->pie() && this->is_static())
1208     gold_fatal(_("-pie and -static are incompatible"));
1209
1210   if (this->shared() && this->relocatable())
1211     gold_fatal(_("-shared and -r are incompatible"));
1212   if (this->pie() && this->relocatable())
1213     gold_fatal(_("-pie and -r are incompatible"));
1214
1215   if (!this->shared())
1216     {
1217       if (this->filter() != NULL)
1218         gold_fatal(_("-F/--filter may not used without -shared"));
1219       if (this->any_auxiliary())
1220         gold_fatal(_("-f/--auxiliary may not be used without -shared"));
1221     }
1222
1223   // TODO: implement support for -retain-symbols-file with -r, if needed.
1224   if (this->relocatable() && this->retain_symbols_file())
1225     gold_fatal(_("-retain-symbols-file does not yet work with -r"));
1226
1227   if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
1228       && (this->shared()
1229           || this->pie()
1230           || this->relocatable()))
1231     gold_fatal(_("binary output format not compatible "
1232                  "with -shared or -pie or -r"));
1233
1234   if (this->user_set_hash_bucket_empty_fraction()
1235       && (this->hash_bucket_empty_fraction() < 0.0
1236           || this->hash_bucket_empty_fraction() >= 1.0))
1237     gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
1238                  "[0.0, 1.0)"),
1239                this->hash_bucket_empty_fraction());
1240
1241   if (this->implicit_incremental_ && this->incremental_mode_ == INCREMENTAL_OFF)
1242     gold_fatal(_("Options --incremental-changed, --incremental-unchanged, "
1243                  "--incremental-unknown require the use of --incremental"));
1244
1245   // Check for options that are not compatible with incremental linking.
1246   // Where an option can be disabled without seriously changing the semantics
1247   // of the link, we turn the option off; otherwise, we issue a fatal error.
1248
1249   if (this->incremental_mode_ != INCREMENTAL_OFF)
1250     {
1251       if (this->relocatable())
1252         gold_fatal(_("incremental linking is not compatible with -r"));
1253       if (this->emit_relocs())
1254         gold_fatal(_("incremental linking is not compatible with "
1255                      "--emit-relocs"));
1256       if (this->has_plugins())
1257         gold_fatal(_("incremental linking is not compatible with --plugin"));
1258       if (this->gc_sections())
1259         {
1260           gold_warning(_("ignoring --gc-sections for an incremental link"));
1261           this->set_gc_sections(false);
1262         }
1263       if (this->icf_enabled())
1264         {
1265           gold_warning(_("ignoring --icf for an incremental link"));
1266           this->set_icf_status(ICF_NONE);
1267         }
1268       if (strcmp(this->compress_debug_sections(), "none") != 0)
1269         {
1270           gold_warning(_("ignoring --compress-debug-sections for an "
1271                          "incremental link"));
1272           this->set_compress_debug_sections("none");
1273         }
1274     }
1275
1276   // --rosegment-gap implies --rosegment.
1277   if (this->user_set_rosegment_gap())
1278     this->set_rosegment(true);
1279
1280   // FIXME: we can/should be doing a lot more sanity checking here.
1281 }
1282
1283 // Search_directory methods.
1284
1285 // This is called if we have a sysroot.  Apply the sysroot if
1286 // appropriate.  Record whether the directory is in the sysroot.
1287
1288 void
1289 Search_directory::add_sysroot(const char* sysroot,
1290                               const char* canonical_sysroot)
1291 {
1292   gold_assert(*sysroot != '\0');
1293   if (this->put_in_sysroot_)
1294     {
1295       if (!IS_DIR_SEPARATOR(this->name_[0])
1296           && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
1297         this->name_ = '/' + this->name_;
1298       this->name_ = sysroot + this->name_;
1299       this->is_in_sysroot_ = true;
1300     }
1301   else
1302     {
1303       // Check whether this entry is in the sysroot.  To do this
1304       // correctly, we need to use canonical names.  Otherwise we will
1305       // get confused by the ../../.. paths that gcc tends to use.
1306       char* canonical_name = lrealpath(this->name_.c_str());
1307       int canonical_name_len = strlen(canonical_name);
1308       int canonical_sysroot_len = strlen(canonical_sysroot);
1309       if (canonical_name_len > canonical_sysroot_len
1310           && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
1311         {
1312           canonical_name[canonical_sysroot_len] = '\0';
1313           if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
1314             this->is_in_sysroot_ = true;
1315         }
1316       free(canonical_name);
1317     }
1318 }
1319
1320 // Input_arguments methods.
1321
1322 // Add a file to the list.
1323
1324 Input_argument&
1325 Input_arguments::add_file(Input_file_argument& file)
1326 {
1327   file.set_arg_serial(++this->file_count_);
1328   if (this->in_group_)
1329     {
1330       gold_assert(!this->input_argument_list_.empty());
1331       gold_assert(this->input_argument_list_.back().is_group());
1332       return this->input_argument_list_.back().group()->add_file(file);
1333     }
1334   if (this->in_lib_)
1335     {
1336       gold_assert(!this->input_argument_list_.empty());
1337       gold_assert(this->input_argument_list_.back().is_lib());
1338       return this->input_argument_list_.back().lib()->add_file(file);
1339     }
1340   this->input_argument_list_.push_back(Input_argument(file));
1341   return this->input_argument_list_.back();
1342 }
1343
1344 // Start a group.
1345
1346 void
1347 Input_arguments::start_group()
1348 {
1349   if (this->in_group_)
1350     gold_fatal(_("May not nest groups"));
1351   if (this->in_lib_)
1352     gold_fatal(_("may not nest groups in libraries"));
1353   Input_file_group* group = new Input_file_group();
1354   this->input_argument_list_.push_back(Input_argument(group));
1355   this->in_group_ = true;
1356 }
1357
1358 // End a group.
1359
1360 void
1361 Input_arguments::end_group()
1362 {
1363   if (!this->in_group_)
1364     gold_fatal(_("Group end without group start"));
1365   this->in_group_ = false;
1366 }
1367
1368 // Start a lib.
1369
1370 void
1371 Input_arguments::start_lib(const Position_dependent_options& options)
1372 {
1373   if (this->in_lib_)
1374     gold_fatal(_("may not nest libraries"));
1375   if (this->in_group_)
1376     gold_fatal(_("may not nest libraries in groups"));
1377   Input_file_lib* lib = new Input_file_lib(options);
1378   this->input_argument_list_.push_back(Input_argument(lib));
1379   this->in_lib_ = true;
1380 }
1381
1382 // End a lib.
1383
1384 void
1385 Input_arguments::end_lib()
1386 {
1387   if (!this->in_lib_)
1388     gold_fatal(_("lib end without lib start"));
1389   this->in_lib_ = false;
1390 }
1391
1392 // Command_line options.
1393
1394 Command_line::Command_line()
1395 {
1396 }
1397
1398 // Pre_options is the hook that sets the ready_to_register flag.
1399
1400 Command_line::Pre_options::Pre_options()
1401 {
1402   gold::options::ready_to_register = true;
1403 }
1404
1405 // Process the command line options.  For process_one_option, i is the
1406 // index of argv to process next, and must be an option (that is,
1407 // start with a dash).  The return value is the index of the next
1408 // option to process (i+1 or i+2, or argc to indicate processing is
1409 // done).  no_more_options is set to true if (and when) "--" is seen
1410 // as an option.
1411
1412 int
1413 Command_line::process_one_option(int argc, const char** argv, int i,
1414                                  bool* no_more_options)
1415 {
1416   gold_assert(argv[i][0] == '-' && !(*no_more_options));
1417
1418   // If we are reading "--", then just set no_more_options and return.
1419   if (argv[i][1] == '-' && argv[i][2] == '\0')
1420     {
1421       *no_more_options = true;
1422       return i + 1;
1423     }
1424
1425   int new_i = i;
1426   options::One_option* option = NULL;
1427   const char* arg = NULL;
1428
1429   // First, try to process argv as a long option.
1430   option = parse_long_option(argc, argv, false, &arg, &new_i);
1431   if (option)
1432     {
1433       option->reader->parse_to_value(argv[i], arg, this, &this->options_);
1434       return new_i;
1435     }
1436
1437   // Now, try to process argv as a short option.  Since several short
1438   // options can be combined in one argv, we may have to parse a lot
1439   // until we're done reading this argv.
1440   int pos_in_argv_i = 1;
1441   while (new_i == i)
1442     {
1443       option = parse_short_option(argc, argv, pos_in_argv_i, &arg, &new_i);
1444       if (!option)
1445         break;
1446       option->reader->parse_to_value(argv[i], arg, this, &this->options_);
1447       ++pos_in_argv_i;
1448     }
1449   if (option)
1450     return new_i;
1451
1452   // I guess it's neither a long option nor a short option.
1453   usage(_("unknown option"), argv[i]);
1454   return argc;
1455 }
1456
1457
1458 void
1459 Command_line::process(int argc, const char** argv)
1460 {
1461   bool no_more_options = false;
1462   int i = 0;
1463   while (i < argc)
1464     {
1465       this->position_options_.copy_from_options(this->options());
1466       if (no_more_options || argv[i][0] != '-')
1467         {
1468           Input_file_argument file(argv[i],
1469                                    Input_file_argument::INPUT_FILE_TYPE_FILE,
1470                                    "", false, this->position_options_);
1471           this->inputs_.add_file(file);
1472           ++i;
1473         }
1474       else
1475         i = process_one_option(argc, argv, i, &no_more_options);
1476     }
1477
1478   if (this->inputs_.in_group())
1479     {
1480       fprintf(stderr, _("%s: missing group end\n"), program_name);
1481       usage();
1482     }
1483
1484   // Normalize the options and ensure they don't contradict each other.
1485   this->options_.finalize();
1486 }
1487
1488 // Finalize the version script options and return them.
1489
1490 const Version_script_info&
1491 Command_line::version_script()
1492 {
1493   this->options_.finalize_dynamic_list();
1494   Version_script_info* vsi = this->script_options_.version_script_info();
1495   vsi->finalize();
1496   return *vsi;
1497 }
1498
1499 } // End namespace gold.