PR 9812
[binutils-gdb.git] / gold / options.h
index b95a70524a2fbed96f1b5caf83aa21a73e7ec5c7..b980281a928ef415b64f04afec49fe7ca0c34e13 100644 (file)
@@ -1,6 +1,6 @@
 // options.h -- handle command line options for gold  -*- C++ -*-
 
-// Copyright 2006, 2007, 2008 Free Software Foundation, Inc.
+// Copyright 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
 // Written by Ian Lance Taylor <iant@google.com>.
 
 // This file is part of gold.
@@ -54,6 +54,7 @@ class Search_directory;
 class Input_file_group;
 class Position_dependent_options;
 class Target;
+class Plugin_manager;
 
 // The nested namespace is to contain all the global variables and
 // structs that need to be defined in the .h file, but do not need to
@@ -61,6 +62,7 @@ class Target;
 namespace options
 {
 typedef std::vector<Search_directory> Dir_list;
+typedef Unordered_set<std::string> String_set;
 
 // These routines convert from a string option to various types.
 // Each gives a fatal error if it cannot parse the argument.
@@ -87,6 +89,9 @@ parse_optional_string(const char* option_name, const char* arg,
 extern void
 parse_dirlist(const char* option_name, const char* arg, Dir_list* retval);
 
+extern void
+parse_set(const char* option_name, const char* arg, String_set* retval);
+
 extern void
 parse_choices(const char* option_name, const char* arg, const char** retval,
               const char* choices[], int num_choices);
@@ -235,6 +240,10 @@ struct Struct_special : public Struct_var
   user_set_##varname__() const                                               \
   { return this->varname__##_.user_set_via_option; }                         \
                                                                              \
+  void                                                                      \
+  set_user_set_##varname__()                                                \
+  { this->varname__##_.user_set_via_option = true; }                        \
+                                                                            \
  private:                                                                    \
   struct Struct_##varname__ : public options::Struct_var                     \
   {                                                                          \
@@ -264,7 +273,8 @@ struct Struct_special : public Struct_var
 // These macros allow for easy addition of a new commandline option.
 
 // If no_helpstring__ is not NULL, then in addition to creating
-// VARNAME, we also create an option called no-VARNAME.
+// VARNAME, we also create an option called no-VARNAME (or, for a -z
+// option, noVARNAME).
 #define DEFINE_bool(varname__, dashes__, shortname__, default_value__,   \
                     helpstring__, no_helpstring__)                       \
   DEFINE_var(varname__, dashes__, shortname__, default_value__,          \
@@ -272,7 +282,10 @@ struct Struct_special : public Struct_var
              false, bool, bool, options::parse_bool)                    \
   struct Struct_no_##varname__ : public options::Struct_var              \
   {                                                                      \
-    Struct_no_##varname__() : option("no-" #varname__, dashes__, '\0',   \
+    Struct_no_##varname__() : option((dashes__ == options::DASH_Z       \
+                                     ? "no" #varname__                  \
+                                     : "no-" #varname__),               \
+                                    dashes__, '\0',                     \
                                      default_value__ ? "false" : "true", \
                                      no_helpstring__, NULL, false, this) \
     { }                                                                  \
@@ -286,6 +299,28 @@ struct Struct_special : public Struct_var
   };                                                                     \
   Struct_no_##varname__ no_##varname__##_initializer_
 
+#define DEFINE_enable(varname__, dashes__, shortname__, default_value__, \
+                      helpstring__, no_helpstring__)                     \
+  DEFINE_var(enable_##varname__, dashes__, shortname__, default_value__, \
+             default_value__ ? "true" : "false", helpstring__, NULL,     \
+             false, bool, bool, options::parse_bool)                    \
+  struct Struct_disable_##varname__ : public options::Struct_var         \
+  {                                                                      \
+    Struct_disable_##varname__() : option("disable-" #varname__,         \
+                                     dashes__, '\0',                     \
+                                     default_value__ ? "false" : "true", \
+                                     no_helpstring__, NULL, false, this) \
+    { }                                                                  \
+                                                                         \
+    void                                                                 \
+    parse_to_value(const char*, const char*,                             \
+                   Command_line*, General_options* options)              \
+    { options->set_enable_##varname__(false); }                          \
+                                                                         \
+    options::One_option option;                                          \
+  };                                                                     \
+  Struct_disable_##varname__ disable_##varname__##_initializer_
+
 #define DEFINE_uint(varname__, dashes__, shortname__, default_value__,  \
                    helpstring__, helparg__)                             \
   DEFINE_var(varname__, dashes__, shortname__, default_value__,         \
@@ -325,6 +360,33 @@ struct Struct_special : public Struct_var
   add_search_directory_to_##varname__(const Search_directory& dir)        \
   { this->varname__##_.value.push_back(dir); }
 
+// This is like DEFINE_string, but we store a set of strings.
+#define DEFINE_set(varname__, dashes__, shortname__,                      \
+                   helpstring__, helparg__)                               \
+  DEFINE_var(varname__, dashes__, shortname__, ,                          \
+             "", helpstring__, helparg__, false, options::String_set,     \
+             const options::String_set&, options::parse_set)              \
+ public:                                                                  \
+  bool                                                                    \
+  any_##varname__() const                                                 \
+  { return !this->varname__##_.value.empty(); }                           \
+                                                                         \
+  bool                                                                    \
+  is_##varname__(const char* symbol) const                                \
+  {                                                                       \
+    return (!this->varname__##_.value.empty()                             \
+            && (this->varname__##_.value.find(std::string(symbol))        \
+                != this->varname__##_.value.end()));                      \
+  }                                                                      \
+                                                                         \
+  options::String_set::const_iterator                                    \
+  varname__##_begin() const                                              \
+  { return this->varname__##_.value.begin(); }                           \
+                                                                         \
+  options::String_set::const_iterator                                    \
+  varname__##_end() const                                                \
+  { return this->varname__##_.value.end(); }
+
 // When you have a list of possible values (expressed as string)
 // After helparg__ should come an initializer list, like
 //   {"foo", "bar", "baz"}
@@ -342,6 +404,53 @@ struct Struct_special : public Struct_var
                            choices, sizeof(choices) / sizeof(*choices)); \
   }
 
+// This is like DEFINE_bool, but VARNAME is the name of a different
+// option.  This option becomes an alias for that one.  INVERT is true
+// if this option is an inversion of the other one.
+#define DEFINE_bool_alias(option__, varname__, dashes__, shortname__,  \
+                         helpstring__, no_helpstring__, invert__)      \
+ private:                                                              \
+  struct Struct_##option__ : public options::Struct_var                        \
+  {                                                                    \
+    Struct_##option__()                                                        \
+      : option(#option__, dashes__, shortname__, "", helpstring__,     \
+              NULL, false, this)                                       \
+    { }                                                                        \
+                                                                       \
+    void                                                               \
+    parse_to_value(const char*, const char*,                           \
+                  Command_line*, General_options* options)             \
+    {                                                                  \
+      options->set_##varname__(!invert__);                             \
+      options->set_user_set_##varname__();                             \
+    }                                                                  \
+                                                                       \
+    options::One_option option;                                                \
+  };                                                                   \
+  Struct_##option__ option__##_;                                       \
+                                                                       \
+  struct Struct_no_##option__ : public options::Struct_var             \
+  {                                                                    \
+    Struct_no_##option__()                                             \
+      : option((dashes__ == options::DASH_Z                            \
+               ? "no" #option__                                        \
+               : "no-" #option__),                                     \
+              dashes__, '\0', "", no_helpstring__,                     \
+              NULL, false, this)                                       \
+    { }                                                                        \
+                                                                       \
+    void                                                               \
+    parse_to_value(const char*, const char*,                           \
+                  Command_line*, General_options* options)             \
+    {                                                                  \
+      options->set_##varname__(invert__);                              \
+      options->set_user_set_##varname__();                             \
+    }                                                                  \
+                                                                       \
+    options::One_option option;                                                \
+  };                                                                   \
+  Struct_no_##option__ no_##option__##_initializer_
+
 // This is used for non-standard flags.  It defines no functions; it
 // just calls General_options::parse_VARNAME whenever the flag is
 // seen.  We declare parse_VARNAME as a static member of
@@ -428,6 +537,8 @@ class General_options
                  N_("Report usage information"), NULL);
   DEFINE_special(version, options::TWO_DASHES, 'v',
                  N_("Report version information"), NULL);
+  DEFINE_special(V, options::EXACTLY_ONE_DASH, '\0',
+                 N_("Report version and target information"), NULL);
 
   // These options are sorted approximately so that for each letter in
   // the alphabet, we show the option whose shortname is that letter
@@ -452,18 +563,24 @@ class General_options
 
   DEFINE_bool(Bdynamic, options::ONE_DASH, '\0', true,
               N_("-l searches for shared libraries"), NULL);
-  // Bstatic affects the same variable as Bdynamic, so we have to use
-  // the "special" macro to make that happen.
-  DEFINE_special(Bstatic, options::ONE_DASH, '\0',
-                 N_("-l does not search for shared libraries"), NULL);
+  DEFINE_bool_alias(Bstatic, Bdynamic, options::ONE_DASH, '\0',
+                   N_("-l does not search for shared libraries"), NULL,
+                   true);
 
   DEFINE_bool(Bsymbolic, options::ONE_DASH, '\0', false,
               N_("Bind defined symbols locally"), NULL);
 
+  DEFINE_bool(Bsymbolic_functions, options::ONE_DASH, '\0', false,
+             N_("Bind defined function symbols locally"), NULL);
+
   DEFINE_optional_string(build_id, options::TWO_DASHES, '\0', "sha1",
                         N_("Generate build ID note"),
                         N_("[=STYLE]"));
 
+  DEFINE_bool(check_sections, options::TWO_DASHES, '\0', true,
+             N_("Check segment addresses for overlaps (default)"),
+             N_("Do not check segment addresses for overlaps"));
+
 #ifdef HAVE_ZLIB_H
   DEFINE_enum(compress_debug_sections, options::TWO_DASHES, '\0', "none",
               N_("Compress .debug_* sections in the output file"),
@@ -503,15 +620,32 @@ class General_options
               N_("Try to detect violations of the One Definition Rule"),
               NULL);
 
+  DEFINE_bool(dynamic_list_data, options::TWO_DASHES, '\0', false,
+              N_("Add data symbols to dynamic symbols"), NULL);
+
+  DEFINE_bool(dynamic_list_cpp_new, options::TWO_DASHES, '\0', false,
+              N_("Add C++ operator new/delete to dynamic symbols"), NULL);
+
+  DEFINE_bool(dynamic_list_cpp_typeinfo, options::TWO_DASHES, '\0', false,
+              N_("Add C++ typeinfo to dynamic symbols"), NULL);
+
+  DEFINE_special(dynamic_list, options::TWO_DASHES, '\0',
+                 N_("Read a list of dynamic symbols"), N_("FILE"));
+
   DEFINE_string(entry, options::TWO_DASHES, 'e', NULL,
                 N_("Set program start address"), N_("ADDRESS"));
 
   DEFINE_bool(export_dynamic, options::TWO_DASHES, 'E', false,
-              N_("Export all dynamic symbols"), NULL);
+              N_("Export all dynamic symbols"),
+             N_("Do not export all dynamic symbols (default)"));
 
   DEFINE_bool(eh_frame_hdr, options::TWO_DASHES, '\0', false,
               N_("Create exception frame header"), NULL);
 
+  DEFINE_bool(fatal_warnings, options::TWO_DASHES, '\0', false,
+             N_("Treat warnings as errors"),
+             N_("Do not treat warnings as errors"));
+
   DEFINE_string(soname, options::ONE_DASH, 'h', NULL,
                 N_("Set shared library name"), N_("FILENAME"));
 
@@ -538,6 +672,28 @@ class General_options
   DEFINE_string(m, options::EXACTLY_ONE_DASH, 'm', "",
                 N_("Ignored for compatibility"), N_("EMULATION"));
 
+  DEFINE_bool(print_map, options::TWO_DASHES, 'M', false,
+             N_("Write map file on standard output"), NULL);
+  DEFINE_string(Map, options::ONE_DASH, '\0', NULL, N_("Write map file"),
+               N_("MAPFILENAME"));
+
+  DEFINE_bool(nmagic, options::TWO_DASHES, 'n', false,
+             N_("Do not page align data"), NULL);
+  DEFINE_bool(omagic, options::EXACTLY_TWO_DASHES, 'N', false,
+             N_("Do not page align data, do not make text readonly"),
+             N_("Page align data, make text readonly"));
+
+  DEFINE_enable(new_dtags, options::EXACTLY_TWO_DASHES, '\0', false,
+               N_("Enable use of DT_RUNPATH and DT_FLAGS"),
+               N_("Disable use of DT_RUNPATH and DT_FLAGS"));
+
+  DEFINE_bool(noinhibit_exec, options::TWO_DASHES, '\0', false,
+             N_("Create an output file even if errors occur"), NULL);
+
+  DEFINE_bool_alias(no_undefined, defs, options::TWO_DASHES, '\0',
+                   N_("Report undefined symbols (even with --shared)"),
+                   NULL, false);
+
   DEFINE_string(output, options::TWO_DASHES, 'o', "a.out",
                 N_("Set output file name"), N_("FILE"));
 
@@ -547,12 +703,32 @@ class General_options
   DEFINE_string(oformat, options::EXACTLY_TWO_DASHES, '\0', "elf",
                N_("Set output format"), N_("[binary]"));
 
+#ifdef ENABLE_PLUGINS
+  DEFINE_special(plugin, options::TWO_DASHES, '\0',
+                 N_("Load a plugin library"), N_("PLUGIN"));
+  DEFINE_special(plugin_opt, options::TWO_DASHES, '\0',
+                 N_("Pass an option to the plugin"), N_("OPTION"));
+#endif
+
+  DEFINE_bool(preread_archive_symbols, options::TWO_DASHES, '\0', false,
+              N_("Preread archive symbols when multi-threaded"), NULL);
+
+  DEFINE_string(print_symbol_counts, options::TWO_DASHES, '\0', NULL,
+               N_("Print symbols defined and used for each input"),
+               N_("FILENAME"));
+
+  DEFINE_bool(Qy, options::EXACTLY_ONE_DASH, '\0', false,
+             N_("Ignored for SVR4 compatibility"), NULL);
+
   DEFINE_bool(emit_relocs, options::TWO_DASHES, 'q', false,
               N_("Generate relocations in output"), NULL);
 
   DEFINE_bool(relocatable, options::EXACTLY_ONE_DASH, 'r', false,
               N_("Generate relocatable output"), NULL);
 
+  DEFINE_bool(relax, options::TWO_DASHES, '\0', false,
+             N_("Relax branches on certain targets"), NULL);
+
   // -R really means -rpath, but can mean --just-symbols for
   // compatibility with GNU ld.  -rpath is always -rpath, so we list
   // it separately.
@@ -570,24 +746,45 @@ class General_options
               N_("Strip all symbols"), NULL);
   DEFINE_bool(strip_debug, options::TWO_DASHES, 'S', false,
               N_("Strip debugging information"), NULL);
+  DEFINE_bool(strip_debug_non_line, options::TWO_DASHES, '\0', false,
+              N_("Emit only debug line number information"), NULL);
   DEFINE_bool(strip_debug_gdb, options::TWO_DASHES, '\0', false,
               N_("Strip debug symbols that are unused by gdb "
                  "(at least versions <= 6.7)"), NULL);
+  DEFINE_bool(strip_lto_sections, options::TWO_DASHES, '\0', true,
+              N_("Strip LTO intermediate code sections"), NULL);
+
+  DEFINE_bool(no_keep_memory, options::TWO_DASHES, 's', false,
+              N_("Use less memory and more disk I/O (included only for compatibility with GNU ld)"), NULL);
 
   DEFINE_bool(shared, options::ONE_DASH, '\0', false,
               N_("Generate shared library"), NULL);
 
+  DEFINE_bool(Bshareable, options::ONE_DASH, '\0', false,
+              N_("Generate shared library"), NULL);
+
   // This is not actually special in any way, but I need to give it
   // a non-standard accessor-function name because 'static' is a keyword.
   DEFINE_special(static, options::ONE_DASH, '\0',
                  N_("Do not link against shared libraries"), NULL);
 
+  DEFINE_bool(gc_sections, options::TWO_DASHES, '\0', false,
+              N_("Remove unused sections"), 
+              N_("Don't remove unused sections (default)"));
+  DEFINE_bool(print_gc_sections, options::TWO_DASHES, '\0', false,
+              N_("List removed unused sections on stderr"), 
+              N_("Do not list removed unused sections"));
+
   DEFINE_bool(stats, options::TWO_DASHES, '\0', false,
               N_("Print resource usage statistics"), NULL);
 
   DEFINE_string(sysroot, options::TWO_DASHES, '\0', "",
                 N_("Set target system root directory"), N_("DIR"));
 
+  DEFINE_bool(trace, options::TWO_DASHES, 't', false,
+              N_("Print the name of each input file"), NULL);
+
   DEFINE_special(script, options::TWO_DASHES, 'T',
                  N_("Read linker script"), N_("FILE"));
 
@@ -610,6 +807,9 @@ class General_options
   DEFINE_uint64(Ttext, options::ONE_DASH, '\0', -1U,
                 N_("Set the address of the text segment"), N_("ADDRESS"));
 
+  DEFINE_set(undefined, options::TWO_DASHES, 'u',
+            N_("Create undefined reference to SYMBOL"), N_("SYMBOL"));
+
   DEFINE_bool(verbose, options::TWO_DASHES, '\0', false,
               N_("Synonym for --debug=files"), NULL);
 
@@ -620,6 +820,16 @@ class General_options
               N_("Include all archive contents"),
               N_("Include only needed archive contents"));
 
+  DEFINE_set(wrap, options::TWO_DASHES, '\0',
+            N_("Use wrapper functions for SYMBOL"), N_("SYMBOL"));
+
+  DEFINE_set(trace_symbol, options::TWO_DASHES, 'y',
+             N_("Trace references to symbol"), N_("SYMBOL"));
+
+  DEFINE_string(Y, options::EXACTLY_ONE_DASH, 'Y', "",
+               N_("Default search path for Solaris compatibility"),
+               N_("PATH"));
+
   DEFINE_special(start_group, options::TWO_DASHES, '(',
                  N_("Start a library search group"), NULL);
   DEFINE_special(end_group, options::TWO_DASHES, ')',
@@ -627,8 +837,9 @@ class General_options
 
   // The -z options.
 
-  // Both execstack and noexecstack differ from the default execstack_
-  // value, so we need to use different variables for them.
+  DEFINE_bool(combreloc, options::DASH_Z, '\0', true,
+             N_("Sort dynamic relocs"),
+             N_("Do not sort dynamic relocs"));
   DEFINE_uint64(common_page_size, options::DASH_Z, '\0', 0,
                 N_("Set common page size to SIZE"), N_("SIZE"));
   DEFINE_bool(defs, options::DASH_Z, '\0', false,
@@ -640,6 +851,33 @@ class General_options
                 N_("Set maximum page size to SIZE"), N_("SIZE"));
   DEFINE_bool(noexecstack, options::DASH_Z, '\0', false,
               N_("Mark output as not requiring executable stack"), NULL);
+  DEFINE_bool(initfirst, options::DASH_Z, '\0', false,
+             N_("Mark DSO to be initialized first at runtime"),
+             NULL);
+  DEFINE_bool(interpose, options::DASH_Z, '\0', false,
+             N_("Mark object to interpose all DSOs but executable"),
+             NULL);
+  DEFINE_bool(loadfltr, options::DASH_Z, '\0', false,
+             N_("Mark object requiring immediate process"),
+             NULL);
+  DEFINE_bool(nodefaultlib, options::DASH_Z, '\0', false,
+             N_("Mark object not to use default search paths"),
+             NULL);
+  DEFINE_bool(nodelete, options::DASH_Z, '\0', false,
+             N_("Mark DSO non-deletable at runtime"),
+             NULL);
+  DEFINE_bool(nodlopen, options::DASH_Z, '\0', false,
+             N_("Mark DSO not available to dlopen"),
+             NULL);
+  DEFINE_bool(nodump, options::DASH_Z, '\0', false,
+             N_("Mark DSO not available to dldump"),
+             NULL);
+  DEFINE_bool(relro, options::DASH_Z, '\0', false,
+             N_("Where possible mark variables read-only after relocation"),
+             N_("Don't mark variables read-only after relocation"));
+  DEFINE_bool(origin, options::DASH_Z, '\0', false,
+             N_("Mark DSO to indicate that needs immediate $ORIGIN "
+                 "processing at runtime"), NULL);
 
  public:
   typedef options::Dir_list Dir_list;
@@ -665,6 +903,20 @@ class General_options
   output_is_position_independent() const
   { return this->shared(); }
 
+  // Return true if the output is something that can be exec()ed, such
+  // as a static executable, or a position-dependent or
+  // position-independent executable, but not a dynamic library or an
+  // object file.
+  bool
+  output_is_executable() const
+  { return !this->shared() || this->output_is_pie(); }
+
+  // Return true if the output is a position-independent executable.
+  // This is currently not supported.
+  bool
+  output_is_pie() const
+  { return false; }
+
   // This would normally be static(), and defined automatically, but
   // since static is a keyword, we need to come up with our own name.
   bool
@@ -702,6 +954,21 @@ class General_options
   do_demangle() const
   { return this->do_demangle_; }
 
+  // Returns TRUE if any plugin libraries have been loaded.
+  bool
+  has_plugins() const
+  { return this->plugins_ != NULL; }
+
+  // Return a pointer to the plugin manager.
+  Plugin_manager*
+  plugins() const
+  { return this->plugins_; }
+
+  // True iff SYMBOL was found in the file specified by dynamic-list.
+  bool
+  in_dynamic_list(const char* symbol) const
+  { return this->dynamic_list_.version_script_info()->symbol_is_local(symbol); }
+
  private:
   // Don't copy this structure.
   General_options(const General_options&);
@@ -739,12 +1006,26 @@ class General_options
   void
   add_sysroot();
 
+  // Add a plugin and its arguments to the list of plugins.
+  void
+  add_plugin(const char *filename);
+
+  // Add a plugin option.
+  void
+  add_plugin_option(const char* opt);
+
   // Whether to mark the stack as executable.
   Execstack execstack_status_;
   // Whether to do a static link.
   bool static_;
   // Whether to do demangling.
   bool do_demangle_;
+  // List of plugin libraries.
+  Plugin_manager* plugins_;
+  // The parsed output of --dynamic-list files.  For convenience in
+  // script.cc, we store this as a Script_options object, even though
+  // we only use a single Version_tree from it.
+  Script_options dynamic_list_;
 };
 
 // The position-dependent options.  We use this to store the state of