gold/options.h

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