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