gdb/defs.h

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