2009-10-09 Doug Kwan <dougkwan@google.com>
[external/binutils.git] / gold / options.cc
1 // options.c -- handle command line options for gold
2
3 // Copyright 2006, 2007, 2008, 2009 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 contruction 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 thes data structures.
63 typedef Unordered_map<std::string, One_option*> Option_map;
64 static Option_map* long_options = NULL;
65 static One_option* short_options[128];
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   // REPORT_BUGS_TO is defined in bfd/bfdver.h.
174   const char* report = REPORT_BUGS_TO;
175   if (*report != '\0')
176     printf(_("Report bugs to %s\n"), report);
177 }
178
179 // For bool, arg will be NULL (boolean options take no argument);
180 // we always just set to true.
181 void
182 parse_bool(const char*, const char*, bool* retval)
183 {
184   *retval = true;
185 }
186
187 void
188 parse_uint(const char* option_name, const char* arg, int* retval)
189 {
190   char* endptr;
191   *retval = strtol(arg, &endptr, 0);
192   if (*endptr != '\0' || retval < 0)
193     gold_fatal(_("%s: invalid option value (expected an integer): %s"),
194                option_name, arg);
195 }
196
197 void
198 parse_int(const char* option_name, const char* arg, int* retval)
199 {
200   char* endptr;
201   *retval = strtol(arg, &endptr, 0);
202   if (*endptr != '\0')
203     gold_fatal(_("%s: invalid option value (expected an integer): %s"),
204                option_name, arg);
205 }
206
207 void
208 parse_uint64(const char* option_name, const char* arg, uint64_t *retval)
209 {
210   char* endptr;
211   *retval = strtoull(arg, &endptr, 0);
212   if (*endptr != '\0')
213     gold_fatal(_("%s: invalid option value (expected an integer): %s"),
214                option_name, arg);
215 }
216
217 void
218 parse_double(const char* option_name, const char* arg, double* retval)
219 {
220   char* endptr;
221   *retval = strtod(arg, &endptr);
222   if (*endptr != '\0')
223     gold_fatal(_("%s: invalid option value "
224                  "(expected a floating point number): %s"),
225                option_name, arg);
226 }
227
228 void
229 parse_string(const char* option_name, const char* arg, const char** retval)
230 {
231   if (*arg == '\0')
232     gold_fatal(_("%s: must take a non-empty argument"), option_name);
233   *retval = arg;
234 }
235
236 void
237 parse_optional_string(const char*, const char* arg, const char** retval)
238 {
239   *retval = arg;
240 }
241
242 void
243 parse_dirlist(const char*, const char* arg, Dir_list* retval)
244 {
245   retval->push_back(Search_directory(arg, false));
246 }
247
248 void
249 parse_set(const char*, const char* arg, String_set* retval)
250 {
251   retval->insert(std::string(arg));
252 }
253
254 void
255 parse_choices(const char* option_name, const char* arg, const char** retval,
256               const char* choices[], int num_choices)
257 {
258   for (int i = 0; i < num_choices; i++)
259     if (strcmp(choices[i], arg) == 0)
260       {
261         *retval = arg;
262         return;
263       }
264
265   // If we get here, the user did not enter a valid choice, so we die.
266   std::string choices_list;
267   for (int i = 0; i < num_choices; i++)
268     {
269       choices_list += choices[i];
270       if (i != num_choices - 1)
271         choices_list += ", ";
272     }
273   gold_fatal(_("%s: must take one of the following arguments: %s"),
274              option_name, choices_list.c_str());
275 }
276
277 } // End namespace options.
278
279 // Define the handler for "special" options (set via DEFINE_special).
280
281 void
282 General_options::parse_help(const char*, const char*, Command_line*)
283 {
284   options::help();
285   ::exit(EXIT_SUCCESS);
286 }
287
288 void
289 General_options::parse_version(const char* opt, const char*, Command_line*)
290 {
291   gold::print_version(opt[0] == '-' && opt[1] == 'v');
292   ::exit(EXIT_SUCCESS);
293 }
294
295 void
296 General_options::parse_V(const char*, const char*, Command_line*)
297 {
298   gold::print_version(true);
299   this->printed_version_ = true;
300   printf(_("  Supported targets:\n"));
301   std::vector<const char*> supported_names;
302   gold::supported_target_names(&supported_names);
303   for (std::vector<const char*>::const_iterator p = supported_names.begin();
304        p != supported_names.end();
305        ++p)
306     printf("   %s\n", *p);
307 }
308
309 void
310 General_options::parse_defsym(const char*, const char* arg,
311                               Command_line* cmdline)
312 {
313   cmdline->script_options().define_symbol(arg);
314 }
315
316 void
317 General_options::parse_incremental_changed(const char*, const char*,
318                                            Command_line*)
319 {
320   this->implicit_incremental_ = true;
321   this->incremental_disposition_ = INCREMENTAL_CHANGED;
322 }
323
324 void
325 General_options::parse_incremental_unchanged(const char*, const char*,
326                                              Command_line*)
327 {
328   this->implicit_incremental_ = true;
329   this->incremental_disposition_ = INCREMENTAL_UNCHANGED;
330 }
331
332 void
333 General_options::parse_incremental_unknown(const char*, const char*,
334                                            Command_line*)
335 {
336   this->implicit_incremental_ = true;
337   this->incremental_disposition_ = INCREMENTAL_CHECK;
338 }
339
340 void
341 General_options::parse_library(const char*, const char* arg,
342                                Command_line* cmdline)
343 {
344   Input_file_argument file(arg, true, "", false, *this);
345   cmdline->inputs().add_file(file);
346 }
347
348 #ifdef ENABLE_PLUGINS
349 void
350 General_options::parse_plugin(const char*, const char* arg,
351                               Command_line*)
352 {
353   this->add_plugin(arg);
354 }
355
356 // Parse --plugin-opt.
357
358 void
359 General_options::parse_plugin_opt(const char*, const char* arg,
360                                   Command_line*)
361 {
362   this->add_plugin_option(arg);
363 }
364 #endif // ENABLE_PLUGINS
365
366 void
367 General_options::parse_R(const char* option, const char* arg,
368                          Command_line* cmdline)
369 {
370   struct stat s;
371   if (::stat(arg, &s) != 0 || S_ISDIR(s.st_mode))
372     this->add_to_rpath(arg);
373   else
374     this->parse_just_symbols(option, arg, cmdline);
375 }
376
377 void
378 General_options::parse_just_symbols(const char*, const char* arg,
379                                     Command_line* cmdline)
380 {
381   Input_file_argument file(arg, false, "", true, *this);
382   cmdline->inputs().add_file(file);
383 }
384
385 void
386 General_options::parse_static(const char*, const char*, Command_line*)
387 {
388   this->set_static(true);
389 }
390
391 void
392 General_options::parse_script(const char*, const char* arg,
393                               Command_line* cmdline)
394 {
395   if (!read_commandline_script(arg, cmdline))
396     gold::gold_fatal(_("unable to parse script file %s"), arg);
397 }
398
399 void
400 General_options::parse_version_script(const char*, const char* arg,
401                                       Command_line* cmdline)
402 {
403   if (!read_version_script(arg, cmdline))
404     gold::gold_fatal(_("unable to parse version script file %s"), arg);
405 }
406
407 void
408 General_options::parse_dynamic_list(const char*, const char* arg,
409                                     Command_line* cmdline)
410 {
411   if (!read_dynamic_list(arg, cmdline, &this->dynamic_list_))
412     gold::gold_fatal(_("unable to parse dynamic-list script file %s"), arg);
413 }
414
415 void
416 General_options::parse_start_group(const char*, const char*,
417                                    Command_line* cmdline)
418 {
419   cmdline->inputs().start_group();
420 }
421
422 void
423 General_options::parse_end_group(const char*, const char*,
424                                  Command_line* cmdline)
425 {
426   cmdline->inputs().end_group();
427 }
428
429 // The function add_excluded_libs() in ld/ldlang.c of GNU ld breaks up a list
430 // of names seperated by commas or colons and puts them in a linked list.
431 // We implement the same parsing of names here but store names in an unordered
432 // map to speed up searching of names.
433
434 void
435 General_options::parse_exclude_libs(const char*, const char* arg,
436                                     Command_line*)
437 {
438   const char *p = arg;
439
440   while (*p != '\0')
441     {
442       size_t length = strcspn(p, ",:");
443       this->excluded_libs_.insert(std::string(p, length));
444       p += (p[length] ? length + 1 : length);
445     }
446 }
447
448 // The checking logic is based on the function check_excluded_libs() in
449 // ld/ldlang.c of GNU ld but our implementation is different because we use
450 // an unordered map instead of a linked list, which is what GNU ld uses.  GNU
451 // ld searches sequentially in the excluded libs list.  For a given archive,
452 // a match is found if the archive's name matches exactly one of the list
453 // entry or if the archive's name is of the form FOO.a and FOO matches exactly
454 // one of the list entry.  An entry "ALL" in the list is considered as a
455 // wild-card and matches any given name.
456
457 bool
458 General_options::check_excluded_libs (const std::string &name) const
459 {
460   Unordered_set<std::string>::const_iterator p;
461
462   // Exit early for the most common case.
463   if (excluded_libs_.empty())
464     return false;
465
466   // If we see "ALL", all archives are excluded from automatic export.
467   p = excluded_libs_.find(std::string("ALL"));
468   if (p != excluded_libs_.end())
469     return true;
470
471   // First strip off any directories in name.
472   const char *basename = lbasename(name.c_str());
473
474   // Try finding an exact match.
475   p = excluded_libs_.find(std::string(basename));
476   if (p != excluded_libs_.end())
477     return true;
478
479   // Try matching NAME without ".a" at the end.
480   size_t length = strlen(basename);
481   if ((length >= 2)
482       && (basename[length - 2] == '.')
483       && (basename[length - 1] == 'a'))
484     {
485       p = excluded_libs_.find(std::string(basename, length - 2));
486       if (p != excluded_libs_.end())
487         return true;
488     }
489
490   return false;
491 }
492
493 // Recognize input and output target names.  The GNU linker accepts
494 // these with --format and --oformat.  This code is intended to be
495 // minimally compatible.  In practice for an ELF target this would be
496 // the same target as the input files; that name always start with
497 // "elf".  Non-ELF targets would be "srec", "symbolsrec", "tekhex",
498 // "binary", "ihex".
499
500 General_options::Object_format
501 General_options::string_to_object_format(const char* arg)
502 {
503   if (strncmp(arg, "elf", 3) == 0)
504     return gold::General_options::OBJECT_FORMAT_ELF;
505   else if (strcmp(arg, "binary") == 0)
506     return gold::General_options::OBJECT_FORMAT_BINARY;
507   else
508     {
509       gold::gold_error(_("format '%s' not supported; treating as elf "
510                          "(supported formats: elf, binary)"),
511                        arg);
512       return gold::General_options::OBJECT_FORMAT_ELF;
513     }
514 }
515
516 } // End namespace gold.
517
518 namespace
519 {
520
521 void
522 usage()
523 {
524   fprintf(stderr,
525           _("%s: use the --help option for usage information\n"),
526           gold::program_name);
527   ::exit(EXIT_FAILURE);
528 }
529
530 void
531 usage(const char* msg, const char *opt)
532 {
533   fprintf(stderr,
534           _("%s: %s: %s\n"),
535           gold::program_name, opt, msg);
536   usage();
537 }
538
539 // If the default sysroot is relocatable, try relocating it based on
540 // the prefix FROM.
541
542 static char*
543 get_relative_sysroot(const char* from)
544 {
545   char* path = make_relative_prefix(gold::program_name, from,
546                                     TARGET_SYSTEM_ROOT);
547   if (path != NULL)
548     {
549       struct stat s;
550       if (::stat(path, &s) == 0 && S_ISDIR(s.st_mode))
551         return path;
552       free(path);
553     }
554
555   return NULL;
556 }
557
558 // Return the default sysroot.  This is set by the --with-sysroot
559 // option to configure.  Note we do not free the return value of
560 // get_relative_sysroot, which is a small memory leak, but is
561 // necessary since we store this pointer directly in General_options.
562
563 static const char*
564 get_default_sysroot()
565 {
566   const char* sysroot = TARGET_SYSTEM_ROOT;
567   if (*sysroot == '\0')
568     return NULL;
569
570   if (TARGET_SYSTEM_ROOT_RELOCATABLE)
571     {
572       char* path = get_relative_sysroot(BINDIR);
573       if (path == NULL)
574         path = get_relative_sysroot(TOOLBINDIR);
575       if (path != NULL)
576         return path;
577     }
578
579   return sysroot;
580 }
581
582 // Parse a long option.  Such options have the form
583 // <-|--><option>[=arg].  If "=arg" is not present but the option
584 // takes an argument, the next word is taken to the be the argument.
585 // If equals_only is set, then only the <option>=<arg> form is
586 // accepted, not the <option><space><arg> form.  Returns a One_option
587 // struct or NULL if argv[i] cannot be parsed as a long option.  In
588 // the not-NULL case, *arg is set to the option's argument (NULL if
589 // the option takes no argument), and *i is advanced past this option.
590 // NOTE: it is safe for argv and arg to point to the same place.
591 gold::options::One_option*
592 parse_long_option(int argc, const char** argv, bool equals_only,
593                   const char** arg, int* i)
594 {
595   const char* const this_argv = argv[*i];
596
597   const char* equals = strchr(this_argv, '=');
598   const char* option_start = this_argv + strspn(this_argv, "-");
599   std::string option(option_start,
600                      equals ? equals - option_start : strlen(option_start));
601
602   gold::options::Option_map::iterator it
603       = gold::options::long_options->find(option);
604   if (it == gold::options::long_options->end())
605     return NULL;
606
607   gold::options::One_option* retval = it->second;
608
609   // If the dash-count doesn't match, we fail.
610   if (this_argv[0] != '-')  // no dashes at all: had better be "-z <longopt>"
611     {
612       if (retval->dashes != gold::options::DASH_Z)
613         return NULL;
614     }
615   else if (this_argv[1] != '-')   // one dash
616     {
617       if (retval->dashes != gold::options::ONE_DASH
618           && retval->dashes != gold::options::EXACTLY_ONE_DASH
619           && retval->dashes != gold::options::TWO_DASHES)
620         return NULL;
621     }
622   else                            // two dashes (or more!)
623     {
624       if (retval->dashes != gold::options::TWO_DASHES
625           && retval->dashes != gold::options::EXACTLY_TWO_DASHES
626           && retval->dashes != gold::options::ONE_DASH)
627         return NULL;
628     }
629
630   // Now that we know the option is good (or else bad in a way that
631   // will cause us to die), increment i to point past this argv.
632   ++(*i);
633
634   // Figure out the option's argument, if any.
635   if (!retval->takes_argument())
636     {
637       if (equals)
638         usage(_("unexpected argument"), this_argv);
639       else
640         *arg = NULL;
641     }
642   else
643     {
644       if (equals)
645         *arg = equals + 1;
646       else if (retval->takes_optional_argument())
647         *arg = retval->default_value;
648       else if (*i < argc && !equals_only)
649         *arg = argv[(*i)++];
650       else
651         usage(_("missing argument"), this_argv);
652     }
653
654   return retval;
655 }
656
657 // Parse a short option.  Such options have the form -<option>[arg].
658 // If "arg" is not present but the option takes an argument, the next
659 // word is taken to the be the argument.  If the option does not take
660 // an argument, it may be followed by another short option.  Returns a
661 // One_option struct or NULL if argv[i] cannot be parsed as a short
662 // option.  In the not-NULL case, *arg is set to the option's argument
663 // (NULL if the option takes no argument), and *i is advanced past
664 // this option.  This function keeps *i the same if we parsed a short
665 // option that does not take an argument, that looks to be followed by
666 // another short option in the same word.
667 gold::options::One_option*
668 parse_short_option(int argc, const char** argv, int pos_in_argv_i,
669                    const char** arg, int* i)
670 {
671   const char* const this_argv = argv[*i];
672
673   if (this_argv[0] != '-')
674     return NULL;
675
676   // We handle -z as a special case.
677   static gold::options::One_option dash_z("", gold::options::DASH_Z,
678                                           'z', "", NULL, "Z-OPTION", false,
679                                           NULL);
680   gold::options::One_option* retval = NULL;
681   if (this_argv[pos_in_argv_i] == 'z')
682     retval = &dash_z;
683   else
684     {
685       const int char_as_int = static_cast<int>(this_argv[pos_in_argv_i]);
686       if (char_as_int > 0 && char_as_int < 128)
687         retval = gold::options::short_options[char_as_int];
688     }
689
690   if (retval == NULL)
691     return NULL;
692
693   // Figure out the option's argument, if any.
694   if (!retval->takes_argument())
695     {
696       *arg = NULL;
697       // We only advance past this argument if it's the only one in argv.
698       if (this_argv[pos_in_argv_i + 1] == '\0')
699         ++(*i);
700     }
701   else
702     {
703       // If we take an argument, we'll eat up this entire argv entry.
704       ++(*i);
705       if (this_argv[pos_in_argv_i + 1] != '\0')
706         *arg = this_argv + pos_in_argv_i + 1;
707       else if (retval->takes_optional_argument())
708         *arg = retval->default_value;
709       else if (*i < argc)
710         *arg = argv[(*i)++];
711       else
712         usage(_("missing argument"), this_argv);
713     }
714
715   // If we're a -z option, we need to parse our argument as a
716   // long-option, e.g. "-z stacksize=8192".
717   if (retval == &dash_z)
718     {
719       int dummy_i = 0;
720       const char* dash_z_arg = *arg;
721       retval = parse_long_option(1, arg, true, arg, &dummy_i);
722       if (retval == NULL)
723         usage(_("unknown -z option"), dash_z_arg);
724     }
725
726   return retval;
727 }
728
729 } // End anonymous namespace.
730
731 namespace gold
732 {
733
734 General_options::General_options()
735   : printed_version_(false),
736     execstack_status_(General_options::EXECSTACK_FROM_INPUT), static_(false),
737     do_demangle_(false), plugins_(),
738     incremental_disposition_(INCREMENTAL_CHECK), implicit_incremental_(false)
739 {
740   // Turn off option registration once construction is complete.
741   gold::options::ready_to_register = false;
742 }
743
744 General_options::Object_format
745 General_options::format_enum() const
746 {
747   return General_options::string_to_object_format(this->format());
748 }
749
750 General_options::Object_format
751 General_options::oformat_enum() const
752 {
753   return General_options::string_to_object_format(this->oformat());
754 }
755
756 // Add the sysroot, if any, to the search paths.
757
758 void
759 General_options::add_sysroot()
760 {
761   if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
762     {
763       this->set_sysroot(get_default_sysroot());
764       if (this->sysroot() == NULL || this->sysroot()[0] == '\0')
765         return;
766     }
767
768   char* canonical_sysroot = lrealpath(this->sysroot());
769
770   for (Dir_list::iterator p = this->library_path_.value.begin();
771        p != this->library_path_.value.end();
772        ++p)
773     p->add_sysroot(this->sysroot(), canonical_sysroot);
774
775   free(canonical_sysroot);
776 }
777
778 // Return whether FILENAME is in a system directory.
779
780 bool
781 General_options::is_in_system_directory(const std::string& filename) const
782 {
783   for (Dir_list::const_iterator p = this->library_path_.value.begin();
784        p != this->library_path_.value.end();
785        ++p)
786     {
787       // We use a straight string comparison rather than calling
788       // FILENAME_CMP because we are only interested in the cases
789       // where we found the file in a system directory, which means
790       // that we used the directory name as a prefix for a -L search.
791       if (p->is_system_directory()
792           && filename.compare(0, p->name().size(), p->name()) == 0)
793         return true;
794     }
795   return false;
796 }
797
798 // Add a plugin to the list of plugins.
799
800 void
801 General_options::add_plugin(const char* filename)
802 {
803   if (this->plugins_ == NULL)
804     this->plugins_ = new Plugin_manager(*this);
805   this->plugins_->add_plugin(filename);
806 }
807
808 // Add a plugin option to a plugin.
809
810 void
811 General_options::add_plugin_option(const char* arg)
812 {
813   if (this->plugins_ == NULL)
814     gold_fatal("--plugin-opt requires --plugin.");
815   this->plugins_->add_plugin_option(arg);
816 }
817
818 // Set up variables and other state that isn't set up automatically by
819 // the parse routine, and ensure options don't contradict each other
820 // and are otherwise kosher.
821
822 void
823 General_options::finalize()
824 {
825   // Normalize the strip modifiers.  They have a total order:
826   // strip_all > strip_debug > strip_non_line > strip_debug_gdb.
827   // If one is true, set all beneath it to true as well.
828   if (this->strip_all())
829     this->set_strip_debug(true);
830   if (this->strip_debug())
831     this->set_strip_debug_non_line(true);
832   if (this->strip_debug_non_line())
833     this->set_strip_debug_gdb(true);
834
835   if (this->Bshareable())
836     this->set_shared(true);
837
838   // If the user specifies both -s and -r, convert the -s to -S.
839   // -r requires us to keep externally visible symbols!
840   if (this->strip_all() && this->relocatable())
841     {
842       this->set_strip_all(false);
843       gold_assert(this->strip_debug());
844     }
845
846   // For us, -dc and -dp are synonyms for --define-common.
847   if (this->dc())
848     this->set_define_common(true);
849   if (this->dp())
850     this->set_define_common(true);
851
852   // We also set --define-common if we're not relocatable, as long as
853   // the user didn't explicitly ask for something different.
854   if (!this->user_set_define_common())
855     this->set_define_common(!this->relocatable());
856
857   // execstack_status_ is a three-state variable; update it based on
858   // -z [no]execstack.
859   if (this->execstack())
860     this->set_execstack_status(EXECSTACK_YES);
861   else if (this->noexecstack())
862     this->set_execstack_status(EXECSTACK_NO);
863
864   // Handle the optional argument for --demangle.
865   if (this->user_set_demangle())
866     {
867       this->set_do_demangle(true);
868       const char* style = this->demangle();
869       if (*style != '\0')
870         {
871           enum demangling_styles style_code;
872
873           style_code = cplus_demangle_name_to_style(style);
874           if (style_code == unknown_demangling)
875             gold_fatal("unknown demangling style '%s'", style);
876           cplus_demangle_set_style(style_code);
877         }
878     }
879   else if (this->user_set_no_demangle())
880     this->set_do_demangle(false);
881   else
882     {
883       // Testing COLLECT_NO_DEMANGLE makes our default demangling
884       // behaviour identical to that of gcc's linker wrapper.
885       this->set_do_demangle(getenv("COLLECT_NO_DEMANGLE") == NULL);
886     }
887
888   // -M is equivalent to "-Map -".
889   if (this->print_map() && !this->user_set_Map())
890     {
891       this->set_Map("-");
892       this->set_user_set_Map();
893     }
894
895   // Using -n or -N implies -static.
896   if (this->nmagic() || this->omagic())
897     this->set_static(true);
898
899   // If --thread_count is specified, it applies to
900   // --thread-count-{initial,middle,final}, though it doesn't override
901   // them.
902   if (this->thread_count() > 0 && this->thread_count_initial() == 0)
903     this->set_thread_count_initial(this->thread_count());
904   if (this->thread_count() > 0 && this->thread_count_middle() == 0)
905     this->set_thread_count_middle(this->thread_count());
906   if (this->thread_count() > 0 && this->thread_count_final() == 0)
907     this->set_thread_count_final(this->thread_count());
908
909   // Let's warn if you set the thread-count but we're going to ignore it.
910 #ifndef ENABLE_THREADS
911   if (this->threads())
912     {
913       gold_warning(_("ignoring --threads: "
914                      "%s was compiled without thread support"),
915                    program_name);
916       this->set_threads(false);
917     }
918   if (this->thread_count() > 0 || this->thread_count_initial() > 0
919       || this->thread_count_middle() > 0 || this->thread_count_final() > 0)
920     gold_warning(_("ignoring --thread-count: "
921                    "%s was compiled without thread support"),
922                  program_name);
923 #endif
924
925   if (this->user_set_Y())
926     {
927       std::string s = this->Y();
928       if (s.compare(0, 2, "P,") == 0)
929         s.erase(0, 2);
930
931       size_t pos = 0;
932       size_t next_pos;
933       do
934         {
935           next_pos = s.find(':', pos);
936           size_t len = (next_pos == std::string::npos
937                         ? next_pos
938                         : next_pos - pos);
939           if (len != 0)
940             this->add_to_library_path_with_sysroot(s.substr(pos, len).c_str());
941           pos = next_pos + 1;
942         }
943       while (next_pos != std::string::npos);
944     }
945   else
946     {
947       // Even if they don't specify it, we add -L /lib and -L /usr/lib.
948       // FIXME: We should only do this when configured in native mode.
949       this->add_to_library_path_with_sysroot("/lib");
950       this->add_to_library_path_with_sysroot("/usr/lib");
951     }
952
953   // Parse the contents of -retain-symbols-file into a set.
954   if (this->retain_symbols_file())
955     {
956       std::ifstream in;
957       in.open(this->retain_symbols_file());
958       if (!in)
959         gold_fatal(_("unable to open -retain-symbols-file file %s: %s"),
960                    this->retain_symbols_file(), strerror(errno));
961       std::string line;
962       std::getline(in, line);   // this chops off the trailing \n, if any
963       while (in)
964         {
965           if (!line.empty() && line[line.length() - 1] == '\r')   // Windows
966             line.resize(line.length() - 1);
967           this->symbols_to_retain_.insert(line);
968           std::getline(in, line);
969         }
970     }
971
972   if (this->shared() && !this->user_set_allow_shlib_undefined())
973     this->set_allow_shlib_undefined(true);
974
975   // Normalize library_path() by adding the sysroot to all directories
976   // in the path, as appropriate.
977   this->add_sysroot();
978
979   // Now that we've normalized the options, check for contradictory ones.
980   if (this->shared() && this->is_static())
981     gold_fatal(_("-shared and -static are incompatible"));
982
983   if (this->shared() && this->relocatable())
984     gold_fatal(_("-shared and -r are incompatible"));
985
986   // TODO: implement support for -retain-symbols-file with -r, if needed.
987   if (this->relocatable() && this->retain_symbols_file())
988     gold_fatal(_("-retain-symbols-file does not yet work with -r"));
989
990   if (this->oformat_enum() != General_options::OBJECT_FORMAT_ELF
991       && (this->shared() || this->relocatable()))
992     gold_fatal(_("binary output format not compatible with -shared or -r"));
993
994   if (this->user_set_hash_bucket_empty_fraction()
995       && (this->hash_bucket_empty_fraction() < 0.0
996           || this->hash_bucket_empty_fraction() >= 1.0))
997     gold_fatal(_("--hash-bucket-empty-fraction value %g out of range "
998                  "[0.0, 1.0)"),
999                this->hash_bucket_empty_fraction());
1000
1001   if (this->implicit_incremental_ && !this->incremental())
1002     gold_fatal(_("Options --incremental-changed, --incremental-unchanged, "
1003                  "--incremental-unknown require the use of --incremental"));
1004
1005   // FIXME: we can/should be doing a lot more sanity checking here.
1006 }
1007
1008 // Search_directory methods.
1009
1010 // This is called if we have a sysroot.  Apply the sysroot if
1011 // appropriate.  Record whether the directory is in the sysroot.
1012
1013 void
1014 Search_directory::add_sysroot(const char* sysroot,
1015                               const char* canonical_sysroot)
1016 {
1017   gold_assert(*sysroot != '\0');
1018   if (this->put_in_sysroot_)
1019     {
1020       if (!IS_DIR_SEPARATOR(this->name_[0])
1021           && !IS_DIR_SEPARATOR(sysroot[strlen(sysroot) - 1]))
1022         this->name_ = '/' + this->name_;
1023       this->name_ = sysroot + this->name_;
1024       this->is_in_sysroot_ = true;
1025     }
1026   else
1027     {
1028       // Check whether this entry is in the sysroot.  To do this
1029       // correctly, we need to use canonical names.  Otherwise we will
1030       // get confused by the ../../.. paths that gcc tends to use.
1031       char* canonical_name = lrealpath(this->name_.c_str());
1032       int canonical_name_len = strlen(canonical_name);
1033       int canonical_sysroot_len = strlen(canonical_sysroot);
1034       if (canonical_name_len > canonical_sysroot_len
1035           && IS_DIR_SEPARATOR(canonical_name[canonical_sysroot_len]))
1036         {
1037           canonical_name[canonical_sysroot_len] = '\0';
1038           if (FILENAME_CMP(canonical_name, canonical_sysroot) == 0)
1039             this->is_in_sysroot_ = true;
1040         }
1041       free(canonical_name);
1042     }
1043 }
1044
1045 // Input_arguments methods.
1046
1047 // Add a file to the list.
1048
1049 void
1050 Input_arguments::add_file(const Input_file_argument& file)
1051 {
1052   if (!this->in_group_)
1053     this->input_argument_list_.push_back(Input_argument(file));
1054   else
1055     {
1056       gold_assert(!this->input_argument_list_.empty());
1057       gold_assert(this->input_argument_list_.back().is_group());
1058       this->input_argument_list_.back().group()->add_file(file);
1059     }
1060 }
1061
1062 // Start a group.
1063
1064 void
1065 Input_arguments::start_group()
1066 {
1067   if (this->in_group_)
1068     gold_fatal(_("May not nest groups"));
1069   Input_file_group* group = new Input_file_group();
1070   this->input_argument_list_.push_back(Input_argument(group));
1071   this->in_group_ = true;
1072 }
1073
1074 // End a group.
1075
1076 void
1077 Input_arguments::end_group()
1078 {
1079   if (!this->in_group_)
1080     gold_fatal(_("Group end without group start"));
1081   this->in_group_ = false;
1082 }
1083
1084 // Command_line options.
1085
1086 Command_line::Command_line()
1087 {
1088 }
1089
1090 // Pre_options is the hook that sets the ready_to_register flag.
1091
1092 Command_line::Pre_options::Pre_options()
1093 {
1094   gold::options::ready_to_register = true;
1095 }
1096
1097 // Process the command line options.  For process_one_option, i is the
1098 // index of argv to process next, and must be an option (that is,
1099 // start with a dash).  The return value is the index of the next
1100 // option to process (i+1 or i+2, or argc to indicate processing is
1101 // done).  no_more_options is set to true if (and when) "--" is seen
1102 // as an option.
1103
1104 int
1105 Command_line::process_one_option(int argc, const char** argv, int i,
1106                                  bool* no_more_options)
1107 {
1108   gold_assert(argv[i][0] == '-' && !(*no_more_options));
1109
1110   // If we are reading "--", then just set no_more_options and return.
1111   if (argv[i][1] == '-' && argv[i][2] == '\0')
1112     {
1113       *no_more_options = true;
1114       return i + 1;
1115     }
1116
1117   int new_i = i;
1118   options::One_option* option = NULL;
1119   const char* arg = NULL;
1120
1121   // First, try to process argv as a long option.
1122   option = parse_long_option(argc, argv, false, &arg, &new_i);
1123   if (option)
1124     {
1125       option->reader->parse_to_value(argv[i], arg, this, &this->options_);
1126       return new_i;
1127     }
1128
1129   // Now, try to process argv as a short option.  Since several short
1130   // options can be combined in one argv, we may have to parse a lot
1131   // until we're done reading this argv.
1132   int pos_in_argv_i = 1;
1133   while (new_i == i)
1134     {
1135       option = parse_short_option(argc, argv, pos_in_argv_i, &arg, &new_i);
1136       if (!option)
1137         break;
1138       option->reader->parse_to_value(argv[i], arg, this, &this->options_);
1139       ++pos_in_argv_i;
1140     }
1141   if (option)
1142     return new_i;
1143
1144   // I guess it's neither a long option nor a short option.
1145   usage(_("unknown option"), argv[i]);
1146   return argc;
1147 }
1148
1149
1150 void
1151 Command_line::process(int argc, const char** argv)
1152 {
1153   bool no_more_options = false;
1154   int i = 0;
1155   while (i < argc)
1156     {
1157       this->position_options_.copy_from_options(this->options());
1158       if (no_more_options || argv[i][0] != '-')
1159         {
1160           Input_file_argument file(argv[i], false, "", false,
1161                                    this->position_options_);
1162           this->inputs_.add_file(file);
1163           ++i;
1164         }
1165       else
1166         i = process_one_option(argc, argv, i, &no_more_options);
1167     }
1168
1169   if (this->inputs_.in_group())
1170     {
1171       fprintf(stderr, _("%s: missing group end\n"), program_name);
1172       usage();
1173     }
1174
1175   // Normalize the options and ensure they don't contradict each other.
1176   this->options_.finalize();
1177 }
1178
1179 } // End namespace gold.