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, 2003, 2004
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 /* NOTE: cagney/2003-11-23: All instances of STREQ[N] covered by
158 testing GDB on a stabs system have been replaced by equivalent
159 str[n]cmp calls. To avoid the possability of introducing bugs when
160 making untested changes, the remaining references were deprecated
161 rather than replaced. */
163 /* DISCLAIMER: cagney/2003-11-23: Simplified definition of these
164 macros so that they just map directly onto strcmp equivalent. I'm
165 not responsible for any breakage due to code that relied on the old
166 underlying implementation. */
168 #define DEPRECATED_STREQ(a,b) (strcmp ((a), (b)) == 0)
169 #define DEPRECATED_STREQN(a,b,c) (strncmp ((a), (b), (c)) == 0)
171 /* Check if a character is one of the commonly used C++ marker characters. */
172 extern int is_cplus_marker (int);
174 /* enable xdb commands if set */
175 extern int xdb_commands
;
177 /* enable dbx commands if set */
178 extern int dbx_commands
;
180 /* System root path, used to find libraries etc. */
181 extern char *gdb_sysroot
;
183 extern int quit_flag
;
184 extern int immediate_quit
;
185 extern int sevenbit_strings
;
187 extern void quit (void);
189 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
190 benefits of having a ``QUIT'' macro rather than a function are
191 marginal. If the overhead of a QUIT function call is proving
192 significant then its calling frequency should probably be reduced
193 [kingdon]. A profile analyzing the current situtation is
197 /* do twice to force compiler warning */
198 #define QUIT_FIXME "FIXME"
199 #define QUIT_FIXME "ignoring redefinition of QUIT"
202 if (quit_flag) quit (); \
203 if (interactive_hook) interactive_hook (); \
208 /* Languages represented in the symbol table and elsewhere.
209 This should probably be in language.h, but since enum's can't
210 be forward declared to satisfy opaque references before their
211 actual definition, needs to be here. */
215 language_unknown
, /* Language not known */
216 language_auto
, /* Placeholder for automatic setting */
218 language_cplus
, /* C++ */
219 language_objc
, /* Objective-C */
220 language_java
, /* Java */
221 language_fortran
, /* Fortran */
222 language_m2
, /* Modula-2 */
223 language_asm
, /* Assembly language */
224 language_scm
, /* Scheme / Guile */
225 language_pascal
, /* Pascal */
226 language_minimal
/* All other languages, minimal support only */
233 unspecified_precision
236 /* A generic, not quite boolean, enumeration. */
244 /* Potential ways that a function can return a value of a given type. */
245 enum return_value_convention
247 /* Where the return value has been squeezed into one or more
249 RETURN_VALUE_REGISTER_CONVENTION
,
250 /* Commonly known as the "struct return convention". The caller
251 passes an additional hidden first parameter to the caller. That
252 parameter contains the address at which the value being returned
253 should be stored. While typically, and historically, used for
254 large structs, this is convention is applied to values of many
256 RETURN_VALUE_STRUCT_CONVENTION
259 /* the cleanup list records things that have to be undone
260 if an error happens (descriptors to be closed, memory to be freed, etc.)
261 Each link in the chain records a function to call and an
264 Use make_cleanup to add an element to the cleanup chain.
265 Use do_cleanups to do all cleanup actions back to a given
266 point in the chain. Use discard_cleanups to remove cleanups
267 from the chain back to a given point, not doing them. */
271 struct cleanup
*next
;
272 void (*function
) (void *);
277 /* The ability to declare that a function never returns is useful, but
278 not really required to compile GDB successfully, so the NORETURN and
279 ATTR_NORETURN macros normally expand into nothing. */
281 /* If compiling with older versions of GCC, a function may be declared
282 "volatile" to indicate that it does not return. */
285 #if defined(__GNUC__) \
286 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
287 #define NORETURN volatile
289 #define NORETURN /* nothing */
293 /* GCC 2.5 and later versions define a function attribute "noreturn",
294 which is the preferred way to declare that a function never returns.
295 However GCC 2.7 appears to be the first version in which this fully
296 works everywhere we use it. */
298 #ifndef ATTR_NORETURN
299 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
300 #define ATTR_NORETURN __attribute__ ((noreturn))
302 #define ATTR_NORETURN /* nothing */
307 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
308 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
310 #define ATTR_FORMAT(type, x, y) /* nothing */
314 /* Be conservative and use enum bitfields only with GCC.
315 This is copied from gcc 3.3.1, system.h. */
317 #if defined(__GNUC__) && (__GNUC__ >= 2)
318 #define ENUM_BITFIELD(TYPE) enum TYPE
320 #define ENUM_BITFIELD(TYPE) unsigned int
323 /* Needed for various prototypes */
328 /* From blockframe.c */
330 extern int inside_entry_func (CORE_ADDR
);
332 extern int deprecated_inside_entry_file (CORE_ADDR addr
);
334 extern int inside_main_func (CORE_ADDR pc
);
338 extern void initialize_utils (void);
340 extern void notice_quit (void);
342 extern int strcmp_iw (const char *, const char *);
344 extern int strcmp_iw_ordered (const char *, const char *);
346 extern int streq (const char *, const char *);
348 extern int subset_compare (char *, char *);
350 extern char *safe_strerror (int);
352 extern void init_malloc (void *);
354 extern void request_quit (int);
356 extern void do_cleanups (struct cleanup
*);
357 extern void do_final_cleanups (struct cleanup
*);
358 extern void do_run_cleanups (struct cleanup
*);
359 extern void do_exec_cleanups (struct cleanup
*);
360 extern void do_exec_error_cleanups (struct cleanup
*);
362 extern void discard_cleanups (struct cleanup
*);
363 extern void discard_final_cleanups (struct cleanup
*);
364 extern void discard_exec_error_cleanups (struct cleanup
*);
365 extern void discard_my_cleanups (struct cleanup
**, struct cleanup
*);
367 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
368 make_cleanup function declarations below. Do not use this typedef
369 as a cast when passing functions into the make_cleanup() code.
370 Instead either use a bounce function or add a wrapper function.
371 Calling a f(char*) function with f(void*) is non-portable. */
372 typedef void (make_cleanup_ftype
) (void *);
374 extern struct cleanup
*make_cleanup (make_cleanup_ftype
*, void *);
376 extern struct cleanup
*make_cleanup_freeargv (char **);
379 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
381 extern struct cleanup
*make_cleanup_close (int fd
);
383 extern struct cleanup
*make_cleanup_bfd_close (bfd
*abfd
);
385 extern struct cleanup
*make_final_cleanup (make_cleanup_ftype
*, void *);
387 extern struct cleanup
*make_my_cleanup (struct cleanup
**,
388 make_cleanup_ftype
*, void *);
390 extern struct cleanup
*make_run_cleanup (make_cleanup_ftype
*, void *);
392 extern struct cleanup
*make_exec_cleanup (make_cleanup_ftype
*, void *);
393 extern struct cleanup
*make_exec_error_cleanup (make_cleanup_ftype
*, void *);
395 extern struct cleanup
*save_cleanups (void);
396 extern struct cleanup
*save_final_cleanups (void);
397 extern struct cleanup
*save_my_cleanups (struct cleanup
**);
399 extern void restore_cleanups (struct cleanup
*);
400 extern void restore_final_cleanups (struct cleanup
*);
401 extern void restore_my_cleanups (struct cleanup
**, struct cleanup
*);
403 extern void free_current_contents (void *);
405 extern void null_cleanup (void *);
407 extern int myread (int, char *, int);
409 extern int query (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
411 extern void init_page_info (void);
413 extern char *gdb_realpath (const char *);
414 extern char *xfullpath (const char *);
416 extern unsigned long gnu_debuglink_crc32 (unsigned long crc
,
417 unsigned char *buf
, size_t len
);
419 /* From demangle.c */
421 extern void set_demangling_style (char *);
426 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
427 extern use_struct_convention_fn generic_use_struct_convention
;
430 /* Annotation stuff. */
432 extern int annotation_level
; /* in stack.c */
434 extern void begin_line (void);
436 extern void wrap_here (char *);
438 extern void reinitialize_more_filter (void);
441 extern struct ui_file
*gdb_stdout
;
443 extern struct ui_file
*gdb_stdin
;
444 /* Serious error notifications */
445 extern struct ui_file
*gdb_stderr
;
446 /* Log/debug/trace messages that should bypass normal stdout/stderr
447 filtering. For moment, always call this stream using
448 *_unfiltered. In the very near future that restriction shall be
449 removed - either call shall be unfiltered. (cagney 1999-06-13). */
450 extern struct ui_file
*gdb_stdlog
;
451 /* Target output that should bypass normal stdout/stderr filtering.
452 For moment, always call this stream using *_unfiltered. In the
453 very near future that restriction shall be removed - either call
454 shall be unfiltered. (cagney 1999-07-02). */
455 extern struct ui_file
*gdb_stdtarg
;
456 extern struct ui_file
*gdb_stdtargerr
;
457 extern struct ui_file
*gdb_stdtargin
;
465 /* More generic printf like operations. Filtered versions may return
466 non-locally on error. */
468 extern void fputs_filtered (const char *, struct ui_file
*);
470 extern void fputs_unfiltered (const char *, struct ui_file
*);
472 extern int fputc_filtered (int c
, struct ui_file
*);
474 extern int fputc_unfiltered (int c
, struct ui_file
*);
476 extern int putchar_filtered (int c
);
478 extern int putchar_unfiltered (int c
);
480 extern void puts_filtered (const char *);
482 extern void puts_unfiltered (const char *);
484 extern void puts_filtered_tabular (char *string
, int width
, int right
);
486 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
488 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
490 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
492 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
494 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
496 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
498 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
500 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
502 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
504 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
506 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
508 extern void print_spaces (int, struct ui_file
*);
510 extern void print_spaces_filtered (int, struct ui_file
*);
512 extern char *n_spaces (int);
514 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
516 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
518 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
520 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
521 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
523 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
524 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
526 extern int strlen_paddr (void);
527 extern char *paddr (CORE_ADDR addr
);
528 extern char *paddr_nz (CORE_ADDR addr
);
529 extern char *paddr_u (CORE_ADDR addr
);
530 extern char *paddr_d (LONGEST addr
);
532 extern char *phex (ULONGEST l
, int sizeof_l
);
533 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
535 /* Like paddr() only print/scan raw CORE_ADDR. The output from
536 core_addr_to_string() can be passed direct to
537 string_to_core_addr(). */
538 extern const char *core_addr_to_string (const CORE_ADDR addr
);
539 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
540 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
542 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
545 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
547 extern void print_sys_errmsg (const char *, int);
549 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
550 "const char *" in unistd.h, so we can't declare the argument
553 extern char *re_comp (const char *);
557 extern void symbol_file_command (char *, int);
559 /* Remote targets may wish to use this as their load function. */
560 extern void generic_load (char *name
, int from_tty
);
562 /* Summarise a download */
563 extern void print_transfer_performance (struct ui_file
*stream
,
564 unsigned long data_count
,
565 unsigned long write_count
,
566 unsigned long time_count
);
570 typedef void initialize_file_ftype (void);
572 extern char *skip_quoted (char *);
574 extern char *gdb_readline (char *);
576 extern char *gdb_readline_wrapper (char *);
578 extern char *command_line_input (char *, int, char *);
580 extern void print_prompt (void);
582 extern int input_from_terminal_p (void);
584 extern int info_verbose
;
586 /* From printcmd.c */
588 extern void set_next_address (CORE_ADDR
);
590 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
593 extern int build_address_symbolic (CORE_ADDR addr
,
601 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
603 extern void print_address (CORE_ADDR
, struct ui_file
*);
607 extern int openp (const char *, int, const char *, int, int, char **);
609 extern int source_full_path_of (char *, char **);
611 extern void mod_path (char *, char **);
613 extern void add_path (char *, char **, int);
615 extern void directory_command (char *, int);
617 extern char *source_path
;
619 extern void init_source_path (void);
621 extern void init_last_source_visited (void);
623 extern char *symtab_to_filename (struct symtab
*);
627 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
628 bfd_signed_vma data_off
,
629 bfd_signed_vma bss_off
);
631 /* Take over the 'find_mapped_memory' vector from exec.c. */
632 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
638 /* Possible lvalue types. Like enum language, this should be in
639 value.h, but needs to be here for the same reason. */
645 /* In memory. Could be a saved register. */
649 /* In a gdb internal variable. */
651 /* Part of a gdb internal variable (structure field). */
652 lval_internalvar_component
,
653 /* In a register series in a frame not the current one, which may have been
654 partially saved or saved in different places (otherwise would be
655 lval_register or lval_memory). */
656 lval_reg_frame_relative
661 /* Control types for commands */
663 enum misc_command_type
671 enum command_control_type
681 /* Structure for saved commands lines
682 (for breakpoints, defined commands, etc). */
686 struct command_line
*next
;
688 enum command_control_type control_type
;
690 struct command_line
**body_list
;
693 extern struct command_line
*read_command_lines (char *, int);
695 extern void free_command_lines (struct command_line
**);
697 /* To continue the execution commands when running gdb asynchronously.
698 A continuation structure contains a pointer to a function to be called
699 to finish the command, once the target has stopped. Such mechanism is
700 used bt the finish and until commands, and in the remote protocol
701 when opening an extended-remote connection. */
703 struct continuation_arg
705 struct continuation_arg
*next
;
706 union continuation_data
{
715 void (*continuation_hook
) (struct continuation_arg
*);
716 struct continuation_arg
*arg_list
;
717 struct continuation
*next
;
721 extern struct continuation
*cmd_continuation
;
722 /* Used only by the step_1 function. */
723 extern struct continuation
*intermediate_continuation
;
726 extern void add_continuation (void (*)(struct continuation_arg
*),
727 struct continuation_arg
*);
728 extern void do_all_continuations (void);
729 extern void discard_all_continuations (void);
731 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
732 struct continuation_arg
*);
733 extern void do_all_intermediate_continuations (void);
734 extern void discard_all_intermediate_continuations (void);
736 /* String containing the current directory (what getwd would return). */
738 extern char *current_directory
;
740 /* Default radixes for input and output. Only some values supported. */
741 extern unsigned input_radix
;
742 extern unsigned output_radix
;
744 /* Possibilities for prettyprint parameters to routines which print
745 things. Like enum language, this should be in value.h, but needs
746 to be here for the same reason. FIXME: If we can eliminate this
747 as an arg to LA_VAL_PRINT, then we can probably move it back to
752 Val_no_prettyprint
= 0,
754 /* Use the default setting which the user has specified. */
758 /* The ptid struct is a collection of the various "ids" necessary
759 for identifying the inferior. This consists of the process id
760 (pid), thread id (tid), and other fields necessary for uniquely
761 identifying the inferior process/thread being debugged. When
762 manipulating ptids, the constructors, accessors, and predicate
763 declared in inferior.h should be used. These are as follows:
765 ptid_build - Make a new ptid from a pid, lwp, and tid.
766 pid_to_ptid - Make a new ptid from just a pid.
767 ptid_get_pid - Fetch the pid component of a ptid.
768 ptid_get_lwp - Fetch the lwp component of a ptid.
769 ptid_get_tid - Fetch the tid component of a ptid.
770 ptid_equal - Test to see if two ptids are equal.
772 Please do NOT access the struct ptid members directly (except, of
773 course, in the implementation of the above ptid manipulation
781 /* Lightweight process id */
788 typedef struct ptid ptid_t
;
792 /* Optional host machine definition. Pure autoconf targets will not
793 need a "xm.h" file. This will be a symlink to one of the xm-*.h
794 files, built by the `configure' script. */
800 /* Optional native machine support. Non-native (and possibly pure
801 multi-arch) targets do not need a "nm.h" file. This will be a
802 symlink to one of the nm-*.h files, built by the `configure'
809 /* Optional target machine definition. Pure multi-arch configurations
810 do not need a "tm.h" file. This will be a symlink to one of the
811 tm-*.h files, built by the `configure' script. */
817 /* If the xm.h file did not define the mode string used to open the
818 files, assume that binary files are opened the same way as text
821 #include "fopen-same.h"
824 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
825 FIXME: Assumes 2's complement arithmetic */
827 #if !defined (UINT_MAX)
828 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
831 #if !defined (INT_MAX)
832 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
835 #if !defined (INT_MIN)
836 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
839 #if !defined (ULONG_MAX)
840 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
843 #if !defined (LONG_MAX)
844 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
847 #if !defined (ULONGEST_MAX)
848 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
851 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
852 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
855 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
856 arguments to a function, number in a value history, register number, etc.)
857 where the value must not be larger than can fit in an int. */
859 extern int longest_to_int (LONGEST
);
861 /* Assorted functions we can declare, now that const and volatile are
864 extern char *savestring (const char *, size_t);
866 extern char *msavestring (void *, const char *, size_t);
868 extern char *mstrsave (void *, const char *);
870 /* Robust versions of same. Throw an internal error when no memory,
871 guard against stray NULL arguments. */
872 extern void *xmmalloc (void *md
, size_t size
);
873 extern void *xmrealloc (void *md
, void *ptr
, size_t size
);
874 extern void *xmcalloc (void *md
, size_t number
, size_t size
);
875 extern void xmfree (void *md
, void *ptr
);
877 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
879 extern void xfree (void *);
881 /* Utility macros to allocate typed memory. Avoids errors like:
882 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
883 sizeof (struct foo), 0). */
884 #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE)))
885 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
886 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
888 /* Like asprintf/vasprintf but get an internal_error if the call
890 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
891 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
893 /* Like asprintf, but return the string, throw an error if no memory. */
894 extern char *xstrprintf (const char *format
, ...) ATTR_FORMAT (printf
, 1, 2);
896 extern int parse_escape (char **);
898 /* Message to be printed before the error message, when an error occurs. */
900 extern char *error_pre_print
;
902 /* Message to be printed before the error message, when an error occurs. */
904 extern char *quit_pre_print
;
906 /* Message to be printed before the warning message, when a warning occurs. */
908 extern char *warning_pre_print
;
910 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
912 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
914 extern NORETURN
void error_silent (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
916 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
918 /* Initialize the error buffer. */
919 extern void error_init (void);
921 /* Returns a freshly allocate buffer containing the last error
923 extern char *error_last_message (void);
925 /* Output arbitrary error message. */
926 extern void error_output_message (char *pre_print
, char *msg
);
928 extern NORETURN
void internal_verror (const char *file
, int line
,
929 const char *, va_list ap
) ATTR_NORETURN
;
931 extern NORETURN
void internal_error (const char *file
, int line
,
932 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
934 extern void internal_vwarning (const char *file
, int line
,
935 const char *, va_list ap
);
937 extern void internal_warning (const char *file
, int line
,
938 const char *, ...) ATTR_FORMAT (printf
, 3, 4);
940 extern NORETURN
void nomem (long) ATTR_NORETURN
;
942 /* Reasons for calling throw_exception(). NOTE: all reason values
943 must be less than zero. enum value 0 is reserved for internal use
944 as the return value from an initial setjmp(). The function
945 catch_exceptions() reserves values >= 0 as legal results from its
950 /* User interrupt. */
952 /* Any other error. */
956 #define ALL_CLEANUPS ((struct cleanup *)0)
958 #define RETURN_MASK(reason) (1 << (int)(-reason))
959 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
960 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
961 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
962 typedef int return_mask
;
964 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
965 to the inner most containing exception handler established using
966 catch_exceptions() (or the legacy catch_errors()).
968 Code normally throws an exception using error() et.al. For various
969 reaons, GDB also contains code that throws an exception directly.
970 For instance, the remote*.c targets contain CNTRL-C signal handlers
971 that propogate the QUIT event up the exception chain. ``This could
972 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
974 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
976 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
977 handler. If an exception (enum return_reason) is thrown using
978 throw_exception() than all cleanups installed since
979 catch_exceptions() was entered are invoked, the (-ve) exception
980 value is then returned by catch_exceptions. If FUNC() returns
981 normally (with a postive or zero return value) then that value is
982 returned by catch_exceptions(). It is an internal_error() for
983 FUNC() to return a negative value.
985 For the period of the FUNC() call: UIOUT is installed as the output
986 builder; ERRSTRING is installed as the error/quit message; and a
987 new cleanup_chain is established. The old values are restored
988 before catch_exceptions() returns.
990 The variant catch_exceptions_with_msg() is the same as
991 catch_exceptions() but adds the ability to return an allocated
992 copy of the gdb error message. This is used when a silent error is
993 issued and the caller wants to manually issue the error message.
995 FIXME; cagney/2001-08-13: The need to override the global UIOUT
996 builder variable should just go away.
998 This function superseeds catch_errors().
1000 This function uses SETJMP() and LONGJUMP(). */
1003 typedef int (catch_exceptions_ftype
) (struct ui_out
*ui_out
, void *args
);
1004 extern int catch_exceptions (struct ui_out
*uiout
,
1005 catch_exceptions_ftype
*func
, void *func_args
,
1006 char *errstring
, return_mask mask
);
1007 extern int catch_exceptions_with_msg (struct ui_out
*uiout
,
1008 catch_exceptions_ftype
*func
,
1010 char *errstring
, char **gdberrmsg
,
1013 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
1014 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
1015 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
1016 value. It's unfortunate that, catch_errors() does not return an
1017 indication of the exact exception that it caught - quit_flag might
1020 This function is superseeded by catch_exceptions(). */
1022 typedef int (catch_errors_ftype
) (void *);
1023 extern int catch_errors (catch_errors_ftype
*, void *, char *, return_mask
);
1025 /* Template to catch_errors() that wraps calls to command
1028 typedef void (catch_command_errors_ftype
) (char *, int);
1029 extern int catch_command_errors (catch_command_errors_ftype
*func
, char *command
, int from_tty
, return_mask
);
1031 extern void warning (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
1033 extern void vwarning (const char *, va_list args
);
1035 /* List of known OS ABIs. If you change this, make sure to update the
1036 table in osabi.c. */
1039 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
1041 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
1048 GDB_OSABI_FREEBSD_AOUT
,
1049 GDB_OSABI_FREEBSD_ELF
,
1050 GDB_OSABI_NETBSD_AOUT
,
1051 GDB_OSABI_NETBSD_ELF
,
1052 GDB_OSABI_OPENBSD_ELF
,
1062 GDB_OSABI_ARM_EABI_V1
,
1063 GDB_OSABI_ARM_EABI_V2
,
1069 GDB_OSABI_INVALID
/* keep this last */
1072 /* Global functions from other, non-gdb GNU thingies.
1073 Libiberty thingies are no longer declared here. We include libiberty.h
1076 #ifndef GETENV_PROVIDED
1077 extern char *getenv (const char *);
1080 /* From other system libraries */
1082 #ifdef HAVE_STDDEF_H
1086 #ifdef HAVE_STDLIB_H
1090 #define min(a, b) ((a) < (b) ? (a) : (b))
1093 #define max(a, b) ((a) > (b) ? (a) : (b))
1097 /* We take the address of fclose later, but some stdio's forget
1098 to declare this. We can't always declare it since there's
1099 no way to declare the parameters without upsetting some compiler
1102 #ifndef FCLOSE_PROVIDED
1103 extern int fclose (FILE *);
1107 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1110 /* Various possibilities for alloca. */
1113 #define alloca __builtin_alloca
1114 #else /* Not GNU C */
1115 #ifdef HAVE_ALLOCA_H
1122 /* We need to be careful not to declare this in a way which conflicts with
1123 bison. Bison never declares it as char *, but under various circumstances
1124 (like __hpux) we need to use void *. */
1125 extern void *alloca ();
1126 #endif /* Not _AIX */
1127 #endif /* Not HAVE_ALLOCA_H */
1128 #endif /* Not GNU C */
1129 #endif /* alloca not defined */
1131 /* Is GDB multi-arch? If there's a "tm.h" file, it is not. */
1132 #ifndef GDB_MULTI_ARCH
1134 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PARTIAL
1136 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PURE
1140 /* Dynamic target-system-dependent parameters for GDB. */
1141 #include "gdbarch.h"
1143 /* Maximum size of a register. Something small, but large enough for
1144 all known ISAs. If it turns out to be too small, make it bigger. */
1146 enum { MAX_REGISTER_SIZE
= 16 };
1148 /* Static target-system-dependent parameters for GDB. */
1150 /* Number of bits in a char or unsigned char for the target machine.
1151 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1152 #if !defined (TARGET_CHAR_BIT)
1153 #define TARGET_CHAR_BIT 8
1156 /* If we picked up a copy of CHAR_BIT from a configuration file
1157 (which may get it by including <limits.h>) then use it to set
1158 the number of bits in a host char. If not, use the same size
1161 #if defined (CHAR_BIT)
1162 #define HOST_CHAR_BIT CHAR_BIT
1164 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1167 /* The bit byte-order has to do just with numbering of bits in
1168 debugging symbols and such. Conceptually, it's quite separate
1169 from byte/word byte order. */
1171 #if !defined (BITS_BIG_ENDIAN)
1172 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1177 extern LONGEST
extract_signed_integer (const void *, int);
1179 extern ULONGEST
extract_unsigned_integer (const void *, int);
1181 extern int extract_long_unsigned_integer (const void *, int, LONGEST
*);
1183 extern CORE_ADDR
extract_typed_address (const void *buf
, struct type
*type
);
1185 extern void store_signed_integer (void *, int, LONGEST
);
1187 extern void store_unsigned_integer (void *, int, ULONGEST
);
1189 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1194 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1196 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1198 extern int watchdog
;
1200 /* Hooks for alternate command interfaces. */
1202 /* The name of the interpreter if specified on the command line. */
1203 extern char *interpreter_p
;
1205 /* If a given interpreter matches INTERPRETER_P then it should update
1206 command_loop_hook and init_ui_hook with the per-interpreter
1208 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1210 struct target_waitstatus
;
1211 struct cmd_list_element
;
1213 /* Should the asynchronous variant of the interpreter (using the
1214 event-loop) be enabled? */
1215 extern int event_loop_p
;
1217 extern void (*init_ui_hook
) (char *argv0
);
1218 extern void (*command_loop_hook
) (void);
1219 extern void (*show_load_progress
) (const char *section
,
1220 unsigned long section_sent
,
1221 unsigned long section_size
,
1222 unsigned long total_sent
,
1223 unsigned long total_size
);
1224 extern void (*print_frame_info_listing_hook
) (struct symtab
* s
,
1225 int line
, int stopline
,
1227 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1228 extern int (*query_hook
) (const char *, va_list);
1229 extern void (*warning_hook
) (const char *, va_list);
1230 extern void (*flush_hook
) (struct ui_file
* stream
);
1231 extern void (*create_breakpoint_hook
) (struct breakpoint
* b
);
1232 extern void (*delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1233 extern void (*modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1234 extern void (*interactive_hook
) (void);
1235 extern void (*registers_changed_hook
) (void);
1236 extern void (*readline_begin_hook
) (char *,...);
1237 extern char *(*readline_hook
) (char *);
1238 extern void (*readline_end_hook
) (void);
1239 extern void (*register_changed_hook
) (int regno
);
1240 extern void (*memory_changed_hook
) (CORE_ADDR addr
, int len
);
1241 extern void (*context_hook
) (int);
1242 extern ptid_t (*target_wait_hook
) (ptid_t ptid
,
1243 struct target_waitstatus
* status
);
1245 extern void (*attach_hook
) (void);
1246 extern void (*detach_hook
) (void);
1247 extern void (*call_command_hook
) (struct cmd_list_element
* c
,
1248 char *cmd
, int from_tty
);
1250 extern void (*set_hook
) (struct cmd_list_element
* c
);
1252 extern NORETURN
void (*error_hook
) (void) ATTR_NORETURN
;
1254 extern void (*error_begin_hook
) (void);
1256 extern int (*ui_load_progress_hook
) (const char *section
, unsigned long num
);
1259 /* Inhibit window interface if non-zero. */
1261 extern int use_windows
;
1263 /* Symbolic definitions of filename-related things. */
1264 /* FIXME, this doesn't work very well if host and executable
1265 filesystems conventions are different. */
1267 #ifndef DIRNAME_SEPARATOR
1268 #define DIRNAME_SEPARATOR ':'
1271 #ifndef SLASH_STRING
1272 #define SLASH_STRING "/"
1277 # define GLOBAL_CURDIR
1280 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1281 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1282 in the code actually refer to a lightweight process id, i.e,
1283 something that can be considered a process id in its own right for
1284 certain purposes. */
1287 #define PIDGET(PTID) (ptid_get_pid (PTID))
1288 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1289 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1292 /* Define well known filenos if the system does not define them. */
1293 #ifndef STDIN_FILENO
1294 #define STDIN_FILENO 0
1296 #ifndef STDOUT_FILENO
1297 #define STDOUT_FILENO 1
1299 #ifndef STDERR_FILENO
1300 #define STDERR_FILENO 2
1303 /* If this definition isn't overridden by the header files, assume
1304 that isatty and fileno exist on this system. */
1306 #define ISATTY(FP) (isatty (fileno (FP)))
1309 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1310 power of 2). Round up/down when necessary. Examples of correct
1313 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1314 write_memory (addr, value, len);
1319 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1320 write_memory (sp, value, len);
1322 Note that uses such as:
1324 write_memory (addr, value, len);
1325 addr += align_up (len, 8);
1329 sp -= align_up (len, 8);
1330 write_memory (sp, value, len);
1332 are typically not correct as they don't ensure that the address (SP
1333 or ADDR) is correctly aligned (relying on previous alignment to
1334 keep things right). This is also why the methods are called
1335 "align_..." instead of "round_..." as the latter reads better with
1336 this incorrect coding style. */
1338 extern ULONGEST
align_up (ULONGEST v
, int n
);
1339 extern ULONGEST
align_down (ULONGEST v
, int n
);
1341 #endif /* #ifndef DEFS_H */