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