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