1 // gold.h -- general definitions for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
6 // This file is part of gold.
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.
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.
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.
32 #include <sys/types.h>
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.
41 # define _LIBGETTEXT_H
44 // Always include <clocale> first to avoid conflicts with the macros
45 // used when ENABLE_NLS is not defined.
50 # define _(String) gettext (String)
52 # define N_(String) gettext_noop (String)
54 # define N_(String) (String)
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)
66 // Figure out how to get a hash set and a hash map.
68 #if defined(HAVE_TR1_UNORDERED_SET) && defined(HAVE_TR1_UNORDERED_MAP) \
69 && defined(HAVE_TR1_UNORDERED_MAP_REHASH)
71 #include <tr1/unordered_set>
72 #include <tr1/unordered_map>
74 // We need a template typedef here.
76 #define Unordered_set std::tr1::unordered_set
77 #define Unordered_map std::tr1::unordered_map
78 #define Unordered_multimap std::tr1::unordered_multimap
80 #define reserve_unordered_map(map, n) ((map)->rehash(n))
82 #elif defined(HAVE_EXT_HASH_MAP) && defined(HAVE_EXT_HASH_SET)
84 #include <ext/hash_map>
85 #include <ext/hash_set>
88 #define Unordered_set __gnu_cxx::hash_set
89 #define Unordered_map __gnu_cxx::hash_map
90 #define Unordered_multimap __gnu_cxx::hash_multimap
96 struct hash<std::string>
99 operator()(std::string s) const
100 { return __stl_hash_string(s.c_str()); }
107 operator()(T* p) const
108 { return reinterpret_cast<size_t>(p); }
113 #define reserve_unordered_map(map, n) ((map)->resize(n))
117 // The fallback is to just use set and map.
122 #define Unordered_set std::set
123 #define Unordered_map std::map
124 #define Unordered_multimap std::multimap
126 #define reserve_unordered_map(map, n)
131 extern "C" ssize_t pread(int, void*, size_t, off_t);
134 #ifndef HAVE_FTRUNCATE
135 extern "C" int ftruncate(int, off_t);
139 #define MREMAP_MAYMOVE 1
140 extern "C" void *mremap(void *, size_t, size_t, int, ...);
144 extern "C" int ffsll(long long);
147 #if !HAVE_DECL_MEMMEM
148 extern "C" void *memmem(const void *, size_t, const void *, size_t);
151 #if !HAVE_DECL_STRNDUP
152 extern "C" char *strndup(const char *, size_t);
158 // General declarations.
160 class General_options;
171 template<int size, bool big_endian>
172 struct Relocate_info;
174 // Some basic types. For these we use lower case initial letters.
176 // For an offset in an input or output file, use off_t. Note that
177 // this will often be a 64-bit type even for a 32-bit build.
179 // The size of a section if we are going to look at the contents.
180 typedef size_t section_size_type;
182 // An offset within a section when we are looking at the contents.
183 typedef ptrdiff_t section_offset_type;
185 // The name of the program as used in error messages.
186 extern const char* program_name;
188 // This function is called to exit the program. Status is true to
189 // exit success (0) and false to exit failure (1).
191 gold_exit(bool status) ATTRIBUTE_NORETURN;
193 // This function is called to emit an error message and then
194 // immediately exit with failure.
196 gold_fatal(const char* format, ...) ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF_1;
198 // This function is called to issue an error. This will cause gold to
199 // eventually exit with failure.
201 gold_error(const char* msg, ...) ATTRIBUTE_PRINTF_1;
203 // This function is called to issue a warning.
205 gold_warning(const char* msg, ...) ATTRIBUTE_PRINTF_1;
207 // This function is called to print an informational message.
209 gold_info(const char* msg, ...) ATTRIBUTE_PRINTF_1;
211 // Work around a bug in gcc 4.3.0. http://gcc.gnu.org/PR35546 . This
212 // can probably be removed after the bug has been fixed for a while.
213 #ifdef HAVE_TEMPLATE_ATTRIBUTES
214 #define TEMPLATE_ATTRIBUTE_PRINTF_4 ATTRIBUTE_PRINTF_4
216 #define TEMPLATE_ATTRIBUTE_PRINTF_4
219 // This function is called to issue an error at the location of a
221 template<int size, bool big_endian>
223 gold_error_at_location(const Relocate_info<size, big_endian>*,
224 size_t, off_t, const char* format, ...)
225 TEMPLATE_ATTRIBUTE_PRINTF_4;
227 // This function is called to issue a warning at the location of a
229 template<int size, bool big_endian>
231 gold_warning_at_location(const Relocate_info<size, big_endian>*,
232 size_t, off_t, const char* format, ...)
233 TEMPLATE_ATTRIBUTE_PRINTF_4;
235 // This function is called to report an undefined symbol without
236 // a relocation (e.g., referenced by a dynamic object). SYM is
237 // the undefined symbol. The file name associated with the SYM
238 // is used to print a location for the undefined symbol.
240 gold_undefined_symbol(const Symbol*);
242 // This function is called to report an undefined symbol resulting
243 // from a relocation. SYM is the undefined symbol. RELINFO is the
244 // general relocation info. RELNUM is the number of the reloc,
245 // and RELOFFSET is the reloc's offset.
246 template<int size, bool big_endian>
248 gold_undefined_symbol_at_location(const Symbol*,
249 const Relocate_info<size, big_endian>*,
252 // This is function is called in some cases if we run out of memory.
254 gold_nomem() ATTRIBUTE_NORETURN;
256 // In versions of gcc before 4.3, using __FUNCTION__ in a template
257 // function can cause gcc to get confused about whether or not the
258 // function can return. See http://gcc.gnu.org/PR30988. Use a macro
259 // to avoid the problem. This can be removed when we no longer need
260 // to care about gcc versions before 4.3.
261 #if defined(__GNUC__) && GCC_VERSION < 4003
262 #define FUNCTION_NAME static_cast<const char*>(__FUNCTION__)
264 #define FUNCTION_NAME __FUNCTION__
267 // This macro and function are used in cases which can not arise if
268 // the code is written correctly.
270 #define gold_unreachable() \
271 (gold::do_gold_unreachable(__FILE__, __LINE__, FUNCTION_NAME))
273 extern void do_gold_unreachable(const char*, int, const char*)
278 #define gold_assert(expr) ((void)(!(expr) ? gold_unreachable(), 0 : 0))
280 // Print version information.
282 print_version(bool print_short);
284 // Get the version string.
286 get_version_string();
288 // Convert numeric types without unnoticed loss of precision.
289 template<typename To, typename From>
291 convert_types(const From from)
294 gold_assert(static_cast<From>(to) == from);
298 // A common case of convert_types<>: convert to section_size_type.
299 template<typename From>
300 inline section_size_type
301 convert_to_section_size_type(const From from)
302 { return convert_types<section_size_type, From>(from); }
304 // Queue up the first set of tasks.
306 queue_initial_tasks(const General_options&,
315 // Queue up the set of tasks to be done before
316 // the middle set of tasks. Only used when garbage
317 // collection is to be done.
319 queue_middle_gc_tasks(const General_options&,
321 const Input_objects*,
327 // Queue up the middle set of tasks.
329 queue_middle_tasks(const General_options&,
331 const Input_objects*,
337 // Queue up the final set of tasks.
339 queue_final_tasks(const General_options&,
340 const Input_objects*,
347 is_prefix_of(const char* prefix, const char* str)
349 return strncmp(prefix, str, strlen(prefix)) == 0;
352 const char* const cident_section_start_prefix = "__start_";
353 const char* const cident_section_stop_prefix = "__stop_";
355 // Returns true if the name is a valid C identifier
357 is_cident(const char* name)
359 return (name[strspn(name,
361 "ABCDEFGHIJKLMNOPWRSTUVWXYZ"
362 "abcdefghijklmnopqrstuvwxyz"
367 // We sometimes need to hash strings. Ideally we should use std::tr1::hash or
368 // __gnu_cxx::hash on some systems but there is no guarantee that either
369 // one is available. For portability, we define simple string hash functions.
371 template<typename Char_type>
373 string_hash(const Char_type* s, size_t length)
375 // This is the hash function used by the dynamic linker for
376 // DT_GNU_HASH entries. I compared this to a Fowler/Noll/Vo hash
377 // for a C++ program with 385,775 global symbols. This hash
378 // function was very slightly worse. However, it is much faster to
379 // compute. Overall wall clock time was a win.
380 const unsigned char* p = reinterpret_cast<const unsigned char*>(s);
382 for (size_t i = 0; i < length * sizeof(Char_type); ++i)
387 // Same as above except we expect the string to be zero terminated.
389 template<typename Char_type>
391 string_hash(const Char_type* s)
393 const unsigned char* p = reinterpret_cast<const unsigned char*>(s);
395 for (size_t i = 0; s[i] != 0; ++i)
397 for (size_t j = 0; j < sizeof(Char_type); j++)
404 } // End namespace gold.
406 #endif // !defined(GOLD_GOLD_H)