gas/
[binutils.git] / gold / gold.h
blob88fc4de603b7e01cb1119263b5ac9f6ad4d4478f
1 // gold.h -- general definitions for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008, 2009, 2010, 2011 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.
23 #ifndef GOLD_GOLD_H
24 #define GOLD_GOLD_H
26 #include "config.h"
27 #include "ansidecl.h"
29 #include <cstddef>
30 #include <cstdlib>
31 #include <cstring>
32 #include <stdint.h>
33 #include <sys/types.h>
35 #ifndef ENABLE_NLS
36 // The Solaris version of locale.h always includes libintl.h. If we
37 // have been configured with --disable-nls then ENABLE_NLS will not
38 // be defined and the dummy definitions of bindtextdomain (et al)
39 // below will conflict with the definitions in libintl.h. So we
40 // define these values to prevent the bogus inclusion of libintl.h.
41 # define _LIBINTL_H
42 # define _LIBGETTEXT_H
43 #endif
45 // Always include <clocale> first to avoid conflicts with the macros
46 // used when ENABLE_NLS is not defined.
47 #include <clocale>
49 #ifdef ENABLE_NLS
50 # include <libintl.h>
51 # define _(String) gettext (String)
52 # ifdef gettext_noop
53 # define N_(String) gettext_noop (String)
54 # else
55 # define N_(String) (String)
56 # endif
57 #else
58 # define gettext(Msgid) (Msgid)
59 # define dgettext(Domainname, Msgid) (Msgid)
60 # define dcgettext(Domainname, Msgid, Category) (Msgid)
61 # define textdomain(Domainname) while (0) /* nothing */
62 # define bindtextdomain(Domainname, Dirname) while (0) /* nothing */
63 # define _(String) (String)
64 # define N_(String) (String)
65 #endif
67 // Figure out how to get a hash set and a hash map.
69 #if defined(HAVE_TR1_UNORDERED_SET) && defined(HAVE_TR1_UNORDERED_MAP) \
70 && defined(HAVE_TR1_UNORDERED_MAP_REHASH)
72 #include <tr1/unordered_set>
73 #include <tr1/unordered_map>
75 // We need a template typedef here.
77 #define Unordered_set std::tr1::unordered_set
78 #define Unordered_map std::tr1::unordered_map
79 #define Unordered_multimap std::tr1::unordered_multimap
81 #define reserve_unordered_map(map, n) ((map)->rehash(n))
83 #elif defined(HAVE_EXT_HASH_MAP) && defined(HAVE_EXT_HASH_SET)
85 #include <ext/hash_map>
86 #include <ext/hash_set>
87 #include <string>
89 #define Unordered_set __gnu_cxx::hash_set
90 #define Unordered_map __gnu_cxx::hash_map
91 #define Unordered_multimap __gnu_cxx::hash_multimap
93 namespace __gnu_cxx
96 template<>
97 struct hash<std::string>
99 size_t
100 operator()(std::string s) const
101 { return __stl_hash_string(s.c_str()); }
104 template<typename T>
105 struct hash<T*>
107 size_t
108 operator()(T* p) const
109 { return reinterpret_cast<size_t>(p); }
114 #define reserve_unordered_map(map, n) ((map)->resize(n))
116 #else
118 // The fallback is to just use set and map.
120 #include <set>
121 #include <map>
123 #define Unordered_set std::set
124 #define Unordered_map std::map
125 #define Unordered_multimap std::multimap
127 #define reserve_unordered_map(map, n)
129 #endif
131 #ifndef HAVE_PREAD
132 extern "C" ssize_t pread(int, void*, size_t, off_t);
133 #endif
135 #ifndef HAVE_FTRUNCATE
136 extern "C" int ftruncate(int, off_t);
137 #endif
139 #ifndef HAVE_FFSLL
140 extern "C" int ffsll(long long);
141 #endif
143 #if !HAVE_DECL_MEMMEM
144 extern "C" void *memmem(const void *, size_t, const void *, size_t);
145 #endif
147 #if !HAVE_DECL_STRNDUP
148 extern "C" char *strndup(const char *, size_t);
149 #endif
151 namespace gold
154 // General declarations.
156 class General_options;
157 class Command_line;
158 class Dirsearch;
159 class Input_objects;
160 class Mapfile;
161 class Symbol;
162 class Symbol_table;
163 class Layout;
164 class Task;
165 class Workqueue;
166 class Output_file;
167 template<int size, bool big_endian>
168 struct Relocate_info;
170 // Exit status codes.
172 enum Exit_status
174 GOLD_OK = EXIT_SUCCESS,
175 GOLD_ERR = EXIT_FAILURE,
176 GOLD_FALLBACK = EXIT_FAILURE + 1
179 // Some basic types. For these we use lower case initial letters.
181 // For an offset in an input or output file, use off_t. Note that
182 // this will often be a 64-bit type even for a 32-bit build.
184 // The size of a section if we are going to look at the contents.
185 typedef size_t section_size_type;
187 // An offset within a section when we are looking at the contents.
188 typedef ptrdiff_t section_offset_type;
190 // The name of the program as used in error messages.
191 extern const char* program_name;
193 // This function is called to exit the program. Status is true to
194 // exit success (0) and false to exit failure (1).
195 extern void
196 gold_exit(Exit_status status) ATTRIBUTE_NORETURN;
198 // This function is called to emit an error message and then
199 // immediately exit with failure.
200 extern void
201 gold_fatal(const char* format, ...) ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF_1;
203 // This function is called to issue an error. This will cause gold to
204 // eventually exit with failure.
205 extern void
206 gold_error(const char* msg, ...) ATTRIBUTE_PRINTF_1;
208 // This function is called to issue a warning.
209 extern void
210 gold_warning(const char* msg, ...) ATTRIBUTE_PRINTF_1;
212 // This function is called to print an informational message.
213 extern void
214 gold_info(const char* msg, ...) ATTRIBUTE_PRINTF_1;
216 // This function is called to emit an error message and then
217 // immediately exit with fallback status (e.g., when
218 // --incremental-update fails and the link needs to be restarted
219 // with --incremental-full).
220 extern void
221 gold_fallback(const char* format, ...) ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF_1;
223 // Work around a bug in gcc 4.3.0. http://gcc.gnu.org/PR35546 . This
224 // can probably be removed after the bug has been fixed for a while.
225 #ifdef HAVE_TEMPLATE_ATTRIBUTES
226 #define TEMPLATE_ATTRIBUTE_PRINTF_4 ATTRIBUTE_PRINTF_4
227 #else
228 #define TEMPLATE_ATTRIBUTE_PRINTF_4
229 #endif
231 // This function is called to issue an error at the location of a
232 // reloc.
233 template<int size, bool big_endian>
234 extern void
235 gold_error_at_location(const Relocate_info<size, big_endian>*,
236 size_t, off_t, const char* format, ...)
237 TEMPLATE_ATTRIBUTE_PRINTF_4;
239 // This function is called to issue a warning at the location of a
240 // reloc.
241 template<int size, bool big_endian>
242 extern void
243 gold_warning_at_location(const Relocate_info<size, big_endian>*,
244 size_t, off_t, const char* format, ...)
245 TEMPLATE_ATTRIBUTE_PRINTF_4;
247 // This function is called to report an undefined symbol without
248 // a relocation (e.g., referenced by a dynamic object). SYM is
249 // the undefined symbol. The file name associated with the SYM
250 // is used to print a location for the undefined symbol.
251 extern void
252 gold_undefined_symbol(const Symbol*);
254 // This function is called to report an undefined symbol resulting
255 // from a relocation. SYM is the undefined symbol. RELINFO is the
256 // general relocation info. RELNUM is the number of the reloc,
257 // and RELOFFSET is the reloc's offset.
258 template<int size, bool big_endian>
259 extern void
260 gold_undefined_symbol_at_location(const Symbol*,
261 const Relocate_info<size, big_endian>*,
262 size_t, off_t);
264 // This is function is called in some cases if we run out of memory.
265 extern void
266 gold_nomem() ATTRIBUTE_NORETURN;
268 // In versions of gcc before 4.3, using __FUNCTION__ in a template
269 // function can cause gcc to get confused about whether or not the
270 // function can return. See http://gcc.gnu.org/PR30988. Use a macro
271 // to avoid the problem. This can be removed when we no longer need
272 // to care about gcc versions before 4.3.
273 #if defined(__GNUC__) && GCC_VERSION < 4003
274 #define FUNCTION_NAME static_cast<const char*>(__FUNCTION__)
275 #else
276 #define FUNCTION_NAME __FUNCTION__
277 #endif
279 // This macro and function are used in cases which can not arise if
280 // the code is written correctly.
282 #define gold_unreachable() \
283 (gold::do_gold_unreachable(__FILE__, __LINE__, FUNCTION_NAME))
285 extern void do_gold_unreachable(const char*, int, const char*)
286 ATTRIBUTE_NORETURN;
288 // Assertion check.
290 #define gold_assert(expr) ((void)(!(expr) ? gold_unreachable(), 0 : 0))
292 // Print version information.
293 extern void
294 print_version(bool print_short);
296 // Get the version string.
297 extern const char*
298 get_version_string();
300 // Convert numeric types without unnoticed loss of precision.
301 template<typename To, typename From>
302 inline To
303 convert_types(const From from)
305 To to = from;
306 gold_assert(static_cast<From>(to) == from);
307 return to;
310 // A common case of convert_types<>: convert to section_size_type.
311 template<typename From>
312 inline section_size_type
313 convert_to_section_size_type(const From from)
314 { return convert_types<section_size_type, From>(from); }
316 // Queue up the first set of tasks.
317 extern void
318 queue_initial_tasks(const General_options&,
319 Dirsearch&,
320 const Command_line&,
321 Workqueue*,
322 Input_objects*,
323 Symbol_table*,
324 Layout*,
325 Mapfile*);
327 // Queue up the set of tasks to be done before
328 // the middle set of tasks. Only used when garbage
329 // collection is to be done.
330 extern void
331 queue_middle_gc_tasks(const General_options&,
332 const Task*,
333 const Input_objects*,
334 Symbol_table*,
335 Layout*,
336 Workqueue*,
337 Mapfile*);
339 // Queue up the middle set of tasks.
340 extern void
341 queue_middle_tasks(const General_options&,
342 const Task*,
343 const Input_objects*,
344 Symbol_table*,
345 Layout*,
346 Workqueue*,
347 Mapfile*);
349 // Queue up the final set of tasks.
350 extern void
351 queue_final_tasks(const General_options&,
352 const Input_objects*,
353 const Symbol_table*,
354 Layout*,
355 Workqueue*,
356 Output_file* of);
358 inline bool
359 is_prefix_of(const char* prefix, const char* str)
361 return strncmp(prefix, str, strlen(prefix)) == 0;
364 const char* const cident_section_start_prefix = "__start_";
365 const char* const cident_section_stop_prefix = "__stop_";
367 // Returns true if the name is a valid C identifier
368 inline bool
369 is_cident(const char* name)
371 return (name[strspn(name,
372 ("0123456789"
373 "ABCDEFGHIJKLMNOPWRSTUVWXYZ"
374 "abcdefghijklmnopqrstuvwxyz"
375 "_"))]
376 == '\0');
379 // We sometimes need to hash strings. Ideally we should use std::tr1::hash or
380 // __gnu_cxx::hash on some systems but there is no guarantee that either
381 // one is available. For portability, we define simple string hash functions.
383 template<typename Char_type>
384 inline size_t
385 string_hash(const Char_type* s, size_t length)
387 // This is the hash function used by the dynamic linker for
388 // DT_GNU_HASH entries. I compared this to a Fowler/Noll/Vo hash
389 // for a C++ program with 385,775 global symbols. This hash
390 // function was very slightly worse. However, it is much faster to
391 // compute. Overall wall clock time was a win.
392 const unsigned char* p = reinterpret_cast<const unsigned char*>(s);
393 size_t h = 5381;
394 for (size_t i = 0; i < length * sizeof(Char_type); ++i)
395 h = h * 33 + *p++;
396 return h;
399 // Same as above except we expect the string to be zero terminated.
401 template<typename Char_type>
402 inline size_t
403 string_hash(const Char_type* s)
405 const unsigned char* p = reinterpret_cast<const unsigned char*>(s);
406 size_t h = 5381;
407 for (size_t i = 0; s[i] != 0; ++i)
409 for (size_t j = 0; j < sizeof(Char_type); j++)
410 h = h * 33 + *p++;
413 return h;
416 // Return whether STRING contains a wildcard character. This is used
417 // to speed up matching.
419 inline bool
420 is_wildcard_string(const char* s)
422 return strpbrk(s, "?*[") != NULL;
425 } // End namespace gold.
427 #endif // !defined(GOLD_GOLD_H)