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