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_
; }
539 bool put_in_sysroot_
;
543 class General_options
546 // NOTE: For every option that you add here, also consider if you
547 // should add it to Position_dependent_options.
548 DEFINE_special(help
, options::TWO_DASHES
, '\0',
549 N_("Report usage information"), NULL
);
550 DEFINE_special(version
, options::TWO_DASHES
, 'v',
551 N_("Report version information"), NULL
);
552 DEFINE_special(V
, options::EXACTLY_ONE_DASH
, '\0',
553 N_("Report version and target information"), NULL
);
555 // These options are sorted approximately so that for each letter in
556 // the alphabet, we show the option whose shortname is that letter
557 // (if any) and then every longname that starts with that letter (in
558 // alphabetical order). For both, lowercase sorts before uppercase.
559 // The -z options come last.
561 DEFINE_bool(allow_shlib_undefined
, options::TWO_DASHES
, '\0', false,
562 N_("Allow unresolved references in shared libraries"),
563 N_("Do not allow unresolved references in shared libraries"));
565 DEFINE_bool(as_needed
, options::TWO_DASHES
, '\0', false,
566 N_("Only set DT_NEEDED for dynamic libs if used"),
567 N_("Always DT_NEEDED for dynamic libs"));
569 // This should really be an "enum", but it's too easy for folks to
570 // forget to update the list as they add new targets. So we just
571 // accept any string. We'll fail later (when the string is parsed),
572 // if the target isn't actually supported.
573 DEFINE_string(format
, options::TWO_DASHES
, 'b', "elf",
574 N_("Set input format"), ("[elf,binary]"));
576 DEFINE_bool(Bdynamic
, options::ONE_DASH
, '\0', true,
577 N_("-l searches for shared libraries"), NULL
);
578 DEFINE_bool_alias(Bstatic
, Bdynamic
, options::ONE_DASH
, '\0',
579 N_("-l does not search for shared libraries"), NULL
,
582 DEFINE_bool(Bsymbolic
, options::ONE_DASH
, '\0', false,
583 N_("Bind defined symbols locally"), NULL
);
585 DEFINE_bool(Bsymbolic_functions
, options::ONE_DASH
, '\0', false,
586 N_("Bind defined function symbols locally"), NULL
);
588 DEFINE_optional_string(build_id
, options::TWO_DASHES
, '\0', "sha1",
589 N_("Generate build ID note"),
592 DEFINE_bool(check_sections
, options::TWO_DASHES
, '\0', true,
593 N_("Check segment addresses for overlaps (default)"),
594 N_("Do not check segment addresses for overlaps"));
597 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
598 N_("Compress .debug_* sections in the output file"),
602 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
603 N_("Compress .debug_* sections in the output file"),
608 DEFINE_bool(define_common
, options::TWO_DASHES
, 'd', false,
609 N_("Define common symbols"),
610 N_("Do not define common symbols"));
611 DEFINE_bool(dc
, options::ONE_DASH
, '\0', false,
612 N_("Alias for -d"), NULL
);
613 DEFINE_bool(dp
, options::ONE_DASH
, '\0', false,
614 N_("Alias for -d"), NULL
);
616 DEFINE_string(debug
, options::TWO_DASHES
, '\0', "",
617 N_("Turn on debugging"),
618 N_("[all,files,script,task][,...]"));
620 DEFINE_special(defsym
, options::TWO_DASHES
, '\0',
621 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
623 DEFINE_optional_string(demangle
, options::TWO_DASHES
, '\0', NULL
,
624 N_("Demangle C++ symbols in log messages"),
627 DEFINE_bool(no_demangle
, options::TWO_DASHES
, '\0', false,
628 N_("Do not demangle C++ symbols in log messages"),
631 DEFINE_bool(detect_odr_violations
, options::TWO_DASHES
, '\0', false,
632 N_("Try to detect violations of the One Definition Rule"),
635 DEFINE_bool(dynamic_list_data
, options::TWO_DASHES
, '\0', false,
636 N_("Add data symbols to dynamic symbols"), NULL
);
638 DEFINE_bool(dynamic_list_cpp_new
, options::TWO_DASHES
, '\0', false,
639 N_("Add C++ operator new/delete to dynamic symbols"), NULL
);
641 DEFINE_bool(dynamic_list_cpp_typeinfo
, options::TWO_DASHES
, '\0', false,
642 N_("Add C++ typeinfo to dynamic symbols"), NULL
);
644 DEFINE_special(dynamic_list
, options::TWO_DASHES
, '\0',
645 N_("Read a list of dynamic symbols"), N_("FILE"));
647 DEFINE_string(entry
, options::TWO_DASHES
, 'e', NULL
,
648 N_("Set program start address"), N_("ADDRESS"));
650 DEFINE_bool(export_dynamic
, options::TWO_DASHES
, 'E', false,
651 N_("Export all dynamic symbols"),
652 N_("Do not export all dynamic symbols (default)"));
654 DEFINE_bool(eh_frame_hdr
, options::TWO_DASHES
, '\0', false,
655 N_("Create exception frame header"), NULL
);
657 DEFINE_bool(fatal_warnings
, options::TWO_DASHES
, '\0', false,
658 N_("Treat warnings as errors"),
659 N_("Do not treat warnings as errors"));
661 DEFINE_string(soname
, options::ONE_DASH
, 'h', NULL
,
662 N_("Set shared library name"), N_("FILENAME"));
664 DEFINE_double(hash_bucket_empty_fraction
, options::TWO_DASHES
, '\0', 0.0,
665 N_("Min fraction of empty buckets in dynamic hash"),
668 DEFINE_enum(hash_style
, options::TWO_DASHES
, '\0', "sysv",
669 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
670 {"sysv", "gnu", "both"});
672 DEFINE_string(dynamic_linker
, options::TWO_DASHES
, 'I', NULL
,
673 N_("Set dynamic linker path"), N_("PROGRAM"));
675 DEFINE_bool(incremental
, options::TWO_DASHES
, '\0', false,
676 N_("Work in progress; do not use"),
677 N_("Do a full build"));
679 DEFINE_special(incremental_changed
, options::TWO_DASHES
, '\0',
680 N_("Assume files changed"), NULL
);
682 DEFINE_special(incremental_unchanged
, options::TWO_DASHES
, '\0',
683 N_("Assume files didn't change"), NULL
);
685 DEFINE_special(incremental_unknown
, options::TWO_DASHES
, '\0',
686 N_("Use timestamps to check files (default)"), NULL
);
688 DEFINE_special(just_symbols
, options::TWO_DASHES
, '\0',
689 N_("Read only symbol values from FILE"), N_("FILE"));
691 DEFINE_special(library
, options::TWO_DASHES
, 'l',
692 N_("Search for library LIBNAME"), N_("LIBNAME"));
694 DEFINE_dirlist(library_path
, options::TWO_DASHES
, 'L',
695 N_("Add directory to search path"), N_("DIR"));
697 DEFINE_string(m
, options::EXACTLY_ONE_DASH
, 'm', "",
698 N_("Ignored for compatibility"), N_("EMULATION"));
700 DEFINE_bool(print_map
, options::TWO_DASHES
, 'M', false,
701 N_("Write map file on standard output"), NULL
);
702 DEFINE_string(Map
, options::ONE_DASH
, '\0', NULL
, N_("Write map file"),
705 DEFINE_bool(nmagic
, options::TWO_DASHES
, 'n', false,
706 N_("Do not page align data"), NULL
);
707 DEFINE_bool(omagic
, options::EXACTLY_TWO_DASHES
, 'N', false,
708 N_("Do not page align data, do not make text readonly"),
709 N_("Page align data, make text readonly"));
711 DEFINE_enable(new_dtags
, options::EXACTLY_TWO_DASHES
, '\0', false,
712 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
713 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
715 DEFINE_bool(noinhibit_exec
, options::TWO_DASHES
, '\0', false,
716 N_("Create an output file even if errors occur"), NULL
);
718 DEFINE_bool_alias(no_undefined
, defs
, options::TWO_DASHES
, '\0',
719 N_("Report undefined symbols (even with --shared)"),
722 DEFINE_string(output
, options::TWO_DASHES
, 'o', "a.out",
723 N_("Set output file name"), N_("FILE"));
725 DEFINE_uint(optimize
, options::EXACTLY_ONE_DASH
, 'O', 0,
726 N_("Optimize output file size"), N_("LEVEL"));
728 DEFINE_string(oformat
, options::EXACTLY_TWO_DASHES
, '\0', "elf",
729 N_("Set output format"), N_("[binary]"));
731 #ifdef ENABLE_PLUGINS
732 DEFINE_special(plugin
, options::TWO_DASHES
, '\0',
733 N_("Load a plugin library"), N_("PLUGIN"));
734 DEFINE_special(plugin_opt
, options::TWO_DASHES
, '\0',
735 N_("Pass an option to the plugin"), N_("OPTION"));
738 DEFINE_bool(preread_archive_symbols
, options::TWO_DASHES
, '\0', false,
739 N_("Preread archive symbols when multi-threaded"), NULL
);
741 DEFINE_string(print_symbol_counts
, options::TWO_DASHES
, '\0', NULL
,
742 N_("Print symbols defined and used for each input"),
745 DEFINE_bool(Qy
, options::EXACTLY_ONE_DASH
, '\0', false,
746 N_("Ignored for SVR4 compatibility"), NULL
);
748 DEFINE_bool(emit_relocs
, options::TWO_DASHES
, 'q', false,
749 N_("Generate relocations in output"), NULL
);
751 DEFINE_bool(relocatable
, options::EXACTLY_ONE_DASH
, 'r', false,
752 N_("Generate relocatable output"), NULL
);
754 DEFINE_bool(relax
, options::TWO_DASHES
, '\0', false,
755 N_("Relax branches on certain targets"), NULL
);
757 // -R really means -rpath, but can mean --just-symbols for
758 // compatibility with GNU ld. -rpath is always -rpath, so we list
760 DEFINE_special(R
, options::EXACTLY_ONE_DASH
, 'R',
761 N_("Add DIR to runtime search path"), N_("DIR"));
763 DEFINE_dirlist(rpath
, options::ONE_DASH
, '\0',
764 N_("Add DIR to runtime search path"), N_("DIR"));
766 DEFINE_dirlist(rpath_link
, options::TWO_DASHES
, '\0',
767 N_("Add DIR to link time shared library search path"),
770 DEFINE_bool(strip_all
, options::TWO_DASHES
, 's', false,
771 N_("Strip all symbols"), NULL
);
772 DEFINE_bool(strip_debug
, options::TWO_DASHES
, 'S', false,
773 N_("Strip debugging information"), NULL
);
774 DEFINE_bool(strip_debug_non_line
, options::TWO_DASHES
, '\0', false,
775 N_("Emit only debug line number information"), NULL
);
776 DEFINE_bool(strip_debug_gdb
, options::TWO_DASHES
, '\0', false,
777 N_("Strip debug symbols that are unused by gdb "
778 "(at least versions <= 6.7)"), NULL
);
779 DEFINE_bool(strip_lto_sections
, options::TWO_DASHES
, '\0', true,
780 N_("Strip LTO intermediate code sections"), NULL
);
782 DEFINE_bool(no_keep_memory
, options::TWO_DASHES
, 's', false,
783 N_("Use less memory and more disk I/O (included only for compatibility with GNU ld)"), NULL
);
785 DEFINE_bool(shared
, options::ONE_DASH
, '\0', false,
786 N_("Generate shared library"), NULL
);
788 DEFINE_bool(Bshareable
, options::ONE_DASH
, '\0', false,
789 N_("Generate shared library"), NULL
);
791 // This is not actually special in any way, but I need to give it
792 // a non-standard accessor-function name because 'static' is a keyword.
793 DEFINE_special(static, options::ONE_DASH
, '\0',
794 N_("Do not link against shared libraries"), NULL
);
796 DEFINE_bool(gc_sections
, options::TWO_DASHES
, '\0', false,
797 N_("Remove unused sections"),
798 N_("Don't remove unused sections (default)"));
800 DEFINE_bool(print_gc_sections
, options::TWO_DASHES
, '\0', false,
801 N_("List removed unused sections on stderr"),
802 N_("Do not list removed unused sections"));
804 DEFINE_bool(stats
, options::TWO_DASHES
, '\0', false,
805 N_("Print resource usage statistics"), NULL
);
807 DEFINE_string(sysroot
, options::TWO_DASHES
, '\0', "",
808 N_("Set target system root directory"), N_("DIR"));
810 DEFINE_bool(trace
, options::TWO_DASHES
, 't', false,
811 N_("Print the name of each input file"), NULL
);
813 DEFINE_special(script
, options::TWO_DASHES
, 'T',
814 N_("Read linker script"), N_("FILE"));
816 DEFINE_bool(threads
, options::TWO_DASHES
, '\0', false,
817 N_("Run the linker multi-threaded"),
818 N_("Do not run the linker multi-threaded"));
819 DEFINE_uint(thread_count
, options::TWO_DASHES
, '\0', 0,
820 N_("Number of threads to use"), N_("COUNT"));
821 DEFINE_uint(thread_count_initial
, options::TWO_DASHES
, '\0', 0,
822 N_("Number of threads to use in initial pass"), N_("COUNT"));
823 DEFINE_uint(thread_count_middle
, options::TWO_DASHES
, '\0', 0,
824 N_("Number of threads to use in middle pass"), N_("COUNT"));
825 DEFINE_uint(thread_count_final
, options::TWO_DASHES
, '\0', 0,
826 N_("Number of threads to use in final pass"), N_("COUNT"));
828 DEFINE_uint64(Tbss
, options::ONE_DASH
, '\0', -1U,
829 N_("Set the address of the bss segment"), N_("ADDRESS"));
830 DEFINE_uint64(Tdata
, options::ONE_DASH
, '\0', -1U,
831 N_("Set the address of the data segment"), N_("ADDRESS"));
832 DEFINE_uint64(Ttext
, options::ONE_DASH
, '\0', -1U,
833 N_("Set the address of the text segment"), N_("ADDRESS"));
835 DEFINE_set(undefined
, options::TWO_DASHES
, 'u',
836 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
838 DEFINE_bool(verbose
, options::TWO_DASHES
, '\0', false,
839 N_("Synonym for --debug=files"), NULL
);
841 DEFINE_special(version_script
, options::TWO_DASHES
, '\0',
842 N_("Read version script"), N_("FILE"));
844 DEFINE_bool(whole_archive
, options::TWO_DASHES
, '\0', false,
845 N_("Include all archive contents"),
846 N_("Include only needed archive contents"));
848 DEFINE_set(wrap
, options::TWO_DASHES
, '\0',
849 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
851 DEFINE_set(trace_symbol
, options::TWO_DASHES
, 'y',
852 N_("Trace references to symbol"), N_("SYMBOL"));
854 DEFINE_string(Y
, options::EXACTLY_ONE_DASH
, 'Y', "",
855 N_("Default search path for Solaris compatibility"),
858 DEFINE_special(start_group
, options::TWO_DASHES
, '(',
859 N_("Start a library search group"), NULL
);
860 DEFINE_special(end_group
, options::TWO_DASHES
, ')',
861 N_("End a library search group"), NULL
);
865 DEFINE_bool(combreloc
, options::DASH_Z
, '\0', true,
866 N_("Sort dynamic relocs"),
867 N_("Do not sort dynamic relocs"));
868 DEFINE_uint64(common_page_size
, options::DASH_Z
, '\0', 0,
869 N_("Set common page size to SIZE"), N_("SIZE"));
870 DEFINE_bool(defs
, options::DASH_Z
, '\0', false,
871 N_("Report undefined symbols (even with --shared)"),
873 DEFINE_bool(execstack
, options::DASH_Z
, '\0', false,
874 N_("Mark output as requiring executable stack"), NULL
);
875 DEFINE_uint64(max_page_size
, options::DASH_Z
, '\0', 0,
876 N_("Set maximum page size to SIZE"), N_("SIZE"));
877 DEFINE_bool(noexecstack
, options::DASH_Z
, '\0', false,
878 N_("Mark output as not requiring executable stack"), NULL
);
879 DEFINE_bool(initfirst
, options::DASH_Z
, '\0', false,
880 N_("Mark DSO to be initialized first at runtime"),
882 DEFINE_bool(interpose
, options::DASH_Z
, '\0', false,
883 N_("Mark object to interpose all DSOs but executable"),
885 DEFINE_bool(loadfltr
, options::DASH_Z
, '\0', false,
886 N_("Mark object requiring immediate process"),
888 DEFINE_bool(nodefaultlib
, options::DASH_Z
, '\0', false,
889 N_("Mark object not to use default search paths"),
891 DEFINE_bool(nodelete
, options::DASH_Z
, '\0', false,
892 N_("Mark DSO non-deletable at runtime"),
894 DEFINE_bool(nodlopen
, options::DASH_Z
, '\0', false,
895 N_("Mark DSO not available to dlopen"),
897 DEFINE_bool(nodump
, options::DASH_Z
, '\0', false,
898 N_("Mark DSO not available to dldump"),
900 DEFINE_bool(relro
, options::DASH_Z
, '\0', false,
901 N_("Where possible mark variables read-only after relocation"),
902 N_("Don't mark variables read-only after relocation"));
903 DEFINE_bool(origin
, options::DASH_Z
, '\0', false,
904 N_("Mark DSO to indicate that needs immediate $ORIGIN "
905 "processing at runtime"), NULL
);
908 typedef options::Dir_list Dir_list
;
912 // Does post-processing on flags, making sure they all have
913 // non-conflicting values. Also converts some flags from their
914 // "standard" types (string, etc), to another type (enum, DirList),
915 // which can be accessed via a separate method. Dies if it notices
919 // The macro defines output() (based on --output), but that's a
920 // generic name. Provide this alternative name, which is clearer.
922 output_file_name() const
923 { return this->output(); }
925 // This is not defined via a flag, but combines flags to say whether
926 // the output is position-independent or not.
928 output_is_position_independent() const
929 { return this->shared(); }
931 // Return true if the output is something that can be exec()ed, such
932 // as a static executable, or a position-dependent or
933 // position-independent executable, but not a dynamic library or an
936 output_is_executable() const
937 { return !this->shared() || this->output_is_pie(); }
939 // Return true if the output is a position-independent executable.
940 // This is currently not supported.
942 output_is_pie() const
945 // This would normally be static(), and defined automatically, but
946 // since static is a keyword, we need to come up with our own name.
951 // In addition to getting the input and output formats as a string
952 // (via format() and oformat()), we also give access as an enum.
957 // Straight binary format.
961 // Note: these functions are not very fast.
962 Object_format
format_enum() const;
963 Object_format
oformat_enum() const;
965 // These are the best way to get access to the execstack state,
966 // not execstack() and noexecstack() which are hard to use properly.
968 is_execstack_set() const
969 { return this->execstack_status_
!= EXECSTACK_FROM_INPUT
; }
972 is_stack_executable() const
973 { return this->execstack_status_
== EXECSTACK_YES
; }
975 // The --demangle option takes an optional string, and there is also
976 // a --no-demangle option. This is the best way to decide whether
977 // to demangle or not.
980 { return this->do_demangle_
; }
982 // Returns TRUE if any plugin libraries have been loaded.
985 { return this->plugins_
!= NULL
; }
987 // Return a pointer to the plugin manager.
990 { return this->plugins_
; }
992 // True iff SYMBOL was found in the file specified by dynamic-list.
994 in_dynamic_list(const char* symbol
) const
995 { return this->dynamic_list_
.version_script_info()->symbol_is_local(symbol
); }
997 // The disposition given by the --incremental-changed,
998 // --incremental-unchanged or --incremental-unknown option. The
999 // value may change as we proceed parsing the command line flags.
1000 Incremental_disposition
1001 incremental_disposition() const
1002 { return this->incremental_disposition_
; }
1005 // Don't copy this structure.
1006 General_options(const General_options
&);
1007 General_options
& operator=(const General_options
&);
1009 // Whether to mark the stack as executable.
1012 // Not set on command line.
1013 EXECSTACK_FROM_INPUT
,
1014 // Mark the stack as executable (-z execstack).
1016 // Mark the stack as not executable (-z noexecstack).
1021 set_execstack_status(Execstack value
)
1022 { this->execstack_status_
= value
; }
1025 set_do_demangle(bool value
)
1026 { this->do_demangle_
= value
; }
1029 set_static(bool value
)
1030 { static_
= value
; }
1032 // These are called by finalize() to set up the search-path correctly.
1034 add_to_library_path_with_sysroot(const char* arg
)
1035 { this->add_search_directory_to_library_path(Search_directory(arg
, true)); }
1037 // Apply any sysroot to the directory lists.
1041 // Add a plugin and its arguments to the list of plugins.
1043 add_plugin(const char *filename
);
1045 // Add a plugin option.
1047 add_plugin_option(const char* opt
);
1049 // Whether to mark the stack as executable.
1050 Execstack execstack_status_
;
1051 // Whether to do a static link.
1053 // Whether to do demangling.
1055 // List of plugin libraries.
1056 Plugin_manager
* plugins_
;
1057 // The parsed output of --dynamic-list files. For convenience in
1058 // script.cc, we store this as a Script_options object, even though
1059 // we only use a single Version_tree from it.
1060 Script_options dynamic_list_
;
1061 // The disposition given by the --incremental-changed,
1062 // --incremental-unchanged or --incremental-unknown option. The
1063 // value may change as we proceed parsing the command line flags.
1064 Incremental_disposition incremental_disposition_
;
1065 // Wheater we have seen one of the options that require incremental
1066 // build (--incremental-changed, --incremental-unchanged or
1067 // --incremental-unknown)
1068 bool implicit_incremental_
;
1071 // The position-dependent options. We use this to store the state of
1072 // the commandline at a particular point in parsing for later
1073 // reference. For instance, if we see "ld --whole-archive foo.a
1074 // --no-whole-archive," we want to store the whole-archive option with
1075 // foo.a, so when the time comes to parse foo.a we know we should do
1076 // it in whole-archive mode. We could store all of General_options,
1077 // but that's big, so we just pick the subset of flags that actually
1078 // change in a position-dependent way.
1080 #define DEFINE_posdep(varname__, type__) \
1084 { return this->varname__##_; } \
1087 set_##varname__(type__ value) \
1088 { this->varname__##_ = value; } \
1092 class Position_dependent_options
1095 Position_dependent_options(const General_options
& options
1096 = Position_dependent_options::default_options_
)
1097 { copy_from_options(options
); }
1099 void copy_from_options(const General_options
& options
)
1101 this->set_as_needed(options
.as_needed());
1102 this->set_Bdynamic(options
.Bdynamic());
1103 this->set_format_enum(options
.format_enum());
1104 this->set_whole_archive(options
.whole_archive());
1105 this->set_incremental_disposition(options
.incremental_disposition());
1108 DEFINE_posdep(as_needed
, bool);
1109 DEFINE_posdep(Bdynamic
, bool);
1110 DEFINE_posdep(format_enum
, General_options::Object_format
);
1111 DEFINE_posdep(whole_archive
, bool);
1112 DEFINE_posdep(incremental_disposition
, Incremental_disposition
);
1115 // This is a General_options with everything set to its default
1116 // value. A Position_dependent_options created with no argument
1117 // will take its values from here.
1118 static General_options default_options_
;
1122 // A single file or library argument from the command line.
1124 class Input_file_argument
1127 // name: file name or library name
1128 // is_lib: true if name is a library name: that is, emits the leading
1129 // "lib" and trailing ".so"/".a" from the name
1130 // extra_search_path: an extra directory to look for the file, prior
1131 // to checking the normal library search path. If this is "",
1132 // then no extra directory is added.
1133 // just_symbols: whether this file only defines symbols.
1134 // options: The position dependent options at this point in the
1135 // command line, such as --whole-archive.
1136 Input_file_argument()
1137 : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false),
1141 Input_file_argument(const char* name
, bool is_lib
,
1142 const char* extra_search_path
,
1144 const Position_dependent_options
& options
)
1145 : name_(name
), is_lib_(is_lib
), extra_search_path_(extra_search_path
),
1146 just_symbols_(just_symbols
), options_(options
)
1149 // You can also pass in a General_options instance instead of a
1150 // Position_dependent_options. In that case, we extract the
1151 // position-independent vars from the General_options and only store
1153 Input_file_argument(const char* name
, bool is_lib
,
1154 const char* extra_search_path
,
1156 const General_options
& options
)
1157 : name_(name
), is_lib_(is_lib
), extra_search_path_(extra_search_path
),
1158 just_symbols_(just_symbols
), options_(options
)
1163 { return this->name_
.c_str(); }
1165 const Position_dependent_options
&
1167 { return this->options_
; }
1171 { return this->is_lib_
; }
1174 extra_search_path() const
1176 return (this->extra_search_path_
.empty()
1178 : this->extra_search_path_
.c_str());
1181 // Return whether we should only read symbols from this file.
1183 just_symbols() const
1184 { return this->just_symbols_
; }
1186 // Return whether this file may require a search using the -L
1189 may_need_search() const
1190 { return this->is_lib_
|| !this->extra_search_path_
.empty(); }
1193 // We use std::string, not const char*, here for convenience when
1194 // using script files, so that we do not have to preserve the string
1198 std::string extra_search_path_
;
1200 Position_dependent_options options_
;
1203 // A file or library, or a group, from the command line.
1205 class Input_argument
1208 // Create a file or library argument.
1209 explicit Input_argument(Input_file_argument file
)
1210 : is_file_(true), file_(file
), group_(NULL
)
1213 // Create a group argument.
1214 explicit Input_argument(Input_file_group
* group
)
1215 : is_file_(false), group_(group
)
1218 // Return whether this is a file.
1221 { return this->is_file_
; }
1223 // Return whether this is a group.
1226 { return !this->is_file_
; }
1228 // Return the information about the file.
1229 const Input_file_argument
&
1232 gold_assert(this->is_file_
);
1236 // Return the information about the group.
1237 const Input_file_group
*
1240 gold_assert(!this->is_file_
);
1241 return this->group_
;
1247 gold_assert(!this->is_file_
);
1248 return this->group_
;
1253 Input_file_argument file_
;
1254 Input_file_group
* group_
;
1257 // A group from the command line. This is a set of arguments within
1258 // --start-group ... --end-group.
1260 class Input_file_group
1263 typedef std::vector
<Input_argument
> Files
;
1264 typedef Files::const_iterator const_iterator
;
1270 // Add a file to the end of the group.
1272 add_file(const Input_file_argument
& arg
)
1273 { this->files_
.push_back(Input_argument(arg
)); }
1275 // Iterators to iterate over the group contents.
1279 { return this->files_
.begin(); }
1283 { return this->files_
.end(); }
1289 // A list of files from the command line or a script.
1291 class Input_arguments
1294 typedef std::vector
<Input_argument
> Input_argument_list
;
1295 typedef Input_argument_list::const_iterator const_iterator
;
1298 : input_argument_list_(), in_group_(false)
1303 add_file(const Input_file_argument
& arg
);
1305 // Start a group (the --start-group option).
1309 // End a group (the --end-group option).
1313 // Return whether we are currently in a group.
1316 { return this->in_group_
; }
1318 // The number of entries in the list.
1321 { return this->input_argument_list_
.size(); }
1323 // Iterators to iterate over the list of input files.
1327 { return this->input_argument_list_
.begin(); }
1331 { return this->input_argument_list_
.end(); }
1333 // Return whether the list is empty.
1336 { return this->input_argument_list_
.empty(); }
1339 Input_argument_list input_argument_list_
;
1344 // All the information read from the command line. These are held in
1345 // three separate structs: one to hold the options (--foo), one to
1346 // hold the filenames listed on the commandline, and one to hold
1347 // linker script information. This third is not a subset of the other
1348 // two because linker scripts can be specified either as options (via
1349 // -T) or as a file.
1354 typedef Input_arguments::const_iterator const_iterator
;
1358 // Process the command line options. This will exit with an
1359 // appropriate error message if an unrecognized option is seen.
1361 process(int argc
, const char** argv
);
1363 // Process one command-line option. This takes the index of argv to
1364 // process, and returns the index for the next option. no_more_options
1365 // is set to true if argv[i] is "--".
1367 process_one_option(int argc
, const char** argv
, int i
,
1368 bool* no_more_options
);
1370 // Get the general options.
1371 const General_options
&
1373 { return this->options_
; }
1375 // Get the position dependent options.
1376 const Position_dependent_options
&
1377 position_dependent_options() const
1378 { return this->position_options_
; }
1380 // Get the linker-script options.
1383 { return this->script_options_
; }
1385 // Get the version-script options: a convenience routine.
1386 const Version_script_info
&
1387 version_script() const
1388 { return *this->script_options_
.version_script_info(); }
1390 // Get the input files.
1393 { return this->inputs_
; }
1395 // The number of input files.
1397 number_of_input_files() const
1398 { return this->inputs_
.size(); }
1400 // Iterators to iterate over the list of input files.
1404 { return this->inputs_
.begin(); }
1408 { return this->inputs_
.end(); }
1411 Command_line(const Command_line
&);
1412 Command_line
& operator=(const Command_line
&);
1414 General_options options_
;
1415 Position_dependent_options position_options_
;
1416 Script_options script_options_
;
1417 Input_arguments inputs_
;
1420 } // End namespace gold.
1422 #endif // !defined(GOLD_OPTIONS_H)