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, 2002
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 /* For ``enum target_signal''. */
43 #include "gdb/signals.h"
45 /* Just in case they're not defined in stdio.h. */
54 /* First include ansidecl.h so we can use the various macro definitions
55 here and in all subsequent file inclusions. */
59 #include <stdarg.h> /* for va_list */
61 #include "libiberty.h"
65 /* For BFD64 and bfd_vma. */
69 /* The target is partially multi-arched. Both "tm.h" and the
70 multi-arch vector provide definitions. "tm.h" normally overrides
71 the multi-arch vector (but there are a few exceptions). */
73 #define GDB_MULTI_ARCH_PARTIAL 1
75 /* The target is partially multi-arched. Both the multi-arch vector
76 and "tm.h" provide definitions. "tm.h" cannot override a definition
77 provided by the multi-arch vector. It is detected as a compilation
80 This setting is only useful during a multi-arch conversion. */
82 #define GDB_MULTI_ARCH_TM 2
84 /* The target is pure multi-arch. The MULTI-ARCH vector provides all
85 definitions. "tm.h" is linked to an empty file. */
87 #define GDB_MULTI_ARCH_PURE 3
91 /* An address in the program being debugged. Host byte order. Rather
92 than duplicate all the logic in BFD which figures out what type
93 this is (long, long long, etc.) and whether it needs to be 64
94 bits (the host/target interactions are subtle), we just use
97 typedef bfd_vma CORE_ADDR
;
99 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
105 #define LONGEST BFD_HOST_64_BIT
106 #define ULONGEST BFD_HOST_U_64_BIT
110 #ifdef CC_HAS_LONG_LONG
111 #define LONGEST long long
112 #define ULONGEST unsigned long long
114 #ifdef BFD_HOST_64_BIT
115 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
116 (e.g. i386-windows) so try it. */
117 #define LONGEST BFD_HOST_64_BIT
118 #define ULONGEST BFD_HOST_U_64_BIT
121 #define ULONGEST unsigned long
125 #endif /* No BFD64 */
127 #endif /* ! LONGEST */
130 #define min(a, b) ((a) < (b) ? (a) : (b))
133 #define max(a, b) ((a) > (b) ? (a) : (b))
136 /* Macros to do string compares.
138 NOTE: cagney/2000-03-14:
140 While old code can continue to refer to these macros, new code is
141 probably better off using strcmp() directly vis: ``strcmp() == 0''
142 and ``strcmp() != 0''.
144 This is because modern compilers can directly inline strcmp()
145 making the original justification for these macros - avoid function
146 call overhead by pre-testing the first characters
147 (``*X==*Y?...:0'') - redundant.
149 ``Even if [...] testing the first character does have a modest
150 performance improvement, I'd rather that whenever a performance
151 issue is found that we spend the effort on algorithmic
152 optimizations than micro-optimizing.'' J.T. */
154 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
155 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
157 /* The character GNU C++ uses to build identifiers that must be unique from
158 the program's identifiers (such as $this and $$vptr). */
159 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
161 /* Check if a character is one of the commonly used C++ marker characters. */
162 extern int is_cplus_marker (int);
164 /* use tui interface if non-zero */
165 extern int tui_version
;
167 /* enable xdb commands if set */
168 extern int xdb_commands
;
170 /* enable dbx commands if set */
171 extern int dbx_commands
;
173 extern int quit_flag
;
174 extern int immediate_quit
;
175 extern int sevenbit_strings
;
177 extern void quit (void);
179 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
180 benefits of having a ``QUIT'' macro rather than a function are
181 marginal. If the overhead of a QUIT function call is proving
182 significant then its calling frequency should probably be reduced
183 [kingdon]. A profile analyzing the current situtation is
187 /* do twice to force compiler warning */
188 #define QUIT_FIXME "FIXME"
189 #define QUIT_FIXME "ignoring redefinition of QUIT"
192 if (quit_flag) quit (); \
193 if (interactive_hook) interactive_hook (); \
198 /* Languages represented in the symbol table and elsewhere.
199 This should probably be in language.h, but since enum's can't
200 be forward declared to satisfy opaque references before their
201 actual definition, needs to be here. */
205 language_unknown
, /* Language not known */
206 language_auto
, /* Placeholder for automatic setting */
208 language_cplus
, /* C++ */
209 language_java
, /* Java */
210 language_chill
, /* Chill */
211 language_fortran
, /* Fortran */
212 language_m2
, /* Modula-2 */
213 language_asm
, /* Assembly language */
214 language_scm
, /* Scheme / Guile */
215 language_pascal
/* Pascal */
222 unspecified_precision
225 /* the cleanup list records things that have to be undone
226 if an error happens (descriptors to be closed, memory to be freed, etc.)
227 Each link in the chain records a function to call and an
230 Use make_cleanup to add an element to the cleanup chain.
231 Use do_cleanups to do all cleanup actions back to a given
232 point in the chain. Use discard_cleanups to remove cleanups
233 from the chain back to a given point, not doing them. */
237 struct cleanup
*next
;
238 void (*function
) (PTR
);
243 /* The ability to declare that a function never returns is useful, but
244 not really required to compile GDB successfully, so the NORETURN and
245 ATTR_NORETURN macros normally expand into nothing. */
247 /* If compiling with older versions of GCC, a function may be declared
248 "volatile" to indicate that it does not return. */
251 #if defined(__GNUC__) \
252 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
253 #define NORETURN volatile
255 #define NORETURN /* nothing */
259 /* GCC 2.5 and later versions define a function attribute "noreturn",
260 which is the preferred way to declare that a function never returns.
261 However GCC 2.7 appears to be the first version in which this fully
262 works everywhere we use it. */
264 #ifndef ATTR_NORETURN
265 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
266 #define ATTR_NORETURN __attribute__ ((noreturn))
268 #define ATTR_NORETURN /* nothing */
273 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
274 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
276 #define ATTR_FORMAT(type, x, y) /* nothing */
280 /* Needed for various prototypes */
285 /* From blockframe.c */
287 extern int inside_entry_func (CORE_ADDR
);
289 extern int inside_entry_file (CORE_ADDR addr
);
291 extern int inside_main_func (CORE_ADDR pc
);
293 /* From ch-lang.c, for the moment. (FIXME) */
295 extern char *chill_demangle (const char *);
299 extern void initialize_utils (void);
301 extern void notice_quit (void);
303 extern int strcmp_iw (const char *, const char *);
305 extern int subset_compare (char *, char *);
307 extern char *safe_strerror (int);
309 extern void init_malloc (void *);
311 extern void request_quit (int);
313 extern void do_cleanups (struct cleanup
*);
314 extern void do_final_cleanups (struct cleanup
*);
315 extern void do_my_cleanups (struct cleanup
**, struct cleanup
*);
316 extern void do_run_cleanups (struct cleanup
*);
317 extern void do_exec_cleanups (struct cleanup
*);
318 extern void do_exec_error_cleanups (struct cleanup
*);
320 extern void discard_cleanups (struct cleanup
*);
321 extern void discard_final_cleanups (struct cleanup
*);
322 extern void discard_exec_error_cleanups (struct cleanup
*);
323 extern void discard_my_cleanups (struct cleanup
**, struct cleanup
*);
325 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
326 make_cleanup function declarations below. Do not use this typedef
327 as a cast when passing functions into the make_cleanup() code.
328 Instead either use a bounce function or add a wrapper function.
329 Calling a f(char*) function with f(void*) is non-portable. */
330 typedef void (make_cleanup_ftype
) (void *);
332 extern struct cleanup
*make_cleanup (make_cleanup_ftype
*, void *);
334 extern struct cleanup
*make_cleanup_freeargv (char **);
337 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
339 extern struct cleanup
*make_cleanup_close (int fd
);
341 extern struct cleanup
*make_cleanup_bfd_close (bfd
*abfd
);
343 extern struct cleanup
*make_final_cleanup (make_cleanup_ftype
*, void *);
345 extern struct cleanup
*make_my_cleanup (struct cleanup
**,
346 make_cleanup_ftype
*, void *);
348 extern struct cleanup
*make_run_cleanup (make_cleanup_ftype
*, void *);
350 extern struct cleanup
*make_exec_cleanup (make_cleanup_ftype
*, void *);
351 extern struct cleanup
*make_exec_error_cleanup (make_cleanup_ftype
*, void *);
353 extern struct cleanup
*save_cleanups (void);
354 extern struct cleanup
*save_final_cleanups (void);
355 extern struct cleanup
*save_my_cleanups (struct cleanup
**);
357 extern void restore_cleanups (struct cleanup
*);
358 extern void restore_final_cleanups (struct cleanup
*);
359 extern void restore_my_cleanups (struct cleanup
**, struct cleanup
*);
361 extern void free_current_contents (void *);
363 extern void null_cleanup (void *);
365 extern int myread (int, char *, int);
367 extern int query (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
369 extern void init_page_info (void);
371 extern CORE_ADDR
host_pointer_to_address (void *ptr
);
372 extern void *address_to_host_pointer (CORE_ADDR addr
);
374 extern char *gdb_realpath (const char *);
375 extern char *xfullpath (const char *);
377 /* From demangle.c */
379 extern void set_demangling_style (char *);
384 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
385 extern use_struct_convention_fn generic_use_struct_convention
;
388 /* Annotation stuff. */
390 extern int annotation_level
; /* in stack.c */
392 extern void begin_line (void);
394 extern void wrap_here (char *);
396 extern void reinitialize_more_filter (void);
399 extern struct ui_file
*gdb_stdout
;
400 /* Serious error notifications */
401 extern struct ui_file
*gdb_stderr
;
402 /* Log/debug/trace messages that should bypass normal stdout/stderr
403 filtering. For momement, always call this stream using
404 *_unfiltered. In the very near future that restriction shall be
405 removed - either call shall be unfiltered. (cagney 1999-06-13). */
406 extern struct ui_file
*gdb_stdlog
;
407 /* Target output that should bypass normal stdout/stderr filtering.
408 For momement, always call this stream using *_unfiltered. In the
409 very near future that restriction shall be removed - either call
410 shall be unfiltered. (cagney 1999-07-02). */
411 extern struct ui_file
*gdb_stdtarg
;
419 /* More generic printf like operations. Filtered versions may return
420 non-locally on error. */
422 extern void fputs_filtered (const char *, struct ui_file
*);
424 extern void fputs_unfiltered (const char *, struct ui_file
*);
426 extern int fputc_filtered (int c
, struct ui_file
*);
428 extern int fputc_unfiltered (int c
, struct ui_file
*);
430 extern int putchar_filtered (int c
);
432 extern int putchar_unfiltered (int c
);
434 extern void puts_filtered (const char *);
436 extern void puts_unfiltered (const char *);
438 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
440 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
442 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
444 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
446 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
448 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
450 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
452 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
454 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
456 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
458 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
460 extern void print_spaces (int, struct ui_file
*);
462 extern void print_spaces_filtered (int, struct ui_file
*);
464 extern char *n_spaces (int);
466 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
468 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
470 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
472 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
473 extern void gdb_print_host_address (void *addr
, struct ui_file
*stream
);
475 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
476 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
478 extern int strlen_paddr (void);
479 extern char *paddr (CORE_ADDR addr
);
480 extern char *paddr_nz (CORE_ADDR addr
);
481 extern char *paddr_u (CORE_ADDR addr
);
482 extern char *paddr_d (LONGEST addr
);
484 extern char *phex (ULONGEST l
, int sizeof_l
);
485 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
487 /* Like paddr() only print/scan raw CORE_ADDR. The output from
488 core_addr_to_string() can be passed direct to
489 string_to_core_addr(). */
490 extern const char *core_addr_to_string (const CORE_ADDR addr
);
491 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
492 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
494 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
497 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
499 extern void print_sys_errmsg (const char *, int);
501 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
502 "const char *" in unistd.h, so we can't declare the argument
505 extern char *re_comp (const char *);
509 extern void symbol_file_command (char *, int);
511 /* Remote targets may wish to use this as their load function. */
512 extern void generic_load (char *name
, int from_tty
);
514 /* Summarise a download */
515 extern void print_transfer_performance (struct ui_file
*stream
,
516 unsigned long data_count
,
517 unsigned long write_count
,
518 unsigned long time_count
);
522 typedef void initialize_file_ftype (void);
524 extern char *skip_quoted (char *);
526 extern char *gdb_readline (char *);
528 extern char *command_line_input (char *, int, char *);
530 extern void print_prompt (void);
532 extern int input_from_terminal_p (void);
534 extern int info_verbose
;
536 /* From printcmd.c */
538 extern void set_next_address (CORE_ADDR
);
540 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
543 extern int build_address_symbolic (CORE_ADDR addr
,
551 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
553 extern void print_address (CORE_ADDR
, struct ui_file
*);
557 extern int openp (const char *, int, const char *, int, int, char **);
559 extern int source_full_path_of (char *, char **);
561 extern void mod_path (char *, char **);
563 extern void directory_command (char *, int);
565 extern void init_source_path (void);
567 extern char *symtab_to_filename (struct symtab
*);
571 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
572 bfd_signed_vma data_off
,
573 bfd_signed_vma bss_off
);
575 /* Take over the 'find_mapped_memory' vector from exec.c. */
576 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
582 /* Possible lvalue types. Like enum language, this should be in
583 value.h, but needs to be here for the same reason. */
589 /* In memory. Could be a saved register. */
593 /* In a gdb internal variable. */
595 /* Part of a gdb internal variable (structure field). */
596 lval_internalvar_component
,
597 /* In a register series in a frame not the current one, which may have been
598 partially saved or saved in different places (otherwise would be
599 lval_register or lval_memory). */
600 lval_reg_frame_relative
605 /* From readline (but not in any readline .h files). */
607 extern char *tilde_expand (char *);
609 /* Control types for commands */
611 enum misc_command_type
619 enum command_control_type
629 /* Structure for saved commands lines
630 (for breakpoints, defined commands, etc). */
634 struct command_line
*next
;
636 enum command_control_type control_type
;
638 struct command_line
**body_list
;
641 extern struct command_line
*read_command_lines (char *, int);
643 extern void free_command_lines (struct command_line
**);
645 /* To continue the execution commands when running gdb asynchronously.
646 A continuation structure contains a pointer to a function to be called
647 to finish the command, once the target has stopped. Such mechanism is
648 used bt the finish and until commands, and in the remote protocol
649 when opening an extended-remote connection. */
651 struct continuation_arg
653 struct continuation_arg
*next
;
654 union continuation_data
{
663 void (*continuation_hook
) (struct continuation_arg
*);
664 struct continuation_arg
*arg_list
;
665 struct continuation
*next
;
669 extern struct continuation
*cmd_continuation
;
670 /* Used only by the step_1 function. */
671 extern struct continuation
*intermediate_continuation
;
674 extern void add_continuation (void (*)(struct continuation_arg
*),
675 struct continuation_arg
*);
676 extern void do_all_continuations (void);
677 extern void discard_all_continuations (void);
679 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
680 struct continuation_arg
*);
681 extern void do_all_intermediate_continuations (void);
682 extern void discard_all_intermediate_continuations (void);
684 /* String containing the current directory (what getwd would return). */
686 extern char *current_directory
;
688 /* Default radixes for input and output. Only some values supported. */
689 extern unsigned input_radix
;
690 extern unsigned output_radix
;
692 /* Possibilities for prettyprint parameters to routines which print
693 things. Like enum language, this should be in value.h, but needs
694 to be here for the same reason. FIXME: If we can eliminate this
695 as an arg to LA_VAL_PRINT, then we can probably move it back to
700 Val_no_prettyprint
= 0,
702 /* Use the default setting which the user has specified. */
706 /* The ptid struct is a collection of the various "ids" necessary
707 for identifying the inferior. This consists of the process id
708 (pid), thread id (tid), and other fields necessary for uniquely
709 identifying the inferior process/thread being debugged. When
710 manipulating ptids, the constructors, accessors, and predicate
711 declared in inferior.h should be used. These are as follows:
713 ptid_build - Make a new ptid from a pid, lwp, and tid.
714 pid_to_ptid - Make a new ptid from just a pid.
715 ptid_get_pid - Fetch the pid component of a ptid.
716 ptid_get_lwp - Fetch the lwp component of a ptid.
717 ptid_get_tid - Fetch the tid component of a ptid.
718 ptid_equal - Test to see if two ptids are equal.
720 Please do NOT access the struct ptid members directly (except, of
721 course, in the implementation of the above ptid manipulation
729 /* Lightweight process id */
736 typedef struct ptid ptid_t
;
740 /* Optional host machine definition. Pure autoconf targets will not
741 need a "xm.h" file. This will be a symlink to one of the xm-*.h
742 files, built by the `configure' script. */
748 /* Optional native machine support. Non-native (and possibly pure
749 multi-arch) targets do not need a "nm.h" file. This will be a
750 symlink to one of the nm-*.h files, built by the `configure'
757 /* Optional target machine definition. Pure multi-arch configurations
758 do not need a "tm.h" file. This will be a symlink to one of the
759 tm-*.h files, built by the `configure' script. */
765 /* GDB_MULTI_ARCH is normally set by configure.in using information
766 from configure.tgt or the config/%/%.mt Makefile fragment. Since
767 some targets have defined it in their "tm.h" file, delay providing
768 a default definition until after "tm.h" has been included.. */
770 #ifndef GDB_MULTI_ARCH
771 #define GDB_MULTI_ARCH 0
775 /* If the xm.h file did not define the mode string used to open the
776 files, assume that binary files are opened the same way as text
779 #include "fopen-same.h"
782 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
783 FIXME: Assumes 2's complement arithmetic */
785 #if !defined (UINT_MAX)
786 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
789 #if !defined (INT_MAX)
790 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
793 #if !defined (INT_MIN)
794 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
797 #if !defined (ULONG_MAX)
798 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
801 #if !defined (LONG_MAX)
802 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
805 #if !defined (ULONGEST_MAX)
806 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
809 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
810 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
813 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
814 arguments to a function, number in a value history, register number, etc.)
815 where the value must not be larger than can fit in an int. */
817 extern int longest_to_int (LONGEST
);
819 /* Assorted functions we can declare, now that const and volatile are
822 extern char *savestring (const char *, size_t);
824 extern char *msavestring (void *, const char *, size_t);
826 extern char *mstrsave (void *, const char *);
828 /* Robust versions of same. Throw an internal error when no memory,
829 guard against stray NULL arguments. */
830 extern void *xmmalloc (void *md
, size_t size
);
831 extern void *xmrealloc (void *md
, void *ptr
, size_t size
);
832 extern void *xmcalloc (void *md
, size_t number
, size_t size
);
833 extern void xmfree (void *md
, void *ptr
);
835 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
837 extern void xfree (void *);
839 /* Utility macro to allocate typed memory. Avoids errors like
840 ``struct foo *foo = xmalloc (sizeof bar)'' and ``struct foo *foo =
841 (struct foo *) xmalloc (sizeof bar)''. */
842 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
844 /* Like asprintf/vasprintf but get an internal_error if the call
846 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
847 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
849 extern int parse_escape (char **);
851 /* Message to be printed before the error message, when an error occurs. */
853 extern char *error_pre_print
;
855 /* Message to be printed before the error message, when an error occurs. */
857 extern char *quit_pre_print
;
859 /* Message to be printed before the warning message, when a warning occurs. */
861 extern char *warning_pre_print
;
863 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
865 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
867 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
869 /* Returns a freshly allocate buffer containing the last error
871 extern char *error_last_message (void);
873 extern NORETURN
void internal_verror (const char *file
, int line
,
874 const char *, va_list ap
) ATTR_NORETURN
;
876 extern NORETURN
void internal_error (const char *file
, int line
,
877 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
879 extern NORETURN
void nomem (long) ATTR_NORETURN
;
881 /* Reasons for calling throw_exception(). NOTE: all reason values
882 must be less than zero. enum value 0 is reserved for internal use
883 as the return value from an initial setjmp(). The function
884 catch_exceptions() reserves values >= 0 as legal results from its
889 /* User interrupt. */
891 /* Any other error. */
895 #define ALL_CLEANUPS ((struct cleanup *)0)
897 #define RETURN_MASK(reason) (1 << (int)(-reason))
898 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
899 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
900 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
901 typedef int return_mask
;
903 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
904 to the inner most containing exception handler established using
905 catch_exceptions() (or the legacy catch_errors()).
907 Code normally throws an exception using error() et.al. For various
908 reaons, GDB also contains code that throws an exception directly.
909 For instance, the remote*.c targets contain CNTRL-C signal handlers
910 that propogate the QUIT event up the exception chain. ``This could
911 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
913 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
915 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
916 handler. If an exception (enum return_reason) is thrown using
917 throw_exception() than all cleanups installed since
918 catch_exceptions() was entered are invoked, the (-ve) exception
919 value is then returned by catch_exceptions. If FUNC() returns
920 normally (with a postive or zero return value) then that value is
921 returned by catch_exceptions(). It is an internal_error() for
922 FUNC() to return a negative value.
924 For the period of the FUNC() call: UIOUT is installed as the output
925 builder; ERRSTRING is installed as the error/quit message; and a
926 new cleanup_chain is established. The old values are restored
927 before catch_exceptions() returns.
929 FIXME; cagney/2001-08-13: The need to override the global UIOUT
930 builder variable should just go away.
932 This function superseeds catch_errors().
934 This function uses SETJMP() and LONGJUMP(). */
937 typedef int (catch_exceptions_ftype
) (struct ui_out
*ui_out
, void *args
);
938 extern int catch_exceptions (struct ui_out
*uiout
,
939 catch_exceptions_ftype
*func
, void *func_args
,
940 char *errstring
, return_mask mask
);
942 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
943 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
944 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
945 value. It's unfortunate that, catch_errors() does not return an
946 indication of the exact exception that it caught - quit_flag might
949 This function is superseeded by catch_exceptions(). */
951 typedef int (catch_errors_ftype
) (PTR
);
952 extern int catch_errors (catch_errors_ftype
*, void *, char *, return_mask
);
954 /* Template to catch_errors() that wraps calls to command
957 typedef void (catch_command_errors_ftype
) (char *, int);
958 extern int catch_command_errors (catch_command_errors_ftype
*func
, char *command
, int from_tty
, return_mask
);
960 extern void warning (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
962 extern void vwarning (const char *, va_list args
);
964 /* Global functions from other, non-gdb GNU thingies.
965 Libiberty thingies are no longer declared here. We include libiberty.h
968 #ifndef GETENV_PROVIDED
969 extern char *getenv (const char *);
972 /* From other system libraries */
982 #define min(a, b) ((a) < (b) ? (a) : (b))
985 #define max(a, b) ((a) > (b) ? (a) : (b))
989 /* We take the address of fclose later, but some stdio's forget
990 to declare this. We can't always declare it since there's
991 no way to declare the parameters without upsetting some compiler
994 #ifndef FCLOSE_PROVIDED
995 extern int fclose (FILE *);
999 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1002 /* Various possibilities for alloca. */
1005 #define alloca __builtin_alloca
1006 #else /* Not GNU C */
1007 #ifdef HAVE_ALLOCA_H
1014 /* We need to be careful not to declare this in a way which conflicts with
1015 bison. Bison never declares it as char *, but under various circumstances
1016 (like __hpux) we need to use void *. */
1017 extern void *alloca ();
1018 #endif /* Not _AIX */
1019 #endif /* Not HAVE_ALLOCA_H */
1020 #endif /* Not GNU C */
1021 #endif /* alloca not defined */
1023 /* Dynamic target-system-dependent parameters for GDB. */
1024 #include "gdbarch.h"
1025 #if (GDB_MULTI_ARCH == 0)
1026 /* Multi-arch targets _should_ be including "arch-utils.h" directly
1027 into their *-tdep.c file. This is a prop to help old non-
1028 multi-arch targets to continue to compile. */
1029 #include "arch-utils.h"
1032 /* Static target-system-dependent parameters for GDB. */
1034 /* Number of bits in a char or unsigned char for the target machine.
1035 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1036 #if !defined (TARGET_CHAR_BIT)
1037 #define TARGET_CHAR_BIT 8
1040 /* If we picked up a copy of CHAR_BIT from a configuration file
1041 (which may get it by including <limits.h>) then use it to set
1042 the number of bits in a host char. If not, use the same size
1045 #if defined (CHAR_BIT)
1046 #define HOST_CHAR_BIT CHAR_BIT
1048 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1051 /* The bit byte-order has to do just with numbering of bits in
1052 debugging symbols and such. Conceptually, it's quite separate
1053 from byte/word byte order. */
1055 #if !defined (BITS_BIG_ENDIAN)
1056 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1061 extern LONGEST
extract_signed_integer (void *, int);
1063 extern ULONGEST
extract_unsigned_integer (void *, int);
1065 extern int extract_long_unsigned_integer (void *, int, LONGEST
*);
1067 extern CORE_ADDR
extract_address (void *, int);
1069 extern CORE_ADDR
extract_typed_address (void *buf
, struct type
*type
);
1071 extern void store_signed_integer (void *, int, LONGEST
);
1073 extern void store_unsigned_integer (void *, int, ULONGEST
);
1075 extern void store_address (void *, int, LONGEST
);
1077 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1082 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1084 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1086 extern int watchdog
;
1088 /* Hooks for alternate command interfaces. */
1090 /* The name of the interpreter if specified on the command line. */
1091 extern char *interpreter_p
;
1093 /* If a given interpreter matches INTERPRETER_P then it should update
1094 command_loop_hook and init_ui_hook with the per-interpreter
1096 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1098 struct target_waitstatus
;
1099 struct cmd_list_element
;
1101 /* Should the asynchronous variant of the interpreter (using the
1102 event-loop) be enabled? */
1103 extern int event_loop_p
;
1105 extern void (*init_ui_hook
) (char *argv0
);
1106 extern void (*command_loop_hook
) (void);
1107 extern void (*show_load_progress
) (const char *section
,
1108 unsigned long section_sent
,
1109 unsigned long section_size
,
1110 unsigned long total_sent
,
1111 unsigned long total_size
);
1112 extern void (*print_frame_info_listing_hook
) (struct symtab
* s
,
1113 int line
, int stopline
,
1115 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1116 extern int (*query_hook
) (const char *, va_list);
1117 extern void (*warning_hook
) (const char *, va_list);
1118 extern void (*flush_hook
) (struct ui_file
* stream
);
1119 extern void (*create_breakpoint_hook
) (struct breakpoint
* b
);
1120 extern void (*delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1121 extern void (*modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1122 extern void (*interactive_hook
) (void);
1123 extern void (*registers_changed_hook
) (void);
1124 extern void (*readline_begin_hook
) (char *,...);
1125 extern char *(*readline_hook
) (char *);
1126 extern void (*readline_end_hook
) (void);
1127 extern void (*register_changed_hook
) (int regno
);
1128 extern void (*memory_changed_hook
) (CORE_ADDR addr
, int len
);
1129 extern void (*context_hook
) (int);
1130 extern ptid_t (*target_wait_hook
) (ptid_t ptid
,
1131 struct target_waitstatus
* status
);
1133 extern void (*attach_hook
) (void);
1134 extern void (*detach_hook
) (void);
1135 extern void (*call_command_hook
) (struct cmd_list_element
* c
,
1136 char *cmd
, int from_tty
);
1138 extern void (*set_hook
) (struct cmd_list_element
* c
);
1140 extern NORETURN
void (*error_hook
) (void) ATTR_NORETURN
;
1142 extern void (*error_begin_hook
) (void);
1144 extern int (*ui_load_progress_hook
) (const char *section
, unsigned long num
);
1147 /* Inhibit window interface if non-zero. */
1149 extern int use_windows
;
1151 /* Symbolic definitions of filename-related things. */
1152 /* FIXME, this doesn't work very well if host and executable
1153 filesystems conventions are different. */
1155 #ifndef DIRNAME_SEPARATOR
1156 #define DIRNAME_SEPARATOR ':'
1159 #ifndef SLASH_STRING
1160 #define SLASH_STRING "/"
1165 # define GLOBAL_CURDIR
1168 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1169 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1170 in the code actually refer to a lightweight process id, i.e,
1171 something that can be considered a process id in its own right for
1172 certain purposes. */
1175 #define PIDGET(PTID) (ptid_get_pid (PTID))
1176 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1177 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1180 /* Define well known filenos if the system does not define them. */
1181 #ifndef STDIN_FILENO
1182 #define STDIN_FILENO 0
1184 #ifndef STDOUT_FILENO
1185 #define STDOUT_FILENO 1
1187 #ifndef STDERR_FILENO
1188 #define STDERR_FILENO 2
1191 /* If this definition isn't overridden by the header files, assume
1192 that isatty and fileno exist on this system. */
1194 #define ISATTY(FP) (isatty (fileno (FP)))
1197 #endif /* #ifndef DEFS_H */