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