gdb/defs.h

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