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
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 */
29 #include <errno.h> /* System call error return status */
35 #include <sys/types.h> /* for size_t */
42 /* Just in case they're not defined in stdio.h. */
51 /* First include ansidecl.h so we can use the various macro definitions
52 here and in all subsequent file inclusions. */
56 #include <stdarg.h> /* for va_list */
58 #include "libiberty.h"
66 /* For BFD64 and bfd_vma. */
70 /* The target is partially multi-arched. Both "tm.h" and the
71 multi-arch vector provide definitions. "tm.h" normally overrides
72 the multi-arch vector (but there are a few exceptions). */
74 #define GDB_MULTI_ARCH_PARTIAL 1
76 /* The target is multi-arched. The MULTI-ARCH vector provides all
77 definitions. "tm.h" is included and may provide definitions of
78 non- multi-arch macros.. */
80 #define GDB_MULTI_ARCH_TM 2
82 /* The target is pure multi-arch. The MULTI-ARCH vector provides all
83 definitions. "tm.h" is linked to an empty file. */
85 #define GDB_MULTI_ARCH_PURE 3
89 /* An address in the program being debugged. Host byte order. Rather
90 than duplicate all the logic in BFD which figures out what type
91 this is (long, long long, etc.) and whether it needs to be 64
92 bits (the host/target interactions are subtle), we just use
95 typedef bfd_vma CORE_ADDR;
97 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
103 #define LONGEST BFD_HOST_64_BIT
104 #define ULONGEST BFD_HOST_U_64_BIT
108 #ifdef CC_HAS_LONG_LONG
109 #define LONGEST long long
110 #define ULONGEST unsigned long long
112 #ifdef BFD_HOST_64_BIT
113 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
114 (e.g. i386-windows) so try it. */
115 #define LONGEST BFD_HOST_64_BIT
116 #define ULONGEST BFD_HOST_U_64_BIT
119 #define ULONGEST unsigned long
123 #endif /* No BFD64 */
125 #endif /* ! LONGEST */
128 #define min(a, b) ((a) < (b) ? (a) : (b))
131 #define max(a, b) ((a) > (b) ? (a) : (b))
134 /* Macros to do string compares.
136 NOTE: cagney/2000-03-14:
138 While old code can continue to refer to these macros, new code is
139 probably better off using strcmp() directly vis: ``strcmp() == 0''
140 and ``strcmp() != 0''.
142 This is because modern compilers can directly inline strcmp()
143 making the original justification for these macros - avoid function
144 call overhead by pre-testing the first characters
145 (``*X==*Y?...:0'') - redundant.
147 ``Even if [...] testing the first character does have a modest
148 performance improvement, I'd rather that whenever a performance
149 issue is found that we spend the effort on algorithmic
150 optimizations than micro-optimizing.'' J.T. */
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 numbering of these signals is chosen to match traditional unix
231 signals (insofar as various unices use the same numbers, anyway).
232 It is also the numbering of the GDB remote protocol. Other remote
233 protocols, if they use a different numbering, should make sure to
234 translate appropriately.
236 Since these numbers have actually made it out into other software
237 (stubs, etc.), you mustn't disturb the assigned numbering. If you
238 need to add new signals here, add them to the end of the explicitly
241 This is based strongly on Unix/POSIX signals for several reasons:
242 (1) This set of signals represents a widely-accepted attempt to
243 represent events of this sort in a portable fashion, (2) we want a
244 signal to make it from wait to child_wait to the user intact, (3) many
245 remote protocols use a similar encoding. However, it is
246 recognized that this set of signals has limitations (such as not
247 distinguishing between various kinds of SIGSEGV, or not
248 distinguishing hitting a breakpoint from finishing a single step).
249 So in the future we may get around this either by adding additional
250 signals for breakpoint, single-step, etc., or by adding signal
251 codes; the latter seems more in the spirit of what BSD, System V,
252 etc. are doing to address these issues. */
254 /* For an explanation of what each signal means, see
255 target_signal_to_string. */
259 /* Used some places (e.g. stop_signal) to record the concept that
260 there is no signal. */
262 TARGET_SIGNAL_FIRST = 0,
263 TARGET_SIGNAL_HUP = 1,
264 TARGET_SIGNAL_INT = 2,
265 TARGET_SIGNAL_QUIT = 3,
266 TARGET_SIGNAL_ILL = 4,
267 TARGET_SIGNAL_TRAP = 5,
268 TARGET_SIGNAL_ABRT = 6,
269 TARGET_SIGNAL_EMT = 7,
270 TARGET_SIGNAL_FPE = 8,
271 TARGET_SIGNAL_KILL = 9,
272 TARGET_SIGNAL_BUS = 10,
273 TARGET_SIGNAL_SEGV = 11,
274 TARGET_SIGNAL_SYS = 12,
275 TARGET_SIGNAL_PIPE = 13,
276 TARGET_SIGNAL_ALRM = 14,
277 TARGET_SIGNAL_TERM = 15,
278 TARGET_SIGNAL_URG = 16,
279 TARGET_SIGNAL_STOP = 17,
280 TARGET_SIGNAL_TSTP = 18,
281 TARGET_SIGNAL_CONT = 19,
282 TARGET_SIGNAL_CHLD = 20,
283 TARGET_SIGNAL_TTIN = 21,
284 TARGET_SIGNAL_TTOU = 22,
285 TARGET_SIGNAL_IO = 23,
286 TARGET_SIGNAL_XCPU = 24,
287 TARGET_SIGNAL_XFSZ = 25,
288 TARGET_SIGNAL_VTALRM = 26,
289 TARGET_SIGNAL_PROF = 27,
290 TARGET_SIGNAL_WINCH = 28,
291 TARGET_SIGNAL_LOST = 29,
292 TARGET_SIGNAL_USR1 = 30,
293 TARGET_SIGNAL_USR2 = 31,
294 TARGET_SIGNAL_PWR = 32,
295 /* Similar to SIGIO. Perhaps they should have the same number. */
296 TARGET_SIGNAL_POLL = 33,
297 TARGET_SIGNAL_WIND = 34,
298 TARGET_SIGNAL_PHONE = 35,
299 TARGET_SIGNAL_WAITING = 36,
300 TARGET_SIGNAL_LWP = 37,
301 TARGET_SIGNAL_DANGER = 38,
302 TARGET_SIGNAL_GRANT = 39,
303 TARGET_SIGNAL_RETRACT = 40,
304 TARGET_SIGNAL_MSG = 41,
305 TARGET_SIGNAL_SOUND = 42,
306 TARGET_SIGNAL_SAK = 43,
307 TARGET_SIGNAL_PRIO = 44,
308 TARGET_SIGNAL_REALTIME_33 = 45,
309 TARGET_SIGNAL_REALTIME_34 = 46,
310 TARGET_SIGNAL_REALTIME_35 = 47,
311 TARGET_SIGNAL_REALTIME_36 = 48,
312 TARGET_SIGNAL_REALTIME_37 = 49,
313 TARGET_SIGNAL_REALTIME_38 = 50,
314 TARGET_SIGNAL_REALTIME_39 = 51,
315 TARGET_SIGNAL_REALTIME_40 = 52,
316 TARGET_SIGNAL_REALTIME_41 = 53,
317 TARGET_SIGNAL_REALTIME_42 = 54,
318 TARGET_SIGNAL_REALTIME_43 = 55,
319 TARGET_SIGNAL_REALTIME_44 = 56,
320 TARGET_SIGNAL_REALTIME_45 = 57,
321 TARGET_SIGNAL_REALTIME_46 = 58,
322 TARGET_SIGNAL_REALTIME_47 = 59,
323 TARGET_SIGNAL_REALTIME_48 = 60,
324 TARGET_SIGNAL_REALTIME_49 = 61,
325 TARGET_SIGNAL_REALTIME_50 = 62,
326 TARGET_SIGNAL_REALTIME_51 = 63,
327 TARGET_SIGNAL_REALTIME_52 = 64,
328 TARGET_SIGNAL_REALTIME_53 = 65,
329 TARGET_SIGNAL_REALTIME_54 = 66,
330 TARGET_SIGNAL_REALTIME_55 = 67,
331 TARGET_SIGNAL_REALTIME_56 = 68,
332 TARGET_SIGNAL_REALTIME_57 = 69,
333 TARGET_SIGNAL_REALTIME_58 = 70,
334 TARGET_SIGNAL_REALTIME_59 = 71,
335 TARGET_SIGNAL_REALTIME_60 = 72,
336 TARGET_SIGNAL_REALTIME_61 = 73,
337 TARGET_SIGNAL_REALTIME_62 = 74,
338 TARGET_SIGNAL_REALTIME_63 = 75,
340 /* Used internally by Solaris threads. See signal(5) on Solaris. */
341 TARGET_SIGNAL_CANCEL = 76,
343 /* Yes, this pains me, too. But LynxOS didn't have SIG32, and now
344 Linux does, and we can't disturb the numbering, since it's part
345 of the protocol. Note that in some GDB's TARGET_SIGNAL_REALTIME_32
347 TARGET_SIGNAL_REALTIME_32,
348 /* Yet another pain, IRIX 6 has SIG64. */
349 TARGET_SIGNAL_REALTIME_64,
351 #if defined(MACH) || defined(__MACH__)
352 /* Mach exceptions */
353 TARGET_EXC_BAD_ACCESS,
354 TARGET_EXC_BAD_INSTRUCTION,
355 TARGET_EXC_ARITHMETIC,
356 TARGET_EXC_EMULATION,
358 TARGET_EXC_BREAKPOINT,
362 /* Some signal we don't know about. */
363 TARGET_SIGNAL_UNKNOWN,
365 /* Use whatever signal we use when one is not specifically specified
366 (for passing to proceed and so on). */
367 TARGET_SIGNAL_DEFAULT,
369 /* Last and unused enum value, for sizing arrays, etc. */
373 /* the cleanup list records things that have to be undone
374 if an error happens (descriptors to be closed, memory to be freed, etc.)
375 Each link in the chain records a function to call and an
378 Use make_cleanup to add an element to the cleanup chain.
379 Use do_cleanups to do all cleanup actions back to a given
380 point in the chain. Use discard_cleanups to remove cleanups
381 from the chain back to a given point, not doing them. */
385 struct cleanup *next;
386 void (*function) (PTR);
391 /* The ability to declare that a function never returns is useful, but
392 not really required to compile GDB successfully, so the NORETURN and
393 ATTR_NORETURN macros normally expand into nothing. */
395 /* If compiling with older versions of GCC, a function may be declared
396 "volatile" to indicate that it does not return. */
399 #if defined(__GNUC__) \
400 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
401 #define NORETURN volatile
403 #define NORETURN /* nothing */
407 /* GCC 2.5 and later versions define a function attribute "noreturn",
408 which is the preferred way to declare that a function never returns.
409 However GCC 2.7 appears to be the first version in which this fully
410 works everywhere we use it. */
412 #ifndef ATTR_NORETURN
413 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
414 #define ATTR_NORETURN __attribute__ ((noreturn))
416 #define ATTR_NORETURN /* nothing */
421 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
422 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
424 #define ATTR_FORMAT(type, x, y) /* nothing */
428 /* Needed for various prototypes */
433 /* From blockframe.c */
435 extern int inside_entry_func (CORE_ADDR);
437 extern int inside_entry_file (CORE_ADDR addr);
439 extern int inside_main_func (CORE_ADDR pc);
441 /* From ch-lang.c, for the moment. (FIXME) */
443 extern char *chill_demangle (const char *);
447 extern void initialize_utils (void);
449 extern void notice_quit (void);
451 extern int strcmp_iw (const char *, const char *);
453 extern int subset_compare (char *, char *);
455 extern char *safe_strerror (int);
457 extern void init_malloc (void *);
459 extern void request_quit (int);
461 extern void do_cleanups (struct cleanup *);
462 extern void do_final_cleanups (struct cleanup *);
463 extern void do_my_cleanups (struct cleanup **, struct cleanup *);
464 extern void do_run_cleanups (struct cleanup *);
465 extern void do_exec_cleanups (struct cleanup *);
466 extern void do_exec_error_cleanups (struct cleanup *);
468 extern void discard_cleanups (struct cleanup *);
469 extern void discard_final_cleanups (struct cleanup *);
470 extern void discard_exec_error_cleanups (struct cleanup *);
471 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
473 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
474 make_cleanup function declarations below. Do not use this typedef
475 as a cast when passing functions into the make_cleanup() code.
476 Instead either use a bounce function or add a wrapper function.
477 Calling a f(char*) function with f(void*) is non-portable. */
478 typedef void (make_cleanup_ftype) (void *);
480 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
482 extern struct cleanup *make_cleanup_freeargv (char **);
485 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
487 extern struct cleanup *make_cleanup_close (int fd);
489 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
491 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
493 extern struct cleanup *make_my_cleanup (struct cleanup **,
494 make_cleanup_ftype *, void *);
496 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
498 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
499 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
501 extern struct cleanup *save_cleanups (void);
502 extern struct cleanup *save_final_cleanups (void);
503 extern struct cleanup *save_my_cleanups (struct cleanup **);
505 extern void restore_cleanups (struct cleanup *);
506 extern void restore_final_cleanups (struct cleanup *);
507 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
509 extern void free_current_contents (void *);
511 extern void null_cleanup (void *);
513 extern int myread (int, char *, int);
515 extern int query (char *, ...) ATTR_FORMAT (printf, 1, 2);
517 extern void init_page_info (void);
519 extern CORE_ADDR host_pointer_to_address (void *ptr);
520 extern void *address_to_host_pointer (CORE_ADDR addr);
522 /* From demangle.c */
524 extern void set_demangling_style (char *);
529 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
530 extern use_struct_convention_fn generic_use_struct_convention;
532 typedef unsigned char *(breakpoint_from_pc_fn) (CORE_ADDR * pcptr, int *lenptr);
534 /* Annotation stuff. */
536 extern int annotation_level; /* in stack.c */
538 extern void begin_line (void);
540 extern void wrap_here (char *);
542 extern void reinitialize_more_filter (void);
545 extern struct ui_file *gdb_stdout;
546 /* Serious error notifications */
547 extern struct ui_file *gdb_stderr;
548 /* Log/debug/trace messages that should bypass normal stdout/stderr
549 filtering. For momement, always call this stream using
550 *_unfiltered. In the very near future that restriction shall be
551 removed - either call shall be unfiltered. (cagney 1999-06-13). */
552 extern struct ui_file *gdb_stdlog;
553 /* Target output that should bypass normal stdout/stderr filtering.
554 For momement, always call this stream using *_unfiltered. In the
555 very near future that restriction shall be removed - either call
556 shall be unfiltered. (cagney 1999-07-02). */
557 extern struct ui_file *gdb_stdtarg;
561 #include "tuiCommand.h"
564 #include "tuiLayout.h"
570 /* More generic printf like operations. Filtered versions may return
571 non-locally on error. */
573 extern void fputs_filtered (const char *, struct ui_file *);
575 extern void fputs_unfiltered (const char *, struct ui_file *);
577 extern int fputc_filtered (int c, struct ui_file *);
579 extern int fputc_unfiltered (int c, struct ui_file *);
581 extern int putchar_filtered (int c);
583 extern int putchar_unfiltered (int c);
585 extern void puts_filtered (const char *);
587 extern void puts_unfiltered (const char *);
589 extern void puts_debug (char *prefix, char *string, char *suffix);
591 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
593 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
595 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
597 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
599 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
601 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
603 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
605 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
607 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
609 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
611 extern void print_spaces (int, struct ui_file *);
613 extern void print_spaces_filtered (int, struct ui_file *);
615 extern char *n_spaces (int);
617 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
619 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
621 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
623 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
624 extern void gdb_print_host_address (void *addr, struct ui_file *stream);
626 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
627 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
629 extern int strlen_paddr (void);
630 extern char *paddr (CORE_ADDR addr);
631 extern char *paddr_nz (CORE_ADDR addr);
632 extern char *paddr_u (CORE_ADDR addr);
633 extern char *paddr_d (LONGEST addr);
635 extern char *phex (ULONGEST l, int sizeof_l);
636 extern char *phex_nz (ULONGEST l, int sizeof_l);
638 extern void fprintf_symbol_filtered (struct ui_file *, char *,
641 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
643 extern void print_sys_errmsg (char *, int);
645 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
646 "const char *" in unistd.h, so we can't declare the argument
649 extern char *re_comp (const char *);
653 extern void symbol_file_command (char *, int);
655 /* Remote targets may wish to use this as their load function. */
656 extern void generic_load (char *name, int from_tty);
658 /* Summarise a download */
659 extern void print_transfer_performance (struct ui_file *stream,
660 unsigned long data_count,
661 unsigned long write_count,
662 unsigned long time_count);
666 typedef void initialize_file_ftype (void);
668 extern char *skip_quoted (char *);
670 extern char *gdb_readline (char *);
672 extern char *command_line_input (char *, int, char *);
674 extern void print_prompt (void);
676 extern int input_from_terminal_p (void);
678 extern int info_verbose;
680 /* From printcmd.c */
682 extern void set_next_address (CORE_ADDR);
684 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
687 extern int build_address_symbolic (CORE_ADDR addr,
695 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
697 extern void print_address (CORE_ADDR, struct ui_file *);
701 extern int openp (char *, int, char *, int, int, char **);
703 extern int source_full_path_of (char *, char **);
705 extern void mod_path (char *, char **);
707 extern void directory_command (char *, int);
709 extern void init_source_path (void);
711 extern char *symtab_to_filename (struct symtab *);
715 extern void exec_set_section_offsets (bfd_signed_vma text_off,
716 bfd_signed_vma data_off,
717 bfd_signed_vma bss_off);
721 extern int read_relative_register_raw_bytes (int, char *);
723 /* Possible lvalue types. Like enum language, this should be in
724 value.h, but needs to be here for the same reason. */
730 /* In memory. Could be a saved register. */
734 /* In a gdb internal variable. */
736 /* Part of a gdb internal variable (structure field). */
737 lval_internalvar_component,
738 /* In a register series in a frame not the current one, which may have been
739 partially saved or saved in different places (otherwise would be
740 lval_register or lval_memory). */
741 lval_reg_frame_relative
746 /* From readline (but not in any readline .h files). */
748 extern char *tilde_expand (char *);
750 /* Control types for commands */
752 enum misc_command_type
760 enum command_control_type
770 /* Structure for saved commands lines
771 (for breakpoints, defined commands, etc). */
775 struct command_line *next;
777 enum command_control_type control_type;
779 struct command_line **body_list;
782 extern struct command_line *read_command_lines (char *, int);
784 extern void free_command_lines (struct command_line **);
786 /* To continue the execution commands when running gdb asynchronously.
787 A continuation structure contains a pointer to a function to be called
788 to finish the command, once the target has stopped. Such mechanism is
789 used bt the finish and until commands, and in the remote protocol
790 when opening an extended-remote connection. */
792 struct continuation_arg
794 struct continuation_arg *next;
795 union continuation_data {
804 void (*continuation_hook) (struct continuation_arg *);
805 struct continuation_arg *arg_list;
806 struct continuation *next;
810 extern struct continuation *cmd_continuation;
811 /* Used only by the step_1 function. */
812 extern struct continuation *intermediate_continuation;
815 extern void add_continuation (void (*)(struct continuation_arg *),
816 struct continuation_arg *);
817 extern void do_all_continuations (void);
818 extern void discard_all_continuations (void);
820 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
821 struct continuation_arg *);
822 extern void do_all_intermediate_continuations (void);
823 extern void discard_all_intermediate_continuations (void);
825 /* String containing the current directory (what getwd would return). */
827 extern char *current_directory;
829 /* Default radixes for input and output. Only some values supported. */
830 extern unsigned input_radix;
831 extern unsigned output_radix;
833 /* Possibilities for prettyprint parameters to routines which print
834 things. Like enum language, this should be in value.h, but needs
835 to be here for the same reason. FIXME: If we can eliminate this
836 as an arg to LA_VAL_PRINT, then we can probably move it back to
841 Val_no_prettyprint = 0,
843 /* Use the default setting which the user has specified. */
848 /* Optional host machine definition. Pure autoconf targets will not
849 need a "xm.h" file. This will be a symlink to one of the xm-*.h
850 files, built by the `configure' script. */
856 /* Optional native machine support. Non-native (and possibly pure
857 multi-arch) targets do not need a "nm.h" file. This will be a
858 symlink to one of the nm-*.h files, built by the `configure'
865 /* Optional target machine definition. Pure multi-arch configurations
866 do not need a "tm.h" file. This will be a symlink to one of the
867 tm-*.h files, built by the `configure' script. */
873 /* GDB_MULTI_ARCH is normally set by configure.in using information
874 from configure.tgt or the config/%/%.mt Makefile fragment. Since
875 some targets have defined it in their "tm.h" file, delay providing
876 a default definition until after "tm.h" has been included.. */
878 #ifndef GDB_MULTI_ARCH
879 #define GDB_MULTI_ARCH 0
883 /* If the xm.h file did not define the mode string used to open the
884 files, assume that binary files are opened the same way as text
887 #include "fopen-same.h"
890 /* Microsoft C can't deal with const pointers */
895 #define CONST_PTR const
898 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
899 FIXME: Assumes 2's complement arithmetic */
901 #if !defined (UINT_MAX)
902 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
905 #if !defined (INT_MAX)
906 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
909 #if !defined (INT_MIN)
910 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
913 #if !defined (ULONG_MAX)
914 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
917 #if !defined (LONG_MAX)
918 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
921 #if !defined (ULONGEST_MAX)
922 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
925 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
926 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
929 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
930 arguments to a function, number in a value history, register number, etc.)
931 where the value must not be larger than can fit in an int. */
933 extern int longest_to_int (LONGEST);
935 /* Assorted functions we can declare, now that const and volatile are
938 extern char *savestring (const char *, size_t);
940 extern char *msavestring (void *, const char *, size_t);
942 extern char *mstrsave (void *, const char *);
944 #if !defined (USE_MMALLOC)
945 /* NOTE: cagney/2000-03-04: The mmalloc functions need to use PTR
946 rather than void* so that they are consistent with the delcaration
947 in ../mmalloc/mmalloc.h. */
948 extern PTR mcalloc (PTR, size_t, size_t);
949 extern PTR mmalloc (PTR, size_t);
950 extern PTR mrealloc (PTR, PTR, size_t);
951 extern void mfree (PTR, PTR);
954 /* Robust versions of same. Throw an internal error when no memory,
955 guard against stray NULL arguments. */
956 extern void *xmmalloc (void *md, size_t size);
957 extern void *xmrealloc (void *md, void *ptr, size_t size);
958 extern void *xmcalloc (void *md, size_t number, size_t size);
959 extern void xmfree (void *md, void *ptr);
961 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
963 extern void xfree (void *);
965 /* Like asprintf/vasprintf but get an internal_error if the call
967 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
968 extern void xvasprintf (char **ret, const char *format, va_list ap);
970 extern int parse_escape (char **);
972 /* Message to be printed before the error message, when an error occurs. */
974 extern char *error_pre_print;
976 /* Message to be printed before the error message, when an error occurs. */
978 extern char *quit_pre_print;
980 /* Message to be printed before the warning message, when a warning occurs. */
982 extern char *warning_pre_print;
984 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
986 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN;
988 /* DEPRECATED: Use error(), verror() or error_stream(). */
989 extern NORETURN void error_begin (void);
991 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
993 /* Returns a freshly allocate buffer containing the last error
995 extern char *error_last_message (void);
997 extern NORETURN void internal_verror (const char *file, int line,
998 const char *, va_list ap) ATTR_NORETURN;
1000 extern NORETURN void internal_error (const char *file, int line,
1001 const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
1003 extern NORETURN void nomem (long) ATTR_NORETURN;
1005 /* Reasons for calling return_to_top_level. Note: enum value 0 is
1006 reserved for internal use as the return value from an initial
1011 /* User interrupt. */
1013 /* Any other error. */
1017 #define ALL_CLEANUPS ((struct cleanup *)0)
1019 #define RETURN_MASK(reason) (1 << (int)(reason))
1020 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
1021 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
1022 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
1023 typedef int return_mask;
1025 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
1027 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
1028 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
1029 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
1030 value. It's unfortunate that, catch_errors() does not return an
1031 indication of the exact exception that it caught - quit_flag might
1034 typedef int (catch_errors_ftype) (PTR);
1035 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
1037 /* Template to catch_errors() that wraps calls to command
1040 typedef void (catch_command_errors_ftype) (char *, int);
1041 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
1043 extern void warning_begin (void);
1045 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
1047 /* Global functions from other, non-gdb GNU thingies.
1048 Libiberty thingies are no longer declared here. We include libiberty.h
1051 #ifndef GETENV_PROVIDED
1052 extern char *getenv (const char *);
1055 /* From other system libraries */
1057 #ifdef HAVE_STDDEF_H
1061 #ifdef HAVE_STDLIB_H
1062 #if defined(_MSC_VER) && !defined(__cplusplus)
1063 /* msvc defines these in stdlib.h for c code */
1070 #define min(a, b) ((a) < (b) ? (a) : (b))
1073 #define max(a, b) ((a) > (b) ? (a) : (b))
1077 /* We take the address of fclose later, but some stdio's forget
1078 to declare this. We can't always declare it since there's
1079 no way to declare the parameters without upsetting some compiler
1082 #ifndef FCLOSE_PROVIDED
1083 extern int fclose (FILE *);
1087 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1090 /* Various possibilities for alloca. */
1093 #define alloca __builtin_alloca
1094 #else /* Not GNU C */
1095 #ifdef HAVE_ALLOCA_H
1102 /* We need to be careful not to declare this in a way which conflicts with
1103 bison. Bison never declares it as char *, but under various circumstances
1104 (like __hpux) we need to use void *. */
1105 extern void *alloca ();
1106 #endif /* Not _AIX */
1107 #endif /* Not HAVE_ALLOCA_H */
1108 #endif /* Not GNU C */
1109 #endif /* alloca not defined */
1111 /* HOST_BYTE_ORDER must be defined to one of these. */
1113 #ifdef HAVE_ENDIAN_H
1117 #if !defined (BIG_ENDIAN)
1118 #define BIG_ENDIAN 4321
1121 #if !defined (LITTLE_ENDIAN)
1122 #define LITTLE_ENDIAN 1234
1125 /* Dynamic target-system-dependent parameters for GDB. */
1126 #include "gdbarch.h"
1127 #if (GDB_MULTI_ARCH == 0)
1128 /* Multi-arch targets _should_ be including "arch-utils.h" directly
1129 into their *-tdep.c file. This is a prop to help old non-
1130 multi-arch targets to continue to compile. */
1131 #include "arch-utils.h"
1134 /* Static target-system-dependent parameters for GDB. */
1136 /* Number of bits in a char or unsigned char for the target machine.
1137 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1138 #if !defined (TARGET_CHAR_BIT)
1139 #define TARGET_CHAR_BIT 8
1142 /* If we picked up a copy of CHAR_BIT from a configuration file
1143 (which may get it by including <limits.h>) then use it to set
1144 the number of bits in a host char. If not, use the same size
1147 #if defined (CHAR_BIT)
1148 #define HOST_CHAR_BIT CHAR_BIT
1150 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1153 /* The bit byte-order has to do just with numbering of bits in
1154 debugging symbols and such. Conceptually, it's quite separate
1155 from byte/word byte order. */
1157 #if !defined (BITS_BIG_ENDIAN)
1158 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1163 extern LONGEST extract_signed_integer (void *, int);
1165 extern ULONGEST extract_unsigned_integer (void *, int);
1167 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1169 extern CORE_ADDR extract_address (void *, int);
1171 extern CORE_ADDR extract_typed_address (void *buf, struct type *type);
1173 extern void store_signed_integer (void *, int, LONGEST);
1175 extern void store_unsigned_integer (void *, int, ULONGEST);
1177 extern void store_address (void *, int, LONGEST);
1179 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1181 /* Setup definitions for host and target floating point formats. We need to
1182 consider the format for `float', `double', and `long double' for both target
1183 and host. We need to do this so that we know what kind of conversions need
1184 to be done when converting target numbers to and from the hosts DOUBLEST
1187 /* This is used to indicate that we don't know the format of the floating point
1188 number. Typically, this is useful for native ports, where the actual format
1189 is irrelevant, since no conversions will be taking place. */
1191 extern const struct floatformat floatformat_unknown;
1193 #if HOST_BYTE_ORDER == BIG_ENDIAN
1194 #ifndef HOST_FLOAT_FORMAT
1195 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
1197 #ifndef HOST_DOUBLE_FORMAT
1198 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
1200 #else /* LITTLE_ENDIAN */
1201 #ifndef HOST_FLOAT_FORMAT
1202 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
1204 #ifndef HOST_DOUBLE_FORMAT
1205 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
1209 #ifndef HOST_LONG_DOUBLE_FORMAT
1210 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
1213 /* Use `long double' if the host compiler supports it. (Note that this is not
1214 necessarily any longer than `double'. On SunOS/gcc, it's the same as
1215 double.) This is necessary because GDB internally converts all floating
1216 point values to the widest type supported by the host.
1218 There are problems however, when the target `long double' is longer than the
1219 host's `long double'. In general, we'll probably reduce the precision of
1220 any such values and print a warning. */
1222 #ifdef HAVE_LONG_DOUBLE
1223 typedef long double DOUBLEST;
1225 typedef double DOUBLEST;
1228 extern void floatformat_to_doublest (const struct floatformat *,
1229 char *, DOUBLEST *);
1230 extern void floatformat_from_doublest (const struct floatformat *,
1231 DOUBLEST *, char *);
1233 extern int floatformat_is_negative (const struct floatformat *, char *);
1234 extern int floatformat_is_nan (const struct floatformat *, char *);
1235 extern char *floatformat_mantissa (const struct floatformat *, char *);
1237 extern DOUBLEST extract_floating (void *, int);
1238 extern void store_floating (void *, int, DOUBLEST);
1240 /* On some machines there are bits in addresses which are not really
1241 part of the address, but are used by the kernel, the hardware, etc.
1242 for special purposes. ADDR_BITS_REMOVE takes out any such bits
1243 so we get a "real" address such as one would find in a symbol
1244 table. This is used only for addresses of instructions, and even then
1245 I'm not sure it's used in all contexts. It exists to deal with there
1246 being a few stray bits in the PC which would mislead us, not as some sort
1247 of generic thing to handle alignment or segmentation (it's possible it
1248 should be in TARGET_READ_PC instead). */
1249 #if !defined (ADDR_BITS_REMOVE)
1250 #define ADDR_BITS_REMOVE(addr) (addr)
1251 #endif /* No ADDR_BITS_REMOVE. */
1255 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1257 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1259 extern int watchdog;
1261 /* Hooks for alternate command interfaces. */
1264 /* The name of the interpreter if specified on the command line. */
1265 extern char *interpreter_p;
1268 /* If a given interpreter matches INTERPRETER_P then it should update
1269 command_loop_hook and init_ui_hook with the per-interpreter
1271 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1273 struct target_waitstatus;
1274 struct cmd_list_element;
1276 /* Should the asynchronous variant of the interpreter (using the
1277 event-loop) be enabled? */
1278 extern int event_loop_p;
1280 extern void (*init_ui_hook) (char *argv0);
1281 extern void (*command_loop_hook) (void);
1282 extern void (*show_load_progress) (const char *section,
1283 unsigned long section_sent,
1284 unsigned long section_size,
1285 unsigned long total_sent,
1286 unsigned long total_size);
1287 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1288 int line, int stopline,
1290 extern struct frame_info *parse_frame_specification (char *frame_exp);
1291 extern int (*query_hook) (const char *, va_list);
1292 extern void (*warning_hook) (const char *, va_list);
1293 extern void (*flush_hook) (struct ui_file * stream);
1294 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1295 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1296 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1297 extern void (*interactive_hook) (void);
1298 extern void (*registers_changed_hook) (void);
1299 extern void (*readline_begin_hook) (char *,...);
1300 extern char *(*readline_hook) (char *);
1301 extern void (*readline_end_hook) (void);
1302 extern void (*register_changed_hook) (int regno);
1303 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1304 extern void (*context_hook) (int);
1305 extern int (*target_wait_hook) (int pid, struct target_waitstatus * status);
1307 extern void (*attach_hook) (void);
1308 extern void (*detach_hook) (void);
1309 extern void (*call_command_hook) (struct cmd_list_element * c,
1310 char *cmd, int from_tty);
1312 extern void (*set_hook) (struct cmd_list_element * c);
1314 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1316 extern void (*error_begin_hook) (void);
1318 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1321 /* Inhibit window interface if non-zero. */
1323 extern int use_windows;
1325 /* Symbolic definitions of filename-related things. */
1326 /* FIXME, this doesn't work very well if host and executable
1327 filesystems conventions are different. */
1329 #ifndef DIRNAME_SEPARATOR
1330 #define DIRNAME_SEPARATOR ':'
1334 #if defined(__GO32__)||defined(_WIN32)
1335 #define SLASH_P(X) ((X)=='\\')
1337 #define SLASH_P(X) ((X)=='/')
1342 #if defined(__GO32__)||defined(_WIN32)
1343 #define SLASH_CHAR '\\'
1345 #define SLASH_CHAR '/'
1349 #ifndef SLASH_STRING
1350 #if defined(__GO32__)||defined(_WIN32)
1351 #define SLASH_STRING "\\"
1353 #define SLASH_STRING "/"
1358 #define ROOTED_P(X) (SLASH_P((X)[0]))
1361 /* On some systems, PIDGET is defined to extract the inferior pid from
1362 an internal pid that has the thread id and pid in seperate bit
1363 fields. If not defined, then just use the entire internal pid as
1367 #define PIDGET(PID) (PID)
1368 #define TIDGET(PID) 0
1369 #define MERGEPID(PID, TID) (PID)
1372 /* Define well known filenos if the system does not define them. */
1373 #ifndef STDIN_FILENO
1374 #define STDIN_FILENO 0
1376 #ifndef STDOUT_FILENO
1377 #define STDOUT_FILENO 1
1379 #ifndef STDERR_FILENO
1380 #define STDERR_FILENO 2
1383 /* If this definition isn't overridden by the header files, assume
1384 that isatty and fileno exist on this system. */
1386 #define ISATTY(FP) (isatty (fileno (FP)))
1390 /* FIXME: cagney/1999-12-13: The following will be moved to gdb.h /
1391 libgdb.h or gdblib.h. */
1393 /* Return-code (RC) from a gdb library call. (The abreviation RC is
1394 taken from the sim/common directory.) */
1397 /* The operation failed. The failure message can be fetched by
1398 calling ``char *error_last_message(void)''. The value is
1399 determined by the catch_errors() interface. */
1400 /* NOTE: Since ``defs.h:catch_errors()'' does not return an error /
1401 internal / quit indication it is not possible to return that
1404 /* No error occured but nothing happened. Due to the catch_errors()
1405 interface, this must be non-zero. */
1407 /* The operation was successful. Due to the catch_errors()
1408 interface, this must be non-zero. */
1413 /* Print the specified breakpoint on GDB_STDOUT. (Eventually this
1414 function will ``print'' the object on ``output''). */
1415 enum gdb_rc gdb_breakpoint_query (/* struct {ui,gdb}_out *output, */ int bnum);
1417 /* Create a breakpoint at ADDRESS (a GDB source and line). */
1418 enum gdb_rc gdb_breakpoint (char *address, char *condition,
1419 int hardwareflag, int tempflag,
1420 int thread, int ignore_count);
1421 enum gdb_rc gdb_thread_select (/* output object */ char *tidstr);
1424 /* Print a list of known thread ids. */
1425 enum gdb_rc gdb_list_thread_ids (/* output object */);
1427 /* Switch thread and print notification. */
1429 #endif /* #ifndef DEFS_H */