gold/options.h

   1 // options.h -- handle command line options for gold  -*- C++ -*-
   2
   3 // Copyright 2006, 2007, 2008, 2009, 2010, 2011 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 used for non-standard flags.  It defines no functions; it
 502 // just calls General_options::parse_VARNAME whenever the flag is
 503 // seen.  We declare parse_VARNAME as a static member of
 504 // General_options; you are responsible for defining it there.
 505 // helparg__ should be NULL iff this special-option is a boolean.
 506 #define DEFINE_special(varname__, dashes__, shortname__,                \
 507                        helpstring__, helparg__)                         \
 508  private:                                                               \
 509   void parse_##varname__(const char* option, const char* arg,           \
 510                          Command_line* inputs);                         \
 511   struct Struct_##varname__ : public options::Struct_special            \
 512   {                                                                     \
 513     Struct_##varname__()                                                \
 514       : options::Struct_special(#varname__, dashes__, shortname__,      \
 515                                 &General_options::parse_##varname__,    \
 516                                 helpstring__, helparg__)                \
 517     { }                                                                 \
 518   };                                                                    \
 519   Struct_##varname__ varname__##_initializer_
 520
 521 // An option that takes an optional string argument.  If the option is
 522 // used with no argument, the value will be the default, and
 523 // user_set_via_option will be true.
 524 #define DEFINE_optional_string(varname__, dashes__, shortname__,        \
 525                                default_value__,                         \
 526                                helpstring__, helparg__)                 \
 527   DEFINE_var(varname__, dashes__, shortname__, default_value__,         \
 528              default_value__, helpstring__, helparg__, true,            \
 529              const char*, const char*, options::parse_optional_string)
 530
 531 // A directory to search.  For each directory we record whether it is
 532 // in the sysroot.  We need to know this so that, if a linker script
 533 // is found within the sysroot, we will apply the sysroot to any files
 534 // named by that script.
 535
 536 class Search_directory
 537 {
 538  public:
 539   // We need a default constructor because we put this in a
 540   // std::vector.
 541   Search_directory()
 542     : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
 543   { }
 544
 545   // This is the usual constructor.
 546   Search_directory(const std::string& name, bool put_in_sysroot)
 547     : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
 548   {
 549     if (this->name_.empty())
 550       this->name_ = ".";
 551   }
 552
 553   // This is called if we have a sysroot.  The sysroot is prefixed to
 554   // any entries for which put_in_sysroot_ is true.  is_in_sysroot_ is
 555   // set to true for any enries which are in the sysroot (this will
 556   // naturally include any entries for which put_in_sysroot_ is true).
 557   // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
 558   // passing SYSROOT to lrealpath.
 559   void
 560   add_sysroot(const char* sysroot, const char* canonical_sysroot);
 561
 562   // Get the directory name.
 563   const std::string&
 564   name() const
 565   { return this->name_; }
 566
 567   // Return whether this directory is in the sysroot.
 568   bool
 569   is_in_sysroot() const
 570   { return this->is_in_sysroot_; }
 571
 572   // Return whether this is considered a system directory.
 573   bool
 574   is_system_directory() const
 575   { return this->put_in_sysroot_ || this->is_in_sysroot_; }
 576
 577  private:
 578   // The directory name.
 579   std::string name_;
 580   // True if the sysroot should be added as a prefix for this
 581   // directory (if there is a sysroot).  This is true for system
 582   // directories that we search by default.
 583   bool put_in_sysroot_;
 584   // True if this directory is in the sysroot (if there is a sysroot).
 585   // This is true if there is a sysroot and either 1) put_in_sysroot_
 586   // is true, or 2) the directory happens to be in the sysroot based
 587   // on a pathname comparison.
 588   bool is_in_sysroot_;
 589 };
 590
 591 class General_options
 592 {
 593  private:
 594   // NOTE: For every option that you add here, also consider if you
 595   // should add it to Position_dependent_options.
 596   DEFINE_special(help, options::TWO_DASHES, '\0',
 597                  N_("Report usage information"), NULL);
 598   DEFINE_special(version, options::TWO_DASHES, 'v',
 599                  N_("Report version information"), NULL);
 600   DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
 601                  N_("Report version and target information"), NULL);
 602
 603   // These options are sorted approximately so that for each letter in
 604   // the alphabet, we show the option whose shortname is that letter
 605   // (if any) and then every longname that starts with that letter (in
 606   // alphabetical order).  For both, lowercase sorts before uppercase.
 607   // The -z options come last.
 608
 609   DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
 610               N_("Not supported"),
 611               N_("Do not copy DT_NEEDED tags from shared libraries"));
 612
 613   DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
 614                     '\0', N_("Allow multiple definitions of symbols"),
 615                     N_("Do not allow multiple definitions"), false);
 616
 617   DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
 618               N_("Allow unresolved references in shared libraries"),
 619               N_("Do not allow unresolved references in shared libraries"));
 620
 621   DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
 622               N_("Only set DT_NEEDED for shared libraries if used"),
 623               N_("Always DT_NEEDED for shared libraries"));
 624
 625   DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
 626               N_("Ignored"), N_("[ignored]"),
 627               {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
 628
 629   // This should really be an "enum", but it's too easy for folks to
 630   // forget to update the list as they add new targets.  So we just
 631   // accept any string.  We'll fail later (when the string is parsed),
 632   // if the target isn't actually supported.
 633   DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
 634                 N_("Set input format"), ("[elf,binary]"));
 635
 636   DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
 637               N_("-l searches for shared libraries"), NULL);
 638   DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
 639                     N_("-l does not search for shared libraries"), NULL,
 640                     true);
 641   DEFINE_bool_alias(dy, Bdynamic, options::ONE_DASH, '\0',
 642                     N_("alias for -Bdynamic"), NULL, false);
 643   DEFINE_bool_alias(dn, Bdynamic, options::ONE_DASH, '\0',
 644                     N_("alias for -Bstatic"), NULL, true);
 645
 646   DEFINE_bool(Bgroup, options::ONE_DASH, '\0', false,
 647               N_("Use group name lookup rules for shared library"), NULL);
 648
 649   DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
 650               N_("Bind defined symbols locally"), NULL);
 651
 652   DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
 653               N_("Bind defined function symbols locally"), NULL);
 654
 655   DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
 656                          N_("Generate build ID note"),
 657                          N_("[=STYLE]"));
 658
 659   DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
 660               N_("Check segment addresses for overlaps (default)"),
 661               N_("Do not check segment addresses for overlaps"));
 662
 663 #ifdef HAVE_ZLIB_H
 664   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
 665               N_("Compress .debug_* sections in the output file"),
 666               ("[none,zlib]"),
 667               {"none", "zlib"});
 668 #else
 669   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
 670               N_("Compress .debug_* sections in the output file"),
 671               N_("[none]"),
 672               {"none"});
 673 #endif
 674
 675   DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
 676               N_("Not supported"),
 677               N_("Do not copy DT_NEEDED tags from shared libraries"));
 678
 679   DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
 680               N_("Output cross reference table"),
 681               N_("Do not output cross reference table"));
 682
 683   DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
 684               N_("Use DT_INIT_ARRAY for all constructors (default)"),
 685               N_("Handle constructors as directed by compiler"));
 686
 687   DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
 688               N_("Define common symbols"),
 689               N_("Do not define common symbols"));
 690   DEFINE_bool(dc, options::ONE_DASH, '\0', false,
 691               N_("Alias for -d"), NULL);
 692   DEFINE_bool(dp, options::ONE_DASH, '\0', false,
 693               N_("Alias for -d"), NULL);
 694
 695   DEFINE_string(debug, options::TWO_DASHES, '\0', "",
 696                 N_("Turn on debugging"),
 697                 N_("[all,files,script,task][,...]"));
 698
 699   DEFINE_special(defsym, options::TWO_DASHES, '\0',
 700                  N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
 701
 702   DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
 703                          N_("Demangle C++ symbols in log messages"),
 704                          N_("[=STYLE]"));
 705
 706   DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
 707               N_("Do not demangle C++ symbols in log messages"),
 708               NULL);
 709
 710   DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
 711               N_("Look for violations of the C++ One Definition Rule"),
 712               N_("Do not look for violations of the C++ One Definition Rule"));
 713
 714   DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
 715               N_("Delete all local symbols"), NULL);
 716   DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
 717               N_("Delete all temporary local symbols"), NULL);
 718
 719   DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
 720               N_("Add data symbols to dynamic symbols"), NULL);
 721
 722   DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
 723               N_("Add C++ operator new/delete to dynamic symbols"), NULL);
 724
 725   DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
 726               N_("Add C++ typeinfo to dynamic symbols"), NULL);
 727
 728   DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
 729                  N_("Read a list of dynamic symbols"), N_("FILE"));
 730
 731   DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
 732                 N_("Set program start address"), N_("ADDRESS"));
 733
 734   DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
 735                  N_("Exclude libraries from automatic export"),
 736                  N_(("lib,lib ...")));
 737
 738   DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
 739               N_("Export all dynamic symbols"),
 740               N_("Do not export all dynamic symbols (default)"));
 741
 742   DEFINE_set(export_dynamic_symbol, options::TWO_DASHES, '\0',
 743              N_("Export SYMBOL to dynamic symbol table"), N_("SYMBOL"));
 744
 745   DEFINE_special(EB, options::ONE_DASH, '\0',
 746                  N_("Link big-endian objects."), NULL);
 747
 748   DEFINE_special(EL, options::ONE_DASH, '\0',
 749                  N_("Link little-endian objects."), NULL);
 750
 751   DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
 752               N_("Create exception frame header"), NULL);
 753
 754   DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
 755               N_("(ARM only) Do not warn about objects with incompatible "
 756                  "enum sizes"));
 757
 758   DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
 759              N_("Auxiliary filter for shared object symbol table"),
 760              N_("SHLIB"));
 761
 762   DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
 763                 N_("Filter for shared object symbol table"),
 764                 N_("SHLIB"));
 765
 766   DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
 767               N_("Treat warnings as errors"),
 768               N_("Do not treat warnings as errors"));
 769
 770   DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
 771                 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
 772
 773   DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
 774               N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
 775               N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
 776
 777   DEFINE_bool(fix_arm1176, options::TWO_DASHES, '\0', true,
 778               N_("(ARM only) Fix binaries for ARM1176 erratum."),
 779               N_("(ARM only) Do not fix binaries for ARM1176 erratum."));
 780
 781   DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
 782               N_("(ARM only) Merge exidx entries in debuginfo."),
 783               N_("(ARM only) Do not merge exidx entries in debuginfo."));
 784
 785   DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
 786                  N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
 787                  NULL);
 788
 789   DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
 790                  N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
 791                     "veneer"),
 792                  NULL);
 793
 794   DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
 795               N_("Ignored"), NULL);
 796
 797   DEFINE_bool(gdb_index, options::TWO_DASHES, '\0', false,
 798               N_("Generate .gdb_index section"),
 799               N_("Do not generate .gdb_index section"));
 800
 801   DEFINE_bool(gnu_unique, options::TWO_DASHES, '\0', true,
 802               N_("Enable STB_GNU_UNIQUE symbol binding (default)"),
 803               N_("Disable STB_GNU_UNIQUE symbol binding"));
 804
 805   DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
 806                 N_("Set shared library name"), N_("FILENAME"));
 807
 808   DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
 809                 N_("Min fraction of empty buckets in dynamic hash"),
 810                 N_("FRACTION"));
 811
 812   DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
 813               N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
 814               {"sysv", "gnu", "both"});
 815
 816   DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
 817                 N_("Set dynamic linker path"), N_("PROGRAM"));
 818
 819   DEFINE_special(incremental, options::TWO_DASHES, '\0',
 820                  N_("Do an incremental link if possible; "
 821                     "otherwise, do a full link and prepare output "
 822                     "for incremental linking"), NULL);
 823
 824   DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
 825                  N_("Do a full link (default)"), NULL);
 826
 827   DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
 828                  N_("Do a full link and "
 829                     "prepare output for incremental linking"), NULL);
 830
 831   DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
 832                  N_("Do an incremental link; exit if not possible"), NULL);
 833
 834   DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
 835                 N_("Set base file for incremental linking"
 836                    " (default is output file)"),
 837                 N_("FILE"));
 838
 839   DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
 840                  N_("Assume files changed"), NULL);
 841
 842   DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
 843                  N_("Assume files didn't change"), NULL);
 844
 845   DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
 846                  N_("Use timestamps to check files (default)"), NULL);
 847
 848   DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
 849                  N_("Assume startup files unchanged "
 850                     "(files preceding this option)"), NULL);
 851
 852   DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
 853                  N_("Amount of extra space to allocate for patches"),
 854                  N_("PERCENT"));
 855
 856   DEFINE_string(init, options::ONE_DASH, '\0', "_init",
 857                 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
 858
 859   DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
 860                  N_("Read only symbol values from FILE"), N_("FILE"));
 861
 862   DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
 863               sizeof(void*) >= 8,
 864               N_("Map whole files to memory (default on 64-bit hosts)"),
 865               N_("Map relevant file parts to memory (default on 32-bit "
 866                  "hosts)"));
 867   DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
 868               N_("Keep files mapped across passes (default)"),
 869               N_("Release mapped files after each pass"));
 870
 871   DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
 872               N_("Generate unwind information for PLT (default)"),
 873               N_("Do not generate unwind information for PLT"));
 874
 875   DEFINE_special(library, options::TWO_DASHES, 'l',
 876                  N_("Search for library LIBNAME"), N_("LIBNAME"));
 877
 878   DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
 879                  N_("Add directory to search path"), N_("DIR"));
 880
 881   DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
 882               N_(" Only search directories specified on the command line."),
 883               NULL);
 884
 885   DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
 886               N_(" Put read-only non-executable sections in their own segment"),
 887               NULL);
 888
 889   DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
 890                 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
 891
 892   DEFINE_bool(mmap_output_file, options::TWO_DASHES, '\0', true,
 893               N_("Map the output file for writing (default)."),
 894               N_("Do not map the output file for writing."));
 895
 896   DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
 897               N_("Write map file on standard output"), NULL);
 898   DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
 899                 N_("MAPFILENAME"));
 900
 901   DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
 902               N_("Do not page align data"), NULL);
 903   DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
 904               N_("Do not page align data, do not make text readonly"),
 905               N_("Page align data, make text readonly"));
 906
 907   DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
 908                 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
 909                 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
 910
 911   DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
 912               N_("Create an output file even if errors occur"), NULL);
 913
 914   DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
 915                     N_("Report undefined symbols (even with --shared)"),
 916                     NULL, false);
 917
 918   DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
 919                 N_("Set output file name"), N_("FILE"));
 920
 921   DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
 922               N_("Optimize output file size"), N_("LEVEL"));
 923
 924   DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
 925                 N_("Set output format"), N_("[binary]"));
 926
 927   DEFINE_bool(p, options::ONE_DASH, '\0', false,
 928               N_("(ARM only) Ignore for backward compatibility"), NULL);
 929
 930   DEFINE_bool(pie, options::ONE_DASH, '\0', false,
 931               N_("Create a position independent executable"), NULL);
 932   DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
 933                     N_("Create a position independent executable"), NULL,
 934                     false);
 935
 936   DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
 937               NULL, N_("(ARM only) Ignore for backward compatibility"));
 938
 939 #ifdef ENABLE_PLUGINS
 940   DEFINE_special(plugin, options::TWO_DASHES, '\0',
 941                  N_("Load a plugin library"), N_("PLUGIN"));
 942   DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
 943                  N_("Pass an option to the plugin"), N_("OPTION"));
 944 #endif
 945
 946   DEFINE_bool(posix_fallocate, options::TWO_DASHES, '\0', true,
 947               N_("Use posix_fallocate to reserve space in the output file"
 948                  " (default)."),
 949               N_("Use fallocate or ftruncate to reserve space."));
 950
 951   DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
 952               N_("Preread archive symbols when multi-threaded"), NULL);
 953
 954   DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
 955               N_("Print default output format"), NULL);
 956
 957   DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
 958                 N_("Print symbols defined and used for each input"),
 959                 N_("FILENAME"));
 960
 961   DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
 962               N_("Ignored for SVR4 compatibility"), NULL);
 963
 964   DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
 965               N_("Generate relocations in output"), NULL);
 966
 967   DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
 968               N_("Generate relocatable output"), NULL);
 969   DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
 970                     N_("Synonym for -r"), NULL, false);
 971
 972   DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
 973               N_("Relax branches on certain targets"), NULL);
 974
 975   DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
 976                 N_("keep only symbols listed in this file"), N_("FILE"));
 977
 978   // -R really means -rpath, but can mean --just-symbols for
 979   // compatibility with GNU ld.  -rpath is always -rpath, so we list
 980   // it separately.
 981   DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
 982                  N_("Add DIR to runtime search path"), N_("DIR"));
 983
 984   DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
 985                  N_("Add DIR to runtime search path"), N_("DIR"));
 986
 987   DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
 988                  N_("Add DIR to link time shared library search path"),
 989                  N_("DIR"));
 990
 991   DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
 992                 N_("Layout sections in the order specified."),
 993                 N_("FILENAME"));
 994
 995   DEFINE_special(section_start, options::TWO_DASHES, '\0',
 996                  N_("Set address of section"), N_("SECTION=ADDRESS"));
 997
 998   DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
 999                          N_("Sort common symbols by alignment"),
1000                          N_("[={ascending,descending}]"));
1001
1002   DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
1003               N_("Dynamic tag slots to reserve (default 5)"),
1004               N_("COUNT"));
1005
1006   DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
1007               N_("Strip all symbols"), NULL);
1008   DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
1009               N_("Strip debugging information"), NULL);
1010   DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
1011               N_("Emit only debug line number information"), NULL);
1012   DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
1013               N_("Strip debug symbols that are unused by gdb "
1014                  "(at least versions <= 7.4)"), NULL);
1015   DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
1016               N_("Strip LTO intermediate code sections"), NULL);
1017
1018   DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
1019              N_("(ARM only) The maximum distance from instructions in a group "
1020                 "of sections to their stubs.  Negative values mean stubs "
1021                 "are always after the group. 1 means using default size.\n"),
1022              N_("SIZE"));
1023
1024   DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
1025               N_("Use less memory and more disk I/O "
1026                  "(included only for compatibility with GNU ld)"), NULL);
1027
1028   DEFINE_bool(shared, options::ONE_DASH, 'G', false,
1029               N_("Generate shared library"), NULL);
1030
1031   DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
1032               N_("Generate shared library"), NULL);
1033
1034   DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
1035               N_("Stack size when -fsplit-stack function calls non-split"),
1036               N_("SIZE"));
1037
1038   // This is not actually special in any way, but I need to give it
1039   // a non-standard accessor-function name because 'static' is a keyword.
1040   DEFINE_special(static, options::ONE_DASH, '\0',
1041                  N_("Do not link against shared libraries"), NULL);
1042
1043   DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
1044               N_("Identical Code Folding. "
1045                  "\'--icf=safe\' Folds ctors, dtors and functions whose"
1046                  " pointers are definitely not taken."),
1047               ("[none,all,safe]"),
1048               {"none", "all", "safe"});
1049
1050   DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
1051               N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
1052
1053   DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
1054               N_("List folded identical sections on stderr"),
1055               N_("Do not list folded identical sections"));
1056
1057   DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
1058              N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1059
1060   DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
1061               N_("Remove unused sections"),
1062               N_("Don't remove unused sections (default)"));
1063
1064   DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
1065               N_("List removed unused sections on stderr"),
1066               N_("Do not list removed unused sections"));
1067
1068   DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
1069               N_("Print resource usage statistics"), NULL);
1070
1071   DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
1072                 N_("Set target system root directory"), N_("DIR"));
1073
1074   DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1075               N_("Print the name of each input file"), NULL);
1076
1077   DEFINE_special(script, options::TWO_DASHES, 'T',
1078                  N_("Read linker script"), N_("FILE"));
1079
1080   DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
1081               N_("Run the linker multi-threaded"),
1082               N_("Do not run the linker multi-threaded"));
1083   DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
1084               N_("Number of threads to use"), N_("COUNT"));
1085   DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
1086               N_("Number of threads to use in initial pass"), N_("COUNT"));
1087   DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
1088               N_("Number of threads to use in middle pass"), N_("COUNT"));
1089   DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
1090               N_("Number of threads to use in final pass"), N_("COUNT"));
1091
1092   DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1093                 N_("Set the address of the bss segment"), N_("ADDRESS"));
1094   DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1095                 N_("Set the address of the data segment"), N_("ADDRESS"));
1096   DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1097                 N_("Set the address of the text segment"), N_("ADDRESS"));
1098
1099   DEFINE_set(undefined, options::TWO_DASHES, 'u',
1100              N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1101
1102   DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1103               N_("How to handle unresolved symbols"),
1104               ("ignore-all,report-all,ignore-in-object-files,"
1105                "ignore-in-shared-libs"),
1106               {"ignore-all", "report-all", "ignore-in-object-files",
1107                   "ignore-in-shared-libs"});
1108
1109   DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1110               N_("Synonym for --debug=files"), NULL);
1111
1112   DEFINE_special(version_script, options::TWO_DASHES, '\0',
1113                  N_("Read version script"), N_("FILE"));
1114
1115   DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1116               N_("Warn about duplicate common symbols"),
1117               N_("Do not warn about duplicate common symbols (default)"));
1118
1119   DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1120               N_("Ignored"), N_("Ignored"));
1121
1122   DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1123               N_("Warn if the stack is executable"),
1124               N_("Do not warn if the stack is executable (default)"));
1125
1126   DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1127               NULL, N_("Don't warn about mismatched input files"));
1128
1129   DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1130               N_("Ignored"), NULL);
1131
1132   DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1133               N_("Warn when skipping an incompatible library"),
1134               N_("Don't warn when skipping an incompatible library"));
1135
1136   DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1137               N_("Warn if text segment is not shareable"),
1138               N_("Do not warn if text segment is not shareable (default)"));
1139
1140   DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1141               N_("Report unresolved symbols as warnings"),
1142               NULL);
1143   DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1144                     options::TWO_DASHES, '\0',
1145                     N_("Report unresolved symbols as errors"),
1146                     NULL, true);
1147
1148   DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1149               N_("(ARM only) Do not warn about objects with incompatible "
1150                  "wchar_t sizes"));
1151
1152   DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1153               N_("Include all archive contents"),
1154               N_("Include only needed archive contents"));
1155
1156   DEFINE_set(wrap, options::TWO_DASHES, '\0',
1157              N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1158
1159   DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1160              N_("Trace references to symbol"), N_("SYMBOL"));
1161
1162   DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1163               N_("Allow unused version in script (default)"),
1164               N_("Do not allow unused version in script"));
1165
1166   DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1167                 N_("Default search path for Solaris compatibility"),
1168                 N_("PATH"));
1169
1170   DEFINE_special(start_group, options::TWO_DASHES, '(',
1171                  N_("Start a library search group"), NULL);
1172   DEFINE_special(end_group, options::TWO_DASHES, ')',
1173                  N_("End a library search group"), NULL);
1174
1175
1176   DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1177                  N_("Start a library"), NULL);
1178   DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1179                  N_("End a library "), NULL);
1180
1181   // The -z options.
1182
1183   DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1184               N_("Sort dynamic relocs"),
1185               N_("Do not sort dynamic relocs"));
1186   DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1187                 N_("Set common page size to SIZE"), N_("SIZE"));
1188   DEFINE_bool(defs, options::DASH_Z, '\0', false,
1189               N_("Report undefined symbols (even with --shared)"),
1190               NULL);
1191   DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1192               N_("Mark output as requiring executable stack"), NULL);
1193   DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1194               N_("Mark DSO to be initialized first at runtime"),
1195               NULL);
1196   DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1197               N_("Mark object to interpose all DSOs but executable"),
1198               NULL);
1199   DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1200                     N_("Mark object for lazy runtime binding (default)"),
1201                     NULL, true);
1202   DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1203               N_("Mark object requiring immediate process"),
1204               NULL);
1205   DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1206                 N_("Set maximum page size to SIZE"), N_("SIZE"));
1207   DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1208               N_("Allow multiple definitions of symbols"),
1209               NULL);
1210   // copyreloc is here in the list because there is only -z
1211   // nocopyreloc, not -z copyreloc.
1212   DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1213               NULL,
1214               N_("Do not create copy relocs"));
1215   DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1216               N_("Mark object not to use default search paths"),
1217               NULL);
1218   DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1219               N_("Mark DSO non-deletable at runtime"),
1220               NULL);
1221   DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1222               N_("Mark DSO not available to dlopen"),
1223               NULL);
1224   DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1225               N_("Mark DSO not available to dldump"),
1226               NULL);
1227   DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1228               N_("Mark output as not requiring executable stack"), NULL);
1229   DEFINE_bool(now, options::DASH_Z, '\0', false,
1230               N_("Mark object for immediate function binding"),
1231               NULL);
1232   DEFINE_bool(origin, options::DASH_Z, '\0', false,
1233               N_("Mark DSO to indicate that needs immediate $ORIGIN "
1234                  "processing at runtime"), NULL);
1235   DEFINE_bool(relro, options::DASH_Z, '\0', false,
1236               N_("Where possible mark variables read-only after relocation"),
1237               N_("Don't mark variables read-only after relocation"));
1238   DEFINE_bool(text, options::DASH_Z, '\0', false,
1239               N_("Do not permit relocations in read-only segments"),
1240               N_("Permit relocations in read-only segments (default)"));
1241   DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1242                     N_("Permit relocations in read-only segments (default)"),
1243                     NULL, true);
1244
1245  public:
1246   typedef options::Dir_list Dir_list;
1247
1248   General_options();
1249
1250   // Does post-processing on flags, making sure they all have
1251   // non-conflicting values.  Also converts some flags from their
1252   // "standard" types (string, etc), to another type (enum, DirList),
1253   // which can be accessed via a separate method.  Dies if it notices
1254   // any problems.
1255   void finalize();
1256
1257   // True if we printed the version information.
1258   bool
1259   printed_version() const
1260   { return this->printed_version_; }
1261
1262   // The macro defines output() (based on --output), but that's a
1263   // generic name.  Provide this alternative name, which is clearer.
1264   const char*
1265   output_file_name() const
1266   { return this->output(); }
1267
1268   // This is not defined via a flag, but combines flags to say whether
1269   // the output is position-independent or not.
1270   bool
1271   output_is_position_independent() const
1272   { return this->shared() || this->pie(); }
1273
1274   // Return true if the output is something that can be exec()ed, such
1275   // as a static executable, or a position-dependent or
1276   // position-independent executable, but not a dynamic library or an
1277   // object file.
1278   bool
1279   output_is_executable() const
1280   { return !this->shared() && !this->relocatable(); }
1281
1282   // This would normally be static(), and defined automatically, but
1283   // since static is a keyword, we need to come up with our own name.
1284   bool
1285   is_static() const
1286   { return static_; }
1287
1288   // In addition to getting the input and output formats as a string
1289   // (via format() and oformat()), we also give access as an enum.
1290   enum Object_format
1291   {
1292     // Ordinary ELF.
1293     OBJECT_FORMAT_ELF,
1294     // Straight binary format.
1295     OBJECT_FORMAT_BINARY
1296   };
1297
1298   // Convert a string to an Object_format.  Gives an error if the
1299   // string is not recognized.
1300   static Object_format
1301   string_to_object_format(const char* arg);
1302
1303   // Note: these functions are not very fast.
1304   Object_format format_enum() const;
1305   Object_format oformat_enum() const;
1306
1307   // Return whether FILENAME is in a system directory.
1308   bool
1309   is_in_system_directory(const std::string& name) const;
1310
1311   // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1312   bool
1313   should_retain_symbol(const char* symbol_name) const
1314     {
1315       if (symbols_to_retain_.empty())    // means flag wasn't specified
1316         return true;
1317       return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1318     }
1319
1320   // These are the best way to get access to the execstack state,
1321   // not execstack() and noexecstack() which are hard to use properly.
1322   bool
1323   is_execstack_set() const
1324   { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1325
1326   bool
1327   is_stack_executable() const
1328   { return this->execstack_status_ == EXECSTACK_YES; }
1329
1330   bool
1331   icf_enabled() const
1332   { return this->icf_status_ != ICF_NONE; }
1333
1334   bool
1335   icf_safe_folding() const
1336   { return this->icf_status_ == ICF_SAFE; }
1337
1338   // The --demangle option takes an optional string, and there is also
1339   // a --no-demangle option.  This is the best way to decide whether
1340   // to demangle or not.
1341   bool
1342   do_demangle() const
1343   { return this->do_demangle_; }
1344
1345   // Returns TRUE if any plugin libraries have been loaded.
1346   bool
1347   has_plugins() const
1348   { return this->plugins_ != NULL; }
1349
1350   // Return a pointer to the plugin manager.
1351   Plugin_manager*
1352   plugins() const
1353   { return this->plugins_; }
1354
1355   // True iff SYMBOL was found in the file specified by dynamic-list.
1356   bool
1357   in_dynamic_list(const char* symbol) const
1358   { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1359
1360   // Finalize the dynamic list.
1361   void
1362   finalize_dynamic_list()
1363   { this->dynamic_list_.version_script_info()->finalize(); }
1364
1365   // The mode selected by the --incremental options.
1366   enum Incremental_mode
1367   {
1368     // No incremental linking (--no-incremental).
1369     INCREMENTAL_OFF,
1370     // Incremental update only (--incremental-update).
1371     INCREMENTAL_UPDATE,
1372     // Force a full link, but prepare for subsequent incremental link
1373     // (--incremental-full).
1374     INCREMENTAL_FULL,
1375     // Incremental update if possible, fallback to full link  (--incremental).
1376     INCREMENTAL_AUTO
1377   };
1378
1379   // The incremental linking mode.
1380   Incremental_mode
1381   incremental_mode() const
1382   { return this->incremental_mode_; }
1383
1384   // The disposition given by the --incremental-changed,
1385   // --incremental-unchanged or --incremental-unknown option.  The
1386   // value may change as we proceed parsing the command line flags.
1387   Incremental_disposition
1388   incremental_disposition() const
1389   { return this->incremental_disposition_; }
1390
1391   // The disposition to use for startup files (those that precede the
1392   // first --incremental-changed, etc. option).
1393   Incremental_disposition
1394   incremental_startup_disposition() const
1395   { return this->incremental_startup_disposition_; }
1396
1397   // Return true if S is the name of a library excluded from automatic
1398   // symbol export.
1399   bool
1400   check_excluded_libs(const std::string &s) const;
1401
1402   // If an explicit start address was given for section SECNAME with
1403   // the --section-start option, return true and set *PADDR to the
1404   // address.  Otherwise return false.
1405   bool
1406   section_start(const char* secname, uint64_t* paddr) const;
1407
1408   // Return whether any --section-start option was used.
1409   bool
1410   any_section_start() const
1411   { return !this->section_starts_.empty(); }
1412
1413   enum Fix_v4bx
1414   {
1415     // Leave original instruction.
1416     FIX_V4BX_NONE,
1417     // Replace instruction.
1418     FIX_V4BX_REPLACE,
1419     // Generate an interworking veneer.
1420     FIX_V4BX_INTERWORKING
1421   };
1422
1423   Fix_v4bx
1424   fix_v4bx() const
1425   { return (this->fix_v4bx_); }
1426
1427   enum Endianness
1428   {
1429     ENDIANNESS_NOT_SET,
1430     ENDIANNESS_BIG,
1431     ENDIANNESS_LITTLE
1432   };
1433
1434   Endianness
1435   endianness() const
1436   { return this->endianness_; }
1437
1438  private:
1439   // Don't copy this structure.
1440   General_options(const General_options&);
1441   General_options& operator=(const General_options&);
1442
1443   // Whether to mark the stack as executable.
1444   enum Execstack
1445   {
1446     // Not set on command line.
1447     EXECSTACK_FROM_INPUT,
1448     // Mark the stack as executable (-z execstack).
1449     EXECSTACK_YES,
1450     // Mark the stack as not executable (-z noexecstack).
1451     EXECSTACK_NO
1452   };
1453
1454   enum Icf_status
1455   {
1456     // Do not fold any functions (Default or --icf=none).
1457     ICF_NONE,
1458     // All functions are candidates for folding. (--icf=all).
1459     ICF_ALL,
1460     // Only ctors and dtors are candidates for folding. (--icf=safe).
1461     ICF_SAFE
1462   };
1463
1464   void
1465   set_icf_status(Icf_status value)
1466   { this->icf_status_ = value; }
1467
1468   void
1469   set_execstack_status(Execstack value)
1470   { this->execstack_status_ = value; }
1471
1472   void
1473   set_do_demangle(bool value)
1474   { this->do_demangle_ = value; }
1475
1476   void
1477   set_static(bool value)
1478   { static_ = value; }
1479
1480   // These are called by finalize() to set up the search-path correctly.
1481   void
1482   add_to_library_path_with_sysroot(const std::string& arg)
1483   { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1484
1485   // Apply any sysroot to the directory lists.
1486   void
1487   add_sysroot();
1488
1489   // Add a plugin and its arguments to the list of plugins.
1490   void
1491   add_plugin(const char* filename);
1492
1493   // Add a plugin option.
1494   void
1495   add_plugin_option(const char* opt);
1496
1497   // Whether we printed version information.
1498   bool printed_version_;
1499   // Whether to mark the stack as executable.
1500   Execstack execstack_status_;
1501   // Whether to do code folding.
1502   Icf_status icf_status_;
1503   // Whether to do a static link.
1504   bool static_;
1505   // Whether to do demangling.
1506   bool do_demangle_;
1507   // List of plugin libraries.
1508   Plugin_manager* plugins_;
1509   // The parsed output of --dynamic-list files.  For convenience in
1510   // script.cc, we store this as a Script_options object, even though
1511   // we only use a single Version_tree from it.
1512   Script_options dynamic_list_;
1513   // The incremental linking mode.
1514   Incremental_mode incremental_mode_;
1515   // The disposition given by the --incremental-changed,
1516   // --incremental-unchanged or --incremental-unknown option.  The
1517   // value may change as we proceed parsing the command line flags.
1518   Incremental_disposition incremental_disposition_;
1519   // The disposition to use for startup files (those marked
1520   // INCREMENTAL_STARTUP).
1521   Incremental_disposition incremental_startup_disposition_;
1522   // Whether we have seen one of the options that require incremental
1523   // build (--incremental-changed, --incremental-unchanged,
1524   // --incremental-unknown, or --incremental-startup-unchanged).
1525   bool implicit_incremental_;
1526   // Libraries excluded from automatic export, via --exclude-libs.
1527   Unordered_set<std::string> excluded_libs_;
1528   // List of symbol-names to keep, via -retain-symbol-info.
1529   Unordered_set<std::string> symbols_to_retain_;
1530   // Map from section name to address from --section-start.
1531   std::map<std::string, uint64_t> section_starts_;
1532   // Whether to process armv4 bx instruction relocation.
1533   Fix_v4bx fix_v4bx_;
1534   // Endianness.
1535   Endianness endianness_;
1536 };
1537
1538 // The position-dependent options.  We use this to store the state of
1539 // the commandline at a particular point in parsing for later
1540 // reference.  For instance, if we see "ld --whole-archive foo.a
1541 // --no-whole-archive," we want to store the whole-archive option with
1542 // foo.a, so when the time comes to parse foo.a we know we should do
1543 // it in whole-archive mode.  We could store all of General_options,
1544 // but that's big, so we just pick the subset of flags that actually
1545 // change in a position-dependent way.
1546
1547 #define DEFINE_posdep(varname__, type__)        \
1548  public:                                        \
1549   type__                                        \
1550   varname__() const                             \
1551   { return this->varname__##_; }                \
1552                                                 \
1553   void                                          \
1554   set_##varname__(type__ value)                 \
1555   { this->varname__##_ = value; }               \
1556  private:                                       \
1557   type__ varname__##_
1558
1559 class Position_dependent_options
1560 {
1561  public:
1562   Position_dependent_options(const General_options& options
1563                              = Position_dependent_options::default_options_)
1564   { copy_from_options(options); }
1565
1566   void copy_from_options(const General_options& options)
1567   {
1568     this->set_as_needed(options.as_needed());
1569     this->set_Bdynamic(options.Bdynamic());
1570     this->set_format_enum(options.format_enum());
1571     this->set_whole_archive(options.whole_archive());
1572     this->set_incremental_disposition(options.incremental_disposition());
1573   }
1574
1575   DEFINE_posdep(as_needed, bool);
1576   DEFINE_posdep(Bdynamic, bool);
1577   DEFINE_posdep(format_enum, General_options::Object_format);
1578   DEFINE_posdep(whole_archive, bool);
1579   DEFINE_posdep(incremental_disposition, Incremental_disposition);
1580
1581  private:
1582   // This is a General_options with everything set to its default
1583   // value.  A Position_dependent_options created with no argument
1584   // will take its values from here.
1585   static General_options default_options_;
1586 };
1587
1588
1589 // A single file or library argument from the command line.
1590
1591 class Input_file_argument
1592 {
1593  public:
1594   enum Input_file_type
1595   {
1596     // A regular file, name used as-is, not searched.
1597     INPUT_FILE_TYPE_FILE,
1598     // A library name.  When used, "lib" will be prepended and ".so" or
1599     // ".a" appended to make a filename, and that filename will be searched
1600     // for using the -L paths.
1601     INPUT_FILE_TYPE_LIBRARY,
1602     // A regular file, name used as-is, but searched using the -L paths.
1603     INPUT_FILE_TYPE_SEARCHED_FILE
1604   };
1605
1606   // name: file name or library name
1607   // type: the type of this input file.
1608   // extra_search_path: an extra directory to look for the file, prior
1609   //         to checking the normal library search path.  If this is "",
1610   //         then no extra directory is added.
1611   // just_symbols: whether this file only defines symbols.
1612   // options: The position dependent options at this point in the
1613   //         command line, such as --whole-archive.
1614   Input_file_argument()
1615     : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1616       just_symbols_(false), options_(), arg_serial_(0)
1617   { }
1618
1619   Input_file_argument(const char* name, Input_file_type type,
1620                       const char* extra_search_path,
1621                       bool just_symbols,
1622                       const Position_dependent_options& options)
1623     : name_(name), type_(type), extra_search_path_(extra_search_path),
1624       just_symbols_(just_symbols), options_(options), arg_serial_(0)
1625   { }
1626
1627   // You can also pass in a General_options instance instead of a
1628   // Position_dependent_options.  In that case, we extract the
1629   // position-independent vars from the General_options and only store
1630   // those.
1631   Input_file_argument(const char* name, Input_file_type type,
1632                       const char* extra_search_path,
1633                       bool just_symbols,
1634                       const General_options& options)
1635     : name_(name), type_(type), extra_search_path_(extra_search_path),
1636       just_symbols_(just_symbols), options_(options), arg_serial_(0)
1637   { }
1638
1639   const char*
1640   name() const
1641   { return this->name_.c_str(); }
1642
1643   const Position_dependent_options&
1644   options() const
1645   { return this->options_; }
1646
1647   bool
1648   is_lib() const
1649   { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1650
1651   bool
1652   is_searched_file() const
1653   { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1654
1655   const char*
1656   extra_search_path() const
1657   {
1658     return (this->extra_search_path_.empty()
1659             ? NULL
1660             : this->extra_search_path_.c_str());
1661   }
1662
1663   // Return whether we should only read symbols from this file.
1664   bool
1665   just_symbols() const
1666   { return this->just_symbols_; }
1667
1668   // Return whether this file may require a search using the -L
1669   // options.
1670   bool
1671   may_need_search() const
1672   {
1673     return (this->is_lib()
1674             || this->is_searched_file()
1675             || !this->extra_search_path_.empty());
1676   }
1677
1678   // Set the serial number for this argument.
1679   void
1680   set_arg_serial(unsigned int arg_serial)
1681   { this->arg_serial_ = arg_serial; }
1682
1683   // Get the serial number.
1684   unsigned int
1685   arg_serial() const
1686   { return this->arg_serial_; }
1687
1688  private:
1689   // We use std::string, not const char*, here for convenience when
1690   // using script files, so that we do not have to preserve the string
1691   // in that case.
1692   std::string name_;
1693   Input_file_type type_;
1694   std::string extra_search_path_;
1695   bool just_symbols_;
1696   Position_dependent_options options_;
1697   // A unique index for this file argument in the argument list.
1698   unsigned int arg_serial_;
1699 };
1700
1701 // A file or library, or a group, from the command line.
1702
1703 class Input_argument
1704 {
1705  public:
1706   // Create a file or library argument.
1707   explicit Input_argument(Input_file_argument file)
1708     : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
1709   { }
1710
1711   // Create a group argument.
1712   explicit Input_argument(Input_file_group* group)
1713     : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
1714   { }
1715
1716   // Create a lib argument.
1717   explicit Input_argument(Input_file_lib* lib)
1718     : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
1719   { }
1720
1721   // Return whether this is a file.
1722   bool
1723   is_file() const
1724   { return this->is_file_; }
1725
1726   // Return whether this is a group.
1727   bool
1728   is_group() const
1729   { return !this->is_file_ && this->lib_ == NULL; }
1730
1731   // Return whether this is a lib.
1732   bool
1733   is_lib() const
1734   { return this->lib_ != NULL; }
1735
1736   // Return the information about the file.
1737   const Input_file_argument&
1738   file() const
1739   {
1740     gold_assert(this->is_file_);
1741     return this->file_;
1742   }
1743
1744   // Return the information about the group.
1745   const Input_file_group*
1746   group() const
1747   {
1748     gold_assert(!this->is_file_);
1749     return this->group_;
1750   }
1751
1752   Input_file_group*
1753   group()
1754   {
1755     gold_assert(!this->is_file_);
1756     return this->group_;
1757   }
1758
1759   // Return the information about the lib.
1760   const Input_file_lib*
1761   lib() const
1762   {
1763     gold_assert(!this->is_file_);
1764     gold_assert(this->lib_);
1765     return this->lib_;
1766   }
1767
1768   Input_file_lib*
1769   lib()
1770   {
1771     gold_assert(!this->is_file_);
1772     gold_assert(this->lib_);
1773     return this->lib_;
1774   }
1775
1776   // If a script generated this argument, store a pointer to the script info.
1777   // Currently used only for recording incremental link information.
1778   void
1779   set_script_info(Script_info* info)
1780   { this->script_info_ = info; }
1781
1782   Script_info*
1783   script_info() const
1784   { return this->script_info_; }
1785
1786  private:
1787   bool is_file_;
1788   Input_file_argument file_;
1789   Input_file_group* group_;
1790   Input_file_lib* lib_;
1791   Script_info* script_info_;
1792 };
1793
1794 typedef std::vector<Input_argument> Input_argument_list;
1795
1796 // A group from the command line.  This is a set of arguments within
1797 // --start-group ... --end-group.
1798
1799 class Input_file_group
1800 {
1801  public:
1802   typedef Input_argument_list::const_iterator const_iterator;
1803
1804   Input_file_group()
1805     : files_()
1806   { }
1807
1808   // Add a file to the end of the group.
1809   Input_argument&
1810   add_file(const Input_file_argument& arg)
1811   {
1812     this->files_.push_back(Input_argument(arg));
1813     return this->files_.back();
1814   }
1815
1816   // Iterators to iterate over the group contents.
1817
1818   const_iterator
1819   begin() const
1820   { return this->files_.begin(); }
1821
1822   const_iterator
1823   end() const
1824   { return this->files_.end(); }
1825
1826  private:
1827   Input_argument_list files_;
1828 };
1829
1830 // A lib from the command line.  This is a set of arguments within
1831 // --start-lib ... --end-lib.
1832
1833 class Input_file_lib
1834 {
1835  public:
1836   typedef Input_argument_list::const_iterator const_iterator;
1837
1838   Input_file_lib(const Position_dependent_options& options)
1839     : files_(), options_(options)
1840   { }
1841
1842   // Add a file to the end of the lib.
1843   Input_argument&
1844   add_file(const Input_file_argument& arg)
1845   {
1846     this->files_.push_back(Input_argument(arg));
1847     return this->files_.back();
1848   }
1849
1850   const Position_dependent_options&
1851   options() const
1852   { return this->options_; }
1853
1854   // Iterators to iterate over the lib contents.
1855
1856   const_iterator
1857   begin() const
1858   { return this->files_.begin(); }
1859
1860   const_iterator
1861   end() const
1862   { return this->files_.end(); }
1863
1864   size_t
1865   size() const
1866   { return this->files_.size(); }
1867
1868  private:
1869   Input_argument_list files_;
1870   Position_dependent_options options_;
1871 };
1872
1873 // A list of files from the command line or a script.
1874
1875 class Input_arguments
1876 {
1877  public:
1878   typedef Input_argument_list::const_iterator const_iterator;
1879
1880   Input_arguments()
1881     : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
1882   { }
1883
1884   // Add a file.
1885   Input_argument&
1886   add_file(Input_file_argument& arg);
1887
1888   // Start a group (the --start-group option).
1889   void
1890   start_group();
1891
1892   // End a group (the --end-group option).
1893   void
1894   end_group();
1895
1896   // Start a lib (the --start-lib option).
1897   void
1898   start_lib(const Position_dependent_options&);
1899
1900   // End a lib (the --end-lib option).
1901   void
1902   end_lib();
1903
1904   // Return whether we are currently in a group.
1905   bool
1906   in_group() const
1907   { return this->in_group_; }
1908
1909   // Return whether we are currently in a lib.
1910   bool
1911   in_lib() const
1912   { return this->in_lib_; }
1913
1914   // The number of entries in the list.
1915   int
1916   size() const
1917   { return this->input_argument_list_.size(); }
1918
1919   // Iterators to iterate over the list of input files.
1920
1921   const_iterator
1922   begin() const
1923   { return this->input_argument_list_.begin(); }
1924
1925   const_iterator
1926   end() const
1927   { return this->input_argument_list_.end(); }
1928
1929   // Return whether the list is empty.
1930   bool
1931   empty() const
1932   { return this->input_argument_list_.empty(); }
1933
1934   // Return the number of input files.  This may be larger than
1935   // input_argument_list_.size(), because of files that are part
1936   // of groups or libs.
1937   int
1938   number_of_input_files() const
1939   { return this->file_count_; }
1940
1941  private:
1942   Input_argument_list input_argument_list_;
1943   bool in_group_;
1944   bool in_lib_;
1945   unsigned int file_count_;
1946 };
1947
1948
1949 // All the information read from the command line.  These are held in
1950 // three separate structs: one to hold the options (--foo), one to
1951 // hold the filenames listed on the commandline, and one to hold
1952 // linker script information.  This third is not a subset of the other
1953 // two because linker scripts can be specified either as options (via
1954 // -T) or as a file.
1955
1956 class Command_line
1957 {
1958  public:
1959   typedef Input_arguments::const_iterator const_iterator;
1960
1961   Command_line();
1962
1963   // Process the command line options.  This will exit with an
1964   // appropriate error message if an unrecognized option is seen.
1965   void
1966   process(int argc, const char** argv);
1967
1968   // Process one command-line option.  This takes the index of argv to
1969   // process, and returns the index for the next option.  no_more_options
1970   // is set to true if argv[i] is "--".
1971   int
1972   process_one_option(int argc, const char** argv, int i,
1973                      bool* no_more_options);
1974
1975   // Get the general options.
1976   const General_options&
1977   options() const
1978   { return this->options_; }
1979
1980   // Get the position dependent options.
1981   const Position_dependent_options&
1982   position_dependent_options() const
1983   { return this->position_options_; }
1984
1985   // Get the linker-script options.
1986   Script_options&
1987   script_options()
1988   { return this->script_options_; }
1989
1990   // Finalize the version-script options and return them.
1991   const Version_script_info&
1992   version_script();
1993
1994   // Get the input files.
1995   Input_arguments&
1996   inputs()
1997   { return this->inputs_; }
1998
1999   // The number of input files.
2000   int
2001   number_of_input_files() const
2002   { return this->inputs_.number_of_input_files(); }
2003
2004   // Iterators to iterate over the list of input files.
2005
2006   const_iterator
2007   begin() const
2008   { return this->inputs_.begin(); }
2009
2010   const_iterator
2011   end() const
2012   { return this->inputs_.end(); }
2013
2014  private:
2015   Command_line(const Command_line&);
2016   Command_line& operator=(const Command_line&);
2017
2018   // This is a dummy class to provide a constructor that runs before
2019   // the constructor for the General_options.  The Pre_options constructor
2020   // is used as a hook to set the flag enabling the options to register
2021   // themselves.
2022   struct Pre_options {
2023     Pre_options();
2024   };
2025
2026   // This must come before options_!
2027   Pre_options pre_options_;
2028   General_options options_;
2029   Position_dependent_options position_options_;
2030   Script_options script_options_;
2031   Input_arguments inputs_;
2032 };
2033
2034 } // End namespace gold.
2035
2036 #endif // !defined(GOLD_OPTIONS_H)