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