1 // options.h -- handle command line options for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008 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 // The nested namespace is to contain all the global variables and
60 // structs that need to be defined in the .h file, but do not need to
61 // be used outside this class.
64 typedef std::vector
<Search_directory
> Dir_list
;
65 typedef Unordered_set
<std::string
> String_set
;
67 // These routines convert from a string option to various types.
68 // Each gives a fatal error if it cannot parse the argument.
71 parse_bool(const char* option_name
, const char* arg
, bool* retval
);
74 parse_uint(const char* option_name
, const char* arg
, int* retval
);
77 parse_uint64(const char* option_name
, const char* arg
, uint64_t* retval
);
80 parse_double(const char* option_name
, const char* arg
, double* retval
);
83 parse_string(const char* option_name
, const char* arg
, const char** retval
);
86 parse_optional_string(const char* option_name
, const char* arg
,
90 parse_dirlist(const char* option_name
, const char* arg
, Dir_list
* retval
);
93 parse_set(const char* option_name
, const char* arg
, String_set
* retval
);
96 parse_choices(const char* option_name
, const char* arg
, const char** retval
,
97 const char* choices
[], int num_choices
);
101 // Most options have both a shortname (one letter) and a longname.
102 // This enum controls how many dashes are expected for longname access
103 // -- shortnames always use one dash. Most longnames will accept
104 // either one dash or two; the only difference between ONE_DASH and
105 // TWO_DASHES is how we print the option in --help. However, some
106 // longnames require two dashes, and some require only one. The
107 // special value DASH_Z means that the option is preceded by "-z".
110 ONE_DASH
, TWO_DASHES
, EXACTLY_ONE_DASH
, EXACTLY_TWO_DASHES
, DASH_Z
113 // LONGNAME is the long-name of the option with dashes converted to
114 // underscores, or else the short-name if the option has no long-name.
115 // It is never the empty string.
116 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
117 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
118 // option has no short-name. If the option has no long-name, you
119 // should specify the short-name in *both* VARNAME and here.
120 // DEFAULT_VALUE is the value of the option if not specified on the
121 // commandline, as a string.
122 // HELPSTRING is the descriptive text used with the option via --help
123 // HELPARG is how you define the argument to the option.
124 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
125 // HELPARG should be NULL iff the option is a bool and takes no arg.
126 // OPTIONAL_ARG is true if this option takes an optional argument. An
127 // optional argument must be specifid as --OPTION=VALUE, not
129 // READER provides parse_to_value, which is a function that will convert
130 // a char* argument into the proper type and store it in some variable.
131 // A One_option struct initializes itself with the global list of options
132 // at constructor time, so be careful making one of these.
135 std::string longname
;
138 const char* default_value
;
139 const char* helpstring
;
144 One_option(const char* ln
, Dashes d
, char sn
, const char* dv
,
145 const char* hs
, const char* ha
, bool oa
, Struct_var
* r
)
146 : longname(ln
), dashes(d
), shortname(sn
), default_value(dv
? dv
: ""),
147 helpstring(hs
), helparg(ha
), optional_arg(oa
), reader(r
)
149 // In longname, we convert all underscores to dashes, since GNU
150 // style uses dashes in option names. longname is likely to have
151 // underscores in it because it's also used to declare a C++
153 const char* pos
= strchr(this->longname
.c_str(), '_');
154 for (; pos
; pos
= strchr(pos
, '_'))
155 this->longname
[pos
- this->longname
.c_str()] = '-';
157 // We only register ourselves if our helpstring is not NULL. This
158 // is to support the "no-VAR" boolean variables, which we
159 // conditionally turn on by defining "no-VAR" help text.
160 if (this->helpstring
)
161 this->register_option();
164 // This option takes an argument iff helparg is not NULL.
166 takes_argument() const
167 { return this->helparg
!= NULL
; }
169 // Whether the argument is optional.
171 takes_optional_argument() const
172 { return this->optional_arg
; }
174 // Register this option with the global list of options.
178 // Print this option to stdout (used with --help).
183 // All options have a Struct_##varname that inherits from this and
184 // actually implements parse_to_value for that option.
187 // OPTION: the name of the option as specified on the commandline,
188 // including leading dashes, and any text following the option:
189 // "-O", "--defsym=mysym=0x1000", etc.
190 // ARG: the arg associated with this option, or NULL if the option
191 // takes no argument: "2", "mysym=0x1000", etc.
192 // CMDLINE: the global Command_line object. Used by DEFINE_special.
193 // OPTIONS: the global General_options object. Used by DEFINE_special.
195 parse_to_value(const char* option
, const char* arg
,
196 Command_line
* cmdline
, General_options
* options
) = 0;
198 ~Struct_var() // To make gcc happy.
202 // This is for "special" options that aren't of any predefined type.
203 struct Struct_special
: public Struct_var
205 // If you change this, change the parse-fn in DEFINE_special as well.
206 typedef void (General_options::*Parse_function
)(const char*, const char*,
208 Struct_special(const char* varname
, Dashes dashes
, char shortname
,
209 Parse_function parse_function
,
210 const char* helpstring
, const char* helparg
)
211 : option(varname
, dashes
, shortname
, "", helpstring
, helparg
, false, this),
212 parse(parse_function
)
215 void parse_to_value(const char* option
, const char* arg
,
216 Command_line
* cmdline
, General_options
* options
)
217 { (options
->*(this->parse
))(option
, arg
, cmdline
); }
220 Parse_function parse
;
223 } // End namespace options.
226 // These are helper macros use by DEFINE_uint64/etc below.
227 // This macro is used inside the General_options_ class, so defines
228 // var() and set_var() as General_options methods. Arguments as are
229 // for the constructor for One_option. param_type__ is the same as
230 // type__ for built-in types, and "const type__ &" otherwise.
231 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
232 default_value_as_string__, helpstring__, helparg__, \
233 optional_arg__, type__, param_type__, parse_fn__) \
237 { return this->varname__##_.value; } \
240 user_set_##varname__() const \
241 { return this->varname__##_.user_set_via_option; } \
244 set_user_set_##varname__() \
245 { this->varname__##_.user_set_via_option = true; } \
248 struct Struct_##varname__ : public options::Struct_var \
250 Struct_##varname__() \
251 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
252 helpstring__, helparg__, optional_arg__, this), \
253 user_set_via_option(false), value(default_value__) \
257 parse_to_value(const char* option_name, const char* arg, \
258 Command_line*, General_options*) \
260 parse_fn__(option_name, arg, &this->value); \
261 this->user_set_via_option = true; \
264 options::One_option option; \
265 bool user_set_via_option; \
268 Struct_##varname__ varname__##_; \
270 set_##varname__(param_type__ value) \
271 { this->varname__##_.value = value; }
273 // These macros allow for easy addition of a new commandline option.
275 // If no_helpstring__ is not NULL, then in addition to creating
276 // VARNAME, we also create an option called no-VARNAME (or, for a -z
277 // option, noVARNAME).
278 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
279 helpstring__, no_helpstring__) \
280 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
281 default_value__ ? "true" : "false", helpstring__, NULL, \
282 false, bool, bool, options::parse_bool) \
283 struct Struct_no_##varname__ : public options::Struct_var \
285 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
287 : "no-" #varname__), \
289 default_value__ ? "false" : "true", \
290 no_helpstring__, NULL, false, this) \
294 parse_to_value(const char*, const char*, \
295 Command_line*, General_options* options) \
296 { options->set_##varname__(false); } \
298 options::One_option option; \
300 Struct_no_##varname__ no_##varname__##_initializer_
302 #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
303 helpstring__, no_helpstring__) \
304 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
305 default_value__ ? "true" : "false", helpstring__, NULL, \
306 false, bool, bool, options::parse_bool) \
307 struct Struct_disable_##varname__ : public options::Struct_var \
309 Struct_disable_##varname__() : option("disable-" #varname__, \
311 default_value__ ? "false" : "true", \
312 no_helpstring__, NULL, false, this) \
316 parse_to_value(const char*, const char*, \
317 Command_line*, General_options* options) \
318 { options->set_enable_##varname__(false); } \
320 options::One_option option; \
322 Struct_disable_##varname__ disable_##varname__##_initializer_
324 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
325 helpstring__, helparg__) \
326 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
327 #default_value__, helpstring__, helparg__, false, \
328 int, int, options::parse_uint)
330 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
331 helpstring__, helparg__) \
332 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
333 #default_value__, helpstring__, helparg__, false, \
334 uint64_t, uint64_t, options::parse_uint64)
336 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
337 helpstring__, helparg__) \
338 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
339 #default_value__, helpstring__, helparg__, false, \
340 double, double, options::parse_double)
342 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
343 helpstring__, helparg__) \
344 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
345 default_value__, helpstring__, helparg__, false, \
346 const char*, const char*, options::parse_string)
348 // This is like DEFINE_string, but we convert each occurrence to a
349 // Search_directory and store it in a vector. Thus we also have the
350 // add_to_VARNAME() method, to append to the vector.
351 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
352 helpstring__, helparg__) \
353 DEFINE_var(varname__, dashes__, shortname__, , \
354 "", helpstring__, helparg__, false, options::Dir_list, \
355 const options::Dir_list&, options::parse_dirlist) \
357 add_to_##varname__(const char* new_value) \
358 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
360 add_search_directory_to_##varname__(const Search_directory& dir) \
361 { this->varname__##_.value.push_back(dir); }
363 // This is like DEFINE_string, but we store a set of strings.
364 #define DEFINE_set(varname__, dashes__, shortname__, \
365 helpstring__, helparg__) \
366 DEFINE_var(varname__, dashes__, shortname__, , \
367 "", helpstring__, helparg__, false, options::String_set, \
368 const options::String_set&, options::parse_set) \
371 any_##varname__() const \
372 { return !this->varname__##_.value.empty(); } \
375 is_##varname__(const char* symbol) const \
377 return (!this->varname__##_.value.empty() \
378 && (this->varname__##_.value.find(std::string(symbol)) \
379 != this->varname__##_.value.end())); \
382 options::String_set::const_iterator \
383 varname__##_begin() const \
384 { return this->varname__##_.value.begin(); } \
386 options::String_set::const_iterator \
387 varname__##_end() const \
388 { return this->varname__##_.value.end(); }
390 // When you have a list of possible values (expressed as string)
391 // After helparg__ should come an initializer list, like
392 // {"foo", "bar", "baz"}
393 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
394 helpstring__, helparg__, ...) \
395 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
396 default_value__, helpstring__, helparg__, false, \
397 const char*, const char*, parse_choices_##varname__) \
399 static void parse_choices_##varname__(const char* option_name, \
401 const char** retval) { \
402 const char* choices[] = __VA_ARGS__; \
403 options::parse_choices(option_name, arg, retval, \
404 choices, sizeof(choices) / sizeof(*choices)); \
407 // This is like DEFINE_bool, but VARNAME is the name of a different
408 // option. This option becomes an alias for that one. INVERT is true
409 // if this option is an inversion of the other one.
410 #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
411 helpstring__, no_helpstring__, invert__) \
413 struct Struct_##option__ : public options::Struct_var \
415 Struct_##option__() \
416 : option(#option__, dashes__, shortname__, "", helpstring__, \
421 parse_to_value(const char*, const char*, \
422 Command_line*, General_options* options) \
424 options->set_##varname__(!invert__); \
425 options->set_user_set_##varname__(); \
428 options::One_option option; \
430 Struct_##option__ option__##_; \
432 struct Struct_no_##option__ : public options::Struct_var \
434 Struct_no_##option__() \
435 : option((dashes__ == options::DASH_Z \
437 : "no-" #option__), \
438 dashes__, '\0', "", no_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_no_##option__ no_##option__##_initializer_
454 // This is used for non-standard flags. It defines no functions; it
455 // just calls General_options::parse_VARNAME whenever the flag is
456 // seen. We declare parse_VARNAME as a static member of
457 // General_options; you are responsible for defining it there.
458 // helparg__ should be NULL iff this special-option is a boolean.
459 #define DEFINE_special(varname__, dashes__, shortname__, \
460 helpstring__, helparg__) \
462 void parse_##varname__(const char* option, const char* arg, \
463 Command_line* inputs); \
464 struct Struct_##varname__ : public options::Struct_special \
466 Struct_##varname__() \
467 : options::Struct_special(#varname__, dashes__, shortname__, \
468 &General_options::parse_##varname__, \
469 helpstring__, helparg__) \
472 Struct_##varname__ varname__##_initializer_
474 // An option that takes an optional string argument. If the option is
475 // used with no argument, the value will be the default, and
476 // user_set_via_option will be true.
477 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
479 helpstring__, helparg__) \
480 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
481 default_value__, helpstring__, helparg__, true, \
482 const char*, const char*, options::parse_optional_string)
484 // A directory to search. For each directory we record whether it is
485 // in the sysroot. We need to know this so that, if a linker script
486 // is found within the sysroot, we will apply the sysroot to any files
487 // named by that script.
489 class Search_directory
492 // We need a default constructor because we put this in a
495 : name_(NULL
), put_in_sysroot_(false), is_in_sysroot_(false)
498 // This is the usual constructor.
499 Search_directory(const char* name
, bool put_in_sysroot
)
500 : name_(name
), put_in_sysroot_(put_in_sysroot
), is_in_sysroot_(false)
502 if (this->name_
.empty())
506 // This is called if we have a sysroot. The sysroot is prefixed to
507 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
508 // set to true for any enries which are in the sysroot (this will
509 // naturally include any entries for which put_in_sysroot_ is true).
510 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
511 // passing SYSROOT to lrealpath.
513 add_sysroot(const char* sysroot
, const char* canonical_sysroot
);
515 // Get the directory name.
518 { return this->name_
; }
520 // Return whether this directory is in the sysroot.
522 is_in_sysroot() const
523 { return this->is_in_sysroot_
; }
527 bool put_in_sysroot_
;
531 class General_options
534 // NOTE: For every option that you add here, also consider if you
535 // should add it to Position_dependent_options.
536 DEFINE_special(help
, options::TWO_DASHES
, '\0',
537 N_("Report usage information"), NULL
);
538 DEFINE_special(version
, options::TWO_DASHES
, 'v',
539 N_("Report version information"), NULL
);
540 DEFINE_special(V
, options::EXACTLY_ONE_DASH
, '\0',
541 N_("Report version and target information"), NULL
);
543 // These options are sorted approximately so that for each letter in
544 // the alphabet, we show the option whose shortname is that letter
545 // (if any) and then every longname that starts with that letter (in
546 // alphabetical order). For both, lowercase sorts before uppercase.
547 // The -z options come last.
549 DEFINE_bool(allow_shlib_undefined
, options::TWO_DASHES
, '\0', false,
550 N_("Allow unresolved references in shared libraries"),
551 N_("Do not allow unresolved references in shared libraries"));
553 DEFINE_bool(as_needed
, options::TWO_DASHES
, '\0', false,
554 N_("Only set DT_NEEDED for dynamic libs if used"),
555 N_("Always DT_NEEDED for dynamic libs"));
557 // This should really be an "enum", but it's too easy for folks to
558 // forget to update the list as they add new targets. So we just
559 // accept any string. We'll fail later (when the string is parsed),
560 // if the target isn't actually supported.
561 DEFINE_string(format
, options::TWO_DASHES
, 'b', "elf",
562 N_("Set input format"), ("[elf,binary]"));
564 DEFINE_bool(Bdynamic
, options::ONE_DASH
, '\0', true,
565 N_("-l searches for shared libraries"), NULL
);
566 DEFINE_bool_alias(Bstatic
, Bdynamic
, options::ONE_DASH
, '\0',
567 N_("-l does not search for shared libraries"), NULL
,
570 DEFINE_bool(Bsymbolic
, options::ONE_DASH
, '\0', false,
571 N_("Bind defined symbols locally"), NULL
);
573 DEFINE_bool(Bsymbolic_functions
, options::ONE_DASH
, '\0', false,
574 N_("Bind defined function symbols locally"), NULL
);
576 DEFINE_optional_string(build_id
, options::TWO_DASHES
, '\0', "sha1",
577 N_("Generate build ID note"),
580 DEFINE_bool(check_sections
, options::TWO_DASHES
, '\0', true,
581 N_("Check segment addresses for overlaps (default)"),
582 N_("Do not check segment addresses for overlaps"));
584 DEFINE_bool(gc_sections
, options::TWO_DASHES
, '\0', true,
585 N_("(noop) Garbage collect sections"),
586 N_("(noop) Do not garbage collect sections"));
589 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
590 N_("Compress .debug_* sections in the output file"),
594 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
595 N_("Compress .debug_* sections in the output file"),
600 DEFINE_bool(define_common
, options::TWO_DASHES
, 'd', false,
601 N_("Define common symbols"),
602 N_("Do not define common symbols"));
603 DEFINE_bool(dc
, options::ONE_DASH
, '\0', false,
604 N_("Alias for -d"), NULL
);
605 DEFINE_bool(dp
, options::ONE_DASH
, '\0', false,
606 N_("Alias for -d"), NULL
);
608 DEFINE_string(debug
, options::TWO_DASHES
, '\0', "",
609 N_("Turn on debugging"),
610 N_("[all,files,script,task][,...]"));
612 DEFINE_special(defsym
, options::TWO_DASHES
, '\0',
613 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
615 DEFINE_optional_string(demangle
, options::TWO_DASHES
, '\0', NULL
,
616 N_("Demangle C++ symbols in log messages"),
619 DEFINE_bool(no_demangle
, options::TWO_DASHES
, '\0', false,
620 N_("Do not demangle C++ symbols in log messages"),
623 DEFINE_bool(detect_odr_violations
, options::TWO_DASHES
, '\0', false,
624 N_("Try to detect violations of the One Definition Rule"),
627 DEFINE_bool(dynamic_list_data
, options::TWO_DASHES
, '\0', false,
628 N_("Add data symbols to dynamic symbols"), NULL
);
630 DEFINE_bool(dynamic_list_cpp_new
, options::TWO_DASHES
, '\0', false,
631 N_("Add C++ operator new/delete to dynamic symbols"), NULL
);
633 DEFINE_bool(dynamic_list_cpp_typeinfo
, options::TWO_DASHES
, '\0', false,
634 N_("Add C++ typeinfo to dynamic symbols"), NULL
);
636 DEFINE_special(dynamic_list
, options::TWO_DASHES
, '\0',
637 N_("Read a list of dynamic symbols"), N_("FILE"));
639 DEFINE_string(entry
, options::TWO_DASHES
, 'e', NULL
,
640 N_("Set program start address"), N_("ADDRESS"));
642 DEFINE_bool(export_dynamic
, options::TWO_DASHES
, 'E', false,
643 N_("Export all dynamic symbols"),
644 N_("Do not export all dynamic symbols (default)"));
646 DEFINE_bool(eh_frame_hdr
, options::TWO_DASHES
, '\0', false,
647 N_("Create exception frame header"), NULL
);
649 DEFINE_bool(fatal_warnings
, options::TWO_DASHES
, '\0', false,
650 N_("Treat warnings as errors"),
651 N_("Do not treat warnings as errors"));
653 DEFINE_string(soname
, options::ONE_DASH
, 'h', NULL
,
654 N_("Set shared library name"), N_("FILENAME"));
656 DEFINE_double(hash_bucket_empty_fraction
, options::TWO_DASHES
, '\0', 0.0,
657 N_("Min fraction of empty buckets in dynamic hash"),
660 DEFINE_enum(hash_style
, options::TWO_DASHES
, '\0', "sysv",
661 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
662 {"sysv", "gnu", "both"});
664 DEFINE_string(dynamic_linker
, options::TWO_DASHES
, 'I', NULL
,
665 N_("Set dynamic linker path"), N_("PROGRAM"));
667 DEFINE_special(just_symbols
, options::TWO_DASHES
, '\0',
668 N_("Read only symbol values from FILE"), N_("FILE"));
670 DEFINE_special(library
, options::TWO_DASHES
, 'l',
671 N_("Search for library LIBNAME"), N_("LIBNAME"));
673 DEFINE_dirlist(library_path
, options::TWO_DASHES
, 'L',
674 N_("Add directory to search path"), N_("DIR"));
676 DEFINE_string(m
, options::EXACTLY_ONE_DASH
, 'm', "",
677 N_("Ignored for compatibility"), N_("EMULATION"));
679 DEFINE_bool(print_map
, options::TWO_DASHES
, 'M', false,
680 N_("Write map file on standard output"), NULL
);
681 DEFINE_string(Map
, options::ONE_DASH
, '\0', NULL
, N_("Write map file"),
684 DEFINE_bool(nmagic
, options::TWO_DASHES
, 'n', false,
685 N_("Do not page align data"), NULL
);
686 DEFINE_bool(omagic
, options::EXACTLY_TWO_DASHES
, 'N', false,
687 N_("Do not page align data, do not make text readonly"),
688 N_("Page align data, make text readonly"));
690 DEFINE_enable(new_dtags
, options::EXACTLY_TWO_DASHES
, '\0', false,
691 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
692 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
694 DEFINE_bool(noinhibit_exec
, options::TWO_DASHES
, '\0', false,
695 N_("Create an output file even if errors occur"), NULL
);
697 DEFINE_bool_alias(no_undefined
, defs
, options::TWO_DASHES
, '\0',
698 N_("Report undefined symbols (even with --shared)"),
701 DEFINE_string(output
, options::TWO_DASHES
, 'o', "a.out",
702 N_("Set output file name"), N_("FILE"));
704 DEFINE_uint(optimize
, options::EXACTLY_ONE_DASH
, 'O', 0,
705 N_("Optimize output file size"), N_("LEVEL"));
707 DEFINE_string(oformat
, options::EXACTLY_TWO_DASHES
, '\0', "elf",
708 N_("Set output format"), N_("[binary]"));
710 #ifdef ENABLE_PLUGINS
711 DEFINE_special(plugin
, options::TWO_DASHES
, '\0',
712 N_("Load a plugin library"), N_("PLUGIN"));
713 DEFINE_special(plugin_opt
, options::TWO_DASHES
, '\0',
714 N_("Pass an option to the plugin"), N_("OPTION"));
717 DEFINE_bool(preread_archive_symbols
, options::TWO_DASHES
, '\0', false,
718 N_("Preread archive symbols when multi-threaded"), NULL
);
720 DEFINE_string(print_symbol_counts
, options::TWO_DASHES
, '\0', NULL
,
721 N_("Print symbols defined and used for each input"),
724 DEFINE_bool(Qy
, options::EXACTLY_ONE_DASH
, '\0', false,
725 N_("Ignored for SVR4 compatibility"), NULL
);
727 DEFINE_bool(emit_relocs
, options::TWO_DASHES
, 'q', false,
728 N_("Generate relocations in output"), NULL
);
730 DEFINE_bool(relocatable
, options::EXACTLY_ONE_DASH
, 'r', false,
731 N_("Generate relocatable output"), NULL
);
733 DEFINE_bool(relax
, options::TWO_DASHES
, '\0', false,
734 N_("Relax branches on certain targets"), NULL
);
736 // -R really means -rpath, but can mean --just-symbols for
737 // compatibility with GNU ld. -rpath is always -rpath, so we list
739 DEFINE_special(R
, options::EXACTLY_ONE_DASH
, 'R',
740 N_("Add DIR to runtime search path"), N_("DIR"));
742 DEFINE_dirlist(rpath
, options::ONE_DASH
, '\0',
743 N_("Add DIR to runtime search path"), N_("DIR"));
745 DEFINE_dirlist(rpath_link
, options::TWO_DASHES
, '\0',
746 N_("Add DIR to link time shared library search path"),
749 DEFINE_bool(strip_all
, options::TWO_DASHES
, 's', false,
750 N_("Strip all symbols"), NULL
);
751 DEFINE_bool(strip_debug
, options::TWO_DASHES
, 'S', false,
752 N_("Strip debugging information"), NULL
);
753 DEFINE_bool(strip_debug_non_line
, options::TWO_DASHES
, '\0', false,
754 N_("Emit only debug line number information"), NULL
);
755 DEFINE_bool(strip_debug_gdb
, options::TWO_DASHES
, '\0', false,
756 N_("Strip debug symbols that are unused by gdb "
757 "(at least versions <= 6.7)"), NULL
);
758 DEFINE_bool(strip_lto_sections
, options::TWO_DASHES
, '\0', true,
759 N_("Strip LTO intermediate code sections"), NULL
);
761 DEFINE_bool(no_keep_memory
, options::TWO_DASHES
, 's', false,
762 N_("Use less memory and more disk I/O (included only for compatibility with GNU ld)"), NULL
);
764 DEFINE_bool(shared
, options::ONE_DASH
, '\0', false,
765 N_("Generate shared library"), NULL
);
767 DEFINE_bool(Bshareable
, options::ONE_DASH
, '\0', false,
768 N_("Generate shared library"), NULL
);
770 // This is not actually special in any way, but I need to give it
771 // a non-standard accessor-function name because 'static' is a keyword.
772 DEFINE_special(static, options::ONE_DASH
, '\0',
773 N_("Do not link against shared libraries"), NULL
);
775 DEFINE_bool(stats
, options::TWO_DASHES
, '\0', false,
776 N_("Print resource usage statistics"), NULL
);
778 DEFINE_string(sysroot
, options::TWO_DASHES
, '\0', "",
779 N_("Set target system root directory"), N_("DIR"));
781 DEFINE_bool(trace
, options::TWO_DASHES
, 't', false,
782 N_("Print the name of each input file"), NULL
);
784 DEFINE_special(script
, options::TWO_DASHES
, 'T',
785 N_("Read linker script"), N_("FILE"));
787 DEFINE_bool(threads
, options::TWO_DASHES
, '\0', false,
788 N_("Run the linker multi-threaded"),
789 N_("Do not run the linker multi-threaded"));
790 DEFINE_uint(thread_count
, options::TWO_DASHES
, '\0', 0,
791 N_("Number of threads to use"), N_("COUNT"));
792 DEFINE_uint(thread_count_initial
, options::TWO_DASHES
, '\0', 0,
793 N_("Number of threads to use in initial pass"), N_("COUNT"));
794 DEFINE_uint(thread_count_middle
, options::TWO_DASHES
, '\0', 0,
795 N_("Number of threads to use in middle pass"), N_("COUNT"));
796 DEFINE_uint(thread_count_final
, options::TWO_DASHES
, '\0', 0,
797 N_("Number of threads to use in final pass"), N_("COUNT"));
799 DEFINE_uint64(Tbss
, options::ONE_DASH
, '\0', -1U,
800 N_("Set the address of the bss segment"), N_("ADDRESS"));
801 DEFINE_uint64(Tdata
, options::ONE_DASH
, '\0', -1U,
802 N_("Set the address of the data segment"), N_("ADDRESS"));
803 DEFINE_uint64(Ttext
, options::ONE_DASH
, '\0', -1U,
804 N_("Set the address of the text segment"), N_("ADDRESS"));
806 DEFINE_set(undefined
, options::TWO_DASHES
, 'u',
807 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
809 DEFINE_bool(verbose
, options::TWO_DASHES
, '\0', false,
810 N_("Synonym for --debug=files"), NULL
);
812 DEFINE_special(version_script
, options::TWO_DASHES
, '\0',
813 N_("Read version script"), N_("FILE"));
815 DEFINE_bool(whole_archive
, options::TWO_DASHES
, '\0', false,
816 N_("Include all archive contents"),
817 N_("Include only needed archive contents"));
819 DEFINE_set(wrap
, options::TWO_DASHES
, '\0',
820 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
822 DEFINE_set(trace_symbol
, options::TWO_DASHES
, 'y',
823 N_("Trace references to symbol"), N_("SYMBOL"));
825 DEFINE_string(Y
, options::EXACTLY_ONE_DASH
, 'Y', "",
826 N_("Default search path for Solaris compatibility"),
829 DEFINE_special(start_group
, options::TWO_DASHES
, '(',
830 N_("Start a library search group"), NULL
);
831 DEFINE_special(end_group
, options::TWO_DASHES
, ')',
832 N_("End a library search group"), NULL
);
836 DEFINE_bool(combreloc
, options::DASH_Z
, '\0', true,
837 N_("Sort dynamic relocs"),
838 N_("Do not sort dynamic relocs"));
839 DEFINE_uint64(common_page_size
, options::DASH_Z
, '\0', 0,
840 N_("Set common page size to SIZE"), N_("SIZE"));
841 DEFINE_bool(defs
, options::DASH_Z
, '\0', false,
842 N_("Report undefined symbols (even with --shared)"),
844 DEFINE_bool(execstack
, options::DASH_Z
, '\0', false,
845 N_("Mark output as requiring executable stack"), NULL
);
846 DEFINE_uint64(max_page_size
, options::DASH_Z
, '\0', 0,
847 N_("Set maximum page size to SIZE"), N_("SIZE"));
848 DEFINE_bool(noexecstack
, options::DASH_Z
, '\0', false,
849 N_("Mark output as not requiring executable stack"), NULL
);
850 DEFINE_bool(initfirst
, options::DASH_Z
, '\0', false,
851 N_("Mark DSO to be initialized first at runtime"),
853 DEFINE_bool(interpose
, options::DASH_Z
, '\0', false,
854 N_("Mark object to interpose all DSOs but executable"),
856 DEFINE_bool(loadfltr
, options::DASH_Z
, '\0', false,
857 N_("Mark object requiring immediate process"),
859 DEFINE_bool(nodefaultlib
, options::DASH_Z
, '\0', false,
860 N_("Mark object not to use default search paths"),
862 DEFINE_bool(nodelete
, options::DASH_Z
, '\0', false,
863 N_("Mark DSO non-deletable at runtime"),
865 DEFINE_bool(nodlopen
, options::DASH_Z
, '\0', false,
866 N_("Mark DSO not available to dlopen"),
868 DEFINE_bool(nodump
, options::DASH_Z
, '\0', false,
869 N_("Mark DSO not available to dldump"),
871 DEFINE_bool(relro
, options::DASH_Z
, '\0', false,
872 N_("Where possible mark variables read-only after relocation"),
873 N_("Don't mark variables read-only after relocation"));
874 DEFINE_bool(origin
, options::DASH_Z
, '\0', false,
875 N_("Mark DSO to indicate that needs immediate $ORIGIN "
876 "processing at runtime"), NULL
);
879 typedef options::Dir_list Dir_list
;
883 // Does post-processing on flags, making sure they all have
884 // non-conflicting values. Also converts some flags from their
885 // "standard" types (string, etc), to another type (enum, DirList),
886 // which can be accessed via a separate method. Dies if it notices
890 // The macro defines output() (based on --output), but that's a
891 // generic name. Provide this alternative name, which is clearer.
893 output_file_name() const
894 { return this->output(); }
896 // This is not defined via a flag, but combines flags to say whether
897 // the output is position-independent or not.
899 output_is_position_independent() const
900 { return this->shared(); }
902 // Return true if the output is something that can be exec()ed, such
903 // as a static executable, or a position-dependent or
904 // position-independent executable, but not a dynamic library or an
907 output_is_executable() const
908 { return !this->shared() || this->output_is_pie(); }
910 // Return true if the output is a position-independent executable.
911 // This is currently not supported.
913 output_is_pie() const
916 // This would normally be static(), and defined automatically, but
917 // since static is a keyword, we need to come up with our own name.
922 // In addition to getting the input and output formats as a string
923 // (via format() and oformat()), we also give access as an enum.
928 // Straight binary format.
932 // Note: these functions are not very fast.
933 Object_format
format_enum() const;
934 Object_format
oformat_enum() const;
936 // These are the best way to get access to the execstack state,
937 // not execstack() and noexecstack() which are hard to use properly.
939 is_execstack_set() const
940 { return this->execstack_status_
!= EXECSTACK_FROM_INPUT
; }
943 is_stack_executable() const
944 { return this->execstack_status_
== EXECSTACK_YES
; }
946 // The --demangle option takes an optional string, and there is also
947 // a --no-demangle option. This is the best way to decide whether
948 // to demangle or not.
951 { return this->do_demangle_
; }
953 // Returns TRUE if any plugin libraries have been loaded.
956 { return this->plugins_
!= NULL
; }
958 // Return a pointer to the plugin manager.
961 { return this->plugins_
; }
963 // True iff SYMBOL was found in the file specified by dynamic-list.
965 in_dynamic_list(const char* symbol
) const
966 { return this->dynamic_list_
.version_script_info()->symbol_is_local(symbol
); }
969 // Don't copy this structure.
970 General_options(const General_options
&);
971 General_options
& operator=(const General_options
&);
973 // Whether to mark the stack as executable.
976 // Not set on command line.
977 EXECSTACK_FROM_INPUT
,
978 // Mark the stack as executable (-z execstack).
980 // Mark the stack as not executable (-z noexecstack).
985 set_execstack_status(Execstack value
)
986 { this->execstack_status_
= value
; }
989 set_do_demangle(bool value
)
990 { this->do_demangle_
= value
; }
993 set_static(bool value
)
996 // These are called by finalize() to set up the search-path correctly.
998 add_to_library_path_with_sysroot(const char* arg
)
999 { this->add_search_directory_to_library_path(Search_directory(arg
, true)); }
1001 // Apply any sysroot to the directory lists.
1005 // Add a plugin and its arguments to the list of plugins.
1007 add_plugin(const char *filename
);
1009 // Add a plugin option.
1011 add_plugin_option(const char* opt
);
1013 // Whether to mark the stack as executable.
1014 Execstack execstack_status_
;
1015 // Whether to do a static link.
1017 // Whether to do demangling.
1019 // List of plugin libraries.
1020 Plugin_manager
* plugins_
;
1021 // The parsed output of --dynamic-list files. For convenience in
1022 // script.cc, we store this as a Script_options object, even though
1023 // we only use a single Version_tree from it.
1024 Script_options dynamic_list_
;
1027 // The position-dependent options. We use this to store the state of
1028 // the commandline at a particular point in parsing for later
1029 // reference. For instance, if we see "ld --whole-archive foo.a
1030 // --no-whole-archive," we want to store the whole-archive option with
1031 // foo.a, so when the time comes to parse foo.a we know we should do
1032 // it in whole-archive mode. We could store all of General_options,
1033 // but that's big, so we just pick the subset of flags that actually
1034 // change in a position-dependent way.
1036 #define DEFINE_posdep(varname__, type__) \
1040 { return this->varname__##_; } \
1043 set_##varname__(type__ value) \
1044 { this->varname__##_ = value; } \
1048 class Position_dependent_options
1051 Position_dependent_options(const General_options
& options
1052 = Position_dependent_options::default_options_
)
1053 { copy_from_options(options
); }
1055 void copy_from_options(const General_options
& options
)
1057 this->set_as_needed(options
.as_needed());
1058 this->set_Bdynamic(options
.Bdynamic());
1059 this->set_format_enum(options
.format_enum());
1060 this->set_whole_archive(options
.whole_archive());
1063 DEFINE_posdep(as_needed
, bool);
1064 DEFINE_posdep(Bdynamic
, bool);
1065 DEFINE_posdep(format_enum
, General_options::Object_format
);
1066 DEFINE_posdep(whole_archive
, bool);
1069 // This is a General_options with everything set to its default
1070 // value. A Position_dependent_options created with no argument
1071 // will take its values from here.
1072 static General_options default_options_
;
1076 // A single file or library argument from the command line.
1078 class Input_file_argument
1081 // name: file name or library name
1082 // is_lib: true if name is a library name: that is, emits the leading
1083 // "lib" and trailing ".so"/".a" from the name
1084 // extra_search_path: an extra directory to look for the file, prior
1085 // to checking the normal library search path. If this is "",
1086 // then no extra directory is added.
1087 // just_symbols: whether this file only defines symbols.
1088 // options: The position dependent options at this point in the
1089 // command line, such as --whole-archive.
1090 Input_file_argument()
1091 : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false),
1095 Input_file_argument(const char* name
, bool is_lib
,
1096 const char* extra_search_path
,
1098 const Position_dependent_options
& options
)
1099 : name_(name
), is_lib_(is_lib
), extra_search_path_(extra_search_path
),
1100 just_symbols_(just_symbols
), options_(options
)
1103 // You can also pass in a General_options instance instead of a
1104 // Position_dependent_options. In that case, we extract the
1105 // position-independent vars from the General_options and only store
1107 Input_file_argument(const char* name
, bool is_lib
,
1108 const char* extra_search_path
,
1110 const General_options
& options
)
1111 : name_(name
), is_lib_(is_lib
), extra_search_path_(extra_search_path
),
1112 just_symbols_(just_symbols
), options_(options
)
1117 { return this->name_
.c_str(); }
1119 const Position_dependent_options
&
1121 { return this->options_
; }
1125 { return this->is_lib_
; }
1128 extra_search_path() const
1130 return (this->extra_search_path_
.empty()
1132 : this->extra_search_path_
.c_str());
1135 // Return whether we should only read symbols from this file.
1137 just_symbols() const
1138 { return this->just_symbols_
; }
1140 // Return whether this file may require a search using the -L
1143 may_need_search() const
1144 { return this->is_lib_
|| !this->extra_search_path_
.empty(); }
1147 // We use std::string, not const char*, here for convenience when
1148 // using script files, so that we do not have to preserve the string
1152 std::string extra_search_path_
;
1154 Position_dependent_options options_
;
1157 // A file or library, or a group, from the command line.
1159 class Input_argument
1162 // Create a file or library argument.
1163 explicit Input_argument(Input_file_argument file
)
1164 : is_file_(true), file_(file
), group_(NULL
)
1167 // Create a group argument.
1168 explicit Input_argument(Input_file_group
* group
)
1169 : is_file_(false), group_(group
)
1172 // Return whether this is a file.
1175 { return this->is_file_
; }
1177 // Return whether this is a group.
1180 { return !this->is_file_
; }
1182 // Return the information about the file.
1183 const Input_file_argument
&
1186 gold_assert(this->is_file_
);
1190 // Return the information about the group.
1191 const Input_file_group
*
1194 gold_assert(!this->is_file_
);
1195 return this->group_
;
1201 gold_assert(!this->is_file_
);
1202 return this->group_
;
1207 Input_file_argument file_
;
1208 Input_file_group
* group_
;
1211 // A group from the command line. This is a set of arguments within
1212 // --start-group ... --end-group.
1214 class Input_file_group
1217 typedef std::vector
<Input_argument
> Files
;
1218 typedef Files::const_iterator const_iterator
;
1224 // Add a file to the end of the group.
1226 add_file(const Input_file_argument
& arg
)
1227 { this->files_
.push_back(Input_argument(arg
)); }
1229 // Iterators to iterate over the group contents.
1233 { return this->files_
.begin(); }
1237 { return this->files_
.end(); }
1243 // A list of files from the command line or a script.
1245 class Input_arguments
1248 typedef std::vector
<Input_argument
> Input_argument_list
;
1249 typedef Input_argument_list::const_iterator const_iterator
;
1252 : input_argument_list_(), in_group_(false)
1257 add_file(const Input_file_argument
& arg
);
1259 // Start a group (the --start-group option).
1263 // End a group (the --end-group option).
1267 // Return whether we are currently in a group.
1270 { return this->in_group_
; }
1272 // The number of entries in the list.
1275 { return this->input_argument_list_
.size(); }
1277 // Iterators to iterate over the list of input files.
1281 { return this->input_argument_list_
.begin(); }
1285 { return this->input_argument_list_
.end(); }
1287 // Return whether the list is empty.
1290 { return this->input_argument_list_
.empty(); }
1293 Input_argument_list input_argument_list_
;
1298 // All the information read from the command line. These are held in
1299 // three separate structs: one to hold the options (--foo), one to
1300 // hold the filenames listed on the commandline, and one to hold
1301 // linker script information. This third is not a subset of the other
1302 // two because linker scripts can be specified either as options (via
1303 // -T) or as a file.
1308 typedef Input_arguments::const_iterator const_iterator
;
1312 // Process the command line options. This will exit with an
1313 // appropriate error message if an unrecognized option is seen.
1315 process(int argc
, const char** argv
);
1317 // Process one command-line option. This takes the index of argv to
1318 // process, and returns the index for the next option. no_more_options
1319 // is set to true if argv[i] is "--".
1321 process_one_option(int argc
, const char** argv
, int i
,
1322 bool* no_more_options
);
1324 // Get the general options.
1325 const General_options
&
1327 { return this->options_
; }
1329 // Get the position dependent options.
1330 const Position_dependent_options
&
1331 position_dependent_options() const
1332 { return this->position_options_
; }
1334 // Get the linker-script options.
1337 { return this->script_options_
; }
1339 // Get the version-script options: a convenience routine.
1340 const Version_script_info
&
1341 version_script() const
1342 { return *this->script_options_
.version_script_info(); }
1344 // Get the input files.
1347 { return this->inputs_
; }
1349 // The number of input files.
1351 number_of_input_files() const
1352 { return this->inputs_
.size(); }
1354 // Iterators to iterate over the list of input files.
1358 { return this->inputs_
.begin(); }
1362 { return this->inputs_
.end(); }
1365 Command_line(const Command_line
&);
1366 Command_line
& operator=(const Command_line
&);
1368 General_options options_
;
1369 Position_dependent_options position_options_
;
1370 Script_options script_options_
;
1371 Input_arguments inputs_
;
1374 } // End namespace gold.
1376 #endif // !defined(GOLD_OPTIONS_H)