]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/defs.h
import gdb-1999-11-16 snapshot
[thirdparty/binutils-gdb.git] / gdb / defs.h
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, 89, 91, 92, 93, 94, 95, 96, 98, 1999
4 Free Software Foundation, Inc.
5
6 This file is part of GDB.
7
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.
12
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.
17
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. */
22
23 #ifndef DEFS_H
24 #define DEFS_H
25
26 #include "config.h" /* Generated by configure */
27 #include <stdio.h>
28 #include <errno.h> /* System call error return status */
29 #include <limits.h>
30
31 #ifdef HAVE_STDDEF_H
32 #include <stddef.h>
33 #else
34 #include <sys/types.h> /* for size_t */
35 #endif
36
37 #ifdef HAVE_UNISTD_H
38 #include <unistd.h>
39 #endif
40
41 /* Just in case they're not defined in stdio.h. */
42
43 #ifndef SEEK_SET
44 #define SEEK_SET 0
45 #endif
46 #ifndef SEEK_CUR
47 #define SEEK_CUR 1
48 #endif
49
50 /* First include ansidecl.h so we can use the various macro definitions
51 here and in all subsequent file inclusions. */
52
53 #include "ansidecl.h"
54
55 #include <stdarg.h> /* for va_list */
56
57 #include "libiberty.h"
58
59 /* libiberty.h can't declare this one, but evidently we can. */
60 extern char *strsignal (int);
61
62 #include "progress.h"
63
64 #ifdef USE_MMALLOC
65 #include "mmalloc.h"
66 #endif
67
68 /* For BFD64 and bfd_vma. */
69 #include "bfd.h"
70
71 /* An address in the program being debugged. Host byte order. Rather
72 than duplicate all the logic in BFD which figures out what type
73 this is (long, long long, etc.) and whether it needs to be 64
74 bits (the host/target interactions are subtle), we just use
75 bfd_vma. */
76
77 typedef bfd_vma CORE_ADDR;
78
79 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
80
81 #ifndef LONGEST
82
83 #ifdef BFD64
84
85 #define LONGEST BFD_HOST_64_BIT
86 #define ULONGEST BFD_HOST_U_64_BIT
87
88 #else /* No BFD64 */
89
90 #ifdef CC_HAS_LONG_LONG
91 #define LONGEST long long
92 #define ULONGEST unsigned long long
93 #else
94 #ifdef BFD_HOST_64_BIT
95 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
96 (e.g. i386-windows) so try it. */
97 #define LONGEST BFD_HOST_64_BIT
98 #define ULONGEST BFD_HOST_U_64_BIT
99 #else
100 #define LONGEST long
101 #define ULONGEST unsigned long
102 #endif
103 #endif
104
105 #endif /* No BFD64 */
106
107 #endif /* ! LONGEST */
108
109 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
110 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
111
112
113 #ifndef min
114 #define min(a, b) ((a) < (b) ? (a) : (b))
115 #endif
116 #ifndef max
117 #define max(a, b) ((a) > (b) ? (a) : (b))
118 #endif
119
120 /* Gdb does *lots* of string compares. Use macros to speed them up by
121 avoiding function calls if the first characters are not the same. */
122
123 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : (int)*(a) - (int)*(b))
124 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
125 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
126
127 /* The character GNU C++ uses to build identifiers that must be unique from
128 the program's identifiers (such as $this and $$vptr). */
129 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
130
131 /* Check if a character is one of the commonly used C++ marker characters. */
132 extern int is_cplus_marker (int);
133
134 /* use tui interface if non-zero */
135 extern int tui_version;
136
137 #if defined(TUI)
138 /* all invocations of TUIDO should have two sets of parens */
139 #define TUIDO(x) tuiDo x
140 #else
141 #define TUIDO(x)
142 #endif
143
144 /* enable xdb commands if set */
145 extern int xdb_commands;
146
147 /* enable dbx commands if set */
148 extern int dbx_commands;
149
150 extern int quit_flag;
151 extern int immediate_quit;
152 extern int sevenbit_strings;
153
154 extern void quit (void);
155
156 #ifdef QUIT
157 /* do twice to force compiler warning */
158 #define QUIT_FIXME "FIXME"
159 #define QUIT_FIXME "ignoring redefinition of QUIT"
160 #else
161 #define QUIT { \
162 if (quit_flag) quit (); \
163 if (interactive_hook) interactive_hook (); \
164 PROGRESS (1); \
165 }
166 #endif
167
168 /* Languages represented in the symbol table and elsewhere.
169 This should probably be in language.h, but since enum's can't
170 be forward declared to satisfy opaque references before their
171 actual definition, needs to be here. */
172
173 enum language
174 {
175 language_unknown, /* Language not known */
176 language_auto, /* Placeholder for automatic setting */
177 language_c, /* C */
178 language_cplus, /* C++ */
179 language_java, /* Java */
180 language_chill, /* Chill */
181 language_fortran, /* Fortran */
182 language_m2, /* Modula-2 */
183 language_asm, /* Assembly language */
184 language_scm /* Scheme / Guile */
185 };
186
187 enum precision_type
188 {
189 single_precision,
190 double_precision,
191 unspecified_precision
192 };
193
194 /* the cleanup list records things that have to be undone
195 if an error happens (descriptors to be closed, memory to be freed, etc.)
196 Each link in the chain records a function to call and an
197 argument to give it.
198
199 Use make_cleanup to add an element to the cleanup chain.
200 Use do_cleanups to do all cleanup actions back to a given
201 point in the chain. Use discard_cleanups to remove cleanups
202 from the chain back to a given point, not doing them. */
203
204 struct cleanup
205 {
206 struct cleanup *next;
207 void (*function) (PTR);
208 PTR arg;
209 };
210
211
212 /* The ability to declare that a function never returns is useful, but
213 not really required to compile GDB successfully, so the NORETURN and
214 ATTR_NORETURN macros normally expand into nothing. */
215
216 /* If compiling with older versions of GCC, a function may be declared
217 "volatile" to indicate that it does not return. */
218
219 #ifndef NORETURN
220 #if defined(__GNUC__) \
221 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
222 #define NORETURN volatile
223 #else
224 #define NORETURN /* nothing */
225 #endif
226 #endif
227
228 /* GCC 2.5 and later versions define a function attribute "noreturn",
229 which is the preferred way to declare that a function never returns.
230 However GCC 2.7 appears to be the first version in which this fully
231 works everywhere we use it. */
232
233 #ifndef ATTR_NORETURN
234 #if defined(__GNUC__) && __GNUC__ >= 2 && __GNUC_MINOR__ >= 7
235 #define ATTR_NORETURN __attribute__ ((noreturn))
236 #else
237 #define ATTR_NORETURN /* nothing */
238 #endif
239 #endif
240
241 #ifndef ATTR_FORMAT
242 #if defined(__GNUC__) && __GNUC__ >= 2 && __GNUC_MINOR__ >= 4
243 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
244 #else
245 #define ATTR_FORMAT(type, x, y) /* nothing */
246 #endif
247 #endif
248
249 /* Needed for various prototypes */
250
251 struct symtab;
252 struct breakpoint;
253
254 /* From blockframe.c */
255
256 extern int inside_entry_func (CORE_ADDR);
257
258 extern int inside_entry_file (CORE_ADDR addr);
259
260 extern int inside_main_func (CORE_ADDR pc);
261
262 /* From ch-lang.c, for the moment. (FIXME) */
263
264 extern char *chill_demangle (const char *);
265
266 /* From utils.c */
267
268 extern void initialize_utils (void);
269
270 extern void notice_quit (void);
271
272 extern int strcmp_iw (const char *, const char *);
273
274 extern int subset_compare (char *, char *);
275
276 extern char *safe_strerror (int);
277
278 extern char *safe_strsignal (int);
279
280 extern void init_malloc (void *);
281
282 extern void request_quit (int);
283
284 extern void do_cleanups (struct cleanup *);
285 extern void do_final_cleanups (struct cleanup *);
286 extern void do_my_cleanups (struct cleanup **, struct cleanup *);
287 extern void do_run_cleanups (struct cleanup *);
288 extern void do_exec_cleanups (struct cleanup *);
289 extern void do_exec_error_cleanups (struct cleanup *);
290
291 extern void discard_cleanups (struct cleanup *);
292 extern void discard_final_cleanups (struct cleanup *);
293 extern void discard_exec_error_cleanups (struct cleanup *);
294 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
295
296 typedef void (*make_cleanup_func) (void *);
297
298 extern struct cleanup *make_cleanup (make_cleanup_func, void *);
299
300 extern struct cleanup *make_cleanup_freeargv (char **);
301
302 struct gdb_file;
303 extern struct cleanup *make_cleanup_gdb_file_delete (struct gdb_file *);
304
305 extern struct cleanup *make_final_cleanup (make_cleanup_func, void *);
306
307 extern struct cleanup *make_my_cleanup (struct cleanup **,
308 make_cleanup_func, void *);
309
310 extern struct cleanup *make_run_cleanup (make_cleanup_func, void *);
311
312 extern struct cleanup *make_exec_cleanup (make_cleanup_func, void *);
313 extern struct cleanup *make_exec_error_cleanup (make_cleanup_func, void *);
314
315 extern struct cleanup *save_cleanups (void);
316 extern struct cleanup *save_final_cleanups (void);
317 extern struct cleanup *save_my_cleanups (struct cleanup **);
318
319 extern void restore_cleanups (struct cleanup *);
320 extern void restore_final_cleanups (struct cleanup *);
321 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
322
323 extern void free_current_contents (char **);
324
325 extern void null_cleanup (PTR);
326
327 extern int myread (int, char *, int);
328
329 extern int query (char *, ...) ATTR_FORMAT (printf, 1, 2);
330
331 #if !defined (USE_MMALLOC)
332 extern PTR mmalloc (PTR, size_t);
333 extern PTR mrealloc (PTR, PTR, size_t);
334 extern void mfree (PTR, PTR);
335 #endif
336
337 extern void init_page_info (void);
338
339 /* From demangle.c */
340
341 extern void set_demangling_style (char *);
342
343 /* From tm.h */
344
345 struct type;
346 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
347 extern use_struct_convention_fn generic_use_struct_convention;
348
349 typedef unsigned char *(breakpoint_from_pc_fn) (CORE_ADDR * pcptr, int *lenptr);
350 \f
351 /* Annotation stuff. */
352
353 extern int annotation_level; /* in stack.c */
354 \f
355 extern void begin_line (void);
356
357 extern void wrap_here (char *);
358
359 extern void reinitialize_more_filter (void);
360
361 struct gdb_file;
362 typedef struct gdb_file GDB_FILE; /* deprecated */
363
364 /* Normal results */
365 extern GDB_FILE *gdb_stdout;
366 /* Serious error notifications */
367 extern GDB_FILE *gdb_stderr;
368 /* Log/debug/trace messages that should bypass normal stdout/stderr
369 filtering. For momement, always call this stream using
370 *_unfiltered. In the very near future that restriction shall be
371 removed - either call shall be unfiltered. (cagney 1999-06-13). */
372 extern GDB_FILE *gdb_stdlog;
373 /* Target output that should bypass normal stdout/stderr filtering.
374 For momement, always call this stream using *_unfiltered. In the
375 very near future that restriction shall be removed - either call
376 shall be unfiltered. (cagney 1999-07-02). */
377 extern GDB_FILE *gdb_stdtarg;
378
379 #if defined(TUI)
380 #include "tui.h"
381 #include "tuiCommand.h"
382 #include "tuiData.h"
383 #include "tuiIO.h"
384 #include "tuiLayout.h"
385 #include "tuiWin.h"
386 #endif
387
388 /* Create a generic gdb_file object with null methods. */
389
390 extern struct gdb_file *gdb_file_new (void);
391
392 /* Override methods used by specific implementations of a GDB_FILE
393 object. */
394
395 typedef void (gdb_file_flush_ftype) (struct gdb_file * stream);
396 extern void set_gdb_file_flush (struct gdb_file *stream, gdb_file_flush_ftype * flush);
397
398 /* NOTE: Both fputs and write methods are available. Default
399 implementations that mapping one onto the other are included. */
400 typedef void (gdb_file_write_ftype) (struct gdb_file * stream, const char *buf, long length_buf);
401 extern void set_gdb_file_write (struct gdb_file *stream, gdb_file_write_ftype *fputs);
402
403 typedef void (gdb_file_fputs_ftype) (const char *, struct gdb_file * stream);
404 extern void set_gdb_file_fputs (struct gdb_file *stream, gdb_file_fputs_ftype * fputs);
405
406 typedef int (gdb_file_isatty_ftype) (struct gdb_file * stream);
407 extern void set_gdb_file_isatty (struct gdb_file *stream, gdb_file_isatty_ftype * isatty);
408
409 typedef void (gdb_file_rewind_ftype) (struct gdb_file * stream);
410 extern void set_gdb_file_rewind (struct gdb_file *stream, gdb_file_rewind_ftype * rewind);
411
412 typedef void (gdb_file_put_method_ftype) (void *object, const char *buffer, long length_buffer);
413 typedef void (gdb_file_put_ftype) (struct gdb_file *stream, gdb_file_put_method_ftype * method, void *context);
414 extern void set_gdb_file_put (struct gdb_file *stream, gdb_file_put_ftype * put);
415
416 typedef void (gdb_file_delete_ftype) (struct gdb_file * stream);
417 extern void set_gdb_file_data (struct gdb_file *stream, void *data, gdb_file_delete_ftype * delete);
418
419 extern void *gdb_file_data (struct gdb_file *file);
420
421
422 /* Open the specified FILE as a gdb_file. */
423 extern struct gdb_file *stdio_fileopen (FILE *file);
424
425 /* Open NAME returning a GDB_FILE. */
426 extern GDB_FILE *gdb_fopen (char *name, char *mode);
427
428 /* Create/open a memory based file. Can be used as a scratch
429 buffer for collecting output. */
430 extern struct gdb_file *mem_fileopen (void);
431
432 extern void gdb_flush (GDB_FILE *);
433
434 extern void gdb_file_delete (struct gdb_file *stream);
435
436 extern void gdb_file_rewind (struct gdb_file *stream);
437
438 extern int gdb_file_isatty (GDB_FILE *);
439
440 extern void gdb_file_write (struct gdb_file *file, const char *buf, long length_buf);
441
442 /* NOTE: copies left to right */
443 extern void gdb_file_put (struct gdb_file *src, gdb_file_put_method_ftype *write, void *dest);
444
445 /* Returns a freshly allocated buffer containing the entire contents
446 of FILE (as determined by gdb_file_put()) with a NUL character
447 appended. LENGTH is set to the size of the buffer minus that
448 appended NUL. */
449 extern char *gdb_file_xstrdup (struct gdb_file *file, long *length);
450
451 /* More generic printf like operations */
452
453 extern void fputs_filtered (const char *, GDB_FILE *);
454
455 extern void fputs_unfiltered (const char *, GDB_FILE *);
456
457 extern int fputc_filtered (int c, GDB_FILE *);
458
459 extern int fputc_unfiltered (int c, GDB_FILE *);
460
461 extern int putchar_unfiltered (int c);
462
463 extern void puts_filtered (const char *);
464
465 extern void puts_unfiltered (const char *);
466
467 extern void puts_debug (char *prefix, char *string, char *suffix);
468
469 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
470
471 extern void vfprintf_filtered (GDB_FILE *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
472
473 extern void fprintf_filtered (GDB_FILE *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
474
475 extern void fprintfi_filtered (int, GDB_FILE *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
476
477 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
478
479 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
480
481 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
482
483 extern void vfprintf_unfiltered (GDB_FILE *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
484
485 extern void fprintf_unfiltered (GDB_FILE *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
486
487 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
488
489 /* #if defined (TUI) */
490 /* DEPRECATED: Only the TUI should use these methods. */
491 extern struct gdb_file *tui_fileopen (FILE *);
492 extern struct gdb_file *tui_sfileopen (int);
493 extern char *tui_file_get_strbuf (struct gdb_file *);
494 extern void tui_file_adjust_strbuf (int, struct gdb_file *);
495 /* #endif */
496
497 extern void print_spaces (int, GDB_FILE *);
498
499 extern void print_spaces_filtered (int, GDB_FILE *);
500
501 extern char *n_spaces (int);
502
503 extern void fputstr_filtered (const char *str, int quotr, GDB_FILE * stream);
504
505 extern void fputstr_unfiltered (const char *str, int quotr, GDB_FILE * stream);
506
507 extern void fputstrn_unfiltered (const char *str, int n, int quotr, GDB_FILE * stream);
508
509 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
510 extern void gdb_print_host_address (void *addr, struct gdb_file *stream);
511
512 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
513 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
514 for ``%*''. */
515 extern int strlen_paddr (void);
516 extern char *paddr (CORE_ADDR addr);
517 extern char *paddr_nz (CORE_ADDR addr);
518 extern char *paddr_u (CORE_ADDR addr);
519 extern char *paddr_d (LONGEST addr);
520
521 typedef bfd_vma t_reg;
522 extern char *preg (t_reg reg);
523 extern char *preg_nz (t_reg reg);
524
525 extern void fprintf_symbol_filtered (GDB_FILE *, char *,
526 enum language, int);
527
528 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
529
530 extern void print_sys_errmsg (char *, int);
531
532 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
533 "const char *" in unistd.h, so we can't declare the argument
534 as "char *". */
535
536 extern char *re_comp (const char *);
537
538 /* From symfile.c */
539
540 extern void symbol_file_command (char *, int);
541
542 /* Remote targets may wish to use this as their load function. */
543 extern void generic_load (char *name, int from_tty);
544
545 /* Summarise a download */
546 extern void print_transfer_performance (struct gdb_file *stream,
547 unsigned long data_count,
548 unsigned long write_count,
549 unsigned long time_count);
550
551 /* From top.c */
552
553 typedef void initialize_file_ftype (void);
554
555 extern char *skip_quoted (char *);
556
557 extern char *gdb_readline (char *);
558
559 extern char *command_line_input (char *, int, char *);
560
561 extern void print_prompt (void);
562
563 extern int input_from_terminal_p (void);
564
565 extern int info_verbose;
566
567 /* From printcmd.c */
568
569 extern void set_next_address (CORE_ADDR);
570
571 extern void print_address_symbolic (CORE_ADDR, GDB_FILE *, int,
572 char *);
573
574 extern void print_address_numeric (CORE_ADDR, int, GDB_FILE *);
575
576 extern void print_address (CORE_ADDR, GDB_FILE *);
577
578 /* From source.c */
579
580 extern int openp (char *, int, char *, int, int, char **);
581
582 extern int source_full_path_of (char *, char **);
583
584 extern void mod_path (char *, char **);
585
586 extern void directory_command (char *, int);
587
588 extern void init_source_path (void);
589
590 extern char *symtab_to_filename (struct symtab *);
591
592 /* From exec.c */
593
594 extern void exec_set_section_offsets (bfd_signed_vma text_off,
595 bfd_signed_vma data_off,
596 bfd_signed_vma bss_off);
597
598 /* From findvar.c */
599
600 extern int read_relative_register_raw_bytes (int, char *);
601
602 /* Possible lvalue types. Like enum language, this should be in
603 value.h, but needs to be here for the same reason. */
604
605 enum lval_type
606 {
607 /* Not an lval. */
608 not_lval,
609 /* In memory. Could be a saved register. */
610 lval_memory,
611 /* In a register. */
612 lval_register,
613 /* In a gdb internal variable. */
614 lval_internalvar,
615 /* Part of a gdb internal variable (structure field). */
616 lval_internalvar_component,
617 /* In a register series in a frame not the current one, which may have been
618 partially saved or saved in different places (otherwise would be
619 lval_register or lval_memory). */
620 lval_reg_frame_relative
621 };
622
623 struct frame_info;
624
625 void default_get_saved_register (char *raw_buffer, int *optimized,
626 CORE_ADDR * addrp,
627 struct frame_info *frame, int regnum,
628 enum lval_type *lval);
629
630 /* From readline (but not in any readline .h files). */
631
632 extern char *tilde_expand (char *);
633
634 /* Control types for commands */
635
636 enum misc_command_type
637 {
638 ok_command,
639 end_command,
640 else_command,
641 nop_command
642 };
643
644 enum command_control_type
645 {
646 simple_control,
647 break_control,
648 continue_control,
649 while_control,
650 if_control,
651 invalid_control
652 };
653
654 /* Structure for saved commands lines
655 (for breakpoints, defined commands, etc). */
656
657 struct command_line
658 {
659 struct command_line *next;
660 char *line;
661 enum command_control_type control_type;
662 int body_count;
663 struct command_line **body_list;
664 };
665
666 extern struct command_line *read_command_lines (char *, int);
667
668 extern void free_command_lines (struct command_line **);
669
670 /* To continue the execution commands when running gdb asynchronously.
671 A continuation structure contains a pointer to a function to be called
672 to finish the command, once the target has stopped. Such mechanism is
673 used bt the finish and until commands, and in the remote protocol
674 when opening an extended-remote connection. */
675
676 struct continuation_arg
677 {
678 struct continuation_arg *next;
679 PTR data;
680 };
681
682 struct continuation
683 {
684 void (*continuation_hook) (struct continuation_arg *);
685 struct continuation_arg *arg_list;
686 struct continuation *next;
687 };
688 struct continuation continuation;
689
690 /* In infrun.c. */
691 extern struct continuation *cmd_continuation;
692
693 /* From utils.c */
694 extern void add_continuation (void (*)(struct continuation_arg *),
695 struct continuation_arg *);
696 extern void do_all_continuations (void);
697 extern void discard_all_continuations (void);
698
699 /* String containing the current directory (what getwd would return). */
700
701 extern char *current_directory;
702
703 /* Default radixes for input and output. Only some values supported. */
704 extern unsigned input_radix;
705 extern unsigned output_radix;
706
707 /* Possibilities for prettyprint parameters to routines which print
708 things. Like enum language, this should be in value.h, but needs
709 to be here for the same reason. FIXME: If we can eliminate this
710 as an arg to LA_VAL_PRINT, then we can probably move it back to
711 value.h. */
712
713 enum val_prettyprint
714 {
715 Val_no_prettyprint = 0,
716 Val_prettyprint,
717 /* Use the default setting which the user has specified. */
718 Val_pretty_default
719 };
720 \f
721
722 /* Host machine definition. This will be a symlink to one of the
723 xm-*.h files, built by the `configure' script. */
724
725 #include "xm.h"
726
727 /* Native machine support. This will be a symlink to one of the
728 nm-*.h files, built by the `configure' script. */
729
730 #include "nm.h"
731
732 /* Target machine definition. This will be a symlink to one of the
733 tm-*.h files, built by the `configure' script. */
734
735 #include "tm.h"
736
737 /* If the xm.h file did not define the mode string used to open the
738 files, assume that binary files are opened the same way as text
739 files */
740 #ifndef FOPEN_RB
741 #include "fopen-same.h"
742 #endif
743
744 /* Microsoft C can't deal with const pointers */
745
746 #ifdef _MSC_VER
747 #define CONST_PTR
748 #else
749 #define CONST_PTR const
750 #endif
751
752 /*
753 * Allow things in gdb to be declared "volatile". If compiling ANSI, it
754 * just works. If compiling with gcc but non-ansi, redefine to __volatile__.
755 * If non-ansi, non-gcc, then eliminate "volatile" entirely, making those
756 * objects be read-write rather than read-only.
757 */
758
759 #ifndef volatile
760 #ifndef __STDC__
761 #ifdef __GNUC__
762 #define volatile __volatile__
763 #else
764 #define volatile /* nothing */
765 #endif /* GNUC */
766 #endif /* STDC */
767 #endif /* volatile */
768
769 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
770 FIXME: Assumes 2's complement arithmetic */
771
772 #if !defined (UINT_MAX)
773 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
774 #endif
775
776 #if !defined (INT_MAX)
777 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
778 #endif
779
780 #if !defined (INT_MIN)
781 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
782 #endif
783
784 #if !defined (ULONG_MAX)
785 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
786 #endif
787
788 #if !defined (LONG_MAX)
789 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
790 #endif
791
792 #if !defined (ULONGEST_MAX)
793 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 32-bits */
794 #endif
795
796 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 32-bits */
797 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
798 #endif
799
800 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
801 arguments to a function, number in a value history, register number, etc.)
802 where the value must not be larger than can fit in an int. */
803
804 extern int longest_to_int (LONGEST);
805
806 /* Assorted functions we can declare, now that const and volatile are
807 defined. */
808
809 extern char *savestring (const char *, int);
810
811 extern char *msavestring (void *, const char *, int);
812
813 extern char *strsave (const char *);
814
815 extern char *mstrsave (void *, const char *);
816
817 /* FIXME; was long, but this causes compile errors in msvc if already
818 defined */
819 #ifdef _MSC_VER
820 extern PTR xmmalloc (PTR, size_t);
821 extern PTR xmrealloc (PTR, PTR, size_t);
822 #else
823 extern PTR xmmalloc (PTR, long);
824 extern PTR xmrealloc (PTR, PTR, long);
825 #endif
826
827 extern int parse_escape (char **);
828
829 /* Message to be printed before the error message, when an error occurs. */
830
831 extern char *error_pre_print;
832
833 /* Message to be printed before the error message, when an error occurs. */
834
835 extern char *quit_pre_print;
836
837 /* Message to be printed before the warning message, when a warning occurs. */
838
839 extern char *warning_pre_print;
840
841 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
842
843 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN;
844
845 /* DEPRECATED: Use error(), verror() or error_stream(). */
846 extern NORETURN void error_begin (void);
847
848 extern NORETURN void error_stream (GDB_FILE *) ATTR_NORETURN;
849
850 /* Returns a freshly allocate buffer containing the last error
851 message. */
852 extern char *error_last_message (void);
853
854 extern NORETURN void internal_verror (const char *, va_list ap) ATTR_NORETURN;
855
856 extern NORETURN void internal_error (char *, ...) ATTR_NORETURN;
857
858 extern NORETURN void nomem (long) ATTR_NORETURN;
859
860 /* Reasons for calling return_to_top_level. */
861
862 enum return_reason
863 {
864 /* User interrupt. */
865 RETURN_QUIT,
866 /* Any other error. */
867 RETURN_ERROR
868 };
869
870 #define ALL_CLEANUPS ((struct cleanup *)0)
871
872 #define RETURN_MASK_QUIT (1 << (int)RETURN_QUIT)
873 #define RETURN_MASK_ERROR (1 << (int)RETURN_ERROR)
874 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
875 typedef int return_mask;
876
877 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
878
879 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
880 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
881 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
882 value. It's unfortunate that, catch_errors() does not return an
883 indication of the exact exception that it caught - quit_flag might
884 help. */
885
886 typedef int (catch_errors_ftype) (PTR);
887 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
888
889 /* Template to catch_errors() that wraps calls to command
890 functions. */
891
892 typedef void (catch_command_errors_ftype) (char *, int);
893 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
894
895 extern void warning_begin (void);
896
897 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
898
899 /* Global functions from other, non-gdb GNU thingies.
900 Libiberty thingies are no longer declared here. We include libiberty.h
901 above, instead. */
902
903 #ifndef GETENV_PROVIDED
904 extern char *getenv (const char *);
905 #endif
906
907 /* From other system libraries */
908
909 #ifdef HAVE_STDDEF_H
910 #include <stddef.h>
911 #endif
912
913 #ifdef HAVE_STDLIB_H
914 #if defined(_MSC_VER) && !defined(__cplusplus)
915 /* msvc defines these in stdlib.h for c code */
916 #undef min
917 #undef max
918 #endif
919 #include <stdlib.h>
920 #endif
921 #ifndef min
922 #define min(a, b) ((a) < (b) ? (a) : (b))
923 #endif
924 #ifndef max
925 #define max(a, b) ((a) > (b) ? (a) : (b))
926 #endif
927
928
929 /* We take the address of fclose later, but some stdio's forget
930 to declare this. We can't always declare it since there's
931 no way to declare the parameters without upsetting some compiler
932 somewhere. */
933
934 #ifndef FCLOSE_PROVIDED
935 extern int fclose (FILE *);
936 #endif
937
938 #ifndef atof
939 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
940 #endif
941
942 #ifndef MALLOC_INCOMPATIBLE
943
944 #ifdef NEED_DECLARATION_MALLOC
945 extern PTR malloc ();
946 #endif
947
948 #ifdef NEED_DECLARATION_REALLOC
949 extern PTR realloc ();
950 #endif
951
952 #ifdef NEED_DECLARATION_FREE
953 extern void free ();
954 #endif
955
956 #endif /* MALLOC_INCOMPATIBLE */
957
958 /* Various possibilities for alloca. */
959 #ifndef alloca
960 #ifdef __GNUC__
961 #define alloca __builtin_alloca
962 #else /* Not GNU C */
963 #ifdef HAVE_ALLOCA_H
964 #include <alloca.h>
965 #else
966 #ifdef _AIX
967 #pragma alloca
968 #else
969
970 /* We need to be careful not to declare this in a way which conflicts with
971 bison. Bison never declares it as char *, but under various circumstances
972 (like __hpux) we need to use void *. */
973 #if defined (__STDC__) || defined (__hpux)
974 extern void *alloca ();
975 #else /* Don't use void *. */
976 extern char *alloca ();
977 #endif /* Don't use void *. */
978 #endif /* Not _AIX */
979 #endif /* Not HAVE_ALLOCA_H */
980 #endif /* Not GNU C */
981 #endif /* alloca not defined */
982
983 /* HOST_BYTE_ORDER must be defined to one of these. */
984
985 #ifdef HAVE_ENDIAN_H
986 #include <endian.h>
987 #endif
988
989 #if !defined (BIG_ENDIAN)
990 #define BIG_ENDIAN 4321
991 #endif
992
993 #if !defined (LITTLE_ENDIAN)
994 #define LITTLE_ENDIAN 1234
995 #endif
996
997 /* Dynamic target-system-dependent parameters for GDB. */
998 #include "gdbarch.h"
999
1000 /* Static target-system-dependent parameters for GDB. */
1001
1002 /* Number of bits in a char or unsigned char for the target machine.
1003 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1004 #if !defined (TARGET_CHAR_BIT)
1005 #define TARGET_CHAR_BIT 8
1006 #endif
1007
1008 /* Number of bits in a short or unsigned short for the target machine. */
1009 #if !defined (TARGET_SHORT_BIT)
1010 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
1011 #endif
1012
1013 /* Number of bits in an int or unsigned int for the target machine. */
1014 #if !defined (TARGET_INT_BIT)
1015 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
1016 #endif
1017
1018 /* Number of bits in a long or unsigned long for the target machine. */
1019 #if !defined (TARGET_LONG_BIT)
1020 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
1021 #endif
1022
1023 /* Number of bits in a long long or unsigned long long for the target machine. */
1024 #if !defined (TARGET_LONG_LONG_BIT)
1025 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
1026 #endif
1027
1028 /* Number of bits in a float for the target machine. */
1029 #if !defined (TARGET_FLOAT_BIT)
1030 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
1031 #endif
1032
1033 /* Number of bits in a double for the target machine. */
1034 #if !defined (TARGET_DOUBLE_BIT)
1035 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
1036 #endif
1037
1038 /* Number of bits in a long double for the target machine. */
1039 #if !defined (TARGET_LONG_DOUBLE_BIT)
1040 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
1041 #endif
1042
1043 /* Number of bits in a pointer for the target machine */
1044 #if !defined (TARGET_PTR_BIT)
1045 #define TARGET_PTR_BIT TARGET_INT_BIT
1046 #endif
1047
1048 /* If we picked up a copy of CHAR_BIT from a configuration file
1049 (which may get it by including <limits.h>) then use it to set
1050 the number of bits in a host char. If not, use the same size
1051 as the target. */
1052
1053 #if defined (CHAR_BIT)
1054 #define HOST_CHAR_BIT CHAR_BIT
1055 #else
1056 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1057 #endif
1058
1059 /* The bit byte-order has to do just with numbering of bits in
1060 debugging symbols and such. Conceptually, it's quite separate
1061 from byte/word byte order. */
1062
1063 #if !defined (BITS_BIG_ENDIAN)
1064 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1065 #endif
1066
1067 /* In findvar.c. */
1068
1069 extern LONGEST extract_signed_integer (void *, int);
1070
1071 extern ULONGEST extract_unsigned_integer (void *, int);
1072
1073 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1074
1075 extern CORE_ADDR extract_address (void *, int);
1076
1077 extern void store_signed_integer (PTR, int, LONGEST);
1078
1079 extern void store_unsigned_integer (PTR, int, ULONGEST);
1080
1081 extern void store_address (PTR, int, LONGEST);
1082
1083 /* Setup definitions for host and target floating point formats. We need to
1084 consider the format for `float', `double', and `long double' for both target
1085 and host. We need to do this so that we know what kind of conversions need
1086 to be done when converting target numbers to and from the hosts DOUBLEST
1087 data type. */
1088
1089 /* This is used to indicate that we don't know the format of the floating point
1090 number. Typically, this is useful for native ports, where the actual format
1091 is irrelevant, since no conversions will be taking place. */
1092
1093 extern const struct floatformat floatformat_unknown;
1094
1095 #if HOST_BYTE_ORDER == BIG_ENDIAN
1096 #ifndef HOST_FLOAT_FORMAT
1097 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
1098 #endif
1099 #ifndef HOST_DOUBLE_FORMAT
1100 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
1101 #endif
1102 #else /* LITTLE_ENDIAN */
1103 #ifndef HOST_FLOAT_FORMAT
1104 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
1105 #endif
1106 #ifndef HOST_DOUBLE_FORMAT
1107 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
1108 #endif
1109 #endif
1110
1111 #ifndef HOST_LONG_DOUBLE_FORMAT
1112 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
1113 #endif
1114
1115 #ifndef TARGET_FLOAT_FORMAT
1116 #define TARGET_FLOAT_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
1117 ? &floatformat_ieee_single_big \
1118 : &floatformat_ieee_single_little)
1119 #endif
1120 #ifndef TARGET_DOUBLE_FORMAT
1121 #define TARGET_DOUBLE_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
1122 ? &floatformat_ieee_double_big \
1123 : &floatformat_ieee_double_little)
1124 #endif
1125
1126 #ifndef TARGET_LONG_DOUBLE_FORMAT
1127 #define TARGET_LONG_DOUBLE_FORMAT &floatformat_unknown
1128 #endif
1129
1130 /* Use `long double' if the host compiler supports it. (Note that this is not
1131 necessarily any longer than `double'. On SunOS/gcc, it's the same as
1132 double.) This is necessary because GDB internally converts all floating
1133 point values to the widest type supported by the host.
1134
1135 There are problems however, when the target `long double' is longer than the
1136 host's `long double'. In general, we'll probably reduce the precision of
1137 any such values and print a warning. */
1138
1139 #ifdef HAVE_LONG_DOUBLE
1140 typedef long double DOUBLEST;
1141 #else
1142 typedef double DOUBLEST;
1143 #endif
1144
1145 extern void floatformat_to_doublest (const struct floatformat *,
1146 char *, DOUBLEST *);
1147 extern void floatformat_from_doublest (const struct floatformat *,
1148 DOUBLEST *, char *);
1149 extern DOUBLEST extract_floating (void *, int);
1150
1151 extern void store_floating (void *, int, DOUBLEST);
1152 \f
1153 /* On some machines there are bits in addresses which are not really
1154 part of the address, but are used by the kernel, the hardware, etc.
1155 for special purposes. ADDR_BITS_REMOVE takes out any such bits
1156 so we get a "real" address such as one would find in a symbol
1157 table. This is used only for addresses of instructions, and even then
1158 I'm not sure it's used in all contexts. It exists to deal with there
1159 being a few stray bits in the PC which would mislead us, not as some sort
1160 of generic thing to handle alignment or segmentation (it's possible it
1161 should be in TARGET_READ_PC instead). */
1162 #if !defined (ADDR_BITS_REMOVE)
1163 #define ADDR_BITS_REMOVE(addr) (addr)
1164 #endif /* No ADDR_BITS_REMOVE. */
1165
1166 /* From valops.c */
1167
1168 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1169
1170 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1171
1172 extern int watchdog;
1173
1174 /* Hooks for alternate command interfaces. */
1175 struct target_waitstatus;
1176 struct cmd_list_element;
1177
1178 /* Should the asynchronous variant of the interpreter (using the
1179 event-loop) be enabled? */
1180 extern int event_loop_p;
1181
1182 extern void (*init_ui_hook) (char *argv0);
1183 extern void (*command_loop_hook) (void);
1184 /* NOTE: cagney/1999-10-14: fputs_unfiltered_hook is deprecated.
1185 Instead code wanting to control GDB's output should be overriding
1186 the gdb_std* files. */
1187 extern void (*fputs_unfiltered_hook) (const char *linebuffer,
1188 GDB_FILE * stream);
1189 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1190 int line, int stopline,
1191 int noerror);
1192 extern struct frame_info *parse_frame_specification (char *frame_exp);
1193 extern int (*query_hook) (const char *, va_list);
1194 extern void (*warning_hook) (const char *, va_list);
1195 extern void (*flush_hook) (GDB_FILE * stream);
1196 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1197 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1198 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1199 extern void (*interactive_hook) (void);
1200 extern void (*registers_changed_hook) (void);
1201 extern void (*readline_begin_hook) (char *,...);
1202 extern char *(*readline_hook) (char *);
1203 extern void (*readline_end_hook) (void);
1204 extern void (*register_changed_hook) (int regno);
1205 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1206 extern void (*context_hook) (int);
1207 extern int (*target_wait_hook) (int pid, struct target_waitstatus * status);
1208
1209 extern void (*attach_hook) (void);
1210 extern void (*detach_hook) (void);
1211 extern void (*call_command_hook) (struct cmd_list_element * c,
1212 char *cmd, int from_tty);
1213
1214 extern void (*set_hook) (struct cmd_list_element * c);
1215
1216 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1217
1218 extern void (*error_begin_hook) (void);
1219
1220 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1221
1222
1223 /* Inhibit window interface if non-zero. */
1224
1225 extern int use_windows;
1226
1227 /* Symbolic definitions of filename-related things. */
1228 /* FIXME, this doesn't work very well if host and executable
1229 filesystems conventions are different. */
1230
1231 #ifndef DIRNAME_SEPARATOR
1232 #define DIRNAME_SEPARATOR ':'
1233 #endif
1234
1235 #ifndef SLASH_P
1236 #if defined(__GO32__)||defined(_WIN32)
1237 #define SLASH_P(X) ((X)=='\\')
1238 #else
1239 #define SLASH_P(X) ((X)=='/')
1240 #endif
1241 #endif
1242
1243 #ifndef SLASH_CHAR
1244 #if defined(__GO32__)||defined(_WIN32)
1245 #define SLASH_CHAR '\\'
1246 #else
1247 #define SLASH_CHAR '/'
1248 #endif
1249 #endif
1250
1251 #ifndef SLASH_STRING
1252 #if defined(__GO32__)||defined(_WIN32)
1253 #define SLASH_STRING "\\"
1254 #else
1255 #define SLASH_STRING "/"
1256 #endif
1257 #endif
1258
1259 #ifndef ROOTED_P
1260 #define ROOTED_P(X) (SLASH_P((X)[0]))
1261 #endif
1262
1263 /* On some systems, PIDGET is defined to extract the inferior pid from
1264 an internal pid that has the thread id and pid in seperate bit
1265 fields. If not defined, then just use the entire internal pid as
1266 the actual pid. */
1267
1268 #ifndef PIDGET
1269 #define PIDGET(pid) (pid)
1270 #endif
1271
1272 /* If under Cygwin, provide backwards compatibility with older
1273 Cygwin compilers that don't define the current cpp define. */
1274 #ifdef __CYGWIN32__
1275 #ifndef __CYGWIN__
1276 #define __CYGWIN__
1277 #endif
1278 #endif
1279
1280 /* Define well known filenos if the system does not define them. */
1281 #ifndef STDIN_FILENO
1282 #define STDIN_FILENO 0
1283 #endif
1284 #ifndef STDOUT_FILENO
1285 #define STDOUT_FILENO 1
1286 #endif
1287 #ifndef STDERR_FILENO
1288 #define STDERR_FILENO 2
1289 #endif
1290
1291 /* If this definition isn't overridden by the header files, assume
1292 that isatty and fileno exist on this system. */
1293 #ifndef ISATTY
1294 #define ISATTY(FP) (isatty (fileno (FP)))
1295 #endif
1296
1297 #endif /* #ifndef DEFS_H */