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