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