1 // options.h -- handle command line options for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
6 // This file is part of gold.
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
23 // General_options (from Command_line::options())
24 // All the options (a.k.a. command-line flags)
25 // Input_argument (from Command_line::inputs())
26 // The list of input files, including -l options.
28 // Everything we get from the command line -- the General_options
29 // plus the Input_arguments.
31 // There are also some smaller classes, such as
32 // Position_dependent_options which hold a subset of General_options
33 // that change as options are parsed (as opposed to the usual behavior
34 // of the last instance of that option specified on the commandline wins).
36 #ifndef GOLD_OPTIONS_H
37 #define GOLD_OPTIONS_H
53 class General_options;
54 class Search_directory;
55 class Input_file_group;
57 class Position_dependent_options;
61 // Incremental build action for a specific file, as selected by the user.
63 enum Incremental_disposition
65 // Determine the status from the timestamp (default).
67 // Assume the file changed from the previous build.
69 // Assume the file didn't change from the previous build.
73 // The nested namespace is to contain all the global variables and
74 // structs that need to be defined in the .h file, but do not need to
75 // be used outside this class.
78 typedef std::vector<Search_directory> Dir_list;
79 typedef Unordered_set<std::string> String_set;
81 // These routines convert from a string option to various types.
82 // Each gives a fatal error if it cannot parse the argument.
85 parse_bool(const char* option_name, const char* arg, bool* retval);
88 parse_int(const char* option_name, const char* arg, int* retval);
91 parse_uint(const char* option_name, const char* arg, int* retval);
94 parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
97 parse_double(const char* option_name, const char* arg, double* retval);
100 parse_string(const char* option_name, const char* arg, const char** retval);
103 parse_optional_string(const char* option_name, const char* arg,
104 const char** retval);
107 parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
110 parse_set(const char* option_name, const char* arg, String_set* retval);
113 parse_choices(const char* option_name, const char* arg, const char** retval,
114 const char* choices[], int num_choices);
118 // Most options have both a shortname (one letter) and a longname.
119 // This enum controls how many dashes are expected for longname access
120 // -- shortnames always use one dash. Most longnames will accept
121 // either one dash or two; the only difference between ONE_DASH and
122 // TWO_DASHES is how we print the option in --help. However, some
123 // longnames require two dashes, and some require only one. The
124 // special value DASH_Z means that the option is preceded by "-z".
127 ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z
130 // LONGNAME is the long-name of the option with dashes converted to
131 // underscores, or else the short-name if the option has no long-name.
132 // It is never the empty string.
133 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
134 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
135 // option has no short-name. If the option has no long-name, you
136 // should specify the short-name in *both* VARNAME and here.
137 // DEFAULT_VALUE is the value of the option if not specified on the
138 // commandline, as a string.
139 // HELPSTRING is the descriptive text used with the option via --help
140 // HELPARG is how you define the argument to the option.
141 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
142 // HELPARG should be NULL iff the option is a bool and takes no arg.
143 // OPTIONAL_ARG is true if this option takes an optional argument. An
144 // optional argument must be specifid as --OPTION=VALUE, not
146 // READER provides parse_to_value, which is a function that will convert
147 // a char* argument into the proper type and store it in some variable.
148 // A One_option struct initializes itself with the global list of options
149 // at constructor time, so be careful making one of these.
152 std::string longname;
155 const char* default_value;
156 const char* helpstring;
161 One_option(const char* ln, Dashes d, char sn, const char* dv,
162 const char* hs, const char* ha, bool oa, Struct_var* r)
163 : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
164 helpstring(hs), helparg(ha), optional_arg(oa), reader(r)
166 // In longname, we convert all underscores to dashes, since GNU
167 // style uses dashes in option names. longname is likely to have
168 // underscores in it because it's also used to declare a C++
170 const char* pos = strchr(this->longname.c_str(), '_');
171 for (; pos; pos = strchr(pos, '_'))
172 this->longname[pos - this->longname.c_str()] = '-';
174 // We only register ourselves if our helpstring is not NULL. This
175 // is to support the "no-VAR" boolean variables, which we
176 // conditionally turn on by defining "no-VAR" help text.
177 if (this->helpstring)
178 this->register_option();
181 // This option takes an argument iff helparg is not NULL.
183 takes_argument() const
184 { return this->helparg != NULL; }
186 // Whether the argument is optional.
188 takes_optional_argument() const
189 { return this->optional_arg; }
191 // Register this option with the global list of options.
195 // Print this option to stdout (used with --help).
200 // All options have a Struct_##varname that inherits from this and
201 // actually implements parse_to_value for that option.
204 // OPTION: the name of the option as specified on the commandline,
205 // including leading dashes, and any text following the option:
206 // "-O", "--defsym=mysym=0x1000", etc.
207 // ARG: the arg associated with this option, or NULL if the option
208 // takes no argument: "2", "mysym=0x1000", etc.
209 // CMDLINE: the global Command_line object. Used by DEFINE_special.
210 // OPTIONS: the global General_options object. Used by DEFINE_special.
212 parse_to_value(const char* option, const char* arg,
213 Command_line* cmdline, General_options* options) = 0;
215 ~Struct_var() // To make gcc happy.
219 // This is for "special" options that aren't of any predefined type.
220 struct Struct_special : public Struct_var
222 // If you change this, change the parse-fn in DEFINE_special as well.
223 typedef void (General_options::*Parse_function)(const char*, const char*,
225 Struct_special(const char* varname, Dashes dashes, char shortname,
226 Parse_function parse_function,
227 const char* helpstring, const char* helparg)
228 : option(varname, dashes, shortname, "", helpstring, helparg, false, this),
229 parse(parse_function)
232 void parse_to_value(const char* option, const char* arg,
233 Command_line* cmdline, General_options* options)
234 { (options->*(this->parse))(option, arg, cmdline); }
237 Parse_function parse;
240 } // End namespace options.
243 // These are helper macros use by DEFINE_uint64/etc below.
244 // This macro is used inside the General_options_ class, so defines
245 // var() and set_var() as General_options methods. Arguments as are
246 // for the constructor for One_option. param_type__ is the same as
247 // type__ for built-in types, and "const type__ &" otherwise.
249 // When we define the linker command option "assert", the macro argument
250 // varname__ of DEFINE_var below will be replaced by "assert". On Mac OSX
251 // assert.h is included implicitly by one of the library headers we use. To
252 // avoid unintended macro substitution of "assert()", we need to enclose
253 // varname__ with parenthese.
254 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
255 default_value_as_string__, helpstring__, helparg__, \
256 optional_arg__, type__, param_type__, parse_fn__) \
259 (varname__)() const \
260 { return this->varname__##_.value; } \
263 user_set_##varname__() const \
264 { return this->varname__##_.user_set_via_option; } \
267 set_user_set_##varname__() \
268 { this->varname__##_.user_set_via_option = true; } \
271 struct Struct_##varname__ : public options::Struct_var \
273 Struct_##varname__() \
274 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
275 helpstring__, helparg__, optional_arg__, this), \
276 user_set_via_option(false), value(default_value__) \
280 parse_to_value(const char* option_name, const char* arg, \
281 Command_line*, General_options*) \
283 parse_fn__(option_name, arg, &this->value); \
284 this->user_set_via_option = true; \
287 options::One_option option; \
288 bool user_set_via_option; \
291 Struct_##varname__ varname__##_; \
293 set_##varname__(param_type__ value) \
294 { this->varname__##_.value = value; }
296 // These macros allow for easy addition of a new commandline option.
298 // If no_helpstring__ is not NULL, then in addition to creating
299 // VARNAME, we also create an option called no-VARNAME (or, for a -z
300 // option, noVARNAME).
301 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
302 helpstring__, no_helpstring__) \
303 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
304 default_value__ ? "true" : "false", helpstring__, NULL, \
305 false, bool, bool, options::parse_bool) \
306 struct Struct_no_##varname__ : public options::Struct_var \
308 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
310 : "no-" #varname__), \
312 default_value__ ? "false" : "true", \
313 no_helpstring__, NULL, false, this) \
317 parse_to_value(const char*, const char*, \
318 Command_line*, General_options* options) \
320 options->set_##varname__(false); \
321 options->set_user_set_##varname__(); \
324 options::One_option option; \
326 Struct_no_##varname__ no_##varname__##_initializer_
328 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
329 helpstring__, no_helpstring__) \
330 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
331 default_value__ ? "true" : "false", helpstring__, NULL, \
332 false, bool, bool, options::parse_bool) \
333 struct Struct_disable_##varname__ : public options::Struct_var \
335 Struct_disable_##varname__() : option("disable-" #varname__, \
337 default_value__ ? "false" : "true", \
338 no_helpstring__, NULL, false, this) \
342 parse_to_value(const char*, const char*, \
343 Command_line*, General_options* options) \
344 { options->set_enable_##varname__(false); } \
346 options::One_option option; \
348 Struct_disable_##varname__ disable_##varname__##_initializer_
350 #define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
351 helpstring__, helparg__) \
352 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
353 #default_value__, helpstring__, helparg__, false, \
354 int, int, options::parse_int)
356 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
357 helpstring__, helparg__) \
358 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
359 #default_value__, helpstring__, helparg__, false, \
360 int, int, options::parse_uint)
362 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
363 helpstring__, helparg__) \
364 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
365 #default_value__, helpstring__, helparg__, false, \
366 uint64_t, uint64_t, options::parse_uint64)
368 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
369 helpstring__, helparg__) \
370 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
371 #default_value__, helpstring__, helparg__, false, \
372 double, double, options::parse_double)
374 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
375 helpstring__, helparg__) \
376 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
377 default_value__, helpstring__, helparg__, false, \
378 const char*, const char*, options::parse_string)
380 // This is like DEFINE_string, but we convert each occurrence to a
381 // Search_directory and store it in a vector. Thus we also have the
382 // add_to_VARNAME() method, to append to the vector.
383 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
384 helpstring__, helparg__) \
385 DEFINE_var(varname__, dashes__, shortname__, , \
386 "", helpstring__, helparg__, false, options::Dir_list, \
387 const options::Dir_list&, options::parse_dirlist) \
389 add_to_##varname__(const char* new_value) \
390 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
392 add_search_directory_to_##varname__(const Search_directory& dir) \
393 { this->varname__##_.value.push_back(dir); }
395 // This is like DEFINE_string, but we store a set of strings.
396 #define DEFINE_set(varname__, dashes__, shortname__, \
397 helpstring__, helparg__) \
398 DEFINE_var(varname__, dashes__, shortname__, , \
399 "", helpstring__, helparg__, false, options::String_set, \
400 const options::String_set&, options::parse_set) \
403 any_##varname__() const \
404 { return !this->varname__##_.value.empty(); } \
407 is_##varname__(const char* symbol) const \
409 return (!this->varname__##_.value.empty() \
410 && (this->varname__##_.value.find(std::string(symbol)) \
411 != this->varname__##_.value.end())); \
414 options::String_set::const_iterator \
415 varname__##_begin() const \
416 { return this->varname__##_.value.begin(); } \
418 options::String_set::const_iterator \
419 varname__##_end() const \
420 { return this->varname__##_.value.end(); }
422 // When you have a list of possible values (expressed as string)
423 // After helparg__ should come an initializer list, like
424 // {"foo", "bar", "baz"}
425 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
426 helpstring__, helparg__, ...) \
427 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
428 default_value__, helpstring__, helparg__, false, \
429 const char*, const char*, parse_choices_##varname__) \
431 static void parse_choices_##varname__(const char* option_name, \
433 const char** retval) { \
434 const char* choices[] = __VA_ARGS__; \
435 options::parse_choices(option_name, arg, retval, \
436 choices, sizeof(choices) / sizeof(*choices)); \
439 // This is like DEFINE_bool, but VARNAME is the name of a different
440 // option. This option becomes an alias for that one. INVERT is true
441 // if this option is an inversion of the other one.
442 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
443 helpstring__, no_helpstring__, invert__) \
445 struct Struct_##option__ : public options::Struct_var \
447 Struct_##option__() \
448 : option(#option__, dashes__, shortname__, "", helpstring__, \
453 parse_to_value(const char*, const char*, \
454 Command_line*, General_options* options) \
456 options->set_##varname__(!invert__); \
457 options->set_user_set_##varname__(); \
460 options::One_option option; \
462 Struct_##option__ option__##_; \
464 struct Struct_no_##option__ : public options::Struct_var \
466 Struct_no_##option__() \
467 : option((dashes__ == options::DASH_Z \
469 : "no-" #option__), \
470 dashes__, '\0', "", no_helpstring__, \
475 parse_to_value(const char*, const char*, \
476 Command_line*, General_options* options) \
478 options->set_##varname__(invert__); \
479 options->set_user_set_##varname__(); \
482 options::One_option option; \
484 Struct_no_##option__ no_##option__##_initializer_
486 // This is used for non-standard flags. It defines no functions; it
487 // just calls General_options::parse_VARNAME whenever the flag is
488 // seen. We declare parse_VARNAME as a static member of
489 // General_options; you are responsible for defining it there.
490 // helparg__ should be NULL iff this special-option is a boolean.
491 #define DEFINE_special(varname__, dashes__, shortname__, \
492 helpstring__, helparg__) \
494 void parse_##varname__(const char* option, const char* arg, \
495 Command_line* inputs); \
496 struct Struct_##varname__ : public options::Struct_special \
498 Struct_##varname__() \
499 : options::Struct_special(#varname__, dashes__, shortname__, \
500 &General_options::parse_##varname__, \
501 helpstring__, helparg__) \
504 Struct_##varname__ varname__##_initializer_
506 // An option that takes an optional string argument. If the option is
507 // used with no argument, the value will be the default, and
508 // user_set_via_option will be true.
509 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
511 helpstring__, helparg__) \
512 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
513 default_value__, helpstring__, helparg__, true, \
514 const char*, const char*, options::parse_optional_string)
516 // A directory to search. For each directory we record whether it is
517 // in the sysroot. We need to know this so that, if a linker script
518 // is found within the sysroot, we will apply the sysroot to any files
519 // named by that script.
521 class Search_directory
524 // We need a default constructor because we put this in a
527 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
530 // This is the usual constructor.
531 Search_directory(const char* name, bool put_in_sysroot)
532 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
534 if (this->name_.empty())
538 // This is called if we have a sysroot. The sysroot is prefixed to
539 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
540 // set to true for any enries which are in the sysroot (this will
541 // naturally include any entries for which put_in_sysroot_ is true).
542 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
543 // passing SYSROOT to lrealpath.
545 add_sysroot(const char* sysroot, const char* canonical_sysroot);
547 // Get the directory name.
550 { return this->name_; }
552 // Return whether this directory is in the sysroot.
554 is_in_sysroot() const
555 { return this->is_in_sysroot_; }
557 // Return whether this is considered a system directory.
559 is_system_directory() const
560 { return this->put_in_sysroot_ || this->is_in_sysroot_; }
563 // The directory name.
565 // True if the sysroot should be added as a prefix for this
566 // directory (if there is a sysroot). This is true for system
567 // directories that we search by default.
568 bool put_in_sysroot_;
569 // True if this directory is in the sysroot (if there is a sysroot).
570 // This is true if there is a sysroot and either 1) put_in_sysroot_
571 // is true, or 2) the directory happens to be in the sysroot based
572 // on a pathname comparison.
576 class General_options
579 // NOTE: For every option that you add here, also consider if you
580 // should add it to Position_dependent_options.
581 DEFINE_special(help, options::TWO_DASHES, '\0',
582 N_("Report usage information"), NULL);
583 DEFINE_special(version, options::TWO_DASHES, 'v',
584 N_("Report version information"), NULL);
585 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
586 N_("Report version and target information"), NULL);
588 // These options are sorted approximately so that for each letter in
589 // the alphabet, we show the option whose shortname is that letter
590 // (if any) and then every longname that starts with that letter (in
591 // alphabetical order). For both, lowercase sorts before uppercase.
592 // The -z options come last.
594 DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
596 N_("Do not copy DT_NEEDED tags from shared libraries"));
598 DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
599 '\0', N_("Allow multiple definitions of symbols"),
600 N_("Do not allow multiple definitions"), false);
602 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
603 N_("Allow unresolved references in shared libraries"),
604 N_("Do not allow unresolved references in shared libraries"));
606 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
607 N_("Only set DT_NEEDED for shared libraries if used"),
608 N_("Always DT_NEEDED for shared libraries"));
610 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
611 N_("Ignored"), N_("[ignored]"),
612 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
614 // This should really be an "enum", but it's too easy for folks to
615 // forget to update the list as they add new targets. So we just
616 // accept any string. We'll fail later (when the string is parsed),
617 // if the target isn't actually supported.
618 DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
619 N_("Set input format"), ("[elf,binary]"));
621 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
622 N_("-l searches for shared libraries"), NULL);
623 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
624 N_("-l does not search for shared libraries"), NULL,
626 DEFINE_bool_alias(dy, Bdynamic, options::ONE_DASH, '\0',
627 N_("alias for -Bdynamic"), NULL, false);
628 DEFINE_bool_alias(dn, Bdynamic, options::ONE_DASH, '\0',
629 N_("alias for -Bstatic"), NULL, true);
631 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
632 N_("Bind defined symbols locally"), NULL);
634 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
635 N_("Bind defined function symbols locally"), NULL);
637 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
638 N_("Generate build ID note"),
641 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
642 N_("Check segment addresses for overlaps (default)"),
643 N_("Do not check segment addresses for overlaps"));
646 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
647 N_("Compress .debug_* sections in the output file"),
651 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
652 N_("Compress .debug_* sections in the output file"),
657 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
659 N_("Do not copy DT_NEEDED tags from shared libraries"));
661 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
662 N_("Output cross reference table"),
663 N_("Do not output cross reference table"));
665 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
666 N_("Define common symbols"),
667 N_("Do not define common symbols"));
668 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
669 N_("Alias for -d"), NULL);
670 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
671 N_("Alias for -d"), NULL);
673 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
674 N_("Turn on debugging"),
675 N_("[all,files,script,task][,...]"));
677 DEFINE_special(defsym, options::TWO_DASHES, '\0',
678 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
680 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
681 N_("Demangle C++ symbols in log messages"),
684 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
685 N_("Do not demangle C++ symbols in log messages"),
688 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
689 N_("Try to detect violations of the One Definition Rule"),
692 DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
693 N_("Delete all local symbols"), NULL);
694 DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
695 N_("Delete all temporary local symbols"), NULL);
697 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
698 N_("Add data symbols to dynamic symbols"), NULL);
700 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
701 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
703 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
704 N_("Add C++ typeinfo to dynamic symbols"), NULL);
706 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
707 N_("Read a list of dynamic symbols"), N_("FILE"));
709 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
710 N_("Set program start address"), N_("ADDRESS"));
712 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
713 N_("Exclude libraries from automatic export"),
714 N_(("lib,lib ...")));
716 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
717 N_("Export all dynamic symbols"),
718 N_("Do not export all dynamic symbols (default)"));
720 DEFINE_special(EB, options::ONE_DASH, '\0',
721 N_("Link big-endian objects."), NULL);
723 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
724 N_("Create exception frame header"), NULL);
726 DEFINE_special(EL, options::ONE_DASH, '\0',
727 N_("Link little-endian objects."), NULL);
729 DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
730 N_("(ARM only) Do not warn about objects with incompatible "
733 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
734 N_("Treat warnings as errors"),
735 N_("Do not treat warnings as errors"));
737 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
738 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
740 DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
741 N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
742 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
744 DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
745 N_("(ARM only) Merge exidx entries in debuginfo."),
746 N_("(ARM only) Do not merge exidx entries in debuginfo."));
748 DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
749 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
752 DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
753 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
757 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
758 N_("Ignored"), NULL);
760 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
761 N_("Set shared library name"), N_("FILENAME"));
763 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
764 N_("Min fraction of empty buckets in dynamic hash"),
767 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
768 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
769 {"sysv", "gnu", "both"});
771 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
772 N_("Set dynamic linker path"), N_("PROGRAM"));
774 DEFINE_special(incremental, options::TWO_DASHES, '\0',
775 N_("Do an incremental link if possible; "
776 "otherwise, do a full link and prepare output "
777 "for incremental linking"), NULL);
779 DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
780 N_("Do a full link (default)"), NULL);
782 DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
783 N_("Do a full link and "
784 "prepare output for incremental linking"), NULL);
786 DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
787 N_("Do an incremental link; exit if not possible"), NULL);
789 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
790 N_("Assume files changed"), NULL);
792 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
793 N_("Assume files didn't change"), NULL);
795 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
796 N_("Use timestamps to check files (default)"), NULL);
798 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
799 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
801 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
802 N_("Read only symbol values from FILE"), N_("FILE"));
804 DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
806 N_("Map whole files to memory (default on 64-bit hosts)"),
807 N_("Map relevant file parts to memory (default on 32-bit "
809 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
810 N_("Keep files mapped across passes (default)"),
811 N_("Release mapped files after each pass"));
813 DEFINE_special(library, options::TWO_DASHES, 'l',
814 N_("Search for library LIBNAME"), N_("LIBNAME"));
816 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
817 N_("Add directory to search path"), N_("DIR"));
819 DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
820 N_(" Only search directories specified on the command line."),
823 DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
824 N_(" Put read-only non-executable sections in their own segment"),
827 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
828 N_("Ignored for compatibility"), N_("EMULATION"));
830 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
831 N_("Write map file on standard output"), NULL);
832 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
835 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
836 N_("Do not page align data"), NULL);
837 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
838 N_("Do not page align data, do not make text readonly"),
839 N_("Page align data, make text readonly"));
841 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
842 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
843 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
845 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
846 N_("Create an output file even if errors occur"), NULL);
848 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
849 N_("Report undefined symbols (even with --shared)"),
852 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
853 N_("Set output file name"), N_("FILE"));
855 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
856 N_("Optimize output file size"), N_("LEVEL"));
858 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
859 N_("Set output format"), N_("[binary]"));
861 DEFINE_bool(p, options::ONE_DASH, '\0', false,
862 N_("(ARM only) Ignore for backward compatibility"), NULL);
864 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
865 N_("Create a position independent executable"), NULL);
866 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
867 N_("Create a position independent executable"), NULL,
870 DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
871 NULL, N_("(ARM only) Ignore for backward compatibility"));
873 #ifdef ENABLE_PLUGINS
874 DEFINE_special(plugin, options::TWO_DASHES, '\0',
875 N_("Load a plugin library"), N_("PLUGIN"));
876 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
877 N_("Pass an option to the plugin"), N_("OPTION"));
880 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
881 N_("Preread archive symbols when multi-threaded"), NULL);
883 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
884 N_("Print symbols defined and used for each input"),
887 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
888 N_("Ignored for SVR4 compatibility"), NULL);
890 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
891 N_("Generate relocations in output"), NULL);
893 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
894 N_("Generate relocatable output"), NULL);
895 DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
896 N_("Synonym for -r"), NULL, false);
898 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
899 N_("Relax branches on certain targets"), NULL);
901 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
902 N_("keep only symbols listed in this file"), N_("FILE"));
904 // -R really means -rpath, but can mean --just-symbols for
905 // compatibility with GNU ld. -rpath is always -rpath, so we list
907 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
908 N_("Add DIR to runtime search path"), N_("DIR"));
910 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
911 N_("Add DIR to runtime search path"), N_("DIR"));
913 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
914 N_("Add DIR to link time shared library search path"),
917 DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
918 N_("Layout sections in the order specified."),
921 DEFINE_special(section_start, options::TWO_DASHES, '\0',
922 N_("Set address of section"), N_("SECTION=ADDRESS"));
924 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
925 N_("Sort common symbols by alignment"),
926 N_("[={ascending,descending}]"));
928 DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
929 N_("Dynamic tag slots to reserve (default 5)"),
932 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
933 N_("Strip all symbols"), NULL);
934 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
935 N_("Strip debugging information"), NULL);
936 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
937 N_("Emit only debug line number information"), NULL);
938 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
939 N_("Strip debug symbols that are unused by gdb "
940 "(at least versions <= 6.7)"), NULL);
941 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
942 N_("Strip LTO intermediate code sections"), NULL);
944 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
945 N_("(ARM only) The maximum distance from instructions in a group "
946 "of sections to their stubs. Negative values mean stubs "
947 "are always after the group. 1 means using default size.\n"),
950 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
951 N_("Use less memory and more disk I/O "
952 "(included only for compatibility with GNU ld)"), NULL);
954 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
955 N_("Generate shared library"), NULL);
957 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
958 N_("Generate shared library"), NULL);
960 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
961 N_("Stack size when -fsplit-stack function calls non-split"),
964 // This is not actually special in any way, but I need to give it
965 // a non-standard accessor-function name because 'static' is a keyword.
966 DEFINE_special(static, options::ONE_DASH, '\0',
967 N_("Do not link against shared libraries"), NULL);
969 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
970 N_("Identical Code Folding. "
971 "\'--icf=safe\' Folds ctors, dtors and functions whose"
972 " pointers are definitely not taken."),
974 {"none", "all", "safe"});
976 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
977 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
979 DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
980 N_("List folded identical sections on stderr"),
981 N_("Do not list folded identical sections"));
983 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
984 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
986 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
987 N_("Remove unused sections"),
988 N_("Don't remove unused sections (default)"));
990 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
991 N_("List removed unused sections on stderr"),
992 N_("Do not list removed unused sections"));
994 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
995 N_("Print resource usage statistics"), NULL);
997 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
998 N_("Set target system root directory"), N_("DIR"));
1000 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1001 N_("Print the name of each input file"), NULL);
1003 DEFINE_special(script, options::TWO_DASHES, 'T',
1004 N_("Read linker script"), N_("FILE"));
1006 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
1007 N_("Run the linker multi-threaded"),
1008 N_("Do not run the linker multi-threaded"));
1009 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
1010 N_("Number of threads to use"), N_("COUNT"));
1011 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
1012 N_("Number of threads to use in initial pass"), N_("COUNT"));
1013 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
1014 N_("Number of threads to use in middle pass"), N_("COUNT"));
1015 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
1016 N_("Number of threads to use in final pass"), N_("COUNT"));
1018 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1019 N_("Set the address of the bss segment"), N_("ADDRESS"));
1020 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1021 N_("Set the address of the data segment"), N_("ADDRESS"));
1022 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1023 N_("Set the address of the text segment"), N_("ADDRESS"));
1025 DEFINE_set(undefined, options::TWO_DASHES, 'u',
1026 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1028 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1029 N_("Synonym for --debug=files"), NULL);
1031 DEFINE_special(version_script, options::TWO_DASHES, '\0',
1032 N_("Read version script"), N_("FILE"));
1034 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1035 N_("Warn about duplicate common symbols"),
1036 N_("Do not warn about duplicate common symbols (default)"));
1038 DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1039 N_("Ignored"), N_("Ignored"));
1041 DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1042 NULL, N_("Don't warn about mismatched input files"));
1044 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1045 N_("Ignored"), NULL);
1047 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1048 N_("Warn when skipping an incompatible library"),
1049 N_("Don't warn when skipping an incompatible library"));
1051 DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1052 N_("Warn if text segment is not shareable"),
1053 N_("Do not warn if text segment is not shareable (default)"));
1055 DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1056 N_("Report unresolved symbols as warnings"),
1058 DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1059 options::TWO_DASHES, '\0',
1060 N_("Report unresolved symbols as errors"),
1063 DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1064 N_("(ARM only) Do not warn about objects with incompatible "
1067 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1068 N_("Include all archive contents"),
1069 N_("Include only needed archive contents"));
1071 DEFINE_set(wrap, options::TWO_DASHES, '\0',
1072 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1074 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1075 N_("Trace references to symbol"), N_("SYMBOL"));
1077 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1078 N_("Allow unused version in script (default)"),
1079 N_("Do not allow unused version in script"));
1081 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1082 N_("Default search path for Solaris compatibility"),
1085 DEFINE_special(start_group, options::TWO_DASHES, '(',
1086 N_("Start a library search group"), NULL);
1087 DEFINE_special(end_group, options::TWO_DASHES, ')',
1088 N_("End a library search group"), NULL);
1091 DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1092 N_("Start a library"), NULL);
1093 DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1094 N_("End a library "), NULL);
1098 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1099 N_("Sort dynamic relocs"),
1100 N_("Do not sort dynamic relocs"));
1101 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1102 N_("Set common page size to SIZE"), N_("SIZE"));
1103 DEFINE_bool(defs, options::DASH_Z, '\0', false,
1104 N_("Report undefined symbols (even with --shared)"),
1106 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1107 N_("Mark output as requiring executable stack"), NULL);
1108 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1109 N_("Mark DSO to be initialized first at runtime"),
1111 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1112 N_("Mark object to interpose all DSOs but executable"),
1114 DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1115 N_("Mark object for lazy runtime binding (default)"),
1117 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1118 N_("Mark object requiring immediate process"),
1120 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1121 N_("Set maximum page size to SIZE"), N_("SIZE"));
1122 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1123 N_("Allow multiple definitions of symbols"),
1125 // copyreloc is here in the list because there is only -z
1126 // nocopyreloc, not -z copyreloc.
1127 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1129 N_("Do not create copy relocs"));
1130 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1131 N_("Mark object not to use default search paths"),
1133 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1134 N_("Mark DSO non-deletable at runtime"),
1136 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1137 N_("Mark DSO not available to dlopen"),
1139 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1140 N_("Mark DSO not available to dldump"),
1142 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1143 N_("Mark output as not requiring executable stack"), NULL);
1144 DEFINE_bool(now, options::DASH_Z, '\0', false,
1145 N_("Mark object for immediate function binding"),
1147 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1148 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1149 "processing at runtime"), NULL);
1150 DEFINE_bool(relro, options::DASH_Z, '\0', false,
1151 N_("Where possible mark variables read-only after relocation"),
1152 N_("Don't mark variables read-only after relocation"));
1153 DEFINE_bool(text, options::DASH_Z, '\0', false,
1154 N_("Do not permit relocations in read-only segments"),
1156 DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1157 N_("Permit relocations in read-only segments (default)"),
1161 typedef options::Dir_list Dir_list;
1165 // Does post-processing on flags, making sure they all have
1166 // non-conflicting values. Also converts some flags from their
1167 // "standard" types (string, etc), to another type (enum, DirList),
1168 // which can be accessed via a separate method. Dies if it notices
1172 // True if we printed the version information.
1174 printed_version() const
1175 { return this->printed_version_; }
1177 // The macro defines output() (based on --output), but that's a
1178 // generic name. Provide this alternative name, which is clearer.
1180 output_file_name() const
1181 { return this->output(); }
1183 // This is not defined via a flag, but combines flags to say whether
1184 // the output is position-independent or not.
1186 output_is_position_independent() const
1187 { return this->shared() || this->pie(); }
1189 // Return true if the output is something that can be exec()ed, such
1190 // as a static executable, or a position-dependent or
1191 // position-independent executable, but not a dynamic library or an
1194 output_is_executable() const
1195 { return !this->shared() && !this->relocatable(); }
1197 // This would normally be static(), and defined automatically, but
1198 // since static is a keyword, we need to come up with our own name.
1203 // In addition to getting the input and output formats as a string
1204 // (via format() and oformat()), we also give access as an enum.
1209 // Straight binary format.
1210 OBJECT_FORMAT_BINARY
1213 // Convert a string to an Object_format. Gives an error if the
1214 // string is not recognized.
1215 static Object_format
1216 string_to_object_format(const char* arg);
1218 // Note: these functions are not very fast.
1219 Object_format format_enum() const;
1220 Object_format oformat_enum() const;
1222 // Return whether FILENAME is in a system directory.
1224 is_in_system_directory(const std::string& name) const;
1226 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1228 should_retain_symbol(const char* symbol_name) const
1230 if (symbols_to_retain_.empty()) // means flag wasn't specified
1232 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1235 // These are the best way to get access to the execstack state,
1236 // not execstack() and noexecstack() which are hard to use properly.
1238 is_execstack_set() const
1239 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1242 is_stack_executable() const
1243 { return this->execstack_status_ == EXECSTACK_YES; }
1247 { return this->icf_status_ != ICF_NONE; }
1250 icf_safe_folding() const
1251 { return this->icf_status_ == ICF_SAFE; }
1253 // The --demangle option takes an optional string, and there is also
1254 // a --no-demangle option. This is the best way to decide whether
1255 // to demangle or not.
1258 { return this->do_demangle_; }
1260 // Returns TRUE if any plugin libraries have been loaded.
1263 { return this->plugins_ != NULL; }
1265 // Return a pointer to the plugin manager.
1268 { return this->plugins_; }
1270 // True iff SYMBOL was found in the file specified by dynamic-list.
1272 in_dynamic_list(const char* symbol) const
1273 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1275 // Finalize the dynamic list.
1277 finalize_dynamic_list()
1278 { this->dynamic_list_.version_script_info()->finalize(); }
1280 // The mode selected by the --incremental options.
1281 enum Incremental_mode
1283 // No incremental linking (--no-incremental).
1285 // Incremental update only (--incremental-update).
1287 // Force a full link, but prepare for subsequent incremental link
1288 // (--incremental-full).
1290 // Incremental update if possible, fallback to full link (--incremental).
1294 // The incremental linking mode.
1296 incremental_mode() const
1297 { return this->incremental_mode_; }
1299 // The disposition given by the --incremental-changed,
1300 // --incremental-unchanged or --incremental-unknown option. The
1301 // value may change as we proceed parsing the command line flags.
1302 Incremental_disposition
1303 incremental_disposition() const
1304 { return this->incremental_disposition_; }
1306 // Return true if S is the name of a library excluded from automatic
1309 check_excluded_libs(const std::string &s) const;
1311 // If an explicit start address was given for section SECNAME with
1312 // the --section-start option, return true and set *PADDR to the
1313 // address. Otherwise return false.
1315 section_start(const char* secname, uint64_t* paddr) const;
1319 // Leave original instruction.
1321 // Replace instruction.
1323 // Generate an interworking veneer.
1324 FIX_V4BX_INTERWORKING
1329 { return (this->fix_v4bx_); }
1340 { return this->endianness_; }
1343 // Don't copy this structure.
1344 General_options(const General_options&);
1345 General_options& operator=(const General_options&);
1347 // Whether to mark the stack as executable.
1350 // Not set on command line.
1351 EXECSTACK_FROM_INPUT,
1352 // Mark the stack as executable (-z execstack).
1354 // Mark the stack as not executable (-z noexecstack).
1360 // Do not fold any functions (Default or --icf=none).
1362 // All functions are candidates for folding. (--icf=all).
1364 // Only ctors and dtors are candidates for folding. (--icf=safe).
1369 set_icf_status(Icf_status value)
1370 { this->icf_status_ = value; }
1373 set_execstack_status(Execstack value)
1374 { this->execstack_status_ = value; }
1377 set_do_demangle(bool value)
1378 { this->do_demangle_ = value; }
1381 set_static(bool value)
1382 { static_ = value; }
1384 // These are called by finalize() to set up the search-path correctly.
1386 add_to_library_path_with_sysroot(const char* arg)
1387 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1389 // Apply any sysroot to the directory lists.
1393 // Add a plugin and its arguments to the list of plugins.
1395 add_plugin(const char* filename);
1397 // Add a plugin option.
1399 add_plugin_option(const char* opt);
1401 // Whether we printed version information.
1402 bool printed_version_;
1403 // Whether to mark the stack as executable.
1404 Execstack execstack_status_;
1405 // Whether to do code folding.
1406 Icf_status icf_status_;
1407 // Whether to do a static link.
1409 // Whether to do demangling.
1411 // List of plugin libraries.
1412 Plugin_manager* plugins_;
1413 // The parsed output of --dynamic-list files. For convenience in
1414 // script.cc, we store this as a Script_options object, even though
1415 // we only use a single Version_tree from it.
1416 Script_options dynamic_list_;
1417 // The incremental linking mode.
1418 Incremental_mode incremental_mode_;
1419 // The disposition given by the --incremental-changed,
1420 // --incremental-unchanged or --incremental-unknown option. The
1421 // value may change as we proceed parsing the command line flags.
1422 Incremental_disposition incremental_disposition_;
1423 // Whether we have seen one of the options that require incremental
1424 // build (--incremental-changed, --incremental-unchanged or
1425 // --incremental-unknown)
1426 bool implicit_incremental_;
1427 // Libraries excluded from automatic export, via --exclude-libs.
1428 Unordered_set<std::string> excluded_libs_;
1429 // List of symbol-names to keep, via -retain-symbol-info.
1430 Unordered_set<std::string> symbols_to_retain_;
1431 // Map from section name to address from --section-start.
1432 std::map<std::string, uint64_t> section_starts_;
1433 // Whether to process armv4 bx instruction relocation.
1436 Endianness endianness_;
1439 // The position-dependent options. We use this to store the state of
1440 // the commandline at a particular point in parsing for later
1441 // reference. For instance, if we see "ld --whole-archive foo.a
1442 // --no-whole-archive," we want to store the whole-archive option with
1443 // foo.a, so when the time comes to parse foo.a we know we should do
1444 // it in whole-archive mode. We could store all of General_options,
1445 // but that's big, so we just pick the subset of flags that actually
1446 // change in a position-dependent way.
1448 #define DEFINE_posdep(varname__, type__) \
1452 { return this->varname__##_; } \
1455 set_##varname__(type__ value) \
1456 { this->varname__##_ = value; } \
1460 class Position_dependent_options
1463 Position_dependent_options(const General_options& options
1464 = Position_dependent_options::default_options_)
1465 { copy_from_options(options); }
1467 void copy_from_options(const General_options& options)
1469 this->set_as_needed(options.as_needed());
1470 this->set_Bdynamic(options.Bdynamic());
1471 this->set_format_enum(options.format_enum());
1472 this->set_whole_archive(options.whole_archive());
1473 this->set_incremental_disposition(options.incremental_disposition());
1476 DEFINE_posdep(as_needed, bool);
1477 DEFINE_posdep(Bdynamic, bool);
1478 DEFINE_posdep(format_enum, General_options::Object_format);
1479 DEFINE_posdep(whole_archive, bool);
1480 DEFINE_posdep(incremental_disposition, Incremental_disposition);
1483 // This is a General_options with everything set to its default
1484 // value. A Position_dependent_options created with no argument
1485 // will take its values from here.
1486 static General_options default_options_;
1490 // A single file or library argument from the command line.
1492 class Input_file_argument
1495 enum Input_file_type
1497 // A regular file, name used as-is, not searched.
1498 INPUT_FILE_TYPE_FILE,
1499 // A library name. When used, "lib" will be prepended and ".so" or
1500 // ".a" appended to make a filename, and that filename will be searched
1501 // for using the -L paths.
1502 INPUT_FILE_TYPE_LIBRARY,
1503 // A regular file, name used as-is, but searched using the -L paths.
1504 INPUT_FILE_TYPE_SEARCHED_FILE
1507 // name: file name or library name
1508 // type: the type of this input file.
1509 // extra_search_path: an extra directory to look for the file, prior
1510 // to checking the normal library search path. If this is "",
1511 // then no extra directory is added.
1512 // just_symbols: whether this file only defines symbols.
1513 // options: The position dependent options at this point in the
1514 // command line, such as --whole-archive.
1515 Input_file_argument()
1516 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1517 just_symbols_(false), options_()
1520 Input_file_argument(const char* name, Input_file_type type,
1521 const char* extra_search_path,
1523 const Position_dependent_options& options)
1524 : name_(name), type_(type), extra_search_path_(extra_search_path),
1525 just_symbols_(just_symbols), options_(options)
1528 // You can also pass in a General_options instance instead of a
1529 // Position_dependent_options. In that case, we extract the
1530 // position-independent vars from the General_options and only store
1532 Input_file_argument(const char* name, Input_file_type type,
1533 const char* extra_search_path,
1535 const General_options& options)
1536 : name_(name), type_(type), extra_search_path_(extra_search_path),
1537 just_symbols_(just_symbols), options_(options)
1542 { return this->name_.c_str(); }
1544 const Position_dependent_options&
1546 { return this->options_; }
1550 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1553 is_searched_file() const
1554 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1557 extra_search_path() const
1559 return (this->extra_search_path_.empty()
1561 : this->extra_search_path_.c_str());
1564 // Return whether we should only read symbols from this file.
1566 just_symbols() const
1567 { return this->just_symbols_; }
1569 // Return whether this file may require a search using the -L
1572 may_need_search() const
1574 return (this->is_lib()
1575 || this->is_searched_file()
1576 || !this->extra_search_path_.empty());
1580 // We use std::string, not const char*, here for convenience when
1581 // using script files, so that we do not have to preserve the string
1584 Input_file_type type_;
1585 std::string extra_search_path_;
1587 Position_dependent_options options_;
1590 // A file or library, or a group, from the command line.
1592 class Input_argument
1595 // Create a file or library argument.
1596 explicit Input_argument(Input_file_argument file)
1597 : is_file_(true), file_(file), group_(NULL), lib_(NULL)
1600 // Create a group argument.
1601 explicit Input_argument(Input_file_group* group)
1602 : is_file_(false), group_(group), lib_(NULL)
1605 // Create a lib argument.
1606 explicit Input_argument(Input_file_lib* lib)
1607 : is_file_(false), group_(NULL), lib_(lib)
1610 // Return whether this is a file.
1613 { return this->is_file_; }
1615 // Return whether this is a group.
1618 { return !this->is_file_ && this->lib_ == NULL; }
1620 // Return whether this is a lib.
1623 { return this->lib_ != NULL; }
1625 // Return the information about the file.
1626 const Input_file_argument&
1629 gold_assert(this->is_file_);
1633 // Return the information about the group.
1634 const Input_file_group*
1637 gold_assert(!this->is_file_);
1638 return this->group_;
1644 gold_assert(!this->is_file_);
1645 return this->group_;
1648 // Return the information about the lib.
1649 const Input_file_lib*
1652 gold_assert(!this->is_file_);
1653 gold_assert(this->lib_);
1660 gold_assert(!this->is_file_);
1661 gold_assert(this->lib_);
1667 Input_file_argument file_;
1668 Input_file_group* group_;
1669 Input_file_lib* lib_;
1672 typedef std::vector<Input_argument> Input_argument_list;
1674 // A group from the command line. This is a set of arguments within
1675 // --start-group ... --end-group.
1677 class Input_file_group
1680 typedef Input_argument_list::const_iterator const_iterator;
1686 // Add a file to the end of the group.
1688 add_file(const Input_file_argument& arg)
1689 { this->files_.push_back(Input_argument(arg)); }
1691 // Iterators to iterate over the group contents.
1695 { return this->files_.begin(); }
1699 { return this->files_.end(); }
1702 Input_argument_list files_;
1705 // A lib from the command line. This is a set of arguments within
1706 // --start-lib ... --end-lib.
1708 class Input_file_lib
1711 typedef Input_argument_list::const_iterator const_iterator;
1713 Input_file_lib(const Position_dependent_options& options)
1714 : files_(), options_(options)
1717 // Add a file to the end of the lib.
1719 add_file(const Input_file_argument& arg)
1720 { this->files_.push_back(Input_argument(arg)); }
1722 const Position_dependent_options&
1724 { return this->options_; }
1726 // Iterators to iterate over the lib contents.
1730 { return this->files_.begin(); }
1734 { return this->files_.end(); }
1738 { return this->files_.size(); }
1741 Input_argument_list files_;
1742 Position_dependent_options options_;
1745 // A list of files from the command line or a script.
1747 class Input_arguments
1750 typedef Input_argument_list::const_iterator const_iterator;
1753 : input_argument_list_(), in_group_(false), in_lib_(false)
1758 add_file(const Input_file_argument& arg);
1760 // Start a group (the --start-group option).
1764 // End a group (the --end-group option).
1768 // Start a lib (the --start-lib option).
1770 start_lib(const Position_dependent_options&);
1772 // End a lib (the --end-lib option).
1776 // Return whether we are currently in a group.
1779 { return this->in_group_; }
1781 // Return whether we are currently in a lib.
1784 { return this->in_lib_; }
1786 // The number of entries in the list.
1789 { return this->input_argument_list_.size(); }
1791 // Iterators to iterate over the list of input files.
1795 { return this->input_argument_list_.begin(); }
1799 { return this->input_argument_list_.end(); }
1801 // Return whether the list is empty.
1804 { return this->input_argument_list_.empty(); }
1807 Input_argument_list input_argument_list_;
1813 // All the information read from the command line. These are held in
1814 // three separate structs: one to hold the options (--foo), one to
1815 // hold the filenames listed on the commandline, and one to hold
1816 // linker script information. This third is not a subset of the other
1817 // two because linker scripts can be specified either as options (via
1818 // -T) or as a file.
1823 typedef Input_arguments::const_iterator const_iterator;
1827 // Process the command line options. This will exit with an
1828 // appropriate error message if an unrecognized option is seen.
1830 process(int argc, const char** argv);
1832 // Process one command-line option. This takes the index of argv to
1833 // process, and returns the index for the next option. no_more_options
1834 // is set to true if argv[i] is "--".
1836 process_one_option(int argc, const char** argv, int i,
1837 bool* no_more_options);
1839 // Get the general options.
1840 const General_options&
1842 { return this->options_; }
1844 // Get the position dependent options.
1845 const Position_dependent_options&
1846 position_dependent_options() const
1847 { return this->position_options_; }
1849 // Get the linker-script options.
1852 { return this->script_options_; }
1854 // Finalize the version-script options and return them.
1855 const Version_script_info&
1858 // Get the input files.
1861 { return this->inputs_; }
1863 // The number of input files.
1865 number_of_input_files() const
1866 { return this->inputs_.size(); }
1868 // Iterators to iterate over the list of input files.
1872 { return this->inputs_.begin(); }
1876 { return this->inputs_.end(); }
1879 Command_line(const Command_line&);
1880 Command_line& operator=(const Command_line&);
1882 // This is a dummy class to provide a constructor that runs before
1883 // the constructor for the General_options. The Pre_options constructor
1884 // is used as a hook to set the flag enabling the options to register
1886 struct Pre_options {
1890 // This must come before options_!
1891 Pre_options pre_options_;
1892 General_options options_;
1893 Position_dependent_options position_options_;
1894 Script_options script_options_;
1895 Input_arguments inputs_;
1898 } // End namespace gold.
1900 #endif // !defined(GOLD_OPTIONS_H)