* MAINTAINERS: Add myself and Cary as gold maintainers.
[deliverable/binutils-gdb.git] / gold / options.h
CommitLineData
bae7f79e
ILT
1// options.h -- handle command line options for gold -*- C++ -*-
2
5393d741 3// Copyright 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
6cb15b7f
ILT
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
bae7f79e 23// General_options (from Command_line::options())
ee1fe73e 24// All the options (a.k.a. command-line flags)
bae7f79e
ILT
25// Input_argument (from Command_line::inputs())
26// The list of input files, including -l options.
ee1fe73e
ILT
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).
bae7f79e
ILT
35
36#ifndef GOLD_OPTIONS_H
37#define GOLD_OPTIONS_H
38
ca3a67a5 39#include <cstdlib>
cbb93e63 40#include <cstring>
bae7f79e 41#include <list>
a192ba05 42#include <map>
61ba1cf9 43#include <string>
92e059d8 44#include <vector>
bae7f79e 45
0daa6f62 46#include "elfcpp.h"
3c2fafa5
ILT
47#include "script.h"
48
bae7f79e
ILT
49namespace gold
50{
51
52class Command_line;
ee1fe73e
ILT
53class General_options;
54class Search_directory;
ead1e424 55class Input_file_group;
b0193076 56class Input_file_lib;
3c2fafa5 57class Position_dependent_options;
0daa6f62 58class Target;
89fc3421 59class Plugin_manager;
cdc29364 60class Script_info;
bae7f79e 61
266d0a74
ILT
62// Incremental build action for a specific file, as selected by the user.
63
64enum Incremental_disposition
65{
221597a5
CC
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,
266d0a74
ILT
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
ee1fe73e
ILT
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.
c7912668
ILT
82namespace options
83{
ee1fe73e 84typedef std::vector<Search_directory> Dir_list;
c5818ff1 85typedef Unordered_set<std::string> String_set;
ee1fe73e
ILT
86
87// These routines convert from a string option to various types.
88// Each gives a fatal error if it cannot parse the argument.
89
90extern void
91parse_bool(const char* option_name, const char* arg, bool* retval);
92
c0a62865
DK
93extern void
94parse_int(const char* option_name, const char* arg, int* retval);
95
ee1fe73e
ILT
96extern void
97parse_uint(const char* option_name, const char* arg, int* retval);
98
99extern void
c18476e7
ILT
100parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
101
102extern void
103parse_double(const char* option_name, const char* arg, double* retval);
ee1fe73e 104
9fbd3822
CC
105extern void
106parse_percent(const char* option_name, const char* arg, double* retval);
107
ee1fe73e
ILT
108extern void
109parse_string(const char* option_name, const char* arg, const char** retval);
110
086a1841
ILT
111extern void
112parse_optional_string(const char* option_name, const char* arg,
113 const char** retval);
114
ee1fe73e
ILT
115extern void
116parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
117
c5818ff1
CC
118extern void
119parse_set(const char* option_name, const char* arg, String_set* retval);
120
ee1fe73e
ILT
121extern void
122parse_choices(const char* option_name, const char* arg, const char** retval,
123 const char* choices[], int num_choices);
124
125struct Struct_var;
126
127// Most options have both a shortname (one letter) and a longname.
128// This enum controls how many dashes are expected for longname access
129// -- shortnames always use one dash. Most longnames will accept
130// either one dash or two; the only difference between ONE_DASH and
131// TWO_DASHES is how we print the option in --help. However, some
132// longnames require two dashes, and some require only one. The
133// special value DASH_Z means that the option is preceded by "-z".
134enum Dashes
135{
136 ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z
137};
138
139// LONGNAME is the long-name of the option with dashes converted to
140// underscores, or else the short-name if the option has no long-name.
141// It is never the empty string.
142// DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
143// SHORTNAME is the short-name of the option, as a char, or '\0' if the
144// option has no short-name. If the option has no long-name, you
145// should specify the short-name in *both* VARNAME and here.
146// DEFAULT_VALUE is the value of the option if not specified on the
147// commandline, as a string.
148// HELPSTRING is the descriptive text used with the option via --help
149// HELPARG is how you define the argument to the option.
150// --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
151// HELPARG should be NULL iff the option is a bool and takes no arg.
086a1841
ILT
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.
ee1fe73e
ILT
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.
159struct 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;
086a1841 167 bool optional_arg;
ee1fe73e
ILT
168 Struct_var* reader;
169
170 One_option(const char* ln, Dashes d, char sn, const char* dv,
086a1841 171 const char* hs, const char* ha, bool oa, Struct_var* r)
ee1fe73e 172 : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
086a1841 173 helpstring(hs), helparg(ha), optional_arg(oa), reader(r)
ee1fe73e
ILT
174 {
175 // In longname, we convert all underscores to dashes, since GNU
176 // style uses dashes in option names. longname is likely to have
177 // underscores in it because it's also used to declare a C++
178 // function.
179 const char* pos = strchr(this->longname.c_str(), '_');
180 for (; pos; pos = strchr(pos, '_'))
181 this->longname[pos - this->longname.c_str()] = '-';
182
183 // We only register ourselves if our helpstring is not NULL. This
184 // is to support the "no-VAR" boolean variables, which we
185 // conditionally turn on by defining "no-VAR" help text.
186 if (this->helpstring)
187 this->register_option();
188 }
189
190 // This option takes an argument iff helparg is not NULL.
191 bool
192 takes_argument() const
193 { return this->helparg != NULL; }
194
086a1841
ILT
195 // Whether the argument is optional.
196 bool
197 takes_optional_argument() const
198 { return this->optional_arg; }
199
ee1fe73e
ILT
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.
211struct Struct_var
212{
213 // OPTION: the name of the option as specified on the commandline,
214 // including leading dashes, and any text following the option:
215 // "-O", "--defsym=mysym=0x1000", etc.
216 // ARG: the arg associated with this option, or NULL if the option
217 // takes no argument: "2", "mysym=0x1000", etc.
218 // CMDLINE: the global Command_line object. Used by DEFINE_special.
219 // OPTIONS: the global General_options object. Used by DEFINE_special.
220 virtual void
221 parse_to_value(const char* option, const char* arg,
222 Command_line* cmdline, General_options* options) = 0;
223 virtual
224 ~Struct_var() // To make gcc happy.
225 { }
226};
bae7f79e 227
ee1fe73e
ILT
228// This is for "special" options that aren't of any predefined type.
229struct Struct_special : public Struct_var
230{
231 // If you change this, change the parse-fn in DEFINE_special as well.
232 typedef void (General_options::*Parse_function)(const char*, const char*,
233 Command_line*);
234 Struct_special(const char* varname, Dashes dashes, char shortname,
235 Parse_function parse_function,
236 const char* helpstring, const char* helparg)
086a1841 237 : option(varname, dashes, shortname, "", helpstring, helparg, false, this),
ee1fe73e
ILT
238 parse(parse_function)
239 { }
240
2ea97941 241 void parse_to_value(const char* option, const char* arg,
ee1fe73e 242 Command_line* cmdline, General_options* options)
2ea97941 243 { (options->*(this->parse))(option, arg, cmdline); }
ee1fe73e
ILT
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.
e96c574b
DK
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.
ee1fe73e
ILT
263#define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
264 default_value_as_string__, helpstring__, helparg__, \
086a1841 265 optional_arg__, type__, param_type__, parse_fn__) \
ee1fe73e
ILT
266 public: \
267 param_type__ \
e96c574b 268 (varname__)() const \
ee1fe73e
ILT
269 { return this->varname__##_.value; } \
270 \
271 bool \
272 user_set_##varname__() const \
273 { return this->varname__##_.user_set_via_option; } \
274 \
2b706932
ILT
275 void \
276 set_user_set_##varname__() \
277 { this->varname__##_.user_set_via_option = true; } \
278 \
ee1fe73e
ILT
279 private: \
280 struct Struct_##varname__ : public options::Struct_var \
281 { \
282 Struct_##varname__() \
283 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
086a1841 284 helpstring__, helparg__, optional_arg__, this), \
ee1fe73e
ILT
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
d98bc257
ILT
308// VARNAME, we also create an option called no-VARNAME (or, for a -z
309// option, noVARNAME).
ee1fe73e
ILT
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, \
086a1841 314 false, bool, bool, options::parse_bool) \
ee1fe73e
ILT
315 struct Struct_no_##varname__ : public options::Struct_var \
316 { \
d98bc257
ILT
317 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
318 ? "no" #varname__ \
319 : "no-" #varname__), \
320 dashes__, '\0', \
ee1fe73e 321 default_value__ ? "false" : "true", \
086a1841 322 no_helpstring__, NULL, false, this) \
ee1fe73e
ILT
323 { } \
324 \
325 void \
326 parse_to_value(const char*, const char*, \
327 Command_line*, General_options* options) \
41263c05
DK
328 { \
329 options->set_##varname__(false); \
330 options->set_user_set_##varname__(); \
331 } \
ee1fe73e
ILT
332 \
333 options::One_option option; \
334 }; \
335 Struct_no_##varname__ no_##varname__##_initializer_
336
7c414435
DM
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
c0a62865
DK
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
ee1fe73e
ILT
365#define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
366 helpstring__, helparg__) \
367 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
086a1841 368 #default_value__, helpstring__, helparg__, false, \
ee1fe73e
ILT
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__, \
086a1841 374 #default_value__, helpstring__, helparg__, false, \
ee1fe73e
ILT
375 uint64_t, uint64_t, options::parse_uint64)
376
c18476e7
ILT
377#define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
378 helpstring__, helparg__) \
379 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
086a1841 380 #default_value__, helpstring__, helparg__, false, \
c18476e7
ILT
381 double, double, options::parse_double)
382
9fbd3822
CC
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
ee1fe73e
ILT
389#define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
390 helpstring__, helparg__) \
391 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
086a1841 392 default_value__, helpstring__, helparg__, false, \
ee1fe73e
ILT
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__, , \
086a1841 401 "", helpstring__, helparg__, false, options::Dir_list, \
ee1fe73e
ILT
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
c5818ff1
CC
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(); } \
f3e9c5c5 420 \
c5818ff1
CC
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())); \
f3e9c5c5
ILT
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(); }
c5818ff1 436
ee1fe73e
ILT
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__, \
086a1841 443 default_value__, helpstring__, helparg__, false, \
ee1fe73e
ILT
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
2b706932
ILT
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
214383dd
ILT
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
ee1fe73e
ILT
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_
bae7f79e 546
086a1841
ILT
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)
bae7f79e 556
ad2d6943
ILT
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
562class Search_directory
563{
564 public:
565 // We need a default constructor because we put this in a
566 // std::vector.
567 Search_directory()
568 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
569 { }
570
571 // This is the usual constructor.
3f3cddf1 572 Search_directory(const std::string& name, bool put_in_sysroot)
2ea97941 573 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
15893b88
ILT
574 {
575 if (this->name_.empty())
576 this->name_ = ".";
577 }
ad2d6943
ILT
578
579 // This is called if we have a sysroot. The sysroot is prefixed to
580 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
581 // set to true for any enries which are in the sysroot (this will
582 // naturally include any entries for which put_in_sysroot_ is true).
583 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
584 // passing SYSROOT to lrealpath.
585 void
586 add_sysroot(const char* sysroot, const char* canonical_sysroot);
587
588 // Get the directory name.
589 const std::string&
590 name() const
591 { return this->name_; }
592
593 // Return whether this directory is in the sysroot.
594 bool
595 is_in_sysroot() const
596 { return this->is_in_sysroot_; }
597
fd9d194f
ILT
598 // Return whether this is considered a system directory.
599 bool
600 is_system_directory() const
601 { return this->put_in_sysroot_ || this->is_in_sysroot_; }
602
ad2d6943 603 private:
fd9d194f 604 // The directory name.
ad2d6943 605 std::string name_;
fd9d194f
ILT
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.
ad2d6943 609 bool put_in_sysroot_;
fd9d194f
ILT
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.
ad2d6943
ILT
614 bool is_in_sysroot_;
615};
616
bae7f79e
ILT
617class General_options
618{
ee1fe73e
ILT
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',
a4d4b13f 623 N_("Report usage information"), NULL);
ee1fe73e 624 DEFINE_special(version, options::TWO_DASHES, 'v',
a4d4b13f 625 N_("Report version information"), NULL);
b5be4a7c
DM
626 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
627 N_("Report version and target information"), NULL);
ee1fe73e 628
fee2edb1
ILT
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
7eaea549
ILT
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
9c4ae156
ILT
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);
30bc8c46 642
ee1fe73e 643 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
a4d4b13f
ILT
644 N_("Allow unresolved references in shared libraries"),
645 N_("Do not allow unresolved references in shared libraries"));
ee1fe73e
ILT
646
647 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
7eaea549
ILT
648 N_("Only set DT_NEEDED for shared libraries if used"),
649 N_("Always DT_NEEDED for shared libraries"));
ee1fe73e 650
fe35d28d
ILT
651 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
652 N_("Ignored"), N_("[ignored]"),
653 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
654
fee2edb1
ILT
655 // This should really be an "enum", but it's too easy for folks to
656 // forget to update the list as they add new targets. So we just
657 // accept any string. We'll fail later (when the string is parsed),
658 // if the target isn't actually supported.
659 DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
660 N_("Set input format"), ("[elf,binary]"));
661
ee1fe73e 662 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
a4d4b13f 663 N_("-l searches for shared libraries"), NULL);
2b706932
ILT
664 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
665 N_("-l does not search for shared libraries"), NULL,
666 true);
b821d13c
ILT
667 DEFINE_bool_alias(dy, Bdynamic, options::ONE_DASH, '\0',
668 N_("alias for -Bdynamic"), NULL, false);
669 DEFINE_bool_alias(dn, Bdynamic, options::ONE_DASH, '\0',
670 N_("alias for -Bstatic"), NULL, true);
ee1fe73e 671
e2153196
ILT
672 DEFINE_bool(Bgroup, options::ONE_DASH, '\0', false,
673 N_("Use group name lookup rules for shared library"), NULL);
674
ee1fe73e 675 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
a4d4b13f 676 N_("Bind defined symbols locally"), NULL);
ee1fe73e 677
f1f70eae
ILT
678 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
679 N_("Bind defined function symbols locally"), NULL);
680
8ed814a9
ILT
681 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
682 N_("Generate build ID note"),
683 N_("[=STYLE]"));
684
34810851
ILT
685 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
686 N_("Check segment addresses for overlaps (default)"),
687 N_("Do not check segment addresses for overlaps"));
688
ee1fe73e
ILT
689#ifdef HAVE_ZLIB_H
690 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
a4d4b13f
ILT
691 N_("Compress .debug_* sections in the output file"),
692 ("[none,zlib]"),
ee1fe73e
ILT
693 {"none", "zlib"});
694#else
695 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
a4d4b13f
ILT
696 N_("Compress .debug_* sections in the output file"),
697 N_("[none]"),
ee1fe73e
ILT
698 {"none"});
699#endif
0dfbdef4 700
7eaea549
ILT
701 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
702 N_("Not supported"),
703 N_("Do not copy DT_NEEDED tags from shared libraries"));
704
dde3f402
ILT
705 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
706 N_("Output cross reference table"),
707 N_("Do not output cross reference table"));
708
5393d741
ILT
709 DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
710 N_("Use DT_INIT_ARRAY for all constructors (default)"),
711 N_("Handle constructors as directed by compiler"));
712
ee1fe73e 713 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
a4d4b13f
ILT
714 N_("Define common symbols"),
715 N_("Do not define common symbols"));
ee1fe73e 716 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
a4d4b13f 717 N_("Alias for -d"), NULL);
ee1fe73e 718 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
a4d4b13f 719 N_("Alias for -d"), NULL);
d391083d 720
fee2edb1 721 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
2285a610
ILT
722 N_("Turn on debugging"),
723 N_("[all,files,script,task][,...]"));
fee2edb1 724
ee1fe73e 725 DEFINE_special(defsym, options::TWO_DASHES, '\0',
a4d4b13f 726 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
a6badf5a 727
086a1841
ILT
728 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
729 N_("Demangle C++ symbols in log messages"),
730 N_("[=STYLE]"));
731
732 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
733 N_("Do not demangle C++ symbols in log messages"),
734 NULL);
fced7afd 735
ee1fe73e 736 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
f30f86fa
ILT
737 N_("Look for violations of the C++ One Definition Rule"),
738 N_("Do not look for violations of the C++ One Definition Rule"));
ee1fe73e 739
ebcc8304
ILT
740 DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
741 N_("Delete all local symbols"), NULL);
bb04269c
DK
742 DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
743 N_("Delete all temporary local symbols"), NULL);
744
c82fbeee
CS
745 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
746 N_("Add data symbols to dynamic symbols"), NULL);
747
748 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
749 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
750
751 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
752 N_("Add C++ typeinfo to dynamic symbols"), NULL);
753
754 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
755 N_("Read a list of dynamic symbols"), N_("FILE"));
756
ee1fe73e 757 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
a4d4b13f 758 N_("Set program start address"), N_("ADDRESS"));
ee1fe73e 759
65514900
CC
760 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
761 N_("Exclude libraries from automatic export"),
762 N_(("lib,lib ...")));
763
ee1fe73e 764 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
ee769c88
ILT
765 N_("Export all dynamic symbols"),
766 N_("Do not export all dynamic symbols (default)"));
dbe717ef 767
31821be0
CC
768 DEFINE_set(export_dynamic_symbol, options::TWO_DASHES, '\0',
769 N_("Export SYMBOL to dynamic symbol table"), N_("SYMBOL"));
770
7296d933
DK
771 DEFINE_special(EB, options::ONE_DASH, '\0',
772 N_("Link big-endian objects."), NULL);
773
7296d933
DK
774 DEFINE_special(EL, options::ONE_DASH, '\0',
775 N_("Link little-endian objects."), NULL);
776
f1ddb600
ILT
777 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
778 N_("Create exception frame header"), NULL);
779
ce0d1972
DK
780 DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
781 N_("(ARM only) Do not warn about objects with incompatible "
782 "enum sizes"));
783
886288f1
ILT
784 DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
785 N_("Auxiliary filter for shared object symbol table"),
786 N_("SHLIB"));
787
788 DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
789 N_("Filter for shared object symbol table"),
790 N_("SHLIB"));
791
d82a5bcc
ILT
792 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
793 N_("Treat warnings as errors"),
794 N_("Do not treat warnings as errors"));
795
c6585162
ILT
796 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
797 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
798
41263c05
DK
799 DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
800 N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
801 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
802
a8e2273b
ILT
803 DEFINE_bool(fix_arm1176, options::TWO_DASHES, '\0', true,
804 N_("(ARM only) Fix binaries for ARM1176 erratum."),
805 N_("(ARM only) Do not fix binaries for ARM1176 erratum."));
806
85fdf906
AH
807 DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
808 N_("(ARM only) Merge exidx entries in debuginfo."),
809 N_("(ARM only) Do not merge exidx entries in debuginfo."));
810
9b2fd367
DK
811 DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
812 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
813 NULL);
814
815 DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
816 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
817 "veneer"),
818 NULL);
819
fe35d28d
ILT
820 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
821 N_("Ignored"), NULL);
822
c1027032
CC
823 DEFINE_bool(gdb_index, options::TWO_DASHES, '\0', false,
824 N_("Generate .gdb_index section"),
825 N_("Do not generate .gdb_index section"));
826
9634ed06
CC
827 DEFINE_bool(gnu_unique, options::TWO_DASHES, '\0', true,
828 N_("Enable STB_GNU_UNIQUE symbol binding (default)"),
829 N_("Disable STB_GNU_UNIQUE symbol binding"));
830
ee1fe73e 831 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
a4d4b13f 832 N_("Set shared library name"), N_("FILENAME"));
ee1fe73e 833
c18476e7
ILT
834 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
835 N_("Min fraction of empty buckets in dynamic hash"),
836 N_("FRACTION"));
837
13670ee6 838 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
a4d4b13f 839 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
13670ee6
ILT
840 {"sysv", "gnu", "both"});
841
ee1fe73e 842 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
a4d4b13f 843 N_("Set dynamic linker path"), N_("PROGRAM"));
ee1fe73e 844
8c21d9d3
CC
845 DEFINE_special(incremental, options::TWO_DASHES, '\0',
846 N_("Do an incremental link if possible; "
847 "otherwise, do a full link and prepare output "
848 "for incremental linking"), NULL);
849
850 DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
851 N_("Do a full link (default)"), NULL);
852
853 DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
854 N_("Do a full link and "
855 "prepare output for incremental linking"), NULL);
856
857 DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
858 N_("Do an incremental link; exit if not possible"), NULL);
266d0a74 859
aa92d6ed
CC
860 DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
861 N_("Set base file for incremental linking"
862 " (default is output file)"),
863 N_("FILE"));
864
266d0a74
ILT
865 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
866 N_("Assume files changed"), NULL);
867
868 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
869 N_("Assume files didn't change"), NULL);
870
871 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
872 N_("Use timestamps to check files (default)"), NULL);
873
221597a5
CC
874 DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
875 N_("Assume startup files unchanged "
876 "(files preceding this option)"), NULL);
877
9fbd3822
CC
878 DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
879 N_("Amount of extra space to allocate for patches"),
880 N_("PERCENT"));
881
c6585162
ILT
882 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
883 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
884
fee2edb1
ILT
885 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
886 N_("Read only symbol values from FILE"), N_("FILE"));
887
a2a5469e 888 DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
2c849493
ILT
889 sizeof(void*) >= 8,
890 N_("Map whole files to memory (default on 64-bit hosts)"),
891 N_("Map relevant file parts to memory (default on 32-bit "
892 "hosts)"));
a2a5469e
CC
893 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
894 N_("Keep files mapped across passes (default)"),
895 N_("Release mapped files after each pass"));
2c849493 896
07a60597
ILT
897 DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
898 N_("Generate unwind information for PLT (default)"),
899 N_("Do not generate unwind information for PLT"));
900
ee1fe73e 901 DEFINE_special(library, options::TWO_DASHES, 'l',
a4d4b13f 902 N_("Search for library LIBNAME"), N_("LIBNAME"));
bae7f79e 903
ee1fe73e 904 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
a4d4b13f 905 N_("Add directory to search path"), N_("DIR"));
ee1fe73e 906
c6ac678d
ST
907 DEFINE_bool(text_reorder, options::TWO_DASHES, '\0', true,
908 N_("Enable text section reordering for GCC section names "
909 "(default)"),
910 N_("Disable text section reordering for GCC section names"));
911
91e75c8a
RÁE
912 DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
913 N_(" Only search directories specified on the command line."),
914 NULL);
915
0f72bf6f
RÁE
916 DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
917 N_(" Put read-only non-executable sections in their own segment"),
918 NULL);
919
ee1fe73e 920 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
03ef7571 921 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
ee1fe73e 922
7c0640fa
CC
923 DEFINE_bool(mmap_output_file, options::TWO_DASHES, '\0', true,
924 N_("Map the output file for writing (default)."),
925 N_("Do not map the output file for writing."));
926
7d9e3d98
ILT
927 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
928 N_("Write map file on standard output"), NULL);
929 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
930 N_("MAPFILENAME"));
931
af6156ef
ILT
932 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
933 N_("Do not page align data"), NULL);
934 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
935 N_("Do not page align data, do not make text readonly"),
936 N_("Page align data, make text readonly"));
937
50701cc1 938 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', true,
7c414435
DM
939 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
940 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
941
cdb0b8f5
ILT
942 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
943 N_("Create an output file even if errors occur"), NULL);
944
f3e9c5c5
ILT
945 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
946 N_("Report undefined symbols (even with --shared)"),
947 NULL, false);
948
ee1fe73e 949 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
a4d4b13f 950 N_("Set output file name"), N_("FILE"));
ee1fe73e
ILT
951
952 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
a4d4b13f 953 N_("Optimize output file size"), N_("LEVEL"));
ee1fe73e 954
a4d4b13f
ILT
955 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
956 N_("Set output format"), N_("[binary]"));
ee1fe73e 957
7296d933
DK
958 DEFINE_bool(p, options::ONE_DASH, '\0', false,
959 N_("(ARM only) Ignore for backward compatibility"), NULL);
960
374ad285
ILT
961 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
962 N_("Create a position independent executable"), NULL);
963 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
964 N_("Create a position independent executable"), NULL,
965 false);
966
7296d933
DK
967 DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
968 NULL, N_("(ARM only) Ignore for backward compatibility"));
969
9e69ed50
AM
970 DEFINE_var(plt_align, options::TWO_DASHES, '\0', 0, "5",
971 N_("(PowerPC64 only) Align PLT call stubs to fit cache lines"),
972 N_("[=P2ALIGN]"), true, int, int, options::parse_uint);
973
974 DEFINE_bool(plt_static_chain, options::TWO_DASHES, '\0', false,
975 N_("(PowerPC64 only) PLT call stubs should load r11"),
976 N_("(PowerPC64 only) PLT call stubs should not load r11"));
977
978 DEFINE_bool(plt_thread_safe, options::TWO_DASHES, '\0', false,
979 N_("(PowerPC64 only) PLT call stubs with load-load barrier"),
980 N_("(PowerPC64 only) PLT call stubs without barrier"));
981
89fc3421
CC
982#ifdef ENABLE_PLUGINS
983 DEFINE_special(plugin, options::TWO_DASHES, '\0',
4674ecfc
CC
984 N_("Load a plugin library"), N_("PLUGIN"));
985 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
986 N_("Pass an option to the plugin"), N_("OPTION"));
89fc3421
CC
987#endif
988
7c0640fa
CC
989 DEFINE_bool(posix_fallocate, options::TWO_DASHES, '\0', true,
990 N_("Use posix_fallocate to reserve space in the output file"
991 " (default)."),
992 N_("Use fallocate or ftruncate to reserve space."));
993
ac45a351
CC
994 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
995 N_("Preread archive symbols when multi-threaded"), NULL);
89fc3421 996
f1ddb600
ILT
997 DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
998 N_("Print default output format"), NULL);
999
92de84a6
ILT
1000 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
1001 N_("Print symbols defined and used for each input"),
1002 N_("FILENAME"));
1003
b5be4a7c
DM
1004 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
1005 N_("Ignored for SVR4 compatibility"), NULL);
1006
ee1fe73e 1007 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
a4d4b13f 1008 N_("Generate relocations in output"), NULL);
ee1fe73e
ILT
1009
1010 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
a4d4b13f 1011 N_("Generate relocatable output"), NULL);
ec69d6da
ILT
1012 DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
1013 N_("Synonym for -r"), NULL, false);
ee1fe73e 1014
706e1f5e
ILT
1015 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
1016 N_("Relax branches on certain targets"), NULL);
1017
719328e1
ILT
1018 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
1019 N_("keep only symbols listed in this file"), N_("FILE"));
8c604651 1020
ee1fe73e
ILT
1021 // -R really means -rpath, but can mean --just-symbols for
1022 // compatibility with GNU ld. -rpath is always -rpath, so we list
1023 // it separately.
1024 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
a4d4b13f 1025 N_("Add DIR to runtime search path"), N_("DIR"));
ee1fe73e
ILT
1026
1027 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
a4d4b13f 1028 N_("Add DIR to runtime search path"), N_("DIR"));
ee1fe73e 1029
ee1fe73e 1030 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
a4d4b13f
ILT
1031 N_("Add DIR to link time shared library search path"),
1032 N_("DIR"));
ee1fe73e 1033
6e9ba2ca
ST
1034 DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
1035 N_("Layout sections in the order specified."),
1036 N_("FILENAME"));
1037
a192ba05
ILT
1038 DEFINE_special(section_start, options::TWO_DASHES, '\0',
1039 N_("Set address of section"), N_("SECTION=ADDRESS"));
1040
fc59c572
ILT
1041 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
1042 N_("Sort common symbols by alignment"),
1043 N_("[={ascending,descending}]"));
1044
9e9e071b
ILT
1045 DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
1046 N_("Dynamic tag slots to reserve (default 5)"),
1047 N_("COUNT"));
1048
ee1fe73e 1049 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
a4d4b13f 1050 N_("Strip all symbols"), NULL);
fee2edb1
ILT
1051 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
1052 N_("Strip debugging information"), NULL);
62b01cb5
ILT
1053 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
1054 N_("Emit only debug line number information"), NULL);
ee1fe73e 1055 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
a4d4b13f 1056 N_("Strip debug symbols that are unused by gdb "
fb1b895d 1057 "(at least versions <= 7.4)"), NULL);
fd06b4aa
CC
1058 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
1059 N_("Strip LTO intermediate code sections"), NULL);
ee1fe73e 1060
c0a62865 1061 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
9e69ed50
AM
1062 N_("(ARM, PowerPC only) The maximum distance from instructions "
1063 "in a group of sections to their stubs. Negative values mean "
1064 "stubs are always after (PowerPC before) the group. 1 means "
1065 "use default size.\n"),
c0a62865
DK
1066 N_("SIZE"));
1067
f773f3d2
CC
1068 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
1069 N_("Use less memory and more disk I/O "
1070 "(included only for compatibility with GNU ld)"), NULL);
3b293544 1071
fe35d28d 1072 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
a4d4b13f 1073 N_("Generate shared library"), NULL);
ee1fe73e 1074
3b293544
CF
1075 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
1076 N_("Generate shared library"), NULL);
1077
364c7fa5
ILT
1078 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
1079 N_("Stack size when -fsplit-stack function calls non-split"),
1080 N_("SIZE"));
1081
ee1fe73e
ILT
1082 // This is not actually special in any way, but I need to give it
1083 // a non-standard accessor-function name because 'static' is a keyword.
1084 DEFINE_special(static, options::ONE_DASH, '\0',
a4d4b13f 1085 N_("Do not link against shared libraries"), NULL);
ee1fe73e 1086
032ce4e9
ST
1087 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
1088 N_("Identical Code Folding. "
21bb3914
ST
1089 "\'--icf=safe\' Folds ctors, dtors and functions whose"
1090 " pointers are definitely not taken."),
032ce4e9
ST
1091 ("[none,all,safe]"),
1092 {"none", "all", "safe"});
ef15dade
ST
1093
1094 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
1095 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
1096
1097 DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
1098 N_("List folded identical sections on stderr"),
1099 N_("Do not list folded identical sections"));
1100
48c187ce
ST
1101 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
1102 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1103
6d03d481 1104 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
266d0a74 1105 N_("Remove unused sections"),
6d03d481 1106 N_("Don't remove unused sections (default)"));
266d0a74 1107
6d03d481 1108 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
266d0a74 1109 N_("List removed unused sections on stderr"),
6d03d481
ST
1110 N_("Do not list removed unused sections"));
1111
ee1fe73e 1112 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
a4d4b13f 1113 N_("Print resource usage statistics"), NULL);
ee1fe73e
ILT
1114
1115 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
a4d4b13f 1116 N_("Set target system root directory"), N_("DIR"));
ee1fe73e 1117
c5818ff1
CC
1118 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1119 N_("Print the name of each input file"), NULL);
1120
ee1fe73e 1121 DEFINE_special(script, options::TWO_DASHES, 'T',
a4d4b13f 1122 N_("Read linker script"), N_("FILE"));
ee1fe73e
ILT
1123
1124 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
a4d4b13f
ILT
1125 N_("Run the linker multi-threaded"),
1126 N_("Do not run the linker multi-threaded"));
ee1fe73e 1127 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
a4d4b13f 1128 N_("Number of threads to use"), N_("COUNT"));
ee1fe73e 1129 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
a4d4b13f 1130 N_("Number of threads to use in initial pass"), N_("COUNT"));
ee1fe73e 1131 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
a4d4b13f 1132 N_("Number of threads to use in middle pass"), N_("COUNT"));
ee1fe73e 1133 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
a4d4b13f 1134 N_("Number of threads to use in final pass"), N_("COUNT"));
ee1fe73e 1135
fee2edb1
ILT
1136 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1137 N_("Set the address of the bss segment"), N_("ADDRESS"));
1138 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1139 N_("Set the address of the data segment"), N_("ADDRESS"));
1140 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1141 N_("Set the address of the text segment"), N_("ADDRESS"));
214383dd
ILT
1142 DEFINE_uint64_alias(Ttext_segment, Ttext, options::ONE_DASH, '\0',
1143 N_("Set the address of the text segment"),
1144 N_("ADDRESS"));
fee2edb1 1145
d8f5a274
AM
1146 DEFINE_bool(toc_optimize, options::TWO_DASHES, '\0', true,
1147 N_("(PowerPC64 only) Optimize TOC code sequences"),
1148 N_("(PowerPC64 only) Don't optimize TOC code sequences"));
1149
1150 DEFINE_bool(toc_sort, options::TWO_DASHES, '\0', true,
1151 N_("(PowerPC64 only) Sort TOC and GOT sections"),
1152 N_("(PowerPC64 only) Don't sort TOC and GOT sections"));
aba6bc71 1153
f3e9c5c5
ILT
1154 DEFINE_set(undefined, options::TWO_DASHES, 'u',
1155 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
2b706932 1156
beabb2c6
ILT
1157 DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1158 N_("How to handle unresolved symbols"),
1159 ("ignore-all,report-all,ignore-in-object-files,"
1160 "ignore-in-shared-libs"),
1161 {"ignore-all", "report-all", "ignore-in-object-files",
1162 "ignore-in-shared-libs"});
1163
2285a610
ILT
1164 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1165 N_("Synonym for --debug=files"), NULL);
1166
fee2edb1
ILT
1167 DEFINE_special(version_script, options::TWO_DASHES, '\0',
1168 N_("Read version script"), N_("FILE"));
1169
1ae4d23b
ILT
1170 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1171 N_("Warn about duplicate common symbols"),
1172 N_("Do not warn about duplicate common symbols (default)"));
1173
37a9ac43
ILT
1174 DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1175 N_("Ignored"), N_("Ignored"));
1176
83e17bd5
CC
1177 DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1178 N_("Warn if the stack is executable"),
1179 N_("Do not warn if the stack is executable (default)"));
1180
7296d933
DK
1181 DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1182 NULL, N_("Don't warn about mismatched input files"));
1183
6eda8c29
ILT
1184 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1185 N_("Ignored"), NULL);
1186
15f8229b
ILT
1187 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1188 N_("Warn when skipping an incompatible library"),
1189 N_("Don't warn when skipping an incompatible library"));
1190
b9674e17
ILT
1191 DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1192 N_("Warn if text segment is not shareable"),
1193 N_("Do not warn if text segment is not shareable (default)"));
1194
dc3f80fe
ILT
1195 DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1196 N_("Report unresolved symbols as warnings"),
1197 NULL);
1198 DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1199 options::TWO_DASHES, '\0',
1200 N_("Report unresolved symbols as errors"),
1201 NULL, true);
1202
ce0d1972
DK
1203 DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1204 N_("(ARM only) Do not warn about objects with incompatible "
1205 "wchar_t sizes"));
1206
ee1fe73e 1207 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
a4d4b13f
ILT
1208 N_("Include all archive contents"),
1209 N_("Include only needed archive contents"));
ee1fe73e 1210
c5818ff1
CC
1211 DEFINE_set(wrap, options::TWO_DASHES, '\0',
1212 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1213
1214 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1215 N_("Trace references to symbol"), N_("SYMBOL"));
0864d551 1216
62dfdd4d
ILT
1217 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1218 N_("Allow unused version in script (default)"),
1219 N_("Do not allow unused version in script"));
1220
706e1f5e
ILT
1221 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1222 N_("Default search path for Solaris compatibility"),
1223 N_("PATH"));
1224
ee1fe73e 1225 DEFINE_special(start_group, options::TWO_DASHES, '(',
a4d4b13f 1226 N_("Start a library search group"), NULL);
ee1fe73e 1227 DEFINE_special(end_group, options::TWO_DASHES, ')',
a4d4b13f 1228 N_("End a library search group"), NULL);
ee1fe73e 1229
b0193076
RÁE
1230
1231 DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1232 N_("Start a library"), NULL);
1233 DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1234 N_("End a library "), NULL);
1235
4f46f626
L
1236 DEFINE_string(fuse_ld, options::ONE_DASH, '\0', "",
1237 N_("Ignored for GCC linker option compatibility"),
1238 "");
1239
fee2edb1 1240 // The -z options.
ee1fe73e 1241
d98bc257
ILT
1242 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1243 N_("Sort dynamic relocs"),
1244 N_("Do not sort dynamic relocs"));
fee2edb1
ILT
1245 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1246 N_("Set common page size to SIZE"), N_("SIZE"));
eb42429a
ILT
1247 DEFINE_bool(defs, options::DASH_Z, '\0', false,
1248 N_("Report undefined symbols (even with --shared)"),
1249 NULL);
ee1fe73e 1250 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
a4d4b13f 1251 N_("Mark output as requiring executable stack"), NULL);
7c414435
DM
1252 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1253 N_("Mark DSO to be initialized first at runtime"),
1254 NULL);
1255 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1256 N_("Mark object to interpose all DSOs but executable"),
1257 NULL);
6a9da32a
CC
1258 DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1259 N_("Mark object for lazy runtime binding (default)"),
1260 NULL, true);
7c414435
DM
1261 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1262 N_("Mark object requiring immediate process"),
1263 NULL);
e1c74d60
ILT
1264 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1265 N_("Set maximum page size to SIZE"), N_("SIZE"));
30bc8c46
ILT
1266 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1267 N_("Allow multiple definitions of symbols"),
1268 NULL);
1269 // copyreloc is here in the list because there is only -z
1270 // nocopyreloc, not -z copyreloc.
966d4097
DK
1271 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1272 NULL,
1273 N_("Do not create copy relocs"));
7c414435
DM
1274 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1275 N_("Mark object not to use default search paths"),
1276 NULL);
1277 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1278 N_("Mark DSO non-deletable at runtime"),
1279 NULL);
1280 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1281 N_("Mark DSO not available to dlopen"),
1282 NULL);
1283 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1284 N_("Mark DSO not available to dldump"),
1285 NULL);
e1c74d60
ILT
1286 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1287 N_("Mark output as not requiring executable stack"), NULL);
1288 DEFINE_bool(now, options::DASH_Z, '\0', false,
1289 N_("Mark object for immediate function binding"),
1290 NULL);
7be8330a
CD
1291 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1292 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1293 "processing at runtime"), NULL);
e1c74d60
ILT
1294 DEFINE_bool(relro, options::DASH_Z, '\0', false,
1295 N_("Where possible mark variables read-only after relocation"),
1296 N_("Don't mark variables read-only after relocation"));
ffeef7df
ILT
1297 DEFINE_bool(text, options::DASH_Z, '\0', false,
1298 N_("Do not permit relocations in read-only segments"),
611062c0 1299 N_("Permit relocations in read-only segments (default)"));
ffeef7df
ILT
1300 DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1301 N_("Permit relocations in read-only segments (default)"),
1302 NULL, true);
bae7f79e 1303
ee1fe73e
ILT
1304 public:
1305 typedef options::Dir_list Dir_list;
ca3a67a5 1306
ee1fe73e 1307 General_options();
61ba1cf9 1308
ee1fe73e
ILT
1309 // Does post-processing on flags, making sure they all have
1310 // non-conflicting values. Also converts some flags from their
1311 // "standard" types (string, etc), to another type (enum, DirList),
1312 // which can be accessed via a separate method. Dies if it notices
1313 // any problems.
1314 void finalize();
516cb3d0 1315
459c9f1c
ILT
1316 // True if we printed the version information.
1317 bool
1318 printed_version() const
1319 { return this->printed_version_; }
1320
ee1fe73e
ILT
1321 // The macro defines output() (based on --output), but that's a
1322 // generic name. Provide this alternative name, which is clearer.
8851ecca 1323 const char*
ee1fe73e
ILT
1324 output_file_name() const
1325 { return this->output(); }
92e059d8 1326
8851ecca
ILT
1327 // This is not defined via a flag, but combines flags to say whether
1328 // the output is position-independent or not.
1329 bool
1330 output_is_position_independent() const
374ad285 1331 { return this->shared() || this->pie(); }
8851ecca 1332
183fd0e3
AO
1333 // Return true if the output is something that can be exec()ed, such
1334 // as a static executable, or a position-dependent or
1335 // position-independent executable, but not a dynamic library or an
1336 // object file.
1337 bool
1338 output_is_executable() const
374ad285 1339 { return !this->shared() && !this->relocatable(); }
183fd0e3 1340
ee1fe73e
ILT
1341 // This would normally be static(), and defined automatically, but
1342 // since static is a keyword, we need to come up with our own name.
bae7f79e
ILT
1343 bool
1344 is_static() const
ee1fe73e 1345 { return static_; }
756ac4a8 1346
ee1fe73e
ILT
1347 // In addition to getting the input and output formats as a string
1348 // (via format() and oformat()), we also give access as an enum.
1349 enum Object_format
1350 {
1351 // Ordinary ELF.
1352 OBJECT_FORMAT_ELF,
1353 // Straight binary format.
1354 OBJECT_FORMAT_BINARY
1355 };
fe9a4c12 1356
e6a307ba
ILT
1357 // Convert a string to an Object_format. Gives an error if the
1358 // string is not recognized.
1359 static Object_format
1360 string_to_object_format(const char* arg);
1361
ee1fe73e
ILT
1362 // Note: these functions are not very fast.
1363 Object_format format_enum() const;
1364 Object_format oformat_enum() const;
fe9a4c12 1365
fd9d194f
ILT
1366 // Return whether FILENAME is in a system directory.
1367 bool
1368 is_in_system_directory(const std::string& name) const;
1369
8c604651
CS
1370 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1371 bool
1372 should_retain_symbol(const char* symbol_name) const
1373 {
1374 if (symbols_to_retain_.empty()) // means flag wasn't specified
1375 return true;
1376 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1377 }
1378
ee1fe73e
ILT
1379 // These are the best way to get access to the execstack state,
1380 // not execstack() and noexecstack() which are hard to use properly.
35cdfc9a
ILT
1381 bool
1382 is_execstack_set() const
ee1fe73e 1383 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
35cdfc9a
ILT
1384
1385 bool
1386 is_stack_executable() const
ee1fe73e 1387 { return this->execstack_status_ == EXECSTACK_YES; }
c7912668 1388
032ce4e9
ST
1389 bool
1390 icf_enabled() const
1391 { return this->icf_status_ != ICF_NONE; }
1392
1393 bool
1394 icf_safe_folding() const
1395 { return this->icf_status_ == ICF_SAFE; }
1396
086a1841
ILT
1397 // The --demangle option takes an optional string, and there is also
1398 // a --no-demangle option. This is the best way to decide whether
1399 // to demangle or not.
1400 bool
1401 do_demangle() const
1402 { return this->do_demangle_; }
1403
89fc3421
CC
1404 // Returns TRUE if any plugin libraries have been loaded.
1405 bool
1406 has_plugins() const
1407 { return this->plugins_ != NULL; }
1408
1409 // Return a pointer to the plugin manager.
1410 Plugin_manager*
1411 plugins() const
1412 { return this->plugins_; }
1413
c82fbeee
CS
1414 // True iff SYMBOL was found in the file specified by dynamic-list.
1415 bool
1416 in_dynamic_list(const char* symbol) const
1417 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1418
6affe781
ILT
1419 // Finalize the dynamic list.
1420 void
1421 finalize_dynamic_list()
1422 { this->dynamic_list_.version_script_info()->finalize(); }
1423
8c21d9d3
CC
1424 // The mode selected by the --incremental options.
1425 enum Incremental_mode
1426 {
1427 // No incremental linking (--no-incremental).
1428 INCREMENTAL_OFF,
1429 // Incremental update only (--incremental-update).
1430 INCREMENTAL_UPDATE,
1431 // Force a full link, but prepare for subsequent incremental link
1432 // (--incremental-full).
1433 INCREMENTAL_FULL,
1434 // Incremental update if possible, fallback to full link (--incremental).
1435 INCREMENTAL_AUTO
1436 };
1437
1438 // The incremental linking mode.
1439 Incremental_mode
1440 incremental_mode() const
1441 { return this->incremental_mode_; }
1442
266d0a74
ILT
1443 // The disposition given by the --incremental-changed,
1444 // --incremental-unchanged or --incremental-unknown option. The
1445 // value may change as we proceed parsing the command line flags.
1446 Incremental_disposition
1447 incremental_disposition() const
1448 { return this->incremental_disposition_; }
1449
221597a5
CC
1450 // The disposition to use for startup files (those that precede the
1451 // first --incremental-changed, etc. option).
1452 Incremental_disposition
1453 incremental_startup_disposition() const
1454 { return this->incremental_startup_disposition_; }
1455
65514900
CC
1456 // Return true if S is the name of a library excluded from automatic
1457 // symbol export.
1458 bool
ca09d69a 1459 check_excluded_libs(const std::string &s) const;
65514900 1460
a192ba05
ILT
1461 // If an explicit start address was given for section SECNAME with
1462 // the --section-start option, return true and set *PADDR to the
1463 // address. Otherwise return false.
1464 bool
1465 section_start(const char* secname, uint64_t* paddr) const;
1466
ea0d8c47
ILT
1467 // Return whether any --section-start option was used.
1468 bool
1469 any_section_start() const
1470 { return !this->section_starts_.empty(); }
1471
9b2fd367
DK
1472 enum Fix_v4bx
1473 {
1474 // Leave original instruction.
1475 FIX_V4BX_NONE,
1476 // Replace instruction.
1477 FIX_V4BX_REPLACE,
1478 // Generate an interworking veneer.
1479 FIX_V4BX_INTERWORKING
1480 };
1481
1482 Fix_v4bx
1483 fix_v4bx() const
1484 { return (this->fix_v4bx_); }
1485
7296d933
DK
1486 enum Endianness
1487 {
1488 ENDIANNESS_NOT_SET,
1489 ENDIANNESS_BIG,
1490 ENDIANNESS_LITTLE
1491 };
1492
1493 Endianness
1494 endianness() const
1495 { return this->endianness_; }
1496
bae7f79e 1497 private:
dbe717ef
ILT
1498 // Don't copy this structure.
1499 General_options(const General_options&);
1500 General_options& operator=(const General_options&);
1501
35cdfc9a
ILT
1502 // Whether to mark the stack as executable.
1503 enum Execstack
1504 {
1505 // Not set on command line.
1506 EXECSTACK_FROM_INPUT,
ee1fe73e 1507 // Mark the stack as executable (-z execstack).
35cdfc9a 1508 EXECSTACK_YES,
ee1fe73e 1509 // Mark the stack as not executable (-z noexecstack).
35cdfc9a
ILT
1510 EXECSTACK_NO
1511 };
1512
032ce4e9
ST
1513 enum Icf_status
1514 {
1515 // Do not fold any functions (Default or --icf=none).
1516 ICF_NONE,
1517 // All functions are candidates for folding. (--icf=all).
1518 ICF_ALL,
1519 // Only ctors and dtors are candidates for folding. (--icf=safe).
1520 ICF_SAFE
1521 };
1522
1523 void
1524 set_icf_status(Icf_status value)
1525 { this->icf_status_ = value; }
1526
92e059d8 1527 void
ee1fe73e 1528 set_execstack_status(Execstack value)
086a1841
ILT
1529 { this->execstack_status_ = value; }
1530
1531 void
1532 set_do_demangle(bool value)
1533 { this->do_demangle_ = value; }
92e059d8 1534
bae7f79e 1535 void
45aa233b 1536 set_static(bool value)
ee1fe73e 1537 { static_ = value; }
652ec9bd 1538
ee1fe73e 1539 // These are called by finalize() to set up the search-path correctly.
35cdfc9a 1540 void
3f3cddf1 1541 add_to_library_path_with_sysroot(const std::string& arg)
ee1fe73e 1542 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
c7912668 1543
ad2d6943
ILT
1544 // Apply any sysroot to the directory lists.
1545 void
1546 add_sysroot();
086a1841 1547
89fc3421
CC
1548 // Add a plugin and its arguments to the list of plugins.
1549 void
ca09d69a 1550 add_plugin(const char* filename);
4674ecfc
CC
1551
1552 // Add a plugin option.
1553 void
1554 add_plugin_option(const char* opt);
89fc3421 1555
459c9f1c
ILT
1556 // Whether we printed version information.
1557 bool printed_version_;
086a1841
ILT
1558 // Whether to mark the stack as executable.
1559 Execstack execstack_status_;
032ce4e9
ST
1560 // Whether to do code folding.
1561 Icf_status icf_status_;
086a1841
ILT
1562 // Whether to do a static link.
1563 bool static_;
1564 // Whether to do demangling.
1565 bool do_demangle_;
89fc3421
CC
1566 // List of plugin libraries.
1567 Plugin_manager* plugins_;
c82fbeee
CS
1568 // The parsed output of --dynamic-list files. For convenience in
1569 // script.cc, we store this as a Script_options object, even though
1570 // we only use a single Version_tree from it.
1571 Script_options dynamic_list_;
8c21d9d3
CC
1572 // The incremental linking mode.
1573 Incremental_mode incremental_mode_;
266d0a74
ILT
1574 // The disposition given by the --incremental-changed,
1575 // --incremental-unchanged or --incremental-unknown option. The
1576 // value may change as we proceed parsing the command line flags.
1577 Incremental_disposition incremental_disposition_;
221597a5
CC
1578 // The disposition to use for startup files (those marked
1579 // INCREMENTAL_STARTUP).
1580 Incremental_disposition incremental_startup_disposition_;
459c9f1c 1581 // Whether we have seen one of the options that require incremental
221597a5
CC
1582 // build (--incremental-changed, --incremental-unchanged,
1583 // --incremental-unknown, or --incremental-startup-unchanged).
266d0a74 1584 bool implicit_incremental_;
8c604651 1585 // Libraries excluded from automatic export, via --exclude-libs.
65514900 1586 Unordered_set<std::string> excluded_libs_;
8c604651
CS
1587 // List of symbol-names to keep, via -retain-symbol-info.
1588 Unordered_set<std::string> symbols_to_retain_;
a192ba05
ILT
1589 // Map from section name to address from --section-start.
1590 std::map<std::string, uint64_t> section_starts_;
9b2fd367
DK
1591 // Whether to process armv4 bx instruction relocation.
1592 Fix_v4bx fix_v4bx_;
7296d933
DK
1593 // Endianness.
1594 Endianness endianness_;
bae7f79e
ILT
1595};
1596
ee1fe73e
ILT
1597// The position-dependent options. We use this to store the state of
1598// the commandline at a particular point in parsing for later
1599// reference. For instance, if we see "ld --whole-archive foo.a
1600// --no-whole-archive," we want to store the whole-archive option with
1601// foo.a, so when the time comes to parse foo.a we know we should do
1602// it in whole-archive mode. We could store all of General_options,
1603// but that's big, so we just pick the subset of flags that actually
1604// change in a position-dependent way.
1605
1606#define DEFINE_posdep(varname__, type__) \
1607 public: \
1608 type__ \
1609 varname__() const \
1610 { return this->varname__##_; } \
1611 \
1612 void \
1613 set_##varname__(type__ value) \
1614 { this->varname__##_ = value; } \
1615 private: \
1616 type__ varname__##_
bae7f79e
ILT
1617
1618class Position_dependent_options
1619{
1620 public:
ee1fe73e
ILT
1621 Position_dependent_options(const General_options& options
1622 = Position_dependent_options::default_options_)
1623 { copy_from_options(options); }
bae7f79e 1624
ee1fe73e
ILT
1625 void copy_from_options(const General_options& options)
1626 {
1627 this->set_as_needed(options.as_needed());
1628 this->set_Bdynamic(options.Bdynamic());
1629 this->set_format_enum(options.format_enum());
1630 this->set_whole_archive(options.whole_archive());
266d0a74 1631 this->set_incremental_disposition(options.incremental_disposition());
ee1fe73e 1632 }
bc644c6c 1633
ee1fe73e
ILT
1634 DEFINE_posdep(as_needed, bool);
1635 DEFINE_posdep(Bdynamic, bool);
1636 DEFINE_posdep(format_enum, General_options::Object_format);
1637 DEFINE_posdep(whole_archive, bool);
266d0a74 1638 DEFINE_posdep(incremental_disposition, Incremental_disposition);
7cc619c3 1639
dbe717ef 1640 private:
ee1fe73e
ILT
1641 // This is a General_options with everything set to its default
1642 // value. A Position_dependent_options created with no argument
1643 // will take its values from here.
1644 static General_options default_options_;
bae7f79e
ILT
1645};
1646
ee1fe73e 1647
bae7f79e
ILT
1648// A single file or library argument from the command line.
1649
ead1e424 1650class Input_file_argument
bae7f79e
ILT
1651{
1652 public:
ae3b5189
CD
1653 enum Input_file_type
1654 {
1655 // A regular file, name used as-is, not searched.
1656 INPUT_FILE_TYPE_FILE,
1657 // A library name. When used, "lib" will be prepended and ".so" or
1658 // ".a" appended to make a filename, and that filename will be searched
1659 // for using the -L paths.
1660 INPUT_FILE_TYPE_LIBRARY,
1661 // A regular file, name used as-is, but searched using the -L paths.
1662 INPUT_FILE_TYPE_SEARCHED_FILE
1663 };
1664
51dee2fe 1665 // name: file name or library name
ae3b5189 1666 // type: the type of this input file.
51dee2fe
ILT
1667 // extra_search_path: an extra directory to look for the file, prior
1668 // to checking the normal library search path. If this is "",
1669 // then no extra directory is added.
88dd47ac 1670 // just_symbols: whether this file only defines symbols.
51dee2fe 1671 // options: The position dependent options at this point in the
ad2d6943 1672 // command line, such as --whole-archive.
ead1e424 1673 Input_file_argument()
ae3b5189 1674 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
cdc29364 1675 just_symbols_(false), options_(), arg_serial_(0)
ead1e424
ILT
1676 { }
1677
2ea97941
ILT
1678 Input_file_argument(const char* name, Input_file_type type,
1679 const char* extra_search_path,
1680 bool just_symbols,
1681 const Position_dependent_options& options)
1682 : name_(name), type_(type), extra_search_path_(extra_search_path),
cdc29364 1683 just_symbols_(just_symbols), options_(options), arg_serial_(0)
ee1fe73e
ILT
1684 { }
1685
1686 // You can also pass in a General_options instance instead of a
1687 // Position_dependent_options. In that case, we extract the
1688 // position-independent vars from the General_options and only store
1689 // those.
2ea97941
ILT
1690 Input_file_argument(const char* name, Input_file_type type,
1691 const char* extra_search_path,
1692 bool just_symbols,
1693 const General_options& options)
1694 : name_(name), type_(type), extra_search_path_(extra_search_path),
cdc29364 1695 just_symbols_(just_symbols), options_(options), arg_serial_(0)
bae7f79e
ILT
1696 { }
1697
1698 const char*
1699 name() const
dbe717ef 1700 { return this->name_.c_str(); }
bae7f79e
ILT
1701
1702 const Position_dependent_options&
1703 options() const
1704 { return this->options_; }
1705
1706 bool
1707 is_lib() const
ae3b5189
CD
1708 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1709
1710 bool
1711 is_searched_file() const
1712 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
bae7f79e 1713
51dee2fe
ILT
1714 const char*
1715 extra_search_path() const
1716 {
1717 return (this->extra_search_path_.empty()
1718 ? NULL
ee1fe73e 1719 : this->extra_search_path_.c_str());
51dee2fe
ILT
1720 }
1721
88dd47ac
ILT
1722 // Return whether we should only read symbols from this file.
1723 bool
1724 just_symbols() const
1725 { return this->just_symbols_; }
1726
51dee2fe
ILT
1727 // Return whether this file may require a search using the -L
1728 // options.
1729 bool
1730 may_need_search() const
ae3b5189
CD
1731 {
1732 return (this->is_lib()
1733 || this->is_searched_file()
1734 || !this->extra_search_path_.empty());
1735 }
51dee2fe 1736
cdc29364
CC
1737 // Set the serial number for this argument.
1738 void
1739 set_arg_serial(unsigned int arg_serial)
1740 { this->arg_serial_ = arg_serial; }
1741
1742 // Get the serial number.
1743 unsigned int
1744 arg_serial() const
1745 { return this->arg_serial_; }
1746
bae7f79e 1747 private:
dbe717ef
ILT
1748 // We use std::string, not const char*, here for convenience when
1749 // using script files, so that we do not have to preserve the string
1750 // in that case.
1751 std::string name_;
ae3b5189 1752 Input_file_type type_;
51dee2fe 1753 std::string extra_search_path_;
88dd47ac 1754 bool just_symbols_;
bae7f79e 1755 Position_dependent_options options_;
cdc29364
CC
1756 // A unique index for this file argument in the argument list.
1757 unsigned int arg_serial_;
bae7f79e
ILT
1758};
1759
ead1e424
ILT
1760// A file or library, or a group, from the command line.
1761
1762class Input_argument
1763{
1764 public:
1765 // Create a file or library argument.
2ea97941 1766 explicit Input_argument(Input_file_argument file)
c7975edd 1767 : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
ead1e424
ILT
1768 { }
1769
1770 // Create a group argument.
2ea97941 1771 explicit Input_argument(Input_file_group* group)
c7975edd 1772 : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
b0193076
RÁE
1773 { }
1774
1775 // Create a lib argument.
1776 explicit Input_argument(Input_file_lib* lib)
c7975edd 1777 : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
ead1e424
ILT
1778 { }
1779
1780 // Return whether this is a file.
1781 bool
1782 is_file() const
1783 { return this->is_file_; }
1784
1785 // Return whether this is a group.
1786 bool
1787 is_group() const
b0193076
RÁE
1788 { return !this->is_file_ && this->lib_ == NULL; }
1789
1790 // Return whether this is a lib.
1791 bool
1792 is_lib() const
1793 { return this->lib_ != NULL; }
ead1e424
ILT
1794
1795 // Return the information about the file.
1796 const Input_file_argument&
1797 file() const
1798 {
a3ad94ed 1799 gold_assert(this->is_file_);
ead1e424
ILT
1800 return this->file_;
1801 }
1802
1803 // Return the information about the group.
1804 const Input_file_group*
1805 group() const
1806 {
a3ad94ed 1807 gold_assert(!this->is_file_);
ead1e424
ILT
1808 return this->group_;
1809 }
1810
1811 Input_file_group*
1812 group()
1813 {
a3ad94ed 1814 gold_assert(!this->is_file_);
ead1e424
ILT
1815 return this->group_;
1816 }
1817
b0193076
RÁE
1818 // Return the information about the lib.
1819 const Input_file_lib*
1820 lib() const
1821 {
1822 gold_assert(!this->is_file_);
1823 gold_assert(this->lib_);
1824 return this->lib_;
1825 }
1826
1827 Input_file_lib*
1828 lib()
1829 {
1830 gold_assert(!this->is_file_);
1831 gold_assert(this->lib_);
1832 return this->lib_;
1833 }
1834
c7975edd
CC
1835 // If a script generated this argument, store a pointer to the script info.
1836 // Currently used only for recording incremental link information.
1837 void
1838 set_script_info(Script_info* info)
1839 { this->script_info_ = info; }
1840
1841 Script_info*
1842 script_info() const
1843 { return this->script_info_; }
1844
ead1e424
ILT
1845 private:
1846 bool is_file_;
1847 Input_file_argument file_;
1848 Input_file_group* group_;
b0193076 1849 Input_file_lib* lib_;
c7975edd 1850 Script_info* script_info_;
ead1e424
ILT
1851};
1852
072fe7ce
ILT
1853typedef std::vector<Input_argument> Input_argument_list;
1854
ead1e424
ILT
1855// A group from the command line. This is a set of arguments within
1856// --start-group ... --end-group.
1857
1858class Input_file_group
92e059d8 1859{
ead1e424 1860 public:
072fe7ce 1861 typedef Input_argument_list::const_iterator const_iterator;
ead1e424
ILT
1862
1863 Input_file_group()
1864 : files_()
1865 { }
1866
1867 // Add a file to the end of the group.
c7975edd 1868 Input_argument&
ead1e424 1869 add_file(const Input_file_argument& arg)
c7975edd
CC
1870 {
1871 this->files_.push_back(Input_argument(arg));
1872 return this->files_.back();
1873 }
ead1e424
ILT
1874
1875 // Iterators to iterate over the group contents.
1876
1877 const_iterator
1878 begin() const
1879 { return this->files_.begin(); }
1880
1881 const_iterator
1882 end() const
1883 { return this->files_.end(); }
1884
1885 private:
072fe7ce 1886 Input_argument_list files_;
92e059d8
ILT
1887};
1888
b0193076
RÁE
1889// A lib from the command line. This is a set of arguments within
1890// --start-lib ... --end-lib.
1891
1892class Input_file_lib
1893{
1894 public:
1895 typedef Input_argument_list::const_iterator const_iterator;
1896
1897 Input_file_lib(const Position_dependent_options& options)
1898 : files_(), options_(options)
1899 { }
1900
1901 // Add a file to the end of the lib.
c7975edd 1902 Input_argument&
b0193076 1903 add_file(const Input_file_argument& arg)
c7975edd
CC
1904 {
1905 this->files_.push_back(Input_argument(arg));
1906 return this->files_.back();
1907 }
b0193076
RÁE
1908
1909 const Position_dependent_options&
1910 options() const
1911 { return this->options_; }
1912
1913 // Iterators to iterate over the lib contents.
1914
1915 const_iterator
1916 begin() const
1917 { return this->files_.begin(); }
1918
1919 const_iterator
1920 end() const
1921 { return this->files_.end(); }
1922
1923 size_t
1924 size() const
1925 { return this->files_.size(); }
1926
1927 private:
1928 Input_argument_list files_;
1929 Position_dependent_options options_;
1930};
1931
dbe717ef
ILT
1932// A list of files from the command line or a script.
1933
1934class Input_arguments
1935{
1936 public:
dbe717ef
ILT
1937 typedef Input_argument_list::const_iterator const_iterator;
1938
1939 Input_arguments()
cdc29364 1940 : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
dbe717ef
ILT
1941 { }
1942
1943 // Add a file.
c7975edd 1944 Input_argument&
cdc29364 1945 add_file(Input_file_argument& arg);
dbe717ef
ILT
1946
1947 // Start a group (the --start-group option).
1948 void
1949 start_group();
1950
1951 // End a group (the --end-group option).
1952 void
1953 end_group();
1954
b0193076
RÁE
1955 // Start a lib (the --start-lib option).
1956 void
1957 start_lib(const Position_dependent_options&);
1958
1959 // End a lib (the --end-lib option).
1960 void
1961 end_lib();
1962
dbe717ef
ILT
1963 // Return whether we are currently in a group.
1964 bool
1965 in_group() const
1966 { return this->in_group_; }
1967
b0193076
RÁE
1968 // Return whether we are currently in a lib.
1969 bool
1970 in_lib() const
1971 { return this->in_lib_; }
1972
fe9a4c12
ILT
1973 // The number of entries in the list.
1974 int
1975 size() const
1976 { return this->input_argument_list_.size(); }
1977
dbe717ef
ILT
1978 // Iterators to iterate over the list of input files.
1979
1980 const_iterator
1981 begin() const
1982 { return this->input_argument_list_.begin(); }
1983
1984 const_iterator
1985 end() const
1986 { return this->input_argument_list_.end(); }
1987
1988 // Return whether the list is empty.
1989 bool
1990 empty() const
1991 { return this->input_argument_list_.empty(); }
1992
cdc29364
CC
1993 // Return the number of input files. This may be larger than
1994 // input_argument_list_.size(), because of files that are part
1995 // of groups or libs.
1996 int
1997 number_of_input_files() const
1998 { return this->file_count_; }
1999
dbe717ef
ILT
2000 private:
2001 Input_argument_list input_argument_list_;
2002 bool in_group_;
b0193076 2003 bool in_lib_;
cdc29364 2004 unsigned int file_count_;
dbe717ef
ILT
2005};
2006
ee1fe73e
ILT
2007
2008// All the information read from the command line. These are held in
2009// three separate structs: one to hold the options (--foo), one to
2010// hold the filenames listed on the commandline, and one to hold
2011// linker script information. This third is not a subset of the other
2012// two because linker scripts can be specified either as options (via
2013// -T) or as a file.
bae7f79e
ILT
2014
2015class Command_line
2016{
2017 public:
ead1e424
ILT
2018 typedef Input_arguments::const_iterator const_iterator;
2019
a5dc0706 2020 Command_line();
bae7f79e
ILT
2021
2022 // Process the command line options. This will exit with an
2023 // appropriate error message if an unrecognized option is seen.
2024 void
ee1fe73e 2025 process(int argc, const char** argv);
bae7f79e 2026
a0451b38 2027 // Process one command-line option. This takes the index of argv to
ee1fe73e
ILT
2028 // process, and returns the index for the next option. no_more_options
2029 // is set to true if argv[i] is "--".
61ba1cf9 2030 int
ee1fe73e
ILT
2031 process_one_option(int argc, const char** argv, int i,
2032 bool* no_more_options);
3c2fafa5 2033
61ba1cf9 2034 // Get the general options.
bae7f79e
ILT
2035 const General_options&
2036 options() const
2037 { return this->options_; }
2038
3c2fafa5
ILT
2039 // Get the position dependent options.
2040 const Position_dependent_options&
2041 position_dependent_options() const
2042 { return this->position_options_; }
2043
a5dc0706
ILT
2044 // Get the linker-script options.
2045 Script_options&
e5756efb 2046 script_options()
a5dc0706 2047 { return this->script_options_; }
e5756efb 2048
6affe781 2049 // Finalize the version-script options and return them.
a5dc0706 2050 const Version_script_info&
6affe781 2051 version_script();
e5756efb 2052
ee1fe73e
ILT
2053 // Get the input files.
2054 Input_arguments&
2055 inputs()
2056 { return this->inputs_; }
2057
fe9a4c12
ILT
2058 // The number of input files.
2059 int
2060 number_of_input_files() const
cdc29364 2061 { return this->inputs_.number_of_input_files(); }
fe9a4c12 2062
ead1e424
ILT
2063 // Iterators to iterate over the list of input files.
2064
2065 const_iterator
2066 begin() const
2067 { return this->inputs_.begin(); }
2068
2069 const_iterator
2070 end() const
2071 { return this->inputs_.end(); }
bae7f79e
ILT
2072
2073 private:
ead1e424
ILT
2074 Command_line(const Command_line&);
2075 Command_line& operator=(const Command_line&);
2076
293c1386
CC
2077 // This is a dummy class to provide a constructor that runs before
2078 // the constructor for the General_options. The Pre_options constructor
2079 // is used as a hook to set the flag enabling the options to register
2080 // themselves.
2081 struct Pre_options {
2082 Pre_options();
2083 };
2084
2085 // This must come before options_!
2086 Pre_options pre_options_;
bae7f79e
ILT
2087 General_options options_;
2088 Position_dependent_options position_options_;
a5dc0706 2089 Script_options script_options_;
ead1e424 2090 Input_arguments inputs_;
bae7f79e
ILT
2091};
2092
2093} // End namespace gold.
2094
2095#endif // !defined(GOLD_OPTIONS_H)
This page took 0.408779 seconds and 4 git commands to generate.