1 // options.h -- handle command line options for gold -*- C++ -*-
3 // Copyright (C) 2006-2015 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 like DEFINE_uint64, but VARNAME is the name of a different
502 // option. This option becomes an alias for that one.
503 #define DEFINE_uint64_alias(option__, varname__, dashes__, shortname__, \
504 helpstring__, helparg__) \
506 struct Struct_##option__ : public options::Struct_var \
508 Struct_##option__() \
509 : option(#option__, dashes__, shortname__, "", helpstring__, \
510 helparg__, false, this) \
514 parse_to_value(const char* option_name, const char* arg, \
515 Command_line*, General_options* options) \
518 options::parse_uint64(option_name, arg, &value); \
519 options->set_##varname__(value); \
520 options->set_user_set_##varname__(); \
523 options::One_option option; \
525 Struct_##option__ option__##_;
527 // This is used for non-standard flags. It defines no functions; it
528 // just calls General_options::parse_VARNAME whenever the flag is
529 // seen. We declare parse_VARNAME as a static member of
530 // General_options; you are responsible for defining it there.
531 // helparg__ should be NULL iff this special-option is a boolean.
532 #define DEFINE_special(varname__, dashes__, shortname__, \
533 helpstring__, helparg__) \
535 void parse_##varname__(const char* option, const char* arg, \
536 Command_line* inputs); \
537 struct Struct_##varname__ : public options::Struct_special \
539 Struct_##varname__() \
540 : options::Struct_special(#varname__, dashes__, shortname__, \
541 &General_options::parse_##varname__, \
542 helpstring__, helparg__) \
545 Struct_##varname__ varname__##_initializer_
547 // An option that takes an optional string argument. If the option is
548 // used with no argument, the value will be the default, and
549 // user_set_via_option will be true.
550 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
552 helpstring__, helparg__) \
553 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
554 default_value__, helpstring__, helparg__, true, \
555 const char*, const char*, options::parse_optional_string)
557 // A directory to search. For each directory we record whether it is
558 // in the sysroot. We need to know this so that, if a linker script
559 // is found within the sysroot, we will apply the sysroot to any files
560 // named by that script.
562 class Search_directory
565 // We need a default constructor because we put this in a
568 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
571 // This is the usual constructor.
572 Search_directory(const std::string& name, bool put_in_sysroot)
573 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
575 if (this->name_.empty())
579 // This is called if we have a sysroot. The sysroot is prefixed to
580 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
581 // set to true for any enries which are in the sysroot (this will
582 // naturally include any entries for which put_in_sysroot_ is true).
583 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
584 // passing SYSROOT to lrealpath.
586 add_sysroot(const char* sysroot, const char* canonical_sysroot);
588 // Get the directory name.
591 { return this->name_; }
593 // Return whether this directory is in the sysroot.
595 is_in_sysroot() const
596 { return this->is_in_sysroot_; }
598 // Return whether this is considered a system directory.
600 is_system_directory() const
601 { return this->put_in_sysroot_ || this->is_in_sysroot_; }
604 // The directory name.
606 // True if the sysroot should be added as a prefix for this
607 // directory (if there is a sysroot). This is true for system
608 // directories that we search by default.
609 bool put_in_sysroot_;
610 // True if this directory is in the sysroot (if there is a sysroot).
611 // This is true if there is a sysroot and either 1) put_in_sysroot_
612 // is true, or 2) the directory happens to be in the sysroot based
613 // on a pathname comparison.
617 class General_options
620 // NOTE: For every option that you add here, also consider if you
621 // should add it to Position_dependent_options.
622 DEFINE_special(help, options::TWO_DASHES, '\0',
623 N_("Report usage information"), NULL);
624 DEFINE_special(version, options::TWO_DASHES, 'v',
625 N_("Report version information"), NULL);
626 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
627 N_("Report version and target information"), NULL);
629 // These options are sorted approximately so that for each letter in
630 // the alphabet, we show the option whose shortname is that letter
631 // (if any) and then every longname that starts with that letter (in
632 // alphabetical order). For both, lowercase sorts before uppercase.
633 // The -z options come last.
635 DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
637 N_("Do not copy DT_NEEDED tags from shared libraries"));
639 DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
640 '\0', N_("Allow multiple definitions of symbols"),
641 N_("Do not allow multiple definitions"), false);
643 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
644 N_("Allow unresolved references in shared libraries"),
645 N_("Do not allow unresolved references in shared libraries"));
647 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
648 N_("Only set DT_NEEDED for shared libraries if used"),
649 N_("Always DT_NEEDED for shared libraries"));
651 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
652 N_("Ignored"), N_("[ignored]"),
653 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
655 // This should really be an "enum", but it's too easy for folks to
656 // forget to update the list as they add new targets. So we just
657 // accept any string. We'll fail later (when the string is parsed),
658 // if the target isn't actually supported.
659 DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
660 N_("Set input format"), ("[elf,binary]"));
662 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
663 N_("-l searches for shared libraries"), NULL);
664 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
665 N_("-l does not search for shared libraries"), NULL,
667 DEFINE_bool_alias(dy, Bdynamic, options::ONE_DASH, '\0',
668 N_("alias for -Bdynamic"), NULL, false);
669 DEFINE_bool_alias(dn, Bdynamic, options::ONE_DASH, '\0',
670 N_("alias for -Bstatic"), NULL, true);
672 DEFINE_bool(Bgroup, options::ONE_DASH, '\0', false,
673 N_("Use group name lookup rules for shared library"), NULL);
675 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
676 N_("Bind defined symbols locally"), NULL);
678 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
679 N_("Bind defined function symbols locally"), NULL);
681 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "tree",
682 N_("Generate build ID note"),
685 DEFINE_uint64(build_id_chunk_size_for_treehash,
686 options::TWO_DASHES, '\0', 2 << 20,
687 N_("Chunk size for '--build-id=tree'"), N_("SIZE"));
689 DEFINE_uint64(build_id_min_file_size_for_treehash, options::TWO_DASHES,
691 N_("Minimum output file size for '--build-id=tree' to work"
692 " differently than '--build-id=sha1'"), N_("SIZE"));
694 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
695 N_("Check segment addresses for overlaps (default)"),
696 N_("Do not check segment addresses for overlaps"));
698 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
699 N_("Compress .debug_* sections in the output file"),
703 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
705 N_("Do not copy DT_NEEDED tags from shared libraries"));
707 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
708 N_("Output cross reference table"),
709 N_("Do not output cross reference table"));
711 DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
712 N_("Use DT_INIT_ARRAY for all constructors (default)"),
713 N_("Handle constructors as directed by compiler"));
715 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
716 N_("Define common symbols"),
717 N_("Do not define common symbols"));
718 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
719 N_("Alias for -d"), NULL);
720 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
721 N_("Alias for -d"), NULL);
723 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
724 N_("Turn on debugging"),
725 N_("[all,files,script,task][,...]"));
727 DEFINE_special(defsym, options::TWO_DASHES, '\0',
728 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
730 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
731 N_("Demangle C++ symbols in log messages"),
734 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
735 N_("Do not demangle C++ symbols in log messages"),
738 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
739 N_("Look for violations of the C++ One Definition Rule"),
740 N_("Do not look for violations of the C++ One Definition Rule"));
742 DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
743 N_("Delete all local symbols"), NULL);
744 DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
745 N_("Delete all temporary local symbols"), NULL);
747 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
748 N_("Add data symbols to dynamic symbols"), NULL);
750 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
751 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
753 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
754 N_("Add C++ typeinfo to dynamic symbols"), NULL);
756 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
757 N_("Read a list of dynamic symbols"), N_("FILE"));
759 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
760 N_("Set program start address"), N_("ADDRESS"));
762 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
763 N_("Exclude libraries from automatic export"),
764 N_(("lib,lib ...")));
766 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
767 N_("Export all dynamic symbols"),
768 N_("Do not export all dynamic symbols (default)"));
770 DEFINE_set(export_dynamic_symbol, options::TWO_DASHES, '\0',
771 N_("Export SYMBOL to dynamic symbol table"), N_("SYMBOL"));
773 DEFINE_special(EB, options::ONE_DASH, '\0',
774 N_("Link big-endian objects."), NULL);
776 DEFINE_special(EL, options::ONE_DASH, '\0',
777 N_("Link little-endian objects."), NULL);
779 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
780 N_("Create exception frame header"), NULL);
782 DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
783 N_("(ARM only) Do not warn about objects with incompatible "
786 DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
787 N_("Auxiliary filter for shared object symbol table"),
790 DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
791 N_("Filter for shared object symbol table"),
794 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
795 N_("Treat warnings as errors"),
796 N_("Do not treat warnings as errors"));
798 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
799 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
801 DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
802 N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
803 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
805 DEFINE_bool(fix_arm1176, options::TWO_DASHES, '\0', true,
806 N_("(ARM only) Fix binaries for ARM1176 erratum."),
807 N_("(ARM only) Do not fix binaries for ARM1176 erratum."));
809 DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
810 N_("(ARM only) Merge exidx entries in debuginfo."),
811 N_("(ARM only) Do not merge exidx entries in debuginfo."));
813 DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
814 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
817 DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
818 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
822 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
823 N_("Ignored"), NULL);
825 DEFINE_bool(gdb_index, options::TWO_DASHES, '\0', false,
826 N_("Generate .gdb_index section"),
827 N_("Do not generate .gdb_index section"));
829 DEFINE_bool(gnu_unique, options::TWO_DASHES, '\0', true,
830 N_("Enable STB_GNU_UNIQUE symbol binding (default)"),
831 N_("Disable STB_GNU_UNIQUE symbol binding"));
833 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
834 N_("Set shared library name"), N_("FILENAME"));
836 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
837 N_("Min fraction of empty buckets in dynamic hash"),
840 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
841 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
842 {"sysv", "gnu", "both"});
844 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
845 N_("Set dynamic linker path"), N_("PROGRAM"));
847 DEFINE_special(incremental, options::TWO_DASHES, '\0',
848 N_("Do an incremental link if possible; "
849 "otherwise, do a full link and prepare output "
850 "for incremental linking"), NULL);
852 DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
853 N_("Do a full link (default)"), NULL);
855 DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
856 N_("Do a full link and "
857 "prepare output for incremental linking"), NULL);
859 DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
860 N_("Do an incremental link; exit if not possible"), NULL);
862 DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
863 N_("Set base file for incremental linking"
864 " (default is output file)"),
867 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
868 N_("Assume files changed"), NULL);
870 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
871 N_("Assume files didn't change"), NULL);
873 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
874 N_("Use timestamps to check files (default)"), NULL);
876 DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
877 N_("Assume startup files unchanged "
878 "(files preceding this option)"), NULL);
880 DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
881 N_("Amount of extra space to allocate for patches"),
884 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
885 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
887 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
888 N_("Read only symbol values from FILE"), N_("FILE"));
890 DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
892 N_("Map whole files to memory (default on 64-bit hosts)"),
893 N_("Map relevant file parts to memory (default on 32-bit "
895 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
896 N_("Keep files mapped across passes (default)"),
897 N_("Release mapped files after each pass"));
899 DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
900 N_("Generate unwind information for PLT (default)"),
901 N_("Do not generate unwind information for PLT"));
903 DEFINE_special(library, options::TWO_DASHES, 'l',
904 N_("Search for library LIBNAME"), N_("LIBNAME"));
906 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
907 N_("Add directory to search path"), N_("DIR"));
909 DEFINE_bool(text_reorder, options::TWO_DASHES, '\0', true,
910 N_("Enable text section reordering for GCC section names "
912 N_("Disable text section reordering for GCC section names"));
914 DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
915 N_("Only search directories specified on the command line."),
918 DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
919 N_("Put read-only non-executable sections in their own segment"),
922 DEFINE_uint64(rosegment_gap, options::TWO_DASHES, '\0', -1U,
923 N_("Set offset between executable and read-only segments"),
926 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
927 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
929 DEFINE_bool(mmap_output_file, options::TWO_DASHES, '\0', true,
930 N_("Map the output file for writing (default)."),
931 N_("Do not map the output file for writing."));
933 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
934 N_("Write map file on standard output"), NULL);
935 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
938 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
939 N_("Do not page align data"), NULL);
940 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
941 N_("Do not page align data, do not make text readonly"),
942 N_("Page align data, make text readonly"));
944 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', true,
945 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
946 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
948 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
949 N_("Create an output file even if errors occur"), NULL);
951 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
952 N_("Report undefined symbols (even with --shared)"),
955 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
956 N_("Set output file name"), N_("FILE"));
958 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
959 N_("Optimize output file size"), N_("LEVEL"));
961 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
962 N_("Set output format"), N_("[binary]"));
964 DEFINE_bool(p, options::ONE_DASH, '\0', false,
965 N_("(ARM only) Ignore for backward compatibility"), NULL);
967 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
968 N_("Create a position independent executable"),
969 N_("Do not create a position independent executable"));
970 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
971 N_("Create a position independent executable"),
972 N_("Do not create a position independent executable"),
975 DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
976 NULL, N_("(ARM only) Ignore for backward compatibility"));
978 DEFINE_var(plt_align, options::TWO_DASHES, '\0', 0, "5",
979 N_("(PowerPC64 only) Align PLT call stubs to fit cache lines"),
980 N_("[=P2ALIGN]"), true, int, int, options::parse_uint);
982 DEFINE_bool(plt_static_chain, options::TWO_DASHES, '\0', false,
983 N_("(PowerPC64 only) PLT call stubs should load r11"),
984 N_("(PowerPC64 only) PLT call stubs should not load r11"));
986 DEFINE_bool(plt_thread_safe, options::TWO_DASHES, '\0', false,
987 N_("(PowerPC64 only) PLT call stubs with load-load barrier"),
988 N_("(PowerPC64 only) PLT call stubs without barrier"));
990 #ifdef ENABLE_PLUGINS
991 DEFINE_special(plugin, options::TWO_DASHES, '\0',
992 N_("Load a plugin library"), N_("PLUGIN"));
993 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
994 N_("Pass an option to the plugin"), N_("OPTION"));
997 DEFINE_bool(posix_fallocate, options::TWO_DASHES, '\0', true,
998 N_("Use posix_fallocate to reserve space in the output file"
1000 N_("Use fallocate or ftruncate to reserve space."));
1002 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
1003 N_("Preread archive symbols when multi-threaded"), NULL);
1005 DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
1006 N_("Print default output format"), NULL);
1008 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
1009 N_("Print symbols defined and used for each input"),
1012 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
1013 N_("Ignored for SVR4 compatibility"), NULL);
1015 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
1016 N_("Generate relocations in output"), NULL);
1018 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
1019 N_("Generate relocatable output"), NULL);
1020 DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
1021 N_("Synonym for -r"), NULL, false);
1023 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
1024 N_("Relax branches on certain targets"), NULL);
1026 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
1027 N_("keep only symbols listed in this file"), N_("FILE"));
1029 // -R really means -rpath, but can mean --just-symbols for
1030 // compatibility with GNU ld. -rpath is always -rpath, so we list
1032 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
1033 N_("Add DIR to runtime search path"), N_("DIR"));
1035 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
1036 N_("Add DIR to runtime search path"), N_("DIR"));
1038 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
1039 N_("Add DIR to link time shared library search path"),
1042 DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
1043 N_("Layout sections in the order specified."),
1046 DEFINE_special(section_start, options::TWO_DASHES, '\0',
1047 N_("Set address of section"), N_("SECTION=ADDRESS"));
1049 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
1050 N_("Sort common symbols by alignment"),
1051 N_("[={ascending,descending}]"));
1053 DEFINE_enum(sort_section, options::TWO_DASHES, '\0', "none",
1054 N_("Sort sections by name. \'--no-text-reorder\'"
1055 " will override \'--sort-section=name\' for .text"),
1059 DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
1060 N_("Dynamic tag slots to reserve (default 5)"),
1063 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
1064 N_("Strip all symbols"), NULL);
1065 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
1066 N_("Strip debugging information"), NULL);
1067 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
1068 N_("Emit only debug line number information"), NULL);
1069 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
1070 N_("Strip debug symbols that are unused by gdb "
1071 "(at least versions <= 7.4)"), NULL);
1072 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
1073 N_("Strip LTO intermediate code sections"), NULL);
1075 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
1076 N_("(ARM, PowerPC only) The maximum distance from instructions "
1077 "in a group of sections to their stubs. Negative values mean "
1078 "stubs are always after (PowerPC before) the group. 1 means "
1079 "use default size.\n"),
1082 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
1083 N_("Use less memory and more disk I/O "
1084 "(included only for compatibility with GNU ld)"), NULL);
1086 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
1087 N_("Generate shared library"), NULL);
1089 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
1090 N_("Generate shared library"), NULL);
1092 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
1093 N_("Stack size when -fsplit-stack function calls non-split"),
1096 // This is not actually special in any way, but I need to give it
1097 // a non-standard accessor-function name because 'static' is a keyword.
1098 DEFINE_special(static, options::ONE_DASH, '\0',
1099 N_("Do not link against shared libraries"), NULL);
1101 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
1102 N_("Identical Code Folding. "
1103 "\'--icf=safe\' Folds ctors, dtors and functions whose"
1104 " pointers are definitely not taken."),
1105 ("[none,all,safe]"),
1106 {"none", "all", "safe"});
1108 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
1109 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
1111 DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
1112 N_("List folded identical sections on stderr"),
1113 N_("Do not list folded identical sections"));
1115 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
1116 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1118 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
1119 N_("Remove unused sections"),
1120 N_("Don't remove unused sections (default)"));
1122 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
1123 N_("List removed unused sections on stderr"),
1124 N_("Do not list removed unused sections"));
1126 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
1127 N_("Print resource usage statistics"), NULL);
1129 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
1130 N_("Set target system root directory"), N_("DIR"));
1132 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1133 N_("Print the name of each input file"), NULL);
1135 DEFINE_special(script, options::TWO_DASHES, 'T',
1136 N_("Read linker script"), N_("FILE"));
1138 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
1139 N_("Run the linker multi-threaded"),
1140 N_("Do not run the linker multi-threaded"));
1141 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
1142 N_("Number of threads to use"), N_("COUNT"));
1143 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
1144 N_("Number of threads to use in initial pass"), N_("COUNT"));
1145 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
1146 N_("Number of threads to use in middle pass"), N_("COUNT"));
1147 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
1148 N_("Number of threads to use in final pass"), N_("COUNT"));
1150 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1151 N_("Set the address of the bss segment"), N_("ADDRESS"));
1152 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1153 N_("Set the address of the data segment"), N_("ADDRESS"));
1154 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1155 N_("Set the address of the text segment"), N_("ADDRESS"));
1156 DEFINE_uint64_alias(Ttext_segment, Ttext, options::ONE_DASH, '\0',
1157 N_("Set the address of the text segment"),
1159 DEFINE_uint64(Trodata_segment, options::ONE_DASH, '\0', -1U,
1160 N_("Set the address of the rodata segment"), N_("ADDRESS"));
1162 DEFINE_bool(toc_optimize, options::TWO_DASHES, '\0', true,
1163 N_("(PowerPC64 only) Optimize TOC code sequences"),
1164 N_("(PowerPC64 only) Don't optimize TOC code sequences"));
1166 DEFINE_bool(toc_sort, options::TWO_DASHES, '\0', true,
1167 N_("(PowerPC64 only) Sort TOC and GOT sections"),
1168 N_("(PowerPC64 only) Don't sort TOC and GOT sections"));
1170 DEFINE_set(undefined, options::TWO_DASHES, 'u',
1171 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1173 DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1174 N_("How to handle unresolved symbols"),
1175 ("ignore-all,report-all,ignore-in-object-files,"
1176 "ignore-in-shared-libs"),
1177 {"ignore-all", "report-all", "ignore-in-object-files",
1178 "ignore-in-shared-libs"});
1180 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1181 N_("Synonym for --debug=files"), NULL);
1183 DEFINE_special(version_script, options::TWO_DASHES, '\0',
1184 N_("Read version script"), N_("FILE"));
1186 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1187 N_("Warn about duplicate common symbols"),
1188 N_("Do not warn about duplicate common symbols (default)"));
1190 DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1191 N_("Ignored"), N_("Ignored"));
1193 DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1194 N_("Warn if the stack is executable"),
1195 N_("Do not warn if the stack is executable (default)"));
1197 DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1198 NULL, N_("Don't warn about mismatched input files"));
1200 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1201 N_("Ignored"), NULL);
1203 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1204 N_("Warn when skipping an incompatible library"),
1205 N_("Don't warn when skipping an incompatible library"));
1207 DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1208 N_("Warn if text segment is not shareable"),
1209 N_("Do not warn if text segment is not shareable (default)"));
1211 DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1212 N_("Report unresolved symbols as warnings"),
1214 DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1215 options::TWO_DASHES, '\0',
1216 N_("Report unresolved symbols as errors"),
1219 DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1220 N_("(ARM only) Do not warn about objects with incompatible "
1223 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1224 N_("Include all archive contents"),
1225 N_("Include only needed archive contents"));
1227 DEFINE_set(wrap, options::TWO_DASHES, '\0',
1228 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1230 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1231 N_("Trace references to symbol"), N_("SYMBOL"));
1233 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1234 N_("Allow unused version in script (default)"),
1235 N_("Do not allow unused version in script"));
1237 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1238 N_("Default search path for Solaris compatibility"),
1241 DEFINE_special(start_group, options::TWO_DASHES, '(',
1242 N_("Start a library search group"), NULL);
1243 DEFINE_special(end_group, options::TWO_DASHES, ')',
1244 N_("End a library search group"), NULL);
1247 DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1248 N_("Start a library"), NULL);
1249 DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1250 N_("End a library "), NULL);
1252 DEFINE_string(fuse_ld, options::ONE_DASH, '\0', "",
1253 N_("Ignored for GCC linker option compatibility"),
1258 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1259 N_("Sort dynamic relocs"),
1260 N_("Do not sort dynamic relocs"));
1261 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1262 N_("Set common page size to SIZE"), N_("SIZE"));
1263 DEFINE_bool(defs, options::DASH_Z, '\0', false,
1264 N_("Report undefined symbols (even with --shared)"),
1266 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1267 N_("Mark output as requiring executable stack"), NULL);
1268 DEFINE_bool(global, options::DASH_Z, '\0', false,
1269 N_("Make symbols in DSO available for subsequently loaded "
1271 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1272 N_("Mark DSO to be initialized first at runtime"),
1274 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1275 N_("Mark object to interpose all DSOs but executable"),
1277 DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1278 N_("Mark object for lazy runtime binding (default)"),
1280 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1281 N_("Mark object requiring immediate process"),
1283 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1284 N_("Set maximum page size to SIZE"), N_("SIZE"));
1285 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1286 N_("Allow multiple definitions of symbols"),
1288 // copyreloc is here in the list because there is only -z
1289 // nocopyreloc, not -z copyreloc.
1290 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1292 N_("Do not create copy relocs"));
1293 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1294 N_("Mark object not to use default search paths"),
1296 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1297 N_("Mark DSO non-deletable at runtime"),
1299 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1300 N_("Mark DSO not available to dlopen"),
1302 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1303 N_("Mark DSO not available to dldump"),
1305 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1306 N_("Mark output as not requiring executable stack"), NULL);
1307 DEFINE_bool(now, options::DASH_Z, '\0', false,
1308 N_("Mark object for immediate function binding"),
1310 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1311 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1312 "processing at runtime"), NULL);
1313 DEFINE_bool(relro, options::DASH_Z, '\0', false,
1314 N_("Where possible mark variables read-only after relocation"),
1315 N_("Don't mark variables read-only after relocation"));
1316 DEFINE_bool(text, options::DASH_Z, '\0', false,
1317 N_("Do not permit relocations in read-only segments"),
1318 N_("Permit relocations in read-only segments (default)"));
1319 DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1320 N_("Permit relocations in read-only segments (default)"),
1324 typedef options::Dir_list Dir_list;
1328 // Does post-processing on flags, making sure they all have
1329 // non-conflicting values. Also converts some flags from their
1330 // "standard" types (string, etc), to another type (enum, DirList),
1331 // which can be accessed via a separate method. Dies if it notices
1335 // True if we printed the version information.
1337 printed_version() const
1338 { return this->printed_version_; }
1340 // The macro defines output() (based on --output), but that's a
1341 // generic name. Provide this alternative name, which is clearer.
1343 output_file_name() const
1344 { return this->output(); }
1346 // This is not defined via a flag, but combines flags to say whether
1347 // the output is position-independent or not.
1349 output_is_position_independent() const
1350 { return this->shared() || this->pie(); }
1352 // Return true if the output is something that can be exec()ed, such
1353 // as a static executable, or a position-dependent or
1354 // position-independent executable, but not a dynamic library or an
1357 output_is_executable() const
1358 { return !this->shared() && !this->relocatable(); }
1360 // This would normally be static(), and defined automatically, but
1361 // since static is a keyword, we need to come up with our own name.
1366 // In addition to getting the input and output formats as a string
1367 // (via format() and oformat()), we also give access as an enum.
1372 // Straight binary format.
1373 OBJECT_FORMAT_BINARY
1376 // Convert a string to an Object_format. Gives an error if the
1377 // string is not recognized.
1378 static Object_format
1379 string_to_object_format(const char* arg);
1381 // Note: these functions are not very fast.
1382 Object_format format_enum() const;
1383 Object_format oformat_enum() const;
1385 // Return whether FILENAME is in a system directory.
1387 is_in_system_directory(const std::string& name) const;
1389 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1391 should_retain_symbol(const char* symbol_name) const
1393 if (symbols_to_retain_.empty()) // means flag wasn't specified
1395 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1398 // These are the best way to get access to the execstack state,
1399 // not execstack() and noexecstack() which are hard to use properly.
1401 is_execstack_set() const
1402 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1405 is_stack_executable() const
1406 { return this->execstack_status_ == EXECSTACK_YES; }
1410 { return this->icf_status_ != ICF_NONE; }
1413 icf_safe_folding() const
1414 { return this->icf_status_ == ICF_SAFE; }
1416 // The --demangle option takes an optional string, and there is also
1417 // a --no-demangle option. This is the best way to decide whether
1418 // to demangle or not.
1421 { return this->do_demangle_; }
1423 // Returns TRUE if any plugin libraries have been loaded.
1426 { return this->plugins_ != NULL; }
1428 // Return a pointer to the plugin manager.
1431 { return this->plugins_; }
1433 // True iff SYMBOL was found in the file specified by dynamic-list.
1435 in_dynamic_list(const char* symbol) const
1436 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1438 // True if a --dynamic-list script was provided.
1440 have_dynamic_list() const
1441 { return this->have_dynamic_list_; }
1443 // Finalize the dynamic list.
1445 finalize_dynamic_list()
1446 { this->dynamic_list_.version_script_info()->finalize(); }
1448 // The mode selected by the --incremental options.
1449 enum Incremental_mode
1451 // No incremental linking (--no-incremental).
1453 // Incremental update only (--incremental-update).
1455 // Force a full link, but prepare for subsequent incremental link
1456 // (--incremental-full).
1458 // Incremental update if possible, fallback to full link (--incremental).
1462 // The incremental linking mode.
1464 incremental_mode() const
1465 { return this->incremental_mode_; }
1467 // The disposition given by the --incremental-changed,
1468 // --incremental-unchanged or --incremental-unknown option. The
1469 // value may change as we proceed parsing the command line flags.
1470 Incremental_disposition
1471 incremental_disposition() const
1472 { return this->incremental_disposition_; }
1474 // The disposition to use for startup files (those that precede the
1475 // first --incremental-changed, etc. option).
1476 Incremental_disposition
1477 incremental_startup_disposition() const
1478 { return this->incremental_startup_disposition_; }
1480 // Return true if S is the name of a library excluded from automatic
1483 check_excluded_libs(const std::string &s) const;
1485 // If an explicit start address was given for section SECNAME with
1486 // the --section-start option, return true and set *PADDR to the
1487 // address. Otherwise return false.
1489 section_start(const char* secname, uint64_t* paddr) const;
1491 // Return whether any --section-start option was used.
1493 any_section_start() const
1494 { return !this->section_starts_.empty(); }
1498 // Leave original instruction.
1500 // Replace instruction.
1502 // Generate an interworking veneer.
1503 FIX_V4BX_INTERWORKING
1508 { return (this->fix_v4bx_); }
1519 { return this->endianness_; }
1522 // Don't copy this structure.
1523 General_options(const General_options&);
1524 General_options& operator=(const General_options&);
1526 // Whether to mark the stack as executable.
1529 // Not set on command line.
1530 EXECSTACK_FROM_INPUT,
1531 // Mark the stack as executable (-z execstack).
1533 // Mark the stack as not executable (-z noexecstack).
1539 // Do not fold any functions (Default or --icf=none).
1541 // All functions are candidates for folding. (--icf=all).
1543 // Only ctors and dtors are candidates for folding. (--icf=safe).
1548 set_icf_status(Icf_status value)
1549 { this->icf_status_ = value; }
1552 set_execstack_status(Execstack value)
1553 { this->execstack_status_ = value; }
1556 set_do_demangle(bool value)
1557 { this->do_demangle_ = value; }
1560 set_static(bool value)
1561 { static_ = value; }
1563 // These are called by finalize() to set up the search-path correctly.
1565 add_to_library_path_with_sysroot(const std::string& arg)
1566 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1568 // Apply any sysroot to the directory lists.
1572 // Add a plugin and its arguments to the list of plugins.
1574 add_plugin(const char* filename);
1576 // Add a plugin option.
1578 add_plugin_option(const char* opt);
1580 // Whether we printed version information.
1581 bool printed_version_;
1582 // Whether to mark the stack as executable.
1583 Execstack execstack_status_;
1584 // Whether to do code folding.
1585 Icf_status icf_status_;
1586 // Whether to do a static link.
1588 // Whether to do demangling.
1590 // List of plugin libraries.
1591 Plugin_manager* plugins_;
1592 // The parsed output of --dynamic-list files. For convenience in
1593 // script.cc, we store this as a Script_options object, even though
1594 // we only use a single Version_tree from it.
1595 Script_options dynamic_list_;
1596 // Whether a --dynamic-list file was provided.
1597 bool have_dynamic_list_;
1598 // The incremental linking mode.
1599 Incremental_mode incremental_mode_;
1600 // The disposition given by the --incremental-changed,
1601 // --incremental-unchanged or --incremental-unknown option. The
1602 // value may change as we proceed parsing the command line flags.
1603 Incremental_disposition incremental_disposition_;
1604 // The disposition to use for startup files (those marked
1605 // INCREMENTAL_STARTUP).
1606 Incremental_disposition incremental_startup_disposition_;
1607 // Whether we have seen one of the options that require incremental
1608 // build (--incremental-changed, --incremental-unchanged,
1609 // --incremental-unknown, or --incremental-startup-unchanged).
1610 bool implicit_incremental_;
1611 // Libraries excluded from automatic export, via --exclude-libs.
1612 Unordered_set<std::string> excluded_libs_;
1613 // List of symbol-names to keep, via -retain-symbol-info.
1614 Unordered_set<std::string> symbols_to_retain_;
1615 // Map from section name to address from --section-start.
1616 std::map<std::string, uint64_t> section_starts_;
1617 // Whether to process armv4 bx instruction relocation.
1620 Endianness endianness_;
1623 // The position-dependent options. We use this to store the state of
1624 // the commandline at a particular point in parsing for later
1625 // reference. For instance, if we see "ld --whole-archive foo.a
1626 // --no-whole-archive," we want to store the whole-archive option with
1627 // foo.a, so when the time comes to parse foo.a we know we should do
1628 // it in whole-archive mode. We could store all of General_options,
1629 // but that's big, so we just pick the subset of flags that actually
1630 // change in a position-dependent way.
1632 #define DEFINE_posdep(varname__, type__) \
1636 { return this->varname__##_; } \
1639 set_##varname__(type__ value) \
1640 { this->varname__##_ = value; } \
1644 class Position_dependent_options
1647 Position_dependent_options(const General_options& options
1648 = Position_dependent_options::default_options_)
1649 { copy_from_options(options); }
1651 void copy_from_options(const General_options& options)
1653 this->set_as_needed(options.as_needed());
1654 this->set_Bdynamic(options.Bdynamic());
1655 this->set_format_enum(options.format_enum());
1656 this->set_whole_archive(options.whole_archive());
1657 this->set_incremental_disposition(options.incremental_disposition());
1660 DEFINE_posdep(as_needed, bool);
1661 DEFINE_posdep(Bdynamic, bool);
1662 DEFINE_posdep(format_enum, General_options::Object_format);
1663 DEFINE_posdep(whole_archive, bool);
1664 DEFINE_posdep(incremental_disposition, Incremental_disposition);
1667 // This is a General_options with everything set to its default
1668 // value. A Position_dependent_options created with no argument
1669 // will take its values from here.
1670 static General_options default_options_;
1674 // A single file or library argument from the command line.
1676 class Input_file_argument
1679 enum Input_file_type
1681 // A regular file, name used as-is, not searched.
1682 INPUT_FILE_TYPE_FILE,
1683 // A library name. When used, "lib" will be prepended and ".so" or
1684 // ".a" appended to make a filename, and that filename will be searched
1685 // for using the -L paths.
1686 INPUT_FILE_TYPE_LIBRARY,
1687 // A regular file, name used as-is, but searched using the -L paths.
1688 INPUT_FILE_TYPE_SEARCHED_FILE
1691 // name: file name or library name
1692 // type: the type of this input file.
1693 // extra_search_path: an extra directory to look for the file, prior
1694 // to checking the normal library search path. If this is "",
1695 // then no extra directory is added.
1696 // just_symbols: whether this file only defines symbols.
1697 // options: The position dependent options at this point in the
1698 // command line, such as --whole-archive.
1699 Input_file_argument()
1700 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1701 just_symbols_(false), options_(), arg_serial_(0)
1704 Input_file_argument(const char* name, Input_file_type type,
1705 const char* extra_search_path,
1707 const Position_dependent_options& options)
1708 : name_(name), type_(type), extra_search_path_(extra_search_path),
1709 just_symbols_(just_symbols), options_(options), arg_serial_(0)
1712 // You can also pass in a General_options instance instead of a
1713 // Position_dependent_options. In that case, we extract the
1714 // position-independent vars from the General_options and only store
1716 Input_file_argument(const char* name, Input_file_type type,
1717 const char* extra_search_path,
1719 const General_options& options)
1720 : name_(name), type_(type), extra_search_path_(extra_search_path),
1721 just_symbols_(just_symbols), options_(options), arg_serial_(0)
1726 { return this->name_.c_str(); }
1728 const Position_dependent_options&
1730 { return this->options_; }
1734 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1737 is_searched_file() const
1738 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1741 extra_search_path() const
1743 return (this->extra_search_path_.empty()
1745 : this->extra_search_path_.c_str());
1748 // Return whether we should only read symbols from this file.
1750 just_symbols() const
1751 { return this->just_symbols_; }
1753 // Return whether this file may require a search using the -L
1756 may_need_search() const
1758 return (this->is_lib()
1759 || this->is_searched_file()
1760 || !this->extra_search_path_.empty());
1763 // Set the serial number for this argument.
1765 set_arg_serial(unsigned int arg_serial)
1766 { this->arg_serial_ = arg_serial; }
1768 // Get the serial number.
1771 { return this->arg_serial_; }
1774 // We use std::string, not const char*, here for convenience when
1775 // using script files, so that we do not have to preserve the string
1778 Input_file_type type_;
1779 std::string extra_search_path_;
1781 Position_dependent_options options_;
1782 // A unique index for this file argument in the argument list.
1783 unsigned int arg_serial_;
1786 // A file or library, or a group, from the command line.
1788 class Input_argument
1791 // Create a file or library argument.
1792 explicit Input_argument(Input_file_argument file)
1793 : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
1796 // Create a group argument.
1797 explicit Input_argument(Input_file_group* group)
1798 : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
1801 // Create a lib argument.
1802 explicit Input_argument(Input_file_lib* lib)
1803 : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
1806 // Return whether this is a file.
1809 { return this->is_file_; }
1811 // Return whether this is a group.
1814 { return !this->is_file_ && this->lib_ == NULL; }
1816 // Return whether this is a lib.
1819 { return this->lib_ != NULL; }
1821 // Return the information about the file.
1822 const Input_file_argument&
1825 gold_assert(this->is_file_);
1829 // Return the information about the group.
1830 const Input_file_group*
1833 gold_assert(!this->is_file_);
1834 return this->group_;
1840 gold_assert(!this->is_file_);
1841 return this->group_;
1844 // Return the information about the lib.
1845 const Input_file_lib*
1848 gold_assert(!this->is_file_);
1849 gold_assert(this->lib_);
1856 gold_assert(!this->is_file_);
1857 gold_assert(this->lib_);
1861 // If a script generated this argument, store a pointer to the script info.
1862 // Currently used only for recording incremental link information.
1864 set_script_info(Script_info* info)
1865 { this->script_info_ = info; }
1869 { return this->script_info_; }
1873 Input_file_argument file_;
1874 Input_file_group* group_;
1875 Input_file_lib* lib_;
1876 Script_info* script_info_;
1879 typedef std::vector<Input_argument> Input_argument_list;
1881 // A group from the command line. This is a set of arguments within
1882 // --start-group ... --end-group.
1884 class Input_file_group
1887 typedef Input_argument_list::const_iterator const_iterator;
1893 // Add a file to the end of the group.
1895 add_file(const Input_file_argument& arg)
1897 this->files_.push_back(Input_argument(arg));
1898 return this->files_.back();
1901 // Iterators to iterate over the group contents.
1905 { return this->files_.begin(); }
1909 { return this->files_.end(); }
1912 Input_argument_list files_;
1915 // A lib from the command line. This is a set of arguments within
1916 // --start-lib ... --end-lib.
1918 class Input_file_lib
1921 typedef Input_argument_list::const_iterator const_iterator;
1923 Input_file_lib(const Position_dependent_options& options)
1924 : files_(), options_(options)
1927 // Add a file to the end of the lib.
1929 add_file(const Input_file_argument& arg)
1931 this->files_.push_back(Input_argument(arg));
1932 return this->files_.back();
1935 const Position_dependent_options&
1937 { return this->options_; }
1939 // Iterators to iterate over the lib contents.
1943 { return this->files_.begin(); }
1947 { return this->files_.end(); }
1951 { return this->files_.size(); }
1954 Input_argument_list files_;
1955 Position_dependent_options options_;
1958 // A list of files from the command line or a script.
1960 class Input_arguments
1963 typedef Input_argument_list::const_iterator const_iterator;
1966 : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
1971 add_file(Input_file_argument& arg);
1973 // Start a group (the --start-group option).
1977 // End a group (the --end-group option).
1981 // Start a lib (the --start-lib option).
1983 start_lib(const Position_dependent_options&);
1985 // End a lib (the --end-lib option).
1989 // Return whether we are currently in a group.
1992 { return this->in_group_; }
1994 // Return whether we are currently in a lib.
1997 { return this->in_lib_; }
1999 // The number of entries in the list.
2002 { return this->input_argument_list_.size(); }
2004 // Iterators to iterate over the list of input files.
2008 { return this->input_argument_list_.begin(); }
2012 { return this->input_argument_list_.end(); }
2014 // Return whether the list is empty.
2017 { return this->input_argument_list_.empty(); }
2019 // Return the number of input files. This may be larger than
2020 // input_argument_list_.size(), because of files that are part
2021 // of groups or libs.
2023 number_of_input_files() const
2024 { return this->file_count_; }
2027 Input_argument_list input_argument_list_;
2030 unsigned int file_count_;
2034 // All the information read from the command line. These are held in
2035 // three separate structs: one to hold the options (--foo), one to
2036 // hold the filenames listed on the commandline, and one to hold
2037 // linker script information. This third is not a subset of the other
2038 // two because linker scripts can be specified either as options (via
2039 // -T) or as a file.
2044 typedef Input_arguments::const_iterator const_iterator;
2048 // Process the command line options. This will exit with an
2049 // appropriate error message if an unrecognized option is seen.
2051 process(int argc, const char** argv);
2053 // Process one command-line option. This takes the index of argv to
2054 // process, and returns the index for the next option. no_more_options
2055 // is set to true if argv[i] is "--".
2057 process_one_option(int argc, const char** argv, int i,
2058 bool* no_more_options);
2060 // Get the general options.
2061 const General_options&
2063 { return this->options_; }
2065 // Get the position dependent options.
2066 const Position_dependent_options&
2067 position_dependent_options() const
2068 { return this->position_options_; }
2070 // Get the linker-script options.
2073 { return this->script_options_; }
2075 // Finalize the version-script options and return them.
2076 const Version_script_info&
2079 // Get the input files.
2082 { return this->inputs_; }
2084 // The number of input files.
2086 number_of_input_files() const
2087 { return this->inputs_.number_of_input_files(); }
2089 // Iterators to iterate over the list of input files.
2093 { return this->inputs_.begin(); }
2097 { return this->inputs_.end(); }
2100 Command_line(const Command_line&);
2101 Command_line& operator=(const Command_line&);
2103 // This is a dummy class to provide a constructor that runs before
2104 // the constructor for the General_options. The Pre_options constructor
2105 // is used as a hook to set the flag enabling the options to register
2107 struct Pre_options {
2111 // This must come before options_!
2112 Pre_options pre_options_;
2113 General_options options_;
2114 Position_dependent_options position_options_;
2115 Script_options script_options_;
2116 Input_arguments inputs_;
2119 } // End namespace gold.
2121 #endif // !defined(GOLD_OPTIONS_H)