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