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