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