gdb/defs.h

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