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