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