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_ftype) (struct gdb_file * stream, struct gdb_file * dest);
 413 extern void set_gdb_file_put (struct gdb_file *stream, gdb_file_put_ftype * put);
 414
 415 typedef void (gdb_file_delete_ftype) (struct gdb_file * stream);
 416 extern void set_gdb_file_data (struct gdb_file *stream, void *data, gdb_file_delete_ftype * delete);
 417
 418 extern void *gdb_file_data (struct gdb_file *file);
 419
 420
 421 /* Open the specified FILE as a gdb_file. */
 422 extern struct gdb_file *stdio_fileopen (FILE *file);
 423
 424 /* Open NAME returning a GDB_FILE. */
 425 extern GDB_FILE *gdb_fopen (char *name, char *mode);
 426
 427 /* Create/open a memory based file. Can be used as a scratch
 428    buffer for collecting output. */
 429 extern struct gdb_file *mem_fileopen (void);
 430
 431 extern void gdb_flush (GDB_FILE *);
 432
 433 extern void gdb_file_delete (struct gdb_file *stream);
 434
 435 extern void gdb_file_rewind (struct gdb_file *stream);
 436
 437 extern int gdb_file_isatty (GDB_FILE *);
 438
 439 extern void gdb_file_write (struct gdb_file *file, const char *buf, long length_buf);
 440
 441 /* NOTE: copies left to right */
 442 extern void gdb_file_put (struct gdb_file *src, struct gdb_file *dest);
 443
 444 /* More generic printf like operations */
 445
 446 extern void fputs_filtered (const char *, GDB_FILE *);
 447
 448 extern void fputs_unfiltered (const char *, GDB_FILE *);
 449
 450 extern int fputc_filtered (int c, GDB_FILE *);
 451
 452 extern int fputc_unfiltered (int c, GDB_FILE *);
 453
 454 extern int putchar_unfiltered (int c);
 455
 456 extern void puts_filtered (const char *);
 457
 458 extern void puts_unfiltered (const char *);
 459
 460 extern void puts_debug (char *prefix, char *string, char *suffix);
 461
 462 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 463
 464 extern void vfprintf_filtered (GDB_FILE *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 465
 466 extern void fprintf_filtered (GDB_FILE *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 467
 468 extern void fprintfi_filtered (int, GDB_FILE *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 469
 470 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 471
 472 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 473
 474 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 475
 476 extern void vfprintf_unfiltered (GDB_FILE *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 477
 478 extern void fprintf_unfiltered (GDB_FILE *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 479
 480 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 481
 482 /* #if defined (TUI) */
 483 /* DEPRECATED: Only the TUI should use these methods. */
 484 extern struct gdb_file *tui_fileopen (FILE *);
 485 extern struct gdb_file *tui_sfileopen (int);
 486 extern char *tui_file_get_strbuf (struct gdb_file *);
 487 extern void tui_file_adjust_strbuf (int, struct gdb_file *);
 488 /* #endif */
 489
 490 extern void print_spaces (int, GDB_FILE *);
 491
 492 extern void print_spaces_filtered (int, GDB_FILE *);
 493
 494 extern char *n_spaces (int);
 495
 496 extern void fputstr_filtered (const char *str, int quotr, GDB_FILE * stream);
 497
 498 extern void fputstr_unfiltered (const char *str, int quotr, GDB_FILE * stream);
 499
 500 extern void fputstrn_unfiltered (const char *str, int n, int quotr, GDB_FILE * stream);
 501
 502 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 503 extern void gdb_print_host_address (void *addr, struct gdb_file *stream);
 504
 505 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 506    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
 507    for ``%*''. */
 508 extern int strlen_paddr (void);
 509 extern char *paddr (CORE_ADDR addr);
 510 extern char *paddr_nz (CORE_ADDR addr);
 511 extern char *paddr_u (CORE_ADDR addr);
 512 extern char *paddr_d (LONGEST addr);
 513
 514 typedef bfd_vma t_reg;
 515 extern char *preg (t_reg reg);
 516 extern char *preg_nz (t_reg reg);
 517
 518 extern void fprintf_symbol_filtered (GDB_FILE *, char *,
 519                                      enum language, int);
 520
 521 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
 522
 523 extern void print_sys_errmsg (char *, int);
 524
 525 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 526    "const char *" in unistd.h, so we can't declare the argument
 527    as "char *".  */
 528
 529 extern char *re_comp (const char *);
 530
 531 /* From symfile.c */
 532
 533 extern void symbol_file_command (char *, int);
 534
 535 /* Remote targets may wish to use this as their load function.  */
 536 extern void generic_load (char *name, int from_tty);
 537
 538 /* Summarise a download */
 539 extern void print_transfer_performance (struct gdb_file *stream,
 540                                         unsigned long data_count,
 541                                         unsigned long write_count,
 542                                         unsigned long time_count);
 543
 544 /* From top.c */
 545
 546 typedef void initialize_file_ftype (void);
 547
 548 extern char *skip_quoted (char *);
 549
 550 extern char *gdb_readline (char *);
 551
 552 extern char *command_line_input (char *, int, char *);
 553
 554 extern void print_prompt (void);
 555
 556 extern int input_from_terminal_p (void);
 557
 558 extern int info_verbose;
 559
 560 /* From printcmd.c */
 561
 562 extern void set_next_address (CORE_ADDR);
 563
 564 extern void print_address_symbolic (CORE_ADDR, GDB_FILE *, int,
 565                                     char *);
 566
 567 extern void print_address_numeric (CORE_ADDR, int, GDB_FILE *);
 568
 569 extern void print_address (CORE_ADDR, GDB_FILE *);
 570
 571 /* From source.c */
 572
 573 extern int openp (char *, int, char *, int, int, char **);
 574
 575 extern int source_full_path_of (char *, char **);
 576
 577 extern void mod_path (char *, char **);
 578
 579 extern void directory_command (char *, int);
 580
 581 extern void init_source_path (void);
 582
 583 extern char *symtab_to_filename (struct symtab *);
 584
 585 /* From exec.c */
 586
 587 extern void exec_set_section_offsets (bfd_signed_vma text_off,
 588                                       bfd_signed_vma data_off,
 589                                       bfd_signed_vma bss_off);
 590
 591 /* From findvar.c */
 592
 593 extern int read_relative_register_raw_bytes (int, char *);
 594
 595 /* Possible lvalue types.  Like enum language, this should be in
 596    value.h, but needs to be here for the same reason. */
 597
 598 enum lval_type
 599   {
 600     /* Not an lval. */
 601     not_lval,
 602     /* In memory.  Could be a saved register.  */
 603     lval_memory,
 604     /* In a register.  */
 605     lval_register,
 606     /* In a gdb internal variable.  */
 607     lval_internalvar,
 608     /* Part of a gdb internal variable (structure field).  */
 609     lval_internalvar_component,
 610     /* In a register series in a frame not the current one, which may have been
 611        partially saved or saved in different places (otherwise would be
 612        lval_register or lval_memory).  */
 613     lval_reg_frame_relative
 614   };
 615
 616 struct frame_info;
 617
 618 void default_get_saved_register (char *raw_buffer, int *optimized,
 619                                  CORE_ADDR * addrp,
 620                                  struct frame_info *frame, int regnum,
 621                                  enum lval_type *lval);
 622
 623 /* From readline (but not in any readline .h files).  */
 624
 625 extern char *tilde_expand (char *);
 626
 627 /* Control types for commands */
 628
 629 enum misc_command_type
 630   {
 631     ok_command,
 632     end_command,
 633     else_command,
 634     nop_command
 635   };
 636
 637 enum command_control_type
 638   {
 639     simple_control,
 640     break_control,
 641     continue_control,
 642     while_control,
 643     if_control,
 644     invalid_control
 645   };
 646
 647 /* Structure for saved commands lines
 648    (for breakpoints, defined commands, etc).  */
 649
 650 struct command_line
 651   {
 652     struct command_line *next;
 653     char *line;
 654     enum command_control_type control_type;
 655     int body_count;
 656     struct command_line **body_list;
 657   };
 658
 659 extern struct command_line *read_command_lines (char *, int);
 660
 661 extern void free_command_lines (struct command_line **);
 662
 663 /* To continue the execution commands when running gdb asynchronously.
 664    A continuation structure contains a pointer to a function to be called
 665    to finish the command, once the target has stopped. Such mechanism is
 666    used bt the finish and until commands, and in the remote protocol
 667    when opening an extended-remote connection. */
 668
 669 struct continuation_arg
 670   {
 671     struct continuation_arg *next;
 672     PTR data;
 673   };
 674
 675 struct continuation
 676   {
 677     void (*continuation_hook) (struct continuation_arg *);
 678     struct continuation_arg *arg_list;
 679     struct continuation *next;
 680   };
 681 struct continuation continuation;
 682
 683 /* In infrun.c. */
 684 extern struct continuation *cmd_continuation;
 685
 686 /* From utils.c */
 687 extern void add_continuation (void (*)(struct continuation_arg *),
 688                               struct continuation_arg *);
 689 extern void do_all_continuations (void);
 690 extern void discard_all_continuations (void);
 691
 692 /* String containing the current directory (what getwd would return).  */
 693
 694 extern char *current_directory;
 695
 696 /* Default radixes for input and output.  Only some values supported.  */
 697 extern unsigned input_radix;
 698 extern unsigned output_radix;
 699
 700 /* Possibilities for prettyprint parameters to routines which print
 701    things.  Like enum language, this should be in value.h, but needs
 702    to be here for the same reason.  FIXME:  If we can eliminate this
 703    as an arg to LA_VAL_PRINT, then we can probably move it back to
 704    value.h. */
 705
 706 enum val_prettyprint
 707   {
 708     Val_no_prettyprint = 0,
 709     Val_prettyprint,
 710     /* Use the default setting which the user has specified.  */
 711     Val_pretty_default
 712   };
 713 \f
 714
 715 /* Host machine definition.  This will be a symlink to one of the
 716    xm-*.h files, built by the `configure' script.  */
 717
 718 #include "xm.h"
 719
 720 /* Native machine support.  This will be a symlink to one of the
 721    nm-*.h files, built by the `configure' script.  */
 722
 723 #include "nm.h"
 724
 725 /* Target machine definition.  This will be a symlink to one of the
 726    tm-*.h files, built by the `configure' script.  */
 727
 728 #include "tm.h"
 729
 730 /* If the xm.h file did not define the mode string used to open the
 731    files, assume that binary files are opened the same way as text
 732    files */
 733 #ifndef FOPEN_RB
 734 #include "fopen-same.h"
 735 #endif
 736
 737 /* Microsoft C can't deal with const pointers */
 738
 739 #ifdef _MSC_VER
 740 #define CONST_PTR
 741 #else
 742 #define CONST_PTR const
 743 #endif
 744
 745 /*
 746  * Allow things in gdb to be declared "volatile".  If compiling ANSI, it
 747  * just works.  If compiling with gcc but non-ansi, redefine to __volatile__.
 748  * If non-ansi, non-gcc, then eliminate "volatile" entirely, making those
 749  * objects be read-write rather than read-only.
 750  */
 751
 752 #ifndef volatile
 753 #ifndef __STDC__
 754 #ifdef __GNUC__
 755 #define volatile __volatile__
 756 #else
 757 #define volatile                /* nothing */
 758 #endif /* GNUC */
 759 #endif /* STDC */
 760 #endif /* volatile */
 761
 762 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 763    FIXME: Assumes 2's complement arithmetic */
 764
 765 #if !defined (UINT_MAX)
 766 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 767 #endif
 768
 769 #if !defined (INT_MAX)
 770 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 771 #endif
 772
 773 #if !defined (INT_MIN)
 774 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 775 #endif
 776
 777 #if !defined (ULONG_MAX)
 778 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 779 #endif
 780
 781 #if !defined (LONG_MAX)
 782 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 783 #endif
 784
 785 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 786    arguments to a function, number in a value history, register number, etc.)
 787    where the value must not be larger than can fit in an int.  */
 788
 789 extern int longest_to_int (LONGEST);
 790
 791 /* Assorted functions we can declare, now that const and volatile are
 792    defined.  */
 793
 794 extern char *savestring (const char *, int);
 795
 796 extern char *msavestring (void *, const char *, int);
 797
 798 extern char *strsave (const char *);
 799
 800 extern char *mstrsave (void *, const char *);
 801
 802 /* FIXME; was long, but this causes compile errors in msvc if already
 803    defined */
 804 #ifdef _MSC_VER
 805 extern PTR xmmalloc (PTR, size_t);
 806 extern PTR xmrealloc (PTR, PTR, size_t);
 807 #else
 808 extern PTR xmmalloc (PTR, long);
 809 extern PTR xmrealloc (PTR, PTR, long);
 810 #endif
 811
 812 extern int parse_escape (char **);
 813
 814 /* Message to be printed before the error message, when an error occurs.  */
 815
 816 extern char *error_pre_print;
 817
 818 /* Message to be printed before the error message, when an error occurs.  */
 819
 820 extern char *quit_pre_print;
 821
 822 /* Message to be printed before the warning message, when a warning occurs.  */
 823
 824 extern char *warning_pre_print;
 825
 826 extern NORETURN void error (const char *, ...) ATTR_NORETURN;
 827
 828 extern void error_begin (void);
 829
 830 extern NORETURN void internal_error (char *, ...) ATTR_NORETURN;
 831
 832 extern NORETURN void error_stream (GDB_FILE *) ATTR_NORETURN;
 833
 834 extern char *error_last_message (void);
 835
 836 extern NORETURN void nomem (long) ATTR_NORETURN;
 837
 838 /* Reasons for calling return_to_top_level.  */
 839
 840 enum return_reason
 841   {
 842     /* User interrupt.  */
 843     RETURN_QUIT,
 844     /* Any other error.  */
 845     RETURN_ERROR
 846   };
 847
 848 #define ALL_CLEANUPS    ((struct cleanup *)0)
 849
 850 #define RETURN_MASK_QUIT (1 << (int)RETURN_QUIT)
 851 #define RETURN_MASK_ERROR (1 << (int)RETURN_ERROR)
 852 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
 853 typedef int return_mask;
 854
 855 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
 856
 857 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
 858    otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
 859    probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
 860    value. It's unfortunate that, catch_errors() does not return an
 861    indication of the exact exception that it caught - quit_flag might
 862    help. */
 863
 864 typedef int (catch_errors_ftype) (PTR);
 865 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
 866
 867 /* Template to catch_errors() that wraps calls to command
 868    functions. */
 869
 870 typedef void (catch_command_errors_ftype) (char *, int);
 871 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
 872
 873 extern void warning_begin (void);
 874
 875 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 876
 877 /* Global functions from other, non-gdb GNU thingies.
 878    Libiberty thingies are no longer declared here.  We include libiberty.h
 879    above, instead.  */
 880
 881 #ifndef GETENV_PROVIDED
 882 extern char *getenv (const char *);
 883 #endif
 884
 885 /* From other system libraries */
 886
 887 #ifdef HAVE_STDDEF_H
 888 #include <stddef.h>
 889 #endif
 890
 891 #ifdef HAVE_STDLIB_H
 892 #if defined(_MSC_VER) && !defined(__cplusplus)
 893 /* msvc defines these in stdlib.h for c code */
 894 #undef min
 895 #undef max
 896 #endif
 897 #include <stdlib.h>
 898 #endif
 899 #ifndef min
 900 #define min(a, b) ((a) < (b) ? (a) : (b))
 901 #endif
 902 #ifndef max
 903 #define max(a, b) ((a) > (b) ? (a) : (b))
 904 #endif
 905
 906
 907 /* We take the address of fclose later, but some stdio's forget
 908    to declare this.  We can't always declare it since there's
 909    no way to declare the parameters without upsetting some compiler
 910    somewhere. */
 911
 912 #ifndef FCLOSE_PROVIDED
 913 extern int fclose (FILE *);
 914 #endif
 915
 916 #ifndef atof
 917 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
 918 #endif
 919
 920 #ifndef MALLOC_INCOMPATIBLE
 921
 922 #ifdef NEED_DECLARATION_MALLOC
 923 extern PTR malloc ();
 924 #endif
 925
 926 #ifdef NEED_DECLARATION_REALLOC
 927 extern PTR realloc ();
 928 #endif
 929
 930 #ifdef NEED_DECLARATION_FREE
 931 extern void free ();
 932 #endif
 933
 934 #endif /* MALLOC_INCOMPATIBLE */
 935
 936 /* Various possibilities for alloca.  */
 937 #ifndef alloca
 938 #ifdef __GNUC__
 939 #define alloca __builtin_alloca
 940 #else /* Not GNU C */
 941 #ifdef HAVE_ALLOCA_H
 942 #include <alloca.h>
 943 #else
 944 #ifdef _AIX
 945 #pragma alloca
 946 #else
 947
 948 /* We need to be careful not to declare this in a way which conflicts with
 949    bison.  Bison never declares it as char *, but under various circumstances
 950    (like __hpux) we need to use void *.  */
 951 #if defined (__STDC__) || defined (__hpux)
 952 extern void *alloca ();
 953 #else /* Don't use void *.  */
 954 extern char *alloca ();
 955 #endif /* Don't use void *.  */
 956 #endif /* Not _AIX */
 957 #endif /* Not HAVE_ALLOCA_H */
 958 #endif /* Not GNU C */
 959 #endif /* alloca not defined */
 960
 961 /* HOST_BYTE_ORDER must be defined to one of these.  */
 962
 963 #ifdef HAVE_ENDIAN_H
 964 #include <endian.h>
 965 #endif
 966
 967 #if !defined (BIG_ENDIAN)
 968 #define BIG_ENDIAN 4321
 969 #endif
 970
 971 #if !defined (LITTLE_ENDIAN)
 972 #define LITTLE_ENDIAN 1234
 973 #endif
 974
 975 /* Dynamic target-system-dependent parameters for GDB. */
 976 #include "gdbarch.h"
 977
 978 /* Static target-system-dependent parameters for GDB. */
 979
 980 /* Number of bits in a char or unsigned char for the target machine.
 981    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
 982 #if !defined (TARGET_CHAR_BIT)
 983 #define TARGET_CHAR_BIT 8
 984 #endif
 985
 986 /* Number of bits in a short or unsigned short for the target machine. */
 987 #if !defined (TARGET_SHORT_BIT)
 988 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
 989 #endif
 990
 991 /* Number of bits in an int or unsigned int for the target machine. */
 992 #if !defined (TARGET_INT_BIT)
 993 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
 994 #endif
 995
 996 /* Number of bits in a long or unsigned long for the target machine. */
 997 #if !defined (TARGET_LONG_BIT)
 998 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
 999 #endif
1000
1001 /* Number of bits in a long long or unsigned long long for the target machine. */
1002 #if !defined (TARGET_LONG_LONG_BIT)
1003 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
1004 #endif
1005
1006 /* Number of bits in a float for the target machine. */
1007 #if !defined (TARGET_FLOAT_BIT)
1008 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
1009 #endif
1010
1011 /* Number of bits in a double for the target machine. */
1012 #if !defined (TARGET_DOUBLE_BIT)
1013 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
1014 #endif
1015
1016 /* Number of bits in a long double for the target machine.  */
1017 #if !defined (TARGET_LONG_DOUBLE_BIT)
1018 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
1019 #endif
1020
1021 /* Number of bits in a pointer for the target machine */
1022 #if !defined (TARGET_PTR_BIT)
1023 #define TARGET_PTR_BIT TARGET_INT_BIT
1024 #endif
1025
1026 /* If we picked up a copy of CHAR_BIT from a configuration file
1027    (which may get it by including <limits.h>) then use it to set
1028    the number of bits in a host char.  If not, use the same size
1029    as the target. */
1030
1031 #if defined (CHAR_BIT)
1032 #define HOST_CHAR_BIT CHAR_BIT
1033 #else
1034 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1035 #endif
1036
1037 /* The bit byte-order has to do just with numbering of bits in
1038    debugging symbols and such.  Conceptually, it's quite separate
1039    from byte/word byte order.  */
1040
1041 #if !defined (BITS_BIG_ENDIAN)
1042 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1043 #endif
1044
1045 /* In findvar.c.  */
1046
1047 extern LONGEST extract_signed_integer (void *, int);
1048
1049 extern ULONGEST extract_unsigned_integer (void *, int);
1050
1051 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1052
1053 extern CORE_ADDR extract_address (void *, int);
1054
1055 extern void store_signed_integer (PTR, int, LONGEST);
1056
1057 extern void store_unsigned_integer (PTR, int, ULONGEST);
1058
1059 extern void store_address (PTR, int, LONGEST);
1060
1061 /* Setup definitions for host and target floating point formats.  We need to
1062    consider the format for `float', `double', and `long double' for both target
1063    and host.  We need to do this so that we know what kind of conversions need
1064    to be done when converting target numbers to and from the hosts DOUBLEST
1065    data type.  */
1066
1067 /* This is used to indicate that we don't know the format of the floating point
1068    number.  Typically, this is useful for native ports, where the actual format
1069    is irrelevant, since no conversions will be taking place.  */
1070
1071 extern const struct floatformat floatformat_unknown;
1072
1073 #if HOST_BYTE_ORDER == BIG_ENDIAN
1074 #ifndef HOST_FLOAT_FORMAT
1075 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
1076 #endif
1077 #ifndef HOST_DOUBLE_FORMAT
1078 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
1079 #endif
1080 #else /* LITTLE_ENDIAN */
1081 #ifndef HOST_FLOAT_FORMAT
1082 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
1083 #endif
1084 #ifndef HOST_DOUBLE_FORMAT
1085 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
1086 #endif
1087 #endif
1088
1089 #ifndef HOST_LONG_DOUBLE_FORMAT
1090 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
1091 #endif
1092
1093 #ifndef TARGET_FLOAT_FORMAT
1094 #define TARGET_FLOAT_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
1095                              ? &floatformat_ieee_single_big \
1096                              : &floatformat_ieee_single_little)
1097 #endif
1098 #ifndef TARGET_DOUBLE_FORMAT
1099 #define TARGET_DOUBLE_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
1100                               ? &floatformat_ieee_double_big \
1101                               : &floatformat_ieee_double_little)
1102 #endif
1103
1104 #ifndef TARGET_LONG_DOUBLE_FORMAT
1105 #define TARGET_LONG_DOUBLE_FORMAT &floatformat_unknown
1106 #endif
1107
1108 /* Use `long double' if the host compiler supports it.  (Note that this is not
1109    necessarily any longer than `double'.  On SunOS/gcc, it's the same as
1110    double.)  This is necessary because GDB internally converts all floating
1111    point values to the widest type supported by the host.
1112
1113    There are problems however, when the target `long double' is longer than the
1114    host's `long double'.  In general, we'll probably reduce the precision of
1115    any such values and print a warning.  */
1116
1117 #ifdef HAVE_LONG_DOUBLE
1118 typedef long double DOUBLEST;
1119 #else
1120 typedef double DOUBLEST;
1121 #endif
1122
1123 extern void floatformat_to_doublest (const struct floatformat *,
1124                                      char *, DOUBLEST *);
1125 extern void floatformat_from_doublest (const struct floatformat *,
1126                                        DOUBLEST *, char *);
1127 extern DOUBLEST extract_floating (void *, int);
1128
1129 extern void store_floating (void *, int, DOUBLEST);
1130 \f
1131 /* On some machines there are bits in addresses which are not really
1132    part of the address, but are used by the kernel, the hardware, etc.
1133    for special purposes.  ADDR_BITS_REMOVE takes out any such bits
1134    so we get a "real" address such as one would find in a symbol
1135    table.  This is used only for addresses of instructions, and even then
1136    I'm not sure it's used in all contexts.  It exists to deal with there
1137    being a few stray bits in the PC which would mislead us, not as some sort
1138    of generic thing to handle alignment or segmentation (it's possible it
1139    should be in TARGET_READ_PC instead). */
1140 #if !defined (ADDR_BITS_REMOVE)
1141 #define ADDR_BITS_REMOVE(addr) (addr)
1142 #endif /* No ADDR_BITS_REMOVE.  */
1143
1144 /* From valops.c */
1145
1146 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1147
1148 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1149
1150 extern int watchdog;
1151
1152 /* Hooks for alternate command interfaces.  */
1153 struct target_waitstatus;
1154 struct cmd_list_element;
1155
1156 /* Should the asynchronous variant of the interpreter (using the
1157    event-loop) be enabled? */
1158 extern int event_loop_p;
1159
1160 extern void (*init_ui_hook) (char *argv0);
1161 extern void (*command_loop_hook) (void);
1162 /* NOTE: cagney/1999-10-14: fputs_unfiltered_hook is deprecated.
1163    Instead code wanting to control GDB's output should be overriding
1164    the gdb_std* files. */
1165 extern void (*fputs_unfiltered_hook) (const char *linebuffer,
1166                                       GDB_FILE * stream);
1167 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1168                                               int line, int stopline,
1169                                               int noerror);
1170 extern struct frame_info *parse_frame_specification (char *frame_exp);
1171 extern int (*query_hook) (const char *, va_list);
1172 extern void (*warning_hook) (const char *, va_list);
1173 extern void (*flush_hook) (GDB_FILE * stream);
1174 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1175 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1176 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1177 extern void (*interactive_hook) (void);
1178 extern void (*registers_changed_hook) (void);
1179 extern void (*readline_begin_hook) (char *,...);
1180 extern char *(*readline_hook) (char *);
1181 extern void (*readline_end_hook) (void);
1182 extern void (*register_changed_hook) (int regno);
1183 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1184 extern void (*context_hook) (int);
1185 extern int (*target_wait_hook) (int pid, struct target_waitstatus * status);
1186
1187 extern void (*attach_hook) (void);
1188 extern void (*detach_hook) (void);
1189 extern void (*call_command_hook) (struct cmd_list_element * c,
1190                                   char *cmd, int from_tty);
1191
1192 extern void (*set_hook) (struct cmd_list_element * c);
1193
1194 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1195
1196 extern void (*error_begin_hook) (void);
1197
1198 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1199
1200
1201 /* Inhibit window interface if non-zero. */
1202
1203 extern int use_windows;
1204
1205 /* Symbolic definitions of filename-related things.  */
1206 /* FIXME, this doesn't work very well if host and executable
1207    filesystems conventions are different.  */
1208
1209 #ifndef DIRNAME_SEPARATOR
1210 #define DIRNAME_SEPARATOR ':'
1211 #endif
1212
1213 #ifndef SLASH_P
1214 #if defined(__GO32__)||defined(_WIN32)
1215 #define SLASH_P(X) ((X)=='\\')
1216 #else
1217 #define SLASH_P(X) ((X)=='/')
1218 #endif
1219 #endif
1220
1221 #ifndef SLASH_CHAR
1222 #if defined(__GO32__)||defined(_WIN32)
1223 #define SLASH_CHAR '\\'
1224 #else
1225 #define SLASH_CHAR '/'
1226 #endif
1227 #endif
1228
1229 #ifndef SLASH_STRING
1230 #if defined(__GO32__)||defined(_WIN32)
1231 #define SLASH_STRING "\\"
1232 #else
1233 #define SLASH_STRING "/"
1234 #endif
1235 #endif
1236
1237 #ifndef ROOTED_P
1238 #define ROOTED_P(X) (SLASH_P((X)[0]))
1239 #endif
1240
1241 /* On some systems, PIDGET is defined to extract the inferior pid from
1242    an internal pid that has the thread id and pid in seperate bit
1243    fields.  If not defined, then just use the entire internal pid as
1244    the actual pid. */
1245
1246 #ifndef PIDGET
1247 #define PIDGET(pid) (pid)
1248 #endif
1249
1250 /* If under Cygwin, provide backwards compatibility with older
1251    Cygwin compilers that don't define the current cpp define. */
1252 #ifdef __CYGWIN32__
1253 #ifndef __CYGWIN__
1254 #define __CYGWIN__
1255 #endif
1256 #endif
1257
1258 /* Define well known filenos if the system does not define them.  */
1259 #ifndef STDIN_FILENO
1260 #define STDIN_FILENO   0
1261 #endif
1262 #ifndef STDOUT_FILENO
1263 #define STDOUT_FILENO  1
1264 #endif
1265 #ifndef STDERR_FILENO
1266 #define STDERR_FILENO  2
1267 #endif
1268
1269 /* If this definition isn't overridden by the header files, assume
1270    that isatty and fileno exist on this system.  */
1271 #ifndef ISATTY
1272 #define ISATTY(FP)      (isatty (fileno (FP)))
1273 #endif
1274
1275 #endif /* #ifndef DEFS_H */