[GOLD] PowerPC stub debug
[deliverable/binutils-gdb.git] / gold / options.h
CommitLineData
bae7f79e
ILT
1// options.h -- handle command line options for gold -*- C++ -*-
2
6f2750fe 3// Copyright (C) 2006-2016 Free Software Foundation, Inc.
6cb15b7f
ILT
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
bae7f79e 23// General_options (from Command_line::options())
ee1fe73e 24// All the options (a.k.a. command-line flags)
bae7f79e
ILT
25// Input_argument (from Command_line::inputs())
26// The list of input files, including -l options.
ee1fe73e
ILT
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).
bae7f79e
ILT
35
36#ifndef GOLD_OPTIONS_H
37#define GOLD_OPTIONS_H
38
ca3a67a5 39#include <cstdlib>
cbb93e63 40#include <cstring>
bae7f79e 41#include <list>
a192ba05 42#include <map>
61ba1cf9 43#include <string>
92e059d8 44#include <vector>
bae7f79e 45
0daa6f62 46#include "elfcpp.h"
3c2fafa5
ILT
47#include "script.h"
48
bae7f79e
ILT
49namespace gold
50{
51
52class Command_line;
ee1fe73e
ILT
53class General_options;
54class Search_directory;
ead1e424 55class Input_file_group;
b0193076 56class Input_file_lib;
3c2fafa5 57class Position_dependent_options;
0daa6f62 58class Target;
89fc3421 59class Plugin_manager;
cdc29364 60class Script_info;
bae7f79e 61
266d0a74
ILT
62// Incremental build action for a specific file, as selected by the user.
63
64enum Incremental_disposition
65{
221597a5
CC
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,
266d0a74
ILT
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
ee1fe73e
ILT
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.
c7912668
ILT
82namespace options
83{
ee1fe73e 84typedef std::vector<Search_directory> Dir_list;
c5818ff1 85typedef Unordered_set<std::string> String_set;
ee1fe73e
ILT
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
90extern void
91parse_bool(const char* option_name, const char* arg, bool* retval);
92
c0a62865
DK
93extern void
94parse_int(const char* option_name, const char* arg, int* retval);
95
ee1fe73e
ILT
96extern void
97parse_uint(const char* option_name, const char* arg, int* retval);
98
99extern void
c18476e7
ILT
100parse_uint64(const char* option_name, const char* arg, uint64_t* retval);
101
102extern void
103parse_double(const char* option_name, const char* arg, double* retval);
ee1fe73e 104
9fbd3822
CC
105extern void
106parse_percent(const char* option_name, const char* arg, double* retval);
107
ee1fe73e
ILT
108extern void
109parse_string(const char* option_name, const char* arg, const char** retval);
110
086a1841
ILT
111extern void
112parse_optional_string(const char* option_name, const char* arg,
113 const char** retval);
114
ee1fe73e
ILT
115extern void
116parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
117
c5818ff1
CC
118extern void
119parse_set(const char* option_name, const char* arg, String_set* retval);
120
ee1fe73e
ILT
121extern void
122parse_choices(const char* option_name, const char* arg, const char** retval,
0c6e6c39 123 const char* choices[], int num_choices);
ee1fe73e
ILT
124
125struct 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".
134enum 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.
086a1841
ILT
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.
ee1fe73e
ILT
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.
358a9718
CC
157// IS_DEFAULT is true for boolean options that are on by default,
158// and thus should have "(default)" printed with the helpstring.
ee1fe73e
ILT
159// A One_option struct initializes itself with the global list of options
160// at constructor time, so be careful making one of these.
161struct 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;
086a1841 169 bool optional_arg;
ee1fe73e 170 Struct_var* reader;
358a9718 171 bool is_default;
ee1fe73e
ILT
172
173 One_option(const char* ln, Dashes d, char sn, const char* dv,
358a9718
CC
174 const char* hs, const char* ha, bool oa, Struct_var* r,
175 bool id)
ee1fe73e 176 : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""),
358a9718
CC
177 helpstring(hs), helparg(ha), optional_arg(oa), reader(r),
178 is_default(id)
ee1fe73e
ILT
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
086a1841
ILT
200 // Whether the argument is optional.
201 bool
202 takes_optional_argument() const
203 { return this->optional_arg; }
204
ee1fe73e
ILT
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.
216struct 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,
0c6e6c39 227 Command_line* cmdline, General_options* options) = 0;
ee1fe73e
ILT
228 virtual
229 ~Struct_var() // To make gcc happy.
230 { }
231};
bae7f79e 232
ee1fe73e
ILT
233// This is for "special" options that aren't of any predefined type.
234struct 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*,
0c6e6c39 238 Command_line*);
ee1fe73e 239 Struct_special(const char* varname, Dashes dashes, char shortname,
0c6e6c39
RM
240 Parse_function parse_function,
241 const char* helpstring, const char* helparg)
358a9718
CC
242 : option(varname, dashes, shortname, "", helpstring, helparg, false, this,
243 false),
ee1fe73e
ILT
244 parse(parse_function)
245 { }
246
2ea97941 247 void parse_to_value(const char* option, const char* arg,
0c6e6c39 248 Command_line* cmdline, General_options* options)
2ea97941 249 { (options->*(this->parse))(option, arg, cmdline); }
ee1fe73e
ILT
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.
e96c574b
DK
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.
ee1fe73e 269#define DEFINE_var(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 270 default_value_as_string__, helpstring__, helparg__, \
358a9718
CC
271 optional_arg__, type__, param_type__, parse_fn__, \
272 is_default__) \
ee1fe73e
ILT
273 public: \
274 param_type__ \
e96c574b 275 (varname__)() const \
ee1fe73e 276 { return this->varname__##_.value; } \
0c6e6c39 277 \
ee1fe73e
ILT
278 bool \
279 user_set_##varname__() const \
280 { return this->varname__##_.user_set_via_option; } \
0c6e6c39 281 \
2b706932
ILT
282 void \
283 set_user_set_##varname__() \
284 { this->varname__##_.user_set_via_option = true; } \
285 \
358a9718
CC
286 static const bool varname__##is_default = is_default__; \
287 \
ee1fe73e
ILT
288 private: \
289 struct Struct_##varname__ : public options::Struct_var \
290 { \
291 Struct_##varname__() \
292 : option(#varname__, dashes__, shortname__, default_value_as_string__, \
358a9718 293 helpstring__, helparg__, optional_arg__, this, is_default__), \
0c6e6c39 294 user_set_via_option(false), value(default_value__) \
ee1fe73e 295 { } \
0c6e6c39 296 \
ee1fe73e
ILT
297 void \
298 parse_to_value(const char* option_name, const char* arg, \
0c6e6c39 299 Command_line*, General_options*) \
ee1fe73e
ILT
300 { \
301 parse_fn__(option_name, arg, &this->value); \
302 this->user_set_via_option = true; \
303 } \
0c6e6c39 304 \
ee1fe73e
ILT
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
d98bc257
ILT
317// VARNAME, we also create an option called no-VARNAME (or, for a -z
318// option, noVARNAME).
ee1fe73e 319#define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 320 helpstring__, no_helpstring__) \
ee1fe73e 321 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 322 default_value__ ? "true" : "false", helpstring__, NULL, \
358a9718 323 false, bool, bool, options::parse_bool, default_value__) \
ee1fe73e
ILT
324 struct Struct_no_##varname__ : public options::Struct_var \
325 { \
d98bc257
ILT
326 Struct_no_##varname__() : option((dashes__ == options::DASH_Z \
327 ? "no" #varname__ \
328 : "no-" #varname__), \
329 dashes__, '\0', \
0c6e6c39 330 default_value__ ? "false" : "true", \
358a9718
CC
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) \
ee1fe73e 361 { } \
0c6e6c39 362 \
ee1fe73e
ILT
363 void \
364 parse_to_value(const char*, const char*, \
0c6e6c39 365 Command_line*, General_options* options) \
41263c05
DK
366 { \
367 options->set_##varname__(false); \
368 options->set_user_set_##varname__(); \
369 } \
0c6e6c39 370 \
ee1fe73e
ILT
371 options::One_option option; \
372 }; \
373 Struct_no_##varname__ no_##varname__##_initializer_
374
7c414435 375#define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 376 helpstring__, no_helpstring__) \
7c414435 377 DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
0c6e6c39 378 default_value__ ? "true" : "false", helpstring__, NULL, \
358a9718 379 false, bool, bool, options::parse_bool, default_value__) \
7c414435
DM
380 struct Struct_disable_##varname__ : public options::Struct_var \
381 { \
382 Struct_disable_##varname__() : option("disable-" #varname__, \
0c6e6c39
RM
383 dashes__, '\0', \
384 default_value__ ? "false" : "true", \
358a9718
CC
385 no_helpstring__, NULL, false, this, \
386 !default_value__) \
7c414435 387 { } \
0c6e6c39 388 \
7c414435
DM
389 void \
390 parse_to_value(const char*, const char*, \
0c6e6c39 391 Command_line*, General_options* options) \
7c414435 392 { options->set_enable_##varname__(false); } \
0c6e6c39 393 \
7c414435
DM
394 options::One_option option; \
395 }; \
396 Struct_disable_##varname__ disable_##varname__##_initializer_
397
c0a62865 398#define DEFINE_int(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 399 helpstring__, helparg__) \
c0a62865 400 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 401 #default_value__, helpstring__, helparg__, false, \
358a9718 402 int, int, options::parse_int, false)
c0a62865 403
ee1fe73e 404#define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 405 helpstring__, helparg__) \
ee1fe73e 406 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 407 #default_value__, helpstring__, helparg__, false, \
358a9718 408 int, int, options::parse_uint, false)
ee1fe73e
ILT
409
410#define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 411 helpstring__, helparg__) \
ee1fe73e 412 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 413 #default_value__, helpstring__, helparg__, false, \
358a9718 414 uint64_t, uint64_t, options::parse_uint64, false)
ee1fe73e 415
c18476e7
ILT
416#define DEFINE_double(varname__, dashes__, shortname__, default_value__, \
417 helpstring__, helparg__) \
418 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
086a1841 419 #default_value__, helpstring__, helparg__, false, \
358a9718 420 double, double, options::parse_double, false)
c18476e7 421
9fbd3822
CC
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, \
358a9718 426 double, double, options::parse_percent, false)
9fbd3822 427
ee1fe73e 428#define DEFINE_string(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 429 helpstring__, helparg__) \
ee1fe73e 430 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 431 default_value__, helpstring__, helparg__, false, \
358a9718 432 const char*, const char*, options::parse_string, false)
ee1fe73e
ILT
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__, \
0c6e6c39 438 helpstring__, helparg__) \
ee1fe73e 439 DEFINE_var(varname__, dashes__, shortname__, , \
0c6e6c39 440 "", helpstring__, helparg__, false, options::Dir_list, \
358a9718 441 const options::Dir_list&, options::parse_dirlist, false) \
ee1fe73e
ILT
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
c5818ff1
CC
449// This is like DEFINE_string, but we store a set of strings.
450#define DEFINE_set(varname__, dashes__, shortname__, \
0c6e6c39 451 helpstring__, helparg__) \
c5818ff1 452 DEFINE_var(varname__, dashes__, shortname__, , \
0c6e6c39 453 "", helpstring__, helparg__, false, options::String_set, \
358a9718 454 const options::String_set&, options::parse_set, false) \
c5818ff1
CC
455 public: \
456 bool \
457 any_##varname__() const \
458 { return !this->varname__##_.value.empty(); } \
f3e9c5c5 459 \
c5818ff1
CC
460 bool \
461 is_##varname__(const char* symbol) const \
462 { \
463 return (!this->varname__##_.value.empty() \
0c6e6c39
RM
464 && (this->varname__##_.value.find(std::string(symbol)) \
465 != this->varname__##_.value.end())); \
f3e9c5c5
ILT
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(); }
c5818ff1 475
ee1fe73e
ILT
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__, \
0c6e6c39 480 helpstring__, helparg__, ...) \
ee1fe73e 481 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 482 default_value__, helpstring__, helparg__, false, \
358a9718 483 const char*, const char*, parse_choices_##varname__, false) \
ee1fe73e
ILT
484 private: \
485 static void parse_choices_##varname__(const char* option_name, \
0c6e6c39
RM
486 const char* arg, \
487 const char** retval) { \
ee1fe73e
ILT
488 const char* choices[] = __VA_ARGS__; \
489 options::parse_choices(option_name, arg, retval, \
0c6e6c39 490 choices, sizeof(choices) / sizeof(*choices)); \
ee1fe73e
ILT
491 }
492
2b706932
ILT
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__, \
358a9718
CC
503 NULL, false, this, \
504 General_options::varname__##is_default ^ invert__) \
2b706932
ILT
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__, \
358a9718
CC
526 NULL, false, this, \
527 !General_options::varname__##is_default ^ invert__) \
2b706932
ILT
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
214383dd
ILT
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__, \
358a9718 551 helparg__, false, this, false) \
214383dd
ILT
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
ee1fe73e
ILT
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__, \
0c6e6c39 574 helpstring__, helparg__) \
ee1fe73e
ILT
575 private: \
576 void parse_##varname__(const char* option, const char* arg, \
0c6e6c39 577 Command_line* inputs); \
ee1fe73e
ILT
578 struct Struct_##varname__ : public options::Struct_special \
579 { \
580 Struct_##varname__() \
581 : options::Struct_special(#varname__, dashes__, shortname__, \
0c6e6c39
RM
582 &General_options::parse_##varname__, \
583 helpstring__, helparg__) \
ee1fe73e
ILT
584 { } \
585 }; \
586 Struct_##varname__ varname__##_initializer_
bae7f79e 587
086a1841
ILT
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__, \
0c6e6c39 595 default_value__, helpstring__, helparg__, true, \
358a9718
CC
596 const char*, const char*, options::parse_optional_string, \
597 false)
bae7f79e 598
ad2d6943
ILT
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
604class 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.
3f3cddf1 614 Search_directory(const std::string& name, bool put_in_sysroot)
2ea97941 615 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
15893b88
ILT
616 {
617 if (this->name_.empty())
618 this->name_ = ".";
619 }
ad2d6943
ILT
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
fd9d194f
ILT
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
ad2d6943 645 private:
fd9d194f 646 // The directory name.
ad2d6943 647 std::string name_;
fd9d194f
ILT
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.
ad2d6943 651 bool put_in_sysroot_;
fd9d194f
ILT
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.
ad2d6943
ILT
656 bool is_in_sysroot_;
657};
658
bae7f79e
ILT
659class General_options
660{
ee1fe73e
ILT
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',
0c6e6c39 665 N_("Report usage information"), NULL);
ee1fe73e 666 DEFINE_special(version, options::TWO_DASHES, 'v',
0c6e6c39 667 N_("Report version information"), NULL);
b5be4a7c 668 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
0c6e6c39 669 N_("Report version and target information"), NULL);
ee1fe73e 670
fee2edb1
ILT
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
358a9718
CC
677 // a
678
7eaea549
ILT
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
9c4ae156 683 DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
358a9718
CC
684 '\0',
685 N_("Allow multiple definitions of symbols"),
9c4ae156 686 N_("Do not allow multiple definitions"), false);
30bc8c46 687
ee1fe73e 688 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
0c6e6c39
RM
689 N_("Allow unresolved references in shared libraries"),
690 N_("Do not allow unresolved references in shared libraries"));
ee1fe73e 691
0eccf19f 692 DEFINE_bool(apply_dynamic_relocs, options::TWO_DASHES, '\0', true,
358a9718 693 N_("Apply link-time values for dynamic relocations"),
0eccf19f 694 N_("(aarch64 only) Do not apply link-time values "
1130c90e 695 "for dynamic relocations"));
0eccf19f 696
ee1fe73e 697 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
358a9718
CC
698 N_("Use DT_NEEDED only for shared libraries that are used"),
699 N_("Use DT_NEEDED for all shared libraries"));
ee1fe73e 700
fe35d28d
ILT
701 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
702 N_("Ignored"), N_("[ignored]"),
703 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
704
358a9718
CC
705 // b
706
fee2edb1
ILT
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",
0c6e6c39 712 N_("Set input format"), ("[elf,binary]"));
fee2edb1 713
358a9718
CC
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
ee1fe73e 730 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
0c6e6c39 731 N_("-l searches for shared libraries"), NULL);
2b706932
ILT
732 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
733 N_("-l does not search for shared libraries"), NULL,
734 true);
b821d13c
ILT
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);
ee1fe73e 739
e2153196
ILT
740 DEFINE_bool(Bgroup, options::ONE_DASH, '\0', false,
741 N_("Use group name lookup rules for shared library"), NULL);
742
358a9718
CC
743 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
744 N_("Generate shared library (alias for -G/-shared)"), NULL);
745
ee1fe73e 746 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
0c6e6c39 747 N_("Bind defined symbols locally"), NULL);
ee1fe73e 748
f1f70eae
ILT
749 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
750 N_("Bind defined function symbols locally"), NULL);
751
358a9718 752 // c
e7c5ea40 753
34810851 754 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
358a9718 755 N_("Check segment addresses for overlaps"),
34810851
ILT
756 N_("Do not check segment addresses for overlaps"));
757
ee1fe73e 758 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
0c6e6c39 759 N_("Compress .debug_* sections in the output file"),
fb8b9dbc
L
760 ("[none,zlib,zlib-gnu,zlib-gabi]"),
761 {"none", "zlib", "zlib-gnu", "zlib-gabi"});
0dfbdef4 762
7eaea549
ILT
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
dde3f402
ILT
767 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
768 N_("Output cross reference table"),
769 N_("Do not output cross reference table"));
770
5393d741 771 DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
358a9718 772 N_("Use DT_INIT_ARRAY for all constructors"),
5393d741
ILT
773 N_("Handle constructors as directed by compiler"));
774
358a9718
CC
775 // d
776
ee1fe73e 777 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
0c6e6c39 778 N_("Define common symbols"),
358a9718 779 N_("Do not define common symbols in relocatable output"));
ee1fe73e 780 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
0c6e6c39 781 N_("Alias for -d"), NULL);
ee1fe73e 782 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
0c6e6c39 783 N_("Alias for -d"), NULL);
d391083d 784
fee2edb1 785 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
0c6e6c39
RM
786 N_("Turn on debugging"),
787 N_("[all,files,script,task][,...]"));
fee2edb1 788
ee1fe73e 789 DEFINE_special(defsym, options::TWO_DASHES, '\0',
0c6e6c39 790 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
a6badf5a 791
086a1841
ILT
792 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
793 N_("Demangle C++ symbols in log messages"),
794 N_("[=STYLE]"));
086a1841
ILT
795 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
796 N_("Do not demangle C++ symbols in log messages"),
797 NULL);
fced7afd 798
ee1fe73e 799 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
0c6e6c39 800 N_("Look for violations of the C++ One Definition Rule"),
f30f86fa 801 N_("Do not look for violations of the C++ One Definition Rule"));
ee1fe73e 802
c82fbeee 803 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
0c6e6c39 804 N_("Add data symbols to dynamic symbols"), NULL);
c82fbeee
CS
805
806 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
0c6e6c39 807 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
c82fbeee
CS
808
809 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
0c6e6c39 810 N_("Add C++ typeinfo to dynamic symbols"), NULL);
c82fbeee
CS
811
812 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
0c6e6c39 813 N_("Read a list of dynamic symbols"), N_("FILE"));
c82fbeee 814
358a9718
CC
815 // e
816
ee1fe73e 817 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
0c6e6c39 818 N_("Set program start address"), N_("ADDRESS"));
ee1fe73e 819
358a9718
CC
820 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
821 N_("Create exception frame header"),
822 N_("Do not create exception frame header"));
823
824 // Alphabetized under 'e' because the option is spelled --enable-new-dtags.
825 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', true,
826 N_("Enable use of DT_RUNPATH"),
827 N_("Disable use of DT_RUNPATH"));
828
829 DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
830 N_("(ARM only) Do not warn about objects with incompatible "
831 "enum sizes"));
832
65514900
CC
833 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
834 N_("Exclude libraries from automatic export"),
835 N_(("lib,lib ...")));
836
ee1fe73e 837 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
0c6e6c39 838 N_("Export all dynamic symbols"),
358a9718 839 N_("Do not export all dynamic symbols"));
dbe717ef 840
31821be0
CC
841 DEFINE_set(export_dynamic_symbol, options::TWO_DASHES, '\0',
842 N_("Export SYMBOL to dynamic symbol table"), N_("SYMBOL"));
843
7296d933
DK
844 DEFINE_special(EB, options::ONE_DASH, '\0',
845 N_("Link big-endian objects."), NULL);
7296d933
DK
846 DEFINE_special(EL, options::ONE_DASH, '\0',
847 N_("Link little-endian objects."), NULL);
848
358a9718 849 // f
ce0d1972 850
886288f1
ILT
851 DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
852 N_("Auxiliary filter for shared object symbol table"),
853 N_("SHLIB"));
854
855 DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
856 N_("Filter for shared object symbol table"),
857 N_("SHLIB"));
858
d82a5bcc
ILT
859 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
860 N_("Treat warnings as errors"),
861 N_("Do not treat warnings as errors"));
862
c6585162 863 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
0c6e6c39 864 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
c6585162 865
358a9718
CC
866 DEFINE_bool(fix_arm1176, options::TWO_DASHES, '\0', true,
867 N_("(ARM only) Fix binaries for ARM1176 erratum"),
868 N_("(ARM only) Do not fix binaries for ARM1176 erratum"));
869
41263c05 870 DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
358a9718
CC
871 N_("(ARM only) Fix binaries for Cortex-A8 erratum"),
872 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum"));
41263c05 873
7a2a1c79 874 DEFINE_bool(fix_cortex_a53_843419, options::TWO_DASHES, '\0', false,
358a9718
CC
875 N_("(AArch64 only) Fix Cortex-A53 erratum 843419"),
876 N_("(AArch64 only) Do not fix Cortex-A53 erratum 843419"));
2f0c79aa
HS
877
878 DEFINE_bool(fix_cortex_a53_835769, options::TWO_DASHES, '\0', false,
358a9718
CC
879 N_("(AArch64 only) Fix Cortex-A53 erratum 835769"),
880 N_("(AArch64 only) Do not fix Cortex-A53 erratum 835769"));
85fdf906 881
9b2fd367 882 DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
0c6e6c39
RM
883 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
884 NULL);
9b2fd367
DK
885
886 DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
0c6e6c39
RM
887 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
888 "veneer"),
889 NULL);
9b2fd367 890
358a9718
CC
891 DEFINE_string(fuse_ld, options::ONE_DASH, '\0', "",
892 N_("Ignored for GCC linker option compatibility"),
893 "");
894
895 // g
ce3e4980 896
fe35d28d
ILT
897 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
898 N_("Ignored"), NULL);
899
358a9718
CC
900 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
901 N_("Remove unused sections"),
902 N_("Don't remove unused sections"));
903
c1027032
CC
904 DEFINE_bool(gdb_index, options::TWO_DASHES, '\0', false,
905 N_("Generate .gdb_index section"),
906 N_("Do not generate .gdb_index section"));
907
9634ed06 908 DEFINE_bool(gnu_unique, options::TWO_DASHES, '\0', true,
358a9718 909 N_("Enable STB_GNU_UNIQUE symbol binding"),
9634ed06
CC
910 N_("Disable STB_GNU_UNIQUE symbol binding"));
911
358a9718
CC
912 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
913 N_("Generate shared library"), NULL);
914
915 // h
916
ee1fe73e 917 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
0c6e6c39 918 N_("Set shared library name"), N_("FILENAME"));
ee1fe73e 919
c18476e7
ILT
920 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
921 N_("Min fraction of empty buckets in dynamic hash"),
922 N_("FRACTION"));
923
13670ee6 924 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv",
a4d4b13f 925 N_("Dynamic hash style"), N_("[sysv,gnu,both]"),
13670ee6
ILT
926 {"sysv", "gnu", "both"});
927
358a9718
CC
928 // i
929
930 DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
931 N_("Alias for -r"), NULL, false);
932
933 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
934 N_("Identical Code Folding. "
935 "\'--icf=safe\' Folds ctors, dtors and functions whose"
936 " pointers are definitely not taken"),
937 ("[none,all,safe]"),
938 {"none", "all", "safe"});
939
940 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
941 N_("Number of iterations of ICF (default 2)"), N_("COUNT"));
ee1fe73e 942
8c21d9d3
CC
943 DEFINE_special(incremental, options::TWO_DASHES, '\0',
944 N_("Do an incremental link if possible; "
945 "otherwise, do a full link and prepare output "
946 "for incremental linking"), NULL);
947
948 DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
949 N_("Do a full link (default)"), NULL);
950
951 DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
952 N_("Do a full link and "
953 "prepare output for incremental linking"), NULL);
954
955 DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
956 N_("Do an incremental link; exit if not possible"), NULL);
266d0a74 957
aa92d6ed 958 DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
0c6e6c39
RM
959 N_("Set base file for incremental linking"
960 " (default is output file)"),
961 N_("FILE"));
aa92d6ed 962
266d0a74 963 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
0c6e6c39 964 N_("Assume files changed"), NULL);
266d0a74
ILT
965
966 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
0c6e6c39 967 N_("Assume files didn't change"), NULL);
266d0a74
ILT
968
969 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
0c6e6c39 970 N_("Use timestamps to check files (default)"), NULL);
266d0a74 971
221597a5 972 DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
0c6e6c39 973 N_("Assume startup files unchanged "
221597a5
CC
974 "(files preceding this option)"), NULL);
975
9fbd3822 976 DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
358a9718
CC
977 N_("Amount of extra space to allocate for patches "
978 "(default 10)"),
9fbd3822
CC
979 N_("PERCENT"));
980
c6585162 981 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
0c6e6c39 982 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
c6585162 983
358a9718
CC
984 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
985 N_("Set dynamic linker path"), N_("PROGRAM"));
986
987 // j
988
fee2edb1 989 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
0c6e6c39 990 N_("Read only symbol values from FILE"), N_("FILE"));
fee2edb1 991
358a9718
CC
992 // k
993
a2a5469e 994 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
358a9718 995 N_("Keep files mapped across passes"),
0c6e6c39 996 N_("Release mapped files after each pass"));
2c849493 997
358a9718
CC
998 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
999 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1000
1001 // l
07a60597 1002
ee1fe73e 1003 DEFINE_special(library, options::TWO_DASHES, 'l',
0c6e6c39 1004 N_("Search for library LIBNAME"), N_("LIBNAME"));
bae7f79e 1005
358a9718
CC
1006 DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
1007 N_("Generate unwind information for PLT"),
1008 N_("Do not generate unwind information for PLT"));
1009
ee1fe73e 1010 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
0c6e6c39 1011 N_("Add directory to search path"), N_("DIR"));
ee1fe73e 1012
358a9718
CC
1013 DEFINE_bool(long_plt, options::TWO_DASHES, '\0', false,
1014 N_("(ARM only) Generate long PLT entries"),
1015 N_("(ARM only) Do not generate long PLT entries"));
0f72bf6f 1016
358a9718 1017 // m
bbc5ae17 1018
ee1fe73e 1019 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
96f9814d 1020 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
ee1fe73e 1021
358a9718
CC
1022 DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
1023 sizeof(void*) >= 8,
1024 N_("Map whole files to memory"),
1025 N_("Map relevant file parts to memory"));
1026
1027 DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
1028 N_("(ARM only) Merge exidx entries in debuginfo"),
1029 N_("(ARM only) Do not merge exidx entries in debuginfo"));
1030
7c0640fa 1031 DEFINE_bool(mmap_output_file, options::TWO_DASHES, '\0', true,
358a9718
CC
1032 N_("Map the output file for writing"),
1033 N_("Do not map the output file for writing"));
7c0640fa 1034
7d9e3d98
ILT
1035 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
1036 N_("Write map file on standard output"), NULL);
358a9718 1037
7d9e3d98
ILT
1038 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
1039 N_("MAPFILENAME"));
1040
358a9718
CC
1041 // n
1042
af6156ef
ILT
1043 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
1044 N_("Do not page align data"), NULL);
1045 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
1046 N_("Do not page align data, do not make text readonly"),
1047 N_("Page align data, make text readonly"));
1048
358a9718
CC
1049 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
1050 N_("Use less memory and more disk I/O "
1051 "(included only for compatibility with GNU ld)"), NULL);
cdb0b8f5 1052
f3e9c5c5
ILT
1053 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
1054 N_("Report undefined symbols (even with --shared)"),
1055 NULL, false);
1056
358a9718
CC
1057 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
1058 N_("Create an output file even if errors occur"), NULL);
1059
1060 DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
1061 N_("Only search directories specified on the command line"),
1062 NULL);
1063
1064 // o
1065
ee1fe73e 1066 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
0c6e6c39 1067 N_("Set output file name"), N_("FILE"));
ee1fe73e 1068
358a9718
CC
1069 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
1070 N_("Set output format"), N_("[binary]"));
1071
ee1fe73e 1072 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
0c6e6c39 1073 N_("Optimize output file size"), N_("LEVEL"));
ee1fe73e 1074
358a9718 1075 // p
ee1fe73e 1076
358a9718
CC
1077 DEFINE_bool(p, options::ONE_DASH, 'p', false,
1078 N_("Ignored for ARM compatibility"), NULL);
7296d933 1079
374ad285 1080 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
81233653
ST
1081 N_("Create a position independent executable"),
1082 N_("Do not create a position independent executable"));
374ad285 1083 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
5f772412
ST
1084 N_("Create a position independent executable"),
1085 N_("Do not create a position independent executable"),
374ad285
ILT
1086 false);
1087
cdb06167
HS
1088 DEFINE_bool(pic_veneer, options::TWO_DASHES, '\0', false,
1089 N_("Force PIC sequences for ARM/Thumb interworking veneers"),
1090 NULL);
1091
7296d933
DK
1092 DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
1093 NULL, N_("(ARM only) Ignore for backward compatibility"));
1094
9e69ed50
AM
1095 DEFINE_var(plt_align, options::TWO_DASHES, '\0', 0, "5",
1096 N_("(PowerPC64 only) Align PLT call stubs to fit cache lines"),
358a9718 1097 N_("[=P2ALIGN]"), true, int, int, options::parse_uint, false);
9e69ed50
AM
1098
1099 DEFINE_bool(plt_static_chain, options::TWO_DASHES, '\0', false,
1100 N_("(PowerPC64 only) PLT call stubs should load r11"),
1101 N_("(PowerPC64 only) PLT call stubs should not load r11"));
1102
1103 DEFINE_bool(plt_thread_safe, options::TWO_DASHES, '\0', false,
1104 N_("(PowerPC64 only) PLT call stubs with load-load barrier"),
1105 N_("(PowerPC64 only) PLT call stubs without barrier"));
1106
89fc3421
CC
1107#ifdef ENABLE_PLUGINS
1108 DEFINE_special(plugin, options::TWO_DASHES, '\0',
0c6e6c39 1109 N_("Load a plugin library"), N_("PLUGIN"));
4674ecfc 1110 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
0c6e6c39 1111 N_("Pass an option to the plugin"), N_("OPTION"));
89fc3421
CC
1112#endif
1113
7c0640fa 1114 DEFINE_bool(posix_fallocate, options::TWO_DASHES, '\0', true,
358a9718
CC
1115 N_("Use posix_fallocate to reserve space in the output file"),
1116 N_("Use fallocate or ftruncate to reserve space"));
7c0640fa 1117
ac45a351 1118 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
0c6e6c39 1119 N_("Preread archive symbols when multi-threaded"), NULL);
89fc3421 1120
358a9718
CC
1121 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
1122 N_("List removed unused sections on stderr"),
1123 N_("Do not list removed unused sections"));
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
f1ddb600
ILT
1129 DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
1130 N_("Print default output format"), NULL);
1131
92de84a6
ILT
1132 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
1133 N_("Print symbols defined and used for each input"),
1134 N_("FILENAME"));
1135
376c3ecd
CC
1136 DEFINE_special(push_state, options::TWO_DASHES, '\0',
1137 N_("Save the state of flags related to input files"), NULL);
1138 DEFINE_special(pop_state, options::TWO_DASHES, '\0',
1139 N_("Restore the state of flags related to input files"), NULL);
1140
358a9718 1141 // q
b5be4a7c 1142
ee1fe73e 1143 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
0c6e6c39 1144 N_("Generate relocations in output"), NULL);
ee1fe73e 1145
358a9718
CC
1146 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
1147 N_("Ignored for SVR4 compatibility"), NULL);
1148
1149 // r
1150
ee1fe73e 1151 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
0c6e6c39 1152 N_("Generate relocatable output"), NULL);
ee1fe73e 1153
706e1f5e
ILT
1154 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
1155 N_("Relax branches on certain targets"), NULL);
1156
719328e1 1157 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
0c6e6c39 1158 N_("keep only symbols listed in this file"), N_("FILE"));
8c604651 1159
358a9718
CC
1160 DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
1161 N_("Put read-only non-executable sections in their own segment"),
1162 NULL);
1163
1164 DEFINE_uint64(rosegment_gap, options::TWO_DASHES, '\0', -1U,
1165 N_("Set offset between executable and read-only segments"),
1166 N_("OFFSET"));
1167
ee1fe73e
ILT
1168 // -R really means -rpath, but can mean --just-symbols for
1169 // compatibility with GNU ld. -rpath is always -rpath, so we list
1170 // it separately.
1171 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
0c6e6c39 1172 N_("Add DIR to runtime search path"), N_("DIR"));
ee1fe73e
ILT
1173
1174 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
0c6e6c39 1175 N_("Add DIR to runtime search path"), N_("DIR"));
ee1fe73e 1176
ee1fe73e 1177 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
0c6e6c39
RM
1178 N_("Add DIR to link time shared library search path"),
1179 N_("DIR"));
ee1fe73e 1180
358a9718
CC
1181 // s
1182
1183 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
1184 N_("Strip all symbols"), NULL);
1185 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
1186 N_("Strip debugging information"), NULL);
1187 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
1188 N_("Emit only debug line number information"), NULL);
1189 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
1190 N_("Strip debug symbols that are unused by gdb "
1191 "(at least versions <= 7.4)"), NULL);
1192 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
1193 N_("Strip LTO intermediate code sections"), NULL);
1194
6e9ba2ca 1195 DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
358a9718 1196 N_("Layout sections in the order specified"),
6e9ba2ca
ST
1197 N_("FILENAME"));
1198
a192ba05
ILT
1199 DEFINE_special(section_start, options::TWO_DASHES, '\0',
1200 N_("Set address of section"), N_("SECTION=ADDRESS"));
1201
fc59c572
ILT
1202 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
1203 N_("Sort common symbols by alignment"),
1204 N_("[={ascending,descending}]"));
1205
6934001a
CC
1206 DEFINE_enum(sort_section, options::TWO_DASHES, '\0', "none",
1207 N_("Sort sections by name. \'--no-text-reorder\'"
1208 " will override \'--sort-section=name\' for .text"),
1209 N_("[none,name]"),
1210 {"none", "name"});
1211
9e9e071b
ILT
1212 DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
1213 N_("Dynamic tag slots to reserve (default 5)"),
1214 N_("COUNT"));
1215
c0a62865 1216 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
0c6e6c39 1217 N_("(ARM, PowerPC only) The maximum distance from instructions "
358a9718
CC
1218 "in a group of sections to their stubs. Negative values mean "
1219 "stubs are always after (PowerPC before) the group. 1 means "
1220 "use default size"),
c0a62865
DK
1221 N_("SIZE"));
1222
364c7fa5
ILT
1223 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x4000,
1224 N_("Stack size when -fsplit-stack function calls non-split"),
1225 N_("SIZE"));
1226
ee1fe73e
ILT
1227 // This is not actually special in any way, but I need to give it
1228 // a non-standard accessor-function name because 'static' is a keyword.
1229 DEFINE_special(static, options::ONE_DASH, '\0',
0c6e6c39 1230 N_("Do not link against shared libraries"), NULL);
ee1fe73e 1231
358a9718
CC
1232 DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1233 N_("Start a library"), NULL);
1234 DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1235 N_("End a library "), NULL);
6d03d481 1236
ee1fe73e 1237 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
0c6e6c39 1238 N_("Print resource usage statistics"), NULL);
ee1fe73e
ILT
1239
1240 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
0c6e6c39 1241 N_("Set target system root directory"), N_("DIR"));
ee1fe73e 1242
358a9718
CC
1243 // t
1244
1245 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1246 N_("Print the name of each input file"), NULL);
1247
bc99685c
DK
1248 DEFINE_bool(target1_abs, options::TWO_DASHES, '\0', false,
1249 N_("(ARM only) Force R_ARM_TARGET1 type to R_ARM_ABS32"),
1250 NULL);
358a9718
CC
1251 DEFINE_bool(target1_rel, options::TWO_DASHES, '\0', false,
1252 N_("(ARM only) Force R_ARM_TARGET1 type to R_ARM_REL32"),
1253 NULL);
bc99685c
DK
1254 DEFINE_enum(target2, options::TWO_DASHES, '\0', NULL,
1255 N_("(ARM only) Set R_ARM_TARGET2 relocation type"),
1256 N_("[rel, abs, got-rel"),
1257 {"rel", "abs", "got-rel"});
1258
358a9718
CC
1259 DEFINE_bool(text_reorder, options::TWO_DASHES, '\0', true,
1260 N_("Enable text section reordering for GCC section names"),
1261 N_("Disable text section reordering for GCC section names"));
ee1fe73e
ILT
1262
1263 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
0c6e6c39
RM
1264 N_("Run the linker multi-threaded"),
1265 N_("Do not run the linker multi-threaded"));
ee1fe73e 1266 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
0c6e6c39 1267 N_("Number of threads to use"), N_("COUNT"));
ee1fe73e 1268 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
0c6e6c39 1269 N_("Number of threads to use in initial pass"), N_("COUNT"));
ee1fe73e 1270 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
0c6e6c39 1271 N_("Number of threads to use in middle pass"), N_("COUNT"));
ee1fe73e 1272 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
0c6e6c39 1273 N_("Number of threads to use in final pass"), N_("COUNT"));
ee1fe73e 1274
358a9718
CC
1275 DEFINE_bool(toc_optimize, options::TWO_DASHES, '\0', true,
1276 N_("(PowerPC64 only) Optimize TOC code sequences"),
1277 N_("(PowerPC64 only) Don't optimize TOC code sequences"));
1278
1279 DEFINE_bool(toc_sort, options::TWO_DASHES, '\0', true,
1280 N_("(PowerPC64 only) Sort TOC and GOT sections"),
1281 N_("(PowerPC64 only) Don't sort TOC and GOT sections"));
1282
1283 DEFINE_special(script, options::TWO_DASHES, 'T',
1284 N_("Read linker script"), N_("FILE"));
1285
fee2edb1 1286 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
0c6e6c39 1287 N_("Set the address of the bss segment"), N_("ADDRESS"));
fee2edb1 1288 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
0c6e6c39 1289 N_("Set the address of the data segment"), N_("ADDRESS"));
fee2edb1 1290 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
0c6e6c39 1291 N_("Set the address of the text segment"), N_("ADDRESS"));
214383dd
ILT
1292 DEFINE_uint64_alias(Ttext_segment, Ttext, options::ONE_DASH, '\0',
1293 N_("Set the address of the text segment"),
1294 N_("ADDRESS"));
a3ed37d8
RM
1295 DEFINE_uint64(Trodata_segment, options::ONE_DASH, '\0', -1U,
1296 N_("Set the address of the rodata segment"), N_("ADDRESS"));
fee2edb1 1297
358a9718 1298 // u
aba6bc71 1299
f3e9c5c5
ILT
1300 DEFINE_set(undefined, options::TWO_DASHES, 'u',
1301 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
2b706932 1302
beabb2c6
ILT
1303 DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1304 N_("How to handle unresolved symbols"),
1305 ("ignore-all,report-all,ignore-in-object-files,"
1306 "ignore-in-shared-libs"),
1307 {"ignore-all", "report-all", "ignore-in-object-files",
1308 "ignore-in-shared-libs"});
1309
358a9718
CC
1310 // v
1311
2285a610 1312 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
358a9718 1313 N_("Alias for --debug=files"), NULL);
2285a610 1314
fee2edb1 1315 DEFINE_special(version_script, options::TWO_DASHES, '\0',
0c6e6c39 1316 N_("Read version script"), N_("FILE"));
fee2edb1 1317
358a9718
CC
1318 // w
1319
1ae4d23b
ILT
1320 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1321 N_("Warn about duplicate common symbols"),
358a9718 1322 N_("Do not warn about duplicate common symbols"));
1ae4d23b 1323
358a9718
CC
1324 DEFINE_bool_ignore(warn_constructors, options::TWO_DASHES, '\0',
1325 N_("Ignored"), N_("Ignored"));
37a9ac43 1326
83e17bd5
CC
1327 DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1328 N_("Warn if the stack is executable"),
358a9718 1329 N_("Do not warn if the stack is executable"));
83e17bd5 1330
7296d933
DK
1331 DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1332 NULL, N_("Don't warn about mismatched input files"));
1333
6eda8c29
ILT
1334 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1335 N_("Ignored"), NULL);
1336
15f8229b
ILT
1337 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1338 N_("Warn when skipping an incompatible library"),
1339 N_("Don't warn when skipping an incompatible library"));
1340
b9674e17
ILT
1341 DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1342 N_("Warn if text segment is not shareable"),
358a9718 1343 N_("Do not warn if text segment is not shareable"));
b9674e17 1344
dc3f80fe
ILT
1345 DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1346 N_("Report unresolved symbols as warnings"),
1347 NULL);
1348 DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1349 options::TWO_DASHES, '\0',
1350 N_("Report unresolved symbols as errors"),
1351 NULL, true);
1352
ce0d1972
DK
1353 DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1354 N_("(ARM only) Do not warn about objects with incompatible "
1355 "wchar_t sizes"));
1356
358a9718
CC
1357 DEFINE_bool(weak_unresolved_symbols, options::TWO_DASHES, '\0', false,
1358 N_("Convert unresolved symbols to weak references"),
1359 NULL);
1360
ee1fe73e 1361 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
0c6e6c39
RM
1362 N_("Include all archive contents"),
1363 N_("Include only needed archive contents"));
ee1fe73e 1364
c5818ff1
CC
1365 DEFINE_set(wrap, options::TWO_DASHES, '\0',
1366 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1367
358a9718
CC
1368 // x
1369
1370 DEFINE_special(discard_all, options::TWO_DASHES, 'x',
1371 N_("Delete all local symbols"), NULL);
1372 DEFINE_special(discard_locals, options::TWO_DASHES, 'X',
1373 N_("Delete all temporary local symbols"), NULL);
1374 DEFINE_special(discard_none, options::TWO_DASHES, '\0',
1375 N_("Keep all local symbols"), NULL);
1376
1377 // y
1378
c5818ff1 1379 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
0c6e6c39 1380 N_("Trace references to symbol"), N_("SYMBOL"));
0864d551 1381
62dfdd4d 1382 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
358a9718 1383 N_("Allow unused version in script"),
62dfdd4d
ILT
1384 N_("Do not allow unused version in script"));
1385
706e1f5e
ILT
1386 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1387 N_("Default search path for Solaris compatibility"),
1388 N_("PATH"));
1389
358a9718
CC
1390 // special characters
1391
ee1fe73e 1392 DEFINE_special(start_group, options::TWO_DASHES, '(',
0c6e6c39 1393 N_("Start a library search group"), NULL);
ee1fe73e 1394 DEFINE_special(end_group, options::TWO_DASHES, ')',
0c6e6c39 1395 N_("End a library search group"), NULL);
ee1fe73e 1396
fee2edb1 1397 // The -z options.
ee1fe73e 1398
d98bc257
ILT
1399 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1400 N_("Sort dynamic relocs"),
1401 N_("Do not sort dynamic relocs"));
fee2edb1 1402 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
0c6e6c39 1403 N_("Set common page size to SIZE"), N_("SIZE"));
eb42429a 1404 DEFINE_bool(defs, options::DASH_Z, '\0', false,
0c6e6c39
RM
1405 N_("Report undefined symbols (even with --shared)"),
1406 NULL);
ee1fe73e 1407 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
0c6e6c39 1408 N_("Mark output as requiring executable stack"), NULL);
fb257835
DI
1409 DEFINE_bool(global, options::DASH_Z, '\0', false,
1410 N_("Make symbols in DSO available for subsequently loaded "
1130c90e 1411 "objects"), NULL);
7c414435
DM
1412 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1413 N_("Mark DSO to be initialized first at runtime"),
1414 NULL);
1415 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1416 N_("Mark object to interpose all DSOs but executable"),
1417 NULL);
6a9da32a 1418 DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
358a9718 1419 N_("Mark object for lazy runtime binding"),
6a9da32a 1420 NULL, true);
7c414435
DM
1421 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1422 N_("Mark object requiring immediate process"),
1423 NULL);
e1c74d60 1424 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
0c6e6c39 1425 N_("Set maximum page size to SIZE"), N_("SIZE"));
30bc8c46
ILT
1426 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1427 N_("Allow multiple definitions of symbols"),
1428 NULL);
1429 // copyreloc is here in the list because there is only -z
1430 // nocopyreloc, not -z copyreloc.
966d4097
DK
1431 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1432 NULL,
1433 N_("Do not create copy relocs"));
7c414435
DM
1434 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1435 N_("Mark object not to use default search paths"),
1436 NULL);
1437 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1438 N_("Mark DSO non-deletable at runtime"),
1439 NULL);
1440 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1441 N_("Mark DSO not available to dlopen"),
1442 NULL);
1443 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1444 N_("Mark DSO not available to dldump"),
1445 NULL);
e1c74d60 1446 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
0c6e6c39 1447 N_("Mark output as not requiring executable stack"), NULL);
e1c74d60
ILT
1448 DEFINE_bool(now, options::DASH_Z, '\0', false,
1449 N_("Mark object for immediate function binding"),
1450 NULL);
7be8330a
CD
1451 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1452 N_("Mark DSO to indicate that needs immediate $ORIGIN "
0c6e6c39 1453 "processing at runtime"), NULL);
6b1edb94 1454 DEFINE_bool(relro, options::DASH_Z, '\0', DEFAULT_LD_Z_RELRO,
e1c74d60
ILT
1455 N_("Where possible mark variables read-only after relocation"),
1456 N_("Don't mark variables read-only after relocation"));
1130c90e
RM
1457 DEFINE_uint64(stack_size, options::DASH_Z, '\0', 0,
1458 N_("Set PT_GNU_STACK segment p_memsz to SIZE"), N_("SIZE"));
ffeef7df
ILT
1459 DEFINE_bool(text, options::DASH_Z, '\0', false,
1460 N_("Do not permit relocations in read-only segments"),
358a9718 1461 N_("Permit relocations in read-only segments"));
ffeef7df 1462 DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
358a9718 1463 N_("Permit relocations in read-only segments"),
ffeef7df 1464 NULL, true);
bae7f79e 1465
ee1fe73e
ILT
1466 public:
1467 typedef options::Dir_list Dir_list;
ca3a67a5 1468
ee1fe73e 1469 General_options();
61ba1cf9 1470
ee1fe73e
ILT
1471 // Does post-processing on flags, making sure they all have
1472 // non-conflicting values. Also converts some flags from their
1473 // "standard" types (string, etc), to another type (enum, DirList),
1474 // which can be accessed via a separate method. Dies if it notices
1475 // any problems.
1476 void finalize();
516cb3d0 1477
459c9f1c
ILT
1478 // True if we printed the version information.
1479 bool
1480 printed_version() const
1481 { return this->printed_version_; }
1482
ee1fe73e
ILT
1483 // The macro defines output() (based on --output), but that's a
1484 // generic name. Provide this alternative name, which is clearer.
8851ecca 1485 const char*
ee1fe73e
ILT
1486 output_file_name() const
1487 { return this->output(); }
92e059d8 1488
8851ecca
ILT
1489 // This is not defined via a flag, but combines flags to say whether
1490 // the output is position-independent or not.
1491 bool
1492 output_is_position_independent() const
374ad285 1493 { return this->shared() || this->pie(); }
8851ecca 1494
183fd0e3
AO
1495 // Return true if the output is something that can be exec()ed, such
1496 // as a static executable, or a position-dependent or
1497 // position-independent executable, but not a dynamic library or an
1498 // object file.
1499 bool
1500 output_is_executable() const
374ad285 1501 { return !this->shared() && !this->relocatable(); }
183fd0e3 1502
ee1fe73e
ILT
1503 // This would normally be static(), and defined automatically, but
1504 // since static is a keyword, we need to come up with our own name.
bae7f79e
ILT
1505 bool
1506 is_static() const
ee1fe73e 1507 { return static_; }
756ac4a8 1508
ee1fe73e
ILT
1509 // In addition to getting the input and output formats as a string
1510 // (via format() and oformat()), we also give access as an enum.
1511 enum Object_format
1512 {
1513 // Ordinary ELF.
1514 OBJECT_FORMAT_ELF,
1515 // Straight binary format.
1516 OBJECT_FORMAT_BINARY
1517 };
fe9a4c12 1518
e6a307ba
ILT
1519 // Convert a string to an Object_format. Gives an error if the
1520 // string is not recognized.
1521 static Object_format
1522 string_to_object_format(const char* arg);
1523
376c3ecd
CC
1524 // Convert an Object_format to string.
1525 static const char*
1526 object_format_to_string(Object_format);
1527
ee1fe73e
ILT
1528 // Note: these functions are not very fast.
1529 Object_format format_enum() const;
1530 Object_format oformat_enum() const;
fe9a4c12 1531
fd9d194f
ILT
1532 // Return whether FILENAME is in a system directory.
1533 bool
1534 is_in_system_directory(const std::string& name) const;
1535
8c604651
CS
1536 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1537 bool
1538 should_retain_symbol(const char* symbol_name) const
1539 {
1540 if (symbols_to_retain_.empty()) // means flag wasn't specified
0c6e6c39 1541 return true;
8c604651
CS
1542 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1543 }
1544
ee1fe73e
ILT
1545 // These are the best way to get access to the execstack state,
1546 // not execstack() and noexecstack() which are hard to use properly.
35cdfc9a
ILT
1547 bool
1548 is_execstack_set() const
ee1fe73e 1549 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
35cdfc9a
ILT
1550
1551 bool
1552 is_stack_executable() const
ee1fe73e 1553 { return this->execstack_status_ == EXECSTACK_YES; }
c7912668 1554
032ce4e9
ST
1555 bool
1556 icf_enabled() const
1557 { return this->icf_status_ != ICF_NONE; }
1558
1559 bool
1560 icf_safe_folding() const
1561 { return this->icf_status_ == ICF_SAFE; }
1562
086a1841
ILT
1563 // The --demangle option takes an optional string, and there is also
1564 // a --no-demangle option. This is the best way to decide whether
1565 // to demangle or not.
1566 bool
1567 do_demangle() const
1568 { return this->do_demangle_; }
1569
89fc3421
CC
1570 // Returns TRUE if any plugin libraries have been loaded.
1571 bool
1572 has_plugins() const
1573 { return this->plugins_ != NULL; }
1574
1575 // Return a pointer to the plugin manager.
1576 Plugin_manager*
1577 plugins() const
1578 { return this->plugins_; }
1579
c82fbeee
CS
1580 // True iff SYMBOL was found in the file specified by dynamic-list.
1581 bool
1582 in_dynamic_list(const char* symbol) const
1583 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1584
fd834e57
CC
1585 // True if a --dynamic-list script was provided.
1586 bool
1587 have_dynamic_list() const
1588 { return this->have_dynamic_list_; }
1589
6affe781
ILT
1590 // Finalize the dynamic list.
1591 void
1592 finalize_dynamic_list()
1593 { this->dynamic_list_.version_script_info()->finalize(); }
1594
8c21d9d3
CC
1595 // The mode selected by the --incremental options.
1596 enum Incremental_mode
1597 {
1598 // No incremental linking (--no-incremental).
1599 INCREMENTAL_OFF,
1600 // Incremental update only (--incremental-update).
1601 INCREMENTAL_UPDATE,
1602 // Force a full link, but prepare for subsequent incremental link
1603 // (--incremental-full).
1604 INCREMENTAL_FULL,
1605 // Incremental update if possible, fallback to full link (--incremental).
1606 INCREMENTAL_AUTO
1607 };
1608
1609 // The incremental linking mode.
1610 Incremental_mode
1611 incremental_mode() const
1612 { return this->incremental_mode_; }
1613
266d0a74
ILT
1614 // The disposition given by the --incremental-changed,
1615 // --incremental-unchanged or --incremental-unknown option. The
1616 // value may change as we proceed parsing the command line flags.
1617 Incremental_disposition
1618 incremental_disposition() const
1619 { return this->incremental_disposition_; }
1620
376c3ecd
CC
1621 void
1622 set_incremental_disposition(Incremental_disposition disp)
1623 { this->incremental_disposition_ = disp; }
1624
221597a5
CC
1625 // The disposition to use for startup files (those that precede the
1626 // first --incremental-changed, etc. option).
1627 Incremental_disposition
1628 incremental_startup_disposition() const
1629 { return this->incremental_startup_disposition_; }
1630
65514900
CC
1631 // Return true if S is the name of a library excluded from automatic
1632 // symbol export.
1633 bool
ca09d69a 1634 check_excluded_libs(const std::string &s) const;
65514900 1635
a192ba05
ILT
1636 // If an explicit start address was given for section SECNAME with
1637 // the --section-start option, return true and set *PADDR to the
1638 // address. Otherwise return false.
1639 bool
1640 section_start(const char* secname, uint64_t* paddr) const;
1641
ea0d8c47
ILT
1642 // Return whether any --section-start option was used.
1643 bool
1644 any_section_start() const
1645 { return !this->section_starts_.empty(); }
1646
9b2fd367
DK
1647 enum Fix_v4bx
1648 {
1649 // Leave original instruction.
1650 FIX_V4BX_NONE,
1651 // Replace instruction.
1652 FIX_V4BX_REPLACE,
1653 // Generate an interworking veneer.
1654 FIX_V4BX_INTERWORKING
1655 };
1656
1657 Fix_v4bx
1658 fix_v4bx() const
1659 { return (this->fix_v4bx_); }
1660
7296d933
DK
1661 enum Endianness
1662 {
1663 ENDIANNESS_NOT_SET,
1664 ENDIANNESS_BIG,
1665 ENDIANNESS_LITTLE
1666 };
1667
1668 Endianness
1669 endianness() const
1670 { return this->endianness_; }
1671
cd3c333f
CC
1672 bool
1673 discard_all() const
1674 { return this->discard_locals_ == DISCARD_ALL; }
1675
1676 bool
1677 discard_locals() const
1678 { return this->discard_locals_ == DISCARD_LOCALS; }
1679
1680 bool
1681 discard_sec_merge() const
1682 { return this->discard_locals_ == DISCARD_SEC_MERGE; }
1683
bae7f79e 1684 private:
dbe717ef
ILT
1685 // Don't copy this structure.
1686 General_options(const General_options&);
1687 General_options& operator=(const General_options&);
1688
cd3c333f
CC
1689 // What local symbols to discard.
1690 enum Discard_locals
1691 {
1692 // Locals in merge sections (default).
1693 DISCARD_SEC_MERGE,
1694 // None (--discard-none).
1695 DISCARD_NONE,
1696 // Temporary locals (--discard-locals/-X).
1697 DISCARD_LOCALS,
1698 // All locals (--discard-all/-x).
1699 DISCARD_ALL
1700 };
1701
35cdfc9a
ILT
1702 // Whether to mark the stack as executable.
1703 enum Execstack
1704 {
1705 // Not set on command line.
1706 EXECSTACK_FROM_INPUT,
ee1fe73e 1707 // Mark the stack as executable (-z execstack).
35cdfc9a 1708 EXECSTACK_YES,
ee1fe73e 1709 // Mark the stack as not executable (-z noexecstack).
35cdfc9a
ILT
1710 EXECSTACK_NO
1711 };
1712
032ce4e9
ST
1713 enum Icf_status
1714 {
1715 // Do not fold any functions (Default or --icf=none).
1716 ICF_NONE,
1717 // All functions are candidates for folding. (--icf=all).
0c6e6c39 1718 ICF_ALL,
032ce4e9
ST
1719 // Only ctors and dtors are candidates for folding. (--icf=safe).
1720 ICF_SAFE
1721 };
1722
1723 void
1724 set_icf_status(Icf_status value)
1725 { this->icf_status_ = value; }
1726
92e059d8 1727 void
ee1fe73e 1728 set_execstack_status(Execstack value)
086a1841
ILT
1729 { this->execstack_status_ = value; }
1730
1731 void
1732 set_do_demangle(bool value)
1733 { this->do_demangle_ = value; }
92e059d8 1734
bae7f79e 1735 void
45aa233b 1736 set_static(bool value)
ee1fe73e 1737 { static_ = value; }
652ec9bd 1738
ee1fe73e 1739 // These are called by finalize() to set up the search-path correctly.
35cdfc9a 1740 void
3f3cddf1 1741 add_to_library_path_with_sysroot(const std::string& arg)
ee1fe73e 1742 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
c7912668 1743
ad2d6943
ILT
1744 // Apply any sysroot to the directory lists.
1745 void
1746 add_sysroot();
086a1841 1747
89fc3421
CC
1748 // Add a plugin and its arguments to the list of plugins.
1749 void
ca09d69a 1750 add_plugin(const char* filename);
4674ecfc
CC
1751
1752 // Add a plugin option.
1753 void
1754 add_plugin_option(const char* opt);
89fc3421 1755
376c3ecd
CC
1756 void
1757 copy_from_posdep_options(const Position_dependent_options&);
1758
459c9f1c
ILT
1759 // Whether we printed version information.
1760 bool printed_version_;
086a1841
ILT
1761 // Whether to mark the stack as executable.
1762 Execstack execstack_status_;
032ce4e9
ST
1763 // Whether to do code folding.
1764 Icf_status icf_status_;
086a1841
ILT
1765 // Whether to do a static link.
1766 bool static_;
1767 // Whether to do demangling.
1768 bool do_demangle_;
89fc3421
CC
1769 // List of plugin libraries.
1770 Plugin_manager* plugins_;
c82fbeee
CS
1771 // The parsed output of --dynamic-list files. For convenience in
1772 // script.cc, we store this as a Script_options object, even though
1773 // we only use a single Version_tree from it.
1774 Script_options dynamic_list_;
fd834e57
CC
1775 // Whether a --dynamic-list file was provided.
1776 bool have_dynamic_list_;
8c21d9d3
CC
1777 // The incremental linking mode.
1778 Incremental_mode incremental_mode_;
266d0a74
ILT
1779 // The disposition given by the --incremental-changed,
1780 // --incremental-unchanged or --incremental-unknown option. The
1781 // value may change as we proceed parsing the command line flags.
1782 Incremental_disposition incremental_disposition_;
221597a5
CC
1783 // The disposition to use for startup files (those marked
1784 // INCREMENTAL_STARTUP).
1785 Incremental_disposition incremental_startup_disposition_;
459c9f1c 1786 // Whether we have seen one of the options that require incremental
221597a5
CC
1787 // build (--incremental-changed, --incremental-unchanged,
1788 // --incremental-unknown, or --incremental-startup-unchanged).
266d0a74 1789 bool implicit_incremental_;
8c604651 1790 // Libraries excluded from automatic export, via --exclude-libs.
65514900 1791 Unordered_set<std::string> excluded_libs_;
8c604651
CS
1792 // List of symbol-names to keep, via -retain-symbol-info.
1793 Unordered_set<std::string> symbols_to_retain_;
a192ba05
ILT
1794 // Map from section name to address from --section-start.
1795 std::map<std::string, uint64_t> section_starts_;
9b2fd367
DK
1796 // Whether to process armv4 bx instruction relocation.
1797 Fix_v4bx fix_v4bx_;
7296d933
DK
1798 // Endianness.
1799 Endianness endianness_;
cd3c333f
CC
1800 // What local symbols to discard.
1801 Discard_locals discard_locals_;
376c3ecd
CC
1802 // Stack of saved options for --push-state/--pop-state.
1803 std::vector<Position_dependent_options*> options_stack_;
bae7f79e
ILT
1804};
1805
ee1fe73e
ILT
1806// The position-dependent options. We use this to store the state of
1807// the commandline at a particular point in parsing for later
1808// reference. For instance, if we see "ld --whole-archive foo.a
1809// --no-whole-archive," we want to store the whole-archive option with
1810// foo.a, so when the time comes to parse foo.a we know we should do
1811// it in whole-archive mode. We could store all of General_options,
1812// but that's big, so we just pick the subset of flags that actually
1813// change in a position-dependent way.
1814
1815#define DEFINE_posdep(varname__, type__) \
1816 public: \
1817 type__ \
1818 varname__() const \
1819 { return this->varname__##_; } \
0c6e6c39 1820 \
ee1fe73e
ILT
1821 void \
1822 set_##varname__(type__ value) \
1823 { this->varname__##_ = value; } \
1824 private: \
1825 type__ varname__##_
bae7f79e
ILT
1826
1827class Position_dependent_options
1828{
1829 public:
ee1fe73e 1830 Position_dependent_options(const General_options& options
0c6e6c39 1831 = Position_dependent_options::default_options_)
ee1fe73e 1832 { copy_from_options(options); }
bae7f79e 1833
376c3ecd
CC
1834 void
1835 copy_from_options(const General_options& options)
ee1fe73e
ILT
1836 {
1837 this->set_as_needed(options.as_needed());
1838 this->set_Bdynamic(options.Bdynamic());
1839 this->set_format_enum(options.format_enum());
1840 this->set_whole_archive(options.whole_archive());
266d0a74 1841 this->set_incremental_disposition(options.incremental_disposition());
ee1fe73e 1842 }
bc644c6c 1843
ee1fe73e
ILT
1844 DEFINE_posdep(as_needed, bool);
1845 DEFINE_posdep(Bdynamic, bool);
1846 DEFINE_posdep(format_enum, General_options::Object_format);
1847 DEFINE_posdep(whole_archive, bool);
266d0a74 1848 DEFINE_posdep(incremental_disposition, Incremental_disposition);
7cc619c3 1849
dbe717ef 1850 private:
ee1fe73e
ILT
1851 // This is a General_options with everything set to its default
1852 // value. A Position_dependent_options created with no argument
1853 // will take its values from here.
1854 static General_options default_options_;
bae7f79e
ILT
1855};
1856
ee1fe73e 1857
bae7f79e
ILT
1858// A single file or library argument from the command line.
1859
ead1e424 1860class Input_file_argument
bae7f79e
ILT
1861{
1862 public:
ae3b5189
CD
1863 enum Input_file_type
1864 {
1865 // A regular file, name used as-is, not searched.
1866 INPUT_FILE_TYPE_FILE,
1867 // A library name. When used, "lib" will be prepended and ".so" or
1868 // ".a" appended to make a filename, and that filename will be searched
1869 // for using the -L paths.
1870 INPUT_FILE_TYPE_LIBRARY,
1871 // A regular file, name used as-is, but searched using the -L paths.
1872 INPUT_FILE_TYPE_SEARCHED_FILE
1873 };
1874
51dee2fe 1875 // name: file name or library name
ae3b5189 1876 // type: the type of this input file.
51dee2fe
ILT
1877 // extra_search_path: an extra directory to look for the file, prior
1878 // to checking the normal library search path. If this is "",
1879 // then no extra directory is added.
88dd47ac 1880 // just_symbols: whether this file only defines symbols.
51dee2fe 1881 // options: The position dependent options at this point in the
ad2d6943 1882 // command line, such as --whole-archive.
ead1e424 1883 Input_file_argument()
ae3b5189 1884 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
cdc29364 1885 just_symbols_(false), options_(), arg_serial_(0)
ead1e424
ILT
1886 { }
1887
2ea97941 1888 Input_file_argument(const char* name, Input_file_type type,
0c6e6c39
RM
1889 const char* extra_search_path,
1890 bool just_symbols,
1891 const Position_dependent_options& options)
2ea97941 1892 : name_(name), type_(type), extra_search_path_(extra_search_path),
cdc29364 1893 just_symbols_(just_symbols), options_(options), arg_serial_(0)
ee1fe73e
ILT
1894 { }
1895
1896 // You can also pass in a General_options instance instead of a
1897 // Position_dependent_options. In that case, we extract the
1898 // position-independent vars from the General_options and only store
1899 // those.
2ea97941 1900 Input_file_argument(const char* name, Input_file_type type,
0c6e6c39
RM
1901 const char* extra_search_path,
1902 bool just_symbols,
1903 const General_options& options)
2ea97941 1904 : name_(name), type_(type), extra_search_path_(extra_search_path),
cdc29364 1905 just_symbols_(just_symbols), options_(options), arg_serial_(0)
bae7f79e
ILT
1906 { }
1907
1908 const char*
1909 name() const
dbe717ef 1910 { return this->name_.c_str(); }
bae7f79e
ILT
1911
1912 const Position_dependent_options&
1913 options() const
1914 { return this->options_; }
1915
1916 bool
1917 is_lib() const
ae3b5189
CD
1918 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
1919
1920 bool
1921 is_searched_file() const
1922 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
bae7f79e 1923
51dee2fe
ILT
1924 const char*
1925 extra_search_path() const
1926 {
1927 return (this->extra_search_path_.empty()
0c6e6c39
RM
1928 ? NULL
1929 : this->extra_search_path_.c_str());
51dee2fe
ILT
1930 }
1931
88dd47ac
ILT
1932 // Return whether we should only read symbols from this file.
1933 bool
1934 just_symbols() const
1935 { return this->just_symbols_; }
1936
51dee2fe
ILT
1937 // Return whether this file may require a search using the -L
1938 // options.
1939 bool
1940 may_need_search() const
ae3b5189
CD
1941 {
1942 return (this->is_lib()
1943 || this->is_searched_file()
1944 || !this->extra_search_path_.empty());
1945 }
51dee2fe 1946
cdc29364
CC
1947 // Set the serial number for this argument.
1948 void
1949 set_arg_serial(unsigned int arg_serial)
1950 { this->arg_serial_ = arg_serial; }
1951
1952 // Get the serial number.
1953 unsigned int
1954 arg_serial() const
1955 { return this->arg_serial_; }
1956
bae7f79e 1957 private:
dbe717ef
ILT
1958 // We use std::string, not const char*, here for convenience when
1959 // using script files, so that we do not have to preserve the string
1960 // in that case.
1961 std::string name_;
ae3b5189 1962 Input_file_type type_;
51dee2fe 1963 std::string extra_search_path_;
88dd47ac 1964 bool just_symbols_;
bae7f79e 1965 Position_dependent_options options_;
cdc29364
CC
1966 // A unique index for this file argument in the argument list.
1967 unsigned int arg_serial_;
bae7f79e
ILT
1968};
1969
ead1e424
ILT
1970// A file or library, or a group, from the command line.
1971
1972class Input_argument
1973{
1974 public:
1975 // Create a file or library argument.
2ea97941 1976 explicit Input_argument(Input_file_argument file)
c7975edd 1977 : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
ead1e424
ILT
1978 { }
1979
1980 // Create a group argument.
2ea97941 1981 explicit Input_argument(Input_file_group* group)
c7975edd 1982 : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
b0193076
RÁE
1983 { }
1984
1985 // Create a lib argument.
1986 explicit Input_argument(Input_file_lib* lib)
c7975edd 1987 : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
ead1e424
ILT
1988 { }
1989
1990 // Return whether this is a file.
1991 bool
1992 is_file() const
1993 { return this->is_file_; }
1994
1995 // Return whether this is a group.
1996 bool
1997 is_group() const
b0193076
RÁE
1998 { return !this->is_file_ && this->lib_ == NULL; }
1999
2000 // Return whether this is a lib.
2001 bool
2002 is_lib() const
2003 { return this->lib_ != NULL; }
ead1e424
ILT
2004
2005 // Return the information about the file.
2006 const Input_file_argument&
2007 file() const
2008 {
a3ad94ed 2009 gold_assert(this->is_file_);
ead1e424
ILT
2010 return this->file_;
2011 }
2012
2013 // Return the information about the group.
2014 const Input_file_group*
2015 group() const
2016 {
a3ad94ed 2017 gold_assert(!this->is_file_);
ead1e424
ILT
2018 return this->group_;
2019 }
2020
2021 Input_file_group*
2022 group()
2023 {
a3ad94ed 2024 gold_assert(!this->is_file_);
ead1e424
ILT
2025 return this->group_;
2026 }
2027
b0193076
RÁE
2028 // Return the information about the lib.
2029 const Input_file_lib*
2030 lib() const
2031 {
2032 gold_assert(!this->is_file_);
2033 gold_assert(this->lib_);
2034 return this->lib_;
2035 }
2036
2037 Input_file_lib*
2038 lib()
2039 {
2040 gold_assert(!this->is_file_);
2041 gold_assert(this->lib_);
2042 return this->lib_;
2043 }
2044
c7975edd
CC
2045 // If a script generated this argument, store a pointer to the script info.
2046 // Currently used only for recording incremental link information.
2047 void
2048 set_script_info(Script_info* info)
2049 { this->script_info_ = info; }
2050
2051 Script_info*
2052 script_info() const
2053 { return this->script_info_; }
2054
ead1e424
ILT
2055 private:
2056 bool is_file_;
2057 Input_file_argument file_;
2058 Input_file_group* group_;
b0193076 2059 Input_file_lib* lib_;
c7975edd 2060 Script_info* script_info_;
ead1e424
ILT
2061};
2062
072fe7ce
ILT
2063typedef std::vector<Input_argument> Input_argument_list;
2064
ead1e424
ILT
2065// A group from the command line. This is a set of arguments within
2066// --start-group ... --end-group.
2067
2068class Input_file_group
92e059d8 2069{
ead1e424 2070 public:
072fe7ce 2071 typedef Input_argument_list::const_iterator const_iterator;
ead1e424
ILT
2072
2073 Input_file_group()
2074 : files_()
2075 { }
2076
2077 // Add a file to the end of the group.
c7975edd 2078 Input_argument&
ead1e424 2079 add_file(const Input_file_argument& arg)
c7975edd
CC
2080 {
2081 this->files_.push_back(Input_argument(arg));
2082 return this->files_.back();
2083 }
ead1e424
ILT
2084
2085 // Iterators to iterate over the group contents.
2086
2087 const_iterator
2088 begin() const
2089 { return this->files_.begin(); }
2090
2091 const_iterator
2092 end() const
2093 { return this->files_.end(); }
2094
2095 private:
072fe7ce 2096 Input_argument_list files_;
92e059d8
ILT
2097};
2098
b0193076
RÁE
2099// A lib from the command line. This is a set of arguments within
2100// --start-lib ... --end-lib.
2101
2102class Input_file_lib
2103{
2104 public:
2105 typedef Input_argument_list::const_iterator const_iterator;
2106
2107 Input_file_lib(const Position_dependent_options& options)
2108 : files_(), options_(options)
2109 { }
2110
2111 // Add a file to the end of the lib.
c7975edd 2112 Input_argument&
b0193076 2113 add_file(const Input_file_argument& arg)
c7975edd
CC
2114 {
2115 this->files_.push_back(Input_argument(arg));
2116 return this->files_.back();
2117 }
b0193076
RÁE
2118
2119 const Position_dependent_options&
2120 options() const
2121 { return this->options_; }
2122
2123 // Iterators to iterate over the lib contents.
2124
2125 const_iterator
2126 begin() const
2127 { return this->files_.begin(); }
2128
2129 const_iterator
2130 end() const
2131 { return this->files_.end(); }
2132
2133 size_t
2134 size() const
2135 { return this->files_.size(); }
2136
2137 private:
2138 Input_argument_list files_;
2139 Position_dependent_options options_;
2140};
2141
dbe717ef
ILT
2142// A list of files from the command line or a script.
2143
2144class Input_arguments
2145{
2146 public:
dbe717ef
ILT
2147 typedef Input_argument_list::const_iterator const_iterator;
2148
2149 Input_arguments()
cdc29364 2150 : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
dbe717ef
ILT
2151 { }
2152
2153 // Add a file.
c7975edd 2154 Input_argument&
cdc29364 2155 add_file(Input_file_argument& arg);
dbe717ef
ILT
2156
2157 // Start a group (the --start-group option).
2158 void
2159 start_group();
2160
2161 // End a group (the --end-group option).
2162 void
2163 end_group();
2164
b0193076
RÁE
2165 // Start a lib (the --start-lib option).
2166 void
2167 start_lib(const Position_dependent_options&);
2168
2169 // End a lib (the --end-lib option).
2170 void
2171 end_lib();
2172
dbe717ef
ILT
2173 // Return whether we are currently in a group.
2174 bool
2175 in_group() const
2176 { return this->in_group_; }
2177
b0193076
RÁE
2178 // Return whether we are currently in a lib.
2179 bool
2180 in_lib() const
2181 { return this->in_lib_; }
2182
fe9a4c12
ILT
2183 // The number of entries in the list.
2184 int
2185 size() const
2186 { return this->input_argument_list_.size(); }
2187
dbe717ef
ILT
2188 // Iterators to iterate over the list of input files.
2189
2190 const_iterator
2191 begin() const
2192 { return this->input_argument_list_.begin(); }
2193
2194 const_iterator
2195 end() const
2196 { return this->input_argument_list_.end(); }
2197
2198 // Return whether the list is empty.
2199 bool
2200 empty() const
2201 { return this->input_argument_list_.empty(); }
2202
cdc29364
CC
2203 // Return the number of input files. This may be larger than
2204 // input_argument_list_.size(), because of files that are part
2205 // of groups or libs.
2206 int
2207 number_of_input_files() const
2208 { return this->file_count_; }
2209
dbe717ef
ILT
2210 private:
2211 Input_argument_list input_argument_list_;
2212 bool in_group_;
b0193076 2213 bool in_lib_;
cdc29364 2214 unsigned int file_count_;
dbe717ef
ILT
2215};
2216
ee1fe73e
ILT
2217
2218// All the information read from the command line. These are held in
2219// three separate structs: one to hold the options (--foo), one to
2220// hold the filenames listed on the commandline, and one to hold
2221// linker script information. This third is not a subset of the other
2222// two because linker scripts can be specified either as options (via
2223// -T) or as a file.
bae7f79e
ILT
2224
2225class Command_line
2226{
2227 public:
ead1e424
ILT
2228 typedef Input_arguments::const_iterator const_iterator;
2229
a5dc0706 2230 Command_line();
bae7f79e
ILT
2231
2232 // Process the command line options. This will exit with an
2233 // appropriate error message if an unrecognized option is seen.
2234 void
ee1fe73e 2235 process(int argc, const char** argv);
bae7f79e 2236
a0451b38 2237 // Process one command-line option. This takes the index of argv to
ee1fe73e
ILT
2238 // process, and returns the index for the next option. no_more_options
2239 // is set to true if argv[i] is "--".
61ba1cf9 2240 int
ee1fe73e 2241 process_one_option(int argc, const char** argv, int i,
0c6e6c39 2242 bool* no_more_options);
3c2fafa5 2243
61ba1cf9 2244 // Get the general options.
bae7f79e
ILT
2245 const General_options&
2246 options() const
2247 { return this->options_; }
2248
3c2fafa5
ILT
2249 // Get the position dependent options.
2250 const Position_dependent_options&
2251 position_dependent_options() const
2252 { return this->position_options_; }
2253
a5dc0706
ILT
2254 // Get the linker-script options.
2255 Script_options&
e5756efb 2256 script_options()
a5dc0706 2257 { return this->script_options_; }
e5756efb 2258
6affe781 2259 // Finalize the version-script options and return them.
a5dc0706 2260 const Version_script_info&
6affe781 2261 version_script();
e5756efb 2262
ee1fe73e
ILT
2263 // Get the input files.
2264 Input_arguments&
2265 inputs()
2266 { return this->inputs_; }
2267
fe9a4c12
ILT
2268 // The number of input files.
2269 int
2270 number_of_input_files() const
cdc29364 2271 { return this->inputs_.number_of_input_files(); }
fe9a4c12 2272
ead1e424
ILT
2273 // Iterators to iterate over the list of input files.
2274
2275 const_iterator
2276 begin() const
2277 { return this->inputs_.begin(); }
2278
2279 const_iterator
2280 end() const
2281 { return this->inputs_.end(); }
bae7f79e
ILT
2282
2283 private:
ead1e424
ILT
2284 Command_line(const Command_line&);
2285 Command_line& operator=(const Command_line&);
2286
293c1386
CC
2287 // This is a dummy class to provide a constructor that runs before
2288 // the constructor for the General_options. The Pre_options constructor
2289 // is used as a hook to set the flag enabling the options to register
2290 // themselves.
2291 struct Pre_options {
2292 Pre_options();
2293 };
2294
2295 // This must come before options_!
2296 Pre_options pre_options_;
bae7f79e
ILT
2297 General_options options_;
2298 Position_dependent_options position_options_;
a5dc0706 2299 Script_options script_options_;
ead1e424 2300 Input_arguments inputs_;
bae7f79e
ILT
2301};
2302
2303} // End namespace gold.
2304
2305#endif // !defined(GOLD_OPTIONS_H)
This page took 0.563951 seconds and 4 git commands to generate.