gold/options.h

   1 // options.h -- handle command line options for gold  -*- C++ -*-
   2
   3 // Copyright 2006, 2007, 2008 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 <list>
  41 #include <string>
  42 #include <vector>
  43
  44 #include "elfcpp.h"
  45 #include "script.h"
  46
  47 namespace gold
  48 {
  49
  50 class Command_line;
  51 class General_options;
  52 class Search_directory;
  53 class Input_file_group;
  54 class Position_dependent_options;
  55 class Target;
  56
  57 // The nested namespace is to contain all the global variables and
  58 // structs that need to be defined in the .h file, but do not need to
  59 // be used outside this class.
  60 namespace options
  61 {
  62 typedef std::vector<Search_directory> Dir_list;
  63
  64 // These routines convert from a string option to various types.
  65 // Each gives a fatal error if it cannot parse the argument.
  66
  67 extern void
  68 parse_bool(const char* option_name, const char* arg, bool* retval);
  69
  70 extern void
  71 parse_uint(const char* option_name, const char* arg, int* retval);
  72
  73 extern void
  74 parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
  75
  76 extern void
  77 parse_double(const char* option_name, const char* arg, double* retval);
  78
  79 extern void
  80 parse_string(const char* option_name, const char* arg, const char** retval);
  81
  82 extern void
  83 parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
  84
  85 extern void
  86 parse_choices(const char* option_name, const char* arg, const char** retval,
  87               const char* choices[], int num_choices);
  88
  89 struct Struct_var;
  90
  91 // Most options have both a shortname (one letter) and a longname.
  92 // This enum controls how many dashes are expected for longname access
  93 // -- shortnames always use one dash.  Most longnames will accept
  94 // either one dash or two; the only difference between ONE_DASH and
  95 // TWO_DASHES is how we print the option in --help.  However, some
  96 // longnames require two dashes, and some require only one.  The
  97 // special value DASH_Z means that the option is preceded by "-z".
  98 enum Dashes
  99 {
 100   ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z
 101 };
 102
 103 // LONGNAME is the long-name of the option with dashes converted to
 104 //    underscores, or else the short-name if the option has no long-name.
 105 //    It is never the empty string.
 106 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
 107 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
 108 //    option has no short-name.  If the option has no long-name, you
 109 //    should specify the short-name in *both* VARNAME and here.
 110 // DEFAULT_VALUE is the value of the option if not specified on the
 111 //    commandline, as a string.
 112 // HELPSTRING is the descriptive text used with the option via --help
 113 // HELPARG is how you define the argument to the option.
 114 //    --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
 115 //    HELPARG should be NULL iff the option is a bool and takes no arg.
 116 // READER provides parse_to_value, which is a function that will convert
 117 //    a char* argument into the proper type and store it in some variable.
 118 // A One_option struct initializes itself with the global list of options
 119 // at constructor time, so be careful making one of these.
 120 struct One_option
 121 {
 122   std::string longname;
 123   Dashes dashes;
 124   char shortname;
 125   const char* default_value;
 126   const char* helpstring;
 127   const char* helparg;
 128   Struct_var* reader;
 129
 130   One_option(const char* ln, Dashes d, char sn, const char* dv,
 131              const char* hs, const char* ha, Struct_var* r)
 132     : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
 133       helpstring(hs), helparg(ha), reader(r)
 134   {
 135     // In longname, we convert all underscores to dashes, since GNU
 136     // style uses dashes in option names.  longname is likely to have
 137     // underscores in it because it's also used to declare a C++
 138     // function.
 139     const char* pos = strchr(this->longname.c_str(), '_');
 140     for (; pos; pos = strchr(pos, '_'))
 141       this->longname[pos - this->longname.c_str()] = '-';
 142
 143     // We only register ourselves if our helpstring is not NULL.  This
 144     // is to support the "no-VAR" boolean variables, which we
 145     // conditionally turn on by defining "no-VAR" help text.
 146     if (this->helpstring)
 147       this->register_option();
 148   }
 149
 150   // This option takes an argument iff helparg is not NULL.
 151   bool
 152   takes_argument() const
 153   { return this->helparg != NULL; }
 154
 155   // Register this option with the global list of options.
 156   void
 157   register_option();
 158
 159   // Print this option to stdout (used with --help).
 160   void
 161   print() const;
 162 };
 163
 164 // All options have a Struct_##varname that inherits from this and
 165 // actually implements parse_to_value for that option.
 166 struct Struct_var
 167 {
 168   // OPTION: the name of the option as specified on the commandline,
 169   //    including leading dashes, and any text following the option:
 170   //    "-O", "--defsym=mysym=0x1000", etc.
 171   // ARG: the arg associated with this option, or NULL if the option
 172   //    takes no argument: "2", "mysym=0x1000", etc.
 173   // CMDLINE: the global Command_line object.  Used by DEFINE_special.
 174   // OPTIONS: the global General_options object.  Used by DEFINE_special.
 175   virtual void
 176   parse_to_value(const char* option, const char* arg,
 177                  Command_line* cmdline, General_options* options) = 0;
 178   virtual
 179   ~Struct_var()  // To make gcc happy.
 180   { }
 181 };
 182
 183 // This is for "special" options that aren't of any predefined type.
 184 struct Struct_special : public Struct_var
 185 {
 186   // If you change this, change the parse-fn in DEFINE_special as well.
 187   typedef void (General_options::*Parse_function)(const char*, const char*,
 188                                                   Command_line*);
 189   Struct_special(const char* varname, Dashes dashes, char shortname,
 190                  Parse_function parse_function,
 191                  const char* helpstring, const char* helparg)
 192     : option(varname, dashes, shortname, "", helpstring, helparg, this),
 193       parse(parse_function)
 194   { }
 195
 196   void parse_to_value(const char* option, const char* arg,
 197                       Command_line* cmdline, General_options* options)
 198   { (options->*(this->parse))(option, arg, cmdline); }
 199
 200   One_option option;
 201   Parse_function parse;
 202 };
 203
 204 }  // End namespace options.
 205
 206
 207 // These are helper macros use by DEFINE_uint64/etc below.
 208 // This macro is used inside the General_options_ class, so defines
 209 // var() and set_var() as General_options methods.  Arguments as are
 210 // for the constructor for One_option.  param_type__ is the same as
 211 // type__ for built-in types, and "const type__ &" otherwise.
 212 #define DEFINE_var(varname__, dashes__, shortname__, default_value__,        \
 213                    default_value_as_string__, helpstring__, helparg__,       \
 214                    type__, param_type__, parse_fn__)                         \
 215  public:                                                                     \
 216   param_type__                                                               \
 217   varname__() const                                                          \
 218   { return this->varname__##_.value; }                                       \
 219                                                                              \
 220   bool                                                                       \
 221   user_set_##varname__() const                                               \
 222   { return this->varname__##_.user_set_via_option; }                         \
 223                                                                              \
 224  private:                                                                    \
 225   struct Struct_##varname__ : public options::Struct_var                     \
 226   {                                                                          \
 227     Struct_##varname__()                                                     \
 228       : option(#varname__, dashes__, shortname__, default_value_as_string__, \
 229                helpstring__, helparg__, this),                               \
 230         user_set_via_option(false), value(default_value__)                   \
 231     { }                                                                      \
 232                                                                              \
 233     void                                                                     \
 234     parse_to_value(const char* option_name, const char* arg,                 \
 235                    Command_line*, General_options*)                          \
 236     {                                                                        \
 237       parse_fn__(option_name, arg, &this->value);                            \
 238       this->user_set_via_option = true;                                      \
 239     }                                                                        \
 240                                                                              \
 241     options::One_option option;                                              \
 242     bool user_set_via_option;                                                \
 243     type__ value;                                                            \
 244   };                                                                         \
 245   Struct_##varname__ varname__##_;                                           \
 246   void                                                                       \
 247   set_##varname__(param_type__ value)                                        \
 248   { this->varname__##_.value = value; }
 249
 250 // These macros allow for easy addition of a new commandline option.
 251
 252 // If no_helpstring__ is not NULL, then in addition to creating
 253 // VARNAME, we also create an option called no-VARNAME.
 254 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__,   \
 255                     helpstring__, no_helpstring__)                       \
 256   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 257              default_value__ ? "true" : "false", helpstring__, NULL,     \
 258              bool, bool, options::parse_bool)                            \
 259   struct Struct_no_##varname__ : public options::Struct_var              \
 260   {                                                                      \
 261     Struct_no_##varname__() : option("no-" #varname__, dashes__, '\0',   \
 262                                      default_value__ ? "false" : "true", \
 263                                      no_helpstring__, NULL, this)        \
 264     { }                                                                  \
 265                                                                          \
 266     void                                                                 \
 267     parse_to_value(const char*, const char*,                             \
 268                    Command_line*, General_options* options)              \
 269     { options->set_##varname__(false); }                                 \
 270                                                                          \
 271     options::One_option option;                                          \
 272   };                                                                     \
 273   Struct_no_##varname__ no_##varname__##_initializer_
 274
 275 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__,  \
 276                    helpstring__, helparg__)                             \
 277   DEFINE_var(varname__, dashes__, shortname__, default_value__,         \
 278              #default_value__, helpstring__, helparg__,                 \
 279              int, int, options::parse_uint)
 280
 281 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
 282                       helpstring__, helparg__)                           \
 283   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 284              #default_value__, helpstring__, helparg__,                  \
 285              uint64_t, uint64_t, options::parse_uint64)
 286
 287 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
 288                       helpstring__, helparg__)                           \
 289   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 290              #default_value__, helpstring__, helparg__,                  \
 291              double, double, options::parse_double)
 292
 293 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
 294                       helpstring__, helparg__)                           \
 295   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 296              default_value__, helpstring__, helparg__,                   \
 297              const char*, const char*, options::parse_string)
 298
 299 // This is like DEFINE_string, but we convert each occurrence to a
 300 // Search_directory and store it in a vector.  Thus we also have the
 301 // add_to_VARNAME() method, to append to the vector.
 302 #define DEFINE_dirlist(varname__, dashes__, shortname__,                  \
 303                            helpstring__, helparg__)                       \
 304   DEFINE_var(varname__, dashes__, shortname__, ,                          \
 305              "", helpstring__, helparg__, options::Dir_list,              \
 306              const options::Dir_list&, options::parse_dirlist)            \
 307   void                                                                    \
 308   add_to_##varname__(const char* new_value)                               \
 309   { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
 310   void                                                                    \
 311   add_search_directory_to_##varname__(const Search_directory& dir)        \
 312   { this->varname__##_.value.push_back(dir); }
 313
 314 // When you have a list of possible values (expressed as string)
 315 // After helparg__ should come an initializer list, like
 316 //   {"foo", "bar", "baz"}
 317 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__,   \
 318                     helpstring__, helparg__, ...)                        \
 319   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
 320              default_value__, helpstring__, helparg__,                   \
 321              const char*, const char*, parse_choices_##varname__)        \
 322  private:                                                                \
 323   static void parse_choices_##varname__(const char* option_name,         \
 324                                         const char* arg,                 \
 325                                         const char** retval) {           \
 326     const char* choices[] = __VA_ARGS__;                                 \
 327     options::parse_choices(option_name, arg, retval,                     \
 328                            choices, sizeof(choices) / sizeof(*choices)); \
 329   }
 330
 331 // This is used for non-standard flags.  It defines no functions; it
 332 // just calls General_options::parse_VARNAME whenever the flag is
 333 // seen.  We declare parse_VARNAME as a static member of
 334 // General_options; you are responsible for defining it there.
 335 // helparg__ should be NULL iff this special-option is a boolean.
 336 #define DEFINE_special(varname__, dashes__, shortname__,                \
 337                        helpstring__, helparg__)                         \
 338  private:                                                               \
 339   void parse_##varname__(const char* option, const char* arg,           \
 340                          Command_line* inputs);                         \
 341   struct Struct_##varname__ : public options::Struct_special            \
 342   {                                                                     \
 343     Struct_##varname__()                                                \
 344       : options::Struct_special(#varname__, dashes__, shortname__,      \
 345                                 &General_options::parse_##varname__,    \
 346                                 helpstring__, helparg__)                \
 347     { }                                                                 \
 348   };                                                                    \
 349   Struct_##varname__ varname__##_initializer_
 350
 351
 352 // A directory to search.  For each directory we record whether it is
 353 // in the sysroot.  We need to know this so that, if a linker script
 354 // is found within the sysroot, we will apply the sysroot to any files
 355 // named by that script.
 356
 357 class Search_directory
 358 {
 359  public:
 360   // We need a default constructor because we put this in a
 361   // std::vector.
 362   Search_directory()
 363     : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
 364   { }
 365
 366   // This is the usual constructor.
 367   Search_directory(const char* name, bool put_in_sysroot)
 368     : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
 369   {
 370     if (this->name_.empty())
 371       this->name_ = ".";
 372   }
 373
 374   // This is called if we have a sysroot.  The sysroot is prefixed to
 375   // any entries for which put_in_sysroot_ is true.  is_in_sysroot_ is
 376   // set to true for any enries which are in the sysroot (this will
 377   // naturally include any entries for which put_in_sysroot_ is true).
 378   // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
 379   // passing SYSROOT to lrealpath.
 380   void
 381   add_sysroot(const char* sysroot, const char* canonical_sysroot);
 382
 383   // Get the directory name.
 384   const std::string&
 385   name() const
 386   { return this->name_; }
 387
 388   // Return whether this directory is in the sysroot.
 389   bool
 390   is_in_sysroot() const
 391   { return this->is_in_sysroot_; }
 392
 393  private:
 394   std::string name_;
 395   bool put_in_sysroot_;
 396   bool is_in_sysroot_;
 397 };
 398
 399 class General_options
 400 {
 401  private:
 402   // NOTE: For every option that you add here, also consider if you
 403   // should add it to Position_dependent_options.
 404   DEFINE_special(help, options::TWO_DASHES, '\0',
 405                  N_("Report usage information"), NULL);
 406   DEFINE_special(version, options::TWO_DASHES, 'v',
 407                  N_("Report version information"), NULL);
 408
 409   // These options are sorted approximately so that for each letter in
 410   // the alphabet, we show the option whose shortname is that letter
 411   // (if any) and then every longname that starts with that letter (in
 412   // alphabetical order).  For both, lowercase sorts before uppercase.
 413   // The -z options come last.
 414
 415   DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
 416               N_("Allow unresolved references in shared libraries"),
 417               N_("Do not allow unresolved references in shared libraries"));
 418
 419   DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
 420               N_("Only set DT_NEEDED for dynamic libs if used"),
 421               N_("Always DT_NEEDED for dynamic libs"));
 422
 423   // This should really be an "enum", but it's too easy for folks to
 424   // forget to update the list as they add new targets.  So we just
 425   // accept any string.  We'll fail later (when the string is parsed),
 426   // if the target isn't actually supported.
 427   DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
 428                 N_("Set input format"), ("[elf,binary]"));
 429
 430   DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
 431               N_("-l searches for shared libraries"), NULL);
 432   // Bstatic affects the same variable as Bdynamic, so we have to use
 433   // the "special" macro to make that happen.
 434   DEFINE_special(Bstatic, options::ONE_DASH, '\0',
 435                  N_("-l does not search for shared libraries"), NULL);
 436
 437   DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
 438               N_("Bind defined symbols locally"), NULL);
 439
 440 #ifdef HAVE_ZLIB_H
 441   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
 442               N_("Compress .debug_* sections in the output file"),
 443               ("[none,zlib]"),
 444               {"none", "zlib"});
 445 #else
 446   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
 447               N_("Compress .debug_* sections in the output file"),
 448               N_("[none]"),
 449               {"none"});
 450 #endif
 451
 452   DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
 453               N_("Define common symbols"),
 454               N_("Do not define common symbols"));
 455   DEFINE_bool(dc, options::ONE_DASH, '\0', false,
 456               N_("Alias for -d"), NULL);
 457   DEFINE_bool(dp, options::ONE_DASH, '\0', false,
 458               N_("Alias for -d"), NULL);
 459
 460   DEFINE_string(debug, options::TWO_DASHES, '\0', "",
 461                 N_("Turn on debugging"),
 462                 N_("[all,files,script,task][,...]"));
 463
 464   DEFINE_special(defsym, options::TWO_DASHES, '\0',
 465                  N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
 466
 467   DEFINE_bool(demangle, options::TWO_DASHES, '\0',
 468               getenv("COLLECT_NO_DEMANGLE") == NULL,
 469               N_("Demangle C++ symbols in log messages"),
 470               N_("Do not demangle C++ symbols in log messages"));
 471
 472   DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
 473               N_("Try to detect violations of the One Definition Rule"),
 474               NULL);
 475
 476   DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
 477                 N_("Set program start address"), N_("ADDRESS"));
 478
 479   DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
 480               N_("Export all dynamic symbols"), NULL);
 481
 482   DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
 483               N_("Create exception frame header"), NULL);
 484
 485   DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
 486                 N_("Set shared library name"), N_("FILENAME"));
 487
 488   DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
 489                 N_("Min fraction of empty buckets in dynamic hash"),
 490                 N_("FRACTION"));
 491
 492   DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
 493               N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
 494               {"sysv", "gnu", "both"});
 495
 496   DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
 497                 N_("Set dynamic linker path"), N_("PROGRAM"));
 498
 499   DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
 500                  N_("Read only symbol values from FILE"), N_("FILE"));
 501
 502   DEFINE_special(library, options::TWO_DASHES, 'l',
 503                  N_("Search for library LIBNAME"), N_("LIBNAME"));
 504
 505   DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
 506                  N_("Add directory to search path"), N_("DIR"));
 507
 508   DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
 509                 N_("Ignored for compatibility"), N_("EMULATION"));
 510
 511   DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
 512                 N_("Set output file name"), N_("FILE"));
 513
 514   DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
 515               N_("Optimize output file size"), N_("LEVEL"));
 516
 517   DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
 518                 N_("Set output format"), N_("[binary]"));
 519
 520   DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
 521               N_("Generate relocations in output"), NULL);
 522
 523   DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
 524               N_("Generate relocatable output"), NULL);
 525
 526   // -R really means -rpath, but can mean --just-symbols for
 527   // compatibility with GNU ld.  -rpath is always -rpath, so we list
 528   // it separately.
 529   DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
 530                  N_("Add DIR to runtime search path"), N_("DIR"));
 531
 532   DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
 533                  N_("Add DIR to runtime search path"), N_("DIR"));
 534
 535   DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
 536                  N_("Add DIR to link time shared library search path"),
 537                  N_("DIR"));
 538
 539   DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
 540               N_("Strip all symbols"), NULL);
 541   DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
 542               N_("Strip debugging information"), NULL);
 543   DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
 544               N_("Strip debug symbols that are unused by gdb "
 545                  "(at least versions <= 6.7)"), NULL);
 546
 547   DEFINE_bool(shared, options::ONE_DASH, '\0', false,
 548               N_("Generate shared library"), NULL);
 549
 550   // This is not actually special in any way, but I need to give it
 551   // a non-standard accessor-function name because 'static' is a keyword.
 552   DEFINE_special(static, options::ONE_DASH, '\0',
 553                  N_("Do not link against shared libraries"), NULL);
 554
 555   DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
 556               N_("Print resource usage statistics"), NULL);
 557
 558   DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
 559                 N_("Set target system root directory"), N_("DIR"));
 560
 561   DEFINE_special(script, options::TWO_DASHES, 'T',
 562                  N_("Read linker script"), N_("FILE"));
 563
 564   DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
 565               N_("Run the linker multi-threaded"),
 566               N_("Do not run the linker multi-threaded"));
 567   DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
 568               N_("Number of threads to use"), N_("COUNT"));
 569   DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
 570               N_("Number of threads to use in initial pass"), N_("COUNT"));
 571   DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
 572               N_("Number of threads to use in middle pass"), N_("COUNT"));
 573   DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
 574               N_("Number of threads to use in final pass"), N_("COUNT"));
 575
 576   DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
 577                 N_("Set the address of the bss segment"), N_("ADDRESS"));
 578   DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
 579                 N_("Set the address of the data segment"), N_("ADDRESS"));
 580   DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
 581                 N_("Set the address of the text segment"), N_("ADDRESS"));
 582
 583   DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
 584               N_("Synonym for --debug=files"), NULL);
 585
 586   DEFINE_special(version_script, options::TWO_DASHES, '\0',
 587                  N_("Read version script"), N_("FILE"));
 588
 589   DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
 590               N_("Include all archive contents"),
 591               N_("Include only needed archive contents"));
 592
 593   DEFINE_special(start_group, options::TWO_DASHES, '(',
 594                  N_("Start a library search group"), NULL);
 595   DEFINE_special(end_group, options::TWO_DASHES, ')',
 596                  N_("End a library search group"), NULL);
 597
 598   // The -z options.
 599
 600   // Both execstack and noexecstack differ from the default execstack_
 601   // value, so we need to use different variables for them.
 602   DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
 603                 N_("Set common page size to SIZE"), N_("SIZE"));
 604   DEFINE_bool(execstack, options::DASH_Z, '\0', false,
 605               N_("Mark output as requiring executable stack"), NULL);
 606   DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
 607                 N_("Set maximum page size to SIZE"), N_("SIZE"));
 608   DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
 609               N_("Mark output as not requiring executable stack"), NULL);
 610
 611  public:
 612   typedef options::Dir_list Dir_list;
 613
 614   General_options();
 615
 616   // Does post-processing on flags, making sure they all have
 617   // non-conflicting values.  Also converts some flags from their
 618   // "standard" types (string, etc), to another type (enum, DirList),
 619   // which can be accessed via a separate method.  Dies if it notices
 620   // any problems.
 621   void finalize();
 622
 623   // The macro defines output() (based on --output), but that's a
 624   // generic name.  Provide this alternative name, which is clearer.
 625   const char*
 626   output_file_name() const
 627   { return this->output(); }
 628
 629   // This is not defined via a flag, but combines flags to say whether
 630   // the output is position-independent or not.
 631   bool
 632   output_is_position_independent() const
 633   { return this->shared(); }
 634
 635   // This would normally be static(), and defined automatically, but
 636   // since static is a keyword, we need to come up with our own name.
 637   bool
 638   is_static() const
 639   { return static_; }
 640
 641   // In addition to getting the input and output formats as a string
 642   // (via format() and oformat()), we also give access as an enum.
 643   enum Object_format
 644   {
 645     // Ordinary ELF.
 646     OBJECT_FORMAT_ELF,
 647     // Straight binary format.
 648     OBJECT_FORMAT_BINARY
 649   };
 650
 651   // Note: these functions are not very fast.
 652   Object_format format_enum() const;
 653   Object_format oformat_enum() const;
 654
 655   // These are the best way to get access to the execstack state,
 656   // not execstack() and noexecstack() which are hard to use properly.
 657   bool
 658   is_execstack_set() const
 659   { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
 660
 661   bool
 662   is_stack_executable() const
 663   { return this->execstack_status_ == EXECSTACK_YES; }
 664
 665  private:
 666   // Don't copy this structure.
 667   General_options(const General_options&);
 668   General_options& operator=(const General_options&);
 669
 670   // Whether to mark the stack as executable.
 671   enum Execstack
 672   {
 673     // Not set on command line.
 674     EXECSTACK_FROM_INPUT,
 675     // Mark the stack as executable (-z execstack).
 676     EXECSTACK_YES,
 677     // Mark the stack as not executable (-z noexecstack).
 678     EXECSTACK_NO
 679   };
 680
 681   Execstack execstack_status_;
 682   void
 683   set_execstack_status(Execstack value)
 684   { execstack_status_ = value; }
 685
 686   bool static_;
 687   void
 688   set_static(bool value)
 689   { static_ = value; }
 690
 691   // These are called by finalize() to set up the search-path correctly.
 692   void
 693   add_to_library_path_with_sysroot(const char* arg)
 694   { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
 695
 696   // Apply any sysroot to the directory lists.
 697   void
 698   add_sysroot();
 699 };
 700
 701 // The position-dependent options.  We use this to store the state of
 702 // the commandline at a particular point in parsing for later
 703 // reference.  For instance, if we see "ld --whole-archive foo.a
 704 // --no-whole-archive," we want to store the whole-archive option with
 705 // foo.a, so when the time comes to parse foo.a we know we should do
 706 // it in whole-archive mode.  We could store all of General_options,
 707 // but that's big, so we just pick the subset of flags that actually
 708 // change in a position-dependent way.
 709
 710 #define DEFINE_posdep(varname__, type__)        \
 711  public:                                        \
 712   type__                                        \
 713   varname__() const                             \
 714   { return this->varname__##_; }                \
 715                                                 \
 716   void                                          \
 717   set_##varname__(type__ value)                 \
 718   { this->varname__##_ = value; }               \
 719  private:                                       \
 720   type__ varname__##_
 721
 722 class Position_dependent_options
 723 {
 724  public:
 725   Position_dependent_options(const General_options& options
 726                              = Position_dependent_options::default_options_)
 727   { copy_from_options(options); }
 728
 729   void copy_from_options(const General_options& options)
 730   {
 731     this->set_as_needed(options.as_needed());
 732     this->set_Bdynamic(options.Bdynamic());
 733     this->set_format_enum(options.format_enum());
 734     this->set_whole_archive(options.whole_archive());
 735   }
 736
 737   DEFINE_posdep(as_needed, bool);
 738   DEFINE_posdep(Bdynamic, bool);
 739   DEFINE_posdep(format_enum, General_options::Object_format);
 740   DEFINE_posdep(whole_archive, bool);
 741
 742  private:
 743   // This is a General_options with everything set to its default
 744   // value.  A Position_dependent_options created with no argument
 745   // will take its values from here.
 746   static General_options default_options_;
 747 };
 748
 749
 750 // A single file or library argument from the command line.
 751
 752 class Input_file_argument
 753 {
 754  public:
 755   // name: file name or library name
 756   // is_lib: true if name is a library name: that is, emits the leading
 757   //         "lib" and trailing ".so"/".a" from the name
 758   // extra_search_path: an extra directory to look for the file, prior
 759   //         to checking the normal library search path.  If this is "",
 760   //         then no extra directory is added.
 761   // just_symbols: whether this file only defines symbols.
 762   // options: The position dependent options at this point in the
 763   //         command line, such as --whole-archive.
 764   Input_file_argument()
 765     : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false),
 766       options_()
 767   { }
 768
 769   Input_file_argument(const char* name, bool is_lib,
 770                       const char* extra_search_path,
 771                       bool just_symbols,
 772                       const Position_dependent_options& options)
 773     : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
 774       just_symbols_(just_symbols), options_(options)
 775   { }
 776
 777   // You can also pass in a General_options instance instead of a
 778   // Position_dependent_options.  In that case, we extract the
 779   // position-independent vars from the General_options and only store
 780   // those.
 781   Input_file_argument(const char* name, bool is_lib,
 782                       const char* extra_search_path,
 783                       bool just_symbols,
 784                       const General_options& options)
 785     : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
 786       just_symbols_(just_symbols), options_(options)
 787   { }
 788
 789   const char*
 790   name() const
 791   { return this->name_.c_str(); }
 792
 793   const Position_dependent_options&
 794   options() const
 795   { return this->options_; }
 796
 797   bool
 798   is_lib() const
 799   { return this->is_lib_; }
 800
 801   const char*
 802   extra_search_path() const
 803   {
 804     return (this->extra_search_path_.empty()
 805             ? NULL
 806             : this->extra_search_path_.c_str());
 807   }
 808
 809   // Return whether we should only read symbols from this file.
 810   bool
 811   just_symbols() const
 812   { return this->just_symbols_; }
 813
 814   // Return whether this file may require a search using the -L
 815   // options.
 816   bool
 817   may_need_search() const
 818   { return this->is_lib_ || !this->extra_search_path_.empty(); }
 819
 820  private:
 821   // We use std::string, not const char*, here for convenience when
 822   // using script files, so that we do not have to preserve the string
 823   // in that case.
 824   std::string name_;
 825   bool is_lib_;
 826   std::string extra_search_path_;
 827   bool just_symbols_;
 828   Position_dependent_options options_;
 829 };
 830
 831 // A file or library, or a group, from the command line.
 832
 833 class Input_argument
 834 {
 835  public:
 836   // Create a file or library argument.
 837   explicit Input_argument(Input_file_argument file)
 838     : is_file_(true), file_(file), group_(NULL)
 839   { }
 840
 841   // Create a group argument.
 842   explicit Input_argument(Input_file_group* group)
 843     : is_file_(false), group_(group)
 844   { }
 845
 846   // Return whether this is a file.
 847   bool
 848   is_file() const
 849   { return this->is_file_; }
 850
 851   // Return whether this is a group.
 852   bool
 853   is_group() const
 854   { return !this->is_file_; }
 855
 856   // Return the information about the file.
 857   const Input_file_argument&
 858   file() const
 859   {
 860     gold_assert(this->is_file_);
 861     return this->file_;
 862   }
 863
 864   // Return the information about the group.
 865   const Input_file_group*
 866   group() const
 867   {
 868     gold_assert(!this->is_file_);
 869     return this->group_;
 870   }
 871
 872   Input_file_group*
 873   group()
 874   {
 875     gold_assert(!this->is_file_);
 876     return this->group_;
 877   }
 878
 879  private:
 880   bool is_file_;
 881   Input_file_argument file_;
 882   Input_file_group* group_;
 883 };
 884
 885 // A group from the command line.  This is a set of arguments within
 886 // --start-group ... --end-group.
 887
 888 class Input_file_group
 889 {
 890  public:
 891   typedef std::vector<Input_argument> Files;
 892   typedef Files::const_iterator const_iterator;
 893
 894   Input_file_group()
 895     : files_()
 896   { }
 897
 898   // Add a file to the end of the group.
 899   void
 900   add_file(const Input_file_argument& arg)
 901   { this->files_.push_back(Input_argument(arg)); }
 902
 903   // Iterators to iterate over the group contents.
 904
 905   const_iterator
 906   begin() const
 907   { return this->files_.begin(); }
 908
 909   const_iterator
 910   end() const
 911   { return this->files_.end(); }
 912
 913  private:
 914   Files files_;
 915 };
 916
 917 // A list of files from the command line or a script.
 918
 919 class Input_arguments
 920 {
 921  public:
 922   typedef std::vector<Input_argument> Input_argument_list;
 923   typedef Input_argument_list::const_iterator const_iterator;
 924
 925   Input_arguments()
 926     : input_argument_list_(), in_group_(false)
 927   { }
 928
 929   // Add a file.
 930   void
 931   add_file(const Input_file_argument& arg);
 932
 933   // Start a group (the --start-group option).
 934   void
 935   start_group();
 936
 937   // End a group (the --end-group option).
 938   void
 939   end_group();
 940
 941   // Return whether we are currently in a group.
 942   bool
 943   in_group() const
 944   { return this->in_group_; }
 945
 946   // The number of entries in the list.
 947   int
 948   size() const
 949   { return this->input_argument_list_.size(); }
 950
 951   // Iterators to iterate over the list of input files.
 952
 953   const_iterator
 954   begin() const
 955   { return this->input_argument_list_.begin(); }
 956
 957   const_iterator
 958   end() const
 959   { return this->input_argument_list_.end(); }
 960
 961   // Return whether the list is empty.
 962   bool
 963   empty() const
 964   { return this->input_argument_list_.empty(); }
 965
 966  private:
 967   Input_argument_list input_argument_list_;
 968   bool in_group_;
 969 };
 970
 971
 972 // All the information read from the command line.  These are held in
 973 // three separate structs: one to hold the options (--foo), one to
 974 // hold the filenames listed on the commandline, and one to hold
 975 // linker script information.  This third is not a subset of the other
 976 // two because linker scripts can be specified either as options (via
 977 // -T) or as a file.
 978
 979 class Command_line
 980 {
 981  public:
 982   typedef Input_arguments::const_iterator const_iterator;
 983
 984   Command_line();
 985
 986   // Process the command line options.  This will exit with an
 987   // appropriate error message if an unrecognized option is seen.
 988   void
 989   process(int argc, const char** argv);
 990
 991   // Process one command-line option.  This takes the index of argv to
 992   // process, and returns the index for the next option.  no_more_options
 993   // is set to true if argv[i] is "--".
 994   int
 995   process_one_option(int argc, const char** argv, int i,
 996                      bool* no_more_options);
 997
 998   // Get the general options.
 999   const General_options&
1000   options() const
1001   { return this->options_; }
1002
1003   // Get the position dependent options.
1004   const Position_dependent_options&
1005   position_dependent_options() const
1006   { return this->position_options_; }
1007
1008   // Get the linker-script options.
1009   Script_options&
1010   script_options()
1011   { return this->script_options_; }
1012
1013   // Get the version-script options: a convenience routine.
1014   const Version_script_info&
1015   version_script() const
1016   { return *this->script_options_.version_script_info(); }
1017
1018   // Get the input files.
1019   Input_arguments&
1020   inputs()
1021   { return this->inputs_; }
1022
1023   // The number of input files.
1024   int
1025   number_of_input_files() const
1026   { return this->inputs_.size(); }
1027
1028   // Iterators to iterate over the list of input files.
1029
1030   const_iterator
1031   begin() const
1032   { return this->inputs_.begin(); }
1033
1034   const_iterator
1035   end() const
1036   { return this->inputs_.end(); }
1037
1038  private:
1039   Command_line(const Command_line&);
1040   Command_line& operator=(const Command_line&);
1041
1042   General_options options_;
1043   Position_dependent_options position_options_;
1044   Script_options script_options_;
1045   Input_arguments inputs_;
1046 };
1047
1048 } // End namespace gold.
1049
1050 #endif // !defined(GOLD_OPTIONS_H)