| 1 | // options.c -- handle command line options for gold |
| 2 | |
| 3 | #include <iostream> |
| 4 | |
| 5 | #include "gold.h" |
| 6 | #include "options.h" |
| 7 | |
| 8 | namespace gold |
| 9 | { |
| 10 | |
| 11 | // The information we keep for a single command line option. |
| 12 | |
| 13 | struct options::One_option |
| 14 | { |
| 15 | // The single character option name, or '\0' if this is only a long |
| 16 | // option. |
| 17 | char short_option; |
| 18 | |
| 19 | // The long option name, or NULL if this is only a short option. |
| 20 | const char* long_option; |
| 21 | |
| 22 | // Description of the option for --help output, or NULL if there is none. |
| 23 | const char* doc; |
| 24 | |
| 25 | // How to print the option name in --help output, or NULL to use the |
| 26 | // default. |
| 27 | const char* help_output; |
| 28 | |
| 29 | // Long option dash control. This is ignored if long_option is |
| 30 | // NULL. |
| 31 | enum |
| 32 | { |
| 33 | // Long option normally takes one dash; two dashes are also |
| 34 | // accepted. |
| 35 | ONE_DASH, |
| 36 | // Long option normally takes two dashes; one dash is also |
| 37 | // accepted. |
| 38 | TWO_DASHES, |
| 39 | // Long option always takes two dashes. |
| 40 | EXACTLY_TWO_DASHES |
| 41 | } dash; |
| 42 | |
| 43 | // Function for special handling, or NULL. Returns the number of |
| 44 | // arguments to skip. This will normally be at least 1, but it may |
| 45 | // be 0 if this function changes *argv. ARG points to the location |
| 46 | // in *ARGV where the option starts, which may be helpful for a |
| 47 | // short option. |
| 48 | int (*special)(int argc, char** argv, char *arg, Command_line*); |
| 49 | |
| 50 | // If this is a position independent option which does not take an |
| 51 | // argument, this is the member function to call to record it. |
| 52 | void (General_options::*general_noarg)(); |
| 53 | |
| 54 | // If this is a position independent function which takes an |
| 55 | // argument, this is the member function to call to record it. |
| 56 | void (General_options::*general_arg)(const char*); |
| 57 | |
| 58 | // If this is a position dependent option which does not take an |
| 59 | // argument, this is the member function to call to record it. |
| 60 | void (Position_dependent_options::*dependent_noarg)(); |
| 61 | |
| 62 | // If this is a position dependent option which takes an argument, |
| 63 | // this is the member function to record it. |
| 64 | void (Position_dependent_options::*dependent_arg)(const char*); |
| 65 | |
| 66 | // Return whether this option takes an argument. |
| 67 | bool |
| 68 | takes_argument() const |
| 69 | { return this->general_arg != NULL || this->dependent_arg != NULL; } |
| 70 | }; |
| 71 | |
| 72 | class options::Command_line_options |
| 73 | { |
| 74 | public: |
| 75 | static const One_option options[]; |
| 76 | static const int options_size; |
| 77 | }; |
| 78 | |
| 79 | } // End namespace gold. |
| 80 | |
| 81 | namespace |
| 82 | { |
| 83 | |
| 84 | // Handle the special -l option, which adds an input file. |
| 85 | |
| 86 | int |
| 87 | library(int argc, char** argv, char* arg, gold::Command_line* cmdline) |
| 88 | { |
| 89 | return cmdline->process_l_option(argc, argv, arg); |
| 90 | } |
| 91 | |
| 92 | // Handle the special --start-group option. |
| 93 | |
| 94 | int |
| 95 | start_group(int, char**, char* arg, gold::Command_line* cmdline) |
| 96 | { |
| 97 | cmdline->start_group(arg); |
| 98 | return 1; |
| 99 | } |
| 100 | |
| 101 | // Handle the special --end-group option. |
| 102 | |
| 103 | int |
| 104 | end_group(int, char**, char* arg, gold::Command_line* cmdline) |
| 105 | { |
| 106 | cmdline->end_group(arg); |
| 107 | return 1; |
| 108 | } |
| 109 | |
| 110 | // Report usage information for ld --help, and exit. |
| 111 | |
| 112 | int |
| 113 | help(int, char**, char*, gold::Command_line*) |
| 114 | { |
| 115 | printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name); |
| 116 | |
| 117 | const int options_size = gold::options::Command_line_options::options_size; |
| 118 | const gold::options::One_option* options = |
| 119 | gold::options::Command_line_options::options; |
| 120 | for (int i = 0; i < options_size; ++i) |
| 121 | { |
| 122 | if (options[i].doc == NULL) |
| 123 | continue; |
| 124 | |
| 125 | printf(" "); |
| 126 | int len = 2; |
| 127 | bool comma = false; |
| 128 | |
| 129 | int j = i; |
| 130 | do |
| 131 | { |
| 132 | if (options[j].help_output != NULL) |
| 133 | { |
| 134 | if (comma) |
| 135 | { |
| 136 | printf(", "); |
| 137 | len += 2; |
| 138 | } |
| 139 | printf(options[j].help_output); |
| 140 | len += std::strlen(options[i].help_output); |
| 141 | } |
| 142 | else |
| 143 | { |
| 144 | if (options[j].short_option != '\0') |
| 145 | { |
| 146 | if (comma) |
| 147 | { |
| 148 | printf(", "); |
| 149 | len += 2; |
| 150 | } |
| 151 | printf("-%c", options[j].short_option); |
| 152 | len += 2; |
| 153 | } |
| 154 | |
| 155 | if (options[j].long_option != NULL) |
| 156 | { |
| 157 | if (comma) |
| 158 | { |
| 159 | printf(", "); |
| 160 | len += 2; |
| 161 | } |
| 162 | if (options[j].dash == gold::options::One_option::ONE_DASH) |
| 163 | { |
| 164 | printf("-"); |
| 165 | ++len; |
| 166 | } |
| 167 | else |
| 168 | { |
| 169 | printf("--"); |
| 170 | len += 2; |
| 171 | } |
| 172 | printf("%s", options[j].long_option); |
| 173 | len += std::strlen(options[j].long_option); |
| 174 | } |
| 175 | } |
| 176 | ++j; |
| 177 | } |
| 178 | while (j < options_size && options[j].doc == NULL); |
| 179 | |
| 180 | if (len > 30) |
| 181 | { |
| 182 | printf("\n"); |
| 183 | len = 0; |
| 184 | } |
| 185 | for (; len < 30; ++len) |
| 186 | std::putchar(' '); |
| 187 | |
| 188 | std::puts(options[i].doc); |
| 189 | } |
| 190 | |
| 191 | gold::gold_exit(true); |
| 192 | |
| 193 | return 0; |
| 194 | } |
| 195 | |
| 196 | } // End anonymous namespace. |
| 197 | |
| 198 | namespace gold |
| 199 | { |
| 200 | |
| 201 | // Helper macros used to specify the options. We could also do this |
| 202 | // using constructors, but then g++ would generate code to initialize |
| 203 | // the array. We want the array to be initialized statically so that |
| 204 | // we get better startup time. |
| 205 | |
| 206 | #define GENERAL_NOARG(short_option, long_option, doc, help, dash, func) \ |
| 207 | { short_option, long_option, doc, help, options::One_option::dash, \ |
| 208 | NULL, func, NULL, NULL, NULL } |
| 209 | #define GENERAL_ARG(short_option, long_option, doc, help, dash, func) \ |
| 210 | { short_option, long_option, doc, help, options::One_option::dash, \ |
| 211 | NULL, NULL, func, NULL, NULL } |
| 212 | #define POSDEP_NOARG(short_option, long_option, doc, help, dash, func) \ |
| 213 | { short_option, long_option, doc, help, options::One_option::dash, \ |
| 214 | NULL, NULL, NULL, func, NULL } |
| 215 | #define POSDEP_ARG(short_option, long_option, doc, help, dash, func) \ |
| 216 | { short_option, long_option, doc, help, options::One_option::dash, \ |
| 217 | NULL, NULL, NULL, NULL, func } |
| 218 | #define SPECIAL(short_option, long_option, doc, help, dash, func) \ |
| 219 | { short_option, long_option, doc, help, options::One_option::dash, \ |
| 220 | func, NULL, NULL, NULL, NULL } |
| 221 | |
| 222 | // Here is the actual list of options which we accept. |
| 223 | |
| 224 | const options::One_option |
| 225 | options::Command_line_options::options[] = |
| 226 | { |
| 227 | SPECIAL('l', "library", N_("Search for library LIBNAME"), |
| 228 | N_("-lLIBNAME --library LIBNAME"), TWO_DASHES, |
| 229 | &library), |
| 230 | SPECIAL('(', "start-group", N_("Start a library search group"), NULL, |
| 231 | TWO_DASHES, &start_group), |
| 232 | SPECIAL(')', "end-group", N_("End a library search group"), NULL, |
| 233 | TWO_DASHES, &end_group), |
| 234 | GENERAL_ARG('L', "library-path", N_("Add directory to search path"), |
| 235 | N_("-L DIR, --library-path DIR"), TWO_DASHES, |
| 236 | &General_options::add_to_search_path), |
| 237 | GENERAL_ARG('m', NULL, N_("Ignored for compatibility"), NULL, ONE_DASH, |
| 238 | &General_options::ignore), |
| 239 | GENERAL_ARG('o', "output", N_("Set output file name"), |
| 240 | N_("-o FILE, --output FILE"), TWO_DASHES, |
| 241 | &General_options::set_output_file_name), |
| 242 | GENERAL_NOARG('r', NULL, N_("Generate relocatable output"), NULL, |
| 243 | ONE_DASH, &General_options::set_relocatable), |
| 244 | GENERAL_NOARG('\0', "shared", N_("Generate shared library"), |
| 245 | NULL, ONE_DASH, &General_options::set_shared), |
| 246 | GENERAL_NOARG('\0', "static", N_("Do not link against shared libraries"), |
| 247 | NULL, ONE_DASH, &General_options::set_static), |
| 248 | SPECIAL('\0', "help", N_("Report usage information"), NULL, |
| 249 | TWO_DASHES, &help) |
| 250 | }; |
| 251 | |
| 252 | const int options::Command_line_options::options_size = |
| 253 | sizeof (options) / sizeof (options[0]); |
| 254 | |
| 255 | // The default values for the general options. |
| 256 | |
| 257 | General_options::General_options() |
| 258 | : search_path_(), |
| 259 | output_file_name_("a.out"), |
| 260 | is_relocatable_(false), |
| 261 | is_shared_(false), |
| 262 | is_static_(false) |
| 263 | { |
| 264 | } |
| 265 | |
| 266 | // The default values for the position dependent options. |
| 267 | |
| 268 | Position_dependent_options::Position_dependent_options() |
| 269 | : do_static_search_(false) |
| 270 | { |
| 271 | } |
| 272 | |
| 273 | // Command_line options. |
| 274 | |
| 275 | Command_line::Command_line() |
| 276 | : options_(), position_options_(), inputs_(), in_group_(false) |
| 277 | { |
| 278 | } |
| 279 | |
| 280 | // Process the command line options. |
| 281 | |
| 282 | void |
| 283 | Command_line::process(int argc, char** argv) |
| 284 | { |
| 285 | const int options_size = options::Command_line_options::options_size; |
| 286 | const options::One_option* options = |
| 287 | options::Command_line_options::options; |
| 288 | bool no_more_options = false; |
| 289 | int i = 0; |
| 290 | while (i < argc) |
| 291 | { |
| 292 | if (argv[i][0] != '-' || no_more_options) |
| 293 | { |
| 294 | this->add_file(argv[i], false); |
| 295 | ++i; |
| 296 | continue; |
| 297 | } |
| 298 | |
| 299 | // Option starting with '-'. |
| 300 | int dashes = 1; |
| 301 | if (argv[i][1] == '-') |
| 302 | { |
| 303 | dashes = 2; |
| 304 | if (argv[i][2] == '\0') |
| 305 | { |
| 306 | no_more_options = true; |
| 307 | continue; |
| 308 | } |
| 309 | } |
| 310 | |
| 311 | // Look for a long option match. |
| 312 | char* opt = argv[i] + dashes; |
| 313 | char first = opt[0]; |
| 314 | int skiparg = 0; |
| 315 | char* arg = strchr(opt, '='); |
| 316 | if (arg != NULL) |
| 317 | *arg = '\0'; |
| 318 | else if (i + 1 < argc) |
| 319 | { |
| 320 | arg = argv[i + 1]; |
| 321 | skiparg = 1; |
| 322 | } |
| 323 | |
| 324 | int j; |
| 325 | for (j = 0; j < options_size; ++j) |
| 326 | { |
| 327 | if (options[j].long_option != NULL |
| 328 | && (dashes == 2 |
| 329 | || (options[j].dash |
| 330 | != options::One_option::EXACTLY_TWO_DASHES)) |
| 331 | && first == options[j].long_option[0] |
| 332 | && strcmp(opt, options[j].long_option) == 0) |
| 333 | { |
| 334 | if (options[j].special) |
| 335 | i += options[j].special(argc - 1, argv + i, opt, this); |
| 336 | else |
| 337 | { |
| 338 | if (!options[j].takes_argument()) |
| 339 | { |
| 340 | arg = NULL; |
| 341 | skiparg = 0; |
| 342 | } |
| 343 | else |
| 344 | { |
| 345 | if (arg == NULL) |
| 346 | this->usage(_("missing argument"), argv[i]); |
| 347 | } |
| 348 | this->apply_option(options[j], arg); |
| 349 | i += skiparg + 1; |
| 350 | } |
| 351 | break; |
| 352 | } |
| 353 | } |
| 354 | if (j < options_size) |
| 355 | continue; |
| 356 | |
| 357 | // If we saw two dashes, we need to see a long option. |
| 358 | if (dashes == 2) |
| 359 | this->usage(_("unknown option"), argv[i]); |
| 360 | |
| 361 | // Look for a short option match. There may be more than one |
| 362 | // short option in a given argument. |
| 363 | bool done = false; |
| 364 | char* s = argv[i] + 1; |
| 365 | ++i; |
| 366 | while (*s != '\0' && !done) |
| 367 | { |
| 368 | char opt = *s; |
| 369 | int j; |
| 370 | for (j = 0; j < options_size; ++j) |
| 371 | { |
| 372 | if (options[j].short_option == opt) |
| 373 | { |
| 374 | if (options[j].special) |
| 375 | { |
| 376 | // Undo the argument skip done above. |
| 377 | --i; |
| 378 | i += options[j].special(argc - i, argv + i, s, this); |
| 379 | done = true; |
| 380 | } |
| 381 | else |
| 382 | { |
| 383 | arg = NULL; |
| 384 | if (options[j].takes_argument()) |
| 385 | { |
| 386 | if (s[1] != '\0') |
| 387 | { |
| 388 | arg = s + 1; |
| 389 | done = true; |
| 390 | } |
| 391 | else if (i < argc) |
| 392 | { |
| 393 | arg = argv[i]; |
| 394 | ++i; |
| 395 | } |
| 396 | else |
| 397 | this->usage(_("missing argument"), opt); |
| 398 | } |
| 399 | this->apply_option(options[j], arg); |
| 400 | } |
| 401 | break; |
| 402 | } |
| 403 | } |
| 404 | |
| 405 | if (j >= options_size) |
| 406 | this->usage(_("unknown option"), *s); |
| 407 | |
| 408 | ++s; |
| 409 | } |
| 410 | } |
| 411 | |
| 412 | if (this->in_group_) |
| 413 | { |
| 414 | fprintf(stderr, _("%s: missing group end"), program_name); |
| 415 | this->usage(); |
| 416 | } |
| 417 | |
| 418 | // FIXME: We should only do this when configured in native mode. |
| 419 | this->options_.add_to_search_path("/lib"); |
| 420 | this->options_.add_to_search_path("/usr/lib"); |
| 421 | } |
| 422 | |
| 423 | // Apply a command line option. |
| 424 | |
| 425 | void |
| 426 | Command_line::apply_option(const options::One_option& opt, |
| 427 | const char* arg) |
| 428 | { |
| 429 | if (arg == NULL) |
| 430 | { |
| 431 | if (opt.general_noarg) |
| 432 | (this->options_.*(opt.general_noarg))(); |
| 433 | else if (opt.dependent_noarg) |
| 434 | (this->position_options_.*(opt.dependent_noarg))(); |
| 435 | else |
| 436 | gold_unreachable(); |
| 437 | } |
| 438 | else |
| 439 | { |
| 440 | if (opt.general_arg) |
| 441 | (this->options_.*(opt.general_arg))(arg); |
| 442 | else if (opt.dependent_arg) |
| 443 | (this->position_options_.*(opt.dependent_arg))(arg); |
| 444 | else |
| 445 | gold_unreachable(); |
| 446 | } |
| 447 | } |
| 448 | |
| 449 | // Add an input file or library. |
| 450 | |
| 451 | void |
| 452 | Command_line::add_file(const char* name, bool is_lib) |
| 453 | { |
| 454 | Input_file_argument file(name, is_lib, this->position_options_); |
| 455 | if (!this->in_group_) |
| 456 | this->inputs_.push_back(Input_argument(file)); |
| 457 | else |
| 458 | { |
| 459 | assert(!this->inputs_.empty()); |
| 460 | assert(this->inputs_.back().is_group()); |
| 461 | this->inputs_.back().group()->add_file(file); |
| 462 | } |
| 463 | } |
| 464 | |
| 465 | // Handle the -l option, which requires special treatment. |
| 466 | |
| 467 | int |
| 468 | Command_line::process_l_option(int argc, char** argv, char* arg) |
| 469 | { |
| 470 | int ret; |
| 471 | const char* libname; |
| 472 | if (arg[1] != '\0') |
| 473 | { |
| 474 | ret = 1; |
| 475 | libname = arg + 1; |
| 476 | } |
| 477 | else if (argc > 1) |
| 478 | { |
| 479 | ret = 2; |
| 480 | libname = argv[argc + 1]; |
| 481 | } |
| 482 | else |
| 483 | this->usage(_("missing argument"), arg); |
| 484 | |
| 485 | this->add_file(libname, true); |
| 486 | |
| 487 | return ret; |
| 488 | } |
| 489 | |
| 490 | // Handle the --start-group option. |
| 491 | |
| 492 | void |
| 493 | Command_line::start_group(const char* arg) |
| 494 | { |
| 495 | if (this->in_group_) |
| 496 | this->usage(_("may not nest groups"), arg); |
| 497 | |
| 498 | // This object is leaked. |
| 499 | Input_file_group* group = new Input_file_group(); |
| 500 | this->inputs_.push_back(Input_argument(group)); |
| 501 | |
| 502 | this->in_group_ = true; |
| 503 | } |
| 504 | |
| 505 | // Handle the --end-group option. |
| 506 | |
| 507 | void |
| 508 | Command_line::end_group(const char* arg) |
| 509 | { |
| 510 | if (!this->in_group_) |
| 511 | this->usage(_("group end without group start"), arg); |
| 512 | this->in_group_ = false; |
| 513 | } |
| 514 | |
| 515 | // Report a usage error. */ |
| 516 | |
| 517 | void |
| 518 | Command_line::usage() |
| 519 | { |
| 520 | fprintf(stderr, |
| 521 | _("%s: use the --help option for usage information\n"), |
| 522 | program_name); |
| 523 | gold_exit(false); |
| 524 | } |
| 525 | |
| 526 | void |
| 527 | Command_line::usage(const char* msg, const char *opt) |
| 528 | { |
| 529 | fprintf(stderr, |
| 530 | _("%s: %s: %s\n"), |
| 531 | program_name, opt, msg); |
| 532 | this->usage(); |
| 533 | } |
| 534 | |
| 535 | void |
| 536 | Command_line::usage(const char* msg, char opt) |
| 537 | { |
| 538 | fprintf(stderr, |
| 539 | _("%s: -%c: %s\n"), |
| 540 | program_name, opt, msg); |
| 541 | this->usage(); |
| 542 | } |
| 543 | |
| 544 | } // End namespace gold. |