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