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 char *ldirname (const char *filename);
 421
 422 /* From demangle.c */
 423
 424 extern void set_demangling_style (char *);
 425
 426 /* From tm.h */
 427
 428 struct type;
 429 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
 430 extern use_struct_convention_fn generic_use_struct_convention;
 431
 432 \f
 433 /* Annotation stuff.  */
 434
 435 extern int annotation_level;    /* in stack.c */
 436 \f
 437 extern void begin_line (void);
 438
 439 extern void wrap_here (char *);
 440
 441 extern void reinitialize_more_filter (void);
 442
 443 /* Normal results */
 444 extern struct ui_file *gdb_stdout;
 445 /* Input stream */
 446 extern struct ui_file *gdb_stdin;
 447 /* Serious error notifications */
 448 extern struct ui_file *gdb_stderr;
 449 /* Log/debug/trace messages that should bypass normal stdout/stderr
 450    filtering.  For moment, always call this stream using
 451    *_unfiltered. In the very near future that restriction shall be
 452    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 453 extern struct ui_file *gdb_stdlog;
 454 /* Target output that should bypass normal stdout/stderr filtering.
 455    For moment, always call this stream using *_unfiltered. In the
 456    very near future that restriction shall be removed - either call
 457    shall be unfiltered. (cagney 1999-07-02). */
 458 extern struct ui_file *gdb_stdtarg;
 459 extern struct ui_file *gdb_stdtargerr;
 460 extern struct ui_file *gdb_stdtargin;
 461
 462 #include "ui-file.h"
 463
 464 /* More generic printf like operations.  Filtered versions may return
 465    non-locally on error.  */
 466
 467 extern void fputs_filtered (const char *, struct ui_file *);
 468
 469 extern void fputs_unfiltered (const char *, struct ui_file *);
 470
 471 extern int fputc_filtered (int c, struct ui_file *);
 472
 473 extern int fputc_unfiltered (int c, struct ui_file *);
 474
 475 extern int putchar_filtered (int c);
 476
 477 extern int putchar_unfiltered (int c);
 478
 479 extern void puts_filtered (const char *);
 480
 481 extern void puts_unfiltered (const char *);
 482
 483 extern void puts_filtered_tabular (char *string, int width, int right);
 484
 485 extern void puts_debug (char *prefix, char *string, char *suffix);
 486
 487 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 488
 489 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 490
 491 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 492
 493 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 494
 495 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 496
 497 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 498
 499 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 500
 501 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 502
 503 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 504
 505 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 506
 507 extern void print_spaces (int, struct ui_file *);
 508
 509 extern void print_spaces_filtered (int, struct ui_file *);
 510
 511 extern char *n_spaces (int);
 512
 513 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 514
 515 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 516
 517 extern void fputstrn_filtered (const char *str, int n, int quotr, struct ui_file * stream);
 518
 519 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 520
 521 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 522 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 523
 524 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 525    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
 526    for ``%*''. */
 527 extern int strlen_paddr (void);
 528 extern char *paddr (CORE_ADDR addr);
 529 extern char *paddr_nz (CORE_ADDR addr);
 530 extern char *paddr_u (CORE_ADDR addr);
 531 extern char *paddr_d (LONGEST addr);
 532
 533 /* Like 0x%lx, replaces deprecated_print_address_numeric.  */
 534 extern const char *paddress (CORE_ADDR addr);
 535
 536 extern char *phex (ULONGEST l, int sizeof_l);
 537 extern char *phex_nz (ULONGEST l, int sizeof_l);
 538 extern char *int_string (LONGEST, int, int, int, int);
 539
 540 /* Like paddr() only print/scan raw CORE_ADDR.  The output from
 541    core_addr_to_string() can be passed direct to
 542    string_to_core_addr().  */
 543 extern const char *core_addr_to_string (const CORE_ADDR addr);
 544 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 545 extern CORE_ADDR string_to_core_addr (const char *my_string);
 546
 547 /* Return a string that contains a number formatted as a hex
 548    string.  */
 549 extern char *hex_string (LONGEST);
 550 extern char *hex_string_custom (LONGEST, int);
 551
 552 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 553                                      enum language, int);
 554
 555 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
 556
 557 extern void print_sys_errmsg (const char *, int);
 558
 559 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 560    "const char *" in unistd.h, so we can't declare the argument
 561    as "char *".  */
 562
 563 extern char *re_comp (const char *);
 564
 565 /* From symfile.c */
 566
 567 extern void symbol_file_command (char *, int);
 568
 569 /* Remote targets may wish to use this as their load function.  */
 570 extern void generic_load (char *name, int from_tty);
 571
 572 /* Report on STREAM the performance of memory transfer operation,
 573    such as 'load'.
 574    DATA_COUNT is the number of bytes transferred.
 575    WRITE_COUNT is the number of separate write operations, or 0,
 576    if that information is not available.
 577    START_TIME is the time at which an operation was started.
 578    END_TIME is the time at which an operation ended.  */
 579 struct timeval;
 580 extern void print_transfer_performance (struct ui_file *stream,
 581                                         unsigned long data_count,
 582                                         unsigned long write_count,
 583                                         const struct timeval *start_time,
 584                                         const struct timeval *end_time);
 585
 586 /* From top.c */
 587
 588 typedef void initialize_file_ftype (void);
 589
 590 extern char *skip_quoted (char *);
 591
 592 extern char *gdb_readline (char *);
 593
 594 extern char *gdb_readline_wrapper (char *);
 595
 596 extern char *command_line_input (char *, int, char *);
 597
 598 extern void print_prompt (void);
 599
 600 extern int input_from_terminal_p (void);
 601
 602 extern int info_verbose;
 603
 604 /* From printcmd.c */
 605
 606 extern void set_next_address (CORE_ADDR);
 607
 608 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
 609                                     char *);
 610
 611 extern int build_address_symbolic (CORE_ADDR addr,
 612                                    int do_demangle,
 613                                    char **name,
 614                                    int *offset,
 615                                    char **filename,
 616                                    int *line,
 617                                    int *unmapped);
 618
 619 extern void deprecated_print_address_numeric (CORE_ADDR, int, struct ui_file *);
 620
 621 extern void print_address (CORE_ADDR, struct ui_file *);
 622
 623 /* From source.c */
 624
 625 #define OPF_TRY_CWD_FIRST     0x01
 626 #define OPF_SEARCH_IN_PATH    0x02
 627
 628 extern int openp (const char *, int, const char *, int, int, char **);
 629
 630 extern int source_full_path_of (char *, char **);
 631
 632 extern void mod_path (char *, char **);
 633
 634 extern void add_path (char *, char **, int);
 635
 636 extern void directory_command (char *, int);
 637
 638 extern void directory_switch (char *, int);
 639
 640 extern char *source_path;
 641
 642 extern void init_source_path (void);
 643
 644 extern void init_last_source_visited (void);
 645
 646 /* From exec.c */
 647
 648 extern void exec_set_section_offsets (bfd_signed_vma text_off,
 649                                       bfd_signed_vma data_off,
 650                                       bfd_signed_vma bss_off);
 651
 652 /* Take over the 'find_mapped_memory' vector from exec.c. */
 653 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
 654                                                             unsigned long,
 655                                                             int, int, int,
 656                                                             void *),
 657                                                    void *));
 658
 659 /* Possible lvalue types.  Like enum language, this should be in
 660    value.h, but needs to be here for the same reason. */
 661
 662 enum lval_type
 663   {
 664     /* Not an lval. */
 665     not_lval,
 666     /* In memory.  */
 667     lval_memory,
 668     /* In a register.  Registers are relative to a frame.  */
 669     lval_register,
 670     /* In a gdb internal variable.  */
 671     lval_internalvar,
 672     /* Part of a gdb internal variable (structure field).  */
 673     lval_internalvar_component
 674   };
 675
 676 /* Control types for commands */
 677
 678 enum misc_command_type
 679   {
 680     ok_command,
 681     end_command,
 682     else_command,
 683     nop_command
 684   };
 685
 686 enum command_control_type
 687   {
 688     simple_control,
 689     break_control,
 690     continue_control,
 691     while_control,
 692     if_control,
 693     commands_control,
 694     invalid_control
 695   };
 696
 697 /* Structure for saved commands lines
 698    (for breakpoints, defined commands, etc).  */
 699
 700 struct command_line
 701   {
 702     struct command_line *next;
 703     char *line;
 704     enum command_control_type control_type;
 705     int body_count;
 706     struct command_line **body_list;
 707   };
 708
 709 extern struct command_line *read_command_lines (char *, int);
 710
 711 extern void free_command_lines (struct command_line **);
 712
 713 /* To continue the execution commands when running gdb asynchronously.
 714    A continuation structure contains a pointer to a function to be called
 715    to finish the command, once the target has stopped. Such mechanism is
 716    used bt the finish and until commands, and in the remote protocol
 717    when opening an extended-remote connection. */
 718
 719 struct continuation_arg
 720   {
 721     struct continuation_arg *next;
 722     union continuation_data {
 723       void *pointer;
 724       int   integer;
 725       long  longint;
 726     } data;
 727   };
 728
 729 struct continuation
 730   {
 731     void (*continuation_hook) (struct continuation_arg *);
 732     struct continuation_arg *arg_list;
 733     struct continuation *next;
 734   };
 735
 736 /* In infrun.c. */
 737 extern struct continuation *cmd_continuation;
 738 /* Used only by the step_1 function. */
 739 extern struct continuation *intermediate_continuation;
 740
 741 /* From utils.c */
 742 extern void add_continuation (void (*)(struct continuation_arg *),
 743                               struct continuation_arg *);
 744 extern void do_all_continuations (void);
 745 extern void discard_all_continuations (void);
 746
 747 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
 748                               struct continuation_arg *);
 749 extern void do_all_intermediate_continuations (void);
 750 extern void discard_all_intermediate_continuations (void);
 751
 752 /* String containing the current directory (what getwd would return).  */
 753
 754 extern char *current_directory;
 755
 756 /* Default radixes for input and output.  Only some values supported.  */
 757 extern unsigned input_radix;
 758 extern unsigned output_radix;
 759
 760 /* Possibilities for prettyprint parameters to routines which print
 761    things.  Like enum language, this should be in value.h, but needs
 762    to be here for the same reason.  FIXME:  If we can eliminate this
 763    as an arg to LA_VAL_PRINT, then we can probably move it back to
 764    value.h. */
 765
 766 enum val_prettyprint
 767   {
 768     Val_no_prettyprint = 0,
 769     Val_prettyprint,
 770     /* Use the default setting which the user has specified.  */
 771     Val_pretty_default
 772   };
 773
 774 /* The ptid struct is a collection of the various "ids" necessary
 775    for identifying the inferior.  This consists of the process id
 776    (pid), thread id (tid), and other fields necessary for uniquely
 777    identifying the inferior process/thread being debugged.  When
 778    manipulating ptids, the constructors, accessors, and predicate
 779    declared in inferior.h should be used.  These are as follows:
 780
 781       ptid_build        - Make a new ptid from a pid, lwp, and tid.
 782       pid_to_ptid       - Make a new ptid from just a pid.
 783       ptid_get_pid      - Fetch the pid component of a ptid.
 784       ptid_get_lwp      - Fetch the lwp component of a ptid.
 785       ptid_get_tid      - Fetch the tid component of a ptid.
 786       ptid_equal        - Test to see if two ptids are equal.
 787
 788    Please do NOT access the struct ptid members directly (except, of
 789    course, in the implementation of the above ptid manipulation
 790    functions).  */
 791
 792 struct ptid
 793   {
 794     /* Process id */
 795     int pid;
 796
 797     /* Lightweight process id */
 798     long lwp;
 799
 800     /* Thread id */
 801     long tid;
 802   };
 803
 804 typedef struct ptid ptid_t;
 805
 806 \f
 807
 808 /* Optional host machine definition.  Pure autoconf targets will not
 809    need a "xm.h" file.  This will be a symlink to one of the xm-*.h
 810    files, built by the `configure' script.  */
 811
 812 #ifdef GDB_XM_FILE
 813 #include "xm.h"
 814 #endif
 815
 816 /* Optional native machine support.  Non-native (and possibly pure
 817    multi-arch) targets do not need a "nm.h" file.  This will be a
 818    symlink to one of the nm-*.h files, built by the `configure'
 819    script.  */
 820
 821 #ifdef GDB_NM_FILE
 822 #include "nm.h"
 823 #endif
 824
 825 /* Optional target machine definition.  Pure multi-arch configurations
 826    do not need a "tm.h" file.  This will be a symlink to one of the
 827    tm-*.h files, built by the `configure' script.  */
 828
 829 #ifdef GDB_TM_FILE
 830 #include "tm.h"
 831 #endif
 832
 833 /* Assume that fopen accepts the letter "b" in the mode string.
 834    It is demanded by ISO C9X, and should be supported on all
 835    platforms that claim to have a standard-conforming C library.  On
 836    true POSIX systems it will be ignored and have no effect.  There
 837    may still be systems without a standard-conforming C library where
 838    an ISO C9X compiler (GCC) is available.  Known examples are SunOS
 839    4.x and 4.3BSD.  This assumption means these systems are no longer
 840    supported.  */
 841 #ifndef FOPEN_RB
 842 # include "fopen-bin.h"
 843 #endif
 844
 845 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 846    FIXME: Assumes 2's complement arithmetic */
 847
 848 #if !defined (UINT_MAX)
 849 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 850 #endif
 851
 852 #if !defined (INT_MAX)
 853 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 854 #endif
 855
 856 #if !defined (INT_MIN)
 857 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 858 #endif
 859
 860 #if !defined (ULONG_MAX)
 861 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 862 #endif
 863
 864 #if !defined (LONG_MAX)
 865 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 866 #endif
 867
 868 #if !defined (ULONGEST_MAX)
 869 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 870 #endif
 871
 872 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 873 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 874 #endif
 875
 876 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 877    arguments to a function, number in a value history, register number, etc.)
 878    where the value must not be larger than can fit in an int.  */
 879
 880 extern int longest_to_int (LONGEST);
 881
 882 /* Assorted functions we can declare, now that const and volatile are
 883    defined.  */
 884
 885 extern char *savestring (const char *, size_t);
 886
 887 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
 888    "libiberty.h". */
 889 extern void xfree (void *);
 890
 891 /* Like xmalloc, but zero the memory.  */
 892 extern void *xzalloc (size_t);
 893
 894 /* Utility macros to allocate typed memory.  Avoids errors like:
 895    struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
 896    sizeof (struct foo), 0).  */
 897 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
 898 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 899 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 900
 901 /* Like asprintf/vasprintf but get an internal_error if the call
 902    fails. */
 903 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
 904 extern void xvasprintf (char **ret, const char *format, va_list ap)
 905      ATTR_FORMAT (printf, 2, 0);
 906
 907 /* Like asprintf and vasprintf, but return the string, throw an error
 908    if no memory.  */
 909 extern char *xstrprintf (const char *format, ...) ATTR_FORMAT (printf, 1, 2);
 910 extern char *xstrvprintf (const char *format, va_list ap)
 911      ATTR_FORMAT (printf, 1, 0);
 912
 913 /* Like snprintf, but throw an error if the output buffer is too small.  */
 914 extern int xsnprintf (char *str, size_t size, const char *format, ...)
 915      ATTR_FORMAT (printf, 3, 4);
 916
 917 extern int parse_escape (char **);
 918
 919 /* Message to be printed before the error message, when an error occurs.  */
 920
 921 extern char *error_pre_print;
 922
 923 /* Message to be printed before the error message, when an error occurs.  */
 924
 925 extern char *quit_pre_print;
 926
 927 /* Message to be printed before the warning message, when a warning occurs.  */
 928
 929 extern char *warning_pre_print;
 930
 931 extern NORETURN void verror (const char *fmt, va_list ap)
 932      ATTR_NORETURN ATTR_FORMAT (printf, 1, 0);
 933
 934 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 935
 936 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
 937
 938 extern NORETURN void vfatal (const char *fmt, va_list ap)
 939      ATTR_NORETURN ATTR_FORMAT (printf, 1, 0);
 940
 941 extern NORETURN void fatal (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 942
 943 extern NORETURN void internal_verror (const char *file, int line,
 944                                       const char *, va_list ap)
 945      ATTR_NORETURN ATTR_FORMAT (printf, 3, 0);
 946
 947 extern NORETURN void internal_error (const char *file, int line,
 948                                      const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
 949
 950 extern void internal_vwarning (const char *file, int line,
 951                                const char *, va_list ap)
 952      ATTR_FORMAT (printf, 3, 0);
 953
 954 extern void internal_warning (const char *file, int line,
 955                               const char *, ...) ATTR_FORMAT (printf, 3, 4);
 956
 957 extern NORETURN void nomem (long) ATTR_NORETURN;
 958
 959 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 960
 961 extern void vwarning (const char *, va_list args) ATTR_FORMAT (printf, 1, 0);
 962
 963 /* List of known OS ABIs.  If you change this, make sure to update the
 964    table in osabi.c.  */
 965 enum gdb_osabi
 966 {
 967   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
 968
 969   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
 970
 971   GDB_OSABI_SVR4,
 972   GDB_OSABI_HURD,
 973   GDB_OSABI_SOLARIS,
 974   GDB_OSABI_OSF1,
 975   GDB_OSABI_LINUX,
 976   GDB_OSABI_FREEBSD_AOUT,
 977   GDB_OSABI_FREEBSD_ELF,
 978   GDB_OSABI_NETBSD_AOUT,
 979   GDB_OSABI_NETBSD_ELF,
 980   GDB_OSABI_OPENBSD_ELF,
 981   GDB_OSABI_WINCE,
 982   GDB_OSABI_GO32,
 983   GDB_OSABI_IRIX,
 984   GDB_OSABI_INTERIX,
 985   GDB_OSABI_HPUX_ELF,
 986   GDB_OSABI_HPUX_SOM,
 987
 988   GDB_OSABI_QNXNTO,
 989
 990   GDB_OSABI_CYGWIN,
 991   GDB_OSABI_AIX,
 992
 993   GDB_OSABI_INVALID             /* keep this last */
 994 };
 995
 996 /* Global functions from other, non-gdb GNU thingies.
 997    Libiberty thingies are no longer declared here.  We include libiberty.h
 998    above, instead.  */
 999
1000 /* From other system libraries */
1001
1002 #ifdef HAVE_STDDEF_H
1003 #include <stddef.h>
1004 #endif
1005
1006 #ifdef HAVE_STDLIB_H
1007 #include <stdlib.h>
1008 #endif
1009 #ifndef min
1010 #define min(a, b) ((a) < (b) ? (a) : (b))
1011 #endif
1012 #ifndef max
1013 #define max(a, b) ((a) > (b) ? (a) : (b))
1014 #endif
1015
1016
1017 #ifndef atof
1018 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
1019 #endif
1020
1021 /* Various possibilities for alloca.  */
1022 #ifndef alloca
1023 #ifdef __GNUC__
1024 #define alloca __builtin_alloca
1025 #else /* Not GNU C */
1026 #ifdef HAVE_ALLOCA_H
1027 #include <alloca.h>
1028 #else
1029 #ifdef _AIX
1030 #pragma alloca
1031 #else
1032
1033 /* We need to be careful not to declare this in a way which conflicts with
1034    bison.  Bison never declares it as char *, but under various circumstances
1035    (like __hpux) we need to use void *.  */
1036 extern void *alloca ();
1037 #endif /* Not _AIX */
1038 #endif /* Not HAVE_ALLOCA_H */
1039 #endif /* Not GNU C */
1040 #endif /* alloca not defined */
1041
1042 /* Dynamic target-system-dependent parameters for GDB. */
1043 #include "gdbarch.h"
1044
1045 /* Maximum size of a register.  Something small, but large enough for
1046    all known ISAs.  If it turns out to be too small, make it bigger.  */
1047
1048 enum { MAX_REGISTER_SIZE = 16 };
1049
1050 /* Static target-system-dependent parameters for GDB. */
1051
1052 /* Number of bits in a char or unsigned char for the target machine.
1053    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
1054 #if !defined (TARGET_CHAR_BIT)
1055 #define TARGET_CHAR_BIT 8
1056 #endif
1057
1058 /* If we picked up a copy of CHAR_BIT from a configuration file
1059    (which may get it by including <limits.h>) then use it to set
1060    the number of bits in a host char.  If not, use the same size
1061    as the target. */
1062
1063 #if defined (CHAR_BIT)
1064 #define HOST_CHAR_BIT CHAR_BIT
1065 #else
1066 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1067 #endif
1068
1069 /* The bit byte-order has to do just with numbering of bits in
1070    debugging symbols and such.  Conceptually, it's quite separate
1071    from byte/word byte order.  */
1072
1073 #if !defined (BITS_BIG_ENDIAN)
1074 #define BITS_BIG_ENDIAN (gdbarch_byte_order (current_gdbarch) == BFD_ENDIAN_BIG)
1075 #endif
1076
1077 /* In findvar.c.  */
1078
1079 extern LONGEST extract_signed_integer (const gdb_byte *, int);
1080
1081 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int);
1082
1083 extern int extract_long_unsigned_integer (const gdb_byte *, int, LONGEST *);
1084
1085 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
1086                                         struct type *type);
1087
1088 extern void store_signed_integer (gdb_byte *, int, LONGEST);
1089
1090 extern void store_unsigned_integer (gdb_byte *, int, ULONGEST);
1091
1092 extern void store_typed_address (gdb_byte *buf, struct type *type,
1093                                  CORE_ADDR addr);
1094
1095 \f
1096 /* From valops.c */
1097
1098 extern int watchdog;
1099
1100 /* Hooks for alternate command interfaces.  */
1101
1102 /* The name of the interpreter if specified on the command line. */
1103 extern char *interpreter_p;
1104
1105 /* If a given interpreter matches INTERPRETER_P then it should update
1106    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1107    per-interpreter implementation.  */
1108 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1109    should be moved here. */
1110
1111 struct target_waitstatus;
1112 struct cmd_list_element;
1113
1114 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1115 extern void (*deprecated_post_add_symbol_hook) (void);
1116 extern void (*selected_frame_level_changed_hook) (int);
1117 extern int (*deprecated_ui_loop_hook) (int signo);
1118 extern void (*deprecated_init_ui_hook) (char *argv0);
1119 extern void (*deprecated_command_loop_hook) (void);
1120 extern void (*deprecated_show_load_progress) (const char *section,
1121                                               unsigned long section_sent,
1122                                               unsigned long section_size,
1123                                               unsigned long total_sent,
1124                                               unsigned long total_size);
1125 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1126                                                          int line, int stopline,
1127                                                          int noerror);
1128 extern int (*deprecated_query_hook) (const char *, va_list)
1129      ATTRIBUTE_FPTR_PRINTF(1,0);
1130 extern void (*deprecated_warning_hook) (const char *, va_list)
1131      ATTRIBUTE_FPTR_PRINTF(1,0);
1132 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1133 extern void (*deprecated_create_breakpoint_hook) (struct breakpoint * b);
1134 extern void (*deprecated_delete_breakpoint_hook) (struct breakpoint * bpt);
1135 extern void (*deprecated_modify_breakpoint_hook) (struct breakpoint * bpt);
1136 extern void (*deprecated_interactive_hook) (void);
1137 extern void (*deprecated_readline_begin_hook) (char *, ...)
1138      ATTRIBUTE_FPTR_PRINTF_1;
1139 extern char *(*deprecated_readline_hook) (char *);
1140 extern void (*deprecated_readline_end_hook) (void);
1141 extern void (*deprecated_register_changed_hook) (int regno);
1142 extern void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
1143 extern void (*deprecated_context_hook) (int);
1144 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1145                                          struct target_waitstatus * status);
1146
1147 extern void (*deprecated_attach_hook) (void);
1148 extern void (*deprecated_detach_hook) (void);
1149 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1150                                              char *cmd, int from_tty);
1151
1152 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1153
1154 extern void (*deprecated_error_hook) (void);
1155
1156 extern void (*deprecated_error_begin_hook) (void);
1157
1158 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1159                                                 unsigned long num);
1160
1161
1162 /* Inhibit window interface if non-zero. */
1163
1164 extern int use_windows;
1165
1166 /* Symbolic definitions of filename-related things.  */
1167 /* FIXME, this doesn't work very well if host and executable
1168    filesystems conventions are different.  */
1169
1170 #ifdef __MSDOS__
1171 # define CANT_FORK
1172 # define GLOBAL_CURDIR
1173 # define DIRNAME_SEPARATOR ';'
1174 #endif
1175
1176 #if !defined (__CYGWIN__) && defined (_WIN32)
1177 # define DIRNAME_SEPARATOR ';'
1178 #endif
1179
1180 #ifndef DIRNAME_SEPARATOR
1181 #define DIRNAME_SEPARATOR ':'
1182 #endif
1183
1184 #ifndef SLASH_STRING
1185 #define SLASH_STRING "/"
1186 #endif
1187
1188 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1189    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1190    in the code actually refer to a lightweight process id, i.e,
1191    something that can be considered a process id in its own right for
1192    certain purposes.  */
1193
1194 #ifndef PIDGET
1195 #define PIDGET(PTID) (ptid_get_pid (PTID))
1196 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1197 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1198 #endif
1199
1200 /* Define well known filenos if the system does not define them.  */
1201 #ifndef STDIN_FILENO
1202 #define STDIN_FILENO   0
1203 #endif
1204 #ifndef STDOUT_FILENO
1205 #define STDOUT_FILENO  1
1206 #endif
1207 #ifndef STDERR_FILENO
1208 #define STDERR_FILENO  2
1209 #endif
1210
1211 /* If this definition isn't overridden by the header files, assume
1212    that isatty and fileno exist on this system.  */
1213 #ifndef ISATTY
1214 #define ISATTY(FP)      (isatty (fileno (FP)))
1215 #endif
1216
1217 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1218    power of 2).  Round up/down when necessary.  Examples of correct
1219    use include:
1220
1221    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1222    write_memory (addr, value, len);
1223    addr += len;
1224
1225    and:
1226
1227    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1228    write_memory (sp, value, len);
1229
1230    Note that uses such as:
1231
1232    write_memory (addr, value, len);
1233    addr += align_up (len, 8);
1234
1235    and:
1236
1237    sp -= align_up (len, 8);
1238    write_memory (sp, value, len);
1239
1240    are typically not correct as they don't ensure that the address (SP
1241    or ADDR) is correctly aligned (relying on previous alignment to
1242    keep things right).  This is also why the methods are called
1243    "align_..." instead of "round_..." as the latter reads better with
1244    this incorrect coding style.  */
1245
1246 extern ULONGEST align_up (ULONGEST v, int n);
1247 extern ULONGEST align_down (ULONGEST v, int n);
1248
1249 /* Allocation and deallocation functions for the libiberty hash table
1250    which use obstacks.  */
1251 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
1252 void dummy_obstack_deallocate (void *object, void *data);
1253
1254 #endif /* #ifndef DEFS_H */