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
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 #define DEPRECATED_STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
164 #define DEPRECATED_STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
166 /* Check if a character is one of the commonly used C++ marker characters. */
167 extern int is_cplus_marker (int);
169 /* enable xdb commands if set */
170 extern int xdb_commands
;
172 /* enable dbx commands if set */
173 extern int dbx_commands
;
175 /* System root path, used to find libraries etc. */
176 extern char *gdb_sysroot
;
178 extern int quit_flag
;
179 extern int immediate_quit
;
180 extern int sevenbit_strings
;
182 extern void quit (void);
184 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
185 benefits of having a ``QUIT'' macro rather than a function are
186 marginal. If the overhead of a QUIT function call is proving
187 significant then its calling frequency should probably be reduced
188 [kingdon]. A profile analyzing the current situtation is
192 /* do twice to force compiler warning */
193 #define QUIT_FIXME "FIXME"
194 #define QUIT_FIXME "ignoring redefinition of QUIT"
197 if (quit_flag) quit (); \
198 if (interactive_hook) interactive_hook (); \
203 /* Languages represented in the symbol table and elsewhere.
204 This should probably be in language.h, but since enum's can't
205 be forward declared to satisfy opaque references before their
206 actual definition, needs to be here. */
210 language_unknown
, /* Language not known */
211 language_auto
, /* Placeholder for automatic setting */
213 language_cplus
, /* C++ */
214 language_objc
, /* Objective-C */
215 language_java
, /* Java */
216 language_fortran
, /* Fortran */
217 language_m2
, /* Modula-2 */
218 language_asm
, /* Assembly language */
219 language_scm
, /* Scheme / Guile */
220 language_pascal
, /* Pascal */
221 language_minimal
/* All other languages, minimal support only */
228 unspecified_precision
231 /* A generic, not quite boolean, enumeration. */
239 /* Potential ways that a function can return a value of a given type. */
240 enum return_value_convention
242 /* Where the return value has been squeezed into one or more
244 RETURN_VALUE_REGISTER_CONVENTION
,
245 /* Commonly known as the "struct return convention". The caller
246 passes an additional hidden first parameter to the caller. That
247 parameter contains the address at which the value being returned
248 should be stored. While typically, and historically, used for
249 large structs, this is convention is applied to values of many
251 RETURN_VALUE_STRUCT_CONVENTION
254 /* the cleanup list records things that have to be undone
255 if an error happens (descriptors to be closed, memory to be freed, etc.)
256 Each link in the chain records a function to call and an
259 Use make_cleanup to add an element to the cleanup chain.
260 Use do_cleanups to do all cleanup actions back to a given
261 point in the chain. Use discard_cleanups to remove cleanups
262 from the chain back to a given point, not doing them. */
266 struct cleanup
*next
;
267 void (*function
) (void *);
272 /* The ability to declare that a function never returns is useful, but
273 not really required to compile GDB successfully, so the NORETURN and
274 ATTR_NORETURN macros normally expand into nothing. */
276 /* If compiling with older versions of GCC, a function may be declared
277 "volatile" to indicate that it does not return. */
280 #if defined(__GNUC__) \
281 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
282 #define NORETURN volatile
284 #define NORETURN /* nothing */
288 /* GCC 2.5 and later versions define a function attribute "noreturn",
289 which is the preferred way to declare that a function never returns.
290 However GCC 2.7 appears to be the first version in which this fully
291 works everywhere we use it. */
293 #ifndef ATTR_NORETURN
294 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
295 #define ATTR_NORETURN __attribute__ ((noreturn))
297 #define ATTR_NORETURN /* nothing */
302 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
303 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
305 #define ATTR_FORMAT(type, x, y) /* nothing */
309 /* Be conservative and use enum bitfields only with GCC.
310 This is copied from gcc 3.3.1, system.h. */
312 #if defined(__GNUC__) && (__GNUC__ >= 2)
313 #define ENUM_BITFIELD(TYPE) enum TYPE
315 #define ENUM_BITFIELD(TYPE) unsigned int
318 /* Needed for various prototypes */
323 /* From blockframe.c */
325 extern int inside_entry_func (CORE_ADDR
);
327 extern int deprecated_inside_entry_file (CORE_ADDR addr
);
329 extern int inside_main_func (CORE_ADDR pc
);
333 extern void initialize_utils (void);
335 extern void notice_quit (void);
337 extern int strcmp_iw (const char *, const char *);
339 extern int strcmp_iw_ordered (const char *, const char *);
341 extern int streq (const char *, const char *);
343 extern int subset_compare (char *, char *);
345 extern char *safe_strerror (int);
347 extern void init_malloc (void *);
349 extern void request_quit (int);
351 extern void do_cleanups (struct cleanup
*);
352 extern void do_final_cleanups (struct cleanup
*);
353 extern void do_my_cleanups (struct cleanup
**, 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);
407 extern void init_page_info (void);
409 extern char *gdb_realpath (const char *);
410 extern char *xfullpath (const char *);
412 extern unsigned long gnu_debuglink_crc32 (unsigned long crc
,
413 unsigned char *buf
, size_t len
);
415 /* From demangle.c */
417 extern void set_demangling_style (char *);
422 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
423 extern use_struct_convention_fn generic_use_struct_convention
;
426 /* Annotation stuff. */
428 extern int annotation_level
; /* in stack.c */
430 extern void begin_line (void);
432 extern void wrap_here (char *);
434 extern void reinitialize_more_filter (void);
437 extern struct ui_file
*gdb_stdout
;
439 extern struct ui_file
*gdb_stdin
;
440 /* Serious error notifications */
441 extern struct ui_file
*gdb_stderr
;
442 /* Log/debug/trace messages that should bypass normal stdout/stderr
443 filtering. For momement, always call this stream using
444 *_unfiltered. In the very near future that restriction shall be
445 removed - either call shall be unfiltered. (cagney 1999-06-13). */
446 extern struct ui_file
*gdb_stdlog
;
447 /* Target output that should bypass normal stdout/stderr filtering.
448 For momement, always call this stream using *_unfiltered. In the
449 very near future that restriction shall be removed - either call
450 shall be unfiltered. (cagney 1999-07-02). */
451 extern struct ui_file
*gdb_stdtarg
;
452 extern struct ui_file
*gdb_stdtargerr
;
453 extern struct ui_file
*gdb_stdtargin
;
461 /* More generic printf like operations. Filtered versions may return
462 non-locally on error. */
464 extern void fputs_filtered (const char *, struct ui_file
*);
466 extern void fputs_unfiltered (const char *, struct ui_file
*);
468 extern int fputc_filtered (int c
, struct ui_file
*);
470 extern int fputc_unfiltered (int c
, struct ui_file
*);
472 extern int putchar_filtered (int c
);
474 extern int putchar_unfiltered (int c
);
476 extern void puts_filtered (const char *);
478 extern void puts_unfiltered (const char *);
480 extern void puts_filtered_tabular (char *string
, int width
, int right
);
482 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
484 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
486 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
488 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
490 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
492 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
494 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
496 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
498 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
500 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
502 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
504 extern void print_spaces (int, struct ui_file
*);
506 extern void print_spaces_filtered (int, struct ui_file
*);
508 extern char *n_spaces (int);
510 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
512 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
514 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
516 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
517 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
519 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
520 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
522 extern int strlen_paddr (void);
523 extern char *paddr (CORE_ADDR addr
);
524 extern char *paddr_nz (CORE_ADDR addr
);
525 extern char *paddr_u (CORE_ADDR addr
);
526 extern char *paddr_d (LONGEST addr
);
528 extern char *phex (ULONGEST l
, int sizeof_l
);
529 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
531 /* Like paddr() only print/scan raw CORE_ADDR. The output from
532 core_addr_to_string() can be passed direct to
533 string_to_core_addr(). */
534 extern const char *core_addr_to_string (const CORE_ADDR addr
);
535 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
536 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
538 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
541 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
543 extern void print_sys_errmsg (const char *, int);
545 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
546 "const char *" in unistd.h, so we can't declare the argument
549 extern char *re_comp (const char *);
553 extern void symbol_file_command (char *, int);
555 /* Remote targets may wish to use this as their load function. */
556 extern void generic_load (char *name
, int from_tty
);
558 /* Summarise a download */
559 extern void print_transfer_performance (struct ui_file
*stream
,
560 unsigned long data_count
,
561 unsigned long write_count
,
562 unsigned long time_count
);
566 typedef void initialize_file_ftype (void);
568 extern char *skip_quoted (char *);
570 extern char *gdb_readline (char *);
572 extern char *gdb_readline_wrapper (char *);
574 extern char *command_line_input (char *, int, char *);
576 extern void print_prompt (void);
578 extern int input_from_terminal_p (void);
580 extern int info_verbose
;
582 /* From printcmd.c */
584 extern void set_next_address (CORE_ADDR
);
586 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
589 extern int build_address_symbolic (CORE_ADDR addr
,
597 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
599 extern void print_address (CORE_ADDR
, struct ui_file
*);
603 extern int openp (const char *, int, const char *, int, int, char **);
605 extern int source_full_path_of (char *, char **);
607 extern void mod_path (char *, char **);
609 extern void add_path (char *, char **, int);
611 extern void directory_command (char *, int);
613 extern char *source_path
;
615 extern void init_source_path (void);
617 extern void init_last_source_visited (void);
619 extern char *symtab_to_filename (struct symtab
*);
623 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
624 bfd_signed_vma data_off
,
625 bfd_signed_vma bss_off
);
627 /* Take over the 'find_mapped_memory' vector from exec.c. */
628 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
634 /* Possible lvalue types. Like enum language, this should be in
635 value.h, but needs to be here for the same reason. */
641 /* In memory. Could be a saved register. */
645 /* In a gdb internal variable. */
647 /* Part of a gdb internal variable (structure field). */
648 lval_internalvar_component
,
649 /* In a register series in a frame not the current one, which may have been
650 partially saved or saved in different places (otherwise would be
651 lval_register or lval_memory). */
652 lval_reg_frame_relative
657 /* Control types for commands */
659 enum misc_command_type
667 enum command_control_type
677 /* Structure for saved commands lines
678 (for breakpoints, defined commands, etc). */
682 struct command_line
*next
;
684 enum command_control_type control_type
;
686 struct command_line
**body_list
;
689 extern struct command_line
*read_command_lines (char *, int);
691 extern void free_command_lines (struct command_line
**);
693 /* To continue the execution commands when running gdb asynchronously.
694 A continuation structure contains a pointer to a function to be called
695 to finish the command, once the target has stopped. Such mechanism is
696 used bt the finish and until commands, and in the remote protocol
697 when opening an extended-remote connection. */
699 struct continuation_arg
701 struct continuation_arg
*next
;
702 union continuation_data
{
711 void (*continuation_hook
) (struct continuation_arg
*);
712 struct continuation_arg
*arg_list
;
713 struct continuation
*next
;
717 extern struct continuation
*cmd_continuation
;
718 /* Used only by the step_1 function. */
719 extern struct continuation
*intermediate_continuation
;
722 extern void add_continuation (void (*)(struct continuation_arg
*),
723 struct continuation_arg
*);
724 extern void do_all_continuations (void);
725 extern void discard_all_continuations (void);
727 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
728 struct continuation_arg
*);
729 extern void do_all_intermediate_continuations (void);
730 extern void discard_all_intermediate_continuations (void);
732 /* String containing the current directory (what getwd would return). */
734 extern char *current_directory
;
736 /* Default radixes for input and output. Only some values supported. */
737 extern unsigned input_radix
;
738 extern unsigned output_radix
;
740 /* Possibilities for prettyprint parameters to routines which print
741 things. Like enum language, this should be in value.h, but needs
742 to be here for the same reason. FIXME: If we can eliminate this
743 as an arg to LA_VAL_PRINT, then we can probably move it back to
748 Val_no_prettyprint
= 0,
750 /* Use the default setting which the user has specified. */
754 /* The ptid struct is a collection of the various "ids" necessary
755 for identifying the inferior. This consists of the process id
756 (pid), thread id (tid), and other fields necessary for uniquely
757 identifying the inferior process/thread being debugged. When
758 manipulating ptids, the constructors, accessors, and predicate
759 declared in inferior.h should be used. These are as follows:
761 ptid_build - Make a new ptid from a pid, lwp, and tid.
762 pid_to_ptid - Make a new ptid from just a pid.
763 ptid_get_pid - Fetch the pid component of a ptid.
764 ptid_get_lwp - Fetch the lwp component of a ptid.
765 ptid_get_tid - Fetch the tid component of a ptid.
766 ptid_equal - Test to see if two ptids are equal.
768 Please do NOT access the struct ptid members directly (except, of
769 course, in the implementation of the above ptid manipulation
777 /* Lightweight process id */
784 typedef struct ptid ptid_t
;
788 /* Optional host machine definition. Pure autoconf targets will not
789 need a "xm.h" file. This will be a symlink to one of the xm-*.h
790 files, built by the `configure' script. */
796 /* Optional native machine support. Non-native (and possibly pure
797 multi-arch) targets do not need a "nm.h" file. This will be a
798 symlink to one of the nm-*.h files, built by the `configure'
805 /* Optional target machine definition. Pure multi-arch configurations
806 do not need a "tm.h" file. This will be a symlink to one of the
807 tm-*.h files, built by the `configure' script. */
813 /* If the xm.h file did not define the mode string used to open the
814 files, assume that binary files are opened the same way as text
817 #include "fopen-same.h"
820 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
821 FIXME: Assumes 2's complement arithmetic */
823 #if !defined (UINT_MAX)
824 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
827 #if !defined (INT_MAX)
828 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
831 #if !defined (INT_MIN)
832 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
835 #if !defined (ULONG_MAX)
836 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
839 #if !defined (LONG_MAX)
840 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
843 #if !defined (ULONGEST_MAX)
844 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
847 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
848 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
851 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
852 arguments to a function, number in a value history, register number, etc.)
853 where the value must not be larger than can fit in an int. */
855 extern int longest_to_int (LONGEST
);
857 /* Assorted functions we can declare, now that const and volatile are
860 extern char *savestring (const char *, size_t);
862 extern char *msavestring (void *, const char *, size_t);
864 extern char *mstrsave (void *, const char *);
866 /* Robust versions of same. Throw an internal error when no memory,
867 guard against stray NULL arguments. */
868 extern void *xmmalloc (void *md
, size_t size
);
869 extern void *xmrealloc (void *md
, void *ptr
, size_t size
);
870 extern void *xmcalloc (void *md
, size_t number
, size_t size
);
871 extern void xmfree (void *md
, void *ptr
);
873 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
875 extern void xfree (void *);
877 /* Utility macros to allocate typed memory. Avoids errors like:
878 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
879 sizeof (struct foo), 0). */
880 #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE)))
881 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
882 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
884 /* Like asprintf/vasprintf but get an internal_error if the call
886 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
887 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
889 /* Like asprintf, but return the string, throw an error if no memory. */
890 extern char *xstrprintf (const char *format
, ...) ATTR_FORMAT (printf
, 1, 2);
892 extern int parse_escape (char **);
894 /* Message to be printed before the error message, when an error occurs. */
896 extern char *error_pre_print
;
898 /* Message to be printed before the error message, when an error occurs. */
900 extern char *quit_pre_print
;
902 /* Message to be printed before the warning message, when a warning occurs. */
904 extern char *warning_pre_print
;
906 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
908 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
910 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
912 /* Initialize the error buffer. */
913 extern void error_init (void);
915 /* Returns a freshly allocate buffer containing the last error
917 extern char *error_last_message (void);
919 extern NORETURN
void internal_verror (const char *file
, int line
,
920 const char *, va_list ap
) ATTR_NORETURN
;
922 extern NORETURN
void internal_error (const char *file
, int line
,
923 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
925 extern void internal_vwarning (const char *file
, int line
,
926 const char *, va_list ap
);
928 extern void internal_warning (const char *file
, int line
,
929 const char *, ...) ATTR_FORMAT (printf
, 3, 4);
931 extern NORETURN
void nomem (long) ATTR_NORETURN
;
933 /* Reasons for calling throw_exception(). NOTE: all reason values
934 must be less than zero. enum value 0 is reserved for internal use
935 as the return value from an initial setjmp(). The function
936 catch_exceptions() reserves values >= 0 as legal results from its
941 /* User interrupt. */
943 /* Any other error. */
947 #define ALL_CLEANUPS ((struct cleanup *)0)
949 #define RETURN_MASK(reason) (1 << (int)(-reason))
950 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
951 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
952 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
953 typedef int return_mask
;
955 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
956 to the inner most containing exception handler established using
957 catch_exceptions() (or the legacy catch_errors()).
959 Code normally throws an exception using error() et.al. For various
960 reaons, GDB also contains code that throws an exception directly.
961 For instance, the remote*.c targets contain CNTRL-C signal handlers
962 that propogate the QUIT event up the exception chain. ``This could
963 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
965 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
967 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
968 handler. If an exception (enum return_reason) is thrown using
969 throw_exception() than all cleanups installed since
970 catch_exceptions() was entered are invoked, the (-ve) exception
971 value is then returned by catch_exceptions. If FUNC() returns
972 normally (with a postive or zero return value) then that value is
973 returned by catch_exceptions(). It is an internal_error() for
974 FUNC() to return a negative value.
976 For the period of the FUNC() call: UIOUT is installed as the output
977 builder; ERRSTRING is installed as the error/quit message; and a
978 new cleanup_chain is established. The old values are restored
979 before catch_exceptions() returns.
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
);
994 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
995 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
996 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
997 value. It's unfortunate that, catch_errors() does not return an
998 indication of the exact exception that it caught - quit_flag might
1001 This function is superseeded by catch_exceptions(). */
1003 typedef int (catch_errors_ftype
) (void *);
1004 extern int catch_errors (catch_errors_ftype
*, void *, char *, return_mask
);
1006 /* Template to catch_errors() that wraps calls to command
1009 typedef void (catch_command_errors_ftype
) (char *, int);
1010 extern int catch_command_errors (catch_command_errors_ftype
*func
, char *command
, int from_tty
, return_mask
);
1012 extern void warning (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
1014 extern void vwarning (const char *, va_list args
);
1016 /* List of known OS ABIs. If you change this, make sure to update the
1017 table in osabi.c. */
1020 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
1022 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
1029 GDB_OSABI_FREEBSD_AOUT
,
1030 GDB_OSABI_FREEBSD_ELF
,
1031 GDB_OSABI_NETBSD_AOUT
,
1032 GDB_OSABI_NETBSD_ELF
,
1042 GDB_OSABI_ARM_EABI_V1
,
1043 GDB_OSABI_ARM_EABI_V2
,
1049 GDB_OSABI_INVALID
/* keep this last */
1052 /* Global functions from other, non-gdb GNU thingies.
1053 Libiberty thingies are no longer declared here. We include libiberty.h
1056 #ifndef GETENV_PROVIDED
1057 extern char *getenv (const char *);
1060 /* From other system libraries */
1062 #ifdef HAVE_STDDEF_H
1066 #ifdef HAVE_STDLIB_H
1070 #define min(a, b) ((a) < (b) ? (a) : (b))
1073 #define max(a, b) ((a) > (b) ? (a) : (b))
1077 /* We take the address of fclose later, but some stdio's forget
1078 to declare this. We can't always declare it since there's
1079 no way to declare the parameters without upsetting some compiler
1082 #ifndef FCLOSE_PROVIDED
1083 extern int fclose (FILE *);
1087 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1090 /* Various possibilities for alloca. */
1093 #define alloca __builtin_alloca
1094 #else /* Not GNU C */
1095 #ifdef HAVE_ALLOCA_H
1102 /* We need to be careful not to declare this in a way which conflicts with
1103 bison. Bison never declares it as char *, but under various circumstances
1104 (like __hpux) we need to use void *. */
1105 extern void *alloca ();
1106 #endif /* Not _AIX */
1107 #endif /* Not HAVE_ALLOCA_H */
1108 #endif /* Not GNU C */
1109 #endif /* alloca not defined */
1111 /* Is GDB multi-arch? If there's a "tm.h" file, it is not. */
1112 #ifndef GDB_MULTI_ARCH
1114 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PARTIAL
1116 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PURE
1120 /* Dynamic target-system-dependent parameters for GDB. */
1121 #include "gdbarch.h"
1123 /* Maximum size of a register. Something small, but large enough for
1124 all known ISAs. If it turns out to be too small, make it bigger. */
1126 enum { MAX_REGISTER_SIZE
= 16 };
1128 /* Static target-system-dependent parameters for GDB. */
1130 /* Number of bits in a char or unsigned char for the target machine.
1131 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1132 #if !defined (TARGET_CHAR_BIT)
1133 #define TARGET_CHAR_BIT 8
1136 /* If we picked up a copy of CHAR_BIT from a configuration file
1137 (which may get it by including <limits.h>) then use it to set
1138 the number of bits in a host char. If not, use the same size
1141 #if defined (CHAR_BIT)
1142 #define HOST_CHAR_BIT CHAR_BIT
1144 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1147 /* The bit byte-order has to do just with numbering of bits in
1148 debugging symbols and such. Conceptually, it's quite separate
1149 from byte/word byte order. */
1151 #if !defined (BITS_BIG_ENDIAN)
1152 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1157 extern LONGEST
extract_signed_integer (const void *, int);
1159 extern ULONGEST
extract_unsigned_integer (const void *, int);
1161 extern int extract_long_unsigned_integer (const void *, int, LONGEST
*);
1163 extern CORE_ADDR
extract_typed_address (const void *buf
, struct type
*type
);
1165 extern void store_signed_integer (void *, int, LONGEST
);
1167 extern void store_unsigned_integer (void *, int, ULONGEST
);
1169 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1174 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1176 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1178 extern int watchdog
;
1180 /* Hooks for alternate command interfaces. */
1182 /* The name of the interpreter if specified on the command line. */
1183 extern char *interpreter_p
;
1185 /* If a given interpreter matches INTERPRETER_P then it should update
1186 command_loop_hook and init_ui_hook with the per-interpreter
1188 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1190 struct target_waitstatus
;
1191 struct cmd_list_element
;
1193 /* Should the asynchronous variant of the interpreter (using the
1194 event-loop) be enabled? */
1195 extern int event_loop_p
;
1197 extern void (*init_ui_hook
) (char *argv0
);
1198 extern void (*command_loop_hook
) (void);
1199 extern void (*show_load_progress
) (const char *section
,
1200 unsigned long section_sent
,
1201 unsigned long section_size
,
1202 unsigned long total_sent
,
1203 unsigned long total_size
);
1204 extern void (*print_frame_info_listing_hook
) (struct symtab
* s
,
1205 int line
, int stopline
,
1207 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1208 extern int (*query_hook
) (const char *, va_list);
1209 extern void (*warning_hook
) (const char *, va_list);
1210 extern void (*flush_hook
) (struct ui_file
* stream
);
1211 extern void (*create_breakpoint_hook
) (struct breakpoint
* b
);
1212 extern void (*delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1213 extern void (*modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1214 extern void (*interactive_hook
) (void);
1215 extern void (*registers_changed_hook
) (void);
1216 extern void (*readline_begin_hook
) (char *,...);
1217 extern char *(*readline_hook
) (char *);
1218 extern void (*readline_end_hook
) (void);
1219 extern void (*register_changed_hook
) (int regno
);
1220 extern void (*memory_changed_hook
) (CORE_ADDR addr
, int len
);
1221 extern void (*context_hook
) (int);
1222 extern ptid_t (*target_wait_hook
) (ptid_t ptid
,
1223 struct target_waitstatus
* status
);
1225 extern void (*attach_hook
) (void);
1226 extern void (*detach_hook
) (void);
1227 extern void (*call_command_hook
) (struct cmd_list_element
* c
,
1228 char *cmd
, int from_tty
);
1230 extern void (*set_hook
) (struct cmd_list_element
* c
);
1232 extern NORETURN
void (*error_hook
) (void) ATTR_NORETURN
;
1234 extern void (*error_begin_hook
) (void);
1236 extern int (*ui_load_progress_hook
) (const char *section
, unsigned long num
);
1239 /* Inhibit window interface if non-zero. */
1241 extern int use_windows
;
1243 /* Symbolic definitions of filename-related things. */
1244 /* FIXME, this doesn't work very well if host and executable
1245 filesystems conventions are different. */
1247 #ifndef DIRNAME_SEPARATOR
1248 #define DIRNAME_SEPARATOR ':'
1251 #ifndef SLASH_STRING
1252 #define SLASH_STRING "/"
1257 # define GLOBAL_CURDIR
1260 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1261 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1262 in the code actually refer to a lightweight process id, i.e,
1263 something that can be considered a process id in its own right for
1264 certain purposes. */
1267 #define PIDGET(PTID) (ptid_get_pid (PTID))
1268 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1269 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1272 /* Define well known filenos if the system does not define them. */
1273 #ifndef STDIN_FILENO
1274 #define STDIN_FILENO 0
1276 #ifndef STDOUT_FILENO
1277 #define STDOUT_FILENO 1
1279 #ifndef STDERR_FILENO
1280 #define STDERR_FILENO 2
1283 /* If this definition isn't overridden by the header files, assume
1284 that isatty and fileno exist on this system. */
1286 #define ISATTY(FP) (isatty (fileno (FP)))
1289 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1290 power of 2). Round up/down when necessary. Examples of correct
1293 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1294 write_memory (addr, value, len);
1299 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1300 write_memory (sp, value, len);
1302 Note that uses such as:
1304 write_memory (addr, value, len);
1305 addr += align_up (len, 8);
1309 sp -= align_up (len, 8);
1310 write_memory (sp, value, len);
1312 are typically not correct as they don't ensure that the address (SP
1313 or ADDR) is correctly aligned (relying on previous alignment to
1314 keep things right). This is also why the methods are called
1315 "align_..." instead of "round_..." as the latter reads better with
1316 this incorrect coding style. */
1318 extern ULONGEST
align_up (ULONGEST v
, int n
);
1319 extern ULONGEST
align_down (ULONGEST v
, int n
);
1321 #endif /* #ifndef DEFS_H */