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 char* 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(merge_exidx_entries, options::TWO_DASHES, '\0', true,
 775               N_("(ARM only) Merge exidx entries in debuginfo."),
 776               N_("(ARM only) Do not merge exidx entries in debuginfo."));
 777
 778   DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
 779                  N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
 780                  NULL);
 781
 782   DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
 783                  N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
 784                     "veneer"),
 785                  NULL);
 786
 787   DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
 788               N_("Ignored"), NULL);
 789
 790   DEFINE_bool(gnu_unique, options::TWO_DASHES, '\0', true,
 791               N_("Enable STB_GNU_UNIQUE symbol binding (default)"),
 792               N_("Disable STB_GNU_UNIQUE symbol binding"));
 793
 794   DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
 795                 N_("Set shared library name"), N_("FILENAME"));
 796
 797   DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
 798                 N_("Min fraction of empty buckets in dynamic hash"),
 799                 N_("FRACTION"));
 800
 801   DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
 802               N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
 803               {"sysv", "gnu", "both"});
 804
 805   DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
 806                 N_("Set dynamic linker path"), N_("PROGRAM"));
 807
 808   DEFINE_special(incremental, options::TWO_DASHES, '\0',
 809                  N_("Do an incremental link if possible; "
 810                     "otherwise, do a full link and prepare output "
 811                     "for incremental linking"), NULL);
 812
 813   DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
 814                  N_("Do a full link (default)"), NULL);
 815
 816   DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
 817                  N_("Do a full link and "
 818                     "prepare output for incremental linking"), NULL);
 819
 820   DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
 821                  N_("Do an incremental link; exit if not possible"), NULL);
 822
 823   DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
 824                 N_("Set base file for incremental linking"
 825                    " (default is output file)"),
 826                 N_("FILE"));
 827
 828   DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
 829                  N_("Assume files changed"), NULL);
 830
 831   DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
 832                  N_("Assume files didn't change"), NULL);
 833
 834   DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
 835                  N_("Use timestamps to check files (default)"), NULL);
 836
 837   DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
 838                  N_("Assume startup files unchanged "
 839                     "(files preceding this option)"), NULL);
 840
 841   DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
 842                  N_("Amount of extra space to allocate for patches"),
 843                  N_("PERCENT"));
 844
 845   DEFINE_string(init, options::ONE_DASH, '\0', "_init",
 846                 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
 847
 848   DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
 849                  N_("Read only symbol values from FILE"), N_("FILE"));
 850
 851   DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
 852               sizeof(void*) >= 8,
 853               N_("Map whole files to memory (default on 64-bit hosts)"),
 854               N_("Map relevant file parts to memory (default on 32-bit "
 855                  "hosts)"));
 856   DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
 857               N_("Keep files mapped across passes (default)"),
 858               N_("Release mapped files after each pass"));
 859
 860   DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
 861               N_("Generate unwind information for PLT (default)"),
 862               N_("Do not generate unwind information for PLT"));
 863
 864   DEFINE_special(library, options::TWO_DASHES, 'l',
 865                  N_("Search for library LIBNAME"), N_("LIBNAME"));
 866
 867   DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
 868                  N_("Add directory to search path"), N_("DIR"));
 869
 870   DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
 871               N_(" Only search directories specified on the command line."),
 872               NULL);
 873
 874   DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
 875               N_(" Put read-only non-executable sections in their own segment"),
 876               NULL);
 877
 878   DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
 879                 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
 880
 881   DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
 882               N_("Write map file on standard output"), NULL);
 883   DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
 884                 N_("MAPFILENAME"));
 885
 886   DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
 887               N_("Do not page align data"), NULL);
 888   DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
 889               N_("Do not page align data, do not make text readonly"),
 890               N_("Page align data, make text readonly"));
 891
 892   DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
 893                 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
 894                 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
 895
 896   DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
 897               N_("Create an output file even if errors occur"), NULL);
 898
 899   DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
 900                     N_("Report undefined symbols (even with --shared)"),
 901                     NULL, false);
 902
 903   DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
 904                 N_("Set output file name"), N_("FILE"));
 905
 906   DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
 907               N_("Optimize output file size"), N_("LEVEL"));
 908
 909   DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
 910                 N_("Set output format"), N_("[binary]"));
 911
 912   DEFINE_bool(p, options::ONE_DASH, '\0', false,
 913               N_("(ARM only) Ignore for backward compatibility"), NULL);
 914
 915   DEFINE_bool(pie, options::ONE_DASH, '\0', false,
 916               N_("Create a position independent executable"), NULL);
 917   DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
 918                     N_("Create a position independent executable"), NULL,
 919                     false);
 920
 921   DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
 922               NULL, N_("(ARM only) Ignore for backward compatibility"));
 923
 924 #ifdef ENABLE_PLUGINS
 925   DEFINE_special(plugin, options::TWO_DASHES, '\0',
 926                  N_("Load a plugin library"), N_("PLUGIN"));
 927   DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
 928                  N_("Pass an option to the plugin"), N_("OPTION"));
 929 #endif
 930
 931   DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
 932               N_("Preread archive symbols when multi-threaded"), NULL);
 933
 934   DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
 935               N_("Print default output format"), NULL);
 936
 937   DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
 938                 N_("Print symbols defined and used for each input"),
 939                 N_("FILENAME"));
 940
 941   DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
 942               N_("Ignored for SVR4 compatibility"), NULL);
 943
 944   DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
 945               N_("Generate relocations in output"), NULL);
 946
 947   DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
 948               N_("Generate relocatable output"), NULL);
 949   DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
 950                     N_("Synonym for -r"), NULL, false);
 951
 952   DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
 953               N_("Relax branches on certain targets"), NULL);
 954
 955   DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
 956                 N_("keep only symbols listed in this file"), N_("FILE"));
 957
 958   // -R really means -rpath, but can mean --just-symbols for
 959   // compatibility with GNU ld.  -rpath is always -rpath, so we list
 960   // it separately.
 961   DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
 962                  N_("Add DIR to runtime search path"), N_("DIR"));
 963
 964   DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
 965                  N_("Add DIR to runtime search path"), N_("DIR"));
 966
 967   DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
 968                  N_("Add DIR to link time shared library search path"),
 969                  N_("DIR"));
 970
 971   DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
 972                 N_("Layout sections in the order specified."),
 973                 N_("FILENAME"));
 974
 975   DEFINE_special(section_start, options::TWO_DASHES, '\0',
 976                  N_("Set address of section"), N_("SECTION=ADDRESS"));
 977
 978   DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
 979                          N_("Sort common symbols by alignment"),
 980                          N_("[={ascending,descending}]"));
 981
 982   DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
 983               N_("Dynamic tag slots to reserve (default 5)"),
 984               N_("COUNT"));
 985
 986   DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
 987               N_("Strip all symbols"), NULL);
 988   DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
 989               N_("Strip debugging information"), NULL);
 990   DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
 991               N_("Emit only debug line number information"), NULL);
 992   DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
 993               N_("Strip debug symbols that are unused by gdb "
 994                  "(at least versions <= 6.7)"), NULL);
 995   DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
 996               N_("Strip LTO intermediate code sections"), NULL);
 997
 998   DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
 999              N_("(ARM only) The maximum distance from instructions in a group "
1000                 "of sections to their stubs.  Negative values mean stubs "
1001                 "are always after the group. 1 means using default size.\n"),
1002              N_("SIZE"));
1003
1004   DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
1005               N_("Use less memory and more disk I/O "
1006                  "(included only for compatibility with GNU ld)"), NULL);
1007
1008   DEFINE_bool(shared, options::ONE_DASH, 'G', false,
1009               N_("Generate shared library"), NULL);
1010
1011   DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
1012               N_("Generate shared library"), NULL);
1013
1014   DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
1015               N_("Stack size when -fsplit-stack function calls non-split"),
1016               N_("SIZE"));
1017
1018   // This is not actually special in any way, but I need to give it
1019   // a non-standard accessor-function name because 'static' is a keyword.
1020   DEFINE_special(static, options::ONE_DASH, '\0',
1021                  N_("Do not link against shared libraries"), NULL);
1022
1023   DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
1024               N_("Identical Code Folding. "
1025                  "\'--icf=safe\' Folds ctors, dtors and functions whose"
1026                  " pointers are definitely not taken."),
1027               ("[none,all,safe]"),
1028               {"none", "all", "safe"});
1029
1030   DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
1031               N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
1032
1033   DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
1034               N_("List folded identical sections on stderr"),
1035               N_("Do not list folded identical sections"));
1036
1037   DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
1038              N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1039
1040   DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
1041               N_("Remove unused sections"),
1042               N_("Don't remove unused sections (default)"));
1043
1044   DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
1045               N_("List removed unused sections on stderr"),
1046               N_("Do not list removed unused sections"));
1047
1048   DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
1049               N_("Print resource usage statistics"), NULL);
1050
1051   DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
1052                 N_("Set target system root directory"), N_("DIR"));
1053
1054   DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1055               N_("Print the name of each input file"), NULL);
1056
1057   DEFINE_special(script, options::TWO_DASHES, 'T',
1058                  N_("Read linker script"), N_("FILE"));
1059
1060   DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
1061               N_("Run the linker multi-threaded"),
1062               N_("Do not run the linker multi-threaded"));
1063   DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
1064               N_("Number of threads to use"), N_("COUNT"));
1065   DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
1066               N_("Number of threads to use in initial pass"), N_("COUNT"));
1067   DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
1068               N_("Number of threads to use in middle pass"), N_("COUNT"));
1069   DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
1070               N_("Number of threads to use in final pass"), N_("COUNT"));
1071
1072   DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1073                 N_("Set the address of the bss segment"), N_("ADDRESS"));
1074   DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1075                 N_("Set the address of the data segment"), N_("ADDRESS"));
1076   DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1077                 N_("Set the address of the text segment"), N_("ADDRESS"));
1078
1079   DEFINE_set(undefined, options::TWO_DASHES, 'u',
1080              N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1081
1082   DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1083               N_("How to handle unresolved symbols"),
1084               ("ignore-all,report-all,ignore-in-object-files,"
1085                "ignore-in-shared-libs"),
1086               {"ignore-all", "report-all", "ignore-in-object-files",
1087                   "ignore-in-shared-libs"});
1088
1089   DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1090               N_("Synonym for --debug=files"), NULL);
1091
1092   DEFINE_special(version_script, options::TWO_DASHES, '\0',
1093                  N_("Read version script"), N_("FILE"));
1094
1095   DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1096               N_("Warn about duplicate common symbols"),
1097               N_("Do not warn about duplicate common symbols (default)"));
1098
1099   DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1100               N_("Ignored"), N_("Ignored"));
1101
1102   DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1103               N_("Warn if the stack is executable"),
1104               N_("Do not warn if the stack is executable (default)"));
1105
1106   DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1107               NULL, N_("Don't warn about mismatched input files"));
1108
1109   DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1110               N_("Ignored"), NULL);
1111
1112   DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1113               N_("Warn when skipping an incompatible library"),
1114               N_("Don't warn when skipping an incompatible library"));
1115
1116   DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1117               N_("Warn if text segment is not shareable"),
1118               N_("Do not warn if text segment is not shareable (default)"));
1119
1120   DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1121               N_("Report unresolved symbols as warnings"),
1122               NULL);
1123   DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1124                     options::TWO_DASHES, '\0',
1125                     N_("Report unresolved symbols as errors"),
1126                     NULL, true);
1127
1128   DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1129               N_("(ARM only) Do not warn about objects with incompatible "
1130                  "wchar_t sizes"));
1131
1132   DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1133               N_("Include all archive contents"),
1134               N_("Include only needed archive contents"));
1135
1136   DEFINE_set(wrap, options::TWO_DASHES, '\0',
1137              N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1138
1139   DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1140              N_("Trace references to symbol"), N_("SYMBOL"));
1141
1142   DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1143               N_("Allow unused version in script (default)"),
1144               N_("Do not allow unused version in script"));
1145
1146   DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1147                 N_("Default search path for Solaris compatibility"),
1148                 N_("PATH"));
1149
1150   DEFINE_special(start_group, options::TWO_DASHES, '(',
1151                  N_("Start a library search group"), NULL);
1152   DEFINE_special(end_group, options::TWO_DASHES, ')',
1153                  N_("End a library search group"), NULL);
1154
1155
1156   DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1157                  N_("Start a library"), NULL);
1158   DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1159                  N_("End a library "), NULL);
1160
1161   // The -z options.
1162
1163   DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1164               N_("Sort dynamic relocs"),
1165               N_("Do not sort dynamic relocs"));
1166   DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1167                 N_("Set common page size to SIZE"), N_("SIZE"));
1168   DEFINE_bool(defs, options::DASH_Z, '\0', false,
1169               N_("Report undefined symbols (even with --shared)"),
1170               NULL);
1171   DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1172               N_("Mark output as requiring executable stack"), NULL);
1173   DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1174               N_("Mark DSO to be initialized first at runtime"),
1175               NULL);
1176   DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1177               N_("Mark object to interpose all DSOs but executable"),
1178               NULL);
1179   DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1180                     N_("Mark object for lazy runtime binding (default)"),
1181                     NULL, true);
1182   DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1183               N_("Mark object requiring immediate process"),
1184               NULL);
1185   DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1186                 N_("Set maximum page size to SIZE"), N_("SIZE"));
1187   DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1188               N_("Allow multiple definitions of symbols"),
1189               NULL);
1190   // copyreloc is here in the list because there is only -z
1191   // nocopyreloc, not -z copyreloc.
1192   DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1193               NULL,
1194               N_("Do not create copy relocs"));
1195   DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1196               N_("Mark object not to use default search paths"),
1197               NULL);
1198   DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1199               N_("Mark DSO non-deletable at runtime"),
1200               NULL);
1201   DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1202               N_("Mark DSO not available to dlopen"),
1203               NULL);
1204   DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1205               N_("Mark DSO not available to dldump"),
1206               NULL);
1207   DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1208               N_("Mark output as not requiring executable stack"), NULL);
1209   DEFINE_bool(now, options::DASH_Z, '\0', false,
1210               N_("Mark object for immediate function binding"),
1211               NULL);
1212   DEFINE_bool(origin, options::DASH_Z, '\0', false,
1213               N_("Mark DSO to indicate that needs immediate $ORIGIN "
1214                  "processing at runtime"), NULL);
1215   DEFINE_bool(relro, options::DASH_Z, '\0', false,
1216               N_("Where possible mark variables read-only after relocation"),
1217               N_("Don't mark variables read-only after relocation"));
1218   DEFINE_bool(text, options::DASH_Z, '\0', false,
1219               N_("Do not permit relocations in read-only segments"),
1220               N_("Permit relocations in read-only segments (default)"));
1221   DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1222                     N_("Permit relocations in read-only segments (default)"),
1223                     NULL, true);
1224
1225  public:
1226   typedef options::Dir_list Dir_list;
1227
1228   General_options();
1229
1230   // Does post-processing on flags, making sure they all have
1231   // non-conflicting values.  Also converts some flags from their
1232   // "standard" types (string, etc), to another type (enum, DirList),
1233   // which can be accessed via a separate method.  Dies if it notices
1234   // any problems.
1235   void finalize();
1236
1237   // True if we printed the version information.
1238   bool
1239   printed_version() const
1240   { return this->printed_version_; }
1241
1242   // The macro defines output() (based on --output), but that's a
1243   // generic name.  Provide this alternative name, which is clearer.
1244   const char*
1245   output_file_name() const
1246   { return this->output(); }
1247
1248   // This is not defined via a flag, but combines flags to say whether
1249   // the output is position-independent or not.
1250   bool
1251   output_is_position_independent() const
1252   { return this->shared() || this->pie(); }
1253
1254   // Return true if the output is something that can be exec()ed, such
1255   // as a static executable, or a position-dependent or
1256   // position-independent executable, but not a dynamic library or an
1257   // object file.
1258   bool
1259   output_is_executable() const
1260   { return !this->shared() && !this->relocatable(); }
1261
1262   // This would normally be static(), and defined automatically, but
1263   // since static is a keyword, we need to come up with our own name.
1264   bool
1265   is_static() const
1266   { return static_; }
1267
1268   // In addition to getting the input and output formats as a string
1269   // (via format() and oformat()), we also give access as an enum.
1270   enum Object_format
1271   {
1272     // Ordinary ELF.
1273     OBJECT_FORMAT_ELF,
1274     // Straight binary format.
1275     OBJECT_FORMAT_BINARY
1276   };
1277
1278   // Convert a string to an Object_format.  Gives an error if the
1279   // string is not recognized.
1280   static Object_format
1281   string_to_object_format(const char* arg);
1282
1283   // Note: these functions are not very fast.
1284   Object_format format_enum() const;
1285   Object_format oformat_enum() const;
1286
1287   // Return whether FILENAME is in a system directory.
1288   bool
1289   is_in_system_directory(const std::string& name) const;
1290
1291   // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1292   bool
1293   should_retain_symbol(const char* symbol_name) const
1294     {
1295       if (symbols_to_retain_.empty())    // means flag wasn't specified
1296         return true;
1297       return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1298     }
1299
1300   // These are the best way to get access to the execstack state,
1301   // not execstack() and noexecstack() which are hard to use properly.
1302   bool
1303   is_execstack_set() const
1304   { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1305
1306   bool
1307   is_stack_executable() const
1308   { return this->execstack_status_ == EXECSTACK_YES; }
1309
1310   bool
1311   icf_enabled() const
1312   { return this->icf_status_ != ICF_NONE; }
1313
1314   bool
1315   icf_safe_folding() const
1316   { return this->icf_status_ == ICF_SAFE; }
1317
1318   // The --demangle option takes an optional string, and there is also
1319   // a --no-demangle option.  This is the best way to decide whether
1320   // to demangle or not.
1321   bool
1322   do_demangle() const
1323   { return this->do_demangle_; }
1324
1325   // Returns TRUE if any plugin libraries have been loaded.
1326   bool
1327   has_plugins() const
1328   { return this->plugins_ != NULL; }
1329
1330   // Return a pointer to the plugin manager.
1331   Plugin_manager*
1332   plugins() const
1333   { return this->plugins_; }
1334
1335   // True iff SYMBOL was found in the file specified by dynamic-list.
1336   bool
1337   in_dynamic_list(const char* symbol) const
1338   { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1339
1340   // Finalize the dynamic list.
1341   void
1342   finalize_dynamic_list()
1343   { this->dynamic_list_.version_script_info()->finalize(); }
1344
1345   // The mode selected by the --incremental options.
1346   enum Incremental_mode
1347   {
1348     // No incremental linking (--no-incremental).
1349     INCREMENTAL_OFF,
1350     // Incremental update only (--incremental-update).
1351     INCREMENTAL_UPDATE,
1352     // Force a full link, but prepare for subsequent incremental link
1353     // (--incremental-full).
1354     INCREMENTAL_FULL,
1355     // Incremental update if possible, fallback to full link  (--incremental).
1356     INCREMENTAL_AUTO
1357   };
1358
1359   // The incremental linking mode.
1360   Incremental_mode
1361   incremental_mode() const
1362   { return this->incremental_mode_; }
1363
1364   // The disposition given by the --incremental-changed,
1365   // --incremental-unchanged or --incremental-unknown option.  The
1366   // value may change as we proceed parsing the command line flags.
1367   Incremental_disposition
1368   incremental_disposition() const
1369   { return this->incremental_disposition_; }
1370
1371   // The disposition to use for startup files (those that precede the
1372   // first --incremental-changed, etc. option).
1373   Incremental_disposition
1374   incremental_startup_disposition() const
1375   { return this->incremental_startup_disposition_; }
1376
1377   // Return true if S is the name of a library excluded from automatic
1378   // symbol export.
1379   bool
1380   check_excluded_libs(const std::string &s) const;
1381
1382   // If an explicit start address was given for section SECNAME with
1383   // the --section-start option, return true and set *PADDR to the
1384   // address.  Otherwise return false.
1385   bool
1386   section_start(const char* secname, uint64_t* paddr) const;
1387
1388   // Return whether any --section-start option was used.
1389   bool
1390   any_section_start() const
1391   { return !this->section_starts_.empty(); }
1392
1393   enum Fix_v4bx
1394   {
1395     // Leave original instruction.
1396     FIX_V4BX_NONE,
1397     // Replace instruction.
1398     FIX_V4BX_REPLACE,
1399     // Generate an interworking veneer.
1400     FIX_V4BX_INTERWORKING
1401   };
1402
1403   Fix_v4bx
1404   fix_v4bx() const
1405   { return (this->fix_v4bx_); }
1406
1407   enum Endianness
1408   {
1409     ENDIANNESS_NOT_SET,
1410     ENDIANNESS_BIG,
1411     ENDIANNESS_LITTLE
1412   };
1413
1414   Endianness
1415   endianness() const
1416   { return this->endianness_; }
1417
1418  private:
1419   // Don't copy this structure.
1420   General_options(const General_options&);
1421   General_options& operator=(const General_options&);
1422
1423   // Whether to mark the stack as executable.
1424   enum Execstack
1425   {
1426     // Not set on command line.
1427     EXECSTACK_FROM_INPUT,
1428     // Mark the stack as executable (-z execstack).
1429     EXECSTACK_YES,
1430     // Mark the stack as not executable (-z noexecstack).
1431     EXECSTACK_NO
1432   };
1433
1434   enum Icf_status
1435   {
1436     // Do not fold any functions (Default or --icf=none).
1437     ICF_NONE,
1438     // All functions are candidates for folding. (--icf=all).
1439     ICF_ALL,
1440     // Only ctors and dtors are candidates for folding. (--icf=safe).
1441     ICF_SAFE
1442   };
1443
1444   void
1445   set_icf_status(Icf_status value)
1446   { this->icf_status_ = value; }
1447
1448   void
1449   set_execstack_status(Execstack value)
1450   { this->execstack_status_ = value; }
1451
1452   void
1453   set_do_demangle(bool value)
1454   { this->do_demangle_ = value; }
1455
1456   void
1457   set_static(bool value)
1458   { static_ = value; }
1459
1460   // These are called by finalize() to set up the search-path correctly.
1461   void
1462   add_to_library_path_with_sysroot(const char* arg)
1463   { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1464
1465   // Apply any sysroot to the directory lists.
1466   void
1467   add_sysroot();
1468
1469   // Add a plugin and its arguments to the list of plugins.
1470   void
1471   add_plugin(const char* filename);
1472
1473   // Add a plugin option.
1474   void
1475   add_plugin_option(const char* opt);
1476
1477   // Whether we printed version information.
1478   bool printed_version_;
1479   // Whether to mark the stack as executable.
1480   Execstack execstack_status_;
1481   // Whether to do code folding.
1482   Icf_status icf_status_;
1483   // Whether to do a static link.
1484   bool static_;
1485   // Whether to do demangling.
1486   bool do_demangle_;
1487   // List of plugin libraries.
1488   Plugin_manager* plugins_;
1489   // The parsed output of --dynamic-list files.  For convenience in
1490   // script.cc, we store this as a Script_options object, even though
1491   // we only use a single Version_tree from it.
1492   Script_options dynamic_list_;
1493   // The incremental linking mode.
1494   Incremental_mode incremental_mode_;
1495   // The disposition given by the --incremental-changed,
1496   // --incremental-unchanged or --incremental-unknown option.  The
1497   // value may change as we proceed parsing the command line flags.
1498   Incremental_disposition incremental_disposition_;
1499   // The disposition to use for startup files (those marked
1500   // INCREMENTAL_STARTUP).
1501   Incremental_disposition incremental_startup_disposition_;
1502   // Whether we have seen one of the options that require incremental
1503   // build (--incremental-changed, --incremental-unchanged,
1504   // --incremental-unknown, or --incremental-startup-unchanged).
1505   bool implicit_incremental_;
1506   // Libraries excluded from automatic export, via --exclude-libs.
1507   Unordered_set<std::string> excluded_libs_;
1508   // List of symbol-names to keep, via -retain-symbol-info.
1509   Unordered_set<std::string> symbols_to_retain_;
1510   // Map from section name to address from --section-start.
1511   std::map<std::string, uint64_t> section_starts_;
1512   // Whether to process armv4 bx instruction relocation.
1513   Fix_v4bx fix_v4bx_;
1514   // Endianness.
1515   Endianness endianness_;
1516 };
1517
1518 // The position-dependent options.  We use this to store the state of
1519 // the commandline at a particular point in parsing for later
1520 // reference.  For instance, if we see "ld --whole-archive foo.a
1521 // --no-whole-archive," we want to store the whole-archive option with
1522 // foo.a, so when the time comes to parse foo.a we know we should do
1523 // it in whole-archive mode.  We could store all of General_options,
1524 // but that's big, so we just pick the subset of flags that actually
1525 // change in a position-dependent way.
1526
1527 #define DEFINE_posdep(varname__, type__)        \
1528  public:                                        \
1529   type__                                        \
1530   varname__() const                             \
1531   { return this->varname__##_; }                \
1532                                                 \
1533   void                                          \
1534   set_##varname__(type__ value)                 \
1535   { this->varname__##_ = value; }               \
1536  private:                                       \
1537   type__ varname__##_
1538
1539 class Position_dependent_options
1540 {
1541  public:
1542   Position_dependent_options(const General_options& options
1543                              = Position_dependent_options::default_options_)
1544   { copy_from_options(options); }
1545
1546   void copy_from_options(const General_options& options)
1547   {
1548     this->set_as_needed(options.as_needed());
1549     this->set_Bdynamic(options.Bdynamic());
1550     this->set_format_enum(options.format_enum());
1551     this->set_whole_archive(options.whole_archive());
1552     this->set_incremental_disposition(options.incremental_disposition());
1553   }
1554
1555   DEFINE_posdep(as_needed, bool);
1556   DEFINE_posdep(Bdynamic, bool);
1557   DEFINE_posdep(format_enum, General_options::Object_format);
1558   DEFINE_posdep(whole_archive, bool);
1559   DEFINE_posdep(incremental_disposition, Incremental_disposition);
1560
1561  private:
1562   // This is a General_options with everything set to its default
1563   // value.  A Position_dependent_options created with no argument
1564   // will take its values from here.
1565   static General_options default_options_;
1566 };
1567
1568
1569 // A single file or library argument from the command line.
1570
1571 class Input_file_argument
1572 {
1573  public:
1574   enum Input_file_type
1575   {
1576     // A regular file, name used as-is, not searched.
1577     INPUT_FILE_TYPE_FILE,
1578     // A library name.  When used, "lib" will be prepended and ".so" or
1579     // ".a" appended to make a filename, and that filename will be searched
1580     // for using the -L paths.
1581     INPUT_FILE_TYPE_LIBRARY,
1582     // A regular file, name used as-is, but searched using the -L paths.
1583     INPUT_FILE_TYPE_SEARCHED_FILE
1584   };
1585
1586   // name: file name or library name
1587   // type: the type of this input file.
1588   // extra_search_path: an extra directory to look for the file, prior
1589   //         to checking the normal library search path.  If this is "",
1590   //         then no extra directory is added.
1591   // just_symbols: whether this file only defines symbols.
1592   // options: The position dependent options at this point in the
1593   //         command line, such as --whole-archive.
1594   Input_file_argument()
1595     : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1596       just_symbols_(false), options_(), arg_serial_(0)
1597   { }
1598
1599   Input_file_argument(const char* name, Input_file_type type,
1600                       const char* extra_search_path,
1601                       bool just_symbols,
1602                       const Position_dependent_options& options)
1603     : name_(name), type_(type), extra_search_path_(extra_search_path),
1604       just_symbols_(just_symbols), options_(options), arg_serial_(0)
1605   { }
1606
1607   // You can also pass in a General_options instance instead of a
1608   // Position_dependent_options.  In that case, we extract the
1609   // position-independent vars from the General_options and only store
1610   // those.
1611   Input_file_argument(const char* name, Input_file_type type,
1612                       const char* extra_search_path,
1613                       bool just_symbols,
1614                       const General_options& options)
1615     : name_(name), type_(type), extra_search_path_(extra_search_path),
1616       just_symbols_(just_symbols), options_(options), arg_serial_(0)
1617   { }
1618
1619   const char*
1620   name() const
1621   { return this->name_.c_str(); }
1622
1623   const Position_dependent_options&
1624   options() const
1625   { return this->options_; }
1626
1627   bool
1628   is_lib() const
1629   { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1630
1631   bool
1632   is_searched_file() const
1633   { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1634
1635   const char*
1636   extra_search_path() const
1637   {
1638     return (this->extra_search_path_.empty()
1639             ? NULL
1640             : this->extra_search_path_.c_str());
1641   }
1642
1643   // Return whether we should only read symbols from this file.
1644   bool
1645   just_symbols() const
1646   { return this->just_symbols_; }
1647
1648   // Return whether this file may require a search using the -L
1649   // options.
1650   bool
1651   may_need_search() const
1652   {
1653     return (this->is_lib()
1654             || this->is_searched_file()
1655             || !this->extra_search_path_.empty());
1656   }
1657
1658   // Set the serial number for this argument.
1659   void
1660   set_arg_serial(unsigned int arg_serial)
1661   { this->arg_serial_ = arg_serial; }
1662
1663   // Get the serial number.
1664   unsigned int
1665   arg_serial() const
1666   { return this->arg_serial_; }
1667
1668  private:
1669   // We use std::string, not const char*, here for convenience when
1670   // using script files, so that we do not have to preserve the string
1671   // in that case.
1672   std::string name_;
1673   Input_file_type type_;
1674   std::string extra_search_path_;
1675   bool just_symbols_;
1676   Position_dependent_options options_;
1677   // A unique index for this file argument in the argument list.
1678   unsigned int arg_serial_;
1679 };
1680
1681 // A file or library, or a group, from the command line.
1682
1683 class Input_argument
1684 {
1685  public:
1686   // Create a file or library argument.
1687   explicit Input_argument(Input_file_argument file)
1688     : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
1689   { }
1690
1691   // Create a group argument.
1692   explicit Input_argument(Input_file_group* group)
1693     : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
1694   { }
1695
1696   // Create a lib argument.
1697   explicit Input_argument(Input_file_lib* lib)
1698     : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
1699   { }
1700
1701   // Return whether this is a file.
1702   bool
1703   is_file() const
1704   { return this->is_file_; }
1705
1706   // Return whether this is a group.
1707   bool
1708   is_group() const
1709   { return !this->is_file_ && this->lib_ == NULL; }
1710
1711   // Return whether this is a lib.
1712   bool
1713   is_lib() const
1714   { return this->lib_ != NULL; }
1715
1716   // Return the information about the file.
1717   const Input_file_argument&
1718   file() const
1719   {
1720     gold_assert(this->is_file_);
1721     return this->file_;
1722   }
1723
1724   // Return the information about the group.
1725   const Input_file_group*
1726   group() const
1727   {
1728     gold_assert(!this->is_file_);
1729     return this->group_;
1730   }
1731
1732   Input_file_group*
1733   group()
1734   {
1735     gold_assert(!this->is_file_);
1736     return this->group_;
1737   }
1738
1739   // Return the information about the lib.
1740   const Input_file_lib*
1741   lib() const
1742   {
1743     gold_assert(!this->is_file_);
1744     gold_assert(this->lib_);
1745     return this->lib_;
1746   }
1747
1748   Input_file_lib*
1749   lib()
1750   {
1751     gold_assert(!this->is_file_);
1752     gold_assert(this->lib_);
1753     return this->lib_;
1754   }
1755
1756   // If a script generated this argument, store a pointer to the script info.
1757   // Currently used only for recording incremental link information.
1758   void
1759   set_script_info(Script_info* info)
1760   { this->script_info_ = info; }
1761
1762   Script_info*
1763   script_info() const
1764   { return this->script_info_; }
1765
1766  private:
1767   bool is_file_;
1768   Input_file_argument file_;
1769   Input_file_group* group_;
1770   Input_file_lib* lib_;
1771   Script_info* script_info_;
1772 };
1773
1774 typedef std::vector<Input_argument> Input_argument_list;
1775
1776 // A group from the command line.  This is a set of arguments within
1777 // --start-group ... --end-group.
1778
1779 class Input_file_group
1780 {
1781  public:
1782   typedef Input_argument_list::const_iterator const_iterator;
1783
1784   Input_file_group()
1785     : files_()
1786   { }
1787
1788   // Add a file to the end of the group.
1789   Input_argument&
1790   add_file(const Input_file_argument& arg)
1791   {
1792     this->files_.push_back(Input_argument(arg));
1793     return this->files_.back();
1794   }
1795
1796   // Iterators to iterate over the group contents.
1797
1798   const_iterator
1799   begin() const
1800   { return this->files_.begin(); }
1801
1802   const_iterator
1803   end() const
1804   { return this->files_.end(); }
1805
1806  private:
1807   Input_argument_list files_;
1808 };
1809
1810 // A lib from the command line.  This is a set of arguments within
1811 // --start-lib ... --end-lib.
1812
1813 class Input_file_lib
1814 {
1815  public:
1816   typedef Input_argument_list::const_iterator const_iterator;
1817
1818   Input_file_lib(const Position_dependent_options& options)
1819     : files_(), options_(options)
1820   { }
1821
1822   // Add a file to the end of the lib.
1823   Input_argument&
1824   add_file(const Input_file_argument& arg)
1825   {
1826     this->files_.push_back(Input_argument(arg));
1827     return this->files_.back();
1828   }
1829
1830   const Position_dependent_options&
1831   options() const
1832   { return this->options_; }
1833
1834   // Iterators to iterate over the lib contents.
1835
1836   const_iterator
1837   begin() const
1838   { return this->files_.begin(); }
1839
1840   const_iterator
1841   end() const
1842   { return this->files_.end(); }
1843
1844   size_t
1845   size() const
1846   { return this->files_.size(); }
1847
1848  private:
1849   Input_argument_list files_;
1850   Position_dependent_options options_;
1851 };
1852
1853 // A list of files from the command line or a script.
1854
1855 class Input_arguments
1856 {
1857  public:
1858   typedef Input_argument_list::const_iterator const_iterator;
1859
1860   Input_arguments()
1861     : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
1862   { }
1863
1864   // Add a file.
1865   Input_argument&
1866   add_file(Input_file_argument& arg);
1867
1868   // Start a group (the --start-group option).
1869   void
1870   start_group();
1871
1872   // End a group (the --end-group option).
1873   void
1874   end_group();
1875
1876   // Start a lib (the --start-lib option).
1877   void
1878   start_lib(const Position_dependent_options&);
1879
1880   // End a lib (the --end-lib option).
1881   void
1882   end_lib();
1883
1884   // Return whether we are currently in a group.
1885   bool
1886   in_group() const
1887   { return this->in_group_; }
1888
1889   // Return whether we are currently in a lib.
1890   bool
1891   in_lib() const
1892   { return this->in_lib_; }
1893
1894   // The number of entries in the list.
1895   int
1896   size() const
1897   { return this->input_argument_list_.size(); }
1898
1899   // Iterators to iterate over the list of input files.
1900
1901   const_iterator
1902   begin() const
1903   { return this->input_argument_list_.begin(); }
1904
1905   const_iterator
1906   end() const
1907   { return this->input_argument_list_.end(); }
1908
1909   // Return whether the list is empty.
1910   bool
1911   empty() const
1912   { return this->input_argument_list_.empty(); }
1913
1914   // Return the number of input files.  This may be larger than
1915   // input_argument_list_.size(), because of files that are part
1916   // of groups or libs.
1917   int
1918   number_of_input_files() const
1919   { return this->file_count_; }
1920
1921  private:
1922   Input_argument_list input_argument_list_;
1923   bool in_group_;
1924   bool in_lib_;
1925   unsigned int file_count_;
1926 };
1927
1928
1929 // All the information read from the command line.  These are held in
1930 // three separate structs: one to hold the options (--foo), one to
1931 // hold the filenames listed on the commandline, and one to hold
1932 // linker script information.  This third is not a subset of the other
1933 // two because linker scripts can be specified either as options (via
1934 // -T) or as a file.
1935
1936 class Command_line
1937 {
1938  public:
1939   typedef Input_arguments::const_iterator const_iterator;
1940
1941   Command_line();
1942
1943   // Process the command line options.  This will exit with an
1944   // appropriate error message if an unrecognized option is seen.
1945   void
1946   process(int argc, const char** argv);
1947
1948   // Process one command-line option.  This takes the index of argv to
1949   // process, and returns the index for the next option.  no_more_options
1950   // is set to true if argv[i] is "--".
1951   int
1952   process_one_option(int argc, const char** argv, int i,
1953                      bool* no_more_options);
1954
1955   // Get the general options.
1956   const General_options&
1957   options() const
1958   { return this->options_; }
1959
1960   // Get the position dependent options.
1961   const Position_dependent_options&
1962   position_dependent_options() const
1963   { return this->position_options_; }
1964
1965   // Get the linker-script options.
1966   Script_options&
1967   script_options()
1968   { return this->script_options_; }
1969
1970   // Finalize the version-script options and return them.
1971   const Version_script_info&
1972   version_script();
1973
1974   // Get the input files.
1975   Input_arguments&
1976   inputs()
1977   { return this->inputs_; }
1978
1979   // The number of input files.
1980   int
1981   number_of_input_files() const
1982   { return this->inputs_.number_of_input_files(); }
1983
1984   // Iterators to iterate over the list of input files.
1985
1986   const_iterator
1987   begin() const
1988   { return this->inputs_.begin(); }
1989
1990   const_iterator
1991   end() const
1992   { return this->inputs_.end(); }
1993
1994  private:
1995   Command_line(const Command_line&);
1996   Command_line& operator=(const Command_line&);
1997
1998   // This is a dummy class to provide a constructor that runs before
1999   // the constructor for the General_options.  The Pre_options constructor
2000   // is used as a hook to set the flag enabling the options to register
2001   // themselves.
2002   struct Pre_options {
2003     Pre_options();
2004   };
2005
2006   // This must come before options_!
2007   Pre_options pre_options_;
2008   General_options options_;
2009   Position_dependent_options position_options_;
2010   Script_options script_options_;
2011   Input_arguments inputs_;
2012 };
2013
2014 } // End namespace gold.
2015
2016 #endif // !defined(GOLD_OPTIONS_H)