1 /* *INDENT-OFF* */ /* ATTR_FORMAT confuses indent, avoid running it for now */
2 /* Basic, host-specific, and target-specific definitions for GDB.
3 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1997, 1998, 1999, 2000, 2001
5 Free Software Foundation, Inc.
7 This file is part of GDB.
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.
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.
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. */
27 #include "config.h" /* Generated by configure */
29 #include <errno.h> /* System call error return status */
35 #include <sys/types.h> /* for size_t */
42 /* Just in case they're not defined in stdio.h. */
51 /* First include ansidecl.h so we can use the various macro definitions
52 here and in all subsequent file inclusions. */
56 #include <stdarg.h> /* for va_list */
58 #include "libiberty.h"
62 /* For BFD64 and bfd_vma. */
66 /* The target is partially multi-arched. Both "tm.h" and the
67 multi-arch vector provide definitions. "tm.h" normally overrides
68 the multi-arch vector (but there are a few exceptions). */
70 #define GDB_MULTI_ARCH_PARTIAL 1
72 /* The target is partially multi-arched. Both the multi-arch vector
73 and "tm.h" provide definitions. "tm.h" cannot override a definition
74 provided by the multi-arch vector. It is detected as a compilation
77 This setting is only useful during a multi-arch conversion. */
79 #define GDB_MULTI_ARCH_TM 2
81 /* The target is pure multi-arch. The MULTI-ARCH vector provides all
82 definitions. "tm.h" is linked to an empty file. */
84 #define GDB_MULTI_ARCH_PURE 3
88 /* An address in the program being debugged. Host byte order. Rather
89 than duplicate all the logic in BFD which figures out what type
90 this is (long, long long, etc.) and whether it needs to be 64
91 bits (the host/target interactions are subtle), we just use
94 typedef bfd_vma CORE_ADDR;
96 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
102 #define LONGEST BFD_HOST_64_BIT
103 #define ULONGEST BFD_HOST_U_64_BIT
107 #ifdef CC_HAS_LONG_LONG
108 #define LONGEST long long
109 #define ULONGEST unsigned long long
111 #ifdef BFD_HOST_64_BIT
112 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
113 (e.g. i386-windows) so try it. */
114 #define LONGEST BFD_HOST_64_BIT
115 #define ULONGEST BFD_HOST_U_64_BIT
118 #define ULONGEST unsigned long
122 #endif /* No BFD64 */
124 #endif /* ! LONGEST */
127 #define min(a, b) ((a) < (b) ? (a) : (b))
130 #define max(a, b) ((a) > (b) ? (a) : (b))
133 /* Macros to do string compares.
135 NOTE: cagney/2000-03-14:
137 While old code can continue to refer to these macros, new code is
138 probably better off using strcmp() directly vis: ``strcmp() == 0''
139 and ``strcmp() != 0''.
141 This is because modern compilers can directly inline strcmp()
142 making the original justification for these macros - avoid function
143 call overhead by pre-testing the first characters
144 (``*X==*Y?...:0'') - redundant.
146 ``Even if [...] testing the first character does have a modest
147 performance improvement, I'd rather that whenever a performance
148 issue is found that we spend the effort on algorithmic
149 optimizations than micro-optimizing.'' J.T. */
151 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
152 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
154 /* The character GNU C++ uses to build identifiers that must be unique from
155 the program's identifiers (such as $this and $$vptr). */
156 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
158 /* Check if a character is one of the commonly used C++ marker characters. */
159 extern int is_cplus_marker (int);
161 /* use tui interface if non-zero */
162 extern int tui_version;
164 /* enable xdb commands if set */
165 extern int xdb_commands;
167 /* enable dbx commands if set */
168 extern int dbx_commands;
170 extern int quit_flag;
171 extern int immediate_quit;
172 extern int sevenbit_strings;
174 extern void quit (void);
176 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
177 benefits of having a ``QUIT'' macro rather than a function are
178 marginal. If the overhead of a QUIT function call is proving
179 significant then its calling frequency should probably be reduced
180 [kingdon]. A profile analyzing the current situtation is
184 /* do twice to force compiler warning */
185 #define QUIT_FIXME "FIXME"
186 #define QUIT_FIXME "ignoring redefinition of QUIT"
189 if (quit_flag) quit (); \
190 if (interactive_hook) interactive_hook (); \
195 /* Languages represented in the symbol table and elsewhere.
196 This should probably be in language.h, but since enum's can't
197 be forward declared to satisfy opaque references before their
198 actual definition, needs to be here. */
202 language_unknown, /* Language not known */
203 language_auto, /* Placeholder for automatic setting */
205 language_cplus, /* C++ */
206 language_java, /* Java */
207 language_chill, /* Chill */
208 language_fortran, /* Fortran */
209 language_m2, /* Modula-2 */
210 language_asm, /* Assembly language */
211 language_scm, /* Scheme / Guile */
212 language_pascal /* Pascal */
219 unspecified_precision
222 /* The numbering of these signals is chosen to match traditional unix
223 signals (insofar as various unices use the same numbers, anyway).
224 It is also the numbering of the GDB remote protocol. Other remote
225 protocols, if they use a different numbering, should make sure to
226 translate appropriately.
228 Since these numbers have actually made it out into other software
229 (stubs, etc.), you mustn't disturb the assigned numbering. If you
230 need to add new signals here, add them to the end of the explicitly
233 This is based strongly on Unix/POSIX signals for several reasons:
234 (1) This set of signals represents a widely-accepted attempt to
235 represent events of this sort in a portable fashion, (2) we want a
236 signal to make it from wait to child_wait to the user intact, (3) many
237 remote protocols use a similar encoding. However, it is
238 recognized that this set of signals has limitations (such as not
239 distinguishing between various kinds of SIGSEGV, or not
240 distinguishing hitting a breakpoint from finishing a single step).
241 So in the future we may get around this either by adding additional
242 signals for breakpoint, single-step, etc., or by adding signal
243 codes; the latter seems more in the spirit of what BSD, System V,
244 etc. are doing to address these issues. */
246 /* For an explanation of what each signal means, see
247 target_signal_to_string. */
251 /* Used some places (e.g. stop_signal) to record the concept that
252 there is no signal. */
254 TARGET_SIGNAL_FIRST = 0,
255 TARGET_SIGNAL_HUP = 1,
256 TARGET_SIGNAL_INT = 2,
257 TARGET_SIGNAL_QUIT = 3,
258 TARGET_SIGNAL_ILL = 4,
259 TARGET_SIGNAL_TRAP = 5,
260 TARGET_SIGNAL_ABRT = 6,
261 TARGET_SIGNAL_EMT = 7,
262 TARGET_SIGNAL_FPE = 8,
263 TARGET_SIGNAL_KILL = 9,
264 TARGET_SIGNAL_BUS = 10,
265 TARGET_SIGNAL_SEGV = 11,
266 TARGET_SIGNAL_SYS = 12,
267 TARGET_SIGNAL_PIPE = 13,
268 TARGET_SIGNAL_ALRM = 14,
269 TARGET_SIGNAL_TERM = 15,
270 TARGET_SIGNAL_URG = 16,
271 TARGET_SIGNAL_STOP = 17,
272 TARGET_SIGNAL_TSTP = 18,
273 TARGET_SIGNAL_CONT = 19,
274 TARGET_SIGNAL_CHLD = 20,
275 TARGET_SIGNAL_TTIN = 21,
276 TARGET_SIGNAL_TTOU = 22,
277 TARGET_SIGNAL_IO = 23,
278 TARGET_SIGNAL_XCPU = 24,
279 TARGET_SIGNAL_XFSZ = 25,
280 TARGET_SIGNAL_VTALRM = 26,
281 TARGET_SIGNAL_PROF = 27,
282 TARGET_SIGNAL_WINCH = 28,
283 TARGET_SIGNAL_LOST = 29,
284 TARGET_SIGNAL_USR1 = 30,
285 TARGET_SIGNAL_USR2 = 31,
286 TARGET_SIGNAL_PWR = 32,
287 /* Similar to SIGIO. Perhaps they should have the same number. */
288 TARGET_SIGNAL_POLL = 33,
289 TARGET_SIGNAL_WIND = 34,
290 TARGET_SIGNAL_PHONE = 35,
291 TARGET_SIGNAL_WAITING = 36,
292 TARGET_SIGNAL_LWP = 37,
293 TARGET_SIGNAL_DANGER = 38,
294 TARGET_SIGNAL_GRANT = 39,
295 TARGET_SIGNAL_RETRACT = 40,
296 TARGET_SIGNAL_MSG = 41,
297 TARGET_SIGNAL_SOUND = 42,
298 TARGET_SIGNAL_SAK = 43,
299 TARGET_SIGNAL_PRIO = 44,
300 TARGET_SIGNAL_REALTIME_33 = 45,
301 TARGET_SIGNAL_REALTIME_34 = 46,
302 TARGET_SIGNAL_REALTIME_35 = 47,
303 TARGET_SIGNAL_REALTIME_36 = 48,
304 TARGET_SIGNAL_REALTIME_37 = 49,
305 TARGET_SIGNAL_REALTIME_38 = 50,
306 TARGET_SIGNAL_REALTIME_39 = 51,
307 TARGET_SIGNAL_REALTIME_40 = 52,
308 TARGET_SIGNAL_REALTIME_41 = 53,
309 TARGET_SIGNAL_REALTIME_42 = 54,
310 TARGET_SIGNAL_REALTIME_43 = 55,
311 TARGET_SIGNAL_REALTIME_44 = 56,
312 TARGET_SIGNAL_REALTIME_45 = 57,
313 TARGET_SIGNAL_REALTIME_46 = 58,
314 TARGET_SIGNAL_REALTIME_47 = 59,
315 TARGET_SIGNAL_REALTIME_48 = 60,
316 TARGET_SIGNAL_REALTIME_49 = 61,
317 TARGET_SIGNAL_REALTIME_50 = 62,
318 TARGET_SIGNAL_REALTIME_51 = 63,
319 TARGET_SIGNAL_REALTIME_52 = 64,
320 TARGET_SIGNAL_REALTIME_53 = 65,
321 TARGET_SIGNAL_REALTIME_54 = 66,
322 TARGET_SIGNAL_REALTIME_55 = 67,
323 TARGET_SIGNAL_REALTIME_56 = 68,
324 TARGET_SIGNAL_REALTIME_57 = 69,
325 TARGET_SIGNAL_REALTIME_58 = 70,
326 TARGET_SIGNAL_REALTIME_59 = 71,
327 TARGET_SIGNAL_REALTIME_60 = 72,
328 TARGET_SIGNAL_REALTIME_61 = 73,
329 TARGET_SIGNAL_REALTIME_62 = 74,
330 TARGET_SIGNAL_REALTIME_63 = 75,
332 /* Used internally by Solaris threads. See signal(5) on Solaris. */
333 TARGET_SIGNAL_CANCEL = 76,
335 /* Yes, this pains me, too. But LynxOS didn't have SIG32, and now
336 Linux does, and we can't disturb the numbering, since it's part
337 of the remote protocol. Note that in some GDB's
338 TARGET_SIGNAL_REALTIME_32 is number 76. */
339 TARGET_SIGNAL_REALTIME_32,
340 /* Yet another pain, IRIX 6 has SIG64. */
341 TARGET_SIGNAL_REALTIME_64,
342 /* Yet another pain, Linux/MIPS might go up to 128. */
343 TARGET_SIGNAL_REALTIME_65,
344 TARGET_SIGNAL_REALTIME_66,
345 TARGET_SIGNAL_REALTIME_67,
346 TARGET_SIGNAL_REALTIME_68,
347 TARGET_SIGNAL_REALTIME_69,
348 TARGET_SIGNAL_REALTIME_70,
349 TARGET_SIGNAL_REALTIME_71,
350 TARGET_SIGNAL_REALTIME_72,
351 TARGET_SIGNAL_REALTIME_73,
352 TARGET_SIGNAL_REALTIME_74,
353 TARGET_SIGNAL_REALTIME_75,
354 TARGET_SIGNAL_REALTIME_76,
355 TARGET_SIGNAL_REALTIME_77,
356 TARGET_SIGNAL_REALTIME_78,
357 TARGET_SIGNAL_REALTIME_79,
358 TARGET_SIGNAL_REALTIME_80,
359 TARGET_SIGNAL_REALTIME_81,
360 TARGET_SIGNAL_REALTIME_82,
361 TARGET_SIGNAL_REALTIME_83,
362 TARGET_SIGNAL_REALTIME_84,
363 TARGET_SIGNAL_REALTIME_85,
364 TARGET_SIGNAL_REALTIME_86,
365 TARGET_SIGNAL_REALTIME_87,
366 TARGET_SIGNAL_REALTIME_88,
367 TARGET_SIGNAL_REALTIME_89,
368 TARGET_SIGNAL_REALTIME_90,
369 TARGET_SIGNAL_REALTIME_91,
370 TARGET_SIGNAL_REALTIME_92,
371 TARGET_SIGNAL_REALTIME_93,
372 TARGET_SIGNAL_REALTIME_94,
373 TARGET_SIGNAL_REALTIME_95,
374 TARGET_SIGNAL_REALTIME_96,
375 TARGET_SIGNAL_REALTIME_97,
376 TARGET_SIGNAL_REALTIME_98,
377 TARGET_SIGNAL_REALTIME_99,
378 TARGET_SIGNAL_REALTIME_100,
379 TARGET_SIGNAL_REALTIME_101,
380 TARGET_SIGNAL_REALTIME_102,
381 TARGET_SIGNAL_REALTIME_103,
382 TARGET_SIGNAL_REALTIME_104,
383 TARGET_SIGNAL_REALTIME_105,
384 TARGET_SIGNAL_REALTIME_106,
385 TARGET_SIGNAL_REALTIME_107,
386 TARGET_SIGNAL_REALTIME_108,
387 TARGET_SIGNAL_REALTIME_109,
388 TARGET_SIGNAL_REALTIME_110,
389 TARGET_SIGNAL_REALTIME_111,
390 TARGET_SIGNAL_REALTIME_112,
391 TARGET_SIGNAL_REALTIME_113,
392 TARGET_SIGNAL_REALTIME_114,
393 TARGET_SIGNAL_REALTIME_115,
394 TARGET_SIGNAL_REALTIME_116,
395 TARGET_SIGNAL_REALTIME_117,
396 TARGET_SIGNAL_REALTIME_118,
397 TARGET_SIGNAL_REALTIME_119,
398 TARGET_SIGNAL_REALTIME_120,
399 TARGET_SIGNAL_REALTIME_121,
400 TARGET_SIGNAL_REALTIME_122,
401 TARGET_SIGNAL_REALTIME_123,
402 TARGET_SIGNAL_REALTIME_124,
403 TARGET_SIGNAL_REALTIME_125,
404 TARGET_SIGNAL_REALTIME_126,
405 TARGET_SIGNAL_REALTIME_127,
407 #if defined(MACH) || defined(__MACH__)
408 /* Mach exceptions */
409 TARGET_EXC_BAD_ACCESS,
410 TARGET_EXC_BAD_INSTRUCTION,
411 TARGET_EXC_ARITHMETIC,
412 TARGET_EXC_EMULATION,
414 TARGET_EXC_BREAKPOINT,
418 /* Some signal we don't know about. */
419 TARGET_SIGNAL_UNKNOWN,
421 /* Use whatever signal we use when one is not specifically specified
422 (for passing to proceed and so on). */
423 TARGET_SIGNAL_DEFAULT,
425 /* Last and unused enum value, for sizing arrays, etc. */
429 /* the cleanup list records things that have to be undone
430 if an error happens (descriptors to be closed, memory to be freed, etc.)
431 Each link in the chain records a function to call and an
434 Use make_cleanup to add an element to the cleanup chain.
435 Use do_cleanups to do all cleanup actions back to a given
436 point in the chain. Use discard_cleanups to remove cleanups
437 from the chain back to a given point, not doing them. */
441 struct cleanup *next;
442 void (*function) (PTR);
447 /* The ability to declare that a function never returns is useful, but
448 not really required to compile GDB successfully, so the NORETURN and
449 ATTR_NORETURN macros normally expand into nothing. */
451 /* If compiling with older versions of GCC, a function may be declared
452 "volatile" to indicate that it does not return. */
455 #if defined(__GNUC__) \
456 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
457 #define NORETURN volatile
459 #define NORETURN /* nothing */
463 /* GCC 2.5 and later versions define a function attribute "noreturn",
464 which is the preferred way to declare that a function never returns.
465 However GCC 2.7 appears to be the first version in which this fully
466 works everywhere we use it. */
468 #ifndef ATTR_NORETURN
469 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
470 #define ATTR_NORETURN __attribute__ ((noreturn))
472 #define ATTR_NORETURN /* nothing */
477 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
478 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
480 #define ATTR_FORMAT(type, x, y) /* nothing */
484 /* Needed for various prototypes */
489 /* From blockframe.c */
491 extern int inside_entry_func (CORE_ADDR);
493 extern int inside_entry_file (CORE_ADDR addr);
495 extern int inside_main_func (CORE_ADDR pc);
497 /* From ch-lang.c, for the moment. (FIXME) */
499 extern char *chill_demangle (const char *);
503 extern void initialize_utils (void);
505 extern void notice_quit (void);
507 extern int strcmp_iw (const char *, const char *);
509 extern int subset_compare (char *, char *);
511 extern char *safe_strerror (int);
513 extern void init_malloc (void *);
515 extern void request_quit (int);
517 extern void do_cleanups (struct cleanup *);
518 extern void do_final_cleanups (struct cleanup *);
519 extern void do_my_cleanups (struct cleanup **, struct cleanup *);
520 extern void do_run_cleanups (struct cleanup *);
521 extern void do_exec_cleanups (struct cleanup *);
522 extern void do_exec_error_cleanups (struct cleanup *);
524 extern void discard_cleanups (struct cleanup *);
525 extern void discard_final_cleanups (struct cleanup *);
526 extern void discard_exec_error_cleanups (struct cleanup *);
527 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
529 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
530 make_cleanup function declarations below. Do not use this typedef
531 as a cast when passing functions into the make_cleanup() code.
532 Instead either use a bounce function or add a wrapper function.
533 Calling a f(char*) function with f(void*) is non-portable. */
534 typedef void (make_cleanup_ftype) (void *);
536 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
538 extern struct cleanup *make_cleanup_freeargv (char **);
541 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
543 extern struct cleanup *make_cleanup_close (int fd);
545 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
547 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
549 extern struct cleanup *make_my_cleanup (struct cleanup **,
550 make_cleanup_ftype *, void *);
552 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
554 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
555 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
557 extern struct cleanup *save_cleanups (void);
558 extern struct cleanup *save_final_cleanups (void);
559 extern struct cleanup *save_my_cleanups (struct cleanup **);
561 extern void restore_cleanups (struct cleanup *);
562 extern void restore_final_cleanups (struct cleanup *);
563 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
565 extern void free_current_contents (void *);
567 extern void null_cleanup (void *);
569 extern int myread (int, char *, int);
571 extern int query (char *, ...) ATTR_FORMAT (printf, 1, 2);
573 extern void init_page_info (void);
575 extern CORE_ADDR host_pointer_to_address (void *ptr);
576 extern void *address_to_host_pointer (CORE_ADDR addr);
578 extern char *gdb_realpath (const char *);
580 /* From demangle.c */
582 extern void set_demangling_style (char *);
587 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
588 extern use_struct_convention_fn generic_use_struct_convention;
590 typedef unsigned char *(breakpoint_from_pc_fn) (CORE_ADDR * pcptr, int *lenptr);
592 /* Annotation stuff. */
594 extern int annotation_level; /* in stack.c */
596 extern void begin_line (void);
598 extern void wrap_here (char *);
600 extern void reinitialize_more_filter (void);
603 extern struct ui_file *gdb_stdout;
604 /* Serious error notifications */
605 extern struct ui_file *gdb_stderr;
606 /* Log/debug/trace messages that should bypass normal stdout/stderr
607 filtering. For momement, always call this stream using
608 *_unfiltered. In the very near future that restriction shall be
609 removed - either call shall be unfiltered. (cagney 1999-06-13). */
610 extern struct ui_file *gdb_stdlog;
611 /* Target output that should bypass normal stdout/stderr filtering.
612 For momement, always call this stream using *_unfiltered. In the
613 very near future that restriction shall be removed - either call
614 shall be unfiltered. (cagney 1999-07-02). */
615 extern struct ui_file *gdb_stdtarg;
623 /* More generic printf like operations. Filtered versions may return
624 non-locally on error. */
626 extern void fputs_filtered (const char *, struct ui_file *);
628 extern void fputs_unfiltered (const char *, struct ui_file *);
630 extern int fputc_filtered (int c, struct ui_file *);
632 extern int fputc_unfiltered (int c, struct ui_file *);
634 extern int putchar_filtered (int c);
636 extern int putchar_unfiltered (int c);
638 extern void puts_filtered (const char *);
640 extern void puts_unfiltered (const char *);
642 extern void puts_debug (char *prefix, char *string, char *suffix);
644 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
646 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
648 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
650 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
652 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
654 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
656 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
658 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
660 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
662 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
664 extern void print_spaces (int, struct ui_file *);
666 extern void print_spaces_filtered (int, struct ui_file *);
668 extern char *n_spaces (int);
670 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
672 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
674 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
676 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
677 extern void gdb_print_host_address (void *addr, struct ui_file *stream);
679 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
680 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
682 extern int strlen_paddr (void);
683 extern char *paddr (CORE_ADDR addr);
684 extern char *paddr_nz (CORE_ADDR addr);
685 extern char *paddr_u (CORE_ADDR addr);
686 extern char *paddr_d (LONGEST addr);
688 extern char *phex (ULONGEST l, int sizeof_l);
689 extern char *phex_nz (ULONGEST l, int sizeof_l);
691 /* Like paddr() only print/scan raw CORE_ADDR. The output from
692 core_addr_to_string() can be passed direct to
693 string_to_core_addr(). */
694 extern const char *core_addr_to_string (const CORE_ADDR addr);
695 extern CORE_ADDR string_to_core_addr (const char *my_string);
697 extern void fprintf_symbol_filtered (struct ui_file *, char *,
700 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
702 extern void print_sys_errmsg (char *, int);
704 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
705 "const char *" in unistd.h, so we can't declare the argument
708 extern char *re_comp (const char *);
712 extern void symbol_file_command (char *, int);
714 /* Remote targets may wish to use this as their load function. */
715 extern void generic_load (char *name, int from_tty);
717 /* Summarise a download */
718 extern void print_transfer_performance (struct ui_file *stream,
719 unsigned long data_count,
720 unsigned long write_count,
721 unsigned long time_count);
725 typedef void initialize_file_ftype (void);
727 extern char *skip_quoted (char *);
729 extern char *gdb_readline (char *);
731 extern char *command_line_input (char *, int, char *);
733 extern void print_prompt (void);
735 extern int input_from_terminal_p (void);
737 extern int info_verbose;
739 /* From printcmd.c */
741 extern void set_next_address (CORE_ADDR);
743 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
746 extern int build_address_symbolic (CORE_ADDR addr,
754 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
756 extern void print_address (CORE_ADDR, struct ui_file *);
760 extern int openp (const char *, int, const char *, int, int, char **);
762 extern int source_full_path_of (char *, char **);
764 extern void mod_path (char *, char **);
766 extern void directory_command (char *, int);
768 extern void init_source_path (void);
770 extern char *symtab_to_filename (struct symtab *);
774 extern void exec_set_section_offsets (bfd_signed_vma text_off,
775 bfd_signed_vma data_off,
776 bfd_signed_vma bss_off);
780 extern int read_relative_register_raw_bytes (int, char *);
782 /* Possible lvalue types. Like enum language, this should be in
783 value.h, but needs to be here for the same reason. */
789 /* In memory. Could be a saved register. */
793 /* In a gdb internal variable. */
795 /* Part of a gdb internal variable (structure field). */
796 lval_internalvar_component,
797 /* In a register series in a frame not the current one, which may have been
798 partially saved or saved in different places (otherwise would be
799 lval_register or lval_memory). */
800 lval_reg_frame_relative
805 /* From readline (but not in any readline .h files). */
807 extern char *tilde_expand (char *);
809 /* Control types for commands */
811 enum misc_command_type
819 enum command_control_type
829 /* Structure for saved commands lines
830 (for breakpoints, defined commands, etc). */
834 struct command_line *next;
836 enum command_control_type control_type;
838 struct command_line **body_list;
841 extern struct command_line *read_command_lines (char *, int);
843 extern void free_command_lines (struct command_line **);
845 /* To continue the execution commands when running gdb asynchronously.
846 A continuation structure contains a pointer to a function to be called
847 to finish the command, once the target has stopped. Such mechanism is
848 used bt the finish and until commands, and in the remote protocol
849 when opening an extended-remote connection. */
851 struct continuation_arg
853 struct continuation_arg *next;
854 union continuation_data {
863 void (*continuation_hook) (struct continuation_arg *);
864 struct continuation_arg *arg_list;
865 struct continuation *next;
869 extern struct continuation *cmd_continuation;
870 /* Used only by the step_1 function. */
871 extern struct continuation *intermediate_continuation;
874 extern void add_continuation (void (*)(struct continuation_arg *),
875 struct continuation_arg *);
876 extern void do_all_continuations (void);
877 extern void discard_all_continuations (void);
879 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
880 struct continuation_arg *);
881 extern void do_all_intermediate_continuations (void);
882 extern void discard_all_intermediate_continuations (void);
884 /* String containing the current directory (what getwd would return). */
886 extern char *current_directory;
888 /* Default radixes for input and output. Only some values supported. */
889 extern unsigned input_radix;
890 extern unsigned output_radix;
892 /* Possibilities for prettyprint parameters to routines which print
893 things. Like enum language, this should be in value.h, but needs
894 to be here for the same reason. FIXME: If we can eliminate this
895 as an arg to LA_VAL_PRINT, then we can probably move it back to
900 Val_no_prettyprint = 0,
902 /* Use the default setting which the user has specified. */
906 /* The ptid struct is a collection of the various "ids" necessary
907 for identifying the inferior. This consists of the process id
908 (pid), thread id (tid), and other fields necessary for uniquely
909 identifying the inferior process/thread being debugged. When
910 manipulating ptids, the constructors, accessors, and predicate
911 declared in inferior.h should be used. These are as follows:
913 ptid_build - Make a new ptid from a pid, lwp, and tid.
914 pid_to_ptid - Make a new ptid from just a pid.
915 ptid_get_pid - Fetch the pid component of a ptid.
916 ptid_get_lwp - Fetch the lwp component of a ptid.
917 ptid_get_tid - Fetch the tid component of a ptid.
918 ptid_equal - Test to see if two ptids are equal.
920 Please do NOT access the struct ptid members directly (except, of
921 course, in the implementation of the above ptid manipulation
929 /* Lightweight process id */
936 typedef struct ptid ptid_t;
940 /* Optional host machine definition. Pure autoconf targets will not
941 need a "xm.h" file. This will be a symlink to one of the xm-*.h
942 files, built by the `configure' script. */
948 /* Optional native machine support. Non-native (and possibly pure
949 multi-arch) targets do not need a "nm.h" file. This will be a
950 symlink to one of the nm-*.h files, built by the `configure'
957 /* Optional target machine definition. Pure multi-arch configurations
958 do not need a "tm.h" file. This will be a symlink to one of the
959 tm-*.h files, built by the `configure' script. */
965 /* GDB_MULTI_ARCH is normally set by configure.in using information
966 from configure.tgt or the config/%/%.mt Makefile fragment. Since
967 some targets have defined it in their "tm.h" file, delay providing
968 a default definition until after "tm.h" has been included.. */
970 #ifndef GDB_MULTI_ARCH
971 #define GDB_MULTI_ARCH 0
975 /* If the xm.h file did not define the mode string used to open the
976 files, assume that binary files are opened the same way as text
979 #include "fopen-same.h"
982 #define CONST_PTR const
984 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
985 FIXME: Assumes 2's complement arithmetic */
987 #if !defined (UINT_MAX)
988 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
991 #if !defined (INT_MAX)
992 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
995 #if !defined (INT_MIN)
996 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
999 #if !defined (ULONG_MAX)
1000 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
1003 #if !defined (LONG_MAX)
1004 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
1007 #if !defined (ULONGEST_MAX)
1008 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
1011 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
1012 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
1015 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
1016 arguments to a function, number in a value history, register number, etc.)
1017 where the value must not be larger than can fit in an int. */
1019 extern int longest_to_int (LONGEST);
1021 /* Assorted functions we can declare, now that const and volatile are
1024 extern char *savestring (const char *, size_t);
1026 extern char *msavestring (void *, const char *, size_t);
1028 extern char *mstrsave (void *, const char *);
1030 /* Robust versions of same. Throw an internal error when no memory,
1031 guard against stray NULL arguments. */
1032 extern void *xmmalloc (void *md, size_t size);
1033 extern void *xmrealloc (void *md, void *ptr, size_t size);
1034 extern void *xmcalloc (void *md, size_t number, size_t size);
1035 extern void xmfree (void *md, void *ptr);
1037 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
1039 extern void xfree (void *);
1041 /* Like asprintf/vasprintf but get an internal_error if the call
1043 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
1044 extern void xvasprintf (char **ret, const char *format, va_list ap);
1046 extern int parse_escape (char **);
1048 /* Message to be printed before the error message, when an error occurs. */
1050 extern char *error_pre_print;
1052 /* Message to be printed before the error message, when an error occurs. */
1054 extern char *quit_pre_print;
1056 /* Message to be printed before the warning message, when a warning occurs. */
1058 extern char *warning_pre_print;
1060 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
1062 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN;
1064 /* DEPRECATED: Use error(), verror() or error_stream(). */
1065 extern NORETURN void error_begin (void);
1067 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
1069 /* Returns a freshly allocate buffer containing the last error
1071 extern char *error_last_message (void);
1073 extern NORETURN void internal_verror (const char *file, int line,
1074 const char *, va_list ap) ATTR_NORETURN;
1076 extern NORETURN void internal_error (const char *file, int line,
1077 const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
1079 extern NORETURN void nomem (long) ATTR_NORETURN;
1081 /* Reasons for calling return_to_top_level. NOTE: all reason values
1082 must be less than zero. enum value 0 is reserved for internal use
1083 as the return value from an initial setjmp(). The function
1084 catch_exceptions() reserves values >= 0 as legal results from its
1085 wrapped function. */
1089 /* User interrupt. */
1091 /* Any other error. */
1095 #define ALL_CLEANUPS ((struct cleanup *)0)
1097 #define RETURN_MASK(reason) (1 << (int)(-reason))
1098 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
1099 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
1100 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
1101 typedef int return_mask;
1103 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
1104 to the inner most containing exception handler (established using
1105 catch_exceptions() or the legacy catch_errors()).
1107 Useful when a section of code that caught an exception finds it
1108 needs to repropagate that exception up the call chain.
1110 The name return_to_top_level() dates back to a time when GDB had
1111 only one exception handler installed at the top level. This really
1112 did return to the top level. The name should probably be changed.
1114 NOTE: Some sections of code are using error_begin() in conjunction
1115 with return_to_top_level() to throw the initial exception. That
1116 code should, instead, use either error() or error_string(). */
1118 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
1120 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
1121 handler. If an exception (enum return_reason) is thrown using
1122 return_to_top_level() than all cleanups installed since
1123 catch_exceptions() was entered are invoked, the (-ve) exception
1124 value is then returned by catch_exceptions. If FUNC() returns
1125 normally (with a postive or zero return value) then that value is
1126 returned by catch_exceptions(). It is an internal_error() for
1127 FUNC() to return a negative value.
1129 For the period of the FUNC() call: UIOUT is installed as the output
1130 builder; ERRSTRING is installed as the error/quit message; and a
1131 new cleanup_chain is established. The old values are restored
1132 before catch_exceptions() returns.
1134 FIXME; cagney/2001-08-13: The need to override the global UIOUT
1135 builder variable should just go away.
1137 This function superseeds catch_errors().
1139 This function uses SETJMP() and LONGJUMP(). */
1142 typedef int (catch_exceptions_ftype) (struct ui_out *ui_out, void *args);
1143 extern int catch_exceptions (struct ui_out *uiout,
1144 catch_exceptions_ftype *func, void *func_args,
1145 char *errstring, return_mask mask);
1147 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
1148 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
1149 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
1150 value. It's unfortunate that, catch_errors() does not return an
1151 indication of the exact exception that it caught - quit_flag might
1154 This function is superseeded by catch_exceptions(). */
1156 typedef int (catch_errors_ftype) (PTR);
1157 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
1159 /* Template to catch_errors() that wraps calls to command
1162 typedef void (catch_command_errors_ftype) (char *, int);
1163 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
1165 extern void warning_begin (void);
1167 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
1169 /* Global functions from other, non-gdb GNU thingies.
1170 Libiberty thingies are no longer declared here. We include libiberty.h
1173 #ifndef GETENV_PROVIDED
1174 extern char *getenv (const char *);
1177 /* From other system libraries */
1179 #ifdef HAVE_STDDEF_H
1183 #ifdef HAVE_STDLIB_H
1187 #define min(a, b) ((a) < (b) ? (a) : (b))
1190 #define max(a, b) ((a) > (b) ? (a) : (b))
1194 /* We take the address of fclose later, but some stdio's forget
1195 to declare this. We can't always declare it since there's
1196 no way to declare the parameters without upsetting some compiler
1199 #ifndef FCLOSE_PROVIDED
1200 extern int fclose (FILE *);
1204 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1207 /* Various possibilities for alloca. */
1210 #define alloca __builtin_alloca
1211 #else /* Not GNU C */
1212 #ifdef HAVE_ALLOCA_H
1219 /* We need to be careful not to declare this in a way which conflicts with
1220 bison. Bison never declares it as char *, but under various circumstances
1221 (like __hpux) we need to use void *. */
1222 extern void *alloca ();
1223 #endif /* Not _AIX */
1224 #endif /* Not HAVE_ALLOCA_H */
1225 #endif /* Not GNU C */
1226 #endif /* alloca not defined */
1228 /* Get a definition of BIG_ENDIAN and BFD_ENDIAN_LITTLE. */
1229 /* FIXME: cagney/2001-10-31: GDB should just use BFD's definitions. */
1231 #ifdef HAVE_ENDIAN_H
1235 #if !defined (BIG_ENDIAN)
1236 #define BIG_ENDIAN 4321
1239 /* Dynamic target-system-dependent parameters for GDB. */
1240 #include "gdbarch.h"
1241 #if (GDB_MULTI_ARCH == 0)
1242 /* Multi-arch targets _should_ be including "arch-utils.h" directly
1243 into their *-tdep.c file. This is a prop to help old non-
1244 multi-arch targets to continue to compile. */
1245 #include "arch-utils.h"
1248 /* Static target-system-dependent parameters for GDB. */
1250 /* Number of bits in a char or unsigned char for the target machine.
1251 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1252 #if !defined (TARGET_CHAR_BIT)
1253 #define TARGET_CHAR_BIT 8
1256 /* If we picked up a copy of CHAR_BIT from a configuration file
1257 (which may get it by including <limits.h>) then use it to set
1258 the number of bits in a host char. If not, use the same size
1261 #if defined (CHAR_BIT)
1262 #define HOST_CHAR_BIT CHAR_BIT
1264 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1267 /* The bit byte-order has to do just with numbering of bits in
1268 debugging symbols and such. Conceptually, it's quite separate
1269 from byte/word byte order. */
1271 #if !defined (BITS_BIG_ENDIAN)
1272 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1277 extern LONGEST extract_signed_integer (void *, int);
1279 extern ULONGEST extract_unsigned_integer (void *, int);
1281 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1283 extern CORE_ADDR extract_address (void *, int);
1285 extern CORE_ADDR extract_typed_address (void *buf, struct type *type);
1287 extern void store_signed_integer (void *, int, LONGEST);
1289 extern void store_unsigned_integer (void *, int, ULONGEST);
1291 extern void store_address (void *, int, LONGEST);
1293 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1298 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1300 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1302 extern int watchdog;
1304 /* Hooks for alternate command interfaces. */
1307 /* The name of the interpreter if specified on the command line. */
1308 extern char *interpreter_p;
1311 /* If a given interpreter matches INTERPRETER_P then it should update
1312 command_loop_hook and init_ui_hook with the per-interpreter
1314 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1316 struct target_waitstatus;
1317 struct cmd_list_element;
1319 /* Should the asynchronous variant of the interpreter (using the
1320 event-loop) be enabled? */
1321 extern int event_loop_p;
1323 extern void (*init_ui_hook) (char *argv0);
1324 extern void (*command_loop_hook) (void);
1325 extern void (*show_load_progress) (const char *section,
1326 unsigned long section_sent,
1327 unsigned long section_size,
1328 unsigned long total_sent,
1329 unsigned long total_size);
1330 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1331 int line, int stopline,
1333 extern struct frame_info *parse_frame_specification (char *frame_exp);
1334 extern int (*query_hook) (const char *, va_list);
1335 extern void (*warning_hook) (const char *, va_list);
1336 extern void (*flush_hook) (struct ui_file * stream);
1337 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1338 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1339 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1340 extern void (*interactive_hook) (void);
1341 extern void (*registers_changed_hook) (void);
1342 extern void (*readline_begin_hook) (char *,...);
1343 extern char *(*readline_hook) (char *);
1344 extern void (*readline_end_hook) (void);
1345 extern void (*register_changed_hook) (int regno);
1346 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1347 extern void (*context_hook) (int);
1348 extern ptid_t (*target_wait_hook) (ptid_t ptid,
1349 struct target_waitstatus * status);
1351 extern void (*attach_hook) (void);
1352 extern void (*detach_hook) (void);
1353 extern void (*call_command_hook) (struct cmd_list_element * c,
1354 char *cmd, int from_tty);
1356 extern void (*set_hook) (struct cmd_list_element * c);
1358 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1360 extern void (*error_begin_hook) (void);
1362 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1365 /* Inhibit window interface if non-zero. */
1367 extern int use_windows;
1369 /* Symbolic definitions of filename-related things. */
1370 /* FIXME, this doesn't work very well if host and executable
1371 filesystems conventions are different. */
1373 #ifndef DIRNAME_SEPARATOR
1374 #define DIRNAME_SEPARATOR ':'
1377 #ifndef SLASH_STRING
1378 #define SLASH_STRING "/"
1383 # define GLOBAL_CURDIR
1386 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1387 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1388 in the code actually refer to a lightweight process id, i.e,
1389 something that can be considered a process id in its own right for
1390 certain purposes. */
1393 #define PIDGET(PTID) (ptid_get_pid (PTID))
1394 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1395 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1398 /* Define well known filenos if the system does not define them. */
1399 #ifndef STDIN_FILENO
1400 #define STDIN_FILENO 0
1402 #ifndef STDOUT_FILENO
1403 #define STDOUT_FILENO 1
1405 #ifndef STDERR_FILENO
1406 #define STDERR_FILENO 2
1409 /* If this definition isn't overridden by the header files, assume
1410 that isatty and fileno exist on this system. */
1412 #define ISATTY(FP) (isatty (fileno (FP)))
1415 #endif /* #ifndef DEFS_H */