PR27140, ppc32 segmentation fault in make_stub
[deliverable/binutils-gdb.git] / gold / options.h
CommitLineData
bae7f79e
ILT
1// options.h -- handle command line options for gold -*- C++ -*-
2
250d07de 3// Copyright (C) 2006-2021 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 \
0b65c07b 474 { return this->varname__##_.value.end(); } \
f37b21b4 475 \
0b65c07b
ST
476 options::String_set::size_type \
477 varname__##_size() const \
478 { return this->varname__##_.value.size(); } \
c5818ff1 479
ee1fe73e
ILT
480// When you have a list of possible values (expressed as string)
481// After helparg__ should come an initializer list, like
482// {"foo", "bar", "baz"}
483#define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \
afd2ea23 484 helpstring__, helparg__, optional_arg__, ...) \
ee1fe73e 485 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
afd2ea23 486 default_value__, helpstring__, helparg__, optional_arg__, \
358a9718 487 const char*, const char*, parse_choices_##varname__, false) \
ee1fe73e
ILT
488 private: \
489 static void parse_choices_##varname__(const char* option_name, \
0c6e6c39
RM
490 const char* arg, \
491 const char** retval) { \
ee1fe73e
ILT
492 const char* choices[] = __VA_ARGS__; \
493 options::parse_choices(option_name, arg, retval, \
0c6e6c39 494 choices, sizeof(choices) / sizeof(*choices)); \
ee1fe73e
ILT
495 }
496
2b706932
ILT
497// This is like DEFINE_bool, but VARNAME is the name of a different
498// option. This option becomes an alias for that one. INVERT is true
499// if this option is an inversion of the other one.
500#define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \
501 helpstring__, no_helpstring__, invert__) \
502 private: \
503 struct Struct_##option__ : public options::Struct_var \
504 { \
505 Struct_##option__() \
506 : option(#option__, dashes__, shortname__, "", helpstring__, \
358a9718
CC
507 NULL, false, this, \
508 General_options::varname__##is_default ^ invert__) \
2b706932
ILT
509 { } \
510 \
511 void \
512 parse_to_value(const char*, const char*, \
513 Command_line*, General_options* options) \
514 { \
515 options->set_##varname__(!invert__); \
516 options->set_user_set_##varname__(); \
517 } \
518 \
519 options::One_option option; \
520 }; \
521 Struct_##option__ option__##_; \
522 \
523 struct Struct_no_##option__ : public options::Struct_var \
524 { \
525 Struct_no_##option__() \
526 : option((dashes__ == options::DASH_Z \
527 ? "no" #option__ \
528 : "no-" #option__), \
529 dashes__, '\0', "", no_helpstring__, \
358a9718
CC
530 NULL, false, this, \
531 !General_options::varname__##is_default ^ invert__) \
2b706932
ILT
532 { } \
533 \
534 void \
535 parse_to_value(const char*, const char*, \
536 Command_line*, General_options* options) \
537 { \
538 options->set_##varname__(invert__); \
539 options->set_user_set_##varname__(); \
540 } \
541 \
542 options::One_option option; \
543 }; \
544 Struct_no_##option__ no_##option__##_initializer_
545
214383dd
ILT
546// This is like DEFINE_uint64, but VARNAME is the name of a different
547// option. This option becomes an alias for that one.
548#define DEFINE_uint64_alias(option__, varname__, dashes__, shortname__, \
549 helpstring__, helparg__) \
550 private: \
551 struct Struct_##option__ : public options::Struct_var \
552 { \
553 Struct_##option__() \
554 : option(#option__, dashes__, shortname__, "", helpstring__, \
358a9718 555 helparg__, false, this, false) \
214383dd
ILT
556 { } \
557 \
558 void \
559 parse_to_value(const char* option_name, const char* arg, \
560 Command_line*, General_options* options) \
561 { \
562 uint64_t value; \
563 options::parse_uint64(option_name, arg, &value); \
564 options->set_##varname__(value); \
565 options->set_user_set_##varname__(); \
566 } \
567 \
568 options::One_option option; \
569 }; \
570 Struct_##option__ option__##_;
571
ee1fe73e
ILT
572// This is used for non-standard flags. It defines no functions; it
573// just calls General_options::parse_VARNAME whenever the flag is
574// seen. We declare parse_VARNAME as a static member of
575// General_options; you are responsible for defining it there.
576// helparg__ should be NULL iff this special-option is a boolean.
577#define DEFINE_special(varname__, dashes__, shortname__, \
0c6e6c39 578 helpstring__, helparg__) \
ee1fe73e
ILT
579 private: \
580 void parse_##varname__(const char* option, const char* arg, \
0c6e6c39 581 Command_line* inputs); \
ee1fe73e
ILT
582 struct Struct_##varname__ : public options::Struct_special \
583 { \
584 Struct_##varname__() \
585 : options::Struct_special(#varname__, dashes__, shortname__, \
0c6e6c39
RM
586 &General_options::parse_##varname__, \
587 helpstring__, helparg__) \
ee1fe73e
ILT
588 { } \
589 }; \
590 Struct_##varname__ varname__##_initializer_
bae7f79e 591
086a1841
ILT
592// An option that takes an optional string argument. If the option is
593// used with no argument, the value will be the default, and
594// user_set_via_option will be true.
595#define DEFINE_optional_string(varname__, dashes__, shortname__, \
596 default_value__, \
597 helpstring__, helparg__) \
598 DEFINE_var(varname__, dashes__, shortname__, default_value__, \
0c6e6c39 599 default_value__, helpstring__, helparg__, true, \
358a9718
CC
600 const char*, const char*, options::parse_optional_string, \
601 false)
bae7f79e 602
ad2d6943
ILT
603// A directory to search. For each directory we record whether it is
604// in the sysroot. We need to know this so that, if a linker script
605// is found within the sysroot, we will apply the sysroot to any files
606// named by that script.
607
608class Search_directory
609{
610 public:
611 // We need a default constructor because we put this in a
612 // std::vector.
613 Search_directory()
614 : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
615 { }
616
617 // This is the usual constructor.
3f3cddf1 618 Search_directory(const std::string& name, bool put_in_sysroot)
2ea97941 619 : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
15893b88
ILT
620 {
621 if (this->name_.empty())
622 this->name_ = ".";
623 }
ad2d6943
ILT
624
625 // This is called if we have a sysroot. The sysroot is prefixed to
626 // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
627 // set to true for any enries which are in the sysroot (this will
628 // naturally include any entries for which put_in_sysroot_ is true).
629 // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
630 // passing SYSROOT to lrealpath.
631 void
632 add_sysroot(const char* sysroot, const char* canonical_sysroot);
633
634 // Get the directory name.
635 const std::string&
636 name() const
637 { return this->name_; }
638
639 // Return whether this directory is in the sysroot.
640 bool
641 is_in_sysroot() const
642 { return this->is_in_sysroot_; }
643
fd9d194f
ILT
644 // Return whether this is considered a system directory.
645 bool
646 is_system_directory() const
647 { return this->put_in_sysroot_ || this->is_in_sysroot_; }
648
ad2d6943 649 private:
fd9d194f 650 // The directory name.
ad2d6943 651 std::string name_;
fd9d194f
ILT
652 // True if the sysroot should be added as a prefix for this
653 // directory (if there is a sysroot). This is true for system
654 // directories that we search by default.
ad2d6943 655 bool put_in_sysroot_;
fd9d194f
ILT
656 // True if this directory is in the sysroot (if there is a sysroot).
657 // This is true if there is a sysroot and either 1) put_in_sysroot_
658 // is true, or 2) the directory happens to be in the sysroot based
659 // on a pathname comparison.
ad2d6943
ILT
660 bool is_in_sysroot_;
661};
662
bae7f79e
ILT
663class General_options
664{
ee1fe73e
ILT
665 private:
666 // NOTE: For every option that you add here, also consider if you
667 // should add it to Position_dependent_options.
668 DEFINE_special(help, options::TWO_DASHES, '\0',
0c6e6c39 669 N_("Report usage information"), NULL);
ee1fe73e 670 DEFINE_special(version, options::TWO_DASHES, 'v',
0c6e6c39 671 N_("Report version information"), NULL);
b5be4a7c 672 DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
0c6e6c39 673 N_("Report version and target information"), NULL);
ee1fe73e 674
fee2edb1
ILT
675 // These options are sorted approximately so that for each letter in
676 // the alphabet, we show the option whose shortname is that letter
677 // (if any) and then every longname that starts with that letter (in
678 // alphabetical order). For both, lowercase sorts before uppercase.
679 // The -z options come last.
680
358a9718
CC
681 // a
682
7eaea549
ILT
683 DEFINE_bool(add_needed, options::TWO_DASHES, '\0', false,
684 N_("Not supported"),
685 N_("Do not copy DT_NEEDED tags from shared libraries"));
686
9c4ae156 687 DEFINE_bool_alias(allow_multiple_definition, muldefs, options::TWO_DASHES,
358a9718
CC
688 '\0',
689 N_("Allow multiple definitions of symbols"),
9c4ae156 690 N_("Do not allow multiple definitions"), false);
30bc8c46 691
ee1fe73e 692 DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false,
0c6e6c39
RM
693 N_("Allow unresolved references in shared libraries"),
694 N_("Do not allow unresolved references in shared libraries"));
ee1fe73e 695
0eccf19f 696 DEFINE_bool(apply_dynamic_relocs, options::TWO_DASHES, '\0', true,
358a9718 697 N_("Apply link-time values for dynamic relocations"),
0eccf19f 698 N_("(aarch64 only) Do not apply link-time values "
1130c90e 699 "for dynamic relocations"));
0eccf19f 700
ee1fe73e 701 DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false,
358a9718
CC
702 N_("Use DT_NEEDED only for shared libraries that are used"),
703 N_("Use DT_NEEDED for all shared libraries"));
ee1fe73e 704
fe35d28d 705 DEFINE_enum(assert, options::ONE_DASH, '\0', NULL,
afd2ea23 706 N_("Ignored"), N_("[ignored]"), false,
fe35d28d
ILT
707 {"definitions", "nodefinitions", "nosymbolic", "pure-text"});
708
358a9718
CC
709 // b
710
fee2edb1
ILT
711 // This should really be an "enum", but it's too easy for folks to
712 // forget to update the list as they add new targets. So we just
713 // accept any string. We'll fail later (when the string is parsed),
714 // if the target isn't actually supported.
715 DEFINE_string(format, options::TWO_DASHES, 'b', "elf",
0c6e6c39 716 N_("Set input format"), ("[elf,binary]"));
fee2edb1 717
36862fc0 718 DEFINE_bool(be8, options::TWO_DASHES, '\0', false,
358a9718
CC
719 N_("Output BE8 format image"), NULL);
720
721 DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "tree",
722 N_("Generate build ID note"),
723 N_("[=STYLE]"));
724
725 DEFINE_uint64(build_id_chunk_size_for_treehash,
726 options::TWO_DASHES, '\0', 2 << 20,
727 N_("Chunk size for '--build-id=tree'"), N_("SIZE"));
728
729 DEFINE_uint64(build_id_min_file_size_for_treehash, options::TWO_DASHES,
730 '\0', 40 << 20,
731 N_("Minimum output file size for '--build-id=tree' to work"
732 " differently than '--build-id=sha1'"), N_("SIZE"));
733
ee1fe73e 734 DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
0c6e6c39 735 N_("-l searches for shared libraries"), NULL);
2b706932
ILT
736 DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
737 N_("-l does not search for shared libraries"), NULL,
738 true);
b821d13c
ILT
739 DEFINE_bool_alias(dy, Bdynamic, options::ONE_DASH, '\0',
740 N_("alias for -Bdynamic"), NULL, false);
741 DEFINE_bool_alias(dn, Bdynamic, options::ONE_DASH, '\0',
742 N_("alias for -Bstatic"), NULL, true);
ee1fe73e 743
e2153196
ILT
744 DEFINE_bool(Bgroup, options::ONE_DASH, '\0', false,
745 N_("Use group name lookup rules for shared library"), NULL);
746
358a9718
CC
747 DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
748 N_("Generate shared library (alias for -G/-shared)"), NULL);
749
ee1fe73e 750 DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
0c6e6c39 751 N_("Bind defined symbols locally"), NULL);
ee1fe73e 752
f1f70eae
ILT
753 DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
754 N_("Bind defined function symbols locally"), NULL);
755
358a9718 756 // c
e7c5ea40 757
34810851 758 DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
358a9718 759 N_("Check segment addresses for overlaps"),
34810851
ILT
760 N_("Do not check segment addresses for overlaps"));
761
ee1fe73e 762 DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
0c6e6c39 763 N_("Compress .debug_* sections in the output file"),
afd2ea23 764 ("[none,zlib,zlib-gnu,zlib-gabi]"), false,
fb8b9dbc 765 {"none", "zlib", "zlib-gnu", "zlib-gabi"});
0dfbdef4 766
7eaea549
ILT
767 DEFINE_bool(copy_dt_needed_entries, options::TWO_DASHES, '\0', false,
768 N_("Not supported"),
769 N_("Do not copy DT_NEEDED tags from shared libraries"));
770
dde3f402
ILT
771 DEFINE_bool(cref, options::TWO_DASHES, '\0', false,
772 N_("Output cross reference table"),
773 N_("Do not output cross reference table"));
774
5393d741 775 DEFINE_bool(ctors_in_init_array, options::TWO_DASHES, '\0', true,
358a9718 776 N_("Use DT_INIT_ARRAY for all constructors"),
5393d741
ILT
777 N_("Handle constructors as directed by compiler"));
778
358a9718
CC
779 // d
780
ee1fe73e 781 DEFINE_bool(define_common, options::TWO_DASHES, 'd', false,
0c6e6c39 782 N_("Define common symbols"),
358a9718 783 N_("Do not define common symbols in relocatable output"));
ee1fe73e 784 DEFINE_bool(dc, options::ONE_DASH, '\0', false,
0c6e6c39 785 N_("Alias for -d"), NULL);
ee1fe73e 786 DEFINE_bool(dp, options::ONE_DASH, '\0', false,
0c6e6c39 787 N_("Alias for -d"), NULL);
d391083d 788
fee2edb1 789 DEFINE_string(debug, options::TWO_DASHES, '\0', "",
0c6e6c39
RM
790 N_("Turn on debugging"),
791 N_("[all,files,script,task][,...]"));
fee2edb1 792
ee1fe73e 793 DEFINE_special(defsym, options::TWO_DASHES, '\0',
0c6e6c39 794 N_("Define a symbol"), N_("SYMBOL=EXPRESSION"));
a6badf5a 795
086a1841
ILT
796 DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL,
797 N_("Demangle C++ symbols in log messages"),
798 N_("[=STYLE]"));
086a1841
ILT
799 DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false,
800 N_("Do not demangle C++ symbols in log messages"),
801 NULL);
fced7afd 802
f37b21b4
RM
803 DEFINE_string(dependency_file, options::TWO_DASHES, '\0', NULL,
804 N_("Write a dependency file listing all files read"),
805 N_("FILE"));
806
ee1fe73e 807 DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false,
0c6e6c39 808 N_("Look for violations of the C++ One Definition Rule"),
f30f86fa 809 N_("Do not look for violations of the C++ One Definition Rule"));
ee1fe73e 810
c82fbeee 811 DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
0c6e6c39 812 N_("Add data symbols to dynamic symbols"), NULL);
c82fbeee
CS
813
814 DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
0c6e6c39 815 N_("Add C++ operator new/delete to dynamic symbols"), NULL);
c82fbeee
CS
816
817 DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
0c6e6c39 818 N_("Add C++ typeinfo to dynamic symbols"), NULL);
c82fbeee
CS
819
820 DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
0c6e6c39 821 N_("Read a list of dynamic symbols"), N_("FILE"));
c82fbeee 822
358a9718
CC
823 // e
824
590b87ff
AM
825 DEFINE_bool(emit_stub_syms, options::TWO_DASHES, '\0', true,
826 N_("(PowerPC only) Label linker stubs with a symbol"),
827 N_("(PowerPC only) Do not label linker stubs with a symbol"));
828
ee1fe73e 829 DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
0c6e6c39 830 N_("Set program start address"), N_("ADDRESS"));
ee1fe73e 831
358a9718
CC
832 DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
833 N_("Create exception frame header"),
834 N_("Do not create exception frame header"));
835
836 // Alphabetized under 'e' because the option is spelled --enable-new-dtags.
837 DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', true,
838 N_("Enable use of DT_RUNPATH"),
839 N_("Disable use of DT_RUNPATH"));
840
841 DEFINE_bool(enum_size_warning, options::TWO_DASHES, '\0', true, NULL,
842 N_("(ARM only) Do not warn about objects with incompatible "
843 "enum sizes"));
844
65514900
CC
845 DEFINE_special(exclude_libs, options::TWO_DASHES, '\0',
846 N_("Exclude libraries from automatic export"),
847 N_(("lib,lib ...")));
848
ee1fe73e 849 DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
0c6e6c39 850 N_("Export all dynamic symbols"),
358a9718 851 N_("Do not export all dynamic symbols"));
dbe717ef 852
31821be0
CC
853 DEFINE_set(export_dynamic_symbol, options::TWO_DASHES, '\0',
854 N_("Export SYMBOL to dynamic symbol table"), N_("SYMBOL"));
855
7296d933
DK
856 DEFINE_special(EB, options::ONE_DASH, '\0',
857 N_("Link big-endian objects."), NULL);
7296d933
DK
858 DEFINE_special(EL, options::ONE_DASH, '\0',
859 N_("Link little-endian objects."), NULL);
860
358a9718 861 // f
ce0d1972 862
886288f1
ILT
863 DEFINE_set(auxiliary, options::TWO_DASHES, 'f',
864 N_("Auxiliary filter for shared object symbol table"),
865 N_("SHLIB"));
866
867 DEFINE_string(filter, options::TWO_DASHES, 'F', NULL,
868 N_("Filter for shared object symbol table"),
869 N_("SHLIB"));
870
d82a5bcc
ILT
871 DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
872 N_("Treat warnings as errors"),
873 N_("Do not treat warnings as errors"));
874
c6585162 875 DEFINE_string(fini, options::ONE_DASH, '\0', "_fini",
0c6e6c39 876 N_("Call SYMBOL at unload-time"), N_("SYMBOL"));
c6585162 877
358a9718
CC
878 DEFINE_bool(fix_arm1176, options::TWO_DASHES, '\0', true,
879 N_("(ARM only) Fix binaries for ARM1176 erratum"),
880 N_("(ARM only) Do not fix binaries for ARM1176 erratum"));
881
41263c05 882 DEFINE_bool(fix_cortex_a8, options::TWO_DASHES, '\0', false,
358a9718
CC
883 N_("(ARM only) Fix binaries for Cortex-A8 erratum"),
884 N_("(ARM only) Do not fix binaries for Cortex-A8 erratum"));
41263c05 885
7a2a1c79 886 DEFINE_bool(fix_cortex_a53_843419, options::TWO_DASHES, '\0', false,
358a9718
CC
887 N_("(AArch64 only) Fix Cortex-A53 erratum 843419"),
888 N_("(AArch64 only) Do not fix Cortex-A53 erratum 843419"));
2f0c79aa
HS
889
890 DEFINE_bool(fix_cortex_a53_835769, options::TWO_DASHES, '\0', false,
358a9718
CC
891 N_("(AArch64 only) Fix Cortex-A53 erratum 835769"),
892 N_("(AArch64 only) Do not fix Cortex-A53 erratum 835769"));
85fdf906 893
9b2fd367 894 DEFINE_special(fix_v4bx, options::TWO_DASHES, '\0',
0c6e6c39
RM
895 N_("(ARM only) Rewrite BX rn as MOV pc, rn for ARMv4"),
896 NULL);
9b2fd367
DK
897
898 DEFINE_special(fix_v4bx_interworking, options::TWO_DASHES, '\0',
0c6e6c39
RM
899 N_("(ARM only) Rewrite BX rn branch to ARMv4 interworking "
900 "veneer"),
901 NULL);
9b2fd367 902
358a9718
CC
903 DEFINE_string(fuse_ld, options::ONE_DASH, '\0', "",
904 N_("Ignored for GCC linker option compatibility"),
930b5f8b 905 N_("[gold,bfd]"));
358a9718
CC
906
907 // g
ce3e4980 908
fe35d28d
ILT
909 DEFINE_bool(g, options::EXACTLY_ONE_DASH, '\0', false,
910 N_("Ignored"), NULL);
911
358a9718
CC
912 DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
913 N_("Remove unused sections"),
914 N_("Don't remove unused sections"));
915
c1027032
CC
916 DEFINE_bool(gdb_index, options::TWO_DASHES, '\0', false,
917 N_("Generate .gdb_index section"),
918 N_("Do not generate .gdb_index section"));
919
9634ed06 920 DEFINE_bool(gnu_unique, options::TWO_DASHES, '\0', true,
358a9718 921 N_("Enable STB_GNU_UNIQUE symbol binding"),
9634ed06
CC
922 N_("Disable STB_GNU_UNIQUE symbol binding"));
923
358a9718
CC
924 DEFINE_bool(shared, options::ONE_DASH, 'G', false,
925 N_("Generate shared library"), NULL);
926
927 // h
928
ee1fe73e 929 DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
0c6e6c39 930 N_("Set shared library name"), N_("FILENAME"));
ee1fe73e 931
c18476e7
ILT
932 DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0,
933 N_("Min fraction of empty buckets in dynamic hash"),
934 N_("FRACTION"));
935
2760f24c 936 DEFINE_enum(hash_style, options::TWO_DASHES, '\0', DEFAULT_HASH_STYLE,
afd2ea23 937 N_("Dynamic hash style"), N_("[sysv,gnu,both]"), false,
13670ee6
ILT
938 {"sysv", "gnu", "both"});
939
358a9718
CC
940 // i
941
942 DEFINE_bool_alias(i, relocatable, options::EXACTLY_ONE_DASH, '\0',
943 N_("Alias for -r"), NULL, false);
944
945 DEFINE_enum(icf, options::TWO_DASHES, '\0', "none",
946 N_("Identical Code Folding. "
947 "\'--icf=safe\' Folds ctors, dtors and functions whose"
948 " pointers are definitely not taken"),
afd2ea23 949 ("[none,all,safe]"), false,
358a9718
CC
950 {"none", "all", "safe"});
951
952 DEFINE_uint(icf_iterations, options::TWO_DASHES , '\0', 0,
e173ea00 953 N_("Number of iterations of ICF (default 3)"), N_("COUNT"));
ee1fe73e 954
8c21d9d3
CC
955 DEFINE_special(incremental, options::TWO_DASHES, '\0',
956 N_("Do an incremental link if possible; "
957 "otherwise, do a full link and prepare output "
958 "for incremental linking"), NULL);
959
960 DEFINE_special(no_incremental, options::TWO_DASHES, '\0',
961 N_("Do a full link (default)"), NULL);
962
963 DEFINE_special(incremental_full, options::TWO_DASHES, '\0',
964 N_("Do a full link and "
965 "prepare output for incremental linking"), NULL);
966
967 DEFINE_special(incremental_update, options::TWO_DASHES, '\0',
968 N_("Do an incremental link; exit if not possible"), NULL);
266d0a74 969
aa92d6ed 970 DEFINE_string(incremental_base, options::TWO_DASHES, '\0', NULL,
0c6e6c39
RM
971 N_("Set base file for incremental linking"
972 " (default is output file)"),
973 N_("FILE"));
aa92d6ed 974
266d0a74 975 DEFINE_special(incremental_changed, options::TWO_DASHES, '\0',
0c6e6c39 976 N_("Assume files changed"), NULL);
266d0a74
ILT
977
978 DEFINE_special(incremental_unchanged, options::TWO_DASHES, '\0',
0c6e6c39 979 N_("Assume files didn't change"), NULL);
266d0a74
ILT
980
981 DEFINE_special(incremental_unknown, options::TWO_DASHES, '\0',
0c6e6c39 982 N_("Use timestamps to check files (default)"), NULL);
266d0a74 983
221597a5 984 DEFINE_special(incremental_startup_unchanged, options::TWO_DASHES, '\0',
0c6e6c39 985 N_("Assume startup files unchanged "
221597a5
CC
986 "(files preceding this option)"), NULL);
987
9fbd3822 988 DEFINE_percent(incremental_patch, options::TWO_DASHES, '\0', 10,
358a9718
CC
989 N_("Amount of extra space to allocate for patches "
990 "(default 10)"),
9fbd3822
CC
991 N_("PERCENT"));
992
c6585162 993 DEFINE_string(init, options::ONE_DASH, '\0', "_init",
0c6e6c39 994 N_("Call SYMBOL at load-time"), N_("SYMBOL"));
c6585162 995
358a9718
CC
996 DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL,
997 N_("Set dynamic linker path"), N_("PROGRAM"));
998
999 // j
1000
fee2edb1 1001 DEFINE_special(just_symbols, options::TWO_DASHES, '\0',
0c6e6c39 1002 N_("Read only symbol values from FILE"), N_("FILE"));
fee2edb1 1003
358a9718
CC
1004 // k
1005
a2a5469e 1006 DEFINE_bool(keep_files_mapped, options::TWO_DASHES, '\0', true,
358a9718 1007 N_("Keep files mapped across passes"),
0c6e6c39 1008 N_("Release mapped files after each pass"));
2c849493 1009
358a9718
CC
1010 DEFINE_set(keep_unique, options::TWO_DASHES, '\0',
1011 N_("Do not fold this symbol during ICF"), N_("SYMBOL"));
1012
1013 // l
07a60597 1014
ee1fe73e 1015 DEFINE_special(library, options::TWO_DASHES, 'l',
0c6e6c39 1016 N_("Search for library LIBNAME"), N_("LIBNAME"));
bae7f79e 1017
358a9718
CC
1018 DEFINE_bool(ld_generated_unwind_info, options::TWO_DASHES, '\0', true,
1019 N_("Generate unwind information for PLT"),
1020 N_("Do not generate unwind information for PLT"));
1021
ee1fe73e 1022 DEFINE_dirlist(library_path, options::TWO_DASHES, 'L',
0c6e6c39 1023 N_("Add directory to search path"), N_("DIR"));
ee1fe73e 1024
358a9718
CC
1025 DEFINE_bool(long_plt, options::TWO_DASHES, '\0', false,
1026 N_("(ARM only) Generate long PLT entries"),
1027 N_("(ARM only) Do not generate long PLT entries"));
0f72bf6f 1028
358a9718 1029 // m
bbc5ae17 1030
ee1fe73e 1031 DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
96f9814d 1032 N_("Set GNU linker emulation; obsolete"), N_("EMULATION"));
ee1fe73e 1033
358a9718
CC
1034 DEFINE_bool(map_whole_files, options::TWO_DASHES, '\0',
1035 sizeof(void*) >= 8,
1036 N_("Map whole files to memory"),
1037 N_("Map relevant file parts to memory"));
1038
1039 DEFINE_bool(merge_exidx_entries, options::TWO_DASHES, '\0', true,
1040 N_("(ARM only) Merge exidx entries in debuginfo"),
1041 N_("(ARM only) Do not merge exidx entries in debuginfo"));
1042
7c0640fa 1043 DEFINE_bool(mmap_output_file, options::TWO_DASHES, '\0', true,
358a9718
CC
1044 N_("Map the output file for writing"),
1045 N_("Do not map the output file for writing"));
7c0640fa 1046
7d9e3d98
ILT
1047 DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
1048 N_("Write map file on standard output"), NULL);
358a9718 1049
7d9e3d98
ILT
1050 DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
1051 N_("MAPFILENAME"));
1052
358a9718
CC
1053 // n
1054
af6156ef
ILT
1055 DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
1056 N_("Do not page align data"), NULL);
1057 DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
1058 N_("Do not page align data, do not make text readonly"),
1059 N_("Page align data, make text readonly"));
1060
358a9718
CC
1061 DEFINE_bool(no_keep_memory, options::TWO_DASHES, '\0', false,
1062 N_("Use less memory and more disk I/O "
1063 "(included only for compatibility with GNU ld)"), NULL);
cdb0b8f5 1064
f3e9c5c5
ILT
1065 DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
1066 N_("Report undefined symbols (even with --shared)"),
1067 NULL, false);
1068
358a9718
CC
1069 DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
1070 N_("Create an output file even if errors occur"), NULL);
1071
1072 DEFINE_bool(nostdlib, options::ONE_DASH, '\0', false,
1073 N_("Only search directories specified on the command line"),
1074 NULL);
1075
1076 // o
1077
ee1fe73e 1078 DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
0c6e6c39 1079 N_("Set output file name"), N_("FILE"));
ee1fe73e 1080
358a9718
CC
1081 DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
1082 N_("Set output format"), N_("[binary]"));
1083
ee1fe73e 1084 DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0,
0c6e6c39 1085 N_("Optimize output file size"), N_("LEVEL"));
ee1fe73e 1086
591be3e4
CC
1087 DEFINE_enum(orphan_handling, options::TWO_DASHES, '\0', "place",
1088 N_("Orphan section handling"), N_("[place,discard,warn,error]"),
afd2ea23 1089 false, {"place", "discard", "warn", "error"});
591be3e4 1090
358a9718 1091 // p
ee1fe73e 1092
358a9718
CC
1093 DEFINE_bool(p, options::ONE_DASH, 'p', false,
1094 N_("Ignored for ARM compatibility"), NULL);
7296d933 1095
374ad285 1096 DEFINE_bool(pie, options::ONE_DASH, '\0', false,
81233653
ST
1097 N_("Create a position independent executable"),
1098 N_("Do not create a position independent executable"));
374ad285 1099 DEFINE_bool_alias(pic_executable, pie, options::TWO_DASHES, '\0',
5f772412
ST
1100 N_("Create a position independent executable"),
1101 N_("Do not create a position independent executable"),
374ad285
ILT
1102 false);
1103
cdb06167
HS
1104 DEFINE_bool(pic_veneer, options::TWO_DASHES, '\0', false,
1105 N_("Force PIC sequences for ARM/Thumb interworking veneers"),
1106 NULL);
1107
7296d933
DK
1108 DEFINE_bool(pipeline_knowledge, options::ONE_DASH, '\0', false,
1109 NULL, N_("(ARM only) Ignore for backward compatibility"));
1110
9e69ed50 1111 DEFINE_var(plt_align, options::TWO_DASHES, '\0', 0, "5",
9e390558 1112 N_("(PowerPC only) Align PLT call stubs to fit cache lines"),
358a9718 1113 N_("[=P2ALIGN]"), true, int, int, options::parse_uint, false);
9e69ed50 1114
7ee7ff70
AM
1115 DEFINE_bool(plt_localentry, options::TWO_DASHES, '\0', false,
1116 N_("(PowerPC64 only) Optimize calls to ELFv2 localentry:0 functions"),
1117 N_("(PowerPC64 only) Don't optimize ELFv2 calls"));
1118
9e69ed50
AM
1119 DEFINE_bool(plt_static_chain, options::TWO_DASHES, '\0', false,
1120 N_("(PowerPC64 only) PLT call stubs should load r11"),
1121 N_("(PowerPC64 only) PLT call stubs should not load r11"));
1122
1123 DEFINE_bool(plt_thread_safe, options::TWO_DASHES, '\0', false,
1124 N_("(PowerPC64 only) PLT call stubs with load-load barrier"),
1125 N_("(PowerPC64 only) PLT call stubs without barrier"));
1126
89fc3421
CC
1127#ifdef ENABLE_PLUGINS
1128 DEFINE_special(plugin, options::TWO_DASHES, '\0',
0c6e6c39 1129 N_("Load a plugin library"), N_("PLUGIN"));
4674ecfc 1130 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
0c6e6c39 1131 N_("Pass an option to the plugin"), N_("OPTION"));
24538276
CC
1132#else
1133 DEFINE_special(plugin, options::TWO_DASHES, '\0',
1134 N_("Load a plugin library (not supported)"), N_("PLUGIN"));
1135 DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
1136 N_("Pass an option to the plugin (not supported)"),
1137 N_("OPTION"));
89fc3421
CC
1138#endif
1139
7c0640fa 1140 DEFINE_bool(posix_fallocate, options::TWO_DASHES, '\0', true,
358a9718
CC
1141 N_("Use posix_fallocate to reserve space in the output file"),
1142 N_("Use fallocate or ftruncate to reserve space"));
7c0640fa 1143
afd2ea23
AM
1144 DEFINE_enum(power10_stubs, options::TWO_DASHES, '\0', "yes",
1145 N_("(PowerPC64 only) stubs use power10 insns"),
1146 N_("[=auto,no,yes]"), true, {"auto", "no", "yes"});
1147 DEFINE_special(no_power10_stubs, options::TWO_DASHES, '\0',
1148 N_("(PowerPC64 only) stubs do not use power10 insns"), NULL);
1149
ac45a351 1150 DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
0c6e6c39 1151 N_("Preread archive symbols when multi-threaded"), NULL);
89fc3421 1152
358a9718
CC
1153 DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
1154 N_("List removed unused sections on stderr"),
1155 N_("Do not list removed unused sections"));
1156
1157 DEFINE_bool(print_icf_sections, options::TWO_DASHES, '\0', false,
1158 N_("List folded identical sections on stderr"),
1159 N_("Do not list folded identical sections"));
1160
f1ddb600
ILT
1161 DEFINE_bool(print_output_format, options::TWO_DASHES, '\0', false,
1162 N_("Print default output format"), NULL);
1163
92de84a6
ILT
1164 DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
1165 N_("Print symbols defined and used for each input"),
1166 N_("FILENAME"));
1167
376c3ecd
CC
1168 DEFINE_special(push_state, options::TWO_DASHES, '\0',
1169 N_("Save the state of flags related to input files"), NULL);
1170 DEFINE_special(pop_state, options::TWO_DASHES, '\0',
1171 N_("Restore the state of flags related to input files"), NULL);
1172
358a9718 1173 // q
b5be4a7c 1174
ee1fe73e 1175 DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
0c6e6c39 1176 N_("Generate relocations in output"), NULL);
ee1fe73e 1177
358a9718
CC
1178 DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
1179 N_("Ignored for SVR4 compatibility"), NULL);
1180
1181 // r
1182
ee1fe73e 1183 DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
0c6e6c39 1184 N_("Generate relocatable output"), NULL);
ee1fe73e 1185
706e1f5e 1186 DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
223b97ba
JC
1187 N_("Relax branches on certain targets"),
1188 N_("Do not relax branches"));
706e1f5e 1189
719328e1 1190 DEFINE_string(retain_symbols_file, options::TWO_DASHES, '\0', NULL,
0c6e6c39 1191 N_("keep only symbols listed in this file"), N_("FILE"));
8c604651 1192
358a9718
CC
1193 DEFINE_bool(rosegment, options::TWO_DASHES, '\0', false,
1194 N_("Put read-only non-executable sections in their own segment"),
9a6c68ca 1195 N_("Do not put read-only non-executable sections in their own segment"));
358a9718
CC
1196
1197 DEFINE_uint64(rosegment_gap, options::TWO_DASHES, '\0', -1U,
1198 N_("Set offset between executable and read-only segments"),
1199 N_("OFFSET"));
1200
ee1fe73e
ILT
1201 // -R really means -rpath, but can mean --just-symbols for
1202 // compatibility with GNU ld. -rpath is always -rpath, so we list
1203 // it separately.
1204 DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R',
0c6e6c39 1205 N_("Add DIR to runtime search path"), N_("DIR"));
ee1fe73e
ILT
1206
1207 DEFINE_dirlist(rpath, options::ONE_DASH, '\0',
0c6e6c39 1208 N_("Add DIR to runtime search path"), N_("DIR"));
ee1fe73e 1209
ee1fe73e 1210 DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0',
0c6e6c39
RM
1211 N_("Add DIR to link time shared library search path"),
1212 N_("DIR"));
ee1fe73e 1213
358a9718
CC
1214 // s
1215
1216 DEFINE_bool(strip_all, options::TWO_DASHES, 's', false,
1217 N_("Strip all symbols"), NULL);
1218 DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
1219 N_("Strip debugging information"), NULL);
1220 DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
1221 N_("Emit only debug line number information"), NULL);
1222 DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
1223 N_("Strip debug symbols that are unused by gdb "
1224 "(at least versions <= 7.4)"), NULL);
1225 DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
1226 N_("Strip LTO intermediate code sections"), NULL);
1227
6e9ba2ca 1228 DEFINE_string(section_ordering_file, options::TWO_DASHES, '\0', NULL,
358a9718 1229 N_("Layout sections in the order specified"),
6e9ba2ca
ST
1230 N_("FILENAME"));
1231
a192ba05
ILT
1232 DEFINE_special(section_start, options::TWO_DASHES, '\0',
1233 N_("Set address of section"), N_("SECTION=ADDRESS"));
1234
f159cdb6
AM
1235 DEFINE_bool(secure_plt, options::TWO_DASHES , '\0', true,
1236 N_("(PowerPC only) Use new-style PLT"), NULL);
1237
fc59c572
ILT
1238 DEFINE_optional_string(sort_common, options::TWO_DASHES, '\0', NULL,
1239 N_("Sort common symbols by alignment"),
1240 N_("[={ascending,descending}]"));
1241
6934001a
CC
1242 DEFINE_enum(sort_section, options::TWO_DASHES, '\0', "none",
1243 N_("Sort sections by name. \'--no-text-reorder\'"
1244 " will override \'--sort-section=name\' for .text"),
afd2ea23 1245 N_("[none,name]"), false,
6934001a
CC
1246 {"none", "name"});
1247
9e9e071b
ILT
1248 DEFINE_uint(spare_dynamic_tags, options::TWO_DASHES, '\0', 5,
1249 N_("Dynamic tag slots to reserve (default 5)"),
1250 N_("COUNT"));
1251
c0a62865 1252 DEFINE_int(stub_group_size, options::TWO_DASHES , '\0', 1,
0c6e6c39 1253 N_("(ARM, PowerPC only) The maximum distance from instructions "
358a9718 1254 "in a group of sections to their stubs. Negative values mean "
a5018ae5 1255 "stubs are always after the group. 1 means use default size"),
c0a62865
DK
1256 N_("SIZE"));
1257
ab502e63 1258 DEFINE_bool(stub_group_multi, options::TWO_DASHES, '\0', true,
69a2af10 1259 N_("(PowerPC only) Allow a group of stubs to serve multiple "
ab502e63
AM
1260 "output sections"),
1261 N_("(PowerPC only) Each output section has its own stubs"));
1c3a5fbe 1262
f9ff65d4 1263 DEFINE_uint(split_stack_adjust_size, options::TWO_DASHES, '\0', 0x100000,
364c7fa5
ILT
1264 N_("Stack size when -fsplit-stack function calls non-split"),
1265 N_("SIZE"));
1266
ee1fe73e
ILT
1267 // This is not actually special in any way, but I need to give it
1268 // a non-standard accessor-function name because 'static' is a keyword.
1269 DEFINE_special(static, options::ONE_DASH, '\0',
0c6e6c39 1270 N_("Do not link against shared libraries"), NULL);
ee1fe73e 1271
358a9718
CC
1272 DEFINE_special(start_lib, options::TWO_DASHES, '\0',
1273 N_("Start a library"), NULL);
1274 DEFINE_special(end_lib, options::TWO_DASHES, '\0',
1275 N_("End a library "), NULL);
6d03d481 1276
ee1fe73e 1277 DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
0c6e6c39 1278 N_("Print resource usage statistics"), NULL);
ee1fe73e
ILT
1279
1280 DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
0c6e6c39 1281 N_("Set target system root directory"), N_("DIR"));
ee1fe73e 1282
358a9718
CC
1283 // t
1284
1285 DEFINE_bool(trace, options::TWO_DASHES, 't', false,
1286 N_("Print the name of each input file"), NULL);
1287
bc99685c
DK
1288 DEFINE_bool(target1_abs, options::TWO_DASHES, '\0', false,
1289 N_("(ARM only) Force R_ARM_TARGET1 type to R_ARM_ABS32"),
1290 NULL);
358a9718
CC
1291 DEFINE_bool(target1_rel, options::TWO_DASHES, '\0', false,
1292 N_("(ARM only) Force R_ARM_TARGET1 type to R_ARM_REL32"),
1293 NULL);
bc99685c
DK
1294 DEFINE_enum(target2, options::TWO_DASHES, '\0', NULL,
1295 N_("(ARM only) Set R_ARM_TARGET2 relocation type"),
afd2ea23 1296 N_("[rel, abs, got-rel"), false,
bc99685c
DK
1297 {"rel", "abs", "got-rel"});
1298
358a9718
CC
1299 DEFINE_bool(text_reorder, options::TWO_DASHES, '\0', true,
1300 N_("Enable text section reordering for GCC section names"),
1301 N_("Disable text section reordering for GCC section names"));
ee1fe73e
ILT
1302
1303 DEFINE_bool(threads, options::TWO_DASHES, '\0', false,
0c6e6c39
RM
1304 N_("Run the linker multi-threaded"),
1305 N_("Do not run the linker multi-threaded"));
ee1fe73e 1306 DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0,
0c6e6c39 1307 N_("Number of threads to use"), N_("COUNT"));
ee1fe73e 1308 DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0,
0c6e6c39 1309 N_("Number of threads to use in initial pass"), N_("COUNT"));
ee1fe73e 1310 DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0,
0c6e6c39 1311 N_("Number of threads to use in middle pass"), N_("COUNT"));
ee1fe73e 1312 DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0,
0c6e6c39 1313 N_("Number of threads to use in final pass"), N_("COUNT"));
ee1fe73e 1314
aacb3b6d
AM
1315 DEFINE_bool(tls_optimize, options::TWO_DASHES, '\0', true,
1316 N_("(PowerPC/64 only) Optimize GD/LD/IE code to IE/LE"),
1317 N_("(PowerPC/64 only) Don'\''t try to optimize TLS accesses"));
34e0882b
AM
1318 DEFINE_bool(tls_get_addr_optimize, options::TWO_DASHES, '\0', true,
1319 N_("(PowerPC/64 only) Use a special __tls_get_addr call"),
1320 N_("(PowerPC/64 only) Don't use a special __tls_get_addr call"));
aacb3b6d 1321
358a9718
CC
1322 DEFINE_bool(toc_optimize, options::TWO_DASHES, '\0', true,
1323 N_("(PowerPC64 only) Optimize TOC code sequences"),
1324 N_("(PowerPC64 only) Don't optimize TOC code sequences"));
1325
1326 DEFINE_bool(toc_sort, options::TWO_DASHES, '\0', true,
1327 N_("(PowerPC64 only) Sort TOC and GOT sections"),
1328 N_("(PowerPC64 only) Don't sort TOC and GOT sections"));
1329
1330 DEFINE_special(script, options::TWO_DASHES, 'T',
1331 N_("Read linker script"), N_("FILE"));
1332
fee2edb1 1333 DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U,
0c6e6c39 1334 N_("Set the address of the bss segment"), N_("ADDRESS"));
fee2edb1 1335 DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U,
0c6e6c39 1336 N_("Set the address of the data segment"), N_("ADDRESS"));
fee2edb1 1337 DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
0c6e6c39 1338 N_("Set the address of the text segment"), N_("ADDRESS"));
214383dd
ILT
1339 DEFINE_uint64_alias(Ttext_segment, Ttext, options::ONE_DASH, '\0',
1340 N_("Set the address of the text segment"),
1341 N_("ADDRESS"));
a3ed37d8
RM
1342 DEFINE_uint64(Trodata_segment, options::ONE_DASH, '\0', -1U,
1343 N_("Set the address of the rodata segment"), N_("ADDRESS"));
fee2edb1 1344
358a9718 1345 // u
aba6bc71 1346
f3e9c5c5
ILT
1347 DEFINE_set(undefined, options::TWO_DASHES, 'u',
1348 N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
2b706932 1349
beabb2c6
ILT
1350 DEFINE_enum(unresolved_symbols, options::TWO_DASHES, '\0', NULL,
1351 N_("How to handle unresolved symbols"),
1352 ("ignore-all,report-all,ignore-in-object-files,"
afd2ea23 1353 "ignore-in-shared-libs"), false,
beabb2c6
ILT
1354 {"ignore-all", "report-all", "ignore-in-object-files",
1355 "ignore-in-shared-libs"});
1356
358a9718
CC
1357 // v
1358
2285a610 1359 DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
358a9718 1360 N_("Alias for --debug=files"), NULL);
2285a610 1361
fee2edb1 1362 DEFINE_special(version_script, options::TWO_DASHES, '\0',
0c6e6c39 1363 N_("Read version script"), N_("FILE"));
fee2edb1 1364
358a9718
CC
1365 // w
1366
1ae4d23b
ILT
1367 DEFINE_bool(warn_common, options::TWO_DASHES, '\0', false,
1368 N_("Warn about duplicate common symbols"),
358a9718 1369 N_("Do not warn about duplicate common symbols"));
1ae4d23b 1370
358a9718
CC
1371 DEFINE_bool_ignore(warn_constructors, options::TWO_DASHES, '\0',
1372 N_("Ignored"), N_("Ignored"));
37a9ac43 1373
3a12c78d
CC
1374 DEFINE_bool(warn_drop_version, options::TWO_DASHES, '\0', false,
1375 N_("Warn when discarding version information"),
1376 N_("Do not warn when discarding version information"));
1377
83e17bd5
CC
1378 DEFINE_bool(warn_execstack, options::TWO_DASHES, '\0', false,
1379 N_("Warn if the stack is executable"),
358a9718 1380 N_("Do not warn if the stack is executable"));
83e17bd5 1381
7296d933
DK
1382 DEFINE_bool(warn_mismatch, options::TWO_DASHES, '\0', true,
1383 NULL, N_("Don't warn about mismatched input files"));
1384
6eda8c29
ILT
1385 DEFINE_bool(warn_multiple_gp, options::TWO_DASHES, '\0', false,
1386 N_("Ignored"), NULL);
1387
15f8229b
ILT
1388 DEFINE_bool(warn_search_mismatch, options::TWO_DASHES, '\0', true,
1389 N_("Warn when skipping an incompatible library"),
1390 N_("Don't warn when skipping an incompatible library"));
1391
b9674e17
ILT
1392 DEFINE_bool(warn_shared_textrel, options::TWO_DASHES, '\0', false,
1393 N_("Warn if text segment is not shareable"),
358a9718 1394 N_("Do not warn if text segment is not shareable"));
b9674e17 1395
dc3f80fe
ILT
1396 DEFINE_bool(warn_unresolved_symbols, options::TWO_DASHES, '\0', false,
1397 N_("Report unresolved symbols as warnings"),
1398 NULL);
1399 DEFINE_bool_alias(error_unresolved_symbols, warn_unresolved_symbols,
1400 options::TWO_DASHES, '\0',
1401 N_("Report unresolved symbols as errors"),
1402 NULL, true);
1403
ce0d1972
DK
1404 DEFINE_bool(wchar_size_warning, options::TWO_DASHES, '\0', true, NULL,
1405 N_("(ARM only) Do not warn about objects with incompatible "
1406 "wchar_t sizes"));
1407
358a9718
CC
1408 DEFINE_bool(weak_unresolved_symbols, options::TWO_DASHES, '\0', false,
1409 N_("Convert unresolved symbols to weak references"),
1410 NULL);
1411
ee1fe73e 1412 DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false,
0c6e6c39
RM
1413 N_("Include all archive contents"),
1414 N_("Include only needed archive contents"));
ee1fe73e 1415
c5818ff1
CC
1416 DEFINE_set(wrap, options::TWO_DASHES, '\0',
1417 N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
1418
358a9718
CC
1419 // x
1420
1421 DEFINE_special(discard_all, options::TWO_DASHES, 'x',
1422 N_("Delete all local symbols"), NULL);
1423 DEFINE_special(discard_locals, options::TWO_DASHES, 'X',
1424 N_("Delete all temporary local symbols"), NULL);
1425 DEFINE_special(discard_none, options::TWO_DASHES, '\0',
1426 N_("Keep all local symbols"), NULL);
1427
1428 // y
1429
c5818ff1 1430 DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
0c6e6c39 1431 N_("Trace references to symbol"), N_("SYMBOL"));
0864d551 1432
62dfdd4d 1433 DEFINE_bool(undefined_version, options::TWO_DASHES, '\0', true,
358a9718 1434 N_("Allow unused version in script"),
62dfdd4d
ILT
1435 N_("Do not allow unused version in script"));
1436
706e1f5e
ILT
1437 DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
1438 N_("Default search path for Solaris compatibility"),
1439 N_("PATH"));
1440
358a9718
CC
1441 // special characters
1442
ee1fe73e 1443 DEFINE_special(start_group, options::TWO_DASHES, '(',
0c6e6c39 1444 N_("Start a library search group"), NULL);
ee1fe73e 1445 DEFINE_special(end_group, options::TWO_DASHES, ')',
0c6e6c39 1446 N_("End a library search group"), NULL);
ee1fe73e 1447
fee2edb1 1448 // The -z options.
ee1fe73e 1449
7a0c0a14
CC
1450 DEFINE_bool(bndplt, options::DASH_Z, '\0', false,
1451 N_("(x86-64 only) Generate a BND PLT for Intel MPX"),
1452 N_("Generate a regular PLT"));
d98bc257
ILT
1453 DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
1454 N_("Sort dynamic relocs"),
1455 N_("Do not sort dynamic relocs"));
fee2edb1 1456 DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
0c6e6c39 1457 N_("Set common page size to SIZE"), N_("SIZE"));
eb42429a 1458 DEFINE_bool(defs, options::DASH_Z, '\0', false,
0c6e6c39
RM
1459 N_("Report undefined symbols (even with --shared)"),
1460 NULL);
ee1fe73e 1461 DEFINE_bool(execstack, options::DASH_Z, '\0', false,
0c6e6c39 1462 N_("Mark output as requiring executable stack"), NULL);
fb257835
DI
1463 DEFINE_bool(global, options::DASH_Z, '\0', false,
1464 N_("Make symbols in DSO available for subsequently loaded "
1130c90e 1465 "objects"), NULL);
7c414435
DM
1466 DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
1467 N_("Mark DSO to be initialized first at runtime"),
1468 NULL);
1469 DEFINE_bool(interpose, options::DASH_Z, '\0', false,
1470 N_("Mark object to interpose all DSOs but executable"),
1471 NULL);
8a87b279
VDM
1472 DEFINE_bool(unique, options::DASH_Z, '\0', false,
1473 N_("Mark DSO to be loaded at most once, and only in the main namespace"),
1474 N_("Do not mark the DSO as one to be loaded only in the main namespace"));
6a9da32a 1475 DEFINE_bool_alias(lazy, now, options::DASH_Z, '\0',
358a9718 1476 N_("Mark object for lazy runtime binding"),
6a9da32a 1477 NULL, true);
7c414435
DM
1478 DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
1479 N_("Mark object requiring immediate process"),
1480 NULL);
e1c74d60 1481 DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0,
0c6e6c39 1482 N_("Set maximum page size to SIZE"), N_("SIZE"));
30bc8c46
ILT
1483 DEFINE_bool(muldefs, options::DASH_Z, '\0', false,
1484 N_("Allow multiple definitions of symbols"),
1485 NULL);
1486 // copyreloc is here in the list because there is only -z
1487 // nocopyreloc, not -z copyreloc.
966d4097
DK
1488 DEFINE_bool(copyreloc, options::DASH_Z, '\0', true,
1489 NULL,
1490 N_("Do not create copy relocs"));
7c414435
DM
1491 DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
1492 N_("Mark object not to use default search paths"),
1493 NULL);
1494 DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
1495 N_("Mark DSO non-deletable at runtime"),
1496 NULL);
1497 DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
1498 N_("Mark DSO not available to dlopen"),
1499 NULL);
1500 DEFINE_bool(nodump, options::DASH_Z, '\0', false,
1501 N_("Mark DSO not available to dldump"),
1502 NULL);
e1c74d60 1503 DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
0c6e6c39 1504 N_("Mark output as not requiring executable stack"), NULL);
e1c74d60
ILT
1505 DEFINE_bool(now, options::DASH_Z, '\0', false,
1506 N_("Mark object for immediate function binding"),
1507 NULL);
7be8330a
CD
1508 DEFINE_bool(origin, options::DASH_Z, '\0', false,
1509 N_("Mark DSO to indicate that needs immediate $ORIGIN "
0c6e6c39 1510 "processing at runtime"), NULL);
6b1edb94 1511 DEFINE_bool(relro, options::DASH_Z, '\0', DEFAULT_LD_Z_RELRO,
e1c74d60
ILT
1512 N_("Where possible mark variables read-only after relocation"),
1513 N_("Don't mark variables read-only after relocation"));
1130c90e
RM
1514 DEFINE_uint64(stack_size, options::DASH_Z, '\0', 0,
1515 N_("Set PT_GNU_STACK segment p_memsz to SIZE"), N_("SIZE"));
cae64165 1516 DEFINE_enum(start_stop_visibility, options::DASH_Z, '\0', "protected",
f37b21b4
RM
1517 N_("ELF symbol visibility for synthesized "
1518 "__start_* and __stop_* symbols"),
afd2ea23 1519 ("[default,internal,hidden,protected]"), false,
f37b21b4 1520 {"default", "internal", "hidden", "protected"});
ffeef7df
ILT
1521 DEFINE_bool(text, options::DASH_Z, '\0', false,
1522 N_("Do not permit relocations in read-only segments"),
358a9718 1523 N_("Permit relocations in read-only segments"));
ffeef7df 1524 DEFINE_bool_alias(textoff, text, options::DASH_Z, '\0',
358a9718 1525 N_("Permit relocations in read-only segments"),
ffeef7df 1526 NULL, true);
3b4190cc
ST
1527 DEFINE_bool(text_unlikely_segment, options::DASH_Z, '\0', false,
1528 N_("Move .text.unlikely sections to a separate segment."),
1529 N_("Do not move .text.unlikely sections to a separate "
1530 "segment."));
779bdadb
ST
1531 DEFINE_bool(keep_text_section_prefix, options::DASH_Z, '\0', false,
1532 N_("Keep .text.hot, .text.startup, .text.exit and .text.unlikely "
1533 "as separate sections in the final binary."),
1534 N_("Merge all .text.* prefix sections."));
3b4190cc 1535
bae7f79e 1536
ee1fe73e
ILT
1537 public:
1538 typedef options::Dir_list Dir_list;
ca3a67a5 1539
ee1fe73e 1540 General_options();
61ba1cf9 1541
ee1fe73e
ILT
1542 // Does post-processing on flags, making sure they all have
1543 // non-conflicting values. Also converts some flags from their
1544 // "standard" types (string, etc), to another type (enum, DirList),
1545 // which can be accessed via a separate method. Dies if it notices
1546 // any problems.
1547 void finalize();
516cb3d0 1548
459c9f1c
ILT
1549 // True if we printed the version information.
1550 bool
1551 printed_version() const
1552 { return this->printed_version_; }
1553
ee1fe73e
ILT
1554 // The macro defines output() (based on --output), but that's a
1555 // generic name. Provide this alternative name, which is clearer.
8851ecca 1556 const char*
ee1fe73e
ILT
1557 output_file_name() const
1558 { return this->output(); }
92e059d8 1559
8851ecca
ILT
1560 // This is not defined via a flag, but combines flags to say whether
1561 // the output is position-independent or not.
1562 bool
1563 output_is_position_independent() const
374ad285 1564 { return this->shared() || this->pie(); }
8851ecca 1565
183fd0e3
AO
1566 // Return true if the output is something that can be exec()ed, such
1567 // as a static executable, or a position-dependent or
1568 // position-independent executable, but not a dynamic library or an
1569 // object file.
1570 bool
1571 output_is_executable() const
374ad285 1572 { return !this->shared() && !this->relocatable(); }
183fd0e3 1573
ee1fe73e
ILT
1574 // This would normally be static(), and defined automatically, but
1575 // since static is a keyword, we need to come up with our own name.
bae7f79e
ILT
1576 bool
1577 is_static() const
ee1fe73e 1578 { return static_; }
756ac4a8 1579
ee1fe73e
ILT
1580 // In addition to getting the input and output formats as a string
1581 // (via format() and oformat()), we also give access as an enum.
1582 enum Object_format
1583 {
1584 // Ordinary ELF.
1585 OBJECT_FORMAT_ELF,
1586 // Straight binary format.
1587 OBJECT_FORMAT_BINARY
1588 };
fe9a4c12 1589
e6a307ba
ILT
1590 // Convert a string to an Object_format. Gives an error if the
1591 // string is not recognized.
1592 static Object_format
1593 string_to_object_format(const char* arg);
1594
376c3ecd
CC
1595 // Convert an Object_format to string.
1596 static const char*
1597 object_format_to_string(Object_format);
1598
ee1fe73e
ILT
1599 // Note: these functions are not very fast.
1600 Object_format format_enum() const;
1601 Object_format oformat_enum() const;
fe9a4c12 1602
fd9d194f
ILT
1603 // Return whether FILENAME is in a system directory.
1604 bool
1605 is_in_system_directory(const std::string& name) const;
1606
8c604651
CS
1607 // RETURN whether SYMBOL_NAME should be kept, according to symbols_to_retain_.
1608 bool
1609 should_retain_symbol(const char* symbol_name) const
1610 {
1611 if (symbols_to_retain_.empty()) // means flag wasn't specified
0c6e6c39 1612 return true;
8c604651
CS
1613 return symbols_to_retain_.find(symbol_name) != symbols_to_retain_.end();
1614 }
1615
ee1fe73e
ILT
1616 // These are the best way to get access to the execstack state,
1617 // not execstack() and noexecstack() which are hard to use properly.
35cdfc9a
ILT
1618 bool
1619 is_execstack_set() const
ee1fe73e 1620 { return this->execstack_status_ != EXECSTACK_FROM_INPUT; }
35cdfc9a
ILT
1621
1622 bool
1623 is_stack_executable() const
ee1fe73e 1624 { return this->execstack_status_ == EXECSTACK_YES; }
c7912668 1625
032ce4e9
ST
1626 bool
1627 icf_enabled() const
1628 { return this->icf_status_ != ICF_NONE; }
1629
1630 bool
1631 icf_safe_folding() const
1632 { return this->icf_status_ == ICF_SAFE; }
1633
086a1841
ILT
1634 // The --demangle option takes an optional string, and there is also
1635 // a --no-demangle option. This is the best way to decide whether
1636 // to demangle or not.
1637 bool
1638 do_demangle() const
1639 { return this->do_demangle_; }
1640
89fc3421
CC
1641 // Returns TRUE if any plugin libraries have been loaded.
1642 bool
1643 has_plugins() const
1644 { return this->plugins_ != NULL; }
1645
1646 // Return a pointer to the plugin manager.
1647 Plugin_manager*
1648 plugins() const
1649 { return this->plugins_; }
1650
c82fbeee
CS
1651 // True iff SYMBOL was found in the file specified by dynamic-list.
1652 bool
1653 in_dynamic_list(const char* symbol) const
1654 { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
1655
fd834e57
CC
1656 // True if a --dynamic-list script was provided.
1657 bool
1658 have_dynamic_list() const
1659 { return this->have_dynamic_list_; }
1660
6affe781
ILT
1661 // Finalize the dynamic list.
1662 void
1663 finalize_dynamic_list()
1664 { this->dynamic_list_.version_script_info()->finalize(); }
1665
8c21d9d3
CC
1666 // The mode selected by the --incremental options.
1667 enum Incremental_mode
1668 {
1669 // No incremental linking (--no-incremental).
1670 INCREMENTAL_OFF,
1671 // Incremental update only (--incremental-update).
1672 INCREMENTAL_UPDATE,
1673 // Force a full link, but prepare for subsequent incremental link
1674 // (--incremental-full).
1675 INCREMENTAL_FULL,
1676 // Incremental update if possible, fallback to full link (--incremental).
1677 INCREMENTAL_AUTO
1678 };
1679
1680 // The incremental linking mode.
1681 Incremental_mode
1682 incremental_mode() const
1683 { return this->incremental_mode_; }
1684
266d0a74
ILT
1685 // The disposition given by the --incremental-changed,
1686 // --incremental-unchanged or --incremental-unknown option. The
1687 // value may change as we proceed parsing the command line flags.
1688 Incremental_disposition
1689 incremental_disposition() const
1690 { return this->incremental_disposition_; }
1691
376c3ecd
CC
1692 void
1693 set_incremental_disposition(Incremental_disposition disp)
1694 { this->incremental_disposition_ = disp; }
1695
221597a5
CC
1696 // The disposition to use for startup files (those that precede the
1697 // first --incremental-changed, etc. option).
1698 Incremental_disposition
1699 incremental_startup_disposition() const
1700 { return this->incremental_startup_disposition_; }
1701
65514900
CC
1702 // Return true if S is the name of a library excluded from automatic
1703 // symbol export.
1704 bool
ca09d69a 1705 check_excluded_libs(const std::string &s) const;
65514900 1706
a192ba05
ILT
1707 // If an explicit start address was given for section SECNAME with
1708 // the --section-start option, return true and set *PADDR to the
1709 // address. Otherwise return false.
1710 bool
1711 section_start(const char* secname, uint64_t* paddr) const;
1712
ea0d8c47
ILT
1713 // Return whether any --section-start option was used.
1714 bool
1715 any_section_start() const
1716 { return !this->section_starts_.empty(); }
1717
9b2fd367
DK
1718 enum Fix_v4bx
1719 {
1720 // Leave original instruction.
1721 FIX_V4BX_NONE,
1722 // Replace instruction.
1723 FIX_V4BX_REPLACE,
1724 // Generate an interworking veneer.
1725 FIX_V4BX_INTERWORKING
1726 };
1727
1728 Fix_v4bx
1729 fix_v4bx() const
1730 { return (this->fix_v4bx_); }
1731
7296d933
DK
1732 enum Endianness
1733 {
1734 ENDIANNESS_NOT_SET,
1735 ENDIANNESS_BIG,
1736 ENDIANNESS_LITTLE
1737 };
1738
1739 Endianness
1740 endianness() const
1741 { return this->endianness_; }
1742
cd3c333f
CC
1743 bool
1744 discard_all() const
1745 { return this->discard_locals_ == DISCARD_ALL; }
1746
1747 bool
1748 discard_locals() const
1749 { return this->discard_locals_ == DISCARD_LOCALS; }
1750
1751 bool
1752 discard_sec_merge() const
1753 { return this->discard_locals_ == DISCARD_SEC_MERGE; }
1754
591be3e4
CC
1755 enum Orphan_handling
1756 {
1757 // Place orphan sections normally (default).
1758 ORPHAN_PLACE,
1759 // Discard all orphan sections.
1760 ORPHAN_DISCARD,
1761 // Warn when placing orphan sections.
1762 ORPHAN_WARN,
1763 // Issue error for orphan sections.
1764 ORPHAN_ERROR
1765 };
1766
1767 Orphan_handling
1768 orphan_handling_enum() const
1769 { return this->orphan_handling_enum_; }
1770
cae64165
RM
1771 elfcpp::STV
1772 start_stop_visibility_enum() const
1773 { return this->start_stop_visibility_enum_; }
1774
afd2ea23
AM
1775 enum Power10_stubs
1776 {
1777 // Use Power10 insns on @notoc calls/branches, non-Power10 elsewhere.
1778 POWER10_STUBS_AUTO,
1779 // Don't use Power10 insns
1780 POWER10_STUBS_NO,
1781 // Always use Power10 insns
1782 POWER10_STUBS_YES
1783 };
1784
1785 Power10_stubs
1786 power10_stubs_enum() const
1787 { return this->power10_stubs_enum_; }
1788
bae7f79e 1789 private:
dbe717ef
ILT
1790 // Don't copy this structure.
1791 General_options(const General_options&);
1792 General_options& operator=(const General_options&);
1793
cd3c333f
CC
1794 // What local symbols to discard.
1795 enum Discard_locals
1796 {
1797 // Locals in merge sections (default).
1798 DISCARD_SEC_MERGE,
1799 // None (--discard-none).
1800 DISCARD_NONE,
1801 // Temporary locals (--discard-locals/-X).
1802 DISCARD_LOCALS,
1803 // All locals (--discard-all/-x).
1804 DISCARD_ALL
1805 };
1806
35cdfc9a
ILT
1807 // Whether to mark the stack as executable.
1808 enum Execstack
1809 {
1810 // Not set on command line.
1811 EXECSTACK_FROM_INPUT,
ee1fe73e 1812 // Mark the stack as executable (-z execstack).
35cdfc9a 1813 EXECSTACK_YES,
ee1fe73e 1814 // Mark the stack as not executable (-z noexecstack).
35cdfc9a
ILT
1815 EXECSTACK_NO
1816 };
1817
032ce4e9
ST
1818 enum Icf_status
1819 {
1820 // Do not fold any functions (Default or --icf=none).
1821 ICF_NONE,
1822 // All functions are candidates for folding. (--icf=all).
0c6e6c39 1823 ICF_ALL,
032ce4e9
ST
1824 // Only ctors and dtors are candidates for folding. (--icf=safe).
1825 ICF_SAFE
1826 };
1827
1828 void
1829 set_icf_status(Icf_status value)
1830 { this->icf_status_ = value; }
1831
92e059d8 1832 void
ee1fe73e 1833 set_execstack_status(Execstack value)
086a1841
ILT
1834 { this->execstack_status_ = value; }
1835
1836 void
1837 set_do_demangle(bool value)
1838 { this->do_demangle_ = value; }
92e059d8 1839
bae7f79e 1840 void
45aa233b 1841 set_static(bool value)
ee1fe73e 1842 { static_ = value; }
652ec9bd 1843
591be3e4
CC
1844 void
1845 set_orphan_handling_enum(Orphan_handling value)
1846 { this->orphan_handling_enum_ = value; }
1847
cae64165
RM
1848 void
1849 set_start_stop_visibility_enum(elfcpp::STV value)
1850 { this->start_stop_visibility_enum_ = value; }
1851
afd2ea23
AM
1852 void
1853 set_power10_stubs_enum(Power10_stubs value)
1854 { this->power10_stubs_enum_ = value; }
1855
ee1fe73e 1856 // These are called by finalize() to set up the search-path correctly.
35cdfc9a 1857 void
3f3cddf1 1858 add_to_library_path_with_sysroot(const std::string& arg)
ee1fe73e 1859 { this->add_search_directory_to_library_path(Search_directory(arg, true)); }
c7912668 1860
ad2d6943
ILT
1861 // Apply any sysroot to the directory lists.
1862 void
1863 add_sysroot();
086a1841 1864
89fc3421
CC
1865 // Add a plugin and its arguments to the list of plugins.
1866 void
ca09d69a 1867 add_plugin(const char* filename);
4674ecfc
CC
1868
1869 // Add a plugin option.
1870 void
1871 add_plugin_option(const char* opt);
89fc3421 1872
376c3ecd
CC
1873 void
1874 copy_from_posdep_options(const Position_dependent_options&);
1875
459c9f1c
ILT
1876 // Whether we printed version information.
1877 bool printed_version_;
086a1841
ILT
1878 // Whether to mark the stack as executable.
1879 Execstack execstack_status_;
032ce4e9
ST
1880 // Whether to do code folding.
1881 Icf_status icf_status_;
086a1841
ILT
1882 // Whether to do a static link.
1883 bool static_;
1884 // Whether to do demangling.
1885 bool do_demangle_;
89fc3421
CC
1886 // List of plugin libraries.
1887 Plugin_manager* plugins_;
c82fbeee
CS
1888 // The parsed output of --dynamic-list files. For convenience in
1889 // script.cc, we store this as a Script_options object, even though
1890 // we only use a single Version_tree from it.
1891 Script_options dynamic_list_;
fd834e57
CC
1892 // Whether a --dynamic-list file was provided.
1893 bool have_dynamic_list_;
8c21d9d3
CC
1894 // The incremental linking mode.
1895 Incremental_mode incremental_mode_;
266d0a74
ILT
1896 // The disposition given by the --incremental-changed,
1897 // --incremental-unchanged or --incremental-unknown option. The
1898 // value may change as we proceed parsing the command line flags.
1899 Incremental_disposition incremental_disposition_;
221597a5
CC
1900 // The disposition to use for startup files (those marked
1901 // INCREMENTAL_STARTUP).
1902 Incremental_disposition incremental_startup_disposition_;
459c9f1c 1903 // Whether we have seen one of the options that require incremental
221597a5
CC
1904 // build (--incremental-changed, --incremental-unchanged,
1905 // --incremental-unknown, or --incremental-startup-unchanged).
266d0a74 1906 bool implicit_incremental_;
8c604651 1907 // Libraries excluded from automatic export, via --exclude-libs.
65514900 1908 Unordered_set<std::string> excluded_libs_;
8c604651
CS
1909 // List of symbol-names to keep, via -retain-symbol-info.
1910 Unordered_set<std::string> symbols_to_retain_;
a192ba05
ILT
1911 // Map from section name to address from --section-start.
1912 std::map<std::string, uint64_t> section_starts_;
9b2fd367
DK
1913 // Whether to process armv4 bx instruction relocation.
1914 Fix_v4bx fix_v4bx_;
7296d933
DK
1915 // Endianness.
1916 Endianness endianness_;
cd3c333f
CC
1917 // What local symbols to discard.
1918 Discard_locals discard_locals_;
376c3ecd
CC
1919 // Stack of saved options for --push-state/--pop-state.
1920 std::vector<Position_dependent_options*> options_stack_;
591be3e4
CC
1921 // Orphan handling option, decoded to an enum value.
1922 Orphan_handling orphan_handling_enum_;
cae64165
RM
1923 // Symbol visibility for __start_* / __stop_* magic symbols.
1924 elfcpp::STV start_stop_visibility_enum_;
afd2ea23
AM
1925 // Power10 stubs option
1926 Power10_stubs power10_stubs_enum_;
bae7f79e
ILT
1927};
1928
ee1fe73e
ILT
1929// The position-dependent options. We use this to store the state of
1930// the commandline at a particular point in parsing for later
1931// reference. For instance, if we see "ld --whole-archive foo.a
1932// --no-whole-archive," we want to store the whole-archive option with
1933// foo.a, so when the time comes to parse foo.a we know we should do
1934// it in whole-archive mode. We could store all of General_options,
1935// but that's big, so we just pick the subset of flags that actually
1936// change in a position-dependent way.
1937
1938#define DEFINE_posdep(varname__, type__) \
1939 public: \
1940 type__ \
1941 varname__() const \
1942 { return this->varname__##_; } \
0c6e6c39 1943 \
ee1fe73e
ILT
1944 void \
1945 set_##varname__(type__ value) \
1946 { this->varname__##_ = value; } \
1947 private: \
1948 type__ varname__##_
bae7f79e
ILT
1949
1950class Position_dependent_options
1951{
1952 public:
ee1fe73e 1953 Position_dependent_options(const General_options& options
0c6e6c39 1954 = Position_dependent_options::default_options_)
ee1fe73e 1955 { copy_from_options(options); }
bae7f79e 1956
376c3ecd
CC
1957 void
1958 copy_from_options(const General_options& options)
ee1fe73e
ILT
1959 {
1960 this->set_as_needed(options.as_needed());
1961 this->set_Bdynamic(options.Bdynamic());
1962 this->set_format_enum(options.format_enum());
1963 this->set_whole_archive(options.whole_archive());
266d0a74 1964 this->set_incremental_disposition(options.incremental_disposition());
ee1fe73e 1965 }
bc644c6c 1966
ee1fe73e
ILT
1967 DEFINE_posdep(as_needed, bool);
1968 DEFINE_posdep(Bdynamic, bool);
1969 DEFINE_posdep(format_enum, General_options::Object_format);
1970 DEFINE_posdep(whole_archive, bool);
266d0a74 1971 DEFINE_posdep(incremental_disposition, Incremental_disposition);
7cc619c3 1972
dbe717ef 1973 private:
ee1fe73e
ILT
1974 // This is a General_options with everything set to its default
1975 // value. A Position_dependent_options created with no argument
1976 // will take its values from here.
1977 static General_options default_options_;
bae7f79e
ILT
1978};
1979
ee1fe73e 1980
bae7f79e
ILT
1981// A single file or library argument from the command line.
1982
ead1e424 1983class Input_file_argument
bae7f79e
ILT
1984{
1985 public:
ae3b5189
CD
1986 enum Input_file_type
1987 {
1988 // A regular file, name used as-is, not searched.
1989 INPUT_FILE_TYPE_FILE,
1990 // A library name. When used, "lib" will be prepended and ".so" or
1991 // ".a" appended to make a filename, and that filename will be searched
1992 // for using the -L paths.
1993 INPUT_FILE_TYPE_LIBRARY,
1994 // A regular file, name used as-is, but searched using the -L paths.
1995 INPUT_FILE_TYPE_SEARCHED_FILE
1996 };
1997
51dee2fe 1998 // name: file name or library name
ae3b5189 1999 // type: the type of this input file.
51dee2fe
ILT
2000 // extra_search_path: an extra directory to look for the file, prior
2001 // to checking the normal library search path. If this is "",
2002 // then no extra directory is added.
88dd47ac 2003 // just_symbols: whether this file only defines symbols.
51dee2fe 2004 // options: The position dependent options at this point in the
ad2d6943 2005 // command line, such as --whole-archive.
ead1e424 2006 Input_file_argument()
ae3b5189 2007 : name_(), type_(INPUT_FILE_TYPE_FILE), extra_search_path_(""),
cdc29364 2008 just_symbols_(false), options_(), arg_serial_(0)
ead1e424
ILT
2009 { }
2010
2ea97941 2011 Input_file_argument(const char* name, Input_file_type type,
0c6e6c39
RM
2012 const char* extra_search_path,
2013 bool just_symbols,
2014 const Position_dependent_options& options)
2ea97941 2015 : name_(name), type_(type), extra_search_path_(extra_search_path),
cdc29364 2016 just_symbols_(just_symbols), options_(options), arg_serial_(0)
ee1fe73e
ILT
2017 { }
2018
2019 // You can also pass in a General_options instance instead of a
2020 // Position_dependent_options. In that case, we extract the
2021 // position-independent vars from the General_options and only store
2022 // those.
2ea97941 2023 Input_file_argument(const char* name, Input_file_type type,
0c6e6c39
RM
2024 const char* extra_search_path,
2025 bool just_symbols,
2026 const General_options& options)
2ea97941 2027 : name_(name), type_(type), extra_search_path_(extra_search_path),
cdc29364 2028 just_symbols_(just_symbols), options_(options), arg_serial_(0)
bae7f79e
ILT
2029 { }
2030
2031 const char*
2032 name() const
dbe717ef 2033 { return this->name_.c_str(); }
bae7f79e
ILT
2034
2035 const Position_dependent_options&
2036 options() const
2037 { return this->options_; }
2038
2039 bool
2040 is_lib() const
ae3b5189
CD
2041 { return type_ == INPUT_FILE_TYPE_LIBRARY; }
2042
2043 bool
2044 is_searched_file() const
2045 { return type_ == INPUT_FILE_TYPE_SEARCHED_FILE; }
bae7f79e 2046
51dee2fe
ILT
2047 const char*
2048 extra_search_path() const
2049 {
2050 return (this->extra_search_path_.empty()
0c6e6c39
RM
2051 ? NULL
2052 : this->extra_search_path_.c_str());
51dee2fe
ILT
2053 }
2054
88dd47ac
ILT
2055 // Return whether we should only read symbols from this file.
2056 bool
2057 just_symbols() const
2058 { return this->just_symbols_; }
2059
51dee2fe
ILT
2060 // Return whether this file may require a search using the -L
2061 // options.
2062 bool
2063 may_need_search() const
ae3b5189
CD
2064 {
2065 return (this->is_lib()
2066 || this->is_searched_file()
2067 || !this->extra_search_path_.empty());
2068 }
51dee2fe 2069
cdc29364
CC
2070 // Set the serial number for this argument.
2071 void
2072 set_arg_serial(unsigned int arg_serial)
2073 { this->arg_serial_ = arg_serial; }
2074
2075 // Get the serial number.
2076 unsigned int
2077 arg_serial() const
2078 { return this->arg_serial_; }
2079
bae7f79e 2080 private:
dbe717ef
ILT
2081 // We use std::string, not const char*, here for convenience when
2082 // using script files, so that we do not have to preserve the string
2083 // in that case.
2084 std::string name_;
ae3b5189 2085 Input_file_type type_;
51dee2fe 2086 std::string extra_search_path_;
88dd47ac 2087 bool just_symbols_;
bae7f79e 2088 Position_dependent_options options_;
cdc29364
CC
2089 // A unique index for this file argument in the argument list.
2090 unsigned int arg_serial_;
bae7f79e
ILT
2091};
2092
ead1e424
ILT
2093// A file or library, or a group, from the command line.
2094
2095class Input_argument
2096{
2097 public:
2098 // Create a file or library argument.
2ea97941 2099 explicit Input_argument(Input_file_argument file)
c7975edd 2100 : is_file_(true), file_(file), group_(NULL), lib_(NULL), script_info_(NULL)
ead1e424
ILT
2101 { }
2102
2103 // Create a group argument.
2ea97941 2104 explicit Input_argument(Input_file_group* group)
c7975edd 2105 : is_file_(false), group_(group), lib_(NULL), script_info_(NULL)
b0193076
RÁE
2106 { }
2107
2108 // Create a lib argument.
2109 explicit Input_argument(Input_file_lib* lib)
c7975edd 2110 : is_file_(false), group_(NULL), lib_(lib), script_info_(NULL)
ead1e424
ILT
2111 { }
2112
2113 // Return whether this is a file.
2114 bool
2115 is_file() const
2116 { return this->is_file_; }
2117
2118 // Return whether this is a group.
2119 bool
2120 is_group() const
b0193076
RÁE
2121 { return !this->is_file_ && this->lib_ == NULL; }
2122
2123 // Return whether this is a lib.
2124 bool
2125 is_lib() const
2126 { return this->lib_ != NULL; }
ead1e424
ILT
2127
2128 // Return the information about the file.
2129 const Input_file_argument&
2130 file() const
2131 {
a3ad94ed 2132 gold_assert(this->is_file_);
ead1e424
ILT
2133 return this->file_;
2134 }
2135
2136 // Return the information about the group.
2137 const Input_file_group*
2138 group() const
2139 {
a3ad94ed 2140 gold_assert(!this->is_file_);
ead1e424
ILT
2141 return this->group_;
2142 }
2143
2144 Input_file_group*
2145 group()
2146 {
a3ad94ed 2147 gold_assert(!this->is_file_);
ead1e424
ILT
2148 return this->group_;
2149 }
2150
b0193076
RÁE
2151 // Return the information about the lib.
2152 const Input_file_lib*
2153 lib() const
2154 {
2155 gold_assert(!this->is_file_);
2156 gold_assert(this->lib_);
2157 return this->lib_;
2158 }
2159
2160 Input_file_lib*
2161 lib()
2162 {
2163 gold_assert(!this->is_file_);
2164 gold_assert(this->lib_);
2165 return this->lib_;
2166 }
2167
c7975edd
CC
2168 // If a script generated this argument, store a pointer to the script info.
2169 // Currently used only for recording incremental link information.
2170 void
2171 set_script_info(Script_info* info)
2172 { this->script_info_ = info; }
2173
2174 Script_info*
2175 script_info() const
2176 { return this->script_info_; }
2177
ead1e424
ILT
2178 private:
2179 bool is_file_;
2180 Input_file_argument file_;
2181 Input_file_group* group_;
b0193076 2182 Input_file_lib* lib_;
c7975edd 2183 Script_info* script_info_;
ead1e424
ILT
2184};
2185
072fe7ce
ILT
2186typedef std::vector<Input_argument> Input_argument_list;
2187
ead1e424
ILT
2188// A group from the command line. This is a set of arguments within
2189// --start-group ... --end-group.
2190
2191class Input_file_group
92e059d8 2192{
ead1e424 2193 public:
072fe7ce 2194 typedef Input_argument_list::const_iterator const_iterator;
ead1e424
ILT
2195
2196 Input_file_group()
2197 : files_()
2198 { }
2199
2200 // Add a file to the end of the group.
c7975edd 2201 Input_argument&
ead1e424 2202 add_file(const Input_file_argument& arg)
c7975edd
CC
2203 {
2204 this->files_.push_back(Input_argument(arg));
2205 return this->files_.back();
2206 }
ead1e424
ILT
2207
2208 // Iterators to iterate over the group contents.
2209
2210 const_iterator
2211 begin() const
2212 { return this->files_.begin(); }
2213
2214 const_iterator
2215 end() const
2216 { return this->files_.end(); }
2217
2218 private:
072fe7ce 2219 Input_argument_list files_;
92e059d8
ILT
2220};
2221
b0193076
RÁE
2222// A lib from the command line. This is a set of arguments within
2223// --start-lib ... --end-lib.
2224
2225class Input_file_lib
2226{
2227 public:
2228 typedef Input_argument_list::const_iterator const_iterator;
2229
2230 Input_file_lib(const Position_dependent_options& options)
2231 : files_(), options_(options)
2232 { }
2233
2234 // Add a file to the end of the lib.
c7975edd 2235 Input_argument&
b0193076 2236 add_file(const Input_file_argument& arg)
c7975edd
CC
2237 {
2238 this->files_.push_back(Input_argument(arg));
2239 return this->files_.back();
2240 }
b0193076
RÁE
2241
2242 const Position_dependent_options&
2243 options() const
2244 { return this->options_; }
2245
2246 // Iterators to iterate over the lib contents.
2247
2248 const_iterator
2249 begin() const
2250 { return this->files_.begin(); }
2251
2252 const_iterator
2253 end() const
2254 { return this->files_.end(); }
2255
2256 size_t
2257 size() const
2258 { return this->files_.size(); }
2259
2260 private:
2261 Input_argument_list files_;
2262 Position_dependent_options options_;
2263};
2264
dbe717ef
ILT
2265// A list of files from the command line or a script.
2266
2267class Input_arguments
2268{
2269 public:
dbe717ef
ILT
2270 typedef Input_argument_list::const_iterator const_iterator;
2271
2272 Input_arguments()
cdc29364 2273 : input_argument_list_(), in_group_(false), in_lib_(false), file_count_(0)
dbe717ef
ILT
2274 { }
2275
2276 // Add a file.
c7975edd 2277 Input_argument&
cdc29364 2278 add_file(Input_file_argument& arg);
dbe717ef
ILT
2279
2280 // Start a group (the --start-group option).
2281 void
2282 start_group();
2283
2284 // End a group (the --end-group option).
2285 void
2286 end_group();
2287
b0193076
RÁE
2288 // Start a lib (the --start-lib option).
2289 void
2290 start_lib(const Position_dependent_options&);
2291
2292 // End a lib (the --end-lib option).
2293 void
2294 end_lib();
2295
dbe717ef
ILT
2296 // Return whether we are currently in a group.
2297 bool
2298 in_group() const
2299 { return this->in_group_; }
2300
b0193076
RÁE
2301 // Return whether we are currently in a lib.
2302 bool
2303 in_lib() const
2304 { return this->in_lib_; }
2305
fe9a4c12
ILT
2306 // The number of entries in the list.
2307 int
2308 size() const
2309 { return this->input_argument_list_.size(); }
2310
dbe717ef
ILT
2311 // Iterators to iterate over the list of input files.
2312
2313 const_iterator
2314 begin() const
2315 { return this->input_argument_list_.begin(); }
2316
2317 const_iterator
2318 end() const
2319 { return this->input_argument_list_.end(); }
2320
2321 // Return whether the list is empty.
2322 bool
2323 empty() const
2324 { return this->input_argument_list_.empty(); }
2325
cdc29364
CC
2326 // Return the number of input files. This may be larger than
2327 // input_argument_list_.size(), because of files that are part
2328 // of groups or libs.
2329 int
2330 number_of_input_files() const
2331 { return this->file_count_; }
2332
dbe717ef
ILT
2333 private:
2334 Input_argument_list input_argument_list_;
2335 bool in_group_;
b0193076 2336 bool in_lib_;
cdc29364 2337 unsigned int file_count_;
dbe717ef
ILT
2338};
2339
ee1fe73e
ILT
2340
2341// All the information read from the command line. These are held in
2342// three separate structs: one to hold the options (--foo), one to
2343// hold the filenames listed on the commandline, and one to hold
2344// linker script information. This third is not a subset of the other
2345// two because linker scripts can be specified either as options (via
2346// -T) or as a file.
bae7f79e
ILT
2347
2348class Command_line
2349{
2350 public:
ead1e424
ILT
2351 typedef Input_arguments::const_iterator const_iterator;
2352
a5dc0706 2353 Command_line();
bae7f79e
ILT
2354
2355 // Process the command line options. This will exit with an
2356 // appropriate error message if an unrecognized option is seen.
2357 void
ee1fe73e 2358 process(int argc, const char** argv);
bae7f79e 2359
a0451b38 2360 // Process one command-line option. This takes the index of argv to
ee1fe73e
ILT
2361 // process, and returns the index for the next option. no_more_options
2362 // is set to true if argv[i] is "--".
61ba1cf9 2363 int
ee1fe73e 2364 process_one_option(int argc, const char** argv, int i,
0c6e6c39 2365 bool* no_more_options);
3c2fafa5 2366
61ba1cf9 2367 // Get the general options.
bae7f79e
ILT
2368 const General_options&
2369 options() const
2370 { return this->options_; }
2371
3c2fafa5
ILT
2372 // Get the position dependent options.
2373 const Position_dependent_options&
2374 position_dependent_options() const
2375 { return this->position_options_; }
2376
a5dc0706
ILT
2377 // Get the linker-script options.
2378 Script_options&
e5756efb 2379 script_options()
a5dc0706 2380 { return this->script_options_; }
e5756efb 2381
6affe781 2382 // Finalize the version-script options and return them.
a5dc0706 2383 const Version_script_info&
6affe781 2384 version_script();
e5756efb 2385
ee1fe73e
ILT
2386 // Get the input files.
2387 Input_arguments&
2388 inputs()
2389 { return this->inputs_; }
2390
fe9a4c12
ILT
2391 // The number of input files.
2392 int
2393 number_of_input_files() const
cdc29364 2394 { return this->inputs_.number_of_input_files(); }
fe9a4c12 2395
ead1e424
ILT
2396 // Iterators to iterate over the list of input files.
2397
2398 const_iterator
2399 begin() const
2400 { return this->inputs_.begin(); }
2401
2402 const_iterator
2403 end() const
2404 { return this->inputs_.end(); }
bae7f79e
ILT
2405
2406 private:
ead1e424
ILT
2407 Command_line(const Command_line&);
2408 Command_line& operator=(const Command_line&);
2409
293c1386
CC
2410 // This is a dummy class to provide a constructor that runs before
2411 // the constructor for the General_options. The Pre_options constructor
2412 // is used as a hook to set the flag enabling the options to register
2413 // themselves.
2414 struct Pre_options {
2415 Pre_options();
2416 };
2417
2418 // This must come before options_!
2419 Pre_options pre_options_;
bae7f79e
ILT
2420 General_options options_;
2421 Position_dependent_options position_options_;
a5dc0706 2422 Script_options script_options_;
ead1e424 2423 Input_arguments inputs_;
bae7f79e
ILT
2424};
2425
2426} // End namespace gold.
2427
2428#endif // !defined(GOLD_OPTIONS_H)
This page took 0.775808 seconds and 4 git commands to generate.