gdb/defs.h

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