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