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
 627   DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
 628               N_("Bind defined symbols locally"), NULL);
 629
 630   DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
 631               N_("Bind defined function symbols locally"), NULL);
 632
 633   DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
 634                          N_("Generate build ID note"),
 635                          N_("[=STYLE]"));
 636
 637   DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
 638               N_("Check segment addresses for overlaps (default)"),
 639               N_("Do not check segment addresses for overlaps"));
 640
 641 #ifdef HAVE_ZLIB_H
 642   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
 643               N_("Compress .debug_* sections in the output file"),
 644               ("[none,zlib]"),
 645               {"none", "zlib"});
 646 #else
 647   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
 648               N_("Compress .debug_* sections in the output file"),
 649               N_("[none]"),
 650               {"none"});
 651 #endif
 652
 653   DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
 654               N_("Not supported"),
 655               N_("Do not copy DT_NEEDED tags from shared libraries"));
 656
 657   DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
 658               N_("Output cross reference table"),
 659               N_("Do not output cross reference table"));
 660
 661   DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
 662               N_("Define common symbols"),
 663               N_("Do not define common symbols"));
 664   DEFINE_bool(dc, options::ONE_DASH, '\0', false,
 665               N_("Alias for -d"), NULL);
 666   DEFINE_bool(dp, options::ONE_DASH, '\0', false,
 667               N_("Alias for -d"), NULL);
 668
 669   DEFINE_string(debug, options::TWO_DASHES, '\0', "",
 670                 N_("Turn on debugging"),
 671                 N_("[all,files,script,task][,...]"));
 672
 673   DEFINE_special(defsym, options::TWO_DASHES, '\0',
 674                  N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
 675
 676   DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
 677                          N_("Demangle C++ symbols in log messages"),
 678                          N_("[=STYLE]"));
 679
 680   DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
 681               N_("Do not demangle C++ symbols in log messages"),
 682               NULL);
 683
 684   DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
 685               N_("Try to detect violations of the One Definition Rule"),
 686               NULL);
 687
 688   DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
 689               N_("Delete all local symbols"), NULL);
 690   DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
 691               N_("Delete all temporary local symbols"), NULL);
 692
 693   DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
 694               N_("Add data symbols to dynamic symbols"), NULL);
 695
 696   DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
 697               N_("Add C++ operator new/delete to dynamic symbols"), NULL);
 698
 699   DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
 700               N_("Add C++ typeinfo to dynamic symbols"), NULL);
 701
 702   DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
 703                  N_("Read a list of dynamic symbols"), N_("FILE"));
 704
 705   DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
 706                 N_("Set program start address"), N_("ADDRESS"));
 707
 708   DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
 709                  N_("Exclude libraries from automatic export"),
 710                  N_(("lib,lib ...")));
 711
 712   DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
 713               N_("Export all dynamic symbols"),
 714               N_("Do not export all dynamic symbols (default)"));
 715
 716   DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
 717               N_("Create exception frame header"), NULL);
 718
 719   DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
 720               N_("Treat warnings as errors"),
 721               N_("Do not treat warnings as errors"));
 722
 723   DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
 724                 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
 725
 726   DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
 727               N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
 728               N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
 729
 730   DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
 731                  N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
 732                  NULL);
 733
 734   DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
 735                  N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
 736                     "veneer"),
 737                  NULL);
 738
 739   DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
 740               N_("Ignored"), NULL);
 741
 742   DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
 743                 N_("Set shared library name"), N_("FILENAME"));
 744
 745   DEFINE_bool(i, options::EXACTLY_ONE_DASH, '\0', false,
 746               N_("Ignored"), NULL);
 747
 748   DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
 749                 N_("Min fraction of empty buckets in dynamic hash"),
 750                 N_("FRACTION"));
 751
 752   DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
 753               N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
 754               {"sysv", "gnu", "both"});
 755
 756   DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
 757                 N_("Set dynamic linker path"), N_("PROGRAM"));
 758
 759   DEFINE_bool(incremental, options::TWO_DASHES, '\0', false,
 760               N_("Work in progress; do not use"),
 761               N_("Do a full build"));
 762
 763   DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
 764                  N_("Assume files changed"), NULL);
 765
 766   DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
 767                  N_("Assume files didn't change"), NULL);
 768
 769   DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
 770                  N_("Use timestamps to check files (default)"), NULL);
 771
 772   DEFINE_string(init, options::ONE_DASH, '\0', "_init",
 773                 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
 774
 775   DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
 776                  N_("Read only symbol values from FILE"), N_("FILE"));
 777
 778   DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
 779               sizeof(void*) >= 8,
 780               N_("Map whole files to memory (default on 64-bit hosts)"),
 781               N_("Map relevant file parts to memory (default on 32-bit "
 782                  "hosts)"));
 783   DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
 784               N_("Keep files mapped across passes (default)"),
 785               N_("Release mapped files after each pass"));
 786
 787   DEFINE_special(library, options::TWO_DASHES, 'l',
 788                  N_("Search for library LIBNAME"), N_("LIBNAME"));
 789
 790   DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
 791                  N_("Add directory to search path"), N_("DIR"));
 792
 793   DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
 794                 N_("Ignored for compatibility"), N_("EMULATION"));
 795
 796   DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
 797               N_("Write map file on standard output"), NULL);
 798   DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
 799                 N_("MAPFILENAME"));
 800
 801   DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
 802               N_("Do not page align data"), NULL);
 803   DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
 804               N_("Do not page align data, do not make text readonly"),
 805               N_("Page align data, make text readonly"));
 806
 807   DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
 808                 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
 809                 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
 810
 811   DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
 812               N_("Create an output file even if errors occur"), NULL);
 813
 814   DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
 815                     N_("Report undefined symbols (even with --shared)"),
 816                     NULL, false);
 817
 818   DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
 819                 N_("Set output file name"), N_("FILE"));
 820
 821   DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
 822               N_("Optimize output file size"), N_("LEVEL"));
 823
 824   DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
 825                 N_("Set output format"), N_("[binary]"));
 826
 827   DEFINE_bool(pie, options::ONE_DASH, '\0', false,
 828               N_("Create a position independent executable"), NULL);
 829   DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
 830                     N_("Create a position independent executable"), NULL,
 831                     false);
 832
 833 #ifdef ENABLE_PLUGINS
 834   DEFINE_special(plugin, options::TWO_DASHES, '\0',
 835                  N_("Load a plugin library"), N_("PLUGIN"));
 836   DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
 837                  N_("Pass an option to the plugin"), N_("OPTION"));
 838 #endif
 839
 840   DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
 841               N_("Preread archive symbols when multi-threaded"), NULL);
 842
 843   DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
 844                 N_("Print symbols defined and used for each input"),
 845                 N_("FILENAME"));
 846
 847   DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
 848               N_("Ignored for SVR4 compatibility"), NULL);
 849
 850   DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
 851               N_("Generate relocations in output"), NULL);
 852
 853   DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
 854               N_("Generate relocatable output"), NULL);
 855
 856   DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
 857               N_("Relax branches on certain targets"), NULL);
 858
 859   DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
 860                 N_("keep only symbols listed in this file"), N_("FILE"));
 861
 862   // -R really means -rpath, but can mean --just-symbols for
 863   // compatibility with GNU ld.  -rpath is always -rpath, so we list
 864   // it separately.
 865   DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
 866                  N_("Add DIR to runtime search path"), N_("DIR"));
 867
 868   DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
 869                  N_("Add DIR to runtime search path"), N_("DIR"));
 870
 871   DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
 872                  N_("Add DIR to link time shared library search path"),
 873                  N_("DIR"));
 874
 875   DEFINE_special(section_start, options::TWO_DASHES, '\0',
 876                  N_("Set address of section"), N_("SECTION=ADDRESS"));
 877
 878   DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
 879                          N_("Sort common symbols by alignment"),
 880                          N_("[={ascending,descending}]"));
 881
 882   DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
 883               N_("Dynamic tag slots to reserve (default 5)"),
 884               N_("COUNT"));
 885
 886   DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
 887               N_("Strip all symbols"), NULL);
 888   DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
 889               N_("Strip debugging information"), NULL);
 890   DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
 891               N_("Emit only debug line number information"), NULL);
 892   DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
 893               N_("Strip debug symbols that are unused by gdb "
 894                  "(at least versions <= 6.7)"), NULL);
 895   DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
 896               N_("Strip LTO intermediate code sections"), NULL);
 897
 898   DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
 899              N_("(ARM only) The maximum distance from instructions in a group "
 900                 "of sections to their stubs.  Negative values mean stubs "
 901                 "are always after the group. 1 means using default size.\n"),
 902              N_("SIZE"));
 903
 904   DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
 905               N_("Use less memory and more disk I/O "
 906                  "(included only for compatibility with GNU ld)"), NULL);
 907
 908   DEFINE_bool(shared, options::ONE_DASH, 'G', false,
 909               N_("Generate shared library"), NULL);
 910
 911   DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
 912               N_("Generate shared library"), NULL);
 913
 914   DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
 915               N_("Stack size when -fsplit-stack function calls non-split"),
 916               N_("SIZE"));
 917
 918   // This is not actually special in any way, but I need to give it
 919   // a non-standard accessor-function name because 'static' is a keyword.
 920   DEFINE_special(static, options::ONE_DASH, '\0',
 921                  N_("Do not link against shared libraries"), NULL);
 922
 923   DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
 924               N_("Identical Code Folding. "
 925                  "\'--icf=safe\' Folds ctors, dtors and functions whose"
 926                  " pointers are definitely not taken."),
 927               ("[none,all,safe]"),
 928               {"none", "all", "safe"});
 929
 930   DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
 931               N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
 932
 933   DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
 934               N_("List folded identical sections on stderr"),
 935               N_("Do not list folded identical sections"));
 936
 937   DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
 938              N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
 939
 940   DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
 941               N_("Remove unused sections"),
 942               N_("Don't remove unused sections (default)"));
 943
 944   DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
 945               N_("List removed unused sections on stderr"),
 946               N_("Do not list removed unused sections"));
 947
 948   DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
 949               N_("Print resource usage statistics"), NULL);
 950
 951   DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
 952                 N_("Set target system root directory"), N_("DIR"));
 953
 954   DEFINE_bool(trace, options::TWO_DASHES, 't', false,
 955               N_("Print the name of each input file"), NULL);
 956
 957   DEFINE_special(script, options::TWO_DASHES, 'T',
 958                  N_("Read linker script"), N_("FILE"));
 959
 960   DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
 961               N_("Run the linker multi-threaded"),
 962               N_("Do not run the linker multi-threaded"));
 963   DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
 964               N_("Number of threads to use"), N_("COUNT"));
 965   DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
 966               N_("Number of threads to use in initial pass"), N_("COUNT"));
 967   DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
 968               N_("Number of threads to use in middle pass"), N_("COUNT"));
 969   DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
 970               N_("Number of threads to use in final pass"), N_("COUNT"));
 971
 972   DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
 973                 N_("Set the address of the bss segment"), N_("ADDRESS"));
 974   DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
 975                 N_("Set the address of the data segment"), N_("ADDRESS"));
 976   DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
 977                 N_("Set the address of the text segment"), N_("ADDRESS"));
 978
 979   DEFINE_set(undefined, options::TWO_DASHES, 'u',
 980              N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
 981
 982   DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
 983               N_("Synonym for --debug=files"), NULL);
 984
 985   DEFINE_special(version_script, options::TWO_DASHES, '\0',
 986                  N_("Read version script"), N_("FILE"));
 987
 988   DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
 989               N_("Warn about duplicate common symbols"),
 990               N_("Do not warn about duplicate common symbols (default)"));
 991
 992   DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
 993               N_("Ignored"), N_("Ignored"));
 994
 995   DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
 996               N_("Ignored"), NULL);
 997
 998   DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
 999               N_("Warn when skipping an incompatible library"),
1000               N_("Don't warn when skipping an incompatible library"));
1001
1002   DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1003               N_("Warn if text segment is not shareable"),
1004               N_("Do not warn if text segment is not shareable (default)"));
1005
1006   DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1007               N_("Report unresolved symbols as warnings"),
1008               NULL);
1009   DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1010                     options::TWO_DASHES, '\0',
1011                     N_("Report unresolved symbols as errors"),
1012                     NULL, true);
1013
1014   DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1015               N_("Include all archive contents"),
1016               N_("Include only needed archive contents"));
1017
1018   DEFINE_set(wrap, options::TWO_DASHES, '\0',
1019              N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1020
1021   DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1022              N_("Trace references to symbol"), N_("SYMBOL"));
1023
1024   DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1025               N_("Allow unused version in script (default)"),
1026               N_("Do not allow unused version in script"));
1027
1028   DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1029                 N_("Default search path for Solaris compatibility"),
1030                 N_("PATH"));
1031
1032   DEFINE_special(start_group, options::TWO_DASHES, '(',
1033                  N_("Start a library search group"), NULL);
1034   DEFINE_special(end_group, options::TWO_DASHES, ')',
1035                  N_("End a library search group"), NULL);
1036
1037
1038   DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1039                  N_("Start a library"), NULL);
1040   DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1041                  N_("End a library "), NULL);
1042
1043   // The -z options.
1044
1045   DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1046               N_("Sort dynamic relocs"),
1047               N_("Do not sort dynamic relocs"));
1048   DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1049                 N_("Set common page size to SIZE"), N_("SIZE"));
1050   DEFINE_bool(defs, options::DASH_Z, '\0', false,
1051               N_("Report undefined symbols (even with --shared)"),
1052               NULL);
1053   DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1054               N_("Mark output as requiring executable stack"), NULL);
1055   DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1056               N_("Mark DSO to be initialized first at runtime"),
1057               NULL);
1058   DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1059               N_("Mark object to interpose all DSOs but executable"),
1060               NULL);
1061   DEFINE_bool(lazy, options::DASH_Z, '\0', false,
1062               N_("Mark object for lazy runtime binding (default)"),
1063               NULL);
1064   DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1065               N_("Mark object requiring immediate process"),
1066               NULL);
1067   DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1068                 N_("Set maximum page size to SIZE"), N_("SIZE"));
1069   DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1070               N_("Allow multiple definitions of symbols"),
1071               NULL);
1072   // copyreloc is here in the list because there is only -z
1073   // nocopyreloc, not -z copyreloc.
1074   DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1075               NULL,
1076               N_("Do not create copy relocs"));
1077   DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1078               N_("Mark object not to use default search paths"),
1079               NULL);
1080   DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1081               N_("Mark DSO non-deletable at runtime"),
1082               NULL);
1083   DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1084               N_("Mark DSO not available to dlopen"),
1085               NULL);
1086   DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1087               N_("Mark DSO not available to dldump"),
1088               NULL);
1089   DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1090               N_("Mark output as not requiring executable stack"), NULL);
1091   DEFINE_bool(now, options::DASH_Z, '\0', false,
1092               N_("Mark object for immediate function binding"),
1093               NULL);
1094   DEFINE_bool(origin, options::DASH_Z, '\0', false,
1095               N_("Mark DSO to indicate that needs immediate $ORIGIN "
1096                  "processing at runtime"), NULL);
1097   DEFINE_bool(relro, options::DASH_Z, '\0', false,
1098               N_("Where possible mark variables read-only after relocation"),
1099               N_("Don't mark variables read-only after relocation"));
1100   DEFINE_bool(text, options::DASH_Z, '\0', false,
1101               N_("Do not permit relocations in read-only segments"),
1102               NULL);
1103   DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1104                     N_("Permit relocations in read-only segments (default)"),
1105                     NULL, true);
1106
1107  public:
1108   typedef options::Dir_list Dir_list;
1109
1110   General_options();
1111
1112   // Does post-processing on flags, making sure they all have
1113   // non-conflicting values.  Also converts some flags from their
1114   // "standard" types (string, etc), to another type (enum, DirList),
1115   // which can be accessed via a separate method.  Dies if it notices
1116   // any problems.
1117   void finalize();
1118
1119   // True if we printed the version information.
1120   bool
1121   printed_version() const
1122   { return this->printed_version_; }
1123
1124   // The macro defines output() (based on --output), but that's a
1125   // generic name.  Provide this alternative name, which is clearer.
1126   const char*
1127   output_file_name() const
1128   { return this->output(); }
1129
1130   // This is not defined via a flag, but combines flags to say whether
1131   // the output is position-independent or not.
1132   bool
1133   output_is_position_independent() const
1134   { return this->shared() || this->pie(); }
1135
1136   // Return true if the output is something that can be exec()ed, such
1137   // as a static executable, or a position-dependent or
1138   // position-independent executable, but not a dynamic library or an
1139   // object file.
1140   bool
1141   output_is_executable() const
1142   { return !this->shared() && !this->relocatable(); }
1143
1144   // This would normally be static(), and defined automatically, but
1145   // since static is a keyword, we need to come up with our own name.
1146   bool
1147   is_static() const
1148   { return static_; }
1149
1150   // In addition to getting the input and output formats as a string
1151   // (via format() and oformat()), we also give access as an enum.
1152   enum Object_format
1153   {
1154     // Ordinary ELF.
1155     OBJECT_FORMAT_ELF,
1156     // Straight binary format.
1157     OBJECT_FORMAT_BINARY
1158   };
1159
1160   // Convert a string to an Object_format.  Gives an error if the
1161   // string is not recognized.
1162   static Object_format
1163   string_to_object_format(const char* arg);
1164
1165   // Note: these functions are not very fast.
1166   Object_format format_enum() const;
1167   Object_format oformat_enum() const;
1168
1169   // Return whether FILENAME is in a system directory.
1170   bool
1171   is_in_system_directory(const std::string& name) const;
1172
1173   // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1174   bool
1175   should_retain_symbol(const char* symbol_name) const
1176     {
1177       if (symbols_to_retain_.empty())    // means flag wasn't specified
1178         return true;
1179       return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1180     }
1181
1182   // These are the best way to get access to the execstack state,
1183   // not execstack() and noexecstack() which are hard to use properly.
1184   bool
1185   is_execstack_set() const
1186   { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1187
1188   bool
1189   is_stack_executable() const
1190   { return this->execstack_status_ == EXECSTACK_YES; }
1191
1192   bool
1193   icf_enabled() const
1194   { return this->icf_status_ != ICF_NONE; }
1195
1196   bool
1197   icf_safe_folding() const
1198   { return this->icf_status_ == ICF_SAFE; }
1199
1200   // The --demangle option takes an optional string, and there is also
1201   // a --no-demangle option.  This is the best way to decide whether
1202   // to demangle or not.
1203   bool
1204   do_demangle() const
1205   { return this->do_demangle_; }
1206
1207   // Returns TRUE if any plugin libraries have been loaded.
1208   bool
1209   has_plugins() const
1210   { return this->plugins_ != NULL; }
1211
1212   // Return a pointer to the plugin manager.
1213   Plugin_manager*
1214   plugins() const
1215   { return this->plugins_; }
1216
1217   // True iff SYMBOL was found in the file specified by dynamic-list.
1218   bool
1219   in_dynamic_list(const char* symbol) const
1220   { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1221
1222   // Finalize the dynamic list.
1223   void
1224   finalize_dynamic_list()
1225   { this->dynamic_list_.version_script_info()->finalize(); }
1226
1227   // The disposition given by the --incremental-changed,
1228   // --incremental-unchanged or --incremental-unknown option.  The
1229   // value may change as we proceed parsing the command line flags.
1230   Incremental_disposition
1231   incremental_disposition() const
1232   { return this->incremental_disposition_; }
1233
1234   // Return true if S is the name of a library excluded from automatic
1235   // symbol export.
1236   bool
1237   check_excluded_libs (const std::string &s) const;
1238
1239   // If an explicit start address was given for section SECNAME with
1240   // the --section-start option, return true and set *PADDR to the
1241   // address.  Otherwise return false.
1242   bool
1243   section_start(const char* secname, uint64_t* paddr) const;
1244
1245   enum Fix_v4bx
1246   {
1247     // Leave original instruction.
1248     FIX_V4BX_NONE,
1249     // Replace instruction.
1250     FIX_V4BX_REPLACE,
1251     // Generate an interworking veneer.
1252     FIX_V4BX_INTERWORKING
1253   };
1254
1255   Fix_v4bx
1256   fix_v4bx() const
1257   { return (this->fix_v4bx_); }
1258
1259  private:
1260   // Don't copy this structure.
1261   General_options(const General_options&);
1262   General_options& operator=(const General_options&);
1263
1264   // Whether to mark the stack as executable.
1265   enum Execstack
1266   {
1267     // Not set on command line.
1268     EXECSTACK_FROM_INPUT,
1269     // Mark the stack as executable (-z execstack).
1270     EXECSTACK_YES,
1271     // Mark the stack as not executable (-z noexecstack).
1272     EXECSTACK_NO
1273   };
1274
1275   enum Icf_status
1276   {
1277     // Do not fold any functions (Default or --icf=none).
1278     ICF_NONE,
1279     // All functions are candidates for folding. (--icf=all).
1280     ICF_ALL,
1281     // Only ctors and dtors are candidates for folding. (--icf=safe).
1282     ICF_SAFE
1283   };
1284
1285   void
1286   set_icf_status(Icf_status value)
1287   { this->icf_status_ = value; }
1288
1289   void
1290   set_execstack_status(Execstack value)
1291   { this->execstack_status_ = value; }
1292
1293   void
1294   set_do_demangle(bool value)
1295   { this->do_demangle_ = value; }
1296
1297   void
1298   set_static(bool value)
1299   { static_ = value; }
1300
1301   // These are called by finalize() to set up the search-path correctly.
1302   void
1303   add_to_library_path_with_sysroot(const char* arg)
1304   { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1305
1306   // Apply any sysroot to the directory lists.
1307   void
1308   add_sysroot();
1309
1310   // Add a plugin and its arguments to the list of plugins.
1311   void
1312   add_plugin(const char *filename);
1313
1314   // Add a plugin option.
1315   void
1316   add_plugin_option(const char* opt);
1317
1318   // Whether we printed version information.
1319   bool printed_version_;
1320   // Whether to mark the stack as executable.
1321   Execstack execstack_status_;
1322   // Whether to do code folding.
1323   Icf_status icf_status_;
1324   // Whether to do a static link.
1325   bool static_;
1326   // Whether to do demangling.
1327   bool do_demangle_;
1328   // List of plugin libraries.
1329   Plugin_manager* plugins_;
1330   // The parsed output of --dynamic-list files.  For convenience in
1331   // script.cc, we store this as a Script_options object, even though
1332   // we only use a single Version_tree from it.
1333   Script_options dynamic_list_;
1334   // The disposition given by the --incremental-changed,
1335   // --incremental-unchanged or --incremental-unknown option.  The
1336   // value may change as we proceed parsing the command line flags.
1337   Incremental_disposition incremental_disposition_;
1338   // Whether we have seen one of the options that require incremental
1339   // build (--incremental-changed, --incremental-unchanged or
1340   // --incremental-unknown)
1341   bool implicit_incremental_;
1342   // Libraries excluded from automatic export, via --exclude-libs.
1343   Unordered_set<std::string> excluded_libs_;
1344   // List of symbol-names to keep, via -retain-symbol-info.
1345   Unordered_set<std::string> symbols_to_retain_;
1346   // Map from section name to address from --section-start.
1347   std::map<std::string, uint64_t> section_starts_;
1348   // Whether to process armv4 bx instruction relocation.
1349   Fix_v4bx fix_v4bx_;
1350 };
1351
1352 // The position-dependent options.  We use this to store the state of
1353 // the commandline at a particular point in parsing for later
1354 // reference.  For instance, if we see "ld --whole-archive foo.a
1355 // --no-whole-archive," we want to store the whole-archive option with
1356 // foo.a, so when the time comes to parse foo.a we know we should do
1357 // it in whole-archive mode.  We could store all of General_options,
1358 // but that's big, so we just pick the subset of flags that actually
1359 // change in a position-dependent way.
1360
1361 #define DEFINE_posdep(varname__, type__)        \
1362  public:                                        \
1363   type__                                        \
1364   varname__() const                             \
1365   { return this->varname__##_; }                \
1366                                                 \
1367   void                                          \
1368   set_##varname__(type__ value)                 \
1369   { this->varname__##_ = value; }               \
1370  private:                                       \
1371   type__ varname__##_
1372
1373 class Position_dependent_options
1374 {
1375  public:
1376   Position_dependent_options(const General_options& options
1377                              = Position_dependent_options::default_options_)
1378   { copy_from_options(options); }
1379
1380   void copy_from_options(const General_options& options)
1381   {
1382     this->set_as_needed(options.as_needed());
1383     this->set_Bdynamic(options.Bdynamic());
1384     this->set_format_enum(options.format_enum());
1385     this->set_whole_archive(options.whole_archive());
1386     this->set_incremental_disposition(options.incremental_disposition());
1387   }
1388
1389   DEFINE_posdep(as_needed, bool);
1390   DEFINE_posdep(Bdynamic, bool);
1391   DEFINE_posdep(format_enum, General_options::Object_format);
1392   DEFINE_posdep(whole_archive, bool);
1393   DEFINE_posdep(incremental_disposition, Incremental_disposition);
1394
1395  private:
1396   // This is a General_options with everything set to its default
1397   // value.  A Position_dependent_options created with no argument
1398   // will take its values from here.
1399   static General_options default_options_;
1400 };
1401
1402
1403 // A single file or library argument from the command line.
1404
1405 class Input_file_argument
1406 {
1407  public:
1408   enum Input_file_type
1409   {
1410     // A regular file, name used as-is, not searched.
1411     INPUT_FILE_TYPE_FILE,
1412     // A library name.  When used, "lib" will be prepended and ".so" or
1413     // ".a" appended to make a filename, and that filename will be searched
1414     // for using the -L paths.
1415     INPUT_FILE_TYPE_LIBRARY,
1416     // A regular file, name used as-is, but searched using the -L paths.
1417     INPUT_FILE_TYPE_SEARCHED_FILE
1418   };
1419
1420   // name: file name or library name
1421   // type: the type of this input file.
1422   // extra_search_path: an extra directory to look for the file, prior
1423   //         to checking the normal library search path.  If this is "",
1424   //         then no extra directory is added.
1425   // just_symbols: whether this file only defines symbols.
1426   // options: The position dependent options at this point in the
1427   //         command line, such as --whole-archive.
1428   Input_file_argument()
1429     : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1430       just_symbols_(false), options_()
1431   { }
1432
1433   Input_file_argument(const char* name, Input_file_type type,
1434                       const char* extra_search_path,
1435                       bool just_symbols,
1436                       const Position_dependent_options& options)
1437     : name_(name), type_(type), extra_search_path_(extra_search_path),
1438       just_symbols_(just_symbols), options_(options)
1439   { }
1440
1441   // You can also pass in a General_options instance instead of a
1442   // Position_dependent_options.  In that case, we extract the
1443   // position-independent vars from the General_options and only store
1444   // those.
1445   Input_file_argument(const char* name, Input_file_type type,
1446                       const char* extra_search_path,
1447                       bool just_symbols,
1448                       const General_options& options)
1449     : name_(name), type_(type), extra_search_path_(extra_search_path),
1450       just_symbols_(just_symbols), options_(options)
1451   { }
1452
1453   const char*
1454   name() const
1455   { return this->name_.c_str(); }
1456
1457   const Position_dependent_options&
1458   options() const
1459   { return this->options_; }
1460
1461   bool
1462   is_lib() const
1463   { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1464
1465   bool
1466   is_searched_file() const
1467   { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1468
1469   const char*
1470   extra_search_path() const
1471   {
1472     return (this->extra_search_path_.empty()
1473             ? NULL
1474             : this->extra_search_path_.c_str());
1475   }
1476
1477   // Return whether we should only read symbols from this file.
1478   bool
1479   just_symbols() const
1480   { return this->just_symbols_; }
1481
1482   // Return whether this file may require a search using the -L
1483   // options.
1484   bool
1485   may_need_search() const
1486   {
1487     return (this->is_lib()
1488             || this->is_searched_file()
1489             || !this->extra_search_path_.empty());
1490   }
1491
1492  private:
1493   // We use std::string, not const char*, here for convenience when
1494   // using script files, so that we do not have to preserve the string
1495   // in that case.
1496   std::string name_;
1497   Input_file_type type_;
1498   std::string extra_search_path_;
1499   bool just_symbols_;
1500   Position_dependent_options options_;
1501 };
1502
1503 // A file or library, or a group, from the command line.
1504
1505 class Input_argument
1506 {
1507  public:
1508   // Create a file or library argument.
1509   explicit Input_argument(Input_file_argument file)
1510     : is_file_(true), file_(file), group_(NULL), lib_(NULL)
1511   { }
1512
1513   // Create a group argument.
1514   explicit Input_argument(Input_file_group* group)
1515     : is_file_(false), group_(group), lib_(NULL)
1516   { }
1517
1518   // Create a lib argument.
1519   explicit Input_argument(Input_file_lib* lib)
1520     : is_file_(false), group_(NULL), lib_(lib)
1521   { }
1522
1523   // Return whether this is a file.
1524   bool
1525   is_file() const
1526   { return this->is_file_; }
1527
1528   // Return whether this is a group.
1529   bool
1530   is_group() const
1531   { return !this->is_file_ && this->lib_ == NULL; }
1532
1533   // Return whether this is a lib.
1534   bool
1535   is_lib() const
1536   { return this->lib_ != NULL; }
1537
1538   // Return the information about the file.
1539   const Input_file_argument&
1540   file() const
1541   {
1542     gold_assert(this->is_file_);
1543     return this->file_;
1544   }
1545
1546   // Return the information about the group.
1547   const Input_file_group*
1548   group() const
1549   {
1550     gold_assert(!this->is_file_);
1551     return this->group_;
1552   }
1553
1554   Input_file_group*
1555   group()
1556   {
1557     gold_assert(!this->is_file_);
1558     return this->group_;
1559   }
1560
1561   // Return the information about the lib.
1562   const Input_file_lib*
1563   lib() const
1564   {
1565     gold_assert(!this->is_file_);
1566     gold_assert(this->lib_);
1567     return this->lib_;
1568   }
1569
1570   Input_file_lib*
1571   lib()
1572   {
1573     gold_assert(!this->is_file_);
1574     gold_assert(this->lib_);
1575     return this->lib_;
1576   }
1577
1578  private:
1579   bool is_file_;
1580   Input_file_argument file_;
1581   Input_file_group* group_;
1582   Input_file_lib* lib_;
1583 };
1584
1585 typedef std::vector<Input_argument> Input_argument_list;
1586
1587 // A group from the command line.  This is a set of arguments within
1588 // --start-group ... --end-group.
1589
1590 class Input_file_group
1591 {
1592  public:
1593   typedef Input_argument_list::const_iterator const_iterator;
1594
1595   Input_file_group()
1596     : files_()
1597   { }
1598
1599   // Add a file to the end of the group.
1600   void
1601   add_file(const Input_file_argument& arg)
1602   { this->files_.push_back(Input_argument(arg)); }
1603
1604   // Iterators to iterate over the group contents.
1605
1606   const_iterator
1607   begin() const
1608   { return this->files_.begin(); }
1609
1610   const_iterator
1611   end() const
1612   { return this->files_.end(); }
1613
1614  private:
1615   Input_argument_list files_;
1616 };
1617
1618 // A lib from the command line.  This is a set of arguments within
1619 // --start-lib ... --end-lib.
1620
1621 class Input_file_lib
1622 {
1623  public:
1624   typedef Input_argument_list::const_iterator const_iterator;
1625
1626   Input_file_lib(const Position_dependent_options& options)
1627     : files_(), options_(options)
1628   { }
1629
1630   // Add a file to the end of the lib.
1631   void
1632   add_file(const Input_file_argument& arg)
1633   { this->files_.push_back(Input_argument(arg)); }
1634
1635   const Position_dependent_options&
1636   options() const
1637   { return this->options_; }
1638
1639   // Iterators to iterate over the lib contents.
1640
1641   const_iterator
1642   begin() const
1643   { return this->files_.begin(); }
1644
1645   const_iterator
1646   end() const
1647   { return this->files_.end(); }
1648
1649   size_t
1650   size() const
1651   { return this->files_.size(); }
1652
1653  private:
1654   Input_argument_list files_;
1655   Position_dependent_options options_;
1656 };
1657
1658 // A list of files from the command line or a script.
1659
1660 class Input_arguments
1661 {
1662  public:
1663   typedef Input_argument_list::const_iterator const_iterator;
1664
1665   Input_arguments()
1666     : input_argument_list_(), in_group_(false), in_lib_(false)
1667   { }
1668
1669   // Add a file.
1670   void
1671   add_file(const Input_file_argument& arg);
1672
1673   // Start a group (the --start-group option).
1674   void
1675   start_group();
1676
1677   // End a group (the --end-group option).
1678   void
1679   end_group();
1680
1681   // Start a lib (the --start-lib option).
1682   void
1683   start_lib(const Position_dependent_options&);
1684
1685   // End a lib (the --end-lib option).
1686   void
1687   end_lib();
1688
1689   // Return whether we are currently in a group.
1690   bool
1691   in_group() const
1692   { return this->in_group_; }
1693
1694   // Return whether we are currently in a lib.
1695   bool
1696   in_lib() const
1697   { return this->in_lib_; }
1698
1699   // The number of entries in the list.
1700   int
1701   size() const
1702   { return this->input_argument_list_.size(); }
1703
1704   // Iterators to iterate over the list of input files.
1705
1706   const_iterator
1707   begin() const
1708   { return this->input_argument_list_.begin(); }
1709
1710   const_iterator
1711   end() const
1712   { return this->input_argument_list_.end(); }
1713
1714   // Return whether the list is empty.
1715   bool
1716   empty() const
1717   { return this->input_argument_list_.empty(); }
1718
1719  private:
1720   Input_argument_list input_argument_list_;
1721   bool in_group_;
1722   bool in_lib_;
1723 };
1724
1725
1726 // All the information read from the command line.  These are held in
1727 // three separate structs: one to hold the options (--foo), one to
1728 // hold the filenames listed on the commandline, and one to hold
1729 // linker script information.  This third is not a subset of the other
1730 // two because linker scripts can be specified either as options (via
1731 // -T) or as a file.
1732
1733 class Command_line
1734 {
1735  public:
1736   typedef Input_arguments::const_iterator const_iterator;
1737
1738   Command_line();
1739
1740   // Process the command line options.  This will exit with an
1741   // appropriate error message if an unrecognized option is seen.
1742   void
1743   process(int argc, const char** argv);
1744
1745   // Process one command-line option.  This takes the index of argv to
1746   // process, and returns the index for the next option.  no_more_options
1747   // is set to true if argv[i] is "--".
1748   int
1749   process_one_option(int argc, const char** argv, int i,
1750                      bool* no_more_options);
1751
1752   // Get the general options.
1753   const General_options&
1754   options() const
1755   { return this->options_; }
1756
1757   // Get the position dependent options.
1758   const Position_dependent_options&
1759   position_dependent_options() const
1760   { return this->position_options_; }
1761
1762   // Get the linker-script options.
1763   Script_options&
1764   script_options()
1765   { return this->script_options_; }
1766
1767   // Finalize the version-script options and return them.
1768   const Version_script_info&
1769   version_script();
1770
1771   // Get the input files.
1772   Input_arguments&
1773   inputs()
1774   { return this->inputs_; }
1775
1776   // The number of input files.
1777   int
1778   number_of_input_files() const
1779   { return this->inputs_.size(); }
1780
1781   // Iterators to iterate over the list of input files.
1782
1783   const_iterator
1784   begin() const
1785   { return this->inputs_.begin(); }
1786
1787   const_iterator
1788   end() const
1789   { return this->inputs_.end(); }
1790
1791  private:
1792   Command_line(const Command_line&);
1793   Command_line& operator=(const Command_line&);
1794
1795   // This is a dummy class to provide a constructor that runs before
1796   // the constructor for the General_options.  The Pre_options constructor
1797   // is used as a hook to set the flag enabling the options to register
1798   // themselves.
1799   struct Pre_options {
1800     Pre_options();
1801   };
1802
1803   // This must come before options_!
1804   Pre_options pre_options_;
1805   General_options options_;
1806   Position_dependent_options position_options_;
1807   Script_options script_options_;
1808   Input_arguments inputs_;
1809 };
1810
1811 } // End namespace gold.
1812
1813 #endif // !defined(GOLD_OPTIONS_H)