gold/gold.h

   1 // gold.h -- general definitions 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 #ifndef GOLD_GOLD_H
  24 #define GOLD_GOLD_H
  25
  26 #include "config.h"
  27 #include "ansidecl.h"
  28
  29 #include <cstddef>
  30 #include <sys/types.h>
  31
  32 #ifdef ENABLE_NLS
  33 # include <libintl.h>
  34 # define _(String) gettext (String)
  35 # ifdef gettext_noop
  36 #  define N_(String) gettext_noop (String)
  37 # else
  38 #  define N_(String) (String)
  39 # endif
  40 #else
  41 # define gettext(Msgid) (Msgid)
  42 # define dgettext(Domainname, Msgid) (Msgid)
  43 # define dcgettext(Domainname, Msgid, Category) (Msgid)
  44 # define textdomain(Domainname) while (0) /* nothing */
  45 # define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
  46 # define _(String) (String)
  47 # define N_(String) (String)
  48 #endif
  49
  50 // Figure out how to get a hash set and a hash map.
  51
  52 #if defined(HAVE_TR1_UNORDERED_SET) && defined(HAVE_TR1_UNORDERED_MAP)
  53
  54 #include <tr1/unordered_set>
  55 #include <tr1/unordered_map>
  56
  57 // We need a template typedef here.
  58
  59 #define Unordered_set std::tr1::unordered_set
  60 #define Unordered_map std::tr1::unordered_map
  61
  62 #elif defined(HAVE_EXT_HASH_MAP) && defined(HAVE_EXT_HASH_SET)
  63
  64 #include <ext/hash_map>
  65 #include <ext/hash_set>
  66 #include <string>
  67
  68 #define Unordered_set __gnu_cxx::hash_set
  69 #define Unordered_map __gnu_cxx::hash_map
  70
  71 namespace __gnu_cxx
  72 {
  73
  74 template<>
  75 struct hash<std::string>
  76 {
  77   size_t
  78   operator()(std::string s) const
  79   { return __stl_hash_string(s.c_str()); }
  80 };
  81
  82 template<typename T>
  83 struct hash<T*>
  84 {
  85   size_t
  86   operator()(T* p) const
  87   { return reinterpret_cast<size_t>(p); }
  88 };
  89
  90 }
  91
  92 #else
  93
  94 // The fallback is to just use set and map.
  95
  96 #include <set>
  97 #include <map>
  98
  99 #define Unordered_set std::set
 100 #define Unordered_map std::map
 101
 102 #endif
 103
 104 #ifndef HAVE_PREAD
 105 extern "C" ssize_t pread(int, void*, size_t, off_t);
 106 #endif
 107
 108 namespace gold
 109 {
 110
 111 // General declarations.
 112
 113 class General_options;
 114 class Command_line;
 115 class Input_argument_list;
 116 class Dirsearch;
 117 class Input_objects;
 118 class Symbol;
 119 class Symbol_table;
 120 class Layout;
 121 class Task;
 122 class Workqueue;
 123 class Output_file;
 124 template<int size, bool big_endian>
 125 struct Relocate_info;
 126
 127 // Some basic types.  For these we use lower case initial letters.
 128
 129 // For an offset in an input or output file, use off_t.  Note that
 130 // this will often be a 64-bit type even for a 32-bit build.
 131
 132 // The size of a section if we are going to look at the contents.
 133 typedef size_t section_size_type;
 134
 135 // An offset within a section when we are looking at the contents.
 136 typedef ptrdiff_t section_offset_type;
 137
 138 // The name of the program as used in error messages.
 139 extern const char* program_name;
 140
 141 // This function is called to exit the program.  Status is true to
 142 // exit success (0) and false to exit failure (1).
 143 extern void
 144 gold_exit(bool status) ATTRIBUTE_NORETURN;
 145
 146 // This function is called to emit an error message and then
 147 // immediately exit with failure.
 148 extern void
 149 gold_fatal(const char* format, ...) ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF_1;
 150
 151 // This function is called to issue an error.  This will cause gold to
 152 // eventually exit with failure.
 153 extern void
 154 gold_error(const char* msg, ...) ATTRIBUTE_PRINTF_1;
 155
 156 // This function is called to issue a warning.
 157 extern void
 158 gold_warning(const char* msg, ...) ATTRIBUTE_PRINTF_1;
 159
 160 // This function is called to issue an error at the location of a
 161 // reloc.
 162 template<int size, bool big_endian>
 163 extern void
 164 gold_error_at_location(const Relocate_info<size, big_endian>*,
 165                        size_t, off_t, const char* format, ...)
 166   ATTRIBUTE_PRINTF_4;
 167
 168 // This function is called to issue a warning at the location of a
 169 // reloc.
 170 template<int size, bool big_endian>
 171 extern void
 172 gold_warning_at_location(const Relocate_info<size, big_endian>*,
 173                          size_t, off_t, const char* format, ...)
 174   ATTRIBUTE_PRINTF_4;
 175
 176 // This function is called to report an undefined symbol.
 177 template<int size, bool big_endian>
 178 extern void
 179 gold_undefined_symbol(const Symbol*,
 180                       const Relocate_info<size, big_endian>*,
 181                       size_t, off_t);
 182
 183 // This is function is called in some cases if we run out of memory.
 184 extern void
 185 gold_nomem() ATTRIBUTE_NORETURN;
 186
 187 // This macro and function are used in cases which can not arise if
 188 // the code is written correctly.
 189
 190 #define gold_unreachable() \
 191   (gold::do_gold_unreachable(__FILE__, __LINE__, __FUNCTION__))
 192
 193 extern void do_gold_unreachable(const char*, int, const char*)
 194   ATTRIBUTE_NORETURN;
 195
 196 // Assertion check.
 197
 198 #define gold_assert(expr) ((void)(!(expr) ? gold_unreachable(), 0 : 0))
 199
 200 // Print version information.
 201 extern void
 202 print_version(bool print_short);
 203
 204 // Get the version string.
 205 extern const char*
 206 get_version_string();
 207
 208 // Convert numeric types without unnoticed loss of precision.
 209 template<typename To, typename From>
 210 inline To
 211 convert_types(const From from)
 212 {
 213   To to = from;
 214   gold_assert(static_cast<From>(to) == from);
 215   return to;
 216 }
 217
 218 // A common case of convert_types<>: convert to section_size_type.
 219 template<typename From>
 220 inline section_size_type
 221 convert_to_section_size_type(const From from)
 222 { return convert_types<section_size_type, From>(from); }
 223
 224 // Queue up the first set of tasks.
 225 extern void
 226 queue_initial_tasks(const General_options&,
 227                     Dirsearch&,
 228                     const Command_line&,
 229                     Workqueue*,
 230                     Input_objects*,
 231                     Symbol_table*,
 232                     Layout*);
 233
 234 // Queue up the middle set of tasks.
 235 extern void
 236 queue_middle_tasks(const General_options&,
 237                    const Task*,
 238                    const Input_objects*,
 239                    Symbol_table*,
 240                    Layout*,
 241                    Workqueue*);
 242
 243 // Queue up the final set of tasks.
 244 extern void
 245 queue_final_tasks(const General_options&,
 246                   const Input_objects*,
 247                   const Symbol_table*,
 248                   Layout*,
 249                   Workqueue*,
 250                   Output_file* of);
 251
 252 } // End namespace gold.
 253
 254 #endif // !defined(GOLD_GOLD_H)