1 // options.h -- handle command line options for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008, 2009, 2010, 2011, 2013
4 // Free Software Foundation, Inc.
5 // Written by Ian Lance Taylor <iant@google.com>.
7 // This file is part of gold.
9 // This program is free software; you can redistribute it and/or modify
10 // it under the terms of the GNU General Public License as published by
11 // the Free Software Foundation; either version 3 of the License, or
12 // (at your option) any later version.
14 // This program is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 // GNU General Public License for more details.
19 // You should have received a copy of the GNU General Public License
20 // along with this program; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
22 // MA 02110-1301, USA.
24 // General_options (from Command_line::options())
25 // All the options (a.k.a. command-line flags)
26 // Input_argument (from Command_line::inputs())
27 // The list of input files, including -l options.
29 // Everything we get from the command line -- the General_options
30 // plus the Input_arguments.
32 // There are also some smaller classes, such as
33 // Position_dependent_options which hold a subset of General_options
34 // that change as options are parsed (as opposed to the usual behavior
35 // of the last instance of that option specified on the commandline wins).
37 #ifndef GOLD_OPTIONS_H
38 #define GOLD_OPTIONS_H
54 class General_options;
55 class Search_directory;
56 class Input_file_group;
58 class Position_dependent_options;
63 // Incremental build action for a specific file, as selected by the user.
65 enum Incremental_disposition
67 // Startup files that appear before the first disposition option.
68 // These will default to INCREMENTAL_CHECK unless the
69 // --incremental-startup-unchanged option is given.
70 // (For files added implicitly by gcc before any user options.)
72 // Determine the status from the timestamp (default).
74 // Assume the file changed from the previous build.
76 // Assume the file didn't change from the previous build.
80 // The nested namespace is to contain all the global variables and
81 // structs that need to be defined in the .h file, but do not need to
82 // be used outside this class.
85 typedef std::vector<Search_directory> Dir_list;
86 typedef Unordered_set<std::string> String_set;
88 // These routines convert from a string option to various types.
89 // Each gives a fatal error if it cannot parse the argument.
92 parse_bool(const char* option_name, const char* arg, bool* retval);
95 parse_int(const char* option_name, const char* arg, int* retval);
98 parse_uint(const char* option_name, const char* arg, int* retval);
101 parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
104 parse_double(const char* option_name, const char* arg, double* retval);
107 parse_percent(const char* option_name, const char* arg, double* retval);
110 parse_string(const char* option_name, const char* arg, const char** retval);
113 parse_optional_string(const char* option_name, const char* arg,
114 const char** retval);
117 parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
120 parse_set(const char* option_name, const char* arg, String_set* retval);
123 parse_choices(const char* option_name, const char* arg, const char** retval,
124 const char* choices[], int num_choices);
128 // Most options have both a shortname (one letter) and a longname.
129 // This enum controls how many dashes are expected for longname access
130 // -- shortnames always use one dash. Most longnames will accept
131 // either one dash or two; the only difference between ONE_DASH and
132 // TWO_DASHES is how we print the option in --help. However, some
133 // longnames require two dashes, and some require only one. The
134 // special value DASH_Z means that the option is preceded by "-z".
137 ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z
140 // LONGNAME is the long-name of the option with dashes converted to
141 // underscores, or else the short-name if the option has no long-name.
142 // It is never the empty string.
143 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
144 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
145 // option has no short-name. If the option has no long-name, you
146 // should specify the short-name in *both* VARNAME and here.
147 // DEFAULT_VALUE is the value of the option if not specified on the
148 // commandline, as a string.
149 // HELPSTRING is the descriptive text used with the option via --help
150 // HELPARG is how you define the argument to the option.
151 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
152 // HELPARG should be NULL iff the option is a bool and takes no arg.
153 // OPTIONAL_ARG is true if this option takes an optional argument. An
154 // optional argument must be specifid as --OPTION=VALUE, not
156 // READER provides parse_to_value, which is a function that will convert
157 // a char* argument into the proper type and store it in some variable.
158 // A One_option struct initializes itself with the global list of options
159 // at constructor time, so be careful making one of these.
162 std::string longname;
165 const char* default_value;
166 const char* helpstring;
171 One_option(const char* ln, Dashes d, char sn, const char* dv,
172 const char* hs, const char* ha, bool oa, Struct_var* r)
173 : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
174 helpstring(hs), helparg(ha), optional_arg(oa), reader(r)
176 // In longname, we convert all underscores to dashes, since GNU
177 // style uses dashes in option names. longname is likely to have
178 // underscores in it because it's also used to declare a C++
180 const char* pos = strchr(this->longname.c_str(), '_');
181 for (; pos; pos = strchr(pos, '_'))
182 this->longname[pos - this->longname.c_str()] = '-';
184 // We only register ourselves if our helpstring is not NULL. This
185 // is to support the "no-VAR" boolean variables, which we
186 // conditionally turn on by defining "no-VAR" help text.
187 if (this->helpstring)
188 this->register_option();
191 // This option takes an argument iff helparg is not NULL.
193 takes_argument() const
194 { return this->helparg != NULL; }
196 // Whether the argument is optional.
198 takes_optional_argument() const
199 { return this->optional_arg; }
201 // Register this option with the global list of options.
205 // Print this option to stdout (used with --help).
210 // All options have a Struct_##varname that inherits from this and
211 // actually implements parse_to_value for that option.
214 // OPTION: the name of the option as specified on the commandline,
215 // including leading dashes, and any text following the option:
216 // "-O", "--defsym=mysym=0x1000", etc.
217 // ARG: the arg associated with this option, or NULL if the option
218 // takes no argument: "2", "mysym=0x1000", etc.
219 // CMDLINE: the global Command_line object. Used by DEFINE_special.
220 // OPTIONS: the global General_options object. Used by DEFINE_special.
222 parse_to_value(const char* option, const char* arg,
223 Command_line* cmdline, General_options* options) = 0;
225 ~Struct_var() // To make gcc happy.
229 // This is for "special" options that aren't of any predefined type.
230 struct Struct_special : public Struct_var
232 // If you change this, change the parse-fn in DEFINE_special as well.
233 typedef void (General_options::*Parse_function)(const char*, const char*,
235 Struct_special(const char* varname, Dashes dashes, char shortname,
236 Parse_function parse_function,
237 const char* helpstring, const char* helparg)
238 : option(varname, dashes, shortname, "", helpstring, helparg, false, this),
239 parse(parse_function)
242 void parse_to_value(const char* option, const char* arg,
243 Command_line* cmdline, General_options* options)
244 { (options->*(this->parse))(option, arg, cmdline); }
247 Parse_function parse;
250 } // End namespace options.
253 // These are helper macros use by DEFINE_uint64/etc below.
254 // This macro is used inside the General_options_ class, so defines
255 // var() and set_var() as General_options methods. Arguments as are
256 // for the constructor for One_option. param_type__ is the same as
257 // type__ for built-in types, and "const type__ &" otherwise.
259 // When we define the linker command option "assert", the macro argument
260 // varname__ of DEFINE_var below will be replaced by "assert". On Mac OSX
261 // assert.h is included implicitly by one of the library headers we use. To
262 // avoid unintended macro substitution of "assert()", we need to enclose
263 // varname__ with parenthese.
264 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
265 default_value_as_string__, helpstring__, helparg__, \
266 optional_arg__, type__, param_type__, parse_fn__) \
269 (varname__)() const \
270 { return this->varname__##_.value; } \
273 user_set_##varname__() const \
274 { return this->varname__##_.user_set_via_option; } \
277 set_user_set_##varname__() \
278 { this->varname__##_.user_set_via_option = true; } \
281 struct Struct_##varname__ : public options::Struct_var \
283 Struct_##varname__() \
284 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
285 helpstring__, helparg__, optional_arg__, this), \
286 user_set_via_option(false), value(default_value__) \
290 parse_to_value(const char* option_name, const char* arg, \
291 Command_line*, General_options*) \
293 parse_fn__(option_name, arg, &this->value); \
294 this->user_set_via_option = true; \
297 options::One_option option; \
298 bool user_set_via_option; \
301 Struct_##varname__ varname__##_; \
303 set_##varname__(param_type__ value) \
304 { this->varname__##_.value = value; }
306 // These macros allow for easy addition of a new commandline option.
308 // If no_helpstring__ is not NULL, then in addition to creating
309 // VARNAME, we also create an option called no-VARNAME (or, for a -z
310 // option, noVARNAME).
311 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
312 helpstring__, no_helpstring__) \
313 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
314 default_value__ ? "true" : "false", helpstring__, NULL, \
315 false, bool, bool, options::parse_bool) \
316 struct Struct_no_##varname__ : public options::Struct_var \
318 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
320 : "no-" #varname__), \
322 default_value__ ? "false" : "true", \
323 no_helpstring__, NULL, false, this) \
327 parse_to_value(const char*, const char*, \
328 Command_line*, General_options* options) \
330 options->set_##varname__(false); \
331 options->set_user_set_##varname__(); \
334 options::One_option option; \
336 Struct_no_##varname__ no_##varname__##_initializer_
338 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
339 helpstring__, no_helpstring__) \
340 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
341 default_value__ ? "true" : "false", helpstring__, NULL, \
342 false, bool, bool, options::parse_bool) \
343 struct Struct_disable_##varname__ : public options::Struct_var \
345 Struct_disable_##varname__() : option("disable-" #varname__, \
347 default_value__ ? "false" : "true", \
348 no_helpstring__, NULL, false, this) \
352 parse_to_value(const char*, const char*, \
353 Command_line*, General_options* options) \
354 { options->set_enable_##varname__(false); } \
356 options::One_option option; \
358 Struct_disable_##varname__ disable_##varname__##_initializer_
360 #define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
361 helpstring__, helparg__) \
362 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
363 #default_value__, helpstring__, helparg__, false, \
364 int, int, options::parse_int)
366 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
367 helpstring__, helparg__) \
368 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
369 #default_value__, helpstring__, helparg__, false, \
370 int, int, options::parse_uint)
372 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
373 helpstring__, helparg__) \
374 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
375 #default_value__, helpstring__, helparg__, false, \
376 uint64_t, uint64_t, options::parse_uint64)
378 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
379 helpstring__, helparg__) \
380 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
381 #default_value__, helpstring__, helparg__, false, \
382 double, double, options::parse_double)
384 #define DEFINE_percent(varname__, dashes__, shortname__, default_value__, \
385 helpstring__, helparg__) \
386 DEFINE_var(varname__, dashes__, shortname__, default_value__ / 100.0, \
387 #default_value__, helpstring__, helparg__, false, \
388 double, double, options::parse_percent)
390 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
391 helpstring__, helparg__) \
392 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
393 default_value__, helpstring__, helparg__, false, \
394 const char*, const char*, options::parse_string)
396 // This is like DEFINE_string, but we convert each occurrence to a
397 // Search_directory and store it in a vector. Thus we also have the
398 // add_to_VARNAME() method, to append to the vector.
399 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
400 helpstring__, helparg__) \
401 DEFINE_var(varname__, dashes__, shortname__, , \
402 "", helpstring__, helparg__, false, options::Dir_list, \
403 const options::Dir_list&, options::parse_dirlist) \
405 add_to_##varname__(const char* new_value) \
406 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
408 add_search_directory_to_##varname__(const Search_directory& dir) \
409 { this->varname__##_.value.push_back(dir); }
411 // This is like DEFINE_string, but we store a set of strings.
412 #define DEFINE_set(varname__, dashes__, shortname__, \
413 helpstring__, helparg__) \
414 DEFINE_var(varname__, dashes__, shortname__, , \
415 "", helpstring__, helparg__, false, options::String_set, \
416 const options::String_set&, options::parse_set) \
419 any_##varname__() const \
420 { return !this->varname__##_.value.empty(); } \
423 is_##varname__(const char* symbol) const \
425 return (!this->varname__##_.value.empty() \
426 && (this->varname__##_.value.find(std::string(symbol)) \
427 != this->varname__##_.value.end())); \
430 options::String_set::const_iterator \
431 varname__##_begin() const \
432 { return this->varname__##_.value.begin(); } \
434 options::String_set::const_iterator \
435 varname__##_end() const \
436 { return this->varname__##_.value.end(); }
438 // When you have a list of possible values (expressed as string)
439 // After helparg__ should come an initializer list, like
440 // {"foo", "bar", "baz"}
441 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
442 helpstring__, helparg__, ...) \
443 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
444 default_value__, helpstring__, helparg__, false, \
445 const char*, const char*, parse_choices_##varname__) \
447 static void parse_choices_##varname__(const char* option_name, \
449 const char** retval) { \
450 const char* choices[] = __VA_ARGS__; \
451 options::parse_choices(option_name, arg, retval, \
452 choices, sizeof(choices) / sizeof(*choices)); \
455 // This is like DEFINE_bool, but VARNAME is the name of a different
456 // option. This option becomes an alias for that one. INVERT is true
457 // if this option is an inversion of the other one.
458 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
459 helpstring__, no_helpstring__, invert__) \
461 struct Struct_##option__ : public options::Struct_var \
463 Struct_##option__() \
464 : option(#option__, dashes__, shortname__, "", helpstring__, \
469 parse_to_value(const char*, const char*, \
470 Command_line*, General_options* options) \
472 options->set_##varname__(!invert__); \
473 options->set_user_set_##varname__(); \
476 options::One_option option; \
478 Struct_##option__ option__##_; \
480 struct Struct_no_##option__ : public options::Struct_var \
482 Struct_no_##option__() \
483 : option((dashes__ == options::DASH_Z \
485 : "no-" #option__), \
486 dashes__, '\0', "", no_helpstring__, \
491 parse_to_value(const char*, const char*, \
492 Command_line*, General_options* options) \
494 options->set_##varname__(invert__); \
495 options->set_user_set_##varname__(); \
498 options::One_option option; \
500 Struct_no_##option__ no_##option__##_initializer_
502 // This is like DEFINE_uint64, but VARNAME is the name of a different
503 // option. This option becomes an alias for that one.
504 #define DEFINE_uint64_alias(option__, varname__, dashes__, shortname__, \
505 helpstring__, helparg__) \
507 struct Struct_##option__ : public options::Struct_var \
509 Struct_##option__() \
510 : option(#option__, dashes__, shortname__, "", helpstring__, \
511 helparg__, false, this) \
515 parse_to_value(const char* option_name, const char* arg, \
516 Command_line*, General_options* options) \
519 options::parse_uint64(option_name, arg, &value); \
520 options->set_##varname__(value); \
521 options->set_user_set_##varname__(); \
524 options::One_option option; \
526 Struct_##option__ option__##_;
528 // This is used for non-standard flags. It defines no functions; it
529 // just calls General_options::parse_VARNAME whenever the flag is
530 // seen. We declare parse_VARNAME as a static member of
531 // General_options; you are responsible for defining it there.
532 // helparg__ should be NULL iff this special-option is a boolean.
533 #define DEFINE_special(varname__, dashes__, shortname__, \
534 helpstring__, helparg__) \
536 void parse_##varname__(const char* option, const char* arg, \
537 Command_line* inputs); \
538 struct Struct_##varname__ : public options::Struct_special \
540 Struct_##varname__() \
541 : options::Struct_special(#varname__, dashes__, shortname__, \
542 &General_options::parse_##varname__, \
543 helpstring__, helparg__) \
546 Struct_##varname__ varname__##_initializer_
548 // An option that takes an optional string argument. If the option is
549 // used with no argument, the value will be the default, and
550 // user_set_via_option will be true.
551 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
553 helpstring__, helparg__) \
554 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
555 default_value__, helpstring__, helparg__, true, \
556 const char*, const char*, options::parse_optional_string)
558 // A directory to search. For each directory we record whether it is
559 // in the sysroot. We need to know this so that, if a linker script
560 // is found within the sysroot, we will apply the sysroot to any files
561 // named by that script.
563 class Search_directory
566 // We need a default constructor because we put this in a
569 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
572 // This is the usual constructor.
573 Search_directory(const std::string& name, bool put_in_sysroot)
574 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
576 if (this->name_.empty())
580 // This is called if we have a sysroot. The sysroot is prefixed to
581 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
582 // set to true for any enries which are in the sysroot (this will
583 // naturally include any entries for which put_in_sysroot_ is true).
584 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
585 // passing SYSROOT to lrealpath.
587 add_sysroot(const char* sysroot, const char* canonical_sysroot);
589 // Get the directory name.
592 { return this->name_; }
594 // Return whether this directory is in the sysroot.
596 is_in_sysroot() const
597 { return this->is_in_sysroot_; }
599 // Return whether this is considered a system directory.
601 is_system_directory() const
602 { return this->put_in_sysroot_ || this->is_in_sysroot_; }
605 // The directory name.
607 // True if the sysroot should be added as a prefix for this
608 // directory (if there is a sysroot). This is true for system
609 // directories that we search by default.
610 bool put_in_sysroot_;
611 // True if this directory is in the sysroot (if there is a sysroot).
612 // This is true if there is a sysroot and either 1) put_in_sysroot_
613 // is true, or 2) the directory happens to be in the sysroot based
614 // on a pathname comparison.
618 class General_options
621 // NOTE: For every option that you add here, also consider if you
622 // should add it to Position_dependent_options.
623 DEFINE_special(help, options::TWO_DASHES, '\0',
624 N_("Report usage information"), NULL);
625 DEFINE_special(version, options::TWO_DASHES, 'v',
626 N_("Report version information"), NULL);
627 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
628 N_("Report version and target information"), NULL);
630 // These options are sorted approximately so that for each letter in
631 // the alphabet, we show the option whose shortname is that letter
632 // (if any) and then every longname that starts with that letter (in
633 // alphabetical order). For both, lowercase sorts before uppercase.
634 // The -z options come last.
636 DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
638 N_("Do not copy DT_NEEDED tags from shared libraries"));
640 DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
641 '\0', N_("Allow multiple definitions of symbols"),
642 N_("Do not allow multiple definitions"), false);
644 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
645 N_("Allow unresolved references in shared libraries"),
646 N_("Do not allow unresolved references in shared libraries"));
648 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
649 N_("Only set DT_NEEDED for shared libraries if used"),
650 N_("Always DT_NEEDED for shared libraries"));
652 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
653 N_("Ignored"), N_("[ignored]"),
654 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
656 // This should really be an "enum", but it's too easy for folks to
657 // forget to update the list as they add new targets. So we just
658 // accept any string. We'll fail later (when the string is parsed),
659 // if the target isn't actually supported.
660 DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
661 N_("Set input format"), ("[elf,binary]"));
663 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
664 N_("-l searches for shared libraries"), NULL);
665 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
666 N_("-l does not search for shared libraries"), NULL,
668 DEFINE_bool_alias(dy, Bdynamic, options::ONE_DASH, '\0',
669 N_("alias for -Bdynamic"), NULL, false);
670 DEFINE_bool_alias(dn, Bdynamic, options::ONE_DASH, '\0',
671 N_("alias for -Bstatic"), NULL, true);
673 DEFINE_bool(Bgroup, options::ONE_DASH, '\0', false,
674 N_("Use group name lookup rules for shared library"), NULL);
676 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
677 N_("Bind defined symbols locally"), NULL);
679 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
680 N_("Bind defined function symbols locally"), NULL);
682 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "tree",
683 N_("Generate build ID note"),
686 DEFINE_uint64(build_id_chunk_size_for_treehash,
687 options::TWO_DASHES, '\0', 2 << 20,
688 N_("Chunk size for '--build-id=tree'"), N_("SIZE"));
690 DEFINE_uint64(build_id_min_file_size_for_treehash, options::TWO_DASHES,
692 N_("Minimum output file size for '--build-id=tree' to work"
693 " differently than '--build-id=sha1'"), N_("SIZE"));
695 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
696 N_("Check segment addresses for overlaps (default)"),
697 N_("Do not check segment addresses for overlaps"));
700 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
701 N_("Compress .debug_* sections in the output file"),
705 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
706 N_("Compress .debug_* sections in the output file"),
711 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
713 N_("Do not copy DT_NEEDED tags from shared libraries"));
715 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
716 N_("Output cross reference table"),
717 N_("Do not output cross reference table"));
719 DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
720 N_("Use DT_INIT_ARRAY for all constructors (default)"),
721 N_("Handle constructors as directed by compiler"));
723 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
724 N_("Define common symbols"),
725 N_("Do not define common symbols"));
726 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
727 N_("Alias for -d"), NULL);
728 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
729 N_("Alias for -d"), NULL);
731 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
732 N_("Turn on debugging"),
733 N_("[all,files,script,task][,...]"));
735 DEFINE_special(defsym, options::TWO_DASHES, '\0',
736 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
738 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
739 N_("Demangle C++ symbols in log messages"),
742 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
743 N_("Do not demangle C++ symbols in log messages"),
746 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
747 N_("Look for violations of the C++ One Definition Rule"),
748 N_("Do not look for violations of the C++ One Definition Rule"));
750 DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
751 N_("Delete all local symbols"), NULL);
752 DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
753 N_("Delete all temporary local symbols"), NULL);
755 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
756 N_("Add data symbols to dynamic symbols"), NULL);
758 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
759 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
761 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
762 N_("Add C++ typeinfo to dynamic symbols"), NULL);
764 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
765 N_("Read a list of dynamic symbols"), N_("FILE"));
767 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
768 N_("Set program start address"), N_("ADDRESS"));
770 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
771 N_("Exclude libraries from automatic export"),
772 N_(("lib,lib ...")));
774 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
775 N_("Export all dynamic symbols"),
776 N_("Do not export all dynamic symbols (default)"));
778 DEFINE_set(export_dynamic_symbol, options::TWO_DASHES, '\0',
779 N_("Export SYMBOL to dynamic symbol table"), N_("SYMBOL"));
781 DEFINE_special(EB, options::ONE_DASH, '\0',
782 N_("Link big-endian objects."), NULL);
784 DEFINE_special(EL, options::ONE_DASH, '\0',
785 N_("Link little-endian objects."), NULL);
787 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
788 N_("Create exception frame header"), NULL);
790 DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
791 N_("(ARM only) Do not warn about objects with incompatible "
794 DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
795 N_("Auxiliary filter for shared object symbol table"),
798 DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
799 N_("Filter for shared object symbol table"),
802 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
803 N_("Treat warnings as errors"),
804 N_("Do not treat warnings as errors"));
806 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
807 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
809 DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
810 N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
811 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
813 DEFINE_bool(fix_arm1176, options::TWO_DASHES, '\0', true,
814 N_("(ARM only) Fix binaries for ARM1176 erratum."),
815 N_("(ARM only) Do not fix binaries for ARM1176 erratum."));
817 DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
818 N_("(ARM only) Merge exidx entries in debuginfo."),
819 N_("(ARM only) Do not merge exidx entries in debuginfo."));
821 DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
822 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
825 DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
826 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
830 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
831 N_("Ignored"), NULL);
833 DEFINE_bool(gdb_index, options::TWO_DASHES, '\0', false,
834 N_("Generate .gdb_index section"),
835 N_("Do not generate .gdb_index section"));
837 DEFINE_bool(gnu_unique, options::TWO_DASHES, '\0', true,
838 N_("Enable STB_GNU_UNIQUE symbol binding (default)"),
839 N_("Disable STB_GNU_UNIQUE symbol binding"));
841 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
842 N_("Set shared library name"), N_("FILENAME"));
844 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
845 N_("Min fraction of empty buckets in dynamic hash"),
848 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
849 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
850 {"sysv", "gnu", "both"});
852 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
853 N_("Set dynamic linker path"), N_("PROGRAM"));
855 DEFINE_special(incremental, options::TWO_DASHES, '\0',
856 N_("Do an incremental link if possible; "
857 "otherwise, do a full link and prepare output "
858 "for incremental linking"), NULL);
860 DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
861 N_("Do a full link (default)"), NULL);
863 DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
864 N_("Do a full link and "
865 "prepare output for incremental linking"), NULL);
867 DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
868 N_("Do an incremental link; exit if not possible"), NULL);
870 DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
871 N_("Set base file for incremental linking"
872 " (default is output file)"),
875 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
876 N_("Assume files changed"), NULL);
878 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
879 N_("Assume files didn't change"), NULL);
881 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
882 N_("Use timestamps to check files (default)"), NULL);
884 DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
885 N_("Assume startup files unchanged "
886 "(files preceding this option)"), NULL);
888 DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
889 N_("Amount of extra space to allocate for patches"),
892 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
893 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
895 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
896 N_("Read only symbol values from FILE"), N_("FILE"));
898 DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
900 N_("Map whole files to memory (default on 64-bit hosts)"),
901 N_("Map relevant file parts to memory (default on 32-bit "
903 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
904 N_("Keep files mapped across passes (default)"),
905 N_("Release mapped files after each pass"));
907 DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
908 N_("Generate unwind information for PLT (default)"),
909 N_("Do not generate unwind information for PLT"));
911 DEFINE_special(library, options::TWO_DASHES, 'l',
912 N_("Search for library LIBNAME"), N_("LIBNAME"));
914 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
915 N_("Add directory to search path"), N_("DIR"));
917 DEFINE_bool(text_reorder, options::TWO_DASHES, '\0', true,
918 N_("Enable text section reordering for GCC section names "
920 N_("Disable text section reordering for GCC section names"));
922 DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
923 N_("Only search directories specified on the command line."),
926 DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
927 N_("Put read-only non-executable sections in their own segment"),
930 DEFINE_uint64(rosegment_gap, options::TWO_DASHES, '\0', -1U,
931 N_("Set offset between executable and read-only segments"),
934 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
935 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
937 DEFINE_bool(mmap_output_file, options::TWO_DASHES, '\0', true,
938 N_("Map the output file for writing (default)."),
939 N_("Do not map the output file for writing."));
941 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
942 N_("Write map file on standard output"), NULL);
943 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
946 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
947 N_("Do not page align data"), NULL);
948 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
949 N_("Do not page align data, do not make text readonly"),
950 N_("Page align data, make text readonly"));
952 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', true,
953 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
954 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
956 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
957 N_("Create an output file even if errors occur"), NULL);
959 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
960 N_("Report undefined symbols (even with --shared)"),
963 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
964 N_("Set output file name"), N_("FILE"));
966 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
967 N_("Optimize output file size"), N_("LEVEL"));
969 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
970 N_("Set output format"), N_("[binary]"));
972 DEFINE_bool(p, options::ONE_DASH, '\0', false,
973 N_("(ARM only) Ignore for backward compatibility"), NULL);
975 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
976 N_("Create a position independent executable"), NULL);
977 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
978 N_("Create a position independent executable"), NULL,
981 DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
982 NULL, N_("(ARM only) Ignore for backward compatibility"));
984 DEFINE_var(plt_align, options::TWO_DASHES, '\0', 0, "5",
985 N_("(PowerPC64 only) Align PLT call stubs to fit cache lines"),
986 N_("[=P2ALIGN]"), true, int, int, options::parse_uint);
988 DEFINE_bool(plt_static_chain, options::TWO_DASHES, '\0', false,
989 N_("(PowerPC64 only) PLT call stubs should load r11"),
990 N_("(PowerPC64 only) PLT call stubs should not load r11"));
992 DEFINE_bool(plt_thread_safe, options::TWO_DASHES, '\0', false,
993 N_("(PowerPC64 only) PLT call stubs with load-load barrier"),
994 N_("(PowerPC64 only) PLT call stubs without barrier"));
996 #ifdef ENABLE_PLUGINS
997 DEFINE_special(plugin, options::TWO_DASHES, '\0',
998 N_("Load a plugin library"), N_("PLUGIN"));
999 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
1000 N_("Pass an option to the plugin"), N_("OPTION"));
1003 DEFINE_bool(posix_fallocate, options::TWO_DASHES, '\0', true,
1004 N_("Use posix_fallocate to reserve space in the output file"
1006 N_("Use fallocate or ftruncate to reserve space."));
1008 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
1009 N_("Preread archive symbols when multi-threaded"), NULL);
1011 DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
1012 N_("Print default output format"), NULL);
1014 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
1015 N_("Print symbols defined and used for each input"),
1018 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
1019 N_("Ignored for SVR4 compatibility"), NULL);
1021 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
1022 N_("Generate relocations in output"), NULL);
1024 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
1025 N_("Generate relocatable output"), NULL);
1026 DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
1027 N_("Synonym for -r"), NULL, false);
1029 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
1030 N_("Relax branches on certain targets"), NULL);
1032 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
1033 N_("keep only symbols listed in this file"), N_("FILE"));
1035 // -R really means -rpath, but can mean --just-symbols for
1036 // compatibility with GNU ld. -rpath is always -rpath, so we list
1038 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
1039 N_("Add DIR to runtime search path"), N_("DIR"));
1041 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
1042 N_("Add DIR to runtime search path"), N_("DIR"));
1044 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
1045 N_("Add DIR to link time shared library search path"),
1048 DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
1049 N_("Layout sections in the order specified."),
1052 DEFINE_special(section_start, options::TWO_DASHES, '\0',
1053 N_("Set address of section"), N_("SECTION=ADDRESS"));
1055 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
1056 N_("Sort common symbols by alignment"),
1057 N_("[={ascending,descending}]"));
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"),
1160 DEFINE_bool(toc_optimize, options::TWO_DASHES, '\0', true,
1161 N_("(PowerPC64 only) Optimize TOC code sequences"),
1162 N_("(PowerPC64 only) Don't optimize TOC code sequences"));
1164 DEFINE_bool(toc_sort, options::TWO_DASHES, '\0', true,
1165 N_("(PowerPC64 only) Sort TOC and GOT sections"),
1166 N_("(PowerPC64 only) Don't sort TOC and GOT sections"));
1168 DEFINE_set(undefined, options::TWO_DASHES, 'u',
1169 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1171 DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1172 N_("How to handle unresolved symbols"),
1173 ("ignore-all,report-all,ignore-in-object-files,"
1174 "ignore-in-shared-libs"),
1175 {"ignore-all", "report-all", "ignore-in-object-files",
1176 "ignore-in-shared-libs"});
1178 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1179 N_("Synonym for --debug=files"), NULL);
1181 DEFINE_special(version_script, options::TWO_DASHES, '\0',
1182 N_("Read version script"), N_("FILE"));
1184 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1185 N_("Warn about duplicate common symbols"),
1186 N_("Do not warn about duplicate common symbols (default)"));
1188 DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1189 N_("Ignored"), N_("Ignored"));
1191 DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1192 N_("Warn if the stack is executable"),
1193 N_("Do not warn if the stack is executable (default)"));
1195 DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1196 NULL, N_("Don't warn about mismatched input files"));
1198 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1199 N_("Ignored"), NULL);
1201 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1202 N_("Warn when skipping an incompatible library"),
1203 N_("Don't warn when skipping an incompatible library"));
1205 DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1206 N_("Warn if text segment is not shareable"),
1207 N_("Do not warn if text segment is not shareable (default)"));
1209 DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1210 N_("Report unresolved symbols as warnings"),
1212 DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1213 options::TWO_DASHES, '\0',
1214 N_("Report unresolved symbols as errors"),
1217 DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1218 N_("(ARM only) Do not warn about objects with incompatible "
1221 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1222 N_("Include all archive contents"),
1223 N_("Include only needed archive contents"));
1225 DEFINE_set(wrap, options::TWO_DASHES, '\0',
1226 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1228 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1229 N_("Trace references to symbol"), N_("SYMBOL"));
1231 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1232 N_("Allow unused version in script (default)"),
1233 N_("Do not allow unused version in script"));
1235 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1236 N_("Default search path for Solaris compatibility"),
1239 DEFINE_special(start_group, options::TWO_DASHES, '(',
1240 N_("Start a library search group"), NULL);
1241 DEFINE_special(end_group, options::TWO_DASHES, ')',
1242 N_("End a library search group"), NULL);
1245 DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1246 N_("Start a library"), NULL);
1247 DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1248 N_("End a library "), NULL);
1250 DEFINE_string(fuse_ld, options::ONE_DASH, '\0', "",
1251 N_("Ignored for GCC linker option compatibility"),
1256 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1257 N_("Sort dynamic relocs"),
1258 N_("Do not sort dynamic relocs"));
1259 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1260 N_("Set common page size to SIZE"), N_("SIZE"));
1261 DEFINE_bool(defs, options::DASH_Z, '\0', false,
1262 N_("Report undefined symbols (even with --shared)"),
1264 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1265 N_("Mark output as requiring executable stack"), NULL);
1266 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1267 N_("Mark DSO to be initialized first at runtime"),
1269 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1270 N_("Mark object to interpose all DSOs but executable"),
1272 DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1273 N_("Mark object for lazy runtime binding (default)"),
1275 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1276 N_("Mark object requiring immediate process"),
1278 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1279 N_("Set maximum page size to SIZE"), N_("SIZE"));
1280 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1281 N_("Allow multiple definitions of symbols"),
1283 // copyreloc is here in the list because there is only -z
1284 // nocopyreloc, not -z copyreloc.
1285 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1287 N_("Do not create copy relocs"));
1288 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1289 N_("Mark object not to use default search paths"),
1291 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1292 N_("Mark DSO non-deletable at runtime"),
1294 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1295 N_("Mark DSO not available to dlopen"),
1297 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1298 N_("Mark DSO not available to dldump"),
1300 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1301 N_("Mark output as not requiring executable stack"), NULL);
1302 DEFINE_bool(now, options::DASH_Z, '\0', false,
1303 N_("Mark object for immediate function binding"),
1305 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1306 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1307 "processing at runtime"), NULL);
1308 DEFINE_bool(relro, options::DASH_Z, '\0', false,
1309 N_("Where possible mark variables read-only after relocation"),
1310 N_("Don't mark variables read-only after relocation"));
1311 DEFINE_bool(text, options::DASH_Z, '\0', false,
1312 N_("Do not permit relocations in read-only segments"),
1313 N_("Permit relocations in read-only segments (default)"));
1314 DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1315 N_("Permit relocations in read-only segments (default)"),
1319 typedef options::Dir_list Dir_list;
1323 // Does post-processing on flags, making sure they all have
1324 // non-conflicting values. Also converts some flags from their
1325 // "standard" types (string, etc), to another type (enum, DirList),
1326 // which can be accessed via a separate method. Dies if it notices
1330 // True if we printed the version information.
1332 printed_version() const
1333 { return this->printed_version_; }
1335 // The macro defines output() (based on --output), but that's a
1336 // generic name. Provide this alternative name, which is clearer.
1338 output_file_name() const
1339 { return this->output(); }
1341 // This is not defined via a flag, but combines flags to say whether
1342 // the output is position-independent or not.
1344 output_is_position_independent() const
1345 { return this->shared() || this->pie(); }
1347 // Return true if the output is something that can be exec()ed, such
1348 // as a static executable, or a position-dependent or
1349 // position-independent executable, but not a dynamic library or an
1352 output_is_executable() const
1353 { return !this->shared() && !this->relocatable(); }
1355 // This would normally be static(), and defined automatically, but
1356 // since static is a keyword, we need to come up with our own name.
1361 // In addition to getting the input and output formats as a string
1362 // (via format() and oformat()), we also give access as an enum.
1367 // Straight binary format.
1368 OBJECT_FORMAT_BINARY
1371 // Convert a string to an Object_format. Gives an error if the
1372 // string is not recognized.
1373 static Object_format
1374 string_to_object_format(const char* arg);
1376 // Note: these functions are not very fast.
1377 Object_format format_enum() const;
1378 Object_format oformat_enum() const;
1380 // Return whether FILENAME is in a system directory.
1382 is_in_system_directory(const std::string& name) const;
1384 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1386 should_retain_symbol(const char* symbol_name) const
1388 if (symbols_to_retain_.empty()) // means flag wasn't specified
1390 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1393 // These are the best way to get access to the execstack state,
1394 // not execstack() and noexecstack() which are hard to use properly.
1396 is_execstack_set() const
1397 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1400 is_stack_executable() const
1401 { return this->execstack_status_ == EXECSTACK_YES; }
1405 { return this->icf_status_ != ICF_NONE; }
1408 icf_safe_folding() const
1409 { return this->icf_status_ == ICF_SAFE; }
1411 // The --demangle option takes an optional string, and there is also
1412 // a --no-demangle option. This is the best way to decide whether
1413 // to demangle or not.
1416 { return this->do_demangle_; }
1418 // Returns TRUE if any plugin libraries have been loaded.
1421 { return this->plugins_ != NULL; }
1423 // Return a pointer to the plugin manager.
1426 { return this->plugins_; }
1428 // True iff SYMBOL was found in the file specified by dynamic-list.
1430 in_dynamic_list(const char* symbol) const
1431 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1433 // Finalize the dynamic list.
1435 finalize_dynamic_list()
1436 { this->dynamic_list_.version_script_info()->finalize(); }
1438 // The mode selected by the --incremental options.
1439 enum Incremental_mode
1441 // No incremental linking (--no-incremental).
1443 // Incremental update only (--incremental-update).
1445 // Force a full link, but prepare for subsequent incremental link
1446 // (--incremental-full).
1448 // Incremental update if possible, fallback to full link (--incremental).
1452 // The incremental linking mode.
1454 incremental_mode() const
1455 { return this->incremental_mode_; }
1457 // The disposition given by the --incremental-changed,
1458 // --incremental-unchanged or --incremental-unknown option. The
1459 // value may change as we proceed parsing the command line flags.
1460 Incremental_disposition
1461 incremental_disposition() const
1462 { return this->incremental_disposition_; }
1464 // The disposition to use for startup files (those that precede the
1465 // first --incremental-changed, etc. option).
1466 Incremental_disposition
1467 incremental_startup_disposition() const
1468 { return this->incremental_startup_disposition_; }
1470 // Return true if S is the name of a library excluded from automatic
1473 check_excluded_libs(const std::string &s) const;
1475 // If an explicit start address was given for section SECNAME with
1476 // the --section-start option, return true and set *PADDR to the
1477 // address. Otherwise return false.
1479 section_start(const char* secname, uint64_t* paddr) const;
1481 // Return whether any --section-start option was used.
1483 any_section_start() const
1484 { return !this->section_starts_.empty(); }
1488 // Leave original instruction.
1490 // Replace instruction.
1492 // Generate an interworking veneer.
1493 FIX_V4BX_INTERWORKING
1498 { return (this->fix_v4bx_); }
1509 { return this->endianness_; }
1512 // Don't copy this structure.
1513 General_options(const General_options&);
1514 General_options& operator=(const General_options&);
1516 // Whether to mark the stack as executable.
1519 // Not set on command line.
1520 EXECSTACK_FROM_INPUT,
1521 // Mark the stack as executable (-z execstack).
1523 // Mark the stack as not executable (-z noexecstack).
1529 // Do not fold any functions (Default or --icf=none).
1531 // All functions are candidates for folding. (--icf=all).
1533 // Only ctors and dtors are candidates for folding. (--icf=safe).
1538 set_icf_status(Icf_status value)
1539 { this->icf_status_ = value; }
1542 set_execstack_status(Execstack value)
1543 { this->execstack_status_ = value; }
1546 set_do_demangle(bool value)
1547 { this->do_demangle_ = value; }
1550 set_static(bool value)
1551 { static_ = value; }
1553 // These are called by finalize() to set up the search-path correctly.
1555 add_to_library_path_with_sysroot(const std::string& arg)
1556 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1558 // Apply any sysroot to the directory lists.
1562 // Add a plugin and its arguments to the list of plugins.
1564 add_plugin(const char* filename);
1566 // Add a plugin option.
1568 add_plugin_option(const char* opt);
1570 // Whether we printed version information.
1571 bool printed_version_;
1572 // Whether to mark the stack as executable.
1573 Execstack execstack_status_;
1574 // Whether to do code folding.
1575 Icf_status icf_status_;
1576 // Whether to do a static link.
1578 // Whether to do demangling.
1580 // List of plugin libraries.
1581 Plugin_manager* plugins_;
1582 // The parsed output of --dynamic-list files. For convenience in
1583 // script.cc, we store this as a Script_options object, even though
1584 // we only use a single Version_tree from it.
1585 Script_options dynamic_list_;
1586 // The incremental linking mode.
1587 Incremental_mode incremental_mode_;
1588 // The disposition given by the --incremental-changed,
1589 // --incremental-unchanged or --incremental-unknown option. The
1590 // value may change as we proceed parsing the command line flags.
1591 Incremental_disposition incremental_disposition_;
1592 // The disposition to use for startup files (those marked
1593 // INCREMENTAL_STARTUP).
1594 Incremental_disposition incremental_startup_disposition_;
1595 // Whether we have seen one of the options that require incremental
1596 // build (--incremental-changed, --incremental-unchanged,
1597 // --incremental-unknown, or --incremental-startup-unchanged).
1598 bool implicit_incremental_;
1599 // Libraries excluded from automatic export, via --exclude-libs.
1600 Unordered_set<std::string> excluded_libs_;
1601 // List of symbol-names to keep, via -retain-symbol-info.
1602 Unordered_set<std::string> symbols_to_retain_;
1603 // Map from section name to address from --section-start.
1604 std::map<std::string, uint64_t> section_starts_;
1605 // Whether to process armv4 bx instruction relocation.
1608 Endianness endianness_;
1611 // The position-dependent options. We use this to store the state of
1612 // the commandline at a particular point in parsing for later
1613 // reference. For instance, if we see "ld --whole-archive foo.a
1614 // --no-whole-archive," we want to store the whole-archive option with
1615 // foo.a, so when the time comes to parse foo.a we know we should do
1616 // it in whole-archive mode. We could store all of General_options,
1617 // but that's big, so we just pick the subset of flags that actually
1618 // change in a position-dependent way.
1620 #define DEFINE_posdep(varname__, type__) \
1624 { return this->varname__##_; } \
1627 set_##varname__(type__ value) \
1628 { this->varname__##_ = value; } \
1632 class Position_dependent_options
1635 Position_dependent_options(const General_options& options
1636 = Position_dependent_options::default_options_)
1637 { copy_from_options(options); }
1639 void copy_from_options(const General_options& options)
1641 this->set_as_needed(options.as_needed());
1642 this->set_Bdynamic(options.Bdynamic());
1643 this->set_format_enum(options.format_enum());
1644 this->set_whole_archive(options.whole_archive());
1645 this->set_incremental_disposition(options.incremental_disposition());
1648 DEFINE_posdep(as_needed, bool);
1649 DEFINE_posdep(Bdynamic, bool);
1650 DEFINE_posdep(format_enum, General_options::Object_format);
1651 DEFINE_posdep(whole_archive, bool);
1652 DEFINE_posdep(incremental_disposition, Incremental_disposition);
1655 // This is a General_options with everything set to its default
1656 // value. A Position_dependent_options created with no argument
1657 // will take its values from here.
1658 static General_options default_options_;
1662 // A single file or library argument from the command line.
1664 class Input_file_argument
1667 enum Input_file_type
1669 // A regular file, name used as-is, not searched.
1670 INPUT_FILE_TYPE_FILE,
1671 // A library name. When used, "lib" will be prepended and ".so" or
1672 // ".a" appended to make a filename, and that filename will be searched
1673 // for using the -L paths.
1674 INPUT_FILE_TYPE_LIBRARY,
1675 // A regular file, name used as-is, but searched using the -L paths.
1676 INPUT_FILE_TYPE_SEARCHED_FILE
1679 // name: file name or library name
1680 // type: the type of this input file.
1681 // extra_search_path: an extra directory to look for the file, prior
1682 // to checking the normal library search path. If this is "",
1683 // then no extra directory is added.
1684 // just_symbols: whether this file only defines symbols.
1685 // options: The position dependent options at this point in the
1686 // command line, such as --whole-archive.
1687 Input_file_argument()
1688 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1689 just_symbols_(false), options_(), arg_serial_(0)
1692 Input_file_argument(const char* name, Input_file_type type,
1693 const char* extra_search_path,
1695 const Position_dependent_options& options)
1696 : name_(name), type_(type), extra_search_path_(extra_search_path),
1697 just_symbols_(just_symbols), options_(options), arg_serial_(0)
1700 // You can also pass in a General_options instance instead of a
1701 // Position_dependent_options. In that case, we extract the
1702 // position-independent vars from the General_options and only store
1704 Input_file_argument(const char* name, Input_file_type type,
1705 const char* extra_search_path,
1707 const General_options& options)
1708 : name_(name), type_(type), extra_search_path_(extra_search_path),
1709 just_symbols_(just_symbols), options_(options), arg_serial_(0)
1714 { return this->name_.c_str(); }
1716 const Position_dependent_options&
1718 { return this->options_; }
1722 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1725 is_searched_file() const
1726 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1729 extra_search_path() const
1731 return (this->extra_search_path_.empty()
1733 : this->extra_search_path_.c_str());
1736 // Return whether we should only read symbols from this file.
1738 just_symbols() const
1739 { return this->just_symbols_; }
1741 // Return whether this file may require a search using the -L
1744 may_need_search() const
1746 return (this->is_lib()
1747 || this->is_searched_file()
1748 || !this->extra_search_path_.empty());
1751 // Set the serial number for this argument.
1753 set_arg_serial(unsigned int arg_serial)
1754 { this->arg_serial_ = arg_serial; }
1756 // Get the serial number.
1759 { return this->arg_serial_; }
1762 // We use std::string, not const char*, here for convenience when
1763 // using script files, so that we do not have to preserve the string
1766 Input_file_type type_;
1767 std::string extra_search_path_;
1769 Position_dependent_options options_;
1770 // A unique index for this file argument in the argument list.
1771 unsigned int arg_serial_;
1774 // A file or library, or a group, from the command line.
1776 class Input_argument
1779 // Create a file or library argument.
1780 explicit Input_argument(Input_file_argument file)
1781 : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
1784 // Create a group argument.
1785 explicit Input_argument(Input_file_group* group)
1786 : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
1789 // Create a lib argument.
1790 explicit Input_argument(Input_file_lib* lib)
1791 : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
1794 // Return whether this is a file.
1797 { return this->is_file_; }
1799 // Return whether this is a group.
1802 { return !this->is_file_ && this->lib_ == NULL; }
1804 // Return whether this is a lib.
1807 { return this->lib_ != NULL; }
1809 // Return the information about the file.
1810 const Input_file_argument&
1813 gold_assert(this->is_file_);
1817 // Return the information about the group.
1818 const Input_file_group*
1821 gold_assert(!this->is_file_);
1822 return this->group_;
1828 gold_assert(!this->is_file_);
1829 return this->group_;
1832 // Return the information about the lib.
1833 const Input_file_lib*
1836 gold_assert(!this->is_file_);
1837 gold_assert(this->lib_);
1844 gold_assert(!this->is_file_);
1845 gold_assert(this->lib_);
1849 // If a script generated this argument, store a pointer to the script info.
1850 // Currently used only for recording incremental link information.
1852 set_script_info(Script_info* info)
1853 { this->script_info_ = info; }
1857 { return this->script_info_; }
1861 Input_file_argument file_;
1862 Input_file_group* group_;
1863 Input_file_lib* lib_;
1864 Script_info* script_info_;
1867 typedef std::vector<Input_argument> Input_argument_list;
1869 // A group from the command line. This is a set of arguments within
1870 // --start-group ... --end-group.
1872 class Input_file_group
1875 typedef Input_argument_list::const_iterator const_iterator;
1881 // Add a file to the end of the group.
1883 add_file(const Input_file_argument& arg)
1885 this->files_.push_back(Input_argument(arg));
1886 return this->files_.back();
1889 // Iterators to iterate over the group contents.
1893 { return this->files_.begin(); }
1897 { return this->files_.end(); }
1900 Input_argument_list files_;
1903 // A lib from the command line. This is a set of arguments within
1904 // --start-lib ... --end-lib.
1906 class Input_file_lib
1909 typedef Input_argument_list::const_iterator const_iterator;
1911 Input_file_lib(const Position_dependent_options& options)
1912 : files_(), options_(options)
1915 // Add a file to the end of the lib.
1917 add_file(const Input_file_argument& arg)
1919 this->files_.push_back(Input_argument(arg));
1920 return this->files_.back();
1923 const Position_dependent_options&
1925 { return this->options_; }
1927 // Iterators to iterate over the lib contents.
1931 { return this->files_.begin(); }
1935 { return this->files_.end(); }
1939 { return this->files_.size(); }
1942 Input_argument_list files_;
1943 Position_dependent_options options_;
1946 // A list of files from the command line or a script.
1948 class Input_arguments
1951 typedef Input_argument_list::const_iterator const_iterator;
1954 : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
1959 add_file(Input_file_argument& arg);
1961 // Start a group (the --start-group option).
1965 // End a group (the --end-group option).
1969 // Start a lib (the --start-lib option).
1971 start_lib(const Position_dependent_options&);
1973 // End a lib (the --end-lib option).
1977 // Return whether we are currently in a group.
1980 { return this->in_group_; }
1982 // Return whether we are currently in a lib.
1985 { return this->in_lib_; }
1987 // The number of entries in the list.
1990 { return this->input_argument_list_.size(); }
1992 // Iterators to iterate over the list of input files.
1996 { return this->input_argument_list_.begin(); }
2000 { return this->input_argument_list_.end(); }
2002 // Return whether the list is empty.
2005 { return this->input_argument_list_.empty(); }
2007 // Return the number of input files. This may be larger than
2008 // input_argument_list_.size(), because of files that are part
2009 // of groups or libs.
2011 number_of_input_files() const
2012 { return this->file_count_; }
2015 Input_argument_list input_argument_list_;
2018 unsigned int file_count_;
2022 // All the information read from the command line. These are held in
2023 // three separate structs: one to hold the options (--foo), one to
2024 // hold the filenames listed on the commandline, and one to hold
2025 // linker script information. This third is not a subset of the other
2026 // two because linker scripts can be specified either as options (via
2027 // -T) or as a file.
2032 typedef Input_arguments::const_iterator const_iterator;
2036 // Process the command line options. This will exit with an
2037 // appropriate error message if an unrecognized option is seen.
2039 process(int argc, const char** argv);
2041 // Process one command-line option. This takes the index of argv to
2042 // process, and returns the index for the next option. no_more_options
2043 // is set to true if argv[i] is "--".
2045 process_one_option(int argc, const char** argv, int i,
2046 bool* no_more_options);
2048 // Get the general options.
2049 const General_options&
2051 { return this->options_; }
2053 // Get the position dependent options.
2054 const Position_dependent_options&
2055 position_dependent_options() const
2056 { return this->position_options_; }
2058 // Get the linker-script options.
2061 { return this->script_options_; }
2063 // Finalize the version-script options and return them.
2064 const Version_script_info&
2067 // Get the input files.
2070 { return this->inputs_; }
2072 // The number of input files.
2074 number_of_input_files() const
2075 { return this->inputs_.number_of_input_files(); }
2077 // Iterators to iterate over the list of input files.
2081 { return this->inputs_.begin(); }
2085 { return this->inputs_.end(); }
2088 Command_line(const Command_line&);
2089 Command_line& operator=(const Command_line&);
2091 // This is a dummy class to provide a constructor that runs before
2092 // the constructor for the General_options. The Pre_options constructor
2093 // is used as a hook to set the flag enabling the options to register
2095 struct Pre_options {
2099 // This must come before options_!
2100 Pre_options pre_options_;
2101 General_options options_;
2102 Position_dependent_options position_options_;
2103 Script_options script_options_;
2104 Input_arguments inputs_;
2107 } // End namespace gold.
2109 #endif // !defined(GOLD_OPTIONS_H)