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"
66 /* For BFD64 and bfd_vma. */
70 /* The target is partially multi-arched. Both "tm.h" and the
71 multi-arch vector provide definitions. "tm.h" normally overrides
72 the multi-arch vector (but there are a few exceptions). */
74 #define GDB_MULTI_ARCH_PARTIAL 1
76 /* The target is partially multi-arched. Both the multi-arch vector
77 and "tm.h" provide definitions. "tm.h" cannot override a definition
78 provided by the multi-arch vector. It is detected as a compilation
81 This setting is only useful during a multi-arch conversion. */
83 #define GDB_MULTI_ARCH_TM 2
85 /* The target is pure multi-arch. The MULTI-ARCH vector provides all
86 definitions. "tm.h" is linked to an empty file. */
88 #define GDB_MULTI_ARCH_PURE 3
92 /* An address in the program being debugged. Host byte order. Rather
93 than duplicate all the logic in BFD which figures out what type
94 this is (long, long long, etc.) and whether it needs to be 64
95 bits (the host/target interactions are subtle), we just use
98 typedef bfd_vma CORE_ADDR
;
100 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
106 #define LONGEST BFD_HOST_64_BIT
107 #define ULONGEST BFD_HOST_U_64_BIT
111 #ifdef CC_HAS_LONG_LONG
112 #define LONGEST long long
113 #define ULONGEST unsigned long long
115 #ifdef BFD_HOST_64_BIT
116 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
117 (e.g. i386-windows) so try it. */
118 #define LONGEST BFD_HOST_64_BIT
119 #define ULONGEST BFD_HOST_U_64_BIT
122 #define ULONGEST unsigned long
126 #endif /* No BFD64 */
128 #endif /* ! LONGEST */
131 #define min(a, b) ((a) < (b) ? (a) : (b))
134 #define max(a, b) ((a) > (b) ? (a) : (b))
137 /* Macros to do string compares.
139 NOTE: cagney/2000-03-14:
141 While old code can continue to refer to these macros, new code is
142 probably better off using strcmp() directly vis: ``strcmp() == 0''
143 and ``strcmp() != 0''.
145 This is because modern compilers can directly inline strcmp()
146 making the original justification for these macros - avoid function
147 call overhead by pre-testing the first characters
148 (``*X==*Y?...:0'') - redundant.
150 ``Even if [...] testing the first character does have a modest
151 performance improvement, I'd rather that whenever a performance
152 issue is found that we spend the effort on algorithmic
153 optimizations than micro-optimizing.'' J.T. */
155 /* NOTE: cagney/2003-11-23: All instances of STREQ[N] covered by
156 testing GDB on a stabs system have been replaced by equivalent
157 str[n]cmp calls. To avoid the possability of introducing bugs when
158 making untested changes, the remaining references were deprecated
159 rather than replaced. */
161 /* DISCLAIMER: cagney/2003-11-23: Simplified definition of these
162 macros so that they just map directly onto strcmp equivalent. I'm
163 not responsible for any breakage due to code that relied on the old
164 underlying implementation. */
166 #define DEPRECATED_STREQ(a,b) (strcmp ((a), (b)) == 0)
167 #define DEPRECATED_STREQN(a,b,c) (strncmp ((a), (b), (c)) == 0)
169 /* Check if a character is one of the commonly used C++ marker characters. */
170 extern int is_cplus_marker (int);
172 /* enable xdb commands if set */
173 extern int xdb_commands
;
175 /* enable dbx commands if set */
176 extern int dbx_commands
;
178 /* System root path, used to find libraries etc. */
179 extern char *gdb_sysroot
;
181 extern int quit_flag
;
182 extern int immediate_quit
;
183 extern int sevenbit_strings
;
185 extern void quit (void);
187 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
188 benefits of having a ``QUIT'' macro rather than a function are
189 marginal. If the overhead of a QUIT function call is proving
190 significant then its calling frequency should probably be reduced
191 [kingdon]. A profile analyzing the current situtation is
195 /* do twice to force compiler warning */
196 #define QUIT_FIXME "FIXME"
197 #define QUIT_FIXME "ignoring redefinition of QUIT"
200 if (quit_flag) quit (); \
201 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
205 /* Languages represented in the symbol table and elsewhere.
206 This should probably be in language.h, but since enum's can't
207 be forward declared to satisfy opaque references before their
208 actual definition, needs to be here. */
212 language_unknown
, /* Language not known */
213 language_auto
, /* Placeholder for automatic setting */
215 language_cplus
, /* C++ */
216 language_objc
, /* Objective-C */
217 language_java
, /* Java */
218 language_fortran
, /* Fortran */
219 language_m2
, /* Modula-2 */
220 language_asm
, /* Assembly language */
221 language_scm
, /* Scheme / Guile */
222 language_pascal
, /* Pascal */
223 language_minimal
/* All other languages, minimal support only */
230 unspecified_precision
233 /* A generic, not quite boolean, enumeration. */
241 /* Potential ways that a function can return a value of a given type. */
242 enum return_value_convention
244 /* Where the return value has been squeezed into one or more
246 RETURN_VALUE_REGISTER_CONVENTION
,
247 /* Commonly known as the "struct return convention". The caller
248 passes an additional hidden first parameter to the caller. That
249 parameter contains the address at which the value being returned
250 should be stored. While typically, and historically, used for
251 large structs, this is convention is applied to values of many
253 RETURN_VALUE_STRUCT_CONVENTION
256 /* the cleanup list records things that have to be undone
257 if an error happens (descriptors to be closed, memory to be freed, etc.)
258 Each link in the chain records a function to call and an
261 Use make_cleanup to add an element to the cleanup chain.
262 Use do_cleanups to do all cleanup actions back to a given
263 point in the chain. Use discard_cleanups to remove cleanups
264 from the chain back to a given point, not doing them. */
268 struct cleanup
*next
;
269 void (*function
) (void *);
274 /* The ability to declare that a function never returns is useful, but
275 not really required to compile GDB successfully, so the NORETURN and
276 ATTR_NORETURN macros normally expand into nothing. */
278 /* If compiling with older versions of GCC, a function may be declared
279 "volatile" to indicate that it does not return. */
282 #if defined(__GNUC__) \
283 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
284 #define NORETURN volatile
286 #define NORETURN /* nothing */
290 /* GCC 2.5 and later versions define a function attribute "noreturn",
291 which is the preferred way to declare that a function never returns.
292 However GCC 2.7 appears to be the first version in which this fully
293 works everywhere we use it. */
295 #ifndef ATTR_NORETURN
296 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
297 #define ATTR_NORETURN __attribute__ ((noreturn))
299 #define ATTR_NORETURN /* nothing */
304 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
305 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
307 #define ATTR_FORMAT(type, x, y) /* nothing */
311 /* Be conservative and use enum bitfields only with GCC.
312 This is copied from gcc 3.3.1, system.h. */
314 #if defined(__GNUC__) && (__GNUC__ >= 2)
315 #define ENUM_BITFIELD(TYPE) enum TYPE
317 #define ENUM_BITFIELD(TYPE) unsigned int
320 /* Needed for various prototypes */
326 /* From blockframe.c */
328 extern int inside_entry_func (struct frame_info
*this_frame
);
330 extern int inside_main_func (CORE_ADDR pc
);
334 extern void initialize_utils (void);
336 extern void notice_quit (void);
338 extern int strcmp_iw (const char *, const char *);
340 extern int strcmp_iw_ordered (const char *, const char *);
342 extern int streq (const char *, const char *);
344 extern int subset_compare (char *, char *);
346 extern char *safe_strerror (int);
348 extern void init_malloc (void *);
350 extern void request_quit (int);
352 extern void do_cleanups (struct cleanup
*);
353 extern void do_final_cleanups (struct cleanup
*);
354 extern void do_run_cleanups (struct cleanup
*);
355 extern void do_exec_cleanups (struct cleanup
*);
356 extern void do_exec_error_cleanups (struct cleanup
*);
358 extern void discard_cleanups (struct cleanup
*);
359 extern void discard_final_cleanups (struct cleanup
*);
360 extern void discard_exec_error_cleanups (struct cleanup
*);
361 extern void discard_my_cleanups (struct cleanup
**, struct cleanup
*);
363 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
364 make_cleanup function declarations below. Do not use this typedef
365 as a cast when passing functions into the make_cleanup() code.
366 Instead either use a bounce function or add a wrapper function.
367 Calling a f(char*) function with f(void*) is non-portable. */
368 typedef void (make_cleanup_ftype
) (void *);
370 extern struct cleanup
*make_cleanup (make_cleanup_ftype
*, void *);
372 extern struct cleanup
*make_cleanup_freeargv (char **);
375 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
377 extern struct cleanup
*make_cleanup_close (int fd
);
379 extern struct cleanup
*make_cleanup_bfd_close (bfd
*abfd
);
381 extern struct cleanup
*make_final_cleanup (make_cleanup_ftype
*, void *);
383 extern struct cleanup
*make_my_cleanup (struct cleanup
**,
384 make_cleanup_ftype
*, void *);
386 extern struct cleanup
*make_run_cleanup (make_cleanup_ftype
*, void *);
388 extern struct cleanup
*make_exec_cleanup (make_cleanup_ftype
*, void *);
389 extern struct cleanup
*make_exec_error_cleanup (make_cleanup_ftype
*, void *);
391 extern struct cleanup
*save_cleanups (void);
392 extern struct cleanup
*save_final_cleanups (void);
393 extern struct cleanup
*save_my_cleanups (struct cleanup
**);
395 extern void restore_cleanups (struct cleanup
*);
396 extern void restore_final_cleanups (struct cleanup
*);
397 extern void restore_my_cleanups (struct cleanup
**, struct cleanup
*);
399 extern void free_current_contents (void *);
401 extern void null_cleanup (void *);
403 extern int myread (int, char *, int);
405 extern int query (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
406 extern int nquery (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
407 extern int yquery (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
409 extern void init_page_info (void);
411 extern char *gdb_realpath (const char *);
412 extern char *xfullpath (const char *);
414 extern unsigned long gnu_debuglink_crc32 (unsigned long crc
,
415 unsigned char *buf
, size_t len
);
417 /* From demangle.c */
419 extern void set_demangling_style (char *);
424 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
425 extern use_struct_convention_fn generic_use_struct_convention
;
428 /* Annotation stuff. */
430 extern int annotation_level
; /* in stack.c */
432 extern void begin_line (void);
434 extern void wrap_here (char *);
436 extern void reinitialize_more_filter (void);
439 extern struct ui_file
*gdb_stdout
;
441 extern struct ui_file
*gdb_stdin
;
442 /* Serious error notifications */
443 extern struct ui_file
*gdb_stderr
;
444 /* Log/debug/trace messages that should bypass normal stdout/stderr
445 filtering. For moment, always call this stream using
446 *_unfiltered. In the very near future that restriction shall be
447 removed - either call shall be unfiltered. (cagney 1999-06-13). */
448 extern struct ui_file
*gdb_stdlog
;
449 /* Target output that should bypass normal stdout/stderr filtering.
450 For moment, always call this stream using *_unfiltered. In the
451 very near future that restriction shall be removed - either call
452 shall be unfiltered. (cagney 1999-07-02). */
453 extern struct ui_file
*gdb_stdtarg
;
454 extern struct ui_file
*gdb_stdtargerr
;
455 extern struct ui_file
*gdb_stdtargin
;
459 /* More generic printf like operations. Filtered versions may return
460 non-locally on error. */
462 extern void fputs_filtered (const char *, struct ui_file
*);
464 extern void fputs_unfiltered (const char *, struct ui_file
*);
466 extern int fputc_filtered (int c
, struct ui_file
*);
468 extern int fputc_unfiltered (int c
, struct ui_file
*);
470 extern int putchar_filtered (int c
);
472 extern int putchar_unfiltered (int c
);
474 extern void puts_filtered (const char *);
476 extern void puts_unfiltered (const char *);
478 extern void puts_filtered_tabular (char *string
, int width
, int right
);
480 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
482 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
484 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
486 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
488 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
490 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
492 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
494 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
496 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
498 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
500 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
502 extern void print_spaces (int, struct ui_file
*);
504 extern void print_spaces_filtered (int, struct ui_file
*);
506 extern char *n_spaces (int);
508 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
510 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
512 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
514 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
515 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
517 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
518 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
520 extern int strlen_paddr (void);
521 extern char *paddr (CORE_ADDR addr
);
522 extern char *paddr_nz (CORE_ADDR addr
);
523 extern char *paddr_u (CORE_ADDR addr
);
524 extern char *paddr_d (LONGEST addr
);
526 extern char *phex (ULONGEST l
, int sizeof_l
);
527 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
529 /* Like paddr() only print/scan raw CORE_ADDR. The output from
530 core_addr_to_string() can be passed direct to
531 string_to_core_addr(). */
532 extern const char *core_addr_to_string (const CORE_ADDR addr
);
533 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
534 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
536 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
539 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
541 extern void print_sys_errmsg (const char *, int);
543 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
544 "const char *" in unistd.h, so we can't declare the argument
547 extern char *re_comp (const char *);
551 extern void symbol_file_command (char *, int);
553 /* Remote targets may wish to use this as their load function. */
554 extern void generic_load (char *name
, int from_tty
);
556 /* Summarise a download */
557 extern void print_transfer_performance (struct ui_file
*stream
,
558 unsigned long data_count
,
559 unsigned long write_count
,
560 unsigned long time_count
);
564 typedef void initialize_file_ftype (void);
566 extern char *skip_quoted (char *);
568 extern char *gdb_readline (char *);
570 extern char *gdb_readline_wrapper (char *);
572 extern char *command_line_input (char *, int, char *);
574 extern void print_prompt (void);
576 extern int input_from_terminal_p (void);
578 extern int info_verbose
;
580 /* From printcmd.c */
582 extern void set_next_address (CORE_ADDR
);
584 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
587 extern int build_address_symbolic (CORE_ADDR addr
,
595 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
597 extern void print_address (CORE_ADDR
, struct ui_file
*);
601 extern int openp (const char *, int, const char *, int, int, char **);
603 extern int source_full_path_of (char *, char **);
605 extern void mod_path (char *, char **);
607 extern void add_path (char *, char **, int);
609 extern void directory_command (char *, int);
611 extern char *source_path
;
613 extern void init_source_path (void);
615 extern void init_last_source_visited (void);
617 extern char *symtab_to_filename (struct symtab
*);
621 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
622 bfd_signed_vma data_off
,
623 bfd_signed_vma bss_off
);
625 /* Take over the 'find_mapped_memory' vector from exec.c. */
626 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
632 /* Possible lvalue types. Like enum language, this should be in
633 value.h, but needs to be here for the same reason. */
639 /* In memory. Could be a saved register. */
643 /* In a gdb internal variable. */
645 /* Part of a gdb internal variable (structure field). */
646 lval_internalvar_component
,
647 /* In a register series in a frame not the current one, which may have been
648 partially saved or saved in different places (otherwise would be
649 lval_register or lval_memory). */
650 lval_reg_frame_relative
653 /* Control types for commands */
655 enum misc_command_type
663 enum command_control_type
673 /* Structure for saved commands lines
674 (for breakpoints, defined commands, etc). */
678 struct command_line
*next
;
680 enum command_control_type control_type
;
682 struct command_line
**body_list
;
685 extern struct command_line
*read_command_lines (char *, int);
687 extern void free_command_lines (struct command_line
**);
689 /* To continue the execution commands when running gdb asynchronously.
690 A continuation structure contains a pointer to a function to be called
691 to finish the command, once the target has stopped. Such mechanism is
692 used bt the finish and until commands, and in the remote protocol
693 when opening an extended-remote connection. */
695 struct continuation_arg
697 struct continuation_arg
*next
;
698 union continuation_data
{
707 void (*continuation_hook
) (struct continuation_arg
*);
708 struct continuation_arg
*arg_list
;
709 struct continuation
*next
;
713 extern struct continuation
*cmd_continuation
;
714 /* Used only by the step_1 function. */
715 extern struct continuation
*intermediate_continuation
;
718 extern void add_continuation (void (*)(struct continuation_arg
*),
719 struct continuation_arg
*);
720 extern void do_all_continuations (void);
721 extern void discard_all_continuations (void);
723 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
724 struct continuation_arg
*);
725 extern void do_all_intermediate_continuations (void);
726 extern void discard_all_intermediate_continuations (void);
728 /* String containing the current directory (what getwd would return). */
730 extern char *current_directory
;
732 /* Default radixes for input and output. Only some values supported. */
733 extern unsigned input_radix
;
734 extern unsigned output_radix
;
736 /* Possibilities for prettyprint parameters to routines which print
737 things. Like enum language, this should be in value.h, but needs
738 to be here for the same reason. FIXME: If we can eliminate this
739 as an arg to LA_VAL_PRINT, then we can probably move it back to
744 Val_no_prettyprint
= 0,
746 /* Use the default setting which the user has specified. */
750 /* The ptid struct is a collection of the various "ids" necessary
751 for identifying the inferior. This consists of the process id
752 (pid), thread id (tid), and other fields necessary for uniquely
753 identifying the inferior process/thread being debugged. When
754 manipulating ptids, the constructors, accessors, and predicate
755 declared in inferior.h should be used. These are as follows:
757 ptid_build - Make a new ptid from a pid, lwp, and tid.
758 pid_to_ptid - Make a new ptid from just a pid.
759 ptid_get_pid - Fetch the pid component of a ptid.
760 ptid_get_lwp - Fetch the lwp component of a ptid.
761 ptid_get_tid - Fetch the tid component of a ptid.
762 ptid_equal - Test to see if two ptids are equal.
764 Please do NOT access the struct ptid members directly (except, of
765 course, in the implementation of the above ptid manipulation
773 /* Lightweight process id */
780 typedef struct ptid ptid_t
;
784 /* Optional host machine definition. Pure autoconf targets will not
785 need a "xm.h" file. This will be a symlink to one of the xm-*.h
786 files, built by the `configure' script. */
792 /* Optional native machine support. Non-native (and possibly pure
793 multi-arch) targets do not need a "nm.h" file. This will be a
794 symlink to one of the nm-*.h files, built by the `configure'
801 /* Optional target machine definition. Pure multi-arch configurations
802 do not need a "tm.h" file. This will be a symlink to one of the
803 tm-*.h files, built by the `configure' script. */
809 /* If the xm.h file did not define the mode string used to open the
810 files, assume that binary files are opened the same way as text
813 #include "fopen-same.h"
816 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
817 FIXME: Assumes 2's complement arithmetic */
819 #if !defined (UINT_MAX)
820 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
823 #if !defined (INT_MAX)
824 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
827 #if !defined (INT_MIN)
828 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
831 #if !defined (ULONG_MAX)
832 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
835 #if !defined (LONG_MAX)
836 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
839 #if !defined (ULONGEST_MAX)
840 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
843 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
844 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
847 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
848 arguments to a function, number in a value history, register number, etc.)
849 where the value must not be larger than can fit in an int. */
851 extern int longest_to_int (LONGEST
);
853 /* Assorted functions we can declare, now that const and volatile are
856 extern char *savestring (const char *, size_t);
858 extern char *msavestring (void *, const char *, size_t);
860 extern char *mstrsave (void *, const char *);
862 /* Robust versions of same. Throw an internal error when no memory,
863 guard against stray NULL arguments. */
864 extern void *xmmalloc (void *md
, size_t size
);
865 extern void *xmrealloc (void *md
, void *ptr
, size_t size
);
866 extern void *xmcalloc (void *md
, size_t number
, size_t size
);
867 extern void xmfree (void *md
, void *ptr
);
869 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
871 extern void xfree (void *);
873 /* Utility macros to allocate typed memory. Avoids errors like:
874 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
875 sizeof (struct foo), 0). */
876 #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE)))
877 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
878 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
880 /* Like asprintf/vasprintf but get an internal_error if the call
882 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
883 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
885 /* Like asprintf, but return the string, throw an error if no memory. */
886 extern char *xstrprintf (const char *format
, ...) ATTR_FORMAT (printf
, 1, 2);
888 extern int parse_escape (char **);
890 /* Message to be printed before the error message, when an error occurs. */
892 extern char *error_pre_print
;
894 /* Message to be printed before the error message, when an error occurs. */
896 extern char *quit_pre_print
;
898 /* Message to be printed before the warning message, when a warning occurs. */
900 extern char *warning_pre_print
;
902 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
904 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
906 extern NORETURN
void error_silent (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
908 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
910 /* Initialize the error buffer. */
911 extern void error_init (void);
913 /* Returns a freshly allocate buffer containing the last error
915 extern char *error_last_message (void);
917 /* Output arbitrary error message. */
918 extern void error_output_message (char *pre_print
, char *msg
);
920 extern NORETURN
void internal_verror (const char *file
, int line
,
921 const char *, va_list ap
) ATTR_NORETURN
;
923 extern NORETURN
void internal_error (const char *file
, int line
,
924 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
926 extern void internal_vwarning (const char *file
, int line
,
927 const char *, va_list ap
);
929 extern void internal_warning (const char *file
, int line
,
930 const char *, ...) ATTR_FORMAT (printf
, 3, 4);
932 extern NORETURN
void nomem (long) ATTR_NORETURN
;
934 /* Reasons for calling throw_exception(). NOTE: all reason values
935 must be less than zero. enum value 0 is reserved for internal use
936 as the return value from an initial setjmp(). The function
937 catch_exceptions() reserves values >= 0 as legal results from its
942 /* User interrupt. */
944 /* Any other error. */
948 #define ALL_CLEANUPS ((struct cleanup *)0)
950 #define RETURN_MASK(reason) (1 << (int)(-reason))
951 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
952 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
953 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
954 typedef int return_mask
;
956 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
957 to the inner most containing exception handler established using
958 catch_exceptions() (or the legacy catch_errors()).
960 Code normally throws an exception using error() et.al. For various
961 reaons, GDB also contains code that throws an exception directly.
962 For instance, the remote*.c targets contain CNTRL-C signal handlers
963 that propogate the QUIT event up the exception chain. ``This could
964 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
966 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
968 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
969 handler. If an exception (enum return_reason) is thrown using
970 throw_exception() than all cleanups installed since
971 catch_exceptions() was entered are invoked, the (-ve) exception
972 value is then returned by catch_exceptions. If FUNC() returns
973 normally (with a postive or zero return value) then that value is
974 returned by catch_exceptions(). It is an internal_error() for
975 FUNC() to return a negative value.
977 For the period of the FUNC() call: UIOUT is installed as the output
978 builder; ERRSTRING is installed as the error/quit message; and a
979 new cleanup_chain is established. The old values are restored
980 before catch_exceptions() returns.
982 The variant catch_exceptions_with_msg() is the same as
983 catch_exceptions() but adds the ability to return an allocated
984 copy of the gdb error message. This is used when a silent error is
985 issued and the caller wants to manually issue the error message.
987 FIXME; cagney/2001-08-13: The need to override the global UIOUT
988 builder variable should just go away.
990 This function superseeds catch_errors().
992 This function uses SETJMP() and LONGJUMP(). */
995 typedef int (catch_exceptions_ftype
) (struct ui_out
*ui_out
, void *args
);
996 extern int catch_exceptions (struct ui_out
*uiout
,
997 catch_exceptions_ftype
*func
, void *func_args
,
998 char *errstring
, return_mask mask
);
999 extern int catch_exceptions_with_msg (struct ui_out
*uiout
,
1000 catch_exceptions_ftype
*func
,
1002 char *errstring
, char **gdberrmsg
,
1005 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
1006 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
1007 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
1008 value. It's unfortunate that, catch_errors() does not return an
1009 indication of the exact exception that it caught - quit_flag might
1012 This function is superseeded by catch_exceptions(). */
1014 typedef int (catch_errors_ftype
) (void *);
1015 extern int catch_errors (catch_errors_ftype
*, void *, char *, return_mask
);
1017 /* Template to catch_errors() that wraps calls to command
1020 typedef void (catch_command_errors_ftype
) (char *, int);
1021 extern int catch_command_errors (catch_command_errors_ftype
*func
, char *command
, int from_tty
, return_mask
);
1023 extern void warning (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
1025 extern void vwarning (const char *, va_list args
);
1027 /* List of known OS ABIs. If you change this, make sure to update the
1028 table in osabi.c. */
1031 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
1033 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
1040 GDB_OSABI_FREEBSD_AOUT
,
1041 GDB_OSABI_FREEBSD_ELF
,
1042 GDB_OSABI_NETBSD_AOUT
,
1043 GDB_OSABI_NETBSD_ELF
,
1044 GDB_OSABI_OPENBSD_ELF
,
1054 GDB_OSABI_ARM_EABI_V1
,
1055 GDB_OSABI_ARM_EABI_V2
,
1061 GDB_OSABI_INVALID
/* keep this last */
1064 /* Global functions from other, non-gdb GNU thingies.
1065 Libiberty thingies are no longer declared here. We include libiberty.h
1068 #ifndef GETENV_PROVIDED
1069 extern char *getenv (const char *);
1072 /* From other system libraries */
1074 #ifdef HAVE_STDDEF_H
1078 #ifdef HAVE_STDLIB_H
1082 #define min(a, b) ((a) < (b) ? (a) : (b))
1085 #define max(a, b) ((a) > (b) ? (a) : (b))
1089 /* We take the address of fclose later, but some stdio's forget
1090 to declare this. We can't always declare it since there's
1091 no way to declare the parameters without upsetting some compiler
1094 #ifndef FCLOSE_PROVIDED
1095 extern int fclose (FILE *);
1099 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1102 /* Various possibilities for alloca. */
1105 #define alloca __builtin_alloca
1106 #else /* Not GNU C */
1107 #ifdef HAVE_ALLOCA_H
1114 /* We need to be careful not to declare this in a way which conflicts with
1115 bison. Bison never declares it as char *, but under various circumstances
1116 (like __hpux) we need to use void *. */
1117 extern void *alloca ();
1118 #endif /* Not _AIX */
1119 #endif /* Not HAVE_ALLOCA_H */
1120 #endif /* Not GNU C */
1121 #endif /* alloca not defined */
1123 /* Is GDB multi-arch? If there's a "tm.h" file, it is not. */
1124 #ifndef GDB_MULTI_ARCH
1126 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PARTIAL
1128 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PURE
1132 /* Dynamic target-system-dependent parameters for GDB. */
1133 #include "gdbarch.h"
1135 /* Maximum size of a register. Something small, but large enough for
1136 all known ISAs. If it turns out to be too small, make it bigger. */
1138 enum { MAX_REGISTER_SIZE
= 16 };
1140 /* Static target-system-dependent parameters for GDB. */
1142 /* Number of bits in a char or unsigned char for the target machine.
1143 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1144 #if !defined (TARGET_CHAR_BIT)
1145 #define TARGET_CHAR_BIT 8
1148 /* If we picked up a copy of CHAR_BIT from a configuration file
1149 (which may get it by including <limits.h>) then use it to set
1150 the number of bits in a host char. If not, use the same size
1153 #if defined (CHAR_BIT)
1154 #define HOST_CHAR_BIT CHAR_BIT
1156 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1159 /* The bit byte-order has to do just with numbering of bits in
1160 debugging symbols and such. Conceptually, it's quite separate
1161 from byte/word byte order. */
1163 #if !defined (BITS_BIG_ENDIAN)
1164 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1169 extern LONGEST
extract_signed_integer (const void *, int);
1171 extern ULONGEST
extract_unsigned_integer (const void *, int);
1173 extern int extract_long_unsigned_integer (const void *, int, LONGEST
*);
1175 extern CORE_ADDR
extract_typed_address (const void *buf
, struct type
*type
);
1177 extern void store_signed_integer (void *, int, LONGEST
);
1179 extern void store_unsigned_integer (void *, int, ULONGEST
);
1181 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1186 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1188 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1190 extern int watchdog
;
1192 /* Hooks for alternate command interfaces. */
1194 /* The name of the interpreter if specified on the command line. */
1195 extern char *interpreter_p
;
1197 /* If a given interpreter matches INTERPRETER_P then it should update
1198 deprecated_command_loop_hook and deprecated_init_ui_hook with the
1199 per-interpreter implementation. */
1200 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1201 should be moved here. */
1203 struct target_waitstatus
;
1204 struct cmd_list_element
;
1206 /* Should the asynchronous variant of the interpreter (using the
1207 event-loop) be enabled? */
1208 extern int event_loop_p
;
1210 extern void (*deprecated_init_ui_hook
) (char *argv0
);
1211 extern void (*deprecated_command_loop_hook
) (void);
1212 extern void (*deprecated_show_load_progress
) (const char *section
,
1213 unsigned long section_sent
,
1214 unsigned long section_size
,
1215 unsigned long total_sent
,
1216 unsigned long total_size
);
1217 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
1218 int line
, int stopline
,
1220 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1221 extern int (*deprecated_query_hook
) (const char *, va_list);
1222 extern void (*deprecated_warning_hook
) (const char *, va_list);
1223 extern void (*deprecated_flush_hook
) (struct ui_file
* stream
);
1224 extern void (*deprecated_create_breakpoint_hook
) (struct breakpoint
* b
);
1225 extern void (*deprecated_delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1226 extern void (*deprecated_modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1227 extern void (*deprecated_interactive_hook
) (void);
1228 extern void (*deprecated_registers_changed_hook
) (void);
1229 extern void (*deprecated_readline_begin_hook
) (char *,...);
1230 extern char *(*deprecated_readline_hook
) (char *);
1231 extern void (*deprecated_readline_end_hook
) (void);
1232 extern void (*deprecated_register_changed_hook
) (int regno
);
1233 extern void (*deprecated_memory_changed_hook
) (CORE_ADDR addr
, int len
);
1234 extern void (*deprecated_context_hook
) (int);
1235 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
1236 struct target_waitstatus
* status
);
1238 extern void (*deprecated_attach_hook
) (void);
1239 extern void (*deprecated_detach_hook
) (void);
1240 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
1241 char *cmd
, int from_tty
);
1243 extern void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
1245 extern NORETURN
void (*deprecated_error_hook
) (void) ATTR_NORETURN
;
1247 extern void (*deprecated_error_begin_hook
) (void);
1249 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
1253 /* Inhibit window interface if non-zero. */
1255 extern int use_windows
;
1257 /* Symbolic definitions of filename-related things. */
1258 /* FIXME, this doesn't work very well if host and executable
1259 filesystems conventions are different. */
1261 #ifndef DIRNAME_SEPARATOR
1262 #define DIRNAME_SEPARATOR ':'
1265 #ifndef SLASH_STRING
1266 #define SLASH_STRING "/"
1271 # define GLOBAL_CURDIR
1274 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1275 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1276 in the code actually refer to a lightweight process id, i.e,
1277 something that can be considered a process id in its own right for
1278 certain purposes. */
1281 #define PIDGET(PTID) (ptid_get_pid (PTID))
1282 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1283 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1286 /* Define well known filenos if the system does not define them. */
1287 #ifndef STDIN_FILENO
1288 #define STDIN_FILENO 0
1290 #ifndef STDOUT_FILENO
1291 #define STDOUT_FILENO 1
1293 #ifndef STDERR_FILENO
1294 #define STDERR_FILENO 2
1297 /* If this definition isn't overridden by the header files, assume
1298 that isatty and fileno exist on this system. */
1300 #define ISATTY(FP) (isatty (fileno (FP)))
1303 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1304 power of 2). Round up/down when necessary. Examples of correct
1307 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1308 write_memory (addr, value, len);
1313 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1314 write_memory (sp, value, len);
1316 Note that uses such as:
1318 write_memory (addr, value, len);
1319 addr += align_up (len, 8);
1323 sp -= align_up (len, 8);
1324 write_memory (sp, value, len);
1326 are typically not correct as they don't ensure that the address (SP
1327 or ADDR) is correctly aligned (relying on previous alignment to
1328 keep things right). This is also why the methods are called
1329 "align_..." instead of "round_..." as the latter reads better with
1330 this incorrect coding style. */
1332 extern ULONGEST
align_up (ULONGEST v
, int n
);
1333 extern ULONGEST
align_down (ULONGEST v
, int n
);
1335 #endif /* #ifndef DEFS_H */