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