OSDN Git Service

* mapfile.cc: New file.
[pf3gnuchains/pf3gnuchains3x.git] / gold / options.h
1 // options.h -- handle command line options for gold  -*- C++ -*-
2
3 // Copyright 2006, 2007, 2008 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 <string>
43 #include <vector>
44
45 #include "elfcpp.h"
46 #include "script.h"
47
48 namespace gold
49 {
50
51 class Command_line;
52 class General_options;
53 class Search_directory;
54 class Input_file_group;
55 class Position_dependent_options;
56 class Target;
57
58 // The nested namespace is to contain all the global variables and
59 // structs that need to be defined in the .h file, but do not need to
60 // be used outside this class.
61 namespace options
62 {
63 typedef std::vector<Search_directory> Dir_list;
64 typedef Unordered_set<std::string> String_set;
65
66 // These routines convert from a string option to various types.
67 // Each gives a fatal error if it cannot parse the argument.
68
69 extern void
70 parse_bool(const char* option_name, const char* arg, bool* retval);
71
72 extern void
73 parse_uint(const char* option_name, const char* arg, int* retval);
74
75 extern void
76 parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
77
78 extern void
79 parse_double(const char* option_name, const char* arg, double* retval);
80
81 extern void
82 parse_string(const char* option_name, const char* arg, const char** retval);
83
84 extern void
85 parse_optional_string(const char* option_name, const char* arg,
86                       const char** retval);
87
88 extern void
89 parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
90
91 extern void
92 parse_set(const char* option_name, const char* arg, String_set* retval);
93
94 extern void
95 parse_choices(const char* option_name, const char* arg, const char** retval,
96               const char* choices[], int num_choices);
97
98 struct Struct_var;
99
100 // Most options have both a shortname (one letter) and a longname.
101 // This enum controls how many dashes are expected for longname access
102 // -- shortnames always use one dash.  Most longnames will accept
103 // either one dash or two; the only difference between ONE_DASH and
104 // TWO_DASHES is how we print the option in --help.  However, some
105 // longnames require two dashes, and some require only one.  The
106 // special value DASH_Z means that the option is preceded by "-z".
107 enum Dashes
108 {
109   ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z
110 };
111
112 // LONGNAME is the long-name of the option with dashes converted to
113 //    underscores, or else the short-name if the option has no long-name.
114 //    It is never the empty string.
115 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
116 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
117 //    option has no short-name.  If the option has no long-name, you
118 //    should specify the short-name in *both* VARNAME and here.
119 // DEFAULT_VALUE is the value of the option if not specified on the
120 //    commandline, as a string.
121 // HELPSTRING is the descriptive text used with the option via --help
122 // HELPARG is how you define the argument to the option.
123 //    --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
124 //    HELPARG should be NULL iff the option is a bool and takes no arg.
125 // OPTIONAL_ARG is true if this option takes an optional argument.  An
126 //    optional argument must be specifid as --OPTION=VALUE, not
127 //    --OPTION VALUE.
128 // READER provides parse_to_value, which is a function that will convert
129 //    a char* argument into the proper type and store it in some variable.
130 // A One_option struct initializes itself with the global list of options
131 // at constructor time, so be careful making one of these.
132 struct One_option
133 {
134   std::string longname;
135   Dashes dashes;
136   char shortname;
137   const char* default_value;
138   const char* helpstring;
139   const char* helparg;
140   bool optional_arg;
141   Struct_var* reader;
142
143   One_option(const char* ln, Dashes d, char sn, const char* dv,
144              const char* hs, const char* ha, bool oa, Struct_var* r)
145     : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
146       helpstring(hs), helparg(ha), optional_arg(oa), reader(r)
147   {
148     // In longname, we convert all underscores to dashes, since GNU
149     // style uses dashes in option names.  longname is likely to have
150     // underscores in it because it's also used to declare a C++
151     // function.
152     const char* pos = strchr(this->longname.c_str(), '_');
153     for (; pos; pos = strchr(pos, '_'))
154       this->longname[pos - this->longname.c_str()] = '-';
155
156     // We only register ourselves if our helpstring is not NULL.  This
157     // is to support the "no-VAR" boolean variables, which we
158     // conditionally turn on by defining "no-VAR" help text.
159     if (this->helpstring)
160       this->register_option();
161   }
162
163   // This option takes an argument iff helparg is not NULL.
164   bool
165   takes_argument() const
166   { return this->helparg != NULL; }
167
168   // Whether the argument is optional.
169   bool
170   takes_optional_argument() const
171   { return this->optional_arg; }
172
173   // Register this option with the global list of options.
174   void
175   register_option();
176
177   // Print this option to stdout (used with --help).
178   void
179   print() const;
180 };
181
182 // All options have a Struct_##varname that inherits from this and
183 // actually implements parse_to_value for that option.
184 struct Struct_var
185 {
186   // OPTION: the name of the option as specified on the commandline,
187   //    including leading dashes, and any text following the option:
188   //    "-O", "--defsym=mysym=0x1000", etc.
189   // ARG: the arg associated with this option, or NULL if the option
190   //    takes no argument: "2", "mysym=0x1000", etc.
191   // CMDLINE: the global Command_line object.  Used by DEFINE_special.
192   // OPTIONS: the global General_options object.  Used by DEFINE_special.
193   virtual void
194   parse_to_value(const char* option, const char* arg,
195                  Command_line* cmdline, General_options* options) = 0;
196   virtual
197   ~Struct_var()  // To make gcc happy.
198   { }
199 };
200
201 // This is for "special" options that aren't of any predefined type.
202 struct Struct_special : public Struct_var
203 {
204   // If you change this, change the parse-fn in DEFINE_special as well.
205   typedef void (General_options::*Parse_function)(const char*, const char*,
206                                                   Command_line*);
207   Struct_special(const char* varname, Dashes dashes, char shortname,
208                  Parse_function parse_function,
209                  const char* helpstring, const char* helparg)
210     : option(varname, dashes, shortname, "", helpstring, helparg, false, this),
211       parse(parse_function)
212   { }
213
214   void parse_to_value(const char* option, const char* arg,
215                       Command_line* cmdline, General_options* options)
216   { (options->*(this->parse))(option, arg, cmdline); }
217
218   One_option option;
219   Parse_function parse;
220 };
221
222 }  // End namespace options.
223
224
225 // These are helper macros use by DEFINE_uint64/etc below.
226 // This macro is used inside the General_options_ class, so defines
227 // var() and set_var() as General_options methods.  Arguments as are
228 // for the constructor for One_option.  param_type__ is the same as
229 // type__ for built-in types, and "const type__ &" otherwise.
230 #define DEFINE_var(varname__, dashes__, shortname__, default_value__,        \
231                    default_value_as_string__, helpstring__, helparg__,       \
232                    optional_arg__, type__, param_type__, parse_fn__)         \
233  public:                                                                     \
234   param_type__                                                               \
235   varname__() const                                                          \
236   { return this->varname__##_.value; }                                       \
237                                                                              \
238   bool                                                                       \
239   user_set_##varname__() const                                               \
240   { return this->varname__##_.user_set_via_option; }                         \
241                                                                              \
242   void                                                                       \
243   set_user_set_##varname__()                                                 \
244   { this->varname__##_.user_set_via_option = true; }                         \
245                                                                              \
246  private:                                                                    \
247   struct Struct_##varname__ : public options::Struct_var                     \
248   {                                                                          \
249     Struct_##varname__()                                                     \
250       : option(#varname__, dashes__, shortname__, default_value_as_string__, \
251                helpstring__, helparg__, optional_arg__, this),               \
252         user_set_via_option(false), value(default_value__)                   \
253     { }                                                                      \
254                                                                              \
255     void                                                                     \
256     parse_to_value(const char* option_name, const char* arg,                 \
257                    Command_line*, General_options*)                          \
258     {                                                                        \
259       parse_fn__(option_name, arg, &this->value);                            \
260       this->user_set_via_option = true;                                      \
261     }                                                                        \
262                                                                              \
263     options::One_option option;                                              \
264     bool user_set_via_option;                                                \
265     type__ value;                                                            \
266   };                                                                         \
267   Struct_##varname__ varname__##_;                                           \
268   void                                                                       \
269   set_##varname__(param_type__ value)                                        \
270   { this->varname__##_.value = value; }
271
272 // These macros allow for easy addition of a new commandline option.
273
274 // If no_helpstring__ is not NULL, then in addition to creating
275 // VARNAME, we also create an option called no-VARNAME (or, for a -z
276 // option, noVARNAME).
277 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__,   \
278                     helpstring__, no_helpstring__)                       \
279   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
280              default_value__ ? "true" : "false", helpstring__, NULL,     \
281              false, bool, bool, options::parse_bool)                     \
282   struct Struct_no_##varname__ : public options::Struct_var              \
283   {                                                                      \
284     Struct_no_##varname__() : option((dashes__ == options::DASH_Z        \
285                                       ? "no" #varname__                  \
286                                       : "no-" #varname__),               \
287                                      dashes__, '\0',                     \
288                                      default_value__ ? "false" : "true", \
289                                      no_helpstring__, NULL, false, this) \
290     { }                                                                  \
291                                                                          \
292     void                                                                 \
293     parse_to_value(const char*, const char*,                             \
294                    Command_line*, General_options* options)              \
295     { options->set_##varname__(false); }                                 \
296                                                                          \
297     options::One_option option;                                          \
298   };                                                                     \
299   Struct_no_##varname__ no_##varname__##_initializer_
300
301 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
302                       helpstring__, no_helpstring__)                     \
303   DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
304              default_value__ ? "true" : "false", helpstring__, NULL,     \
305              false, bool, bool, options::parse_bool)                     \
306   struct Struct_disable_##varname__ : public options::Struct_var         \
307   {                                                                      \
308     Struct_disable_##varname__() : option("disable-" #varname__,         \
309                                      dashes__, '\0',                     \
310                                      default_value__ ? "false" : "true", \
311                                      no_helpstring__, NULL, false, this) \
312     { }                                                                  \
313                                                                          \
314     void                                                                 \
315     parse_to_value(const char*, const char*,                             \
316                    Command_line*, General_options* options)              \
317     { options->set_enable_##varname__(false); }                          \
318                                                                          \
319     options::One_option option;                                          \
320   };                                                                     \
321   Struct_disable_##varname__ disable_##varname__##_initializer_
322
323 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__,  \
324                    helpstring__, helparg__)                             \
325   DEFINE_var(varname__, dashes__, shortname__, default_value__,         \
326              #default_value__, helpstring__, helparg__, false,          \
327              int, int, options::parse_uint)
328
329 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
330                       helpstring__, helparg__)                           \
331   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
332              #default_value__, helpstring__, helparg__, false,           \
333              uint64_t, uint64_t, options::parse_uint64)
334
335 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
336                       helpstring__, helparg__)                           \
337   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
338              #default_value__, helpstring__, helparg__, false,           \
339              double, double, options::parse_double)
340
341 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
342                       helpstring__, helparg__)                           \
343   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
344              default_value__, helpstring__, helparg__, false,            \
345              const char*, const char*, options::parse_string)
346
347 // This is like DEFINE_string, but we convert each occurrence to a
348 // Search_directory and store it in a vector.  Thus we also have the
349 // add_to_VARNAME() method, to append to the vector.
350 #define DEFINE_dirlist(varname__, dashes__, shortname__,                  \
351                            helpstring__, helparg__)                       \
352   DEFINE_var(varname__, dashes__, shortname__, ,                          \
353              "", helpstring__, helparg__, false, options::Dir_list,       \
354              const options::Dir_list&, options::parse_dirlist)            \
355   void                                                                    \
356   add_to_##varname__(const char* new_value)                               \
357   { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
358   void                                                                    \
359   add_search_directory_to_##varname__(const Search_directory& dir)        \
360   { this->varname__##_.value.push_back(dir); }
361
362 // This is like DEFINE_string, but we store a set of strings.
363 #define DEFINE_set(varname__, dashes__, shortname__,                      \
364                    helpstring__, helparg__)                               \
365   DEFINE_var(varname__, dashes__, shortname__, ,                          \
366              "", helpstring__, helparg__, false, options::String_set,     \
367              const options::String_set&, options::parse_set)              \
368  public:                                                                  \
369   bool                                                                    \
370   any_##varname__() const                                                 \
371   { return !this->varname__##_.value.empty(); }                           \
372                                                                           \
373   bool                                                                    \
374   is_##varname__(const char* symbol) const                                \
375   {                                                                       \
376     return (!this->varname__##_.value.empty()                             \
377             && (this->varname__##_.value.find(std::string(symbol))        \
378                 != this->varname__##_.value.end()));                      \
379   }                                                                       \
380                                                                           \
381   options::String_set::const_iterator                                     \
382   varname__##_begin() const                                               \
383   { return this->varname__##_.value.begin(); }                            \
384                                                                           \
385   options::String_set::const_iterator                                     \
386   varname__##_end() const                                                 \
387   { return this->varname__##_.value.end(); }
388
389 // When you have a list of possible values (expressed as string)
390 // After helparg__ should come an initializer list, like
391 //   {"foo", "bar", "baz"}
392 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__,   \
393                     helpstring__, helparg__, ...)                        \
394   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
395              default_value__, helpstring__, helparg__, false,            \
396              const char*, const char*, parse_choices_##varname__)        \
397  private:                                                                \
398   static void parse_choices_##varname__(const char* option_name,         \
399                                         const char* arg,                 \
400                                         const char** retval) {           \
401     const char* choices[] = __VA_ARGS__;                                 \
402     options::parse_choices(option_name, arg, retval,                     \
403                            choices, sizeof(choices) / sizeof(*choices)); \
404   }
405
406 // This is like DEFINE_bool, but VARNAME is the name of a different
407 // option.  This option becomes an alias for that one.  INVERT is true
408 // if this option is an inversion of the other one.
409 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__,   \
410                           helpstring__, no_helpstring__, invert__)      \
411  private:                                                               \
412   struct Struct_##option__ : public options::Struct_var                 \
413   {                                                                     \
414     Struct_##option__()                                                 \
415       : option(#option__, dashes__, shortname__, "", helpstring__,      \
416                NULL, false, this)                                       \
417     { }                                                                 \
418                                                                         \
419     void                                                                \
420     parse_to_value(const char*, const char*,                            \
421                    Command_line*, General_options* options)             \
422     {                                                                   \
423       options->set_##varname__(!invert__);                              \
424       options->set_user_set_##varname__();                              \
425     }                                                                   \
426                                                                         \
427     options::One_option option;                                         \
428   };                                                                    \
429   Struct_##option__ option__##_;                                        \
430                                                                         \
431   struct Struct_no_##option__ : public options::Struct_var              \
432   {                                                                     \
433     Struct_no_##option__()                                              \
434       : option((dashes__ == options::DASH_Z                             \
435                 ? "no" #option__                                        \
436                 : "no-" #option__),                                     \
437                dashes__, '\0', "", no_helpstring__,                     \
438                NULL, false, this)                                       \
439     { }                                                                 \
440                                                                         \
441     void                                                                \
442     parse_to_value(const char*, const char*,                            \
443                    Command_line*, General_options* options)             \
444     {                                                                   \
445       options->set_##varname__(invert__);                               \
446       options->set_user_set_##varname__();                              \
447     }                                                                   \
448                                                                         \
449     options::One_option option;                                         \
450   };                                                                    \
451   Struct_no_##option__ no_##option__##_initializer_
452
453 // This is used for non-standard flags.  It defines no functions; it
454 // just calls General_options::parse_VARNAME whenever the flag is
455 // seen.  We declare parse_VARNAME as a static member of
456 // General_options; you are responsible for defining it there.
457 // helparg__ should be NULL iff this special-option is a boolean.
458 #define DEFINE_special(varname__, dashes__, shortname__,                \
459                        helpstring__, helparg__)                         \
460  private:                                                               \
461   void parse_##varname__(const char* option, const char* arg,           \
462                          Command_line* inputs);                         \
463   struct Struct_##varname__ : public options::Struct_special            \
464   {                                                                     \
465     Struct_##varname__()                                                \
466       : options::Struct_special(#varname__, dashes__, shortname__,      \
467                                 &General_options::parse_##varname__,    \
468                                 helpstring__, helparg__)                \
469     { }                                                                 \
470   };                                                                    \
471   Struct_##varname__ varname__##_initializer_
472
473 // An option that takes an optional string argument.  If the option is
474 // used with no argument, the value will be the default, and
475 // user_set_via_option will be true.
476 #define DEFINE_optional_string(varname__, dashes__, shortname__,        \
477                                default_value__,                         \
478                                helpstring__, helparg__)                 \
479   DEFINE_var(varname__, dashes__, shortname__, default_value__,         \
480              default_value__, helpstring__, helparg__, true,            \
481              const char*, const char*, options::parse_optional_string)
482
483 // A directory to search.  For each directory we record whether it is
484 // in the sysroot.  We need to know this so that, if a linker script
485 // is found within the sysroot, we will apply the sysroot to any files
486 // named by that script.
487
488 class Search_directory
489 {
490  public:
491   // We need a default constructor because we put this in a
492   // std::vector.
493   Search_directory()
494     : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
495   { }
496
497   // This is the usual constructor.
498   Search_directory(const char* name, bool put_in_sysroot)
499     : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
500   {
501     if (this->name_.empty())
502       this->name_ = ".";
503   }
504
505   // This is called if we have a sysroot.  The sysroot is prefixed to
506   // any entries for which put_in_sysroot_ is true.  is_in_sysroot_ is
507   // set to true for any enries which are in the sysroot (this will
508   // naturally include any entries for which put_in_sysroot_ is true).
509   // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
510   // passing SYSROOT to lrealpath.
511   void
512   add_sysroot(const char* sysroot, const char* canonical_sysroot);
513
514   // Get the directory name.
515   const std::string&
516   name() const
517   { return this->name_; }
518
519   // Return whether this directory is in the sysroot.
520   bool
521   is_in_sysroot() const
522   { return this->is_in_sysroot_; }
523
524  private:
525   std::string name_;
526   bool put_in_sysroot_;
527   bool is_in_sysroot_;
528 };
529
530 class General_options
531 {
532  private:
533   // NOTE: For every option that you add here, also consider if you
534   // should add it to Position_dependent_options.
535   DEFINE_special(help, options::TWO_DASHES, '\0',
536                  N_("Report usage information"), NULL);
537   DEFINE_special(version, options::TWO_DASHES, 'v',
538                  N_("Report version information"), NULL);
539   DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
540                  N_("Report version and target information"), NULL);
541
542   // These options are sorted approximately so that for each letter in
543   // the alphabet, we show the option whose shortname is that letter
544   // (if any) and then every longname that starts with that letter (in
545   // alphabetical order).  For both, lowercase sorts before uppercase.
546   // The -z options come last.
547
548   DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
549               N_("Allow unresolved references in shared libraries"),
550               N_("Do not allow unresolved references in shared libraries"));
551
552   DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
553               N_("Only set DT_NEEDED for dynamic libs if used"),
554               N_("Always DT_NEEDED for dynamic libs"));
555
556   // This should really be an "enum", but it's too easy for folks to
557   // forget to update the list as they add new targets.  So we just
558   // accept any string.  We'll fail later (when the string is parsed),
559   // if the target isn't actually supported.
560   DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
561                 N_("Set input format"), ("[elf,binary]"));
562
563   DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
564               N_("-l searches for shared libraries"), NULL);
565   DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
566                     N_("-l does not search for shared libraries"), NULL,
567                     true);
568
569   DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
570               N_("Bind defined symbols locally"), NULL);
571
572   DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
573               N_("Bind defined function symbols locally"), NULL);
574
575   DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
576                          N_("Generate build ID note"),
577                          N_("[=STYLE]"));
578
579 #ifdef HAVE_ZLIB_H
580   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
581               N_("Compress .debug_* sections in the output file"),
582               ("[none,zlib]"),
583               {"none", "zlib"});
584 #else
585   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
586               N_("Compress .debug_* sections in the output file"),
587               N_("[none]"),
588               {"none"});
589 #endif
590
591   DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
592               N_("Define common symbols"),
593               N_("Do not define common symbols"));
594   DEFINE_bool(dc, options::ONE_DASH, '\0', false,
595               N_("Alias for -d"), NULL);
596   DEFINE_bool(dp, options::ONE_DASH, '\0', false,
597               N_("Alias for -d"), NULL);
598
599   DEFINE_string(debug, options::TWO_DASHES, '\0', "",
600                 N_("Turn on debugging"),
601                 N_("[all,files,script,task][,...]"));
602
603   DEFINE_special(defsym, options::TWO_DASHES, '\0',
604                  N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
605
606   DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
607                          N_("Demangle C++ symbols in log messages"),
608                          N_("[=STYLE]"));
609
610   DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
611               N_("Do not demangle C++ symbols in log messages"),
612               NULL);
613
614   DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
615               N_("Try to detect violations of the One Definition Rule"),
616               NULL);
617
618   DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
619                 N_("Set program start address"), N_("ADDRESS"));
620
621   DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
622               N_("Export all dynamic symbols"), NULL);
623
624   DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
625               N_("Create exception frame header"), NULL);
626
627   DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
628               N_("Treat warnings as errors"),
629               N_("Do not treat warnings as errors"));
630
631   DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
632                 N_("Set shared library name"), N_("FILENAME"));
633
634   DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
635                 N_("Min fraction of empty buckets in dynamic hash"),
636                 N_("FRACTION"));
637
638   DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
639               N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
640               {"sysv", "gnu", "both"});
641
642   DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
643                 N_("Set dynamic linker path"), N_("PROGRAM"));
644
645   DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
646                  N_("Read only symbol values from FILE"), N_("FILE"));
647
648   DEFINE_special(library, options::TWO_DASHES, 'l',
649                  N_("Search for library LIBNAME"), N_("LIBNAME"));
650
651   DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
652                  N_("Add directory to search path"), N_("DIR"));
653
654   DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
655                 N_("Ignored for compatibility"), N_("EMULATION"));
656
657   DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
658               N_("Write map file on standard output"), NULL);
659   DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
660                 N_("MAPFILENAME"));
661
662   DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
663                 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
664                 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
665
666   DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
667               N_("Create an output file even if errors occur"), NULL);
668
669   DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
670                     N_("Report undefined symbols (even with --shared)"),
671                     NULL, false);
672
673   DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
674                 N_("Set output file name"), N_("FILE"));
675
676   DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
677               N_("Optimize output file size"), N_("LEVEL"));
678
679   DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
680                 N_("Set output format"), N_("[binary]"));
681
682   DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
683               N_("Ignored for SVR4 compatibility"), NULL);
684
685   DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
686               N_("Generate relocations in output"), NULL);
687
688   DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
689               N_("Generate relocatable output"), NULL);
690
691   DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
692               N_("Relax branches on certain targets"), NULL);
693
694   // -R really means -rpath, but can mean --just-symbols for
695   // compatibility with GNU ld.  -rpath is always -rpath, so we list
696   // it separately.
697   DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
698                  N_("Add DIR to runtime search path"), N_("DIR"));
699
700   DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
701                  N_("Add DIR to runtime search path"), N_("DIR"));
702
703   DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
704                  N_("Add DIR to link time shared library search path"),
705                  N_("DIR"));
706
707   DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
708               N_("Strip all symbols"), NULL);
709   DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
710               N_("Strip debugging information"), NULL);
711   DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
712               N_("Strip debug symbols that are unused by gdb "
713                  "(at least versions <= 6.7)"), NULL);
714
715   DEFINE_bool(shared, options::ONE_DASH, '\0', false,
716               N_("Generate shared library"), NULL);
717
718   // This is not actually special in any way, but I need to give it
719   // a non-standard accessor-function name because 'static' is a keyword.
720   DEFINE_special(static, options::ONE_DASH, '\0',
721                  N_("Do not link against shared libraries"), NULL);
722
723   DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
724               N_("Print resource usage statistics"), NULL);
725
726   DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
727                 N_("Set target system root directory"), N_("DIR"));
728
729   DEFINE_bool(trace, options::TWO_DASHES, 't', false,
730               N_("Print the name of each input file"), NULL);
731
732   DEFINE_special(script, options::TWO_DASHES, 'T',
733                  N_("Read linker script"), N_("FILE"));
734
735   DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
736               N_("Run the linker multi-threaded"),
737               N_("Do not run the linker multi-threaded"));
738   DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
739               N_("Number of threads to use"), N_("COUNT"));
740   DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
741               N_("Number of threads to use in initial pass"), N_("COUNT"));
742   DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
743               N_("Number of threads to use in middle pass"), N_("COUNT"));
744   DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
745               N_("Number of threads to use in final pass"), N_("COUNT"));
746
747   DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
748                 N_("Set the address of the bss segment"), N_("ADDRESS"));
749   DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
750                 N_("Set the address of the data segment"), N_("ADDRESS"));
751   DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
752                 N_("Set the address of the text segment"), N_("ADDRESS"));
753
754   DEFINE_set(undefined, options::TWO_DASHES, 'u',
755              N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
756
757   DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
758               N_("Synonym for --debug=files"), NULL);
759
760   DEFINE_special(version_script, options::TWO_DASHES, '\0',
761                  N_("Read version script"), N_("FILE"));
762
763   DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
764               N_("Include all archive contents"),
765               N_("Include only needed archive contents"));
766
767   DEFINE_set(wrap, options::TWO_DASHES, '\0',
768              N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
769
770   DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
771              N_("Trace references to symbol"), N_("SYMBOL"));
772
773   DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
774                 N_("Default search path for Solaris compatibility"),
775                 N_("PATH"));
776
777   DEFINE_special(start_group, options::TWO_DASHES, '(',
778                  N_("Start a library search group"), NULL);
779   DEFINE_special(end_group, options::TWO_DASHES, ')',
780                  N_("End a library search group"), NULL);
781
782   // The -z options.
783
784   DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
785               N_("Sort dynamic relocs"),
786               N_("Do not sort dynamic relocs"));
787   DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
788                 N_("Set common page size to SIZE"), N_("SIZE"));
789   DEFINE_bool(defs, options::DASH_Z, '\0', false,
790               N_("Report undefined symbols (even with --shared)"),
791               NULL);
792   DEFINE_bool(execstack, options::DASH_Z, '\0', false,
793               N_("Mark output as requiring executable stack"), NULL);
794   DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
795                 N_("Set maximum page size to SIZE"), N_("SIZE"));
796   DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
797               N_("Mark output as not requiring executable stack"), NULL);
798   DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
799               N_("Mark DSO to be initialized first at runtime"),
800               NULL);
801   DEFINE_bool(interpose, options::DASH_Z, '\0', false,
802               N_("Mark object to interpose all DSOs but executable"),
803               NULL);
804   DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
805               N_("Mark object requiring immediate process"),
806               NULL);
807   DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
808               N_("Mark object not to use default search paths"),
809               NULL);
810   DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
811               N_("Mark DSO non-deletable at runtime"),
812               NULL);
813   DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
814               N_("Mark DSO not available to dlopen"),
815               NULL);
816   DEFINE_bool(nodump, options::DASH_Z, '\0', false,
817               N_("Mark DSO not available to dldump"),
818               NULL);
819   DEFINE_bool(relro, options::DASH_Z, '\0', false,
820               N_("Where possible mark variables read-only after relocation"),
821               N_("Don't mark variables read-only after relocation"));
822
823  public:
824   typedef options::Dir_list Dir_list;
825
826   General_options();
827
828   // Does post-processing on flags, making sure they all have
829   // non-conflicting values.  Also converts some flags from their
830   // "standard" types (string, etc), to another type (enum, DirList),
831   // which can be accessed via a separate method.  Dies if it notices
832   // any problems.
833   void finalize();
834
835   // The macro defines output() (based on --output), but that's a
836   // generic name.  Provide this alternative name, which is clearer.
837   const char*
838   output_file_name() const
839   { return this->output(); }
840
841   // This is not defined via a flag, but combines flags to say whether
842   // the output is position-independent or not.
843   bool
844   output_is_position_independent() const
845   { return this->shared(); }
846
847   // This would normally be static(), and defined automatically, but
848   // since static is a keyword, we need to come up with our own name.
849   bool
850   is_static() const
851   { return static_; }
852
853   // In addition to getting the input and output formats as a string
854   // (via format() and oformat()), we also give access as an enum.
855   enum Object_format
856   {
857     // Ordinary ELF.
858     OBJECT_FORMAT_ELF,
859     // Straight binary format.
860     OBJECT_FORMAT_BINARY
861   };
862
863   // Note: these functions are not very fast.
864   Object_format format_enum() const;
865   Object_format oformat_enum() const;
866
867   // These are the best way to get access to the execstack state,
868   // not execstack() and noexecstack() which are hard to use properly.
869   bool
870   is_execstack_set() const
871   { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
872
873   bool
874   is_stack_executable() const
875   { return this->execstack_status_ == EXECSTACK_YES; }
876
877   // The --demangle option takes an optional string, and there is also
878   // a --no-demangle option.  This is the best way to decide whether
879   // to demangle or not.
880   bool
881   do_demangle() const
882   { return this->do_demangle_; }
883
884  private:
885   // Don't copy this structure.
886   General_options(const General_options&);
887   General_options& operator=(const General_options&);
888
889   // Whether to mark the stack as executable.
890   enum Execstack
891   {
892     // Not set on command line.
893     EXECSTACK_FROM_INPUT,
894     // Mark the stack as executable (-z execstack).
895     EXECSTACK_YES,
896     // Mark the stack as not executable (-z noexecstack).
897     EXECSTACK_NO
898   };
899
900   void
901   set_execstack_status(Execstack value)
902   { this->execstack_status_ = value; }
903
904   void
905   set_do_demangle(bool value)
906   { this->do_demangle_ = value; }
907
908   void
909   set_static(bool value)
910   { static_ = value; }
911
912   // These are called by finalize() to set up the search-path correctly.
913   void
914   add_to_library_path_with_sysroot(const char* arg)
915   { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
916
917   // Apply any sysroot to the directory lists.
918   void
919   add_sysroot();
920
921   // Whether to mark the stack as executable.
922   Execstack execstack_status_;
923   // Whether to do a static link.
924   bool static_;
925   // Whether to do demangling.
926   bool do_demangle_;
927 };
928
929 // The position-dependent options.  We use this to store the state of
930 // the commandline at a particular point in parsing for later
931 // reference.  For instance, if we see "ld --whole-archive foo.a
932 // --no-whole-archive," we want to store the whole-archive option with
933 // foo.a, so when the time comes to parse foo.a we know we should do
934 // it in whole-archive mode.  We could store all of General_options,
935 // but that's big, so we just pick the subset of flags that actually
936 // change in a position-dependent way.
937
938 #define DEFINE_posdep(varname__, type__)        \
939  public:                                        \
940   type__                                        \
941   varname__() const                             \
942   { return this->varname__##_; }                \
943                                                 \
944   void                                          \
945   set_##varname__(type__ value)                 \
946   { this->varname__##_ = value; }               \
947  private:                                       \
948   type__ varname__##_
949
950 class Position_dependent_options
951 {
952  public:
953   Position_dependent_options(const General_options& options
954                              = Position_dependent_options::default_options_)
955   { copy_from_options(options); }
956
957   void copy_from_options(const General_options& options)
958   {
959     this->set_as_needed(options.as_needed());
960     this->set_Bdynamic(options.Bdynamic());
961     this->set_format_enum(options.format_enum());
962     this->set_whole_archive(options.whole_archive());
963   }
964
965   DEFINE_posdep(as_needed, bool);
966   DEFINE_posdep(Bdynamic, bool);
967   DEFINE_posdep(format_enum, General_options::Object_format);
968   DEFINE_posdep(whole_archive, bool);
969
970  private:
971   // This is a General_options with everything set to its default
972   // value.  A Position_dependent_options created with no argument
973   // will take its values from here.
974   static General_options default_options_;
975 };
976
977
978 // A single file or library argument from the command line.
979
980 class Input_file_argument
981 {
982  public:
983   // name: file name or library name
984   // is_lib: true if name is a library name: that is, emits the leading
985   //         "lib" and trailing ".so"/".a" from the name
986   // extra_search_path: an extra directory to look for the file, prior
987   //         to checking the normal library search path.  If this is "",
988   //         then no extra directory is added.
989   // just_symbols: whether this file only defines symbols.
990   // options: The position dependent options at this point in the
991   //         command line, such as --whole-archive.
992   Input_file_argument()
993     : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false),
994       options_()
995   { }
996
997   Input_file_argument(const char* name, bool is_lib,
998                       const char* extra_search_path,
999                       bool just_symbols,
1000                       const Position_dependent_options& options)
1001     : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
1002       just_symbols_(just_symbols), options_(options)
1003   { }
1004
1005   // You can also pass in a General_options instance instead of a
1006   // Position_dependent_options.  In that case, we extract the
1007   // position-independent vars from the General_options and only store
1008   // those.
1009   Input_file_argument(const char* name, bool is_lib,
1010                       const char* extra_search_path,
1011                       bool just_symbols,
1012                       const General_options& options)
1013     : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
1014       just_symbols_(just_symbols), options_(options)
1015   { }
1016
1017   const char*
1018   name() const
1019   { return this->name_.c_str(); }
1020
1021   const Position_dependent_options&
1022   options() const
1023   { return this->options_; }
1024
1025   bool
1026   is_lib() const
1027   { return this->is_lib_; }
1028
1029   const char*
1030   extra_search_path() const
1031   {
1032     return (this->extra_search_path_.empty()
1033             ? NULL
1034             : this->extra_search_path_.c_str());
1035   }
1036
1037   // Return whether we should only read symbols from this file.
1038   bool
1039   just_symbols() const
1040   { return this->just_symbols_; }
1041
1042   // Return whether this file may require a search using the -L
1043   // options.
1044   bool
1045   may_need_search() const
1046   { return this->is_lib_ || !this->extra_search_path_.empty(); }
1047
1048  private:
1049   // We use std::string, not const char*, here for convenience when
1050   // using script files, so that we do not have to preserve the string
1051   // in that case.
1052   std::string name_;
1053   bool is_lib_;
1054   std::string extra_search_path_;
1055   bool just_symbols_;
1056   Position_dependent_options options_;
1057 };
1058
1059 // A file or library, or a group, from the command line.
1060
1061 class Input_argument
1062 {
1063  public:
1064   // Create a file or library argument.
1065   explicit Input_argument(Input_file_argument file)
1066     : is_file_(true), file_(file), group_(NULL)
1067   { }
1068
1069   // Create a group argument.
1070   explicit Input_argument(Input_file_group* group)
1071     : is_file_(false), group_(group)
1072   { }
1073
1074   // Return whether this is a file.
1075   bool
1076   is_file() const
1077   { return this->is_file_; }
1078
1079   // Return whether this is a group.
1080   bool
1081   is_group() const
1082   { return !this->is_file_; }
1083
1084   // Return the information about the file.
1085   const Input_file_argument&
1086   file() const
1087   {
1088     gold_assert(this->is_file_);
1089     return this->file_;
1090   }
1091
1092   // Return the information about the group.
1093   const Input_file_group*
1094   group() const
1095   {
1096     gold_assert(!this->is_file_);
1097     return this->group_;
1098   }
1099
1100   Input_file_group*
1101   group()
1102   {
1103     gold_assert(!this->is_file_);
1104     return this->group_;
1105   }
1106
1107  private:
1108   bool is_file_;
1109   Input_file_argument file_;
1110   Input_file_group* group_;
1111 };
1112
1113 // A group from the command line.  This is a set of arguments within
1114 // --start-group ... --end-group.
1115
1116 class Input_file_group
1117 {
1118  public:
1119   typedef std::vector<Input_argument> Files;
1120   typedef Files::const_iterator const_iterator;
1121
1122   Input_file_group()
1123     : files_()
1124   { }
1125
1126   // Add a file to the end of the group.
1127   void
1128   add_file(const Input_file_argument& arg)
1129   { this->files_.push_back(Input_argument(arg)); }
1130
1131   // Iterators to iterate over the group contents.
1132
1133   const_iterator
1134   begin() const
1135   { return this->files_.begin(); }
1136
1137   const_iterator
1138   end() const
1139   { return this->files_.end(); }
1140
1141  private:
1142   Files files_;
1143 };
1144
1145 // A list of files from the command line or a script.
1146
1147 class Input_arguments
1148 {
1149  public:
1150   typedef std::vector<Input_argument> Input_argument_list;
1151   typedef Input_argument_list::const_iterator const_iterator;
1152
1153   Input_arguments()
1154     : input_argument_list_(), in_group_(false)
1155   { }
1156
1157   // Add a file.
1158   void
1159   add_file(const Input_file_argument& arg);
1160
1161   // Start a group (the --start-group option).
1162   void
1163   start_group();
1164
1165   // End a group (the --end-group option).
1166   void
1167   end_group();
1168
1169   // Return whether we are currently in a group.
1170   bool
1171   in_group() const
1172   { return this->in_group_; }
1173
1174   // The number of entries in the list.
1175   int
1176   size() const
1177   { return this->input_argument_list_.size(); }
1178
1179   // Iterators to iterate over the list of input files.
1180
1181   const_iterator
1182   begin() const
1183   { return this->input_argument_list_.begin(); }
1184
1185   const_iterator
1186   end() const
1187   { return this->input_argument_list_.end(); }
1188
1189   // Return whether the list is empty.
1190   bool
1191   empty() const
1192   { return this->input_argument_list_.empty(); }
1193
1194  private:
1195   Input_argument_list input_argument_list_;
1196   bool in_group_;
1197 };
1198
1199
1200 // All the information read from the command line.  These are held in
1201 // three separate structs: one to hold the options (--foo), one to
1202 // hold the filenames listed on the commandline, and one to hold
1203 // linker script information.  This third is not a subset of the other
1204 // two because linker scripts can be specified either as options (via
1205 // -T) or as a file.
1206
1207 class Command_line
1208 {
1209  public:
1210   typedef Input_arguments::const_iterator const_iterator;
1211
1212   Command_line();
1213
1214   // Process the command line options.  This will exit with an
1215   // appropriate error message if an unrecognized option is seen.
1216   void
1217   process(int argc, const char** argv);
1218
1219   // Process one command-line option.  This takes the index of argv to
1220   // process, and returns the index for the next option.  no_more_options
1221   // is set to true if argv[i] is "--".
1222   int
1223   process_one_option(int argc, const char** argv, int i,
1224                      bool* no_more_options);
1225
1226   // Get the general options.
1227   const General_options&
1228   options() const
1229   { return this->options_; }
1230
1231   // Get the position dependent options.
1232   const Position_dependent_options&
1233   position_dependent_options() const
1234   { return this->position_options_; }
1235
1236   // Get the linker-script options.
1237   Script_options&
1238   script_options()
1239   { return this->script_options_; }
1240
1241   // Get the version-script options: a convenience routine.
1242   const Version_script_info&
1243   version_script() const
1244   { return *this->script_options_.version_script_info(); }
1245
1246   // Get the input files.
1247   Input_arguments&
1248   inputs()
1249   { return this->inputs_; }
1250
1251   // The number of input files.
1252   int
1253   number_of_input_files() const
1254   { return this->inputs_.size(); }
1255
1256   // Iterators to iterate over the list of input files.
1257
1258   const_iterator
1259   begin() const
1260   { return this->inputs_.begin(); }
1261
1262   const_iterator
1263   end() const
1264   { return this->inputs_.end(); }
1265
1266  private:
1267   Command_line(const Command_line&);
1268   Command_line& operator=(const Command_line&);
1269
1270   General_options options_;
1271   Position_dependent_options position_options_;
1272   Script_options script_options_;
1273   Input_arguments inputs_;
1274 };
1275
1276 } // End namespace gold.
1277
1278 #endif // !defined(GOLD_OPTIONS_H)