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 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
 355
 356 struct target_ops;
 357 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
 358
 359 extern struct cleanup *
 360   make_cleanup_restore_ui_file (struct ui_file **variable);
 361
 362 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
 363
 364 extern struct cleanup *make_my_cleanup (struct cleanup **,
 365                                         make_cleanup_ftype *, void *);
 366
 367 extern struct cleanup *make_my_cleanup2 (struct cleanup **,
 368                                          make_cleanup_ftype *, void *,
 369                                          void (*free_arg) (void *));
 370
 371 extern struct cleanup *save_cleanups (void);
 372 extern struct cleanup *save_final_cleanups (void);
 373 extern struct cleanup *save_my_cleanups (struct cleanup **);
 374
 375 extern void restore_cleanups (struct cleanup *);
 376 extern void restore_final_cleanups (struct cleanup *);
 377 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 378
 379 extern void free_current_contents (void *);
 380
 381 extern void null_cleanup (void *);
 382
 383 extern struct cleanup *make_command_stats_cleanup (int);
 384
 385 extern int myread (int, char *, int);
 386
 387 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 388 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 389 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 390
 391 extern void init_page_info (void);
 392
 393 extern struct cleanup *make_cleanup_restore_page_info (void);
 394 extern struct cleanup *
 395   set_batch_flag_and_make_cleanup_restore_page_info (void);
 396
 397 extern char *gdb_realpath (const char *);
 398 extern char *xfullpath (const char *);
 399
 400 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
 401                                           unsigned char *buf, size_t len);
 402
 403 ULONGEST strtoulst (const char *num, const char **trailer, int base);
 404
 405 char *ldirname (const char *filename);
 406
 407 char **gdb_buildargv (const char *);
 408
 409 int compare_positive_ints (const void *ap, const void *bp);
 410
 411 /* A wrapper for bfd_errmsg to produce a more helpful error message
 412    in the case of bfd_error_file_ambiguously recognized.
 413    MATCHING, if non-NULL, is the corresponding argument to
 414    bfd_check_format_matches, and will be freed.  */
 415
 416 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
 417
 418 extern int parse_pid_to_attach (char *args);
 419
 420 /* From demangle.c */
 421
 422 extern void set_demangling_style (char *);
 423
 424 \f
 425 /* Annotation stuff.  */
 426
 427 extern int annotation_level;    /* in stack.c */
 428 \f
 429 extern void begin_line (void);
 430
 431 extern void wrap_here (char *);
 432
 433 extern void reinitialize_more_filter (void);
 434
 435 /* Normal results */
 436 extern struct ui_file *gdb_stdout;
 437 /* Input stream */
 438 extern struct ui_file *gdb_stdin;
 439 /* Serious error notifications */
 440 extern struct ui_file *gdb_stderr;
 441 /* Log/debug/trace messages that should bypass normal stdout/stderr
 442    filtering.  For moment, always call this stream using
 443    *_unfiltered. In the very near future that restriction shall be
 444    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 445 extern struct ui_file *gdb_stdlog;
 446 /* Target output that should bypass normal stdout/stderr filtering.
 447    For moment, always call this stream using *_unfiltered. In the
 448    very near future that restriction shall be removed - either call
 449    shall be unfiltered. (cagney 1999-07-02). */
 450 extern struct ui_file *gdb_stdtarg;
 451 extern struct ui_file *gdb_stdtargerr;
 452 extern struct ui_file *gdb_stdtargin;
 453
 454 #include "ui-file.h"
 455
 456 /* More generic printf like operations.  Filtered versions may return
 457    non-locally on error.  */
 458
 459 extern void fputs_filtered (const char *, struct ui_file *);
 460
 461 extern void fputs_unfiltered (const char *, struct ui_file *);
 462
 463 extern int fputc_filtered (int c, struct ui_file *);
 464
 465 extern int fputc_unfiltered (int c, struct ui_file *);
 466
 467 extern int putchar_filtered (int c);
 468
 469 extern int putchar_unfiltered (int c);
 470
 471 extern void puts_filtered (const char *);
 472
 473 extern void puts_unfiltered (const char *);
 474
 475 extern void puts_filtered_tabular (char *string, int width, int right);
 476
 477 extern void puts_debug (char *prefix, char *string, char *suffix);
 478
 479 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 480
 481 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTRIBUTE_PRINTF (2, 0);
 482
 483 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 484
 485 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 486
 487 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 488
 489 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 490
 491 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 492
 493 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTRIBUTE_PRINTF (2, 0);
 494
 495 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 496
 497 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 498
 499 extern void print_spaces (int, struct ui_file *);
 500
 501 extern void print_spaces_filtered (int, struct ui_file *);
 502
 503 extern char *n_spaces (int);
 504
 505 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 506
 507 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 508
 509 extern void fputstrn_filtered (const char *str, int n, int quotr, struct ui_file * stream);
 510
 511 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 512
 513 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 514 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 515
 516 extern const char *host_address_to_string (const void *addr);
 517
 518 /* Convert CORE_ADDR to string in platform-specific manner.
 519    This is usually formatted similar to 0x%lx.  */
 520 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 521
 522 /* %d for LONGEST */
 523 extern char *plongest (LONGEST l);
 524 /* %u for ULONGEST */
 525 extern char *pulongest (ULONGEST l);
 526
 527 extern char *phex (ULONGEST l, int sizeof_l);
 528 extern char *phex_nz (ULONGEST l, int sizeof_l);
 529 extern char *int_string (LONGEST, int, int, int, int);
 530
 531 /* Convert a CORE_ADDR into a HEX string with leading zeros.
 532    The output from core_addr_to_string() can be passed direct to
 533    string_to_core_addr().  */
 534 extern const char *core_addr_to_string (const CORE_ADDR addr);
 535 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 536 extern CORE_ADDR string_to_core_addr (const char *my_string);
 537
 538 /* Return a string that contains a number formatted as a hex
 539    string.  */
 540 extern char *hex_string (LONGEST);
 541 extern char *hex_string_custom (LONGEST, int);
 542
 543 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 544                                      enum language, int);
 545
 546 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
 547
 548 extern void print_sys_errmsg (const char *, int);
 549
 550 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 551    "const char *" in unistd.h, so we can't declare the argument
 552    as "char *".  */
 553
 554 extern char *re_comp (const char *);
 555
 556 /* From symfile.c */
 557
 558 extern void symbol_file_command (char *, int);
 559
 560 /* Remote targets may wish to use this as their load function.  */
 561 extern void generic_load (char *name, int from_tty);
 562
 563 /* Report on STREAM the performance of memory transfer operation,
 564    such as 'load'.
 565    DATA_COUNT is the number of bytes transferred.
 566    WRITE_COUNT is the number of separate write operations, or 0,
 567    if that information is not available.
 568    START_TIME is the time at which an operation was started.
 569    END_TIME is the time at which an operation ended.  */
 570 struct timeval;
 571 extern void print_transfer_performance (struct ui_file *stream,
 572                                         unsigned long data_count,
 573                                         unsigned long write_count,
 574                                         const struct timeval *start_time,
 575                                         const struct timeval *end_time);
 576
 577 /* From top.c */
 578
 579 typedef void initialize_file_ftype (void);
 580
 581 extern char *skip_quoted (char *);
 582
 583 extern char *gdb_readline (char *);
 584
 585 extern char *gdb_readline_wrapper (char *);
 586
 587 extern char *command_line_input (char *, int, char *);
 588
 589 extern void print_prompt (void);
 590
 591 extern int input_from_terminal_p (void);
 592
 593 extern int info_verbose;
 594
 595 /* From printcmd.c */
 596
 597 extern void set_next_address (struct gdbarch *, CORE_ADDR);
 598
 599 extern void print_address_symbolic (struct gdbarch *, CORE_ADDR,
 600                                     struct ui_file *, int, char *);
 601
 602 extern int build_address_symbolic (struct gdbarch *,
 603                                    CORE_ADDR addr,
 604                                    int do_demangle,
 605                                    char **name,
 606                                    int *offset,
 607                                    char **filename,
 608                                    int *line,
 609                                    int *unmapped);
 610
 611 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
 612 extern const char *pc_prefix (CORE_ADDR);
 613
 614 /* From source.c */
 615
 616 #define OPF_TRY_CWD_FIRST     0x01
 617 #define OPF_SEARCH_IN_PATH    0x02
 618
 619 extern int openp (const char *, int, const char *, int, char **);
 620
 621 extern int source_full_path_of (const char *, char **);
 622
 623 extern void mod_path (char *, char **);
 624
 625 extern void add_path (char *, char **, int);
 626
 627 extern void directory_command (char *, int);
 628
 629 extern void directory_switch (char *, int);
 630
 631 extern char *source_path;
 632
 633 extern void init_source_path (void);
 634
 635 /* From exec.c */
 636
 637 /* Take over the 'find_mapped_memory' vector from exec.c. */
 638 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
 639                                                             unsigned long,
 640                                                             int, int, int,
 641                                                             void *),
 642                                                    void *));
 643
 644 /* Possible lvalue types.  Like enum language, this should be in
 645    value.h, but needs to be here for the same reason. */
 646
 647 enum lval_type
 648   {
 649     /* Not an lval. */
 650     not_lval,
 651     /* In memory.  */
 652     lval_memory,
 653     /* In a register.  Registers are relative to a frame.  */
 654     lval_register,
 655     /* In a gdb internal variable.  */
 656     lval_internalvar,
 657     /* Part of a gdb internal variable (structure field).  */
 658     lval_internalvar_component,
 659     /* Value's bits are fetched and stored using functions provided by
 660        its creator.  */
 661     lval_computed
 662   };
 663
 664 /* Control types for commands */
 665
 666 enum misc_command_type
 667   {
 668     ok_command,
 669     end_command,
 670     else_command,
 671     nop_command
 672   };
 673
 674 enum command_control_type
 675   {
 676     simple_control,
 677     break_control,
 678     continue_control,
 679     while_control,
 680     if_control,
 681     commands_control,
 682     python_control,
 683     while_stepping_control,
 684     invalid_control
 685   };
 686
 687 /* Structure for saved commands lines
 688    (for breakpoints, defined commands, etc).  */
 689
 690 struct command_line
 691   {
 692     struct command_line *next;
 693     char *line;
 694     enum command_control_type control_type;
 695     /* The number of elements in body_list.  */
 696     int body_count;
 697     /* For composite commands, the nested lists of
 698        commands. For example, for "if" command this
 699        will contain the then branch and the else
 700        branch, if that is available.  */
 701     struct command_line **body_list;
 702   };
 703
 704 extern struct command_line *read_command_lines (char *, int, int,
 705                                                 void (*)(char *, void *),
 706                                                 void *);
 707 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
 708                                                   void (*)(char *, void *),
 709                                                   void *);
 710
 711 extern void free_command_lines (struct command_line **);
 712
 713 /* To continue the execution commands when running gdb asynchronously.
 714    A continuation structure contains a pointer to a function to be called
 715    to finish the command, once the target has stopped. Such mechanism is
 716    used by the finish and until commands, and in the remote protocol
 717    when opening an extended-remote connection. */
 718
 719 struct continuation;
 720 struct thread_info;
 721 struct inferior;
 722
 723 /* From utils.c */
 724
 725 /* Thread specific continuations.  */
 726
 727 extern void add_continuation (struct thread_info *,
 728                               void (*)(void *), void *,
 729                               void (*)(void *));
 730 extern void do_all_continuations (void);
 731 extern void do_all_continuations_thread (struct thread_info *);
 732 extern void discard_all_continuations (void);
 733 extern void discard_all_continuations_thread (struct thread_info *);
 734
 735 extern void add_intermediate_continuation (struct thread_info *,
 736                                            void (*)(void *), void *,
 737                                            void (*)(void *));
 738 extern void do_all_intermediate_continuations (void);
 739 extern void do_all_intermediate_continuations_thread (struct thread_info *);
 740 extern void discard_all_intermediate_continuations (void);
 741 extern void discard_all_intermediate_continuations_thread (struct thread_info *);
 742
 743 /* Inferior specific (any thread) continuations.  */
 744
 745 extern void add_inferior_continuation (void (*) (void *),
 746                                        void *,
 747                                        void (*) (void *));
 748 extern void do_all_inferior_continuations (void);
 749 extern void discard_all_inferior_continuations (struct inferior *inf);
 750
 751 /* String containing the current directory (what getwd would return).  */
 752
 753 extern char *current_directory;
 754
 755 /* Default radixes for input and output.  Only some values supported.  */
 756 extern unsigned input_radix;
 757 extern unsigned output_radix;
 758
 759 /* Possibilities for prettyprint parameters to routines which print
 760    things.  Like enum language, this should be in value.h, but needs
 761    to be here for the same reason.  FIXME:  If we can eliminate this
 762    as an arg to LA_VAL_PRINT, then we can probably move it back to
 763    value.h. */
 764
 765 enum val_prettyprint
 766   {
 767     Val_no_prettyprint = 0,
 768     Val_prettyprint,
 769     /* Use the default setting which the user has specified.  */
 770     Val_pretty_default
 771   };
 772
 773 /* The ptid struct is a collection of the various "ids" necessary
 774    for identifying the inferior.  This consists of the process id
 775    (pid), thread id (tid), and other fields necessary for uniquely
 776    identifying the inferior process/thread being debugged.  When
 777    manipulating ptids, the constructors, accessors, and predicate
 778    declared in inferior.h should be used.  These are as follows:
 779
 780       ptid_build        - Make a new ptid from a pid, lwp, and tid.
 781       pid_to_ptid       - Make a new ptid from just a pid.
 782       ptid_get_pid      - Fetch the pid component of a ptid.
 783       ptid_get_lwp      - Fetch the lwp component of a ptid.
 784       ptid_get_tid      - Fetch the tid component of a ptid.
 785       ptid_equal        - Test to see if two ptids are equal.
 786       ptid_is_pid       - Test to see if this ptid represents a process id.
 787
 788    Please do NOT access the struct ptid members directly (except, of
 789    course, in the implementation of the above ptid manipulation
 790    functions).  */
 791
 792 struct ptid
 793   {
 794     /* Process id */
 795     int pid;
 796
 797     /* Lightweight process id */
 798     long lwp;
 799
 800     /* Thread id */
 801     long tid;
 802   };
 803
 804 typedef struct ptid ptid_t;
 805
 806 \f
 807
 808 /* Optional native machine support.  Non-native (and possibly pure
 809    multi-arch) targets do not need a "nm.h" file.  This will be a
 810    symlink to one of the nm-*.h files, built by the `configure'
 811    script.  */
 812
 813 #ifdef GDB_NM_FILE
 814 #include "nm.h"
 815 #endif
 816
 817 /* Assume that fopen accepts the letter "b" in the mode string.
 818    It is demanded by ISO C9X, and should be supported on all
 819    platforms that claim to have a standard-conforming C library.  On
 820    true POSIX systems it will be ignored and have no effect.  There
 821    may still be systems without a standard-conforming C library where
 822    an ISO C9X compiler (GCC) is available.  Known examples are SunOS
 823    4.x and 4.3BSD.  This assumption means these systems are no longer
 824    supported.  */
 825 #ifndef FOPEN_RB
 826 # include "fopen-bin.h"
 827 #endif
 828
 829 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 830    FIXME: Assumes 2's complement arithmetic */
 831
 832 #if !defined (UINT_MAX)
 833 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 834 #endif
 835
 836 #if !defined (INT_MAX)
 837 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 838 #endif
 839
 840 #if !defined (INT_MIN)
 841 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 842 #endif
 843
 844 #if !defined (ULONG_MAX)
 845 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 846 #endif
 847
 848 #if !defined (LONG_MAX)
 849 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 850 #endif
 851
 852 #if !defined (ULONGEST_MAX)
 853 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 854 #endif
 855
 856 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 857 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 858 #endif
 859
 860 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 861    arguments to a function, number in a value history, register number, etc.)
 862    where the value must not be larger than can fit in an int.  */
 863
 864 extern int longest_to_int (LONGEST);
 865
 866 /* Assorted functions we can declare, now that const and volatile are
 867    defined.  */
 868
 869 extern char *savestring (const char *, size_t);
 870
 871 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
 872    "libiberty.h". */
 873 extern void xfree (void *);
 874
 875 /* Like xmalloc, but zero the memory.  */
 876 extern void *xzalloc (size_t);
 877
 878 /* Utility macros to allocate typed memory.  Avoids errors like:
 879    struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
 880    sizeof (struct foo), 0).  */
 881 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
 882 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 883 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 884
 885 /* Like asprintf/vasprintf but get an internal_error if the call
 886    fails. */
 887 extern void xasprintf (char **ret, const char *format, ...) ATTRIBUTE_PRINTF (2, 3);
 888 extern void xvasprintf (char **ret, const char *format, va_list ap)
 889      ATTRIBUTE_PRINTF (2, 0);
 890
 891 /* Like asprintf and vasprintf, but return the string, throw an error
 892    if no memory.  */
 893 extern char *xstrprintf (const char *format, ...) ATTRIBUTE_PRINTF (1, 2);
 894 extern char *xstrvprintf (const char *format, va_list ap)
 895      ATTRIBUTE_PRINTF (1, 0);
 896
 897 /* Like snprintf, but throw an error if the output buffer is too small.  */
 898 extern int xsnprintf (char *str, size_t size, const char *format, ...)
 899      ATTRIBUTE_PRINTF (3, 4);
 900
 901 extern int parse_escape (struct gdbarch *, char **);
 902
 903 /* Message to be printed before the error message, when an error occurs.  */
 904
 905 extern char *error_pre_print;
 906
 907 /* Message to be printed before the error message, when an error occurs.  */
 908
 909 extern char *quit_pre_print;
 910
 911 /* Message to be printed before the warning message, when a warning occurs.  */
 912
 913 extern char *warning_pre_print;
 914
 915 extern void verror (const char *fmt, va_list ap)
 916      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 917
 918 extern void error (const char *fmt, ...)
 919      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 920
 921 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
 922
 923 extern void vfatal (const char *fmt, va_list ap)
 924      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 925
 926 extern void fatal (const char *fmt, ...)
 927      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 928
 929 extern void internal_verror (const char *file, int line, const char *,
 930                              va_list ap)
 931      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
 932
 933 extern void internal_error (const char *file, int line, const char *, ...)
 934      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 4);
 935
 936 extern void internal_vwarning (const char *file, int line,
 937                                const char *, va_list ap)
 938      ATTRIBUTE_PRINTF (3, 0);
 939
 940 extern void internal_warning (const char *file, int line,
 941                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 942
 943 extern void nomem (long) ATTRIBUTE_NORETURN;
 944
 945 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 946
 947 extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
 948
 949 /* List of known OS ABIs.  If you change this, make sure to update the
 950    table in osabi.c.  */
 951 enum gdb_osabi
 952 {
 953   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
 954
 955   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
 956
 957   GDB_OSABI_SVR4,
 958   GDB_OSABI_HURD,
 959   GDB_OSABI_SOLARIS,
 960   GDB_OSABI_OSF1,
 961   GDB_OSABI_LINUX,
 962   GDB_OSABI_FREEBSD_AOUT,
 963   GDB_OSABI_FREEBSD_ELF,
 964   GDB_OSABI_NETBSD_AOUT,
 965   GDB_OSABI_NETBSD_ELF,
 966   GDB_OSABI_OPENBSD_ELF,
 967   GDB_OSABI_WINCE,
 968   GDB_OSABI_GO32,
 969   GDB_OSABI_IRIX,
 970   GDB_OSABI_INTERIX,
 971   GDB_OSABI_HPUX_ELF,
 972   GDB_OSABI_HPUX_SOM,
 973   GDB_OSABI_QNXNTO,
 974   GDB_OSABI_CYGWIN,
 975   GDB_OSABI_AIX,
 976   GDB_OSABI_DICOS,
 977   GDB_OSABI_DARWIN,
 978   GDB_OSABI_SYMBIAN,
 979
 980   GDB_OSABI_INVALID             /* keep this last */
 981 };
 982
 983 /* Global functions from other, non-gdb GNU thingies.
 984    Libiberty thingies are no longer declared here.  We include libiberty.h
 985    above, instead.  */
 986
 987 /* From other system libraries */
 988
 989 #ifdef HAVE_STDDEF_H
 990 #include <stddef.h>
 991 #endif
 992
 993 #ifdef HAVE_STDLIB_H
 994 #include <stdlib.h>
 995 #endif
 996 #ifndef min
 997 #define min(a, b) ((a) < (b) ? (a) : (b))
 998 #endif
 999 #ifndef max
1000 #define max(a, b) ((a) > (b) ? (a) : (b))
1001 #endif
1002
1003
1004 #ifndef atof
1005 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
1006 #endif
1007
1008 /* Various possibilities for alloca.  */
1009 #ifndef alloca
1010 #ifdef __GNUC__
1011 #define alloca __builtin_alloca
1012 #else /* Not GNU C */
1013 #ifdef HAVE_ALLOCA_H
1014 #include <alloca.h>
1015 #else
1016 #ifdef _AIX
1017 #pragma alloca
1018 #else
1019
1020 /* We need to be careful not to declare this in a way which conflicts with
1021    bison.  Bison never declares it as char *, but under various circumstances
1022    (like __hpux) we need to use void *.  */
1023 extern void *alloca ();
1024 #endif /* Not _AIX */
1025 #endif /* Not HAVE_ALLOCA_H */
1026 #endif /* Not GNU C */
1027 #endif /* alloca not defined */
1028
1029 /* Dynamic target-system-dependent parameters for GDB. */
1030 #include "gdbarch.h"
1031
1032 /* Maximum size of a register.  Something small, but large enough for
1033    all known ISAs.  If it turns out to be too small, make it bigger.  */
1034
1035 enum { MAX_REGISTER_SIZE = 32 };
1036
1037 /* Static target-system-dependent parameters for GDB. */
1038
1039 /* Number of bits in a char or unsigned char for the target machine.
1040    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
1041 #if !defined (TARGET_CHAR_BIT)
1042 #define TARGET_CHAR_BIT 8
1043 #endif
1044
1045 /* If we picked up a copy of CHAR_BIT from a configuration file
1046    (which may get it by including <limits.h>) then use it to set
1047    the number of bits in a host char.  If not, use the same size
1048    as the target. */
1049
1050 #if defined (CHAR_BIT)
1051 #define HOST_CHAR_BIT CHAR_BIT
1052 #else
1053 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1054 #endif
1055
1056 /* In findvar.c.  */
1057
1058 extern LONGEST extract_signed_integer (const gdb_byte *, int,
1059                                        enum bfd_endian);
1060
1061 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
1062                                           enum bfd_endian);
1063
1064 extern int extract_long_unsigned_integer (const gdb_byte *, int,
1065                                           enum bfd_endian, LONGEST *);
1066
1067 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
1068                                         struct type *type);
1069
1070 extern void store_signed_integer (gdb_byte *, int,
1071                                   enum bfd_endian, LONGEST);
1072
1073 extern void store_unsigned_integer (gdb_byte *, int,
1074                                     enum bfd_endian, ULONGEST);
1075
1076 extern void store_typed_address (gdb_byte *buf, struct type *type,
1077                                  CORE_ADDR addr);
1078
1079 \f
1080 /* From valops.c */
1081
1082 extern int watchdog;
1083
1084 /* Hooks for alternate command interfaces.  */
1085
1086 /* The name of the interpreter if specified on the command line. */
1087 extern char *interpreter_p;
1088
1089 /* If a given interpreter matches INTERPRETER_P then it should update
1090    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1091    per-interpreter implementation.  */
1092 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1093    should be moved here. */
1094
1095 struct target_waitstatus;
1096 struct cmd_list_element;
1097
1098 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1099 extern void (*deprecated_post_add_symbol_hook) (void);
1100 extern void (*selected_frame_level_changed_hook) (int);
1101 extern int (*deprecated_ui_loop_hook) (int signo);
1102 extern void (*deprecated_init_ui_hook) (char *argv0);
1103 extern void (*deprecated_command_loop_hook) (void);
1104 extern void (*deprecated_show_load_progress) (const char *section,
1105                                               unsigned long section_sent,
1106                                               unsigned long section_size,
1107                                               unsigned long total_sent,
1108                                               unsigned long total_size);
1109 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1110                                                          int line, int stopline,
1111                                                          int noerror);
1112 extern int (*deprecated_query_hook) (const char *, va_list)
1113      ATTRIBUTE_FPTR_PRINTF(1,0);
1114 extern void (*deprecated_warning_hook) (const char *, va_list)
1115      ATTRIBUTE_FPTR_PRINTF(1,0);
1116 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1117 extern void (*deprecated_interactive_hook) (void);
1118 extern void (*deprecated_readline_begin_hook) (char *, ...)
1119      ATTRIBUTE_FPTR_PRINTF_1;
1120 extern char *(*deprecated_readline_hook) (char *);
1121 extern void (*deprecated_readline_end_hook) (void);
1122 extern void (*deprecated_register_changed_hook) (int regno);
1123 extern void (*deprecated_context_hook) (int);
1124 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1125                                               struct target_waitstatus *status,
1126                                               int options);
1127
1128 extern void (*deprecated_attach_hook) (void);
1129 extern void (*deprecated_detach_hook) (void);
1130 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1131                                              char *cmd, int from_tty);
1132
1133 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1134
1135 extern void (*deprecated_error_begin_hook) (void);
1136
1137 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1138                                                 unsigned long num);
1139
1140
1141 /* Inhibit window interface if non-zero. */
1142
1143 extern int use_windows;
1144
1145 /* Definitions of filename-related things.  */
1146
1147 /* Host specific things.  */
1148
1149 #ifdef __MSDOS__
1150 # define CANT_FORK
1151 # define GLOBAL_CURDIR
1152 # define DIRNAME_SEPARATOR ';'
1153 #endif
1154
1155 #if !defined (__CYGWIN__) && defined (_WIN32)
1156 # define DIRNAME_SEPARATOR ';'
1157 #endif
1158
1159 #ifndef DIRNAME_SEPARATOR
1160 #define DIRNAME_SEPARATOR ':'
1161 #endif
1162
1163 #ifndef SLASH_STRING
1164 #define SLASH_STRING "/"
1165 #endif
1166
1167 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1168    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1169    in the code actually refer to a lightweight process id, i.e,
1170    something that can be considered a process id in its own right for
1171    certain purposes.  */
1172
1173 #ifndef PIDGET
1174 #define PIDGET(PTID) (ptid_get_pid (PTID))
1175 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1176 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1177 #endif
1178
1179 /* Define well known filenos if the system does not define them.  */
1180 #ifndef STDIN_FILENO
1181 #define STDIN_FILENO   0
1182 #endif
1183 #ifndef STDOUT_FILENO
1184 #define STDOUT_FILENO  1
1185 #endif
1186 #ifndef STDERR_FILENO
1187 #define STDERR_FILENO  2
1188 #endif
1189
1190 /* If this definition isn't overridden by the header files, assume
1191    that isatty and fileno exist on this system.  */
1192 #ifndef ISATTY
1193 #define ISATTY(FP)      (isatty (fileno (FP)))
1194 #endif
1195
1196 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1197    power of 2).  Round up/down when necessary.  Examples of correct
1198    use include:
1199
1200    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1201    write_memory (addr, value, len);
1202    addr += len;
1203
1204    and:
1205
1206    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1207    write_memory (sp, value, len);
1208
1209    Note that uses such as:
1210
1211    write_memory (addr, value, len);
1212    addr += align_up (len, 8);
1213
1214    and:
1215
1216    sp -= align_up (len, 8);
1217    write_memory (sp, value, len);
1218
1219    are typically not correct as they don't ensure that the address (SP
1220    or ADDR) is correctly aligned (relying on previous alignment to
1221    keep things right).  This is also why the methods are called
1222    "align_..." instead of "round_..." as the latter reads better with
1223    this incorrect coding style.  */
1224
1225 extern ULONGEST align_up (ULONGEST v, int n);
1226 extern ULONGEST align_down (ULONGEST v, int n);
1227
1228 /* Allocation and deallocation functions for the libiberty hash table
1229    which use obstacks.  */
1230 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
1231 void dummy_obstack_deallocate (void *object, void *data);
1232
1233 /* From progspace.c */
1234
1235 extern void initialize_progspace (void);
1236 extern void initialize_inferiors (void);
1237
1238 #endif /* #ifndef DEFS_H */