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