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   // --sysroot: The system root of a cross-linker.
 173   const std::string&
 174   sysroot() const
 175   { return this->sysroot_; }
 176
 177  private:
 178   // Don't copy this structure.
 179   General_options(const General_options&);
 180   General_options& operator=(const General_options&);
 181
 182   friend class Command_line;
 183   friend class options::Command_line_options;
 184
 185   // Which symbols to strip.
 186   enum Strip
 187   {
 188     // Don't strip any symbols.
 189     STRIP_NONE,
 190     // Strip all symbols.
 191     STRIP_ALL,
 192     // Strip debugging information.
 193     STRIP_DEBUG
 194   };
 195
 196   void
 197   set_export_dynamic()
 198   { this->export_dynamic_ = true; }
 199
 200   void
 201   set_dynamic_linker(const char* arg)
 202   { this->dynamic_linker_ = arg; }
 203
 204   void
 205   add_to_search_path(const char* arg)
 206   { this->search_path_.push_back(Search_directory(arg, false)); }
 207
 208   void
 209   add_to_search_path_with_sysroot(const char* arg)
 210   { this->search_path_.push_back(Search_directory(arg, true)); }
 211
 212   void
 213   set_optimization_level(const char* arg)
 214   { this->optimization_level_ = atoi(arg); }
 215
 216   void
 217   set_output_file_name(const char* arg)
 218   { this->output_file_name_ = arg; }
 219
 220   void
 221   set_relocatable()
 222   { this->is_relocatable_ = true; }
 223
 224   void
 225   set_strip_all()
 226   { this->strip_ = STRIP_ALL; }
 227
 228   // Note: normalize_options() depends on the fact that this turns off
 229   // STRIP_ALL if it were already set.
 230   void
 231   set_strip_debug()
 232   { this->strip_ = STRIP_DEBUG; }
 233
 234   void
 235   set_create_eh_frame_hdr()
 236   { this->create_eh_frame_hdr_ = true; }
 237
 238   void
 239   add_to_rpath(const char* arg)
 240   { this->rpath_.push_back(Search_directory(arg, false)); }
 241
 242   void
 243   add_to_rpath_link(const char* arg)
 244   { this->rpath_link_.push_back(Search_directory(arg, false)); }
 245
 246   void
 247   set_shared()
 248   { this->is_shared_ = true; }
 249
 250   void
 251   set_static()
 252   { this->is_static_ = true; }
 253
 254   void
 255   set_sysroot(const char* arg)
 256   { this->sysroot_ = arg; }
 257
 258   void
 259   ignore(const char*)
 260   { }
 261
 262   // Apply any sysroot to the directory lists.
 263   void
 264   add_sysroot();
 265
 266   bool export_dynamic_;
 267   const char* dynamic_linker_;
 268   Dir_list search_path_;
 269   int optimization_level_;
 270   const char* output_file_name_;
 271   bool is_relocatable_;
 272   Strip strip_;
 273   bool create_eh_frame_hdr_;
 274   Dir_list rpath_;
 275   Dir_list rpath_link_;
 276   bool is_shared_;
 277   bool is_static_;
 278   std::string sysroot_;
 279 };
 280
 281 // The current state of the position dependent options.
 282
 283 class Position_dependent_options
 284 {
 285  public:
 286   Position_dependent_options();
 287
 288   // -Bstatic: Whether we are searching for a static archive rather
 289   // than a shared object.
 290   bool
 291   do_static_search() const
 292   { return this->do_static_search_; }
 293
 294   // --as-needed: Whether to add a DT_NEEDED argument only if the
 295   // dynamic object is used.
 296   bool
 297   as_needed() const
 298   { return this->as_needed_; }
 299
 300   // --whole-archive: Whether to include the entire contents of an
 301   // --archive.
 302   bool
 303   include_whole_archive() const
 304   { return this->include_whole_archive_; }
 305
 306   void
 307   set_static_search()
 308   { this->do_static_search_ = true; }
 309
 310   void
 311   set_dynamic_search()
 312   { this->do_static_search_ = false; }
 313
 314   void
 315   set_as_needed()
 316   { this->as_needed_ = true; }
 317
 318   void
 319   clear_as_needed()
 320   { this->as_needed_ = false; }
 321
 322   void
 323   set_whole_archive()
 324   { this->include_whole_archive_ = true; }
 325
 326   void
 327   clear_whole_archive()
 328   { this->include_whole_archive_ = false; }
 329
 330  private:
 331   bool do_static_search_;
 332   bool as_needed_;
 333   bool include_whole_archive_;
 334 };
 335
 336 // A single file or library argument from the command line.
 337
 338 class Input_file_argument
 339 {
 340  public:
 341   // name: file name or library name
 342   // is_lib: true if name is a library name: that is, emits the leading
 343   //         "lib" and trailing ".so"/".a" from the name
 344   // extra_search_path: an extra directory to look for the file, prior
 345   //         to checking the normal library search path.  If this is "",
 346   //         then no extra directory is added.
 347   // options: The position dependent options at this point in the
 348   //         command line, such as --whole-archive.
 349   Input_file_argument()
 350     : name_(), is_lib_(false), extra_search_path_(""), options_()
 351   { }
 352
 353   Input_file_argument(const char* name, bool is_lib,
 354                       const char* extra_search_path,
 355                       const Position_dependent_options& options)
 356     : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
 357       options_(options)
 358   { }
 359
 360   const char*
 361   name() const
 362   { return this->name_.c_str(); }
 363
 364   const Position_dependent_options&
 365   options() const
 366   { return this->options_; }
 367
 368   bool
 369   is_lib() const
 370   { return this->is_lib_; }
 371
 372   const char*
 373   extra_search_path() const
 374   {
 375     return (this->extra_search_path_.empty()
 376             ? NULL
 377             : this->extra_search_path_.c_str());
 378   }
 379
 380   // Return whether this file may require a search using the -L
 381   // options.
 382   bool
 383   may_need_search() const
 384   { return this->is_lib_ || !this->extra_search_path_.empty(); }
 385
 386  private:
 387   // We use std::string, not const char*, here for convenience when
 388   // using script files, so that we do not have to preserve the string
 389   // in that case.
 390   std::string name_;
 391   bool is_lib_;
 392   std::string extra_search_path_;
 393   Position_dependent_options options_;
 394 };
 395
 396 // A file or library, or a group, from the command line.
 397
 398 class Input_argument
 399 {
 400  public:
 401   // Create a file or library argument.
 402   explicit Input_argument(Input_file_argument file)
 403     : is_file_(true), file_(file), group_(NULL)
 404   { }
 405
 406   // Create a group argument.
 407   explicit Input_argument(Input_file_group* group)
 408     : is_file_(false), group_(group)
 409   { }
 410
 411   // Return whether this is a file.
 412   bool
 413   is_file() const
 414   { return this->is_file_; }
 415
 416   // Return whether this is a group.
 417   bool
 418   is_group() const
 419   { return !this->is_file_; }
 420
 421   // Return the information about the file.
 422   const Input_file_argument&
 423   file() const
 424   {
 425     gold_assert(this->is_file_);
 426     return this->file_;
 427   }
 428
 429   // Return the information about the group.
 430   const Input_file_group*
 431   group() const
 432   {
 433     gold_assert(!this->is_file_);
 434     return this->group_;
 435   }
 436
 437   Input_file_group*
 438   group()
 439   {
 440     gold_assert(!this->is_file_);
 441     return this->group_;
 442   }
 443
 444  private:
 445   bool is_file_;
 446   Input_file_argument file_;
 447   Input_file_group* group_;
 448 };
 449
 450 // A group from the command line.  This is a set of arguments within
 451 // --start-group ... --end-group.
 452
 453 class Input_file_group
 454 {
 455  public:
 456   typedef std::vector<Input_argument> Files;
 457   typedef Files::const_iterator const_iterator;
 458
 459   Input_file_group()
 460     : files_()
 461   { }
 462
 463   // Add a file to the end of the group.
 464   void
 465   add_file(const Input_file_argument& arg)
 466   { this->files_.push_back(Input_argument(arg)); }
 467
 468   // Iterators to iterate over the group contents.
 469
 470   const_iterator
 471   begin() const
 472   { return this->files_.begin(); }
 473
 474   const_iterator
 475   end() const
 476   { return this->files_.end(); }
 477
 478  private:
 479   Files files_;
 480 };
 481
 482 // A list of files from the command line or a script.
 483
 484 class Input_arguments
 485 {
 486  public:
 487   typedef std::vector<Input_argument> Input_argument_list;
 488   typedef Input_argument_list::const_iterator const_iterator;
 489
 490   Input_arguments()
 491     : input_argument_list_(), in_group_(false)
 492   { }
 493
 494   // Add a file.
 495   void
 496   add_file(const Input_file_argument& arg);
 497
 498   // Start a group (the --start-group option).
 499   void
 500   start_group();
 501
 502   // End a group (the --end-group option).
 503   void
 504   end_group();
 505
 506   // Return whether we are currently in a group.
 507   bool
 508   in_group() const
 509   { return this->in_group_; }
 510
 511   // Iterators to iterate over the list of input files.
 512
 513   const_iterator
 514   begin() const
 515   { return this->input_argument_list_.begin(); }
 516
 517   const_iterator
 518   end() const
 519   { return this->input_argument_list_.end(); }
 520
 521   // Return whether the list is empty.
 522   bool
 523   empty() const
 524   { return this->input_argument_list_.empty(); }
 525
 526  private:
 527   Input_argument_list input_argument_list_;
 528   bool in_group_;
 529 };
 530
 531 // All the information read from the command line.
 532
 533 class Command_line
 534 {
 535  public:
 536   typedef Input_arguments::const_iterator const_iterator;
 537
 538   Command_line();
 539
 540   // Process the command line options.  This will exit with an
 541   // appropriate error message if an unrecognized option is seen.
 542   void
 543   process(int argc, char** argv);
 544
 545   // Handle a -l option.
 546   int
 547   process_l_option(int, char**, char*);
 548
 549   // Handle a --start-group option.
 550   void
 551   start_group(const char* arg);
 552
 553   // Handle a --end-group option.
 554   void
 555   end_group(const char* arg);
 556
 557   // Get the general options.
 558   const General_options&
 559   options() const
 560   { return this->options_; }
 561
 562   // Iterators to iterate over the list of input files.
 563
 564   const_iterator
 565   begin() const
 566   { return this->inputs_.begin(); }
 567
 568   const_iterator
 569   end() const
 570   { return this->inputs_.end(); }
 571
 572  private:
 573   Command_line(const Command_line&);
 574   Command_line& operator=(const Command_line&);
 575
 576   // Report usage error.
 577   void
 578   usage() ATTRIBUTE_NORETURN;
 579   void
 580   usage(const char* msg, const char* opt) ATTRIBUTE_NORETURN;
 581   void
 582   usage(const char* msg, char opt) ATTRIBUTE_NORETURN;
 583
 584   // Apply a command line option.
 585   void
 586   apply_option(const gold::options::One_option&, const char*);
 587
 588   // Add a file.
 589   void
 590   add_file(const char* name, bool is_lib);
 591
 592   // Examine the result of processing the command-line, and verify
 593   // the flags do not contradict each other or are otherwise illegal.
 594   void
 595   normalize_options();
 596
 597   General_options options_;
 598   Position_dependent_options position_options_;
 599   Input_arguments inputs_;
 600 };
 601
 602 } // End namespace gold.
 603
 604 #endif // !defined(GOLD_OPTIONS_H)