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_minimal
, /* All other languages, minimal support only */
208 unspecified_precision
211 /* A generic, not quite boolean, enumeration. */
219 /* Potential ways that a function can return a value of a given type. */
220 enum return_value_convention
222 /* Where the return value has been squeezed into one or more
224 RETURN_VALUE_REGISTER_CONVENTION
,
225 /* Commonly known as the "struct return convention". The caller
226 passes an additional hidden first parameter to the caller. That
227 parameter contains the address at which the value being returned
228 should be stored. While typically, and historically, used for
229 large structs, this is convention is applied to values of many
231 RETURN_VALUE_STRUCT_CONVENTION
,
232 /* Like the "struct return convention" above, but where the ABI
233 guarantees that the called function stores the address at which
234 the value being returned is stored in a well-defined location,
235 such as a register or memory slot in the stack frame. Don't use
236 this if the ABI doesn't explicitly guarantees this. */
237 RETURN_VALUE_ABI_RETURNS_ADDRESS
,
238 /* Like the "struct return convention" above, but where the ABI
239 guarantees that the address at which the value being returned is
240 stored will be available in a well-defined location, such as a
241 register or memory slot in the stack frame. Don't use this if
242 the ABI doesn't explicitly guarantees this. */
243 RETURN_VALUE_ABI_PRESERVES_ADDRESS
,
246 /* the cleanup list records things that have to be undone
247 if an error happens (descriptors to be closed, memory to be freed, etc.)
248 Each link in the chain records a function to call and an
251 Use make_cleanup to add an element to the cleanup chain.
252 Use do_cleanups to do all cleanup actions back to a given
253 point in the chain. Use discard_cleanups to remove cleanups
254 from the chain back to a given point, not doing them. */
258 struct cleanup
*next
;
259 void (*function
) (void *);
264 /* The ability to declare that a function never returns is useful, but
265 not really required to compile GDB successfully, so the NORETURN and
266 ATTR_NORETURN macros normally expand into nothing. */
268 /* If compiling with older versions of GCC, a function may be declared
269 "volatile" to indicate that it does not return. */
272 #if defined(__GNUC__) \
273 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
274 #define NORETURN volatile
276 #define NORETURN /* nothing */
280 /* GCC 2.5 and later versions define a function attribute "noreturn",
281 which is the preferred way to declare that a function never returns.
282 However GCC 2.7 appears to be the first version in which this fully
283 works everywhere we use it. */
285 #ifndef ATTR_NORETURN
286 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
287 #define ATTR_NORETURN __attribute__ ((noreturn))
289 #define ATTR_NORETURN /* nothing */
294 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
295 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
297 #define ATTR_FORMAT(type, x, y) /* nothing */
301 /* Be conservative and use enum bitfields only with GCC.
302 This is copied from gcc 3.3.1, system.h. */
304 #if defined(__GNUC__) && (__GNUC__ >= 2)
305 #define ENUM_BITFIELD(TYPE) enum TYPE
307 #define ENUM_BITFIELD(TYPE) unsigned int
310 /* Needed for various prototypes */
316 /* From blockframe.c */
318 extern int inside_entry_func (struct frame_info
*this_frame
);
322 extern void initialize_utils (void);
324 extern void notice_quit (void);
326 extern int strcmp_iw (const char *, const char *);
328 extern int strcmp_iw_ordered (const char *, const char *);
330 extern int streq (const char *, const char *);
332 extern int subset_compare (char *, char *);
334 extern char *safe_strerror (int);
336 extern void request_quit (int);
338 extern void do_cleanups (struct cleanup
*);
339 extern void do_final_cleanups (struct cleanup
*);
340 extern void do_run_cleanups (struct cleanup
*);
341 extern void do_exec_cleanups (struct cleanup
*);
342 extern void do_exec_error_cleanups (struct cleanup
*);
344 extern void discard_cleanups (struct cleanup
*);
345 extern void discard_final_cleanups (struct cleanup
*);
346 extern void discard_exec_error_cleanups (struct cleanup
*);
347 extern void discard_my_cleanups (struct cleanup
**, struct cleanup
*);
349 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
350 make_cleanup function declarations below. Do not use this typedef
351 as a cast when passing functions into the make_cleanup() code.
352 Instead either use a bounce function or add a wrapper function.
353 Calling a f(char*) function with f(void*) is non-portable. */
354 typedef void (make_cleanup_ftype
) (void *);
356 extern struct cleanup
*make_cleanup (make_cleanup_ftype
*, void *);
358 extern struct cleanup
*make_cleanup_freeargv (char **);
361 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
363 extern struct cleanup
*make_cleanup_close (int fd
);
365 extern struct cleanup
*make_cleanup_bfd_close (bfd
*abfd
);
367 extern struct cleanup
*make_final_cleanup (make_cleanup_ftype
*, void *);
369 extern struct cleanup
*make_my_cleanup (struct cleanup
**,
370 make_cleanup_ftype
*, void *);
372 extern struct cleanup
*make_run_cleanup (make_cleanup_ftype
*, void *);
374 extern struct cleanup
*make_exec_cleanup (make_cleanup_ftype
*, void *);
375 extern struct cleanup
*make_exec_error_cleanup (make_cleanup_ftype
*, void *);
377 extern struct cleanup
*save_cleanups (void);
378 extern struct cleanup
*save_final_cleanups (void);
379 extern struct cleanup
*save_my_cleanups (struct cleanup
**);
381 extern void restore_cleanups (struct cleanup
*);
382 extern void restore_final_cleanups (struct cleanup
*);
383 extern void restore_my_cleanups (struct cleanup
**, struct cleanup
*);
385 extern void free_current_contents (void *);
387 extern void null_cleanup (void *);
389 extern int myread (int, char *, int);
391 extern int query (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
392 extern int nquery (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
393 extern int yquery (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
395 extern void init_page_info (void);
397 extern char *gdb_realpath (const char *);
398 extern char *xfullpath (const char *);
400 extern unsigned long gnu_debuglink_crc32 (unsigned long crc
,
401 unsigned char *buf
, size_t len
);
403 /* From demangle.c */
405 extern void set_demangling_style (char *);
410 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
411 extern use_struct_convention_fn generic_use_struct_convention
;
414 /* Annotation stuff. */
416 extern int annotation_level
; /* in stack.c */
418 extern void begin_line (void);
420 extern void wrap_here (char *);
422 extern void reinitialize_more_filter (void);
425 extern struct ui_file
*gdb_stdout
;
427 extern struct ui_file
*gdb_stdin
;
428 /* Serious error notifications */
429 extern struct ui_file
*gdb_stderr
;
430 /* Log/debug/trace messages that should bypass normal stdout/stderr
431 filtering. For moment, always call this stream using
432 *_unfiltered. In the very near future that restriction shall be
433 removed - either call shall be unfiltered. (cagney 1999-06-13). */
434 extern struct ui_file
*gdb_stdlog
;
435 /* Target output that should bypass normal stdout/stderr filtering.
436 For moment, always call this stream using *_unfiltered. In the
437 very near future that restriction shall be removed - either call
438 shall be unfiltered. (cagney 1999-07-02). */
439 extern struct ui_file
*gdb_stdtarg
;
440 extern struct ui_file
*gdb_stdtargerr
;
441 extern struct ui_file
*gdb_stdtargin
;
445 /* More generic printf like operations. Filtered versions may return
446 non-locally on error. */
448 extern void fputs_filtered (const char *, struct ui_file
*);
450 extern void fputs_unfiltered (const char *, struct ui_file
*);
452 extern int fputc_filtered (int c
, struct ui_file
*);
454 extern int fputc_unfiltered (int c
, struct ui_file
*);
456 extern int putchar_filtered (int c
);
458 extern int putchar_unfiltered (int c
);
460 extern void puts_filtered (const char *);
462 extern void puts_unfiltered (const char *);
464 extern void puts_filtered_tabular (char *string
, int width
, int right
);
466 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
468 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
470 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
472 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
474 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
476 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
478 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
480 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
482 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
484 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
486 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
488 extern void print_spaces (int, struct ui_file
*);
490 extern void print_spaces_filtered (int, struct ui_file
*);
492 extern char *n_spaces (int);
494 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
496 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
498 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
500 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
501 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
503 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
504 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
506 extern int strlen_paddr (void);
507 extern char *paddr (CORE_ADDR addr
);
508 extern char *paddr_nz (CORE_ADDR addr
);
509 extern char *paddr_u (CORE_ADDR addr
);
510 extern char *paddr_d (LONGEST addr
);
512 extern char *phex (ULONGEST l
, int sizeof_l
);
513 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
515 /* Like paddr() only print/scan raw CORE_ADDR. The output from
516 core_addr_to_string() can be passed direct to
517 string_to_core_addr(). */
518 extern const char *core_addr_to_string (const CORE_ADDR addr
);
519 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
520 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
522 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
525 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
527 extern void print_sys_errmsg (const char *, int);
529 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
530 "const char *" in unistd.h, so we can't declare the argument
533 extern char *re_comp (const char *);
537 extern void symbol_file_command (char *, int);
539 /* Remote targets may wish to use this as their load function. */
540 extern void generic_load (char *name
, int from_tty
);
542 /* Summarise a download */
543 extern void print_transfer_performance (struct ui_file
*stream
,
544 unsigned long data_count
,
545 unsigned long write_count
,
546 unsigned long time_count
);
550 typedef void initialize_file_ftype (void);
552 extern char *skip_quoted (char *);
554 extern char *gdb_readline (char *);
556 extern char *gdb_readline_wrapper (char *);
558 extern char *command_line_input (char *, int, char *);
560 extern void print_prompt (void);
562 extern int input_from_terminal_p (void);
564 extern int info_verbose
;
566 /* From printcmd.c */
568 extern void set_next_address (CORE_ADDR
);
570 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
573 extern int build_address_symbolic (CORE_ADDR addr
,
581 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
583 extern void print_address (CORE_ADDR
, struct ui_file
*);
587 #define OPF_TRY_CWD_FIRST 0x01
588 #define OPF_SEARCH_IN_PATH 0x02
590 extern int openp (const char *, int, const char *, int, int, char **);
592 extern int source_full_path_of (char *, char **);
594 extern void mod_path (char *, char **);
596 extern void add_path (char *, char **, int);
598 extern void directory_command (char *, int);
600 extern char *source_path
;
602 extern void init_source_path (void);
604 extern void init_last_source_visited (void);
608 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
609 bfd_signed_vma data_off
,
610 bfd_signed_vma bss_off
);
612 /* Take over the 'find_mapped_memory' vector from exec.c. */
613 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
619 /* Possible lvalue types. Like enum language, this should be in
620 value.h, but needs to be here for the same reason. */
626 /* In memory. Could be a saved register. */
630 /* In a gdb internal variable. */
632 /* Part of a gdb internal variable (structure field). */
633 lval_internalvar_component
,
634 /* In a register series in a frame not the current one, which may have been
635 partially saved or saved in different places (otherwise would be
636 lval_register or lval_memory). */
637 lval_reg_frame_relative
640 /* Control types for commands */
642 enum misc_command_type
650 enum command_control_type
660 /* Structure for saved commands lines
661 (for breakpoints, defined commands, etc). */
665 struct command_line
*next
;
667 enum command_control_type control_type
;
669 struct command_line
**body_list
;
672 extern struct command_line
*read_command_lines (char *, int);
674 extern void free_command_lines (struct command_line
**);
676 /* To continue the execution commands when running gdb asynchronously.
677 A continuation structure contains a pointer to a function to be called
678 to finish the command, once the target has stopped. Such mechanism is
679 used bt the finish and until commands, and in the remote protocol
680 when opening an extended-remote connection. */
682 struct continuation_arg
684 struct continuation_arg
*next
;
685 union continuation_data
{
694 void (*continuation_hook
) (struct continuation_arg
*);
695 struct continuation_arg
*arg_list
;
696 struct continuation
*next
;
700 extern struct continuation
*cmd_continuation
;
701 /* Used only by the step_1 function. */
702 extern struct continuation
*intermediate_continuation
;
705 extern void add_continuation (void (*)(struct continuation_arg
*),
706 struct continuation_arg
*);
707 extern void do_all_continuations (void);
708 extern void discard_all_continuations (void);
710 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
711 struct continuation_arg
*);
712 extern void do_all_intermediate_continuations (void);
713 extern void discard_all_intermediate_continuations (void);
715 /* String containing the current directory (what getwd would return). */
717 extern char *current_directory
;
719 /* Default radixes for input and output. Only some values supported. */
720 extern unsigned input_radix
;
721 extern unsigned output_radix
;
723 /* Possibilities for prettyprint parameters to routines which print
724 things. Like enum language, this should be in value.h, but needs
725 to be here for the same reason. FIXME: If we can eliminate this
726 as an arg to LA_VAL_PRINT, then we can probably move it back to
731 Val_no_prettyprint
= 0,
733 /* Use the default setting which the user has specified. */
737 /* The ptid struct is a collection of the various "ids" necessary
738 for identifying the inferior. This consists of the process id
739 (pid), thread id (tid), and other fields necessary for uniquely
740 identifying the inferior process/thread being debugged. When
741 manipulating ptids, the constructors, accessors, and predicate
742 declared in inferior.h should be used. These are as follows:
744 ptid_build - Make a new ptid from a pid, lwp, and tid.
745 pid_to_ptid - Make a new ptid from just a pid.
746 ptid_get_pid - Fetch the pid component of a ptid.
747 ptid_get_lwp - Fetch the lwp component of a ptid.
748 ptid_get_tid - Fetch the tid component of a ptid.
749 ptid_equal - Test to see if two ptids are equal.
751 Please do NOT access the struct ptid members directly (except, of
752 course, in the implementation of the above ptid manipulation
760 /* Lightweight process id */
767 typedef struct ptid ptid_t
;
771 /* Optional host machine definition. Pure autoconf targets will not
772 need a "xm.h" file. This will be a symlink to one of the xm-*.h
773 files, built by the `configure' script. */
779 /* Optional native machine support. Non-native (and possibly pure
780 multi-arch) targets do not need a "nm.h" file. This will be a
781 symlink to one of the nm-*.h files, built by the `configure'
788 /* Optional target machine definition. Pure multi-arch configurations
789 do not need a "tm.h" file. This will be a symlink to one of the
790 tm-*.h files, built by the `configure' script. */
796 /* If the xm.h file did not define the mode string used to open the
797 files, assume that binary files are opened the same way as text
800 #include "fopen-same.h"
803 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
804 FIXME: Assumes 2's complement arithmetic */
806 #if !defined (UINT_MAX)
807 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
810 #if !defined (INT_MAX)
811 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
814 #if !defined (INT_MIN)
815 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
818 #if !defined (ULONG_MAX)
819 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
822 #if !defined (LONG_MAX)
823 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
826 #if !defined (ULONGEST_MAX)
827 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
830 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
831 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
834 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
835 arguments to a function, number in a value history, register number, etc.)
836 where the value must not be larger than can fit in an int. */
838 extern int longest_to_int (LONGEST
);
840 /* Assorted functions we can declare, now that const and volatile are
843 extern char *savestring (const char *, size_t);
845 extern char *msavestring (void *, const char *, size_t);
847 extern char *mstrsave (void *, const char *);
849 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
851 extern void xfree (void *);
853 /* Utility macros to allocate typed memory. Avoids errors like:
854 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
855 sizeof (struct foo), 0). */
856 #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE)))
857 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
858 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
860 /* Like asprintf/vasprintf but get an internal_error if the call
862 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
863 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
865 /* Like asprintf and vasprintf, but return the string, throw an error
867 extern char *xstrprintf (const char *format
, ...) ATTR_FORMAT (printf
, 1, 2);
868 extern char *xstrvprintf (const char *format
, va_list ap
);
870 extern int parse_escape (char **);
872 /* Message to be printed before the error message, when an error occurs. */
874 extern char *error_pre_print
;
876 /* Message to be printed before the error message, when an error occurs. */
878 extern char *quit_pre_print
;
880 /* Message to be printed before the warning message, when a warning occurs. */
882 extern char *warning_pre_print
;
884 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
886 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
888 extern NORETURN
void error_silent (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
890 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
892 /* Initialize the error buffer. */
893 extern void error_init (void);
895 /* Returns a freshly allocate buffer containing the last error
897 extern char *error_last_message (void);
899 /* Output arbitrary error message. */
900 extern void error_output_message (char *pre_print
, char *msg
);
902 extern NORETURN
void internal_verror (const char *file
, int line
,
903 const char *, va_list ap
) ATTR_NORETURN
;
905 extern NORETURN
void internal_error (const char *file
, int line
,
906 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
908 extern void internal_vwarning (const char *file
, int line
,
909 const char *, va_list ap
);
911 extern void internal_warning (const char *file
, int line
,
912 const char *, ...) ATTR_FORMAT (printf
, 3, 4);
914 extern NORETURN
void nomem (long) ATTR_NORETURN
;
916 /* Reasons for calling throw_exception(). NOTE: all reason values
917 must be less than zero. enum value 0 is reserved for internal use
918 as the return value from an initial setjmp(). The function
919 catch_exceptions() reserves values >= 0 as legal results from its
924 /* User interrupt. */
926 /* Any other error. */
930 #define ALL_CLEANUPS ((struct cleanup *)0)
932 #define RETURN_MASK(reason) (1 << (int)(-reason))
933 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
934 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
935 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
936 typedef int return_mask
;
938 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
939 to the inner most containing exception handler established using
940 catch_exceptions() (or the legacy catch_errors()).
942 Code normally throws an exception using error() et.al. For various
943 reaons, GDB also contains code that throws an exception directly.
944 For instance, the remote*.c targets contain CNTRL-C signal handlers
945 that propogate the QUIT event up the exception chain. ``This could
946 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
948 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
950 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
951 handler. If an exception (enum return_reason) is thrown using
952 throw_exception() than all cleanups installed since
953 catch_exceptions() was entered are invoked, the (-ve) exception
954 value is then returned by catch_exceptions. If FUNC() returns
955 normally (with a postive or zero return value) then that value is
956 returned by catch_exceptions(). It is an internal_error() for
957 FUNC() to return a negative value.
959 For the period of the FUNC() call: UIOUT is installed as the output
960 builder; ERRSTRING is installed as the error/quit message; and a
961 new cleanup_chain is established. The old values are restored
962 before catch_exceptions() returns.
964 The variant catch_exceptions_with_msg() is the same as
965 catch_exceptions() but adds the ability to return an allocated
966 copy of the gdb error message. This is used when a silent error is
967 issued and the caller wants to manually issue the error message.
969 FIXME; cagney/2001-08-13: The need to override the global UIOUT
970 builder variable should just go away.
972 This function superseeds catch_errors().
974 This function uses SETJMP() and LONGJUMP(). */
977 typedef int (catch_exceptions_ftype
) (struct ui_out
*ui_out
, void *args
);
978 extern int catch_exceptions (struct ui_out
*uiout
,
979 catch_exceptions_ftype
*func
, void *func_args
,
980 char *errstring
, return_mask mask
);
981 extern int catch_exceptions_with_msg (struct ui_out
*uiout
,
982 catch_exceptions_ftype
*func
,
984 char *errstring
, char **gdberrmsg
,
987 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
988 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
989 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
990 value. It's unfortunate that, catch_errors() does not return an
991 indication of the exact exception that it caught - quit_flag might
994 This function is superseeded by catch_exceptions(). */
996 typedef int (catch_errors_ftype
) (void *);
997 extern int catch_errors (catch_errors_ftype
*, void *, char *, return_mask
);
999 /* Template to catch_errors() that wraps calls to command
1002 typedef void (catch_command_errors_ftype
) (char *, int);
1003 extern int catch_command_errors (catch_command_errors_ftype
*func
, char *command
, int from_tty
, return_mask
);
1005 extern void warning (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
1007 extern void vwarning (const char *, va_list args
);
1009 /* List of known OS ABIs. If you change this, make sure to update the
1010 table in osabi.c. */
1013 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
1015 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
1022 GDB_OSABI_FREEBSD_AOUT
,
1023 GDB_OSABI_FREEBSD_ELF
,
1024 GDB_OSABI_NETBSD_AOUT
,
1025 GDB_OSABI_NETBSD_ELF
,
1026 GDB_OSABI_OPENBSD_ELF
,
1036 GDB_OSABI_ARM_EABI_V1
,
1037 GDB_OSABI_ARM_EABI_V2
,
1043 GDB_OSABI_INVALID
/* keep this last */
1046 /* Global functions from other, non-gdb GNU thingies.
1047 Libiberty thingies are no longer declared here. We include libiberty.h
1050 /* From other system libraries */
1052 #ifdef HAVE_STDDEF_H
1056 #ifdef HAVE_STDLIB_H
1060 #define min(a, b) ((a) < (b) ? (a) : (b))
1063 #define max(a, b) ((a) > (b) ? (a) : (b))
1068 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1071 /* Various possibilities for alloca. */
1074 #define alloca __builtin_alloca
1075 #else /* Not GNU C */
1076 #ifdef HAVE_ALLOCA_H
1083 /* We need to be careful not to declare this in a way which conflicts with
1084 bison. Bison never declares it as char *, but under various circumstances
1085 (like __hpux) we need to use void *. */
1086 extern void *alloca ();
1087 #endif /* Not _AIX */
1088 #endif /* Not HAVE_ALLOCA_H */
1089 #endif /* Not GNU C */
1090 #endif /* alloca not defined */
1092 /* Dynamic target-system-dependent parameters for GDB. */
1093 #include "gdbarch.h"
1095 /* Maximum size of a register. Something small, but large enough for
1096 all known ISAs. If it turns out to be too small, make it bigger. */
1098 enum { MAX_REGISTER_SIZE
= 16 };
1100 /* Static target-system-dependent parameters for GDB. */
1102 /* Number of bits in a char or unsigned char for the target machine.
1103 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1104 #if !defined (TARGET_CHAR_BIT)
1105 #define TARGET_CHAR_BIT 8
1108 /* If we picked up a copy of CHAR_BIT from a configuration file
1109 (which may get it by including <limits.h>) then use it to set
1110 the number of bits in a host char. If not, use the same size
1113 #if defined (CHAR_BIT)
1114 #define HOST_CHAR_BIT CHAR_BIT
1116 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1119 /* The bit byte-order has to do just with numbering of bits in
1120 debugging symbols and such. Conceptually, it's quite separate
1121 from byte/word byte order. */
1123 #if !defined (BITS_BIG_ENDIAN)
1124 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1129 extern LONGEST
extract_signed_integer (const void *, int);
1131 extern ULONGEST
extract_unsigned_integer (const void *, int);
1133 extern int extract_long_unsigned_integer (const void *, int, LONGEST
*);
1135 extern CORE_ADDR
extract_typed_address (const void *buf
, struct type
*type
);
1137 extern void store_signed_integer (void *, int, LONGEST
);
1139 extern void store_unsigned_integer (void *, int, ULONGEST
);
1141 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1146 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1148 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1150 extern int watchdog
;
1152 /* Hooks for alternate command interfaces. */
1154 /* The name of the interpreter if specified on the command line. */
1155 extern char *interpreter_p
;
1157 /* If a given interpreter matches INTERPRETER_P then it should update
1158 deprecated_command_loop_hook and deprecated_init_ui_hook with the
1159 per-interpreter implementation. */
1160 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1161 should be moved here. */
1163 struct target_waitstatus
;
1164 struct cmd_list_element
;
1166 /* Should the asynchronous variant of the interpreter (using the
1167 event-loop) be enabled? */
1168 /* NOTE: cagney/2004-06-10: GDB changed to always uses the event-loop.
1169 A follow-on cleanup is to eliminate references to
1171 #define event_loop_p 1
1173 extern void (*deprecated_pre_add_symbol_hook
) (const char *);
1174 extern void (*deprecated_post_add_symbol_hook
) (void);
1175 extern void (*selected_frame_level_changed_hook
) (int);
1176 extern int (*deprecated_ui_loop_hook
) (int signo
);
1177 extern void (*deprecated_init_ui_hook
) (char *argv0
);
1178 extern void (*deprecated_command_loop_hook
) (void);
1179 extern void (*deprecated_show_load_progress
) (const char *section
,
1180 unsigned long section_sent
,
1181 unsigned long section_size
,
1182 unsigned long total_sent
,
1183 unsigned long total_size
);
1184 extern void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
1185 int line
, int stopline
,
1187 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1188 extern int (*deprecated_query_hook
) (const char *, va_list);
1189 extern void (*deprecated_warning_hook
) (const char *, va_list);
1190 extern void (*deprecated_flush_hook
) (struct ui_file
* stream
);
1191 extern void (*deprecated_create_breakpoint_hook
) (struct breakpoint
* b
);
1192 extern void (*deprecated_delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1193 extern void (*deprecated_modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1194 extern void (*deprecated_interactive_hook
) (void);
1195 extern void (*deprecated_registers_changed_hook
) (void);
1196 extern void (*deprecated_readline_begin_hook
) (char *,...);
1197 extern char *(*deprecated_readline_hook
) (char *);
1198 extern void (*deprecated_readline_end_hook
) (void);
1199 extern void (*deprecated_register_changed_hook
) (int regno
);
1200 extern void (*deprecated_memory_changed_hook
) (CORE_ADDR addr
, int len
);
1201 extern void (*deprecated_context_hook
) (int);
1202 extern ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
1203 struct target_waitstatus
* status
);
1205 extern void (*deprecated_attach_hook
) (void);
1206 extern void (*deprecated_detach_hook
) (void);
1207 extern void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
1208 char *cmd
, int from_tty
);
1210 extern void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
1212 extern void (*deprecated_error_hook
) (void);
1214 extern void (*deprecated_error_begin_hook
) (void);
1216 extern int (*deprecated_ui_load_progress_hook
) (const char *section
,
1220 /* Inhibit window interface if non-zero. */
1222 extern int use_windows
;
1224 /* Symbolic definitions of filename-related things. */
1225 /* FIXME, this doesn't work very well if host and executable
1226 filesystems conventions are different. */
1228 #ifndef DIRNAME_SEPARATOR
1229 #define DIRNAME_SEPARATOR ':'
1232 #ifndef SLASH_STRING
1233 #define SLASH_STRING "/"
1238 # define GLOBAL_CURDIR
1241 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1242 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1243 in the code actually refer to a lightweight process id, i.e,
1244 something that can be considered a process id in its own right for
1245 certain purposes. */
1248 #define PIDGET(PTID) (ptid_get_pid (PTID))
1249 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1250 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1253 /* Define well known filenos if the system does not define them. */
1254 #ifndef STDIN_FILENO
1255 #define STDIN_FILENO 0
1257 #ifndef STDOUT_FILENO
1258 #define STDOUT_FILENO 1
1260 #ifndef STDERR_FILENO
1261 #define STDERR_FILENO 2
1264 /* If this definition isn't overridden by the header files, assume
1265 that isatty and fileno exist on this system. */
1267 #define ISATTY(FP) (isatty (fileno (FP)))
1270 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1271 power of 2). Round up/down when necessary. Examples of correct
1274 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1275 write_memory (addr, value, len);
1280 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1281 write_memory (sp, value, len);
1283 Note that uses such as:
1285 write_memory (addr, value, len);
1286 addr += align_up (len, 8);
1290 sp -= align_up (len, 8);
1291 write_memory (sp, value, len);
1293 are typically not correct as they don't ensure that the address (SP
1294 or ADDR) is correctly aligned (relying on previous alignment to
1295 keep things right). This is also why the methods are called
1296 "align_..." instead of "round_..." as the latter reads better with
1297 this incorrect coding style. */
1299 extern ULONGEST
align_up (ULONGEST v
, int n
);
1300 extern ULONGEST
align_down (ULONGEST v
, int n
);
1302 #endif /* #ifndef DEFS_H */