1 // options.h -- handle command line options for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
6 // This file is part of gold.
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.
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.
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.
23 // General_options (from Command_line::options())
24 // All the options (a.k.a. command-line flags)
25 // Input_argument (from Command_line::inputs())
26 // The list of input files, including -l options.
28 // Everything we get from the command line -- the General_options
29 // plus the Input_arguments.
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).
36 #ifndef GOLD_OPTIONS_H
37 #define GOLD_OPTIONS_H
53 class General_options
;
54 class Search_directory
;
55 class Input_file_group
;
57 class Position_dependent_options
;
62 // Incremental build action for a specific file, as selected by the user.
64 enum Incremental_disposition
66 // Determine the status from the timestamp (default).
68 // Assume the file changed from the previous build.
70 // Assume the file didn't change from the previous build.
74 // The nested namespace is to contain all the global variables and
75 // structs that need to be defined in the .h file, but do not need to
76 // be used outside this class.
79 typedef std::vector
<Search_directory
> Dir_list
;
80 typedef Unordered_set
<std::string
> String_set
;
82 // These routines convert from a string option to various types.
83 // Each gives a fatal error if it cannot parse the argument.
86 parse_bool(const char* option_name
, const char* arg
, bool* retval
);
89 parse_int(const char* option_name
, const char* arg
, int* retval
);
92 parse_uint(const char* option_name
, const char* arg
, int* retval
);
95 parse_uint64(const char* option_name
, const char* arg
, uint64_t* retval
);
98 parse_double(const char* option_name
, const char* arg
, double* retval
);
101 parse_string(const char* option_name
, const char* arg
, const char** retval
);
104 parse_optional_string(const char* option_name
, const char* arg
,
105 const char** retval
);
108 parse_dirlist(const char* option_name
, const char* arg
, Dir_list
* retval
);
111 parse_set(const char* option_name
, const char* arg
, String_set
* retval
);
114 parse_choices(const char* option_name
, const char* arg
, const char** retval
,
115 const char* choices
[], int num_choices
);
119 // Most options have both a shortname (one letter) and a longname.
120 // This enum controls how many dashes are expected for longname access
121 // -- shortnames always use one dash. Most longnames will accept
122 // either one dash or two; the only difference between ONE_DASH and
123 // TWO_DASHES is how we print the option in --help. However, some
124 // longnames require two dashes, and some require only one. The
125 // special value DASH_Z means that the option is preceded by "-z".
128 ONE_DASH
, TWO_DASHES
, EXACTLY_ONE_DASH
, EXACTLY_TWO_DASHES
, DASH_Z
131 // LONGNAME is the long-name of the option with dashes converted to
132 // underscores, or else the short-name if the option has no long-name.
133 // It is never the empty string.
134 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
135 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
136 // option has no short-name. If the option has no long-name, you
137 // should specify the short-name in *both* VARNAME and here.
138 // DEFAULT_VALUE is the value of the option if not specified on the
139 // commandline, as a string.
140 // HELPSTRING is the descriptive text used with the option via --help
141 // HELPARG is how you define the argument to the option.
142 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
143 // HELPARG should be NULL iff the option is a bool and takes no arg.
144 // OPTIONAL_ARG is true if this option takes an optional argument. An
145 // optional argument must be specifid as --OPTION=VALUE, not
147 // READER provides parse_to_value, which is a function that will convert
148 // a char* argument into the proper type and store it in some variable.
149 // A One_option struct initializes itself with the global list of options
150 // at constructor time, so be careful making one of these.
153 std::string longname
;
156 const char* default_value
;
157 const char* helpstring
;
162 One_option(const char* ln
, Dashes d
, char sn
, const char* dv
,
163 const char* hs
, const char* ha
, bool oa
, Struct_var
* r
)
164 : longname(ln
), dashes(d
), shortname(sn
), default_value(dv
? dv
: ""),
165 helpstring(hs
), helparg(ha
), optional_arg(oa
), reader(r
)
167 // In longname, we convert all underscores to dashes, since GNU
168 // style uses dashes in option names. longname is likely to have
169 // underscores in it because it's also used to declare a C++
171 const char* pos
= strchr(this->longname
.c_str(), '_');
172 for (; pos
; pos
= strchr(pos
, '_'))
173 this->longname
[pos
- this->longname
.c_str()] = '-';
175 // We only register ourselves if our helpstring is not NULL. This
176 // is to support the "no-VAR" boolean variables, which we
177 // conditionally turn on by defining "no-VAR" help text.
178 if (this->helpstring
)
179 this->register_option();
182 // This option takes an argument iff helparg is not NULL.
184 takes_argument() const
185 { return this->helparg
!= NULL
; }
187 // Whether the argument is optional.
189 takes_optional_argument() const
190 { return this->optional_arg
; }
192 // Register this option with the global list of options.
196 // Print this option to stdout (used with --help).
201 // All options have a Struct_##varname that inherits from this and
202 // actually implements parse_to_value for that option.
205 // OPTION: the name of the option as specified on the commandline,
206 // including leading dashes, and any text following the option:
207 // "-O", "--defsym=mysym=0x1000", etc.
208 // ARG: the arg associated with this option, or NULL if the option
209 // takes no argument: "2", "mysym=0x1000", etc.
210 // CMDLINE: the global Command_line object. Used by DEFINE_special.
211 // OPTIONS: the global General_options object. Used by DEFINE_special.
213 parse_to_value(const char* option
, const char* arg
,
214 Command_line
* cmdline
, General_options
* options
) = 0;
216 ~Struct_var() // To make gcc happy.
220 // This is for "special" options that aren't of any predefined type.
221 struct Struct_special
: public Struct_var
223 // If you change this, change the parse-fn in DEFINE_special as well.
224 typedef void (General_options::*Parse_function
)(const char*, const char*,
226 Struct_special(const char* varname
, Dashes dashes
, char shortname
,
227 Parse_function parse_function
,
228 const char* helpstring
, const char* helparg
)
229 : option(varname
, dashes
, shortname
, "", helpstring
, helparg
, false, this),
230 parse(parse_function
)
233 void parse_to_value(const char* option
, const char* arg
,
234 Command_line
* cmdline
, General_options
* options
)
235 { (options
->*(this->parse
))(option
, arg
, cmdline
); }
238 Parse_function parse
;
241 } // End namespace options.
244 // These are helper macros use by DEFINE_uint64/etc below.
245 // This macro is used inside the General_options_ class, so defines
246 // var() and set_var() as General_options methods. Arguments as are
247 // for the constructor for One_option. param_type__ is the same as
248 // type__ for built-in types, and "const type__ &" otherwise.
250 // When we define the linker command option "assert", the macro argument
251 // varname__ of DEFINE_var below will be replaced by "assert". On Mac OSX
252 // assert.h is included implicitly by one of the library headers we use. To
253 // avoid unintended macro substitution of "assert()", we need to enclose
254 // varname__ with parenthese.
255 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
256 default_value_as_string__, helpstring__, helparg__, \
257 optional_arg__, type__, param_type__, parse_fn__) \
260 (varname__)() const \
261 { return this->varname__##_.value; } \
264 user_set_##varname__() const \
265 { return this->varname__##_.user_set_via_option; } \
268 set_user_set_##varname__() \
269 { this->varname__##_.user_set_via_option = true; } \
272 struct Struct_##varname__ : public options::Struct_var \
274 Struct_##varname__() \
275 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
276 helpstring__, helparg__, optional_arg__, this), \
277 user_set_via_option(false), value(default_value__) \
281 parse_to_value(const char* option_name, const char* arg, \
282 Command_line*, General_options*) \
284 parse_fn__(option_name, arg, &this->value); \
285 this->user_set_via_option = true; \
288 options::One_option option; \
289 bool user_set_via_option; \
292 Struct_##varname__ varname__##_; \
294 set_##varname__(param_type__ value) \
295 { this->varname__##_.value = value; }
297 // These macros allow for easy addition of a new commandline option.
299 // If no_helpstring__ is not NULL, then in addition to creating
300 // VARNAME, we also create an option called no-VARNAME (or, for a -z
301 // option, noVARNAME).
302 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
303 helpstring__, no_helpstring__) \
304 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
305 default_value__ ? "true" : "false", helpstring__, NULL, \
306 false, bool, bool, options::parse_bool) \
307 struct Struct_no_##varname__ : public options::Struct_var \
309 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
311 : "no-" #varname__), \
313 default_value__ ? "false" : "true", \
314 no_helpstring__, NULL, false, this) \
318 parse_to_value(const char*, const char*, \
319 Command_line*, General_options* options) \
321 options->set_##varname__(false); \
322 options->set_user_set_##varname__(); \
325 options::One_option option; \
327 Struct_no_##varname__ no_##varname__##_initializer_
329 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
330 helpstring__, no_helpstring__) \
331 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
332 default_value__ ? "true" : "false", helpstring__, NULL, \
333 false, bool, bool, options::parse_bool) \
334 struct Struct_disable_##varname__ : public options::Struct_var \
336 Struct_disable_##varname__() : option("disable-" #varname__, \
338 default_value__ ? "false" : "true", \
339 no_helpstring__, NULL, false, this) \
343 parse_to_value(const char*, const char*, \
344 Command_line*, General_options* options) \
345 { options->set_enable_##varname__(false); } \
347 options::One_option option; \
349 Struct_disable_##varname__ disable_##varname__##_initializer_
351 #define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
352 helpstring__, helparg__) \
353 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
354 #default_value__, helpstring__, helparg__, false, \
355 int, int, options::parse_int)
357 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
358 helpstring__, helparg__) \
359 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
360 #default_value__, helpstring__, helparg__, false, \
361 int, int, options::parse_uint)
363 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
364 helpstring__, helparg__) \
365 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
366 #default_value__, helpstring__, helparg__, false, \
367 uint64_t, uint64_t, options::parse_uint64)
369 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
370 helpstring__, helparg__) \
371 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
372 #default_value__, helpstring__, helparg__, false, \
373 double, double, options::parse_double)
375 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
376 helpstring__, helparg__) \
377 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
378 default_value__, helpstring__, helparg__, false, \
379 const char*, const char*, options::parse_string)
381 // This is like DEFINE_string, but we convert each occurrence to a
382 // Search_directory and store it in a vector. Thus we also have the
383 // add_to_VARNAME() method, to append to the vector.
384 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
385 helpstring__, helparg__) \
386 DEFINE_var(varname__, dashes__, shortname__, , \
387 "", helpstring__, helparg__, false, options::Dir_list, \
388 const options::Dir_list&, options::parse_dirlist) \
390 add_to_##varname__(const char* new_value) \
391 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
393 add_search_directory_to_##varname__(const Search_directory& dir) \
394 { this->varname__##_.value.push_back(dir); }
396 // This is like DEFINE_string, but we store a set of strings.
397 #define DEFINE_set(varname__, dashes__, shortname__, \
398 helpstring__, helparg__) \
399 DEFINE_var(varname__, dashes__, shortname__, , \
400 "", helpstring__, helparg__, false, options::String_set, \
401 const options::String_set&, options::parse_set) \
404 any_##varname__() const \
405 { return !this->varname__##_.value.empty(); } \
408 is_##varname__(const char* symbol) const \
410 return (!this->varname__##_.value.empty() \
411 && (this->varname__##_.value.find(std::string(symbol)) \
412 != this->varname__##_.value.end())); \
415 options::String_set::const_iterator \
416 varname__##_begin() const \
417 { return this->varname__##_.value.begin(); } \
419 options::String_set::const_iterator \
420 varname__##_end() const \
421 { return this->varname__##_.value.end(); }
423 // When you have a list of possible values (expressed as string)
424 // After helparg__ should come an initializer list, like
425 // {"foo", "bar", "baz"}
426 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
427 helpstring__, helparg__, ...) \
428 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
429 default_value__, helpstring__, helparg__, false, \
430 const char*, const char*, parse_choices_##varname__) \
432 static void parse_choices_##varname__(const char* option_name, \
434 const char** retval) { \
435 const char* choices[] = __VA_ARGS__; \
436 options::parse_choices(option_name, arg, retval, \
437 choices, sizeof(choices) / sizeof(*choices)); \
440 // This is like DEFINE_bool, but VARNAME is the name of a different
441 // option. This option becomes an alias for that one. INVERT is true
442 // if this option is an inversion of the other one.
443 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
444 helpstring__, no_helpstring__, invert__) \
446 struct Struct_##option__ : public options::Struct_var \
448 Struct_##option__() \
449 : option(#option__, dashes__, shortname__, "", helpstring__, \
454 parse_to_value(const char*, const char*, \
455 Command_line*, General_options* options) \
457 options->set_##varname__(!invert__); \
458 options->set_user_set_##varname__(); \
461 options::One_option option; \
463 Struct_##option__ option__##_; \
465 struct Struct_no_##option__ : public options::Struct_var \
467 Struct_no_##option__() \
468 : option((dashes__ == options::DASH_Z \
470 : "no-" #option__), \
471 dashes__, '\0', "", no_helpstring__, \
476 parse_to_value(const char*, const char*, \
477 Command_line*, General_options* options) \
479 options->set_##varname__(invert__); \
480 options->set_user_set_##varname__(); \
483 options::One_option option; \
485 Struct_no_##option__ no_##option__##_initializer_
487 // This is used for non-standard flags. It defines no functions; it
488 // just calls General_options::parse_VARNAME whenever the flag is
489 // seen. We declare parse_VARNAME as a static member of
490 // General_options; you are responsible for defining it there.
491 // helparg__ should be NULL iff this special-option is a boolean.
492 #define DEFINE_special(varname__, dashes__, shortname__, \
493 helpstring__, helparg__) \
495 void parse_##varname__(const char* option, const char* arg, \
496 Command_line* inputs); \
497 struct Struct_##varname__ : public options::Struct_special \
499 Struct_##varname__() \
500 : options::Struct_special(#varname__, dashes__, shortname__, \
501 &General_options::parse_##varname__, \
502 helpstring__, helparg__) \
505 Struct_##varname__ varname__##_initializer_
507 // An option that takes an optional string argument. If the option is
508 // used with no argument, the value will be the default, and
509 // user_set_via_option will be true.
510 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
512 helpstring__, helparg__) \
513 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
514 default_value__, helpstring__, helparg__, true, \
515 const char*, const char*, options::parse_optional_string)
517 // A directory to search. For each directory we record whether it is
518 // in the sysroot. We need to know this so that, if a linker script
519 // is found within the sysroot, we will apply the sysroot to any files
520 // named by that script.
522 class Search_directory
525 // We need a default constructor because we put this in a
528 : name_(NULL
), put_in_sysroot_(false), is_in_sysroot_(false)
531 // This is the usual constructor.
532 Search_directory(const char* name
, bool put_in_sysroot
)
533 : name_(name
), put_in_sysroot_(put_in_sysroot
), is_in_sysroot_(false)
535 if (this->name_
.empty())
539 // This is called if we have a sysroot. The sysroot is prefixed to
540 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
541 // set to true for any enries which are in the sysroot (this will
542 // naturally include any entries for which put_in_sysroot_ is true).
543 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
544 // passing SYSROOT to lrealpath.
546 add_sysroot(const char* sysroot
, const char* canonical_sysroot
);
548 // Get the directory name.
551 { return this->name_
; }
553 // Return whether this directory is in the sysroot.
555 is_in_sysroot() const
556 { return this->is_in_sysroot_
; }
558 // Return whether this is considered a system directory.
560 is_system_directory() const
561 { return this->put_in_sysroot_
|| this->is_in_sysroot_
; }
564 // The directory name.
566 // True if the sysroot should be added as a prefix for this
567 // directory (if there is a sysroot). This is true for system
568 // directories that we search by default.
569 bool put_in_sysroot_
;
570 // True if this directory is in the sysroot (if there is a sysroot).
571 // This is true if there is a sysroot and either 1) put_in_sysroot_
572 // is true, or 2) the directory happens to be in the sysroot based
573 // on a pathname comparison.
577 class General_options
580 // NOTE: For every option that you add here, also consider if you
581 // should add it to Position_dependent_options.
582 DEFINE_special(help
, options::TWO_DASHES
, '\0',
583 N_("Report usage information"), NULL
);
584 DEFINE_special(version
, options::TWO_DASHES
, 'v',
585 N_("Report version information"), NULL
);
586 DEFINE_special(V
, options::EXACTLY_ONE_DASH
, '\0',
587 N_("Report version and target information"), NULL
);
589 // These options are sorted approximately so that for each letter in
590 // the alphabet, we show the option whose shortname is that letter
591 // (if any) and then every longname that starts with that letter (in
592 // alphabetical order). For both, lowercase sorts before uppercase.
593 // The -z options come last.
595 DEFINE_bool(add_needed
, options::TWO_DASHES
, '\0', false,
597 N_("Do not copy DT_NEEDED tags from shared libraries"));
599 DEFINE_bool_alias(allow_multiple_definition
, muldefs
, options::TWO_DASHES
,
600 '\0', N_("Allow multiple definitions of symbols"),
601 N_("Do not allow multiple definitions"), false);
603 DEFINE_bool(allow_shlib_undefined
, options::TWO_DASHES
, '\0', false,
604 N_("Allow unresolved references in shared libraries"),
605 N_("Do not allow unresolved references in shared libraries"));
607 DEFINE_bool(as_needed
, options::TWO_DASHES
, '\0', false,
608 N_("Only set DT_NEEDED for shared libraries if used"),
609 N_("Always DT_NEEDED for shared libraries"));
611 DEFINE_enum(assert, options::ONE_DASH
, '\0', NULL
,
612 N_("Ignored"), N_("[ignored]"),
613 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
615 // This should really be an "enum", but it's too easy for folks to
616 // forget to update the list as they add new targets. So we just
617 // accept any string. We'll fail later (when the string is parsed),
618 // if the target isn't actually supported.
619 DEFINE_string(format
, options::TWO_DASHES
, 'b', "elf",
620 N_("Set input format"), ("[elf,binary]"));
622 DEFINE_bool(Bdynamic
, options::ONE_DASH
, '\0', true,
623 N_("-l searches for shared libraries"), NULL
);
624 DEFINE_bool_alias(Bstatic
, Bdynamic
, options::ONE_DASH
, '\0',
625 N_("-l does not search for shared libraries"), NULL
,
627 DEFINE_bool_alias(dy
, Bdynamic
, options::ONE_DASH
, '\0',
628 N_("alias for -Bdynamic"), NULL
, false);
629 DEFINE_bool_alias(dn
, Bdynamic
, options::ONE_DASH
, '\0',
630 N_("alias for -Bstatic"), NULL
, true);
632 DEFINE_bool(Bsymbolic
, options::ONE_DASH
, '\0', false,
633 N_("Bind defined symbols locally"), NULL
);
635 DEFINE_bool(Bsymbolic_functions
, options::ONE_DASH
, '\0', false,
636 N_("Bind defined function symbols locally"), NULL
);
638 DEFINE_optional_string(build_id
, options::TWO_DASHES
, '\0', "sha1",
639 N_("Generate build ID note"),
642 DEFINE_bool(check_sections
, options::TWO_DASHES
, '\0', true,
643 N_("Check segment addresses for overlaps (default)"),
644 N_("Do not check segment addresses for overlaps"));
647 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
648 N_("Compress .debug_* sections in the output file"),
652 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
653 N_("Compress .debug_* sections in the output file"),
658 DEFINE_bool(copy_dt_needed_entries
, options::TWO_DASHES
, '\0', false,
660 N_("Do not copy DT_NEEDED tags from shared libraries"));
662 DEFINE_bool(cref
, options::TWO_DASHES
, '\0', false,
663 N_("Output cross reference table"),
664 N_("Do not output cross reference table"));
666 DEFINE_bool(ctors_in_init_array
, options::TWO_DASHES
, '\0', true,
667 N_("Use DT_INIT_ARRAY for all constructors (default)"),
668 N_("Handle constructors as directed by compiler"));
670 DEFINE_bool(define_common
, options::TWO_DASHES
, 'd', false,
671 N_("Define common symbols"),
672 N_("Do not define common symbols"));
673 DEFINE_bool(dc
, options::ONE_DASH
, '\0', false,
674 N_("Alias for -d"), NULL
);
675 DEFINE_bool(dp
, options::ONE_DASH
, '\0', false,
676 N_("Alias for -d"), NULL
);
678 DEFINE_string(debug
, options::TWO_DASHES
, '\0', "",
679 N_("Turn on debugging"),
680 N_("[all,files,script,task][,...]"));
682 DEFINE_special(defsym
, options::TWO_DASHES
, '\0',
683 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
685 DEFINE_optional_string(demangle
, options::TWO_DASHES
, '\0', NULL
,
686 N_("Demangle C++ symbols in log messages"),
689 DEFINE_bool(no_demangle
, options::TWO_DASHES
, '\0', false,
690 N_("Do not demangle C++ symbols in log messages"),
693 DEFINE_bool(detect_odr_violations
, options::TWO_DASHES
, '\0', false,
694 N_("Look for violations of the C++ One Definition Rule"),
695 N_("Do not look for violations of the C++ One Definition Rule"));
697 DEFINE_bool(discard_all
, options::TWO_DASHES
, 'x', false,
698 N_("Delete all local symbols"), NULL
);
699 DEFINE_bool(discard_locals
, options::TWO_DASHES
, 'X', false,
700 N_("Delete all temporary local symbols"), NULL
);
702 DEFINE_bool(dynamic_list_data
, options::TWO_DASHES
, '\0', false,
703 N_("Add data symbols to dynamic symbols"), NULL
);
705 DEFINE_bool(dynamic_list_cpp_new
, options::TWO_DASHES
, '\0', false,
706 N_("Add C++ operator new/delete to dynamic symbols"), NULL
);
708 DEFINE_bool(dynamic_list_cpp_typeinfo
, options::TWO_DASHES
, '\0', false,
709 N_("Add C++ typeinfo to dynamic symbols"), NULL
);
711 DEFINE_special(dynamic_list
, options::TWO_DASHES
, '\0',
712 N_("Read a list of dynamic symbols"), N_("FILE"));
714 DEFINE_string(entry
, options::TWO_DASHES
, 'e', NULL
,
715 N_("Set program start address"), N_("ADDRESS"));
717 DEFINE_special(exclude_libs
, options::TWO_DASHES
, '\0',
718 N_("Exclude libraries from automatic export"),
719 N_(("lib,lib ...")));
721 DEFINE_bool(export_dynamic
, options::TWO_DASHES
, 'E', false,
722 N_("Export all dynamic symbols"),
723 N_("Do not export all dynamic symbols (default)"));
725 DEFINE_special(EB
, options::ONE_DASH
, '\0',
726 N_("Link big-endian objects."), NULL
);
728 DEFINE_bool(eh_frame_hdr
, options::TWO_DASHES
, '\0', false,
729 N_("Create exception frame header"), NULL
);
731 DEFINE_special(EL
, options::ONE_DASH
, '\0',
732 N_("Link little-endian objects."), NULL
);
734 DEFINE_bool(enum_size_warning
, options::TWO_DASHES
, '\0', true, NULL
,
735 N_("(ARM only) Do not warn about objects with incompatible "
738 DEFINE_set(auxiliary
, options::TWO_DASHES
, 'f',
739 N_("Auxiliary filter for shared object symbol table"),
742 DEFINE_string(filter
, options::TWO_DASHES
, 'F', NULL
,
743 N_("Filter for shared object symbol table"),
746 DEFINE_bool(fatal_warnings
, options::TWO_DASHES
, '\0', false,
747 N_("Treat warnings as errors"),
748 N_("Do not treat warnings as errors"));
750 DEFINE_string(fini
, options::ONE_DASH
, '\0', "_fini",
751 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
753 DEFINE_bool(fix_cortex_a8
, options::TWO_DASHES
, '\0', false,
754 N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
755 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
757 DEFINE_bool(merge_exidx_entries
, options::TWO_DASHES
, '\0', true,
758 N_("(ARM only) Merge exidx entries in debuginfo."),
759 N_("(ARM only) Do not merge exidx entries in debuginfo."));
761 DEFINE_special(fix_v4bx
, options::TWO_DASHES
, '\0',
762 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
765 DEFINE_special(fix_v4bx_interworking
, options::TWO_DASHES
, '\0',
766 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
770 DEFINE_bool(g
, options::EXACTLY_ONE_DASH
, '\0', false,
771 N_("Ignored"), NULL
);
773 DEFINE_string(soname
, options::ONE_DASH
, 'h', NULL
,
774 N_("Set shared library name"), N_("FILENAME"));
776 DEFINE_double(hash_bucket_empty_fraction
, options::TWO_DASHES
, '\0', 0.0,
777 N_("Min fraction of empty buckets in dynamic hash"),
780 DEFINE_enum(hash_style
, options::TWO_DASHES
, '\0', "sysv",
781 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
782 {"sysv", "gnu", "both"});
784 DEFINE_string(dynamic_linker
, options::TWO_DASHES
, 'I', NULL
,
785 N_("Set dynamic linker path"), N_("PROGRAM"));
787 DEFINE_special(incremental
, options::TWO_DASHES
, '\0',
788 N_("Do an incremental link if possible; "
789 "otherwise, do a full link and prepare output "
790 "for incremental linking"), NULL
);
792 DEFINE_special(no_incremental
, options::TWO_DASHES
, '\0',
793 N_("Do a full link (default)"), NULL
);
795 DEFINE_special(incremental_full
, options::TWO_DASHES
, '\0',
796 N_("Do a full link and "
797 "prepare output for incremental linking"), NULL
);
799 DEFINE_special(incremental_update
, options::TWO_DASHES
, '\0',
800 N_("Do an incremental link; exit if not possible"), NULL
);
802 DEFINE_string(incremental_base
, options::TWO_DASHES
, '\0', NULL
,
803 N_("Set base file for incremental linking"
804 " (default is output file)"),
807 DEFINE_special(incremental_changed
, options::TWO_DASHES
, '\0',
808 N_("Assume files changed"), NULL
);
810 DEFINE_special(incremental_unchanged
, options::TWO_DASHES
, '\0',
811 N_("Assume files didn't change"), NULL
);
813 DEFINE_special(incremental_unknown
, options::TWO_DASHES
, '\0',
814 N_("Use timestamps to check files (default)"), NULL
);
816 DEFINE_string(init
, options::ONE_DASH
, '\0', "_init",
817 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
819 DEFINE_special(just_symbols
, options::TWO_DASHES
, '\0',
820 N_("Read only symbol values from FILE"), N_("FILE"));
822 DEFINE_bool(map_whole_files
, options::TWO_DASHES
, '\0',
824 N_("Map whole files to memory (default on 64-bit hosts)"),
825 N_("Map relevant file parts to memory (default on 32-bit "
827 DEFINE_bool(keep_files_mapped
, options::TWO_DASHES
, '\0', true,
828 N_("Keep files mapped across passes (default)"),
829 N_("Release mapped files after each pass"));
831 DEFINE_bool(ld_generated_unwind_info
, options::TWO_DASHES
, '\0', true,
832 N_("Generate unwind information for PLT (default)"),
833 N_("Do not generate unwind information for PLT"));
835 DEFINE_special(library
, options::TWO_DASHES
, 'l',
836 N_("Search for library LIBNAME"), N_("LIBNAME"));
838 DEFINE_dirlist(library_path
, options::TWO_DASHES
, 'L',
839 N_("Add directory to search path"), N_("DIR"));
841 DEFINE_bool(nostdlib
, options::ONE_DASH
, '\0', false,
842 N_(" Only search directories specified on the command line."),
845 DEFINE_bool(rosegment
, options::TWO_DASHES
, '\0', false,
846 N_(" Put read-only non-executable sections in their own segment"),
849 DEFINE_string(m
, options::EXACTLY_ONE_DASH
, 'm', "",
850 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
852 DEFINE_bool(print_map
, options::TWO_DASHES
, 'M', false,
853 N_("Write map file on standard output"), NULL
);
854 DEFINE_string(Map
, options::ONE_DASH
, '\0', NULL
, N_("Write map file"),
857 DEFINE_bool(nmagic
, options::TWO_DASHES
, 'n', false,
858 N_("Do not page align data"), NULL
);
859 DEFINE_bool(omagic
, options::EXACTLY_TWO_DASHES
, 'N', false,
860 N_("Do not page align data, do not make text readonly"),
861 N_("Page align data, make text readonly"));
863 DEFINE_enable(new_dtags
, options::EXACTLY_TWO_DASHES
, '\0', false,
864 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
865 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
867 DEFINE_bool(noinhibit_exec
, options::TWO_DASHES
, '\0', false,
868 N_("Create an output file even if errors occur"), NULL
);
870 DEFINE_bool_alias(no_undefined
, defs
, options::TWO_DASHES
, '\0',
871 N_("Report undefined symbols (even with --shared)"),
874 DEFINE_string(output
, options::TWO_DASHES
, 'o', "a.out",
875 N_("Set output file name"), N_("FILE"));
877 DEFINE_uint(optimize
, options::EXACTLY_ONE_DASH
, 'O', 0,
878 N_("Optimize output file size"), N_("LEVEL"));
880 DEFINE_string(oformat
, options::EXACTLY_TWO_DASHES
, '\0', "elf",
881 N_("Set output format"), N_("[binary]"));
883 DEFINE_bool(p
, options::ONE_DASH
, '\0', false,
884 N_("(ARM only) Ignore for backward compatibility"), NULL
);
886 DEFINE_bool(pie
, options::ONE_DASH
, '\0', false,
887 N_("Create a position independent executable"), NULL
);
888 DEFINE_bool_alias(pic_executable
, pie
, options::TWO_DASHES
, '\0',
889 N_("Create a position independent executable"), NULL
,
892 DEFINE_bool(pipeline_knowledge
, options::ONE_DASH
, '\0', false,
893 NULL
, N_("(ARM only) Ignore for backward compatibility"));
895 #ifdef ENABLE_PLUGINS
896 DEFINE_special(plugin
, options::TWO_DASHES
, '\0',
897 N_("Load a plugin library"), N_("PLUGIN"));
898 DEFINE_special(plugin_opt
, options::TWO_DASHES
, '\0',
899 N_("Pass an option to the plugin"), N_("OPTION"));
902 DEFINE_bool(preread_archive_symbols
, options::TWO_DASHES
, '\0', false,
903 N_("Preread archive symbols when multi-threaded"), NULL
);
905 DEFINE_string(print_symbol_counts
, options::TWO_DASHES
, '\0', NULL
,
906 N_("Print symbols defined and used for each input"),
909 DEFINE_bool(Qy
, options::EXACTLY_ONE_DASH
, '\0', false,
910 N_("Ignored for SVR4 compatibility"), NULL
);
912 DEFINE_bool(emit_relocs
, options::TWO_DASHES
, 'q', false,
913 N_("Generate relocations in output"), NULL
);
915 DEFINE_bool(relocatable
, options::EXACTLY_ONE_DASH
, 'r', false,
916 N_("Generate relocatable output"), NULL
);
917 DEFINE_bool_alias(i
, relocatable
, options::EXACTLY_ONE_DASH
, '\0',
918 N_("Synonym for -r"), NULL
, false);
920 DEFINE_bool(relax
, options::TWO_DASHES
, '\0', false,
921 N_("Relax branches on certain targets"), NULL
);
923 DEFINE_string(retain_symbols_file
, options::TWO_DASHES
, '\0', NULL
,
924 N_("keep only symbols listed in this file"), N_("FILE"));
926 // -R really means -rpath, but can mean --just-symbols for
927 // compatibility with GNU ld. -rpath is always -rpath, so we list
929 DEFINE_special(R
, options::EXACTLY_ONE_DASH
, 'R',
930 N_("Add DIR to runtime search path"), N_("DIR"));
932 DEFINE_dirlist(rpath
, options::ONE_DASH
, '\0',
933 N_("Add DIR to runtime search path"), N_("DIR"));
935 DEFINE_dirlist(rpath_link
, options::TWO_DASHES
, '\0',
936 N_("Add DIR to link time shared library search path"),
939 DEFINE_string(section_ordering_file
, options::TWO_DASHES
, '\0', NULL
,
940 N_("Layout sections in the order specified."),
943 DEFINE_special(section_start
, options::TWO_DASHES
, '\0',
944 N_("Set address of section"), N_("SECTION=ADDRESS"));
946 DEFINE_optional_string(sort_common
, options::TWO_DASHES
, '\0', NULL
,
947 N_("Sort common symbols by alignment"),
948 N_("[={ascending,descending}]"));
950 DEFINE_uint(spare_dynamic_tags
, options::TWO_DASHES
, '\0', 5,
951 N_("Dynamic tag slots to reserve (default 5)"),
954 DEFINE_bool(strip_all
, options::TWO_DASHES
, 's', false,
955 N_("Strip all symbols"), NULL
);
956 DEFINE_bool(strip_debug
, options::TWO_DASHES
, 'S', false,
957 N_("Strip debugging information"), NULL
);
958 DEFINE_bool(strip_debug_non_line
, options::TWO_DASHES
, '\0', false,
959 N_("Emit only debug line number information"), NULL
);
960 DEFINE_bool(strip_debug_gdb
, options::TWO_DASHES
, '\0', false,
961 N_("Strip debug symbols that are unused by gdb "
962 "(at least versions <= 6.7)"), NULL
);
963 DEFINE_bool(strip_lto_sections
, options::TWO_DASHES
, '\0', true,
964 N_("Strip LTO intermediate code sections"), NULL
);
966 DEFINE_int(stub_group_size
, options::TWO_DASHES
, '\0', 1,
967 N_("(ARM only) The maximum distance from instructions in a group "
968 "of sections to their stubs. Negative values mean stubs "
969 "are always after the group. 1 means using default size.\n"),
972 DEFINE_bool(no_keep_memory
, options::TWO_DASHES
, '\0', false,
973 N_("Use less memory and more disk I/O "
974 "(included only for compatibility with GNU ld)"), NULL
);
976 DEFINE_bool(shared
, options::ONE_DASH
, 'G', false,
977 N_("Generate shared library"), NULL
);
979 DEFINE_bool(Bshareable
, options::ONE_DASH
, '\0', false,
980 N_("Generate shared library"), NULL
);
982 DEFINE_uint(split_stack_adjust_size
, options::TWO_DASHES
, '\0', 0x4000,
983 N_("Stack size when -fsplit-stack function calls non-split"),
986 // This is not actually special in any way, but I need to give it
987 // a non-standard accessor-function name because 'static' is a keyword.
988 DEFINE_special(static, options::ONE_DASH
, '\0',
989 N_("Do not link against shared libraries"), NULL
);
991 DEFINE_enum(icf
, options::TWO_DASHES
, '\0', "none",
992 N_("Identical Code Folding. "
993 "\'--icf=safe\' Folds ctors, dtors and functions whose"
994 " pointers are definitely not taken."),
996 {"none", "all", "safe"});
998 DEFINE_uint(icf_iterations
, options::TWO_DASHES
, '\0', 0,
999 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
1001 DEFINE_bool(print_icf_sections
, options::TWO_DASHES
, '\0', false,
1002 N_("List folded identical sections on stderr"),
1003 N_("Do not list folded identical sections"));
1005 DEFINE_set(keep_unique
, options::TWO_DASHES
, '\0',
1006 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1008 DEFINE_bool(gc_sections
, options::TWO_DASHES
, '\0', false,
1009 N_("Remove unused sections"),
1010 N_("Don't remove unused sections (default)"));
1012 DEFINE_bool(print_gc_sections
, options::TWO_DASHES
, '\0', false,
1013 N_("List removed unused sections on stderr"),
1014 N_("Do not list removed unused sections"));
1016 DEFINE_bool(stats
, options::TWO_DASHES
, '\0', false,
1017 N_("Print resource usage statistics"), NULL
);
1019 DEFINE_string(sysroot
, options::TWO_DASHES
, '\0', "",
1020 N_("Set target system root directory"), N_("DIR"));
1022 DEFINE_bool(trace
, options::TWO_DASHES
, 't', false,
1023 N_("Print the name of each input file"), NULL
);
1025 DEFINE_special(script
, options::TWO_DASHES
, 'T',
1026 N_("Read linker script"), N_("FILE"));
1028 DEFINE_bool(threads
, options::TWO_DASHES
, '\0', false,
1029 N_("Run the linker multi-threaded"),
1030 N_("Do not run the linker multi-threaded"));
1031 DEFINE_uint(thread_count
, options::TWO_DASHES
, '\0', 0,
1032 N_("Number of threads to use"), N_("COUNT"));
1033 DEFINE_uint(thread_count_initial
, options::TWO_DASHES
, '\0', 0,
1034 N_("Number of threads to use in initial pass"), N_("COUNT"));
1035 DEFINE_uint(thread_count_middle
, options::TWO_DASHES
, '\0', 0,
1036 N_("Number of threads to use in middle pass"), N_("COUNT"));
1037 DEFINE_uint(thread_count_final
, options::TWO_DASHES
, '\0', 0,
1038 N_("Number of threads to use in final pass"), N_("COUNT"));
1040 DEFINE_uint64(Tbss
, options::ONE_DASH
, '\0', -1U,
1041 N_("Set the address of the bss segment"), N_("ADDRESS"));
1042 DEFINE_uint64(Tdata
, options::ONE_DASH
, '\0', -1U,
1043 N_("Set the address of the data segment"), N_("ADDRESS"));
1044 DEFINE_uint64(Ttext
, options::ONE_DASH
, '\0', -1U,
1045 N_("Set the address of the text segment"), N_("ADDRESS"));
1047 DEFINE_set(undefined
, options::TWO_DASHES
, 'u',
1048 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1050 DEFINE_bool(verbose
, options::TWO_DASHES
, '\0', false,
1051 N_("Synonym for --debug=files"), NULL
);
1053 DEFINE_special(version_script
, options::TWO_DASHES
, '\0',
1054 N_("Read version script"), N_("FILE"));
1056 DEFINE_bool(warn_common
, options::TWO_DASHES
, '\0', false,
1057 N_("Warn about duplicate common symbols"),
1058 N_("Do not warn about duplicate common symbols (default)"));
1060 DEFINE_bool(warn_constructors
, options::TWO_DASHES
, '\0', false,
1061 N_("Ignored"), N_("Ignored"));
1063 DEFINE_bool(warn_execstack
, options::TWO_DASHES
, '\0', false,
1064 N_("Warn if the stack is executable"),
1065 N_("Do not warn if the stack is executable (default)"));
1067 DEFINE_bool(warn_mismatch
, options::TWO_DASHES
, '\0', true,
1068 NULL
, N_("Don't warn about mismatched input files"));
1070 DEFINE_bool(warn_multiple_gp
, options::TWO_DASHES
, '\0', false,
1071 N_("Ignored"), NULL
);
1073 DEFINE_bool(warn_search_mismatch
, options::TWO_DASHES
, '\0', true,
1074 N_("Warn when skipping an incompatible library"),
1075 N_("Don't warn when skipping an incompatible library"));
1077 DEFINE_bool(warn_shared_textrel
, options::TWO_DASHES
, '\0', false,
1078 N_("Warn if text segment is not shareable"),
1079 N_("Do not warn if text segment is not shareable (default)"));
1081 DEFINE_bool(warn_unresolved_symbols
, options::TWO_DASHES
, '\0', false,
1082 N_("Report unresolved symbols as warnings"),
1084 DEFINE_bool_alias(error_unresolved_symbols
, warn_unresolved_symbols
,
1085 options::TWO_DASHES
, '\0',
1086 N_("Report unresolved symbols as errors"),
1089 DEFINE_bool(wchar_size_warning
, options::TWO_DASHES
, '\0', true, NULL
,
1090 N_("(ARM only) Do not warn about objects with incompatible "
1093 DEFINE_bool(whole_archive
, options::TWO_DASHES
, '\0', false,
1094 N_("Include all archive contents"),
1095 N_("Include only needed archive contents"));
1097 DEFINE_set(wrap
, options::TWO_DASHES
, '\0',
1098 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1100 DEFINE_set(trace_symbol
, options::TWO_DASHES
, 'y',
1101 N_("Trace references to symbol"), N_("SYMBOL"));
1103 DEFINE_bool(undefined_version
, options::TWO_DASHES
, '\0', true,
1104 N_("Allow unused version in script (default)"),
1105 N_("Do not allow unused version in script"));
1107 DEFINE_string(Y
, options::EXACTLY_ONE_DASH
, 'Y', "",
1108 N_("Default search path for Solaris compatibility"),
1111 DEFINE_special(start_group
, options::TWO_DASHES
, '(',
1112 N_("Start a library search group"), NULL
);
1113 DEFINE_special(end_group
, options::TWO_DASHES
, ')',
1114 N_("End a library search group"), NULL
);
1117 DEFINE_special(start_lib
, options::TWO_DASHES
, '\0',
1118 N_("Start a library"), NULL
);
1119 DEFINE_special(end_lib
, options::TWO_DASHES
, '\0',
1120 N_("End a library "), NULL
);
1124 DEFINE_bool(combreloc
, options::DASH_Z
, '\0', true,
1125 N_("Sort dynamic relocs"),
1126 N_("Do not sort dynamic relocs"));
1127 DEFINE_uint64(common_page_size
, options::DASH_Z
, '\0', 0,
1128 N_("Set common page size to SIZE"), N_("SIZE"));
1129 DEFINE_bool(defs
, options::DASH_Z
, '\0', false,
1130 N_("Report undefined symbols (even with --shared)"),
1132 DEFINE_bool(execstack
, options::DASH_Z
, '\0', false,
1133 N_("Mark output as requiring executable stack"), NULL
);
1134 DEFINE_bool(initfirst
, options::DASH_Z
, '\0', false,
1135 N_("Mark DSO to be initialized first at runtime"),
1137 DEFINE_bool(interpose
, options::DASH_Z
, '\0', false,
1138 N_("Mark object to interpose all DSOs but executable"),
1140 DEFINE_bool_alias(lazy
, now
, options::DASH_Z
, '\0',
1141 N_("Mark object for lazy runtime binding (default)"),
1143 DEFINE_bool(loadfltr
, options::DASH_Z
, '\0', false,
1144 N_("Mark object requiring immediate process"),
1146 DEFINE_uint64(max_page_size
, options::DASH_Z
, '\0', 0,
1147 N_("Set maximum page size to SIZE"), N_("SIZE"));
1148 DEFINE_bool(muldefs
, options::DASH_Z
, '\0', false,
1149 N_("Allow multiple definitions of symbols"),
1151 // copyreloc is here in the list because there is only -z
1152 // nocopyreloc, not -z copyreloc.
1153 DEFINE_bool(copyreloc
, options::DASH_Z
, '\0', true,
1155 N_("Do not create copy relocs"));
1156 DEFINE_bool(nodefaultlib
, options::DASH_Z
, '\0', false,
1157 N_("Mark object not to use default search paths"),
1159 DEFINE_bool(nodelete
, options::DASH_Z
, '\0', false,
1160 N_("Mark DSO non-deletable at runtime"),
1162 DEFINE_bool(nodlopen
, options::DASH_Z
, '\0', false,
1163 N_("Mark DSO not available to dlopen"),
1165 DEFINE_bool(nodump
, options::DASH_Z
, '\0', false,
1166 N_("Mark DSO not available to dldump"),
1168 DEFINE_bool(noexecstack
, options::DASH_Z
, '\0', false,
1169 N_("Mark output as not requiring executable stack"), NULL
);
1170 DEFINE_bool(now
, options::DASH_Z
, '\0', false,
1171 N_("Mark object for immediate function binding"),
1173 DEFINE_bool(origin
, options::DASH_Z
, '\0', false,
1174 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1175 "processing at runtime"), NULL
);
1176 DEFINE_bool(relro
, options::DASH_Z
, '\0', false,
1177 N_("Where possible mark variables read-only after relocation"),
1178 N_("Don't mark variables read-only after relocation"));
1179 DEFINE_bool(text
, options::DASH_Z
, '\0', false,
1180 N_("Do not permit relocations in read-only segments"),
1181 N_("Permit relocations in read-only segments (default)"));
1182 DEFINE_bool_alias(textoff
, text
, options::DASH_Z
, '\0',
1183 N_("Permit relocations in read-only segments (default)"),
1187 typedef options::Dir_list Dir_list
;
1191 // Does post-processing on flags, making sure they all have
1192 // non-conflicting values. Also converts some flags from their
1193 // "standard" types (string, etc), to another type (enum, DirList),
1194 // which can be accessed via a separate method. Dies if it notices
1198 // True if we printed the version information.
1200 printed_version() const
1201 { return this->printed_version_
; }
1203 // The macro defines output() (based on --output), but that's a
1204 // generic name. Provide this alternative name, which is clearer.
1206 output_file_name() const
1207 { return this->output(); }
1209 // This is not defined via a flag, but combines flags to say whether
1210 // the output is position-independent or not.
1212 output_is_position_independent() const
1213 { return this->shared() || this->pie(); }
1215 // Return true if the output is something that can be exec()ed, such
1216 // as a static executable, or a position-dependent or
1217 // position-independent executable, but not a dynamic library or an
1220 output_is_executable() const
1221 { return !this->shared() && !this->relocatable(); }
1223 // This would normally be static(), and defined automatically, but
1224 // since static is a keyword, we need to come up with our own name.
1229 // In addition to getting the input and output formats as a string
1230 // (via format() and oformat()), we also give access as an enum.
1235 // Straight binary format.
1236 OBJECT_FORMAT_BINARY
1239 // Convert a string to an Object_format. Gives an error if the
1240 // string is not recognized.
1241 static Object_format
1242 string_to_object_format(const char* arg
);
1244 // Note: these functions are not very fast.
1245 Object_format
format_enum() const;
1246 Object_format
oformat_enum() const;
1248 // Return whether FILENAME is in a system directory.
1250 is_in_system_directory(const std::string
& name
) const;
1252 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1254 should_retain_symbol(const char* symbol_name
) const
1256 if (symbols_to_retain_
.empty()) // means flag wasn't specified
1258 return symbols_to_retain_
.find(symbol_name
) != symbols_to_retain_
.end();
1261 // These are the best way to get access to the execstack state,
1262 // not execstack() and noexecstack() which are hard to use properly.
1264 is_execstack_set() const
1265 { return this->execstack_status_
!= EXECSTACK_FROM_INPUT
; }
1268 is_stack_executable() const
1269 { return this->execstack_status_
== EXECSTACK_YES
; }
1273 { return this->icf_status_
!= ICF_NONE
; }
1276 icf_safe_folding() const
1277 { return this->icf_status_
== ICF_SAFE
; }
1279 // The --demangle option takes an optional string, and there is also
1280 // a --no-demangle option. This is the best way to decide whether
1281 // to demangle or not.
1284 { return this->do_demangle_
; }
1286 // Returns TRUE if any plugin libraries have been loaded.
1289 { return this->plugins_
!= NULL
; }
1291 // Return a pointer to the plugin manager.
1294 { return this->plugins_
; }
1296 // True iff SYMBOL was found in the file specified by dynamic-list.
1298 in_dynamic_list(const char* symbol
) const
1299 { return this->dynamic_list_
.version_script_info()->symbol_is_local(symbol
); }
1301 // Finalize the dynamic list.
1303 finalize_dynamic_list()
1304 { this->dynamic_list_
.version_script_info()->finalize(); }
1306 // The mode selected by the --incremental options.
1307 enum Incremental_mode
1309 // No incremental linking (--no-incremental).
1311 // Incremental update only (--incremental-update).
1313 // Force a full link, but prepare for subsequent incremental link
1314 // (--incremental-full).
1316 // Incremental update if possible, fallback to full link (--incremental).
1320 // The incremental linking mode.
1322 incremental_mode() const
1323 { return this->incremental_mode_
; }
1325 // The disposition given by the --incremental-changed,
1326 // --incremental-unchanged or --incremental-unknown option. The
1327 // value may change as we proceed parsing the command line flags.
1328 Incremental_disposition
1329 incremental_disposition() const
1330 { return this->incremental_disposition_
; }
1332 // Return true if S is the name of a library excluded from automatic
1335 check_excluded_libs(const std::string
&s
) const;
1337 // If an explicit start address was given for section SECNAME with
1338 // the --section-start option, return true and set *PADDR to the
1339 // address. Otherwise return false.
1341 section_start(const char* secname
, uint64_t* paddr
) const;
1345 // Leave original instruction.
1347 // Replace instruction.
1349 // Generate an interworking veneer.
1350 FIX_V4BX_INTERWORKING
1355 { return (this->fix_v4bx_
); }
1366 { return this->endianness_
; }
1369 // Don't copy this structure.
1370 General_options(const General_options
&);
1371 General_options
& operator=(const General_options
&);
1373 // Whether to mark the stack as executable.
1376 // Not set on command line.
1377 EXECSTACK_FROM_INPUT
,
1378 // Mark the stack as executable (-z execstack).
1380 // Mark the stack as not executable (-z noexecstack).
1386 // Do not fold any functions (Default or --icf=none).
1388 // All functions are candidates for folding. (--icf=all).
1390 // Only ctors and dtors are candidates for folding. (--icf=safe).
1395 set_icf_status(Icf_status value
)
1396 { this->icf_status_
= value
; }
1399 set_execstack_status(Execstack value
)
1400 { this->execstack_status_
= value
; }
1403 set_do_demangle(bool value
)
1404 { this->do_demangle_
= value
; }
1407 set_static(bool value
)
1408 { static_
= value
; }
1410 // These are called by finalize() to set up the search-path correctly.
1412 add_to_library_path_with_sysroot(const char* arg
)
1413 { this->add_search_directory_to_library_path(Search_directory(arg
, true)); }
1415 // Apply any sysroot to the directory lists.
1419 // Add a plugin and its arguments to the list of plugins.
1421 add_plugin(const char* filename
);
1423 // Add a plugin option.
1425 add_plugin_option(const char* opt
);
1427 // Whether we printed version information.
1428 bool printed_version_
;
1429 // Whether to mark the stack as executable.
1430 Execstack execstack_status_
;
1431 // Whether to do code folding.
1432 Icf_status icf_status_
;
1433 // Whether to do a static link.
1435 // Whether to do demangling.
1437 // List of plugin libraries.
1438 Plugin_manager
* plugins_
;
1439 // The parsed output of --dynamic-list files. For convenience in
1440 // script.cc, we store this as a Script_options object, even though
1441 // we only use a single Version_tree from it.
1442 Script_options dynamic_list_
;
1443 // The incremental linking mode.
1444 Incremental_mode incremental_mode_
;
1445 // The disposition given by the --incremental-changed,
1446 // --incremental-unchanged or --incremental-unknown option. The
1447 // value may change as we proceed parsing the command line flags.
1448 Incremental_disposition incremental_disposition_
;
1449 // Whether we have seen one of the options that require incremental
1450 // build (--incremental-changed, --incremental-unchanged or
1451 // --incremental-unknown)
1452 bool implicit_incremental_
;
1453 // Libraries excluded from automatic export, via --exclude-libs.
1454 Unordered_set
<std::string
> excluded_libs_
;
1455 // List of symbol-names to keep, via -retain-symbol-info.
1456 Unordered_set
<std::string
> symbols_to_retain_
;
1457 // Map from section name to address from --section-start.
1458 std::map
<std::string
, uint64_t> section_starts_
;
1459 // Whether to process armv4 bx instruction relocation.
1462 Endianness endianness_
;
1465 // The position-dependent options. We use this to store the state of
1466 // the commandline at a particular point in parsing for later
1467 // reference. For instance, if we see "ld --whole-archive foo.a
1468 // --no-whole-archive," we want to store the whole-archive option with
1469 // foo.a, so when the time comes to parse foo.a we know we should do
1470 // it in whole-archive mode. We could store all of General_options,
1471 // but that's big, so we just pick the subset of flags that actually
1472 // change in a position-dependent way.
1474 #define DEFINE_posdep(varname__, type__) \
1478 { return this->varname__##_; } \
1481 set_##varname__(type__ value) \
1482 { this->varname__##_ = value; } \
1486 class Position_dependent_options
1489 Position_dependent_options(const General_options
& options
1490 = Position_dependent_options::default_options_
)
1491 { copy_from_options(options
); }
1493 void copy_from_options(const General_options
& options
)
1495 this->set_as_needed(options
.as_needed());
1496 this->set_Bdynamic(options
.Bdynamic());
1497 this->set_format_enum(options
.format_enum());
1498 this->set_whole_archive(options
.whole_archive());
1499 this->set_incremental_disposition(options
.incremental_disposition());
1502 DEFINE_posdep(as_needed
, bool);
1503 DEFINE_posdep(Bdynamic
, bool);
1504 DEFINE_posdep(format_enum
, General_options::Object_format
);
1505 DEFINE_posdep(whole_archive
, bool);
1506 DEFINE_posdep(incremental_disposition
, Incremental_disposition
);
1509 // This is a General_options with everything set to its default
1510 // value. A Position_dependent_options created with no argument
1511 // will take its values from here.
1512 static General_options default_options_
;
1516 // A single file or library argument from the command line.
1518 class Input_file_argument
1521 enum Input_file_type
1523 // A regular file, name used as-is, not searched.
1524 INPUT_FILE_TYPE_FILE
,
1525 // A library name. When used, "lib" will be prepended and ".so" or
1526 // ".a" appended to make a filename, and that filename will be searched
1527 // for using the -L paths.
1528 INPUT_FILE_TYPE_LIBRARY
,
1529 // A regular file, name used as-is, but searched using the -L paths.
1530 INPUT_FILE_TYPE_SEARCHED_FILE
1533 // name: file name or library name
1534 // type: the type of this input file.
1535 // extra_search_path: an extra directory to look for the file, prior
1536 // to checking the normal library search path. If this is "",
1537 // then no extra directory is added.
1538 // just_symbols: whether this file only defines symbols.
1539 // options: The position dependent options at this point in the
1540 // command line, such as --whole-archive.
1541 Input_file_argument()
1542 : name_(), type_(INPUT_FILE_TYPE_FILE
), extra_search_path_(""),
1543 just_symbols_(false), options_(), arg_serial_(0)
1546 Input_file_argument(const char* name
, Input_file_type type
,
1547 const char* extra_search_path
,
1549 const Position_dependent_options
& options
)
1550 : name_(name
), type_(type
), extra_search_path_(extra_search_path
),
1551 just_symbols_(just_symbols
), options_(options
), arg_serial_(0)
1554 // You can also pass in a General_options instance instead of a
1555 // Position_dependent_options. In that case, we extract the
1556 // position-independent vars from the General_options and only store
1558 Input_file_argument(const char* name
, Input_file_type type
,
1559 const char* extra_search_path
,
1561 const General_options
& options
)
1562 : name_(name
), type_(type
), extra_search_path_(extra_search_path
),
1563 just_symbols_(just_symbols
), options_(options
), arg_serial_(0)
1568 { return this->name_
.c_str(); }
1570 const Position_dependent_options
&
1572 { return this->options_
; }
1576 { return type_
== INPUT_FILE_TYPE_LIBRARY
; }
1579 is_searched_file() const
1580 { return type_
== INPUT_FILE_TYPE_SEARCHED_FILE
; }
1583 extra_search_path() const
1585 return (this->extra_search_path_
.empty()
1587 : this->extra_search_path_
.c_str());
1590 // Return whether we should only read symbols from this file.
1592 just_symbols() const
1593 { return this->just_symbols_
; }
1595 // Return whether this file may require a search using the -L
1598 may_need_search() const
1600 return (this->is_lib()
1601 || this->is_searched_file()
1602 || !this->extra_search_path_
.empty());
1605 // Set the serial number for this argument.
1607 set_arg_serial(unsigned int arg_serial
)
1608 { this->arg_serial_
= arg_serial
; }
1610 // Get the serial number.
1613 { return this->arg_serial_
; }
1616 // We use std::string, not const char*, here for convenience when
1617 // using script files, so that we do not have to preserve the string
1620 Input_file_type type_
;
1621 std::string extra_search_path_
;
1623 Position_dependent_options options_
;
1624 // A unique index for this file argument in the argument list.
1625 unsigned int arg_serial_
;
1628 // A file or library, or a group, from the command line.
1630 class Input_argument
1633 // Create a file or library argument.
1634 explicit Input_argument(Input_file_argument file
)
1635 : is_file_(true), file_(file
), group_(NULL
), lib_(NULL
), script_info_(NULL
)
1638 // Create a group argument.
1639 explicit Input_argument(Input_file_group
* group
)
1640 : is_file_(false), group_(group
), lib_(NULL
), script_info_(NULL
)
1643 // Create a lib argument.
1644 explicit Input_argument(Input_file_lib
* lib
)
1645 : is_file_(false), group_(NULL
), lib_(lib
), script_info_(NULL
)
1648 // Return whether this is a file.
1651 { return this->is_file_
; }
1653 // Return whether this is a group.
1656 { return !this->is_file_
&& this->lib_
== NULL
; }
1658 // Return whether this is a lib.
1661 { return this->lib_
!= NULL
; }
1663 // Return the information about the file.
1664 const Input_file_argument
&
1667 gold_assert(this->is_file_
);
1671 // Return the information about the group.
1672 const Input_file_group
*
1675 gold_assert(!this->is_file_
);
1676 return this->group_
;
1682 gold_assert(!this->is_file_
);
1683 return this->group_
;
1686 // Return the information about the lib.
1687 const Input_file_lib
*
1690 gold_assert(!this->is_file_
);
1691 gold_assert(this->lib_
);
1698 gold_assert(!this->is_file_
);
1699 gold_assert(this->lib_
);
1703 // If a script generated this argument, store a pointer to the script info.
1704 // Currently used only for recording incremental link information.
1706 set_script_info(Script_info
* info
)
1707 { this->script_info_
= info
; }
1711 { return this->script_info_
; }
1715 Input_file_argument file_
;
1716 Input_file_group
* group_
;
1717 Input_file_lib
* lib_
;
1718 Script_info
* script_info_
;
1721 typedef std::vector
<Input_argument
> Input_argument_list
;
1723 // A group from the command line. This is a set of arguments within
1724 // --start-group ... --end-group.
1726 class Input_file_group
1729 typedef Input_argument_list::const_iterator const_iterator
;
1735 // Add a file to the end of the group.
1737 add_file(const Input_file_argument
& arg
)
1739 this->files_
.push_back(Input_argument(arg
));
1740 return this->files_
.back();
1743 // Iterators to iterate over the group contents.
1747 { return this->files_
.begin(); }
1751 { return this->files_
.end(); }
1754 Input_argument_list files_
;
1757 // A lib from the command line. This is a set of arguments within
1758 // --start-lib ... --end-lib.
1760 class Input_file_lib
1763 typedef Input_argument_list::const_iterator const_iterator
;
1765 Input_file_lib(const Position_dependent_options
& options
)
1766 : files_(), options_(options
)
1769 // Add a file to the end of the lib.
1771 add_file(const Input_file_argument
& arg
)
1773 this->files_
.push_back(Input_argument(arg
));
1774 return this->files_
.back();
1777 const Position_dependent_options
&
1779 { return this->options_
; }
1781 // Iterators to iterate over the lib contents.
1785 { return this->files_
.begin(); }
1789 { return this->files_
.end(); }
1793 { return this->files_
.size(); }
1796 Input_argument_list files_
;
1797 Position_dependent_options options_
;
1800 // A list of files from the command line or a script.
1802 class Input_arguments
1805 typedef Input_argument_list::const_iterator const_iterator
;
1808 : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
1813 add_file(Input_file_argument
& arg
);
1815 // Start a group (the --start-group option).
1819 // End a group (the --end-group option).
1823 // Start a lib (the --start-lib option).
1825 start_lib(const Position_dependent_options
&);
1827 // End a lib (the --end-lib option).
1831 // Return whether we are currently in a group.
1834 { return this->in_group_
; }
1836 // Return whether we are currently in a lib.
1839 { return this->in_lib_
; }
1841 // The number of entries in the list.
1844 { return this->input_argument_list_
.size(); }
1846 // Iterators to iterate over the list of input files.
1850 { return this->input_argument_list_
.begin(); }
1854 { return this->input_argument_list_
.end(); }
1856 // Return whether the list is empty.
1859 { return this->input_argument_list_
.empty(); }
1861 // Return the number of input files. This may be larger than
1862 // input_argument_list_.size(), because of files that are part
1863 // of groups or libs.
1865 number_of_input_files() const
1866 { return this->file_count_
; }
1869 Input_argument_list input_argument_list_
;
1872 unsigned int file_count_
;
1876 // All the information read from the command line. These are held in
1877 // three separate structs: one to hold the options (--foo), one to
1878 // hold the filenames listed on the commandline, and one to hold
1879 // linker script information. This third is not a subset of the other
1880 // two because linker scripts can be specified either as options (via
1881 // -T) or as a file.
1886 typedef Input_arguments::const_iterator const_iterator
;
1890 // Process the command line options. This will exit with an
1891 // appropriate error message if an unrecognized option is seen.
1893 process(int argc
, const char** argv
);
1895 // Process one command-line option. This takes the index of argv to
1896 // process, and returns the index for the next option. no_more_options
1897 // is set to true if argv[i] is "--".
1899 process_one_option(int argc
, const char** argv
, int i
,
1900 bool* no_more_options
);
1902 // Get the general options.
1903 const General_options
&
1905 { return this->options_
; }
1907 // Get the position dependent options.
1908 const Position_dependent_options
&
1909 position_dependent_options() const
1910 { return this->position_options_
; }
1912 // Get the linker-script options.
1915 { return this->script_options_
; }
1917 // Finalize the version-script options and return them.
1918 const Version_script_info
&
1921 // Get the input files.
1924 { return this->inputs_
; }
1926 // The number of input files.
1928 number_of_input_files() const
1929 { return this->inputs_
.number_of_input_files(); }
1931 // Iterators to iterate over the list of input files.
1935 { return this->inputs_
.begin(); }
1939 { return this->inputs_
.end(); }
1942 Command_line(const Command_line
&);
1943 Command_line
& operator=(const Command_line
&);
1945 // This is a dummy class to provide a constructor that runs before
1946 // the constructor for the General_options. The Pre_options constructor
1947 // is used as a hook to set the flag enabling the options to register
1949 struct Pre_options
{
1953 // This must come before options_!
1954 Pre_options pre_options_
;
1955 General_options options_
;
1956 Position_dependent_options position_options_
;
1957 Script_options script_options_
;
1958 Input_arguments inputs_
;
1961 } // End namespace gold.
1963 #endif // !defined(GOLD_OPTIONS_H)