gdb/defs.h

   1 /* Basic, host-specific, and target-specific definitions for GDB.
   2    Copyright (C) 1986, 89, 91, 92, 93, 94, 95, 96, 1998
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GDB.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20
  21 #ifndef DEFS_H
  22 #define DEFS_H
  23
  24 #include "config.h"             /* Generated by configure */
  25 #include <stdio.h>
  26 #include <errno.h>              /* System call error return status */
  27
  28 #ifdef HAVE_STDDEF_H
  29 #  include <stddef.h>
  30 #else
  31 #  include <sys/types.h>   /* for size_t */
  32 #endif
  33
  34 /* Just in case they're not defined in stdio.h. */
  35
  36 #ifndef SEEK_SET
  37 #define SEEK_SET 0
  38 #endif
  39 #ifndef SEEK_CUR
  40 #define SEEK_CUR 1
  41 #endif
  42
  43 /* First include ansidecl.h so we can use the various macro definitions
  44    here and in all subsequent file inclusions.  */
  45
  46 #include "ansidecl.h"
  47
  48 #ifdef ANSI_PROTOTYPES
  49 #include <stdarg.h>
  50 #else
  51 #include <varargs.h>
  52 #endif
  53
  54 #include "libiberty.h"
  55
  56 /* libiberty.h can't declare this one, but evidently we can.  */
  57 extern char *strsignal PARAMS ((int));
  58
  59 #include "progress.h"
  60
  61 #ifdef USE_MMALLOC
  62 #include "mmalloc.h"
  63 #endif
  64
  65 /* For BFD64 and bfd_vma.  */
  66 #include "bfd.h"
  67
  68 /* An address in the program being debugged.  Host byte order.  Rather
  69    than duplicate all the logic in BFD which figures out what type
  70    this is (long, long long, etc.) and whether it needs to be 64
  71    bits (the host/target interactions are subtle), we just use
  72    bfd_vma.  */
  73
  74 typedef bfd_vma CORE_ADDR;
  75
  76 #ifndef min
  77 #define min(a, b) ((a) < (b) ? (a) : (b))
  78 #endif
  79 #ifndef max
  80 #define max(a, b) ((a) > (b) ? (a) : (b))
  81 #endif
  82
  83 /* Gdb does *lots* of string compares.  Use macros to speed them up by
  84    avoiding function calls if the first characters are not the same. */
  85
  86 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : (int)*(a) - (int)*(b))
  87 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
  88 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
  89
  90 /* The character GNU C++ uses to build identifiers that must be unique from
  91    the program's identifiers (such as $this and $$vptr).  */
  92 #define CPLUS_MARKER '$'        /* May be overridden to '.' for SysV */
  93
  94 /* Check if a character is one of the commonly used C++ marker characters.  */
  95 extern int is_cplus_marker PARAMS ((int));
  96
  97 /* enable xdb commands if set */
  98 extern int xdb_commands;
  99
 100 /* enable dbx commands if set */
 101 extern int dbx_commands;
 102
 103 extern int quit_flag;
 104 extern int immediate_quit;
 105 extern int sevenbit_strings;
 106
 107 extern void quit PARAMS ((void));
 108
 109 #ifdef QUIT
 110 /* do twice to force compiler warning */
 111 #define QUIT_FIXME "FIXME"
 112 #define QUIT_FIXME "ignoring redefinition of QUIT"
 113 #else
 114 #define QUIT { \
 115   if (quit_flag) quit (); \
 116   if (interactive_hook) interactive_hook (); \
 117   PROGRESS (1); \
 118 }
 119 #endif
 120
 121 /* Command classes are top-level categories into which commands are broken
 122    down for "help" purposes.
 123    Notes on classes: class_alias is for alias commands which are not
 124    abbreviations of the original command.  class-pseudo is for commands
 125    which are not really commands nor help topics ("stop").  */
 126
 127 enum command_class
 128 {
 129   /* Special args to help_list */
 130   all_classes = -2, all_commands = -1,
 131   /* Classes of commands */
 132   no_class = -1, class_run = 0, class_vars, class_stack,
 133   class_files, class_support, class_info, class_breakpoint, class_trace,
 134   class_alias, class_obscure, class_user, class_maintenance,
 135   class_pseudo, class_tui, class_xdb
 136 };
 137
 138 /* Languages represented in the symbol table and elsewhere.
 139    This should probably be in language.h, but since enum's can't
 140    be forward declared to satisfy opaque references before their
 141    actual definition, needs to be here. */
 142
 143 enum language
 144 {
 145    language_unknown,            /* Language not known */
 146    language_auto,               /* Placeholder for automatic setting */
 147    language_c,                  /* C */
 148    language_cplus,              /* C++ */
 149    /* start-sanitize-java */
 150    language_java,               /* Java */
 151    /* end-sanitize-java */
 152    language_chill,              /* Chill */
 153    language_fortran,            /* Fortran */
 154    language_m2,                 /* Modula-2 */
 155    language_asm,                /* Assembly language */
 156    language_scm                 /* Scheme / Guile */
 157 };
 158
 159 /* the cleanup list records things that have to be undone
 160    if an error happens (descriptors to be closed, memory to be freed, etc.)
 161    Each link in the chain records a function to call and an
 162    argument to give it.
 163
 164    Use make_cleanup to add an element to the cleanup chain.
 165    Use do_cleanups to do all cleanup actions back to a given
 166    point in the chain.  Use discard_cleanups to remove cleanups
 167    from the chain back to a given point, not doing them.  */
 168
 169 struct cleanup
 170 {
 171   struct cleanup *next;
 172   void (*function) PARAMS ((PTR));
 173   PTR arg;
 174 };
 175
 176
 177 /* The ability to declare that a function never returns is useful, but
 178    not really required to compile GDB successfully, so the NORETURN and
 179    ATTR_NORETURN macros normally expand into nothing.  */
 180
 181 /* If compiling with older versions of GCC, a function may be declared
 182    "volatile" to indicate that it does not return.  */
 183
 184 #ifndef NORETURN
 185 # if defined(__GNUC__) \
 186      && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
 187 #  define NORETURN volatile
 188 # else
 189 #  define NORETURN /* nothing */
 190 # endif
 191 #endif
 192
 193 /* GCC 2.5 and later versions define a function attribute "noreturn",
 194    which is the preferred way to declare that a function never returns.
 195    However GCC 2.7 appears to be the first version in which this fully
 196    works everywhere we use it. */
 197
 198 #ifndef ATTR_NORETURN
 199 # if defined(__GNUC__) && __GNUC__ >= 2 && __GNUC_MINOR__ >= 7
 200 #  define ATTR_NORETURN __attribute__ ((noreturn))
 201 # else
 202 #  define ATTR_NORETURN /* nothing */
 203 # endif
 204 #endif
 205
 206 #ifndef ATTR_FORMAT
 207 # if defined(__GNUC__) && __GNUC__ >= 2 && __GNUC_MINOR__ >= 4 && defined (__ANSI_PROTOTYPES)
 208 #  define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
 209 # else
 210 #  define ATTR_FORMAT(type, x, y) /* nothing */
 211 # endif
 212 #endif
 213
 214 /* Needed for various prototypes */
 215
 216 #ifdef __STDC__
 217 struct symtab;
 218 struct breakpoint;
 219 #endif
 220
 221 /* From blockframe.c */
 222
 223 extern int inside_entry_func PARAMS ((CORE_ADDR));
 224
 225 extern int inside_entry_file PARAMS ((CORE_ADDR addr));
 226
 227 extern int inside_main_func PARAMS ((CORE_ADDR pc));
 228
 229 /* From ch-lang.c, for the moment. (FIXME) */
 230
 231 extern char *chill_demangle PARAMS ((const char *));
 232
 233 /* From utils.c */
 234
 235 extern void notice_quit PARAMS ((void));
 236
 237 extern int strcmp_iw PARAMS ((const char *, const char *));
 238
 239 extern char *safe_strerror PARAMS ((int));
 240
 241 extern char *safe_strsignal PARAMS ((int));
 242
 243 extern void init_malloc PARAMS ((void *));
 244
 245 extern void request_quit PARAMS ((int));
 246
 247 extern void do_cleanups PARAMS ((struct cleanup *));
 248 extern void do_final_cleanups PARAMS ((struct cleanup *));
 249 extern void do_my_cleanups PARAMS ((struct cleanup **, struct cleanup *));
 250 extern void do_run_cleanups PARAMS ((struct cleanup *));
 251
 252 extern void discard_cleanups PARAMS ((struct cleanup *));
 253 extern void discard_final_cleanups PARAMS ((struct cleanup *));
 254 extern void discard_my_cleanups PARAMS ((struct cleanup **, struct cleanup *));
 255
 256 typedef void (*make_cleanup_func) PARAMS ((void *));
 257
 258 extern struct cleanup *make_cleanup PARAMS ((make_cleanup_func, void *));
 259
 260 extern struct cleanup *make_final_cleanup PARAMS ((make_cleanup_func, void *));
 261
 262 extern struct cleanup *make_my_cleanup PARAMS ((struct cleanup **,
 263                                                 make_cleanup_func, void *));
 264
 265 extern struct cleanup *make_run_cleanup PARAMS ((make_cleanup_func, void *));
 266
 267 extern struct cleanup *save_cleanups PARAMS ((void));
 268 extern struct cleanup *save_final_cleanups PARAMS ((void));
 269 extern struct cleanup *save_my_cleanups PARAMS ((struct cleanup **));
 270
 271 extern void restore_cleanups PARAMS ((struct cleanup *));
 272 extern void restore_final_cleanups PARAMS ((struct cleanup *));
 273 extern void restore_my_cleanups PARAMS ((struct cleanup **, struct cleanup *));
 274
 275 extern void free_current_contents PARAMS ((char **));
 276
 277 extern void null_cleanup PARAMS ((PTR));
 278
 279 extern int myread PARAMS ((int, char *, int));
 280
 281 extern int query PARAMS((char *, ...))
 282      ATTR_FORMAT(printf, 1, 2);
 283
 284 #if !defined (USE_MMALLOC)
 285 extern PTR mmalloc PARAMS ((PTR, size_t));
 286 extern PTR mrealloc PARAMS ((PTR, PTR, size_t));
 287 extern void mfree PARAMS ((PTR, PTR));
 288 #endif
 289
 290 /* From demangle.c */
 291
 292 extern void set_demangling_style PARAMS ((char *));
 293
 294 /* From tm.h */
 295
 296 struct type;
 297 typedef int (use_struct_convention_fn) PARAMS ((int gcc_p, struct type *value_type));
 298 extern use_struct_convention_fn generic_use_struct_convention;
 299
 300 typedef unsigned char *(breakpoint_from_pc_fn) PARAMS ((CORE_ADDR *pcptr, int *lenptr));
 301
 302
 303 \f
 304 /* Annotation stuff.  */
 305
 306 extern int annotation_level; /* in stack.c */
 307 \f
 308 extern void begin_line PARAMS ((void));
 309
 310 extern void wrap_here PARAMS ((char *));
 311
 312 extern void reinitialize_more_filter PARAMS ((void));
 313
 314 typedef FILE GDB_FILE;
 315 #define gdb_stdout stdout
 316 #define gdb_stderr stderr
 317
 318 extern void gdb_flush PARAMS ((GDB_FILE *));
 319
 320 extern GDB_FILE *gdb_fopen PARAMS ((char * name, char * mode));
 321
 322 extern void fputs_filtered PARAMS ((const char *, GDB_FILE *));
 323
 324 extern void fputs_unfiltered PARAMS ((const char *, GDB_FILE *));
 325
 326 extern int fputc_filtered PARAMS ((int c, GDB_FILE *));
 327
 328 extern int fputc_unfiltered PARAMS ((int c, GDB_FILE *));
 329
 330 extern int putchar_unfiltered PARAMS ((int c));
 331
 332 extern void puts_filtered PARAMS ((const char *));
 333
 334 extern void puts_unfiltered PARAMS ((const char *));
 335
 336 extern void puts_debug PARAMS ((char *prefix, char *string, char *suffix));
 337
 338 extern void vprintf_filtered PARAMS ((const char *, va_list))
 339      ATTR_FORMAT(printf, 1, 0);
 340
 341 extern void vfprintf_filtered PARAMS ((FILE *, const char *, va_list))
 342      ATTR_FORMAT(printf, 2, 0);
 343
 344 extern void fprintf_filtered PARAMS ((FILE *, const char *, ...))
 345      ATTR_FORMAT(printf, 2, 3);
 346
 347 extern void fprintfi_filtered PARAMS ((int, FILE *, const char *, ...))
 348      ATTR_FORMAT(printf, 3, 4);
 349
 350 extern void printf_filtered PARAMS ((const char *, ...))
 351      ATTR_FORMAT(printf, 1, 2);
 352
 353 extern void printfi_filtered PARAMS ((int, const char *, ...))
 354      ATTR_FORMAT(printf, 2, 3);
 355
 356 extern void vprintf_unfiltered PARAMS ((const char *, va_list))
 357      ATTR_FORMAT(printf, 1, 0);
 358
 359 extern void vfprintf_unfiltered PARAMS ((FILE *, const char *, va_list))
 360      ATTR_FORMAT(printf, 2, 0);
 361
 362 extern void fprintf_unfiltered PARAMS ((FILE *, const char *, ...))
 363      ATTR_FORMAT(printf, 2, 3);
 364
 365 extern void printf_unfiltered PARAMS ((const char *, ...))
 366      ATTR_FORMAT(printf, 1, 2);
 367
 368 extern void print_spaces PARAMS ((int, GDB_FILE *));
 369
 370 extern void print_spaces_filtered PARAMS ((int, GDB_FILE *));
 371
 372 extern char *n_spaces PARAMS ((int));
 373
 374 extern void gdb_printchar PARAMS ((int, GDB_FILE *, int));
 375
 376 extern void gdb_print_address PARAMS ((void *, GDB_FILE *));
 377
 378 typedef bfd_vma t_addr;
 379 typedef bfd_vma t_reg;
 380 extern char* paddr PARAMS ((t_addr addr));
 381
 382 extern char* preg PARAMS ((t_reg reg));
 383
 384 extern char* paddr_nz PARAMS ((t_addr addr));
 385
 386 extern char* preg_nz PARAMS ((t_reg reg));
 387
 388 extern void fprintf_symbol_filtered PARAMS ((GDB_FILE *, char *,
 389                                              enum language, int));
 390
 391 extern NORETURN void perror_with_name PARAMS ((char *)) ATTR_NORETURN;
 392
 393 extern void print_sys_errmsg PARAMS ((char *, int));
 394
 395 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 396    "const char *" in unistd.h, so we can't declare the argument
 397    as "char *".  */
 398
 399 extern char *re_comp PARAMS ((const char *));
 400
 401 /* From symfile.c */
 402
 403 extern void symbol_file_command PARAMS ((char *, int));
 404
 405 /* From top.c */
 406
 407 extern char *skip_quoted PARAMS ((char *));
 408
 409 extern char *gdb_readline PARAMS ((char *));
 410
 411 extern char *command_line_input PARAMS ((char *, int, char *));
 412
 413 extern void print_prompt PARAMS ((void));
 414
 415 extern int input_from_terminal_p PARAMS ((void));
 416
 417 extern int info_verbose;
 418
 419 /* From printcmd.c */
 420
 421 extern void set_next_address PARAMS ((CORE_ADDR));
 422
 423 extern void print_address_symbolic PARAMS ((CORE_ADDR, GDB_FILE *, int,
 424                                             char *));
 425
 426 extern void print_address_numeric PARAMS ((CORE_ADDR, int, GDB_FILE *));
 427
 428 extern void print_address PARAMS ((CORE_ADDR, GDB_FILE *));
 429
 430 /* From source.c */
 431
 432 extern int openp PARAMS ((char *, int, char *, int, int, char **));
 433
 434 extern void mod_path PARAMS ((char *, char **));
 435
 436 extern void directory_command PARAMS ((char *, int));
 437
 438 extern void init_source_path PARAMS ((void));
 439
 440 extern char *symtab_to_filename PARAMS ((struct symtab *));
 441
 442 /* From findvar.c */
 443
 444 extern int read_relative_register_raw_bytes PARAMS ((int, char *));
 445
 446 /* From readline (but not in any readline .h files).  */
 447
 448 extern char *tilde_expand PARAMS ((char *));
 449
 450 /* Control types for commands */
 451
 452 enum misc_command_type
 453 {
 454   ok_command,
 455   end_command,
 456   else_command,
 457   nop_command
 458 };
 459
 460 enum command_control_type
 461 {
 462   simple_control,
 463   break_control,
 464   continue_control,
 465   while_control,
 466   if_control,
 467   invalid_control
 468 };
 469
 470 /* Structure for saved commands lines
 471    (for breakpoints, defined commands, etc).  */
 472
 473 struct command_line
 474 {
 475   struct command_line *next;
 476   char *line;
 477   enum command_control_type control_type;
 478   int body_count;
 479   struct command_line **body_list;
 480 };
 481
 482 extern struct command_line *read_command_lines PARAMS ((char *, int));
 483
 484 extern void free_command_lines PARAMS ((struct command_line **));
 485
 486 /* String containing the current directory (what getwd would return).  */
 487
 488 extern char *current_directory;
 489
 490 /* Default radixes for input and output.  Only some values supported.  */
 491 extern unsigned input_radix;
 492 extern unsigned output_radix;
 493
 494 /* Possibilities for prettyprint parameters to routines which print
 495    things.  Like enum language, this should be in value.h, but needs
 496    to be here for the same reason.  FIXME:  If we can eliminate this
 497    as an arg to LA_VAL_PRINT, then we can probably move it back to
 498    value.h. */
 499
 500 enum val_prettyprint
 501 {
 502   Val_no_prettyprint = 0,
 503   Val_prettyprint,
 504   /* Use the default setting which the user has specified.  */
 505   Val_pretty_default
 506 };
 507
 508 \f
 509 /* Host machine definition.  This will be a symlink to one of the
 510    xm-*.h files, built by the `configure' script.  */
 511
 512 #include "xm.h"
 513
 514 /* Native machine support.  This will be a symlink to one of the
 515    nm-*.h files, built by the `configure' script.  */
 516
 517 #include "nm.h"
 518
 519 /* Target machine definition.  This will be a symlink to one of the
 520    tm-*.h files, built by the `configure' script.  */
 521
 522 #include "tm.h"
 523
 524 /* If the xm.h file did not define the mode string used to open the
 525    files, assume that binary files are opened the same way as text
 526    files */
 527 #ifndef FOPEN_RB
 528 #include "fopen-same.h"
 529 #endif
 530
 531 /* Microsoft C can't deal with const pointers */
 532
 533 #ifdef _MSC_VER
 534 #define CONST_PTR
 535 #else
 536 #define CONST_PTR const
 537 #endif
 538
 539 /*
 540  * Allow things in gdb to be declared "volatile".  If compiling ANSI, it
 541  * just works.  If compiling with gcc but non-ansi, redefine to __volatile__.
 542  * If non-ansi, non-gcc, then eliminate "volatile" entirely, making those
 543  * objects be read-write rather than read-only.
 544  */
 545
 546 #ifndef volatile
 547 #ifndef __STDC__
 548 # ifdef __GNUC__
 549 #  define volatile __volatile__
 550 # else
 551 #  define volatile /*nothing*/
 552 # endif /* GNUC */
 553 #endif /* STDC */
 554 #endif /* volatile */
 555
 556 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 557    FIXME: Assumes 2's complement arithmetic */
 558
 559 #if !defined (UINT_MAX)
 560 #define UINT_MAX ((unsigned int)(~0))           /* 0xFFFFFFFF for 32-bits */
 561 #endif
 562
 563 #if !defined (INT_MAX)
 564 #define INT_MAX ((int)(UINT_MAX >> 1))          /* 0x7FFFFFFF for 32-bits */
 565 #endif
 566
 567 #if !defined (INT_MIN)
 568 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 569 #endif
 570
 571 #if !defined (ULONG_MAX)
 572 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 573 #endif
 574
 575 #if !defined (LONG_MAX)
 576 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 577 #endif
 578
 579 #ifndef LONGEST
 580
 581 #ifdef BFD64
 582
 583 /* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */
 584
 585 #define LONGEST BFD_HOST_64_BIT
 586 #define ULONGEST BFD_HOST_U_64_BIT
 587
 588 #else /* No BFD64 */
 589
 590 #  ifdef CC_HAS_LONG_LONG
 591 #    define LONGEST long long
 592 #    define ULONGEST unsigned long long
 593 #  else
 594 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
 595    (e.g. i386-windows) so try it.  */
 596 #    ifdef BFD_HOST_64_BIT
 597 #      define LONGEST BFD_HOST_64_BIT
 598 #      define ULONGEST BFD_HOST_U_64_BIT
 599 #    else
 600 #      define LONGEST long
 601 #      define ULONGEST unsigned long
 602 #    endif
 603 #  endif
 604
 605 #endif /* No BFD64 */
 606
 607 #endif /* ! LONGEST */
 608
 609 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 610    arguments to a function, number in a value history, register number, etc.)
 611    where the value must not be larger than can fit in an int.  */
 612
 613 extern int longest_to_int PARAMS ((LONGEST));
 614
 615 /* Assorted functions we can declare, now that const and volatile are
 616    defined.  */
 617
 618 extern char *savestring PARAMS ((const char *, int));
 619
 620 extern char *msavestring PARAMS ((void *, const char *, int));
 621
 622 extern char *strsave PARAMS ((const char *));
 623
 624 extern char *mstrsave PARAMS ((void *, const char *));
 625
 626 #ifdef _MSC_VER /* FIXME; was long, but this causes compile errors in msvc if already defined */
 627 extern PTR xmmalloc PARAMS ((PTR, size_t));
 628
 629 extern PTR xmrealloc PARAMS ((PTR, PTR, size_t));
 630 #else
 631 extern PTR xmmalloc PARAMS ((PTR, long));
 632
 633 extern PTR xmrealloc PARAMS ((PTR, PTR, long));
 634 #endif
 635
 636 extern int parse_escape PARAMS ((char **));
 637
 638 /* compat - handle old targets that just define REGISTER_NAMES */
 639 #ifndef REGISTER_NAME
 640 extern char *gdb_register_names[];
 641 #define REGISTER_NAME(i) gdb_register_names[i]
 642 #endif
 643
 644 /* Message to be printed before the error message, when an error occurs.  */
 645
 646 extern char *error_pre_print;
 647
 648 /* Message to be printed before the error message, when an error occurs.  */
 649
 650 extern char *quit_pre_print;
 651
 652 /* Message to be printed before the warning message, when a warning occurs.  */
 653
 654 extern char *warning_pre_print;
 655
 656 extern NORETURN void error PARAMS((const char *, ...)) ATTR_NORETURN;
 657
 658 extern void error_begin PARAMS ((void));
 659
 660 extern NORETURN void fatal PARAMS((char *, ...)) ATTR_NORETURN;
 661
 662 extern NORETURN void nomem PARAMS ((long)) ATTR_NORETURN;
 663
 664 /* Reasons for calling return_to_top_level.  */
 665 enum return_reason {
 666   /* User interrupt.  */
 667   RETURN_QUIT,
 668
 669   /* Any other error.  */
 670   RETURN_ERROR
 671 };
 672
 673 #define RETURN_MASK_QUIT (1 << (int)RETURN_QUIT)
 674 #define RETURN_MASK_ERROR (1 << (int)RETURN_ERROR)
 675 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
 676 typedef int return_mask;
 677
 678 extern NORETURN void
 679 return_to_top_level PARAMS ((enum return_reason)) ATTR_NORETURN;
 680
 681 extern int
 682 catch_errors PARAMS ((int (*) (char *), void *, char *, return_mask));
 683
 684 extern void warning_begin PARAMS ((void));
 685
 686 extern void warning PARAMS ((const char *, ...))
 687      ATTR_FORMAT(printf, 1, 2);
 688
 689 /* Global functions from other, non-gdb GNU thingies.
 690    Libiberty thingies are no longer declared here.  We include libiberty.h
 691    above, instead.  */
 692
 693 #ifndef GETENV_PROVIDED
 694 extern char *getenv PARAMS ((const char *));
 695 #endif
 696
 697 /* From other system libraries */
 698
 699 #ifdef HAVE_STDDEF_H
 700 #include <stddef.h>
 701 #endif
 702
 703 #ifdef HAVE_STDLIB_H
 704 #if defined(_MSC_VER) && !defined(__cplusplus)
 705 /* msvc defines these in stdlib.h for c code */
 706 #undef min
 707 #undef max
 708 #endif
 709 #include <stdlib.h>
 710 #endif
 711 #ifndef min
 712 #define min(a, b) ((a) < (b) ? (a) : (b))
 713 #endif
 714 #ifndef max
 715 #define max(a, b) ((a) > (b) ? (a) : (b))
 716 #endif
 717
 718
 719 /* We take the address of fclose later, but some stdio's forget
 720    to declare this.  We can't always declare it since there's
 721    no way to declare the parameters without upsetting some compiler
 722    somewhere. */
 723
 724 #ifndef FCLOSE_PROVIDED
 725 extern int fclose PARAMS ((FILE *));
 726 #endif
 727
 728 #ifndef atof
 729 extern double atof PARAMS ((const char *));     /* X3.159-1989  4.10.1.1 */
 730 #endif
 731
 732 #ifndef MALLOC_INCOMPATIBLE
 733
 734 #ifdef NEED_DECLARATION_MALLOC
 735 extern PTR malloc ();
 736 #endif
 737
 738 #ifdef NEED_DECLARATION_REALLOC
 739 extern PTR realloc ();
 740 #endif
 741
 742 #ifdef NEED_DECLARATION_FREE
 743 extern void free ();
 744 #endif
 745
 746 #endif /* MALLOC_INCOMPATIBLE */
 747
 748 /* Various possibilities for alloca.  */
 749 #ifndef alloca
 750 # ifdef __GNUC__
 751 #  define alloca __builtin_alloca
 752 # else /* Not GNU C */
 753 #  ifdef HAVE_ALLOCA_H
 754 #   include <alloca.h>
 755 #  else
 756 #   ifdef _AIX
 757  #pragma alloca
 758 #   else
 759
 760 /* We need to be careful not to declare this in a way which conflicts with
 761    bison.  Bison never declares it as char *, but under various circumstances
 762    (like __hpux) we need to use void *.  */
 763 #    if defined (__STDC__) || defined (__hpux)
 764    extern void *alloca ();
 765 #    else /* Don't use void *.  */
 766    extern char *alloca ();
 767 #    endif /* Don't use void *.  */
 768 #   endif /* Not _AIX */
 769 #  endif /* Not HAVE_ALLOCA_H */
 770 # endif /* Not GNU C */
 771 #endif /* alloca not defined */
 772
 773 /* HOST_BYTE_ORDER must be defined to one of these.  */
 774
 775 #ifdef HAVE_ENDIAN_H
 776 #include <endian.h>
 777 #endif
 778
 779 #if !defined (BIG_ENDIAN)
 780 #define BIG_ENDIAN 4321
 781 #endif
 782
 783 #if !defined (LITTLE_ENDIAN)
 784 #define LITTLE_ENDIAN 1234
 785 #endif
 786
 787 /* Dynamic target-system-dependent parameters for GDB. */
 788
 789 #include "gdbarch.h"
 790
 791 /* Static target-system-dependent parameters for GDB. */
 792
 793 /* Number of bits in a char or unsigned char for the target machine.
 794    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
 795 #if !defined (TARGET_CHAR_BIT)
 796 #define TARGET_CHAR_BIT 8
 797 #endif
 798
 799 /* Number of bits in a short or unsigned short for the target machine. */
 800 #if !defined (TARGET_SHORT_BIT)
 801 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
 802 #endif
 803
 804 /* Number of bits in an int or unsigned int for the target machine. */
 805 #if !defined (TARGET_INT_BIT)
 806 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
 807 #endif
 808
 809 /* Number of bits in a long or unsigned long for the target machine. */
 810 #if !defined (TARGET_LONG_BIT)
 811 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
 812 #endif
 813
 814 /* Number of bits in a long long or unsigned long long for the target machine. */
 815 #if !defined (TARGET_LONG_LONG_BIT)
 816 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
 817 #endif
 818
 819 /* Number of bits in a float for the target machine. */
 820 #if !defined (TARGET_FLOAT_BIT)
 821 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
 822 #endif
 823
 824 /* Number of bits in a double for the target machine. */
 825 #if !defined (TARGET_DOUBLE_BIT)
 826 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
 827 #endif
 828
 829 /* Number of bits in a long double for the target machine.  */
 830 #if !defined (TARGET_LONG_DOUBLE_BIT)
 831 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
 832 #endif
 833
 834 /* Number of bits in a pointer for the target machine */
 835 #if !defined (TARGET_PTR_BIT)
 836 #define TARGET_PTR_BIT TARGET_INT_BIT
 837 #endif
 838
 839 /* If we picked up a copy of CHAR_BIT from a configuration file
 840    (which may get it by including <limits.h>) then use it to set
 841    the number of bits in a host char.  If not, use the same size
 842    as the target. */
 843
 844 #if defined (CHAR_BIT)
 845 #define HOST_CHAR_BIT CHAR_BIT
 846 #else
 847 #define HOST_CHAR_BIT TARGET_CHAR_BIT
 848 #endif
 849
 850 /* The bit byte-order has to do just with numbering of bits in
 851    debugging symbols and such.  Conceptually, it's quite separate
 852    from byte/word byte order.  */
 853
 854 #if !defined (BITS_BIG_ENDIAN)
 855 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
 856 #endif
 857
 858 /* In findvar.c.  */
 859
 860 extern LONGEST extract_signed_integer PARAMS ((void *, int));
 861
 862 extern ULONGEST extract_unsigned_integer PARAMS ((void *, int));
 863
 864 extern int extract_long_unsigned_integer PARAMS ((void *, int, LONGEST *));
 865
 866 extern CORE_ADDR extract_address PARAMS ((void *, int));
 867
 868 extern void store_signed_integer PARAMS ((void *, int, LONGEST));
 869
 870 extern void store_unsigned_integer PARAMS ((void *, int, ULONGEST));
 871
 872 extern void store_address PARAMS ((void *, int, CORE_ADDR));
 873
 874 /* Setup definitions for host and target floating point formats.  We need to
 875    consider the format for `float', `double', and `long double' for both target
 876    and host.  We need to do this so that we know what kind of conversions need
 877    to be done when converting target numbers to and from the hosts DOUBLEST
 878    data type.  */
 879
 880 /* This is used to indicate that we don't know the format of the floating point
 881    number.  Typically, this is useful for native ports, where the actual format
 882    is irrelevant, since no conversions will be taking place.  */
 883
 884 extern const struct floatformat floatformat_unknown;
 885
 886 #if HOST_BYTE_ORDER == BIG_ENDIAN
 887 #  ifndef HOST_FLOAT_FORMAT
 888 #    define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
 889 #  endif
 890 #  ifndef HOST_DOUBLE_FORMAT
 891 #    define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
 892 #  endif
 893 #else                           /* LITTLE_ENDIAN */
 894 #  ifndef HOST_FLOAT_FORMAT
 895 #    define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
 896 #  endif
 897 #  ifndef HOST_DOUBLE_FORMAT
 898 #    define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
 899 #  endif
 900 #endif
 901
 902 #ifndef HOST_LONG_DOUBLE_FORMAT
 903 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
 904 #endif
 905
 906 #ifndef TARGET_FLOAT_FORMAT
 907 #define TARGET_FLOAT_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
 908                              ? &floatformat_ieee_single_big \
 909                              : &floatformat_ieee_single_little)
 910 #endif
 911 #ifndef TARGET_DOUBLE_FORMAT
 912 #define TARGET_DOUBLE_FORMAT (TARGET_BYTE_ORDER == BIG_ENDIAN \
 913                               ? &floatformat_ieee_double_big \
 914                               : &floatformat_ieee_double_little)
 915 #endif
 916
 917 #ifndef TARGET_LONG_DOUBLE_FORMAT
 918 #  define TARGET_LONG_DOUBLE_FORMAT &floatformat_unknown
 919 #endif
 920
 921 /* Use `long double' if the host compiler supports it.  (Note that this is not
 922    necessarily any longer than `double'.  On SunOS/gcc, it's the same as
 923    double.)  This is necessary because GDB internally converts all floating
 924    point values to the widest type supported by the host.
 925
 926    There are problems however, when the target `long double' is longer than the
 927    host's `long double'.  In general, we'll probably reduce the precision of
 928    any such values and print a warning.  */
 929
 930 #ifdef HAVE_LONG_DOUBLE
 931 typedef long double DOUBLEST;
 932 #else
 933 typedef double DOUBLEST;
 934 #endif
 935
 936 extern void floatformat_to_doublest PARAMS ((const struct floatformat *,
 937                                              char *, DOUBLEST *));
 938 extern void floatformat_from_doublest PARAMS ((const struct floatformat *,
 939                                                DOUBLEST *, char *));
 940 extern DOUBLEST extract_floating PARAMS ((void *, int));
 941
 942 extern void store_floating PARAMS ((void *, int, DOUBLEST));
 943 \f
 944 /* On some machines there are bits in addresses which are not really
 945    part of the address, but are used by the kernel, the hardware, etc.
 946    for special purposes.  ADDR_BITS_REMOVE takes out any such bits
 947    so we get a "real" address such as one would find in a symbol
 948    table.  This is used only for addresses of instructions, and even then
 949    I'm not sure it's used in all contexts.  It exists to deal with there
 950    being a few stray bits in the PC which would mislead us, not as some sort
 951    of generic thing to handle alignment or segmentation (it's possible it
 952    should be in TARGET_READ_PC instead).  */
 953 #if !defined (ADDR_BITS_REMOVE)
 954 #define ADDR_BITS_REMOVE(addr) (addr)
 955 #endif /* No ADDR_BITS_REMOVE.  */
 956
 957 /* From valops.c */
 958
 959 extern CORE_ADDR push_bytes PARAMS ((CORE_ADDR, char *, int));
 960
 961 extern CORE_ADDR push_word PARAMS ((CORE_ADDR, ULONGEST));
 962
 963 /* Some parts of gdb might be considered optional, in the sense that they
 964    are not essential for being able to build a working, usable debugger
 965    for a specific environment.  For example, the maintenance commands
 966    are there for the benefit of gdb maintainers.  As another example,
 967    some environments really don't need gdb's that are able to read N
 968    different object file formats.  In order to make it possible (but
 969    not necessarily recommended) to build "stripped down" versions of
 970    gdb, the following defines control selective compilation of those
 971    parts of gdb which can be safely left out when necessary.  Note that
 972    the default is to include everything. */
 973
 974 #ifndef MAINTENANCE_CMDS
 975 #define MAINTENANCE_CMDS 1
 976 #endif
 977
 978 #ifdef MAINTENANCE_CMDS
 979 extern int watchdog;
 980 #endif
 981
 982 /* Hooks for alternate command interfaces.  */
 983
 984 #ifdef __STDC__
 985 struct target_waitstatus;
 986 struct cmd_list_element;
 987 #endif
 988
 989 extern void (*init_ui_hook) PARAMS ((char *argv0));
 990 extern void (*command_loop_hook) PARAMS ((void));
 991 extern void (*fputs_unfiltered_hook) PARAMS ((const char *linebuffer,
 992                                               FILE *stream));
 993 extern void (*print_frame_info_listing_hook) PARAMS ((struct symtab *s,
 994                                                       int line, int stopline,
 995                                                       int noerror));
 996 extern int  (*query_hook) PARAMS ((const char *, va_list));
 997 extern void (*warning_hook) PARAMS ((const char *, va_list));
 998 extern void (*flush_hook) PARAMS ((FILE *stream));
 999 extern void (*create_breakpoint_hook) PARAMS ((struct breakpoint *b));
1000 extern void (*delete_breakpoint_hook) PARAMS ((struct breakpoint *bpt));
1001 extern void (*modify_breakpoint_hook) PARAMS ((struct breakpoint *bpt));
1002 extern void (*target_output_hook) PARAMS ((char *));
1003 extern void (*interactive_hook) PARAMS ((void));
1004 extern void (*registers_changed_hook) PARAMS ((void));
1005 extern void (*readline_begin_hook) PARAMS ((char *, ...));
1006 extern char * (*readline_hook) PARAMS ((char *));
1007 extern void (*readline_end_hook) PARAMS ((void));
1008 extern void (*pc_changed_hook) PARAMS ((void));
1009 extern void (*context_hook) PARAMS ((int));
1010 extern int (*target_wait_hook) PARAMS ((int pid,
1011                                         struct target_waitstatus *status));
1012
1013 extern void (*call_command_hook) PARAMS ((struct cmd_list_element *c,
1014                                           char *cmd, int from_tty));
1015
1016 extern NORETURN void (*error_hook) PARAMS ((void)) ATTR_NORETURN;
1017
1018
1019
1020 /* Inhibit window interface if non-zero. */
1021
1022 extern int use_windows;
1023
1024 /* Symbolic definitions of filename-related things.  */
1025 /* FIXME, this doesn't work very well if host and executable
1026    filesystems conventions are different.  */
1027
1028 #ifndef DIRNAME_SEPARATOR
1029 #define DIRNAME_SEPARATOR ':'
1030 #endif
1031
1032 #ifndef SLASH_P
1033 #if defined(__GO32__)||defined(_WIN32)
1034 #define SLASH_P(X) ((X)=='\\')
1035 #else
1036 #define SLASH_P(X) ((X)=='/')
1037 #endif
1038 #endif
1039
1040 #ifndef SLASH_CHAR
1041 #if defined(__GO32__)||defined(_WIN32)
1042 #define SLASH_CHAR '\\'
1043 #else
1044 #define SLASH_CHAR '/'
1045 #endif
1046 #endif
1047
1048 #ifndef SLASH_STRING
1049 #if defined(__GO32__)||defined(_WIN32)
1050 #define SLASH_STRING "\\"
1051 #else
1052 #define SLASH_STRING "/"
1053 #endif
1054 #endif
1055
1056 #ifndef ROOTED_P
1057 #define ROOTED_P(X) (SLASH_P((X)[0]))
1058 #endif
1059
1060 /* On some systems, PIDGET is defined to extract the inferior pid from
1061    an internal pid that has the thread id and pid in seperate bit
1062    fields.  If not defined, then just use the entire internal pid as
1063    the actual pid. */
1064
1065 #ifndef PIDGET
1066 #define PIDGET(pid) (pid)
1067 #endif
1068
1069 /* If under Cygwin, provide backwards compatibility with older
1070    Cygwin compilers that don't define the current cpp define. */
1071 #ifdef __CYGWIN32__
1072 #ifndef __CYGWIN__
1073 #define __CYGWIN__
1074 #endif
1075 #endif
1076
1077 #endif /* #ifndef DEFS_H */