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. */
69 /* An address in the program being debugged. Host byte order. Rather
70 than duplicate all the logic in BFD which figures out what type
71 this is (long, long long, etc.) and whether it needs to be 64
72 bits (the host/target interactions are subtle), we just use
75 typedef bfd_vma CORE_ADDR
;
77 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
83 #define LONGEST BFD_HOST_64_BIT
84 #define ULONGEST BFD_HOST_U_64_BIT
88 #ifdef CC_HAS_LONG_LONG
89 #define LONGEST long long
90 #define ULONGEST unsigned long long
92 #ifdef BFD_HOST_64_BIT
93 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
94 (e.g. i386-windows) so try it. */
95 #define LONGEST BFD_HOST_64_BIT
96 #define ULONGEST BFD_HOST_U_64_BIT
99 #define ULONGEST unsigned long
103 #endif /* No BFD64 */
105 #endif /* ! LONGEST */
108 #define min(a, b) ((a) < (b) ? (a) : (b))
111 #define max(a, b) ((a) > (b) ? (a) : (b))
114 /* Macros to do string compares.
116 NOTE: cagney/2000-03-14:
118 While old code can continue to refer to these macros, new code is
119 probably better off using strcmp() directly vis: ``strcmp() == 0''
120 and ``strcmp() != 0''.
122 This is because modern compilers can directly inline strcmp()
123 making the original justification for these macros - avoid function
124 call overhead by pre-testing the first characters
125 (``*X==*Y?...:0'') - redundant.
127 ``Even if [...] testing the first character does have a modest
128 performance improvement, I'd rather that whenever a performance
129 issue is found that we spend the effort on algorithmic
130 optimizations than micro-optimizing.'' J.T. */
132 /* NOTE: cagney/2003-11-23: All instances of STREQ[N] covered by
133 testing GDB on a stabs system have been replaced by equivalent
134 str[n]cmp calls. To avoid the possability of introducing bugs when
135 making untested changes, the remaining references were deprecated
136 rather than replaced. */
138 /* DISCLAIMER: cagney/2003-11-23: Simplified definition of these
139 macros so that they just map directly onto strcmp equivalent. I'm
140 not responsible for any breakage due to code that relied on the old
141 underlying implementation. */
143 #define DEPRECATED_STREQ(a,b) (strcmp ((a), (b)) == 0)
144 #define DEPRECATED_STREQN(a,b,c) (strncmp ((a), (b), (c)) == 0)
146 /* Check if a character is one of the commonly used C++ marker characters. */
147 extern int is_cplus_marker (int);
149 /* enable xdb commands if set */
150 extern int xdb_commands
;
152 /* enable dbx commands if set */
153 extern int dbx_commands
;
155 /* System root path, used to find libraries etc. */
156 extern char *gdb_sysroot
;
158 extern int quit_flag
;
159 extern int immediate_quit
;
160 extern int sevenbit_strings
;
162 extern void quit (void);
164 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
165 benefits of having a ``QUIT'' macro rather than a function are
166 marginal. If the overhead of a QUIT function call is proving
167 significant then its calling frequency should probably be reduced
168 [kingdon]. A profile analyzing the current situtation is
172 /* do twice to force compiler warning */
173 #define QUIT_FIXME "FIXME"
174 #define QUIT_FIXME "ignoring redefinition of QUIT"
177 if (quit_flag) quit (); \
178 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
182 /* Languages represented in the symbol table and elsewhere.
183 This should probably be in language.h, but since enum's can't
184 be forward declared to satisfy opaque references before their
185 actual definition, needs to be here. */
189 language_unknown
, /* Language not known */
190 language_auto
, /* Placeholder for automatic setting */
192 language_cplus
, /* C++ */
193 language_objc
, /* Objective-C */
194 language_java
, /* Java */
195 language_fortran
, /* Fortran */
196 language_m2
, /* Modula-2 */
197 language_asm
, /* Assembly language */
198 language_scm
, /* Scheme / Guile */
199 language_pascal
, /* Pascal */
200 language_ada
, /* Ada */
201 language_minimal
, /* All other languages, minimal support only */
209 unspecified_precision
212 /* A generic, not quite boolean, enumeration. */
220 /* Potential ways that a function can return a value of a given type. */
221 enum return_value_convention
223 /* Where the return value has been squeezed into one or more
225 RETURN_VALUE_REGISTER_CONVENTION
,
226 /* Commonly known as the "struct return convention". The caller
227 passes an additional hidden first parameter to the caller. That
228 parameter contains the address at which the value being returned
229 should be stored. While typically, and historically, used for
230 large structs, this is convention is applied to values of many
232 RETURN_VALUE_STRUCT_CONVENTION
,
233 /* Like the "struct return convention" above, but where the ABI
234 guarantees that the called function stores the address at which
235 the value being returned is stored in a well-defined location,
236 such as a register or memory slot in the stack frame. Don't use
237 this if the ABI doesn't explicitly guarantees this. */
238 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
239 /* Like the "struct return convention" above, but where the ABI
240 guarantees that the address at which the value being returned is
241 stored will be available in a well-defined location, such as a
242 register or memory slot in the stack frame. Don't use this if
243 the ABI doesn't explicitly guarantees this. */
244 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
247 /* the cleanup list records things that have to be undone
248 if an error happens (descriptors to be closed, memory to be freed, etc.)
249 Each link in the chain records a function to call and an
252 Use make_cleanup to add an element to the cleanup chain.
253 Use do_cleanups to do all cleanup actions back to a given
254 point in the chain. Use discard_cleanups to remove cleanups
255 from the chain back to a given point, not doing them. */
259 struct cleanup
*next
;
260 void (*function
) (void *);
265 /* The ability to declare that a function never returns is useful, but
266 not really required to compile GDB successfully, so the NORETURN and
267 ATTR_NORETURN macros normally expand into nothing. */
269 /* If compiling with older versions of GCC, a function may be declared
270 "volatile" to indicate that it does not return. */
273 #if defined(__GNUC__) \
274 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
275 #define NORETURN volatile
277 #define NORETURN /* nothing */
281 /* GCC 2.5 and later versions define a function attribute "noreturn",
282 which is the preferred way to declare that a function never returns.
283 However GCC 2.7 appears to be the first version in which this fully
284 works everywhere we use it. */
286 #ifndef ATTR_NORETURN
287 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
288 #define ATTR_NORETURN __attribute__ ((noreturn))
290 #define ATTR_NORETURN /* nothing */
295 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
296 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
298 #define ATTR_FORMAT(type, x, y) /* nothing */
302 /* Be conservative and use enum bitfields only with GCC.
303 This is copied from gcc 3.3.1, system.h. */
305 #if defined(__GNUC__) && (__GNUC__ >= 2)
306 #define ENUM_BITFIELD(TYPE) enum TYPE
308 #define ENUM_BITFIELD(TYPE) unsigned int
311 /* Needed for various prototypes */
319 extern void initialize_utils (void);
321 extern void notice_quit (void);
323 extern int strcmp_iw (const char *, const char *);
325 extern int strcmp_iw_ordered (const char *, const char *);
327 extern int streq (const char *, const char *);
329 extern int subset_compare (char *, char *);
331 extern char *safe_strerror (int);
333 extern void request_quit (int);
335 extern void do_cleanups (struct cleanup
*);
336 extern void do_final_cleanups (struct cleanup
*);
337 extern void do_run_cleanups (struct cleanup
*);
338 extern void do_exec_cleanups (struct cleanup
*);
339 extern void do_exec_error_cleanups (struct cleanup
*);
341 extern void discard_cleanups (struct cleanup
*);
342 extern void discard_final_cleanups (struct cleanup
*);
343 extern void discard_exec_error_cleanups (struct cleanup
*);
344 extern void discard_my_cleanups (struct cleanup
**, struct cleanup
*);
346 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
347 make_cleanup function declarations below. Do not use this typedef
348 as a cast when passing functions into the make_cleanup() code.
349 Instead either use a bounce function or add a wrapper function.
350 Calling a f(char*) function with f(void*) is non-portable. */
351 typedef void (make_cleanup_ftype
) (void *);
353 extern struct cleanup
*make_cleanup (make_cleanup_ftype
*, void *);
355 extern struct cleanup
*make_cleanup_freeargv (char **);
358 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
360 struct section_addr_info
;
361 extern struct cleanup
*(make_cleanup_free_section_addr_info
362 (struct section_addr_info
*));
364 extern struct cleanup
*make_cleanup_close (int fd
);
366 extern struct cleanup
*make_cleanup_bfd_close (bfd
*abfd
);
368 extern struct cleanup
*make_final_cleanup (make_cleanup_ftype
*, void *);
370 extern struct cleanup
*make_my_cleanup (struct cleanup
**,
371 make_cleanup_ftype
*, void *);
373 extern struct cleanup
*make_run_cleanup (make_cleanup_ftype
*, void *);
375 extern struct cleanup
*make_exec_cleanup (make_cleanup_ftype
*, void *);
376 extern struct cleanup
*make_exec_error_cleanup (make_cleanup_ftype
*, void *);
378 extern struct cleanup
*save_cleanups (void);
379 extern struct cleanup
*save_final_cleanups (void);
380 extern struct cleanup
*save_my_cleanups (struct cleanup
**);
382 extern void restore_cleanups (struct cleanup
*);
383 extern void restore_final_cleanups (struct cleanup
*);
384 extern void restore_my_cleanups (struct cleanup
**, struct cleanup
*);
386 extern void free_current_contents (void *);
388 extern void null_cleanup (void *);
390 extern int myread (int, char *, int);
392 extern int query (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
393 extern int nquery (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
394 extern int yquery (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
396 extern void init_page_info (void);
398 extern char *gdb_realpath (const char *);
399 extern char *xfullpath (const char *);
401 extern unsigned long gnu_debuglink_crc32 (unsigned long crc
,
402 unsigned char *buf
, size_t len
);
404 /* From demangle.c */
406 extern void set_demangling_style (char *);
411 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
412 extern use_struct_convention_fn generic_use_struct_convention
;
415 /* Annotation stuff. */
417 extern int annotation_level
; /* in stack.c */
419 extern void begin_line (void);
421 extern void wrap_here (char *);
423 extern void reinitialize_more_filter (void);
426 extern struct ui_file
*gdb_stdout
;
428 extern struct ui_file
*gdb_stdin
;
429 /* Serious error notifications */
430 extern struct ui_file
*gdb_stderr
;
431 /* Log/debug/trace messages that should bypass normal stdout/stderr
432 filtering. For moment, always call this stream using
433 *_unfiltered. In the very near future that restriction shall be
434 removed - either call shall be unfiltered. (cagney 1999-06-13). */
435 extern struct ui_file
*gdb_stdlog
;
436 /* Target output that should bypass normal stdout/stderr filtering.
437 For moment, always call this stream using *_unfiltered. In the
438 very near future that restriction shall be removed - either call
439 shall be unfiltered. (cagney 1999-07-02). */
440 extern struct ui_file
*gdb_stdtarg
;
441 extern struct ui_file
*gdb_stdtargerr
;
442 extern struct ui_file
*gdb_stdtargin
;
446 /* More generic printf like operations. Filtered versions may return
447 non-locally on error. */
449 extern void fputs_filtered (const char *, struct ui_file
*);
451 extern void fputs_unfiltered (const char *, struct ui_file
*);
453 extern int fputc_filtered (int c
, struct ui_file
*);
455 extern int fputc_unfiltered (int c
, struct ui_file
*);
457 extern int putchar_filtered (int c
);
459 extern int putchar_unfiltered (int c
);
461 extern void puts_filtered (const char *);
463 extern void puts_unfiltered (const char *);
465 extern void puts_filtered_tabular (char *string
, int width
, int right
);
467 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
469 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
471 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
473 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
475 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
477 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
479 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
481 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
483 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
485 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
487 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
489 extern void print_spaces (int, struct ui_file
*);
491 extern void print_spaces_filtered (int, struct ui_file
*);
493 extern char *n_spaces (int);
495 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
497 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
499 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
501 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
502 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
504 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
505 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
507 extern int strlen_paddr (void);
508 extern char *paddr (CORE_ADDR addr
);
509 extern char *paddr_nz (CORE_ADDR addr
);
510 extern char *paddr_u (CORE_ADDR addr
);
511 extern char *paddr_d (LONGEST addr
);
513 extern char *phex (ULONGEST l
, int sizeof_l
);
514 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
515 extern char *int_string (LONGEST
, int, int, int, int);
517 /* Like paddr() only print/scan raw CORE_ADDR. The output from
518 core_addr_to_string() can be passed direct to
519 string_to_core_addr(). */
520 extern const char *core_addr_to_string (const CORE_ADDR addr
);
521 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
522 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
524 /* Return a string that contains a number formatted as a hex
526 extern char *hex_string (LONGEST
);
527 extern char *hex_string_custom (LONGEST
, int);
529 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
532 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
534 extern void print_sys_errmsg (const char *, int);
536 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
537 "const char *" in unistd.h, so we can't declare the argument
540 extern char *re_comp (const char *);
544 extern void symbol_file_command (char *, int);
546 /* Remote targets may wish to use this as their load function. */
547 extern void generic_load (char *name
, int from_tty
);
549 /* Summarise a download */
550 extern void print_transfer_performance (struct ui_file
*stream
,
551 unsigned long data_count
,
552 unsigned long write_count
,
553 unsigned long time_count
);
557 typedef void initialize_file_ftype (void);
559 extern char *skip_quoted (char *);
561 extern char *gdb_readline (char *);
563 extern char *gdb_readline_wrapper (char *);
565 extern char *command_line_input (char *, int, char *);
567 extern void print_prompt (void);
569 extern int input_from_terminal_p (void);
571 extern int info_verbose
;
573 /* From printcmd.c */
575 extern void set_next_address (CORE_ADDR
);
577 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
580 extern int build_address_symbolic (CORE_ADDR addr
,
588 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
590 extern void print_address (CORE_ADDR
, struct ui_file
*);
594 #define OPF_TRY_CWD_FIRST 0x01
595 #define OPF_SEARCH_IN_PATH 0x02
597 extern int openp (const char *, int, const char *, int, int, char **);
599 extern int source_full_path_of (char *, char **);
601 extern void mod_path (char *, char **);
603 extern void add_path (char *, char **, int);
605 extern void directory_command (char *, int);
607 extern char *source_path
;
609 extern void init_source_path (void);
611 extern void init_last_source_visited (void);
615 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
616 bfd_signed_vma data_off
,
617 bfd_signed_vma bss_off
);
619 /* Take over the 'find_mapped_memory' vector from exec.c. */
620 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
626 /* Possible lvalue types. Like enum language, this should be in
627 value.h, but needs to be here for the same reason. */
633 /* In memory. Could be a saved register. */
637 /* In a gdb internal variable. */
639 /* Part of a gdb internal variable (structure field). */
640 lval_internalvar_component
,
641 /* In a register series in a frame not the current one, which may have been
642 partially saved or saved in different places (otherwise would be
643 lval_register or lval_memory). */
644 lval_reg_frame_relative
647 /* Control types for commands */
649 enum misc_command_type
657 enum command_control_type
667 /* Structure for saved commands lines
668 (for breakpoints, defined commands, etc). */
672 struct command_line
*next
;
674 enum command_control_type control_type
;
676 struct command_line
**body_list
;
679 extern struct command_line
*read_command_lines (char *, int);
681 extern void free_command_lines (struct command_line
**);
683 /* To continue the execution commands when running gdb asynchronously.
684 A continuation structure contains a pointer to a function to be called
685 to finish the command, once the target has stopped. Such mechanism is
686 used bt the finish and until commands, and in the remote protocol
687 when opening an extended-remote connection. */
689 struct continuation_arg
691 struct continuation_arg
*next
;
692 union continuation_data
{
701 void (*continuation_hook
) (struct continuation_arg
*);
702 struct continuation_arg
*arg_list
;
703 struct continuation
*next
;
707 extern struct continuation
*cmd_continuation
;
708 /* Used only by the step_1 function. */
709 extern struct continuation
*intermediate_continuation
;
712 extern void add_continuation (void (*)(struct continuation_arg
*),
713 struct continuation_arg
*);
714 extern void do_all_continuations (void);
715 extern void discard_all_continuations (void);
717 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
718 struct continuation_arg
*);
719 extern void do_all_intermediate_continuations (void);
720 extern void discard_all_intermediate_continuations (void);
722 /* String containing the current directory (what getwd would return). */
724 extern char *current_directory
;
726 /* Default radixes for input and output. Only some values supported. */
727 extern unsigned input_radix
;
728 extern unsigned output_radix
;
730 /* Possibilities for prettyprint parameters to routines which print
731 things. Like enum language, this should be in value.h, but needs
732 to be here for the same reason. FIXME: If we can eliminate this
733 as an arg to LA_VAL_PRINT, then we can probably move it back to
738 Val_no_prettyprint
= 0,
740 /* Use the default setting which the user has specified. */
744 /* The ptid struct is a collection of the various "ids" necessary
745 for identifying the inferior. This consists of the process id
746 (pid), thread id (tid), and other fields necessary for uniquely
747 identifying the inferior process/thread being debugged. When
748 manipulating ptids, the constructors, accessors, and predicate
749 declared in inferior.h should be used. These are as follows:
751 ptid_build - Make a new ptid from a pid, lwp, and tid.
752 pid_to_ptid - Make a new ptid from just a pid.
753 ptid_get_pid - Fetch the pid component of a ptid.
754 ptid_get_lwp - Fetch the lwp component of a ptid.
755 ptid_get_tid - Fetch the tid component of a ptid.
756 ptid_equal - Test to see if two ptids are equal.
758 Please do NOT access the struct ptid members directly (except, of
759 course, in the implementation of the above ptid manipulation
767 /* Lightweight process id */
774 typedef struct ptid ptid_t
;
778 /* Optional host machine definition. Pure autoconf targets will not
779 need a "xm.h" file. This will be a symlink to one of the xm-*.h
780 files, built by the `configure' script. */
786 /* Optional native machine support. Non-native (and possibly pure
787 multi-arch) targets do not need a "nm.h" file. This will be a
788 symlink to one of the nm-*.h files, built by the `configure'
795 /* Optional target machine definition. Pure multi-arch configurations
796 do not need a "tm.h" file. This will be a symlink to one of the
797 tm-*.h files, built by the `configure' script. */
803 /* Assume that fopen accepts the letter "b" in the mode string.
804 Support for is demanded by ISO C90, and should be supported on all
805 platforms that claim to have a standards conforming C library. On
806 true POSIX systems it will be ignored and have no effect. There
807 may still be systems without a standards conforming C library where
808 an ISO C90 compiler (GCC) is available. Known examples are SunOS
809 4.x and 4.3BSD. This assumption means these systems are no longer
812 # include "fopen-bin.h"
815 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
816 FIXME: Assumes 2's complement arithmetic */
818 #if !defined (UINT_MAX)
819 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
822 #if !defined (INT_MAX)
823 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
826 #if !defined (INT_MIN)
827 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
830 #if !defined (ULONG_MAX)
831 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
834 #if !defined (LONG_MAX)
835 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
838 #if !defined (ULONGEST_MAX)
839 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
842 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
843 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
846 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
847 arguments to a function, number in a value history, register number, etc.)
848 where the value must not be larger than can fit in an int. */
850 extern int longest_to_int (LONGEST
);
852 /* Assorted functions we can declare, now that const and volatile are
855 extern char *savestring (const char *, size_t);
857 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
859 extern void xfree (void *);
861 /* Utility macros to allocate typed memory. Avoids errors like:
862 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
863 sizeof (struct foo), 0). */
864 #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE)))
865 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
866 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
868 /* Like asprintf/vasprintf but get an internal_error if the call
870 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
871 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
873 /* Like asprintf and vasprintf, but return the string, throw an error
875 extern char *xstrprintf (const char *format
, ...) ATTR_FORMAT (printf
, 1, 2);
876 extern char *xstrvprintf (const char *format
, va_list ap
);
878 extern int parse_escape (char **);
880 /* Message to be printed before the error message, when an error occurs. */
882 extern char *error_pre_print
;
884 /* Message to be printed before the error message, when an error occurs. */
886 extern char *quit_pre_print
;
888 /* Message to be printed before the warning message, when a warning occurs. */
890 extern char *warning_pre_print
;
892 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
894 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
896 extern NORETURN
void error_silent (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
898 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
900 /* Initialize the error buffer. */
901 extern void error_init (void);
903 /* Returns a freshly allocate buffer containing the last error
905 extern char *error_last_message (void);
907 /* Output arbitrary error message. */
908 extern void error_output_message (char *pre_print
, char *msg
);
910 extern NORETURN
void vfatal (const char *fmt
, va_list ap
) ATTR_NORETURN
;
912 extern NORETURN
void fatal (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
914 extern NORETURN
void internal_verror (const char *file
, int line
,
915 const char *, va_list ap
) ATTR_NORETURN
;
917 extern NORETURN
void internal_error (const char *file
, int line
,
918 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
920 extern void internal_vwarning (const char *file
, int line
,
921 const char *, va_list ap
);
923 extern void internal_warning (const char *file
, int line
,
924 const char *, ...) ATTR_FORMAT (printf
, 3, 4);
926 extern NORETURN
void nomem (long) ATTR_NORETURN
;
928 /* Reasons for calling throw_exception(). NOTE: all reason values
929 must be less than zero. enum value 0 is reserved for internal use
930 as the return value from an initial setjmp(). The function
931 catch_exceptions() reserves values >= 0 as legal results from its
936 /* User interrupt. */
938 /* Any other error. */
942 #define ALL_CLEANUPS ((struct cleanup *)0)
944 #define RETURN_MASK(reason) (1 << (int)(-reason))
945 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
946 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
947 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
948 typedef int return_mask
;
950 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
951 to the inner most containing exception handler established using
952 catch_exceptions() (or the legacy catch_errors()).
954 Code normally throws an exception using error() et.al. For various
955 reaons, GDB also contains code that throws an exception directly.
956 For instance, the remote*.c targets contain CNTRL-C signal handlers
957 that propogate the QUIT event up the exception chain. ``This could
958 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
960 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
962 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
963 handler. If an exception (enum return_reason) is thrown using
964 throw_exception() than all cleanups installed since
965 catch_exceptions() was entered are invoked, the (-ve) exception
966 value is then returned by catch_exceptions. If FUNC() returns
967 normally (with a postive or zero return value) then that value is
968 returned by catch_exceptions(). It is an internal_error() for
969 FUNC() to return a negative value.
971 For the period of the FUNC() call: UIOUT is installed as the output
972 builder; ERRSTRING is installed as the error/quit message; and a
973 new cleanup_chain is established. The old values are restored
974 before catch_exceptions() returns.
976 The variant catch_exceptions_with_msg() is the same as
977 catch_exceptions() but adds the ability to return an allocated
978 copy of the gdb error message. This is used when a silent error is
979 issued and the caller wants to manually issue the error message.
981 FIXME; cagney/2001-08-13: The need to override the global UIOUT
982 builder variable should just go away.
984 This function superseeds catch_errors().
986 This function uses SETJMP() and LONGJUMP(). */
989 typedef int (catch_exceptions_ftype
) (struct ui_out
*ui_out
, void *args
);
990 extern int catch_exceptions (struct ui_out
*uiout
,
991 catch_exceptions_ftype
*func
, void *func_args
,
992 char *errstring
, return_mask mask
);
993 extern int catch_exceptions_with_msg (struct ui_out
*uiout
,
994 catch_exceptions_ftype
*func
,
996 char *errstring
, char **gdberrmsg
,
999 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
1000 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
1001 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
1002 value. It's unfortunate that, catch_errors() does not return an
1003 indication of the exact exception that it caught - quit_flag might
1006 This function is superseeded by catch_exceptions(). */
1008 typedef int (catch_errors_ftype
) (void *);
1009 extern int catch_errors (catch_errors_ftype
*, void *, char *, return_mask
);
1011 /* Template to catch_errors() that wraps calls to command
1014 typedef void (catch_command_errors_ftype
) (char *, int);
1015 extern int catch_command_errors (catch_command_errors_ftype
*func
, char *command
, int from_tty
, return_mask
);
1017 extern void warning (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
1019 extern void vwarning (const char *, va_list args
);
1021 /* List of known OS ABIs. If you change this, make sure to update the
1022 table in osabi.c. */
1025 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
1027 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
1034 GDB_OSABI_FREEBSD_AOUT
,
1035 GDB_OSABI_FREEBSD_ELF
,
1036 GDB_OSABI_NETBSD_AOUT
,
1037 GDB_OSABI_NETBSD_ELF
,
1038 GDB_OSABI_OPENBSD_ELF
,
1048 GDB_OSABI_ARM_EABI_V1
,
1049 GDB_OSABI_ARM_EABI_V2
,
1055 GDB_OSABI_INVALID
/* keep this last */
1058 /* Global functions from other, non-gdb GNU thingies.
1059 Libiberty thingies are no longer declared here. We include libiberty.h
1062 /* From other system libraries */
1064 #ifdef HAVE_STDDEF_H
1068 #ifdef HAVE_STDLIB_H
1072 #define min(a, b) ((a) < (b) ? (a) : (b))
1075 #define max(a, b) ((a) > (b) ? (a) : (b))
1080 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1083 /* Various possibilities for alloca. */
1086 #define alloca __builtin_alloca
1087 #else /* Not GNU C */
1088 #ifdef HAVE_ALLOCA_H
1095 /* We need to be careful not to declare this in a way which conflicts with
1096 bison. Bison never declares it as char *, but under various circumstances
1097 (like __hpux) we need to use void *. */
1098 extern void *alloca ();
1099 #endif /* Not _AIX */
1100 #endif /* Not HAVE_ALLOCA_H */
1101 #endif /* Not GNU C */
1102 #endif /* alloca not defined */
1104 /* Dynamic target-system-dependent parameters for GDB. */
1105 #include "gdbarch.h"
1107 /* Maximum size of a register. Something small, but large enough for
1108 all known ISAs. If it turns out to be too small, make it bigger. */
1110 enum { MAX_REGISTER_SIZE
= 16 };
1112 /* Static target-system-dependent parameters for GDB. */
1114 /* Number of bits in a char or unsigned char for the target machine.
1115 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1116 #if !defined (TARGET_CHAR_BIT)
1117 #define TARGET_CHAR_BIT 8
1120 /* If we picked up a copy of CHAR_BIT from a configuration file
1121 (which may get it by including <limits.h>) then use it to set
1122 the number of bits in a host char. If not, use the same size
1125 #if defined (CHAR_BIT)
1126 #define HOST_CHAR_BIT CHAR_BIT
1128 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1131 /* The bit byte-order has to do just with numbering of bits in
1132 debugging symbols and such. Conceptually, it's quite separate
1133 from byte/word byte order. */
1135 #if !defined (BITS_BIG_ENDIAN)
1136 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1141 extern LONGEST
extract_signed_integer (const void *, int);
1143 extern ULONGEST
extract_unsigned_integer (const void *, int);
1145 extern int extract_long_unsigned_integer (const void *, int, LONGEST
*);
1147 extern CORE_ADDR
extract_typed_address (const void *buf
, struct type
*type
);
1149 extern void store_signed_integer (void *, int, LONGEST
);
1151 extern void store_unsigned_integer (void *, int, ULONGEST
);
1153 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1158 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1160 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1162 extern int watchdog
;
1164 /* Hooks for alternate command interfaces. */
1166 /* The name of the interpreter if specified on the command line. */
1167 extern char *interpreter_p
;
1169 /* If a given interpreter matches INTERPRETER_P then it should update
1170 deprecated_command_loop_hook and deprecated_init_ui_hook with the
1171 per-interpreter implementation. */
1172 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1173 should be moved here. */
1175 struct target_waitstatus
;
1176 struct cmd_list_element
;
1178 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
1179 extern void (*deprecated_post_add_symbol_hook
) (void);
1180 extern void (*selected_frame_level_changed_hook
) (int);
1181 extern int (*deprecated_ui_loop_hook
) (int signo
);
1182 extern void (*deprecated_init_ui_hook
) (char *argv0
);
1183 extern void (*deprecated_command_loop_hook
) (void);
1184 extern void (*deprecated_show_load_progress
) (const char *section
,
1185 unsigned long section_sent
,
1186 unsigned long section_size
,
1187 unsigned long total_sent
,
1188 unsigned long total_size
);
1189 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
1190 int line
, int stopline
,
1192 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1193 extern int (*deprecated_query_hook
) (const char *, va_list);
1194 extern void (*deprecated_warning_hook
) (const char *, va_list);
1195 extern void (*deprecated_flush_hook
) (struct ui_file
* stream
);
1196 extern void (*deprecated_create_breakpoint_hook
) (struct breakpoint
* b
);
1197 extern void (*deprecated_delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1198 extern void (*deprecated_modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1199 extern void (*deprecated_interactive_hook
) (void);
1200 extern void (*deprecated_registers_changed_hook
) (void);
1201 extern void (*deprecated_readline_begin_hook
) (char *,...);
1202 extern char *(*deprecated_readline_hook
) (char *);
1203 extern void (*deprecated_readline_end_hook
) (void);
1204 extern void (*deprecated_register_changed_hook
) (int regno
);
1205 extern void (*deprecated_memory_changed_hook
) (CORE_ADDR addr
, int len
);
1206 extern void (*deprecated_context_hook
) (int);
1207 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
1208 struct target_waitstatus
* status
);
1210 extern void (*deprecated_attach_hook
) (void);
1211 extern void (*deprecated_detach_hook
) (void);
1212 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
1213 char *cmd
, int from_tty
);
1215 extern void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
1217 extern void (*deprecated_error_hook
) (void);
1219 extern void (*deprecated_error_begin_hook
) (void);
1221 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
1225 /* Inhibit window interface if non-zero. */
1227 extern int use_windows
;
1229 /* Symbolic definitions of filename-related things. */
1230 /* FIXME, this doesn't work very well if host and executable
1231 filesystems conventions are different. */
1233 #ifndef DIRNAME_SEPARATOR
1234 #define DIRNAME_SEPARATOR ':'
1237 #ifndef SLASH_STRING
1238 #define SLASH_STRING "/"
1243 # define GLOBAL_CURDIR
1246 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1247 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1248 in the code actually refer to a lightweight process id, i.e,
1249 something that can be considered a process id in its own right for
1250 certain purposes. */
1253 #define PIDGET(PTID) (ptid_get_pid (PTID))
1254 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1255 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1258 /* Define well known filenos if the system does not define them. */
1259 #ifndef STDIN_FILENO
1260 #define STDIN_FILENO 0
1262 #ifndef STDOUT_FILENO
1263 #define STDOUT_FILENO 1
1265 #ifndef STDERR_FILENO
1266 #define STDERR_FILENO 2
1269 /* If this definition isn't overridden by the header files, assume
1270 that isatty and fileno exist on this system. */
1272 #define ISATTY(FP) (isatty (fileno (FP)))
1275 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1276 power of 2). Round up/down when necessary. Examples of correct
1279 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1280 write_memory (addr, value, len);
1285 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1286 write_memory (sp, value, len);
1288 Note that uses such as:
1290 write_memory (addr, value, len);
1291 addr += align_up (len, 8);
1295 sp -= align_up (len, 8);
1296 write_memory (sp, value, len);
1298 are typically not correct as they don't ensure that the address (SP
1299 or ADDR) is correctly aligned (relying on previous alignment to
1300 keep things right). This is also why the methods are called
1301 "align_..." instead of "round_..." as the latter reads better with
1302 this incorrect coding style. */
1304 extern ULONGEST
align_up (ULONGEST v
, int n
);
1305 extern ULONGEST
align_down (ULONGEST v
, int n
);
1307 #endif /* #ifndef DEFS_H */