Commit | Line | Data |
---|---|---|
bae7f79e ILT |
1 | // options.h -- handle command line options for gold -*- C++ -*- |
2 | ||
e5756efb | 3 | // Copyright 2006, 2007, 2008 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> |
bae7f79e | 40 | #include <list> |
61ba1cf9 | 41 | #include <string> |
92e059d8 | 42 | #include <vector> |
bae7f79e | 43 | |
0daa6f62 | 44 | #include "elfcpp.h" |
3c2fafa5 ILT |
45 | #include "script.h" |
46 | ||
bae7f79e ILT |
47 | namespace gold |
48 | { | |
49 | ||
50 | class Command_line; | |
ee1fe73e ILT |
51 | class General_options; |
52 | class Search_directory; | |
ead1e424 | 53 | class Input_file_group; |
3c2fafa5 | 54 | class Position_dependent_options; |
0daa6f62 | 55 | class Target; |
bae7f79e | 56 | |
ee1fe73e ILT |
57 | // The nested namespace is to contain all the global variables and |
58 | // structs that need to be defined in the .h file, but do not need to | |
59 | // be used outside this class. | |
c7912668 ILT |
60 | namespace options |
61 | { | |
ee1fe73e ILT |
62 | typedef std::vector<Search_directory> Dir_list; |
63 | ||
64 | // These routines convert from a string option to various types. | |
65 | // Each gives a fatal error if it cannot parse the argument. | |
66 | ||
67 | extern void | |
68 | parse_bool(const char* option_name, const char* arg, bool* retval); | |
69 | ||
70 | extern void | |
71 | parse_uint(const char* option_name, const char* arg, int* retval); | |
72 | ||
73 | extern void | |
74 | parse_uint64(const char* option_name, const char* arg, uint64_t *retval); | |
75 | ||
76 | extern void | |
77 | parse_string(const char* option_name, const char* arg, const char** retval); | |
78 | ||
79 | extern void | |
80 | parse_dirlist(const char* option_name, const char* arg, Dir_list* retval); | |
81 | ||
82 | extern void | |
83 | parse_choices(const char* option_name, const char* arg, const char** retval, | |
84 | const char* choices[], int num_choices); | |
85 | ||
86 | struct Struct_var; | |
87 | ||
88 | // Most options have both a shortname (one letter) and a longname. | |
89 | // This enum controls how many dashes are expected for longname access | |
90 | // -- shortnames always use one dash. Most longnames will accept | |
91 | // either one dash or two; the only difference between ONE_DASH and | |
92 | // TWO_DASHES is how we print the option in --help. However, some | |
93 | // longnames require two dashes, and some require only one. The | |
94 | // special value DASH_Z means that the option is preceded by "-z". | |
95 | enum Dashes | |
96 | { | |
97 | ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z | |
98 | }; | |
99 | ||
100 | // LONGNAME is the long-name of the option with dashes converted to | |
101 | // underscores, or else the short-name if the option has no long-name. | |
102 | // It is never the empty string. | |
103 | // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc. | |
104 | // SHORTNAME is the short-name of the option, as a char, or '\0' if the | |
105 | // option has no short-name. If the option has no long-name, you | |
106 | // should specify the short-name in *both* VARNAME and here. | |
107 | // DEFAULT_VALUE is the value of the option if not specified on the | |
108 | // commandline, as a string. | |
109 | // HELPSTRING is the descriptive text used with the option via --help | |
110 | // HELPARG is how you define the argument to the option. | |
111 | // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING" | |
112 | // HELPARG should be NULL iff the option is a bool and takes no arg. | |
113 | // READER provides parse_to_value, which is a function that will convert | |
114 | // a char* argument into the proper type and store it in some variable. | |
115 | // A One_option struct initializes itself with the global list of options | |
116 | // at constructor time, so be careful making one of these. | |
117 | struct One_option | |
118 | { | |
119 | std::string longname; | |
120 | Dashes dashes; | |
121 | char shortname; | |
122 | const char* default_value; | |
123 | const char* helpstring; | |
124 | const char* helparg; | |
125 | Struct_var* reader; | |
126 | ||
127 | One_option(const char* ln, Dashes d, char sn, const char* dv, | |
128 | const char* hs, const char* ha, Struct_var* r) | |
129 | : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""), | |
130 | helpstring(hs), helparg(ha), reader(r) | |
131 | { | |
132 | // In longname, we convert all underscores to dashes, since GNU | |
133 | // style uses dashes in option names. longname is likely to have | |
134 | // underscores in it because it's also used to declare a C++ | |
135 | // function. | |
136 | const char* pos = strchr(this->longname.c_str(), '_'); | |
137 | for (; pos; pos = strchr(pos, '_')) | |
138 | this->longname[pos - this->longname.c_str()] = '-'; | |
139 | ||
140 | // We only register ourselves if our helpstring is not NULL. This | |
141 | // is to support the "no-VAR" boolean variables, which we | |
142 | // conditionally turn on by defining "no-VAR" help text. | |
143 | if (this->helpstring) | |
144 | this->register_option(); | |
145 | } | |
146 | ||
147 | // This option takes an argument iff helparg is not NULL. | |
148 | bool | |
149 | takes_argument() const | |
150 | { return this->helparg != NULL; } | |
151 | ||
152 | // Register this option with the global list of options. | |
153 | void | |
154 | register_option(); | |
155 | ||
156 | // Print this option to stdout (used with --help). | |
157 | void | |
158 | print() const; | |
159 | }; | |
160 | ||
161 | // All options have a Struct_##varname that inherits from this and | |
162 | // actually implements parse_to_value for that option. | |
163 | struct Struct_var | |
164 | { | |
165 | // OPTION: the name of the option as specified on the commandline, | |
166 | // including leading dashes, and any text following the option: | |
167 | // "-O", "--defsym=mysym=0x1000", etc. | |
168 | // ARG: the arg associated with this option, or NULL if the option | |
169 | // takes no argument: "2", "mysym=0x1000", etc. | |
170 | // CMDLINE: the global Command_line object. Used by DEFINE_special. | |
171 | // OPTIONS: the global General_options object. Used by DEFINE_special. | |
172 | virtual void | |
173 | parse_to_value(const char* option, const char* arg, | |
174 | Command_line* cmdline, General_options* options) = 0; | |
175 | virtual | |
176 | ~Struct_var() // To make gcc happy. | |
177 | { } | |
178 | }; | |
bae7f79e | 179 | |
ee1fe73e ILT |
180 | // This is for "special" options that aren't of any predefined type. |
181 | struct Struct_special : public Struct_var | |
182 | { | |
183 | // If you change this, change the parse-fn in DEFINE_special as well. | |
184 | typedef void (General_options::*Parse_function)(const char*, const char*, | |
185 | Command_line*); | |
186 | Struct_special(const char* varname, Dashes dashes, char shortname, | |
187 | Parse_function parse_function, | |
188 | const char* helpstring, const char* helparg) | |
189 | : option(varname, dashes, shortname, "", helpstring, helparg, this), | |
190 | parse(parse_function) | |
191 | { } | |
192 | ||
193 | void parse_to_value(const char* option, const char* arg, | |
194 | Command_line* cmdline, General_options* options) | |
195 | { (options->*(this->parse))(option, arg, cmdline); } | |
196 | ||
197 | One_option option; | |
198 | Parse_function parse; | |
199 | }; | |
200 | ||
201 | } // End namespace options. | |
202 | ||
203 | ||
204 | // These are helper macros use by DEFINE_uint64/etc below. | |
205 | // This macro is used inside the General_options_ class, so defines | |
206 | // var() and set_var() as General_options methods. Arguments as are | |
207 | // for the constructor for One_option. param_type__ is the same as | |
208 | // type__ for built-in types, and "const type__ &" otherwise. | |
209 | #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \ | |
210 | default_value_as_string__, helpstring__, helparg__, \ | |
211 | type__, param_type__, parse_fn__) \ | |
212 | public: \ | |
213 | param_type__ \ | |
214 | varname__() const \ | |
215 | { return this->varname__##_.value; } \ | |
216 | \ | |
217 | bool \ | |
218 | user_set_##varname__() const \ | |
219 | { return this->varname__##_.user_set_via_option; } \ | |
220 | \ | |
221 | private: \ | |
222 | struct Struct_##varname__ : public options::Struct_var \ | |
223 | { \ | |
224 | Struct_##varname__() \ | |
225 | : option(#varname__, dashes__, shortname__, default_value_as_string__, \ | |
226 | helpstring__, helparg__, this), \ | |
227 | user_set_via_option(false), value(default_value__) \ | |
228 | { } \ | |
229 | \ | |
230 | void \ | |
231 | parse_to_value(const char* option_name, const char* arg, \ | |
232 | Command_line*, General_options*) \ | |
233 | { \ | |
234 | parse_fn__(option_name, arg, &this->value); \ | |
235 | this->user_set_via_option = true; \ | |
236 | } \ | |
237 | \ | |
238 | options::One_option option; \ | |
239 | bool user_set_via_option; \ | |
240 | type__ value; \ | |
241 | }; \ | |
242 | Struct_##varname__ varname__##_; \ | |
243 | void \ | |
244 | set_##varname__(param_type__ value) \ | |
245 | { this->varname__##_.value = value; } | |
246 | ||
247 | // These macros allow for easy addition of a new commandline option. | |
248 | ||
249 | // If no_helpstring__ is not NULL, then in addition to creating | |
250 | // VARNAME, we also create an option called no-VARNAME. | |
251 | #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \ | |
252 | helpstring__, no_helpstring__) \ | |
253 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ | |
254 | default_value__ ? "true" : "false", helpstring__, NULL, \ | |
255 | bool, bool, options::parse_bool) \ | |
256 | struct Struct_no_##varname__ : public options::Struct_var \ | |
257 | { \ | |
258 | Struct_no_##varname__() : option("no-" #varname__, dashes__, '\0', \ | |
259 | default_value__ ? "false" : "true", \ | |
260 | no_helpstring__, NULL, this) \ | |
261 | { } \ | |
262 | \ | |
263 | void \ | |
264 | parse_to_value(const char*, const char*, \ | |
265 | Command_line*, General_options* options) \ | |
266 | { options->set_##varname__(false); } \ | |
267 | \ | |
268 | options::One_option option; \ | |
269 | }; \ | |
270 | Struct_no_##varname__ no_##varname__##_initializer_ | |
271 | ||
272 | #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \ | |
273 | helpstring__, helparg__) \ | |
274 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ | |
275 | #default_value__, helpstring__, helparg__, \ | |
276 | int, int, options::parse_uint) | |
277 | ||
278 | #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \ | |
279 | helpstring__, helparg__) \ | |
280 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ | |
281 | #default_value__, helpstring__, helparg__, \ | |
282 | uint64_t, uint64_t, options::parse_uint64) | |
283 | ||
284 | #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \ | |
285 | helpstring__, helparg__) \ | |
286 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ | |
287 | default_value__, helpstring__, helparg__, \ | |
288 | const char*, const char*, options::parse_string) | |
289 | ||
290 | // This is like DEFINE_string, but we convert each occurrence to a | |
291 | // Search_directory and store it in a vector. Thus we also have the | |
292 | // add_to_VARNAME() method, to append to the vector. | |
293 | #define DEFINE_dirlist(varname__, dashes__, shortname__, \ | |
294 | helpstring__, helparg__) \ | |
295 | DEFINE_var(varname__, dashes__, shortname__, , \ | |
296 | "", helpstring__, helparg__, options::Dir_list, \ | |
297 | const options::Dir_list&, options::parse_dirlist) \ | |
298 | void \ | |
299 | add_to_##varname__(const char* new_value) \ | |
300 | { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \ | |
301 | void \ | |
302 | add_search_directory_to_##varname__(const Search_directory& dir) \ | |
303 | { this->varname__##_.value.push_back(dir); } | |
304 | ||
305 | // When you have a list of possible values (expressed as string) | |
306 | // After helparg__ should come an initializer list, like | |
307 | // {"foo", "bar", "baz"} | |
308 | #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \ | |
309 | helpstring__, helparg__, ...) \ | |
310 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ | |
311 | default_value__, helpstring__, helparg__, \ | |
312 | const char*, const char*, parse_choices_##varname__) \ | |
313 | private: \ | |
314 | static void parse_choices_##varname__(const char* option_name, \ | |
315 | const char* arg, \ | |
316 | const char** retval) { \ | |
317 | const char* choices[] = __VA_ARGS__; \ | |
318 | options::parse_choices(option_name, arg, retval, \ | |
319 | choices, sizeof(choices) / sizeof(*choices)); \ | |
320 | } | |
321 | ||
322 | // This is used for non-standard flags. It defines no functions; it | |
323 | // just calls General_options::parse_VARNAME whenever the flag is | |
324 | // seen. We declare parse_VARNAME as a static member of | |
325 | // General_options; you are responsible for defining it there. | |
326 | // helparg__ should be NULL iff this special-option is a boolean. | |
327 | #define DEFINE_special(varname__, dashes__, shortname__, \ | |
328 | helpstring__, helparg__) \ | |
329 | private: \ | |
330 | void parse_##varname__(const char* option, const char* arg, \ | |
331 | Command_line* inputs); \ | |
332 | struct Struct_##varname__ : public options::Struct_special \ | |
333 | { \ | |
334 | Struct_##varname__() \ | |
335 | : options::Struct_special(#varname__, dashes__, shortname__, \ | |
336 | &General_options::parse_##varname__, \ | |
337 | helpstring__, helparg__) \ | |
338 | { } \ | |
339 | }; \ | |
340 | Struct_##varname__ varname__##_initializer_ | |
bae7f79e | 341 | |
bae7f79e | 342 | |
ad2d6943 ILT |
343 | // A directory to search. For each directory we record whether it is |
344 | // in the sysroot. We need to know this so that, if a linker script | |
345 | // is found within the sysroot, we will apply the sysroot to any files | |
346 | // named by that script. | |
347 | ||
348 | class Search_directory | |
349 | { | |
350 | public: | |
351 | // We need a default constructor because we put this in a | |
352 | // std::vector. | |
353 | Search_directory() | |
354 | : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false) | |
355 | { } | |
356 | ||
357 | // This is the usual constructor. | |
358 | Search_directory(const char* name, bool put_in_sysroot) | |
359 | : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false) | |
15893b88 ILT |
360 | { |
361 | if (this->name_.empty()) | |
362 | this->name_ = "."; | |
363 | } | |
ad2d6943 ILT |
364 | |
365 | // This is called if we have a sysroot. The sysroot is prefixed to | |
366 | // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is | |
367 | // set to true for any enries which are in the sysroot (this will | |
368 | // naturally include any entries for which put_in_sysroot_ is true). | |
369 | // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of | |
370 | // passing SYSROOT to lrealpath. | |
371 | void | |
372 | add_sysroot(const char* sysroot, const char* canonical_sysroot); | |
373 | ||
374 | // Get the directory name. | |
375 | const std::string& | |
376 | name() const | |
377 | { return this->name_; } | |
378 | ||
379 | // Return whether this directory is in the sysroot. | |
380 | bool | |
381 | is_in_sysroot() const | |
382 | { return this->is_in_sysroot_; } | |
383 | ||
384 | private: | |
385 | std::string name_; | |
386 | bool put_in_sysroot_; | |
387 | bool is_in_sysroot_; | |
388 | }; | |
389 | ||
bae7f79e ILT |
390 | class General_options |
391 | { | |
ee1fe73e ILT |
392 | private: |
393 | // NOTE: For every option that you add here, also consider if you | |
394 | // should add it to Position_dependent_options. | |
395 | DEFINE_special(help, options::TWO_DASHES, '\0', | |
396 | _("Report usage information"), NULL); | |
397 | DEFINE_special(version, options::TWO_DASHES, 'v', | |
398 | _("Report version information"), NULL); | |
399 | ||
400 | DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false, | |
401 | _("Allow unresolved references in shared libraries"), | |
402 | _("Do not allow unresolved references in shared libraries")); | |
403 | ||
404 | DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false, | |
405 | _("Only set DT_NEEDED for dynamic libs if used"), | |
406 | _("Always DT_NEEDED for dynamic libs")); | |
407 | ||
408 | DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true, | |
409 | _("-l searches for shared libraries"), NULL); | |
410 | // Bstatic affects the same variable as Bdynamic, so we have to use | |
411 | // the "special" macro to make that happen. | |
412 | DEFINE_special(Bstatic, options::ONE_DASH, '\0', | |
413 | _("-l does not search for shared libraries"), NULL); | |
414 | ||
415 | DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false, | |
416 | _("Bind defined symbols locally"), NULL); | |
417 | ||
418 | DEFINE_enum(format, options::TWO_DASHES, 'b', "elf", | |
419 | _("Set input format"), _("[elf,binary]"), | |
420 | {"elf", "binary", | |
421 | "elf32-i386", "elf32-little", "elf32-big", | |
422 | "elf64-x86_64", "elf64-little", "elf64-big"}); | |
bae7f79e | 423 | |
ee1fe73e ILT |
424 | #ifdef HAVE_ZLIB_H |
425 | DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none", | |
426 | _("Compress .debug_* sections in the output file"), | |
427 | _("[none,zlib]"), | |
428 | {"none", "zlib"}); | |
429 | #else | |
430 | DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none", | |
431 | _("Compress .debug_* sections in the output file"), | |
432 | _("[none]"), | |
433 | {"none"}); | |
434 | #endif | |
0dfbdef4 | 435 | |
ee1fe73e ILT |
436 | DEFINE_bool(define_common, options::TWO_DASHES, 'd', false, |
437 | _("Define common symbols"), | |
438 | _("Do not define common symbols")); | |
439 | DEFINE_bool(dc, options::ONE_DASH, '\0', false, | |
440 | _("Alias for -d"), NULL); | |
441 | DEFINE_bool(dp, options::ONE_DASH, '\0', false, | |
442 | _("Alias for -d"), NULL); | |
d391083d | 443 | |
ee1fe73e ILT |
444 | DEFINE_special(defsym, options::TWO_DASHES, '\0', |
445 | _("Define a symbol"), _("SYMBOL=EXPRESSION")); | |
a6badf5a | 446 | |
ee1fe73e ILT |
447 | DEFINE_bool(demangle, options::TWO_DASHES, '\0', |
448 | getenv("COLLECT_NO_DEMANGLE") == NULL, | |
449 | _("Demangle C++ symbols in log messages"), | |
450 | _("Do not demangle C++ symbols in log messages")); | |
fced7afd | 451 | |
ee1fe73e ILT |
452 | DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false, |
453 | _("Try to detect violations of the One Definition Rule"), | |
454 | NULL); | |
455 | ||
456 | DEFINE_string(entry, options::TWO_DASHES, 'e', NULL, | |
457 | _("Set program start address"), _("ADDRESS")); | |
458 | ||
459 | DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false, | |
460 | _("Export all dynamic symbols"), NULL); | |
dbe717ef | 461 | |
ee1fe73e ILT |
462 | DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false, |
463 | _("Create exception frame header"), NULL); | |
464 | ||
465 | DEFINE_string(soname, options::ONE_DASH, 'h', NULL, | |
466 | _("Set shared library name"), _("FILENAME")); | |
467 | ||
468 | DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL, | |
469 | _("Set dynamic linker path"), _("PROGRAM")); | |
470 | ||
471 | DEFINE_special(library, options::TWO_DASHES, 'l', | |
472 | _("Search for library LIBNAME"), _("LIBNAME")); | |
bae7f79e | 473 | |
ee1fe73e ILT |
474 | DEFINE_dirlist(library_path, options::TWO_DASHES, 'L', |
475 | _("Add directory to search path"), _("DIR")); | |
476 | ||
477 | DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "", | |
478 | _("Ignored for compatibility"), _("EMULATION")); | |
479 | ||
480 | DEFINE_string(output, options::TWO_DASHES, 'o', "a.out", | |
481 | _("Set output file name"), _("FILE")); | |
482 | ||
483 | DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0, | |
484 | _("Optimize output file size"), _("LEVEL")); | |
485 | ||
486 | DEFINE_enum(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf", | |
487 | _("Set output format"), _("[binary]"), | |
488 | {"elf", "binary"}); | |
489 | ||
490 | DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false, | |
491 | _("Generate relocations in output"), NULL); | |
492 | ||
493 | DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false, | |
494 | _("Generate relocatable output"), NULL); | |
495 | ||
496 | // -R really means -rpath, but can mean --just-symbols for | |
497 | // compatibility with GNU ld. -rpath is always -rpath, so we list | |
498 | // it separately. | |
499 | DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R', | |
500 | _("Add DIR to runtime search path"), _("DIR")); | |
501 | ||
502 | DEFINE_dirlist(rpath, options::ONE_DASH, '\0', | |
503 | _("Add DIR to runtime search path"), _("DIR")); | |
504 | ||
505 | DEFINE_special(just_symbols, options::TWO_DASHES, '\0', | |
506 | _("Read only symbol values from FILE"), _("FILE")); | |
507 | ||
508 | DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0', | |
509 | _("Add DIR to link time shared library search path"), | |
510 | _("DIR")); | |
511 | ||
512 | DEFINE_bool(strip_all, options::TWO_DASHES, 's', false, | |
513 | _("Strip all symbols"), NULL); | |
514 | DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false, | |
515 | _("Strip debug symbols that are unused by gdb " | |
516 | "(at least versions <= 6.7)"), NULL); | |
517 | DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false, | |
518 | _("Strip debugging information"), NULL); | |
519 | ||
520 | DEFINE_bool(shared, options::ONE_DASH, '\0', false, | |
521 | _("Generate shared library"), NULL); | |
522 | ||
523 | // This is not actually special in any way, but I need to give it | |
524 | // a non-standard accessor-function name because 'static' is a keyword. | |
525 | DEFINE_special(static, options::ONE_DASH, '\0', | |
526 | _("Do not link against shared libraries"), NULL); | |
527 | ||
528 | DEFINE_bool(stats, options::TWO_DASHES, '\0', false, | |
529 | _("Print resource usage statistics"), NULL); | |
530 | ||
531 | DEFINE_string(sysroot, options::TWO_DASHES, '\0', "", | |
532 | _("Set target system root directory"), _("DIR")); | |
533 | ||
534 | DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U, | |
535 | _("Set the address of the bss segment"), _("ADDRESS")); | |
536 | DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U, | |
537 | _("Set the address of the data segment"), _("ADDRESS")); | |
538 | DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U, | |
539 | _("Set the address of the text segment"), _("ADDRESS")); | |
540 | ||
541 | DEFINE_special(script, options::TWO_DASHES, 'T', | |
542 | _("Read linker script"), _("FILE")); | |
543 | DEFINE_special(version_script, options::TWO_DASHES, '\0', | |
544 | _("Read version script"), _("FILE")); | |
545 | ||
546 | DEFINE_bool(threads, options::TWO_DASHES, '\0', false, | |
547 | _("Run the linker multi-threaded"), | |
548 | _("Do not run the linker multi-threaded")); | |
549 | DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0, | |
550 | _("Number of threads to use"), _("COUNT")); | |
551 | DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0, | |
552 | _("Number of threads to use in initial pass"), _("COUNT")); | |
553 | DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0, | |
554 | _("Number of threads to use in middle pass"), _("COUNT")); | |
555 | DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0, | |
556 | _("Number of threads to use in final pass"), _("COUNT")); | |
557 | ||
558 | DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false, | |
559 | _("Include all archive contents"), | |
560 | _("Include only needed archive contents")); | |
561 | ||
562 | DEFINE_special(start_group, options::TWO_DASHES, '(', | |
563 | _("Start a library search group"), NULL); | |
564 | DEFINE_special(end_group, options::TWO_DASHES, ')', | |
565 | _("End a library search group"), NULL); | |
566 | ||
567 | DEFINE_string(debug, options::TWO_DASHES, '\0', "", | |
568 | _("Turn on debugging"), _("[task,script,all][,...]")); | |
569 | ||
570 | // The -z flags. | |
571 | ||
572 | // Both execstack and noexecstack differ from the default execstack_ | |
573 | // value, so we need to use different variables for them. | |
574 | DEFINE_bool(execstack, options::DASH_Z, '\0', false, | |
575 | _("Mark output as requiring executable stack"), NULL); | |
576 | DEFINE_bool(noexecstack, options::DASH_Z, '\0', false, | |
577 | _("Mark output as not requiring executable stack"), NULL); | |
578 | DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0, | |
579 | _("Set maximum page size to SIZE"), _("SIZE")); | |
580 | DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0, | |
581 | _("Set common page size to SIZE"), _("SIZE")); | |
bae7f79e | 582 | |
ee1fe73e ILT |
583 | public: |
584 | typedef options::Dir_list Dir_list; | |
ca3a67a5 | 585 | |
ee1fe73e | 586 | General_options(); |
61ba1cf9 | 587 | |
ee1fe73e ILT |
588 | // Does post-processing on flags, making sure they all have |
589 | // non-conflicting values. Also converts some flags from their | |
590 | // "standard" types (string, etc), to another type (enum, DirList), | |
591 | // which can be accessed via a separate method. Dies if it notices | |
592 | // any problems. | |
593 | void finalize(); | |
516cb3d0 | 594 | |
ee1fe73e ILT |
595 | // The macro defines output() (based on --output), but that's a |
596 | // generic name. Provide this alternative name, which is clearer. | |
8851ecca | 597 | const char* |
ee1fe73e ILT |
598 | output_file_name() const |
599 | { return this->output(); } | |
92e059d8 | 600 | |
8851ecca ILT |
601 | // This is not defined via a flag, but combines flags to say whether |
602 | // the output is position-independent or not. | |
603 | bool | |
604 | output_is_position_independent() const | |
605 | { return this->shared(); } | |
606 | ||
ee1fe73e ILT |
607 | // This would normally be static(), and defined automatically, but |
608 | // since static is a keyword, we need to come up with our own name. | |
bae7f79e ILT |
609 | bool |
610 | is_static() const | |
ee1fe73e | 611 | { return static_; } |
756ac4a8 | 612 | |
ee1fe73e ILT |
613 | // In addition to getting the input and output formats as a string |
614 | // (via format() and oformat()), we also give access as an enum. | |
615 | enum Object_format | |
616 | { | |
617 | // Ordinary ELF. | |
618 | OBJECT_FORMAT_ELF, | |
619 | // Straight binary format. | |
620 | OBJECT_FORMAT_BINARY | |
621 | }; | |
fe9a4c12 | 622 | |
ee1fe73e ILT |
623 | // Note: these functions are not very fast. |
624 | Object_format format_enum() const; | |
625 | Object_format oformat_enum() const; | |
fe9a4c12 | 626 | |
ee1fe73e ILT |
627 | // These are the best way to get access to the execstack state, |
628 | // not execstack() and noexecstack() which are hard to use properly. | |
35cdfc9a ILT |
629 | bool |
630 | is_execstack_set() const | |
ee1fe73e | 631 | { return this->execstack_status_ != EXECSTACK_FROM_INPUT; } |
35cdfc9a ILT |
632 | |
633 | bool | |
634 | is_stack_executable() const | |
ee1fe73e | 635 | { return this->execstack_status_ == EXECSTACK_YES; } |
c7912668 | 636 | |
bae7f79e | 637 | private: |
dbe717ef ILT |
638 | // Don't copy this structure. |
639 | General_options(const General_options&); | |
640 | General_options& operator=(const General_options&); | |
641 | ||
35cdfc9a ILT |
642 | // Whether to mark the stack as executable. |
643 | enum Execstack | |
644 | { | |
645 | // Not set on command line. | |
646 | EXECSTACK_FROM_INPUT, | |
ee1fe73e | 647 | // Mark the stack as executable (-z execstack). |
35cdfc9a | 648 | EXECSTACK_YES, |
ee1fe73e | 649 | // Mark the stack as not executable (-z noexecstack). |
35cdfc9a ILT |
650 | EXECSTACK_NO |
651 | }; | |
652 | ||
ee1fe73e | 653 | Execstack execstack_status_; |
92e059d8 | 654 | void |
ee1fe73e ILT |
655 | set_execstack_status(Execstack value) |
656 | { execstack_status_ = value; } | |
92e059d8 | 657 | |
ee1fe73e | 658 | bool static_; |
bae7f79e | 659 | void |
45aa233b | 660 | set_static(bool value) |
ee1fe73e | 661 | { static_ = value; } |
652ec9bd | 662 | |
ee1fe73e | 663 | // These are called by finalize() to set up the search-path correctly. |
35cdfc9a | 664 | void |
ee1fe73e ILT |
665 | add_to_library_path_with_sysroot(const char* arg) |
666 | { this->add_search_directory_to_library_path(Search_directory(arg, true)); } | |
c7912668 | 667 | |
ad2d6943 ILT |
668 | // Apply any sysroot to the directory lists. |
669 | void | |
670 | add_sysroot(); | |
bae7f79e ILT |
671 | }; |
672 | ||
ee1fe73e ILT |
673 | // The position-dependent options. We use this to store the state of |
674 | // the commandline at a particular point in parsing for later | |
675 | // reference. For instance, if we see "ld --whole-archive foo.a | |
676 | // --no-whole-archive," we want to store the whole-archive option with | |
677 | // foo.a, so when the time comes to parse foo.a we know we should do | |
678 | // it in whole-archive mode. We could store all of General_options, | |
679 | // but that's big, so we just pick the subset of flags that actually | |
680 | // change in a position-dependent way. | |
681 | ||
682 | #define DEFINE_posdep(varname__, type__) \ | |
683 | public: \ | |
684 | type__ \ | |
685 | varname__() const \ | |
686 | { return this->varname__##_; } \ | |
687 | \ | |
688 | void \ | |
689 | set_##varname__(type__ value) \ | |
690 | { this->varname__##_ = value; } \ | |
691 | private: \ | |
692 | type__ varname__##_ | |
bae7f79e ILT |
693 | |
694 | class Position_dependent_options | |
695 | { | |
696 | public: | |
ee1fe73e ILT |
697 | Position_dependent_options(const General_options& options |
698 | = Position_dependent_options::default_options_) | |
699 | { copy_from_options(options); } | |
bae7f79e | 700 | |
ee1fe73e ILT |
701 | void copy_from_options(const General_options& options) |
702 | { | |
703 | this->set_as_needed(options.as_needed()); | |
704 | this->set_Bdynamic(options.Bdynamic()); | |
705 | this->set_format_enum(options.format_enum()); | |
706 | this->set_whole_archive(options.whole_archive()); | |
707 | } | |
bc644c6c | 708 | |
ee1fe73e ILT |
709 | DEFINE_posdep(as_needed, bool); |
710 | DEFINE_posdep(Bdynamic, bool); | |
711 | DEFINE_posdep(format_enum, General_options::Object_format); | |
712 | DEFINE_posdep(whole_archive, bool); | |
7cc619c3 | 713 | |
dbe717ef | 714 | private: |
ee1fe73e ILT |
715 | // This is a General_options with everything set to its default |
716 | // value. A Position_dependent_options created with no argument | |
717 | // will take its values from here. | |
718 | static General_options default_options_; | |
bae7f79e ILT |
719 | }; |
720 | ||
ee1fe73e | 721 | |
bae7f79e ILT |
722 | // A single file or library argument from the command line. |
723 | ||
ead1e424 | 724 | class Input_file_argument |
bae7f79e ILT |
725 | { |
726 | public: | |
51dee2fe ILT |
727 | // name: file name or library name |
728 | // is_lib: true if name is a library name: that is, emits the leading | |
729 | // "lib" and trailing ".so"/".a" from the name | |
730 | // extra_search_path: an extra directory to look for the file, prior | |
731 | // to checking the normal library search path. If this is "", | |
732 | // then no extra directory is added. | |
88dd47ac | 733 | // just_symbols: whether this file only defines symbols. |
51dee2fe | 734 | // options: The position dependent options at this point in the |
ad2d6943 | 735 | // command line, such as --whole-archive. |
ead1e424 | 736 | Input_file_argument() |
88dd47ac ILT |
737 | : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false), |
738 | options_() | |
ead1e424 ILT |
739 | { } |
740 | ||
741 | Input_file_argument(const char* name, bool is_lib, | |
51dee2fe | 742 | const char* extra_search_path, |
ee1fe73e ILT |
743 | bool just_symbols, |
744 | const Position_dependent_options& options) | |
745 | : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path), | |
746 | just_symbols_(just_symbols), options_(options) | |
747 | { } | |
748 | ||
749 | // You can also pass in a General_options instance instead of a | |
750 | // Position_dependent_options. In that case, we extract the | |
751 | // position-independent vars from the General_options and only store | |
752 | // those. | |
753 | Input_file_argument(const char* name, bool is_lib, | |
754 | const char* extra_search_path, | |
755 | bool just_symbols, | |
756 | const General_options& options) | |
51dee2fe | 757 | : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path), |
88dd47ac | 758 | just_symbols_(just_symbols), options_(options) |
bae7f79e ILT |
759 | { } |
760 | ||
761 | const char* | |
762 | name() const | |
dbe717ef | 763 | { return this->name_.c_str(); } |
bae7f79e ILT |
764 | |
765 | const Position_dependent_options& | |
766 | options() const | |
767 | { return this->options_; } | |
768 | ||
769 | bool | |
770 | is_lib() const | |
61ba1cf9 | 771 | { return this->is_lib_; } |
bae7f79e | 772 | |
51dee2fe ILT |
773 | const char* |
774 | extra_search_path() const | |
775 | { | |
776 | return (this->extra_search_path_.empty() | |
777 | ? NULL | |
ee1fe73e | 778 | : this->extra_search_path_.c_str()); |
51dee2fe ILT |
779 | } |
780 | ||
88dd47ac ILT |
781 | // Return whether we should only read symbols from this file. |
782 | bool | |
783 | just_symbols() const | |
784 | { return this->just_symbols_; } | |
785 | ||
51dee2fe ILT |
786 | // Return whether this file may require a search using the -L |
787 | // options. | |
788 | bool | |
789 | may_need_search() const | |
790 | { return this->is_lib_ || !this->extra_search_path_.empty(); } | |
791 | ||
bae7f79e | 792 | private: |
dbe717ef ILT |
793 | // We use std::string, not const char*, here for convenience when |
794 | // using script files, so that we do not have to preserve the string | |
795 | // in that case. | |
796 | std::string name_; | |
61ba1cf9 | 797 | bool is_lib_; |
51dee2fe | 798 | std::string extra_search_path_; |
88dd47ac | 799 | bool just_symbols_; |
bae7f79e ILT |
800 | Position_dependent_options options_; |
801 | }; | |
802 | ||
ead1e424 ILT |
803 | // A file or library, or a group, from the command line. |
804 | ||
805 | class Input_argument | |
806 | { | |
807 | public: | |
808 | // Create a file or library argument. | |
809 | explicit Input_argument(Input_file_argument file) | |
810 | : is_file_(true), file_(file), group_(NULL) | |
811 | { } | |
812 | ||
813 | // Create a group argument. | |
814 | explicit Input_argument(Input_file_group* group) | |
815 | : is_file_(false), group_(group) | |
816 | { } | |
817 | ||
818 | // Return whether this is a file. | |
819 | bool | |
820 | is_file() const | |
821 | { return this->is_file_; } | |
822 | ||
823 | // Return whether this is a group. | |
824 | bool | |
825 | is_group() const | |
826 | { return !this->is_file_; } | |
827 | ||
828 | // Return the information about the file. | |
829 | const Input_file_argument& | |
830 | file() const | |
831 | { | |
a3ad94ed | 832 | gold_assert(this->is_file_); |
ead1e424 ILT |
833 | return this->file_; |
834 | } | |
835 | ||
836 | // Return the information about the group. | |
837 | const Input_file_group* | |
838 | group() const | |
839 | { | |
a3ad94ed | 840 | gold_assert(!this->is_file_); |
ead1e424 ILT |
841 | return this->group_; |
842 | } | |
843 | ||
844 | Input_file_group* | |
845 | group() | |
846 | { | |
a3ad94ed | 847 | gold_assert(!this->is_file_); |
ead1e424 ILT |
848 | return this->group_; |
849 | } | |
850 | ||
851 | private: | |
852 | bool is_file_; | |
853 | Input_file_argument file_; | |
854 | Input_file_group* group_; | |
855 | }; | |
856 | ||
857 | // A group from the command line. This is a set of arguments within | |
858 | // --start-group ... --end-group. | |
859 | ||
860 | class Input_file_group | |
92e059d8 | 861 | { |
ead1e424 ILT |
862 | public: |
863 | typedef std::vector<Input_argument> Files; | |
864 | typedef Files::const_iterator const_iterator; | |
865 | ||
866 | Input_file_group() | |
867 | : files_() | |
868 | { } | |
869 | ||
870 | // Add a file to the end of the group. | |
871 | void | |
872 | add_file(const Input_file_argument& arg) | |
873 | { this->files_.push_back(Input_argument(arg)); } | |
874 | ||
875 | // Iterators to iterate over the group contents. | |
876 | ||
877 | const_iterator | |
878 | begin() const | |
879 | { return this->files_.begin(); } | |
880 | ||
881 | const_iterator | |
882 | end() const | |
883 | { return this->files_.end(); } | |
884 | ||
885 | private: | |
886 | Files files_; | |
92e059d8 ILT |
887 | }; |
888 | ||
dbe717ef ILT |
889 | // A list of files from the command line or a script. |
890 | ||
891 | class Input_arguments | |
892 | { | |
893 | public: | |
894 | typedef std::vector<Input_argument> Input_argument_list; | |
895 | typedef Input_argument_list::const_iterator const_iterator; | |
896 | ||
897 | Input_arguments() | |
898 | : input_argument_list_(), in_group_(false) | |
899 | { } | |
900 | ||
901 | // Add a file. | |
902 | void | |
903 | add_file(const Input_file_argument& arg); | |
904 | ||
905 | // Start a group (the --start-group option). | |
906 | void | |
907 | start_group(); | |
908 | ||
909 | // End a group (the --end-group option). | |
910 | void | |
911 | end_group(); | |
912 | ||
913 | // Return whether we are currently in a group. | |
914 | bool | |
915 | in_group() const | |
916 | { return this->in_group_; } | |
917 | ||
fe9a4c12 ILT |
918 | // The number of entries in the list. |
919 | int | |
920 | size() const | |
921 | { return this->input_argument_list_.size(); } | |
922 | ||
dbe717ef ILT |
923 | // Iterators to iterate over the list of input files. |
924 | ||
925 | const_iterator | |
926 | begin() const | |
927 | { return this->input_argument_list_.begin(); } | |
928 | ||
929 | const_iterator | |
930 | end() const | |
931 | { return this->input_argument_list_.end(); } | |
932 | ||
933 | // Return whether the list is empty. | |
934 | bool | |
935 | empty() const | |
936 | { return this->input_argument_list_.empty(); } | |
937 | ||
938 | private: | |
939 | Input_argument_list input_argument_list_; | |
940 | bool in_group_; | |
941 | }; | |
942 | ||
ee1fe73e ILT |
943 | |
944 | // All the information read from the command line. These are held in | |
945 | // three separate structs: one to hold the options (--foo), one to | |
946 | // hold the filenames listed on the commandline, and one to hold | |
947 | // linker script information. This third is not a subset of the other | |
948 | // two because linker scripts can be specified either as options (via | |
949 | // -T) or as a file. | |
bae7f79e ILT |
950 | |
951 | class Command_line | |
952 | { | |
953 | public: | |
ead1e424 ILT |
954 | typedef Input_arguments::const_iterator const_iterator; |
955 | ||
a5dc0706 | 956 | Command_line(); |
bae7f79e ILT |
957 | |
958 | // Process the command line options. This will exit with an | |
959 | // appropriate error message if an unrecognized option is seen. | |
960 | void | |
ee1fe73e | 961 | process(int argc, const char** argv); |
bae7f79e | 962 | |
a0451b38 | 963 | // Process one command-line option. This takes the index of argv to |
ee1fe73e ILT |
964 | // process, and returns the index for the next option. no_more_options |
965 | // is set to true if argv[i] is "--". | |
61ba1cf9 | 966 | int |
ee1fe73e ILT |
967 | process_one_option(int argc, const char** argv, int i, |
968 | bool* no_more_options); | |
3c2fafa5 | 969 | |
61ba1cf9 | 970 | // Get the general options. |
bae7f79e ILT |
971 | const General_options& |
972 | options() const | |
973 | { return this->options_; } | |
974 | ||
3c2fafa5 ILT |
975 | // Get the position dependent options. |
976 | const Position_dependent_options& | |
977 | position_dependent_options() const | |
978 | { return this->position_options_; } | |
979 | ||
a5dc0706 ILT |
980 | // Get the linker-script options. |
981 | Script_options& | |
e5756efb | 982 | script_options() |
a5dc0706 | 983 | { return this->script_options_; } |
e5756efb | 984 | |
a5dc0706 ILT |
985 | // Get the version-script options: a convenience routine. |
986 | const Version_script_info& | |
987 | version_script() const | |
988 | { return *this->script_options_.version_script_info(); } | |
e5756efb | 989 | |
ee1fe73e ILT |
990 | // Get the input files. |
991 | Input_arguments& | |
992 | inputs() | |
993 | { return this->inputs_; } | |
994 | ||
fe9a4c12 ILT |
995 | // The number of input files. |
996 | int | |
997 | number_of_input_files() const | |
998 | { return this->inputs_.size(); } | |
999 | ||
ead1e424 ILT |
1000 | // Iterators to iterate over the list of input files. |
1001 | ||
1002 | const_iterator | |
1003 | begin() const | |
1004 | { return this->inputs_.begin(); } | |
1005 | ||
1006 | const_iterator | |
1007 | end() const | |
1008 | { return this->inputs_.end(); } | |
bae7f79e ILT |
1009 | |
1010 | private: | |
ead1e424 ILT |
1011 | Command_line(const Command_line&); |
1012 | Command_line& operator=(const Command_line&); | |
1013 | ||
bae7f79e ILT |
1014 | General_options options_; |
1015 | Position_dependent_options position_options_; | |
a5dc0706 | 1016 | Script_options script_options_; |
ead1e424 | 1017 | Input_arguments inputs_; |
bae7f79e ILT |
1018 | }; |
1019 | ||
1020 | } // End namespace gold. | |
1021 | ||
1022 | #endif // !defined(GOLD_OPTIONS_H) |