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