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 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
   4    1997, 1998, 1999, 2000, 2001, 2002
   5    Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   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.
  13
  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.
  18
  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.  */
  23
  24 #ifndef DEFS_H
  25 #define DEFS_H
  26
  27 #include "config.h"             /* Generated by configure */
  28 #include <stdio.h>
  29 #include <errno.h>              /* System call error return status */
  30 #include <limits.h>
  31
  32 #ifdef HAVE_STDDEF_H
  33 #include <stddef.h>
  34 #else
  35 #include <sys/types.h>          /* for size_t */
  36 #endif
  37
  38 #ifdef HAVE_UNISTD_H
  39 #include <unistd.h>
  40 #endif
  41
  42 /* For ``enum target_signal''.  */
  43 #include "gdb/signals.h"
  44
  45 /* Just in case they're not defined in stdio.h. */
  46
  47 #ifndef SEEK_SET
  48 #define SEEK_SET 0
  49 #endif
  50 #ifndef SEEK_CUR
  51 #define SEEK_CUR 1
  52 #endif
  53
  54 /* First include ansidecl.h so we can use the various macro definitions
  55    here and in all subsequent file inclusions.  */
  56
  57 #include "ansidecl.h"
  58
  59 #include <stdarg.h>             /* for va_list */
  60
  61 #include "libiberty.h"
  62
  63 #include "progress.h"
  64
  65 /* For BFD64 and bfd_vma.  */
  66 #include "bfd.h"
  67
  68
  69 /* The target is partially multi-arched.  Both "tm.h" and the
  70    multi-arch vector provide definitions.  "tm.h" normally overrides
  71    the multi-arch vector (but there are a few exceptions).  */
  72
  73 #define GDB_MULTI_ARCH_PARTIAL 1
  74
  75 /* The target is partially multi-arched. Both the multi-arch vector
  76    and "tm.h" provide definitions. "tm.h" cannot override a definition
  77    provided by the multi-arch vector.  It is detected as a compilation
  78    error.
  79
  80    This setting is only useful during a multi-arch conversion. */
  81
  82 #define GDB_MULTI_ARCH_TM 2
  83
  84 /* The target is pure multi-arch.  The MULTI-ARCH vector provides all
  85    definitions.  "tm.h" is linked to an empty file. */
  86
  87 #define GDB_MULTI_ARCH_PURE 3
  88
  89
  90
  91 /* An address in the program being debugged.  Host byte order.  Rather
  92    than duplicate all the logic in BFD which figures out what type
  93    this is (long, long long, etc.) and whether it needs to be 64
  94    bits (the host/target interactions are subtle), we just use
  95    bfd_vma.  */
  96
  97 typedef bfd_vma CORE_ADDR;
  98
  99 /* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */
 100
 101 #ifndef LONGEST
 102
 103 #ifdef BFD64
 104
 105 #define LONGEST BFD_HOST_64_BIT
 106 #define ULONGEST BFD_HOST_U_64_BIT
 107
 108 #else /* No BFD64 */
 109
 110 #ifdef CC_HAS_LONG_LONG
 111 #define LONGEST long long
 112 #define ULONGEST unsigned long long
 113 #else
 114 #ifdef BFD_HOST_64_BIT
 115 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
 116    (e.g. i386-windows) so try it.  */
 117 #define LONGEST BFD_HOST_64_BIT
 118 #define ULONGEST BFD_HOST_U_64_BIT
 119 #else
 120 #define LONGEST long
 121 #define ULONGEST unsigned long
 122 #endif
 123 #endif
 124
 125 #endif /* No BFD64 */
 126
 127 #endif /* ! LONGEST */
 128
 129 #ifndef min
 130 #define min(a, b) ((a) < (b) ? (a) : (b))
 131 #endif
 132 #ifndef max
 133 #define max(a, b) ((a) > (b) ? (a) : (b))
 134 #endif
 135
 136 /* Macros to do string compares.
 137
 138    NOTE: cagney/2000-03-14:
 139
 140    While old code can continue to refer to these macros, new code is
 141    probably better off using strcmp() directly vis: ``strcmp() == 0''
 142    and ``strcmp() != 0''.
 143
 144    This is because modern compilers can directly inline strcmp()
 145    making the original justification for these macros - avoid function
 146    call overhead by pre-testing the first characters
 147    (``*X==*Y?...:0'') - redundant.
 148
 149    ``Even if [...] testing the first character does have a modest
 150    performance improvement, I'd rather that whenever a performance
 151    issue is found that we spend the effort on algorithmic
 152    optimizations than micro-optimizing.'' J.T. */
 153
 154 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
 155 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
 156
 157 /* The character GNU C++ uses to build identifiers that must be unique from
 158    the program's identifiers (such as $this and $$vptr).  */
 159 #define CPLUS_MARKER '$'        /* May be overridden to '.' for SysV */
 160
 161 /* Check if a character is one of the commonly used C++ marker characters.  */
 162 extern int is_cplus_marker (int);
 163
 164 /* use tui interface if non-zero */
 165 extern int tui_version;
 166
 167 /* enable xdb commands if set */
 168 extern int xdb_commands;
 169
 170 /* enable dbx commands if set */
 171 extern int dbx_commands;
 172
 173 extern int quit_flag;
 174 extern int immediate_quit;
 175 extern int sevenbit_strings;
 176
 177 extern void quit (void);
 178
 179 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
 180    benefits of having a ``QUIT'' macro rather than a function are
 181    marginal.  If the overhead of a QUIT function call is proving
 182    significant then its calling frequency should probably be reduced
 183    [kingdon].  A profile analyzing the current situtation is
 184    needed. */
 185
 186 #ifdef QUIT
 187 /* do twice to force compiler warning */
 188 #define QUIT_FIXME "FIXME"
 189 #define QUIT_FIXME "ignoring redefinition of QUIT"
 190 #else
 191 #define QUIT { \
 192   if (quit_flag) quit (); \
 193   if (interactive_hook) interactive_hook (); \
 194   PROGRESS (1); \
 195 }
 196 #endif
 197
 198 /* Languages represented in the symbol table and elsewhere.
 199    This should probably be in language.h, but since enum's can't
 200    be forward declared to satisfy opaque references before their
 201    actual definition, needs to be here. */
 202
 203 enum language
 204   {
 205     language_unknown,           /* Language not known */
 206     language_auto,              /* Placeholder for automatic setting */
 207     language_c,                 /* C */
 208     language_cplus,             /* C++ */
 209     language_java,              /* Java */
 210     language_chill,             /* Chill */
 211     language_fortran,           /* Fortran */
 212     language_m2,                /* Modula-2 */
 213     language_asm,               /* Assembly language */
 214     language_scm,               /* Scheme / Guile */
 215     language_pascal             /* Pascal */
 216   };
 217
 218 enum precision_type
 219   {
 220     single_precision,
 221     double_precision,
 222     unspecified_precision
 223   };
 224
 225 /* A generic, not quite boolean, enumeration.  */
 226 enum auto_boolean
 227 {
 228   AUTO_BOOLEAN_TRUE,
 229   AUTO_BOOLEAN_FALSE,
 230   AUTO_BOOLEAN_AUTO
 231 };
 232
 233 /* the cleanup list records things that have to be undone
 234    if an error happens (descriptors to be closed, memory to be freed, etc.)
 235    Each link in the chain records a function to call and an
 236    argument to give it.
 237
 238    Use make_cleanup to add an element to the cleanup chain.
 239    Use do_cleanups to do all cleanup actions back to a given
 240    point in the chain.  Use discard_cleanups to remove cleanups
 241    from the chain back to a given point, not doing them.  */
 242
 243 struct cleanup
 244   {
 245     struct cleanup *next;
 246     void (*function) (PTR);
 247     PTR arg;
 248   };
 249
 250
 251 /* The ability to declare that a function never returns is useful, but
 252    not really required to compile GDB successfully, so the NORETURN and
 253    ATTR_NORETURN macros normally expand into nothing.  */
 254
 255 /* If compiling with older versions of GCC, a function may be declared
 256    "volatile" to indicate that it does not return.  */
 257
 258 #ifndef NORETURN
 259 #if defined(__GNUC__) \
 260      && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
 261 #define NORETURN volatile
 262 #else
 263 #define NORETURN                /* nothing */
 264 #endif
 265 #endif
 266
 267 /* GCC 2.5 and later versions define a function attribute "noreturn",
 268    which is the preferred way to declare that a function never returns.
 269    However GCC 2.7 appears to be the first version in which this fully
 270    works everywhere we use it. */
 271
 272 #ifndef ATTR_NORETURN
 273 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
 274 #define ATTR_NORETURN __attribute__ ((noreturn))
 275 #else
 276 #define ATTR_NORETURN           /* nothing */
 277 #endif
 278 #endif
 279
 280 #ifndef ATTR_FORMAT
 281 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
 282 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
 283 #else
 284 #define ATTR_FORMAT(type, x, y) /* nothing */
 285 #endif
 286 #endif
 287
 288 /* Needed for various prototypes */
 289
 290 struct symtab;
 291 struct breakpoint;
 292
 293 /* From blockframe.c */
 294
 295 extern int inside_entry_func (CORE_ADDR);
 296
 297 extern int inside_entry_file (CORE_ADDR addr);
 298
 299 extern int inside_main_func (CORE_ADDR pc);
 300
 301 /* From ch-lang.c, for the moment. (FIXME) */
 302
 303 extern char *chill_demangle (const char *);
 304
 305 /* From utils.c */
 306
 307 extern void initialize_utils (void);
 308
 309 extern void notice_quit (void);
 310
 311 extern int strcmp_iw (const char *, const char *);
 312
 313 extern int subset_compare (char *, char *);
 314
 315 extern char *safe_strerror (int);
 316
 317 extern void init_malloc (void *);
 318
 319 extern void request_quit (int);
 320
 321 extern void do_cleanups (struct cleanup *);
 322 extern void do_final_cleanups (struct cleanup *);
 323 extern void do_my_cleanups (struct cleanup **, struct cleanup *);
 324 extern void do_run_cleanups (struct cleanup *);
 325 extern void do_exec_cleanups (struct cleanup *);
 326 extern void do_exec_error_cleanups (struct cleanup *);
 327
 328 extern void discard_cleanups (struct cleanup *);
 329 extern void discard_final_cleanups (struct cleanup *);
 330 extern void discard_exec_error_cleanups (struct cleanup *);
 331 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
 332
 333 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
 334    make_cleanup function declarations below. Do not use this typedef
 335    as a cast when passing functions into the make_cleanup() code.
 336    Instead either use a bounce function or add a wrapper function.
 337    Calling a f(char*) function with f(void*) is non-portable. */
 338 typedef void (make_cleanup_ftype) (void *);
 339
 340 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
 341
 342 extern struct cleanup *make_cleanup_freeargv (char **);
 343
 344 struct ui_file;
 345 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
 346
 347 extern struct cleanup *make_cleanup_close (int fd);
 348
 349 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
 350
 351 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
 352
 353 extern struct cleanup *make_my_cleanup (struct cleanup **,
 354                                         make_cleanup_ftype *, void *);
 355
 356 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
 357
 358 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
 359 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
 360
 361 extern struct cleanup *save_cleanups (void);
 362 extern struct cleanup *save_final_cleanups (void);
 363 extern struct cleanup *save_my_cleanups (struct cleanup **);
 364
 365 extern void restore_cleanups (struct cleanup *);
 366 extern void restore_final_cleanups (struct cleanup *);
 367 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 368
 369 extern void free_current_contents (void *);
 370
 371 extern void null_cleanup (void *);
 372
 373 extern int myread (int, char *, int);
 374
 375 extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 376
 377 extern void init_page_info (void);
 378
 379 extern CORE_ADDR host_pointer_to_address (void *ptr);
 380 extern void *address_to_host_pointer (CORE_ADDR addr);
 381
 382 extern char *gdb_realpath (const char *);
 383 extern char *xfullpath (const char *);
 384
 385 /* From demangle.c */
 386
 387 extern void set_demangling_style (char *);
 388
 389 /* From tm.h */
 390
 391 struct type;
 392 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
 393 extern use_struct_convention_fn generic_use_struct_convention;
 394
 395 \f
 396 /* Annotation stuff.  */
 397
 398 extern int annotation_level;    /* in stack.c */
 399 \f
 400 extern void begin_line (void);
 401
 402 extern void wrap_here (char *);
 403
 404 extern void reinitialize_more_filter (void);
 405
 406 /* Normal results */
 407 extern struct ui_file *gdb_stdout;
 408 /* Serious error notifications */
 409 extern struct ui_file *gdb_stderr;
 410 /* Log/debug/trace messages that should bypass normal stdout/stderr
 411    filtering.  For momement, always call this stream using
 412    *_unfiltered. In the very near future that restriction shall be
 413    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 414 extern struct ui_file *gdb_stdlog;
 415 /* Target output that should bypass normal stdout/stderr filtering.
 416    For momement, always call this stream using *_unfiltered. In the
 417    very near future that restriction shall be removed - either call
 418    shall be unfiltered. (cagney 1999-07-02). */
 419 extern struct ui_file *gdb_stdtarg;
 420
 421 #if defined(TUI)
 422 #include "tui.h"
 423 #endif
 424
 425 #include "ui-file.h"
 426
 427 /* More generic printf like operations.  Filtered versions may return
 428    non-locally on error.  */
 429
 430 extern void fputs_filtered (const char *, struct ui_file *);
 431
 432 extern void fputs_unfiltered (const char *, struct ui_file *);
 433
 434 extern int fputc_filtered (int c, struct ui_file *);
 435
 436 extern int fputc_unfiltered (int c, struct ui_file *);
 437
 438 extern int putchar_filtered (int c);
 439
 440 extern int putchar_unfiltered (int c);
 441
 442 extern void puts_filtered (const char *);
 443
 444 extern void puts_unfiltered (const char *);
 445
 446 extern void puts_debug (char *prefix, char *string, char *suffix);
 447
 448 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 449
 450 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 451
 452 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 453
 454 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 455
 456 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 457
 458 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 459
 460 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 461
 462 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 463
 464 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 465
 466 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 467
 468 extern void print_spaces (int, struct ui_file *);
 469
 470 extern void print_spaces_filtered (int, struct ui_file *);
 471
 472 extern char *n_spaces (int);
 473
 474 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 475
 476 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 477
 478 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 479
 480 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 481 extern void gdb_print_host_address (void *addr, struct ui_file *stream);
 482
 483 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 484    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
 485    for ``%*''. */
 486 extern int strlen_paddr (void);
 487 extern char *paddr (CORE_ADDR addr);
 488 extern char *paddr_nz (CORE_ADDR addr);
 489 extern char *paddr_u (CORE_ADDR addr);
 490 extern char *paddr_d (LONGEST addr);
 491
 492 extern char *phex (ULONGEST l, int sizeof_l);
 493 extern char *phex_nz (ULONGEST l, int sizeof_l);
 494
 495 /* Like paddr() only print/scan raw CORE_ADDR.  The output from
 496    core_addr_to_string() can be passed direct to
 497    string_to_core_addr().  */
 498 extern const char *core_addr_to_string (const CORE_ADDR addr);
 499 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 500 extern CORE_ADDR string_to_core_addr (const char *my_string);
 501
 502 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 503                                      enum language, int);
 504
 505 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
 506
 507 extern void print_sys_errmsg (const char *, int);
 508
 509 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 510    "const char *" in unistd.h, so we can't declare the argument
 511    as "char *".  */
 512
 513 extern char *re_comp (const char *);
 514
 515 /* From symfile.c */
 516
 517 extern void symbol_file_command (char *, int);
 518
 519 /* Remote targets may wish to use this as their load function.  */
 520 extern void generic_load (char *name, int from_tty);
 521
 522 /* Summarise a download */
 523 extern void print_transfer_performance (struct ui_file *stream,
 524                                         unsigned long data_count,
 525                                         unsigned long write_count,
 526                                         unsigned long time_count);
 527
 528 /* From top.c */
 529
 530 typedef void initialize_file_ftype (void);
 531
 532 extern char *skip_quoted (char *);
 533
 534 extern char *gdb_readline (char *);
 535
 536 extern char *command_line_input (char *, int, char *);
 537
 538 extern void print_prompt (void);
 539
 540 extern int input_from_terminal_p (void);
 541
 542 extern int info_verbose;
 543
 544 /* From printcmd.c */
 545
 546 extern void set_next_address (CORE_ADDR);
 547
 548 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
 549                                     char *);
 550
 551 extern int build_address_symbolic (CORE_ADDR addr,
 552                                    int do_demangle,
 553                                    char **name,
 554                                    int *offset,
 555                                    char **filename,
 556                                    int *line,
 557                                    int *unmapped);
 558
 559 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
 560
 561 extern void print_address (CORE_ADDR, struct ui_file *);
 562
 563 /* From source.c */
 564
 565 extern int openp (const char *, int, const char *, int, int, char **);
 566
 567 extern int source_full_path_of (char *, char **);
 568
 569 extern void mod_path (char *, char **);
 570
 571 extern void directory_command (char *, int);
 572
 573 extern void init_source_path (void);
 574
 575 extern char *symtab_to_filename (struct symtab *);
 576
 577 /* From exec.c */
 578
 579 extern void exec_set_section_offsets (bfd_signed_vma text_off,
 580                                       bfd_signed_vma data_off,
 581                                       bfd_signed_vma bss_off);
 582
 583 /* Take over the 'find_mapped_memory' vector from exec.c. */
 584 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
 585                                                             unsigned long,
 586                                                             int, int, int,
 587                                                             void *),
 588                                                    void *));
 589
 590 /* Possible lvalue types.  Like enum language, this should be in
 591    value.h, but needs to be here for the same reason. */
 592
 593 enum lval_type
 594   {
 595     /* Not an lval. */
 596     not_lval,
 597     /* In memory.  Could be a saved register.  */
 598     lval_memory,
 599     /* In a register.  */
 600     lval_register,
 601     /* In a gdb internal variable.  */
 602     lval_internalvar,
 603     /* Part of a gdb internal variable (structure field).  */
 604     lval_internalvar_component,
 605     /* In a register series in a frame not the current one, which may have been
 606        partially saved or saved in different places (otherwise would be
 607        lval_register or lval_memory).  */
 608     lval_reg_frame_relative
 609   };
 610
 611 struct frame_info;
 612
 613 /* From readline (but not in any readline .h files).  */
 614
 615 extern char *tilde_expand (char *);
 616
 617 /* Control types for commands */
 618
 619 enum misc_command_type
 620   {
 621     ok_command,
 622     end_command,
 623     else_command,
 624     nop_command
 625   };
 626
 627 enum command_control_type
 628   {
 629     simple_control,
 630     break_control,
 631     continue_control,
 632     while_control,
 633     if_control,
 634     invalid_control
 635   };
 636
 637 /* Structure for saved commands lines
 638    (for breakpoints, defined commands, etc).  */
 639
 640 struct command_line
 641   {
 642     struct command_line *next;
 643     char *line;
 644     enum command_control_type control_type;
 645     int body_count;
 646     struct command_line **body_list;
 647   };
 648
 649 extern struct command_line *read_command_lines (char *, int);
 650
 651 extern void free_command_lines (struct command_line **);
 652
 653 /* To continue the execution commands when running gdb asynchronously.
 654    A continuation structure contains a pointer to a function to be called
 655    to finish the command, once the target has stopped. Such mechanism is
 656    used bt the finish and until commands, and in the remote protocol
 657    when opening an extended-remote connection. */
 658
 659 struct continuation_arg
 660   {
 661     struct continuation_arg *next;
 662     union continuation_data {
 663       void *pointer;
 664       int   integer;
 665       long  longint;
 666     } data;
 667   };
 668
 669 struct continuation
 670   {
 671     void (*continuation_hook) (struct continuation_arg *);
 672     struct continuation_arg *arg_list;
 673     struct continuation *next;
 674   };
 675
 676 /* In infrun.c. */
 677 extern struct continuation *cmd_continuation;
 678 /* Used only by the step_1 function. */
 679 extern struct continuation *intermediate_continuation;
 680
 681 /* From utils.c */
 682 extern void add_continuation (void (*)(struct continuation_arg *),
 683                               struct continuation_arg *);
 684 extern void do_all_continuations (void);
 685 extern void discard_all_continuations (void);
 686
 687 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
 688                               struct continuation_arg *);
 689 extern void do_all_intermediate_continuations (void);
 690 extern void discard_all_intermediate_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
 714 /* The ptid struct is a collection of the various "ids" necessary
 715    for identifying the inferior.  This consists of the process id
 716    (pid), thread id (tid), and other fields necessary for uniquely
 717    identifying the inferior process/thread being debugged.  When
 718    manipulating ptids, the constructors, accessors, and predicate
 719    declared in inferior.h should be used.  These are as follows:
 720
 721       ptid_build        - Make a new ptid from a pid, lwp, and tid.
 722       pid_to_ptid       - Make a new ptid from just a pid.
 723       ptid_get_pid      - Fetch the pid component of a ptid.
 724       ptid_get_lwp      - Fetch the lwp component of a ptid.
 725       ptid_get_tid      - Fetch the tid component of a ptid.
 726       ptid_equal        - Test to see if two ptids are equal.
 727
 728    Please do NOT access the struct ptid members directly (except, of
 729    course, in the implementation of the above ptid manipulation
 730    functions).  */
 731
 732 struct ptid
 733   {
 734     /* Process id */
 735     int pid;
 736
 737     /* Lightweight process id */
 738     long lwp;
 739
 740     /* Thread id */
 741     long tid;
 742   };
 743
 744 typedef struct ptid ptid_t;
 745
 746 \f
 747
 748 /* Optional host machine definition.  Pure autoconf targets will not
 749    need a "xm.h" file.  This will be a symlink to one of the xm-*.h
 750    files, built by the `configure' script.  */
 751
 752 #ifdef GDB_XM_FILE
 753 #include "xm.h"
 754 #endif
 755
 756 /* Optional native machine support.  Non-native (and possibly pure
 757    multi-arch) targets do not need a "nm.h" file.  This will be a
 758    symlink to one of the nm-*.h files, built by the `configure'
 759    script.  */
 760
 761 #ifdef GDB_NM_FILE
 762 #include "nm.h"
 763 #endif
 764
 765 /* Optional target machine definition.  Pure multi-arch configurations
 766    do not need a "tm.h" file.  This will be a symlink to one of the
 767    tm-*.h files, built by the `configure' script.  */
 768
 769 #ifdef GDB_TM_FILE
 770 #include "tm.h"
 771 #endif
 772
 773 /* GDB_MULTI_ARCH is normally set by configure.in using information
 774    from configure.tgt or the config/%/%.mt Makefile fragment.  Since
 775    some targets have defined it in their "tm.h" file, delay providing
 776    a default definition until after "tm.h" has been included.. */
 777
 778 #ifndef GDB_MULTI_ARCH
 779 #define GDB_MULTI_ARCH 0
 780 #endif
 781
 782
 783 /* If the xm.h file did not define the mode string used to open the
 784    files, assume that binary files are opened the same way as text
 785    files */
 786 #ifndef FOPEN_RB
 787 #include "fopen-same.h"
 788 #endif
 789
 790 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 791    FIXME: Assumes 2's complement arithmetic */
 792
 793 #if !defined (UINT_MAX)
 794 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 795 #endif
 796
 797 #if !defined (INT_MAX)
 798 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 799 #endif
 800
 801 #if !defined (INT_MIN)
 802 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 803 #endif
 804
 805 #if !defined (ULONG_MAX)
 806 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 807 #endif
 808
 809 #if !defined (LONG_MAX)
 810 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 811 #endif
 812
 813 #if !defined (ULONGEST_MAX)
 814 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 815 #endif
 816
 817 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 818 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 819 #endif
 820
 821 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 822    arguments to a function, number in a value history, register number, etc.)
 823    where the value must not be larger than can fit in an int.  */
 824
 825 extern int longest_to_int (LONGEST);
 826
 827 /* Assorted functions we can declare, now that const and volatile are
 828    defined.  */
 829
 830 extern char *savestring (const char *, size_t);
 831
 832 extern char *msavestring (void *, const char *, size_t);
 833
 834 extern char *mstrsave (void *, const char *);
 835
 836 /* Robust versions of same.  Throw an internal error when no memory,
 837    guard against stray NULL arguments. */
 838 extern void *xmmalloc (void *md, size_t size);
 839 extern void *xmrealloc (void *md, void *ptr, size_t size);
 840 extern void *xmcalloc (void *md, size_t number, size_t size);
 841 extern void xmfree (void *md, void *ptr);
 842
 843 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
 844    "libiberty.h". */
 845 extern void xfree (void *);
 846
 847 /* Utility macros to allocate typed memory.  Avoids errors like
 848    ``struct foo *foo = xmalloc (sizeof bar)'' and ``struct foo *foo =
 849    (struct foo *) xmalloc (sizeof bar)''.  */
 850 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 851 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 852
 853 /* Like asprintf/vasprintf but get an internal_error if the call
 854    fails. */
 855 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
 856 extern void xvasprintf (char **ret, const char *format, va_list ap);
 857
 858 extern int parse_escape (char **);
 859
 860 /* Message to be printed before the error message, when an error occurs.  */
 861
 862 extern char *error_pre_print;
 863
 864 /* Message to be printed before the error message, when an error occurs.  */
 865
 866 extern char *quit_pre_print;
 867
 868 /* Message to be printed before the warning message, when a warning occurs.  */
 869
 870 extern char *warning_pre_print;
 871
 872 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
 873
 874 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 875
 876 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
 877
 878 /* Returns a freshly allocate buffer containing the last error
 879    message.  */
 880 extern char *error_last_message (void);
 881
 882 extern NORETURN void internal_verror (const char *file, int line,
 883                                       const char *, va_list ap) ATTR_NORETURN;
 884
 885 extern NORETURN void internal_error (const char *file, int line,
 886                                      const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
 887
 888 extern NORETURN void nomem (long) ATTR_NORETURN;
 889
 890 /* Reasons for calling throw_exception().  NOTE: all reason values
 891    must be less than zero.  enum value 0 is reserved for internal use
 892    as the return value from an initial setjmp().  The function
 893    catch_exceptions() reserves values >= 0 as legal results from its
 894    wrapped function.  */
 895
 896 enum return_reason
 897   {
 898     /* User interrupt.  */
 899     RETURN_QUIT = -2,
 900     /* Any other error.  */
 901     RETURN_ERROR
 902   };
 903
 904 #define ALL_CLEANUPS    ((struct cleanup *)0)
 905
 906 #define RETURN_MASK(reason)     (1 << (int)(-reason))
 907 #define RETURN_MASK_QUIT        RETURN_MASK (RETURN_QUIT)
 908 #define RETURN_MASK_ERROR       RETURN_MASK (RETURN_ERROR)
 909 #define RETURN_MASK_ALL         (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
 910 typedef int return_mask;
 911
 912 /* Throw an exception of type RETURN_REASON.  Will execute a LONG JUMP
 913    to the inner most containing exception handler established using
 914    catch_exceptions() (or the legacy catch_errors()).
 915
 916    Code normally throws an exception using error() et.al.  For various
 917    reaons, GDB also contains code that throws an exception directly.
 918    For instance, the remote*.c targets contain CNTRL-C signal handlers
 919    that propogate the QUIT event up the exception chain.  ``This could
 920    be a good thing or a dangerous thing.'' -- the Existential Wombat.  */
 921
 922 extern NORETURN void throw_exception (enum return_reason) ATTR_NORETURN;
 923
 924 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
 925    handler.  If an exception (enum return_reason) is thrown using
 926    throw_exception() than all cleanups installed since
 927    catch_exceptions() was entered are invoked, the (-ve) exception
 928    value is then returned by catch_exceptions.  If FUNC() returns
 929    normally (with a postive or zero return value) then that value is
 930    returned by catch_exceptions().  It is an internal_error() for
 931    FUNC() to return a negative value.
 932
 933    For the period of the FUNC() call: UIOUT is installed as the output
 934    builder; ERRSTRING is installed as the error/quit message; and a
 935    new cleanup_chain is established.  The old values are restored
 936    before catch_exceptions() returns.
 937
 938    FIXME; cagney/2001-08-13: The need to override the global UIOUT
 939    builder variable should just go away.
 940
 941    This function superseeds catch_errors().
 942
 943    This function uses SETJMP() and LONGJUMP().  */
 944
 945 struct ui_out;
 946 typedef int (catch_exceptions_ftype) (struct ui_out *ui_out, void *args);
 947 extern int catch_exceptions (struct ui_out *uiout,
 948                              catch_exceptions_ftype *func, void *func_args,
 949                              char *errstring, return_mask mask);
 950
 951 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
 952    otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
 953    probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
 954    value. It's unfortunate that, catch_errors() does not return an
 955    indication of the exact exception that it caught - quit_flag might
 956    help.
 957
 958    This function is superseeded by catch_exceptions().  */
 959
 960 typedef int (catch_errors_ftype) (PTR);
 961 extern int catch_errors (catch_errors_ftype *, void *, char *, return_mask);
 962
 963 /* Template to catch_errors() that wraps calls to command
 964    functions. */
 965
 966 typedef void (catch_command_errors_ftype) (char *, int);
 967 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
 968
 969 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 970
 971 extern void vwarning (const char *, va_list args);
 972
 973 /* Global functions from other, non-gdb GNU thingies.
 974    Libiberty thingies are no longer declared here.  We include libiberty.h
 975    above, instead.  */
 976
 977 #ifndef GETENV_PROVIDED
 978 extern char *getenv (const char *);
 979 #endif
 980
 981 /* From other system libraries */
 982
 983 #ifdef HAVE_STDDEF_H
 984 #include <stddef.h>
 985 #endif
 986
 987 #ifdef HAVE_STDLIB_H
 988 #include <stdlib.h>
 989 #endif
 990 #ifndef min
 991 #define min(a, b) ((a) < (b) ? (a) : (b))
 992 #endif
 993 #ifndef max
 994 #define max(a, b) ((a) > (b) ? (a) : (b))
 995 #endif
 996
 997
 998 /* We take the address of fclose later, but some stdio's forget
 999    to declare this.  We can't always declare it since there's
1000    no way to declare the parameters without upsetting some compiler
1001    somewhere. */
1002
1003 #ifndef FCLOSE_PROVIDED
1004 extern int fclose (FILE *);
1005 #endif
1006
1007 #ifndef atof
1008 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
1009 #endif
1010
1011 /* Various possibilities for alloca.  */
1012 #ifndef alloca
1013 #ifdef __GNUC__
1014 #define alloca __builtin_alloca
1015 #else /* Not GNU C */
1016 #ifdef HAVE_ALLOCA_H
1017 #include <alloca.h>
1018 #else
1019 #ifdef _AIX
1020 #pragma alloca
1021 #else
1022
1023 /* We need to be careful not to declare this in a way which conflicts with
1024    bison.  Bison never declares it as char *, but under various circumstances
1025    (like __hpux) we need to use void *.  */
1026 extern void *alloca ();
1027 #endif /* Not _AIX */
1028 #endif /* Not HAVE_ALLOCA_H */
1029 #endif /* Not GNU C */
1030 #endif /* alloca not defined */
1031
1032 /* Dynamic target-system-dependent parameters for GDB. */
1033 #include "gdbarch.h"
1034 #if (GDB_MULTI_ARCH == 0)
1035 /* Multi-arch targets _should_ be including "arch-utils.h" directly
1036    into their *-tdep.c file.  This is a prop to help old non-
1037    multi-arch targets to continue to compile. */
1038 #include "arch-utils.h"
1039 #endif
1040
1041 /* Static target-system-dependent parameters for GDB. */
1042
1043 /* Number of bits in a char or unsigned char for the target machine.
1044    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
1045 #if !defined (TARGET_CHAR_BIT)
1046 #define TARGET_CHAR_BIT 8
1047 #endif
1048
1049 /* If we picked up a copy of CHAR_BIT from a configuration file
1050    (which may get it by including <limits.h>) then use it to set
1051    the number of bits in a host char.  If not, use the same size
1052    as the target. */
1053
1054 #if defined (CHAR_BIT)
1055 #define HOST_CHAR_BIT CHAR_BIT
1056 #else
1057 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1058 #endif
1059
1060 /* The bit byte-order has to do just with numbering of bits in
1061    debugging symbols and such.  Conceptually, it's quite separate
1062    from byte/word byte order.  */
1063
1064 #if !defined (BITS_BIG_ENDIAN)
1065 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1066 #endif
1067
1068 /* In findvar.c.  */
1069
1070 extern LONGEST extract_signed_integer (void *, int);
1071
1072 extern ULONGEST extract_unsigned_integer (void *, int);
1073
1074 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1075
1076 extern CORE_ADDR extract_address (void *, int);
1077
1078 extern CORE_ADDR extract_typed_address (void *buf, struct type *type);
1079
1080 extern void store_signed_integer (void *, int, LONGEST);
1081
1082 extern void store_unsigned_integer (void *, int, ULONGEST);
1083
1084 extern void store_address (void *, int, LONGEST);
1085
1086 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1087
1088 \f
1089 /* From valops.c */
1090
1091 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1092
1093 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1094
1095 extern int watchdog;
1096
1097 /* Hooks for alternate command interfaces.  */
1098
1099 /* The name of the interpreter if specified on the command line. */
1100 extern char *interpreter_p;
1101
1102 /* If a given interpreter matches INTERPRETER_P then it should update
1103    command_loop_hook and init_ui_hook with the per-interpreter
1104    implementation. */
1105 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1106
1107 struct target_waitstatus;
1108 struct cmd_list_element;
1109
1110 /* Should the asynchronous variant of the interpreter (using the
1111    event-loop) be enabled? */
1112 extern int event_loop_p;
1113
1114 extern void (*init_ui_hook) (char *argv0);
1115 extern void (*command_loop_hook) (void);
1116 extern void (*show_load_progress) (const char *section,
1117                                    unsigned long section_sent,
1118                                    unsigned long section_size,
1119                                    unsigned long total_sent,
1120                                    unsigned long total_size);
1121 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1122                                               int line, int stopline,
1123                                               int noerror);
1124 extern struct frame_info *parse_frame_specification (char *frame_exp);
1125 extern int (*query_hook) (const char *, va_list);
1126 extern void (*warning_hook) (const char *, va_list);
1127 extern void (*flush_hook) (struct ui_file * stream);
1128 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1129 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1130 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1131 extern void (*interactive_hook) (void);
1132 extern void (*registers_changed_hook) (void);
1133 extern void (*readline_begin_hook) (char *,...);
1134 extern char *(*readline_hook) (char *);
1135 extern void (*readline_end_hook) (void);
1136 extern void (*register_changed_hook) (int regno);
1137 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1138 extern void (*context_hook) (int);
1139 extern ptid_t (*target_wait_hook) (ptid_t ptid,
1140                                          struct target_waitstatus * status);
1141
1142 extern void (*attach_hook) (void);
1143 extern void (*detach_hook) (void);
1144 extern void (*call_command_hook) (struct cmd_list_element * c,
1145                                   char *cmd, int from_tty);
1146
1147 extern void (*set_hook) (struct cmd_list_element * c);
1148
1149 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1150
1151 extern void (*error_begin_hook) (void);
1152
1153 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1154
1155
1156 /* Inhibit window interface if non-zero. */
1157
1158 extern int use_windows;
1159
1160 /* Symbolic definitions of filename-related things.  */
1161 /* FIXME, this doesn't work very well if host and executable
1162    filesystems conventions are different.  */
1163
1164 #ifndef DIRNAME_SEPARATOR
1165 #define DIRNAME_SEPARATOR ':'
1166 #endif
1167
1168 #ifndef SLASH_STRING
1169 #define SLASH_STRING "/"
1170 #endif
1171
1172 #ifdef __MSDOS__
1173 # define CANT_FORK
1174 # define GLOBAL_CURDIR
1175 #endif
1176
1177 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1178    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1179    in the code actually refer to a lightweight process id, i.e,
1180    something that can be considered a process id in its own right for
1181    certain purposes.  */
1182
1183 #ifndef PIDGET
1184 #define PIDGET(PTID) (ptid_get_pid (PTID))
1185 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1186 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1187 #endif
1188
1189 /* Define well known filenos if the system does not define them.  */
1190 #ifndef STDIN_FILENO
1191 #define STDIN_FILENO   0
1192 #endif
1193 #ifndef STDOUT_FILENO
1194 #define STDOUT_FILENO  1
1195 #endif
1196 #ifndef STDERR_FILENO
1197 #define STDERR_FILENO  2
1198 #endif
1199
1200 /* If this definition isn't overridden by the header files, assume
1201    that isatty and fileno exist on this system.  */
1202 #ifndef ISATTY
1203 #define ISATTY(FP)      (isatty (fileno (FP)))
1204 #endif
1205
1206 #endif /* #ifndef DEFS_H */