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