gdb/defs.h

   1 /* *INDENT-OFF* */ /* ATTR_FORMAT confuses indent, avoid running it for now */
   2 /* Basic, host-specific, and target-specific definitions for GDB.
   3    Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
   4    1997, 1998, 1999, 2000, 2001
   5    Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 59 Temple Place - Suite 330,
  22    Boston, MA 02111-1307, USA.  */
  23
  24 #ifndef DEFS_H
  25 #define DEFS_H
  26
  27 #include "config.h"             /* Generated by configure */
  28 #include <stdio.h>
  29 #include <errno.h>              /* System call error return status */
  30 #include <limits.h>
  31
  32 #ifdef HAVE_STDDEF_H
  33 #include <stddef.h>
  34 #else
  35 #include <sys/types.h>          /* for size_t */
  36 #endif
  37
  38 #ifdef HAVE_UNISTD_H
  39 #include <unistd.h>
  40 #endif
  41
  42 /* Just in case they're not defined in stdio.h. */
  43
  44 #ifndef SEEK_SET
  45 #define SEEK_SET 0
  46 #endif
  47 #ifndef SEEK_CUR
  48 #define SEEK_CUR 1
  49 #endif
  50
  51 /* First include ansidecl.h so we can use the various macro definitions
  52    here and in all subsequent file inclusions.  */
  53
  54 #include "ansidecl.h"
  55
  56 #include <stdarg.h>             /* for va_list */
  57
  58 #include "libiberty.h"
  59
  60 #include "progress.h"
  61
  62 #ifdef USE_MMALLOC
  63 #include "mmalloc.h"
  64 #endif
  65
  66 /* For BFD64 and bfd_vma.  */
  67 #include "bfd.h"
  68
  69
  70 /* The target is partially multi-arched.  Both "tm.h" and the
  71    multi-arch vector provide definitions.  "tm.h" normally overrides
  72    the multi-arch vector (but there are a few exceptions).  */
  73
  74 #define GDB_MULTI_ARCH_PARTIAL 1
  75
  76 /* The target is partially multi-arched. Both the multi-arch vector
  77    and "tm.h" provide definitions. "tm.h" cannot override a definition
  78    provided by the multi-arch vector.  It is detected as a compilation
  79    error.
  80
  81    This setting is only useful during a multi-arch conversion. */
  82
  83 #define GDB_MULTI_ARCH_TM 2
  84
  85 /* The target is pure multi-arch.  The MULTI-ARCH vector provides all
  86    definitions.  "tm.h" is linked to an empty file. */
  87
  88 #define GDB_MULTI_ARCH_PURE 3
  89
  90
  91
  92 /* An address in the program being debugged.  Host byte order.  Rather
  93    than duplicate all the logic in BFD which figures out what type
  94    this is (long, long long, etc.) and whether it needs to be 64
  95    bits (the host/target interactions are subtle), we just use
  96    bfd_vma.  */
  97
  98 typedef bfd_vma CORE_ADDR;
  99
 100 /* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */
 101
 102 #ifndef LONGEST
 103
 104 #ifdef BFD64
 105
 106 #define LONGEST BFD_HOST_64_BIT
 107 #define ULONGEST BFD_HOST_U_64_BIT
 108
 109 #else /* No BFD64 */
 110
 111 #ifdef CC_HAS_LONG_LONG
 112 #define LONGEST long long
 113 #define ULONGEST unsigned long long
 114 #else
 115 #ifdef BFD_HOST_64_BIT
 116 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
 117    (e.g. i386-windows) so try it.  */
 118 #define LONGEST BFD_HOST_64_BIT
 119 #define ULONGEST BFD_HOST_U_64_BIT
 120 #else
 121 #define LONGEST long
 122 #define ULONGEST unsigned long
 123 #endif
 124 #endif
 125
 126 #endif /* No BFD64 */
 127
 128 #endif /* ! LONGEST */
 129
 130 #ifndef min
 131 #define min(a, b) ((a) < (b) ? (a) : (b))
 132 #endif
 133 #ifndef max
 134 #define max(a, b) ((a) > (b) ? (a) : (b))
 135 #endif
 136
 137 /* Macros to do string compares.
 138
 139    NOTE: cagney/2000-03-14:
 140
 141    While old code can continue to refer to these macros, new code is
 142    probably better off using strcmp() directly vis: ``strcmp() == 0''
 143    and ``strcmp() != 0''.
 144
 145    This is because modern compilers can directly inline strcmp()
 146    making the original justification for these macros - avoid function
 147    call overhead by pre-testing the first characters
 148    (``*X==*Y?...:0'') - redundant.
 149
 150    ``Even if [...] testing the first character does have a modest
 151    performance improvement, I'd rather that whenever a performance
 152    issue is found that we spend the effort on algorithmic
 153    optimizations than micro-optimizing.'' J.T. */
 154
 155 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
 156 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
 157
 158 /* The character GNU C++ uses to build identifiers that must be unique from
 159    the program's identifiers (such as $this and $$vptr).  */
 160 #define CPLUS_MARKER '$'        /* May be overridden to '.' for SysV */
 161
 162 /* Check if a character is one of the commonly used C++ marker characters.  */
 163 extern int is_cplus_marker (int);
 164
 165 /* use tui interface if non-zero */
 166 extern int tui_version;
 167
 168 /* enable xdb commands if set */
 169 extern int xdb_commands;
 170
 171 /* enable dbx commands if set */
 172 extern int dbx_commands;
 173
 174 extern int quit_flag;
 175 extern int immediate_quit;
 176 extern int sevenbit_strings;
 177
 178 extern void quit (void);
 179
 180 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
 181    benefits of having a ``QUIT'' macro rather than a function are
 182    marginal.  If the overhead of a QUIT function call is proving
 183    significant then its calling frequency should probably be reduced
 184    [kingdon].  A profile analyzing the current situtation is
 185    needed. */
 186
 187 #ifdef QUIT
 188 /* do twice to force compiler warning */
 189 #define QUIT_FIXME "FIXME"
 190 #define QUIT_FIXME "ignoring redefinition of QUIT"
 191 #else
 192 #define QUIT { \
 193   if (quit_flag) quit (); \
 194   if (interactive_hook) interactive_hook (); \
 195   PROGRESS (1); \
 196 }
 197 #endif
 198
 199 /* Languages represented in the symbol table and elsewhere.
 200    This should probably be in language.h, but since enum's can't
 201    be forward declared to satisfy opaque references before their
 202    actual definition, needs to be here. */
 203
 204 enum language
 205   {
 206     language_unknown,           /* Language not known */
 207     language_auto,              /* Placeholder for automatic setting */
 208     language_c,                 /* C */
 209     language_cplus,             /* C++ */
 210     language_java,              /* Java */
 211     language_chill,             /* Chill */
 212     language_fortran,           /* Fortran */
 213     language_m2,                /* Modula-2 */
 214     language_asm,               /* Assembly language */
 215     language_scm,               /* Scheme / Guile */
 216     language_pascal             /* Pascal */
 217   };
 218
 219 enum precision_type
 220   {
 221     single_precision,
 222     double_precision,
 223     unspecified_precision
 224   };
 225
 226 /* The numbering of these signals is chosen to match traditional unix
 227    signals (insofar as various unices use the same numbers, anyway).
 228    It is also the numbering of the GDB remote protocol.  Other remote
 229    protocols, if they use a different numbering, should make sure to
 230    translate appropriately.
 231
 232    Since these numbers have actually made it out into other software
 233    (stubs, etc.), you mustn't disturb the assigned numbering.  If you
 234    need to add new signals here, add them to the end of the explicitly
 235    numbered signals.
 236
 237    This is based strongly on Unix/POSIX signals for several reasons:
 238    (1) This set of signals represents a widely-accepted attempt to
 239    represent events of this sort in a portable fashion, (2) we want a
 240    signal to make it from wait to child_wait to the user intact, (3) many
 241    remote protocols use a similar encoding.  However, it is
 242    recognized that this set of signals has limitations (such as not
 243    distinguishing between various kinds of SIGSEGV, or not
 244    distinguishing hitting a breakpoint from finishing a single step).
 245    So in the future we may get around this either by adding additional
 246    signals for breakpoint, single-step, etc., or by adding signal
 247    codes; the latter seems more in the spirit of what BSD, System V,
 248    etc. are doing to address these issues.  */
 249
 250 /* For an explanation of what each signal means, see
 251    target_signal_to_string.  */
 252
 253 enum target_signal
 254   {
 255     /* Used some places (e.g. stop_signal) to record the concept that
 256        there is no signal.  */
 257     TARGET_SIGNAL_0 = 0,
 258     TARGET_SIGNAL_FIRST = 0,
 259     TARGET_SIGNAL_HUP = 1,
 260     TARGET_SIGNAL_INT = 2,
 261     TARGET_SIGNAL_QUIT = 3,
 262     TARGET_SIGNAL_ILL = 4,
 263     TARGET_SIGNAL_TRAP = 5,
 264     TARGET_SIGNAL_ABRT = 6,
 265     TARGET_SIGNAL_EMT = 7,
 266     TARGET_SIGNAL_FPE = 8,
 267     TARGET_SIGNAL_KILL = 9,
 268     TARGET_SIGNAL_BUS = 10,
 269     TARGET_SIGNAL_SEGV = 11,
 270     TARGET_SIGNAL_SYS = 12,
 271     TARGET_SIGNAL_PIPE = 13,
 272     TARGET_SIGNAL_ALRM = 14,
 273     TARGET_SIGNAL_TERM = 15,
 274     TARGET_SIGNAL_URG = 16,
 275     TARGET_SIGNAL_STOP = 17,
 276     TARGET_SIGNAL_TSTP = 18,
 277     TARGET_SIGNAL_CONT = 19,
 278     TARGET_SIGNAL_CHLD = 20,
 279     TARGET_SIGNAL_TTIN = 21,
 280     TARGET_SIGNAL_TTOU = 22,
 281     TARGET_SIGNAL_IO = 23,
 282     TARGET_SIGNAL_XCPU = 24,
 283     TARGET_SIGNAL_XFSZ = 25,
 284     TARGET_SIGNAL_VTALRM = 26,
 285     TARGET_SIGNAL_PROF = 27,
 286     TARGET_SIGNAL_WINCH = 28,
 287     TARGET_SIGNAL_LOST = 29,
 288     TARGET_SIGNAL_USR1 = 30,
 289     TARGET_SIGNAL_USR2 = 31,
 290     TARGET_SIGNAL_PWR = 32,
 291     /* Similar to SIGIO.  Perhaps they should have the same number.  */
 292     TARGET_SIGNAL_POLL = 33,
 293     TARGET_SIGNAL_WIND = 34,
 294     TARGET_SIGNAL_PHONE = 35,
 295     TARGET_SIGNAL_WAITING = 36,
 296     TARGET_SIGNAL_LWP = 37,
 297     TARGET_SIGNAL_DANGER = 38,
 298     TARGET_SIGNAL_GRANT = 39,
 299     TARGET_SIGNAL_RETRACT = 40,
 300     TARGET_SIGNAL_MSG = 41,
 301     TARGET_SIGNAL_SOUND = 42,
 302     TARGET_SIGNAL_SAK = 43,
 303     TARGET_SIGNAL_PRIO = 44,
 304     TARGET_SIGNAL_REALTIME_33 = 45,
 305     TARGET_SIGNAL_REALTIME_34 = 46,
 306     TARGET_SIGNAL_REALTIME_35 = 47,
 307     TARGET_SIGNAL_REALTIME_36 = 48,
 308     TARGET_SIGNAL_REALTIME_37 = 49,
 309     TARGET_SIGNAL_REALTIME_38 = 50,
 310     TARGET_SIGNAL_REALTIME_39 = 51,
 311     TARGET_SIGNAL_REALTIME_40 = 52,
 312     TARGET_SIGNAL_REALTIME_41 = 53,
 313     TARGET_SIGNAL_REALTIME_42 = 54,
 314     TARGET_SIGNAL_REALTIME_43 = 55,
 315     TARGET_SIGNAL_REALTIME_44 = 56,
 316     TARGET_SIGNAL_REALTIME_45 = 57,
 317     TARGET_SIGNAL_REALTIME_46 = 58,
 318     TARGET_SIGNAL_REALTIME_47 = 59,
 319     TARGET_SIGNAL_REALTIME_48 = 60,
 320     TARGET_SIGNAL_REALTIME_49 = 61,
 321     TARGET_SIGNAL_REALTIME_50 = 62,
 322     TARGET_SIGNAL_REALTIME_51 = 63,
 323     TARGET_SIGNAL_REALTIME_52 = 64,
 324     TARGET_SIGNAL_REALTIME_53 = 65,
 325     TARGET_SIGNAL_REALTIME_54 = 66,
 326     TARGET_SIGNAL_REALTIME_55 = 67,
 327     TARGET_SIGNAL_REALTIME_56 = 68,
 328     TARGET_SIGNAL_REALTIME_57 = 69,
 329     TARGET_SIGNAL_REALTIME_58 = 70,
 330     TARGET_SIGNAL_REALTIME_59 = 71,
 331     TARGET_SIGNAL_REALTIME_60 = 72,
 332     TARGET_SIGNAL_REALTIME_61 = 73,
 333     TARGET_SIGNAL_REALTIME_62 = 74,
 334     TARGET_SIGNAL_REALTIME_63 = 75,
 335
 336     /* Used internally by Solaris threads.  See signal(5) on Solaris.  */
 337     TARGET_SIGNAL_CANCEL = 76,
 338
 339     /* Yes, this pains me, too.  But LynxOS didn't have SIG32, and now
 340        Linux does, and we can't disturb the numbering, since it's part
 341        of the remote protocol.  Note that in some GDB's
 342        TARGET_SIGNAL_REALTIME_32 is number 76.  */
 343     TARGET_SIGNAL_REALTIME_32,
 344     /* Yet another pain, IRIX 6 has SIG64. */
 345     TARGET_SIGNAL_REALTIME_64,
 346     /* Yet another pain, Linux/MIPS might go up to 128. */
 347     TARGET_SIGNAL_REALTIME_65,
 348     TARGET_SIGNAL_REALTIME_66,
 349     TARGET_SIGNAL_REALTIME_67,
 350     TARGET_SIGNAL_REALTIME_68,
 351     TARGET_SIGNAL_REALTIME_69,
 352     TARGET_SIGNAL_REALTIME_70,
 353     TARGET_SIGNAL_REALTIME_71,
 354     TARGET_SIGNAL_REALTIME_72,
 355     TARGET_SIGNAL_REALTIME_73,
 356     TARGET_SIGNAL_REALTIME_74,
 357     TARGET_SIGNAL_REALTIME_75,
 358     TARGET_SIGNAL_REALTIME_76,
 359     TARGET_SIGNAL_REALTIME_77,
 360     TARGET_SIGNAL_REALTIME_78,
 361     TARGET_SIGNAL_REALTIME_79,
 362     TARGET_SIGNAL_REALTIME_80,
 363     TARGET_SIGNAL_REALTIME_81,
 364     TARGET_SIGNAL_REALTIME_82,
 365     TARGET_SIGNAL_REALTIME_83,
 366     TARGET_SIGNAL_REALTIME_84,
 367     TARGET_SIGNAL_REALTIME_85,
 368     TARGET_SIGNAL_REALTIME_86,
 369     TARGET_SIGNAL_REALTIME_87,
 370     TARGET_SIGNAL_REALTIME_88,
 371     TARGET_SIGNAL_REALTIME_89,
 372     TARGET_SIGNAL_REALTIME_90,
 373     TARGET_SIGNAL_REALTIME_91,
 374     TARGET_SIGNAL_REALTIME_92,
 375     TARGET_SIGNAL_REALTIME_93,
 376     TARGET_SIGNAL_REALTIME_94,
 377     TARGET_SIGNAL_REALTIME_95,
 378     TARGET_SIGNAL_REALTIME_96,
 379     TARGET_SIGNAL_REALTIME_97,
 380     TARGET_SIGNAL_REALTIME_98,
 381     TARGET_SIGNAL_REALTIME_99,
 382     TARGET_SIGNAL_REALTIME_100,
 383     TARGET_SIGNAL_REALTIME_101,
 384     TARGET_SIGNAL_REALTIME_102,
 385     TARGET_SIGNAL_REALTIME_103,
 386     TARGET_SIGNAL_REALTIME_104,
 387     TARGET_SIGNAL_REALTIME_105,
 388     TARGET_SIGNAL_REALTIME_106,
 389     TARGET_SIGNAL_REALTIME_107,
 390     TARGET_SIGNAL_REALTIME_108,
 391     TARGET_SIGNAL_REALTIME_109,
 392     TARGET_SIGNAL_REALTIME_110,
 393     TARGET_SIGNAL_REALTIME_111,
 394     TARGET_SIGNAL_REALTIME_112,
 395     TARGET_SIGNAL_REALTIME_113,
 396     TARGET_SIGNAL_REALTIME_114,
 397     TARGET_SIGNAL_REALTIME_115,
 398     TARGET_SIGNAL_REALTIME_116,
 399     TARGET_SIGNAL_REALTIME_117,
 400     TARGET_SIGNAL_REALTIME_118,
 401     TARGET_SIGNAL_REALTIME_119,
 402     TARGET_SIGNAL_REALTIME_120,
 403     TARGET_SIGNAL_REALTIME_121,
 404     TARGET_SIGNAL_REALTIME_122,
 405     TARGET_SIGNAL_REALTIME_123,
 406     TARGET_SIGNAL_REALTIME_124,
 407     TARGET_SIGNAL_REALTIME_125,
 408     TARGET_SIGNAL_REALTIME_126,
 409     TARGET_SIGNAL_REALTIME_127,
 410
 411 #if defined(MACH) || defined(__MACH__)
 412     /* Mach exceptions */
 413     TARGET_EXC_BAD_ACCESS,
 414     TARGET_EXC_BAD_INSTRUCTION,
 415     TARGET_EXC_ARITHMETIC,
 416     TARGET_EXC_EMULATION,
 417     TARGET_EXC_SOFTWARE,
 418     TARGET_EXC_BREAKPOINT,
 419 #endif
 420     TARGET_SIGNAL_INFO,
 421
 422     /* Some signal we don't know about.  */
 423     TARGET_SIGNAL_UNKNOWN,
 424
 425     /* Use whatever signal we use when one is not specifically specified
 426        (for passing to proceed and so on).  */
 427     TARGET_SIGNAL_DEFAULT,
 428
 429     /* Last and unused enum value, for sizing arrays, etc.  */
 430     TARGET_SIGNAL_LAST
 431   };
 432
 433 /* the cleanup list records things that have to be undone
 434    if an error happens (descriptors to be closed, memory to be freed, etc.)
 435    Each link in the chain records a function to call and an
 436    argument to give it.
 437
 438    Use make_cleanup to add an element to the cleanup chain.
 439    Use do_cleanups to do all cleanup actions back to a given
 440    point in the chain.  Use discard_cleanups to remove cleanups
 441    from the chain back to a given point, not doing them.  */
 442
 443 struct cleanup
 444   {
 445     struct cleanup *next;
 446     void (*function) (PTR);
 447     PTR arg;
 448   };
 449
 450
 451 /* The ability to declare that a function never returns is useful, but
 452    not really required to compile GDB successfully, so the NORETURN and
 453    ATTR_NORETURN macros normally expand into nothing.  */
 454
 455 /* If compiling with older versions of GCC, a function may be declared
 456    "volatile" to indicate that it does not return.  */
 457
 458 #ifndef NORETURN
 459 #if defined(__GNUC__) \
 460      && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
 461 #define NORETURN volatile
 462 #else
 463 #define NORETURN                /* nothing */
 464 #endif
 465 #endif
 466
 467 /* GCC 2.5 and later versions define a function attribute "noreturn",
 468    which is the preferred way to declare that a function never returns.
 469    However GCC 2.7 appears to be the first version in which this fully
 470    works everywhere we use it. */
 471
 472 #ifndef ATTR_NORETURN
 473 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
 474 #define ATTR_NORETURN __attribute__ ((noreturn))
 475 #else
 476 #define ATTR_NORETURN           /* nothing */
 477 #endif
 478 #endif
 479
 480 #ifndef ATTR_FORMAT
 481 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
 482 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
 483 #else
 484 #define ATTR_FORMAT(type, x, y) /* nothing */
 485 #endif
 486 #endif
 487
 488 /* Needed for various prototypes */
 489
 490 struct symtab;
 491 struct breakpoint;
 492
 493 /* From blockframe.c */
 494
 495 extern int inside_entry_func (CORE_ADDR);
 496
 497 extern int inside_entry_file (CORE_ADDR addr);
 498
 499 extern int inside_main_func (CORE_ADDR pc);
 500
 501 /* From ch-lang.c, for the moment. (FIXME) */
 502
 503 extern char *chill_demangle (const char *);
 504
 505 /* From utils.c */
 506
 507 extern void initialize_utils (void);
 508
 509 extern void notice_quit (void);
 510
 511 extern int strcmp_iw (const char *, const char *);
 512
 513 extern int subset_compare (char *, char *);
 514
 515 extern char *safe_strerror (int);
 516
 517 extern void init_malloc (void *);
 518
 519 extern void request_quit (int);
 520
 521 extern void do_cleanups (struct cleanup *);
 522 extern void do_final_cleanups (struct cleanup *);
 523 extern void do_my_cleanups (struct cleanup **, struct cleanup *);
 524 extern void do_run_cleanups (struct cleanup *);
 525 extern void do_exec_cleanups (struct cleanup *);
 526 extern void do_exec_error_cleanups (struct cleanup *);
 527
 528 extern void discard_cleanups (struct cleanup *);
 529 extern void discard_final_cleanups (struct cleanup *);
 530 extern void discard_exec_error_cleanups (struct cleanup *);
 531 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
 532
 533 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
 534    make_cleanup function declarations below. Do not use this typedef
 535    as a cast when passing functions into the make_cleanup() code.
 536    Instead either use a bounce function or add a wrapper function.
 537    Calling a f(char*) function with f(void*) is non-portable. */
 538 typedef void (make_cleanup_ftype) (void *);
 539
 540 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
 541
 542 extern struct cleanup *make_cleanup_freeargv (char **);
 543
 544 struct ui_file;
 545 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
 546
 547 extern struct cleanup *make_cleanup_close (int fd);
 548
 549 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
 550
 551 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
 552
 553 extern struct cleanup *make_my_cleanup (struct cleanup **,
 554                                         make_cleanup_ftype *, void *);
 555
 556 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
 557
 558 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
 559 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
 560
 561 extern struct cleanup *save_cleanups (void);
 562 extern struct cleanup *save_final_cleanups (void);
 563 extern struct cleanup *save_my_cleanups (struct cleanup **);
 564
 565 extern void restore_cleanups (struct cleanup *);
 566 extern void restore_final_cleanups (struct cleanup *);
 567 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 568
 569 extern void free_current_contents (void *);
 570
 571 extern void null_cleanup (void *);
 572
 573 extern int myread (int, char *, int);
 574
 575 extern int query (char *, ...) ATTR_FORMAT (printf, 1, 2);
 576
 577 extern void init_page_info (void);
 578
 579 extern CORE_ADDR host_pointer_to_address (void *ptr);
 580 extern void *address_to_host_pointer (CORE_ADDR addr);
 581
 582 /* From demangle.c */
 583
 584 extern void set_demangling_style (char *);
 585
 586 /* From tm.h */
 587
 588 struct type;
 589 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
 590 extern use_struct_convention_fn generic_use_struct_convention;
 591
 592 typedef unsigned char *(breakpoint_from_pc_fn) (CORE_ADDR * pcptr, int *lenptr);
 593 \f
 594 /* Annotation stuff.  */
 595
 596 extern int annotation_level;    /* in stack.c */
 597 \f
 598 extern void begin_line (void);
 599
 600 extern void wrap_here (char *);
 601
 602 extern void reinitialize_more_filter (void);
 603
 604 /* Normal results */
 605 extern struct ui_file *gdb_stdout;
 606 /* Serious error notifications */
 607 extern struct ui_file *gdb_stderr;
 608 /* Log/debug/trace messages that should bypass normal stdout/stderr
 609    filtering.  For momement, always call this stream using
 610    *_unfiltered. In the very near future that restriction shall be
 611    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 612 extern struct ui_file *gdb_stdlog;
 613 /* Target output that should bypass normal stdout/stderr filtering.
 614    For momement, always call this stream using *_unfiltered. In the
 615    very near future that restriction shall be removed - either call
 616    shall be unfiltered. (cagney 1999-07-02). */
 617 extern struct ui_file *gdb_stdtarg;
 618
 619 #if defined(TUI)
 620 #include "tui.h"
 621 #endif
 622
 623 #include "ui-file.h"
 624
 625 /* More generic printf like operations.  Filtered versions may return
 626    non-locally on error.  */
 627
 628 extern void fputs_filtered (const char *, struct ui_file *);
 629
 630 extern void fputs_unfiltered (const char *, struct ui_file *);
 631
 632 extern int fputc_filtered (int c, struct ui_file *);
 633
 634 extern int fputc_unfiltered (int c, struct ui_file *);
 635
 636 extern int putchar_filtered (int c);
 637
 638 extern int putchar_unfiltered (int c);
 639
 640 extern void puts_filtered (const char *);
 641
 642 extern void puts_unfiltered (const char *);
 643
 644 extern void puts_debug (char *prefix, char *string, char *suffix);
 645
 646 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 647
 648 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 649
 650 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 651
 652 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 653
 654 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 655
 656 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 657
 658 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 659
 660 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 661
 662 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 663
 664 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 665
 666 extern void print_spaces (int, struct ui_file *);
 667
 668 extern void print_spaces_filtered (int, struct ui_file *);
 669
 670 extern char *n_spaces (int);
 671
 672 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 673
 674 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 675
 676 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 677
 678 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 679 extern void gdb_print_host_address (void *addr, struct ui_file *stream);
 680
 681 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 682    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
 683    for ``%*''. */
 684 extern int strlen_paddr (void);
 685 extern char *paddr (CORE_ADDR addr);
 686 extern char *paddr_nz (CORE_ADDR addr);
 687 extern char *paddr_u (CORE_ADDR addr);
 688 extern char *paddr_d (LONGEST addr);
 689
 690 extern char *phex (ULONGEST l, int sizeof_l);
 691 extern char *phex_nz (ULONGEST l, int sizeof_l);
 692
 693 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 694                                      enum language, int);
 695
 696 extern NORETURN void perror_with_name (char *) ATTR_NORETURN;
 697
 698 extern void print_sys_errmsg (char *, int);
 699
 700 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 701    "const char *" in unistd.h, so we can't declare the argument
 702    as "char *".  */
 703
 704 extern char *re_comp (const char *);
 705
 706 /* From symfile.c */
 707
 708 extern void symbol_file_command (char *, int);
 709
 710 /* Remote targets may wish to use this as their load function.  */
 711 extern void generic_load (char *name, int from_tty);
 712
 713 /* Summarise a download */
 714 extern void print_transfer_performance (struct ui_file *stream,
 715                                         unsigned long data_count,
 716                                         unsigned long write_count,
 717                                         unsigned long time_count);
 718
 719 /* From top.c */
 720
 721 typedef void initialize_file_ftype (void);
 722
 723 extern char *skip_quoted (char *);
 724
 725 extern char *gdb_readline (char *);
 726
 727 extern char *command_line_input (char *, int, char *);
 728
 729 extern void print_prompt (void);
 730
 731 extern int input_from_terminal_p (void);
 732
 733 extern int info_verbose;
 734
 735 /* From printcmd.c */
 736
 737 extern void set_next_address (CORE_ADDR);
 738
 739 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
 740                                     char *);
 741
 742 extern int build_address_symbolic (CORE_ADDR addr,
 743                                    int do_demangle,
 744                                    char **name,
 745                                    int *offset,
 746                                    char **filename,
 747                                    int *line,
 748                                    int *unmapped);
 749
 750 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
 751
 752 extern void print_address (CORE_ADDR, struct ui_file *);
 753
 754 /* From source.c */
 755
 756 extern int openp (const char *, int, const char *, int, int, char **);
 757
 758 extern int source_full_path_of (char *, char **);
 759
 760 extern void mod_path (char *, char **);
 761
 762 extern void directory_command (char *, int);
 763
 764 extern void init_source_path (void);
 765
 766 extern char *symtab_to_filename (struct symtab *);
 767
 768 /* From exec.c */
 769
 770 extern void exec_set_section_offsets (bfd_signed_vma text_off,
 771                                       bfd_signed_vma data_off,
 772                                       bfd_signed_vma bss_off);
 773
 774 /* From findvar.c */
 775
 776 extern int read_relative_register_raw_bytes (int, char *);
 777
 778 /* Possible lvalue types.  Like enum language, this should be in
 779    value.h, but needs to be here for the same reason. */
 780
 781 enum lval_type
 782   {
 783     /* Not an lval. */
 784     not_lval,
 785     /* In memory.  Could be a saved register.  */
 786     lval_memory,
 787     /* In a register.  */
 788     lval_register,
 789     /* In a gdb internal variable.  */
 790     lval_internalvar,
 791     /* Part of a gdb internal variable (structure field).  */
 792     lval_internalvar_component,
 793     /* In a register series in a frame not the current one, which may have been
 794        partially saved or saved in different places (otherwise would be
 795        lval_register or lval_memory).  */
 796     lval_reg_frame_relative
 797   };
 798
 799 struct frame_info;
 800
 801 /* From readline (but not in any readline .h files).  */
 802
 803 extern char *tilde_expand (char *);
 804
 805 /* Control types for commands */
 806
 807 enum misc_command_type
 808   {
 809     ok_command,
 810     end_command,
 811     else_command,
 812     nop_command
 813   };
 814
 815 enum command_control_type
 816   {
 817     simple_control,
 818     break_control,
 819     continue_control,
 820     while_control,
 821     if_control,
 822     invalid_control
 823   };
 824
 825 /* Structure for saved commands lines
 826    (for breakpoints, defined commands, etc).  */
 827
 828 struct command_line
 829   {
 830     struct command_line *next;
 831     char *line;
 832     enum command_control_type control_type;
 833     int body_count;
 834     struct command_line **body_list;
 835   };
 836
 837 extern struct command_line *read_command_lines (char *, int);
 838
 839 extern void free_command_lines (struct command_line **);
 840
 841 /* To continue the execution commands when running gdb asynchronously.
 842    A continuation structure contains a pointer to a function to be called
 843    to finish the command, once the target has stopped. Such mechanism is
 844    used bt the finish and until commands, and in the remote protocol
 845    when opening an extended-remote connection. */
 846
 847 struct continuation_arg
 848   {
 849     struct continuation_arg *next;
 850     union continuation_data {
 851       void *pointer;
 852       int   integer;
 853       long  longint;
 854     } data;
 855   };
 856
 857 struct continuation
 858   {
 859     void (*continuation_hook) (struct continuation_arg *);
 860     struct continuation_arg *arg_list;
 861     struct continuation *next;
 862   };
 863
 864 /* In infrun.c. */
 865 extern struct continuation *cmd_continuation;
 866 /* Used only by the step_1 function. */
 867 extern struct continuation *intermediate_continuation;
 868
 869 /* From utils.c */
 870 extern void add_continuation (void (*)(struct continuation_arg *),
 871                               struct continuation_arg *);
 872 extern void do_all_continuations (void);
 873 extern void discard_all_continuations (void);
 874
 875 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
 876                               struct continuation_arg *);
 877 extern void do_all_intermediate_continuations (void);
 878 extern void discard_all_intermediate_continuations (void);
 879
 880 /* String containing the current directory (what getwd would return).  */
 881
 882 extern char *current_directory;
 883
 884 /* Default radixes for input and output.  Only some values supported.  */
 885 extern unsigned input_radix;
 886 extern unsigned output_radix;
 887
 888 /* Possibilities for prettyprint parameters to routines which print
 889    things.  Like enum language, this should be in value.h, but needs
 890    to be here for the same reason.  FIXME:  If we can eliminate this
 891    as an arg to LA_VAL_PRINT, then we can probably move it back to
 892    value.h. */
 893
 894 enum val_prettyprint
 895   {
 896     Val_no_prettyprint = 0,
 897     Val_prettyprint,
 898     /* Use the default setting which the user has specified.  */
 899     Val_pretty_default
 900   };
 901
 902 /* The ptid struct is a collection of the various "ids" necessary
 903    for identifying the inferior.  This consists of the process id
 904    (pid), thread id (tid), and other fields necessary for uniquely
 905    identifying the inferior process/thread being debugged.  When
 906    manipulating ptids, the constructors, accessors, and predicate
 907    declared in inferior.h should be used.  These are as follows:
 908
 909       ptid_build        - Make a new ptid from a pid, lwp, and tid.
 910       pid_to_ptid       - Make a new ptid from just a pid.
 911       ptid_get_pid      - Fetch the pid component of a ptid.
 912       ptid_get_lwp      - Fetch the lwp component of a ptid.
 913       ptid_get_tid      - Fetch the tid component of a ptid.
 914       ptid_equal        - Test to see if two ptids are equal.
 915
 916    Please do NOT access the struct ptid members directly (except, of
 917    course, in the implementation of the above ptid manipulation
 918    functions).  */
 919
 920 struct ptid
 921   {
 922     /* Process id */
 923     int pid;
 924
 925     /* Lightweight process id */
 926     long lwp;
 927
 928     /* Thread id */
 929     long tid;
 930   };
 931
 932 typedef struct ptid ptid_t;
 933
 934 \f
 935
 936 /* Optional host machine definition.  Pure autoconf targets will not
 937    need a "xm.h" file.  This will be a symlink to one of the xm-*.h
 938    files, built by the `configure' script.  */
 939
 940 #ifdef GDB_XM_FILE
 941 #include "xm.h"
 942 #endif
 943
 944 /* Optional native machine support.  Non-native (and possibly pure
 945    multi-arch) targets do not need a "nm.h" file.  This will be a
 946    symlink to one of the nm-*.h files, built by the `configure'
 947    script.  */
 948
 949 #ifdef GDB_NM_FILE
 950 #include "nm.h"
 951 #endif
 952
 953 /* Optional target machine definition.  Pure multi-arch configurations
 954    do not need a "tm.h" file.  This will be a symlink to one of the
 955    tm-*.h files, built by the `configure' script.  */
 956
 957 #ifdef GDB_TM_FILE
 958 #include "tm.h"
 959 #endif
 960
 961 /* GDB_MULTI_ARCH is normally set by configure.in using information
 962    from configure.tgt or the config/%/%.mt Makefile fragment.  Since
 963    some targets have defined it in their "tm.h" file, delay providing
 964    a default definition until after "tm.h" has been included.. */
 965
 966 #ifndef GDB_MULTI_ARCH
 967 #define GDB_MULTI_ARCH 0
 968 #endif
 969
 970
 971 /* If the xm.h file did not define the mode string used to open the
 972    files, assume that binary files are opened the same way as text
 973    files */
 974 #ifndef FOPEN_RB
 975 #include "fopen-same.h"
 976 #endif
 977
 978 #define CONST_PTR const
 979
 980 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 981    FIXME: Assumes 2's complement arithmetic */
 982
 983 #if !defined (UINT_MAX)
 984 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 985 #endif
 986
 987 #if !defined (INT_MAX)
 988 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 989 #endif
 990
 991 #if !defined (INT_MIN)
 992 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 993 #endif
 994
 995 #if !defined (ULONG_MAX)
 996 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 997 #endif
 998
 999 #if !defined (LONG_MAX)
1000 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
1001 #endif
1002
1003 #if !defined (ULONGEST_MAX)
1004 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
1005 #endif
1006
1007 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
1008 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
1009 #endif
1010
1011 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
1012    arguments to a function, number in a value history, register number, etc.)
1013    where the value must not be larger than can fit in an int.  */
1014
1015 extern int longest_to_int (LONGEST);
1016
1017 /* Assorted functions we can declare, now that const and volatile are
1018    defined.  */
1019
1020 extern char *savestring (const char *, size_t);
1021
1022 extern char *msavestring (void *, const char *, size_t);
1023
1024 extern char *mstrsave (void *, const char *);
1025
1026 #if !defined (USE_MMALLOC)
1027 /* NOTE: cagney/2000-03-04: The mmalloc functions need to use PTR
1028    rather than void* so that they are consistent with the delcaration
1029    in ../mmalloc/mmalloc.h. */
1030 extern PTR mcalloc (PTR, size_t, size_t);
1031 extern PTR mmalloc (PTR, size_t);
1032 extern PTR mrealloc (PTR, PTR, size_t);
1033 extern void mfree (PTR, PTR);
1034 #endif
1035
1036 /* Robust versions of same.  Throw an internal error when no memory,
1037    guard against stray NULL arguments. */
1038 extern void *xmmalloc (void *md, size_t size);
1039 extern void *xmrealloc (void *md, void *ptr, size_t size);
1040 extern void *xmcalloc (void *md, size_t number, size_t size);
1041 extern void xmfree (void *md, void *ptr);
1042
1043 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
1044    "libiberty.h". */
1045 extern void xfree (void *);
1046
1047 /* Like asprintf/vasprintf but get an internal_error if the call
1048    fails. */
1049 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
1050 extern void xvasprintf (char **ret, const char *format, va_list ap);
1051
1052 extern int parse_escape (char **);
1053
1054 /* Message to be printed before the error message, when an error occurs.  */
1055
1056 extern char *error_pre_print;
1057
1058 /* Message to be printed before the error message, when an error occurs.  */
1059
1060 extern char *quit_pre_print;
1061
1062 /* Message to be printed before the warning message, when a warning occurs.  */
1063
1064 extern char *warning_pre_print;
1065
1066 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
1067
1068 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN;
1069
1070 /* DEPRECATED: Use error(), verror() or error_stream(). */
1071 extern NORETURN void error_begin (void);
1072
1073 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
1074
1075 /* Returns a freshly allocate buffer containing the last error
1076    message.  */
1077 extern char *error_last_message (void);
1078
1079 extern NORETURN void internal_verror (const char *file, int line,
1080                                       const char *, va_list ap) ATTR_NORETURN;
1081
1082 extern NORETURN void internal_error (const char *file, int line,
1083                                      const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
1084
1085 extern NORETURN void nomem (long) ATTR_NORETURN;
1086
1087 /* Reasons for calling return_to_top_level.  Note: enum value 0 is
1088    reserved for internal use as the return value from an initial
1089    setjmp().  */
1090
1091 enum return_reason
1092   {
1093     /* User interrupt.  */
1094     RETURN_QUIT = 1,
1095     /* Any other error.  */
1096     RETURN_ERROR
1097   };
1098
1099 #define ALL_CLEANUPS    ((struct cleanup *)0)
1100
1101 #define RETURN_MASK(reason)     (1 << (int)(reason))
1102 #define RETURN_MASK_QUIT        RETURN_MASK (RETURN_QUIT)
1103 #define RETURN_MASK_ERROR       RETURN_MASK (RETURN_ERROR)
1104 #define RETURN_MASK_ALL         (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
1105 typedef int return_mask;
1106
1107 extern NORETURN void return_to_top_level (enum return_reason) ATTR_NORETURN;
1108
1109 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
1110    otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
1111    probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
1112    value. It's unfortunate that, catch_errors() does not return an
1113    indication of the exact exception that it caught - quit_flag might
1114    help. */
1115
1116 typedef int (catch_errors_ftype) (PTR);
1117 extern int catch_errors (catch_errors_ftype *, PTR, char *, return_mask);
1118
1119 /* Template to catch_errors() that wraps calls to command
1120    functions. */
1121
1122 typedef void (catch_command_errors_ftype) (char *, int);
1123 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
1124
1125 extern void warning_begin (void);
1126
1127 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
1128
1129 /* Global functions from other, non-gdb GNU thingies.
1130    Libiberty thingies are no longer declared here.  We include libiberty.h
1131    above, instead.  */
1132
1133 #ifndef GETENV_PROVIDED
1134 extern char *getenv (const char *);
1135 #endif
1136
1137 /* From other system libraries */
1138
1139 #ifdef HAVE_STDDEF_H
1140 #include <stddef.h>
1141 #endif
1142
1143 #ifdef HAVE_STDLIB_H
1144 #include <stdlib.h>
1145 #endif
1146 #ifndef min
1147 #define min(a, b) ((a) < (b) ? (a) : (b))
1148 #endif
1149 #ifndef max
1150 #define max(a, b) ((a) > (b) ? (a) : (b))
1151 #endif
1152
1153
1154 /* We take the address of fclose later, but some stdio's forget
1155    to declare this.  We can't always declare it since there's
1156    no way to declare the parameters without upsetting some compiler
1157    somewhere. */
1158
1159 #ifndef FCLOSE_PROVIDED
1160 extern int fclose (FILE *);
1161 #endif
1162
1163 #ifndef atof
1164 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
1165 #endif
1166
1167 /* Various possibilities for alloca.  */
1168 #ifndef alloca
1169 #ifdef __GNUC__
1170 #define alloca __builtin_alloca
1171 #else /* Not GNU C */
1172 #ifdef HAVE_ALLOCA_H
1173 #include <alloca.h>
1174 #else
1175 #ifdef _AIX
1176 #pragma alloca
1177 #else
1178
1179 /* We need to be careful not to declare this in a way which conflicts with
1180    bison.  Bison never declares it as char *, but under various circumstances
1181    (like __hpux) we need to use void *.  */
1182 extern void *alloca ();
1183 #endif /* Not _AIX */
1184 #endif /* Not HAVE_ALLOCA_H */
1185 #endif /* Not GNU C */
1186 #endif /* alloca not defined */
1187
1188 /* HOST_BYTE_ORDER must be defined to one of these.  */
1189
1190 #ifdef HAVE_ENDIAN_H
1191 #include <endian.h>
1192 #endif
1193
1194 #if !defined (BIG_ENDIAN)
1195 #define BIG_ENDIAN 4321
1196 #endif
1197
1198 #if !defined (LITTLE_ENDIAN)
1199 #define LITTLE_ENDIAN 1234
1200 #endif
1201
1202 /* Dynamic target-system-dependent parameters for GDB. */
1203 #include "gdbarch.h"
1204 #if (GDB_MULTI_ARCH == 0)
1205 /* Multi-arch targets _should_ be including "arch-utils.h" directly
1206    into their *-tdep.c file.  This is a prop to help old non-
1207    multi-arch targets to continue to compile. */
1208 #include "arch-utils.h"
1209 #endif
1210
1211 /* Static target-system-dependent parameters for GDB. */
1212
1213 /* Number of bits in a char or unsigned char for the target machine.
1214    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
1215 #if !defined (TARGET_CHAR_BIT)
1216 #define TARGET_CHAR_BIT 8
1217 #endif
1218
1219 /* If we picked up a copy of CHAR_BIT from a configuration file
1220    (which may get it by including <limits.h>) then use it to set
1221    the number of bits in a host char.  If not, use the same size
1222    as the target. */
1223
1224 #if defined (CHAR_BIT)
1225 #define HOST_CHAR_BIT CHAR_BIT
1226 #else
1227 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1228 #endif
1229
1230 /* The bit byte-order has to do just with numbering of bits in
1231    debugging symbols and such.  Conceptually, it's quite separate
1232    from byte/word byte order.  */
1233
1234 #if !defined (BITS_BIG_ENDIAN)
1235 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BIG_ENDIAN)
1236 #endif
1237
1238 /* In findvar.c.  */
1239
1240 extern LONGEST extract_signed_integer (void *, int);
1241
1242 extern ULONGEST extract_unsigned_integer (void *, int);
1243
1244 extern int extract_long_unsigned_integer (void *, int, LONGEST *);
1245
1246 extern CORE_ADDR extract_address (void *, int);
1247
1248 extern CORE_ADDR extract_typed_address (void *buf, struct type *type);
1249
1250 extern void store_signed_integer (void *, int, LONGEST);
1251
1252 extern void store_unsigned_integer (void *, int, ULONGEST);
1253
1254 extern void store_address (void *, int, LONGEST);
1255
1256 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1257
1258 /* Setup definitions for host and target floating point formats.  We need to
1259    consider the format for `float', `double', and `long double' for both target
1260    and host.  We need to do this so that we know what kind of conversions need
1261    to be done when converting target numbers to and from the hosts DOUBLEST
1262    data type.  */
1263
1264 /* This is used to indicate that we don't know the format of the floating point
1265    number.  Typically, this is useful for native ports, where the actual format
1266    is irrelevant, since no conversions will be taking place.  */
1267
1268 extern const struct floatformat floatformat_unknown;
1269
1270 #if HOST_BYTE_ORDER == BIG_ENDIAN
1271 #ifndef HOST_FLOAT_FORMAT
1272 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_big
1273 #endif
1274 #ifndef HOST_DOUBLE_FORMAT
1275 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_big
1276 #endif
1277 #else /* LITTLE_ENDIAN */
1278 #ifndef HOST_FLOAT_FORMAT
1279 #define HOST_FLOAT_FORMAT &floatformat_ieee_single_little
1280 #endif
1281 #ifndef HOST_DOUBLE_FORMAT
1282 #define HOST_DOUBLE_FORMAT &floatformat_ieee_double_little
1283 #endif
1284 #endif
1285
1286 #ifndef HOST_LONG_DOUBLE_FORMAT
1287 #define HOST_LONG_DOUBLE_FORMAT &floatformat_unknown
1288 #endif
1289
1290 /* Use `long double' if the host compiler supports it.  (Note that this is not
1291    necessarily any longer than `double'.  On SunOS/gcc, it's the same as
1292    double.)  This is necessary because GDB internally converts all floating
1293    point values to the widest type supported by the host.
1294
1295    There are problems however, when the target `long double' is longer than the
1296    host's `long double'.  In general, we'll probably reduce the precision of
1297    any such values and print a warning.  */
1298
1299 #ifdef HAVE_LONG_DOUBLE
1300 typedef long double DOUBLEST;
1301 #else
1302 typedef double DOUBLEST;
1303 #endif
1304
1305 extern void floatformat_to_doublest (const struct floatformat *,
1306                                      char *, DOUBLEST *);
1307 extern void floatformat_from_doublest (const struct floatformat *,
1308                                        DOUBLEST *, char *);
1309
1310 extern int floatformat_is_negative (const struct floatformat *, char *);
1311 extern int floatformat_is_nan (const struct floatformat *, char *);
1312 extern char *floatformat_mantissa (const struct floatformat *, char *);
1313
1314 extern DOUBLEST extract_floating (void *, int);
1315 extern void store_floating (void *, int, DOUBLEST);
1316 \f
1317 /* From valops.c */
1318
1319 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1320
1321 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1322
1323 extern int watchdog;
1324
1325 /* Hooks for alternate command interfaces.  */
1326
1327 #ifdef UI_OUT
1328 /* The name of the interpreter if specified on the command line. */
1329 extern char *interpreter_p;
1330 #endif
1331
1332 /* If a given interpreter matches INTERPRETER_P then it should update
1333    command_loop_hook and init_ui_hook with the per-interpreter
1334    implementation. */
1335 /* FIXME: command_loop_hook and init_ui_hook should be moved here. */
1336
1337 struct target_waitstatus;
1338 struct cmd_list_element;
1339
1340 /* Should the asynchronous variant of the interpreter (using the
1341    event-loop) be enabled? */
1342 extern int event_loop_p;
1343
1344 extern void (*init_ui_hook) (char *argv0);
1345 extern void (*command_loop_hook) (void);
1346 extern void (*show_load_progress) (const char *section,
1347                                    unsigned long section_sent,
1348                                    unsigned long section_size,
1349                                    unsigned long total_sent,
1350                                    unsigned long total_size);
1351 extern void (*print_frame_info_listing_hook) (struct symtab * s,
1352                                               int line, int stopline,
1353                                               int noerror);
1354 extern struct frame_info *parse_frame_specification (char *frame_exp);
1355 extern int (*query_hook) (const char *, va_list);
1356 extern void (*warning_hook) (const char *, va_list);
1357 extern void (*flush_hook) (struct ui_file * stream);
1358 extern void (*create_breakpoint_hook) (struct breakpoint * b);
1359 extern void (*delete_breakpoint_hook) (struct breakpoint * bpt);
1360 extern void (*modify_breakpoint_hook) (struct breakpoint * bpt);
1361 extern void (*interactive_hook) (void);
1362 extern void (*registers_changed_hook) (void);
1363 extern void (*readline_begin_hook) (char *,...);
1364 extern char *(*readline_hook) (char *);
1365 extern void (*readline_end_hook) (void);
1366 extern void (*register_changed_hook) (int regno);
1367 extern void (*memory_changed_hook) (CORE_ADDR addr, int len);
1368 extern void (*context_hook) (int);
1369 extern ptid_t (*target_wait_hook) (ptid_t ptid,
1370                                          struct target_waitstatus * status);
1371
1372 extern void (*attach_hook) (void);
1373 extern void (*detach_hook) (void);
1374 extern void (*call_command_hook) (struct cmd_list_element * c,
1375                                   char *cmd, int from_tty);
1376
1377 extern void (*set_hook) (struct cmd_list_element * c);
1378
1379 extern NORETURN void (*error_hook) (void) ATTR_NORETURN;
1380
1381 extern void (*error_begin_hook) (void);
1382
1383 extern int (*ui_load_progress_hook) (const char *section, unsigned long num);
1384
1385
1386 /* Inhibit window interface if non-zero. */
1387
1388 extern int use_windows;
1389
1390 /* Symbolic definitions of filename-related things.  */
1391 /* FIXME, this doesn't work very well if host and executable
1392    filesystems conventions are different.  */
1393
1394 #ifndef DIRNAME_SEPARATOR
1395 #define DIRNAME_SEPARATOR ':'
1396 #endif
1397
1398 #ifndef SLASH_STRING
1399 #ifdef _WIN32
1400 #define SLASH_STRING "\\"
1401 #else
1402 #define SLASH_STRING "/"
1403 #endif
1404 #endif
1405
1406 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1407    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1408    in the code actually refer to a lightweight process id, i.e,
1409    something that can be considered a process id in its own right for
1410    certain purposes.  */
1411
1412 #ifndef PIDGET
1413 #define PIDGET(PTID) (ptid_get_pid (PTID))
1414 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1415 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1416 #endif
1417
1418 /* Define well known filenos if the system does not define them.  */
1419 #ifndef STDIN_FILENO
1420 #define STDIN_FILENO   0
1421 #endif
1422 #ifndef STDOUT_FILENO
1423 #define STDOUT_FILENO  1
1424 #endif
1425 #ifndef STDERR_FILENO
1426 #define STDERR_FILENO  2
1427 #endif
1428
1429 /* If this definition isn't overridden by the header files, assume
1430    that isatty and fileno exist on this system.  */
1431 #ifndef ISATTY
1432 #define ISATTY(FP)      (isatty (fileno (FP)))
1433 #endif
1434
1435 \f
1436 /* FIXME: cagney/1999-12-13: The following will be moved to gdb.h /
1437    libgdb.h or gdblib.h. */
1438
1439 /* Return-code (RC) from a gdb library call.  (The abreviation RC is
1440    taken from the sim/common directory.) */
1441
1442 enum gdb_rc {
1443   /* The operation failed.  The failure message can be fetched by
1444      calling ``char *error_last_message(void)''. The value is
1445      determined by the catch_errors() interface. */
1446   /* NOTE: Since ``defs.h:catch_errors()'' does not return an error /
1447      internal / quit indication it is not possible to return that
1448      here. */
1449   GDB_RC_FAIL = 0,
1450   /* No error occured but nothing happened. Due to the catch_errors()
1451      interface, this must be non-zero. */
1452   GDB_RC_NONE = 1,
1453   /* The operation was successful. Due to the catch_errors()
1454      interface, this must be non-zero. */
1455   GDB_RC_OK = 2
1456 };
1457
1458
1459 /* Print the specified breakpoint on GDB_STDOUT. (Eventually this
1460    function will ``print'' the object on ``output''). */
1461 enum gdb_rc gdb_breakpoint_query (/* struct {ui,gdb}_out *output, */ int bnum);
1462
1463 /* Create a breakpoint at ADDRESS (a GDB source and line). */
1464 enum gdb_rc gdb_breakpoint (char *address, char *condition,
1465                             int hardwareflag, int tempflag,
1466                             int thread, int ignore_count);
1467 enum gdb_rc gdb_thread_select (/* output object */ char *tidstr);
1468
1469 #ifdef UI_OUT
1470 /* Print a list of known thread ids. */
1471 enum gdb_rc gdb_list_thread_ids (/* output object */);
1472
1473 /* Switch thread and print notification. */
1474 #endif
1475
1476 #endif /* #ifndef DEFS_H */