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. */
30 #include <errno.h> /* System call error return status. */
36 #include <sys/types.h> /* For size_t. */
43 /* First include ansidecl.h so we can use the various macro definitions
44 here and in all subsequent file inclusions. */
48 #include "gdb_locale.h"
50 /* For ``enum target_signal''. */
51 #include "gdb/signals.h"
53 /* Just in case they're not defined in stdio.h. */
62 #include <stdarg.h> /* For va_list. */
64 #include "libiberty.h"
68 /* For BFD64 and bfd_vma. */
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). */
76 #define GDB_MULTI_ARCH_PARTIAL 1
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
83 This setting is only useful during a multi-arch conversion. */
85 #define GDB_MULTI_ARCH_TM 2
87 /* The target is pure multi-arch. The MULTI-ARCH vector provides all
88 definitions. "tm.h" is linked to an empty file. */
90 #define GDB_MULTI_ARCH_PURE 3
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
100 typedef bfd_vma CORE_ADDR
;
102 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
108 #define LONGEST BFD_HOST_64_BIT
109 #define ULONGEST BFD_HOST_U_64_BIT
113 #ifdef CC_HAS_LONG_LONG
114 #define LONGEST long long
115 #define ULONGEST unsigned long long
117 #ifdef BFD_HOST_64_BIT
118 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
119 (e.g. i386-windows) so try it. */
120 #define LONGEST BFD_HOST_64_BIT
121 #define ULONGEST BFD_HOST_U_64_BIT
124 #define ULONGEST unsigned long
128 #endif /* No BFD64 */
130 #endif /* ! LONGEST */
133 #define min(a, b) ((a) < (b) ? (a) : (b))
136 #define max(a, b) ((a) > (b) ? (a) : (b))
139 /* Macros to do string compares.
141 NOTE: cagney/2000-03-14:
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''.
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.
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. */
157 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
158 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
160 /* Check if a character is one of the commonly used C++ marker characters. */
161 extern int is_cplus_marker (int);
163 /* use tui interface if non-zero */
164 extern int tui_version
;
166 /* enable xdb commands if set */
167 extern int xdb_commands
;
169 /* enable dbx commands if set */
170 extern int dbx_commands
;
172 extern int quit_flag
;
173 extern int immediate_quit
;
174 extern int sevenbit_strings
;
176 extern void quit (void);
178 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
179 benefits of having a ``QUIT'' macro rather than a function are
180 marginal. If the overhead of a QUIT function call is proving
181 significant then its calling frequency should probably be reduced
182 [kingdon]. A profile analyzing the current situtation is
186 /* do twice to force compiler warning */
187 #define QUIT_FIXME "FIXME"
188 #define QUIT_FIXME "ignoring redefinition of QUIT"
191 if (quit_flag) quit (); \
192 if (interactive_hook) interactive_hook (); \
197 /* Languages represented in the symbol table and elsewhere.
198 This should probably be in language.h, but since enum's can't
199 be forward declared to satisfy opaque references before their
200 actual definition, needs to be here. */
204 language_unknown
, /* Language not known */
205 language_auto
, /* Placeholder for automatic setting */
207 language_cplus
, /* C++ */
208 language_objc
, /* Objective-C */
209 language_java
, /* Java */
210 language_fortran
, /* Fortran */
211 language_m2
, /* Modula-2 */
212 language_asm
, /* Assembly language */
213 language_scm
, /* Scheme / Guile */
214 language_pascal
/* Pascal */
221 unspecified_precision
224 /* A generic, not quite boolean, enumeration. */
232 /* the cleanup list records things that have to be undone
233 if an error happens (descriptors to be closed, memory to be freed, etc.)
234 Each link in the chain records a function to call and an
237 Use make_cleanup to add an element to the cleanup chain.
238 Use do_cleanups to do all cleanup actions back to a given
239 point in the chain. Use discard_cleanups to remove cleanups
240 from the chain back to a given point, not doing them. */
244 struct cleanup
*next
;
245 void (*function
) (PTR
);
250 /* The ability to declare that a function never returns is useful, but
251 not really required to compile GDB successfully, so the NORETURN and
252 ATTR_NORETURN macros normally expand into nothing. */
254 /* If compiling with older versions of GCC, a function may be declared
255 "volatile" to indicate that it does not return. */
258 #if defined(__GNUC__) \
259 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
260 #define NORETURN volatile
262 #define NORETURN /* nothing */
266 /* GCC 2.5 and later versions define a function attribute "noreturn",
267 which is the preferred way to declare that a function never returns.
268 However GCC 2.7 appears to be the first version in which this fully
269 works everywhere we use it. */
271 #ifndef ATTR_NORETURN
272 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
273 #define ATTR_NORETURN __attribute__ ((noreturn))
275 #define ATTR_NORETURN /* nothing */
280 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
281 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
283 #define ATTR_FORMAT(type, x, y) /* nothing */
287 /* Needed for various prototypes */
292 /* From blockframe.c */
294 extern int inside_entry_func (CORE_ADDR
);
296 extern int inside_entry_file (CORE_ADDR addr
);
298 extern int inside_main_func (CORE_ADDR pc
);
302 extern void initialize_utils (void);
304 extern void notice_quit (void);
306 extern int strcmp_iw (const char *, const char *);
308 extern int subset_compare (char *, char *);
310 extern char *safe_strerror (int);
312 extern void init_malloc (void *);
314 extern void request_quit (int);
316 extern void do_cleanups (struct cleanup
*);
317 extern void do_final_cleanups (struct cleanup
*);
318 extern void do_my_cleanups (struct cleanup
**, struct cleanup
*);
319 extern void do_run_cleanups (struct cleanup
*);
320 extern void do_exec_cleanups (struct cleanup
*);
321 extern void do_exec_error_cleanups (struct cleanup
*);
323 extern void discard_cleanups (struct cleanup
*);
324 extern void discard_final_cleanups (struct cleanup
*);
325 extern void discard_exec_error_cleanups (struct cleanup
*);
326 extern void discard_my_cleanups (struct cleanup
**, struct cleanup
*);
328 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
329 make_cleanup function declarations below. Do not use this typedef
330 as a cast when passing functions into the make_cleanup() code.
331 Instead either use a bounce function or add a wrapper function.
332 Calling a f(char*) function with f(void*) is non-portable. */
333 typedef void (make_cleanup_ftype
) (void *);
335 extern struct cleanup
*make_cleanup (make_cleanup_ftype
*, void *);
337 extern struct cleanup
*make_cleanup_freeargv (char **);
340 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
342 extern struct cleanup
*make_cleanup_close (int fd
);
344 extern struct cleanup
*make_cleanup_bfd_close (bfd
*abfd
);
346 extern struct cleanup
*make_final_cleanup (make_cleanup_ftype
*, void *);
348 extern struct cleanup
*make_my_cleanup (struct cleanup
**,
349 make_cleanup_ftype
*, void *);
351 extern struct cleanup
*make_run_cleanup (make_cleanup_ftype
*, void *);
353 extern struct cleanup
*make_exec_cleanup (make_cleanup_ftype
*, void *);
354 extern struct cleanup
*make_exec_error_cleanup (make_cleanup_ftype
*, void *);
356 extern struct cleanup
*save_cleanups (void);
357 extern struct cleanup
*save_final_cleanups (void);
358 extern struct cleanup
*save_my_cleanups (struct cleanup
**);
360 extern void restore_cleanups (struct cleanup
*);
361 extern void restore_final_cleanups (struct cleanup
*);
362 extern void restore_my_cleanups (struct cleanup
**, struct cleanup
*);
364 extern void free_current_contents (void *);
366 extern void null_cleanup (void *);
368 extern int myread (int, char *, int);
370 extern int query (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
372 extern void init_page_info (void);
374 extern CORE_ADDR
host_pointer_to_address (void *ptr
);
375 extern void *address_to_host_pointer (CORE_ADDR addr
);
377 extern char *gdb_realpath (const char *);
378 extern char *xfullpath (const char *);
380 /* From demangle.c */
382 extern void set_demangling_style (char *);
387 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
388 extern use_struct_convention_fn generic_use_struct_convention
;
391 /* Annotation stuff. */
393 extern int annotation_level
; /* in stack.c */
395 extern void begin_line (void);
397 extern void wrap_here (char *);
399 extern void reinitialize_more_filter (void);
402 extern struct ui_file
*gdb_stdout
;
403 /* Serious error notifications */
404 extern struct ui_file
*gdb_stderr
;
405 /* Log/debug/trace messages that should bypass normal stdout/stderr
406 filtering. For momement, always call this stream using
407 *_unfiltered. In the very near future that restriction shall be
408 removed - either call shall be unfiltered. (cagney 1999-06-13). */
409 extern struct ui_file
*gdb_stdlog
;
410 /* Target output that should bypass normal stdout/stderr filtering.
411 For momement, always call this stream using *_unfiltered. In the
412 very near future that restriction shall be removed - either call
413 shall be unfiltered. (cagney 1999-07-02). */
414 extern struct ui_file
*gdb_stdtarg
;
422 /* More generic printf like operations. Filtered versions may return
423 non-locally on error. */
425 extern void fputs_filtered (const char *, struct ui_file
*);
427 extern void fputs_unfiltered (const char *, struct ui_file
*);
429 extern int fputc_filtered (int c
, struct ui_file
*);
431 extern int fputc_unfiltered (int c
, struct ui_file
*);
433 extern int putchar_filtered (int c
);
435 extern int putchar_unfiltered (int c
);
437 extern void puts_filtered (const char *);
439 extern void puts_unfiltered (const char *);
441 extern void puts_filtered_tabular (char *string
, int width
, int right
);
443 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
445 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
447 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
449 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
451 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
453 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
455 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
457 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
459 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
461 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
463 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
465 extern void print_spaces (int, struct ui_file
*);
467 extern void print_spaces_filtered (int, struct ui_file
*);
469 extern char *n_spaces (int);
471 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
473 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
475 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
477 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
478 extern void gdb_print_host_address (void *addr
, struct ui_file
*stream
);
480 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
481 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
483 extern int strlen_paddr (void);
484 extern char *paddr (CORE_ADDR addr
);
485 extern char *paddr_nz (CORE_ADDR addr
);
486 extern char *paddr_u (CORE_ADDR addr
);
487 extern char *paddr_d (LONGEST addr
);
489 extern char *phex (ULONGEST l
, int sizeof_l
);
490 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
492 /* Like paddr() only print/scan raw CORE_ADDR. The output from
493 core_addr_to_string() can be passed direct to
494 string_to_core_addr(). */
495 extern const char *core_addr_to_string (const CORE_ADDR addr
);
496 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
497 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
499 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
502 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
504 extern void print_sys_errmsg (const char *, int);
506 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
507 "const char *" in unistd.h, so we can't declare the argument
510 extern char *re_comp (const char *);
514 extern void symbol_file_command (char *, int);
516 /* Remote targets may wish to use this as their load function. */
517 extern void generic_load (char *name
, int from_tty
);
519 /* Summarise a download */
520 extern void print_transfer_performance (struct ui_file
*stream
,
521 unsigned long data_count
,
522 unsigned long write_count
,
523 unsigned long time_count
);
527 typedef void initialize_file_ftype (void);
529 extern char *skip_quoted (char *);
531 extern char *gdb_readline (char *);
533 extern char *gdb_readline_wrapper (char *);
535 extern char *command_line_input (char *, int, char *);
537 extern void print_prompt (void);
539 extern int input_from_terminal_p (void);
541 extern int info_verbose
;
543 /* From printcmd.c */
545 extern void set_next_address (CORE_ADDR
);
547 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
550 extern int build_address_symbolic (CORE_ADDR addr
,
558 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
560 extern void print_address (CORE_ADDR
, struct ui_file
*);
564 extern int openp (const char *, int, const char *, int, int, char **);
566 extern int source_full_path_of (char *, char **);
568 extern void mod_path (char *, char **);
570 extern void add_path (char *, char **, int);
572 extern void directory_command (char *, int);
574 extern char *source_path
;
576 extern void init_source_path (void);
578 extern void init_last_source_visited (void);
580 extern char *symtab_to_filename (struct symtab
*);
584 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
585 bfd_signed_vma data_off
,
586 bfd_signed_vma bss_off
);
588 /* Take over the 'find_mapped_memory' vector from exec.c. */
589 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
595 /* Possible lvalue types. Like enum language, this should be in
596 value.h, but needs to be here for the same reason. */
602 /* In memory. Could be a saved register. */
606 /* In a gdb internal variable. */
608 /* Part of a gdb internal variable (structure field). */
609 lval_internalvar_component
,
610 /* In a register series in a frame not the current one, which may have been
611 partially saved or saved in different places (otherwise would be
612 lval_register or lval_memory). */
613 lval_reg_frame_relative
618 /* Control types for commands */
620 enum misc_command_type
628 enum command_control_type
638 /* Structure for saved commands lines
639 (for breakpoints, defined commands, etc). */
643 struct command_line
*next
;
645 enum command_control_type control_type
;
647 struct command_line
**body_list
;
650 extern struct command_line
*read_command_lines (char *, int);
652 extern void free_command_lines (struct command_line
**);
654 /* To continue the execution commands when running gdb asynchronously.
655 A continuation structure contains a pointer to a function to be called
656 to finish the command, once the target has stopped. Such mechanism is
657 used bt the finish and until commands, and in the remote protocol
658 when opening an extended-remote connection. */
660 struct continuation_arg
662 struct continuation_arg
*next
;
663 union continuation_data
{
672 void (*continuation_hook
) (struct continuation_arg
*);
673 struct continuation_arg
*arg_list
;
674 struct continuation
*next
;
678 extern struct continuation
*cmd_continuation
;
679 /* Used only by the step_1 function. */
680 extern struct continuation
*intermediate_continuation
;
683 extern void add_continuation (void (*)(struct continuation_arg
*),
684 struct continuation_arg
*);
685 extern void do_all_continuations (void);
686 extern void discard_all_continuations (void);
688 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
689 struct continuation_arg
*);
690 extern void do_all_intermediate_continuations (void);
691 extern void discard_all_intermediate_continuations (void);
693 /* String containing the current directory (what getwd would return). */
695 extern char *current_directory
;
697 /* Default radixes for input and output. Only some values supported. */
698 extern unsigned input_radix
;
699 extern unsigned output_radix
;
701 /* Possibilities for prettyprint parameters to routines which print
702 things. Like enum language, this should be in value.h, but needs
703 to be here for the same reason. FIXME: If we can eliminate this
704 as an arg to LA_VAL_PRINT, then we can probably move it back to
709 Val_no_prettyprint
= 0,
711 /* Use the default setting which the user has specified. */
715 /* The ptid struct is a collection of the various "ids" necessary
716 for identifying the inferior. This consists of the process id
717 (pid), thread id (tid), and other fields necessary for uniquely
718 identifying the inferior process/thread being debugged. When
719 manipulating ptids, the constructors, accessors, and predicate
720 declared in inferior.h should be used. These are as follows:
722 ptid_build - Make a new ptid from a pid, lwp, and tid.
723 pid_to_ptid - Make a new ptid from just a pid.
724 ptid_get_pid - Fetch the pid component of a ptid.
725 ptid_get_lwp - Fetch the lwp component of a ptid.
726 ptid_get_tid - Fetch the tid component of a ptid.
727 ptid_equal - Test to see if two ptids are equal.
729 Please do NOT access the struct ptid members directly (except, of
730 course, in the implementation of the above ptid manipulation
738 /* Lightweight process id */
745 typedef struct ptid ptid_t
;
749 /* Optional host machine definition. Pure autoconf targets will not
750 need a "xm.h" file. This will be a symlink to one of the xm-*.h
751 files, built by the `configure' script. */
757 /* Optional native machine support. Non-native (and possibly pure
758 multi-arch) targets do not need a "nm.h" file. This will be a
759 symlink to one of the nm-*.h files, built by the `configure'
766 /* Optional target machine definition. Pure multi-arch configurations
767 do not need a "tm.h" file. This will be a symlink to one of the
768 tm-*.h files, built by the `configure' script. */
774 /* GDB_MULTI_ARCH is normally set by configure.in using information
775 from configure.tgt or the config/%/%.mt Makefile fragment. Since
776 some targets have defined it in their "tm.h" file, delay providing
777 a default definition until after "tm.h" has been included.. */
779 #ifndef GDB_MULTI_ARCH
780 #define GDB_MULTI_ARCH 0
784 /* If the xm.h file did not define the mode string used to open the
785 files, assume that binary files are opened the same way as text
788 #include "fopen-same.h"
791 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
792 FIXME: Assumes 2's complement arithmetic */
794 #if !defined (UINT_MAX)
795 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
798 #if !defined (INT_MAX)
799 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
802 #if !defined (INT_MIN)
803 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
806 #if !defined (ULONG_MAX)
807 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
810 #if !defined (LONG_MAX)
811 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
814 #if !defined (ULONGEST_MAX)
815 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
818 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
819 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
822 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
823 arguments to a function, number in a value history, register number, etc.)
824 where the value must not be larger than can fit in an int. */
826 extern int longest_to_int (LONGEST
);
828 /* Assorted functions we can declare, now that const and volatile are
831 extern char *savestring (const char *, size_t);
833 extern char *msavestring (void *, const char *, size_t);
835 extern char *mstrsave (void *, const char *);
837 /* Robust versions of same. Throw an internal error when no memory,
838 guard against stray NULL arguments. */
839 extern void *xmmalloc (void *md
, size_t size
);
840 extern void *xmrealloc (void *md
, void *ptr
, size_t size
);
841 extern void *xmcalloc (void *md
, size_t number
, size_t size
);
842 extern void xmfree (void *md
, void *ptr
);
844 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
846 extern void xfree (void *);
848 /* Utility macros to allocate typed memory. Avoids errors like
849 ``struct foo *foo = xmalloc (sizeof bar)'' and ``struct foo *foo =
850 (struct foo *) xmalloc (sizeof bar)''. */
851 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
852 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
854 /* Like asprintf/vasprintf but get an internal_error if the call
856 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
857 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
859 extern int parse_escape (char **);
861 /* Message to be printed before the error message, when an error occurs. */
863 extern char *error_pre_print
;
865 /* Message to be printed before the error message, when an error occurs. */
867 extern char *quit_pre_print
;
869 /* Message to be printed before the warning message, when a warning occurs. */
871 extern char *warning_pre_print
;
873 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
875 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
877 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
879 /* Returns a freshly allocate buffer containing the last error
881 extern char *error_last_message (void);
883 extern NORETURN
void internal_verror (const char *file
, int line
,
884 const char *, va_list ap
) ATTR_NORETURN
;
886 extern NORETURN
void internal_error (const char *file
, int line
,
887 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
889 extern void internal_vwarning (const char *file
, int line
,
890 const char *, va_list ap
);
892 extern void internal_warning (const char *file
, int line
,
893 const char *, ...) ATTR_FORMAT (printf
, 3, 4);
895 extern NORETURN
void nomem (long) ATTR_NORETURN
;
897 /* Reasons for calling throw_exception(). NOTE: all reason values
898 must be less than zero. enum value 0 is reserved for internal use
899 as the return value from an initial setjmp(). The function
900 catch_exceptions() reserves values >= 0 as legal results from its
905 /* User interrupt. */
907 /* Any other error. */
911 #define ALL_CLEANUPS ((struct cleanup *)0)
913 #define RETURN_MASK(reason) (1 << (int)(-reason))
914 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
915 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
916 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
917 typedef int return_mask
;
919 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
920 to the inner most containing exception handler established using
921 catch_exceptions() (or the legacy catch_errors()).
923 Code normally throws an exception using error() et.al. For various
924 reaons, GDB also contains code that throws an exception directly.
925 For instance, the remote*.c targets contain CNTRL-C signal handlers
926 that propogate the QUIT event up the exception chain. ``This could
927 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
929 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
931 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
932 handler. If an exception (enum return_reason) is thrown using
933 throw_exception() than all cleanups installed since
934 catch_exceptions() was entered are invoked, the (-ve) exception
935 value is then returned by catch_exceptions. If FUNC() returns
936 normally (with a postive or zero return value) then that value is
937 returned by catch_exceptions(). It is an internal_error() for
938 FUNC() to return a negative value.
940 For the period of the FUNC() call: UIOUT is installed as the output
941 builder; ERRSTRING is installed as the error/quit message; and a
942 new cleanup_chain is established. The old values are restored
943 before catch_exceptions() returns.
945 FIXME; cagney/2001-08-13: The need to override the global UIOUT
946 builder variable should just go away.
948 This function superseeds catch_errors().
950 This function uses SETJMP() and LONGJUMP(). */
953 typedef int (catch_exceptions_ftype
) (struct ui_out
*ui_out
, void *args
);
954 extern int catch_exceptions (struct ui_out
*uiout
,
955 catch_exceptions_ftype
*func
, void *func_args
,
956 char *errstring
, return_mask mask
);
958 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
959 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
960 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
961 value. It's unfortunate that, catch_errors() does not return an
962 indication of the exact exception that it caught - quit_flag might
965 This function is superseeded by catch_exceptions(). */
967 typedef int (catch_errors_ftype
) (PTR
);
968 extern int catch_errors (catch_errors_ftype
*, void *, char *, return_mask
);
970 /* Template to catch_errors() that wraps calls to command
973 typedef void (catch_command_errors_ftype
) (char *, int);
974 extern int catch_command_errors (catch_command_errors_ftype
*func
, char *command
, int from_tty
, return_mask
);
976 extern void warning (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
978 extern void vwarning (const char *, va_list args
);
980 /* List of known OS ABIs. If you change this, make sure to update the
984 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
986 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
993 GDB_OSABI_FREEBSD_AOUT
,
994 GDB_OSABI_FREEBSD_ELF
,
995 GDB_OSABI_NETBSD_AOUT
,
996 GDB_OSABI_NETBSD_ELF
,
1006 GDB_OSABI_ARM_EABI_V1
,
1007 GDB_OSABI_ARM_EABI_V2
,
1010 GDB_OSABI_INVALID
/* keep this last */
1013 /* Global functions from other, non-gdb GNU thingies.
1014 Libiberty thingies are no longer declared here. We include libiberty.h
1017 #ifndef GETENV_PROVIDED
1018 extern char *getenv (const char *);
1021 /* From other system libraries */
1023 #ifdef HAVE_STDDEF_H
1027 #ifdef HAVE_STDLIB_H
1031 #define min(a, b) ((a) < (b) ? (a) : (b))
1034 #define max(a, b) ((a) > (b) ? (a) : (b))
1038 /* We take the address of fclose later, but some stdio's forget
1039 to declare this. We can't always declare it since there's
1040 no way to declare the parameters without upsetting some compiler
1043 #ifndef FCLOSE_PROVIDED
1044 extern int fclose (FILE *);
1048 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1051 /* Various possibilities for alloca. */
1054 #define alloca __builtin_alloca
1055 #else /* Not GNU C */
1056 #ifdef HAVE_ALLOCA_H
1063 /* We need to be careful not to declare this in a way which conflicts with
1064 bison. Bison never declares it as char *, but under various circumstances
1065 (like __hpux) we need to use void *. */
1066 extern void *alloca ();
1067 #endif /* Not _AIX */
1068 #endif /* Not HAVE_ALLOCA_H */
1069 #endif /* Not GNU C */
1070 #endif /* alloca not defined */
1072 /* Dynamic target-system-dependent parameters for GDB. */
1073 #include "gdbarch.h"
1074 #if (GDB_MULTI_ARCH == 0)
1075 /* Multi-arch targets _should_ be including "arch-utils.h" directly
1076 into their *-tdep.c file. This is a prop to help old non-
1077 multi-arch targets to continue to compile. */
1078 #include "arch-utils.h"
1081 /* Static target-system-dependent parameters for GDB. */
1083 /* Number of bits in a char or unsigned char for the target machine.
1084 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1085 #if !defined (TARGET_CHAR_BIT)
1086 #define TARGET_CHAR_BIT 8
1089 /* If we picked up a copy of CHAR_BIT from a configuration file
1090 (which may get it by including <limits.h>) then use it to set
1091 the number of bits in a host char. If not, use the same size
1094 #if defined (CHAR_BIT)
1095 #define HOST_CHAR_BIT CHAR_BIT
1097 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1100 /* The bit byte-order has to do just with numbering of bits in
1101 debugging symbols and such. Conceptually, it's quite separate
1102 from byte/word byte order. */
1104 #if !defined (BITS_BIG_ENDIAN)
1105 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1110 extern LONGEST
extract_signed_integer (const void *, int);
1112 extern ULONGEST
extract_unsigned_integer (const void *, int);
1114 extern int extract_long_unsigned_integer (void *, int, LONGEST
*);
1116 extern CORE_ADDR
extract_address (void *, int);
1118 extern CORE_ADDR
extract_typed_address (void *buf
, struct type
*type
);
1120 extern void store_signed_integer (void *, int, LONGEST
);
1122 extern void store_unsigned_integer (void *, int, ULONGEST
);
1124 extern void store_address (void *, int, LONGEST
);
1126 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1131 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1133 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1135 extern int watchdog
;
1137 /* Hooks for alternate command interfaces. */
1139 /* The name of the interpreter if specified on the command line. */
1140 extern char *interpreter_p
;
1142 /* If a given interpreter matches INTERPRETER_P then it should update
1143 command_loop_hook and init_ui_hook with the per-interpreter
1145 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1147 struct target_waitstatus
;
1148 struct cmd_list_element
;
1150 /* Should the asynchronous variant of the interpreter (using the
1151 event-loop) be enabled? */
1152 extern int event_loop_p
;
1154 extern void (*init_ui_hook
) (char *argv0
);
1155 extern void (*command_loop_hook
) (void);
1156 extern void (*show_load_progress
) (const char *section
,
1157 unsigned long section_sent
,
1158 unsigned long section_size
,
1159 unsigned long total_sent
,
1160 unsigned long total_size
);
1161 extern void (*print_frame_info_listing_hook
) (struct symtab
* s
,
1162 int line
, int stopline
,
1164 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1165 extern int (*query_hook
) (const char *, va_list);
1166 extern void (*warning_hook
) (const char *, va_list);
1167 extern void (*flush_hook
) (struct ui_file
* stream
);
1168 extern void (*create_breakpoint_hook
) (struct breakpoint
* b
);
1169 extern void (*delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1170 extern void (*modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1171 extern void (*interactive_hook
) (void);
1172 extern void (*registers_changed_hook
) (void);
1173 extern void (*readline_begin_hook
) (char *,...);
1174 extern char *(*readline_hook
) (char *);
1175 extern void (*readline_end_hook
) (void);
1176 extern void (*register_changed_hook
) (int regno
);
1177 extern void (*memory_changed_hook
) (CORE_ADDR addr
, int len
);
1178 extern void (*context_hook
) (int);
1179 extern ptid_t (*target_wait_hook
) (ptid_t ptid
,
1180 struct target_waitstatus
* status
);
1182 extern void (*attach_hook
) (void);
1183 extern void (*detach_hook
) (void);
1184 extern void (*call_command_hook
) (struct cmd_list_element
* c
,
1185 char *cmd
, int from_tty
);
1187 extern void (*set_hook
) (struct cmd_list_element
* c
);
1189 extern NORETURN
void (*error_hook
) (void) ATTR_NORETURN
;
1191 extern void (*error_begin_hook
) (void);
1193 extern int (*ui_load_progress_hook
) (const char *section
, unsigned long num
);
1196 /* Inhibit window interface if non-zero. */
1198 extern int use_windows
;
1200 /* Symbolic definitions of filename-related things. */
1201 /* FIXME, this doesn't work very well if host and executable
1202 filesystems conventions are different. */
1204 #ifndef DIRNAME_SEPARATOR
1205 #define DIRNAME_SEPARATOR ':'
1208 #ifndef SLASH_STRING
1209 #define SLASH_STRING "/"
1214 # define GLOBAL_CURDIR
1217 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1218 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1219 in the code actually refer to a lightweight process id, i.e,
1220 something that can be considered a process id in its own right for
1221 certain purposes. */
1224 #define PIDGET(PTID) (ptid_get_pid (PTID))
1225 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1226 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1229 /* Define well known filenos if the system does not define them. */
1230 #ifndef STDIN_FILENO
1231 #define STDIN_FILENO 0
1233 #ifndef STDOUT_FILENO
1234 #define STDOUT_FILENO 1
1236 #ifndef STDERR_FILENO
1237 #define STDERR_FILENO 2
1240 /* If this definition isn't overridden by the header files, assume
1241 that isatty and fileno exist on this system. */
1243 #define ISATTY(FP) (isatty (fileno (FP)))
1246 #endif /* #ifndef DEFS_H */