1 // options.h -- handle command line options for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
6 // This file is part of gold.
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
23 // General_options (from Command_line::options())
24 // All the options (a.k.a. command-line flags)
25 // Input_argument (from Command_line::inputs())
26 // The list of input files, including -l options.
28 // Everything we get from the command line -- the General_options
29 // plus the Input_arguments.
31 // There are also some smaller classes, such as
32 // Position_dependent_options which hold a subset of General_options
33 // that change as options are parsed (as opposed to the usual behavior
34 // of the last instance of that option specified on the commandline wins).
36 #ifndef GOLD_OPTIONS_H
37 #define GOLD_OPTIONS_H
53 class General_options
;
54 class Search_directory
;
55 class Input_file_group
;
56 class Position_dependent_options
;
60 // Incremental build action for a specific file, as selected by the user.
62 enum Incremental_disposition
64 // Determine the status from the timestamp (default).
66 // Assume the file changed from the previous build.
68 // Assume the file didn't change from the previous build.
72 // The nested namespace is to contain all the global variables and
73 // structs that need to be defined in the .h file, but do not need to
74 // be used outside this class.
77 typedef std::vector
<Search_directory
> Dir_list
;
78 typedef Unordered_set
<std::string
> String_set
;
80 // These routines convert from a string option to various types.
81 // Each gives a fatal error if it cannot parse the argument.
84 parse_bool(const char* option_name
, const char* arg
, bool* retval
);
87 parse_int(const char* option_name
, const char* arg
, int* retval
);
90 parse_uint(const char* option_name
, const char* arg
, int* retval
);
93 parse_uint64(const char* option_name
, const char* arg
, uint64_t* retval
);
96 parse_double(const char* option_name
, const char* arg
, double* retval
);
99 parse_string(const char* option_name
, const char* arg
, const char** retval
);
102 parse_optional_string(const char* option_name
, const char* arg
,
103 const char** retval
);
106 parse_dirlist(const char* option_name
, const char* arg
, Dir_list
* retval
);
109 parse_set(const char* option_name
, const char* arg
, String_set
* retval
);
112 parse_choices(const char* option_name
, const char* arg
, const char** retval
,
113 const char* choices
[], int num_choices
);
117 // Most options have both a shortname (one letter) and a longname.
118 // This enum controls how many dashes are expected for longname access
119 // -- shortnames always use one dash. Most longnames will accept
120 // either one dash or two; the only difference between ONE_DASH and
121 // TWO_DASHES is how we print the option in --help. However, some
122 // longnames require two dashes, and some require only one. The
123 // special value DASH_Z means that the option is preceded by "-z".
126 ONE_DASH
, TWO_DASHES
, EXACTLY_ONE_DASH
, EXACTLY_TWO_DASHES
, DASH_Z
129 // LONGNAME is the long-name of the option with dashes converted to
130 // underscores, or else the short-name if the option has no long-name.
131 // It is never the empty string.
132 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
133 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
134 // option has no short-name. If the option has no long-name, you
135 // should specify the short-name in *both* VARNAME and here.
136 // DEFAULT_VALUE is the value of the option if not specified on the
137 // commandline, as a string.
138 // HELPSTRING is the descriptive text used with the option via --help
139 // HELPARG is how you define the argument to the option.
140 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
141 // HELPARG should be NULL iff the option is a bool and takes no arg.
142 // OPTIONAL_ARG is true if this option takes an optional argument. An
143 // optional argument must be specifid as --OPTION=VALUE, not
145 // READER provides parse_to_value, which is a function that will convert
146 // a char* argument into the proper type and store it in some variable.
147 // A One_option struct initializes itself with the global list of options
148 // at constructor time, so be careful making one of these.
151 std::string longname
;
154 const char* default_value
;
155 const char* helpstring
;
160 One_option(const char* ln
, Dashes d
, char sn
, const char* dv
,
161 const char* hs
, const char* ha
, bool oa
, Struct_var
* r
)
162 : longname(ln
), dashes(d
), shortname(sn
), default_value(dv
? dv
: ""),
163 helpstring(hs
), helparg(ha
), optional_arg(oa
), reader(r
)
165 // In longname, we convert all underscores to dashes, since GNU
166 // style uses dashes in option names. longname is likely to have
167 // underscores in it because it's also used to declare a C++
169 const char* pos
= strchr(this->longname
.c_str(), '_');
170 for (; pos
; pos
= strchr(pos
, '_'))
171 this->longname
[pos
- this->longname
.c_str()] = '-';
173 // We only register ourselves if our helpstring is not NULL. This
174 // is to support the "no-VAR" boolean variables, which we
175 // conditionally turn on by defining "no-VAR" help text.
176 if (this->helpstring
)
177 this->register_option();
180 // This option takes an argument iff helparg is not NULL.
182 takes_argument() const
183 { return this->helparg
!= NULL
; }
185 // Whether the argument is optional.
187 takes_optional_argument() const
188 { return this->optional_arg
; }
190 // Register this option with the global list of options.
194 // Print this option to stdout (used with --help).
199 // All options have a Struct_##varname that inherits from this and
200 // actually implements parse_to_value for that option.
203 // OPTION: the name of the option as specified on the commandline,
204 // including leading dashes, and any text following the option:
205 // "-O", "--defsym=mysym=0x1000", etc.
206 // ARG: the arg associated with this option, or NULL if the option
207 // takes no argument: "2", "mysym=0x1000", etc.
208 // CMDLINE: the global Command_line object. Used by DEFINE_special.
209 // OPTIONS: the global General_options object. Used by DEFINE_special.
211 parse_to_value(const char* option
, const char* arg
,
212 Command_line
* cmdline
, General_options
* options
) = 0;
214 ~Struct_var() // To make gcc happy.
218 // This is for "special" options that aren't of any predefined type.
219 struct Struct_special
: public Struct_var
221 // If you change this, change the parse-fn in DEFINE_special as well.
222 typedef void (General_options::*Parse_function
)(const char*, const char*,
224 Struct_special(const char* varname
, Dashes dashes
, char shortname
,
225 Parse_function parse_function
,
226 const char* helpstring
, const char* helparg
)
227 : option(varname
, dashes
, shortname
, "", helpstring
, helparg
, false, this),
228 parse(parse_function
)
231 void parse_to_value(const char* option
, const char* arg
,
232 Command_line
* cmdline
, General_options
* options
)
233 { (options
->*(this->parse
))(option
, arg
, cmdline
); }
236 Parse_function parse
;
239 } // End namespace options.
242 // These are helper macros use by DEFINE_uint64/etc below.
243 // This macro is used inside the General_options_ class, so defines
244 // var() and set_var() as General_options methods. Arguments as are
245 // for the constructor for One_option. param_type__ is the same as
246 // type__ for built-in types, and "const type__ &" otherwise.
248 // When we define the linker command option "assert", the macro argument
249 // varname__ of DEFINE_var below will be replaced by "assert". On Mac OSX
250 // assert.h is included implicitly by one of the library headers we use. To
251 // avoid unintended macro substitution of "assert()", we need to enclose
252 // varname__ with parenthese.
253 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
254 default_value_as_string__, helpstring__, helparg__, \
255 optional_arg__, type__, param_type__, parse_fn__) \
258 (varname__)() const \
259 { return this->varname__##_.value; } \
262 user_set_##varname__() const \
263 { return this->varname__##_.user_set_via_option; } \
266 set_user_set_##varname__() \
267 { this->varname__##_.user_set_via_option = true; } \
270 struct Struct_##varname__ : public options::Struct_var \
272 Struct_##varname__() \
273 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
274 helpstring__, helparg__, optional_arg__, this), \
275 user_set_via_option(false), value(default_value__) \
279 parse_to_value(const char* option_name, const char* arg, \
280 Command_line*, General_options*) \
282 parse_fn__(option_name, arg, &this->value); \
283 this->user_set_via_option = true; \
286 options::One_option option; \
287 bool user_set_via_option; \
290 Struct_##varname__ varname__##_; \
292 set_##varname__(param_type__ value) \
293 { this->varname__##_.value = value; }
295 // These macros allow for easy addition of a new commandline option.
297 // If no_helpstring__ is not NULL, then in addition to creating
298 // VARNAME, we also create an option called no-VARNAME (or, for a -z
299 // option, noVARNAME).
300 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
301 helpstring__, no_helpstring__) \
302 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
303 default_value__ ? "true" : "false", helpstring__, NULL, \
304 false, bool, bool, options::parse_bool) \
305 struct Struct_no_##varname__ : public options::Struct_var \
307 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
309 : "no-" #varname__), \
311 default_value__ ? "false" : "true", \
312 no_helpstring__, NULL, false, this) \
316 parse_to_value(const char*, const char*, \
317 Command_line*, General_options* options) \
318 { options->set_##varname__(false); } \
320 options::One_option option; \
322 Struct_no_##varname__ no_##varname__##_initializer_
324 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
325 helpstring__, no_helpstring__) \
326 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
327 default_value__ ? "true" : "false", helpstring__, NULL, \
328 false, bool, bool, options::parse_bool) \
329 struct Struct_disable_##varname__ : public options::Struct_var \
331 Struct_disable_##varname__() : option("disable-" #varname__, \
333 default_value__ ? "false" : "true", \
334 no_helpstring__, NULL, false, this) \
338 parse_to_value(const char*, const char*, \
339 Command_line*, General_options* options) \
340 { options->set_enable_##varname__(false); } \
342 options::One_option option; \
344 Struct_disable_##varname__ disable_##varname__##_initializer_
346 #define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
347 helpstring__, helparg__) \
348 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
349 #default_value__, helpstring__, helparg__, false, \
350 int, int, options::parse_int)
352 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
353 helpstring__, helparg__) \
354 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
355 #default_value__, helpstring__, helparg__, false, \
356 int, int, options::parse_uint)
358 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
359 helpstring__, helparg__) \
360 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
361 #default_value__, helpstring__, helparg__, false, \
362 uint64_t, uint64_t, options::parse_uint64)
364 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
365 helpstring__, helparg__) \
366 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
367 #default_value__, helpstring__, helparg__, false, \
368 double, double, options::parse_double)
370 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
371 helpstring__, helparg__) \
372 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
373 default_value__, helpstring__, helparg__, false, \
374 const char*, const char*, options::parse_string)
376 // This is like DEFINE_string, but we convert each occurrence to a
377 // Search_directory and store it in a vector. Thus we also have the
378 // add_to_VARNAME() method, to append to the vector.
379 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
380 helpstring__, helparg__) \
381 DEFINE_var(varname__, dashes__, shortname__, , \
382 "", helpstring__, helparg__, false, options::Dir_list, \
383 const options::Dir_list&, options::parse_dirlist) \
385 add_to_##varname__(const char* new_value) \
386 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
388 add_search_directory_to_##varname__(const Search_directory& dir) \
389 { this->varname__##_.value.push_back(dir); }
391 // This is like DEFINE_string, but we store a set of strings.
392 #define DEFINE_set(varname__, dashes__, shortname__, \
393 helpstring__, helparg__) \
394 DEFINE_var(varname__, dashes__, shortname__, , \
395 "", helpstring__, helparg__, false, options::String_set, \
396 const options::String_set&, options::parse_set) \
399 any_##varname__() const \
400 { return !this->varname__##_.value.empty(); } \
403 is_##varname__(const char* symbol) const \
405 return (!this->varname__##_.value.empty() \
406 && (this->varname__##_.value.find(std::string(symbol)) \
407 != this->varname__##_.value.end())); \
410 options::String_set::const_iterator \
411 varname__##_begin() const \
412 { return this->varname__##_.value.begin(); } \
414 options::String_set::const_iterator \
415 varname__##_end() const \
416 { return this->varname__##_.value.end(); }
418 // When you have a list of possible values (expressed as string)
419 // After helparg__ should come an initializer list, like
420 // {"foo", "bar", "baz"}
421 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
422 helpstring__, helparg__, ...) \
423 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
424 default_value__, helpstring__, helparg__, false, \
425 const char*, const char*, parse_choices_##varname__) \
427 static void parse_choices_##varname__(const char* option_name, \
429 const char** retval) { \
430 const char* choices[] = __VA_ARGS__; \
431 options::parse_choices(option_name, arg, retval, \
432 choices, sizeof(choices) / sizeof(*choices)); \
435 // This is like DEFINE_bool, but VARNAME is the name of a different
436 // option. This option becomes an alias for that one. INVERT is true
437 // if this option is an inversion of the other one.
438 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
439 helpstring__, no_helpstring__, invert__) \
441 struct Struct_##option__ : public options::Struct_var \
443 Struct_##option__() \
444 : option(#option__, dashes__, shortname__, "", helpstring__, \
449 parse_to_value(const char*, const char*, \
450 Command_line*, General_options* options) \
452 options->set_##varname__(!invert__); \
453 options->set_user_set_##varname__(); \
456 options::One_option option; \
458 Struct_##option__ option__##_; \
460 struct Struct_no_##option__ : public options::Struct_var \
462 Struct_no_##option__() \
463 : option((dashes__ == options::DASH_Z \
465 : "no-" #option__), \
466 dashes__, '\0', "", no_helpstring__, \
471 parse_to_value(const char*, const char*, \
472 Command_line*, General_options* options) \
474 options->set_##varname__(invert__); \
475 options->set_user_set_##varname__(); \
478 options::One_option option; \
480 Struct_no_##option__ no_##option__##_initializer_
482 // This is used for non-standard flags. It defines no functions; it
483 // just calls General_options::parse_VARNAME whenever the flag is
484 // seen. We declare parse_VARNAME as a static member of
485 // General_options; you are responsible for defining it there.
486 // helparg__ should be NULL iff this special-option is a boolean.
487 #define DEFINE_special(varname__, dashes__, shortname__, \
488 helpstring__, helparg__) \
490 void parse_##varname__(const char* option, const char* arg, \
491 Command_line* inputs); \
492 struct Struct_##varname__ : public options::Struct_special \
494 Struct_##varname__() \
495 : options::Struct_special(#varname__, dashes__, shortname__, \
496 &General_options::parse_##varname__, \
497 helpstring__, helparg__) \
500 Struct_##varname__ varname__##_initializer_
502 // An option that takes an optional string argument. If the option is
503 // used with no argument, the value will be the default, and
504 // user_set_via_option will be true.
505 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
507 helpstring__, helparg__) \
508 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
509 default_value__, helpstring__, helparg__, true, \
510 const char*, const char*, options::parse_optional_string)
512 // A directory to search. For each directory we record whether it is
513 // in the sysroot. We need to know this so that, if a linker script
514 // is found within the sysroot, we will apply the sysroot to any files
515 // named by that script.
517 class Search_directory
520 // We need a default constructor because we put this in a
523 : name_(NULL
), put_in_sysroot_(false), is_in_sysroot_(false)
526 // This is the usual constructor.
527 Search_directory(const char* name
, bool put_in_sysroot
)
528 : name_(name
), put_in_sysroot_(put_in_sysroot
), is_in_sysroot_(false)
530 if (this->name_
.empty())
534 // This is called if we have a sysroot. The sysroot is prefixed to
535 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
536 // set to true for any enries which are in the sysroot (this will
537 // naturally include any entries for which put_in_sysroot_ is true).
538 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
539 // passing SYSROOT to lrealpath.
541 add_sysroot(const char* sysroot
, const char* canonical_sysroot
);
543 // Get the directory name.
546 { return this->name_
; }
548 // Return whether this directory is in the sysroot.
550 is_in_sysroot() const
551 { return this->is_in_sysroot_
; }
553 // Return whether this is considered a system directory.
555 is_system_directory() const
556 { return this->put_in_sysroot_
|| this->is_in_sysroot_
; }
559 // The directory name.
561 // True if the sysroot should be added as a prefix for this
562 // directory (if there is a sysroot). This is true for system
563 // directories that we search by default.
564 bool put_in_sysroot_
;
565 // True if this directory is in the sysroot (if there is a sysroot).
566 // This is true if there is a sysroot and either 1) put_in_sysroot_
567 // is true, or 2) the directory happens to be in the sysroot based
568 // on a pathname comparison.
572 class General_options
575 // NOTE: For every option that you add here, also consider if you
576 // should add it to Position_dependent_options.
577 DEFINE_special(help
, options::TWO_DASHES
, '\0',
578 N_("Report usage information"), NULL
);
579 DEFINE_special(version
, options::TWO_DASHES
, 'v',
580 N_("Report version information"), NULL
);
581 DEFINE_special(V
, options::EXACTLY_ONE_DASH
, '\0',
582 N_("Report version and target information"), NULL
);
584 // These options are sorted approximately so that for each letter in
585 // the alphabet, we show the option whose shortname is that letter
586 // (if any) and then every longname that starts with that letter (in
587 // alphabetical order). For both, lowercase sorts before uppercase.
588 // The -z options come last.
590 DEFINE_bool(add_needed
, options::TWO_DASHES
, '\0', false,
592 N_("Do not copy DT_NEEDED tags from shared libraries"));
594 DEFINE_bool_alias(allow_multiple_definition
, muldefs
, options::TWO_DASHES
,
595 '\0', N_("Allow multiple definitions of symbols"),
596 N_("Do not allow multiple definitions"), false);
598 DEFINE_bool(allow_shlib_undefined
, options::TWO_DASHES
, '\0', false,
599 N_("Allow unresolved references in shared libraries"),
600 N_("Do not allow unresolved references in shared libraries"));
602 DEFINE_bool(as_needed
, options::TWO_DASHES
, '\0', false,
603 N_("Only set DT_NEEDED for shared libraries if used"),
604 N_("Always DT_NEEDED for shared libraries"));
606 DEFINE_enum(assert, options::ONE_DASH
, '\0', NULL
,
607 N_("Ignored"), N_("[ignored]"),
608 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
610 // This should really be an "enum", but it's too easy for folks to
611 // forget to update the list as they add new targets. So we just
612 // accept any string. We'll fail later (when the string is parsed),
613 // if the target isn't actually supported.
614 DEFINE_string(format
, options::TWO_DASHES
, 'b', "elf",
615 N_("Set input format"), ("[elf,binary]"));
617 DEFINE_bool(Bdynamic
, options::ONE_DASH
, '\0', true,
618 N_("-l searches for shared libraries"), NULL
);
619 DEFINE_bool_alias(Bstatic
, Bdynamic
, options::ONE_DASH
, '\0',
620 N_("-l does not search for shared libraries"), NULL
,
623 DEFINE_bool(Bsymbolic
, options::ONE_DASH
, '\0', false,
624 N_("Bind defined symbols locally"), NULL
);
626 DEFINE_bool(Bsymbolic_functions
, options::ONE_DASH
, '\0', false,
627 N_("Bind defined function symbols locally"), NULL
);
629 DEFINE_optional_string(build_id
, options::TWO_DASHES
, '\0', "sha1",
630 N_("Generate build ID note"),
633 DEFINE_bool(check_sections
, options::TWO_DASHES
, '\0', true,
634 N_("Check segment addresses for overlaps (default)"),
635 N_("Do not check segment addresses for overlaps"));
638 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
639 N_("Compress .debug_* sections in the output file"),
643 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
644 N_("Compress .debug_* sections in the output file"),
649 DEFINE_bool(copy_dt_needed_entries
, options::TWO_DASHES
, '\0', false,
651 N_("Do not copy DT_NEEDED tags from shared libraries"));
653 DEFINE_bool(cref
, options::TWO_DASHES
, '\0', false,
654 N_("Output cross reference table"),
655 N_("Do not output cross reference table"));
657 DEFINE_bool(define_common
, options::TWO_DASHES
, 'd', false,
658 N_("Define common symbols"),
659 N_("Do not define common symbols"));
660 DEFINE_bool(dc
, options::ONE_DASH
, '\0', false,
661 N_("Alias for -d"), NULL
);
662 DEFINE_bool(dp
, options::ONE_DASH
, '\0', false,
663 N_("Alias for -d"), NULL
);
665 DEFINE_string(debug
, options::TWO_DASHES
, '\0', "",
666 N_("Turn on debugging"),
667 N_("[all,files,script,task][,...]"));
669 DEFINE_special(defsym
, options::TWO_DASHES
, '\0',
670 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
672 DEFINE_optional_string(demangle
, options::TWO_DASHES
, '\0', NULL
,
673 N_("Demangle C++ symbols in log messages"),
676 DEFINE_bool(no_demangle
, options::TWO_DASHES
, '\0', false,
677 N_("Do not demangle C++ symbols in log messages"),
680 DEFINE_bool(detect_odr_violations
, options::TWO_DASHES
, '\0', false,
681 N_("Try to detect violations of the One Definition Rule"),
684 DEFINE_bool(discard_all
, options::TWO_DASHES
, 'x', false,
685 N_("Delete all local symbols"), NULL
);
686 DEFINE_bool(discard_locals
, options::TWO_DASHES
, 'X', false,
687 N_("Delete all temporary local symbols"), NULL
);
689 DEFINE_bool(dynamic_list_data
, options::TWO_DASHES
, '\0', false,
690 N_("Add data symbols to dynamic symbols"), NULL
);
692 DEFINE_bool(dynamic_list_cpp_new
, options::TWO_DASHES
, '\0', false,
693 N_("Add C++ operator new/delete to dynamic symbols"), NULL
);
695 DEFINE_bool(dynamic_list_cpp_typeinfo
, options::TWO_DASHES
, '\0', false,
696 N_("Add C++ typeinfo to dynamic symbols"), NULL
);
698 DEFINE_special(dynamic_list
, options::TWO_DASHES
, '\0',
699 N_("Read a list of dynamic symbols"), N_("FILE"));
701 DEFINE_string(entry
, options::TWO_DASHES
, 'e', NULL
,
702 N_("Set program start address"), N_("ADDRESS"));
704 DEFINE_special(exclude_libs
, options::TWO_DASHES
, '\0',
705 N_("Exclude libraries from automatic export"),
706 N_(("lib,lib ...")));
708 DEFINE_bool(export_dynamic
, options::TWO_DASHES
, 'E', false,
709 N_("Export all dynamic symbols"),
710 N_("Do not export all dynamic symbols (default)"));
712 DEFINE_bool(eh_frame_hdr
, options::TWO_DASHES
, '\0', false,
713 N_("Create exception frame header"), NULL
);
715 DEFINE_bool(fatal_warnings
, options::TWO_DASHES
, '\0', false,
716 N_("Treat warnings as errors"),
717 N_("Do not treat warnings as errors"));
719 DEFINE_string(fini
, options::ONE_DASH
, '\0', "_fini",
720 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
722 DEFINE_bool(g
, options::EXACTLY_ONE_DASH
, '\0', false,
723 N_("Ignored"), NULL
);
725 DEFINE_string(soname
, options::ONE_DASH
, 'h', NULL
,
726 N_("Set shared library name"), N_("FILENAME"));
728 DEFINE_bool(i
, options::EXACTLY_ONE_DASH
, '\0', false,
729 N_("Ignored"), NULL
);
731 DEFINE_double(hash_bucket_empty_fraction
, options::TWO_DASHES
, '\0', 0.0,
732 N_("Min fraction of empty buckets in dynamic hash"),
735 DEFINE_enum(hash_style
, options::TWO_DASHES
, '\0', "sysv",
736 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
737 {"sysv", "gnu", "both"});
739 DEFINE_string(dynamic_linker
, options::TWO_DASHES
, 'I', NULL
,
740 N_("Set dynamic linker path"), N_("PROGRAM"));
742 DEFINE_bool(incremental
, options::TWO_DASHES
, '\0', false,
743 N_("Work in progress; do not use"),
744 N_("Do a full build"));
746 DEFINE_special(incremental_changed
, options::TWO_DASHES
, '\0',
747 N_("Assume files changed"), NULL
);
749 DEFINE_special(incremental_unchanged
, options::TWO_DASHES
, '\0',
750 N_("Assume files didn't change"), NULL
);
752 DEFINE_special(incremental_unknown
, options::TWO_DASHES
, '\0',
753 N_("Use timestamps to check files (default)"), NULL
);
755 DEFINE_string(init
, options::ONE_DASH
, '\0', "_init",
756 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
758 DEFINE_special(just_symbols
, options::TWO_DASHES
, '\0',
759 N_("Read only symbol values from FILE"), N_("FILE"));
761 DEFINE_bool(keep_files_mapped
, options::TWO_DASHES
, '\0',
763 N_("Map whole files to memory (default on 64-bit hosts)"),
764 N_("Map relevant file parts to memory (default on 32-bit "
767 DEFINE_special(library
, options::TWO_DASHES
, 'l',
768 N_("Search for library LIBNAME"), N_("LIBNAME"));
770 DEFINE_dirlist(library_path
, options::TWO_DASHES
, 'L',
771 N_("Add directory to search path"), N_("DIR"));
773 DEFINE_string(m
, options::EXACTLY_ONE_DASH
, 'm', "",
774 N_("Ignored for compatibility"), N_("EMULATION"));
776 DEFINE_bool(print_map
, options::TWO_DASHES
, 'M', false,
777 N_("Write map file on standard output"), NULL
);
778 DEFINE_string(Map
, options::ONE_DASH
, '\0', NULL
, N_("Write map file"),
781 DEFINE_bool(nmagic
, options::TWO_DASHES
, 'n', false,
782 N_("Do not page align data"), NULL
);
783 DEFINE_bool(omagic
, options::EXACTLY_TWO_DASHES
, 'N', false,
784 N_("Do not page align data, do not make text readonly"),
785 N_("Page align data, make text readonly"));
787 DEFINE_enable(new_dtags
, options::EXACTLY_TWO_DASHES
, '\0', false,
788 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
789 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
791 DEFINE_bool(noinhibit_exec
, options::TWO_DASHES
, '\0', false,
792 N_("Create an output file even if errors occur"), NULL
);
794 DEFINE_bool_alias(no_undefined
, defs
, options::TWO_DASHES
, '\0',
795 N_("Report undefined symbols (even with --shared)"),
798 DEFINE_string(output
, options::TWO_DASHES
, 'o', "a.out",
799 N_("Set output file name"), N_("FILE"));
801 DEFINE_uint(optimize
, options::EXACTLY_ONE_DASH
, 'O', 0,
802 N_("Optimize output file size"), N_("LEVEL"));
804 DEFINE_string(oformat
, options::EXACTLY_TWO_DASHES
, '\0', "elf",
805 N_("Set output format"), N_("[binary]"));
807 DEFINE_bool(pie
, options::ONE_DASH
, '\0', false,
808 N_("Create a position independent executable"), NULL
);
809 DEFINE_bool_alias(pic_executable
, pie
, options::TWO_DASHES
, '\0',
810 N_("Create a position independent executable"), NULL
,
813 #ifdef ENABLE_PLUGINS
814 DEFINE_special(plugin
, options::TWO_DASHES
, '\0',
815 N_("Load a plugin library"), N_("PLUGIN"));
816 DEFINE_special(plugin_opt
, options::TWO_DASHES
, '\0',
817 N_("Pass an option to the plugin"), N_("OPTION"));
820 DEFINE_bool(preread_archive_symbols
, options::TWO_DASHES
, '\0', false,
821 N_("Preread archive symbols when multi-threaded"), NULL
);
823 DEFINE_string(print_symbol_counts
, options::TWO_DASHES
, '\0', NULL
,
824 N_("Print symbols defined and used for each input"),
827 DEFINE_bool(Qy
, options::EXACTLY_ONE_DASH
, '\0', false,
828 N_("Ignored for SVR4 compatibility"), NULL
);
830 DEFINE_bool(emit_relocs
, options::TWO_DASHES
, 'q', false,
831 N_("Generate relocations in output"), NULL
);
833 DEFINE_bool(relocatable
, options::EXACTLY_ONE_DASH
, 'r', false,
834 N_("Generate relocatable output"), NULL
);
836 DEFINE_bool(relax
, options::TWO_DASHES
, '\0', false,
837 N_("Relax branches on certain targets"), NULL
);
839 DEFINE_string(retain_symbols_file
, options::TWO_DASHES
, '\0', NULL
,
840 N_("keep only symbols listed in this file"), N_("FILE"));
842 // -R really means -rpath, but can mean --just-symbols for
843 // compatibility with GNU ld. -rpath is always -rpath, so we list
845 DEFINE_special(R
, options::EXACTLY_ONE_DASH
, 'R',
846 N_("Add DIR to runtime search path"), N_("DIR"));
848 DEFINE_dirlist(rpath
, options::ONE_DASH
, '\0',
849 N_("Add DIR to runtime search path"), N_("DIR"));
851 DEFINE_dirlist(rpath_link
, options::TWO_DASHES
, '\0',
852 N_("Add DIR to link time shared library search path"),
855 DEFINE_special(section_start
, options::TWO_DASHES
, '\0',
856 N_("Set address of section"), N_("SECTION=ADDRESS"));
858 DEFINE_optional_string(sort_common
, options::TWO_DASHES
, '\0', NULL
,
859 N_("Sort common symbols by alignment"),
860 N_("[={ascending,descending}]"));
862 DEFINE_bool(strip_all
, options::TWO_DASHES
, 's', false,
863 N_("Strip all symbols"), NULL
);
864 DEFINE_bool(strip_debug
, options::TWO_DASHES
, 'S', false,
865 N_("Strip debugging information"), NULL
);
866 DEFINE_bool(strip_debug_non_line
, options::TWO_DASHES
, '\0', false,
867 N_("Emit only debug line number information"), NULL
);
868 DEFINE_bool(strip_debug_gdb
, options::TWO_DASHES
, '\0', false,
869 N_("Strip debug symbols that are unused by gdb "
870 "(at least versions <= 6.7)"), NULL
);
871 DEFINE_bool(strip_lto_sections
, options::TWO_DASHES
, '\0', true,
872 N_("Strip LTO intermediate code sections"), NULL
);
874 DEFINE_int(stub_group_size
, options::TWO_DASHES
, '\0', 1,
875 N_("(ARM only) The maximum distance from instructions in a group "
876 "of sections to their stubs. Negative values mean stubs "
877 "are always after the group. 1 means using default size.\n"),
880 DEFINE_bool(no_keep_memory
, options::TWO_DASHES
, '\0', false,
881 N_("Use less memory and more disk I/O "
882 "(included only for compatibility with GNU ld)"), NULL
);
884 DEFINE_bool(shared
, options::ONE_DASH
, 'G', false,
885 N_("Generate shared library"), NULL
);
887 DEFINE_bool(Bshareable
, options::ONE_DASH
, '\0', false,
888 N_("Generate shared library"), NULL
);
890 DEFINE_uint(split_stack_adjust_size
, options::TWO_DASHES
, '\0', 0x4000,
891 N_("Stack size when -fsplit-stack function calls non-split"),
894 // This is not actually special in any way, but I need to give it
895 // a non-standard accessor-function name because 'static' is a keyword.
896 DEFINE_special(static, options::ONE_DASH
, '\0',
897 N_("Do not link against shared libraries"), NULL
);
899 DEFINE_enum(icf
, options::TWO_DASHES
, '\0', "none",
900 N_("Identical Code Folding. "
901 "\'--icf=safe\' folds only ctors and dtors."),
903 {"none", "all", "safe"});
905 DEFINE_uint(icf_iterations
, options::TWO_DASHES
, '\0', 0,
906 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
908 DEFINE_bool(print_icf_sections
, options::TWO_DASHES
, '\0', false,
909 N_("List folded identical sections on stderr"),
910 N_("Do not list folded identical sections"));
912 DEFINE_set(keep_unique
, options::TWO_DASHES
, '\0',
913 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
915 DEFINE_bool(gc_sections
, options::TWO_DASHES
, '\0', false,
916 N_("Remove unused sections"),
917 N_("Don't remove unused sections (default)"));
919 DEFINE_bool(print_gc_sections
, options::TWO_DASHES
, '\0', false,
920 N_("List removed unused sections on stderr"),
921 N_("Do not list removed unused sections"));
923 DEFINE_bool(stats
, options::TWO_DASHES
, '\0', false,
924 N_("Print resource usage statistics"), NULL
);
926 DEFINE_string(sysroot
, options::TWO_DASHES
, '\0', "",
927 N_("Set target system root directory"), N_("DIR"));
929 DEFINE_bool(trace
, options::TWO_DASHES
, 't', false,
930 N_("Print the name of each input file"), NULL
);
932 DEFINE_special(script
, options::TWO_DASHES
, 'T',
933 N_("Read linker script"), N_("FILE"));
935 DEFINE_bool(threads
, options::TWO_DASHES
, '\0', false,
936 N_("Run the linker multi-threaded"),
937 N_("Do not run the linker multi-threaded"));
938 DEFINE_uint(thread_count
, options::TWO_DASHES
, '\0', 0,
939 N_("Number of threads to use"), N_("COUNT"));
940 DEFINE_uint(thread_count_initial
, options::TWO_DASHES
, '\0', 0,
941 N_("Number of threads to use in initial pass"), N_("COUNT"));
942 DEFINE_uint(thread_count_middle
, options::TWO_DASHES
, '\0', 0,
943 N_("Number of threads to use in middle pass"), N_("COUNT"));
944 DEFINE_uint(thread_count_final
, options::TWO_DASHES
, '\0', 0,
945 N_("Number of threads to use in final pass"), N_("COUNT"));
947 DEFINE_uint64(Tbss
, options::ONE_DASH
, '\0', -1U,
948 N_("Set the address of the bss segment"), N_("ADDRESS"));
949 DEFINE_uint64(Tdata
, options::ONE_DASH
, '\0', -1U,
950 N_("Set the address of the data segment"), N_("ADDRESS"));
951 DEFINE_uint64(Ttext
, options::ONE_DASH
, '\0', -1U,
952 N_("Set the address of the text segment"), N_("ADDRESS"));
954 DEFINE_set(undefined
, options::TWO_DASHES
, 'u',
955 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
957 DEFINE_bool(verbose
, options::TWO_DASHES
, '\0', false,
958 N_("Synonym for --debug=files"), NULL
);
960 DEFINE_special(version_script
, options::TWO_DASHES
, '\0',
961 N_("Read version script"), N_("FILE"));
963 DEFINE_bool(warn_common
, options::TWO_DASHES
, '\0', false,
964 N_("Warn about duplicate common symbols"),
965 N_("Do not warn about duplicate common symbols (default)"));
967 DEFINE_bool(warn_constructors
, options::TWO_DASHES
, '\0', false,
968 N_("Ignored"), N_("Ignored"));
970 DEFINE_bool(warn_multiple_gp
, options::TWO_DASHES
, '\0', false,
971 N_("Ignored"), NULL
);
973 DEFINE_bool(warn_search_mismatch
, options::TWO_DASHES
, '\0', true,
974 N_("Warn when skipping an incompatible library"),
975 N_("Don't warn when skipping an incompatible library"));
977 DEFINE_bool(warn_shared_textrel
, options::TWO_DASHES
, '\0', false,
978 N_("Warn if text segment is not shareable"),
979 N_("Do not warn if text segment is not shareable (default)"));
981 DEFINE_bool(warn_unresolved_symbols
, options::TWO_DASHES
, '\0', false,
982 N_("Report unresolved symbols as warnings"),
984 DEFINE_bool_alias(error_unresolved_symbols
, warn_unresolved_symbols
,
985 options::TWO_DASHES
, '\0',
986 N_("Report unresolved symbols as errors"),
989 DEFINE_bool(whole_archive
, options::TWO_DASHES
, '\0', false,
990 N_("Include all archive contents"),
991 N_("Include only needed archive contents"));
993 DEFINE_set(wrap
, options::TWO_DASHES
, '\0',
994 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
996 DEFINE_set(trace_symbol
, options::TWO_DASHES
, 'y',
997 N_("Trace references to symbol"), N_("SYMBOL"));
999 DEFINE_bool(undefined_version
, options::TWO_DASHES
, '\0', true,
1000 N_("Allow unused version in script (default)"),
1001 N_("Do not allow unused version in script"));
1003 DEFINE_string(Y
, options::EXACTLY_ONE_DASH
, 'Y', "",
1004 N_("Default search path for Solaris compatibility"),
1007 DEFINE_special(start_group
, options::TWO_DASHES
, '(',
1008 N_("Start a library search group"), NULL
);
1009 DEFINE_special(end_group
, options::TWO_DASHES
, ')',
1010 N_("End a library search group"), NULL
);
1014 DEFINE_bool(combreloc
, options::DASH_Z
, '\0', true,
1015 N_("Sort dynamic relocs"),
1016 N_("Do not sort dynamic relocs"));
1017 DEFINE_uint64(common_page_size
, options::DASH_Z
, '\0', 0,
1018 N_("Set common page size to SIZE"), N_("SIZE"));
1019 DEFINE_bool(defs
, options::DASH_Z
, '\0', false,
1020 N_("Report undefined symbols (even with --shared)"),
1022 DEFINE_bool(execstack
, options::DASH_Z
, '\0', false,
1023 N_("Mark output as requiring executable stack"), NULL
);
1024 DEFINE_bool(initfirst
, options::DASH_Z
, '\0', false,
1025 N_("Mark DSO to be initialized first at runtime"),
1027 DEFINE_bool(interpose
, options::DASH_Z
, '\0', false,
1028 N_("Mark object to interpose all DSOs but executable"),
1030 DEFINE_bool(lazy
, options::DASH_Z
, '\0', false,
1031 N_("Mark object for lazy runtime binding (default)"),
1033 DEFINE_bool(loadfltr
, options::DASH_Z
, '\0', false,
1034 N_("Mark object requiring immediate process"),
1036 DEFINE_uint64(max_page_size
, options::DASH_Z
, '\0', 0,
1037 N_("Set maximum page size to SIZE"), N_("SIZE"));
1038 DEFINE_bool(muldefs
, options::DASH_Z
, '\0', false,
1039 N_("Allow multiple definitions of symbols"),
1041 // copyreloc is here in the list because there is only -z
1042 // nocopyreloc, not -z copyreloc.
1043 DEFINE_bool(copyreloc
, options::DASH_Z
, '\0', true,
1045 N_("Do not create copy relocs"));
1046 DEFINE_bool(nodefaultlib
, options::DASH_Z
, '\0', false,
1047 N_("Mark object not to use default search paths"),
1049 DEFINE_bool(nodelete
, options::DASH_Z
, '\0', false,
1050 N_("Mark DSO non-deletable at runtime"),
1052 DEFINE_bool(nodlopen
, options::DASH_Z
, '\0', false,
1053 N_("Mark DSO not available to dlopen"),
1055 DEFINE_bool(nodump
, options::DASH_Z
, '\0', false,
1056 N_("Mark DSO not available to dldump"),
1058 DEFINE_bool(noexecstack
, options::DASH_Z
, '\0', false,
1059 N_("Mark output as not requiring executable stack"), NULL
);
1060 DEFINE_bool(now
, options::DASH_Z
, '\0', false,
1061 N_("Mark object for immediate function binding"),
1063 DEFINE_bool(origin
, options::DASH_Z
, '\0', false,
1064 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1065 "processing at runtime"), NULL
);
1066 DEFINE_bool(relro
, options::DASH_Z
, '\0', false,
1067 N_("Where possible mark variables read-only after relocation"),
1068 N_("Don't mark variables read-only after relocation"));
1069 DEFINE_bool(text
, options::DASH_Z
, '\0', false,
1070 N_("Do not permit relocations in read-only segments"),
1072 DEFINE_bool_alias(textoff
, text
, options::DASH_Z
, '\0',
1073 N_("Permit relocations in read-only segments (default)"),
1077 typedef options::Dir_list Dir_list
;
1081 // Does post-processing on flags, making sure they all have
1082 // non-conflicting values. Also converts some flags from their
1083 // "standard" types (string, etc), to another type (enum, DirList),
1084 // which can be accessed via a separate method. Dies if it notices
1088 // True if we printed the version information.
1090 printed_version() const
1091 { return this->printed_version_
; }
1093 // The macro defines output() (based on --output), but that's a
1094 // generic name. Provide this alternative name, which is clearer.
1096 output_file_name() const
1097 { return this->output(); }
1099 // This is not defined via a flag, but combines flags to say whether
1100 // the output is position-independent or not.
1102 output_is_position_independent() const
1103 { return this->shared() || this->pie(); }
1105 // Return true if the output is something that can be exec()ed, such
1106 // as a static executable, or a position-dependent or
1107 // position-independent executable, but not a dynamic library or an
1110 output_is_executable() const
1111 { return !this->shared() && !this->relocatable(); }
1113 // This would normally be static(), and defined automatically, but
1114 // since static is a keyword, we need to come up with our own name.
1119 // In addition to getting the input and output formats as a string
1120 // (via format() and oformat()), we also give access as an enum.
1125 // Straight binary format.
1126 OBJECT_FORMAT_BINARY
1129 // Convert a string to an Object_format. Gives an error if the
1130 // string is not recognized.
1131 static Object_format
1132 string_to_object_format(const char* arg
);
1134 // Note: these functions are not very fast.
1135 Object_format
format_enum() const;
1136 Object_format
oformat_enum() const;
1138 // Return whether FILENAME is in a system directory.
1140 is_in_system_directory(const std::string
& name
) const;
1142 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1144 should_retain_symbol(const char* symbol_name
) const
1146 if (symbols_to_retain_
.empty()) // means flag wasn't specified
1148 return symbols_to_retain_
.find(symbol_name
) != symbols_to_retain_
.end();
1151 // These are the best way to get access to the execstack state,
1152 // not execstack() and noexecstack() which are hard to use properly.
1154 is_execstack_set() const
1155 { return this->execstack_status_
!= EXECSTACK_FROM_INPUT
; }
1158 is_stack_executable() const
1159 { return this->execstack_status_
== EXECSTACK_YES
; }
1163 { return this->icf_status_
!= ICF_NONE
; }
1166 icf_safe_folding() const
1167 { return this->icf_status_
== ICF_SAFE
; }
1169 // The --demangle option takes an optional string, and there is also
1170 // a --no-demangle option. This is the best way to decide whether
1171 // to demangle or not.
1174 { return this->do_demangle_
; }
1176 // Returns TRUE if any plugin libraries have been loaded.
1179 { return this->plugins_
!= NULL
; }
1181 // Return a pointer to the plugin manager.
1184 { return this->plugins_
; }
1186 // True iff SYMBOL was found in the file specified by dynamic-list.
1188 in_dynamic_list(const char* symbol
) const
1189 { return this->dynamic_list_
.version_script_info()->symbol_is_local(symbol
); }
1191 // Finalize the dynamic list.
1193 finalize_dynamic_list()
1194 { this->dynamic_list_
.version_script_info()->finalize(); }
1196 // The disposition given by the --incremental-changed,
1197 // --incremental-unchanged or --incremental-unknown option. The
1198 // value may change as we proceed parsing the command line flags.
1199 Incremental_disposition
1200 incremental_disposition() const
1201 { return this->incremental_disposition_
; }
1203 // Return true if S is the name of a library excluded from automatic
1206 check_excluded_libs (const std::string
&s
) const;
1208 // If an explicit start address was given for section SECNAME with
1209 // the --section-start option, return true and set *PADDR to the
1210 // address. Otherwise return false.
1212 section_start(const char* secname
, uint64_t* paddr
) const;
1215 // Don't copy this structure.
1216 General_options(const General_options
&);
1217 General_options
& operator=(const General_options
&);
1219 // Whether to mark the stack as executable.
1222 // Not set on command line.
1223 EXECSTACK_FROM_INPUT
,
1224 // Mark the stack as executable (-z execstack).
1226 // Mark the stack as not executable (-z noexecstack).
1232 // Do not fold any functions (Default or --icf=none).
1234 // All functions are candidates for folding. (--icf=all).
1236 // Only ctors and dtors are candidates for folding. (--icf=safe).
1241 set_icf_status(Icf_status value
)
1242 { this->icf_status_
= value
; }
1245 set_execstack_status(Execstack value
)
1246 { this->execstack_status_
= value
; }
1249 set_do_demangle(bool value
)
1250 { this->do_demangle_
= value
; }
1253 set_static(bool value
)
1254 { static_
= value
; }
1256 // These are called by finalize() to set up the search-path correctly.
1258 add_to_library_path_with_sysroot(const char* arg
)
1259 { this->add_search_directory_to_library_path(Search_directory(arg
, true)); }
1261 // Apply any sysroot to the directory lists.
1265 // Add a plugin and its arguments to the list of plugins.
1267 add_plugin(const char *filename
);
1269 // Add a plugin option.
1271 add_plugin_option(const char* opt
);
1273 // Whether we printed version information.
1274 bool printed_version_
;
1275 // Whether to mark the stack as executable.
1276 Execstack execstack_status_
;
1277 // Whether to do code folding.
1278 Icf_status icf_status_
;
1279 // Whether to do a static link.
1281 // Whether to do demangling.
1283 // List of plugin libraries.
1284 Plugin_manager
* plugins_
;
1285 // The parsed output of --dynamic-list files. For convenience in
1286 // script.cc, we store this as a Script_options object, even though
1287 // we only use a single Version_tree from it.
1288 Script_options dynamic_list_
;
1289 // The disposition given by the --incremental-changed,
1290 // --incremental-unchanged or --incremental-unknown option. The
1291 // value may change as we proceed parsing the command line flags.
1292 Incremental_disposition incremental_disposition_
;
1293 // Whether we have seen one of the options that require incremental
1294 // build (--incremental-changed, --incremental-unchanged or
1295 // --incremental-unknown)
1296 bool implicit_incremental_
;
1297 // Libraries excluded from automatic export, via --exclude-libs.
1298 Unordered_set
<std::string
> excluded_libs_
;
1299 // List of symbol-names to keep, via -retain-symbol-info.
1300 Unordered_set
<std::string
> symbols_to_retain_
;
1301 // Map from section name to address from --section-start.
1302 std::map
<std::string
, uint64_t> section_starts_
;
1305 // The position-dependent options. We use this to store the state of
1306 // the commandline at a particular point in parsing for later
1307 // reference. For instance, if we see "ld --whole-archive foo.a
1308 // --no-whole-archive," we want to store the whole-archive option with
1309 // foo.a, so when the time comes to parse foo.a we know we should do
1310 // it in whole-archive mode. We could store all of General_options,
1311 // but that's big, so we just pick the subset of flags that actually
1312 // change in a position-dependent way.
1314 #define DEFINE_posdep(varname__, type__) \
1318 { return this->varname__##_; } \
1321 set_##varname__(type__ value) \
1322 { this->varname__##_ = value; } \
1326 class Position_dependent_options
1329 Position_dependent_options(const General_options
& options
1330 = Position_dependent_options::default_options_
)
1331 { copy_from_options(options
); }
1333 void copy_from_options(const General_options
& options
)
1335 this->set_as_needed(options
.as_needed());
1336 this->set_Bdynamic(options
.Bdynamic());
1337 this->set_format_enum(options
.format_enum());
1338 this->set_whole_archive(options
.whole_archive());
1339 this->set_incremental_disposition(options
.incremental_disposition());
1342 DEFINE_posdep(as_needed
, bool);
1343 DEFINE_posdep(Bdynamic
, bool);
1344 DEFINE_posdep(format_enum
, General_options::Object_format
);
1345 DEFINE_posdep(whole_archive
, bool);
1346 DEFINE_posdep(incremental_disposition
, Incremental_disposition
);
1349 // This is a General_options with everything set to its default
1350 // value. A Position_dependent_options created with no argument
1351 // will take its values from here.
1352 static General_options default_options_
;
1356 // A single file or library argument from the command line.
1358 class Input_file_argument
1361 enum Input_file_type
1363 // A regular file, name used as-is, not searched.
1364 INPUT_FILE_TYPE_FILE
,
1365 // A library name. When used, "lib" will be prepended and ".so" or
1366 // ".a" appended to make a filename, and that filename will be searched
1367 // for using the -L paths.
1368 INPUT_FILE_TYPE_LIBRARY
,
1369 // A regular file, name used as-is, but searched using the -L paths.
1370 INPUT_FILE_TYPE_SEARCHED_FILE
1373 // name: file name or library name
1374 // type: the type of this input file.
1375 // extra_search_path: an extra directory to look for the file, prior
1376 // to checking the normal library search path. If this is "",
1377 // then no extra directory is added.
1378 // just_symbols: whether this file only defines symbols.
1379 // options: The position dependent options at this point in the
1380 // command line, such as --whole-archive.
1381 Input_file_argument()
1382 : name_(), type_(INPUT_FILE_TYPE_FILE
), extra_search_path_(""),
1383 just_symbols_(false), options_()
1386 Input_file_argument(const char* name
, Input_file_type type
,
1387 const char* extra_search_path
,
1389 const Position_dependent_options
& options
)
1390 : name_(name
), type_(type
), extra_search_path_(extra_search_path
),
1391 just_symbols_(just_symbols
), options_(options
)
1394 // You can also pass in a General_options instance instead of a
1395 // Position_dependent_options. In that case, we extract the
1396 // position-independent vars from the General_options and only store
1398 Input_file_argument(const char* name
, Input_file_type type
,
1399 const char* extra_search_path
,
1401 const General_options
& options
)
1402 : name_(name
), type_(type
), extra_search_path_(extra_search_path
),
1403 just_symbols_(just_symbols
), options_(options
)
1408 { return this->name_
.c_str(); }
1410 const Position_dependent_options
&
1412 { return this->options_
; }
1416 { return type_
== INPUT_FILE_TYPE_LIBRARY
; }
1419 is_searched_file() const
1420 { return type_
== INPUT_FILE_TYPE_SEARCHED_FILE
; }
1423 extra_search_path() const
1425 return (this->extra_search_path_
.empty()
1427 : this->extra_search_path_
.c_str());
1430 // Return whether we should only read symbols from this file.
1432 just_symbols() const
1433 { return this->just_symbols_
; }
1435 // Return whether this file may require a search using the -L
1438 may_need_search() const
1440 return (this->is_lib()
1441 || this->is_searched_file()
1442 || !this->extra_search_path_
.empty());
1446 // We use std::string, not const char*, here for convenience when
1447 // using script files, so that we do not have to preserve the string
1450 Input_file_type type_
;
1451 std::string extra_search_path_
;
1453 Position_dependent_options options_
;
1456 // A file or library, or a group, from the command line.
1458 class Input_argument
1461 // Create a file or library argument.
1462 explicit Input_argument(Input_file_argument file
)
1463 : is_file_(true), file_(file
), group_(NULL
)
1466 // Create a group argument.
1467 explicit Input_argument(Input_file_group
* group
)
1468 : is_file_(false), group_(group
)
1471 // Return whether this is a file.
1474 { return this->is_file_
; }
1476 // Return whether this is a group.
1479 { return !this->is_file_
; }
1481 // Return the information about the file.
1482 const Input_file_argument
&
1485 gold_assert(this->is_file_
);
1489 // Return the information about the group.
1490 const Input_file_group
*
1493 gold_assert(!this->is_file_
);
1494 return this->group_
;
1500 gold_assert(!this->is_file_
);
1501 return this->group_
;
1506 Input_file_argument file_
;
1507 Input_file_group
* group_
;
1510 typedef std::vector
<Input_argument
> Input_argument_list
;
1512 // A group from the command line. This is a set of arguments within
1513 // --start-group ... --end-group.
1515 class Input_file_group
1518 typedef Input_argument_list::const_iterator const_iterator
;
1524 // Add a file to the end of the group.
1526 add_file(const Input_file_argument
& arg
)
1527 { this->files_
.push_back(Input_argument(arg
)); }
1529 // Iterators to iterate over the group contents.
1533 { return this->files_
.begin(); }
1537 { return this->files_
.end(); }
1540 Input_argument_list files_
;
1543 // A list of files from the command line or a script.
1545 class Input_arguments
1548 typedef Input_argument_list::const_iterator const_iterator
;
1551 : input_argument_list_(), in_group_(false)
1556 add_file(const Input_file_argument
& arg
);
1558 // Start a group (the --start-group option).
1562 // End a group (the --end-group option).
1566 // Return whether we are currently in a group.
1569 { return this->in_group_
; }
1571 // The number of entries in the list.
1574 { return this->input_argument_list_
.size(); }
1576 // Iterators to iterate over the list of input files.
1580 { return this->input_argument_list_
.begin(); }
1584 { return this->input_argument_list_
.end(); }
1586 // Return whether the list is empty.
1589 { return this->input_argument_list_
.empty(); }
1592 Input_argument_list input_argument_list_
;
1597 // All the information read from the command line. These are held in
1598 // three separate structs: one to hold the options (--foo), one to
1599 // hold the filenames listed on the commandline, and one to hold
1600 // linker script information. This third is not a subset of the other
1601 // two because linker scripts can be specified either as options (via
1602 // -T) or as a file.
1607 typedef Input_arguments::const_iterator const_iterator
;
1611 // Process the command line options. This will exit with an
1612 // appropriate error message if an unrecognized option is seen.
1614 process(int argc
, const char** argv
);
1616 // Process one command-line option. This takes the index of argv to
1617 // process, and returns the index for the next option. no_more_options
1618 // is set to true if argv[i] is "--".
1620 process_one_option(int argc
, const char** argv
, int i
,
1621 bool* no_more_options
);
1623 // Get the general options.
1624 const General_options
&
1626 { return this->options_
; }
1628 // Get the position dependent options.
1629 const Position_dependent_options
&
1630 position_dependent_options() const
1631 { return this->position_options_
; }
1633 // Get the linker-script options.
1636 { return this->script_options_
; }
1638 // Finalize the version-script options and return them.
1639 const Version_script_info
&
1642 // Get the input files.
1645 { return this->inputs_
; }
1647 // The number of input files.
1649 number_of_input_files() const
1650 { return this->inputs_
.size(); }
1652 // Iterators to iterate over the list of input files.
1656 { return this->inputs_
.begin(); }
1660 { return this->inputs_
.end(); }
1663 Command_line(const Command_line
&);
1664 Command_line
& operator=(const Command_line
&);
1666 // This is a dummy class to provide a constructor that runs before
1667 // the constructor for the General_options. The Pre_options constructor
1668 // is used as a hook to set the flag enabling the options to register
1670 struct Pre_options
{
1674 // This must come before options_!
1675 Pre_options pre_options_
;
1676 General_options options_
;
1677 Position_dependent_options position_options_
;
1678 Script_options script_options_
;
1679 Input_arguments inputs_
;
1682 } // End namespace gold.
1684 #endif // !defined(GOLD_OPTIONS_H)