Copyright update for binutils
[external/binutils.git] / gold / options.h
1 // options.h -- handle command line options for gold  -*- C++ -*-
2
3 // Copyright (C) 2006-2016 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(apply_dynamic_relocs, options::TWO_DASHES, '\0', true,
648               N_("Apply link-time values for dynamic relocations (default)"),
649               N_("(aarch64 only) Do not apply link-time values "
650                  "for dynamic relocations"));
651
652   DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
653               N_("Only set DT_NEEDED for shared libraries if used"),
654               N_("Always DT_NEEDED for shared libraries"));
655
656   DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
657               N_("Ignored"), N_("[ignored]"),
658               {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
659
660   // This should really be an "enum", but it's too easy for folks to
661   // forget to update the list as they add new targets.  So we just
662   // accept any string.  We'll fail later (when the string is parsed),
663   // if the target isn't actually supported.
664   DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
665                 N_("Set input format"), ("[elf,binary]"));
666
667   DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
668               N_("-l searches for shared libraries"), NULL);
669   DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
670                     N_("-l does not search for shared libraries"), NULL,
671                     true);
672   DEFINE_bool_alias(dy, Bdynamic, options::ONE_DASH, '\0',
673                     N_("alias for -Bdynamic"), NULL, false);
674   DEFINE_bool_alias(dn, Bdynamic, options::ONE_DASH, '\0',
675                     N_("alias for -Bstatic"), NULL, true);
676
677   DEFINE_bool(Bgroup, options::ONE_DASH, '\0', false,
678               N_("Use group name lookup rules for shared library"), NULL);
679
680   DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
681               N_("Bind defined symbols locally"), NULL);
682
683   DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
684               N_("Bind defined function symbols locally"), NULL);
685
686   DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "tree",
687                          N_("Generate build ID note"),
688                          N_("[=STYLE]"));
689
690   DEFINE_uint64(build_id_chunk_size_for_treehash,
691                 options::TWO_DASHES, '\0', 2 << 20,
692                 N_("Chunk size for '--build-id=tree'"), N_("SIZE"));
693
694   DEFINE_uint64(build_id_min_file_size_for_treehash, options::TWO_DASHES,
695                 '\0', 40 << 20,
696                 N_("Minimum output file size for '--build-id=tree' to work"
697                    " differently than '--build-id=sha1'"), N_("SIZE"));
698
699   DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
700               N_("Check segment addresses for overlaps (default)"),
701               N_("Do not check segment addresses for overlaps"));
702
703   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
704               N_("Compress .debug_* sections in the output file"),
705               ("[none,zlib,zlib-gnu,zlib-gabi]"),
706               {"none", "zlib", "zlib-gnu", "zlib-gabi"});
707
708   DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
709               N_("Not supported"),
710               N_("Do not copy DT_NEEDED tags from shared libraries"));
711
712   DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
713               N_("Output cross reference table"),
714               N_("Do not output cross reference table"));
715
716   DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
717               N_("Use DT_INIT_ARRAY for all constructors (default)"),
718               N_("Handle constructors as directed by compiler"));
719
720   DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
721               N_("Define common symbols"),
722               N_("Do not define common symbols"));
723   DEFINE_bool(dc, options::ONE_DASH, '\0', false,
724               N_("Alias for -d"), NULL);
725   DEFINE_bool(dp, options::ONE_DASH, '\0', false,
726               N_("Alias for -d"), NULL);
727
728   DEFINE_string(debug, options::TWO_DASHES, '\0', "",
729                 N_("Turn on debugging"),
730                 N_("[all,files,script,task][,...]"));
731
732   DEFINE_special(defsym, options::TWO_DASHES, '\0',
733                  N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
734
735   DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
736                          N_("Demangle C++ symbols in log messages"),
737                          N_("[=STYLE]"));
738
739   DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
740               N_("Do not demangle C++ symbols in log messages"),
741               NULL);
742
743   DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
744               N_("Look for violations of the C++ One Definition Rule"),
745               N_("Do not look for violations of the C++ One Definition Rule"));
746
747   DEFINE_special(discard_all, options::TWO_DASHES, 'x',
748                  N_("Delete all local symbols"), NULL);
749   DEFINE_special(discard_locals, options::TWO_DASHES, 'X',
750                  N_("Delete all temporary local symbols"), NULL);
751   DEFINE_special(discard_none, options::TWO_DASHES, '\0',
752                  N_("Keep all local symbols"), NULL);
753
754   DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
755               N_("Add data symbols to dynamic symbols"), NULL);
756
757   DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
758               N_("Add C++ operator new/delete to dynamic symbols"), NULL);
759
760   DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
761               N_("Add C++ typeinfo to dynamic symbols"), NULL);
762
763   DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
764                  N_("Read a list of dynamic symbols"), N_("FILE"));
765
766   DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
767                 N_("Set program start address"), N_("ADDRESS"));
768
769   DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
770                  N_("Exclude libraries from automatic export"),
771                  N_(("lib,lib ...")));
772
773   DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
774               N_("Export all dynamic symbols"),
775               N_("Do not export all dynamic symbols (default)"));
776
777   DEFINE_set(export_dynamic_symbol, options::TWO_DASHES, '\0',
778              N_("Export SYMBOL to dynamic symbol table"), N_("SYMBOL"));
779
780   DEFINE_special(EB, options::ONE_DASH, '\0',
781                  N_("Link big-endian objects."), NULL);
782
783   DEFINE_special(EL, options::ONE_DASH, '\0',
784                  N_("Link little-endian objects."), NULL);
785
786   DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
787               N_("Create exception frame header"), NULL);
788
789   DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
790               N_("(ARM only) Do not warn about objects with incompatible "
791                  "enum sizes"));
792
793   DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
794              N_("Auxiliary filter for shared object symbol table"),
795              N_("SHLIB"));
796
797   DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
798                 N_("Filter for shared object symbol table"),
799                 N_("SHLIB"));
800
801   DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
802               N_("Treat warnings as errors"),
803               N_("Do not treat warnings as errors"));
804
805   DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
806                 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
807
808   DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
809               N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
810               N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
811
812   DEFINE_bool(fix_cortex_a53_843419, options::TWO_DASHES, '\0', false,
813               N_("(AArch64 only) Fix Cortex-A53 erratum 843419."),
814               N_("(AArch64 only) Do not fix Cortex-A53 erratum 843419."));
815
816   DEFINE_bool(fix_cortex_a53_835769, options::TWO_DASHES, '\0', false,
817               N_("(AArch64 only) Fix Cortex-A53 erratum 835769."),
818               N_("(AArch64 only) Do not fix Cortex-A53 erratum 835769."));
819
820   DEFINE_bool(fix_arm1176, options::TWO_DASHES, '\0', true,
821               N_("(ARM only) Fix binaries for ARM1176 erratum."),
822               N_("(ARM only) Do not fix binaries for ARM1176 erratum."));
823
824   DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
825               N_("(ARM only) Merge exidx entries in debuginfo."),
826               N_("(ARM only) Do not merge exidx entries in debuginfo."));
827
828   DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
829                  N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
830                  NULL);
831
832   DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
833                  N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
834                     "veneer"),
835                  NULL);
836
837   DEFINE_bool(long_plt, options::TWO_DASHES, '\0', false,
838               N_("(ARM only) Generate long PLT entries"),
839               N_("(ARM only) Do not generate long PLT entries"));
840
841   DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
842               N_("Ignored"), NULL);
843
844   DEFINE_bool(gdb_index, options::TWO_DASHES, '\0', false,
845               N_("Generate .gdb_index section"),
846               N_("Do not generate .gdb_index section"));
847
848   DEFINE_bool(gnu_unique, options::TWO_DASHES, '\0', true,
849               N_("Enable STB_GNU_UNIQUE symbol binding (default)"),
850               N_("Disable STB_GNU_UNIQUE symbol binding"));
851
852   DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
853                 N_("Set shared library name"), N_("FILENAME"));
854
855   DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
856                 N_("Min fraction of empty buckets in dynamic hash"),
857                 N_("FRACTION"));
858
859   DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
860               N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
861               {"sysv", "gnu", "both"});
862
863   DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
864                 N_("Set dynamic linker path"), N_("PROGRAM"));
865
866   DEFINE_special(incremental, options::TWO_DASHES, '\0',
867                  N_("Do an incremental link if possible; "
868                     "otherwise, do a full link and prepare output "
869                     "for incremental linking"), NULL);
870
871   DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
872                  N_("Do a full link (default)"), NULL);
873
874   DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
875                  N_("Do a full link and "
876                     "prepare output for incremental linking"), NULL);
877
878   DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
879                  N_("Do an incremental link; exit if not possible"), NULL);
880
881   DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
882                 N_("Set base file for incremental linking"
883                    " (default is output file)"),
884                 N_("FILE"));
885
886   DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
887                  N_("Assume files changed"), NULL);
888
889   DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
890                  N_("Assume files didn't change"), NULL);
891
892   DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
893                  N_("Use timestamps to check files (default)"), NULL);
894
895   DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
896                  N_("Assume startup files unchanged "
897                     "(files preceding this option)"), NULL);
898
899   DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
900                  N_("Amount of extra space to allocate for patches"),
901                  N_("PERCENT"));
902
903   DEFINE_string(init, options::ONE_DASH, '\0', "_init",
904                 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
905
906   DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
907                  N_("Read only symbol values from FILE"), N_("FILE"));
908
909   DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
910               sizeof(void*) >= 8,
911               N_("Map whole files to memory (default on 64-bit hosts)"),
912               N_("Map relevant file parts to memory (default on 32-bit "
913                  "hosts)"));
914   DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
915               N_("Keep files mapped across passes (default)"),
916               N_("Release mapped files after each pass"));
917
918   DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
919               N_("Generate unwind information for PLT (default)"),
920               N_("Do not generate unwind information for PLT"));
921
922   DEFINE_special(library, options::TWO_DASHES, 'l',
923                  N_("Search for library LIBNAME"), N_("LIBNAME"));
924
925   DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
926                  N_("Add directory to search path"), N_("DIR"));
927
928   DEFINE_bool(text_reorder, options::TWO_DASHES, '\0', true,
929               N_("Enable text section reordering for GCC section names "
930                  "(default)"),
931               N_("Disable text section reordering for GCC section names"));
932
933   DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
934               N_("Only search directories specified on the command line."),
935               NULL);
936
937   DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
938               N_("Put read-only non-executable sections in their own segment"),
939               NULL);
940
941   DEFINE_uint64(rosegment_gap, options::TWO_DASHES, '\0', -1U,
942                 N_("Set offset between executable and read-only segments"),
943                 N_("OFFSET"));
944
945   DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
946                 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
947
948   DEFINE_bool(mmap_output_file, options::TWO_DASHES, '\0', true,
949               N_("Map the output file for writing (default)."),
950               N_("Do not map the output file for writing."));
951
952   DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
953               N_("Write map file on standard output"), NULL);
954   DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
955                 N_("MAPFILENAME"));
956
957   DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
958               N_("Do not page align data"), NULL);
959   DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
960               N_("Do not page align data, do not make text readonly"),
961               N_("Page align data, make text readonly"));
962
963   DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', true,
964                 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
965                 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
966
967   DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
968               N_("Create an output file even if errors occur"), NULL);
969
970   DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
971                     N_("Report undefined symbols (even with --shared)"),
972                     NULL, false);
973
974   DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
975                 N_("Set output file name"), N_("FILE"));
976
977   DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
978               N_("Optimize output file size"), N_("LEVEL"));
979
980   DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
981                 N_("Set output format"), N_("[binary]"));
982
983   DEFINE_bool(p, options::ONE_DASH, '\0', false,
984               N_("(ARM only) Ignore for backward compatibility"), NULL);
985
986   DEFINE_bool(pie, options::ONE_DASH, '\0', false,
987               N_("Create a position independent executable"),
988               N_("Do not create a position independent executable"));
989   DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
990                     N_("Create a position independent executable"),
991                     N_("Do not create a position independent executable"),
992                     false);
993
994   DEFINE_bool(pic_veneer, options::TWO_DASHES, '\0', false,
995               N_("Force PIC sequences for ARM/Thumb interworking veneers"),
996               NULL);
997
998   DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
999               NULL, N_("(ARM only) Ignore for backward compatibility"));
1000
1001   DEFINE_var(plt_align, options::TWO_DASHES, '\0', 0, "5",
1002              N_("(PowerPC64 only) Align PLT call stubs to fit cache lines"),
1003              N_("[=P2ALIGN]"), true, int, int, options::parse_uint);
1004
1005   DEFINE_bool(plt_static_chain, options::TWO_DASHES, '\0', false,
1006               N_("(PowerPC64 only) PLT call stubs should load r11"),
1007               N_("(PowerPC64 only) PLT call stubs should not load r11"));
1008
1009   DEFINE_bool(plt_thread_safe, options::TWO_DASHES, '\0', false,
1010               N_("(PowerPC64 only) PLT call stubs with load-load barrier"),
1011               N_("(PowerPC64 only) PLT call stubs without barrier"));
1012
1013 #ifdef ENABLE_PLUGINS
1014   DEFINE_special(plugin, options::TWO_DASHES, '\0',
1015                  N_("Load a plugin library"), N_("PLUGIN"));
1016   DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
1017                  N_("Pass an option to the plugin"), N_("OPTION"));
1018 #endif
1019
1020   DEFINE_bool(posix_fallocate, options::TWO_DASHES, '\0', true,
1021               N_("Use posix_fallocate to reserve space in the output file"
1022                  " (default)."),
1023               N_("Use fallocate or ftruncate to reserve space."));
1024
1025   DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
1026               N_("Preread archive symbols when multi-threaded"), NULL);
1027
1028   DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
1029               N_("Print default output format"), NULL);
1030
1031   DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
1032                 N_("Print symbols defined and used for each input"),
1033                 N_("FILENAME"));
1034
1035   DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
1036               N_("Ignored for SVR4 compatibility"), NULL);
1037
1038   DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
1039               N_("Generate relocations in output"), NULL);
1040
1041   DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
1042               N_("Generate relocatable output"), NULL);
1043   DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
1044                     N_("Synonym for -r"), NULL, false);
1045
1046   DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
1047               N_("Relax branches on certain targets"), NULL);
1048
1049   DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
1050                 N_("keep only symbols listed in this file"), N_("FILE"));
1051
1052   // -R really means -rpath, but can mean --just-symbols for
1053   // compatibility with GNU ld.  -rpath is always -rpath, so we list
1054   // it separately.
1055   DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
1056                  N_("Add DIR to runtime search path"), N_("DIR"));
1057
1058   DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
1059                  N_("Add DIR to runtime search path"), N_("DIR"));
1060
1061   DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
1062                  N_("Add DIR to link time shared library search path"),
1063                  N_("DIR"));
1064
1065   DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
1066                 N_("Layout sections in the order specified."),
1067                 N_("FILENAME"));
1068
1069   DEFINE_special(section_start, options::TWO_DASHES, '\0',
1070                  N_("Set address of section"), N_("SECTION=ADDRESS"));
1071
1072   DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
1073                          N_("Sort common symbols by alignment"),
1074                          N_("[={ascending,descending}]"));
1075
1076   DEFINE_enum(sort_section, options::TWO_DASHES, '\0', "none",
1077               N_("Sort sections by name.  \'--no-text-reorder\'"
1078                  " will override \'--sort-section=name\' for .text"),
1079               N_("[none,name]"),
1080               {"none", "name"});
1081
1082   DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
1083               N_("Dynamic tag slots to reserve (default 5)"),
1084               N_("COUNT"));
1085
1086   DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
1087               N_("Strip all symbols"), NULL);
1088   DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
1089               N_("Strip debugging information"), NULL);
1090   DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
1091               N_("Emit only debug line number information"), NULL);
1092   DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
1093               N_("Strip debug symbols that are unused by gdb "
1094                  "(at least versions <= 7.4)"), NULL);
1095   DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
1096               N_("Strip LTO intermediate code sections"), NULL);
1097
1098   DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
1099              N_("(ARM, PowerPC only) The maximum distance from instructions "
1100                 "in a group of sections to their stubs.  Negative values mean "
1101                 "stubs are always after (PowerPC before) the group.  1 means "
1102                 "use default size.\n"),
1103              N_("SIZE"));
1104
1105   DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
1106               N_("Use less memory and more disk I/O "
1107                  "(included only for compatibility with GNU ld)"), NULL);
1108
1109   DEFINE_bool(shared, options::ONE_DASH, 'G', false,
1110               N_("Generate shared library"), NULL);
1111
1112   DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
1113               N_("Generate shared library"), NULL);
1114
1115   DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
1116               N_("Stack size when -fsplit-stack function calls non-split"),
1117               N_("SIZE"));
1118
1119   // This is not actually special in any way, but I need to give it
1120   // a non-standard accessor-function name because 'static' is a keyword.
1121   DEFINE_special(static, options::ONE_DASH, '\0',
1122                  N_("Do not link against shared libraries"), NULL);
1123
1124   DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
1125               N_("Identical Code Folding. "
1126                  "\'--icf=safe\' Folds ctors, dtors and functions whose"
1127                  " pointers are definitely not taken."),
1128               ("[none,all,safe]"),
1129               {"none", "all", "safe"});
1130
1131   DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
1132               N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
1133
1134   DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
1135               N_("List folded identical sections on stderr"),
1136               N_("Do not list folded identical sections"));
1137
1138   DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
1139              N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1140
1141   DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
1142               N_("Remove unused sections"),
1143               N_("Don't remove unused sections (default)"));
1144
1145   DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
1146               N_("List removed unused sections on stderr"),
1147               N_("Do not list removed unused sections"));
1148
1149   DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
1150               N_("Print resource usage statistics"), NULL);
1151
1152   DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
1153                 N_("Set target system root directory"), N_("DIR"));
1154
1155   DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1156               N_("Print the name of each input file"), NULL);
1157
1158   DEFINE_special(script, options::TWO_DASHES, 'T',
1159                  N_("Read linker script"), N_("FILE"));
1160
1161   DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
1162               N_("Run the linker multi-threaded"),
1163               N_("Do not run the linker multi-threaded"));
1164   DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
1165               N_("Number of threads to use"), N_("COUNT"));
1166   DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
1167               N_("Number of threads to use in initial pass"), N_("COUNT"));
1168   DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
1169               N_("Number of threads to use in middle pass"), N_("COUNT"));
1170   DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
1171               N_("Number of threads to use in final pass"), N_("COUNT"));
1172
1173   DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1174                 N_("Set the address of the bss segment"), N_("ADDRESS"));
1175   DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1176                 N_("Set the address of the data segment"), N_("ADDRESS"));
1177   DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1178                 N_("Set the address of the text segment"), N_("ADDRESS"));
1179   DEFINE_uint64_alias(Ttext_segment, Ttext, options::ONE_DASH, '\0',
1180                       N_("Set the address of the text segment"),
1181                       N_("ADDRESS"));
1182   DEFINE_uint64(Trodata_segment, options::ONE_DASH, '\0', -1U,
1183                 N_("Set the address of the rodata segment"), N_("ADDRESS"));
1184
1185   DEFINE_bool(toc_optimize, options::TWO_DASHES, '\0', true,
1186               N_("(PowerPC64 only) Optimize TOC code sequences"),
1187               N_("(PowerPC64 only) Don't optimize TOC code sequences"));
1188
1189   DEFINE_bool(toc_sort, options::TWO_DASHES, '\0', true,
1190               N_("(PowerPC64 only) Sort TOC and GOT sections"),
1191               N_("(PowerPC64 only) Don't sort TOC and GOT sections"));
1192
1193   DEFINE_set(undefined, options::TWO_DASHES, 'u',
1194              N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1195
1196   DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1197               N_("How to handle unresolved symbols"),
1198               ("ignore-all,report-all,ignore-in-object-files,"
1199                "ignore-in-shared-libs"),
1200               {"ignore-all", "report-all", "ignore-in-object-files",
1201                   "ignore-in-shared-libs"});
1202
1203   DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1204               N_("Synonym for --debug=files"), NULL);
1205
1206   DEFINE_special(version_script, options::TWO_DASHES, '\0',
1207                  N_("Read version script"), N_("FILE"));
1208
1209   DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1210               N_("Warn about duplicate common symbols"),
1211               N_("Do not warn about duplicate common symbols (default)"));
1212
1213   DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1214               N_("Ignored"), N_("Ignored"));
1215
1216   DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1217               N_("Warn if the stack is executable"),
1218               N_("Do not warn if the stack is executable (default)"));
1219
1220   DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1221               NULL, N_("Don't warn about mismatched input files"));
1222
1223   DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1224               N_("Ignored"), NULL);
1225
1226   DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1227               N_("Warn when skipping an incompatible library"),
1228               N_("Don't warn when skipping an incompatible library"));
1229
1230   DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1231               N_("Warn if text segment is not shareable"),
1232               N_("Do not warn if text segment is not shareable (default)"));
1233
1234   DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1235               N_("Report unresolved symbols as warnings"),
1236               NULL);
1237   DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1238                     options::TWO_DASHES, '\0',
1239                     N_("Report unresolved symbols as errors"),
1240                     NULL, true);
1241   DEFINE_bool(weak_unresolved_symbols, options::TWO_DASHES, '\0', false,
1242               N_("Convert unresolved symbols to weak references"),
1243               NULL);
1244
1245   DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1246               N_("(ARM only) Do not warn about objects with incompatible "
1247                  "wchar_t sizes"));
1248
1249   DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1250               N_("Include all archive contents"),
1251               N_("Include only needed archive contents"));
1252
1253   DEFINE_set(wrap, options::TWO_DASHES, '\0',
1254              N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1255
1256   DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1257              N_("Trace references to symbol"), N_("SYMBOL"));
1258
1259   DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1260               N_("Allow unused version in script (default)"),
1261               N_("Do not allow unused version in script"));
1262
1263   DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1264                 N_("Default search path for Solaris compatibility"),
1265                 N_("PATH"));
1266
1267   DEFINE_special(start_group, options::TWO_DASHES, '(',
1268                  N_("Start a library search group"), NULL);
1269   DEFINE_special(end_group, options::TWO_DASHES, ')',
1270                  N_("End a library search group"), NULL);
1271
1272
1273   DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1274                  N_("Start a library"), NULL);
1275   DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1276                  N_("End a library "), NULL);
1277
1278   DEFINE_string(fuse_ld, options::ONE_DASH, '\0', "",
1279                 N_("Ignored for GCC linker option compatibility"),
1280                 "");
1281
1282   // The -z options.
1283
1284   DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1285               N_("Sort dynamic relocs"),
1286               N_("Do not sort dynamic relocs"));
1287   DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1288                 N_("Set common page size to SIZE"), N_("SIZE"));
1289   DEFINE_bool(defs, options::DASH_Z, '\0', false,
1290               N_("Report undefined symbols (even with --shared)"),
1291               NULL);
1292   DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1293               N_("Mark output as requiring executable stack"), NULL);
1294   DEFINE_bool(global, options::DASH_Z, '\0', false,
1295               N_("Make symbols in DSO available for subsequently loaded "
1296                  "objects"), NULL);
1297   DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1298               N_("Mark DSO to be initialized first at runtime"),
1299               NULL);
1300   DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1301               N_("Mark object to interpose all DSOs but executable"),
1302               NULL);
1303   DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1304                     N_("Mark object for lazy runtime binding (default)"),
1305                     NULL, true);
1306   DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1307               N_("Mark object requiring immediate process"),
1308               NULL);
1309   DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1310                 N_("Set maximum page size to SIZE"), N_("SIZE"));
1311   DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1312               N_("Allow multiple definitions of symbols"),
1313               NULL);
1314   // copyreloc is here in the list because there is only -z
1315   // nocopyreloc, not -z copyreloc.
1316   DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1317               NULL,
1318               N_("Do not create copy relocs"));
1319   DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1320               N_("Mark object not to use default search paths"),
1321               NULL);
1322   DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1323               N_("Mark DSO non-deletable at runtime"),
1324               NULL);
1325   DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1326               N_("Mark DSO not available to dlopen"),
1327               NULL);
1328   DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1329               N_("Mark DSO not available to dldump"),
1330               NULL);
1331   DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1332               N_("Mark output as not requiring executable stack"), NULL);
1333   DEFINE_bool(now, options::DASH_Z, '\0', false,
1334               N_("Mark object for immediate function binding"),
1335               NULL);
1336   DEFINE_bool(origin, options::DASH_Z, '\0', false,
1337               N_("Mark DSO to indicate that needs immediate $ORIGIN "
1338                  "processing at runtime"), NULL);
1339   DEFINE_bool(relro, options::DASH_Z, '\0', false,
1340               N_("Where possible mark variables read-only after relocation"),
1341               N_("Don't mark variables read-only after relocation"));
1342   DEFINE_bool(text, options::DASH_Z, '\0', false,
1343               N_("Do not permit relocations in read-only segments"),
1344               N_("Permit relocations in read-only segments (default)"));
1345   DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1346                     N_("Permit relocations in read-only segments (default)"),
1347                     NULL, true);
1348
1349  public:
1350   typedef options::Dir_list Dir_list;
1351
1352   General_options();
1353
1354   // Does post-processing on flags, making sure they all have
1355   // non-conflicting values.  Also converts some flags from their
1356   // "standard" types (string, etc), to another type (enum, DirList),
1357   // which can be accessed via a separate method.  Dies if it notices
1358   // any problems.
1359   void finalize();
1360
1361   // True if we printed the version information.
1362   bool
1363   printed_version() const
1364   { return this->printed_version_; }
1365
1366   // The macro defines output() (based on --output), but that's a
1367   // generic name.  Provide this alternative name, which is clearer.
1368   const char*
1369   output_file_name() const
1370   { return this->output(); }
1371
1372   // This is not defined via a flag, but combines flags to say whether
1373   // the output is position-independent or not.
1374   bool
1375   output_is_position_independent() const
1376   { return this->shared() || this->pie(); }
1377
1378   // Return true if the output is something that can be exec()ed, such
1379   // as a static executable, or a position-dependent or
1380   // position-independent executable, but not a dynamic library or an
1381   // object file.
1382   bool
1383   output_is_executable() const
1384   { return !this->shared() && !this->relocatable(); }
1385
1386   // This would normally be static(), and defined automatically, but
1387   // since static is a keyword, we need to come up with our own name.
1388   bool
1389   is_static() const
1390   { return static_; }
1391
1392   // In addition to getting the input and output formats as a string
1393   // (via format() and oformat()), we also give access as an enum.
1394   enum Object_format
1395   {
1396     // Ordinary ELF.
1397     OBJECT_FORMAT_ELF,
1398     // Straight binary format.
1399     OBJECT_FORMAT_BINARY
1400   };
1401
1402   // Convert a string to an Object_format.  Gives an error if the
1403   // string is not recognized.
1404   static Object_format
1405   string_to_object_format(const char* arg);
1406
1407   // Note: these functions are not very fast.
1408   Object_format format_enum() const;
1409   Object_format oformat_enum() const;
1410
1411   // Return whether FILENAME is in a system directory.
1412   bool
1413   is_in_system_directory(const std::string& name) const;
1414
1415   // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1416   bool
1417   should_retain_symbol(const char* symbol_name) const
1418     {
1419       if (symbols_to_retain_.empty())    // means flag wasn't specified
1420         return true;
1421       return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1422     }
1423
1424   // These are the best way to get access to the execstack state,
1425   // not execstack() and noexecstack() which are hard to use properly.
1426   bool
1427   is_execstack_set() const
1428   { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1429
1430   bool
1431   is_stack_executable() const
1432   { return this->execstack_status_ == EXECSTACK_YES; }
1433
1434   bool
1435   icf_enabled() const
1436   { return this->icf_status_ != ICF_NONE; }
1437
1438   bool
1439   icf_safe_folding() const
1440   { return this->icf_status_ == ICF_SAFE; }
1441
1442   // The --demangle option takes an optional string, and there is also
1443   // a --no-demangle option.  This is the best way to decide whether
1444   // to demangle or not.
1445   bool
1446   do_demangle() const
1447   { return this->do_demangle_; }
1448
1449   // Returns TRUE if any plugin libraries have been loaded.
1450   bool
1451   has_plugins() const
1452   { return this->plugins_ != NULL; }
1453
1454   // Return a pointer to the plugin manager.
1455   Plugin_manager*
1456   plugins() const
1457   { return this->plugins_; }
1458
1459   // True iff SYMBOL was found in the file specified by dynamic-list.
1460   bool
1461   in_dynamic_list(const char* symbol) const
1462   { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1463
1464   // True if a --dynamic-list script was provided.
1465   bool
1466   have_dynamic_list() const
1467   { return this->have_dynamic_list_; }
1468
1469   // Finalize the dynamic list.
1470   void
1471   finalize_dynamic_list()
1472   { this->dynamic_list_.version_script_info()->finalize(); }
1473
1474   // The mode selected by the --incremental options.
1475   enum Incremental_mode
1476   {
1477     // No incremental linking (--no-incremental).
1478     INCREMENTAL_OFF,
1479     // Incremental update only (--incremental-update).
1480     INCREMENTAL_UPDATE,
1481     // Force a full link, but prepare for subsequent incremental link
1482     // (--incremental-full).
1483     INCREMENTAL_FULL,
1484     // Incremental update if possible, fallback to full link  (--incremental).
1485     INCREMENTAL_AUTO
1486   };
1487
1488   // The incremental linking mode.
1489   Incremental_mode
1490   incremental_mode() const
1491   { return this->incremental_mode_; }
1492
1493   // The disposition given by the --incremental-changed,
1494   // --incremental-unchanged or --incremental-unknown option.  The
1495   // value may change as we proceed parsing the command line flags.
1496   Incremental_disposition
1497   incremental_disposition() const
1498   { return this->incremental_disposition_; }
1499
1500   // The disposition to use for startup files (those that precede the
1501   // first --incremental-changed, etc. option).
1502   Incremental_disposition
1503   incremental_startup_disposition() const
1504   { return this->incremental_startup_disposition_; }
1505
1506   // Return true if S is the name of a library excluded from automatic
1507   // symbol export.
1508   bool
1509   check_excluded_libs(const std::string &s) const;
1510
1511   // If an explicit start address was given for section SECNAME with
1512   // the --section-start option, return true and set *PADDR to the
1513   // address.  Otherwise return false.
1514   bool
1515   section_start(const char* secname, uint64_t* paddr) const;
1516
1517   // Return whether any --section-start option was used.
1518   bool
1519   any_section_start() const
1520   { return !this->section_starts_.empty(); }
1521
1522   enum Fix_v4bx
1523   {
1524     // Leave original instruction.
1525     FIX_V4BX_NONE,
1526     // Replace instruction.
1527     FIX_V4BX_REPLACE,
1528     // Generate an interworking veneer.
1529     FIX_V4BX_INTERWORKING
1530   };
1531
1532   Fix_v4bx
1533   fix_v4bx() const
1534   { return (this->fix_v4bx_); }
1535
1536   enum Endianness
1537   {
1538     ENDIANNESS_NOT_SET,
1539     ENDIANNESS_BIG,
1540     ENDIANNESS_LITTLE
1541   };
1542
1543   Endianness
1544   endianness() const
1545   { return this->endianness_; }
1546
1547   bool
1548   discard_all() const
1549   { return this->discard_locals_ == DISCARD_ALL; }
1550
1551   bool
1552   discard_locals() const
1553   { return this->discard_locals_ == DISCARD_LOCALS; }
1554
1555   bool
1556   discard_sec_merge() const
1557   { return this->discard_locals_ == DISCARD_SEC_MERGE; }
1558
1559  private:
1560   // Don't copy this structure.
1561   General_options(const General_options&);
1562   General_options& operator=(const General_options&);
1563
1564   // What local symbols to discard.
1565   enum Discard_locals
1566   {
1567     // Locals in merge sections (default).
1568     DISCARD_SEC_MERGE,
1569     // None (--discard-none).
1570     DISCARD_NONE,
1571     // Temporary locals (--discard-locals/-X).
1572     DISCARD_LOCALS,
1573     // All locals (--discard-all/-x).
1574     DISCARD_ALL
1575   };
1576
1577   // Whether to mark the stack as executable.
1578   enum Execstack
1579   {
1580     // Not set on command line.
1581     EXECSTACK_FROM_INPUT,
1582     // Mark the stack as executable (-z execstack).
1583     EXECSTACK_YES,
1584     // Mark the stack as not executable (-z noexecstack).
1585     EXECSTACK_NO
1586   };
1587
1588   enum Icf_status
1589   {
1590     // Do not fold any functions (Default or --icf=none).
1591     ICF_NONE,
1592     // All functions are candidates for folding. (--icf=all).
1593     ICF_ALL,
1594     // Only ctors and dtors are candidates for folding. (--icf=safe).
1595     ICF_SAFE
1596   };
1597
1598   void
1599   set_icf_status(Icf_status value)
1600   { this->icf_status_ = value; }
1601
1602   void
1603   set_execstack_status(Execstack value)
1604   { this->execstack_status_ = value; }
1605
1606   void
1607   set_do_demangle(bool value)
1608   { this->do_demangle_ = value; }
1609
1610   void
1611   set_static(bool value)
1612   { static_ = value; }
1613
1614   // These are called by finalize() to set up the search-path correctly.
1615   void
1616   add_to_library_path_with_sysroot(const std::string& arg)
1617   { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1618
1619   // Apply any sysroot to the directory lists.
1620   void
1621   add_sysroot();
1622
1623   // Add a plugin and its arguments to the list of plugins.
1624   void
1625   add_plugin(const char* filename);
1626
1627   // Add a plugin option.
1628   void
1629   add_plugin_option(const char* opt);
1630
1631   // Whether we printed version information.
1632   bool printed_version_;
1633   // Whether to mark the stack as executable.
1634   Execstack execstack_status_;
1635   // Whether to do code folding.
1636   Icf_status icf_status_;
1637   // Whether to do a static link.
1638   bool static_;
1639   // Whether to do demangling.
1640   bool do_demangle_;
1641   // List of plugin libraries.
1642   Plugin_manager* plugins_;
1643   // The parsed output of --dynamic-list files.  For convenience in
1644   // script.cc, we store this as a Script_options object, even though
1645   // we only use a single Version_tree from it.
1646   Script_options dynamic_list_;
1647   // Whether a --dynamic-list file was provided.
1648   bool have_dynamic_list_;
1649   // The incremental linking mode.
1650   Incremental_mode incremental_mode_;
1651   // The disposition given by the --incremental-changed,
1652   // --incremental-unchanged or --incremental-unknown option.  The
1653   // value may change as we proceed parsing the command line flags.
1654   Incremental_disposition incremental_disposition_;
1655   // The disposition to use for startup files (those marked
1656   // INCREMENTAL_STARTUP).
1657   Incremental_disposition incremental_startup_disposition_;
1658   // Whether we have seen one of the options that require incremental
1659   // build (--incremental-changed, --incremental-unchanged,
1660   // --incremental-unknown, or --incremental-startup-unchanged).
1661   bool implicit_incremental_;
1662   // Libraries excluded from automatic export, via --exclude-libs.
1663   Unordered_set<std::string> excluded_libs_;
1664   // List of symbol-names to keep, via -retain-symbol-info.
1665   Unordered_set<std::string> symbols_to_retain_;
1666   // Map from section name to address from --section-start.
1667   std::map<std::string, uint64_t> section_starts_;
1668   // Whether to process armv4 bx instruction relocation.
1669   Fix_v4bx fix_v4bx_;
1670   // Endianness.
1671   Endianness endianness_;
1672   // What local symbols to discard.
1673   Discard_locals discard_locals_;
1674 };
1675
1676 // The position-dependent options.  We use this to store the state of
1677 // the commandline at a particular point in parsing for later
1678 // reference.  For instance, if we see "ld --whole-archive foo.a
1679 // --no-whole-archive," we want to store the whole-archive option with
1680 // foo.a, so when the time comes to parse foo.a we know we should do
1681 // it in whole-archive mode.  We could store all of General_options,
1682 // but that's big, so we just pick the subset of flags that actually
1683 // change in a position-dependent way.
1684
1685 #define DEFINE_posdep(varname__, type__)        \
1686  public:                                        \
1687   type__                                        \
1688   varname__() const                             \
1689   { return this->varname__##_; }                \
1690                                                 \
1691   void                                          \
1692   set_##varname__(type__ value)                 \
1693   { this->varname__##_ = value; }               \
1694  private:                                       \
1695   type__ varname__##_
1696
1697 class Position_dependent_options
1698 {
1699  public:
1700   Position_dependent_options(const General_options& options
1701                              = Position_dependent_options::default_options_)
1702   { copy_from_options(options); }
1703
1704   void copy_from_options(const General_options& options)
1705   {
1706     this->set_as_needed(options.as_needed());
1707     this->set_Bdynamic(options.Bdynamic());
1708     this->set_format_enum(options.format_enum());
1709     this->set_whole_archive(options.whole_archive());
1710     this->set_incremental_disposition(options.incremental_disposition());
1711   }
1712
1713   DEFINE_posdep(as_needed, bool);
1714   DEFINE_posdep(Bdynamic, bool);
1715   DEFINE_posdep(format_enum, General_options::Object_format);
1716   DEFINE_posdep(whole_archive, bool);
1717   DEFINE_posdep(incremental_disposition, Incremental_disposition);
1718
1719  private:
1720   // This is a General_options with everything set to its default
1721   // value.  A Position_dependent_options created with no argument
1722   // will take its values from here.
1723   static General_options default_options_;
1724 };
1725
1726
1727 // A single file or library argument from the command line.
1728
1729 class Input_file_argument
1730 {
1731  public:
1732   enum Input_file_type
1733   {
1734     // A regular file, name used as-is, not searched.
1735     INPUT_FILE_TYPE_FILE,
1736     // A library name.  When used, "lib" will be prepended and ".so" or
1737     // ".a" appended to make a filename, and that filename will be searched
1738     // for using the -L paths.
1739     INPUT_FILE_TYPE_LIBRARY,
1740     // A regular file, name used as-is, but searched using the -L paths.
1741     INPUT_FILE_TYPE_SEARCHED_FILE
1742   };
1743
1744   // name: file name or library name
1745   // type: the type of this input file.
1746   // extra_search_path: an extra directory to look for the file, prior
1747   //         to checking the normal library search path.  If this is "",
1748   //         then no extra directory is added.
1749   // just_symbols: whether this file only defines symbols.
1750   // options: The position dependent options at this point in the
1751   //         command line, such as --whole-archive.
1752   Input_file_argument()
1753     : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1754       just_symbols_(false), options_(), arg_serial_(0)
1755   { }
1756
1757   Input_file_argument(const char* name, Input_file_type type,
1758                       const char* extra_search_path,
1759                       bool just_symbols,
1760                       const Position_dependent_options& options)
1761     : name_(name), type_(type), extra_search_path_(extra_search_path),
1762       just_symbols_(just_symbols), options_(options), arg_serial_(0)
1763   { }
1764
1765   // You can also pass in a General_options instance instead of a
1766   // Position_dependent_options.  In that case, we extract the
1767   // position-independent vars from the General_options and only store
1768   // those.
1769   Input_file_argument(const char* name, Input_file_type type,
1770                       const char* extra_search_path,
1771                       bool just_symbols,
1772                       const General_options& options)
1773     : name_(name), type_(type), extra_search_path_(extra_search_path),
1774       just_symbols_(just_symbols), options_(options), arg_serial_(0)
1775   { }
1776
1777   const char*
1778   name() const
1779   { return this->name_.c_str(); }
1780
1781   const Position_dependent_options&
1782   options() const
1783   { return this->options_; }
1784
1785   bool
1786   is_lib() const
1787   { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1788
1789   bool
1790   is_searched_file() const
1791   { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1792
1793   const char*
1794   extra_search_path() const
1795   {
1796     return (this->extra_search_path_.empty()
1797             ? NULL
1798             : this->extra_search_path_.c_str());
1799   }
1800
1801   // Return whether we should only read symbols from this file.
1802   bool
1803   just_symbols() const
1804   { return this->just_symbols_; }
1805
1806   // Return whether this file may require a search using the -L
1807   // options.
1808   bool
1809   may_need_search() const
1810   {
1811     return (this->is_lib()
1812             || this->is_searched_file()
1813             || !this->extra_search_path_.empty());
1814   }
1815
1816   // Set the serial number for this argument.
1817   void
1818   set_arg_serial(unsigned int arg_serial)
1819   { this->arg_serial_ = arg_serial; }
1820
1821   // Get the serial number.
1822   unsigned int
1823   arg_serial() const
1824   { return this->arg_serial_; }
1825
1826  private:
1827   // We use std::string, not const char*, here for convenience when
1828   // using script files, so that we do not have to preserve the string
1829   // in that case.
1830   std::string name_;
1831   Input_file_type type_;
1832   std::string extra_search_path_;
1833   bool just_symbols_;
1834   Position_dependent_options options_;
1835   // A unique index for this file argument in the argument list.
1836   unsigned int arg_serial_;
1837 };
1838
1839 // A file or library, or a group, from the command line.
1840
1841 class Input_argument
1842 {
1843  public:
1844   // Create a file or library argument.
1845   explicit Input_argument(Input_file_argument file)
1846     : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
1847   { }
1848
1849   // Create a group argument.
1850   explicit Input_argument(Input_file_group* group)
1851     : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
1852   { }
1853
1854   // Create a lib argument.
1855   explicit Input_argument(Input_file_lib* lib)
1856     : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
1857   { }
1858
1859   // Return whether this is a file.
1860   bool
1861   is_file() const
1862   { return this->is_file_; }
1863
1864   // Return whether this is a group.
1865   bool
1866   is_group() const
1867   { return !this->is_file_ && this->lib_ == NULL; }
1868
1869   // Return whether this is a lib.
1870   bool
1871   is_lib() const
1872   { return this->lib_ != NULL; }
1873
1874   // Return the information about the file.
1875   const Input_file_argument&
1876   file() const
1877   {
1878     gold_assert(this->is_file_);
1879     return this->file_;
1880   }
1881
1882   // Return the information about the group.
1883   const Input_file_group*
1884   group() const
1885   {
1886     gold_assert(!this->is_file_);
1887     return this->group_;
1888   }
1889
1890   Input_file_group*
1891   group()
1892   {
1893     gold_assert(!this->is_file_);
1894     return this->group_;
1895   }
1896
1897   // Return the information about the lib.
1898   const Input_file_lib*
1899   lib() const
1900   {
1901     gold_assert(!this->is_file_);
1902     gold_assert(this->lib_);
1903     return this->lib_;
1904   }
1905
1906   Input_file_lib*
1907   lib()
1908   {
1909     gold_assert(!this->is_file_);
1910     gold_assert(this->lib_);
1911     return this->lib_;
1912   }
1913
1914   // If a script generated this argument, store a pointer to the script info.
1915   // Currently used only for recording incremental link information.
1916   void
1917   set_script_info(Script_info* info)
1918   { this->script_info_ = info; }
1919
1920   Script_info*
1921   script_info() const
1922   { return this->script_info_; }
1923
1924  private:
1925   bool is_file_;
1926   Input_file_argument file_;
1927   Input_file_group* group_;
1928   Input_file_lib* lib_;
1929   Script_info* script_info_;
1930 };
1931
1932 typedef std::vector<Input_argument> Input_argument_list;
1933
1934 // A group from the command line.  This is a set of arguments within
1935 // --start-group ... --end-group.
1936
1937 class Input_file_group
1938 {
1939  public:
1940   typedef Input_argument_list::const_iterator const_iterator;
1941
1942   Input_file_group()
1943     : files_()
1944   { }
1945
1946   // Add a file to the end of the group.
1947   Input_argument&
1948   add_file(const Input_file_argument& arg)
1949   {
1950     this->files_.push_back(Input_argument(arg));
1951     return this->files_.back();
1952   }
1953
1954   // Iterators to iterate over the group contents.
1955
1956   const_iterator
1957   begin() const
1958   { return this->files_.begin(); }
1959
1960   const_iterator
1961   end() const
1962   { return this->files_.end(); }
1963
1964  private:
1965   Input_argument_list files_;
1966 };
1967
1968 // A lib from the command line.  This is a set of arguments within
1969 // --start-lib ... --end-lib.
1970
1971 class Input_file_lib
1972 {
1973  public:
1974   typedef Input_argument_list::const_iterator const_iterator;
1975
1976   Input_file_lib(const Position_dependent_options& options)
1977     : files_(), options_(options)
1978   { }
1979
1980   // Add a file to the end of the lib.
1981   Input_argument&
1982   add_file(const Input_file_argument& arg)
1983   {
1984     this->files_.push_back(Input_argument(arg));
1985     return this->files_.back();
1986   }
1987
1988   const Position_dependent_options&
1989   options() const
1990   { return this->options_; }
1991
1992   // Iterators to iterate over the lib contents.
1993
1994   const_iterator
1995   begin() const
1996   { return this->files_.begin(); }
1997
1998   const_iterator
1999   end() const
2000   { return this->files_.end(); }
2001
2002   size_t
2003   size() const
2004   { return this->files_.size(); }
2005
2006  private:
2007   Input_argument_list files_;
2008   Position_dependent_options options_;
2009 };
2010
2011 // A list of files from the command line or a script.
2012
2013 class Input_arguments
2014 {
2015  public:
2016   typedef Input_argument_list::const_iterator const_iterator;
2017
2018   Input_arguments()
2019     : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
2020   { }
2021
2022   // Add a file.
2023   Input_argument&
2024   add_file(Input_file_argument& arg);
2025
2026   // Start a group (the --start-group option).
2027   void
2028   start_group();
2029
2030   // End a group (the --end-group option).
2031   void
2032   end_group();
2033
2034   // Start a lib (the --start-lib option).
2035   void
2036   start_lib(const Position_dependent_options&);
2037
2038   // End a lib (the --end-lib option).
2039   void
2040   end_lib();
2041
2042   // Return whether we are currently in a group.
2043   bool
2044   in_group() const
2045   { return this->in_group_; }
2046
2047   // Return whether we are currently in a lib.
2048   bool
2049   in_lib() const
2050   { return this->in_lib_; }
2051
2052   // The number of entries in the list.
2053   int
2054   size() const
2055   { return this->input_argument_list_.size(); }
2056
2057   // Iterators to iterate over the list of input files.
2058
2059   const_iterator
2060   begin() const
2061   { return this->input_argument_list_.begin(); }
2062
2063   const_iterator
2064   end() const
2065   { return this->input_argument_list_.end(); }
2066
2067   // Return whether the list is empty.
2068   bool
2069   empty() const
2070   { return this->input_argument_list_.empty(); }
2071
2072   // Return the number of input files.  This may be larger than
2073   // input_argument_list_.size(), because of files that are part
2074   // of groups or libs.
2075   int
2076   number_of_input_files() const
2077   { return this->file_count_; }
2078
2079  private:
2080   Input_argument_list input_argument_list_;
2081   bool in_group_;
2082   bool in_lib_;
2083   unsigned int file_count_;
2084 };
2085
2086
2087 // All the information read from the command line.  These are held in
2088 // three separate structs: one to hold the options (--foo), one to
2089 // hold the filenames listed on the commandline, and one to hold
2090 // linker script information.  This third is not a subset of the other
2091 // two because linker scripts can be specified either as options (via
2092 // -T) or as a file.
2093
2094 class Command_line
2095 {
2096  public:
2097   typedef Input_arguments::const_iterator const_iterator;
2098
2099   Command_line();
2100
2101   // Process the command line options.  This will exit with an
2102   // appropriate error message if an unrecognized option is seen.
2103   void
2104   process(int argc, const char** argv);
2105
2106   // Process one command-line option.  This takes the index of argv to
2107   // process, and returns the index for the next option.  no_more_options
2108   // is set to true if argv[i] is "--".
2109   int
2110   process_one_option(int argc, const char** argv, int i,
2111                      bool* no_more_options);
2112
2113   // Get the general options.
2114   const General_options&
2115   options() const
2116   { return this->options_; }
2117
2118   // Get the position dependent options.
2119   const Position_dependent_options&
2120   position_dependent_options() const
2121   { return this->position_options_; }
2122
2123   // Get the linker-script options.
2124   Script_options&
2125   script_options()
2126   { return this->script_options_; }
2127
2128   // Finalize the version-script options and return them.
2129   const Version_script_info&
2130   version_script();
2131
2132   // Get the input files.
2133   Input_arguments&
2134   inputs()
2135   { return this->inputs_; }
2136
2137   // The number of input files.
2138   int
2139   number_of_input_files() const
2140   { return this->inputs_.number_of_input_files(); }
2141
2142   // Iterators to iterate over the list of input files.
2143
2144   const_iterator
2145   begin() const
2146   { return this->inputs_.begin(); }
2147
2148   const_iterator
2149   end() const
2150   { return this->inputs_.end(); }
2151
2152  private:
2153   Command_line(const Command_line&);
2154   Command_line& operator=(const Command_line&);
2155
2156   // This is a dummy class to provide a constructor that runs before
2157   // the constructor for the General_options.  The Pre_options constructor
2158   // is used as a hook to set the flag enabling the options to register
2159   // themselves.
2160   struct Pre_options {
2161     Pre_options();
2162   };
2163
2164   // This must come before options_!
2165   Pre_options pre_options_;
2166   General_options options_;
2167   Position_dependent_options position_options_;
2168   Script_options script_options_;
2169   Input_arguments inputs_;
2170 };
2171
2172 } // End namespace gold.
2173
2174 #endif // !defined(GOLD_OPTIONS_H)