gold: Local modification to add --relocatable synonym
[dragonfly.git] / contrib / binutils-2.21 / gold / options.h
CommitLineData
5e4e6ec1
SW
1// options.h -- handle command line options for gold -*- C++ -*-
2
3// Copyright 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
4// Written by Ian Lance Taylor <iant@google.com>.
5
6// This file is part of gold.
7
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.
12
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.
17
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.
22
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.
27// Command_line
28// Everything we get from the command line -- the General_options
29// plus the Input_arguments.
30//
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).
35
36#ifndef GOLD_OPTIONS_H
37#define GOLD_OPTIONS_H
38
39#include <cstdlib>
40#include <cstring>
41#include <list>
42#include <map>
43#include <string>
44#include <vector>
45
46#include "elfcpp.h"
47#include "script.h"
48
49namespace gold
50{
51
52class Command_line;
53class General_options;
54class Search_directory;
55class Input_file_group;
56class Input_file_lib;
57class Position_dependent_options;
58class Target;
59class Plugin_manager;
60
61// Incremental build action for a specific file, as selected by the user.
62
63enum Incremental_disposition
64{
65 // Determine the status from the timestamp (default).
66 INCREMENTAL_CHECK,
67 // Assume the file changed from the previous build.
68 INCREMENTAL_CHANGED,
69 // Assume the file didn't change from the previous build.
70 INCREMENTAL_UNCHANGED
71};
72
73// The nested namespace is to contain all the global variables and
74// structs that need to be defined in the .h file, but do not need to
75// be used outside this class.
76namespace options
77{
78typedef std::vector<Search_directory> Dir_list;
79typedef Unordered_set<std::string> String_set;
80
81// These routines convert from a string option to various types.
82// Each gives a fatal error if it cannot parse the argument.
83
84extern void
85parse_bool(const char* option_name, const char* arg, bool* retval);
86
87extern void
88parse_int(const char* option_name, const char* arg, int* retval);
89
90extern void
91parse_uint(const char* option_name, const char* arg, int* retval);
92
93extern void
94parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
95
96extern void
97parse_double(const char* option_name, const char* arg, double* retval);
98
99extern void
100parse_string(const char* option_name, const char* arg, const char** retval);
101
102extern void
103parse_optional_string(const char* option_name, const char* arg,
104 const char** retval);
105
106extern void
107parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
108
109extern void
110parse_set(const char* option_name, const char* arg, String_set* retval);
111
112extern void
113parse_choices(const char* option_name, const char* arg, const char** retval,
114 const char* choices[], int num_choices);
115
116struct Struct_var;
117
118// Most options have both a shortname (one letter) and a longname.
119// This enum controls how many dashes are expected for longname access
120// -- shortnames always use one dash. Most longnames will accept
121// either one dash or two; the only difference between ONE_DASH and
122// TWO_DASHES is how we print the option in --help. However, some
123// longnames require two dashes, and some require only one. The
124// special value DASH_Z means that the option is preceded by "-z".
125enum Dashes
126{
127 ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z
128};
129
130// LONGNAME is the long-name of the option with dashes converted to
131// underscores, or else the short-name if the option has no long-name.
132// It is never the empty string.
133// DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc.
134// SHORTNAME is the short-name of the option, as a char, or '\0' if the
135// option has no short-name. If the option has no long-name, you
136// should specify the short-name in *both* VARNAME and here.
137// DEFAULT_VALUE is the value of the option if not specified on the
138// commandline, as a string.
139// HELPSTRING is the descriptive text used with the option via --help
140// HELPARG is how you define the argument to the option.
141// --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING"
142// HELPARG should be NULL iff the option is a bool and takes no arg.
143// OPTIONAL_ARG is true if this option takes an optional argument. An
144// optional argument must be specifid as --OPTION=VALUE, not
145// --OPTION VALUE.
146// READER provides parse_to_value, which is a function that will convert
147// a char* argument into the proper type and store it in some variable.
148// A One_option struct initializes itself with the global list of options
149// at constructor time, so be careful making one of these.
150struct One_option
151{
152 std::string longname;
153 Dashes dashes;
154 char shortname;
155 const char* default_value;
156 const char* helpstring;
157 const char* helparg;
158 bool optional_arg;
159 Struct_var* reader;
160
161 One_option(const char* ln, Dashes d, char sn, const char* dv,
162 const char* hs, const char* ha, bool oa, Struct_var* r)
163 : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
164 helpstring(hs), helparg(ha), optional_arg(oa), reader(r)
165 {
166 // In longname, we convert all underscores to dashes, since GNU
167 // style uses dashes in option names. longname is likely to have
168 // underscores in it because it's also used to declare a C++
169 // function.
170 const char* pos = strchr(this->longname.c_str(), '_');
171 for (; pos; pos = strchr(pos, '_'))
172 this->longname[pos - this->longname.c_str()] = '-';
173
174 // We only register ourselves if our helpstring is not NULL. This
175 // is to support the "no-VAR" boolean variables, which we
176 // conditionally turn on by defining "no-VAR" help text.
177 if (this->helpstring)
178 this->register_option();
179 }
180
181 // This option takes an argument iff helparg is not NULL.
182 bool
183 takes_argument() const
184 { return this->helparg != NULL; }
185
186 // Whether the argument is optional.
187 bool
188 takes_optional_argument() const
189 { return this->optional_arg; }
190
191 // Register this option with the global list of options.
192 void
193 register_option();
194
195 // Print this option to stdout (used with --help).
196 void
197 print() const;
198};
199
200// All options have a Struct_##varname that inherits from this and
201// actually implements parse_to_value for that option.
202struct Struct_var
203{
204 // OPTION: the name of the option as specified on the commandline,
205 // including leading dashes, and any text following the option:
206 // "-O", "--defsym=mysym=0x1000", etc.
207 // ARG: the arg associated with this option, or NULL if the option
208 // takes no argument: "2", "mysym=0x1000", etc.
209 // CMDLINE: the global Command_line object. Used by DEFINE_special.
210 // OPTIONS: the global General_options object. Used by DEFINE_special.
211 virtual void
212 parse_to_value(const char* option, const char* arg,
213 Command_line* cmdline, General_options* options) = 0;
214 virtual
215 ~Struct_var() // To make gcc happy.
216 { }
217};
218
219// This is for "special" options that aren't of any predefined type.
220struct Struct_special : public Struct_var
221{
222 // If you change this, change the parse-fn in DEFINE_special as well.
223 typedef void (General_options::*Parse_function)(const char*, const char*,
224 Command_line*);
225 Struct_special(const char* varname, Dashes dashes, char shortname,
226 Parse_function parse_function,
227 const char* helpstring, const char* helparg)
228 : option(varname, dashes, shortname, "", helpstring, helparg, false, this),
229 parse(parse_function)
230 { }
231
232 void parse_to_value(const char* option, const char* arg,
233 Command_line* cmdline, General_options* options)
234 { (options->*(this->parse))(option, arg, cmdline); }
235
236 One_option option;
237 Parse_function parse;
238};
239
240} // End namespace options.
241
242
243// These are helper macros use by DEFINE_uint64/etc below.
244// This macro is used inside the General_options_ class, so defines
245// var() and set_var() as General_options methods. Arguments as are
246// for the constructor for One_option. param_type__ is the same as
247// type__ for built-in types, and "const type__ &" otherwise.
248//
249// When we define the linker command option "assert", the macro argument
250// varname__ of DEFINE_var below will be replaced by "assert". On Mac OSX
251// assert.h is included implicitly by one of the library headers we use. To
252// avoid unintended macro substitution of "assert()", we need to enclose
253// varname__ with parenthese.
254#define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
255 default_value_as_string__, helpstring__, helparg__, \
256 optional_arg__, type__, param_type__, parse_fn__) \
257 public: \
258 param_type__ \
259 (varname__)() const \
260 { return this->varname__##_.value; } \
261 \
262 bool \
263 user_set_##varname__() const \
264 { return this->varname__##_.user_set_via_option; } \
265 \
266 void \
267 set_user_set_##varname__() \
268 { this->varname__##_.user_set_via_option = true; } \
269 \
270 private: \
271 struct Struct_##varname__ : public options::Struct_var \
272 { \
273 Struct_##varname__() \
274 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
275 helpstring__, helparg__, optional_arg__, this), \
276 user_set_via_option(false), value(default_value__) \
277 { } \
278 \
279 void \
280 parse_to_value(const char* option_name, const char* arg, \
281 Command_line*, General_options*) \
282 { \
283 parse_fn__(option_name, arg, &this->value); \
284 this->user_set_via_option = true; \
285 } \
286 \
287 options::One_option option; \
288 bool user_set_via_option; \
289 type__ value; \
290 }; \
291 Struct_##varname__ varname__##_; \
292 void \
293 set_##varname__(param_type__ value) \
294 { this->varname__##_.value = value; }
295
296// These macros allow for easy addition of a new commandline option.
297
298// If no_helpstring__ is not NULL, then in addition to creating
299// VARNAME, we also create an option called no-VARNAME (or, for a -z
300// option, noVARNAME).
301#define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
302 helpstring__, no_helpstring__) \
303 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
304 default_value__ ? "true" : "false", helpstring__, NULL, \
305 false, bool, bool, options::parse_bool) \
306 struct Struct_no_##varname__ : public options::Struct_var \
307 { \
308 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
309 ? "no" #varname__ \
310 : "no-" #varname__), \
311 dashes__, '\0', \
312 default_value__ ? "false" : "true", \
313 no_helpstring__, NULL, false, this) \
314 { } \
315 \
316 void \
317 parse_to_value(const char*, const char*, \
318 Command_line*, General_options* options) \
319 { \
320 options->set_##varname__(false); \
321 options->set_user_set_##varname__(); \
322 } \
323 \
324 options::One_option option; \
325 }; \
326 Struct_no_##varname__ no_##varname__##_initializer_
327
328#define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
329 helpstring__, no_helpstring__) \
330 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
331 default_value__ ? "true" : "false", helpstring__, NULL, \
332 false, bool, bool, options::parse_bool) \
333 struct Struct_disable_##varname__ : public options::Struct_var \
334 { \
335 Struct_disable_##varname__() : option("disable-" #varname__, \
336 dashes__, '\0', \
337 default_value__ ? "false" : "true", \
338 no_helpstring__, NULL, false, this) \
339 { } \
340 \
341 void \
342 parse_to_value(const char*, const char*, \
343 Command_line*, General_options* options) \
344 { options->set_enable_##varname__(false); } \
345 \
346 options::One_option option; \
347 }; \
348 Struct_disable_##varname__ disable_##varname__##_initializer_
349
350#define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
351 helpstring__, helparg__) \
352 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
353 #default_value__, helpstring__, helparg__, false, \
354 int, int, options::parse_int)
355
356#define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
357 helpstring__, helparg__) \
358 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
359 #default_value__, helpstring__, helparg__, false, \
360 int, int, options::parse_uint)
361
362#define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
363 helpstring__, helparg__) \
364 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
365 #default_value__, helpstring__, helparg__, false, \
366 uint64_t, uint64_t, options::parse_uint64)
367
368#define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
369 helpstring__, helparg__) \
370 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
371 #default_value__, helpstring__, helparg__, false, \
372 double, double, options::parse_double)
373
374#define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
375 helpstring__, helparg__) \
376 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
377 default_value__, helpstring__, helparg__, false, \
378 const char*, const char*, options::parse_string)
379
380// This is like DEFINE_string, but we convert each occurrence to a
381// Search_directory and store it in a vector. Thus we also have the
382// add_to_VARNAME() method, to append to the vector.
383#define DEFINE_dirlist(varname__, dashes__, shortname__, \
384 helpstring__, helparg__) \
385 DEFINE_var(varname__, dashes__, shortname__, , \
386 "", helpstring__, helparg__, false, options::Dir_list, \
387 const options::Dir_list&, options::parse_dirlist) \
388 void \
389 add_to_##varname__(const char* new_value) \
390 { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \
391 void \
392 add_search_directory_to_##varname__(const Search_directory& dir) \
393 { this->varname__##_.value.push_back(dir); }
394
395// This is like DEFINE_string, but we store a set of strings.
396#define DEFINE_set(varname__, dashes__, shortname__, \
397 helpstring__, helparg__) \
398 DEFINE_var(varname__, dashes__, shortname__, , \
399 "", helpstring__, helparg__, false, options::String_set, \
400 const options::String_set&, options::parse_set) \
401 public: \
402 bool \
403 any_##varname__() const \
404 { return !this->varname__##_.value.empty(); } \
405 \
406 bool \
407 is_##varname__(const char* symbol) const \
408 { \
409 return (!this->varname__##_.value.empty() \
410 && (this->varname__##_.value.find(std::string(symbol)) \
411 != this->varname__##_.value.end())); \
412 } \
413 \
414 options::String_set::const_iterator \
415 varname__##_begin() const \
416 { return this->varname__##_.value.begin(); } \
417 \
418 options::String_set::const_iterator \
419 varname__##_end() const \
420 { return this->varname__##_.value.end(); }
421
422// When you have a list of possible values (expressed as string)
423// After helparg__ should come an initializer list, like
424// {"foo", "bar", "baz"}
425#define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
426 helpstring__, helparg__, ...) \
427 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
428 default_value__, helpstring__, helparg__, false, \
429 const char*, const char*, parse_choices_##varname__) \
430 private: \
431 static void parse_choices_##varname__(const char* option_name, \
432 const char* arg, \
433 const char** retval) { \
434 const char* choices[] = __VA_ARGS__; \
435 options::parse_choices(option_name, arg, retval, \
436 choices, sizeof(choices) / sizeof(*choices)); \
437 }
438
439// This is like DEFINE_bool, but VARNAME is the name of a different
440// option. This option becomes an alias for that one. INVERT is true
441// if this option is an inversion of the other one.
442#define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
443 helpstring__, no_helpstring__, invert__) \
444 private: \
445 struct Struct_##option__ : public options::Struct_var \
446 { \
447 Struct_##option__() \
448 : option(#option__, dashes__, shortname__, "", helpstring__, \
449 NULL, false, this) \
450 { } \
451 \
452 void \
453 parse_to_value(const char*, const char*, \
454 Command_line*, General_options* options) \
455 { \
456 options->set_##varname__(!invert__); \
457 options->set_user_set_##varname__(); \
458 } \
459 \
460 options::One_option option; \
461 }; \
462 Struct_##option__ option__##_; \
463 \
464 struct Struct_no_##option__ : public options::Struct_var \
465 { \
466 Struct_no_##option__() \
467 : option((dashes__ == options::DASH_Z \
468 ? "no" #option__ \
469 : "no-" #option__), \
470 dashes__, '\0', "", no_helpstring__, \
471 NULL, false, this) \
472 { } \
473 \
474 void \
475 parse_to_value(const char*, const char*, \
476 Command_line*, General_options* options) \
477 { \
478 options->set_##varname__(invert__); \
479 options->set_user_set_##varname__(); \
480 } \
481 \
482 options::One_option option; \
483 }; \
484 Struct_no_##option__ no_##option__##_initializer_
485
486// This is used for non-standard flags. It defines no functions; it
487// just calls General_options::parse_VARNAME whenever the flag is
488// seen. We declare parse_VARNAME as a static member of
489// General_options; you are responsible for defining it there.
490// helparg__ should be NULL iff this special-option is a boolean.
491#define DEFINE_special(varname__, dashes__, shortname__, \
492 helpstring__, helparg__) \
493 private: \
494 void parse_##varname__(const char* option, const char* arg, \
495 Command_line* inputs); \
496 struct Struct_##varname__ : public options::Struct_special \
497 { \
498 Struct_##varname__() \
499 : options::Struct_special(#varname__, dashes__, shortname__, \
500 &General_options::parse_##varname__, \
501 helpstring__, helparg__) \
502 { } \
503 }; \
504 Struct_##varname__ varname__##_initializer_
505
506// An option that takes an optional string argument. If the option is
507// used with no argument, the value will be the default, and
508// user_set_via_option will be true.
509#define DEFINE_optional_string(varname__, dashes__, shortname__, \
510 default_value__, \
511 helpstring__, helparg__) \
512 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
513 default_value__, helpstring__, helparg__, true, \
514 const char*, const char*, options::parse_optional_string)
515
516// A directory to search. For each directory we record whether it is
517// in the sysroot. We need to know this so that, if a linker script
518// is found within the sysroot, we will apply the sysroot to any files
519// named by that script.
520
521class Search_directory
522{
523 public:
524 // We need a default constructor because we put this in a
525 // std::vector.
526 Search_directory()
527 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
528 { }
529
530 // This is the usual constructor.
531 Search_directory(const char* name, bool put_in_sysroot)
532 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
533 {
534 if (this->name_.empty())
535 this->name_ = ".";
536 }
537
538 // This is called if we have a sysroot. The sysroot is prefixed to
539 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
540 // set to true for any enries which are in the sysroot (this will
541 // naturally include any entries for which put_in_sysroot_ is true).
542 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
543 // passing SYSROOT to lrealpath.
544 void
545 add_sysroot(const char* sysroot, const char* canonical_sysroot);
546
547 // Get the directory name.
548 const std::string&
549 name() const
550 { return this->name_; }
551
552 // Return whether this directory is in the sysroot.
553 bool
554 is_in_sysroot() const
555 { return this->is_in_sysroot_; }
556
557 // Return whether this is considered a system directory.
558 bool
559 is_system_directory() const
560 { return this->put_in_sysroot_ || this->is_in_sysroot_; }
561
562 private:
563 // The directory name.
564 std::string name_;
565 // True if the sysroot should be added as a prefix for this
566 // directory (if there is a sysroot). This is true for system
567 // directories that we search by default.
568 bool put_in_sysroot_;
569 // True if this directory is in the sysroot (if there is a sysroot).
570 // This is true if there is a sysroot and either 1) put_in_sysroot_
571 // is true, or 2) the directory happens to be in the sysroot based
572 // on a pathname comparison.
573 bool is_in_sysroot_;
574};
575
576class General_options
577{
578 private:
579 // NOTE: For every option that you add here, also consider if you
580 // should add it to Position_dependent_options.
581 DEFINE_special(help, options::TWO_DASHES, '\0',
582 N_("Report usage information"), NULL);
583 DEFINE_special(version, options::TWO_DASHES, 'v',
584 N_("Report version information"), NULL);
585 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
586 N_("Report version and target information"), NULL);
587
588 // These options are sorted approximately so that for each letter in
589 // the alphabet, we show the option whose shortname is that letter
590 // (if any) and then every longname that starts with that letter (in
591 // alphabetical order). For both, lowercase sorts before uppercase.
592 // The -z options come last.
593
594 DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
595 N_("Not supported"),
596 N_("Do not copy DT_NEEDED tags from shared libraries"));
597
598 DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
599 '\0', N_("Allow multiple definitions of symbols"),
600 N_("Do not allow multiple definitions"), false);
601
602 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
603 N_("Allow unresolved references in shared libraries"),
604 N_("Do not allow unresolved references in shared libraries"));
605
606 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
607 N_("Only set DT_NEEDED for shared libraries if used"),
608 N_("Always DT_NEEDED for shared libraries"));
609
610 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
611 N_("Ignored"), N_("[ignored]"),
612 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
613
614 // This should really be an "enum", but it's too easy for folks to
615 // forget to update the list as they add new targets. So we just
616 // accept any string. We'll fail later (when the string is parsed),
617 // if the target isn't actually supported.
618 DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
619 N_("Set input format"), ("[elf,binary]"));
620
621 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
622 N_("-l searches for shared libraries"), NULL);
623 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
624 N_("-l does not search for shared libraries"), NULL,
625 true);
626
627 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
628 N_("Bind defined symbols locally"), NULL);
629
630 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
631 N_("Bind defined function symbols locally"), NULL);
632
633 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
634 N_("Generate build ID note"),
635 N_("[=STYLE]"));
636
637 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
638 N_("Check segment addresses for overlaps (default)"),
639 N_("Do not check segment addresses for overlaps"));
640
641#ifdef HAVE_ZLIB_H
642 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
643 N_("Compress .debug_* sections in the output file"),
644 ("[none,zlib]"),
645 {"none", "zlib"});
646#else
647 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
648 N_("Compress .debug_* sections in the output file"),
649 N_("[none]"),
650 {"none"});
651#endif
652
653 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
654 N_("Not supported"),
655 N_("Do not copy DT_NEEDED tags from shared libraries"));
656
657 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
658 N_("Output cross reference table"),
659 N_("Do not output cross reference table"));
660
661 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
662 N_("Define common symbols"),
663 N_("Do not define common symbols"));
664 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
665 N_("Alias for -d"), NULL);
666 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
667 N_("Alias for -d"), NULL);
668
669 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
670 N_("Turn on debugging"),
671 N_("[all,files,script,task][,...]"));
672
673 DEFINE_special(defsym, options::TWO_DASHES, '\0',
674 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
675
676 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
677 N_("Demangle C++ symbols in log messages"),
678 N_("[=STYLE]"));
679
680 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
681 N_("Do not demangle C++ symbols in log messages"),
682 NULL);
683
684 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
685 N_("Try to detect violations of the One Definition Rule"),
686 NULL);
687
688 DEFINE_bool(discard_all, options::TWO_DASHES, 'x', false,
689 N_("Delete all local symbols"), NULL);
690 DEFINE_bool(discard_locals, options::TWO_DASHES, 'X', false,
691 N_("Delete all temporary local symbols"), NULL);
692
693 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
694 N_("Add data symbols to dynamic symbols"), NULL);
695
696 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
697 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
698
699 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
700 N_("Add C++ typeinfo to dynamic symbols"), NULL);
701
702 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
703 N_("Read a list of dynamic symbols"), N_("FILE"));
704
705 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
706 N_("Set program start address"), N_("ADDRESS"));
707
708 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
709 N_("Exclude libraries from automatic export"),
710 N_(("lib,lib ...")));
711
712 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
713 N_("Export all dynamic symbols"),
714 N_("Do not export all dynamic symbols (default)"));
715
716 DEFINE_special(EB, options::ONE_DASH, '\0',
717 N_("Link big-endian objects."), NULL);
718
719 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
720 N_("Create exception frame header"), NULL);
721
722 DEFINE_special(EL, options::ONE_DASH, '\0',
723 N_("Link little-endian objects."), NULL);
724
725 DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
726 N_("(ARM only) Do not warn about objects with incompatible "
727 "enum sizes"));
728
729 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
730 N_("Treat warnings as errors"),
731 N_("Do not treat warnings as errors"));
732
733 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
734 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
735
736 DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
737 N_("(ARM only) Fix binaries for Cortex-A8 erratum."),
738 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum."));
739
740 DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
741 N_("(ARM only) Merge exidx entries in debuginfo."),
742 N_("(ARM only) Do not merge exidx entries in debuginfo."));
743
744 DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
745 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
746 NULL);
747
748 DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
749 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
750 "veneer"),
751 NULL);
752
753 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
754 N_("Ignored"), NULL);
755
756 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
757 N_("Set shared library name"), N_("FILENAME"));
758
5e4e6ec1
SW
759 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
760 N_("Min fraction of empty buckets in dynamic hash"),
761 N_("FRACTION"));
762
763 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
764 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
765 {"sysv", "gnu", "both"});
766
767 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
768 N_("Set dynamic linker path"), N_("PROGRAM"));
769
770 DEFINE_special(incremental, options::TWO_DASHES, '\0',
771 N_("Do an incremental link if possible; "
772 "otherwise, do a full link and prepare output "
773 "for incremental linking"), NULL);
774
775 DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
776 N_("Do a full link (default)"), NULL);
777
778 DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
779 N_("Do a full link and "
780 "prepare output for incremental linking"), NULL);
781
782 DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
783 N_("Do an incremental link; exit if not possible"), NULL);
784
785 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
786 N_("Assume files changed"), NULL);
787
788 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
789 N_("Assume files didn't change"), NULL);
790
791 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
792 N_("Use timestamps to check files (default)"), NULL);
793
794 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
795 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
796
797 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
798 N_("Read only symbol values from FILE"), N_("FILE"));
799
800 DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
801 sizeof(void*) >= 8,
802 N_("Map whole files to memory (default on 64-bit hosts)"),
803 N_("Map relevant file parts to memory (default on 32-bit "
804 "hosts)"));
805 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
806 N_("Keep files mapped across passes (default)"),
807 N_("Release mapped files after each pass"));
808
809 DEFINE_special(library, options::TWO_DASHES, 'l',
810 N_("Search for library LIBNAME"), N_("LIBNAME"));
811
812 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
813 N_("Add directory to search path"), N_("DIR"));
814
815 DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
816 N_(" Only search directories specified on the command line."),
817 NULL);
818
819 DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
820 N_(" Put read-only non-executable sections in their own segment"),
821 NULL);
822
823 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
824 N_("Ignored for compatibility"), N_("EMULATION"));
825
826 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
827 N_("Write map file on standard output"), NULL);
828 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
829 N_("MAPFILENAME"));
830
831 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
832 N_("Do not page align data"), NULL);
833 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
834 N_("Do not page align data, do not make text readonly"),
835 N_("Page align data, make text readonly"));
836
837 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
838 N_("Enable use of DT_RUNPATH and DT_FLAGS"),
839 N_("Disable use of DT_RUNPATH and DT_FLAGS"));
840
841 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
842 N_("Create an output file even if errors occur"), NULL);
843
844 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
845 N_("Report undefined symbols (even with --shared)"),
846 NULL, false);
847
848 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
849 N_("Set output file name"), N_("FILE"));
850
851 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
852 N_("Optimize output file size"), N_("LEVEL"));
853
854 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
855 N_("Set output format"), N_("[binary]"));
856
857 DEFINE_bool(p, options::ONE_DASH, '\0', false,
858 N_("(ARM only) Ignore for backward compatibility"), NULL);
859
860 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
861 N_("Create a position independent executable"), NULL);
862 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
863 N_("Create a position independent executable"), NULL,
864 false);
865
866 DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
867 NULL, N_("(ARM only) Ignore for backward compatibility"));
868
869#ifdef ENABLE_PLUGINS
870 DEFINE_special(plugin, options::TWO_DASHES, '\0',
871 N_("Load a plugin library"), N_("PLUGIN"));
872 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
873 N_("Pass an option to the plugin"), N_("OPTION"));
874#endif
875
876 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
877 N_("Preread archive symbols when multi-threaded"), NULL);
878
879 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
880 N_("Print symbols defined and used for each input"),
881 N_("FILENAME"));
882
883 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
884 N_("Ignored for SVR4 compatibility"), NULL);
885
886 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
887 N_("Generate relocations in output"), NULL);
888
889 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
890 N_("Generate relocatable output"), NULL);
2ff7ea11
JM
891 DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
892 N_("Synonym for -r"), NULL, false);
5e4e6ec1
SW
893
894 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
895 N_("Relax branches on certain targets"), NULL);
896
897 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
898 N_("keep only symbols listed in this file"), N_("FILE"));
899
900 // -R really means -rpath, but can mean --just-symbols for
901 // compatibility with GNU ld. -rpath is always -rpath, so we list
902 // it separately.
903 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
904 N_("Add DIR to runtime search path"), N_("DIR"));
905
906 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
907 N_("Add DIR to runtime search path"), N_("DIR"));
908
909 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
910 N_("Add DIR to link time shared library search path"),
911 N_("DIR"));
912
913 DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
914 N_("Layout sections in the order specified."),
915 N_("FILENAME"));
916
917 DEFINE_special(section_start, options::TWO_DASHES, '\0',
918 N_("Set address of section"), N_("SECTION=ADDRESS"));
919
920 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
921 N_("Sort common symbols by alignment"),
922 N_("[={ascending,descending}]"));
923
924 DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
925 N_("Dynamic tag slots to reserve (default 5)"),
926 N_("COUNT"));
927
928 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
929 N_("Strip all symbols"), NULL);
930 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
931 N_("Strip debugging information"), NULL);
932 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
933 N_("Emit only debug line number information"), NULL);
934 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
935 N_("Strip debug symbols that are unused by gdb "
936 "(at least versions <= 6.7)"), NULL);
937 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
938 N_("Strip LTO intermediate code sections"), NULL);
939
940 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
941 N_("(ARM only) The maximum distance from instructions in a group "
942 "of sections to their stubs. Negative values mean stubs "
943 "are always after the group. 1 means using default size.\n"),
944 N_("SIZE"));
945
946 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
947 N_("Use less memory and more disk I/O "
948 "(included only for compatibility with GNU ld)"), NULL);
949
950 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
951 N_("Generate shared library"), NULL);
952
953 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
954 N_("Generate shared library"), NULL);
955
956 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
957 N_("Stack size when -fsplit-stack function calls non-split"),
958 N_("SIZE"));
959
960 // This is not actually special in any way, but I need to give it
961 // a non-standard accessor-function name because 'static' is a keyword.
962 DEFINE_special(static, options::ONE_DASH, '\0',
963 N_("Do not link against shared libraries"), NULL);
964
965 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
966 N_("Identical Code Folding. "
967 "\'--icf=safe\' Folds ctors, dtors and functions whose"
968 " pointers are definitely not taken."),
969 ("[none,all,safe]"),
970 {"none", "all", "safe"});
971
972 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
973 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
974
975 DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
976 N_("List folded identical sections on stderr"),
977 N_("Do not list folded identical sections"));
978
979 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
980 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
981
982 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
983 N_("Remove unused sections"),
984 N_("Don't remove unused sections (default)"));
985
986 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
987 N_("List removed unused sections on stderr"),
988 N_("Do not list removed unused sections"));
989
990 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
991 N_("Print resource usage statistics"), NULL);
992
993 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
994 N_("Set target system root directory"), N_("DIR"));
995
996 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
997 N_("Print the name of each input file"), NULL);
998
999 DEFINE_special(script, options::TWO_DASHES, 'T',
1000 N_("Read linker script"), N_("FILE"));
1001
1002 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
1003 N_("Run the linker multi-threaded"),
1004 N_("Do not run the linker multi-threaded"));
1005 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
1006 N_("Number of threads to use"), N_("COUNT"));
1007 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
1008 N_("Number of threads to use in initial pass"), N_("COUNT"));
1009 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
1010 N_("Number of threads to use in middle pass"), N_("COUNT"));
1011 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
1012 N_("Number of threads to use in final pass"), N_("COUNT"));
1013
1014 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
1015 N_("Set the address of the bss segment"), N_("ADDRESS"));
1016 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
1017 N_("Set the address of the data segment"), N_("ADDRESS"));
1018 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
1019 N_("Set the address of the text segment"), N_("ADDRESS"));
1020
1021 DEFINE_set(undefined, options::TWO_DASHES, 'u',
1022 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
1023
1024 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
1025 N_("Synonym for --debug=files"), NULL);
1026
1027 DEFINE_special(version_script, options::TWO_DASHES, '\0',
1028 N_("Read version script"), N_("FILE"));
1029
1030 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1031 N_("Warn about duplicate common symbols"),
1032 N_("Do not warn about duplicate common symbols (default)"));
1033
1034 DEFINE_bool(warn_constructors, options::TWO_DASHES, '\0', false,
1035 N_("Ignored"), N_("Ignored"));
1036
1037 DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1038 NULL, N_("Don't warn about mismatched input files"));
1039
1040 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1041 N_("Ignored"), NULL);
1042
1043 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1044 N_("Warn when skipping an incompatible library"),
1045 N_("Don't warn when skipping an incompatible library"));
1046
1047 DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1048 N_("Warn if text segment is not shareable"),
1049 N_("Do not warn if text segment is not shareable (default)"));
1050
1051 DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1052 N_("Report unresolved symbols as warnings"),
1053 NULL);
1054 DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1055 options::TWO_DASHES, '\0',
1056 N_("Report unresolved symbols as errors"),
1057 NULL, true);
1058
1059 DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1060 N_("(ARM only) Do not warn about objects with incompatible "
1061 "wchar_t sizes"));
1062
1063 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
1064 N_("Include all archive contents"),
1065 N_("Include only needed archive contents"));
1066
1067 DEFINE_set(wrap, options::TWO_DASHES, '\0',
1068 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1069
1070 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
1071 N_("Trace references to symbol"), N_("SYMBOL"));
1072
1073 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
1074 N_("Allow unused version in script (default)"),
1075 N_("Do not allow unused version in script"));
1076
1077 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1078 N_("Default search path for Solaris compatibility"),
1079 N_("PATH"));
1080
1081 DEFINE_special(start_group, options::TWO_DASHES, '(',
1082 N_("Start a library search group"), NULL);
1083 DEFINE_special(end_group, options::TWO_DASHES, ')',
1084 N_("End a library search group"), NULL);
1085
1086
1087 DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1088 N_("Start a library"), NULL);
1089 DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1090 N_("End a library "), NULL);
1091
1092 // The -z options.
1093
1094 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1095 N_("Sort dynamic relocs"),
1096 N_("Do not sort dynamic relocs"));
1097 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
1098 N_("Set common page size to SIZE"), N_("SIZE"));
1099 DEFINE_bool(defs, options::DASH_Z, '\0', false,
1100 N_("Report undefined symbols (even with --shared)"),
1101 NULL);
1102 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
1103 N_("Mark output as requiring executable stack"), NULL);
1104 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1105 N_("Mark DSO to be initialized first at runtime"),
1106 NULL);
1107 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1108 N_("Mark object to interpose all DSOs but executable"),
1109 NULL);
1110 DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
1111 N_("Mark object for lazy runtime binding (default)"),
1112 NULL, true);
1113 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1114 N_("Mark object requiring immediate process"),
1115 NULL);
1116 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
1117 N_("Set maximum page size to SIZE"), N_("SIZE"));
1118 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1119 N_("Allow multiple definitions of symbols"),
1120 NULL);
1121 // copyreloc is here in the list because there is only -z
1122 // nocopyreloc, not -z copyreloc.
1123 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1124 NULL,
1125 N_("Do not create copy relocs"));
1126 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1127 N_("Mark object not to use default search paths"),
1128 NULL);
1129 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1130 N_("Mark DSO non-deletable at runtime"),
1131 NULL);
1132 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1133 N_("Mark DSO not available to dlopen"),
1134 NULL);
1135 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1136 N_("Mark DSO not available to dldump"),
1137 NULL);
1138 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
1139 N_("Mark output as not requiring executable stack"), NULL);
1140 DEFINE_bool(now, options::DASH_Z, '\0', false,
1141 N_("Mark object for immediate function binding"),
1142 NULL);
1143 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1144 N_("Mark DSO to indicate that needs immediate $ORIGIN "
1145 "processing at runtime"), NULL);
1146 DEFINE_bool(relro, options::DASH_Z, '\0', false,
1147 N_("Where possible mark variables read-only after relocation"),
1148 N_("Don't mark variables read-only after relocation"));
1149 DEFINE_bool(text, options::DASH_Z, '\0', false,
1150 N_("Do not permit relocations in read-only segments"),
1151 NULL);
1152 DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
1153 N_("Permit relocations in read-only segments (default)"),
1154 NULL, true);
1155
1156 public:
1157 typedef options::Dir_list Dir_list;
1158
1159 General_options();
1160
1161 // Does post-processing on flags, making sure they all have
1162 // non-conflicting values. Also converts some flags from their
1163 // "standard" types (string, etc), to another type (enum, DirList),
1164 // which can be accessed via a separate method. Dies if it notices
1165 // any problems.
1166 void finalize();
1167
1168 // True if we printed the version information.
1169 bool
1170 printed_version() const
1171 { return this->printed_version_; }
1172
1173 // The macro defines output() (based on --output), but that's a
1174 // generic name. Provide this alternative name, which is clearer.
1175 const char*
1176 output_file_name() const
1177 { return this->output(); }
1178
1179 // This is not defined via a flag, but combines flags to say whether
1180 // the output is position-independent or not.
1181 bool
1182 output_is_position_independent() const
1183 { return this->shared() || this->pie(); }
1184
1185 // Return true if the output is something that can be exec()ed, such
1186 // as a static executable, or a position-dependent or
1187 // position-independent executable, but not a dynamic library or an
1188 // object file.
1189 bool
1190 output_is_executable() const
1191 { return !this->shared() && !this->relocatable(); }
1192
1193 // This would normally be static(), and defined automatically, but
1194 // since static is a keyword, we need to come up with our own name.
1195 bool
1196 is_static() const
1197 { return static_; }
1198
1199 // In addition to getting the input and output formats as a string
1200 // (via format() and oformat()), we also give access as an enum.
1201 enum Object_format
1202 {
1203 // Ordinary ELF.
1204 OBJECT_FORMAT_ELF,
1205 // Straight binary format.
1206 OBJECT_FORMAT_BINARY
1207 };
1208
1209 // Convert a string to an Object_format. Gives an error if the
1210 // string is not recognized.
1211 static Object_format
1212 string_to_object_format(const char* arg);
1213
1214 // Note: these functions are not very fast.
1215 Object_format format_enum() const;
1216 Object_format oformat_enum() const;
1217
1218 // Return whether FILENAME is in a system directory.
1219 bool
1220 is_in_system_directory(const std::string& name) const;
1221
1222 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1223 bool
1224 should_retain_symbol(const char* symbol_name) const
1225 {
1226 if (symbols_to_retain_.empty()) // means flag wasn't specified
1227 return true;
1228 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1229 }
1230
1231 // These are the best way to get access to the execstack state,
1232 // not execstack() and noexecstack() which are hard to use properly.
1233 bool
1234 is_execstack_set() const
1235 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
1236
1237 bool
1238 is_stack_executable() const
1239 { return this->execstack_status_ == EXECSTACK_YES; }
1240
1241 bool
1242 icf_enabled() const
1243 { return this->icf_status_ != ICF_NONE; }
1244
1245 bool
1246 icf_safe_folding() const
1247 { return this->icf_status_ == ICF_SAFE; }
1248
1249 // The --demangle option takes an optional string, and there is also
1250 // a --no-demangle option. This is the best way to decide whether
1251 // to demangle or not.
1252 bool
1253 do_demangle() const
1254 { return this->do_demangle_; }
1255
1256 // Returns TRUE if any plugin libraries have been loaded.
1257 bool
1258 has_plugins() const
1259 { return this->plugins_ != NULL; }
1260
1261 // Return a pointer to the plugin manager.
1262 Plugin_manager*
1263 plugins() const
1264 { return this->plugins_; }
1265
1266 // True iff SYMBOL was found in the file specified by dynamic-list.
1267 bool
1268 in_dynamic_list(const char* symbol) const
1269 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1270
1271 // Finalize the dynamic list.
1272 void
1273 finalize_dynamic_list()
1274 { this->dynamic_list_.version_script_info()->finalize(); }
1275
1276 // The mode selected by the --incremental options.
1277 enum Incremental_mode
1278 {
1279 // No incremental linking (--no-incremental).
1280 INCREMENTAL_OFF,
1281 // Incremental update only (--incremental-update).
1282 INCREMENTAL_UPDATE,
1283 // Force a full link, but prepare for subsequent incremental link
1284 // (--incremental-full).
1285 INCREMENTAL_FULL,
1286 // Incremental update if possible, fallback to full link (--incremental).
1287 INCREMENTAL_AUTO
1288 };
1289
1290 // The incremental linking mode.
1291 Incremental_mode
1292 incremental_mode() const
1293 { return this->incremental_mode_; }
1294
1295 // The disposition given by the --incremental-changed,
1296 // --incremental-unchanged or --incremental-unknown option. The
1297 // value may change as we proceed parsing the command line flags.
1298 Incremental_disposition
1299 incremental_disposition() const
1300 { return this->incremental_disposition_; }
1301
1302 // Return true if S is the name of a library excluded from automatic
1303 // symbol export.
1304 bool
1305 check_excluded_libs(const std::string &s) const;
1306
1307 // If an explicit start address was given for section SECNAME with
1308 // the --section-start option, return true and set *PADDR to the
1309 // address. Otherwise return false.
1310 bool
1311 section_start(const char* secname, uint64_t* paddr) const;
1312
1313 enum Fix_v4bx
1314 {
1315 // Leave original instruction.
1316 FIX_V4BX_NONE,
1317 // Replace instruction.
1318 FIX_V4BX_REPLACE,
1319 // Generate an interworking veneer.
1320 FIX_V4BX_INTERWORKING
1321 };
1322
1323 Fix_v4bx
1324 fix_v4bx() const
1325 { return (this->fix_v4bx_); }
1326
1327 enum Endianness
1328 {
1329 ENDIANNESS_NOT_SET,
1330 ENDIANNESS_BIG,
1331 ENDIANNESS_LITTLE
1332 };
1333
1334 Endianness
1335 endianness() const
1336 { return this->endianness_; }
1337
1338 private:
1339 // Don't copy this structure.
1340 General_options(const General_options&);
1341 General_options& operator=(const General_options&);
1342
1343 // Whether to mark the stack as executable.
1344 enum Execstack
1345 {
1346 // Not set on command line.
1347 EXECSTACK_FROM_INPUT,
1348 // Mark the stack as executable (-z execstack).
1349 EXECSTACK_YES,
1350 // Mark the stack as not executable (-z noexecstack).
1351 EXECSTACK_NO
1352 };
1353
1354 enum Icf_status
1355 {
1356 // Do not fold any functions (Default or --icf=none).
1357 ICF_NONE,
1358 // All functions are candidates for folding. (--icf=all).
1359 ICF_ALL,
1360 // Only ctors and dtors are candidates for folding. (--icf=safe).
1361 ICF_SAFE
1362 };
1363
1364 void
1365 set_icf_status(Icf_status value)
1366 { this->icf_status_ = value; }
1367
1368 void
1369 set_execstack_status(Execstack value)
1370 { this->execstack_status_ = value; }
1371
1372 void
1373 set_do_demangle(bool value)
1374 { this->do_demangle_ = value; }
1375
1376 void
1377 set_static(bool value)
1378 { static_ = value; }
1379
1380 // These are called by finalize() to set up the search-path correctly.
1381 void
1382 add_to_library_path_with_sysroot(const char* arg)
1383 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
1384
1385 // Apply any sysroot to the directory lists.
1386 void
1387 add_sysroot();
1388
1389 // Add a plugin and its arguments to the list of plugins.
1390 void
1391 add_plugin(const char* filename);
1392
1393 // Add a plugin option.
1394 void
1395 add_plugin_option(const char* opt);
1396
1397 // Whether we printed version information.
1398 bool printed_version_;
1399 // Whether to mark the stack as executable.
1400 Execstack execstack_status_;
1401 // Whether to do code folding.
1402 Icf_status icf_status_;
1403 // Whether to do a static link.
1404 bool static_;
1405 // Whether to do demangling.
1406 bool do_demangle_;
1407 // List of plugin libraries.
1408 Plugin_manager* plugins_;
1409 // The parsed output of --dynamic-list files. For convenience in
1410 // script.cc, we store this as a Script_options object, even though
1411 // we only use a single Version_tree from it.
1412 Script_options dynamic_list_;
1413 // The incremental linking mode.
1414 Incremental_mode incremental_mode_;
1415 // The disposition given by the --incremental-changed,
1416 // --incremental-unchanged or --incremental-unknown option. The
1417 // value may change as we proceed parsing the command line flags.
1418 Incremental_disposition incremental_disposition_;
1419 // Whether we have seen one of the options that require incremental
1420 // build (--incremental-changed, --incremental-unchanged or
1421 // --incremental-unknown)
1422 bool implicit_incremental_;
1423 // Libraries excluded from automatic export, via --exclude-libs.
1424 Unordered_set<std::string> excluded_libs_;
1425 // List of symbol-names to keep, via -retain-symbol-info.
1426 Unordered_set<std::string> symbols_to_retain_;
1427 // Map from section name to address from --section-start.
1428 std::map<std::string, uint64_t> section_starts_;
1429 // Whether to process armv4 bx instruction relocation.
1430 Fix_v4bx fix_v4bx_;
1431 // Endianness.
1432 Endianness endianness_;
1433};
1434
1435// The position-dependent options. We use this to store the state of
1436// the commandline at a particular point in parsing for later
1437// reference. For instance, if we see "ld --whole-archive foo.a
1438// --no-whole-archive," we want to store the whole-archive option with
1439// foo.a, so when the time comes to parse foo.a we know we should do
1440// it in whole-archive mode. We could store all of General_options,
1441// but that's big, so we just pick the subset of flags that actually
1442// change in a position-dependent way.
1443
1444#define DEFINE_posdep(varname__, type__) \
1445 public: \
1446 type__ \
1447 varname__() const \
1448 { return this->varname__##_; } \
1449 \
1450 void \
1451 set_##varname__(type__ value) \
1452 { this->varname__##_ = value; } \
1453 private: \
1454 type__ varname__##_
1455
1456class Position_dependent_options
1457{
1458 public:
1459 Position_dependent_options(const General_options& options
1460 = Position_dependent_options::default_options_)
1461 { copy_from_options(options); }
1462
1463 void copy_from_options(const General_options& options)
1464 {
1465 this->set_as_needed(options.as_needed());
1466 this->set_Bdynamic(options.Bdynamic());
1467 this->set_format_enum(options.format_enum());
1468 this->set_whole_archive(options.whole_archive());
1469 this->set_incremental_disposition(options.incremental_disposition());
1470 }
1471
1472 DEFINE_posdep(as_needed, bool);
1473 DEFINE_posdep(Bdynamic, bool);
1474 DEFINE_posdep(format_enum, General_options::Object_format);
1475 DEFINE_posdep(whole_archive, bool);
1476 DEFINE_posdep(incremental_disposition, Incremental_disposition);
1477
1478 private:
1479 // This is a General_options with everything set to its default
1480 // value. A Position_dependent_options created with no argument
1481 // will take its values from here.
1482 static General_options default_options_;
1483};
1484
1485
1486// A single file or library argument from the command line.
1487
1488class Input_file_argument
1489{
1490 public:
1491 enum Input_file_type
1492 {
1493 // A regular file, name used as-is, not searched.
1494 INPUT_FILE_TYPE_FILE,
1495 // A library name. When used, "lib" will be prepended and ".so" or
1496 // ".a" appended to make a filename, and that filename will be searched
1497 // for using the -L paths.
1498 INPUT_FILE_TYPE_LIBRARY,
1499 // A regular file, name used as-is, but searched using the -L paths.
1500 INPUT_FILE_TYPE_SEARCHED_FILE
1501 };
1502
1503 // name: file name or library name
1504 // type: the type of this input file.
1505 // extra_search_path: an extra directory to look for the file, prior
1506 // to checking the normal library search path. If this is "",
1507 // then no extra directory is added.
1508 // just_symbols: whether this file only defines symbols.
1509 // options: The position dependent options at this point in the
1510 // command line, such as --whole-archive.
1511 Input_file_argument()
1512 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
1513 just_symbols_(false), options_()
1514 { }
1515
1516 Input_file_argument(const char* name, Input_file_type type,
1517 const char* extra_search_path,
1518 bool just_symbols,
1519 const Position_dependent_options& options)
1520 : name_(name), type_(type), extra_search_path_(extra_search_path),
1521 just_symbols_(just_symbols), options_(options)
1522 { }
1523
1524 // You can also pass in a General_options instance instead of a
1525 // Position_dependent_options. In that case, we extract the
1526 // position-independent vars from the General_options and only store
1527 // those.
1528 Input_file_argument(const char* name, Input_file_type type,
1529 const char* extra_search_path,
1530 bool just_symbols,
1531 const General_options& options)
1532 : name_(name), type_(type), extra_search_path_(extra_search_path),
1533 just_symbols_(just_symbols), options_(options)
1534 { }
1535
1536 const char*
1537 name() const
1538 { return this->name_.c_str(); }
1539
1540 const Position_dependent_options&
1541 options() const
1542 { return this->options_; }
1543
1544 bool
1545 is_lib() const
1546 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1547
1548 bool
1549 is_searched_file() const
1550 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
1551
1552 const char*
1553 extra_search_path() const
1554 {
1555 return (this->extra_search_path_.empty()
1556 ? NULL
1557 : this->extra_search_path_.c_str());
1558 }
1559
1560 // Return whether we should only read symbols from this file.
1561 bool
1562 just_symbols() const
1563 { return this->just_symbols_; }
1564
1565 // Return whether this file may require a search using the -L
1566 // options.
1567 bool
1568 may_need_search() const
1569 {
1570 return (this->is_lib()
1571 || this->is_searched_file()
1572 || !this->extra_search_path_.empty());
1573 }
1574
1575 private:
1576 // We use std::string, not const char*, here for convenience when
1577 // using script files, so that we do not have to preserve the string
1578 // in that case.
1579 std::string name_;
1580 Input_file_type type_;
1581 std::string extra_search_path_;
1582 bool just_symbols_;
1583 Position_dependent_options options_;
1584};
1585
1586// A file or library, or a group, from the command line.
1587
1588class Input_argument
1589{
1590 public:
1591 // Create a file or library argument.
1592 explicit Input_argument(Input_file_argument file)
1593 : is_file_(true), file_(file), group_(NULL), lib_(NULL)
1594 { }
1595
1596 // Create a group argument.
1597 explicit Input_argument(Input_file_group* group)
1598 : is_file_(false), group_(group), lib_(NULL)
1599 { }
1600
1601 // Create a lib argument.
1602 explicit Input_argument(Input_file_lib* lib)
1603 : is_file_(false), group_(NULL), lib_(lib)
1604 { }
1605
1606 // Return whether this is a file.
1607 bool
1608 is_file() const
1609 { return this->is_file_; }
1610
1611 // Return whether this is a group.
1612 bool
1613 is_group() const
1614 { return !this->is_file_ && this->lib_ == NULL; }
1615
1616 // Return whether this is a lib.
1617 bool
1618 is_lib() const
1619 { return this->lib_ != NULL; }
1620
1621 // Return the information about the file.
1622 const Input_file_argument&
1623 file() const
1624 {
1625 gold_assert(this->is_file_);
1626 return this->file_;
1627 }
1628
1629 // Return the information about the group.
1630 const Input_file_group*
1631 group() const
1632 {
1633 gold_assert(!this->is_file_);
1634 return this->group_;
1635 }
1636
1637 Input_file_group*
1638 group()
1639 {
1640 gold_assert(!this->is_file_);
1641 return this->group_;
1642 }
1643
1644 // Return the information about the lib.
1645 const Input_file_lib*
1646 lib() const
1647 {
1648 gold_assert(!this->is_file_);
1649 gold_assert(this->lib_);
1650 return this->lib_;
1651 }
1652
1653 Input_file_lib*
1654 lib()
1655 {
1656 gold_assert(!this->is_file_);
1657 gold_assert(this->lib_);
1658 return this->lib_;
1659 }
1660
1661 private:
1662 bool is_file_;
1663 Input_file_argument file_;
1664 Input_file_group* group_;
1665 Input_file_lib* lib_;
1666};
1667
1668typedef std::vector<Input_argument> Input_argument_list;
1669
1670// A group from the command line. This is a set of arguments within
1671// --start-group ... --end-group.
1672
1673class Input_file_group
1674{
1675 public:
1676 typedef Input_argument_list::const_iterator const_iterator;
1677
1678 Input_file_group()
1679 : files_()
1680 { }
1681
1682 // Add a file to the end of the group.
1683 void
1684 add_file(const Input_file_argument& arg)
1685 { this->files_.push_back(Input_argument(arg)); }
1686
1687 // Iterators to iterate over the group contents.
1688
1689 const_iterator
1690 begin() const
1691 { return this->files_.begin(); }
1692
1693 const_iterator
1694 end() const
1695 { return this->files_.end(); }
1696
1697 private:
1698 Input_argument_list files_;
1699};
1700
1701// A lib from the command line. This is a set of arguments within
1702// --start-lib ... --end-lib.
1703
1704class Input_file_lib
1705{
1706 public:
1707 typedef Input_argument_list::const_iterator const_iterator;
1708
1709 Input_file_lib(const Position_dependent_options& options)
1710 : files_(), options_(options)
1711 { }
1712
1713 // Add a file to the end of the lib.
1714 void
1715 add_file(const Input_file_argument& arg)
1716 { this->files_.push_back(Input_argument(arg)); }
1717
1718 const Position_dependent_options&
1719 options() const
1720 { return this->options_; }
1721
1722 // Iterators to iterate over the lib contents.
1723
1724 const_iterator
1725 begin() const
1726 { return this->files_.begin(); }
1727
1728 const_iterator
1729 end() const
1730 { return this->files_.end(); }
1731
1732 size_t
1733 size() const
1734 { return this->files_.size(); }
1735
1736 private:
1737 Input_argument_list files_;
1738 Position_dependent_options options_;
1739};
1740
1741// A list of files from the command line or a script.
1742
1743class Input_arguments
1744{
1745 public:
1746 typedef Input_argument_list::const_iterator const_iterator;
1747
1748 Input_arguments()
1749 : input_argument_list_(), in_group_(false), in_lib_(false)
1750 { }
1751
1752 // Add a file.
1753 void
1754 add_file(const Input_file_argument& arg);
1755
1756 // Start a group (the --start-group option).
1757 void
1758 start_group();
1759
1760 // End a group (the --end-group option).
1761 void
1762 end_group();
1763
1764 // Start a lib (the --start-lib option).
1765 void
1766 start_lib(const Position_dependent_options&);
1767
1768 // End a lib (the --end-lib option).
1769 void
1770 end_lib();
1771
1772 // Return whether we are currently in a group.
1773 bool
1774 in_group() const
1775 { return this->in_group_; }
1776
1777 // Return whether we are currently in a lib.
1778 bool
1779 in_lib() const
1780 { return this->in_lib_; }
1781
1782 // The number of entries in the list.
1783 int
1784 size() const
1785 { return this->input_argument_list_.size(); }
1786
1787 // Iterators to iterate over the list of input files.
1788
1789 const_iterator
1790 begin() const
1791 { return this->input_argument_list_.begin(); }
1792
1793 const_iterator
1794 end() const
1795 { return this->input_argument_list_.end(); }
1796
1797 // Return whether the list is empty.
1798 bool
1799 empty() const
1800 { return this->input_argument_list_.empty(); }
1801
1802 private:
1803 Input_argument_list input_argument_list_;
1804 bool in_group_;
1805 bool in_lib_;
1806};
1807
1808
1809// All the information read from the command line. These are held in
1810// three separate structs: one to hold the options (--foo), one to
1811// hold the filenames listed on the commandline, and one to hold
1812// linker script information. This third is not a subset of the other
1813// two because linker scripts can be specified either as options (via
1814// -T) or as a file.
1815
1816class Command_line
1817{
1818 public:
1819 typedef Input_arguments::const_iterator const_iterator;
1820
1821 Command_line();
1822
1823 // Process the command line options. This will exit with an
1824 // appropriate error message if an unrecognized option is seen.
1825 void
1826 process(int argc, const char** argv);
1827
1828 // Process one command-line option. This takes the index of argv to
1829 // process, and returns the index for the next option. no_more_options
1830 // is set to true if argv[i] is "--".
1831 int
1832 process_one_option(int argc, const char** argv, int i,
1833 bool* no_more_options);
1834
1835 // Get the general options.
1836 const General_options&
1837 options() const
1838 { return this->options_; }
1839
1840 // Get the position dependent options.
1841 const Position_dependent_options&
1842 position_dependent_options() const
1843 { return this->position_options_; }
1844
1845 // Get the linker-script options.
1846 Script_options&
1847 script_options()
1848 { return this->script_options_; }
1849
1850 // Finalize the version-script options and return them.
1851 const Version_script_info&
1852 version_script();
1853
1854 // Get the input files.
1855 Input_arguments&
1856 inputs()
1857 { return this->inputs_; }
1858
1859 // The number of input files.
1860 int
1861 number_of_input_files() const
1862 { return this->inputs_.size(); }
1863
1864 // Iterators to iterate over the list of input files.
1865
1866 const_iterator
1867 begin() const
1868 { return this->inputs_.begin(); }
1869
1870 const_iterator
1871 end() const
1872 { return this->inputs_.end(); }
1873
1874 private:
1875 Command_line(const Command_line&);
1876 Command_line& operator=(const Command_line&);
1877
1878 // This is a dummy class to provide a constructor that runs before
1879 // the constructor for the General_options. The Pre_options constructor
1880 // is used as a hook to set the flag enabling the options to register
1881 // themselves.
1882 struct Pre_options {
1883 Pre_options();
1884 };
1885
1886 // This must come before options_!
1887 Pre_options pre_options_;
1888 General_options options_;
1889 Position_dependent_options position_options_;
1890 Script_options script_options_;
1891 Input_arguments inputs_;
1892};
1893
1894} // End namespace gold.
1895
1896#endif // !defined(GOLD_OPTIONS_H)