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