gold/options.h

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