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