gold/options.h

   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 // Command_line
  24 //   Holds everything we get from the command line.
  25 // General_options (from Command_line::options())
  26 //   Options which are not position dependent.
  27 // Input_argument (from Command_line::inputs())
  28 //   The list of input files, including -l options.
  29 // Position_dependent_options (from Input_argument::options())
  30 //   Position dependent options which apply to this argument.
  31
  32 #ifndef GOLD_OPTIONS_H
  33 #define GOLD_OPTIONS_H
  34
  35 #include <cstdlib>
  36 #include <list>
  37 #include <string>
  38 #include <vector>
  39
  40 #include "elfcpp.h"
  41 #include "script.h"
  42
  43 namespace gold
  44 {
  45
  46 class Command_line;
  47 class Input_file_group;
  48 class Position_dependent_options;
  49 class Target;
  50
  51 namespace options
  52 {
  53
  54 class Command_line_options;
  55 struct One_option;
  56 struct One_z_option;
  57 struct One_debug_option;
  58
  59 } // End namespace gold::options.
  60
  61 // A directory to search.  For each directory we record whether it is
  62 // in the sysroot.  We need to know this so that, if a linker script
  63 // is found within the sysroot, we will apply the sysroot to any files
  64 // named by that script.
  65
  66 class Search_directory
  67 {
  68  public:
  69   // We need a default constructor because we put this in a
  70   // std::vector.
  71   Search_directory()
  72     : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
  73   { }
  74
  75   // This is the usual constructor.
  76   Search_directory(const char* name, bool put_in_sysroot)
  77     : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
  78   {
  79     if (this->name_.empty())
  80       this->name_ = ".";
  81   }
  82
  83   // This is called if we have a sysroot.  The sysroot is prefixed to
  84   // any entries for which put_in_sysroot_ is true.  is_in_sysroot_ is
  85   // set to true for any enries which are in the sysroot (this will
  86   // naturally include any entries for which put_in_sysroot_ is true).
  87   // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
  88   // passing SYSROOT to lrealpath.
  89   void
  90   add_sysroot(const char* sysroot, const char* canonical_sysroot);
  91
  92   // Get the directory name.
  93   const std::string&
  94   name() const
  95   { return this->name_; }
  96
  97   // Return whether this directory is in the sysroot.
  98   bool
  99   is_in_sysroot() const
 100   { return this->is_in_sysroot_; }
 101
 102  private:
 103   std::string name_;
 104   bool put_in_sysroot_;
 105   bool is_in_sysroot_;
 106 };
 107
 108 // The position independent options which apply to the whole link.
 109 // There are a lot of them.
 110
 111 class General_options
 112 {
 113  public:
 114   enum Object_format
 115   {
 116     // Ordinary ELF.
 117     OBJECT_FORMAT_ELF,
 118     // Straight binary format.
 119     OBJECT_FORMAT_BINARY
 120   };
 121
 122   General_options();
 123
 124   // -d: define common symbols.
 125   bool
 126   define_common() const
 127   { return this->define_common_; }
 128
 129   // -e: set entry address.
 130   const char*
 131   entry() const
 132   { return this->entry_; }
 133
 134   // -E: export dynamic symbols.
 135   bool
 136   export_dynamic() const
 137   { return this->export_dynamic_; }
 138
 139   // -h: shared library name.
 140   const char*
 141   soname() const
 142   { return this->soname_; }
 143
 144   // -I: dynamic linker name.
 145   const char*
 146   dynamic_linker() const
 147   { return this->dynamic_linker_; }
 148
 149   // -L: Library search path.
 150   typedef std::vector<Search_directory> Dir_list;
 151
 152   const Dir_list&
 153   search_path() const
 154   { return this->search_path_; }
 155
 156   // -O: optimization level (0: don't try to optimize output size).
 157   int
 158   optimize() const
 159   { return this->optimization_level_; }
 160
 161   // -o: Output file name.
 162   const char*
 163   output_file_name() const
 164   { return this->output_file_name_; }
 165
 166   // --oformat: Output format.
 167   Object_format
 168   oformat() const
 169   { return this->oformat_; }
 170
 171   const char*
 172   oformat_string() const
 173   { return this->oformat_string_; }
 174
 175   // Return the default target.
 176   Target*
 177   default_target() const;
 178
 179   // -q: Whether to emit relocations.
 180   bool
 181   emit_relocs() const
 182   { return this->emit_relocs_; }
 183
 184   // -r: Whether we are doing a relocatable link.
 185   bool
 186   relocatable() const
 187   { return this->is_relocatable_; }
 188
 189   // -s: Strip all symbols.
 190   bool
 191   strip_all() const
 192   { return this->strip_ == STRIP_ALL; }
 193
 194   // -S: Strip debugging information.
 195   bool
 196   strip_debug() const
 197   { return this->strip_ == STRIP_ALL || this->strip_ == STRIP_DEBUG; }
 198
 199   // --strip-debug-gdb: strip only debugging information that's not
 200   // used by gdb (at least, for gdb versions <= 6.7).
 201   bool
 202   strip_debug_gdb() const
 203   { return this->strip_debug() || this->strip_ == STRIP_DEBUG_UNUSED_BY_GDB; }
 204
 205   // --allow-shlib-undefined: do not warn about unresolved symbols in
 206   // --shared libraries.
 207   bool
 208   allow_shlib_undefined() const
 209   { return this->allow_shlib_undefined_; }
 210
 211   // -Bsymbolic: bind defined symbols locally.
 212   bool
 213   Bsymbolic() const
 214   { return this->symbolic_; }
 215
 216   // --compress-debug-sections: compress .debug_* sections in the
 217   // output file using the given compression method.  This is useful
 218   // when the tools (such as gdb) support compressed sections.
 219   bool
 220   compress_debug_sections() const
 221   { return this->compress_debug_sections_ != NO_COMPRESSION; }
 222
 223   bool
 224   zlib_compress_debug_sections() const
 225   { return this->compress_debug_sections_ == ZLIB_COMPRESSION; }
 226
 227   // --demangle: demangle C++ symbols in our log messages.
 228   bool
 229   demangle() const
 230   { return this->demangle_; }
 231
 232   // --detect-odr-violations: Whether to search for One Defn Rule violations.
 233   bool
 234   detect_odr_violations() const
 235   { return this->detect_odr_violations_; }
 236
 237   // --eh-frame-hdr: Whether to generate an exception frame header.
 238   bool
 239   eh_frame_hdr() const
 240   { return this->create_eh_frame_hdr_; }
 241
 242   // --rpath: The runtime search path.
 243   const Dir_list&
 244   rpath() const
 245   { return this->rpath_; }
 246
 247   // --rpath-link: The link time search patch for shared libraries.
 248   const Dir_list&
 249   rpath_link() const
 250   { return this->rpath_link_; }
 251
 252   // --shared: Whether generating a shared object.
 253   bool
 254   shared() const
 255   { return this->is_shared_; }
 256
 257   // This is not defined via a flag, but combines flags to say whether
 258   // the output is position-independent or not.
 259   bool
 260   output_is_position_independent() const
 261   { return this->shared(); }
 262
 263   // --static: Whether doing a static link.
 264   bool
 265   is_static() const
 266   { return this->is_static_; }
 267
 268   // --stats: Print resource usage statistics.
 269   bool
 270   print_stats() const
 271   { return this->print_stats_; }
 272
 273   // --sysroot: The system root of a cross-linker.
 274   const std::string&
 275   sysroot() const
 276   { return this->sysroot_; }
 277
 278   // -Tbss: The address of the BSS segment
 279   uint64_t
 280   Tbss() const
 281   { return this->bss_segment_address_; }
 282
 283   // Whether -Tbss was used.
 284   bool
 285   user_set_Tbss() const
 286   { return this->bss_segment_address_ != -1U; }
 287
 288   // -Tdata: The address of the data segment
 289   uint64_t
 290   Tdata() const
 291   { return this->data_segment_address_; }
 292
 293   // Whether -Tdata was used.
 294   bool
 295   user_set_Tdata() const
 296   { return this->data_segment_address_ != -1U; }
 297
 298   // -Ttext: The address of the .text section
 299   uint64_t
 300   Ttext() const
 301   { return this->text_segment_address_; }
 302
 303   // Whether -Ttext was used.
 304   bool
 305   user_set_Ttext() const
 306   { return this->text_segment_address_ != -1U; }
 307
 308   // --threads: Whether to use threads.
 309   bool
 310   threads() const
 311   { return this->threads_; }
 312
 313   // --thread-count-initial: Threads to use in initial pass.
 314   int
 315   thread_count_initial() const
 316   { return this->thread_count_initial_; }
 317
 318   // --thread-count-middle: Threads to use in middle pass.
 319   int
 320   thread_count_middle() const
 321   { return this->thread_count_middle_; }
 322
 323   // --thread-count-final: Threads to use in final pass.
 324   int
 325   thread_count_final() const
 326   { return this->thread_count_final_; }
 327
 328   // -z execstack, -z noexecstack
 329   bool
 330   is_execstack_set() const
 331   { return this->execstack_ != EXECSTACK_FROM_INPUT; }
 332
 333   bool
 334   is_stack_executable() const
 335   { return this->execstack_ == EXECSTACK_YES; }
 336
 337   // -z max-page-size
 338   uint64_t
 339   max_page_size() const
 340   { return this->max_page_size_; }
 341
 342   // -z common-page-size
 343   uint64_t
 344   common_page_size() const
 345   { return this->common_page_size_; }
 346
 347   // --debug
 348   unsigned int
 349   debug() const
 350   { return this->debug_; }
 351
 352  private:
 353   // Don't copy this structure.
 354   General_options(const General_options&);
 355   General_options& operator=(const General_options&);
 356
 357   friend class Command_line;
 358   friend class options::Command_line_options;
 359
 360   // Which symbols to strip.
 361   enum Strip
 362   {
 363     // Don't strip any symbols.
 364     STRIP_NONE,
 365     // Strip all symbols.
 366     STRIP_ALL,
 367     // Strip debugging information.
 368     STRIP_DEBUG,
 369     // Strip debugging information that's not used by gdb (at least <= 6.7)
 370     STRIP_DEBUG_UNUSED_BY_GDB
 371   };
 372
 373   // Whether to mark the stack as executable.
 374   enum Execstack
 375   {
 376     // Not set on command line.
 377     EXECSTACK_FROM_INPUT,
 378     // Mark the stack as executable.
 379     EXECSTACK_YES,
 380     // Mark the stack as not executable.
 381     EXECSTACK_NO
 382   };
 383
 384   // What compression method to use
 385   enum CompressionMethod
 386   {
 387     NO_COMPRESSION,
 388     ZLIB_COMPRESSION,
 389   };
 390
 391   void
 392   set_define_common(bool value)
 393   {
 394     this->define_common_ = value;
 395     this->user_set_define_common_ = true;
 396   }
 397
 398   void
 399   set_no_define_common(bool value)
 400   { this->set_define_common(!value); }
 401
 402   bool
 403   user_set_define_common() const
 404   { return this->user_set_define_common_; }
 405
 406   void
 407   set_entry(const char* arg)
 408   { this->entry_ = arg; }
 409
 410   void
 411   set_export_dynamic(bool value)
 412   { this->export_dynamic_ = value; }
 413
 414   void
 415   set_soname(const char* arg)
 416   { this->soname_ = arg; }
 417
 418   void
 419   set_dynamic_linker(const char* arg)
 420   { this->dynamic_linker_ = arg; }
 421
 422   void
 423   add_to_search_path(const char* arg)
 424   { this->search_path_.push_back(Search_directory(arg, false)); }
 425
 426   void
 427   add_to_search_path_with_sysroot(const char* arg)
 428   { this->search_path_.push_back(Search_directory(arg, true)); }
 429
 430   void
 431   set_optimize(const char* arg)
 432   {
 433     char* endptr;
 434     this->optimization_level_ = strtol(arg, &endptr, 0);
 435     if (*endptr != '\0' || this->optimization_level_ < 0)
 436       gold_fatal(_("invalid optimization level: %s"), arg);
 437   }
 438
 439   void
 440   set_output(const char* arg)
 441   { this->output_file_name_ = arg; }
 442
 443   void
 444   set_oformat(const char*);
 445
 446   void
 447   set_emit_relocs(bool value)
 448   { this->emit_relocs_ = value; }
 449
 450   void
 451   set_relocatable(bool value)
 452   { this->is_relocatable_ = value; }
 453
 454   void
 455   set_strip_all(bool)
 456   { this->strip_ = STRIP_ALL; }
 457
 458   // Note: normalize_options() depends on the fact that this turns off
 459   // STRIP_ALL if it were already set.
 460   void
 461   set_strip_debug(bool)
 462   { this->strip_ = STRIP_DEBUG; }
 463
 464   void
 465   set_strip_debug_gdb(bool)
 466   { this->strip_ = STRIP_DEBUG_UNUSED_BY_GDB; }
 467
 468   void
 469   set_allow_shlib_undefined(bool value)
 470   { this->allow_shlib_undefined_ = value; }
 471
 472   void
 473   set_no_allow_shlib_undefined(bool value)
 474   { this->set_allow_shlib_undefined(!value); }
 475
 476   void
 477   set_Bsymbolic(bool value)
 478   { this->symbolic_ = value; }
 479
 480   void set_compress_debug_sections(const char* arg)
 481   {
 482     if (strcmp(arg, "none") == 0)
 483       this->compress_debug_sections_ = NO_COMPRESSION;
 484 #ifdef HAVE_ZLIB_H
 485     else if (strcmp(arg, "zlib") == 0)
 486       this->compress_debug_sections_ = ZLIB_COMPRESSION;
 487 #endif
 488     else
 489       gold_fatal(_("unsupported argument to --compress-debug-sections: %s"),
 490                  arg);
 491   }
 492
 493   void
 494   add_to_defsym(const char* arg);
 495
 496   void
 497   set_demangle(bool value)
 498   { this->demangle_ = value; }
 499
 500   void
 501   set_no_demangle(bool value)
 502   { this->set_demangle(!value); }
 503
 504   void
 505   set_detect_odr_violations(bool value)
 506   { this->detect_odr_violations_ = value; }
 507
 508   void
 509   set_eh_frame_hdr(bool value)
 510   { this->create_eh_frame_hdr_ = value; }
 511
 512   void
 513   add_to_rpath(const char* arg)
 514   { this->rpath_.push_back(Search_directory(arg, false)); }
 515
 516   void
 517   add_to_rpath_link(const char* arg)
 518   { this->rpath_link_.push_back(Search_directory(arg, false)); }
 519
 520   void
 521   set_shared(bool value)
 522   { this->is_shared_ = value; }
 523
 524   void
 525   set_static(bool value)
 526   { this->is_static_ = value; }
 527
 528   void
 529   set_stats(bool value)
 530   { this->print_stats_ = value; }
 531
 532   void
 533   set_sysroot(const char* arg)
 534   { this->sysroot_ = arg; }
 535
 536   void
 537   set_segment_address(const char* name, const char* arg, uint64_t* val)
 538   {
 539     char* endptr;
 540     *val = strtoull(arg, &endptr, 0);
 541     if (*endptr != '\0' || *val == -1U)
 542       gold_fatal(_("invalid argument to %s: %s"), name, arg);
 543   }
 544
 545   void
 546   set_Tbss(const char* arg)
 547   { this->set_segment_address("-Tbss", arg, &this->bss_segment_address_); }
 548
 549   void
 550   set_Tdata(const char* arg)
 551   { this->set_segment_address("-Tdata", arg, &this->data_segment_address_); }
 552
 553   void
 554   set_Ttext(const char* arg)
 555   { this->set_segment_address("-Ttext", arg, &this->text_segment_address_); }
 556
 557   int
 558   parse_thread_count(const char* arg)
 559   {
 560     char* endptr;
 561     const int count = strtol(arg, &endptr, 0);
 562     if (*endptr != '\0' || count < 0)
 563       gold_fatal(_("invalid thread count: %s"), arg);
 564     return count;
 565   }
 566
 567   void
 568   set_threads(bool value)
 569   {
 570 #ifndef ENABLE_THREADS
 571     if (value)
 572       gold_fatal(_("--threads not supported"));
 573 #endif
 574     this->threads_ = value;
 575   }
 576
 577   void
 578   set_no_threads(bool value)
 579   { this->set_threads(!value); }
 580
 581   void
 582   set_thread_count(const char* arg)
 583   {
 584     int count = this->parse_thread_count(arg);
 585     this->thread_count_initial_ = count;
 586     this->thread_count_middle_ = count;
 587     this->thread_count_final_ = count;
 588   }
 589
 590   void
 591   set_thread_count_initial(const char* arg)
 592   { this->thread_count_initial_ = this->parse_thread_count(arg); }
 593
 594   void
 595   set_thread_count_middle(const char* arg)
 596   { this->thread_count_middle_ = this->parse_thread_count(arg); }
 597
 598   void
 599   set_thread_count_final(const char* arg)
 600   { this->thread_count_final_ = this->parse_thread_count(arg); }
 601
 602   void
 603   ignore(const char*)
 604   { }
 605
 606   void
 607   set_execstack(bool)
 608   { this->execstack_ = EXECSTACK_YES; }
 609
 610   void
 611   set_noexecstack(bool)
 612   { this->execstack_ = EXECSTACK_NO; }
 613
 614   void
 615   set_max_page_size(const char* arg)
 616   {
 617     char* endptr;
 618     this->max_page_size_ = strtoull(arg, &endptr, 0);
 619     if (*endptr != '\0' || this->max_page_size_ == 0)
 620       gold_fatal(_("invalid max-page-size: %s"), arg);
 621   }
 622
 623   void
 624   set_common_page_size(const char* arg)
 625   {
 626     char* endptr;
 627     this->common_page_size_ = strtoull(arg, &endptr, 0);
 628     if (*endptr != '\0' || this->common_page_size_ == 0)
 629       gold_fatal(_("invalid common-page-size: %s"), arg);
 630   }
 631
 632   void
 633   set_debug(unsigned int flags)
 634   { this->debug_ = flags; }
 635
 636   // Handle the -z option.
 637   void
 638   handle_z_option(const char*);
 639
 640   // Handle the --debug option.
 641   void
 642   handle_debug_option(const char*);
 643
 644   // Apply any sysroot to the directory lists.
 645   void
 646   add_sysroot();
 647
 648   bool define_common_;
 649   bool user_set_define_common_;
 650   const char* entry_;
 651   bool export_dynamic_;
 652   const char* soname_;
 653   const char* dynamic_linker_;
 654   Dir_list search_path_;
 655   int optimization_level_;
 656   const char* output_file_name_;
 657   Object_format oformat_;
 658   const char* oformat_string_;
 659   bool emit_relocs_;
 660   bool is_relocatable_;
 661   Strip strip_;
 662   bool allow_shlib_undefined_;
 663   bool symbolic_;
 664   CompressionMethod compress_debug_sections_;
 665   bool demangle_;
 666   bool detect_odr_violations_;
 667   bool create_eh_frame_hdr_;
 668   Dir_list rpath_;
 669   Dir_list rpath_link_;
 670   bool is_shared_;
 671   bool is_static_;
 672   bool print_stats_;
 673   std::string sysroot_;
 674   uint64_t bss_segment_address_;
 675   uint64_t data_segment_address_;
 676   uint64_t text_segment_address_;
 677   bool threads_;
 678   int thread_count_initial_;
 679   int thread_count_middle_;
 680   int thread_count_final_;
 681   Execstack execstack_;
 682   uint64_t max_page_size_;
 683   uint64_t common_page_size_;
 684   unsigned int debug_;
 685 };
 686
 687 // The current state of the position dependent options.
 688
 689 class Position_dependent_options
 690 {
 691  public:
 692   typedef General_options::Object_format Object_format;
 693
 694   Position_dependent_options();
 695
 696   // -Bdynamic/-Bstatic: Whether we are searching for a static archive
 697   // -rather than a shared object.
 698   bool
 699   Bstatic() const
 700   { return this->do_static_search_; }
 701
 702   // --as-needed: Whether to add a DT_NEEDED argument only if the
 703   // dynamic object is used.
 704   bool
 705   as_needed() const
 706   { return this->as_needed_; }
 707
 708   // --whole-archive: Whether to include the entire contents of an
 709   // --archive.
 710   bool
 711   whole_archive() const
 712   { return this->include_whole_archive_; }
 713
 714   // --format: The format of the input file.
 715   Object_format
 716   format() const
 717   { return this->input_format_; }
 718
 719   void
 720   set_Bstatic(bool value)
 721   { this->do_static_search_ = value; }
 722
 723   void
 724   set_Bdynamic(bool value)
 725   { this->set_Bstatic(!value); }
 726
 727   void
 728   set_as_needed(bool value)
 729   { this->as_needed_ = value; }
 730
 731   void
 732   set_no_as_needed(bool value)
 733   { this->set_as_needed(!value); }
 734
 735   void
 736   set_whole_archive(bool value)
 737   { this->include_whole_archive_ = value; }
 738
 739   void
 740   set_no_whole_archive(bool value)
 741   { this->set_whole_archive(!value); }
 742
 743   void
 744   set_format(const char*);
 745
 746  private:
 747   bool do_static_search_;
 748   bool as_needed_;
 749   bool include_whole_archive_;
 750   Object_format input_format_;
 751 };
 752
 753 // A single file or library argument from the command line.
 754
 755 class Input_file_argument
 756 {
 757  public:
 758   // name: file name or library name
 759   // is_lib: true if name is a library name: that is, emits the leading
 760   //         "lib" and trailing ".so"/".a" from the name
 761   // extra_search_path: an extra directory to look for the file, prior
 762   //         to checking the normal library search path.  If this is "",
 763   //         then no extra directory is added.
 764   // just_symbols: whether this file only defines symbols.
 765   // options: The position dependent options at this point in the
 766   //         command line, such as --whole-archive.
 767   Input_file_argument()
 768     : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false),
 769       options_()
 770   { }
 771
 772   Input_file_argument(const char* name, bool is_lib,
 773                       const char* extra_search_path,
 774                       bool just_symbols,
 775                       const Position_dependent_options& options)
 776     : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
 777       just_symbols_(just_symbols), options_(options)
 778   { }
 779
 780   const char*
 781   name() const
 782   { return this->name_.c_str(); }
 783
 784   const Position_dependent_options&
 785   options() const
 786   { return this->options_; }
 787
 788   bool
 789   is_lib() const
 790   { return this->is_lib_; }
 791
 792   const char*
 793   extra_search_path() const
 794   {
 795     return (this->extra_search_path_.empty()
 796             ? NULL
 797             : this->extra_search_path_.c_str());
 798   }
 799
 800   // Return whether we should only read symbols from this file.
 801   bool
 802   just_symbols() const
 803   { return this->just_symbols_; }
 804
 805   // Return whether this file may require a search using the -L
 806   // options.
 807   bool
 808   may_need_search() const
 809   { return this->is_lib_ || !this->extra_search_path_.empty(); }
 810
 811  private:
 812   // We use std::string, not const char*, here for convenience when
 813   // using script files, so that we do not have to preserve the string
 814   // in that case.
 815   std::string name_;
 816   bool is_lib_;
 817   std::string extra_search_path_;
 818   bool just_symbols_;
 819   Position_dependent_options options_;
 820 };
 821
 822 // A file or library, or a group, from the command line.
 823
 824 class Input_argument
 825 {
 826  public:
 827   // Create a file or library argument.
 828   explicit Input_argument(Input_file_argument file)
 829     : is_file_(true), file_(file), group_(NULL)
 830   { }
 831
 832   // Create a group argument.
 833   explicit Input_argument(Input_file_group* group)
 834     : is_file_(false), group_(group)
 835   { }
 836
 837   // Return whether this is a file.
 838   bool
 839   is_file() const
 840   { return this->is_file_; }
 841
 842   // Return whether this is a group.
 843   bool
 844   is_group() const
 845   { return !this->is_file_; }
 846
 847   // Return the information about the file.
 848   const Input_file_argument&
 849   file() const
 850   {
 851     gold_assert(this->is_file_);
 852     return this->file_;
 853   }
 854
 855   // Return the information about the group.
 856   const Input_file_group*
 857   group() const
 858   {
 859     gold_assert(!this->is_file_);
 860     return this->group_;
 861   }
 862
 863   Input_file_group*
 864   group()
 865   {
 866     gold_assert(!this->is_file_);
 867     return this->group_;
 868   }
 869
 870  private:
 871   bool is_file_;
 872   Input_file_argument file_;
 873   Input_file_group* group_;
 874 };
 875
 876 // A group from the command line.  This is a set of arguments within
 877 // --start-group ... --end-group.
 878
 879 class Input_file_group
 880 {
 881  public:
 882   typedef std::vector<Input_argument> Files;
 883   typedef Files::const_iterator const_iterator;
 884
 885   Input_file_group()
 886     : files_()
 887   { }
 888
 889   // Add a file to the end of the group.
 890   void
 891   add_file(const Input_file_argument& arg)
 892   { this->files_.push_back(Input_argument(arg)); }
 893
 894   // Iterators to iterate over the group contents.
 895
 896   const_iterator
 897   begin() const
 898   { return this->files_.begin(); }
 899
 900   const_iterator
 901   end() const
 902   { return this->files_.end(); }
 903
 904  private:
 905   Files files_;
 906 };
 907
 908 // A list of files from the command line or a script.
 909
 910 class Input_arguments
 911 {
 912  public:
 913   typedef std::vector<Input_argument> Input_argument_list;
 914   typedef Input_argument_list::const_iterator const_iterator;
 915
 916   Input_arguments()
 917     : input_argument_list_(), in_group_(false)
 918   { }
 919
 920   // Add a file.
 921   void
 922   add_file(const Input_file_argument& arg);
 923
 924   // Start a group (the --start-group option).
 925   void
 926   start_group();
 927
 928   // End a group (the --end-group option).
 929   void
 930   end_group();
 931
 932   // Return whether we are currently in a group.
 933   bool
 934   in_group() const
 935   { return this->in_group_; }
 936
 937   // The number of entries in the list.
 938   int
 939   size() const
 940   { return this->input_argument_list_.size(); }
 941
 942   // Iterators to iterate over the list of input files.
 943
 944   const_iterator
 945   begin() const
 946   { return this->input_argument_list_.begin(); }
 947
 948   const_iterator
 949   end() const
 950   { return this->input_argument_list_.end(); }
 951
 952   // Return whether the list is empty.
 953   bool
 954   empty() const
 955   { return this->input_argument_list_.empty(); }
 956
 957  private:
 958   Input_argument_list input_argument_list_;
 959   bool in_group_;
 960 };
 961
 962 // All the information read from the command line.
 963
 964 class Command_line
 965 {
 966  public:
 967   typedef Input_arguments::const_iterator const_iterator;
 968
 969   Command_line();
 970
 971   // Process the command line options.  This will exit with an
 972   // appropriate error message if an unrecognized option is seen.
 973   void
 974   process(int argc, char** argv);
 975
 976   // Process one command-line option.  This takes the index of argv to
 977   // process, and returns the index for the next option.
 978   int
 979   process_one_option(int argc, char** argv, int i, bool* no_more_options);
 980
 981   // Handle a -l option.
 982   int
 983   process_l_option(int, char**, char*, bool);
 984
 985   // Handle a -R option when it means --rpath.
 986   void
 987   add_to_rpath(const char* arg)
 988   { this->options_.add_to_rpath(arg); }
 989
 990   // Add a file for which we just read the symbols.
 991   void
 992   add_just_symbols_file(const char* arg)
 993   {
 994     this->inputs_.add_file(Input_file_argument(arg, false, "", true,
 995                                                this->position_options_));
 996   }
 997
 998   // Handle a --start-group option.
 999   void
1000   start_group(const char* arg);
1001
1002   // Handle a --end-group option.
1003   void
1004   end_group(const char* arg);
1005
1006   // Get an option argument--a helper function for special processing.
1007   const char*
1008   get_special_argument(const char* longname, int argc, char** argv,
1009                        const char* arg, bool long_option,
1010                        int *pret);
1011
1012   // Get the general options.
1013   const General_options&
1014   options() const
1015   { return this->options_; }
1016
1017   // Get the position dependent options.
1018   const Position_dependent_options&
1019   position_dependent_options() const
1020   { return this->position_options_; }
1021
1022   // Get the linker-script options.
1023   Script_options&
1024   script_options()
1025   { return this->script_options_; }
1026
1027   // Get the version-script options: a convenience routine.
1028   const Version_script_info&
1029   version_script() const
1030   { return *this->script_options_.version_script_info(); }
1031
1032   // The number of input files.
1033   int
1034   number_of_input_files() const
1035   { return this->inputs_.size(); }
1036
1037   // Iterators to iterate over the list of input files.
1038
1039   const_iterator
1040   begin() const
1041   { return this->inputs_.begin(); }
1042
1043   const_iterator
1044   end() const
1045   { return this->inputs_.end(); }
1046
1047  private:
1048   Command_line(const Command_line&);
1049   Command_line& operator=(const Command_line&);
1050
1051   // Report usage error.
1052   void
1053   usage() ATTRIBUTE_NORETURN;
1054   void
1055   usage(const char* msg, const char* opt) ATTRIBUTE_NORETURN;
1056   void
1057   usage(const char* msg, char opt) ATTRIBUTE_NORETURN;
1058
1059   // Apply a command line option.
1060   void
1061   apply_option(const gold::options::One_option&, const char*);
1062
1063   // Add a file.
1064   void
1065   add_file(const char* name, bool is_lib);
1066
1067   // Examine the result of processing the command-line, and verify
1068   // the flags do not contradict each other or are otherwise illegal.
1069   void
1070   normalize_options();
1071
1072   General_options options_;
1073   Position_dependent_options position_options_;
1074   Script_options script_options_;
1075   Input_arguments inputs_;
1076 };
1077
1078 } // End namespace gold.
1079
1080 #endif // !defined(GOLD_OPTIONS_H)