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