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