| 1 | // options.h -- handle command line options for gold -*- C++ -*- |
| 2 | |
| 3 | // Copyright 2006, 2007, 2008 Free Software Foundation, Inc. |
| 4 | // Written by Ian Lance Taylor <iant@google.com>. |
| 5 | |
| 6 | // This file is part of gold. |
| 7 | |
| 8 | // This program is free software; you can redistribute it and/or modify |
| 9 | // it under the terms of the GNU General Public License as published by |
| 10 | // the Free Software Foundation; either version 3 of the License, or |
| 11 | // (at your option) any later version. |
| 12 | |
| 13 | // This program is distributed in the hope that it will be useful, |
| 14 | // but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | // GNU General Public License for more details. |
| 17 | |
| 18 | // You should have received a copy of the GNU General Public License |
| 19 | // along with this program; if not, write to the Free Software |
| 20 | // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, |
| 21 | // MA 02110-1301, USA. |
| 22 | |
| 23 | // General_options (from Command_line::options()) |
| 24 | // All the options (a.k.a. command-line flags) |
| 25 | // Input_argument (from Command_line::inputs()) |
| 26 | // The list of input files, including -l options. |
| 27 | // Command_line |
| 28 | // Everything we get from the command line -- the General_options |
| 29 | // plus the Input_arguments. |
| 30 | // |
| 31 | // There are also some smaller classes, such as |
| 32 | // Position_dependent_options which hold a subset of General_options |
| 33 | // that change as options are parsed (as opposed to the usual behavior |
| 34 | // of the last instance of that option specified on the commandline wins). |
| 35 | |
| 36 | #ifndef GOLD_OPTIONS_H |
| 37 | #define GOLD_OPTIONS_H |
| 38 | |
| 39 | #include <cstdlib> |
| 40 | #include <cstring> |
| 41 | #include <list> |
| 42 | #include <string> |
| 43 | #include <vector> |
| 44 | |
| 45 | #include "elfcpp.h" |
| 46 | #include "script.h" |
| 47 | |
| 48 | namespace gold |
| 49 | { |
| 50 | |
| 51 | class Command_line; |
| 52 | class General_options; |
| 53 | class Search_directory; |
| 54 | class Input_file_group; |
| 55 | class Position_dependent_options; |
| 56 | class Target; |
| 57 | class Plugin_manager; |
| 58 | |
| 59 | // The nested namespace is to contain all the global variables and |
| 60 | // structs that need to be defined in the .h file, but do not need to |
| 61 | // be used outside this class. |
| 62 | namespace options |
| 63 | { |
| 64 | typedef std::vector<Search_directory> Dir_list; |
| 65 | typedef Unordered_set<std::string> String_set; |
| 66 | |
| 67 | // These routines convert from a string option to various types. |
| 68 | // Each gives a fatal error if it cannot parse the argument. |
| 69 | |
| 70 | extern void |
| 71 | parse_bool(const char* option_name, const char* arg, bool* retval); |
| 72 | |
| 73 | extern void |
| 74 | parse_uint(const char* option_name, const char* arg, int* retval); |
| 75 | |
| 76 | extern void |
| 77 | parse_uint64(const char* option_name, const char* arg, uint64_t* retval); |
| 78 | |
| 79 | extern void |
| 80 | parse_double(const char* option_name, const char* arg, double* retval); |
| 81 | |
| 82 | extern void |
| 83 | parse_string(const char* option_name, const char* arg, const char** retval); |
| 84 | |
| 85 | extern void |
| 86 | parse_optional_string(const char* option_name, const char* arg, |
| 87 | const char** retval); |
| 88 | |
| 89 | extern void |
| 90 | parse_dirlist(const char* option_name, const char* arg, Dir_list* retval); |
| 91 | |
| 92 | extern void |
| 93 | parse_set(const char* option_name, const char* arg, String_set* retval); |
| 94 | |
| 95 | extern void |
| 96 | parse_choices(const char* option_name, const char* arg, const char** retval, |
| 97 | const char* choices[], int num_choices); |
| 98 | |
| 99 | struct Struct_var; |
| 100 | |
| 101 | // Most options have both a shortname (one letter) and a longname. |
| 102 | // This enum controls how many dashes are expected for longname access |
| 103 | // -- shortnames always use one dash. Most longnames will accept |
| 104 | // either one dash or two; the only difference between ONE_DASH and |
| 105 | // TWO_DASHES is how we print the option in --help. However, some |
| 106 | // longnames require two dashes, and some require only one. The |
| 107 | // special value DASH_Z means that the option is preceded by "-z". |
| 108 | enum Dashes |
| 109 | { |
| 110 | ONE_DASH, TWO_DASHES, EXACTLY_ONE_DASH, EXACTLY_TWO_DASHES, DASH_Z |
| 111 | }; |
| 112 | |
| 113 | // LONGNAME is the long-name of the option with dashes converted to |
| 114 | // underscores, or else the short-name if the option has no long-name. |
| 115 | // It is never the empty string. |
| 116 | // DASHES is an instance of the Dashes enum: ONE_DASH, TWO_DASHES, etc. |
| 117 | // SHORTNAME is the short-name of the option, as a char, or '\0' if the |
| 118 | // option has no short-name. If the option has no long-name, you |
| 119 | // should specify the short-name in *both* VARNAME and here. |
| 120 | // DEFAULT_VALUE is the value of the option if not specified on the |
| 121 | // commandline, as a string. |
| 122 | // HELPSTRING is the descriptive text used with the option via --help |
| 123 | // HELPARG is how you define the argument to the option. |
| 124 | // --help output is "-shortname HELPARG, --longname HELPARG: HELPSTRING" |
| 125 | // HELPARG should be NULL iff the option is a bool and takes no arg. |
| 126 | // OPTIONAL_ARG is true if this option takes an optional argument. An |
| 127 | // optional argument must be specifid as --OPTION=VALUE, not |
| 128 | // --OPTION VALUE. |
| 129 | // READER provides parse_to_value, which is a function that will convert |
| 130 | // a char* argument into the proper type and store it in some variable. |
| 131 | // A One_option struct initializes itself with the global list of options |
| 132 | // at constructor time, so be careful making one of these. |
| 133 | struct One_option |
| 134 | { |
| 135 | std::string longname; |
| 136 | Dashes dashes; |
| 137 | char shortname; |
| 138 | const char* default_value; |
| 139 | const char* helpstring; |
| 140 | const char* helparg; |
| 141 | bool optional_arg; |
| 142 | Struct_var* reader; |
| 143 | |
| 144 | One_option(const char* ln, Dashes d, char sn, const char* dv, |
| 145 | const char* hs, const char* ha, bool oa, Struct_var* r) |
| 146 | : longname(ln), dashes(d), shortname(sn), default_value(dv ? dv : ""), |
| 147 | helpstring(hs), helparg(ha), optional_arg(oa), reader(r) |
| 148 | { |
| 149 | // In longname, we convert all underscores to dashes, since GNU |
| 150 | // style uses dashes in option names. longname is likely to have |
| 151 | // underscores in it because it's also used to declare a C++ |
| 152 | // function. |
| 153 | const char* pos = strchr(this->longname.c_str(), '_'); |
| 154 | for (; pos; pos = strchr(pos, '_')) |
| 155 | this->longname[pos - this->longname.c_str()] = '-'; |
| 156 | |
| 157 | // We only register ourselves if our helpstring is not NULL. This |
| 158 | // is to support the "no-VAR" boolean variables, which we |
| 159 | // conditionally turn on by defining "no-VAR" help text. |
| 160 | if (this->helpstring) |
| 161 | this->register_option(); |
| 162 | } |
| 163 | |
| 164 | // This option takes an argument iff helparg is not NULL. |
| 165 | bool |
| 166 | takes_argument() const |
| 167 | { return this->helparg != NULL; } |
| 168 | |
| 169 | // Whether the argument is optional. |
| 170 | bool |
| 171 | takes_optional_argument() const |
| 172 | { return this->optional_arg; } |
| 173 | |
| 174 | // Register this option with the global list of options. |
| 175 | void |
| 176 | register_option(); |
| 177 | |
| 178 | // Print this option to stdout (used with --help). |
| 179 | void |
| 180 | print() const; |
| 181 | }; |
| 182 | |
| 183 | // All options have a Struct_##varname that inherits from this and |
| 184 | // actually implements parse_to_value for that option. |
| 185 | struct Struct_var |
| 186 | { |
| 187 | // OPTION: the name of the option as specified on the commandline, |
| 188 | // including leading dashes, and any text following the option: |
| 189 | // "-O", "--defsym=mysym=0x1000", etc. |
| 190 | // ARG: the arg associated with this option, or NULL if the option |
| 191 | // takes no argument: "2", "mysym=0x1000", etc. |
| 192 | // CMDLINE: the global Command_line object. Used by DEFINE_special. |
| 193 | // OPTIONS: the global General_options object. Used by DEFINE_special. |
| 194 | virtual void |
| 195 | parse_to_value(const char* option, const char* arg, |
| 196 | Command_line* cmdline, General_options* options) = 0; |
| 197 | virtual |
| 198 | ~Struct_var() // To make gcc happy. |
| 199 | { } |
| 200 | }; |
| 201 | |
| 202 | // This is for "special" options that aren't of any predefined type. |
| 203 | struct Struct_special : public Struct_var |
| 204 | { |
| 205 | // If you change this, change the parse-fn in DEFINE_special as well. |
| 206 | typedef void (General_options::*Parse_function)(const char*, const char*, |
| 207 | Command_line*); |
| 208 | Struct_special(const char* varname, Dashes dashes, char shortname, |
| 209 | Parse_function parse_function, |
| 210 | const char* helpstring, const char* helparg) |
| 211 | : option(varname, dashes, shortname, "", helpstring, helparg, false, this), |
| 212 | parse(parse_function) |
| 213 | { } |
| 214 | |
| 215 | void parse_to_value(const char* option, const char* arg, |
| 216 | Command_line* cmdline, General_options* options) |
| 217 | { (options->*(this->parse))(option, arg, cmdline); } |
| 218 | |
| 219 | One_option option; |
| 220 | Parse_function parse; |
| 221 | }; |
| 222 | |
| 223 | } // End namespace options. |
| 224 | |
| 225 | |
| 226 | // These are helper macros use by DEFINE_uint64/etc below. |
| 227 | // This macro is used inside the General_options_ class, so defines |
| 228 | // var() and set_var() as General_options methods. Arguments as are |
| 229 | // for the constructor for One_option. param_type__ is the same as |
| 230 | // type__ for built-in types, and "const type__ &" otherwise. |
| 231 | #define DEFINE_var(varname__, dashes__, shortname__, default_value__, \ |
| 232 | default_value_as_string__, helpstring__, helparg__, \ |
| 233 | optional_arg__, type__, param_type__, parse_fn__) \ |
| 234 | public: \ |
| 235 | param_type__ \ |
| 236 | varname__() const \ |
| 237 | { return this->varname__##_.value; } \ |
| 238 | \ |
| 239 | bool \ |
| 240 | user_set_##varname__() const \ |
| 241 | { return this->varname__##_.user_set_via_option; } \ |
| 242 | \ |
| 243 | void \ |
| 244 | set_user_set_##varname__() \ |
| 245 | { this->varname__##_.user_set_via_option = true; } \ |
| 246 | \ |
| 247 | private: \ |
| 248 | struct Struct_##varname__ : public options::Struct_var \ |
| 249 | { \ |
| 250 | Struct_##varname__() \ |
| 251 | : option(#varname__, dashes__, shortname__, default_value_as_string__, \ |
| 252 | helpstring__, helparg__, optional_arg__, this), \ |
| 253 | user_set_via_option(false), value(default_value__) \ |
| 254 | { } \ |
| 255 | \ |
| 256 | void \ |
| 257 | parse_to_value(const char* option_name, const char* arg, \ |
| 258 | Command_line*, General_options*) \ |
| 259 | { \ |
| 260 | parse_fn__(option_name, arg, &this->value); \ |
| 261 | this->user_set_via_option = true; \ |
| 262 | } \ |
| 263 | \ |
| 264 | options::One_option option; \ |
| 265 | bool user_set_via_option; \ |
| 266 | type__ value; \ |
| 267 | }; \ |
| 268 | Struct_##varname__ varname__##_; \ |
| 269 | void \ |
| 270 | set_##varname__(param_type__ value) \ |
| 271 | { this->varname__##_.value = value; } |
| 272 | |
| 273 | // These macros allow for easy addition of a new commandline option. |
| 274 | |
| 275 | // If no_helpstring__ is not NULL, then in addition to creating |
| 276 | // VARNAME, we also create an option called no-VARNAME (or, for a -z |
| 277 | // option, noVARNAME). |
| 278 | #define DEFINE_bool(varname__, dashes__, shortname__, default_value__, \ |
| 279 | helpstring__, no_helpstring__) \ |
| 280 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ |
| 281 | default_value__ ? "true" : "false", helpstring__, NULL, \ |
| 282 | false, bool, bool, options::parse_bool) \ |
| 283 | struct Struct_no_##varname__ : public options::Struct_var \ |
| 284 | { \ |
| 285 | Struct_no_##varname__() : option((dashes__ == options::DASH_Z \ |
| 286 | ? "no" #varname__ \ |
| 287 | : "no-" #varname__), \ |
| 288 | dashes__, '\0', \ |
| 289 | default_value__ ? "false" : "true", \ |
| 290 | no_helpstring__, NULL, false, this) \ |
| 291 | { } \ |
| 292 | \ |
| 293 | void \ |
| 294 | parse_to_value(const char*, const char*, \ |
| 295 | Command_line*, General_options* options) \ |
| 296 | { options->set_##varname__(false); } \ |
| 297 | \ |
| 298 | options::One_option option; \ |
| 299 | }; \ |
| 300 | Struct_no_##varname__ no_##varname__##_initializer_ |
| 301 | |
| 302 | #define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \ |
| 303 | helpstring__, no_helpstring__) \ |
| 304 | DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \ |
| 305 | default_value__ ? "true" : "false", helpstring__, NULL, \ |
| 306 | false, bool, bool, options::parse_bool) \ |
| 307 | struct Struct_disable_##varname__ : public options::Struct_var \ |
| 308 | { \ |
| 309 | Struct_disable_##varname__() : option("disable-" #varname__, \ |
| 310 | dashes__, '\0', \ |
| 311 | default_value__ ? "false" : "true", \ |
| 312 | no_helpstring__, NULL, false, this) \ |
| 313 | { } \ |
| 314 | \ |
| 315 | void \ |
| 316 | parse_to_value(const char*, const char*, \ |
| 317 | Command_line*, General_options* options) \ |
| 318 | { options->set_enable_##varname__(false); } \ |
| 319 | \ |
| 320 | options::One_option option; \ |
| 321 | }; \ |
| 322 | Struct_disable_##varname__ disable_##varname__##_initializer_ |
| 323 | |
| 324 | #define DEFINE_uint(varname__, dashes__, shortname__, default_value__, \ |
| 325 | helpstring__, helparg__) \ |
| 326 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ |
| 327 | #default_value__, helpstring__, helparg__, false, \ |
| 328 | int, int, options::parse_uint) |
| 329 | |
| 330 | #define DEFINE_uint64(varname__, dashes__, shortname__, default_value__, \ |
| 331 | helpstring__, helparg__) \ |
| 332 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ |
| 333 | #default_value__, helpstring__, helparg__, false, \ |
| 334 | uint64_t, uint64_t, options::parse_uint64) |
| 335 | |
| 336 | #define DEFINE_double(varname__, dashes__, shortname__, default_value__, \ |
| 337 | helpstring__, helparg__) \ |
| 338 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ |
| 339 | #default_value__, helpstring__, helparg__, false, \ |
| 340 | double, double, options::parse_double) |
| 341 | |
| 342 | #define DEFINE_string(varname__, dashes__, shortname__, default_value__, \ |
| 343 | helpstring__, helparg__) \ |
| 344 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ |
| 345 | default_value__, helpstring__, helparg__, false, \ |
| 346 | const char*, const char*, options::parse_string) |
| 347 | |
| 348 | // This is like DEFINE_string, but we convert each occurrence to a |
| 349 | // Search_directory and store it in a vector. Thus we also have the |
| 350 | // add_to_VARNAME() method, to append to the vector. |
| 351 | #define DEFINE_dirlist(varname__, dashes__, shortname__, \ |
| 352 | helpstring__, helparg__) \ |
| 353 | DEFINE_var(varname__, dashes__, shortname__, , \ |
| 354 | "", helpstring__, helparg__, false, options::Dir_list, \ |
| 355 | const options::Dir_list&, options::parse_dirlist) \ |
| 356 | void \ |
| 357 | add_to_##varname__(const char* new_value) \ |
| 358 | { options::parse_dirlist(NULL, new_value, &this->varname__##_.value); } \ |
| 359 | void \ |
| 360 | add_search_directory_to_##varname__(const Search_directory& dir) \ |
| 361 | { this->varname__##_.value.push_back(dir); } |
| 362 | |
| 363 | // This is like DEFINE_string, but we store a set of strings. |
| 364 | #define DEFINE_set(varname__, dashes__, shortname__, \ |
| 365 | helpstring__, helparg__) \ |
| 366 | DEFINE_var(varname__, dashes__, shortname__, , \ |
| 367 | "", helpstring__, helparg__, false, options::String_set, \ |
| 368 | const options::String_set&, options::parse_set) \ |
| 369 | public: \ |
| 370 | bool \ |
| 371 | any_##varname__() const \ |
| 372 | { return !this->varname__##_.value.empty(); } \ |
| 373 | \ |
| 374 | bool \ |
| 375 | is_##varname__(const char* symbol) const \ |
| 376 | { \ |
| 377 | return (!this->varname__##_.value.empty() \ |
| 378 | && (this->varname__##_.value.find(std::string(symbol)) \ |
| 379 | != this->varname__##_.value.end())); \ |
| 380 | } \ |
| 381 | \ |
| 382 | options::String_set::const_iterator \ |
| 383 | varname__##_begin() const \ |
| 384 | { return this->varname__##_.value.begin(); } \ |
| 385 | \ |
| 386 | options::String_set::const_iterator \ |
| 387 | varname__##_end() const \ |
| 388 | { return this->varname__##_.value.end(); } |
| 389 | |
| 390 | // When you have a list of possible values (expressed as string) |
| 391 | // After helparg__ should come an initializer list, like |
| 392 | // {"foo", "bar", "baz"} |
| 393 | #define DEFINE_enum(varname__, dashes__, shortname__, default_value__, \ |
| 394 | helpstring__, helparg__, ...) \ |
| 395 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ |
| 396 | default_value__, helpstring__, helparg__, false, \ |
| 397 | const char*, const char*, parse_choices_##varname__) \ |
| 398 | private: \ |
| 399 | static void parse_choices_##varname__(const char* option_name, \ |
| 400 | const char* arg, \ |
| 401 | const char** retval) { \ |
| 402 | const char* choices[] = __VA_ARGS__; \ |
| 403 | options::parse_choices(option_name, arg, retval, \ |
| 404 | choices, sizeof(choices) / sizeof(*choices)); \ |
| 405 | } |
| 406 | |
| 407 | // This is like DEFINE_bool, but VARNAME is the name of a different |
| 408 | // option. This option becomes an alias for that one. INVERT is true |
| 409 | // if this option is an inversion of the other one. |
| 410 | #define DEFINE_bool_alias(option__, varname__, dashes__, shortname__, \ |
| 411 | helpstring__, no_helpstring__, invert__) \ |
| 412 | private: \ |
| 413 | struct Struct_##option__ : public options::Struct_var \ |
| 414 | { \ |
| 415 | Struct_##option__() \ |
| 416 | : option(#option__, dashes__, shortname__, "", helpstring__, \ |
| 417 | NULL, false, this) \ |
| 418 | { } \ |
| 419 | \ |
| 420 | void \ |
| 421 | parse_to_value(const char*, const char*, \ |
| 422 | Command_line*, General_options* options) \ |
| 423 | { \ |
| 424 | options->set_##varname__(!invert__); \ |
| 425 | options->set_user_set_##varname__(); \ |
| 426 | } \ |
| 427 | \ |
| 428 | options::One_option option; \ |
| 429 | }; \ |
| 430 | Struct_##option__ option__##_; \ |
| 431 | \ |
| 432 | struct Struct_no_##option__ : public options::Struct_var \ |
| 433 | { \ |
| 434 | Struct_no_##option__() \ |
| 435 | : option((dashes__ == options::DASH_Z \ |
| 436 | ? "no" #option__ \ |
| 437 | : "no-" #option__), \ |
| 438 | dashes__, '\0', "", no_helpstring__, \ |
| 439 | NULL, false, this) \ |
| 440 | { } \ |
| 441 | \ |
| 442 | void \ |
| 443 | parse_to_value(const char*, const char*, \ |
| 444 | Command_line*, General_options* options) \ |
| 445 | { \ |
| 446 | options->set_##varname__(invert__); \ |
| 447 | options->set_user_set_##varname__(); \ |
| 448 | } \ |
| 449 | \ |
| 450 | options::One_option option; \ |
| 451 | }; \ |
| 452 | Struct_no_##option__ no_##option__##_initializer_ |
| 453 | |
| 454 | // This is used for non-standard flags. It defines no functions; it |
| 455 | // just calls General_options::parse_VARNAME whenever the flag is |
| 456 | // seen. We declare parse_VARNAME as a static member of |
| 457 | // General_options; you are responsible for defining it there. |
| 458 | // helparg__ should be NULL iff this special-option is a boolean. |
| 459 | #define DEFINE_special(varname__, dashes__, shortname__, \ |
| 460 | helpstring__, helparg__) \ |
| 461 | private: \ |
| 462 | void parse_##varname__(const char* option, const char* arg, \ |
| 463 | Command_line* inputs); \ |
| 464 | struct Struct_##varname__ : public options::Struct_special \ |
| 465 | { \ |
| 466 | Struct_##varname__() \ |
| 467 | : options::Struct_special(#varname__, dashes__, shortname__, \ |
| 468 | &General_options::parse_##varname__, \ |
| 469 | helpstring__, helparg__) \ |
| 470 | { } \ |
| 471 | }; \ |
| 472 | Struct_##varname__ varname__##_initializer_ |
| 473 | |
| 474 | // An option that takes an optional string argument. If the option is |
| 475 | // used with no argument, the value will be the default, and |
| 476 | // user_set_via_option will be true. |
| 477 | #define DEFINE_optional_string(varname__, dashes__, shortname__, \ |
| 478 | default_value__, \ |
| 479 | helpstring__, helparg__) \ |
| 480 | DEFINE_var(varname__, dashes__, shortname__, default_value__, \ |
| 481 | default_value__, helpstring__, helparg__, true, \ |
| 482 | const char*, const char*, options::parse_optional_string) |
| 483 | |
| 484 | // A directory to search. For each directory we record whether it is |
| 485 | // in the sysroot. We need to know this so that, if a linker script |
| 486 | // is found within the sysroot, we will apply the sysroot to any files |
| 487 | // named by that script. |
| 488 | |
| 489 | class Search_directory |
| 490 | { |
| 491 | public: |
| 492 | // We need a default constructor because we put this in a |
| 493 | // std::vector. |
| 494 | Search_directory() |
| 495 | : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false) |
| 496 | { } |
| 497 | |
| 498 | // This is the usual constructor. |
| 499 | Search_directory(const char* name, bool put_in_sysroot) |
| 500 | : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false) |
| 501 | { |
| 502 | if (this->name_.empty()) |
| 503 | this->name_ = "."; |
| 504 | } |
| 505 | |
| 506 | // This is called if we have a sysroot. The sysroot is prefixed to |
| 507 | // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is |
| 508 | // set to true for any enries which are in the sysroot (this will |
| 509 | // naturally include any entries for which put_in_sysroot_ is true). |
| 510 | // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of |
| 511 | // passing SYSROOT to lrealpath. |
| 512 | void |
| 513 | add_sysroot(const char* sysroot, const char* canonical_sysroot); |
| 514 | |
| 515 | // Get the directory name. |
| 516 | const std::string& |
| 517 | name() const |
| 518 | { return this->name_; } |
| 519 | |
| 520 | // Return whether this directory is in the sysroot. |
| 521 | bool |
| 522 | is_in_sysroot() const |
| 523 | { return this->is_in_sysroot_; } |
| 524 | |
| 525 | private: |
| 526 | std::string name_; |
| 527 | bool put_in_sysroot_; |
| 528 | bool is_in_sysroot_; |
| 529 | }; |
| 530 | |
| 531 | class General_options |
| 532 | { |
| 533 | private: |
| 534 | // NOTE: For every option that you add here, also consider if you |
| 535 | // should add it to Position_dependent_options. |
| 536 | DEFINE_special(help, options::TWO_DASHES, '\0', |
| 537 | N_("Report usage information"), NULL); |
| 538 | DEFINE_special(version, options::TWO_DASHES, 'v', |
| 539 | N_("Report version information"), NULL); |
| 540 | DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0', |
| 541 | N_("Report version and target information"), NULL); |
| 542 | |
| 543 | // These options are sorted approximately so that for each letter in |
| 544 | // the alphabet, we show the option whose shortname is that letter |
| 545 | // (if any) and then every longname that starts with that letter (in |
| 546 | // alphabetical order). For both, lowercase sorts before uppercase. |
| 547 | // The -z options come last. |
| 548 | |
| 549 | DEFINE_bool(allow_shlib_undefined, options::TWO_DASHES, '\0', false, |
| 550 | N_("Allow unresolved references in shared libraries"), |
| 551 | N_("Do not allow unresolved references in shared libraries")); |
| 552 | |
| 553 | DEFINE_bool(as_needed, options::TWO_DASHES, '\0', false, |
| 554 | N_("Only set DT_NEEDED for dynamic libs if used"), |
| 555 | N_("Always DT_NEEDED for dynamic libs")); |
| 556 | |
| 557 | // This should really be an "enum", but it's too easy for folks to |
| 558 | // forget to update the list as they add new targets. So we just |
| 559 | // accept any string. We'll fail later (when the string is parsed), |
| 560 | // if the target isn't actually supported. |
| 561 | DEFINE_string(format, options::TWO_DASHES, 'b', "elf", |
| 562 | N_("Set input format"), ("[elf,binary]")); |
| 563 | |
| 564 | DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true, |
| 565 | N_("-l searches for shared libraries"), NULL); |
| 566 | DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0', |
| 567 | N_("-l does not search for shared libraries"), NULL, |
| 568 | true); |
| 569 | |
| 570 | DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false, |
| 571 | N_("Bind defined symbols locally"), NULL); |
| 572 | |
| 573 | DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false, |
| 574 | N_("Bind defined function symbols locally"), NULL); |
| 575 | |
| 576 | DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1", |
| 577 | N_("Generate build ID note"), |
| 578 | N_("[=STYLE]")); |
| 579 | |
| 580 | DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true, |
| 581 | N_("Check segment addresses for overlaps (default)"), |
| 582 | N_("Do not check segment addresses for overlaps")); |
| 583 | |
| 584 | #ifdef HAVE_ZLIB_H |
| 585 | DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none", |
| 586 | N_("Compress .debug_* sections in the output file"), |
| 587 | ("[none,zlib]"), |
| 588 | {"none", "zlib"}); |
| 589 | #else |
| 590 | DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none", |
| 591 | N_("Compress .debug_* sections in the output file"), |
| 592 | N_("[none]"), |
| 593 | {"none"}); |
| 594 | #endif |
| 595 | |
| 596 | DEFINE_bool(define_common, options::TWO_DASHES, 'd', false, |
| 597 | N_("Define common symbols"), |
| 598 | N_("Do not define common symbols")); |
| 599 | DEFINE_bool(dc, options::ONE_DASH, '\0', false, |
| 600 | N_("Alias for -d"), NULL); |
| 601 | DEFINE_bool(dp, options::ONE_DASH, '\0', false, |
| 602 | N_("Alias for -d"), NULL); |
| 603 | |
| 604 | DEFINE_string(debug, options::TWO_DASHES, '\0', "", |
| 605 | N_("Turn on debugging"), |
| 606 | N_("[all,files,script,task][,...]")); |
| 607 | |
| 608 | DEFINE_special(defsym, options::TWO_DASHES, '\0', |
| 609 | N_("Define a symbol"), N_("SYMBOL=EXPRESSION")); |
| 610 | |
| 611 | DEFINE_optional_string(demangle, options::TWO_DASHES, '\0', NULL, |
| 612 | N_("Demangle C++ symbols in log messages"), |
| 613 | N_("[=STYLE]")); |
| 614 | |
| 615 | DEFINE_bool(no_demangle, options::TWO_DASHES, '\0', false, |
| 616 | N_("Do not demangle C++ symbols in log messages"), |
| 617 | NULL); |
| 618 | |
| 619 | DEFINE_bool(detect_odr_violations, options::TWO_DASHES, '\0', false, |
| 620 | N_("Try to detect violations of the One Definition Rule"), |
| 621 | NULL); |
| 622 | |
| 623 | DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false, |
| 624 | N_("Add data symbols to dynamic symbols"), NULL); |
| 625 | |
| 626 | DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false, |
| 627 | N_("Add C++ operator new/delete to dynamic symbols"), NULL); |
| 628 | |
| 629 | DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false, |
| 630 | N_("Add C++ typeinfo to dynamic symbols"), NULL); |
| 631 | |
| 632 | DEFINE_special(dynamic_list, options::TWO_DASHES, '\0', |
| 633 | N_("Read a list of dynamic symbols"), N_("FILE")); |
| 634 | |
| 635 | DEFINE_string(entry, options::TWO_DASHES, 'e', NULL, |
| 636 | N_("Set program start address"), N_("ADDRESS")); |
| 637 | |
| 638 | DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false, |
| 639 | N_("Export all dynamic symbols"), NULL); |
| 640 | |
| 641 | DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false, |
| 642 | N_("Create exception frame header"), NULL); |
| 643 | |
| 644 | DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false, |
| 645 | N_("Treat warnings as errors"), |
| 646 | N_("Do not treat warnings as errors")); |
| 647 | |
| 648 | DEFINE_string(soname, options::ONE_DASH, 'h', NULL, |
| 649 | N_("Set shared library name"), N_("FILENAME")); |
| 650 | |
| 651 | DEFINE_double(hash_bucket_empty_fraction, options::TWO_DASHES, '\0', 0.0, |
| 652 | N_("Min fraction of empty buckets in dynamic hash"), |
| 653 | N_("FRACTION")); |
| 654 | |
| 655 | DEFINE_enum(hash_style, options::TWO_DASHES, '\0', "sysv", |
| 656 | N_("Dynamic hash style"), N_("[sysv,gnu,both]"), |
| 657 | {"sysv", "gnu", "both"}); |
| 658 | |
| 659 | DEFINE_string(dynamic_linker, options::TWO_DASHES, 'I', NULL, |
| 660 | N_("Set dynamic linker path"), N_("PROGRAM")); |
| 661 | |
| 662 | DEFINE_special(just_symbols, options::TWO_DASHES, '\0', |
| 663 | N_("Read only symbol values from FILE"), N_("FILE")); |
| 664 | |
| 665 | DEFINE_special(library, options::TWO_DASHES, 'l', |
| 666 | N_("Search for library LIBNAME"), N_("LIBNAME")); |
| 667 | |
| 668 | DEFINE_dirlist(library_path, options::TWO_DASHES, 'L', |
| 669 | N_("Add directory to search path"), N_("DIR")); |
| 670 | |
| 671 | DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "", |
| 672 | N_("Ignored for compatibility"), N_("EMULATION")); |
| 673 | |
| 674 | DEFINE_bool(print_map, options::TWO_DASHES, 'M', false, |
| 675 | N_("Write map file on standard output"), NULL); |
| 676 | DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"), |
| 677 | N_("MAPFILENAME")); |
| 678 | |
| 679 | DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false, |
| 680 | N_("Do not page align data"), NULL); |
| 681 | DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false, |
| 682 | N_("Do not page align data, do not make text readonly"), |
| 683 | N_("Page align data, make text readonly")); |
| 684 | |
| 685 | DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false, |
| 686 | N_("Enable use of DT_RUNPATH and DT_FLAGS"), |
| 687 | N_("Disable use of DT_RUNPATH and DT_FLAGS")); |
| 688 | |
| 689 | DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false, |
| 690 | N_("Create an output file even if errors occur"), NULL); |
| 691 | |
| 692 | DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0', |
| 693 | N_("Report undefined symbols (even with --shared)"), |
| 694 | NULL, false); |
| 695 | |
| 696 | DEFINE_string(output, options::TWO_DASHES, 'o', "a.out", |
| 697 | N_("Set output file name"), N_("FILE")); |
| 698 | |
| 699 | DEFINE_uint(optimize, options::EXACTLY_ONE_DASH, 'O', 0, |
| 700 | N_("Optimize output file size"), N_("LEVEL")); |
| 701 | |
| 702 | DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf", |
| 703 | N_("Set output format"), N_("[binary]")); |
| 704 | |
| 705 | #ifdef ENABLE_PLUGINS |
| 706 | DEFINE_special(plugin, options::TWO_DASHES, '\0', |
| 707 | N_("Load a plugin library"), N_("PLUGIN")); |
| 708 | DEFINE_special(plugin_opt, options::TWO_DASHES, '\0', |
| 709 | N_("Pass an option to the plugin"), N_("OPTION")); |
| 710 | #endif |
| 711 | |
| 712 | DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false, |
| 713 | N_("Preread archive symbols when multi-threaded"), NULL); |
| 714 | |
| 715 | DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL, |
| 716 | N_("Print symbols defined and used for each input"), |
| 717 | N_("FILENAME")); |
| 718 | |
| 719 | DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false, |
| 720 | N_("Ignored for SVR4 compatibility"), NULL); |
| 721 | |
| 722 | DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false, |
| 723 | N_("Generate relocations in output"), NULL); |
| 724 | |
| 725 | DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false, |
| 726 | N_("Generate relocatable output"), NULL); |
| 727 | |
| 728 | DEFINE_bool(relax, options::TWO_DASHES, '\0', false, |
| 729 | N_("Relax branches on certain targets"), NULL); |
| 730 | |
| 731 | // -R really means -rpath, but can mean --just-symbols for |
| 732 | // compatibility with GNU ld. -rpath is always -rpath, so we list |
| 733 | // it separately. |
| 734 | DEFINE_special(R, options::EXACTLY_ONE_DASH, 'R', |
| 735 | N_("Add DIR to runtime search path"), N_("DIR")); |
| 736 | |
| 737 | DEFINE_dirlist(rpath, options::ONE_DASH, '\0', |
| 738 | N_("Add DIR to runtime search path"), N_("DIR")); |
| 739 | |
| 740 | DEFINE_dirlist(rpath_link, options::TWO_DASHES, '\0', |
| 741 | N_("Add DIR to link time shared library search path"), |
| 742 | N_("DIR")); |
| 743 | |
| 744 | DEFINE_bool(strip_all, options::TWO_DASHES, 's', false, |
| 745 | N_("Strip all symbols"), NULL); |
| 746 | DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false, |
| 747 | N_("Strip debugging information"), NULL); |
| 748 | DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false, |
| 749 | N_("Emit only debug line number information"), NULL); |
| 750 | DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false, |
| 751 | N_("Strip debug symbols that are unused by gdb " |
| 752 | "(at least versions <= 6.7)"), NULL); |
| 753 | DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true, |
| 754 | N_("Strip LTO intermediate code sections"), NULL); |
| 755 | |
| 756 | DEFINE_bool(shared, options::ONE_DASH, '\0', false, |
| 757 | N_("Generate shared library"), NULL); |
| 758 | |
| 759 | // This is not actually special in any way, but I need to give it |
| 760 | // a non-standard accessor-function name because 'static' is a keyword. |
| 761 | DEFINE_special(static, options::ONE_DASH, '\0', |
| 762 | N_("Do not link against shared libraries"), NULL); |
| 763 | |
| 764 | DEFINE_bool(stats, options::TWO_DASHES, '\0', false, |
| 765 | N_("Print resource usage statistics"), NULL); |
| 766 | |
| 767 | DEFINE_string(sysroot, options::TWO_DASHES, '\0', "", |
| 768 | N_("Set target system root directory"), N_("DIR")); |
| 769 | |
| 770 | DEFINE_bool(trace, options::TWO_DASHES, 't', false, |
| 771 | N_("Print the name of each input file"), NULL); |
| 772 | |
| 773 | DEFINE_special(script, options::TWO_DASHES, 'T', |
| 774 | N_("Read linker script"), N_("FILE")); |
| 775 | |
| 776 | DEFINE_bool(threads, options::TWO_DASHES, '\0', false, |
| 777 | N_("Run the linker multi-threaded"), |
| 778 | N_("Do not run the linker multi-threaded")); |
| 779 | DEFINE_uint(thread_count, options::TWO_DASHES, '\0', 0, |
| 780 | N_("Number of threads to use"), N_("COUNT")); |
| 781 | DEFINE_uint(thread_count_initial, options::TWO_DASHES, '\0', 0, |
| 782 | N_("Number of threads to use in initial pass"), N_("COUNT")); |
| 783 | DEFINE_uint(thread_count_middle, options::TWO_DASHES, '\0', 0, |
| 784 | N_("Number of threads to use in middle pass"), N_("COUNT")); |
| 785 | DEFINE_uint(thread_count_final, options::TWO_DASHES, '\0', 0, |
| 786 | N_("Number of threads to use in final pass"), N_("COUNT")); |
| 787 | |
| 788 | DEFINE_uint64(Tbss, options::ONE_DASH, '\0', -1U, |
| 789 | N_("Set the address of the bss segment"), N_("ADDRESS")); |
| 790 | DEFINE_uint64(Tdata, options::ONE_DASH, '\0', -1U, |
| 791 | N_("Set the address of the data segment"), N_("ADDRESS")); |
| 792 | DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U, |
| 793 | N_("Set the address of the text segment"), N_("ADDRESS")); |
| 794 | |
| 795 | DEFINE_set(undefined, options::TWO_DASHES, 'u', |
| 796 | N_("Create undefined reference to SYMBOL"), N_("SYMBOL")); |
| 797 | |
| 798 | DEFINE_bool(verbose, options::TWO_DASHES, '\0', false, |
| 799 | N_("Synonym for --debug=files"), NULL); |
| 800 | |
| 801 | DEFINE_special(version_script, options::TWO_DASHES, '\0', |
| 802 | N_("Read version script"), N_("FILE")); |
| 803 | |
| 804 | DEFINE_bool(whole_archive, options::TWO_DASHES, '\0', false, |
| 805 | N_("Include all archive contents"), |
| 806 | N_("Include only needed archive contents")); |
| 807 | |
| 808 | DEFINE_set(wrap, options::TWO_DASHES, '\0', |
| 809 | N_("Use wrapper functions for SYMBOL"), N_("SYMBOL")); |
| 810 | |
| 811 | DEFINE_set(trace_symbol, options::TWO_DASHES, 'y', |
| 812 | N_("Trace references to symbol"), N_("SYMBOL")); |
| 813 | |
| 814 | DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "", |
| 815 | N_("Default search path for Solaris compatibility"), |
| 816 | N_("PATH")); |
| 817 | |
| 818 | DEFINE_special(start_group, options::TWO_DASHES, '(', |
| 819 | N_("Start a library search group"), NULL); |
| 820 | DEFINE_special(end_group, options::TWO_DASHES, ')', |
| 821 | N_("End a library search group"), NULL); |
| 822 | |
| 823 | // The -z options. |
| 824 | |
| 825 | DEFINE_bool(combreloc, options::DASH_Z, '\0', true, |
| 826 | N_("Sort dynamic relocs"), |
| 827 | N_("Do not sort dynamic relocs")); |
| 828 | DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0, |
| 829 | N_("Set common page size to SIZE"), N_("SIZE")); |
| 830 | DEFINE_bool(defs, options::DASH_Z, '\0', false, |
| 831 | N_("Report undefined symbols (even with --shared)"), |
| 832 | NULL); |
| 833 | DEFINE_bool(execstack, options::DASH_Z, '\0', false, |
| 834 | N_("Mark output as requiring executable stack"), NULL); |
| 835 | DEFINE_uint64(max_page_size, options::DASH_Z, '\0', 0, |
| 836 | N_("Set maximum page size to SIZE"), N_("SIZE")); |
| 837 | DEFINE_bool(noexecstack, options::DASH_Z, '\0', false, |
| 838 | N_("Mark output as not requiring executable stack"), NULL); |
| 839 | DEFINE_bool(initfirst, options::DASH_Z, '\0', false, |
| 840 | N_("Mark DSO to be initialized first at runtime"), |
| 841 | NULL); |
| 842 | DEFINE_bool(interpose, options::DASH_Z, '\0', false, |
| 843 | N_("Mark object to interpose all DSOs but executable"), |
| 844 | NULL); |
| 845 | DEFINE_bool(loadfltr, options::DASH_Z, '\0', false, |
| 846 | N_("Mark object requiring immediate process"), |
| 847 | NULL); |
| 848 | DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false, |
| 849 | N_("Mark object not to use default search paths"), |
| 850 | NULL); |
| 851 | DEFINE_bool(nodelete, options::DASH_Z, '\0', false, |
| 852 | N_("Mark DSO non-deletable at runtime"), |
| 853 | NULL); |
| 854 | DEFINE_bool(nodlopen, options::DASH_Z, '\0', false, |
| 855 | N_("Mark DSO not available to dlopen"), |
| 856 | NULL); |
| 857 | DEFINE_bool(nodump, options::DASH_Z, '\0', false, |
| 858 | N_("Mark DSO not available to dldump"), |
| 859 | NULL); |
| 860 | DEFINE_bool(relro, options::DASH_Z, '\0', false, |
| 861 | N_("Where possible mark variables read-only after relocation"), |
| 862 | N_("Don't mark variables read-only after relocation")); |
| 863 | DEFINE_bool(origin, options::DASH_Z, '\0', false, |
| 864 | N_("Mark DSO to indicate that needs immediate $ORIGIN " |
| 865 | "processing at runtime"), NULL); |
| 866 | |
| 867 | public: |
| 868 | typedef options::Dir_list Dir_list; |
| 869 | |
| 870 | General_options(); |
| 871 | |
| 872 | // Does post-processing on flags, making sure they all have |
| 873 | // non-conflicting values. Also converts some flags from their |
| 874 | // "standard" types (string, etc), to another type (enum, DirList), |
| 875 | // which can be accessed via a separate method. Dies if it notices |
| 876 | // any problems. |
| 877 | void finalize(); |
| 878 | |
| 879 | // The macro defines output() (based on --output), but that's a |
| 880 | // generic name. Provide this alternative name, which is clearer. |
| 881 | const char* |
| 882 | output_file_name() const |
| 883 | { return this->output(); } |
| 884 | |
| 885 | // This is not defined via a flag, but combines flags to say whether |
| 886 | // the output is position-independent or not. |
| 887 | bool |
| 888 | output_is_position_independent() const |
| 889 | { return this->shared(); } |
| 890 | |
| 891 | // Return true if the output is something that can be exec()ed, such |
| 892 | // as a static executable, or a position-dependent or |
| 893 | // position-independent executable, but not a dynamic library or an |
| 894 | // object file. |
| 895 | bool |
| 896 | output_is_executable() const |
| 897 | { return !this->shared() || this->output_is_pie(); } |
| 898 | |
| 899 | // Return true if the output is a position-independent executable. |
| 900 | // This is currently not supported. |
| 901 | bool |
| 902 | output_is_pie() const |
| 903 | { return false; } |
| 904 | |
| 905 | // This would normally be static(), and defined automatically, but |
| 906 | // since static is a keyword, we need to come up with our own name. |
| 907 | bool |
| 908 | is_static() const |
| 909 | { return static_; } |
| 910 | |
| 911 | // In addition to getting the input and output formats as a string |
| 912 | // (via format() and oformat()), we also give access as an enum. |
| 913 | enum Object_format |
| 914 | { |
| 915 | // Ordinary ELF. |
| 916 | OBJECT_FORMAT_ELF, |
| 917 | // Straight binary format. |
| 918 | OBJECT_FORMAT_BINARY |
| 919 | }; |
| 920 | |
| 921 | // Note: these functions are not very fast. |
| 922 | Object_format format_enum() const; |
| 923 | Object_format oformat_enum() const; |
| 924 | |
| 925 | // These are the best way to get access to the execstack state, |
| 926 | // not execstack() and noexecstack() which are hard to use properly. |
| 927 | bool |
| 928 | is_execstack_set() const |
| 929 | { return this->execstack_status_ != EXECSTACK_FROM_INPUT; } |
| 930 | |
| 931 | bool |
| 932 | is_stack_executable() const |
| 933 | { return this->execstack_status_ == EXECSTACK_YES; } |
| 934 | |
| 935 | // The --demangle option takes an optional string, and there is also |
| 936 | // a --no-demangle option. This is the best way to decide whether |
| 937 | // to demangle or not. |
| 938 | bool |
| 939 | do_demangle() const |
| 940 | { return this->do_demangle_; } |
| 941 | |
| 942 | // Returns TRUE if any plugin libraries have been loaded. |
| 943 | bool |
| 944 | has_plugins() const |
| 945 | { return this->plugins_ != NULL; } |
| 946 | |
| 947 | // Return a pointer to the plugin manager. |
| 948 | Plugin_manager* |
| 949 | plugins() const |
| 950 | { return this->plugins_; } |
| 951 | |
| 952 | // True iff SYMBOL was found in the file specified by dynamic-list. |
| 953 | bool |
| 954 | in_dynamic_list(const char* symbol) const |
| 955 | { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); } |
| 956 | |
| 957 | private: |
| 958 | // Don't copy this structure. |
| 959 | General_options(const General_options&); |
| 960 | General_options& operator=(const General_options&); |
| 961 | |
| 962 | // Whether to mark the stack as executable. |
| 963 | enum Execstack |
| 964 | { |
| 965 | // Not set on command line. |
| 966 | EXECSTACK_FROM_INPUT, |
| 967 | // Mark the stack as executable (-z execstack). |
| 968 | EXECSTACK_YES, |
| 969 | // Mark the stack as not executable (-z noexecstack). |
| 970 | EXECSTACK_NO |
| 971 | }; |
| 972 | |
| 973 | void |
| 974 | set_execstack_status(Execstack value) |
| 975 | { this->execstack_status_ = value; } |
| 976 | |
| 977 | void |
| 978 | set_do_demangle(bool value) |
| 979 | { this->do_demangle_ = value; } |
| 980 | |
| 981 | void |
| 982 | set_static(bool value) |
| 983 | { static_ = value; } |
| 984 | |
| 985 | // These are called by finalize() to set up the search-path correctly. |
| 986 | void |
| 987 | add_to_library_path_with_sysroot(const char* arg) |
| 988 | { this->add_search_directory_to_library_path(Search_directory(arg, true)); } |
| 989 | |
| 990 | // Apply any sysroot to the directory lists. |
| 991 | void |
| 992 | add_sysroot(); |
| 993 | |
| 994 | // Add a plugin and its arguments to the list of plugins. |
| 995 | void |
| 996 | add_plugin(const char *filename); |
| 997 | |
| 998 | // Add a plugin option. |
| 999 | void |
| 1000 | add_plugin_option(const char* opt); |
| 1001 | |
| 1002 | // Whether to mark the stack as executable. |
| 1003 | Execstack execstack_status_; |
| 1004 | // Whether to do a static link. |
| 1005 | bool static_; |
| 1006 | // Whether to do demangling. |
| 1007 | bool do_demangle_; |
| 1008 | // List of plugin libraries. |
| 1009 | Plugin_manager* plugins_; |
| 1010 | // The parsed output of --dynamic-list files. For convenience in |
| 1011 | // script.cc, we store this as a Script_options object, even though |
| 1012 | // we only use a single Version_tree from it. |
| 1013 | Script_options dynamic_list_; |
| 1014 | }; |
| 1015 | |
| 1016 | // The position-dependent options. We use this to store the state of |
| 1017 | // the commandline at a particular point in parsing for later |
| 1018 | // reference. For instance, if we see "ld --whole-archive foo.a |
| 1019 | // --no-whole-archive," we want to store the whole-archive option with |
| 1020 | // foo.a, so when the time comes to parse foo.a we know we should do |
| 1021 | // it in whole-archive mode. We could store all of General_options, |
| 1022 | // but that's big, so we just pick the subset of flags that actually |
| 1023 | // change in a position-dependent way. |
| 1024 | |
| 1025 | #define DEFINE_posdep(varname__, type__) \ |
| 1026 | public: \ |
| 1027 | type__ \ |
| 1028 | varname__() const \ |
| 1029 | { return this->varname__##_; } \ |
| 1030 | \ |
| 1031 | void \ |
| 1032 | set_##varname__(type__ value) \ |
| 1033 | { this->varname__##_ = value; } \ |
| 1034 | private: \ |
| 1035 | type__ varname__##_ |
| 1036 | |
| 1037 | class Position_dependent_options |
| 1038 | { |
| 1039 | public: |
| 1040 | Position_dependent_options(const General_options& options |
| 1041 | = Position_dependent_options::default_options_) |
| 1042 | { copy_from_options(options); } |
| 1043 | |
| 1044 | void copy_from_options(const General_options& options) |
| 1045 | { |
| 1046 | this->set_as_needed(options.as_needed()); |
| 1047 | this->set_Bdynamic(options.Bdynamic()); |
| 1048 | this->set_format_enum(options.format_enum()); |
| 1049 | this->set_whole_archive(options.whole_archive()); |
| 1050 | } |
| 1051 | |
| 1052 | DEFINE_posdep(as_needed, bool); |
| 1053 | DEFINE_posdep(Bdynamic, bool); |
| 1054 | DEFINE_posdep(format_enum, General_options::Object_format); |
| 1055 | DEFINE_posdep(whole_archive, bool); |
| 1056 | |
| 1057 | private: |
| 1058 | // This is a General_options with everything set to its default |
| 1059 | // value. A Position_dependent_options created with no argument |
| 1060 | // will take its values from here. |
| 1061 | static General_options default_options_; |
| 1062 | }; |
| 1063 | |
| 1064 | |
| 1065 | // A single file or library argument from the command line. |
| 1066 | |
| 1067 | class Input_file_argument |
| 1068 | { |
| 1069 | public: |
| 1070 | // name: file name or library name |
| 1071 | // is_lib: true if name is a library name: that is, emits the leading |
| 1072 | // "lib" and trailing ".so"/".a" from the name |
| 1073 | // extra_search_path: an extra directory to look for the file, prior |
| 1074 | // to checking the normal library search path. If this is "", |
| 1075 | // then no extra directory is added. |
| 1076 | // just_symbols: whether this file only defines symbols. |
| 1077 | // options: The position dependent options at this point in the |
| 1078 | // command line, such as --whole-archive. |
| 1079 | Input_file_argument() |
| 1080 | : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false), |
| 1081 | options_() |
| 1082 | { } |
| 1083 | |
| 1084 | Input_file_argument(const char* name, bool is_lib, |
| 1085 | const char* extra_search_path, |
| 1086 | bool just_symbols, |
| 1087 | const Position_dependent_options& options) |
| 1088 | : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path), |
| 1089 | just_symbols_(just_symbols), options_(options) |
| 1090 | { } |
| 1091 | |
| 1092 | // You can also pass in a General_options instance instead of a |
| 1093 | // Position_dependent_options. In that case, we extract the |
| 1094 | // position-independent vars from the General_options and only store |
| 1095 | // those. |
| 1096 | Input_file_argument(const char* name, bool is_lib, |
| 1097 | const char* extra_search_path, |
| 1098 | bool just_symbols, |
| 1099 | const General_options& options) |
| 1100 | : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path), |
| 1101 | just_symbols_(just_symbols), options_(options) |
| 1102 | { } |
| 1103 | |
| 1104 | const char* |
| 1105 | name() const |
| 1106 | { return this->name_.c_str(); } |
| 1107 | |
| 1108 | const Position_dependent_options& |
| 1109 | options() const |
| 1110 | { return this->options_; } |
| 1111 | |
| 1112 | bool |
| 1113 | is_lib() const |
| 1114 | { return this->is_lib_; } |
| 1115 | |
| 1116 | const char* |
| 1117 | extra_search_path() const |
| 1118 | { |
| 1119 | return (this->extra_search_path_.empty() |
| 1120 | ? NULL |
| 1121 | : this->extra_search_path_.c_str()); |
| 1122 | } |
| 1123 | |
| 1124 | // Return whether we should only read symbols from this file. |
| 1125 | bool |
| 1126 | just_symbols() const |
| 1127 | { return this->just_symbols_; } |
| 1128 | |
| 1129 | // Return whether this file may require a search using the -L |
| 1130 | // options. |
| 1131 | bool |
| 1132 | may_need_search() const |
| 1133 | { return this->is_lib_ || !this->extra_search_path_.empty(); } |
| 1134 | |
| 1135 | private: |
| 1136 | // We use std::string, not const char*, here for convenience when |
| 1137 | // using script files, so that we do not have to preserve the string |
| 1138 | // in that case. |
| 1139 | std::string name_; |
| 1140 | bool is_lib_; |
| 1141 | std::string extra_search_path_; |
| 1142 | bool just_symbols_; |
| 1143 | Position_dependent_options options_; |
| 1144 | }; |
| 1145 | |
| 1146 | // A file or library, or a group, from the command line. |
| 1147 | |
| 1148 | class Input_argument |
| 1149 | { |
| 1150 | public: |
| 1151 | // Create a file or library argument. |
| 1152 | explicit Input_argument(Input_file_argument file) |
| 1153 | : is_file_(true), file_(file), group_(NULL) |
| 1154 | { } |
| 1155 | |
| 1156 | // Create a group argument. |
| 1157 | explicit Input_argument(Input_file_group* group) |
| 1158 | : is_file_(false), group_(group) |
| 1159 | { } |
| 1160 | |
| 1161 | // Return whether this is a file. |
| 1162 | bool |
| 1163 | is_file() const |
| 1164 | { return this->is_file_; } |
| 1165 | |
| 1166 | // Return whether this is a group. |
| 1167 | bool |
| 1168 | is_group() const |
| 1169 | { return !this->is_file_; } |
| 1170 | |
| 1171 | // Return the information about the file. |
| 1172 | const Input_file_argument& |
| 1173 | file() const |
| 1174 | { |
| 1175 | gold_assert(this->is_file_); |
| 1176 | return this->file_; |
| 1177 | } |
| 1178 | |
| 1179 | // Return the information about the group. |
| 1180 | const Input_file_group* |
| 1181 | group() const |
| 1182 | { |
| 1183 | gold_assert(!this->is_file_); |
| 1184 | return this->group_; |
| 1185 | } |
| 1186 | |
| 1187 | Input_file_group* |
| 1188 | group() |
| 1189 | { |
| 1190 | gold_assert(!this->is_file_); |
| 1191 | return this->group_; |
| 1192 | } |
| 1193 | |
| 1194 | private: |
| 1195 | bool is_file_; |
| 1196 | Input_file_argument file_; |
| 1197 | Input_file_group* group_; |
| 1198 | }; |
| 1199 | |
| 1200 | // A group from the command line. This is a set of arguments within |
| 1201 | // --start-group ... --end-group. |
| 1202 | |
| 1203 | class Input_file_group |
| 1204 | { |
| 1205 | public: |
| 1206 | typedef std::vector<Input_argument> Files; |
| 1207 | typedef Files::const_iterator const_iterator; |
| 1208 | |
| 1209 | Input_file_group() |
| 1210 | : files_() |
| 1211 | { } |
| 1212 | |
| 1213 | // Add a file to the end of the group. |
| 1214 | void |
| 1215 | add_file(const Input_file_argument& arg) |
| 1216 | { this->files_.push_back(Input_argument(arg)); } |
| 1217 | |
| 1218 | // Iterators to iterate over the group contents. |
| 1219 | |
| 1220 | const_iterator |
| 1221 | begin() const |
| 1222 | { return this->files_.begin(); } |
| 1223 | |
| 1224 | const_iterator |
| 1225 | end() const |
| 1226 | { return this->files_.end(); } |
| 1227 | |
| 1228 | private: |
| 1229 | Files files_; |
| 1230 | }; |
| 1231 | |
| 1232 | // A list of files from the command line or a script. |
| 1233 | |
| 1234 | class Input_arguments |
| 1235 | { |
| 1236 | public: |
| 1237 | typedef std::vector<Input_argument> Input_argument_list; |
| 1238 | typedef Input_argument_list::const_iterator const_iterator; |
| 1239 | |
| 1240 | Input_arguments() |
| 1241 | : input_argument_list_(), in_group_(false) |
| 1242 | { } |
| 1243 | |
| 1244 | // Add a file. |
| 1245 | void |
| 1246 | add_file(const Input_file_argument& arg); |
| 1247 | |
| 1248 | // Start a group (the --start-group option). |
| 1249 | void |
| 1250 | start_group(); |
| 1251 | |
| 1252 | // End a group (the --end-group option). |
| 1253 | void |
| 1254 | end_group(); |
| 1255 | |
| 1256 | // Return whether we are currently in a group. |
| 1257 | bool |
| 1258 | in_group() const |
| 1259 | { return this->in_group_; } |
| 1260 | |
| 1261 | // The number of entries in the list. |
| 1262 | int |
| 1263 | size() const |
| 1264 | { return this->input_argument_list_.size(); } |
| 1265 | |
| 1266 | // Iterators to iterate over the list of input files. |
| 1267 | |
| 1268 | const_iterator |
| 1269 | begin() const |
| 1270 | { return this->input_argument_list_.begin(); } |
| 1271 | |
| 1272 | const_iterator |
| 1273 | end() const |
| 1274 | { return this->input_argument_list_.end(); } |
| 1275 | |
| 1276 | // Return whether the list is empty. |
| 1277 | bool |
| 1278 | empty() const |
| 1279 | { return this->input_argument_list_.empty(); } |
| 1280 | |
| 1281 | private: |
| 1282 | Input_argument_list input_argument_list_; |
| 1283 | bool in_group_; |
| 1284 | }; |
| 1285 | |
| 1286 | |
| 1287 | // All the information read from the command line. These are held in |
| 1288 | // three separate structs: one to hold the options (--foo), one to |
| 1289 | // hold the filenames listed on the commandline, and one to hold |
| 1290 | // linker script information. This third is not a subset of the other |
| 1291 | // two because linker scripts can be specified either as options (via |
| 1292 | // -T) or as a file. |
| 1293 | |
| 1294 | class Command_line |
| 1295 | { |
| 1296 | public: |
| 1297 | typedef Input_arguments::const_iterator const_iterator; |
| 1298 | |
| 1299 | Command_line(); |
| 1300 | |
| 1301 | // Process the command line options. This will exit with an |
| 1302 | // appropriate error message if an unrecognized option is seen. |
| 1303 | void |
| 1304 | process(int argc, const char** argv); |
| 1305 | |
| 1306 | // Process one command-line option. This takes the index of argv to |
| 1307 | // process, and returns the index for the next option. no_more_options |
| 1308 | // is set to true if argv[i] is "--". |
| 1309 | int |
| 1310 | process_one_option(int argc, const char** argv, int i, |
| 1311 | bool* no_more_options); |
| 1312 | |
| 1313 | // Get the general options. |
| 1314 | const General_options& |
| 1315 | options() const |
| 1316 | { return this->options_; } |
| 1317 | |
| 1318 | // Get the position dependent options. |
| 1319 | const Position_dependent_options& |
| 1320 | position_dependent_options() const |
| 1321 | { return this->position_options_; } |
| 1322 | |
| 1323 | // Get the linker-script options. |
| 1324 | Script_options& |
| 1325 | script_options() |
| 1326 | { return this->script_options_; } |
| 1327 | |
| 1328 | // Get the version-script options: a convenience routine. |
| 1329 | const Version_script_info& |
| 1330 | version_script() const |
| 1331 | { return *this->script_options_.version_script_info(); } |
| 1332 | |
| 1333 | // Get the input files. |
| 1334 | Input_arguments& |
| 1335 | inputs() |
| 1336 | { return this->inputs_; } |
| 1337 | |
| 1338 | // The number of input files. |
| 1339 | int |
| 1340 | number_of_input_files() const |
| 1341 | { return this->inputs_.size(); } |
| 1342 | |
| 1343 | // Iterators to iterate over the list of input files. |
| 1344 | |
| 1345 | const_iterator |
| 1346 | begin() const |
| 1347 | { return this->inputs_.begin(); } |
| 1348 | |
| 1349 | const_iterator |
| 1350 | end() const |
| 1351 | { return this->inputs_.end(); } |
| 1352 | |
| 1353 | private: |
| 1354 | Command_line(const Command_line&); |
| 1355 | Command_line& operator=(const Command_line&); |
| 1356 | |
| 1357 | General_options options_; |
| 1358 | Position_dependent_options position_options_; |
| 1359 | Script_options script_options_; |
| 1360 | Input_arguments inputs_; |
| 1361 | }; |
| 1362 | |
| 1363 | } // End namespace gold. |
| 1364 | |
| 1365 | #endif // !defined(GOLD_OPTIONS_H) |