gdb/defs.h

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