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
52 class General_options;
53 class Search_directory;
54 class Input_file_group;
55 class Position_dependent_options;
59 // Incremental build action for a specific file, as selected by the user.
61 enum Incremental_disposition
63 // Determine the status from the timestamp (default).
65 // Assume the file changed from the previous build.
67 // Assume the file didn't change from the previous build.
71 // The nested namespace is to contain all the global variables and
72 // structs that need to be defined in the .h file, but do not need to
73 // be used outside this class.
76 typedef std::vector<Search_directory> Dir_list;
77 typedef Unordered_set<std::string> String_set;
79 // These routines convert from a string option to various types.
80 // Each gives a fatal error if it cannot parse the argument.
83 parse_bool(const char* option_name, const char* arg, bool* retval);
86 parse_int(const char* option_name, const char* arg, int* retval);
89 parse_uint(const char* option_name, const char* arg, int* retval);
92 parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
95 parse_double(const char* option_name, const char* arg, double* retval);
98 parse_string(const char* option_name, const char* arg, const char** retval);
101 parse_optional_string(const char* option_name, const char* arg,
102 const char** retval);
105 parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
108 parse_set(const char* option_name, const char* arg, String_set* retval);
111 parse_choices(const char* option_name, const char* arg, const char** retval,
112 const char* choices[], int num_choices);
116 // Most options have both a shortname (one letter) and a longname.
117 // This enum controls how many dashes are expected for longname access
118 // -- shortnames always use one dash. Most longnames will accept
119 // either one dash or two; the only difference between ONE_DASH and
120 // TWO_DASHES is how we print the option in --help. However, some
121 // longnames require two dashes, and some require only one. The
122 // special value DASH_Z means that the option is preceded by "-z".
125 ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z
128 // LONGNAME is the long-name of the option with dashes converted to
129 // underscores, or else the short-name if the option has no long-name.
130 // It is never the empty string.
131 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
132 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
133 // option has no short-name. If the option has no long-name, you
134 // should specify the short-name in *both* VARNAME and here.
135 // DEFAULT_VALUE is the value of the option if not specified on the
136 // commandline, as a string.
137 // HELPSTRING is the descriptive text used with the option via --help
138 // HELPARG is how you define the argument to the option.
139 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
140 // HELPARG should be NULL iff the option is a bool and takes no arg.
141 // OPTIONAL_ARG is true if this option takes an optional argument. An
142 // optional argument must be specifid as --OPTION=VALUE, not
144 // READER provides parse_to_value, which is a function that will convert
145 // a char* argument into the proper type and store it in some variable.
146 // A One_option struct initializes itself with the global list of options
147 // at constructor time, so be careful making one of these.
150 std::string longname;
153 const char* default_value;
154 const char* helpstring;
159 One_option(const char* ln, Dashes d, char sn, const char* dv,
160 const char* hs, const char* ha, bool oa, Struct_var* r)
161 : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
162 helpstring(hs), helparg(ha), optional_arg(oa), reader(r)
164 // In longname, we convert all underscores to dashes, since GNU
165 // style uses dashes in option names. longname is likely to have
166 // underscores in it because it's also used to declare a C++
168 const char* pos = strchr(this->longname.c_str(), '_');
169 for (; pos; pos = strchr(pos, '_'))
170 this->longname[pos - this->longname.c_str()] = '-';
172 // We only register ourselves if our helpstring is not NULL. This
173 // is to support the "no-VAR" boolean variables, which we
174 // conditionally turn on by defining "no-VAR" help text.
175 if (this->helpstring)
176 this->register_option();
179 // This option takes an argument iff helparg is not NULL.
181 takes_argument() const
182 { return this->helparg != NULL; }
184 // Whether the argument is optional.
186 takes_optional_argument() const
187 { return this->optional_arg; }
189 // Register this option with the global list of options.
193 // Print this option to stdout (used with --help).
198 // All options have a Struct_##varname that inherits from this and
199 // actually implements parse_to_value for that option.
202 // OPTION: the name of the option as specified on the commandline,
203 // including leading dashes, and any text following the option:
204 // "-O", "--defsym=mysym=0x1000", etc.
205 // ARG: the arg associated with this option, or NULL if the option
206 // takes no argument: "2", "mysym=0x1000", etc.
207 // CMDLINE: the global Command_line object. Used by DEFINE_special.
208 // OPTIONS: the global General_options object. Used by DEFINE_special.
210 parse_to_value(const char* option, const char* arg,
211 Command_line* cmdline, General_options* options) = 0;
213 ~Struct_var() // To make gcc happy.
217 // This is for "special" options that aren't of any predefined type.
218 struct Struct_special : public Struct_var
220 // If you change this, change the parse-fn in DEFINE_special as well.
221 typedef void (General_options::*Parse_function)(const char*, const char*,
223 Struct_special(const char* varname, Dashes dashes, char shortname,
224 Parse_function parse_function,
225 const char* helpstring, const char* helparg)
226 : option(varname, dashes, shortname, "", helpstring, helparg, false, this),
227 parse(parse_function)
230 void parse_to_value(const char* option, const char* arg,
231 Command_line* cmdline, General_options* options)
232 { (options->*(this->parse))(option, arg, cmdline); }
235 Parse_function parse;
238 } // End namespace options.
241 // These are helper macros use by DEFINE_uint64/etc below.
242 // This macro is used inside the General_options_ class, so defines
243 // var() and set_var() as General_options methods. Arguments as are
244 // for the constructor for One_option. param_type__ is the same as
245 // type__ for built-in types, and "const type__ &" otherwise.
246 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
247 default_value_as_string__, helpstring__, helparg__, \
248 optional_arg__, type__, param_type__, parse_fn__) \
252 { return this->varname__##_.value; } \
255 user_set_##varname__() const \
256 { return this->varname__##_.user_set_via_option; } \
259 set_user_set_##varname__() \
260 { this->varname__##_.user_set_via_option = true; } \
263 struct Struct_##varname__ : public options::Struct_var \
265 Struct_##varname__() \
266 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
267 helpstring__, helparg__, optional_arg__, this), \
268 user_set_via_option(false), value(default_value__) \
272 parse_to_value(const char* option_name, const char* arg, \
273 Command_line*, General_options*) \
275 parse_fn__(option_name, arg, &this->value); \
276 this->user_set_via_option = true; \
279 options::One_option option; \
280 bool user_set_via_option; \
283 Struct_##varname__ varname__##_; \
285 set_##varname__(param_type__ value) \
286 { this->varname__##_.value = value; }
288 // These macros allow for easy addition of a new commandline option.
290 // If no_helpstring__ is not NULL, then in addition to creating
291 // VARNAME, we also create an option called no-VARNAME (or, for a -z
292 // option, noVARNAME).
293 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
294 helpstring__, no_helpstring__) \
295 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
296 default_value__ ? "true" : "false", helpstring__, NULL, \
297 false, bool, bool, options::parse_bool) \
298 struct Struct_no_##varname__ : public options::Struct_var \
300 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
302 : "no-" #varname__), \
304 default_value__ ? "false" : "true", \
305 no_helpstring__, NULL, false, this) \
309 parse_to_value(const char*, const char*, \
310 Command_line*, General_options* options) \
311 { options->set_##varname__(false); } \
313 options::One_option option; \
315 Struct_no_##varname__ no_##varname__##_initializer_
317 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
318 helpstring__, no_helpstring__) \
319 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
320 default_value__ ? "true" : "false", helpstring__, NULL, \
321 false, bool, bool, options::parse_bool) \
322 struct Struct_disable_##varname__ : public options::Struct_var \
324 Struct_disable_##varname__() : option("disable-" #varname__, \
326 default_value__ ? "false" : "true", \
327 no_helpstring__, NULL, false, this) \
331 parse_to_value(const char*, const char*, \
332 Command_line*, General_options* options) \
333 { options->set_enable_##varname__(false); } \
335 options::One_option option; \
337 Struct_disable_##varname__ disable_##varname__##_initializer_
339 #define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
340 helpstring__, helparg__) \
341 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
342 #default_value__, helpstring__, helparg__, false, \
343 int, int, options::parse_int)
345 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
346 helpstring__, helparg__) \
347 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
348 #default_value__, helpstring__, helparg__, false, \
349 int, int, options::parse_uint)
351 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
352 helpstring__, helparg__) \
353 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
354 #default_value__, helpstring__, helparg__, false, \
355 uint64_t, uint64_t, options::parse_uint64)
357 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
358 helpstring__, helparg__) \
359 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
360 #default_value__, helpstring__, helparg__, false, \
361 double, double, options::parse_double)
363 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
364 helpstring__, helparg__) \
365 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
366 default_value__, helpstring__, helparg__, false, \
367 const char*, const char*, options::parse_string)
369 // This is like DEFINE_string, but we convert each occurrence to a
370 // Search_directory and store it in a vector. Thus we also have the
371 // add_to_VARNAME() method, to append to the vector.
372 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
373 helpstring__, helparg__) \
374 DEFINE_var(varname__, dashes__, shortname__, , \
375 "", helpstring__, helparg__, false, options::Dir_list, \
376 const options::Dir_list&, options::parse_dirlist) \
378 add_to_##varname__(const char* new_value) \
379 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
381 add_search_directory_to_##varname__(const Search_directory& dir) \
382 { this->varname__##_.value.push_back(dir); }
384 // This is like DEFINE_string, but we store a set of strings.
385 #define DEFINE_set(varname__, dashes__, shortname__, \
386 helpstring__, helparg__) \
387 DEFINE_var(varname__, dashes__, shortname__, , \
388 "", helpstring__, helparg__, false, options::String_set, \
389 const options::String_set&, options::parse_set) \
392 any_##varname__() const \
393 { return !this->varname__##_.value.empty(); } \
396 is_##varname__(const char* symbol) const \
398 return (!this->varname__##_.value.empty() \
399 && (this->varname__##_.value.find(std::string(symbol)) \
400 != this->varname__##_.value.end())); \
403 options::String_set::const_iterator \
404 varname__##_begin() const \
405 { return this->varname__##_.value.begin(); } \
407 options::String_set::const_iterator \
408 varname__##_end() const \
409 { return this->varname__##_.value.end(); }
411 // When you have a list of possible values (expressed as string)
412 // After helparg__ should come an initializer list, like
413 // {"foo", "bar", "baz"}
414 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
415 helpstring__, helparg__, ...) \
416 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
417 default_value__, helpstring__, helparg__, false, \
418 const char*, const char*, parse_choices_##varname__) \
420 static void parse_choices_##varname__(const char* option_name, \
422 const char** retval) { \
423 const char* choices[] = __VA_ARGS__; \
424 options::parse_choices(option_name, arg, retval, \
425 choices, sizeof(choices) / sizeof(*choices)); \
428 // This is like DEFINE_bool, but VARNAME is the name of a different
429 // option. This option becomes an alias for that one. INVERT is true
430 // if this option is an inversion of the other one.
431 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
432 helpstring__, no_helpstring__, invert__) \
434 struct Struct_##option__ : public options::Struct_var \
436 Struct_##option__() \
437 : option(#option__, dashes__, shortname__, "", helpstring__, \
442 parse_to_value(const char*, const char*, \
443 Command_line*, General_options* options) \
445 options->set_##varname__(!invert__); \
446 options->set_user_set_##varname__(); \
449 options::One_option option; \
451 Struct_##option__ option__##_; \
453 struct Struct_no_##option__ : public options::Struct_var \
455 Struct_no_##option__() \
456 : option((dashes__ == options::DASH_Z \
458 : "no-" #option__), \
459 dashes__, '\0', "", no_helpstring__, \
464 parse_to_value(const char*, const char*, \
465 Command_line*, General_options* options) \
467 options->set_##varname__(invert__); \
468 options->set_user_set_##varname__(); \
471 options::One_option option; \
473 Struct_no_##option__ no_##option__##_initializer_
475 // This is used for non-standard flags. It defines no functions; it
476 // just calls General_options::parse_VARNAME whenever the flag is
477 // seen. We declare parse_VARNAME as a static member of
478 // General_options; you are responsible for defining it there.
479 // helparg__ should be NULL iff this special-option is a boolean.
480 #define DEFINE_special(varname__, dashes__, shortname__, \
481 helpstring__, helparg__) \
483 void parse_##varname__(const char* option, const char* arg, \
484 Command_line* inputs); \
485 struct Struct_##varname__ : public options::Struct_special \
487 Struct_##varname__() \
488 : options::Struct_special(#varname__, dashes__, shortname__, \
489 &General_options::parse_##varname__, \
490 helpstring__, helparg__) \
493 Struct_##varname__ varname__##_initializer_
495 // An option that takes an optional string argument. If the option is
496 // used with no argument, the value will be the default, and
497 // user_set_via_option will be true.
498 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
500 helpstring__, helparg__) \
501 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
502 default_value__, helpstring__, helparg__, true, \
503 const char*, const char*, options::parse_optional_string)
505 // A directory to search. For each directory we record whether it is
506 // in the sysroot. We need to know this so that, if a linker script
507 // is found within the sysroot, we will apply the sysroot to any files
508 // named by that script.
510 class Search_directory
513 // We need a default constructor because we put this in a
516 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
519 // This is the usual constructor.
520 Search_directory(const char* name, bool put_in_sysroot)
521 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
523 if (this->name_.empty())
527 // This is called if we have a sysroot. The sysroot is prefixed to
528 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
529 // set to true for any enries which are in the sysroot (this will
530 // naturally include any entries for which put_in_sysroot_ is true).
531 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
532 // passing SYSROOT to lrealpath.
534 add_sysroot(const char* sysroot, const char* canonical_sysroot);
536 // Get the directory name.
539 { return this->name_; }
541 // Return whether this directory is in the sysroot.
543 is_in_sysroot() const
544 { return this->is_in_sysroot_; }
546 // Return whether this is considered a system directory.
548 is_system_directory() const
549 { return this->put_in_sysroot_ || this->is_in_sysroot_; }
552 // The directory name.
554 // True if the sysroot should be added as a prefix for this
555 // directory (if there is a sysroot). This is true for system
556 // directories that we search by default.
557 bool put_in_sysroot_;
558 // True if this directory is in the sysroot (if there is a sysroot).
559 // This is true if there is a sysroot and either 1) put_in_sysroot_
560 // is true, or 2) the directory happens to be in the sysroot based
561 // on a pathname comparison.
565 class General_options
568 // NOTE: For every option that you add here, also consider if you
569 // should add it to Position_dependent_options.
570 DEFINE_special(help, options::TWO_DASHES, '\0',
571 N_("Report usage information"), NULL);
572 DEFINE_special(version, options::TWO_DASHES, 'v',
573 N_("Report version information"), NULL);
574 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
575 N_("Report version and target information"), NULL);
577 // These options are sorted approximately so that for each letter in
578 // the alphabet, we show the option whose shortname is that letter
579 // (if any) and then every longname that starts with that letter (in
580 // alphabetical order). For both, lowercase sorts before uppercase.
581 // The -z options come last.
583 DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
585 N_("Do not copy DT_NEEDED tags from shared libraries"));
587 DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
588 '\0', N_("Allow multiple definitions of symbols"),
589 N_("Do not allow multiple definitions"), false);
591 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
592 N_("Allow unresolved references in shared libraries"),
593 N_("Do not allow unresolved references in shared libraries"));
595 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
596 N_("Only set DT_NEEDED for shared libraries if used"),
597 N_("Always DT_NEEDED for shared libraries"));
599 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
600 N_("Ignored"), N_("[ignored]"),
601 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
603 // This should really be an "enum", but it's too easy for folks to
604 // forget to update the list as they add new targets. So we just
605 // accept any string. We'll fail later (when the string is parsed),
606 // if the target isn't actually supported.
607 DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
608 N_("Set input format"), ("[elf,binary]"));
610 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
611 N_("-l searches for shared libraries"), NULL);
612 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
613 N_("-l does not search for shared libraries"), NULL,
616 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
617 N_("Bind defined symbols locally"), NULL);
619 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
620 N_("Bind defined function symbols locally"), NULL);
622 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
623 N_("Generate build ID note"),
626 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
627 N_("Check segment addresses for overlaps (default)"),
628 N_("Do not check segment addresses for overlaps"));
631 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
632 N_("Compress .debug_* sections in the output file"),
636 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
637 N_("Compress .debug_* sections in the output file"),
642 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
644 N_("Do not copy DT_NEEDED tags from shared libraries"));
646 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
647 N_("Output cross reference table"),
648 N_("Do not output cross reference table"));
650 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
651 N_("Define common symbols"),
652 N_("Do not define common symbols"));
653 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
654 N_("Alias for -d"), NULL);
655 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
656 N_("Alias for -d"), NULL);
658 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
659 N_("Turn on debugging"),
660 N_("[all,files,script,task][,...]"));
662 DEFINE_special(defsym, options::TWO_DASHES, '\0',
663 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
665 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
666 N_("Demangle C++ symbols in log messages"),
669 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
670 N_("Do not demangle C++ symbols in log messages"),
673 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
674 N_("Try to detect violations of the One Definition Rule"),
677 DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
678 N_("Delete all local symbols"), NULL);
679 DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
680 N_("Delete all temporary local symbols"), NULL);
682 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
683 N_("Add data symbols to dynamic symbols"), NULL);
685 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
686 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
688 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
689 N_("Add C++ typeinfo to dynamic symbols"), NULL);
691 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
692 N_("Read a list of dynamic symbols"), N_("FILE"));
694 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
695 N_("Set program start address"), N_("ADDRESS"));
697 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
698 N_("Exclude libraries from automatic export"),
699 N_(("lib,lib ...")));
701 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
702 N_("Export all dynamic symbols"),
703 N_("Do not export all dynamic symbols (default)"));
705 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
706 N_("Create exception frame header"), NULL);
708 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
709 N_("Treat warnings as errors"),
710 N_("Do not treat warnings as errors"));
712 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
713 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
715 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
716 N_("Ignored"), NULL);
718 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
719 N_("Set shared library name"), N_("FILENAME"));
721 DEFINE_bool(i, options::EXACTLY_ONE_DASH, '\0', false,
722 N_("Ignored"), NULL);
724 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
725 N_("Min fraction of empty buckets in dynamic hash"),
728 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
729 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
730 {"sysv", "gnu", "both"});
732 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
733 N_("Set dynamic linker path"), N_("PROGRAM"));
735 DEFINE_bool(incremental, options::TWO_DASHES, '\0', false,
736 N_("Work in progress; do not use"),
737 N_("Do a full build"));
739 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
740 N_("Assume files changed"), NULL);
742 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
743 N_("Assume files didn't change"), NULL);
745 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
746 N_("Use timestamps to check files (default)"), NULL);
748 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
749 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
751 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
752 N_("Read only symbol values from FILE"), N_("FILE"));
754 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0',
756 N_("Map whole files to memory (default on 64-bit hosts)"),
757 N_("Map relevant file parts to memory (default on 32-bit "
760 DEFINE_special(library, options::TWO_DASHES, 'l',
761 N_("Search for library LIBNAME"), N_("LIBNAME"));
763 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
764 N_("Add directory to search path"), N_("DIR"));
766 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
767 N_("Ignored for compatibility"), N_("EMULATION"));
769 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
770 N_("Write map file on standard output"), NULL);
771 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
774 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
775 N_("Do not page align data"), NULL);
776 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
777 N_("Do not page align data, do not make text readonly"),
778 N_("Page align data, make text readonly"));
780 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
781 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
782 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
784 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
785 N_("Create an output file even if errors occur"), NULL);
787 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
788 N_("Report undefined symbols (even with --shared)"),
791 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
792 N_("Set output file name"), N_("FILE"));
794 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
795 N_("Optimize output file size"), N_("LEVEL"));
797 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
798 N_("Set output format"), N_("[binary]"));
800 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
801 N_("Create a position independent executable"), NULL);
802 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
803 N_("Create a position independent executable"), NULL,
806 #ifdef ENABLE_PLUGINS
807 DEFINE_special(plugin, options::TWO_DASHES, '\0',
808 N_("Load a plugin library"), N_("PLUGIN"));
809 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
810 N_("Pass an option to the plugin"), N_("OPTION"));
813 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
814 N_("Preread archive symbols when multi-threaded"), NULL);
816 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
817 N_("Print symbols defined and used for each input"),
820 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
821 N_("Ignored for SVR4 compatibility"), NULL);
823 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
824 N_("Generate relocations in output"), NULL);
826 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
827 N_("Generate relocatable output"), NULL);
829 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
830 N_("Relax branches on certain targets"), NULL);
832 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
833 N_("keep only symbols listed in this file"), N_("FILE"));
835 // -R really means -rpath, but can mean --just-symbols for
836 // compatibility with GNU ld. -rpath is always -rpath, so we list
838 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
839 N_("Add DIR to runtime search path"), N_("DIR"));
841 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
842 N_("Add DIR to runtime search path"), N_("DIR"));
844 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
845 N_("Add DIR to link time shared library search path"),
848 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
849 N_("Sort common symbols by alignment"),
850 N_("[={ascending,descending}]"));
852 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
853 N_("Strip all symbols"), NULL);
854 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
855 N_("Strip debugging information"), NULL);
856 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
857 N_("Emit only debug line number information"), NULL);
858 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
859 N_("Strip debug symbols that are unused by gdb "
860 "(at least versions <= 6.7)"), NULL);
861 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
862 N_("Strip LTO intermediate code sections"), NULL);
864 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
865 N_("(ARM only) The maximum distance from instructions in a group "
866 "of sections to their stubs. Negative values mean stubs "
867 "are always after the group. 1 means using default size.\n"),
870 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
871 N_("Use less memory and more disk I/O "
872 "(included only for compatibility with GNU ld)"), NULL);
874 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
875 N_("Generate shared library"), NULL);
877 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
878 N_("Generate shared library"), NULL);
880 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
881 N_("Stack size when -fsplit-stack function calls non-split"),
884 // This is not actually special in any way, but I need to give it
885 // a non-standard accessor-function name because 'static' is a keyword.
886 DEFINE_special(static, options::ONE_DASH, '\0',
887 N_("Do not link against shared libraries"), NULL);
889 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
890 N_("Identical Code Folding. "
891 "\'--icf=safe\' folds only ctors and dtors."),
893 {"none", "all", "safe"});
895 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
896 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
898 DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
899 N_("List folded identical sections on stderr"),
900 N_("Do not list folded identical sections"));
902 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
903 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
905 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
906 N_("Remove unused sections"),
907 N_("Don't remove unused sections (default)"));
909 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
910 N_("List removed unused sections on stderr"),
911 N_("Do not list removed unused sections"));
913 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
914 N_("Print resource usage statistics"), NULL);
916 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
917 N_("Set target system root directory"), N_("DIR"));
919 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
920 N_("Print the name of each input file"), NULL);
922 DEFINE_special(script, options::TWO_DASHES, 'T',
923 N_("Read linker script"), N_("FILE"));
925 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
926 N_("Run the linker multi-threaded"),
927 N_("Do not run the linker multi-threaded"));
928 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
929 N_("Number of threads to use"), N_("COUNT"));
930 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
931 N_("Number of threads to use in initial pass"), N_("COUNT"));
932 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
933 N_("Number of threads to use in middle pass"), N_("COUNT"));
934 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
935 N_("Number of threads to use in final pass"), N_("COUNT"));
937 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
938 N_("Set the address of the bss segment"), N_("ADDRESS"));
939 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
940 N_("Set the address of the data segment"), N_("ADDRESS"));
941 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
942 N_("Set the address of the text segment"), N_("ADDRESS"));
944 DEFINE_set(undefined, options::TWO_DASHES, 'u',
945 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
947 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
948 N_("Synonym for --debug=files"), NULL);
950 DEFINE_special(version_script, options::TWO_DASHES, '\0',
951 N_("Read version script"), N_("FILE"));
953 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
954 N_("Warn about duplicate common symbols"),
955 N_("Do not warn about duplicate common symbols (default)"));
957 DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
958 N_("Ignored"), N_("Ignored"));
960 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
961 N_("Warn when skipping an incompatible library"),
962 N_("Don't warn when skipping an incompatible library"));
964 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
965 N_("Include all archive contents"),
966 N_("Include only needed archive contents"));
968 DEFINE_set(wrap, options::TWO_DASHES, '\0',
969 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
971 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
972 N_("Trace references to symbol"), N_("SYMBOL"));
974 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
975 N_("Allow unused version in script (default)"),
976 N_("Do not allow unused version in script"));
978 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
979 N_("Default search path for Solaris compatibility"),
982 DEFINE_special(start_group, options::TWO_DASHES, '(',
983 N_("Start a library search group"), NULL);
984 DEFINE_special(end_group, options::TWO_DASHES, ')',
985 N_("End a library search group"), NULL);
989 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
990 N_("Sort dynamic relocs"),
991 N_("Do not sort dynamic relocs"));
992 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
993 N_("Set common page size to SIZE"), N_("SIZE"));
994 DEFINE_bool(defs, options::DASH_Z, '\0', false,
995 N_("Report undefined symbols (even with --shared)"),
997 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
998 N_("Mark output as requiring executable stack"), NULL);
999 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1000 N_("Mark DSO to be initialized first at runtime"),
1002 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1003 N_("Mark object to interpose all DSOs but executable"),
1005 DEFINE_bool(lazy, options::DASH_Z, '\0', false,
1006 N_("Mark object for lazy runtime binding (default)"),
1008 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1009 N_("Mark object requiring immediate process"),
1011 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1012 N_("Set maximum page size to SIZE"), N_("SIZE"));
1013 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1014 N_("Allow multiple definitions of symbols"),
1016 // copyreloc is here in the list because there is only -z
1017 // nocopyreloc, not -z copyreloc.
1018 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1020 N_("Do not create copy relocs"));
1021 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1022 N_("Mark object not to use default search paths"),
1024 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1025 N_("Mark DSO non-deletable at runtime"),
1027 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1028 N_("Mark DSO not available to dlopen"),
1030 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1031 N_("Mark DSO not available to dldump"),
1033 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1034 N_("Mark output as not requiring executable stack"), NULL);
1035 DEFINE_bool(now, options::DASH_Z, '\0', false,
1036 N_("Mark object for immediate function binding"),
1038 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1039 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1040 "processing at runtime"), NULL);
1041 DEFINE_bool(relro, options::DASH_Z, '\0', false,
1042 N_("Where possible mark variables read-only after relocation"),
1043 N_("Don't mark variables read-only after relocation"));
1046 typedef options::Dir_list Dir_list;
1050 // Does post-processing on flags, making sure they all have
1051 // non-conflicting values. Also converts some flags from their
1052 // "standard" types (string, etc), to another type (enum, DirList),
1053 // which can be accessed via a separate method. Dies if it notices
1057 // True if we printed the version information.
1059 printed_version() const
1060 { return this->printed_version_; }
1062 // The macro defines output() (based on --output), but that's a
1063 // generic name. Provide this alternative name, which is clearer.
1065 output_file_name() const
1066 { return this->output(); }
1068 // This is not defined via a flag, but combines flags to say whether
1069 // the output is position-independent or not.
1071 output_is_position_independent() const
1072 { return this->shared() || this->pie(); }
1074 // Return true if the output is something that can be exec()ed, such
1075 // as a static executable, or a position-dependent or
1076 // position-independent executable, but not a dynamic library or an
1079 output_is_executable() const
1080 { return !this->shared() && !this->relocatable(); }
1082 // This would normally be static(), and defined automatically, but
1083 // since static is a keyword, we need to come up with our own name.
1088 // In addition to getting the input and output formats as a string
1089 // (via format() and oformat()), we also give access as an enum.
1094 // Straight binary format.
1095 OBJECT_FORMAT_BINARY
1098 // Convert a string to an Object_format. Gives an error if the
1099 // string is not recognized.
1100 static Object_format
1101 string_to_object_format(const char* arg);
1103 // Note: these functions are not very fast.
1104 Object_format format_enum() const;
1105 Object_format oformat_enum() const;
1107 // Return whether FILENAME is in a system directory.
1109 is_in_system_directory(const std::string& name) const;
1111 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1113 should_retain_symbol(const char* symbol_name) const
1115 if (symbols_to_retain_.empty()) // means flag wasn't specified
1117 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1120 // These are the best way to get access to the execstack state,
1121 // not execstack() and noexecstack() which are hard to use properly.
1123 is_execstack_set() const
1124 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1127 is_stack_executable() const
1128 { return this->execstack_status_ == EXECSTACK_YES; }
1132 { return this->icf_status_ != ICF_NONE; }
1135 icf_safe_folding() const
1136 { return this->icf_status_ == ICF_SAFE; }
1138 // The --demangle option takes an optional string, and there is also
1139 // a --no-demangle option. This is the best way to decide whether
1140 // to demangle or not.
1143 { return this->do_demangle_; }
1145 // Returns TRUE if any plugin libraries have been loaded.
1148 { return this->plugins_ != NULL; }
1150 // Return a pointer to the plugin manager.
1153 { return this->plugins_; }
1155 // True iff SYMBOL was found in the file specified by dynamic-list.
1157 in_dynamic_list(const char* symbol) const
1158 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1160 // Finalize the dynamic list.
1162 finalize_dynamic_list()
1163 { this->dynamic_list_.version_script_info()->finalize(); }
1165 // The disposition given by the --incremental-changed,
1166 // --incremental-unchanged or --incremental-unknown option. The
1167 // value may change as we proceed parsing the command line flags.
1168 Incremental_disposition
1169 incremental_disposition() const
1170 { return this->incremental_disposition_; }
1172 // Return true if S is the name of a library excluded from automatic
1175 check_excluded_libs (const std::string &s) const;
1178 // Don't copy this structure.
1179 General_options(const General_options&);
1180 General_options& operator=(const General_options&);
1182 // Whether to mark the stack as executable.
1185 // Not set on command line.
1186 EXECSTACK_FROM_INPUT,
1187 // Mark the stack as executable (-z execstack).
1189 // Mark the stack as not executable (-z noexecstack).
1195 // Do not fold any functions (Default or --icf=none).
1197 // All functions are candidates for folding. (--icf=all).
1199 // Only ctors and dtors are candidates for folding. (--icf=safe).
1204 set_icf_status(Icf_status value)
1205 { this->icf_status_ = value; }
1208 set_execstack_status(Execstack value)
1209 { this->execstack_status_ = value; }
1212 set_do_demangle(bool value)
1213 { this->do_demangle_ = value; }
1216 set_static(bool value)
1217 { static_ = value; }
1219 // These are called by finalize() to set up the search-path correctly.
1221 add_to_library_path_with_sysroot(const char* arg)
1222 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1224 // Apply any sysroot to the directory lists.
1228 // Add a plugin and its arguments to the list of plugins.
1230 add_plugin(const char *filename);
1232 // Add a plugin option.
1234 add_plugin_option(const char* opt);
1236 // Whether we printed version information.
1237 bool printed_version_;
1238 // Whether to mark the stack as executable.
1239 Execstack execstack_status_;
1240 // Whether to do code folding.
1241 Icf_status icf_status_;
1242 // Whether to do a static link.
1244 // Whether to do demangling.
1246 // List of plugin libraries.
1247 Plugin_manager* plugins_;
1248 // The parsed output of --dynamic-list files. For convenience in
1249 // script.cc, we store this as a Script_options object, even though
1250 // we only use a single Version_tree from it.
1251 Script_options dynamic_list_;
1252 // The disposition given by the --incremental-changed,
1253 // --incremental-unchanged or --incremental-unknown option. The
1254 // value may change as we proceed parsing the command line flags.
1255 Incremental_disposition incremental_disposition_;
1256 // Whether we have seen one of the options that require incremental
1257 // build (--incremental-changed, --incremental-unchanged or
1258 // --incremental-unknown)
1259 bool implicit_incremental_;
1260 // Libraries excluded from automatic export, via --exclude-libs.
1261 Unordered_set<std::string> excluded_libs_;
1262 // List of symbol-names to keep, via -retain-symbol-info.
1263 Unordered_set<std::string> symbols_to_retain_;
1266 // The position-dependent options. We use this to store the state of
1267 // the commandline at a particular point in parsing for later
1268 // reference. For instance, if we see "ld --whole-archive foo.a
1269 // --no-whole-archive," we want to store the whole-archive option with
1270 // foo.a, so when the time comes to parse foo.a we know we should do
1271 // it in whole-archive mode. We could store all of General_options,
1272 // but that's big, so we just pick the subset of flags that actually
1273 // change in a position-dependent way.
1275 #define DEFINE_posdep(varname__, type__) \
1279 { return this->varname__##_; } \
1282 set_##varname__(type__ value) \
1283 { this->varname__##_ = value; } \
1287 class Position_dependent_options
1290 Position_dependent_options(const General_options& options
1291 = Position_dependent_options::default_options_)
1292 { copy_from_options(options); }
1294 void copy_from_options(const General_options& options)
1296 this->set_as_needed(options.as_needed());
1297 this->set_Bdynamic(options.Bdynamic());
1298 this->set_format_enum(options.format_enum());
1299 this->set_whole_archive(options.whole_archive());
1300 this->set_incremental_disposition(options.incremental_disposition());
1303 DEFINE_posdep(as_needed, bool);
1304 DEFINE_posdep(Bdynamic, bool);
1305 DEFINE_posdep(format_enum, General_options::Object_format);
1306 DEFINE_posdep(whole_archive, bool);
1307 DEFINE_posdep(incremental_disposition, Incremental_disposition);
1310 // This is a General_options with everything set to its default
1311 // value. A Position_dependent_options created with no argument
1312 // will take its values from here.
1313 static General_options default_options_;
1317 // A single file or library argument from the command line.
1319 class Input_file_argument
1322 enum Input_file_type
1324 // A regular file, name used as-is, not searched.
1325 INPUT_FILE_TYPE_FILE,
1326 // A library name. When used, "lib" will be prepended and ".so" or
1327 // ".a" appended to make a filename, and that filename will be searched
1328 // for using the -L paths.
1329 INPUT_FILE_TYPE_LIBRARY,
1330 // A regular file, name used as-is, but searched using the -L paths.
1331 INPUT_FILE_TYPE_SEARCHED_FILE
1334 // name: file name or library name
1335 // type: the type of this input file.
1336 // extra_search_path: an extra directory to look for the file, prior
1337 // to checking the normal library search path. If this is "",
1338 // then no extra directory is added.
1339 // just_symbols: whether this file only defines symbols.
1340 // options: The position dependent options at this point in the
1341 // command line, such as --whole-archive.
1342 Input_file_argument()
1343 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1344 just_symbols_(false), options_()
1347 Input_file_argument(const char* name, Input_file_type type,
1348 const char* extra_search_path,
1350 const Position_dependent_options& options)
1351 : name_(name), type_(type), extra_search_path_(extra_search_path),
1352 just_symbols_(just_symbols), options_(options)
1355 // You can also pass in a General_options instance instead of a
1356 // Position_dependent_options. In that case, we extract the
1357 // position-independent vars from the General_options and only store
1359 Input_file_argument(const char* name, Input_file_type type,
1360 const char* extra_search_path,
1362 const General_options& options)
1363 : name_(name), type_(type), extra_search_path_(extra_search_path),
1364 just_symbols_(just_symbols), options_(options)
1369 { return this->name_.c_str(); }
1371 const Position_dependent_options&
1373 { return this->options_; }
1377 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1380 is_searched_file() const
1381 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1384 extra_search_path() const
1386 return (this->extra_search_path_.empty()
1388 : this->extra_search_path_.c_str());
1391 // Return whether we should only read symbols from this file.
1393 just_symbols() const
1394 { return this->just_symbols_; }
1396 // Return whether this file may require a search using the -L
1399 may_need_search() const
1401 return (this->is_lib()
1402 || this->is_searched_file()
1403 || !this->extra_search_path_.empty());
1407 // We use std::string, not const char*, here for convenience when
1408 // using script files, so that we do not have to preserve the string
1411 Input_file_type type_;
1412 std::string extra_search_path_;
1414 Position_dependent_options options_;
1417 // A file or library, or a group, from the command line.
1419 class Input_argument
1422 // Create a file or library argument.
1423 explicit Input_argument(Input_file_argument file)
1424 : is_file_(true), file_(file), group_(NULL)
1427 // Create a group argument.
1428 explicit Input_argument(Input_file_group* group)
1429 : is_file_(false), group_(group)
1432 // Return whether this is a file.
1435 { return this->is_file_; }
1437 // Return whether this is a group.
1440 { return !this->is_file_; }
1442 // Return the information about the file.
1443 const Input_file_argument&
1446 gold_assert(this->is_file_);
1450 // Return the information about the group.
1451 const Input_file_group*
1454 gold_assert(!this->is_file_);
1455 return this->group_;
1461 gold_assert(!this->is_file_);
1462 return this->group_;
1467 Input_file_argument file_;
1468 Input_file_group* group_;
1471 typedef std::vector<Input_argument> Input_argument_list;
1473 // A group from the command line. This is a set of arguments within
1474 // --start-group ... --end-group.
1476 class Input_file_group
1479 typedef Input_argument_list::const_iterator const_iterator;
1485 // Add a file to the end of the group.
1487 add_file(const Input_file_argument& arg)
1488 { this->files_.push_back(Input_argument(arg)); }
1490 // Iterators to iterate over the group contents.
1494 { return this->files_.begin(); }
1498 { return this->files_.end(); }
1501 Input_argument_list files_;
1504 // A list of files from the command line or a script.
1506 class Input_arguments
1509 typedef Input_argument_list::const_iterator const_iterator;
1512 : input_argument_list_(), in_group_(false)
1517 add_file(const Input_file_argument& arg);
1519 // Start a group (the --start-group option).
1523 // End a group (the --end-group option).
1527 // Return whether we are currently in a group.
1530 { return this->in_group_; }
1532 // The number of entries in the list.
1535 { return this->input_argument_list_.size(); }
1537 // Iterators to iterate over the list of input files.
1541 { return this->input_argument_list_.begin(); }
1545 { return this->input_argument_list_.end(); }
1547 // Return whether the list is empty.
1550 { return this->input_argument_list_.empty(); }
1553 Input_argument_list input_argument_list_;
1558 // All the information read from the command line. These are held in
1559 // three separate structs: one to hold the options (--foo), one to
1560 // hold the filenames listed on the commandline, and one to hold
1561 // linker script information. This third is not a subset of the other
1562 // two because linker scripts can be specified either as options (via
1563 // -T) or as a file.
1568 typedef Input_arguments::const_iterator const_iterator;
1572 // Process the command line options. This will exit with an
1573 // appropriate error message if an unrecognized option is seen.
1575 process(int argc, const char** argv);
1577 // Process one command-line option. This takes the index of argv to
1578 // process, and returns the index for the next option. no_more_options
1579 // is set to true if argv[i] is "--".
1581 process_one_option(int argc, const char** argv, int i,
1582 bool* no_more_options);
1584 // Get the general options.
1585 const General_options&
1587 { return this->options_; }
1589 // Get the position dependent options.
1590 const Position_dependent_options&
1591 position_dependent_options() const
1592 { return this->position_options_; }
1594 // Get the linker-script options.
1597 { return this->script_options_; }
1599 // Finalize the version-script options and return them.
1600 const Version_script_info&
1603 // Get the input files.
1606 { return this->inputs_; }
1608 // The number of input files.
1610 number_of_input_files() const
1611 { return this->inputs_.size(); }
1613 // Iterators to iterate over the list of input files.
1617 { return this->inputs_.begin(); }
1621 { return this->inputs_.end(); }
1624 Command_line(const Command_line&);
1625 Command_line& operator=(const Command_line&);
1627 // This is a dummy class to provide a constructor that runs before
1628 // the constructor for the General_options. The Pre_options constructor
1629 // is used as a hook to set the flag enabling the options to register
1631 struct Pre_options {
1635 // This must come before options_!
1636 Pre_options pre_options_;
1637 General_options options_;
1638 Position_dependent_options position_options_;
1639 Script_options script_options_;
1640 Input_arguments inputs_;
1643 } // End namespace gold.
1645 #endif // !defined(GOLD_OPTIONS_H)