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