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 /* Potential ways that a function can return a value of a given type. */
234 enum return_value_convention
236 /* Where the return value has been squeezed into one or more
238 RETURN_VALUE_REGISTER_CONVENTION
,
239 /* Commonly known as the "struct return convention". The caller
240 passes an additional hidden first parameter to the caller. That
241 parameter contains the address at which the value being returned
242 should be stored. While typically, and historically, used for
243 large structs, this is convention is applied to values of many
245 RETURN_VALUE_STRUCT_CONVENTION
248 /* the cleanup list records things that have to be undone
249 if an error happens (descriptors to be closed, memory to be freed, etc.)
250 Each link in the chain records a function to call and an
253 Use make_cleanup to add an element to the cleanup chain.
254 Use do_cleanups to do all cleanup actions back to a given
255 point in the chain. Use discard_cleanups to remove cleanups
256 from the chain back to a given point, not doing them. */
260 struct cleanup
*next
;
261 void (*function
) (void *);
266 /* The ability to declare that a function never returns is useful, but
267 not really required to compile GDB successfully, so the NORETURN and
268 ATTR_NORETURN macros normally expand into nothing. */
270 /* If compiling with older versions of GCC, a function may be declared
271 "volatile" to indicate that it does not return. */
274 #if defined(__GNUC__) \
275 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
276 #define NORETURN volatile
278 #define NORETURN /* nothing */
282 /* GCC 2.5 and later versions define a function attribute "noreturn",
283 which is the preferred way to declare that a function never returns.
284 However GCC 2.7 appears to be the first version in which this fully
285 works everywhere we use it. */
287 #ifndef ATTR_NORETURN
288 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
289 #define ATTR_NORETURN __attribute__ ((noreturn))
291 #define ATTR_NORETURN /* nothing */
296 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
297 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
299 #define ATTR_FORMAT(type, x, y) /* nothing */
303 /* Be conservative and use enum bitfields only with GCC.
304 This is copied from gcc 3.3.1, system.h. */
306 #if defined(__GNUC__) && (__GNUC__ >= 2)
307 #define ENUM_BITFIELD(TYPE) enum TYPE
309 #define ENUM_BITFIELD(TYPE) unsigned int
312 /* Needed for various prototypes */
317 /* From blockframe.c */
319 extern int inside_entry_func (CORE_ADDR
);
321 extern int deprecated_inside_entry_file (CORE_ADDR addr
);
323 extern int inside_main_func (CORE_ADDR pc
);
327 extern void initialize_utils (void);
329 extern void notice_quit (void);
331 extern int strcmp_iw (const char *, const char *);
333 extern int strcmp_iw_ordered (const char *, const char *);
335 extern int streq (const char *, const char *);
337 extern int subset_compare (char *, char *);
339 extern char *safe_strerror (int);
341 extern void init_malloc (void *);
343 extern void request_quit (int);
345 extern void do_cleanups (struct cleanup
*);
346 extern void do_final_cleanups (struct cleanup
*);
347 extern void do_my_cleanups (struct cleanup
**, struct cleanup
*);
348 extern void do_run_cleanups (struct cleanup
*);
349 extern void do_exec_cleanups (struct cleanup
*);
350 extern void do_exec_error_cleanups (struct cleanup
*);
352 extern void discard_cleanups (struct cleanup
*);
353 extern void discard_final_cleanups (struct cleanup
*);
354 extern void discard_exec_error_cleanups (struct cleanup
*);
355 extern void discard_my_cleanups (struct cleanup
**, struct cleanup
*);
357 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
358 make_cleanup function declarations below. Do not use this typedef
359 as a cast when passing functions into the make_cleanup() code.
360 Instead either use a bounce function or add a wrapper function.
361 Calling a f(char*) function with f(void*) is non-portable. */
362 typedef void (make_cleanup_ftype
) (void *);
364 extern struct cleanup
*make_cleanup (make_cleanup_ftype
*, void *);
366 extern struct cleanup
*make_cleanup_freeargv (char **);
369 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
371 extern struct cleanup
*make_cleanup_close (int fd
);
373 extern struct cleanup
*make_cleanup_bfd_close (bfd
*abfd
);
375 extern struct cleanup
*make_final_cleanup (make_cleanup_ftype
*, void *);
377 extern struct cleanup
*make_my_cleanup (struct cleanup
**,
378 make_cleanup_ftype
*, void *);
380 extern struct cleanup
*make_run_cleanup (make_cleanup_ftype
*, void *);
382 extern struct cleanup
*make_exec_cleanup (make_cleanup_ftype
*, void *);
383 extern struct cleanup
*make_exec_error_cleanup (make_cleanup_ftype
*, void *);
385 extern struct cleanup
*save_cleanups (void);
386 extern struct cleanup
*save_final_cleanups (void);
387 extern struct cleanup
*save_my_cleanups (struct cleanup
**);
389 extern void restore_cleanups (struct cleanup
*);
390 extern void restore_final_cleanups (struct cleanup
*);
391 extern void restore_my_cleanups (struct cleanup
**, struct cleanup
*);
393 extern void free_current_contents (void *);
395 extern void null_cleanup (void *);
397 extern int myread (int, char *, int);
399 extern int query (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
401 extern void init_page_info (void);
403 extern char *gdb_realpath (const char *);
404 extern char *xfullpath (const char *);
406 extern unsigned long gnu_debuglink_crc32 (unsigned long crc
,
407 unsigned char *buf
, size_t len
);
409 /* From demangle.c */
411 extern void set_demangling_style (char *);
416 typedef int (use_struct_convention_fn
) (int gcc_p
, struct type
* value_type
);
417 extern use_struct_convention_fn generic_use_struct_convention
;
420 /* Annotation stuff. */
422 extern int annotation_level
; /* in stack.c */
424 extern void begin_line (void);
426 extern void wrap_here (char *);
428 extern void reinitialize_more_filter (void);
431 extern struct ui_file
*gdb_stdout
;
433 extern struct ui_file
*gdb_stdin
;
434 /* Serious error notifications */
435 extern struct ui_file
*gdb_stderr
;
436 /* Log/debug/trace messages that should bypass normal stdout/stderr
437 filtering. For momement, always call this stream using
438 *_unfiltered. In the very near future that restriction shall be
439 removed - either call shall be unfiltered. (cagney 1999-06-13). */
440 extern struct ui_file
*gdb_stdlog
;
441 /* Target output that should bypass normal stdout/stderr filtering.
442 For momement, always call this stream using *_unfiltered. In the
443 very near future that restriction shall be removed - either call
444 shall be unfiltered. (cagney 1999-07-02). */
445 extern struct ui_file
*gdb_stdtarg
;
446 extern struct ui_file
*gdb_stdtargerr
;
447 extern struct ui_file
*gdb_stdtargin
;
455 /* More generic printf like operations. Filtered versions may return
456 non-locally on error. */
458 extern void fputs_filtered (const char *, struct ui_file
*);
460 extern void fputs_unfiltered (const char *, struct ui_file
*);
462 extern int fputc_filtered (int c
, struct ui_file
*);
464 extern int fputc_unfiltered (int c
, struct ui_file
*);
466 extern int putchar_filtered (int c
);
468 extern int putchar_unfiltered (int c
);
470 extern void puts_filtered (const char *);
472 extern void puts_unfiltered (const char *);
474 extern void puts_filtered_tabular (char *string
, int width
, int right
);
476 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
478 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
480 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
482 extern void fprintf_filtered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
484 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 3, 4);
486 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
488 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
490 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf
, 1, 0);
492 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list) ATTR_FORMAT (printf
, 2, 0);
494 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...) ATTR_FORMAT (printf
, 2, 3);
496 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf
, 1, 2);
498 extern void print_spaces (int, struct ui_file
*);
500 extern void print_spaces_filtered (int, struct ui_file
*);
502 extern char *n_spaces (int);
504 extern void fputstr_filtered (const char *str
, int quotr
, struct ui_file
* stream
);
506 extern void fputstr_unfiltered (const char *str
, int quotr
, struct ui_file
* stream
);
508 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
, struct ui_file
* stream
);
510 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
511 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
513 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
514 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
516 extern int strlen_paddr (void);
517 extern char *paddr (CORE_ADDR addr
);
518 extern char *paddr_nz (CORE_ADDR addr
);
519 extern char *paddr_u (CORE_ADDR addr
);
520 extern char *paddr_d (LONGEST addr
);
522 extern char *phex (ULONGEST l
, int sizeof_l
);
523 extern char *phex_nz (ULONGEST l
, int sizeof_l
);
525 /* Like paddr() only print/scan raw CORE_ADDR. The output from
526 core_addr_to_string() can be passed direct to
527 string_to_core_addr(). */
528 extern const char *core_addr_to_string (const CORE_ADDR addr
);
529 extern const char *core_addr_to_string_nz (const CORE_ADDR addr
);
530 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
532 extern void fprintf_symbol_filtered (struct ui_file
*, char *,
535 extern NORETURN
void perror_with_name (const char *) ATTR_NORETURN
;
537 extern void print_sys_errmsg (const char *, int);
539 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
540 "const char *" in unistd.h, so we can't declare the argument
543 extern char *re_comp (const char *);
547 extern void symbol_file_command (char *, int);
549 /* Remote targets may wish to use this as their load function. */
550 extern void generic_load (char *name
, int from_tty
);
552 /* Summarise a download */
553 extern void print_transfer_performance (struct ui_file
*stream
,
554 unsigned long data_count
,
555 unsigned long write_count
,
556 unsigned long time_count
);
560 typedef void initialize_file_ftype (void);
562 extern char *skip_quoted (char *);
564 extern char *gdb_readline (char *);
566 extern char *gdb_readline_wrapper (char *);
568 extern char *command_line_input (char *, int, char *);
570 extern void print_prompt (void);
572 extern int input_from_terminal_p (void);
574 extern int info_verbose
;
576 /* From printcmd.c */
578 extern void set_next_address (CORE_ADDR
);
580 extern void print_address_symbolic (CORE_ADDR
, struct ui_file
*, int,
583 extern int build_address_symbolic (CORE_ADDR addr
,
591 extern void print_address_numeric (CORE_ADDR
, int, struct ui_file
*);
593 extern void print_address (CORE_ADDR
, struct ui_file
*);
597 extern int openp (const char *, int, const char *, int, int, char **);
599 extern int source_full_path_of (char *, char **);
601 extern void mod_path (char *, char **);
603 extern void add_path (char *, char **, int);
605 extern void directory_command (char *, int);
607 extern char *source_path
;
609 extern void init_source_path (void);
611 extern void init_last_source_visited (void);
613 extern char *symtab_to_filename (struct symtab
*);
617 extern void exec_set_section_offsets (bfd_signed_vma text_off
,
618 bfd_signed_vma data_off
,
619 bfd_signed_vma bss_off
);
621 /* Take over the 'find_mapped_memory' vector from exec.c. */
622 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR
,
628 /* Possible lvalue types. Like enum language, this should be in
629 value.h, but needs to be here for the same reason. */
635 /* In memory. Could be a saved register. */
639 /* In a gdb internal variable. */
641 /* Part of a gdb internal variable (structure field). */
642 lval_internalvar_component
,
643 /* In a register series in a frame not the current one, which may have been
644 partially saved or saved in different places (otherwise would be
645 lval_register or lval_memory). */
646 lval_reg_frame_relative
651 /* Control types for commands */
653 enum misc_command_type
661 enum command_control_type
671 /* Structure for saved commands lines
672 (for breakpoints, defined commands, etc). */
676 struct command_line
*next
;
678 enum command_control_type control_type
;
680 struct command_line
**body_list
;
683 extern struct command_line
*read_command_lines (char *, int);
685 extern void free_command_lines (struct command_line
**);
687 /* To continue the execution commands when running gdb asynchronously.
688 A continuation structure contains a pointer to a function to be called
689 to finish the command, once the target has stopped. Such mechanism is
690 used bt the finish and until commands, and in the remote protocol
691 when opening an extended-remote connection. */
693 struct continuation_arg
695 struct continuation_arg
*next
;
696 union continuation_data
{
705 void (*continuation_hook
) (struct continuation_arg
*);
706 struct continuation_arg
*arg_list
;
707 struct continuation
*next
;
711 extern struct continuation
*cmd_continuation
;
712 /* Used only by the step_1 function. */
713 extern struct continuation
*intermediate_continuation
;
716 extern void add_continuation (void (*)(struct continuation_arg
*),
717 struct continuation_arg
*);
718 extern void do_all_continuations (void);
719 extern void discard_all_continuations (void);
721 extern void add_intermediate_continuation (void (*)(struct continuation_arg
*),
722 struct continuation_arg
*);
723 extern void do_all_intermediate_continuations (void);
724 extern void discard_all_intermediate_continuations (void);
726 /* String containing the current directory (what getwd would return). */
728 extern char *current_directory
;
730 /* Default radixes for input and output. Only some values supported. */
731 extern unsigned input_radix
;
732 extern unsigned output_radix
;
734 /* Possibilities for prettyprint parameters to routines which print
735 things. Like enum language, this should be in value.h, but needs
736 to be here for the same reason. FIXME: If we can eliminate this
737 as an arg to LA_VAL_PRINT, then we can probably move it back to
742 Val_no_prettyprint
= 0,
744 /* Use the default setting which the user has specified. */
748 /* The ptid struct is a collection of the various "ids" necessary
749 for identifying the inferior. This consists of the process id
750 (pid), thread id (tid), and other fields necessary for uniquely
751 identifying the inferior process/thread being debugged. When
752 manipulating ptids, the constructors, accessors, and predicate
753 declared in inferior.h should be used. These are as follows:
755 ptid_build - Make a new ptid from a pid, lwp, and tid.
756 pid_to_ptid - Make a new ptid from just a pid.
757 ptid_get_pid - Fetch the pid component of a ptid.
758 ptid_get_lwp - Fetch the lwp component of a ptid.
759 ptid_get_tid - Fetch the tid component of a ptid.
760 ptid_equal - Test to see if two ptids are equal.
762 Please do NOT access the struct ptid members directly (except, of
763 course, in the implementation of the above ptid manipulation
771 /* Lightweight process id */
778 typedef struct ptid ptid_t
;
782 /* Optional host machine definition. Pure autoconf targets will not
783 need a "xm.h" file. This will be a symlink to one of the xm-*.h
784 files, built by the `configure' script. */
790 /* Optional native machine support. Non-native (and possibly pure
791 multi-arch) targets do not need a "nm.h" file. This will be a
792 symlink to one of the nm-*.h files, built by the `configure'
799 /* Optional target machine definition. Pure multi-arch configurations
800 do not need a "tm.h" file. This will be a symlink to one of the
801 tm-*.h files, built by the `configure' script. */
807 /* If the xm.h file did not define the mode string used to open the
808 files, assume that binary files are opened the same way as text
811 #include "fopen-same.h"
814 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
815 FIXME: Assumes 2's complement arithmetic */
817 #if !defined (UINT_MAX)
818 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
821 #if !defined (INT_MAX)
822 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
825 #if !defined (INT_MIN)
826 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
829 #if !defined (ULONG_MAX)
830 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
833 #if !defined (LONG_MAX)
834 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
837 #if !defined (ULONGEST_MAX)
838 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
841 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
842 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
845 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
846 arguments to a function, number in a value history, register number, etc.)
847 where the value must not be larger than can fit in an int. */
849 extern int longest_to_int (LONGEST
);
851 /* Assorted functions we can declare, now that const and volatile are
854 extern char *savestring (const char *, size_t);
856 extern char *msavestring (void *, const char *, size_t);
858 extern char *mstrsave (void *, const char *);
860 /* Robust versions of same. Throw an internal error when no memory,
861 guard against stray NULL arguments. */
862 extern void *xmmalloc (void *md
, size_t size
);
863 extern void *xmrealloc (void *md
, void *ptr
, size_t size
);
864 extern void *xmcalloc (void *md
, size_t number
, size_t size
);
865 extern void xmfree (void *md
, void *ptr
);
867 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
869 extern void xfree (void *);
871 /* Utility macros to allocate typed memory. Avoids errors like
872 ``struct foo *foo = xmalloc (sizeof bar)'' and ``struct foo *foo =
873 (struct foo *) xmalloc (sizeof bar)''. */
874 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
875 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
877 /* Like asprintf/vasprintf but get an internal_error if the call
879 extern void xasprintf (char **ret
, const char *format
, ...) ATTR_FORMAT (printf
, 2, 3);
880 extern void xvasprintf (char **ret
, const char *format
, va_list ap
);
882 /* Like asprintf, but return the string, throw an error if no memory. */
883 extern char *xstrprintf (const char *format
, ...) ATTR_FORMAT (printf
, 1, 2);
885 extern int parse_escape (char **);
887 /* Message to be printed before the error message, when an error occurs. */
889 extern char *error_pre_print
;
891 /* Message to be printed before the error message, when an error occurs. */
893 extern char *quit_pre_print
;
895 /* Message to be printed before the warning message, when a warning occurs. */
897 extern char *warning_pre_print
;
899 extern NORETURN
void verror (const char *fmt
, va_list ap
) ATTR_NORETURN
;
901 extern NORETURN
void error (const char *fmt
, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
903 extern NORETURN
void error_stream (struct ui_file
*) ATTR_NORETURN
;
905 /* Initialize the error buffer. */
906 extern void error_init (void);
908 /* Returns a freshly allocate buffer containing the last error
910 extern char *error_last_message (void);
912 extern NORETURN
void internal_verror (const char *file
, int line
,
913 const char *, va_list ap
) ATTR_NORETURN
;
915 extern NORETURN
void internal_error (const char *file
, int line
,
916 const char *, ...) ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
918 extern void internal_vwarning (const char *file
, int line
,
919 const char *, va_list ap
);
921 extern void internal_warning (const char *file
, int line
,
922 const char *, ...) ATTR_FORMAT (printf
, 3, 4);
924 extern NORETURN
void nomem (long) ATTR_NORETURN
;
926 /* Reasons for calling throw_exception(). NOTE: all reason values
927 must be less than zero. enum value 0 is reserved for internal use
928 as the return value from an initial setjmp(). The function
929 catch_exceptions() reserves values >= 0 as legal results from its
934 /* User interrupt. */
936 /* Any other error. */
940 #define ALL_CLEANUPS ((struct cleanup *)0)
942 #define RETURN_MASK(reason) (1 << (int)(-reason))
943 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
944 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
945 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
946 typedef int return_mask
;
948 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
949 to the inner most containing exception handler established using
950 catch_exceptions() (or the legacy catch_errors()).
952 Code normally throws an exception using error() et.al. For various
953 reaons, GDB also contains code that throws an exception directly.
954 For instance, the remote*.c targets contain CNTRL-C signal handlers
955 that propogate the QUIT event up the exception chain. ``This could
956 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
958 extern NORETURN
void throw_exception (enum return_reason
) ATTR_NORETURN
;
960 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
961 handler. If an exception (enum return_reason) is thrown using
962 throw_exception() than all cleanups installed since
963 catch_exceptions() was entered are invoked, the (-ve) exception
964 value is then returned by catch_exceptions. If FUNC() returns
965 normally (with a postive or zero return value) then that value is
966 returned by catch_exceptions(). It is an internal_error() for
967 FUNC() to return a negative value.
969 For the period of the FUNC() call: UIOUT is installed as the output
970 builder; ERRSTRING is installed as the error/quit message; and a
971 new cleanup_chain is established. The old values are restored
972 before catch_exceptions() returns.
974 FIXME; cagney/2001-08-13: The need to override the global UIOUT
975 builder variable should just go away.
977 This function superseeds catch_errors().
979 This function uses SETJMP() and LONGJUMP(). */
982 typedef int (catch_exceptions_ftype
) (struct ui_out
*ui_out
, void *args
);
983 extern int catch_exceptions (struct ui_out
*uiout
,
984 catch_exceptions_ftype
*func
, void *func_args
,
985 char *errstring
, return_mask mask
);
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
,
1035 GDB_OSABI_ARM_EABI_V1
,
1036 GDB_OSABI_ARM_EABI_V2
,
1042 GDB_OSABI_INVALID
/* keep this last */
1045 /* Global functions from other, non-gdb GNU thingies.
1046 Libiberty thingies are no longer declared here. We include libiberty.h
1049 #ifndef GETENV_PROVIDED
1050 extern char *getenv (const char *);
1053 /* From other system libraries */
1055 #ifdef HAVE_STDDEF_H
1059 #ifdef HAVE_STDLIB_H
1063 #define min(a, b) ((a) < (b) ? (a) : (b))
1066 #define max(a, b) ((a) > (b) ? (a) : (b))
1070 /* We take the address of fclose later, but some stdio's forget
1071 to declare this. We can't always declare it since there's
1072 no way to declare the parameters without upsetting some compiler
1075 #ifndef FCLOSE_PROVIDED
1076 extern int fclose (FILE *);
1080 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1083 /* Various possibilities for alloca. */
1086 #define alloca __builtin_alloca
1087 #else /* Not GNU C */
1088 #ifdef HAVE_ALLOCA_H
1095 /* We need to be careful not to declare this in a way which conflicts with
1096 bison. Bison never declares it as char *, but under various circumstances
1097 (like __hpux) we need to use void *. */
1098 extern void *alloca ();
1099 #endif /* Not _AIX */
1100 #endif /* Not HAVE_ALLOCA_H */
1101 #endif /* Not GNU C */
1102 #endif /* alloca not defined */
1104 /* Is GDB multi-arch? If there's a "tm.h" file, it is not. */
1105 #ifndef GDB_MULTI_ARCH
1107 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PARTIAL
1109 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PURE
1113 /* Dynamic target-system-dependent parameters for GDB. */
1114 #include "gdbarch.h"
1116 /* Maximum size of a register. Something small, but large enough for
1117 all known ISAs. If it turns out to be too small, make it bigger. */
1119 enum { MAX_REGISTER_SIZE
= 16 };
1121 /* Static target-system-dependent parameters for GDB. */
1123 /* Number of bits in a char or unsigned char for the target machine.
1124 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1125 #if !defined (TARGET_CHAR_BIT)
1126 #define TARGET_CHAR_BIT 8
1129 /* If we picked up a copy of CHAR_BIT from a configuration file
1130 (which may get it by including <limits.h>) then use it to set
1131 the number of bits in a host char. If not, use the same size
1134 #if defined (CHAR_BIT)
1135 #define HOST_CHAR_BIT CHAR_BIT
1137 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1140 /* The bit byte-order has to do just with numbering of bits in
1141 debugging symbols and such. Conceptually, it's quite separate
1142 from byte/word byte order. */
1144 #if !defined (BITS_BIG_ENDIAN)
1145 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1150 extern LONGEST
extract_signed_integer (const void *, int);
1152 extern ULONGEST
extract_unsigned_integer (const void *, int);
1154 extern int extract_long_unsigned_integer (const void *, int, LONGEST
*);
1156 extern CORE_ADDR
extract_typed_address (const void *buf
, struct type
*type
);
1158 extern void store_signed_integer (void *, int, LONGEST
);
1160 extern void store_unsigned_integer (void *, int, ULONGEST
);
1162 extern void store_typed_address (void *buf
, struct type
*type
, CORE_ADDR addr
);
1167 extern CORE_ADDR
push_bytes (CORE_ADDR
, char *, int);
1169 extern CORE_ADDR
push_word (CORE_ADDR
, ULONGEST
);
1171 extern int watchdog
;
1173 /* Hooks for alternate command interfaces. */
1175 /* The name of the interpreter if specified on the command line. */
1176 extern char *interpreter_p
;
1178 /* If a given interpreter matches INTERPRETER_P then it should update
1179 command_loop_hook and init_ui_hook with the per-interpreter
1181 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1183 struct target_waitstatus
;
1184 struct cmd_list_element
;
1186 /* Should the asynchronous variant of the interpreter (using the
1187 event-loop) be enabled? */
1188 extern int event_loop_p
;
1190 extern void (*init_ui_hook
) (char *argv0
);
1191 extern void (*command_loop_hook
) (void);
1192 extern void (*show_load_progress
) (const char *section
,
1193 unsigned long section_sent
,
1194 unsigned long section_size
,
1195 unsigned long total_sent
,
1196 unsigned long total_size
);
1197 extern void (*print_frame_info_listing_hook
) (struct symtab
* s
,
1198 int line
, int stopline
,
1200 extern struct frame_info
*parse_frame_specification (char *frame_exp
);
1201 extern int (*query_hook
) (const char *, va_list);
1202 extern void (*warning_hook
) (const char *, va_list);
1203 extern void (*flush_hook
) (struct ui_file
* stream
);
1204 extern void (*create_breakpoint_hook
) (struct breakpoint
* b
);
1205 extern void (*delete_breakpoint_hook
) (struct breakpoint
* bpt
);
1206 extern void (*modify_breakpoint_hook
) (struct breakpoint
* bpt
);
1207 extern void (*interactive_hook
) (void);
1208 extern void (*registers_changed_hook
) (void);
1209 extern void (*readline_begin_hook
) (char *,...);
1210 extern char *(*readline_hook
) (char *);
1211 extern void (*readline_end_hook
) (void);
1212 extern void (*register_changed_hook
) (int regno
);
1213 extern void (*memory_changed_hook
) (CORE_ADDR addr
, int len
);
1214 extern void (*context_hook
) (int);
1215 extern ptid_t (*target_wait_hook
) (ptid_t ptid
,
1216 struct target_waitstatus
* status
);
1218 extern void (*attach_hook
) (void);
1219 extern void (*detach_hook
) (void);
1220 extern void (*call_command_hook
) (struct cmd_list_element
* c
,
1221 char *cmd
, int from_tty
);
1223 extern void (*set_hook
) (struct cmd_list_element
* c
);
1225 extern NORETURN
void (*error_hook
) (void) ATTR_NORETURN
;
1227 extern void (*error_begin_hook
) (void);
1229 extern int (*ui_load_progress_hook
) (const char *section
, unsigned long num
);
1232 /* Inhibit window interface if non-zero. */
1234 extern int use_windows
;
1236 /* Symbolic definitions of filename-related things. */
1237 /* FIXME, this doesn't work very well if host and executable
1238 filesystems conventions are different. */
1240 #ifndef DIRNAME_SEPARATOR
1241 #define DIRNAME_SEPARATOR ':'
1244 #ifndef SLASH_STRING
1245 #define SLASH_STRING "/"
1250 # define GLOBAL_CURDIR
1253 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1254 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1255 in the code actually refer to a lightweight process id, i.e,
1256 something that can be considered a process id in its own right for
1257 certain purposes. */
1260 #define PIDGET(PTID) (ptid_get_pid (PTID))
1261 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1262 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1265 /* Define well known filenos if the system does not define them. */
1266 #ifndef STDIN_FILENO
1267 #define STDIN_FILENO 0
1269 #ifndef STDOUT_FILENO
1270 #define STDOUT_FILENO 1
1272 #ifndef STDERR_FILENO
1273 #define STDERR_FILENO 2
1276 /* If this definition isn't overridden by the header files, assume
1277 that isatty and fileno exist on this system. */
1279 #define ISATTY(FP) (isatty (fileno (FP)))
1282 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1283 power of 2). Round up/down when necessary. Examples of correct
1286 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1287 write_memory (addr, value, len);
1292 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1293 write_memory (sp, value, len);
1295 Note that uses such as:
1297 write_memory (addr, value, len);
1298 addr += align_up (len, 8);
1302 sp -= align_up (len, 8);
1303 write_memory (sp, value, len);
1305 are typically not correct as they don't ensure that the address (SP
1306 or ADDR) is correctly aligned (relying on previous alignment to
1307 keep things right). This is also why the methods are called
1308 "align_..." instead of "round_..." as the latter reads better with
1309 this incorrect coding style. */
1311 extern ULONGEST
align_up (ULONGEST v
, int n
);
1312 extern ULONGEST
align_down (ULONGEST v
, int n
);
1314 #endif /* #ifndef DEFS_H */