gdb/defs.h

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