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, 2002, 2003, 2004, 2005
   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
  29 #include <stdio.h>
  30 #include <errno.h>              /* System call error return status.  */
  31 #include <limits.h>
  32
  33 #ifdef HAVE_STDDEF_H
  34 #include <stddef.h>
  35 #else
  36 #include <sys/types.h>          /* For size_t.  */
  37 #endif
  38
  39 #ifdef HAVE_UNISTD_H
  40 #include <unistd.h>
  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 #include "gdb_locale.h"
  49
  50 /* For ``enum target_signal''.  */
  51 #include "gdb/signals.h"
  52
  53 /* Just in case they're not defined in stdio.h.  */
  54
  55 #ifndef SEEK_SET
  56 #define SEEK_SET 0
  57 #endif
  58 #ifndef SEEK_CUR
  59 #define SEEK_CUR 1
  60 #endif
  61
  62 #include <stdarg.h>             /* For va_list.  */
  63
  64 #include "libiberty.h"
  65
  66 /* Rather than duplicate all the logic in BFD for figuring out what
  67    types to use (which can be pretty complicated), symply define them
  68    in terms of the corresponding type from BFD.  */
  69
  70 #include "bfd.h"
  71
  72 /* A byte from the program being debugged.  */
  73 typedef bfd_byte gdb_byte;
  74
  75 /* An address in the program being debugged.  Host byte order.  */
  76 typedef bfd_vma CORE_ADDR;
  77
  78 /* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */
  79
  80 #ifndef LONGEST
  81
  82 #ifdef BFD64
  83
  84 #define LONGEST BFD_HOST_64_BIT
  85 #define ULONGEST BFD_HOST_U_64_BIT
  86
  87 #else /* No BFD64 */
  88
  89 #ifdef CC_HAS_LONG_LONG
  90 #define LONGEST long long
  91 #define ULONGEST unsigned long long
  92 #else
  93 #ifdef BFD_HOST_64_BIT
  94 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
  95    (e.g. i386-windows) so try it.  */
  96 #define LONGEST BFD_HOST_64_BIT
  97 #define ULONGEST BFD_HOST_U_64_BIT
  98 #else
  99 #define LONGEST long
 100 #define ULONGEST unsigned long
 101 #endif
 102 #endif
 103
 104 #endif /* No BFD64 */
 105
 106 #endif /* ! LONGEST */
 107
 108 #ifndef min
 109 #define min(a, b) ((a) < (b) ? (a) : (b))
 110 #endif
 111 #ifndef max
 112 #define max(a, b) ((a) > (b) ? (a) : (b))
 113 #endif
 114
 115 /* Macros to do string compares.
 116
 117    NOTE: cagney/2000-03-14:
 118
 119    While old code can continue to refer to these macros, new code is
 120    probably better off using strcmp() directly vis: ``strcmp() == 0''
 121    and ``strcmp() != 0''.
 122
 123    This is because modern compilers can directly inline strcmp()
 124    making the original justification for these macros - avoid function
 125    call overhead by pre-testing the first characters
 126    (``*X==*Y?...:0'') - redundant.
 127
 128    ``Even if [...] testing the first character does have a modest
 129    performance improvement, I'd rather that whenever a performance
 130    issue is found that we spend the effort on algorithmic
 131    optimizations than micro-optimizing.'' J.T. */
 132
 133 /* NOTE: cagney/2003-11-23: All instances of STREQ[N] covered by
 134    testing GDB on a stabs system have been replaced by equivalent
 135    str[n]cmp calls.  To avoid the possability of introducing bugs when
 136    making untested changes, the remaining references were deprecated
 137    rather than replaced.  */
 138
 139 /* DISCLAIMER: cagney/2003-11-23: Simplified definition of these
 140    macros so that they just map directly onto strcmp equivalent.  I'm
 141    not responsible for any breakage due to code that relied on the old
 142    underlying implementation.  */
 143
 144 #define DEPRECATED_STREQ(a,b) (strcmp ((a), (b)) == 0)
 145 #define DEPRECATED_STREQN(a,b,c) (strncmp ((a), (b), (c)) == 0)
 146
 147 /* Check if a character is one of the commonly used C++ marker characters.  */
 148 extern int is_cplus_marker (int);
 149
 150 /* enable xdb commands if set */
 151 extern int xdb_commands;
 152
 153 /* enable dbx commands if set */
 154 extern int dbx_commands;
 155
 156 /* System root path, used to find libraries etc.  */
 157 extern char *gdb_sysroot;
 158
 159 extern int quit_flag;
 160 extern int immediate_quit;
 161 extern int sevenbit_strings;
 162
 163 extern void quit (void);
 164
 165 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
 166    benefits of having a ``QUIT'' macro rather than a function are
 167    marginal.  If the overhead of a QUIT function call is proving
 168    significant then its calling frequency should probably be reduced
 169    [kingdon].  A profile analyzing the current situtation is
 170    needed. */
 171
 172 #ifdef QUIT
 173 /* do twice to force compiler warning */
 174 #define QUIT_FIXME "FIXME"
 175 #define QUIT_FIXME "ignoring redefinition of QUIT"
 176 #else
 177 #define QUIT { \
 178   if (quit_flag) quit (); \
 179   if (deprecated_interactive_hook) deprecated_interactive_hook (); \
 180 }
 181 #endif
 182
 183 /* Languages represented in the symbol table and elsewhere.
 184    This should probably be in language.h, but since enum's can't
 185    be forward declared to satisfy opaque references before their
 186    actual definition, needs to be here. */
 187
 188 enum language
 189   {
 190     language_unknown,           /* Language not known */
 191     language_auto,              /* Placeholder for automatic setting */
 192     language_c,                 /* C */
 193     language_cplus,             /* C++ */
 194     language_objc,              /* Objective-C */
 195     language_java,              /* Java */
 196     language_fortran,           /* Fortran */
 197     language_m2,                /* Modula-2 */
 198     language_asm,               /* Assembly language */
 199     language_scm,               /* Scheme / Guile */
 200     language_pascal,            /* Pascal */
 201     language_ada,               /* Ada */
 202     language_minimal,           /* All other languages, minimal support only */
 203     nr_languages
 204   };
 205
 206 enum precision_type
 207   {
 208     single_precision,
 209     double_precision,
 210     unspecified_precision
 211   };
 212
 213 /* A generic, not quite boolean, enumeration.  */
 214 enum auto_boolean
 215 {
 216   AUTO_BOOLEAN_TRUE,
 217   AUTO_BOOLEAN_FALSE,
 218   AUTO_BOOLEAN_AUTO
 219 };
 220
 221 /* Potential ways that a function can return a value of a given type.  */
 222 enum return_value_convention
 223 {
 224   /* Where the return value has been squeezed into one or more
 225      registers.  */
 226   RETURN_VALUE_REGISTER_CONVENTION,
 227   /* Commonly known as the "struct return convention".  The caller
 228      passes an additional hidden first parameter to the caller.  That
 229      parameter contains the address at which the value being returned
 230      should be stored.  While typically, and historically, used for
 231      large structs, this is convention is applied to values of many
 232      different types.  */
 233   RETURN_VALUE_STRUCT_CONVENTION,
 234   /* Like the "struct return convention" above, but where the ABI
 235      guarantees that the called function stores the address at which
 236      the value being returned is stored in a well-defined location,
 237      such as a register or memory slot in the stack frame.  Don't use
 238      this if the ABI doesn't explicitly guarantees this.  */
 239   RETURN_VALUE_ABI_RETURNS_ADDRESS,
 240   /* Like the "struct return convention" above, but where the ABI
 241      guarantees that the address at which the value being returned is
 242      stored will be available in a well-defined location, such as a
 243      register or memory slot in the stack frame.  Don't use this if
 244      the ABI doesn't explicitly guarantees this.  */
 245   RETURN_VALUE_ABI_PRESERVES_ADDRESS,
 246 };
 247
 248 /* the cleanup list records things that have to be undone
 249    if an error happens (descriptors to be closed, memory to be freed, etc.)
 250    Each link in the chain records a function to call and an
 251    argument to give it.
 252
 253    Use make_cleanup to add an element to the cleanup chain.
 254    Use do_cleanups to do all cleanup actions back to a given
 255    point in the chain.  Use discard_cleanups to remove cleanups
 256    from the chain back to a given point, not doing them.  */
 257
 258 struct cleanup
 259   {
 260     struct cleanup *next;
 261     void (*function) (void *);
 262     void *arg;
 263   };
 264
 265
 266 /* The ability to declare that a function never returns is useful, but
 267    not really required to compile GDB successfully, so the NORETURN and
 268    ATTR_NORETURN macros normally expand into nothing.  */
 269
 270 /* If compiling with older versions of GCC, a function may be declared
 271    "volatile" to indicate that it does not return.  */
 272
 273 #ifndef NORETURN
 274 #if defined(__GNUC__) \
 275      && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
 276 #define NORETURN volatile
 277 #else
 278 #define NORETURN                /* nothing */
 279 #endif
 280 #endif
 281
 282 /* GCC 2.5 and later versions define a function attribute "noreturn",
 283    which is the preferred way to declare that a function never returns.
 284    However GCC 2.7 appears to be the first version in which this fully
 285    works everywhere we use it. */
 286
 287 #ifndef ATTR_NORETURN
 288 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
 289 #define ATTR_NORETURN __attribute__ ((noreturn))
 290 #else
 291 #define ATTR_NORETURN           /* nothing */
 292 #endif
 293 #endif
 294
 295 #ifndef ATTR_FORMAT
 296 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
 297 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
 298 #else
 299 #define ATTR_FORMAT(type, x, y) /* nothing */
 300 #endif
 301 #endif
 302
 303 /* Be conservative and use enum bitfields only with GCC.
 304    This is copied from gcc 3.3.1, system.h.  */
 305
 306 #if defined(__GNUC__) && (__GNUC__ >= 2)
 307 #define ENUM_BITFIELD(TYPE) enum TYPE
 308 #else
 309 #define ENUM_BITFIELD(TYPE) unsigned int
 310 #endif
 311
 312 /* Needed for various prototypes */
 313
 314 struct symtab;
 315 struct breakpoint;
 316 struct frame_info;
 317
 318 /* From utils.c */
 319
 320 extern void initialize_utils (void);
 321
 322 extern void notice_quit (void);
 323
 324 extern int strcmp_iw (const char *, const char *);
 325
 326 extern int strcmp_iw_ordered (const char *, const char *);
 327
 328 extern int streq (const char *, const char *);
 329
 330 extern int subset_compare (char *, char *);
 331
 332 extern char *safe_strerror (int);
 333
 334 extern void request_quit (int);
 335
 336 #define ALL_CLEANUPS    ((struct cleanup *)0)
 337
 338 extern void do_cleanups (struct cleanup *);
 339 extern void do_final_cleanups (struct cleanup *);
 340 extern void do_run_cleanups (struct cleanup *);
 341 extern void do_exec_cleanups (struct cleanup *);
 342 extern void do_exec_error_cleanups (struct cleanup *);
 343
 344 extern void discard_cleanups (struct cleanup *);
 345 extern void discard_final_cleanups (struct cleanup *);
 346 extern void discard_exec_error_cleanups (struct cleanup *);
 347 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
 348
 349 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
 350    make_cleanup function declarations below. Do not use this typedef
 351    as a cast when passing functions into the make_cleanup() code.
 352    Instead either use a bounce function or add a wrapper function.
 353    Calling a f(char*) function with f(void*) is non-portable. */
 354 typedef void (make_cleanup_ftype) (void *);
 355
 356 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
 357
 358 extern struct cleanup *make_cleanup_freeargv (char **);
 359
 360 struct ui_file;
 361 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
 362
 363 struct section_addr_info;
 364 extern struct cleanup *(make_cleanup_free_section_addr_info
 365                         (struct section_addr_info *));
 366
 367 extern struct cleanup *make_cleanup_close (int fd);
 368
 369 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
 370
 371 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
 372
 373 extern struct cleanup *make_my_cleanup (struct cleanup **,
 374                                         make_cleanup_ftype *, void *);
 375
 376 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
 377
 378 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
 379 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
 380
 381 extern struct cleanup *save_cleanups (void);
 382 extern struct cleanup *save_final_cleanups (void);
 383 extern struct cleanup *save_my_cleanups (struct cleanup **);
 384
 385 extern void restore_cleanups (struct cleanup *);
 386 extern void restore_final_cleanups (struct cleanup *);
 387 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 388
 389 extern void free_current_contents (void *);
 390
 391 extern void null_cleanup (void *);
 392
 393 extern int myread (int, char *, int);
 394
 395 extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 396 extern int nquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 397 extern int yquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 398
 399 extern void init_page_info (void);
 400
 401 extern char *gdb_realpath (const char *);
 402 extern char *xfullpath (const char *);
 403
 404 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
 405                                           unsigned char *buf, size_t len);
 406
 407 /* From demangle.c */
 408
 409 extern void set_demangling_style (char *);
 410
 411 /* From tm.h */
 412
 413 struct type;
 414 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
 415 extern use_struct_convention_fn generic_use_struct_convention;
 416
 417 \f
 418 /* Annotation stuff.  */
 419
 420 extern int annotation_level;    /* in stack.c */
 421 \f
 422 extern void begin_line (void);
 423
 424 extern void wrap_here (char *);
 425
 426 extern void reinitialize_more_filter (void);
 427
 428 /* Normal results */
 429 extern struct ui_file *gdb_stdout;
 430 /* Input stream */
 431 extern struct ui_file *gdb_stdin;
 432 /* Serious error notifications */
 433 extern struct ui_file *gdb_stderr;
 434 /* Log/debug/trace messages that should bypass normal stdout/stderr
 435    filtering.  For moment, always call this stream using
 436    *_unfiltered. In the very near future that restriction shall be
 437    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 438 extern struct ui_file *gdb_stdlog;
 439 /* Target output that should bypass normal stdout/stderr filtering.
 440    For moment, always call this stream using *_unfiltered. In the
 441    very near future that restriction shall be removed - either call
 442    shall be unfiltered. (cagney 1999-07-02). */
 443 extern struct ui_file *gdb_stdtarg;
 444 extern struct ui_file *gdb_stdtargerr;
 445 extern struct ui_file *gdb_stdtargin;
 446
 447 #include "ui-file.h"
 448
 449 /* More generic printf like operations.  Filtered versions may return
 450    non-locally on error.  */
 451
 452 extern void fputs_filtered (const char *, struct ui_file *);
 453
 454 extern void fputs_unfiltered (const char *, struct ui_file *);
 455
 456 extern int fputc_filtered (int c, struct ui_file *);
 457
 458 extern int fputc_unfiltered (int c, struct ui_file *);
 459
 460 extern int putchar_filtered (int c);
 461
 462 extern int putchar_unfiltered (int c);
 463
 464 extern void puts_filtered (const char *);
 465
 466 extern void puts_unfiltered (const char *);
 467
 468 extern void puts_filtered_tabular (char *string, int width, int right);
 469
 470 extern void puts_debug (char *prefix, char *string, char *suffix);
 471
 472 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 473
 474 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 475
 476 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 477
 478 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 479
 480 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 481
 482 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 483
 484 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 485
 486 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 487
 488 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 489
 490 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 491
 492 extern void print_spaces (int, struct ui_file *);
 493
 494 extern void print_spaces_filtered (int, struct ui_file *);
 495
 496 extern char *n_spaces (int);
 497
 498 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 499
 500 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 501
 502 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 503
 504 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 505 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 506
 507 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 508    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
 509    for ``%*''. */
 510 extern int strlen_paddr (void);
 511 extern char *paddr (CORE_ADDR addr);
 512 extern char *paddr_nz (CORE_ADDR addr);
 513 extern char *paddr_u (CORE_ADDR addr);
 514 extern char *paddr_d (LONGEST addr);
 515
 516 /* Like 0x%lx, replaces deprecated_print_address_numeric.  */
 517 extern const char *paddress (CORE_ADDR addr);
 518
 519 extern char *phex (ULONGEST l, int sizeof_l);
 520 extern char *phex_nz (ULONGEST l, int sizeof_l);
 521 extern char *int_string (LONGEST, int, int, int, int);
 522
 523 /* Like paddr() only print/scan raw CORE_ADDR.  The output from
 524    core_addr_to_string() can be passed direct to
 525    string_to_core_addr().  */
 526 extern const char *core_addr_to_string (const CORE_ADDR addr);
 527 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 528 extern CORE_ADDR string_to_core_addr (const char *my_string);
 529
 530 /* Return a string that contains a number formatted as a hex
 531    string.  */
 532 extern char *hex_string (LONGEST);
 533 extern char *hex_string_custom (LONGEST, int);
 534
 535 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 536                                      enum language, int);
 537
 538 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
 539
 540 extern void print_sys_errmsg (const char *, int);
 541
 542 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 543    "const char *" in unistd.h, so we can't declare the argument
 544    as "char *".  */
 545
 546 extern char *re_comp (const char *);
 547
 548 /* From symfile.c */
 549
 550 extern void symbol_file_command (char *, int);
 551
 552 /* Remote targets may wish to use this as their load function.  */
 553 extern void generic_load (char *name, int from_tty);
 554
 555 /* Summarise a download */
 556 extern void print_transfer_performance (struct ui_file *stream,
 557                                         unsigned long data_count,
 558                                         unsigned long write_count,
 559                                         unsigned long time_count);
 560
 561 /* From top.c */
 562
 563 typedef void initialize_file_ftype (void);
 564
 565 extern char *skip_quoted (char *);
 566
 567 extern char *gdb_readline (char *);
 568
 569 extern char *gdb_readline_wrapper (char *);
 570
 571 extern char *command_line_input (char *, int, char *);
 572
 573 extern void print_prompt (void);
 574
 575 extern int input_from_terminal_p (void);
 576
 577 extern int info_verbose;
 578
 579 /* From printcmd.c */
 580
 581 extern void set_next_address (CORE_ADDR);
 582
 583 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
 584                                     char *);
 585
 586 extern int build_address_symbolic (CORE_ADDR addr,
 587                                    int do_demangle,
 588                                    char **name,
 589                                    int *offset,
 590                                    char **filename,
 591                                    int *line,
 592                                    int *unmapped);
 593
 594 extern void deprecated_print_address_numeric (CORE_ADDR, int, struct ui_file *);
 595
 596 extern void print_address (CORE_ADDR, struct ui_file *);
 597
 598 /* From source.c */
 599
 600 #define OPF_TRY_CWD_FIRST     0x01
 601 #define OPF_SEARCH_IN_PATH    0x02
 602
 603 extern int openp (const char *, int, const char *, int, int, char **);
 604
 605 extern int source_full_path_of (char *, char **);
 606
 607 extern void mod_path (char *, char **);
 608
 609 extern void add_path (char *, char **, int);
 610
 611 extern void directory_command (char *, int);
 612
 613 extern char *source_path;
 614
 615 extern void init_source_path (void);
 616
 617 extern void init_last_source_visited (void);
 618
 619 /* From exec.c */
 620
 621 extern void exec_set_section_offsets (bfd_signed_vma text_off,
 622                                       bfd_signed_vma data_off,
 623                                       bfd_signed_vma bss_off);
 624
 625 /* Take over the 'find_mapped_memory' vector from exec.c. */
 626 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
 627                                                             unsigned long,
 628                                                             int, int, int,
 629                                                             void *),
 630                                                    void *));
 631
 632 /* Possible lvalue types.  Like enum language, this should be in
 633    value.h, but needs to be here for the same reason. */
 634
 635 enum lval_type
 636   {
 637     /* Not an lval. */
 638     not_lval,
 639     /* In memory.  */
 640     lval_memory,
 641     /* In a register.  Registers are relative to a frame.  */
 642     lval_register,
 643     /* In a gdb internal variable.  */
 644     lval_internalvar,
 645     /* Part of a gdb internal variable (structure field).  */
 646     lval_internalvar_component
 647   };
 648
 649 /* Control types for commands */
 650
 651 enum misc_command_type
 652   {
 653     ok_command,
 654     end_command,
 655     else_command,
 656     nop_command
 657   };
 658
 659 enum command_control_type
 660   {
 661     simple_control,
 662     break_control,
 663     continue_control,
 664     while_control,
 665     if_control,
 666     invalid_control
 667   };
 668
 669 /* Structure for saved commands lines
 670    (for breakpoints, defined commands, etc).  */
 671
 672 struct command_line
 673   {
 674     struct command_line *next;
 675     char *line;
 676     enum command_control_type control_type;
 677     int body_count;
 678     struct command_line **body_list;
 679   };
 680
 681 extern struct command_line *read_command_lines (char *, int);
 682
 683 extern void free_command_lines (struct command_line **);
 684
 685 /* To continue the execution commands when running gdb asynchronously.
 686    A continuation structure contains a pointer to a function to be called
 687    to finish the command, once the target has stopped. Such mechanism is
 688    used bt the finish and until commands, and in the remote protocol
 689    when opening an extended-remote connection. */
 690
 691 struct continuation_arg
 692   {
 693     struct continuation_arg *next;
 694     union continuation_data {
 695       void *pointer;
 696       int   integer;
 697       long  longint;
 698     } data;
 699   };
 700
 701 struct continuation
 702   {
 703     void (*continuation_hook) (struct continuation_arg *);
 704     struct continuation_arg *arg_list;
 705     struct continuation *next;
 706   };
 707
 708 /* In infrun.c. */
 709 extern struct continuation *cmd_continuation;
 710 /* Used only by the step_1 function. */
 711 extern struct continuation *intermediate_continuation;
 712
 713 /* From utils.c */
 714 extern void add_continuation (void (*)(struct continuation_arg *),
 715                               struct continuation_arg *);
 716 extern void do_all_continuations (void);
 717 extern void discard_all_continuations (void);
 718
 719 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
 720                               struct continuation_arg *);
 721 extern void do_all_intermediate_continuations (void);
 722 extern void discard_all_intermediate_continuations (void);
 723
 724 /* String containing the current directory (what getwd would return).  */
 725
 726 extern char *current_directory;
 727
 728 /* Default radixes for input and output.  Only some values supported.  */
 729 extern unsigned input_radix;
 730 extern unsigned output_radix;
 731
 732 /* Possibilities for prettyprint parameters to routines which print
 733    things.  Like enum language, this should be in value.h, but needs
 734    to be here for the same reason.  FIXME:  If we can eliminate this
 735    as an arg to LA_VAL_PRINT, then we can probably move it back to
 736    value.h. */
 737
 738 enum val_prettyprint
 739   {
 740     Val_no_prettyprint = 0,
 741     Val_prettyprint,
 742     /* Use the default setting which the user has specified.  */
 743     Val_pretty_default
 744   };
 745
 746 /* The ptid struct is a collection of the various "ids" necessary
 747    for identifying the inferior.  This consists of the process id
 748    (pid), thread id (tid), and other fields necessary for uniquely
 749    identifying the inferior process/thread being debugged.  When
 750    manipulating ptids, the constructors, accessors, and predicate
 751    declared in inferior.h should be used.  These are as follows:
 752
 753       ptid_build        - Make a new ptid from a pid, lwp, and tid.
 754       pid_to_ptid       - Make a new ptid from just a pid.
 755       ptid_get_pid      - Fetch the pid component of a ptid.
 756       ptid_get_lwp      - Fetch the lwp component of a ptid.
 757       ptid_get_tid      - Fetch the tid component of a ptid.
 758       ptid_equal        - Test to see if two ptids are equal.
 759
 760    Please do NOT access the struct ptid members directly (except, of
 761    course, in the implementation of the above ptid manipulation
 762    functions).  */
 763
 764 struct ptid
 765   {
 766     /* Process id */
 767     int pid;
 768
 769     /* Lightweight process id */
 770     long lwp;
 771
 772     /* Thread id */
 773     long tid;
 774   };
 775
 776 typedef struct ptid ptid_t;
 777
 778 \f
 779
 780 /* Optional host machine definition.  Pure autoconf targets will not
 781    need a "xm.h" file.  This will be a symlink to one of the xm-*.h
 782    files, built by the `configure' script.  */
 783
 784 #ifdef GDB_XM_FILE
 785 #include "xm.h"
 786 #endif
 787
 788 /* Optional native machine support.  Non-native (and possibly pure
 789    multi-arch) targets do not need a "nm.h" file.  This will be a
 790    symlink to one of the nm-*.h files, built by the `configure'
 791    script.  */
 792
 793 #ifdef GDB_NM_FILE
 794 #include "nm.h"
 795 #endif
 796
 797 /* Optional target machine definition.  Pure multi-arch configurations
 798    do not need a "tm.h" file.  This will be a symlink to one of the
 799    tm-*.h files, built by the `configure' script.  */
 800
 801 #ifdef GDB_TM_FILE
 802 #include "tm.h"
 803 #endif
 804
 805 /* Assume that fopen accepts the letter "b" in the mode string.
 806    It is demanded by ISO C9X, and should be supported on all
 807    platforms that claim to have a standard-conforming C library.  On
 808    true POSIX systems it will be ignored and have no effect.  There
 809    may still be systems without a standard-conforming C library where
 810    an ISO C9X compiler (GCC) is available.  Known examples are SunOS
 811    4.x and 4.3BSD.  This assumption means these systems are no longer
 812    supported.  */
 813 #ifndef FOPEN_RB
 814 # include "fopen-bin.h"
 815 #endif
 816
 817 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 818    FIXME: Assumes 2's complement arithmetic */
 819
 820 #if !defined (UINT_MAX)
 821 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 822 #endif
 823
 824 #if !defined (INT_MAX)
 825 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 826 #endif
 827
 828 #if !defined (INT_MIN)
 829 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 830 #endif
 831
 832 #if !defined (ULONG_MAX)
 833 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 834 #endif
 835
 836 #if !defined (LONG_MAX)
 837 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 838 #endif
 839
 840 #if !defined (ULONGEST_MAX)
 841 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 842 #endif
 843
 844 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 845 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 846 #endif
 847
 848 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 849    arguments to a function, number in a value history, register number, etc.)
 850    where the value must not be larger than can fit in an int.  */
 851
 852 extern int longest_to_int (LONGEST);
 853
 854 /* Assorted functions we can declare, now that const and volatile are
 855    defined.  */
 856
 857 extern char *savestring (const char *, size_t);
 858
 859 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
 860    "libiberty.h". */
 861 extern void xfree (void *);
 862
 863 /* Like xmalloc, but zero the memory.  */
 864 extern void *xzalloc (size_t);
 865
 866 /* Utility macros to allocate typed memory.  Avoids errors like:
 867    struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
 868    sizeof (struct foo), 0).  */
 869 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
 870 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 871 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 872
 873 /* Like asprintf/vasprintf but get an internal_error if the call
 874    fails. */
 875 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
 876 extern void xvasprintf (char **ret, const char *format, va_list ap);
 877
 878 /* Like asprintf and vasprintf, but return the string, throw an error
 879    if no memory.  */
 880 extern char *xstrprintf (const char *format, ...) ATTR_FORMAT (printf, 1, 2);
 881 extern char *xstrvprintf (const char *format, va_list ap);
 882
 883 /* Like snprintf, but throw an error if the output buffer is too small.  */
 884 extern int xsnprintf (char *str, size_t size, const char *format, ...)
 885      ATTR_FORMAT (printf, 3, 4);
 886
 887 extern int parse_escape (char **);
 888
 889 /* Message to be printed before the error message, when an error occurs.  */
 890
 891 extern char *error_pre_print;
 892
 893 /* Message to be printed before the error message, when an error occurs.  */
 894
 895 extern char *quit_pre_print;
 896
 897 /* Message to be printed before the warning message, when a warning occurs.  */
 898
 899 extern char *warning_pre_print;
 900
 901 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
 902
 903 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 904
 905 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
 906
 907 extern NORETURN void vfatal (const char *fmt, va_list ap) ATTR_NORETURN;
 908
 909 extern NORETURN void fatal (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 910
 911 extern NORETURN void internal_verror (const char *file, int line,
 912                                       const char *, va_list ap) ATTR_NORETURN;
 913
 914 extern NORETURN void internal_error (const char *file, int line,
 915                                      const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
 916
 917 extern void internal_vwarning (const char *file, int line,
 918                                const char *, va_list ap);
 919
 920 extern void internal_warning (const char *file, int line,
 921                               const char *, ...) ATTR_FORMAT (printf, 3, 4);
 922
 923 extern NORETURN void nomem (long) ATTR_NORETURN;
 924
 925 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 926
 927 extern void vwarning (const char *, va_list args);
 928
 929 /* List of known OS ABIs.  If you change this, make sure to update the
 930    table in osabi.c.  */
 931 enum gdb_osabi
 932 {
 933   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
 934
 935   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
 936
 937   GDB_OSABI_SVR4,
 938   GDB_OSABI_HURD,
 939   GDB_OSABI_SOLARIS,
 940   GDB_OSABI_OSF1,
 941   GDB_OSABI_LINUX,
 942   GDB_OSABI_FREEBSD_AOUT,
 943   GDB_OSABI_FREEBSD_ELF,
 944   GDB_OSABI_NETBSD_AOUT,
 945   GDB_OSABI_NETBSD_ELF,
 946   GDB_OSABI_OPENBSD_ELF,
 947   GDB_OSABI_WINCE,
 948   GDB_OSABI_GO32,
 949   GDB_OSABI_NETWARE,
 950   GDB_OSABI_IRIX,
 951   GDB_OSABI_LYNXOS,
 952   GDB_OSABI_INTERIX,
 953   GDB_OSABI_HPUX_ELF,
 954   GDB_OSABI_HPUX_SOM,
 955
 956   GDB_OSABI_QNXNTO,
 957
 958   GDB_OSABI_CYGWIN,
 959
 960   GDB_OSABI_INVALID             /* keep this last */
 961 };
 962
 963 /* Global functions from other, non-gdb GNU thingies.
 964    Libiberty thingies are no longer declared here.  We include libiberty.h
 965    above, instead.  */
 966
 967 /* From other system libraries */
 968
 969 #ifdef HAVE_STDDEF_H
 970 #include <stddef.h>
 971 #endif
 972
 973 #ifdef HAVE_STDLIB_H
 974 #include <stdlib.h>
 975 #endif
 976 #ifndef min
 977 #define min(a, b) ((a) < (b) ? (a) : (b))
 978 #endif
 979 #ifndef max
 980 #define max(a, b) ((a) > (b) ? (a) : (b))
 981 #endif
 982
 983
 984 #ifndef atof
 985 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
 986 #endif
 987
 988 /* Various possibilities for alloca.  */
 989 #ifndef alloca
 990 #ifdef __GNUC__
 991 #define alloca __builtin_alloca
 992 #else /* Not GNU C */
 993 #ifdef HAVE_ALLOCA_H
 994 #include <alloca.h>
 995 #else
 996 #ifdef _AIX
 997 #pragma alloca
 998 #else
 999
1000 /* We need to be careful not to declare this in a way which conflicts with
1001    bison.  Bison never declares it as char *, but under various circumstances
1002    (like __hpux) we need to use void *.  */
1003 extern void *alloca ();
1004 #endif /* Not _AIX */
1005 #endif /* Not HAVE_ALLOCA_H */
1006 #endif /* Not GNU C */
1007 #endif /* alloca not defined */
1008
1009 /* Dynamic target-system-dependent parameters for GDB. */
1010 #include "gdbarch.h"
1011
1012 /* Maximum size of a register.  Something small, but large enough for
1013    all known ISAs.  If it turns out to be too small, make it bigger.  */
1014
1015 enum { MAX_REGISTER_SIZE = 16 };
1016
1017 /* Static target-system-dependent parameters for GDB. */
1018
1019 /* Number of bits in a char or unsigned char for the target machine.
1020    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
1021 #if !defined (TARGET_CHAR_BIT)
1022 #define TARGET_CHAR_BIT 8
1023 #endif
1024
1025 /* If we picked up a copy of CHAR_BIT from a configuration file
1026    (which may get it by including <limits.h>) then use it to set
1027    the number of bits in a host char.  If not, use the same size
1028    as the target. */
1029
1030 #if defined (CHAR_BIT)
1031 #define HOST_CHAR_BIT CHAR_BIT
1032 #else
1033 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1034 #endif
1035
1036 /* The bit byte-order has to do just with numbering of bits in
1037    debugging symbols and such.  Conceptually, it's quite separate
1038    from byte/word byte order.  */
1039
1040 #if !defined (BITS_BIG_ENDIAN)
1041 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1042 #endif
1043
1044 /* In findvar.c.  */
1045
1046 extern LONGEST extract_signed_integer (const void *, int);
1047
1048 extern ULONGEST extract_unsigned_integer (const void *, int);
1049
1050 extern int extract_long_unsigned_integer (const void *, int, LONGEST *);
1051
1052 extern CORE_ADDR extract_typed_address (const void *buf, struct type *type);
1053
1054 extern void store_signed_integer (void *, int, LONGEST);
1055
1056 extern void store_unsigned_integer (void *, int, ULONGEST);
1057
1058 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1059
1060 \f
1061 /* From valops.c */
1062
1063 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1064
1065 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1066
1067 extern int watchdog;
1068
1069 /* Hooks for alternate command interfaces.  */
1070
1071 /* The name of the interpreter if specified on the command line. */
1072 extern char *interpreter_p;
1073
1074 /* If a given interpreter matches INTERPRETER_P then it should update
1075    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1076    per-interpreter implementation.  */
1077 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1078    should be moved here. */
1079
1080 struct target_waitstatus;
1081 struct cmd_list_element;
1082
1083 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1084 extern void (*deprecated_post_add_symbol_hook) (void);
1085 extern void (*selected_frame_level_changed_hook) (int);
1086 extern int (*deprecated_ui_loop_hook) (int signo);
1087 extern void (*deprecated_init_ui_hook) (char *argv0);
1088 extern void (*deprecated_command_loop_hook) (void);
1089 extern void (*deprecated_show_load_progress) (const char *section,
1090                                               unsigned long section_sent,
1091                                               unsigned long section_size,
1092                                               unsigned long total_sent,
1093                                               unsigned long total_size);
1094 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1095                                                          int line, int stopline,
1096                                                          int noerror);
1097 extern struct frame_info *parse_frame_specification (char *frame_exp);
1098 extern int (*deprecated_query_hook) (const char *, va_list);
1099 extern void (*deprecated_warning_hook) (const char *, va_list);
1100 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1101 extern void (*deprecated_create_breakpoint_hook) (struct breakpoint * b);
1102 extern void (*deprecated_delete_breakpoint_hook) (struct breakpoint * bpt);
1103 extern void (*deprecated_modify_breakpoint_hook) (struct breakpoint * bpt);
1104 extern void (*deprecated_interactive_hook) (void);
1105 extern void (*deprecated_registers_changed_hook) (void);
1106 extern void (*deprecated_readline_begin_hook) (char *,...);
1107 extern char *(*deprecated_readline_hook) (char *);
1108 extern void (*deprecated_readline_end_hook) (void);
1109 extern void (*deprecated_register_changed_hook) (int regno);
1110 extern void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
1111 extern void (*deprecated_context_hook) (int);
1112 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1113                                          struct target_waitstatus * status);
1114
1115 extern void (*deprecated_attach_hook) (void);
1116 extern void (*deprecated_detach_hook) (void);
1117 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1118                                              char *cmd, int from_tty);
1119
1120 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1121
1122 extern void (*deprecated_error_hook) (void);
1123
1124 extern void (*deprecated_error_begin_hook) (void);
1125
1126 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1127                                                 unsigned long num);
1128
1129
1130 /* Inhibit window interface if non-zero. */
1131
1132 extern int use_windows;
1133
1134 /* Symbolic definitions of filename-related things.  */
1135 /* FIXME, this doesn't work very well if host and executable
1136    filesystems conventions are different.  */
1137
1138 #ifdef __MSDOS__
1139 # define CANT_FORK
1140 # define GLOBAL_CURDIR
1141 # define DIRNAME_SEPARATOR ';'
1142 #endif
1143
1144 #ifndef DIRNAME_SEPARATOR
1145 #define DIRNAME_SEPARATOR ':'
1146 #endif
1147
1148 #ifndef SLASH_STRING
1149 #define SLASH_STRING "/"
1150 #endif
1151
1152 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1153    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1154    in the code actually refer to a lightweight process id, i.e,
1155    something that can be considered a process id in its own right for
1156    certain purposes.  */
1157
1158 #ifndef PIDGET
1159 #define PIDGET(PTID) (ptid_get_pid (PTID))
1160 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1161 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1162 #endif
1163
1164 /* Define well known filenos if the system does not define them.  */
1165 #ifndef STDIN_FILENO
1166 #define STDIN_FILENO   0
1167 #endif
1168 #ifndef STDOUT_FILENO
1169 #define STDOUT_FILENO  1
1170 #endif
1171 #ifndef STDERR_FILENO
1172 #define STDERR_FILENO  2
1173 #endif
1174
1175 /* If this definition isn't overridden by the header files, assume
1176    that isatty and fileno exist on this system.  */
1177 #ifndef ISATTY
1178 #define ISATTY(FP)      (isatty (fileno (FP)))
1179 #endif
1180
1181 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1182    power of 2).  Round up/down when necessary.  Examples of correct
1183    use include:
1184
1185    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1186    write_memory (addr, value, len);
1187    addr += len;
1188
1189    and:
1190
1191    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1192    write_memory (sp, value, len);
1193
1194    Note that uses such as:
1195
1196    write_memory (addr, value, len);
1197    addr += align_up (len, 8);
1198
1199    and:
1200
1201    sp -= align_up (len, 8);
1202    write_memory (sp, value, len);
1203
1204    are typically not correct as they don't ensure that the address (SP
1205    or ADDR) is correctly aligned (relying on previous alignment to
1206    keep things right).  This is also why the methods are called
1207    "align_..." instead of "round_..." as the latter reads better with
1208    this incorrect coding style.  */
1209
1210 extern ULONGEST align_up (ULONGEST v, int n);
1211 extern ULONGEST align_down (ULONGEST v, int n);
1212
1213 #endif /* #ifndef DEFS_H */