// options.h -- handle command line options for gold -*- C++ -*-
+// Copyright 2006, 2007, 2008 Free Software Foundation, Inc.
+// Written by Ian Lance Taylor <iant@google.com>.
+
+// This file is part of gold.
+
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
+// MA 02110-1301, USA.
+
// Command_line
// Holds everything we get from the command line.
// General_options (from Command_line::options())
#ifndef GOLD_OPTIONS_H
#define GOLD_OPTIONS_H
+#include <cstdlib>
#include <list>
#include <string>
#include <vector>
+#include "elfcpp.h"
+#include "script.h"
+
namespace gold
{
class Command_line;
class Input_file_group;
+class Position_dependent_options;
+class Target;
-namespace options {
+namespace options
+{
class Command_line_options;
struct One_option;
+struct One_z_option;
+struct One_debug_option;
} // End namespace gold::options.
+// A directory to search. For each directory we record whether it is
+// in the sysroot. We need to know this so that, if a linker script
+// is found within the sysroot, we will apply the sysroot to any files
+// named by that script.
+
+class Search_directory
+{
+ public:
+ // We need a default constructor because we put this in a
+ // std::vector.
+ Search_directory()
+ : name_(NULL), put_in_sysroot_(false), is_in_sysroot_(false)
+ { }
+
+ // This is the usual constructor.
+ Search_directory(const char* name, bool put_in_sysroot)
+ : name_(name), put_in_sysroot_(put_in_sysroot), is_in_sysroot_(false)
+ {
+ if (this->name_.empty())
+ this->name_ = ".";
+ }
+
+ // This is called if we have a sysroot. The sysroot is prefixed to
+ // any entries for which put_in_sysroot_ is true. is_in_sysroot_ is
+ // set to true for any enries which are in the sysroot (this will
+ // naturally include any entries for which put_in_sysroot_ is true).
+ // SYSROOT is the sysroot, CANONICAL_SYSROOT is the result of
+ // passing SYSROOT to lrealpath.
+ void
+ add_sysroot(const char* sysroot, const char* canonical_sysroot);
+
+ // Get the directory name.
+ const std::string&
+ name() const
+ { return this->name_; }
+
+ // Return whether this directory is in the sysroot.
+ bool
+ is_in_sysroot() const
+ { return this->is_in_sysroot_; }
+
+ private:
+ std::string name_;
+ bool put_in_sysroot_;
+ bool is_in_sysroot_;
+};
+
// The position independent options which apply to the whole link.
// There are a lot of them.
class General_options
{
public:
+ enum Object_format
+ {
+ // Ordinary ELF.
+ OBJECT_FORMAT_ELF,
+ // Straight binary format.
+ OBJECT_FORMAT_BINARY
+ };
+
General_options();
+ // -e: set entry address.
+ const char*
+ entry() const
+ { return this->entry_; }
+
// -E: export dynamic symbols.
bool
export_dynamic() const
{ return this->export_dynamic_; }
+ // -h: shared library name.
+ const char*
+ soname() const
+ { return this->soname_; }
+
// -I: dynamic linker name.
const char*
dynamic_linker() const
{ return this->dynamic_linker_; }
// -L: Library search path.
- typedef std::vector<const char*> Dir_list;
+ typedef std::vector<Search_directory> Dir_list;
const Dir_list&
search_path() const
{ return this->search_path_; }
+ // -O: optimization level (0: don't try to optimize output size).
+ int
+ optimize() const
+ { return this->optimization_level_; }
+
// -o: Output file name.
const char*
output_file_name() const
{ return this->output_file_name_; }
+ // --oformat: Output format.
+ Object_format
+ oformat() const
+ { return this->oformat_; }
+
+ // Return the default target.
+ Target*
+ default_target() const;
+
// -r: Whether we are doing a relocatable link.
bool
- is_relocatable() const
+ relocatable() const
{ return this->is_relocatable_; }
+ // -s: Strip all symbols.
+ bool
+ strip_all() const
+ { return this->strip_ == STRIP_ALL; }
+
+ // -S: Strip debugging information.
+ bool
+ strip_debug() const
+ { return this->strip_ == STRIP_ALL || this->strip_ == STRIP_DEBUG; }
+
+ // --strip-debug-gdb: strip only debugging information that's not
+ // used by gdb (at least, for gdb versions <= 6.7).
+ bool
+ strip_debug_gdb() const
+ { return this->strip_debug() || this->strip_ == STRIP_DEBUG_UNUSED_BY_GDB; }
+
+ // --allow-shlib-undefined: do not warn about unresolved symbols in
+ // --shared libraries.
+ bool
+ allow_shlib_undefined() const
+ { return this->allow_shlib_undefined_; }
+
+ // -Bsymbolic: bind defined symbols locally.
+ bool
+ Bsymbolic() const
+ { return this->symbolic_; }
+
+ // --compress-debug-sections: compress .debug_* sections in the
+ // output file using the given compression method. This is useful
+ // when the tools (such as gdb) support compressed sections.
+ bool
+ compress_debug_sections() const
+ { return this->compress_debug_sections_ != NO_COMPRESSION; }
+
+ bool
+ zlib_compress_debug_sections() const
+ { return this->compress_debug_sections_ == ZLIB_COMPRESSION; }
+
+ // --demangle: demangle C++ symbols in our log messages.
+ bool
+ demangle() const
+ { return this->demangle_; }
+
+ // --detect-odr-violations: Whether to search for One Defn Rule violations.
+ bool
+ detect_odr_violations() const
+ { return this->detect_odr_violations_; }
+
// --eh-frame-hdr: Whether to generate an exception frame header.
bool
- create_eh_frame_hdr() const
+ eh_frame_hdr() const
{ return this->create_eh_frame_hdr_; }
// --rpath: The runtime search path.
// --shared: Whether generating a shared object.
bool
- is_shared() const
+ shared() const
{ return this->is_shared_; }
// --static: Whether doing a static link.
is_static() const
{ return this->is_static_; }
+ // --stats: Print resource usage statistics.
+ bool
+ print_stats() const
+ { return this->print_stats_; }
+
+ // --sysroot: The system root of a cross-linker.
+ const std::string&
+ sysroot() const
+ { return this->sysroot_; }
+
+ // -Tbss: The address of the BSS segment
+ uint64_t
+ Tbss() const
+ { return this->bss_segment_address_; }
+
+ // Whether -Tbss was used.
+ bool
+ user_set_Tbss() const
+ { return this->bss_segment_address_ != -1U; }
+
+ // -Tdata: The address of the data segment
+ uint64_t
+ Tdata() const
+ { return this->data_segment_address_; }
+
+ // Whether -Tdata was used.
+ bool
+ user_set_Tdata() const
+ { return this->data_segment_address_ != -1U; }
+
+ // -Ttext: The address of the .text section
+ uint64_t
+ Ttext() const
+ { return this->text_segment_address_; }
+
+ // Whether -Ttext was used.
+ bool
+ user_set_Ttext() const
+ { return this->text_segment_address_ != -1U; }
+
+ // --threads: Whether to use threads.
+ bool
+ threads() const
+ { return this->threads_; }
+
+ // --thread-count-initial: Threads to use in initial pass.
+ int
+ thread_count_initial() const
+ { return this->thread_count_initial_; }
+
+ // --thread-count-middle: Threads to use in middle pass.
+ int
+ thread_count_middle() const
+ { return this->thread_count_middle_; }
+
+ // --thread-count-final: Threads to use in final pass.
+ int
+ thread_count_final() const
+ { return this->thread_count_final_; }
+
+ // -z execstack, -z noexecstack
+ bool
+ is_execstack_set() const
+ { return this->execstack_ != EXECSTACK_FROM_INPUT; }
+
+ bool
+ is_stack_executable() const
+ { return this->execstack_ == EXECSTACK_YES; }
+
+ // -z max-page-size
+ uint64_t
+ max_page_size() const
+ { return this->max_page_size_; }
+
+ // -z common-page-size
+ uint64_t
+ common_page_size() const
+ { return this->common_page_size_; }
+
+ // --debug
+ unsigned int
+ debug() const
+ { return this->debug_; }
+
private:
// Don't copy this structure.
General_options(const General_options&);
friend class Command_line;
friend class options::Command_line_options;
+ // Which symbols to strip.
+ enum Strip
+ {
+ // Don't strip any symbols.
+ STRIP_NONE,
+ // Strip all symbols.
+ STRIP_ALL,
+ // Strip debugging information.
+ STRIP_DEBUG,
+ // Strip debugging information that's not used by gdb (at least <= 6.7)
+ STRIP_DEBUG_UNUSED_BY_GDB
+ };
+
+ // Whether to mark the stack as executable.
+ enum Execstack
+ {
+ // Not set on command line.
+ EXECSTACK_FROM_INPUT,
+ // Mark the stack as executable.
+ EXECSTACK_YES,
+ // Mark the stack as not executable.
+ EXECSTACK_NO
+ };
+
+ // What compression method to use
+ enum CompressionMethod
+ {
+ NO_COMPRESSION,
+ ZLIB_COMPRESSION,
+ };
+
void
- set_export_dynamic()
- { this->export_dynamic_ = true; }
+ set_entry(const char* arg)
+ { this->entry_ = arg; }
+
+ void
+ set_export_dynamic(bool value)
+ { this->export_dynamic_ = value; }
+
+ void
+ set_soname(const char* arg)
+ { this->soname_ = arg; }
void
set_dynamic_linker(const char* arg)
void
add_to_search_path(const char* arg)
- { this->search_path_.push_back(arg); }
+ { this->search_path_.push_back(Search_directory(arg, false)); }
void
- set_output_file_name(const char* arg)
+ add_to_search_path_with_sysroot(const char* arg)
+ { this->search_path_.push_back(Search_directory(arg, true)); }
+
+ void
+ set_optimize(const char* arg)
+ {
+ char* endptr;
+ this->optimization_level_ = strtol(arg, &endptr, 0);
+ if (*endptr != '\0' || this->optimization_level_ < 0)
+ gold_fatal(_("invalid optimization level: %s"), arg);
+ }
+
+ void
+ set_output(const char* arg)
{ this->output_file_name_ = arg; }
void
- set_relocatable()
- { this->is_relocatable_ = true; }
+ set_oformat(const char*);
+
+ void
+ set_relocatable(bool value)
+ { this->is_relocatable_ = value; }
+
+ void
+ set_strip_all(bool)
+ { this->strip_ = STRIP_ALL; }
+
+ // Note: normalize_options() depends on the fact that this turns off
+ // STRIP_ALL if it were already set.
+ void
+ set_strip_debug(bool)
+ { this->strip_ = STRIP_DEBUG; }
+
+ void
+ set_strip_debug_gdb(bool)
+ { this->strip_ = STRIP_DEBUG_UNUSED_BY_GDB; }
+
+ void
+ set_allow_shlib_undefined(bool value)
+ { this->allow_shlib_undefined_ = value; }
+
+ void
+ set_no_allow_shlib_undefined(bool value)
+ { this->set_allow_shlib_undefined(!value); }
+
+ void
+ set_Bsymbolic(bool value)
+ { this->symbolic_ = value; }
+
+ void set_compress_debug_sections(const char* arg)
+ {
+ if (strcmp(arg, "none") == 0)
+ this->compress_debug_sections_ = NO_COMPRESSION;
+#ifdef HAVE_ZLIB_H
+ else if (strcmp(arg, "zlib") == 0)
+ this->compress_debug_sections_ = ZLIB_COMPRESSION;
+#endif
+ else
+ gold_fatal(_("unsupported argument to --compress-debug-sections: %s"),
+ arg);
+ }
+
+ void
+ add_to_defsym(const char* arg);
+
+ void
+ set_demangle(bool value)
+ { this->demangle_ = value; }
+
+ void
+ set_no_demangle(bool value)
+ { this->set_demangle(!value); }
+
+ void
+ set_detect_odr_violations(bool value)
+ { this->detect_odr_violations_ = value; }
void
- create_eh_frame_hdr()
- { this->create_eh_frame_hdr_ = true; }
+ set_eh_frame_hdr(bool value)
+ { this->create_eh_frame_hdr_ = value; }
void
add_to_rpath(const char* arg)
- { this->rpath_.push_back(arg); }
+ { this->rpath_.push_back(Search_directory(arg, false)); }
void
add_to_rpath_link(const char* arg)
- { this->rpath_link_.push_back(arg); }
+ { this->rpath_link_.push_back(Search_directory(arg, false)); }
+
+ void
+ set_shared(bool value)
+ { this->is_shared_ = value; }
+
+ void
+ set_static(bool value)
+ { this->is_static_ = value; }
+
+ void
+ set_stats(bool value)
+ { this->print_stats_ = value; }
+
+ void
+ set_sysroot(const char* arg)
+ { this->sysroot_ = arg; }
+
+ void
+ set_segment_address(const char* name, const char* arg, uint64_t* val)
+ {
+ char* endptr;
+ *val = strtoull(arg, &endptr, 0);
+ if (*endptr != '\0' || *val == -1U)
+ gold_fatal(_("invalid argument to %s: %s"), name, arg);
+ }
+
+ void
+ set_Tbss(const char* arg)
+ { this->set_segment_address("-Tbss", arg, &this->bss_segment_address_); }
+
+ void
+ set_Tdata(const char* arg)
+ { this->set_segment_address("-Tdata", arg, &this->data_segment_address_); }
+
+ void
+ set_Ttext(const char* arg)
+ { this->set_segment_address("-Ttext", arg, &this->text_segment_address_); }
+
+ int
+ parse_thread_count(const char* arg)
+ {
+ char* endptr;
+ const int count = strtol(arg, &endptr, 0);
+ if (*endptr != '\0' || count < 0)
+ gold_fatal(_("invalid thread count: %s"), arg);
+ return count;
+ }
+
+ void
+ set_threads(bool value)
+ {
+#ifndef ENABLE_THREADS
+ if (value)
+ gold_fatal(_("--threads not supported"));
+#endif
+ this->threads_ = value;
+ }
void
- set_shared()
- { this->is_shared_ = true; }
+ set_no_threads(bool value)
+ { this->set_threads(!value); }
+
+ void
+ set_thread_count(const char* arg)
+ {
+ int count = this->parse_thread_count(arg);
+ this->thread_count_initial_ = count;
+ this->thread_count_middle_ = count;
+ this->thread_count_final_ = count;
+ }
void
- set_static()
- { this->is_static_ = true; }
+ set_thread_count_initial(const char* arg)
+ { this->thread_count_initial_ = this->parse_thread_count(arg); }
+
+ void
+ set_thread_count_middle(const char* arg)
+ { this->thread_count_middle_ = this->parse_thread_count(arg); }
+
+ void
+ set_thread_count_final(const char* arg)
+ { this->thread_count_final_ = this->parse_thread_count(arg); }
void
ignore(const char*)
{ }
+ void
+ set_execstack(bool)
+ { this->execstack_ = EXECSTACK_YES; }
+
+ void
+ set_noexecstack(bool)
+ { this->execstack_ = EXECSTACK_NO; }
+
+ void
+ set_max_page_size(const char* arg)
+ {
+ char* endptr;
+ this->max_page_size_ = strtoull(arg, &endptr, 0);
+ if (*endptr != '\0' || this->max_page_size_ == 0)
+ gold_fatal(_("invalid max-page-size: %s"), arg);
+ }
+
+ void
+ set_common_page_size(const char* arg)
+ {
+ char* endptr;
+ this->common_page_size_ = strtoull(arg, &endptr, 0);
+ if (*endptr != '\0' || this->common_page_size_ == 0)
+ gold_fatal(_("invalid common-page-size: %s"), arg);
+ }
+
+ void
+ set_debug(unsigned int flags)
+ { this->debug_ = flags; }
+
+ // Handle the -z option.
+ void
+ handle_z_option(const char*);
+
+ // Handle the --debug option.
+ void
+ handle_debug_option(const char*);
+
+ // Apply any sysroot to the directory lists.
+ void
+ add_sysroot();
+
+ const char* entry_;
bool export_dynamic_;
+ const char* soname_;
const char* dynamic_linker_;
Dir_list search_path_;
+ int optimization_level_;
const char* output_file_name_;
+ Object_format oformat_;
+ const char* oformat_string_;
bool is_relocatable_;
+ Strip strip_;
+ bool allow_shlib_undefined_;
+ bool symbolic_;
+ CompressionMethod compress_debug_sections_;
+ bool demangle_;
+ bool detect_odr_violations_;
bool create_eh_frame_hdr_;
Dir_list rpath_;
Dir_list rpath_link_;
bool is_shared_;
bool is_static_;
+ bool print_stats_;
+ std::string sysroot_;
+ uint64_t bss_segment_address_;
+ uint64_t data_segment_address_;
+ uint64_t text_segment_address_;
+ bool threads_;
+ int thread_count_initial_;
+ int thread_count_middle_;
+ int thread_count_final_;
+ Execstack execstack_;
+ uint64_t max_page_size_;
+ uint64_t common_page_size_;
+ unsigned int debug_;
};
// The current state of the position dependent options.
class Position_dependent_options
{
public:
+ typedef General_options::Object_format Object_format;
+
Position_dependent_options();
- // -Bstatic: Whether we are searching for a static archive rather
- // than a shared object.
+ // -Bdynamic/-Bstatic: Whether we are searching for a static archive
+ // -rather than a shared object.
bool
- do_static_search() const
+ Bstatic() const
{ return this->do_static_search_; }
// --as-needed: Whether to add a DT_NEEDED argument only if the
// --whole-archive: Whether to include the entire contents of an
// --archive.
bool
- include_whole_archive() const
+ whole_archive() const
{ return this->include_whole_archive_; }
+ // --format: The format of the input file.
+ Object_format
+ format() const
+ { return this->input_format_; }
+
void
- set_static_search()
- { this->do_static_search_ = true; }
+ set_Bstatic(bool value)
+ { this->do_static_search_ = value; }
void
- set_dynamic_search()
- { this->do_static_search_ = false; }
+ set_Bdynamic(bool value)
+ { this->set_Bstatic(!value); }
void
- set_as_needed()
- { this->as_needed_ = true; }
+ set_as_needed(bool value)
+ { this->as_needed_ = value; }
void
- clear_as_needed()
- { this->as_needed_ = false; }
+ set_no_as_needed(bool value)
+ { this->set_as_needed(!value); }
void
- set_whole_archive()
- { this->include_whole_archive_ = true; }
+ set_whole_archive(bool value)
+ { this->include_whole_archive_ = value; }
void
- clear_whole_archive()
- { this->include_whole_archive_ = false; }
+ set_no_whole_archive(bool value)
+ { this->set_whole_archive(!value); }
+
+ void
+ set_format(const char*);
private:
bool do_static_search_;
bool as_needed_;
bool include_whole_archive_;
+ Object_format input_format_;
};
// A single file or library argument from the command line.
class Input_file_argument
{
public:
+ // name: file name or library name
+ // is_lib: true if name is a library name: that is, emits the leading
+ // "lib" and trailing ".so"/".a" from the name
+ // extra_search_path: an extra directory to look for the file, prior
+ // to checking the normal library search path. If this is "",
+ // then no extra directory is added.
+ // just_symbols: whether this file only defines symbols.
+ // options: The position dependent options at this point in the
+ // command line, such as --whole-archive.
Input_file_argument()
- : name_(), is_lib_(false), options_()
+ : name_(), is_lib_(false), extra_search_path_(""), just_symbols_(false),
+ options_()
{ }
Input_file_argument(const char* name, bool is_lib,
+ const char* extra_search_path,
+ bool just_symbols,
const Position_dependent_options& options)
- : name_(name), is_lib_(is_lib), options_(options)
+ : name_(name), is_lib_(is_lib), extra_search_path_(extra_search_path),
+ just_symbols_(just_symbols), options_(options)
{ }
const char*
is_lib() const
{ return this->is_lib_; }
+ const char*
+ extra_search_path() const
+ {
+ return (this->extra_search_path_.empty()
+ ? NULL
+ : this->extra_search_path_.c_str());
+ }
+
+ // Return whether we should only read symbols from this file.
+ bool
+ just_symbols() const
+ { return this->just_symbols_; }
+
+ // Return whether this file may require a search using the -L
+ // options.
+ bool
+ may_need_search() const
+ { return this->is_lib_ || !this->extra_search_path_.empty(); }
+
private:
// We use std::string, not const char*, here for convenience when
// using script files, so that we do not have to preserve the string
// in that case.
std::string name_;
bool is_lib_;
+ std::string extra_search_path_;
+ bool just_symbols_;
Position_dependent_options options_;
};
in_group() const
{ return this->in_group_; }
+ // The number of entries in the list.
+ int
+ size() const
+ { return this->input_argument_list_.size(); }
+
// Iterators to iterate over the list of input files.
const_iterator
void
process(int argc, char** argv);
+ // Process one command-line option. This takes the index of argv to
+ // process, and returns the index for the next option.
+ int
+ process_one_option(int argc, char** argv, int i, bool* no_more_options);
+
// Handle a -l option.
int
- process_l_option(int, char**, char*);
+ process_l_option(int, char**, char*, bool);
+
+ // Handle a -R option when it means --rpath.
+ void
+ add_to_rpath(const char* arg)
+ { this->options_.add_to_rpath(arg); }
+
+ // Add a file for which we just read the symbols.
+ void
+ add_just_symbols_file(const char* arg)
+ {
+ this->inputs_.add_file(Input_file_argument(arg, false, "", true,
+ this->position_options_));
+ }
// Handle a --start-group option.
void
void
end_group(const char* arg);
+ // Get an option argument--a helper function for special processing.
+ const char*
+ get_special_argument(const char* longname, int argc, char** argv,
+ const char* arg, bool long_option,
+ int *pret);
+
// Get the general options.
const General_options&
options() const
{ return this->options_; }
+ // Get the position dependent options.
+ const Position_dependent_options&
+ position_dependent_options() const
+ { return this->position_options_; }
+
+ // Get the linker-script options.
+ Script_options&
+ script_options()
+ { return this->script_options_; }
+
+ // Get the version-script options: a convenience routine.
+ const Version_script_info&
+ version_script() const
+ { return *this->script_options_.version_script_info(); }
+
+ // The number of input files.
+ int
+ number_of_input_files() const
+ { return this->inputs_.size(); }
+
// Iterators to iterate over the list of input files.
const_iterator
void
add_file(const char* name, bool is_lib);
+ // Examine the result of processing the command-line, and verify
+ // the flags do not contradict each other or are otherwise illegal.
+ void
+ normalize_options();
+
General_options options_;
Position_dependent_options position_options_;
+ Script_options script_options_;
Input_arguments inputs_;
};