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