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