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(Bgroup, options::ONE_DASH, '\0', false,
647 N_("Use group name lookup rules for shared library"), NULL);
649 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
650 N_("Bind defined symbols locally"), NULL);
652 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
653 N_("Bind defined function symbols locally"), NULL);
655 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
656 N_("Generate build ID note"),
659 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
660 N_("Check segment addresses for overlaps (default)"),
661 N_("Do not check segment addresses for overlaps"));
664 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
665 N_("Compress .debug_* sections in the output file"),
669 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
670 N_("Compress .debug_* sections in the output file"),
675 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
677 N_("Do not copy DT_NEEDED tags from shared libraries"));
679 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
680 N_("Output cross reference table"),
681 N_("Do not output cross reference table"));
683 DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
684 N_("Use DT_INIT_ARRAY for all constructors (default)"),
685 N_("Handle constructors as directed by compiler"));
687 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
688 N_("Define common symbols"),
689 N_("Do not define common symbols"));
690 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
691 N_("Alias for -d"), NULL);
692 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
693 N_("Alias for -d"), NULL);
695 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
696 N_("Turn on debugging"),
697 N_("[all,files,script,task][,...]"));
699 DEFINE_special(defsym, options::TWO_DASHES, '\0',
700 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
702 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
703 N_("Demangle C++ symbols in log messages"),
706 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
707 N_("Do not demangle C++ symbols in log messages"),
710 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
711 N_("Look for violations of the C++ One Definition Rule"),
712 N_("Do not look for violations of the C++ One Definition Rule"));
714 DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
715 N_("Delete all local symbols"), NULL);
716 DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
717 N_("Delete all temporary local symbols"), NULL);
719 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
720 N_("Add data symbols to dynamic symbols"), NULL);
722 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
723 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
725 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
726 N_("Add C++ typeinfo to dynamic symbols"), NULL);
728 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
729 N_("Read a list of dynamic symbols"), N_("FILE"));
731 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
732 N_("Set program start address"), N_("ADDRESS"));
734 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
735 N_("Exclude libraries from automatic export"),
736 N_(("lib,lib ...")));
738 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
739 N_("Export all dynamic symbols"),
740 N_("Do not export all dynamic symbols (default)"));
742 DEFINE_special(EB, options::ONE_DASH, '\0',
743 N_("Link big-endian objects."), NULL);
745 DEFINE_special(EL, options::ONE_DASH, '\0',
746 N_("Link little-endian objects."), NULL);
748 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
749 N_("Create exception frame header"), NULL);
751 DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
752 N_("(ARM only) Do not warn about objects with incompatible "
755 DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
756 N_("Auxiliary filter for shared object symbol table"),
759 DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
760 N_("Filter for shared object symbol table"),
763 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
764 N_("Treat warnings as errors"),
765 N_("Do not treat warnings as errors"));
767 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
768 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
770 DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
771 N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
772 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
774 DEFINE_bool(fix_arm1176, options::TWO_DASHES, '\0', true,
775 N_("(ARM only) Fix binaries for ARM1176 erratum."),
776 N_("(ARM only) Do not fix binaries for ARM1176 erratum."));
778 DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
779 N_("(ARM only) Merge exidx entries in debuginfo."),
780 N_("(ARM only) Do not merge exidx entries in debuginfo."));
782 DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
783 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
786 DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
787 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
791 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
792 N_("Ignored"), NULL);
794 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
795 N_("Set shared library name"), N_("FILENAME"));
797 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
798 N_("Min fraction of empty buckets in dynamic hash"),
801 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
802 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
803 {"sysv", "gnu", "both"});
805 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
806 N_("Set dynamic linker path"), N_("PROGRAM"));
808 DEFINE_special(incremental, options::TWO_DASHES, '\0',
809 N_("Do an incremental link if possible; "
810 "otherwise, do a full link and prepare output "
811 "for incremental linking"), NULL);
813 DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
814 N_("Do a full link (default)"), NULL);
816 DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
817 N_("Do a full link and "
818 "prepare output for incremental linking"), NULL);
820 DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
821 N_("Do an incremental link; exit if not possible"), NULL);
823 DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
824 N_("Set base file for incremental linking"
825 " (default is output file)"),
828 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
829 N_("Assume files changed"), NULL);
831 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
832 N_("Assume files didn't change"), NULL);
834 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
835 N_("Use timestamps to check files (default)"), NULL);
837 DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
838 N_("Assume startup files unchanged "
839 "(files preceding this option)"), NULL);
841 DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
842 N_("Amount of extra space to allocate for patches"),
845 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
846 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
848 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
849 N_("Read only symbol values from FILE"), N_("FILE"));
851 DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
853 N_("Map whole files to memory (default on 64-bit hosts)"),
854 N_("Map relevant file parts to memory (default on 32-bit "
856 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
857 N_("Keep files mapped across passes (default)"),
858 N_("Release mapped files after each pass"));
860 DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
861 N_("Generate unwind information for PLT (default)"),
862 N_("Do not generate unwind information for PLT"));
864 DEFINE_special(library, options::TWO_DASHES, 'l',
865 N_("Search for library LIBNAME"), N_("LIBNAME"));
867 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
868 N_("Add directory to search path"), N_("DIR"));
870 DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
871 N_(" Only search directories specified on the command line."),
874 DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
875 N_(" Put read-only non-executable sections in their own segment"),
878 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
879 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
881 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
882 N_("Write map file on standard output"), NULL);
883 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
886 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
887 N_("Do not page align data"), NULL);
888 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
889 N_("Do not page align data, do not make text readonly"),
890 N_("Page align data, make text readonly"));
892 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
893 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
894 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
896 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
897 N_("Create an output file even if errors occur"), NULL);
899 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
900 N_("Report undefined symbols (even with --shared)"),
903 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
904 N_("Set output file name"), N_("FILE"));
906 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
907 N_("Optimize output file size"), N_("LEVEL"));
909 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
910 N_("Set output format"), N_("[binary]"));
912 DEFINE_bool(p, options::ONE_DASH, '\0', false,
913 N_("(ARM only) Ignore for backward compatibility"), NULL);
915 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
916 N_("Create a position independent executable"), NULL);
917 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
918 N_("Create a position independent executable"), NULL,
921 DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
922 NULL, N_("(ARM only) Ignore for backward compatibility"));
924 #ifdef ENABLE_PLUGINS
925 DEFINE_special(plugin, options::TWO_DASHES, '\0',
926 N_("Load a plugin library"), N_("PLUGIN"));
927 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
928 N_("Pass an option to the plugin"), N_("OPTION"));
931 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
932 N_("Preread archive symbols when multi-threaded"), NULL);
934 DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
935 N_("Print default output format"), NULL);
937 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
938 N_("Print symbols defined and used for each input"),
941 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
942 N_("Ignored for SVR4 compatibility"), NULL);
944 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
945 N_("Generate relocations in output"), NULL);
947 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
948 N_("Generate relocatable output"), NULL);
949 DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
950 N_("Synonym for -r"), NULL, false);
952 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
953 N_("Relax branches on certain targets"), NULL);
955 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
956 N_("keep only symbols listed in this file"), N_("FILE"));
958 // -R really means -rpath, but can mean --just-symbols for
959 // compatibility with GNU ld. -rpath is always -rpath, so we list
961 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
962 N_("Add DIR to runtime search path"), N_("DIR"));
964 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
965 N_("Add DIR to runtime search path"), N_("DIR"));
967 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
968 N_("Add DIR to link time shared library search path"),
971 DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
972 N_("Layout sections in the order specified."),
975 DEFINE_special(section_start, options::TWO_DASHES, '\0',
976 N_("Set address of section"), N_("SECTION=ADDRESS"));
978 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
979 N_("Sort common symbols by alignment"),
980 N_("[={ascending,descending}]"));
982 DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
983 N_("Dynamic tag slots to reserve (default 5)"),
986 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
987 N_("Strip all symbols"), NULL);
988 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
989 N_("Strip debugging information"), NULL);
990 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
991 N_("Emit only debug line number information"), NULL);
992 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
993 N_("Strip debug symbols that are unused by gdb "
994 "(at least versions <= 6.7)"), NULL);
995 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
996 N_("Strip LTO intermediate code sections"), NULL);
998 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
999 N_("(ARM only) The maximum distance from instructions in a group "
1000 "of sections to their stubs. Negative values mean stubs "
1001 "are always after the group. 1 means using default size.\n"),
1004 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
1005 N_("Use less memory and more disk I/O "
1006 "(included only for compatibility with GNU ld)"), NULL);
1008 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
1009 N_("Generate shared library"), NULL);
1011 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
1012 N_("Generate shared library"), NULL);
1014 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
1015 N_("Stack size when -fsplit-stack function calls non-split"),
1018 // This is not actually special in any way, but I need to give it
1019 // a non-standard accessor-function name because 'static' is a keyword.
1020 DEFINE_special(static, options::ONE_DASH, '\0',
1021 N_("Do not link against shared libraries"), NULL);
1023 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
1024 N_("Identical Code Folding. "
1025 "\'--icf=safe\' Folds ctors, dtors and functions whose"
1026 " pointers are definitely not taken."),
1027 ("[none,all,safe]"),
1028 {"none", "all", "safe"});
1030 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
1031 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
1033 DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
1034 N_("List folded identical sections on stderr"),
1035 N_("Do not list folded identical sections"));
1037 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
1038 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1040 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
1041 N_("Remove unused sections"),
1042 N_("Don't remove unused sections (default)"));
1044 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
1045 N_("List removed unused sections on stderr"),
1046 N_("Do not list removed unused sections"));
1048 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
1049 N_("Print resource usage statistics"), NULL);
1051 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
1052 N_("Set target system root directory"), N_("DIR"));
1054 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1055 N_("Print the name of each input file"), NULL);
1057 DEFINE_special(script, options::TWO_DASHES, 'T',
1058 N_("Read linker script"), N_("FILE"));
1060 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
1061 N_("Run the linker multi-threaded"),
1062 N_("Do not run the linker multi-threaded"));
1063 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
1064 N_("Number of threads to use"), N_("COUNT"));
1065 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
1066 N_("Number of threads to use in initial pass"), N_("COUNT"));
1067 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
1068 N_("Number of threads to use in middle pass"), N_("COUNT"));
1069 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
1070 N_("Number of threads to use in final pass"), N_("COUNT"));
1072 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1073 N_("Set the address of the bss segment"), N_("ADDRESS"));
1074 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1075 N_("Set the address of the data segment"), N_("ADDRESS"));
1076 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1077 N_("Set the address of the text segment"), N_("ADDRESS"));
1079 DEFINE_set(undefined, options::TWO_DASHES, 'u',
1080 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1082 DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1083 N_("How to handle unresolved symbols"),
1084 ("ignore-all,report-all,ignore-in-object-files,"
1085 "ignore-in-shared-libs"),
1086 {"ignore-all", "report-all", "ignore-in-object-files",
1087 "ignore-in-shared-libs"});
1089 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1090 N_("Synonym for --debug=files"), NULL);
1092 DEFINE_special(version_script, options::TWO_DASHES, '\0',
1093 N_("Read version script"), N_("FILE"));
1095 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1096 N_("Warn about duplicate common symbols"),
1097 N_("Do not warn about duplicate common symbols (default)"));
1099 DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1100 N_("Ignored"), N_("Ignored"));
1102 DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1103 N_("Warn if the stack is executable"),
1104 N_("Do not warn if the stack is executable (default)"));
1106 DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1107 NULL, N_("Don't warn about mismatched input files"));
1109 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1110 N_("Ignored"), NULL);
1112 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1113 N_("Warn when skipping an incompatible library"),
1114 N_("Don't warn when skipping an incompatible library"));
1116 DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1117 N_("Warn if text segment is not shareable"),
1118 N_("Do not warn if text segment is not shareable (default)"));
1120 DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1121 N_("Report unresolved symbols as warnings"),
1123 DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1124 options::TWO_DASHES, '\0',
1125 N_("Report unresolved symbols as errors"),
1128 DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1129 N_("(ARM only) Do not warn about objects with incompatible "
1132 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1133 N_("Include all archive contents"),
1134 N_("Include only needed archive contents"));
1136 DEFINE_set(wrap, options::TWO_DASHES, '\0',
1137 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1139 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1140 N_("Trace references to symbol"), N_("SYMBOL"));
1142 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1143 N_("Allow unused version in script (default)"),
1144 N_("Do not allow unused version in script"));
1146 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1147 N_("Default search path for Solaris compatibility"),
1150 DEFINE_special(start_group, options::TWO_DASHES, '(',
1151 N_("Start a library search group"), NULL);
1152 DEFINE_special(end_group, options::TWO_DASHES, ')',
1153 N_("End a library search group"), NULL);
1156 DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1157 N_("Start a library"), NULL);
1158 DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1159 N_("End a library "), NULL);
1163 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1164 N_("Sort dynamic relocs"),
1165 N_("Do not sort dynamic relocs"));
1166 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1167 N_("Set common page size to SIZE"), N_("SIZE"));
1168 DEFINE_bool(defs, options::DASH_Z, '\0', false,
1169 N_("Report undefined symbols (even with --shared)"),
1171 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1172 N_("Mark output as requiring executable stack"), NULL);
1173 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1174 N_("Mark DSO to be initialized first at runtime"),
1176 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1177 N_("Mark object to interpose all DSOs but executable"),
1179 DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1180 N_("Mark object for lazy runtime binding (default)"),
1182 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1183 N_("Mark object requiring immediate process"),
1185 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1186 N_("Set maximum page size to SIZE"), N_("SIZE"));
1187 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1188 N_("Allow multiple definitions of symbols"),
1190 // copyreloc is here in the list because there is only -z
1191 // nocopyreloc, not -z copyreloc.
1192 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1194 N_("Do not create copy relocs"));
1195 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1196 N_("Mark object not to use default search paths"),
1198 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1199 N_("Mark DSO non-deletable at runtime"),
1201 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1202 N_("Mark DSO not available to dlopen"),
1204 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1205 N_("Mark DSO not available to dldump"),
1207 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1208 N_("Mark output as not requiring executable stack"), NULL);
1209 DEFINE_bool(now, options::DASH_Z, '\0', false,
1210 N_("Mark object for immediate function binding"),
1212 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1213 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1214 "processing at runtime"), NULL);
1215 DEFINE_bool(relro, options::DASH_Z, '\0', false,
1216 N_("Where possible mark variables read-only after relocation"),
1217 N_("Don't mark variables read-only after relocation"));
1218 DEFINE_bool(text, options::DASH_Z, '\0', false,
1219 N_("Do not permit relocations in read-only segments"),
1220 N_("Permit relocations in read-only segments (default)"));
1221 DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1222 N_("Permit relocations in read-only segments (default)"),
1226 typedef options::Dir_list Dir_list;
1230 // Does post-processing on flags, making sure they all have
1231 // non-conflicting values. Also converts some flags from their
1232 // "standard" types (string, etc), to another type (enum, DirList),
1233 // which can be accessed via a separate method. Dies if it notices
1237 // True if we printed the version information.
1239 printed_version() const
1240 { return this->printed_version_; }
1242 // The macro defines output() (based on --output), but that's a
1243 // generic name. Provide this alternative name, which is clearer.
1245 output_file_name() const
1246 { return this->output(); }
1248 // This is not defined via a flag, but combines flags to say whether
1249 // the output is position-independent or not.
1251 output_is_position_independent() const
1252 { return this->shared() || this->pie(); }
1254 // Return true if the output is something that can be exec()ed, such
1255 // as a static executable, or a position-dependent or
1256 // position-independent executable, but not a dynamic library or an
1259 output_is_executable() const
1260 { return !this->shared() && !this->relocatable(); }
1262 // This would normally be static(), and defined automatically, but
1263 // since static is a keyword, we need to come up with our own name.
1268 // In addition to getting the input and output formats as a string
1269 // (via format() and oformat()), we also give access as an enum.
1274 // Straight binary format.
1275 OBJECT_FORMAT_BINARY
1278 // Convert a string to an Object_format. Gives an error if the
1279 // string is not recognized.
1280 static Object_format
1281 string_to_object_format(const char* arg);
1283 // Note: these functions are not very fast.
1284 Object_format format_enum() const;
1285 Object_format oformat_enum() const;
1287 // Return whether FILENAME is in a system directory.
1289 is_in_system_directory(const std::string& name) const;
1291 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1293 should_retain_symbol(const char* symbol_name) const
1295 if (symbols_to_retain_.empty()) // means flag wasn't specified
1297 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1300 // These are the best way to get access to the execstack state,
1301 // not execstack() and noexecstack() which are hard to use properly.
1303 is_execstack_set() const
1304 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1307 is_stack_executable() const
1308 { return this->execstack_status_ == EXECSTACK_YES; }
1312 { return this->icf_status_ != ICF_NONE; }
1315 icf_safe_folding() const
1316 { return this->icf_status_ == ICF_SAFE; }
1318 // The --demangle option takes an optional string, and there is also
1319 // a --no-demangle option. This is the best way to decide whether
1320 // to demangle or not.
1323 { return this->do_demangle_; }
1325 // Returns TRUE if any plugin libraries have been loaded.
1328 { return this->plugins_ != NULL; }
1330 // Return a pointer to the plugin manager.
1333 { return this->plugins_; }
1335 // True iff SYMBOL was found in the file specified by dynamic-list.
1337 in_dynamic_list(const char* symbol) const
1338 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1340 // Finalize the dynamic list.
1342 finalize_dynamic_list()
1343 { this->dynamic_list_.version_script_info()->finalize(); }
1345 // The mode selected by the --incremental options.
1346 enum Incremental_mode
1348 // No incremental linking (--no-incremental).
1350 // Incremental update only (--incremental-update).
1352 // Force a full link, but prepare for subsequent incremental link
1353 // (--incremental-full).
1355 // Incremental update if possible, fallback to full link (--incremental).
1359 // The incremental linking mode.
1361 incremental_mode() const
1362 { return this->incremental_mode_; }
1364 // The disposition given by the --incremental-changed,
1365 // --incremental-unchanged or --incremental-unknown option. The
1366 // value may change as we proceed parsing the command line flags.
1367 Incremental_disposition
1368 incremental_disposition() const
1369 { return this->incremental_disposition_; }
1371 // The disposition to use for startup files (those that precede the
1372 // first --incremental-changed, etc. option).
1373 Incremental_disposition
1374 incremental_startup_disposition() const
1375 { return this->incremental_startup_disposition_; }
1377 // Return true if S is the name of a library excluded from automatic
1380 check_excluded_libs(const std::string &s) const;
1382 // If an explicit start address was given for section SECNAME with
1383 // the --section-start option, return true and set *PADDR to the
1384 // address. Otherwise return false.
1386 section_start(const char* secname, uint64_t* paddr) const;
1390 // Leave original instruction.
1392 // Replace instruction.
1394 // Generate an interworking veneer.
1395 FIX_V4BX_INTERWORKING
1400 { return (this->fix_v4bx_); }
1411 { return this->endianness_; }
1414 // Don't copy this structure.
1415 General_options(const General_options&);
1416 General_options& operator=(const General_options&);
1418 // Whether to mark the stack as executable.
1421 // Not set on command line.
1422 EXECSTACK_FROM_INPUT,
1423 // Mark the stack as executable (-z execstack).
1425 // Mark the stack as not executable (-z noexecstack).
1431 // Do not fold any functions (Default or --icf=none).
1433 // All functions are candidates for folding. (--icf=all).
1435 // Only ctors and dtors are candidates for folding. (--icf=safe).
1440 set_icf_status(Icf_status value)
1441 { this->icf_status_ = value; }
1444 set_execstack_status(Execstack value)
1445 { this->execstack_status_ = value; }
1448 set_do_demangle(bool value)
1449 { this->do_demangle_ = value; }
1452 set_static(bool value)
1453 { static_ = value; }
1455 // These are called by finalize() to set up the search-path correctly.
1457 add_to_library_path_with_sysroot(const char* arg)
1458 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1460 // Apply any sysroot to the directory lists.
1464 // Add a plugin and its arguments to the list of plugins.
1466 add_plugin(const char* filename);
1468 // Add a plugin option.
1470 add_plugin_option(const char* opt);
1472 // Whether we printed version information.
1473 bool printed_version_;
1474 // Whether to mark the stack as executable.
1475 Execstack execstack_status_;
1476 // Whether to do code folding.
1477 Icf_status icf_status_;
1478 // Whether to do a static link.
1480 // Whether to do demangling.
1482 // List of plugin libraries.
1483 Plugin_manager* plugins_;
1484 // The parsed output of --dynamic-list files. For convenience in
1485 // script.cc, we store this as a Script_options object, even though
1486 // we only use a single Version_tree from it.
1487 Script_options dynamic_list_;
1488 // The incremental linking mode.
1489 Incremental_mode incremental_mode_;
1490 // The disposition given by the --incremental-changed,
1491 // --incremental-unchanged or --incremental-unknown option. The
1492 // value may change as we proceed parsing the command line flags.
1493 Incremental_disposition incremental_disposition_;
1494 // The disposition to use for startup files (those marked
1495 // INCREMENTAL_STARTUP).
1496 Incremental_disposition incremental_startup_disposition_;
1497 // Whether we have seen one of the options that require incremental
1498 // build (--incremental-changed, --incremental-unchanged,
1499 // --incremental-unknown, or --incremental-startup-unchanged).
1500 bool implicit_incremental_;
1501 // Libraries excluded from automatic export, via --exclude-libs.
1502 Unordered_set<std::string> excluded_libs_;
1503 // List of symbol-names to keep, via -retain-symbol-info.
1504 Unordered_set<std::string> symbols_to_retain_;
1505 // Map from section name to address from --section-start.
1506 std::map<std::string, uint64_t> section_starts_;
1507 // Whether to process armv4 bx instruction relocation.
1510 Endianness endianness_;
1513 // The position-dependent options. We use this to store the state of
1514 // the commandline at a particular point in parsing for later
1515 // reference. For instance, if we see "ld --whole-archive foo.a
1516 // --no-whole-archive," we want to store the whole-archive option with
1517 // foo.a, so when the time comes to parse foo.a we know we should do
1518 // it in whole-archive mode. We could store all of General_options,
1519 // but that's big, so we just pick the subset of flags that actually
1520 // change in a position-dependent way.
1522 #define DEFINE_posdep(varname__, type__) \
1526 { return this->varname__##_; } \
1529 set_##varname__(type__ value) \
1530 { this->varname__##_ = value; } \
1534 class Position_dependent_options
1537 Position_dependent_options(const General_options& options
1538 = Position_dependent_options::default_options_)
1539 { copy_from_options(options); }
1541 void copy_from_options(const General_options& options)
1543 this->set_as_needed(options.as_needed());
1544 this->set_Bdynamic(options.Bdynamic());
1545 this->set_format_enum(options.format_enum());
1546 this->set_whole_archive(options.whole_archive());
1547 this->set_incremental_disposition(options.incremental_disposition());
1550 DEFINE_posdep(as_needed, bool);
1551 DEFINE_posdep(Bdynamic, bool);
1552 DEFINE_posdep(format_enum, General_options::Object_format);
1553 DEFINE_posdep(whole_archive, bool);
1554 DEFINE_posdep(incremental_disposition, Incremental_disposition);
1557 // This is a General_options with everything set to its default
1558 // value. A Position_dependent_options created with no argument
1559 // will take its values from here.
1560 static General_options default_options_;
1564 // A single file or library argument from the command line.
1566 class Input_file_argument
1569 enum Input_file_type
1571 // A regular file, name used as-is, not searched.
1572 INPUT_FILE_TYPE_FILE,
1573 // A library name. When used, "lib" will be prepended and ".so" or
1574 // ".a" appended to make a filename, and that filename will be searched
1575 // for using the -L paths.
1576 INPUT_FILE_TYPE_LIBRARY,
1577 // A regular file, name used as-is, but searched using the -L paths.
1578 INPUT_FILE_TYPE_SEARCHED_FILE
1581 // name: file name or library name
1582 // type: the type of this input file.
1583 // extra_search_path: an extra directory to look for the file, prior
1584 // to checking the normal library search path. If this is "",
1585 // then no extra directory is added.
1586 // just_symbols: whether this file only defines symbols.
1587 // options: The position dependent options at this point in the
1588 // command line, such as --whole-archive.
1589 Input_file_argument()
1590 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1591 just_symbols_(false), options_(), arg_serial_(0)
1594 Input_file_argument(const char* name, Input_file_type type,
1595 const char* extra_search_path,
1597 const Position_dependent_options& options)
1598 : name_(name), type_(type), extra_search_path_(extra_search_path),
1599 just_symbols_(just_symbols), options_(options), arg_serial_(0)
1602 // You can also pass in a General_options instance instead of a
1603 // Position_dependent_options. In that case, we extract the
1604 // position-independent vars from the General_options and only store
1606 Input_file_argument(const char* name, Input_file_type type,
1607 const char* extra_search_path,
1609 const General_options& options)
1610 : name_(name), type_(type), extra_search_path_(extra_search_path),
1611 just_symbols_(just_symbols), options_(options), arg_serial_(0)
1616 { return this->name_.c_str(); }
1618 const Position_dependent_options&
1620 { return this->options_; }
1624 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1627 is_searched_file() const
1628 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1631 extra_search_path() const
1633 return (this->extra_search_path_.empty()
1635 : this->extra_search_path_.c_str());
1638 // Return whether we should only read symbols from this file.
1640 just_symbols() const
1641 { return this->just_symbols_; }
1643 // Return whether this file may require a search using the -L
1646 may_need_search() const
1648 return (this->is_lib()
1649 || this->is_searched_file()
1650 || !this->extra_search_path_.empty());
1653 // Set the serial number for this argument.
1655 set_arg_serial(unsigned int arg_serial)
1656 { this->arg_serial_ = arg_serial; }
1658 // Get the serial number.
1661 { return this->arg_serial_; }
1664 // We use std::string, not const char*, here for convenience when
1665 // using script files, so that we do not have to preserve the string
1668 Input_file_type type_;
1669 std::string extra_search_path_;
1671 Position_dependent_options options_;
1672 // A unique index for this file argument in the argument list.
1673 unsigned int arg_serial_;
1676 // A file or library, or a group, from the command line.
1678 class Input_argument
1681 // Create a file or library argument.
1682 explicit Input_argument(Input_file_argument file)
1683 : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
1686 // Create a group argument.
1687 explicit Input_argument(Input_file_group* group)
1688 : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
1691 // Create a lib argument.
1692 explicit Input_argument(Input_file_lib* lib)
1693 : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
1696 // Return whether this is a file.
1699 { return this->is_file_; }
1701 // Return whether this is a group.
1704 { return !this->is_file_ && this->lib_ == NULL; }
1706 // Return whether this is a lib.
1709 { return this->lib_ != NULL; }
1711 // Return the information about the file.
1712 const Input_file_argument&
1715 gold_assert(this->is_file_);
1719 // Return the information about the group.
1720 const Input_file_group*
1723 gold_assert(!this->is_file_);
1724 return this->group_;
1730 gold_assert(!this->is_file_);
1731 return this->group_;
1734 // Return the information about the lib.
1735 const Input_file_lib*
1738 gold_assert(!this->is_file_);
1739 gold_assert(this->lib_);
1746 gold_assert(!this->is_file_);
1747 gold_assert(this->lib_);
1751 // If a script generated this argument, store a pointer to the script info.
1752 // Currently used only for recording incremental link information.
1754 set_script_info(Script_info* info)
1755 { this->script_info_ = info; }
1759 { return this->script_info_; }
1763 Input_file_argument file_;
1764 Input_file_group* group_;
1765 Input_file_lib* lib_;
1766 Script_info* script_info_;
1769 typedef std::vector<Input_argument> Input_argument_list;
1771 // A group from the command line. This is a set of arguments within
1772 // --start-group ... --end-group.
1774 class Input_file_group
1777 typedef Input_argument_list::const_iterator const_iterator;
1783 // Add a file to the end of the group.
1785 add_file(const Input_file_argument& arg)
1787 this->files_.push_back(Input_argument(arg));
1788 return this->files_.back();
1791 // Iterators to iterate over the group contents.
1795 { return this->files_.begin(); }
1799 { return this->files_.end(); }
1802 Input_argument_list files_;
1805 // A lib from the command line. This is a set of arguments within
1806 // --start-lib ... --end-lib.
1808 class Input_file_lib
1811 typedef Input_argument_list::const_iterator const_iterator;
1813 Input_file_lib(const Position_dependent_options& options)
1814 : files_(), options_(options)
1817 // Add a file to the end of the lib.
1819 add_file(const Input_file_argument& arg)
1821 this->files_.push_back(Input_argument(arg));
1822 return this->files_.back();
1825 const Position_dependent_options&
1827 { return this->options_; }
1829 // Iterators to iterate over the lib contents.
1833 { return this->files_.begin(); }
1837 { return this->files_.end(); }
1841 { return this->files_.size(); }
1844 Input_argument_list files_;
1845 Position_dependent_options options_;
1848 // A list of files from the command line or a script.
1850 class Input_arguments
1853 typedef Input_argument_list::const_iterator const_iterator;
1856 : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
1861 add_file(Input_file_argument& arg);
1863 // Start a group (the --start-group option).
1867 // End a group (the --end-group option).
1871 // Start a lib (the --start-lib option).
1873 start_lib(const Position_dependent_options&);
1875 // End a lib (the --end-lib option).
1879 // Return whether we are currently in a group.
1882 { return this->in_group_; }
1884 // Return whether we are currently in a lib.
1887 { return this->in_lib_; }
1889 // The number of entries in the list.
1892 { return this->input_argument_list_.size(); }
1894 // Iterators to iterate over the list of input files.
1898 { return this->input_argument_list_.begin(); }
1902 { return this->input_argument_list_.end(); }
1904 // Return whether the list is empty.
1907 { return this->input_argument_list_.empty(); }
1909 // Return the number of input files. This may be larger than
1910 // input_argument_list_.size(), because of files that are part
1911 // of groups or libs.
1913 number_of_input_files() const
1914 { return this->file_count_; }
1917 Input_argument_list input_argument_list_;
1920 unsigned int file_count_;
1924 // All the information read from the command line. These are held in
1925 // three separate structs: one to hold the options (--foo), one to
1926 // hold the filenames listed on the commandline, and one to hold
1927 // linker script information. This third is not a subset of the other
1928 // two because linker scripts can be specified either as options (via
1929 // -T) or as a file.
1934 typedef Input_arguments::const_iterator const_iterator;
1938 // Process the command line options. This will exit with an
1939 // appropriate error message if an unrecognized option is seen.
1941 process(int argc, const char** argv);
1943 // Process one command-line option. This takes the index of argv to
1944 // process, and returns the index for the next option. no_more_options
1945 // is set to true if argv[i] is "--".
1947 process_one_option(int argc, const char** argv, int i,
1948 bool* no_more_options);
1950 // Get the general options.
1951 const General_options&
1953 { return this->options_; }
1955 // Get the position dependent options.
1956 const Position_dependent_options&
1957 position_dependent_options() const
1958 { return this->position_options_; }
1960 // Get the linker-script options.
1963 { return this->script_options_; }
1965 // Finalize the version-script options and return them.
1966 const Version_script_info&
1969 // Get the input files.
1972 { return this->inputs_; }
1974 // The number of input files.
1976 number_of_input_files() const
1977 { return this->inputs_.number_of_input_files(); }
1979 // Iterators to iterate over the list of input files.
1983 { return this->inputs_.begin(); }
1987 { return this->inputs_.end(); }
1990 Command_line(const Command_line&);
1991 Command_line& operator=(const Command_line&);
1993 // This is a dummy class to provide a constructor that runs before
1994 // the constructor for the General_options. The Pre_options constructor
1995 // is used as a hook to set the flag enabling the options to register
1997 struct Pre_options {
2001 // This must come before options_!
2002 Pre_options pre_options_;
2003 General_options options_;
2004 Position_dependent_options position_options_;
2005 Script_options script_options_;
2006 Input_arguments inputs_;
2009 } // End namespace gold.
2011 #endif // !defined(GOLD_OPTIONS_H)