Commit | Line | Data |
---|---|---|
9846de1b | 1 | /* *INDENT-OFF* */ /* ATTR_FORMAT confuses indent, avoid running it for now */ |
c906108c | 2 | /* Basic, host-specific, and target-specific definitions for GDB. |
b6ba6518 | 3 | Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, |
4fcef00a | 4 | 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 |
c906108c SS |
5 | Free Software Foundation, Inc. |
6 | ||
c5aa993b | 7 | This file is part of GDB. |
c906108c | 8 | |
c5aa993b JM |
9 | This program is free software; you can redistribute it and/or modify |
10 | it under the terms of the GNU General Public License as published by | |
11 | the Free Software Foundation; either version 2 of the License, or | |
12 | (at your option) any later version. | |
c906108c | 13 | |
c5aa993b JM |
14 | This program is distributed in the hope that it will be useful, |
15 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | GNU General Public License for more details. | |
c906108c | 18 | |
c5aa993b JM |
19 | You should have received a copy of the GNU General Public License |
20 | along with this program; if not, write to the Free Software | |
21 | Foundation, Inc., 59 Temple Place - Suite 330, | |
22 | Boston, MA 02111-1307, USA. */ | |
c906108c SS |
23 | |
24 | #ifndef DEFS_H | |
25 | #define DEFS_H | |
26 | ||
975ac915 MK |
27 | #include "config.h" /* Generated by configure. */ |
28 | ||
c906108c | 29 | #include <stdio.h> |
975ac915 | 30 | #include <errno.h> /* System call error return status. */ |
c906108c SS |
31 | #include <limits.h> |
32 | ||
33 | #ifdef HAVE_STDDEF_H | |
917317f4 | 34 | #include <stddef.h> |
c906108c | 35 | #else |
975ac915 | 36 | #include <sys/types.h> /* For size_t. */ |
c906108c SS |
37 | #endif |
38 | ||
104c1213 JM |
39 | #ifdef HAVE_UNISTD_H |
40 | #include <unistd.h> | |
41 | #endif | |
42 | ||
167baebf MK |
43 | /* First include ansidecl.h so we can use the various macro definitions |
44 | here and in all subsequent file inclusions. */ | |
45 | ||
46 | #include "ansidecl.h" | |
47 | ||
0fbb3da7 TT |
48 | #include "gdb_locale.h" |
49 | ||
dd7bf85e DJ |
50 | /* For ``enum target_signal''. */ |
51 | #include "gdb/signals.h" | |
52 | ||
975ac915 | 53 | /* Just in case they're not defined in stdio.h. */ |
c906108c SS |
54 | |
55 | #ifndef SEEK_SET | |
56 | #define SEEK_SET 0 | |
57 | #endif | |
58 | #ifndef SEEK_CUR | |
59 | #define SEEK_CUR 1 | |
60 | #endif | |
61 | ||
975ac915 | 62 | #include <stdarg.h> /* For va_list. */ |
c906108c SS |
63 | |
64 | #include "libiberty.h" | |
65 | ||
c906108c SS |
66 | #include "progress.h" |
67 | ||
c906108c SS |
68 | /* For BFD64 and bfd_vma. */ |
69 | #include "bfd.h" | |
70 | ||
6166d547 AC |
71 | |
72 | /* The target is partially multi-arched. Both "tm.h" and the | |
73 | multi-arch vector provide definitions. "tm.h" normally overrides | |
74 | the multi-arch vector (but there are a few exceptions). */ | |
75 | ||
76 | #define GDB_MULTI_ARCH_PARTIAL 1 | |
77 | ||
83905903 AC |
78 | /* The target is partially multi-arched. Both the multi-arch vector |
79 | and "tm.h" provide definitions. "tm.h" cannot override a definition | |
80 | provided by the multi-arch vector. It is detected as a compilation | |
81 | error. | |
82 | ||
83 | This setting is only useful during a multi-arch conversion. */ | |
6166d547 AC |
84 | |
85 | #define GDB_MULTI_ARCH_TM 2 | |
86 | ||
87 | /* The target is pure multi-arch. The MULTI-ARCH vector provides all | |
5a2402b8 | 88 | definitions. "tm.h" is linked to an empty file. */ |
6166d547 AC |
89 | |
90 | #define GDB_MULTI_ARCH_PURE 3 | |
91 | ||
92 | ||
93 | ||
c906108c SS |
94 | /* An address in the program being debugged. Host byte order. Rather |
95 | than duplicate all the logic in BFD which figures out what type | |
96 | this is (long, long long, etc.) and whether it needs to be 64 | |
97 | bits (the host/target interactions are subtle), we just use | |
98 | bfd_vma. */ | |
99 | ||
100 | typedef bfd_vma CORE_ADDR; | |
101 | ||
104c1213 JM |
102 | /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */ |
103 | ||
104 | #ifndef LONGEST | |
105 | ||
106 | #ifdef BFD64 | |
107 | ||
108 | #define LONGEST BFD_HOST_64_BIT | |
109 | #define ULONGEST BFD_HOST_U_64_BIT | |
110 | ||
111 | #else /* No BFD64 */ | |
112 | ||
917317f4 JM |
113 | #ifdef CC_HAS_LONG_LONG |
114 | #define LONGEST long long | |
115 | #define ULONGEST unsigned long long | |
116 | #else | |
117 | #ifdef BFD_HOST_64_BIT | |
104c1213 JM |
118 | /* BFD_HOST_64_BIT is defined for some hosts that don't have long long |
119 | (e.g. i386-windows) so try it. */ | |
917317f4 JM |
120 | #define LONGEST BFD_HOST_64_BIT |
121 | #define ULONGEST BFD_HOST_U_64_BIT | |
122 | #else | |
123 | #define LONGEST long | |
124 | #define ULONGEST unsigned long | |
125 | #endif | |
126 | #endif | |
104c1213 JM |
127 | |
128 | #endif /* No BFD64 */ | |
129 | ||
130 | #endif /* ! LONGEST */ | |
131 | ||
c906108c SS |
132 | #ifndef min |
133 | #define min(a, b) ((a) < (b) ? (a) : (b)) | |
134 | #endif | |
135 | #ifndef max | |
136 | #define max(a, b) ((a) > (b) ? (a) : (b)) | |
137 | #endif | |
138 | ||
1a0559af AC |
139 | /* Macros to do string compares. |
140 | ||
141 | NOTE: cagney/2000-03-14: | |
142 | ||
143 | While old code can continue to refer to these macros, new code is | |
144 | probably better off using strcmp() directly vis: ``strcmp() == 0'' | |
145 | and ``strcmp() != 0''. | |
146 | ||
147 | This is because modern compilers can directly inline strcmp() | |
148 | making the original justification for these macros - avoid function | |
149 | call overhead by pre-testing the first characters | |
150 | (``*X==*Y?...:0'') - redundant. | |
151 | ||
152 | ``Even if [...] testing the first character does have a modest | |
153 | performance improvement, I'd rather that whenever a performance | |
154 | issue is found that we spend the effort on algorithmic | |
155 | optimizations than micro-optimizing.'' J.T. */ | |
c906108c | 156 | |
cb137aa5 AC |
157 | /* NOTE: cagney/2003-11-23: All instances of STREQ[N] covered by |
158 | testing GDB on a stabs system have been replaced by equivalent | |
159 | str[n]cmp calls. To avoid the possability of introducing bugs when | |
160 | making untested changes, the remaining references were deprecated | |
161 | rather than replaced. */ | |
162 | ||
e7ebf6d6 AC |
163 | /* DISCLAIMER: cagney/2003-11-23: Simplified definition of these |
164 | macros so that they just map directly onto strcmp equivalent. I'm | |
165 | not responsible for any breakage due to code that relied on the old | |
166 | underlying implementation. */ | |
167 | ||
168 | #define DEPRECATED_STREQ(a,b) (strcmp ((a), (b)) == 0) | |
169 | #define DEPRECATED_STREQN(a,b,c) (strncmp ((a), (b), (c)) == 0) | |
c906108c | 170 | |
c906108c | 171 | /* Check if a character is one of the commonly used C++ marker characters. */ |
917317f4 | 172 | extern int is_cplus_marker (int); |
c906108c | 173 | |
c906108c SS |
174 | /* enable xdb commands if set */ |
175 | extern int xdb_commands; | |
176 | ||
177 | /* enable dbx commands if set */ | |
178 | extern int dbx_commands; | |
179 | ||
030292b7 DJ |
180 | /* System root path, used to find libraries etc. */ |
181 | extern char *gdb_sysroot; | |
182 | ||
c906108c SS |
183 | extern int quit_flag; |
184 | extern int immediate_quit; | |
185 | extern int sevenbit_strings; | |
186 | ||
917317f4 | 187 | extern void quit (void); |
c906108c | 188 | |
1a0559af AC |
189 | /* FIXME: cagney/2000-03-13: It has been suggested that the peformance |
190 | benefits of having a ``QUIT'' macro rather than a function are | |
191 | marginal. If the overhead of a QUIT function call is proving | |
192 | significant then its calling frequency should probably be reduced | |
193 | [kingdon]. A profile analyzing the current situtation is | |
194 | needed. */ | |
195 | ||
c906108c SS |
196 | #ifdef QUIT |
197 | /* do twice to force compiler warning */ | |
198 | #define QUIT_FIXME "FIXME" | |
199 | #define QUIT_FIXME "ignoring redefinition of QUIT" | |
200 | #else | |
201 | #define QUIT { \ | |
202 | if (quit_flag) quit (); \ | |
203 | if (interactive_hook) interactive_hook (); \ | |
204 | PROGRESS (1); \ | |
205 | } | |
206 | #endif | |
207 | ||
c906108c SS |
208 | /* Languages represented in the symbol table and elsewhere. |
209 | This should probably be in language.h, but since enum's can't | |
210 | be forward declared to satisfy opaque references before their | |
211 | actual definition, needs to be here. */ | |
212 | ||
917317f4 JM |
213 | enum language |
214 | { | |
215 | language_unknown, /* Language not known */ | |
216 | language_auto, /* Placeholder for automatic setting */ | |
217 | language_c, /* C */ | |
218 | language_cplus, /* C++ */ | |
50f85cdf | 219 | language_objc, /* Objective-C */ |
917317f4 | 220 | language_java, /* Java */ |
917317f4 JM |
221 | language_fortran, /* Fortran */ |
222 | language_m2, /* Modula-2 */ | |
223 | language_asm, /* Assembly language */ | |
750ba382 | 224 | language_scm, /* Scheme / Guile */ |
20a0e81d JB |
225 | language_pascal, /* Pascal */ |
226 | language_minimal /* All other languages, minimal support only */ | |
917317f4 | 227 | }; |
c906108c SS |
228 | |
229 | enum precision_type | |
917317f4 JM |
230 | { |
231 | single_precision, | |
232 | double_precision, | |
233 | unspecified_precision | |
234 | }; | |
235 | ||
7f19b9a2 AC |
236 | /* A generic, not quite boolean, enumeration. */ |
237 | enum auto_boolean | |
238 | { | |
239 | AUTO_BOOLEAN_TRUE, | |
240 | AUTO_BOOLEAN_FALSE, | |
241 | AUTO_BOOLEAN_AUTO | |
242 | }; | |
243 | ||
92ad9cd9 AC |
244 | /* Potential ways that a function can return a value of a given type. */ |
245 | enum return_value_convention | |
246 | { | |
247 | /* Where the return value has been squeezed into one or more | |
248 | registers. */ | |
249 | RETURN_VALUE_REGISTER_CONVENTION, | |
250 | /* Commonly known as the "struct return convention". The caller | |
251 | passes an additional hidden first parameter to the caller. That | |
252 | parameter contains the address at which the value being returned | |
253 | should be stored. While typically, and historically, used for | |
254 | large structs, this is convention is applied to values of many | |
255 | different types. */ | |
256 | RETURN_VALUE_STRUCT_CONVENTION | |
257 | }; | |
258 | ||
c906108c SS |
259 | /* the cleanup list records things that have to be undone |
260 | if an error happens (descriptors to be closed, memory to be freed, etc.) | |
261 | Each link in the chain records a function to call and an | |
262 | argument to give it. | |
263 | ||
264 | Use make_cleanup to add an element to the cleanup chain. | |
265 | Use do_cleanups to do all cleanup actions back to a given | |
266 | point in the chain. Use discard_cleanups to remove cleanups | |
267 | from the chain back to a given point, not doing them. */ | |
268 | ||
269 | struct cleanup | |
917317f4 JM |
270 | { |
271 | struct cleanup *next; | |
4efb68b1 AC |
272 | void (*function) (void *); |
273 | void *arg; | |
917317f4 | 274 | }; |
c906108c SS |
275 | |
276 | ||
277 | /* The ability to declare that a function never returns is useful, but | |
278 | not really required to compile GDB successfully, so the NORETURN and | |
279 | ATTR_NORETURN macros normally expand into nothing. */ | |
280 | ||
281 | /* If compiling with older versions of GCC, a function may be declared | |
282 | "volatile" to indicate that it does not return. */ | |
283 | ||
284 | #ifndef NORETURN | |
917317f4 | 285 | #if defined(__GNUC__) \ |
c906108c | 286 | && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)) |
917317f4 JM |
287 | #define NORETURN volatile |
288 | #else | |
289 | #define NORETURN /* nothing */ | |
290 | #endif | |
c906108c SS |
291 | #endif |
292 | ||
293 | /* GCC 2.5 and later versions define a function attribute "noreturn", | |
294 | which is the preferred way to declare that a function never returns. | |
295 | However GCC 2.7 appears to be the first version in which this fully | |
296 | works everywhere we use it. */ | |
297 | ||
298 | #ifndef ATTR_NORETURN | |
7d418785 | 299 | #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)) |
917317f4 JM |
300 | #define ATTR_NORETURN __attribute__ ((noreturn)) |
301 | #else | |
302 | #define ATTR_NORETURN /* nothing */ | |
303 | #endif | |
c906108c SS |
304 | #endif |
305 | ||
306 | #ifndef ATTR_FORMAT | |
7d418785 | 307 | #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4)) |
917317f4 JM |
308 | #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y))) |
309 | #else | |
310 | #define ATTR_FORMAT(type, x, y) /* nothing */ | |
311 | #endif | |
c906108c SS |
312 | #endif |
313 | ||
87193939 MC |
314 | /* Be conservative and use enum bitfields only with GCC. |
315 | This is copied from gcc 3.3.1, system.h. */ | |
316 | ||
317 | #if defined(__GNUC__) && (__GNUC__ >= 2) | |
318 | #define ENUM_BITFIELD(TYPE) enum TYPE | |
319 | #else | |
320 | #define ENUM_BITFIELD(TYPE) unsigned int | |
321 | #endif | |
322 | ||
c906108c SS |
323 | /* Needed for various prototypes */ |
324 | ||
c906108c SS |
325 | struct symtab; |
326 | struct breakpoint; | |
6e4c6c91 | 327 | struct frame_info; |
c906108c SS |
328 | |
329 | /* From blockframe.c */ | |
330 | ||
6e4c6c91 | 331 | extern int inside_entry_func (struct frame_info *this_frame); |
c906108c | 332 | |
627b3ba2 | 333 | extern int deprecated_inside_entry_file (CORE_ADDR addr); |
c906108c | 334 | |
917317f4 | 335 | extern int inside_main_func (CORE_ADDR pc); |
c906108c | 336 | |
c906108c SS |
337 | /* From utils.c */ |
338 | ||
917317f4 | 339 | extern void initialize_utils (void); |
392a587b | 340 | |
917317f4 | 341 | extern void notice_quit (void); |
c906108c | 342 | |
917317f4 | 343 | extern int strcmp_iw (const char *, const char *); |
c906108c | 344 | |
0fe19209 DC |
345 | extern int strcmp_iw_ordered (const char *, const char *); |
346 | ||
2de7ced7 DJ |
347 | extern int streq (const char *, const char *); |
348 | ||
917317f4 | 349 | extern int subset_compare (char *, char *); |
7a292a7a | 350 | |
917317f4 | 351 | extern char *safe_strerror (int); |
c906108c | 352 | |
917317f4 | 353 | extern void init_malloc (void *); |
c906108c | 354 | |
917317f4 | 355 | extern void request_quit (int); |
c906108c | 356 | |
917317f4 JM |
357 | extern void do_cleanups (struct cleanup *); |
358 | extern void do_final_cleanups (struct cleanup *); | |
917317f4 JM |
359 | extern void do_run_cleanups (struct cleanup *); |
360 | extern void do_exec_cleanups (struct cleanup *); | |
361 | extern void do_exec_error_cleanups (struct cleanup *); | |
c906108c | 362 | |
917317f4 JM |
363 | extern void discard_cleanups (struct cleanup *); |
364 | extern void discard_final_cleanups (struct cleanup *); | |
365 | extern void discard_exec_error_cleanups (struct cleanup *); | |
366 | extern void discard_my_cleanups (struct cleanup **, struct cleanup *); | |
c906108c | 367 | |
e4005526 AC |
368 | /* NOTE: cagney/2000-03-04: This typedef is strictly for the |
369 | make_cleanup function declarations below. Do not use this typedef | |
370 | as a cast when passing functions into the make_cleanup() code. | |
371 | Instead either use a bounce function or add a wrapper function. | |
372 | Calling a f(char*) function with f(void*) is non-portable. */ | |
373 | typedef void (make_cleanup_ftype) (void *); | |
374 | ||
375 | extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *); | |
c906108c | 376 | |
917317f4 | 377 | extern struct cleanup *make_cleanup_freeargv (char **); |
7a292a7a | 378 | |
d9fcf2fb JM |
379 | struct ui_file; |
380 | extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *); | |
11cf8741 | 381 | |
f5ff8c83 AC |
382 | extern struct cleanup *make_cleanup_close (int fd); |
383 | ||
5c65bbb6 AC |
384 | extern struct cleanup *make_cleanup_bfd_close (bfd *abfd); |
385 | ||
e4005526 | 386 | extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *); |
c906108c | 387 | |
917317f4 | 388 | extern struct cleanup *make_my_cleanup (struct cleanup **, |
e4005526 | 389 | make_cleanup_ftype *, void *); |
c906108c | 390 | |
e4005526 | 391 | extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *); |
c906108c | 392 | |
e4005526 AC |
393 | extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *); |
394 | extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *); | |
43ff13b4 | 395 | |
917317f4 JM |
396 | extern struct cleanup *save_cleanups (void); |
397 | extern struct cleanup *save_final_cleanups (void); | |
398 | extern struct cleanup *save_my_cleanups (struct cleanup **); | |
c906108c | 399 | |
917317f4 JM |
400 | extern void restore_cleanups (struct cleanup *); |
401 | extern void restore_final_cleanups (struct cleanup *); | |
402 | extern void restore_my_cleanups (struct cleanup **, struct cleanup *); | |
c906108c | 403 | |
2f9429ae | 404 | extern void free_current_contents (void *); |
c906108c | 405 | |
e54a9244 | 406 | extern void null_cleanup (void *); |
c906108c | 407 | |
917317f4 | 408 | extern int myread (int, char *, int); |
c906108c | 409 | |
6972bc8b | 410 | extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2); |
c906108c | 411 | |
917317f4 | 412 | extern void init_page_info (void); |
392a587b | 413 | |
58d370e0 | 414 | extern char *gdb_realpath (const char *); |
08b204d1 | 415 | extern char *xfullpath (const char *); |
58d370e0 | 416 | |
5b5d99cf JB |
417 | extern unsigned long gnu_debuglink_crc32 (unsigned long crc, |
418 | unsigned char *buf, size_t len); | |
419 | ||
c906108c SS |
420 | /* From demangle.c */ |
421 | ||
917317f4 | 422 | extern void set_demangling_style (char *); |
c906108c SS |
423 | |
424 | /* From tm.h */ | |
425 | ||
426 | struct type; | |
917317f4 | 427 | typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type); |
c906108c SS |
428 | extern use_struct_convention_fn generic_use_struct_convention; |
429 | ||
c906108c SS |
430 | \f |
431 | /* Annotation stuff. */ | |
432 | ||
917317f4 | 433 | extern int annotation_level; /* in stack.c */ |
c906108c | 434 | \f |
917317f4 | 435 | extern void begin_line (void); |
c906108c | 436 | |
917317f4 | 437 | extern void wrap_here (char *); |
c906108c | 438 | |
917317f4 | 439 | extern void reinitialize_more_filter (void); |
c906108c | 440 | |
0f71a2f6 | 441 | /* Normal results */ |
d9fcf2fb | 442 | extern struct ui_file *gdb_stdout; |
449092f6 CV |
443 | /* Input stream */ |
444 | extern struct ui_file *gdb_stdin; | |
0f71a2f6 | 445 | /* Serious error notifications */ |
d9fcf2fb | 446 | extern struct ui_file *gdb_stderr; |
0f71a2f6 | 447 | /* Log/debug/trace messages that should bypass normal stdout/stderr |
1cd348be | 448 | filtering. For moment, always call this stream using |
0f71a2f6 JM |
449 | *_unfiltered. In the very near future that restriction shall be |
450 | removed - either call shall be unfiltered. (cagney 1999-06-13). */ | |
d9fcf2fb | 451 | extern struct ui_file *gdb_stdlog; |
43ff13b4 | 452 | /* Target output that should bypass normal stdout/stderr filtering. |
1cd348be | 453 | For moment, always call this stream using *_unfiltered. In the |
43ff13b4 JM |
454 | very near future that restriction shall be removed - either call |
455 | shall be unfiltered. (cagney 1999-07-02). */ | |
d9fcf2fb | 456 | extern struct ui_file *gdb_stdtarg; |
449092f6 CV |
457 | extern struct ui_file *gdb_stdtargerr; |
458 | extern struct ui_file *gdb_stdtargin; | |
c906108c | 459 | |
d9fcf2fb | 460 | #include "ui-file.h" |
c906108c | 461 | |
d1f4cff8 AC |
462 | /* More generic printf like operations. Filtered versions may return |
463 | non-locally on error. */ | |
c906108c | 464 | |
d9fcf2fb | 465 | extern void fputs_filtered (const char *, struct ui_file *); |
c906108c | 466 | |
d9fcf2fb | 467 | extern void fputs_unfiltered (const char *, struct ui_file *); |
c906108c | 468 | |
d9fcf2fb | 469 | extern int fputc_filtered (int c, struct ui_file *); |
c906108c | 470 | |
d9fcf2fb | 471 | extern int fputc_unfiltered (int c, struct ui_file *); |
c906108c | 472 | |
d1f4cff8 AC |
473 | extern int putchar_filtered (int c); |
474 | ||
917317f4 | 475 | extern int putchar_unfiltered (int c); |
c906108c | 476 | |
917317f4 | 477 | extern void puts_filtered (const char *); |
c906108c | 478 | |
917317f4 | 479 | extern void puts_unfiltered (const char *); |
c906108c | 480 | |
4a351cef AF |
481 | extern void puts_filtered_tabular (char *string, int width, int right); |
482 | ||
917317f4 | 483 | extern void puts_debug (char *prefix, char *string, char *suffix); |
c906108c | 484 | |
917317f4 | 485 | extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0); |
c906108c | 486 | |
d9fcf2fb | 487 | extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0); |
c906108c | 488 | |
d9fcf2fb | 489 | extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3); |
c906108c | 490 | |
d9fcf2fb | 491 | extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4); |
c906108c | 492 | |
917317f4 | 493 | extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2); |
c906108c | 494 | |
917317f4 | 495 | extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3); |
c906108c | 496 | |
917317f4 | 497 | extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0); |
c906108c | 498 | |
d9fcf2fb | 499 | extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0); |
c906108c | 500 | |
d9fcf2fb | 501 | extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3); |
917317f4 JM |
502 | |
503 | extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2); | |
c906108c | 504 | |
d9fcf2fb | 505 | extern void print_spaces (int, struct ui_file *); |
c906108c | 506 | |
d9fcf2fb | 507 | extern void print_spaces_filtered (int, struct ui_file *); |
c906108c | 508 | |
917317f4 | 509 | extern char *n_spaces (int); |
c906108c | 510 | |
d9fcf2fb | 511 | extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream); |
43e526b9 | 512 | |
d9fcf2fb | 513 | extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream); |
43e526b9 | 514 | |
d9fcf2fb | 515 | extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream); |
c906108c | 516 | |
d4f3574e | 517 | /* Display the host ADDR on STREAM formatted as ``0x%x''. */ |
ac16bf07 | 518 | extern void gdb_print_host_address (const void *addr, struct ui_file *stream); |
c906108c | 519 | |
104c1213 JM |
520 | /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx. |
521 | paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is | |
522 | for ``%*''. */ | |
d4f3574e | 523 | extern int strlen_paddr (void); |
917317f4 JM |
524 | extern char *paddr (CORE_ADDR addr); |
525 | extern char *paddr_nz (CORE_ADDR addr); | |
526 | extern char *paddr_u (CORE_ADDR addr); | |
527 | extern char *paddr_d (LONGEST addr); | |
c906108c | 528 | |
5683e87a AC |
529 | extern char *phex (ULONGEST l, int sizeof_l); |
530 | extern char *phex_nz (ULONGEST l, int sizeof_l); | |
c906108c | 531 | |
03dd37c3 AC |
532 | /* Like paddr() only print/scan raw CORE_ADDR. The output from |
533 | core_addr_to_string() can be passed direct to | |
534 | string_to_core_addr(). */ | |
535 | extern const char *core_addr_to_string (const CORE_ADDR addr); | |
079777f6 | 536 | extern const char *core_addr_to_string_nz (const CORE_ADDR addr); |
03dd37c3 AC |
537 | extern CORE_ADDR string_to_core_addr (const char *my_string); |
538 | ||
d9fcf2fb | 539 | extern void fprintf_symbol_filtered (struct ui_file *, char *, |
917317f4 | 540 | enum language, int); |
c906108c | 541 | |
6972bc8b | 542 | extern NORETURN void perror_with_name (const char *) ATTR_NORETURN; |
c906108c | 543 | |
6972bc8b | 544 | extern void print_sys_errmsg (const char *, int); |
c906108c SS |
545 | |
546 | /* From regex.c or libc. BSD 4.4 declares this with the argument type as | |
547 | "const char *" in unistd.h, so we can't declare the argument | |
548 | as "char *". */ | |
549 | ||
917317f4 | 550 | extern char *re_comp (const char *); |
c906108c SS |
551 | |
552 | /* From symfile.c */ | |
553 | ||
917317f4 JM |
554 | extern void symbol_file_command (char *, int); |
555 | ||
556 | /* Remote targets may wish to use this as their load function. */ | |
557 | extern void generic_load (char *name, int from_tty); | |
558 | ||
559 | /* Summarise a download */ | |
d9fcf2fb | 560 | extern void print_transfer_performance (struct ui_file *stream, |
917317f4 JM |
561 | unsigned long data_count, |
562 | unsigned long write_count, | |
563 | unsigned long time_count); | |
c906108c SS |
564 | |
565 | /* From top.c */ | |
566 | ||
6426a772 JM |
567 | typedef void initialize_file_ftype (void); |
568 | ||
389e51db AC |
569 | extern char *skip_quoted (char *); |
570 | ||
917317f4 | 571 | extern char *gdb_readline (char *); |
c906108c | 572 | |
b4f5539f TT |
573 | extern char *gdb_readline_wrapper (char *); |
574 | ||
917317f4 | 575 | extern char *command_line_input (char *, int, char *); |
c906108c | 576 | |
917317f4 | 577 | extern void print_prompt (void); |
c906108c | 578 | |
917317f4 | 579 | extern int input_from_terminal_p (void); |
c906108c SS |
580 | |
581 | extern int info_verbose; | |
582 | ||
583 | /* From printcmd.c */ | |
584 | ||
917317f4 | 585 | extern void set_next_address (CORE_ADDR); |
c906108c | 586 | |
d9fcf2fb | 587 | extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int, |
917317f4 | 588 | char *); |
c906108c | 589 | |
dfcd3bfb | 590 | extern int build_address_symbolic (CORE_ADDR addr, |
7b83ea04 AC |
591 | int do_demangle, |
592 | char **name, | |
593 | int *offset, | |
594 | char **filename, | |
595 | int *line, | |
dfcd3bfb JM |
596 | int *unmapped); |
597 | ||
d9fcf2fb | 598 | extern void print_address_numeric (CORE_ADDR, int, struct ui_file *); |
c906108c | 599 | |
d9fcf2fb | 600 | extern void print_address (CORE_ADDR, struct ui_file *); |
c906108c SS |
601 | |
602 | /* From source.c */ | |
603 | ||
1f8cc6db | 604 | extern int openp (const char *, int, const char *, int, int, char **); |
c906108c | 605 | |
917317f4 | 606 | extern int source_full_path_of (char *, char **); |
c906108c | 607 | |
917317f4 | 608 | extern void mod_path (char *, char **); |
c906108c | 609 | |
c04e0a08 JJ |
610 | extern void add_path (char *, char **, int); |
611 | ||
917317f4 | 612 | extern void directory_command (char *, int); |
c906108c | 613 | |
c04e0a08 JJ |
614 | extern char *source_path; |
615 | ||
917317f4 | 616 | extern void init_source_path (void); |
c906108c | 617 | |
c04e0a08 JJ |
618 | extern void init_last_source_visited (void); |
619 | ||
917317f4 | 620 | extern char *symtab_to_filename (struct symtab *); |
c906108c | 621 | |
104c1213 JM |
622 | /* From exec.c */ |
623 | ||
624 | extern void exec_set_section_offsets (bfd_signed_vma text_off, | |
625 | bfd_signed_vma data_off, | |
626 | bfd_signed_vma bss_off); | |
627 | ||
be4d1333 MS |
628 | /* Take over the 'find_mapped_memory' vector from exec.c. */ |
629 | extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR, | |
630 | unsigned long, | |
631 | int, int, int, | |
632 | void *), | |
633 | void *)); | |
634 | ||
53a5351d JM |
635 | /* Possible lvalue types. Like enum language, this should be in |
636 | value.h, but needs to be here for the same reason. */ | |
637 | ||
638 | enum lval_type | |
639 | { | |
640 | /* Not an lval. */ | |
641 | not_lval, | |
642 | /* In memory. Could be a saved register. */ | |
643 | lval_memory, | |
644 | /* In a register. */ | |
645 | lval_register, | |
646 | /* In a gdb internal variable. */ | |
647 | lval_internalvar, | |
648 | /* Part of a gdb internal variable (structure field). */ | |
649 | lval_internalvar_component, | |
650 | /* In a register series in a frame not the current one, which may have been | |
651 | partially saved or saved in different places (otherwise would be | |
652 | lval_register or lval_memory). */ | |
653 | lval_reg_frame_relative | |
654 | }; | |
655 | ||
c906108c SS |
656 | /* Control types for commands */ |
657 | ||
658 | enum misc_command_type | |
917317f4 JM |
659 | { |
660 | ok_command, | |
661 | end_command, | |
662 | else_command, | |
663 | nop_command | |
664 | }; | |
c906108c SS |
665 | |
666 | enum command_control_type | |
917317f4 JM |
667 | { |
668 | simple_control, | |
669 | break_control, | |
670 | continue_control, | |
671 | while_control, | |
672 | if_control, | |
673 | invalid_control | |
674 | }; | |
c906108c SS |
675 | |
676 | /* Structure for saved commands lines | |
677 | (for breakpoints, defined commands, etc). */ | |
678 | ||
679 | struct command_line | |
917317f4 JM |
680 | { |
681 | struct command_line *next; | |
682 | char *line; | |
683 | enum command_control_type control_type; | |
684 | int body_count; | |
685 | struct command_line **body_list; | |
686 | }; | |
c906108c | 687 | |
917317f4 | 688 | extern struct command_line *read_command_lines (char *, int); |
c906108c | 689 | |
917317f4 | 690 | extern void free_command_lines (struct command_line **); |
c906108c | 691 | |
7b83ea04 AC |
692 | /* To continue the execution commands when running gdb asynchronously. |
693 | A continuation structure contains a pointer to a function to be called | |
43ff13b4 JM |
694 | to finish the command, once the target has stopped. Such mechanism is |
695 | used bt the finish and until commands, and in the remote protocol | |
696 | when opening an extended-remote connection. */ | |
697 | ||
698 | struct continuation_arg | |
917317f4 JM |
699 | { |
700 | struct continuation_arg *next; | |
57e687d9 MS |
701 | union continuation_data { |
702 | void *pointer; | |
703 | int integer; | |
704 | long longint; | |
705 | } data; | |
917317f4 | 706 | }; |
43ff13b4 JM |
707 | |
708 | struct continuation | |
917317f4 JM |
709 | { |
710 | void (*continuation_hook) (struct continuation_arg *); | |
711 | struct continuation_arg *arg_list; | |
712 | struct continuation *next; | |
713 | }; | |
43ff13b4 JM |
714 | |
715 | /* In infrun.c. */ | |
716 | extern struct continuation *cmd_continuation; | |
c2d11a7d JM |
717 | /* Used only by the step_1 function. */ |
718 | extern struct continuation *intermediate_continuation; | |
43ff13b4 JM |
719 | |
720 | /* From utils.c */ | |
917317f4 JM |
721 | extern void add_continuation (void (*)(struct continuation_arg *), |
722 | struct continuation_arg *); | |
723 | extern void do_all_continuations (void); | |
724 | extern void discard_all_continuations (void); | |
43ff13b4 | 725 | |
c2d11a7d JM |
726 | extern void add_intermediate_continuation (void (*)(struct continuation_arg *), |
727 | struct continuation_arg *); | |
728 | extern void do_all_intermediate_continuations (void); | |
729 | extern void discard_all_intermediate_continuations (void); | |
730 | ||
c906108c SS |
731 | /* String containing the current directory (what getwd would return). */ |
732 | ||
733 | extern char *current_directory; | |
734 | ||
735 | /* Default radixes for input and output. Only some values supported. */ | |
736 | extern unsigned input_radix; | |
737 | extern unsigned output_radix; | |
738 | ||
739 | /* Possibilities for prettyprint parameters to routines which print | |
740 | things. Like enum language, this should be in value.h, but needs | |
741 | to be here for the same reason. FIXME: If we can eliminate this | |
742 | as an arg to LA_VAL_PRINT, then we can probably move it back to | |
743 | value.h. */ | |
744 | ||
745 | enum val_prettyprint | |
917317f4 JM |
746 | { |
747 | Val_no_prettyprint = 0, | |
748 | Val_prettyprint, | |
749 | /* Use the default setting which the user has specified. */ | |
750 | Val_pretty_default | |
751 | }; | |
39f77062 | 752 | |
ca6724c1 KB |
753 | /* The ptid struct is a collection of the various "ids" necessary |
754 | for identifying the inferior. This consists of the process id | |
755 | (pid), thread id (tid), and other fields necessary for uniquely | |
756 | identifying the inferior process/thread being debugged. When | |
757 | manipulating ptids, the constructors, accessors, and predicate | |
758 | declared in inferior.h should be used. These are as follows: | |
759 | ||
760 | ptid_build - Make a new ptid from a pid, lwp, and tid. | |
761 | pid_to_ptid - Make a new ptid from just a pid. | |
762 | ptid_get_pid - Fetch the pid component of a ptid. | |
763 | ptid_get_lwp - Fetch the lwp component of a ptid. | |
764 | ptid_get_tid - Fetch the tid component of a ptid. | |
765 | ptid_equal - Test to see if two ptids are equal. | |
766 | ||
767 | Please do NOT access the struct ptid members directly (except, of | |
768 | course, in the implementation of the above ptid manipulation | |
769 | functions). */ | |
770 | ||
771 | struct ptid | |
772 | { | |
773 | /* Process id */ | |
774 | int pid; | |
39f77062 | 775 | |
ca6724c1 KB |
776 | /* Lightweight process id */ |
777 | long lwp; | |
39f77062 | 778 | |
ca6724c1 KB |
779 | /* Thread id */ |
780 | long tid; | |
781 | }; | |
39f77062 | 782 | |
ca6724c1 | 783 | typedef struct ptid ptid_t; |
39f77062 | 784 | |
c906108c | 785 | \f |
917317f4 | 786 | |
5a2402b8 AC |
787 | /* Optional host machine definition. Pure autoconf targets will not |
788 | need a "xm.h" file. This will be a symlink to one of the xm-*.h | |
789 | files, built by the `configure' script. */ | |
c906108c | 790 | |
5a2402b8 | 791 | #ifdef GDB_XM_FILE |
c906108c | 792 | #include "xm.h" |
5a2402b8 | 793 | #endif |
c906108c | 794 | |
5a2402b8 AC |
795 | /* Optional native machine support. Non-native (and possibly pure |
796 | multi-arch) targets do not need a "nm.h" file. This will be a | |
797 | symlink to one of the nm-*.h files, built by the `configure' | |
798 | script. */ | |
c906108c | 799 | |
5a2402b8 | 800 | #ifdef GDB_NM_FILE |
c906108c | 801 | #include "nm.h" |
5a2402b8 | 802 | #endif |
c906108c | 803 | |
5a2402b8 AC |
804 | /* Optional target machine definition. Pure multi-arch configurations |
805 | do not need a "tm.h" file. This will be a symlink to one of the | |
c906108c SS |
806 | tm-*.h files, built by the `configure' script. */ |
807 | ||
5a2402b8 | 808 | #ifdef GDB_TM_FILE |
c906108c | 809 | #include "tm.h" |
6166d547 AC |
810 | #endif |
811 | ||
c906108c SS |
812 | /* If the xm.h file did not define the mode string used to open the |
813 | files, assume that binary files are opened the same way as text | |
814 | files */ | |
815 | #ifndef FOPEN_RB | |
816 | #include "fopen-same.h" | |
817 | #endif | |
818 | ||
c906108c SS |
819 | /* Defaults for system-wide constants (if not defined by xm.h, we fake it). |
820 | FIXME: Assumes 2's complement arithmetic */ | |
821 | ||
822 | #if !defined (UINT_MAX) | |
917317f4 | 823 | #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */ |
c906108c SS |
824 | #endif |
825 | ||
826 | #if !defined (INT_MAX) | |
917317f4 | 827 | #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */ |
c906108c SS |
828 | #endif |
829 | ||
830 | #if !defined (INT_MIN) | |
831 | #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */ | |
832 | #endif | |
833 | ||
834 | #if !defined (ULONG_MAX) | |
835 | #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */ | |
836 | #endif | |
837 | ||
838 | #if !defined (LONG_MAX) | |
839 | #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */ | |
840 | #endif | |
841 | ||
4ce44c66 | 842 | #if !defined (ULONGEST_MAX) |
658d99ff | 843 | #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */ |
4ce44c66 JM |
844 | #endif |
845 | ||
658d99ff | 846 | #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */ |
4ce44c66 JM |
847 | #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1)) |
848 | #endif | |
849 | ||
c906108c SS |
850 | /* Convert a LONGEST to an int. This is used in contexts (e.g. number of |
851 | arguments to a function, number in a value history, register number, etc.) | |
852 | where the value must not be larger than can fit in an int. */ | |
853 | ||
917317f4 | 854 | extern int longest_to_int (LONGEST); |
c906108c | 855 | |
7b83ea04 | 856 | /* Assorted functions we can declare, now that const and volatile are |
c906108c SS |
857 | defined. */ |
858 | ||
5565b556 | 859 | extern char *savestring (const char *, size_t); |
c906108c | 860 | |
5565b556 | 861 | extern char *msavestring (void *, const char *, size_t); |
c906108c | 862 | |
917317f4 | 863 | extern char *mstrsave (void *, const char *); |
c906108c | 864 | |
c0e61796 AC |
865 | /* Robust versions of same. Throw an internal error when no memory, |
866 | guard against stray NULL arguments. */ | |
867 | extern void *xmmalloc (void *md, size_t size); | |
868 | extern void *xmrealloc (void *md, void *ptr, size_t size); | |
869 | extern void *xmcalloc (void *md, size_t number, size_t size); | |
870 | extern void xmfree (void *md, void *ptr); | |
871 | ||
872 | /* xmalloc(), xrealloc() and xcalloc() have already been declared in | |
873 | "libiberty.h". */ | |
874 | extern void xfree (void *); | |
875 | ||
bba2d28d AC |
876 | /* Utility macros to allocate typed memory. Avoids errors like: |
877 | struct foo *foo = xmalloc (sizeof struct bar); and memset (foo, | |
878 | sizeof (struct foo), 0). */ | |
879 | #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE))) | |
349c5d5f | 880 | #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE))) |
3fadccb3 | 881 | #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE))) |
349c5d5f | 882 | |
76995688 AC |
883 | /* Like asprintf/vasprintf but get an internal_error if the call |
884 | fails. */ | |
885 | extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3); | |
886 | extern void xvasprintf (char **ret, const char *format, va_list ap); | |
887 | ||
9ebf4acf AC |
888 | /* Like asprintf, but return the string, throw an error if no memory. */ |
889 | extern char *xstrprintf (const char *format, ...) ATTR_FORMAT (printf, 1, 2); | |
890 | ||
917317f4 | 891 | extern int parse_escape (char **); |
c906108c | 892 | |
c906108c SS |
893 | /* Message to be printed before the error message, when an error occurs. */ |
894 | ||
895 | extern char *error_pre_print; | |
896 | ||
897 | /* Message to be printed before the error message, when an error occurs. */ | |
898 | ||
899 | extern char *quit_pre_print; | |
900 | ||
901 | /* Message to be printed before the warning message, when a warning occurs. */ | |
902 | ||
903 | extern char *warning_pre_print; | |
904 | ||
4ce44c66 | 905 | extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN; |
c906108c | 906 | |
823ca731 | 907 | extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2); |
c906108c | 908 | |
4fcef00a JJ |
909 | extern NORETURN void error_silent (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2); |
910 | ||
d9fcf2fb | 911 | extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN; |
2acceee2 | 912 | |
b9362cc7 AC |
913 | /* Initialize the error buffer. */ |
914 | extern void error_init (void); | |
915 | ||
4ce44c66 JM |
916 | /* Returns a freshly allocate buffer containing the last error |
917 | message. */ | |
917317f4 | 918 | extern char *error_last_message (void); |
2acceee2 | 919 | |
4fcef00a JJ |
920 | /* Output arbitrary error message. */ |
921 | extern void error_output_message (char *pre_print, char *msg); | |
922 | ||
8e65ff28 AC |
923 | extern NORETURN void internal_verror (const char *file, int line, |
924 | const char *, va_list ap) ATTR_NORETURN; | |
4ce44c66 | 925 | |
8e65ff28 AC |
926 | extern NORETURN void internal_error (const char *file, int line, |
927 | const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4); | |
4ce44c66 | 928 | |
dec43320 AC |
929 | extern void internal_vwarning (const char *file, int line, |
930 | const char *, va_list ap); | |
931 | ||
932 | extern void internal_warning (const char *file, int line, | |
933 | const char *, ...) ATTR_FORMAT (printf, 3, 4); | |
934 | ||
917317f4 | 935 | extern NORETURN void nomem (long) ATTR_NORETURN; |
c906108c | 936 | |
b5a2688f | 937 | /* Reasons for calling throw_exception(). NOTE: all reason values |
f9c696d2 AC |
938 | must be less than zero. enum value 0 is reserved for internal use |
939 | as the return value from an initial setjmp(). The function | |
940 | catch_exceptions() reserves values >= 0 as legal results from its | |
941 | wrapped function. */ | |
c906108c | 942 | |
917317f4 JM |
943 | enum return_reason |
944 | { | |
945 | /* User interrupt. */ | |
f9c696d2 | 946 | RETURN_QUIT = -2, |
917317f4 JM |
947 | /* Any other error. */ |
948 | RETURN_ERROR | |
949 | }; | |
c906108c | 950 | |
43ff13b4 JM |
951 | #define ALL_CLEANUPS ((struct cleanup *)0) |
952 | ||
f9c696d2 | 953 | #define RETURN_MASK(reason) (1 << (int)(-reason)) |
99eeeb0f ND |
954 | #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT) |
955 | #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR) | |
956 | #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR) | |
c906108c SS |
957 | typedef int return_mask; |
958 | ||
ab290c52 | 959 | /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP |
b5a2688f AC |
960 | to the inner most containing exception handler established using |
961 | catch_exceptions() (or the legacy catch_errors()). | |
ab290c52 | 962 | |
b5a2688f AC |
963 | Code normally throws an exception using error() et.al. For various |
964 | reaons, GDB also contains code that throws an exception directly. | |
965 | For instance, the remote*.c targets contain CNTRL-C signal handlers | |
966 | that propogate the QUIT event up the exception chain. ``This could | |
967 | be a good thing or a dangerous thing.'' -- the Existential Wombat. */ | |
ab290c52 | 968 | |
b5a2688f | 969 | extern NORETURN void throw_exception (enum return_reason) ATTR_NORETURN; |
c906108c | 970 | |
f9c696d2 AC |
971 | /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception |
972 | handler. If an exception (enum return_reason) is thrown using | |
b5a2688f | 973 | throw_exception() than all cleanups installed since |
f9c696d2 AC |
974 | catch_exceptions() was entered are invoked, the (-ve) exception |
975 | value is then returned by catch_exceptions. If FUNC() returns | |
976 | normally (with a postive or zero return value) then that value is | |
977 | returned by catch_exceptions(). It is an internal_error() for | |
978 | FUNC() to return a negative value. | |
979 | ||
980 | For the period of the FUNC() call: UIOUT is installed as the output | |
981 | builder; ERRSTRING is installed as the error/quit message; and a | |
982 | new cleanup_chain is established. The old values are restored | |
983 | before catch_exceptions() returns. | |
984 | ||
4fcef00a JJ |
985 | The variant catch_exceptions_with_msg() is the same as |
986 | catch_exceptions() but adds the ability to return an allocated | |
987 | copy of the gdb error message. This is used when a silent error is | |
988 | issued and the caller wants to manually issue the error message. | |
989 | ||
f9c696d2 AC |
990 | FIXME; cagney/2001-08-13: The need to override the global UIOUT |
991 | builder variable should just go away. | |
992 | ||
993 | This function superseeds catch_errors(). | |
994 | ||
995 | This function uses SETJMP() and LONGJUMP(). */ | |
996 | ||
997 | struct ui_out; | |
998 | typedef int (catch_exceptions_ftype) (struct ui_out *ui_out, void *args); | |
999 | extern int catch_exceptions (struct ui_out *uiout, | |
1000 | catch_exceptions_ftype *func, void *func_args, | |
1001 | char *errstring, return_mask mask); | |
4fcef00a JJ |
1002 | extern int catch_exceptions_with_msg (struct ui_out *uiout, |
1003 | catch_exceptions_ftype *func, | |
1004 | void *func_args, | |
1005 | char *errstring, char **gdberrmsg, | |
1006 | return_mask mask); | |
f9c696d2 | 1007 | |
11cf8741 JM |
1008 | /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero |
1009 | otherwize the result from CATCH_ERRORS_FTYPE is returned. It is | |
1010 | probably useful for CATCH_ERRORS_FTYPE to always return a non-zero | |
1011 | value. It's unfortunate that, catch_errors() does not return an | |
1012 | indication of the exact exception that it caught - quit_flag might | |
f9c696d2 AC |
1013 | help. |
1014 | ||
1015 | This function is superseeded by catch_exceptions(). */ | |
11cf8741 | 1016 | |
4efb68b1 | 1017 | typedef int (catch_errors_ftype) (void *); |
12b9c64f | 1018 | extern int catch_errors (catch_errors_ftype *, void *, char *, return_mask); |
c906108c | 1019 | |
11cf8741 JM |
1020 | /* Template to catch_errors() that wraps calls to command |
1021 | functions. */ | |
1022 | ||
1023 | typedef void (catch_command_errors_ftype) (char *, int); | |
1024 | extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask); | |
1025 | ||
917317f4 | 1026 | extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2); |
c906108c | 1027 | |
f5a96129 AC |
1028 | extern void vwarning (const char *, va_list args); |
1029 | ||
4be87837 DJ |
1030 | /* List of known OS ABIs. If you change this, make sure to update the |
1031 | table in osabi.c. */ | |
1032 | enum gdb_osabi | |
1033 | { | |
1034 | GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */ | |
1035 | ||
1036 | GDB_OSABI_UNKNOWN = 0, /* keep this zero */ | |
1037 | ||
1038 | GDB_OSABI_SVR4, | |
1039 | GDB_OSABI_HURD, | |
1040 | GDB_OSABI_SOLARIS, | |
1041 | GDB_OSABI_OSF1, | |
1042 | GDB_OSABI_LINUX, | |
1043 | GDB_OSABI_FREEBSD_AOUT, | |
1044 | GDB_OSABI_FREEBSD_ELF, | |
1045 | GDB_OSABI_NETBSD_AOUT, | |
1046 | GDB_OSABI_NETBSD_ELF, | |
d33b9831 | 1047 | GDB_OSABI_OPENBSD_ELF, |
4be87837 DJ |
1048 | GDB_OSABI_WINCE, |
1049 | GDB_OSABI_GO32, | |
1050 | GDB_OSABI_NETWARE, | |
1051 | GDB_OSABI_IRIX, | |
1052 | GDB_OSABI_LYNXOS, | |
1053 | GDB_OSABI_INTERIX, | |
1054 | GDB_OSABI_HPUX_ELF, | |
1055 | GDB_OSABI_HPUX_SOM, | |
1056 | ||
1057 | GDB_OSABI_ARM_EABI_V1, | |
1058 | GDB_OSABI_ARM_EABI_V2, | |
1059 | GDB_OSABI_ARM_APCS, | |
83461b86 | 1060 | GDB_OSABI_QNXNTO, |
4be87837 | 1061 | |
1762d96d CV |
1062 | GDB_OSABI_CYGWIN, |
1063 | ||
4be87837 DJ |
1064 | GDB_OSABI_INVALID /* keep this last */ |
1065 | }; | |
1066 | ||
c906108c SS |
1067 | /* Global functions from other, non-gdb GNU thingies. |
1068 | Libiberty thingies are no longer declared here. We include libiberty.h | |
1069 | above, instead. */ | |
1070 | ||
1071 | #ifndef GETENV_PROVIDED | |
917317f4 | 1072 | extern char *getenv (const char *); |
c906108c SS |
1073 | #endif |
1074 | ||
1075 | /* From other system libraries */ | |
1076 | ||
1077 | #ifdef HAVE_STDDEF_H | |
1078 | #include <stddef.h> | |
1079 | #endif | |
1080 | ||
1081 | #ifdef HAVE_STDLIB_H | |
c906108c SS |
1082 | #include <stdlib.h> |
1083 | #endif | |
1084 | #ifndef min | |
1085 | #define min(a, b) ((a) < (b) ? (a) : (b)) | |
1086 | #endif | |
1087 | #ifndef max | |
1088 | #define max(a, b) ((a) > (b) ? (a) : (b)) | |
1089 | #endif | |
1090 | ||
1091 | ||
1092 | /* We take the address of fclose later, but some stdio's forget | |
1093 | to declare this. We can't always declare it since there's | |
1094 | no way to declare the parameters without upsetting some compiler | |
1095 | somewhere. */ | |
1096 | ||
1097 | #ifndef FCLOSE_PROVIDED | |
917317f4 | 1098 | extern int fclose (FILE *); |
c906108c SS |
1099 | #endif |
1100 | ||
1101 | #ifndef atof | |
917317f4 | 1102 | extern double atof (const char *); /* X3.159-1989 4.10.1.1 */ |
c906108c SS |
1103 | #endif |
1104 | ||
c906108c SS |
1105 | /* Various possibilities for alloca. */ |
1106 | #ifndef alloca | |
917317f4 JM |
1107 | #ifdef __GNUC__ |
1108 | #define alloca __builtin_alloca | |
1109 | #else /* Not GNU C */ | |
1110 | #ifdef HAVE_ALLOCA_H | |
1111 | #include <alloca.h> | |
1112 | #else | |
1113 | #ifdef _AIX | |
1114 | #pragma alloca | |
1115 | #else | |
c906108c SS |
1116 | |
1117 | /* We need to be careful not to declare this in a way which conflicts with | |
1118 | bison. Bison never declares it as char *, but under various circumstances | |
1119 | (like __hpux) we need to use void *. */ | |
917317f4 | 1120 | extern void *alloca (); |
917317f4 JM |
1121 | #endif /* Not _AIX */ |
1122 | #endif /* Not HAVE_ALLOCA_H */ | |
1123 | #endif /* Not GNU C */ | |
c906108c SS |
1124 | #endif /* alloca not defined */ |
1125 | ||
57b29be7 AC |
1126 | /* Is GDB multi-arch? If there's a "tm.h" file, it is not. */ |
1127 | #ifndef GDB_MULTI_ARCH | |
1128 | #ifdef GDB_TM_FILE | |
1129 | #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PARTIAL | |
1130 | #else | |
1131 | #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PURE | |
1132 | #endif | |
1133 | #endif | |
1134 | ||
c906108c SS |
1135 | /* Dynamic target-system-dependent parameters for GDB. */ |
1136 | #include "gdbarch.h" | |
1137 | ||
0c92afe8 AC |
1138 | /* Maximum size of a register. Something small, but large enough for |
1139 | all known ISAs. If it turns out to be too small, make it bigger. */ | |
1140 | ||
1141 | enum { MAX_REGISTER_SIZE = 16 }; | |
1142 | ||
c906108c SS |
1143 | /* Static target-system-dependent parameters for GDB. */ |
1144 | ||
1145 | /* Number of bits in a char or unsigned char for the target machine. | |
1146 | Just like CHAR_BIT in <limits.h> but describes the target machine. */ | |
1147 | #if !defined (TARGET_CHAR_BIT) | |
1148 | #define TARGET_CHAR_BIT 8 | |
1149 | #endif | |
1150 | ||
c906108c SS |
1151 | /* If we picked up a copy of CHAR_BIT from a configuration file |
1152 | (which may get it by including <limits.h>) then use it to set | |
1153 | the number of bits in a host char. If not, use the same size | |
1154 | as the target. */ | |
1155 | ||
1156 | #if defined (CHAR_BIT) | |
1157 | #define HOST_CHAR_BIT CHAR_BIT | |
1158 | #else | |
1159 | #define HOST_CHAR_BIT TARGET_CHAR_BIT | |
1160 | #endif | |
1161 | ||
1162 | /* The bit byte-order has to do just with numbering of bits in | |
1163 | debugging symbols and such. Conceptually, it's quite separate | |
1164 | from byte/word byte order. */ | |
1165 | ||
1166 | #if !defined (BITS_BIG_ENDIAN) | |
d7449b42 | 1167 | #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG) |
c906108c SS |
1168 | #endif |
1169 | ||
1170 | /* In findvar.c. */ | |
1171 | ||
37611a2b | 1172 | extern LONGEST extract_signed_integer (const void *, int); |
c906108c | 1173 | |
37611a2b | 1174 | extern ULONGEST extract_unsigned_integer (const void *, int); |
c906108c | 1175 | |
66140c26 | 1176 | extern int extract_long_unsigned_integer (const void *, int, LONGEST *); |
c906108c | 1177 | |
66140c26 | 1178 | extern CORE_ADDR extract_typed_address (const void *buf, struct type *type); |
4478b372 | 1179 | |
a9ac8f51 | 1180 | extern void store_signed_integer (void *, int, LONGEST); |
c906108c | 1181 | |
a9ac8f51 | 1182 | extern void store_unsigned_integer (void *, int, ULONGEST); |
c906108c | 1183 | |
4478b372 JB |
1184 | extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr); |
1185 | ||
c906108c | 1186 | \f |
c906108c SS |
1187 | /* From valops.c */ |
1188 | ||
917317f4 | 1189 | extern CORE_ADDR push_bytes (CORE_ADDR, char *, int); |
c906108c | 1190 | |
917317f4 | 1191 | extern CORE_ADDR push_word (CORE_ADDR, ULONGEST); |
c906108c | 1192 | |
c906108c | 1193 | extern int watchdog; |
c906108c SS |
1194 | |
1195 | /* Hooks for alternate command interfaces. */ | |
8b93c638 | 1196 | |
fb40c209 AC |
1197 | /* The name of the interpreter if specified on the command line. */ |
1198 | extern char *interpreter_p; | |
fb40c209 AC |
1199 | |
1200 | /* If a given interpreter matches INTERPRETER_P then it should update | |
1201 | command_loop_hook and init_ui_hook with the per-interpreter | |
1202 | implementation. */ | |
1203 | /* FIXME: command_loop_hook and init_ui_hook should be moved here. */ | |
1204 | ||
c906108c SS |
1205 | struct target_waitstatus; |
1206 | struct cmd_list_element; | |
c906108c | 1207 | |
0f71a2f6 JM |
1208 | /* Should the asynchronous variant of the interpreter (using the |
1209 | event-loop) be enabled? */ | |
6426a772 | 1210 | extern int event_loop_p; |
917317f4 JM |
1211 | |
1212 | extern void (*init_ui_hook) (char *argv0); | |
1213 | extern void (*command_loop_hook) (void); | |
c2d11a7d | 1214 | extern void (*show_load_progress) (const char *section, |
7b83ea04 AC |
1215 | unsigned long section_sent, |
1216 | unsigned long section_size, | |
1217 | unsigned long total_sent, | |
c2d11a7d | 1218 | unsigned long total_size); |
917317f4 JM |
1219 | extern void (*print_frame_info_listing_hook) (struct symtab * s, |
1220 | int line, int stopline, | |
1221 | int noerror); | |
1222 | extern struct frame_info *parse_frame_specification (char *frame_exp); | |
1223 | extern int (*query_hook) (const char *, va_list); | |
1224 | extern void (*warning_hook) (const char *, va_list); | |
d9fcf2fb | 1225 | extern void (*flush_hook) (struct ui_file * stream); |
917317f4 JM |
1226 | extern void (*create_breakpoint_hook) (struct breakpoint * b); |
1227 | extern void (*delete_breakpoint_hook) (struct breakpoint * bpt); | |
1228 | extern void (*modify_breakpoint_hook) (struct breakpoint * bpt); | |
1229 | extern void (*interactive_hook) (void); | |
1230 | extern void (*registers_changed_hook) (void); | |
1231 | extern void (*readline_begin_hook) (char *,...); | |
1232 | extern char *(*readline_hook) (char *); | |
1233 | extern void (*readline_end_hook) (void); | |
1234 | extern void (*register_changed_hook) (int regno); | |
1235 | extern void (*memory_changed_hook) (CORE_ADDR addr, int len); | |
1236 | extern void (*context_hook) (int); | |
39f77062 KB |
1237 | extern ptid_t (*target_wait_hook) (ptid_t ptid, |
1238 | struct target_waitstatus * status); | |
917317f4 JM |
1239 | |
1240 | extern void (*attach_hook) (void); | |
1241 | extern void (*detach_hook) (void); | |
1242 | extern void (*call_command_hook) (struct cmd_list_element * c, | |
1243 | char *cmd, int from_tty); | |
1244 | ||
1245 | extern void (*set_hook) (struct cmd_list_element * c); | |
1246 | ||
1247 | extern NORETURN void (*error_hook) (void) ATTR_NORETURN; | |
1248 | ||
1249 | extern void (*error_begin_hook) (void); | |
1250 | ||
1251 | extern int (*ui_load_progress_hook) (const char *section, unsigned long num); | |
c906108c SS |
1252 | |
1253 | ||
1254 | /* Inhibit window interface if non-zero. */ | |
1255 | ||
1256 | extern int use_windows; | |
1257 | ||
1258 | /* Symbolic definitions of filename-related things. */ | |
1259 | /* FIXME, this doesn't work very well if host and executable | |
1260 | filesystems conventions are different. */ | |
1261 | ||
1262 | #ifndef DIRNAME_SEPARATOR | |
1263 | #define DIRNAME_SEPARATOR ':' | |
1264 | #endif | |
1265 | ||
c906108c | 1266 | #ifndef SLASH_STRING |
c906108c SS |
1267 | #define SLASH_STRING "/" |
1268 | #endif | |
c906108c | 1269 | |
2584159e EZ |
1270 | #ifdef __MSDOS__ |
1271 | # define CANT_FORK | |
1272 | # define GLOBAL_CURDIR | |
1273 | #endif | |
1274 | ||
ca6724c1 KB |
1275 | /* Provide default definitions of PIDGET, TIDGET, and MERGEPID. |
1276 | The name ``TIDGET'' is a historical accident. Many uses of TIDGET | |
1277 | in the code actually refer to a lightweight process id, i.e, | |
1278 | something that can be considered a process id in its own right for | |
1279 | certain purposes. */ | |
c906108c SS |
1280 | |
1281 | #ifndef PIDGET | |
ca6724c1 KB |
1282 | #define PIDGET(PTID) (ptid_get_pid (PTID)) |
1283 | #define TIDGET(PTID) (ptid_get_lwp (PTID)) | |
1284 | #define MERGEPID(PID, TID) ptid_build (PID, TID, 0) | |
c906108c SS |
1285 | #endif |
1286 | ||
96baa820 JM |
1287 | /* Define well known filenos if the system does not define them. */ |
1288 | #ifndef STDIN_FILENO | |
1289 | #define STDIN_FILENO 0 | |
1290 | #endif | |
1291 | #ifndef STDOUT_FILENO | |
1292 | #define STDOUT_FILENO 1 | |
1293 | #endif | |
1294 | #ifndef STDERR_FILENO | |
1295 | #define STDERR_FILENO 2 | |
1296 | #endif | |
1297 | ||
104c1213 JM |
1298 | /* If this definition isn't overridden by the header files, assume |
1299 | that isatty and fileno exist on this system. */ | |
1300 | #ifndef ISATTY | |
1301 | #define ISATTY(FP) (isatty (fileno (FP))) | |
1302 | #endif | |
1303 | ||
5b03f266 AC |
1304 | /* Ensure that V is aligned to an N byte boundary (B's assumed to be a |
1305 | power of 2). Round up/down when necessary. Examples of correct | |
1306 | use include: | |
1307 | ||
1308 | addr = align_up (addr, 8); -- VALUE needs 8 byte alignment | |
1309 | write_memory (addr, value, len); | |
1310 | addr += len; | |
1311 | ||
1312 | and: | |
1313 | ||
1314 | sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned | |
1315 | write_memory (sp, value, len); | |
1316 | ||
1317 | Note that uses such as: | |
1318 | ||
1319 | write_memory (addr, value, len); | |
1320 | addr += align_up (len, 8); | |
1321 | ||
1322 | and: | |
1323 | ||
1324 | sp -= align_up (len, 8); | |
1325 | write_memory (sp, value, len); | |
1326 | ||
1327 | are typically not correct as they don't ensure that the address (SP | |
1328 | or ADDR) is correctly aligned (relying on previous alignment to | |
1329 | keep things right). This is also why the methods are called | |
1330 | "align_..." instead of "round_..." as the latter reads better with | |
1331 | this incorrect coding style. */ | |
1332 | ||
1333 | extern ULONGEST align_up (ULONGEST v, int n); | |
1334 | extern ULONGEST align_down (ULONGEST v, int n); | |
1335 | ||
c906108c | 1336 | #endif /* #ifndef DEFS_H */ |