gold/gold.h

   1 // gold.h -- general definitions for gold   -*- C++ -*-
   2
   3 // Copyright 2006, 2007, 2008, 2009 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 <cstring>
  31 #include <stdint.h>
  32 #include <sys/types.h>
  33
  34 #ifndef ENABLE_NLS
  35   // The Solaris version of locale.h always includes libintl.h.  If we
  36   // have been configured with --disable-nls then ENABLE_NLS will not
  37   // be defined and the dummy definitions of bindtextdomain (et al)
  38   // below will conflict with the defintions in libintl.h.  So we
  39   // define these values to prevent the bogus inclusion of libintl.h.
  40 # define _LIBINTL_H
  41 # define _LIBGETTEXT_H
  42 #endif
  43
  44 // Always include <clocale> first to avoid conflicts with the macros
  45 // used when ENABLE_NLS is not defined.
  46 #include <clocale>
  47
  48 #ifdef ENABLE_NLS
  49 # include <libintl.h>
  50 # define _(String) gettext (String)
  51 # ifdef gettext_noop
  52 #  define N_(String) gettext_noop (String)
  53 # else
  54 #  define N_(String) (String)
  55 # endif
  56 #else
  57 # define gettext(Msgid) (Msgid)
  58 # define dgettext(Domainname, Msgid) (Msgid)
  59 # define dcgettext(Domainname, Msgid, Category) (Msgid)
  60 # define textdomain(Domainname) while (0) /* nothing */
  61 # define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
  62 # define _(String) (String)
  63 # define N_(String) (String)
  64 #endif
  65
  66 // Figure out how to get a hash set and a hash map.
  67
  68 #if defined(HAVE_TR1_UNORDERED_SET) && defined(HAVE_TR1_UNORDERED_MAP)
  69
  70 #include <tr1/unordered_set>
  71 #include <tr1/unordered_map>
  72
  73 // We need a template typedef here.
  74
  75 #define Unordered_set std::tr1::unordered_set
  76 #define Unordered_map std::tr1::unordered_map
  77
  78 #elif defined(HAVE_EXT_HASH_MAP) && defined(HAVE_EXT_HASH_SET)
  79
  80 #include <ext/hash_map>
  81 #include <ext/hash_set>
  82 #include <string>
  83
  84 #define Unordered_set __gnu_cxx::hash_set
  85 #define Unordered_map __gnu_cxx::hash_map
  86
  87 namespace __gnu_cxx
  88 {
  89
  90 template<>
  91 struct hash<std::string>
  92 {
  93   size_t
  94   operator()(std::string s) const
  95   { return __stl_hash_string(s.c_str()); }
  96 };
  97
  98 template<typename T>
  99 struct hash<T*>
 100 {
 101   size_t
 102   operator()(T* p) const
 103   { return reinterpret_cast<size_t>(p); }
 104 };
 105
 106 }
 107
 108 #else
 109
 110 // The fallback is to just use set and map.
 111
 112 #include <set>
 113 #include <map>
 114
 115 #define Unordered_set std::set
 116 #define Unordered_map std::map
 117
 118 #endif
 119
 120 #ifndef HAVE_PREAD
 121 extern "C" ssize_t pread(int, void*, size_t, off_t);
 122 #endif
 123
 124 #ifndef HAVE_FTRUNCATE
 125 extern "C" int ftruncate(int, off_t);
 126 #endif
 127
 128 #ifndef HAVE_MREMAP
 129 #define MREMAP_MAYMOVE 1
 130 extern "C" void *mremap(void *, size_t, size_t, int, ...);
 131 #endif
 132
 133 #ifndef HAVE_FFSLL
 134 extern "C" int ffsll(long long);
 135 #endif
 136
 137 namespace gold
 138 {
 139
 140 // General declarations.
 141
 142 class General_options;
 143 class Command_line;
 144 class Input_argument_list;
 145 class Dirsearch;
 146 class Input_objects;
 147 class Mapfile;
 148 class Symbol;
 149 class Symbol_table;
 150 class Layout;
 151 class Task;
 152 class Workqueue;
 153 class Output_file;
 154 template<int size, bool big_endian>
 155 struct Relocate_info;
 156
 157 // Some basic types.  For these we use lower case initial letters.
 158
 159 // For an offset in an input or output file, use off_t.  Note that
 160 // this will often be a 64-bit type even for a 32-bit build.
 161
 162 // The size of a section if we are going to look at the contents.
 163 typedef size_t section_size_type;
 164
 165 // An offset within a section when we are looking at the contents.
 166 typedef ptrdiff_t section_offset_type;
 167
 168 // The name of the program as used in error messages.
 169 extern const char* program_name;
 170
 171 // This function is called to exit the program.  Status is true to
 172 // exit success (0) and false to exit failure (1).
 173 extern void
 174 gold_exit(bool status) ATTRIBUTE_NORETURN;
 175
 176 // This function is called to emit an error message and then
 177 // immediately exit with failure.
 178 extern void
 179 gold_fatal(const char* format, ...) ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF_1;
 180
 181 // This function is called to issue an error.  This will cause gold to
 182 // eventually exit with failure.
 183 extern void
 184 gold_error(const char* msg, ...) ATTRIBUTE_PRINTF_1;
 185
 186 // This function is called to issue a warning.
 187 extern void
 188 gold_warning(const char* msg, ...) ATTRIBUTE_PRINTF_1;
 189
 190 // This function is called to print an informational message.
 191 extern void
 192 gold_info(const char* msg, ...) ATTRIBUTE_PRINTF_1;
 193
 194 // Work around a bug in gcc 4.3.0.  http://gcc.gnu.org/PR35546 .  This
 195 // can probably be removed after the bug has been fixed for a while.
 196 #ifdef HAVE_TEMPLATE_ATTRIBUTES
 197 #define TEMPLATE_ATTRIBUTE_PRINTF_4 ATTRIBUTE_PRINTF_4
 198 #else
 199 #define TEMPLATE_ATTRIBUTE_PRINTF_4
 200 #endif
 201
 202 // This function is called to issue an error at the location of a
 203 // reloc.
 204 template<int size, bool big_endian>
 205 extern void
 206 gold_error_at_location(const Relocate_info<size, big_endian>*,
 207                        size_t, off_t, const char* format, ...)
 208   TEMPLATE_ATTRIBUTE_PRINTF_4;
 209
 210 // This function is called to issue a warning at the location of a
 211 // reloc.
 212 template<int size, bool big_endian>
 213 extern void
 214 gold_warning_at_location(const Relocate_info<size, big_endian>*,
 215                          size_t, off_t, const char* format, ...)
 216   TEMPLATE_ATTRIBUTE_PRINTF_4;
 217
 218 // This function is called to report an undefined symbol without
 219 // a relocation (e.g., referenced by a dynamic object).  SYM is
 220 // the undefined symbol.  The file name associated with the SYM
 221 // is used to print a location for the undefined symbol.
 222 extern void
 223 gold_undefined_symbol(const Symbol*);
 224
 225 // This function is called to report an undefined symbol resulting
 226 // from a relocation.  SYM is the undefined symbol.  RELINFO is the
 227 // general relocation info.  RELNUM is the number of the reloc,
 228 // and RELOFFSET is the reloc's offset.
 229 template<int size, bool big_endian>
 230 extern void
 231 gold_undefined_symbol_at_location(const Symbol*,
 232                                   const Relocate_info<size, big_endian>*,
 233                                   size_t, off_t);
 234
 235 // This is function is called in some cases if we run out of memory.
 236 extern void
 237 gold_nomem() ATTRIBUTE_NORETURN;
 238
 239 // This macro and function are used in cases which can not arise if
 240 // the code is written correctly.
 241
 242 #define gold_unreachable() \
 243   (gold::do_gold_unreachable(__FILE__, __LINE__, __FUNCTION__))
 244
 245 extern void do_gold_unreachable(const char*, int, const char*)
 246   ATTRIBUTE_NORETURN;
 247
 248 // Assertion check.
 249
 250 #define gold_assert(expr) ((void)(!(expr) ? gold_unreachable(), 0 : 0))
 251
 252 // Print version information.
 253 extern void
 254 print_version(bool print_short);
 255
 256 // Get the version string.
 257 extern const char*
 258 get_version_string();
 259
 260 // Convert numeric types without unnoticed loss of precision.
 261 template<typename To, typename From>
 262 inline To
 263 convert_types(const From from)
 264 {
 265   To to = from;
 266   gold_assert(static_cast<From>(to) == from);
 267   return to;
 268 }
 269
 270 // A common case of convert_types<>: convert to section_size_type.
 271 template<typename From>
 272 inline section_size_type
 273 convert_to_section_size_type(const From from)
 274 { return convert_types<section_size_type, From>(from); }
 275
 276 // Queue up the first set of tasks.
 277 extern void
 278 queue_initial_tasks(const General_options&,
 279                     Dirsearch&,
 280                     const Command_line&,
 281                     Workqueue*,
 282                     Input_objects*,
 283                     Symbol_table*,
 284                     Layout*,
 285                     Mapfile*);
 286
 287 // Queue up the set of tasks to be done before
 288 // the middle set of tasks.  Only used when garbage
 289 // collection is to be done.
 290 extern void
 291 queue_middle_gc_tasks(const General_options&,
 292                       const Task*,
 293                       const Input_objects*,
 294                       Symbol_table*,
 295                       Layout*,
 296                       Workqueue*,
 297                       Mapfile*);
 298
 299 // Queue up the middle set of tasks.
 300 extern void
 301 queue_middle_tasks(const General_options&,
 302                    const Task*,
 303                    const Input_objects*,
 304                    Symbol_table*,
 305                    Layout*,
 306                    Workqueue*,
 307                    Mapfile*);
 308
 309 // Queue up the final set of tasks.
 310 extern void
 311 queue_final_tasks(const General_options&,
 312                   const Input_objects*,
 313                   const Symbol_table*,
 314                   Layout*,
 315                   Workqueue*,
 316                   Output_file* of);
 317
 318 inline bool
 319 is_prefix_of(const char* prefix, const char* str)
 320 {
 321   return strncmp(prefix, str, strlen(prefix)) == 0;
 322 }
 323
 324 } // End namespace gold.
 325
 326 #endif // !defined(GOLD_GOLD_H)