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