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 | ||
d288e464 | 68 | #if defined(HAVE_TR1_UNORDERED_SET) && defined(HAVE_TR1_UNORDERED_MAP) |
bae7f79e ILT |
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 | ||
d288e464 | 78 | #elif defined(HAVE_EXT_HASH_MAP) && defined(HAVE_EXT_HASH_SET) |
54dc6425 ILT |
79 | |
80 | #include <ext/hash_map> | |
81 | #include <ext/hash_set> | |
274e99f9 | 82 | #include <string> |
54dc6425 ILT |
83 | |
84 | #define Unordered_set __gnu_cxx::hash_set | |
85 | #define Unordered_map __gnu_cxx::hash_map | |
86 | ||
274e99f9 ILT |
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 | ||
54dc6425 ILT |
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 | ||
82dcae9d ILT |
120 | #ifndef HAVE_PREAD |
121 | extern "C" ssize_t pread(int, void*, size_t, off_t); | |
122 | #endif | |
123 | ||
9201d894 ILT |
124 | #ifndef HAVE_FTRUNCATE |
125 | extern "C" int ftruncate(int, off_t); | |
126 | #endif | |
127 | ||
5482377d ILT |
128 | namespace gold |
129 | { | |
5482377d | 130 | |
8383303e | 131 | // General declarations. |
bae7f79e | 132 | |
61ba1cf9 | 133 | class General_options; |
5a6f7e2d | 134 | class Command_line; |
92e059d8 ILT |
135 | class Input_argument_list; |
136 | class Dirsearch; | |
61ba1cf9 | 137 | class Input_objects; |
7d9e3d98 | 138 | class Mapfile; |
75f2446e | 139 | class Symbol; |
61ba1cf9 ILT |
140 | class Symbol_table; |
141 | class Layout; | |
17a1d0a9 | 142 | class Task; |
61ba1cf9 ILT |
143 | class Workqueue; |
144 | class Output_file; | |
75f2446e ILT |
145 | template<int size, bool big_endian> |
146 | struct Relocate_info; | |
61ba1cf9 | 147 | |
8383303e ILT |
148 | // Some basic types. For these we use lower case initial letters. |
149 | ||
150 | // For an offset in an input or output file, use off_t. Note that | |
151 | // this will often be a 64-bit type even for a 32-bit build. | |
152 | ||
153 | // The size of a section if we are going to look at the contents. | |
154 | typedef size_t section_size_type; | |
155 | ||
156 | // An offset within a section when we are looking at the contents. | |
157 | typedef ptrdiff_t section_offset_type; | |
158 | ||
bae7f79e ILT |
159 | // The name of the program as used in error messages. |
160 | extern const char* program_name; | |
161 | ||
162 | // This function is called to exit the program. Status is true to | |
163 | // exit success (0) and false to exit failure (1). | |
164 | extern void | |
165 | gold_exit(bool status) ATTRIBUTE_NORETURN; | |
166 | ||
75f2446e ILT |
167 | // This function is called to emit an error message and then |
168 | // immediately exit with failure. | |
169 | extern void | |
170 | gold_fatal(const char* format, ...) ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF_1; | |
171 | ||
172 | // This function is called to issue an error. This will cause gold to | |
173 | // eventually exit with failure. | |
174 | extern void | |
175 | gold_error(const char* msg, ...) ATTRIBUTE_PRINTF_1; | |
176 | ||
177 | // This function is called to issue a warning. | |
178 | extern void | |
179 | gold_warning(const char* msg, ...) ATTRIBUTE_PRINTF_1; | |
180 | ||
c5818ff1 CC |
181 | // This function is called to print an informational message. |
182 | extern void | |
183 | gold_info(const char* msg, ...) ATTRIBUTE_PRINTF_1; | |
184 | ||
04bf7072 ILT |
185 | // Work around a bug in gcc 4.3.0. http://gcc.gnu.org/PR35546 . This |
186 | // can probably be removed after the bug has been fixed for a while. | |
187 | #ifdef HAVE_TEMPLATE_ATTRIBUTES | |
188 | #define TEMPLATE_ATTRIBUTE_PRINTF_4 ATTRIBUTE_PRINTF_4 | |
189 | #else | |
190 | #define TEMPLATE_ATTRIBUTE_PRINTF_4 | |
191 | #endif | |
192 | ||
75f2446e ILT |
193 | // This function is called to issue an error at the location of a |
194 | // reloc. | |
195 | template<int size, bool big_endian> | |
196 | extern void | |
197 | gold_error_at_location(const Relocate_info<size, big_endian>*, | |
198 | size_t, off_t, const char* format, ...) | |
04bf7072 | 199 | TEMPLATE_ATTRIBUTE_PRINTF_4; |
75f2446e ILT |
200 | |
201 | // This function is called to issue a warning at the location of a | |
202 | // reloc. | |
203 | template<int size, bool big_endian> | |
204 | extern void | |
205 | gold_warning_at_location(const Relocate_info<size, big_endian>*, | |
206 | size_t, off_t, const char* format, ...) | |
04bf7072 | 207 | TEMPLATE_ATTRIBUTE_PRINTF_4; |
75f2446e | 208 | |
f073bbf7 CD |
209 | // This function is called to report an undefined symbol without |
210 | // a relocation (e.g., referenced by a dynamic object). SYM is | |
211 | // the undefined symbol. The file name associated with the SYM | |
212 | // is used to print a location for the undefined symbol. | |
213 | extern void | |
214 | gold_undefined_symbol(const Symbol*); | |
215 | ||
216 | // This function is called to report an undefined symbol resulting | |
217 | // from a relocation. SYM is the undefined symbol. RELINFO is the | |
218 | // general relocation info. RELNUM is the number of the reloc, | |
219 | // and RELOFFSET is the reloc's offset. | |
75f2446e | 220 | template<int size, bool big_endian> |
bae7f79e | 221 | extern void |
f073bbf7 CD |
222 | gold_undefined_symbol_at_location(const Symbol*, |
223 | const Relocate_info<size, big_endian>*, | |
224 | size_t, off_t); | |
bae7f79e ILT |
225 | |
226 | // This is function is called in some cases if we run out of memory. | |
227 | extern void | |
228 | gold_nomem() ATTRIBUTE_NORETURN; | |
229 | ||
a3ad94ed ILT |
230 | // This macro and function are used in cases which can not arise if |
231 | // the code is written correctly. | |
232 | ||
233 | #define gold_unreachable() \ | |
234 | (gold::do_gold_unreachable(__FILE__, __LINE__, __FUNCTION__)) | |
235 | ||
236 | extern void do_gold_unreachable(const char*, int, const char*) | |
237 | ATTRIBUTE_NORETURN; | |
238 | ||
239 | // Assertion check. | |
240 | ||
241 | #define gold_assert(expr) ((void)(!(expr) ? gold_unreachable(), 0 : 0)) | |
bae7f79e | 242 | |
8486ee48 ILT |
243 | // Print version information. |
244 | extern void | |
245 | print_version(bool print_short); | |
246 | ||
4f211c8b ILT |
247 | // Get the version string. |
248 | extern const char* | |
249 | get_version_string(); | |
250 | ||
8383303e ILT |
251 | // Convert numeric types without unnoticed loss of precision. |
252 | template<typename To, typename From> | |
253 | inline To | |
254 | convert_types(const From from) | |
255 | { | |
256 | To to = from; | |
9bb53bf8 | 257 | gold_assert(static_cast<From>(to) == from); |
8383303e ILT |
258 | return to; |
259 | } | |
260 | ||
261 | // A common case of convert_types<>: convert to section_size_type. | |
262 | template<typename From> | |
263 | inline section_size_type | |
264 | convert_to_section_size_type(const From from) | |
265 | { return convert_types<section_size_type, From>(from); } | |
266 | ||
92e059d8 ILT |
267 | // Queue up the first set of tasks. |
268 | extern void | |
269 | queue_initial_tasks(const General_options&, | |
17a1d0a9 | 270 | Dirsearch&, |
5a6f7e2d | 271 | const Command_line&, |
92e059d8 ILT |
272 | Workqueue*, |
273 | Input_objects*, | |
274 | Symbol_table*, | |
7d9e3d98 ILT |
275 | Layout*, |
276 | Mapfile*); | |
92e059d8 | 277 | |
6d03d481 ST |
278 | // Queue up the set of tasks to be done before |
279 | // the middle set of tasks. Only used when garbage | |
280 | // collection is to be done. | |
281 | extern void | |
282 | queue_middle_gc_tasks(const General_options&, | |
283 | const Task*, | |
284 | const Input_objects*, | |
285 | Symbol_table*, | |
286 | Layout*, | |
287 | Workqueue*, | |
288 | Mapfile*); | |
289 | ||
92e059d8 ILT |
290 | // Queue up the middle set of tasks. |
291 | extern void | |
292 | queue_middle_tasks(const General_options&, | |
17a1d0a9 | 293 | const Task*, |
92e059d8 ILT |
294 | const Input_objects*, |
295 | Symbol_table*, | |
296 | Layout*, | |
7d9e3d98 ILT |
297 | Workqueue*, |
298 | Mapfile*); | |
92e059d8 ILT |
299 | |
300 | // Queue up the final set of tasks. | |
61ba1cf9 ILT |
301 | extern void |
302 | queue_final_tasks(const General_options&, | |
303 | const Input_objects*, | |
304 | const Symbol_table*, | |
27bc2bce | 305 | Layout*, |
61ba1cf9 ILT |
306 | Workqueue*, |
307 | Output_file* of); | |
308 | ||
6d03d481 ST |
309 | inline bool |
310 | is_prefix_of(const char* prefix, const char* str) | |
311 | { | |
312 | return strncmp(prefix, str, strlen(prefix)) == 0; | |
313 | } | |
314 | ||
bae7f79e ILT |
315 | } // End namespace gold. |
316 | ||
317 | #endif // !defined(GOLD_GOLD_H) |