1 /* *INDENT-OFF* */ /* ATTR_FORMAT confuses indent, avoid running it for now */
2 /* Basic, host-specific, and target-specific definitions for GDB.
3 Copyright (C) 1986, 1989, 1991-1996, 1998-2000
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
26 #include "config.h" /* Generated by configure */
28 #include <errno.h> /* System call error return status */
34 #include <sys/types.h> /* for size_t */
41 /* Just in case they're not defined in stdio.h. */
50 /* First include ansidecl.h so we can use the various macro definitions
51 here and in all subsequent file inclusions. */
55 #include <stdarg.h> /* for va_list */
57 #include "libiberty.h"
65 /* For BFD64 and bfd_vma. */
69 /* The target is partially multi-arched. Both "tm.h" and the
70 multi-arch vector provide definitions. "tm.h" normally overrides
71 the multi-arch vector (but there are a few exceptions). */
73 #define GDB_MULTI_ARCH_PARTIAL 1
75 /* The target is multi-arched. The MULTI-ARCH vector provides all
76 definitions. "tm.h" is included and may provide definitions of
77 non- multi-arch macros.. */
79 #define GDB_MULTI_ARCH_TM 2
81 /* The target is pure multi-arch. The MULTI-ARCH vector provides all
82 definitions. "tm.h" is linked to an empty file. */
84 #define GDB_MULTI_ARCH_PURE 3
88 /* An address in the program being debugged. Host byte order. Rather
89 than duplicate all the logic in BFD which figures out what type
90 this is (long, long long, etc.) and whether it needs to be 64
91 bits (the host/target interactions are subtle), we just use
94 typedef bfd_vma CORE_ADDR;
96 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
102 #define LONGEST BFD_HOST_64_BIT
103 #define ULONGEST BFD_HOST_U_64_BIT
107 #ifdef CC_HAS_LONG_LONG
108 #define LONGEST long long
109 #define ULONGEST unsigned long long
111 #ifdef BFD_HOST_64_BIT
112 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
113 (e.g. i386-windows) so try it. */
114 #define LONGEST BFD_HOST_64_BIT
115 #define ULONGEST BFD_HOST_U_64_BIT
118 #define ULONGEST unsigned long
122 #endif /* No BFD64 */
124 #endif /* ! LONGEST */
127 #define min(a, b) ((a) < (b) ? (a) : (b))
130 #define max(a, b) ((a) > (b) ? (a) : (b))
133 /* Macros to do string compares.
135 NOTE: cagney/2000-03-14:
137 While old code can continue to refer to these macros, new code is
138 probably better off using strcmp() directly vis: ``strcmp() == 0''
139 and ``strcmp() != 0''.
141 This is because modern compilers can directly inline strcmp()
142 making the original justification for these macros - avoid function
143 call overhead by pre-testing the first characters
144 (``*X==*Y?...:0'') - redundant.
146 ``Even if [...] testing the first character does have a modest
147 performance improvement, I'd rather that whenever a performance
148 issue is found that we spend the effort on algorithmic
149 optimizations than micro-optimizing.'' J.T. */
151 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : (int)*(a) - (int)*(b))
152 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
153 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
155 /* The character GNU C++ uses to build identifiers that must be unique from
156 the program's identifiers (such as $this and $$vptr). */
157 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
159 /* Check if a character is one of the commonly used C++ marker characters. */
160 extern int is_cplus_marker (int);
162 /* use tui interface if non-zero */
163 extern int tui_version;
166 /* all invocations of TUIDO should have two sets of parens */
167 #define TUIDO(x) tuiDo x
172 /* enable xdb commands if set */
173 extern int xdb_commands;
175 /* enable dbx commands if set */
176 extern int dbx_commands;
178 extern int quit_flag;
179 extern int immediate_quit;
180 extern int sevenbit_strings;
182 extern void quit (void);
184 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
185 benefits of having a ``QUIT'' macro rather than a function are
186 marginal. If the overhead of a QUIT function call is proving
187 significant then its calling frequency should probably be reduced
188 [kingdon]. A profile analyzing the current situtation is
192 /* do twice to force compiler warning */
193 #define QUIT_FIXME "FIXME"
194 #define QUIT_FIXME "ignoring redefinition of QUIT"
197 if (quit_flag) quit (); \
198 if (interactive_hook) interactive_hook (); \
203 /* Languages represented in the symbol table and elsewhere.
204 This should probably be in language.h, but since enum's can't
205 be forward declared to satisfy opaque references before their
206 actual definition, needs to be here. */
210 language_unknown, /* Language not known */
211 language_auto, /* Placeholder for automatic setting */
213 language_cplus, /* C++ */
214 language_java, /* Java */
215 language_chill, /* Chill */
216 language_fortran, /* Fortran */
217 language_m2, /* Modula-2 */
218 language_asm, /* Assembly language */
219 language_scm, /* Scheme / Guile */
220 language_pascal /* Pascal */
227 unspecified_precision
230 /* the cleanup list records things that have to be undone
231 if an error happens (descriptors to be closed, memory to be freed, etc.)
232 Each link in the chain records a function to call and an
235 Use make_cleanup to add an element to the cleanup chain.
236 Use do_cleanups to do all cleanup actions back to a given
237 point in the chain. Use discard_cleanups to remove cleanups
238 from the chain back to a given point, not doing them. */
242 struct cleanup *next;
243 void (*function) (PTR);
248 /* The ability to declare that a function never returns is useful, but
249 not really required to compile GDB successfully, so the NORETURN and
250 ATTR_NORETURN macros normally expand into nothing. */
252 /* If compiling with older versions of GCC, a function may be declared
253 "volatile" to indicate that it does not return. */
256 #if defined(__GNUC__) \
257 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
258 #define NORETURN volatile
260 #define NORETURN /* nothing */
264 /* GCC 2.5 and later versions define a function attribute "noreturn",
265 which is the preferred way to declare that a function never returns.
266 However GCC 2.7 appears to be the first version in which this fully
267 works everywhere we use it. */
269 #ifndef ATTR_NORETURN
270 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
271 #define ATTR_NORETURN __attribute__ ((noreturn))
273 #define ATTR_NORETURN /* nothing */
278 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
279 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
281 #define ATTR_FORMAT(type, x, y) /* nothing */
285 /* Needed for various prototypes */
290 /* From blockframe.c */
292 extern int inside_entry_func (CORE_ADDR);
294 extern int inside_entry_file (CORE_ADDR addr);
296 extern int inside_main_func (CORE_ADDR pc);
298 /* From ch-lang.c, for the moment. (FIXME) */
300 extern char *chill_demangle (const char *);
304 extern void initialize_utils (void);
306 extern void notice_quit (void);
308 extern int strcmp_iw (const char *, const char *);
310 extern int subset_compare (char *, char *);
312 extern char *safe_strerror (int);
314 extern void init_malloc (void *);
316 extern void request_quit (int);
318 extern void do_cleanups (struct cleanup *);
319 extern void do_final_cleanups (struct cleanup *);
320 extern void do_my_cleanups (struct cleanup **, struct cleanup *);
321 extern void do_run_cleanups (struct cleanup *);
322 extern void do_exec_cleanups (struct cleanup *);
323 extern void do_exec_error_cleanups (struct cleanup *);
325 extern void discard_cleanups (struct cleanup *);
326 extern void discard_final_cleanups (struct cleanup *);
327 extern void discard_exec_error_cleanups (struct cleanup *);
328 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
330 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
331 make_cleanup function declarations below. Do not use this typedef
332 as a cast when passing functions into the make_cleanup() code.
333 Instead either use a bounce function or add a wrapper function.
334 Calling a f(char*) function with f(void*) is non-portable. */
335 typedef void (make_cleanup_ftype) (void *);
337 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
339 extern struct cleanup *make_cleanup_freeargv (char **);
342 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
344 extern struct cleanup *make_cleanup_close (int fd);
346 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
348 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
350 extern struct cleanup *make_my_cleanup (struct cleanup **,
351 make_cleanup_ftype *, void *);
353 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
355 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
356 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
358 extern struct cleanup *save_cleanups (void);
359 extern struct cleanup *save_final_cleanups (void);
360 extern struct cleanup *save_my_cleanups (struct cleanup **);
362 extern void restore_cleanups (struct cleanup *);
363 extern void restore_final_cleanups (struct cleanup *);
364 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
366 extern void free_current_contents (void *);
368 extern void null_cleanup (void *);
370 extern int myread (int, char *, int);
372 extern int query (char *, ...) ATTR_FORMAT (printf, 1, 2);
374 #if !defined (USE_MMALLOC)
375 /* NOTE: cagney/2000-03-04: The mmalloc functions need to use PTR
376 rather than void* so that they are consistent with
377 ../mmalloc/mmalloc.h. */
378 extern PTR mcalloc (PTR, size_t, size_t);
379 extern PTR mmalloc (PTR, size_t);
380 extern PTR mrealloc (PTR, PTR, size_t);
381 extern void mfree (PTR, PTR);
384 extern void init_page_info (void);
386 extern CORE_ADDR host_pointer_to_address (void *ptr);
387 extern void *address_to_host_pointer (CORE_ADDR addr);
389 /* From demangle.c */
391 extern void set_demangling_style (char *);
396 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
397 extern use_struct_convention_fn generic_use_struct_convention;
399 typedef unsigned char *(breakpoint_from_pc_fn) (CORE_ADDR * pcptr, int *lenptr);
401 /* Annotation stuff. */
403 extern int annotation_level; /* in stack.c */
405 extern void begin_line (void);
407 extern void wrap_here (char *);
409 extern void reinitialize_more_filter (void);
412 extern struct ui_file *gdb_stdout;
413 /* Serious error notifications */
414 extern struct ui_file *gdb_stderr;
415 /* Log/debug/trace messages that should bypass normal stdout/stderr
416 filtering. For momement, always call this stream using
417 *_unfiltered. In the very near future that restriction shall be
418 removed - either call shall be unfiltered. (cagney 1999-06-13). */
419 extern struct ui_file *gdb_stdlog;
420 /* Target output that should bypass normal stdout/stderr filtering.
421 For momement, always call this stream using *_unfiltered. In the
422 very near future that restriction shall be removed - either call
423 shall be unfiltered. (cagney 1999-07-02). */
424 extern struct ui_file *gdb_stdtarg;
428 #include "tuiCommand.h"
431 #include "tuiLayout.h"
437 /* More generic printf like operations */
439 extern void fputs_filtered (const char *, struct ui_file *);
441 extern void fputs_unfiltered (const char *, struct ui_file *);
443 extern int fputc_filtered (int c, struct ui_file *);
445 extern int fputc_unfiltered (int c, struct ui_file *);
447 extern int putchar_unfiltered (int c);
449 extern void puts_filtered (const char *);
451 extern void puts_unfiltered (const char *);
453 extern void puts_debug (char *prefix, char *string, char *suffix);
455 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
457 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
459 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
461 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
463 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
465 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
467 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
469 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
471 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
473 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
475 extern void print_spaces (int, struct ui_file *);
477 extern void print_spaces_filtered (int, struct ui_file *);
479 extern char *n_spaces (int);
481 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
483 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
485 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
487 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
488 extern void gdb_print_host_address (void *addr, struct ui_file *stream);
490 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
491 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
493 extern int strlen_paddr (void);
494 extern char *paddr (CORE_ADDR addr);
495 extern char *paddr_nz (CORE_ADDR addr);
496 extern char *paddr_u (CORE_ADDR addr);
497 extern char *paddr_d (LONGEST addr);
499 extern char *phex (ULONGEST l, int sizeof_l);
500 extern char *phex_nz (ULONGEST l, int sizeof_l);
502 extern void fprintf_symbol_filtered (struct ui_file *, char *,
505 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
507 extern void print_sys_errmsg (char *, int);
509 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
510 "const char *" in unistd.h, so we can't declare the argument
513 extern char *re_comp (const char *);
517 extern void symbol_file_command (char *, int);
519 /* Remote targets may wish to use this as their load function. */
520 extern void generic_load (char *name, int from_tty);
522 /* Summarise a download */
523 extern void print_transfer_performance (struct ui_file *stream,
524 unsigned long data_count,
525 unsigned long write_count,
526 unsigned long time_count);
530 typedef void initialize_file_ftype (void);
532 extern char *skip_quoted (char *);
534 extern char *gdb_readline (char *);
536 extern char *command_line_input (char *, int, char *);
538 extern void print_prompt (void);
540 extern int input_from_terminal_p (void);
542 extern int info_verbose;
544 /* From printcmd.c */
546 extern void set_next_address (CORE_ADDR);
548 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
551 extern int build_address_symbolic (CORE_ADDR addr,
559 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
561 extern void print_address (CORE_ADDR, struct ui_file *);
565 extern int openp (char *, int, char *, int, int, char **);
567 extern int source_full_path_of (char *, char **);
569 extern void mod_path (char *, char **);
571 extern void directory_command (char *, int);
573 extern void init_source_path (void);
575 extern char *symtab_to_filename (struct symtab *);
579 extern void exec_set_section_offsets (bfd_signed_vma text_off,
580 bfd_signed_vma data_off,
581 bfd_signed_vma bss_off);
585 extern int read_relative_register_raw_bytes (int, char *);
587 /* Possible lvalue types. Like enum language, this should be in
588 value.h, but needs to be here for the same reason. */
594 /* In memory. Could be a saved register. */
598 /* In a gdb internal variable. */
600 /* Part of a gdb internal variable (structure field). */
601 lval_internalvar_component,
602 /* In a register series in a frame not the current one, which may have been
603 partially saved or saved in different places (otherwise would be
604 lval_register or lval_memory). */
605 lval_reg_frame_relative
610 /* From readline (but not in any readline .h files). */
612 extern char *tilde_expand (char *);
614 /* Control types for commands */
616 enum misc_command_type
624 enum command_control_type
634 /* Structure for saved commands lines
635 (for breakpoints, defined commands, etc). */
639 struct command_line *next;
641 enum command_control_type control_type;
643 struct command_line **body_list;
646 extern struct command_line *read_command_lines (char *, int);
648 extern void free_command_lines (struct command_line **);
650 /* To continue the execution commands when running gdb asynchronously.
651 A continuation structure contains a pointer to a function to be called
652 to finish the command, once the target has stopped. Such mechanism is
653 used bt the finish and until commands, and in the remote protocol
654 when opening an extended-remote connection. */
656 struct continuation_arg
658 struct continuation_arg *next;
659 union continuation_data {
668 void (*continuation_hook) (struct continuation_arg *);
669 struct continuation_arg *arg_list;
670 struct continuation *next;
672 struct continuation continuation;
675 extern struct continuation *cmd_continuation;
676 /* Used only by the step_1 function. */
677 extern struct continuation *intermediate_continuation;
680 extern void add_continuation (void (*)(struct continuation_arg *),
681 struct continuation_arg *);
682 extern void do_all_continuations (void);
683 extern void discard_all_continuations (void);
685 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
686 struct continuation_arg *);
687 extern void do_all_intermediate_continuations (void);
688 extern void discard_all_intermediate_continuations (void);
690 /* String containing the current directory (what getwd would return). */
692 extern char *current_directory;
694 /* Default radixes for input and output. Only some values supported. */
695 extern unsigned input_radix;
696 extern unsigned output_radix;
698 /* Possibilities for prettyprint parameters to routines which print
699 things. Like enum language, this should be in value.h, but needs
700 to be here for the same reason. FIXME: If we can eliminate this
701 as an arg to LA_VAL_PRINT, then we can probably move it back to
706 Val_no_prettyprint = 0,
708 /* Use the default setting which the user has specified. */
713 /* Optional host machine definition. Pure autoconf targets will not
714 need a "xm.h" file. This will be a symlink to one of the xm-*.h
715 files, built by the `configure' script. */
721 /* Optional native machine support. Non-native (and possibly pure
722 multi-arch) targets do not need a "nm.h" file. This will be a
723 symlink to one of the nm-*.h files, built by the `configure'
730 /* Optional target machine definition. Pure multi-arch configurations
731 do not need a "tm.h" file. This will be a symlink to one of the
732 tm-*.h files, built by the `configure' script. */
738 /* GDB_MULTI_ARCH is normally set by configure.in using information
739 from configure.tgt or the config/%/%.mt Makefile fragment. Since
740 some targets have defined it in their "tm.h" file, delay providing
741 a default definition until after "tm.h" has been included.. */
743 #ifndef GDB_MULTI_ARCH
744 #define GDB_MULTI_ARCH 0
748 /* If the xm.h file did not define the mode string used to open the
749 files, assume that binary files are opened the same way as text
752 #include "fopen-same.h"
755 /* Microsoft C can't deal with const pointers */
760 #define CONST_PTR const
764 * Allow things in gdb to be declared "volatile". If compiling ANSI, it
765 * just works. If compiling with gcc but non-ansi, redefine to __volatile__.
766 * If non-ansi, non-gcc, then eliminate "volatile" entirely, making those
767 * objects be read-write rather than read-only.
773 #define volatile __volatile__
775 #define volatile /* nothing */
778 #endif /* volatile */
780 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
781 FIXME: Assumes 2's complement arithmetic */
783 #if !defined (UINT_MAX)
784 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
787 #if !defined (INT_MAX)
788 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
791 #if !defined (INT_MIN)
792 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
795 #if !defined (ULONG_MAX)
796 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
799 #if !defined (LONG_MAX)
800 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
803 #if !defined (ULONGEST_MAX)
804 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 32-bits */
807 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 32-bits */
808 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
811 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
812 arguments to a function, number in a value history, register number, etc.)
813 where the value must not be larger than can fit in an int. */
815 extern int longest_to_int (LONGEST);
817 /* Assorted functions we can declare, now that const and volatile are
820 extern char *savestring (const char *, int);
822 extern char *msavestring (void *, const char *, int);
824 extern char *strsave (const char *);
826 extern char *mstrsave (void *, const char *);
828 /* FIXME; was long, but this causes compile errors in msvc if already
831 extern PTR xmmalloc (PTR, size_t);
832 extern PTR xmrealloc (PTR, PTR, size_t);
834 extern PTR xmmalloc (PTR, long);
835 extern PTR xmrealloc (PTR, PTR, long);
838 extern int parse_escape (char **);
840 /* Message to be printed before the error message, when an error occurs. */
842 extern char *error_pre_print;
844 /* Message to be printed before the error message, when an error occurs. */
846 extern char *quit_pre_print;
848 /* Message to be printed before the warning message, when a warning occurs. */
850 extern char *warning_pre_print;
852 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
854 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN;
856 /* DEPRECATED: Use error(), verror() or error_stream(). */
857 extern NORETURN void error_begin (void);
859 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
861 /* Returns a freshly allocate buffer containing the last error
863 extern char *error_last_message (void);
865 extern NORETURN void internal_verror (const char *, va_list ap) ATTR_NORETURN;
867 extern NORETURN void internal_error (char *, ...) ATTR_NORETURN;
869 extern NORETURN void nomem (long) ATTR_NORETURN;
871 /* Reasons for calling return_to_top_level. Note: enum value 0 is
872 reserved for internal use as the return value from an initial
877 /* User interrupt. */
879 /* Any other error. */
883 #define ALL_CLEANUPS ((struct cleanup *)0)
885 #define RETURN_MASK(reason) (1 << (int)(reason))
886 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
887 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
888 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
889 typedef int return_mask;
891 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
893 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
894 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
895 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
896 value. It's unfortunate that, catch_errors() does not return an
897 indication of the exact exception that it caught - quit_flag might
900 typedef int (catch_errors_ftype) (PTR);
901 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
903 /* Template to catch_errors() that wraps calls to command
906 typedef void (catch_command_errors_ftype) (char *, int);
907 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
909 extern void warning_begin (void);
911 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
913 /* Global functions from other, non-gdb GNU thingies.
914 Libiberty thingies are no longer declared here. We include libiberty.h
917 #ifndef GETENV_PROVIDED
918 extern char *getenv (const char *);
921 /* From other system libraries */
928 #if defined(_MSC_VER) && !defined(__cplusplus)
929 /* msvc defines these in stdlib.h for c code */
936 #define min(a, b) ((a) < (b) ? (a) : (b))
939 #define max(a, b) ((a) > (b) ? (a) : (b))
943 /* We take the address of fclose later, but some stdio's forget
944 to declare this. We can't always declare it since there's
945 no way to declare the parameters without upsetting some compiler
948 #ifndef FCLOSE_PROVIDED
949 extern int fclose (FILE *);
953 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
956 #ifndef MALLOC_INCOMPATIBLE
958 #ifdef NEED_DECLARATION_MALLOC
959 extern PTR malloc ();
962 #ifdef NEED_DECLARATION_REALLOC
963 extern PTR realloc ();
966 #ifdef NEED_DECLARATION_FREE
970 #endif /* MALLOC_INCOMPATIBLE */
972 /* Various possibilities for alloca. */
975 #define alloca __builtin_alloca
976 #else /* Not GNU C */
984 /* We need to be careful not to declare this in a way which conflicts with
985 bison. Bison never declares it as char *, but under various circumstances
986 (like __hpux) we need to use void *. */
987 #if defined (__STDC__) || defined (__hpux)
988 extern void *alloca ();
989 #else /* Don't use void *. */
990 extern char *alloca ();
991 #endif /* Don't use void *. */
992 #endif /* Not _AIX */
993 #endif /* Not HAVE_ALLOCA_H */
994 #endif /* Not GNU C */
995 #endif /* alloca not defined */
997 /* HOST_BYTE_ORDER must be defined to one of these. */
1003 #if !defined (BIG_ENDIAN)
1004 #define BIG_ENDIAN 4321
1007 #if !defined (LITTLE_ENDIAN)
1008 #define LITTLE_ENDIAN 1234
1011 /* Dynamic target-system-dependent parameters for GDB. */
1012 #include "gdbarch.h"
1013 #if (GDB_MULTI_ARCH == 0)
1014 /* Multi-arch targets _should_ be including "arch-utils.h" directly
1015 into their *-tdep.c file. This is a prop to help old non-
1016 multi-arch targets to continue to compile. */
1017 #include "arch-utils.h"
1020 /* Static target-system-dependent parameters for GDB. */
1022 /* Number of bits in a char or unsigned char for the target machine.
1023 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1024 #if !defined (TARGET_CHAR_BIT)
1025 #define TARGET_CHAR_BIT 8
1028 /* If we picked up a copy of CHAR_BIT from a configuration file
1029 (which may get it by including <limits.h>) then use it to set
1030 the number of bits in a host char. If not, use the same size
1033 #if defined (CHAR_BIT)
1034 #define HOST_CHAR_BIT CHAR_BIT
1036 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1039 /* The bit byte-order has to do just with numbering of bits in
1040 debugging symbols and such. Conceptually, it's quite separate
1041 from byte/word byte order. */
1043 #if !defined (BITS_BIG_ENDIAN)
1044 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1049 extern LONGEST extract_signed_integer (void *, int);
1051 extern ULONGEST extract_unsigned_integer (void *, int);
1053 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1055 extern CORE_ADDR extract_address (void *, int);
1057 extern CORE_ADDR extract_typed_address (void *buf, struct type *type);
1059 extern void store_signed_integer (void *, int, LONGEST);
1061 extern void store_unsigned_integer (void *, int, ULONGEST);
1063 extern void store_address (void *, int, LONGEST);
1065 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1067 /* Setup definitions for host and target floating point formats. We need to
1068 consider the format for `float', `double', and `long double' for both target
1069 and host. We need to do this so that we know what kind of conversions need
1070 to be done when converting target numbers to and from the hosts DOUBLEST
1073 /* This is used to indicate that we don't know the format of the floating point
1074 number. Typically, this is useful for native ports, where the actual format
1075 is irrelevant, since no conversions will be taking place. */
1077 extern const struct floatformat floatformat_unknown;
1079 #if HOST_BYTE_ORDER == BIG_ENDIAN
1080 #ifndef HOST_FLOAT_FORMAT
1081 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
1083 #ifndef HOST_DOUBLE_FORMAT
1084 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
1086 #else /* LITTLE_ENDIAN */
1087 #ifndef HOST_FLOAT_FORMAT
1088 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
1090 #ifndef HOST_DOUBLE_FORMAT
1091 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
1095 #ifndef HOST_LONG_DOUBLE_FORMAT
1096 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
1099 /* Use `long double' if the host compiler supports it. (Note that this is not
1100 necessarily any longer than `double'. On SunOS/gcc, it's the same as
1101 double.) This is necessary because GDB internally converts all floating
1102 point values to the widest type supported by the host.
1104 There are problems however, when the target `long double' is longer than the
1105 host's `long double'. In general, we'll probably reduce the precision of
1106 any such values and print a warning. */
1108 #ifdef HAVE_LONG_DOUBLE
1109 typedef long double DOUBLEST;
1111 typedef double DOUBLEST;
1114 extern void floatformat_to_doublest (const struct floatformat *,
1115 char *, DOUBLEST *);
1116 extern void floatformat_from_doublest (const struct floatformat *,
1117 DOUBLEST *, char *);
1118 extern DOUBLEST extract_floating (void *, int);
1120 extern void store_floating (void *, int, DOUBLEST);
1122 /* On some machines there are bits in addresses which are not really
1123 part of the address, but are used by the kernel, the hardware, etc.
1124 for special purposes. ADDR_BITS_REMOVE takes out any such bits
1125 so we get a "real" address such as one would find in a symbol
1126 table. This is used only for addresses of instructions, and even then
1127 I'm not sure it's used in all contexts. It exists to deal with there
1128 being a few stray bits in the PC which would mislead us, not as some sort
1129 of generic thing to handle alignment or segmentation (it's possible it
1130 should be in TARGET_READ_PC instead). */
1131 #if !defined (ADDR_BITS_REMOVE)
1132 #define ADDR_BITS_REMOVE(addr) (addr)
1133 #endif /* No ADDR_BITS_REMOVE. */
1137 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1139 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1141 extern int watchdog;
1143 /* Hooks for alternate command interfaces. */
1146 /* The name of the interpreter if specified on the command line. */
1147 extern char *interpreter_p;
1150 /* If a given interpreter matches INTERPRETER_P then it should update
1151 command_loop_hook and init_ui_hook with the per-interpreter
1153 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1155 struct target_waitstatus;
1156 struct cmd_list_element;
1158 /* Should the asynchronous variant of the interpreter (using the
1159 event-loop) be enabled? */
1160 extern int event_loop_p;
1162 extern void (*init_ui_hook) (char *argv0);
1163 extern void (*command_loop_hook) (void);
1164 extern void (*show_load_progress) (const char *section,
1165 unsigned long section_sent,
1166 unsigned long section_size,
1167 unsigned long total_sent,
1168 unsigned long total_size);
1169 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1170 int line, int stopline,
1172 extern struct frame_info *parse_frame_specification (char *frame_exp);
1173 extern int (*query_hook) (const char *, va_list);
1174 extern void (*warning_hook) (const char *, va_list);
1175 extern void (*flush_hook) (struct ui_file * stream);
1176 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1177 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1178 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1179 extern void (*interactive_hook) (void);
1180 extern void (*registers_changed_hook) (void);
1181 extern void (*readline_begin_hook) (char *,...);
1182 extern char *(*readline_hook) (char *);
1183 extern void (*readline_end_hook) (void);
1184 extern void (*register_changed_hook) (int regno);
1185 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1186 extern void (*context_hook) (int);
1187 extern int (*target_wait_hook) (int pid, struct target_waitstatus * status);
1189 extern void (*attach_hook) (void);
1190 extern void (*detach_hook) (void);
1191 extern void (*call_command_hook) (struct cmd_list_element * c,
1192 char *cmd, int from_tty);
1194 extern void (*set_hook) (struct cmd_list_element * c);
1196 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1198 extern void (*error_begin_hook) (void);
1200 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1203 /* Inhibit window interface if non-zero. */
1205 extern int use_windows;
1207 /* Symbolic definitions of filename-related things. */
1208 /* FIXME, this doesn't work very well if host and executable
1209 filesystems conventions are different. */
1211 #ifndef DIRNAME_SEPARATOR
1212 #define DIRNAME_SEPARATOR ':'
1216 #if defined(__GO32__)||defined(_WIN32)
1217 #define SLASH_P(X) ((X)=='\\')
1219 #define SLASH_P(X) ((X)=='/')
1224 #if defined(__GO32__)||defined(_WIN32)
1225 #define SLASH_CHAR '\\'
1227 #define SLASH_CHAR '/'
1231 #ifndef SLASH_STRING
1232 #if defined(__GO32__)||defined(_WIN32)
1233 #define SLASH_STRING "\\"
1235 #define SLASH_STRING "/"
1240 #define ROOTED_P(X) (SLASH_P((X)[0]))
1243 /* On some systems, PIDGET is defined to extract the inferior pid from
1244 an internal pid that has the thread id and pid in seperate bit
1245 fields. If not defined, then just use the entire internal pid as
1249 #define PIDGET(PID) (PID)
1250 #define TIDGET(PID) 0
1251 #define MERGEPID(PID, TID) (PID)
1254 /* If under Cygwin, provide backwards compatibility with older
1255 Cygwin compilers that don't define the current cpp define. */
1262 /* Define well known filenos if the system does not define them. */
1263 #ifndef STDIN_FILENO
1264 #define STDIN_FILENO 0
1266 #ifndef STDOUT_FILENO
1267 #define STDOUT_FILENO 1
1269 #ifndef STDERR_FILENO
1270 #define STDERR_FILENO 2
1273 /* If this definition isn't overridden by the header files, assume
1274 that isatty and fileno exist on this system. */
1276 #define ISATTY(FP) (isatty (fileno (FP)))
1280 /* FIXME: cagney/1999-12-13: The following will be moved to gdb.h /
1281 libgdb.h or gdblib.h. */
1283 /* Return-code (RC) from a gdb library call. (The abreviation RC is
1284 taken from the sim/common directory.) */
1287 /* The operation failed. The failure message can be fetched by
1288 calling ``char *error_last_message(void)''. The value is
1289 determined by the catch_errors() interface. */
1290 /* NOTE: Since ``defs.h:catch_errors()'' does not return an error /
1291 internal / quit indication it is not possible to return that
1294 /* No error occured but nothing happened. Due to the catch_errors()
1295 interface, this must be non-zero. */
1297 /* The operation was successful. Due to the catch_errors()
1298 interface, this must be non-zero. */
1303 /* Print the specified breakpoint on GDB_STDOUT. (Eventually this
1304 function will ``print'' the object on ``output''). */
1305 enum gdb_rc gdb_breakpoint_query (/* struct {ui,gdb}_out *output, */ int bnum);
1307 /* Create a breakpoint at ADDRESS (a GDB source and line). */
1308 enum gdb_rc gdb_breakpoint (char *address, char *condition,
1309 int hardwareflag, int tempflag,
1310 int thread, int ignore_count);
1311 enum gdb_rc gdb_thread_select (/* output object */ char *tidstr);
1314 /* Print a list of known thread ids. */
1315 enum gdb_rc gdb_list_thread_ids (/* output object */);
1317 /* Switch thread and print notification. */
1319 #endif /* #ifndef DEFS_H */