gold/options.h

   1 // options.h -- handle command line options for gold  -*- C++ -*-
   2
   3 // Copyright 2006, 2007, 2008, 2009, 2010, 2011 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 // General_options (from Command_line::options())
  24 //   All the options (a.k.a. command-line flags)
  25 // Input_argument (from Command_line::inputs())
  26 //   The list of input files, including -l options.
  27 // Command_line
  28 //   Everything we get from the command line -- the General_options
  29 //   plus the Input_arguments.
  30 //
  31 // There are also some smaller classes, such as
  32 // Position_dependent_options which hold a subset of General_options
  33 // that change as options are parsed (as opposed to the usual behavior
  34 // of the last instance of that option specified on the commandline wins).
  35
  36 #ifndef GOLD_OPTIONS_H
  37 #define GOLD_OPTIONS_H
  38
  39 #include <cstdlib>
  40 #include <cstring>
  41 #include <list>
  42 #include <map>
  43 #include <string>
  44 #include <vector>
  45
  46 #include "elfcpp.h"
  47 #include "script.h"
  48
  49 namespace gold
  50 {
  51
  52 class Command_line;
  53 class General_options;
  54 class Search_directory;
  55 class Input_file_group;
  56 class Input_file_lib;
  57 class Position_dependent_options;
  58 class Target;
  59 class Plugin_manager;
  60 class Script_info;
  61
  62 // Incremental build action for a specific file, as selected by the user.
  63
  64 enum Incremental_disposition
  65 {
  66   // Startup files that appear before the first disposition option.
  67   // These will default to INCREMENTAL_CHECK unless the
  68   // --incremental-startup-unchanged option is given.
  69   // (For files added implicitly by gcc before any user options.)
  70   INCREMENTAL_STARTUP,
  71   // Determine the status from the timestamp (default).
  72   INCREMENTAL_CHECK,
  73   // Assume the file changed from the previous build.
  74   INCREMENTAL_CHANGED,
  75   // Assume the file didn't change from the previous build.
  76   INCREMENTAL_UNCHANGED
  77 };
  78
  79 // The nested namespace is to contain all the global variables and
  80 // structs that need to be defined in the .h file, but do not need to
  81 // be used outside this class.
  82 namespace options
  83 {
  84 typedef std::vector<Search_directory> Dir_list;
  85 typedef Unordered_set<std::string> String_set;
  86
  87 // These routines convert from a string option to various types.
  88 // Each gives a fatal error if it cannot parse the argument.
  89
  90 extern void
  91 parse_bool(const char* option_name, const char* arg, bool* retval);
  92
  93 extern void
  94 parse_int(const char* option_name, const char* arg, int* retval);
  95
  96 extern void
  97 parse_uint(const char* option_name, const char* arg, int* retval);
  98
  99 extern void
 100 parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
 101
 102 extern void
 103 parse_double(const char* option_name, const char* arg, double* retval);
 104
 105 extern void
 106 parse_percent(const char* option_name, const char* arg, double* retval);
 107
 108 extern void
 109 parse_string(const char* option_name, const char* arg, const char** retval);
 110
 111 extern void
 112 parse_optional_string(const char* option_name, const char* arg,
 113                       const char** retval);
 114
 115 extern void
 116 parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
 117
 118 extern void
 119 parse_set(const char* option_name, const char* arg, String_set* retval);
 120
 121 extern void
 122 parse_choices(const char* option_name, const char* arg, const char** retval,
 123               const char* choices[], int num_choices);
 124
 125 struct Struct_var;
 126
 127 // Most options have both a shortname (one letter) and a longname.
 128 // This enum controls how many dashes are expected for longname access
 129 // -- shortnames always use one dash.  Most longnames will accept
 130 // either one dash or two; the only difference between ONE_DASH and
 131 // TWO_DASHES is how we print the option in --help.  However, some
 132 // longnames require two dashes, and some require only one.  The
 133 // special value DASH_Z means that the option is preceded by "-z".
 134 enum Dashes
 135 {
 136   ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z
 137 };
 138
 139 // LONGNAME is the long-name of the option with dashes converted to
 140 //    underscores, or else the short-name if the option has no long-name.
 141 //    It is never the empty string.
 142 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
 143 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
 144 //    option has no short-name.  If the option has no long-name, you
 145 //    should specify the short-name in *both* VARNAME and here.
 146 // DEFAULT_VALUE is the value of the option if not specified on the
 147 //    commandline, as a string.
 148 // HELPSTRING is the descriptive text used with the option via --help
 149 // HELPARG is how you define the argument to the option.
 150 //    --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
 151 //    HELPARG should be NULL iff the option is a bool and takes no arg.
 152 // OPTIONAL_ARG is true if this option takes an optional argument.  An
 153 //    optional argument must be specifid as --OPTION=VALUE, not
 154 //    --OPTION VALUE.
 155 // READER provides parse_to_value, which is a function that will convert
 156 //    a char* argument into the proper type and store it in some variable.
 157 // A One_option struct initializes itself with the global list of options
 158 // at constructor time, so be careful making one of these.
 159 struct One_option
 160 {
 161   std::string longname;
 162   Dashes dashes;
 163   char shortname;
 164   const char* default_value;
 165   const char* helpstring;
 166   const char* helparg;
 167   bool optional_arg;
 168   Struct_var* reader;
 169
 170   One_option(const char* ln, Dashes d, char sn, const char* dv,
 171              const char* hs, const char* ha, bool oa, Struct_var* r)
 172     : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
 173       helpstring(hs), helparg(ha), optional_arg(oa), reader(r)
 174   {
 175     // In longname, we convert all underscores to dashes, since GNU
 176     // style uses dashes in option names.  longname is likely to have
 177     // underscores in it because it's also used to declare a C++
 178     // function.
 179     const char* pos = strchr(this->longname.c_str(), '_');
 180     for (; pos; pos = strchr(pos, '_'))
 181       this->longname[pos - this->longname.c_str()] = '-';
 182
 183     // We only register ourselves if our helpstring is not NULL.  This
 184     // is to support the "no-VAR" boolean variables, which we
 185     // conditionally turn on by defining "no-VAR" help text.
 186     if (this->helpstring)
 187       this->register_option();
 188   }
 189
 190   // This option takes an argument iff helparg is not NULL.
 191   bool
 192   takes_argument() const
 193   { return this->helparg != NULL; }
 194
 195   // Whether the argument is optional.
 196   bool
 197   takes_optional_argument() const
 198   { return this->optional_arg; }
 199
 200   // Register this option with the global list of options.
 201   void
 202   register_option();
 203
 204   // Print this option to stdout (used with --help).
 205   void
 206   print() const;
 207 };
 208
 209 // All options have a Struct_##varname that inherits from this and
 210 // actually implements parse_to_value for that option.
 211 struct Struct_var
 212 {
 213   // OPTION: the name of the option as specified on the commandline,
 214   //    including leading dashes, and any text following the option:
 215   //    "-O", "--defsym=mysym=0x1000", etc.
 216   // ARG: the arg associated with this option, or NULL if the option
 217   //    takes no argument: "2", "mysym=0x1000", etc.
 218   // CMDLINE: the global Command_line object.  Used by DEFINE_special.
 219   // OPTIONS: the global General_options object.  Used by DEFINE_special.
 220   virtual void
 221   parse_to_value(const char* option, const char* arg,
 222                  Command_line* cmdline, General_options* options) = 0;
 223   virtual
 224   ~Struct_var()  // To make gcc happy.
 225   { }
 226 };
 227
 228 // This is for "special" options that aren't of any predefined type.
 229 struct Struct_special : public Struct_var
 230 {
 231   // If you change this, change the parse-fn in DEFINE_special as well.
 232   typedef void (General_options::*Parse_function)(const char*, const char*,
 233                                                   Command_line*);
 234   Struct_special(const char* varname, Dashes dashes, char shortname,
 235                  Parse_function parse_function,
 236                  const char* helpstring, const char* helparg)
 237     : option(varname, dashes, shortname, "", helpstring, helparg, false, this),
 238       parse(parse_function)
 239   { }
 240
 241   void parse_to_value(const char* option, const char* arg,
 242                       Command_line* cmdline, General_options* options)
 243   { (options->*(this->parse))(option, arg, cmdline); }
 244
 245   One_option option;
 246   Parse_function parse;
 247 };
 248
 249 }  // End namespace options.
 250
 251
 252 // These are helper macros use by DEFINE_uint64/etc below.
 253 // This macro is used inside the General_options_ class, so defines
 254 // var() and set_var() as General_options methods.  Arguments as are
 255 // for the constructor for One_option.  param_type__ is the same as
 256 // type__ for built-in types, and "const type__ &" otherwise.
 257 //
 258 // When we define the linker command option "assert", the macro argument
 259 // varname__ of DEFINE_var below will be replaced by "assert".  On Mac OSX
 260 // assert.h is included implicitly by one of the library headers we use.  To
 261 // avoid unintended macro substitution of "assert()", we need to enclose
 262 // varname__ with parenthese.
 263 #define DEFINE_var(varname__, dashes__, shortname__, default_value__,        \
 264                    default_value_as_string__, helpstring__, helparg__,       \
 265                    optional_arg__, type__, param_type__, parse_fn__)         \
 266  public:                                                                     \
 267   param_type__                                                               \
 268   (varname__)() const                                                        \
 269   { return this->varname__##_.value; }                                       \
 270                                                                              \
 271   bool                                                                       \
 272   user_set_##varname__() const                                               \
 273   { return this->varname__##_.user_set_via_option; }                         \
 274                                                                              \
 275   void                                                                       \
 276   set_user_set_##varname__()                                                 \
 277   { this->varname__##_.user_set_via_option = true; }                         \
 278                                                                              \
 279  private:                                                                    \
 280   struct Struct_##varname__ : public options::Struct_var                     \
 281   {                                                                          \
 282     Struct_##varname__()                                                     \
 283       : option(#varname__, dashes__, shortname__, default_value_as_string__, \
 284                helpstring__, helparg__, optional_arg__, this),               \
 285         user_set_via_option(false), value(default_value__)                   \
 286     { }                                                                      \
 287                                                                              \
 288     void                                                                     \
 289     parse_to_value(const char* option_name, const char* arg,                 \
 290                    Command_line*, General_options*)                          \
 291     {                                                                        \
 292       parse_fn__(option_name, arg, &this->value);                            \
 293       this->user_set_via_option = true;                                      \
 294     }                                                                        \
 295                                                                              \
 296     options::One_option option;                                              \
 297     bool user_set_via_option;                                                \
 298     type__ value;                                                            \
 299   };                                                                         \
 300   Struct_##varname__ varname__##_;                                           \
 301   void                                                                       \
 302   set_##varname__(param_type__ value)                                        \
 303   { this->varname__##_.value = value; }
 304
 305 // These macros allow for easy addition of a new commandline option.
 306
 307 // If no_helpstring__ is not NULL, then in addition to creating
 308 // VARNAME, we also create an option called no-VARNAME (or, for a -z
 309 // option, noVARNAME).
 310 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__,   \
 311                     helpstring__, no_helpstring__)                       \
 312   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 313              default_value__ ? "true" : "false", helpstring__, NULL,     \
 314              false, bool, bool, options::parse_bool)                     \
 315   struct Struct_no_##varname__ : public options::Struct_var              \
 316   {                                                                      \
 317     Struct_no_##varname__() : option((dashes__ == options::DASH_Z        \
 318                                       ? "no" #varname__                  \
 319                                       : "no-" #varname__),               \
 320                                      dashes__, '\0',                     \
 321                                      default_value__ ? "false" : "true", \
 322                                      no_helpstring__, NULL, false, this) \
 323     { }                                                                  \
 324                                                                          \
 325     void                                                                 \
 326     parse_to_value(const char*, const char*,                             \
 327                    Command_line*, General_options* options)              \
 328     {                                                                    \
 329       options->set_##varname__(false);                                   \
 330       options->set_user_set_##varname__();                               \
 331     }                                                                    \
 332                                                                          \
 333     options::One_option option;                                          \
 334   };                                                                     \
 335   Struct_no_##varname__ no_##varname__##_initializer_
 336
 337 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
 338                       helpstring__, no_helpstring__)                     \
 339   DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
 340              default_value__ ? "true" : "false", helpstring__, NULL,     \
 341              false, bool, bool, options::parse_bool)                     \
 342   struct Struct_disable_##varname__ : public options::Struct_var         \
 343   {                                                                      \
 344     Struct_disable_##varname__() : option("disable-" #varname__,         \
 345                                      dashes__, '\0',                     \
 346                                      default_value__ ? "false" : "true", \
 347                                      no_helpstring__, NULL, false, this) \
 348     { }                                                                  \
 349                                                                          \
 350     void                                                                 \
 351     parse_to_value(const char*, const char*,                             \
 352                    Command_line*, General_options* options)              \
 353     { options->set_enable_##varname__(false); }                          \
 354                                                                          \
 355     options::One_option option;                                          \
 356   };                                                                     \
 357   Struct_disable_##varname__ disable_##varname__##_initializer_
 358
 359 #define DEFINE_int(varname__, dashes__, shortname__, default_value__,   \
 360                    helpstring__, helparg__)                             \
 361   DEFINE_var(varname__, dashes__, shortname__, default_value__,         \
 362              #default_value__, helpstring__, helparg__, false,          \
 363              int, int, options::parse_int)
 364
 365 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__,  \
 366                    helpstring__, helparg__)                             \
 367   DEFINE_var(varname__, dashes__, shortname__, default_value__,         \
 368              #default_value__, helpstring__, helparg__, false,          \
 369              int, int, options::parse_uint)
 370
 371 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
 372                       helpstring__, helparg__)                           \
 373   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 374              #default_value__, helpstring__, helparg__, false,           \
 375              uint64_t, uint64_t, options::parse_uint64)
 376
 377 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
 378                       helpstring__, helparg__)                           \
 379   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 380              #default_value__, helpstring__, helparg__, false,           \
 381              double, double, options::parse_double)
 382
 383 #define DEFINE_percent(varname__, dashes__, shortname__, default_value__, \
 384                        helpstring__, helparg__)                           \
 385   DEFINE_var(varname__, dashes__, shortname__, default_value__ / 100.0,   \
 386              #default_value__, helpstring__, helparg__, false,            \
 387              double, double, options::parse_percent)
 388
 389 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
 390                       helpstring__, helparg__)                           \
 391   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 392              default_value__, helpstring__, helparg__, false,            \
 393              const char*, const char*, options::parse_string)
 394
 395 // This is like DEFINE_string, but we convert each occurrence to a
 396 // Search_directory and store it in a vector.  Thus we also have the
 397 // add_to_VARNAME() method, to append to the vector.
 398 #define DEFINE_dirlist(varname__, dashes__, shortname__,                  \
 399                            helpstring__, helparg__)                       \
 400   DEFINE_var(varname__, dashes__, shortname__, ,                          \
 401              "", helpstring__, helparg__, false, options::Dir_list,       \
 402              const options::Dir_list&, options::parse_dirlist)            \
 403   void                                                                    \
 404   add_to_##varname__(const char* new_value)                               \
 405   { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
 406   void                                                                    \
 407   add_search_directory_to_##varname__(const Search_directory& dir)        \
 408   { this->varname__##_.value.push_back(dir); }
 409
 410 // This is like DEFINE_string, but we store a set of strings.
 411 #define DEFINE_set(varname__, dashes__, shortname__,                      \
 412                    helpstring__, helparg__)                               \
 413   DEFINE_var(varname__, dashes__, shortname__, ,                          \
 414              "", helpstring__, helparg__, false, options::String_set,     \
 415              const options::String_set&, options::parse_set)              \
 416  public:                                                                  \
 417   bool                                                                    \
 418   any_##varname__() const                                                 \
 419   { return !this->varname__##_.value.empty(); }                           \
 420                                                                           \
 421   bool                                                                    \
 422   is_##varname__(const char* symbol) const                                \
 423   {                                                                       \
 424     return (!this->varname__##_.value.empty()                             \
 425             && (this->varname__##_.value.find(std::string(symbol))        \
 426                 != this->varname__##_.value.end()));                      \
 427   }                                                                       \
 428                                                                           \
 429   options::String_set::const_iterator                                     \
 430   varname__##_begin() const                                               \
 431   { return this->varname__##_.value.begin(); }                            \
 432                                                                           \
 433   options::String_set::const_iterator                                     \
 434   varname__##_end() const                                                 \
 435   { return this->varname__##_.value.end(); }
 436
 437 // When you have a list of possible values (expressed as string)
 438 // After helparg__ should come an initializer list, like
 439 //   {"foo", "bar", "baz"}
 440 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__,   \
 441                     helpstring__, helparg__, ...)                        \
 442   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 443              default_value__, helpstring__, helparg__, false,            \
 444              const char*, const char*, parse_choices_##varname__)        \
 445  private:                                                                \
 446   static void parse_choices_##varname__(const char* option_name,         \
 447                                         const char* arg,                 \
 448                                         const char** retval) {           \
 449     const char* choices[] = __VA_ARGS__;                                 \
 450     options::parse_choices(option_name, arg, retval,                     \
 451                            choices, sizeof(choices) / sizeof(*choices)); \
 452   }
 453
 454 // This is like DEFINE_bool, but VARNAME is the name of a different
 455 // option.  This option becomes an alias for that one.  INVERT is true
 456 // if this option is an inversion of the other one.
 457 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__,   \
 458                           helpstring__, no_helpstring__, invert__)      \
 459  private:                                                               \
 460   struct Struct_##option__ : public options::Struct_var                 \
 461   {                                                                     \
 462     Struct_##option__()                                                 \
 463       : option(#option__, dashes__, shortname__, "", helpstring__,      \
 464                NULL, false, this)                                       \
 465     { }                                                                 \
 466                                                                         \
 467     void                                                                \
 468     parse_to_value(const char*, const char*,                            \
 469                    Command_line*, General_options* options)             \
 470     {                                                                   \
 471       options->set_##varname__(!invert__);                              \
 472       options->set_user_set_##varname__();                              \
 473     }                                                                   \
 474                                                                         \
 475     options::One_option option;                                         \
 476   };                                                                    \
 477   Struct_##option__ option__##_;                                        \
 478                                                                         \
 479   struct Struct_no_##option__ : public options::Struct_var              \
 480   {                                                                     \
 481     Struct_no_##option__()                                              \
 482       : option((dashes__ == options::DASH_Z                             \
 483                 ? "no" #option__                                        \
 484                 : "no-" #option__),                                     \
 485                dashes__, '\0', "", no_helpstring__,                     \
 486                NULL, false, this)                                       \
 487     { }                                                                 \
 488                                                                         \
 489     void                                                                \
 490     parse_to_value(const char*, const char*,                            \
 491                    Command_line*, General_options* options)             \
 492     {                                                                   \
 493       options->set_##varname__(invert__);                               \
 494       options->set_user_set_##varname__();                              \
 495     }                                                                   \
 496                                                                         \
 497     options::One_option option;                                         \
 498   };                                                                    \
 499   Struct_no_##option__ no_##option__##_initializer_
 500
 501 // This is used for non-standard flags.  It defines no functions; it
 502 // just calls General_options::parse_VARNAME whenever the flag is
 503 // seen.  We declare parse_VARNAME as a static member of
 504 // General_options; you are responsible for defining it there.
 505 // helparg__ should be NULL iff this special-option is a boolean.
 506 #define DEFINE_special(varname__, dashes__, shortname__,                \
 507                        helpstring__, helparg__)                         \
 508  private:                                                               \
 509   void parse_##varname__(const char* option, const char* arg,           \
 510                          Command_line* inputs);                         \
 511   struct Struct_##varname__ : public options::Struct_special            \
 512   {                                                                     \
 513     Struct_##varname__()                                                \
 514       : options::Struct_special(#varname__, dashes__, shortname__,      \
 515                                 &General_options::parse_##varname__,    \
 516                                 helpstring__, helparg__)                \
 517     { }                                                                 \
 518   };                                                                    \
 519   Struct_##varname__ varname__##_initializer_
 520
 521 // An option that takes an optional string argument.  If the option is
 522 // used with no argument, the value will be the default, and
 523 // user_set_via_option will be true.
 524 #define DEFINE_optional_string(varname__, dashes__, shortname__,        \
 525                                default_value__,                         \
 526                                helpstring__, helparg__)                 \
 527   DEFINE_var(varname__, dashes__, shortname__, default_value__,         \
 528              default_value__, helpstring__, helparg__, true,            \
 529              const char*, const char*, options::parse_optional_string)
 530
 531 // A directory to search.  For each directory we record whether it is
 532 // in the sysroot.  We need to know this so that, if a linker script
 533 // is found within the sysroot, we will apply the sysroot to any files
 534 // named by that script.
 535
 536 class Search_directory
 537 {
 538  public:
 539   // We need a default constructor because we put this in a
 540   // std::vector.
 541   Search_directory()
 542     : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
 543   { }
 544
 545   // This is the usual constructor.
 546   Search_directory(const std::string& name, bool put_in_sysroot)
 547     : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
 548   {
 549     if (this->name_.empty())
 550       this->name_ = ".";
 551   }
 552
 553   // This is called if we have a sysroot.  The sysroot is prefixed to
 554   // any entries for which put_in_sysroot_ is true.  is_in_sysroot_ is
 555   // set to true for any enries which are in the sysroot (this will
 556   // naturally include any entries for which put_in_sysroot_ is true).
 557   // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
 558   // passing SYSROOT to lrealpath.
 559   void
 560   add_sysroot(const char* sysroot, const char* canonical_sysroot);
 561
 562   // Get the directory name.
 563   const std::string&
 564   name() const
 565   { return this->name_; }
 566
 567   // Return whether this directory is in the sysroot.
 568   bool
 569   is_in_sysroot() const
 570   { return this->is_in_sysroot_; }
 571
 572   // Return whether this is considered a system directory.
 573   bool
 574   is_system_directory() const
 575   { return this->put_in_sysroot_ || this->is_in_sysroot_; }
 576
 577  private:
 578   // The directory name.
 579   std::string name_;
 580   // True if the sysroot should be added as a prefix for this
 581   // directory (if there is a sysroot).  This is true for system
 582   // directories that we search by default.
 583   bool put_in_sysroot_;
 584   // True if this directory is in the sysroot (if there is a sysroot).
 585   // This is true if there is a sysroot and either 1) put_in_sysroot_
 586   // is true, or 2) the directory happens to be in the sysroot based
 587   // on a pathname comparison.
 588   bool is_in_sysroot_;
 589 };
 590
 591 class General_options
 592 {
 593  private:
 594   // NOTE: For every option that you add here, also consider if you
 595   // should add it to Position_dependent_options.
 596   DEFINE_special(help, options::TWO_DASHES, '\0',
 597                  N_("Report usage information"), NULL);
 598   DEFINE_special(version, options::TWO_DASHES, 'v',
 599                  N_("Report version information"), NULL);
 600   DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
 601                  N_("Report version and target information"), NULL);
 602
 603   // These options are sorted approximately so that for each letter in
 604   // the alphabet, we show the option whose shortname is that letter
 605   // (if any) and then every longname that starts with that letter (in
 606   // alphabetical order).  For both, lowercase sorts before uppercase.
 607   // The -z options come last.
 608
 609   DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
 610               N_("Not supported"),
 611               N_("Do not copy DT_NEEDED tags from shared libraries"));
 612
 613   DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
 614                     '\0', N_("Allow multiple definitions of symbols"),
 615                     N_("Do not allow multiple definitions"), false);
 616
 617   DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
 618               N_("Allow unresolved references in shared libraries"),
 619               N_("Do not allow unresolved references in shared libraries"));
 620
 621   DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
 622               N_("Only set DT_NEEDED for shared libraries if used"),
 623               N_("Always DT_NEEDED for shared libraries"));
 624
 625   DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
 626               N_("Ignored"), N_("[ignored]"),
 627               {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
 628
 629   // This should really be an "enum", but it's too easy for folks to
 630   // forget to update the list as they add new targets.  So we just
 631   // accept any string.  We'll fail later (when the string is parsed),
 632   // if the target isn't actually supported.
 633   DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
 634                 N_("Set input format"), ("[elf,binary]"));
 635
 636   DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
 637               N_("-l searches for shared libraries"), NULL);
 638   DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
 639                     N_("-l does not search for shared libraries"), NULL,
 640                     true);
 641   DEFINE_bool_alias(dy, Bdynamic, options::ONE_DASH, '\0',
 642                     N_("alias for -Bdynamic"), NULL, false);
 643   DEFINE_bool_alias(dn, Bdynamic, options::ONE_DASH, '\0',
 644                     N_("alias for -Bstatic"), NULL, true);
 645
 646   DEFINE_bool(Bgroup, options::ONE_DASH, '\0', false,
 647               N_("Use group name lookup rules for shared library"), NULL);
 648
 649   DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
 650               N_("Bind defined symbols locally"), NULL);
 651
 652   DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
 653               N_("Bind defined function symbols locally"), NULL);
 654
 655   DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
 656                          N_("Generate build ID note"),
 657                          N_("[=STYLE]"));
 658
 659   DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
 660               N_("Check segment addresses for overlaps (default)"),
 661               N_("Do not check segment addresses for overlaps"));
 662
 663 #ifdef HAVE_ZLIB_H
 664   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
 665               N_("Compress .debug_* sections in the output file"),
 666               ("[none,zlib]"),
 667               {"none", "zlib"});
 668 #else
 669   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
 670               N_("Compress .debug_* sections in the output file"),
 671               N_("[none]"),
 672               {"none"});
 673 #endif
 674
 675   DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
 676               N_("Not supported"),
 677               N_("Do not copy DT_NEEDED tags from shared libraries"));
 678
 679   DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
 680               N_("Output cross reference table"),
 681               N_("Do not output cross reference table"));
 682
 683   DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
 684               N_("Use DT_INIT_ARRAY for all constructors (default)"),
 685               N_("Handle constructors as directed by compiler"));
 686
 687   DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
 688               N_("Define common symbols"),
 689               N_("Do not define common symbols"));
 690   DEFINE_bool(dc, options::ONE_DASH, '\0', false,
 691               N_("Alias for -d"), NULL);
 692   DEFINE_bool(dp, options::ONE_DASH, '\0', false,
 693               N_("Alias for -d"), NULL);
 694
 695   DEFINE_string(debug, options::TWO_DASHES, '\0', "",
 696                 N_("Turn on debugging"),
 697                 N_("[all,files,script,task][,...]"));
 698
 699   DEFINE_special(defsym, options::TWO_DASHES, '\0',
 700                  N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
 701
 702   DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
 703                          N_("Demangle C++ symbols in log messages"),
 704                          N_("[=STYLE]"));
 705
 706   DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
 707               N_("Do not demangle C++ symbols in log messages"),
 708               NULL);
 709
 710   DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
 711               N_("Look for violations of the C++ One Definition Rule"),
 712               N_("Do not look for violations of the C++ One Definition Rule"));
 713
 714   DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
 715               N_("Delete all local symbols"), NULL);
 716   DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
 717               N_("Delete all temporary local symbols"), NULL);
 718
 719   DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
 720               N_("Add data symbols to dynamic symbols"), NULL);
 721
 722   DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
 723               N_("Add C++ operator new/delete to dynamic symbols"), NULL);
 724
 725   DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
 726               N_("Add C++ typeinfo to dynamic symbols"), NULL);
 727
 728   DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
 729                  N_("Read a list of dynamic symbols"), N_("FILE"));
 730
 731   DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
 732                 N_("Set program start address"), N_("ADDRESS"));
 733
 734   DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
 735                  N_("Exclude libraries from automatic export"),
 736                  N_(("lib,lib ...")));
 737
 738   DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
 739               N_("Export all dynamic symbols"),
 740               N_("Do not export all dynamic symbols (default)"));
 741
 742   DEFINE_special(EB, options::ONE_DASH, '\0',
 743                  N_("Link big-endian objects."), NULL);
 744
 745   DEFINE_special(EL, options::ONE_DASH, '\0',
 746                  N_("Link little-endian objects."), NULL);
 747
 748   DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
 749               N_("Create exception frame header"), NULL);
 750
 751   DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
 752               N_("(ARM only) Do not warn about objects with incompatible "
 753                  "enum sizes"));
 754
 755   DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
 756              N_("Auxiliary filter for shared object symbol table"),
 757              N_("SHLIB"));
 758
 759   DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
 760                 N_("Filter for shared object symbol table"),
 761                 N_("SHLIB"));
 762
 763   DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
 764               N_("Treat warnings as errors"),
 765               N_("Do not treat warnings as errors"));
 766
 767   DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
 768                 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
 769
 770   DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
 771               N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
 772               N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
 773
 774   DEFINE_bool(fix_arm1176, options::TWO_DASHES, '\0', true,
 775               N_("(ARM only) Fix binaries for ARM1176 erratum."),
 776               N_("(ARM only) Do not fix binaries for ARM1176 erratum."));
 777
 778   DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
 779               N_("(ARM only) Merge exidx entries in debuginfo."),
 780               N_("(ARM only) Do not merge exidx entries in debuginfo."));
 781
 782   DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
 783                  N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
 784                  NULL);
 785
 786   DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
 787                  N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
 788                     "veneer"),
 789                  NULL);
 790
 791   DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
 792               N_("Ignored"), NULL);
 793
 794   DEFINE_bool(gnu_unique, options::TWO_DASHES, '\0', true,
 795               N_("Enable STB_GNU_UNIQUE symbol binding (default)"),
 796               N_("Disable STB_GNU_UNIQUE symbol binding"));
 797
 798   DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
 799                 N_("Set shared library name"), N_("FILENAME"));
 800
 801   DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
 802                 N_("Min fraction of empty buckets in dynamic hash"),
 803                 N_("FRACTION"));
 804
 805   DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
 806               N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
 807               {"sysv", "gnu", "both"});
 808
 809   DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
 810                 N_("Set dynamic linker path"), N_("PROGRAM"));
 811
 812   DEFINE_special(incremental, options::TWO_DASHES, '\0',
 813                  N_("Do an incremental link if possible; "
 814                     "otherwise, do a full link and prepare output "
 815                     "for incremental linking"), NULL);
 816
 817   DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
 818                  N_("Do a full link (default)"), NULL);
 819
 820   DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
 821                  N_("Do a full link and "
 822                     "prepare output for incremental linking"), NULL);
 823
 824   DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
 825                  N_("Do an incremental link; exit if not possible"), NULL);
 826
 827   DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
 828                 N_("Set base file for incremental linking"
 829                    " (default is output file)"),
 830                 N_("FILE"));
 831
 832   DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
 833                  N_("Assume files changed"), NULL);
 834
 835   DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
 836                  N_("Assume files didn't change"), NULL);
 837
 838   DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
 839                  N_("Use timestamps to check files (default)"), NULL);
 840
 841   DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
 842                  N_("Assume startup files unchanged "
 843                     "(files preceding this option)"), NULL);
 844
 845   DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
 846                  N_("Amount of extra space to allocate for patches"),
 847                  N_("PERCENT"));
 848
 849   DEFINE_string(init, options::ONE_DASH, '\0', "_init",
 850                 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
 851
 852   DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
 853                  N_("Read only symbol values from FILE"), N_("FILE"));
 854
 855   DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
 856               sizeof(void*) >= 8,
 857               N_("Map whole files to memory (default on 64-bit hosts)"),
 858               N_("Map relevant file parts to memory (default on 32-bit "
 859                  "hosts)"));
 860   DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
 861               N_("Keep files mapped across passes (default)"),
 862               N_("Release mapped files after each pass"));
 863
 864   DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
 865               N_("Generate unwind information for PLT (default)"),
 866               N_("Do not generate unwind information for PLT"));
 867
 868   DEFINE_special(library, options::TWO_DASHES, 'l',
 869                  N_("Search for library LIBNAME"), N_("LIBNAME"));
 870
 871   DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
 872                  N_("Add directory to search path"), N_("DIR"));
 873
 874   DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
 875               N_(" Only search directories specified on the command line."),
 876               NULL);
 877
 878   DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
 879               N_(" Put read-only non-executable sections in their own segment"),
 880               NULL);
 881
 882   DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
 883                 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
 884
 885   DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
 886               N_("Write map file on standard output"), NULL);
 887   DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
 888                 N_("MAPFILENAME"));
 889
 890   DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
 891               N_("Do not page align data"), NULL);
 892   DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
 893               N_("Do not page align data, do not make text readonly"),
 894               N_("Page align data, make text readonly"));
 895
 896   DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
 897                 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
 898                 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
 899
 900   DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
 901               N_("Create an output file even if errors occur"), NULL);
 902
 903   DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
 904                     N_("Report undefined symbols (even with --shared)"),
 905                     NULL, false);
 906
 907   DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
 908                 N_("Set output file name"), N_("FILE"));
 909
 910   DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
 911               N_("Optimize output file size"), N_("LEVEL"));
 912
 913   DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
 914                 N_("Set output format"), N_("[binary]"));
 915
 916   DEFINE_bool(p, options::ONE_DASH, '\0', false,
 917               N_("(ARM only) Ignore for backward compatibility"), NULL);
 918
 919   DEFINE_bool(pie, options::ONE_DASH, '\0', false,
 920               N_("Create a position independent executable"), NULL);
 921   DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
 922                     N_("Create a position independent executable"), NULL,
 923                     false);
 924
 925   DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
 926               NULL, N_("(ARM only) Ignore for backward compatibility"));
 927
 928 #ifdef ENABLE_PLUGINS
 929   DEFINE_special(plugin, options::TWO_DASHES, '\0',
 930                  N_("Load a plugin library"), N_("PLUGIN"));
 931   DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
 932                  N_("Pass an option to the plugin"), N_("OPTION"));
 933 #endif
 934
 935   DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
 936               N_("Preread archive symbols when multi-threaded"), NULL);
 937
 938   DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
 939               N_("Print default output format"), NULL);
 940
 941   DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
 942                 N_("Print symbols defined and used for each input"),
 943                 N_("FILENAME"));
 944
 945   DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
 946               N_("Ignored for SVR4 compatibility"), NULL);
 947
 948   DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
 949               N_("Generate relocations in output"), NULL);
 950
 951   DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
 952               N_("Generate relocatable output"), NULL);
 953   DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
 954                     N_("Synonym for -r"), NULL, false);
 955
 956   DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
 957               N_("Relax branches on certain targets"), NULL);
 958
 959   DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
 960                 N_("keep only symbols listed in this file"), N_("FILE"));
 961
 962   // -R really means -rpath, but can mean --just-symbols for
 963   // compatibility with GNU ld.  -rpath is always -rpath, so we list
 964   // it separately.
 965   DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
 966                  N_("Add DIR to runtime search path"), N_("DIR"));
 967
 968   DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
 969                  N_("Add DIR to runtime search path"), N_("DIR"));
 970
 971   DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
 972                  N_("Add DIR to link time shared library search path"),
 973                  N_("DIR"));
 974
 975   DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
 976                 N_("Layout sections in the order specified."),
 977                 N_("FILENAME"));
 978
 979   DEFINE_special(section_start, options::TWO_DASHES, '\0',
 980                  N_("Set address of section"), N_("SECTION=ADDRESS"));
 981
 982   DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
 983                          N_("Sort common symbols by alignment"),
 984                          N_("[={ascending,descending}]"));
 985
 986   DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
 987               N_("Dynamic tag slots to reserve (default 5)"),
 988               N_("COUNT"));
 989
 990   DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
 991               N_("Strip all symbols"), NULL);
 992   DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
 993               N_("Strip debugging information"), NULL);
 994   DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
 995               N_("Emit only debug line number information"), NULL);
 996   DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
 997               N_("Strip debug symbols that are unused by gdb "
 998                  "(at least versions <= 6.7)"), NULL);
 999   DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
1000               N_("Strip LTO intermediate code sections"), NULL);
1001
1002   DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
1003              N_("(ARM only) The maximum distance from instructions in a group "
1004                 "of sections to their stubs.  Negative values mean stubs "
1005                 "are always after the group. 1 means using default size.\n"),
1006              N_("SIZE"));
1007
1008   DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
1009               N_("Use less memory and more disk I/O "
1010                  "(included only for compatibility with GNU ld)"), NULL);
1011
1012   DEFINE_bool(shared, options::ONE_DASH, 'G', false,
1013               N_("Generate shared library"), NULL);
1014
1015   DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
1016               N_("Generate shared library"), NULL);
1017
1018   DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
1019               N_("Stack size when -fsplit-stack function calls non-split"),
1020               N_("SIZE"));
1021
1022   // This is not actually special in any way, but I need to give it
1023   // a non-standard accessor-function name because 'static' is a keyword.
1024   DEFINE_special(static, options::ONE_DASH, '\0',
1025                  N_("Do not link against shared libraries"), NULL);
1026
1027   DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
1028               N_("Identical Code Folding. "
1029                  "\'--icf=safe\' Folds ctors, dtors and functions whose"
1030                  " pointers are definitely not taken."),
1031               ("[none,all,safe]"),
1032               {"none", "all", "safe"});
1033
1034   DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
1035               N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
1036
1037   DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
1038               N_("List folded identical sections on stderr"),
1039               N_("Do not list folded identical sections"));
1040
1041   DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
1042              N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1043
1044   DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
1045               N_("Remove unused sections"),
1046               N_("Don't remove unused sections (default)"));
1047
1048   DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
1049               N_("List removed unused sections on stderr"),
1050               N_("Do not list removed unused sections"));
1051
1052   DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
1053               N_("Print resource usage statistics"), NULL);
1054
1055   DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
1056                 N_("Set target system root directory"), N_("DIR"));
1057
1058   DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1059               N_("Print the name of each input file"), NULL);
1060
1061   DEFINE_special(script, options::TWO_DASHES, 'T',
1062                  N_("Read linker script"), N_("FILE"));
1063
1064   DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
1065               N_("Run the linker multi-threaded"),
1066               N_("Do not run the linker multi-threaded"));
1067   DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
1068               N_("Number of threads to use"), N_("COUNT"));
1069   DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
1070               N_("Number of threads to use in initial pass"), N_("COUNT"));
1071   DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
1072               N_("Number of threads to use in middle pass"), N_("COUNT"));
1073   DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
1074               N_("Number of threads to use in final pass"), N_("COUNT"));
1075
1076   DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1077                 N_("Set the address of the bss segment"), N_("ADDRESS"));
1078   DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1079                 N_("Set the address of the data segment"), N_("ADDRESS"));
1080   DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1081                 N_("Set the address of the text segment"), N_("ADDRESS"));
1082
1083   DEFINE_set(undefined, options::TWO_DASHES, 'u',
1084              N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1085
1086   DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1087               N_("How to handle unresolved symbols"),
1088               ("ignore-all,report-all,ignore-in-object-files,"
1089                "ignore-in-shared-libs"),
1090               {"ignore-all", "report-all", "ignore-in-object-files",
1091                   "ignore-in-shared-libs"});
1092
1093   DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1094               N_("Synonym for --debug=files"), NULL);
1095
1096   DEFINE_special(version_script, options::TWO_DASHES, '\0',
1097                  N_("Read version script"), N_("FILE"));
1098
1099   DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1100               N_("Warn about duplicate common symbols"),
1101               N_("Do not warn about duplicate common symbols (default)"));
1102
1103   DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1104               N_("Ignored"), N_("Ignored"));
1105
1106   DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1107               N_("Warn if the stack is executable"),
1108               N_("Do not warn if the stack is executable (default)"));
1109
1110   DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1111               NULL, N_("Don't warn about mismatched input files"));
1112
1113   DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1114               N_("Ignored"), NULL);
1115
1116   DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1117               N_("Warn when skipping an incompatible library"),
1118               N_("Don't warn when skipping an incompatible library"));
1119
1120   DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1121               N_("Warn if text segment is not shareable"),
1122               N_("Do not warn if text segment is not shareable (default)"));
1123
1124   DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1125               N_("Report unresolved symbols as warnings"),
1126               NULL);
1127   DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1128                     options::TWO_DASHES, '\0',
1129                     N_("Report unresolved symbols as errors"),
1130                     NULL, true);
1131
1132   DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1133               N_("(ARM only) Do not warn about objects with incompatible "
1134                  "wchar_t sizes"));
1135
1136   DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1137               N_("Include all archive contents"),
1138               N_("Include only needed archive contents"));
1139
1140   DEFINE_set(wrap, options::TWO_DASHES, '\0',
1141              N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1142
1143   DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1144              N_("Trace references to symbol"), N_("SYMBOL"));
1145
1146   DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1147               N_("Allow unused version in script (default)"),
1148               N_("Do not allow unused version in script"));
1149
1150   DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1151                 N_("Default search path for Solaris compatibility"),
1152                 N_("PATH"));
1153
1154   DEFINE_special(start_group, options::TWO_DASHES, '(',
1155                  N_("Start a library search group"), NULL);
1156   DEFINE_special(end_group, options::TWO_DASHES, ')',
1157                  N_("End a library search group"), NULL);
1158
1159
1160   DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1161                  N_("Start a library"), NULL);
1162   DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1163                  N_("End a library "), NULL);
1164
1165   // The -z options.
1166
1167   DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1168               N_("Sort dynamic relocs"),
1169               N_("Do not sort dynamic relocs"));
1170   DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1171                 N_("Set common page size to SIZE"), N_("SIZE"));
1172   DEFINE_bool(defs, options::DASH_Z, '\0', false,
1173               N_("Report undefined symbols (even with --shared)"),
1174               NULL);
1175   DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1176               N_("Mark output as requiring executable stack"), NULL);
1177   DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1178               N_("Mark DSO to be initialized first at runtime"),
1179               NULL);
1180   DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1181               N_("Mark object to interpose all DSOs but executable"),
1182               NULL);
1183   DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1184                     N_("Mark object for lazy runtime binding (default)"),
1185                     NULL, true);
1186   DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1187               N_("Mark object requiring immediate process"),
1188               NULL);
1189   DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1190                 N_("Set maximum page size to SIZE"), N_("SIZE"));
1191   DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1192               N_("Allow multiple definitions of symbols"),
1193               NULL);
1194   // copyreloc is here in the list because there is only -z
1195   // nocopyreloc, not -z copyreloc.
1196   DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1197               NULL,
1198               N_("Do not create copy relocs"));
1199   DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1200               N_("Mark object not to use default search paths"),
1201               NULL);
1202   DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1203               N_("Mark DSO non-deletable at runtime"),
1204               NULL);
1205   DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1206               N_("Mark DSO not available to dlopen"),
1207               NULL);
1208   DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1209               N_("Mark DSO not available to dldump"),
1210               NULL);
1211   DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1212               N_("Mark output as not requiring executable stack"), NULL);
1213   DEFINE_bool(now, options::DASH_Z, '\0', false,
1214               N_("Mark object for immediate function binding"),
1215               NULL);
1216   DEFINE_bool(origin, options::DASH_Z, '\0', false,
1217               N_("Mark DSO to indicate that needs immediate $ORIGIN "
1218                  "processing at runtime"), NULL);
1219   DEFINE_bool(relro, options::DASH_Z, '\0', false,
1220               N_("Where possible mark variables read-only after relocation"),
1221               N_("Don't mark variables read-only after relocation"));
1222   DEFINE_bool(text, options::DASH_Z, '\0', false,
1223               N_("Do not permit relocations in read-only segments"),
1224               N_("Permit relocations in read-only segments (default)"));
1225   DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1226                     N_("Permit relocations in read-only segments (default)"),
1227                     NULL, true);
1228
1229  public:
1230   typedef options::Dir_list Dir_list;
1231
1232   General_options();
1233
1234   // Does post-processing on flags, making sure they all have
1235   // non-conflicting values.  Also converts some flags from their
1236   // "standard" types (string, etc), to another type (enum, DirList),
1237   // which can be accessed via a separate method.  Dies if it notices
1238   // any problems.
1239   void finalize();
1240
1241   // True if we printed the version information.
1242   bool
1243   printed_version() const
1244   { return this->printed_version_; }
1245
1246   // The macro defines output() (based on --output), but that's a
1247   // generic name.  Provide this alternative name, which is clearer.
1248   const char*
1249   output_file_name() const
1250   { return this->output(); }
1251
1252   // This is not defined via a flag, but combines flags to say whether
1253   // the output is position-independent or not.
1254   bool
1255   output_is_position_independent() const
1256   { return this->shared() || this->pie(); }
1257
1258   // Return true if the output is something that can be exec()ed, such
1259   // as a static executable, or a position-dependent or
1260   // position-independent executable, but not a dynamic library or an
1261   // object file.
1262   bool
1263   output_is_executable() const
1264   { return !this->shared() && !this->relocatable(); }
1265
1266   // This would normally be static(), and defined automatically, but
1267   // since static is a keyword, we need to come up with our own name.
1268   bool
1269   is_static() const
1270   { return static_; }
1271
1272   // In addition to getting the input and output formats as a string
1273   // (via format() and oformat()), we also give access as an enum.
1274   enum Object_format
1275   {
1276     // Ordinary ELF.
1277     OBJECT_FORMAT_ELF,
1278     // Straight binary format.
1279     OBJECT_FORMAT_BINARY
1280   };
1281
1282   // Convert a string to an Object_format.  Gives an error if the
1283   // string is not recognized.
1284   static Object_format
1285   string_to_object_format(const char* arg);
1286
1287   // Note: these functions are not very fast.
1288   Object_format format_enum() const;
1289   Object_format oformat_enum() const;
1290
1291   // Return whether FILENAME is in a system directory.
1292   bool
1293   is_in_system_directory(const std::string& name) const;
1294
1295   // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1296   bool
1297   should_retain_symbol(const char* symbol_name) const
1298     {
1299       if (symbols_to_retain_.empty())    // means flag wasn't specified
1300         return true;
1301       return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1302     }
1303
1304   // These are the best way to get access to the execstack state,
1305   // not execstack() and noexecstack() which are hard to use properly.
1306   bool
1307   is_execstack_set() const
1308   { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1309
1310   bool
1311   is_stack_executable() const
1312   { return this->execstack_status_ == EXECSTACK_YES; }
1313
1314   bool
1315   icf_enabled() const
1316   { return this->icf_status_ != ICF_NONE; }
1317
1318   bool
1319   icf_safe_folding() const
1320   { return this->icf_status_ == ICF_SAFE; }
1321
1322   // The --demangle option takes an optional string, and there is also
1323   // a --no-demangle option.  This is the best way to decide whether
1324   // to demangle or not.
1325   bool
1326   do_demangle() const
1327   { return this->do_demangle_; }
1328
1329   // Returns TRUE if any plugin libraries have been loaded.
1330   bool
1331   has_plugins() const
1332   { return this->plugins_ != NULL; }
1333
1334   // Return a pointer to the plugin manager.
1335   Plugin_manager*
1336   plugins() const
1337   { return this->plugins_; }
1338
1339   // True iff SYMBOL was found in the file specified by dynamic-list.
1340   bool
1341   in_dynamic_list(const char* symbol) const
1342   { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1343
1344   // Finalize the dynamic list.
1345   void
1346   finalize_dynamic_list()
1347   { this->dynamic_list_.version_script_info()->finalize(); }
1348
1349   // The mode selected by the --incremental options.
1350   enum Incremental_mode
1351   {
1352     // No incremental linking (--no-incremental).
1353     INCREMENTAL_OFF,
1354     // Incremental update only (--incremental-update).
1355     INCREMENTAL_UPDATE,
1356     // Force a full link, but prepare for subsequent incremental link
1357     // (--incremental-full).
1358     INCREMENTAL_FULL,
1359     // Incremental update if possible, fallback to full link  (--incremental).
1360     INCREMENTAL_AUTO
1361   };
1362
1363   // The incremental linking mode.
1364   Incremental_mode
1365   incremental_mode() const
1366   { return this->incremental_mode_; }
1367
1368   // The disposition given by the --incremental-changed,
1369   // --incremental-unchanged or --incremental-unknown option.  The
1370   // value may change as we proceed parsing the command line flags.
1371   Incremental_disposition
1372   incremental_disposition() const
1373   { return this->incremental_disposition_; }
1374
1375   // The disposition to use for startup files (those that precede the
1376   // first --incremental-changed, etc. option).
1377   Incremental_disposition
1378   incremental_startup_disposition() const
1379   { return this->incremental_startup_disposition_; }
1380
1381   // Return true if S is the name of a library excluded from automatic
1382   // symbol export.
1383   bool
1384   check_excluded_libs(const std::string &s) const;
1385
1386   // If an explicit start address was given for section SECNAME with
1387   // the --section-start option, return true and set *PADDR to the
1388   // address.  Otherwise return false.
1389   bool
1390   section_start(const char* secname, uint64_t* paddr) const;
1391
1392   // Return whether any --section-start option was used.
1393   bool
1394   any_section_start() const
1395   { return !this->section_starts_.empty(); }
1396
1397   enum Fix_v4bx
1398   {
1399     // Leave original instruction.
1400     FIX_V4BX_NONE,
1401     // Replace instruction.
1402     FIX_V4BX_REPLACE,
1403     // Generate an interworking veneer.
1404     FIX_V4BX_INTERWORKING
1405   };
1406
1407   Fix_v4bx
1408   fix_v4bx() const
1409   { return (this->fix_v4bx_); }
1410
1411   enum Endianness
1412   {
1413     ENDIANNESS_NOT_SET,
1414     ENDIANNESS_BIG,
1415     ENDIANNESS_LITTLE
1416   };
1417
1418   Endianness
1419   endianness() const
1420   { return this->endianness_; }
1421
1422  private:
1423   // Don't copy this structure.
1424   General_options(const General_options&);
1425   General_options& operator=(const General_options&);
1426
1427   // Whether to mark the stack as executable.
1428   enum Execstack
1429   {
1430     // Not set on command line.
1431     EXECSTACK_FROM_INPUT,
1432     // Mark the stack as executable (-z execstack).
1433     EXECSTACK_YES,
1434     // Mark the stack as not executable (-z noexecstack).
1435     EXECSTACK_NO
1436   };
1437
1438   enum Icf_status
1439   {
1440     // Do not fold any functions (Default or --icf=none).
1441     ICF_NONE,
1442     // All functions are candidates for folding. (--icf=all).
1443     ICF_ALL,
1444     // Only ctors and dtors are candidates for folding. (--icf=safe).
1445     ICF_SAFE
1446   };
1447
1448   void
1449   set_icf_status(Icf_status value)
1450   { this->icf_status_ = value; }
1451
1452   void
1453   set_execstack_status(Execstack value)
1454   { this->execstack_status_ = value; }
1455
1456   void
1457   set_do_demangle(bool value)
1458   { this->do_demangle_ = value; }
1459
1460   void
1461   set_static(bool value)
1462   { static_ = value; }
1463
1464   // These are called by finalize() to set up the search-path correctly.
1465   void
1466   add_to_library_path_with_sysroot(const std::string& arg)
1467   { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1468
1469   // Apply any sysroot to the directory lists.
1470   void
1471   add_sysroot();
1472
1473   // Add a plugin and its arguments to the list of plugins.
1474   void
1475   add_plugin(const char* filename);
1476
1477   // Add a plugin option.
1478   void
1479   add_plugin_option(const char* opt);
1480
1481   // Whether we printed version information.
1482   bool printed_version_;
1483   // Whether to mark the stack as executable.
1484   Execstack execstack_status_;
1485   // Whether to do code folding.
1486   Icf_status icf_status_;
1487   // Whether to do a static link.
1488   bool static_;
1489   // Whether to do demangling.
1490   bool do_demangle_;
1491   // List of plugin libraries.
1492   Plugin_manager* plugins_;
1493   // The parsed output of --dynamic-list files.  For convenience in
1494   // script.cc, we store this as a Script_options object, even though
1495   // we only use a single Version_tree from it.
1496   Script_options dynamic_list_;
1497   // The incremental linking mode.
1498   Incremental_mode incremental_mode_;
1499   // The disposition given by the --incremental-changed,
1500   // --incremental-unchanged or --incremental-unknown option.  The
1501   // value may change as we proceed parsing the command line flags.
1502   Incremental_disposition incremental_disposition_;
1503   // The disposition to use for startup files (those marked
1504   // INCREMENTAL_STARTUP).
1505   Incremental_disposition incremental_startup_disposition_;
1506   // Whether we have seen one of the options that require incremental
1507   // build (--incremental-changed, --incremental-unchanged,
1508   // --incremental-unknown, or --incremental-startup-unchanged).
1509   bool implicit_incremental_;
1510   // Libraries excluded from automatic export, via --exclude-libs.
1511   Unordered_set<std::string> excluded_libs_;
1512   // List of symbol-names to keep, via -retain-symbol-info.
1513   Unordered_set<std::string> symbols_to_retain_;
1514   // Map from section name to address from --section-start.
1515   std::map<std::string, uint64_t> section_starts_;
1516   // Whether to process armv4 bx instruction relocation.
1517   Fix_v4bx fix_v4bx_;
1518   // Endianness.
1519   Endianness endianness_;
1520 };
1521
1522 // The position-dependent options.  We use this to store the state of
1523 // the commandline at a particular point in parsing for later
1524 // reference.  For instance, if we see "ld --whole-archive foo.a
1525 // --no-whole-archive," we want to store the whole-archive option with
1526 // foo.a, so when the time comes to parse foo.a we know we should do
1527 // it in whole-archive mode.  We could store all of General_options,
1528 // but that's big, so we just pick the subset of flags that actually
1529 // change in a position-dependent way.
1530
1531 #define DEFINE_posdep(varname__, type__)        \
1532  public:                                        \
1533   type__                                        \
1534   varname__() const                             \
1535   { return this->varname__##_; }                \
1536                                                 \
1537   void                                          \
1538   set_##varname__(type__ value)                 \
1539   { this->varname__##_ = value; }               \
1540  private:                                       \
1541   type__ varname__##_
1542
1543 class Position_dependent_options
1544 {
1545  public:
1546   Position_dependent_options(const General_options& options
1547                              = Position_dependent_options::default_options_)
1548   { copy_from_options(options); }
1549
1550   void copy_from_options(const General_options& options)
1551   {
1552     this->set_as_needed(options.as_needed());
1553     this->set_Bdynamic(options.Bdynamic());
1554     this->set_format_enum(options.format_enum());
1555     this->set_whole_archive(options.whole_archive());
1556     this->set_incremental_disposition(options.incremental_disposition());
1557   }
1558
1559   DEFINE_posdep(as_needed, bool);
1560   DEFINE_posdep(Bdynamic, bool);
1561   DEFINE_posdep(format_enum, General_options::Object_format);
1562   DEFINE_posdep(whole_archive, bool);
1563   DEFINE_posdep(incremental_disposition, Incremental_disposition);
1564
1565  private:
1566   // This is a General_options with everything set to its default
1567   // value.  A Position_dependent_options created with no argument
1568   // will take its values from here.
1569   static General_options default_options_;
1570 };
1571
1572
1573 // A single file or library argument from the command line.
1574
1575 class Input_file_argument
1576 {
1577  public:
1578   enum Input_file_type
1579   {
1580     // A regular file, name used as-is, not searched.
1581     INPUT_FILE_TYPE_FILE,
1582     // A library name.  When used, "lib" will be prepended and ".so" or
1583     // ".a" appended to make a filename, and that filename will be searched
1584     // for using the -L paths.
1585     INPUT_FILE_TYPE_LIBRARY,
1586     // A regular file, name used as-is, but searched using the -L paths.
1587     INPUT_FILE_TYPE_SEARCHED_FILE
1588   };
1589
1590   // name: file name or library name
1591   // type: the type of this input file.
1592   // extra_search_path: an extra directory to look for the file, prior
1593   //         to checking the normal library search path.  If this is "",
1594   //         then no extra directory is added.
1595   // just_symbols: whether this file only defines symbols.
1596   // options: The position dependent options at this point in the
1597   //         command line, such as --whole-archive.
1598   Input_file_argument()
1599     : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1600       just_symbols_(false), options_(), arg_serial_(0)
1601   { }
1602
1603   Input_file_argument(const char* name, Input_file_type type,
1604                       const char* extra_search_path,
1605                       bool just_symbols,
1606                       const Position_dependent_options& options)
1607     : name_(name), type_(type), extra_search_path_(extra_search_path),
1608       just_symbols_(just_symbols), options_(options), arg_serial_(0)
1609   { }
1610
1611   // You can also pass in a General_options instance instead of a
1612   // Position_dependent_options.  In that case, we extract the
1613   // position-independent vars from the General_options and only store
1614   // those.
1615   Input_file_argument(const char* name, Input_file_type type,
1616                       const char* extra_search_path,
1617                       bool just_symbols,
1618                       const General_options& options)
1619     : name_(name), type_(type), extra_search_path_(extra_search_path),
1620       just_symbols_(just_symbols), options_(options), arg_serial_(0)
1621   { }
1622
1623   const char*
1624   name() const
1625   { return this->name_.c_str(); }
1626
1627   const Position_dependent_options&
1628   options() const
1629   { return this->options_; }
1630
1631   bool
1632   is_lib() const
1633   { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1634
1635   bool
1636   is_searched_file() const
1637   { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1638
1639   const char*
1640   extra_search_path() const
1641   {
1642     return (this->extra_search_path_.empty()
1643             ? NULL
1644             : this->extra_search_path_.c_str());
1645   }
1646
1647   // Return whether we should only read symbols from this file.
1648   bool
1649   just_symbols() const
1650   { return this->just_symbols_; }
1651
1652   // Return whether this file may require a search using the -L
1653   // options.
1654   bool
1655   may_need_search() const
1656   {
1657     return (this->is_lib()
1658             || this->is_searched_file()
1659             || !this->extra_search_path_.empty());
1660   }
1661
1662   // Set the serial number for this argument.
1663   void
1664   set_arg_serial(unsigned int arg_serial)
1665   { this->arg_serial_ = arg_serial; }
1666
1667   // Get the serial number.
1668   unsigned int
1669   arg_serial() const
1670   { return this->arg_serial_; }
1671
1672  private:
1673   // We use std::string, not const char*, here for convenience when
1674   // using script files, so that we do not have to preserve the string
1675   // in that case.
1676   std::string name_;
1677   Input_file_type type_;
1678   std::string extra_search_path_;
1679   bool just_symbols_;
1680   Position_dependent_options options_;
1681   // A unique index for this file argument in the argument list.
1682   unsigned int arg_serial_;
1683 };
1684
1685 // A file or library, or a group, from the command line.
1686
1687 class Input_argument
1688 {
1689  public:
1690   // Create a file or library argument.
1691   explicit Input_argument(Input_file_argument file)
1692     : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
1693   { }
1694
1695   // Create a group argument.
1696   explicit Input_argument(Input_file_group* group)
1697     : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
1698   { }
1699
1700   // Create a lib argument.
1701   explicit Input_argument(Input_file_lib* lib)
1702     : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
1703   { }
1704
1705   // Return whether this is a file.
1706   bool
1707   is_file() const
1708   { return this->is_file_; }
1709
1710   // Return whether this is a group.
1711   bool
1712   is_group() const
1713   { return !this->is_file_ && this->lib_ == NULL; }
1714
1715   // Return whether this is a lib.
1716   bool
1717   is_lib() const
1718   { return this->lib_ != NULL; }
1719
1720   // Return the information about the file.
1721   const Input_file_argument&
1722   file() const
1723   {
1724     gold_assert(this->is_file_);
1725     return this->file_;
1726   }
1727
1728   // Return the information about the group.
1729   const Input_file_group*
1730   group() const
1731   {
1732     gold_assert(!this->is_file_);
1733     return this->group_;
1734   }
1735
1736   Input_file_group*
1737   group()
1738   {
1739     gold_assert(!this->is_file_);
1740     return this->group_;
1741   }
1742
1743   // Return the information about the lib.
1744   const Input_file_lib*
1745   lib() const
1746   {
1747     gold_assert(!this->is_file_);
1748     gold_assert(this->lib_);
1749     return this->lib_;
1750   }
1751
1752   Input_file_lib*
1753   lib()
1754   {
1755     gold_assert(!this->is_file_);
1756     gold_assert(this->lib_);
1757     return this->lib_;
1758   }
1759
1760   // If a script generated this argument, store a pointer to the script info.
1761   // Currently used only for recording incremental link information.
1762   void
1763   set_script_info(Script_info* info)
1764   { this->script_info_ = info; }
1765
1766   Script_info*
1767   script_info() const
1768   { return this->script_info_; }
1769
1770  private:
1771   bool is_file_;
1772   Input_file_argument file_;
1773   Input_file_group* group_;
1774   Input_file_lib* lib_;
1775   Script_info* script_info_;
1776 };
1777
1778 typedef std::vector<Input_argument> Input_argument_list;
1779
1780 // A group from the command line.  This is a set of arguments within
1781 // --start-group ... --end-group.
1782
1783 class Input_file_group
1784 {
1785  public:
1786   typedef Input_argument_list::const_iterator const_iterator;
1787
1788   Input_file_group()
1789     : files_()
1790   { }
1791
1792   // Add a file to the end of the group.
1793   Input_argument&
1794   add_file(const Input_file_argument& arg)
1795   {
1796     this->files_.push_back(Input_argument(arg));
1797     return this->files_.back();
1798   }
1799
1800   // Iterators to iterate over the group contents.
1801
1802   const_iterator
1803   begin() const
1804   { return this->files_.begin(); }
1805
1806   const_iterator
1807   end() const
1808   { return this->files_.end(); }
1809
1810  private:
1811   Input_argument_list files_;
1812 };
1813
1814 // A lib from the command line.  This is a set of arguments within
1815 // --start-lib ... --end-lib.
1816
1817 class Input_file_lib
1818 {
1819  public:
1820   typedef Input_argument_list::const_iterator const_iterator;
1821
1822   Input_file_lib(const Position_dependent_options& options)
1823     : files_(), options_(options)
1824   { }
1825
1826   // Add a file to the end of the lib.
1827   Input_argument&
1828   add_file(const Input_file_argument& arg)
1829   {
1830     this->files_.push_back(Input_argument(arg));
1831     return this->files_.back();
1832   }
1833
1834   const Position_dependent_options&
1835   options() const
1836   { return this->options_; }
1837
1838   // Iterators to iterate over the lib contents.
1839
1840   const_iterator
1841   begin() const
1842   { return this->files_.begin(); }
1843
1844   const_iterator
1845   end() const
1846   { return this->files_.end(); }
1847
1848   size_t
1849   size() const
1850   { return this->files_.size(); }
1851
1852  private:
1853   Input_argument_list files_;
1854   Position_dependent_options options_;
1855 };
1856
1857 // A list of files from the command line or a script.
1858
1859 class Input_arguments
1860 {
1861  public:
1862   typedef Input_argument_list::const_iterator const_iterator;
1863
1864   Input_arguments()
1865     : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
1866   { }
1867
1868   // Add a file.
1869   Input_argument&
1870   add_file(Input_file_argument& arg);
1871
1872   // Start a group (the --start-group option).
1873   void
1874   start_group();
1875
1876   // End a group (the --end-group option).
1877   void
1878   end_group();
1879
1880   // Start a lib (the --start-lib option).
1881   void
1882   start_lib(const Position_dependent_options&);
1883
1884   // End a lib (the --end-lib option).
1885   void
1886   end_lib();
1887
1888   // Return whether we are currently in a group.
1889   bool
1890   in_group() const
1891   { return this->in_group_; }
1892
1893   // Return whether we are currently in a lib.
1894   bool
1895   in_lib() const
1896   { return this->in_lib_; }
1897
1898   // The number of entries in the list.
1899   int
1900   size() const
1901   { return this->input_argument_list_.size(); }
1902
1903   // Iterators to iterate over the list of input files.
1904
1905   const_iterator
1906   begin() const
1907   { return this->input_argument_list_.begin(); }
1908
1909   const_iterator
1910   end() const
1911   { return this->input_argument_list_.end(); }
1912
1913   // Return whether the list is empty.
1914   bool
1915   empty() const
1916   { return this->input_argument_list_.empty(); }
1917
1918   // Return the number of input files.  This may be larger than
1919   // input_argument_list_.size(), because of files that are part
1920   // of groups or libs.
1921   int
1922   number_of_input_files() const
1923   { return this->file_count_; }
1924
1925  private:
1926   Input_argument_list input_argument_list_;
1927   bool in_group_;
1928   bool in_lib_;
1929   unsigned int file_count_;
1930 };
1931
1932
1933 // All the information read from the command line.  These are held in
1934 // three separate structs: one to hold the options (--foo), one to
1935 // hold the filenames listed on the commandline, and one to hold
1936 // linker script information.  This third is not a subset of the other
1937 // two because linker scripts can be specified either as options (via
1938 // -T) or as a file.
1939
1940 class Command_line
1941 {
1942  public:
1943   typedef Input_arguments::const_iterator const_iterator;
1944
1945   Command_line();
1946
1947   // Process the command line options.  This will exit with an
1948   // appropriate error message if an unrecognized option is seen.
1949   void
1950   process(int argc, const char** argv);
1951
1952   // Process one command-line option.  This takes the index of argv to
1953   // process, and returns the index for the next option.  no_more_options
1954   // is set to true if argv[i] is "--".
1955   int
1956   process_one_option(int argc, const char** argv, int i,
1957                      bool* no_more_options);
1958
1959   // Get the general options.
1960   const General_options&
1961   options() const
1962   { return this->options_; }
1963
1964   // Get the position dependent options.
1965   const Position_dependent_options&
1966   position_dependent_options() const
1967   { return this->position_options_; }
1968
1969   // Get the linker-script options.
1970   Script_options&
1971   script_options()
1972   { return this->script_options_; }
1973
1974   // Finalize the version-script options and return them.
1975   const Version_script_info&
1976   version_script();
1977
1978   // Get the input files.
1979   Input_arguments&
1980   inputs()
1981   { return this->inputs_; }
1982
1983   // The number of input files.
1984   int
1985   number_of_input_files() const
1986   { return this->inputs_.number_of_input_files(); }
1987
1988   // Iterators to iterate over the list of input files.
1989
1990   const_iterator
1991   begin() const
1992   { return this->inputs_.begin(); }
1993
1994   const_iterator
1995   end() const
1996   { return this->inputs_.end(); }
1997
1998  private:
1999   Command_line(const Command_line&);
2000   Command_line& operator=(const Command_line&);
2001
2002   // This is a dummy class to provide a constructor that runs before
2003   // the constructor for the General_options.  The Pre_options constructor
2004   // is used as a hook to set the flag enabling the options to register
2005   // themselves.
2006   struct Pre_options {
2007     Pre_options();
2008   };
2009
2010   // This must come before options_!
2011   Pre_options pre_options_;
2012   General_options options_;
2013   Position_dependent_options position_options_;
2014   Script_options script_options_;
2015   Input_arguments inputs_;
2016 };
2017
2018 } // End namespace gold.
2019
2020 #endif // !defined(GOLD_OPTIONS_H)