gold/options.h

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