gdb/defs.h

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