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