1 // options.h -- handle command line options for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008, 2009, 2010 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
;
56 class Position_dependent_options
;
60 // Incremental build action for a specific file, as selected by the user.
62 enum Incremental_disposition
64 // Determine the status from the timestamp (default).
66 // Assume the file changed from the previous build.
68 // Assume the file didn't change from the previous build.
72 // The nested namespace is to contain all the global variables and
73 // structs that need to be defined in the .h file, but do not need to
74 // be used outside this class.
77 typedef std::vector
<Search_directory
> Dir_list
;
78 typedef Unordered_set
<std::string
> String_set
;
80 // These routines convert from a string option to various types.
81 // Each gives a fatal error if it cannot parse the argument.
84 parse_bool(const char* option_name
, const char* arg
, bool* retval
);
87 parse_int(const char* option_name
, const char* arg
, int* retval
);
90 parse_uint(const char* option_name
, const char* arg
, int* retval
);
93 parse_uint64(const char* option_name
, const char* arg
, uint64_t* retval
);
96 parse_double(const char* option_name
, const char* arg
, double* retval
);
99 parse_string(const char* option_name
, const char* arg
, const char** retval
);
102 parse_optional_string(const char* option_name
, const char* arg
,
103 const char** retval
);
106 parse_dirlist(const char* option_name
, const char* arg
, Dir_list
* retval
);
109 parse_set(const char* option_name
, const char* arg
, String_set
* retval
);
112 parse_choices(const char* option_name
, const char* arg
, const char** retval
,
113 const char* choices
[], int num_choices
);
117 // Most options have both a shortname (one letter) and a longname.
118 // This enum controls how many dashes are expected for longname access
119 // -- shortnames always use one dash. Most longnames will accept
120 // either one dash or two; the only difference between ONE_DASH and
121 // TWO_DASHES is how we print the option in --help. However, some
122 // longnames require two dashes, and some require only one. The
123 // special value DASH_Z means that the option is preceded by "-z".
126 ONE_DASH
, TWO_DASHES
, EXACTLY_ONE_DASH
, EXACTLY_TWO_DASHES
, DASH_Z
129 // LONGNAME is the long-name of the option with dashes converted to
130 // underscores, or else the short-name if the option has no long-name.
131 // It is never the empty string.
132 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
133 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
134 // option has no short-name. If the option has no long-name, you
135 // should specify the short-name in *both* VARNAME and here.
136 // DEFAULT_VALUE is the value of the option if not specified on the
137 // commandline, as a string.
138 // HELPSTRING is the descriptive text used with the option via --help
139 // HELPARG is how you define the argument to the option.
140 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
141 // HELPARG should be NULL iff the option is a bool and takes no arg.
142 // OPTIONAL_ARG is true if this option takes an optional argument. An
143 // optional argument must be specifid as --OPTION=VALUE, not
145 // READER provides parse_to_value, which is a function that will convert
146 // a char* argument into the proper type and store it in some variable.
147 // A One_option struct initializes itself with the global list of options
148 // at constructor time, so be careful making one of these.
151 std::string longname
;
154 const char* default_value
;
155 const char* helpstring
;
160 One_option(const char* ln
, Dashes d
, char sn
, const char* dv
,
161 const char* hs
, const char* ha
, bool oa
, Struct_var
* r
)
162 : longname(ln
), dashes(d
), shortname(sn
), default_value(dv
? dv
: ""),
163 helpstring(hs
), helparg(ha
), optional_arg(oa
), reader(r
)
165 // In longname, we convert all underscores to dashes, since GNU
166 // style uses dashes in option names. longname is likely to have
167 // underscores in it because it's also used to declare a C++
169 const char* pos
= strchr(this->longname
.c_str(), '_');
170 for (; pos
; pos
= strchr(pos
, '_'))
171 this->longname
[pos
- this->longname
.c_str()] = '-';
173 // We only register ourselves if our helpstring is not NULL. This
174 // is to support the "no-VAR" boolean variables, which we
175 // conditionally turn on by defining "no-VAR" help text.
176 if (this->helpstring
)
177 this->register_option();
180 // This option takes an argument iff helparg is not NULL.
182 takes_argument() const
183 { return this->helparg
!= NULL
; }
185 // Whether the argument is optional.
187 takes_optional_argument() const
188 { return this->optional_arg
; }
190 // Register this option with the global list of options.
194 // Print this option to stdout (used with --help).
199 // All options have a Struct_##varname that inherits from this and
200 // actually implements parse_to_value for that option.
203 // OPTION: the name of the option as specified on the commandline,
204 // including leading dashes, and any text following the option:
205 // "-O", "--defsym=mysym=0x1000", etc.
206 // ARG: the arg associated with this option, or NULL if the option
207 // takes no argument: "2", "mysym=0x1000", etc.
208 // CMDLINE: the global Command_line object. Used by DEFINE_special.
209 // OPTIONS: the global General_options object. Used by DEFINE_special.
211 parse_to_value(const char* option
, const char* arg
,
212 Command_line
* cmdline
, General_options
* options
) = 0;
214 ~Struct_var() // To make gcc happy.
218 // This is for "special" options that aren't of any predefined type.
219 struct Struct_special
: public Struct_var
221 // If you change this, change the parse-fn in DEFINE_special as well.
222 typedef void (General_options::*Parse_function
)(const char*, const char*,
224 Struct_special(const char* varname
, Dashes dashes
, char shortname
,
225 Parse_function parse_function
,
226 const char* helpstring
, const char* helparg
)
227 : option(varname
, dashes
, shortname
, "", helpstring
, helparg
, false, this),
228 parse(parse_function
)
231 void parse_to_value(const char* option
, const char* arg
,
232 Command_line
* cmdline
, General_options
* options
)
233 { (options
->*(this->parse
))(option
, arg
, cmdline
); }
236 Parse_function parse
;
239 } // End namespace options.
242 // These are helper macros use by DEFINE_uint64/etc below.
243 // This macro is used inside the General_options_ class, so defines
244 // var() and set_var() as General_options methods. Arguments as are
245 // for the constructor for One_option. param_type__ is the same as
246 // type__ for built-in types, and "const type__ &" otherwise.
248 // When we define the linker command option "assert", the macro argument
249 // varname__ of DEFINE_var below will be replaced by "assert". On Mac OSX
250 // assert.h is included implicitly by one of the library headers we use. To
251 // avoid unintended macro substitution of "assert()", we need to enclose
252 // varname__ with parenthese.
253 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
254 default_value_as_string__, helpstring__, helparg__, \
255 optional_arg__, type__, param_type__, parse_fn__) \
258 (varname__)() const \
259 { return this->varname__##_.value; } \
262 user_set_##varname__() const \
263 { return this->varname__##_.user_set_via_option; } \
266 set_user_set_##varname__() \
267 { this->varname__##_.user_set_via_option = true; } \
270 struct Struct_##varname__ : public options::Struct_var \
272 Struct_##varname__() \
273 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
274 helpstring__, helparg__, optional_arg__, this), \
275 user_set_via_option(false), value(default_value__) \
279 parse_to_value(const char* option_name, const char* arg, \
280 Command_line*, General_options*) \
282 parse_fn__(option_name, arg, &this->value); \
283 this->user_set_via_option = true; \
286 options::One_option option; \
287 bool user_set_via_option; \
290 Struct_##varname__ varname__##_; \
292 set_##varname__(param_type__ value) \
293 { this->varname__##_.value = value; }
295 // These macros allow for easy addition of a new commandline option.
297 // If no_helpstring__ is not NULL, then in addition to creating
298 // VARNAME, we also create an option called no-VARNAME (or, for a -z
299 // option, noVARNAME).
300 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
301 helpstring__, no_helpstring__) \
302 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
303 default_value__ ? "true" : "false", helpstring__, NULL, \
304 false, bool, bool, options::parse_bool) \
305 struct Struct_no_##varname__ : public options::Struct_var \
307 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
309 : "no-" #varname__), \
311 default_value__ ? "false" : "true", \
312 no_helpstring__, NULL, false, this) \
316 parse_to_value(const char*, const char*, \
317 Command_line*, General_options* options) \
319 options->set_##varname__(false); \
320 options->set_user_set_##varname__(); \
323 options::One_option option; \
325 Struct_no_##varname__ no_##varname__##_initializer_
327 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
328 helpstring__, no_helpstring__) \
329 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
330 default_value__ ? "true" : "false", helpstring__, NULL, \
331 false, bool, bool, options::parse_bool) \
332 struct Struct_disable_##varname__ : public options::Struct_var \
334 Struct_disable_##varname__() : option("disable-" #varname__, \
336 default_value__ ? "false" : "true", \
337 no_helpstring__, NULL, false, this) \
341 parse_to_value(const char*, const char*, \
342 Command_line*, General_options* options) \
343 { options->set_enable_##varname__(false); } \
345 options::One_option option; \
347 Struct_disable_##varname__ disable_##varname__##_initializer_
349 #define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
350 helpstring__, helparg__) \
351 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
352 #default_value__, helpstring__, helparg__, false, \
353 int, int, options::parse_int)
355 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
356 helpstring__, helparg__) \
357 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
358 #default_value__, helpstring__, helparg__, false, \
359 int, int, options::parse_uint)
361 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
362 helpstring__, helparg__) \
363 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
364 #default_value__, helpstring__, helparg__, false, \
365 uint64_t, uint64_t, options::parse_uint64)
367 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
368 helpstring__, helparg__) \
369 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
370 #default_value__, helpstring__, helparg__, false, \
371 double, double, options::parse_double)
373 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
374 helpstring__, helparg__) \
375 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
376 default_value__, helpstring__, helparg__, false, \
377 const char*, const char*, options::parse_string)
379 // This is like DEFINE_string, but we convert each occurrence to a
380 // Search_directory and store it in a vector. Thus we also have the
381 // add_to_VARNAME() method, to append to the vector.
382 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
383 helpstring__, helparg__) \
384 DEFINE_var(varname__, dashes__, shortname__, , \
385 "", helpstring__, helparg__, false, options::Dir_list, \
386 const options::Dir_list&, options::parse_dirlist) \
388 add_to_##varname__(const char* new_value) \
389 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
391 add_search_directory_to_##varname__(const Search_directory& dir) \
392 { this->varname__##_.value.push_back(dir); }
394 // This is like DEFINE_string, but we store a set of strings.
395 #define DEFINE_set(varname__, dashes__, shortname__, \
396 helpstring__, helparg__) \
397 DEFINE_var(varname__, dashes__, shortname__, , \
398 "", helpstring__, helparg__, false, options::String_set, \
399 const options::String_set&, options::parse_set) \
402 any_##varname__() const \
403 { return !this->varname__##_.value.empty(); } \
406 is_##varname__(const char* symbol) const \
408 return (!this->varname__##_.value.empty() \
409 && (this->varname__##_.value.find(std::string(symbol)) \
410 != this->varname__##_.value.end())); \
413 options::String_set::const_iterator \
414 varname__##_begin() const \
415 { return this->varname__##_.value.begin(); } \
417 options::String_set::const_iterator \
418 varname__##_end() const \
419 { return this->varname__##_.value.end(); }
421 // When you have a list of possible values (expressed as string)
422 // After helparg__ should come an initializer list, like
423 // {"foo", "bar", "baz"}
424 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
425 helpstring__, helparg__, ...) \
426 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
427 default_value__, helpstring__, helparg__, false, \
428 const char*, const char*, parse_choices_##varname__) \
430 static void parse_choices_##varname__(const char* option_name, \
432 const char** retval) { \
433 const char* choices[] = __VA_ARGS__; \
434 options::parse_choices(option_name, arg, retval, \
435 choices, sizeof(choices) / sizeof(*choices)); \
438 // This is like DEFINE_bool, but VARNAME is the name of a different
439 // option. This option becomes an alias for that one. INVERT is true
440 // if this option is an inversion of the other one.
441 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
442 helpstring__, no_helpstring__, invert__) \
444 struct Struct_##option__ : public options::Struct_var \
446 Struct_##option__() \
447 : option(#option__, dashes__, shortname__, "", helpstring__, \
452 parse_to_value(const char*, const char*, \
453 Command_line*, General_options* options) \
455 options->set_##varname__(!invert__); \
456 options->set_user_set_##varname__(); \
459 options::One_option option; \
461 Struct_##option__ option__##_; \
463 struct Struct_no_##option__ : public options::Struct_var \
465 Struct_no_##option__() \
466 : option((dashes__ == options::DASH_Z \
468 : "no-" #option__), \
469 dashes__, '\0', "", no_helpstring__, \
474 parse_to_value(const char*, const char*, \
475 Command_line*, General_options* options) \
477 options->set_##varname__(invert__); \
478 options->set_user_set_##varname__(); \
481 options::One_option option; \
483 Struct_no_##option__ no_##option__##_initializer_
485 // This is used for non-standard flags. It defines no functions; it
486 // just calls General_options::parse_VARNAME whenever the flag is
487 // seen. We declare parse_VARNAME as a static member of
488 // General_options; you are responsible for defining it there.
489 // helparg__ should be NULL iff this special-option is a boolean.
490 #define DEFINE_special(varname__, dashes__, shortname__, \
491 helpstring__, helparg__) \
493 void parse_##varname__(const char* option, const char* arg, \
494 Command_line* inputs); \
495 struct Struct_##varname__ : public options::Struct_special \
497 Struct_##varname__() \
498 : options::Struct_special(#varname__, dashes__, shortname__, \
499 &General_options::parse_##varname__, \
500 helpstring__, helparg__) \
503 Struct_##varname__ varname__##_initializer_
505 // An option that takes an optional string argument. If the option is
506 // used with no argument, the value will be the default, and
507 // user_set_via_option will be true.
508 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
510 helpstring__, helparg__) \
511 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
512 default_value__, helpstring__, helparg__, true, \
513 const char*, const char*, options::parse_optional_string)
515 // A directory to search. For each directory we record whether it is
516 // in the sysroot. We need to know this so that, if a linker script
517 // is found within the sysroot, we will apply the sysroot to any files
518 // named by that script.
520 class Search_directory
523 // We need a default constructor because we put this in a
526 : name_(NULL
), put_in_sysroot_(false), is_in_sysroot_(false)
529 // This is the usual constructor.
530 Search_directory(const char* name
, bool put_in_sysroot
)
531 : name_(name
), put_in_sysroot_(put_in_sysroot
), is_in_sysroot_(false)
533 if (this->name_
.empty())
537 // This is called if we have a sysroot. The sysroot is prefixed to
538 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
539 // set to true for any enries which are in the sysroot (this will
540 // naturally include any entries for which put_in_sysroot_ is true).
541 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
542 // passing SYSROOT to lrealpath.
544 add_sysroot(const char* sysroot
, const char* canonical_sysroot
);
546 // Get the directory name.
549 { return this->name_
; }
551 // Return whether this directory is in the sysroot.
553 is_in_sysroot() const
554 { return this->is_in_sysroot_
; }
556 // Return whether this is considered a system directory.
558 is_system_directory() const
559 { return this->put_in_sysroot_
|| this->is_in_sysroot_
; }
562 // The directory name.
564 // True if the sysroot should be added as a prefix for this
565 // directory (if there is a sysroot). This is true for system
566 // directories that we search by default.
567 bool put_in_sysroot_
;
568 // True if this directory is in the sysroot (if there is a sysroot).
569 // This is true if there is a sysroot and either 1) put_in_sysroot_
570 // is true, or 2) the directory happens to be in the sysroot based
571 // on a pathname comparison.
575 class General_options
578 // NOTE: For every option that you add here, also consider if you
579 // should add it to Position_dependent_options.
580 DEFINE_special(help
, options::TWO_DASHES
, '\0',
581 N_("Report usage information"), NULL
);
582 DEFINE_special(version
, options::TWO_DASHES
, 'v',
583 N_("Report version information"), NULL
);
584 DEFINE_special(V
, options::EXACTLY_ONE_DASH
, '\0',
585 N_("Report version and target information"), NULL
);
587 // These options are sorted approximately so that for each letter in
588 // the alphabet, we show the option whose shortname is that letter
589 // (if any) and then every longname that starts with that letter (in
590 // alphabetical order). For both, lowercase sorts before uppercase.
591 // The -z options come last.
593 DEFINE_bool(add_needed
, options::TWO_DASHES
, '\0', false,
595 N_("Do not copy DT_NEEDED tags from shared libraries"));
597 DEFINE_bool_alias(allow_multiple_definition
, muldefs
, options::TWO_DASHES
,
598 '\0', N_("Allow multiple definitions of symbols"),
599 N_("Do not allow multiple definitions"), false);
601 DEFINE_bool(allow_shlib_undefined
, options::TWO_DASHES
, '\0', false,
602 N_("Allow unresolved references in shared libraries"),
603 N_("Do not allow unresolved references in shared libraries"));
605 DEFINE_bool(as_needed
, options::TWO_DASHES
, '\0', false,
606 N_("Only set DT_NEEDED for shared libraries if used"),
607 N_("Always DT_NEEDED for shared libraries"));
609 DEFINE_enum(assert, options::ONE_DASH
, '\0', NULL
,
610 N_("Ignored"), N_("[ignored]"),
611 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
613 // This should really be an "enum", but it's too easy for folks to
614 // forget to update the list as they add new targets. So we just
615 // accept any string. We'll fail later (when the string is parsed),
616 // if the target isn't actually supported.
617 DEFINE_string(format
, options::TWO_DASHES
, 'b', "elf",
618 N_("Set input format"), ("[elf,binary]"));
620 DEFINE_bool(Bdynamic
, options::ONE_DASH
, '\0', true,
621 N_("-l searches for shared libraries"), NULL
);
622 DEFINE_bool_alias(Bstatic
, Bdynamic
, options::ONE_DASH
, '\0',
623 N_("-l does not search for shared libraries"), NULL
,
626 DEFINE_bool(Bsymbolic
, options::ONE_DASH
, '\0', false,
627 N_("Bind defined symbols locally"), NULL
);
629 DEFINE_bool(Bsymbolic_functions
, options::ONE_DASH
, '\0', false,
630 N_("Bind defined function symbols locally"), NULL
);
632 DEFINE_optional_string(build_id
, options::TWO_DASHES
, '\0', "sha1",
633 N_("Generate build ID note"),
636 DEFINE_bool(check_sections
, options::TWO_DASHES
, '\0', true,
637 N_("Check segment addresses for overlaps (default)"),
638 N_("Do not check segment addresses for overlaps"));
641 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
642 N_("Compress .debug_* sections in the output file"),
646 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
647 N_("Compress .debug_* sections in the output file"),
652 DEFINE_bool(copy_dt_needed_entries
, options::TWO_DASHES
, '\0', false,
654 N_("Do not copy DT_NEEDED tags from shared libraries"));
656 DEFINE_bool(cref
, options::TWO_DASHES
, '\0', false,
657 N_("Output cross reference table"),
658 N_("Do not output cross reference table"));
660 DEFINE_bool(define_common
, options::TWO_DASHES
, 'd', false,
661 N_("Define common symbols"),
662 N_("Do not define common symbols"));
663 DEFINE_bool(dc
, options::ONE_DASH
, '\0', false,
664 N_("Alias for -d"), NULL
);
665 DEFINE_bool(dp
, options::ONE_DASH
, '\0', false,
666 N_("Alias for -d"), NULL
);
668 DEFINE_string(debug
, options::TWO_DASHES
, '\0', "",
669 N_("Turn on debugging"),
670 N_("[all,files,script,task][,...]"));
672 DEFINE_special(defsym
, options::TWO_DASHES
, '\0',
673 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
675 DEFINE_optional_string(demangle
, options::TWO_DASHES
, '\0', NULL
,
676 N_("Demangle C++ symbols in log messages"),
679 DEFINE_bool(no_demangle
, options::TWO_DASHES
, '\0', false,
680 N_("Do not demangle C++ symbols in log messages"),
683 DEFINE_bool(detect_odr_violations
, options::TWO_DASHES
, '\0', false,
684 N_("Try to detect violations of the One Definition Rule"),
687 DEFINE_bool(discard_all
, options::TWO_DASHES
, 'x', false,
688 N_("Delete all local symbols"), NULL
);
689 DEFINE_bool(discard_locals
, options::TWO_DASHES
, 'X', false,
690 N_("Delete all temporary local symbols"), NULL
);
692 DEFINE_bool(dynamic_list_data
, options::TWO_DASHES
, '\0', false,
693 N_("Add data symbols to dynamic symbols"), NULL
);
695 DEFINE_bool(dynamic_list_cpp_new
, options::TWO_DASHES
, '\0', false,
696 N_("Add C++ operator new/delete to dynamic symbols"), NULL
);
698 DEFINE_bool(dynamic_list_cpp_typeinfo
, options::TWO_DASHES
, '\0', false,
699 N_("Add C++ typeinfo to dynamic symbols"), NULL
);
701 DEFINE_special(dynamic_list
, options::TWO_DASHES
, '\0',
702 N_("Read a list of dynamic symbols"), N_("FILE"));
704 DEFINE_string(entry
, options::TWO_DASHES
, 'e', NULL
,
705 N_("Set program start address"), N_("ADDRESS"));
707 DEFINE_special(exclude_libs
, options::TWO_DASHES
, '\0',
708 N_("Exclude libraries from automatic export"),
709 N_(("lib,lib ...")));
711 DEFINE_bool(export_dynamic
, options::TWO_DASHES
, 'E', false,
712 N_("Export all dynamic symbols"),
713 N_("Do not export all dynamic symbols (default)"));
715 DEFINE_bool(eh_frame_hdr
, options::TWO_DASHES
, '\0', false,
716 N_("Create exception frame header"), NULL
);
718 DEFINE_bool(fatal_warnings
, options::TWO_DASHES
, '\0', false,
719 N_("Treat warnings as errors"),
720 N_("Do not treat warnings as errors"));
722 DEFINE_string(fini
, options::ONE_DASH
, '\0', "_fini",
723 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
725 DEFINE_bool(fix_cortex_a8
, options::TWO_DASHES
, '\0', false,
726 N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
727 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
729 DEFINE_special(fix_v4bx
, options::TWO_DASHES
, '\0',
730 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
733 DEFINE_special(fix_v4bx_interworking
, options::TWO_DASHES
, '\0',
734 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
738 DEFINE_bool(g
, options::EXACTLY_ONE_DASH
, '\0', false,
739 N_("Ignored"), NULL
);
741 DEFINE_string(soname
, options::ONE_DASH
, 'h', NULL
,
742 N_("Set shared library name"), N_("FILENAME"));
744 DEFINE_bool(i
, options::EXACTLY_ONE_DASH
, '\0', false,
745 N_("Ignored"), NULL
);
747 DEFINE_double(hash_bucket_empty_fraction
, options::TWO_DASHES
, '\0', 0.0,
748 N_("Min fraction of empty buckets in dynamic hash"),
751 DEFINE_enum(hash_style
, options::TWO_DASHES
, '\0', "sysv",
752 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
753 {"sysv", "gnu", "both"});
755 DEFINE_string(dynamic_linker
, options::TWO_DASHES
, 'I', NULL
,
756 N_("Set dynamic linker path"), N_("PROGRAM"));
758 DEFINE_bool(incremental
, options::TWO_DASHES
, '\0', false,
759 N_("Work in progress; do not use"),
760 N_("Do a full build"));
762 DEFINE_special(incremental_changed
, options::TWO_DASHES
, '\0',
763 N_("Assume files changed"), NULL
);
765 DEFINE_special(incremental_unchanged
, options::TWO_DASHES
, '\0',
766 N_("Assume files didn't change"), NULL
);
768 DEFINE_special(incremental_unknown
, options::TWO_DASHES
, '\0',
769 N_("Use timestamps to check files (default)"), NULL
);
771 DEFINE_string(init
, options::ONE_DASH
, '\0', "_init",
772 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
774 DEFINE_special(just_symbols
, options::TWO_DASHES
, '\0',
775 N_("Read only symbol values from FILE"), N_("FILE"));
777 DEFINE_bool(keep_files_mapped
, options::TWO_DASHES
, '\0',
779 N_("Map whole files to memory (default on 64-bit hosts)"),
780 N_("Map relevant file parts to memory (default on 32-bit "
783 DEFINE_special(library
, options::TWO_DASHES
, 'l',
784 N_("Search for library LIBNAME"), N_("LIBNAME"));
786 DEFINE_dirlist(library_path
, options::TWO_DASHES
, 'L',
787 N_("Add directory to search path"), N_("DIR"));
789 DEFINE_string(m
, options::EXACTLY_ONE_DASH
, 'm', "",
790 N_("Ignored for compatibility"), N_("EMULATION"));
792 DEFINE_bool(print_map
, options::TWO_DASHES
, 'M', false,
793 N_("Write map file on standard output"), NULL
);
794 DEFINE_string(Map
, options::ONE_DASH
, '\0', NULL
, N_("Write map file"),
797 DEFINE_bool(nmagic
, options::TWO_DASHES
, 'n', false,
798 N_("Do not page align data"), NULL
);
799 DEFINE_bool(omagic
, options::EXACTLY_TWO_DASHES
, 'N', false,
800 N_("Do not page align data, do not make text readonly"),
801 N_("Page align data, make text readonly"));
803 DEFINE_enable(new_dtags
, options::EXACTLY_TWO_DASHES
, '\0', false,
804 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
805 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
807 DEFINE_bool(noinhibit_exec
, options::TWO_DASHES
, '\0', false,
808 N_("Create an output file even if errors occur"), NULL
);
810 DEFINE_bool_alias(no_undefined
, defs
, options::TWO_DASHES
, '\0',
811 N_("Report undefined symbols (even with --shared)"),
814 DEFINE_string(output
, options::TWO_DASHES
, 'o', "a.out",
815 N_("Set output file name"), N_("FILE"));
817 DEFINE_uint(optimize
, options::EXACTLY_ONE_DASH
, 'O', 0,
818 N_("Optimize output file size"), N_("LEVEL"));
820 DEFINE_string(oformat
, options::EXACTLY_TWO_DASHES
, '\0', "elf",
821 N_("Set output format"), N_("[binary]"));
823 DEFINE_bool(pie
, options::ONE_DASH
, '\0', false,
824 N_("Create a position independent executable"), NULL
);
825 DEFINE_bool_alias(pic_executable
, pie
, options::TWO_DASHES
, '\0',
826 N_("Create a position independent executable"), NULL
,
829 #ifdef ENABLE_PLUGINS
830 DEFINE_special(plugin
, options::TWO_DASHES
, '\0',
831 N_("Load a plugin library"), N_("PLUGIN"));
832 DEFINE_special(plugin_opt
, options::TWO_DASHES
, '\0',
833 N_("Pass an option to the plugin"), N_("OPTION"));
836 DEFINE_bool(preread_archive_symbols
, options::TWO_DASHES
, '\0', false,
837 N_("Preread archive symbols when multi-threaded"), NULL
);
839 DEFINE_string(print_symbol_counts
, options::TWO_DASHES
, '\0', NULL
,
840 N_("Print symbols defined and used for each input"),
843 DEFINE_bool(Qy
, options::EXACTLY_ONE_DASH
, '\0', false,
844 N_("Ignored for SVR4 compatibility"), NULL
);
846 DEFINE_bool(emit_relocs
, options::TWO_DASHES
, 'q', false,
847 N_("Generate relocations in output"), NULL
);
849 DEFINE_bool(relocatable
, options::EXACTLY_ONE_DASH
, 'r', false,
850 N_("Generate relocatable output"), NULL
);
852 DEFINE_bool(relax
, options::TWO_DASHES
, '\0', false,
853 N_("Relax branches on certain targets"), NULL
);
855 DEFINE_string(retain_symbols_file
, options::TWO_DASHES
, '\0', NULL
,
856 N_("keep only symbols listed in this file"), N_("FILE"));
858 // -R really means -rpath, but can mean --just-symbols for
859 // compatibility with GNU ld. -rpath is always -rpath, so we list
861 DEFINE_special(R
, options::EXACTLY_ONE_DASH
, 'R',
862 N_("Add DIR to runtime search path"), N_("DIR"));
864 DEFINE_dirlist(rpath
, options::ONE_DASH
, '\0',
865 N_("Add DIR to runtime search path"), N_("DIR"));
867 DEFINE_dirlist(rpath_link
, options::TWO_DASHES
, '\0',
868 N_("Add DIR to link time shared library search path"),
871 DEFINE_special(section_start
, options::TWO_DASHES
, '\0',
872 N_("Set address of section"), N_("SECTION=ADDRESS"));
874 DEFINE_optional_string(sort_common
, options::TWO_DASHES
, '\0', NULL
,
875 N_("Sort common symbols by alignment"),
876 N_("[={ascending,descending}]"));
878 DEFINE_bool(strip_all
, options::TWO_DASHES
, 's', false,
879 N_("Strip all symbols"), NULL
);
880 DEFINE_bool(strip_debug
, options::TWO_DASHES
, 'S', false,
881 N_("Strip debugging information"), NULL
);
882 DEFINE_bool(strip_debug_non_line
, options::TWO_DASHES
, '\0', false,
883 N_("Emit only debug line number information"), NULL
);
884 DEFINE_bool(strip_debug_gdb
, options::TWO_DASHES
, '\0', false,
885 N_("Strip debug symbols that are unused by gdb "
886 "(at least versions <= 6.7)"), NULL
);
887 DEFINE_bool(strip_lto_sections
, options::TWO_DASHES
, '\0', true,
888 N_("Strip LTO intermediate code sections"), NULL
);
890 DEFINE_int(stub_group_size
, options::TWO_DASHES
, '\0', 1,
891 N_("(ARM only) The maximum distance from instructions in a group "
892 "of sections to their stubs. Negative values mean stubs "
893 "are always after the group. 1 means using default size.\n"),
896 DEFINE_bool(no_keep_memory
, options::TWO_DASHES
, '\0', false,
897 N_("Use less memory and more disk I/O "
898 "(included only for compatibility with GNU ld)"), NULL
);
900 DEFINE_bool(shared
, options::ONE_DASH
, 'G', false,
901 N_("Generate shared library"), NULL
);
903 DEFINE_bool(Bshareable
, options::ONE_DASH
, '\0', false,
904 N_("Generate shared library"), NULL
);
906 DEFINE_uint(split_stack_adjust_size
, options::TWO_DASHES
, '\0', 0x4000,
907 N_("Stack size when -fsplit-stack function calls non-split"),
910 // This is not actually special in any way, but I need to give it
911 // a non-standard accessor-function name because 'static' is a keyword.
912 DEFINE_special(static, options::ONE_DASH
, '\0',
913 N_("Do not link against shared libraries"), NULL
);
915 DEFINE_enum(icf
, options::TWO_DASHES
, '\0', "none",
916 N_("Identical Code Folding. "
917 "\'--icf=safe\' folds only ctors and dtors."),
919 {"none", "all", "safe"});
921 DEFINE_uint(icf_iterations
, options::TWO_DASHES
, '\0', 0,
922 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
924 DEFINE_bool(print_icf_sections
, options::TWO_DASHES
, '\0', false,
925 N_("List folded identical sections on stderr"),
926 N_("Do not list folded identical sections"));
928 DEFINE_set(keep_unique
, options::TWO_DASHES
, '\0',
929 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
931 DEFINE_bool(gc_sections
, options::TWO_DASHES
, '\0', false,
932 N_("Remove unused sections"),
933 N_("Don't remove unused sections (default)"));
935 DEFINE_bool(print_gc_sections
, options::TWO_DASHES
, '\0', false,
936 N_("List removed unused sections on stderr"),
937 N_("Do not list removed unused sections"));
939 DEFINE_bool(stats
, options::TWO_DASHES
, '\0', false,
940 N_("Print resource usage statistics"), NULL
);
942 DEFINE_string(sysroot
, options::TWO_DASHES
, '\0', "",
943 N_("Set target system root directory"), N_("DIR"));
945 DEFINE_bool(trace
, options::TWO_DASHES
, 't', false,
946 N_("Print the name of each input file"), NULL
);
948 DEFINE_special(script
, options::TWO_DASHES
, 'T',
949 N_("Read linker script"), N_("FILE"));
951 DEFINE_bool(threads
, options::TWO_DASHES
, '\0', false,
952 N_("Run the linker multi-threaded"),
953 N_("Do not run the linker multi-threaded"));
954 DEFINE_uint(thread_count
, options::TWO_DASHES
, '\0', 0,
955 N_("Number of threads to use"), N_("COUNT"));
956 DEFINE_uint(thread_count_initial
, options::TWO_DASHES
, '\0', 0,
957 N_("Number of threads to use in initial pass"), N_("COUNT"));
958 DEFINE_uint(thread_count_middle
, options::TWO_DASHES
, '\0', 0,
959 N_("Number of threads to use in middle pass"), N_("COUNT"));
960 DEFINE_uint(thread_count_final
, options::TWO_DASHES
, '\0', 0,
961 N_("Number of threads to use in final pass"), N_("COUNT"));
963 DEFINE_uint64(Tbss
, options::ONE_DASH
, '\0', -1U,
964 N_("Set the address of the bss segment"), N_("ADDRESS"));
965 DEFINE_uint64(Tdata
, options::ONE_DASH
, '\0', -1U,
966 N_("Set the address of the data segment"), N_("ADDRESS"));
967 DEFINE_uint64(Ttext
, options::ONE_DASH
, '\0', -1U,
968 N_("Set the address of the text segment"), N_("ADDRESS"));
970 DEFINE_set(undefined
, options::TWO_DASHES
, 'u',
971 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
973 DEFINE_bool(verbose
, options::TWO_DASHES
, '\0', false,
974 N_("Synonym for --debug=files"), NULL
);
976 DEFINE_special(version_script
, options::TWO_DASHES
, '\0',
977 N_("Read version script"), N_("FILE"));
979 DEFINE_bool(warn_common
, options::TWO_DASHES
, '\0', false,
980 N_("Warn about duplicate common symbols"),
981 N_("Do not warn about duplicate common symbols (default)"));
983 DEFINE_bool(warn_constructors
, options::TWO_DASHES
, '\0', false,
984 N_("Ignored"), N_("Ignored"));
986 DEFINE_bool(warn_multiple_gp
, options::TWO_DASHES
, '\0', false,
987 N_("Ignored"), NULL
);
989 DEFINE_bool(warn_search_mismatch
, options::TWO_DASHES
, '\0', true,
990 N_("Warn when skipping an incompatible library"),
991 N_("Don't warn when skipping an incompatible library"));
993 DEFINE_bool(warn_shared_textrel
, options::TWO_DASHES
, '\0', false,
994 N_("Warn if text segment is not shareable"),
995 N_("Do not warn if text segment is not shareable (default)"));
997 DEFINE_bool(warn_unresolved_symbols
, options::TWO_DASHES
, '\0', false,
998 N_("Report unresolved symbols as warnings"),
1000 DEFINE_bool_alias(error_unresolved_symbols
, warn_unresolved_symbols
,
1001 options::TWO_DASHES
, '\0',
1002 N_("Report unresolved symbols as errors"),
1005 DEFINE_bool(whole_archive
, options::TWO_DASHES
, '\0', false,
1006 N_("Include all archive contents"),
1007 N_("Include only needed archive contents"));
1009 DEFINE_set(wrap
, options::TWO_DASHES
, '\0',
1010 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1012 DEFINE_set(trace_symbol
, options::TWO_DASHES
, 'y',
1013 N_("Trace references to symbol"), N_("SYMBOL"));
1015 DEFINE_bool(undefined_version
, options::TWO_DASHES
, '\0', true,
1016 N_("Allow unused version in script (default)"),
1017 N_("Do not allow unused version in script"));
1019 DEFINE_string(Y
, options::EXACTLY_ONE_DASH
, 'Y', "",
1020 N_("Default search path for Solaris compatibility"),
1023 DEFINE_special(start_group
, options::TWO_DASHES
, '(',
1024 N_("Start a library search group"), NULL
);
1025 DEFINE_special(end_group
, options::TWO_DASHES
, ')',
1026 N_("End a library search group"), NULL
);
1030 DEFINE_bool(combreloc
, options::DASH_Z
, '\0', true,
1031 N_("Sort dynamic relocs"),
1032 N_("Do not sort dynamic relocs"));
1033 DEFINE_uint64(common_page_size
, options::DASH_Z
, '\0', 0,
1034 N_("Set common page size to SIZE"), N_("SIZE"));
1035 DEFINE_bool(defs
, options::DASH_Z
, '\0', false,
1036 N_("Report undefined symbols (even with --shared)"),
1038 DEFINE_bool(execstack
, options::DASH_Z
, '\0', false,
1039 N_("Mark output as requiring executable stack"), NULL
);
1040 DEFINE_bool(initfirst
, options::DASH_Z
, '\0', false,
1041 N_("Mark DSO to be initialized first at runtime"),
1043 DEFINE_bool(interpose
, options::DASH_Z
, '\0', false,
1044 N_("Mark object to interpose all DSOs but executable"),
1046 DEFINE_bool(lazy
, options::DASH_Z
, '\0', false,
1047 N_("Mark object for lazy runtime binding (default)"),
1049 DEFINE_bool(loadfltr
, options::DASH_Z
, '\0', false,
1050 N_("Mark object requiring immediate process"),
1052 DEFINE_uint64(max_page_size
, options::DASH_Z
, '\0', 0,
1053 N_("Set maximum page size to SIZE"), N_("SIZE"));
1054 DEFINE_bool(muldefs
, options::DASH_Z
, '\0', false,
1055 N_("Allow multiple definitions of symbols"),
1057 // copyreloc is here in the list because there is only -z
1058 // nocopyreloc, not -z copyreloc.
1059 DEFINE_bool(copyreloc
, options::DASH_Z
, '\0', true,
1061 N_("Do not create copy relocs"));
1062 DEFINE_bool(nodefaultlib
, options::DASH_Z
, '\0', false,
1063 N_("Mark object not to use default search paths"),
1065 DEFINE_bool(nodelete
, options::DASH_Z
, '\0', false,
1066 N_("Mark DSO non-deletable at runtime"),
1068 DEFINE_bool(nodlopen
, options::DASH_Z
, '\0', false,
1069 N_("Mark DSO not available to dlopen"),
1071 DEFINE_bool(nodump
, options::DASH_Z
, '\0', false,
1072 N_("Mark DSO not available to dldump"),
1074 DEFINE_bool(noexecstack
, options::DASH_Z
, '\0', false,
1075 N_("Mark output as not requiring executable stack"), NULL
);
1076 DEFINE_bool(now
, options::DASH_Z
, '\0', false,
1077 N_("Mark object for immediate function binding"),
1079 DEFINE_bool(origin
, options::DASH_Z
, '\0', false,
1080 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1081 "processing at runtime"), NULL
);
1082 DEFINE_bool(relro
, options::DASH_Z
, '\0', false,
1083 N_("Where possible mark variables read-only after relocation"),
1084 N_("Don't mark variables read-only after relocation"));
1085 DEFINE_bool(text
, options::DASH_Z
, '\0', false,
1086 N_("Do not permit relocations in read-only segments"),
1088 DEFINE_bool_alias(textoff
, text
, options::DASH_Z
, '\0',
1089 N_("Permit relocations in read-only segments (default)"),
1093 typedef options::Dir_list Dir_list
;
1097 // Does post-processing on flags, making sure they all have
1098 // non-conflicting values. Also converts some flags from their
1099 // "standard" types (string, etc), to another type (enum, DirList),
1100 // which can be accessed via a separate method. Dies if it notices
1104 // True if we printed the version information.
1106 printed_version() const
1107 { return this->printed_version_
; }
1109 // The macro defines output() (based on --output), but that's a
1110 // generic name. Provide this alternative name, which is clearer.
1112 output_file_name() const
1113 { return this->output(); }
1115 // This is not defined via a flag, but combines flags to say whether
1116 // the output is position-independent or not.
1118 output_is_position_independent() const
1119 { return this->shared() || this->pie(); }
1121 // Return true if the output is something that can be exec()ed, such
1122 // as a static executable, or a position-dependent or
1123 // position-independent executable, but not a dynamic library or an
1126 output_is_executable() const
1127 { return !this->shared() && !this->relocatable(); }
1129 // This would normally be static(), and defined automatically, but
1130 // since static is a keyword, we need to come up with our own name.
1135 // In addition to getting the input and output formats as a string
1136 // (via format() and oformat()), we also give access as an enum.
1141 // Straight binary format.
1142 OBJECT_FORMAT_BINARY
1145 // Convert a string to an Object_format. Gives an error if the
1146 // string is not recognized.
1147 static Object_format
1148 string_to_object_format(const char* arg
);
1150 // Note: these functions are not very fast.
1151 Object_format
format_enum() const;
1152 Object_format
oformat_enum() const;
1154 // Return whether FILENAME is in a system directory.
1156 is_in_system_directory(const std::string
& name
) const;
1158 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1160 should_retain_symbol(const char* symbol_name
) const
1162 if (symbols_to_retain_
.empty()) // means flag wasn't specified
1164 return symbols_to_retain_
.find(symbol_name
) != symbols_to_retain_
.end();
1167 // These are the best way to get access to the execstack state,
1168 // not execstack() and noexecstack() which are hard to use properly.
1170 is_execstack_set() const
1171 { return this->execstack_status_
!= EXECSTACK_FROM_INPUT
; }
1174 is_stack_executable() const
1175 { return this->execstack_status_
== EXECSTACK_YES
; }
1179 { return this->icf_status_
!= ICF_NONE
; }
1182 icf_safe_folding() const
1183 { return this->icf_status_
== ICF_SAFE
; }
1185 // The --demangle option takes an optional string, and there is also
1186 // a --no-demangle option. This is the best way to decide whether
1187 // to demangle or not.
1190 { return this->do_demangle_
; }
1192 // Returns TRUE if any plugin libraries have been loaded.
1195 { return this->plugins_
!= NULL
; }
1197 // Return a pointer to the plugin manager.
1200 { return this->plugins_
; }
1202 // True iff SYMBOL was found in the file specified by dynamic-list.
1204 in_dynamic_list(const char* symbol
) const
1205 { return this->dynamic_list_
.version_script_info()->symbol_is_local(symbol
); }
1207 // Finalize the dynamic list.
1209 finalize_dynamic_list()
1210 { this->dynamic_list_
.version_script_info()->finalize(); }
1212 // The disposition given by the --incremental-changed,
1213 // --incremental-unchanged or --incremental-unknown option. The
1214 // value may change as we proceed parsing the command line flags.
1215 Incremental_disposition
1216 incremental_disposition() const
1217 { return this->incremental_disposition_
; }
1219 // Return true if S is the name of a library excluded from automatic
1222 check_excluded_libs (const std::string
&s
) const;
1224 // If an explicit start address was given for section SECNAME with
1225 // the --section-start option, return true and set *PADDR to the
1226 // address. Otherwise return false.
1228 section_start(const char* secname
, uint64_t* paddr
) const;
1232 // Leave original instruction.
1234 // Replace instruction.
1236 // Generate an interworking veneer.
1237 FIX_V4BX_INTERWORKING
1242 { return (this->fix_v4bx_
); }
1245 // Don't copy this structure.
1246 General_options(const General_options
&);
1247 General_options
& operator=(const General_options
&);
1249 // Whether to mark the stack as executable.
1252 // Not set on command line.
1253 EXECSTACK_FROM_INPUT
,
1254 // Mark the stack as executable (-z execstack).
1256 // Mark the stack as not executable (-z noexecstack).
1262 // Do not fold any functions (Default or --icf=none).
1264 // All functions are candidates for folding. (--icf=all).
1266 // Only ctors and dtors are candidates for folding. (--icf=safe).
1271 set_icf_status(Icf_status value
)
1272 { this->icf_status_
= value
; }
1275 set_execstack_status(Execstack value
)
1276 { this->execstack_status_
= value
; }
1279 set_do_demangle(bool value
)
1280 { this->do_demangle_
= value
; }
1283 set_static(bool value
)
1284 { static_
= value
; }
1286 // These are called by finalize() to set up the search-path correctly.
1288 add_to_library_path_with_sysroot(const char* arg
)
1289 { this->add_search_directory_to_library_path(Search_directory(arg
, true)); }
1291 // Apply any sysroot to the directory lists.
1295 // Add a plugin and its arguments to the list of plugins.
1297 add_plugin(const char *filename
);
1299 // Add a plugin option.
1301 add_plugin_option(const char* opt
);
1303 // Whether we printed version information.
1304 bool printed_version_
;
1305 // Whether to mark the stack as executable.
1306 Execstack execstack_status_
;
1307 // Whether to do code folding.
1308 Icf_status icf_status_
;
1309 // Whether to do a static link.
1311 // Whether to do demangling.
1313 // List of plugin libraries.
1314 Plugin_manager
* plugins_
;
1315 // The parsed output of --dynamic-list files. For convenience in
1316 // script.cc, we store this as a Script_options object, even though
1317 // we only use a single Version_tree from it.
1318 Script_options dynamic_list_
;
1319 // The disposition given by the --incremental-changed,
1320 // --incremental-unchanged or --incremental-unknown option. The
1321 // value may change as we proceed parsing the command line flags.
1322 Incremental_disposition incremental_disposition_
;
1323 // Whether we have seen one of the options that require incremental
1324 // build (--incremental-changed, --incremental-unchanged or
1325 // --incremental-unknown)
1326 bool implicit_incremental_
;
1327 // Libraries excluded from automatic export, via --exclude-libs.
1328 Unordered_set
<std::string
> excluded_libs_
;
1329 // List of symbol-names to keep, via -retain-symbol-info.
1330 Unordered_set
<std::string
> symbols_to_retain_
;
1331 // Map from section name to address from --section-start.
1332 std::map
<std::string
, uint64_t> section_starts_
;
1333 // Whether to process armv4 bx instruction relocation.
1337 // The position-dependent options. We use this to store the state of
1338 // the commandline at a particular point in parsing for later
1339 // reference. For instance, if we see "ld --whole-archive foo.a
1340 // --no-whole-archive," we want to store the whole-archive option with
1341 // foo.a, so when the time comes to parse foo.a we know we should do
1342 // it in whole-archive mode. We could store all of General_options,
1343 // but that's big, so we just pick the subset of flags that actually
1344 // change in a position-dependent way.
1346 #define DEFINE_posdep(varname__, type__) \
1350 { return this->varname__##_; } \
1353 set_##varname__(type__ value) \
1354 { this->varname__##_ = value; } \
1358 class Position_dependent_options
1361 Position_dependent_options(const General_options
& options
1362 = Position_dependent_options::default_options_
)
1363 { copy_from_options(options
); }
1365 void copy_from_options(const General_options
& options
)
1367 this->set_as_needed(options
.as_needed());
1368 this->set_Bdynamic(options
.Bdynamic());
1369 this->set_format_enum(options
.format_enum());
1370 this->set_whole_archive(options
.whole_archive());
1371 this->set_incremental_disposition(options
.incremental_disposition());
1374 DEFINE_posdep(as_needed
, bool);
1375 DEFINE_posdep(Bdynamic
, bool);
1376 DEFINE_posdep(format_enum
, General_options::Object_format
);
1377 DEFINE_posdep(whole_archive
, bool);
1378 DEFINE_posdep(incremental_disposition
, Incremental_disposition
);
1381 // This is a General_options with everything set to its default
1382 // value. A Position_dependent_options created with no argument
1383 // will take its values from here.
1384 static General_options default_options_
;
1388 // A single file or library argument from the command line.
1390 class Input_file_argument
1393 enum Input_file_type
1395 // A regular file, name used as-is, not searched.
1396 INPUT_FILE_TYPE_FILE
,
1397 // A library name. When used, "lib" will be prepended and ".so" or
1398 // ".a" appended to make a filename, and that filename will be searched
1399 // for using the -L paths.
1400 INPUT_FILE_TYPE_LIBRARY
,
1401 // A regular file, name used as-is, but searched using the -L paths.
1402 INPUT_FILE_TYPE_SEARCHED_FILE
1405 // name: file name or library name
1406 // type: the type of this input file.
1407 // extra_search_path: an extra directory to look for the file, prior
1408 // to checking the normal library search path. If this is "",
1409 // then no extra directory is added.
1410 // just_symbols: whether this file only defines symbols.
1411 // options: The position dependent options at this point in the
1412 // command line, such as --whole-archive.
1413 Input_file_argument()
1414 : name_(), type_(INPUT_FILE_TYPE_FILE
), extra_search_path_(""),
1415 just_symbols_(false), options_()
1418 Input_file_argument(const char* name
, Input_file_type type
,
1419 const char* extra_search_path
,
1421 const Position_dependent_options
& options
)
1422 : name_(name
), type_(type
), extra_search_path_(extra_search_path
),
1423 just_symbols_(just_symbols
), options_(options
)
1426 // You can also pass in a General_options instance instead of a
1427 // Position_dependent_options. In that case, we extract the
1428 // position-independent vars from the General_options and only store
1430 Input_file_argument(const char* name
, Input_file_type type
,
1431 const char* extra_search_path
,
1433 const General_options
& options
)
1434 : name_(name
), type_(type
), extra_search_path_(extra_search_path
),
1435 just_symbols_(just_symbols
), options_(options
)
1440 { return this->name_
.c_str(); }
1442 const Position_dependent_options
&
1444 { return this->options_
; }
1448 { return type_
== INPUT_FILE_TYPE_LIBRARY
; }
1451 is_searched_file() const
1452 { return type_
== INPUT_FILE_TYPE_SEARCHED_FILE
; }
1455 extra_search_path() const
1457 return (this->extra_search_path_
.empty()
1459 : this->extra_search_path_
.c_str());
1462 // Return whether we should only read symbols from this file.
1464 just_symbols() const
1465 { return this->just_symbols_
; }
1467 // Return whether this file may require a search using the -L
1470 may_need_search() const
1472 return (this->is_lib()
1473 || this->is_searched_file()
1474 || !this->extra_search_path_
.empty());
1478 // We use std::string, not const char*, here for convenience when
1479 // using script files, so that we do not have to preserve the string
1482 Input_file_type type_
;
1483 std::string extra_search_path_
;
1485 Position_dependent_options options_
;
1488 // A file or library, or a group, from the command line.
1490 class Input_argument
1493 // Create a file or library argument.
1494 explicit Input_argument(Input_file_argument file
)
1495 : is_file_(true), file_(file
), group_(NULL
)
1498 // Create a group argument.
1499 explicit Input_argument(Input_file_group
* group
)
1500 : is_file_(false), group_(group
)
1503 // Return whether this is a file.
1506 { return this->is_file_
; }
1508 // Return whether this is a group.
1511 { return !this->is_file_
; }
1513 // Return the information about the file.
1514 const Input_file_argument
&
1517 gold_assert(this->is_file_
);
1521 // Return the information about the group.
1522 const Input_file_group
*
1525 gold_assert(!this->is_file_
);
1526 return this->group_
;
1532 gold_assert(!this->is_file_
);
1533 return this->group_
;
1538 Input_file_argument file_
;
1539 Input_file_group
* group_
;
1542 typedef std::vector
<Input_argument
> Input_argument_list
;
1544 // A group from the command line. This is a set of arguments within
1545 // --start-group ... --end-group.
1547 class Input_file_group
1550 typedef Input_argument_list::const_iterator const_iterator
;
1556 // Add a file to the end of the group.
1558 add_file(const Input_file_argument
& arg
)
1559 { this->files_
.push_back(Input_argument(arg
)); }
1561 // Iterators to iterate over the group contents.
1565 { return this->files_
.begin(); }
1569 { return this->files_
.end(); }
1572 Input_argument_list files_
;
1575 // A list of files from the command line or a script.
1577 class Input_arguments
1580 typedef Input_argument_list::const_iterator const_iterator
;
1583 : input_argument_list_(), in_group_(false)
1588 add_file(const Input_file_argument
& arg
);
1590 // Start a group (the --start-group option).
1594 // End a group (the --end-group option).
1598 // Return whether we are currently in a group.
1601 { return this->in_group_
; }
1603 // The number of entries in the list.
1606 { return this->input_argument_list_
.size(); }
1608 // Iterators to iterate over the list of input files.
1612 { return this->input_argument_list_
.begin(); }
1616 { return this->input_argument_list_
.end(); }
1618 // Return whether the list is empty.
1621 { return this->input_argument_list_
.empty(); }
1624 Input_argument_list input_argument_list_
;
1629 // All the information read from the command line. These are held in
1630 // three separate structs: one to hold the options (--foo), one to
1631 // hold the filenames listed on the commandline, and one to hold
1632 // linker script information. This third is not a subset of the other
1633 // two because linker scripts can be specified either as options (via
1634 // -T) or as a file.
1639 typedef Input_arguments::const_iterator const_iterator
;
1643 // Process the command line options. This will exit with an
1644 // appropriate error message if an unrecognized option is seen.
1646 process(int argc
, const char** argv
);
1648 // Process one command-line option. This takes the index of argv to
1649 // process, and returns the index for the next option. no_more_options
1650 // is set to true if argv[i] is "--".
1652 process_one_option(int argc
, const char** argv
, int i
,
1653 bool* no_more_options
);
1655 // Get the general options.
1656 const General_options
&
1658 { return this->options_
; }
1660 // Get the position dependent options.
1661 const Position_dependent_options
&
1662 position_dependent_options() const
1663 { return this->position_options_
; }
1665 // Get the linker-script options.
1668 { return this->script_options_
; }
1670 // Finalize the version-script options and return them.
1671 const Version_script_info
&
1674 // Get the input files.
1677 { return this->inputs_
; }
1679 // The number of input files.
1681 number_of_input_files() const
1682 { return this->inputs_
.size(); }
1684 // Iterators to iterate over the list of input files.
1688 { return this->inputs_
.begin(); }
1692 { return this->inputs_
.end(); }
1695 Command_line(const Command_line
&);
1696 Command_line
& operator=(const Command_line
&);
1698 // This is a dummy class to provide a constructor that runs before
1699 // the constructor for the General_options. The Pre_options constructor
1700 // is used as a hook to set the flag enabling the options to register
1702 struct Pre_options
{
1706 // This must come before options_!
1707 Pre_options pre_options_
;
1708 General_options options_
;
1709 Position_dependent_options position_options_
;
1710 Script_options script_options_
;
1711 Input_arguments inputs_
;
1714 } // End namespace gold.
1716 #endif // !defined(GOLD_OPTIONS_H)