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