1 // options.h -- handle command line options for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008, 2009 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
52 class General_options
;
53 class Search_directory
;
54 class Input_file_group
;
55 class Position_dependent_options
;
59 // Incremental build action for a specific file, as selected by the user.
61 enum Incremental_disposition
63 // Determine the status from the timestamp (default).
65 // Assume the file changed from the previous build.
67 // Assume the file didn't change from the previous build.
71 // The nested namespace is to contain all the global variables and
72 // structs that need to be defined in the .h file, but do not need to
73 // be used outside this class.
76 typedef std::vector
<Search_directory
> Dir_list
;
77 typedef Unordered_set
<std::string
> String_set
;
79 // These routines convert from a string option to various types.
80 // Each gives a fatal error if it cannot parse the argument.
83 parse_bool(const char* option_name
, const char* arg
, bool* retval
);
86 parse_uint(const char* option_name
, const char* arg
, int* retval
);
89 parse_uint64(const char* option_name
, const char* arg
, uint64_t* retval
);
92 parse_double(const char* option_name
, const char* arg
, double* retval
);
95 parse_string(const char* option_name
, const char* arg
, const char** retval
);
98 parse_optional_string(const char* option_name
, const char* arg
,
102 parse_dirlist(const char* option_name
, const char* arg
, Dir_list
* retval
);
105 parse_set(const char* option_name
, const char* arg
, String_set
* retval
);
108 parse_choices(const char* option_name
, const char* arg
, const char** retval
,
109 const char* choices
[], int num_choices
);
113 // Most options have both a shortname (one letter) and a longname.
114 // This enum controls how many dashes are expected for longname access
115 // -- shortnames always use one dash. Most longnames will accept
116 // either one dash or two; the only difference between ONE_DASH and
117 // TWO_DASHES is how we print the option in --help. However, some
118 // longnames require two dashes, and some require only one. The
119 // special value DASH_Z means that the option is preceded by "-z".
122 ONE_DASH
, TWO_DASHES
, EXACTLY_ONE_DASH
, EXACTLY_TWO_DASHES
, DASH_Z
125 // LONGNAME is the long-name of the option with dashes converted to
126 // underscores, or else the short-name if the option has no long-name.
127 // It is never the empty string.
128 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
129 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
130 // option has no short-name. If the option has no long-name, you
131 // should specify the short-name in *both* VARNAME and here.
132 // DEFAULT_VALUE is the value of the option if not specified on the
133 // commandline, as a string.
134 // HELPSTRING is the descriptive text used with the option via --help
135 // HELPARG is how you define the argument to the option.
136 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
137 // HELPARG should be NULL iff the option is a bool and takes no arg.
138 // OPTIONAL_ARG is true if this option takes an optional argument. An
139 // optional argument must be specifid as --OPTION=VALUE, not
141 // READER provides parse_to_value, which is a function that will convert
142 // a char* argument into the proper type and store it in some variable.
143 // A One_option struct initializes itself with the global list of options
144 // at constructor time, so be careful making one of these.
147 std::string longname
;
150 const char* default_value
;
151 const char* helpstring
;
156 One_option(const char* ln
, Dashes d
, char sn
, const char* dv
,
157 const char* hs
, const char* ha
, bool oa
, Struct_var
* r
)
158 : longname(ln
), dashes(d
), shortname(sn
), default_value(dv
? dv
: ""),
159 helpstring(hs
), helparg(ha
), optional_arg(oa
), reader(r
)
161 // In longname, we convert all underscores to dashes, since GNU
162 // style uses dashes in option names. longname is likely to have
163 // underscores in it because it's also used to declare a C++
165 const char* pos
= strchr(this->longname
.c_str(), '_');
166 for (; pos
; pos
= strchr(pos
, '_'))
167 this->longname
[pos
- this->longname
.c_str()] = '-';
169 // We only register ourselves if our helpstring is not NULL. This
170 // is to support the "no-VAR" boolean variables, which we
171 // conditionally turn on by defining "no-VAR" help text.
172 if (this->helpstring
)
173 this->register_option();
176 // This option takes an argument iff helparg is not NULL.
178 takes_argument() const
179 { return this->helparg
!= NULL
; }
181 // Whether the argument is optional.
183 takes_optional_argument() const
184 { return this->optional_arg
; }
186 // Register this option with the global list of options.
190 // Print this option to stdout (used with --help).
195 // All options have a Struct_##varname that inherits from this and
196 // actually implements parse_to_value for that option.
199 // OPTION: the name of the option as specified on the commandline,
200 // including leading dashes, and any text following the option:
201 // "-O", "--defsym=mysym=0x1000", etc.
202 // ARG: the arg associated with this option, or NULL if the option
203 // takes no argument: "2", "mysym=0x1000", etc.
204 // CMDLINE: the global Command_line object. Used by DEFINE_special.
205 // OPTIONS: the global General_options object. Used by DEFINE_special.
207 parse_to_value(const char* option
, const char* arg
,
208 Command_line
* cmdline
, General_options
* options
) = 0;
210 ~Struct_var() // To make gcc happy.
214 // This is for "special" options that aren't of any predefined type.
215 struct Struct_special
: public Struct_var
217 // If you change this, change the parse-fn in DEFINE_special as well.
218 typedef void (General_options::*Parse_function
)(const char*, const char*,
220 Struct_special(const char* varname
, Dashes dashes
, char shortname
,
221 Parse_function parse_function
,
222 const char* helpstring
, const char* helparg
)
223 : option(varname
, dashes
, shortname
, "", helpstring
, helparg
, false, this),
224 parse(parse_function
)
227 void parse_to_value(const char* option
, const char* arg
,
228 Command_line
* cmdline
, General_options
* options
)
229 { (options
->*(this->parse
))(option
, arg
, cmdline
); }
232 Parse_function parse
;
235 } // End namespace options.
238 // These are helper macros use by DEFINE_uint64/etc below.
239 // This macro is used inside the General_options_ class, so defines
240 // var() and set_var() as General_options methods. Arguments as are
241 // for the constructor for One_option. param_type__ is the same as
242 // type__ for built-in types, and "const type__ &" otherwise.
243 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
244 default_value_as_string__, helpstring__, helparg__, \
245 optional_arg__, type__, param_type__, parse_fn__) \
249 { return this->varname__##_.value; } \
252 user_set_##varname__() const \
253 { return this->varname__##_.user_set_via_option; } \
256 set_user_set_##varname__() \
257 { this->varname__##_.user_set_via_option = true; } \
260 struct Struct_##varname__ : public options::Struct_var \
262 Struct_##varname__() \
263 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
264 helpstring__, helparg__, optional_arg__, this), \
265 user_set_via_option(false), value(default_value__) \
269 parse_to_value(const char* option_name, const char* arg, \
270 Command_line*, General_options*) \
272 parse_fn__(option_name, arg, &this->value); \
273 this->user_set_via_option = true; \
276 options::One_option option; \
277 bool user_set_via_option; \
280 Struct_##varname__ varname__##_; \
282 set_##varname__(param_type__ value) \
283 { this->varname__##_.value = value; }
285 // These macros allow for easy addition of a new commandline option.
287 // If no_helpstring__ is not NULL, then in addition to creating
288 // VARNAME, we also create an option called no-VARNAME (or, for a -z
289 // option, noVARNAME).
290 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
291 helpstring__, no_helpstring__) \
292 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
293 default_value__ ? "true" : "false", helpstring__, NULL, \
294 false, bool, bool, options::parse_bool) \
295 struct Struct_no_##varname__ : public options::Struct_var \
297 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
299 : "no-" #varname__), \
301 default_value__ ? "false" : "true", \
302 no_helpstring__, NULL, false, this) \
306 parse_to_value(const char*, const char*, \
307 Command_line*, General_options* options) \
308 { options->set_##varname__(false); } \
310 options::One_option option; \
312 Struct_no_##varname__ no_##varname__##_initializer_
314 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
315 helpstring__, no_helpstring__) \
316 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
317 default_value__ ? "true" : "false", helpstring__, NULL, \
318 false, bool, bool, options::parse_bool) \
319 struct Struct_disable_##varname__ : public options::Struct_var \
321 Struct_disable_##varname__() : option("disable-" #varname__, \
323 default_value__ ? "false" : "true", \
324 no_helpstring__, NULL, false, this) \
328 parse_to_value(const char*, const char*, \
329 Command_line*, General_options* options) \
330 { options->set_enable_##varname__(false); } \
332 options::One_option option; \
334 Struct_disable_##varname__ disable_##varname__##_initializer_
336 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
337 helpstring__, helparg__) \
338 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
339 #default_value__, helpstring__, helparg__, false, \
340 int, int, options::parse_uint)
342 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
343 helpstring__, helparg__) \
344 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
345 #default_value__, helpstring__, helparg__, false, \
346 uint64_t, uint64_t, options::parse_uint64)
348 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
349 helpstring__, helparg__) \
350 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
351 #default_value__, helpstring__, helparg__, false, \
352 double, double, options::parse_double)
354 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
355 helpstring__, helparg__) \
356 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
357 default_value__, helpstring__, helparg__, false, \
358 const char*, const char*, options::parse_string)
360 // This is like DEFINE_string, but we convert each occurrence to a
361 // Search_directory and store it in a vector. Thus we also have the
362 // add_to_VARNAME() method, to append to the vector.
363 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
364 helpstring__, helparg__) \
365 DEFINE_var(varname__, dashes__, shortname__, , \
366 "", helpstring__, helparg__, false, options::Dir_list, \
367 const options::Dir_list&, options::parse_dirlist) \
369 add_to_##varname__(const char* new_value) \
370 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
372 add_search_directory_to_##varname__(const Search_directory& dir) \
373 { this->varname__##_.value.push_back(dir); }
375 // This is like DEFINE_string, but we store a set of strings.
376 #define DEFINE_set(varname__, dashes__, shortname__, \
377 helpstring__, helparg__) \
378 DEFINE_var(varname__, dashes__, shortname__, , \
379 "", helpstring__, helparg__, false, options::String_set, \
380 const options::String_set&, options::parse_set) \
383 any_##varname__() const \
384 { return !this->varname__##_.value.empty(); } \
387 is_##varname__(const char* symbol) const \
389 return (!this->varname__##_.value.empty() \
390 && (this->varname__##_.value.find(std::string(symbol)) \
391 != this->varname__##_.value.end())); \
394 options::String_set::const_iterator \
395 varname__##_begin() const \
396 { return this->varname__##_.value.begin(); } \
398 options::String_set::const_iterator \
399 varname__##_end() const \
400 { return this->varname__##_.value.end(); }
402 // When you have a list of possible values (expressed as string)
403 // After helparg__ should come an initializer list, like
404 // {"foo", "bar", "baz"}
405 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
406 helpstring__, helparg__, ...) \
407 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
408 default_value__, helpstring__, helparg__, false, \
409 const char*, const char*, parse_choices_##varname__) \
411 static void parse_choices_##varname__(const char* option_name, \
413 const char** retval) { \
414 const char* choices[] = __VA_ARGS__; \
415 options::parse_choices(option_name, arg, retval, \
416 choices, sizeof(choices) / sizeof(*choices)); \
419 // This is like DEFINE_bool, but VARNAME is the name of a different
420 // option. This option becomes an alias for that one. INVERT is true
421 // if this option is an inversion of the other one.
422 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
423 helpstring__, no_helpstring__, invert__) \
425 struct Struct_##option__ : public options::Struct_var \
427 Struct_##option__() \
428 : option(#option__, dashes__, shortname__, "", helpstring__, \
433 parse_to_value(const char*, const char*, \
434 Command_line*, General_options* options) \
436 options->set_##varname__(!invert__); \
437 options->set_user_set_##varname__(); \
440 options::One_option option; \
442 Struct_##option__ option__##_; \
444 struct Struct_no_##option__ : public options::Struct_var \
446 Struct_no_##option__() \
447 : option((dashes__ == options::DASH_Z \
449 : "no-" #option__), \
450 dashes__, '\0', "", no_helpstring__, \
455 parse_to_value(const char*, const char*, \
456 Command_line*, General_options* options) \
458 options->set_##varname__(invert__); \
459 options->set_user_set_##varname__(); \
462 options::One_option option; \
464 Struct_no_##option__ no_##option__##_initializer_
466 // This is used for non-standard flags. It defines no functions; it
467 // just calls General_options::parse_VARNAME whenever the flag is
468 // seen. We declare parse_VARNAME as a static member of
469 // General_options; you are responsible for defining it there.
470 // helparg__ should be NULL iff this special-option is a boolean.
471 #define DEFINE_special(varname__, dashes__, shortname__, \
472 helpstring__, helparg__) \
474 void parse_##varname__(const char* option, const char* arg, \
475 Command_line* inputs); \
476 struct Struct_##varname__ : public options::Struct_special \
478 Struct_##varname__() \
479 : options::Struct_special(#varname__, dashes__, shortname__, \
480 &General_options::parse_##varname__, \
481 helpstring__, helparg__) \
484 Struct_##varname__ varname__##_initializer_
486 // An option that takes an optional string argument. If the option is
487 // used with no argument, the value will be the default, and
488 // user_set_via_option will be true.
489 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
491 helpstring__, helparg__) \
492 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
493 default_value__, helpstring__, helparg__, true, \
494 const char*, const char*, options::parse_optional_string)
496 // A directory to search. For each directory we record whether it is
497 // in the sysroot. We need to know this so that, if a linker script
498 // is found within the sysroot, we will apply the sysroot to any files
499 // named by that script.
501 class Search_directory
504 // We need a default constructor because we put this in a
507 : name_(NULL
), put_in_sysroot_(false), is_in_sysroot_(false)
510 // This is the usual constructor.
511 Search_directory(const char* name
, bool put_in_sysroot
)
512 : name_(name
), put_in_sysroot_(put_in_sysroot
), is_in_sysroot_(false)
514 if (this->name_
.empty())
518 // This is called if we have a sysroot. The sysroot is prefixed to
519 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
520 // set to true for any enries which are in the sysroot (this will
521 // naturally include any entries for which put_in_sysroot_ is true).
522 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
523 // passing SYSROOT to lrealpath.
525 add_sysroot(const char* sysroot
, const char* canonical_sysroot
);
527 // Get the directory name.
530 { return this->name_
; }
532 // Return whether this directory is in the sysroot.
534 is_in_sysroot() const
535 { return this->is_in_sysroot_
; }
537 // Return whether this is considered a system directory.
539 is_system_directory() const
540 { return this->put_in_sysroot_
|| this->is_in_sysroot_
; }
543 // The directory name.
545 // True if the sysroot should be added as a prefix for this
546 // directory (if there is a sysroot). This is true for system
547 // directories that we search by default.
548 bool put_in_sysroot_
;
549 // True if this directory is in the sysroot (if there is a sysroot).
550 // This is true if there is a sysroot and either 1) put_in_sysroot_
551 // is true, or 2) the directory happens to be in the sysroot based
552 // on a pathname comparison.
556 class General_options
559 // NOTE: For every option that you add here, also consider if you
560 // should add it to Position_dependent_options.
561 DEFINE_special(help
, options::TWO_DASHES
, '\0',
562 N_("Report usage information"), NULL
);
563 DEFINE_special(version
, options::TWO_DASHES
, 'v',
564 N_("Report version information"), NULL
);
565 DEFINE_special(V
, options::EXACTLY_ONE_DASH
, '\0',
566 N_("Report version and target information"), NULL
);
568 // These options are sorted approximately so that for each letter in
569 // the alphabet, we show the option whose shortname is that letter
570 // (if any) and then every longname that starts with that letter (in
571 // alphabetical order). For both, lowercase sorts before uppercase.
572 // The -z options come last.
574 DEFINE_bool(allow_shlib_undefined
, options::TWO_DASHES
, '\0', false,
575 N_("Allow unresolved references in shared libraries"),
576 N_("Do not allow unresolved references in shared libraries"));
578 DEFINE_bool(as_needed
, options::TWO_DASHES
, '\0', false,
579 N_("Only set DT_NEEDED for dynamic libs if used"),
580 N_("Always DT_NEEDED for dynamic libs"));
582 // This should really be an "enum", but it's too easy for folks to
583 // forget to update the list as they add new targets. So we just
584 // accept any string. We'll fail later (when the string is parsed),
585 // if the target isn't actually supported.
586 DEFINE_string(format
, options::TWO_DASHES
, 'b', "elf",
587 N_("Set input format"), ("[elf,binary]"));
589 DEFINE_bool(Bdynamic
, options::ONE_DASH
, '\0', true,
590 N_("-l searches for shared libraries"), NULL
);
591 DEFINE_bool_alias(Bstatic
, Bdynamic
, options::ONE_DASH
, '\0',
592 N_("-l does not search for shared libraries"), NULL
,
595 DEFINE_bool(Bsymbolic
, options::ONE_DASH
, '\0', false,
596 N_("Bind defined symbols locally"), NULL
);
598 DEFINE_bool(Bsymbolic_functions
, options::ONE_DASH
, '\0', false,
599 N_("Bind defined function symbols locally"), NULL
);
601 DEFINE_optional_string(build_id
, options::TWO_DASHES
, '\0', "sha1",
602 N_("Generate build ID note"),
605 DEFINE_bool(check_sections
, options::TWO_DASHES
, '\0', true,
606 N_("Check segment addresses for overlaps (default)"),
607 N_("Do not check segment addresses for overlaps"));
610 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
611 N_("Compress .debug_* sections in the output file"),
615 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
616 N_("Compress .debug_* sections in the output file"),
621 DEFINE_bool(define_common
, options::TWO_DASHES
, 'd', false,
622 N_("Define common symbols"),
623 N_("Do not define common symbols"));
624 DEFINE_bool(dc
, options::ONE_DASH
, '\0', false,
625 N_("Alias for -d"), NULL
);
626 DEFINE_bool(dp
, options::ONE_DASH
, '\0', false,
627 N_("Alias for -d"), NULL
);
629 DEFINE_string(debug
, options::TWO_DASHES
, '\0', "",
630 N_("Turn on debugging"),
631 N_("[all,files,script,task][,...]"));
633 DEFINE_special(defsym
, options::TWO_DASHES
, '\0',
634 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
636 DEFINE_optional_string(demangle
, options::TWO_DASHES
, '\0', NULL
,
637 N_("Demangle C++ symbols in log messages"),
640 DEFINE_bool(no_demangle
, options::TWO_DASHES
, '\0', false,
641 N_("Do not demangle C++ symbols in log messages"),
644 DEFINE_bool(detect_odr_violations
, options::TWO_DASHES
, '\0', false,
645 N_("Try to detect violations of the One Definition Rule"),
648 DEFINE_bool(dynamic_list_data
, options::TWO_DASHES
, '\0', false,
649 N_("Add data symbols to dynamic symbols"), NULL
);
651 DEFINE_bool(dynamic_list_cpp_new
, options::TWO_DASHES
, '\0', false,
652 N_("Add C++ operator new/delete to dynamic symbols"), NULL
);
654 DEFINE_bool(dynamic_list_cpp_typeinfo
, options::TWO_DASHES
, '\0', false,
655 N_("Add C++ typeinfo to dynamic symbols"), NULL
);
657 DEFINE_special(dynamic_list
, options::TWO_DASHES
, '\0',
658 N_("Read a list of dynamic symbols"), N_("FILE"));
660 DEFINE_string(entry
, options::TWO_DASHES
, 'e', NULL
,
661 N_("Set program start address"), N_("ADDRESS"));
663 DEFINE_bool(export_dynamic
, options::TWO_DASHES
, 'E', false,
664 N_("Export all dynamic symbols"),
665 N_("Do not export all dynamic symbols (default)"));
667 DEFINE_bool(eh_frame_hdr
, options::TWO_DASHES
, '\0', false,
668 N_("Create exception frame header"), NULL
);
670 DEFINE_bool(fatal_warnings
, options::TWO_DASHES
, '\0', false,
671 N_("Treat warnings as errors"),
672 N_("Do not treat warnings as errors"));
674 DEFINE_string(soname
, options::ONE_DASH
, 'h', NULL
,
675 N_("Set shared library name"), N_("FILENAME"));
677 DEFINE_double(hash_bucket_empty_fraction
, options::TWO_DASHES
, '\0', 0.0,
678 N_("Min fraction of empty buckets in dynamic hash"),
681 DEFINE_enum(hash_style
, options::TWO_DASHES
, '\0', "sysv",
682 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
683 {"sysv", "gnu", "both"});
685 DEFINE_string(dynamic_linker
, options::TWO_DASHES
, 'I', NULL
,
686 N_("Set dynamic linker path"), N_("PROGRAM"));
688 DEFINE_bool(incremental
, options::TWO_DASHES
, '\0', false,
689 N_("Work in progress; do not use"),
690 N_("Do a full build"));
692 DEFINE_special(incremental_changed
, options::TWO_DASHES
, '\0',
693 N_("Assume files changed"), NULL
);
695 DEFINE_special(incremental_unchanged
, options::TWO_DASHES
, '\0',
696 N_("Assume files didn't change"), NULL
);
698 DEFINE_special(incremental_unknown
, options::TWO_DASHES
, '\0',
699 N_("Use timestamps to check files (default)"), NULL
);
701 DEFINE_special(just_symbols
, options::TWO_DASHES
, '\0',
702 N_("Read only symbol values from FILE"), N_("FILE"));
704 DEFINE_special(library
, options::TWO_DASHES
, 'l',
705 N_("Search for library LIBNAME"), N_("LIBNAME"));
707 DEFINE_dirlist(library_path
, options::TWO_DASHES
, 'L',
708 N_("Add directory to search path"), N_("DIR"));
710 DEFINE_string(m
, options::EXACTLY_ONE_DASH
, 'm', "",
711 N_("Ignored for compatibility"), N_("EMULATION"));
713 DEFINE_bool(print_map
, options::TWO_DASHES
, 'M', false,
714 N_("Write map file on standard output"), NULL
);
715 DEFINE_string(Map
, options::ONE_DASH
, '\0', NULL
, N_("Write map file"),
718 DEFINE_bool(nmagic
, options::TWO_DASHES
, 'n', false,
719 N_("Do not page align data"), NULL
);
720 DEFINE_bool(omagic
, options::EXACTLY_TWO_DASHES
, 'N', false,
721 N_("Do not page align data, do not make text readonly"),
722 N_("Page align data, make text readonly"));
724 DEFINE_enable(new_dtags
, options::EXACTLY_TWO_DASHES
, '\0', false,
725 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
726 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
728 DEFINE_bool(noinhibit_exec
, options::TWO_DASHES
, '\0', false,
729 N_("Create an output file even if errors occur"), NULL
);
731 DEFINE_bool_alias(no_undefined
, defs
, options::TWO_DASHES
, '\0',
732 N_("Report undefined symbols (even with --shared)"),
735 DEFINE_string(output
, options::TWO_DASHES
, 'o', "a.out",
736 N_("Set output file name"), N_("FILE"));
738 DEFINE_uint(optimize
, options::EXACTLY_ONE_DASH
, 'O', 0,
739 N_("Optimize output file size"), N_("LEVEL"));
741 DEFINE_string(oformat
, options::EXACTLY_TWO_DASHES
, '\0', "elf",
742 N_("Set output format"), N_("[binary]"));
744 #ifdef ENABLE_PLUGINS
745 DEFINE_special(plugin
, options::TWO_DASHES
, '\0',
746 N_("Load a plugin library"), N_("PLUGIN"));
747 DEFINE_special(plugin_opt
, options::TWO_DASHES
, '\0',
748 N_("Pass an option to the plugin"), N_("OPTION"));
751 DEFINE_bool(preread_archive_symbols
, options::TWO_DASHES
, '\0', false,
752 N_("Preread archive symbols when multi-threaded"), NULL
);
754 DEFINE_string(print_symbol_counts
, options::TWO_DASHES
, '\0', NULL
,
755 N_("Print symbols defined and used for each input"),
758 DEFINE_bool(Qy
, options::EXACTLY_ONE_DASH
, '\0', false,
759 N_("Ignored for SVR4 compatibility"), NULL
);
761 DEFINE_bool(emit_relocs
, options::TWO_DASHES
, 'q', false,
762 N_("Generate relocations in output"), NULL
);
764 DEFINE_bool(relocatable
, options::EXACTLY_ONE_DASH
, 'r', false,
765 N_("Generate relocatable output"), NULL
);
767 DEFINE_bool(relax
, options::TWO_DASHES
, '\0', false,
768 N_("Relax branches on certain targets"), NULL
);
770 // -R really means -rpath, but can mean --just-symbols for
771 // compatibility with GNU ld. -rpath is always -rpath, so we list
773 DEFINE_special(R
, options::EXACTLY_ONE_DASH
, 'R',
774 N_("Add DIR to runtime search path"), N_("DIR"));
776 DEFINE_dirlist(rpath
, options::ONE_DASH
, '\0',
777 N_("Add DIR to runtime search path"), N_("DIR"));
779 DEFINE_dirlist(rpath_link
, options::TWO_DASHES
, '\0',
780 N_("Add DIR to link time shared library search path"),
783 DEFINE_bool(strip_all
, options::TWO_DASHES
, 's', false,
784 N_("Strip all symbols"), NULL
);
785 DEFINE_bool(strip_debug
, options::TWO_DASHES
, 'S', false,
786 N_("Strip debugging information"), NULL
);
787 DEFINE_bool(strip_debug_non_line
, options::TWO_DASHES
, '\0', false,
788 N_("Emit only debug line number information"), NULL
);
789 DEFINE_bool(strip_debug_gdb
, options::TWO_DASHES
, '\0', false,
790 N_("Strip debug symbols that are unused by gdb "
791 "(at least versions <= 6.7)"), NULL
);
792 DEFINE_bool(strip_lto_sections
, options::TWO_DASHES
, '\0', true,
793 N_("Strip LTO intermediate code sections"), NULL
);
795 DEFINE_bool(no_keep_memory
, options::TWO_DASHES
, 's', false,
796 N_("Use less memory and more disk I/O (included only for compatibility with GNU ld)"), NULL
);
798 DEFINE_bool(shared
, options::ONE_DASH
, '\0', false,
799 N_("Generate shared library"), NULL
);
801 DEFINE_bool(Bshareable
, options::ONE_DASH
, '\0', false,
802 N_("Generate shared library"), NULL
);
804 // This is not actually special in any way, but I need to give it
805 // a non-standard accessor-function name because 'static' is a keyword.
806 DEFINE_special(static, options::ONE_DASH
, '\0',
807 N_("Do not link against shared libraries"), NULL
);
809 DEFINE_bool(gc_sections
, options::TWO_DASHES
, '\0', false,
810 N_("Remove unused sections"),
811 N_("Don't remove unused sections (default)"));
813 DEFINE_bool(print_gc_sections
, options::TWO_DASHES
, '\0', false,
814 N_("List removed unused sections on stderr"),
815 N_("Do not list removed unused sections"));
817 DEFINE_bool(stats
, options::TWO_DASHES
, '\0', false,
818 N_("Print resource usage statistics"), NULL
);
820 DEFINE_string(sysroot
, options::TWO_DASHES
, '\0', "",
821 N_("Set target system root directory"), N_("DIR"));
823 DEFINE_bool(trace
, options::TWO_DASHES
, 't', false,
824 N_("Print the name of each input file"), NULL
);
826 DEFINE_special(script
, options::TWO_DASHES
, 'T',
827 N_("Read linker script"), N_("FILE"));
829 DEFINE_bool(threads
, options::TWO_DASHES
, '\0', false,
830 N_("Run the linker multi-threaded"),
831 N_("Do not run the linker multi-threaded"));
832 DEFINE_uint(thread_count
, options::TWO_DASHES
, '\0', 0,
833 N_("Number of threads to use"), N_("COUNT"));
834 DEFINE_uint(thread_count_initial
, options::TWO_DASHES
, '\0', 0,
835 N_("Number of threads to use in initial pass"), N_("COUNT"));
836 DEFINE_uint(thread_count_middle
, options::TWO_DASHES
, '\0', 0,
837 N_("Number of threads to use in middle pass"), N_("COUNT"));
838 DEFINE_uint(thread_count_final
, options::TWO_DASHES
, '\0', 0,
839 N_("Number of threads to use in final pass"), N_("COUNT"));
841 DEFINE_uint64(Tbss
, options::ONE_DASH
, '\0', -1U,
842 N_("Set the address of the bss segment"), N_("ADDRESS"));
843 DEFINE_uint64(Tdata
, options::ONE_DASH
, '\0', -1U,
844 N_("Set the address of the data segment"), N_("ADDRESS"));
845 DEFINE_uint64(Ttext
, options::ONE_DASH
, '\0', -1U,
846 N_("Set the address of the text segment"), N_("ADDRESS"));
848 DEFINE_set(undefined
, options::TWO_DASHES
, 'u',
849 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
851 DEFINE_bool(verbose
, options::TWO_DASHES
, '\0', false,
852 N_("Synonym for --debug=files"), NULL
);
854 DEFINE_special(version_script
, options::TWO_DASHES
, '\0',
855 N_("Read version script"), N_("FILE"));
857 DEFINE_bool(warn_search_mismatch
, options::TWO_DASHES
, '\0', true,
858 N_("Warn when skipping an incompatible library"),
859 N_("Don't warn when skipping an incompatible library"));
861 DEFINE_bool(whole_archive
, options::TWO_DASHES
, '\0', false,
862 N_("Include all archive contents"),
863 N_("Include only needed archive contents"));
865 DEFINE_set(wrap
, options::TWO_DASHES
, '\0',
866 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
868 DEFINE_set(trace_symbol
, options::TWO_DASHES
, 'y',
869 N_("Trace references to symbol"), N_("SYMBOL"));
871 DEFINE_string(Y
, options::EXACTLY_ONE_DASH
, 'Y', "",
872 N_("Default search path for Solaris compatibility"),
875 DEFINE_special(start_group
, options::TWO_DASHES
, '(',
876 N_("Start a library search group"), NULL
);
877 DEFINE_special(end_group
, options::TWO_DASHES
, ')',
878 N_("End a library search group"), NULL
);
882 DEFINE_bool(combreloc
, options::DASH_Z
, '\0', true,
883 N_("Sort dynamic relocs"),
884 N_("Do not sort dynamic relocs"));
885 DEFINE_uint64(common_page_size
, options::DASH_Z
, '\0', 0,
886 N_("Set common page size to SIZE"), N_("SIZE"));
887 DEFINE_bool(defs
, options::DASH_Z
, '\0', false,
888 N_("Report undefined symbols (even with --shared)"),
890 DEFINE_bool(execstack
, options::DASH_Z
, '\0', false,
891 N_("Mark output as requiring executable stack"), NULL
);
892 DEFINE_uint64(max_page_size
, options::DASH_Z
, '\0', 0,
893 N_("Set maximum page size to SIZE"), N_("SIZE"));
894 DEFINE_bool(noexecstack
, options::DASH_Z
, '\0', false,
895 N_("Mark output as not requiring executable stack"), NULL
);
896 DEFINE_bool(initfirst
, options::DASH_Z
, '\0', false,
897 N_("Mark DSO to be initialized first at runtime"),
899 DEFINE_bool(interpose
, options::DASH_Z
, '\0', false,
900 N_("Mark object to interpose all DSOs but executable"),
902 DEFINE_bool(loadfltr
, options::DASH_Z
, '\0', false,
903 N_("Mark object requiring immediate process"),
905 DEFINE_bool(nodefaultlib
, options::DASH_Z
, '\0', false,
906 N_("Mark object not to use default search paths"),
908 DEFINE_bool(nodelete
, options::DASH_Z
, '\0', false,
909 N_("Mark DSO non-deletable at runtime"),
911 DEFINE_bool(nodlopen
, options::DASH_Z
, '\0', false,
912 N_("Mark DSO not available to dlopen"),
914 DEFINE_bool(nodump
, options::DASH_Z
, '\0', false,
915 N_("Mark DSO not available to dldump"),
917 DEFINE_bool(relro
, options::DASH_Z
, '\0', false,
918 N_("Where possible mark variables read-only after relocation"),
919 N_("Don't mark variables read-only after relocation"));
920 DEFINE_bool(origin
, options::DASH_Z
, '\0', false,
921 N_("Mark DSO to indicate that needs immediate $ORIGIN "
922 "processing at runtime"), NULL
);
925 typedef options::Dir_list Dir_list
;
929 // Does post-processing on flags, making sure they all have
930 // non-conflicting values. Also converts some flags from their
931 // "standard" types (string, etc), to another type (enum, DirList),
932 // which can be accessed via a separate method. Dies if it notices
936 // The macro defines output() (based on --output), but that's a
937 // generic name. Provide this alternative name, which is clearer.
939 output_file_name() const
940 { return this->output(); }
942 // This is not defined via a flag, but combines flags to say whether
943 // the output is position-independent or not.
945 output_is_position_independent() const
946 { return this->shared(); }
948 // Return true if the output is something that can be exec()ed, such
949 // as a static executable, or a position-dependent or
950 // position-independent executable, but not a dynamic library or an
953 output_is_executable() const
954 { return !this->shared() || this->output_is_pie(); }
956 // Return true if the output is a position-independent executable.
957 // This is currently not supported.
959 output_is_pie() const
962 // This would normally be static(), and defined automatically, but
963 // since static is a keyword, we need to come up with our own name.
968 // In addition to getting the input and output formats as a string
969 // (via format() and oformat()), we also give access as an enum.
974 // Straight binary format.
978 // Note: these functions are not very fast.
979 Object_format
format_enum() const;
980 Object_format
oformat_enum() const;
982 // Return whether FILENAME is in a system directory.
984 is_in_system_directory(const std::string
& name
) const;
986 // These are the best way to get access to the execstack state,
987 // not execstack() and noexecstack() which are hard to use properly.
989 is_execstack_set() const
990 { return this->execstack_status_
!= EXECSTACK_FROM_INPUT
; }
993 is_stack_executable() const
994 { return this->execstack_status_
== EXECSTACK_YES
; }
996 // The --demangle option takes an optional string, and there is also
997 // a --no-demangle option. This is the best way to decide whether
998 // to demangle or not.
1001 { return this->do_demangle_
; }
1003 // Returns TRUE if any plugin libraries have been loaded.
1006 { return this->plugins_
!= NULL
; }
1008 // Return a pointer to the plugin manager.
1011 { return this->plugins_
; }
1013 // True iff SYMBOL was found in the file specified by dynamic-list.
1015 in_dynamic_list(const char* symbol
) const
1016 { return this->dynamic_list_
.version_script_info()->symbol_is_local(symbol
); }
1018 // The disposition given by the --incremental-changed,
1019 // --incremental-unchanged or --incremental-unknown option. The
1020 // value may change as we proceed parsing the command line flags.
1021 Incremental_disposition
1022 incremental_disposition() const
1023 { return this->incremental_disposition_
; }
1026 // Don't copy this structure.
1027 General_options(const General_options
&);
1028 General_options
& operator=(const General_options
&);
1030 // Whether to mark the stack as executable.
1033 // Not set on command line.
1034 EXECSTACK_FROM_INPUT
,
1035 // Mark the stack as executable (-z execstack).
1037 // Mark the stack as not executable (-z noexecstack).
1042 set_execstack_status(Execstack value
)
1043 { this->execstack_status_
= value
; }
1046 set_do_demangle(bool value
)
1047 { this->do_demangle_
= value
; }
1050 set_static(bool value
)
1051 { static_
= value
; }
1053 // These are called by finalize() to set up the search-path correctly.
1055 add_to_library_path_with_sysroot(const char* arg
)
1056 { this->add_search_directory_to_library_path(Search_directory(arg
, true)); }
1058 // Apply any sysroot to the directory lists.
1062 // Add a plugin and its arguments to the list of plugins.
1064 add_plugin(const char *filename
);
1066 // Add a plugin option.
1068 add_plugin_option(const char* opt
);
1070 // Whether to mark the stack as executable.
1071 Execstack execstack_status_
;
1072 // Whether to do a static link.
1074 // Whether to do demangling.
1076 // List of plugin libraries.
1077 Plugin_manager
* plugins_
;
1078 // The parsed output of --dynamic-list files. For convenience in
1079 // script.cc, we store this as a Script_options object, even though
1080 // we only use a single Version_tree from it.
1081 Script_options dynamic_list_
;
1082 // The disposition given by the --incremental-changed,
1083 // --incremental-unchanged or --incremental-unknown option. The
1084 // value may change as we proceed parsing the command line flags.
1085 Incremental_disposition incremental_disposition_
;
1086 // Wheater we have seen one of the options that require incremental
1087 // build (--incremental-changed, --incremental-unchanged or
1088 // --incremental-unknown)
1089 bool implicit_incremental_
;
1092 // The position-dependent options. We use this to store the state of
1093 // the commandline at a particular point in parsing for later
1094 // reference. For instance, if we see "ld --whole-archive foo.a
1095 // --no-whole-archive," we want to store the whole-archive option with
1096 // foo.a, so when the time comes to parse foo.a we know we should do
1097 // it in whole-archive mode. We could store all of General_options,
1098 // but that's big, so we just pick the subset of flags that actually
1099 // change in a position-dependent way.
1101 #define DEFINE_posdep(varname__, type__) \
1105 { return this->varname__##_; } \
1108 set_##varname__(type__ value) \
1109 { this->varname__##_ = value; } \
1113 class Position_dependent_options
1116 Position_dependent_options(const General_options
& options
1117 = Position_dependent_options::default_options_
)
1118 { copy_from_options(options
); }
1120 void copy_from_options(const General_options
& options
)
1122 this->set_as_needed(options
.as_needed());
1123 this->set_Bdynamic(options
.Bdynamic());
1124 this->set_format_enum(options
.format_enum());
1125 this->set_whole_archive(options
.whole_archive());
1126 this->set_incremental_disposition(options
.incremental_disposition());
1129 DEFINE_posdep(as_needed
, bool);
1130 DEFINE_posdep(Bdynamic
, bool);
1131 DEFINE_posdep(format_enum
, General_options::Object_format
);
1132 DEFINE_posdep(whole_archive
, bool);
1133 DEFINE_posdep(incremental_disposition
, Incremental_disposition
);
1136 // This is a General_options with everything set to its default
1137 // value. A Position_dependent_options created with no argument
1138 // will take its values from here.
1139 static General_options default_options_
;
1143 // A single file or library argument from the command line.
1145 class Input_file_argument
1148 // name: file name or library name
1149 // is_lib: true if name is a library name: that is, emits the leading
1150 // "lib" and trailing ".so"/".a" from the name
1151 // extra_search_path: an extra directory to look for the file, prior
1152 // to checking the normal library search path. If this is "",
1153 // then no extra directory is added.
1154 // just_symbols: whether this file only defines symbols.
1155 // options: The position dependent options at this point in the
1156 // command line, such as --whole-archive.
1157 Input_file_argument()
1158 : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false),
1162 Input_file_argument(const char* name
, bool is_lib
,
1163 const char* extra_search_path
,
1165 const Position_dependent_options
& options
)
1166 : name_(name
), is_lib_(is_lib
), extra_search_path_(extra_search_path
),
1167 just_symbols_(just_symbols
), options_(options
)
1170 // You can also pass in a General_options instance instead of a
1171 // Position_dependent_options. In that case, we extract the
1172 // position-independent vars from the General_options and only store
1174 Input_file_argument(const char* name
, bool is_lib
,
1175 const char* extra_search_path
,
1177 const General_options
& options
)
1178 : name_(name
), is_lib_(is_lib
), extra_search_path_(extra_search_path
),
1179 just_symbols_(just_symbols
), options_(options
)
1184 { return this->name_
.c_str(); }
1186 const Position_dependent_options
&
1188 { return this->options_
; }
1192 { return this->is_lib_
; }
1195 extra_search_path() const
1197 return (this->extra_search_path_
.empty()
1199 : this->extra_search_path_
.c_str());
1202 // Return whether we should only read symbols from this file.
1204 just_symbols() const
1205 { return this->just_symbols_
; }
1207 // Return whether this file may require a search using the -L
1210 may_need_search() const
1211 { return this->is_lib_
|| !this->extra_search_path_
.empty(); }
1214 // We use std::string, not const char*, here for convenience when
1215 // using script files, so that we do not have to preserve the string
1219 std::string extra_search_path_
;
1221 Position_dependent_options options_
;
1224 // A file or library, or a group, from the command line.
1226 class Input_argument
1229 // Create a file or library argument.
1230 explicit Input_argument(Input_file_argument file
)
1231 : is_file_(true), file_(file
), group_(NULL
)
1234 // Create a group argument.
1235 explicit Input_argument(Input_file_group
* group
)
1236 : is_file_(false), group_(group
)
1239 // Return whether this is a file.
1242 { return this->is_file_
; }
1244 // Return whether this is a group.
1247 { return !this->is_file_
; }
1249 // Return the information about the file.
1250 const Input_file_argument
&
1253 gold_assert(this->is_file_
);
1257 // Return the information about the group.
1258 const Input_file_group
*
1261 gold_assert(!this->is_file_
);
1262 return this->group_
;
1268 gold_assert(!this->is_file_
);
1269 return this->group_
;
1274 Input_file_argument file_
;
1275 Input_file_group
* group_
;
1278 // A group from the command line. This is a set of arguments within
1279 // --start-group ... --end-group.
1281 class Input_file_group
1284 typedef std::vector
<Input_argument
> Files
;
1285 typedef Files::const_iterator const_iterator
;
1291 // Add a file to the end of the group.
1293 add_file(const Input_file_argument
& arg
)
1294 { this->files_
.push_back(Input_argument(arg
)); }
1296 // Iterators to iterate over the group contents.
1300 { return this->files_
.begin(); }
1304 { return this->files_
.end(); }
1310 // A list of files from the command line or a script.
1312 class Input_arguments
1315 typedef std::vector
<Input_argument
> Input_argument_list
;
1316 typedef Input_argument_list::const_iterator const_iterator
;
1319 : input_argument_list_(), in_group_(false)
1324 add_file(const Input_file_argument
& arg
);
1326 // Start a group (the --start-group option).
1330 // End a group (the --end-group option).
1334 // Return whether we are currently in a group.
1337 { return this->in_group_
; }
1339 // The number of entries in the list.
1342 { return this->input_argument_list_
.size(); }
1344 // Iterators to iterate over the list of input files.
1348 { return this->input_argument_list_
.begin(); }
1352 { return this->input_argument_list_
.end(); }
1354 // Return whether the list is empty.
1357 { return this->input_argument_list_
.empty(); }
1360 Input_argument_list input_argument_list_
;
1365 // All the information read from the command line. These are held in
1366 // three separate structs: one to hold the options (--foo), one to
1367 // hold the filenames listed on the commandline, and one to hold
1368 // linker script information. This third is not a subset of the other
1369 // two because linker scripts can be specified either as options (via
1370 // -T) or as a file.
1375 typedef Input_arguments::const_iterator const_iterator
;
1379 // Process the command line options. This will exit with an
1380 // appropriate error message if an unrecognized option is seen.
1382 process(int argc
, const char** argv
);
1384 // Process one command-line option. This takes the index of argv to
1385 // process, and returns the index for the next option. no_more_options
1386 // is set to true if argv[i] is "--".
1388 process_one_option(int argc
, const char** argv
, int i
,
1389 bool* no_more_options
);
1391 // Get the general options.
1392 const General_options
&
1394 { return this->options_
; }
1396 // Get the position dependent options.
1397 const Position_dependent_options
&
1398 position_dependent_options() const
1399 { return this->position_options_
; }
1401 // Get the linker-script options.
1404 { return this->script_options_
; }
1406 // Get the version-script options: a convenience routine.
1407 const Version_script_info
&
1408 version_script() const
1409 { return *this->script_options_
.version_script_info(); }
1411 // Get the input files.
1414 { return this->inputs_
; }
1416 // The number of input files.
1418 number_of_input_files() const
1419 { return this->inputs_
.size(); }
1421 // Iterators to iterate over the list of input files.
1425 { return this->inputs_
.begin(); }
1429 { return this->inputs_
.end(); }
1432 Command_line(const Command_line
&);
1433 Command_line
& operator=(const Command_line
&);
1435 General_options options_
;
1436 Position_dependent_options position_options_
;
1437 Script_options script_options_
;
1438 Input_arguments inputs_
;
1441 } // End namespace gold.
1443 #endif // !defined(GOLD_OPTIONS_H)