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 // Startup files that appear before the first disposition option.
67 // These will default to INCREMENTAL_CHECK unless the
68 // --incremental-startup-unchanged option is given.
69 // (For files added implicitly by gcc before any user options.)
71 // Determine the status from the timestamp (default).
73 // Assume the file changed from the previous build.
75 // Assume the file didn't change from the previous build.
79 // The nested namespace is to contain all the global variables and
80 // structs that need to be defined in the .h file, but do not need to
81 // be used outside this class.
84 typedef std::vector<Search_directory> Dir_list;
85 typedef Unordered_set<std::string> String_set;
87 // These routines convert from a string option to various types.
88 // Each gives a fatal error if it cannot parse the argument.
91 parse_bool(const char* option_name, const char* arg, bool* retval);
94 parse_int(const char* option_name, const char* arg, int* retval);
97 parse_uint(const char* option_name, const char* arg, int* retval);
100 parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
103 parse_double(const char* option_name, const char* arg, double* retval);
106 parse_percent(const char* option_name, const char* arg, double* retval);
109 parse_string(const char* option_name, const char* arg, const char** retval);
112 parse_optional_string(const char* option_name, const char* arg,
113 const char** retval);
116 parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
119 parse_set(const char* option_name, const char* arg, String_set* retval);
122 parse_choices(const char* option_name, const char* arg, const char** retval,
123 const char* choices[], int num_choices);
127 // Most options have both a shortname (one letter) and a longname.
128 // This enum controls how many dashes are expected for longname access
129 // -- shortnames always use one dash. Most longnames will accept
130 // either one dash or two; the only difference between ONE_DASH and
131 // TWO_DASHES is how we print the option in --help. However, some
132 // longnames require two dashes, and some require only one. The
133 // special value DASH_Z means that the option is preceded by "-z".
136 ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z
139 // LONGNAME is the long-name of the option with dashes converted to
140 // underscores, or else the short-name if the option has no long-name.
141 // It is never the empty string.
142 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
143 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
144 // option has no short-name. If the option has no long-name, you
145 // should specify the short-name in *both* VARNAME and here.
146 // DEFAULT_VALUE is the value of the option if not specified on the
147 // commandline, as a string.
148 // HELPSTRING is the descriptive text used with the option via --help
149 // HELPARG is how you define the argument to the option.
150 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
151 // HELPARG should be NULL iff the option is a bool and takes no arg.
152 // OPTIONAL_ARG is true if this option takes an optional argument. An
153 // optional argument must be specifid as --OPTION=VALUE, not
155 // READER provides parse_to_value, which is a function that will convert
156 // a char* argument into the proper type and store it in some variable.
157 // A One_option struct initializes itself with the global list of options
158 // at constructor time, so be careful making one of these.
161 std::string longname;
164 const char* default_value;
165 const char* helpstring;
170 One_option(const char* ln, Dashes d, char sn, const char* dv,
171 const char* hs, const char* ha, bool oa, Struct_var* r)
172 : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
173 helpstring(hs), helparg(ha), optional_arg(oa), reader(r)
175 // In longname, we convert all underscores to dashes, since GNU
176 // style uses dashes in option names. longname is likely to have
177 // underscores in it because it's also used to declare a C++
179 const char* pos = strchr(this->longname.c_str(), '_');
180 for (; pos; pos = strchr(pos, '_'))
181 this->longname[pos - this->longname.c_str()] = '-';
183 // We only register ourselves if our helpstring is not NULL. This
184 // is to support the "no-VAR" boolean variables, which we
185 // conditionally turn on by defining "no-VAR" help text.
186 if (this->helpstring)
187 this->register_option();
190 // This option takes an argument iff helparg is not NULL.
192 takes_argument() const
193 { return this->helparg != NULL; }
195 // Whether the argument is optional.
197 takes_optional_argument() const
198 { return this->optional_arg; }
200 // Register this option with the global list of options.
204 // Print this option to stdout (used with --help).
209 // All options have a Struct_##varname that inherits from this and
210 // actually implements parse_to_value for that option.
213 // OPTION: the name of the option as specified on the commandline,
214 // including leading dashes, and any text following the option:
215 // "-O", "--defsym=mysym=0x1000", etc.
216 // ARG: the arg associated with this option, or NULL if the option
217 // takes no argument: "2", "mysym=0x1000", etc.
218 // CMDLINE: the global Command_line object. Used by DEFINE_special.
219 // OPTIONS: the global General_options object. Used by DEFINE_special.
221 parse_to_value(const char* option, const char* arg,
222 Command_line* cmdline, General_options* options) = 0;
224 ~Struct_var() // To make gcc happy.
228 // This is for "special" options that aren't of any predefined type.
229 struct Struct_special : public Struct_var
231 // If you change this, change the parse-fn in DEFINE_special as well.
232 typedef void (General_options::*Parse_function)(const char*, const char*,
234 Struct_special(const char* varname, Dashes dashes, char shortname,
235 Parse_function parse_function,
236 const char* helpstring, const char* helparg)
237 : option(varname, dashes, shortname, "", helpstring, helparg, false, this),
238 parse(parse_function)
241 void parse_to_value(const char* option, const char* arg,
242 Command_line* cmdline, General_options* options)
243 { (options->*(this->parse))(option, arg, cmdline); }
246 Parse_function parse;
249 } // End namespace options.
252 // These are helper macros use by DEFINE_uint64/etc below.
253 // This macro is used inside the General_options_ class, so defines
254 // var() and set_var() as General_options methods. Arguments as are
255 // for the constructor for One_option. param_type__ is the same as
256 // type__ for built-in types, and "const type__ &" otherwise.
258 // When we define the linker command option "assert", the macro argument
259 // varname__ of DEFINE_var below will be replaced by "assert". On Mac OSX
260 // assert.h is included implicitly by one of the library headers we use. To
261 // avoid unintended macro substitution of "assert()", we need to enclose
262 // varname__ with parenthese.
263 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
264 default_value_as_string__, helpstring__, helparg__, \
265 optional_arg__, type__, param_type__, parse_fn__) \
268 (varname__)() const \
269 { return this->varname__##_.value; } \
272 user_set_##varname__() const \
273 { return this->varname__##_.user_set_via_option; } \
276 set_user_set_##varname__() \
277 { this->varname__##_.user_set_via_option = true; } \
280 struct Struct_##varname__ : public options::Struct_var \
282 Struct_##varname__() \
283 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
284 helpstring__, helparg__, optional_arg__, this), \
285 user_set_via_option(false), value(default_value__) \
289 parse_to_value(const char* option_name, const char* arg, \
290 Command_line*, General_options*) \
292 parse_fn__(option_name, arg, &this->value); \
293 this->user_set_via_option = true; \
296 options::One_option option; \
297 bool user_set_via_option; \
300 Struct_##varname__ varname__##_; \
302 set_##varname__(param_type__ value) \
303 { this->varname__##_.value = value; }
305 // These macros allow for easy addition of a new commandline option.
307 // If no_helpstring__ is not NULL, then in addition to creating
308 // VARNAME, we also create an option called no-VARNAME (or, for a -z
309 // option, noVARNAME).
310 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
311 helpstring__, no_helpstring__) \
312 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
313 default_value__ ? "true" : "false", helpstring__, NULL, \
314 false, bool, bool, options::parse_bool) \
315 struct Struct_no_##varname__ : public options::Struct_var \
317 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
319 : "no-" #varname__), \
321 default_value__ ? "false" : "true", \
322 no_helpstring__, NULL, false, this) \
326 parse_to_value(const char*, const char*, \
327 Command_line*, General_options* options) \
329 options->set_##varname__(false); \
330 options->set_user_set_##varname__(); \
333 options::One_option option; \
335 Struct_no_##varname__ no_##varname__##_initializer_
337 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
338 helpstring__, no_helpstring__) \
339 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
340 default_value__ ? "true" : "false", helpstring__, NULL, \
341 false, bool, bool, options::parse_bool) \
342 struct Struct_disable_##varname__ : public options::Struct_var \
344 Struct_disable_##varname__() : option("disable-" #varname__, \
346 default_value__ ? "false" : "true", \
347 no_helpstring__, NULL, false, this) \
351 parse_to_value(const char*, const char*, \
352 Command_line*, General_options* options) \
353 { options->set_enable_##varname__(false); } \
355 options::One_option option; \
357 Struct_disable_##varname__ disable_##varname__##_initializer_
359 #define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
360 helpstring__, helparg__) \
361 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
362 #default_value__, helpstring__, helparg__, false, \
363 int, int, options::parse_int)
365 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
366 helpstring__, helparg__) \
367 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
368 #default_value__, helpstring__, helparg__, false, \
369 int, int, options::parse_uint)
371 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
372 helpstring__, helparg__) \
373 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
374 #default_value__, helpstring__, helparg__, false, \
375 uint64_t, uint64_t, options::parse_uint64)
377 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
378 helpstring__, helparg__) \
379 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
380 #default_value__, helpstring__, helparg__, false, \
381 double, double, options::parse_double)
383 #define DEFINE_percent(varname__, dashes__, shortname__, default_value__, \
384 helpstring__, helparg__) \
385 DEFINE_var(varname__, dashes__, shortname__, default_value__ / 100.0, \
386 #default_value__, helpstring__, helparg__, false, \
387 double, double, options::parse_percent)
389 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
390 helpstring__, helparg__) \
391 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
392 default_value__, helpstring__, helparg__, false, \
393 const char*, const char*, options::parse_string)
395 // This is like DEFINE_string, but we convert each occurrence to a
396 // Search_directory and store it in a vector. Thus we also have the
397 // add_to_VARNAME() method, to append to the vector.
398 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
399 helpstring__, helparg__) \
400 DEFINE_var(varname__, dashes__, shortname__, , \
401 "", helpstring__, helparg__, false, options::Dir_list, \
402 const options::Dir_list&, options::parse_dirlist) \
404 add_to_##varname__(const char* new_value) \
405 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
407 add_search_directory_to_##varname__(const Search_directory& dir) \
408 { this->varname__##_.value.push_back(dir); }
410 // This is like DEFINE_string, but we store a set of strings.
411 #define DEFINE_set(varname__, dashes__, shortname__, \
412 helpstring__, helparg__) \
413 DEFINE_var(varname__, dashes__, shortname__, , \
414 "", helpstring__, helparg__, false, options::String_set, \
415 const options::String_set&, options::parse_set) \
418 any_##varname__() const \
419 { return !this->varname__##_.value.empty(); } \
422 is_##varname__(const char* symbol) const \
424 return (!this->varname__##_.value.empty() \
425 && (this->varname__##_.value.find(std::string(symbol)) \
426 != this->varname__##_.value.end())); \
429 options::String_set::const_iterator \
430 varname__##_begin() const \
431 { return this->varname__##_.value.begin(); } \
433 options::String_set::const_iterator \
434 varname__##_end() const \
435 { return this->varname__##_.value.end(); }
437 // When you have a list of possible values (expressed as string)
438 // After helparg__ should come an initializer list, like
439 // {"foo", "bar", "baz"}
440 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
441 helpstring__, helparg__, ...) \
442 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
443 default_value__, helpstring__, helparg__, false, \
444 const char*, const char*, parse_choices_##varname__) \
446 static void parse_choices_##varname__(const char* option_name, \
448 const char** retval) { \
449 const char* choices[] = __VA_ARGS__; \
450 options::parse_choices(option_name, arg, retval, \
451 choices, sizeof(choices) / sizeof(*choices)); \
454 // This is like DEFINE_bool, but VARNAME is the name of a different
455 // option. This option becomes an alias for that one. INVERT is true
456 // if this option is an inversion of the other one.
457 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
458 helpstring__, no_helpstring__, invert__) \
460 struct Struct_##option__ : public options::Struct_var \
462 Struct_##option__() \
463 : option(#option__, dashes__, shortname__, "", helpstring__, \
468 parse_to_value(const char*, const char*, \
469 Command_line*, General_options* options) \
471 options->set_##varname__(!invert__); \
472 options->set_user_set_##varname__(); \
475 options::One_option option; \
477 Struct_##option__ option__##_; \
479 struct Struct_no_##option__ : public options::Struct_var \
481 Struct_no_##option__() \
482 : option((dashes__ == options::DASH_Z \
484 : "no-" #option__), \
485 dashes__, '\0', "", no_helpstring__, \
490 parse_to_value(const char*, const char*, \
491 Command_line*, General_options* options) \
493 options->set_##varname__(invert__); \
494 options->set_user_set_##varname__(); \
497 options::One_option option; \
499 Struct_no_##option__ no_##option__##_initializer_
501 // This is used for non-standard flags. It defines no functions; it
502 // just calls General_options::parse_VARNAME whenever the flag is
503 // seen. We declare parse_VARNAME as a static member of
504 // General_options; you are responsible for defining it there.
505 // helparg__ should be NULL iff this special-option is a boolean.
506 #define DEFINE_special(varname__, dashes__, shortname__, \
507 helpstring__, helparg__) \
509 void parse_##varname__(const char* option, const char* arg, \
510 Command_line* inputs); \
511 struct Struct_##varname__ : public options::Struct_special \
513 Struct_##varname__() \
514 : options::Struct_special(#varname__, dashes__, shortname__, \
515 &General_options::parse_##varname__, \
516 helpstring__, helparg__) \
519 Struct_##varname__ varname__##_initializer_
521 // An option that takes an optional string argument. If the option is
522 // used with no argument, the value will be the default, and
523 // user_set_via_option will be true.
524 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
526 helpstring__, helparg__) \
527 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
528 default_value__, helpstring__, helparg__, true, \
529 const char*, const char*, options::parse_optional_string)
531 // A directory to search. For each directory we record whether it is
532 // in the sysroot. We need to know this so that, if a linker script
533 // is found within the sysroot, we will apply the sysroot to any files
534 // named by that script.
536 class Search_directory
539 // We need a default constructor because we put this in a
542 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
545 // This is the usual constructor.
546 Search_directory(const char* name, bool put_in_sysroot)
547 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
549 if (this->name_.empty())
553 // This is called if we have a sysroot. The sysroot is prefixed to
554 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
555 // set to true for any enries which are in the sysroot (this will
556 // naturally include any entries for which put_in_sysroot_ is true).
557 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
558 // passing SYSROOT to lrealpath.
560 add_sysroot(const char* sysroot, const char* canonical_sysroot);
562 // Get the directory name.
565 { return this->name_; }
567 // Return whether this directory is in the sysroot.
569 is_in_sysroot() const
570 { return this->is_in_sysroot_; }
572 // Return whether this is considered a system directory.
574 is_system_directory() const
575 { return this->put_in_sysroot_ || this->is_in_sysroot_; }
578 // The directory name.
580 // True if the sysroot should be added as a prefix for this
581 // directory (if there is a sysroot). This is true for system
582 // directories that we search by default.
583 bool put_in_sysroot_;
584 // True if this directory is in the sysroot (if there is a sysroot).
585 // This is true if there is a sysroot and either 1) put_in_sysroot_
586 // is true, or 2) the directory happens to be in the sysroot based
587 // on a pathname comparison.
591 class General_options
594 // NOTE: For every option that you add here, also consider if you
595 // should add it to Position_dependent_options.
596 DEFINE_special(help, options::TWO_DASHES, '\0',
597 N_("Report usage information"), NULL);
598 DEFINE_special(version, options::TWO_DASHES, 'v',
599 N_("Report version information"), NULL);
600 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
601 N_("Report version and target information"), NULL);
603 // These options are sorted approximately so that for each letter in
604 // the alphabet, we show the option whose shortname is that letter
605 // (if any) and then every longname that starts with that letter (in
606 // alphabetical order). For both, lowercase sorts before uppercase.
607 // The -z options come last.
609 DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
611 N_("Do not copy DT_NEEDED tags from shared libraries"));
613 DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
614 '\0', N_("Allow multiple definitions of symbols"),
615 N_("Do not allow multiple definitions"), false);
617 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
618 N_("Allow unresolved references in shared libraries"),
619 N_("Do not allow unresolved references in shared libraries"));
621 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
622 N_("Only set DT_NEEDED for shared libraries if used"),
623 N_("Always DT_NEEDED for shared libraries"));
625 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
626 N_("Ignored"), N_("[ignored]"),
627 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
629 // This should really be an "enum", but it's too easy for folks to
630 // forget to update the list as they add new targets. So we just
631 // accept any string. We'll fail later (when the string is parsed),
632 // if the target isn't actually supported.
633 DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
634 N_("Set input format"), ("[elf,binary]"));
636 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
637 N_("-l searches for shared libraries"), NULL);
638 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
639 N_("-l does not search for shared libraries"), NULL,
641 DEFINE_bool_alias(dy, Bdynamic, options::ONE_DASH, '\0',
642 N_("alias for -Bdynamic"), NULL, false);
643 DEFINE_bool_alias(dn, Bdynamic, options::ONE_DASH, '\0',
644 N_("alias for -Bstatic"), NULL, true);
646 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
647 N_("Bind defined symbols locally"), NULL);
649 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
650 N_("Bind defined function symbols locally"), NULL);
652 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
653 N_("Generate build ID note"),
656 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
657 N_("Check segment addresses for overlaps (default)"),
658 N_("Do not check segment addresses for overlaps"));
661 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
662 N_("Compress .debug_* sections in the output file"),
666 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
667 N_("Compress .debug_* sections in the output file"),
672 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
674 N_("Do not copy DT_NEEDED tags from shared libraries"));
676 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
677 N_("Output cross reference table"),
678 N_("Do not output cross reference table"));
680 DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
681 N_("Use DT_INIT_ARRAY for all constructors (default)"),
682 N_("Handle constructors as directed by compiler"));
684 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
685 N_("Define common symbols"),
686 N_("Do not define common symbols"));
687 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
688 N_("Alias for -d"), NULL);
689 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
690 N_("Alias for -d"), NULL);
692 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
693 N_("Turn on debugging"),
694 N_("[all,files,script,task][,...]"));
696 DEFINE_special(defsym, options::TWO_DASHES, '\0',
697 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
699 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
700 N_("Demangle C++ symbols in log messages"),
703 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
704 N_("Do not demangle C++ symbols in log messages"),
707 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
708 N_("Look for violations of the C++ One Definition Rule"),
709 N_("Do not look for violations of the C++ One Definition Rule"));
711 DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
712 N_("Delete all local symbols"), NULL);
713 DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
714 N_("Delete all temporary local symbols"), NULL);
716 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
717 N_("Add data symbols to dynamic symbols"), NULL);
719 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
720 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
722 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
723 N_("Add C++ typeinfo to dynamic symbols"), NULL);
725 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
726 N_("Read a list of dynamic symbols"), N_("FILE"));
728 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
729 N_("Set program start address"), N_("ADDRESS"));
731 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
732 N_("Exclude libraries from automatic export"),
733 N_(("lib,lib ...")));
735 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
736 N_("Export all dynamic symbols"),
737 N_("Do not export all dynamic symbols (default)"));
739 DEFINE_special(EB, options::ONE_DASH, '\0',
740 N_("Link big-endian objects."), NULL);
742 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
743 N_("Create exception frame header"), NULL);
745 DEFINE_special(EL, options::ONE_DASH, '\0',
746 N_("Link little-endian objects."), NULL);
748 DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
749 N_("(ARM only) Do not warn about objects with incompatible "
752 DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
753 N_("Auxiliary filter for shared object symbol table"),
756 DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
757 N_("Filter for shared object symbol table"),
760 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
761 N_("Treat warnings as errors"),
762 N_("Do not treat warnings as errors"));
764 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
765 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
767 DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
768 N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
769 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
771 DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
772 N_("(ARM only) Merge exidx entries in debuginfo."),
773 N_("(ARM only) Do not merge exidx entries in debuginfo."));
775 DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
776 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
779 DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
780 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
784 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
785 N_("Ignored"), NULL);
787 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
788 N_("Set shared library name"), N_("FILENAME"));
790 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
791 N_("Min fraction of empty buckets in dynamic hash"),
794 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
795 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
796 {"sysv", "gnu", "both"});
798 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
799 N_("Set dynamic linker path"), N_("PROGRAM"));
801 DEFINE_special(incremental, options::TWO_DASHES, '\0',
802 N_("Do an incremental link if possible; "
803 "otherwise, do a full link and prepare output "
804 "for incremental linking"), NULL);
806 DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
807 N_("Do a full link (default)"), NULL);
809 DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
810 N_("Do a full link and "
811 "prepare output for incremental linking"), NULL);
813 DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
814 N_("Do an incremental link; exit if not possible"), NULL);
816 DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
817 N_("Set base file for incremental linking"
818 " (default is output file)"),
821 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
822 N_("Assume files changed"), NULL);
824 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
825 N_("Assume files didn't change"), NULL);
827 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
828 N_("Use timestamps to check files (default)"), NULL);
830 DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
831 N_("Assume startup files unchanged "
832 "(files preceding this option)"), NULL);
834 DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
835 N_("Amount of extra space to allocate for patches"),
838 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
839 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
841 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
842 N_("Read only symbol values from FILE"), N_("FILE"));
844 DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
846 N_("Map whole files to memory (default on 64-bit hosts)"),
847 N_("Map relevant file parts to memory (default on 32-bit "
849 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
850 N_("Keep files mapped across passes (default)"),
851 N_("Release mapped files after each pass"));
853 DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
854 N_("Generate unwind information for PLT (default)"),
855 N_("Do not generate unwind information for PLT"));
857 DEFINE_special(library, options::TWO_DASHES, 'l',
858 N_("Search for library LIBNAME"), N_("LIBNAME"));
860 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
861 N_("Add directory to search path"), N_("DIR"));
863 DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
864 N_(" Only search directories specified on the command line."),
867 DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
868 N_(" Put read-only non-executable sections in their own segment"),
871 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
872 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
874 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
875 N_("Write map file on standard output"), NULL);
876 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
879 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
880 N_("Do not page align data"), NULL);
881 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
882 N_("Do not page align data, do not make text readonly"),
883 N_("Page align data, make text readonly"));
885 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
886 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
887 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
889 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
890 N_("Create an output file even if errors occur"), NULL);
892 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
893 N_("Report undefined symbols (even with --shared)"),
896 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
897 N_("Set output file name"), N_("FILE"));
899 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
900 N_("Optimize output file size"), N_("LEVEL"));
902 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
903 N_("Set output format"), N_("[binary]"));
905 DEFINE_bool(p, options::ONE_DASH, '\0', false,
906 N_("(ARM only) Ignore for backward compatibility"), NULL);
908 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
909 N_("Create a position independent executable"), NULL);
910 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
911 N_("Create a position independent executable"), NULL,
914 DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
915 NULL, N_("(ARM only) Ignore for backward compatibility"));
917 #ifdef ENABLE_PLUGINS
918 DEFINE_special(plugin, options::TWO_DASHES, '\0',
919 N_("Load a plugin library"), N_("PLUGIN"));
920 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
921 N_("Pass an option to the plugin"), N_("OPTION"));
924 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
925 N_("Preread archive symbols when multi-threaded"), NULL);
927 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
928 N_("Print symbols defined and used for each input"),
931 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
932 N_("Ignored for SVR4 compatibility"), NULL);
934 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
935 N_("Generate relocations in output"), NULL);
937 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
938 N_("Generate relocatable output"), NULL);
939 DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
940 N_("Synonym for -r"), NULL, false);
942 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
943 N_("Relax branches on certain targets"), NULL);
945 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
946 N_("keep only symbols listed in this file"), N_("FILE"));
948 // -R really means -rpath, but can mean --just-symbols for
949 // compatibility with GNU ld. -rpath is always -rpath, so we list
951 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
952 N_("Add DIR to runtime search path"), N_("DIR"));
954 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
955 N_("Add DIR to runtime search path"), N_("DIR"));
957 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
958 N_("Add DIR to link time shared library search path"),
961 DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
962 N_("Layout sections in the order specified."),
965 DEFINE_special(section_start, options::TWO_DASHES, '\0',
966 N_("Set address of section"), N_("SECTION=ADDRESS"));
968 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
969 N_("Sort common symbols by alignment"),
970 N_("[={ascending,descending}]"));
972 DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
973 N_("Dynamic tag slots to reserve (default 5)"),
976 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
977 N_("Strip all symbols"), NULL);
978 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
979 N_("Strip debugging information"), NULL);
980 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
981 N_("Emit only debug line number information"), NULL);
982 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
983 N_("Strip debug symbols that are unused by gdb "
984 "(at least versions <= 6.7)"), NULL);
985 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
986 N_("Strip LTO intermediate code sections"), NULL);
988 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
989 N_("(ARM only) The maximum distance from instructions in a group "
990 "of sections to their stubs. Negative values mean stubs "
991 "are always after the group. 1 means using default size.\n"),
994 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
995 N_("Use less memory and more disk I/O "
996 "(included only for compatibility with GNU ld)"), NULL);
998 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
999 N_("Generate shared library"), NULL);
1001 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
1002 N_("Generate shared library"), NULL);
1004 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
1005 N_("Stack size when -fsplit-stack function calls non-split"),
1008 // This is not actually special in any way, but I need to give it
1009 // a non-standard accessor-function name because 'static' is a keyword.
1010 DEFINE_special(static, options::ONE_DASH, '\0',
1011 N_("Do not link against shared libraries"), NULL);
1013 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
1014 N_("Identical Code Folding. "
1015 "\'--icf=safe\' Folds ctors, dtors and functions whose"
1016 " pointers are definitely not taken."),
1017 ("[none,all,safe]"),
1018 {"none", "all", "safe"});
1020 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
1021 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
1023 DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
1024 N_("List folded identical sections on stderr"),
1025 N_("Do not list folded identical sections"));
1027 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
1028 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1030 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
1031 N_("Remove unused sections"),
1032 N_("Don't remove unused sections (default)"));
1034 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
1035 N_("List removed unused sections on stderr"),
1036 N_("Do not list removed unused sections"));
1038 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
1039 N_("Print resource usage statistics"), NULL);
1041 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
1042 N_("Set target system root directory"), N_("DIR"));
1044 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1045 N_("Print the name of each input file"), NULL);
1047 DEFINE_special(script, options::TWO_DASHES, 'T',
1048 N_("Read linker script"), N_("FILE"));
1050 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
1051 N_("Run the linker multi-threaded"),
1052 N_("Do not run the linker multi-threaded"));
1053 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
1054 N_("Number of threads to use"), N_("COUNT"));
1055 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
1056 N_("Number of threads to use in initial pass"), N_("COUNT"));
1057 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
1058 N_("Number of threads to use in middle pass"), N_("COUNT"));
1059 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
1060 N_("Number of threads to use in final pass"), N_("COUNT"));
1062 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1063 N_("Set the address of the bss segment"), N_("ADDRESS"));
1064 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1065 N_("Set the address of the data segment"), N_("ADDRESS"));
1066 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1067 N_("Set the address of the text segment"), N_("ADDRESS"));
1069 DEFINE_set(undefined, options::TWO_DASHES, 'u',
1070 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1072 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1073 N_("Synonym for --debug=files"), NULL);
1075 DEFINE_special(version_script, options::TWO_DASHES, '\0',
1076 N_("Read version script"), N_("FILE"));
1078 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1079 N_("Warn about duplicate common symbols"),
1080 N_("Do not warn about duplicate common symbols (default)"));
1082 DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1083 N_("Ignored"), N_("Ignored"));
1085 DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1086 N_("Warn if the stack is executable"),
1087 N_("Do not warn if the stack is executable (default)"));
1089 DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1090 NULL, N_("Don't warn about mismatched input files"));
1092 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1093 N_("Ignored"), NULL);
1095 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1096 N_("Warn when skipping an incompatible library"),
1097 N_("Don't warn when skipping an incompatible library"));
1099 DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1100 N_("Warn if text segment is not shareable"),
1101 N_("Do not warn if text segment is not shareable (default)"));
1103 DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1104 N_("Report unresolved symbols as warnings"),
1106 DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1107 options::TWO_DASHES, '\0',
1108 N_("Report unresolved symbols as errors"),
1111 DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1112 N_("(ARM only) Do not warn about objects with incompatible "
1115 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1116 N_("Include all archive contents"),
1117 N_("Include only needed archive contents"));
1119 DEFINE_set(wrap, options::TWO_DASHES, '\0',
1120 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1122 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1123 N_("Trace references to symbol"), N_("SYMBOL"));
1125 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1126 N_("Allow unused version in script (default)"),
1127 N_("Do not allow unused version in script"));
1129 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1130 N_("Default search path for Solaris compatibility"),
1133 DEFINE_special(start_group, options::TWO_DASHES, '(',
1134 N_("Start a library search group"), NULL);
1135 DEFINE_special(end_group, options::TWO_DASHES, ')',
1136 N_("End a library search group"), NULL);
1139 DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1140 N_("Start a library"), NULL);
1141 DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1142 N_("End a library "), NULL);
1146 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1147 N_("Sort dynamic relocs"),
1148 N_("Do not sort dynamic relocs"));
1149 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1150 N_("Set common page size to SIZE"), N_("SIZE"));
1151 DEFINE_bool(defs, options::DASH_Z, '\0', false,
1152 N_("Report undefined symbols (even with --shared)"),
1154 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1155 N_("Mark output as requiring executable stack"), NULL);
1156 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1157 N_("Mark DSO to be initialized first at runtime"),
1159 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1160 N_("Mark object to interpose all DSOs but executable"),
1162 DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1163 N_("Mark object for lazy runtime binding (default)"),
1165 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1166 N_("Mark object requiring immediate process"),
1168 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1169 N_("Set maximum page size to SIZE"), N_("SIZE"));
1170 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1171 N_("Allow multiple definitions of symbols"),
1173 // copyreloc is here in the list because there is only -z
1174 // nocopyreloc, not -z copyreloc.
1175 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1177 N_("Do not create copy relocs"));
1178 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1179 N_("Mark object not to use default search paths"),
1181 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1182 N_("Mark DSO non-deletable at runtime"),
1184 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1185 N_("Mark DSO not available to dlopen"),
1187 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1188 N_("Mark DSO not available to dldump"),
1190 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1191 N_("Mark output as not requiring executable stack"), NULL);
1192 DEFINE_bool(now, options::DASH_Z, '\0', false,
1193 N_("Mark object for immediate function binding"),
1195 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1196 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1197 "processing at runtime"), NULL);
1198 DEFINE_bool(relro, options::DASH_Z, '\0', false,
1199 N_("Where possible mark variables read-only after relocation"),
1200 N_("Don't mark variables read-only after relocation"));
1201 DEFINE_bool(text, options::DASH_Z, '\0', false,
1202 N_("Do not permit relocations in read-only segments"),
1203 N_("Permit relocations in read-only segments (default)"));
1204 DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1205 N_("Permit relocations in read-only segments (default)"),
1209 typedef options::Dir_list Dir_list;
1213 // Does post-processing on flags, making sure they all have
1214 // non-conflicting values. Also converts some flags from their
1215 // "standard" types (string, etc), to another type (enum, DirList),
1216 // which can be accessed via a separate method. Dies if it notices
1220 // True if we printed the version information.
1222 printed_version() const
1223 { return this->printed_version_; }
1225 // The macro defines output() (based on --output), but that's a
1226 // generic name. Provide this alternative name, which is clearer.
1228 output_file_name() const
1229 { return this->output(); }
1231 // This is not defined via a flag, but combines flags to say whether
1232 // the output is position-independent or not.
1234 output_is_position_independent() const
1235 { return this->shared() || this->pie(); }
1237 // Return true if the output is something that can be exec()ed, such
1238 // as a static executable, or a position-dependent or
1239 // position-independent executable, but not a dynamic library or an
1242 output_is_executable() const
1243 { return !this->shared() && !this->relocatable(); }
1245 // This would normally be static(), and defined automatically, but
1246 // since static is a keyword, we need to come up with our own name.
1251 // In addition to getting the input and output formats as a string
1252 // (via format() and oformat()), we also give access as an enum.
1257 // Straight binary format.
1258 OBJECT_FORMAT_BINARY
1261 // Convert a string to an Object_format. Gives an error if the
1262 // string is not recognized.
1263 static Object_format
1264 string_to_object_format(const char* arg);
1266 // Note: these functions are not very fast.
1267 Object_format format_enum() const;
1268 Object_format oformat_enum() const;
1270 // Return whether FILENAME is in a system directory.
1272 is_in_system_directory(const std::string& name) const;
1274 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1276 should_retain_symbol(const char* symbol_name) const
1278 if (symbols_to_retain_.empty()) // means flag wasn't specified
1280 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1283 // These are the best way to get access to the execstack state,
1284 // not execstack() and noexecstack() which are hard to use properly.
1286 is_execstack_set() const
1287 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1290 is_stack_executable() const
1291 { return this->execstack_status_ == EXECSTACK_YES; }
1295 { return this->icf_status_ != ICF_NONE; }
1298 icf_safe_folding() const
1299 { return this->icf_status_ == ICF_SAFE; }
1301 // The --demangle option takes an optional string, and there is also
1302 // a --no-demangle option. This is the best way to decide whether
1303 // to demangle or not.
1306 { return this->do_demangle_; }
1308 // Returns TRUE if any plugin libraries have been loaded.
1311 { return this->plugins_ != NULL; }
1313 // Return a pointer to the plugin manager.
1316 { return this->plugins_; }
1318 // True iff SYMBOL was found in the file specified by dynamic-list.
1320 in_dynamic_list(const char* symbol) const
1321 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1323 // Finalize the dynamic list.
1325 finalize_dynamic_list()
1326 { this->dynamic_list_.version_script_info()->finalize(); }
1328 // The mode selected by the --incremental options.
1329 enum Incremental_mode
1331 // No incremental linking (--no-incremental).
1333 // Incremental update only (--incremental-update).
1335 // Force a full link, but prepare for subsequent incremental link
1336 // (--incremental-full).
1338 // Incremental update if possible, fallback to full link (--incremental).
1342 // The incremental linking mode.
1344 incremental_mode() const
1345 { return this->incremental_mode_; }
1347 // The disposition given by the --incremental-changed,
1348 // --incremental-unchanged or --incremental-unknown option. The
1349 // value may change as we proceed parsing the command line flags.
1350 Incremental_disposition
1351 incremental_disposition() const
1352 { return this->incremental_disposition_; }
1354 // The disposition to use for startup files (those that precede the
1355 // first --incremental-changed, etc. option).
1356 Incremental_disposition
1357 incremental_startup_disposition() const
1358 { return this->incremental_startup_disposition_; }
1360 // Return true if S is the name of a library excluded from automatic
1363 check_excluded_libs(const std::string &s) const;
1365 // If an explicit start address was given for section SECNAME with
1366 // the --section-start option, return true and set *PADDR to the
1367 // address. Otherwise return false.
1369 section_start(const char* secname, uint64_t* paddr) const;
1373 // Leave original instruction.
1375 // Replace instruction.
1377 // Generate an interworking veneer.
1378 FIX_V4BX_INTERWORKING
1383 { return (this->fix_v4bx_); }
1394 { return this->endianness_; }
1397 // Don't copy this structure.
1398 General_options(const General_options&);
1399 General_options& operator=(const General_options&);
1401 // Whether to mark the stack as executable.
1404 // Not set on command line.
1405 EXECSTACK_FROM_INPUT,
1406 // Mark the stack as executable (-z execstack).
1408 // Mark the stack as not executable (-z noexecstack).
1414 // Do not fold any functions (Default or --icf=none).
1416 // All functions are candidates for folding. (--icf=all).
1418 // Only ctors and dtors are candidates for folding. (--icf=safe).
1423 set_icf_status(Icf_status value)
1424 { this->icf_status_ = value; }
1427 set_execstack_status(Execstack value)
1428 { this->execstack_status_ = value; }
1431 set_do_demangle(bool value)
1432 { this->do_demangle_ = value; }
1435 set_static(bool value)
1436 { static_ = value; }
1438 // These are called by finalize() to set up the search-path correctly.
1440 add_to_library_path_with_sysroot(const char* arg)
1441 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1443 // Apply any sysroot to the directory lists.
1447 // Add a plugin and its arguments to the list of plugins.
1449 add_plugin(const char* filename);
1451 // Add a plugin option.
1453 add_plugin_option(const char* opt);
1455 // Whether we printed version information.
1456 bool printed_version_;
1457 // Whether to mark the stack as executable.
1458 Execstack execstack_status_;
1459 // Whether to do code folding.
1460 Icf_status icf_status_;
1461 // Whether to do a static link.
1463 // Whether to do demangling.
1465 // List of plugin libraries.
1466 Plugin_manager* plugins_;
1467 // The parsed output of --dynamic-list files. For convenience in
1468 // script.cc, we store this as a Script_options object, even though
1469 // we only use a single Version_tree from it.
1470 Script_options dynamic_list_;
1471 // The incremental linking mode.
1472 Incremental_mode incremental_mode_;
1473 // The disposition given by the --incremental-changed,
1474 // --incremental-unchanged or --incremental-unknown option. The
1475 // value may change as we proceed parsing the command line flags.
1476 Incremental_disposition incremental_disposition_;
1477 // The disposition to use for startup files (those marked
1478 // INCREMENTAL_STARTUP).
1479 Incremental_disposition incremental_startup_disposition_;
1480 // Whether we have seen one of the options that require incremental
1481 // build (--incremental-changed, --incremental-unchanged,
1482 // --incremental-unknown, or --incremental-startup-unchanged).
1483 bool implicit_incremental_;
1484 // Libraries excluded from automatic export, via --exclude-libs.
1485 Unordered_set<std::string> excluded_libs_;
1486 // List of symbol-names to keep, via -retain-symbol-info.
1487 Unordered_set<std::string> symbols_to_retain_;
1488 // Map from section name to address from --section-start.
1489 std::map<std::string, uint64_t> section_starts_;
1490 // Whether to process armv4 bx instruction relocation.
1493 Endianness endianness_;
1496 // The position-dependent options. We use this to store the state of
1497 // the commandline at a particular point in parsing for later
1498 // reference. For instance, if we see "ld --whole-archive foo.a
1499 // --no-whole-archive," we want to store the whole-archive option with
1500 // foo.a, so when the time comes to parse foo.a we know we should do
1501 // it in whole-archive mode. We could store all of General_options,
1502 // but that's big, so we just pick the subset of flags that actually
1503 // change in a position-dependent way.
1505 #define DEFINE_posdep(varname__, type__) \
1509 { return this->varname__##_; } \
1512 set_##varname__(type__ value) \
1513 { this->varname__##_ = value; } \
1517 class Position_dependent_options
1520 Position_dependent_options(const General_options& options
1521 = Position_dependent_options::default_options_)
1522 { copy_from_options(options); }
1524 void copy_from_options(const General_options& options)
1526 this->set_as_needed(options.as_needed());
1527 this->set_Bdynamic(options.Bdynamic());
1528 this->set_format_enum(options.format_enum());
1529 this->set_whole_archive(options.whole_archive());
1530 this->set_incremental_disposition(options.incremental_disposition());
1533 DEFINE_posdep(as_needed, bool);
1534 DEFINE_posdep(Bdynamic, bool);
1535 DEFINE_posdep(format_enum, General_options::Object_format);
1536 DEFINE_posdep(whole_archive, bool);
1537 DEFINE_posdep(incremental_disposition, Incremental_disposition);
1540 // This is a General_options with everything set to its default
1541 // value. A Position_dependent_options created with no argument
1542 // will take its values from here.
1543 static General_options default_options_;
1547 // A single file or library argument from the command line.
1549 class Input_file_argument
1552 enum Input_file_type
1554 // A regular file, name used as-is, not searched.
1555 INPUT_FILE_TYPE_FILE,
1556 // A library name. When used, "lib" will be prepended and ".so" or
1557 // ".a" appended to make a filename, and that filename will be searched
1558 // for using the -L paths.
1559 INPUT_FILE_TYPE_LIBRARY,
1560 // A regular file, name used as-is, but searched using the -L paths.
1561 INPUT_FILE_TYPE_SEARCHED_FILE
1564 // name: file name or library name
1565 // type: the type of this input file.
1566 // extra_search_path: an extra directory to look for the file, prior
1567 // to checking the normal library search path. If this is "",
1568 // then no extra directory is added.
1569 // just_symbols: whether this file only defines symbols.
1570 // options: The position dependent options at this point in the
1571 // command line, such as --whole-archive.
1572 Input_file_argument()
1573 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1574 just_symbols_(false), options_(), arg_serial_(0)
1577 Input_file_argument(const char* name, Input_file_type type,
1578 const char* extra_search_path,
1580 const Position_dependent_options& options)
1581 : name_(name), type_(type), extra_search_path_(extra_search_path),
1582 just_symbols_(just_symbols), options_(options), arg_serial_(0)
1585 // You can also pass in a General_options instance instead of a
1586 // Position_dependent_options. In that case, we extract the
1587 // position-independent vars from the General_options and only store
1589 Input_file_argument(const char* name, Input_file_type type,
1590 const char* extra_search_path,
1592 const General_options& options)
1593 : name_(name), type_(type), extra_search_path_(extra_search_path),
1594 just_symbols_(just_symbols), options_(options), arg_serial_(0)
1599 { return this->name_.c_str(); }
1601 const Position_dependent_options&
1603 { return this->options_; }
1607 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1610 is_searched_file() const
1611 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1614 extra_search_path() const
1616 return (this->extra_search_path_.empty()
1618 : this->extra_search_path_.c_str());
1621 // Return whether we should only read symbols from this file.
1623 just_symbols() const
1624 { return this->just_symbols_; }
1626 // Return whether this file may require a search using the -L
1629 may_need_search() const
1631 return (this->is_lib()
1632 || this->is_searched_file()
1633 || !this->extra_search_path_.empty());
1636 // Set the serial number for this argument.
1638 set_arg_serial(unsigned int arg_serial)
1639 { this->arg_serial_ = arg_serial; }
1641 // Get the serial number.
1644 { return this->arg_serial_; }
1647 // We use std::string, not const char*, here for convenience when
1648 // using script files, so that we do not have to preserve the string
1651 Input_file_type type_;
1652 std::string extra_search_path_;
1654 Position_dependent_options options_;
1655 // A unique index for this file argument in the argument list.
1656 unsigned int arg_serial_;
1659 // A file or library, or a group, from the command line.
1661 class Input_argument
1664 // Create a file or library argument.
1665 explicit Input_argument(Input_file_argument file)
1666 : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
1669 // Create a group argument.
1670 explicit Input_argument(Input_file_group* group)
1671 : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
1674 // Create a lib argument.
1675 explicit Input_argument(Input_file_lib* lib)
1676 : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
1679 // Return whether this is a file.
1682 { return this->is_file_; }
1684 // Return whether this is a group.
1687 { return !this->is_file_ && this->lib_ == NULL; }
1689 // Return whether this is a lib.
1692 { return this->lib_ != NULL; }
1694 // Return the information about the file.
1695 const Input_file_argument&
1698 gold_assert(this->is_file_);
1702 // Return the information about the group.
1703 const Input_file_group*
1706 gold_assert(!this->is_file_);
1707 return this->group_;
1713 gold_assert(!this->is_file_);
1714 return this->group_;
1717 // Return the information about the lib.
1718 const Input_file_lib*
1721 gold_assert(!this->is_file_);
1722 gold_assert(this->lib_);
1729 gold_assert(!this->is_file_);
1730 gold_assert(this->lib_);
1734 // If a script generated this argument, store a pointer to the script info.
1735 // Currently used only for recording incremental link information.
1737 set_script_info(Script_info* info)
1738 { this->script_info_ = info; }
1742 { return this->script_info_; }
1746 Input_file_argument file_;
1747 Input_file_group* group_;
1748 Input_file_lib* lib_;
1749 Script_info* script_info_;
1752 typedef std::vector<Input_argument> Input_argument_list;
1754 // A group from the command line. This is a set of arguments within
1755 // --start-group ... --end-group.
1757 class Input_file_group
1760 typedef Input_argument_list::const_iterator const_iterator;
1766 // Add a file to the end of the group.
1768 add_file(const Input_file_argument& arg)
1770 this->files_.push_back(Input_argument(arg));
1771 return this->files_.back();
1774 // Iterators to iterate over the group contents.
1778 { return this->files_.begin(); }
1782 { return this->files_.end(); }
1785 Input_argument_list files_;
1788 // A lib from the command line. This is a set of arguments within
1789 // --start-lib ... --end-lib.
1791 class Input_file_lib
1794 typedef Input_argument_list::const_iterator const_iterator;
1796 Input_file_lib(const Position_dependent_options& options)
1797 : files_(), options_(options)
1800 // Add a file to the end of the lib.
1802 add_file(const Input_file_argument& arg)
1804 this->files_.push_back(Input_argument(arg));
1805 return this->files_.back();
1808 const Position_dependent_options&
1810 { return this->options_; }
1812 // Iterators to iterate over the lib contents.
1816 { return this->files_.begin(); }
1820 { return this->files_.end(); }
1824 { return this->files_.size(); }
1827 Input_argument_list files_;
1828 Position_dependent_options options_;
1831 // A list of files from the command line or a script.
1833 class Input_arguments
1836 typedef Input_argument_list::const_iterator const_iterator;
1839 : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
1844 add_file(Input_file_argument& arg);
1846 // Start a group (the --start-group option).
1850 // End a group (the --end-group option).
1854 // Start a lib (the --start-lib option).
1856 start_lib(const Position_dependent_options&);
1858 // End a lib (the --end-lib option).
1862 // Return whether we are currently in a group.
1865 { return this->in_group_; }
1867 // Return whether we are currently in a lib.
1870 { return this->in_lib_; }
1872 // The number of entries in the list.
1875 { return this->input_argument_list_.size(); }
1877 // Iterators to iterate over the list of input files.
1881 { return this->input_argument_list_.begin(); }
1885 { return this->input_argument_list_.end(); }
1887 // Return whether the list is empty.
1890 { return this->input_argument_list_.empty(); }
1892 // Return the number of input files. This may be larger than
1893 // input_argument_list_.size(), because of files that are part
1894 // of groups or libs.
1896 number_of_input_files() const
1897 { return this->file_count_; }
1900 Input_argument_list input_argument_list_;
1903 unsigned int file_count_;
1907 // All the information read from the command line. These are held in
1908 // three separate structs: one to hold the options (--foo), one to
1909 // hold the filenames listed on the commandline, and one to hold
1910 // linker script information. This third is not a subset of the other
1911 // two because linker scripts can be specified either as options (via
1912 // -T) or as a file.
1917 typedef Input_arguments::const_iterator const_iterator;
1921 // Process the command line options. This will exit with an
1922 // appropriate error message if an unrecognized option is seen.
1924 process(int argc, const char** argv);
1926 // Process one command-line option. This takes the index of argv to
1927 // process, and returns the index for the next option. no_more_options
1928 // is set to true if argv[i] is "--".
1930 process_one_option(int argc, const char** argv, int i,
1931 bool* no_more_options);
1933 // Get the general options.
1934 const General_options&
1936 { return this->options_; }
1938 // Get the position dependent options.
1939 const Position_dependent_options&
1940 position_dependent_options() const
1941 { return this->position_options_; }
1943 // Get the linker-script options.
1946 { return this->script_options_; }
1948 // Finalize the version-script options and return them.
1949 const Version_script_info&
1952 // Get the input files.
1955 { return this->inputs_; }
1957 // The number of input files.
1959 number_of_input_files() const
1960 { return this->inputs_.number_of_input_files(); }
1962 // Iterators to iterate over the list of input files.
1966 { return this->inputs_.begin(); }
1970 { return this->inputs_.end(); }
1973 Command_line(const Command_line&);
1974 Command_line& operator=(const Command_line&);
1976 // This is a dummy class to provide a constructor that runs before
1977 // the constructor for the General_options. The Pre_options constructor
1978 // is used as a hook to set the flag enabling the options to register
1980 struct Pre_options {
1984 // This must come before options_!
1985 Pre_options pre_options_;
1986 General_options options_;
1987 Position_dependent_options position_options_;
1988 Script_options script_options_;
1989 Input_arguments inputs_;
1992 } // End namespace gold.
1994 #endif // !defined(GOLD_OPTIONS_H)