gold/options.h

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