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_scm,               /* Scheme / Guile */
 214     language_pascal,            /* Pascal */
 215     language_ada,               /* Ada */
 216     language_minimal,           /* All other languages, minimal support only */
 217     nr_languages
 218   };
 219
 220 enum precision_type
 221   {
 222     single_precision,
 223     double_precision,
 224     unspecified_precision
 225   };
 226
 227 /* A generic, not quite boolean, enumeration.  */
 228 enum auto_boolean
 229 {
 230   AUTO_BOOLEAN_TRUE,
 231   AUTO_BOOLEAN_FALSE,
 232   AUTO_BOOLEAN_AUTO
 233 };
 234
 235 /* Potential ways that a function can return a value of a given type.  */
 236 enum return_value_convention
 237 {
 238   /* Where the return value has been squeezed into one or more
 239      registers.  */
 240   RETURN_VALUE_REGISTER_CONVENTION,
 241   /* Commonly known as the "struct return convention".  The caller
 242      passes an additional hidden first parameter to the caller.  That
 243      parameter contains the address at which the value being returned
 244      should be stored.  While typically, and historically, used for
 245      large structs, this is convention is applied to values of many
 246      different types.  */
 247   RETURN_VALUE_STRUCT_CONVENTION,
 248   /* Like the "struct return convention" above, but where the ABI
 249      guarantees that the called function stores the address at which
 250      the value being returned is stored in a well-defined location,
 251      such as a register or memory slot in the stack frame.  Don't use
 252      this if the ABI doesn't explicitly guarantees this.  */
 253   RETURN_VALUE_ABI_RETURNS_ADDRESS,
 254   /* Like the "struct return convention" above, but where the ABI
 255      guarantees that the address at which the value being returned is
 256      stored will be available in a well-defined location, such as a
 257      register or memory slot in the stack frame.  Don't use this if
 258      the ABI doesn't explicitly guarantees this.  */
 259   RETURN_VALUE_ABI_PRESERVES_ADDRESS,
 260 };
 261
 262 /* the cleanup list records things that have to be undone
 263    if an error happens (descriptors to be closed, memory to be freed, etc.)
 264    Each link in the chain records a function to call and an
 265    argument to give it.
 266
 267    Use make_cleanup to add an element to the cleanup chain.
 268    Use do_cleanups to do all cleanup actions back to a given
 269    point in the chain.  Use discard_cleanups to remove cleanups
 270    from the chain back to a given point, not doing them.  */
 271
 272 struct cleanup
 273   {
 274     struct cleanup *next;
 275     void (*function) (void *);
 276     void *arg;
 277   };
 278
 279
 280 /* The ability to declare that a function never returns is useful, but
 281    not really required to compile GDB successfully, so the NORETURN and
 282    ATTR_NORETURN macros normally expand into nothing.  */
 283
 284 /* If compiling with older versions of GCC, a function may be declared
 285    "volatile" to indicate that it does not return.  */
 286
 287 #ifndef NORETURN
 288 #if defined(__GNUC__) \
 289      && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
 290 #define NORETURN volatile
 291 #else
 292 #define NORETURN                /* nothing */
 293 #endif
 294 #endif
 295
 296 /* GCC 2.5 and later versions define a function attribute "noreturn",
 297    which is the preferred way to declare that a function never returns.
 298    However GCC 2.7 appears to be the first version in which this fully
 299    works everywhere we use it. */
 300
 301 #ifndef ATTR_NORETURN
 302 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
 303 #define ATTR_NORETURN __attribute__ ((noreturn))
 304 #else
 305 #define ATTR_NORETURN           /* nothing */
 306 #endif
 307 #endif
 308
 309 #ifndef ATTR_FORMAT
 310 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
 311 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
 312 #else
 313 #define ATTR_FORMAT(type, x, y) /* nothing */
 314 #endif
 315 #endif
 316
 317 /* Be conservative and use enum bitfields only with GCC.
 318    This is copied from gcc 3.3.1, system.h.  */
 319
 320 #if defined(__GNUC__) && (__GNUC__ >= 2)
 321 #define ENUM_BITFIELD(TYPE) enum TYPE
 322 #else
 323 #define ENUM_BITFIELD(TYPE) unsigned int
 324 #endif
 325
 326 /* Needed for various prototypes */
 327
 328 struct symtab;
 329 struct breakpoint;
 330 struct frame_info;
 331
 332 /* From utils.c */
 333
 334 extern void initialize_utils (void);
 335
 336 extern void notice_quit (void);
 337
 338 extern int strcmp_iw (const char *, const char *);
 339
 340 extern int strcmp_iw_ordered (const char *, const char *);
 341
 342 extern int streq (const char *, const char *);
 343
 344 extern int subset_compare (char *, char *);
 345
 346 extern char *safe_strerror (int);
 347
 348 #define ALL_CLEANUPS    ((struct cleanup *)0)
 349
 350 extern void do_cleanups (struct cleanup *);
 351 extern void do_final_cleanups (struct cleanup *);
 352 extern void do_run_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_run_cleanup (make_cleanup_ftype *, void *);
 389
 390 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
 391 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
 392
 393 extern struct cleanup *save_cleanups (void);
 394 extern struct cleanup *save_final_cleanups (void);
 395 extern struct cleanup *save_my_cleanups (struct cleanup **);
 396
 397 extern void restore_cleanups (struct cleanup *);
 398 extern void restore_final_cleanups (struct cleanup *);
 399 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 400
 401 extern void free_current_contents (void *);
 402
 403 extern void null_cleanup (void *);
 404
 405 extern int myread (int, char *, int);
 406
 407 extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 408 extern int nquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 409 extern int yquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 410
 411 extern void init_page_info (void);
 412
 413 extern char *gdb_realpath (const char *);
 414 extern char *xfullpath (const char *);
 415
 416 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
 417                                           unsigned char *buf, size_t len);
 418
 419 ULONGEST strtoulst (const char *num, const char **trailer, int base);
 420
 421 /* From demangle.c */
 422
 423 extern void set_demangling_style (char *);
 424
 425 /* From tm.h */
 426
 427 struct type;
 428 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
 429 extern use_struct_convention_fn generic_use_struct_convention;
 430
 431 \f
 432 /* Annotation stuff.  */
 433
 434 extern int annotation_level;    /* in stack.c */
 435 \f
 436 extern void begin_line (void);
 437
 438 extern void wrap_here (char *);
 439
 440 extern void reinitialize_more_filter (void);
 441
 442 /* Normal results */
 443 extern struct ui_file *gdb_stdout;
 444 /* Input stream */
 445 extern struct ui_file *gdb_stdin;
 446 /* Serious error notifications */
 447 extern struct ui_file *gdb_stderr;
 448 /* Log/debug/trace messages that should bypass normal stdout/stderr
 449    filtering.  For moment, always call this stream using
 450    *_unfiltered. In the very near future that restriction shall be
 451    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 452 extern struct ui_file *gdb_stdlog;
 453 /* Target output that should bypass normal stdout/stderr filtering.
 454    For moment, always call this stream using *_unfiltered. In the
 455    very near future that restriction shall be removed - either call
 456    shall be unfiltered. (cagney 1999-07-02). */
 457 extern struct ui_file *gdb_stdtarg;
 458 extern struct ui_file *gdb_stdtargerr;
 459 extern struct ui_file *gdb_stdtargin;
 460
 461 #include "ui-file.h"
 462
 463 /* More generic printf like operations.  Filtered versions may return
 464    non-locally on error.  */
 465
 466 extern void fputs_filtered (const char *, struct ui_file *);
 467
 468 extern void fputs_unfiltered (const char *, struct ui_file *);
 469
 470 extern int fputc_filtered (int c, struct ui_file *);
 471
 472 extern int fputc_unfiltered (int c, struct ui_file *);
 473
 474 extern int putchar_filtered (int c);
 475
 476 extern int putchar_unfiltered (int c);
 477
 478 extern void puts_filtered (const char *);
 479
 480 extern void puts_unfiltered (const char *);
 481
 482 extern void puts_filtered_tabular (char *string, int width, int right);
 483
 484 extern void puts_debug (char *prefix, char *string, char *suffix);
 485
 486 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 487
 488 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 489
 490 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 491
 492 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 493
 494 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 495
 496 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 497
 498 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 499
 500 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 501
 502 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 503
 504 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 505
 506 extern void print_spaces (int, struct ui_file *);
 507
 508 extern void print_spaces_filtered (int, struct ui_file *);
 509
 510 extern char *n_spaces (int);
 511
 512 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 513
 514 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 515
 516 extern void fputstrn_filtered (const char *str, int n, int quotr, struct ui_file * stream);
 517
 518 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 519
 520 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 521 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 522
 523 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 524    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
 525    for ``%*''. */
 526 extern int strlen_paddr (void);
 527 extern char *paddr (CORE_ADDR addr);
 528 extern char *paddr_nz (CORE_ADDR addr);
 529 extern char *paddr_u (CORE_ADDR addr);
 530 extern char *paddr_d (LONGEST addr);
 531
 532 /* Like 0x%lx, replaces deprecated_print_address_numeric.  */
 533 extern const char *paddress (CORE_ADDR addr);
 534
 535 extern char *phex (ULONGEST l, int sizeof_l);
 536 extern char *phex_nz (ULONGEST l, int sizeof_l);
 537 extern char *int_string (LONGEST, int, int, int, int);
 538
 539 /* Like paddr() only print/scan raw CORE_ADDR.  The output from
 540    core_addr_to_string() can be passed direct to
 541    string_to_core_addr().  */
 542 extern const char *core_addr_to_string (const CORE_ADDR addr);
 543 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 544 extern CORE_ADDR string_to_core_addr (const char *my_string);
 545
 546 /* Return a string that contains a number formatted as a hex
 547    string.  */
 548 extern char *hex_string (LONGEST);
 549 extern char *hex_string_custom (LONGEST, int);
 550
 551 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 552                                      enum language, int);
 553
 554 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
 555
 556 extern void print_sys_errmsg (const char *, int);
 557
 558 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 559    "const char *" in unistd.h, so we can't declare the argument
 560    as "char *".  */
 561
 562 extern char *re_comp (const char *);
 563
 564 /* From symfile.c */
 565
 566 extern void symbol_file_command (char *, int);
 567
 568 /* Remote targets may wish to use this as their load function.  */
 569 extern void generic_load (char *name, int from_tty);
 570
 571 /* Report on STREAM the performance of memory transfer operation,
 572    such as 'load'.
 573    DATA_COUNT is the number of bytes transferred.
 574    WRITE_COUNT is the number of separate write operations, or 0,
 575    if that information is not available.
 576    START_TIME is the time at which an operation was started.
 577    END_TIME is the time at which an operation ended.  */
 578 struct timeval;
 579 extern void print_transfer_performance (struct ui_file *stream,
 580                                         unsigned long data_count,
 581                                         unsigned long write_count,
 582                                         const struct timeval *start_time,
 583                                         const struct timeval *end_time);
 584
 585 /* From top.c */
 586
 587 typedef void initialize_file_ftype (void);
 588
 589 extern char *skip_quoted (char *);
 590
 591 extern char *gdb_readline (char *);
 592
 593 extern char *gdb_readline_wrapper (char *);
 594
 595 extern char *command_line_input (char *, int, char *);
 596
 597 extern void print_prompt (void);
 598
 599 extern int input_from_terminal_p (void);
 600
 601 extern int info_verbose;
 602
 603 /* From printcmd.c */
 604
 605 extern void set_next_address (CORE_ADDR);
 606
 607 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
 608                                     char *);
 609
 610 extern int build_address_symbolic (CORE_ADDR addr,
 611                                    int do_demangle,
 612                                    char **name,
 613                                    int *offset,
 614                                    char **filename,
 615                                    int *line,
 616                                    int *unmapped);
 617
 618 extern void deprecated_print_address_numeric (CORE_ADDR, int, struct ui_file *);
 619
 620 extern void print_address (CORE_ADDR, struct ui_file *);
 621
 622 /* From source.c */
 623
 624 #define OPF_TRY_CWD_FIRST     0x01
 625 #define OPF_SEARCH_IN_PATH    0x02
 626
 627 extern int openp (const char *, int, const char *, int, int, char **);
 628
 629 extern int source_full_path_of (char *, char **);
 630
 631 extern void mod_path (char *, char **);
 632
 633 extern void add_path (char *, char **, int);
 634
 635 extern void directory_command (char *, int);
 636
 637 extern void directory_switch (char *, int);
 638
 639 extern char *source_path;
 640
 641 extern void init_source_path (void);
 642
 643 extern void init_last_source_visited (void);
 644
 645 /* From exec.c */
 646
 647 extern void exec_set_section_offsets (bfd_signed_vma text_off,
 648                                       bfd_signed_vma data_off,
 649                                       bfd_signed_vma bss_off);
 650
 651 /* Take over the 'find_mapped_memory' vector from exec.c. */
 652 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
 653                                                             unsigned long,
 654                                                             int, int, int,
 655                                                             void *),
 656                                                    void *));
 657
 658 /* Possible lvalue types.  Like enum language, this should be in
 659    value.h, but needs to be here for the same reason. */
 660
 661 enum lval_type
 662   {
 663     /* Not an lval. */
 664     not_lval,
 665     /* In memory.  */
 666     lval_memory,
 667     /* In a register.  Registers are relative to a frame.  */
 668     lval_register,
 669     /* In a gdb internal variable.  */
 670     lval_internalvar,
 671     /* Part of a gdb internal variable (structure field).  */
 672     lval_internalvar_component
 673   };
 674
 675 /* Control types for commands */
 676
 677 enum misc_command_type
 678   {
 679     ok_command,
 680     end_command,
 681     else_command,
 682     nop_command
 683   };
 684
 685 enum command_control_type
 686   {
 687     simple_control,
 688     break_control,
 689     continue_control,
 690     while_control,
 691     if_control,
 692     commands_control,
 693     invalid_control
 694   };
 695
 696 /* Structure for saved commands lines
 697    (for breakpoints, defined commands, etc).  */
 698
 699 struct command_line
 700   {
 701     struct command_line *next;
 702     char *line;
 703     enum command_control_type control_type;
 704     int body_count;
 705     struct command_line **body_list;
 706   };
 707
 708 extern struct command_line *read_command_lines (char *, int);
 709
 710 extern void free_command_lines (struct command_line **);
 711
 712 /* To continue the execution commands when running gdb asynchronously.
 713    A continuation structure contains a pointer to a function to be called
 714    to finish the command, once the target has stopped. Such mechanism is
 715    used bt the finish and until commands, and in the remote protocol
 716    when opening an extended-remote connection. */
 717
 718 struct continuation_arg
 719   {
 720     struct continuation_arg *next;
 721     union continuation_data {
 722       void *pointer;
 723       int   integer;
 724       long  longint;
 725     } data;
 726   };
 727
 728 struct continuation
 729   {
 730     void (*continuation_hook) (struct continuation_arg *);
 731     struct continuation_arg *arg_list;
 732     struct continuation *next;
 733   };
 734
 735 /* In infrun.c. */
 736 extern struct continuation *cmd_continuation;
 737 /* Used only by the step_1 function. */
 738 extern struct continuation *intermediate_continuation;
 739
 740 /* From utils.c */
 741 extern void add_continuation (void (*)(struct continuation_arg *),
 742                               struct continuation_arg *);
 743 extern void do_all_continuations (void);
 744 extern void discard_all_continuations (void);
 745
 746 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
 747                               struct continuation_arg *);
 748 extern void do_all_intermediate_continuations (void);
 749 extern void discard_all_intermediate_continuations (void);
 750
 751 /* String containing the current directory (what getwd would return).  */
 752
 753 extern char *current_directory;
 754
 755 /* Default radixes for input and output.  Only some values supported.  */
 756 extern unsigned input_radix;
 757 extern unsigned output_radix;
 758
 759 /* Possibilities for prettyprint parameters to routines which print
 760    things.  Like enum language, this should be in value.h, but needs
 761    to be here for the same reason.  FIXME:  If we can eliminate this
 762    as an arg to LA_VAL_PRINT, then we can probably move it back to
 763    value.h. */
 764
 765 enum val_prettyprint
 766   {
 767     Val_no_prettyprint = 0,
 768     Val_prettyprint,
 769     /* Use the default setting which the user has specified.  */
 770     Val_pretty_default
 771   };
 772
 773 /* The ptid struct is a collection of the various "ids" necessary
 774    for identifying the inferior.  This consists of the process id
 775    (pid), thread id (tid), and other fields necessary for uniquely
 776    identifying the inferior process/thread being debugged.  When
 777    manipulating ptids, the constructors, accessors, and predicate
 778    declared in inferior.h should be used.  These are as follows:
 779
 780       ptid_build        - Make a new ptid from a pid, lwp, and tid.
 781       pid_to_ptid       - Make a new ptid from just a pid.
 782       ptid_get_pid      - Fetch the pid component of a ptid.
 783       ptid_get_lwp      - Fetch the lwp component of a ptid.
 784       ptid_get_tid      - Fetch the tid component of a ptid.
 785       ptid_equal        - Test to see if two ptids are equal.
 786
 787    Please do NOT access the struct ptid members directly (except, of
 788    course, in the implementation of the above ptid manipulation
 789    functions).  */
 790
 791 struct ptid
 792   {
 793     /* Process id */
 794     int pid;
 795
 796     /* Lightweight process id */
 797     long lwp;
 798
 799     /* Thread id */
 800     long tid;
 801   };
 802
 803 typedef struct ptid ptid_t;
 804
 805 \f
 806
 807 /* Optional host machine definition.  Pure autoconf targets will not
 808    need a "xm.h" file.  This will be a symlink to one of the xm-*.h
 809    files, built by the `configure' script.  */
 810
 811 #ifdef GDB_XM_FILE
 812 #include "xm.h"
 813 #endif
 814
 815 /* Optional native machine support.  Non-native (and possibly pure
 816    multi-arch) targets do not need a "nm.h" file.  This will be a
 817    symlink to one of the nm-*.h files, built by the `configure'
 818    script.  */
 819
 820 #ifdef GDB_NM_FILE
 821 #include "nm.h"
 822 #endif
 823
 824 /* Optional target machine definition.  Pure multi-arch configurations
 825    do not need a "tm.h" file.  This will be a symlink to one of the
 826    tm-*.h files, built by the `configure' script.  */
 827
 828 #ifdef GDB_TM_FILE
 829 #include "tm.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 (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_NETWARE,
 983   GDB_OSABI_IRIX,
 984   GDB_OSABI_LYNXOS,
 985   GDB_OSABI_INTERIX,
 986   GDB_OSABI_HPUX_ELF,
 987   GDB_OSABI_HPUX_SOM,
 988
 989   GDB_OSABI_QNXNTO,
 990
 991   GDB_OSABI_CYGWIN,
 992   GDB_OSABI_AIX,
 993
 994   GDB_OSABI_INVALID             /* keep this last */
 995 };
 996
 997 /* Global functions from other, non-gdb GNU thingies.
 998    Libiberty thingies are no longer declared here.  We include libiberty.h
 999    above, instead.  */
1000
1001 /* From other system libraries */
1002
1003 #ifdef HAVE_STDDEF_H
1004 #include <stddef.h>
1005 #endif
1006
1007 #ifdef HAVE_STDLIB_H
1008 #include <stdlib.h>
1009 #endif
1010 #ifndef min
1011 #define min(a, b) ((a) < (b) ? (a) : (b))
1012 #endif
1013 #ifndef max
1014 #define max(a, b) ((a) > (b) ? (a) : (b))
1015 #endif
1016
1017
1018 #ifndef atof
1019 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
1020 #endif
1021
1022 /* Various possibilities for alloca.  */
1023 #ifndef alloca
1024 #ifdef __GNUC__
1025 #define alloca __builtin_alloca
1026 #else /* Not GNU C */
1027 #ifdef HAVE_ALLOCA_H
1028 #include <alloca.h>
1029 #else
1030 #ifdef _AIX
1031 #pragma alloca
1032 #else
1033
1034 /* We need to be careful not to declare this in a way which conflicts with
1035    bison.  Bison never declares it as char *, but under various circumstances
1036    (like __hpux) we need to use void *.  */
1037 extern void *alloca ();
1038 #endif /* Not _AIX */
1039 #endif /* Not HAVE_ALLOCA_H */
1040 #endif /* Not GNU C */
1041 #endif /* alloca not defined */
1042
1043 /* Dynamic target-system-dependent parameters for GDB. */
1044 #include "gdbarch.h"
1045
1046 /* Maximum size of a register.  Something small, but large enough for
1047    all known ISAs.  If it turns out to be too small, make it bigger.  */
1048
1049 enum { MAX_REGISTER_SIZE = 16 };
1050
1051 /* Static target-system-dependent parameters for GDB. */
1052
1053 /* Number of bits in a char or unsigned char for the target machine.
1054    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
1055 #if !defined (TARGET_CHAR_BIT)
1056 #define TARGET_CHAR_BIT 8
1057 #endif
1058
1059 /* If we picked up a copy of CHAR_BIT from a configuration file
1060    (which may get it by including <limits.h>) then use it to set
1061    the number of bits in a host char.  If not, use the same size
1062    as the target. */
1063
1064 #if defined (CHAR_BIT)
1065 #define HOST_CHAR_BIT CHAR_BIT
1066 #else
1067 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1068 #endif
1069
1070 /* The bit byte-order has to do just with numbering of bits in
1071    debugging symbols and such.  Conceptually, it's quite separate
1072    from byte/word byte order.  */
1073
1074 #if !defined (BITS_BIG_ENDIAN)
1075 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1076 #endif
1077
1078 /* In findvar.c.  */
1079
1080 extern LONGEST extract_signed_integer (const gdb_byte *, int);
1081
1082 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int);
1083
1084 extern int extract_long_unsigned_integer (const gdb_byte *, int, LONGEST *);
1085
1086 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
1087                                         struct type *type);
1088
1089 extern void store_signed_integer (gdb_byte *, int, LONGEST);
1090
1091 extern void store_unsigned_integer (gdb_byte *, int, ULONGEST);
1092
1093 extern void store_typed_address (gdb_byte *buf, struct type *type,
1094                                  CORE_ADDR addr);
1095
1096 \f
1097 /* From valops.c */
1098
1099 extern int watchdog;
1100
1101 /* Hooks for alternate command interfaces.  */
1102
1103 /* The name of the interpreter if specified on the command line. */
1104 extern char *interpreter_p;
1105
1106 /* If a given interpreter matches INTERPRETER_P then it should update
1107    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1108    per-interpreter implementation.  */
1109 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1110    should be moved here. */
1111
1112 struct target_waitstatus;
1113 struct cmd_list_element;
1114
1115 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1116 extern void (*deprecated_post_add_symbol_hook) (void);
1117 extern void (*selected_frame_level_changed_hook) (int);
1118 extern int (*deprecated_ui_loop_hook) (int signo);
1119 extern void (*deprecated_init_ui_hook) (char *argv0);
1120 extern void (*deprecated_command_loop_hook) (void);
1121 extern void (*deprecated_show_load_progress) (const char *section,
1122                                               unsigned long section_sent,
1123                                               unsigned long section_size,
1124                                               unsigned long total_sent,
1125                                               unsigned long total_size);
1126 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1127                                                          int line, int stopline,
1128                                                          int noerror);
1129 extern int (*deprecated_query_hook) (const char *, va_list)
1130      ATTRIBUTE_FPTR_PRINTF(1,0);
1131 extern void (*deprecated_warning_hook) (const char *, va_list)
1132      ATTRIBUTE_FPTR_PRINTF(1,0);
1133 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1134 extern void (*deprecated_create_breakpoint_hook) (struct breakpoint * b);
1135 extern void (*deprecated_delete_breakpoint_hook) (struct breakpoint * bpt);
1136 extern void (*deprecated_modify_breakpoint_hook) (struct breakpoint * bpt);
1137 extern void (*deprecated_interactive_hook) (void);
1138 extern void (*deprecated_registers_changed_hook) (void);
1139 extern void (*deprecated_readline_begin_hook) (char *, ...)
1140      ATTRIBUTE_FPTR_PRINTF_1;
1141 extern char *(*deprecated_readline_hook) (char *);
1142 extern void (*deprecated_readline_end_hook) (void);
1143 extern void (*deprecated_register_changed_hook) (int regno);
1144 extern void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
1145 extern void (*deprecated_context_hook) (int);
1146 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1147                                          struct target_waitstatus * status);
1148
1149 extern void (*deprecated_attach_hook) (void);
1150 extern void (*deprecated_detach_hook) (void);
1151 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1152                                              char *cmd, int from_tty);
1153
1154 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1155
1156 extern void (*deprecated_error_hook) (void);
1157
1158 extern void (*deprecated_error_begin_hook) (void);
1159
1160 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1161                                                 unsigned long num);
1162
1163
1164 /* Inhibit window interface if non-zero. */
1165
1166 extern int use_windows;
1167
1168 /* Symbolic definitions of filename-related things.  */
1169 /* FIXME, this doesn't work very well if host and executable
1170    filesystems conventions are different.  */
1171
1172 #ifdef __MSDOS__
1173 # define CANT_FORK
1174 # define GLOBAL_CURDIR
1175 # define DIRNAME_SEPARATOR ';'
1176 #endif
1177
1178 #if !defined (__CYGWIN__) && defined (_WIN32)
1179 # define DIRNAME_SEPARATOR ';'
1180 #endif
1181
1182 #ifndef DIRNAME_SEPARATOR
1183 #define DIRNAME_SEPARATOR ':'
1184 #endif
1185
1186 #ifndef SLASH_STRING
1187 #define SLASH_STRING "/"
1188 #endif
1189
1190 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1191    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1192    in the code actually refer to a lightweight process id, i.e,
1193    something that can be considered a process id in its own right for
1194    certain purposes.  */
1195
1196 #ifndef PIDGET
1197 #define PIDGET(PTID) (ptid_get_pid (PTID))
1198 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1199 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1200 #endif
1201
1202 /* Define well known filenos if the system does not define them.  */
1203 #ifndef STDIN_FILENO
1204 #define STDIN_FILENO   0
1205 #endif
1206 #ifndef STDOUT_FILENO
1207 #define STDOUT_FILENO  1
1208 #endif
1209 #ifndef STDERR_FILENO
1210 #define STDERR_FILENO  2
1211 #endif
1212
1213 /* If this definition isn't overridden by the header files, assume
1214    that isatty and fileno exist on this system.  */
1215 #ifndef ISATTY
1216 #define ISATTY(FP)      (isatty (fileno (FP)))
1217 #endif
1218
1219 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1220    power of 2).  Round up/down when necessary.  Examples of correct
1221    use include:
1222
1223    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1224    write_memory (addr, value, len);
1225    addr += len;
1226
1227    and:
1228
1229    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1230    write_memory (sp, value, len);
1231
1232    Note that uses such as:
1233
1234    write_memory (addr, value, len);
1235    addr += align_up (len, 8);
1236
1237    and:
1238
1239    sp -= align_up (len, 8);
1240    write_memory (sp, value, len);
1241
1242    are typically not correct as they don't ensure that the address (SP
1243    or ADDR) is correctly aligned (relying on previous alignment to
1244    keep things right).  This is also why the methods are called
1245    "align_..." instead of "round_..." as the latter reads better with
1246    this incorrect coding style.  */
1247
1248 extern ULONGEST align_up (ULONGEST v, int n);
1249 extern ULONGEST align_down (ULONGEST v, int n);
1250
1251 /* Allocation and deallocation functions for the libiberty hash table
1252    which use obstacks.  */
1253 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
1254 void dummy_obstack_deallocate (void *object, void *data);
1255
1256 #endif /* #ifndef DEFS_H */