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 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
158 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
160 /* Check if a character is one of the commonly used C++ marker characters. */
161 extern int is_cplus_marker (int);
163 /* enable xdb commands if set */
164 extern int xdb_commands
;
166 /* enable dbx commands if set */
167 extern int dbx_commands
;
169 /* System root path, used to find libraries etc. */
170 extern char *gdb_sysroot
;
172 extern int quit_flag
;
173 extern int immediate_quit
;
174 extern int sevenbit_strings
;
176 extern void quit (void);
178 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
179 benefits of having a ``QUIT'' macro rather than a function are
180 marginal. If the overhead of a QUIT function call is proving
181 significant then its calling frequency should probably be reduced
182 [kingdon]. A profile analyzing the current situtation is
186 /* do twice to force compiler warning */
187 #define QUIT_FIXME "FIXME"
188 #define QUIT_FIXME "ignoring redefinition of QUIT"
191 if (quit_flag) quit (); \
192 if (interactive_hook) interactive_hook (); \
197 /* Languages represented in the symbol table and elsewhere.
198 This should probably be in language.h, but since enum's can't
199 be forward declared to satisfy opaque references before their
200 actual definition, needs to be here. */
204 language_unknown
, /* Language not known */
205 language_auto
, /* Placeholder for automatic setting */
207 language_cplus
, /* C++ */
208 language_objc
, /* Objective-C */
209 language_java
, /* Java */
210 language_fortran
, /* Fortran */
211 language_m2
, /* Modula-2 */
212 language_asm
, /* Assembly language */
213 language_scm
, /* Scheme / Guile */
214 language_pascal
, /* Pascal */
215 language_minimal
/* All other languages, minimal support only */
222 unspecified_precision
225 /* A generic, not quite boolean, enumeration. */
233 /* the cleanup list records things that have to be undone
234 if an error happens (descriptors to be closed, memory to be freed, etc.)
235 Each link in the chain records a function to call and an
238 Use make_cleanup to add an element to the cleanup chain.
239 Use do_cleanups to do all cleanup actions back to a given
240 point in the chain. Use discard_cleanups to remove cleanups
241 from the chain back to a given point, not doing them. */
245 struct cleanup
*next
;
246 void (*function
) (void *);
251 /* The ability to declare that a function never returns is useful, but
252 not really required to compile GDB successfully, so the NORETURN and
253 ATTR_NORETURN macros normally expand into nothing. */
255 /* If compiling with older versions of GCC, a function may be declared
256 "volatile" to indicate that it does not return. */
259 #if defined(__GNUC__) \
260 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
261 #define NORETURN volatile
263 #define NORETURN /* nothing */
267 /* GCC 2.5 and later versions define a function attribute "noreturn",
268 which is the preferred way to declare that a function never returns.
269 However GCC 2.7 appears to be the first version in which this fully
270 works everywhere we use it. */
272 #ifndef ATTR_NORETURN
273 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
274 #define ATTR_NORETURN __attribute__ ((noreturn))
276 #define ATTR_NORETURN /* nothing */
281 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
282 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
284 #define ATTR_FORMAT(type, x, y) /* nothing */
288 /* Needed for various prototypes */
293 /* From blockframe.c */
295 extern int inside_entry_func (CORE_ADDR
);
297 extern int inside_entry_file (CORE_ADDR addr
);
299 extern int inside_main_func (CORE_ADDR pc
);
303 extern void initialize_utils (void);
305 extern void notice_quit (void);
307 extern int strcmp_iw (const char *, const char *);
309 extern int strcmp_iw_ordered (const char *, const char *);
311 extern int streq (const char *, const char *);
313 extern int subset_compare (char *, char *);
315 extern char *safe_strerror (int);
317 extern void init_malloc (void *);
319 extern void request_quit (int);
321 extern void do_cleanups (struct cleanup
*);
322 extern void do_final_cleanups (struct cleanup
*);
323 extern void do_my_cleanups (struct cleanup
**, struct cleanup
*);
324 extern void do_run_cleanups (struct cleanup
*);
325 extern void do_exec_cleanups (struct cleanup
*);
326 extern void do_exec_error_cleanups (struct cleanup
*);
328 extern void discard_cleanups (struct cleanup
*);
329 extern void discard_final_cleanups (struct cleanup
*);
330 extern void discard_exec_error_cleanups (struct cleanup
*);
331 extern void discard_my_cleanups (struct cleanup
**, struct cleanup
*);
333 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
334 make_cleanup function declarations below. Do not use this typedef
335 as a cast when passing functions into the make_cleanup() code.
336 Instead either use a bounce function or add a wrapper function.
337 Calling a f(char*) function with f(void*) is non-portable. */
338 typedef void (make_cleanup_ftype
) (void *);
340 extern struct cleanup
*make_cleanup (make_cleanup_ftype
*, void *);
342 extern struct cleanup
*make_cleanup_freeargv (char **);
345 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
347 extern struct cleanup
*make_cleanup_close (int fd
);
349 extern struct cleanup
*make_cleanup_bfd_close (bfd
*abfd
);
351 extern struct cleanup
*make_final_cleanup (make_cleanup_ftype
*, void *);
353 extern struct cleanup
*make_my_cleanup (struct cleanup
**,
354 make_cleanup_ftype
*, void *);
356 extern struct cleanup
*make_run_cleanup (make_cleanup_ftype
*, void *);
358 extern struct cleanup
*make_exec_cleanup (make_cleanup_ftype
*, void *);
359 extern struct cleanup
*make_exec_error_cleanup (make_cleanup_ftype
*, void *);
361 extern struct cleanup
*save_cleanups (void);
362 extern struct cleanup
*save_final_cleanups (void);
363 extern struct cleanup
*save_my_cleanups (struct cleanup
**);
365 extern void restore_cleanups (struct cleanup
*);
366 extern void restore_final_cleanups (struct cleanup
*);
367 extern void restore_my_cleanups (struct cleanup
**, struct cleanup
*);
369 extern void free_current_contents (void *);
371 extern void null_cleanup (void *);
373 extern int myread (int, char *, int);
375 extern int query (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
377 extern void init_page_info (void);
379 extern char *gdb_realpath (const char *);
380 extern char *xfullpath (const char *);
382 extern unsigned long gnu_debuglink_crc32 (unsigned long crc
,
383 unsigned char *buf
, size_t len
);
385 /* From demangle.c */
387 extern void set_demangling_style (char *);
392 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
393 extern use_struct_convention_fn generic_use_struct_convention
;
396 /* Annotation stuff. */
398 extern int annotation_level
; /* in stack.c */
400 extern void begin_line (void);
402 extern void wrap_here (char *);
404 extern void reinitialize_more_filter (void);
407 extern struct ui_file
*gdb_stdout
;
409 extern struct ui_file
*gdb_stdin
;
410 /* Serious error notifications */
411 extern struct ui_file
*gdb_stderr
;
412 /* Log/debug/trace messages that should bypass normal stdout/stderr
413 filtering. For momement, always call this stream using
414 *_unfiltered. In the very near future that restriction shall be
415 removed - either call shall be unfiltered. (cagney 1999-06-13). */
416 extern struct ui_file
*gdb_stdlog
;
417 /* Target output that should bypass normal stdout/stderr filtering.
418 For momement, always call this stream using *_unfiltered. In the
419 very near future that restriction shall be removed - either call
420 shall be unfiltered. (cagney 1999-07-02). */
421 extern struct ui_file
*gdb_stdtarg
;
422 extern struct ui_file
*gdb_stdtargerr
;
423 extern struct ui_file
*gdb_stdtargin
;
431 /* More generic printf like operations. Filtered versions may return
432 non-locally on error. */
434 extern void fputs_filtered (const char *, struct ui_file
*);
436 extern void fputs_unfiltered (const char *, struct ui_file
*);
438 extern int fputc_filtered (int c
, struct ui_file
*);
440 extern int fputc_unfiltered (int c
, struct ui_file
*);
442 extern int putchar_filtered (int c
);
444 extern int putchar_unfiltered (int c
);
446 extern void puts_filtered (const char *);
448 extern void puts_unfiltered (const char *);
450 extern void puts_filtered_tabular (char *string
, int width
, int right
);
452 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
454 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
456 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
458 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
460 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
462 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
464 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
466 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
468 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
470 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
472 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
474 extern void print_spaces (int, struct ui_file
*);
476 extern void print_spaces_filtered (int, struct ui_file
*);
478 extern char *n_spaces (int);
480 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
482 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
484 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
486 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
487 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
489 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
490 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
492 extern int strlen_paddr (void);
493 extern char *paddr (CORE_ADDR addr
);
494 extern char *paddr_nz (CORE_ADDR addr
);
495 extern char *paddr_u (CORE_ADDR addr
);
496 extern char *paddr_d (LONGEST addr
);
498 extern char *phex (ULONGEST l
, int sizeof_l
);
499 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
501 /* Like paddr() only print/scan raw CORE_ADDR. The output from
502 core_addr_to_string() can be passed direct to
503 string_to_core_addr(). */
504 extern const char *core_addr_to_string (const CORE_ADDR addr
);
505 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
506 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
508 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
511 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
513 extern void print_sys_errmsg (const char *, int);
515 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
516 "const char *" in unistd.h, so we can't declare the argument
519 extern char *re_comp (const char *);
523 extern void symbol_file_command (char *, int);
525 /* Remote targets may wish to use this as their load function. */
526 extern void generic_load (char *name
, int from_tty
);
528 /* Summarise a download */
529 extern void print_transfer_performance (struct ui_file
*stream
,
530 unsigned long data_count
,
531 unsigned long write_count
,
532 unsigned long time_count
);
536 typedef void initialize_file_ftype (void);
538 extern char *skip_quoted (char *);
540 extern char *gdb_readline (char *);
542 extern char *gdb_readline_wrapper (char *);
544 extern char *command_line_input (char *, int, char *);
546 extern void print_prompt (void);
548 extern int input_from_terminal_p (void);
550 extern int info_verbose
;
552 /* From printcmd.c */
554 extern void set_next_address (CORE_ADDR
);
556 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
559 extern int build_address_symbolic (CORE_ADDR addr
,
567 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
569 extern void print_address (CORE_ADDR
, struct ui_file
*);
573 extern int openp (const char *, int, const char *, int, int, char **);
575 extern int source_full_path_of (char *, char **);
577 extern void mod_path (char *, char **);
579 extern void add_path (char *, char **, int);
581 extern void directory_command (char *, int);
583 extern char *source_path
;
585 extern void init_source_path (void);
587 extern void init_last_source_visited (void);
589 extern char *symtab_to_filename (struct symtab
*);
593 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
594 bfd_signed_vma data_off
,
595 bfd_signed_vma bss_off
);
597 /* Take over the 'find_mapped_memory' vector from exec.c. */
598 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
604 /* Possible lvalue types. Like enum language, this should be in
605 value.h, but needs to be here for the same reason. */
611 /* In memory. Could be a saved register. */
615 /* In a gdb internal variable. */
617 /* Part of a gdb internal variable (structure field). */
618 lval_internalvar_component
,
619 /* In a register series in a frame not the current one, which may have been
620 partially saved or saved in different places (otherwise would be
621 lval_register or lval_memory). */
622 lval_reg_frame_relative
627 /* Control types for commands */
629 enum misc_command_type
637 enum command_control_type
647 /* Structure for saved commands lines
648 (for breakpoints, defined commands, etc). */
652 struct command_line
*next
;
654 enum command_control_type control_type
;
656 struct command_line
**body_list
;
659 extern struct command_line
*read_command_lines (char *, int);
661 extern void free_command_lines (struct command_line
**);
663 /* To continue the execution commands when running gdb asynchronously.
664 A continuation structure contains a pointer to a function to be called
665 to finish the command, once the target has stopped. Such mechanism is
666 used bt the finish and until commands, and in the remote protocol
667 when opening an extended-remote connection. */
669 struct continuation_arg
671 struct continuation_arg
*next
;
672 union continuation_data
{
681 void (*continuation_hook
) (struct continuation_arg
*);
682 struct continuation_arg
*arg_list
;
683 struct continuation
*next
;
687 extern struct continuation
*cmd_continuation
;
688 /* Used only by the step_1 function. */
689 extern struct continuation
*intermediate_continuation
;
692 extern void add_continuation (void (*)(struct continuation_arg
*),
693 struct continuation_arg
*);
694 extern void do_all_continuations (void);
695 extern void discard_all_continuations (void);
697 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
698 struct continuation_arg
*);
699 extern void do_all_intermediate_continuations (void);
700 extern void discard_all_intermediate_continuations (void);
702 /* String containing the current directory (what getwd would return). */
704 extern char *current_directory
;
706 /* Default radixes for input and output. Only some values supported. */
707 extern unsigned input_radix
;
708 extern unsigned output_radix
;
710 /* Possibilities for prettyprint parameters to routines which print
711 things. Like enum language, this should be in value.h, but needs
712 to be here for the same reason. FIXME: If we can eliminate this
713 as an arg to LA_VAL_PRINT, then we can probably move it back to
718 Val_no_prettyprint
= 0,
720 /* Use the default setting which the user has specified. */
724 /* The ptid struct is a collection of the various "ids" necessary
725 for identifying the inferior. This consists of the process id
726 (pid), thread id (tid), and other fields necessary for uniquely
727 identifying the inferior process/thread being debugged. When
728 manipulating ptids, the constructors, accessors, and predicate
729 declared in inferior.h should be used. These are as follows:
731 ptid_build - Make a new ptid from a pid, lwp, and tid.
732 pid_to_ptid - Make a new ptid from just a pid.
733 ptid_get_pid - Fetch the pid component of a ptid.
734 ptid_get_lwp - Fetch the lwp component of a ptid.
735 ptid_get_tid - Fetch the tid component of a ptid.
736 ptid_equal - Test to see if two ptids are equal.
738 Please do NOT access the struct ptid members directly (except, of
739 course, in the implementation of the above ptid manipulation
747 /* Lightweight process id */
754 typedef struct ptid ptid_t
;
758 /* Optional host machine definition. Pure autoconf targets will not
759 need a "xm.h" file. This will be a symlink to one of the xm-*.h
760 files, built by the `configure' script. */
766 /* Optional native machine support. Non-native (and possibly pure
767 multi-arch) targets do not need a "nm.h" file. This will be a
768 symlink to one of the nm-*.h files, built by the `configure'
775 /* Optional target machine definition. Pure multi-arch configurations
776 do not need a "tm.h" file. This will be a symlink to one of the
777 tm-*.h files, built by the `configure' script. */
783 /* GDB_MULTI_ARCH is normally set by configure.in using information
784 from configure.tgt or the config/%/%.mt Makefile fragment. Since
785 some targets have defined it in their "tm.h" file, delay providing
786 a default definition until after "tm.h" has been included.. */
788 #ifndef GDB_MULTI_ARCH
789 #define GDB_MULTI_ARCH 0
793 /* If the xm.h file did not define the mode string used to open the
794 files, assume that binary files are opened the same way as text
797 #include "fopen-same.h"
800 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
801 FIXME: Assumes 2's complement arithmetic */
803 #if !defined (UINT_MAX)
804 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
807 #if !defined (INT_MAX)
808 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
811 #if !defined (INT_MIN)
812 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
815 #if !defined (ULONG_MAX)
816 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
819 #if !defined (LONG_MAX)
820 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
823 #if !defined (ULONGEST_MAX)
824 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
827 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
828 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
831 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
832 arguments to a function, number in a value history, register number, etc.)
833 where the value must not be larger than can fit in an int. */
835 extern int longest_to_int (LONGEST
);
837 /* Assorted functions we can declare, now that const and volatile are
840 extern char *savestring (const char *, size_t);
842 extern char *msavestring (void *, const char *, size_t);
844 extern char *mstrsave (void *, const char *);
846 /* Robust versions of same. Throw an internal error when no memory,
847 guard against stray NULL arguments. */
848 extern void *xmmalloc (void *md
, size_t size
);
849 extern void *xmrealloc (void *md
, void *ptr
, size_t size
);
850 extern void *xmcalloc (void *md
, size_t number
, size_t size
);
851 extern void xmfree (void *md
, void *ptr
);
853 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
855 extern void xfree (void *);
857 /* Utility macros to allocate typed memory. Avoids errors like
858 ``struct foo *foo = xmalloc (sizeof bar)'' and ``struct foo *foo =
859 (struct foo *) xmalloc (sizeof bar)''. */
860 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
861 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
863 /* Like asprintf/vasprintf but get an internal_error if the call
865 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
866 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
868 extern int parse_escape (char **);
870 /* Message to be printed before the error message, when an error occurs. */
872 extern char *error_pre_print
;
874 /* Message to be printed before the error message, when an error occurs. */
876 extern char *quit_pre_print
;
878 /* Message to be printed before the warning message, when a warning occurs. */
880 extern char *warning_pre_print
;
882 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
884 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
886 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
888 /* Initialize the error buffer. */
889 extern void error_init (void);
891 /* Returns a freshly allocate buffer containing the last error
893 extern char *error_last_message (void);
895 extern NORETURN
void internal_verror (const char *file
, int line
,
896 const char *, va_list ap
) ATTR_NORETURN
;
898 extern NORETURN
void internal_error (const char *file
, int line
,
899 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
901 extern void internal_vwarning (const char *file
, int line
,
902 const char *, va_list ap
);
904 extern void internal_warning (const char *file
, int line
,
905 const char *, ...) ATTR_FORMAT (printf
, 3, 4);
907 extern NORETURN
void nomem (long) ATTR_NORETURN
;
909 /* Reasons for calling throw_exception(). NOTE: all reason values
910 must be less than zero. enum value 0 is reserved for internal use
911 as the return value from an initial setjmp(). The function
912 catch_exceptions() reserves values >= 0 as legal results from its
917 /* User interrupt. */
919 /* Any other error. */
923 #define ALL_CLEANUPS ((struct cleanup *)0)
925 #define RETURN_MASK(reason) (1 << (int)(-reason))
926 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
927 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
928 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
929 typedef int return_mask
;
931 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
932 to the inner most containing exception handler established using
933 catch_exceptions() (or the legacy catch_errors()).
935 Code normally throws an exception using error() et.al. For various
936 reaons, GDB also contains code that throws an exception directly.
937 For instance, the remote*.c targets contain CNTRL-C signal handlers
938 that propogate the QUIT event up the exception chain. ``This could
939 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
941 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
943 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
944 handler. If an exception (enum return_reason) is thrown using
945 throw_exception() than all cleanups installed since
946 catch_exceptions() was entered are invoked, the (-ve) exception
947 value is then returned by catch_exceptions. If FUNC() returns
948 normally (with a postive or zero return value) then that value is
949 returned by catch_exceptions(). It is an internal_error() for
950 FUNC() to return a negative value.
952 For the period of the FUNC() call: UIOUT is installed as the output
953 builder; ERRSTRING is installed as the error/quit message; and a
954 new cleanup_chain is established. The old values are restored
955 before catch_exceptions() returns.
957 FIXME; cagney/2001-08-13: The need to override the global UIOUT
958 builder variable should just go away.
960 This function superseeds catch_errors().
962 This function uses SETJMP() and LONGJUMP(). */
965 typedef int (catch_exceptions_ftype
) (struct ui_out
*ui_out
, void *args
);
966 extern int catch_exceptions (struct ui_out
*uiout
,
967 catch_exceptions_ftype
*func
, void *func_args
,
968 char *errstring
, return_mask mask
);
970 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
971 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
972 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
973 value. It's unfortunate that, catch_errors() does not return an
974 indication of the exact exception that it caught - quit_flag might
977 This function is superseeded by catch_exceptions(). */
979 typedef int (catch_errors_ftype
) (void *);
980 extern int catch_errors (catch_errors_ftype
*, void *, char *, return_mask
);
982 /* Template to catch_errors() that wraps calls to command
985 typedef void (catch_command_errors_ftype
) (char *, int);
986 extern int catch_command_errors (catch_command_errors_ftype
*func
, char *command
, int from_tty
, return_mask
);
988 extern void warning (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
990 extern void vwarning (const char *, va_list args
);
992 /* List of known OS ABIs. If you change this, make sure to update the
996 GDB_OSABI_UNINITIALIZED
= -1, /* For struct gdbarch_info. */
998 GDB_OSABI_UNKNOWN
= 0, /* keep this zero */
1005 GDB_OSABI_FREEBSD_AOUT
,
1006 GDB_OSABI_FREEBSD_ELF
,
1007 GDB_OSABI_NETBSD_AOUT
,
1008 GDB_OSABI_NETBSD_ELF
,
1018 GDB_OSABI_ARM_EABI_V1
,
1019 GDB_OSABI_ARM_EABI_V2
,
1025 GDB_OSABI_INVALID
/* keep this last */
1028 /* Global functions from other, non-gdb GNU thingies.
1029 Libiberty thingies are no longer declared here. We include libiberty.h
1032 #ifndef GETENV_PROVIDED
1033 extern char *getenv (const char *);
1036 /* From other system libraries */
1038 #ifdef HAVE_STDDEF_H
1042 #ifdef HAVE_STDLIB_H
1046 #define min(a, b) ((a) < (b) ? (a) : (b))
1049 #define max(a, b) ((a) > (b) ? (a) : (b))
1053 /* We take the address of fclose later, but some stdio's forget
1054 to declare this. We can't always declare it since there's
1055 no way to declare the parameters without upsetting some compiler
1058 #ifndef FCLOSE_PROVIDED
1059 extern int fclose (FILE *);
1063 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1066 /* Various possibilities for alloca. */
1069 #define alloca __builtin_alloca
1070 #else /* Not GNU C */
1071 #ifdef HAVE_ALLOCA_H
1078 /* We need to be careful not to declare this in a way which conflicts with
1079 bison. Bison never declares it as char *, but under various circumstances
1080 (like __hpux) we need to use void *. */
1081 extern void *alloca ();
1082 #endif /* Not _AIX */
1083 #endif /* Not HAVE_ALLOCA_H */
1084 #endif /* Not GNU C */
1085 #endif /* alloca not defined */
1087 /* Dynamic target-system-dependent parameters for GDB. */
1088 #include "gdbarch.h"
1089 #if (GDB_MULTI_ARCH == 0)
1090 /* Multi-arch targets _should_ be including "arch-utils.h" directly
1091 into their *-tdep.c file. This is a prop to help old non-
1092 multi-arch targets to continue to compile. */
1093 #include "arch-utils.h"
1096 /* Maximum size of a register. Something small, but large enough for
1097 all known ISAs. If it turns out to be too small, make it bigger. */
1099 enum { MAX_REGISTER_SIZE
= 16 };
1101 /* Static target-system-dependent parameters for GDB. */
1103 /* Number of bits in a char or unsigned char for the target machine.
1104 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1105 #if !defined (TARGET_CHAR_BIT)
1106 #define TARGET_CHAR_BIT 8
1109 /* If we picked up a copy of CHAR_BIT from a configuration file
1110 (which may get it by including <limits.h>) then use it to set
1111 the number of bits in a host char. If not, use the same size
1114 #if defined (CHAR_BIT)
1115 #define HOST_CHAR_BIT CHAR_BIT
1117 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1120 /* The bit byte-order has to do just with numbering of bits in
1121 debugging symbols and such. Conceptually, it's quite separate
1122 from byte/word byte order. */
1124 #if !defined (BITS_BIG_ENDIAN)
1125 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1130 extern LONGEST
extract_signed_integer (const void *, int);
1132 extern ULONGEST
extract_unsigned_integer (const void *, int);
1134 extern int extract_long_unsigned_integer (const void *, int, LONGEST
*);
1136 extern CORE_ADDR
extract_typed_address (const void *buf
, struct type
*type
);
1138 extern void store_signed_integer (void *, int, LONGEST
);
1140 extern void store_unsigned_integer (void *, int, ULONGEST
);
1142 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1147 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1149 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1151 extern int watchdog
;
1153 /* Hooks for alternate command interfaces. */
1155 /* The name of the interpreter if specified on the command line. */
1156 extern char *interpreter_p
;
1158 /* If a given interpreter matches INTERPRETER_P then it should update
1159 command_loop_hook and init_ui_hook with the per-interpreter
1161 /* FIXME: command_loop_hook and init_ui_hook 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 extern int event_loop_p
;
1170 extern void (*init_ui_hook
) (char *argv0
);
1171 extern void (*command_loop_hook
) (void);
1172 extern void (*show_load_progress
) (const char *section
,
1173 unsigned long section_sent
,
1174 unsigned long section_size
,
1175 unsigned long total_sent
,
1176 unsigned long total_size
);
1177 extern void (*print_frame_info_listing_hook
) (struct symtab
* s
,
1178 int line
, int stopline
,
1180 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1181 extern int (*query_hook
) (const char *, va_list);
1182 extern void (*warning_hook
) (const char *, va_list);
1183 extern void (*flush_hook
) (struct ui_file
* stream
);
1184 extern void (*create_breakpoint_hook
) (struct breakpoint
* b
);
1185 extern void (*delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1186 extern void (*modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1187 extern void (*interactive_hook
) (void);
1188 extern void (*registers_changed_hook
) (void);
1189 extern void (*readline_begin_hook
) (char *,...);
1190 extern char *(*readline_hook
) (char *);
1191 extern void (*readline_end_hook
) (void);
1192 extern void (*register_changed_hook
) (int regno
);
1193 extern void (*memory_changed_hook
) (CORE_ADDR addr
, int len
);
1194 extern void (*context_hook
) (int);
1195 extern ptid_t (*target_wait_hook
) (ptid_t ptid
,
1196 struct target_waitstatus
* status
);
1198 extern void (*attach_hook
) (void);
1199 extern void (*detach_hook
) (void);
1200 extern void (*call_command_hook
) (struct cmd_list_element
* c
,
1201 char *cmd
, int from_tty
);
1203 extern void (*set_hook
) (struct cmd_list_element
* c
);
1205 extern NORETURN
void (*error_hook
) (void) ATTR_NORETURN
;
1207 extern void (*error_begin_hook
) (void);
1209 extern int (*ui_load_progress_hook
) (const char *section
, unsigned long num
);
1212 /* Inhibit window interface if non-zero. */
1214 extern int use_windows
;
1216 /* Symbolic definitions of filename-related things. */
1217 /* FIXME, this doesn't work very well if host and executable
1218 filesystems conventions are different. */
1220 #ifndef DIRNAME_SEPARATOR
1221 #define DIRNAME_SEPARATOR ':'
1224 #ifndef SLASH_STRING
1225 #define SLASH_STRING "/"
1230 # define GLOBAL_CURDIR
1233 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1234 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1235 in the code actually refer to a lightweight process id, i.e,
1236 something that can be considered a process id in its own right for
1237 certain purposes. */
1240 #define PIDGET(PTID) (ptid_get_pid (PTID))
1241 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1242 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1245 /* Define well known filenos if the system does not define them. */
1246 #ifndef STDIN_FILENO
1247 #define STDIN_FILENO 0
1249 #ifndef STDOUT_FILENO
1250 #define STDOUT_FILENO 1
1252 #ifndef STDERR_FILENO
1253 #define STDERR_FILENO 2
1256 /* If this definition isn't overridden by the header files, assume
1257 that isatty and fileno exist on this system. */
1259 #define ISATTY(FP) (isatty (fileno (FP)))
1262 #endif /* #ifndef DEFS_H */