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