Commit | Line | Data |
---|---|---|
bae7f79e ILT |
1 | // gold.h -- general definitions for gold -*- C++ -*- |
2 | ||
6d03d481 | 3 | // Copyright 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
6cb15b7f ILT |
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 | ||
bae7f79e | 23 | #ifndef GOLD_GOLD_H |
6724bacc | 24 | #define GOLD_GOLD_H |
bae7f79e ILT |
25 | |
26 | #include "config.h" | |
27 | #include "ansidecl.h" | |
28 | ||
cbb93e63 | 29 | #include <cstddef> |
e0ebcf42 ILT |
30 | #include <cstring> |
31 | #include <stdint.h> | |
cbb93e63 ILT |
32 | #include <sys/types.h> |
33 | ||
801647d1 ILT |
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 | ||
bae7f79e ILT |
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 | ||
54dc6425 ILT |
66 | // Figure out how to get a hash set and a hash map. |
67 | ||
40fde488 CD |
68 | #if defined(HAVE_TR1_UNORDERED_SET) && defined(HAVE_TR1_UNORDERED_MAP) \ |
69 | && defined(HAVE_TR1_UNORDERED_MAP_REHASH) | |
bae7f79e ILT |
70 | |
71 | #include <tr1/unordered_set> | |
72 | #include <tr1/unordered_map> | |
73 | ||
74 | // We need a template typedef here. | |
75 | ||
76 | #define Unordered_set std::tr1::unordered_set | |
77 | #define Unordered_map std::tr1::unordered_map | |
78 | ||
e55bde5e ILT |
79 | #define reserve_unordered_map(map, n) ((map)->rehash(n)) |
80 | ||
d288e464 | 81 | #elif defined(HAVE_EXT_HASH_MAP) && defined(HAVE_EXT_HASH_SET) |
54dc6425 ILT |
82 | |
83 | #include <ext/hash_map> | |
84 | #include <ext/hash_set> | |
274e99f9 | 85 | #include <string> |
54dc6425 ILT |
86 | |
87 | #define Unordered_set __gnu_cxx::hash_set | |
88 | #define Unordered_map __gnu_cxx::hash_map | |
89 | ||
274e99f9 ILT |
90 | namespace __gnu_cxx |
91 | { | |
92 | ||
93 | template<> | |
94 | struct hash<std::string> | |
95 | { | |
96 | size_t | |
97 | operator()(std::string s) const | |
98 | { return __stl_hash_string(s.c_str()); } | |
99 | }; | |
100 | ||
101 | template<typename T> | |
102 | struct hash<T*> | |
103 | { | |
104 | size_t | |
105 | operator()(T* p) const | |
106 | { return reinterpret_cast<size_t>(p); } | |
107 | }; | |
108 | ||
109 | } | |
110 | ||
e55bde5e ILT |
111 | #define reserve_unordered_map(map, n) ((map)->resize(n)) |
112 | ||
54dc6425 ILT |
113 | #else |
114 | ||
115 | // The fallback is to just use set and map. | |
116 | ||
117 | #include <set> | |
118 | #include <map> | |
119 | ||
120 | #define Unordered_set std::set | |
121 | #define Unordered_map std::map | |
122 | ||
e55bde5e ILT |
123 | #define reserve_unordered_map(map, n) |
124 | ||
54dc6425 ILT |
125 | #endif |
126 | ||
82dcae9d ILT |
127 | #ifndef HAVE_PREAD |
128 | extern "C" ssize_t pread(int, void*, size_t, off_t); | |
129 | #endif | |
130 | ||
9201d894 ILT |
131 | #ifndef HAVE_FTRUNCATE |
132 | extern "C" int ftruncate(int, off_t); | |
133 | #endif | |
134 | ||
2f35ab9b ILT |
135 | #ifndef HAVE_MREMAP |
136 | #define MREMAP_MAYMOVE 1 | |
fd03461a ILT |
137 | extern "C" void *mremap(void *, size_t, size_t, int, ...); |
138 | #endif | |
139 | ||
140 | #ifndef HAVE_FFSLL | |
141 | extern "C" int ffsll(long long); | |
2f35ab9b ILT |
142 | #endif |
143 | ||
3d857b98 DK |
144 | #if !HAVE_DECL_MEMMEM |
145 | extern "C" void *memmem(const void *, size_t, const void *, size_t); | |
146 | #endif | |
147 | ||
148 | #if !HAVE_DECL_STRNDUP | |
149 | extern "C" char *strndup(const char *, size_t); | |
150 | #endif | |
151 | ||
5482377d ILT |
152 | namespace gold |
153 | { | |
5482377d | 154 | |
8383303e | 155 | // General declarations. |
bae7f79e | 156 | |
61ba1cf9 | 157 | class General_options; |
5a6f7e2d | 158 | class Command_line; |
92e059d8 | 159 | class Dirsearch; |
61ba1cf9 | 160 | class Input_objects; |
7d9e3d98 | 161 | class Mapfile; |
75f2446e | 162 | class Symbol; |
61ba1cf9 ILT |
163 | class Symbol_table; |
164 | class Layout; | |
17a1d0a9 | 165 | class Task; |
61ba1cf9 ILT |
166 | class Workqueue; |
167 | class Output_file; | |
75f2446e ILT |
168 | template<int size, bool big_endian> |
169 | struct Relocate_info; | |
61ba1cf9 | 170 | |
8383303e ILT |
171 | // Some basic types. For these we use lower case initial letters. |
172 | ||
173 | // For an offset in an input or output file, use off_t. Note that | |
174 | // this will often be a 64-bit type even for a 32-bit build. | |
175 | ||
176 | // The size of a section if we are going to look at the contents. | |
177 | typedef size_t section_size_type; | |
178 | ||
179 | // An offset within a section when we are looking at the contents. | |
180 | typedef ptrdiff_t section_offset_type; | |
181 | ||
bae7f79e ILT |
182 | // The name of the program as used in error messages. |
183 | extern const char* program_name; | |
184 | ||
185 | // This function is called to exit the program. Status is true to | |
186 | // exit success (0) and false to exit failure (1). | |
187 | extern void | |
188 | gold_exit(bool status) ATTRIBUTE_NORETURN; | |
189 | ||
75f2446e ILT |
190 | // This function is called to emit an error message and then |
191 | // immediately exit with failure. | |
192 | extern void | |
193 | gold_fatal(const char* format, ...) ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF_1; | |
194 | ||
195 | // This function is called to issue an error. This will cause gold to | |
196 | // eventually exit with failure. | |
197 | extern void | |
198 | gold_error(const char* msg, ...) ATTRIBUTE_PRINTF_1; | |
199 | ||
200 | // This function is called to issue a warning. | |
201 | extern void | |
202 | gold_warning(const char* msg, ...) ATTRIBUTE_PRINTF_1; | |
203 | ||
c5818ff1 CC |
204 | // This function is called to print an informational message. |
205 | extern void | |
206 | gold_info(const char* msg, ...) ATTRIBUTE_PRINTF_1; | |
207 | ||
04bf7072 ILT |
208 | // Work around a bug in gcc 4.3.0. http://gcc.gnu.org/PR35546 . This |
209 | // can probably be removed after the bug has been fixed for a while. | |
210 | #ifdef HAVE_TEMPLATE_ATTRIBUTES | |
211 | #define TEMPLATE_ATTRIBUTE_PRINTF_4 ATTRIBUTE_PRINTF_4 | |
212 | #else | |
213 | #define TEMPLATE_ATTRIBUTE_PRINTF_4 | |
214 | #endif | |
215 | ||
75f2446e ILT |
216 | // This function is called to issue an error at the location of a |
217 | // reloc. | |
218 | template<int size, bool big_endian> | |
219 | extern void | |
220 | gold_error_at_location(const Relocate_info<size, big_endian>*, | |
221 | size_t, off_t, const char* format, ...) | |
04bf7072 | 222 | TEMPLATE_ATTRIBUTE_PRINTF_4; |
75f2446e ILT |
223 | |
224 | // This function is called to issue a warning at the location of a | |
225 | // reloc. | |
226 | template<int size, bool big_endian> | |
227 | extern void | |
228 | gold_warning_at_location(const Relocate_info<size, big_endian>*, | |
229 | size_t, off_t, const char* format, ...) | |
04bf7072 | 230 | TEMPLATE_ATTRIBUTE_PRINTF_4; |
75f2446e | 231 | |
f073bbf7 CD |
232 | // This function is called to report an undefined symbol without |
233 | // a relocation (e.g., referenced by a dynamic object). SYM is | |
234 | // the undefined symbol. The file name associated with the SYM | |
235 | // is used to print a location for the undefined symbol. | |
236 | extern void | |
237 | gold_undefined_symbol(const Symbol*); | |
238 | ||
239 | // This function is called to report an undefined symbol resulting | |
240 | // from a relocation. SYM is the undefined symbol. RELINFO is the | |
241 | // general relocation info. RELNUM is the number of the reloc, | |
242 | // and RELOFFSET is the reloc's offset. | |
75f2446e | 243 | template<int size, bool big_endian> |
bae7f79e | 244 | extern void |
f073bbf7 CD |
245 | gold_undefined_symbol_at_location(const Symbol*, |
246 | const Relocate_info<size, big_endian>*, | |
247 | size_t, off_t); | |
bae7f79e ILT |
248 | |
249 | // This is function is called in some cases if we run out of memory. | |
250 | extern void | |
251 | gold_nomem() ATTRIBUTE_NORETURN; | |
252 | ||
a3ad94ed ILT |
253 | // This macro and function are used in cases which can not arise if |
254 | // the code is written correctly. | |
255 | ||
256 | #define gold_unreachable() \ | |
257 | (gold::do_gold_unreachable(__FILE__, __LINE__, __FUNCTION__)) | |
258 | ||
259 | extern void do_gold_unreachable(const char*, int, const char*) | |
260 | ATTRIBUTE_NORETURN; | |
261 | ||
262 | // Assertion check. | |
263 | ||
264 | #define gold_assert(expr) ((void)(!(expr) ? gold_unreachable(), 0 : 0)) | |
bae7f79e | 265 | |
8486ee48 ILT |
266 | // Print version information. |
267 | extern void | |
268 | print_version(bool print_short); | |
269 | ||
4f211c8b ILT |
270 | // Get the version string. |
271 | extern const char* | |
272 | get_version_string(); | |
273 | ||
8383303e ILT |
274 | // Convert numeric types without unnoticed loss of precision. |
275 | template<typename To, typename From> | |
276 | inline To | |
277 | convert_types(const From from) | |
278 | { | |
279 | To to = from; | |
9bb53bf8 | 280 | gold_assert(static_cast<From>(to) == from); |
8383303e ILT |
281 | return to; |
282 | } | |
283 | ||
284 | // A common case of convert_types<>: convert to section_size_type. | |
285 | template<typename From> | |
286 | inline section_size_type | |
287 | convert_to_section_size_type(const From from) | |
288 | { return convert_types<section_size_type, From>(from); } | |
289 | ||
92e059d8 ILT |
290 | // Queue up the first set of tasks. |
291 | extern void | |
292 | queue_initial_tasks(const General_options&, | |
17a1d0a9 | 293 | Dirsearch&, |
5a6f7e2d | 294 | const Command_line&, |
92e059d8 ILT |
295 | Workqueue*, |
296 | Input_objects*, | |
297 | Symbol_table*, | |
7d9e3d98 ILT |
298 | Layout*, |
299 | Mapfile*); | |
92e059d8 | 300 | |
6d03d481 ST |
301 | // Queue up the set of tasks to be done before |
302 | // the middle set of tasks. Only used when garbage | |
072fe7ce | 303 | // collection is to be done. |
6d03d481 ST |
304 | extern void |
305 | queue_middle_gc_tasks(const General_options&, | |
306 | const Task*, | |
307 | const Input_objects*, | |
308 | Symbol_table*, | |
309 | Layout*, | |
310 | Workqueue*, | |
311 | Mapfile*); | |
312 | ||
92e059d8 ILT |
313 | // Queue up the middle set of tasks. |
314 | extern void | |
315 | queue_middle_tasks(const General_options&, | |
17a1d0a9 | 316 | const Task*, |
92e059d8 ILT |
317 | const Input_objects*, |
318 | Symbol_table*, | |
319 | Layout*, | |
7d9e3d98 ILT |
320 | Workqueue*, |
321 | Mapfile*); | |
92e059d8 ILT |
322 | |
323 | // Queue up the final set of tasks. | |
61ba1cf9 ILT |
324 | extern void |
325 | queue_final_tasks(const General_options&, | |
326 | const Input_objects*, | |
327 | const Symbol_table*, | |
27bc2bce | 328 | Layout*, |
61ba1cf9 ILT |
329 | Workqueue*, |
330 | Output_file* of); | |
331 | ||
6d03d481 ST |
332 | inline bool |
333 | is_prefix_of(const char* prefix, const char* str) | |
334 | { | |
335 | return strncmp(prefix, str, strlen(prefix)) == 0; | |
336 | } | |
337 | ||
bae7f79e ILT |
338 | } // End namespace gold. |
339 | ||
340 | #endif // !defined(GOLD_GOLD_H) |