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