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.
247 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
248 default_value_as_string__, helpstring__, helparg__, \
249 optional_arg__, type__, param_type__, parse_fn__) \
253 { return this->varname__##_.value; } \
256 user_set_##varname__() const \
257 { return this->varname__##_.user_set_via_option; } \
260 set_user_set_##varname__() \
261 { this->varname__##_.user_set_via_option = true; } \
264 struct Struct_##varname__ : public options::Struct_var \
266 Struct_##varname__() \
267 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
268 helpstring__, helparg__, optional_arg__, this), \
269 user_set_via_option(false), value(default_value__) \
273 parse_to_value(const char* option_name, const char* arg, \
274 Command_line*, General_options*) \
276 parse_fn__(option_name, arg, &this->value); \
277 this->user_set_via_option = true; \
280 options::One_option option; \
281 bool user_set_via_option; \
284 Struct_##varname__ varname__##_; \
286 set_##varname__(param_type__ value) \
287 { this->varname__##_.value = value; }
289 // These macros allow for easy addition of a new commandline option.
291 // If no_helpstring__ is not NULL, then in addition to creating
292 // VARNAME, we also create an option called no-VARNAME (or, for a -z
293 // option, noVARNAME).
294 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
295 helpstring__, no_helpstring__) \
296 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
297 default_value__ ? "true" : "false", helpstring__, NULL, \
298 false, bool, bool, options::parse_bool) \
299 struct Struct_no_##varname__ : public options::Struct_var \
301 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
303 : "no-" #varname__), \
305 default_value__ ? "false" : "true", \
306 no_helpstring__, NULL, false, this) \
310 parse_to_value(const char*, const char*, \
311 Command_line*, General_options* options) \
312 { options->set_##varname__(false); } \
314 options::One_option option; \
316 Struct_no_##varname__ no_##varname__##_initializer_
318 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
319 helpstring__, no_helpstring__) \
320 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
321 default_value__ ? "true" : "false", helpstring__, NULL, \
322 false, bool, bool, options::parse_bool) \
323 struct Struct_disable_##varname__ : public options::Struct_var \
325 Struct_disable_##varname__() : option("disable-" #varname__, \
327 default_value__ ? "false" : "true", \
328 no_helpstring__, NULL, false, this) \
332 parse_to_value(const char*, const char*, \
333 Command_line*, General_options* options) \
334 { options->set_enable_##varname__(false); } \
336 options::One_option option; \
338 Struct_disable_##varname__ disable_##varname__##_initializer_
340 #define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
341 helpstring__, helparg__) \
342 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
343 #default_value__, helpstring__, helparg__, false, \
344 int, int, options::parse_int)
346 #define DEFINE_uint(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_uint)
352 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
353 helpstring__, helparg__) \
354 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
355 #default_value__, helpstring__, helparg__, false, \
356 uint64_t, uint64_t, options::parse_uint64)
358 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
359 helpstring__, helparg__) \
360 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
361 #default_value__, helpstring__, helparg__, false, \
362 double, double, options::parse_double)
364 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
365 helpstring__, helparg__) \
366 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
367 default_value__, helpstring__, helparg__, false, \
368 const char*, const char*, options::parse_string)
370 // This is like DEFINE_string, but we convert each occurrence to a
371 // Search_directory and store it in a vector. Thus we also have the
372 // add_to_VARNAME() method, to append to the vector.
373 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
374 helpstring__, helparg__) \
375 DEFINE_var(varname__, dashes__, shortname__, , \
376 "", helpstring__, helparg__, false, options::Dir_list, \
377 const options::Dir_list&, options::parse_dirlist) \
379 add_to_##varname__(const char* new_value) \
380 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
382 add_search_directory_to_##varname__(const Search_directory& dir) \
383 { this->varname__##_.value.push_back(dir); }
385 // This is like DEFINE_string, but we store a set of strings.
386 #define DEFINE_set(varname__, dashes__, shortname__, \
387 helpstring__, helparg__) \
388 DEFINE_var(varname__, dashes__, shortname__, , \
389 "", helpstring__, helparg__, false, options::String_set, \
390 const options::String_set&, options::parse_set) \
393 any_##varname__() const \
394 { return !this->varname__##_.value.empty(); } \
397 is_##varname__(const char* symbol) const \
399 return (!this->varname__##_.value.empty() \
400 && (this->varname__##_.value.find(std::string(symbol)) \
401 != this->varname__##_.value.end())); \
404 options::String_set::const_iterator \
405 varname__##_begin() const \
406 { return this->varname__##_.value.begin(); } \
408 options::String_set::const_iterator \
409 varname__##_end() const \
410 { return this->varname__##_.value.end(); }
412 // When you have a list of possible values (expressed as string)
413 // After helparg__ should come an initializer list, like
414 // {"foo", "bar", "baz"}
415 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
416 helpstring__, helparg__, ...) \
417 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
418 default_value__, helpstring__, helparg__, false, \
419 const char*, const char*, parse_choices_##varname__) \
421 static void parse_choices_##varname__(const char* option_name, \
423 const char** retval) { \
424 const char* choices[] = __VA_ARGS__; \
425 options::parse_choices(option_name, arg, retval, \
426 choices, sizeof(choices) / sizeof(*choices)); \
429 // This is like DEFINE_bool, but VARNAME is the name of a different
430 // option. This option becomes an alias for that one. INVERT is true
431 // if this option is an inversion of the other one.
432 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
433 helpstring__, no_helpstring__, invert__) \
435 struct Struct_##option__ : public options::Struct_var \
437 Struct_##option__() \
438 : option(#option__, dashes__, shortname__, "", helpstring__, \
443 parse_to_value(const char*, const char*, \
444 Command_line*, General_options* options) \
446 options->set_##varname__(!invert__); \
447 options->set_user_set_##varname__(); \
450 options::One_option option; \
452 Struct_##option__ option__##_; \
454 struct Struct_no_##option__ : public options::Struct_var \
456 Struct_no_##option__() \
457 : option((dashes__ == options::DASH_Z \
459 : "no-" #option__), \
460 dashes__, '\0', "", no_helpstring__, \
465 parse_to_value(const char*, const char*, \
466 Command_line*, General_options* options) \
468 options->set_##varname__(invert__); \
469 options->set_user_set_##varname__(); \
472 options::One_option option; \
474 Struct_no_##option__ no_##option__##_initializer_
476 // This is used for non-standard flags. It defines no functions; it
477 // just calls General_options::parse_VARNAME whenever the flag is
478 // seen. We declare parse_VARNAME as a static member of
479 // General_options; you are responsible for defining it there.
480 // helparg__ should be NULL iff this special-option is a boolean.
481 #define DEFINE_special(varname__, dashes__, shortname__, \
482 helpstring__, helparg__) \
484 void parse_##varname__(const char* option, const char* arg, \
485 Command_line* inputs); \
486 struct Struct_##varname__ : public options::Struct_special \
488 Struct_##varname__() \
489 : options::Struct_special(#varname__, dashes__, shortname__, \
490 &General_options::parse_##varname__, \
491 helpstring__, helparg__) \
494 Struct_##varname__ varname__##_initializer_
496 // An option that takes an optional string argument. If the option is
497 // used with no argument, the value will be the default, and
498 // user_set_via_option will be true.
499 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
501 helpstring__, helparg__) \
502 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
503 default_value__, helpstring__, helparg__, true, \
504 const char*, const char*, options::parse_optional_string)
506 // A directory to search. For each directory we record whether it is
507 // in the sysroot. We need to know this so that, if a linker script
508 // is found within the sysroot, we will apply the sysroot to any files
509 // named by that script.
511 class Search_directory
514 // We need a default constructor because we put this in a
517 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
520 // This is the usual constructor.
521 Search_directory(const char* name, bool put_in_sysroot)
522 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
524 if (this->name_.empty())
528 // This is called if we have a sysroot. The sysroot is prefixed to
529 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
530 // set to true for any enries which are in the sysroot (this will
531 // naturally include any entries for which put_in_sysroot_ is true).
532 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
533 // passing SYSROOT to lrealpath.
535 add_sysroot(const char* sysroot, const char* canonical_sysroot);
537 // Get the directory name.
540 { return this->name_; }
542 // Return whether this directory is in the sysroot.
544 is_in_sysroot() const
545 { return this->is_in_sysroot_; }
547 // Return whether this is considered a system directory.
549 is_system_directory() const
550 { return this->put_in_sysroot_ || this->is_in_sysroot_; }
553 // The directory name.
555 // True if the sysroot should be added as a prefix for this
556 // directory (if there is a sysroot). This is true for system
557 // directories that we search by default.
558 bool put_in_sysroot_;
559 // True if this directory is in the sysroot (if there is a sysroot).
560 // This is true if there is a sysroot and either 1) put_in_sysroot_
561 // is true, or 2) the directory happens to be in the sysroot based
562 // on a pathname comparison.
566 class General_options
569 // NOTE: For every option that you add here, also consider if you
570 // should add it to Position_dependent_options.
571 DEFINE_special(help, options::TWO_DASHES, '\0',
572 N_("Report usage information"), NULL);
573 DEFINE_special(version, options::TWO_DASHES, 'v',
574 N_("Report version information"), NULL);
575 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
576 N_("Report version and target information"), NULL);
578 // These options are sorted approximately so that for each letter in
579 // the alphabet, we show the option whose shortname is that letter
580 // (if any) and then every longname that starts with that letter (in
581 // alphabetical order). For both, lowercase sorts before uppercase.
582 // The -z options come last.
584 DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
586 N_("Do not copy DT_NEEDED tags from shared libraries"));
588 DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
589 '\0', N_("Allow multiple definitions of symbols"),
590 N_("Do not allow multiple definitions"), false);
592 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
593 N_("Allow unresolved references in shared libraries"),
594 N_("Do not allow unresolved references in shared libraries"));
596 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
597 N_("Only set DT_NEEDED for shared libraries if used"),
598 N_("Always DT_NEEDED for shared libraries"));
600 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
601 N_("Ignored"), N_("[ignored]"),
602 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
604 // This should really be an "enum", but it's too easy for folks to
605 // forget to update the list as they add new targets. So we just
606 // accept any string. We'll fail later (when the string is parsed),
607 // if the target isn't actually supported.
608 DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
609 N_("Set input format"), ("[elf,binary]"));
611 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
612 N_("-l searches for shared libraries"), NULL);
613 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
614 N_("-l does not search for shared libraries"), NULL,
617 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
618 N_("Bind defined symbols locally"), NULL);
620 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
621 N_("Bind defined function symbols locally"), NULL);
623 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
624 N_("Generate build ID note"),
627 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
628 N_("Check segment addresses for overlaps (default)"),
629 N_("Do not check segment addresses for overlaps"));
632 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
633 N_("Compress .debug_* sections in the output file"),
637 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
638 N_("Compress .debug_* sections in the output file"),
643 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
645 N_("Do not copy DT_NEEDED tags from shared libraries"));
647 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
648 N_("Output cross reference table"),
649 N_("Do not output cross reference table"));
651 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
652 N_("Define common symbols"),
653 N_("Do not define common symbols"));
654 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
655 N_("Alias for -d"), NULL);
656 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
657 N_("Alias for -d"), NULL);
659 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
660 N_("Turn on debugging"),
661 N_("[all,files,script,task][,...]"));
663 DEFINE_special(defsym, options::TWO_DASHES, '\0',
664 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
666 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
667 N_("Demangle C++ symbols in log messages"),
670 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
671 N_("Do not demangle C++ symbols in log messages"),
674 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
675 N_("Try to detect violations of the One Definition Rule"),
678 DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
679 N_("Delete all local symbols"), NULL);
680 DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
681 N_("Delete all temporary local symbols"), NULL);
683 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
684 N_("Add data symbols to dynamic symbols"), NULL);
686 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
687 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
689 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
690 N_("Add C++ typeinfo to dynamic symbols"), NULL);
692 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
693 N_("Read a list of dynamic symbols"), N_("FILE"));
695 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
696 N_("Set program start address"), N_("ADDRESS"));
698 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
699 N_("Exclude libraries from automatic export"),
700 N_(("lib,lib ...")));
702 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
703 N_("Export all dynamic symbols"),
704 N_("Do not export all dynamic symbols (default)"));
706 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
707 N_("Create exception frame header"), NULL);
709 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
710 N_("Treat warnings as errors"),
711 N_("Do not treat warnings as errors"));
713 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
714 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
716 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
717 N_("Ignored"), NULL);
719 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
720 N_("Set shared library name"), N_("FILENAME"));
722 DEFINE_bool(i, options::EXACTLY_ONE_DASH, '\0', false,
723 N_("Ignored"), NULL);
725 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
726 N_("Min fraction of empty buckets in dynamic hash"),
729 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
730 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
731 {"sysv", "gnu", "both"});
733 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
734 N_("Set dynamic linker path"), N_("PROGRAM"));
736 DEFINE_bool(incremental, options::TWO_DASHES, '\0', false,
737 N_("Work in progress; do not use"),
738 N_("Do a full build"));
740 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
741 N_("Assume files changed"), NULL);
743 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
744 N_("Assume files didn't change"), NULL);
746 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
747 N_("Use timestamps to check files (default)"), NULL);
749 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
750 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
752 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
753 N_("Read only symbol values from FILE"), N_("FILE"));
755 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0',
757 N_("Map whole files to memory (default on 64-bit hosts)"),
758 N_("Map relevant file parts to memory (default on 32-bit "
761 DEFINE_special(library, options::TWO_DASHES, 'l',
762 N_("Search for library LIBNAME"), N_("LIBNAME"));
764 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
765 N_("Add directory to search path"), N_("DIR"));
767 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
768 N_("Ignored for compatibility"), N_("EMULATION"));
770 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
771 N_("Write map file on standard output"), NULL);
772 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
775 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
776 N_("Do not page align data"), NULL);
777 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
778 N_("Do not page align data, do not make text readonly"),
779 N_("Page align data, make text readonly"));
781 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
782 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
783 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
785 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
786 N_("Create an output file even if errors occur"), NULL);
788 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
789 N_("Report undefined symbols (even with --shared)"),
792 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
793 N_("Set output file name"), N_("FILE"));
795 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
796 N_("Optimize output file size"), N_("LEVEL"));
798 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
799 N_("Set output format"), N_("[binary]"));
801 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
802 N_("Create a position independent executable"), NULL);
803 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
804 N_("Create a position independent executable"), NULL,
807 #ifdef ENABLE_PLUGINS
808 DEFINE_special(plugin, options::TWO_DASHES, '\0',
809 N_("Load a plugin library"), N_("PLUGIN"));
810 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
811 N_("Pass an option to the plugin"), N_("OPTION"));
814 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
815 N_("Preread archive symbols when multi-threaded"), NULL);
817 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
818 N_("Print symbols defined and used for each input"),
821 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
822 N_("Ignored for SVR4 compatibility"), NULL);
824 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
825 N_("Generate relocations in output"), NULL);
827 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
828 N_("Generate relocatable output"), NULL);
830 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
831 N_("Relax branches on certain targets"), NULL);
833 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
834 N_("keep only symbols listed in this file"), N_("FILE"));
836 // -R really means -rpath, but can mean --just-symbols for
837 // compatibility with GNU ld. -rpath is always -rpath, so we list
839 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
840 N_("Add DIR to runtime search path"), N_("DIR"));
842 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
843 N_("Add DIR to runtime search path"), N_("DIR"));
845 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
846 N_("Add DIR to link time shared library search path"),
849 DEFINE_special(section_start, options::TWO_DASHES, '\0',
850 N_("Set address of section"), N_("SECTION=ADDRESS"));
852 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
853 N_("Sort common symbols by alignment"),
854 N_("[={ascending,descending}]"));
856 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
857 N_("Strip all symbols"), NULL);
858 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
859 N_("Strip debugging information"), NULL);
860 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
861 N_("Emit only debug line number information"), NULL);
862 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
863 N_("Strip debug symbols that are unused by gdb "
864 "(at least versions <= 6.7)"), NULL);
865 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
866 N_("Strip LTO intermediate code sections"), NULL);
868 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
869 N_("(ARM only) The maximum distance from instructions in a group "
870 "of sections to their stubs. Negative values mean stubs "
871 "are always after the group. 1 means using default size.\n"),
874 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
875 N_("Use less memory and more disk I/O "
876 "(included only for compatibility with GNU ld)"), NULL);
878 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
879 N_("Generate shared library"), NULL);
881 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
882 N_("Generate shared library"), NULL);
884 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
885 N_("Stack size when -fsplit-stack function calls non-split"),
888 // This is not actually special in any way, but I need to give it
889 // a non-standard accessor-function name because 'static' is a keyword.
890 DEFINE_special(static, options::ONE_DASH, '\0',
891 N_("Do not link against shared libraries"), NULL);
893 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
894 N_("Identical Code Folding. "
895 "\'--icf=safe\' folds only ctors and dtors."),
897 {"none", "all", "safe"});
899 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
900 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
902 DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
903 N_("List folded identical sections on stderr"),
904 N_("Do not list folded identical sections"));
906 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
907 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
909 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
910 N_("Remove unused sections"),
911 N_("Don't remove unused sections (default)"));
913 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
914 N_("List removed unused sections on stderr"),
915 N_("Do not list removed unused sections"));
917 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
918 N_("Print resource usage statistics"), NULL);
920 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
921 N_("Set target system root directory"), N_("DIR"));
923 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
924 N_("Print the name of each input file"), NULL);
926 DEFINE_special(script, options::TWO_DASHES, 'T',
927 N_("Read linker script"), N_("FILE"));
929 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
930 N_("Run the linker multi-threaded"),
931 N_("Do not run the linker multi-threaded"));
932 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
933 N_("Number of threads to use"), N_("COUNT"));
934 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
935 N_("Number of threads to use in initial pass"), N_("COUNT"));
936 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
937 N_("Number of threads to use in middle pass"), N_("COUNT"));
938 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
939 N_("Number of threads to use in final pass"), N_("COUNT"));
941 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
942 N_("Set the address of the bss segment"), N_("ADDRESS"));
943 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
944 N_("Set the address of the data segment"), N_("ADDRESS"));
945 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
946 N_("Set the address of the text segment"), N_("ADDRESS"));
948 DEFINE_set(undefined, options::TWO_DASHES, 'u',
949 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
951 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
952 N_("Synonym for --debug=files"), NULL);
954 DEFINE_special(version_script, options::TWO_DASHES, '\0',
955 N_("Read version script"), N_("FILE"));
957 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
958 N_("Warn about duplicate common symbols"),
959 N_("Do not warn about duplicate common symbols (default)"));
961 DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
962 N_("Ignored"), N_("Ignored"));
964 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
965 N_("Ignored"), NULL);
967 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
968 N_("Warn when skipping an incompatible library"),
969 N_("Don't warn when skipping an incompatible library"));
971 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
972 N_("Include all archive contents"),
973 N_("Include only needed archive contents"));
975 DEFINE_set(wrap, options::TWO_DASHES, '\0',
976 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
978 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
979 N_("Trace references to symbol"), N_("SYMBOL"));
981 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
982 N_("Allow unused version in script (default)"),
983 N_("Do not allow unused version in script"));
985 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
986 N_("Default search path for Solaris compatibility"),
989 DEFINE_special(start_group, options::TWO_DASHES, '(',
990 N_("Start a library search group"), NULL);
991 DEFINE_special(end_group, options::TWO_DASHES, ')',
992 N_("End a library search group"), NULL);
996 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
997 N_("Sort dynamic relocs"),
998 N_("Do not sort dynamic relocs"));
999 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1000 N_("Set common page size to SIZE"), N_("SIZE"));
1001 DEFINE_bool(defs, options::DASH_Z, '\0', false,
1002 N_("Report undefined symbols (even with --shared)"),
1004 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1005 N_("Mark output as requiring executable stack"), NULL);
1006 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1007 N_("Mark DSO to be initialized first at runtime"),
1009 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1010 N_("Mark object to interpose all DSOs but executable"),
1012 DEFINE_bool(lazy, options::DASH_Z, '\0', false,
1013 N_("Mark object for lazy runtime binding (default)"),
1015 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1016 N_("Mark object requiring immediate process"),
1018 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1019 N_("Set maximum page size to SIZE"), N_("SIZE"));
1020 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1021 N_("Allow multiple definitions of symbols"),
1023 // copyreloc is here in the list because there is only -z
1024 // nocopyreloc, not -z copyreloc.
1025 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1027 N_("Do not create copy relocs"));
1028 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1029 N_("Mark object not to use default search paths"),
1031 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1032 N_("Mark DSO non-deletable at runtime"),
1034 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1035 N_("Mark DSO not available to dlopen"),
1037 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1038 N_("Mark DSO not available to dldump"),
1040 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1041 N_("Mark output as not requiring executable stack"), NULL);
1042 DEFINE_bool(now, options::DASH_Z, '\0', false,
1043 N_("Mark object for immediate function binding"),
1045 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1046 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1047 "processing at runtime"), NULL);
1048 DEFINE_bool(relro, options::DASH_Z, '\0', false,
1049 N_("Where possible mark variables read-only after relocation"),
1050 N_("Don't mark variables read-only after relocation"));
1053 typedef options::Dir_list Dir_list;
1057 // Does post-processing on flags, making sure they all have
1058 // non-conflicting values. Also converts some flags from their
1059 // "standard" types (string, etc), to another type (enum, DirList),
1060 // which can be accessed via a separate method. Dies if it notices
1064 // True if we printed the version information.
1066 printed_version() const
1067 { return this->printed_version_; }
1069 // The macro defines output() (based on --output), but that's a
1070 // generic name. Provide this alternative name, which is clearer.
1072 output_file_name() const
1073 { return this->output(); }
1075 // This is not defined via a flag, but combines flags to say whether
1076 // the output is position-independent or not.
1078 output_is_position_independent() const
1079 { return this->shared() || this->pie(); }
1081 // Return true if the output is something that can be exec()ed, such
1082 // as a static executable, or a position-dependent or
1083 // position-independent executable, but not a dynamic library or an
1086 output_is_executable() const
1087 { return !this->shared() && !this->relocatable(); }
1089 // This would normally be static(), and defined automatically, but
1090 // since static is a keyword, we need to come up with our own name.
1095 // In addition to getting the input and output formats as a string
1096 // (via format() and oformat()), we also give access as an enum.
1101 // Straight binary format.
1102 OBJECT_FORMAT_BINARY
1105 // Convert a string to an Object_format. Gives an error if the
1106 // string is not recognized.
1107 static Object_format
1108 string_to_object_format(const char* arg);
1110 // Note: these functions are not very fast.
1111 Object_format format_enum() const;
1112 Object_format oformat_enum() const;
1114 // Return whether FILENAME is in a system directory.
1116 is_in_system_directory(const std::string& name) const;
1118 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1120 should_retain_symbol(const char* symbol_name) const
1122 if (symbols_to_retain_.empty()) // means flag wasn't specified
1124 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1127 // These are the best way to get access to the execstack state,
1128 // not execstack() and noexecstack() which are hard to use properly.
1130 is_execstack_set() const
1131 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1134 is_stack_executable() const
1135 { return this->execstack_status_ == EXECSTACK_YES; }
1139 { return this->icf_status_ != ICF_NONE; }
1142 icf_safe_folding() const
1143 { return this->icf_status_ == ICF_SAFE; }
1145 // The --demangle option takes an optional string, and there is also
1146 // a --no-demangle option. This is the best way to decide whether
1147 // to demangle or not.
1150 { return this->do_demangle_; }
1152 // Returns TRUE if any plugin libraries have been loaded.
1155 { return this->plugins_ != NULL; }
1157 // Return a pointer to the plugin manager.
1160 { return this->plugins_; }
1162 // True iff SYMBOL was found in the file specified by dynamic-list.
1164 in_dynamic_list(const char* symbol) const
1165 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1167 // Finalize the dynamic list.
1169 finalize_dynamic_list()
1170 { this->dynamic_list_.version_script_info()->finalize(); }
1172 // The disposition given by the --incremental-changed,
1173 // --incremental-unchanged or --incremental-unknown option. The
1174 // value may change as we proceed parsing the command line flags.
1175 Incremental_disposition
1176 incremental_disposition() const
1177 { return this->incremental_disposition_; }
1179 // Return true if S is the name of a library excluded from automatic
1182 check_excluded_libs (const std::string &s) const;
1184 // If an explicit start address was given for section SECNAME with
1185 // the --section-start option, return true and set *PADDR to the
1186 // address. Otherwise return false.
1188 section_start(const char* secname, uint64_t* paddr) const;
1191 // Don't copy this structure.
1192 General_options(const General_options&);
1193 General_options& operator=(const General_options&);
1195 // Whether to mark the stack as executable.
1198 // Not set on command line.
1199 EXECSTACK_FROM_INPUT,
1200 // Mark the stack as executable (-z execstack).
1202 // Mark the stack as not executable (-z noexecstack).
1208 // Do not fold any functions (Default or --icf=none).
1210 // All functions are candidates for folding. (--icf=all).
1212 // Only ctors and dtors are candidates for folding. (--icf=safe).
1217 set_icf_status(Icf_status value)
1218 { this->icf_status_ = value; }
1221 set_execstack_status(Execstack value)
1222 { this->execstack_status_ = value; }
1225 set_do_demangle(bool value)
1226 { this->do_demangle_ = value; }
1229 set_static(bool value)
1230 { static_ = value; }
1232 // These are called by finalize() to set up the search-path correctly.
1234 add_to_library_path_with_sysroot(const char* arg)
1235 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1237 // Apply any sysroot to the directory lists.
1241 // Add a plugin and its arguments to the list of plugins.
1243 add_plugin(const char *filename);
1245 // Add a plugin option.
1247 add_plugin_option(const char* opt);
1249 // Whether we printed version information.
1250 bool printed_version_;
1251 // Whether to mark the stack as executable.
1252 Execstack execstack_status_;
1253 // Whether to do code folding.
1254 Icf_status icf_status_;
1255 // Whether to do a static link.
1257 // Whether to do demangling.
1259 // List of plugin libraries.
1260 Plugin_manager* plugins_;
1261 // The parsed output of --dynamic-list files. For convenience in
1262 // script.cc, we store this as a Script_options object, even though
1263 // we only use a single Version_tree from it.
1264 Script_options dynamic_list_;
1265 // The disposition given by the --incremental-changed,
1266 // --incremental-unchanged or --incremental-unknown option. The
1267 // value may change as we proceed parsing the command line flags.
1268 Incremental_disposition incremental_disposition_;
1269 // Whether we have seen one of the options that require incremental
1270 // build (--incremental-changed, --incremental-unchanged or
1271 // --incremental-unknown)
1272 bool implicit_incremental_;
1273 // Libraries excluded from automatic export, via --exclude-libs.
1274 Unordered_set<std::string> excluded_libs_;
1275 // List of symbol-names to keep, via -retain-symbol-info.
1276 Unordered_set<std::string> symbols_to_retain_;
1277 // Map from section name to address from --section-start.
1278 std::map<std::string, uint64_t> section_starts_;
1281 // The position-dependent options. We use this to store the state of
1282 // the commandline at a particular point in parsing for later
1283 // reference. For instance, if we see "ld --whole-archive foo.a
1284 // --no-whole-archive," we want to store the whole-archive option with
1285 // foo.a, so when the time comes to parse foo.a we know we should do
1286 // it in whole-archive mode. We could store all of General_options,
1287 // but that's big, so we just pick the subset of flags that actually
1288 // change in a position-dependent way.
1290 #define DEFINE_posdep(varname__, type__) \
1294 { return this->varname__##_; } \
1297 set_##varname__(type__ value) \
1298 { this->varname__##_ = value; } \
1302 class Position_dependent_options
1305 Position_dependent_options(const General_options& options
1306 = Position_dependent_options::default_options_)
1307 { copy_from_options(options); }
1309 void copy_from_options(const General_options& options)
1311 this->set_as_needed(options.as_needed());
1312 this->set_Bdynamic(options.Bdynamic());
1313 this->set_format_enum(options.format_enum());
1314 this->set_whole_archive(options.whole_archive());
1315 this->set_incremental_disposition(options.incremental_disposition());
1318 DEFINE_posdep(as_needed, bool);
1319 DEFINE_posdep(Bdynamic, bool);
1320 DEFINE_posdep(format_enum, General_options::Object_format);
1321 DEFINE_posdep(whole_archive, bool);
1322 DEFINE_posdep(incremental_disposition, Incremental_disposition);
1325 // This is a General_options with everything set to its default
1326 // value. A Position_dependent_options created with no argument
1327 // will take its values from here.
1328 static General_options default_options_;
1332 // A single file or library argument from the command line.
1334 class Input_file_argument
1337 enum Input_file_type
1339 // A regular file, name used as-is, not searched.
1340 INPUT_FILE_TYPE_FILE,
1341 // A library name. When used, "lib" will be prepended and ".so" or
1342 // ".a" appended to make a filename, and that filename will be searched
1343 // for using the -L paths.
1344 INPUT_FILE_TYPE_LIBRARY,
1345 // A regular file, name used as-is, but searched using the -L paths.
1346 INPUT_FILE_TYPE_SEARCHED_FILE
1349 // name: file name or library name
1350 // type: the type of this input file.
1351 // extra_search_path: an extra directory to look for the file, prior
1352 // to checking the normal library search path. If this is "",
1353 // then no extra directory is added.
1354 // just_symbols: whether this file only defines symbols.
1355 // options: The position dependent options at this point in the
1356 // command line, such as --whole-archive.
1357 Input_file_argument()
1358 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1359 just_symbols_(false), options_()
1362 Input_file_argument(const char* name, Input_file_type type,
1363 const char* extra_search_path,
1365 const Position_dependent_options& options)
1366 : name_(name), type_(type), extra_search_path_(extra_search_path),
1367 just_symbols_(just_symbols), options_(options)
1370 // You can also pass in a General_options instance instead of a
1371 // Position_dependent_options. In that case, we extract the
1372 // position-independent vars from the General_options and only store
1374 Input_file_argument(const char* name, Input_file_type type,
1375 const char* extra_search_path,
1377 const General_options& options)
1378 : name_(name), type_(type), extra_search_path_(extra_search_path),
1379 just_symbols_(just_symbols), options_(options)
1384 { return this->name_.c_str(); }
1386 const Position_dependent_options&
1388 { return this->options_; }
1392 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1395 is_searched_file() const
1396 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1399 extra_search_path() const
1401 return (this->extra_search_path_.empty()
1403 : this->extra_search_path_.c_str());
1406 // Return whether we should only read symbols from this file.
1408 just_symbols() const
1409 { return this->just_symbols_; }
1411 // Return whether this file may require a search using the -L
1414 may_need_search() const
1416 return (this->is_lib()
1417 || this->is_searched_file()
1418 || !this->extra_search_path_.empty());
1422 // We use std::string, not const char*, here for convenience when
1423 // using script files, so that we do not have to preserve the string
1426 Input_file_type type_;
1427 std::string extra_search_path_;
1429 Position_dependent_options options_;
1432 // A file or library, or a group, from the command line.
1434 class Input_argument
1437 // Create a file or library argument.
1438 explicit Input_argument(Input_file_argument file)
1439 : is_file_(true), file_(file), group_(NULL)
1442 // Create a group argument.
1443 explicit Input_argument(Input_file_group* group)
1444 : is_file_(false), group_(group)
1447 // Return whether this is a file.
1450 { return this->is_file_; }
1452 // Return whether this is a group.
1455 { return !this->is_file_; }
1457 // Return the information about the file.
1458 const Input_file_argument&
1461 gold_assert(this->is_file_);
1465 // Return the information about the group.
1466 const Input_file_group*
1469 gold_assert(!this->is_file_);
1470 return this->group_;
1476 gold_assert(!this->is_file_);
1477 return this->group_;
1482 Input_file_argument file_;
1483 Input_file_group* group_;
1486 typedef std::vector<Input_argument> Input_argument_list;
1488 // A group from the command line. This is a set of arguments within
1489 // --start-group ... --end-group.
1491 class Input_file_group
1494 typedef Input_argument_list::const_iterator const_iterator;
1500 // Add a file to the end of the group.
1502 add_file(const Input_file_argument& arg)
1503 { this->files_.push_back(Input_argument(arg)); }
1505 // Iterators to iterate over the group contents.
1509 { return this->files_.begin(); }
1513 { return this->files_.end(); }
1516 Input_argument_list files_;
1519 // A list of files from the command line or a script.
1521 class Input_arguments
1524 typedef Input_argument_list::const_iterator const_iterator;
1527 : input_argument_list_(), in_group_(false)
1532 add_file(const Input_file_argument& arg);
1534 // Start a group (the --start-group option).
1538 // End a group (the --end-group option).
1542 // Return whether we are currently in a group.
1545 { return this->in_group_; }
1547 // The number of entries in the list.
1550 { return this->input_argument_list_.size(); }
1552 // Iterators to iterate over the list of input files.
1556 { return this->input_argument_list_.begin(); }
1560 { return this->input_argument_list_.end(); }
1562 // Return whether the list is empty.
1565 { return this->input_argument_list_.empty(); }
1568 Input_argument_list input_argument_list_;
1573 // All the information read from the command line. These are held in
1574 // three separate structs: one to hold the options (--foo), one to
1575 // hold the filenames listed on the commandline, and one to hold
1576 // linker script information. This third is not a subset of the other
1577 // two because linker scripts can be specified either as options (via
1578 // -T) or as a file.
1583 typedef Input_arguments::const_iterator const_iterator;
1587 // Process the command line options. This will exit with an
1588 // appropriate error message if an unrecognized option is seen.
1590 process(int argc, const char** argv);
1592 // Process one command-line option. This takes the index of argv to
1593 // process, and returns the index for the next option. no_more_options
1594 // is set to true if argv[i] is "--".
1596 process_one_option(int argc, const char** argv, int i,
1597 bool* no_more_options);
1599 // Get the general options.
1600 const General_options&
1602 { return this->options_; }
1604 // Get the position dependent options.
1605 const Position_dependent_options&
1606 position_dependent_options() const
1607 { return this->position_options_; }
1609 // Get the linker-script options.
1612 { return this->script_options_; }
1614 // Finalize the version-script options and return them.
1615 const Version_script_info&
1618 // Get the input files.
1621 { return this->inputs_; }
1623 // The number of input files.
1625 number_of_input_files() const
1626 { return this->inputs_.size(); }
1628 // Iterators to iterate over the list of input files.
1632 { return this->inputs_.begin(); }
1636 { return this->inputs_.end(); }
1639 Command_line(const Command_line&);
1640 Command_line& operator=(const Command_line&);
1642 // This is a dummy class to provide a constructor that runs before
1643 // the constructor for the General_options. The Pre_options constructor
1644 // is used as a hook to set the flag enabling the options to register
1646 struct Pre_options {
1650 // This must come before options_!
1651 Pre_options pre_options_;
1652 General_options options_;
1653 Position_dependent_options position_options_;
1654 Script_options script_options_;
1655 Input_arguments inputs_;
1658 } // End namespace gold.
1660 #endif // !defined(GOLD_OPTIONS_H)