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