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