gold/options.h

   1 // options.h -- handle command line options for gold  -*- C++ -*-
   2
   3 // Copyright 2006, 2007 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 namespace gold
  41 {
  42
  43 class Command_line;
  44 class Input_file_group;
  45
  46 namespace options {
  47
  48 class Command_line_options;
  49 struct One_option;
  50
  51 } // End namespace gold::options.
  52
  53 // A directory to search.  For each directory we record whether it is
  54 // in the sysroot.  We need to know this so that, if a linker script
  55 // is found within the sysroot, we will apply the sysroot to any files
  56 // named by that script.
  57
  58 class Search_directory
  59 {
  60  public:
  61   // We need a default constructor because we put this in a
  62   // std::vector.
  63   Search_directory()
  64     : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
  65   { }
  66
  67   // This is the usual constructor.
  68   Search_directory(const char* name, bool put_in_sysroot)
  69     : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
  70   { gold_assert(!this->name_.empty()); }
  71
  72   // This is called if we have a sysroot.  The sysroot is prefixed to
  73   // any entries for which put_in_sysroot_ is true.  is_in_sysroot_ is
  74   // set to true for any enries which are in the sysroot (this will
  75   // naturally include any entries for which put_in_sysroot_ is true).
  76   // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
  77   // passing SYSROOT to lrealpath.
  78   void
  79   add_sysroot(const char* sysroot, const char* canonical_sysroot);
  80
  81   // Get the directory name.
  82   const std::string&
  83   name() const
  84   { return this->name_; }
  85
  86   // Return whether this directory is in the sysroot.
  87   bool
  88   is_in_sysroot() const
  89   { return this->is_in_sysroot_; }
  90
  91  private:
  92   std::string name_;
  93   bool put_in_sysroot_;
  94   bool is_in_sysroot_;
  95 };
  96
  97 // The position independent options which apply to the whole link.
  98 // There are a lot of them.
  99
 100 class General_options
 101 {
 102  public:
 103   General_options();
 104
 105   // -E: export dynamic symbols.
 106   bool
 107   export_dynamic() const
 108   { return this->export_dynamic_; }
 109
 110   // -I: dynamic linker name.
 111   const char*
 112   dynamic_linker() const
 113   { return this->dynamic_linker_; }
 114
 115   // -L: Library search path.
 116   typedef std::vector<Search_directory> Dir_list;
 117
 118   const Dir_list&
 119   search_path() const
 120   { return this->search_path_; }
 121
 122   // -O: optimization level (0: don't try to optimize output size).
 123   int
 124   optimization_level() const
 125   { return this->optimization_level_; }
 126
 127   // -o: Output file name.
 128   const char*
 129   output_file_name() const
 130   { return this->output_file_name_; }
 131
 132   // -r: Whether we are doing a relocatable link.
 133   bool
 134   is_relocatable() const
 135   { return this->is_relocatable_; }
 136
 137   // -s: Strip all symbols.
 138   bool
 139   strip_all() const
 140   { return this->strip_ == STRIP_ALL; }
 141
 142   // -S: Strip debugging information.
 143   bool
 144   strip_debug() const
 145   { return this->strip_ == STRIP_ALL || this->strip_ == STRIP_DEBUG; }
 146
 147   // --eh-frame-hdr: Whether to generate an exception frame header.
 148   bool
 149   create_eh_frame_hdr() const
 150   { return this->create_eh_frame_hdr_; }
 151
 152   // --rpath: The runtime search path.
 153   const Dir_list&
 154   rpath() const
 155   { return this->rpath_; }
 156
 157   // --rpath-link: The link time search patch for shared libraries.
 158   const Dir_list&
 159   rpath_link() const
 160   { return this->rpath_link_; }
 161
 162   // --shared: Whether generating a shared object.
 163   bool
 164   is_shared() const
 165   { return this->is_shared_; }
 166
 167   // --static: Whether doing a static link.
 168   bool
 169   is_static() const
 170   { return this->is_static_; }
 171
 172   // --statis: Print resource usage statistics.
 173   bool
 174   print_stats() const
 175   { return this->print_stats_; }
 176
 177   // --sysroot: The system root of a cross-linker.
 178   const std::string&
 179   sysroot() const
 180   { return this->sysroot_; }
 181
 182  private:
 183   // Don't copy this structure.
 184   General_options(const General_options&);
 185   General_options& operator=(const General_options&);
 186
 187   friend class Command_line;
 188   friend class options::Command_line_options;
 189
 190   // Which symbols to strip.
 191   enum Strip
 192   {
 193     // Don't strip any symbols.
 194     STRIP_NONE,
 195     // Strip all symbols.
 196     STRIP_ALL,
 197     // Strip debugging information.
 198     STRIP_DEBUG
 199   };
 200
 201   void
 202   set_export_dynamic()
 203   { this->export_dynamic_ = true; }
 204
 205   void
 206   set_dynamic_linker(const char* arg)
 207   { this->dynamic_linker_ = arg; }
 208
 209   void
 210   add_to_search_path(const char* arg)
 211   { this->search_path_.push_back(Search_directory(arg, false)); }
 212
 213   void
 214   add_to_search_path_with_sysroot(const char* arg)
 215   { this->search_path_.push_back(Search_directory(arg, true)); }
 216
 217   void
 218   set_optimization_level(const char* arg)
 219   { this->optimization_level_ = atoi(arg); }
 220
 221   void
 222   set_output_file_name(const char* arg)
 223   { this->output_file_name_ = arg; }
 224
 225   void
 226   set_relocatable()
 227   { this->is_relocatable_ = true; }
 228
 229   void
 230   set_strip_all()
 231   { this->strip_ = STRIP_ALL; }
 232
 233   // Note: normalize_options() depends on the fact that this turns off
 234   // STRIP_ALL if it were already set.
 235   void
 236   set_strip_debug()
 237   { this->strip_ = STRIP_DEBUG; }
 238
 239   void
 240   set_create_eh_frame_hdr()
 241   { this->create_eh_frame_hdr_ = true; }
 242
 243   void
 244   add_to_rpath(const char* arg)
 245   { this->rpath_.push_back(Search_directory(arg, false)); }
 246
 247   void
 248   add_to_rpath_link(const char* arg)
 249   { this->rpath_link_.push_back(Search_directory(arg, false)); }
 250
 251   void
 252   set_shared()
 253   { this->is_shared_ = true; }
 254
 255   void
 256   set_static()
 257   { this->is_static_ = true; }
 258
 259   void
 260   set_stats()
 261   { this->print_stats_ = true; }
 262
 263   void
 264   set_sysroot(const char* arg)
 265   { this->sysroot_ = arg; }
 266
 267   void
 268   ignore(const char*)
 269   { }
 270
 271   // Apply any sysroot to the directory lists.
 272   void
 273   add_sysroot();
 274
 275   bool export_dynamic_;
 276   const char* dynamic_linker_;
 277   Dir_list search_path_;
 278   int optimization_level_;
 279   const char* output_file_name_;
 280   bool is_relocatable_;
 281   Strip strip_;
 282   bool create_eh_frame_hdr_;
 283   Dir_list rpath_;
 284   Dir_list rpath_link_;
 285   bool is_shared_;
 286   bool is_static_;
 287   bool print_stats_;
 288   std::string sysroot_;
 289 };
 290
 291 // The current state of the position dependent options.
 292
 293 class Position_dependent_options
 294 {
 295  public:
 296   Position_dependent_options();
 297
 298   // -Bstatic: Whether we are searching for a static archive rather
 299   // than a shared object.
 300   bool
 301   do_static_search() const
 302   { return this->do_static_search_; }
 303
 304   // --as-needed: Whether to add a DT_NEEDED argument only if the
 305   // dynamic object is used.
 306   bool
 307   as_needed() const
 308   { return this->as_needed_; }
 309
 310   // --whole-archive: Whether to include the entire contents of an
 311   // --archive.
 312   bool
 313   include_whole_archive() const
 314   { return this->include_whole_archive_; }
 315
 316   void
 317   set_static_search()
 318   { this->do_static_search_ = true; }
 319
 320   void
 321   set_dynamic_search()
 322   { this->do_static_search_ = false; }
 323
 324   void
 325   set_as_needed()
 326   { this->as_needed_ = true; }
 327
 328   void
 329   clear_as_needed()
 330   { this->as_needed_ = false; }
 331
 332   void
 333   set_whole_archive()
 334   { this->include_whole_archive_ = true; }
 335
 336   void
 337   clear_whole_archive()
 338   { this->include_whole_archive_ = false; }
 339
 340  private:
 341   bool do_static_search_;
 342   bool as_needed_;
 343   bool include_whole_archive_;
 344 };
 345
 346 // A single file or library argument from the command line.
 347
 348 class Input_file_argument
 349 {
 350  public:
 351   // name: file name or library name
 352   // is_lib: true if name is a library name: that is, emits the leading
 353   //         "lib" and trailing ".so"/".a" from the name
 354   // extra_search_path: an extra directory to look for the file, prior
 355   //         to checking the normal library search path.  If this is "",
 356   //         then no extra directory is added.
 357   // options: The position dependent options at this point in the
 358   //         command line, such as --whole-archive.
 359   Input_file_argument()
 360     : name_(), is_lib_(false), extra_search_path_(""), options_()
 361   { }
 362
 363   Input_file_argument(const char* name, bool is_lib,
 364                       const char* extra_search_path,
 365                       const Position_dependent_options& options)
 366     : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
 367       options_(options)
 368   { }
 369
 370   const char*
 371   name() const
 372   { return this->name_.c_str(); }
 373
 374   const Position_dependent_options&
 375   options() const
 376   { return this->options_; }
 377
 378   bool
 379   is_lib() const
 380   { return this->is_lib_; }
 381
 382   const char*
 383   extra_search_path() const
 384   {
 385     return (this->extra_search_path_.empty()
 386             ? NULL
 387             : this->extra_search_path_.c_str());
 388   }
 389
 390   // Return whether this file may require a search using the -L
 391   // options.
 392   bool
 393   may_need_search() const
 394   { return this->is_lib_ || !this->extra_search_path_.empty(); }
 395
 396  private:
 397   // We use std::string, not const char*, here for convenience when
 398   // using script files, so that we do not have to preserve the string
 399   // in that case.
 400   std::string name_;
 401   bool is_lib_;
 402   std::string extra_search_path_;
 403   Position_dependent_options options_;
 404 };
 405
 406 // A file or library, or a group, from the command line.
 407
 408 class Input_argument
 409 {
 410  public:
 411   // Create a file or library argument.
 412   explicit Input_argument(Input_file_argument file)
 413     : is_file_(true), file_(file), group_(NULL)
 414   { }
 415
 416   // Create a group argument.
 417   explicit Input_argument(Input_file_group* group)
 418     : is_file_(false), group_(group)
 419   { }
 420
 421   // Return whether this is a file.
 422   bool
 423   is_file() const
 424   { return this->is_file_; }
 425
 426   // Return whether this is a group.
 427   bool
 428   is_group() const
 429   { return !this->is_file_; }
 430
 431   // Return the information about the file.
 432   const Input_file_argument&
 433   file() const
 434   {
 435     gold_assert(this->is_file_);
 436     return this->file_;
 437   }
 438
 439   // Return the information about the group.
 440   const Input_file_group*
 441   group() const
 442   {
 443     gold_assert(!this->is_file_);
 444     return this->group_;
 445   }
 446
 447   Input_file_group*
 448   group()
 449   {
 450     gold_assert(!this->is_file_);
 451     return this->group_;
 452   }
 453
 454  private:
 455   bool is_file_;
 456   Input_file_argument file_;
 457   Input_file_group* group_;
 458 };
 459
 460 // A group from the command line.  This is a set of arguments within
 461 // --start-group ... --end-group.
 462
 463 class Input_file_group
 464 {
 465  public:
 466   typedef std::vector<Input_argument> Files;
 467   typedef Files::const_iterator const_iterator;
 468
 469   Input_file_group()
 470     : files_()
 471   { }
 472
 473   // Add a file to the end of the group.
 474   void
 475   add_file(const Input_file_argument& arg)
 476   { this->files_.push_back(Input_argument(arg)); }
 477
 478   // Iterators to iterate over the group contents.
 479
 480   const_iterator
 481   begin() const
 482   { return this->files_.begin(); }
 483
 484   const_iterator
 485   end() const
 486   { return this->files_.end(); }
 487
 488  private:
 489   Files files_;
 490 };
 491
 492 // A list of files from the command line or a script.
 493
 494 class Input_arguments
 495 {
 496  public:
 497   typedef std::vector<Input_argument> Input_argument_list;
 498   typedef Input_argument_list::const_iterator const_iterator;
 499
 500   Input_arguments()
 501     : input_argument_list_(), in_group_(false)
 502   { }
 503
 504   // Add a file.
 505   void
 506   add_file(const Input_file_argument& arg);
 507
 508   // Start a group (the --start-group option).
 509   void
 510   start_group();
 511
 512   // End a group (the --end-group option).
 513   void
 514   end_group();
 515
 516   // Return whether we are currently in a group.
 517   bool
 518   in_group() const
 519   { return this->in_group_; }
 520
 521   // Iterators to iterate over the list of input files.
 522
 523   const_iterator
 524   begin() const
 525   { return this->input_argument_list_.begin(); }
 526
 527   const_iterator
 528   end() const
 529   { return this->input_argument_list_.end(); }
 530
 531   // Return whether the list is empty.
 532   bool
 533   empty() const
 534   { return this->input_argument_list_.empty(); }
 535
 536  private:
 537   Input_argument_list input_argument_list_;
 538   bool in_group_;
 539 };
 540
 541 // All the information read from the command line.
 542
 543 class Command_line
 544 {
 545  public:
 546   typedef Input_arguments::const_iterator const_iterator;
 547
 548   Command_line();
 549
 550   // Process the command line options.  This will exit with an
 551   // appropriate error message if an unrecognized option is seen.
 552   void
 553   process(int argc, char** argv);
 554
 555   // Handle a -l option.
 556   int
 557   process_l_option(int, char**, char*);
 558
 559   // Handle a --start-group option.
 560   void
 561   start_group(const char* arg);
 562
 563   // Handle a --end-group option.
 564   void
 565   end_group(const char* arg);
 566
 567   // Get the general options.
 568   const General_options&
 569   options() const
 570   { return this->options_; }
 571
 572   // Iterators to iterate over the list of input files.
 573
 574   const_iterator
 575   begin() const
 576   { return this->inputs_.begin(); }
 577
 578   const_iterator
 579   end() const
 580   { return this->inputs_.end(); }
 581
 582  private:
 583   Command_line(const Command_line&);
 584   Command_line& operator=(const Command_line&);
 585
 586   // Report usage error.
 587   void
 588   usage() ATTRIBUTE_NORETURN;
 589   void
 590   usage(const char* msg, const char* opt) ATTRIBUTE_NORETURN;
 591   void
 592   usage(const char* msg, char opt) ATTRIBUTE_NORETURN;
 593
 594   // Apply a command line option.
 595   void
 596   apply_option(const gold::options::One_option&, const char*);
 597
 598   // Add a file.
 599   void
 600   add_file(const char* name, bool is_lib);
 601
 602   // Examine the result of processing the command-line, and verify
 603   // the flags do not contradict each other or are otherwise illegal.
 604   void
 605   normalize_options();
 606
 607   General_options options_;
 608   Position_dependent_options position_options_;
 609   Input_arguments inputs_;
 610 };
 611
 612 } // End namespace gold.
 613
 614 #endif // !defined(GOLD_OPTIONS_H)