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
;
58 // The nested namespace is to contain all the global variables and
59 // structs that need to be defined in the .h file, but do not need to
60 // be used outside this class.
63 typedef std::vector
<Search_directory
> Dir_list
;
65 // These routines convert from a string option to various types.
66 // Each gives a fatal error if it cannot parse the argument.
69 parse_bool(const char* option_name
, const char* arg
, bool* retval
);
72 parse_uint(const char* option_name
, const char* arg
, int* retval
);
75 parse_uint64(const char* option_name
, const char* arg
, uint64_t* retval
);
78 parse_double(const char* option_name
, const char* arg
, double* retval
);
81 parse_string(const char* option_name
, const char* arg
, const char** retval
);
84 parse_optional_string(const char* option_name
, const char* arg
,
88 parse_dirlist(const char* option_name
, const char* arg
, Dir_list
* retval
);
91 parse_choices(const char* option_name
, const char* arg
, const char** retval
,
92 const char* choices
[], int num_choices
);
96 // Most options have both a shortname (one letter) and a longname.
97 // This enum controls how many dashes are expected for longname access
98 // -- shortnames always use one dash. Most longnames will accept
99 // either one dash or two; the only difference between ONE_DASH and
100 // TWO_DASHES is how we print the option in --help. However, some
101 // longnames require two dashes, and some require only one. The
102 // special value DASH_Z means that the option is preceded by "-z".
105 ONE_DASH
, TWO_DASHES
, EXACTLY_ONE_DASH
, EXACTLY_TWO_DASHES
, DASH_Z
108 // LONGNAME is the long-name of the option with dashes converted to
109 // underscores, or else the short-name if the option has no long-name.
110 // It is never the empty string.
111 // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
112 // SHORTNAME is the short-name of the option, as a char, or '\0' if the
113 // option has no short-name. If the option has no long-name, you
114 // should specify the short-name in *both* VARNAME and here.
115 // DEFAULT_VALUE is the value of the option if not specified on the
116 // commandline, as a string.
117 // HELPSTRING is the descriptive text used with the option via --help
118 // HELPARG is how you define the argument to the option.
119 // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
120 // HELPARG should be NULL iff the option is a bool and takes no arg.
121 // OPTIONAL_ARG is true if this option takes an optional argument. An
122 // optional argument must be specifid as --OPTION=VALUE, not
124 // READER provides parse_to_value, which is a function that will convert
125 // a char* argument into the proper type and store it in some variable.
126 // A One_option struct initializes itself with the global list of options
127 // at constructor time, so be careful making one of these.
130 std::string longname
;
133 const char* default_value
;
134 const char* helpstring
;
139 One_option(const char* ln
, Dashes d
, char sn
, const char* dv
,
140 const char* hs
, const char* ha
, bool oa
, Struct_var
* r
)
141 : longname(ln
), dashes(d
), shortname(sn
), default_value(dv
? dv
: ""),
142 helpstring(hs
), helparg(ha
), optional_arg(oa
), reader(r
)
144 // In longname, we convert all underscores to dashes, since GNU
145 // style uses dashes in option names. longname is likely to have
146 // underscores in it because it's also used to declare a C++
148 const char* pos
= strchr(this->longname
.c_str(), '_');
149 for (; pos
; pos
= strchr(pos
, '_'))
150 this->longname
[pos
- this->longname
.c_str()] = '-';
152 // We only register ourselves if our helpstring is not NULL. This
153 // is to support the "no-VAR" boolean variables, which we
154 // conditionally turn on by defining "no-VAR" help text.
155 if (this->helpstring
)
156 this->register_option();
159 // This option takes an argument iff helparg is not NULL.
161 takes_argument() const
162 { return this->helparg
!= NULL
; }
164 // Whether the argument is optional.
166 takes_optional_argument() const
167 { return this->optional_arg
; }
169 // Register this option with the global list of options.
173 // Print this option to stdout (used with --help).
178 // All options have a Struct_##varname that inherits from this and
179 // actually implements parse_to_value for that option.
182 // OPTION: the name of the option as specified on the commandline,
183 // including leading dashes, and any text following the option:
184 // "-O", "--defsym=mysym=0x1000", etc.
185 // ARG: the arg associated with this option, or NULL if the option
186 // takes no argument: "2", "mysym=0x1000", etc.
187 // CMDLINE: the global Command_line object. Used by DEFINE_special.
188 // OPTIONS: the global General_options object. Used by DEFINE_special.
190 parse_to_value(const char* option
, const char* arg
,
191 Command_line
* cmdline
, General_options
* options
) = 0;
193 ~Struct_var() // To make gcc happy.
197 // This is for "special" options that aren't of any predefined type.
198 struct Struct_special
: public Struct_var
200 // If you change this, change the parse-fn in DEFINE_special as well.
201 typedef void (General_options::*Parse_function
)(const char*, const char*,
203 Struct_special(const char* varname
, Dashes dashes
, char shortname
,
204 Parse_function parse_function
,
205 const char* helpstring
, const char* helparg
)
206 : option(varname
, dashes
, shortname
, "", helpstring
, helparg
, false, this),
207 parse(parse_function
)
210 void parse_to_value(const char* option
, const char* arg
,
211 Command_line
* cmdline
, General_options
* options
)
212 { (options
->*(this->parse
))(option
, arg
, cmdline
); }
215 Parse_function parse
;
218 } // End namespace options.
221 // These are helper macros use by DEFINE_uint64/etc below.
222 // This macro is used inside the General_options_ class, so defines
223 // var() and set_var() as General_options methods. Arguments as are
224 // for the constructor for One_option. param_type__ is the same as
225 // type__ for built-in types, and "const type__ &" otherwise.
226 #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
227 default_value_as_string__, helpstring__, helparg__, \
228 optional_arg__, type__, param_type__, parse_fn__) \
232 { return this->varname__##_.value; } \
235 user_set_##varname__() const \
236 { return this->varname__##_.user_set_via_option; } \
239 struct Struct_##varname__ : public options::Struct_var \
241 Struct_##varname__() \
242 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
243 helpstring__, helparg__, optional_arg__, this), \
244 user_set_via_option(false), value(default_value__) \
248 parse_to_value(const char* option_name, const char* arg, \
249 Command_line*, General_options*) \
251 parse_fn__(option_name, arg, &this->value); \
252 this->user_set_via_option = true; \
255 options::One_option option; \
256 bool user_set_via_option; \
259 Struct_##varname__ varname__##_; \
261 set_##varname__(param_type__ value) \
262 { this->varname__##_.value = value; }
264 // These macros allow for easy addition of a new commandline option.
266 // If no_helpstring__ is not NULL, then in addition to creating
267 // VARNAME, we also create an option called no-VARNAME.
268 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
269 helpstring__, no_helpstring__) \
270 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
271 default_value__ ? "true" : "false", helpstring__, NULL, \
272 false, bool, bool, options::parse_bool) \
273 struct Struct_no_##varname__ : public options::Struct_var \
275 Struct_no_##varname__() : option("no-" #varname__, dashes__, '\0', \
276 default_value__ ? "false" : "true", \
277 no_helpstring__, NULL, false, this) \
281 parse_to_value(const char*, const char*, \
282 Command_line*, General_options* options) \
283 { options->set_##varname__(false); } \
285 options::One_option option; \
287 Struct_no_##varname__ no_##varname__##_initializer_
289 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
290 helpstring__, helparg__) \
291 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
292 #default_value__, helpstring__, helparg__, false, \
293 int, int, options::parse_uint)
295 #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
296 helpstring__, helparg__) \
297 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
298 #default_value__, helpstring__, helparg__, false, \
299 uint64_t, uint64_t, options::parse_uint64)
301 #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
302 helpstring__, helparg__) \
303 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
304 #default_value__, helpstring__, helparg__, false, \
305 double, double, options::parse_double)
307 #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
308 helpstring__, helparg__) \
309 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
310 default_value__, helpstring__, helparg__, false, \
311 const char*, const char*, options::parse_string)
313 // This is like DEFINE_string, but we convert each occurrence to a
314 // Search_directory and store it in a vector. Thus we also have the
315 // add_to_VARNAME() method, to append to the vector.
316 #define DEFINE_dirlist(varname__, dashes__, shortname__, \
317 helpstring__, helparg__) \
318 DEFINE_var(varname__, dashes__, shortname__, , \
319 "", helpstring__, helparg__, false, options::Dir_list, \
320 const options::Dir_list&, options::parse_dirlist) \
322 add_to_##varname__(const char* new_value) \
323 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
325 add_search_directory_to_##varname__(const Search_directory& dir) \
326 { this->varname__##_.value.push_back(dir); }
328 // When you have a list of possible values (expressed as string)
329 // After helparg__ should come an initializer list, like
330 // {"foo", "bar", "baz"}
331 #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
332 helpstring__, helparg__, ...) \
333 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
334 default_value__, helpstring__, helparg__, false, \
335 const char*, const char*, parse_choices_##varname__) \
337 static void parse_choices_##varname__(const char* option_name, \
339 const char** retval) { \
340 const char* choices[] = __VA_ARGS__; \
341 options::parse_choices(option_name, arg, retval, \
342 choices, sizeof(choices) / sizeof(*choices)); \
345 // This is used for non-standard flags. It defines no functions; it
346 // just calls General_options::parse_VARNAME whenever the flag is
347 // seen. We declare parse_VARNAME as a static member of
348 // General_options; you are responsible for defining it there.
349 // helparg__ should be NULL iff this special-option is a boolean.
350 #define DEFINE_special(varname__, dashes__, shortname__, \
351 helpstring__, helparg__) \
353 void parse_##varname__(const char* option, const char* arg, \
354 Command_line* inputs); \
355 struct Struct_##varname__ : public options::Struct_special \
357 Struct_##varname__() \
358 : options::Struct_special(#varname__, dashes__, shortname__, \
359 &General_options::parse_##varname__, \
360 helpstring__, helparg__) \
363 Struct_##varname__ varname__##_initializer_
365 // An option that takes an optional string argument. If the option is
366 // used with no argument, the value will be the default, and
367 // user_set_via_option will be true.
368 #define DEFINE_optional_string(varname__, dashes__, shortname__, \
370 helpstring__, helparg__) \
371 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
372 default_value__, helpstring__, helparg__, true, \
373 const char*, const char*, options::parse_optional_string)
375 // A directory to search. For each directory we record whether it is
376 // in the sysroot. We need to know this so that, if a linker script
377 // is found within the sysroot, we will apply the sysroot to any files
378 // named by that script.
380 class Search_directory
383 // We need a default constructor because we put this in a
386 : name_(NULL
), put_in_sysroot_(false), is_in_sysroot_(false)
389 // This is the usual constructor.
390 Search_directory(const char* name
, bool put_in_sysroot
)
391 : name_(name
), put_in_sysroot_(put_in_sysroot
), is_in_sysroot_(false)
393 if (this->name_
.empty())
397 // This is called if we have a sysroot. The sysroot is prefixed to
398 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
399 // set to true for any enries which are in the sysroot (this will
400 // naturally include any entries for which put_in_sysroot_ is true).
401 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
402 // passing SYSROOT to lrealpath.
404 add_sysroot(const char* sysroot
, const char* canonical_sysroot
);
406 // Get the directory name.
409 { return this->name_
; }
411 // Return whether this directory is in the sysroot.
413 is_in_sysroot() const
414 { return this->is_in_sysroot_
; }
418 bool put_in_sysroot_
;
422 class General_options
425 // NOTE: For every option that you add here, also consider if you
426 // should add it to Position_dependent_options.
427 DEFINE_special(help
, options::TWO_DASHES
, '\0',
428 N_("Report usage information"), NULL
);
429 DEFINE_special(version
, options::TWO_DASHES
, 'v',
430 N_("Report version information"), NULL
);
432 // These options are sorted approximately so that for each letter in
433 // the alphabet, we show the option whose shortname is that letter
434 // (if any) and then every longname that starts with that letter (in
435 // alphabetical order). For both, lowercase sorts before uppercase.
436 // The -z options come last.
438 DEFINE_bool(allow_shlib_undefined
, options::TWO_DASHES
, '\0', false,
439 N_("Allow unresolved references in shared libraries"),
440 N_("Do not allow unresolved references in shared libraries"));
442 DEFINE_bool(as_needed
, options::TWO_DASHES
, '\0', false,
443 N_("Only set DT_NEEDED for dynamic libs if used"),
444 N_("Always DT_NEEDED for dynamic libs"));
446 // This should really be an "enum", but it's too easy for folks to
447 // forget to update the list as they add new targets. So we just
448 // accept any string. We'll fail later (when the string is parsed),
449 // if the target isn't actually supported.
450 DEFINE_string(format
, options::TWO_DASHES
, 'b', "elf",
451 N_("Set input format"), ("[elf,binary]"));
453 DEFINE_bool(Bdynamic
, options::ONE_DASH
, '\0', true,
454 N_("-l searches for shared libraries"), NULL
);
455 // Bstatic affects the same variable as Bdynamic, so we have to use
456 // the "special" macro to make that happen.
457 DEFINE_special(Bstatic
, options::ONE_DASH
, '\0',
458 N_("-l does not search for shared libraries"), NULL
);
460 DEFINE_bool(Bsymbolic
, options::ONE_DASH
, '\0', false,
461 N_("Bind defined symbols locally"), NULL
);
463 DEFINE_optional_string(build_id
, options::TWO_DASHES
, '\0', "sha1",
464 N_("Generate build ID note"),
468 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
469 N_("Compress .debug_* sections in the output file"),
473 DEFINE_enum(compress_debug_sections
, options::TWO_DASHES
, '\0', "none",
474 N_("Compress .debug_* sections in the output file"),
479 DEFINE_bool(define_common
, options::TWO_DASHES
, 'd', false,
480 N_("Define common symbols"),
481 N_("Do not define common symbols"));
482 DEFINE_bool(dc
, options::ONE_DASH
, '\0', false,
483 N_("Alias for -d"), NULL
);
484 DEFINE_bool(dp
, options::ONE_DASH
, '\0', false,
485 N_("Alias for -d"), NULL
);
487 DEFINE_string(debug
, options::TWO_DASHES
, '\0', "",
488 N_("Turn on debugging"),
489 N_("[all,files,script,task][,...]"));
491 DEFINE_special(defsym
, options::TWO_DASHES
, '\0',
492 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
494 DEFINE_optional_string(demangle
, options::TWO_DASHES
, '\0', NULL
,
495 N_("Demangle C++ symbols in log messages"),
498 DEFINE_bool(no_demangle
, options::TWO_DASHES
, '\0', false,
499 N_("Do not demangle C++ symbols in log messages"),
502 DEFINE_bool(detect_odr_violations
, options::TWO_DASHES
, '\0', false,
503 N_("Try to detect violations of the One Definition Rule"),
506 DEFINE_string(entry
, options::TWO_DASHES
, 'e', NULL
,
507 N_("Set program start address"), N_("ADDRESS"));
509 DEFINE_bool(export_dynamic
, options::TWO_DASHES
, 'E', false,
510 N_("Export all dynamic symbols"), NULL
);
512 DEFINE_bool(eh_frame_hdr
, options::TWO_DASHES
, '\0', false,
513 N_("Create exception frame header"), NULL
);
515 DEFINE_string(soname
, options::ONE_DASH
, 'h', NULL
,
516 N_("Set shared library name"), N_("FILENAME"));
518 DEFINE_double(hash_bucket_empty_fraction
, options::TWO_DASHES
, '\0', 0.0,
519 N_("Min fraction of empty buckets in dynamic hash"),
522 DEFINE_enum(hash_style
, options::TWO_DASHES
, '\0', "sysv",
523 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
524 {"sysv", "gnu", "both"});
526 DEFINE_string(dynamic_linker
, options::TWO_DASHES
, 'I', NULL
,
527 N_("Set dynamic linker path"), N_("PROGRAM"));
529 DEFINE_special(just_symbols
, options::TWO_DASHES
, '\0',
530 N_("Read only symbol values from FILE"), N_("FILE"));
532 DEFINE_special(library
, options::TWO_DASHES
, 'l',
533 N_("Search for library LIBNAME"), N_("LIBNAME"));
535 DEFINE_dirlist(library_path
, options::TWO_DASHES
, 'L',
536 N_("Add directory to search path"), N_("DIR"));
538 DEFINE_string(m
, options::EXACTLY_ONE_DASH
, 'm', "",
539 N_("Ignored for compatibility"), N_("EMULATION"));
541 DEFINE_string(output
, options::TWO_DASHES
, 'o', "a.out",
542 N_("Set output file name"), N_("FILE"));
544 DEFINE_uint(optimize
, options::EXACTLY_ONE_DASH
, 'O', 0,
545 N_("Optimize output file size"), N_("LEVEL"));
547 DEFINE_string(oformat
, options::EXACTLY_TWO_DASHES
, '\0', "elf",
548 N_("Set output format"), N_("[binary]"));
550 DEFINE_bool(emit_relocs
, options::TWO_DASHES
, 'q', false,
551 N_("Generate relocations in output"), NULL
);
553 DEFINE_bool(relocatable
, options::EXACTLY_ONE_DASH
, 'r', false,
554 N_("Generate relocatable output"), NULL
);
556 // -R really means -rpath, but can mean --just-symbols for
557 // compatibility with GNU ld. -rpath is always -rpath, so we list
559 DEFINE_special(R
, options::EXACTLY_ONE_DASH
, 'R',
560 N_("Add DIR to runtime search path"), N_("DIR"));
562 DEFINE_dirlist(rpath
, options::ONE_DASH
, '\0',
563 N_("Add DIR to runtime search path"), N_("DIR"));
565 DEFINE_dirlist(rpath_link
, options::TWO_DASHES
, '\0',
566 N_("Add DIR to link time shared library search path"),
569 DEFINE_bool(strip_all
, options::TWO_DASHES
, 's', false,
570 N_("Strip all symbols"), NULL
);
571 DEFINE_bool(strip_debug
, options::TWO_DASHES
, 'S', false,
572 N_("Strip debugging information"), NULL
);
573 DEFINE_bool(strip_debug_gdb
, options::TWO_DASHES
, '\0', false,
574 N_("Strip debug symbols that are unused by gdb "
575 "(at least versions <= 6.7)"), NULL
);
577 DEFINE_bool(shared
, options::ONE_DASH
, '\0', false,
578 N_("Generate shared library"), NULL
);
580 // This is not actually special in any way, but I need to give it
581 // a non-standard accessor-function name because 'static' is a keyword.
582 DEFINE_special(static, options::ONE_DASH
, '\0',
583 N_("Do not link against shared libraries"), NULL
);
585 DEFINE_bool(stats
, options::TWO_DASHES
, '\0', false,
586 N_("Print resource usage statistics"), NULL
);
588 DEFINE_string(sysroot
, options::TWO_DASHES
, '\0', "",
589 N_("Set target system root directory"), N_("DIR"));
591 DEFINE_special(script
, options::TWO_DASHES
, 'T',
592 N_("Read linker script"), N_("FILE"));
594 DEFINE_bool(threads
, options::TWO_DASHES
, '\0', false,
595 N_("Run the linker multi-threaded"),
596 N_("Do not run the linker multi-threaded"));
597 DEFINE_uint(thread_count
, options::TWO_DASHES
, '\0', 0,
598 N_("Number of threads to use"), N_("COUNT"));
599 DEFINE_uint(thread_count_initial
, options::TWO_DASHES
, '\0', 0,
600 N_("Number of threads to use in initial pass"), N_("COUNT"));
601 DEFINE_uint(thread_count_middle
, options::TWO_DASHES
, '\0', 0,
602 N_("Number of threads to use in middle pass"), N_("COUNT"));
603 DEFINE_uint(thread_count_final
, options::TWO_DASHES
, '\0', 0,
604 N_("Number of threads to use in final pass"), N_("COUNT"));
606 DEFINE_uint64(Tbss
, options::ONE_DASH
, '\0', -1U,
607 N_("Set the address of the bss segment"), N_("ADDRESS"));
608 DEFINE_uint64(Tdata
, options::ONE_DASH
, '\0', -1U,
609 N_("Set the address of the data segment"), N_("ADDRESS"));
610 DEFINE_uint64(Ttext
, options::ONE_DASH
, '\0', -1U,
611 N_("Set the address of the text segment"), N_("ADDRESS"));
613 DEFINE_bool(verbose
, options::TWO_DASHES
, '\0', false,
614 N_("Synonym for --debug=files"), NULL
);
616 DEFINE_special(version_script
, options::TWO_DASHES
, '\0',
617 N_("Read version script"), N_("FILE"));
619 DEFINE_bool(whole_archive
, options::TWO_DASHES
, '\0', false,
620 N_("Include all archive contents"),
621 N_("Include only needed archive contents"));
623 DEFINE_special(start_group
, options::TWO_DASHES
, '(',
624 N_("Start a library search group"), NULL
);
625 DEFINE_special(end_group
, options::TWO_DASHES
, ')',
626 N_("End a library search group"), NULL
);
630 // Both execstack and noexecstack differ from the default execstack_
631 // value, so we need to use different variables for them.
632 DEFINE_uint64(common_page_size
, options::DASH_Z
, '\0', 0,
633 N_("Set common page size to SIZE"), N_("SIZE"));
634 DEFINE_bool(defs
, options::DASH_Z
, '\0', false,
635 N_("Report undefined symbols (even with --shared)"),
637 DEFINE_bool(execstack
, options::DASH_Z
, '\0', false,
638 N_("Mark output as requiring executable stack"), NULL
);
639 DEFINE_uint64(max_page_size
, options::DASH_Z
, '\0', 0,
640 N_("Set maximum page size to SIZE"), N_("SIZE"));
641 DEFINE_bool(noexecstack
, options::DASH_Z
, '\0', false,
642 N_("Mark output as not requiring executable stack"), NULL
);
645 typedef options::Dir_list Dir_list
;
649 // Does post-processing on flags, making sure they all have
650 // non-conflicting values. Also converts some flags from their
651 // "standard" types (string, etc), to another type (enum, DirList),
652 // which can be accessed via a separate method. Dies if it notices
656 // The macro defines output() (based on --output), but that's a
657 // generic name. Provide this alternative name, which is clearer.
659 output_file_name() const
660 { return this->output(); }
662 // This is not defined via a flag, but combines flags to say whether
663 // the output is position-independent or not.
665 output_is_position_independent() const
666 { return this->shared(); }
668 // This would normally be static(), and defined automatically, but
669 // since static is a keyword, we need to come up with our own name.
674 // In addition to getting the input and output formats as a string
675 // (via format() and oformat()), we also give access as an enum.
680 // Straight binary format.
684 // Note: these functions are not very fast.
685 Object_format
format_enum() const;
686 Object_format
oformat_enum() const;
688 // These are the best way to get access to the execstack state,
689 // not execstack() and noexecstack() which are hard to use properly.
691 is_execstack_set() const
692 { return this->execstack_status_
!= EXECSTACK_FROM_INPUT
; }
695 is_stack_executable() const
696 { return this->execstack_status_
== EXECSTACK_YES
; }
698 // The --demangle option takes an optional string, and there is also
699 // a --no-demangle option. This is the best way to decide whether
700 // to demangle or not.
703 { return this->do_demangle_
; }
706 // Don't copy this structure.
707 General_options(const General_options
&);
708 General_options
& operator=(const General_options
&);
710 // Whether to mark the stack as executable.
713 // Not set on command line.
714 EXECSTACK_FROM_INPUT
,
715 // Mark the stack as executable (-z execstack).
717 // Mark the stack as not executable (-z noexecstack).
722 set_execstack_status(Execstack value
)
723 { this->execstack_status_
= value
; }
726 set_do_demangle(bool value
)
727 { this->do_demangle_
= value
; }
730 set_static(bool value
)
733 // These are called by finalize() to set up the search-path correctly.
735 add_to_library_path_with_sysroot(const char* arg
)
736 { this->add_search_directory_to_library_path(Search_directory(arg
, true)); }
738 // Apply any sysroot to the directory lists.
742 // Whether to mark the stack as executable.
743 Execstack execstack_status_
;
744 // Whether to do a static link.
746 // Whether to do demangling.
750 // The position-dependent options. We use this to store the state of
751 // the commandline at a particular point in parsing for later
752 // reference. For instance, if we see "ld --whole-archive foo.a
753 // --no-whole-archive," we want to store the whole-archive option with
754 // foo.a, so when the time comes to parse foo.a we know we should do
755 // it in whole-archive mode. We could store all of General_options,
756 // but that's big, so we just pick the subset of flags that actually
757 // change in a position-dependent way.
759 #define DEFINE_posdep(varname__, type__) \
763 { return this->varname__##_; } \
766 set_##varname__(type__ value) \
767 { this->varname__##_ = value; } \
771 class Position_dependent_options
774 Position_dependent_options(const General_options
& options
775 = Position_dependent_options::default_options_
)
776 { copy_from_options(options
); }
778 void copy_from_options(const General_options
& options
)
780 this->set_as_needed(options
.as_needed());
781 this->set_Bdynamic(options
.Bdynamic());
782 this->set_format_enum(options
.format_enum());
783 this->set_whole_archive(options
.whole_archive());
786 DEFINE_posdep(as_needed
, bool);
787 DEFINE_posdep(Bdynamic
, bool);
788 DEFINE_posdep(format_enum
, General_options::Object_format
);
789 DEFINE_posdep(whole_archive
, bool);
792 // This is a General_options with everything set to its default
793 // value. A Position_dependent_options created with no argument
794 // will take its values from here.
795 static General_options default_options_
;
799 // A single file or library argument from the command line.
801 class Input_file_argument
804 // name: file name or library name
805 // is_lib: true if name is a library name: that is, emits the leading
806 // "lib" and trailing ".so"/".a" from the name
807 // extra_search_path: an extra directory to look for the file, prior
808 // to checking the normal library search path. If this is "",
809 // then no extra directory is added.
810 // just_symbols: whether this file only defines symbols.
811 // options: The position dependent options at this point in the
812 // command line, such as --whole-archive.
813 Input_file_argument()
814 : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false),
818 Input_file_argument(const char* name
, bool is_lib
,
819 const char* extra_search_path
,
821 const Position_dependent_options
& options
)
822 : name_(name
), is_lib_(is_lib
), extra_search_path_(extra_search_path
),
823 just_symbols_(just_symbols
), options_(options
)
826 // You can also pass in a General_options instance instead of a
827 // Position_dependent_options. In that case, we extract the
828 // position-independent vars from the General_options and only store
830 Input_file_argument(const char* name
, bool is_lib
,
831 const char* extra_search_path
,
833 const General_options
& options
)
834 : name_(name
), is_lib_(is_lib
), extra_search_path_(extra_search_path
),
835 just_symbols_(just_symbols
), options_(options
)
840 { return this->name_
.c_str(); }
842 const Position_dependent_options
&
844 { return this->options_
; }
848 { return this->is_lib_
; }
851 extra_search_path() const
853 return (this->extra_search_path_
.empty()
855 : this->extra_search_path_
.c_str());
858 // Return whether we should only read symbols from this file.
861 { return this->just_symbols_
; }
863 // Return whether this file may require a search using the -L
866 may_need_search() const
867 { return this->is_lib_
|| !this->extra_search_path_
.empty(); }
870 // We use std::string, not const char*, here for convenience when
871 // using script files, so that we do not have to preserve the string
875 std::string extra_search_path_
;
877 Position_dependent_options options_
;
880 // A file or library, or a group, from the command line.
885 // Create a file or library argument.
886 explicit Input_argument(Input_file_argument file
)
887 : is_file_(true), file_(file
), group_(NULL
)
890 // Create a group argument.
891 explicit Input_argument(Input_file_group
* group
)
892 : is_file_(false), group_(group
)
895 // Return whether this is a file.
898 { return this->is_file_
; }
900 // Return whether this is a group.
903 { return !this->is_file_
; }
905 // Return the information about the file.
906 const Input_file_argument
&
909 gold_assert(this->is_file_
);
913 // Return the information about the group.
914 const Input_file_group
*
917 gold_assert(!this->is_file_
);
924 gold_assert(!this->is_file_
);
930 Input_file_argument file_
;
931 Input_file_group
* group_
;
934 // A group from the command line. This is a set of arguments within
935 // --start-group ... --end-group.
937 class Input_file_group
940 typedef std::vector
<Input_argument
> Files
;
941 typedef Files::const_iterator const_iterator
;
947 // Add a file to the end of the group.
949 add_file(const Input_file_argument
& arg
)
950 { this->files_
.push_back(Input_argument(arg
)); }
952 // Iterators to iterate over the group contents.
956 { return this->files_
.begin(); }
960 { return this->files_
.end(); }
966 // A list of files from the command line or a script.
968 class Input_arguments
971 typedef std::vector
<Input_argument
> Input_argument_list
;
972 typedef Input_argument_list::const_iterator const_iterator
;
975 : input_argument_list_(), in_group_(false)
980 add_file(const Input_file_argument
& arg
);
982 // Start a group (the --start-group option).
986 // End a group (the --end-group option).
990 // Return whether we are currently in a group.
993 { return this->in_group_
; }
995 // The number of entries in the list.
998 { return this->input_argument_list_
.size(); }
1000 // Iterators to iterate over the list of input files.
1004 { return this->input_argument_list_
.begin(); }
1008 { return this->input_argument_list_
.end(); }
1010 // Return whether the list is empty.
1013 { return this->input_argument_list_
.empty(); }
1016 Input_argument_list input_argument_list_
;
1021 // All the information read from the command line. These are held in
1022 // three separate structs: one to hold the options (--foo), one to
1023 // hold the filenames listed on the commandline, and one to hold
1024 // linker script information. This third is not a subset of the other
1025 // two because linker scripts can be specified either as options (via
1026 // -T) or as a file.
1031 typedef Input_arguments::const_iterator const_iterator
;
1035 // Process the command line options. This will exit with an
1036 // appropriate error message if an unrecognized option is seen.
1038 process(int argc
, const char** argv
);
1040 // Process one command-line option. This takes the index of argv to
1041 // process, and returns the index for the next option. no_more_options
1042 // is set to true if argv[i] is "--".
1044 process_one_option(int argc
, const char** argv
, int i
,
1045 bool* no_more_options
);
1047 // Get the general options.
1048 const General_options
&
1050 { return this->options_
; }
1052 // Get the position dependent options.
1053 const Position_dependent_options
&
1054 position_dependent_options() const
1055 { return this->position_options_
; }
1057 // Get the linker-script options.
1060 { return this->script_options_
; }
1062 // Get the version-script options: a convenience routine.
1063 const Version_script_info
&
1064 version_script() const
1065 { return *this->script_options_
.version_script_info(); }
1067 // Get the input files.
1070 { return this->inputs_
; }
1072 // The number of input files.
1074 number_of_input_files() const
1075 { return this->inputs_
.size(); }
1077 // Iterators to iterate over the list of input files.
1081 { return this->inputs_
.begin(); }
1085 { return this->inputs_
.end(); }
1088 Command_line(const Command_line
&);
1089 Command_line
& operator=(const Command_line
&);
1091 General_options options_
;
1092 Position_dependent_options position_options_
;
1093 Script_options script_options_
;
1094 Input_arguments inputs_
;
1097 } // End namespace gold.
1099 #endif // !defined(GOLD_OPTIONS_H)