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