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 /* DISCLAIMER: cagney/2003-11-23: Simplified definition of these
164 macros so that they just map directly onto strcmp equivalent. I'm
165 not responsible for any breakage due to code that relied on the old
166 underlying implementation. */
168 #define DEPRECATED_STREQ(a,b) (strcmp ((a), (b)) == 0)
169 #define DEPRECATED_STREQN(a,b,c) (strncmp ((a), (b), (c)) == 0)
171 /* Check if a character is one of the commonly used C++ marker characters. */
172 extern int is_cplus_marker (int);
174 /* enable xdb commands if set */
175 extern int xdb_commands
;
177 /* enable dbx commands if set */
178 extern int dbx_commands
;
180 /* System root path, used to find libraries etc. */
181 extern char *gdb_sysroot
;
183 extern int quit_flag
;
184 extern int immediate_quit
;
185 extern int sevenbit_strings
;
187 extern void quit (void);
189 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
190 benefits of having a ``QUIT'' macro rather than a function are
191 marginal. If the overhead of a QUIT function call is proving
192 significant then its calling frequency should probably be reduced
193 [kingdon]. A profile analyzing the current situtation is
197 /* do twice to force compiler warning */
198 #define QUIT_FIXME "FIXME"
199 #define QUIT_FIXME "ignoring redefinition of QUIT"
202 if (quit_flag) quit (); \
203 if (interactive_hook) interactive_hook (); \
208 /* Languages represented in the symbol table and elsewhere.
209 This should probably be in language.h, but since enum's can't
210 be forward declared to satisfy opaque references before their
211 actual definition, needs to be here. */
215 language_unknown
, /* Language not known */
216 language_auto
, /* Placeholder for automatic setting */
218 language_cplus
, /* C++ */
219 language_objc
, /* Objective-C */
220 language_java
, /* Java */
221 language_fortran
, /* Fortran */
222 language_m2
, /* Modula-2 */
223 language_asm
, /* Assembly language */
224 language_scm
, /* Scheme / Guile */
225 language_pascal
, /* Pascal */
226 language_minimal
/* All other languages, minimal support only */
233 unspecified_precision
236 /* A generic, not quite boolean, enumeration. */
244 /* Potential ways that a function can return a value of a given type. */
245 enum return_value_convention
247 /* Where the return value has been squeezed into one or more
249 RETURN_VALUE_REGISTER_CONVENTION
,
250 /* Commonly known as the "struct return convention". The caller
251 passes an additional hidden first parameter to the caller. That
252 parameter contains the address at which the value being returned
253 should be stored. While typically, and historically, used for
254 large structs, this is convention is applied to values of many
256 RETURN_VALUE_STRUCT_CONVENTION
259 /* the cleanup list records things that have to be undone
260 if an error happens (descriptors to be closed, memory to be freed, etc.)
261 Each link in the chain records a function to call and an
264 Use make_cleanup to add an element to the cleanup chain.
265 Use do_cleanups to do all cleanup actions back to a given
266 point in the chain. Use discard_cleanups to remove cleanups
267 from the chain back to a given point, not doing them. */
271 struct cleanup
*next
;
272 void (*function
) (void *);
277 /* The ability to declare that a function never returns is useful, but
278 not really required to compile GDB successfully, so the NORETURN and
279 ATTR_NORETURN macros normally expand into nothing. */
281 /* If compiling with older versions of GCC, a function may be declared
282 "volatile" to indicate that it does not return. */
285 #if defined(__GNUC__) \
286 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
287 #define NORETURN volatile
289 #define NORETURN /* nothing */
293 /* GCC 2.5 and later versions define a function attribute "noreturn",
294 which is the preferred way to declare that a function never returns.
295 However GCC 2.7 appears to be the first version in which this fully
296 works everywhere we use it. */
298 #ifndef ATTR_NORETURN
299 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
300 #define ATTR_NORETURN __attribute__ ((noreturn))
302 #define ATTR_NORETURN /* nothing */
307 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
308 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
310 #define ATTR_FORMAT(type, x, y) /* nothing */
314 /* Be conservative and use enum bitfields only with GCC.
315 This is copied from gcc 3.3.1, system.h. */
317 #if defined(__GNUC__) && (__GNUC__ >= 2)
318 #define ENUM_BITFIELD(TYPE) enum TYPE
320 #define ENUM_BITFIELD(TYPE) unsigned int
323 /* Needed for various prototypes */
328 /* From blockframe.c */
330 extern int inside_entry_func (CORE_ADDR
);
332 extern int deprecated_inside_entry_file (CORE_ADDR addr
);
334 extern int inside_main_func (CORE_ADDR pc
);
338 extern void initialize_utils (void);
340 extern void notice_quit (void);
342 extern int strcmp_iw (const char *, const char *);
344 extern int strcmp_iw_ordered (const char *, const char *);
346 extern int streq (const char *, const char *);
348 extern int subset_compare (char *, char *);
350 extern char *safe_strerror (int);
352 extern void init_malloc (void *);
354 extern void request_quit (int);
356 extern void do_cleanups (struct cleanup
*);
357 extern void do_final_cleanups (struct cleanup
*);
358 extern void do_my_cleanups (struct cleanup
**, struct cleanup
*);
359 extern void do_run_cleanups (struct cleanup
*);
360 extern void do_exec_cleanups (struct cleanup
*);
361 extern void do_exec_error_cleanups (struct cleanup
*);
363 extern void discard_cleanups (struct cleanup
*);
364 extern void discard_final_cleanups (struct cleanup
*);
365 extern void discard_exec_error_cleanups (struct cleanup
*);
366 extern void discard_my_cleanups (struct cleanup
**, struct cleanup
*);
368 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
369 make_cleanup function declarations below. Do not use this typedef
370 as a cast when passing functions into the make_cleanup() code.
371 Instead either use a bounce function or add a wrapper function.
372 Calling a f(char*) function with f(void*) is non-portable. */
373 typedef void (make_cleanup_ftype
) (void *);
375 extern struct cleanup
*make_cleanup (make_cleanup_ftype
*, void *);
377 extern struct cleanup
*make_cleanup_freeargv (char **);
380 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
382 extern struct cleanup
*make_cleanup_close (int fd
);
384 extern struct cleanup
*make_cleanup_bfd_close (bfd
*abfd
);
386 extern struct cleanup
*make_final_cleanup (make_cleanup_ftype
*, void *);
388 extern struct cleanup
*make_my_cleanup (struct cleanup
**,
389 make_cleanup_ftype
*, void *);
391 extern struct cleanup
*make_run_cleanup (make_cleanup_ftype
*, void *);
393 extern struct cleanup
*make_exec_cleanup (make_cleanup_ftype
*, void *);
394 extern struct cleanup
*make_exec_error_cleanup (make_cleanup_ftype
*, void *);
396 extern struct cleanup
*save_cleanups (void);
397 extern struct cleanup
*save_final_cleanups (void);
398 extern struct cleanup
*save_my_cleanups (struct cleanup
**);
400 extern void restore_cleanups (struct cleanup
*);
401 extern void restore_final_cleanups (struct cleanup
*);
402 extern void restore_my_cleanups (struct cleanup
**, struct cleanup
*);
404 extern void free_current_contents (void *);
406 extern void null_cleanup (void *);
408 extern int myread (int, char *, int);
410 extern int query (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
412 extern void init_page_info (void);
414 extern char *gdb_realpath (const char *);
415 extern char *xfullpath (const char *);
417 extern unsigned long gnu_debuglink_crc32 (unsigned long crc
,
418 unsigned char *buf
, size_t len
);
420 /* From demangle.c */
422 extern void set_demangling_style (char *);
427 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
428 extern use_struct_convention_fn generic_use_struct_convention
;
431 /* Annotation stuff. */
433 extern int annotation_level
; /* in stack.c */
435 extern void begin_line (void);
437 extern void wrap_here (char *);
439 extern void reinitialize_more_filter (void);
442 extern struct ui_file
*gdb_stdout
;
444 extern struct ui_file
*gdb_stdin
;
445 /* Serious error notifications */
446 extern struct ui_file
*gdb_stderr
;
447 /* Log/debug/trace messages that should bypass normal stdout/stderr
448 filtering. For momement, always call this stream using
449 *_unfiltered. In the very near future that restriction shall be
450 removed - either call shall be unfiltered. (cagney 1999-06-13). */
451 extern struct ui_file
*gdb_stdlog
;
452 /* Target output that should bypass normal stdout/stderr filtering.
453 For momement, always call this stream using *_unfiltered. In the
454 very near future that restriction shall be removed - either call
455 shall be unfiltered. (cagney 1999-07-02). */
456 extern struct ui_file
*gdb_stdtarg
;
457 extern struct ui_file
*gdb_stdtargerr
;
458 extern struct ui_file
*gdb_stdtargin
;
466 /* More generic printf like operations. Filtered versions may return
467 non-locally on error. */
469 extern void fputs_filtered (const char *, struct ui_file
*);
471 extern void fputs_unfiltered (const char *, struct ui_file
*);
473 extern int fputc_filtered (int c
, struct ui_file
*);
475 extern int fputc_unfiltered (int c
, struct ui_file
*);
477 extern int putchar_filtered (int c
);
479 extern int putchar_unfiltered (int c
);
481 extern void puts_filtered (const char *);
483 extern void puts_unfiltered (const char *);
485 extern void puts_filtered_tabular (char *string
, int width
, int right
);
487 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
489 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
491 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
493 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
495 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
497 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
499 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
501 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
503 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
505 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
507 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
509 extern void print_spaces (int, struct ui_file
*);
511 extern void print_spaces_filtered (int, struct ui_file
*);
513 extern char *n_spaces (int);
515 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
517 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
519 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
521 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
522 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
524 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
525 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
527 extern int strlen_paddr (void);
528 extern char *paddr (CORE_ADDR addr
);
529 extern char *paddr_nz (CORE_ADDR addr
);
530 extern char *paddr_u (CORE_ADDR addr
);
531 extern char *paddr_d (LONGEST addr
);
533 extern char *phex (ULONGEST l
, int sizeof_l
);
534 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
536 /* Like paddr() only print/scan raw CORE_ADDR. The output from
537 core_addr_to_string() can be passed direct to
538 string_to_core_addr(). */
539 extern const char *core_addr_to_string (const CORE_ADDR addr
);
540 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
541 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
543 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
546 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
548 extern void print_sys_errmsg (const char *, int);
550 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
551 "const char *" in unistd.h, so we can't declare the argument
554 extern char *re_comp (const char *);
558 extern void symbol_file_command (char *, int);
560 /* Remote targets may wish to use this as their load function. */
561 extern void generic_load (char *name
, int from_tty
);
563 /* Summarise a download */
564 extern void print_transfer_performance (struct ui_file
*stream
,
565 unsigned long data_count
,
566 unsigned long write_count
,
567 unsigned long time_count
);
571 typedef void initialize_file_ftype (void);
573 extern char *skip_quoted (char *);
575 extern char *gdb_readline (char *);
577 extern char *gdb_readline_wrapper (char *);
579 extern char *command_line_input (char *, int, char *);
581 extern void print_prompt (void);
583 extern int input_from_terminal_p (void);
585 extern int info_verbose
;
587 /* From printcmd.c */
589 extern void set_next_address (CORE_ADDR
);
591 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
594 extern int build_address_symbolic (CORE_ADDR addr
,
602 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
604 extern void print_address (CORE_ADDR
, struct ui_file
*);
608 extern int openp (const char *, int, const char *, int, int, char **);
610 extern int source_full_path_of (char *, char **);
612 extern void mod_path (char *, char **);
614 extern void add_path (char *, char **, int);
616 extern void directory_command (char *, int);
618 extern char *source_path
;
620 extern void init_source_path (void);
622 extern void init_last_source_visited (void);
624 extern char *symtab_to_filename (struct symtab
*);
628 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
629 bfd_signed_vma data_off
,
630 bfd_signed_vma bss_off
);
632 /* Take over the 'find_mapped_memory' vector from exec.c. */
633 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
639 /* Possible lvalue types. Like enum language, this should be in
640 value.h, but needs to be here for the same reason. */
646 /* In memory. Could be a saved register. */
650 /* In a gdb internal variable. */
652 /* Part of a gdb internal variable (structure field). */
653 lval_internalvar_component
,
654 /* In a register series in a frame not the current one, which may have been
655 partially saved or saved in different places (otherwise would be
656 lval_register or lval_memory). */
657 lval_reg_frame_relative
662 /* Control types for commands */
664 enum misc_command_type
672 enum command_control_type
682 /* Structure for saved commands lines
683 (for breakpoints, defined commands, etc). */
687 struct command_line
*next
;
689 enum command_control_type control_type
;
691 struct command_line
**body_list
;
694 extern struct command_line
*read_command_lines (char *, int);
696 extern void free_command_lines (struct command_line
**);
698 /* To continue the execution commands when running gdb asynchronously.
699 A continuation structure contains a pointer to a function to be called
700 to finish the command, once the target has stopped. Such mechanism is
701 used bt the finish and until commands, and in the remote protocol
702 when opening an extended-remote connection. */
704 struct continuation_arg
706 struct continuation_arg
*next
;
707 union continuation_data
{
716 void (*continuation_hook
) (struct continuation_arg
*);
717 struct continuation_arg
*arg_list
;
718 struct continuation
*next
;
722 extern struct continuation
*cmd_continuation
;
723 /* Used only by the step_1 function. */
724 extern struct continuation
*intermediate_continuation
;
727 extern void add_continuation (void (*)(struct continuation_arg
*),
728 struct continuation_arg
*);
729 extern void do_all_continuations (void);
730 extern void discard_all_continuations (void);
732 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
733 struct continuation_arg
*);
734 extern void do_all_intermediate_continuations (void);
735 extern void discard_all_intermediate_continuations (void);
737 /* String containing the current directory (what getwd would return). */
739 extern char *current_directory
;
741 /* Default radixes for input and output. Only some values supported. */
742 extern unsigned input_radix
;
743 extern unsigned output_radix
;
745 /* Possibilities for prettyprint parameters to routines which print
746 things. Like enum language, this should be in value.h, but needs
747 to be here for the same reason. FIXME: If we can eliminate this
748 as an arg to LA_VAL_PRINT, then we can probably move it back to
753 Val_no_prettyprint
= 0,
755 /* Use the default setting which the user has specified. */
759 /* The ptid struct is a collection of the various "ids" necessary
760 for identifying the inferior. This consists of the process id
761 (pid), thread id (tid), and other fields necessary for uniquely
762 identifying the inferior process/thread being debugged. When
763 manipulating ptids, the constructors, accessors, and predicate
764 declared in inferior.h should be used. These are as follows:
766 ptid_build - Make a new ptid from a pid, lwp, and tid.
767 pid_to_ptid - Make a new ptid from just a pid.
768 ptid_get_pid - Fetch the pid component of a ptid.
769 ptid_get_lwp - Fetch the lwp component of a ptid.
770 ptid_get_tid - Fetch the tid component of a ptid.
771 ptid_equal - Test to see if two ptids are equal.
773 Please do NOT access the struct ptid members directly (except, of
774 course, in the implementation of the above ptid manipulation
782 /* Lightweight process id */
789 typedef struct ptid ptid_t
;
793 /* Optional host machine definition. Pure autoconf targets will not
794 need a "xm.h" file. This will be a symlink to one of the xm-*.h
795 files, built by the `configure' script. */
801 /* Optional native machine support. Non-native (and possibly pure
802 multi-arch) targets do not need a "nm.h" file. This will be a
803 symlink to one of the nm-*.h files, built by the `configure'
810 /* Optional target machine definition. Pure multi-arch configurations
811 do not need a "tm.h" file. This will be a symlink to one of the
812 tm-*.h files, built by the `configure' script. */
818 /* If the xm.h file did not define the mode string used to open the
819 files, assume that binary files are opened the same way as text
822 #include "fopen-same.h"
825 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
826 FIXME: Assumes 2's complement arithmetic */
828 #if !defined (UINT_MAX)
829 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
832 #if !defined (INT_MAX)
833 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
836 #if !defined (INT_MIN)
837 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
840 #if !defined (ULONG_MAX)
841 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
844 #if !defined (LONG_MAX)
845 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
848 #if !defined (ULONGEST_MAX)
849 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
852 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
853 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
856 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
857 arguments to a function, number in a value history, register number, etc.)
858 where the value must not be larger than can fit in an int. */
860 extern int longest_to_int (LONGEST
);
862 /* Assorted functions we can declare, now that const and volatile are
865 extern char *savestring (const char *, size_t);
867 extern char *msavestring (void *, const char *, size_t);
869 extern char *mstrsave (void *, const char *);
871 /* Robust versions of same. Throw an internal error when no memory,
872 guard against stray NULL arguments. */
873 extern void *xmmalloc (void *md
, size_t size
);
874 extern void *xmrealloc (void *md
, void *ptr
, size_t size
);
875 extern void *xmcalloc (void *md
, size_t number
, size_t size
);
876 extern void xmfree (void *md
, void *ptr
);
878 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
880 extern void xfree (void *);
882 /* Utility macros to allocate typed memory. Avoids errors like:
883 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
884 sizeof (struct foo), 0). */
885 #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE)))
886 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
887 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
889 /* Like asprintf/vasprintf but get an internal_error if the call
891 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
892 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
894 /* Like asprintf, but return the string, throw an error if no memory. */
895 extern char *xstrprintf (const char *format
, ...) ATTR_FORMAT (printf
, 1, 2);
897 extern int parse_escape (char **);
899 /* Message to be printed before the error message, when an error occurs. */
901 extern char *error_pre_print
;
903 /* Message to be printed before the error message, when an error occurs. */
905 extern char *quit_pre_print
;
907 /* Message to be printed before the warning message, when a warning occurs. */
909 extern char *warning_pre_print
;
911 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
913 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
915 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
917 /* Initialize the error buffer. */
918 extern void error_init (void);
920 /* Returns a freshly allocate buffer containing the last error
922 extern char *error_last_message (void);
924 extern NORETURN
void internal_verror (const char *file
, int line
,
925 const char *, va_list ap
) ATTR_NORETURN
;
927 extern NORETURN
void internal_error (const char *file
, int line
,
928 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
930 extern void internal_vwarning (const char *file
, int line
,
931 const char *, va_list ap
);
933 extern void internal_warning (const char *file
, int line
,
934 const char *, ...) ATTR_FORMAT (printf
, 3, 4);
936 extern NORETURN
void nomem (long) ATTR_NORETURN
;
938 /* Reasons for calling throw_exception(). NOTE: all reason values
939 must be less than zero. enum value 0 is reserved for internal use
940 as the return value from an initial setjmp(). The function
941 catch_exceptions() reserves values >= 0 as legal results from its
946 /* User interrupt. */
948 /* Any other error. */
952 #define ALL_CLEANUPS ((struct cleanup *)0)
954 #define RETURN_MASK(reason) (1 << (int)(-reason))
955 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
956 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
957 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
958 typedef int return_mask
;
960 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
961 to the inner most containing exception handler established using
962 catch_exceptions() (or the legacy catch_errors()).
964 Code normally throws an exception using error() et.al. For various
965 reaons, GDB also contains code that throws an exception directly.
966 For instance, the remote*.c targets contain CNTRL-C signal handlers
967 that propogate the QUIT event up the exception chain. ``This could
968 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
970 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
972 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
973 handler. If an exception (enum return_reason) is thrown using
974 throw_exception() than all cleanups installed since
975 catch_exceptions() was entered are invoked, the (-ve) exception
976 value is then returned by catch_exceptions. If FUNC() returns
977 normally (with a postive or zero return value) then that value is
978 returned by catch_exceptions(). It is an internal_error() for
979 FUNC() to return a negative value.
981 For the period of the FUNC() call: UIOUT is installed as the output
982 builder; ERRSTRING is installed as the error/quit message; and a
983 new cleanup_chain is established. The old values are restored
984 before catch_exceptions() returns.
986 FIXME; cagney/2001-08-13: The need to override the global UIOUT
987 builder variable should just go away.
989 This function superseeds catch_errors().
991 This function uses SETJMP() and LONGJUMP(). */
994 typedef int (catch_exceptions_ftype
) (struct ui_out
*ui_out
, void *args
);
995 extern int catch_exceptions (struct ui_out
*uiout
,
996 catch_exceptions_ftype
*func
, void *func_args
,
997 char *errstring
, return_mask mask
);
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
,
1047 GDB_OSABI_ARM_EABI_V1
,
1048 GDB_OSABI_ARM_EABI_V2
,
1054 GDB_OSABI_INVALID
/* keep this last */
1057 /* Global functions from other, non-gdb GNU thingies.
1058 Libiberty thingies are no longer declared here. We include libiberty.h
1061 #ifndef GETENV_PROVIDED
1062 extern char *getenv (const char *);
1065 /* From other system libraries */
1067 #ifdef HAVE_STDDEF_H
1071 #ifdef HAVE_STDLIB_H
1075 #define min(a, b) ((a) < (b) ? (a) : (b))
1078 #define max(a, b) ((a) > (b) ? (a) : (b))
1082 /* We take the address of fclose later, but some stdio's forget
1083 to declare this. We can't always declare it since there's
1084 no way to declare the parameters without upsetting some compiler
1087 #ifndef FCLOSE_PROVIDED
1088 extern int fclose (FILE *);
1092 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1095 /* Various possibilities for alloca. */
1098 #define alloca __builtin_alloca
1099 #else /* Not GNU C */
1100 #ifdef HAVE_ALLOCA_H
1107 /* We need to be careful not to declare this in a way which conflicts with
1108 bison. Bison never declares it as char *, but under various circumstances
1109 (like __hpux) we need to use void *. */
1110 extern void *alloca ();
1111 #endif /* Not _AIX */
1112 #endif /* Not HAVE_ALLOCA_H */
1113 #endif /* Not GNU C */
1114 #endif /* alloca not defined */
1116 /* Is GDB multi-arch? If there's a "tm.h" file, it is not. */
1117 #ifndef GDB_MULTI_ARCH
1119 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PARTIAL
1121 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PURE
1125 /* Dynamic target-system-dependent parameters for GDB. */
1126 #include "gdbarch.h"
1128 /* Maximum size of a register. Something small, but large enough for
1129 all known ISAs. If it turns out to be too small, make it bigger. */
1131 enum { MAX_REGISTER_SIZE
= 16 };
1133 /* Static target-system-dependent parameters for GDB. */
1135 /* Number of bits in a char or unsigned char for the target machine.
1136 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1137 #if !defined (TARGET_CHAR_BIT)
1138 #define TARGET_CHAR_BIT 8
1141 /* If we picked up a copy of CHAR_BIT from a configuration file
1142 (which may get it by including <limits.h>) then use it to set
1143 the number of bits in a host char. If not, use the same size
1146 #if defined (CHAR_BIT)
1147 #define HOST_CHAR_BIT CHAR_BIT
1149 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1152 /* The bit byte-order has to do just with numbering of bits in
1153 debugging symbols and such. Conceptually, it's quite separate
1154 from byte/word byte order. */
1156 #if !defined (BITS_BIG_ENDIAN)
1157 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1162 extern LONGEST
extract_signed_integer (const void *, int);
1164 extern ULONGEST
extract_unsigned_integer (const void *, int);
1166 extern int extract_long_unsigned_integer (const void *, int, LONGEST
*);
1168 extern CORE_ADDR
extract_typed_address (const void *buf
, struct type
*type
);
1170 extern void store_signed_integer (void *, int, LONGEST
);
1172 extern void store_unsigned_integer (void *, int, ULONGEST
);
1174 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1179 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1181 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1183 extern int watchdog
;
1185 /* Hooks for alternate command interfaces. */
1187 /* The name of the interpreter if specified on the command line. */
1188 extern char *interpreter_p
;
1190 /* If a given interpreter matches INTERPRETER_P then it should update
1191 command_loop_hook and init_ui_hook with the per-interpreter
1193 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1195 struct target_waitstatus
;
1196 struct cmd_list_element
;
1198 /* Should the asynchronous variant of the interpreter (using the
1199 event-loop) be enabled? */
1200 extern int event_loop_p
;
1202 extern void (*init_ui_hook
) (char *argv0
);
1203 extern void (*command_loop_hook
) (void);
1204 extern void (*show_load_progress
) (const char *section
,
1205 unsigned long section_sent
,
1206 unsigned long section_size
,
1207 unsigned long total_sent
,
1208 unsigned long total_size
);
1209 extern void (*print_frame_info_listing_hook
) (struct symtab
* s
,
1210 int line
, int stopline
,
1212 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1213 extern int (*query_hook
) (const char *, va_list);
1214 extern void (*warning_hook
) (const char *, va_list);
1215 extern void (*flush_hook
) (struct ui_file
* stream
);
1216 extern void (*create_breakpoint_hook
) (struct breakpoint
* b
);
1217 extern void (*delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1218 extern void (*modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1219 extern void (*interactive_hook
) (void);
1220 extern void (*registers_changed_hook
) (void);
1221 extern void (*readline_begin_hook
) (char *,...);
1222 extern char *(*readline_hook
) (char *);
1223 extern void (*readline_end_hook
) (void);
1224 extern void (*register_changed_hook
) (int regno
);
1225 extern void (*memory_changed_hook
) (CORE_ADDR addr
, int len
);
1226 extern void (*context_hook
) (int);
1227 extern ptid_t (*target_wait_hook
) (ptid_t ptid
,
1228 struct target_waitstatus
* status
);
1230 extern void (*attach_hook
) (void);
1231 extern void (*detach_hook
) (void);
1232 extern void (*call_command_hook
) (struct cmd_list_element
* c
,
1233 char *cmd
, int from_tty
);
1235 extern void (*set_hook
) (struct cmd_list_element
* c
);
1237 extern NORETURN
void (*error_hook
) (void) ATTR_NORETURN
;
1239 extern void (*error_begin_hook
) (void);
1241 extern int (*ui_load_progress_hook
) (const char *section
, unsigned long num
);
1244 /* Inhibit window interface if non-zero. */
1246 extern int use_windows
;
1248 /* Symbolic definitions of filename-related things. */
1249 /* FIXME, this doesn't work very well if host and executable
1250 filesystems conventions are different. */
1252 #ifndef DIRNAME_SEPARATOR
1253 #define DIRNAME_SEPARATOR ':'
1256 #ifndef SLASH_STRING
1257 #define SLASH_STRING "/"
1262 # define GLOBAL_CURDIR
1265 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1266 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1267 in the code actually refer to a lightweight process id, i.e,
1268 something that can be considered a process id in its own right for
1269 certain purposes. */
1272 #define PIDGET(PTID) (ptid_get_pid (PTID))
1273 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1274 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1277 /* Define well known filenos if the system does not define them. */
1278 #ifndef STDIN_FILENO
1279 #define STDIN_FILENO 0
1281 #ifndef STDOUT_FILENO
1282 #define STDOUT_FILENO 1
1284 #ifndef STDERR_FILENO
1285 #define STDERR_FILENO 2
1288 /* If this definition isn't overridden by the header files, assume
1289 that isatty and fileno exist on this system. */
1291 #define ISATTY(FP) (isatty (fileno (FP)))
1294 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1295 power of 2). Round up/down when necessary. Examples of correct
1298 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1299 write_memory (addr, value, len);
1304 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1305 write_memory (sp, value, len);
1307 Note that uses such as:
1309 write_memory (addr, value, len);
1310 addr += align_up (len, 8);
1314 sp -= align_up (len, 8);
1315 write_memory (sp, value, len);
1317 are typically not correct as they don't ensure that the address (SP
1318 or ADDR) is correctly aligned (relying on previous alignment to
1319 keep things right). This is also why the methods are called
1320 "align_..." instead of "round_..." as the latter reads better with
1321 this incorrect coding style. */
1323 extern ULONGEST
align_up (ULONGEST v
, int n
);
1324 extern ULONGEST
align_down (ULONGEST v
, int n
);
1326 #endif /* #ifndef DEFS_H */